2 * "splice": joining two ropes together by interweaving their strands.
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.
8 * The traditional unix read/write is extended with a "splice()" operation
9 * that transfers data buffers to or from a pipe buffer.
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.
20 #include <linux/bvec.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>
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.
46 static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
47 struct pipe_buffer *buf)
49 struct page *page = buf->page;
50 struct address_space *mapping;
54 mapping = page_mapping(page);
56 WARN_ON(!PageUptodate(page));
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
66 wait_on_page_writeback(page);
68 if (page_has_private(page) &&
69 !try_to_release_page(page, GFP_KERNEL))
73 * If we succeeded in removing the mapping, set LRU flag
76 if (remove_mapping(mapping, page)) {
77 buf->flags |= PIPE_BUF_FLAG_LRU;
83 * Raced with truncate or failed to remove page from current
84 * address space, unlock and return failure.
91 static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
92 struct pipe_buffer *buf)
95 buf->flags &= ~PIPE_BUF_FLAG_LRU;
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.
102 static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
103 struct pipe_buffer *buf)
105 struct page *page = buf->page;
108 if (!PageUptodate(page)) {
112 * Page got truncated/unhashed. This will cause a 0-byte
113 * splice, if this is the first page.
115 if (!page->mapping) {
121 * Uh oh, read-error from disk.
123 if (!PageUptodate(page)) {
129 * Page is ok afterall, we are done.
140 const struct pipe_buf_operations page_cache_pipe_buf_ops = {
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,
148 static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
149 struct pipe_buffer *buf)
151 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
154 buf->flags |= PIPE_BUF_FLAG_LRU;
155 return generic_pipe_buf_steal(pipe, buf);
158 static const struct pipe_buf_operations user_page_pipe_buf_ops = {
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,
166 static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
169 if (waitqueue_active(&pipe->wait))
170 wake_up_interruptible(&pipe->wait);
171 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
175 * splice_to_pipe - fill passed data into a pipe
176 * @pipe: pipe to fill
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.
185 ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
186 struct splice_pipe_desc *spd)
188 unsigned int spd_pages = spd->nr_pages;
189 int ret = 0, page_nr = 0;
194 if (unlikely(!pipe->readers)) {
195 send_sig(SIGPIPE, current, 0);
200 while (pipe->nrbufs < pipe->buffers) {
201 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
202 struct pipe_buffer *buf = pipe->bufs + newbuf;
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;
215 if (!--spd->nr_pages)
223 while (page_nr < spd_pages)
224 spd->spd_release(spd, page_nr++);
228 EXPORT_SYMBOL_GPL(splice_to_pipe);
230 ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
234 if (unlikely(!pipe->readers)) {
235 send_sig(SIGPIPE, current, 0);
237 } else if (pipe->nrbufs == pipe->buffers) {
240 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
241 pipe->bufs[newbuf] = *buf;
245 pipe_buf_release(pipe, buf);
248 EXPORT_SYMBOL(add_to_pipe);
251 * Check if we need to grow the arrays holding pages and partial page
254 int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
256 unsigned int buffers = ACCESS_ONCE(pipe->buffers);
258 spd->nr_pages_max = buffers;
259 if (buffers <= PIPE_DEF_BUFFERS)
262 spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
263 spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
265 if (spd->pages && spd->partial)
273 void splice_shrink_spd(struct splice_pipe_desc *spd)
275 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
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
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().
295 ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
296 struct pipe_inode_info *pipe, size_t len,
303 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len);
305 init_sync_kiocb(&kiocb, in);
306 kiocb.ki_pos = *ppos;
307 ret = call_read_iter(in, &kiocb, &to);
309 *ppos = kiocb.ki_pos;
311 } else if (ret < 0) {
314 iov_iter_advance(&to, 0); /* to free what was emitted */
316 * callers of ->splice_read() expect -EAGAIN on
317 * "can't put anything in there", rather than -EFAULT.
325 EXPORT_SYMBOL(generic_file_splice_read);
327 const struct pipe_buf_operations default_pipe_buf_ops = {
329 .confirm = generic_pipe_buf_confirm,
330 .release = generic_pipe_buf_release,
331 .steal = generic_pipe_buf_steal,
332 .get = generic_pipe_buf_get,
335 static int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
336 struct pipe_buffer *buf)
341 /* Pipe buffer operations for a socket and similar. */
342 const struct pipe_buf_operations nosteal_pipe_buf_ops = {
344 .confirm = generic_pipe_buf_confirm,
345 .release = generic_pipe_buf_release,
346 .steal = generic_pipe_buf_nosteal,
347 .get = generic_pipe_buf_get,
349 EXPORT_SYMBOL(nosteal_pipe_buf_ops);
351 static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
352 unsigned long vlen, loff_t offset)
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);
367 ssize_t kernel_write(struct file *file, const char *buf, size_t count,
375 /* The cast to a user pointer is valid due to the set_fs() */
376 res = vfs_write(file, (__force const char __user *)buf, count, &pos);
381 EXPORT_SYMBOL(kernel_write);
383 static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
384 struct pipe_inode_info *pipe, size_t len,
387 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
390 unsigned int nr_pages;
391 size_t offset, base, copied = 0;
395 if (pipe->nrbufs == pipe->buffers)
399 * Try to keep page boundaries matching to source pagecache ones -
400 * it probably won't be much help, but...
402 offset = *ppos & ~PAGE_MASK;
404 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
406 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &base);
410 nr_pages = DIV_ROUND_UP(res + base, PAGE_SIZE);
413 if (nr_pages > PIPE_DEF_BUFFERS) {
414 vec = kmalloc(nr_pages * sizeof(struct kvec), GFP_KERNEL);
415 if (unlikely(!vec)) {
421 pipe->bufs[to.idx].offset = offset;
422 pipe->bufs[to.idx].len -= offset;
424 for (i = 0; i < nr_pages; i++) {
425 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
426 vec[i].iov_base = page_address(pages[i]) + offset;
427 vec[i].iov_len = this_len;
432 res = kernel_readv(in, vec, nr_pages, *ppos);
441 for (i = 0; i < nr_pages; i++)
444 iov_iter_advance(&to, copied); /* truncates and discards */
449 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
450 * using sendpage(). Return the number of bytes sent.
452 static int pipe_to_sendpage(struct pipe_inode_info *pipe,
453 struct pipe_buffer *buf, struct splice_desc *sd)
455 struct file *file = sd->u.file;
456 loff_t pos = sd->pos;
459 if (!likely(file->f_op->sendpage))
462 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
464 if (sd->len < sd->total_len && pipe->nrbufs > 1)
465 more |= MSG_SENDPAGE_NOTLAST;
467 return file->f_op->sendpage(file, buf->page, buf->offset,
468 sd->len, &pos, more);
471 static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
474 if (waitqueue_active(&pipe->wait))
475 wake_up_interruptible(&pipe->wait);
476 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
480 * splice_from_pipe_feed - feed available data from a pipe to a file
481 * @pipe: pipe to splice from
482 * @sd: information to @actor
483 * @actor: handler that splices the data
486 * This function loops over the pipe and calls @actor to do the
487 * actual moving of a single struct pipe_buffer to the desired
488 * destination. It returns when there's no more buffers left in
489 * the pipe or if the requested number of bytes (@sd->total_len)
490 * have been copied. It returns a positive number (one) if the
491 * pipe needs to be filled with more data, zero if the required
492 * number of bytes have been copied and -errno on error.
494 * This, together with splice_from_pipe_{begin,end,next}, may be
495 * used to implement the functionality of __splice_from_pipe() when
496 * locking is required around copying the pipe buffers to the
499 static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
504 while (pipe->nrbufs) {
505 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
508 if (sd->len > sd->total_len)
509 sd->len = sd->total_len;
511 ret = pipe_buf_confirm(pipe, buf);
518 ret = actor(pipe, buf, sd);
525 sd->num_spliced += ret;
528 sd->total_len -= ret;
531 pipe_buf_release(pipe, buf);
532 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
535 sd->need_wakeup = true;
546 * splice_from_pipe_next - wait for some data to splice from
547 * @pipe: pipe to splice from
548 * @sd: information about the splice operation
551 * This function will wait for some data and return a positive
552 * value (one) if pipe buffers are available. It will return zero
553 * or -errno if no more data needs to be spliced.
555 static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
558 * Check for signal early to make process killable when there are
559 * always buffers available
561 if (signal_pending(current))
564 while (!pipe->nrbufs) {
568 if (!pipe->waiting_writers && sd->num_spliced)
571 if (sd->flags & SPLICE_F_NONBLOCK)
574 if (signal_pending(current))
577 if (sd->need_wakeup) {
578 wakeup_pipe_writers(pipe);
579 sd->need_wakeup = false;
589 * splice_from_pipe_begin - start splicing from pipe
590 * @sd: information about the splice operation
593 * This function should be called before a loop containing
594 * splice_from_pipe_next() and splice_from_pipe_feed() to
595 * initialize the necessary fields of @sd.
597 static void splice_from_pipe_begin(struct splice_desc *sd)
600 sd->need_wakeup = false;
604 * splice_from_pipe_end - finish splicing from pipe
605 * @pipe: pipe to splice from
606 * @sd: information about the splice operation
609 * This function will wake up pipe writers if necessary. It should
610 * be called after a loop containing splice_from_pipe_next() and
611 * splice_from_pipe_feed().
613 static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
616 wakeup_pipe_writers(pipe);
620 * __splice_from_pipe - splice data from a pipe to given actor
621 * @pipe: pipe to splice from
622 * @sd: information to @actor
623 * @actor: handler that splices the data
626 * This function does little more than loop over the pipe and call
627 * @actor to do the actual moving of a single struct pipe_buffer to
628 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
632 ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
637 splice_from_pipe_begin(sd);
640 ret = splice_from_pipe_next(pipe, sd);
642 ret = splice_from_pipe_feed(pipe, sd, actor);
644 splice_from_pipe_end(pipe, sd);
646 return sd->num_spliced ? sd->num_spliced : ret;
648 EXPORT_SYMBOL(__splice_from_pipe);
651 * splice_from_pipe - splice data from a pipe to a file
652 * @pipe: pipe to splice from
653 * @out: file to splice to
654 * @ppos: position in @out
655 * @len: how many bytes to splice
656 * @flags: splice modifier flags
657 * @actor: handler that splices the data
660 * See __splice_from_pipe. This function locks the pipe inode,
661 * otherwise it's identical to __splice_from_pipe().
664 ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
665 loff_t *ppos, size_t len, unsigned int flags,
669 struct splice_desc sd = {
677 ret = __splice_from_pipe(pipe, &sd, actor);
684 * iter_file_splice_write - splice data from a pipe to a file
686 * @out: file to write to
687 * @ppos: position in @out
688 * @len: number of bytes to splice
689 * @flags: splice modifier flags
692 * Will either move or copy pages (determined by @flags options) from
693 * the given pipe inode to the given file.
694 * This one is ->write_iter-based.
698 iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
699 loff_t *ppos, size_t len, unsigned int flags)
701 struct splice_desc sd = {
707 int nbufs = pipe->buffers;
708 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
712 if (unlikely(!array))
717 splice_from_pipe_begin(&sd);
718 while (sd.total_len) {
719 struct iov_iter from;
723 ret = splice_from_pipe_next(pipe, &sd);
727 if (unlikely(nbufs < pipe->buffers)) {
729 nbufs = pipe->buffers;
730 array = kcalloc(nbufs, sizeof(struct bio_vec),
738 /* build the vector */
740 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
741 struct pipe_buffer *buf = pipe->bufs + idx;
742 size_t this_len = buf->len;
747 if (idx == pipe->buffers - 1)
750 ret = pipe_buf_confirm(pipe, buf);
757 array[n].bv_page = buf->page;
758 array[n].bv_len = this_len;
759 array[n].bv_offset = buf->offset;
763 iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
764 sd.total_len - left);
765 ret = vfs_iter_write(out, &from, &sd.pos);
769 sd.num_spliced += ret;
773 /* dismiss the fully eaten buffers, adjust the partial one */
775 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
776 if (ret >= buf->len) {
779 pipe_buf_release(pipe, buf);
780 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
783 sd.need_wakeup = true;
793 splice_from_pipe_end(pipe, &sd);
798 ret = sd.num_spliced;
803 EXPORT_SYMBOL(iter_file_splice_write);
805 static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
806 struct splice_desc *sd)
810 loff_t tmp = sd->pos;
812 data = kmap(buf->page);
813 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
819 static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
820 struct file *out, loff_t *ppos,
821 size_t len, unsigned int flags)
825 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
833 * generic_splice_sendpage - splice data from a pipe to a socket
834 * @pipe: pipe to splice from
835 * @out: socket to write to
836 * @ppos: position in @out
837 * @len: number of bytes to splice
838 * @flags: splice modifier flags
841 * Will send @len bytes from the pipe to a network socket. No data copying
845 ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
846 loff_t *ppos, size_t len, unsigned int flags)
848 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
851 EXPORT_SYMBOL(generic_splice_sendpage);
854 * Attempt to initiate a splice from pipe to file.
856 static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
857 loff_t *ppos, size_t len, unsigned int flags)
859 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
860 loff_t *, size_t, unsigned int);
862 if (out->f_op->splice_write)
863 splice_write = out->f_op->splice_write;
865 splice_write = default_file_splice_write;
867 return splice_write(pipe, out, ppos, len, flags);
871 * Attempt to initiate a splice from a file to a pipe.
873 static long do_splice_to(struct file *in, loff_t *ppos,
874 struct pipe_inode_info *pipe, size_t len,
877 ssize_t (*splice_read)(struct file *, loff_t *,
878 struct pipe_inode_info *, size_t, unsigned int);
881 if (unlikely(!(in->f_mode & FMODE_READ)))
884 ret = rw_verify_area(READ, in, ppos, len);
885 if (unlikely(ret < 0))
888 if (unlikely(len > MAX_RW_COUNT))
891 if (in->f_op->splice_read)
892 splice_read = in->f_op->splice_read;
894 splice_read = default_file_splice_read;
896 return splice_read(in, ppos, pipe, len, flags);
900 * splice_direct_to_actor - splices data directly between two non-pipes
901 * @in: file to splice from
902 * @sd: actor information on where to splice to
903 * @actor: handles the data splicing
906 * This is a special case helper to splice directly between two
907 * points, without requiring an explicit pipe. Internally an allocated
908 * pipe is cached in the process, and reused during the lifetime of
912 ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
913 splice_direct_actor *actor)
915 struct pipe_inode_info *pipe;
922 * We require the input being a regular file, as we don't want to
923 * randomly drop data for eg socket -> socket splicing. Use the
924 * piped splicing for that!
926 i_mode = file_inode(in)->i_mode;
927 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
931 * neither in nor out is a pipe, setup an internal pipe attached to
932 * 'out' and transfer the wanted data from 'in' to 'out' through that
934 pipe = current->splice_pipe;
935 if (unlikely(!pipe)) {
936 pipe = alloc_pipe_info();
941 * We don't have an immediate reader, but we'll read the stuff
942 * out of the pipe right after the splice_to_pipe(). So set
943 * PIPE_READERS appropriately.
947 current->splice_pipe = pipe;
959 * Don't block on output, we have to drain the direct pipe.
961 sd->flags &= ~SPLICE_F_NONBLOCK;
962 more = sd->flags & SPLICE_F_MORE;
966 loff_t pos = sd->pos, prev_pos = pos;
968 ret = do_splice_to(in, &pos, pipe, len, flags);
969 if (unlikely(ret <= 0))
973 sd->total_len = read_len;
976 * If more data is pending, set SPLICE_F_MORE
977 * If this is the last data and SPLICE_F_MORE was not set
978 * initially, clears it.
981 sd->flags |= SPLICE_F_MORE;
983 sd->flags &= ~SPLICE_F_MORE;
985 * NOTE: nonblocking mode only applies to the input. We
986 * must not do the output in nonblocking mode as then we
987 * could get stuck data in the internal pipe:
989 ret = actor(pipe, sd);
990 if (unlikely(ret <= 0)) {
999 if (ret < read_len) {
1000 sd->pos = prev_pos + ret;
1006 pipe->nrbufs = pipe->curbuf = 0;
1012 * If we did an incomplete transfer we must release
1013 * the pipe buffers in question:
1015 for (i = 0; i < pipe->buffers; i++) {
1016 struct pipe_buffer *buf = pipe->bufs + i;
1019 pipe_buf_release(pipe, buf);
1027 EXPORT_SYMBOL(splice_direct_to_actor);
1029 static int direct_splice_actor(struct pipe_inode_info *pipe,
1030 struct splice_desc *sd)
1032 struct file *file = sd->u.file;
1034 return do_splice_from(pipe, file, sd->opos, sd->total_len,
1039 * do_splice_direct - splices data directly between two files
1040 * @in: file to splice from
1041 * @ppos: input file offset
1042 * @out: file to splice to
1043 * @opos: output file offset
1044 * @len: number of bytes to splice
1045 * @flags: splice modifier flags
1048 * For use by do_sendfile(). splice can easily emulate sendfile, but
1049 * doing it in the application would incur an extra system call
1050 * (splice in + splice out, as compared to just sendfile()). So this helper
1051 * can splice directly through a process-private pipe.
1054 long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
1055 loff_t *opos, size_t len, unsigned int flags)
1057 struct splice_desc sd = {
1067 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1070 if (unlikely(out->f_flags & O_APPEND))
1073 ret = rw_verify_area(WRITE, out, opos, len);
1074 if (unlikely(ret < 0))
1077 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
1083 EXPORT_SYMBOL(do_splice_direct);
1085 static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1088 if (unlikely(!pipe->readers)) {
1089 send_sig(SIGPIPE, current, 0);
1092 if (pipe->nrbufs != pipe->buffers)
1094 if (flags & SPLICE_F_NONBLOCK)
1096 if (signal_pending(current))
1097 return -ERESTARTSYS;
1098 pipe->waiting_writers++;
1100 pipe->waiting_writers--;
1104 static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1105 struct pipe_inode_info *opipe,
1106 size_t len, unsigned int flags);
1109 * Determine where to splice to/from.
1111 static long do_splice(struct file *in, loff_t __user *off_in,
1112 struct file *out, loff_t __user *off_out,
1113 size_t len, unsigned int flags)
1115 struct pipe_inode_info *ipipe;
1116 struct pipe_inode_info *opipe;
1120 ipipe = get_pipe_info(in);
1121 opipe = get_pipe_info(out);
1123 if (ipipe && opipe) {
1124 if (off_in || off_out)
1127 if (!(in->f_mode & FMODE_READ))
1130 if (!(out->f_mode & FMODE_WRITE))
1133 /* Splicing to self would be fun, but... */
1137 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1144 if (!(out->f_mode & FMODE_PWRITE))
1146 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
1149 offset = out->f_pos;
1152 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1155 if (unlikely(out->f_flags & O_APPEND))
1158 ret = rw_verify_area(WRITE, out, &offset, len);
1159 if (unlikely(ret < 0))
1162 file_start_write(out);
1163 ret = do_splice_from(ipipe, out, &offset, len, flags);
1164 file_end_write(out);
1167 out->f_pos = offset;
1168 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
1178 if (!(in->f_mode & FMODE_PREAD))
1180 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
1187 ret = wait_for_space(opipe, flags);
1189 ret = do_splice_to(in, &offset, opipe, len, flags);
1192 wakeup_pipe_readers(opipe);
1195 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
1204 static int iter_to_pipe(struct iov_iter *from,
1205 struct pipe_inode_info *pipe,
1208 struct pipe_buffer buf = {
1209 .ops = &user_page_pipe_buf_ops,
1214 bool failed = false;
1216 while (iov_iter_count(from) && !failed) {
1217 struct page *pages[16];
1222 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1228 for (n = 0; copied; n++, start = 0) {
1229 int size = min_t(int, copied, PAGE_SIZE - start);
1231 buf.page = pages[n];
1234 ret = add_to_pipe(pipe, &buf);
1235 if (unlikely(ret < 0)) {
1238 iov_iter_advance(from, ret);
1247 return total ? total : ret;
1250 static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1251 struct splice_desc *sd)
1253 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1254 return n == sd->len ? n : -EFAULT;
1258 * For lack of a better implementation, implement vmsplice() to userspace
1259 * as a simple copy of the pipes pages to the user iov.
1261 static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
1262 unsigned long nr_segs, unsigned int flags)
1264 struct pipe_inode_info *pipe;
1265 struct splice_desc sd;
1267 struct iovec iovstack[UIO_FASTIOV];
1268 struct iovec *iov = iovstack;
1269 struct iov_iter iter;
1271 pipe = get_pipe_info(file);
1275 ret = import_iovec(READ, uiov, nr_segs,
1276 ARRAY_SIZE(iovstack), &iov, &iter);
1280 sd.total_len = iov_iter_count(&iter);
1288 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1297 * vmsplice splices a user address range into a pipe. It can be thought of
1298 * as splice-from-memory, where the regular splice is splice-from-file (or
1299 * to file). In both cases the output is a pipe, naturally.
1301 static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
1302 unsigned long nr_segs, unsigned int flags)
1304 struct pipe_inode_info *pipe;
1305 struct iovec iovstack[UIO_FASTIOV];
1306 struct iovec *iov = iovstack;
1307 struct iov_iter from;
1309 unsigned buf_flag = 0;
1311 if (flags & SPLICE_F_GIFT)
1312 buf_flag = PIPE_BUF_FLAG_GIFT;
1314 pipe = get_pipe_info(file);
1318 ret = import_iovec(WRITE, uiov, nr_segs,
1319 ARRAY_SIZE(iovstack), &iov, &from);
1324 ret = wait_for_space(pipe, flags);
1326 ret = iter_to_pipe(&from, pipe, buf_flag);
1329 wakeup_pipe_readers(pipe);
1335 * Note that vmsplice only really supports true splicing _from_ user memory
1336 * to a pipe, not the other way around. Splicing from user memory is a simple
1337 * operation that can be supported without any funky alignment restrictions
1338 * or nasty vm tricks. We simply map in the user memory and fill them into
1339 * a pipe. The reverse isn't quite as easy, though. There are two possible
1340 * solutions for that:
1342 * - memcpy() the data internally, at which point we might as well just
1343 * do a regular read() on the buffer anyway.
1344 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1345 * has restriction limitations on both ends of the pipe).
1347 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1350 SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1351 unsigned long, nr_segs, unsigned int, flags)
1356 if (unlikely(flags & ~SPLICE_F_ALL))
1358 if (unlikely(nr_segs > UIO_MAXIOV))
1360 else if (unlikely(!nr_segs))
1366 if (f.file->f_mode & FMODE_WRITE)
1367 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1368 else if (f.file->f_mode & FMODE_READ)
1369 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
1377 #ifdef CONFIG_COMPAT
1378 COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1379 unsigned int, nr_segs, unsigned int, flags)
1382 struct iovec __user *iov;
1383 if (nr_segs > UIO_MAXIOV)
1385 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1386 for (i = 0; i < nr_segs; i++) {
1387 struct compat_iovec v;
1388 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1389 get_user(v.iov_len, &iov32[i].iov_len) ||
1390 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1391 put_user(v.iov_len, &iov[i].iov_len))
1394 return sys_vmsplice(fd, iov, nr_segs, flags);
1398 SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1399 int, fd_out, loff_t __user *, off_out,
1400 size_t, len, unsigned int, flags)
1408 if (unlikely(flags & ~SPLICE_F_ALL))
1414 if (in.file->f_mode & FMODE_READ) {
1415 out = fdget(fd_out);
1417 if (out.file->f_mode & FMODE_WRITE)
1418 error = do_splice(in.file, off_in,
1430 * Make sure there's data to read. Wait for input if we can, otherwise
1431 * return an appropriate error.
1433 static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1438 * Check ->nrbufs without the inode lock first. This function
1439 * is speculative anyways, so missing one is ok.
1447 while (!pipe->nrbufs) {
1448 if (signal_pending(current)) {
1454 if (!pipe->waiting_writers) {
1455 if (flags & SPLICE_F_NONBLOCK) {
1468 * Make sure there's writeable room. Wait for room if we can, otherwise
1469 * return an appropriate error.
1471 static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1476 * Check ->nrbufs without the inode lock first. This function
1477 * is speculative anyways, so missing one is ok.
1479 if (pipe->nrbufs < pipe->buffers)
1485 while (pipe->nrbufs >= pipe->buffers) {
1486 if (!pipe->readers) {
1487 send_sig(SIGPIPE, current, 0);
1491 if (flags & SPLICE_F_NONBLOCK) {
1495 if (signal_pending(current)) {
1499 pipe->waiting_writers++;
1501 pipe->waiting_writers--;
1509 * Splice contents of ipipe to opipe.
1511 static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1512 struct pipe_inode_info *opipe,
1513 size_t len, unsigned int flags)
1515 struct pipe_buffer *ibuf, *obuf;
1517 bool input_wakeup = false;
1521 ret = ipipe_prep(ipipe, flags);
1525 ret = opipe_prep(opipe, flags);
1530 * Potential ABBA deadlock, work around it by ordering lock
1531 * grabbing by pipe info address. Otherwise two different processes
1532 * could deadlock (one doing tee from A -> B, the other from B -> A).
1534 pipe_double_lock(ipipe, opipe);
1537 if (!opipe->readers) {
1538 send_sig(SIGPIPE, current, 0);
1544 if (!ipipe->nrbufs && !ipipe->writers)
1548 * Cannot make any progress, because either the input
1549 * pipe is empty or the output pipe is full.
1551 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
1552 /* Already processed some buffers, break */
1556 if (flags & SPLICE_F_NONBLOCK) {
1562 * We raced with another reader/writer and haven't
1563 * managed to process any buffers. A zero return
1564 * value means EOF, so retry instead.
1571 ibuf = ipipe->bufs + ipipe->curbuf;
1572 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1573 obuf = opipe->bufs + nbuf;
1575 if (len >= ibuf->len) {
1577 * Simply move the whole buffer from ipipe to opipe
1582 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
1584 input_wakeup = true;
1587 * Get a reference to this pipe buffer,
1588 * so we can copy the contents over.
1590 pipe_buf_get(ipipe, ibuf);
1594 * Don't inherit the gift flag, we need to
1595 * prevent multiple steals of this page.
1597 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1601 ibuf->offset += obuf->len;
1602 ibuf->len -= obuf->len;
1612 * If we put data in the output pipe, wakeup any potential readers.
1615 wakeup_pipe_readers(opipe);
1618 wakeup_pipe_writers(ipipe);
1624 * Link contents of ipipe to opipe.
1626 static int link_pipe(struct pipe_inode_info *ipipe,
1627 struct pipe_inode_info *opipe,
1628 size_t len, unsigned int flags)
1630 struct pipe_buffer *ibuf, *obuf;
1631 int ret = 0, i = 0, nbuf;
1634 * Potential ABBA deadlock, work around it by ordering lock
1635 * grabbing by pipe info address. Otherwise two different processes
1636 * could deadlock (one doing tee from A -> B, the other from B -> A).
1638 pipe_double_lock(ipipe, opipe);
1641 if (!opipe->readers) {
1642 send_sig(SIGPIPE, current, 0);
1649 * If we have iterated all input buffers or ran out of
1650 * output room, break.
1652 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
1655 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1656 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1659 * Get a reference to this pipe buffer,
1660 * so we can copy the contents over.
1662 pipe_buf_get(ipipe, ibuf);
1664 obuf = opipe->bufs + nbuf;
1668 * Don't inherit the gift flag, we need to
1669 * prevent multiple steals of this page.
1671 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1673 if (obuf->len > len)
1683 * return EAGAIN if we have the potential of some data in the
1684 * future, otherwise just return 0
1686 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1693 * If we put data in the output pipe, wakeup any potential readers.
1696 wakeup_pipe_readers(opipe);
1702 * This is a tee(1) implementation that works on pipes. It doesn't copy
1703 * any data, it simply references the 'in' pages on the 'out' pipe.
1704 * The 'flags' used are the SPLICE_F_* variants, currently the only
1705 * applicable one is SPLICE_F_NONBLOCK.
1707 static long do_tee(struct file *in, struct file *out, size_t len,
1710 struct pipe_inode_info *ipipe = get_pipe_info(in);
1711 struct pipe_inode_info *opipe = get_pipe_info(out);
1715 * Duplicate the contents of ipipe to opipe without actually
1718 if (ipipe && opipe && ipipe != opipe) {
1720 * Keep going, unless we encounter an error. The ipipe/opipe
1721 * ordering doesn't really matter.
1723 ret = ipipe_prep(ipipe, flags);
1725 ret = opipe_prep(opipe, flags);
1727 ret = link_pipe(ipipe, opipe, len, flags);
1734 SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
1739 if (unlikely(flags & ~SPLICE_F_ALL))
1748 if (in.file->f_mode & FMODE_READ) {
1749 struct fd out = fdget(fdout);
1751 if (out.file->f_mode & FMODE_WRITE)
1752 error = do_tee(in.file, out.file,