1 // SPDX-License-Identifier: GPL-2.0-only
3 * "splice": joining two ropes together by interweaving their strands.
5 * This is the "extended pipe" functionality, where a pipe is used as
6 * an arbitrary in-memory buffer. Think of a pipe as a small kernel
7 * buffer that you can use to transfer data from one end to the other.
9 * The traditional unix read/write is extended with a "splice()" operation
10 * that transfers data buffers to or from a pipe buffer.
12 * Named by Larry McVoy, original implementation from Linus, extended by
13 * Jens to support splicing to files, network, direct splicing, etc and
14 * fixing lots of bugs.
16 * Copyright (C) 2005-2006 Jens Axboe <axboe@kernel.dk>
17 * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
18 * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
21 #include <linux/bvec.h>
23 #include <linux/file.h>
24 #include <linux/pagemap.h>
25 #include <linux/splice.h>
26 #include <linux/memcontrol.h>
27 #include <linux/mm_inline.h>
28 #include <linux/swap.h>
29 #include <linux/writeback.h>
30 #include <linux/export.h>
31 #include <linux/syscalls.h>
32 #include <linux/uio.h>
33 #include <linux/security.h>
34 #include <linux/gfp.h>
35 #include <linux/socket.h>
36 #include <linux/compat.h>
37 #include <linux/sched/signal.h>
42 * Attempt to steal a page from a pipe buffer. This should perhaps go into
43 * a vm helper function, it's already simplified quite a bit by the
44 * addition of remove_mapping(). If success is returned, the caller may
45 * attempt to reuse this page for another destination.
47 static bool page_cache_pipe_buf_try_steal(struct pipe_inode_info
*pipe
,
48 struct pipe_buffer
*buf
)
50 struct page
*page
= buf
->page
;
51 struct address_space
*mapping
;
55 mapping
= page_mapping(page
);
57 WARN_ON(!PageUptodate(page
));
60 * At least for ext2 with nobh option, we need to wait on
61 * writeback completing on this page, since we'll remove it
62 * from the pagecache. Otherwise truncate wont wait on the
63 * page, allowing the disk blocks to be reused by someone else
64 * before we actually wrote our data to them. fs corruption
67 wait_on_page_writeback(page
);
69 if (page_has_private(page
) &&
70 !try_to_release_page(page
, GFP_KERNEL
))
74 * If we succeeded in removing the mapping, set LRU flag
77 if (remove_mapping(mapping
, page
)) {
78 buf
->flags
|= PIPE_BUF_FLAG_LRU
;
84 * Raced with truncate or failed to remove page from current
85 * address space, unlock and return failure.
92 static void page_cache_pipe_buf_release(struct pipe_inode_info
*pipe
,
93 struct pipe_buffer
*buf
)
96 buf
->flags
&= ~PIPE_BUF_FLAG_LRU
;
100 * Check whether the contents of buf is OK to access. Since the content
101 * is a page cache page, IO may be in flight.
103 static int page_cache_pipe_buf_confirm(struct pipe_inode_info
*pipe
,
104 struct pipe_buffer
*buf
)
106 struct page
*page
= buf
->page
;
109 if (!PageUptodate(page
)) {
113 * Page got truncated/unhashed. This will cause a 0-byte
114 * splice, if this is the first page.
116 if (!page
->mapping
) {
122 * Uh oh, read-error from disk.
124 if (!PageUptodate(page
)) {
130 * Page is ok afterall, we are done.
141 const struct pipe_buf_operations page_cache_pipe_buf_ops
= {
142 .confirm
= page_cache_pipe_buf_confirm
,
143 .release
= page_cache_pipe_buf_release
,
144 .try_steal
= page_cache_pipe_buf_try_steal
,
145 .get
= generic_pipe_buf_get
,
148 static bool user_page_pipe_buf_try_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_try_steal(pipe
, buf
);
158 static const struct pipe_buf_operations user_page_pipe_buf_ops
= {
159 .release
= page_cache_pipe_buf_release
,
160 .try_steal
= user_page_pipe_buf_try_steal
,
161 .get
= generic_pipe_buf_get
,
164 static void wakeup_pipe_readers(struct pipe_inode_info
*pipe
)
167 if (waitqueue_active(&pipe
->rd_wait
))
168 wake_up_interruptible(&pipe
->rd_wait
);
169 kill_fasync(&pipe
->fasync_readers
, SIGIO
, POLL_IN
);
173 * splice_to_pipe - fill passed data into a pipe
174 * @pipe: pipe to fill
178 * @spd contains a map of pages and len/offset tuples, along with
179 * the struct pipe_buf_operations associated with these pages. This
180 * function will link that data to the pipe.
183 ssize_t
splice_to_pipe(struct pipe_inode_info
*pipe
,
184 struct splice_pipe_desc
*spd
)
186 unsigned int spd_pages
= spd
->nr_pages
;
187 unsigned int tail
= pipe
->tail
;
188 unsigned int head
= pipe
->head
;
189 unsigned int mask
= pipe
->ring_size
- 1;
190 int ret
= 0, page_nr
= 0;
195 if (unlikely(!pipe
->readers
)) {
196 send_sig(SIGPIPE
, current
, 0);
201 while (!pipe_full(head
, tail
, pipe
->max_usage
)) {
202 struct pipe_buffer
*buf
= &pipe
->bufs
[head
& mask
];
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;
216 if (!--spd
->nr_pages
)
224 while (page_nr
< spd_pages
)
225 spd
->spd_release(spd
, page_nr
++);
229 EXPORT_SYMBOL_GPL(splice_to_pipe
);
231 ssize_t
add_to_pipe(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
)
233 unsigned int head
= pipe
->head
;
234 unsigned int tail
= pipe
->tail
;
235 unsigned int mask
= pipe
->ring_size
- 1;
238 if (unlikely(!pipe
->readers
)) {
239 send_sig(SIGPIPE
, current
, 0);
241 } else if (pipe_full(head
, tail
, pipe
->max_usage
)) {
244 pipe
->bufs
[head
& mask
] = *buf
;
245 pipe
->head
= head
+ 1;
248 pipe_buf_release(pipe
, buf
);
251 EXPORT_SYMBOL(add_to_pipe
);
254 * Check if we need to grow the arrays holding pages and partial page
257 int splice_grow_spd(const struct pipe_inode_info
*pipe
, struct splice_pipe_desc
*spd
)
259 unsigned int max_usage
= READ_ONCE(pipe
->max_usage
);
261 spd
->nr_pages_max
= max_usage
;
262 if (max_usage
<= PIPE_DEF_BUFFERS
)
265 spd
->pages
= kmalloc_array(max_usage
, sizeof(struct page
*), GFP_KERNEL
);
266 spd
->partial
= kmalloc_array(max_usage
, sizeof(struct partial_page
),
269 if (spd
->pages
&& spd
->partial
)
277 void splice_shrink_spd(struct splice_pipe_desc
*spd
)
279 if (spd
->nr_pages_max
<= PIPE_DEF_BUFFERS
)
287 * generic_file_splice_read - splice data from file to a pipe
288 * @in: file to splice from
289 * @ppos: position in @in
290 * @pipe: pipe to splice to
291 * @len: number of bytes to splice
292 * @flags: splice modifier flags
295 * Will read pages from given file and fill them into a pipe. Can be
296 * used as long as it has more or less sane ->read_iter().
299 ssize_t
generic_file_splice_read(struct file
*in
, loff_t
*ppos
,
300 struct pipe_inode_info
*pipe
, size_t len
,
308 iov_iter_pipe(&to
, READ
, pipe
, len
);
310 init_sync_kiocb(&kiocb
, in
);
311 kiocb
.ki_pos
= *ppos
;
312 ret
= call_read_iter(in
, &kiocb
, &to
);
314 *ppos
= kiocb
.ki_pos
;
316 } else if (ret
< 0) {
319 iov_iter_advance(&to
, 0); /* to free what was emitted */
321 * callers of ->splice_read() expect -EAGAIN on
322 * "can't put anything in there", rather than -EFAULT.
330 EXPORT_SYMBOL(generic_file_splice_read
);
332 const struct pipe_buf_operations default_pipe_buf_ops
= {
333 .release
= generic_pipe_buf_release
,
334 .try_steal
= generic_pipe_buf_try_steal
,
335 .get
= generic_pipe_buf_get
,
338 /* Pipe buffer operations for a socket and similar. */
339 const struct pipe_buf_operations nosteal_pipe_buf_ops
= {
340 .release
= generic_pipe_buf_release
,
341 .get
= generic_pipe_buf_get
,
343 EXPORT_SYMBOL(nosteal_pipe_buf_ops
);
345 static ssize_t
kernel_readv(struct file
*file
, const struct kvec
*vec
,
346 unsigned long vlen
, loff_t offset
)
354 /* The cast to a user pointer is valid due to the set_fs() */
355 res
= vfs_readv(file
, (const struct iovec __user
*)vec
, vlen
, &pos
, 0);
361 static ssize_t
default_file_splice_read(struct file
*in
, loff_t
*ppos
,
362 struct pipe_inode_info
*pipe
, size_t len
,
365 struct kvec
*vec
, __vec
[PIPE_DEF_BUFFERS
];
368 unsigned int nr_pages
;
370 size_t offset
, base
, copied
= 0;
374 if (pipe_full(pipe
->head
, pipe
->tail
, pipe
->max_usage
))
378 * Try to keep page boundaries matching to source pagecache ones -
379 * it probably won't be much help, but...
381 offset
= *ppos
& ~PAGE_MASK
;
383 iov_iter_pipe(&to
, READ
, pipe
, len
+ offset
);
385 res
= iov_iter_get_pages_alloc(&to
, &pages
, len
+ offset
, &base
);
389 nr_pages
= DIV_ROUND_UP(res
+ base
, PAGE_SIZE
);
392 if (nr_pages
> PIPE_DEF_BUFFERS
) {
393 vec
= kmalloc_array(nr_pages
, sizeof(struct kvec
), GFP_KERNEL
);
394 if (unlikely(!vec
)) {
400 mask
= pipe
->ring_size
- 1;
401 pipe
->bufs
[to
.head
& mask
].offset
= offset
;
402 pipe
->bufs
[to
.head
& mask
].len
-= offset
;
404 for (i
= 0; i
< nr_pages
; i
++) {
405 size_t this_len
= min_t(size_t, len
, PAGE_SIZE
- offset
);
406 vec
[i
].iov_base
= page_address(pages
[i
]) + offset
;
407 vec
[i
].iov_len
= this_len
;
412 res
= kernel_readv(in
, vec
, nr_pages
, *ppos
);
421 for (i
= 0; i
< nr_pages
; i
++)
424 iov_iter_advance(&to
, copied
); /* truncates and discards */
429 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
430 * using sendpage(). Return the number of bytes sent.
432 static int pipe_to_sendpage(struct pipe_inode_info
*pipe
,
433 struct pipe_buffer
*buf
, struct splice_desc
*sd
)
435 struct file
*file
= sd
->u
.file
;
436 loff_t pos
= sd
->pos
;
439 if (!likely(file
->f_op
->sendpage
))
442 more
= (sd
->flags
& SPLICE_F_MORE
) ? MSG_MORE
: 0;
444 if (sd
->len
< sd
->total_len
&&
445 pipe_occupancy(pipe
->head
, pipe
->tail
) > 1)
446 more
|= MSG_SENDPAGE_NOTLAST
;
448 return file
->f_op
->sendpage(file
, buf
->page
, buf
->offset
,
449 sd
->len
, &pos
, more
);
452 static void wakeup_pipe_writers(struct pipe_inode_info
*pipe
)
455 if (waitqueue_active(&pipe
->wr_wait
))
456 wake_up_interruptible(&pipe
->wr_wait
);
457 kill_fasync(&pipe
->fasync_writers
, SIGIO
, POLL_OUT
);
461 * splice_from_pipe_feed - feed available data from a pipe to a file
462 * @pipe: pipe to splice from
463 * @sd: information to @actor
464 * @actor: handler that splices the data
467 * This function loops over the pipe and calls @actor to do the
468 * actual moving of a single struct pipe_buffer to the desired
469 * destination. It returns when there's no more buffers left in
470 * the pipe or if the requested number of bytes (@sd->total_len)
471 * have been copied. It returns a positive number (one) if the
472 * pipe needs to be filled with more data, zero if the required
473 * number of bytes have been copied and -errno on error.
475 * This, together with splice_from_pipe_{begin,end,next}, may be
476 * used to implement the functionality of __splice_from_pipe() when
477 * locking is required around copying the pipe buffers to the
480 static int splice_from_pipe_feed(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
483 unsigned int head
= pipe
->head
;
484 unsigned int tail
= pipe
->tail
;
485 unsigned int mask
= pipe
->ring_size
- 1;
488 while (!pipe_empty(head
, tail
)) {
489 struct pipe_buffer
*buf
= &pipe
->bufs
[tail
& mask
];
492 if (sd
->len
> sd
->total_len
)
493 sd
->len
= sd
->total_len
;
495 ret
= pipe_buf_confirm(pipe
, buf
);
502 ret
= actor(pipe
, buf
, sd
);
509 sd
->num_spliced
+= ret
;
512 sd
->total_len
-= ret
;
515 pipe_buf_release(pipe
, buf
);
519 sd
->need_wakeup
= true;
529 /* We know we have a pipe buffer, but maybe it's empty? */
530 static inline bool eat_empty_buffer(struct pipe_inode_info
*pipe
)
532 unsigned int tail
= pipe
->tail
;
533 unsigned int mask
= pipe
->ring_size
- 1;
534 struct pipe_buffer
*buf
= &pipe
->bufs
[tail
& mask
];
536 if (unlikely(!buf
->len
)) {
537 pipe_buf_release(pipe
, buf
);
546 * splice_from_pipe_next - wait for some data to splice from
547 * @pipe: pipe to splice from
548 * @sd: information about the splice operation
551 * This function will wait for some data and return a positive
552 * value (one) if pipe buffers are available. It will return zero
553 * or -errno if no more data needs to be spliced.
555 static int splice_from_pipe_next(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
558 * Check for signal early to make process killable when there are
559 * always buffers available
561 if (signal_pending(current
))
565 while (pipe_empty(pipe
->head
, pipe
->tail
)) {
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;
583 pipe_wait_readable(pipe
);
586 if (eat_empty_buffer(pipe
))
593 * splice_from_pipe_begin - start splicing from pipe
594 * @sd: information about the splice operation
597 * This function should be called before a loop containing
598 * splice_from_pipe_next() and splice_from_pipe_feed() to
599 * initialize the necessary fields of @sd.
601 static void splice_from_pipe_begin(struct splice_desc
*sd
)
604 sd
->need_wakeup
= false;
608 * splice_from_pipe_end - finish splicing from pipe
609 * @pipe: pipe to splice from
610 * @sd: information about the splice operation
613 * This function will wake up pipe writers if necessary. It should
614 * be called after a loop containing splice_from_pipe_next() and
615 * splice_from_pipe_feed().
617 static void splice_from_pipe_end(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
620 wakeup_pipe_writers(pipe
);
624 * __splice_from_pipe - splice data from a pipe to given actor
625 * @pipe: pipe to splice from
626 * @sd: information to @actor
627 * @actor: handler that splices the data
630 * This function does little more than loop over the pipe and call
631 * @actor to do the actual moving of a single struct pipe_buffer to
632 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
636 ssize_t
__splice_from_pipe(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
641 splice_from_pipe_begin(sd
);
644 ret
= splice_from_pipe_next(pipe
, sd
);
646 ret
= splice_from_pipe_feed(pipe
, sd
, actor
);
648 splice_from_pipe_end(pipe
, sd
);
650 return sd
->num_spliced
? sd
->num_spliced
: ret
;
652 EXPORT_SYMBOL(__splice_from_pipe
);
655 * splice_from_pipe - splice data from a pipe to a file
656 * @pipe: pipe to splice from
657 * @out: file to splice to
658 * @ppos: position in @out
659 * @len: how many bytes to splice
660 * @flags: splice modifier flags
661 * @actor: handler that splices the data
664 * See __splice_from_pipe. This function locks the pipe inode,
665 * otherwise it's identical to __splice_from_pipe().
668 ssize_t
splice_from_pipe(struct pipe_inode_info
*pipe
, struct file
*out
,
669 loff_t
*ppos
, size_t len
, unsigned int flags
,
673 struct splice_desc sd
= {
681 ret
= __splice_from_pipe(pipe
, &sd
, actor
);
688 * iter_file_splice_write - splice data from a pipe to a file
690 * @out: file to write to
691 * @ppos: position in @out
692 * @len: number of bytes to splice
693 * @flags: splice modifier flags
696 * Will either move or copy pages (determined by @flags options) from
697 * the given pipe inode to the given file.
698 * This one is ->write_iter-based.
702 iter_file_splice_write(struct pipe_inode_info
*pipe
, struct file
*out
,
703 loff_t
*ppos
, size_t len
, unsigned int flags
)
705 struct splice_desc sd
= {
711 int nbufs
= pipe
->max_usage
;
712 struct bio_vec
*array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
716 if (unlikely(!array
))
721 splice_from_pipe_begin(&sd
);
722 while (sd
.total_len
) {
723 struct iov_iter from
;
724 unsigned int head
, tail
, mask
;
728 ret
= splice_from_pipe_next(pipe
, &sd
);
732 if (unlikely(nbufs
< pipe
->max_usage
)) {
734 nbufs
= pipe
->max_usage
;
735 array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
745 mask
= pipe
->ring_size
- 1;
747 /* build the vector */
749 for (n
= 0; !pipe_empty(head
, tail
) && left
&& n
< nbufs
; tail
++, n
++) {
750 struct pipe_buffer
*buf
= &pipe
->bufs
[tail
& mask
];
751 size_t this_len
= buf
->len
;
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
, WRITE
, array
, n
, sd
.total_len
- left
);
770 ret
= vfs_iter_write(out
, &from
, &sd
.pos
, 0);
774 sd
.num_spliced
+= ret
;
778 /* dismiss the fully eaten buffers, adjust the partial one */
781 struct pipe_buffer
*buf
= &pipe
->bufs
[tail
& mask
];
782 if (ret
>= buf
->len
) {
785 pipe_buf_release(pipe
, buf
);
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 if (out
->f_op
->splice_write
)
866 return out
->f_op
->splice_write(pipe
, out
, ppos
, len
, flags
);
867 return default_file_splice_write(pipe
, out
, ppos
, len
, flags
);
871 * Attempt to initiate a splice from a file to a pipe.
873 static long do_splice_to(struct file
*in
, loff_t
*ppos
,
874 struct pipe_inode_info
*pipe
, size_t len
,
879 if (unlikely(!(in
->f_mode
& FMODE_READ
)))
882 ret
= rw_verify_area(READ
, in
, ppos
, len
);
883 if (unlikely(ret
< 0))
886 if (unlikely(len
> MAX_RW_COUNT
))
889 if (in
->f_op
->splice_read
)
890 return in
->f_op
->splice_read(in
, ppos
, pipe
, len
, flags
);
891 return default_file_splice_read(in
, ppos
, pipe
, len
, flags
);
895 * splice_direct_to_actor - splices data directly between two non-pipes
896 * @in: file to splice from
897 * @sd: actor information on where to splice to
898 * @actor: handles the data splicing
901 * This is a special case helper to splice directly between two
902 * points, without requiring an explicit pipe. Internally an allocated
903 * pipe is cached in the process, and reused during the lifetime of
907 ssize_t
splice_direct_to_actor(struct file
*in
, struct splice_desc
*sd
,
908 splice_direct_actor
*actor
)
910 struct pipe_inode_info
*pipe
;
917 * We require the input being a regular file, as we don't want to
918 * randomly drop data for eg socket -> socket splicing. Use the
919 * piped splicing for that!
921 i_mode
= file_inode(in
)->i_mode
;
922 if (unlikely(!S_ISREG(i_mode
) && !S_ISBLK(i_mode
)))
926 * neither in nor out is a pipe, setup an internal pipe attached to
927 * 'out' and transfer the wanted data from 'in' to 'out' through that
929 pipe
= current
->splice_pipe
;
930 if (unlikely(!pipe
)) {
931 pipe
= alloc_pipe_info();
936 * We don't have an immediate reader, but we'll read the stuff
937 * out of the pipe right after the splice_to_pipe(). So set
938 * PIPE_READERS appropriately.
942 current
->splice_pipe
= pipe
;
954 * Don't block on output, we have to drain the direct pipe.
956 sd
->flags
&= ~SPLICE_F_NONBLOCK
;
957 more
= sd
->flags
& SPLICE_F_MORE
;
959 WARN_ON_ONCE(!pipe_empty(pipe
->head
, pipe
->tail
));
962 unsigned int p_space
;
964 loff_t pos
= sd
->pos
, prev_pos
= pos
;
966 /* Don't try to read more the pipe has space for. */
967 p_space
= pipe
->max_usage
-
968 pipe_occupancy(pipe
->head
, pipe
->tail
);
969 read_len
= min_t(size_t, len
, p_space
<< PAGE_SHIFT
);
970 ret
= do_splice_to(in
, &pos
, pipe
, read_len
, flags
);
971 if (unlikely(ret
<= 0))
975 sd
->total_len
= read_len
;
978 * If more data is pending, set SPLICE_F_MORE
979 * If this is the last data and SPLICE_F_MORE was not set
980 * initially, clears it.
983 sd
->flags
|= SPLICE_F_MORE
;
985 sd
->flags
&= ~SPLICE_F_MORE
;
987 * NOTE: nonblocking mode only applies to the input. We
988 * must not do the output in nonblocking mode as then we
989 * could get stuck data in the internal pipe:
991 ret
= actor(pipe
, sd
);
992 if (unlikely(ret
<= 0)) {
1001 if (ret
< read_len
) {
1002 sd
->pos
= prev_pos
+ ret
;
1008 pipe
->tail
= pipe
->head
= 0;
1014 * If we did an incomplete transfer we must release
1015 * the pipe buffers in question:
1017 for (i
= 0; i
< pipe
->ring_size
; i
++) {
1018 struct pipe_buffer
*buf
= &pipe
->bufs
[i
];
1021 pipe_buf_release(pipe
, buf
);
1029 EXPORT_SYMBOL(splice_direct_to_actor
);
1031 static int direct_splice_actor(struct pipe_inode_info
*pipe
,
1032 struct splice_desc
*sd
)
1034 struct file
*file
= sd
->u
.file
;
1036 return do_splice_from(pipe
, file
, sd
->opos
, sd
->total_len
,
1041 * do_splice_direct - splices data directly between two files
1042 * @in: file to splice from
1043 * @ppos: input file offset
1044 * @out: file to splice to
1045 * @opos: output file offset
1046 * @len: number of bytes to splice
1047 * @flags: splice modifier flags
1050 * For use by do_sendfile(). splice can easily emulate sendfile, but
1051 * doing it in the application would incur an extra system call
1052 * (splice in + splice out, as compared to just sendfile()). So this helper
1053 * can splice directly through a process-private pipe.
1056 long do_splice_direct(struct file
*in
, loff_t
*ppos
, struct file
*out
,
1057 loff_t
*opos
, size_t len
, unsigned int flags
)
1059 struct splice_desc sd
= {
1069 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1072 if (unlikely(out
->f_flags
& O_APPEND
))
1075 ret
= rw_verify_area(WRITE
, out
, opos
, len
);
1076 if (unlikely(ret
< 0))
1079 ret
= splice_direct_to_actor(in
, &sd
, direct_splice_actor
);
1085 EXPORT_SYMBOL(do_splice_direct
);
1087 static int wait_for_space(struct pipe_inode_info
*pipe
, unsigned flags
)
1090 if (unlikely(!pipe
->readers
)) {
1091 send_sig(SIGPIPE
, current
, 0);
1094 if (!pipe_full(pipe
->head
, pipe
->tail
, pipe
->max_usage
))
1096 if (flags
& SPLICE_F_NONBLOCK
)
1098 if (signal_pending(current
))
1099 return -ERESTARTSYS
;
1100 pipe_wait_writable(pipe
);
1104 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1105 struct pipe_inode_info
*opipe
,
1106 size_t len
, unsigned int flags
);
1109 * Determine where to splice to/from.
1111 long do_splice(struct file
*in
, loff_t __user
*off_in
,
1112 struct file
*out
, loff_t __user
*off_out
,
1113 size_t len
, unsigned int flags
)
1115 struct pipe_inode_info
*ipipe
;
1116 struct pipe_inode_info
*opipe
;
1120 if (unlikely(!(in
->f_mode
& FMODE_READ
) ||
1121 !(out
->f_mode
& FMODE_WRITE
)))
1124 ipipe
= get_pipe_info(in
, true);
1125 opipe
= get_pipe_info(out
, true);
1127 if (ipipe
&& opipe
) {
1128 if (off_in
|| off_out
)
1131 /* Splicing to self would be fun, but... */
1135 if ((in
->f_flags
| out
->f_flags
) & O_NONBLOCK
)
1136 flags
|= SPLICE_F_NONBLOCK
;
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_flags
& O_APPEND
))
1156 ret
= rw_verify_area(WRITE
, out
, &offset
, len
);
1157 if (unlikely(ret
< 0))
1160 if (in
->f_flags
& O_NONBLOCK
)
1161 flags
|= SPLICE_F_NONBLOCK
;
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
)))
1187 if (out
->f_flags
& O_NONBLOCK
)
1188 flags
|= SPLICE_F_NONBLOCK
;
1191 ret
= wait_for_space(opipe
, flags
);
1193 unsigned int p_space
;
1195 /* Don't try to read more the pipe has space for. */
1196 p_space
= opipe
->max_usage
- pipe_occupancy(opipe
->head
, opipe
->tail
);
1197 len
= min_t(size_t, len
, p_space
<< PAGE_SHIFT
);
1199 ret
= do_splice_to(in
, &offset
, opipe
, len
, flags
);
1203 wakeup_pipe_readers(opipe
);
1206 else if (copy_to_user(off_in
, &offset
, sizeof(loff_t
)))
1215 static int iter_to_pipe(struct iov_iter
*from
,
1216 struct pipe_inode_info
*pipe
,
1219 struct pipe_buffer buf
= {
1220 .ops
= &user_page_pipe_buf_ops
,
1225 bool failed
= false;
1227 while (iov_iter_count(from
) && !failed
) {
1228 struct page
*pages
[16];
1233 copied
= iov_iter_get_pages(from
, pages
, ~0UL, 16, &start
);
1239 for (n
= 0; copied
; n
++, start
= 0) {
1240 int size
= min_t(int, copied
, PAGE_SIZE
- start
);
1242 buf
.page
= pages
[n
];
1245 ret
= add_to_pipe(pipe
, &buf
);
1246 if (unlikely(ret
< 0)) {
1249 iov_iter_advance(from
, ret
);
1258 return total
? total
: ret
;
1261 static int pipe_to_user(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
1262 struct splice_desc
*sd
)
1264 int n
= copy_page_to_iter(buf
->page
, buf
->offset
, sd
->len
, sd
->u
.data
);
1265 return n
== sd
->len
? n
: -EFAULT
;
1269 * For lack of a better implementation, implement vmsplice() to userspace
1270 * as a simple copy of the pipes pages to the user iov.
1272 static long vmsplice_to_user(struct file
*file
, struct iov_iter
*iter
,
1275 struct pipe_inode_info
*pipe
= get_pipe_info(file
, true);
1276 struct splice_desc sd
= {
1277 .total_len
= iov_iter_count(iter
),
1288 ret
= __splice_from_pipe(pipe
, &sd
, pipe_to_user
);
1296 * vmsplice splices a user address range into a pipe. It can be thought of
1297 * as splice-from-memory, where the regular splice is splice-from-file (or
1298 * to file). In both cases the output is a pipe, naturally.
1300 static long vmsplice_to_pipe(struct file
*file
, struct iov_iter
*iter
,
1303 struct pipe_inode_info
*pipe
;
1305 unsigned buf_flag
= 0;
1307 if (flags
& SPLICE_F_GIFT
)
1308 buf_flag
= PIPE_BUF_FLAG_GIFT
;
1310 pipe
= get_pipe_info(file
, true);
1315 ret
= wait_for_space(pipe
, flags
);
1317 ret
= iter_to_pipe(iter
, pipe
, buf_flag
);
1320 wakeup_pipe_readers(pipe
);
1324 static int vmsplice_type(struct fd f
, int *type
)
1328 if (f
.file
->f_mode
& FMODE_WRITE
) {
1330 } else if (f
.file
->f_mode
& FMODE_READ
) {
1340 * Note that vmsplice only really supports true splicing _from_ user memory
1341 * to a pipe, not the other way around. Splicing from user memory is a simple
1342 * operation that can be supported without any funky alignment restrictions
1343 * or nasty vm tricks. We simply map in the user memory and fill them into
1344 * a pipe. The reverse isn't quite as easy, though. There are two possible
1345 * solutions for that:
1347 * - memcpy() the data internally, at which point we might as well just
1348 * do a regular read() on the buffer anyway.
1349 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1350 * has restriction limitations on both ends of the pipe).
1352 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1355 static long do_vmsplice(struct file
*f
, struct iov_iter
*iter
, unsigned int flags
)
1357 if (unlikely(flags
& ~SPLICE_F_ALL
))
1360 if (!iov_iter_count(iter
))
1363 if (iov_iter_rw(iter
) == WRITE
)
1364 return vmsplice_to_pipe(f
, iter
, flags
);
1366 return vmsplice_to_user(f
, iter
, flags
);
1369 SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct iovec __user
*, uiov
,
1370 unsigned long, nr_segs
, unsigned int, flags
)
1372 struct iovec iovstack
[UIO_FASTIOV
];
1373 struct iovec
*iov
= iovstack
;
1374 struct iov_iter iter
;
1380 error
= vmsplice_type(f
, &type
);
1384 error
= import_iovec(type
, uiov
, nr_segs
,
1385 ARRAY_SIZE(iovstack
), &iov
, &iter
);
1387 error
= do_vmsplice(f
.file
, &iter
, flags
);
1394 #ifdef CONFIG_COMPAT
1395 COMPAT_SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct compat_iovec __user
*, iov32
,
1396 unsigned int, nr_segs
, unsigned int, flags
)
1398 struct iovec iovstack
[UIO_FASTIOV
];
1399 struct iovec
*iov
= iovstack
;
1400 struct iov_iter iter
;
1406 error
= vmsplice_type(f
, &type
);
1410 error
= compat_import_iovec(type
, iov32
, nr_segs
,
1411 ARRAY_SIZE(iovstack
), &iov
, &iter
);
1413 error
= do_vmsplice(f
.file
, &iter
, flags
);
1421 SYSCALL_DEFINE6(splice
, int, fd_in
, loff_t __user
*, off_in
,
1422 int, fd_out
, loff_t __user
*, off_out
,
1423 size_t, len
, unsigned int, flags
)
1431 if (unlikely(flags
& ~SPLICE_F_ALL
))
1437 out
= fdget(fd_out
);
1439 error
= do_splice(in
.file
, off_in
, out
.file
, off_out
,
1449 * Make sure there's data to read. Wait for input if we can, otherwise
1450 * return an appropriate error.
1452 static int ipipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1457 * Check the pipe occupancy without the inode lock first. This function
1458 * is speculative anyways, so missing one is ok.
1460 if (!pipe_empty(pipe
->head
, pipe
->tail
))
1466 while (pipe_empty(pipe
->head
, pipe
->tail
)) {
1467 if (signal_pending(current
)) {
1473 if (flags
& SPLICE_F_NONBLOCK
) {
1477 pipe_wait_readable(pipe
);
1485 * Make sure there's writeable room. Wait for room if we can, otherwise
1486 * return an appropriate error.
1488 static int opipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1493 * Check pipe occupancy without the inode lock first. This function
1494 * is speculative anyways, so missing one is ok.
1496 if (!pipe_full(pipe
->head
, pipe
->tail
, pipe
->max_usage
))
1502 while (pipe_full(pipe
->head
, pipe
->tail
, pipe
->max_usage
)) {
1503 if (!pipe
->readers
) {
1504 send_sig(SIGPIPE
, current
, 0);
1508 if (flags
& SPLICE_F_NONBLOCK
) {
1512 if (signal_pending(current
)) {
1516 pipe_wait_writable(pipe
);
1524 * Splice contents of ipipe to opipe.
1526 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1527 struct pipe_inode_info
*opipe
,
1528 size_t len
, unsigned int flags
)
1530 struct pipe_buffer
*ibuf
, *obuf
;
1531 unsigned int i_head
, o_head
;
1532 unsigned int i_tail
, o_tail
;
1533 unsigned int i_mask
, o_mask
;
1535 bool input_wakeup
= false;
1539 ret
= ipipe_prep(ipipe
, flags
);
1543 ret
= opipe_prep(opipe
, flags
);
1548 * Potential ABBA deadlock, work around it by ordering lock
1549 * grabbing by pipe info address. Otherwise two different processes
1550 * could deadlock (one doing tee from A -> B, the other from B -> A).
1552 pipe_double_lock(ipipe
, opipe
);
1554 i_tail
= ipipe
->tail
;
1555 i_mask
= ipipe
->ring_size
- 1;
1556 o_head
= opipe
->head
;
1557 o_mask
= opipe
->ring_size
- 1;
1562 if (!opipe
->readers
) {
1563 send_sig(SIGPIPE
, current
, 0);
1569 i_head
= ipipe
->head
;
1570 o_tail
= opipe
->tail
;
1572 if (pipe_empty(i_head
, i_tail
) && !ipipe
->writers
)
1576 * Cannot make any progress, because either the input
1577 * pipe is empty or the output pipe is full.
1579 if (pipe_empty(i_head
, i_tail
) ||
1580 pipe_full(o_head
, o_tail
, opipe
->max_usage
)) {
1581 /* Already processed some buffers, break */
1585 if (flags
& SPLICE_F_NONBLOCK
) {
1591 * We raced with another reader/writer and haven't
1592 * managed to process any buffers. A zero return
1593 * value means EOF, so retry instead.
1600 ibuf
= &ipipe
->bufs
[i_tail
& i_mask
];
1601 obuf
= &opipe
->bufs
[o_head
& o_mask
];
1603 if (len
>= ibuf
->len
) {
1605 * Simply move the whole buffer from ipipe to opipe
1610 ipipe
->tail
= i_tail
;
1611 input_wakeup
= true;
1614 opipe
->head
= o_head
;
1617 * Get a reference to this pipe buffer,
1618 * so we can copy the contents over.
1620 if (!pipe_buf_get(ipipe
, ibuf
)) {
1628 * Don't inherit the gift and merge flags, we need to
1629 * prevent multiple steals of this page.
1631 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1632 obuf
->flags
&= ~PIPE_BUF_FLAG_CAN_MERGE
;
1635 ibuf
->offset
+= len
;
1639 opipe
->head
= o_head
;
1649 * If we put data in the output pipe, wakeup any potential readers.
1652 wakeup_pipe_readers(opipe
);
1655 wakeup_pipe_writers(ipipe
);
1661 * Link contents of ipipe to opipe.
1663 static int link_pipe(struct pipe_inode_info
*ipipe
,
1664 struct pipe_inode_info
*opipe
,
1665 size_t len
, unsigned int flags
)
1667 struct pipe_buffer
*ibuf
, *obuf
;
1668 unsigned int i_head
, o_head
;
1669 unsigned int i_tail
, o_tail
;
1670 unsigned int i_mask
, o_mask
;
1674 * Potential ABBA deadlock, work around it by ordering lock
1675 * grabbing by pipe info address. Otherwise two different processes
1676 * could deadlock (one doing tee from A -> B, the other from B -> A).
1678 pipe_double_lock(ipipe
, opipe
);
1680 i_tail
= ipipe
->tail
;
1681 i_mask
= ipipe
->ring_size
- 1;
1682 o_head
= opipe
->head
;
1683 o_mask
= opipe
->ring_size
- 1;
1686 if (!opipe
->readers
) {
1687 send_sig(SIGPIPE
, current
, 0);
1693 i_head
= ipipe
->head
;
1694 o_tail
= opipe
->tail
;
1697 * If we have iterated all input buffers or run out of
1698 * output room, break.
1700 if (pipe_empty(i_head
, i_tail
) ||
1701 pipe_full(o_head
, o_tail
, opipe
->max_usage
))
1704 ibuf
= &ipipe
->bufs
[i_tail
& i_mask
];
1705 obuf
= &opipe
->bufs
[o_head
& o_mask
];
1708 * Get a reference to this pipe buffer,
1709 * so we can copy the contents over.
1711 if (!pipe_buf_get(ipipe
, ibuf
)) {
1720 * Don't inherit the gift and merge flag, we need to prevent
1721 * multiple steals of this page.
1723 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1724 obuf
->flags
&= ~PIPE_BUF_FLAG_CAN_MERGE
;
1726 if (obuf
->len
> len
)
1732 opipe
->head
= o_head
;
1740 * If we put data in the output pipe, wakeup any potential readers.
1743 wakeup_pipe_readers(opipe
);
1749 * This is a tee(1) implementation that works on pipes. It doesn't copy
1750 * any data, it simply references the 'in' pages on the 'out' pipe.
1751 * The 'flags' used are the SPLICE_F_* variants, currently the only
1752 * applicable one is SPLICE_F_NONBLOCK.
1754 long do_tee(struct file
*in
, struct file
*out
, size_t len
, unsigned int flags
)
1756 struct pipe_inode_info
*ipipe
= get_pipe_info(in
, true);
1757 struct pipe_inode_info
*opipe
= get_pipe_info(out
, true);
1760 if (unlikely(!(in
->f_mode
& FMODE_READ
) ||
1761 !(out
->f_mode
& FMODE_WRITE
)))
1765 * Duplicate the contents of ipipe to opipe without actually
1768 if (ipipe
&& opipe
&& ipipe
!= opipe
) {
1769 if ((in
->f_flags
| out
->f_flags
) & O_NONBLOCK
)
1770 flags
|= SPLICE_F_NONBLOCK
;
1773 * Keep going, unless we encounter an error. The ipipe/opipe
1774 * ordering doesn't really matter.
1776 ret
= ipipe_prep(ipipe
, flags
);
1778 ret
= opipe_prep(opipe
, flags
);
1780 ret
= link_pipe(ipipe
, opipe
, len
, flags
);
1787 SYSCALL_DEFINE4(tee
, int, fdin
, int, fdout
, size_t, len
, unsigned int, flags
)
1792 if (unlikely(flags
& ~SPLICE_F_ALL
))
1803 error
= do_tee(in
.file
, out
.file
, len
, flags
);