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
)
91 page_cache_release(buf
->page
);
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
, do_wakeup
, page_nr
;
198 if (!pipe
->readers
) {
199 send_sig(SIGPIPE
, current
, 0);
205 if (pipe
->nrbufs
< pipe
->buffers
) {
206 int newbuf
= (pipe
->curbuf
+ pipe
->nrbufs
) & (pipe
->buffers
- 1);
207 struct pipe_buffer
*buf
= pipe
->bufs
+ newbuf
;
209 buf
->page
= spd
->pages
[page_nr
];
210 buf
->offset
= spd
->partial
[page_nr
].offset
;
211 buf
->len
= spd
->partial
[page_nr
].len
;
212 buf
->private = spd
->partial
[page_nr
].private;
214 if (spd
->flags
& SPLICE_F_GIFT
)
215 buf
->flags
|= PIPE_BUF_FLAG_GIFT
;
224 if (!--spd
->nr_pages
)
226 if (pipe
->nrbufs
< pipe
->buffers
)
232 if (spd
->flags
& SPLICE_F_NONBLOCK
) {
238 if (signal_pending(current
)) {
246 if (waitqueue_active(&pipe
->wait
))
247 wake_up_interruptible_sync(&pipe
->wait
);
248 kill_fasync(&pipe
->fasync_readers
, SIGIO
, POLL_IN
);
252 pipe
->waiting_writers
++;
254 pipe
->waiting_writers
--;
260 wakeup_pipe_readers(pipe
);
262 while (page_nr
< spd_pages
)
263 spd
->spd_release(spd
, page_nr
++);
267 EXPORT_SYMBOL_GPL(splice_to_pipe
);
269 void spd_release_page(struct splice_pipe_desc
*spd
, unsigned int i
)
271 page_cache_release(spd
->pages
[i
]);
275 * Check if we need to grow the arrays holding pages and partial page
278 int splice_grow_spd(const struct pipe_inode_info
*pipe
, struct splice_pipe_desc
*spd
)
280 unsigned int buffers
= ACCESS_ONCE(pipe
->buffers
);
282 spd
->nr_pages_max
= buffers
;
283 if (buffers
<= PIPE_DEF_BUFFERS
)
286 spd
->pages
= kmalloc(buffers
* sizeof(struct page
*), GFP_KERNEL
);
287 spd
->partial
= kmalloc(buffers
* sizeof(struct partial_page
), GFP_KERNEL
);
289 if (spd
->pages
&& spd
->partial
)
297 void splice_shrink_spd(struct splice_pipe_desc
*spd
)
299 if (spd
->nr_pages_max
<= PIPE_DEF_BUFFERS
)
307 __generic_file_splice_read(struct file
*in
, loff_t
*ppos
,
308 struct pipe_inode_info
*pipe
, size_t len
,
311 struct address_space
*mapping
= in
->f_mapping
;
312 unsigned int loff
, nr_pages
, req_pages
;
313 struct page
*pages
[PIPE_DEF_BUFFERS
];
314 struct partial_page partial
[PIPE_DEF_BUFFERS
];
316 pgoff_t index
, end_index
;
319 struct splice_pipe_desc spd
= {
322 .nr_pages_max
= PIPE_DEF_BUFFERS
,
324 .ops
= &page_cache_pipe_buf_ops
,
325 .spd_release
= spd_release_page
,
328 if (splice_grow_spd(pipe
, &spd
))
331 index
= *ppos
>> PAGE_CACHE_SHIFT
;
332 loff
= *ppos
& ~PAGE_CACHE_MASK
;
333 req_pages
= (len
+ loff
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
334 nr_pages
= min(req_pages
, spd
.nr_pages_max
);
337 * Lookup the (hopefully) full range of pages we need.
339 spd
.nr_pages
= find_get_pages_contig(mapping
, index
, nr_pages
, spd
.pages
);
340 index
+= spd
.nr_pages
;
343 * If find_get_pages_contig() returned fewer pages than we needed,
344 * readahead/allocate the rest and fill in the holes.
346 if (spd
.nr_pages
< nr_pages
)
347 page_cache_sync_readahead(mapping
, &in
->f_ra
, in
,
348 index
, req_pages
- spd
.nr_pages
);
351 while (spd
.nr_pages
< nr_pages
) {
353 * Page could be there, find_get_pages_contig() breaks on
356 page
= find_get_page(mapping
, index
);
359 * page didn't exist, allocate one.
361 page
= page_cache_alloc_cold(mapping
);
365 error
= add_to_page_cache_lru(page
, mapping
, index
,
366 mapping_gfp_constraint(mapping
, GFP_KERNEL
));
367 if (unlikely(error
)) {
368 page_cache_release(page
);
369 if (error
== -EEXIST
)
374 * add_to_page_cache() locks the page, unlock it
375 * to avoid convoluting the logic below even more.
380 spd
.pages
[spd
.nr_pages
++] = page
;
385 * Now loop over the map and see if we need to start IO on any
386 * pages, fill in the partial map, etc.
388 index
= *ppos
>> PAGE_CACHE_SHIFT
;
389 nr_pages
= spd
.nr_pages
;
391 for (page_nr
= 0; page_nr
< nr_pages
; page_nr
++) {
392 unsigned int this_len
;
398 * this_len is the max we'll use from this page
400 this_len
= min_t(unsigned long, len
, PAGE_CACHE_SIZE
- loff
);
401 page
= spd
.pages
[page_nr
];
403 if (PageReadahead(page
))
404 page_cache_async_readahead(mapping
, &in
->f_ra
, in
,
405 page
, index
, req_pages
- page_nr
);
408 * If the page isn't uptodate, we may need to start io on it
410 if (!PageUptodate(page
)) {
414 * Page was truncated, or invalidated by the
415 * filesystem. Redo the find/create, but this time the
416 * page is kept locked, so there's no chance of another
417 * race with truncate/invalidate.
419 if (!page
->mapping
) {
421 page
= find_or_create_page(mapping
, index
,
422 mapping_gfp_mask(mapping
));
428 page_cache_release(spd
.pages
[page_nr
]);
429 spd
.pages
[page_nr
] = page
;
432 * page was already under io and is now done, great
434 if (PageUptodate(page
)) {
440 * need to read in the page
442 error
= mapping
->a_ops
->readpage(in
, page
);
443 if (unlikely(error
)) {
445 * We really should re-lookup the page here,
446 * but it complicates things a lot. Instead
447 * lets just do what we already stored, and
448 * we'll get it the next time we are called.
450 if (error
== AOP_TRUNCATED_PAGE
)
458 * i_size must be checked after PageUptodate.
460 isize
= i_size_read(mapping
->host
);
461 end_index
= (isize
- 1) >> PAGE_CACHE_SHIFT
;
462 if (unlikely(!isize
|| index
> end_index
))
466 * if this is the last page, see if we need to shrink
467 * the length and stop
469 if (end_index
== index
) {
473 * max good bytes in this page
475 plen
= ((isize
- 1) & ~PAGE_CACHE_MASK
) + 1;
480 * force quit after adding this page
482 this_len
= min(this_len
, plen
- loff
);
486 spd
.partial
[page_nr
].offset
= loff
;
487 spd
.partial
[page_nr
].len
= this_len
;
495 * Release any pages at the end, if we quit early. 'page_nr' is how far
496 * we got, 'nr_pages' is how many pages are in the map.
498 while (page_nr
< nr_pages
)
499 page_cache_release(spd
.pages
[page_nr
++]);
500 in
->f_ra
.prev_pos
= (loff_t
)index
<< PAGE_CACHE_SHIFT
;
503 error
= splice_to_pipe(pipe
, &spd
);
505 splice_shrink_spd(&spd
);
510 * generic_file_splice_read - splice data from file to a pipe
511 * @in: file to splice from
512 * @ppos: position in @in
513 * @pipe: pipe to splice to
514 * @len: number of bytes to splice
515 * @flags: splice modifier flags
518 * Will read pages from given file and fill them into a pipe. Can be
519 * used as long as the address_space operations for the source implements
523 ssize_t
generic_file_splice_read(struct file
*in
, loff_t
*ppos
,
524 struct pipe_inode_info
*pipe
, size_t len
,
530 if (IS_DAX(in
->f_mapping
->host
))
531 return default_file_splice_read(in
, ppos
, pipe
, len
, flags
);
533 isize
= i_size_read(in
->f_mapping
->host
);
534 if (unlikely(*ppos
>= isize
))
537 left
= isize
- *ppos
;
538 if (unlikely(left
< len
))
541 ret
= __generic_file_splice_read(in
, ppos
, pipe
, len
, flags
);
549 EXPORT_SYMBOL(generic_file_splice_read
);
551 static const struct pipe_buf_operations default_pipe_buf_ops
= {
553 .confirm
= generic_pipe_buf_confirm
,
554 .release
= generic_pipe_buf_release
,
555 .steal
= generic_pipe_buf_steal
,
556 .get
= generic_pipe_buf_get
,
559 static int generic_pipe_buf_nosteal(struct pipe_inode_info
*pipe
,
560 struct pipe_buffer
*buf
)
565 /* Pipe buffer operations for a socket and similar. */
566 const struct pipe_buf_operations nosteal_pipe_buf_ops
= {
568 .confirm
= generic_pipe_buf_confirm
,
569 .release
= generic_pipe_buf_release
,
570 .steal
= generic_pipe_buf_nosteal
,
571 .get
= generic_pipe_buf_get
,
573 EXPORT_SYMBOL(nosteal_pipe_buf_ops
);
575 static ssize_t
kernel_readv(struct file
*file
, const struct iovec
*vec
,
576 unsigned long vlen
, loff_t offset
)
584 /* The cast to a user pointer is valid due to the set_fs() */
585 res
= vfs_readv(file
, (const struct iovec __user
*)vec
, vlen
, &pos
);
591 ssize_t
kernel_write(struct file
*file
, const char *buf
, size_t count
,
599 /* The cast to a user pointer is valid due to the set_fs() */
600 res
= vfs_write(file
, (__force
const char __user
*)buf
, count
, &pos
);
605 EXPORT_SYMBOL(kernel_write
);
607 ssize_t
default_file_splice_read(struct file
*in
, loff_t
*ppos
,
608 struct pipe_inode_info
*pipe
, size_t len
,
611 unsigned int nr_pages
;
612 unsigned int nr_freed
;
614 struct page
*pages
[PIPE_DEF_BUFFERS
];
615 struct partial_page partial
[PIPE_DEF_BUFFERS
];
616 struct iovec
*vec
, __vec
[PIPE_DEF_BUFFERS
];
621 struct splice_pipe_desc spd
= {
624 .nr_pages_max
= PIPE_DEF_BUFFERS
,
626 .ops
= &default_pipe_buf_ops
,
627 .spd_release
= spd_release_page
,
630 if (splice_grow_spd(pipe
, &spd
))
635 if (spd
.nr_pages_max
> PIPE_DEF_BUFFERS
) {
636 vec
= kmalloc(spd
.nr_pages_max
* sizeof(struct iovec
), GFP_KERNEL
);
641 offset
= *ppos
& ~PAGE_CACHE_MASK
;
642 nr_pages
= (len
+ offset
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
644 for (i
= 0; i
< nr_pages
&& i
< spd
.nr_pages_max
&& len
; i
++) {
647 page
= alloc_page(GFP_USER
);
652 this_len
= min_t(size_t, len
, PAGE_CACHE_SIZE
- offset
);
653 vec
[i
].iov_base
= (void __user
*) page_address(page
);
654 vec
[i
].iov_len
= this_len
;
661 res
= kernel_readv(in
, vec
, spd
.nr_pages
, *ppos
);
672 for (i
= 0; i
< spd
.nr_pages
; i
++) {
673 this_len
= min_t(size_t, vec
[i
].iov_len
, res
);
674 spd
.partial
[i
].offset
= 0;
675 spd
.partial
[i
].len
= this_len
;
677 __free_page(spd
.pages
[i
]);
683 spd
.nr_pages
-= nr_freed
;
685 res
= splice_to_pipe(pipe
, &spd
);
692 splice_shrink_spd(&spd
);
696 for (i
= 0; i
< spd
.nr_pages
; i
++)
697 __free_page(spd
.pages
[i
]);
702 EXPORT_SYMBOL(default_file_splice_read
);
705 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
706 * using sendpage(). Return the number of bytes sent.
708 static int pipe_to_sendpage(struct pipe_inode_info
*pipe
,
709 struct pipe_buffer
*buf
, struct splice_desc
*sd
)
711 struct file
*file
= sd
->u
.file
;
712 loff_t pos
= sd
->pos
;
715 if (!likely(file
->f_op
->sendpage
))
718 more
= (sd
->flags
& SPLICE_F_MORE
) ? MSG_MORE
: 0;
720 if (sd
->len
< sd
->total_len
&& pipe
->nrbufs
> 1)
721 more
|= MSG_SENDPAGE_NOTLAST
;
723 return file
->f_op
->sendpage(file
, buf
->page
, buf
->offset
,
724 sd
->len
, &pos
, more
);
727 static void wakeup_pipe_writers(struct pipe_inode_info
*pipe
)
730 if (waitqueue_active(&pipe
->wait
))
731 wake_up_interruptible(&pipe
->wait
);
732 kill_fasync(&pipe
->fasync_writers
, SIGIO
, POLL_OUT
);
736 * splice_from_pipe_feed - feed available data from a pipe to a file
737 * @pipe: pipe to splice from
738 * @sd: information to @actor
739 * @actor: handler that splices the data
742 * This function loops over the pipe and calls @actor to do the
743 * actual moving of a single struct pipe_buffer to the desired
744 * destination. It returns when there's no more buffers left in
745 * the pipe or if the requested number of bytes (@sd->total_len)
746 * have been copied. It returns a positive number (one) if the
747 * pipe needs to be filled with more data, zero if the required
748 * number of bytes have been copied and -errno on error.
750 * This, together with splice_from_pipe_{begin,end,next}, may be
751 * used to implement the functionality of __splice_from_pipe() when
752 * locking is required around copying the pipe buffers to the
755 static int splice_from_pipe_feed(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
760 while (pipe
->nrbufs
) {
761 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
762 const struct pipe_buf_operations
*ops
= buf
->ops
;
765 if (sd
->len
> sd
->total_len
)
766 sd
->len
= sd
->total_len
;
768 ret
= buf
->ops
->confirm(pipe
, buf
);
775 ret
= actor(pipe
, buf
, sd
);
782 sd
->num_spliced
+= ret
;
785 sd
->total_len
-= ret
;
789 ops
->release(pipe
, buf
);
790 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (pipe
->buffers
- 1);
793 sd
->need_wakeup
= true;
804 * splice_from_pipe_next - wait for some data to splice from
805 * @pipe: pipe to splice from
806 * @sd: information about the splice operation
809 * This function will wait for some data and return a positive
810 * value (one) if pipe buffers are available. It will return zero
811 * or -errno if no more data needs to be spliced.
813 static int splice_from_pipe_next(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
816 * Check for signal early to make process killable when there are
817 * always buffers available
819 if (signal_pending(current
))
822 while (!pipe
->nrbufs
) {
826 if (!pipe
->waiting_writers
&& sd
->num_spliced
)
829 if (sd
->flags
& SPLICE_F_NONBLOCK
)
832 if (signal_pending(current
))
835 if (sd
->need_wakeup
) {
836 wakeup_pipe_writers(pipe
);
837 sd
->need_wakeup
= false;
847 * splice_from_pipe_begin - start splicing from pipe
848 * @sd: information about the splice operation
851 * This function should be called before a loop containing
852 * splice_from_pipe_next() and splice_from_pipe_feed() to
853 * initialize the necessary fields of @sd.
855 static void splice_from_pipe_begin(struct splice_desc
*sd
)
858 sd
->need_wakeup
= false;
862 * splice_from_pipe_end - finish splicing from pipe
863 * @pipe: pipe to splice from
864 * @sd: information about the splice operation
867 * This function will wake up pipe writers if necessary. It should
868 * be called after a loop containing splice_from_pipe_next() and
869 * splice_from_pipe_feed().
871 static void splice_from_pipe_end(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
874 wakeup_pipe_writers(pipe
);
878 * __splice_from_pipe - splice data from a pipe to given actor
879 * @pipe: pipe to splice from
880 * @sd: information to @actor
881 * @actor: handler that splices the data
884 * This function does little more than loop over the pipe and call
885 * @actor to do the actual moving of a single struct pipe_buffer to
886 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
890 ssize_t
__splice_from_pipe(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
895 splice_from_pipe_begin(sd
);
898 ret
= splice_from_pipe_next(pipe
, sd
);
900 ret
= splice_from_pipe_feed(pipe
, sd
, actor
);
902 splice_from_pipe_end(pipe
, sd
);
904 return sd
->num_spliced
? sd
->num_spliced
: ret
;
906 EXPORT_SYMBOL(__splice_from_pipe
);
909 * splice_from_pipe - splice data from a pipe to a file
910 * @pipe: pipe to splice from
911 * @out: file to splice to
912 * @ppos: position in @out
913 * @len: how many bytes to splice
914 * @flags: splice modifier flags
915 * @actor: handler that splices the data
918 * See __splice_from_pipe. This function locks the pipe inode,
919 * otherwise it's identical to __splice_from_pipe().
922 ssize_t
splice_from_pipe(struct pipe_inode_info
*pipe
, struct file
*out
,
923 loff_t
*ppos
, size_t len
, unsigned int flags
,
927 struct splice_desc sd
= {
935 ret
= __splice_from_pipe(pipe
, &sd
, actor
);
942 * iter_file_splice_write - splice data from a pipe to a file
944 * @out: file to write to
945 * @ppos: position in @out
946 * @len: number of bytes to splice
947 * @flags: splice modifier flags
950 * Will either move or copy pages (determined by @flags options) from
951 * the given pipe inode to the given file.
952 * This one is ->write_iter-based.
956 iter_file_splice_write(struct pipe_inode_info
*pipe
, struct file
*out
,
957 loff_t
*ppos
, size_t len
, unsigned int flags
)
959 struct splice_desc sd
= {
965 int nbufs
= pipe
->buffers
;
966 struct bio_vec
*array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
970 if (unlikely(!array
))
975 splice_from_pipe_begin(&sd
);
976 while (sd
.total_len
) {
977 struct iov_iter from
;
981 ret
= splice_from_pipe_next(pipe
, &sd
);
985 if (unlikely(nbufs
< pipe
->buffers
)) {
987 nbufs
= pipe
->buffers
;
988 array
= kcalloc(nbufs
, sizeof(struct bio_vec
),
996 /* build the vector */
998 for (n
= 0, idx
= pipe
->curbuf
; left
&& n
< pipe
->nrbufs
; n
++, idx
++) {
999 struct pipe_buffer
*buf
= pipe
->bufs
+ idx
;
1000 size_t this_len
= buf
->len
;
1002 if (this_len
> left
)
1005 if (idx
== pipe
->buffers
- 1)
1008 ret
= buf
->ops
->confirm(pipe
, buf
);
1009 if (unlikely(ret
)) {
1010 if (ret
== -ENODATA
)
1015 array
[n
].bv_page
= buf
->page
;
1016 array
[n
].bv_len
= this_len
;
1017 array
[n
].bv_offset
= buf
->offset
;
1021 iov_iter_bvec(&from
, ITER_BVEC
| WRITE
, array
, n
,
1022 sd
.total_len
- left
);
1023 ret
= vfs_iter_write(out
, &from
, &sd
.pos
);
1027 sd
.num_spliced
+= ret
;
1028 sd
.total_len
-= ret
;
1031 /* dismiss the fully eaten buffers, adjust the partial one */
1033 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
1034 if (ret
>= buf
->len
) {
1035 const struct pipe_buf_operations
*ops
= buf
->ops
;
1039 ops
->release(pipe
, buf
);
1040 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (pipe
->buffers
- 1);
1043 sd
.need_wakeup
= true;
1053 splice_from_pipe_end(pipe
, &sd
);
1058 ret
= sd
.num_spliced
;
1063 EXPORT_SYMBOL(iter_file_splice_write
);
1065 static int write_pipe_buf(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
1066 struct splice_desc
*sd
)
1070 loff_t tmp
= sd
->pos
;
1072 data
= kmap(buf
->page
);
1073 ret
= __kernel_write(sd
->u
.file
, data
+ buf
->offset
, sd
->len
, &tmp
);
1079 static ssize_t
default_file_splice_write(struct pipe_inode_info
*pipe
,
1080 struct file
*out
, loff_t
*ppos
,
1081 size_t len
, unsigned int flags
)
1085 ret
= splice_from_pipe(pipe
, out
, ppos
, len
, flags
, write_pipe_buf
);
1093 * generic_splice_sendpage - splice data from a pipe to a socket
1094 * @pipe: pipe to splice from
1095 * @out: socket to write to
1096 * @ppos: position in @out
1097 * @len: number of bytes to splice
1098 * @flags: splice modifier flags
1101 * Will send @len bytes from the pipe to a network socket. No data copying
1105 ssize_t
generic_splice_sendpage(struct pipe_inode_info
*pipe
, struct file
*out
,
1106 loff_t
*ppos
, size_t len
, unsigned int flags
)
1108 return splice_from_pipe(pipe
, out
, ppos
, len
, flags
, pipe_to_sendpage
);
1111 EXPORT_SYMBOL(generic_splice_sendpage
);
1114 * Attempt to initiate a splice from pipe to file.
1116 static long do_splice_from(struct pipe_inode_info
*pipe
, struct file
*out
,
1117 loff_t
*ppos
, size_t len
, unsigned int flags
)
1119 ssize_t (*splice_write
)(struct pipe_inode_info
*, struct file
*,
1120 loff_t
*, size_t, unsigned int);
1122 if (out
->f_op
->splice_write
)
1123 splice_write
= out
->f_op
->splice_write
;
1125 splice_write
= default_file_splice_write
;
1127 return splice_write(pipe
, out
, ppos
, len
, flags
);
1131 * Attempt to initiate a splice from a file to a pipe.
1133 static long do_splice_to(struct file
*in
, loff_t
*ppos
,
1134 struct pipe_inode_info
*pipe
, size_t len
,
1137 ssize_t (*splice_read
)(struct file
*, loff_t
*,
1138 struct pipe_inode_info
*, size_t, unsigned int);
1141 if (unlikely(!(in
->f_mode
& FMODE_READ
)))
1144 ret
= rw_verify_area(READ
, in
, ppos
, len
);
1145 if (unlikely(ret
< 0))
1148 if (in
->f_op
->splice_read
)
1149 splice_read
= in
->f_op
->splice_read
;
1151 splice_read
= default_file_splice_read
;
1153 return splice_read(in
, ppos
, pipe
, len
, flags
);
1157 * splice_direct_to_actor - splices data directly between two non-pipes
1158 * @in: file to splice from
1159 * @sd: actor information on where to splice to
1160 * @actor: handles the data splicing
1163 * This is a special case helper to splice directly between two
1164 * points, without requiring an explicit pipe. Internally an allocated
1165 * pipe is cached in the process, and reused during the lifetime of
1169 ssize_t
splice_direct_to_actor(struct file
*in
, struct splice_desc
*sd
,
1170 splice_direct_actor
*actor
)
1172 struct pipe_inode_info
*pipe
;
1179 * We require the input being a regular file, as we don't want to
1180 * randomly drop data for eg socket -> socket splicing. Use the
1181 * piped splicing for that!
1183 i_mode
= file_inode(in
)->i_mode
;
1184 if (unlikely(!S_ISREG(i_mode
) && !S_ISBLK(i_mode
)))
1188 * neither in nor out is a pipe, setup an internal pipe attached to
1189 * 'out' and transfer the wanted data from 'in' to 'out' through that
1191 pipe
= current
->splice_pipe
;
1192 if (unlikely(!pipe
)) {
1193 pipe
= alloc_pipe_info();
1198 * We don't have an immediate reader, but we'll read the stuff
1199 * out of the pipe right after the splice_to_pipe(). So set
1200 * PIPE_READERS appropriately.
1204 current
->splice_pipe
= pipe
;
1212 len
= sd
->total_len
;
1216 * Don't block on output, we have to drain the direct pipe.
1218 sd
->flags
&= ~SPLICE_F_NONBLOCK
;
1219 more
= sd
->flags
& SPLICE_F_MORE
;
1223 loff_t pos
= sd
->pos
, prev_pos
= pos
;
1225 ret
= do_splice_to(in
, &pos
, pipe
, len
, flags
);
1226 if (unlikely(ret
<= 0))
1230 sd
->total_len
= read_len
;
1233 * If more data is pending, set SPLICE_F_MORE
1234 * If this is the last data and SPLICE_F_MORE was not set
1235 * initially, clears it.
1238 sd
->flags
|= SPLICE_F_MORE
;
1240 sd
->flags
&= ~SPLICE_F_MORE
;
1242 * NOTE: nonblocking mode only applies to the input. We
1243 * must not do the output in nonblocking mode as then we
1244 * could get stuck data in the internal pipe:
1246 ret
= actor(pipe
, sd
);
1247 if (unlikely(ret
<= 0)) {
1256 if (ret
< read_len
) {
1257 sd
->pos
= prev_pos
+ ret
;
1263 pipe
->nrbufs
= pipe
->curbuf
= 0;
1269 * If we did an incomplete transfer we must release
1270 * the pipe buffers in question:
1272 for (i
= 0; i
< pipe
->buffers
; i
++) {
1273 struct pipe_buffer
*buf
= pipe
->bufs
+ i
;
1276 buf
->ops
->release(pipe
, buf
);
1286 EXPORT_SYMBOL(splice_direct_to_actor
);
1288 static int direct_splice_actor(struct pipe_inode_info
*pipe
,
1289 struct splice_desc
*sd
)
1291 struct file
*file
= sd
->u
.file
;
1293 return do_splice_from(pipe
, file
, sd
->opos
, sd
->total_len
,
1298 * do_splice_direct - splices data directly between two files
1299 * @in: file to splice from
1300 * @ppos: input file offset
1301 * @out: file to splice to
1302 * @opos: output file offset
1303 * @len: number of bytes to splice
1304 * @flags: splice modifier flags
1307 * For use by do_sendfile(). splice can easily emulate sendfile, but
1308 * doing it in the application would incur an extra system call
1309 * (splice in + splice out, as compared to just sendfile()). So this helper
1310 * can splice directly through a process-private pipe.
1313 long do_splice_direct(struct file
*in
, loff_t
*ppos
, struct file
*out
,
1314 loff_t
*opos
, size_t len
, unsigned int flags
)
1316 struct splice_desc sd
= {
1326 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1329 if (unlikely(out
->f_flags
& O_APPEND
))
1332 ret
= rw_verify_area(WRITE
, out
, opos
, len
);
1333 if (unlikely(ret
< 0))
1336 ret
= splice_direct_to_actor(in
, &sd
, direct_splice_actor
);
1342 EXPORT_SYMBOL(do_splice_direct
);
1344 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1345 struct pipe_inode_info
*opipe
,
1346 size_t len
, unsigned int flags
);
1349 * Determine where to splice to/from.
1351 static long do_splice(struct file
*in
, loff_t __user
*off_in
,
1352 struct file
*out
, loff_t __user
*off_out
,
1353 size_t len
, unsigned int flags
)
1355 struct pipe_inode_info
*ipipe
;
1356 struct pipe_inode_info
*opipe
;
1360 ipipe
= get_pipe_info(in
);
1361 opipe
= get_pipe_info(out
);
1363 if (ipipe
&& opipe
) {
1364 if (off_in
|| off_out
)
1367 if (!(in
->f_mode
& FMODE_READ
))
1370 if (!(out
->f_mode
& FMODE_WRITE
))
1373 /* Splicing to self would be fun, but... */
1377 return splice_pipe_to_pipe(ipipe
, opipe
, len
, flags
);
1384 if (!(out
->f_mode
& FMODE_PWRITE
))
1386 if (copy_from_user(&offset
, off_out
, sizeof(loff_t
)))
1389 offset
= out
->f_pos
;
1392 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1395 if (unlikely(out
->f_flags
& O_APPEND
))
1398 ret
= rw_verify_area(WRITE
, out
, &offset
, len
);
1399 if (unlikely(ret
< 0))
1402 file_start_write(out
);
1403 ret
= do_splice_from(ipipe
, out
, &offset
, len
, flags
);
1404 file_end_write(out
);
1407 out
->f_pos
= offset
;
1408 else if (copy_to_user(off_out
, &offset
, sizeof(loff_t
)))
1418 if (!(in
->f_mode
& FMODE_PREAD
))
1420 if (copy_from_user(&offset
, off_in
, sizeof(loff_t
)))
1426 ret
= do_splice_to(in
, &offset
, opipe
, len
, flags
);
1430 else if (copy_to_user(off_in
, &offset
, sizeof(loff_t
)))
1440 * Map an iov into an array of pages and offset/length tupples. With the
1441 * partial_page structure, we can map several non-contiguous ranges into
1442 * our ones pages[] map instead of splitting that operation into pieces.
1443 * Could easily be exported as a generic helper for other users, in which
1444 * case one would probably want to add a 'max_nr_pages' parameter as well.
1446 static int get_iovec_page_array(const struct iovec __user
*iov
,
1447 unsigned int nr_vecs
, struct page
**pages
,
1448 struct partial_page
*partial
, bool aligned
,
1449 unsigned int pipe_buffers
)
1451 int buffers
= 0, error
= 0;
1454 unsigned long off
, npages
;
1461 if (copy_from_user(&entry
, iov
, sizeof(entry
)))
1464 base
= entry
.iov_base
;
1465 len
= entry
.iov_len
;
1468 * Sanity check this iovec. 0 read succeeds.
1474 if (!access_ok(VERIFY_READ
, base
, len
))
1478 * Get this base offset and number of pages, then map
1479 * in the user pages.
1481 off
= (unsigned long) base
& ~PAGE_MASK
;
1484 * If asked for alignment, the offset must be zero and the
1485 * length a multiple of the PAGE_SIZE.
1488 if (aligned
&& (off
|| len
& ~PAGE_MASK
))
1491 npages
= (off
+ len
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
1492 if (npages
> pipe_buffers
- buffers
)
1493 npages
= pipe_buffers
- buffers
;
1495 error
= get_user_pages_fast((unsigned long)base
, npages
,
1496 0, &pages
[buffers
]);
1498 if (unlikely(error
<= 0))
1502 * Fill this contiguous range into the partial page map.
1504 for (i
= 0; i
< error
; i
++) {
1505 const int plen
= min_t(size_t, len
, PAGE_SIZE
- off
);
1507 partial
[buffers
].offset
= off
;
1508 partial
[buffers
].len
= plen
;
1516 * We didn't complete this iov, stop here since it probably
1517 * means we have to move some of this into a pipe to
1518 * be able to continue.
1524 * Don't continue if we mapped fewer pages than we asked for,
1525 * or if we mapped the max number of pages that we have
1528 if (error
< npages
|| buffers
== pipe_buffers
)
1541 static int pipe_to_user(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
1542 struct splice_desc
*sd
)
1544 int n
= copy_page_to_iter(buf
->page
, buf
->offset
, sd
->len
, sd
->u
.data
);
1545 return n
== sd
->len
? n
: -EFAULT
;
1549 * For lack of a better implementation, implement vmsplice() to userspace
1550 * as a simple copy of the pipes pages to the user iov.
1552 static long vmsplice_to_user(struct file
*file
, const struct iovec __user
*uiov
,
1553 unsigned long nr_segs
, unsigned int flags
)
1555 struct pipe_inode_info
*pipe
;
1556 struct splice_desc sd
;
1558 struct iovec iovstack
[UIO_FASTIOV
];
1559 struct iovec
*iov
= iovstack
;
1560 struct iov_iter iter
;
1562 pipe
= get_pipe_info(file
);
1566 ret
= import_iovec(READ
, uiov
, nr_segs
,
1567 ARRAY_SIZE(iovstack
), &iov
, &iter
);
1571 sd
.total_len
= iov_iter_count(&iter
);
1579 ret
= __splice_from_pipe(pipe
, &sd
, pipe_to_user
);
1588 * vmsplice splices a user address range into a pipe. It can be thought of
1589 * as splice-from-memory, where the regular splice is splice-from-file (or
1590 * to file). In both cases the output is a pipe, naturally.
1592 static long vmsplice_to_pipe(struct file
*file
, const struct iovec __user
*iov
,
1593 unsigned long nr_segs
, unsigned int flags
)
1595 struct pipe_inode_info
*pipe
;
1596 struct page
*pages
[PIPE_DEF_BUFFERS
];
1597 struct partial_page partial
[PIPE_DEF_BUFFERS
];
1598 struct splice_pipe_desc spd
= {
1601 .nr_pages_max
= PIPE_DEF_BUFFERS
,
1603 .ops
= &user_page_pipe_buf_ops
,
1604 .spd_release
= spd_release_page
,
1608 pipe
= get_pipe_info(file
);
1612 if (splice_grow_spd(pipe
, &spd
))
1615 spd
.nr_pages
= get_iovec_page_array(iov
, nr_segs
, spd
.pages
,
1618 if (spd
.nr_pages
<= 0)
1621 ret
= splice_to_pipe(pipe
, &spd
);
1623 splice_shrink_spd(&spd
);
1628 * Note that vmsplice only really supports true splicing _from_ user memory
1629 * to a pipe, not the other way around. Splicing from user memory is a simple
1630 * operation that can be supported without any funky alignment restrictions
1631 * or nasty vm tricks. We simply map in the user memory and fill them into
1632 * a pipe. The reverse isn't quite as easy, though. There are two possible
1633 * solutions for that:
1635 * - memcpy() the data internally, at which point we might as well just
1636 * do a regular read() on the buffer anyway.
1637 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1638 * has restriction limitations on both ends of the pipe).
1640 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1643 SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct iovec __user
*, iov
,
1644 unsigned long, nr_segs
, unsigned int, flags
)
1649 if (unlikely(nr_segs
> UIO_MAXIOV
))
1651 else if (unlikely(!nr_segs
))
1657 if (f
.file
->f_mode
& FMODE_WRITE
)
1658 error
= vmsplice_to_pipe(f
.file
, iov
, nr_segs
, flags
);
1659 else if (f
.file
->f_mode
& FMODE_READ
)
1660 error
= vmsplice_to_user(f
.file
, iov
, nr_segs
, flags
);
1668 #ifdef CONFIG_COMPAT
1669 COMPAT_SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct compat_iovec __user
*, iov32
,
1670 unsigned int, nr_segs
, unsigned int, flags
)
1673 struct iovec __user
*iov
;
1674 if (nr_segs
> UIO_MAXIOV
)
1676 iov
= compat_alloc_user_space(nr_segs
* sizeof(struct iovec
));
1677 for (i
= 0; i
< nr_segs
; i
++) {
1678 struct compat_iovec v
;
1679 if (get_user(v
.iov_base
, &iov32
[i
].iov_base
) ||
1680 get_user(v
.iov_len
, &iov32
[i
].iov_len
) ||
1681 put_user(compat_ptr(v
.iov_base
), &iov
[i
].iov_base
) ||
1682 put_user(v
.iov_len
, &iov
[i
].iov_len
))
1685 return sys_vmsplice(fd
, iov
, nr_segs
, flags
);
1689 SYSCALL_DEFINE6(splice
, int, fd_in
, loff_t __user
*, off_in
,
1690 int, fd_out
, loff_t __user
*, off_out
,
1691 size_t, len
, unsigned int, flags
)
1702 if (in
.file
->f_mode
& FMODE_READ
) {
1703 out
= fdget(fd_out
);
1705 if (out
.file
->f_mode
& FMODE_WRITE
)
1706 error
= do_splice(in
.file
, off_in
,
1718 * Make sure there's data to read. Wait for input if we can, otherwise
1719 * return an appropriate error.
1721 static int ipipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1726 * Check ->nrbufs without the inode lock first. This function
1727 * is speculative anyways, so missing one is ok.
1735 while (!pipe
->nrbufs
) {
1736 if (signal_pending(current
)) {
1742 if (!pipe
->waiting_writers
) {
1743 if (flags
& SPLICE_F_NONBLOCK
) {
1756 * Make sure there's writeable room. Wait for room if we can, otherwise
1757 * return an appropriate error.
1759 static int opipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1764 * Check ->nrbufs without the inode lock first. This function
1765 * is speculative anyways, so missing one is ok.
1767 if (pipe
->nrbufs
< pipe
->buffers
)
1773 while (pipe
->nrbufs
>= pipe
->buffers
) {
1774 if (!pipe
->readers
) {
1775 send_sig(SIGPIPE
, current
, 0);
1779 if (flags
& SPLICE_F_NONBLOCK
) {
1783 if (signal_pending(current
)) {
1787 pipe
->waiting_writers
++;
1789 pipe
->waiting_writers
--;
1797 * Splice contents of ipipe to opipe.
1799 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1800 struct pipe_inode_info
*opipe
,
1801 size_t len
, unsigned int flags
)
1803 struct pipe_buffer
*ibuf
, *obuf
;
1805 bool input_wakeup
= false;
1809 ret
= ipipe_prep(ipipe
, flags
);
1813 ret
= opipe_prep(opipe
, flags
);
1818 * Potential ABBA deadlock, work around it by ordering lock
1819 * grabbing by pipe info address. Otherwise two different processes
1820 * could deadlock (one doing tee from A -> B, the other from B -> A).
1822 pipe_double_lock(ipipe
, opipe
);
1825 if (!opipe
->readers
) {
1826 send_sig(SIGPIPE
, current
, 0);
1832 if (!ipipe
->nrbufs
&& !ipipe
->writers
)
1836 * Cannot make any progress, because either the input
1837 * pipe is empty or the output pipe is full.
1839 if (!ipipe
->nrbufs
|| opipe
->nrbufs
>= opipe
->buffers
) {
1840 /* Already processed some buffers, break */
1844 if (flags
& SPLICE_F_NONBLOCK
) {
1850 * We raced with another reader/writer and haven't
1851 * managed to process any buffers. A zero return
1852 * value means EOF, so retry instead.
1859 ibuf
= ipipe
->bufs
+ ipipe
->curbuf
;
1860 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (opipe
->buffers
- 1);
1861 obuf
= opipe
->bufs
+ nbuf
;
1863 if (len
>= ibuf
->len
) {
1865 * Simply move the whole buffer from ipipe to opipe
1870 ipipe
->curbuf
= (ipipe
->curbuf
+ 1) & (ipipe
->buffers
- 1);
1872 input_wakeup
= true;
1875 * Get a reference to this pipe buffer,
1876 * so we can copy the contents over.
1878 ibuf
->ops
->get(ipipe
, ibuf
);
1882 * Don't inherit the gift flag, we need to
1883 * prevent multiple steals of this page.
1885 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1889 ibuf
->offset
+= obuf
->len
;
1890 ibuf
->len
-= obuf
->len
;
1900 * If we put data in the output pipe, wakeup any potential readers.
1903 wakeup_pipe_readers(opipe
);
1906 wakeup_pipe_writers(ipipe
);
1912 * Link contents of ipipe to opipe.
1914 static int link_pipe(struct pipe_inode_info
*ipipe
,
1915 struct pipe_inode_info
*opipe
,
1916 size_t len
, unsigned int flags
)
1918 struct pipe_buffer
*ibuf
, *obuf
;
1919 int ret
= 0, i
= 0, nbuf
;
1922 * Potential ABBA deadlock, work around it by ordering lock
1923 * grabbing by pipe info address. Otherwise two different processes
1924 * could deadlock (one doing tee from A -> B, the other from B -> A).
1926 pipe_double_lock(ipipe
, opipe
);
1929 if (!opipe
->readers
) {
1930 send_sig(SIGPIPE
, current
, 0);
1937 * If we have iterated all input buffers or ran out of
1938 * output room, break.
1940 if (i
>= ipipe
->nrbufs
|| opipe
->nrbufs
>= opipe
->buffers
)
1943 ibuf
= ipipe
->bufs
+ ((ipipe
->curbuf
+ i
) & (ipipe
->buffers
-1));
1944 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (opipe
->buffers
- 1);
1947 * Get a reference to this pipe buffer,
1948 * so we can copy the contents over.
1950 ibuf
->ops
->get(ipipe
, ibuf
);
1952 obuf
= opipe
->bufs
+ nbuf
;
1956 * Don't inherit the gift flag, we need to
1957 * prevent multiple steals of this page.
1959 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1961 if (obuf
->len
> len
)
1971 * return EAGAIN if we have the potential of some data in the
1972 * future, otherwise just return 0
1974 if (!ret
&& ipipe
->waiting_writers
&& (flags
& SPLICE_F_NONBLOCK
))
1981 * If we put data in the output pipe, wakeup any potential readers.
1984 wakeup_pipe_readers(opipe
);
1990 * This is a tee(1) implementation that works on pipes. It doesn't copy
1991 * any data, it simply references the 'in' pages on the 'out' pipe.
1992 * The 'flags' used are the SPLICE_F_* variants, currently the only
1993 * applicable one is SPLICE_F_NONBLOCK.
1995 static long do_tee(struct file
*in
, struct file
*out
, size_t len
,
1998 struct pipe_inode_info
*ipipe
= get_pipe_info(in
);
1999 struct pipe_inode_info
*opipe
= get_pipe_info(out
);
2003 * Duplicate the contents of ipipe to opipe without actually
2006 if (ipipe
&& opipe
&& ipipe
!= opipe
) {
2008 * Keep going, unless we encounter an error. The ipipe/opipe
2009 * ordering doesn't really matter.
2011 ret
= ipipe_prep(ipipe
, flags
);
2013 ret
= opipe_prep(opipe
, flags
);
2015 ret
= link_pipe(ipipe
, opipe
, len
, flags
);
2022 SYSCALL_DEFINE4(tee
, int, fdin
, int, fdout
, size_t, len
, unsigned int, flags
)
2033 if (in
.file
->f_mode
& FMODE_READ
) {
2034 struct fd out
= fdget(fdout
);
2036 if (out
.file
->f_mode
& FMODE_WRITE
)
2037 error
= do_tee(in
.file
, out
.file
,