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