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>
21 #include <linux/file.h>
22 #include <linux/pagemap.h>
23 #include <linux/splice.h>
24 #include <linux/memcontrol.h>
25 #include <linux/mm_inline.h>
26 #include <linux/swap.h>
27 #include <linux/writeback.h>
28 #include <linux/export.h>
29 #include <linux/syscalls.h>
30 #include <linux/uio.h>
31 #include <linux/security.h>
32 #include <linux/gfp.h>
33 #include <linux/socket.h>
34 #include <linux/compat.h>
38 * Attempt to steal a page from a pipe buffer. This should perhaps go into
39 * a vm helper function, it's already simplified quite a bit by the
40 * addition of remove_mapping(). If success is returned, the caller may
41 * attempt to reuse this page for another destination.
43 static int page_cache_pipe_buf_steal(struct pipe_inode_info
*pipe
,
44 struct pipe_buffer
*buf
)
46 struct page
*page
= buf
->page
;
47 struct address_space
*mapping
;
51 mapping
= page_mapping(page
);
53 WARN_ON(!PageUptodate(page
));
56 * At least for ext2 with nobh option, we need to wait on
57 * writeback completing on this page, since we'll remove it
58 * from the pagecache. Otherwise truncate wont wait on the
59 * page, allowing the disk blocks to be reused by someone else
60 * before we actually wrote our data to them. fs corruption
63 wait_on_page_writeback(page
);
65 if (page_has_private(page
) &&
66 !try_to_release_page(page
, GFP_KERNEL
))
70 * If we succeeded in removing the mapping, set LRU flag
73 if (remove_mapping(mapping
, page
)) {
74 buf
->flags
|= PIPE_BUF_FLAG_LRU
;
80 * Raced with truncate or failed to remove page from current
81 * address space, unlock and return failure.
88 static void page_cache_pipe_buf_release(struct pipe_inode_info
*pipe
,
89 struct pipe_buffer
*buf
)
92 buf
->flags
&= ~PIPE_BUF_FLAG_LRU
;
96 * Check whether the contents of buf is OK to access. Since the content
97 * is a page cache page, IO may be in flight.
99 static int page_cache_pipe_buf_confirm(struct pipe_inode_info
*pipe
,
100 struct pipe_buffer
*buf
)
102 struct page
*page
= buf
->page
;
105 if (!PageUptodate(page
)) {
109 * Page got truncated/unhashed. This will cause a 0-byte
110 * splice, if this is the first page.
112 if (!page
->mapping
) {
118 * Uh oh, read-error from disk.
120 if (!PageUptodate(page
)) {
126 * Page is ok afterall, we are done.
137 const struct pipe_buf_operations page_cache_pipe_buf_ops
= {
139 .confirm
= page_cache_pipe_buf_confirm
,
140 .release
= page_cache_pipe_buf_release
,
141 .steal
= page_cache_pipe_buf_steal
,
142 .get
= generic_pipe_buf_get
,
145 static int user_page_pipe_buf_steal(struct pipe_inode_info
*pipe
,
146 struct pipe_buffer
*buf
)
148 if (!(buf
->flags
& PIPE_BUF_FLAG_GIFT
))
151 buf
->flags
|= PIPE_BUF_FLAG_LRU
;
152 return generic_pipe_buf_steal(pipe
, buf
);
155 static const struct pipe_buf_operations user_page_pipe_buf_ops
= {
157 .confirm
= generic_pipe_buf_confirm
,
158 .release
= page_cache_pipe_buf_release
,
159 .steal
= user_page_pipe_buf_steal
,
160 .get
= generic_pipe_buf_get
,
163 static void wakeup_pipe_readers(struct pipe_inode_info
*pipe
)
166 if (waitqueue_active(&pipe
->wait
))
167 wake_up_interruptible(&pipe
->wait
);
168 kill_fasync(&pipe
->fasync_readers
, SIGIO
, POLL_IN
);
172 * splice_to_pipe - fill passed data into a pipe
173 * @pipe: pipe to fill
177 * @spd contains a map of pages and len/offset tuples, along with
178 * the struct pipe_buf_operations associated with these pages. This
179 * function will link that data to the pipe.
182 ssize_t
splice_to_pipe(struct pipe_inode_info
*pipe
,
183 struct splice_pipe_desc
*spd
)
185 unsigned int spd_pages
= spd
->nr_pages
;
186 int ret
= 0, page_nr
= 0;
191 if (unlikely(!pipe
->readers
)) {
192 send_sig(SIGPIPE
, current
, 0);
197 while (pipe
->nrbufs
< pipe
->buffers
) {
198 int newbuf
= (pipe
->curbuf
+ pipe
->nrbufs
) & (pipe
->buffers
- 1);
199 struct pipe_buffer
*buf
= pipe
->bufs
+ newbuf
;
201 buf
->page
= spd
->pages
[page_nr
];
202 buf
->offset
= spd
->partial
[page_nr
].offset
;
203 buf
->len
= spd
->partial
[page_nr
].len
;
204 buf
->private = spd
->partial
[page_nr
].private;
211 if (!--spd
->nr_pages
)
219 while (page_nr
< spd_pages
)
220 spd
->spd_release(spd
, page_nr
++);
224 EXPORT_SYMBOL_GPL(splice_to_pipe
);
226 ssize_t
add_to_pipe(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
)
230 if (unlikely(!pipe
->readers
)) {
231 send_sig(SIGPIPE
, current
, 0);
233 } else if (pipe
->nrbufs
== pipe
->buffers
) {
236 int newbuf
= (pipe
->curbuf
+ pipe
->nrbufs
) & (pipe
->buffers
- 1);
237 pipe
->bufs
[newbuf
] = *buf
;
241 pipe_buf_release(pipe
, buf
);
244 EXPORT_SYMBOL(add_to_pipe
);
246 void spd_release_page(struct splice_pipe_desc
*spd
, unsigned int i
)
248 put_page(spd
->pages
[i
]);
252 * Check if we need to grow the arrays holding pages and partial page
255 int splice_grow_spd(const struct pipe_inode_info
*pipe
, struct splice_pipe_desc
*spd
)
257 unsigned int buffers
= ACCESS_ONCE(pipe
->buffers
);
259 spd
->nr_pages_max
= buffers
;
260 if (buffers
<= PIPE_DEF_BUFFERS
)
263 spd
->pages
= kmalloc(buffers
* sizeof(struct page
*), GFP_KERNEL
);
264 spd
->partial
= kmalloc(buffers
* sizeof(struct partial_page
), GFP_KERNEL
);
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
,
305 isize
= i_size_read(in
->f_mapping
->host
);
306 if (unlikely(*ppos
>= isize
))
309 iov_iter_pipe(&to
, ITER_PIPE
| READ
, pipe
, len
);
311 init_sync_kiocb(&kiocb
, in
);
312 kiocb
.ki_pos
= *ppos
;
313 ret
= in
->f_op
->read_iter(&kiocb
, &to
);
315 *ppos
= kiocb
.ki_pos
;
317 } else if (ret
< 0) {
320 iov_iter_advance(&to
, 0); /* to free what was emitted */
322 * callers of ->splice_read() expect -EAGAIN on
323 * "can't put anything in there", rather than -EFAULT.
331 EXPORT_SYMBOL(generic_file_splice_read
);
333 const struct pipe_buf_operations default_pipe_buf_ops
= {
335 .confirm
= generic_pipe_buf_confirm
,
336 .release
= generic_pipe_buf_release
,
337 .steal
= generic_pipe_buf_steal
,
338 .get
= generic_pipe_buf_get
,
341 static int generic_pipe_buf_nosteal(struct pipe_inode_info
*pipe
,
342 struct pipe_buffer
*buf
)
347 /* Pipe buffer operations for a socket and similar. */
348 const struct pipe_buf_operations nosteal_pipe_buf_ops
= {
350 .confirm
= generic_pipe_buf_confirm
,
351 .release
= generic_pipe_buf_release
,
352 .steal
= generic_pipe_buf_nosteal
,
353 .get
= generic_pipe_buf_get
,
355 EXPORT_SYMBOL(nosteal_pipe_buf_ops
);
357 static ssize_t
kernel_readv(struct file
*file
, const struct kvec
*vec
,
358 unsigned long vlen
, loff_t offset
)
366 /* The cast to a user pointer is valid due to the set_fs() */
367 res
= vfs_readv(file
, (const struct iovec __user
*)vec
, vlen
, &pos
, 0);
373 ssize_t
kernel_write(struct file
*file
, const char *buf
, size_t count
,
381 /* The cast to a user pointer is valid due to the set_fs() */
382 res
= vfs_write(file
, (__force
const char __user
*)buf
, count
, &pos
);
387 EXPORT_SYMBOL(kernel_write
);
389 static ssize_t
default_file_splice_read(struct file
*in
, loff_t
*ppos
,
390 struct pipe_inode_info
*pipe
, size_t len
,
393 struct kvec
*vec
, __vec
[PIPE_DEF_BUFFERS
];
396 unsigned int nr_pages
;
397 size_t offset
, dummy
, copied
= 0;
401 if (pipe
->nrbufs
== pipe
->buffers
)
405 * Try to keep page boundaries matching to source pagecache ones -
406 * it probably won't be much help, but...
408 offset
= *ppos
& ~PAGE_MASK
;
410 iov_iter_pipe(&to
, ITER_PIPE
| READ
, pipe
, len
+ offset
);
412 res
= iov_iter_get_pages_alloc(&to
, &pages
, len
+ offset
, &dummy
);
416 nr_pages
= res
/ PAGE_SIZE
;
419 if (nr_pages
> PIPE_DEF_BUFFERS
) {
420 vec
= kmalloc(nr_pages
* sizeof(struct kvec
), GFP_KERNEL
);
421 if (unlikely(!vec
)) {
427 pipe
->bufs
[to
.idx
].offset
= offset
;
428 pipe
->bufs
[to
.idx
].len
-= offset
;
430 for (i
= 0; i
< nr_pages
; i
++) {
431 size_t this_len
= min_t(size_t, len
, PAGE_SIZE
- offset
);
432 vec
[i
].iov_base
= page_address(pages
[i
]) + offset
;
433 vec
[i
].iov_len
= this_len
;
438 res
= kernel_readv(in
, vec
, nr_pages
, *ppos
);
447 for (i
= 0; i
< nr_pages
; i
++)
450 iov_iter_advance(&to
, copied
); /* truncates and discards */
455 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
456 * using sendpage(). Return the number of bytes sent.
458 static int pipe_to_sendpage(struct pipe_inode_info
*pipe
,
459 struct pipe_buffer
*buf
, struct splice_desc
*sd
)
461 struct file
*file
= sd
->u
.file
;
462 loff_t pos
= sd
->pos
;
465 if (!likely(file
->f_op
->sendpage
))
468 more
= (sd
->flags
& SPLICE_F_MORE
) ? MSG_MORE
: 0;
470 if (sd
->len
< sd
->total_len
&& pipe
->nrbufs
> 1)
471 more
|= MSG_SENDPAGE_NOTLAST
;
473 return file
->f_op
->sendpage(file
, buf
->page
, buf
->offset
,
474 sd
->len
, &pos
, more
);
477 static void wakeup_pipe_writers(struct pipe_inode_info
*pipe
)
480 if (waitqueue_active(&pipe
->wait
))
481 wake_up_interruptible(&pipe
->wait
);
482 kill_fasync(&pipe
->fasync_writers
, SIGIO
, POLL_OUT
);
486 * splice_from_pipe_feed - feed available data from a pipe to a file
487 * @pipe: pipe to splice from
488 * @sd: information to @actor
489 * @actor: handler that splices the data
492 * This function loops over the pipe and calls @actor to do the
493 * actual moving of a single struct pipe_buffer to the desired
494 * destination. It returns when there's no more buffers left in
495 * the pipe or if the requested number of bytes (@sd->total_len)
496 * have been copied. It returns a positive number (one) if the
497 * pipe needs to be filled with more data, zero if the required
498 * number of bytes have been copied and -errno on error.
500 * This, together with splice_from_pipe_{begin,end,next}, may be
501 * used to implement the functionality of __splice_from_pipe() when
502 * locking is required around copying the pipe buffers to the
505 static int splice_from_pipe_feed(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
510 while (pipe
->nrbufs
) {
511 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
514 if (sd
->len
> sd
->total_len
)
515 sd
->len
= sd
->total_len
;
517 ret
= pipe_buf_confirm(pipe
, buf
);
524 ret
= actor(pipe
, buf
, sd
);
531 sd
->num_spliced
+= ret
;
534 sd
->total_len
-= ret
;
537 pipe_buf_release(pipe
, buf
);
538 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (pipe
->buffers
- 1);
541 sd
->need_wakeup
= true;
552 * splice_from_pipe_next - wait for some data to splice from
553 * @pipe: pipe to splice from
554 * @sd: information about the splice operation
557 * This function will wait for some data and return a positive
558 * value (one) if pipe buffers are available. It will return zero
559 * or -errno if no more data needs to be spliced.
561 static int splice_from_pipe_next(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
564 * Check for signal early to make process killable when there are
565 * always buffers available
567 if (signal_pending(current
))
570 while (!pipe
->nrbufs
) {
574 if (!pipe
->waiting_writers
&& sd
->num_spliced
)
577 if (sd
->flags
& SPLICE_F_NONBLOCK
)
580 if (signal_pending(current
))
583 if (sd
->need_wakeup
) {
584 wakeup_pipe_writers(pipe
);
585 sd
->need_wakeup
= false;
595 * splice_from_pipe_begin - start splicing from pipe
596 * @sd: information about the splice operation
599 * This function should be called before a loop containing
600 * splice_from_pipe_next() and splice_from_pipe_feed() to
601 * initialize the necessary fields of @sd.
603 static void splice_from_pipe_begin(struct splice_desc
*sd
)
606 sd
->need_wakeup
= false;
610 * splice_from_pipe_end - finish splicing from pipe
611 * @pipe: pipe to splice from
612 * @sd: information about the splice operation
615 * This function will wake up pipe writers if necessary. It should
616 * be called after a loop containing splice_from_pipe_next() and
617 * splice_from_pipe_feed().
619 static void splice_from_pipe_end(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
622 wakeup_pipe_writers(pipe
);
626 * __splice_from_pipe - splice data from a pipe to given actor
627 * @pipe: pipe to splice from
628 * @sd: information to @actor
629 * @actor: handler that splices the data
632 * This function does little more than loop over the pipe and call
633 * @actor to do the actual moving of a single struct pipe_buffer to
634 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
638 ssize_t
__splice_from_pipe(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
643 splice_from_pipe_begin(sd
);
646 ret
= splice_from_pipe_next(pipe
, sd
);
648 ret
= splice_from_pipe_feed(pipe
, sd
, actor
);
650 splice_from_pipe_end(pipe
, sd
);
652 return sd
->num_spliced
? sd
->num_spliced
: ret
;
654 EXPORT_SYMBOL(__splice_from_pipe
);
657 * splice_from_pipe - splice data from a pipe to a file
658 * @pipe: pipe to splice from
659 * @out: file to splice to
660 * @ppos: position in @out
661 * @len: how many bytes to splice
662 * @flags: splice modifier flags
663 * @actor: handler that splices the data
666 * See __splice_from_pipe. This function locks the pipe inode,
667 * otherwise it's identical to __splice_from_pipe().
670 ssize_t
splice_from_pipe(struct pipe_inode_info
*pipe
, struct file
*out
,
671 loff_t
*ppos
, size_t len
, unsigned int flags
,
675 struct splice_desc sd
= {
683 ret
= __splice_from_pipe(pipe
, &sd
, actor
);
690 * iter_file_splice_write - splice data from a pipe to a file
692 * @out: file to write to
693 * @ppos: position in @out
694 * @len: number of bytes to splice
695 * @flags: splice modifier flags
698 * Will either move or copy pages (determined by @flags options) from
699 * the given pipe inode to the given file.
700 * This one is ->write_iter-based.
704 iter_file_splice_write(struct pipe_inode_info
*pipe
, struct file
*out
,
705 loff_t
*ppos
, size_t len
, unsigned int flags
)
707 struct splice_desc sd
= {
713 int nbufs
= pipe
->buffers
;
714 struct bio_vec
*array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
718 if (unlikely(!array
))
723 splice_from_pipe_begin(&sd
);
724 while (sd
.total_len
) {
725 struct iov_iter from
;
729 ret
= splice_from_pipe_next(pipe
, &sd
);
733 if (unlikely(nbufs
< pipe
->buffers
)) {
735 nbufs
= pipe
->buffers
;
736 array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
744 /* build the vector */
746 for (n
= 0, idx
= pipe
->curbuf
; left
&& n
< pipe
->nrbufs
; n
++, idx
++) {
747 struct pipe_buffer
*buf
= pipe
->bufs
+ idx
;
748 size_t this_len
= buf
->len
;
753 if (idx
== pipe
->buffers
- 1)
756 ret
= pipe_buf_confirm(pipe
, buf
);
763 array
[n
].bv_page
= buf
->page
;
764 array
[n
].bv_len
= this_len
;
765 array
[n
].bv_offset
= buf
->offset
;
769 iov_iter_bvec(&from
, ITER_BVEC
| WRITE
, array
, n
,
770 sd
.total_len
- left
);
771 ret
= vfs_iter_write(out
, &from
, &sd
.pos
);
775 sd
.num_spliced
+= ret
;
779 /* dismiss the fully eaten buffers, adjust the partial one */
781 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
782 if (ret
>= buf
->len
) {
785 pipe_buf_release(pipe
, buf
);
786 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (pipe
->buffers
- 1);
789 sd
.need_wakeup
= true;
799 splice_from_pipe_end(pipe
, &sd
);
804 ret
= sd
.num_spliced
;
809 EXPORT_SYMBOL(iter_file_splice_write
);
811 static int write_pipe_buf(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
812 struct splice_desc
*sd
)
816 loff_t tmp
= sd
->pos
;
818 data
= kmap(buf
->page
);
819 ret
= __kernel_write(sd
->u
.file
, data
+ buf
->offset
, sd
->len
, &tmp
);
825 static ssize_t
default_file_splice_write(struct pipe_inode_info
*pipe
,
826 struct file
*out
, loff_t
*ppos
,
827 size_t len
, unsigned int flags
)
831 ret
= splice_from_pipe(pipe
, out
, ppos
, len
, flags
, write_pipe_buf
);
839 * generic_splice_sendpage - splice data from a pipe to a socket
840 * @pipe: pipe to splice from
841 * @out: socket to write to
842 * @ppos: position in @out
843 * @len: number of bytes to splice
844 * @flags: splice modifier flags
847 * Will send @len bytes from the pipe to a network socket. No data copying
851 ssize_t
generic_splice_sendpage(struct pipe_inode_info
*pipe
, struct file
*out
,
852 loff_t
*ppos
, size_t len
, unsigned int flags
)
854 return splice_from_pipe(pipe
, out
, ppos
, len
, flags
, pipe_to_sendpage
);
857 EXPORT_SYMBOL(generic_splice_sendpage
);
860 * Attempt to initiate a splice from pipe to file.
862 static long do_splice_from(struct pipe_inode_info
*pipe
, struct file
*out
,
863 loff_t
*ppos
, size_t len
, unsigned int flags
)
865 ssize_t (*splice_write
)(struct pipe_inode_info
*, struct file
*,
866 loff_t
*, size_t, unsigned int);
868 if (out
->f_op
->splice_write
)
869 splice_write
= out
->f_op
->splice_write
;
871 splice_write
= default_file_splice_write
;
873 return splice_write(pipe
, out
, ppos
, len
, flags
);
877 * Attempt to initiate a splice from a file to a pipe.
879 static long do_splice_to(struct file
*in
, loff_t
*ppos
,
880 struct pipe_inode_info
*pipe
, size_t len
,
883 ssize_t (*splice_read
)(struct file
*, loff_t
*,
884 struct pipe_inode_info
*, size_t, unsigned int);
887 if (unlikely(!(in
->f_mode
& FMODE_READ
)))
890 ret
= rw_verify_area(READ
, in
, ppos
, len
);
891 if (unlikely(ret
< 0))
894 if (unlikely(len
> MAX_RW_COUNT
))
897 if (in
->f_op
->splice_read
)
898 splice_read
= in
->f_op
->splice_read
;
900 splice_read
= default_file_splice_read
;
902 return splice_read(in
, ppos
, pipe
, len
, flags
);
906 * splice_direct_to_actor - splices data directly between two non-pipes
907 * @in: file to splice from
908 * @sd: actor information on where to splice to
909 * @actor: handles the data splicing
912 * This is a special case helper to splice directly between two
913 * points, without requiring an explicit pipe. Internally an allocated
914 * pipe is cached in the process, and reused during the lifetime of
918 ssize_t
splice_direct_to_actor(struct file
*in
, struct splice_desc
*sd
,
919 splice_direct_actor
*actor
)
921 struct pipe_inode_info
*pipe
;
928 * We require the input being a regular file, as we don't want to
929 * randomly drop data for eg socket -> socket splicing. Use the
930 * piped splicing for that!
932 i_mode
= file_inode(in
)->i_mode
;
933 if (unlikely(!S_ISREG(i_mode
) && !S_ISBLK(i_mode
)))
937 * neither in nor out is a pipe, setup an internal pipe attached to
938 * 'out' and transfer the wanted data from 'in' to 'out' through that
940 pipe
= current
->splice_pipe
;
941 if (unlikely(!pipe
)) {
942 pipe
= alloc_pipe_info();
947 * We don't have an immediate reader, but we'll read the stuff
948 * out of the pipe right after the splice_to_pipe(). So set
949 * PIPE_READERS appropriately.
953 current
->splice_pipe
= pipe
;
965 * Don't block on output, we have to drain the direct pipe.
967 sd
->flags
&= ~SPLICE_F_NONBLOCK
;
968 more
= sd
->flags
& SPLICE_F_MORE
;
972 loff_t pos
= sd
->pos
, prev_pos
= pos
;
974 ret
= do_splice_to(in
, &pos
, pipe
, len
, flags
);
975 if (unlikely(ret
<= 0))
979 sd
->total_len
= read_len
;
982 * If more data is pending, set SPLICE_F_MORE
983 * If this is the last data and SPLICE_F_MORE was not set
984 * initially, clears it.
987 sd
->flags
|= SPLICE_F_MORE
;
989 sd
->flags
&= ~SPLICE_F_MORE
;
991 * NOTE: nonblocking mode only applies to the input. We
992 * must not do the output in nonblocking mode as then we
993 * could get stuck data in the internal pipe:
995 ret
= actor(pipe
, sd
);
996 if (unlikely(ret
<= 0)) {
1005 if (ret
< read_len
) {
1006 sd
->pos
= prev_pos
+ ret
;
1012 pipe
->nrbufs
= pipe
->curbuf
= 0;
1018 * If we did an incomplete transfer we must release
1019 * the pipe buffers in question:
1021 for (i
= 0; i
< pipe
->buffers
; i
++) {
1022 struct pipe_buffer
*buf
= pipe
->bufs
+ i
;
1025 pipe_buf_release(pipe
, buf
);
1033 EXPORT_SYMBOL(splice_direct_to_actor
);
1035 static int direct_splice_actor(struct pipe_inode_info
*pipe
,
1036 struct splice_desc
*sd
)
1038 struct file
*file
= sd
->u
.file
;
1040 return do_splice_from(pipe
, file
, sd
->opos
, sd
->total_len
,
1045 * do_splice_direct - splices data directly between two files
1046 * @in: file to splice from
1047 * @ppos: input file offset
1048 * @out: file to splice to
1049 * @opos: output file offset
1050 * @len: number of bytes to splice
1051 * @flags: splice modifier flags
1054 * For use by do_sendfile(). splice can easily emulate sendfile, but
1055 * doing it in the application would incur an extra system call
1056 * (splice in + splice out, as compared to just sendfile()). So this helper
1057 * can splice directly through a process-private pipe.
1060 long do_splice_direct(struct file
*in
, loff_t
*ppos
, struct file
*out
,
1061 loff_t
*opos
, size_t len
, unsigned int flags
)
1063 struct splice_desc sd
= {
1073 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1076 if (unlikely(out
->f_flags
& O_APPEND
))
1079 ret
= rw_verify_area(WRITE
, out
, opos
, len
);
1080 if (unlikely(ret
< 0))
1083 ret
= splice_direct_to_actor(in
, &sd
, direct_splice_actor
);
1089 EXPORT_SYMBOL(do_splice_direct
);
1091 static int wait_for_space(struct pipe_inode_info
*pipe
, unsigned flags
)
1093 while (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
--;
1105 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1106 struct pipe_inode_info
*opipe
,
1107 size_t len
, unsigned int flags
);
1110 * Determine where to splice to/from.
1112 static long do_splice(struct file
*in
, loff_t __user
*off_in
,
1113 struct file
*out
, loff_t __user
*off_out
,
1114 size_t len
, unsigned int flags
)
1116 struct pipe_inode_info
*ipipe
;
1117 struct pipe_inode_info
*opipe
;
1121 ipipe
= get_pipe_info(in
);
1122 opipe
= get_pipe_info(out
);
1124 if (ipipe
&& opipe
) {
1125 if (off_in
|| off_out
)
1128 if (!(in
->f_mode
& FMODE_READ
))
1131 if (!(out
->f_mode
& FMODE_WRITE
))
1134 /* Splicing to self would be fun, but... */
1138 return splice_pipe_to_pipe(ipipe
, opipe
, len
, flags
);
1145 if (!(out
->f_mode
& FMODE_PWRITE
))
1147 if (copy_from_user(&offset
, off_out
, sizeof(loff_t
)))
1150 offset
= out
->f_pos
;
1153 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1156 if (unlikely(out
->f_flags
& O_APPEND
))
1159 ret
= rw_verify_area(WRITE
, out
, &offset
, len
);
1160 if (unlikely(ret
< 0))
1163 file_start_write(out
);
1164 ret
= do_splice_from(ipipe
, out
, &offset
, len
, flags
);
1165 file_end_write(out
);
1168 out
->f_pos
= offset
;
1169 else if (copy_to_user(off_out
, &offset
, sizeof(loff_t
)))
1179 if (!(in
->f_mode
& FMODE_PREAD
))
1181 if (copy_from_user(&offset
, off_in
, sizeof(loff_t
)))
1188 ret
= wait_for_space(opipe
, flags
);
1190 ret
= do_splice_to(in
, &offset
, opipe
, len
, flags
);
1193 wakeup_pipe_readers(opipe
);
1196 else if (copy_to_user(off_in
, &offset
, sizeof(loff_t
)))
1205 static int iter_to_pipe(struct iov_iter
*from
,
1206 struct pipe_inode_info
*pipe
,
1209 struct pipe_buffer buf
= {
1210 .ops
= &user_page_pipe_buf_ops
,
1215 bool failed
= false;
1217 while (iov_iter_count(from
) && !failed
) {
1218 struct page
*pages
[16];
1223 copied
= iov_iter_get_pages(from
, pages
, ~0UL, 16, &start
);
1229 for (n
= 0; copied
; n
++, start
= 0) {
1230 int size
= min_t(int, copied
, PAGE_SIZE
- start
);
1232 buf
.page
= pages
[n
];
1235 ret
= add_to_pipe(pipe
, &buf
);
1236 if (unlikely(ret
< 0)) {
1239 iov_iter_advance(from
, ret
);
1248 return total
? total
: ret
;
1251 static int pipe_to_user(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
1252 struct splice_desc
*sd
)
1254 int n
= copy_page_to_iter(buf
->page
, buf
->offset
, sd
->len
, sd
->u
.data
);
1255 return n
== sd
->len
? n
: -EFAULT
;
1259 * For lack of a better implementation, implement vmsplice() to userspace
1260 * as a simple copy of the pipes pages to the user iov.
1262 static long vmsplice_to_user(struct file
*file
, const struct iovec __user
*uiov
,
1263 unsigned long nr_segs
, unsigned int flags
)
1265 struct pipe_inode_info
*pipe
;
1266 struct splice_desc sd
;
1268 struct iovec iovstack
[UIO_FASTIOV
];
1269 struct iovec
*iov
= iovstack
;
1270 struct iov_iter iter
;
1272 pipe
= get_pipe_info(file
);
1276 ret
= import_iovec(READ
, uiov
, nr_segs
,
1277 ARRAY_SIZE(iovstack
), &iov
, &iter
);
1281 sd
.total_len
= iov_iter_count(&iter
);
1289 ret
= __splice_from_pipe(pipe
, &sd
, pipe_to_user
);
1298 * vmsplice splices a user address range into a pipe. It can be thought of
1299 * as splice-from-memory, where the regular splice is splice-from-file (or
1300 * to file). In both cases the output is a pipe, naturally.
1302 static long vmsplice_to_pipe(struct file
*file
, const struct iovec __user
*uiov
,
1303 unsigned long nr_segs
, unsigned int flags
)
1305 struct pipe_inode_info
*pipe
;
1306 struct iovec iovstack
[UIO_FASTIOV
];
1307 struct iovec
*iov
= iovstack
;
1308 struct iov_iter from
;
1310 unsigned buf_flag
= 0;
1312 if (flags
& SPLICE_F_GIFT
)
1313 buf_flag
= PIPE_BUF_FLAG_GIFT
;
1315 pipe
= get_pipe_info(file
);
1319 ret
= import_iovec(WRITE
, uiov
, nr_segs
,
1320 ARRAY_SIZE(iovstack
), &iov
, &from
);
1325 ret
= wait_for_space(pipe
, flags
);
1327 ret
= iter_to_pipe(&from
, pipe
, buf_flag
);
1330 wakeup_pipe_readers(pipe
);
1336 * Note that vmsplice only really supports true splicing _from_ user memory
1337 * to a pipe, not the other way around. Splicing from user memory is a simple
1338 * operation that can be supported without any funky alignment restrictions
1339 * or nasty vm tricks. We simply map in the user memory and fill them into
1340 * a pipe. The reverse isn't quite as easy, though. There are two possible
1341 * solutions for that:
1343 * - memcpy() the data internally, at which point we might as well just
1344 * do a regular read() on the buffer anyway.
1345 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1346 * has restriction limitations on both ends of the pipe).
1348 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1351 SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct iovec __user
*, iov
,
1352 unsigned long, nr_segs
, unsigned int, flags
)
1357 if (unlikely(nr_segs
> UIO_MAXIOV
))
1359 else if (unlikely(!nr_segs
))
1365 if (f
.file
->f_mode
& FMODE_WRITE
)
1366 error
= vmsplice_to_pipe(f
.file
, iov
, nr_segs
, flags
);
1367 else if (f
.file
->f_mode
& FMODE_READ
)
1368 error
= vmsplice_to_user(f
.file
, iov
, nr_segs
, flags
);
1376 #ifdef CONFIG_COMPAT
1377 COMPAT_SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct compat_iovec __user
*, iov32
,
1378 unsigned int, nr_segs
, unsigned int, flags
)
1381 struct iovec __user
*iov
;
1382 if (nr_segs
> UIO_MAXIOV
)
1384 iov
= compat_alloc_user_space(nr_segs
* sizeof(struct iovec
));
1385 for (i
= 0; i
< nr_segs
; i
++) {
1386 struct compat_iovec v
;
1387 if (get_user(v
.iov_base
, &iov32
[i
].iov_base
) ||
1388 get_user(v
.iov_len
, &iov32
[i
].iov_len
) ||
1389 put_user(compat_ptr(v
.iov_base
), &iov
[i
].iov_base
) ||
1390 put_user(v
.iov_len
, &iov
[i
].iov_len
))
1393 return sys_vmsplice(fd
, iov
, nr_segs
, flags
);
1397 SYSCALL_DEFINE6(splice
, int, fd_in
, loff_t __user
*, off_in
,
1398 int, fd_out
, loff_t __user
*, off_out
,
1399 size_t, len
, unsigned int, flags
)
1410 if (in
.file
->f_mode
& FMODE_READ
) {
1411 out
= fdget(fd_out
);
1413 if (out
.file
->f_mode
& FMODE_WRITE
)
1414 error
= do_splice(in
.file
, off_in
,
1426 * Make sure there's data to read. Wait for input if we can, otherwise
1427 * return an appropriate error.
1429 static int ipipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1434 * Check ->nrbufs without the inode lock first. This function
1435 * is speculative anyways, so missing one is ok.
1443 while (!pipe
->nrbufs
) {
1444 if (signal_pending(current
)) {
1450 if (!pipe
->waiting_writers
) {
1451 if (flags
& SPLICE_F_NONBLOCK
) {
1464 * Make sure there's writeable room. Wait for room if we can, otherwise
1465 * return an appropriate error.
1467 static int opipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1472 * Check ->nrbufs without the inode lock first. This function
1473 * is speculative anyways, so missing one is ok.
1475 if (pipe
->nrbufs
< pipe
->buffers
)
1481 while (pipe
->nrbufs
>= pipe
->buffers
) {
1482 if (!pipe
->readers
) {
1483 send_sig(SIGPIPE
, current
, 0);
1487 if (flags
& SPLICE_F_NONBLOCK
) {
1491 if (signal_pending(current
)) {
1495 pipe
->waiting_writers
++;
1497 pipe
->waiting_writers
--;
1505 * Splice contents of ipipe to opipe.
1507 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1508 struct pipe_inode_info
*opipe
,
1509 size_t len
, unsigned int flags
)
1511 struct pipe_buffer
*ibuf
, *obuf
;
1513 bool input_wakeup
= false;
1517 ret
= ipipe_prep(ipipe
, flags
);
1521 ret
= opipe_prep(opipe
, flags
);
1526 * Potential ABBA deadlock, work around it by ordering lock
1527 * grabbing by pipe info address. Otherwise two different processes
1528 * could deadlock (one doing tee from A -> B, the other from B -> A).
1530 pipe_double_lock(ipipe
, opipe
);
1533 if (!opipe
->readers
) {
1534 send_sig(SIGPIPE
, current
, 0);
1540 if (!ipipe
->nrbufs
&& !ipipe
->writers
)
1544 * Cannot make any progress, because either the input
1545 * pipe is empty or the output pipe is full.
1547 if (!ipipe
->nrbufs
|| opipe
->nrbufs
>= opipe
->buffers
) {
1548 /* Already processed some buffers, break */
1552 if (flags
& SPLICE_F_NONBLOCK
) {
1558 * We raced with another reader/writer and haven't
1559 * managed to process any buffers. A zero return
1560 * value means EOF, so retry instead.
1567 ibuf
= ipipe
->bufs
+ ipipe
->curbuf
;
1568 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (opipe
->buffers
- 1);
1569 obuf
= opipe
->bufs
+ nbuf
;
1571 if (len
>= ibuf
->len
) {
1573 * Simply move the whole buffer from ipipe to opipe
1578 ipipe
->curbuf
= (ipipe
->curbuf
+ 1) & (ipipe
->buffers
- 1);
1580 input_wakeup
= true;
1583 * Get a reference to this pipe buffer,
1584 * so we can copy the contents over.
1586 pipe_buf_get(ipipe
, ibuf
);
1590 * Don't inherit the gift flag, we need to
1591 * prevent multiple steals of this page.
1593 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1597 ibuf
->offset
+= obuf
->len
;
1598 ibuf
->len
-= obuf
->len
;
1608 * If we put data in the output pipe, wakeup any potential readers.
1611 wakeup_pipe_readers(opipe
);
1614 wakeup_pipe_writers(ipipe
);
1620 * Link contents of ipipe to opipe.
1622 static int link_pipe(struct pipe_inode_info
*ipipe
,
1623 struct pipe_inode_info
*opipe
,
1624 size_t len
, unsigned int flags
)
1626 struct pipe_buffer
*ibuf
, *obuf
;
1627 int ret
= 0, i
= 0, nbuf
;
1630 * Potential ABBA deadlock, work around it by ordering lock
1631 * grabbing by pipe info address. Otherwise two different processes
1632 * could deadlock (one doing tee from A -> B, the other from B -> A).
1634 pipe_double_lock(ipipe
, opipe
);
1637 if (!opipe
->readers
) {
1638 send_sig(SIGPIPE
, current
, 0);
1645 * If we have iterated all input buffers or ran out of
1646 * output room, break.
1648 if (i
>= ipipe
->nrbufs
|| opipe
->nrbufs
>= opipe
->buffers
)
1651 ibuf
= ipipe
->bufs
+ ((ipipe
->curbuf
+ i
) & (ipipe
->buffers
-1));
1652 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (opipe
->buffers
- 1);
1655 * Get a reference to this pipe buffer,
1656 * so we can copy the contents over.
1658 pipe_buf_get(ipipe
, ibuf
);
1660 obuf
= opipe
->bufs
+ nbuf
;
1664 * Don't inherit the gift flag, we need to
1665 * prevent multiple steals of this page.
1667 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1669 if (obuf
->len
> len
)
1679 * return EAGAIN if we have the potential of some data in the
1680 * future, otherwise just return 0
1682 if (!ret
&& ipipe
->waiting_writers
&& (flags
& SPLICE_F_NONBLOCK
))
1689 * If we put data in the output pipe, wakeup any potential readers.
1692 wakeup_pipe_readers(opipe
);
1698 * This is a tee(1) implementation that works on pipes. It doesn't copy
1699 * any data, it simply references the 'in' pages on the 'out' pipe.
1700 * The 'flags' used are the SPLICE_F_* variants, currently the only
1701 * applicable one is SPLICE_F_NONBLOCK.
1703 static long do_tee(struct file
*in
, struct file
*out
, size_t len
,
1706 struct pipe_inode_info
*ipipe
= get_pipe_info(in
);
1707 struct pipe_inode_info
*opipe
= get_pipe_info(out
);
1711 * Duplicate the contents of ipipe to opipe without actually
1714 if (ipipe
&& opipe
&& ipipe
!= opipe
) {
1716 * Keep going, unless we encounter an error. The ipipe/opipe
1717 * ordering doesn't really matter.
1719 ret
= ipipe_prep(ipipe
, flags
);
1721 ret
= opipe_prep(opipe
, flags
);
1723 ret
= link_pipe(ipipe
, opipe
, len
, flags
);
1730 SYSCALL_DEFINE4(tee
, int, fdin
, int, fdout
, size_t, len
, unsigned int, flags
)
1741 if (in
.file
->f_mode
& FMODE_READ
) {
1742 struct fd out
= fdget(fdout
);
1744 if (out
.file
->f_mode
& FMODE_WRITE
)
1745 error
= do_tee(in
.file
, out
.file
,