lib/scatterlist.c

   1 /*
   2  * Copyright (C) 2007 Jens Axboe <jens.axboe@oracle.com>
   3  *
   4  * Scatterlist handling helpers.
   5  *
   6  * This source code is licensed under the GNU General Public License,
   7  * Version 2. See the file COPYING for more details.
   8  */
   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>
  14
  15 /**
  16  * sg_next - return the next scatterlist entry in a list
  17  * @sg:         The current sg entry
  18  *
  19  * Description:
  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
  22  *   scatterlist array.
  23  *
  24  **/
  25 struct scatterlist *sg_next(struct scatterlist *sg)
  26 {
  27 #ifdef CONFIG_DEBUG_SG
  28         BUG_ON(sg->sg_magic != SG_MAGIC);
  29 #endif
  30         if (sg_is_last(sg))
  31                 return NULL;
  32
  33         sg++;
  34         if (unlikely(sg_is_chain(sg)))
  35                 sg = sg_chain_ptr(sg);
  36
  37         return sg;
  38 }
  39 EXPORT_SYMBOL(sg_next);
  40
  41 /**
  42  * sg_nents - return total count of entries in scatterlist
  43  * @sg:         The scatterlist
  44  *
  45  * Description:
  46  * Allows to know how many entries are in sg, taking into acount
  47  * chaining as well
  48  *
  49  **/
  50 int sg_nents(struct scatterlist *sg)
  51 {
  52         int nents;
  53         for (nents = 0; sg; sg = sg_next(sg))
  54                 nents++;
  55         return nents;
  56 }
  57 EXPORT_SYMBOL(sg_nents);
  58
  59 /**
  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
  64  *
  65  * Description:
  66  * Determines the number of entries in sg that are required to meet
  67  * the supplied length, taking into acount chaining as well
  68  *
  69  * Returns:
  70  *   the number of sg entries needed, negative error on failure
  71  *
  72  **/
  73 int sg_nents_for_len(struct scatterlist *sg, u64 len)
  74 {
  75         int nents;
  76         u64 total;
  77
  78         if (!len)
  79                 return 0;
  80
  81         for (nents = 0, total = 0; sg; sg = sg_next(sg)) {
  82                 nents++;
  83                 total += sg->length;
  84                 if (total >= len)
  85                         return nents;
  86         }
  87
  88         return -EINVAL;
  89 }
  90 EXPORT_SYMBOL(sg_nents_for_len);
  91
  92 /**
  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
  96  *
  97  * Description:
  98  *   Should only be used casually, it (currently) scans the entire list
  99  *   to get the last entry.
 100  *
 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
 103  *   exist from @sgl@.
 104  *
 105  **/
 106 struct scatterlist *sg_last(struct scatterlist *sgl, unsigned int nents)
 107 {
 108         struct scatterlist *sg, *ret = NULL;
 109         unsigned int i;
 110
 111         for_each_sg(sgl, sg, nents, i)
 112                 ret = sg;
 113
 114 #ifdef CONFIG_DEBUG_SG
 115         BUG_ON(sgl[0].sg_magic != SG_MAGIC);
 116         BUG_ON(!sg_is_last(ret));
 117 #endif
 118         return ret;
 119 }
 120 EXPORT_SYMBOL(sg_last);
 121
 122 /**
 123  * sg_init_table - Initialize SG table
 124  * @sgl:           The SG table
 125  * @nents:         Number of entries in table
 126  *
 127  * Notes:
 128  *   If this is part of a chained sg table, sg_mark_end() should be
 129  *   used only on the last table part.
 130  *
 131  **/
 132 void sg_init_table(struct scatterlist *sgl, unsigned int nents)
 133 {
 134         memset(sgl, 0, sizeof(*sgl) * nents);
 135 #ifdef CONFIG_DEBUG_SG
 136         {
 137                 unsigned int i;
 138                 for (i = 0; i < nents; i++)
 139                         sgl[i].sg_magic = SG_MAGIC;
 140         }
 141 #endif
 142         sg_mark_end(&sgl[nents - 1]);
 143 }
 144 EXPORT_SYMBOL(sg_init_table);
 145
 146 /**
 147  * sg_init_one - Initialize a single entry sg list
 148  * @sg:          SG entry
 149  * @buf:         Virtual address for IO
 150  * @buflen:      IO length
 151  *
 152  **/
 153 void sg_init_one(struct scatterlist *sg, const void *buf, unsigned int buflen)
 154 {
 155         sg_init_table(sg, 1);
 156         sg_set_buf(sg, buf, buflen);
 157 }
 158 EXPORT_SYMBOL(sg_init_one);
 159
 160 /*
 161  * The default behaviour of sg_alloc_table() is to use these kmalloc/kfree
 162  * helpers.
 163  */
 164 static struct scatterlist *sg_kmalloc(unsigned int nents, gfp_t gfp_mask)
 165 {
 166         if (nents == SG_MAX_SINGLE_ALLOC) {
 167                 /*
 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.
 175                  */
 176                 void *ptr = (void *) __get_free_page(gfp_mask);
 177                 kmemleak_alloc(ptr, PAGE_SIZE, 1, gfp_mask);
 178                 return ptr;
 179         } else
 180                 return kmalloc(nents * sizeof(struct scatterlist), gfp_mask);
 181 }
 182
 183 static void sg_kfree(struct scatterlist *sg, unsigned int nents)
 184 {
 185         if (nents == SG_MAX_SINGLE_ALLOC) {
 186                 kmemleak_free(sg);
 187                 free_page((unsigned long) sg);
 188         } else
 189                 kfree(sg);
 190 }
 191
 192 /**
 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
 198  *
 199  *  Description:
 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().
 203  *
 204  **/
 205 void __sg_free_table(struct sg_table *table, unsigned int max_ents,
 206                      bool skip_first_chunk, sg_free_fn *free_fn)
 207 {
 208         struct scatterlist *sgl, *next;
 209
 210         if (unlikely(!table->sgl))
 211                 return;
 212
 213         sgl = table->sgl;
 214         while (table->orig_nents) {
 215                 unsigned int alloc_size = table->orig_nents;
 216                 unsigned int sg_size;
 217
 218                 /*
 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.
 223                  */
 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;
 228                 } else {
 229                         sg_size = alloc_size;
 230                         next = NULL;
 231                 }
 232
 233                 table->orig_nents -= sg_size;
 234                 if (skip_first_chunk)
 235                         skip_first_chunk = false;
 236                 else
 237                         free_fn(sgl, alloc_size);
 238                 sgl = next;
 239         }
 240
 241         table->sgl = NULL;
 242 }
 243 EXPORT_SYMBOL(__sg_free_table);
 244
 245 /**
 246  * sg_free_table - Free a previously allocated sg table
 247  * @table:      The mapped sg table header
 248  *
 249  **/
 250 void sg_free_table(struct sg_table *table)
 251 {
 252         __sg_free_table(table, SG_MAX_SINGLE_ALLOC, false, sg_kfree);
 253 }
 254 EXPORT_SYMBOL(sg_free_table);
 255
 256 /**
 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
 263  *
 264  * Description:
 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.
 269  *
 270  * Notes:
 271  *   If this function returns non-0 (eg failure), the caller must call
 272  *   __sg_free_table() to cleanup any leftover allocations.
 273  *
 274  **/
 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)
 278 {
 279         struct scatterlist *sg, *prv;
 280         unsigned int left;
 281
 282         memset(table, 0, sizeof(*table));
 283
 284         if (nents == 0)
 285                 return -EINVAL;
 286 #ifndef CONFIG_ARCH_HAS_SG_CHAIN
 287         if (WARN_ON_ONCE(nents > max_ents))
 288                 return -EINVAL;
 289 #endif
 290
 291         left = nents;
 292         prv = NULL;
 293         do {
 294                 unsigned int sg_size, alloc_size = left;
 295
 296                 if (alloc_size > max_ents) {
 297                         alloc_size = max_ents;
 298                         sg_size = alloc_size - 1;
 299                 } else
 300                         sg_size = alloc_size;
 301
 302                 left -= sg_size;
 303
 304                 if (first_chunk) {
 305                         sg = first_chunk;
 306                         first_chunk = NULL;
 307                 } else {
 308                         sg = alloc_fn(alloc_size, gfp_mask);
 309                 }
 310                 if (unlikely(!sg)) {
 311                         /*
 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
 315                          * confused.
 316                          */
 317                         if (prv)
 318                                 table->nents = ++table->orig_nents;
 319
 320                         return -ENOMEM;
 321                 }
 322
 323                 sg_init_table(sg, alloc_size);
 324                 table->nents = table->orig_nents += sg_size;
 325
 326                 /*
 327                  * If this is the first mapping, assign the sg table header.
 328                  * If this is not the first mapping, chain previous part.
 329                  */
 330                 if (prv)
 331                         sg_chain(prv, max_ents, sg);
 332                 else
 333                         table->sgl = sg;
 334
 335                 /*
 336                  * If no more entries after this one, mark the end
 337                  */
 338                 if (!left)
 339                         sg_mark_end(&sg[sg_size - 1]);
 340
 341                 prv = sg;
 342         } while (left);
 343
 344         return 0;
 345 }
 346 EXPORT_SYMBOL(__sg_alloc_table);
 347
 348 /**
 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
 353  *
 354  *  Description:
 355  *    Allocate and initialize an sg table. If @nents@ is larger than
 356  *    SG_MAX_SINGLE_ALLOC a chained sg table will be setup.
 357  *
 358  **/
 359 int sg_alloc_table(struct sg_table *table, unsigned int nents, gfp_t gfp_mask)
 360 {
 361         int ret;
 362
 363         ret = __sg_alloc_table(table, nents, SG_MAX_SINGLE_ALLOC,
 364                                NULL, gfp_mask, sg_kmalloc);
 365         if (unlikely(ret))
 366                 __sg_free_table(table, SG_MAX_SINGLE_ALLOC, false, sg_kfree);
 367
 368         return ret;
 369 }
 370 EXPORT_SYMBOL(sg_alloc_table);
 371
 372 /**
 373  * sg_alloc_table_from_pages - Allocate and initialize an sg table from
 374  *                             an array of pages
 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
 381  *
 382  *  Description:
 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
 387  *    sg_free_table.
 388  *
 389  * Returns:
 390  *   0 on success, negative error on failure
 391  */
 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,
 395         gfp_t gfp_mask)
 396 {
 397         unsigned int chunks;
 398         unsigned int i;
 399         unsigned int cur_page;
 400         int ret;
 401         struct scatterlist *s;
 402
 403         /* compute number of contiguous chunks */
 404         chunks = 1;
 405         for (i = 1; i < n_pages; ++i)
 406                 if (page_to_pfn(pages[i]) != page_to_pfn(pages[i - 1]) + 1)
 407                         ++chunks;
 408
 409         ret = sg_alloc_table(sgt, chunks, gfp_mask);
 410         if (unlikely(ret))
 411                 return ret;
 412
 413         /* merging chunks and putting them into the scatterlist */
 414         cur_page = 0;
 415         for_each_sg(sgt->sgl, s, sgt->orig_nents, i) {
 416                 unsigned long chunk_size;
 417                 unsigned int j;
 418
 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)
 423                                 break;
 424
 425                 chunk_size = ((j - cur_page) << PAGE_SHIFT) - offset;
 426                 sg_set_page(s, pages[cur_page], min(size, chunk_size), offset);
 427                 size -= chunk_size;
 428                 offset = 0;
 429                 cur_page = j;
 430         }
 431
 432         return 0;
 433 }
 434 EXPORT_SYMBOL(sg_alloc_table_from_pages);
 435
 436 #ifdef CONFIG_SGL_ALLOC
 437
 438 /**
 439  * sgl_alloc_order - allocate a scatterlist and its pages
 440  * @length: Length in bytes of the scatterlist. Must be at least one
 441  * @order: Second argument for alloc_pages()
 442  * @chainable: Whether or not to allocate an extra element in the scatterlist
 443  *      for scatterlist chaining purposes
 444  * @gfp: Memory allocation flags
 445  * @nent_p: [out] Number of entries in the scatterlist that have pages
 446  *
 447  * Returns: A pointer to an initialized scatterlist or %NULL upon failure.
 448  */
 449 struct scatterlist *sgl_alloc_order(unsigned long long length,
 450                                     unsigned int order, bool chainable,
 451                                     gfp_t gfp, unsigned int *nent_p)
 452 {
 453         struct scatterlist *sgl, *sg;
 454         struct page *page;
 455         unsigned int nent, nalloc;
 456         u32 elem_len;
 457
 458         nent = round_up(length, PAGE_SIZE << order) >> (PAGE_SHIFT + order);
 459         /* Check for integer overflow */
 460         if (length > (nent << (PAGE_SHIFT + order)))
 461                 return NULL;
 462         nalloc = nent;
 463         if (chainable) {
 464                 /* Check for integer overflow */
 465                 if (nalloc + 1 < nalloc)
 466                         return NULL;
 467                 nalloc++;
 468         }
 469         sgl = kmalloc_array(nalloc, sizeof(struct scatterlist),
 470                             (gfp & ~GFP_DMA) | __GFP_ZERO);
 471         if (!sgl)
 472                 return NULL;
 473
 474         sg_init_table(sgl, nent);
 475         sg = sgl;
 476         while (length) {
 477                 elem_len = min_t(u64, length, PAGE_SIZE << order);
 478                 page = alloc_pages(gfp, order);
 479                 if (!page) {
 480                         sgl_free_order(sgl, order);
 481                         return NULL;
 482                 }
 483
 484                 sg_set_page(sg, page, elem_len, 0);
 485                 length -= elem_len;
 486                 sg = sg_next(sg);
 487         }
 488         WARN_ON_ONCE(sg);
 489         if (nent_p)
 490                 *nent_p = nent;
 491         return sgl;
 492 }
 493 EXPORT_SYMBOL(sgl_alloc_order);
 494
 495 /**
 496  * sgl_alloc - allocate a scatterlist and its pages
 497  * @length: Length in bytes of the scatterlist
 498  * @gfp: Memory allocation flags
 499  * @nent_p: [out] Number of entries in the scatterlist
 500  *
 501  * Returns: A pointer to an initialized scatterlist or %NULL upon failure.
 502  */
 503 struct scatterlist *sgl_alloc(unsigned long long length, gfp_t gfp,
 504                               unsigned int *nent_p)
 505 {
 506         return sgl_alloc_order(length, 0, false, gfp, nent_p);
 507 }
 508 EXPORT_SYMBOL(sgl_alloc);
 509
 510 /**
 511  * sgl_free_order - free a scatterlist and its pages
 512  * @sgl: Scatterlist with one or more elements
 513  * @order: Second argument for __free_pages()
 514  */
 515 void sgl_free_order(struct scatterlist *sgl, int order)
 516 {
 517         struct scatterlist *sg;
 518         struct page *page;
 519
 520         for (sg = sgl; sg; sg = sg_next(sg)) {
 521                 page = sg_page(sg);
 522                 if (page)
 523                         __free_pages(page, order);
 524         }
 525         kfree(sgl);
 526 }
 527 EXPORT_SYMBOL(sgl_free_order);
 528
 529 /**
 530  * sgl_free - free a scatterlist and its pages
 531  * @sgl: Scatterlist with one or more elements
 532  */
 533 void sgl_free(struct scatterlist *sgl)
 534 {
 535         sgl_free_order(sgl, 0);
 536 }
 537 EXPORT_SYMBOL(sgl_free);
 538
 539 #endif /* CONFIG_SGL_ALLOC */
 540
 541 void __sg_page_iter_start(struct sg_page_iter *piter,
 542                           struct scatterlist *sglist, unsigned int nents,
 543                           unsigned long pgoffset)
 544 {
 545         piter->__pg_advance = 0;
 546         piter->__nents = nents;
 547
 548         piter->sg = sglist;
 549         piter->sg_pgoffset = pgoffset;
 550 }
 551 EXPORT_SYMBOL(__sg_page_iter_start);
 552
 553 static int sg_page_count(struct scatterlist *sg)
 554 {
 555         return PAGE_ALIGN(sg->offset + sg->length) >> PAGE_SHIFT;
 556 }
 557
 558 bool __sg_page_iter_next(struct sg_page_iter *piter)
 559 {
 560         if (!piter->__nents || !piter->sg)
 561                 return false;
 562
 563         piter->sg_pgoffset += piter->__pg_advance;
 564         piter->__pg_advance = 1;
 565
 566         while (piter->sg_pgoffset >= sg_page_count(piter->sg)) {
 567                 piter->sg_pgoffset -= sg_page_count(piter->sg);
 568                 piter->sg = sg_next(piter->sg);
 569                 if (!--piter->__nents || !piter->sg)
 570                         return false;
 571         }
 572
 573         return true;
 574 }
 575 EXPORT_SYMBOL(__sg_page_iter_next);
 576
 577 /**
 578  * sg_miter_start - start mapping iteration over a sg list
 579  * @miter: sg mapping iter to be started
 580  * @sgl: sg list to iterate over
 581  * @nents: number of sg entries
 582  *
 583  * Description:
 584  *   Starts mapping iterator @miter.
 585  *
 586  * Context:
 587  *   Don't care.
 588  */
 589 void sg_miter_start(struct sg_mapping_iter *miter, struct scatterlist *sgl,
 590                     unsigned int nents, unsigned int flags)
 591 {
 592         memset(miter, 0, sizeof(struct sg_mapping_iter));
 593
 594         __sg_page_iter_start(&miter->piter, sgl, nents, 0);
 595         WARN_ON(!(flags & (SG_MITER_TO_SG | SG_MITER_FROM_SG)));
 596         miter->__flags = flags;
 597 }
 598 EXPORT_SYMBOL(sg_miter_start);
 599
 600 static bool sg_miter_get_next_page(struct sg_mapping_iter *miter)
 601 {
 602         if (!miter->__remaining) {
 603                 struct scatterlist *sg;
 604
 605                 if (!__sg_page_iter_next(&miter->piter))
 606                         return false;
 607
 608                 sg = miter->piter.sg;
 609
 610                 miter->__offset = miter->piter.sg_pgoffset ? 0 : sg->offset;
 611                 miter->piter.sg_pgoffset += miter->__offset >> PAGE_SHIFT;
 612                 miter->__offset &= PAGE_SIZE - 1;
 613                 miter->__remaining = sg->offset + sg->length -
 614                                      (miter->piter.sg_pgoffset << PAGE_SHIFT) -
 615                                      miter->__offset;
 616                 miter->__remaining = min_t(unsigned long, miter->__remaining,
 617                                            PAGE_SIZE - miter->__offset);
 618         }
 619
 620         return true;
 621 }
 622
 623 /**
 624  * sg_miter_skip - reposition mapping iterator
 625  * @miter: sg mapping iter to be skipped
 626  * @offset: number of bytes to plus the current location
 627  *
 628  * Description:
 629  *   Sets the offset of @miter to its current location plus @offset bytes.
 630  *   If mapping iterator @miter has been proceeded by sg_miter_next(), this
 631  *   stops @miter.
 632  *
 633  * Context:
 634  *   Don't care if @miter is stopped, or not proceeded yet.
 635  *   Otherwise, preemption disabled if the SG_MITER_ATOMIC is set.
 636  *
 637  * Returns:
 638  *   true if @miter contains the valid mapping.  false if end of sg
 639  *   list is reached.
 640  */
 641 bool sg_miter_skip(struct sg_mapping_iter *miter, off_t offset)
 642 {
 643         sg_miter_stop(miter);
 644
 645         while (offset) {
 646                 off_t consumed;
 647
 648                 if (!sg_miter_get_next_page(miter))
 649                         return false;
 650
 651                 consumed = min_t(off_t, offset, miter->__remaining);
 652                 miter->__offset += consumed;
 653                 miter->__remaining -= consumed;
 654                 offset -= consumed;
 655         }
 656
 657         return true;
 658 }
 659 EXPORT_SYMBOL(sg_miter_skip);
 660
 661 /**
 662  * sg_miter_next - proceed mapping iterator to the next mapping
 663  * @miter: sg mapping iter to proceed
 664  *
 665  * Description:
 666  *   Proceeds @miter to the next mapping.  @miter should have been started
 667  *   using sg_miter_start().  On successful return, @miter->page,
 668  *   @miter->addr and @miter->length point to the current mapping.
 669  *
 670  * Context:
 671  *   Preemption disabled if SG_MITER_ATOMIC.  Preemption must stay disabled
 672  *   till @miter is stopped.  May sleep if !SG_MITER_ATOMIC.
 673  *
 674  * Returns:
 675  *   true if @miter contains the next mapping.  false if end of sg
 676  *   list is reached.
 677  */
 678 bool sg_miter_next(struct sg_mapping_iter *miter)
 679 {
 680         sg_miter_stop(miter);
 681
 682         /*
 683          * Get to the next page if necessary.
 684          * __remaining, __offset is adjusted by sg_miter_stop
 685          */
 686         if (!sg_miter_get_next_page(miter))
 687                 return false;
 688
 689         miter->page = sg_page_iter_page(&miter->piter);
 690         miter->consumed = miter->length = miter->__remaining;
 691
 692         if (miter->__flags & SG_MITER_ATOMIC)
 693                 miter->addr = kmap_atomic(miter->page) + miter->__offset;
 694         else
 695                 miter->addr = kmap(miter->page) + miter->__offset;
 696
 697         return true;
 698 }
 699 EXPORT_SYMBOL(sg_miter_next);
 700
 701 /**
 702  * sg_miter_stop - stop mapping iteration
 703  * @miter: sg mapping iter to be stopped
 704  *
 705  * Description:
 706  *   Stops mapping iterator @miter.  @miter should have been started
 707  *   using sg_miter_start().  A stopped iteration can be resumed by
 708  *   calling sg_miter_next() on it.  This is useful when resources (kmap)
 709  *   need to be released during iteration.
 710  *
 711  * Context:
 712  *   Preemption disabled if the SG_MITER_ATOMIC is set.  Don't care
 713  *   otherwise.
 714  */
 715 void sg_miter_stop(struct sg_mapping_iter *miter)
 716 {
 717         WARN_ON(miter->consumed > miter->length);
 718
 719         /* drop resources from the last iteration */
 720         if (miter->addr) {
 721                 miter->__offset += miter->consumed;
 722                 miter->__remaining -= miter->consumed;
 723
 724                 if ((miter->__flags & SG_MITER_TO_SG) &&
 725                     !PageSlab(miter->page))
 726                         flush_kernel_dcache_page(miter->page);
 727
 728                 if (miter->__flags & SG_MITER_ATOMIC) {
 729                         WARN_ON_ONCE(preemptible());
 730                         kunmap_atomic(miter->addr);
 731                 } else
 732                         kunmap(miter->page);
 733
 734                 miter->page = NULL;
 735                 miter->addr = NULL;
 736                 miter->length = 0;
 737                 miter->consumed = 0;
 738         }
 739 }
 740 EXPORT_SYMBOL(sg_miter_stop);
 741
 742 /**
 743  * sg_copy_buffer - Copy data between a linear buffer and an SG list
 744  * @sgl:                 The SG list
 745  * @nents:               Number of SG entries
 746  * @buf:                 Where to copy from
 747  * @buflen:              The number of bytes to copy
 748  * @skip:                Number of bytes to skip before copying
 749  * @to_buffer:           transfer direction (true == from an sg list to a
 750  *                       buffer, false == from a buffer to an sg list
 751  *
 752  * Returns the number of copied bytes.
 753  *
 754  **/
 755 size_t sg_copy_buffer(struct scatterlist *sgl, unsigned int nents, void *buf,
 756                       size_t buflen, off_t skip, bool to_buffer)
 757 {
 758         unsigned int offset = 0;
 759         struct sg_mapping_iter miter;
 760         unsigned int sg_flags = SG_MITER_ATOMIC;
 761
 762         if (to_buffer)
 763                 sg_flags |= SG_MITER_FROM_SG;
 764         else
 765                 sg_flags |= SG_MITER_TO_SG;
 766
 767         sg_miter_start(&miter, sgl, nents, sg_flags);
 768
 769         if (!sg_miter_skip(&miter, skip))
 770                 return false;
 771
 772         while ((offset < buflen) && sg_miter_next(&miter)) {
 773                 unsigned int len;
 774
 775                 len = min(miter.length, buflen - offset);
 776
 777                 if (to_buffer)
 778                         memcpy(buf + offset, miter.addr, len);
 779                 else
 780                         memcpy(miter.addr, buf + offset, len);
 781
 782                 offset += len;
 783         }
 784
 785         sg_miter_stop(&miter);
 786
 787         return offset;
 788 }
 789 EXPORT_SYMBOL(sg_copy_buffer);
 790
 791 /**
 792  * sg_copy_from_buffer - Copy from a linear buffer to an SG list
 793  * @sgl:                 The SG list
 794  * @nents:               Number of SG entries
 795  * @buf:                 Where to copy from
 796  * @buflen:              The number of bytes to copy
 797  *
 798  * Returns the number of copied bytes.
 799  *
 800  **/
 801 size_t sg_copy_from_buffer(struct scatterlist *sgl, unsigned int nents,
 802                            const void *buf, size_t buflen)
 803 {
 804         return sg_copy_buffer(sgl, nents, (void *)buf, buflen, 0, false);
 805 }
 806 EXPORT_SYMBOL(sg_copy_from_buffer);
 807
 808 /**
 809  * sg_copy_to_buffer - Copy from an SG list to a linear buffer
 810  * @sgl:                 The SG list
 811  * @nents:               Number of SG entries
 812  * @buf:                 Where to copy to
 813  * @buflen:              The number of bytes to copy
 814  *
 815  * Returns the number of copied bytes.
 816  *
 817  **/
 818 size_t sg_copy_to_buffer(struct scatterlist *sgl, unsigned int nents,
 819                          void *buf, size_t buflen)
 820 {
 821         return sg_copy_buffer(sgl, nents, buf, buflen, 0, true);
 822 }
 823 EXPORT_SYMBOL(sg_copy_to_buffer);
 824
 825 /**
 826  * sg_pcopy_from_buffer - Copy from a linear buffer to an SG list
 827  * @sgl:                 The SG list
 828  * @nents:               Number of SG entries
 829  * @buf:                 Where to copy from
 830  * @buflen:              The number of bytes to copy
 831  * @skip:                Number of bytes to skip before copying
 832  *
 833  * Returns the number of copied bytes.
 834  *
 835  **/
 836 size_t sg_pcopy_from_buffer(struct scatterlist *sgl, unsigned int nents,
 837                             const void *buf, size_t buflen, off_t skip)
 838 {
 839         return sg_copy_buffer(sgl, nents, (void *)buf, buflen, skip, false);
 840 }
 841 EXPORT_SYMBOL(sg_pcopy_from_buffer);
 842
 843 /**
 844  * sg_pcopy_to_buffer - Copy from an SG list to a linear buffer
 845  * @sgl:                 The SG list
 846  * @nents:               Number of SG entries
 847  * @buf:                 Where to copy to
 848  * @buflen:              The number of bytes to copy
 849  * @skip:                Number of bytes to skip before copying
 850  *
 851  * Returns the number of copied bytes.
 852  *
 853  **/
 854 size_t sg_pcopy_to_buffer(struct scatterlist *sgl, unsigned int nents,
 855                           void *buf, size_t buflen, off_t skip)
 856 {
 857         return sg_copy_buffer(sgl, nents, buf, buflen, skip, true);
 858 }
 859 EXPORT_SYMBOL(sg_pcopy_to_buffer);
 860
 861 /**
 862  * sg_zero_buffer - Zero-out a part of a SG list
 863  * @sgl:                 The SG list
 864  * @nents:               Number of SG entries
 865  * @buflen:              The number of bytes to zero out
 866  * @skip:                Number of bytes to skip before zeroing
 867  *
 868  * Returns the number of bytes zeroed.
 869  **/
 870 size_t sg_zero_buffer(struct scatterlist *sgl, unsigned int nents,
 871                        size_t buflen, off_t skip)
 872 {
 873         unsigned int offset = 0;
 874         struct sg_mapping_iter miter;
 875         unsigned int sg_flags = SG_MITER_ATOMIC | SG_MITER_TO_SG;
 876
 877         sg_miter_start(&miter, sgl, nents, sg_flags);
 878
 879         if (!sg_miter_skip(&miter, skip))
 880                 return false;
 881
 882         while (offset < buflen && sg_miter_next(&miter)) {
 883                 unsigned int len;
 884
 885                 len = min(miter.length, buflen - offset);
 886                 memset(miter.addr, 0, len);
 887
 888                 offset += len;
 889         }
 890
 891         sg_miter_stop(&miter);
 892         return offset;
 893 }
 894 EXPORT_SYMBOL(sg_zero_buffer);