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 and fixing the initial implementation
15 * Copyright (C) 2005 Jens Axboe <axboe@suse.de>
16 * Copyright (C) 2005 Linus Torvalds <torvalds@osdl.org>
20 #include <linux/file.h>
21 #include <linux/pagemap.h>
22 #include <linux/pipe_fs_i.h>
23 #include <linux/mm_inline.h>
24 #include <linux/swap.h>
25 #include <linux/writeback.h>
26 #include <linux/buffer_head.h>
27 #include <linux/module.h>
28 #include <linux/syscalls.h>
31 * Passed to the actors
34 unsigned int len, total_len; /* current and remaining length */
35 unsigned int flags; /* splice flags */
36 struct file *file; /* file to read/write */
37 loff_t pos; /* file position */
41 * Attempt to steal a page from a pipe buffer. This should perhaps go into
42 * a vm helper function, it's already simplified quite a bit by the
43 * addition of remove_mapping(). If success is returned, the caller may
44 * attempt to reuse this page for another destination.
46 static int page_cache_pipe_buf_steal(struct pipe_inode_info *info,
47 struct pipe_buffer *buf)
49 struct page *page = buf->page;
50 struct address_space *mapping = page_mapping(page);
52 WARN_ON(!PageLocked(page));
53 WARN_ON(!PageUptodate(page));
56 * At least for ext2 with nobh option, we need to wait on writeback
57 * completing on this page, since we'll remove it from the pagecache.
58 * Otherwise truncate wont wait on the page, allowing the disk
59 * blocks to be reused by someone else before we actually wrote our
60 * data to them. fs corruption ensues.
62 wait_on_page_writeback(page);
64 if (PagePrivate(page))
65 try_to_release_page(page, mapping_gfp_mask(mapping));
67 if (!remove_mapping(mapping, page))
70 buf->flags |= PIPE_BUF_FLAG_STOLEN | PIPE_BUF_FLAG_LRU;
74 static void page_cache_pipe_buf_release(struct pipe_inode_info *info,
75 struct pipe_buffer *buf)
77 page_cache_release(buf->page);
79 buf->flags &= ~(PIPE_BUF_FLAG_STOLEN | PIPE_BUF_FLAG_LRU);
82 static void *page_cache_pipe_buf_map(struct file *file,
83 struct pipe_inode_info *info,
84 struct pipe_buffer *buf)
86 struct page *page = buf->page;
90 if (!PageUptodate(page)) {
97 return ERR_PTR(-ENODATA);
100 return kmap(buf->page);
103 static void page_cache_pipe_buf_unmap(struct pipe_inode_info *info,
104 struct pipe_buffer *buf)
106 unlock_page(buf->page);
110 static struct pipe_buf_operations page_cache_pipe_buf_ops = {
112 .map = page_cache_pipe_buf_map,
113 .unmap = page_cache_pipe_buf_unmap,
114 .release = page_cache_pipe_buf_release,
115 .steal = page_cache_pipe_buf_steal,
119 * Pipe output worker. This sets up our pipe format with the page cache
120 * pipe buffer operations. Otherwise very similar to the regular pipe_writev().
122 static ssize_t move_to_pipe(struct inode *inode, struct page **pages,
123 int nr_pages, unsigned long offset,
124 unsigned long len, unsigned int flags)
126 struct pipe_inode_info *info;
127 int ret, do_wakeup, i;
133 mutex_lock(PIPE_MUTEX(*inode));
135 info = inode->i_pipe;
139 if (!PIPE_READERS(*inode)) {
140 send_sig(SIGPIPE, current, 0);
147 if (bufs < PIPE_BUFFERS) {
148 int newbuf = (info->curbuf + bufs) & (PIPE_BUFFERS - 1);
149 struct pipe_buffer *buf = info->bufs + newbuf;
150 struct page *page = pages[i++];
151 unsigned long this_len;
153 this_len = PAGE_CACHE_SIZE - offset;
158 buf->offset = offset;
160 buf->ops = &page_cache_pipe_buf_ops;
161 info->nrbufs = ++bufs;
171 if (bufs < PIPE_BUFFERS)
177 if (flags & SPLICE_F_NONBLOCK) {
183 if (signal_pending(current)) {
191 if (waitqueue_active(PIPE_WAIT(*inode)))
192 wake_up_interruptible_sync(PIPE_WAIT(*inode));
193 kill_fasync(PIPE_FASYNC_READERS(*inode), SIGIO,
198 PIPE_WAITING_WRITERS(*inode)++;
200 PIPE_WAITING_WRITERS(*inode)--;
203 mutex_unlock(PIPE_MUTEX(*inode));
207 if (waitqueue_active(PIPE_WAIT(*inode)))
208 wake_up_interruptible(PIPE_WAIT(*inode));
209 kill_fasync(PIPE_FASYNC_READERS(*inode), SIGIO, POLL_IN);
213 page_cache_release(pages[i++]);
218 static int __generic_file_splice_read(struct file *in, struct inode *pipe,
219 size_t len, unsigned int flags)
221 struct address_space *mapping = in->f_mapping;
222 unsigned int offset, nr_pages;
223 struct page *pages[PIPE_BUFFERS];
228 index = in->f_pos >> PAGE_CACHE_SHIFT;
229 offset = in->f_pos & ~PAGE_CACHE_MASK;
230 nr_pages = (len + offset + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
232 if (nr_pages > PIPE_BUFFERS)
233 nr_pages = PIPE_BUFFERS;
236 * initiate read-ahead on this page range
238 do_page_cache_readahead(mapping, in, index, nr_pages);
241 * now fill in the holes
243 for (i = 0; i < nr_pages; i++, index++) {
245 * no page there, look one up / create it
247 page = find_or_create_page(mapping, index,
248 mapping_gfp_mask(mapping));
252 if (PageUptodate(page))
255 int error = mapping->a_ops->readpage(in, page);
257 if (unlikely(error)) {
258 page_cache_release(page);
266 return move_to_pipe(pipe, pages, i, offset, len, flags);
272 * generic_file_splice_read - splice data from file to a pipe
273 * @in: file to splice from
274 * @pipe: pipe to splice to
275 * @len: number of bytes to splice
276 * @flags: splice modifier flags
278 * Will read pages from given file and fill them into a pipe.
281 ssize_t generic_file_splice_read(struct file *in, struct inode *pipe,
282 size_t len, unsigned int flags)
290 ret = __generic_file_splice_read(in, pipe, len, flags);
299 if (!(flags & SPLICE_F_NONBLOCK))
311 EXPORT_SYMBOL(generic_file_splice_read);
314 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
317 static int pipe_to_sendpage(struct pipe_inode_info *info,
318 struct pipe_buffer *buf, struct splice_desc *sd)
320 struct file *file = sd->file;
321 loff_t pos = sd->pos;
328 * sub-optimal, but we are limited by the pipe ->map. we don't
329 * need a kmap'ed buffer here, we just want to make sure we
330 * have the page pinned if the pipe page originates from the
333 ptr = buf->ops->map(file, info, buf);
337 offset = pos & ~PAGE_CACHE_MASK;
338 more = (sd->flags & SPLICE_F_MORE) || sd->len < sd->total_len;
340 ret = file->f_op->sendpage(file, buf->page, offset, sd->len, &pos,more);
342 buf->ops->unmap(info, buf);
350 * This is a little more tricky than the file -> pipe splicing. There are
351 * basically three cases:
353 * - Destination page already exists in the address space and there
354 * are users of it. For that case we have no other option that
355 * copying the data. Tough luck.
356 * - Destination page already exists in the address space, but there
357 * are no users of it. Make sure it's uptodate, then drop it. Fall
358 * through to last case.
359 * - Destination page does not exist, we can add the pipe page to
360 * the page cache and avoid the copy.
362 * If asked to move pages to the output file (SPLICE_F_MOVE is set in
363 * sd->flags), we attempt to migrate pages from the pipe to the output
364 * file address space page cache. This is possible if no one else has
365 * the pipe page referenced outside of the pipe and page cache. If
366 * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create
367 * a new page in the output file page cache and fill/dirty that.
369 static int pipe_to_file(struct pipe_inode_info *info, struct pipe_buffer *buf,
370 struct splice_desc *sd)
372 struct file *file = sd->file;
373 struct address_space *mapping = file->f_mapping;
374 gfp_t gfp_mask = mapping_gfp_mask(mapping);
382 * after this, page will be locked and unmapped
384 src = buf->ops->map(file, info, buf);
388 index = sd->pos >> PAGE_CACHE_SHIFT;
389 offset = sd->pos & ~PAGE_CACHE_MASK;
392 * reuse buf page, if SPLICE_F_MOVE is set
394 if (sd->flags & SPLICE_F_MOVE) {
396 * If steal succeeds, buf->page is now pruned from the vm
397 * side (LRU and page cache) and we can reuse it.
399 if (buf->ops->steal(info, buf))
403 if (add_to_page_cache(page, mapping, index, gfp_mask))
406 if (!(buf->flags & PIPE_BUF_FLAG_LRU))
411 page = find_or_create_page(mapping, index, gfp_mask);
416 * If the page is uptodate, it is also locked. If it isn't
417 * uptodate, we can mark it uptodate if we are filling the
418 * full page. Otherwise we need to read it in first...
420 if (!PageUptodate(page)) {
421 if (sd->len < PAGE_CACHE_SIZE) {
422 ret = mapping->a_ops->readpage(file, page);
428 if (!PageUptodate(page)) {
430 * page got invalidated, repeat
432 if (!page->mapping) {
434 page_cache_release(page);
441 WARN_ON(!PageLocked(page));
442 SetPageUptodate(page);
447 ret = mapping->a_ops->prepare_write(file, page, 0, sd->len);
448 if (ret == AOP_TRUNCATED_PAGE) {
449 page_cache_release(page);
454 if (!(buf->flags & PIPE_BUF_FLAG_STOLEN)) {
455 char *dst = kmap_atomic(page, KM_USER0);
457 memcpy(dst + offset, src + buf->offset, sd->len);
458 flush_dcache_page(page);
459 kunmap_atomic(dst, KM_USER0);
462 ret = mapping->a_ops->commit_write(file, page, 0, sd->len);
463 if (ret == AOP_TRUNCATED_PAGE) {
464 page_cache_release(page);
469 mark_page_accessed(page);
470 balance_dirty_pages_ratelimited(mapping);
472 if (!(buf->flags & PIPE_BUF_FLAG_STOLEN)) {
473 page_cache_release(page);
477 buf->ops->unmap(info, buf);
481 typedef int (splice_actor)(struct pipe_inode_info *, struct pipe_buffer *,
482 struct splice_desc *);
485 * Pipe input worker. Most of this logic works like a regular pipe, the
486 * key here is the 'actor' worker passed in that actually moves the data
487 * to the wanted destination. See pipe_to_file/pipe_to_sendpage above.
489 static ssize_t move_from_pipe(struct inode *inode, struct file *out,
490 size_t len, unsigned int flags,
493 struct pipe_inode_info *info;
494 int ret, do_wakeup, err;
495 struct splice_desc sd;
505 mutex_lock(PIPE_MUTEX(*inode));
507 info = inode->i_pipe;
509 int bufs = info->nrbufs;
512 int curbuf = info->curbuf;
513 struct pipe_buffer *buf = info->bufs + curbuf;
514 struct pipe_buf_operations *ops = buf->ops;
517 if (sd.len > sd.total_len)
518 sd.len = sd.total_len;
520 err = actor(info, buf, &sd);
522 if (!ret && err != -ENODATA)
529 buf->offset += sd.len;
533 ops->release(info, buf);
534 curbuf = (curbuf + 1) & (PIPE_BUFFERS - 1);
535 info->curbuf = curbuf;
536 info->nrbufs = --bufs;
541 sd.total_len -= sd.len;
548 if (!PIPE_WRITERS(*inode))
550 if (!PIPE_WAITING_WRITERS(*inode)) {
555 if (flags & SPLICE_F_NONBLOCK) {
561 if (signal_pending(current)) {
569 if (waitqueue_active(PIPE_WAIT(*inode)))
570 wake_up_interruptible_sync(PIPE_WAIT(*inode));
571 kill_fasync(PIPE_FASYNC_WRITERS(*inode),SIGIO,POLL_OUT);
578 mutex_unlock(PIPE_MUTEX(*inode));
582 if (waitqueue_active(PIPE_WAIT(*inode)))
583 wake_up_interruptible(PIPE_WAIT(*inode));
584 kill_fasync(PIPE_FASYNC_WRITERS(*inode), SIGIO, POLL_OUT);
587 mutex_lock(&out->f_mapping->host->i_mutex);
589 mutex_unlock(&out->f_mapping->host->i_mutex);
595 * generic_file_splice_write - splice data from a pipe to a file
597 * @out: file to write to
598 * @len: number of bytes to splice
599 * @flags: splice modifier flags
601 * Will either move or copy pages (determined by @flags options) from
602 * the given pipe inode to the given file.
605 ssize_t generic_file_splice_write(struct inode *inode, struct file *out,
606 size_t len, unsigned int flags)
608 struct address_space *mapping = out->f_mapping;
609 ssize_t ret = move_from_pipe(inode, out, len, flags, pipe_to_file);
612 * if file or inode is SYNC and we actually wrote some data, sync it
614 if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(mapping->host))
616 struct inode *inode = mapping->host;
619 mutex_lock(&inode->i_mutex);
620 err = generic_osync_inode(mapping->host, mapping,
621 OSYNC_METADATA|OSYNC_DATA);
622 mutex_unlock(&inode->i_mutex);
631 EXPORT_SYMBOL(generic_file_splice_write);
634 * generic_splice_sendpage - splice data from a pipe to a socket
636 * @out: socket to write to
637 * @len: number of bytes to splice
638 * @flags: splice modifier flags
640 * Will send @len bytes from the pipe to a network socket. No data copying
644 ssize_t generic_splice_sendpage(struct inode *inode, struct file *out,
645 size_t len, unsigned int flags)
647 return move_from_pipe(inode, out, len, flags, pipe_to_sendpage);
650 EXPORT_SYMBOL(generic_splice_sendpage);
653 * Attempt to initiate a splice from pipe to file.
655 static long do_splice_from(struct inode *pipe, struct file *out, size_t len,
661 if (!out->f_op || !out->f_op->splice_write)
664 if (!(out->f_mode & FMODE_WRITE))
668 ret = rw_verify_area(WRITE, out, &pos, len);
669 if (unlikely(ret < 0))
672 return out->f_op->splice_write(pipe, out, len, flags);
676 * Attempt to initiate a splice from a file to a pipe.
678 static long do_splice_to(struct file *in, struct inode *pipe, size_t len,
681 loff_t pos, isize, left;
684 if (!in->f_op || !in->f_op->splice_read)
687 if (!(in->f_mode & FMODE_READ))
691 ret = rw_verify_area(READ, in, &pos, len);
692 if (unlikely(ret < 0))
695 isize = i_size_read(in->f_mapping->host);
696 if (unlikely(in->f_pos >= isize))
699 left = isize - in->f_pos;
703 return in->f_op->splice_read(in, pipe, len, flags);
707 * Determine where to splice to/from.
709 static long do_splice(struct file *in, struct file *out, size_t len,
714 pipe = in->f_dentry->d_inode;
716 return do_splice_from(pipe, out, len, flags);
718 pipe = out->f_dentry->d_inode;
720 return do_splice_to(in, pipe, len, flags);
725 asmlinkage long sys_splice(int fdin, int fdout, size_t len, unsigned int flags)
728 struct file *in, *out;
729 int fput_in, fput_out;
735 in = fget_light(fdin, &fput_in);
737 if (in->f_mode & FMODE_READ) {
738 out = fget_light(fdout, &fput_out);
740 if (out->f_mode & FMODE_WRITE)
741 error = do_splice(in, out, len, flags);
742 fput_light(out, fput_out);
746 fput_light(in, fput_in);