fold __pipe_get_pages() into pipe_get_pages()
[linux-block.git] / lib / iov_iter.c
CommitLineData
457c8996 1// SPDX-License-Identifier: GPL-2.0-only
7999096f 2#include <crypto/hash.h>
4f18cd31 3#include <linux/export.h>
2f8b5444 4#include <linux/bvec.h>
4d0e9df5 5#include <linux/fault-inject-usercopy.h>
4f18cd31
AV
6#include <linux/uio.h>
7#include <linux/pagemap.h>
28961998 8#include <linux/highmem.h>
91f79c43
AV
9#include <linux/slab.h>
10#include <linux/vmalloc.h>
241699cd 11#include <linux/splice.h>
bfdc5970 12#include <linux/compat.h>
a604ec7e 13#include <net/checksum.h>
d05f4435 14#include <linux/scatterlist.h>
d0ef4c36 15#include <linux/instrumented.h>
4f18cd31 16
241699cd
AV
17#define PIPE_PARANOIA /* for now */
18
fcb14cb1
AV
19/* covers ubuf and kbuf alike */
20#define iterate_buf(i, n, base, len, off, __p, STEP) { \
21 size_t __maybe_unused off = 0; \
22 len = n; \
23 base = __p + i->iov_offset; \
24 len -= (STEP); \
25 i->iov_offset += len; \
26 n = len; \
27}
28
5c67aa90 29/* covers iovec and kvec alike */
a6e4ec7b 30#define iterate_iovec(i, n, base, len, off, __p, STEP) { \
7baa5099 31 size_t off = 0; \
a6e4ec7b 32 size_t skip = i->iov_offset; \
7a1bcb5d 33 do { \
7baa5099
AV
34 len = min(n, __p->iov_len - skip); \
35 if (likely(len)) { \
36 base = __p->iov_base + skip; \
37 len -= (STEP); \
38 off += len; \
39 skip += len; \
40 n -= len; \
7a1bcb5d
AV
41 if (skip < __p->iov_len) \
42 break; \
43 } \
44 __p++; \
45 skip = 0; \
46 } while (n); \
a6e4ec7b 47 i->iov_offset = skip; \
7baa5099 48 n = off; \
04a31165
AV
49}
50
a6e4ec7b 51#define iterate_bvec(i, n, base, len, off, p, STEP) { \
7baa5099 52 size_t off = 0; \
a6e4ec7b 53 unsigned skip = i->iov_offset; \
7491a2bf
AV
54 while (n) { \
55 unsigned offset = p->bv_offset + skip; \
1b4fb5ff 56 unsigned left; \
21b56c84
AV
57 void *kaddr = kmap_local_page(p->bv_page + \
58 offset / PAGE_SIZE); \
7baa5099 59 base = kaddr + offset % PAGE_SIZE; \
a6e4ec7b 60 len = min(min(n, (size_t)(p->bv_len - skip)), \
7491a2bf 61 (size_t)(PAGE_SIZE - offset % PAGE_SIZE)); \
1b4fb5ff 62 left = (STEP); \
21b56c84 63 kunmap_local(kaddr); \
7baa5099
AV
64 len -= left; \
65 off += len; \
66 skip += len; \
7491a2bf
AV
67 if (skip == p->bv_len) { \
68 skip = 0; \
69 p++; \
70 } \
7baa5099 71 n -= len; \
1b4fb5ff
AV
72 if (left) \
73 break; \
7491a2bf 74 } \
a6e4ec7b 75 i->iov_offset = skip; \
7baa5099 76 n = off; \
04a31165
AV
77}
78
a6e4ec7b 79#define iterate_xarray(i, n, base, len, __off, STEP) { \
1b4fb5ff 80 __label__ __out; \
622838f3 81 size_t __off = 0; \
821979f5 82 struct folio *folio; \
a6e4ec7b 83 loff_t start = i->xarray_start + i->iov_offset; \
4b179e9a 84 pgoff_t index = start / PAGE_SIZE; \
7ff50620
DH
85 XA_STATE(xas, i->xarray, index); \
86 \
821979f5 87 len = PAGE_SIZE - offset_in_page(start); \
7baa5099 88 rcu_read_lock(); \
821979f5 89 xas_for_each(&xas, folio, ULONG_MAX) { \
7baa5099 90 unsigned left; \
821979f5
MWO
91 size_t offset; \
92 if (xas_retry(&xas, folio)) \
7baa5099 93 continue; \
821979f5 94 if (WARN_ON(xa_is_value(folio))) \
7baa5099 95 break; \
821979f5 96 if (WARN_ON(folio_test_hugetlb(folio))) \
7baa5099 97 break; \
821979f5
MWO
98 offset = offset_in_folio(folio, start + __off); \
99 while (offset < folio_size(folio)) { \
100 base = kmap_local_folio(folio, offset); \
7baa5099
AV
101 len = min(n, len); \
102 left = (STEP); \
821979f5 103 kunmap_local(base); \
7baa5099
AV
104 len -= left; \
105 __off += len; \
106 n -= len; \
107 if (left || n == 0) \
108 goto __out; \
821979f5
MWO
109 offset += len; \
110 len = PAGE_SIZE; \
7baa5099 111 } \
7ff50620 112 } \
1b4fb5ff 113__out: \
7ff50620 114 rcu_read_unlock(); \
821979f5 115 i->iov_offset += __off; \
622838f3 116 n = __off; \
7ff50620
DH
117}
118
7baa5099 119#define __iterate_and_advance(i, n, base, len, off, I, K) { \
dd254f5a
AV
120 if (unlikely(i->count < n)) \
121 n = i->count; \
f5da8354 122 if (likely(n)) { \
fcb14cb1
AV
123 if (likely(iter_is_ubuf(i))) { \
124 void __user *base; \
125 size_t len; \
126 iterate_buf(i, n, base, len, off, \
127 i->ubuf, (I)) \
128 } else if (likely(iter_is_iovec(i))) { \
5c67aa90 129 const struct iovec *iov = i->iov; \
7baa5099
AV
130 void __user *base; \
131 size_t len; \
132 iterate_iovec(i, n, base, len, off, \
a6e4ec7b 133 iov, (I)) \
28f38db7
AV
134 i->nr_segs -= iov - i->iov; \
135 i->iov = iov; \
136 } else if (iov_iter_is_bvec(i)) { \
1bdc76ae 137 const struct bio_vec *bvec = i->bvec; \
7baa5099
AV
138 void *base; \
139 size_t len; \
140 iterate_bvec(i, n, base, len, off, \
a6e4ec7b 141 bvec, (K)) \
7491a2bf
AV
142 i->nr_segs -= bvec - i->bvec; \
143 i->bvec = bvec; \
28f38db7 144 } else if (iov_iter_is_kvec(i)) { \
5c67aa90 145 const struct kvec *kvec = i->kvec; \
7baa5099
AV
146 void *base; \
147 size_t len; \
148 iterate_iovec(i, n, base, len, off, \
a6e4ec7b 149 kvec, (K)) \
dd254f5a
AV
150 i->nr_segs -= kvec - i->kvec; \
151 i->kvec = kvec; \
28f38db7 152 } else if (iov_iter_is_xarray(i)) { \
7baa5099
AV
153 void *base; \
154 size_t len; \
155 iterate_xarray(i, n, base, len, off, \
a6e4ec7b 156 (K)) \
7ce2a91e 157 } \
dd254f5a 158 i->count -= n; \
7ce2a91e 159 } \
7ce2a91e 160}
7baa5099
AV
161#define iterate_and_advance(i, n, base, len, off, I, K) \
162 __iterate_and_advance(i, n, base, len, off, I, ((void)(K),0))
7ce2a91e 163
09fc68dc
AV
164static int copyout(void __user *to, const void *from, size_t n)
165{
4d0e9df5
AL
166 if (should_fail_usercopy())
167 return n;
96d4f267 168 if (access_ok(to, n)) {
d0ef4c36 169 instrument_copy_to_user(to, from, n);
09fc68dc
AV
170 n = raw_copy_to_user(to, from, n);
171 }
172 return n;
173}
174
175static int copyin(void *to, const void __user *from, size_t n)
176{
4d0e9df5
AL
177 if (should_fail_usercopy())
178 return n;
96d4f267 179 if (access_ok(from, n)) {
d0ef4c36 180 instrument_copy_from_user(to, from, n);
09fc68dc
AV
181 n = raw_copy_from_user(to, from, n);
182 }
183 return n;
184}
185
2dcedb2a
AV
186static inline struct pipe_buffer *pipe_buf(const struct pipe_inode_info *pipe,
187 unsigned int slot)
188{
189 return &pipe->bufs[slot & (pipe->ring_size - 1)];
190}
191
241699cd
AV
192#ifdef PIPE_PARANOIA
193static bool sanity(const struct iov_iter *i)
194{
195 struct pipe_inode_info *pipe = i->pipe;
8cefc107
DH
196 unsigned int p_head = pipe->head;
197 unsigned int p_tail = pipe->tail;
8cefc107
DH
198 unsigned int p_occupancy = pipe_occupancy(p_head, p_tail);
199 unsigned int i_head = i->head;
200 unsigned int idx;
201
10f525a8 202 if (i->last_offset) {
241699cd 203 struct pipe_buffer *p;
8cefc107 204 if (unlikely(p_occupancy == 0))
241699cd 205 goto Bad; // pipe must be non-empty
8cefc107 206 if (unlikely(i_head != p_head - 1))
241699cd
AV
207 goto Bad; // must be at the last buffer...
208
2dcedb2a 209 p = pipe_buf(pipe, i_head);
10f525a8 210 if (unlikely(p->offset + p->len != abs(i->last_offset)))
241699cd
AV
211 goto Bad; // ... at the end of segment
212 } else {
8cefc107 213 if (i_head != p_head)
241699cd
AV
214 goto Bad; // must be right after the last buffer
215 }
216 return true;
217Bad:
10f525a8 218 printk(KERN_ERR "idx = %d, offset = %d\n", i_head, i->last_offset);
8cefc107
DH
219 printk(KERN_ERR "head = %d, tail = %d, buffers = %d\n",
220 p_head, p_tail, pipe->ring_size);
221 for (idx = 0; idx < pipe->ring_size; idx++)
241699cd
AV
222 printk(KERN_ERR "[%p %p %d %d]\n",
223 pipe->bufs[idx].ops,
224 pipe->bufs[idx].page,
225 pipe->bufs[idx].offset,
226 pipe->bufs[idx].len);
227 WARN_ON(1);
228 return false;
229}
230#else
231#define sanity(i) true
232#endif
233
47b7fcae
AV
234static struct page *push_anon(struct pipe_inode_info *pipe, unsigned size)
235{
236 struct page *page = alloc_page(GFP_USER);
237 if (page) {
238 struct pipe_buffer *buf = pipe_buf(pipe, pipe->head++);
239 *buf = (struct pipe_buffer) {
240 .ops = &default_pipe_buf_ops,
241 .page = page,
242 .offset = 0,
243 .len = size
244 };
245 }
246 return page;
247}
248
249static void push_page(struct pipe_inode_info *pipe, struct page *page,
250 unsigned int offset, unsigned int size)
251{
252 struct pipe_buffer *buf = pipe_buf(pipe, pipe->head++);
253 *buf = (struct pipe_buffer) {
254 .ops = &page_cache_pipe_buf_ops,
255 .page = page,
256 .offset = offset,
257 .len = size
258 };
259 get_page(page);
260}
261
10f525a8 262static inline int last_offset(const struct pipe_buffer *buf)
8fad7767 263{
10f525a8
AV
264 if (buf->ops == &default_pipe_buf_ops)
265 return buf->len; // buf->offset is 0 for those
266 else
267 return -(buf->offset + buf->len);
8fad7767
AV
268}
269
270static struct page *append_pipe(struct iov_iter *i, size_t size,
271 unsigned int *off)
272{
273 struct pipe_inode_info *pipe = i->pipe;
10f525a8 274 int offset = i->last_offset;
8fad7767
AV
275 struct pipe_buffer *buf;
276 struct page *page;
277
10f525a8
AV
278 if (offset > 0 && offset < PAGE_SIZE) {
279 // some space in the last buffer; add to it
8fad7767 280 buf = pipe_buf(pipe, pipe->head - 1);
10f525a8
AV
281 size = min_t(size_t, size, PAGE_SIZE - offset);
282 buf->len += size;
283 i->last_offset += size;
284 i->count -= size;
285 *off = offset;
286 return buf->page;
8fad7767
AV
287 }
288 // OK, we need a new buffer
289 *off = 0;
290 size = min_t(size_t, size, PAGE_SIZE);
291 if (pipe_full(pipe->head, pipe->tail, pipe->max_usage))
292 return NULL;
293 page = push_anon(pipe, size);
294 if (!page)
295 return NULL;
296 i->head = pipe->head - 1;
10f525a8 297 i->last_offset = size;
8fad7767
AV
298 i->count -= size;
299 return page;
300}
301
241699cd
AV
302static size_t copy_page_to_iter_pipe(struct page *page, size_t offset, size_t bytes,
303 struct iov_iter *i)
304{
305 struct pipe_inode_info *pipe = i->pipe;
47b7fcae 306 unsigned int head = pipe->head;
241699cd
AV
307
308 if (unlikely(bytes > i->count))
309 bytes = i->count;
310
311 if (unlikely(!bytes))
312 return 0;
313
314 if (!sanity(i))
315 return 0;
316
10f525a8 317 if (offset && i->last_offset == -offset) { // could we merge it?
47b7fcae
AV
318 struct pipe_buffer *buf = pipe_buf(pipe, head - 1);
319 if (buf->page == page) {
241699cd 320 buf->len += bytes;
10f525a8 321 i->last_offset -= bytes;
47b7fcae
AV
322 i->count -= bytes;
323 return bytes;
241699cd 324 }
241699cd 325 }
47b7fcae 326 if (pipe_full(pipe->head, pipe->tail, pipe->max_usage))
241699cd 327 return 0;
8cefc107 328
47b7fcae 329 push_page(pipe, page, offset, bytes);
10f525a8 330 i->last_offset = -(offset + bytes);
47b7fcae 331 i->head = head;
241699cd
AV
332 i->count -= bytes;
333 return bytes;
334}
335
171a0203 336/*
a6294593
AG
337 * fault_in_iov_iter_readable - fault in iov iterator for reading
338 * @i: iterator
339 * @size: maximum length
340 *
171a0203 341 * Fault in one or more iovecs of the given iov_iter, to a maximum length of
a6294593
AG
342 * @size. For each iovec, fault in each page that constitutes the iovec.
343 *
344 * Returns the number of bytes not faulted in (like copy_to_user() and
345 * copy_from_user()).
171a0203 346 *
a6294593 347 * Always returns 0 for non-userspace iterators.
171a0203 348 */
a6294593 349size_t fault_in_iov_iter_readable(const struct iov_iter *i, size_t size)
171a0203 350{
fcb14cb1
AV
351 if (iter_is_ubuf(i)) {
352 size_t n = min(size, iov_iter_count(i));
353 n -= fault_in_readable(i->ubuf + i->iov_offset, n);
354 return size - n;
355 } else if (iter_is_iovec(i)) {
a6294593 356 size_t count = min(size, iov_iter_count(i));
8409a0d2
AV
357 const struct iovec *p;
358 size_t skip;
359
a6294593
AG
360 size -= count;
361 for (p = i->iov, skip = i->iov_offset; count; p++, skip = 0) {
362 size_t len = min(count, p->iov_len - skip);
363 size_t ret;
8409a0d2
AV
364
365 if (unlikely(!len))
366 continue;
a6294593
AG
367 ret = fault_in_readable(p->iov_base + skip, len);
368 count -= len - ret;
369 if (ret)
370 break;
8409a0d2 371 }
a6294593 372 return count + size;
171a0203
AA
373 }
374 return 0;
375}
a6294593 376EXPORT_SYMBOL(fault_in_iov_iter_readable);
171a0203 377
cdd591fc
AG
378/*
379 * fault_in_iov_iter_writeable - fault in iov iterator for writing
380 * @i: iterator
381 * @size: maximum length
382 *
383 * Faults in the iterator using get_user_pages(), i.e., without triggering
384 * hardware page faults. This is primarily useful when we already know that
385 * some or all of the pages in @i aren't in memory.
386 *
387 * Returns the number of bytes not faulted in, like copy_to_user() and
388 * copy_from_user().
389 *
390 * Always returns 0 for non-user-space iterators.
391 */
392size_t fault_in_iov_iter_writeable(const struct iov_iter *i, size_t size)
393{
fcb14cb1
AV
394 if (iter_is_ubuf(i)) {
395 size_t n = min(size, iov_iter_count(i));
396 n -= fault_in_safe_writeable(i->ubuf + i->iov_offset, n);
397 return size - n;
398 } else if (iter_is_iovec(i)) {
cdd591fc
AG
399 size_t count = min(size, iov_iter_count(i));
400 const struct iovec *p;
401 size_t skip;
402
403 size -= count;
404 for (p = i->iov, skip = i->iov_offset; count; p++, skip = 0) {
405 size_t len = min(count, p->iov_len - skip);
406 size_t ret;
407
408 if (unlikely(!len))
409 continue;
410 ret = fault_in_safe_writeable(p->iov_base + skip, len);
411 count -= len - ret;
412 if (ret)
413 break;
414 }
415 return count + size;
416 }
417 return 0;
418}
419EXPORT_SYMBOL(fault_in_iov_iter_writeable);
420
aa563d7b 421void iov_iter_init(struct iov_iter *i, unsigned int direction,
71d8e532
AV
422 const struct iovec *iov, unsigned long nr_segs,
423 size_t count)
424{
aa563d7b 425 WARN_ON(direction & ~(READ | WRITE));
8cd54c1c
AV
426 *i = (struct iov_iter) {
427 .iter_type = ITER_IOVEC,
3337ab08 428 .nofault = false,
fcb14cb1 429 .user_backed = true,
8cd54c1c
AV
430 .data_source = direction,
431 .iov = iov,
432 .nr_segs = nr_segs,
433 .iov_offset = 0,
434 .count = count
435 };
71d8e532
AV
436}
437EXPORT_SYMBOL(iov_iter_init);
7b2c99d1 438
12d426ab
AV
439// returns the offset in partial buffer (if any)
440static inline unsigned int pipe_npages(const struct iov_iter *i, int *npages)
241699cd 441{
12d426ab
AV
442 struct pipe_inode_info *pipe = i->pipe;
443 int used = pipe->head - pipe->tail;
10f525a8 444 int off = i->last_offset;
8cefc107 445
12d426ab
AV
446 *npages = max((int)pipe->max_usage - used, 0);
447
10f525a8 448 if (off > 0 && off < PAGE_SIZE) { // anon and not full
12d426ab
AV
449 (*npages)++;
450 return off;
241699cd 451 }
12d426ab 452 return 0;
241699cd
AV
453}
454
241699cd
AV
455static size_t copy_pipe_to_iter(const void *addr, size_t bytes,
456 struct iov_iter *i)
457{
8fad7767 458 unsigned int off, chunk;
241699cd 459
8fad7767
AV
460 if (unlikely(bytes > i->count))
461 bytes = i->count;
462 if (unlikely(!bytes))
241699cd
AV
463 return 0;
464
8fad7767 465 if (!sanity(i))
241699cd 466 return 0;
8fad7767
AV
467
468 for (size_t n = bytes; n; n -= chunk) {
469 struct page *page = append_pipe(i, n, &off);
470 chunk = min_t(size_t, n, PAGE_SIZE - off);
471 if (!page)
472 return bytes - n;
473 memcpy_to_page(page, off, addr, chunk);
241699cd 474 addr += chunk;
8fad7767 475 }
241699cd
AV
476 return bytes;
477}
478
f9152895
AV
479static __wsum csum_and_memcpy(void *to, const void *from, size_t len,
480 __wsum sum, size_t off)
481{
cc44c17b 482 __wsum next = csum_partial_copy_nocheck(from, to, len);
f9152895
AV
483 return csum_block_add(sum, next, off);
484}
485
78e1f386 486static size_t csum_and_copy_to_pipe_iter(const void *addr, size_t bytes,
6852df12 487 struct iov_iter *i, __wsum *sump)
78e1f386 488{
6852df12
AV
489 __wsum sum = *sump;
490 size_t off = 0;
8fad7767
AV
491 unsigned int chunk, r;
492
493 if (unlikely(bytes > i->count))
494 bytes = i->count;
495 if (unlikely(!bytes))
496 return 0;
78e1f386
AV
497
498 if (!sanity(i))
499 return 0;
500
6852df12 501 while (bytes) {
8fad7767
AV
502 struct page *page = append_pipe(i, bytes, &r);
503 char *p;
504
505 if (!page)
506 break;
507 chunk = min_t(size_t, bytes, PAGE_SIZE - r);
508 p = kmap_local_page(page);
6852df12 509 sum = csum_and_memcpy(p + r, addr + off, chunk, sum, off);
2495bdcc 510 kunmap_local(p);
78e1f386 511 off += chunk;
8fad7767 512 bytes -= chunk;
6852df12
AV
513 }
514 *sump = sum;
6852df12 515 return off;
78e1f386
AV
516}
517
aa28de27 518size_t _copy_to_iter(const void *addr, size_t bytes, struct iov_iter *i)
62a8067a 519{
00e23707 520 if (unlikely(iov_iter_is_pipe(i)))
241699cd 521 return copy_pipe_to_iter(addr, bytes, i);
fcb14cb1 522 if (user_backed_iter(i))
09fc68dc 523 might_fault();
7baa5099
AV
524 iterate_and_advance(i, bytes, base, len, off,
525 copyout(base, addr + off, len),
526 memcpy(base, addr + off, len)
3d4d3e48 527 )
62a8067a 528
3d4d3e48 529 return bytes;
c35e0248 530}
aa28de27 531EXPORT_SYMBOL(_copy_to_iter);
c35e0248 532
ec6347bb
DW
533#ifdef CONFIG_ARCH_HAS_COPY_MC
534static int copyout_mc(void __user *to, const void *from, size_t n)
8780356e 535{
96d4f267 536 if (access_ok(to, n)) {
d0ef4c36 537 instrument_copy_to_user(to, from, n);
ec6347bb 538 n = copy_mc_to_user((__force void *) to, from, n);
8780356e
DW
539 }
540 return n;
541}
542
ec6347bb 543static size_t copy_mc_pipe_to_iter(const void *addr, size_t bytes,
ca146f6f
DW
544 struct iov_iter *i)
545{
8fad7767
AV
546 size_t xfer = 0;
547 unsigned int off, chunk;
548
549 if (unlikely(bytes > i->count))
550 bytes = i->count;
551 if (unlikely(!bytes))
552 return 0;
ca146f6f
DW
553
554 if (!sanity(i))
555 return 0;
556
8fad7767
AV
557 while (bytes) {
558 struct page *page = append_pipe(i, bytes, &off);
ca146f6f 559 unsigned long rem;
8fad7767
AV
560 char *p;
561
562 if (!page)
563 break;
564 chunk = min_t(size_t, bytes, PAGE_SIZE - off);
565 p = kmap_local_page(page);
2a510a74
AV
566 rem = copy_mc_to_kernel(p + off, addr + xfer, chunk);
567 chunk -= rem;
568 kunmap_local(p);
8fad7767
AV
569 xfer += chunk;
570 bytes -= chunk;
c3497fd0 571 if (rem) {
8fad7767 572 iov_iter_revert(i, rem);
ca146f6f 573 break;
c3497fd0 574 }
2a510a74 575 }
ca146f6f
DW
576 return xfer;
577}
578
bf3eeb9b 579/**
ec6347bb 580 * _copy_mc_to_iter - copy to iter with source memory error exception handling
bf3eeb9b
DW
581 * @addr: source kernel address
582 * @bytes: total transfer length
44e55997 583 * @i: destination iterator
bf3eeb9b 584 *
ec6347bb
DW
585 * The pmem driver deploys this for the dax operation
586 * (dax_copy_to_iter()) for dax reads (bypass page-cache and the
587 * block-layer). Upon #MC read(2) aborts and returns EIO or the bytes
588 * successfully copied.
bf3eeb9b 589 *
ec6347bb 590 * The main differences between this and typical _copy_to_iter().
bf3eeb9b
DW
591 *
592 * * Typical tail/residue handling after a fault retries the copy
593 * byte-by-byte until the fault happens again. Re-triggering machine
594 * checks is potentially fatal so the implementation uses source
595 * alignment and poison alignment assumptions to avoid re-triggering
596 * hardware exceptions.
597 *
598 * * ITER_KVEC, ITER_PIPE, and ITER_BVEC can return short copies.
599 * Compare to copy_to_iter() where only ITER_IOVEC attempts might return
600 * a short copy.
44e55997
RD
601 *
602 * Return: number of bytes copied (may be %0)
bf3eeb9b 603 */
ec6347bb 604size_t _copy_mc_to_iter(const void *addr, size_t bytes, struct iov_iter *i)
8780356e 605{
00e23707 606 if (unlikely(iov_iter_is_pipe(i)))
ec6347bb 607 return copy_mc_pipe_to_iter(addr, bytes, i);
fcb14cb1 608 if (user_backed_iter(i))
8780356e 609 might_fault();
7baa5099
AV
610 __iterate_and_advance(i, bytes, base, len, off,
611 copyout_mc(base, addr + off, len),
612 copy_mc_to_kernel(base, addr + off, len)
8780356e
DW
613 )
614
615 return bytes;
616}
ec6347bb
DW
617EXPORT_SYMBOL_GPL(_copy_mc_to_iter);
618#endif /* CONFIG_ARCH_HAS_COPY_MC */
8780356e 619
aa28de27 620size_t _copy_from_iter(void *addr, size_t bytes, struct iov_iter *i)
c35e0248 621{
00e23707 622 if (unlikely(iov_iter_is_pipe(i))) {
241699cd
AV
623 WARN_ON(1);
624 return 0;
625 }
fcb14cb1 626 if (user_backed_iter(i))
09fc68dc 627 might_fault();
7baa5099
AV
628 iterate_and_advance(i, bytes, base, len, off,
629 copyin(addr + off, base, len),
630 memcpy(addr + off, base, len)
0dbca9a4
AV
631 )
632
633 return bytes;
c35e0248 634}
aa28de27 635EXPORT_SYMBOL(_copy_from_iter);
c35e0248 636
aa28de27 637size_t _copy_from_iter_nocache(void *addr, size_t bytes, struct iov_iter *i)
aa583096 638{
00e23707 639 if (unlikely(iov_iter_is_pipe(i))) {
241699cd
AV
640 WARN_ON(1);
641 return 0;
642 }
7baa5099
AV
643 iterate_and_advance(i, bytes, base, len, off,
644 __copy_from_user_inatomic_nocache(addr + off, base, len),
645 memcpy(addr + off, base, len)
aa583096
AV
646 )
647
648 return bytes;
649}
aa28de27 650EXPORT_SYMBOL(_copy_from_iter_nocache);
aa583096 651
0aed55af 652#ifdef CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE
abd08d7d
DW
653/**
654 * _copy_from_iter_flushcache - write destination through cpu cache
655 * @addr: destination kernel address
656 * @bytes: total transfer length
44e55997 657 * @i: source iterator
abd08d7d
DW
658 *
659 * The pmem driver arranges for filesystem-dax to use this facility via
660 * dax_copy_from_iter() for ensuring that writes to persistent memory
661 * are flushed through the CPU cache. It is differentiated from
662 * _copy_from_iter_nocache() in that guarantees all data is flushed for
663 * all iterator types. The _copy_from_iter_nocache() only attempts to
664 * bypass the cache for the ITER_IOVEC case, and on some archs may use
665 * instructions that strand dirty-data in the cache.
44e55997
RD
666 *
667 * Return: number of bytes copied (may be %0)
abd08d7d 668 */
6a37e940 669size_t _copy_from_iter_flushcache(void *addr, size_t bytes, struct iov_iter *i)
0aed55af 670{
00e23707 671 if (unlikely(iov_iter_is_pipe(i))) {
0aed55af
DW
672 WARN_ON(1);
673 return 0;
674 }
7baa5099
AV
675 iterate_and_advance(i, bytes, base, len, off,
676 __copy_from_user_flushcache(addr + off, base, len),
677 memcpy_flushcache(addr + off, base, len)
0aed55af
DW
678 )
679
680 return bytes;
681}
6a37e940 682EXPORT_SYMBOL_GPL(_copy_from_iter_flushcache);
0aed55af
DW
683#endif
684
72e809ed
AV
685static inline bool page_copy_sane(struct page *page, size_t offset, size_t n)
686{
6daef95b
ED
687 struct page *head;
688 size_t v = n + offset;
689
690 /*
691 * The general case needs to access the page order in order
692 * to compute the page size.
693 * However, we mostly deal with order-0 pages and thus can
694 * avoid a possible cache line miss for requests that fit all
695 * page orders.
696 */
697 if (n <= v && v <= PAGE_SIZE)
698 return true;
699
700 head = compound_head(page);
701 v += (page - head) << PAGE_SHIFT;
a90bcb86 702
a50b854e 703 if (likely(n <= v && v <= (page_size(head))))
72e809ed
AV
704 return true;
705 WARN_ON(1);
706 return false;
707}
cbbd26b8 708
08aa6479 709static size_t __copy_page_to_iter(struct page *page, size_t offset, size_t bytes,
62a8067a
AV
710 struct iov_iter *i)
711{
59bb69c6
AV
712 if (unlikely(iov_iter_is_pipe(i))) {
713 return copy_page_to_iter_pipe(page, offset, bytes, i);
714 } else {
c1d4d6a9
AV
715 void *kaddr = kmap_local_page(page);
716 size_t wanted = _copy_to_iter(kaddr + offset, bytes, i);
717 kunmap_local(kaddr);
d271524a 718 return wanted;
28f38db7 719 }
62a8067a 720}
08aa6479
AV
721
722size_t copy_page_to_iter(struct page *page, size_t offset, size_t bytes,
723 struct iov_iter *i)
724{
725 size_t res = 0;
726 if (unlikely(!page_copy_sane(page, offset, bytes)))
727 return 0;
728 page += offset / PAGE_SIZE; // first subpage
729 offset %= PAGE_SIZE;
730 while (1) {
731 size_t n = __copy_page_to_iter(page, offset,
732 min(bytes, (size_t)PAGE_SIZE - offset), i);
733 res += n;
734 bytes -= n;
735 if (!bytes || !n)
736 break;
737 offset += n;
738 if (offset == PAGE_SIZE) {
739 page++;
740 offset = 0;
741 }
742 }
743 return res;
744}
62a8067a
AV
745EXPORT_SYMBOL(copy_page_to_iter);
746
747size_t copy_page_from_iter(struct page *page, size_t offset, size_t bytes,
748 struct iov_iter *i)
749{
59bb69c6 750 if (page_copy_sane(page, offset, bytes)) {
55ca375c 751 void *kaddr = kmap_local_page(page);
aa28de27 752 size_t wanted = _copy_from_iter(kaddr + offset, bytes, i);
55ca375c 753 kunmap_local(kaddr);
d271524a 754 return wanted;
28f38db7 755 }
28f38db7 756 return 0;
62a8067a
AV
757}
758EXPORT_SYMBOL(copy_page_from_iter);
759
241699cd
AV
760static size_t pipe_zero(size_t bytes, struct iov_iter *i)
761{
8fad7767 762 unsigned int chunk, off;
241699cd 763
8fad7767
AV
764 if (unlikely(bytes > i->count))
765 bytes = i->count;
766 if (unlikely(!bytes))
241699cd
AV
767 return 0;
768
8fad7767 769 if (!sanity(i))
241699cd
AV
770 return 0;
771
8fad7767
AV
772 for (size_t n = bytes; n; n -= chunk) {
773 struct page *page = append_pipe(i, n, &off);
774 char *p;
775
776 if (!page)
777 return bytes - n;
778 chunk = min_t(size_t, n, PAGE_SIZE - off);
779 p = kmap_local_page(page);
893839fd
AV
780 memset(p + off, 0, chunk);
781 kunmap_local(p);
8fad7767 782 }
241699cd
AV
783 return bytes;
784}
785
c35e0248
MW
786size_t iov_iter_zero(size_t bytes, struct iov_iter *i)
787{
00e23707 788 if (unlikely(iov_iter_is_pipe(i)))
241699cd 789 return pipe_zero(bytes, i);
7baa5099
AV
790 iterate_and_advance(i, bytes, base, len, count,
791 clear_user(base, len),
792 memset(base, 0, len)
8442fa46
AV
793 )
794
795 return bytes;
c35e0248
MW
796}
797EXPORT_SYMBOL(iov_iter_zero);
798
f0b65f39
AV
799size_t copy_page_from_iter_atomic(struct page *page, unsigned offset, size_t bytes,
800 struct iov_iter *i)
62a8067a 801{
04a31165 802 char *kaddr = kmap_atomic(page), *p = kaddr + offset;
72e809ed
AV
803 if (unlikely(!page_copy_sane(page, offset, bytes))) {
804 kunmap_atomic(kaddr);
805 return 0;
806 }
9ea9ce04 807 if (unlikely(iov_iter_is_pipe(i) || iov_iter_is_discard(i))) {
241699cd
AV
808 kunmap_atomic(kaddr);
809 WARN_ON(1);
810 return 0;
811 }
7baa5099
AV
812 iterate_and_advance(i, bytes, base, len, off,
813 copyin(p + off, base, len),
814 memcpy(p + off, base, len)
04a31165
AV
815 )
816 kunmap_atomic(kaddr);
817 return bytes;
62a8067a 818}
f0b65f39 819EXPORT_SYMBOL(copy_page_from_iter_atomic);
62a8067a 820
241699cd
AV
821static void pipe_advance(struct iov_iter *i, size_t size)
822{
823 struct pipe_inode_info *pipe = i->pipe;
10f525a8 824 int off = i->last_offset;
8cefc107 825
2c855de9
AV
826 if (!off && !size) {
827 pipe_discard_from(pipe, i->start_head); // discard everything
828 return;
829 }
830 i->count -= size;
831 while (1) {
832 struct pipe_buffer *buf = pipe_buf(pipe, i->head);
241699cd 833 if (off) /* make it relative to the beginning of buffer */
10f525a8 834 size += abs(off) - buf->offset;
2c855de9
AV
835 if (size <= buf->len) {
836 buf->len = size;
10f525a8 837 i->last_offset = last_offset(buf);
2c855de9 838 break;
241699cd 839 }
2c855de9
AV
840 size -= buf->len;
841 i->head++;
842 off = 0;
241699cd 843 }
2c855de9 844 pipe_discard_from(pipe, i->head + 1); // discard everything past this one
241699cd
AV
845}
846
54c8195b
PB
847static void iov_iter_bvec_advance(struct iov_iter *i, size_t size)
848{
18fa9af7 849 const struct bio_vec *bvec, *end;
54c8195b 850
18fa9af7
AV
851 if (!i->count)
852 return;
853 i->count -= size;
854
855 size += i->iov_offset;
54c8195b 856
18fa9af7
AV
857 for (bvec = i->bvec, end = bvec + i->nr_segs; bvec < end; bvec++) {
858 if (likely(size < bvec->bv_len))
859 break;
860 size -= bvec->bv_len;
861 }
862 i->iov_offset = size;
863 i->nr_segs -= bvec - i->bvec;
864 i->bvec = bvec;
54c8195b
PB
865}
866
185ac4d4
AV
867static void iov_iter_iovec_advance(struct iov_iter *i, size_t size)
868{
869 const struct iovec *iov, *end;
870
871 if (!i->count)
872 return;
873 i->count -= size;
874
875 size += i->iov_offset; // from beginning of current segment
876 for (iov = i->iov, end = iov + i->nr_segs; iov < end; iov++) {
877 if (likely(size < iov->iov_len))
878 break;
879 size -= iov->iov_len;
880 }
881 i->iov_offset = size;
882 i->nr_segs -= iov - i->iov;
883 i->iov = iov;
884}
885
62a8067a
AV
886void iov_iter_advance(struct iov_iter *i, size_t size)
887{
3b3fc051
AV
888 if (unlikely(i->count < size))
889 size = i->count;
fcb14cb1
AV
890 if (likely(iter_is_ubuf(i)) || unlikely(iov_iter_is_xarray(i))) {
891 i->iov_offset += size;
892 i->count -= size;
893 } else if (likely(iter_is_iovec(i) || iov_iter_is_kvec(i))) {
185ac4d4
AV
894 /* iovec and kvec have identical layouts */
895 iov_iter_iovec_advance(i, size);
896 } else if (iov_iter_is_bvec(i)) {
897 iov_iter_bvec_advance(i, size);
898 } else if (iov_iter_is_pipe(i)) {
241699cd 899 pipe_advance(i, size);
185ac4d4
AV
900 } else if (iov_iter_is_discard(i)) {
901 i->count -= size;
54c8195b 902 }
62a8067a
AV
903}
904EXPORT_SYMBOL(iov_iter_advance);
905
27c0e374
AV
906void iov_iter_revert(struct iov_iter *i, size_t unroll)
907{
908 if (!unroll)
909 return;
5b47d59a
AV
910 if (WARN_ON(unroll > MAX_RW_COUNT))
911 return;
27c0e374 912 i->count += unroll;
00e23707 913 if (unlikely(iov_iter_is_pipe(i))) {
27c0e374 914 struct pipe_inode_info *pipe = i->pipe;
92acdc4f
AV
915 unsigned int head = pipe->head;
916
917 while (head > i->start_head) {
918 struct pipe_buffer *b = pipe_buf(pipe, --head);
919 if (unroll < b->len) {
920 b->len -= unroll;
10f525a8 921 i->last_offset = last_offset(b);
92acdc4f
AV
922 i->head = head;
923 return;
27c0e374 924 }
92acdc4f
AV
925 unroll -= b->len;
926 pipe_buf_release(pipe, b);
927 pipe->head--;
27c0e374 928 }
10f525a8 929 i->last_offset = 0;
92acdc4f 930 i->head = head;
27c0e374
AV
931 return;
932 }
9ea9ce04
DH
933 if (unlikely(iov_iter_is_discard(i)))
934 return;
27c0e374
AV
935 if (unroll <= i->iov_offset) {
936 i->iov_offset -= unroll;
937 return;
938 }
939 unroll -= i->iov_offset;
fcb14cb1 940 if (iov_iter_is_xarray(i) || iter_is_ubuf(i)) {
7ff50620
DH
941 BUG(); /* We should never go beyond the start of the specified
942 * range since we might then be straying into pages that
943 * aren't pinned.
944 */
945 } else if (iov_iter_is_bvec(i)) {
27c0e374
AV
946 const struct bio_vec *bvec = i->bvec;
947 while (1) {
948 size_t n = (--bvec)->bv_len;
949 i->nr_segs++;
950 if (unroll <= n) {
951 i->bvec = bvec;
952 i->iov_offset = n - unroll;
953 return;
954 }
955 unroll -= n;
956 }
957 } else { /* same logics for iovec and kvec */
958 const struct iovec *iov = i->iov;
959 while (1) {
960 size_t n = (--iov)->iov_len;
961 i->nr_segs++;
962 if (unroll <= n) {
963 i->iov = iov;
964 i->iov_offset = n - unroll;
965 return;
966 }
967 unroll -= n;
968 }
969 }
970}
971EXPORT_SYMBOL(iov_iter_revert);
972
62a8067a
AV
973/*
974 * Return the count of just the current iov_iter segment.
975 */
976size_t iov_iter_single_seg_count(const struct iov_iter *i)
977{
28f38db7
AV
978 if (i->nr_segs > 1) {
979 if (likely(iter_is_iovec(i) || iov_iter_is_kvec(i)))
980 return min(i->count, i->iov->iov_len - i->iov_offset);
981 if (iov_iter_is_bvec(i))
982 return min(i->count, i->bvec->bv_len - i->iov_offset);
983 }
984 return i->count;
62a8067a
AV
985}
986EXPORT_SYMBOL(iov_iter_single_seg_count);
987
aa563d7b 988void iov_iter_kvec(struct iov_iter *i, unsigned int direction,
05afcb77 989 const struct kvec *kvec, unsigned long nr_segs,
abb78f87
AV
990 size_t count)
991{
aa563d7b 992 WARN_ON(direction & ~(READ | WRITE));
8cd54c1c
AV
993 *i = (struct iov_iter){
994 .iter_type = ITER_KVEC,
995 .data_source = direction,
996 .kvec = kvec,
997 .nr_segs = nr_segs,
998 .iov_offset = 0,
999 .count = count
1000 };
abb78f87
AV
1001}
1002EXPORT_SYMBOL(iov_iter_kvec);
1003
aa563d7b 1004void iov_iter_bvec(struct iov_iter *i, unsigned int direction,
05afcb77
AV
1005 const struct bio_vec *bvec, unsigned long nr_segs,
1006 size_t count)
1007{
aa563d7b 1008 WARN_ON(direction & ~(READ | WRITE));
8cd54c1c
AV
1009 *i = (struct iov_iter){
1010 .iter_type = ITER_BVEC,
1011 .data_source = direction,
1012 .bvec = bvec,
1013 .nr_segs = nr_segs,
1014 .iov_offset = 0,
1015 .count = count
1016 };
05afcb77
AV
1017}
1018EXPORT_SYMBOL(iov_iter_bvec);
1019
aa563d7b 1020void iov_iter_pipe(struct iov_iter *i, unsigned int direction,
241699cd
AV
1021 struct pipe_inode_info *pipe,
1022 size_t count)
1023{
aa563d7b 1024 BUG_ON(direction != READ);
8cefc107 1025 WARN_ON(pipe_full(pipe->head, pipe->tail, pipe->ring_size));
8cd54c1c
AV
1026 *i = (struct iov_iter){
1027 .iter_type = ITER_PIPE,
1028 .data_source = false,
1029 .pipe = pipe,
1030 .head = pipe->head,
1031 .start_head = pipe->head,
10f525a8 1032 .last_offset = 0,
8cd54c1c
AV
1033 .count = count
1034 };
241699cd
AV
1035}
1036EXPORT_SYMBOL(iov_iter_pipe);
1037
7ff50620
DH
1038/**
1039 * iov_iter_xarray - Initialise an I/O iterator to use the pages in an xarray
1040 * @i: The iterator to initialise.
1041 * @direction: The direction of the transfer.
1042 * @xarray: The xarray to access.
1043 * @start: The start file position.
1044 * @count: The size of the I/O buffer in bytes.
1045 *
1046 * Set up an I/O iterator to either draw data out of the pages attached to an
1047 * inode or to inject data into those pages. The pages *must* be prevented
1048 * from evaporation, either by taking a ref on them or locking them by the
1049 * caller.
1050 */
1051void iov_iter_xarray(struct iov_iter *i, unsigned int direction,
1052 struct xarray *xarray, loff_t start, size_t count)
1053{
1054 BUG_ON(direction & ~1);
8cd54c1c
AV
1055 *i = (struct iov_iter) {
1056 .iter_type = ITER_XARRAY,
1057 .data_source = direction,
1058 .xarray = xarray,
1059 .xarray_start = start,
1060 .count = count,
1061 .iov_offset = 0
1062 };
7ff50620
DH
1063}
1064EXPORT_SYMBOL(iov_iter_xarray);
1065
9ea9ce04
DH
1066/**
1067 * iov_iter_discard - Initialise an I/O iterator that discards data
1068 * @i: The iterator to initialise.
1069 * @direction: The direction of the transfer.
1070 * @count: The size of the I/O buffer in bytes.
1071 *
1072 * Set up an I/O iterator that just discards everything that's written to it.
1073 * It's only available as a READ iterator.
1074 */
1075void iov_iter_discard(struct iov_iter *i, unsigned int direction, size_t count)
1076{
1077 BUG_ON(direction != READ);
8cd54c1c
AV
1078 *i = (struct iov_iter){
1079 .iter_type = ITER_DISCARD,
1080 .data_source = false,
1081 .count = count,
1082 .iov_offset = 0
1083 };
9ea9ce04
DH
1084}
1085EXPORT_SYMBOL(iov_iter_discard);
1086
cfa320f7
KB
1087static bool iov_iter_aligned_iovec(const struct iov_iter *i, unsigned addr_mask,
1088 unsigned len_mask)
1089{
1090 size_t size = i->count;
1091 size_t skip = i->iov_offset;
1092 unsigned k;
1093
1094 for (k = 0; k < i->nr_segs; k++, skip = 0) {
1095 size_t len = i->iov[k].iov_len - skip;
1096
1097 if (len > size)
1098 len = size;
1099 if (len & len_mask)
1100 return false;
1101 if ((unsigned long)(i->iov[k].iov_base + skip) & addr_mask)
1102 return false;
1103
1104 size -= len;
1105 if (!size)
1106 break;
1107 }
1108 return true;
1109}
1110
1111static bool iov_iter_aligned_bvec(const struct iov_iter *i, unsigned addr_mask,
1112 unsigned len_mask)
1113{
1114 size_t size = i->count;
1115 unsigned skip = i->iov_offset;
1116 unsigned k;
1117
1118 for (k = 0; k < i->nr_segs; k++, skip = 0) {
1119 size_t len = i->bvec[k].bv_len - skip;
1120
1121 if (len > size)
1122 len = size;
1123 if (len & len_mask)
1124 return false;
1125 if ((unsigned long)(i->bvec[k].bv_offset + skip) & addr_mask)
1126 return false;
1127
1128 size -= len;
1129 if (!size)
1130 break;
1131 }
1132 return true;
1133}
1134
1135/**
1136 * iov_iter_is_aligned() - Check if the addresses and lengths of each segments
1137 * are aligned to the parameters.
1138 *
1139 * @i: &struct iov_iter to restore
1140 * @addr_mask: bit mask to check against the iov element's addresses
1141 * @len_mask: bit mask to check against the iov element's lengths
1142 *
1143 * Return: false if any addresses or lengths intersect with the provided masks
1144 */
1145bool iov_iter_is_aligned(const struct iov_iter *i, unsigned addr_mask,
1146 unsigned len_mask)
1147{
fcb14cb1
AV
1148 if (likely(iter_is_ubuf(i))) {
1149 if (i->count & len_mask)
1150 return false;
1151 if ((unsigned long)(i->ubuf + i->iov_offset) & addr_mask)
1152 return false;
1153 return true;
1154 }
1155
cfa320f7
KB
1156 if (likely(iter_is_iovec(i) || iov_iter_is_kvec(i)))
1157 return iov_iter_aligned_iovec(i, addr_mask, len_mask);
1158
1159 if (iov_iter_is_bvec(i))
1160 return iov_iter_aligned_bvec(i, addr_mask, len_mask);
1161
1162 if (iov_iter_is_pipe(i)) {
cfa320f7
KB
1163 size_t size = i->count;
1164
1165 if (size & len_mask)
1166 return false;
10f525a8
AV
1167 if (size && i->last_offset > 0) {
1168 if (i->last_offset & addr_mask)
cfa320f7
KB
1169 return false;
1170 }
1171
1172 return true;
1173 }
1174
1175 if (iov_iter_is_xarray(i)) {
1176 if (i->count & len_mask)
1177 return false;
1178 if ((i->xarray_start + i->iov_offset) & addr_mask)
1179 return false;
1180 }
1181
1182 return true;
1183}
1184EXPORT_SYMBOL_GPL(iov_iter_is_aligned);
1185
9221d2e3 1186static unsigned long iov_iter_alignment_iovec(const struct iov_iter *i)
62a8067a 1187{
04a31165
AV
1188 unsigned long res = 0;
1189 size_t size = i->count;
9221d2e3
AV
1190 size_t skip = i->iov_offset;
1191 unsigned k;
1192
1193 for (k = 0; k < i->nr_segs; k++, skip = 0) {
1194 size_t len = i->iov[k].iov_len - skip;
1195 if (len) {
1196 res |= (unsigned long)i->iov[k].iov_base + skip;
1197 if (len > size)
1198 len = size;
1199 res |= len;
1200 size -= len;
1201 if (!size)
1202 break;
1203 }
1204 }
1205 return res;
1206}
04a31165 1207
9221d2e3
AV
1208static unsigned long iov_iter_alignment_bvec(const struct iov_iter *i)
1209{
1210 unsigned res = 0;
1211 size_t size = i->count;
1212 unsigned skip = i->iov_offset;
1213 unsigned k;
1214
1215 for (k = 0; k < i->nr_segs; k++, skip = 0) {
1216 size_t len = i->bvec[k].bv_len - skip;
1217 res |= (unsigned long)i->bvec[k].bv_offset + skip;
1218 if (len > size)
1219 len = size;
1220 res |= len;
1221 size -= len;
1222 if (!size)
1223 break;
1224 }
1225 return res;
1226}
1227
1228unsigned long iov_iter_alignment(const struct iov_iter *i)
1229{
fcb14cb1
AV
1230 if (likely(iter_is_ubuf(i))) {
1231 size_t size = i->count;
1232 if (size)
1233 return ((unsigned long)i->ubuf + i->iov_offset) | size;
1234 return 0;
1235 }
1236
9221d2e3
AV
1237 /* iovec and kvec have identical layouts */
1238 if (likely(iter_is_iovec(i) || iov_iter_is_kvec(i)))
1239 return iov_iter_alignment_iovec(i);
1240
1241 if (iov_iter_is_bvec(i))
1242 return iov_iter_alignment_bvec(i);
1243
1244 if (iov_iter_is_pipe(i)) {
9221d2e3 1245 size_t size = i->count;
e0ff126e 1246
10f525a8
AV
1247 if (size && i->last_offset > 0)
1248 return size | i->last_offset;
241699cd
AV
1249 return size;
1250 }
9221d2e3
AV
1251
1252 if (iov_iter_is_xarray(i))
3d14ec1f 1253 return (i->xarray_start + i->iov_offset) | i->count;
9221d2e3
AV
1254
1255 return 0;
62a8067a
AV
1256}
1257EXPORT_SYMBOL(iov_iter_alignment);
1258
357f435d
AV
1259unsigned long iov_iter_gap_alignment(const struct iov_iter *i)
1260{
33844e66 1261 unsigned long res = 0;
610c7a71 1262 unsigned long v = 0;
357f435d 1263 size_t size = i->count;
610c7a71 1264 unsigned k;
357f435d 1265
fcb14cb1
AV
1266 if (iter_is_ubuf(i))
1267 return 0;
1268
610c7a71 1269 if (WARN_ON(!iter_is_iovec(i)))
241699cd 1270 return ~0U;
241699cd 1271
610c7a71
AV
1272 for (k = 0; k < i->nr_segs; k++) {
1273 if (i->iov[k].iov_len) {
1274 unsigned long base = (unsigned long)i->iov[k].iov_base;
1275 if (v) // if not the first one
1276 res |= base | v; // this start | previous end
1277 v = base + i->iov[k].iov_len;
1278 if (size <= i->iov[k].iov_len)
1279 break;
1280 size -= i->iov[k].iov_len;
1281 }
1282 }
33844e66 1283 return res;
357f435d
AV
1284}
1285EXPORT_SYMBOL(iov_iter_gap_alignment);
1286
acbdeb83
AV
1287static struct page **get_pages_array(size_t n)
1288{
1289 return kvmalloc_array(n, sizeof(struct page *), GFP_KERNEL);
1290}
1291
241699cd 1292static ssize_t pipe_get_pages(struct iov_iter *i,
acbdeb83 1293 struct page ***pages, size_t maxsize, unsigned maxpages,
241699cd
AV
1294 size_t *start)
1295{
85200084 1296 struct pipe_inode_info *pipe = i->pipe;
12d426ab 1297 unsigned int npages, off;
acbdeb83 1298 struct page **p;
85200084
AV
1299 ssize_t left;
1300 int count;
241699cd
AV
1301
1302 if (!sanity(i))
1303 return -EFAULT;
1304
12d426ab 1305 *start = off = pipe_npages(i, &npages);
85200084
AV
1306 count = DIV_ROUND_UP(maxsize + off, PAGE_SIZE);
1307 if (count > npages)
1308 count = npages;
1309 if (count > maxpages)
1310 count = maxpages;
acbdeb83
AV
1311 p = *pages;
1312 if (!p) {
85200084 1313 *pages = p = get_pages_array(count);
acbdeb83
AV
1314 if (!p)
1315 return -ENOMEM;
1316 }
241699cd 1317
85200084
AV
1318 left = maxsize;
1319 npages = 0;
1320 if (off) {
1321 struct pipe_buffer *buf = pipe_buf(pipe, pipe->head - 1);
1322
1323 get_page(*p++ = buf->page);
1324 left -= PAGE_SIZE - off;
1325 if (left <= 0) {
1326 buf->len += maxsize;
1327 return maxsize;
1328 }
1329 buf->len = PAGE_SIZE;
1330 npages = 1;
1331 }
1332 for ( ; npages < count; npages++) {
1333 struct page *page;
1334 unsigned int size = min_t(ssize_t, left, PAGE_SIZE);
1335
1336 if (pipe_full(pipe->head, pipe->tail, pipe->max_usage))
1337 break;
1338 page = push_anon(pipe, size);
1339 if (!page)
1340 break;
1341 get_page(*p++ = page);
1342 left -= size;
1343 }
1344 if (!npages)
1345 return -EFAULT;
1346 return maxsize - left;
241699cd
AV
1347}
1348
7ff50620
DH
1349static ssize_t iter_xarray_populate_pages(struct page **pages, struct xarray *xa,
1350 pgoff_t index, unsigned int nr_pages)
1351{
1352 XA_STATE(xas, xa, index);
1353 struct page *page;
1354 unsigned int ret = 0;
1355
1356 rcu_read_lock();
1357 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
1358 if (xas_retry(&xas, page))
1359 continue;
1360
1361 /* Has the page moved or been split? */
1362 if (unlikely(page != xas_reload(&xas))) {
1363 xas_reset(&xas);
1364 continue;
1365 }
1366
1367 pages[ret] = find_subpage(page, xas.xa_index);
1368 get_page(pages[ret]);
1369 if (++ret == nr_pages)
1370 break;
1371 }
1372 rcu_read_unlock();
1373 return ret;
1374}
1375
1376static ssize_t iter_xarray_get_pages(struct iov_iter *i,
68fe506f 1377 struct page ***pages, size_t maxsize,
7ff50620
DH
1378 unsigned maxpages, size_t *_start_offset)
1379{
1380 unsigned nr, offset;
1381 pgoff_t index, count;
6c776766 1382 size_t size = maxsize;
7ff50620
DH
1383 loff_t pos;
1384
7ff50620
DH
1385 pos = i->xarray_start + i->iov_offset;
1386 index = pos >> PAGE_SHIFT;
1387 offset = pos & ~PAGE_MASK;
1388 *_start_offset = offset;
1389
0aa4fc32 1390 count = DIV_ROUND_UP(size + offset, PAGE_SIZE);
7ff50620
DH
1391 if (count > maxpages)
1392 count = maxpages;
1393
68fe506f
AV
1394 if (!*pages) {
1395 *pages = get_pages_array(count);
1396 if (!*pages)
1397 return -ENOMEM;
1398 }
1399
1400 nr = iter_xarray_populate_pages(*pages, i->xarray, index, count);
7ff50620
DH
1401 if (nr == 0)
1402 return 0;
1403
1c27f1fc 1404 return min_t(size_t, nr * PAGE_SIZE - offset, maxsize);
7ff50620
DH
1405}
1406
fcb14cb1 1407/* must be done on non-empty ITER_UBUF or ITER_IOVEC one */
dd45ab9d 1408static unsigned long first_iovec_segment(const struct iov_iter *i, size_t *size)
3d671ca6
AV
1409{
1410 size_t skip;
1411 long k;
1412
fcb14cb1
AV
1413 if (iter_is_ubuf(i))
1414 return (unsigned long)i->ubuf + i->iov_offset;
1415
3d671ca6 1416 for (k = 0, skip = i->iov_offset; k < i->nr_segs; k++, skip = 0) {
3d671ca6
AV
1417 size_t len = i->iov[k].iov_len - skip;
1418
1419 if (unlikely(!len))
1420 continue;
59dbd7d0
AV
1421 if (*size > len)
1422 *size = len;
dd45ab9d 1423 return (unsigned long)i->iov[k].iov_base + skip;
3d671ca6
AV
1424 }
1425 BUG(); // if it had been empty, we wouldn't get called
1426}
1427
1428/* must be done on non-empty ITER_BVEC one */
1429static struct page *first_bvec_segment(const struct iov_iter *i,
59dbd7d0 1430 size_t *size, size_t *start)
3d671ca6
AV
1431{
1432 struct page *page;
1433 size_t skip = i->iov_offset, len;
1434
1435 len = i->bvec->bv_len - skip;
59dbd7d0
AV
1436 if (*size > len)
1437 *size = len;
3d671ca6
AV
1438 skip += i->bvec->bv_offset;
1439 page = i->bvec->bv_page + skip / PAGE_SIZE;
dda8e5d1 1440 *start = skip % PAGE_SIZE;
3d671ca6
AV
1441 return page;
1442}
1443
451c0ba9
AV
1444static ssize_t __iov_iter_get_pages_alloc(struct iov_iter *i,
1445 struct page ***pages, size_t maxsize,
1446 unsigned int maxpages, size_t *start)
62a8067a 1447{
3d671ca6
AV
1448 int n, res;
1449
e5393fae
AV
1450 if (maxsize > i->count)
1451 maxsize = i->count;
451c0ba9 1452 if (!maxsize)
3d671ca6 1453 return 0;
7392ed17
AV
1454 if (maxsize > MAX_RW_COUNT)
1455 maxsize = MAX_RW_COUNT;
e5393fae 1456
fcb14cb1 1457 if (likely(user_backed_iter(i))) {
3337ab08 1458 unsigned int gup_flags = 0;
3d671ca6 1459 unsigned long addr;
e5393fae 1460
3337ab08
AG
1461 if (iov_iter_rw(i) != WRITE)
1462 gup_flags |= FOLL_WRITE;
1463 if (i->nofault)
1464 gup_flags |= FOLL_NOFAULT;
1465
dd45ab9d
AV
1466 addr = first_iovec_segment(i, &maxsize);
1467 *start = addr % PAGE_SIZE;
1468 addr &= PAGE_MASK;
59dbd7d0 1469 n = DIV_ROUND_UP(maxsize + *start, PAGE_SIZE);
dda8e5d1
AV
1470 if (n > maxpages)
1471 n = maxpages;
451c0ba9
AV
1472 if (!*pages) {
1473 *pages = get_pages_array(n);
1474 if (!*pages)
1475 return -ENOMEM;
1476 }
1477 res = get_user_pages_fast(addr, n, gup_flags, *pages);
814a6674 1478 if (unlikely(res <= 0))
e5393fae 1479 return res;
59dbd7d0 1480 return min_t(size_t, maxsize, res * PAGE_SIZE - *start);
3d671ca6
AV
1481 }
1482 if (iov_iter_is_bvec(i)) {
451c0ba9 1483 struct page **p;
3d671ca6
AV
1484 struct page *page;
1485
59dbd7d0
AV
1486 page = first_bvec_segment(i, &maxsize, start);
1487 n = DIV_ROUND_UP(maxsize + *start, PAGE_SIZE);
dda8e5d1
AV
1488 if (n > maxpages)
1489 n = maxpages;
451c0ba9
AV
1490 p = *pages;
1491 if (!p) {
1492 *pages = p = get_pages_array(n);
1493 if (!p)
1494 return -ENOMEM;
1495 }
dda8e5d1 1496 for (int k = 0; k < n; k++)
451c0ba9 1497 get_page(*p++ = page++);
59dbd7d0 1498 return min_t(size_t, maxsize, n * PAGE_SIZE - *start);
3d671ca6
AV
1499 }
1500 if (iov_iter_is_pipe(i))
451c0ba9 1501 return pipe_get_pages(i, pages, maxsize, maxpages, start);
3d671ca6 1502 if (iov_iter_is_xarray(i))
451c0ba9 1503 return iter_xarray_get_pages(i, pages, maxsize, maxpages, start);
3d671ca6 1504 return -EFAULT;
62a8067a 1505}
62a8067a 1506
451c0ba9
AV
1507ssize_t iov_iter_get_pages(struct iov_iter *i,
1508 struct page **pages, size_t maxsize, unsigned maxpages,
62a8067a
AV
1509 size_t *start)
1510{
451c0ba9 1511 if (!maxpages)
3d671ca6 1512 return 0;
451c0ba9 1513 BUG_ON(!pages);
3d671ca6 1514
451c0ba9 1515 return __iov_iter_get_pages_alloc(i, &pages, maxsize, maxpages, start);
62a8067a 1516}
451c0ba9 1517EXPORT_SYMBOL(iov_iter_get_pages);
91329559
AV
1518
1519ssize_t iov_iter_get_pages_alloc(struct iov_iter *i,
1520 struct page ***pages, size_t maxsize,
1521 size_t *start)
1522{
1523 ssize_t len;
1524
1525 *pages = NULL;
1526
451c0ba9 1527 len = __iov_iter_get_pages_alloc(i, pages, maxsize, ~0U, start);
91329559
AV
1528 if (len <= 0) {
1529 kvfree(*pages);
1530 *pages = NULL;
1531 }
1532 return len;
1533}
62a8067a
AV
1534EXPORT_SYMBOL(iov_iter_get_pages_alloc);
1535
a604ec7e
AV
1536size_t csum_and_copy_from_iter(void *addr, size_t bytes, __wsum *csum,
1537 struct iov_iter *i)
1538{
a604ec7e 1539 __wsum sum, next;
a604ec7e 1540 sum = *csum;
9ea9ce04 1541 if (unlikely(iov_iter_is_pipe(i) || iov_iter_is_discard(i))) {
241699cd
AV
1542 WARN_ON(1);
1543 return 0;
1544 }
7baa5099
AV
1545 iterate_and_advance(i, bytes, base, len, off, ({
1546 next = csum_and_copy_from_user(base, addr + off, len);
2495bdcc 1547 sum = csum_block_add(sum, next, off);
7baa5099 1548 next ? 0 : len;
a604ec7e 1549 }), ({
7baa5099 1550 sum = csum_and_memcpy(addr + off, base, len, sum, off);
a604ec7e
AV
1551 })
1552 )
1553 *csum = sum;
1554 return bytes;
1555}
1556EXPORT_SYMBOL(csum_and_copy_from_iter);
1557
52cbd23a 1558size_t csum_and_copy_to_iter(const void *addr, size_t bytes, void *_csstate,
a604ec7e
AV
1559 struct iov_iter *i)
1560{
52cbd23a 1561 struct csum_state *csstate = _csstate;
a604ec7e 1562 __wsum sum, next;
78e1f386 1563
78e1f386 1564 if (unlikely(iov_iter_is_discard(i))) {
241699cd
AV
1565 WARN_ON(1); /* for now */
1566 return 0;
1567 }
6852df12
AV
1568
1569 sum = csum_shift(csstate->csum, csstate->off);
1570 if (unlikely(iov_iter_is_pipe(i)))
1571 bytes = csum_and_copy_to_pipe_iter(addr, bytes, i, &sum);
1572 else iterate_and_advance(i, bytes, base, len, off, ({
7baa5099 1573 next = csum_and_copy_to_user(addr + off, base, len);
2495bdcc 1574 sum = csum_block_add(sum, next, off);
7baa5099 1575 next ? 0 : len;
a604ec7e 1576 }), ({
7baa5099 1577 sum = csum_and_memcpy(base, addr + off, len, sum, off);
a604ec7e
AV
1578 })
1579 )
594e450b
AV
1580 csstate->csum = csum_shift(sum, csstate->off);
1581 csstate->off += bytes;
a604ec7e
AV
1582 return bytes;
1583}
1584EXPORT_SYMBOL(csum_and_copy_to_iter);
1585
d05f4435
SG
1586size_t hash_and_copy_to_iter(const void *addr, size_t bytes, void *hashp,
1587 struct iov_iter *i)
1588{
7999096f 1589#ifdef CONFIG_CRYPTO_HASH
d05f4435
SG
1590 struct ahash_request *hash = hashp;
1591 struct scatterlist sg;
1592 size_t copied;
1593
1594 copied = copy_to_iter(addr, bytes, i);
1595 sg_init_one(&sg, addr, copied);
1596 ahash_request_set_crypt(hash, &sg, NULL, copied);
1597 crypto_ahash_update(hash);
1598 return copied;
27fad74a
Y
1599#else
1600 return 0;
1601#endif
d05f4435
SG
1602}
1603EXPORT_SYMBOL(hash_and_copy_to_iter);
1604
66531c65 1605static int iov_npages(const struct iov_iter *i, int maxpages)
62a8067a 1606{
66531c65
AV
1607 size_t skip = i->iov_offset, size = i->count;
1608 const struct iovec *p;
e0f2dc40
AV
1609 int npages = 0;
1610
66531c65
AV
1611 for (p = i->iov; size; skip = 0, p++) {
1612 unsigned offs = offset_in_page(p->iov_base + skip);
1613 size_t len = min(p->iov_len - skip, size);
e0f2dc40 1614
66531c65
AV
1615 if (len) {
1616 size -= len;
1617 npages += DIV_ROUND_UP(offs + len, PAGE_SIZE);
1618 if (unlikely(npages > maxpages))
1619 return maxpages;
1620 }
1621 }
1622 return npages;
1623}
1624
1625static int bvec_npages(const struct iov_iter *i, int maxpages)
1626{
1627 size_t skip = i->iov_offset, size = i->count;
1628 const struct bio_vec *p;
1629 int npages = 0;
1630
1631 for (p = i->bvec; size; skip = 0, p++) {
1632 unsigned offs = (p->bv_offset + skip) % PAGE_SIZE;
1633 size_t len = min(p->bv_len - skip, size);
1634
1635 size -= len;
1636 npages += DIV_ROUND_UP(offs + len, PAGE_SIZE);
1637 if (unlikely(npages > maxpages))
1638 return maxpages;
1639 }
1640 return npages;
1641}
1642
1643int iov_iter_npages(const struct iov_iter *i, int maxpages)
1644{
1645 if (unlikely(!i->count))
1646 return 0;
fcb14cb1
AV
1647 if (likely(iter_is_ubuf(i))) {
1648 unsigned offs = offset_in_page(i->ubuf + i->iov_offset);
1649 int npages = DIV_ROUND_UP(offs + i->count, PAGE_SIZE);
1650 return min(npages, maxpages);
1651 }
66531c65
AV
1652 /* iovec and kvec have identical layouts */
1653 if (likely(iter_is_iovec(i) || iov_iter_is_kvec(i)))
1654 return iov_npages(i, maxpages);
1655 if (iov_iter_is_bvec(i))
1656 return bvec_npages(i, maxpages);
1657 if (iov_iter_is_pipe(i)) {
66531c65 1658 int npages;
241699cd
AV
1659
1660 if (!sanity(i))
1661 return 0;
1662
12d426ab 1663 pipe_npages(i, &npages);
66531c65
AV
1664 return min(npages, maxpages);
1665 }
1666 if (iov_iter_is_xarray(i)) {
e4f8df86
AV
1667 unsigned offset = (i->xarray_start + i->iov_offset) % PAGE_SIZE;
1668 int npages = DIV_ROUND_UP(offset + i->count, PAGE_SIZE);
66531c65
AV
1669 return min(npages, maxpages);
1670 }
1671 return 0;
62a8067a 1672}
f67da30c 1673EXPORT_SYMBOL(iov_iter_npages);
4b8164b9
AV
1674
1675const void *dup_iter(struct iov_iter *new, struct iov_iter *old, gfp_t flags)
1676{
1677 *new = *old;
00e23707 1678 if (unlikely(iov_iter_is_pipe(new))) {
241699cd
AV
1679 WARN_ON(1);
1680 return NULL;
1681 }
00e23707 1682 if (iov_iter_is_bvec(new))
4b8164b9
AV
1683 return new->bvec = kmemdup(new->bvec,
1684 new->nr_segs * sizeof(struct bio_vec),
1685 flags);
fcb14cb1 1686 else if (iov_iter_is_kvec(new) || iter_is_iovec(new))
4b8164b9
AV
1687 /* iovec and kvec have identical layout */
1688 return new->iov = kmemdup(new->iov,
1689 new->nr_segs * sizeof(struct iovec),
1690 flags);
fcb14cb1 1691 return NULL;
4b8164b9
AV
1692}
1693EXPORT_SYMBOL(dup_iter);
bc917be8 1694
bfdc5970
CH
1695static int copy_compat_iovec_from_user(struct iovec *iov,
1696 const struct iovec __user *uvec, unsigned long nr_segs)
1697{
1698 const struct compat_iovec __user *uiov =
1699 (const struct compat_iovec __user *)uvec;
1700 int ret = -EFAULT, i;
1701
a959a978 1702 if (!user_access_begin(uiov, nr_segs * sizeof(*uiov)))
bfdc5970
CH
1703 return -EFAULT;
1704
1705 for (i = 0; i < nr_segs; i++) {
1706 compat_uptr_t buf;
1707 compat_ssize_t len;
1708
1709 unsafe_get_user(len, &uiov[i].iov_len, uaccess_end);
1710 unsafe_get_user(buf, &uiov[i].iov_base, uaccess_end);
1711
1712 /* check for compat_size_t not fitting in compat_ssize_t .. */
1713 if (len < 0) {
1714 ret = -EINVAL;
1715 goto uaccess_end;
1716 }
1717 iov[i].iov_base = compat_ptr(buf);
1718 iov[i].iov_len = len;
1719 }
1720
1721 ret = 0;
1722uaccess_end:
1723 user_access_end();
1724 return ret;
1725}
1726
1727static int copy_iovec_from_user(struct iovec *iov,
1728 const struct iovec __user *uvec, unsigned long nr_segs)
fb041b59
DL
1729{
1730 unsigned long seg;
fb041b59 1731
bfdc5970
CH
1732 if (copy_from_user(iov, uvec, nr_segs * sizeof(*uvec)))
1733 return -EFAULT;
1734 for (seg = 0; seg < nr_segs; seg++) {
1735 if ((ssize_t)iov[seg].iov_len < 0)
1736 return -EINVAL;
fb041b59
DL
1737 }
1738
bfdc5970
CH
1739 return 0;
1740}
1741
1742struct iovec *iovec_from_user(const struct iovec __user *uvec,
1743 unsigned long nr_segs, unsigned long fast_segs,
1744 struct iovec *fast_iov, bool compat)
1745{
1746 struct iovec *iov = fast_iov;
1747 int ret;
1748
fb041b59 1749 /*
bfdc5970
CH
1750 * SuS says "The readv() function *may* fail if the iovcnt argument was
1751 * less than or equal to 0, or greater than {IOV_MAX}. Linux has
1752 * traditionally returned zero for zero segments, so...
fb041b59 1753 */
bfdc5970
CH
1754 if (nr_segs == 0)
1755 return iov;
1756 if (nr_segs > UIO_MAXIOV)
1757 return ERR_PTR(-EINVAL);
fb041b59
DL
1758 if (nr_segs > fast_segs) {
1759 iov = kmalloc_array(nr_segs, sizeof(struct iovec), GFP_KERNEL);
bfdc5970
CH
1760 if (!iov)
1761 return ERR_PTR(-ENOMEM);
fb041b59 1762 }
bfdc5970
CH
1763
1764 if (compat)
1765 ret = copy_compat_iovec_from_user(iov, uvec, nr_segs);
1766 else
1767 ret = copy_iovec_from_user(iov, uvec, nr_segs);
1768 if (ret) {
1769 if (iov != fast_iov)
1770 kfree(iov);
1771 return ERR_PTR(ret);
1772 }
1773
1774 return iov;
1775}
1776
1777ssize_t __import_iovec(int type, const struct iovec __user *uvec,
1778 unsigned nr_segs, unsigned fast_segs, struct iovec **iovp,
1779 struct iov_iter *i, bool compat)
1780{
1781 ssize_t total_len = 0;
1782 unsigned long seg;
1783 struct iovec *iov;
1784
1785 iov = iovec_from_user(uvec, nr_segs, fast_segs, *iovp, compat);
1786 if (IS_ERR(iov)) {
1787 *iovp = NULL;
1788 return PTR_ERR(iov);
fb041b59
DL
1789 }
1790
1791 /*
bfdc5970
CH
1792 * According to the Single Unix Specification we should return EINVAL if
1793 * an element length is < 0 when cast to ssize_t or if the total length
1794 * would overflow the ssize_t return value of the system call.
fb041b59
DL
1795 *
1796 * Linux caps all read/write calls to MAX_RW_COUNT, and avoids the
1797 * overflow case.
1798 */
fb041b59 1799 for (seg = 0; seg < nr_segs; seg++) {
fb041b59
DL
1800 ssize_t len = (ssize_t)iov[seg].iov_len;
1801
bfdc5970
CH
1802 if (!access_ok(iov[seg].iov_base, len)) {
1803 if (iov != *iovp)
1804 kfree(iov);
1805 *iovp = NULL;
1806 return -EFAULT;
fb041b59 1807 }
bfdc5970
CH
1808
1809 if (len > MAX_RW_COUNT - total_len) {
1810 len = MAX_RW_COUNT - total_len;
fb041b59
DL
1811 iov[seg].iov_len = len;
1812 }
bfdc5970 1813 total_len += len;
fb041b59 1814 }
bfdc5970
CH
1815
1816 iov_iter_init(i, type, iov, nr_segs, total_len);
1817 if (iov == *iovp)
1818 *iovp = NULL;
1819 else
1820 *iovp = iov;
1821 return total_len;
fb041b59
DL
1822}
1823
ffecee4f
VN
1824/**
1825 * import_iovec() - Copy an array of &struct iovec from userspace
1826 * into the kernel, check that it is valid, and initialize a new
1827 * &struct iov_iter iterator to access it.
1828 *
1829 * @type: One of %READ or %WRITE.
bfdc5970 1830 * @uvec: Pointer to the userspace array.
ffecee4f
VN
1831 * @nr_segs: Number of elements in userspace array.
1832 * @fast_segs: Number of elements in @iov.
bfdc5970 1833 * @iovp: (input and output parameter) Pointer to pointer to (usually small
ffecee4f
VN
1834 * on-stack) kernel array.
1835 * @i: Pointer to iterator that will be initialized on success.
1836 *
1837 * If the array pointed to by *@iov is large enough to hold all @nr_segs,
1838 * then this function places %NULL in *@iov on return. Otherwise, a new
1839 * array will be allocated and the result placed in *@iov. This means that
1840 * the caller may call kfree() on *@iov regardless of whether the small
1841 * on-stack array was used or not (and regardless of whether this function
1842 * returns an error or not).
1843 *
87e5e6da 1844 * Return: Negative error code on error, bytes imported on success
ffecee4f 1845 */
bfdc5970 1846ssize_t import_iovec(int type, const struct iovec __user *uvec,
bc917be8 1847 unsigned nr_segs, unsigned fast_segs,
bfdc5970 1848 struct iovec **iovp, struct iov_iter *i)
bc917be8 1849{
89cd35c5
CH
1850 return __import_iovec(type, uvec, nr_segs, fast_segs, iovp, i,
1851 in_compat_syscall());
bc917be8
AV
1852}
1853EXPORT_SYMBOL(import_iovec);
1854
bc917be8
AV
1855int import_single_range(int rw, void __user *buf, size_t len,
1856 struct iovec *iov, struct iov_iter *i)
1857{
1858 if (len > MAX_RW_COUNT)
1859 len = MAX_RW_COUNT;
96d4f267 1860 if (unlikely(!access_ok(buf, len)))
bc917be8
AV
1861 return -EFAULT;
1862
1863 iov->iov_base = buf;
1864 iov->iov_len = len;
1865 iov_iter_init(i, rw, iov, 1, len);
1866 return 0;
1867}
e1267585 1868EXPORT_SYMBOL(import_single_range);
8fb0f47a
JA
1869
1870/**
1871 * iov_iter_restore() - Restore a &struct iov_iter to the same state as when
1872 * iov_iter_save_state() was called.
1873 *
1874 * @i: &struct iov_iter to restore
1875 * @state: state to restore from
1876 *
1877 * Used after iov_iter_save_state() to bring restore @i, if operations may
1878 * have advanced it.
1879 *
1880 * Note: only works on ITER_IOVEC, ITER_BVEC, and ITER_KVEC
1881 */
1882void iov_iter_restore(struct iov_iter *i, struct iov_iter_state *state)
1883{
1884 if (WARN_ON_ONCE(!iov_iter_is_bvec(i) && !iter_is_iovec(i)) &&
fcb14cb1 1885 !iov_iter_is_kvec(i) && !iter_is_ubuf(i))
8fb0f47a
JA
1886 return;
1887 i->iov_offset = state->iov_offset;
1888 i->count = state->count;
fcb14cb1
AV
1889 if (iter_is_ubuf(i))
1890 return;
8fb0f47a
JA
1891 /*
1892 * For the *vec iters, nr_segs + iov is constant - if we increment
1893 * the vec, then we also decrement the nr_segs count. Hence we don't
1894 * need to track both of these, just one is enough and we can deduct
1895 * the other from that. ITER_KVEC and ITER_IOVEC are the same struct
1896 * size, so we can just increment the iov pointer as they are unionzed.
1897 * ITER_BVEC _may_ be the same size on some archs, but on others it is
1898 * not. Be safe and handle it separately.
1899 */
1900 BUILD_BUG_ON(sizeof(struct iovec) != sizeof(struct kvec));
1901 if (iov_iter_is_bvec(i))
1902 i->bvec -= state->nr_segs - i->nr_segs;
1903 else
1904 i->iov -= state->nr_segs - i->nr_segs;
1905 i->nr_segs = state->nr_segs;
1906}