2 * Copyright (C) 2007 Jens Axboe <jens.axboe@oracle.com>
4 * Scatterlist handling helpers.
6 * This source code is licensed under the GNU General Public License,
7 * Version 2. See the file COPYING for more details.
9 #include <linux/export.h>
10 #include <linux/slab.h>
11 #include <linux/scatterlist.h>
12 #include <linux/highmem.h>
13 #include <linux/kmemleak.h>
16 * sg_next - return the next scatterlist entry in a list
17 * @sg: The current sg entry
20 * Usually the next entry will be @sg@ + 1, but if this sg element is part
21 * of a chained scatterlist, it could jump to the start of a new
25 struct scatterlist *sg_next(struct scatterlist *sg)
27 #ifdef CONFIG_DEBUG_SG
28 BUG_ON(sg->sg_magic != SG_MAGIC);
34 if (unlikely(sg_is_chain(sg)))
35 sg = sg_chain_ptr(sg);
39 EXPORT_SYMBOL(sg_next);
42 * sg_nents - return total count of entries in scatterlist
43 * @sg: The scatterlist
46 * Allows to know how many entries are in sg, taking into acount
50 int sg_nents(struct scatterlist *sg)
53 for (nents = 0; sg; sg = sg_next(sg))
57 EXPORT_SYMBOL(sg_nents);
60 * sg_nents_for_len - return total count of entries in scatterlist
61 * needed to satisfy the supplied length
62 * @sg: The scatterlist
63 * @len: The total required length
66 * Determines the number of entries in sg that are required to meet
67 * the supplied length, taking into acount chaining as well
70 * the number of sg entries needed, negative error on failure
73 int sg_nents_for_len(struct scatterlist *sg, u64 len)
81 for (nents = 0, total = 0; sg; sg = sg_next(sg)) {
90 EXPORT_SYMBOL(sg_nents_for_len);
93 * sg_last - return the last scatterlist entry in a list
94 * @sgl: First entry in the scatterlist
95 * @nents: Number of entries in the scatterlist
98 * Should only be used casually, it (currently) scans the entire list
99 * to get the last entry.
101 * Note that the @sgl@ pointer passed in need not be the first one,
102 * the important bit is that @nents@ denotes the number of entries that
106 struct scatterlist *sg_last(struct scatterlist *sgl, unsigned int nents)
108 struct scatterlist *sg, *ret = NULL;
111 for_each_sg(sgl, sg, nents, i)
114 #ifdef CONFIG_DEBUG_SG
115 BUG_ON(sgl[0].sg_magic != SG_MAGIC);
116 BUG_ON(!sg_is_last(ret));
120 EXPORT_SYMBOL(sg_last);
123 * sg_init_table - Initialize SG table
125 * @nents: Number of entries in table
128 * If this is part of a chained sg table, sg_mark_end() should be
129 * used only on the last table part.
132 void sg_init_table(struct scatterlist *sgl, unsigned int nents)
134 memset(sgl, 0, sizeof(*sgl) * nents);
135 #ifdef CONFIG_DEBUG_SG
138 for (i = 0; i < nents; i++)
139 sgl[i].sg_magic = SG_MAGIC;
142 sg_mark_end(&sgl[nents - 1]);
144 EXPORT_SYMBOL(sg_init_table);
147 * sg_init_one - Initialize a single entry sg list
149 * @buf: Virtual address for IO
153 void sg_init_one(struct scatterlist *sg, const void *buf, unsigned int buflen)
155 sg_init_table(sg, 1);
156 sg_set_buf(sg, buf, buflen);
158 EXPORT_SYMBOL(sg_init_one);
161 * The default behaviour of sg_alloc_table() is to use these kmalloc/kfree
164 static struct scatterlist *sg_kmalloc(unsigned int nents, gfp_t gfp_mask)
166 if (nents == SG_MAX_SINGLE_ALLOC) {
168 * Kmemleak doesn't track page allocations as they are not
169 * commonly used (in a raw form) for kernel data structures.
170 * As we chain together a list of pages and then a normal
171 * kmalloc (tracked by kmemleak), in order to for that last
172 * allocation not to become decoupled (and thus a
173 * false-positive) we need to inform kmemleak of all the
174 * intermediate allocations.
176 void *ptr = (void *) __get_free_page(gfp_mask);
177 kmemleak_alloc(ptr, PAGE_SIZE, 1, gfp_mask);
180 return kmalloc(nents * sizeof(struct scatterlist), gfp_mask);
183 static void sg_kfree(struct scatterlist *sg, unsigned int nents)
185 if (nents == SG_MAX_SINGLE_ALLOC) {
187 free_page((unsigned long) sg);
193 * __sg_free_table - Free a previously mapped sg table
194 * @table: The sg table header to use
195 * @max_ents: The maximum number of entries per single scatterlist
196 * @skip_first_chunk: don't free the (preallocated) first scatterlist chunk
197 * @free_fn: Free function
200 * Free an sg table previously allocated and setup with
201 * __sg_alloc_table(). The @max_ents value must be identical to
202 * that previously used with __sg_alloc_table().
205 void __sg_free_table(struct sg_table *table, unsigned int max_ents,
206 bool skip_first_chunk, sg_free_fn *free_fn)
208 struct scatterlist *sgl, *next;
210 if (unlikely(!table->sgl))
214 while (table->orig_nents) {
215 unsigned int alloc_size = table->orig_nents;
216 unsigned int sg_size;
219 * If we have more than max_ents segments left,
220 * then assign 'next' to the sg table after the current one.
221 * sg_size is then one less than alloc size, since the last
222 * element is the chain pointer.
224 if (alloc_size > max_ents) {
225 next = sg_chain_ptr(&sgl[max_ents - 1]);
226 alloc_size = max_ents;
227 sg_size = alloc_size - 1;
229 sg_size = alloc_size;
233 table->orig_nents -= sg_size;
234 if (skip_first_chunk)
235 skip_first_chunk = false;
237 free_fn(sgl, alloc_size);
243 EXPORT_SYMBOL(__sg_free_table);
246 * sg_free_table - Free a previously allocated sg table
247 * @table: The mapped sg table header
250 void sg_free_table(struct sg_table *table)
252 __sg_free_table(table, SG_MAX_SINGLE_ALLOC, false, sg_kfree);
254 EXPORT_SYMBOL(sg_free_table);
257 * __sg_alloc_table - Allocate and initialize an sg table with given allocator
258 * @table: The sg table header to use
259 * @nents: Number of entries in sg list
260 * @max_ents: The maximum number of entries the allocator returns per call
261 * @gfp_mask: GFP allocation mask
262 * @alloc_fn: Allocator to use
265 * This function returns a @table @nents long. The allocator is
266 * defined to return scatterlist chunks of maximum size @max_ents.
267 * Thus if @nents is bigger than @max_ents, the scatterlists will be
268 * chained in units of @max_ents.
271 * If this function returns non-0 (eg failure), the caller must call
272 * __sg_free_table() to cleanup any leftover allocations.
275 int __sg_alloc_table(struct sg_table *table, unsigned int nents,
276 unsigned int max_ents, struct scatterlist *first_chunk,
277 gfp_t gfp_mask, sg_alloc_fn *alloc_fn)
279 struct scatterlist *sg, *prv;
282 memset(table, 0, sizeof(*table));
286 #ifndef CONFIG_ARCH_HAS_SG_CHAIN
287 if (WARN_ON_ONCE(nents > max_ents))
294 unsigned int sg_size, alloc_size = left;
296 if (alloc_size > max_ents) {
297 alloc_size = max_ents;
298 sg_size = alloc_size - 1;
300 sg_size = alloc_size;
308 sg = alloc_fn(alloc_size, gfp_mask);
312 * Adjust entry count to reflect that the last
313 * entry of the previous table won't be used for
314 * linkage. Without this, sg_kfree() may get
318 table->nents = ++table->orig_nents;
323 sg_init_table(sg, alloc_size);
324 table->nents = table->orig_nents += sg_size;
327 * If this is the first mapping, assign the sg table header.
328 * If this is not the first mapping, chain previous part.
331 sg_chain(prv, max_ents, sg);
336 * If no more entries after this one, mark the end
339 sg_mark_end(&sg[sg_size - 1]);
346 EXPORT_SYMBOL(__sg_alloc_table);
349 * sg_alloc_table - Allocate and initialize an sg table
350 * @table: The sg table header to use
351 * @nents: Number of entries in sg list
352 * @gfp_mask: GFP allocation mask
355 * Allocate and initialize an sg table. If @nents@ is larger than
356 * SG_MAX_SINGLE_ALLOC a chained sg table will be setup.
359 int sg_alloc_table(struct sg_table *table, unsigned int nents, gfp_t gfp_mask)
363 ret = __sg_alloc_table(table, nents, SG_MAX_SINGLE_ALLOC,
364 NULL, gfp_mask, sg_kmalloc);
366 __sg_free_table(table, SG_MAX_SINGLE_ALLOC, false, sg_kfree);
370 EXPORT_SYMBOL(sg_alloc_table);
373 * sg_alloc_table_from_pages - Allocate and initialize an sg table from
375 * @sgt: The sg table header to use
376 * @pages: Pointer to an array of page pointers
377 * @n_pages: Number of pages in the pages array
378 * @offset: Offset from start of the first page to the start of a buffer
379 * @size: Number of valid bytes in the buffer (after offset)
380 * @gfp_mask: GFP allocation mask
383 * Allocate and initialize an sg table from a list of pages. Contiguous
384 * ranges of the pages are squashed into a single scatterlist node. A user
385 * may provide an offset at a start and a size of valid data in a buffer
386 * specified by the page array. The returned sg table is released by
390 * 0 on success, negative error on failure
392 int sg_alloc_table_from_pages(struct sg_table *sgt,
393 struct page **pages, unsigned int n_pages,
394 unsigned long offset, unsigned long size,
399 unsigned int cur_page;
401 struct scatterlist *s;
403 /* compute number of contiguous chunks */
405 for (i = 1; i < n_pages; ++i)
406 if (page_to_pfn(pages[i]) != page_to_pfn(pages[i - 1]) + 1)
409 ret = sg_alloc_table(sgt, chunks, gfp_mask);
413 /* merging chunks and putting them into the scatterlist */
415 for_each_sg(sgt->sgl, s, sgt->orig_nents, i) {
416 unsigned long chunk_size;
419 /* look for the end of the current chunk */
420 for (j = cur_page + 1; j < n_pages; ++j)
421 if (page_to_pfn(pages[j]) !=
422 page_to_pfn(pages[j - 1]) + 1)
425 chunk_size = ((j - cur_page) << PAGE_SHIFT) - offset;
426 sg_set_page(s, pages[cur_page], min(size, chunk_size), offset);
434 EXPORT_SYMBOL(sg_alloc_table_from_pages);
436 void __sg_page_iter_start(struct sg_page_iter *piter,
437 struct scatterlist *sglist, unsigned int nents,
438 unsigned long pgoffset)
440 piter->__pg_advance = 0;
441 piter->__nents = nents;
444 piter->sg_pgoffset = pgoffset;
446 EXPORT_SYMBOL(__sg_page_iter_start);
448 static int sg_page_count(struct scatterlist *sg)
450 return PAGE_ALIGN(sg->offset + sg->length) >> PAGE_SHIFT;
453 bool __sg_page_iter_next(struct sg_page_iter *piter)
455 if (!piter->__nents || !piter->sg)
458 piter->sg_pgoffset += piter->__pg_advance;
459 piter->__pg_advance = 1;
461 while (piter->sg_pgoffset >= sg_page_count(piter->sg)) {
462 piter->sg_pgoffset -= sg_page_count(piter->sg);
463 piter->sg = sg_next(piter->sg);
464 if (!--piter->__nents || !piter->sg)
470 EXPORT_SYMBOL(__sg_page_iter_next);
473 * sg_miter_start - start mapping iteration over a sg list
474 * @miter: sg mapping iter to be started
475 * @sgl: sg list to iterate over
476 * @nents: number of sg entries
479 * Starts mapping iterator @miter.
484 void sg_miter_start(struct sg_mapping_iter *miter, struct scatterlist *sgl,
485 unsigned int nents, unsigned int flags)
487 memset(miter, 0, sizeof(struct sg_mapping_iter));
489 __sg_page_iter_start(&miter->piter, sgl, nents, 0);
490 WARN_ON(!(flags & (SG_MITER_TO_SG | SG_MITER_FROM_SG)));
491 miter->__flags = flags;
493 EXPORT_SYMBOL(sg_miter_start);
495 static bool sg_miter_get_next_page(struct sg_mapping_iter *miter)
497 if (!miter->__remaining) {
498 struct scatterlist *sg;
499 unsigned long pgoffset;
501 if (!__sg_page_iter_next(&miter->piter))
504 sg = miter->piter.sg;
505 pgoffset = miter->piter.sg_pgoffset;
507 miter->__offset = pgoffset ? 0 : sg->offset;
508 miter->__remaining = sg->offset + sg->length -
509 (pgoffset << PAGE_SHIFT) - miter->__offset;
510 miter->__remaining = min_t(unsigned long, miter->__remaining,
511 PAGE_SIZE - miter->__offset);
518 * sg_miter_skip - reposition mapping iterator
519 * @miter: sg mapping iter to be skipped
520 * @offset: number of bytes to plus the current location
523 * Sets the offset of @miter to its current location plus @offset bytes.
524 * If mapping iterator @miter has been proceeded by sg_miter_next(), this
528 * Don't care if @miter is stopped, or not proceeded yet.
529 * Otherwise, preemption disabled if the SG_MITER_ATOMIC is set.
532 * true if @miter contains the valid mapping. false if end of sg
535 bool sg_miter_skip(struct sg_mapping_iter *miter, off_t offset)
537 sg_miter_stop(miter);
542 if (!sg_miter_get_next_page(miter))
545 consumed = min_t(off_t, offset, miter->__remaining);
546 miter->__offset += consumed;
547 miter->__remaining -= consumed;
553 EXPORT_SYMBOL(sg_miter_skip);
556 * sg_miter_next - proceed mapping iterator to the next mapping
557 * @miter: sg mapping iter to proceed
560 * Proceeds @miter to the next mapping. @miter should have been started
561 * using sg_miter_start(). On successful return, @miter->page,
562 * @miter->addr and @miter->length point to the current mapping.
565 * Preemption disabled if SG_MITER_ATOMIC. Preemption must stay disabled
566 * till @miter is stopped. May sleep if !SG_MITER_ATOMIC.
569 * true if @miter contains the next mapping. false if end of sg
572 bool sg_miter_next(struct sg_mapping_iter *miter)
574 sg_miter_stop(miter);
577 * Get to the next page if necessary.
578 * __remaining, __offset is adjusted by sg_miter_stop
580 if (!sg_miter_get_next_page(miter))
583 miter->page = sg_page_iter_page(&miter->piter);
584 miter->consumed = miter->length = miter->__remaining;
586 if (miter->__flags & SG_MITER_ATOMIC)
587 miter->addr = kmap_atomic(miter->page) + miter->__offset;
589 miter->addr = kmap(miter->page) + miter->__offset;
593 EXPORT_SYMBOL(sg_miter_next);
596 * sg_miter_stop - stop mapping iteration
597 * @miter: sg mapping iter to be stopped
600 * Stops mapping iterator @miter. @miter should have been started
601 * started using sg_miter_start(). A stopped iteration can be
602 * resumed by calling sg_miter_next() on it. This is useful when
603 * resources (kmap) need to be released during iteration.
606 * Preemption disabled if the SG_MITER_ATOMIC is set. Don't care
609 void sg_miter_stop(struct sg_mapping_iter *miter)
611 WARN_ON(miter->consumed > miter->length);
613 /* drop resources from the last iteration */
615 miter->__offset += miter->consumed;
616 miter->__remaining -= miter->consumed;
618 if ((miter->__flags & SG_MITER_TO_SG) &&
619 !PageSlab(miter->page))
620 flush_kernel_dcache_page(miter->page);
622 if (miter->__flags & SG_MITER_ATOMIC) {
623 WARN_ON_ONCE(!pagefault_disabled());
624 kunmap_atomic(miter->addr);
634 EXPORT_SYMBOL(sg_miter_stop);
637 * sg_copy_buffer - Copy data between a linear buffer and an SG list
639 * @nents: Number of SG entries
640 * @buf: Where to copy from
641 * @buflen: The number of bytes to copy
642 * @skip: Number of bytes to skip before copying
643 * @to_buffer: transfer direction (true == from an sg list to a
644 * buffer, false == from a buffer to an sg list
646 * Returns the number of copied bytes.
649 size_t sg_copy_buffer(struct scatterlist *sgl, unsigned int nents, void *buf,
650 size_t buflen, off_t skip, bool to_buffer)
652 unsigned int offset = 0;
653 struct sg_mapping_iter miter;
655 unsigned int sg_flags = SG_MITER_ATOMIC;
658 sg_flags |= SG_MITER_FROM_SG;
660 sg_flags |= SG_MITER_TO_SG;
662 sg_miter_start(&miter, sgl, nents, sg_flags);
664 if (!sg_miter_skip(&miter, skip))
667 local_irq_save_nort(flags);
669 while (sg_miter_next(&miter) && offset < buflen) {
672 len = min(miter.length, buflen - offset);
675 memcpy(buf + offset, miter.addr, len);
677 memcpy(miter.addr, buf + offset, len);
682 sg_miter_stop(&miter);
684 local_irq_restore_nort(flags);
687 EXPORT_SYMBOL(sg_copy_buffer);
690 * sg_copy_from_buffer - Copy from a linear buffer to an SG list
692 * @nents: Number of SG entries
693 * @buf: Where to copy from
694 * @buflen: The number of bytes to copy
696 * Returns the number of copied bytes.
699 size_t sg_copy_from_buffer(struct scatterlist *sgl, unsigned int nents,
700 const void *buf, size_t buflen)
702 return sg_copy_buffer(sgl, nents, (void *)buf, buflen, 0, false);
704 EXPORT_SYMBOL(sg_copy_from_buffer);
707 * sg_copy_to_buffer - Copy from an SG list to a linear buffer
709 * @nents: Number of SG entries
710 * @buf: Where to copy to
711 * @buflen: The number of bytes to copy
713 * Returns the number of copied bytes.
716 size_t sg_copy_to_buffer(struct scatterlist *sgl, unsigned int nents,
717 void *buf, size_t buflen)
719 return sg_copy_buffer(sgl, nents, buf, buflen, 0, true);
721 EXPORT_SYMBOL(sg_copy_to_buffer);
724 * sg_pcopy_from_buffer - Copy from a linear buffer to an SG list
726 * @nents: Number of SG entries
727 * @buf: Where to copy from
728 * @buflen: The number of bytes to copy
729 * @skip: Number of bytes to skip before copying
731 * Returns the number of copied bytes.
734 size_t sg_pcopy_from_buffer(struct scatterlist *sgl, unsigned int nents,
735 const void *buf, size_t buflen, off_t skip)
737 return sg_copy_buffer(sgl, nents, (void *)buf, buflen, skip, false);
739 EXPORT_SYMBOL(sg_pcopy_from_buffer);
742 * sg_pcopy_to_buffer - Copy from an SG list to a linear buffer
744 * @nents: Number of SG entries
745 * @buf: Where to copy to
746 * @buflen: The number of bytes to copy
747 * @skip: Number of bytes to skip before copying
749 * Returns the number of copied bytes.
752 size_t sg_pcopy_to_buffer(struct scatterlist *sgl, unsigned int nents,
753 void *buf, size_t buflen, off_t skip)
755 return sg_copy_buffer(sgl, nents, buf, buflen, skip, true);
757 EXPORT_SYMBOL(sg_pcopy_to_buffer);