2 * "splice": joining two ropes together by interweaving their strands.
4 * This is the "extended pipe" functionality, where a pipe is used as
5 * an arbitrary in-memory buffer. Think of a pipe as a small kernel
6 * buffer that you can use to transfer data from one end to the other.
8 * The traditional unix read/write is extended with a "splice()" operation
9 * that transfers data buffers to or from a pipe buffer.
11 * Named by Larry McVoy, original implementation from Linus, extended by
12 * Jens to support splicing to files, network, direct splicing, etc and
13 * fixing lots of bugs.
15 * Copyright (C) 2005-2006 Jens Axboe <axboe@kernel.dk>
16 * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
17 * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
20 #include <linux/bvec.h>
22 #include <linux/file.h>
23 #include <linux/pagemap.h>
24 #include <linux/splice.h>
25 #include <linux/memcontrol.h>
26 #include <linux/mm_inline.h>
27 #include <linux/swap.h>
28 #include <linux/writeback.h>
29 #include <linux/export.h>
30 #include <linux/syscalls.h>
31 #include <linux/uio.h>
32 #include <linux/security.h>
33 #include <linux/gfp.h>
34 #include <linux/socket.h>
35 #include <linux/compat.h>
36 #include <linux/sched/signal.h>
41 * Attempt to steal a page from a pipe buffer. This should perhaps go into
42 * a vm helper function, it's already simplified quite a bit by the
43 * addition of remove_mapping(). If success is returned, the caller may
44 * attempt to reuse this page for another destination.
46 static int page_cache_pipe_buf_steal(struct pipe_inode_info
*pipe
,
47 struct pipe_buffer
*buf
)
49 struct page
*page
= buf
->page
;
50 struct address_space
*mapping
;
54 mapping
= page_mapping(page
);
56 WARN_ON(!PageUptodate(page
));
59 * At least for ext2 with nobh option, we need to wait on
60 * writeback completing on this page, since we'll remove it
61 * from the pagecache. Otherwise truncate wont wait on the
62 * page, allowing the disk blocks to be reused by someone else
63 * before we actually wrote our data to them. fs corruption
66 wait_on_page_writeback(page
);
68 if (page_has_private(page
) &&
69 !try_to_release_page(page
, GFP_KERNEL
))
73 * If we succeeded in removing the mapping, set LRU flag
76 if (remove_mapping(mapping
, page
)) {
77 buf
->flags
|= PIPE_BUF_FLAG_LRU
;
83 * Raced with truncate or failed to remove page from current
84 * address space, unlock and return failure.
91 static void page_cache_pipe_buf_release(struct pipe_inode_info
*pipe
,
92 struct pipe_buffer
*buf
)
95 buf
->flags
&= ~PIPE_BUF_FLAG_LRU
;
99 * Check whether the contents of buf is OK to access. Since the content
100 * is a page cache page, IO may be in flight.
102 static int page_cache_pipe_buf_confirm(struct pipe_inode_info
*pipe
,
103 struct pipe_buffer
*buf
)
105 struct page
*page
= buf
->page
;
108 if (!PageUptodate(page
)) {
112 * Page got truncated/unhashed. This will cause a 0-byte
113 * splice, if this is the first page.
115 if (!page
->mapping
) {
121 * Uh oh, read-error from disk.
123 if (!PageUptodate(page
)) {
129 * Page is ok afterall, we are done.
140 const struct pipe_buf_operations page_cache_pipe_buf_ops
= {
141 .confirm
= page_cache_pipe_buf_confirm
,
142 .release
= page_cache_pipe_buf_release
,
143 .steal
= page_cache_pipe_buf_steal
,
144 .get
= generic_pipe_buf_get
,
147 static int user_page_pipe_buf_steal(struct pipe_inode_info
*pipe
,
148 struct pipe_buffer
*buf
)
150 if (!(buf
->flags
& PIPE_BUF_FLAG_GIFT
))
153 buf
->flags
|= PIPE_BUF_FLAG_LRU
;
154 return generic_pipe_buf_steal(pipe
, buf
);
157 static const struct pipe_buf_operations user_page_pipe_buf_ops
= {
158 .confirm
= generic_pipe_buf_confirm
,
159 .release
= page_cache_pipe_buf_release
,
160 .steal
= user_page_pipe_buf_steal
,
161 .get
= generic_pipe_buf_get
,
164 static void wakeup_pipe_readers(struct pipe_inode_info
*pipe
)
167 if (waitqueue_active(&pipe
->wait
))
168 wake_up_interruptible(&pipe
->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 int ret
= 0, page_nr
= 0;
192 if (unlikely(!pipe
->readers
)) {
193 send_sig(SIGPIPE
, current
, 0);
198 while (pipe
->nrbufs
< pipe
->buffers
) {
199 int newbuf
= (pipe
->curbuf
+ pipe
->nrbufs
) & (pipe
->buffers
- 1);
200 struct pipe_buffer
*buf
= pipe
->bufs
+ newbuf
;
202 buf
->page
= spd
->pages
[page_nr
];
203 buf
->offset
= spd
->partial
[page_nr
].offset
;
204 buf
->len
= spd
->partial
[page_nr
].len
;
205 buf
->private = spd
->partial
[page_nr
].private;
213 if (!--spd
->nr_pages
)
221 while (page_nr
< spd_pages
)
222 spd
->spd_release(spd
, page_nr
++);
226 EXPORT_SYMBOL_GPL(splice_to_pipe
);
228 ssize_t
add_to_pipe(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
)
232 if (unlikely(!pipe
->readers
)) {
233 send_sig(SIGPIPE
, current
, 0);
235 } else if (pipe
->nrbufs
== pipe
->buffers
) {
238 int newbuf
= (pipe
->curbuf
+ pipe
->nrbufs
) & (pipe
->buffers
- 1);
239 pipe
->bufs
[newbuf
] = *buf
;
243 pipe_buf_release(pipe
, buf
);
246 EXPORT_SYMBOL(add_to_pipe
);
249 * Check if we need to grow the arrays holding pages and partial page
252 int splice_grow_spd(const struct pipe_inode_info
*pipe
, struct splice_pipe_desc
*spd
)
254 unsigned int buffers
= READ_ONCE(pipe
->buffers
);
256 spd
->nr_pages_max
= buffers
;
257 if (buffers
<= PIPE_DEF_BUFFERS
)
260 spd
->pages
= kmalloc_array(buffers
, sizeof(struct page
*), GFP_KERNEL
);
261 spd
->partial
= kmalloc_array(buffers
, sizeof(struct partial_page
),
264 if (spd
->pages
&& spd
->partial
)
272 void splice_shrink_spd(struct splice_pipe_desc
*spd
)
274 if (spd
->nr_pages_max
<= PIPE_DEF_BUFFERS
)
282 * generic_file_splice_read - splice data from file to a pipe
283 * @in: file to splice from
284 * @ppos: position in @in
285 * @pipe: pipe to splice to
286 * @len: number of bytes to splice
287 * @flags: splice modifier flags
290 * Will read pages from given file and fill them into a pipe. Can be
291 * used as long as it has more or less sane ->read_iter().
294 ssize_t
generic_file_splice_read(struct file
*in
, loff_t
*ppos
,
295 struct pipe_inode_info
*pipe
, size_t len
,
302 iov_iter_pipe(&to
, READ
, pipe
, len
);
304 init_sync_kiocb(&kiocb
, in
);
305 kiocb
.ki_pos
= *ppos
;
306 ret
= call_read_iter(in
, &kiocb
, &to
);
308 *ppos
= kiocb
.ki_pos
;
310 } else if (ret
< 0) {
313 iov_iter_advance(&to
, 0); /* to free what was emitted */
315 * callers of ->splice_read() expect -EAGAIN on
316 * "can't put anything in there", rather than -EFAULT.
324 EXPORT_SYMBOL(generic_file_splice_read
);
326 const struct pipe_buf_operations default_pipe_buf_ops
= {
327 .confirm
= generic_pipe_buf_confirm
,
328 .release
= generic_pipe_buf_release
,
329 .steal
= generic_pipe_buf_steal
,
330 .get
= generic_pipe_buf_get
,
333 int generic_pipe_buf_nosteal(struct pipe_inode_info
*pipe
,
334 struct pipe_buffer
*buf
)
339 /* Pipe buffer operations for a socket and similar. */
340 const struct pipe_buf_operations nosteal_pipe_buf_ops
= {
341 .confirm
= generic_pipe_buf_confirm
,
342 .release
= generic_pipe_buf_release
,
343 .steal
= generic_pipe_buf_nosteal
,
344 .get
= generic_pipe_buf_get
,
346 EXPORT_SYMBOL(nosteal_pipe_buf_ops
);
348 static ssize_t
kernel_readv(struct file
*file
, const struct kvec
*vec
,
349 unsigned long vlen
, loff_t offset
)
357 /* The cast to a user pointer is valid due to the set_fs() */
358 res
= vfs_readv(file
, (const struct iovec __user
*)vec
, vlen
, &pos
, 0);
364 static ssize_t
default_file_splice_read(struct file
*in
, loff_t
*ppos
,
365 struct pipe_inode_info
*pipe
, size_t len
,
368 struct kvec
*vec
, __vec
[PIPE_DEF_BUFFERS
];
371 unsigned int nr_pages
;
372 size_t offset
, base
, copied
= 0;
376 if (pipe
->nrbufs
== pipe
->buffers
)
380 * Try to keep page boundaries matching to source pagecache ones -
381 * it probably won't be much help, but...
383 offset
= *ppos
& ~PAGE_MASK
;
385 iov_iter_pipe(&to
, READ
, pipe
, len
+ offset
);
387 res
= iov_iter_get_pages_alloc(&to
, &pages
, len
+ offset
, &base
);
391 nr_pages
= DIV_ROUND_UP(res
+ base
, PAGE_SIZE
);
394 if (nr_pages
> PIPE_DEF_BUFFERS
) {
395 vec
= kmalloc_array(nr_pages
, sizeof(struct kvec
), GFP_KERNEL
);
396 if (unlikely(!vec
)) {
402 pipe
->bufs
[to
.idx
].offset
= offset
;
403 pipe
->bufs
[to
.idx
].len
-= offset
;
405 for (i
= 0; i
< nr_pages
; i
++) {
406 size_t this_len
= min_t(size_t, len
, PAGE_SIZE
- offset
);
407 vec
[i
].iov_base
= page_address(pages
[i
]) + offset
;
408 vec
[i
].iov_len
= this_len
;
413 res
= kernel_readv(in
, vec
, nr_pages
, *ppos
);
422 for (i
= 0; i
< nr_pages
; i
++)
425 iov_iter_advance(&to
, copied
); /* truncates and discards */
430 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
431 * using sendpage(). Return the number of bytes sent.
433 static int pipe_to_sendpage(struct pipe_inode_info
*pipe
,
434 struct pipe_buffer
*buf
, struct splice_desc
*sd
)
436 struct file
*file
= sd
->u
.file
;
437 loff_t pos
= sd
->pos
;
440 if (!likely(file
->f_op
->sendpage
))
443 more
= (sd
->flags
& SPLICE_F_MORE
) ? MSG_MORE
: 0;
445 if (sd
->len
< sd
->total_len
&& pipe
->nrbufs
> 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
->wait
))
456 wake_up_interruptible(&pipe
->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
,
485 while (pipe
->nrbufs
) {
486 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
489 if (sd
->len
> sd
->total_len
)
490 sd
->len
= sd
->total_len
;
492 ret
= pipe_buf_confirm(pipe
, buf
);
499 ret
= actor(pipe
, buf
, sd
);
506 sd
->num_spliced
+= ret
;
509 sd
->total_len
-= ret
;
512 pipe_buf_release(pipe
, buf
);
513 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (pipe
->buffers
- 1);
516 sd
->need_wakeup
= true;
527 * splice_from_pipe_next - wait for some data to splice from
528 * @pipe: pipe to splice from
529 * @sd: information about the splice operation
532 * This function will wait for some data and return a positive
533 * value (one) if pipe buffers are available. It will return zero
534 * or -errno if no more data needs to be spliced.
536 static int splice_from_pipe_next(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
539 * Check for signal early to make process killable when there are
540 * always buffers available
542 if (signal_pending(current
))
545 while (!pipe
->nrbufs
) {
549 if (!pipe
->waiting_writers
&& sd
->num_spliced
)
552 if (sd
->flags
& SPLICE_F_NONBLOCK
)
555 if (signal_pending(current
))
558 if (sd
->need_wakeup
) {
559 wakeup_pipe_writers(pipe
);
560 sd
->need_wakeup
= false;
570 * splice_from_pipe_begin - start splicing from pipe
571 * @sd: information about the splice operation
574 * This function should be called before a loop containing
575 * splice_from_pipe_next() and splice_from_pipe_feed() to
576 * initialize the necessary fields of @sd.
578 static void splice_from_pipe_begin(struct splice_desc
*sd
)
581 sd
->need_wakeup
= false;
585 * splice_from_pipe_end - finish splicing from pipe
586 * @pipe: pipe to splice from
587 * @sd: information about the splice operation
590 * This function will wake up pipe writers if necessary. It should
591 * be called after a loop containing splice_from_pipe_next() and
592 * splice_from_pipe_feed().
594 static void splice_from_pipe_end(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
597 wakeup_pipe_writers(pipe
);
601 * __splice_from_pipe - splice data from a pipe to given actor
602 * @pipe: pipe to splice from
603 * @sd: information to @actor
604 * @actor: handler that splices the data
607 * This function does little more than loop over the pipe and call
608 * @actor to do the actual moving of a single struct pipe_buffer to
609 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
613 ssize_t
__splice_from_pipe(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
618 splice_from_pipe_begin(sd
);
621 ret
= splice_from_pipe_next(pipe
, sd
);
623 ret
= splice_from_pipe_feed(pipe
, sd
, actor
);
625 splice_from_pipe_end(pipe
, sd
);
627 return sd
->num_spliced
? sd
->num_spliced
: ret
;
629 EXPORT_SYMBOL(__splice_from_pipe
);
632 * splice_from_pipe - splice data from a pipe to a file
633 * @pipe: pipe to splice from
634 * @out: file to splice to
635 * @ppos: position in @out
636 * @len: how many bytes to splice
637 * @flags: splice modifier flags
638 * @actor: handler that splices the data
641 * See __splice_from_pipe. This function locks the pipe inode,
642 * otherwise it's identical to __splice_from_pipe().
645 ssize_t
splice_from_pipe(struct pipe_inode_info
*pipe
, struct file
*out
,
646 loff_t
*ppos
, size_t len
, unsigned int flags
,
650 struct splice_desc sd
= {
658 ret
= __splice_from_pipe(pipe
, &sd
, actor
);
665 * iter_file_splice_write - splice data from a pipe to a file
667 * @out: file to write to
668 * @ppos: position in @out
669 * @len: number of bytes to splice
670 * @flags: splice modifier flags
673 * Will either move or copy pages (determined by @flags options) from
674 * the given pipe inode to the given file.
675 * This one is ->write_iter-based.
679 iter_file_splice_write(struct pipe_inode_info
*pipe
, struct file
*out
,
680 loff_t
*ppos
, size_t len
, unsigned int flags
)
682 struct splice_desc sd
= {
688 int nbufs
= pipe
->buffers
;
689 struct bio_vec
*array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
693 if (unlikely(!array
))
698 splice_from_pipe_begin(&sd
);
699 while (sd
.total_len
) {
700 struct iov_iter from
;
704 ret
= splice_from_pipe_next(pipe
, &sd
);
708 if (unlikely(nbufs
< pipe
->buffers
)) {
710 nbufs
= pipe
->buffers
;
711 array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
719 /* build the vector */
721 for (n
= 0, idx
= pipe
->curbuf
; left
&& n
< pipe
->nrbufs
; n
++, idx
++) {
722 struct pipe_buffer
*buf
= pipe
->bufs
+ idx
;
723 size_t this_len
= buf
->len
;
728 if (idx
== pipe
->buffers
- 1)
731 ret
= pipe_buf_confirm(pipe
, buf
);
738 array
[n
].bv_page
= buf
->page
;
739 array
[n
].bv_len
= this_len
;
740 array
[n
].bv_offset
= buf
->offset
;
744 iov_iter_bvec(&from
, WRITE
, array
, n
, sd
.total_len
- left
);
745 ret
= vfs_iter_write(out
, &from
, &sd
.pos
, 0);
749 sd
.num_spliced
+= ret
;
753 /* dismiss the fully eaten buffers, adjust the partial one */
755 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
756 if (ret
>= buf
->len
) {
759 pipe_buf_release(pipe
, buf
);
760 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (pipe
->buffers
- 1);
763 sd
.need_wakeup
= true;
773 splice_from_pipe_end(pipe
, &sd
);
778 ret
= sd
.num_spliced
;
783 EXPORT_SYMBOL(iter_file_splice_write
);
785 static int write_pipe_buf(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
786 struct splice_desc
*sd
)
790 loff_t tmp
= sd
->pos
;
792 data
= kmap(buf
->page
);
793 ret
= __kernel_write(sd
->u
.file
, data
+ buf
->offset
, sd
->len
, &tmp
);
799 static ssize_t
default_file_splice_write(struct pipe_inode_info
*pipe
,
800 struct file
*out
, loff_t
*ppos
,
801 size_t len
, unsigned int flags
)
805 ret
= splice_from_pipe(pipe
, out
, ppos
, len
, flags
, write_pipe_buf
);
813 * generic_splice_sendpage - splice data from a pipe to a socket
814 * @pipe: pipe to splice from
815 * @out: socket to write to
816 * @ppos: position in @out
817 * @len: number of bytes to splice
818 * @flags: splice modifier flags
821 * Will send @len bytes from the pipe to a network socket. No data copying
825 ssize_t
generic_splice_sendpage(struct pipe_inode_info
*pipe
, struct file
*out
,
826 loff_t
*ppos
, size_t len
, unsigned int flags
)
828 return splice_from_pipe(pipe
, out
, ppos
, len
, flags
, pipe_to_sendpage
);
831 EXPORT_SYMBOL(generic_splice_sendpage
);
834 * Attempt to initiate a splice from pipe to file.
836 static long do_splice_from(struct pipe_inode_info
*pipe
, struct file
*out
,
837 loff_t
*ppos
, size_t len
, unsigned int flags
)
839 ssize_t (*splice_write
)(struct pipe_inode_info
*, struct file
*,
840 loff_t
*, size_t, unsigned int);
842 if (out
->f_op
->splice_write
)
843 splice_write
= out
->f_op
->splice_write
;
845 splice_write
= default_file_splice_write
;
847 return splice_write(pipe
, out
, ppos
, len
, flags
);
851 * Attempt to initiate a splice from a file to a pipe.
853 static long do_splice_to(struct file
*in
, loff_t
*ppos
,
854 struct pipe_inode_info
*pipe
, size_t len
,
857 ssize_t (*splice_read
)(struct file
*, loff_t
*,
858 struct pipe_inode_info
*, size_t, unsigned int);
861 if (unlikely(!(in
->f_mode
& FMODE_READ
)))
864 ret
= rw_verify_area(READ
, in
, ppos
, len
);
865 if (unlikely(ret
< 0))
868 if (unlikely(len
> MAX_RW_COUNT
))
871 if (in
->f_op
->splice_read
)
872 splice_read
= in
->f_op
->splice_read
;
874 splice_read
= default_file_splice_read
;
876 return splice_read(in
, ppos
, pipe
, len
, flags
);
880 * splice_direct_to_actor - splices data directly between two non-pipes
881 * @in: file to splice from
882 * @sd: actor information on where to splice to
883 * @actor: handles the data splicing
886 * This is a special case helper to splice directly between two
887 * points, without requiring an explicit pipe. Internally an allocated
888 * pipe is cached in the process, and reused during the lifetime of
892 ssize_t
splice_direct_to_actor(struct file
*in
, struct splice_desc
*sd
,
893 splice_direct_actor
*actor
)
895 struct pipe_inode_info
*pipe
;
902 * We require the input being a regular file, as we don't want to
903 * randomly drop data for eg socket -> socket splicing. Use the
904 * piped splicing for that!
906 i_mode
= file_inode(in
)->i_mode
;
907 if (unlikely(!S_ISREG(i_mode
) && !S_ISBLK(i_mode
)))
911 * neither in nor out is a pipe, setup an internal pipe attached to
912 * 'out' and transfer the wanted data from 'in' to 'out' through that
914 pipe
= current
->splice_pipe
;
915 if (unlikely(!pipe
)) {
916 pipe
= alloc_pipe_info();
921 * We don't have an immediate reader, but we'll read the stuff
922 * out of the pipe right after the splice_to_pipe(). So set
923 * PIPE_READERS appropriately.
927 current
->splice_pipe
= pipe
;
939 * Don't block on output, we have to drain the direct pipe.
941 sd
->flags
&= ~SPLICE_F_NONBLOCK
;
942 more
= sd
->flags
& SPLICE_F_MORE
;
944 WARN_ON_ONCE(pipe
->nrbufs
!= 0);
948 loff_t pos
= sd
->pos
, prev_pos
= pos
;
950 /* Don't try to read more the pipe has space for. */
951 read_len
= min_t(size_t, len
,
952 (pipe
->buffers
- pipe
->nrbufs
) << PAGE_SHIFT
);
953 ret
= do_splice_to(in
, &pos
, pipe
, read_len
, flags
);
954 if (unlikely(ret
<= 0))
958 sd
->total_len
= read_len
;
961 * If more data is pending, set SPLICE_F_MORE
962 * If this is the last data and SPLICE_F_MORE was not set
963 * initially, clears it.
966 sd
->flags
|= SPLICE_F_MORE
;
968 sd
->flags
&= ~SPLICE_F_MORE
;
970 * NOTE: nonblocking mode only applies to the input. We
971 * must not do the output in nonblocking mode as then we
972 * could get stuck data in the internal pipe:
974 ret
= actor(pipe
, sd
);
975 if (unlikely(ret
<= 0)) {
984 if (ret
< read_len
) {
985 sd
->pos
= prev_pos
+ ret
;
991 pipe
->nrbufs
= pipe
->curbuf
= 0;
997 * If we did an incomplete transfer we must release
998 * the pipe buffers in question:
1000 for (i
= 0; i
< pipe
->buffers
; i
++) {
1001 struct pipe_buffer
*buf
= pipe
->bufs
+ i
;
1004 pipe_buf_release(pipe
, buf
);
1012 EXPORT_SYMBOL(splice_direct_to_actor
);
1014 static int direct_splice_actor(struct pipe_inode_info
*pipe
,
1015 struct splice_desc
*sd
)
1017 struct file
*file
= sd
->u
.file
;
1019 return do_splice_from(pipe
, file
, sd
->opos
, sd
->total_len
,
1024 * do_splice_direct - splices data directly between two files
1025 * @in: file to splice from
1026 * @ppos: input file offset
1027 * @out: file to splice to
1028 * @opos: output file offset
1029 * @len: number of bytes to splice
1030 * @flags: splice modifier flags
1033 * For use by do_sendfile(). splice can easily emulate sendfile, but
1034 * doing it in the application would incur an extra system call
1035 * (splice in + splice out, as compared to just sendfile()). So this helper
1036 * can splice directly through a process-private pipe.
1039 long do_splice_direct(struct file
*in
, loff_t
*ppos
, struct file
*out
,
1040 loff_t
*opos
, size_t len
, unsigned int flags
)
1042 struct splice_desc sd
= {
1052 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1055 if (unlikely(out
->f_flags
& O_APPEND
))
1058 ret
= rw_verify_area(WRITE
, out
, opos
, len
);
1059 if (unlikely(ret
< 0))
1062 ret
= splice_direct_to_actor(in
, &sd
, direct_splice_actor
);
1068 EXPORT_SYMBOL(do_splice_direct
);
1070 static int wait_for_space(struct pipe_inode_info
*pipe
, unsigned flags
)
1073 if (unlikely(!pipe
->readers
)) {
1074 send_sig(SIGPIPE
, current
, 0);
1077 if (pipe
->nrbufs
!= pipe
->buffers
)
1079 if (flags
& SPLICE_F_NONBLOCK
)
1081 if (signal_pending(current
))
1082 return -ERESTARTSYS
;
1083 pipe
->waiting_writers
++;
1085 pipe
->waiting_writers
--;
1089 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1090 struct pipe_inode_info
*opipe
,
1091 size_t len
, unsigned int flags
);
1094 * Determine where to splice to/from.
1096 static long do_splice(struct file
*in
, loff_t __user
*off_in
,
1097 struct file
*out
, loff_t __user
*off_out
,
1098 size_t len
, unsigned int flags
)
1100 struct pipe_inode_info
*ipipe
;
1101 struct pipe_inode_info
*opipe
;
1105 ipipe
= get_pipe_info(in
);
1106 opipe
= get_pipe_info(out
);
1108 if (ipipe
&& opipe
) {
1109 if (off_in
|| off_out
)
1112 if (!(in
->f_mode
& FMODE_READ
))
1115 if (!(out
->f_mode
& FMODE_WRITE
))
1118 /* Splicing to self would be fun, but... */
1122 if ((in
->f_flags
| out
->f_flags
) & O_NONBLOCK
)
1123 flags
|= SPLICE_F_NONBLOCK
;
1125 return splice_pipe_to_pipe(ipipe
, opipe
, len
, flags
);
1132 if (!(out
->f_mode
& FMODE_PWRITE
))
1134 if (copy_from_user(&offset
, off_out
, sizeof(loff_t
)))
1137 offset
= out
->f_pos
;
1140 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1143 if (unlikely(out
->f_flags
& O_APPEND
))
1146 ret
= rw_verify_area(WRITE
, out
, &offset
, len
);
1147 if (unlikely(ret
< 0))
1150 if (in
->f_flags
& O_NONBLOCK
)
1151 flags
|= SPLICE_F_NONBLOCK
;
1153 file_start_write(out
);
1154 ret
= do_splice_from(ipipe
, out
, &offset
, len
, flags
);
1155 file_end_write(out
);
1158 out
->f_pos
= offset
;
1159 else if (copy_to_user(off_out
, &offset
, sizeof(loff_t
)))
1169 if (!(in
->f_mode
& FMODE_PREAD
))
1171 if (copy_from_user(&offset
, off_in
, sizeof(loff_t
)))
1177 if (out
->f_flags
& O_NONBLOCK
)
1178 flags
|= SPLICE_F_NONBLOCK
;
1181 ret
= wait_for_space(opipe
, flags
);
1183 ret
= do_splice_to(in
, &offset
, opipe
, len
, flags
);
1186 wakeup_pipe_readers(opipe
);
1189 else if (copy_to_user(off_in
, &offset
, sizeof(loff_t
)))
1198 static int iter_to_pipe(struct iov_iter
*from
,
1199 struct pipe_inode_info
*pipe
,
1202 struct pipe_buffer buf
= {
1203 .ops
= &user_page_pipe_buf_ops
,
1208 bool failed
= false;
1210 while (iov_iter_count(from
) && !failed
) {
1211 struct page
*pages
[16];
1216 copied
= iov_iter_get_pages(from
, pages
, ~0UL, 16, &start
);
1222 for (n
= 0; copied
; n
++, start
= 0) {
1223 int size
= min_t(int, copied
, PAGE_SIZE
- start
);
1225 buf
.page
= pages
[n
];
1228 ret
= add_to_pipe(pipe
, &buf
);
1229 if (unlikely(ret
< 0)) {
1232 iov_iter_advance(from
, ret
);
1241 return total
? total
: ret
;
1244 static int pipe_to_user(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
1245 struct splice_desc
*sd
)
1247 int n
= copy_page_to_iter(buf
->page
, buf
->offset
, sd
->len
, sd
->u
.data
);
1248 return n
== sd
->len
? n
: -EFAULT
;
1252 * For lack of a better implementation, implement vmsplice() to userspace
1253 * as a simple copy of the pipes pages to the user iov.
1255 static long vmsplice_to_user(struct file
*file
, struct iov_iter
*iter
,
1258 struct pipe_inode_info
*pipe
= get_pipe_info(file
);
1259 struct splice_desc sd
= {
1260 .total_len
= iov_iter_count(iter
),
1271 ret
= __splice_from_pipe(pipe
, &sd
, pipe_to_user
);
1279 * vmsplice splices a user address range into a pipe. It can be thought of
1280 * as splice-from-memory, where the regular splice is splice-from-file (or
1281 * to file). In both cases the output is a pipe, naturally.
1283 static long vmsplice_to_pipe(struct file
*file
, struct iov_iter
*iter
,
1286 struct pipe_inode_info
*pipe
;
1288 unsigned buf_flag
= 0;
1290 if (flags
& SPLICE_F_GIFT
)
1291 buf_flag
= PIPE_BUF_FLAG_GIFT
;
1293 pipe
= get_pipe_info(file
);
1298 ret
= wait_for_space(pipe
, flags
);
1300 ret
= iter_to_pipe(iter
, pipe
, buf_flag
);
1303 wakeup_pipe_readers(pipe
);
1307 static int vmsplice_type(struct fd f
, int *type
)
1311 if (f
.file
->f_mode
& FMODE_WRITE
) {
1313 } else if (f
.file
->f_mode
& FMODE_READ
) {
1323 * Note that vmsplice only really supports true splicing _from_ user memory
1324 * to a pipe, not the other way around. Splicing from user memory is a simple
1325 * operation that can be supported without any funky alignment restrictions
1326 * or nasty vm tricks. We simply map in the user memory and fill them into
1327 * a pipe. The reverse isn't quite as easy, though. There are two possible
1328 * solutions for that:
1330 * - memcpy() the data internally, at which point we might as well just
1331 * do a regular read() on the buffer anyway.
1332 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1333 * has restriction limitations on both ends of the pipe).
1335 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1338 static long do_vmsplice(struct file
*f
, struct iov_iter
*iter
, unsigned int flags
)
1340 if (unlikely(flags
& ~SPLICE_F_ALL
))
1343 if (!iov_iter_count(iter
))
1346 if (iov_iter_rw(iter
) == WRITE
)
1347 return vmsplice_to_pipe(f
, iter
, flags
);
1349 return vmsplice_to_user(f
, iter
, flags
);
1352 SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct iovec __user
*, uiov
,
1353 unsigned long, nr_segs
, unsigned int, flags
)
1355 struct iovec iovstack
[UIO_FASTIOV
];
1356 struct iovec
*iov
= iovstack
;
1357 struct iov_iter iter
;
1363 error
= vmsplice_type(f
, &type
);
1367 error
= import_iovec(type
, uiov
, nr_segs
,
1368 ARRAY_SIZE(iovstack
), &iov
, &iter
);
1370 error
= do_vmsplice(f
.file
, &iter
, flags
);
1377 #ifdef CONFIG_COMPAT
1378 COMPAT_SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct compat_iovec __user
*, iov32
,
1379 unsigned int, nr_segs
, unsigned int, flags
)
1381 struct iovec iovstack
[UIO_FASTIOV
];
1382 struct iovec
*iov
= iovstack
;
1383 struct iov_iter iter
;
1389 error
= vmsplice_type(f
, &type
);
1393 error
= compat_import_iovec(type
, iov32
, nr_segs
,
1394 ARRAY_SIZE(iovstack
), &iov
, &iter
);
1396 error
= do_vmsplice(f
.file
, &iter
, flags
);
1404 SYSCALL_DEFINE6(splice
, int, fd_in
, loff_t __user
*, off_in
,
1405 int, fd_out
, loff_t __user
*, off_out
,
1406 size_t, len
, unsigned int, flags
)
1414 if (unlikely(flags
& ~SPLICE_F_ALL
))
1420 if (in
.file
->f_mode
& FMODE_READ
) {
1421 out
= fdget(fd_out
);
1423 if (out
.file
->f_mode
& FMODE_WRITE
)
1424 error
= do_splice(in
.file
, off_in
,
1436 * Make sure there's data to read. Wait for input if we can, otherwise
1437 * return an appropriate error.
1439 static int ipipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1444 * Check ->nrbufs without the inode lock first. This function
1445 * is speculative anyways, so missing one is ok.
1453 while (!pipe
->nrbufs
) {
1454 if (signal_pending(current
)) {
1460 if (!pipe
->waiting_writers
) {
1461 if (flags
& SPLICE_F_NONBLOCK
) {
1474 * Make sure there's writeable room. Wait for room if we can, otherwise
1475 * return an appropriate error.
1477 static int opipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1482 * Check ->nrbufs without the inode lock first. This function
1483 * is speculative anyways, so missing one is ok.
1485 if (pipe
->nrbufs
< pipe
->buffers
)
1491 while (pipe
->nrbufs
>= pipe
->buffers
) {
1492 if (!pipe
->readers
) {
1493 send_sig(SIGPIPE
, current
, 0);
1497 if (flags
& SPLICE_F_NONBLOCK
) {
1501 if (signal_pending(current
)) {
1505 pipe
->waiting_writers
++;
1507 pipe
->waiting_writers
--;
1515 * Splice contents of ipipe to opipe.
1517 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1518 struct pipe_inode_info
*opipe
,
1519 size_t len
, unsigned int flags
)
1521 struct pipe_buffer
*ibuf
, *obuf
;
1523 bool input_wakeup
= false;
1527 ret
= ipipe_prep(ipipe
, flags
);
1531 ret
= opipe_prep(opipe
, flags
);
1536 * Potential ABBA deadlock, work around it by ordering lock
1537 * grabbing by pipe info address. Otherwise two different processes
1538 * could deadlock (one doing tee from A -> B, the other from B -> A).
1540 pipe_double_lock(ipipe
, opipe
);
1543 if (!opipe
->readers
) {
1544 send_sig(SIGPIPE
, current
, 0);
1550 if (!ipipe
->nrbufs
&& !ipipe
->writers
)
1554 * Cannot make any progress, because either the input
1555 * pipe is empty or the output pipe is full.
1557 if (!ipipe
->nrbufs
|| opipe
->nrbufs
>= opipe
->buffers
) {
1558 /* Already processed some buffers, break */
1562 if (flags
& SPLICE_F_NONBLOCK
) {
1568 * We raced with another reader/writer and haven't
1569 * managed to process any buffers. A zero return
1570 * value means EOF, so retry instead.
1577 ibuf
= ipipe
->bufs
+ ipipe
->curbuf
;
1578 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (opipe
->buffers
- 1);
1579 obuf
= opipe
->bufs
+ nbuf
;
1581 if (len
>= ibuf
->len
) {
1583 * Simply move the whole buffer from ipipe to opipe
1588 ipipe
->curbuf
= (ipipe
->curbuf
+ 1) & (ipipe
->buffers
- 1);
1590 input_wakeup
= true;
1593 * Get a reference to this pipe buffer,
1594 * so we can copy the contents over.
1596 if (!pipe_buf_get(ipipe
, ibuf
)) {
1604 * Don't inherit the gift flag, we need to
1605 * prevent multiple steals of this page.
1607 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1609 pipe_buf_mark_unmergeable(obuf
);
1613 ibuf
->offset
+= obuf
->len
;
1614 ibuf
->len
-= obuf
->len
;
1624 * If we put data in the output pipe, wakeup any potential readers.
1627 wakeup_pipe_readers(opipe
);
1630 wakeup_pipe_writers(ipipe
);
1636 * Link contents of ipipe to opipe.
1638 static int link_pipe(struct pipe_inode_info
*ipipe
,
1639 struct pipe_inode_info
*opipe
,
1640 size_t len
, unsigned int flags
)
1642 struct pipe_buffer
*ibuf
, *obuf
;
1643 int ret
= 0, i
= 0, nbuf
;
1646 * Potential ABBA deadlock, work around it by ordering lock
1647 * grabbing by pipe info address. Otherwise two different processes
1648 * could deadlock (one doing tee from A -> B, the other from B -> A).
1650 pipe_double_lock(ipipe
, opipe
);
1653 if (!opipe
->readers
) {
1654 send_sig(SIGPIPE
, current
, 0);
1661 * If we have iterated all input buffers or ran out of
1662 * output room, break.
1664 if (i
>= ipipe
->nrbufs
|| opipe
->nrbufs
>= opipe
->buffers
)
1667 ibuf
= ipipe
->bufs
+ ((ipipe
->curbuf
+ i
) & (ipipe
->buffers
-1));
1668 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (opipe
->buffers
- 1);
1671 * Get a reference to this pipe buffer,
1672 * so we can copy the contents over.
1674 if (!pipe_buf_get(ipipe
, ibuf
)) {
1680 obuf
= opipe
->bufs
+ nbuf
;
1684 * Don't inherit the gift flag, we need to
1685 * prevent multiple steals of this page.
1687 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1689 pipe_buf_mark_unmergeable(obuf
);
1691 if (obuf
->len
> len
)
1701 * return EAGAIN if we have the potential of some data in the
1702 * future, otherwise just return 0
1704 if (!ret
&& ipipe
->waiting_writers
&& (flags
& SPLICE_F_NONBLOCK
))
1711 * If we put data in the output pipe, wakeup any potential readers.
1714 wakeup_pipe_readers(opipe
);
1720 * This is a tee(1) implementation that works on pipes. It doesn't copy
1721 * any data, it simply references the 'in' pages on the 'out' pipe.
1722 * The 'flags' used are the SPLICE_F_* variants, currently the only
1723 * applicable one is SPLICE_F_NONBLOCK.
1725 static long do_tee(struct file
*in
, struct file
*out
, size_t len
,
1728 struct pipe_inode_info
*ipipe
= get_pipe_info(in
);
1729 struct pipe_inode_info
*opipe
= get_pipe_info(out
);
1733 * Duplicate the contents of ipipe to opipe without actually
1736 if (ipipe
&& opipe
&& ipipe
!= opipe
) {
1737 if ((in
->f_flags
| out
->f_flags
) & O_NONBLOCK
)
1738 flags
|= SPLICE_F_NONBLOCK
;
1741 * Keep going, unless we encounter an error. The ipipe/opipe
1742 * ordering doesn't really matter.
1744 ret
= ipipe_prep(ipipe
, flags
);
1746 ret
= opipe_prep(opipe
, flags
);
1748 ret
= link_pipe(ipipe
, opipe
, len
, flags
);
1755 SYSCALL_DEFINE4(tee
, int, fdin
, int, fdout
, size_t, len
, unsigned int, flags
)
1760 if (unlikely(flags
& ~SPLICE_F_ALL
))
1769 if (in
.file
->f_mode
& FMODE_READ
) {
1770 struct fd out
= fdget(fdout
);
1772 if (out
.file
->f_mode
& FMODE_WRITE
)
1773 error
= do_tee(in
.file
, out
.file
,