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
,
304 iov_iter_pipe(&to
, ITER_PIPE
| READ
, pipe
, len
);
306 init_sync_kiocb(&kiocb
, in
);
307 kiocb
.ki_pos
= *ppos
;
308 ret
= in
->f_op
->read_iter(&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 static 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 ssize_t
kernel_write(struct file
*file
, const char *buf
, size_t count
,
376 /* The cast to a user pointer is valid due to the set_fs() */
377 res
= vfs_write(file
, (__force
const char __user
*)buf
, count
, &pos
);
382 EXPORT_SYMBOL(kernel_write
);
384 static ssize_t
default_file_splice_read(struct file
*in
, loff_t
*ppos
,
385 struct pipe_inode_info
*pipe
, size_t len
,
388 struct kvec
*vec
, __vec
[PIPE_DEF_BUFFERS
];
391 unsigned int nr_pages
;
392 size_t offset
, dummy
, copied
= 0;
396 if (pipe
->nrbufs
== pipe
->buffers
)
400 * Try to keep page boundaries matching to source pagecache ones -
401 * it probably won't be much help, but...
403 offset
= *ppos
& ~PAGE_MASK
;
405 iov_iter_pipe(&to
, ITER_PIPE
| READ
, pipe
, len
+ offset
);
407 res
= iov_iter_get_pages_alloc(&to
, &pages
, len
+ offset
, &dummy
);
411 nr_pages
= res
/ PAGE_SIZE
;
414 if (nr_pages
> PIPE_DEF_BUFFERS
) {
415 vec
= kmalloc(nr_pages
* sizeof(struct kvec
), GFP_KERNEL
);
416 if (unlikely(!vec
)) {
422 pipe
->bufs
[to
.idx
].offset
= offset
;
423 pipe
->bufs
[to
.idx
].len
-= offset
;
425 for (i
= 0; i
< nr_pages
; i
++) {
426 size_t this_len
= min_t(size_t, len
, PAGE_SIZE
- offset
);
427 vec
[i
].iov_base
= page_address(pages
[i
]) + offset
;
428 vec
[i
].iov_len
= this_len
;
433 res
= kernel_readv(in
, vec
, nr_pages
, *ppos
);
442 for (i
= 0; i
< nr_pages
; i
++)
445 iov_iter_advance(&to
, copied
); /* truncates and discards */
450 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
451 * using sendpage(). Return the number of bytes sent.
453 static int pipe_to_sendpage(struct pipe_inode_info
*pipe
,
454 struct pipe_buffer
*buf
, struct splice_desc
*sd
)
456 struct file
*file
= sd
->u
.file
;
457 loff_t pos
= sd
->pos
;
460 if (!likely(file
->f_op
->sendpage
))
463 more
= (sd
->flags
& SPLICE_F_MORE
) ? MSG_MORE
: 0;
465 if (sd
->len
< sd
->total_len
&& pipe
->nrbufs
> 1)
466 more
|= MSG_SENDPAGE_NOTLAST
;
468 return file
->f_op
->sendpage(file
, buf
->page
, buf
->offset
,
469 sd
->len
, &pos
, more
);
472 static void wakeup_pipe_writers(struct pipe_inode_info
*pipe
)
475 if (waitqueue_active(&pipe
->wait
))
476 wake_up_interruptible(&pipe
->wait
);
477 kill_fasync(&pipe
->fasync_writers
, SIGIO
, POLL_OUT
);
481 * splice_from_pipe_feed - feed available data from a pipe to a file
482 * @pipe: pipe to splice from
483 * @sd: information to @actor
484 * @actor: handler that splices the data
487 * This function loops over the pipe and calls @actor to do the
488 * actual moving of a single struct pipe_buffer to the desired
489 * destination. It returns when there's no more buffers left in
490 * the pipe or if the requested number of bytes (@sd->total_len)
491 * have been copied. It returns a positive number (one) if the
492 * pipe needs to be filled with more data, zero if the required
493 * number of bytes have been copied and -errno on error.
495 * This, together with splice_from_pipe_{begin,end,next}, may be
496 * used to implement the functionality of __splice_from_pipe() when
497 * locking is required around copying the pipe buffers to the
500 static int splice_from_pipe_feed(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
505 while (pipe
->nrbufs
) {
506 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
509 if (sd
->len
> sd
->total_len
)
510 sd
->len
= sd
->total_len
;
512 ret
= pipe_buf_confirm(pipe
, buf
);
519 ret
= actor(pipe
, buf
, sd
);
526 sd
->num_spliced
+= ret
;
529 sd
->total_len
-= ret
;
532 pipe_buf_release(pipe
, buf
);
533 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (pipe
->buffers
- 1);
536 sd
->need_wakeup
= true;
547 * splice_from_pipe_next - wait for some data to splice from
548 * @pipe: pipe to splice from
549 * @sd: information about the splice operation
552 * This function will wait for some data and return a positive
553 * value (one) if pipe buffers are available. It will return zero
554 * or -errno if no more data needs to be spliced.
556 static int splice_from_pipe_next(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
559 * Check for signal early to make process killable when there are
560 * always buffers available
562 if (signal_pending(current
))
565 while (!pipe
->nrbufs
) {
569 if (!pipe
->waiting_writers
&& sd
->num_spliced
)
572 if (sd
->flags
& SPLICE_F_NONBLOCK
)
575 if (signal_pending(current
))
578 if (sd
->need_wakeup
) {
579 wakeup_pipe_writers(pipe
);
580 sd
->need_wakeup
= false;
590 * splice_from_pipe_begin - start splicing from pipe
591 * @sd: information about the splice operation
594 * This function should be called before a loop containing
595 * splice_from_pipe_next() and splice_from_pipe_feed() to
596 * initialize the necessary fields of @sd.
598 static void splice_from_pipe_begin(struct splice_desc
*sd
)
601 sd
->need_wakeup
= false;
605 * splice_from_pipe_end - finish splicing from pipe
606 * @pipe: pipe to splice from
607 * @sd: information about the splice operation
610 * This function will wake up pipe writers if necessary. It should
611 * be called after a loop containing splice_from_pipe_next() and
612 * splice_from_pipe_feed().
614 static void splice_from_pipe_end(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
617 wakeup_pipe_writers(pipe
);
621 * __splice_from_pipe - splice data from a pipe to given actor
622 * @pipe: pipe to splice from
623 * @sd: information to @actor
624 * @actor: handler that splices the data
627 * This function does little more than loop over the pipe and call
628 * @actor to do the actual moving of a single struct pipe_buffer to
629 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
633 ssize_t
__splice_from_pipe(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
638 splice_from_pipe_begin(sd
);
641 ret
= splice_from_pipe_next(pipe
, sd
);
643 ret
= splice_from_pipe_feed(pipe
, sd
, actor
);
645 splice_from_pipe_end(pipe
, sd
);
647 return sd
->num_spliced
? sd
->num_spliced
: ret
;
649 EXPORT_SYMBOL(__splice_from_pipe
);
652 * splice_from_pipe - splice data from a pipe to a file
653 * @pipe: pipe to splice from
654 * @out: file to splice to
655 * @ppos: position in @out
656 * @len: how many bytes to splice
657 * @flags: splice modifier flags
658 * @actor: handler that splices the data
661 * See __splice_from_pipe. This function locks the pipe inode,
662 * otherwise it's identical to __splice_from_pipe().
665 ssize_t
splice_from_pipe(struct pipe_inode_info
*pipe
, struct file
*out
,
666 loff_t
*ppos
, size_t len
, unsigned int flags
,
670 struct splice_desc sd
= {
678 ret
= __splice_from_pipe(pipe
, &sd
, actor
);
685 * iter_file_splice_write - splice data from a pipe to a file
687 * @out: file to write to
688 * @ppos: position in @out
689 * @len: number of bytes to splice
690 * @flags: splice modifier flags
693 * Will either move or copy pages (determined by @flags options) from
694 * the given pipe inode to the given file.
695 * This one is ->write_iter-based.
699 iter_file_splice_write(struct pipe_inode_info
*pipe
, struct file
*out
,
700 loff_t
*ppos
, size_t len
, unsigned int flags
)
702 struct splice_desc sd
= {
708 int nbufs
= pipe
->buffers
;
709 struct bio_vec
*array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
713 if (unlikely(!array
))
718 splice_from_pipe_begin(&sd
);
719 while (sd
.total_len
) {
720 struct iov_iter from
;
724 ret
= splice_from_pipe_next(pipe
, &sd
);
728 if (unlikely(nbufs
< pipe
->buffers
)) {
730 nbufs
= pipe
->buffers
;
731 array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
739 /* build the vector */
741 for (n
= 0, idx
= pipe
->curbuf
; left
&& n
< pipe
->nrbufs
; n
++, idx
++) {
742 struct pipe_buffer
*buf
= pipe
->bufs
+ idx
;
743 size_t this_len
= buf
->len
;
748 if (idx
== pipe
->buffers
- 1)
751 ret
= pipe_buf_confirm(pipe
, buf
);
758 array
[n
].bv_page
= buf
->page
;
759 array
[n
].bv_len
= this_len
;
760 array
[n
].bv_offset
= buf
->offset
;
764 iov_iter_bvec(&from
, ITER_BVEC
| WRITE
, array
, n
,
765 sd
.total_len
- left
);
766 ret
= vfs_iter_write(out
, &from
, &sd
.pos
);
770 sd
.num_spliced
+= ret
;
774 /* dismiss the fully eaten buffers, adjust the partial one */
776 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
777 if (ret
>= buf
->len
) {
780 pipe_buf_release(pipe
, buf
);
781 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (pipe
->buffers
- 1);
784 sd
.need_wakeup
= true;
794 splice_from_pipe_end(pipe
, &sd
);
799 ret
= sd
.num_spliced
;
804 EXPORT_SYMBOL(iter_file_splice_write
);
806 static int write_pipe_buf(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
807 struct splice_desc
*sd
)
811 loff_t tmp
= sd
->pos
;
813 data
= kmap(buf
->page
);
814 ret
= __kernel_write(sd
->u
.file
, data
+ buf
->offset
, sd
->len
, &tmp
);
820 static ssize_t
default_file_splice_write(struct pipe_inode_info
*pipe
,
821 struct file
*out
, loff_t
*ppos
,
822 size_t len
, unsigned int flags
)
826 ret
= splice_from_pipe(pipe
, out
, ppos
, len
, flags
, write_pipe_buf
);
834 * generic_splice_sendpage - splice data from a pipe to a socket
835 * @pipe: pipe to splice from
836 * @out: socket to write to
837 * @ppos: position in @out
838 * @len: number of bytes to splice
839 * @flags: splice modifier flags
842 * Will send @len bytes from the pipe to a network socket. No data copying
846 ssize_t
generic_splice_sendpage(struct pipe_inode_info
*pipe
, struct file
*out
,
847 loff_t
*ppos
, size_t len
, unsigned int flags
)
849 return splice_from_pipe(pipe
, out
, ppos
, len
, flags
, pipe_to_sendpage
);
852 EXPORT_SYMBOL(generic_splice_sendpage
);
855 * Attempt to initiate a splice from pipe to file.
857 static long do_splice_from(struct pipe_inode_info
*pipe
, struct file
*out
,
858 loff_t
*ppos
, size_t len
, unsigned int flags
)
860 ssize_t (*splice_write
)(struct pipe_inode_info
*, struct file
*,
861 loff_t
*, size_t, unsigned int);
863 if (out
->f_op
->splice_write
)
864 splice_write
= out
->f_op
->splice_write
;
866 splice_write
= default_file_splice_write
;
868 return splice_write(pipe
, out
, ppos
, len
, flags
);
872 * Attempt to initiate a splice from a file to a pipe.
874 static long do_splice_to(struct file
*in
, loff_t
*ppos
,
875 struct pipe_inode_info
*pipe
, size_t len
,
878 ssize_t (*splice_read
)(struct file
*, loff_t
*,
879 struct pipe_inode_info
*, size_t, unsigned int);
882 if (unlikely(!(in
->f_mode
& FMODE_READ
)))
885 ret
= rw_verify_area(READ
, in
, ppos
, len
);
886 if (unlikely(ret
< 0))
889 if (unlikely(len
> MAX_RW_COUNT
))
892 if (in
->f_op
->splice_read
)
893 splice_read
= in
->f_op
->splice_read
;
895 splice_read
= default_file_splice_read
;
897 return splice_read(in
, ppos
, pipe
, len
, flags
);
901 * splice_direct_to_actor - splices data directly between two non-pipes
902 * @in: file to splice from
903 * @sd: actor information on where to splice to
904 * @actor: handles the data splicing
907 * This is a special case helper to splice directly between two
908 * points, without requiring an explicit pipe. Internally an allocated
909 * pipe is cached in the process, and reused during the lifetime of
913 ssize_t
splice_direct_to_actor(struct file
*in
, struct splice_desc
*sd
,
914 splice_direct_actor
*actor
)
916 struct pipe_inode_info
*pipe
;
923 * We require the input being a regular file, as we don't want to
924 * randomly drop data for eg socket -> socket splicing. Use the
925 * piped splicing for that!
927 i_mode
= file_inode(in
)->i_mode
;
928 if (unlikely(!S_ISREG(i_mode
) && !S_ISBLK(i_mode
)))
932 * neither in nor out is a pipe, setup an internal pipe attached to
933 * 'out' and transfer the wanted data from 'in' to 'out' through that
935 pipe
= current
->splice_pipe
;
936 if (unlikely(!pipe
)) {
937 pipe
= alloc_pipe_info();
942 * We don't have an immediate reader, but we'll read the stuff
943 * out of the pipe right after the splice_to_pipe(). So set
944 * PIPE_READERS appropriately.
948 current
->splice_pipe
= pipe
;
960 * Don't block on output, we have to drain the direct pipe.
962 sd
->flags
&= ~SPLICE_F_NONBLOCK
;
963 more
= sd
->flags
& SPLICE_F_MORE
;
967 loff_t pos
= sd
->pos
, prev_pos
= pos
;
969 ret
= do_splice_to(in
, &pos
, pipe
, len
, flags
);
970 if (unlikely(ret
<= 0))
974 sd
->total_len
= read_len
;
977 * If more data is pending, set SPLICE_F_MORE
978 * If this is the last data and SPLICE_F_MORE was not set
979 * initially, clears it.
982 sd
->flags
|= SPLICE_F_MORE
;
984 sd
->flags
&= ~SPLICE_F_MORE
;
986 * NOTE: nonblocking mode only applies to the input. We
987 * must not do the output in nonblocking mode as then we
988 * could get stuck data in the internal pipe:
990 ret
= actor(pipe
, sd
);
991 if (unlikely(ret
<= 0)) {
1000 if (ret
< read_len
) {
1001 sd
->pos
= prev_pos
+ ret
;
1007 pipe
->nrbufs
= pipe
->curbuf
= 0;
1013 * If we did an incomplete transfer we must release
1014 * the pipe buffers in question:
1016 for (i
= 0; i
< pipe
->buffers
; i
++) {
1017 struct pipe_buffer
*buf
= pipe
->bufs
+ i
;
1020 pipe_buf_release(pipe
, buf
);
1028 EXPORT_SYMBOL(splice_direct_to_actor
);
1030 static int direct_splice_actor(struct pipe_inode_info
*pipe
,
1031 struct splice_desc
*sd
)
1033 struct file
*file
= sd
->u
.file
;
1035 return do_splice_from(pipe
, file
, sd
->opos
, sd
->total_len
,
1040 * do_splice_direct - splices data directly between two files
1041 * @in: file to splice from
1042 * @ppos: input file offset
1043 * @out: file to splice to
1044 * @opos: output file offset
1045 * @len: number of bytes to splice
1046 * @flags: splice modifier flags
1049 * For use by do_sendfile(). splice can easily emulate sendfile, but
1050 * doing it in the application would incur an extra system call
1051 * (splice in + splice out, as compared to just sendfile()). So this helper
1052 * can splice directly through a process-private pipe.
1055 long do_splice_direct(struct file
*in
, loff_t
*ppos
, struct file
*out
,
1056 loff_t
*opos
, size_t len
, unsigned int flags
)
1058 struct splice_desc sd
= {
1068 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1071 if (unlikely(out
->f_flags
& O_APPEND
))
1074 ret
= rw_verify_area(WRITE
, out
, opos
, len
);
1075 if (unlikely(ret
< 0))
1078 ret
= splice_direct_to_actor(in
, &sd
, direct_splice_actor
);
1084 EXPORT_SYMBOL(do_splice_direct
);
1086 static int wait_for_space(struct pipe_inode_info
*pipe
, unsigned flags
)
1088 while (pipe
->nrbufs
== pipe
->buffers
) {
1089 if (flags
& SPLICE_F_NONBLOCK
)
1091 if (signal_pending(current
))
1092 return -ERESTARTSYS
;
1093 pipe
->waiting_writers
++;
1095 pipe
->waiting_writers
--;
1100 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1101 struct pipe_inode_info
*opipe
,
1102 size_t len
, unsigned int flags
);
1105 * Determine where to splice to/from.
1107 static long do_splice(struct file
*in
, loff_t __user
*off_in
,
1108 struct file
*out
, loff_t __user
*off_out
,
1109 size_t len
, unsigned int flags
)
1111 struct pipe_inode_info
*ipipe
;
1112 struct pipe_inode_info
*opipe
;
1116 ipipe
= get_pipe_info(in
);
1117 opipe
= get_pipe_info(out
);
1119 if (ipipe
&& opipe
) {
1120 if (off_in
|| off_out
)
1123 if (!(in
->f_mode
& FMODE_READ
))
1126 if (!(out
->f_mode
& FMODE_WRITE
))
1129 /* Splicing to self would be fun, but... */
1133 return splice_pipe_to_pipe(ipipe
, opipe
, len
, flags
);
1140 if (!(out
->f_mode
& FMODE_PWRITE
))
1142 if (copy_from_user(&offset
, off_out
, sizeof(loff_t
)))
1145 offset
= out
->f_pos
;
1148 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1151 if (unlikely(out
->f_flags
& O_APPEND
))
1154 ret
= rw_verify_area(WRITE
, out
, &offset
, len
);
1155 if (unlikely(ret
< 0))
1158 file_start_write(out
);
1159 ret
= do_splice_from(ipipe
, out
, &offset
, len
, flags
);
1160 file_end_write(out
);
1163 out
->f_pos
= offset
;
1164 else if (copy_to_user(off_out
, &offset
, sizeof(loff_t
)))
1174 if (!(in
->f_mode
& FMODE_PREAD
))
1176 if (copy_from_user(&offset
, off_in
, sizeof(loff_t
)))
1183 ret
= wait_for_space(opipe
, flags
);
1185 ret
= do_splice_to(in
, &offset
, opipe
, len
, flags
);
1188 wakeup_pipe_readers(opipe
);
1191 else if (copy_to_user(off_in
, &offset
, sizeof(loff_t
)))
1200 static int iter_to_pipe(struct iov_iter
*from
,
1201 struct pipe_inode_info
*pipe
,
1204 struct pipe_buffer buf
= {
1205 .ops
= &user_page_pipe_buf_ops
,
1210 bool failed
= false;
1212 while (iov_iter_count(from
) && !failed
) {
1213 struct page
*pages
[16];
1218 copied
= iov_iter_get_pages(from
, pages
, ~0UL, 16, &start
);
1224 for (n
= 0; copied
; n
++, start
= 0) {
1225 int size
= min_t(int, copied
, PAGE_SIZE
- start
);
1227 buf
.page
= pages
[n
];
1230 ret
= add_to_pipe(pipe
, &buf
);
1231 if (unlikely(ret
< 0)) {
1234 iov_iter_advance(from
, ret
);
1243 return total
? total
: ret
;
1246 static int pipe_to_user(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
1247 struct splice_desc
*sd
)
1249 int n
= copy_page_to_iter(buf
->page
, buf
->offset
, sd
->len
, sd
->u
.data
);
1250 return n
== sd
->len
? n
: -EFAULT
;
1254 * For lack of a better implementation, implement vmsplice() to userspace
1255 * as a simple copy of the pipes pages to the user iov.
1257 static long vmsplice_to_user(struct file
*file
, const struct iovec __user
*uiov
,
1258 unsigned long nr_segs
, unsigned int flags
)
1260 struct pipe_inode_info
*pipe
;
1261 struct splice_desc sd
;
1263 struct iovec iovstack
[UIO_FASTIOV
];
1264 struct iovec
*iov
= iovstack
;
1265 struct iov_iter iter
;
1267 pipe
= get_pipe_info(file
);
1271 ret
= import_iovec(READ
, uiov
, nr_segs
,
1272 ARRAY_SIZE(iovstack
), &iov
, &iter
);
1276 sd
.total_len
= iov_iter_count(&iter
);
1284 ret
= __splice_from_pipe(pipe
, &sd
, pipe_to_user
);
1293 * vmsplice splices a user address range into a pipe. It can be thought of
1294 * as splice-from-memory, where the regular splice is splice-from-file (or
1295 * to file). In both cases the output is a pipe, naturally.
1297 static long vmsplice_to_pipe(struct file
*file
, const struct iovec __user
*uiov
,
1298 unsigned long nr_segs
, unsigned int flags
)
1300 struct pipe_inode_info
*pipe
;
1301 struct iovec iovstack
[UIO_FASTIOV
];
1302 struct iovec
*iov
= iovstack
;
1303 struct iov_iter from
;
1305 unsigned buf_flag
= 0;
1307 if (flags
& SPLICE_F_GIFT
)
1308 buf_flag
= PIPE_BUF_FLAG_GIFT
;
1310 pipe
= get_pipe_info(file
);
1314 ret
= import_iovec(WRITE
, uiov
, nr_segs
,
1315 ARRAY_SIZE(iovstack
), &iov
, &from
);
1320 ret
= wait_for_space(pipe
, flags
);
1322 ret
= iter_to_pipe(&from
, pipe
, buf_flag
);
1325 wakeup_pipe_readers(pipe
);
1331 * Note that vmsplice only really supports true splicing _from_ user memory
1332 * to a pipe, not the other way around. Splicing from user memory is a simple
1333 * operation that can be supported without any funky alignment restrictions
1334 * or nasty vm tricks. We simply map in the user memory and fill them into
1335 * a pipe. The reverse isn't quite as easy, though. There are two possible
1336 * solutions for that:
1338 * - memcpy() the data internally, at which point we might as well just
1339 * do a regular read() on the buffer anyway.
1340 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1341 * has restriction limitations on both ends of the pipe).
1343 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1346 SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct iovec __user
*, iov
,
1347 unsigned long, nr_segs
, unsigned int, flags
)
1352 if (unlikely(nr_segs
> UIO_MAXIOV
))
1354 else if (unlikely(!nr_segs
))
1360 if (f
.file
->f_mode
& FMODE_WRITE
)
1361 error
= vmsplice_to_pipe(f
.file
, iov
, nr_segs
, flags
);
1362 else if (f
.file
->f_mode
& FMODE_READ
)
1363 error
= vmsplice_to_user(f
.file
, iov
, nr_segs
, flags
);
1371 #ifdef CONFIG_COMPAT
1372 COMPAT_SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct compat_iovec __user
*, iov32
,
1373 unsigned int, nr_segs
, unsigned int, flags
)
1376 struct iovec __user
*iov
;
1377 if (nr_segs
> UIO_MAXIOV
)
1379 iov
= compat_alloc_user_space(nr_segs
* sizeof(struct iovec
));
1380 for (i
= 0; i
< nr_segs
; i
++) {
1381 struct compat_iovec v
;
1382 if (get_user(v
.iov_base
, &iov32
[i
].iov_base
) ||
1383 get_user(v
.iov_len
, &iov32
[i
].iov_len
) ||
1384 put_user(compat_ptr(v
.iov_base
), &iov
[i
].iov_base
) ||
1385 put_user(v
.iov_len
, &iov
[i
].iov_len
))
1388 return sys_vmsplice(fd
, iov
, nr_segs
, flags
);
1392 SYSCALL_DEFINE6(splice
, int, fd_in
, loff_t __user
*, off_in
,
1393 int, fd_out
, loff_t __user
*, off_out
,
1394 size_t, len
, unsigned int, flags
)
1405 if (in
.file
->f_mode
& FMODE_READ
) {
1406 out
= fdget(fd_out
);
1408 if (out
.file
->f_mode
& FMODE_WRITE
)
1409 error
= do_splice(in
.file
, off_in
,
1421 * Make sure there's data to read. Wait for input if we can, otherwise
1422 * return an appropriate error.
1424 static int ipipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1429 * Check ->nrbufs without the inode lock first. This function
1430 * is speculative anyways, so missing one is ok.
1438 while (!pipe
->nrbufs
) {
1439 if (signal_pending(current
)) {
1445 if (!pipe
->waiting_writers
) {
1446 if (flags
& SPLICE_F_NONBLOCK
) {
1459 * Make sure there's writeable room. Wait for room if we can, otherwise
1460 * return an appropriate error.
1462 static int opipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1467 * Check ->nrbufs without the inode lock first. This function
1468 * is speculative anyways, so missing one is ok.
1470 if (pipe
->nrbufs
< pipe
->buffers
)
1476 while (pipe
->nrbufs
>= pipe
->buffers
) {
1477 if (!pipe
->readers
) {
1478 send_sig(SIGPIPE
, current
, 0);
1482 if (flags
& SPLICE_F_NONBLOCK
) {
1486 if (signal_pending(current
)) {
1490 pipe
->waiting_writers
++;
1492 pipe
->waiting_writers
--;
1500 * Splice contents of ipipe to opipe.
1502 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1503 struct pipe_inode_info
*opipe
,
1504 size_t len
, unsigned int flags
)
1506 struct pipe_buffer
*ibuf
, *obuf
;
1508 bool input_wakeup
= false;
1512 ret
= ipipe_prep(ipipe
, flags
);
1516 ret
= opipe_prep(opipe
, flags
);
1521 * Potential ABBA deadlock, work around it by ordering lock
1522 * grabbing by pipe info address. Otherwise two different processes
1523 * could deadlock (one doing tee from A -> B, the other from B -> A).
1525 pipe_double_lock(ipipe
, opipe
);
1528 if (!opipe
->readers
) {
1529 send_sig(SIGPIPE
, current
, 0);
1535 if (!ipipe
->nrbufs
&& !ipipe
->writers
)
1539 * Cannot make any progress, because either the input
1540 * pipe is empty or the output pipe is full.
1542 if (!ipipe
->nrbufs
|| opipe
->nrbufs
>= opipe
->buffers
) {
1543 /* Already processed some buffers, break */
1547 if (flags
& SPLICE_F_NONBLOCK
) {
1553 * We raced with another reader/writer and haven't
1554 * managed to process any buffers. A zero return
1555 * value means EOF, so retry instead.
1562 ibuf
= ipipe
->bufs
+ ipipe
->curbuf
;
1563 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (opipe
->buffers
- 1);
1564 obuf
= opipe
->bufs
+ nbuf
;
1566 if (len
>= ibuf
->len
) {
1568 * Simply move the whole buffer from ipipe to opipe
1573 ipipe
->curbuf
= (ipipe
->curbuf
+ 1) & (ipipe
->buffers
- 1);
1575 input_wakeup
= true;
1578 * Get a reference to this pipe buffer,
1579 * so we can copy the contents over.
1581 pipe_buf_get(ipipe
, ibuf
);
1585 * Don't inherit the gift flag, we need to
1586 * prevent multiple steals of this page.
1588 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1592 ibuf
->offset
+= obuf
->len
;
1593 ibuf
->len
-= obuf
->len
;
1603 * If we put data in the output pipe, wakeup any potential readers.
1606 wakeup_pipe_readers(opipe
);
1609 wakeup_pipe_writers(ipipe
);
1615 * Link contents of ipipe to opipe.
1617 static int link_pipe(struct pipe_inode_info
*ipipe
,
1618 struct pipe_inode_info
*opipe
,
1619 size_t len
, unsigned int flags
)
1621 struct pipe_buffer
*ibuf
, *obuf
;
1622 int ret
= 0, i
= 0, nbuf
;
1625 * Potential ABBA deadlock, work around it by ordering lock
1626 * grabbing by pipe info address. Otherwise two different processes
1627 * could deadlock (one doing tee from A -> B, the other from B -> A).
1629 pipe_double_lock(ipipe
, opipe
);
1632 if (!opipe
->readers
) {
1633 send_sig(SIGPIPE
, current
, 0);
1640 * If we have iterated all input buffers or ran out of
1641 * output room, break.
1643 if (i
>= ipipe
->nrbufs
|| opipe
->nrbufs
>= opipe
->buffers
)
1646 ibuf
= ipipe
->bufs
+ ((ipipe
->curbuf
+ i
) & (ipipe
->buffers
-1));
1647 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (opipe
->buffers
- 1);
1650 * Get a reference to this pipe buffer,
1651 * so we can copy the contents over.
1653 pipe_buf_get(ipipe
, ibuf
);
1655 obuf
= opipe
->bufs
+ nbuf
;
1659 * Don't inherit the gift flag, we need to
1660 * prevent multiple steals of this page.
1662 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1664 if (obuf
->len
> len
)
1674 * return EAGAIN if we have the potential of some data in the
1675 * future, otherwise just return 0
1677 if (!ret
&& ipipe
->waiting_writers
&& (flags
& SPLICE_F_NONBLOCK
))
1684 * If we put data in the output pipe, wakeup any potential readers.
1687 wakeup_pipe_readers(opipe
);
1693 * This is a tee(1) implementation that works on pipes. It doesn't copy
1694 * any data, it simply references the 'in' pages on the 'out' pipe.
1695 * The 'flags' used are the SPLICE_F_* variants, currently the only
1696 * applicable one is SPLICE_F_NONBLOCK.
1698 static long do_tee(struct file
*in
, struct file
*out
, size_t len
,
1701 struct pipe_inode_info
*ipipe
= get_pipe_info(in
);
1702 struct pipe_inode_info
*opipe
= get_pipe_info(out
);
1706 * Duplicate the contents of ipipe to opipe without actually
1709 if (ipipe
&& opipe
&& ipipe
!= opipe
) {
1711 * Keep going, unless we encounter an error. The ipipe/opipe
1712 * ordering doesn't really matter.
1714 ret
= ipipe_prep(ipipe
, flags
);
1716 ret
= opipe_prep(opipe
, flags
);
1718 ret
= link_pipe(ipipe
, opipe
, len
, flags
);
1725 SYSCALL_DEFINE4(tee
, int, fdin
, int, fdout
, size_t, len
, unsigned int, flags
)
1736 if (in
.file
->f_mode
& FMODE_READ
) {
1737 struct fd out
= fdget(fdout
);
1739 if (out
.file
->f_mode
& FMODE_WRITE
)
1740 error
= do_tee(in
.file
, out
.file
,