scatterlist.c 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829
  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. * sg_next - return the next scatterlist entry in a list
  16. * @sg: The current sg entry
  17. *
  18. * Description:
  19. * Usually the next entry will be @sg@ + 1, but if this sg element is part
  20. * of a chained scatterlist, it could jump to the start of a new
  21. * scatterlist array.
  22. *
  23. **/
  24. struct scatterlist *sg_next(struct scatterlist *sg)
  25. {
  26. #ifdef CONFIG_DEBUG_SG
  27. BUG_ON(sg->sg_magic != SG_MAGIC);
  28. #endif
  29. if (sg_is_last(sg))
  30. return NULL;
  31. sg++;
  32. if (unlikely(sg_is_chain(sg)))
  33. sg = sg_chain_ptr(sg);
  34. return sg;
  35. }
  36. EXPORT_SYMBOL(sg_next);
  37. /**
  38. * sg_nents - return total count of entries in scatterlist
  39. * @sg: The scatterlist
  40. *
  41. * Description:
  42. * Allows to know how many entries are in sg, taking into acount
  43. * chaining as well
  44. *
  45. **/
  46. int sg_nents(struct scatterlist *sg)
  47. {
  48. int nents;
  49. for (nents = 0; sg; sg = sg_next(sg))
  50. nents++;
  51. return nents;
  52. }
  53. EXPORT_SYMBOL(sg_nents);
  54. /**
  55. * sg_nents_for_len - return total count of entries in scatterlist
  56. * needed to satisfy the supplied length
  57. * @sg: The scatterlist
  58. * @len: The total required length
  59. *
  60. * Description:
  61. * Determines the number of entries in sg that are required to meet
  62. * the supplied length, taking into acount chaining as well
  63. *
  64. * Returns:
  65. * the number of sg entries needed, negative error on failure
  66. *
  67. **/
  68. int sg_nents_for_len(struct scatterlist *sg, u64 len)
  69. {
  70. int nents;
  71. u64 total;
  72. if (!len)
  73. return 0;
  74. for (nents = 0, total = 0; sg; sg = sg_next(sg)) {
  75. nents++;
  76. total += sg->length;
  77. if (total >= len)
  78. return nents;
  79. }
  80. return -EINVAL;
  81. }
  82. EXPORT_SYMBOL(sg_nents_for_len);
  83. /**
  84. * sg_last - return the last scatterlist entry in a list
  85. * @sgl: First entry in the scatterlist
  86. * @nents: Number of entries in the scatterlist
  87. *
  88. * Description:
  89. * Should only be used casually, it (currently) scans the entire list
  90. * to get the last entry.
  91. *
  92. * Note that the @sgl@ pointer passed in need not be the first one,
  93. * the important bit is that @nents@ denotes the number of entries that
  94. * exist from @sgl@.
  95. *
  96. **/
  97. struct scatterlist *sg_last(struct scatterlist *sgl, unsigned int nents)
  98. {
  99. struct scatterlist *sg, *ret = NULL;
  100. unsigned int i;
  101. for_each_sg(sgl, sg, nents, i)
  102. ret = sg;
  103. #ifdef CONFIG_DEBUG_SG
  104. BUG_ON(sgl[0].sg_magic != SG_MAGIC);
  105. BUG_ON(!sg_is_last(ret));
  106. #endif
  107. return ret;
  108. }
  109. EXPORT_SYMBOL(sg_last);
  110. /**
  111. * sg_init_table - Initialize SG table
  112. * @sgl: The SG table
  113. * @nents: Number of entries in table
  114. *
  115. * Notes:
  116. * If this is part of a chained sg table, sg_mark_end() should be
  117. * used only on the last table part.
  118. *
  119. **/
  120. void sg_init_table(struct scatterlist *sgl, unsigned int nents)
  121. {
  122. memset(sgl, 0, sizeof(*sgl) * nents);
  123. #ifdef CONFIG_DEBUG_SG
  124. {
  125. unsigned int i;
  126. for (i = 0; i < nents; i++)
  127. sgl[i].sg_magic = SG_MAGIC;
  128. }
  129. #endif
  130. sg_mark_end(&sgl[nents - 1]);
  131. }
  132. EXPORT_SYMBOL(sg_init_table);
  133. /**
  134. * sg_init_one - Initialize a single entry sg list
  135. * @sg: SG entry
  136. * @buf: Virtual address for IO
  137. * @buflen: IO length
  138. *
  139. **/
  140. void sg_init_one(struct scatterlist *sg, const void *buf, unsigned int buflen)
  141. {
  142. sg_init_table(sg, 1);
  143. sg_set_buf(sg, buf, buflen);
  144. }
  145. EXPORT_SYMBOL(sg_init_one);
  146. /*
  147. * The default behaviour of sg_alloc_table() is to use these kmalloc/kfree
  148. * helpers.
  149. */
  150. static struct scatterlist *sg_kmalloc(unsigned int nents, gfp_t gfp_mask)
  151. {
  152. if (nents == SG_MAX_SINGLE_ALLOC) {
  153. /*
  154. * Kmemleak doesn't track page allocations as they are not
  155. * commonly used (in a raw form) for kernel data structures.
  156. * As we chain together a list of pages and then a normal
  157. * kmalloc (tracked by kmemleak), in order to for that last
  158. * allocation not to become decoupled (and thus a
  159. * false-positive) we need to inform kmemleak of all the
  160. * intermediate allocations.
  161. */
  162. void *ptr = (void *) __get_free_page(gfp_mask);
  163. kmemleak_alloc(ptr, PAGE_SIZE, 1, gfp_mask);
  164. return ptr;
  165. } else
  166. return kmalloc(nents * sizeof(struct scatterlist), gfp_mask);
  167. }
  168. static void sg_kfree(struct scatterlist *sg, unsigned int nents)
  169. {
  170. if (nents == SG_MAX_SINGLE_ALLOC) {
  171. kmemleak_free(sg);
  172. free_page((unsigned long) sg);
  173. } else
  174. kfree(sg);
  175. }
  176. /**
  177. * __sg_free_table - Free a previously mapped sg table
  178. * @table: The sg table header to use
  179. * @max_ents: The maximum number of entries per single scatterlist
  180. * @skip_first_chunk: don't free the (preallocated) first scatterlist chunk
  181. * @free_fn: Free function
  182. *
  183. * Description:
  184. * Free an sg table previously allocated and setup with
  185. * __sg_alloc_table(). The @max_ents value must be identical to
  186. * that previously used with __sg_alloc_table().
  187. *
  188. **/
  189. void __sg_free_table(struct sg_table *table, unsigned int max_ents,
  190. bool skip_first_chunk, sg_free_fn *free_fn)
  191. {
  192. struct scatterlist *sgl, *next;
  193. if (unlikely(!table->sgl))
  194. return;
  195. sgl = table->sgl;
  196. while (table->orig_nents) {
  197. unsigned int alloc_size = table->orig_nents;
  198. unsigned int sg_size;
  199. /*
  200. * If we have more than max_ents segments left,
  201. * then assign 'next' to the sg table after the current one.
  202. * sg_size is then one less than alloc size, since the last
  203. * element is the chain pointer.
  204. */
  205. if (alloc_size > max_ents) {
  206. next = sg_chain_ptr(&sgl[max_ents - 1]);
  207. alloc_size = max_ents;
  208. sg_size = alloc_size - 1;
  209. } else {
  210. sg_size = alloc_size;
  211. next = NULL;
  212. }
  213. table->orig_nents -= sg_size;
  214. if (skip_first_chunk)
  215. skip_first_chunk = false;
  216. else
  217. free_fn(sgl, alloc_size);
  218. sgl = next;
  219. }
  220. table->sgl = NULL;
  221. }
  222. EXPORT_SYMBOL(__sg_free_table);
  223. /**
  224. * sg_free_table - Free a previously allocated sg table
  225. * @table: The mapped sg table header
  226. *
  227. **/
  228. void sg_free_table(struct sg_table *table)
  229. {
  230. __sg_free_table(table, SG_MAX_SINGLE_ALLOC, false, sg_kfree);
  231. }
  232. EXPORT_SYMBOL(sg_free_table);
  233. /**
  234. * __sg_alloc_table - Allocate and initialize an sg table with given allocator
  235. * @table: The sg table header to use
  236. * @nents: Number of entries in sg list
  237. * @max_ents: The maximum number of entries the allocator returns per call
  238. * @gfp_mask: GFP allocation mask
  239. * @alloc_fn: Allocator to use
  240. *
  241. * Description:
  242. * This function returns a @table @nents long. The allocator is
  243. * defined to return scatterlist chunks of maximum size @max_ents.
  244. * Thus if @nents is bigger than @max_ents, the scatterlists will be
  245. * chained in units of @max_ents.
  246. *
  247. * Notes:
  248. * If this function returns non-0 (eg failure), the caller must call
  249. * __sg_free_table() to cleanup any leftover allocations.
  250. *
  251. **/
  252. int __sg_alloc_table(struct sg_table *table, unsigned int nents,
  253. unsigned int max_ents, struct scatterlist *first_chunk,
  254. gfp_t gfp_mask, sg_alloc_fn *alloc_fn)
  255. {
  256. struct scatterlist *sg, *prv;
  257. unsigned int left;
  258. memset(table, 0, sizeof(*table));
  259. if (nents == 0)
  260. return -EINVAL;
  261. #ifndef CONFIG_ARCH_HAS_SG_CHAIN
  262. if (WARN_ON_ONCE(nents > max_ents))
  263. return -EINVAL;
  264. #endif
  265. left = nents;
  266. prv = NULL;
  267. do {
  268. unsigned int sg_size, alloc_size = left;
  269. if (alloc_size > max_ents) {
  270. alloc_size = max_ents;
  271. sg_size = alloc_size - 1;
  272. } else
  273. sg_size = alloc_size;
  274. left -= sg_size;
  275. if (first_chunk) {
  276. sg = first_chunk;
  277. first_chunk = NULL;
  278. } else {
  279. sg = alloc_fn(alloc_size, gfp_mask);
  280. }
  281. if (unlikely(!sg)) {
  282. /*
  283. * Adjust entry count to reflect that the last
  284. * entry of the previous table won't be used for
  285. * linkage. Without this, sg_kfree() may get
  286. * confused.
  287. */
  288. if (prv)
  289. table->nents = ++table->orig_nents;
  290. return -ENOMEM;
  291. }
  292. sg_init_table(sg, alloc_size);
  293. table->nents = table->orig_nents += sg_size;
  294. /*
  295. * If this is the first mapping, assign the sg table header.
  296. * If this is not the first mapping, chain previous part.
  297. */
  298. if (prv)
  299. sg_chain(prv, max_ents, sg);
  300. else
  301. table->sgl = sg;
  302. /*
  303. * If no more entries after this one, mark the end
  304. */
  305. if (!left)
  306. sg_mark_end(&sg[sg_size - 1]);
  307. prv = sg;
  308. } while (left);
  309. return 0;
  310. }
  311. EXPORT_SYMBOL(__sg_alloc_table);
  312. /**
  313. * sg_alloc_table - Allocate and initialize an sg table
  314. * @table: The sg table header to use
  315. * @nents: Number of entries in sg list
  316. * @gfp_mask: GFP allocation mask
  317. *
  318. * Description:
  319. * Allocate and initialize an sg table. If @nents@ is larger than
  320. * SG_MAX_SINGLE_ALLOC a chained sg table will be setup.
  321. *
  322. **/
  323. int sg_alloc_table(struct sg_table *table, unsigned int nents, gfp_t gfp_mask)
  324. {
  325. int ret;
  326. ret = __sg_alloc_table(table, nents, SG_MAX_SINGLE_ALLOC,
  327. NULL, gfp_mask, sg_kmalloc);
  328. if (unlikely(ret))
  329. __sg_free_table(table, SG_MAX_SINGLE_ALLOC, false, sg_kfree);
  330. return ret;
  331. }
  332. EXPORT_SYMBOL(sg_alloc_table);
  333. /**
  334. * __sg_alloc_table_from_pages - Allocate and initialize an sg table from
  335. * an array of pages
  336. * @sgt: The sg table header to use
  337. * @pages: Pointer to an array of page pointers
  338. * @n_pages: Number of pages in the pages array
  339. * @offset: Offset from start of the first page to the start of a buffer
  340. * @size: Number of valid bytes in the buffer (after offset)
  341. * @max_segment: Maximum size of a scatterlist node in bytes (page aligned)
  342. * @gfp_mask: GFP allocation mask
  343. *
  344. * Description:
  345. * Allocate and initialize an sg table from a list of pages. Contiguous
  346. * ranges of the pages are squashed into a single scatterlist node up to the
  347. * maximum size specified in @max_segment. An user may provide an offset at a
  348. * start and a size of valid data in a buffer specified by the page array.
  349. * The returned sg table is released by sg_free_table.
  350. *
  351. * Returns:
  352. * 0 on success, negative error on failure
  353. */
  354. int __sg_alloc_table_from_pages(struct sg_table *sgt, struct page **pages,
  355. unsigned int n_pages, unsigned int offset,
  356. unsigned long size, unsigned int max_segment,
  357. gfp_t gfp_mask)
  358. {
  359. unsigned int chunks, cur_page, seg_len, i;
  360. int ret;
  361. struct scatterlist *s;
  362. if (WARN_ON(!max_segment || offset_in_page(max_segment)))
  363. return -EINVAL;
  364. /* compute number of contiguous chunks */
  365. chunks = 1;
  366. seg_len = 0;
  367. for (i = 1; i < n_pages; i++) {
  368. seg_len += PAGE_SIZE;
  369. if (seg_len >= max_segment ||
  370. page_to_pfn(pages[i]) != page_to_pfn(pages[i - 1]) + 1) {
  371. chunks++;
  372. seg_len = 0;
  373. }
  374. }
  375. ret = sg_alloc_table(sgt, chunks, gfp_mask);
  376. if (unlikely(ret))
  377. return ret;
  378. /* merging chunks and putting them into the scatterlist */
  379. cur_page = 0;
  380. for_each_sg(sgt->sgl, s, sgt->orig_nents, i) {
  381. unsigned int j, chunk_size;
  382. /* look for the end of the current chunk */
  383. seg_len = 0;
  384. for (j = cur_page + 1; j < n_pages; j++) {
  385. seg_len += PAGE_SIZE;
  386. if (seg_len >= max_segment ||
  387. page_to_pfn(pages[j]) !=
  388. page_to_pfn(pages[j - 1]) + 1)
  389. break;
  390. }
  391. chunk_size = ((j - cur_page) << PAGE_SHIFT) - offset;
  392. sg_set_page(s, pages[cur_page],
  393. min_t(unsigned long, size, chunk_size), offset);
  394. size -= chunk_size;
  395. offset = 0;
  396. cur_page = j;
  397. }
  398. return 0;
  399. }
  400. EXPORT_SYMBOL(__sg_alloc_table_from_pages);
  401. /**
  402. * sg_alloc_table_from_pages - Allocate and initialize an sg table from
  403. * an array of pages
  404. * @sgt: The sg table header to use
  405. * @pages: Pointer to an array of page pointers
  406. * @n_pages: Number of pages in the pages array
  407. * @offset: Offset from start of the first page to the start of a buffer
  408. * @size: Number of valid bytes in the buffer (after offset)
  409. * @gfp_mask: GFP allocation mask
  410. *
  411. * Description:
  412. * Allocate and initialize an sg table from a list of pages. Contiguous
  413. * ranges of the pages are squashed into a single scatterlist node. A user
  414. * may provide an offset at a start and a size of valid data in a buffer
  415. * specified by the page array. The returned sg table is released by
  416. * sg_free_table.
  417. *
  418. * Returns:
  419. * 0 on success, negative error on failure
  420. */
  421. int sg_alloc_table_from_pages(struct sg_table *sgt, struct page **pages,
  422. unsigned int n_pages, unsigned int offset,
  423. unsigned long size, gfp_t gfp_mask)
  424. {
  425. return __sg_alloc_table_from_pages(sgt, pages, n_pages, offset, size,
  426. SCATTERLIST_MAX_SEGMENT, gfp_mask);
  427. }
  428. EXPORT_SYMBOL(sg_alloc_table_from_pages);
  429. void __sg_page_iter_start(struct sg_page_iter *piter,
  430. struct scatterlist *sglist, unsigned int nents,
  431. unsigned long pgoffset)
  432. {
  433. piter->__pg_advance = 0;
  434. piter->__nents = nents;
  435. piter->sg = sglist;
  436. piter->sg_pgoffset = pgoffset;
  437. }
  438. EXPORT_SYMBOL(__sg_page_iter_start);
  439. static int sg_page_count(struct scatterlist *sg)
  440. {
  441. return PAGE_ALIGN(sg->offset + sg->length) >> PAGE_SHIFT;
  442. }
  443. bool __sg_page_iter_next(struct sg_page_iter *piter)
  444. {
  445. if (!piter->__nents || !piter->sg)
  446. return false;
  447. piter->sg_pgoffset += piter->__pg_advance;
  448. piter->__pg_advance = 1;
  449. while (piter->sg_pgoffset >= sg_page_count(piter->sg)) {
  450. piter->sg_pgoffset -= sg_page_count(piter->sg);
  451. piter->sg = sg_next(piter->sg);
  452. if (!--piter->__nents || !piter->sg)
  453. return false;
  454. }
  455. return true;
  456. }
  457. EXPORT_SYMBOL(__sg_page_iter_next);
  458. /**
  459. * sg_miter_start - start mapping iteration over a sg list
  460. * @miter: sg mapping iter to be started
  461. * @sgl: sg list to iterate over
  462. * @nents: number of sg entries
  463. *
  464. * Description:
  465. * Starts mapping iterator @miter.
  466. *
  467. * Context:
  468. * Don't care.
  469. */
  470. void sg_miter_start(struct sg_mapping_iter *miter, struct scatterlist *sgl,
  471. unsigned int nents, unsigned int flags)
  472. {
  473. memset(miter, 0, sizeof(struct sg_mapping_iter));
  474. __sg_page_iter_start(&miter->piter, sgl, nents, 0);
  475. WARN_ON(!(flags & (SG_MITER_TO_SG | SG_MITER_FROM_SG)));
  476. miter->__flags = flags;
  477. }
  478. EXPORT_SYMBOL(sg_miter_start);
  479. static bool sg_miter_get_next_page(struct sg_mapping_iter *miter)
  480. {
  481. if (!miter->__remaining) {
  482. struct scatterlist *sg;
  483. unsigned long pgoffset;
  484. if (!__sg_page_iter_next(&miter->piter))
  485. return false;
  486. sg = miter->piter.sg;
  487. pgoffset = miter->piter.sg_pgoffset;
  488. miter->__offset = pgoffset ? 0 : sg->offset;
  489. miter->__remaining = sg->offset + sg->length -
  490. (pgoffset << PAGE_SHIFT) - miter->__offset;
  491. miter->__remaining = min_t(unsigned long, miter->__remaining,
  492. PAGE_SIZE - miter->__offset);
  493. }
  494. return true;
  495. }
  496. /**
  497. * sg_miter_skip - reposition mapping iterator
  498. * @miter: sg mapping iter to be skipped
  499. * @offset: number of bytes to plus the current location
  500. *
  501. * Description:
  502. * Sets the offset of @miter to its current location plus @offset bytes.
  503. * If mapping iterator @miter has been proceeded by sg_miter_next(), this
  504. * stops @miter.
  505. *
  506. * Context:
  507. * Don't care if @miter is stopped, or not proceeded yet.
  508. * Otherwise, preemption disabled if the SG_MITER_ATOMIC is set.
  509. *
  510. * Returns:
  511. * true if @miter contains the valid mapping. false if end of sg
  512. * list is reached.
  513. */
  514. bool sg_miter_skip(struct sg_mapping_iter *miter, off_t offset)
  515. {
  516. sg_miter_stop(miter);
  517. while (offset) {
  518. off_t consumed;
  519. if (!sg_miter_get_next_page(miter))
  520. return false;
  521. consumed = min_t(off_t, offset, miter->__remaining);
  522. miter->__offset += consumed;
  523. miter->__remaining -= consumed;
  524. offset -= consumed;
  525. }
  526. return true;
  527. }
  528. EXPORT_SYMBOL(sg_miter_skip);
  529. /**
  530. * sg_miter_next - proceed mapping iterator to the next mapping
  531. * @miter: sg mapping iter to proceed
  532. *
  533. * Description:
  534. * Proceeds @miter to the next mapping. @miter should have been started
  535. * using sg_miter_start(). On successful return, @miter->page,
  536. * @miter->addr and @miter->length point to the current mapping.
  537. *
  538. * Context:
  539. * Preemption disabled if SG_MITER_ATOMIC. Preemption must stay disabled
  540. * till @miter is stopped. May sleep if !SG_MITER_ATOMIC.
  541. *
  542. * Returns:
  543. * true if @miter contains the next mapping. false if end of sg
  544. * list is reached.
  545. */
  546. bool sg_miter_next(struct sg_mapping_iter *miter)
  547. {
  548. sg_miter_stop(miter);
  549. /*
  550. * Get to the next page if necessary.
  551. * __remaining, __offset is adjusted by sg_miter_stop
  552. */
  553. if (!sg_miter_get_next_page(miter))
  554. return false;
  555. miter->page = sg_page_iter_page(&miter->piter);
  556. miter->consumed = miter->length = miter->__remaining;
  557. if (miter->__flags & SG_MITER_ATOMIC)
  558. miter->addr = kmap_atomic(miter->page) + miter->__offset;
  559. else
  560. miter->addr = kmap(miter->page) + miter->__offset;
  561. return true;
  562. }
  563. EXPORT_SYMBOL(sg_miter_next);
  564. /**
  565. * sg_miter_stop - stop mapping iteration
  566. * @miter: sg mapping iter to be stopped
  567. *
  568. * Description:
  569. * Stops mapping iterator @miter. @miter should have been started
  570. * using sg_miter_start(). A stopped iteration can be resumed by
  571. * calling sg_miter_next() on it. This is useful when resources (kmap)
  572. * need to be released during iteration.
  573. *
  574. * Context:
  575. * Preemption disabled if the SG_MITER_ATOMIC is set. Don't care
  576. * otherwise.
  577. */
  578. void sg_miter_stop(struct sg_mapping_iter *miter)
  579. {
  580. WARN_ON(miter->consumed > miter->length);
  581. /* drop resources from the last iteration */
  582. if (miter->addr) {
  583. miter->__offset += miter->consumed;
  584. miter->__remaining -= miter->consumed;
  585. if ((miter->__flags & SG_MITER_TO_SG) &&
  586. !PageSlab(miter->page))
  587. flush_kernel_dcache_page(miter->page);
  588. if (miter->__flags & SG_MITER_ATOMIC) {
  589. WARN_ON_ONCE(preemptible());
  590. kunmap_atomic(miter->addr);
  591. } else
  592. kunmap(miter->page);
  593. miter->page = NULL;
  594. miter->addr = NULL;
  595. miter->length = 0;
  596. miter->consumed = 0;
  597. }
  598. }
  599. EXPORT_SYMBOL(sg_miter_stop);
  600. /**
  601. * sg_copy_buffer - Copy data between a linear buffer and an SG list
  602. * @sgl: The SG list
  603. * @nents: Number of SG entries
  604. * @buf: Where to copy from
  605. * @buflen: The number of bytes to copy
  606. * @skip: Number of bytes to skip before copying
  607. * @to_buffer: transfer direction (true == from an sg list to a
  608. * buffer, false == from a buffer to an sg list
  609. *
  610. * Returns the number of copied bytes.
  611. *
  612. **/
  613. size_t sg_copy_buffer(struct scatterlist *sgl, unsigned int nents, void *buf,
  614. size_t buflen, off_t skip, bool to_buffer)
  615. {
  616. unsigned int offset = 0;
  617. struct sg_mapping_iter miter;
  618. unsigned int sg_flags = SG_MITER_ATOMIC;
  619. if (to_buffer)
  620. sg_flags |= SG_MITER_FROM_SG;
  621. else
  622. sg_flags |= SG_MITER_TO_SG;
  623. sg_miter_start(&miter, sgl, nents, sg_flags);
  624. if (!sg_miter_skip(&miter, skip))
  625. return false;
  626. while ((offset < buflen) && sg_miter_next(&miter)) {
  627. unsigned int len;
  628. len = min(miter.length, buflen - offset);
  629. if (to_buffer)
  630. memcpy(buf + offset, miter.addr, len);
  631. else
  632. memcpy(miter.addr, buf + offset, len);
  633. offset += len;
  634. }
  635. sg_miter_stop(&miter);
  636. return offset;
  637. }
  638. EXPORT_SYMBOL(sg_copy_buffer);
  639. /**
  640. * sg_copy_from_buffer - Copy from a linear buffer to an SG list
  641. * @sgl: The SG list
  642. * @nents: Number of SG entries
  643. * @buf: Where to copy from
  644. * @buflen: The number of bytes to copy
  645. *
  646. * Returns the number of copied bytes.
  647. *
  648. **/
  649. size_t sg_copy_from_buffer(struct scatterlist *sgl, unsigned int nents,
  650. const void *buf, size_t buflen)
  651. {
  652. return sg_copy_buffer(sgl, nents, (void *)buf, buflen, 0, false);
  653. }
  654. EXPORT_SYMBOL(sg_copy_from_buffer);
  655. /**
  656. * sg_copy_to_buffer - Copy from an SG list to a linear buffer
  657. * @sgl: The SG list
  658. * @nents: Number of SG entries
  659. * @buf: Where to copy to
  660. * @buflen: The number of bytes to copy
  661. *
  662. * Returns the number of copied bytes.
  663. *
  664. **/
  665. size_t sg_copy_to_buffer(struct scatterlist *sgl, unsigned int nents,
  666. void *buf, size_t buflen)
  667. {
  668. return sg_copy_buffer(sgl, nents, buf, buflen, 0, true);
  669. }
  670. EXPORT_SYMBOL(sg_copy_to_buffer);
  671. /**
  672. * sg_pcopy_from_buffer - Copy from a linear buffer to an SG list
  673. * @sgl: The SG list
  674. * @nents: Number of SG entries
  675. * @buf: Where to copy from
  676. * @buflen: The number of bytes to copy
  677. * @skip: Number of bytes to skip before copying
  678. *
  679. * Returns the number of copied bytes.
  680. *
  681. **/
  682. size_t sg_pcopy_from_buffer(struct scatterlist *sgl, unsigned int nents,
  683. const void *buf, size_t buflen, off_t skip)
  684. {
  685. return sg_copy_buffer(sgl, nents, (void *)buf, buflen, skip, false);
  686. }
  687. EXPORT_SYMBOL(sg_pcopy_from_buffer);
  688. /**
  689. * sg_pcopy_to_buffer - Copy from an SG list to a linear buffer
  690. * @sgl: The SG list
  691. * @nents: Number of SG entries
  692. * @buf: Where to copy to
  693. * @buflen: The number of bytes to copy
  694. * @skip: Number of bytes to skip before copying
  695. *
  696. * Returns the number of copied bytes.
  697. *
  698. **/
  699. size_t sg_pcopy_to_buffer(struct scatterlist *sgl, unsigned int nents,
  700. void *buf, size_t buflen, off_t skip)
  701. {
  702. return sg_copy_buffer(sgl, nents, buf, buflen, skip, true);
  703. }
  704. EXPORT_SYMBOL(sg_pcopy_to_buffer);
  705. /**
  706. * sg_zero_buffer - Zero-out a part of a SG list
  707. * @sgl: The SG list
  708. * @nents: Number of SG entries
  709. * @buflen: The number of bytes to zero out
  710. * @skip: Number of bytes to skip before zeroing
  711. *
  712. * Returns the number of bytes zeroed.
  713. **/
  714. size_t sg_zero_buffer(struct scatterlist *sgl, unsigned int nents,
  715. size_t buflen, off_t skip)
  716. {
  717. unsigned int offset = 0;
  718. struct sg_mapping_iter miter;
  719. unsigned int sg_flags = SG_MITER_ATOMIC | SG_MITER_TO_SG;
  720. sg_miter_start(&miter, sgl, nents, sg_flags);
  721. if (!sg_miter_skip(&miter, skip))
  722. return false;
  723. while (offset < buflen && sg_miter_next(&miter)) {
  724. unsigned int len;
  725. len = min(miter.length, buflen - offset);
  726. memset(miter.addr, 0, len);
  727. offset += len;
  728. }
  729. sg_miter_stop(&miter);
  730. return offset;
  731. }
  732. EXPORT_SYMBOL(sg_zero_buffer);