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