1
2
3
4
5
6
7
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
17
18
19
20
21
22
23
24
25struct 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}
39EXPORT_SYMBOL(sg_next);
40
41
42
43
44
45
46
47
48
49
50int sg_nents(struct scatterlist *sg)
51{
52 int nents;
53 for (nents = 0; sg; sg = sg_next(sg))
54 nents++;
55 return nents;
56}
57EXPORT_SYMBOL(sg_nents);
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73int 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}
90EXPORT_SYMBOL(sg_nents_for_len);
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106struct 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}
120EXPORT_SYMBOL(sg_last);
121
122
123
124
125
126
127
128
129
130
131
132void 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}
144EXPORT_SYMBOL(sg_init_table);
145
146
147
148
149
150
151
152
153void 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}
158EXPORT_SYMBOL(sg_init_one);
159
160
161
162
163
164static struct scatterlist *sg_kmalloc(unsigned int nents, gfp_t gfp_mask)
165{
166 if (nents == SG_MAX_SINGLE_ALLOC) {
167
168
169
170
171
172
173
174
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
183static 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
194
195
196
197
198
199
200
201
202
203
204
205void __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
220
221
222
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}
243EXPORT_SYMBOL(__sg_free_table);
244
245
246
247
248
249
250void sg_free_table(struct sg_table *table)
251{
252 __sg_free_table(table, SG_MAX_SINGLE_ALLOC, false, sg_kfree);
253}
254EXPORT_SYMBOL(sg_free_table);
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275int __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
313
314
315
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
328
329
330 if (prv)
331 sg_chain(prv, max_ents, sg);
332 else
333 table->sgl = sg;
334
335
336
337
338 if (!left)
339 sg_mark_end(&sg[sg_size - 1]);
340
341 prv = sg;
342 } while (left);
343
344 return 0;
345}
346EXPORT_SYMBOL(__sg_alloc_table);
347
348
349
350
351
352
353
354
355
356
357
358
359int 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}
370EXPORT_SYMBOL(sg_alloc_table);
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393int __sg_alloc_table_from_pages(struct sg_table *sgt, struct page **pages,
394 unsigned int n_pages, unsigned int offset,
395 unsigned long size, unsigned int max_segment,
396 gfp_t gfp_mask)
397{
398 unsigned int chunks, cur_page, seg_len, i;
399 int ret;
400 struct scatterlist *s;
401
402 if (WARN_ON(!max_segment || offset_in_page(max_segment)))
403 return -EINVAL;
404
405
406 chunks = 1;
407 seg_len = 0;
408 for (i = 1; i < n_pages; i++) {
409 seg_len += PAGE_SIZE;
410 if (seg_len >= max_segment ||
411 page_to_pfn(pages[i]) != page_to_pfn(pages[i - 1]) + 1) {
412 chunks++;
413 seg_len = 0;
414 }
415 }
416
417 ret = sg_alloc_table(sgt, chunks, gfp_mask);
418 if (unlikely(ret))
419 return ret;
420
421
422 cur_page = 0;
423 for_each_sg(sgt->sgl, s, sgt->orig_nents, i) {
424 unsigned int j, chunk_size;
425
426
427 seg_len = 0;
428 for (j = cur_page + 1; j < n_pages; j++) {
429 seg_len += PAGE_SIZE;
430 if (seg_len >= max_segment ||
431 page_to_pfn(pages[j]) !=
432 page_to_pfn(pages[j - 1]) + 1)
433 break;
434 }
435
436 chunk_size = ((j - cur_page) << PAGE_SHIFT) - offset;
437 sg_set_page(s, pages[cur_page],
438 min_t(unsigned long, size, chunk_size), offset);
439 size -= chunk_size;
440 offset = 0;
441 cur_page = j;
442 }
443
444 return 0;
445}
446EXPORT_SYMBOL(__sg_alloc_table_from_pages);
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468int sg_alloc_table_from_pages(struct sg_table *sgt, struct page **pages,
469 unsigned int n_pages, unsigned int offset,
470 unsigned long size, gfp_t gfp_mask)
471{
472 return __sg_alloc_table_from_pages(sgt, pages, n_pages, offset, size,
473 SCATTERLIST_MAX_SEGMENT, gfp_mask);
474}
475EXPORT_SYMBOL(sg_alloc_table_from_pages);
476
477void __sg_page_iter_start(struct sg_page_iter *piter,
478 struct scatterlist *sglist, unsigned int nents,
479 unsigned long pgoffset)
480{
481 piter->__pg_advance = 0;
482 piter->__nents = nents;
483
484 piter->sg = sglist;
485 piter->sg_pgoffset = pgoffset;
486}
487EXPORT_SYMBOL(__sg_page_iter_start);
488
489static int sg_page_count(struct scatterlist *sg)
490{
491 return PAGE_ALIGN(sg->offset + sg->length) >> PAGE_SHIFT;
492}
493
494bool __sg_page_iter_next(struct sg_page_iter *piter)
495{
496 if (!piter->__nents || !piter->sg)
497 return false;
498
499 piter->sg_pgoffset += piter->__pg_advance;
500 piter->__pg_advance = 1;
501
502 while (piter->sg_pgoffset >= sg_page_count(piter->sg)) {
503 piter->sg_pgoffset -= sg_page_count(piter->sg);
504 piter->sg = sg_next(piter->sg);
505 if (!--piter->__nents || !piter->sg)
506 return false;
507 }
508
509 return true;
510}
511EXPORT_SYMBOL(__sg_page_iter_next);
512
513
514
515
516
517
518
519
520
521
522
523
524
525void sg_miter_start(struct sg_mapping_iter *miter, struct scatterlist *sgl,
526 unsigned int nents, unsigned int flags)
527{
528 memset(miter, 0, sizeof(struct sg_mapping_iter));
529
530 __sg_page_iter_start(&miter->piter, sgl, nents, 0);
531 WARN_ON(!(flags & (SG_MITER_TO_SG | SG_MITER_FROM_SG)));
532 miter->__flags = flags;
533}
534EXPORT_SYMBOL(sg_miter_start);
535
536static bool sg_miter_get_next_page(struct sg_mapping_iter *miter)
537{
538 if (!miter->__remaining) {
539 struct scatterlist *sg;
540 unsigned long pgoffset;
541
542 if (!__sg_page_iter_next(&miter->piter))
543 return false;
544
545 sg = miter->piter.sg;
546 pgoffset = miter->piter.sg_pgoffset;
547
548 miter->__offset = pgoffset ? 0 : sg->offset;
549 miter->__remaining = sg->offset + sg->length -
550 (pgoffset << PAGE_SHIFT) - miter->__offset;
551 miter->__remaining = min_t(unsigned long, miter->__remaining,
552 PAGE_SIZE - miter->__offset);
553 }
554
555 return true;
556}
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576bool sg_miter_skip(struct sg_mapping_iter *miter, off_t offset)
577{
578 sg_miter_stop(miter);
579
580 while (offset) {
581 off_t consumed;
582
583 if (!sg_miter_get_next_page(miter))
584 return false;
585
586 consumed = min_t(off_t, offset, miter->__remaining);
587 miter->__offset += consumed;
588 miter->__remaining -= consumed;
589 offset -= consumed;
590 }
591
592 return true;
593}
594EXPORT_SYMBOL(sg_miter_skip);
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613bool sg_miter_next(struct sg_mapping_iter *miter)
614{
615 sg_miter_stop(miter);
616
617
618
619
620
621 if (!sg_miter_get_next_page(miter))
622 return false;
623
624 miter->page = sg_page_iter_page(&miter->piter);
625 miter->consumed = miter->length = miter->__remaining;
626
627 if (miter->__flags & SG_MITER_ATOMIC)
628 miter->addr = kmap_atomic(miter->page) + miter->__offset;
629 else
630 miter->addr = kmap(miter->page) + miter->__offset;
631
632 return true;
633}
634EXPORT_SYMBOL(sg_miter_next);
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650void sg_miter_stop(struct sg_mapping_iter *miter)
651{
652 WARN_ON(miter->consumed > miter->length);
653
654
655 if (miter->addr) {
656 miter->__offset += miter->consumed;
657 miter->__remaining -= miter->consumed;
658
659 if ((miter->__flags & SG_MITER_TO_SG) &&
660 !PageSlab(miter->page))
661 flush_kernel_dcache_page(miter->page);
662
663 if (miter->__flags & SG_MITER_ATOMIC) {
664 WARN_ON_ONCE(preemptible());
665 kunmap_atomic(miter->addr);
666 } else
667 kunmap(miter->page);
668
669 miter->page = NULL;
670 miter->addr = NULL;
671 miter->length = 0;
672 miter->consumed = 0;
673 }
674}
675EXPORT_SYMBOL(sg_miter_stop);
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690size_t sg_copy_buffer(struct scatterlist *sgl, unsigned int nents, void *buf,
691 size_t buflen, off_t skip, bool to_buffer)
692{
693 unsigned int offset = 0;
694 struct sg_mapping_iter miter;
695 unsigned int sg_flags = SG_MITER_ATOMIC;
696
697 if (to_buffer)
698 sg_flags |= SG_MITER_FROM_SG;
699 else
700 sg_flags |= SG_MITER_TO_SG;
701
702 sg_miter_start(&miter, sgl, nents, sg_flags);
703
704 if (!sg_miter_skip(&miter, skip))
705 return false;
706
707 while ((offset < buflen) && sg_miter_next(&miter)) {
708 unsigned int len;
709
710 len = min(miter.length, buflen - offset);
711
712 if (to_buffer)
713 memcpy(buf + offset, miter.addr, len);
714 else
715 memcpy(miter.addr, buf + offset, len);
716
717 offset += len;
718 }
719
720 sg_miter_stop(&miter);
721
722 return offset;
723}
724EXPORT_SYMBOL(sg_copy_buffer);
725
726
727
728
729
730
731
732
733
734
735
736size_t sg_copy_from_buffer(struct scatterlist *sgl, unsigned int nents,
737 const void *buf, size_t buflen)
738{
739 return sg_copy_buffer(sgl, nents, (void *)buf, buflen, 0, false);
740}
741EXPORT_SYMBOL(sg_copy_from_buffer);
742
743
744
745
746
747
748
749
750
751
752
753size_t sg_copy_to_buffer(struct scatterlist *sgl, unsigned int nents,
754 void *buf, size_t buflen)
755{
756 return sg_copy_buffer(sgl, nents, buf, buflen, 0, true);
757}
758EXPORT_SYMBOL(sg_copy_to_buffer);
759
760
761
762
763
764
765
766
767
768
769
770
771size_t sg_pcopy_from_buffer(struct scatterlist *sgl, unsigned int nents,
772 const void *buf, size_t buflen, off_t skip)
773{
774 return sg_copy_buffer(sgl, nents, (void *)buf, buflen, skip, false);
775}
776EXPORT_SYMBOL(sg_pcopy_from_buffer);
777
778
779
780
781
782
783
784
785
786
787
788
789size_t sg_pcopy_to_buffer(struct scatterlist *sgl, unsigned int nents,
790 void *buf, size_t buflen, off_t skip)
791{
792 return sg_copy_buffer(sgl, nents, buf, buflen, skip, true);
793}
794EXPORT_SYMBOL(sg_pcopy_to_buffer);
795
796
797
798
799
800
801
802
803
804
805size_t sg_zero_buffer(struct scatterlist *sgl, unsigned int nents,
806 size_t buflen, off_t skip)
807{
808 unsigned int offset = 0;
809 struct sg_mapping_iter miter;
810 unsigned int sg_flags = SG_MITER_ATOMIC | SG_MITER_TO_SG;
811
812 sg_miter_start(&miter, sgl, nents, sg_flags);
813
814 if (!sg_miter_skip(&miter, skip))
815 return false;
816
817 while (offset < buflen && sg_miter_next(&miter)) {
818 unsigned int len;
819
820 len = min(miter.length, buflen - offset);
821 memset(miter.addr, 0, len);
822
823 offset += len;
824 }
825
826 sg_miter_stop(&miter);
827 return offset;
828}
829EXPORT_SYMBOL(sg_zero_buffer);
830