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_last - return the last scatterlist entry in a list
  43  * @sgl:        First entry in the scatterlist
  44  * @nents:      Number of entries in the scatterlist
  45  *
  46  * Description:
  47  *   Should only be used casually, it (currently) scans the entire list
  48  *   to get the last entry.
  49  *
  50  *   Note that the @sgl@ pointer passed in need not be the first one,
  51  *   the important bit is that @nents@ denotes the number of entries that
  52  *   exist from @sgl@.
  53  *
  54  **/
  55 struct scatterlist *sg_last(struct scatterlist *sgl, unsigned int nents)
  56 {
  57 #ifndef ARCH_HAS_SG_CHAIN
  58         struct scatterlist *ret = &sgl[nents - 1];
  59 #else
  60         struct scatterlist *sg, *ret = NULL;
  61         unsigned int i;
  62
  63         for_each_sg(sgl, sg, nents, i)
  64                 ret = sg;
  65
  66 #endif
  67 #ifdef CONFIG_DEBUG_SG
  68         BUG_ON(sgl[0].sg_magic != SG_MAGIC);
  69         BUG_ON(!sg_is_last(ret));
  70 #endif
  71         return ret;
  72 }
  73 EXPORT_SYMBOL(sg_last);
  74
  75 /**
  76  * sg_init_table - Initialize SG table
  77  * @sgl:           The SG table
  78  * @nents:         Number of entries in table
  79  *
  80  * Notes:
  81  *   If this is part of a chained sg table, sg_mark_end() should be
  82  *   used only on the last table part.
  83  *
  84  **/
  85 void sg_init_table(struct scatterlist *sgl, unsigned int nents)
  86 {
  87         memset(sgl, 0, sizeof(*sgl) * nents);
  88 #ifdef CONFIG_DEBUG_SG
  89         {
  90                 unsigned int i;
  91                 for (i = 0; i < nents; i++)
  92                         sgl[i].sg_magic = SG_MAGIC;
  93         }
  94 #endif
  95         sg_mark_end(&sgl[nents - 1]);
  96 }
  97 EXPORT_SYMBOL(sg_init_table);
  98
  99 /**
 100  * sg_init_one - Initialize a single entry sg list
 101  * @sg:          SG entry
 102  * @buf:         Virtual address for IO
 103  * @buflen:      IO length
 104  *
 105  **/
 106 void sg_init_one(struct scatterlist *sg, const void *buf, unsigned int buflen)
 107 {
 108         sg_init_table(sg, 1);
 109         sg_set_buf(sg, buf, buflen);
 110 }
 111 EXPORT_SYMBOL(sg_init_one);
 112
 113 /*
 114  * The default behaviour of sg_alloc_table() is to use these kmalloc/kfree
 115  * helpers.
 116  */
 117 static struct scatterlist *sg_kmalloc(unsigned int nents, gfp_t gfp_mask)
 118 {
 119         if (nents == SG_MAX_SINGLE_ALLOC) {
 120                 /*
 121                  * Kmemleak doesn't track page allocations as they are not
 122                  * commonly used (in a raw form) for kernel data structures.
 123                  * As we chain together a list of pages and then a normal
 124                  * kmalloc (tracked by kmemleak), in order to for that last
 125                  * allocation not to become decoupled (and thus a
 126                  * false-positive) we need to inform kmemleak of all the
 127                  * intermediate allocations.
 128                  */
 129                 void *ptr = (void *) __get_free_page(gfp_mask);
 130                 kmemleak_alloc(ptr, PAGE_SIZE, 1, gfp_mask);
 131                 return ptr;
 132         } else
 133                 return kmalloc(nents * sizeof(struct scatterlist), gfp_mask);
 134 }
 135
 136 static void sg_kfree(struct scatterlist *sg, unsigned int nents)
 137 {
 138         if (nents == SG_MAX_SINGLE_ALLOC) {
 139                 kmemleak_free(sg);
 140                 free_page((unsigned long) sg);
 141         } else
 142                 kfree(sg);
 143 }
 144
 145 /**
 146  * __sg_free_table - Free a previously mapped sg table
 147  * @table:      The sg table header to use
 148  * @max_ents:   The maximum number of entries per single scatterlist
 149  * @free_fn:    Free function
 150  *
 151  *  Description:
 152  *    Free an sg table previously allocated and setup with
 153  *    __sg_alloc_table().  The @max_ents value must be identical to
 154  *    that previously used with __sg_alloc_table().
 155  *
 156  **/
 157 void __sg_free_table(struct sg_table *table, unsigned int max_ents,
 158                      sg_free_fn *free_fn)
 159 {
 160         struct scatterlist *sgl, *next;
 161
 162         if (unlikely(!table->sgl))
 163                 return;
 164
 165         sgl = table->sgl;
 166         while (table->orig_nents) {
 167                 unsigned int alloc_size = table->orig_nents;
 168                 unsigned int sg_size;
 169
 170                 /*
 171                  * If we have more than max_ents segments left,
 172                  * then assign 'next' to the sg table after the current one.
 173                  * sg_size is then one less than alloc size, since the last
 174                  * element is the chain pointer.
 175                  */
 176                 if (alloc_size > max_ents) {
 177                         next = sg_chain_ptr(&sgl[max_ents - 1]);
 178                         alloc_size = max_ents;
 179                         sg_size = alloc_size - 1;
 180                 } else {
 181                         sg_size = alloc_size;
 182                         next = NULL;
 183                 }
 184
 185                 table->orig_nents -= sg_size;
 186                 free_fn(sgl, alloc_size);
 187                 sgl = next;
 188         }
 189
 190         table->sgl = NULL;
 191 }
 192 EXPORT_SYMBOL(__sg_free_table);
 193
 194 /**
 195  * sg_free_table - Free a previously allocated sg table
 196  * @table:      The mapped sg table header
 197  *
 198  **/
 199 void sg_free_table(struct sg_table *table)
 200 {
 201         __sg_free_table(table, SG_MAX_SINGLE_ALLOC, sg_kfree);
 202 }
 203 EXPORT_SYMBOL(sg_free_table);
 204
 205 /**
 206  * __sg_alloc_table - Allocate and initialize an sg table with given allocator
 207  * @table:      The sg table header to use
 208  * @nents:      Number of entries in sg list
 209  * @max_ents:   The maximum number of entries the allocator returns per call
 210  * @gfp_mask:   GFP allocation mask
 211  * @alloc_fn:   Allocator to use
 212  *
 213  * Description:
 214  *   This function returns a @table @nents long. The allocator is
 215  *   defined to return scatterlist chunks of maximum size @max_ents.
 216  *   Thus if @nents is bigger than @max_ents, the scatterlists will be
 217  *   chained in units of @max_ents.
 218  *
 219  * Notes:
 220  *   If this function returns non-0 (eg failure), the caller must call
 221  *   __sg_free_table() to cleanup any leftover allocations.
 222  *
 223  **/
 224 int __sg_alloc_table(struct sg_table *table, unsigned int nents,
 225                      unsigned int max_ents, gfp_t gfp_mask,
 226                      sg_alloc_fn *alloc_fn)
 227 {
 228         struct scatterlist *sg, *prv;
 229         unsigned int left;
 230
 231 #ifndef ARCH_HAS_SG_CHAIN
 232         BUG_ON(nents > max_ents);
 233 #endif
 234
 235         memset(table, 0, sizeof(*table));
 236
 237         left = nents;
 238         prv = NULL;
 239         do {
 240                 unsigned int sg_size, alloc_size = left;
 241
 242                 if (alloc_size > max_ents) {
 243                         alloc_size = max_ents;
 244                         sg_size = alloc_size - 1;
 245                 } else
 246                         sg_size = alloc_size;
 247
 248                 left -= sg_size;
 249
 250                 sg = alloc_fn(alloc_size, gfp_mask);
 251                 if (unlikely(!sg)) {
 252                         /*
 253                          * Adjust entry count to reflect that the last
 254                          * entry of the previous table won't be used for
 255                          * linkage.  Without this, sg_kfree() may get
 256                          * confused.
 257                          */
 258                         if (prv)
 259                                 table->nents = ++table->orig_nents;
 260
 261                         return -ENOMEM;
 262                 }
 263
 264                 sg_init_table(sg, alloc_size);
 265                 table->nents = table->orig_nents += sg_size;
 266
 267                 /*
 268                  * If this is the first mapping, assign the sg table header.
 269                  * If this is not the first mapping, chain previous part.
 270                  */
 271                 if (prv)
 272                         sg_chain(prv, max_ents, sg);
 273                 else
 274                         table->sgl = sg;
 275
 276                 /*
 277                  * If no more entries after this one, mark the end
 278                  */
 279                 if (!left)
 280                         sg_mark_end(&sg[sg_size - 1]);
 281
 282                 prv = sg;
 283         } while (left);
 284
 285         return 0;
 286 }
 287 EXPORT_SYMBOL(__sg_alloc_table);
 288
 289 /**
 290  * sg_alloc_table - Allocate and initialize an sg table
 291  * @table:      The sg table header to use
 292  * @nents:      Number of entries in sg list
 293  * @gfp_mask:   GFP allocation mask
 294  *
 295  *  Description:
 296  *    Allocate and initialize an sg table. If @nents@ is larger than
 297  *    SG_MAX_SINGLE_ALLOC a chained sg table will be setup.
 298  *
 299  **/
 300 int sg_alloc_table(struct sg_table *table, unsigned int nents, gfp_t gfp_mask)
 301 {
 302         int ret;
 303
 304         ret = __sg_alloc_table(table, nents, SG_MAX_SINGLE_ALLOC,
 305                                gfp_mask, sg_kmalloc);
 306         if (unlikely(ret))
 307                 __sg_free_table(table, SG_MAX_SINGLE_ALLOC, sg_kfree);
 308
 309         return ret;
 310 }
 311 EXPORT_SYMBOL(sg_alloc_table);
 312
 313 /**
 314  * sg_alloc_table_from_pages - Allocate and initialize an sg table from
 315  *                             an array of pages
 316  * @sgt:        The sg table header to use
 317  * @pages:      Pointer to an array of page pointers
 318  * @n_pages:    Number of pages in the pages array
 319  * @offset:     Offset from a start of the first page to a start of a buffer
 320  * @size:       Number of valid bytes in the buffer (after offset)
 321  * @gfp_mask:   GFP allocation mask
 322  *
 323  *  Description:
 324  *    Allocate and initialize an sg table from a list of pages. Continuous
 325  *    ranges of the pages are squashed into a single scatterlist node. A user
 326  *    may provide an offset at a start and a size of valid data in a buffer
 327  *    specified by the page array. The returned sg table is released by
 328  *    sg_free_table.
 329  *
 330  * Returns:
 331  *   0 on success, negative error on failure
 332  **/
 333 int sg_alloc_table_from_pages(struct sg_table *sgt,
 334         struct page **pages, unsigned int n_pages,
 335         unsigned long offset, unsigned long size,
 336         gfp_t gfp_mask)
 337 {
 338         unsigned int chunks;
 339         unsigned int i;
 340         unsigned int cur_page;
 341         int ret;
 342         struct scatterlist *s;
 343
 344         /* compute number of contiguous chunks */
 345         chunks = 1;
 346         for (i = 1; i < n_pages; ++i)
 347                 if (pages[i] != pages[i - 1] + 1)
 348                         ++chunks;
 349
 350         ret = sg_alloc_table(sgt, chunks, gfp_mask);
 351         if (unlikely(ret))
 352                 return ret;
 353
 354         /* merging chunks and putting them into the scatterlist */
 355         cur_page = 0;
 356         for_each_sg(sgt->sgl, s, sgt->orig_nents, i) {
 357                 unsigned long chunk_size;
 358                 unsigned int j;
 359
 360                 /* looking for the end of the current chunk */
 361                 for (j = cur_page + 1; j < n_pages; ++j)
 362                         if (pages[j] != pages[j - 1] + 1)
 363                                 break;
 364
 365                 chunk_size = ((j - cur_page) << PAGE_SHIFT) - offset;
 366                 sg_set_page(s, pages[cur_page], min(size, chunk_size), offset);
 367                 size -= chunk_size;
 368                 offset = 0;
 369                 cur_page = j;
 370         }
 371
 372         return 0;
 373 }
 374 EXPORT_SYMBOL(sg_alloc_table_from_pages);
 375
 376 /**
 377  * sg_miter_start - start mapping iteration over a sg list
 378  * @miter: sg mapping iter to be started
 379  * @sgl: sg list to iterate over
 380  * @nents: number of sg entries
 381  *
 382  * Description:
 383  *   Starts mapping iterator @miter.
 384  *
 385  * Context:
 386  *   Don't care.
 387  */
 388 void sg_miter_start(struct sg_mapping_iter *miter, struct scatterlist *sgl,
 389                     unsigned int nents, unsigned int flags)
 390 {
 391         memset(miter, 0, sizeof(struct sg_mapping_iter));
 392
 393         miter->__sg = sgl;
 394         miter->__nents = nents;
 395         miter->__offset = 0;
 396         WARN_ON(!(flags & (SG_MITER_TO_SG | SG_MITER_FROM_SG)));
 397         miter->__flags = flags;
 398 }
 399 EXPORT_SYMBOL(sg_miter_start);
 400
 401 /**
 402  * sg_miter_next - proceed mapping iterator to the next mapping
 403  * @miter: sg mapping iter to proceed
 404  *
 405  * Description:
 406  *   Proceeds @miter@ to the next mapping.  @miter@ should have been
 407  *   started using sg_miter_start().  On successful return,
 408  *   @miter@->page, @miter@->addr and @miter@->length point to the
 409  *   current mapping.
 410  *
 411  * Context:
 412  *   IRQ disabled if SG_MITER_ATOMIC.  IRQ must stay disabled till
 413  *   @miter@ is stopped.  May sleep if !SG_MITER_ATOMIC.
 414  *
 415  * Returns:
 416  *   true if @miter contains the next mapping.  false if end of sg
 417  *   list is reached.
 418  */
 419 bool sg_miter_next(struct sg_mapping_iter *miter)
 420 {
 421         unsigned int off, len;
 422
 423         /* check for end and drop resources from the last iteration */
 424         if (!miter->__nents)
 425                 return false;
 426
 427         sg_miter_stop(miter);
 428
 429         /* get to the next sg if necessary.  __offset is adjusted by stop */
 430         while (miter->__offset == miter->__sg->length) {
 431                 if (--miter->__nents) {
 432                         miter->__sg = sg_next(miter->__sg);
 433                         miter->__offset = 0;
 434                 } else
 435                         return false;
 436         }
 437
 438         /* map the next page */
 439         off = miter->__sg->offset + miter->__offset;
 440         len = miter->__sg->length - miter->__offset;
 441
 442         miter->page = nth_page(sg_page(miter->__sg), off >> PAGE_SHIFT);
 443         off &= ~PAGE_MASK;
 444         miter->length = min_t(unsigned int, len, PAGE_SIZE - off);
 445         miter->consumed = miter->length;
 446
 447         if (miter->__flags & SG_MITER_ATOMIC)
 448                 miter->addr = kmap_atomic(miter->page) + off;
 449         else
 450                 miter->addr = kmap(miter->page) + off;
 451
 452         return true;
 453 }
 454 EXPORT_SYMBOL(sg_miter_next);
 455
 456 /**
 457  * sg_miter_stop - stop mapping iteration
 458  * @miter: sg mapping iter to be stopped
 459  *
 460  * Description:
 461  *   Stops mapping iterator @miter.  @miter should have been started
 462  *   started using sg_miter_start().  A stopped iteration can be
 463  *   resumed by calling sg_miter_next() on it.  This is useful when
 464  *   resources (kmap) need to be released during iteration.
 465  *
 466  * Context:
 467  *   IRQ disabled if the SG_MITER_ATOMIC is set.  Don't care otherwise.
 468  */
 469 void sg_miter_stop(struct sg_mapping_iter *miter)
 470 {
 471         WARN_ON(miter->consumed > miter->length);
 472
 473         /* drop resources from the last iteration */
 474         if (miter->addr) {
 475                 miter->__offset += miter->consumed;
 476
 477                 if (miter->__flags & SG_MITER_TO_SG)
 478                         flush_kernel_dcache_page(miter->page);
 479
 480                 if (miter->__flags & SG_MITER_ATOMIC) {
 481                         WARN_ON(!irqs_disabled());
 482                         kunmap_atomic(miter->addr);
 483                 } else
 484                         kunmap(miter->page);
 485
 486                 miter->page = NULL;
 487                 miter->addr = NULL;
 488                 miter->length = 0;
 489                 miter->consumed = 0;
 490         }
 491 }
 492 EXPORT_SYMBOL(sg_miter_stop);
 493
 494 /**
 495  * sg_copy_buffer - Copy data between a linear buffer and an SG list
 496  * @sgl:                 The SG list
 497  * @nents:               Number of SG entries
 498  * @buf:                 Where to copy from
 499  * @buflen:              The number of bytes to copy
 500  * @to_buffer:           transfer direction (non zero == from an sg list to a
 501  *                       buffer, 0 == from a buffer to an sg list
 502  *
 503  * Returns the number of copied bytes.
 504  *
 505  **/
 506 static size_t sg_copy_buffer(struct scatterlist *sgl, unsigned int nents,
 507                              void *buf, size_t buflen, int to_buffer)
 508 {
 509         unsigned int offset = 0;
 510         struct sg_mapping_iter miter;
 511         unsigned long flags;
 512         unsigned int sg_flags = SG_MITER_ATOMIC;
 513
 514         if (to_buffer)
 515                 sg_flags |= SG_MITER_FROM_SG;
 516         else
 517                 sg_flags |= SG_MITER_TO_SG;
 518
 519         sg_miter_start(&miter, sgl, nents, sg_flags);
 520
 521         local_irq_save(flags);
 522
 523         while (sg_miter_next(&miter) && offset < buflen) {
 524                 unsigned int len;
 525
 526                 len = min(miter.length, buflen - offset);
 527
 528                 if (to_buffer)
 529                         memcpy(buf + offset, miter.addr, len);
 530                 else
 531                         memcpy(miter.addr, buf + offset, len);
 532
 533                 offset += len;
 534         }
 535
 536         sg_miter_stop(&miter);
 537
 538         local_irq_restore(flags);
 539         return offset;
 540 }
 541
 542 /**
 543  * sg_copy_from_buffer - Copy from a linear buffer to an SG list
 544  * @sgl:                 The SG list
 545  * @nents:               Number of SG entries
 546  * @buf:                 Where to copy from
 547  * @buflen:              The number of bytes to copy
 548  *
 549  * Returns the number of copied bytes.
 550  *
 551  **/
 552 size_t sg_copy_from_buffer(struct scatterlist *sgl, unsigned int nents,
 553                            void *buf, size_t buflen)
 554 {
 555         return sg_copy_buffer(sgl, nents, buf, buflen, 0);
 556 }
 557 EXPORT_SYMBOL(sg_copy_from_buffer);
 558
 559 /**
 560  * sg_copy_to_buffer - Copy from an SG list to a linear buffer
 561  * @sgl:                 The SG list
 562  * @nents:               Number of SG entries
 563  * @buf:                 Where to copy to
 564  * @buflen:              The number of bytes to copy
 565  *
 566  * Returns the number of copied bytes.
 567  *
 568  **/
 569 size_t sg_copy_to_buffer(struct scatterlist *sgl, unsigned int nents,
 570                          void *buf, size_t buflen)
 571 {
 572         return sg_copy_buffer(sgl, nents, buf, buflen, 1);
 573 }
 574 EXPORT_SYMBOL(sg_copy_to_buffer);