]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - fs/splice.c
jbd2: do not clear the BH_Mapped flag when forgetting a metadata buffer
[mirror_ubuntu-bionic-kernel.git] / fs / splice.c
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
12 * Jens to support splicing to files, network, direct splicing, etc and
13 * fixing lots of bugs.
14 *
15 * Copyright (C) 2005-2006 Jens Axboe <axboe@kernel.dk>
16 * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
17 * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
18 *
19 */
20 #include <linux/bvec.h>
21 #include <linux/fs.h>
22 #include <linux/file.h>
23 #include <linux/pagemap.h>
24 #include <linux/splice.h>
25 #include <linux/memcontrol.h>
26 #include <linux/mm_inline.h>
27 #include <linux/swap.h>
28 #include <linux/writeback.h>
29 #include <linux/export.h>
30 #include <linux/syscalls.h>
31 #include <linux/uio.h>
32 #include <linux/security.h>
33 #include <linux/gfp.h>
34 #include <linux/socket.h>
35 #include <linux/compat.h>
36 #include <linux/sched/signal.h>
37
38 #include "internal.h"
39
40 /*
41 * Attempt to steal a page from a pipe buffer. This should perhaps go into
42 * a vm helper function, it's already simplified quite a bit by the
43 * addition of remove_mapping(). If success is returned, the caller may
44 * attempt to reuse this page for another destination.
45 */
46 static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
47 struct pipe_buffer *buf)
48 {
49 struct page *page = buf->page;
50 struct address_space *mapping;
51
52 lock_page(page);
53
54 mapping = page_mapping(page);
55 if (mapping) {
56 WARN_ON(!PageUptodate(page));
57
58 /*
59 * At least for ext2 with nobh option, we need to wait on
60 * writeback completing on this page, since we'll remove it
61 * from the pagecache. Otherwise truncate wont wait on the
62 * page, allowing the disk blocks to be reused by someone else
63 * before we actually wrote our data to them. fs corruption
64 * ensues.
65 */
66 wait_on_page_writeback(page);
67
68 if (page_has_private(page) &&
69 !try_to_release_page(page, GFP_KERNEL))
70 goto out_unlock;
71
72 /*
73 * If we succeeded in removing the mapping, set LRU flag
74 * and return good.
75 */
76 if (remove_mapping(mapping, page)) {
77 buf->flags |= PIPE_BUF_FLAG_LRU;
78 return 0;
79 }
80 }
81
82 /*
83 * Raced with truncate or failed to remove page from current
84 * address space, unlock and return failure.
85 */
86 out_unlock:
87 unlock_page(page);
88 return 1;
89 }
90
91 static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
92 struct pipe_buffer *buf)
93 {
94 put_page(buf->page);
95 buf->flags &= ~PIPE_BUF_FLAG_LRU;
96 }
97
98 /*
99 * Check whether the contents of buf is OK to access. Since the content
100 * is a page cache page, IO may be in flight.
101 */
102 static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
103 struct pipe_buffer *buf)
104 {
105 struct page *page = buf->page;
106 int err;
107
108 if (!PageUptodate(page)) {
109 lock_page(page);
110
111 /*
112 * Page got truncated/unhashed. This will cause a 0-byte
113 * splice, if this is the first page.
114 */
115 if (!page->mapping) {
116 err = -ENODATA;
117 goto error;
118 }
119
120 /*
121 * Uh oh, read-error from disk.
122 */
123 if (!PageUptodate(page)) {
124 err = -EIO;
125 goto error;
126 }
127
128 /*
129 * Page is ok afterall, we are done.
130 */
131 unlock_page(page);
132 }
133
134 return 0;
135 error:
136 unlock_page(page);
137 return err;
138 }
139
140 const struct pipe_buf_operations page_cache_pipe_buf_ops = {
141 .can_merge = 0,
142 .confirm = page_cache_pipe_buf_confirm,
143 .release = page_cache_pipe_buf_release,
144 .steal = page_cache_pipe_buf_steal,
145 .get = generic_pipe_buf_get,
146 };
147
148 static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
149 struct pipe_buffer *buf)
150 {
151 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
152 return 1;
153
154 buf->flags |= PIPE_BUF_FLAG_LRU;
155 return generic_pipe_buf_steal(pipe, buf);
156 }
157
158 static const struct pipe_buf_operations user_page_pipe_buf_ops = {
159 .can_merge = 0,
160 .confirm = generic_pipe_buf_confirm,
161 .release = page_cache_pipe_buf_release,
162 .steal = user_page_pipe_buf_steal,
163 .get = generic_pipe_buf_get,
164 };
165
166 static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
167 {
168 smp_mb();
169 if (waitqueue_active(&pipe->wait))
170 wake_up_interruptible(&pipe->wait);
171 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
172 }
173
174 /**
175 * splice_to_pipe - fill passed data into a pipe
176 * @pipe: pipe to fill
177 * @spd: data to fill
178 *
179 * Description:
180 * @spd contains a map of pages and len/offset tuples, along with
181 * the struct pipe_buf_operations associated with these pages. This
182 * function will link that data to the pipe.
183 *
184 */
185 ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
186 struct splice_pipe_desc *spd)
187 {
188 unsigned int spd_pages = spd->nr_pages;
189 int ret = 0, page_nr = 0;
190
191 if (!spd_pages)
192 return 0;
193
194 if (unlikely(!pipe->readers)) {
195 send_sig(SIGPIPE, current, 0);
196 ret = -EPIPE;
197 goto out;
198 }
199
200 while (pipe->nrbufs < pipe->buffers) {
201 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
202 struct pipe_buffer *buf = pipe->bufs + newbuf;
203
204 buf->page = spd->pages[page_nr];
205 buf->offset = spd->partial[page_nr].offset;
206 buf->len = spd->partial[page_nr].len;
207 buf->private = spd->partial[page_nr].private;
208 buf->ops = spd->ops;
209 buf->flags = 0;
210
211 pipe->nrbufs++;
212 page_nr++;
213 ret += buf->len;
214
215 if (!--spd->nr_pages)
216 break;
217 }
218
219 if (!ret)
220 ret = -EAGAIN;
221
222 out:
223 while (page_nr < spd_pages)
224 spd->spd_release(spd, page_nr++);
225
226 return ret;
227 }
228 EXPORT_SYMBOL_GPL(splice_to_pipe);
229
230 ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
231 {
232 int ret;
233
234 if (unlikely(!pipe->readers)) {
235 send_sig(SIGPIPE, current, 0);
236 ret = -EPIPE;
237 } else if (pipe->nrbufs == pipe->buffers) {
238 ret = -EAGAIN;
239 } else {
240 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
241 pipe->bufs[newbuf] = *buf;
242 pipe->nrbufs++;
243 return buf->len;
244 }
245 pipe_buf_release(pipe, buf);
246 return ret;
247 }
248 EXPORT_SYMBOL(add_to_pipe);
249
250 /*
251 * Check if we need to grow the arrays holding pages and partial page
252 * descriptions.
253 */
254 int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
255 {
256 unsigned int buffers = READ_ONCE(pipe->buffers);
257
258 spd->nr_pages_max = buffers;
259 if (buffers <= PIPE_DEF_BUFFERS)
260 return 0;
261
262 spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
263 spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
264
265 if (spd->pages && spd->partial)
266 return 0;
267
268 kfree(spd->pages);
269 kfree(spd->partial);
270 return -ENOMEM;
271 }
272
273 void splice_shrink_spd(struct splice_pipe_desc *spd)
274 {
275 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
276 return;
277
278 kfree(spd->pages);
279 kfree(spd->partial);
280 }
281
282 /**
283 * generic_file_splice_read - splice data from file to a pipe
284 * @in: file to splice from
285 * @ppos: position in @in
286 * @pipe: pipe to splice to
287 * @len: number of bytes to splice
288 * @flags: splice modifier flags
289 *
290 * Description:
291 * Will read pages from given file and fill them into a pipe. Can be
292 * used as long as it has more or less sane ->read_iter().
293 *
294 */
295 ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
296 struct pipe_inode_info *pipe, size_t len,
297 unsigned int flags)
298 {
299 struct iov_iter to;
300 struct kiocb kiocb;
301 int idx, ret;
302
303 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len);
304 idx = to.idx;
305 init_sync_kiocb(&kiocb, in);
306 kiocb.ki_pos = *ppos;
307 ret = call_read_iter(in, &kiocb, &to);
308 if (ret > 0) {
309 *ppos = kiocb.ki_pos;
310 file_accessed(in);
311 } else if (ret < 0) {
312 to.idx = idx;
313 to.iov_offset = 0;
314 iov_iter_advance(&to, 0); /* to free what was emitted */
315 /*
316 * callers of ->splice_read() expect -EAGAIN on
317 * "can't put anything in there", rather than -EFAULT.
318 */
319 if (ret == -EFAULT)
320 ret = -EAGAIN;
321 }
322
323 return ret;
324 }
325 EXPORT_SYMBOL(generic_file_splice_read);
326
327 const struct pipe_buf_operations default_pipe_buf_ops = {
328 .can_merge = 0,
329 .confirm = generic_pipe_buf_confirm,
330 .release = generic_pipe_buf_release,
331 .steal = generic_pipe_buf_steal,
332 .get = generic_pipe_buf_get,
333 };
334
335 int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
336 struct pipe_buffer *buf)
337 {
338 return 1;
339 }
340
341 /* Pipe buffer operations for a socket and similar. */
342 const struct pipe_buf_operations nosteal_pipe_buf_ops = {
343 .can_merge = 0,
344 .confirm = generic_pipe_buf_confirm,
345 .release = generic_pipe_buf_release,
346 .steal = generic_pipe_buf_nosteal,
347 .get = generic_pipe_buf_get,
348 };
349 EXPORT_SYMBOL(nosteal_pipe_buf_ops);
350
351 static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
352 unsigned long vlen, loff_t offset)
353 {
354 mm_segment_t old_fs;
355 loff_t pos = offset;
356 ssize_t res;
357
358 old_fs = get_fs();
359 set_fs(get_ds());
360 /* The cast to a user pointer is valid due to the set_fs() */
361 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
362 set_fs(old_fs);
363
364 return res;
365 }
366
367 static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
368 struct pipe_inode_info *pipe, size_t len,
369 unsigned int flags)
370 {
371 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
372 struct iov_iter to;
373 struct page **pages;
374 unsigned int nr_pages;
375 size_t offset, base, copied = 0;
376 ssize_t res;
377 int i;
378
379 if (pipe->nrbufs == pipe->buffers)
380 return -EAGAIN;
381
382 /*
383 * Try to keep page boundaries matching to source pagecache ones -
384 * it probably won't be much help, but...
385 */
386 offset = *ppos & ~PAGE_MASK;
387
388 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
389
390 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &base);
391 if (res <= 0)
392 return -ENOMEM;
393
394 nr_pages = DIV_ROUND_UP(res + base, PAGE_SIZE);
395
396 vec = __vec;
397 if (nr_pages > PIPE_DEF_BUFFERS) {
398 vec = kmalloc(nr_pages * sizeof(struct kvec), GFP_KERNEL);
399 if (unlikely(!vec)) {
400 res = -ENOMEM;
401 goto out;
402 }
403 }
404
405 pipe->bufs[to.idx].offset = offset;
406 pipe->bufs[to.idx].len -= offset;
407
408 for (i = 0; i < nr_pages; i++) {
409 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
410 vec[i].iov_base = page_address(pages[i]) + offset;
411 vec[i].iov_len = this_len;
412 len -= this_len;
413 offset = 0;
414 }
415
416 res = kernel_readv(in, vec, nr_pages, *ppos);
417 if (res > 0) {
418 copied = res;
419 *ppos += res;
420 }
421
422 if (vec != __vec)
423 kfree(vec);
424 out:
425 for (i = 0; i < nr_pages; i++)
426 put_page(pages[i]);
427 kvfree(pages);
428 iov_iter_advance(&to, copied); /* truncates and discards */
429 return res;
430 }
431
432 /*
433 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
434 * using sendpage(). Return the number of bytes sent.
435 */
436 static int pipe_to_sendpage(struct pipe_inode_info *pipe,
437 struct pipe_buffer *buf, struct splice_desc *sd)
438 {
439 struct file *file = sd->u.file;
440 loff_t pos = sd->pos;
441 int more;
442
443 if (!likely(file->f_op->sendpage))
444 return -EINVAL;
445
446 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
447
448 if (sd->len < sd->total_len && pipe->nrbufs > 1)
449 more |= MSG_SENDPAGE_NOTLAST;
450
451 return file->f_op->sendpage(file, buf->page, buf->offset,
452 sd->len, &pos, more);
453 }
454
455 static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
456 {
457 smp_mb();
458 if (waitqueue_active(&pipe->wait))
459 wake_up_interruptible(&pipe->wait);
460 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
461 }
462
463 /**
464 * splice_from_pipe_feed - feed available data from a pipe to a file
465 * @pipe: pipe to splice from
466 * @sd: information to @actor
467 * @actor: handler that splices the data
468 *
469 * Description:
470 * This function loops over the pipe and calls @actor to do the
471 * actual moving of a single struct pipe_buffer to the desired
472 * destination. It returns when there's no more buffers left in
473 * the pipe or if the requested number of bytes (@sd->total_len)
474 * have been copied. It returns a positive number (one) if the
475 * pipe needs to be filled with more data, zero if the required
476 * number of bytes have been copied and -errno on error.
477 *
478 * This, together with splice_from_pipe_{begin,end,next}, may be
479 * used to implement the functionality of __splice_from_pipe() when
480 * locking is required around copying the pipe buffers to the
481 * destination.
482 */
483 static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
484 splice_actor *actor)
485 {
486 int ret;
487
488 while (pipe->nrbufs) {
489 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
490
491 sd->len = buf->len;
492 if (sd->len > sd->total_len)
493 sd->len = sd->total_len;
494
495 ret = pipe_buf_confirm(pipe, buf);
496 if (unlikely(ret)) {
497 if (ret == -ENODATA)
498 ret = 0;
499 return ret;
500 }
501
502 ret = actor(pipe, buf, sd);
503 if (ret <= 0)
504 return ret;
505
506 buf->offset += ret;
507 buf->len -= ret;
508
509 sd->num_spliced += ret;
510 sd->len -= ret;
511 sd->pos += ret;
512 sd->total_len -= ret;
513
514 if (!buf->len) {
515 pipe_buf_release(pipe, buf);
516 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
517 pipe->nrbufs--;
518 if (pipe->files)
519 sd->need_wakeup = true;
520 }
521
522 if (!sd->total_len)
523 return 0;
524 }
525
526 return 1;
527 }
528
529 /**
530 * splice_from_pipe_next - wait for some data to splice from
531 * @pipe: pipe to splice from
532 * @sd: information about the splice operation
533 *
534 * Description:
535 * This function will wait for some data and return a positive
536 * value (one) if pipe buffers are available. It will return zero
537 * or -errno if no more data needs to be spliced.
538 */
539 static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
540 {
541 /*
542 * Check for signal early to make process killable when there are
543 * always buffers available
544 */
545 if (signal_pending(current))
546 return -ERESTARTSYS;
547
548 while (!pipe->nrbufs) {
549 if (!pipe->writers)
550 return 0;
551
552 if (!pipe->waiting_writers && sd->num_spliced)
553 return 0;
554
555 if (sd->flags & SPLICE_F_NONBLOCK)
556 return -EAGAIN;
557
558 if (signal_pending(current))
559 return -ERESTARTSYS;
560
561 if (sd->need_wakeup) {
562 wakeup_pipe_writers(pipe);
563 sd->need_wakeup = false;
564 }
565
566 pipe_wait(pipe);
567 }
568
569 return 1;
570 }
571
572 /**
573 * splice_from_pipe_begin - start splicing from pipe
574 * @sd: information about the splice operation
575 *
576 * Description:
577 * This function should be called before a loop containing
578 * splice_from_pipe_next() and splice_from_pipe_feed() to
579 * initialize the necessary fields of @sd.
580 */
581 static void splice_from_pipe_begin(struct splice_desc *sd)
582 {
583 sd->num_spliced = 0;
584 sd->need_wakeup = false;
585 }
586
587 /**
588 * splice_from_pipe_end - finish splicing from pipe
589 * @pipe: pipe to splice from
590 * @sd: information about the splice operation
591 *
592 * Description:
593 * This function will wake up pipe writers if necessary. It should
594 * be called after a loop containing splice_from_pipe_next() and
595 * splice_from_pipe_feed().
596 */
597 static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
598 {
599 if (sd->need_wakeup)
600 wakeup_pipe_writers(pipe);
601 }
602
603 /**
604 * __splice_from_pipe - splice data from a pipe to given actor
605 * @pipe: pipe to splice from
606 * @sd: information to @actor
607 * @actor: handler that splices the data
608 *
609 * Description:
610 * This function does little more than loop over the pipe and call
611 * @actor to do the actual moving of a single struct pipe_buffer to
612 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
613 * pipe_to_user.
614 *
615 */
616 ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
617 splice_actor *actor)
618 {
619 int ret;
620
621 splice_from_pipe_begin(sd);
622 do {
623 cond_resched();
624 ret = splice_from_pipe_next(pipe, sd);
625 if (ret > 0)
626 ret = splice_from_pipe_feed(pipe, sd, actor);
627 } while (ret > 0);
628 splice_from_pipe_end(pipe, sd);
629
630 return sd->num_spliced ? sd->num_spliced : ret;
631 }
632 EXPORT_SYMBOL(__splice_from_pipe);
633
634 /**
635 * splice_from_pipe - splice data from a pipe to a file
636 * @pipe: pipe to splice from
637 * @out: file to splice to
638 * @ppos: position in @out
639 * @len: how many bytes to splice
640 * @flags: splice modifier flags
641 * @actor: handler that splices the data
642 *
643 * Description:
644 * See __splice_from_pipe. This function locks the pipe inode,
645 * otherwise it's identical to __splice_from_pipe().
646 *
647 */
648 ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
649 loff_t *ppos, size_t len, unsigned int flags,
650 splice_actor *actor)
651 {
652 ssize_t ret;
653 struct splice_desc sd = {
654 .total_len = len,
655 .flags = flags,
656 .pos = *ppos,
657 .u.file = out,
658 };
659
660 pipe_lock(pipe);
661 ret = __splice_from_pipe(pipe, &sd, actor);
662 pipe_unlock(pipe);
663
664 return ret;
665 }
666
667 /**
668 * iter_file_splice_write - splice data from a pipe to a file
669 * @pipe: pipe info
670 * @out: file to write to
671 * @ppos: position in @out
672 * @len: number of bytes to splice
673 * @flags: splice modifier flags
674 *
675 * Description:
676 * Will either move or copy pages (determined by @flags options) from
677 * the given pipe inode to the given file.
678 * This one is ->write_iter-based.
679 *
680 */
681 ssize_t
682 iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
683 loff_t *ppos, size_t len, unsigned int flags)
684 {
685 struct splice_desc sd = {
686 .total_len = len,
687 .flags = flags,
688 .pos = *ppos,
689 .u.file = out,
690 };
691 int nbufs = pipe->buffers;
692 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
693 GFP_KERNEL);
694 ssize_t ret;
695
696 if (unlikely(!array))
697 return -ENOMEM;
698
699 pipe_lock(pipe);
700
701 splice_from_pipe_begin(&sd);
702 while (sd.total_len) {
703 struct iov_iter from;
704 size_t left;
705 int n, idx;
706
707 ret = splice_from_pipe_next(pipe, &sd);
708 if (ret <= 0)
709 break;
710
711 if (unlikely(nbufs < pipe->buffers)) {
712 kfree(array);
713 nbufs = pipe->buffers;
714 array = kcalloc(nbufs, sizeof(struct bio_vec),
715 GFP_KERNEL);
716 if (!array) {
717 ret = -ENOMEM;
718 break;
719 }
720 }
721
722 /* build the vector */
723 left = sd.total_len;
724 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
725 struct pipe_buffer *buf = pipe->bufs + idx;
726 size_t this_len = buf->len;
727
728 if (this_len > left)
729 this_len = left;
730
731 if (idx == pipe->buffers - 1)
732 idx = -1;
733
734 ret = pipe_buf_confirm(pipe, buf);
735 if (unlikely(ret)) {
736 if (ret == -ENODATA)
737 ret = 0;
738 goto done;
739 }
740
741 array[n].bv_page = buf->page;
742 array[n].bv_len = this_len;
743 array[n].bv_offset = buf->offset;
744 left -= this_len;
745 }
746
747 iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
748 sd.total_len - left);
749 ret = vfs_iter_write(out, &from, &sd.pos, 0);
750 if (ret <= 0)
751 break;
752
753 sd.num_spliced += ret;
754 sd.total_len -= ret;
755 *ppos = sd.pos;
756
757 /* dismiss the fully eaten buffers, adjust the partial one */
758 while (ret) {
759 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
760 if (ret >= buf->len) {
761 ret -= buf->len;
762 buf->len = 0;
763 pipe_buf_release(pipe, buf);
764 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
765 pipe->nrbufs--;
766 if (pipe->files)
767 sd.need_wakeup = true;
768 } else {
769 buf->offset += ret;
770 buf->len -= ret;
771 ret = 0;
772 }
773 }
774 }
775 done:
776 kfree(array);
777 splice_from_pipe_end(pipe, &sd);
778
779 pipe_unlock(pipe);
780
781 if (sd.num_spliced)
782 ret = sd.num_spliced;
783
784 return ret;
785 }
786
787 EXPORT_SYMBOL(iter_file_splice_write);
788
789 static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
790 struct splice_desc *sd)
791 {
792 int ret;
793 void *data;
794 loff_t tmp = sd->pos;
795
796 data = kmap(buf->page);
797 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
798 kunmap(buf->page);
799
800 return ret;
801 }
802
803 static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
804 struct file *out, loff_t *ppos,
805 size_t len, unsigned int flags)
806 {
807 ssize_t ret;
808
809 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
810 if (ret > 0)
811 *ppos += ret;
812
813 return ret;
814 }
815
816 /**
817 * generic_splice_sendpage - splice data from a pipe to a socket
818 * @pipe: pipe to splice from
819 * @out: socket to write to
820 * @ppos: position in @out
821 * @len: number of bytes to splice
822 * @flags: splice modifier flags
823 *
824 * Description:
825 * Will send @len bytes from the pipe to a network socket. No data copying
826 * is involved.
827 *
828 */
829 ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
830 loff_t *ppos, size_t len, unsigned int flags)
831 {
832 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
833 }
834
835 EXPORT_SYMBOL(generic_splice_sendpage);
836
837 /*
838 * Attempt to initiate a splice from pipe to file.
839 */
840 long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
841 loff_t *ppos, size_t len, unsigned int flags)
842 {
843 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
844 loff_t *, size_t, unsigned int);
845
846 if (out->f_op->splice_write)
847 splice_write = out->f_op->splice_write;
848 else
849 splice_write = default_file_splice_write;
850
851 return splice_write(pipe, out, ppos, len, flags);
852 }
853 EXPORT_SYMBOL_GPL(do_splice_from);
854
855 /*
856 * Attempt to initiate a splice from a file to a pipe.
857 */
858 long do_splice_to(struct file *in, loff_t *ppos,
859 struct pipe_inode_info *pipe, size_t len,
860 unsigned int flags)
861 {
862 ssize_t (*splice_read)(struct file *, loff_t *,
863 struct pipe_inode_info *, size_t, unsigned int);
864 int ret;
865
866 if (unlikely(!(in->f_mode & FMODE_READ)))
867 return -EBADF;
868
869 ret = rw_verify_area(READ, in, ppos, len);
870 if (unlikely(ret < 0))
871 return ret;
872
873 if (unlikely(len > MAX_RW_COUNT))
874 len = MAX_RW_COUNT;
875
876 if (in->f_op->splice_read)
877 splice_read = in->f_op->splice_read;
878 else
879 splice_read = default_file_splice_read;
880
881 return splice_read(in, ppos, pipe, len, flags);
882 }
883 EXPORT_SYMBOL_GPL(do_splice_to);
884
885 /**
886 * splice_direct_to_actor - splices data directly between two non-pipes
887 * @in: file to splice from
888 * @sd: actor information on where to splice to
889 * @actor: handles the data splicing
890 *
891 * Description:
892 * This is a special case helper to splice directly between two
893 * points, without requiring an explicit pipe. Internally an allocated
894 * pipe is cached in the process, and reused during the lifetime of
895 * that process.
896 *
897 */
898 ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
899 splice_direct_actor *actor)
900 {
901 struct pipe_inode_info *pipe;
902 long ret, bytes;
903 umode_t i_mode;
904 size_t len;
905 int i, flags, more;
906
907 /*
908 * We require the input being a regular file, as we don't want to
909 * randomly drop data for eg socket -> socket splicing. Use the
910 * piped splicing for that!
911 */
912 i_mode = file_inode(in)->i_mode;
913 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
914 return -EINVAL;
915
916 /*
917 * neither in nor out is a pipe, setup an internal pipe attached to
918 * 'out' and transfer the wanted data from 'in' to 'out' through that
919 */
920 pipe = current->splice_pipe;
921 if (unlikely(!pipe)) {
922 pipe = alloc_pipe_info();
923 if (!pipe)
924 return -ENOMEM;
925
926 /*
927 * We don't have an immediate reader, but we'll read the stuff
928 * out of the pipe right after the splice_to_pipe(). So set
929 * PIPE_READERS appropriately.
930 */
931 pipe->readers = 1;
932
933 current->splice_pipe = pipe;
934 }
935
936 /*
937 * Do the splice.
938 */
939 ret = 0;
940 bytes = 0;
941 len = sd->total_len;
942 flags = sd->flags;
943
944 /*
945 * Don't block on output, we have to drain the direct pipe.
946 */
947 sd->flags &= ~SPLICE_F_NONBLOCK;
948 more = sd->flags & SPLICE_F_MORE;
949
950 WARN_ON_ONCE(pipe->nrbufs != 0);
951
952 while (len) {
953 unsigned int pipe_pages;
954 size_t read_len;
955 loff_t pos = sd->pos, prev_pos = pos;
956
957 /* Don't try to read more the pipe has space for. */
958 pipe_pages = pipe->buffers - pipe->nrbufs;
959 read_len = min(len, (size_t)pipe_pages << PAGE_SHIFT);
960 ret = do_splice_to(in, &pos, pipe, read_len, flags);
961 if (unlikely(ret <= 0))
962 goto out_release;
963
964 read_len = ret;
965 sd->total_len = read_len;
966
967 /*
968 * If more data is pending, set SPLICE_F_MORE
969 * If this is the last data and SPLICE_F_MORE was not set
970 * initially, clears it.
971 */
972 if (read_len < len)
973 sd->flags |= SPLICE_F_MORE;
974 else if (!more)
975 sd->flags &= ~SPLICE_F_MORE;
976 /*
977 * NOTE: nonblocking mode only applies to the input. We
978 * must not do the output in nonblocking mode as then we
979 * could get stuck data in the internal pipe:
980 */
981 ret = actor(pipe, sd);
982 if (unlikely(ret <= 0)) {
983 sd->pos = prev_pos;
984 goto out_release;
985 }
986
987 bytes += ret;
988 len -= ret;
989 sd->pos = pos;
990
991 if (ret < read_len) {
992 sd->pos = prev_pos + ret;
993 goto out_release;
994 }
995 }
996
997 done:
998 pipe->nrbufs = pipe->curbuf = 0;
999 file_accessed(in);
1000 return bytes;
1001
1002 out_release:
1003 /*
1004 * If we did an incomplete transfer we must release
1005 * the pipe buffers in question:
1006 */
1007 for (i = 0; i < pipe->buffers; i++) {
1008 struct pipe_buffer *buf = pipe->bufs + i;
1009
1010 if (buf->ops)
1011 pipe_buf_release(pipe, buf);
1012 }
1013
1014 if (!bytes)
1015 bytes = ret;
1016
1017 goto done;
1018 }
1019 EXPORT_SYMBOL(splice_direct_to_actor);
1020
1021 static int direct_splice_actor(struct pipe_inode_info *pipe,
1022 struct splice_desc *sd)
1023 {
1024 struct file *file = sd->u.file;
1025
1026 return do_splice_from(pipe, file, sd->opos, sd->total_len,
1027 sd->flags);
1028 }
1029
1030 /**
1031 * do_splice_direct - splices data directly between two files
1032 * @in: file to splice from
1033 * @ppos: input file offset
1034 * @out: file to splice to
1035 * @opos: output file offset
1036 * @len: number of bytes to splice
1037 * @flags: splice modifier flags
1038 *
1039 * Description:
1040 * For use by do_sendfile(). splice can easily emulate sendfile, but
1041 * doing it in the application would incur an extra system call
1042 * (splice in + splice out, as compared to just sendfile()). So this helper
1043 * can splice directly through a process-private pipe.
1044 *
1045 */
1046 long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
1047 loff_t *opos, size_t len, unsigned int flags)
1048 {
1049 struct splice_desc sd = {
1050 .len = len,
1051 .total_len = len,
1052 .flags = flags,
1053 .pos = *ppos,
1054 .u.file = out,
1055 .opos = opos,
1056 };
1057 long ret;
1058
1059 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1060 return -EBADF;
1061
1062 if (unlikely(out->f_flags & O_APPEND))
1063 return -EINVAL;
1064
1065 ret = rw_verify_area(WRITE, out, opos, len);
1066 if (unlikely(ret < 0))
1067 return ret;
1068
1069 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
1070 if (ret > 0)
1071 *ppos = sd.pos;
1072
1073 return ret;
1074 }
1075 EXPORT_SYMBOL(do_splice_direct);
1076
1077 static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1078 {
1079 for (;;) {
1080 if (unlikely(!pipe->readers)) {
1081 send_sig(SIGPIPE, current, 0);
1082 return -EPIPE;
1083 }
1084 if (pipe->nrbufs != pipe->buffers)
1085 return 0;
1086 if (flags & SPLICE_F_NONBLOCK)
1087 return -EAGAIN;
1088 if (signal_pending(current))
1089 return -ERESTARTSYS;
1090 pipe->waiting_writers++;
1091 pipe_wait(pipe);
1092 pipe->waiting_writers--;
1093 }
1094 }
1095
1096 static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1097 struct pipe_inode_info *opipe,
1098 size_t len, unsigned int flags);
1099
1100 /*
1101 * Determine where to splice to/from.
1102 */
1103 static long do_splice(struct file *in, loff_t __user *off_in,
1104 struct file *out, loff_t __user *off_out,
1105 size_t len, unsigned int flags)
1106 {
1107 struct pipe_inode_info *ipipe;
1108 struct pipe_inode_info *opipe;
1109 loff_t offset;
1110 long ret;
1111
1112 ipipe = get_pipe_info(in);
1113 opipe = get_pipe_info(out);
1114
1115 if (ipipe && opipe) {
1116 if (off_in || off_out)
1117 return -ESPIPE;
1118
1119 if (!(in->f_mode & FMODE_READ))
1120 return -EBADF;
1121
1122 if (!(out->f_mode & FMODE_WRITE))
1123 return -EBADF;
1124
1125 /* Splicing to self would be fun, but... */
1126 if (ipipe == opipe)
1127 return -EINVAL;
1128
1129 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1130 }
1131
1132 if (ipipe) {
1133 if (off_in)
1134 return -ESPIPE;
1135 if (off_out) {
1136 if (!(out->f_mode & FMODE_PWRITE))
1137 return -EINVAL;
1138 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
1139 return -EFAULT;
1140 } else {
1141 offset = out->f_pos;
1142 }
1143
1144 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1145 return -EBADF;
1146
1147 if (unlikely(out->f_flags & O_APPEND))
1148 return -EINVAL;
1149
1150 ret = rw_verify_area(WRITE, out, &offset, len);
1151 if (unlikely(ret < 0))
1152 return ret;
1153
1154 file_start_write(out);
1155 ret = do_splice_from(ipipe, out, &offset, len, flags);
1156 file_end_write(out);
1157
1158 if (!off_out)
1159 out->f_pos = offset;
1160 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
1161 ret = -EFAULT;
1162
1163 return ret;
1164 }
1165
1166 if (opipe) {
1167 if (off_out)
1168 return -ESPIPE;
1169 if (off_in) {
1170 if (!(in->f_mode & FMODE_PREAD))
1171 return -EINVAL;
1172 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
1173 return -EFAULT;
1174 } else {
1175 offset = in->f_pos;
1176 }
1177
1178 pipe_lock(opipe);
1179 ret = wait_for_space(opipe, flags);
1180 if (!ret) {
1181 unsigned int pipe_pages;
1182
1183 /* Don't try to read more the pipe has space for. */
1184 pipe_pages = opipe->buffers - opipe->nrbufs;
1185 len = min(len, (size_t)pipe_pages << PAGE_SHIFT);
1186
1187 ret = do_splice_to(in, &offset, opipe, len, flags);
1188 }
1189 pipe_unlock(opipe);
1190 if (ret > 0)
1191 wakeup_pipe_readers(opipe);
1192 if (!off_in)
1193 in->f_pos = offset;
1194 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
1195 ret = -EFAULT;
1196
1197 return ret;
1198 }
1199
1200 return -EINVAL;
1201 }
1202
1203 static int iter_to_pipe(struct iov_iter *from,
1204 struct pipe_inode_info *pipe,
1205 unsigned flags)
1206 {
1207 struct pipe_buffer buf = {
1208 .ops = &user_page_pipe_buf_ops,
1209 .flags = flags
1210 };
1211 size_t total = 0;
1212 int ret = 0;
1213 bool failed = false;
1214
1215 while (iov_iter_count(from) && !failed) {
1216 struct page *pages[16];
1217 ssize_t copied;
1218 size_t start;
1219 int n;
1220
1221 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1222 if (copied <= 0) {
1223 ret = copied;
1224 break;
1225 }
1226
1227 for (n = 0; copied; n++, start = 0) {
1228 int size = min_t(int, copied, PAGE_SIZE - start);
1229 if (!failed) {
1230 buf.page = pages[n];
1231 buf.offset = start;
1232 buf.len = size;
1233 ret = add_to_pipe(pipe, &buf);
1234 if (unlikely(ret < 0)) {
1235 failed = true;
1236 } else {
1237 iov_iter_advance(from, ret);
1238 total += ret;
1239 }
1240 } else {
1241 put_page(pages[n]);
1242 }
1243 copied -= size;
1244 }
1245 }
1246 return total ? total : ret;
1247 }
1248
1249 static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1250 struct splice_desc *sd)
1251 {
1252 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1253 return n == sd->len ? n : -EFAULT;
1254 }
1255
1256 /*
1257 * For lack of a better implementation, implement vmsplice() to userspace
1258 * as a simple copy of the pipes pages to the user iov.
1259 */
1260 static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
1261 unsigned long nr_segs, unsigned int flags)
1262 {
1263 struct pipe_inode_info *pipe;
1264 struct splice_desc sd;
1265 long ret;
1266 struct iovec iovstack[UIO_FASTIOV];
1267 struct iovec *iov = iovstack;
1268 struct iov_iter iter;
1269
1270 pipe = get_pipe_info(file);
1271 if (!pipe)
1272 return -EBADF;
1273
1274 ret = import_iovec(READ, uiov, nr_segs,
1275 ARRAY_SIZE(iovstack), &iov, &iter);
1276 if (ret < 0)
1277 return ret;
1278
1279 sd.total_len = iov_iter_count(&iter);
1280 sd.len = 0;
1281 sd.flags = flags;
1282 sd.u.data = &iter;
1283 sd.pos = 0;
1284
1285 if (sd.total_len) {
1286 pipe_lock(pipe);
1287 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1288 pipe_unlock(pipe);
1289 }
1290
1291 kfree(iov);
1292 return ret;
1293 }
1294
1295 /*
1296 * vmsplice splices a user address range into a pipe. It can be thought of
1297 * as splice-from-memory, where the regular splice is splice-from-file (or
1298 * to file). In both cases the output is a pipe, naturally.
1299 */
1300 static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
1301 unsigned long nr_segs, unsigned int flags)
1302 {
1303 struct pipe_inode_info *pipe;
1304 struct iovec iovstack[UIO_FASTIOV];
1305 struct iovec *iov = iovstack;
1306 struct iov_iter from;
1307 long ret;
1308 unsigned buf_flag = 0;
1309
1310 if (flags & SPLICE_F_GIFT)
1311 buf_flag = PIPE_BUF_FLAG_GIFT;
1312
1313 pipe = get_pipe_info(file);
1314 if (!pipe)
1315 return -EBADF;
1316
1317 ret = import_iovec(WRITE, uiov, nr_segs,
1318 ARRAY_SIZE(iovstack), &iov, &from);
1319 if (ret < 0)
1320 return ret;
1321
1322 pipe_lock(pipe);
1323 ret = wait_for_space(pipe, flags);
1324 if (!ret)
1325 ret = iter_to_pipe(&from, pipe, buf_flag);
1326 pipe_unlock(pipe);
1327 if (ret > 0)
1328 wakeup_pipe_readers(pipe);
1329 kfree(iov);
1330 return ret;
1331 }
1332
1333 /*
1334 * Note that vmsplice only really supports true splicing _from_ user memory
1335 * to a pipe, not the other way around. Splicing from user memory is a simple
1336 * operation that can be supported without any funky alignment restrictions
1337 * or nasty vm tricks. We simply map in the user memory and fill them into
1338 * a pipe. The reverse isn't quite as easy, though. There are two possible
1339 * solutions for that:
1340 *
1341 * - memcpy() the data internally, at which point we might as well just
1342 * do a regular read() on the buffer anyway.
1343 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1344 * has restriction limitations on both ends of the pipe).
1345 *
1346 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1347 *
1348 */
1349 SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1350 unsigned long, nr_segs, unsigned int, flags)
1351 {
1352 struct fd f;
1353 long error;
1354
1355 if (unlikely(flags & ~SPLICE_F_ALL))
1356 return -EINVAL;
1357 if (unlikely(nr_segs > UIO_MAXIOV))
1358 return -EINVAL;
1359 else if (unlikely(!nr_segs))
1360 return 0;
1361
1362 error = -EBADF;
1363 f = fdget(fd);
1364 if (f.file) {
1365 if (f.file->f_mode & FMODE_WRITE)
1366 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1367 else if (f.file->f_mode & FMODE_READ)
1368 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
1369
1370 fdput(f);
1371 }
1372
1373 return error;
1374 }
1375
1376 #ifdef CONFIG_COMPAT
1377 COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1378 unsigned int, nr_segs, unsigned int, flags)
1379 {
1380 unsigned i;
1381 struct iovec __user *iov;
1382 if (nr_segs > UIO_MAXIOV)
1383 return -EINVAL;
1384 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1385 for (i = 0; i < nr_segs; i++) {
1386 struct compat_iovec v;
1387 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1388 get_user(v.iov_len, &iov32[i].iov_len) ||
1389 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1390 put_user(v.iov_len, &iov[i].iov_len))
1391 return -EFAULT;
1392 }
1393 return sys_vmsplice(fd, iov, nr_segs, flags);
1394 }
1395 #endif
1396
1397 SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1398 int, fd_out, loff_t __user *, off_out,
1399 size_t, len, unsigned int, flags)
1400 {
1401 struct fd in, out;
1402 long error;
1403
1404 if (unlikely(!len))
1405 return 0;
1406
1407 if (unlikely(flags & ~SPLICE_F_ALL))
1408 return -EINVAL;
1409
1410 error = -EBADF;
1411 in = fdget(fd_in);
1412 if (in.file) {
1413 if (in.file->f_mode & FMODE_READ) {
1414 out = fdget(fd_out);
1415 if (out.file) {
1416 if (out.file->f_mode & FMODE_WRITE)
1417 error = do_splice(in.file, off_in,
1418 out.file, off_out,
1419 len, flags);
1420 fdput(out);
1421 }
1422 }
1423 fdput(in);
1424 }
1425 return error;
1426 }
1427
1428 /*
1429 * Make sure there's data to read. Wait for input if we can, otherwise
1430 * return an appropriate error.
1431 */
1432 static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1433 {
1434 int ret;
1435
1436 /*
1437 * Check ->nrbufs without the inode lock first. This function
1438 * is speculative anyways, so missing one is ok.
1439 */
1440 if (pipe->nrbufs)
1441 return 0;
1442
1443 ret = 0;
1444 pipe_lock(pipe);
1445
1446 while (!pipe->nrbufs) {
1447 if (signal_pending(current)) {
1448 ret = -ERESTARTSYS;
1449 break;
1450 }
1451 if (!pipe->writers)
1452 break;
1453 if (!pipe->waiting_writers) {
1454 if (flags & SPLICE_F_NONBLOCK) {
1455 ret = -EAGAIN;
1456 break;
1457 }
1458 }
1459 pipe_wait(pipe);
1460 }
1461
1462 pipe_unlock(pipe);
1463 return ret;
1464 }
1465
1466 /*
1467 * Make sure there's writeable room. Wait for room if we can, otherwise
1468 * return an appropriate error.
1469 */
1470 static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1471 {
1472 int ret;
1473
1474 /*
1475 * Check ->nrbufs without the inode lock first. This function
1476 * is speculative anyways, so missing one is ok.
1477 */
1478 if (pipe->nrbufs < pipe->buffers)
1479 return 0;
1480
1481 ret = 0;
1482 pipe_lock(pipe);
1483
1484 while (pipe->nrbufs >= pipe->buffers) {
1485 if (!pipe->readers) {
1486 send_sig(SIGPIPE, current, 0);
1487 ret = -EPIPE;
1488 break;
1489 }
1490 if (flags & SPLICE_F_NONBLOCK) {
1491 ret = -EAGAIN;
1492 break;
1493 }
1494 if (signal_pending(current)) {
1495 ret = -ERESTARTSYS;
1496 break;
1497 }
1498 pipe->waiting_writers++;
1499 pipe_wait(pipe);
1500 pipe->waiting_writers--;
1501 }
1502
1503 pipe_unlock(pipe);
1504 return ret;
1505 }
1506
1507 /*
1508 * Splice contents of ipipe to opipe.
1509 */
1510 static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1511 struct pipe_inode_info *opipe,
1512 size_t len, unsigned int flags)
1513 {
1514 struct pipe_buffer *ibuf, *obuf;
1515 int ret = 0, nbuf;
1516 bool input_wakeup = false;
1517
1518
1519 retry:
1520 ret = ipipe_prep(ipipe, flags);
1521 if (ret)
1522 return ret;
1523
1524 ret = opipe_prep(opipe, flags);
1525 if (ret)
1526 return ret;
1527
1528 /*
1529 * Potential ABBA deadlock, work around it by ordering lock
1530 * grabbing by pipe info address. Otherwise two different processes
1531 * could deadlock (one doing tee from A -> B, the other from B -> A).
1532 */
1533 pipe_double_lock(ipipe, opipe);
1534
1535 do {
1536 if (!opipe->readers) {
1537 send_sig(SIGPIPE, current, 0);
1538 if (!ret)
1539 ret = -EPIPE;
1540 break;
1541 }
1542
1543 if (!ipipe->nrbufs && !ipipe->writers)
1544 break;
1545
1546 /*
1547 * Cannot make any progress, because either the input
1548 * pipe is empty or the output pipe is full.
1549 */
1550 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
1551 /* Already processed some buffers, break */
1552 if (ret)
1553 break;
1554
1555 if (flags & SPLICE_F_NONBLOCK) {
1556 ret = -EAGAIN;
1557 break;
1558 }
1559
1560 /*
1561 * We raced with another reader/writer and haven't
1562 * managed to process any buffers. A zero return
1563 * value means EOF, so retry instead.
1564 */
1565 pipe_unlock(ipipe);
1566 pipe_unlock(opipe);
1567 goto retry;
1568 }
1569
1570 ibuf = ipipe->bufs + ipipe->curbuf;
1571 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1572 obuf = opipe->bufs + nbuf;
1573
1574 if (len >= ibuf->len) {
1575 /*
1576 * Simply move the whole buffer from ipipe to opipe
1577 */
1578 *obuf = *ibuf;
1579 ibuf->ops = NULL;
1580 opipe->nrbufs++;
1581 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
1582 ipipe->nrbufs--;
1583 input_wakeup = true;
1584 } else {
1585 /*
1586 * Get a reference to this pipe buffer,
1587 * so we can copy the contents over.
1588 */
1589 if (!pipe_buf_get(ipipe, ibuf)) {
1590 if (ret == 0)
1591 ret = -EFAULT;
1592 break;
1593 }
1594 *obuf = *ibuf;
1595
1596 /*
1597 * Don't inherit the gift flag, we need to
1598 * prevent multiple steals of this page.
1599 */
1600 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1601
1602 pipe_buf_mark_unmergeable(obuf);
1603
1604 obuf->len = len;
1605 opipe->nrbufs++;
1606 ibuf->offset += obuf->len;
1607 ibuf->len -= obuf->len;
1608 }
1609 ret += obuf->len;
1610 len -= obuf->len;
1611 } while (len);
1612
1613 pipe_unlock(ipipe);
1614 pipe_unlock(opipe);
1615
1616 /*
1617 * If we put data in the output pipe, wakeup any potential readers.
1618 */
1619 if (ret > 0)
1620 wakeup_pipe_readers(opipe);
1621
1622 if (input_wakeup)
1623 wakeup_pipe_writers(ipipe);
1624
1625 return ret;
1626 }
1627
1628 /*
1629 * Link contents of ipipe to opipe.
1630 */
1631 static int link_pipe(struct pipe_inode_info *ipipe,
1632 struct pipe_inode_info *opipe,
1633 size_t len, unsigned int flags)
1634 {
1635 struct pipe_buffer *ibuf, *obuf;
1636 int ret = 0, i = 0, nbuf;
1637
1638 /*
1639 * Potential ABBA deadlock, work around it by ordering lock
1640 * grabbing by pipe info address. Otherwise two different processes
1641 * could deadlock (one doing tee from A -> B, the other from B -> A).
1642 */
1643 pipe_double_lock(ipipe, opipe);
1644
1645 do {
1646 if (!opipe->readers) {
1647 send_sig(SIGPIPE, current, 0);
1648 if (!ret)
1649 ret = -EPIPE;
1650 break;
1651 }
1652
1653 /*
1654 * If we have iterated all input buffers or ran out of
1655 * output room, break.
1656 */
1657 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
1658 break;
1659
1660 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1661 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1662
1663 /*
1664 * Get a reference to this pipe buffer,
1665 * so we can copy the contents over.
1666 */
1667 if (!pipe_buf_get(ipipe, ibuf)) {
1668 if (ret == 0)
1669 ret = -EFAULT;
1670 break;
1671 }
1672
1673 obuf = opipe->bufs + nbuf;
1674 *obuf = *ibuf;
1675
1676 /*
1677 * Don't inherit the gift flag, we need to
1678 * prevent multiple steals of this page.
1679 */
1680 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1681
1682 pipe_buf_mark_unmergeable(obuf);
1683
1684 if (obuf->len > len)
1685 obuf->len = len;
1686
1687 opipe->nrbufs++;
1688 ret += obuf->len;
1689 len -= obuf->len;
1690 i++;
1691 } while (len);
1692
1693 /*
1694 * return EAGAIN if we have the potential of some data in the
1695 * future, otherwise just return 0
1696 */
1697 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1698 ret = -EAGAIN;
1699
1700 pipe_unlock(ipipe);
1701 pipe_unlock(opipe);
1702
1703 /*
1704 * If we put data in the output pipe, wakeup any potential readers.
1705 */
1706 if (ret > 0)
1707 wakeup_pipe_readers(opipe);
1708
1709 return ret;
1710 }
1711
1712 /*
1713 * This is a tee(1) implementation that works on pipes. It doesn't copy
1714 * any data, it simply references the 'in' pages on the 'out' pipe.
1715 * The 'flags' used are the SPLICE_F_* variants, currently the only
1716 * applicable one is SPLICE_F_NONBLOCK.
1717 */
1718 static long do_tee(struct file *in, struct file *out, size_t len,
1719 unsigned int flags)
1720 {
1721 struct pipe_inode_info *ipipe = get_pipe_info(in);
1722 struct pipe_inode_info *opipe = get_pipe_info(out);
1723 int ret = -EINVAL;
1724
1725 /*
1726 * Duplicate the contents of ipipe to opipe without actually
1727 * copying the data.
1728 */
1729 if (ipipe && opipe && ipipe != opipe) {
1730 /*
1731 * Keep going, unless we encounter an error. The ipipe/opipe
1732 * ordering doesn't really matter.
1733 */
1734 ret = ipipe_prep(ipipe, flags);
1735 if (!ret) {
1736 ret = opipe_prep(opipe, flags);
1737 if (!ret)
1738 ret = link_pipe(ipipe, opipe, len, flags);
1739 }
1740 }
1741
1742 return ret;
1743 }
1744
1745 SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
1746 {
1747 struct fd in;
1748 int error;
1749
1750 if (unlikely(flags & ~SPLICE_F_ALL))
1751 return -EINVAL;
1752
1753 if (unlikely(!len))
1754 return 0;
1755
1756 error = -EBADF;
1757 in = fdget(fdin);
1758 if (in.file) {
1759 if (in.file->f_mode & FMODE_READ) {
1760 struct fd out = fdget(fdout);
1761 if (out.file) {
1762 if (out.file->f_mode & FMODE_WRITE)
1763 error = do_tee(in.file, out.file,
1764 len, flags);
1765 fdput(out);
1766 }
1767 }
1768 fdput(in);
1769 }
1770
1771 return error;
1772 }