1 // SPDX-License-Identifier: GPL-2.0-only
3 * "splice": joining two ropes together by interweaving their strands.
5 * This is the "extended pipe" functionality, where a pipe is used as
6 * an arbitrary in-memory buffer. Think of a pipe as a small kernel
7 * buffer that you can use to transfer data from one end to the other.
9 * The traditional unix read/write is extended with a "splice()" operation
10 * that transfers data buffers to or from a pipe buffer.
12 * Named by Larry McVoy, original implementation from Linus, extended by
13 * Jens to support splicing to files, network, direct splicing, etc and
14 * fixing lots of bugs.
16 * Copyright (C) 2005-2006 Jens Axboe <axboe@kernel.dk>
17 * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
18 * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
21 #include <linux/bvec.h>
23 #include <linux/file.h>
24 #include <linux/pagemap.h>
25 #include <linux/splice.h>
26 #include <linux/memcontrol.h>
27 #include <linux/mm_inline.h>
28 #include <linux/swap.h>
29 #include <linux/writeback.h>
30 #include <linux/export.h>
31 #include <linux/syscalls.h>
32 #include <linux/uio.h>
33 #include <linux/security.h>
34 #include <linux/gfp.h>
35 #include <linux/socket.h>
36 #include <linux/compat.h>
37 #include <linux/sched/signal.h>
42 * Attempt to steal a page from a pipe buffer. This should perhaps go into
43 * a vm helper function, it's already simplified quite a bit by the
44 * addition of remove_mapping(). If success is returned, the caller may
45 * attempt to reuse this page for another destination.
47 static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
48 struct pipe_buffer *buf)
50 struct page *page = buf->page;
51 struct address_space *mapping;
55 mapping = page_mapping(page);
57 WARN_ON(!PageUptodate(page));
60 * At least for ext2 with nobh option, we need to wait on
61 * writeback completing on this page, since we'll remove it
62 * from the pagecache. Otherwise truncate wont wait on the
63 * page, allowing the disk blocks to be reused by someone else
64 * before we actually wrote our data to them. fs corruption
67 wait_on_page_writeback(page);
69 if (page_has_private(page) &&
70 !try_to_release_page(page, GFP_KERNEL))
74 * If we succeeded in removing the mapping, set LRU flag
77 if (remove_mapping(mapping, page)) {
78 buf->flags |= PIPE_BUF_FLAG_LRU;
84 * Raced with truncate or failed to remove page from current
85 * address space, unlock and return failure.
92 static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
93 struct pipe_buffer *buf)
96 buf->flags &= ~PIPE_BUF_FLAG_LRU;
100 * Check whether the contents of buf is OK to access. Since the content
101 * is a page cache page, IO may be in flight.
103 static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
104 struct pipe_buffer *buf)
106 struct page *page = buf->page;
109 if (!PageUptodate(page)) {
113 * Page got truncated/unhashed. This will cause a 0-byte
114 * splice, if this is the first page.
116 if (!page->mapping) {
122 * Uh oh, read-error from disk.
124 if (!PageUptodate(page)) {
130 * Page is ok afterall, we are done.
141 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 = {
159 .confirm = generic_pipe_buf_confirm,
160 .release = page_cache_pipe_buf_release,
161 .steal = user_page_pipe_buf_steal,
162 .get = generic_pipe_buf_get,
165 static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
168 if (waitqueue_active(&pipe->wait))
169 wake_up_interruptible(&pipe->wait);
170 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
174 * splice_to_pipe - fill passed data into a pipe
175 * @pipe: pipe to fill
179 * @spd contains a map of pages and len/offset tuples, along with
180 * the struct pipe_buf_operations associated with these pages. This
181 * function will link that data to the pipe.
184 ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
185 struct splice_pipe_desc *spd)
187 unsigned int spd_pages = spd->nr_pages;
188 int ret = 0, page_nr = 0;
193 if (unlikely(!pipe->readers)) {
194 send_sig(SIGPIPE, current, 0);
199 while (pipe->nrbufs < pipe->buffers) {
200 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
201 struct pipe_buffer *buf = pipe->bufs + newbuf;
203 buf->page = spd->pages[page_nr];
204 buf->offset = spd->partial[page_nr].offset;
205 buf->len = spd->partial[page_nr].len;
206 buf->private = spd->partial[page_nr].private;
214 if (!--spd->nr_pages)
222 while (page_nr < spd_pages)
223 spd->spd_release(spd, page_nr++);
227 EXPORT_SYMBOL_GPL(splice_to_pipe);
229 ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
233 if (unlikely(!pipe->readers)) {
234 send_sig(SIGPIPE, current, 0);
236 } else if (pipe->nrbufs == pipe->buffers) {
239 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
240 pipe->bufs[newbuf] = *buf;
244 pipe_buf_release(pipe, buf);
247 EXPORT_SYMBOL(add_to_pipe);
250 * Check if we need to grow the arrays holding pages and partial page
253 int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
255 unsigned int buffers = READ_ONCE(pipe->buffers);
257 spd->nr_pages_max = buffers;
258 if (buffers <= PIPE_DEF_BUFFERS)
261 spd->pages = kmalloc_array(buffers, sizeof(struct page *), GFP_KERNEL);
262 spd->partial = kmalloc_array(buffers, sizeof(struct partial_page),
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, 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 = {
328 .confirm = generic_pipe_buf_confirm,
329 .release = generic_pipe_buf_release,
330 .steal = generic_pipe_buf_steal,
331 .get = generic_pipe_buf_get,
334 int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
335 struct pipe_buffer *buf)
340 /* Pipe buffer operations for a socket and similar. */
341 const struct pipe_buf_operations nosteal_pipe_buf_ops = {
342 .confirm = generic_pipe_buf_confirm,
343 .release = generic_pipe_buf_release,
344 .steal = generic_pipe_buf_nosteal,
345 .get = generic_pipe_buf_get,
347 EXPORT_SYMBOL(nosteal_pipe_buf_ops);
349 static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
350 unsigned long vlen, loff_t offset)
358 /* The cast to a user pointer is valid due to the set_fs() */
359 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
365 static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
366 struct pipe_inode_info *pipe, size_t len,
369 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
372 unsigned int nr_pages;
373 size_t offset, base, copied = 0;
377 if (pipe->nrbufs == pipe->buffers)
381 * Try to keep page boundaries matching to source pagecache ones -
382 * it probably won't be much help, but...
384 offset = *ppos & ~PAGE_MASK;
386 iov_iter_pipe(&to, READ, pipe, len + offset);
388 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &base);
392 nr_pages = DIV_ROUND_UP(res + base, PAGE_SIZE);
395 if (nr_pages > PIPE_DEF_BUFFERS) {
396 vec = kmalloc_array(nr_pages, sizeof(struct kvec), GFP_KERNEL);
397 if (unlikely(!vec)) {
403 pipe->bufs[to.idx].offset = offset;
404 pipe->bufs[to.idx].len -= offset;
406 for (i = 0; i < nr_pages; i++) {
407 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
408 vec[i].iov_base = page_address(pages[i]) + offset;
409 vec[i].iov_len = this_len;
414 res = kernel_readv(in, vec, nr_pages, *ppos);
423 for (i = 0; i < nr_pages; i++)
426 iov_iter_advance(&to, copied); /* truncates and discards */
431 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
432 * using sendpage(). Return the number of bytes sent.
434 static int pipe_to_sendpage(struct pipe_inode_info *pipe,
435 struct pipe_buffer *buf, struct splice_desc *sd)
437 struct file *file = sd->u.file;
438 loff_t pos = sd->pos;
441 if (!likely(file->f_op->sendpage))
444 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
446 if (sd->len < sd->total_len && pipe->nrbufs > 1)
447 more |= MSG_SENDPAGE_NOTLAST;
449 return file->f_op->sendpage(file, buf->page, buf->offset,
450 sd->len, &pos, more);
453 static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
456 if (waitqueue_active(&pipe->wait))
457 wake_up_interruptible(&pipe->wait);
458 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
462 * splice_from_pipe_feed - feed available data from a pipe to a file
463 * @pipe: pipe to splice from
464 * @sd: information to @actor
465 * @actor: handler that splices the data
468 * This function loops over the pipe and calls @actor to do the
469 * actual moving of a single struct pipe_buffer to the desired
470 * destination. It returns when there's no more buffers left in
471 * the pipe or if the requested number of bytes (@sd->total_len)
472 * have been copied. It returns a positive number (one) if the
473 * pipe needs to be filled with more data, zero if the required
474 * number of bytes have been copied and -errno on error.
476 * This, together with splice_from_pipe_{begin,end,next}, may be
477 * used to implement the functionality of __splice_from_pipe() when
478 * locking is required around copying the pipe buffers to the
481 static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
486 while (pipe->nrbufs) {
487 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
490 if (sd->len > sd->total_len)
491 sd->len = sd->total_len;
493 ret = pipe_buf_confirm(pipe, buf);
500 ret = actor(pipe, buf, sd);
507 sd->num_spliced += ret;
510 sd->total_len -= ret;
513 pipe_buf_release(pipe, buf);
514 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
517 sd->need_wakeup = true;
528 * splice_from_pipe_next - wait for some data to splice from
529 * @pipe: pipe to splice from
530 * @sd: information about the splice operation
533 * This function will wait for some data and return a positive
534 * value (one) if pipe buffers are available. It will return zero
535 * or -errno if no more data needs to be spliced.
537 static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
540 * Check for signal early to make process killable when there are
541 * always buffers available
543 if (signal_pending(current))
546 while (!pipe->nrbufs) {
550 if (!pipe->waiting_writers && sd->num_spliced)
553 if (sd->flags & SPLICE_F_NONBLOCK)
556 if (signal_pending(current))
559 if (sd->need_wakeup) {
560 wakeup_pipe_writers(pipe);
561 sd->need_wakeup = false;
571 * splice_from_pipe_begin - start splicing from pipe
572 * @sd: information about the splice operation
575 * This function should be called before a loop containing
576 * splice_from_pipe_next() and splice_from_pipe_feed() to
577 * initialize the necessary fields of @sd.
579 static void splice_from_pipe_begin(struct splice_desc *sd)
582 sd->need_wakeup = false;
586 * splice_from_pipe_end - finish splicing from pipe
587 * @pipe: pipe to splice from
588 * @sd: information about the splice operation
591 * This function will wake up pipe writers if necessary. It should
592 * be called after a loop containing splice_from_pipe_next() and
593 * splice_from_pipe_feed().
595 static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
598 wakeup_pipe_writers(pipe);
602 * __splice_from_pipe - splice data from a pipe to given actor
603 * @pipe: pipe to splice from
604 * @sd: information to @actor
605 * @actor: handler that splices the data
608 * This function does little more than loop over the pipe and call
609 * @actor to do the actual moving of a single struct pipe_buffer to
610 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
614 ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
619 splice_from_pipe_begin(sd);
622 ret = splice_from_pipe_next(pipe, sd);
624 ret = splice_from_pipe_feed(pipe, sd, actor);
626 splice_from_pipe_end(pipe, sd);
628 return sd->num_spliced ? sd->num_spliced : ret;
630 EXPORT_SYMBOL(__splice_from_pipe);
633 * splice_from_pipe - splice data from a pipe to a file
634 * @pipe: pipe to splice from
635 * @out: file to splice to
636 * @ppos: position in @out
637 * @len: how many bytes to splice
638 * @flags: splice modifier flags
639 * @actor: handler that splices the data
642 * See __splice_from_pipe. This function locks the pipe inode,
643 * otherwise it's identical to __splice_from_pipe().
646 ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
647 loff_t *ppos, size_t len, unsigned int flags,
651 struct splice_desc sd = {
659 ret = __splice_from_pipe(pipe, &sd, actor);
666 * iter_file_splice_write - splice data from a pipe to a file
668 * @out: file to write to
669 * @ppos: position in @out
670 * @len: number of bytes to splice
671 * @flags: splice modifier flags
674 * Will either move or copy pages (determined by @flags options) from
675 * the given pipe inode to the given file.
676 * This one is ->write_iter-based.
680 iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
681 loff_t *ppos, size_t len, unsigned int flags)
683 struct splice_desc sd = {
689 int nbufs = pipe->buffers;
690 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
694 if (unlikely(!array))
699 splice_from_pipe_begin(&sd);
700 while (sd.total_len) {
701 struct iov_iter from;
705 ret = splice_from_pipe_next(pipe, &sd);
709 if (unlikely(nbufs < pipe->buffers)) {
711 nbufs = pipe->buffers;
712 array = kcalloc(nbufs, sizeof(struct bio_vec),
720 /* build the vector */
722 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
723 struct pipe_buffer *buf = pipe->bufs + idx;
724 size_t this_len = buf->len;
729 if (idx == pipe->buffers - 1)
732 ret = pipe_buf_confirm(pipe, buf);
739 array[n].bv_page = buf->page;
740 array[n].bv_len = this_len;
741 array[n].bv_offset = buf->offset;
745 iov_iter_bvec(&from, WRITE, array, n, sd.total_len - left);
746 ret = vfs_iter_write(out, &from, &sd.pos, 0);
750 sd.num_spliced += ret;
754 /* dismiss the fully eaten buffers, adjust the partial one */
756 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
757 if (ret >= buf->len) {
760 pipe_buf_release(pipe, buf);
761 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
764 sd.need_wakeup = true;
774 splice_from_pipe_end(pipe, &sd);
779 ret = sd.num_spliced;
784 EXPORT_SYMBOL(iter_file_splice_write);
786 static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
787 struct splice_desc *sd)
791 loff_t tmp = sd->pos;
793 data = kmap(buf->page);
794 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
800 static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
801 struct file *out, loff_t *ppos,
802 size_t len, unsigned int flags)
806 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
814 * generic_splice_sendpage - splice data from a pipe to a socket
815 * @pipe: pipe to splice from
816 * @out: socket to write to
817 * @ppos: position in @out
818 * @len: number of bytes to splice
819 * @flags: splice modifier flags
822 * Will send @len bytes from the pipe to a network socket. No data copying
826 ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
827 loff_t *ppos, size_t len, unsigned int flags)
829 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
832 EXPORT_SYMBOL(generic_splice_sendpage);
835 * Attempt to initiate a splice from pipe to file.
837 static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
838 loff_t *ppos, size_t len, unsigned int flags)
840 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
841 loff_t *, size_t, unsigned int);
843 if (out->f_op->splice_write)
844 splice_write = out->f_op->splice_write;
846 splice_write = default_file_splice_write;
848 return splice_write(pipe, out, ppos, len, flags);
852 * Attempt to initiate a splice from a file to a pipe.
854 static long do_splice_to(struct file *in, loff_t *ppos,
855 struct pipe_inode_info *pipe, size_t len,
858 ssize_t (*splice_read)(struct file *, loff_t *,
859 struct pipe_inode_info *, size_t, unsigned int);
862 if (unlikely(!(in->f_mode & FMODE_READ)))
865 ret = rw_verify_area(READ, in, ppos, len);
866 if (unlikely(ret < 0))
869 if (unlikely(len > MAX_RW_COUNT))
872 if (in->f_op->splice_read)
873 splice_read = in->f_op->splice_read;
875 splice_read = default_file_splice_read;
877 return splice_read(in, ppos, pipe, len, flags);
881 * splice_direct_to_actor - splices data directly between two non-pipes
882 * @in: file to splice from
883 * @sd: actor information on where to splice to
884 * @actor: handles the data splicing
887 * This is a special case helper to splice directly between two
888 * points, without requiring an explicit pipe. Internally an allocated
889 * pipe is cached in the process, and reused during the lifetime of
893 ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
894 splice_direct_actor *actor)
896 struct pipe_inode_info *pipe;
903 * We require the input being a regular file, as we don't want to
904 * randomly drop data for eg socket -> socket splicing. Use the
905 * piped splicing for that!
907 i_mode = file_inode(in)->i_mode;
908 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
912 * neither in nor out is a pipe, setup an internal pipe attached to
913 * 'out' and transfer the wanted data from 'in' to 'out' through that
915 pipe = current->splice_pipe;
916 if (unlikely(!pipe)) {
917 pipe = alloc_pipe_info();
922 * We don't have an immediate reader, but we'll read the stuff
923 * out of the pipe right after the splice_to_pipe(). So set
924 * PIPE_READERS appropriately.
928 current->splice_pipe = pipe;
940 * Don't block on output, we have to drain the direct pipe.
942 sd->flags &= ~SPLICE_F_NONBLOCK;
943 more = sd->flags & SPLICE_F_MORE;
945 WARN_ON_ONCE(pipe->nrbufs != 0);
949 loff_t pos = sd->pos, prev_pos = pos;
951 /* Don't try to read more the pipe has space for. */
952 read_len = min_t(size_t, len,
953 (pipe->buffers - pipe->nrbufs) << PAGE_SHIFT);
954 ret = do_splice_to(in, &pos, pipe, read_len, flags);
955 if (unlikely(ret <= 0))
959 sd->total_len = read_len;
962 * If more data is pending, set SPLICE_F_MORE
963 * If this is the last data and SPLICE_F_MORE was not set
964 * initially, clears it.
967 sd->flags |= SPLICE_F_MORE;
969 sd->flags &= ~SPLICE_F_MORE;
971 * NOTE: nonblocking mode only applies to the input. We
972 * must not do the output in nonblocking mode as then we
973 * could get stuck data in the internal pipe:
975 ret = actor(pipe, sd);
976 if (unlikely(ret <= 0)) {
985 if (ret < read_len) {
986 sd->pos = prev_pos + ret;
992 pipe->nrbufs = pipe->curbuf = 0;
998 * If we did an incomplete transfer we must release
999 * the pipe buffers in question:
1001 for (i = 0; i < pipe->buffers; i++) {
1002 struct pipe_buffer *buf = pipe->bufs + i;
1005 pipe_buf_release(pipe, buf);
1013 EXPORT_SYMBOL(splice_direct_to_actor);
1015 static int direct_splice_actor(struct pipe_inode_info *pipe,
1016 struct splice_desc *sd)
1018 struct file *file = sd->u.file;
1020 return do_splice_from(pipe, file, sd->opos, sd->total_len,
1025 * do_splice_direct - splices data directly between two files
1026 * @in: file to splice from
1027 * @ppos: input file offset
1028 * @out: file to splice to
1029 * @opos: output file offset
1030 * @len: number of bytes to splice
1031 * @flags: splice modifier flags
1034 * For use by do_sendfile(). splice can easily emulate sendfile, but
1035 * doing it in the application would incur an extra system call
1036 * (splice in + splice out, as compared to just sendfile()). So this helper
1037 * can splice directly through a process-private pipe.
1040 long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
1041 loff_t *opos, size_t len, unsigned int flags)
1043 struct splice_desc sd = {
1053 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1056 if (unlikely(out->f_flags & O_APPEND))
1059 ret = rw_verify_area(WRITE, out, opos, len);
1060 if (unlikely(ret < 0))
1063 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
1069 EXPORT_SYMBOL(do_splice_direct);
1071 static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1074 if (unlikely(!pipe->readers)) {
1075 send_sig(SIGPIPE, current, 0);
1078 if (pipe->nrbufs != pipe->buffers)
1080 if (flags & SPLICE_F_NONBLOCK)
1082 if (signal_pending(current))
1083 return -ERESTARTSYS;
1084 pipe->waiting_writers++;
1086 pipe->waiting_writers--;
1090 static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1091 struct pipe_inode_info *opipe,
1092 size_t len, unsigned int flags);
1095 * Determine where to splice to/from.
1097 static long do_splice(struct file *in, loff_t __user *off_in,
1098 struct file *out, loff_t __user *off_out,
1099 size_t len, unsigned int flags)
1101 struct pipe_inode_info *ipipe;
1102 struct pipe_inode_info *opipe;
1106 ipipe = get_pipe_info(in);
1107 opipe = get_pipe_info(out);
1109 if (ipipe && opipe) {
1110 if (off_in || off_out)
1113 if (!(in->f_mode & FMODE_READ))
1116 if (!(out->f_mode & FMODE_WRITE))
1119 /* Splicing to self would be fun, but... */
1123 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1124 flags |= SPLICE_F_NONBLOCK;
1126 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1133 if (!(out->f_mode & FMODE_PWRITE))
1135 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
1138 offset = out->f_pos;
1141 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1144 if (unlikely(out->f_flags & O_APPEND))
1147 ret = rw_verify_area(WRITE, out, &offset, len);
1148 if (unlikely(ret < 0))
1151 if (in->f_flags & O_NONBLOCK)
1152 flags |= SPLICE_F_NONBLOCK;
1154 file_start_write(out);
1155 ret = do_splice_from(ipipe, out, &offset, len, flags);
1156 file_end_write(out);
1159 out->f_pos = offset;
1160 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
1170 if (!(in->f_mode & FMODE_PREAD))
1172 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
1178 if (out->f_flags & O_NONBLOCK)
1179 flags |= SPLICE_F_NONBLOCK;
1182 ret = wait_for_space(opipe, flags);
1184 ret = do_splice_to(in, &offset, opipe, len, flags);
1187 wakeup_pipe_readers(opipe);
1190 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
1199 static int iter_to_pipe(struct iov_iter *from,
1200 struct pipe_inode_info *pipe,
1203 struct pipe_buffer buf = {
1204 .ops = &user_page_pipe_buf_ops,
1209 bool failed = false;
1211 while (iov_iter_count(from) && !failed) {
1212 struct page *pages[16];
1217 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1223 for (n = 0; copied; n++, start = 0) {
1224 int size = min_t(int, copied, PAGE_SIZE - start);
1226 buf.page = pages[n];
1229 ret = add_to_pipe(pipe, &buf);
1230 if (unlikely(ret < 0)) {
1233 iov_iter_advance(from, ret);
1242 return total ? total : ret;
1245 static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1246 struct splice_desc *sd)
1248 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1249 return n == sd->len ? n : -EFAULT;
1253 * For lack of a better implementation, implement vmsplice() to userspace
1254 * as a simple copy of the pipes pages to the user iov.
1256 static long vmsplice_to_user(struct file *file, struct iov_iter *iter,
1259 struct pipe_inode_info *pipe = get_pipe_info(file);
1260 struct splice_desc sd = {
1261 .total_len = iov_iter_count(iter),
1272 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1280 * vmsplice splices a user address range into a pipe. It can be thought of
1281 * as splice-from-memory, where the regular splice is splice-from-file (or
1282 * to file). In both cases the output is a pipe, naturally.
1284 static long vmsplice_to_pipe(struct file *file, struct iov_iter *iter,
1287 struct pipe_inode_info *pipe;
1289 unsigned buf_flag = 0;
1291 if (flags & SPLICE_F_GIFT)
1292 buf_flag = PIPE_BUF_FLAG_GIFT;
1294 pipe = get_pipe_info(file);
1299 ret = wait_for_space(pipe, flags);
1301 ret = iter_to_pipe(iter, pipe, buf_flag);
1304 wakeup_pipe_readers(pipe);
1308 static int vmsplice_type(struct fd f, int *type)
1312 if (f.file->f_mode & FMODE_WRITE) {
1314 } else if (f.file->f_mode & FMODE_READ) {
1324 * Note that vmsplice only really supports true splicing _from_ user memory
1325 * to a pipe, not the other way around. Splicing from user memory is a simple
1326 * operation that can be supported without any funky alignment restrictions
1327 * or nasty vm tricks. We simply map in the user memory and fill them into
1328 * a pipe. The reverse isn't quite as easy, though. There are two possible
1329 * solutions for that:
1331 * - memcpy() the data internally, at which point we might as well just
1332 * do a regular read() on the buffer anyway.
1333 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1334 * has restriction limitations on both ends of the pipe).
1336 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1339 static long do_vmsplice(struct file *f, struct iov_iter *iter, unsigned int flags)
1341 if (unlikely(flags & ~SPLICE_F_ALL))
1344 if (!iov_iter_count(iter))
1347 if (iov_iter_rw(iter) == WRITE)
1348 return vmsplice_to_pipe(f, iter, flags);
1350 return vmsplice_to_user(f, iter, flags);
1353 SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, uiov,
1354 unsigned long, nr_segs, unsigned int, flags)
1356 struct iovec iovstack[UIO_FASTIOV];
1357 struct iovec *iov = iovstack;
1358 struct iov_iter iter;
1364 error = vmsplice_type(f, &type);
1368 error = import_iovec(type, uiov, nr_segs,
1369 ARRAY_SIZE(iovstack), &iov, &iter);
1371 error = do_vmsplice(f.file, &iter, flags);
1378 #ifdef CONFIG_COMPAT
1379 COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1380 unsigned int, nr_segs, unsigned int, flags)
1382 struct iovec iovstack[UIO_FASTIOV];
1383 struct iovec *iov = iovstack;
1384 struct iov_iter iter;
1390 error = vmsplice_type(f, &type);
1394 error = compat_import_iovec(type, iov32, nr_segs,
1395 ARRAY_SIZE(iovstack), &iov, &iter);
1397 error = do_vmsplice(f.file, &iter, flags);
1405 SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1406 int, fd_out, loff_t __user *, off_out,
1407 size_t, len, unsigned int, flags)
1415 if (unlikely(flags & ~SPLICE_F_ALL))
1421 if (in.file->f_mode & FMODE_READ) {
1422 out = fdget(fd_out);
1424 if (out.file->f_mode & FMODE_WRITE)
1425 error = do_splice(in.file, off_in,
1437 * Make sure there's data to read. Wait for input if we can, otherwise
1438 * return an appropriate error.
1440 static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1445 * Check ->nrbufs without the inode lock first. This function
1446 * is speculative anyways, so missing one is ok.
1454 while (!pipe->nrbufs) {
1455 if (signal_pending(current)) {
1461 if (!pipe->waiting_writers) {
1462 if (flags & SPLICE_F_NONBLOCK) {
1475 * Make sure there's writeable room. Wait for room if we can, otherwise
1476 * return an appropriate error.
1478 static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1483 * Check ->nrbufs without the inode lock first. This function
1484 * is speculative anyways, so missing one is ok.
1486 if (pipe->nrbufs < pipe->buffers)
1492 while (pipe->nrbufs >= pipe->buffers) {
1493 if (!pipe->readers) {
1494 send_sig(SIGPIPE, current, 0);
1498 if (flags & SPLICE_F_NONBLOCK) {
1502 if (signal_pending(current)) {
1506 pipe->waiting_writers++;
1508 pipe->waiting_writers--;
1516 * Splice contents of ipipe to opipe.
1518 static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1519 struct pipe_inode_info *opipe,
1520 size_t len, unsigned int flags)
1522 struct pipe_buffer *ibuf, *obuf;
1524 bool input_wakeup = false;
1528 ret = ipipe_prep(ipipe, flags);
1532 ret = opipe_prep(opipe, flags);
1537 * Potential ABBA deadlock, work around it by ordering lock
1538 * grabbing by pipe info address. Otherwise two different processes
1539 * could deadlock (one doing tee from A -> B, the other from B -> A).
1541 pipe_double_lock(ipipe, opipe);
1544 if (!opipe->readers) {
1545 send_sig(SIGPIPE, current, 0);
1551 if (!ipipe->nrbufs && !ipipe->writers)
1555 * Cannot make any progress, because either the input
1556 * pipe is empty or the output pipe is full.
1558 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
1559 /* Already processed some buffers, break */
1563 if (flags & SPLICE_F_NONBLOCK) {
1569 * We raced with another reader/writer and haven't
1570 * managed to process any buffers. A zero return
1571 * value means EOF, so retry instead.
1578 ibuf = ipipe->bufs + ipipe->curbuf;
1579 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1580 obuf = opipe->bufs + nbuf;
1582 if (len >= ibuf->len) {
1584 * Simply move the whole buffer from ipipe to opipe
1589 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
1591 input_wakeup = true;
1594 * Get a reference to this pipe buffer,
1595 * so we can copy the contents over.
1597 if (!pipe_buf_get(ipipe, ibuf)) {
1605 * Don't inherit the gift flag, we need to
1606 * prevent multiple steals of this page.
1608 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1610 pipe_buf_mark_unmergeable(obuf);
1614 ibuf->offset += obuf->len;
1615 ibuf->len -= obuf->len;
1625 * If we put data in the output pipe, wakeup any potential readers.
1628 wakeup_pipe_readers(opipe);
1631 wakeup_pipe_writers(ipipe);
1637 * Link contents of ipipe to opipe.
1639 static int link_pipe(struct pipe_inode_info *ipipe,
1640 struct pipe_inode_info *opipe,
1641 size_t len, unsigned int flags)
1643 struct pipe_buffer *ibuf, *obuf;
1644 int ret = 0, i = 0, nbuf;
1647 * Potential ABBA deadlock, work around it by ordering lock
1648 * grabbing by pipe info address. Otherwise two different processes
1649 * could deadlock (one doing tee from A -> B, the other from B -> A).
1651 pipe_double_lock(ipipe, opipe);
1654 if (!opipe->readers) {
1655 send_sig(SIGPIPE, current, 0);
1662 * If we have iterated all input buffers or ran out of
1663 * output room, break.
1665 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
1668 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1669 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1672 * Get a reference to this pipe buffer,
1673 * so we can copy the contents over.
1675 if (!pipe_buf_get(ipipe, ibuf)) {
1681 obuf = opipe->bufs + nbuf;
1685 * Don't inherit the gift flag, we need to
1686 * prevent multiple steals of this page.
1688 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1690 pipe_buf_mark_unmergeable(obuf);
1692 if (obuf->len > len)
1702 * return EAGAIN if we have the potential of some data in the
1703 * future, otherwise just return 0
1705 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1712 * If we put data in the output pipe, wakeup any potential readers.
1715 wakeup_pipe_readers(opipe);
1721 * This is a tee(1) implementation that works on pipes. It doesn't copy
1722 * any data, it simply references the 'in' pages on the 'out' pipe.
1723 * The 'flags' used are the SPLICE_F_* variants, currently the only
1724 * applicable one is SPLICE_F_NONBLOCK.
1726 static long do_tee(struct file *in, struct file *out, size_t len,
1729 struct pipe_inode_info *ipipe = get_pipe_info(in);
1730 struct pipe_inode_info *opipe = get_pipe_info(out);
1734 * Duplicate the contents of ipipe to opipe without actually
1737 if (ipipe && opipe && ipipe != opipe) {
1738 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1739 flags |= SPLICE_F_NONBLOCK;
1742 * Keep going, unless we encounter an error. The ipipe/opipe
1743 * ordering doesn't really matter.
1745 ret = ipipe_prep(ipipe, flags);
1747 ret = opipe_prep(opipe, flags);
1749 ret = link_pipe(ipipe, opipe, len, flags);
1756 SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
1761 if (unlikely(flags & ~SPLICE_F_ALL))
1770 if (in.file->f_mode & FMODE_READ) {
1771 struct fd out = fdget(fdout);
1773 if (out.file->f_mode & FMODE_WRITE)
1774 error = do_tee(in.file, out.file,