Revert "kobject: don't block for each kobject_uevent".
[linux-2.6/mini2440.git] / fs / splice.c
blob5384a90665d05ef33053a28360fa9b51cf460b3d
1 /*
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>
20 #include <linux/fs.h>
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>
35 * Attempt to steal a page from a pipe buffer. This should perhaps go into
36 * a vm helper function, it's already simplified quite a bit by the
37 * addition of remove_mapping(). If success is returned, the caller may
38 * attempt to reuse this page for another destination.
40 static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
41 struct pipe_buffer *buf)
43 struct page *page = buf->page;
44 struct address_space *mapping;
46 lock_page(page);
48 mapping = page_mapping(page);
49 if (mapping) {
50 WARN_ON(!PageUptodate(page));
53 * At least for ext2 with nobh option, we need to wait on
54 * writeback completing on this page, since we'll remove it
55 * from the pagecache. Otherwise truncate wont wait on the
56 * page, allowing the disk blocks to be reused by someone else
57 * before we actually wrote our data to them. fs corruption
58 * ensues.
60 wait_on_page_writeback(page);
62 if (page_has_private(page) &&
63 !try_to_release_page(page, GFP_KERNEL))
64 goto out_unlock;
67 * If we succeeded in removing the mapping, set LRU flag
68 * and return good.
70 if (remove_mapping(mapping, page)) {
71 buf->flags |= PIPE_BUF_FLAG_LRU;
72 return 0;
77 * Raced with truncate or failed to remove page from current
78 * address space, unlock and return failure.
80 out_unlock:
81 unlock_page(page);
82 return 1;
85 static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
86 struct pipe_buffer *buf)
88 page_cache_release(buf->page);
89 buf->flags &= ~PIPE_BUF_FLAG_LRU;
93 * Check whether the contents of buf is OK to access. Since the content
94 * is a page cache page, IO may be in flight.
96 static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
97 struct pipe_buffer *buf)
99 struct page *page = buf->page;
100 int err;
102 if (!PageUptodate(page)) {
103 lock_page(page);
106 * Page got truncated/unhashed. This will cause a 0-byte
107 * splice, if this is the first page.
109 if (!page->mapping) {
110 err = -ENODATA;
111 goto error;
115 * Uh oh, read-error from disk.
117 if (!PageUptodate(page)) {
118 err = -EIO;
119 goto error;
123 * Page is ok afterall, we are done.
125 unlock_page(page);
128 return 0;
129 error:
130 unlock_page(page);
131 return err;
134 static const struct pipe_buf_operations page_cache_pipe_buf_ops = {
135 .can_merge = 0,
136 .map = generic_pipe_buf_map,
137 .unmap = generic_pipe_buf_unmap,
138 .confirm = page_cache_pipe_buf_confirm,
139 .release = page_cache_pipe_buf_release,
140 .steal = page_cache_pipe_buf_steal,
141 .get = generic_pipe_buf_get,
144 static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
145 struct pipe_buffer *buf)
147 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
148 return 1;
150 buf->flags |= PIPE_BUF_FLAG_LRU;
151 return generic_pipe_buf_steal(pipe, buf);
154 static const struct pipe_buf_operations user_page_pipe_buf_ops = {
155 .can_merge = 0,
156 .map = generic_pipe_buf_map,
157 .unmap = generic_pipe_buf_unmap,
158 .confirm = generic_pipe_buf_confirm,
159 .release = page_cache_pipe_buf_release,
160 .steal = user_page_pipe_buf_steal,
161 .get = generic_pipe_buf_get,
165 * splice_to_pipe - fill passed data into a pipe
166 * @pipe: pipe to fill
167 * @spd: data to fill
169 * Description:
170 * @spd contains a map of pages and len/offset tuples, along with
171 * the struct pipe_buf_operations associated with these pages. This
172 * function will link that data to the pipe.
175 ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
176 struct splice_pipe_desc *spd)
178 unsigned int spd_pages = spd->nr_pages;
179 int ret, do_wakeup, page_nr;
181 ret = 0;
182 do_wakeup = 0;
183 page_nr = 0;
185 pipe_lock(pipe);
187 for (;;) {
188 if (!pipe->readers) {
189 send_sig(SIGPIPE, current, 0);
190 if (!ret)
191 ret = -EPIPE;
192 break;
195 if (pipe->nrbufs < PIPE_BUFFERS) {
196 int newbuf = (pipe->curbuf + pipe->nrbufs) & (PIPE_BUFFERS - 1);
197 struct pipe_buffer *buf = pipe->bufs + newbuf;
199 buf->page = spd->pages[page_nr];
200 buf->offset = spd->partial[page_nr].offset;
201 buf->len = spd->partial[page_nr].len;
202 buf->private = spd->partial[page_nr].private;
203 buf->ops = spd->ops;
204 if (spd->flags & SPLICE_F_GIFT)
205 buf->flags |= PIPE_BUF_FLAG_GIFT;
207 pipe->nrbufs++;
208 page_nr++;
209 ret += buf->len;
211 if (pipe->inode)
212 do_wakeup = 1;
214 if (!--spd->nr_pages)
215 break;
216 if (pipe->nrbufs < PIPE_BUFFERS)
217 continue;
219 break;
222 if (spd->flags & SPLICE_F_NONBLOCK) {
223 if (!ret)
224 ret = -EAGAIN;
225 break;
228 if (signal_pending(current)) {
229 if (!ret)
230 ret = -ERESTARTSYS;
231 break;
234 if (do_wakeup) {
235 smp_mb();
236 if (waitqueue_active(&pipe->wait))
237 wake_up_interruptible_sync(&pipe->wait);
238 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
239 do_wakeup = 0;
242 pipe->waiting_writers++;
243 pipe_wait(pipe);
244 pipe->waiting_writers--;
247 pipe_unlock(pipe);
249 if (do_wakeup) {
250 smp_mb();
251 if (waitqueue_active(&pipe->wait))
252 wake_up_interruptible(&pipe->wait);
253 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
256 while (page_nr < spd_pages)
257 spd->spd_release(spd, page_nr++);
259 return ret;
262 static void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
264 page_cache_release(spd->pages[i]);
267 static int
268 __generic_file_splice_read(struct file *in, loff_t *ppos,
269 struct pipe_inode_info *pipe, size_t len,
270 unsigned int flags)
272 struct address_space *mapping = in->f_mapping;
273 unsigned int loff, nr_pages, req_pages;
274 struct page *pages[PIPE_BUFFERS];
275 struct partial_page partial[PIPE_BUFFERS];
276 struct page *page;
277 pgoff_t index, end_index;
278 loff_t isize;
279 int error, page_nr;
280 struct splice_pipe_desc spd = {
281 .pages = pages,
282 .partial = partial,
283 .flags = flags,
284 .ops = &page_cache_pipe_buf_ops,
285 .spd_release = spd_release_page,
288 index = *ppos >> PAGE_CACHE_SHIFT;
289 loff = *ppos & ~PAGE_CACHE_MASK;
290 req_pages = (len + loff + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
291 nr_pages = min(req_pages, (unsigned)PIPE_BUFFERS);
294 * Lookup the (hopefully) full range of pages we need.
296 spd.nr_pages = find_get_pages_contig(mapping, index, nr_pages, pages);
297 index += spd.nr_pages;
300 * If find_get_pages_contig() returned fewer pages than we needed,
301 * readahead/allocate the rest and fill in the holes.
303 if (spd.nr_pages < nr_pages)
304 page_cache_sync_readahead(mapping, &in->f_ra, in,
305 index, req_pages - spd.nr_pages);
307 error = 0;
308 while (spd.nr_pages < nr_pages) {
310 * Page could be there, find_get_pages_contig() breaks on
311 * the first hole.
313 page = find_get_page(mapping, index);
314 if (!page) {
316 * page didn't exist, allocate one.
318 page = page_cache_alloc_cold(mapping);
319 if (!page)
320 break;
322 error = add_to_page_cache_lru(page, mapping, index,
323 mapping_gfp_mask(mapping));
324 if (unlikely(error)) {
325 page_cache_release(page);
326 if (error == -EEXIST)
327 continue;
328 break;
331 * add_to_page_cache() locks the page, unlock it
332 * to avoid convoluting the logic below even more.
334 unlock_page(page);
337 pages[spd.nr_pages++] = page;
338 index++;
342 * Now loop over the map and see if we need to start IO on any
343 * pages, fill in the partial map, etc.
345 index = *ppos >> PAGE_CACHE_SHIFT;
346 nr_pages = spd.nr_pages;
347 spd.nr_pages = 0;
348 for (page_nr = 0; page_nr < nr_pages; page_nr++) {
349 unsigned int this_len;
351 if (!len)
352 break;
355 * this_len is the max we'll use from this page
357 this_len = min_t(unsigned long, len, PAGE_CACHE_SIZE - loff);
358 page = pages[page_nr];
360 if (PageReadahead(page))
361 page_cache_async_readahead(mapping, &in->f_ra, in,
362 page, index, req_pages - page_nr);
365 * If the page isn't uptodate, we may need to start io on it
367 if (!PageUptodate(page)) {
369 * If in nonblock mode then dont block on waiting
370 * for an in-flight io page
372 if (flags & SPLICE_F_NONBLOCK) {
373 if (!trylock_page(page)) {
374 error = -EAGAIN;
375 break;
377 } else
378 lock_page(page);
381 * Page was truncated, or invalidated by the
382 * filesystem. Redo the find/create, but this time the
383 * page is kept locked, so there's no chance of another
384 * race with truncate/invalidate.
386 if (!page->mapping) {
387 unlock_page(page);
388 page = find_or_create_page(mapping, index,
389 mapping_gfp_mask(mapping));
391 if (!page) {
392 error = -ENOMEM;
393 break;
395 page_cache_release(pages[page_nr]);
396 pages[page_nr] = page;
399 * page was already under io and is now done, great
401 if (PageUptodate(page)) {
402 unlock_page(page);
403 goto fill_it;
407 * need to read in the page
409 error = mapping->a_ops->readpage(in, page);
410 if (unlikely(error)) {
412 * We really should re-lookup the page here,
413 * but it complicates things a lot. Instead
414 * lets just do what we already stored, and
415 * we'll get it the next time we are called.
417 if (error == AOP_TRUNCATED_PAGE)
418 error = 0;
420 break;
423 fill_it:
425 * i_size must be checked after PageUptodate.
427 isize = i_size_read(mapping->host);
428 end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
429 if (unlikely(!isize || index > end_index))
430 break;
433 * if this is the last page, see if we need to shrink
434 * the length and stop
436 if (end_index == index) {
437 unsigned int plen;
440 * max good bytes in this page
442 plen = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
443 if (plen <= loff)
444 break;
447 * force quit after adding this page
449 this_len = min(this_len, plen - loff);
450 len = this_len;
453 partial[page_nr].offset = loff;
454 partial[page_nr].len = this_len;
455 len -= this_len;
456 loff = 0;
457 spd.nr_pages++;
458 index++;
462 * Release any pages at the end, if we quit early. 'page_nr' is how far
463 * we got, 'nr_pages' is how many pages are in the map.
465 while (page_nr < nr_pages)
466 page_cache_release(pages[page_nr++]);
467 in->f_ra.prev_pos = (loff_t)index << PAGE_CACHE_SHIFT;
469 if (spd.nr_pages)
470 return splice_to_pipe(pipe, &spd);
472 return error;
476 * generic_file_splice_read - splice data from file to a pipe
477 * @in: file to splice from
478 * @ppos: position in @in
479 * @pipe: pipe to splice to
480 * @len: number of bytes to splice
481 * @flags: splice modifier flags
483 * Description:
484 * Will read pages from given file and fill them into a pipe. Can be
485 * used as long as the address_space operations for the source implements
486 * a readpage() hook.
489 ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
490 struct pipe_inode_info *pipe, size_t len,
491 unsigned int flags)
493 loff_t isize, left;
494 int ret;
496 isize = i_size_read(in->f_mapping->host);
497 if (unlikely(*ppos >= isize))
498 return 0;
500 left = isize - *ppos;
501 if (unlikely(left < len))
502 len = left;
504 ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
505 if (ret > 0)
506 *ppos += ret;
508 return ret;
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->u.file;
521 loff_t pos = sd->pos;
522 int ret, more;
524 ret = buf->ops->confirm(pipe, buf);
525 if (!ret) {
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);
532 return ret;
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 int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
556 struct splice_desc *sd)
558 struct file *file = sd->u.file;
559 struct address_space *mapping = file->f_mapping;
560 unsigned int offset, this_len;
561 struct page *page;
562 void *fsdata;
563 int ret;
566 * make sure the data in this buffer is uptodate
568 ret = buf->ops->confirm(pipe, buf);
569 if (unlikely(ret))
570 return ret;
572 offset = sd->pos & ~PAGE_CACHE_MASK;
574 this_len = sd->len;
575 if (this_len + offset > PAGE_CACHE_SIZE)
576 this_len = PAGE_CACHE_SIZE - offset;
578 ret = pagecache_write_begin(file, mapping, sd->pos, this_len,
579 AOP_FLAG_UNINTERRUPTIBLE, &page, &fsdata);
580 if (unlikely(ret))
581 goto out;
583 if (buf->page != page) {
585 * Careful, ->map() uses KM_USER0!
587 char *src = buf->ops->map(pipe, buf, 1);
588 char *dst = kmap_atomic(page, KM_USER1);
590 memcpy(dst + offset, src + buf->offset, this_len);
591 flush_dcache_page(page);
592 kunmap_atomic(dst, KM_USER1);
593 buf->ops->unmap(pipe, buf, src);
595 ret = pagecache_write_end(file, mapping, sd->pos, this_len, this_len,
596 page, fsdata);
597 out:
598 return ret;
600 EXPORT_SYMBOL(pipe_to_file);
602 static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
604 smp_mb();
605 if (waitqueue_active(&pipe->wait))
606 wake_up_interruptible(&pipe->wait);
607 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
611 * splice_from_pipe_feed - feed available data from a pipe to a file
612 * @pipe: pipe to splice from
613 * @sd: information to @actor
614 * @actor: handler that splices the data
616 * Description:
618 * This function loops over the pipe and calls @actor to do the
619 * actual moving of a single struct pipe_buffer to the desired
620 * destination. It returns when there's no more buffers left in
621 * the pipe or if the requested number of bytes (@sd->total_len)
622 * have been copied. It returns a positive number (one) if the
623 * pipe needs to be filled with more data, zero if the required
624 * number of bytes have been copied and -errno on error.
626 * This, together with splice_from_pipe_{begin,end,next}, may be
627 * used to implement the functionality of __splice_from_pipe() when
628 * locking is required around copying the pipe buffers to the
629 * destination.
631 int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
632 splice_actor *actor)
634 int ret;
636 while (pipe->nrbufs) {
637 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
638 const struct pipe_buf_operations *ops = buf->ops;
640 sd->len = buf->len;
641 if (sd->len > sd->total_len)
642 sd->len = sd->total_len;
644 ret = actor(pipe, buf, sd);
645 if (ret <= 0) {
646 if (ret == -ENODATA)
647 ret = 0;
648 return ret;
650 buf->offset += ret;
651 buf->len -= ret;
653 sd->num_spliced += ret;
654 sd->len -= ret;
655 sd->pos += ret;
656 sd->total_len -= ret;
658 if (!buf->len) {
659 buf->ops = NULL;
660 ops->release(pipe, buf);
661 pipe->curbuf = (pipe->curbuf + 1) & (PIPE_BUFFERS - 1);
662 pipe->nrbufs--;
663 if (pipe->inode)
664 sd->need_wakeup = true;
667 if (!sd->total_len)
668 return 0;
671 return 1;
673 EXPORT_SYMBOL(splice_from_pipe_feed);
676 * splice_from_pipe_next - wait for some data to splice from
677 * @pipe: pipe to splice from
678 * @sd: information about the splice operation
680 * Description:
681 * This function will wait for some data and return a positive
682 * value (one) if pipe buffers are available. It will return zero
683 * or -errno if no more data needs to be spliced.
685 int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
687 while (!pipe->nrbufs) {
688 if (!pipe->writers)
689 return 0;
691 if (!pipe->waiting_writers && sd->num_spliced)
692 return 0;
694 if (sd->flags & SPLICE_F_NONBLOCK)
695 return -EAGAIN;
697 if (signal_pending(current))
698 return -ERESTARTSYS;
700 if (sd->need_wakeup) {
701 wakeup_pipe_writers(pipe);
702 sd->need_wakeup = false;
705 pipe_wait(pipe);
708 return 1;
710 EXPORT_SYMBOL(splice_from_pipe_next);
713 * splice_from_pipe_begin - start splicing from pipe
714 * @pipe: pipe to splice from
716 * Description:
717 * This function should be called before a loop containing
718 * splice_from_pipe_next() and splice_from_pipe_feed() to
719 * initialize the necessary fields of @sd.
721 void splice_from_pipe_begin(struct splice_desc *sd)
723 sd->num_spliced = 0;
724 sd->need_wakeup = false;
726 EXPORT_SYMBOL(splice_from_pipe_begin);
729 * splice_from_pipe_end - finish splicing from pipe
730 * @pipe: pipe to splice from
731 * @sd: information about the splice operation
733 * Description:
734 * This function will wake up pipe writers if necessary. It should
735 * be called after a loop containing splice_from_pipe_next() and
736 * splice_from_pipe_feed().
738 void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
740 if (sd->need_wakeup)
741 wakeup_pipe_writers(pipe);
743 EXPORT_SYMBOL(splice_from_pipe_end);
746 * __splice_from_pipe - splice data from a pipe to given actor
747 * @pipe: pipe to splice from
748 * @sd: information to @actor
749 * @actor: handler that splices the data
751 * Description:
752 * This function does little more than loop over the pipe and call
753 * @actor to do the actual moving of a single struct pipe_buffer to
754 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
755 * pipe_to_user.
758 ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
759 splice_actor *actor)
761 int ret;
763 splice_from_pipe_begin(sd);
764 do {
765 ret = splice_from_pipe_next(pipe, sd);
766 if (ret > 0)
767 ret = splice_from_pipe_feed(pipe, sd, actor);
768 } while (ret > 0);
769 splice_from_pipe_end(pipe, sd);
771 return sd->num_spliced ? sd->num_spliced : ret;
773 EXPORT_SYMBOL(__splice_from_pipe);
776 * splice_from_pipe - splice data from a pipe to a file
777 * @pipe: pipe to splice from
778 * @out: file to splice to
779 * @ppos: position in @out
780 * @len: how many bytes to splice
781 * @flags: splice modifier flags
782 * @actor: handler that splices the data
784 * Description:
785 * See __splice_from_pipe. This function locks the pipe inode,
786 * otherwise it's identical to __splice_from_pipe().
789 ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
790 loff_t *ppos, size_t len, unsigned int flags,
791 splice_actor *actor)
793 ssize_t ret;
794 struct splice_desc sd = {
795 .total_len = len,
796 .flags = flags,
797 .pos = *ppos,
798 .u.file = out,
801 pipe_lock(pipe);
802 ret = __splice_from_pipe(pipe, &sd, actor);
803 pipe_unlock(pipe);
805 return ret;
809 * generic_file_splice_write - splice data from a pipe to a file
810 * @pipe: pipe info
811 * @out: file to write to
812 * @ppos: position in @out
813 * @len: number of bytes to splice
814 * @flags: splice modifier flags
816 * Description:
817 * Will either move or copy pages (determined by @flags options) from
818 * the given pipe inode to the given file.
821 ssize_t
822 generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
823 loff_t *ppos, size_t len, unsigned int flags)
825 struct address_space *mapping = out->f_mapping;
826 struct inode *inode = mapping->host;
827 struct splice_desc sd = {
828 .total_len = len,
829 .flags = flags,
830 .pos = *ppos,
831 .u.file = out,
833 ssize_t ret;
835 pipe_lock(pipe);
837 splice_from_pipe_begin(&sd);
838 do {
839 ret = splice_from_pipe_next(pipe, &sd);
840 if (ret <= 0)
841 break;
843 mutex_lock_nested(&inode->i_mutex, I_MUTEX_CHILD);
844 ret = file_remove_suid(out);
845 if (!ret)
846 ret = splice_from_pipe_feed(pipe, &sd, pipe_to_file);
847 mutex_unlock(&inode->i_mutex);
848 } while (ret > 0);
849 splice_from_pipe_end(pipe, &sd);
851 pipe_unlock(pipe);
853 if (sd.num_spliced)
854 ret = sd.num_spliced;
856 if (ret > 0) {
857 unsigned long nr_pages;
859 *ppos += ret;
860 nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
863 * If file or inode is SYNC and we actually wrote some data,
864 * sync it.
866 if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(inode))) {
867 int err;
869 mutex_lock(&inode->i_mutex);
870 err = generic_osync_inode(inode, mapping,
871 OSYNC_METADATA|OSYNC_DATA);
872 mutex_unlock(&inode->i_mutex);
874 if (err)
875 ret = err;
877 balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
880 return ret;
883 EXPORT_SYMBOL(generic_file_splice_write);
886 * generic_splice_sendpage - splice data from a pipe to a socket
887 * @pipe: pipe to splice from
888 * @out: socket to write to
889 * @ppos: position in @out
890 * @len: number of bytes to splice
891 * @flags: splice modifier flags
893 * Description:
894 * Will send @len bytes from the pipe to a network socket. No data copying
895 * is involved.
898 ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
899 loff_t *ppos, size_t len, unsigned int flags)
901 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
904 EXPORT_SYMBOL(generic_splice_sendpage);
907 * Attempt to initiate a splice from pipe to file.
909 static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
910 loff_t *ppos, size_t len, unsigned int flags)
912 int ret;
914 if (unlikely(!out->f_op || !out->f_op->splice_write))
915 return -EINVAL;
917 if (unlikely(!(out->f_mode & FMODE_WRITE)))
918 return -EBADF;
920 if (unlikely(out->f_flags & O_APPEND))
921 return -EINVAL;
923 ret = rw_verify_area(WRITE, out, ppos, len);
924 if (unlikely(ret < 0))
925 return ret;
927 return out->f_op->splice_write(pipe, out, ppos, len, flags);
931 * Attempt to initiate a splice from a file to a pipe.
933 static long do_splice_to(struct file *in, loff_t *ppos,
934 struct pipe_inode_info *pipe, size_t len,
935 unsigned int flags)
937 int ret;
939 if (unlikely(!in->f_op || !in->f_op->splice_read))
940 return -EINVAL;
942 if (unlikely(!(in->f_mode & FMODE_READ)))
943 return -EBADF;
945 ret = rw_verify_area(READ, in, ppos, len);
946 if (unlikely(ret < 0))
947 return ret;
949 return in->f_op->splice_read(in, ppos, pipe, len, flags);
953 * splice_direct_to_actor - splices data directly between two non-pipes
954 * @in: file to splice from
955 * @sd: actor information on where to splice to
956 * @actor: handles the data splicing
958 * Description:
959 * This is a special case helper to splice directly between two
960 * points, without requiring an explicit pipe. Internally an allocated
961 * pipe is cached in the process, and reused during the lifetime of
962 * that process.
965 ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
966 splice_direct_actor *actor)
968 struct pipe_inode_info *pipe;
969 long ret, bytes;
970 umode_t i_mode;
971 size_t len;
972 int i, flags;
975 * We require the input being a regular file, as we don't want to
976 * randomly drop data for eg socket -> socket splicing. Use the
977 * piped splicing for that!
979 i_mode = in->f_path.dentry->d_inode->i_mode;
980 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
981 return -EINVAL;
984 * neither in nor out is a pipe, setup an internal pipe attached to
985 * 'out' and transfer the wanted data from 'in' to 'out' through that
987 pipe = current->splice_pipe;
988 if (unlikely(!pipe)) {
989 pipe = alloc_pipe_info(NULL);
990 if (!pipe)
991 return -ENOMEM;
994 * We don't have an immediate reader, but we'll read the stuff
995 * out of the pipe right after the splice_to_pipe(). So set
996 * PIPE_READERS appropriately.
998 pipe->readers = 1;
1000 current->splice_pipe = pipe;
1004 * Do the splice.
1006 ret = 0;
1007 bytes = 0;
1008 len = sd->total_len;
1009 flags = sd->flags;
1012 * Don't block on output, we have to drain the direct pipe.
1014 sd->flags &= ~SPLICE_F_NONBLOCK;
1016 while (len) {
1017 size_t read_len;
1018 loff_t pos = sd->pos, prev_pos = pos;
1020 ret = do_splice_to(in, &pos, pipe, len, flags);
1021 if (unlikely(ret <= 0))
1022 goto out_release;
1024 read_len = ret;
1025 sd->total_len = read_len;
1028 * NOTE: nonblocking mode only applies to the input. We
1029 * must not do the output in nonblocking mode as then we
1030 * could get stuck data in the internal pipe:
1032 ret = actor(pipe, sd);
1033 if (unlikely(ret <= 0)) {
1034 sd->pos = prev_pos;
1035 goto out_release;
1038 bytes += ret;
1039 len -= ret;
1040 sd->pos = pos;
1042 if (ret < read_len) {
1043 sd->pos = prev_pos + ret;
1044 goto out_release;
1048 done:
1049 pipe->nrbufs = pipe->curbuf = 0;
1050 file_accessed(in);
1051 return bytes;
1053 out_release:
1055 * If we did an incomplete transfer we must release
1056 * the pipe buffers in question:
1058 for (i = 0; i < PIPE_BUFFERS; i++) {
1059 struct pipe_buffer *buf = pipe->bufs + i;
1061 if (buf->ops) {
1062 buf->ops->release(pipe, buf);
1063 buf->ops = NULL;
1067 if (!bytes)
1068 bytes = ret;
1070 goto done;
1072 EXPORT_SYMBOL(splice_direct_to_actor);
1074 static int direct_splice_actor(struct pipe_inode_info *pipe,
1075 struct splice_desc *sd)
1077 struct file *file = sd->u.file;
1079 return do_splice_from(pipe, file, &sd->pos, sd->total_len, sd->flags);
1083 * do_splice_direct - splices data directly between two files
1084 * @in: file to splice from
1085 * @ppos: input file offset
1086 * @out: file to splice to
1087 * @len: number of bytes to splice
1088 * @flags: splice modifier flags
1090 * Description:
1091 * For use by do_sendfile(). splice can easily emulate sendfile, but
1092 * doing it in the application would incur an extra system call
1093 * (splice in + splice out, as compared to just sendfile()). So this helper
1094 * can splice directly through a process-private pipe.
1097 long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
1098 size_t len, unsigned int flags)
1100 struct splice_desc sd = {
1101 .len = len,
1102 .total_len = len,
1103 .flags = flags,
1104 .pos = *ppos,
1105 .u.file = out,
1107 long ret;
1109 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
1110 if (ret > 0)
1111 *ppos = sd.pos;
1113 return ret;
1117 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
1118 * location, so checking ->i_pipe is not enough to verify that this is a
1119 * pipe.
1121 static inline struct pipe_inode_info *pipe_info(struct inode *inode)
1123 if (S_ISFIFO(inode->i_mode))
1124 return inode->i_pipe;
1126 return NULL;
1130 * Determine where to splice to/from.
1132 static long do_splice(struct file *in, loff_t __user *off_in,
1133 struct file *out, loff_t __user *off_out,
1134 size_t len, unsigned int flags)
1136 struct pipe_inode_info *pipe;
1137 loff_t offset, *off;
1138 long ret;
1140 pipe = pipe_info(in->f_path.dentry->d_inode);
1141 if (pipe) {
1142 if (off_in)
1143 return -ESPIPE;
1144 if (off_out) {
1145 if (out->f_op->llseek == no_llseek)
1146 return -EINVAL;
1147 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
1148 return -EFAULT;
1149 off = &offset;
1150 } else
1151 off = &out->f_pos;
1153 ret = do_splice_from(pipe, out, off, len, flags);
1155 if (off_out && copy_to_user(off_out, off, sizeof(loff_t)))
1156 ret = -EFAULT;
1158 return ret;
1161 pipe = pipe_info(out->f_path.dentry->d_inode);
1162 if (pipe) {
1163 if (off_out)
1164 return -ESPIPE;
1165 if (off_in) {
1166 if (in->f_op->llseek == no_llseek)
1167 return -EINVAL;
1168 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
1169 return -EFAULT;
1170 off = &offset;
1171 } else
1172 off = &in->f_pos;
1174 ret = do_splice_to(in, off, pipe, len, flags);
1176 if (off_in && copy_to_user(off_in, off, sizeof(loff_t)))
1177 ret = -EFAULT;
1179 return ret;
1182 return -EINVAL;
1186 * Map an iov into an array of pages and offset/length tupples. With the
1187 * partial_page structure, we can map several non-contiguous ranges into
1188 * our ones pages[] map instead of splitting that operation into pieces.
1189 * Could easily be exported as a generic helper for other users, in which
1190 * case one would probably want to add a 'max_nr_pages' parameter as well.
1192 static int get_iovec_page_array(const struct iovec __user *iov,
1193 unsigned int nr_vecs, struct page **pages,
1194 struct partial_page *partial, int aligned)
1196 int buffers = 0, error = 0;
1198 while (nr_vecs) {
1199 unsigned long off, npages;
1200 struct iovec entry;
1201 void __user *base;
1202 size_t len;
1203 int i;
1205 error = -EFAULT;
1206 if (copy_from_user(&entry, iov, sizeof(entry)))
1207 break;
1209 base = entry.iov_base;
1210 len = entry.iov_len;
1213 * Sanity check this iovec. 0 read succeeds.
1215 error = 0;
1216 if (unlikely(!len))
1217 break;
1218 error = -EFAULT;
1219 if (!access_ok(VERIFY_READ, base, len))
1220 break;
1223 * Get this base offset and number of pages, then map
1224 * in the user pages.
1226 off = (unsigned long) base & ~PAGE_MASK;
1229 * If asked for alignment, the offset must be zero and the
1230 * length a multiple of the PAGE_SIZE.
1232 error = -EINVAL;
1233 if (aligned && (off || len & ~PAGE_MASK))
1234 break;
1236 npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1237 if (npages > PIPE_BUFFERS - buffers)
1238 npages = PIPE_BUFFERS - buffers;
1240 error = get_user_pages_fast((unsigned long)base, npages,
1241 0, &pages[buffers]);
1243 if (unlikely(error <= 0))
1244 break;
1247 * Fill this contiguous range into the partial page map.
1249 for (i = 0; i < error; i++) {
1250 const int plen = min_t(size_t, len, PAGE_SIZE - off);
1252 partial[buffers].offset = off;
1253 partial[buffers].len = plen;
1255 off = 0;
1256 len -= plen;
1257 buffers++;
1261 * We didn't complete this iov, stop here since it probably
1262 * means we have to move some of this into a pipe to
1263 * be able to continue.
1265 if (len)
1266 break;
1269 * Don't continue if we mapped fewer pages than we asked for,
1270 * or if we mapped the max number of pages that we have
1271 * room for.
1273 if (error < npages || buffers == PIPE_BUFFERS)
1274 break;
1276 nr_vecs--;
1277 iov++;
1280 if (buffers)
1281 return buffers;
1283 return error;
1286 static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1287 struct splice_desc *sd)
1289 char *src;
1290 int ret;
1292 ret = buf->ops->confirm(pipe, buf);
1293 if (unlikely(ret))
1294 return ret;
1297 * See if we can use the atomic maps, by prefaulting in the
1298 * pages and doing an atomic copy
1300 if (!fault_in_pages_writeable(sd->u.userptr, sd->len)) {
1301 src = buf->ops->map(pipe, buf, 1);
1302 ret = __copy_to_user_inatomic(sd->u.userptr, src + buf->offset,
1303 sd->len);
1304 buf->ops->unmap(pipe, buf, src);
1305 if (!ret) {
1306 ret = sd->len;
1307 goto out;
1312 * No dice, use slow non-atomic map and copy
1314 src = buf->ops->map(pipe, buf, 0);
1316 ret = sd->len;
1317 if (copy_to_user(sd->u.userptr, src + buf->offset, sd->len))
1318 ret = -EFAULT;
1320 buf->ops->unmap(pipe, buf, src);
1321 out:
1322 if (ret > 0)
1323 sd->u.userptr += ret;
1324 return ret;
1328 * For lack of a better implementation, implement vmsplice() to userspace
1329 * as a simple copy of the pipes pages to the user iov.
1331 static long vmsplice_to_user(struct file *file, const struct iovec __user *iov,
1332 unsigned long nr_segs, unsigned int flags)
1334 struct pipe_inode_info *pipe;
1335 struct splice_desc sd;
1336 ssize_t size;
1337 int error;
1338 long ret;
1340 pipe = pipe_info(file->f_path.dentry->d_inode);
1341 if (!pipe)
1342 return -EBADF;
1344 pipe_lock(pipe);
1346 error = ret = 0;
1347 while (nr_segs) {
1348 void __user *base;
1349 size_t len;
1352 * Get user address base and length for this iovec.
1354 error = get_user(base, &iov->iov_base);
1355 if (unlikely(error))
1356 break;
1357 error = get_user(len, &iov->iov_len);
1358 if (unlikely(error))
1359 break;
1362 * Sanity check this iovec. 0 read succeeds.
1364 if (unlikely(!len))
1365 break;
1366 if (unlikely(!base)) {
1367 error = -EFAULT;
1368 break;
1371 if (unlikely(!access_ok(VERIFY_WRITE, base, len))) {
1372 error = -EFAULT;
1373 break;
1376 sd.len = 0;
1377 sd.total_len = len;
1378 sd.flags = flags;
1379 sd.u.userptr = base;
1380 sd.pos = 0;
1382 size = __splice_from_pipe(pipe, &sd, pipe_to_user);
1383 if (size < 0) {
1384 if (!ret)
1385 ret = size;
1387 break;
1390 ret += size;
1392 if (size < len)
1393 break;
1395 nr_segs--;
1396 iov++;
1399 pipe_unlock(pipe);
1401 if (!ret)
1402 ret = error;
1404 return ret;
1408 * vmsplice splices a user address range into a pipe. It can be thought of
1409 * as splice-from-memory, where the regular splice is splice-from-file (or
1410 * to file). In both cases the output is a pipe, naturally.
1412 static long vmsplice_to_pipe(struct file *file, const struct iovec __user *iov,
1413 unsigned long nr_segs, unsigned int flags)
1415 struct pipe_inode_info *pipe;
1416 struct page *pages[PIPE_BUFFERS];
1417 struct partial_page partial[PIPE_BUFFERS];
1418 struct splice_pipe_desc spd = {
1419 .pages = pages,
1420 .partial = partial,
1421 .flags = flags,
1422 .ops = &user_page_pipe_buf_ops,
1423 .spd_release = spd_release_page,
1426 pipe = pipe_info(file->f_path.dentry->d_inode);
1427 if (!pipe)
1428 return -EBADF;
1430 spd.nr_pages = get_iovec_page_array(iov, nr_segs, pages, partial,
1431 flags & SPLICE_F_GIFT);
1432 if (spd.nr_pages <= 0)
1433 return spd.nr_pages;
1435 return splice_to_pipe(pipe, &spd);
1439 * Note that vmsplice only really supports true splicing _from_ user memory
1440 * to a pipe, not the other way around. Splicing from user memory is a simple
1441 * operation that can be supported without any funky alignment restrictions
1442 * or nasty vm tricks. We simply map in the user memory and fill them into
1443 * a pipe. The reverse isn't quite as easy, though. There are two possible
1444 * solutions for that:
1446 * - memcpy() the data internally, at which point we might as well just
1447 * do a regular read() on the buffer anyway.
1448 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1449 * has restriction limitations on both ends of the pipe).
1451 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1454 SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1455 unsigned long, nr_segs, unsigned int, flags)
1457 struct file *file;
1458 long error;
1459 int fput;
1461 if (unlikely(nr_segs > UIO_MAXIOV))
1462 return -EINVAL;
1463 else if (unlikely(!nr_segs))
1464 return 0;
1466 error = -EBADF;
1467 file = fget_light(fd, &fput);
1468 if (file) {
1469 if (file->f_mode & FMODE_WRITE)
1470 error = vmsplice_to_pipe(file, iov, nr_segs, flags);
1471 else if (file->f_mode & FMODE_READ)
1472 error = vmsplice_to_user(file, iov, nr_segs, flags);
1474 fput_light(file, fput);
1477 return error;
1480 SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1481 int, fd_out, loff_t __user *, off_out,
1482 size_t, len, unsigned int, flags)
1484 long error;
1485 struct file *in, *out;
1486 int fput_in, fput_out;
1488 if (unlikely(!len))
1489 return 0;
1491 error = -EBADF;
1492 in = fget_light(fd_in, &fput_in);
1493 if (in) {
1494 if (in->f_mode & FMODE_READ) {
1495 out = fget_light(fd_out, &fput_out);
1496 if (out) {
1497 if (out->f_mode & FMODE_WRITE)
1498 error = do_splice(in, off_in,
1499 out, off_out,
1500 len, flags);
1501 fput_light(out, fput_out);
1505 fput_light(in, fput_in);
1508 return error;
1512 * Make sure there's data to read. Wait for input if we can, otherwise
1513 * return an appropriate error.
1515 static int link_ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1517 int ret;
1520 * Check ->nrbufs without the inode lock first. This function
1521 * is speculative anyways, so missing one is ok.
1523 if (pipe->nrbufs)
1524 return 0;
1526 ret = 0;
1527 pipe_lock(pipe);
1529 while (!pipe->nrbufs) {
1530 if (signal_pending(current)) {
1531 ret = -ERESTARTSYS;
1532 break;
1534 if (!pipe->writers)
1535 break;
1536 if (!pipe->waiting_writers) {
1537 if (flags & SPLICE_F_NONBLOCK) {
1538 ret = -EAGAIN;
1539 break;
1542 pipe_wait(pipe);
1545 pipe_unlock(pipe);
1546 return ret;
1550 * Make sure there's writeable room. Wait for room if we can, otherwise
1551 * return an appropriate error.
1553 static int link_opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1555 int ret;
1558 * Check ->nrbufs without the inode lock first. This function
1559 * is speculative anyways, so missing one is ok.
1561 if (pipe->nrbufs < PIPE_BUFFERS)
1562 return 0;
1564 ret = 0;
1565 pipe_lock(pipe);
1567 while (pipe->nrbufs >= PIPE_BUFFERS) {
1568 if (!pipe->readers) {
1569 send_sig(SIGPIPE, current, 0);
1570 ret = -EPIPE;
1571 break;
1573 if (flags & SPLICE_F_NONBLOCK) {
1574 ret = -EAGAIN;
1575 break;
1577 if (signal_pending(current)) {
1578 ret = -ERESTARTSYS;
1579 break;
1581 pipe->waiting_writers++;
1582 pipe_wait(pipe);
1583 pipe->waiting_writers--;
1586 pipe_unlock(pipe);
1587 return ret;
1591 * Link contents of ipipe to opipe.
1593 static int link_pipe(struct pipe_inode_info *ipipe,
1594 struct pipe_inode_info *opipe,
1595 size_t len, unsigned int flags)
1597 struct pipe_buffer *ibuf, *obuf;
1598 int ret = 0, i = 0, nbuf;
1601 * Potential ABBA deadlock, work around it by ordering lock
1602 * grabbing by pipe info address. Otherwise two different processes
1603 * could deadlock (one doing tee from A -> B, the other from B -> A).
1605 pipe_double_lock(ipipe, opipe);
1607 do {
1608 if (!opipe->readers) {
1609 send_sig(SIGPIPE, current, 0);
1610 if (!ret)
1611 ret = -EPIPE;
1612 break;
1616 * If we have iterated all input buffers or ran out of
1617 * output room, break.
1619 if (i >= ipipe->nrbufs || opipe->nrbufs >= PIPE_BUFFERS)
1620 break;
1622 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (PIPE_BUFFERS - 1));
1623 nbuf = (opipe->curbuf + opipe->nrbufs) & (PIPE_BUFFERS - 1);
1626 * Get a reference to this pipe buffer,
1627 * so we can copy the contents over.
1629 ibuf->ops->get(ipipe, ibuf);
1631 obuf = opipe->bufs + nbuf;
1632 *obuf = *ibuf;
1635 * Don't inherit the gift flag, we need to
1636 * prevent multiple steals of this page.
1638 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1640 if (obuf->len > len)
1641 obuf->len = len;
1643 opipe->nrbufs++;
1644 ret += obuf->len;
1645 len -= obuf->len;
1646 i++;
1647 } while (len);
1650 * return EAGAIN if we have the potential of some data in the
1651 * future, otherwise just return 0
1653 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1654 ret = -EAGAIN;
1656 pipe_unlock(ipipe);
1657 pipe_unlock(opipe);
1660 * If we put data in the output pipe, wakeup any potential readers.
1662 if (ret > 0) {
1663 smp_mb();
1664 if (waitqueue_active(&opipe->wait))
1665 wake_up_interruptible(&opipe->wait);
1666 kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN);
1669 return ret;
1673 * This is a tee(1) implementation that works on pipes. It doesn't copy
1674 * any data, it simply references the 'in' pages on the 'out' pipe.
1675 * The 'flags' used are the SPLICE_F_* variants, currently the only
1676 * applicable one is SPLICE_F_NONBLOCK.
1678 static long do_tee(struct file *in, struct file *out, size_t len,
1679 unsigned int flags)
1681 struct pipe_inode_info *ipipe = pipe_info(in->f_path.dentry->d_inode);
1682 struct pipe_inode_info *opipe = pipe_info(out->f_path.dentry->d_inode);
1683 int ret = -EINVAL;
1686 * Duplicate the contents of ipipe to opipe without actually
1687 * copying the data.
1689 if (ipipe && opipe && ipipe != opipe) {
1691 * Keep going, unless we encounter an error. The ipipe/opipe
1692 * ordering doesn't really matter.
1694 ret = link_ipipe_prep(ipipe, flags);
1695 if (!ret) {
1696 ret = link_opipe_prep(opipe, flags);
1697 if (!ret)
1698 ret = link_pipe(ipipe, opipe, len, flags);
1702 return ret;
1705 SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
1707 struct file *in;
1708 int error, fput_in;
1710 if (unlikely(!len))
1711 return 0;
1713 error = -EBADF;
1714 in = fget_light(fdin, &fput_in);
1715 if (in) {
1716 if (in->f_mode & FMODE_READ) {
1717 int fput_out;
1718 struct file *out = fget_light(fdout, &fput_out);
1720 if (out) {
1721 if (out->f_mode & FMODE_WRITE)
1722 error = do_tee(in, out, len, flags);
1723 fput_light(out, fput_out);
1726 fput_light(in, fput_in);
1729 return error;