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.
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>
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
= READ_ONCE(pipe
->buffers
);
258 spd
->nr_pages_max
= buffers
;
259 if (buffers
<= PIPE_DEF_BUFFERS
)
262 spd
->pages
= kmalloc_array(buffers
, sizeof(struct page
*), GFP_KERNEL
);
263 spd
->partial
= kmalloc_array(buffers
, sizeof(struct partial_page
),
266 if (spd
->pages
&& spd
->partial
)
274 void splice_shrink_spd(struct splice_pipe_desc
*spd
)
276 if (spd
->nr_pages_max
<= PIPE_DEF_BUFFERS
)
284 * generic_file_splice_read - splice data from file to a pipe
285 * @in: file to splice from
286 * @ppos: position in @in
287 * @pipe: pipe to splice to
288 * @len: number of bytes to splice
289 * @flags: splice modifier flags
292 * Will read pages from given file and fill them into a pipe. Can be
293 * used as long as it has more or less sane ->read_iter().
296 ssize_t
generic_file_splice_read(struct file
*in
, loff_t
*ppos
,
297 struct pipe_inode_info
*pipe
, size_t len
,
304 iov_iter_pipe(&to
, ITER_PIPE
| READ
, pipe
, len
);
306 init_sync_kiocb(&kiocb
, in
);
307 kiocb
.ki_pos
= *ppos
;
308 ret
= call_read_iter(in
, &kiocb
, &to
);
310 *ppos
= kiocb
.ki_pos
;
312 } else if (ret
< 0) {
315 iov_iter_advance(&to
, 0); /* to free what was emitted */
317 * callers of ->splice_read() expect -EAGAIN on
318 * "can't put anything in there", rather than -EFAULT.
326 EXPORT_SYMBOL(generic_file_splice_read
);
328 const struct pipe_buf_operations default_pipe_buf_ops
= {
330 .confirm
= generic_pipe_buf_confirm
,
331 .release
= generic_pipe_buf_release
,
332 .steal
= generic_pipe_buf_steal
,
333 .get
= generic_pipe_buf_get
,
336 int generic_pipe_buf_nosteal(struct pipe_inode_info
*pipe
,
337 struct pipe_buffer
*buf
)
342 /* Pipe buffer operations for a socket and similar. */
343 const struct pipe_buf_operations nosteal_pipe_buf_ops
= {
345 .confirm
= generic_pipe_buf_confirm
,
346 .release
= generic_pipe_buf_release
,
347 .steal
= generic_pipe_buf_nosteal
,
348 .get
= generic_pipe_buf_get
,
350 EXPORT_SYMBOL(nosteal_pipe_buf_ops
);
352 static ssize_t
kernel_readv(struct file
*file
, const struct kvec
*vec
,
353 unsigned long vlen
, loff_t offset
)
361 /* The cast to a user pointer is valid due to the set_fs() */
362 res
= vfs_readv(file
, (const struct iovec __user
*)vec
, vlen
, &pos
, 0);
368 static ssize_t
default_file_splice_read(struct file
*in
, loff_t
*ppos
,
369 struct pipe_inode_info
*pipe
, size_t len
,
372 struct kvec
*vec
, __vec
[PIPE_DEF_BUFFERS
];
375 unsigned int nr_pages
;
376 size_t offset
, base
, copied
= 0;
380 if (pipe
->nrbufs
== pipe
->buffers
)
384 * Try to keep page boundaries matching to source pagecache ones -
385 * it probably won't be much help, but...
387 offset
= *ppos
& ~PAGE_MASK
;
389 iov_iter_pipe(&to
, ITER_PIPE
| READ
, pipe
, len
+ offset
);
391 res
= iov_iter_get_pages_alloc(&to
, &pages
, len
+ offset
, &base
);
395 nr_pages
= DIV_ROUND_UP(res
+ base
, PAGE_SIZE
);
398 if (nr_pages
> PIPE_DEF_BUFFERS
) {
399 vec
= kmalloc_array(nr_pages
, sizeof(struct kvec
), GFP_KERNEL
);
400 if (unlikely(!vec
)) {
406 pipe
->bufs
[to
.idx
].offset
= offset
;
407 pipe
->bufs
[to
.idx
].len
-= offset
;
409 for (i
= 0; i
< nr_pages
; i
++) {
410 size_t this_len
= min_t(size_t, len
, PAGE_SIZE
- offset
);
411 vec
[i
].iov_base
= page_address(pages
[i
]) + offset
;
412 vec
[i
].iov_len
= this_len
;
417 res
= kernel_readv(in
, vec
, nr_pages
, *ppos
);
426 for (i
= 0; i
< nr_pages
; i
++)
429 iov_iter_advance(&to
, copied
); /* truncates and discards */
434 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
435 * using sendpage(). Return the number of bytes sent.
437 static int pipe_to_sendpage(struct pipe_inode_info
*pipe
,
438 struct pipe_buffer
*buf
, struct splice_desc
*sd
)
440 struct file
*file
= sd
->u
.file
;
441 loff_t pos
= sd
->pos
;
444 if (!likely(file
->f_op
->sendpage
))
447 more
= (sd
->flags
& SPLICE_F_MORE
) ? MSG_MORE
: 0;
449 if (sd
->len
< sd
->total_len
&& pipe
->nrbufs
> 1)
450 more
|= MSG_SENDPAGE_NOTLAST
;
452 return file
->f_op
->sendpage(file
, buf
->page
, buf
->offset
,
453 sd
->len
, &pos
, more
);
456 static void wakeup_pipe_writers(struct pipe_inode_info
*pipe
)
459 if (waitqueue_active(&pipe
->wait
))
460 wake_up_interruptible(&pipe
->wait
);
461 kill_fasync(&pipe
->fasync_writers
, SIGIO
, POLL_OUT
);
465 * splice_from_pipe_feed - feed available data from a pipe to a file
466 * @pipe: pipe to splice from
467 * @sd: information to @actor
468 * @actor: handler that splices the data
471 * This function loops over the pipe and calls @actor to do the
472 * actual moving of a single struct pipe_buffer to the desired
473 * destination. It returns when there's no more buffers left in
474 * the pipe or if the requested number of bytes (@sd->total_len)
475 * have been copied. It returns a positive number (one) if the
476 * pipe needs to be filled with more data, zero if the required
477 * number of bytes have been copied and -errno on error.
479 * This, together with splice_from_pipe_{begin,end,next}, may be
480 * used to implement the functionality of __splice_from_pipe() when
481 * locking is required around copying the pipe buffers to the
484 static int splice_from_pipe_feed(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
489 while (pipe
->nrbufs
) {
490 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
493 if (sd
->len
> sd
->total_len
)
494 sd
->len
= sd
->total_len
;
496 ret
= pipe_buf_confirm(pipe
, buf
);
503 ret
= actor(pipe
, buf
, sd
);
510 sd
->num_spliced
+= ret
;
513 sd
->total_len
-= ret
;
516 pipe_buf_release(pipe
, buf
);
517 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (pipe
->buffers
- 1);
520 sd
->need_wakeup
= true;
531 * splice_from_pipe_next - wait for some data to splice from
532 * @pipe: pipe to splice from
533 * @sd: information about the splice operation
536 * This function will wait for some data and return a positive
537 * value (one) if pipe buffers are available. It will return zero
538 * or -errno if no more data needs to be spliced.
540 static int splice_from_pipe_next(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
543 * Check for signal early to make process killable when there are
544 * always buffers available
546 if (signal_pending(current
))
549 while (!pipe
->nrbufs
) {
553 if (!pipe
->waiting_writers
&& sd
->num_spliced
)
556 if (sd
->flags
& SPLICE_F_NONBLOCK
)
559 if (signal_pending(current
))
562 if (sd
->need_wakeup
) {
563 wakeup_pipe_writers(pipe
);
564 sd
->need_wakeup
= false;
574 * splice_from_pipe_begin - start splicing from pipe
575 * @sd: information about the splice operation
578 * This function should be called before a loop containing
579 * splice_from_pipe_next() and splice_from_pipe_feed() to
580 * initialize the necessary fields of @sd.
582 static void splice_from_pipe_begin(struct splice_desc
*sd
)
585 sd
->need_wakeup
= false;
589 * splice_from_pipe_end - finish splicing from pipe
590 * @pipe: pipe to splice from
591 * @sd: information about the splice operation
594 * This function will wake up pipe writers if necessary. It should
595 * be called after a loop containing splice_from_pipe_next() and
596 * splice_from_pipe_feed().
598 static void splice_from_pipe_end(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
601 wakeup_pipe_writers(pipe
);
605 * __splice_from_pipe - splice data from a pipe to given actor
606 * @pipe: pipe to splice from
607 * @sd: information to @actor
608 * @actor: handler that splices the data
611 * This function does little more than loop over the pipe and call
612 * @actor to do the actual moving of a single struct pipe_buffer to
613 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
617 ssize_t
__splice_from_pipe(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
622 splice_from_pipe_begin(sd
);
625 ret
= splice_from_pipe_next(pipe
, sd
);
627 ret
= splice_from_pipe_feed(pipe
, sd
, actor
);
629 splice_from_pipe_end(pipe
, sd
);
631 return sd
->num_spliced
? sd
->num_spliced
: ret
;
633 EXPORT_SYMBOL(__splice_from_pipe
);
636 * splice_from_pipe - splice data from a pipe to a file
637 * @pipe: pipe to splice from
638 * @out: file to splice to
639 * @ppos: position in @out
640 * @len: how many bytes to splice
641 * @flags: splice modifier flags
642 * @actor: handler that splices the data
645 * See __splice_from_pipe. This function locks the pipe inode,
646 * otherwise it's identical to __splice_from_pipe().
649 ssize_t
splice_from_pipe(struct pipe_inode_info
*pipe
, struct file
*out
,
650 loff_t
*ppos
, size_t len
, unsigned int flags
,
654 struct splice_desc sd
= {
662 ret
= __splice_from_pipe(pipe
, &sd
, actor
);
669 * iter_file_splice_write - splice data from a pipe to a file
671 * @out: file to write to
672 * @ppos: position in @out
673 * @len: number of bytes to splice
674 * @flags: splice modifier flags
677 * Will either move or copy pages (determined by @flags options) from
678 * the given pipe inode to the given file.
679 * This one is ->write_iter-based.
683 iter_file_splice_write(struct pipe_inode_info
*pipe
, struct file
*out
,
684 loff_t
*ppos
, size_t len
, unsigned int flags
)
686 struct splice_desc sd
= {
692 int nbufs
= pipe
->buffers
;
693 struct bio_vec
*array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
697 if (unlikely(!array
))
702 splice_from_pipe_begin(&sd
);
703 while (sd
.total_len
) {
704 struct iov_iter from
;
708 ret
= splice_from_pipe_next(pipe
, &sd
);
712 if (unlikely(nbufs
< pipe
->buffers
)) {
714 nbufs
= pipe
->buffers
;
715 array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
723 /* build the vector */
725 for (n
= 0, idx
= pipe
->curbuf
; left
&& n
< pipe
->nrbufs
; n
++, idx
++) {
726 struct pipe_buffer
*buf
= pipe
->bufs
+ idx
;
727 size_t this_len
= buf
->len
;
732 if (idx
== pipe
->buffers
- 1)
735 ret
= pipe_buf_confirm(pipe
, buf
);
742 array
[n
].bv_page
= buf
->page
;
743 array
[n
].bv_len
= this_len
;
744 array
[n
].bv_offset
= buf
->offset
;
748 iov_iter_bvec(&from
, ITER_BVEC
| WRITE
, array
, n
,
749 sd
.total_len
- left
);
750 ret
= vfs_iter_write(out
, &from
, &sd
.pos
, 0);
754 sd
.num_spliced
+= ret
;
758 /* dismiss the fully eaten buffers, adjust the partial one */
760 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
761 if (ret
>= buf
->len
) {
764 pipe_buf_release(pipe
, buf
);
765 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (pipe
->buffers
- 1);
768 sd
.need_wakeup
= true;
778 splice_from_pipe_end(pipe
, &sd
);
783 ret
= sd
.num_spliced
;
788 EXPORT_SYMBOL(iter_file_splice_write
);
790 static int write_pipe_buf(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
791 struct splice_desc
*sd
)
795 loff_t tmp
= sd
->pos
;
797 data
= kmap(buf
->page
);
798 ret
= __kernel_write(sd
->u
.file
, data
+ buf
->offset
, sd
->len
, &tmp
);
804 static ssize_t
default_file_splice_write(struct pipe_inode_info
*pipe
,
805 struct file
*out
, loff_t
*ppos
,
806 size_t len
, unsigned int flags
)
810 ret
= splice_from_pipe(pipe
, out
, ppos
, len
, flags
, write_pipe_buf
);
818 * generic_splice_sendpage - splice data from a pipe to a socket
819 * @pipe: pipe to splice from
820 * @out: socket to write to
821 * @ppos: position in @out
822 * @len: number of bytes to splice
823 * @flags: splice modifier flags
826 * Will send @len bytes from the pipe to a network socket. No data copying
830 ssize_t
generic_splice_sendpage(struct pipe_inode_info
*pipe
, struct file
*out
,
831 loff_t
*ppos
, size_t len
, unsigned int flags
)
833 return splice_from_pipe(pipe
, out
, ppos
, len
, flags
, pipe_to_sendpage
);
836 EXPORT_SYMBOL(generic_splice_sendpage
);
839 * Attempt to initiate a splice from pipe to file.
841 static long do_splice_from(struct pipe_inode_info
*pipe
, struct file
*out
,
842 loff_t
*ppos
, size_t len
, unsigned int flags
)
844 ssize_t (*splice_write
)(struct pipe_inode_info
*, struct file
*,
845 loff_t
*, size_t, unsigned int);
847 if (out
->f_op
->splice_write
)
848 splice_write
= out
->f_op
->splice_write
;
850 splice_write
= default_file_splice_write
;
852 return splice_write(pipe
, out
, ppos
, len
, flags
);
856 * Attempt to initiate a splice from a file to a pipe.
858 static long do_splice_to(struct file
*in
, loff_t
*ppos
,
859 struct pipe_inode_info
*pipe
, size_t len
,
862 ssize_t (*splice_read
)(struct file
*, loff_t
*,
863 struct pipe_inode_info
*, size_t, unsigned int);
866 if (unlikely(!(in
->f_mode
& FMODE_READ
)))
869 ret
= rw_verify_area(READ
, in
, ppos
, len
);
870 if (unlikely(ret
< 0))
873 if (unlikely(len
> MAX_RW_COUNT
))
876 if (in
->f_op
->splice_read
)
877 splice_read
= in
->f_op
->splice_read
;
879 splice_read
= default_file_splice_read
;
881 return splice_read(in
, ppos
, pipe
, len
, flags
);
885 * splice_direct_to_actor - splices data directly between two non-pipes
886 * @in: file to splice from
887 * @sd: actor information on where to splice to
888 * @actor: handles the data splicing
891 * This is a special case helper to splice directly between two
892 * points, without requiring an explicit pipe. Internally an allocated
893 * pipe is cached in the process, and reused during the lifetime of
897 ssize_t
splice_direct_to_actor(struct file
*in
, struct splice_desc
*sd
,
898 splice_direct_actor
*actor
)
900 struct pipe_inode_info
*pipe
;
907 * We require the input being a regular file, as we don't want to
908 * randomly drop data for eg socket -> socket splicing. Use the
909 * piped splicing for that!
911 i_mode
= file_inode(in
)->i_mode
;
912 if (unlikely(!S_ISREG(i_mode
) && !S_ISBLK(i_mode
)))
916 * neither in nor out is a pipe, setup an internal pipe attached to
917 * 'out' and transfer the wanted data from 'in' to 'out' through that
919 pipe
= current
->splice_pipe
;
920 if (unlikely(!pipe
)) {
921 pipe
= alloc_pipe_info();
926 * We don't have an immediate reader, but we'll read the stuff
927 * out of the pipe right after the splice_to_pipe(). So set
928 * PIPE_READERS appropriately.
932 current
->splice_pipe
= pipe
;
944 * Don't block on output, we have to drain the direct pipe.
946 sd
->flags
&= ~SPLICE_F_NONBLOCK
;
947 more
= sd
->flags
& SPLICE_F_MORE
;
949 WARN_ON_ONCE(pipe
->nrbufs
!= 0);
952 unsigned int pipe_pages
;
954 loff_t pos
= sd
->pos
, prev_pos
= pos
;
956 /* Don't try to read more the pipe has space for. */
957 pipe_pages
= pipe
->buffers
- pipe
->nrbufs
;
958 read_len
= min(len
, (size_t)pipe_pages
<< PAGE_SHIFT
);
959 ret
= do_splice_to(in
, &pos
, pipe
, read_len
, flags
);
960 if (unlikely(ret
<= 0))
964 sd
->total_len
= read_len
;
967 * If more data is pending, set SPLICE_F_MORE
968 * If this is the last data and SPLICE_F_MORE was not set
969 * initially, clears it.
972 sd
->flags
|= SPLICE_F_MORE
;
974 sd
->flags
&= ~SPLICE_F_MORE
;
976 * NOTE: nonblocking mode only applies to the input. We
977 * must not do the output in nonblocking mode as then we
978 * could get stuck data in the internal pipe:
980 ret
= actor(pipe
, sd
);
981 if (unlikely(ret
<= 0)) {
990 if (ret
< read_len
) {
991 sd
->pos
= prev_pos
+ ret
;
997 pipe
->nrbufs
= pipe
->curbuf
= 0;
1003 * If we did an incomplete transfer we must release
1004 * the pipe buffers in question:
1006 for (i
= 0; i
< pipe
->buffers
; i
++) {
1007 struct pipe_buffer
*buf
= pipe
->bufs
+ i
;
1010 pipe_buf_release(pipe
, buf
);
1018 EXPORT_SYMBOL(splice_direct_to_actor
);
1020 static int direct_splice_actor(struct pipe_inode_info
*pipe
,
1021 struct splice_desc
*sd
)
1023 struct file
*file
= sd
->u
.file
;
1025 return do_splice_from(pipe
, file
, sd
->opos
, sd
->total_len
,
1030 * do_splice_direct - splices data directly between two files
1031 * @in: file to splice from
1032 * @ppos: input file offset
1033 * @out: file to splice to
1034 * @opos: output file offset
1035 * @len: number of bytes to splice
1036 * @flags: splice modifier flags
1039 * For use by do_sendfile(). splice can easily emulate sendfile, but
1040 * doing it in the application would incur an extra system call
1041 * (splice in + splice out, as compared to just sendfile()). So this helper
1042 * can splice directly through a process-private pipe.
1045 long do_splice_direct(struct file
*in
, loff_t
*ppos
, struct file
*out
,
1046 loff_t
*opos
, size_t len
, unsigned int flags
)
1048 struct splice_desc sd
= {
1058 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1061 if (unlikely(out
->f_flags
& O_APPEND
))
1064 ret
= rw_verify_area(WRITE
, out
, opos
, len
);
1065 if (unlikely(ret
< 0))
1068 ret
= splice_direct_to_actor(in
, &sd
, direct_splice_actor
);
1074 EXPORT_SYMBOL(do_splice_direct
);
1076 static int wait_for_space(struct pipe_inode_info
*pipe
, unsigned flags
)
1079 if (unlikely(!pipe
->readers
)) {
1080 send_sig(SIGPIPE
, current
, 0);
1083 if (pipe
->nrbufs
!= pipe
->buffers
)
1085 if (flags
& SPLICE_F_NONBLOCK
)
1087 if (signal_pending(current
))
1088 return -ERESTARTSYS
;
1089 pipe
->waiting_writers
++;
1091 pipe
->waiting_writers
--;
1095 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1096 struct pipe_inode_info
*opipe
,
1097 size_t len
, unsigned int flags
);
1100 * Determine where to splice to/from.
1102 static long do_splice(struct file
*in
, loff_t __user
*off_in
,
1103 struct file
*out
, loff_t __user
*off_out
,
1104 size_t len
, unsigned int flags
)
1106 struct pipe_inode_info
*ipipe
;
1107 struct pipe_inode_info
*opipe
;
1111 ipipe
= get_pipe_info(in
);
1112 opipe
= get_pipe_info(out
);
1114 if (ipipe
&& opipe
) {
1115 if (off_in
|| off_out
)
1118 if (!(in
->f_mode
& FMODE_READ
))
1121 if (!(out
->f_mode
& FMODE_WRITE
))
1124 /* Splicing to self would be fun, but... */
1128 return splice_pipe_to_pipe(ipipe
, opipe
, len
, flags
);
1135 if (!(out
->f_mode
& FMODE_PWRITE
))
1137 if (copy_from_user(&offset
, off_out
, sizeof(loff_t
)))
1140 offset
= out
->f_pos
;
1143 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1146 if (unlikely(out
->f_flags
& O_APPEND
))
1149 ret
= rw_verify_area(WRITE
, out
, &offset
, len
);
1150 if (unlikely(ret
< 0))
1153 file_start_write(out
);
1154 ret
= do_splice_from(ipipe
, out
, &offset
, len
, flags
);
1155 file_end_write(out
);
1158 out
->f_pos
= offset
;
1159 else if (copy_to_user(off_out
, &offset
, sizeof(loff_t
)))
1169 if (!(in
->f_mode
& FMODE_PREAD
))
1171 if (copy_from_user(&offset
, off_in
, sizeof(loff_t
)))
1178 ret
= wait_for_space(opipe
, flags
);
1180 unsigned int pipe_pages
;
1182 /* Don't try to read more the pipe has space for. */
1183 pipe_pages
= opipe
->buffers
- opipe
->nrbufs
;
1184 len
= min(len
, (size_t)pipe_pages
<< PAGE_SHIFT
);
1186 ret
= do_splice_to(in
, &offset
, opipe
, len
, flags
);
1190 wakeup_pipe_readers(opipe
);
1193 else if (copy_to_user(off_in
, &offset
, sizeof(loff_t
)))
1202 static int iter_to_pipe(struct iov_iter
*from
,
1203 struct pipe_inode_info
*pipe
,
1206 struct pipe_buffer buf
= {
1207 .ops
= &user_page_pipe_buf_ops
,
1212 bool failed
= false;
1214 while (iov_iter_count(from
) && !failed
) {
1215 struct page
*pages
[16];
1220 copied
= iov_iter_get_pages(from
, pages
, ~0UL, 16, &start
);
1226 for (n
= 0; copied
; n
++, start
= 0) {
1227 int size
= min_t(int, copied
, PAGE_SIZE
- start
);
1229 buf
.page
= pages
[n
];
1232 ret
= add_to_pipe(pipe
, &buf
);
1233 if (unlikely(ret
< 0)) {
1236 iov_iter_advance(from
, ret
);
1245 return total
? total
: ret
;
1248 static int pipe_to_user(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
1249 struct splice_desc
*sd
)
1251 int n
= copy_page_to_iter(buf
->page
, buf
->offset
, sd
->len
, sd
->u
.data
);
1252 return n
== sd
->len
? n
: -EFAULT
;
1256 * For lack of a better implementation, implement vmsplice() to userspace
1257 * as a simple copy of the pipes pages to the user iov.
1259 static long vmsplice_to_user(struct file
*file
, struct iov_iter
*iter
,
1262 struct pipe_inode_info
*pipe
= get_pipe_info(file
);
1263 struct splice_desc sd
= {
1264 .total_len
= iov_iter_count(iter
),
1275 ret
= __splice_from_pipe(pipe
, &sd
, pipe_to_user
);
1283 * vmsplice splices a user address range into a pipe. It can be thought of
1284 * as splice-from-memory, where the regular splice is splice-from-file (or
1285 * to file). In both cases the output is a pipe, naturally.
1287 static long vmsplice_to_pipe(struct file
*file
, struct iov_iter
*iter
,
1290 struct pipe_inode_info
*pipe
;
1292 unsigned buf_flag
= 0;
1294 if (flags
& SPLICE_F_GIFT
)
1295 buf_flag
= PIPE_BUF_FLAG_GIFT
;
1297 pipe
= get_pipe_info(file
);
1302 ret
= wait_for_space(pipe
, flags
);
1304 ret
= iter_to_pipe(iter
, pipe
, buf_flag
);
1307 wakeup_pipe_readers(pipe
);
1311 static int vmsplice_type(struct fd f
, int *type
)
1315 if (f
.file
->f_mode
& FMODE_WRITE
) {
1317 } else if (f
.file
->f_mode
& FMODE_READ
) {
1327 * Note that vmsplice only really supports true splicing _from_ user memory
1328 * to a pipe, not the other way around. Splicing from user memory is a simple
1329 * operation that can be supported without any funky alignment restrictions
1330 * or nasty vm tricks. We simply map in the user memory and fill them into
1331 * a pipe. The reverse isn't quite as easy, though. There are two possible
1332 * solutions for that:
1334 * - memcpy() the data internally, at which point we might as well just
1335 * do a regular read() on the buffer anyway.
1336 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1337 * has restriction limitations on both ends of the pipe).
1339 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1342 static long do_vmsplice(struct file
*f
, struct iov_iter
*iter
, unsigned int flags
)
1344 if (unlikely(flags
& ~SPLICE_F_ALL
))
1347 if (!iov_iter_count(iter
))
1350 if (iov_iter_rw(iter
) == WRITE
)
1351 return vmsplice_to_pipe(f
, iter
, flags
);
1353 return vmsplice_to_user(f
, iter
, flags
);
1356 SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct iovec __user
*, uiov
,
1357 unsigned long, nr_segs
, unsigned int, flags
)
1359 struct iovec iovstack
[UIO_FASTIOV
];
1360 struct iovec
*iov
= iovstack
;
1361 struct iov_iter iter
;
1367 error
= vmsplice_type(f
, &type
);
1371 error
= import_iovec(type
, uiov
, nr_segs
,
1372 ARRAY_SIZE(iovstack
), &iov
, &iter
);
1374 error
= do_vmsplice(f
.file
, &iter
, flags
);
1381 #ifdef CONFIG_COMPAT
1382 COMPAT_SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct compat_iovec __user
*, iov32
,
1383 unsigned int, nr_segs
, unsigned int, flags
)
1385 struct iovec iovstack
[UIO_FASTIOV
];
1386 struct iovec
*iov
= iovstack
;
1387 struct iov_iter iter
;
1393 error
= vmsplice_type(f
, &type
);
1397 error
= compat_import_iovec(type
, iov32
, nr_segs
,
1398 ARRAY_SIZE(iovstack
), &iov
, &iter
);
1400 error
= do_vmsplice(f
.file
, &iter
, flags
);
1408 SYSCALL_DEFINE6(splice
, int, fd_in
, loff_t __user
*, off_in
,
1409 int, fd_out
, loff_t __user
*, off_out
,
1410 size_t, len
, unsigned int, flags
)
1418 if (unlikely(flags
& ~SPLICE_F_ALL
))
1424 if (in
.file
->f_mode
& FMODE_READ
) {
1425 out
= fdget(fd_out
);
1427 if (out
.file
->f_mode
& FMODE_WRITE
)
1428 error
= do_splice(in
.file
, off_in
,
1440 * Make sure there's data to read. Wait for input if we can, otherwise
1441 * return an appropriate error.
1443 static int ipipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1448 * Check ->nrbufs without the inode lock first. This function
1449 * is speculative anyways, so missing one is ok.
1457 while (!pipe
->nrbufs
) {
1458 if (signal_pending(current
)) {
1464 if (!pipe
->waiting_writers
) {
1465 if (flags
& SPLICE_F_NONBLOCK
) {
1478 * Make sure there's writeable room. Wait for room if we can, otherwise
1479 * return an appropriate error.
1481 static int opipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1486 * Check ->nrbufs without the inode lock first. This function
1487 * is speculative anyways, so missing one is ok.
1489 if (pipe
->nrbufs
< pipe
->buffers
)
1495 while (pipe
->nrbufs
>= pipe
->buffers
) {
1496 if (!pipe
->readers
) {
1497 send_sig(SIGPIPE
, current
, 0);
1501 if (flags
& SPLICE_F_NONBLOCK
) {
1505 if (signal_pending(current
)) {
1509 pipe
->waiting_writers
++;
1511 pipe
->waiting_writers
--;
1519 * Splice contents of ipipe to opipe.
1521 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1522 struct pipe_inode_info
*opipe
,
1523 size_t len
, unsigned int flags
)
1525 struct pipe_buffer
*ibuf
, *obuf
;
1527 bool input_wakeup
= false;
1531 ret
= ipipe_prep(ipipe
, flags
);
1535 ret
= opipe_prep(opipe
, flags
);
1540 * Potential ABBA deadlock, work around it by ordering lock
1541 * grabbing by pipe info address. Otherwise two different processes
1542 * could deadlock (one doing tee from A -> B, the other from B -> A).
1544 pipe_double_lock(ipipe
, opipe
);
1547 if (!opipe
->readers
) {
1548 send_sig(SIGPIPE
, current
, 0);
1554 if (!ipipe
->nrbufs
&& !ipipe
->writers
)
1558 * Cannot make any progress, because either the input
1559 * pipe is empty or the output pipe is full.
1561 if (!ipipe
->nrbufs
|| opipe
->nrbufs
>= opipe
->buffers
) {
1562 /* Already processed some buffers, break */
1566 if (flags
& SPLICE_F_NONBLOCK
) {
1572 * We raced with another reader/writer and haven't
1573 * managed to process any buffers. A zero return
1574 * value means EOF, so retry instead.
1581 ibuf
= ipipe
->bufs
+ ipipe
->curbuf
;
1582 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (opipe
->buffers
- 1);
1583 obuf
= opipe
->bufs
+ nbuf
;
1585 if (len
>= ibuf
->len
) {
1587 * Simply move the whole buffer from ipipe to opipe
1592 ipipe
->curbuf
= (ipipe
->curbuf
+ 1) & (ipipe
->buffers
- 1);
1594 input_wakeup
= true;
1597 * Get a reference to this pipe buffer,
1598 * so we can copy the contents over.
1600 if (!pipe_buf_get(ipipe
, ibuf
)) {
1608 * Don't inherit the gift flag, we need to
1609 * prevent multiple steals of this page.
1611 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1613 pipe_buf_mark_unmergeable(obuf
);
1617 ibuf
->offset
+= obuf
->len
;
1618 ibuf
->len
-= obuf
->len
;
1628 * If we put data in the output pipe, wakeup any potential readers.
1631 wakeup_pipe_readers(opipe
);
1634 wakeup_pipe_writers(ipipe
);
1640 * Link contents of ipipe to opipe.
1642 static int link_pipe(struct pipe_inode_info
*ipipe
,
1643 struct pipe_inode_info
*opipe
,
1644 size_t len
, unsigned int flags
)
1646 struct pipe_buffer
*ibuf
, *obuf
;
1647 int ret
= 0, i
= 0, nbuf
;
1650 * Potential ABBA deadlock, work around it by ordering lock
1651 * grabbing by pipe info address. Otherwise two different processes
1652 * could deadlock (one doing tee from A -> B, the other from B -> A).
1654 pipe_double_lock(ipipe
, opipe
);
1657 if (!opipe
->readers
) {
1658 send_sig(SIGPIPE
, current
, 0);
1665 * If we have iterated all input buffers or ran out of
1666 * output room, break.
1668 if (i
>= ipipe
->nrbufs
|| opipe
->nrbufs
>= opipe
->buffers
)
1671 ibuf
= ipipe
->bufs
+ ((ipipe
->curbuf
+ i
) & (ipipe
->buffers
-1));
1672 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (opipe
->buffers
- 1);
1675 * Get a reference to this pipe buffer,
1676 * so we can copy the contents over.
1678 if (!pipe_buf_get(ipipe
, ibuf
)) {
1684 obuf
= opipe
->bufs
+ nbuf
;
1688 * Don't inherit the gift flag, we need to
1689 * prevent multiple steals of this page.
1691 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1693 pipe_buf_mark_unmergeable(obuf
);
1695 if (obuf
->len
> len
)
1705 * return EAGAIN if we have the potential of some data in the
1706 * future, otherwise just return 0
1708 if (!ret
&& ipipe
->waiting_writers
&& (flags
& SPLICE_F_NONBLOCK
))
1715 * If we put data in the output pipe, wakeup any potential readers.
1718 wakeup_pipe_readers(opipe
);
1724 * This is a tee(1) implementation that works on pipes. It doesn't copy
1725 * any data, it simply references the 'in' pages on the 'out' pipe.
1726 * The 'flags' used are the SPLICE_F_* variants, currently the only
1727 * applicable one is SPLICE_F_NONBLOCK.
1729 static long do_tee(struct file
*in
, struct file
*out
, size_t len
,
1732 struct pipe_inode_info
*ipipe
= get_pipe_info(in
);
1733 struct pipe_inode_info
*opipe
= get_pipe_info(out
);
1737 * Duplicate the contents of ipipe to opipe without actually
1740 if (ipipe
&& opipe
&& ipipe
!= opipe
) {
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
,