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/buffer_head.h>
29 #include <linux/module.h>
30 #include <linux/syscalls.h>
31 #include <linux/uio.h>
32 #include <linux/security.h>
33 #include <linux/gfp.h>
36 * Attempt to steal a page from a pipe buffer. This should perhaps go into
37 * a vm helper function, it's already simplified quite a bit by the
38 * addition of remove_mapping(). If success is returned, the caller may
39 * attempt to reuse this page for another destination.
41 static int page_cache_pipe_buf_steal(struct pipe_inode_info
*pipe
,
42 struct pipe_buffer
*buf
)
44 struct page
*page
= buf
->page
;
45 struct address_space
*mapping
;
49 mapping
= page_mapping(page
);
51 WARN_ON(!PageUptodate(page
));
54 * At least for ext2 with nobh option, we need to wait on
55 * writeback completing on this page, since we'll remove it
56 * from the pagecache. Otherwise truncate wont wait on the
57 * page, allowing the disk blocks to be reused by someone else
58 * before we actually wrote our data to them. fs corruption
61 wait_on_page_writeback(page
);
63 if (page_has_private(page
) &&
64 !try_to_release_page(page
, GFP_KERNEL
))
68 * If we succeeded in removing the mapping, set LRU flag
71 if (remove_mapping(mapping
, page
)) {
72 buf
->flags
|= PIPE_BUF_FLAG_LRU
;
78 * Raced with truncate or failed to remove page from current
79 * address space, unlock and return failure.
86 static void page_cache_pipe_buf_release(struct pipe_inode_info
*pipe
,
87 struct pipe_buffer
*buf
)
89 page_cache_release(buf
->page
);
90 buf
->flags
&= ~PIPE_BUF_FLAG_LRU
;
94 * Check whether the contents of buf is OK to access. Since the content
95 * is a page cache page, IO may be in flight.
97 static int page_cache_pipe_buf_confirm(struct pipe_inode_info
*pipe
,
98 struct pipe_buffer
*buf
)
100 struct page
*page
= buf
->page
;
103 if (!PageUptodate(page
)) {
107 * Page got truncated/unhashed. This will cause a 0-byte
108 * splice, if this is the first page.
110 if (!page
->mapping
) {
116 * Uh oh, read-error from disk.
118 if (!PageUptodate(page
)) {
124 * Page is ok afterall, we are done.
135 static const struct pipe_buf_operations page_cache_pipe_buf_ops
= {
137 .map
= generic_pipe_buf_map
,
138 .unmap
= generic_pipe_buf_unmap
,
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 .map
= generic_pipe_buf_map
,
158 .unmap
= generic_pipe_buf_unmap
,
159 .confirm
= generic_pipe_buf_confirm
,
160 .release
= page_cache_pipe_buf_release
,
161 .steal
= user_page_pipe_buf_steal
,
162 .get
= generic_pipe_buf_get
,
166 * splice_to_pipe - fill passed data into a pipe
167 * @pipe: pipe to fill
171 * @spd contains a map of pages and len/offset tuples, along with
172 * the struct pipe_buf_operations associated with these pages. This
173 * function will link that data to the pipe.
176 ssize_t
splice_to_pipe(struct pipe_inode_info
*pipe
,
177 struct splice_pipe_desc
*spd
)
179 unsigned int spd_pages
= spd
->nr_pages
;
180 int ret
, do_wakeup
, page_nr
;
189 if (!pipe
->readers
) {
190 send_sig(SIGPIPE
, current
, 0);
196 if (pipe
->nrbufs
< PIPE_BUFFERS
) {
197 int newbuf
= (pipe
->curbuf
+ pipe
->nrbufs
) & (PIPE_BUFFERS
- 1);
198 struct pipe_buffer
*buf
= pipe
->bufs
+ newbuf
;
200 buf
->page
= spd
->pages
[page_nr
];
201 buf
->offset
= spd
->partial
[page_nr
].offset
;
202 buf
->len
= spd
->partial
[page_nr
].len
;
203 buf
->private = spd
->partial
[page_nr
].private;
205 if (spd
->flags
& SPLICE_F_GIFT
)
206 buf
->flags
|= PIPE_BUF_FLAG_GIFT
;
215 if (!--spd
->nr_pages
)
217 if (pipe
->nrbufs
< PIPE_BUFFERS
)
223 if (spd
->flags
& SPLICE_F_NONBLOCK
) {
229 if (signal_pending(current
)) {
237 if (waitqueue_active(&pipe
->wait
))
238 wake_up_interruptible_sync(&pipe
->wait
);
239 kill_fasync(&pipe
->fasync_readers
, SIGIO
, POLL_IN
);
243 pipe
->waiting_writers
++;
245 pipe
->waiting_writers
--;
252 if (waitqueue_active(&pipe
->wait
))
253 wake_up_interruptible(&pipe
->wait
);
254 kill_fasync(&pipe
->fasync_readers
, SIGIO
, POLL_IN
);
257 while (page_nr
< spd_pages
)
258 spd
->spd_release(spd
, page_nr
++);
263 static void spd_release_page(struct splice_pipe_desc
*spd
, unsigned int i
)
265 page_cache_release(spd
->pages
[i
]);
269 __generic_file_splice_read(struct file
*in
, loff_t
*ppos
,
270 struct pipe_inode_info
*pipe
, size_t len
,
273 struct address_space
*mapping
= in
->f_mapping
;
274 unsigned int loff
, nr_pages
, req_pages
;
275 struct page
*pages
[PIPE_BUFFERS
];
276 struct partial_page partial
[PIPE_BUFFERS
];
278 pgoff_t index
, end_index
;
281 struct splice_pipe_desc spd
= {
285 .ops
= &page_cache_pipe_buf_ops
,
286 .spd_release
= spd_release_page
,
289 index
= *ppos
>> PAGE_CACHE_SHIFT
;
290 loff
= *ppos
& ~PAGE_CACHE_MASK
;
291 req_pages
= (len
+ loff
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
292 nr_pages
= min(req_pages
, (unsigned)PIPE_BUFFERS
);
295 * Lookup the (hopefully) full range of pages we need.
297 spd
.nr_pages
= find_get_pages_contig(mapping
, index
, nr_pages
, pages
);
298 index
+= spd
.nr_pages
;
301 * If find_get_pages_contig() returned fewer pages than we needed,
302 * readahead/allocate the rest and fill in the holes.
304 if (spd
.nr_pages
< nr_pages
)
305 page_cache_sync_readahead(mapping
, &in
->f_ra
, in
,
306 index
, req_pages
- spd
.nr_pages
);
309 while (spd
.nr_pages
< nr_pages
) {
311 * Page could be there, find_get_pages_contig() breaks on
314 page
= find_get_page(mapping
, index
);
317 * page didn't exist, allocate one.
319 page
= page_cache_alloc_cold(mapping
);
323 error
= add_to_page_cache_lru(page
, mapping
, index
,
324 mapping_gfp_mask(mapping
));
325 if (unlikely(error
)) {
326 page_cache_release(page
);
327 if (error
== -EEXIST
)
332 * add_to_page_cache() locks the page, unlock it
333 * to avoid convoluting the logic below even more.
338 pages
[spd
.nr_pages
++] = page
;
343 * Now loop over the map and see if we need to start IO on any
344 * pages, fill in the partial map, etc.
346 index
= *ppos
>> PAGE_CACHE_SHIFT
;
347 nr_pages
= spd
.nr_pages
;
349 for (page_nr
= 0; page_nr
< nr_pages
; page_nr
++) {
350 unsigned int this_len
;
356 * this_len is the max we'll use from this page
358 this_len
= min_t(unsigned long, len
, PAGE_CACHE_SIZE
- loff
);
359 page
= pages
[page_nr
];
361 if (PageReadahead(page
))
362 page_cache_async_readahead(mapping
, &in
->f_ra
, in
,
363 page
, index
, req_pages
- page_nr
);
366 * If the page isn't uptodate, we may need to start io on it
368 if (!PageUptodate(page
)) {
372 * Page was truncated, or invalidated by the
373 * filesystem. Redo the find/create, but this time the
374 * page is kept locked, so there's no chance of another
375 * race with truncate/invalidate.
377 if (!page
->mapping
) {
379 page
= find_or_create_page(mapping
, index
,
380 mapping_gfp_mask(mapping
));
386 page_cache_release(pages
[page_nr
]);
387 pages
[page_nr
] = page
;
390 * page was already under io and is now done, great
392 if (PageUptodate(page
)) {
398 * need to read in the page
400 error
= mapping
->a_ops
->readpage(in
, page
);
401 if (unlikely(error
)) {
403 * We really should re-lookup the page here,
404 * but it complicates things a lot. Instead
405 * lets just do what we already stored, and
406 * we'll get it the next time we are called.
408 if (error
== AOP_TRUNCATED_PAGE
)
416 * i_size must be checked after PageUptodate.
418 isize
= i_size_read(mapping
->host
);
419 end_index
= (isize
- 1) >> PAGE_CACHE_SHIFT
;
420 if (unlikely(!isize
|| index
> end_index
))
424 * if this is the last page, see if we need to shrink
425 * the length and stop
427 if (end_index
== index
) {
431 * max good bytes in this page
433 plen
= ((isize
- 1) & ~PAGE_CACHE_MASK
) + 1;
438 * force quit after adding this page
440 this_len
= min(this_len
, plen
- loff
);
444 partial
[page_nr
].offset
= loff
;
445 partial
[page_nr
].len
= this_len
;
453 * Release any pages at the end, if we quit early. 'page_nr' is how far
454 * we got, 'nr_pages' is how many pages are in the map.
456 while (page_nr
< nr_pages
)
457 page_cache_release(pages
[page_nr
++]);
458 in
->f_ra
.prev_pos
= (loff_t
)index
<< PAGE_CACHE_SHIFT
;
461 return splice_to_pipe(pipe
, &spd
);
467 * generic_file_splice_read - splice data from file to a pipe
468 * @in: file to splice from
469 * @ppos: position in @in
470 * @pipe: pipe to splice to
471 * @len: number of bytes to splice
472 * @flags: splice modifier flags
475 * Will read pages from given file and fill them into a pipe. Can be
476 * used as long as the address_space operations for the source implements
480 ssize_t
generic_file_splice_read(struct file
*in
, loff_t
*ppos
,
481 struct pipe_inode_info
*pipe
, size_t len
,
487 isize
= i_size_read(in
->f_mapping
->host
);
488 if (unlikely(*ppos
>= isize
))
491 left
= isize
- *ppos
;
492 if (unlikely(left
< len
))
495 ret
= __generic_file_splice_read(in
, ppos
, pipe
, len
, flags
);
503 EXPORT_SYMBOL(generic_file_splice_read
);
505 static const struct pipe_buf_operations default_pipe_buf_ops
= {
507 .map
= generic_pipe_buf_map
,
508 .unmap
= generic_pipe_buf_unmap
,
509 .confirm
= generic_pipe_buf_confirm
,
510 .release
= generic_pipe_buf_release
,
511 .steal
= generic_pipe_buf_steal
,
512 .get
= generic_pipe_buf_get
,
515 static ssize_t
kernel_readv(struct file
*file
, const struct iovec
*vec
,
516 unsigned long vlen
, loff_t offset
)
524 /* The cast to a user pointer is valid due to the set_fs() */
525 res
= vfs_readv(file
, (const struct iovec __user
*)vec
, vlen
, &pos
);
531 static ssize_t
kernel_write(struct file
*file
, const char *buf
, size_t count
,
539 /* The cast to a user pointer is valid due to the set_fs() */
540 res
= vfs_write(file
, (const char __user
*)buf
, count
, &pos
);
546 ssize_t
default_file_splice_read(struct file
*in
, loff_t
*ppos
,
547 struct pipe_inode_info
*pipe
, size_t len
,
550 unsigned int nr_pages
;
551 unsigned int nr_freed
;
553 struct page
*pages
[PIPE_BUFFERS
];
554 struct partial_page partial
[PIPE_BUFFERS
];
555 struct iovec vec
[PIPE_BUFFERS
];
561 struct splice_pipe_desc spd
= {
565 .ops
= &default_pipe_buf_ops
,
566 .spd_release
= spd_release_page
,
569 index
= *ppos
>> PAGE_CACHE_SHIFT
;
570 offset
= *ppos
& ~PAGE_CACHE_MASK
;
571 nr_pages
= (len
+ offset
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
573 for (i
= 0; i
< nr_pages
&& i
< PIPE_BUFFERS
&& len
; i
++) {
576 page
= alloc_page(GFP_USER
);
581 this_len
= min_t(size_t, len
, PAGE_CACHE_SIZE
- offset
);
582 vec
[i
].iov_base
= (void __user
*) page_address(page
);
583 vec
[i
].iov_len
= this_len
;
590 res
= kernel_readv(in
, vec
, spd
.nr_pages
, *ppos
);
601 for (i
= 0; i
< spd
.nr_pages
; i
++) {
602 this_len
= min_t(size_t, vec
[i
].iov_len
, res
);
603 partial
[i
].offset
= 0;
604 partial
[i
].len
= this_len
;
606 __free_page(pages
[i
]);
612 spd
.nr_pages
-= nr_freed
;
614 res
= splice_to_pipe(pipe
, &spd
);
621 for (i
= 0; i
< spd
.nr_pages
; i
++)
622 __free_page(pages
[i
]);
626 EXPORT_SYMBOL(default_file_splice_read
);
629 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
630 * using sendpage(). Return the number of bytes sent.
632 static int pipe_to_sendpage(struct pipe_inode_info
*pipe
,
633 struct pipe_buffer
*buf
, struct splice_desc
*sd
)
635 struct file
*file
= sd
->u
.file
;
636 loff_t pos
= sd
->pos
;
639 ret
= buf
->ops
->confirm(pipe
, buf
);
641 more
= (sd
->flags
& SPLICE_F_MORE
) || sd
->len
< sd
->total_len
;
642 if (file
->f_op
&& file
->f_op
->sendpage
)
643 ret
= file
->f_op
->sendpage(file
, buf
->page
, buf
->offset
,
644 sd
->len
, &pos
, more
);
653 * This is a little more tricky than the file -> pipe splicing. There are
654 * basically three cases:
656 * - Destination page already exists in the address space and there
657 * are users of it. For that case we have no other option that
658 * copying the data. Tough luck.
659 * - Destination page already exists in the address space, but there
660 * are no users of it. Make sure it's uptodate, then drop it. Fall
661 * through to last case.
662 * - Destination page does not exist, we can add the pipe page to
663 * the page cache and avoid the copy.
665 * If asked to move pages to the output file (SPLICE_F_MOVE is set in
666 * sd->flags), we attempt to migrate pages from the pipe to the output
667 * file address space page cache. This is possible if no one else has
668 * the pipe page referenced outside of the pipe and page cache. If
669 * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create
670 * a new page in the output file page cache and fill/dirty that.
672 int pipe_to_file(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
673 struct splice_desc
*sd
)
675 struct file
*file
= sd
->u
.file
;
676 struct address_space
*mapping
= file
->f_mapping
;
677 unsigned int offset
, this_len
;
683 * make sure the data in this buffer is uptodate
685 ret
= buf
->ops
->confirm(pipe
, buf
);
689 offset
= sd
->pos
& ~PAGE_CACHE_MASK
;
692 if (this_len
+ offset
> PAGE_CACHE_SIZE
)
693 this_len
= PAGE_CACHE_SIZE
- offset
;
695 ret
= pagecache_write_begin(file
, mapping
, sd
->pos
, this_len
,
696 AOP_FLAG_UNINTERRUPTIBLE
, &page
, &fsdata
);
700 if (buf
->page
!= page
) {
702 * Careful, ->map() uses KM_USER0!
704 char *src
= buf
->ops
->map(pipe
, buf
, 1);
705 char *dst
= kmap_atomic(page
, KM_USER1
);
707 memcpy(dst
+ offset
, src
+ buf
->offset
, this_len
);
708 flush_dcache_page(page
);
709 kunmap_atomic(dst
, KM_USER1
);
710 buf
->ops
->unmap(pipe
, buf
, src
);
712 ret
= pagecache_write_end(file
, mapping
, sd
->pos
, this_len
, this_len
,
717 EXPORT_SYMBOL(pipe_to_file
);
719 static void wakeup_pipe_writers(struct pipe_inode_info
*pipe
)
722 if (waitqueue_active(&pipe
->wait
))
723 wake_up_interruptible(&pipe
->wait
);
724 kill_fasync(&pipe
->fasync_writers
, SIGIO
, POLL_OUT
);
728 * splice_from_pipe_feed - feed available data from a pipe to a file
729 * @pipe: pipe to splice from
730 * @sd: information to @actor
731 * @actor: handler that splices the data
734 * This function loops over the pipe and calls @actor to do the
735 * actual moving of a single struct pipe_buffer to the desired
736 * destination. It returns when there's no more buffers left in
737 * the pipe or if the requested number of bytes (@sd->total_len)
738 * have been copied. It returns a positive number (one) if the
739 * pipe needs to be filled with more data, zero if the required
740 * number of bytes have been copied and -errno on error.
742 * This, together with splice_from_pipe_{begin,end,next}, may be
743 * used to implement the functionality of __splice_from_pipe() when
744 * locking is required around copying the pipe buffers to the
747 int splice_from_pipe_feed(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
752 while (pipe
->nrbufs
) {
753 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
754 const struct pipe_buf_operations
*ops
= buf
->ops
;
757 if (sd
->len
> sd
->total_len
)
758 sd
->len
= sd
->total_len
;
760 ret
= actor(pipe
, buf
, sd
);
769 sd
->num_spliced
+= ret
;
772 sd
->total_len
-= ret
;
776 ops
->release(pipe
, buf
);
777 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (PIPE_BUFFERS
- 1);
780 sd
->need_wakeup
= true;
789 EXPORT_SYMBOL(splice_from_pipe_feed
);
792 * splice_from_pipe_next - wait for some data to splice from
793 * @pipe: pipe to splice from
794 * @sd: information about the splice operation
797 * This function will wait for some data and return a positive
798 * value (one) if pipe buffers are available. It will return zero
799 * or -errno if no more data needs to be spliced.
801 int splice_from_pipe_next(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
803 while (!pipe
->nrbufs
) {
807 if (!pipe
->waiting_writers
&& sd
->num_spliced
)
810 if (sd
->flags
& SPLICE_F_NONBLOCK
)
813 if (signal_pending(current
))
816 if (sd
->need_wakeup
) {
817 wakeup_pipe_writers(pipe
);
818 sd
->need_wakeup
= false;
826 EXPORT_SYMBOL(splice_from_pipe_next
);
829 * splice_from_pipe_begin - start splicing from pipe
830 * @sd: information about the splice operation
833 * This function should be called before a loop containing
834 * splice_from_pipe_next() and splice_from_pipe_feed() to
835 * initialize the necessary fields of @sd.
837 void splice_from_pipe_begin(struct splice_desc
*sd
)
840 sd
->need_wakeup
= false;
842 EXPORT_SYMBOL(splice_from_pipe_begin
);
845 * splice_from_pipe_end - finish splicing from pipe
846 * @pipe: pipe to splice from
847 * @sd: information about the splice operation
850 * This function will wake up pipe writers if necessary. It should
851 * be called after a loop containing splice_from_pipe_next() and
852 * splice_from_pipe_feed().
854 void splice_from_pipe_end(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
)
857 wakeup_pipe_writers(pipe
);
859 EXPORT_SYMBOL(splice_from_pipe_end
);
862 * __splice_from_pipe - splice data from a pipe to given actor
863 * @pipe: pipe to splice from
864 * @sd: information to @actor
865 * @actor: handler that splices the data
868 * This function does little more than loop over the pipe and call
869 * @actor to do the actual moving of a single struct pipe_buffer to
870 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
874 ssize_t
__splice_from_pipe(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
879 splice_from_pipe_begin(sd
);
881 ret
= splice_from_pipe_next(pipe
, sd
);
883 ret
= splice_from_pipe_feed(pipe
, sd
, actor
);
885 splice_from_pipe_end(pipe
, sd
);
887 return sd
->num_spliced
? sd
->num_spliced
: ret
;
889 EXPORT_SYMBOL(__splice_from_pipe
);
892 * splice_from_pipe - splice data from a pipe to a file
893 * @pipe: pipe to splice from
894 * @out: file to splice to
895 * @ppos: position in @out
896 * @len: how many bytes to splice
897 * @flags: splice modifier flags
898 * @actor: handler that splices the data
901 * See __splice_from_pipe. This function locks the pipe inode,
902 * otherwise it's identical to __splice_from_pipe().
905 ssize_t
splice_from_pipe(struct pipe_inode_info
*pipe
, struct file
*out
,
906 loff_t
*ppos
, size_t len
, unsigned int flags
,
910 struct splice_desc sd
= {
918 ret
= __splice_from_pipe(pipe
, &sd
, actor
);
925 * generic_file_splice_write - splice data from a pipe to a file
927 * @out: file to write to
928 * @ppos: position in @out
929 * @len: number of bytes to splice
930 * @flags: splice modifier flags
933 * Will either move or copy pages (determined by @flags options) from
934 * the given pipe inode to the given file.
938 generic_file_splice_write(struct pipe_inode_info
*pipe
, struct file
*out
,
939 loff_t
*ppos
, size_t len
, unsigned int flags
)
941 struct address_space
*mapping
= out
->f_mapping
;
942 struct inode
*inode
= mapping
->host
;
943 struct splice_desc sd
= {
953 splice_from_pipe_begin(&sd
);
955 ret
= splice_from_pipe_next(pipe
, &sd
);
959 mutex_lock_nested(&inode
->i_mutex
, I_MUTEX_CHILD
);
960 ret
= file_remove_suid(out
);
962 file_update_time(out
);
963 ret
= splice_from_pipe_feed(pipe
, &sd
, pipe_to_file
);
965 mutex_unlock(&inode
->i_mutex
);
967 splice_from_pipe_end(pipe
, &sd
);
972 ret
= sd
.num_spliced
;
975 unsigned long nr_pages
;
978 nr_pages
= (ret
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
980 err
= generic_write_sync(out
, *ppos
, ret
);
985 balance_dirty_pages_ratelimited_nr(mapping
, nr_pages
);
991 EXPORT_SYMBOL(generic_file_splice_write
);
993 static int write_pipe_buf(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
994 struct splice_desc
*sd
)
999 ret
= buf
->ops
->confirm(pipe
, buf
);
1003 data
= buf
->ops
->map(pipe
, buf
, 0);
1004 ret
= kernel_write(sd
->u
.file
, data
+ buf
->offset
, sd
->len
, sd
->pos
);
1005 buf
->ops
->unmap(pipe
, buf
, data
);
1010 static ssize_t
default_file_splice_write(struct pipe_inode_info
*pipe
,
1011 struct file
*out
, loff_t
*ppos
,
1012 size_t len
, unsigned int flags
)
1016 ret
= splice_from_pipe(pipe
, out
, ppos
, len
, flags
, write_pipe_buf
);
1024 * generic_splice_sendpage - splice data from a pipe to a socket
1025 * @pipe: pipe to splice from
1026 * @out: socket to write to
1027 * @ppos: position in @out
1028 * @len: number of bytes to splice
1029 * @flags: splice modifier flags
1032 * Will send @len bytes from the pipe to a network socket. No data copying
1036 ssize_t
generic_splice_sendpage(struct pipe_inode_info
*pipe
, struct file
*out
,
1037 loff_t
*ppos
, size_t len
, unsigned int flags
)
1039 return splice_from_pipe(pipe
, out
, ppos
, len
, flags
, pipe_to_sendpage
);
1042 EXPORT_SYMBOL(generic_splice_sendpage
);
1045 * Attempt to initiate a splice from pipe to file.
1047 static long do_splice_from(struct pipe_inode_info
*pipe
, struct file
*out
,
1048 loff_t
*ppos
, size_t len
, unsigned int flags
)
1050 ssize_t (*splice_write
)(struct pipe_inode_info
*, struct file
*,
1051 loff_t
*, size_t, unsigned int);
1054 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
1057 if (unlikely(out
->f_flags
& O_APPEND
))
1060 ret
= rw_verify_area(WRITE
, out
, ppos
, len
);
1061 if (unlikely(ret
< 0))
1064 if (out
->f_op
&& out
->f_op
->splice_write
)
1065 splice_write
= out
->f_op
->splice_write
;
1067 splice_write
= default_file_splice_write
;
1069 return splice_write(pipe
, out
, ppos
, len
, flags
);
1073 * Attempt to initiate a splice from a file to a pipe.
1075 static long do_splice_to(struct file
*in
, loff_t
*ppos
,
1076 struct pipe_inode_info
*pipe
, size_t len
,
1079 ssize_t (*splice_read
)(struct file
*, loff_t
*,
1080 struct pipe_inode_info
*, size_t, unsigned int);
1083 if (unlikely(!(in
->f_mode
& FMODE_READ
)))
1086 ret
= rw_verify_area(READ
, in
, ppos
, len
);
1087 if (unlikely(ret
< 0))
1090 if (in
->f_op
&& in
->f_op
->splice_read
)
1091 splice_read
= in
->f_op
->splice_read
;
1093 splice_read
= default_file_splice_read
;
1095 return splice_read(in
, ppos
, pipe
, len
, flags
);
1099 * splice_direct_to_actor - splices data directly between two non-pipes
1100 * @in: file to splice from
1101 * @sd: actor information on where to splice to
1102 * @actor: handles the data splicing
1105 * This is a special case helper to splice directly between two
1106 * points, without requiring an explicit pipe. Internally an allocated
1107 * pipe is cached in the process, and reused during the lifetime of
1111 ssize_t
splice_direct_to_actor(struct file
*in
, struct splice_desc
*sd
,
1112 splice_direct_actor
*actor
)
1114 struct pipe_inode_info
*pipe
;
1121 * We require the input being a regular file, as we don't want to
1122 * randomly drop data for eg socket -> socket splicing. Use the
1123 * piped splicing for that!
1125 i_mode
= in
->f_path
.dentry
->d_inode
->i_mode
;
1126 if (unlikely(!S_ISREG(i_mode
) && !S_ISBLK(i_mode
)))
1130 * neither in nor out is a pipe, setup an internal pipe attached to
1131 * 'out' and transfer the wanted data from 'in' to 'out' through that
1133 pipe
= current
->splice_pipe
;
1134 if (unlikely(!pipe
)) {
1135 pipe
= alloc_pipe_info(NULL
);
1140 * We don't have an immediate reader, but we'll read the stuff
1141 * out of the pipe right after the splice_to_pipe(). So set
1142 * PIPE_READERS appropriately.
1146 current
->splice_pipe
= pipe
;
1154 len
= sd
->total_len
;
1158 * Don't block on output, we have to drain the direct pipe.
1160 sd
->flags
&= ~SPLICE_F_NONBLOCK
;
1164 loff_t pos
= sd
->pos
, prev_pos
= pos
;
1166 ret
= do_splice_to(in
, &pos
, pipe
, len
, flags
);
1167 if (unlikely(ret
<= 0))
1171 sd
->total_len
= read_len
;
1174 * NOTE: nonblocking mode only applies to the input. We
1175 * must not do the output in nonblocking mode as then we
1176 * could get stuck data in the internal pipe:
1178 ret
= actor(pipe
, sd
);
1179 if (unlikely(ret
<= 0)) {
1188 if (ret
< read_len
) {
1189 sd
->pos
= prev_pos
+ ret
;
1195 pipe
->nrbufs
= pipe
->curbuf
= 0;
1201 * If we did an incomplete transfer we must release
1202 * the pipe buffers in question:
1204 for (i
= 0; i
< PIPE_BUFFERS
; i
++) {
1205 struct pipe_buffer
*buf
= pipe
->bufs
+ i
;
1208 buf
->ops
->release(pipe
, buf
);
1218 EXPORT_SYMBOL(splice_direct_to_actor
);
1220 static int direct_splice_actor(struct pipe_inode_info
*pipe
,
1221 struct splice_desc
*sd
)
1223 struct file
*file
= sd
->u
.file
;
1225 return do_splice_from(pipe
, file
, &file
->f_pos
, sd
->total_len
,
1230 * do_splice_direct - splices data directly between two files
1231 * @in: file to splice from
1232 * @ppos: input file offset
1233 * @out: file to splice to
1234 * @len: number of bytes to splice
1235 * @flags: splice modifier flags
1238 * For use by do_sendfile(). splice can easily emulate sendfile, but
1239 * doing it in the application would incur an extra system call
1240 * (splice in + splice out, as compared to just sendfile()). So this helper
1241 * can splice directly through a process-private pipe.
1244 long do_splice_direct(struct file
*in
, loff_t
*ppos
, struct file
*out
,
1245 size_t len
, unsigned int flags
)
1247 struct splice_desc sd
= {
1256 ret
= splice_direct_to_actor(in
, &sd
, direct_splice_actor
);
1263 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1264 struct pipe_inode_info
*opipe
,
1265 size_t len
, unsigned int flags
);
1267 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
1268 * location, so checking ->i_pipe is not enough to verify that this is a
1271 static inline struct pipe_inode_info
*pipe_info(struct inode
*inode
)
1273 if (S_ISFIFO(inode
->i_mode
))
1274 return inode
->i_pipe
;
1280 * Determine where to splice to/from.
1282 static long do_splice(struct file
*in
, loff_t __user
*off_in
,
1283 struct file
*out
, loff_t __user
*off_out
,
1284 size_t len
, unsigned int flags
)
1286 struct pipe_inode_info
*ipipe
;
1287 struct pipe_inode_info
*opipe
;
1288 loff_t offset
, *off
;
1291 ipipe
= pipe_info(in
->f_path
.dentry
->d_inode
);
1292 opipe
= pipe_info(out
->f_path
.dentry
->d_inode
);
1294 if (ipipe
&& opipe
) {
1295 if (off_in
|| off_out
)
1298 if (!(in
->f_mode
& FMODE_READ
))
1301 if (!(out
->f_mode
& FMODE_WRITE
))
1304 /* Splicing to self would be fun, but... */
1308 return splice_pipe_to_pipe(ipipe
, opipe
, len
, flags
);
1315 if (!(out
->f_mode
& FMODE_PWRITE
))
1317 if (copy_from_user(&offset
, off_out
, sizeof(loff_t
)))
1323 ret
= do_splice_from(ipipe
, out
, off
, len
, flags
);
1325 if (off_out
&& copy_to_user(off_out
, off
, sizeof(loff_t
)))
1335 if (!(in
->f_mode
& FMODE_PREAD
))
1337 if (copy_from_user(&offset
, off_in
, sizeof(loff_t
)))
1343 ret
= do_splice_to(in
, off
, opipe
, len
, flags
);
1345 if (off_in
&& copy_to_user(off_in
, off
, sizeof(loff_t
)))
1355 * Map an iov into an array of pages and offset/length tupples. With the
1356 * partial_page structure, we can map several non-contiguous ranges into
1357 * our ones pages[] map instead of splitting that operation into pieces.
1358 * Could easily be exported as a generic helper for other users, in which
1359 * case one would probably want to add a 'max_nr_pages' parameter as well.
1361 static int get_iovec_page_array(const struct iovec __user
*iov
,
1362 unsigned int nr_vecs
, struct page
**pages
,
1363 struct partial_page
*partial
, int aligned
)
1365 int buffers
= 0, error
= 0;
1368 unsigned long off
, npages
;
1375 if (copy_from_user(&entry
, iov
, sizeof(entry
)))
1378 base
= entry
.iov_base
;
1379 len
= entry
.iov_len
;
1382 * Sanity check this iovec. 0 read succeeds.
1388 if (!access_ok(VERIFY_READ
, base
, len
))
1392 * Get this base offset and number of pages, then map
1393 * in the user pages.
1395 off
= (unsigned long) base
& ~PAGE_MASK
;
1398 * If asked for alignment, the offset must be zero and the
1399 * length a multiple of the PAGE_SIZE.
1402 if (aligned
&& (off
|| len
& ~PAGE_MASK
))
1405 npages
= (off
+ len
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
1406 if (npages
> PIPE_BUFFERS
- buffers
)
1407 npages
= PIPE_BUFFERS
- buffers
;
1409 error
= get_user_pages_fast((unsigned long)base
, npages
,
1410 0, &pages
[buffers
]);
1412 if (unlikely(error
<= 0))
1416 * Fill this contiguous range into the partial page map.
1418 for (i
= 0; i
< error
; i
++) {
1419 const int plen
= min_t(size_t, len
, PAGE_SIZE
- off
);
1421 partial
[buffers
].offset
= off
;
1422 partial
[buffers
].len
= plen
;
1430 * We didn't complete this iov, stop here since it probably
1431 * means we have to move some of this into a pipe to
1432 * be able to continue.
1438 * Don't continue if we mapped fewer pages than we asked for,
1439 * or if we mapped the max number of pages that we have
1442 if (error
< npages
|| buffers
== PIPE_BUFFERS
)
1455 static int pipe_to_user(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
1456 struct splice_desc
*sd
)
1461 ret
= buf
->ops
->confirm(pipe
, buf
);
1466 * See if we can use the atomic maps, by prefaulting in the
1467 * pages and doing an atomic copy
1469 if (!fault_in_pages_writeable(sd
->u
.userptr
, sd
->len
)) {
1470 src
= buf
->ops
->map(pipe
, buf
, 1);
1471 ret
= __copy_to_user_inatomic(sd
->u
.userptr
, src
+ buf
->offset
,
1473 buf
->ops
->unmap(pipe
, buf
, src
);
1481 * No dice, use slow non-atomic map and copy
1483 src
= buf
->ops
->map(pipe
, buf
, 0);
1486 if (copy_to_user(sd
->u
.userptr
, src
+ buf
->offset
, sd
->len
))
1489 buf
->ops
->unmap(pipe
, buf
, src
);
1492 sd
->u
.userptr
+= ret
;
1497 * For lack of a better implementation, implement vmsplice() to userspace
1498 * as a simple copy of the pipes pages to the user iov.
1500 static long vmsplice_to_user(struct file
*file
, const struct iovec __user
*iov
,
1501 unsigned long nr_segs
, unsigned int flags
)
1503 struct pipe_inode_info
*pipe
;
1504 struct splice_desc sd
;
1509 pipe
= pipe_info(file
->f_path
.dentry
->d_inode
);
1521 * Get user address base and length for this iovec.
1523 error
= get_user(base
, &iov
->iov_base
);
1524 if (unlikely(error
))
1526 error
= get_user(len
, &iov
->iov_len
);
1527 if (unlikely(error
))
1531 * Sanity check this iovec. 0 read succeeds.
1535 if (unlikely(!base
)) {
1540 if (unlikely(!access_ok(VERIFY_WRITE
, base
, len
))) {
1548 sd
.u
.userptr
= base
;
1551 size
= __splice_from_pipe(pipe
, &sd
, pipe_to_user
);
1577 * vmsplice splices a user address range into a pipe. It can be thought of
1578 * as splice-from-memory, where the regular splice is splice-from-file (or
1579 * to file). In both cases the output is a pipe, naturally.
1581 static long vmsplice_to_pipe(struct file
*file
, const struct iovec __user
*iov
,
1582 unsigned long nr_segs
, unsigned int flags
)
1584 struct pipe_inode_info
*pipe
;
1585 struct page
*pages
[PIPE_BUFFERS
];
1586 struct partial_page partial
[PIPE_BUFFERS
];
1587 struct splice_pipe_desc spd
= {
1591 .ops
= &user_page_pipe_buf_ops
,
1592 .spd_release
= spd_release_page
,
1595 pipe
= pipe_info(file
->f_path
.dentry
->d_inode
);
1599 spd
.nr_pages
= get_iovec_page_array(iov
, nr_segs
, pages
, partial
,
1600 flags
& SPLICE_F_GIFT
);
1601 if (spd
.nr_pages
<= 0)
1602 return spd
.nr_pages
;
1604 return splice_to_pipe(pipe
, &spd
);
1608 * Note that vmsplice only really supports true splicing _from_ user memory
1609 * to a pipe, not the other way around. Splicing from user memory is a simple
1610 * operation that can be supported without any funky alignment restrictions
1611 * or nasty vm tricks. We simply map in the user memory and fill them into
1612 * a pipe. The reverse isn't quite as easy, though. There are two possible
1613 * solutions for that:
1615 * - memcpy() the data internally, at which point we might as well just
1616 * do a regular read() on the buffer anyway.
1617 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1618 * has restriction limitations on both ends of the pipe).
1620 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1623 SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct iovec __user
*, iov
,
1624 unsigned long, nr_segs
, unsigned int, flags
)
1630 if (unlikely(nr_segs
> UIO_MAXIOV
))
1632 else if (unlikely(!nr_segs
))
1636 file
= fget_light(fd
, &fput
);
1638 if (file
->f_mode
& FMODE_WRITE
)
1639 error
= vmsplice_to_pipe(file
, iov
, nr_segs
, flags
);
1640 else if (file
->f_mode
& FMODE_READ
)
1641 error
= vmsplice_to_user(file
, iov
, nr_segs
, flags
);
1643 fput_light(file
, fput
);
1649 SYSCALL_DEFINE6(splice
, int, fd_in
, loff_t __user
*, off_in
,
1650 int, fd_out
, loff_t __user
*, off_out
,
1651 size_t, len
, unsigned int, flags
)
1654 struct file
*in
, *out
;
1655 int fput_in
, fput_out
;
1661 in
= fget_light(fd_in
, &fput_in
);
1663 if (in
->f_mode
& FMODE_READ
) {
1664 out
= fget_light(fd_out
, &fput_out
);
1666 if (out
->f_mode
& FMODE_WRITE
)
1667 error
= do_splice(in
, off_in
,
1670 fput_light(out
, fput_out
);
1674 fput_light(in
, fput_in
);
1681 * Make sure there's data to read. Wait for input if we can, otherwise
1682 * return an appropriate error.
1684 static int ipipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1689 * Check ->nrbufs without the inode lock first. This function
1690 * is speculative anyways, so missing one is ok.
1698 while (!pipe
->nrbufs
) {
1699 if (signal_pending(current
)) {
1705 if (!pipe
->waiting_writers
) {
1706 if (flags
& SPLICE_F_NONBLOCK
) {
1719 * Make sure there's writeable room. Wait for room if we can, otherwise
1720 * return an appropriate error.
1722 static int opipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1727 * Check ->nrbufs without the inode lock first. This function
1728 * is speculative anyways, so missing one is ok.
1730 if (pipe
->nrbufs
< PIPE_BUFFERS
)
1736 while (pipe
->nrbufs
>= PIPE_BUFFERS
) {
1737 if (!pipe
->readers
) {
1738 send_sig(SIGPIPE
, current
, 0);
1742 if (flags
& SPLICE_F_NONBLOCK
) {
1746 if (signal_pending(current
)) {
1750 pipe
->waiting_writers
++;
1752 pipe
->waiting_writers
--;
1760 * Splice contents of ipipe to opipe.
1762 static int splice_pipe_to_pipe(struct pipe_inode_info
*ipipe
,
1763 struct pipe_inode_info
*opipe
,
1764 size_t len
, unsigned int flags
)
1766 struct pipe_buffer
*ibuf
, *obuf
;
1768 bool input_wakeup
= false;
1772 ret
= ipipe_prep(ipipe
, flags
);
1776 ret
= opipe_prep(opipe
, flags
);
1781 * Potential ABBA deadlock, work around it by ordering lock
1782 * grabbing by pipe info address. Otherwise two different processes
1783 * could deadlock (one doing tee from A -> B, the other from B -> A).
1785 pipe_double_lock(ipipe
, opipe
);
1788 if (!opipe
->readers
) {
1789 send_sig(SIGPIPE
, current
, 0);
1795 if (!ipipe
->nrbufs
&& !ipipe
->writers
)
1799 * Cannot make any progress, because either the input
1800 * pipe is empty or the output pipe is full.
1802 if (!ipipe
->nrbufs
|| opipe
->nrbufs
>= PIPE_BUFFERS
) {
1803 /* Already processed some buffers, break */
1807 if (flags
& SPLICE_F_NONBLOCK
) {
1813 * We raced with another reader/writer and haven't
1814 * managed to process any buffers. A zero return
1815 * value means EOF, so retry instead.
1822 ibuf
= ipipe
->bufs
+ ipipe
->curbuf
;
1823 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) % PIPE_BUFFERS
;
1824 obuf
= opipe
->bufs
+ nbuf
;
1826 if (len
>= ibuf
->len
) {
1828 * Simply move the whole buffer from ipipe to opipe
1833 ipipe
->curbuf
= (ipipe
->curbuf
+ 1) % PIPE_BUFFERS
;
1835 input_wakeup
= true;
1838 * Get a reference to this pipe buffer,
1839 * so we can copy the contents over.
1841 ibuf
->ops
->get(ipipe
, ibuf
);
1845 * Don't inherit the gift flag, we need to
1846 * prevent multiple steals of this page.
1848 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1852 ibuf
->offset
+= obuf
->len
;
1853 ibuf
->len
-= obuf
->len
;
1863 * If we put data in the output pipe, wakeup any potential readers.
1867 if (waitqueue_active(&opipe
->wait
))
1868 wake_up_interruptible(&opipe
->wait
);
1869 kill_fasync(&opipe
->fasync_readers
, SIGIO
, POLL_IN
);
1872 wakeup_pipe_writers(ipipe
);
1878 * Link contents of ipipe to opipe.
1880 static int link_pipe(struct pipe_inode_info
*ipipe
,
1881 struct pipe_inode_info
*opipe
,
1882 size_t len
, unsigned int flags
)
1884 struct pipe_buffer
*ibuf
, *obuf
;
1885 int ret
= 0, i
= 0, nbuf
;
1888 * Potential ABBA deadlock, work around it by ordering lock
1889 * grabbing by pipe info address. Otherwise two different processes
1890 * could deadlock (one doing tee from A -> B, the other from B -> A).
1892 pipe_double_lock(ipipe
, opipe
);
1895 if (!opipe
->readers
) {
1896 send_sig(SIGPIPE
, current
, 0);
1903 * If we have iterated all input buffers or ran out of
1904 * output room, break.
1906 if (i
>= ipipe
->nrbufs
|| opipe
->nrbufs
>= PIPE_BUFFERS
)
1909 ibuf
= ipipe
->bufs
+ ((ipipe
->curbuf
+ i
) & (PIPE_BUFFERS
- 1));
1910 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (PIPE_BUFFERS
- 1);
1913 * Get a reference to this pipe buffer,
1914 * so we can copy the contents over.
1916 ibuf
->ops
->get(ipipe
, ibuf
);
1918 obuf
= opipe
->bufs
+ nbuf
;
1922 * Don't inherit the gift flag, we need to
1923 * prevent multiple steals of this page.
1925 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1927 if (obuf
->len
> len
)
1937 * return EAGAIN if we have the potential of some data in the
1938 * future, otherwise just return 0
1940 if (!ret
&& ipipe
->waiting_writers
&& (flags
& SPLICE_F_NONBLOCK
))
1947 * If we put data in the output pipe, wakeup any potential readers.
1951 if (waitqueue_active(&opipe
->wait
))
1952 wake_up_interruptible(&opipe
->wait
);
1953 kill_fasync(&opipe
->fasync_readers
, SIGIO
, POLL_IN
);
1960 * This is a tee(1) implementation that works on pipes. It doesn't copy
1961 * any data, it simply references the 'in' pages on the 'out' pipe.
1962 * The 'flags' used are the SPLICE_F_* variants, currently the only
1963 * applicable one is SPLICE_F_NONBLOCK.
1965 static long do_tee(struct file
*in
, struct file
*out
, size_t len
,
1968 struct pipe_inode_info
*ipipe
= pipe_info(in
->f_path
.dentry
->d_inode
);
1969 struct pipe_inode_info
*opipe
= pipe_info(out
->f_path
.dentry
->d_inode
);
1973 * Duplicate the contents of ipipe to opipe without actually
1976 if (ipipe
&& opipe
&& ipipe
!= opipe
) {
1978 * Keep going, unless we encounter an error. The ipipe/opipe
1979 * ordering doesn't really matter.
1981 ret
= ipipe_prep(ipipe
, flags
);
1983 ret
= opipe_prep(opipe
, flags
);
1985 ret
= link_pipe(ipipe
, opipe
, len
, flags
);
1992 SYSCALL_DEFINE4(tee
, int, fdin
, int, fdout
, size_t, len
, unsigned int, flags
)
2001 in
= fget_light(fdin
, &fput_in
);
2003 if (in
->f_mode
& FMODE_READ
) {
2005 struct file
*out
= fget_light(fdout
, &fput_out
);
2008 if (out
->f_mode
& FMODE_WRITE
)
2009 error
= do_tee(in
, out
, len
, flags
);
2010 fput_light(out
, fput_out
);
2013 fput_light(in
, fput_in
);