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