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/mm_inline.h>
25 #include <linux/swap.h>
26 #include <linux/writeback.h>
27 #include <linux/buffer_head.h>
28 #include <linux/module.h>
29 #include <linux/syscalls.h>
30 #include <linux/uio.h>
31 #include <linux/security.h>
34 * Attempt to steal a page from a pipe buffer. This should perhaps go into
35 * a vm helper function, it's already simplified quite a bit by the
36 * addition of remove_mapping(). If success is returned, the caller may
37 * attempt to reuse this page for another destination.
39 static int page_cache_pipe_buf_steal(struct pipe_inode_info
*pipe
,
40 struct pipe_buffer
*buf
)
42 struct page
*page
= buf
->page
;
43 struct address_space
*mapping
;
47 mapping
= page_mapping(page
);
49 WARN_ON(!PageUptodate(page
));
52 * At least for ext2 with nobh option, we need to wait on
53 * writeback completing on this page, since we'll remove it
54 * from the pagecache. Otherwise truncate wont wait on the
55 * page, allowing the disk blocks to be reused by someone else
56 * before we actually wrote our data to them. fs corruption
59 wait_on_page_writeback(page
);
61 if (PagePrivate(page
) && !try_to_release_page(page
, GFP_KERNEL
))
65 * If we succeeded in removing the mapping, set LRU flag
68 if (remove_mapping(mapping
, page
)) {
69 buf
->flags
|= PIPE_BUF_FLAG_LRU
;
75 * Raced with truncate or failed to remove page from current
76 * address space, unlock and return failure.
83 static void page_cache_pipe_buf_release(struct pipe_inode_info
*pipe
,
84 struct pipe_buffer
*buf
)
86 page_cache_release(buf
->page
);
87 buf
->flags
&= ~PIPE_BUF_FLAG_LRU
;
91 * Check whether the contents of buf is OK to access. Since the content
92 * is a page cache page, IO may be in flight.
94 static int page_cache_pipe_buf_confirm(struct pipe_inode_info
*pipe
,
95 struct pipe_buffer
*buf
)
97 struct page
*page
= buf
->page
;
100 if (!PageUptodate(page
)) {
104 * Page got truncated/unhashed. This will cause a 0-byte
105 * splice, if this is the first page.
107 if (!page
->mapping
) {
113 * Uh oh, read-error from disk.
115 if (!PageUptodate(page
)) {
121 * Page is ok afterall, we are done.
132 static const struct pipe_buf_operations page_cache_pipe_buf_ops
= {
134 .map
= generic_pipe_buf_map
,
135 .unmap
= generic_pipe_buf_unmap
,
136 .confirm
= page_cache_pipe_buf_confirm
,
137 .release
= page_cache_pipe_buf_release
,
138 .steal
= page_cache_pipe_buf_steal
,
139 .get
= generic_pipe_buf_get
,
142 static int user_page_pipe_buf_steal(struct pipe_inode_info
*pipe
,
143 struct pipe_buffer
*buf
)
145 if (!(buf
->flags
& PIPE_BUF_FLAG_GIFT
))
148 buf
->flags
|= PIPE_BUF_FLAG_LRU
;
149 return generic_pipe_buf_steal(pipe
, buf
);
152 static const struct pipe_buf_operations user_page_pipe_buf_ops
= {
154 .map
= generic_pipe_buf_map
,
155 .unmap
= generic_pipe_buf_unmap
,
156 .confirm
= generic_pipe_buf_confirm
,
157 .release
= page_cache_pipe_buf_release
,
158 .steal
= user_page_pipe_buf_steal
,
159 .get
= generic_pipe_buf_get
,
163 * splice_to_pipe - fill passed data into a pipe
164 * @pipe: pipe to fill
168 * @spd contains a map of pages and len/offset tuples, along with
169 * the struct pipe_buf_operations associated with these pages. This
170 * function will link that data to the pipe.
173 ssize_t
splice_to_pipe(struct pipe_inode_info
*pipe
,
174 struct splice_pipe_desc
*spd
)
176 unsigned int spd_pages
= spd
->nr_pages
;
177 int ret
, do_wakeup
, page_nr
;
184 mutex_lock(&pipe
->inode
->i_mutex
);
187 if (!pipe
->readers
) {
188 send_sig(SIGPIPE
, current
, 0);
194 if (pipe
->nrbufs
< PIPE_BUFFERS
) {
195 int newbuf
= (pipe
->curbuf
+ pipe
->nrbufs
) & (PIPE_BUFFERS
- 1);
196 struct pipe_buffer
*buf
= pipe
->bufs
+ newbuf
;
198 buf
->page
= spd
->pages
[page_nr
];
199 buf
->offset
= spd
->partial
[page_nr
].offset
;
200 buf
->len
= spd
->partial
[page_nr
].len
;
201 buf
->private = spd
->partial
[page_nr
].private;
203 if (spd
->flags
& SPLICE_F_GIFT
)
204 buf
->flags
|= PIPE_BUF_FLAG_GIFT
;
213 if (!--spd
->nr_pages
)
215 if (pipe
->nrbufs
< PIPE_BUFFERS
)
221 if (spd
->flags
& SPLICE_F_NONBLOCK
) {
227 if (signal_pending(current
)) {
235 if (waitqueue_active(&pipe
->wait
))
236 wake_up_interruptible_sync(&pipe
->wait
);
237 kill_fasync(&pipe
->fasync_readers
, SIGIO
, POLL_IN
);
241 pipe
->waiting_writers
++;
243 pipe
->waiting_writers
--;
247 mutex_unlock(&pipe
->inode
->i_mutex
);
251 if (waitqueue_active(&pipe
->wait
))
252 wake_up_interruptible(&pipe
->wait
);
253 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
)) {
370 * If in nonblock mode then dont block on waiting
371 * for an in-flight io page
373 if (flags
& SPLICE_F_NONBLOCK
) {
374 if (!trylock_page(page
)) {
382 * Page was truncated, or invalidated by the
383 * filesystem. Redo the find/create, but this time the
384 * page is kept locked, so there's no chance of another
385 * race with truncate/invalidate.
387 if (!page
->mapping
) {
389 page
= find_or_create_page(mapping
, index
,
390 mapping_gfp_mask(mapping
));
396 page_cache_release(pages
[page_nr
]);
397 pages
[page_nr
] = page
;
400 * page was already under io and is now done, great
402 if (PageUptodate(page
)) {
408 * need to read in the page
410 error
= mapping
->a_ops
->readpage(in
, page
);
411 if (unlikely(error
)) {
413 * We really should re-lookup the page here,
414 * but it complicates things a lot. Instead
415 * lets just do what we already stored, and
416 * we'll get it the next time we are called.
418 if (error
== AOP_TRUNCATED_PAGE
)
426 * i_size must be checked after PageUptodate.
428 isize
= i_size_read(mapping
->host
);
429 end_index
= (isize
- 1) >> PAGE_CACHE_SHIFT
;
430 if (unlikely(!isize
|| index
> end_index
))
434 * if this is the last page, see if we need to shrink
435 * the length and stop
437 if (end_index
== index
) {
441 * max good bytes in this page
443 plen
= ((isize
- 1) & ~PAGE_CACHE_MASK
) + 1;
448 * force quit after adding this page
450 this_len
= min(this_len
, plen
- loff
);
454 partial
[page_nr
].offset
= loff
;
455 partial
[page_nr
].len
= this_len
;
463 * Release any pages at the end, if we quit early. 'page_nr' is how far
464 * we got, 'nr_pages' is how many pages are in the map.
466 while (page_nr
< nr_pages
)
467 page_cache_release(pages
[page_nr
++]);
468 in
->f_ra
.prev_pos
= (loff_t
)index
<< PAGE_CACHE_SHIFT
;
471 return splice_to_pipe(pipe
, &spd
);
477 * generic_file_splice_read - splice data from file to a pipe
478 * @in: file to splice from
479 * @ppos: position in @in
480 * @pipe: pipe to splice to
481 * @len: number of bytes to splice
482 * @flags: splice modifier flags
485 * Will read pages from given file and fill them into a pipe. Can be
486 * used as long as the address_space operations for the source implements
490 ssize_t
generic_file_splice_read(struct file
*in
, loff_t
*ppos
,
491 struct pipe_inode_info
*pipe
, size_t len
,
497 isize
= i_size_read(in
->f_mapping
->host
);
498 if (unlikely(*ppos
>= isize
))
501 left
= isize
- *ppos
;
502 if (unlikely(left
< len
))
505 ret
= __generic_file_splice_read(in
, ppos
, pipe
, len
, flags
);
512 EXPORT_SYMBOL(generic_file_splice_read
);
515 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
516 * using sendpage(). Return the number of bytes sent.
518 static int pipe_to_sendpage(struct pipe_inode_info
*pipe
,
519 struct pipe_buffer
*buf
, struct splice_desc
*sd
)
521 struct file
*file
= sd
->u
.file
;
522 loff_t pos
= sd
->pos
;
525 ret
= buf
->ops
->confirm(pipe
, buf
);
527 more
= (sd
->flags
& SPLICE_F_MORE
) || sd
->len
< sd
->total_len
;
529 ret
= file
->f_op
->sendpage(file
, buf
->page
, buf
->offset
,
530 sd
->len
, &pos
, more
);
537 * This is a little more tricky than the file -> pipe splicing. There are
538 * basically three cases:
540 * - Destination page already exists in the address space and there
541 * are users of it. For that case we have no other option that
542 * copying the data. Tough luck.
543 * - Destination page already exists in the address space, but there
544 * are no users of it. Make sure it's uptodate, then drop it. Fall
545 * through to last case.
546 * - Destination page does not exist, we can add the pipe page to
547 * the page cache and avoid the copy.
549 * If asked to move pages to the output file (SPLICE_F_MOVE is set in
550 * sd->flags), we attempt to migrate pages from the pipe to the output
551 * file address space page cache. This is possible if no one else has
552 * the pipe page referenced outside of the pipe and page cache. If
553 * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create
554 * a new page in the output file page cache and fill/dirty that.
556 static int pipe_to_file(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
557 struct splice_desc
*sd
)
559 struct file
*file
= sd
->u
.file
;
560 struct address_space
*mapping
= file
->f_mapping
;
561 unsigned int offset
, this_len
;
567 * make sure the data in this buffer is uptodate
569 ret
= buf
->ops
->confirm(pipe
, buf
);
573 offset
= sd
->pos
& ~PAGE_CACHE_MASK
;
576 if (this_len
+ offset
> PAGE_CACHE_SIZE
)
577 this_len
= PAGE_CACHE_SIZE
- offset
;
579 ret
= pagecache_write_begin(file
, mapping
, sd
->pos
, this_len
,
580 AOP_FLAG_UNINTERRUPTIBLE
, &page
, &fsdata
);
584 if (buf
->page
!= page
) {
586 * Careful, ->map() uses KM_USER0!
588 char *src
= buf
->ops
->map(pipe
, buf
, 1);
589 char *dst
= kmap_atomic(page
, KM_USER1
);
591 memcpy(dst
+ offset
, src
+ buf
->offset
, this_len
);
592 flush_dcache_page(page
);
593 kunmap_atomic(dst
, KM_USER1
);
594 buf
->ops
->unmap(pipe
, buf
, src
);
596 ret
= pagecache_write_end(file
, mapping
, sd
->pos
, this_len
, this_len
,
603 * __splice_from_pipe - splice data from a pipe to given actor
604 * @pipe: pipe to splice from
605 * @sd: information to @actor
606 * @actor: handler that splices the data
609 * This function does little more than loop over the pipe and call
610 * @actor to do the actual moving of a single struct pipe_buffer to
611 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
615 ssize_t
__splice_from_pipe(struct pipe_inode_info
*pipe
, struct splice_desc
*sd
,
618 int ret
, do_wakeup
, err
;
625 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
626 const struct pipe_buf_operations
*ops
= buf
->ops
;
629 if (sd
->len
> sd
->total_len
)
630 sd
->len
= sd
->total_len
;
632 err
= actor(pipe
, buf
, sd
);
634 if (!ret
&& err
!= -ENODATA
)
646 sd
->total_len
-= err
;
652 ops
->release(pipe
, buf
);
653 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (PIPE_BUFFERS
- 1);
667 if (!pipe
->waiting_writers
) {
672 if (sd
->flags
& SPLICE_F_NONBLOCK
) {
678 if (signal_pending(current
)) {
686 if (waitqueue_active(&pipe
->wait
))
687 wake_up_interruptible_sync(&pipe
->wait
);
688 kill_fasync(&pipe
->fasync_writers
, SIGIO
, POLL_OUT
);
697 if (waitqueue_active(&pipe
->wait
))
698 wake_up_interruptible(&pipe
->wait
);
699 kill_fasync(&pipe
->fasync_writers
, SIGIO
, POLL_OUT
);
704 EXPORT_SYMBOL(__splice_from_pipe
);
707 * splice_from_pipe - splice data from a pipe to a file
708 * @pipe: pipe to splice from
709 * @out: file to splice to
710 * @ppos: position in @out
711 * @len: how many bytes to splice
712 * @flags: splice modifier flags
713 * @actor: handler that splices the data
716 * See __splice_from_pipe. This function locks the input and output inodes,
717 * otherwise it's identical to __splice_from_pipe().
720 ssize_t
splice_from_pipe(struct pipe_inode_info
*pipe
, struct file
*out
,
721 loff_t
*ppos
, size_t len
, unsigned int flags
,
725 struct inode
*inode
= out
->f_mapping
->host
;
726 struct splice_desc sd
= {
734 * The actor worker might be calling ->write_begin and
735 * ->write_end. Most of the time, these expect i_mutex to
736 * be held. Since this may result in an ABBA deadlock with
737 * pipe->inode, we have to order lock acquiry here.
739 * Outer lock must be inode->i_mutex, as pipe_wait() will
740 * release and reacquire pipe->inode->i_mutex, AND inode must
743 WARN_ON(S_ISFIFO(inode
->i_mode
));
744 mutex_lock_nested(&inode
->i_mutex
, I_MUTEX_PARENT
);
746 mutex_lock_nested(&pipe
->inode
->i_mutex
, I_MUTEX_CHILD
);
747 ret
= __splice_from_pipe(pipe
, &sd
, actor
);
749 mutex_unlock(&pipe
->inode
->i_mutex
);
750 mutex_unlock(&inode
->i_mutex
);
756 * generic_file_splice_write_nolock - generic_file_splice_write without mutexes
758 * @out: file to write to
759 * @ppos: position in @out
760 * @len: number of bytes to splice
761 * @flags: splice modifier flags
764 * Will either move or copy pages (determined by @flags options) from
765 * the given pipe inode to the given file. The caller is responsible
766 * for acquiring i_mutex on both inodes.
770 generic_file_splice_write_nolock(struct pipe_inode_info
*pipe
, struct file
*out
,
771 loff_t
*ppos
, size_t len
, unsigned int flags
)
773 struct address_space
*mapping
= out
->f_mapping
;
774 struct inode
*inode
= mapping
->host
;
775 struct splice_desc sd
= {
784 err
= file_remove_suid(out
);
788 ret
= __splice_from_pipe(pipe
, &sd
, pipe_to_file
);
790 unsigned long nr_pages
;
793 nr_pages
= (ret
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
796 * If file or inode is SYNC and we actually wrote some data,
799 if (unlikely((out
->f_flags
& O_SYNC
) || IS_SYNC(inode
))) {
800 err
= generic_osync_inode(inode
, mapping
,
801 OSYNC_METADATA
|OSYNC_DATA
);
806 balance_dirty_pages_ratelimited_nr(mapping
, nr_pages
);
812 EXPORT_SYMBOL(generic_file_splice_write_nolock
);
815 * generic_file_splice_write - splice data from a pipe to a file
817 * @out: file to write to
818 * @ppos: position in @out
819 * @len: number of bytes to splice
820 * @flags: splice modifier flags
823 * Will either move or copy pages (determined by @flags options) from
824 * the given pipe inode to the given file.
828 generic_file_splice_write(struct pipe_inode_info
*pipe
, struct file
*out
,
829 loff_t
*ppos
, size_t len
, unsigned int flags
)
831 struct address_space
*mapping
= out
->f_mapping
;
832 struct inode
*inode
= mapping
->host
;
833 struct splice_desc sd
= {
841 WARN_ON(S_ISFIFO(inode
->i_mode
));
842 mutex_lock_nested(&inode
->i_mutex
, I_MUTEX_PARENT
);
843 ret
= file_remove_suid(out
);
846 mutex_lock_nested(&pipe
->inode
->i_mutex
, I_MUTEX_CHILD
);
847 ret
= __splice_from_pipe(pipe
, &sd
, pipe_to_file
);
849 mutex_unlock(&pipe
->inode
->i_mutex
);
851 mutex_unlock(&inode
->i_mutex
);
853 unsigned long nr_pages
;
856 nr_pages
= (ret
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
859 * If file or inode is SYNC and we actually wrote some data,
862 if (unlikely((out
->f_flags
& O_SYNC
) || IS_SYNC(inode
))) {
865 mutex_lock(&inode
->i_mutex
);
866 err
= generic_osync_inode(inode
, mapping
,
867 OSYNC_METADATA
|OSYNC_DATA
);
868 mutex_unlock(&inode
->i_mutex
);
873 balance_dirty_pages_ratelimited_nr(mapping
, nr_pages
);
879 EXPORT_SYMBOL(generic_file_splice_write
);
882 * generic_splice_sendpage - splice data from a pipe to a socket
883 * @pipe: pipe to splice from
884 * @out: socket to write to
885 * @ppos: position in @out
886 * @len: number of bytes to splice
887 * @flags: splice modifier flags
890 * Will send @len bytes from the pipe to a network socket. No data copying
894 ssize_t
generic_splice_sendpage(struct pipe_inode_info
*pipe
, struct file
*out
,
895 loff_t
*ppos
, size_t len
, unsigned int flags
)
897 return splice_from_pipe(pipe
, out
, ppos
, len
, flags
, pipe_to_sendpage
);
900 EXPORT_SYMBOL(generic_splice_sendpage
);
903 * Attempt to initiate a splice from pipe to file.
905 static long do_splice_from(struct pipe_inode_info
*pipe
, struct file
*out
,
906 loff_t
*ppos
, size_t len
, unsigned int flags
)
910 if (unlikely(!out
->f_op
|| !out
->f_op
->splice_write
))
913 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
916 if (unlikely(out
->f_flags
& O_APPEND
))
919 ret
= rw_verify_area(WRITE
, out
, ppos
, len
);
920 if (unlikely(ret
< 0))
923 return out
->f_op
->splice_write(pipe
, out
, ppos
, len
, flags
);
927 * Attempt to initiate a splice from a file to a pipe.
929 static long do_splice_to(struct file
*in
, loff_t
*ppos
,
930 struct pipe_inode_info
*pipe
, size_t len
,
935 if (unlikely(!in
->f_op
|| !in
->f_op
->splice_read
))
938 if (unlikely(!(in
->f_mode
& FMODE_READ
)))
941 ret
= rw_verify_area(READ
, in
, ppos
, len
);
942 if (unlikely(ret
< 0))
945 return in
->f_op
->splice_read(in
, ppos
, pipe
, len
, flags
);
949 * splice_direct_to_actor - splices data directly between two non-pipes
950 * @in: file to splice from
951 * @sd: actor information on where to splice to
952 * @actor: handles the data splicing
955 * This is a special case helper to splice directly between two
956 * points, without requiring an explicit pipe. Internally an allocated
957 * pipe is cached in the process, and reused during the lifetime of
961 ssize_t
splice_direct_to_actor(struct file
*in
, struct splice_desc
*sd
,
962 splice_direct_actor
*actor
)
964 struct pipe_inode_info
*pipe
;
971 * We require the input being a regular file, as we don't want to
972 * randomly drop data for eg socket -> socket splicing. Use the
973 * piped splicing for that!
975 i_mode
= in
->f_path
.dentry
->d_inode
->i_mode
;
976 if (unlikely(!S_ISREG(i_mode
) && !S_ISBLK(i_mode
)))
980 * neither in nor out is a pipe, setup an internal pipe attached to
981 * 'out' and transfer the wanted data from 'in' to 'out' through that
983 pipe
= current
->splice_pipe
;
984 if (unlikely(!pipe
)) {
985 pipe
= alloc_pipe_info(NULL
);
990 * We don't have an immediate reader, but we'll read the stuff
991 * out of the pipe right after the splice_to_pipe(). So set
992 * PIPE_READERS appropriately.
996 current
->splice_pipe
= pipe
;
1004 len
= sd
->total_len
;
1008 * Don't block on output, we have to drain the direct pipe.
1010 sd
->flags
&= ~SPLICE_F_NONBLOCK
;
1014 loff_t pos
= sd
->pos
, prev_pos
= pos
;
1016 ret
= do_splice_to(in
, &pos
, pipe
, len
, flags
);
1017 if (unlikely(ret
<= 0))
1021 sd
->total_len
= read_len
;
1024 * NOTE: nonblocking mode only applies to the input. We
1025 * must not do the output in nonblocking mode as then we
1026 * could get stuck data in the internal pipe:
1028 ret
= actor(pipe
, sd
);
1029 if (unlikely(ret
<= 0)) {
1038 if (ret
< read_len
) {
1039 sd
->pos
= prev_pos
+ ret
;
1045 pipe
->nrbufs
= pipe
->curbuf
= 0;
1051 * If we did an incomplete transfer we must release
1052 * the pipe buffers in question:
1054 for (i
= 0; i
< PIPE_BUFFERS
; i
++) {
1055 struct pipe_buffer
*buf
= pipe
->bufs
+ i
;
1058 buf
->ops
->release(pipe
, buf
);
1068 EXPORT_SYMBOL(splice_direct_to_actor
);
1070 static int direct_splice_actor(struct pipe_inode_info
*pipe
,
1071 struct splice_desc
*sd
)
1073 struct file
*file
= sd
->u
.file
;
1075 return do_splice_from(pipe
, file
, &sd
->pos
, sd
->total_len
, sd
->flags
);
1079 * do_splice_direct - splices data directly between two files
1080 * @in: file to splice from
1081 * @ppos: input file offset
1082 * @out: file to splice to
1083 * @len: number of bytes to splice
1084 * @flags: splice modifier flags
1087 * For use by do_sendfile(). splice can easily emulate sendfile, but
1088 * doing it in the application would incur an extra system call
1089 * (splice in + splice out, as compared to just sendfile()). So this helper
1090 * can splice directly through a process-private pipe.
1093 long do_splice_direct(struct file
*in
, loff_t
*ppos
, struct file
*out
,
1094 size_t len
, unsigned int flags
)
1096 struct splice_desc sd
= {
1105 ret
= splice_direct_to_actor(in
, &sd
, direct_splice_actor
);
1113 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
1114 * location, so checking ->i_pipe is not enough to verify that this is a
1117 static inline struct pipe_inode_info
*pipe_info(struct inode
*inode
)
1119 if (S_ISFIFO(inode
->i_mode
))
1120 return inode
->i_pipe
;
1126 * Determine where to splice to/from.
1128 static long do_splice(struct file
*in
, loff_t __user
*off_in
,
1129 struct file
*out
, loff_t __user
*off_out
,
1130 size_t len
, unsigned int flags
)
1132 struct pipe_inode_info
*pipe
;
1133 loff_t offset
, *off
;
1136 pipe
= pipe_info(in
->f_path
.dentry
->d_inode
);
1141 if (out
->f_op
->llseek
== no_llseek
)
1143 if (copy_from_user(&offset
, off_out
, sizeof(loff_t
)))
1149 ret
= do_splice_from(pipe
, out
, off
, len
, flags
);
1151 if (off_out
&& copy_to_user(off_out
, off
, sizeof(loff_t
)))
1157 pipe
= pipe_info(out
->f_path
.dentry
->d_inode
);
1162 if (in
->f_op
->llseek
== no_llseek
)
1164 if (copy_from_user(&offset
, off_in
, sizeof(loff_t
)))
1170 ret
= do_splice_to(in
, off
, pipe
, len
, flags
);
1172 if (off_in
&& copy_to_user(off_in
, off
, sizeof(loff_t
)))
1182 * Map an iov into an array of pages and offset/length tupples. With the
1183 * partial_page structure, we can map several non-contiguous ranges into
1184 * our ones pages[] map instead of splitting that operation into pieces.
1185 * Could easily be exported as a generic helper for other users, in which
1186 * case one would probably want to add a 'max_nr_pages' parameter as well.
1188 static int get_iovec_page_array(const struct iovec __user
*iov
,
1189 unsigned int nr_vecs
, struct page
**pages
,
1190 struct partial_page
*partial
, int aligned
)
1192 int buffers
= 0, error
= 0;
1195 unsigned long off
, npages
;
1202 if (copy_from_user(&entry
, iov
, sizeof(entry
)))
1205 base
= entry
.iov_base
;
1206 len
= entry
.iov_len
;
1209 * Sanity check this iovec. 0 read succeeds.
1215 if (!access_ok(VERIFY_READ
, base
, len
))
1219 * Get this base offset and number of pages, then map
1220 * in the user pages.
1222 off
= (unsigned long) base
& ~PAGE_MASK
;
1225 * If asked for alignment, the offset must be zero and the
1226 * length a multiple of the PAGE_SIZE.
1229 if (aligned
&& (off
|| len
& ~PAGE_MASK
))
1232 npages
= (off
+ len
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
1233 if (npages
> PIPE_BUFFERS
- buffers
)
1234 npages
= PIPE_BUFFERS
- buffers
;
1236 error
= get_user_pages_fast((unsigned long)base
, npages
,
1237 0, &pages
[buffers
]);
1239 if (unlikely(error
<= 0))
1243 * Fill this contiguous range into the partial page map.
1245 for (i
= 0; i
< error
; i
++) {
1246 const int plen
= min_t(size_t, len
, PAGE_SIZE
- off
);
1248 partial
[buffers
].offset
= off
;
1249 partial
[buffers
].len
= plen
;
1257 * We didn't complete this iov, stop here since it probably
1258 * means we have to move some of this into a pipe to
1259 * be able to continue.
1265 * Don't continue if we mapped fewer pages than we asked for,
1266 * or if we mapped the max number of pages that we have
1269 if (error
< npages
|| buffers
== PIPE_BUFFERS
)
1282 static int pipe_to_user(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
1283 struct splice_desc
*sd
)
1288 ret
= buf
->ops
->confirm(pipe
, buf
);
1293 * See if we can use the atomic maps, by prefaulting in the
1294 * pages and doing an atomic copy
1296 if (!fault_in_pages_writeable(sd
->u
.userptr
, sd
->len
)) {
1297 src
= buf
->ops
->map(pipe
, buf
, 1);
1298 ret
= __copy_to_user_inatomic(sd
->u
.userptr
, src
+ buf
->offset
,
1300 buf
->ops
->unmap(pipe
, buf
, src
);
1308 * No dice, use slow non-atomic map and copy
1310 src
= buf
->ops
->map(pipe
, buf
, 0);
1313 if (copy_to_user(sd
->u
.userptr
, src
+ buf
->offset
, sd
->len
))
1316 buf
->ops
->unmap(pipe
, buf
, src
);
1319 sd
->u
.userptr
+= ret
;
1324 * For lack of a better implementation, implement vmsplice() to userspace
1325 * as a simple copy of the pipes pages to the user iov.
1327 static long vmsplice_to_user(struct file
*file
, const struct iovec __user
*iov
,
1328 unsigned long nr_segs
, unsigned int flags
)
1330 struct pipe_inode_info
*pipe
;
1331 struct splice_desc sd
;
1336 pipe
= pipe_info(file
->f_path
.dentry
->d_inode
);
1341 mutex_lock(&pipe
->inode
->i_mutex
);
1349 * Get user address base and length for this iovec.
1351 error
= get_user(base
, &iov
->iov_base
);
1352 if (unlikely(error
))
1354 error
= get_user(len
, &iov
->iov_len
);
1355 if (unlikely(error
))
1359 * Sanity check this iovec. 0 read succeeds.
1363 if (unlikely(!base
)) {
1368 if (unlikely(!access_ok(VERIFY_WRITE
, base
, len
))) {
1376 sd
.u
.userptr
= base
;
1379 size
= __splice_from_pipe(pipe
, &sd
, pipe_to_user
);
1397 mutex_unlock(&pipe
->inode
->i_mutex
);
1406 * vmsplice splices a user address range into a pipe. It can be thought of
1407 * as splice-from-memory, where the regular splice is splice-from-file (or
1408 * to file). In both cases the output is a pipe, naturally.
1410 static long vmsplice_to_pipe(struct file
*file
, const struct iovec __user
*iov
,
1411 unsigned long nr_segs
, unsigned int flags
)
1413 struct pipe_inode_info
*pipe
;
1414 struct page
*pages
[PIPE_BUFFERS
];
1415 struct partial_page partial
[PIPE_BUFFERS
];
1416 struct splice_pipe_desc spd
= {
1420 .ops
= &user_page_pipe_buf_ops
,
1421 .spd_release
= spd_release_page
,
1424 pipe
= pipe_info(file
->f_path
.dentry
->d_inode
);
1428 spd
.nr_pages
= get_iovec_page_array(iov
, nr_segs
, pages
, partial
,
1429 flags
& SPLICE_F_GIFT
);
1430 if (spd
.nr_pages
<= 0)
1431 return spd
.nr_pages
;
1433 return splice_to_pipe(pipe
, &spd
);
1437 * Note that vmsplice only really supports true splicing _from_ user memory
1438 * to a pipe, not the other way around. Splicing from user memory is a simple
1439 * operation that can be supported without any funky alignment restrictions
1440 * or nasty vm tricks. We simply map in the user memory and fill them into
1441 * a pipe. The reverse isn't quite as easy, though. There are two possible
1442 * solutions for that:
1444 * - memcpy() the data internally, at which point we might as well just
1445 * do a regular read() on the buffer anyway.
1446 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1447 * has restriction limitations on both ends of the pipe).
1449 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1452 SYSCALL_DEFINE4(vmsplice
, int, fd
, const struct iovec __user
*, iov
,
1453 unsigned long, nr_segs
, unsigned int, flags
)
1459 if (unlikely(nr_segs
> UIO_MAXIOV
))
1461 else if (unlikely(!nr_segs
))
1465 file
= fget_light(fd
, &fput
);
1467 if (file
->f_mode
& FMODE_WRITE
)
1468 error
= vmsplice_to_pipe(file
, iov
, nr_segs
, flags
);
1469 else if (file
->f_mode
& FMODE_READ
)
1470 error
= vmsplice_to_user(file
, iov
, nr_segs
, flags
);
1472 fput_light(file
, fput
);
1478 SYSCALL_DEFINE6(splice
, int, fd_in
, loff_t __user
*, off_in
,
1479 int, fd_out
, loff_t __user
*, off_out
,
1480 size_t, len
, unsigned int, flags
)
1483 struct file
*in
, *out
;
1484 int fput_in
, fput_out
;
1490 in
= fget_light(fd_in
, &fput_in
);
1492 if (in
->f_mode
& FMODE_READ
) {
1493 out
= fget_light(fd_out
, &fput_out
);
1495 if (out
->f_mode
& FMODE_WRITE
)
1496 error
= do_splice(in
, off_in
,
1499 fput_light(out
, fput_out
);
1503 fput_light(in
, fput_in
);
1510 * Make sure there's data to read. Wait for input if we can, otherwise
1511 * return an appropriate error.
1513 static int link_ipipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1518 * Check ->nrbufs without the inode lock first. This function
1519 * is speculative anyways, so missing one is ok.
1525 mutex_lock(&pipe
->inode
->i_mutex
);
1527 while (!pipe
->nrbufs
) {
1528 if (signal_pending(current
)) {
1534 if (!pipe
->waiting_writers
) {
1535 if (flags
& SPLICE_F_NONBLOCK
) {
1543 mutex_unlock(&pipe
->inode
->i_mutex
);
1548 * Make sure there's writeable room. Wait for room if we can, otherwise
1549 * return an appropriate error.
1551 static int link_opipe_prep(struct pipe_inode_info
*pipe
, unsigned int flags
)
1556 * Check ->nrbufs without the inode lock first. This function
1557 * is speculative anyways, so missing one is ok.
1559 if (pipe
->nrbufs
< PIPE_BUFFERS
)
1563 mutex_lock(&pipe
->inode
->i_mutex
);
1565 while (pipe
->nrbufs
>= PIPE_BUFFERS
) {
1566 if (!pipe
->readers
) {
1567 send_sig(SIGPIPE
, current
, 0);
1571 if (flags
& SPLICE_F_NONBLOCK
) {
1575 if (signal_pending(current
)) {
1579 pipe
->waiting_writers
++;
1581 pipe
->waiting_writers
--;
1584 mutex_unlock(&pipe
->inode
->i_mutex
);
1589 * Link contents of ipipe to opipe.
1591 static int link_pipe(struct pipe_inode_info
*ipipe
,
1592 struct pipe_inode_info
*opipe
,
1593 size_t len
, unsigned int flags
)
1595 struct pipe_buffer
*ibuf
, *obuf
;
1596 int ret
= 0, i
= 0, nbuf
;
1599 * Potential ABBA deadlock, work around it by ordering lock
1600 * grabbing by inode address. Otherwise two different processes
1601 * could deadlock (one doing tee from A -> B, the other from B -> A).
1603 inode_double_lock(ipipe
->inode
, opipe
->inode
);
1606 if (!opipe
->readers
) {
1607 send_sig(SIGPIPE
, current
, 0);
1614 * If we have iterated all input buffers or ran out of
1615 * output room, break.
1617 if (i
>= ipipe
->nrbufs
|| opipe
->nrbufs
>= PIPE_BUFFERS
)
1620 ibuf
= ipipe
->bufs
+ ((ipipe
->curbuf
+ i
) & (PIPE_BUFFERS
- 1));
1621 nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (PIPE_BUFFERS
- 1);
1624 * Get a reference to this pipe buffer,
1625 * so we can copy the contents over.
1627 ibuf
->ops
->get(ipipe
, ibuf
);
1629 obuf
= opipe
->bufs
+ nbuf
;
1633 * Don't inherit the gift flag, we need to
1634 * prevent multiple steals of this page.
1636 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1638 if (obuf
->len
> len
)
1648 * return EAGAIN if we have the potential of some data in the
1649 * future, otherwise just return 0
1651 if (!ret
&& ipipe
->waiting_writers
&& (flags
& SPLICE_F_NONBLOCK
))
1654 inode_double_unlock(ipipe
->inode
, opipe
->inode
);
1657 * If we put data in the output pipe, wakeup any potential readers.
1661 if (waitqueue_active(&opipe
->wait
))
1662 wake_up_interruptible(&opipe
->wait
);
1663 kill_fasync(&opipe
->fasync_readers
, SIGIO
, POLL_IN
);
1670 * This is a tee(1) implementation that works on pipes. It doesn't copy
1671 * any data, it simply references the 'in' pages on the 'out' pipe.
1672 * The 'flags' used are the SPLICE_F_* variants, currently the only
1673 * applicable one is SPLICE_F_NONBLOCK.
1675 static long do_tee(struct file
*in
, struct file
*out
, size_t len
,
1678 struct pipe_inode_info
*ipipe
= pipe_info(in
->f_path
.dentry
->d_inode
);
1679 struct pipe_inode_info
*opipe
= pipe_info(out
->f_path
.dentry
->d_inode
);
1683 * Duplicate the contents of ipipe to opipe without actually
1686 if (ipipe
&& opipe
&& ipipe
!= opipe
) {
1688 * Keep going, unless we encounter an error. The ipipe/opipe
1689 * ordering doesn't really matter.
1691 ret
= link_ipipe_prep(ipipe
, flags
);
1693 ret
= link_opipe_prep(opipe
, flags
);
1695 ret
= link_pipe(ipipe
, opipe
, len
, flags
);
1702 SYSCALL_DEFINE4(tee
, int, fdin
, int, fdout
, size_t, len
, unsigned int, flags
)
1711 in
= fget_light(fdin
, &fput_in
);
1713 if (in
->f_mode
& FMODE_READ
) {
1715 struct file
*out
= fget_light(fdout
, &fput_out
);
1718 if (out
->f_mode
& FMODE_WRITE
)
1719 error
= do_tee(in
, out
, len
, flags
);
1720 fput_light(out
, fput_out
);
1723 fput_light(in
, fput_in
);