1 // SPDX-License-Identifier: GPL-2.0-only
2 #include <crypto/hash.h>
3 #include <linux/export.h>
4 #include <linux/bvec.h>
5 #include <linux/fault-inject-usercopy.h>
7 #include <linux/pagemap.h>
8 #include <linux/highmem.h>
9 #include <linux/slab.h>
10 #include <linux/vmalloc.h>
11 #include <linux/splice.h>
12 #include <linux/compat.h>
13 #include <net/checksum.h>
14 #include <linux/scatterlist.h>
15 #include <linux/instrumented.h>
17 #define PIPE_PARANOIA /* for now */
19 /* covers iovec and kvec alike */
20 #define iterate_iovec(i, n, base, len, off, __p, STEP) { \
22 size_t skip = i->iov_offset; \
24 len = min(n, __p->iov_len - skip); \
26 base = __p->iov_base + skip; \
31 if (skip < __p->iov_len) \
37 i->iov_offset = skip; \
41 #define iterate_bvec(i, n, base, len, off, p, STEP) { \
43 unsigned skip = i->iov_offset; \
45 unsigned offset = p->bv_offset + skip; \
47 void *kaddr = kmap_local_page(p->bv_page + \
48 offset / PAGE_SIZE); \
49 base = kaddr + offset % PAGE_SIZE; \
50 len = min(min(n, (size_t)(p->bv_len - skip)), \
51 (size_t)(PAGE_SIZE - offset % PAGE_SIZE)); \
53 kunmap_local(kaddr); \
57 if (skip == p->bv_len) { \
65 i->iov_offset = skip; \
69 #define iterate_xarray(i, n, base, len, __off, STEP) { \
72 struct folio *folio; \
73 loff_t start = i->xarray_start + i->iov_offset; \
74 pgoff_t index = start / PAGE_SIZE; \
75 XA_STATE(xas, i->xarray, index); \
77 len = PAGE_SIZE - offset_in_page(start); \
79 xas_for_each(&xas, folio, ULONG_MAX) { \
82 if (xas_retry(&xas, folio)) \
84 if (WARN_ON(xa_is_value(folio))) \
86 if (WARN_ON(folio_test_hugetlb(folio))) \
88 offset = offset_in_folio(folio, start + __off); \
89 while (offset < folio_size(folio)) { \
90 base = kmap_local_folio(folio, offset); \
105 i->iov_offset += __off; \
109 #define __iterate_and_advance(i, n, base, len, off, I, K) { \
110 if (unlikely(i->count < n)) \
113 if (likely(iter_is_iovec(i))) { \
114 const struct iovec *iov = i->iov; \
117 iterate_iovec(i, n, base, len, off, \
119 i->nr_segs -= iov - i->iov; \
121 } else if (iov_iter_is_bvec(i)) { \
122 const struct bio_vec *bvec = i->bvec; \
125 iterate_bvec(i, n, base, len, off, \
127 i->nr_segs -= bvec - i->bvec; \
129 } else if (iov_iter_is_kvec(i)) { \
130 const struct kvec *kvec = i->kvec; \
133 iterate_iovec(i, n, base, len, off, \
135 i->nr_segs -= kvec - i->kvec; \
137 } else if (iov_iter_is_xarray(i)) { \
140 iterate_xarray(i, n, base, len, off, \
146 #define iterate_and_advance(i, n, base, len, off, I, K) \
147 __iterate_and_advance(i, n, base, len, off, I, ((void)(K),0))
149 static int copyout(void __user *to, const void *from, size_t n)
151 if (should_fail_usercopy())
153 if (access_ok(to, n)) {
154 instrument_copy_to_user(to, from, n);
155 n = raw_copy_to_user(to, from, n);
160 static int copyin(void *to, const void __user *from, size_t n)
162 if (should_fail_usercopy())
164 if (access_ok(from, n)) {
165 instrument_copy_from_user(to, from, n);
166 n = raw_copy_from_user(to, from, n);
172 static bool sanity(const struct iov_iter *i)
174 struct pipe_inode_info *pipe = i->pipe;
175 unsigned int p_head = pipe->head;
176 unsigned int p_tail = pipe->tail;
177 unsigned int p_mask = pipe->ring_size - 1;
178 unsigned int p_occupancy = pipe_occupancy(p_head, p_tail);
179 unsigned int i_head = i->head;
183 struct pipe_buffer *p;
184 if (unlikely(p_occupancy == 0))
185 goto Bad; // pipe must be non-empty
186 if (unlikely(i_head != p_head - 1))
187 goto Bad; // must be at the last buffer...
189 p = &pipe->bufs[i_head & p_mask];
190 if (unlikely(p->offset + p->len != i->iov_offset))
191 goto Bad; // ... at the end of segment
193 if (i_head != p_head)
194 goto Bad; // must be right after the last buffer
198 printk(KERN_ERR "idx = %d, offset = %zd\n", i_head, i->iov_offset);
199 printk(KERN_ERR "head = %d, tail = %d, buffers = %d\n",
200 p_head, p_tail, pipe->ring_size);
201 for (idx = 0; idx < pipe->ring_size; idx++)
202 printk(KERN_ERR "[%p %p %d %d]\n",
204 pipe->bufs[idx].page,
205 pipe->bufs[idx].offset,
206 pipe->bufs[idx].len);
211 #define sanity(i) true
214 static size_t copy_page_to_iter_pipe(struct page *page, size_t offset, size_t bytes,
217 struct pipe_inode_info *pipe = i->pipe;
218 struct pipe_buffer *buf;
219 unsigned int p_tail = pipe->tail;
220 unsigned int p_mask = pipe->ring_size - 1;
221 unsigned int i_head = i->head;
224 if (unlikely(bytes > i->count))
227 if (unlikely(!bytes))
234 buf = &pipe->bufs[i_head & p_mask];
236 if (offset == off && buf->page == page) {
237 /* merge with the last one */
239 i->iov_offset += bytes;
243 buf = &pipe->bufs[i_head & p_mask];
245 if (pipe_full(i_head, p_tail, pipe->max_usage))
248 buf->ops = &page_cache_pipe_buf_ops;
252 buf->offset = offset;
255 pipe->head = i_head + 1;
256 i->iov_offset = offset + bytes;
264 * fault_in_iov_iter_readable - fault in iov iterator for reading
266 * @size: maximum length
268 * Fault in one or more iovecs of the given iov_iter, to a maximum length of
269 * @size. For each iovec, fault in each page that constitutes the iovec.
271 * Returns the number of bytes not faulted in (like copy_to_user() and
274 * Always returns 0 for non-userspace iterators.
276 size_t fault_in_iov_iter_readable(const struct iov_iter *i, size_t size)
278 if (iter_is_iovec(i)) {
279 size_t count = min(size, iov_iter_count(i));
280 const struct iovec *p;
284 for (p = i->iov, skip = i->iov_offset; count; p++, skip = 0) {
285 size_t len = min(count, p->iov_len - skip);
290 ret = fault_in_readable(p->iov_base + skip, len);
299 EXPORT_SYMBOL(fault_in_iov_iter_readable);
302 * fault_in_iov_iter_writeable - fault in iov iterator for writing
304 * @size: maximum length
306 * Faults in the iterator using get_user_pages(), i.e., without triggering
307 * hardware page faults. This is primarily useful when we already know that
308 * some or all of the pages in @i aren't in memory.
310 * Returns the number of bytes not faulted in, like copy_to_user() and
313 * Always returns 0 for non-user-space iterators.
315 size_t fault_in_iov_iter_writeable(const struct iov_iter *i, size_t size)
317 if (iter_is_iovec(i)) {
318 size_t count = min(size, iov_iter_count(i));
319 const struct iovec *p;
323 for (p = i->iov, skip = i->iov_offset; count; p++, skip = 0) {
324 size_t len = min(count, p->iov_len - skip);
329 ret = fault_in_safe_writeable(p->iov_base + skip, len);
338 EXPORT_SYMBOL(fault_in_iov_iter_writeable);
340 void iov_iter_init(struct iov_iter *i, unsigned int direction,
341 const struct iovec *iov, unsigned long nr_segs,
344 WARN_ON(direction & ~(READ | WRITE));
345 *i = (struct iov_iter) {
346 .iter_type = ITER_IOVEC,
348 .data_source = direction,
355 EXPORT_SYMBOL(iov_iter_init);
357 static inline bool allocated(struct pipe_buffer *buf)
359 return buf->ops == &default_pipe_buf_ops;
362 static inline void data_start(const struct iov_iter *i,
363 unsigned int *iter_headp, size_t *offp)
365 unsigned int p_mask = i->pipe->ring_size - 1;
366 unsigned int iter_head = i->head;
367 size_t off = i->iov_offset;
369 if (off && (!allocated(&i->pipe->bufs[iter_head & p_mask]) ||
374 *iter_headp = iter_head;
378 static size_t push_pipe(struct iov_iter *i, size_t size,
379 int *iter_headp, size_t *offp)
381 struct pipe_inode_info *pipe = i->pipe;
382 unsigned int p_tail = pipe->tail;
383 unsigned int p_mask = pipe->ring_size - 1;
384 unsigned int iter_head;
388 if (unlikely(size > i->count))
394 data_start(i, &iter_head, &off);
395 *iter_headp = iter_head;
398 left -= PAGE_SIZE - off;
400 pipe->bufs[iter_head & p_mask].len += size;
403 pipe->bufs[iter_head & p_mask].len = PAGE_SIZE;
406 while (!pipe_full(iter_head, p_tail, pipe->max_usage)) {
407 struct pipe_buffer *buf = &pipe->bufs[iter_head & p_mask];
408 struct page *page = alloc_page(GFP_USER);
412 buf->ops = &default_pipe_buf_ops;
416 buf->len = min_t(ssize_t, left, PAGE_SIZE);
419 pipe->head = iter_head;
427 static size_t copy_pipe_to_iter(const void *addr, size_t bytes,
430 struct pipe_inode_info *pipe = i->pipe;
431 unsigned int p_mask = pipe->ring_size - 1;
438 bytes = n = push_pipe(i, bytes, &i_head, &off);
442 size_t chunk = min_t(size_t, n, PAGE_SIZE - off);
443 memcpy_to_page(pipe->bufs[i_head & p_mask].page, off, addr, chunk);
445 i->iov_offset = off + chunk;
455 static __wsum csum_and_memcpy(void *to, const void *from, size_t len,
456 __wsum sum, size_t off)
458 __wsum next = csum_partial_copy_nocheck(from, to, len);
459 return csum_block_add(sum, next, off);
462 static size_t csum_and_copy_to_pipe_iter(const void *addr, size_t bytes,
463 struct iov_iter *i, __wsum *sump)
465 struct pipe_inode_info *pipe = i->pipe;
466 unsigned int p_mask = pipe->ring_size - 1;
475 bytes = push_pipe(i, bytes, &i_head, &r);
477 size_t chunk = min_t(size_t, bytes, PAGE_SIZE - r);
478 char *p = kmap_local_page(pipe->bufs[i_head & p_mask].page);
479 sum = csum_and_memcpy(p + r, addr + off, chunk, sum, off);
482 i->iov_offset = r + chunk;
493 size_t _copy_to_iter(const void *addr, size_t bytes, struct iov_iter *i)
495 if (unlikely(iov_iter_is_pipe(i)))
496 return copy_pipe_to_iter(addr, bytes, i);
497 if (iter_is_iovec(i))
499 iterate_and_advance(i, bytes, base, len, off,
500 copyout(base, addr + off, len),
501 memcpy(base, addr + off, len)
506 EXPORT_SYMBOL(_copy_to_iter);
508 #ifdef CONFIG_ARCH_HAS_COPY_MC
509 static int copyout_mc(void __user *to, const void *from, size_t n)
511 if (access_ok(to, n)) {
512 instrument_copy_to_user(to, from, n);
513 n = copy_mc_to_user((__force void *) to, from, n);
518 static size_t copy_mc_pipe_to_iter(const void *addr, size_t bytes,
521 struct pipe_inode_info *pipe = i->pipe;
522 unsigned int p_mask = pipe->ring_size - 1;
524 size_t n, off, xfer = 0;
529 n = push_pipe(i, bytes, &i_head, &off);
531 size_t chunk = min_t(size_t, n, PAGE_SIZE - off);
532 char *p = kmap_local_page(pipe->bufs[i_head & p_mask].page);
534 rem = copy_mc_to_kernel(p + off, addr + xfer, chunk);
538 i->iov_offset = off + chunk;
551 * _copy_mc_to_iter - copy to iter with source memory error exception handling
552 * @addr: source kernel address
553 * @bytes: total transfer length
554 * @i: destination iterator
556 * The pmem driver deploys this for the dax operation
557 * (dax_copy_to_iter()) for dax reads (bypass page-cache and the
558 * block-layer). Upon #MC read(2) aborts and returns EIO or the bytes
559 * successfully copied.
561 * The main differences between this and typical _copy_to_iter().
563 * * Typical tail/residue handling after a fault retries the copy
564 * byte-by-byte until the fault happens again. Re-triggering machine
565 * checks is potentially fatal so the implementation uses source
566 * alignment and poison alignment assumptions to avoid re-triggering
567 * hardware exceptions.
569 * * ITER_KVEC, ITER_PIPE, and ITER_BVEC can return short copies.
570 * Compare to copy_to_iter() where only ITER_IOVEC attempts might return
573 * Return: number of bytes copied (may be %0)
575 size_t _copy_mc_to_iter(const void *addr, size_t bytes, struct iov_iter *i)
577 if (unlikely(iov_iter_is_pipe(i)))
578 return copy_mc_pipe_to_iter(addr, bytes, i);
579 if (iter_is_iovec(i))
581 __iterate_and_advance(i, bytes, base, len, off,
582 copyout_mc(base, addr + off, len),
583 copy_mc_to_kernel(base, addr + off, len)
588 EXPORT_SYMBOL_GPL(_copy_mc_to_iter);
589 #endif /* CONFIG_ARCH_HAS_COPY_MC */
591 size_t _copy_from_iter(void *addr, size_t bytes, struct iov_iter *i)
593 if (unlikely(iov_iter_is_pipe(i))) {
597 if (iter_is_iovec(i))
599 iterate_and_advance(i, bytes, base, len, off,
600 copyin(addr + off, base, len),
601 memcpy(addr + off, base, len)
606 EXPORT_SYMBOL(_copy_from_iter);
608 size_t _copy_from_iter_nocache(void *addr, size_t bytes, struct iov_iter *i)
610 if (unlikely(iov_iter_is_pipe(i))) {
614 iterate_and_advance(i, bytes, base, len, off,
615 __copy_from_user_inatomic_nocache(addr + off, base, len),
616 memcpy(addr + off, base, len)
621 EXPORT_SYMBOL(_copy_from_iter_nocache);
623 #ifdef CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE
625 * _copy_from_iter_flushcache - write destination through cpu cache
626 * @addr: destination kernel address
627 * @bytes: total transfer length
628 * @i: source iterator
630 * The pmem driver arranges for filesystem-dax to use this facility via
631 * dax_copy_from_iter() for ensuring that writes to persistent memory
632 * are flushed through the CPU cache. It is differentiated from
633 * _copy_from_iter_nocache() in that guarantees all data is flushed for
634 * all iterator types. The _copy_from_iter_nocache() only attempts to
635 * bypass the cache for the ITER_IOVEC case, and on some archs may use
636 * instructions that strand dirty-data in the cache.
638 * Return: number of bytes copied (may be %0)
640 size_t _copy_from_iter_flushcache(void *addr, size_t bytes, struct iov_iter *i)
642 if (unlikely(iov_iter_is_pipe(i))) {
646 iterate_and_advance(i, bytes, base, len, off,
647 __copy_from_user_flushcache(addr + off, base, len),
648 memcpy_flushcache(addr + off, base, len)
653 EXPORT_SYMBOL_GPL(_copy_from_iter_flushcache);
656 static inline bool page_copy_sane(struct page *page, size_t offset, size_t n)
659 size_t v = n + offset;
662 * The general case needs to access the page order in order
663 * to compute the page size.
664 * However, we mostly deal with order-0 pages and thus can
665 * avoid a possible cache line miss for requests that fit all
668 if (n <= v && v <= PAGE_SIZE)
671 head = compound_head(page);
672 v += (page - head) << PAGE_SHIFT;
674 if (likely(n <= v && v <= (page_size(head))))
680 static size_t __copy_page_to_iter(struct page *page, size_t offset, size_t bytes,
683 if (unlikely(iov_iter_is_pipe(i))) {
684 return copy_page_to_iter_pipe(page, offset, bytes, i);
686 void *kaddr = kmap_local_page(page);
687 size_t wanted = _copy_to_iter(kaddr + offset, bytes, i);
693 size_t copy_page_to_iter(struct page *page, size_t offset, size_t bytes,
697 if (unlikely(!page_copy_sane(page, offset, bytes)))
699 page += offset / PAGE_SIZE; // first subpage
702 size_t n = __copy_page_to_iter(page, offset,
703 min(bytes, (size_t)PAGE_SIZE - offset), i);
709 if (offset == PAGE_SIZE) {
716 EXPORT_SYMBOL(copy_page_to_iter);
718 size_t copy_page_from_iter(struct page *page, size_t offset, size_t bytes,
721 if (page_copy_sane(page, offset, bytes)) {
722 void *kaddr = kmap_local_page(page);
723 size_t wanted = _copy_from_iter(kaddr + offset, bytes, i);
729 EXPORT_SYMBOL(copy_page_from_iter);
731 static size_t pipe_zero(size_t bytes, struct iov_iter *i)
733 struct pipe_inode_info *pipe = i->pipe;
734 unsigned int p_mask = pipe->ring_size - 1;
741 bytes = n = push_pipe(i, bytes, &i_head, &off);
746 size_t chunk = min_t(size_t, n, PAGE_SIZE - off);
747 char *p = kmap_local_page(pipe->bufs[i_head & p_mask].page);
748 memset(p + off, 0, chunk);
751 i->iov_offset = off + chunk;
760 size_t iov_iter_zero(size_t bytes, struct iov_iter *i)
762 if (unlikely(iov_iter_is_pipe(i)))
763 return pipe_zero(bytes, i);
764 iterate_and_advance(i, bytes, base, len, count,
765 clear_user(base, len),
771 EXPORT_SYMBOL(iov_iter_zero);
773 size_t copy_page_from_iter_atomic(struct page *page, unsigned offset, size_t bytes,
776 char *kaddr = kmap_atomic(page), *p = kaddr + offset;
777 if (unlikely(!page_copy_sane(page, offset, bytes))) {
778 kunmap_atomic(kaddr);
781 if (unlikely(iov_iter_is_pipe(i) || iov_iter_is_discard(i))) {
782 kunmap_atomic(kaddr);
786 iterate_and_advance(i, bytes, base, len, off,
787 copyin(p + off, base, len),
788 memcpy(p + off, base, len)
790 kunmap_atomic(kaddr);
793 EXPORT_SYMBOL(copy_page_from_iter_atomic);
795 static inline void pipe_truncate(struct iov_iter *i)
797 struct pipe_inode_info *pipe = i->pipe;
798 unsigned int p_tail = pipe->tail;
799 unsigned int p_head = pipe->head;
800 unsigned int p_mask = pipe->ring_size - 1;
802 if (!pipe_empty(p_head, p_tail)) {
803 struct pipe_buffer *buf;
804 unsigned int i_head = i->head;
805 size_t off = i->iov_offset;
808 buf = &pipe->bufs[i_head & p_mask];
809 buf->len = off - buf->offset;
812 while (p_head != i_head) {
814 pipe_buf_release(pipe, &pipe->bufs[p_head & p_mask]);
821 static void pipe_advance(struct iov_iter *i, size_t size)
823 struct pipe_inode_info *pipe = i->pipe;
825 struct pipe_buffer *buf;
826 unsigned int p_mask = pipe->ring_size - 1;
827 unsigned int i_head = i->head;
828 size_t off = i->iov_offset, left = size;
830 if (off) /* make it relative to the beginning of buffer */
831 left += off - pipe->bufs[i_head & p_mask].offset;
833 buf = &pipe->bufs[i_head & p_mask];
834 if (left <= buf->len)
840 i->iov_offset = buf->offset + left;
843 /* ... and discard everything past that point */
847 static void iov_iter_bvec_advance(struct iov_iter *i, size_t size)
851 bi.bi_size = i->count;
852 bi.bi_bvec_done = i->iov_offset;
854 bvec_iter_advance(i->bvec, &bi, size);
856 i->bvec += bi.bi_idx;
857 i->nr_segs -= bi.bi_idx;
858 i->count = bi.bi_size;
859 i->iov_offset = bi.bi_bvec_done;
862 static void iov_iter_iovec_advance(struct iov_iter *i, size_t size)
864 const struct iovec *iov, *end;
870 size += i->iov_offset; // from beginning of current segment
871 for (iov = i->iov, end = iov + i->nr_segs; iov < end; iov++) {
872 if (likely(size < iov->iov_len))
874 size -= iov->iov_len;
876 i->iov_offset = size;
877 i->nr_segs -= iov - i->iov;
881 void iov_iter_advance(struct iov_iter *i, size_t size)
883 if (unlikely(i->count < size))
885 if (likely(iter_is_iovec(i) || iov_iter_is_kvec(i))) {
886 /* iovec and kvec have identical layouts */
887 iov_iter_iovec_advance(i, size);
888 } else if (iov_iter_is_bvec(i)) {
889 iov_iter_bvec_advance(i, size);
890 } else if (iov_iter_is_pipe(i)) {
891 pipe_advance(i, size);
892 } else if (unlikely(iov_iter_is_xarray(i))) {
893 i->iov_offset += size;
895 } else if (iov_iter_is_discard(i)) {
899 EXPORT_SYMBOL(iov_iter_advance);
901 void iov_iter_revert(struct iov_iter *i, size_t unroll)
905 if (WARN_ON(unroll > MAX_RW_COUNT))
908 if (unlikely(iov_iter_is_pipe(i))) {
909 struct pipe_inode_info *pipe = i->pipe;
910 unsigned int p_mask = pipe->ring_size - 1;
911 unsigned int i_head = i->head;
912 size_t off = i->iov_offset;
914 struct pipe_buffer *b = &pipe->bufs[i_head & p_mask];
915 size_t n = off - b->offset;
921 if (!unroll && i_head == i->start_head) {
926 b = &pipe->bufs[i_head & p_mask];
927 off = b->offset + b->len;
934 if (unlikely(iov_iter_is_discard(i)))
936 if (unroll <= i->iov_offset) {
937 i->iov_offset -= unroll;
940 unroll -= i->iov_offset;
941 if (iov_iter_is_xarray(i)) {
942 BUG(); /* We should never go beyond the start of the specified
943 * range since we might then be straying into pages that
946 } else if (iov_iter_is_bvec(i)) {
947 const struct bio_vec *bvec = i->bvec;
949 size_t n = (--bvec)->bv_len;
953 i->iov_offset = n - unroll;
958 } else { /* same logics for iovec and kvec */
959 const struct iovec *iov = i->iov;
961 size_t n = (--iov)->iov_len;
965 i->iov_offset = n - unroll;
972 EXPORT_SYMBOL(iov_iter_revert);
975 * Return the count of just the current iov_iter segment.
977 size_t iov_iter_single_seg_count(const struct iov_iter *i)
979 if (i->nr_segs > 1) {
980 if (likely(iter_is_iovec(i) || iov_iter_is_kvec(i)))
981 return min(i->count, i->iov->iov_len - i->iov_offset);
982 if (iov_iter_is_bvec(i))
983 return min(i->count, i->bvec->bv_len - i->iov_offset);
987 EXPORT_SYMBOL(iov_iter_single_seg_count);
989 void iov_iter_kvec(struct iov_iter *i, unsigned int direction,
990 const struct kvec *kvec, unsigned long nr_segs,
993 WARN_ON(direction & ~(READ | WRITE));
994 *i = (struct iov_iter){
995 .iter_type = ITER_KVEC,
996 .data_source = direction,
1003 EXPORT_SYMBOL(iov_iter_kvec);
1005 void iov_iter_bvec(struct iov_iter *i, unsigned int direction,
1006 const struct bio_vec *bvec, unsigned long nr_segs,
1009 WARN_ON(direction & ~(READ | WRITE));
1010 *i = (struct iov_iter){
1011 .iter_type = ITER_BVEC,
1012 .data_source = direction,
1019 EXPORT_SYMBOL(iov_iter_bvec);
1021 void iov_iter_pipe(struct iov_iter *i, unsigned int direction,
1022 struct pipe_inode_info *pipe,
1025 BUG_ON(direction != READ);
1026 WARN_ON(pipe_full(pipe->head, pipe->tail, pipe->ring_size));
1027 *i = (struct iov_iter){
1028 .iter_type = ITER_PIPE,
1029 .data_source = false,
1032 .start_head = pipe->head,
1037 EXPORT_SYMBOL(iov_iter_pipe);
1040 * iov_iter_xarray - Initialise an I/O iterator to use the pages in an xarray
1041 * @i: The iterator to initialise.
1042 * @direction: The direction of the transfer.
1043 * @xarray: The xarray to access.
1044 * @start: The start file position.
1045 * @count: The size of the I/O buffer in bytes.
1047 * Set up an I/O iterator to either draw data out of the pages attached to an
1048 * inode or to inject data into those pages. The pages *must* be prevented
1049 * from evaporation, either by taking a ref on them or locking them by the
1052 void iov_iter_xarray(struct iov_iter *i, unsigned int direction,
1053 struct xarray *xarray, loff_t start, size_t count)
1055 BUG_ON(direction & ~1);
1056 *i = (struct iov_iter) {
1057 .iter_type = ITER_XARRAY,
1058 .data_source = direction,
1060 .xarray_start = start,
1065 EXPORT_SYMBOL(iov_iter_xarray);
1068 * iov_iter_discard - Initialise an I/O iterator that discards data
1069 * @i: The iterator to initialise.
1070 * @direction: The direction of the transfer.
1071 * @count: The size of the I/O buffer in bytes.
1073 * Set up an I/O iterator that just discards everything that's written to it.
1074 * It's only available as a READ iterator.
1076 void iov_iter_discard(struct iov_iter *i, unsigned int direction, size_t count)
1078 BUG_ON(direction != READ);
1079 *i = (struct iov_iter){
1080 .iter_type = ITER_DISCARD,
1081 .data_source = false,
1086 EXPORT_SYMBOL(iov_iter_discard);
1088 static unsigned long iov_iter_alignment_iovec(const struct iov_iter *i)
1090 unsigned long res = 0;
1091 size_t size = i->count;
1092 size_t skip = i->iov_offset;
1095 for (k = 0; k < i->nr_segs; k++, skip = 0) {
1096 size_t len = i->iov[k].iov_len - skip;
1098 res |= (unsigned long)i->iov[k].iov_base + skip;
1110 static unsigned long iov_iter_alignment_bvec(const struct iov_iter *i)
1113 size_t size = i->count;
1114 unsigned skip = i->iov_offset;
1117 for (k = 0; k < i->nr_segs; k++, skip = 0) {
1118 size_t len = i->bvec[k].bv_len - skip;
1119 res |= (unsigned long)i->bvec[k].bv_offset + skip;
1130 unsigned long iov_iter_alignment(const struct iov_iter *i)
1132 /* iovec and kvec have identical layouts */
1133 if (likely(iter_is_iovec(i) || iov_iter_is_kvec(i)))
1134 return iov_iter_alignment_iovec(i);
1136 if (iov_iter_is_bvec(i))
1137 return iov_iter_alignment_bvec(i);
1139 if (iov_iter_is_pipe(i)) {
1140 unsigned int p_mask = i->pipe->ring_size - 1;
1141 size_t size = i->count;
1143 if (size && i->iov_offset && allocated(&i->pipe->bufs[i->head & p_mask]))
1144 return size | i->iov_offset;
1148 if (iov_iter_is_xarray(i))
1149 return (i->xarray_start + i->iov_offset) | i->count;
1153 EXPORT_SYMBOL(iov_iter_alignment);
1155 unsigned long iov_iter_gap_alignment(const struct iov_iter *i)
1157 unsigned long res = 0;
1158 unsigned long v = 0;
1159 size_t size = i->count;
1162 if (WARN_ON(!iter_is_iovec(i)))
1165 for (k = 0; k < i->nr_segs; k++) {
1166 if (i->iov[k].iov_len) {
1167 unsigned long base = (unsigned long)i->iov[k].iov_base;
1168 if (v) // if not the first one
1169 res |= base | v; // this start | previous end
1170 v = base + i->iov[k].iov_len;
1171 if (size <= i->iov[k].iov_len)
1173 size -= i->iov[k].iov_len;
1178 EXPORT_SYMBOL(iov_iter_gap_alignment);
1180 static inline ssize_t __pipe_get_pages(struct iov_iter *i,
1182 struct page **pages,
1186 struct pipe_inode_info *pipe = i->pipe;
1187 unsigned int p_mask = pipe->ring_size - 1;
1188 ssize_t n = push_pipe(i, maxsize, &iter_head, start);
1195 get_page(*pages++ = pipe->bufs[iter_head & p_mask].page);
1203 static ssize_t pipe_get_pages(struct iov_iter *i,
1204 struct page **pages, size_t maxsize, unsigned maxpages,
1207 unsigned int iter_head, npages;
1213 data_start(i, &iter_head, start);
1214 /* Amount of free space: some of this one + all after this one */
1215 npages = pipe_space_for_user(iter_head, i->pipe->tail, i->pipe);
1216 capacity = min(npages, maxpages) * PAGE_SIZE - *start;
1218 return __pipe_get_pages(i, min(maxsize, capacity), pages, iter_head, start);
1221 static ssize_t iter_xarray_populate_pages(struct page **pages, struct xarray *xa,
1222 pgoff_t index, unsigned int nr_pages)
1224 XA_STATE(xas, xa, index);
1226 unsigned int ret = 0;
1229 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
1230 if (xas_retry(&xas, page))
1233 /* Has the page moved or been split? */
1234 if (unlikely(page != xas_reload(&xas))) {
1239 pages[ret] = find_subpage(page, xas.xa_index);
1240 get_page(pages[ret]);
1241 if (++ret == nr_pages)
1248 static ssize_t iter_xarray_get_pages(struct iov_iter *i,
1249 struct page **pages, size_t maxsize,
1250 unsigned maxpages, size_t *_start_offset)
1252 unsigned nr, offset;
1253 pgoff_t index, count;
1254 size_t size = maxsize, actual;
1257 if (!size || !maxpages)
1260 pos = i->xarray_start + i->iov_offset;
1261 index = pos >> PAGE_SHIFT;
1262 offset = pos & ~PAGE_MASK;
1263 *_start_offset = offset;
1266 if (size > PAGE_SIZE - offset) {
1267 size -= PAGE_SIZE - offset;
1268 count += size >> PAGE_SHIFT;
1274 if (count > maxpages)
1277 nr = iter_xarray_populate_pages(pages, i->xarray, index, count);
1281 actual = PAGE_SIZE * nr;
1283 if (nr == count && size > 0) {
1284 unsigned last_offset = (nr > 1) ? 0 : offset;
1285 actual -= PAGE_SIZE - (last_offset + size);
1290 /* must be done on non-empty ITER_IOVEC one */
1291 static unsigned long first_iovec_segment(const struct iov_iter *i,
1292 size_t *size, size_t *start,
1293 size_t maxsize, unsigned maxpages)
1298 for (k = 0, skip = i->iov_offset; k < i->nr_segs; k++, skip = 0) {
1299 unsigned long addr = (unsigned long)i->iov[k].iov_base + skip;
1300 size_t len = i->iov[k].iov_len - skip;
1306 len += (*start = addr % PAGE_SIZE);
1307 if (len > maxpages * PAGE_SIZE)
1308 len = maxpages * PAGE_SIZE;
1310 return addr & PAGE_MASK;
1312 BUG(); // if it had been empty, we wouldn't get called
1315 /* must be done on non-empty ITER_BVEC one */
1316 static struct page *first_bvec_segment(const struct iov_iter *i,
1317 size_t *size, size_t *start,
1318 size_t maxsize, unsigned maxpages)
1321 size_t skip = i->iov_offset, len;
1323 len = i->bvec->bv_len - skip;
1326 skip += i->bvec->bv_offset;
1327 page = i->bvec->bv_page + skip / PAGE_SIZE;
1328 len += (*start = skip % PAGE_SIZE);
1329 if (len > maxpages * PAGE_SIZE)
1330 len = maxpages * PAGE_SIZE;
1335 ssize_t iov_iter_get_pages(struct iov_iter *i,
1336 struct page **pages, size_t maxsize, unsigned maxpages,
1342 if (maxsize > i->count)
1347 if (likely(iter_is_iovec(i))) {
1348 unsigned int gup_flags = 0;
1351 if (iov_iter_rw(i) != WRITE)
1352 gup_flags |= FOLL_WRITE;
1354 gup_flags |= FOLL_NOFAULT;
1356 addr = first_iovec_segment(i, &len, start, maxsize, maxpages);
1357 n = DIV_ROUND_UP(len, PAGE_SIZE);
1358 res = get_user_pages_fast(addr, n, gup_flags, pages);
1359 if (unlikely(res <= 0))
1361 return (res == n ? len : res * PAGE_SIZE) - *start;
1363 if (iov_iter_is_bvec(i)) {
1366 page = first_bvec_segment(i, &len, start, maxsize, maxpages);
1367 n = DIV_ROUND_UP(len, PAGE_SIZE);
1369 get_page(*pages++ = page++);
1370 return len - *start;
1372 if (iov_iter_is_pipe(i))
1373 return pipe_get_pages(i, pages, maxsize, maxpages, start);
1374 if (iov_iter_is_xarray(i))
1375 return iter_xarray_get_pages(i, pages, maxsize, maxpages, start);
1378 EXPORT_SYMBOL(iov_iter_get_pages);
1380 static struct page **get_pages_array(size_t n)
1382 return kvmalloc_array(n, sizeof(struct page *), GFP_KERNEL);
1385 static ssize_t pipe_get_pages_alloc(struct iov_iter *i,
1386 struct page ***pages, size_t maxsize,
1390 unsigned int iter_head, npages;
1396 data_start(i, &iter_head, start);
1397 /* Amount of free space: some of this one + all after this one */
1398 npages = pipe_space_for_user(iter_head, i->pipe->tail, i->pipe);
1399 n = npages * PAGE_SIZE - *start;
1403 npages = DIV_ROUND_UP(maxsize + *start, PAGE_SIZE);
1404 p = get_pages_array(npages);
1407 n = __pipe_get_pages(i, maxsize, p, iter_head, start);
1415 static ssize_t iter_xarray_get_pages_alloc(struct iov_iter *i,
1416 struct page ***pages, size_t maxsize,
1417 size_t *_start_offset)
1420 unsigned nr, offset;
1421 pgoff_t index, count;
1422 size_t size = maxsize, actual;
1428 pos = i->xarray_start + i->iov_offset;
1429 index = pos >> PAGE_SHIFT;
1430 offset = pos & ~PAGE_MASK;
1431 *_start_offset = offset;
1434 if (size > PAGE_SIZE - offset) {
1435 size -= PAGE_SIZE - offset;
1436 count += size >> PAGE_SHIFT;
1442 p = get_pages_array(count);
1447 nr = iter_xarray_populate_pages(p, i->xarray, index, count);
1451 actual = PAGE_SIZE * nr;
1453 if (nr == count && size > 0) {
1454 unsigned last_offset = (nr > 1) ? 0 : offset;
1455 actual -= PAGE_SIZE - (last_offset + size);
1460 ssize_t iov_iter_get_pages_alloc(struct iov_iter *i,
1461 struct page ***pages, size_t maxsize,
1468 if (maxsize > i->count)
1473 if (likely(iter_is_iovec(i))) {
1474 unsigned int gup_flags = 0;
1477 if (iov_iter_rw(i) != WRITE)
1478 gup_flags |= FOLL_WRITE;
1480 gup_flags |= FOLL_NOFAULT;
1482 addr = first_iovec_segment(i, &len, start, maxsize, ~0U);
1483 n = DIV_ROUND_UP(len, PAGE_SIZE);
1484 p = get_pages_array(n);
1487 res = get_user_pages_fast(addr, n, gup_flags, p);
1488 if (unlikely(res <= 0)) {
1494 return (res == n ? len : res * PAGE_SIZE) - *start;
1496 if (iov_iter_is_bvec(i)) {
1499 page = first_bvec_segment(i, &len, start, maxsize, ~0U);
1500 n = DIV_ROUND_UP(len, PAGE_SIZE);
1501 *pages = p = get_pages_array(n);
1505 get_page(*p++ = page++);
1506 return len - *start;
1508 if (iov_iter_is_pipe(i))
1509 return pipe_get_pages_alloc(i, pages, maxsize, start);
1510 if (iov_iter_is_xarray(i))
1511 return iter_xarray_get_pages_alloc(i, pages, maxsize, start);
1514 EXPORT_SYMBOL(iov_iter_get_pages_alloc);
1516 size_t csum_and_copy_from_iter(void *addr, size_t bytes, __wsum *csum,
1521 if (unlikely(iov_iter_is_pipe(i) || iov_iter_is_discard(i))) {
1525 iterate_and_advance(i, bytes, base, len, off, ({
1526 next = csum_and_copy_from_user(base, addr + off, len);
1527 sum = csum_block_add(sum, next, off);
1530 sum = csum_and_memcpy(addr + off, base, len, sum, off);
1536 EXPORT_SYMBOL(csum_and_copy_from_iter);
1538 size_t csum_and_copy_to_iter(const void *addr, size_t bytes, void *_csstate,
1541 struct csum_state *csstate = _csstate;
1544 if (unlikely(iov_iter_is_discard(i))) {
1545 WARN_ON(1); /* for now */
1549 sum = csum_shift(csstate->csum, csstate->off);
1550 if (unlikely(iov_iter_is_pipe(i)))
1551 bytes = csum_and_copy_to_pipe_iter(addr, bytes, i, &sum);
1552 else iterate_and_advance(i, bytes, base, len, off, ({
1553 next = csum_and_copy_to_user(addr + off, base, len);
1554 sum = csum_block_add(sum, next, off);
1557 sum = csum_and_memcpy(base, addr + off, len, sum, off);
1560 csstate->csum = csum_shift(sum, csstate->off);
1561 csstate->off += bytes;
1564 EXPORT_SYMBOL(csum_and_copy_to_iter);
1566 size_t hash_and_copy_to_iter(const void *addr, size_t bytes, void *hashp,
1569 #ifdef CONFIG_CRYPTO_HASH
1570 struct ahash_request *hash = hashp;
1571 struct scatterlist sg;
1574 copied = copy_to_iter(addr, bytes, i);
1575 sg_init_one(&sg, addr, copied);
1576 ahash_request_set_crypt(hash, &sg, NULL, copied);
1577 crypto_ahash_update(hash);
1583 EXPORT_SYMBOL(hash_and_copy_to_iter);
1585 static int iov_npages(const struct iov_iter *i, int maxpages)
1587 size_t skip = i->iov_offset, size = i->count;
1588 const struct iovec *p;
1591 for (p = i->iov; size; skip = 0, p++) {
1592 unsigned offs = offset_in_page(p->iov_base + skip);
1593 size_t len = min(p->iov_len - skip, size);
1597 npages += DIV_ROUND_UP(offs + len, PAGE_SIZE);
1598 if (unlikely(npages > maxpages))
1605 static int bvec_npages(const struct iov_iter *i, int maxpages)
1607 size_t skip = i->iov_offset, size = i->count;
1608 const struct bio_vec *p;
1611 for (p = i->bvec; size; skip = 0, p++) {
1612 unsigned offs = (p->bv_offset + skip) % PAGE_SIZE;
1613 size_t len = min(p->bv_len - skip, size);
1616 npages += DIV_ROUND_UP(offs + len, PAGE_SIZE);
1617 if (unlikely(npages > maxpages))
1623 int iov_iter_npages(const struct iov_iter *i, int maxpages)
1625 if (unlikely(!i->count))
1627 /* iovec and kvec have identical layouts */
1628 if (likely(iter_is_iovec(i) || iov_iter_is_kvec(i)))
1629 return iov_npages(i, maxpages);
1630 if (iov_iter_is_bvec(i))
1631 return bvec_npages(i, maxpages);
1632 if (iov_iter_is_pipe(i)) {
1633 unsigned int iter_head;
1640 data_start(i, &iter_head, &off);
1641 /* some of this one + all after this one */
1642 npages = pipe_space_for_user(iter_head, i->pipe->tail, i->pipe);
1643 return min(npages, maxpages);
1645 if (iov_iter_is_xarray(i)) {
1646 unsigned offset = (i->xarray_start + i->iov_offset) % PAGE_SIZE;
1647 int npages = DIV_ROUND_UP(offset + i->count, PAGE_SIZE);
1648 return min(npages, maxpages);
1652 EXPORT_SYMBOL(iov_iter_npages);
1654 const void *dup_iter(struct iov_iter *new, struct iov_iter *old, gfp_t flags)
1657 if (unlikely(iov_iter_is_pipe(new))) {
1661 if (unlikely(iov_iter_is_discard(new) || iov_iter_is_xarray(new)))
1663 if (iov_iter_is_bvec(new))
1664 return new->bvec = kmemdup(new->bvec,
1665 new->nr_segs * sizeof(struct bio_vec),
1668 /* iovec and kvec have identical layout */
1669 return new->iov = kmemdup(new->iov,
1670 new->nr_segs * sizeof(struct iovec),
1673 EXPORT_SYMBOL(dup_iter);
1675 static int copy_compat_iovec_from_user(struct iovec *iov,
1676 const struct iovec __user *uvec, unsigned long nr_segs)
1678 const struct compat_iovec __user *uiov =
1679 (const struct compat_iovec __user *)uvec;
1680 int ret = -EFAULT, i;
1682 if (!user_access_begin(uiov, nr_segs * sizeof(*uiov)))
1685 for (i = 0; i < nr_segs; i++) {
1689 unsafe_get_user(len, &uiov[i].iov_len, uaccess_end);
1690 unsafe_get_user(buf, &uiov[i].iov_base, uaccess_end);
1692 /* check for compat_size_t not fitting in compat_ssize_t .. */
1697 iov[i].iov_base = compat_ptr(buf);
1698 iov[i].iov_len = len;
1707 static int copy_iovec_from_user(struct iovec *iov,
1708 const struct iovec __user *uvec, unsigned long nr_segs)
1712 if (copy_from_user(iov, uvec, nr_segs * sizeof(*uvec)))
1714 for (seg = 0; seg < nr_segs; seg++) {
1715 if ((ssize_t)iov[seg].iov_len < 0)
1722 struct iovec *iovec_from_user(const struct iovec __user *uvec,
1723 unsigned long nr_segs, unsigned long fast_segs,
1724 struct iovec *fast_iov, bool compat)
1726 struct iovec *iov = fast_iov;
1730 * SuS says "The readv() function *may* fail if the iovcnt argument was
1731 * less than or equal to 0, or greater than {IOV_MAX}. Linux has
1732 * traditionally returned zero for zero segments, so...
1736 if (nr_segs > UIO_MAXIOV)
1737 return ERR_PTR(-EINVAL);
1738 if (nr_segs > fast_segs) {
1739 iov = kmalloc_array(nr_segs, sizeof(struct iovec), GFP_KERNEL);
1741 return ERR_PTR(-ENOMEM);
1745 ret = copy_compat_iovec_from_user(iov, uvec, nr_segs);
1747 ret = copy_iovec_from_user(iov, uvec, nr_segs);
1749 if (iov != fast_iov)
1751 return ERR_PTR(ret);
1757 ssize_t __import_iovec(int type, const struct iovec __user *uvec,
1758 unsigned nr_segs, unsigned fast_segs, struct iovec **iovp,
1759 struct iov_iter *i, bool compat)
1761 ssize_t total_len = 0;
1765 iov = iovec_from_user(uvec, nr_segs, fast_segs, *iovp, compat);
1768 return PTR_ERR(iov);
1772 * According to the Single Unix Specification we should return EINVAL if
1773 * an element length is < 0 when cast to ssize_t or if the total length
1774 * would overflow the ssize_t return value of the system call.
1776 * Linux caps all read/write calls to MAX_RW_COUNT, and avoids the
1779 for (seg = 0; seg < nr_segs; seg++) {
1780 ssize_t len = (ssize_t)iov[seg].iov_len;
1782 if (!access_ok(iov[seg].iov_base, len)) {
1789 if (len > MAX_RW_COUNT - total_len) {
1790 len = MAX_RW_COUNT - total_len;
1791 iov[seg].iov_len = len;
1796 iov_iter_init(i, type, iov, nr_segs, total_len);
1805 * import_iovec() - Copy an array of &struct iovec from userspace
1806 * into the kernel, check that it is valid, and initialize a new
1807 * &struct iov_iter iterator to access it.
1809 * @type: One of %READ or %WRITE.
1810 * @uvec: Pointer to the userspace array.
1811 * @nr_segs: Number of elements in userspace array.
1812 * @fast_segs: Number of elements in @iov.
1813 * @iovp: (input and output parameter) Pointer to pointer to (usually small
1814 * on-stack) kernel array.
1815 * @i: Pointer to iterator that will be initialized on success.
1817 * If the array pointed to by *@iov is large enough to hold all @nr_segs,
1818 * then this function places %NULL in *@iov on return. Otherwise, a new
1819 * array will be allocated and the result placed in *@iov. This means that
1820 * the caller may call kfree() on *@iov regardless of whether the small
1821 * on-stack array was used or not (and regardless of whether this function
1822 * returns an error or not).
1824 * Return: Negative error code on error, bytes imported on success
1826 ssize_t import_iovec(int type, const struct iovec __user *uvec,
1827 unsigned nr_segs, unsigned fast_segs,
1828 struct iovec **iovp, struct iov_iter *i)
1830 return __import_iovec(type, uvec, nr_segs, fast_segs, iovp, i,
1831 in_compat_syscall());
1833 EXPORT_SYMBOL(import_iovec);
1835 int import_single_range(int rw, void __user *buf, size_t len,
1836 struct iovec *iov, struct iov_iter *i)
1838 if (len > MAX_RW_COUNT)
1840 if (unlikely(!access_ok(buf, len)))
1843 iov->iov_base = buf;
1845 iov_iter_init(i, rw, iov, 1, len);
1848 EXPORT_SYMBOL(import_single_range);
1851 * iov_iter_restore() - Restore a &struct iov_iter to the same state as when
1852 * iov_iter_save_state() was called.
1854 * @i: &struct iov_iter to restore
1855 * @state: state to restore from
1857 * Used after iov_iter_save_state() to bring restore @i, if operations may
1860 * Note: only works on ITER_IOVEC, ITER_BVEC, and ITER_KVEC
1862 void iov_iter_restore(struct iov_iter *i, struct iov_iter_state *state)
1864 if (WARN_ON_ONCE(!iov_iter_is_bvec(i) && !iter_is_iovec(i)) &&
1865 !iov_iter_is_kvec(i))
1867 i->iov_offset = state->iov_offset;
1868 i->count = state->count;
1870 * For the *vec iters, nr_segs + iov is constant - if we increment
1871 * the vec, then we also decrement the nr_segs count. Hence we don't
1872 * need to track both of these, just one is enough and we can deduct
1873 * the other from that. ITER_KVEC and ITER_IOVEC are the same struct
1874 * size, so we can just increment the iov pointer as they are unionzed.
1875 * ITER_BVEC _may_ be the same size on some archs, but on others it is
1876 * not. Be safe and handle it separately.
1878 BUILD_BUG_ON(sizeof(struct iovec) != sizeof(struct kvec));
1879 if (iov_iter_is_bvec(i))
1880 i->bvec -= state->nr_segs - i->nr_segs;
1882 i->iov -= state->nr_segs - i->nr_segs;
1883 i->nr_segs = state->nr_segs;