]>
Commit | Line | Data |
---|---|---|
5274f052 JA |
1 | /* |
2 | * "splice": joining two ropes together by interweaving their strands. | |
3 | * | |
4 | * This is the "extended pipe" functionality, where a pipe is used as | |
5 | * an arbitrary in-memory buffer. Think of a pipe as a small kernel | |
6 | * buffer that you can use to transfer data from one end to the other. | |
7 | * | |
8 | * The traditional unix read/write is extended with a "splice()" operation | |
9 | * that transfers data buffers to or from a pipe buffer. | |
10 | * | |
11 | * Named by Larry McVoy, original implementation from Linus, extended by | |
c2058e06 JA |
12 | * Jens to support splicing to files, network, direct splicing, etc and |
13 | * fixing lots of bugs. | |
5274f052 | 14 | * |
0fe23479 | 15 | * Copyright (C) 2005-2006 Jens Axboe <[email protected]> |
c2058e06 JA |
16 | * Copyright (C) 2005-2006 Linus Torvalds <[email protected]> |
17 | * Copyright (C) 2006 Ingo Molnar <[email protected]> | |
5274f052 JA |
18 | * |
19 | */ | |
20 | #include <linux/fs.h> | |
21 | #include <linux/file.h> | |
22 | #include <linux/pagemap.h> | |
d6b29d7c | 23 | #include <linux/splice.h> |
08e552c6 | 24 | #include <linux/memcontrol.h> |
5274f052 | 25 | #include <linux/mm_inline.h> |
5abc97aa | 26 | #include <linux/swap.h> |
4f6f0bd2 | 27 | #include <linux/writeback.h> |
630d9c47 | 28 | #include <linux/export.h> |
4f6f0bd2 | 29 | #include <linux/syscalls.h> |
912d35f8 | 30 | #include <linux/uio.h> |
29ce2058 | 31 | #include <linux/security.h> |
5a0e3ad6 | 32 | #include <linux/gfp.h> |
35f9c09f | 33 | #include <linux/socket.h> |
5274f052 | 34 | |
83f9135b JA |
35 | /* |
36 | * Attempt to steal a page from a pipe buffer. This should perhaps go into | |
37 | * a vm helper function, it's already simplified quite a bit by the | |
38 | * addition of remove_mapping(). If success is returned, the caller may | |
39 | * attempt to reuse this page for another destination. | |
40 | */ | |
76ad4d11 | 41 | static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe, |
5abc97aa JA |
42 | struct pipe_buffer *buf) |
43 | { | |
44 | struct page *page = buf->page; | |
9e94cd4f | 45 | struct address_space *mapping; |
5abc97aa | 46 | |
9e0267c2 JA |
47 | lock_page(page); |
48 | ||
9e94cd4f JA |
49 | mapping = page_mapping(page); |
50 | if (mapping) { | |
51 | WARN_ON(!PageUptodate(page)); | |
5abc97aa | 52 | |
9e94cd4f JA |
53 | /* |
54 | * At least for ext2 with nobh option, we need to wait on | |
55 | * writeback completing on this page, since we'll remove it | |
56 | * from the pagecache. Otherwise truncate wont wait on the | |
57 | * page, allowing the disk blocks to be reused by someone else | |
58 | * before we actually wrote our data to them. fs corruption | |
59 | * ensues. | |
60 | */ | |
61 | wait_on_page_writeback(page); | |
ad8d6f0a | 62 | |
266cf658 DH |
63 | if (page_has_private(page) && |
64 | !try_to_release_page(page, GFP_KERNEL)) | |
ca39d651 | 65 | goto out_unlock; |
4f6f0bd2 | 66 | |
9e94cd4f JA |
67 | /* |
68 | * If we succeeded in removing the mapping, set LRU flag | |
69 | * and return good. | |
70 | */ | |
71 | if (remove_mapping(mapping, page)) { | |
72 | buf->flags |= PIPE_BUF_FLAG_LRU; | |
73 | return 0; | |
74 | } | |
9e0267c2 | 75 | } |
5abc97aa | 76 | |
9e94cd4f JA |
77 | /* |
78 | * Raced with truncate or failed to remove page from current | |
79 | * address space, unlock and return failure. | |
80 | */ | |
ca39d651 | 81 | out_unlock: |
9e94cd4f JA |
82 | unlock_page(page); |
83 | return 1; | |
5abc97aa JA |
84 | } |
85 | ||
76ad4d11 | 86 | static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe, |
5274f052 JA |
87 | struct pipe_buffer *buf) |
88 | { | |
89 | page_cache_release(buf->page); | |
1432873a | 90 | buf->flags &= ~PIPE_BUF_FLAG_LRU; |
5274f052 JA |
91 | } |
92 | ||
0845718d JA |
93 | /* |
94 | * Check whether the contents of buf is OK to access. Since the content | |
95 | * is a page cache page, IO may be in flight. | |
96 | */ | |
cac36bb0 JA |
97 | static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe, |
98 | struct pipe_buffer *buf) | |
5274f052 JA |
99 | { |
100 | struct page *page = buf->page; | |
49d0b21b | 101 | int err; |
5274f052 JA |
102 | |
103 | if (!PageUptodate(page)) { | |
49d0b21b JA |
104 | lock_page(page); |
105 | ||
106 | /* | |
107 | * Page got truncated/unhashed. This will cause a 0-byte | |
73d62d83 | 108 | * splice, if this is the first page. |
49d0b21b JA |
109 | */ |
110 | if (!page->mapping) { | |
111 | err = -ENODATA; | |
112 | goto error; | |
113 | } | |
5274f052 | 114 | |
49d0b21b | 115 | /* |
73d62d83 | 116 | * Uh oh, read-error from disk. |
49d0b21b JA |
117 | */ |
118 | if (!PageUptodate(page)) { | |
119 | err = -EIO; | |
120 | goto error; | |
121 | } | |
122 | ||
123 | /* | |
f84d7519 | 124 | * Page is ok afterall, we are done. |
49d0b21b | 125 | */ |
5274f052 | 126 | unlock_page(page); |
5274f052 JA |
127 | } |
128 | ||
f84d7519 | 129 | return 0; |
49d0b21b JA |
130 | error: |
131 | unlock_page(page); | |
f84d7519 | 132 | return err; |
70524490 JA |
133 | } |
134 | ||
708e3508 | 135 | const struct pipe_buf_operations page_cache_pipe_buf_ops = { |
5274f052 | 136 | .can_merge = 0, |
f84d7519 JA |
137 | .map = generic_pipe_buf_map, |
138 | .unmap = generic_pipe_buf_unmap, | |
cac36bb0 | 139 | .confirm = page_cache_pipe_buf_confirm, |
5274f052 | 140 | .release = page_cache_pipe_buf_release, |
5abc97aa | 141 | .steal = page_cache_pipe_buf_steal, |
f84d7519 | 142 | .get = generic_pipe_buf_get, |
5274f052 JA |
143 | }; |
144 | ||
912d35f8 JA |
145 | static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe, |
146 | struct pipe_buffer *buf) | |
147 | { | |
7afa6fd0 JA |
148 | if (!(buf->flags & PIPE_BUF_FLAG_GIFT)) |
149 | return 1; | |
150 | ||
1432873a | 151 | buf->flags |= PIPE_BUF_FLAG_LRU; |
330ab716 | 152 | return generic_pipe_buf_steal(pipe, buf); |
912d35f8 JA |
153 | } |
154 | ||
d4c3cca9 | 155 | static const struct pipe_buf_operations user_page_pipe_buf_ops = { |
912d35f8 | 156 | .can_merge = 0, |
f84d7519 JA |
157 | .map = generic_pipe_buf_map, |
158 | .unmap = generic_pipe_buf_unmap, | |
cac36bb0 | 159 | .confirm = generic_pipe_buf_confirm, |
912d35f8 JA |
160 | .release = page_cache_pipe_buf_release, |
161 | .steal = user_page_pipe_buf_steal, | |
f84d7519 | 162 | .get = generic_pipe_buf_get, |
912d35f8 JA |
163 | }; |
164 | ||
825cdcb1 NK |
165 | static void wakeup_pipe_readers(struct pipe_inode_info *pipe) |
166 | { | |
167 | smp_mb(); | |
168 | if (waitqueue_active(&pipe->wait)) | |
169 | wake_up_interruptible(&pipe->wait); | |
170 | kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN); | |
171 | } | |
172 | ||
932cc6d4 JA |
173 | /** |
174 | * splice_to_pipe - fill passed data into a pipe | |
175 | * @pipe: pipe to fill | |
176 | * @spd: data to fill | |
177 | * | |
178 | * Description: | |
79685b8d | 179 | * @spd contains a map of pages and len/offset tuples, along with |
932cc6d4 JA |
180 | * the struct pipe_buf_operations associated with these pages. This |
181 | * function will link that data to the pipe. | |
182 | * | |
83f9135b | 183 | */ |
d6b29d7c JA |
184 | ssize_t splice_to_pipe(struct pipe_inode_info *pipe, |
185 | struct splice_pipe_desc *spd) | |
5274f052 | 186 | { |
00de00bd | 187 | unsigned int spd_pages = spd->nr_pages; |
912d35f8 | 188 | int ret, do_wakeup, page_nr; |
5274f052 JA |
189 | |
190 | ret = 0; | |
191 | do_wakeup = 0; | |
912d35f8 | 192 | page_nr = 0; |
5274f052 | 193 | |
61e0d47c | 194 | pipe_lock(pipe); |
5274f052 | 195 | |
5274f052 | 196 | for (;;) { |
3a326a2c | 197 | if (!pipe->readers) { |
5274f052 JA |
198 | send_sig(SIGPIPE, current, 0); |
199 | if (!ret) | |
200 | ret = -EPIPE; | |
201 | break; | |
202 | } | |
203 | ||
35f3d14d JA |
204 | if (pipe->nrbufs < pipe->buffers) { |
205 | int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1); | |
3a326a2c | 206 | struct pipe_buffer *buf = pipe->bufs + newbuf; |
5274f052 | 207 | |
912d35f8 JA |
208 | buf->page = spd->pages[page_nr]; |
209 | buf->offset = spd->partial[page_nr].offset; | |
210 | buf->len = spd->partial[page_nr].len; | |
497f9625 | 211 | buf->private = spd->partial[page_nr].private; |
912d35f8 | 212 | buf->ops = spd->ops; |
7afa6fd0 JA |
213 | if (spd->flags & SPLICE_F_GIFT) |
214 | buf->flags |= PIPE_BUF_FLAG_GIFT; | |
215 | ||
6f767b04 | 216 | pipe->nrbufs++; |
912d35f8 JA |
217 | page_nr++; |
218 | ret += buf->len; | |
219 | ||
6f767b04 JA |
220 | if (pipe->inode) |
221 | do_wakeup = 1; | |
5274f052 | 222 | |
912d35f8 | 223 | if (!--spd->nr_pages) |
5274f052 | 224 | break; |
35f3d14d | 225 | if (pipe->nrbufs < pipe->buffers) |
5274f052 JA |
226 | continue; |
227 | ||
228 | break; | |
229 | } | |
230 | ||
912d35f8 | 231 | if (spd->flags & SPLICE_F_NONBLOCK) { |
29e35094 LT |
232 | if (!ret) |
233 | ret = -EAGAIN; | |
234 | break; | |
235 | } | |
236 | ||
5274f052 JA |
237 | if (signal_pending(current)) { |
238 | if (!ret) | |
239 | ret = -ERESTARTSYS; | |
240 | break; | |
241 | } | |
242 | ||
243 | if (do_wakeup) { | |
c0bd1f65 | 244 | smp_mb(); |
3a326a2c IM |
245 | if (waitqueue_active(&pipe->wait)) |
246 | wake_up_interruptible_sync(&pipe->wait); | |
247 | kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN); | |
5274f052 JA |
248 | do_wakeup = 0; |
249 | } | |
250 | ||
3a326a2c IM |
251 | pipe->waiting_writers++; |
252 | pipe_wait(pipe); | |
253 | pipe->waiting_writers--; | |
5274f052 JA |
254 | } |
255 | ||
61e0d47c | 256 | pipe_unlock(pipe); |
5274f052 | 257 | |
825cdcb1 NK |
258 | if (do_wakeup) |
259 | wakeup_pipe_readers(pipe); | |
5274f052 | 260 | |
00de00bd | 261 | while (page_nr < spd_pages) |
bbdfc2f7 | 262 | spd->spd_release(spd, page_nr++); |
5274f052 JA |
263 | |
264 | return ret; | |
265 | } | |
266 | ||
708e3508 | 267 | void spd_release_page(struct splice_pipe_desc *spd, unsigned int i) |
bbdfc2f7 JA |
268 | { |
269 | page_cache_release(spd->pages[i]); | |
270 | } | |
271 | ||
35f3d14d JA |
272 | /* |
273 | * Check if we need to grow the arrays holding pages and partial page | |
274 | * descriptions. | |
275 | */ | |
047fe360 | 276 | int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd) |
35f3d14d | 277 | { |
047fe360 ED |
278 | unsigned int buffers = ACCESS_ONCE(pipe->buffers); |
279 | ||
280 | spd->nr_pages_max = buffers; | |
281 | if (buffers <= PIPE_DEF_BUFFERS) | |
35f3d14d JA |
282 | return 0; |
283 | ||
047fe360 ED |
284 | spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL); |
285 | spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL); | |
35f3d14d JA |
286 | |
287 | if (spd->pages && spd->partial) | |
288 | return 0; | |
289 | ||
290 | kfree(spd->pages); | |
291 | kfree(spd->partial); | |
292 | return -ENOMEM; | |
293 | } | |
294 | ||
047fe360 | 295 | void splice_shrink_spd(struct splice_pipe_desc *spd) |
35f3d14d | 296 | { |
047fe360 | 297 | if (spd->nr_pages_max <= PIPE_DEF_BUFFERS) |
35f3d14d JA |
298 | return; |
299 | ||
300 | kfree(spd->pages); | |
301 | kfree(spd->partial); | |
302 | } | |
303 | ||
3a326a2c | 304 | static int |
cbb7e577 JA |
305 | __generic_file_splice_read(struct file *in, loff_t *ppos, |
306 | struct pipe_inode_info *pipe, size_t len, | |
307 | unsigned int flags) | |
5274f052 JA |
308 | { |
309 | struct address_space *mapping = in->f_mapping; | |
d8983910 | 310 | unsigned int loff, nr_pages, req_pages; |
35f3d14d JA |
311 | struct page *pages[PIPE_DEF_BUFFERS]; |
312 | struct partial_page partial[PIPE_DEF_BUFFERS]; | |
5274f052 | 313 | struct page *page; |
91ad66ef JA |
314 | pgoff_t index, end_index; |
315 | loff_t isize; | |
eb20796b | 316 | int error, page_nr; |
912d35f8 JA |
317 | struct splice_pipe_desc spd = { |
318 | .pages = pages, | |
319 | .partial = partial, | |
047fe360 | 320 | .nr_pages_max = PIPE_DEF_BUFFERS, |
912d35f8 JA |
321 | .flags = flags, |
322 | .ops = &page_cache_pipe_buf_ops, | |
bbdfc2f7 | 323 | .spd_release = spd_release_page, |
912d35f8 | 324 | }; |
5274f052 | 325 | |
35f3d14d JA |
326 | if (splice_grow_spd(pipe, &spd)) |
327 | return -ENOMEM; | |
328 | ||
cbb7e577 | 329 | index = *ppos >> PAGE_CACHE_SHIFT; |
912d35f8 | 330 | loff = *ppos & ~PAGE_CACHE_MASK; |
d8983910 | 331 | req_pages = (len + loff + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT; |
047fe360 | 332 | nr_pages = min(req_pages, spd.nr_pages_max); |
5274f052 | 333 | |
eb20796b JA |
334 | /* |
335 | * Lookup the (hopefully) full range of pages we need. | |
336 | */ | |
35f3d14d | 337 | spd.nr_pages = find_get_pages_contig(mapping, index, nr_pages, spd.pages); |
431a4820 | 338 | index += spd.nr_pages; |
82aa5d61 | 339 | |
eb20796b JA |
340 | /* |
341 | * If find_get_pages_contig() returned fewer pages than we needed, | |
431a4820 | 342 | * readahead/allocate the rest and fill in the holes. |
eb20796b | 343 | */ |
431a4820 | 344 | if (spd.nr_pages < nr_pages) |
cf914a7d RR |
345 | page_cache_sync_readahead(mapping, &in->f_ra, in, |
346 | index, req_pages - spd.nr_pages); | |
431a4820 | 347 | |
932cc6d4 | 348 | error = 0; |
eb20796b | 349 | while (spd.nr_pages < nr_pages) { |
82aa5d61 | 350 | /* |
eb20796b JA |
351 | * Page could be there, find_get_pages_contig() breaks on |
352 | * the first hole. | |
5274f052 | 353 | */ |
7480a904 JA |
354 | page = find_get_page(mapping, index); |
355 | if (!page) { | |
7480a904 | 356 | /* |
eb20796b | 357 | * page didn't exist, allocate one. |
7480a904 JA |
358 | */ |
359 | page = page_cache_alloc_cold(mapping); | |
360 | if (!page) | |
361 | break; | |
362 | ||
363 | error = add_to_page_cache_lru(page, mapping, index, | |
0ae0b5d0 | 364 | GFP_KERNEL); |
7480a904 JA |
365 | if (unlikely(error)) { |
366 | page_cache_release(page); | |
a0548871 JA |
367 | if (error == -EEXIST) |
368 | continue; | |
7480a904 JA |
369 | break; |
370 | } | |
eb20796b JA |
371 | /* |
372 | * add_to_page_cache() locks the page, unlock it | |
373 | * to avoid convoluting the logic below even more. | |
374 | */ | |
375 | unlock_page(page); | |
7480a904 JA |
376 | } |
377 | ||
35f3d14d | 378 | spd.pages[spd.nr_pages++] = page; |
eb20796b JA |
379 | index++; |
380 | } | |
381 | ||
382 | /* | |
383 | * Now loop over the map and see if we need to start IO on any | |
384 | * pages, fill in the partial map, etc. | |
385 | */ | |
386 | index = *ppos >> PAGE_CACHE_SHIFT; | |
387 | nr_pages = spd.nr_pages; | |
388 | spd.nr_pages = 0; | |
389 | for (page_nr = 0; page_nr < nr_pages; page_nr++) { | |
390 | unsigned int this_len; | |
391 | ||
392 | if (!len) | |
393 | break; | |
394 | ||
395 | /* | |
396 | * this_len is the max we'll use from this page | |
397 | */ | |
398 | this_len = min_t(unsigned long, len, PAGE_CACHE_SIZE - loff); | |
35f3d14d | 399 | page = spd.pages[page_nr]; |
eb20796b | 400 | |
a08a166f | 401 | if (PageReadahead(page)) |
cf914a7d | 402 | page_cache_async_readahead(mapping, &in->f_ra, in, |
d8983910 | 403 | page, index, req_pages - page_nr); |
a08a166f | 404 | |
7480a904 JA |
405 | /* |
406 | * If the page isn't uptodate, we may need to start io on it | |
407 | */ | |
408 | if (!PageUptodate(page)) { | |
6965031d | 409 | lock_page(page); |
7480a904 JA |
410 | |
411 | /* | |
32502b84 MS |
412 | * Page was truncated, or invalidated by the |
413 | * filesystem. Redo the find/create, but this time the | |
414 | * page is kept locked, so there's no chance of another | |
415 | * race with truncate/invalidate. | |
7480a904 JA |
416 | */ |
417 | if (!page->mapping) { | |
418 | unlock_page(page); | |
32502b84 MS |
419 | page = find_or_create_page(mapping, index, |
420 | mapping_gfp_mask(mapping)); | |
421 | ||
422 | if (!page) { | |
423 | error = -ENOMEM; | |
424 | break; | |
425 | } | |
35f3d14d JA |
426 | page_cache_release(spd.pages[page_nr]); |
427 | spd.pages[page_nr] = page; | |
7480a904 JA |
428 | } |
429 | /* | |
430 | * page was already under io and is now done, great | |
431 | */ | |
432 | if (PageUptodate(page)) { | |
433 | unlock_page(page); | |
434 | goto fill_it; | |
435 | } | |
5274f052 | 436 | |
7480a904 JA |
437 | /* |
438 | * need to read in the page | |
439 | */ | |
440 | error = mapping->a_ops->readpage(in, page); | |
5274f052 | 441 | if (unlikely(error)) { |
eb20796b JA |
442 | /* |
443 | * We really should re-lookup the page here, | |
444 | * but it complicates things a lot. Instead | |
445 | * lets just do what we already stored, and | |
446 | * we'll get it the next time we are called. | |
447 | */ | |
7480a904 | 448 | if (error == AOP_TRUNCATED_PAGE) |
eb20796b JA |
449 | error = 0; |
450 | ||
5274f052 JA |
451 | break; |
452 | } | |
620a324b JA |
453 | } |
454 | fill_it: | |
455 | /* | |
456 | * i_size must be checked after PageUptodate. | |
457 | */ | |
458 | isize = i_size_read(mapping->host); | |
459 | end_index = (isize - 1) >> PAGE_CACHE_SHIFT; | |
460 | if (unlikely(!isize || index > end_index)) | |
461 | break; | |
462 | ||
463 | /* | |
464 | * if this is the last page, see if we need to shrink | |
465 | * the length and stop | |
466 | */ | |
467 | if (end_index == index) { | |
468 | unsigned int plen; | |
91ad66ef JA |
469 | |
470 | /* | |
620a324b | 471 | * max good bytes in this page |
91ad66ef | 472 | */ |
620a324b JA |
473 | plen = ((isize - 1) & ~PAGE_CACHE_MASK) + 1; |
474 | if (plen <= loff) | |
91ad66ef | 475 | break; |
91ad66ef JA |
476 | |
477 | /* | |
620a324b | 478 | * force quit after adding this page |
91ad66ef | 479 | */ |
620a324b JA |
480 | this_len = min(this_len, plen - loff); |
481 | len = this_len; | |
5274f052 | 482 | } |
620a324b | 483 | |
35f3d14d JA |
484 | spd.partial[page_nr].offset = loff; |
485 | spd.partial[page_nr].len = this_len; | |
82aa5d61 | 486 | len -= this_len; |
91ad66ef | 487 | loff = 0; |
eb20796b JA |
488 | spd.nr_pages++; |
489 | index++; | |
5274f052 JA |
490 | } |
491 | ||
eb20796b | 492 | /* |
475ecade | 493 | * Release any pages at the end, if we quit early. 'page_nr' is how far |
eb20796b JA |
494 | * we got, 'nr_pages' is how many pages are in the map. |
495 | */ | |
496 | while (page_nr < nr_pages) | |
35f3d14d | 497 | page_cache_release(spd.pages[page_nr++]); |
f4e6b498 | 498 | in->f_ra.prev_pos = (loff_t)index << PAGE_CACHE_SHIFT; |
eb20796b | 499 | |
912d35f8 | 500 | if (spd.nr_pages) |
35f3d14d | 501 | error = splice_to_pipe(pipe, &spd); |
5274f052 | 502 | |
047fe360 | 503 | splice_shrink_spd(&spd); |
7480a904 | 504 | return error; |
5274f052 JA |
505 | } |
506 | ||
83f9135b JA |
507 | /** |
508 | * generic_file_splice_read - splice data from file to a pipe | |
509 | * @in: file to splice from | |
932cc6d4 | 510 | * @ppos: position in @in |
83f9135b JA |
511 | * @pipe: pipe to splice to |
512 | * @len: number of bytes to splice | |
513 | * @flags: splice modifier flags | |
514 | * | |
932cc6d4 JA |
515 | * Description: |
516 | * Will read pages from given file and fill them into a pipe. Can be | |
517 | * used as long as the address_space operations for the source implements | |
518 | * a readpage() hook. | |
519 | * | |
83f9135b | 520 | */ |
cbb7e577 JA |
521 | ssize_t generic_file_splice_read(struct file *in, loff_t *ppos, |
522 | struct pipe_inode_info *pipe, size_t len, | |
523 | unsigned int flags) | |
5274f052 | 524 | { |
d366d398 | 525 | loff_t isize, left; |
8191ecd1 | 526 | int ret; |
d366d398 JA |
527 | |
528 | isize = i_size_read(in->f_mapping->host); | |
529 | if (unlikely(*ppos >= isize)) | |
530 | return 0; | |
531 | ||
532 | left = isize - *ppos; | |
533 | if (unlikely(left < len)) | |
534 | len = left; | |
5274f052 | 535 | |
8191ecd1 | 536 | ret = __generic_file_splice_read(in, ppos, pipe, len, flags); |
723590ed | 537 | if (ret > 0) { |
cbb7e577 | 538 | *ppos += ret; |
723590ed MS |
539 | file_accessed(in); |
540 | } | |
5274f052 JA |
541 | |
542 | return ret; | |
543 | } | |
059a8f37 JA |
544 | EXPORT_SYMBOL(generic_file_splice_read); |
545 | ||
6818173b MS |
546 | static const struct pipe_buf_operations default_pipe_buf_ops = { |
547 | .can_merge = 0, | |
548 | .map = generic_pipe_buf_map, | |
549 | .unmap = generic_pipe_buf_unmap, | |
550 | .confirm = generic_pipe_buf_confirm, | |
551 | .release = generic_pipe_buf_release, | |
552 | .steal = generic_pipe_buf_steal, | |
553 | .get = generic_pipe_buf_get, | |
554 | }; | |
555 | ||
556 | static ssize_t kernel_readv(struct file *file, const struct iovec *vec, | |
557 | unsigned long vlen, loff_t offset) | |
558 | { | |
559 | mm_segment_t old_fs; | |
560 | loff_t pos = offset; | |
561 | ssize_t res; | |
562 | ||
563 | old_fs = get_fs(); | |
564 | set_fs(get_ds()); | |
565 | /* The cast to a user pointer is valid due to the set_fs() */ | |
566 | res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos); | |
567 | set_fs(old_fs); | |
568 | ||
569 | return res; | |
570 | } | |
571 | ||
b2858d7d MS |
572 | static ssize_t kernel_write(struct file *file, const char *buf, size_t count, |
573 | loff_t pos) | |
0b0a47f5 MS |
574 | { |
575 | mm_segment_t old_fs; | |
576 | ssize_t res; | |
577 | ||
578 | old_fs = get_fs(); | |
579 | set_fs(get_ds()); | |
580 | /* The cast to a user pointer is valid due to the set_fs() */ | |
b2858d7d | 581 | res = vfs_write(file, (const char __user *)buf, count, &pos); |
0b0a47f5 MS |
582 | set_fs(old_fs); |
583 | ||
584 | return res; | |
585 | } | |
586 | ||
6818173b MS |
587 | ssize_t default_file_splice_read(struct file *in, loff_t *ppos, |
588 | struct pipe_inode_info *pipe, size_t len, | |
589 | unsigned int flags) | |
590 | { | |
591 | unsigned int nr_pages; | |
592 | unsigned int nr_freed; | |
593 | size_t offset; | |
35f3d14d JA |
594 | struct page *pages[PIPE_DEF_BUFFERS]; |
595 | struct partial_page partial[PIPE_DEF_BUFFERS]; | |
596 | struct iovec *vec, __vec[PIPE_DEF_BUFFERS]; | |
6818173b MS |
597 | ssize_t res; |
598 | size_t this_len; | |
599 | int error; | |
600 | int i; | |
601 | struct splice_pipe_desc spd = { | |
602 | .pages = pages, | |
603 | .partial = partial, | |
047fe360 | 604 | .nr_pages_max = PIPE_DEF_BUFFERS, |
6818173b MS |
605 | .flags = flags, |
606 | .ops = &default_pipe_buf_ops, | |
607 | .spd_release = spd_release_page, | |
608 | }; | |
609 | ||
35f3d14d JA |
610 | if (splice_grow_spd(pipe, &spd)) |
611 | return -ENOMEM; | |
612 | ||
613 | res = -ENOMEM; | |
614 | vec = __vec; | |
047fe360 ED |
615 | if (spd.nr_pages_max > PIPE_DEF_BUFFERS) { |
616 | vec = kmalloc(spd.nr_pages_max * sizeof(struct iovec), GFP_KERNEL); | |
35f3d14d JA |
617 | if (!vec) |
618 | goto shrink_ret; | |
619 | } | |
620 | ||
6818173b MS |
621 | offset = *ppos & ~PAGE_CACHE_MASK; |
622 | nr_pages = (len + offset + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT; | |
623 | ||
047fe360 | 624 | for (i = 0; i < nr_pages && i < spd.nr_pages_max && len; i++) { |
6818173b MS |
625 | struct page *page; |
626 | ||
4f231228 | 627 | page = alloc_page(GFP_USER); |
6818173b MS |
628 | error = -ENOMEM; |
629 | if (!page) | |
630 | goto err; | |
631 | ||
632 | this_len = min_t(size_t, len, PAGE_CACHE_SIZE - offset); | |
4f231228 | 633 | vec[i].iov_base = (void __user *) page_address(page); |
6818173b | 634 | vec[i].iov_len = this_len; |
35f3d14d | 635 | spd.pages[i] = page; |
6818173b MS |
636 | spd.nr_pages++; |
637 | len -= this_len; | |
638 | offset = 0; | |
639 | } | |
640 | ||
641 | res = kernel_readv(in, vec, spd.nr_pages, *ppos); | |
77f6bf57 AM |
642 | if (res < 0) { |
643 | error = res; | |
6818173b | 644 | goto err; |
77f6bf57 | 645 | } |
6818173b MS |
646 | |
647 | error = 0; | |
648 | if (!res) | |
649 | goto err; | |
650 | ||
651 | nr_freed = 0; | |
652 | for (i = 0; i < spd.nr_pages; i++) { | |
6818173b | 653 | this_len = min_t(size_t, vec[i].iov_len, res); |
35f3d14d JA |
654 | spd.partial[i].offset = 0; |
655 | spd.partial[i].len = this_len; | |
6818173b | 656 | if (!this_len) { |
35f3d14d JA |
657 | __free_page(spd.pages[i]); |
658 | spd.pages[i] = NULL; | |
6818173b MS |
659 | nr_freed++; |
660 | } | |
661 | res -= this_len; | |
662 | } | |
663 | spd.nr_pages -= nr_freed; | |
664 | ||
665 | res = splice_to_pipe(pipe, &spd); | |
666 | if (res > 0) | |
667 | *ppos += res; | |
668 | ||
35f3d14d JA |
669 | shrink_ret: |
670 | if (vec != __vec) | |
671 | kfree(vec); | |
047fe360 | 672 | splice_shrink_spd(&spd); |
6818173b MS |
673 | return res; |
674 | ||
675 | err: | |
4f231228 | 676 | for (i = 0; i < spd.nr_pages; i++) |
35f3d14d | 677 | __free_page(spd.pages[i]); |
4f231228 | 678 | |
35f3d14d JA |
679 | res = error; |
680 | goto shrink_ret; | |
6818173b MS |
681 | } |
682 | EXPORT_SYMBOL(default_file_splice_read); | |
683 | ||
5274f052 | 684 | /* |
4f6f0bd2 | 685 | * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos' |
016b661e | 686 | * using sendpage(). Return the number of bytes sent. |
5274f052 | 687 | */ |
76ad4d11 | 688 | static int pipe_to_sendpage(struct pipe_inode_info *pipe, |
5274f052 JA |
689 | struct pipe_buffer *buf, struct splice_desc *sd) |
690 | { | |
6a14b90b | 691 | struct file *file = sd->u.file; |
5274f052 | 692 | loff_t pos = sd->pos; |
a8adbe37 | 693 | int more; |
5274f052 | 694 | |
a8adbe37 MM |
695 | if (!likely(file->f_op && file->f_op->sendpage)) |
696 | return -EINVAL; | |
697 | ||
35f9c09f ED |
698 | more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0; |
699 | if (sd->len < sd->total_len) | |
700 | more |= MSG_SENDPAGE_NOTLAST; | |
a8adbe37 MM |
701 | return file->f_op->sendpage(file, buf->page, buf->offset, |
702 | sd->len, &pos, more); | |
5274f052 JA |
703 | } |
704 | ||
705 | /* | |
706 | * This is a little more tricky than the file -> pipe splicing. There are | |
707 | * basically three cases: | |
708 | * | |
709 | * - Destination page already exists in the address space and there | |
710 | * are users of it. For that case we have no other option that | |
711 | * copying the data. Tough luck. | |
712 | * - Destination page already exists in the address space, but there | |
713 | * are no users of it. Make sure it's uptodate, then drop it. Fall | |
714 | * through to last case. | |
715 | * - Destination page does not exist, we can add the pipe page to | |
716 | * the page cache and avoid the copy. | |
717 | * | |
83f9135b JA |
718 | * If asked to move pages to the output file (SPLICE_F_MOVE is set in |
719 | * sd->flags), we attempt to migrate pages from the pipe to the output | |
720 | * file address space page cache. This is possible if no one else has | |
721 | * the pipe page referenced outside of the pipe and page cache. If | |
722 | * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create | |
723 | * a new page in the output file page cache and fill/dirty that. | |
5274f052 | 724 | */ |
328eaaba MS |
725 | int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf, |
726 | struct splice_desc *sd) | |
5274f052 | 727 | { |
6a14b90b | 728 | struct file *file = sd->u.file; |
5274f052 | 729 | struct address_space *mapping = file->f_mapping; |
016b661e | 730 | unsigned int offset, this_len; |
5274f052 | 731 | struct page *page; |
afddba49 | 732 | void *fsdata; |
3e7ee3e7 | 733 | int ret; |
5274f052 | 734 | |
5274f052 JA |
735 | offset = sd->pos & ~PAGE_CACHE_MASK; |
736 | ||
016b661e JA |
737 | this_len = sd->len; |
738 | if (this_len + offset > PAGE_CACHE_SIZE) | |
739 | this_len = PAGE_CACHE_SIZE - offset; | |
740 | ||
afddba49 NP |
741 | ret = pagecache_write_begin(file, mapping, sd->pos, this_len, |
742 | AOP_FLAG_UNINTERRUPTIBLE, &page, &fsdata); | |
743 | if (unlikely(ret)) | |
744 | goto out; | |
5274f052 | 745 | |
0568b409 | 746 | if (buf->page != page) { |
76ad4d11 | 747 | char *src = buf->ops->map(pipe, buf, 1); |
e8e3c3d6 | 748 | char *dst = kmap_atomic(page); |
5abc97aa | 749 | |
016b661e | 750 | memcpy(dst + offset, src + buf->offset, this_len); |
5abc97aa | 751 | flush_dcache_page(page); |
e8e3c3d6 | 752 | kunmap_atomic(dst); |
76ad4d11 | 753 | buf->ops->unmap(pipe, buf, src); |
5abc97aa | 754 | } |
afddba49 NP |
755 | ret = pagecache_write_end(file, mapping, sd->pos, this_len, this_len, |
756 | page, fsdata); | |
5274f052 | 757 | out: |
5274f052 JA |
758 | return ret; |
759 | } | |
328eaaba | 760 | EXPORT_SYMBOL(pipe_to_file); |
5274f052 | 761 | |
b3c2d2dd MS |
762 | static void wakeup_pipe_writers(struct pipe_inode_info *pipe) |
763 | { | |
764 | smp_mb(); | |
765 | if (waitqueue_active(&pipe->wait)) | |
766 | wake_up_interruptible(&pipe->wait); | |
767 | kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT); | |
768 | } | |
769 | ||
932cc6d4 | 770 | /** |
b3c2d2dd | 771 | * splice_from_pipe_feed - feed available data from a pipe to a file |
932cc6d4 JA |
772 | * @pipe: pipe to splice from |
773 | * @sd: information to @actor | |
774 | * @actor: handler that splices the data | |
775 | * | |
776 | * Description: | |
b3c2d2dd MS |
777 | * This function loops over the pipe and calls @actor to do the |
778 | * actual moving of a single struct pipe_buffer to the desired | |
779 | * destination. It returns when there's no more buffers left in | |
780 | * the pipe or if the requested number of bytes (@sd->total_len) | |
781 | * have been copied. It returns a positive number (one) if the | |
782 | * pipe needs to be filled with more data, zero if the required | |
783 | * number of bytes have been copied and -errno on error. | |
932cc6d4 | 784 | * |
b3c2d2dd MS |
785 | * This, together with splice_from_pipe_{begin,end,next}, may be |
786 | * used to implement the functionality of __splice_from_pipe() when | |
787 | * locking is required around copying the pipe buffers to the | |
788 | * destination. | |
83f9135b | 789 | */ |
b3c2d2dd MS |
790 | int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd, |
791 | splice_actor *actor) | |
5274f052 | 792 | { |
b3c2d2dd | 793 | int ret; |
5274f052 | 794 | |
b3c2d2dd MS |
795 | while (pipe->nrbufs) { |
796 | struct pipe_buffer *buf = pipe->bufs + pipe->curbuf; | |
797 | const struct pipe_buf_operations *ops = buf->ops; | |
5274f052 | 798 | |
b3c2d2dd MS |
799 | sd->len = buf->len; |
800 | if (sd->len > sd->total_len) | |
801 | sd->len = sd->total_len; | |
5274f052 | 802 | |
a8adbe37 MM |
803 | ret = buf->ops->confirm(pipe, buf); |
804 | if (unlikely(ret)) { | |
b3c2d2dd MS |
805 | if (ret == -ENODATA) |
806 | ret = 0; | |
807 | return ret; | |
808 | } | |
a8adbe37 MM |
809 | |
810 | ret = actor(pipe, buf, sd); | |
811 | if (ret <= 0) | |
812 | return ret; | |
813 | ||
b3c2d2dd MS |
814 | buf->offset += ret; |
815 | buf->len -= ret; | |
816 | ||
817 | sd->num_spliced += ret; | |
818 | sd->len -= ret; | |
819 | sd->pos += ret; | |
820 | sd->total_len -= ret; | |
821 | ||
822 | if (!buf->len) { | |
823 | buf->ops = NULL; | |
824 | ops->release(pipe, buf); | |
35f3d14d | 825 | pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1); |
b3c2d2dd MS |
826 | pipe->nrbufs--; |
827 | if (pipe->inode) | |
828 | sd->need_wakeup = true; | |
829 | } | |
5274f052 | 830 | |
b3c2d2dd MS |
831 | if (!sd->total_len) |
832 | return 0; | |
833 | } | |
5274f052 | 834 | |
b3c2d2dd MS |
835 | return 1; |
836 | } | |
837 | EXPORT_SYMBOL(splice_from_pipe_feed); | |
5274f052 | 838 | |
b3c2d2dd MS |
839 | /** |
840 | * splice_from_pipe_next - wait for some data to splice from | |
841 | * @pipe: pipe to splice from | |
842 | * @sd: information about the splice operation | |
843 | * | |
844 | * Description: | |
845 | * This function will wait for some data and return a positive | |
846 | * value (one) if pipe buffers are available. It will return zero | |
847 | * or -errno if no more data needs to be spliced. | |
848 | */ | |
849 | int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd) | |
850 | { | |
851 | while (!pipe->nrbufs) { | |
852 | if (!pipe->writers) | |
853 | return 0; | |
016b661e | 854 | |
b3c2d2dd MS |
855 | if (!pipe->waiting_writers && sd->num_spliced) |
856 | return 0; | |
73d62d83 | 857 | |
b3c2d2dd MS |
858 | if (sd->flags & SPLICE_F_NONBLOCK) |
859 | return -EAGAIN; | |
5274f052 | 860 | |
b3c2d2dd MS |
861 | if (signal_pending(current)) |
862 | return -ERESTARTSYS; | |
5274f052 | 863 | |
b3c2d2dd MS |
864 | if (sd->need_wakeup) { |
865 | wakeup_pipe_writers(pipe); | |
866 | sd->need_wakeup = false; | |
5274f052 JA |
867 | } |
868 | ||
b3c2d2dd MS |
869 | pipe_wait(pipe); |
870 | } | |
29e35094 | 871 | |
b3c2d2dd MS |
872 | return 1; |
873 | } | |
874 | EXPORT_SYMBOL(splice_from_pipe_next); | |
5274f052 | 875 | |
b3c2d2dd MS |
876 | /** |
877 | * splice_from_pipe_begin - start splicing from pipe | |
b80901bb | 878 | * @sd: information about the splice operation |
b3c2d2dd MS |
879 | * |
880 | * Description: | |
881 | * This function should be called before a loop containing | |
882 | * splice_from_pipe_next() and splice_from_pipe_feed() to | |
883 | * initialize the necessary fields of @sd. | |
884 | */ | |
885 | void splice_from_pipe_begin(struct splice_desc *sd) | |
886 | { | |
887 | sd->num_spliced = 0; | |
888 | sd->need_wakeup = false; | |
889 | } | |
890 | EXPORT_SYMBOL(splice_from_pipe_begin); | |
5274f052 | 891 | |
b3c2d2dd MS |
892 | /** |
893 | * splice_from_pipe_end - finish splicing from pipe | |
894 | * @pipe: pipe to splice from | |
895 | * @sd: information about the splice operation | |
896 | * | |
897 | * Description: | |
898 | * This function will wake up pipe writers if necessary. It should | |
899 | * be called after a loop containing splice_from_pipe_next() and | |
900 | * splice_from_pipe_feed(). | |
901 | */ | |
902 | void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd) | |
903 | { | |
904 | if (sd->need_wakeup) | |
905 | wakeup_pipe_writers(pipe); | |
906 | } | |
907 | EXPORT_SYMBOL(splice_from_pipe_end); | |
5274f052 | 908 | |
b3c2d2dd MS |
909 | /** |
910 | * __splice_from_pipe - splice data from a pipe to given actor | |
911 | * @pipe: pipe to splice from | |
912 | * @sd: information to @actor | |
913 | * @actor: handler that splices the data | |
914 | * | |
915 | * Description: | |
916 | * This function does little more than loop over the pipe and call | |
917 | * @actor to do the actual moving of a single struct pipe_buffer to | |
918 | * the desired destination. See pipe_to_file, pipe_to_sendpage, or | |
919 | * pipe_to_user. | |
920 | * | |
921 | */ | |
922 | ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd, | |
923 | splice_actor *actor) | |
924 | { | |
925 | int ret; | |
5274f052 | 926 | |
b3c2d2dd MS |
927 | splice_from_pipe_begin(sd); |
928 | do { | |
929 | ret = splice_from_pipe_next(pipe, sd); | |
930 | if (ret > 0) | |
931 | ret = splice_from_pipe_feed(pipe, sd, actor); | |
932 | } while (ret > 0); | |
933 | splice_from_pipe_end(pipe, sd); | |
934 | ||
935 | return sd->num_spliced ? sd->num_spliced : ret; | |
5274f052 | 936 | } |
40bee44e | 937 | EXPORT_SYMBOL(__splice_from_pipe); |
5274f052 | 938 | |
932cc6d4 JA |
939 | /** |
940 | * splice_from_pipe - splice data from a pipe to a file | |
941 | * @pipe: pipe to splice from | |
942 | * @out: file to splice to | |
943 | * @ppos: position in @out | |
944 | * @len: how many bytes to splice | |
945 | * @flags: splice modifier flags | |
946 | * @actor: handler that splices the data | |
947 | * | |
948 | * Description: | |
2933970b | 949 | * See __splice_from_pipe. This function locks the pipe inode, |
932cc6d4 JA |
950 | * otherwise it's identical to __splice_from_pipe(). |
951 | * | |
952 | */ | |
6da61809 MF |
953 | ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out, |
954 | loff_t *ppos, size_t len, unsigned int flags, | |
955 | splice_actor *actor) | |
956 | { | |
957 | ssize_t ret; | |
c66ab6fa JA |
958 | struct splice_desc sd = { |
959 | .total_len = len, | |
960 | .flags = flags, | |
961 | .pos = *ppos, | |
6a14b90b | 962 | .u.file = out, |
c66ab6fa | 963 | }; |
6da61809 | 964 | |
61e0d47c | 965 | pipe_lock(pipe); |
c66ab6fa | 966 | ret = __splice_from_pipe(pipe, &sd, actor); |
61e0d47c | 967 | pipe_unlock(pipe); |
6da61809 MF |
968 | |
969 | return ret; | |
970 | } | |
971 | ||
83f9135b JA |
972 | /** |
973 | * generic_file_splice_write - splice data from a pipe to a file | |
3a326a2c | 974 | * @pipe: pipe info |
83f9135b | 975 | * @out: file to write to |
932cc6d4 | 976 | * @ppos: position in @out |
83f9135b JA |
977 | * @len: number of bytes to splice |
978 | * @flags: splice modifier flags | |
979 | * | |
932cc6d4 JA |
980 | * Description: |
981 | * Will either move or copy pages (determined by @flags options) from | |
982 | * the given pipe inode to the given file. | |
83f9135b JA |
983 | * |
984 | */ | |
3a326a2c IM |
985 | ssize_t |
986 | generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out, | |
cbb7e577 | 987 | loff_t *ppos, size_t len, unsigned int flags) |
5274f052 | 988 | { |
4f6f0bd2 | 989 | struct address_space *mapping = out->f_mapping; |
8c34e2d6 | 990 | struct inode *inode = mapping->host; |
7f3d4ee1 MS |
991 | struct splice_desc sd = { |
992 | .total_len = len, | |
993 | .flags = flags, | |
994 | .pos = *ppos, | |
995 | .u.file = out, | |
996 | }; | |
3a326a2c IM |
997 | ssize_t ret; |
998 | ||
14da9200 JK |
999 | sb_start_write(inode->i_sb); |
1000 | ||
61e0d47c | 1001 | pipe_lock(pipe); |
eb443e5a MS |
1002 | |
1003 | splice_from_pipe_begin(&sd); | |
1004 | do { | |
1005 | ret = splice_from_pipe_next(pipe, &sd); | |
1006 | if (ret <= 0) | |
1007 | break; | |
1008 | ||
1009 | mutex_lock_nested(&inode->i_mutex, I_MUTEX_CHILD); | |
1010 | ret = file_remove_suid(out); | |
723590ed | 1011 | if (!ret) { |
c3b2da31 JB |
1012 | ret = file_update_time(out); |
1013 | if (!ret) | |
1014 | ret = splice_from_pipe_feed(pipe, &sd, | |
1015 | pipe_to_file); | |
723590ed | 1016 | } |
eb443e5a MS |
1017 | mutex_unlock(&inode->i_mutex); |
1018 | } while (ret > 0); | |
1019 | splice_from_pipe_end(pipe, &sd); | |
1020 | ||
61e0d47c | 1021 | pipe_unlock(pipe); |
eb443e5a MS |
1022 | |
1023 | if (sd.num_spliced) | |
1024 | ret = sd.num_spliced; | |
1025 | ||
a4514ebd | 1026 | if (ret > 0) { |
17ee4f49 | 1027 | unsigned long nr_pages; |
148f948b | 1028 | int err; |
17ee4f49 | 1029 | |
17ee4f49 | 1030 | nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT; |
a4514ebd | 1031 | |
148f948b JK |
1032 | err = generic_write_sync(out, *ppos, ret); |
1033 | if (err) | |
1034 | ret = err; | |
1035 | else | |
1036 | *ppos += ret; | |
17ee4f49 | 1037 | balance_dirty_pages_ratelimited_nr(mapping, nr_pages); |
4f6f0bd2 | 1038 | } |
14da9200 | 1039 | sb_end_write(inode->i_sb); |
4f6f0bd2 JA |
1040 | |
1041 | return ret; | |
5274f052 JA |
1042 | } |
1043 | ||
059a8f37 JA |
1044 | EXPORT_SYMBOL(generic_file_splice_write); |
1045 | ||
b2858d7d MS |
1046 | static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf, |
1047 | struct splice_desc *sd) | |
0b0a47f5 | 1048 | { |
b2858d7d MS |
1049 | int ret; |
1050 | void *data; | |
1051 | ||
b2858d7d MS |
1052 | data = buf->ops->map(pipe, buf, 0); |
1053 | ret = kernel_write(sd->u.file, data + buf->offset, sd->len, sd->pos); | |
1054 | buf->ops->unmap(pipe, buf, data); | |
1055 | ||
1056 | return ret; | |
0b0a47f5 MS |
1057 | } |
1058 | ||
1059 | static ssize_t default_file_splice_write(struct pipe_inode_info *pipe, | |
1060 | struct file *out, loff_t *ppos, | |
1061 | size_t len, unsigned int flags) | |
1062 | { | |
b2858d7d | 1063 | ssize_t ret; |
0b0a47f5 | 1064 | |
b2858d7d MS |
1065 | ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf); |
1066 | if (ret > 0) | |
1067 | *ppos += ret; | |
0b0a47f5 | 1068 | |
b2858d7d | 1069 | return ret; |
0b0a47f5 MS |
1070 | } |
1071 | ||
83f9135b JA |
1072 | /** |
1073 | * generic_splice_sendpage - splice data from a pipe to a socket | |
932cc6d4 | 1074 | * @pipe: pipe to splice from |
83f9135b | 1075 | * @out: socket to write to |
932cc6d4 | 1076 | * @ppos: position in @out |
83f9135b JA |
1077 | * @len: number of bytes to splice |
1078 | * @flags: splice modifier flags | |
1079 | * | |
932cc6d4 JA |
1080 | * Description: |
1081 | * Will send @len bytes from the pipe to a network socket. No data copying | |
1082 | * is involved. | |
83f9135b JA |
1083 | * |
1084 | */ | |
3a326a2c | 1085 | ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out, |
cbb7e577 | 1086 | loff_t *ppos, size_t len, unsigned int flags) |
5274f052 | 1087 | { |
00522fb4 | 1088 | return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage); |
5274f052 JA |
1089 | } |
1090 | ||
059a8f37 | 1091 | EXPORT_SYMBOL(generic_splice_sendpage); |
a0f06780 | 1092 | |
83f9135b JA |
1093 | /* |
1094 | * Attempt to initiate a splice from pipe to file. | |
1095 | */ | |
3a326a2c | 1096 | static long do_splice_from(struct pipe_inode_info *pipe, struct file *out, |
cbb7e577 | 1097 | loff_t *ppos, size_t len, unsigned int flags) |
5274f052 | 1098 | { |
0b0a47f5 MS |
1099 | ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, |
1100 | loff_t *, size_t, unsigned int); | |
5274f052 JA |
1101 | int ret; |
1102 | ||
49570e9b | 1103 | if (unlikely(!(out->f_mode & FMODE_WRITE))) |
5274f052 JA |
1104 | return -EBADF; |
1105 | ||
efc968d4 LT |
1106 | if (unlikely(out->f_flags & O_APPEND)) |
1107 | return -EINVAL; | |
1108 | ||
cbb7e577 | 1109 | ret = rw_verify_area(WRITE, out, ppos, len); |
5274f052 JA |
1110 | if (unlikely(ret < 0)) |
1111 | return ret; | |
1112 | ||
cc56f7de CG |
1113 | if (out->f_op && out->f_op->splice_write) |
1114 | splice_write = out->f_op->splice_write; | |
1115 | else | |
0b0a47f5 MS |
1116 | splice_write = default_file_splice_write; |
1117 | ||
1118 | return splice_write(pipe, out, ppos, len, flags); | |
5274f052 JA |
1119 | } |
1120 | ||
83f9135b JA |
1121 | /* |
1122 | * Attempt to initiate a splice from a file to a pipe. | |
1123 | */ | |
cbb7e577 JA |
1124 | static long do_splice_to(struct file *in, loff_t *ppos, |
1125 | struct pipe_inode_info *pipe, size_t len, | |
1126 | unsigned int flags) | |
5274f052 | 1127 | { |
6818173b MS |
1128 | ssize_t (*splice_read)(struct file *, loff_t *, |
1129 | struct pipe_inode_info *, size_t, unsigned int); | |
5274f052 JA |
1130 | int ret; |
1131 | ||
49570e9b | 1132 | if (unlikely(!(in->f_mode & FMODE_READ))) |
5274f052 JA |
1133 | return -EBADF; |
1134 | ||
cbb7e577 | 1135 | ret = rw_verify_area(READ, in, ppos, len); |
5274f052 JA |
1136 | if (unlikely(ret < 0)) |
1137 | return ret; | |
1138 | ||
cc56f7de CG |
1139 | if (in->f_op && in->f_op->splice_read) |
1140 | splice_read = in->f_op->splice_read; | |
1141 | else | |
6818173b MS |
1142 | splice_read = default_file_splice_read; |
1143 | ||
1144 | return splice_read(in, ppos, pipe, len, flags); | |
5274f052 JA |
1145 | } |
1146 | ||
932cc6d4 JA |
1147 | /** |
1148 | * splice_direct_to_actor - splices data directly between two non-pipes | |
1149 | * @in: file to splice from | |
1150 | * @sd: actor information on where to splice to | |
1151 | * @actor: handles the data splicing | |
1152 | * | |
1153 | * Description: | |
1154 | * This is a special case helper to splice directly between two | |
1155 | * points, without requiring an explicit pipe. Internally an allocated | |
79685b8d | 1156 | * pipe is cached in the process, and reused during the lifetime of |
932cc6d4 JA |
1157 | * that process. |
1158 | * | |
c66ab6fa JA |
1159 | */ |
1160 | ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd, | |
1161 | splice_direct_actor *actor) | |
b92ce558 JA |
1162 | { |
1163 | struct pipe_inode_info *pipe; | |
1164 | long ret, bytes; | |
1165 | umode_t i_mode; | |
c66ab6fa JA |
1166 | size_t len; |
1167 | int i, flags; | |
b92ce558 JA |
1168 | |
1169 | /* | |
1170 | * We require the input being a regular file, as we don't want to | |
1171 | * randomly drop data for eg socket -> socket splicing. Use the | |
1172 | * piped splicing for that! | |
1173 | */ | |
0f7fc9e4 | 1174 | i_mode = in->f_path.dentry->d_inode->i_mode; |
b92ce558 JA |
1175 | if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode))) |
1176 | return -EINVAL; | |
1177 | ||
1178 | /* | |
1179 | * neither in nor out is a pipe, setup an internal pipe attached to | |
1180 | * 'out' and transfer the wanted data from 'in' to 'out' through that | |
1181 | */ | |
1182 | pipe = current->splice_pipe; | |
49570e9b | 1183 | if (unlikely(!pipe)) { |
b92ce558 JA |
1184 | pipe = alloc_pipe_info(NULL); |
1185 | if (!pipe) | |
1186 | return -ENOMEM; | |
1187 | ||
1188 | /* | |
1189 | * We don't have an immediate reader, but we'll read the stuff | |
00522fb4 | 1190 | * out of the pipe right after the splice_to_pipe(). So set |
b92ce558 JA |
1191 | * PIPE_READERS appropriately. |
1192 | */ | |
1193 | pipe->readers = 1; | |
1194 | ||
1195 | current->splice_pipe = pipe; | |
1196 | } | |
1197 | ||
1198 | /* | |
73d62d83 | 1199 | * Do the splice. |
b92ce558 JA |
1200 | */ |
1201 | ret = 0; | |
1202 | bytes = 0; | |
c66ab6fa JA |
1203 | len = sd->total_len; |
1204 | flags = sd->flags; | |
1205 | ||
1206 | /* | |
1207 | * Don't block on output, we have to drain the direct pipe. | |
1208 | */ | |
1209 | sd->flags &= ~SPLICE_F_NONBLOCK; | |
b92ce558 JA |
1210 | |
1211 | while (len) { | |
51a92c0f | 1212 | size_t read_len; |
a82c53a0 | 1213 | loff_t pos = sd->pos, prev_pos = pos; |
b92ce558 | 1214 | |
bcd4f3ac | 1215 | ret = do_splice_to(in, &pos, pipe, len, flags); |
51a92c0f | 1216 | if (unlikely(ret <= 0)) |
b92ce558 JA |
1217 | goto out_release; |
1218 | ||
1219 | read_len = ret; | |
c66ab6fa | 1220 | sd->total_len = read_len; |
b92ce558 JA |
1221 | |
1222 | /* | |
1223 | * NOTE: nonblocking mode only applies to the input. We | |
1224 | * must not do the output in nonblocking mode as then we | |
1225 | * could get stuck data in the internal pipe: | |
1226 | */ | |
c66ab6fa | 1227 | ret = actor(pipe, sd); |
a82c53a0 TZ |
1228 | if (unlikely(ret <= 0)) { |
1229 | sd->pos = prev_pos; | |
b92ce558 | 1230 | goto out_release; |
a82c53a0 | 1231 | } |
b92ce558 JA |
1232 | |
1233 | bytes += ret; | |
1234 | len -= ret; | |
bcd4f3ac | 1235 | sd->pos = pos; |
b92ce558 | 1236 | |
a82c53a0 TZ |
1237 | if (ret < read_len) { |
1238 | sd->pos = prev_pos + ret; | |
51a92c0f | 1239 | goto out_release; |
a82c53a0 | 1240 | } |
b92ce558 JA |
1241 | } |
1242 | ||
9e97198d | 1243 | done: |
b92ce558 | 1244 | pipe->nrbufs = pipe->curbuf = 0; |
80848708 | 1245 | file_accessed(in); |
b92ce558 JA |
1246 | return bytes; |
1247 | ||
1248 | out_release: | |
1249 | /* | |
1250 | * If we did an incomplete transfer we must release | |
1251 | * the pipe buffers in question: | |
1252 | */ | |
35f3d14d | 1253 | for (i = 0; i < pipe->buffers; i++) { |
b92ce558 JA |
1254 | struct pipe_buffer *buf = pipe->bufs + i; |
1255 | ||
1256 | if (buf->ops) { | |
1257 | buf->ops->release(pipe, buf); | |
1258 | buf->ops = NULL; | |
1259 | } | |
1260 | } | |
b92ce558 | 1261 | |
9e97198d JA |
1262 | if (!bytes) |
1263 | bytes = ret; | |
c66ab6fa | 1264 | |
9e97198d | 1265 | goto done; |
c66ab6fa JA |
1266 | } |
1267 | EXPORT_SYMBOL(splice_direct_to_actor); | |
1268 | ||
1269 | static int direct_splice_actor(struct pipe_inode_info *pipe, | |
1270 | struct splice_desc *sd) | |
1271 | { | |
6a14b90b | 1272 | struct file *file = sd->u.file; |
c66ab6fa | 1273 | |
2cb4b05e CG |
1274 | return do_splice_from(pipe, file, &file->f_pos, sd->total_len, |
1275 | sd->flags); | |
c66ab6fa JA |
1276 | } |
1277 | ||
932cc6d4 JA |
1278 | /** |
1279 | * do_splice_direct - splices data directly between two files | |
1280 | * @in: file to splice from | |
1281 | * @ppos: input file offset | |
1282 | * @out: file to splice to | |
1283 | * @len: number of bytes to splice | |
1284 | * @flags: splice modifier flags | |
1285 | * | |
1286 | * Description: | |
1287 | * For use by do_sendfile(). splice can easily emulate sendfile, but | |
1288 | * doing it in the application would incur an extra system call | |
1289 | * (splice in + splice out, as compared to just sendfile()). So this helper | |
1290 | * can splice directly through a process-private pipe. | |
1291 | * | |
1292 | */ | |
c66ab6fa JA |
1293 | long do_splice_direct(struct file *in, loff_t *ppos, struct file *out, |
1294 | size_t len, unsigned int flags) | |
1295 | { | |
1296 | struct splice_desc sd = { | |
1297 | .len = len, | |
1298 | .total_len = len, | |
1299 | .flags = flags, | |
1300 | .pos = *ppos, | |
6a14b90b | 1301 | .u.file = out, |
c66ab6fa | 1302 | }; |
51a92c0f | 1303 | long ret; |
c66ab6fa JA |
1304 | |
1305 | ret = splice_direct_to_actor(in, &sd, direct_splice_actor); | |
51a92c0f | 1306 | if (ret > 0) |
a82c53a0 | 1307 | *ppos = sd.pos; |
51a92c0f | 1308 | |
c66ab6fa | 1309 | return ret; |
b92ce558 JA |
1310 | } |
1311 | ||
7c77f0b3 MS |
1312 | static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe, |
1313 | struct pipe_inode_info *opipe, | |
1314 | size_t len, unsigned int flags); | |
ddac0d39 | 1315 | |
83f9135b JA |
1316 | /* |
1317 | * Determine where to splice to/from. | |
1318 | */ | |
529565dc IM |
1319 | static long do_splice(struct file *in, loff_t __user *off_in, |
1320 | struct file *out, loff_t __user *off_out, | |
1321 | size_t len, unsigned int flags) | |
5274f052 | 1322 | { |
7c77f0b3 MS |
1323 | struct pipe_inode_info *ipipe; |
1324 | struct pipe_inode_info *opipe; | |
cbb7e577 | 1325 | loff_t offset, *off; |
a4514ebd | 1326 | long ret; |
5274f052 | 1327 | |
71993e62 LT |
1328 | ipipe = get_pipe_info(in); |
1329 | opipe = get_pipe_info(out); | |
7c77f0b3 MS |
1330 | |
1331 | if (ipipe && opipe) { | |
1332 | if (off_in || off_out) | |
1333 | return -ESPIPE; | |
1334 | ||
1335 | if (!(in->f_mode & FMODE_READ)) | |
1336 | return -EBADF; | |
1337 | ||
1338 | if (!(out->f_mode & FMODE_WRITE)) | |
1339 | return -EBADF; | |
1340 | ||
1341 | /* Splicing to self would be fun, but... */ | |
1342 | if (ipipe == opipe) | |
1343 | return -EINVAL; | |
1344 | ||
1345 | return splice_pipe_to_pipe(ipipe, opipe, len, flags); | |
1346 | } | |
1347 | ||
1348 | if (ipipe) { | |
529565dc IM |
1349 | if (off_in) |
1350 | return -ESPIPE; | |
b92ce558 | 1351 | if (off_out) { |
19c9a49b | 1352 | if (!(out->f_mode & FMODE_PWRITE)) |
b92ce558 | 1353 | return -EINVAL; |
cbb7e577 | 1354 | if (copy_from_user(&offset, off_out, sizeof(loff_t))) |
b92ce558 | 1355 | return -EFAULT; |
cbb7e577 JA |
1356 | off = &offset; |
1357 | } else | |
1358 | off = &out->f_pos; | |
529565dc | 1359 | |
7c77f0b3 | 1360 | ret = do_splice_from(ipipe, out, off, len, flags); |
a4514ebd JA |
1361 | |
1362 | if (off_out && copy_to_user(off_out, off, sizeof(loff_t))) | |
1363 | ret = -EFAULT; | |
1364 | ||
1365 | return ret; | |
529565dc | 1366 | } |
5274f052 | 1367 | |
7c77f0b3 | 1368 | if (opipe) { |
529565dc IM |
1369 | if (off_out) |
1370 | return -ESPIPE; | |
b92ce558 | 1371 | if (off_in) { |
19c9a49b | 1372 | if (!(in->f_mode & FMODE_PREAD)) |
b92ce558 | 1373 | return -EINVAL; |
cbb7e577 | 1374 | if (copy_from_user(&offset, off_in, sizeof(loff_t))) |
b92ce558 | 1375 | return -EFAULT; |
cbb7e577 JA |
1376 | off = &offset; |
1377 | } else | |
1378 | off = &in->f_pos; | |
529565dc | 1379 | |
7c77f0b3 | 1380 | ret = do_splice_to(in, off, opipe, len, flags); |
a4514ebd JA |
1381 | |
1382 | if (off_in && copy_to_user(off_in, off, sizeof(loff_t))) | |
1383 | ret = -EFAULT; | |
1384 | ||
1385 | return ret; | |
529565dc | 1386 | } |
5274f052 JA |
1387 | |
1388 | return -EINVAL; | |
1389 | } | |
1390 | ||
912d35f8 JA |
1391 | /* |
1392 | * Map an iov into an array of pages and offset/length tupples. With the | |
1393 | * partial_page structure, we can map several non-contiguous ranges into | |
1394 | * our ones pages[] map instead of splitting that operation into pieces. | |
1395 | * Could easily be exported as a generic helper for other users, in which | |
1396 | * case one would probably want to add a 'max_nr_pages' parameter as well. | |
1397 | */ | |
1398 | static int get_iovec_page_array(const struct iovec __user *iov, | |
1399 | unsigned int nr_vecs, struct page **pages, | |
bd1a68b5 | 1400 | struct partial_page *partial, bool aligned, |
35f3d14d | 1401 | unsigned int pipe_buffers) |
912d35f8 JA |
1402 | { |
1403 | int buffers = 0, error = 0; | |
1404 | ||
912d35f8 JA |
1405 | while (nr_vecs) { |
1406 | unsigned long off, npages; | |
75723957 | 1407 | struct iovec entry; |
912d35f8 JA |
1408 | void __user *base; |
1409 | size_t len; | |
1410 | int i; | |
1411 | ||
75723957 | 1412 | error = -EFAULT; |
bc40d73c | 1413 | if (copy_from_user(&entry, iov, sizeof(entry))) |
912d35f8 JA |
1414 | break; |
1415 | ||
75723957 LT |
1416 | base = entry.iov_base; |
1417 | len = entry.iov_len; | |
1418 | ||
912d35f8 JA |
1419 | /* |
1420 | * Sanity check this iovec. 0 read succeeds. | |
1421 | */ | |
75723957 | 1422 | error = 0; |
912d35f8 JA |
1423 | if (unlikely(!len)) |
1424 | break; | |
1425 | error = -EFAULT; | |
712a30e6 | 1426 | if (!access_ok(VERIFY_READ, base, len)) |
912d35f8 JA |
1427 | break; |
1428 | ||
1429 | /* | |
1430 | * Get this base offset and number of pages, then map | |
1431 | * in the user pages. | |
1432 | */ | |
1433 | off = (unsigned long) base & ~PAGE_MASK; | |
7afa6fd0 JA |
1434 | |
1435 | /* | |
1436 | * If asked for alignment, the offset must be zero and the | |
1437 | * length a multiple of the PAGE_SIZE. | |
1438 | */ | |
1439 | error = -EINVAL; | |
1440 | if (aligned && (off || len & ~PAGE_MASK)) | |
1441 | break; | |
1442 | ||
912d35f8 | 1443 | npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT; |
35f3d14d JA |
1444 | if (npages > pipe_buffers - buffers) |
1445 | npages = pipe_buffers - buffers; | |
912d35f8 | 1446 | |
bc40d73c NP |
1447 | error = get_user_pages_fast((unsigned long)base, npages, |
1448 | 0, &pages[buffers]); | |
912d35f8 JA |
1449 | |
1450 | if (unlikely(error <= 0)) | |
1451 | break; | |
1452 | ||
1453 | /* | |
1454 | * Fill this contiguous range into the partial page map. | |
1455 | */ | |
1456 | for (i = 0; i < error; i++) { | |
7591489a | 1457 | const int plen = min_t(size_t, len, PAGE_SIZE - off); |
912d35f8 JA |
1458 | |
1459 | partial[buffers].offset = off; | |
1460 | partial[buffers].len = plen; | |
1461 | ||
1462 | off = 0; | |
1463 | len -= plen; | |
1464 | buffers++; | |
1465 | } | |
1466 | ||
1467 | /* | |
1468 | * We didn't complete this iov, stop here since it probably | |
1469 | * means we have to move some of this into a pipe to | |
1470 | * be able to continue. | |
1471 | */ | |
1472 | if (len) | |
1473 | break; | |
1474 | ||
1475 | /* | |
1476 | * Don't continue if we mapped fewer pages than we asked for, | |
1477 | * or if we mapped the max number of pages that we have | |
1478 | * room for. | |
1479 | */ | |
35f3d14d | 1480 | if (error < npages || buffers == pipe_buffers) |
912d35f8 JA |
1481 | break; |
1482 | ||
1483 | nr_vecs--; | |
1484 | iov++; | |
1485 | } | |
1486 | ||
912d35f8 JA |
1487 | if (buffers) |
1488 | return buffers; | |
1489 | ||
1490 | return error; | |
1491 | } | |
1492 | ||
6a14b90b JA |
1493 | static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf, |
1494 | struct splice_desc *sd) | |
1495 | { | |
1496 | char *src; | |
1497 | int ret; | |
1498 | ||
6a14b90b JA |
1499 | /* |
1500 | * See if we can use the atomic maps, by prefaulting in the | |
1501 | * pages and doing an atomic copy | |
1502 | */ | |
1503 | if (!fault_in_pages_writeable(sd->u.userptr, sd->len)) { | |
1504 | src = buf->ops->map(pipe, buf, 1); | |
1505 | ret = __copy_to_user_inatomic(sd->u.userptr, src + buf->offset, | |
1506 | sd->len); | |
1507 | buf->ops->unmap(pipe, buf, src); | |
1508 | if (!ret) { | |
1509 | ret = sd->len; | |
1510 | goto out; | |
1511 | } | |
1512 | } | |
1513 | ||
1514 | /* | |
1515 | * No dice, use slow non-atomic map and copy | |
1516 | */ | |
1517 | src = buf->ops->map(pipe, buf, 0); | |
1518 | ||
1519 | ret = sd->len; | |
1520 | if (copy_to_user(sd->u.userptr, src + buf->offset, sd->len)) | |
1521 | ret = -EFAULT; | |
1522 | ||
6866bef4 | 1523 | buf->ops->unmap(pipe, buf, src); |
6a14b90b JA |
1524 | out: |
1525 | if (ret > 0) | |
1526 | sd->u.userptr += ret; | |
6a14b90b JA |
1527 | return ret; |
1528 | } | |
1529 | ||
1530 | /* | |
1531 | * For lack of a better implementation, implement vmsplice() to userspace | |
1532 | * as a simple copy of the pipes pages to the user iov. | |
1533 | */ | |
1534 | static long vmsplice_to_user(struct file *file, const struct iovec __user *iov, | |
1535 | unsigned long nr_segs, unsigned int flags) | |
1536 | { | |
1537 | struct pipe_inode_info *pipe; | |
1538 | struct splice_desc sd; | |
1539 | ssize_t size; | |
1540 | int error; | |
1541 | long ret; | |
1542 | ||
71993e62 | 1543 | pipe = get_pipe_info(file); |
6a14b90b JA |
1544 | if (!pipe) |
1545 | return -EBADF; | |
1546 | ||
61e0d47c | 1547 | pipe_lock(pipe); |
6a14b90b JA |
1548 | |
1549 | error = ret = 0; | |
1550 | while (nr_segs) { | |
1551 | void __user *base; | |
1552 | size_t len; | |
1553 | ||
1554 | /* | |
1555 | * Get user address base and length for this iovec. | |
1556 | */ | |
1557 | error = get_user(base, &iov->iov_base); | |
1558 | if (unlikely(error)) | |
1559 | break; | |
1560 | error = get_user(len, &iov->iov_len); | |
1561 | if (unlikely(error)) | |
1562 | break; | |
1563 | ||
1564 | /* | |
1565 | * Sanity check this iovec. 0 read succeeds. | |
1566 | */ | |
1567 | if (unlikely(!len)) | |
1568 | break; | |
1569 | if (unlikely(!base)) { | |
1570 | error = -EFAULT; | |
1571 | break; | |
1572 | } | |
1573 | ||
8811930d JA |
1574 | if (unlikely(!access_ok(VERIFY_WRITE, base, len))) { |
1575 | error = -EFAULT; | |
1576 | break; | |
1577 | } | |
1578 | ||
6a14b90b JA |
1579 | sd.len = 0; |
1580 | sd.total_len = len; | |
1581 | sd.flags = flags; | |
1582 | sd.u.userptr = base; | |
1583 | sd.pos = 0; | |
1584 | ||
1585 | size = __splice_from_pipe(pipe, &sd, pipe_to_user); | |
1586 | if (size < 0) { | |
1587 | if (!ret) | |
1588 | ret = size; | |
1589 | ||
1590 | break; | |
1591 | } | |
1592 | ||
1593 | ret += size; | |
1594 | ||
1595 | if (size < len) | |
1596 | break; | |
1597 | ||
1598 | nr_segs--; | |
1599 | iov++; | |
1600 | } | |
1601 | ||
61e0d47c | 1602 | pipe_unlock(pipe); |
6a14b90b JA |
1603 | |
1604 | if (!ret) | |
1605 | ret = error; | |
1606 | ||
1607 | return ret; | |
1608 | } | |
1609 | ||
912d35f8 JA |
1610 | /* |
1611 | * vmsplice splices a user address range into a pipe. It can be thought of | |
1612 | * as splice-from-memory, where the regular splice is splice-from-file (or | |
1613 | * to file). In both cases the output is a pipe, naturally. | |
912d35f8 | 1614 | */ |
6a14b90b JA |
1615 | static long vmsplice_to_pipe(struct file *file, const struct iovec __user *iov, |
1616 | unsigned long nr_segs, unsigned int flags) | |
912d35f8 | 1617 | { |
ddac0d39 | 1618 | struct pipe_inode_info *pipe; |
35f3d14d JA |
1619 | struct page *pages[PIPE_DEF_BUFFERS]; |
1620 | struct partial_page partial[PIPE_DEF_BUFFERS]; | |
912d35f8 JA |
1621 | struct splice_pipe_desc spd = { |
1622 | .pages = pages, | |
1623 | .partial = partial, | |
047fe360 | 1624 | .nr_pages_max = PIPE_DEF_BUFFERS, |
912d35f8 JA |
1625 | .flags = flags, |
1626 | .ops = &user_page_pipe_buf_ops, | |
bbdfc2f7 | 1627 | .spd_release = spd_release_page, |
912d35f8 | 1628 | }; |
35f3d14d | 1629 | long ret; |
912d35f8 | 1630 | |
71993e62 | 1631 | pipe = get_pipe_info(file); |
ddac0d39 | 1632 | if (!pipe) |
912d35f8 | 1633 | return -EBADF; |
912d35f8 | 1634 | |
35f3d14d JA |
1635 | if (splice_grow_spd(pipe, &spd)) |
1636 | return -ENOMEM; | |
1637 | ||
1638 | spd.nr_pages = get_iovec_page_array(iov, nr_segs, spd.pages, | |
bd1a68b5 | 1639 | spd.partial, false, |
047fe360 | 1640 | spd.nr_pages_max); |
912d35f8 | 1641 | if (spd.nr_pages <= 0) |
35f3d14d JA |
1642 | ret = spd.nr_pages; |
1643 | else | |
1644 | ret = splice_to_pipe(pipe, &spd); | |
912d35f8 | 1645 | |
047fe360 | 1646 | splice_shrink_spd(&spd); |
35f3d14d | 1647 | return ret; |
912d35f8 JA |
1648 | } |
1649 | ||
6a14b90b JA |
1650 | /* |
1651 | * Note that vmsplice only really supports true splicing _from_ user memory | |
1652 | * to a pipe, not the other way around. Splicing from user memory is a simple | |
1653 | * operation that can be supported without any funky alignment restrictions | |
1654 | * or nasty vm tricks. We simply map in the user memory and fill them into | |
1655 | * a pipe. The reverse isn't quite as easy, though. There are two possible | |
1656 | * solutions for that: | |
1657 | * | |
1658 | * - memcpy() the data internally, at which point we might as well just | |
1659 | * do a regular read() on the buffer anyway. | |
1660 | * - Lots of nasty vm tricks, that are neither fast nor flexible (it | |
1661 | * has restriction limitations on both ends of the pipe). | |
1662 | * | |
1663 | * Currently we punt and implement it as a normal copy, see pipe_to_user(). | |
1664 | * | |
1665 | */ | |
836f92ad HC |
1666 | SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov, |
1667 | unsigned long, nr_segs, unsigned int, flags) | |
912d35f8 | 1668 | { |
2903ff01 | 1669 | struct fd f; |
912d35f8 | 1670 | long error; |
912d35f8 | 1671 | |
6a14b90b JA |
1672 | if (unlikely(nr_segs > UIO_MAXIOV)) |
1673 | return -EINVAL; | |
1674 | else if (unlikely(!nr_segs)) | |
1675 | return 0; | |
1676 | ||
912d35f8 | 1677 | error = -EBADF; |
2903ff01 AV |
1678 | f = fdget(fd); |
1679 | if (f.file) { | |
1680 | if (f.file->f_mode & FMODE_WRITE) | |
1681 | error = vmsplice_to_pipe(f.file, iov, nr_segs, flags); | |
1682 | else if (f.file->f_mode & FMODE_READ) | |
1683 | error = vmsplice_to_user(f.file, iov, nr_segs, flags); | |
1684 | ||
1685 | fdput(f); | |
912d35f8 JA |
1686 | } |
1687 | ||
1688 | return error; | |
1689 | } | |
1690 | ||
836f92ad HC |
1691 | SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in, |
1692 | int, fd_out, loff_t __user *, off_out, | |
1693 | size_t, len, unsigned int, flags) | |
5274f052 | 1694 | { |
2903ff01 | 1695 | struct fd in, out; |
5274f052 | 1696 | long error; |
5274f052 JA |
1697 | |
1698 | if (unlikely(!len)) | |
1699 | return 0; | |
1700 | ||
1701 | error = -EBADF; | |
2903ff01 AV |
1702 | in = fdget(fd_in); |
1703 | if (in.file) { | |
1704 | if (in.file->f_mode & FMODE_READ) { | |
1705 | out = fdget(fd_out); | |
1706 | if (out.file) { | |
1707 | if (out.file->f_mode & FMODE_WRITE) | |
1708 | error = do_splice(in.file, off_in, | |
1709 | out.file, off_out, | |
529565dc | 1710 | len, flags); |
2903ff01 | 1711 | fdput(out); |
5274f052 JA |
1712 | } |
1713 | } | |
2903ff01 | 1714 | fdput(in); |
5274f052 | 1715 | } |
5274f052 JA |
1716 | return error; |
1717 | } | |
70524490 | 1718 | |
aadd06e5 JA |
1719 | /* |
1720 | * Make sure there's data to read. Wait for input if we can, otherwise | |
1721 | * return an appropriate error. | |
1722 | */ | |
7c77f0b3 | 1723 | static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags) |
aadd06e5 JA |
1724 | { |
1725 | int ret; | |
1726 | ||
1727 | /* | |
1728 | * Check ->nrbufs without the inode lock first. This function | |
1729 | * is speculative anyways, so missing one is ok. | |
1730 | */ | |
1731 | if (pipe->nrbufs) | |
1732 | return 0; | |
1733 | ||
1734 | ret = 0; | |
61e0d47c | 1735 | pipe_lock(pipe); |
aadd06e5 JA |
1736 | |
1737 | while (!pipe->nrbufs) { | |
1738 | if (signal_pending(current)) { | |
1739 | ret = -ERESTARTSYS; | |
1740 | break; | |
1741 | } | |
1742 | if (!pipe->writers) | |
1743 | break; | |
1744 | if (!pipe->waiting_writers) { | |
1745 | if (flags & SPLICE_F_NONBLOCK) { | |
1746 | ret = -EAGAIN; | |
1747 | break; | |
1748 | } | |
1749 | } | |
1750 | pipe_wait(pipe); | |
1751 | } | |
1752 | ||
61e0d47c | 1753 | pipe_unlock(pipe); |
aadd06e5 JA |
1754 | return ret; |
1755 | } | |
1756 | ||
1757 | /* | |
1758 | * Make sure there's writeable room. Wait for room if we can, otherwise | |
1759 | * return an appropriate error. | |
1760 | */ | |
7c77f0b3 | 1761 | static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags) |
aadd06e5 JA |
1762 | { |
1763 | int ret; | |
1764 | ||
1765 | /* | |
1766 | * Check ->nrbufs without the inode lock first. This function | |
1767 | * is speculative anyways, so missing one is ok. | |
1768 | */ | |
35f3d14d | 1769 | if (pipe->nrbufs < pipe->buffers) |
aadd06e5 JA |
1770 | return 0; |
1771 | ||
1772 | ret = 0; | |
61e0d47c | 1773 | pipe_lock(pipe); |
aadd06e5 | 1774 | |
35f3d14d | 1775 | while (pipe->nrbufs >= pipe->buffers) { |
aadd06e5 JA |
1776 | if (!pipe->readers) { |
1777 | send_sig(SIGPIPE, current, 0); | |
1778 | ret = -EPIPE; | |
1779 | break; | |
1780 | } | |
1781 | if (flags & SPLICE_F_NONBLOCK) { | |
1782 | ret = -EAGAIN; | |
1783 | break; | |
1784 | } | |
1785 | if (signal_pending(current)) { | |
1786 | ret = -ERESTARTSYS; | |
1787 | break; | |
1788 | } | |
1789 | pipe->waiting_writers++; | |
1790 | pipe_wait(pipe); | |
1791 | pipe->waiting_writers--; | |
1792 | } | |
1793 | ||
61e0d47c | 1794 | pipe_unlock(pipe); |
aadd06e5 JA |
1795 | return ret; |
1796 | } | |
1797 | ||
7c77f0b3 MS |
1798 | /* |
1799 | * Splice contents of ipipe to opipe. | |
1800 | */ | |
1801 | static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe, | |
1802 | struct pipe_inode_info *opipe, | |
1803 | size_t len, unsigned int flags) | |
1804 | { | |
1805 | struct pipe_buffer *ibuf, *obuf; | |
1806 | int ret = 0, nbuf; | |
1807 | bool input_wakeup = false; | |
1808 | ||
1809 | ||
1810 | retry: | |
1811 | ret = ipipe_prep(ipipe, flags); | |
1812 | if (ret) | |
1813 | return ret; | |
1814 | ||
1815 | ret = opipe_prep(opipe, flags); | |
1816 | if (ret) | |
1817 | return ret; | |
1818 | ||
1819 | /* | |
1820 | * Potential ABBA deadlock, work around it by ordering lock | |
1821 | * grabbing by pipe info address. Otherwise two different processes | |
1822 | * could deadlock (one doing tee from A -> B, the other from B -> A). | |
1823 | */ | |
1824 | pipe_double_lock(ipipe, opipe); | |
1825 | ||
1826 | do { | |
1827 | if (!opipe->readers) { | |
1828 | send_sig(SIGPIPE, current, 0); | |
1829 | if (!ret) | |
1830 | ret = -EPIPE; | |
1831 | break; | |
1832 | } | |
1833 | ||
1834 | if (!ipipe->nrbufs && !ipipe->writers) | |
1835 | break; | |
1836 | ||
1837 | /* | |
1838 | * Cannot make any progress, because either the input | |
1839 | * pipe is empty or the output pipe is full. | |
1840 | */ | |
35f3d14d | 1841 | if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) { |
7c77f0b3 MS |
1842 | /* Already processed some buffers, break */ |
1843 | if (ret) | |
1844 | break; | |
1845 | ||
1846 | if (flags & SPLICE_F_NONBLOCK) { | |
1847 | ret = -EAGAIN; | |
1848 | break; | |
1849 | } | |
1850 | ||
1851 | /* | |
1852 | * We raced with another reader/writer and haven't | |
1853 | * managed to process any buffers. A zero return | |
1854 | * value means EOF, so retry instead. | |
1855 | */ | |
1856 | pipe_unlock(ipipe); | |
1857 | pipe_unlock(opipe); | |
1858 | goto retry; | |
1859 | } | |
1860 | ||
1861 | ibuf = ipipe->bufs + ipipe->curbuf; | |
35f3d14d | 1862 | nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1); |
7c77f0b3 MS |
1863 | obuf = opipe->bufs + nbuf; |
1864 | ||
1865 | if (len >= ibuf->len) { | |
1866 | /* | |
1867 | * Simply move the whole buffer from ipipe to opipe | |
1868 | */ | |
1869 | *obuf = *ibuf; | |
1870 | ibuf->ops = NULL; | |
1871 | opipe->nrbufs++; | |
35f3d14d | 1872 | ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1); |
7c77f0b3 MS |
1873 | ipipe->nrbufs--; |
1874 | input_wakeup = true; | |
1875 | } else { | |
1876 | /* | |
1877 | * Get a reference to this pipe buffer, | |
1878 | * so we can copy the contents over. | |
1879 | */ | |
1880 | ibuf->ops->get(ipipe, ibuf); | |
1881 | *obuf = *ibuf; | |
1882 | ||
1883 | /* | |
1884 | * Don't inherit the gift flag, we need to | |
1885 | * prevent multiple steals of this page. | |
1886 | */ | |
1887 | obuf->flags &= ~PIPE_BUF_FLAG_GIFT; | |
1888 | ||
1889 | obuf->len = len; | |
1890 | opipe->nrbufs++; | |
1891 | ibuf->offset += obuf->len; | |
1892 | ibuf->len -= obuf->len; | |
1893 | } | |
1894 | ret += obuf->len; | |
1895 | len -= obuf->len; | |
1896 | } while (len); | |
1897 | ||
1898 | pipe_unlock(ipipe); | |
1899 | pipe_unlock(opipe); | |
1900 | ||
1901 | /* | |
1902 | * If we put data in the output pipe, wakeup any potential readers. | |
1903 | */ | |
825cdcb1 NK |
1904 | if (ret > 0) |
1905 | wakeup_pipe_readers(opipe); | |
1906 | ||
7c77f0b3 MS |
1907 | if (input_wakeup) |
1908 | wakeup_pipe_writers(ipipe); | |
1909 | ||
1910 | return ret; | |
1911 | } | |
1912 | ||
70524490 JA |
1913 | /* |
1914 | * Link contents of ipipe to opipe. | |
1915 | */ | |
1916 | static int link_pipe(struct pipe_inode_info *ipipe, | |
1917 | struct pipe_inode_info *opipe, | |
1918 | size_t len, unsigned int flags) | |
1919 | { | |
1920 | struct pipe_buffer *ibuf, *obuf; | |
aadd06e5 | 1921 | int ret = 0, i = 0, nbuf; |
70524490 JA |
1922 | |
1923 | /* | |
1924 | * Potential ABBA deadlock, work around it by ordering lock | |
61e0d47c | 1925 | * grabbing by pipe info address. Otherwise two different processes |
70524490 JA |
1926 | * could deadlock (one doing tee from A -> B, the other from B -> A). |
1927 | */ | |
61e0d47c | 1928 | pipe_double_lock(ipipe, opipe); |
70524490 | 1929 | |
aadd06e5 | 1930 | do { |
70524490 JA |
1931 | if (!opipe->readers) { |
1932 | send_sig(SIGPIPE, current, 0); | |
1933 | if (!ret) | |
1934 | ret = -EPIPE; | |
1935 | break; | |
1936 | } | |
70524490 | 1937 | |
aadd06e5 JA |
1938 | /* |
1939 | * If we have iterated all input buffers or ran out of | |
1940 | * output room, break. | |
1941 | */ | |
35f3d14d | 1942 | if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) |
aadd06e5 | 1943 | break; |
70524490 | 1944 | |
35f3d14d JA |
1945 | ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1)); |
1946 | nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1); | |
70524490 JA |
1947 | |
1948 | /* | |
aadd06e5 JA |
1949 | * Get a reference to this pipe buffer, |
1950 | * so we can copy the contents over. | |
70524490 | 1951 | */ |
aadd06e5 JA |
1952 | ibuf->ops->get(ipipe, ibuf); |
1953 | ||
1954 | obuf = opipe->bufs + nbuf; | |
1955 | *obuf = *ibuf; | |
1956 | ||
2a27250e | 1957 | /* |
aadd06e5 JA |
1958 | * Don't inherit the gift flag, we need to |
1959 | * prevent multiple steals of this page. | |
2a27250e | 1960 | */ |
aadd06e5 | 1961 | obuf->flags &= ~PIPE_BUF_FLAG_GIFT; |
70524490 | 1962 | |
aadd06e5 JA |
1963 | if (obuf->len > len) |
1964 | obuf->len = len; | |
70524490 | 1965 | |
aadd06e5 JA |
1966 | opipe->nrbufs++; |
1967 | ret += obuf->len; | |
1968 | len -= obuf->len; | |
1969 | i++; | |
1970 | } while (len); | |
70524490 | 1971 | |
02cf01ae JA |
1972 | /* |
1973 | * return EAGAIN if we have the potential of some data in the | |
1974 | * future, otherwise just return 0 | |
1975 | */ | |
1976 | if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK)) | |
1977 | ret = -EAGAIN; | |
1978 | ||
61e0d47c MS |
1979 | pipe_unlock(ipipe); |
1980 | pipe_unlock(opipe); | |
70524490 | 1981 | |
aadd06e5 JA |
1982 | /* |
1983 | * If we put data in the output pipe, wakeup any potential readers. | |
1984 | */ | |
825cdcb1 NK |
1985 | if (ret > 0) |
1986 | wakeup_pipe_readers(opipe); | |
70524490 JA |
1987 | |
1988 | return ret; | |
1989 | } | |
1990 | ||
1991 | /* | |
1992 | * This is a tee(1) implementation that works on pipes. It doesn't copy | |
1993 | * any data, it simply references the 'in' pages on the 'out' pipe. | |
1994 | * The 'flags' used are the SPLICE_F_* variants, currently the only | |
1995 | * applicable one is SPLICE_F_NONBLOCK. | |
1996 | */ | |
1997 | static long do_tee(struct file *in, struct file *out, size_t len, | |
1998 | unsigned int flags) | |
1999 | { | |
71993e62 LT |
2000 | struct pipe_inode_info *ipipe = get_pipe_info(in); |
2001 | struct pipe_inode_info *opipe = get_pipe_info(out); | |
aadd06e5 | 2002 | int ret = -EINVAL; |
70524490 JA |
2003 | |
2004 | /* | |
aadd06e5 JA |
2005 | * Duplicate the contents of ipipe to opipe without actually |
2006 | * copying the data. | |
70524490 | 2007 | */ |
aadd06e5 JA |
2008 | if (ipipe && opipe && ipipe != opipe) { |
2009 | /* | |
2010 | * Keep going, unless we encounter an error. The ipipe/opipe | |
2011 | * ordering doesn't really matter. | |
2012 | */ | |
7c77f0b3 | 2013 | ret = ipipe_prep(ipipe, flags); |
aadd06e5 | 2014 | if (!ret) { |
7c77f0b3 | 2015 | ret = opipe_prep(opipe, flags); |
02cf01ae | 2016 | if (!ret) |
aadd06e5 | 2017 | ret = link_pipe(ipipe, opipe, len, flags); |
aadd06e5 JA |
2018 | } |
2019 | } | |
70524490 | 2020 | |
aadd06e5 | 2021 | return ret; |
70524490 JA |
2022 | } |
2023 | ||
836f92ad | 2024 | SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags) |
70524490 | 2025 | { |
2903ff01 AV |
2026 | struct fd in; |
2027 | int error; | |
70524490 JA |
2028 | |
2029 | if (unlikely(!len)) | |
2030 | return 0; | |
2031 | ||
2032 | error = -EBADF; | |
2903ff01 AV |
2033 | in = fdget(fdin); |
2034 | if (in.file) { | |
2035 | if (in.file->f_mode & FMODE_READ) { | |
2036 | struct fd out = fdget(fdout); | |
2037 | if (out.file) { | |
2038 | if (out.file->f_mode & FMODE_WRITE) | |
2039 | error = do_tee(in.file, out.file, | |
2040 | len, flags); | |
2041 | fdput(out); | |
70524490 JA |
2042 | } |
2043 | } | |
2903ff01 | 2044 | fdput(in); |
70524490 JA |
2045 | } |
2046 | ||
2047 | return error; | |
2048 | } |