splice: adjust balance_dirty_pages_ratelimited() call
[linux-block.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>
23#include <linux/pipe_fs_i.h>
24#include <linux/mm_inline.h>
5abc97aa 25#include <linux/swap.h>
4f6f0bd2
JA
26#include <linux/writeback.h>
27#include <linux/buffer_head.h>
a0f06780 28#include <linux/module.h>
4f6f0bd2 29#include <linux/syscalls.h>
912d35f8 30#include <linux/uio.h>
5274f052 31
912d35f8
JA
32struct partial_page {
33 unsigned int offset;
34 unsigned int len;
35};
36
37/*
00522fb4 38 * Passed to splice_to_pipe
912d35f8
JA
39 */
40struct splice_pipe_desc {
41 struct page **pages; /* page map */
42 struct partial_page *partial; /* pages[] may not be contig */
43 int nr_pages; /* number of pages in map */
44 unsigned int flags; /* splice flags */
d4c3cca9 45 const struct pipe_buf_operations *ops;/* ops associated with output pipe */
912d35f8
JA
46};
47
83f9135b
JA
48/*
49 * Attempt to steal a page from a pipe buffer. This should perhaps go into
50 * a vm helper function, it's already simplified quite a bit by the
51 * addition of remove_mapping(). If success is returned, the caller may
52 * attempt to reuse this page for another destination.
53 */
76ad4d11 54static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
5abc97aa
JA
55 struct pipe_buffer *buf)
56{
57 struct page *page = buf->page;
9e94cd4f 58 struct address_space *mapping;
5abc97aa 59
9e0267c2
JA
60 lock_page(page);
61
9e94cd4f
JA
62 mapping = page_mapping(page);
63 if (mapping) {
64 WARN_ON(!PageUptodate(page));
5abc97aa 65
9e94cd4f
JA
66 /*
67 * At least for ext2 with nobh option, we need to wait on
68 * writeback completing on this page, since we'll remove it
69 * from the pagecache. Otherwise truncate wont wait on the
70 * page, allowing the disk blocks to be reused by someone else
71 * before we actually wrote our data to them. fs corruption
72 * ensues.
73 */
74 wait_on_page_writeback(page);
ad8d6f0a 75
9e94cd4f 76 if (PagePrivate(page))
2ae88149 77 try_to_release_page(page, GFP_KERNEL);
4f6f0bd2 78
9e94cd4f
JA
79 /*
80 * If we succeeded in removing the mapping, set LRU flag
81 * and return good.
82 */
83 if (remove_mapping(mapping, page)) {
84 buf->flags |= PIPE_BUF_FLAG_LRU;
85 return 0;
86 }
9e0267c2 87 }
5abc97aa 88
9e94cd4f
JA
89 /*
90 * Raced with truncate or failed to remove page from current
91 * address space, unlock and return failure.
92 */
93 unlock_page(page);
94 return 1;
5abc97aa
JA
95}
96
76ad4d11 97static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
5274f052
JA
98 struct pipe_buffer *buf)
99{
100 page_cache_release(buf->page);
1432873a 101 buf->flags &= ~PIPE_BUF_FLAG_LRU;
5274f052
JA
102}
103
76ad4d11 104static int page_cache_pipe_buf_pin(struct pipe_inode_info *pipe,
f84d7519 105 struct pipe_buffer *buf)
5274f052
JA
106{
107 struct page *page = buf->page;
49d0b21b 108 int err;
5274f052
JA
109
110 if (!PageUptodate(page)) {
49d0b21b
JA
111 lock_page(page);
112
113 /*
114 * Page got truncated/unhashed. This will cause a 0-byte
73d62d83 115 * splice, if this is the first page.
49d0b21b
JA
116 */
117 if (!page->mapping) {
118 err = -ENODATA;
119 goto error;
120 }
5274f052 121
49d0b21b 122 /*
73d62d83 123 * Uh oh, read-error from disk.
49d0b21b
JA
124 */
125 if (!PageUptodate(page)) {
126 err = -EIO;
127 goto error;
128 }
129
130 /*
f84d7519 131 * Page is ok afterall, we are done.
49d0b21b 132 */
5274f052 133 unlock_page(page);
5274f052
JA
134 }
135
f84d7519 136 return 0;
49d0b21b
JA
137error:
138 unlock_page(page);
f84d7519 139 return err;
70524490
JA
140}
141
d4c3cca9 142static const struct pipe_buf_operations page_cache_pipe_buf_ops = {
5274f052 143 .can_merge = 0,
f84d7519
JA
144 .map = generic_pipe_buf_map,
145 .unmap = generic_pipe_buf_unmap,
146 .pin = page_cache_pipe_buf_pin,
5274f052 147 .release = page_cache_pipe_buf_release,
5abc97aa 148 .steal = page_cache_pipe_buf_steal,
f84d7519 149 .get = generic_pipe_buf_get,
5274f052
JA
150};
151
912d35f8
JA
152static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
153 struct pipe_buffer *buf)
154{
7afa6fd0
JA
155 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
156 return 1;
157
1432873a 158 buf->flags |= PIPE_BUF_FLAG_LRU;
330ab716 159 return generic_pipe_buf_steal(pipe, buf);
912d35f8
JA
160}
161
d4c3cca9 162static const struct pipe_buf_operations user_page_pipe_buf_ops = {
912d35f8 163 .can_merge = 0,
f84d7519
JA
164 .map = generic_pipe_buf_map,
165 .unmap = generic_pipe_buf_unmap,
166 .pin = generic_pipe_buf_pin,
912d35f8
JA
167 .release = page_cache_pipe_buf_release,
168 .steal = user_page_pipe_buf_steal,
f84d7519 169 .get = generic_pipe_buf_get,
912d35f8
JA
170};
171
83f9135b
JA
172/*
173 * Pipe output worker. This sets up our pipe format with the page cache
174 * pipe buffer operations. Otherwise very similar to the regular pipe_writev().
175 */
00522fb4
JA
176static ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
177 struct splice_pipe_desc *spd)
5274f052 178{
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
3a326a2c
IM
185 if (pipe->inode)
186 mutex_lock(&pipe->inode->i_mutex);
5274f052 187
5274f052 188 for (;;) {
3a326a2c 189 if (!pipe->readers) {
5274f052
JA
190 send_sig(SIGPIPE, current, 0);
191 if (!ret)
192 ret = -EPIPE;
193 break;
194 }
195
6f767b04
JA
196 if (pipe->nrbufs < PIPE_BUFFERS) {
197 int newbuf = (pipe->curbuf + pipe->nrbufs) & (PIPE_BUFFERS - 1);
3a326a2c 198 struct pipe_buffer *buf = pipe->bufs + newbuf;
5274f052 199
912d35f8
JA
200 buf->page = spd->pages[page_nr];
201 buf->offset = spd->partial[page_nr].offset;
202 buf->len = spd->partial[page_nr].len;
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
3a326a2c
IM
247 if (pipe->inode)
248 mutex_unlock(&pipe->inode->i_mutex);
5274f052
JA
249
250 if (do_wakeup) {
c0bd1f65 251 smp_mb();
3a326a2c
IM
252 if (waitqueue_active(&pipe->wait))
253 wake_up_interruptible(&pipe->wait);
254 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
5274f052
JA
255 }
256
912d35f8
JA
257 while (page_nr < spd->nr_pages)
258 page_cache_release(spd->pages[page_nr++]);
5274f052
JA
259
260 return ret;
261}
262
3a326a2c 263static int
cbb7e577
JA
264__generic_file_splice_read(struct file *in, loff_t *ppos,
265 struct pipe_inode_info *pipe, size_t len,
266 unsigned int flags)
5274f052
JA
267{
268 struct address_space *mapping = in->f_mapping;
912d35f8 269 unsigned int loff, nr_pages;
16c523dd 270 struct page *pages[PIPE_BUFFERS];
912d35f8 271 struct partial_page partial[PIPE_BUFFERS];
5274f052 272 struct page *page;
91ad66ef
JA
273 pgoff_t index, end_index;
274 loff_t isize;
eb20796b 275 int error, page_nr;
912d35f8
JA
276 struct splice_pipe_desc spd = {
277 .pages = pages,
278 .partial = partial,
279 .flags = flags,
280 .ops = &page_cache_pipe_buf_ops,
281 };
5274f052 282
cbb7e577 283 index = *ppos >> PAGE_CACHE_SHIFT;
912d35f8
JA
284 loff = *ppos & ~PAGE_CACHE_MASK;
285 nr_pages = (len + loff + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
5274f052
JA
286
287 if (nr_pages > PIPE_BUFFERS)
288 nr_pages = PIPE_BUFFERS;
289
290 /*
86aa5ac5
JA
291 * Don't try to 2nd guess the read-ahead logic, call into
292 * page_cache_readahead() like the page cache reads would do.
5274f052 293 */
86aa5ac5 294 page_cache_readahead(mapping, &in->f_ra, in, index, nr_pages);
5274f052 295
5274f052 296 /*
73d62d83 297 * Now fill in the holes:
5274f052 298 */
7480a904 299 error = 0;
82aa5d61 300
eb20796b
JA
301 /*
302 * Lookup the (hopefully) full range of pages we need.
303 */
304 spd.nr_pages = find_get_pages_contig(mapping, index, nr_pages, pages);
82aa5d61 305
eb20796b
JA
306 /*
307 * If find_get_pages_contig() returned fewer pages than we needed,
308 * allocate the rest.
309 */
310 index += spd.nr_pages;
311 while (spd.nr_pages < nr_pages) {
82aa5d61 312 /*
eb20796b
JA
313 * Page could be there, find_get_pages_contig() breaks on
314 * the first hole.
5274f052 315 */
7480a904
JA
316 page = find_get_page(mapping, index);
317 if (!page) {
e27dedd8
JA
318 /*
319 * Make sure the read-ahead engine is notified
320 * about this failure.
321 */
322 handle_ra_miss(mapping, &in->f_ra, index);
323
7480a904 324 /*
eb20796b 325 * page didn't exist, allocate one.
7480a904
JA
326 */
327 page = page_cache_alloc_cold(mapping);
328 if (!page)
329 break;
330
331 error = add_to_page_cache_lru(page, mapping, index,
2ae88149 332 GFP_KERNEL);
7480a904
JA
333 if (unlikely(error)) {
334 page_cache_release(page);
a0548871
JA
335 if (error == -EEXIST)
336 continue;
7480a904
JA
337 break;
338 }
eb20796b
JA
339 /*
340 * add_to_page_cache() locks the page, unlock it
341 * to avoid convoluting the logic below even more.
342 */
343 unlock_page(page);
7480a904
JA
344 }
345
eb20796b
JA
346 pages[spd.nr_pages++] = page;
347 index++;
348 }
349
350 /*
351 * Now loop over the map and see if we need to start IO on any
352 * pages, fill in the partial map, etc.
353 */
354 index = *ppos >> PAGE_CACHE_SHIFT;
355 nr_pages = spd.nr_pages;
356 spd.nr_pages = 0;
357 for (page_nr = 0; page_nr < nr_pages; page_nr++) {
358 unsigned int this_len;
359
360 if (!len)
361 break;
362
363 /*
364 * this_len is the max we'll use from this page
365 */
366 this_len = min_t(unsigned long, len, PAGE_CACHE_SIZE - loff);
367 page = pages[page_nr];
368
7480a904
JA
369 /*
370 * If the page isn't uptodate, we may need to start io on it
371 */
372 if (!PageUptodate(page)) {
c4f895cb
JA
373 /*
374 * If in nonblock mode then dont block on waiting
375 * for an in-flight io page
376 */
9ae9d68c
FW
377 if (flags & SPLICE_F_NONBLOCK) {
378 if (TestSetPageLocked(page))
379 break;
380 } else
381 lock_page(page);
7480a904
JA
382
383 /*
384 * page was truncated, stop here. if this isn't the
385 * first page, we'll just complete what we already
386 * added
387 */
388 if (!page->mapping) {
389 unlock_page(page);
7480a904
JA
390 break;
391 }
392 /*
393 * page was already under io and is now done, great
394 */
395 if (PageUptodate(page)) {
396 unlock_page(page);
397 goto fill_it;
398 }
5274f052 399
7480a904
JA
400 /*
401 * need to read in the page
402 */
403 error = mapping->a_ops->readpage(in, page);
5274f052 404 if (unlikely(error)) {
eb20796b
JA
405 /*
406 * We really should re-lookup the page here,
407 * but it complicates things a lot. Instead
408 * lets just do what we already stored, and
409 * we'll get it the next time we are called.
410 */
7480a904 411 if (error == AOP_TRUNCATED_PAGE)
eb20796b
JA
412 error = 0;
413
5274f052
JA
414 break;
415 }
620a324b
JA
416 }
417fill_it:
418 /*
419 * i_size must be checked after PageUptodate.
420 */
421 isize = i_size_read(mapping->host);
422 end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
423 if (unlikely(!isize || index > end_index))
424 break;
425
426 /*
427 * if this is the last page, see if we need to shrink
428 * the length and stop
429 */
430 if (end_index == index) {
431 unsigned int plen;
91ad66ef
JA
432
433 /*
620a324b 434 * max good bytes in this page
91ad66ef 435 */
620a324b
JA
436 plen = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
437 if (plen <= loff)
91ad66ef 438 break;
91ad66ef
JA
439
440 /*
620a324b 441 * force quit after adding this page
91ad66ef 442 */
620a324b
JA
443 this_len = min(this_len, plen - loff);
444 len = this_len;
5274f052 445 }
620a324b 446
eb20796b
JA
447 partial[page_nr].offset = loff;
448 partial[page_nr].len = this_len;
82aa5d61 449 len -= this_len;
91ad66ef 450 loff = 0;
eb20796b
JA
451 spd.nr_pages++;
452 index++;
5274f052
JA
453 }
454
eb20796b 455 /*
475ecade 456 * Release any pages at the end, if we quit early. 'page_nr' is how far
eb20796b
JA
457 * we got, 'nr_pages' is how many pages are in the map.
458 */
459 while (page_nr < nr_pages)
460 page_cache_release(pages[page_nr++]);
461
912d35f8 462 if (spd.nr_pages)
00522fb4 463 return splice_to_pipe(pipe, &spd);
5274f052 464
7480a904 465 return error;
5274f052
JA
466}
467
83f9135b
JA
468/**
469 * generic_file_splice_read - splice data from file to a pipe
470 * @in: file to splice from
471 * @pipe: pipe to splice to
472 * @len: number of bytes to splice
473 * @flags: splice modifier flags
474 *
475 * Will read pages from given file and fill them into a pipe.
83f9135b 476 */
cbb7e577
JA
477ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
478 struct pipe_inode_info *pipe, size_t len,
479 unsigned int flags)
5274f052
JA
480{
481 ssize_t spliced;
482 int ret;
d366d398
JA
483 loff_t isize, left;
484
485 isize = i_size_read(in->f_mapping->host);
486 if (unlikely(*ppos >= isize))
487 return 0;
488
489 left = isize - *ppos;
490 if (unlikely(left < len))
491 len = left;
5274f052
JA
492
493 ret = 0;
494 spliced = 0;
495 while (len) {
cbb7e577 496 ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
5274f052 497
c4f895cb 498 if (ret < 0)
5274f052 499 break;
c4f895cb
JA
500 else if (!ret) {
501 if (spliced)
502 break;
503 if (flags & SPLICE_F_NONBLOCK) {
504 ret = -EAGAIN;
505 break;
506 }
507 }
5274f052 508
cbb7e577 509 *ppos += ret;
5274f052
JA
510 len -= ret;
511 spliced += ret;
512 }
513
514 if (spliced)
515 return spliced;
516
517 return ret;
518}
519
059a8f37
JA
520EXPORT_SYMBOL(generic_file_splice_read);
521
5274f052 522/*
4f6f0bd2 523 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
016b661e 524 * using sendpage(). Return the number of bytes sent.
5274f052 525 */
76ad4d11 526static int pipe_to_sendpage(struct pipe_inode_info *pipe,
5274f052
JA
527 struct pipe_buffer *buf, struct splice_desc *sd)
528{
529 struct file *file = sd->file;
530 loff_t pos = sd->pos;
f84d7519 531 int ret, more;
5274f052 532
76ad4d11 533 ret = buf->ops->pin(pipe, buf);
f84d7519
JA
534 if (!ret) {
535 more = (sd->flags & SPLICE_F_MORE) || sd->len < sd->total_len;
5274f052 536
f84d7519
JA
537 ret = file->f_op->sendpage(file, buf->page, buf->offset,
538 sd->len, &pos, more);
539 }
5274f052 540
016b661e 541 return ret;
5274f052
JA
542}
543
544/*
545 * This is a little more tricky than the file -> pipe splicing. There are
546 * basically three cases:
547 *
548 * - Destination page already exists in the address space and there
549 * are users of it. For that case we have no other option that
550 * copying the data. Tough luck.
551 * - Destination page already exists in the address space, but there
552 * are no users of it. Make sure it's uptodate, then drop it. Fall
553 * through to last case.
554 * - Destination page does not exist, we can add the pipe page to
555 * the page cache and avoid the copy.
556 *
83f9135b
JA
557 * If asked to move pages to the output file (SPLICE_F_MOVE is set in
558 * sd->flags), we attempt to migrate pages from the pipe to the output
559 * file address space page cache. This is possible if no one else has
560 * the pipe page referenced outside of the pipe and page cache. If
561 * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create
562 * a new page in the output file page cache and fill/dirty that.
5274f052 563 */
76ad4d11 564static int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
5274f052
JA
565 struct splice_desc *sd)
566{
567 struct file *file = sd->file;
568 struct address_space *mapping = file->f_mapping;
016b661e 569 unsigned int offset, this_len;
5274f052 570 struct page *page;
5274f052 571 pgoff_t index;
3e7ee3e7 572 int ret;
5274f052
JA
573
574 /*
49d0b21b 575 * make sure the data in this buffer is uptodate
5274f052 576 */
76ad4d11 577 ret = buf->ops->pin(pipe, buf);
f84d7519
JA
578 if (unlikely(ret))
579 return ret;
5274f052
JA
580
581 index = sd->pos >> PAGE_CACHE_SHIFT;
582 offset = sd->pos & ~PAGE_CACHE_MASK;
583
016b661e
JA
584 this_len = sd->len;
585 if (this_len + offset > PAGE_CACHE_SIZE)
586 this_len = PAGE_CACHE_SIZE - offset;
587
485ddb4b
NP
588find_page:
589 page = find_lock_page(mapping, index);
590 if (!page) {
591 ret = -ENOMEM;
592 page = page_cache_alloc_cold(mapping);
593 if (unlikely(!page))
594 goto out_ret;
595
83f9135b 596 /*
485ddb4b 597 * This will also lock the page
83f9135b 598 */
485ddb4b
NP
599 ret = add_to_page_cache_lru(page, mapping, index,
600 GFP_KERNEL);
601 if (unlikely(ret))
602 goto out;
603 }
9e0267c2 604
016b661e 605 ret = mapping->a_ops->prepare_write(file, page, offset, offset+this_len);
bfc4ee39
JA
606 if (unlikely(ret)) {
607 loff_t isize = i_size_read(mapping->host);
608
609 if (ret != AOP_TRUNCATED_PAGE)
610 unlock_page(page);
4f6f0bd2 611 page_cache_release(page);
bfc4ee39
JA
612 if (ret == AOP_TRUNCATED_PAGE)
613 goto find_page;
614
615 /*
616 * prepare_write() may have instantiated a few blocks
617 * outside i_size. Trim these off again.
618 */
619 if (sd->pos + this_len > isize)
620 vmtruncate(mapping->host, isize);
621
e6e80f29 622 goto out_ret;
bfc4ee39 623 }
5274f052 624
0568b409 625 if (buf->page != page) {
f84d7519
JA
626 /*
627 * Careful, ->map() uses KM_USER0!
628 */
76ad4d11 629 char *src = buf->ops->map(pipe, buf, 1);
f84d7519 630 char *dst = kmap_atomic(page, KM_USER1);
5abc97aa 631
016b661e 632 memcpy(dst + offset, src + buf->offset, this_len);
5abc97aa 633 flush_dcache_page(page);
f84d7519 634 kunmap_atomic(dst, KM_USER1);
76ad4d11 635 buf->ops->unmap(pipe, buf, src);
5abc97aa 636 }
5274f052 637
016b661e 638 ret = mapping->a_ops->commit_write(file, page, offset, offset+this_len);
d9993c37
DM
639 if (ret) {
640 if (ret == AOP_TRUNCATED_PAGE) {
641 page_cache_release(page);
642 goto find_page;
643 }
644 if (ret < 0)
645 goto out;
0568b409 646 /*
d9993c37
DM
647 * Partial write has happened, so 'ret' already initialized by
648 * number of bytes written, Where is nothing we have to do here.
0568b409 649 */
d9993c37 650 } else
0568b409 651 ret = this_len;
d9993c37
DM
652 /*
653 * Return the number of bytes written and mark page as
654 * accessed, we are now done!
655 */
656 mark_page_accessed(page);
5274f052 657out:
0568b409 658 page_cache_release(page);
9e0267c2 659 unlock_page(page);
e6e80f29 660out_ret:
5274f052
JA
661 return ret;
662}
663
83f9135b
JA
664/*
665 * Pipe input worker. Most of this logic works like a regular pipe, the
666 * key here is the 'actor' worker passed in that actually moves the data
667 * to the wanted destination. See pipe_to_file/pipe_to_sendpage above.
668 */
40bee44e
MF
669ssize_t __splice_from_pipe(struct pipe_inode_info *pipe,
670 struct file *out, loff_t *ppos, size_t len,
671 unsigned int flags, splice_actor *actor)
5274f052 672{
5274f052
JA
673 int ret, do_wakeup, err;
674 struct splice_desc sd;
675
676 ret = 0;
677 do_wakeup = 0;
678
679 sd.total_len = len;
680 sd.flags = flags;
681 sd.file = out;
cbb7e577 682 sd.pos = *ppos;
5274f052 683
5274f052 684 for (;;) {
6f767b04
JA
685 if (pipe->nrbufs) {
686 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
d4c3cca9 687 const struct pipe_buf_operations *ops = buf->ops;
5274f052
JA
688
689 sd.len = buf->len;
690 if (sd.len > sd.total_len)
691 sd.len = sd.total_len;
692
3a326a2c 693 err = actor(pipe, buf, &sd);
016b661e 694 if (err <= 0) {
5274f052
JA
695 if (!ret && err != -ENODATA)
696 ret = err;
697
698 break;
699 }
700
016b661e
JA
701 ret += err;
702 buf->offset += err;
703 buf->len -= err;
704
705 sd.len -= err;
706 sd.pos += err;
707 sd.total_len -= err;
708 if (sd.len)
709 continue;
73d62d83 710
5274f052
JA
711 if (!buf->len) {
712 buf->ops = NULL;
3a326a2c 713 ops->release(pipe, buf);
6f767b04
JA
714 pipe->curbuf = (pipe->curbuf + 1) & (PIPE_BUFFERS - 1);
715 pipe->nrbufs--;
716 if (pipe->inode)
717 do_wakeup = 1;
5274f052
JA
718 }
719
5274f052
JA
720 if (!sd.total_len)
721 break;
722 }
723
6f767b04 724 if (pipe->nrbufs)
5274f052 725 continue;
3a326a2c 726 if (!pipe->writers)
5274f052 727 break;
3a326a2c 728 if (!pipe->waiting_writers) {
5274f052
JA
729 if (ret)
730 break;
731 }
732
29e35094
LT
733 if (flags & SPLICE_F_NONBLOCK) {
734 if (!ret)
735 ret = -EAGAIN;
736 break;
737 }
738
5274f052
JA
739 if (signal_pending(current)) {
740 if (!ret)
741 ret = -ERESTARTSYS;
742 break;
743 }
744
745 if (do_wakeup) {
c0bd1f65 746 smp_mb();
3a326a2c
IM
747 if (waitqueue_active(&pipe->wait))
748 wake_up_interruptible_sync(&pipe->wait);
749 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
5274f052
JA
750 do_wakeup = 0;
751 }
752
3a326a2c 753 pipe_wait(pipe);
5274f052
JA
754 }
755
5274f052 756 if (do_wakeup) {
c0bd1f65 757 smp_mb();
3a326a2c
IM
758 if (waitqueue_active(&pipe->wait))
759 wake_up_interruptible(&pipe->wait);
760 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
5274f052
JA
761 }
762
5274f052 763 return ret;
5274f052 764}
40bee44e 765EXPORT_SYMBOL(__splice_from_pipe);
5274f052 766
6da61809
MF
767ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
768 loff_t *ppos, size_t len, unsigned int flags,
769 splice_actor *actor)
770{
771 ssize_t ret;
772 struct inode *inode = out->f_mapping->host;
773
774 /*
775 * The actor worker might be calling ->prepare_write and
776 * ->commit_write. Most of the time, these expect i_mutex to
777 * be held. Since this may result in an ABBA deadlock with
778 * pipe->inode, we have to order lock acquiry here.
779 */
780 inode_double_lock(inode, pipe->inode);
781 ret = __splice_from_pipe(pipe, out, ppos, len, flags, actor);
782 inode_double_unlock(inode, pipe->inode);
783
784 return ret;
785}
786
787/**
788 * generic_file_splice_write_nolock - generic_file_splice_write without mutexes
789 * @pipe: pipe info
790 * @out: file to write to
791 * @len: number of bytes to splice
792 * @flags: splice modifier flags
793 *
794 * Will either move or copy pages (determined by @flags options) from
795 * the given pipe inode to the given file. The caller is responsible
796 * for acquiring i_mutex on both inodes.
797 *
798 */
799ssize_t
800generic_file_splice_write_nolock(struct pipe_inode_info *pipe, struct file *out,
801 loff_t *ppos, size_t len, unsigned int flags)
802{
803 struct address_space *mapping = out->f_mapping;
804 struct inode *inode = mapping->host;
805 ssize_t ret;
806 int err;
807
0f7fc9e4 808 err = remove_suid(out->f_path.dentry);
8c34e2d6
JA
809 if (unlikely(err))
810 return err;
811
6da61809
MF
812 ret = __splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_file);
813 if (ret > 0) {
17ee4f49
JA
814 unsigned long nr_pages;
815
6da61809 816 *ppos += ret;
17ee4f49 817 nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
6da61809
MF
818
819 /*
820 * If file or inode is SYNC and we actually wrote some data,
821 * sync it.
822 */
823 if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(inode))) {
824 err = generic_osync_inode(inode, mapping,
825 OSYNC_METADATA|OSYNC_DATA);
826
827 if (err)
828 ret = err;
829 }
17ee4f49 830 balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
6da61809
MF
831 }
832
833 return ret;
834}
835
836EXPORT_SYMBOL(generic_file_splice_write_nolock);
837
83f9135b
JA
838/**
839 * generic_file_splice_write - splice data from a pipe to a file
3a326a2c 840 * @pipe: pipe info
83f9135b
JA
841 * @out: file to write to
842 * @len: number of bytes to splice
843 * @flags: splice modifier flags
844 *
845 * Will either move or copy pages (determined by @flags options) from
846 * the given pipe inode to the given file.
847 *
848 */
3a326a2c
IM
849ssize_t
850generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
cbb7e577 851 loff_t *ppos, size_t len, unsigned int flags)
5274f052 852{
4f6f0bd2 853 struct address_space *mapping = out->f_mapping;
8c34e2d6 854 struct inode *inode = mapping->host;
3a326a2c 855 ssize_t ret;
8c34e2d6
JA
856 int err;
857
0f7fc9e4 858 err = should_remove_suid(out->f_path.dentry);
8c34e2d6
JA
859 if (unlikely(err)) {
860 mutex_lock(&inode->i_mutex);
0f7fc9e4 861 err = __remove_suid(out->f_path.dentry, err);
8c34e2d6
JA
862 mutex_unlock(&inode->i_mutex);
863 if (err)
864 return err;
865 }
3a326a2c 866
00522fb4 867 ret = splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_file);
a4514ebd 868 if (ret > 0) {
17ee4f49
JA
869 unsigned long nr_pages;
870
a4514ebd 871 *ppos += ret;
17ee4f49 872 nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
a4514ebd
JA
873
874 /*
875 * If file or inode is SYNC and we actually wrote some data,
876 * sync it.
877 */
878 if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(inode))) {
a4514ebd
JA
879 mutex_lock(&inode->i_mutex);
880 err = generic_osync_inode(inode, mapping,
881 OSYNC_METADATA|OSYNC_DATA);
882 mutex_unlock(&inode->i_mutex);
4f6f0bd2 883
a4514ebd
JA
884 if (err)
885 ret = err;
886 }
17ee4f49 887 balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
4f6f0bd2
JA
888 }
889
890 return ret;
5274f052
JA
891}
892
059a8f37
JA
893EXPORT_SYMBOL(generic_file_splice_write);
894
83f9135b
JA
895/**
896 * generic_splice_sendpage - splice data from a pipe to a socket
897 * @inode: pipe inode
898 * @out: socket to write to
899 * @len: number of bytes to splice
900 * @flags: splice modifier flags
901 *
902 * Will send @len bytes from the pipe to a network socket. No data copying
903 * is involved.
904 *
905 */
3a326a2c 906ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
cbb7e577 907 loff_t *ppos, size_t len, unsigned int flags)
5274f052 908{
00522fb4 909 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
5274f052
JA
910}
911
059a8f37 912EXPORT_SYMBOL(generic_splice_sendpage);
a0f06780 913
83f9135b
JA
914/*
915 * Attempt to initiate a splice from pipe to file.
916 */
3a326a2c 917static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
cbb7e577 918 loff_t *ppos, size_t len, unsigned int flags)
5274f052 919{
5274f052
JA
920 int ret;
921
49570e9b 922 if (unlikely(!out->f_op || !out->f_op->splice_write))
5274f052
JA
923 return -EINVAL;
924
49570e9b 925 if (unlikely(!(out->f_mode & FMODE_WRITE)))
5274f052
JA
926 return -EBADF;
927
cbb7e577 928 ret = rw_verify_area(WRITE, out, ppos, len);
5274f052
JA
929 if (unlikely(ret < 0))
930 return ret;
931
cbb7e577 932 return out->f_op->splice_write(pipe, out, ppos, len, flags);
5274f052
JA
933}
934
83f9135b
JA
935/*
936 * Attempt to initiate a splice from a file to a pipe.
937 */
cbb7e577
JA
938static long do_splice_to(struct file *in, loff_t *ppos,
939 struct pipe_inode_info *pipe, size_t len,
940 unsigned int flags)
5274f052 941{
5274f052
JA
942 int ret;
943
49570e9b 944 if (unlikely(!in->f_op || !in->f_op->splice_read))
5274f052
JA
945 return -EINVAL;
946
49570e9b 947 if (unlikely(!(in->f_mode & FMODE_READ)))
5274f052
JA
948 return -EBADF;
949
cbb7e577 950 ret = rw_verify_area(READ, in, ppos, len);
5274f052
JA
951 if (unlikely(ret < 0))
952 return ret;
953
cbb7e577 954 return in->f_op->splice_read(in, ppos, pipe, len, flags);
5274f052
JA
955}
956
cbb7e577
JA
957long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
958 size_t len, unsigned int flags)
b92ce558
JA
959{
960 struct pipe_inode_info *pipe;
961 long ret, bytes;
cbb7e577 962 loff_t out_off;
b92ce558
JA
963 umode_t i_mode;
964 int i;
965
966 /*
967 * We require the input being a regular file, as we don't want to
968 * randomly drop data for eg socket -> socket splicing. Use the
969 * piped splicing for that!
970 */
0f7fc9e4 971 i_mode = in->f_path.dentry->d_inode->i_mode;
b92ce558
JA
972 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
973 return -EINVAL;
974
975 /*
976 * neither in nor out is a pipe, setup an internal pipe attached to
977 * 'out' and transfer the wanted data from 'in' to 'out' through that
978 */
979 pipe = current->splice_pipe;
49570e9b 980 if (unlikely(!pipe)) {
b92ce558
JA
981 pipe = alloc_pipe_info(NULL);
982 if (!pipe)
983 return -ENOMEM;
984
985 /*
986 * We don't have an immediate reader, but we'll read the stuff
00522fb4 987 * out of the pipe right after the splice_to_pipe(). So set
b92ce558
JA
988 * PIPE_READERS appropriately.
989 */
990 pipe->readers = 1;
991
992 current->splice_pipe = pipe;
993 }
994
995 /*
73d62d83 996 * Do the splice.
b92ce558
JA
997 */
998 ret = 0;
999 bytes = 0;
cbb7e577 1000 out_off = 0;
b92ce558
JA
1001
1002 while (len) {
1003 size_t read_len, max_read_len;
1004
1005 /*
1006 * Do at most PIPE_BUFFERS pages worth of transfer:
1007 */
1008 max_read_len = min(len, (size_t)(PIPE_BUFFERS*PAGE_SIZE));
1009
cbb7e577 1010 ret = do_splice_to(in, ppos, pipe, max_read_len, flags);
b92ce558
JA
1011 if (unlikely(ret < 0))
1012 goto out_release;
1013
1014 read_len = ret;
1015
1016 /*
1017 * NOTE: nonblocking mode only applies to the input. We
1018 * must not do the output in nonblocking mode as then we
1019 * could get stuck data in the internal pipe:
1020 */
cbb7e577 1021 ret = do_splice_from(pipe, out, &out_off, read_len,
b92ce558
JA
1022 flags & ~SPLICE_F_NONBLOCK);
1023 if (unlikely(ret < 0))
1024 goto out_release;
1025
1026 bytes += ret;
1027 len -= ret;
1028
1029 /*
1030 * In nonblocking mode, if we got back a short read then
1031 * that was due to either an IO error or due to the
1032 * pagecache entry not being there. In the IO error case
1033 * the _next_ splice attempt will produce a clean IO error
1034 * return value (not a short read), so in both cases it's
1035 * correct to break out of the loop here:
1036 */
1037 if ((flags & SPLICE_F_NONBLOCK) && (read_len < max_read_len))
1038 break;
1039 }
1040
1041 pipe->nrbufs = pipe->curbuf = 0;
1042
1043 return bytes;
1044
1045out_release:
1046 /*
1047 * If we did an incomplete transfer we must release
1048 * the pipe buffers in question:
1049 */
1050 for (i = 0; i < PIPE_BUFFERS; i++) {
1051 struct pipe_buffer *buf = pipe->bufs + i;
1052
1053 if (buf->ops) {
1054 buf->ops->release(pipe, buf);
1055 buf->ops = NULL;
1056 }
1057 }
1058 pipe->nrbufs = pipe->curbuf = 0;
1059
1060 /*
1061 * If we transferred some data, return the number of bytes:
1062 */
1063 if (bytes > 0)
1064 return bytes;
1065
1066 return ret;
1067}
1068
ddac0d39
JA
1069/*
1070 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
1071 * location, so checking ->i_pipe is not enough to verify that this is a
1072 * pipe.
1073 */
1074static inline struct pipe_inode_info *pipe_info(struct inode *inode)
1075{
1076 if (S_ISFIFO(inode->i_mode))
1077 return inode->i_pipe;
1078
1079 return NULL;
1080}
1081
83f9135b
JA
1082/*
1083 * Determine where to splice to/from.
1084 */
529565dc
IM
1085static long do_splice(struct file *in, loff_t __user *off_in,
1086 struct file *out, loff_t __user *off_out,
1087 size_t len, unsigned int flags)
5274f052 1088{
3a326a2c 1089 struct pipe_inode_info *pipe;
cbb7e577 1090 loff_t offset, *off;
a4514ebd 1091 long ret;
5274f052 1092
0f7fc9e4 1093 pipe = pipe_info(in->f_path.dentry->d_inode);
529565dc
IM
1094 if (pipe) {
1095 if (off_in)
1096 return -ESPIPE;
b92ce558
JA
1097 if (off_out) {
1098 if (out->f_op->llseek == no_llseek)
1099 return -EINVAL;
cbb7e577 1100 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
b92ce558 1101 return -EFAULT;
cbb7e577
JA
1102 off = &offset;
1103 } else
1104 off = &out->f_pos;
529565dc 1105
a4514ebd
JA
1106 ret = do_splice_from(pipe, out, off, len, flags);
1107
1108 if (off_out && copy_to_user(off_out, off, sizeof(loff_t)))
1109 ret = -EFAULT;
1110
1111 return ret;
529565dc 1112 }
5274f052 1113
0f7fc9e4 1114 pipe = pipe_info(out->f_path.dentry->d_inode);
529565dc
IM
1115 if (pipe) {
1116 if (off_out)
1117 return -ESPIPE;
b92ce558
JA
1118 if (off_in) {
1119 if (in->f_op->llseek == no_llseek)
1120 return -EINVAL;
cbb7e577 1121 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
b92ce558 1122 return -EFAULT;
cbb7e577
JA
1123 off = &offset;
1124 } else
1125 off = &in->f_pos;
529565dc 1126
a4514ebd
JA
1127 ret = do_splice_to(in, off, pipe, len, flags);
1128
1129 if (off_in && copy_to_user(off_in, off, sizeof(loff_t)))
1130 ret = -EFAULT;
1131
1132 return ret;
529565dc 1133 }
5274f052
JA
1134
1135 return -EINVAL;
1136}
1137
912d35f8
JA
1138/*
1139 * Map an iov into an array of pages and offset/length tupples. With the
1140 * partial_page structure, we can map several non-contiguous ranges into
1141 * our ones pages[] map instead of splitting that operation into pieces.
1142 * Could easily be exported as a generic helper for other users, in which
1143 * case one would probably want to add a 'max_nr_pages' parameter as well.
1144 */
1145static int get_iovec_page_array(const struct iovec __user *iov,
1146 unsigned int nr_vecs, struct page **pages,
7afa6fd0 1147 struct partial_page *partial, int aligned)
912d35f8
JA
1148{
1149 int buffers = 0, error = 0;
1150
1151 /*
1152 * It's ok to take the mmap_sem for reading, even
1153 * across a "get_user()".
1154 */
1155 down_read(&current->mm->mmap_sem);
1156
1157 while (nr_vecs) {
1158 unsigned long off, npages;
1159 void __user *base;
1160 size_t len;
1161 int i;
1162
1163 /*
1164 * Get user address base and length for this iovec.
1165 */
1166 error = get_user(base, &iov->iov_base);
1167 if (unlikely(error))
1168 break;
1169 error = get_user(len, &iov->iov_len);
1170 if (unlikely(error))
1171 break;
1172
1173 /*
1174 * Sanity check this iovec. 0 read succeeds.
1175 */
1176 if (unlikely(!len))
1177 break;
1178 error = -EFAULT;
1179 if (unlikely(!base))
1180 break;
1181
1182 /*
1183 * Get this base offset and number of pages, then map
1184 * in the user pages.
1185 */
1186 off = (unsigned long) base & ~PAGE_MASK;
7afa6fd0
JA
1187
1188 /*
1189 * If asked for alignment, the offset must be zero and the
1190 * length a multiple of the PAGE_SIZE.
1191 */
1192 error = -EINVAL;
1193 if (aligned && (off || len & ~PAGE_MASK))
1194 break;
1195
912d35f8
JA
1196 npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1197 if (npages > PIPE_BUFFERS - buffers)
1198 npages = PIPE_BUFFERS - buffers;
1199
1200 error = get_user_pages(current, current->mm,
1201 (unsigned long) base, npages, 0, 0,
1202 &pages[buffers], NULL);
1203
1204 if (unlikely(error <= 0))
1205 break;
1206
1207 /*
1208 * Fill this contiguous range into the partial page map.
1209 */
1210 for (i = 0; i < error; i++) {
7591489a 1211 const int plen = min_t(size_t, len, PAGE_SIZE - off);
912d35f8
JA
1212
1213 partial[buffers].offset = off;
1214 partial[buffers].len = plen;
1215
1216 off = 0;
1217 len -= plen;
1218 buffers++;
1219 }
1220
1221 /*
1222 * We didn't complete this iov, stop here since it probably
1223 * means we have to move some of this into a pipe to
1224 * be able to continue.
1225 */
1226 if (len)
1227 break;
1228
1229 /*
1230 * Don't continue if we mapped fewer pages than we asked for,
1231 * or if we mapped the max number of pages that we have
1232 * room for.
1233 */
1234 if (error < npages || buffers == PIPE_BUFFERS)
1235 break;
1236
1237 nr_vecs--;
1238 iov++;
1239 }
1240
1241 up_read(&current->mm->mmap_sem);
1242
1243 if (buffers)
1244 return buffers;
1245
1246 return error;
1247}
1248
1249/*
1250 * vmsplice splices a user address range into a pipe. It can be thought of
1251 * as splice-from-memory, where the regular splice is splice-from-file (or
1252 * to file). In both cases the output is a pipe, naturally.
1253 *
1254 * Note that vmsplice only supports splicing _from_ user memory to a pipe,
1255 * not the other way around. Splicing from user memory is a simple operation
1256 * that can be supported without any funky alignment restrictions or nasty
1257 * vm tricks. We simply map in the user memory and fill them into a pipe.
1258 * The reverse isn't quite as easy, though. There are two possible solutions
1259 * for that:
1260 *
1261 * - memcpy() the data internally, at which point we might as well just
1262 * do a regular read() on the buffer anyway.
1263 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1264 * has restriction limitations on both ends of the pipe).
1265 *
1266 * Alas, it isn't here.
1267 *
1268 */
1269static long do_vmsplice(struct file *file, const struct iovec __user *iov,
1270 unsigned long nr_segs, unsigned int flags)
1271{
ddac0d39 1272 struct pipe_inode_info *pipe;
912d35f8
JA
1273 struct page *pages[PIPE_BUFFERS];
1274 struct partial_page partial[PIPE_BUFFERS];
1275 struct splice_pipe_desc spd = {
1276 .pages = pages,
1277 .partial = partial,
1278 .flags = flags,
1279 .ops = &user_page_pipe_buf_ops,
1280 };
1281
0f7fc9e4 1282 pipe = pipe_info(file->f_path.dentry->d_inode);
ddac0d39 1283 if (!pipe)
912d35f8
JA
1284 return -EBADF;
1285 if (unlikely(nr_segs > UIO_MAXIOV))
1286 return -EINVAL;
1287 else if (unlikely(!nr_segs))
1288 return 0;
1289
7afa6fd0
JA
1290 spd.nr_pages = get_iovec_page_array(iov, nr_segs, pages, partial,
1291 flags & SPLICE_F_GIFT);
912d35f8
JA
1292 if (spd.nr_pages <= 0)
1293 return spd.nr_pages;
1294
00522fb4 1295 return splice_to_pipe(pipe, &spd);
912d35f8
JA
1296}
1297
1298asmlinkage long sys_vmsplice(int fd, const struct iovec __user *iov,
1299 unsigned long nr_segs, unsigned int flags)
1300{
1301 struct file *file;
1302 long error;
1303 int fput;
1304
1305 error = -EBADF;
1306 file = fget_light(fd, &fput);
1307 if (file) {
1308 if (file->f_mode & FMODE_WRITE)
1309 error = do_vmsplice(file, iov, nr_segs, flags);
1310
1311 fput_light(file, fput);
1312 }
1313
1314 return error;
1315}
1316
529565dc
IM
1317asmlinkage long sys_splice(int fd_in, loff_t __user *off_in,
1318 int fd_out, loff_t __user *off_out,
1319 size_t len, unsigned int flags)
5274f052
JA
1320{
1321 long error;
1322 struct file *in, *out;
1323 int fput_in, fput_out;
1324
1325 if (unlikely(!len))
1326 return 0;
1327
1328 error = -EBADF;
529565dc 1329 in = fget_light(fd_in, &fput_in);
5274f052
JA
1330 if (in) {
1331 if (in->f_mode & FMODE_READ) {
529565dc 1332 out = fget_light(fd_out, &fput_out);
5274f052
JA
1333 if (out) {
1334 if (out->f_mode & FMODE_WRITE)
529565dc
IM
1335 error = do_splice(in, off_in,
1336 out, off_out,
1337 len, flags);
5274f052
JA
1338 fput_light(out, fput_out);
1339 }
1340 }
1341
1342 fput_light(in, fput_in);
1343 }
1344
1345 return error;
1346}
70524490 1347
aadd06e5
JA
1348/*
1349 * Make sure there's data to read. Wait for input if we can, otherwise
1350 * return an appropriate error.
1351 */
1352static int link_ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1353{
1354 int ret;
1355
1356 /*
1357 * Check ->nrbufs without the inode lock first. This function
1358 * is speculative anyways, so missing one is ok.
1359 */
1360 if (pipe->nrbufs)
1361 return 0;
1362
1363 ret = 0;
1364 mutex_lock(&pipe->inode->i_mutex);
1365
1366 while (!pipe->nrbufs) {
1367 if (signal_pending(current)) {
1368 ret = -ERESTARTSYS;
1369 break;
1370 }
1371 if (!pipe->writers)
1372 break;
1373 if (!pipe->waiting_writers) {
1374 if (flags & SPLICE_F_NONBLOCK) {
1375 ret = -EAGAIN;
1376 break;
1377 }
1378 }
1379 pipe_wait(pipe);
1380 }
1381
1382 mutex_unlock(&pipe->inode->i_mutex);
1383 return ret;
1384}
1385
1386/*
1387 * Make sure there's writeable room. Wait for room if we can, otherwise
1388 * return an appropriate error.
1389 */
1390static int link_opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1391{
1392 int ret;
1393
1394 /*
1395 * Check ->nrbufs without the inode lock first. This function
1396 * is speculative anyways, so missing one is ok.
1397 */
1398 if (pipe->nrbufs < PIPE_BUFFERS)
1399 return 0;
1400
1401 ret = 0;
1402 mutex_lock(&pipe->inode->i_mutex);
1403
1404 while (pipe->nrbufs >= PIPE_BUFFERS) {
1405 if (!pipe->readers) {
1406 send_sig(SIGPIPE, current, 0);
1407 ret = -EPIPE;
1408 break;
1409 }
1410 if (flags & SPLICE_F_NONBLOCK) {
1411 ret = -EAGAIN;
1412 break;
1413 }
1414 if (signal_pending(current)) {
1415 ret = -ERESTARTSYS;
1416 break;
1417 }
1418 pipe->waiting_writers++;
1419 pipe_wait(pipe);
1420 pipe->waiting_writers--;
1421 }
1422
1423 mutex_unlock(&pipe->inode->i_mutex);
1424 return ret;
1425}
1426
70524490
JA
1427/*
1428 * Link contents of ipipe to opipe.
1429 */
1430static int link_pipe(struct pipe_inode_info *ipipe,
1431 struct pipe_inode_info *opipe,
1432 size_t len, unsigned int flags)
1433{
1434 struct pipe_buffer *ibuf, *obuf;
aadd06e5 1435 int ret = 0, i = 0, nbuf;
70524490
JA
1436
1437 /*
1438 * Potential ABBA deadlock, work around it by ordering lock
1439 * grabbing by inode address. Otherwise two different processes
1440 * could deadlock (one doing tee from A -> B, the other from B -> A).
1441 */
62752ee1 1442 inode_double_lock(ipipe->inode, opipe->inode);
70524490 1443
aadd06e5 1444 do {
70524490
JA
1445 if (!opipe->readers) {
1446 send_sig(SIGPIPE, current, 0);
1447 if (!ret)
1448 ret = -EPIPE;
1449 break;
1450 }
70524490 1451
aadd06e5
JA
1452 /*
1453 * If we have iterated all input buffers or ran out of
1454 * output room, break.
1455 */
1456 if (i >= ipipe->nrbufs || opipe->nrbufs >= PIPE_BUFFERS)
1457 break;
70524490 1458
aadd06e5
JA
1459 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (PIPE_BUFFERS - 1));
1460 nbuf = (opipe->curbuf + opipe->nrbufs) & (PIPE_BUFFERS - 1);
70524490
JA
1461
1462 /*
aadd06e5
JA
1463 * Get a reference to this pipe buffer,
1464 * so we can copy the contents over.
70524490 1465 */
aadd06e5
JA
1466 ibuf->ops->get(ipipe, ibuf);
1467
1468 obuf = opipe->bufs + nbuf;
1469 *obuf = *ibuf;
1470
2a27250e 1471 /*
aadd06e5
JA
1472 * Don't inherit the gift flag, we need to
1473 * prevent multiple steals of this page.
2a27250e 1474 */
aadd06e5 1475 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
70524490 1476
aadd06e5
JA
1477 if (obuf->len > len)
1478 obuf->len = len;
70524490 1479
aadd06e5
JA
1480 opipe->nrbufs++;
1481 ret += obuf->len;
1482 len -= obuf->len;
1483 i++;
1484 } while (len);
70524490 1485
62752ee1 1486 inode_double_unlock(ipipe->inode, opipe->inode);
70524490 1487
aadd06e5
JA
1488 /*
1489 * If we put data in the output pipe, wakeup any potential readers.
1490 */
1491 if (ret > 0) {
70524490
JA
1492 smp_mb();
1493 if (waitqueue_active(&opipe->wait))
1494 wake_up_interruptible(&opipe->wait);
1495 kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN);
1496 }
1497
1498 return ret;
1499}
1500
1501/*
1502 * This is a tee(1) implementation that works on pipes. It doesn't copy
1503 * any data, it simply references the 'in' pages on the 'out' pipe.
1504 * The 'flags' used are the SPLICE_F_* variants, currently the only
1505 * applicable one is SPLICE_F_NONBLOCK.
1506 */
1507static long do_tee(struct file *in, struct file *out, size_t len,
1508 unsigned int flags)
1509{
0f7fc9e4
JJS
1510 struct pipe_inode_info *ipipe = pipe_info(in->f_path.dentry->d_inode);
1511 struct pipe_inode_info *opipe = pipe_info(out->f_path.dentry->d_inode);
aadd06e5 1512 int ret = -EINVAL;
70524490
JA
1513
1514 /*
aadd06e5
JA
1515 * Duplicate the contents of ipipe to opipe without actually
1516 * copying the data.
70524490 1517 */
aadd06e5
JA
1518 if (ipipe && opipe && ipipe != opipe) {
1519 /*
1520 * Keep going, unless we encounter an error. The ipipe/opipe
1521 * ordering doesn't really matter.
1522 */
1523 ret = link_ipipe_prep(ipipe, flags);
1524 if (!ret) {
1525 ret = link_opipe_prep(opipe, flags);
1526 if (!ret) {
1527 ret = link_pipe(ipipe, opipe, len, flags);
1528 if (!ret && (flags & SPLICE_F_NONBLOCK))
1529 ret = -EAGAIN;
1530 }
1531 }
1532 }
70524490 1533
aadd06e5 1534 return ret;
70524490
JA
1535}
1536
1537asmlinkage long sys_tee(int fdin, int fdout, size_t len, unsigned int flags)
1538{
1539 struct file *in;
1540 int error, fput_in;
1541
1542 if (unlikely(!len))
1543 return 0;
1544
1545 error = -EBADF;
1546 in = fget_light(fdin, &fput_in);
1547 if (in) {
1548 if (in->f_mode & FMODE_READ) {
1549 int fput_out;
1550 struct file *out = fget_light(fdout, &fput_out);
1551
1552 if (out) {
1553 if (out->f_mode & FMODE_WRITE)
1554 error = do_tee(in, out, len, flags);
1555 fput_light(out, fput_out);
1556 }
1557 }
1558 fput_light(in, fput_in);
1559 }
1560
1561 return error;
1562}