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@suse.de>
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/pipe_fs_i.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>
38 * Passed to splice_to_pipe
40 struct splice_pipe_desc
{
41 struct page
**pages
; /* page map */
42 struct partial_page
*partial
; /* pages[] may not be contig */
43 int nr_pages
; /* number of pages in map */
44 unsigned int flags
; /* splice flags */
45 struct pipe_buf_operations
*ops
;/* ops associated with output pipe */
49 * Attempt to steal a page from a pipe buffer. This should perhaps go into
50 * a vm helper function, it's already simplified quite a bit by the
51 * addition of remove_mapping(). If success is returned, the caller may
52 * attempt to reuse this page for another destination.
54 static int page_cache_pipe_buf_steal(struct pipe_inode_info
*pipe
,
55 struct pipe_buffer
*buf
)
57 struct page
*page
= buf
->page
;
58 struct address_space
*mapping
;
62 mapping
= page_mapping(page
);
64 WARN_ON(!PageUptodate(page
));
67 * At least for ext2 with nobh option, we need to wait on
68 * writeback completing on this page, since we'll remove it
69 * from the pagecache. Otherwise truncate wont wait on the
70 * page, allowing the disk blocks to be reused by someone else
71 * before we actually wrote our data to them. fs corruption
74 wait_on_page_writeback(page
);
76 if (PagePrivate(page
))
77 try_to_release_page(page
, mapping_gfp_mask(mapping
));
80 * If we succeeded in removing the mapping, set LRU flag
83 if (remove_mapping(mapping
, page
)) {
84 buf
->flags
|= PIPE_BUF_FLAG_LRU
;
90 * Raced with truncate or failed to remove page from current
91 * address space, unlock and return failure.
97 static void page_cache_pipe_buf_release(struct pipe_inode_info
*pipe
,
98 struct pipe_buffer
*buf
)
100 page_cache_release(buf
->page
);
101 buf
->flags
&= ~PIPE_BUF_FLAG_LRU
;
104 static int page_cache_pipe_buf_pin(struct pipe_inode_info
*pipe
,
105 struct pipe_buffer
*buf
)
107 struct page
*page
= buf
->page
;
110 if (!PageUptodate(page
)) {
114 * Page got truncated/unhashed. This will cause a 0-byte
115 * splice, if this is the first page.
117 if (!page
->mapping
) {
123 * Uh oh, read-error from disk.
125 if (!PageUptodate(page
)) {
131 * Page is ok afterall, we are done.
142 static struct pipe_buf_operations page_cache_pipe_buf_ops
= {
144 .map
= generic_pipe_buf_map
,
145 .unmap
= generic_pipe_buf_unmap
,
146 .pin
= page_cache_pipe_buf_pin
,
147 .release
= page_cache_pipe_buf_release
,
148 .steal
= page_cache_pipe_buf_steal
,
149 .get
= generic_pipe_buf_get
,
152 static int user_page_pipe_buf_steal(struct pipe_inode_info
*pipe
,
153 struct pipe_buffer
*buf
)
155 if (!(buf
->flags
& PIPE_BUF_FLAG_GIFT
))
158 buf
->flags
|= PIPE_BUF_FLAG_LRU
;
159 return generic_pipe_buf_steal(pipe
, buf
);
162 static struct pipe_buf_operations user_page_pipe_buf_ops
= {
164 .map
= generic_pipe_buf_map
,
165 .unmap
= generic_pipe_buf_unmap
,
166 .pin
= generic_pipe_buf_pin
,
167 .release
= page_cache_pipe_buf_release
,
168 .steal
= user_page_pipe_buf_steal
,
169 .get
= generic_pipe_buf_get
,
173 * Pipe output worker. This sets up our pipe format with the page cache
174 * pipe buffer operations. Otherwise very similar to the regular pipe_writev().
176 static ssize_t
splice_to_pipe(struct pipe_inode_info
*pipe
,
177 struct splice_pipe_desc
*spd
)
179 int ret
, do_wakeup
, page_nr
;
186 mutex_lock(&pipe
->inode
->i_mutex
);
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
;
204 if (spd
->flags
& SPLICE_F_GIFT
)
205 buf
->flags
|= PIPE_BUF_FLAG_GIFT
;
214 if (!--spd
->nr_pages
)
216 if (pipe
->nrbufs
< PIPE_BUFFERS
)
222 if (spd
->flags
& SPLICE_F_NONBLOCK
) {
228 if (signal_pending(current
)) {
236 if (waitqueue_active(&pipe
->wait
))
237 wake_up_interruptible_sync(&pipe
->wait
);
238 kill_fasync(&pipe
->fasync_readers
, SIGIO
, POLL_IN
);
242 pipe
->waiting_writers
++;
244 pipe
->waiting_writers
--;
248 mutex_unlock(&pipe
->inode
->i_mutex
);
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
->nr_pages
)
258 page_cache_release(spd
->pages
[page_nr
++]);
264 __generic_file_splice_read(struct file
*in
, loff_t
*ppos
,
265 struct pipe_inode_info
*pipe
, size_t len
,
268 struct address_space
*mapping
= in
->f_mapping
;
269 unsigned int loff
, nr_pages
;
270 struct page
*pages
[PIPE_BUFFERS
];
271 struct partial_page partial
[PIPE_BUFFERS
];
273 pgoff_t index
, end_index
;
277 struct splice_pipe_desc spd
= {
281 .ops
= &page_cache_pipe_buf_ops
,
284 index
= *ppos
>> PAGE_CACHE_SHIFT
;
285 loff
= *ppos
& ~PAGE_CACHE_MASK
;
286 nr_pages
= (len
+ loff
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
288 if (nr_pages
> PIPE_BUFFERS
)
289 nr_pages
= PIPE_BUFFERS
;
292 * Initiate read-ahead on this page range. however, don't call into
293 * read-ahead if this is a non-zero offset (we are likely doing small
294 * chunk splice and the page is already there) for a single page.
296 if (!loff
|| nr_pages
> 1)
297 page_cache_readahead(mapping
, &in
->f_ra
, in
, index
, nr_pages
);
300 * Now fill in the holes:
306 * Lookup the (hopefully) full range of pages we need.
308 spd
.nr_pages
= find_get_pages_contig(mapping
, index
, nr_pages
, pages
);
311 * If find_get_pages_contig() returned fewer pages than we needed,
314 index
+= spd
.nr_pages
;
315 while (spd
.nr_pages
< nr_pages
) {
317 * Page could be there, find_get_pages_contig() breaks on
320 page
= find_get_page(mapping
, index
);
323 * Make sure the read-ahead engine is notified
324 * about this failure.
326 handle_ra_miss(mapping
, &in
->f_ra
, index
);
329 * page didn't exist, allocate one.
331 page
= page_cache_alloc_cold(mapping
);
335 error
= add_to_page_cache_lru(page
, mapping
, index
,
336 mapping_gfp_mask(mapping
));
337 if (unlikely(error
)) {
338 page_cache_release(page
);
339 if (error
== -EEXIST
)
344 * add_to_page_cache() locks the page, unlock it
345 * to avoid convoluting the logic below even more.
350 pages
[spd
.nr_pages
++] = page
;
355 * Now loop over the map and see if we need to start IO on any
356 * pages, fill in the partial map, etc.
358 index
= *ppos
>> PAGE_CACHE_SHIFT
;
359 nr_pages
= spd
.nr_pages
;
361 for (page_nr
= 0; page_nr
< nr_pages
; page_nr
++) {
362 unsigned int this_len
;
368 * this_len is the max we'll use from this page
370 this_len
= min_t(unsigned long, len
, PAGE_CACHE_SIZE
- loff
);
371 page
= pages
[page_nr
];
374 * If the page isn't uptodate, we may need to start io on it
376 if (!PageUptodate(page
)) {
378 * If in nonblock mode then dont block on waiting
379 * for an in-flight io page
381 if (flags
& SPLICE_F_NONBLOCK
)
387 * page was truncated, stop here. if this isn't the
388 * first page, we'll just complete what we already
391 if (!page
->mapping
) {
396 * page was already under io and is now done, great
398 if (PageUptodate(page
)) {
404 * need to read in the page
406 error
= mapping
->a_ops
->readpage(in
, page
);
407 if (unlikely(error
)) {
409 * We really should re-lookup the page here,
410 * but it complicates things a lot. Instead
411 * lets just do what we already stored, and
412 * we'll get it the next time we are called.
414 if (error
== AOP_TRUNCATED_PAGE
)
421 * i_size must be checked after ->readpage().
423 isize
= i_size_read(mapping
->host
);
424 end_index
= (isize
- 1) >> PAGE_CACHE_SHIFT
;
425 if (unlikely(!isize
|| index
> end_index
))
429 * if this is the last page, see if we need to shrink
430 * the length and stop
432 if (end_index
== index
) {
433 loff
= PAGE_CACHE_SIZE
- (isize
& ~PAGE_CACHE_MASK
);
434 if (total_len
+ loff
> isize
)
437 * force quit after adding this page
440 this_len
= min(this_len
, loff
);
445 partial
[page_nr
].offset
= loff
;
446 partial
[page_nr
].len
= this_len
;
448 total_len
+= this_len
;
455 * Release any pages at the end, if we quit early. 'i' is how far
456 * we got, 'nr_pages' is how many pages are in the map.
458 while (page_nr
< nr_pages
)
459 page_cache_release(pages
[page_nr
++]);
462 return splice_to_pipe(pipe
, &spd
);
468 * generic_file_splice_read - splice data from file to a pipe
469 * @in: file to splice from
470 * @pipe: pipe to splice to
471 * @len: number of bytes to splice
472 * @flags: splice modifier flags
474 * Will read pages from given file and fill them into a pipe.
476 ssize_t
generic_file_splice_read(struct file
*in
, loff_t
*ppos
,
477 struct pipe_inode_info
*pipe
, size_t len
,
487 ret
= __generic_file_splice_read(in
, ppos
, pipe
, len
, flags
);
494 if (flags
& SPLICE_F_NONBLOCK
) {
511 EXPORT_SYMBOL(generic_file_splice_read
);
514 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
515 * using sendpage(). Return the number of bytes sent.
517 static int pipe_to_sendpage(struct pipe_inode_info
*pipe
,
518 struct pipe_buffer
*buf
, struct splice_desc
*sd
)
520 struct file
*file
= sd
->file
;
521 loff_t pos
= sd
->pos
;
524 ret
= buf
->ops
->pin(pipe
, buf
);
526 more
= (sd
->flags
& SPLICE_F_MORE
) || sd
->len
< sd
->total_len
;
528 ret
= file
->f_op
->sendpage(file
, buf
->page
, buf
->offset
,
529 sd
->len
, &pos
, more
);
536 * This is a little more tricky than the file -> pipe splicing. There are
537 * basically three cases:
539 * - Destination page already exists in the address space and there
540 * are users of it. For that case we have no other option that
541 * copying the data. Tough luck.
542 * - Destination page already exists in the address space, but there
543 * are no users of it. Make sure it's uptodate, then drop it. Fall
544 * through to last case.
545 * - Destination page does not exist, we can add the pipe page to
546 * the page cache and avoid the copy.
548 * If asked to move pages to the output file (SPLICE_F_MOVE is set in
549 * sd->flags), we attempt to migrate pages from the pipe to the output
550 * file address space page cache. This is possible if no one else has
551 * the pipe page referenced outside of the pipe and page cache. If
552 * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create
553 * a new page in the output file page cache and fill/dirty that.
555 static int pipe_to_file(struct pipe_inode_info
*pipe
, struct pipe_buffer
*buf
,
556 struct splice_desc
*sd
)
558 struct file
*file
= sd
->file
;
559 struct address_space
*mapping
= file
->f_mapping
;
560 gfp_t gfp_mask
= mapping_gfp_mask(mapping
);
561 unsigned int offset
, this_len
;
567 * make sure the data in this buffer is uptodate
569 ret
= buf
->ops
->pin(pipe
, buf
);
573 index
= sd
->pos
>> PAGE_CACHE_SHIFT
;
574 offset
= sd
->pos
& ~PAGE_CACHE_MASK
;
577 if (this_len
+ offset
> PAGE_CACHE_SIZE
)
578 this_len
= PAGE_CACHE_SIZE
- offset
;
581 * Reuse buf page, if SPLICE_F_MOVE is set and we are doing a full
584 if ((sd
->flags
& SPLICE_F_MOVE
) && this_len
== PAGE_CACHE_SIZE
) {
586 * If steal succeeds, buf->page is now pruned from the
587 * pagecache and we can reuse it. The page will also be
588 * locked on successful return.
590 if (buf
->ops
->steal(pipe
, buf
))
594 if (add_to_page_cache(page
, mapping
, index
, gfp_mask
)) {
599 page_cache_get(page
);
601 if (!(buf
->flags
& PIPE_BUF_FLAG_LRU
))
605 page
= find_lock_page(mapping
, index
);
608 page
= page_cache_alloc_cold(mapping
);
613 * This will also lock the page
615 ret
= add_to_page_cache_lru(page
, mapping
, index
,
622 * We get here with the page locked. If the page is also
623 * uptodate, we don't need to do more. If it isn't, we
624 * may need to bring it in if we are not going to overwrite
627 if (!PageUptodate(page
)) {
628 if (this_len
< PAGE_CACHE_SIZE
) {
629 ret
= mapping
->a_ops
->readpage(file
, page
);
635 if (!PageUptodate(page
)) {
637 * Page got invalidated, repeat.
639 if (!page
->mapping
) {
641 page_cache_release(page
);
648 SetPageUptodate(page
);
652 ret
= mapping
->a_ops
->prepare_write(file
, page
, offset
, offset
+this_len
);
654 loff_t isize
= i_size_read(mapping
->host
);
656 if (ret
!= AOP_TRUNCATED_PAGE
)
658 page_cache_release(page
);
659 if (ret
== AOP_TRUNCATED_PAGE
)
663 * prepare_write() may have instantiated a few blocks
664 * outside i_size. Trim these off again.
666 if (sd
->pos
+ this_len
> isize
)
667 vmtruncate(mapping
->host
, isize
);
672 if (buf
->page
!= page
) {
674 * Careful, ->map() uses KM_USER0!
676 char *src
= buf
->ops
->map(pipe
, buf
, 1);
677 char *dst
= kmap_atomic(page
, KM_USER1
);
679 memcpy(dst
+ offset
, src
+ buf
->offset
, this_len
);
680 flush_dcache_page(page
);
681 kunmap_atomic(dst
, KM_USER1
);
682 buf
->ops
->unmap(pipe
, buf
, src
);
685 ret
= mapping
->a_ops
->commit_write(file
, page
, offset
, offset
+this_len
);
688 * Return the number of bytes written and mark page as
689 * accessed, we are now done!
692 mark_page_accessed(page
);
693 balance_dirty_pages_ratelimited(mapping
);
694 } else if (ret
== AOP_TRUNCATED_PAGE
) {
695 page_cache_release(page
);
699 page_cache_release(page
);
706 * Pipe input worker. Most of this logic works like a regular pipe, the
707 * key here is the 'actor' worker passed in that actually moves the data
708 * to the wanted destination. See pipe_to_file/pipe_to_sendpage above.
710 ssize_t
splice_from_pipe(struct pipe_inode_info
*pipe
, struct file
*out
,
711 loff_t
*ppos
, size_t len
, unsigned int flags
,
714 int ret
, do_wakeup
, err
;
715 struct splice_desc sd
;
726 mutex_lock(&pipe
->inode
->i_mutex
);
730 struct pipe_buffer
*buf
= pipe
->bufs
+ pipe
->curbuf
;
731 struct pipe_buf_operations
*ops
= buf
->ops
;
734 if (sd
.len
> sd
.total_len
)
735 sd
.len
= sd
.total_len
;
737 err
= actor(pipe
, buf
, &sd
);
739 if (!ret
&& err
!= -ENODATA
)
757 ops
->release(pipe
, buf
);
758 pipe
->curbuf
= (pipe
->curbuf
+ 1) & (PIPE_BUFFERS
- 1);
772 if (!pipe
->waiting_writers
) {
777 if (flags
& SPLICE_F_NONBLOCK
) {
783 if (signal_pending(current
)) {
791 if (waitqueue_active(&pipe
->wait
))
792 wake_up_interruptible_sync(&pipe
->wait
);
793 kill_fasync(&pipe
->fasync_writers
, SIGIO
, POLL_OUT
);
801 mutex_unlock(&pipe
->inode
->i_mutex
);
805 if (waitqueue_active(&pipe
->wait
))
806 wake_up_interruptible(&pipe
->wait
);
807 kill_fasync(&pipe
->fasync_writers
, SIGIO
, POLL_OUT
);
814 * generic_file_splice_write - splice data from a pipe to a file
816 * @out: file to write to
817 * @len: number of bytes to splice
818 * @flags: splice modifier flags
820 * Will either move or copy pages (determined by @flags options) from
821 * the given pipe inode to the given file.
825 generic_file_splice_write(struct pipe_inode_info
*pipe
, struct file
*out
,
826 loff_t
*ppos
, size_t len
, unsigned int flags
)
828 struct address_space
*mapping
= out
->f_mapping
;
831 ret
= splice_from_pipe(pipe
, out
, ppos
, len
, flags
, pipe_to_file
);
833 struct inode
*inode
= mapping
->host
;
838 * If file or inode is SYNC and we actually wrote some data,
841 if (unlikely((out
->f_flags
& O_SYNC
) || IS_SYNC(inode
))) {
844 mutex_lock(&inode
->i_mutex
);
845 err
= generic_osync_inode(inode
, mapping
,
846 OSYNC_METADATA
|OSYNC_DATA
);
847 mutex_unlock(&inode
->i_mutex
);
857 EXPORT_SYMBOL(generic_file_splice_write
);
860 * generic_splice_sendpage - splice data from a pipe to a socket
862 * @out: socket to write to
863 * @len: number of bytes to splice
864 * @flags: splice modifier flags
866 * Will send @len bytes from the pipe to a network socket. No data copying
870 ssize_t
generic_splice_sendpage(struct pipe_inode_info
*pipe
, struct file
*out
,
871 loff_t
*ppos
, size_t len
, unsigned int flags
)
873 return splice_from_pipe(pipe
, out
, ppos
, len
, flags
, pipe_to_sendpage
);
876 EXPORT_SYMBOL(generic_splice_sendpage
);
879 * Attempt to initiate a splice from pipe to file.
881 static long do_splice_from(struct pipe_inode_info
*pipe
, struct file
*out
,
882 loff_t
*ppos
, size_t len
, unsigned int flags
)
886 if (unlikely(!out
->f_op
|| !out
->f_op
->splice_write
))
889 if (unlikely(!(out
->f_mode
& FMODE_WRITE
)))
892 ret
= rw_verify_area(WRITE
, out
, ppos
, len
);
893 if (unlikely(ret
< 0))
896 return out
->f_op
->splice_write(pipe
, out
, ppos
, len
, flags
);
900 * Attempt to initiate a splice from a file to a pipe.
902 static long do_splice_to(struct file
*in
, loff_t
*ppos
,
903 struct pipe_inode_info
*pipe
, size_t len
,
909 if (unlikely(!in
->f_op
|| !in
->f_op
->splice_read
))
912 if (unlikely(!(in
->f_mode
& FMODE_READ
)))
915 ret
= rw_verify_area(READ
, in
, ppos
, len
);
916 if (unlikely(ret
< 0))
919 isize
= i_size_read(in
->f_mapping
->host
);
920 if (unlikely(*ppos
>= isize
))
923 left
= isize
- *ppos
;
924 if (unlikely(left
< len
))
927 return in
->f_op
->splice_read(in
, ppos
, pipe
, len
, flags
);
930 long do_splice_direct(struct file
*in
, loff_t
*ppos
, struct file
*out
,
931 size_t len
, unsigned int flags
)
933 struct pipe_inode_info
*pipe
;
940 * We require the input being a regular file, as we don't want to
941 * randomly drop data for eg socket -> socket splicing. Use the
942 * piped splicing for that!
944 i_mode
= in
->f_dentry
->d_inode
->i_mode
;
945 if (unlikely(!S_ISREG(i_mode
) && !S_ISBLK(i_mode
)))
949 * neither in nor out is a pipe, setup an internal pipe attached to
950 * 'out' and transfer the wanted data from 'in' to 'out' through that
952 pipe
= current
->splice_pipe
;
953 if (unlikely(!pipe
)) {
954 pipe
= alloc_pipe_info(NULL
);
959 * We don't have an immediate reader, but we'll read the stuff
960 * out of the pipe right after the splice_to_pipe(). So set
961 * PIPE_READERS appropriately.
965 current
->splice_pipe
= pipe
;
976 size_t read_len
, max_read_len
;
979 * Do at most PIPE_BUFFERS pages worth of transfer:
981 max_read_len
= min(len
, (size_t)(PIPE_BUFFERS
*PAGE_SIZE
));
983 ret
= do_splice_to(in
, ppos
, pipe
, max_read_len
, flags
);
984 if (unlikely(ret
< 0))
990 * NOTE: nonblocking mode only applies to the input. We
991 * must not do the output in nonblocking mode as then we
992 * could get stuck data in the internal pipe:
994 ret
= do_splice_from(pipe
, out
, &out_off
, read_len
,
995 flags
& ~SPLICE_F_NONBLOCK
);
996 if (unlikely(ret
< 0))
1003 * In nonblocking mode, if we got back a short read then
1004 * that was due to either an IO error or due to the
1005 * pagecache entry not being there. In the IO error case
1006 * the _next_ splice attempt will produce a clean IO error
1007 * return value (not a short read), so in both cases it's
1008 * correct to break out of the loop here:
1010 if ((flags
& SPLICE_F_NONBLOCK
) && (read_len
< max_read_len
))
1014 pipe
->nrbufs
= pipe
->curbuf
= 0;
1020 * If we did an incomplete transfer we must release
1021 * the pipe buffers in question:
1023 for (i
= 0; i
< PIPE_BUFFERS
; i
++) {
1024 struct pipe_buffer
*buf
= pipe
->bufs
+ i
;
1027 buf
->ops
->release(pipe
, buf
);
1031 pipe
->nrbufs
= pipe
->curbuf
= 0;
1034 * If we transferred some data, return the number of bytes:
1042 EXPORT_SYMBOL(do_splice_direct
);
1045 * Determine where to splice to/from.
1047 static long do_splice(struct file
*in
, loff_t __user
*off_in
,
1048 struct file
*out
, loff_t __user
*off_out
,
1049 size_t len
, unsigned int flags
)
1051 struct pipe_inode_info
*pipe
;
1052 loff_t offset
, *off
;
1055 pipe
= in
->f_dentry
->d_inode
->i_pipe
;
1060 if (out
->f_op
->llseek
== no_llseek
)
1062 if (copy_from_user(&offset
, off_out
, sizeof(loff_t
)))
1068 ret
= do_splice_from(pipe
, out
, off
, len
, flags
);
1070 if (off_out
&& copy_to_user(off_out
, off
, sizeof(loff_t
)))
1076 pipe
= out
->f_dentry
->d_inode
->i_pipe
;
1081 if (in
->f_op
->llseek
== no_llseek
)
1083 if (copy_from_user(&offset
, off_in
, sizeof(loff_t
)))
1089 ret
= do_splice_to(in
, off
, pipe
, len
, flags
);
1091 if (off_in
&& copy_to_user(off_in
, off
, sizeof(loff_t
)))
1101 * Map an iov into an array of pages and offset/length tupples. With the
1102 * partial_page structure, we can map several non-contiguous ranges into
1103 * our ones pages[] map instead of splitting that operation into pieces.
1104 * Could easily be exported as a generic helper for other users, in which
1105 * case one would probably want to add a 'max_nr_pages' parameter as well.
1107 static int get_iovec_page_array(const struct iovec __user
*iov
,
1108 unsigned int nr_vecs
, struct page
**pages
,
1109 struct partial_page
*partial
, int aligned
)
1111 int buffers
= 0, error
= 0;
1114 * It's ok to take the mmap_sem for reading, even
1115 * across a "get_user()".
1117 down_read(¤t
->mm
->mmap_sem
);
1120 unsigned long off
, npages
;
1126 * Get user address base and length for this iovec.
1128 error
= get_user(base
, &iov
->iov_base
);
1129 if (unlikely(error
))
1131 error
= get_user(len
, &iov
->iov_len
);
1132 if (unlikely(error
))
1136 * Sanity check this iovec. 0 read succeeds.
1141 if (unlikely(!base
))
1145 * Get this base offset and number of pages, then map
1146 * in the user pages.
1148 off
= (unsigned long) base
& ~PAGE_MASK
;
1151 * If asked for alignment, the offset must be zero and the
1152 * length a multiple of the PAGE_SIZE.
1155 if (aligned
&& (off
|| len
& ~PAGE_MASK
))
1158 npages
= (off
+ len
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
1159 if (npages
> PIPE_BUFFERS
- buffers
)
1160 npages
= PIPE_BUFFERS
- buffers
;
1162 error
= get_user_pages(current
, current
->mm
,
1163 (unsigned long) base
, npages
, 0, 0,
1164 &pages
[buffers
], NULL
);
1166 if (unlikely(error
<= 0))
1170 * Fill this contiguous range into the partial page map.
1172 for (i
= 0; i
< error
; i
++) {
1173 const int plen
= min_t(size_t, len
, PAGE_SIZE
- off
);
1175 partial
[buffers
].offset
= off
;
1176 partial
[buffers
].len
= plen
;
1184 * We didn't complete this iov, stop here since it probably
1185 * means we have to move some of this into a pipe to
1186 * be able to continue.
1192 * Don't continue if we mapped fewer pages than we asked for,
1193 * or if we mapped the max number of pages that we have
1196 if (error
< npages
|| buffers
== PIPE_BUFFERS
)
1203 up_read(¤t
->mm
->mmap_sem
);
1212 * vmsplice splices a user address range into a pipe. It can be thought of
1213 * as splice-from-memory, where the regular splice is splice-from-file (or
1214 * to file). In both cases the output is a pipe, naturally.
1216 * Note that vmsplice only supports splicing _from_ user memory to a pipe,
1217 * not the other way around. Splicing from user memory is a simple operation
1218 * that can be supported without any funky alignment restrictions or nasty
1219 * vm tricks. We simply map in the user memory and fill them into a pipe.
1220 * The reverse isn't quite as easy, though. There are two possible solutions
1223 * - memcpy() the data internally, at which point we might as well just
1224 * do a regular read() on the buffer anyway.
1225 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1226 * has restriction limitations on both ends of the pipe).
1228 * Alas, it isn't here.
1231 static long do_vmsplice(struct file
*file
, const struct iovec __user
*iov
,
1232 unsigned long nr_segs
, unsigned int flags
)
1234 struct pipe_inode_info
*pipe
= file
->f_dentry
->d_inode
->i_pipe
;
1235 struct page
*pages
[PIPE_BUFFERS
];
1236 struct partial_page partial
[PIPE_BUFFERS
];
1237 struct splice_pipe_desc spd
= {
1241 .ops
= &user_page_pipe_buf_ops
,
1244 if (unlikely(!pipe
))
1246 if (unlikely(nr_segs
> UIO_MAXIOV
))
1248 else if (unlikely(!nr_segs
))
1251 spd
.nr_pages
= get_iovec_page_array(iov
, nr_segs
, pages
, partial
,
1252 flags
& SPLICE_F_GIFT
);
1253 if (spd
.nr_pages
<= 0)
1254 return spd
.nr_pages
;
1256 return splice_to_pipe(pipe
, &spd
);
1259 asmlinkage
long sys_vmsplice(int fd
, const struct iovec __user
*iov
,
1260 unsigned long nr_segs
, unsigned int flags
)
1267 file
= fget_light(fd
, &fput
);
1269 if (file
->f_mode
& FMODE_WRITE
)
1270 error
= do_vmsplice(file
, iov
, nr_segs
, flags
);
1272 fput_light(file
, fput
);
1278 asmlinkage
long sys_splice(int fd_in
, loff_t __user
*off_in
,
1279 int fd_out
, loff_t __user
*off_out
,
1280 size_t len
, unsigned int flags
)
1283 struct file
*in
, *out
;
1284 int fput_in
, fput_out
;
1290 in
= fget_light(fd_in
, &fput_in
);
1292 if (in
->f_mode
& FMODE_READ
) {
1293 out
= fget_light(fd_out
, &fput_out
);
1295 if (out
->f_mode
& FMODE_WRITE
)
1296 error
= do_splice(in
, off_in
,
1299 fput_light(out
, fput_out
);
1303 fput_light(in
, fput_in
);
1310 * Link contents of ipipe to opipe.
1312 static int link_pipe(struct pipe_inode_info
*ipipe
,
1313 struct pipe_inode_info
*opipe
,
1314 size_t len
, unsigned int flags
)
1316 struct pipe_buffer
*ibuf
, *obuf
;
1317 int ret
, do_wakeup
, i
, ipipe_first
;
1319 ret
= do_wakeup
= ipipe_first
= 0;
1322 * Potential ABBA deadlock, work around it by ordering lock
1323 * grabbing by inode address. Otherwise two different processes
1324 * could deadlock (one doing tee from A -> B, the other from B -> A).
1326 if (ipipe
->inode
< opipe
->inode
) {
1328 mutex_lock(&ipipe
->inode
->i_mutex
);
1329 mutex_lock(&opipe
->inode
->i_mutex
);
1331 mutex_lock(&opipe
->inode
->i_mutex
);
1332 mutex_lock(&ipipe
->inode
->i_mutex
);
1336 if (!opipe
->readers
) {
1337 send_sig(SIGPIPE
, current
, 0);
1342 if (ipipe
->nrbufs
- i
) {
1343 ibuf
= ipipe
->bufs
+ ((ipipe
->curbuf
+ i
) & (PIPE_BUFFERS
- 1));
1346 * If we have room, fill this buffer
1348 if (opipe
->nrbufs
< PIPE_BUFFERS
) {
1349 int nbuf
= (opipe
->curbuf
+ opipe
->nrbufs
) & (PIPE_BUFFERS
- 1);
1352 * Get a reference to this pipe buffer,
1353 * so we can copy the contents over.
1355 ibuf
->ops
->get(ipipe
, ibuf
);
1357 obuf
= opipe
->bufs
+ nbuf
;
1361 * Don't inherit the gift flag, we need to
1362 * prevent multiple steals of this page.
1364 obuf
->flags
&= ~PIPE_BUF_FLAG_GIFT
;
1366 if (obuf
->len
> len
)
1376 if (opipe
->nrbufs
< PIPE_BUFFERS
)
1381 * We have input available, but no output room.
1382 * If we already copied data, return that. If we
1383 * need to drop the opipe lock, it must be ordered
1384 * last to avoid deadlocks.
1386 if ((flags
& SPLICE_F_NONBLOCK
) || !ipipe_first
) {
1391 if (signal_pending(current
)) {
1398 if (waitqueue_active(&opipe
->wait
))
1399 wake_up_interruptible(&opipe
->wait
);
1400 kill_fasync(&opipe
->fasync_readers
, SIGIO
, POLL_IN
);
1404 opipe
->waiting_writers
++;
1406 opipe
->waiting_writers
--;
1411 * No input buffers, do the usual checks for available
1412 * writers and blocking and wait if necessary
1414 if (!ipipe
->writers
)
1416 if (!ipipe
->waiting_writers
) {
1421 * pipe_wait() drops the ipipe mutex. To avoid deadlocks
1422 * with another process, we can only safely do that if
1423 * the ipipe lock is ordered last.
1425 if ((flags
& SPLICE_F_NONBLOCK
) || ipipe_first
) {
1430 if (signal_pending(current
)) {
1436 if (waitqueue_active(&ipipe
->wait
))
1437 wake_up_interruptible_sync(&ipipe
->wait
);
1438 kill_fasync(&ipipe
->fasync_writers
, SIGIO
, POLL_OUT
);
1443 mutex_unlock(&ipipe
->inode
->i_mutex
);
1444 mutex_unlock(&opipe
->inode
->i_mutex
);
1448 if (waitqueue_active(&opipe
->wait
))
1449 wake_up_interruptible(&opipe
->wait
);
1450 kill_fasync(&opipe
->fasync_readers
, SIGIO
, POLL_IN
);
1457 * This is a tee(1) implementation that works on pipes. It doesn't copy
1458 * any data, it simply references the 'in' pages on the 'out' pipe.
1459 * The 'flags' used are the SPLICE_F_* variants, currently the only
1460 * applicable one is SPLICE_F_NONBLOCK.
1462 static long do_tee(struct file
*in
, struct file
*out
, size_t len
,
1465 struct pipe_inode_info
*ipipe
= in
->f_dentry
->d_inode
->i_pipe
;
1466 struct pipe_inode_info
*opipe
= out
->f_dentry
->d_inode
->i_pipe
;
1469 * Link ipipe to the two output pipes, consuming as we go along.
1472 return link_pipe(ipipe
, opipe
, len
, flags
);
1477 asmlinkage
long sys_tee(int fdin
, int fdout
, size_t len
, unsigned int flags
)
1486 in
= fget_light(fdin
, &fput_in
);
1488 if (in
->f_mode
& FMODE_READ
) {
1490 struct file
*out
= fget_light(fdout
, &fput_out
);
1493 if (out
->f_mode
& FMODE_WRITE
)
1494 error
= do_tee(in
, out
, len
, flags
);
1495 fput_light(out
, fput_out
);
1498 fput_light(in
, fput_in
);