blob: 584b2b7a1dbe01671cd48afb48cf08f9851c2f51 [file] [log] [blame]
Jens Axboe5274f052006-03-30 15:15:30 +02001/*
2 * "splice": joining two ropes together by interweaving their strands.
3 *
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.
7 *
8 * The traditional unix read/write is extended with a "splice()" operation
9 * that transfers data buffers to or from a pipe buffer.
10 *
11 * Named by Larry McVoy, original implementation from Linus, extended by
Jens Axboec2058e02006-04-11 13:56:34 +020012 * Jens to support splicing to files, network, direct splicing, etc and
13 * fixing lots of bugs.
Jens Axboe5274f052006-03-30 15:15:30 +020014 *
Jens Axboe0fe23472006-09-04 15:41:16 +020015 * Copyright (C) 2005-2006 Jens Axboe <axboe@kernel.dk>
Jens Axboec2058e02006-04-11 13:56:34 +020016 * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
17 * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
Jens Axboe5274f052006-03-30 15:15:30 +020018 *
19 */
20#include <linux/fs.h>
21#include <linux/file.h>
22#include <linux/pagemap.h>
Jens Axboed6b29d72007-06-04 09:59:47 +020023#include <linux/splice.h>
KAMEZAWA Hiroyuki08e552c2009-01-07 18:08:01 -080024#include <linux/memcontrol.h>
Jens Axboe5274f052006-03-30 15:15:30 +020025#include <linux/mm_inline.h>
Jens Axboe5abc97a2006-03-30 15:16:46 +020026#include <linux/swap.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020027#include <linux/writeback.h>
28#include <linux/buffer_head.h>
Jeff Garzika0f06782006-03-30 23:06:13 -050029#include <linux/module.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020030#include <linux/syscalls.h>
Jens Axboe912d35f2006-04-26 10:59:21 +020031#include <linux/uio.h>
James Morris29ce2052007-07-13 11:44:32 +020032#include <linux/security.h>
Jens Axboe5274f052006-03-30 15:15:30 +020033
Jens Axboe83f91352006-04-02 23:05:09 +020034/*
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.
39 */
Jens Axboe76ad4d12006-05-03 10:41:33 +020040static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
Jens Axboe5abc97a2006-03-30 15:16:46 +020041 struct pipe_buffer *buf)
42{
43 struct page *page = buf->page;
Jens Axboe9e94cd42006-06-20 15:01:12 +020044 struct address_space *mapping;
Jens Axboe5abc97a2006-03-30 15:16:46 +020045
Jens Axboe9e0267c2006-04-19 15:57:31 +020046 lock_page(page);
47
Jens Axboe9e94cd42006-06-20 15:01:12 +020048 mapping = page_mapping(page);
49 if (mapping) {
50 WARN_ON(!PageUptodate(page));
Jens Axboe5abc97a2006-03-30 15:16:46 +020051
Jens Axboe9e94cd42006-06-20 15:01:12 +020052 /*
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.
59 */
60 wait_on_page_writeback(page);
Jens Axboead8d6f02006-04-02 23:10:32 +020061
David Howells266cf652009-04-03 16:42:36 +010062 if (page_has_private(page) &&
63 !try_to_release_page(page, GFP_KERNEL))
Jens Axboeca39d652008-05-20 21:27:41 +020064 goto out_unlock;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020065
Jens Axboe9e94cd42006-06-20 15:01:12 +020066 /*
67 * If we succeeded in removing the mapping, set LRU flag
68 * and return good.
69 */
70 if (remove_mapping(mapping, page)) {
71 buf->flags |= PIPE_BUF_FLAG_LRU;
72 return 0;
73 }
Jens Axboe9e0267c2006-04-19 15:57:31 +020074 }
Jens Axboe5abc97a2006-03-30 15:16:46 +020075
Jens Axboe9e94cd42006-06-20 15:01:12 +020076 /*
77 * Raced with truncate or failed to remove page from current
78 * address space, unlock and return failure.
79 */
Jens Axboeca39d652008-05-20 21:27:41 +020080out_unlock:
Jens Axboe9e94cd42006-06-20 15:01:12 +020081 unlock_page(page);
82 return 1;
Jens Axboe5abc97a2006-03-30 15:16:46 +020083}
84
Jens Axboe76ad4d12006-05-03 10:41:33 +020085static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +020086 struct pipe_buffer *buf)
87{
88 page_cache_release(buf->page);
Jens Axboe14328732006-05-03 10:35:26 +020089 buf->flags &= ~PIPE_BUF_FLAG_LRU;
Jens Axboe5274f052006-03-30 15:15:30 +020090}
91
Jens Axboe08457182007-06-12 20:51:32 +020092/*
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.
95 */
Jens Axboecac36bb02007-06-14 13:10:48 +020096static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
97 struct pipe_buffer *buf)
Jens Axboe5274f052006-03-30 15:15:30 +020098{
99 struct page *page = buf->page;
Jens Axboe49d0b212006-04-10 09:04:41 +0200100 int err;
Jens Axboe5274f052006-03-30 15:15:30 +0200101
102 if (!PageUptodate(page)) {
Jens Axboe49d0b212006-04-10 09:04:41 +0200103 lock_page(page);
104
105 /*
106 * Page got truncated/unhashed. This will cause a 0-byte
Ingo Molnar73d62d82006-04-11 13:57:21 +0200107 * splice, if this is the first page.
Jens Axboe49d0b212006-04-10 09:04:41 +0200108 */
109 if (!page->mapping) {
110 err = -ENODATA;
111 goto error;
112 }
113
114 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200115 * Uh oh, read-error from disk.
Jens Axboe49d0b212006-04-10 09:04:41 +0200116 */
117 if (!PageUptodate(page)) {
118 err = -EIO;
119 goto error;
120 }
121
122 /*
Jens Axboef84d7512006-05-01 19:59:03 +0200123 * Page is ok afterall, we are done.
Jens Axboe49d0b212006-04-10 09:04:41 +0200124 */
Jens Axboe5274f052006-03-30 15:15:30 +0200125 unlock_page(page);
Jens Axboe5274f052006-03-30 15:15:30 +0200126 }
127
Jens Axboef84d7512006-05-01 19:59:03 +0200128 return 0;
Jens Axboe49d0b212006-04-10 09:04:41 +0200129error:
130 unlock_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200131 return err;
Jens Axboe70524492006-04-11 15:51:17 +0200132}
133
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800134static const struct pipe_buf_operations page_cache_pipe_buf_ops = {
Jens Axboe5274f052006-03-30 15:15:30 +0200135 .can_merge = 0,
Jens Axboef84d7512006-05-01 19:59:03 +0200136 .map = generic_pipe_buf_map,
137 .unmap = generic_pipe_buf_unmap,
Jens Axboecac36bb02007-06-14 13:10:48 +0200138 .confirm = page_cache_pipe_buf_confirm,
Jens Axboe5274f052006-03-30 15:15:30 +0200139 .release = page_cache_pipe_buf_release,
Jens Axboe5abc97a2006-03-30 15:16:46 +0200140 .steal = page_cache_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200141 .get = generic_pipe_buf_get,
Jens Axboe5274f052006-03-30 15:15:30 +0200142};
143
Jens Axboe912d35f2006-04-26 10:59:21 +0200144static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
145 struct pipe_buffer *buf)
146{
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200147 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
148 return 1;
149
Jens Axboe14328732006-05-03 10:35:26 +0200150 buf->flags |= PIPE_BUF_FLAG_LRU;
Jens Axboe330ab712006-05-02 15:29:57 +0200151 return generic_pipe_buf_steal(pipe, buf);
Jens Axboe912d35f2006-04-26 10:59:21 +0200152}
153
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800154static const struct pipe_buf_operations user_page_pipe_buf_ops = {
Jens Axboe912d35f2006-04-26 10:59:21 +0200155 .can_merge = 0,
Jens Axboef84d7512006-05-01 19:59:03 +0200156 .map = generic_pipe_buf_map,
157 .unmap = generic_pipe_buf_unmap,
Jens Axboecac36bb02007-06-14 13:10:48 +0200158 .confirm = generic_pipe_buf_confirm,
Jens Axboe912d35f2006-04-26 10:59:21 +0200159 .release = page_cache_pipe_buf_release,
160 .steal = user_page_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200161 .get = generic_pipe_buf_get,
Jens Axboe912d35f2006-04-26 10:59:21 +0200162};
163
Jens Axboe932cc6d2007-06-21 13:10:21 +0200164/**
165 * splice_to_pipe - fill passed data into a pipe
166 * @pipe: pipe to fill
167 * @spd: data to fill
168 *
169 * Description:
Randy Dunlap79685b82007-07-27 08:08:51 +0200170 * @spd contains a map of pages and len/offset tuples, along with
Jens Axboe932cc6d2007-06-21 13:10:21 +0200171 * the struct pipe_buf_operations associated with these pages. This
172 * function will link that data to the pipe.
173 *
Jens Axboe83f91352006-04-02 23:05:09 +0200174 */
Jens Axboed6b29d72007-06-04 09:59:47 +0200175ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
176 struct splice_pipe_desc *spd)
Jens Axboe5274f052006-03-30 15:15:30 +0200177{
Jens Axboe00de00b2007-06-15 13:14:22 +0200178 unsigned int spd_pages = spd->nr_pages;
Jens Axboe912d35f2006-04-26 10:59:21 +0200179 int ret, do_wakeup, page_nr;
Jens Axboe5274f052006-03-30 15:15:30 +0200180
181 ret = 0;
182 do_wakeup = 0;
Jens Axboe912d35f2006-04-26 10:59:21 +0200183 page_nr = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200184
Ingo Molnar3a326a22006-04-10 15:18:35 +0200185 if (pipe->inode)
186 mutex_lock(&pipe->inode->i_mutex);
Jens Axboe5274f052006-03-30 15:15:30 +0200187
Jens Axboe5274f052006-03-30 15:15:30 +0200188 for (;;) {
Ingo Molnar3a326a22006-04-10 15:18:35 +0200189 if (!pipe->readers) {
Jens Axboe5274f052006-03-30 15:15:30 +0200190 send_sig(SIGPIPE, current, 0);
191 if (!ret)
192 ret = -EPIPE;
193 break;
194 }
195
Jens Axboe6f767b02006-04-11 13:53:56 +0200196 if (pipe->nrbufs < PIPE_BUFFERS) {
197 int newbuf = (pipe->curbuf + pipe->nrbufs) & (PIPE_BUFFERS - 1);
Ingo Molnar3a326a22006-04-10 15:18:35 +0200198 struct pipe_buffer *buf = pipe->bufs + newbuf;
Jens Axboe5274f052006-03-30 15:15:30 +0200199
Jens Axboe912d35f2006-04-26 10:59:21 +0200200 buf->page = spd->pages[page_nr];
201 buf->offset = spd->partial[page_nr].offset;
202 buf->len = spd->partial[page_nr].len;
Jens Axboe497f9622007-06-11 12:00:45 +0200203 buf->private = spd->partial[page_nr].private;
Jens Axboe912d35f2006-04-26 10:59:21 +0200204 buf->ops = spd->ops;
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200205 if (spd->flags & SPLICE_F_GIFT)
206 buf->flags |= PIPE_BUF_FLAG_GIFT;
207
Jens Axboe6f767b02006-04-11 13:53:56 +0200208 pipe->nrbufs++;
Jens Axboe912d35f2006-04-26 10:59:21 +0200209 page_nr++;
210 ret += buf->len;
211
Jens Axboe6f767b02006-04-11 13:53:56 +0200212 if (pipe->inode)
213 do_wakeup = 1;
Jens Axboe5274f052006-03-30 15:15:30 +0200214
Jens Axboe912d35f2006-04-26 10:59:21 +0200215 if (!--spd->nr_pages)
Jens Axboe5274f052006-03-30 15:15:30 +0200216 break;
Jens Axboe6f767b02006-04-11 13:53:56 +0200217 if (pipe->nrbufs < PIPE_BUFFERS)
Jens Axboe5274f052006-03-30 15:15:30 +0200218 continue;
219
220 break;
221 }
222
Jens Axboe912d35f2006-04-26 10:59:21 +0200223 if (spd->flags & SPLICE_F_NONBLOCK) {
Linus Torvalds29e35092006-04-02 12:46:35 -0700224 if (!ret)
225 ret = -EAGAIN;
226 break;
227 }
228
Jens Axboe5274f052006-03-30 15:15:30 +0200229 if (signal_pending(current)) {
230 if (!ret)
231 ret = -ERESTARTSYS;
232 break;
233 }
234
235 if (do_wakeup) {
Jens Axboec0bd1f62006-04-10 09:03:32 +0200236 smp_mb();
Ingo Molnar3a326a22006-04-10 15:18:35 +0200237 if (waitqueue_active(&pipe->wait))
238 wake_up_interruptible_sync(&pipe->wait);
239 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
Jens Axboe5274f052006-03-30 15:15:30 +0200240 do_wakeup = 0;
241 }
242
Ingo Molnar3a326a22006-04-10 15:18:35 +0200243 pipe->waiting_writers++;
244 pipe_wait(pipe);
245 pipe->waiting_writers--;
Jens Axboe5274f052006-03-30 15:15:30 +0200246 }
247
Jens Axboe02676e52007-06-15 13:16:13 +0200248 if (pipe->inode) {
Ingo Molnar3a326a22006-04-10 15:18:35 +0200249 mutex_unlock(&pipe->inode->i_mutex);
Jens Axboe5274f052006-03-30 15:15:30 +0200250
Jens Axboe02676e52007-06-15 13:16:13 +0200251 if (do_wakeup) {
252 smp_mb();
253 if (waitqueue_active(&pipe->wait))
254 wake_up_interruptible(&pipe->wait);
255 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
256 }
Jens Axboe5274f052006-03-30 15:15:30 +0200257 }
258
Jens Axboe00de00b2007-06-15 13:14:22 +0200259 while (page_nr < spd_pages)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800260 spd->spd_release(spd, page_nr++);
Jens Axboe5274f052006-03-30 15:15:30 +0200261
262 return ret;
263}
264
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800265static void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
266{
267 page_cache_release(spd->pages[i]);
268}
269
Ingo Molnar3a326a22006-04-10 15:18:35 +0200270static int
Jens Axboecbb7e572006-04-11 14:57:50 +0200271__generic_file_splice_read(struct file *in, loff_t *ppos,
272 struct pipe_inode_info *pipe, size_t len,
273 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200274{
275 struct address_space *mapping = in->f_mapping;
Fengguang Wud8983912007-07-19 01:48:06 -0700276 unsigned int loff, nr_pages, req_pages;
Jens Axboe16c523d2006-04-10 09:03:58 +0200277 struct page *pages[PIPE_BUFFERS];
Jens Axboe912d35f2006-04-26 10:59:21 +0200278 struct partial_page partial[PIPE_BUFFERS];
Jens Axboe5274f052006-03-30 15:15:30 +0200279 struct page *page;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200280 pgoff_t index, end_index;
281 loff_t isize;
Jens Axboeeb207962006-04-27 11:05:22 +0200282 int error, page_nr;
Jens Axboe912d35f2006-04-26 10:59:21 +0200283 struct splice_pipe_desc spd = {
284 .pages = pages,
285 .partial = partial,
286 .flags = flags,
287 .ops = &page_cache_pipe_buf_ops,
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800288 .spd_release = spd_release_page,
Jens Axboe912d35f2006-04-26 10:59:21 +0200289 };
Jens Axboe5274f052006-03-30 15:15:30 +0200290
Jens Axboecbb7e572006-04-11 14:57:50 +0200291 index = *ppos >> PAGE_CACHE_SHIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +0200292 loff = *ppos & ~PAGE_CACHE_MASK;
Fengguang Wud8983912007-07-19 01:48:06 -0700293 req_pages = (len + loff + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
294 nr_pages = min(req_pages, (unsigned)PIPE_BUFFERS);
Jens Axboe5274f052006-03-30 15:15:30 +0200295
296 /*
Jens Axboeeb207962006-04-27 11:05:22 +0200297 * Lookup the (hopefully) full range of pages we need.
298 */
299 spd.nr_pages = find_get_pages_contig(mapping, index, nr_pages, pages);
Fengguang Wu431a48202007-07-19 01:48:05 -0700300 index += spd.nr_pages;
Jens Axboeeb207962006-04-27 11:05:22 +0200301
302 /*
303 * If find_get_pages_contig() returned fewer pages than we needed,
Fengguang Wu431a48202007-07-19 01:48:05 -0700304 * readahead/allocate the rest and fill in the holes.
Jens Axboeeb207962006-04-27 11:05:22 +0200305 */
Fengguang Wu431a48202007-07-19 01:48:05 -0700306 if (spd.nr_pages < nr_pages)
Rusty Russellcf914a72007-07-19 01:48:08 -0700307 page_cache_sync_readahead(mapping, &in->f_ra, in,
308 index, req_pages - spd.nr_pages);
Fengguang Wu431a48202007-07-19 01:48:05 -0700309
Jens Axboe932cc6d2007-06-21 13:10:21 +0200310 error = 0;
Jens Axboeeb207962006-04-27 11:05:22 +0200311 while (spd.nr_pages < nr_pages) {
312 /*
313 * Page could be there, find_get_pages_contig() breaks on
314 * the first hole.
315 */
316 page = find_get_page(mapping, index);
317 if (!page) {
Jens Axboee27dedd2006-05-01 19:59:54 +0200318 /*
Jens Axboeeb207962006-04-27 11:05:22 +0200319 * page didn't exist, allocate one.
320 */
321 page = page_cache_alloc_cold(mapping);
322 if (!page)
323 break;
324
325 error = add_to_page_cache_lru(page, mapping, index,
Hugh Dickins4cd13502008-04-03 23:35:22 +0100326 mapping_gfp_mask(mapping));
Jens Axboeeb207962006-04-27 11:05:22 +0200327 if (unlikely(error)) {
328 page_cache_release(page);
Jens Axboea0548872006-05-03 10:58:22 +0200329 if (error == -EEXIST)
330 continue;
Jens Axboeeb207962006-04-27 11:05:22 +0200331 break;
332 }
333 /*
334 * add_to_page_cache() locks the page, unlock it
335 * to avoid convoluting the logic below even more.
336 */
337 unlock_page(page);
338 }
339
340 pages[spd.nr_pages++] = page;
341 index++;
342 }
343
344 /*
345 * Now loop over the map and see if we need to start IO on any
346 * pages, fill in the partial map, etc.
347 */
348 index = *ppos >> PAGE_CACHE_SHIFT;
349 nr_pages = spd.nr_pages;
350 spd.nr_pages = 0;
351 for (page_nr = 0; page_nr < nr_pages; page_nr++) {
Jens Axboe82aa5d62006-04-20 13:05:48 +0200352 unsigned int this_len;
353
354 if (!len)
355 break;
356
357 /*
358 * this_len is the max we'll use from this page
359 */
Andrew Mortonba5f5d92006-04-25 15:33:34 +0200360 this_len = min_t(unsigned long, len, PAGE_CACHE_SIZE - loff);
Jens Axboeeb207962006-04-27 11:05:22 +0200361 page = pages[page_nr];
Jens Axboe7480a902006-04-11 13:52:47 +0200362
Fengguang Wua08a1662007-07-19 01:48:03 -0700363 if (PageReadahead(page))
Rusty Russellcf914a72007-07-19 01:48:08 -0700364 page_cache_async_readahead(mapping, &in->f_ra, in,
Fengguang Wud8983912007-07-19 01:48:06 -0700365 page, index, req_pages - page_nr);
Fengguang Wua08a1662007-07-19 01:48:03 -0700366
Jens Axboe7480a902006-04-11 13:52:47 +0200367 /*
368 * If the page isn't uptodate, we may need to start io on it
369 */
370 if (!PageUptodate(page)) {
Jens Axboec4f895c2006-04-19 15:56:12 +0200371 /*
372 * If in nonblock mode then dont block on waiting
373 * for an in-flight io page
374 */
Fengguang Wu9ae9d682007-05-08 08:44:36 +0200375 if (flags & SPLICE_F_NONBLOCK) {
Nick Piggin529ae9a2008-08-02 12:01:03 +0200376 if (!trylock_page(page)) {
Jens Axboe8191ecd2008-04-10 08:24:25 +0200377 error = -EAGAIN;
Fengguang Wu9ae9d682007-05-08 08:44:36 +0200378 break;
Jens Axboe8191ecd2008-04-10 08:24:25 +0200379 }
Fengguang Wu9ae9d682007-05-08 08:44:36 +0200380 } else
381 lock_page(page);
Jens Axboe7480a902006-04-11 13:52:47 +0200382
383 /*
Miklos Szeredi32502b82008-07-04 09:35:17 +0200384 * Page was truncated, or invalidated by the
385 * filesystem. Redo the find/create, but this time the
386 * page is kept locked, so there's no chance of another
387 * race with truncate/invalidate.
Jens Axboe7480a902006-04-11 13:52:47 +0200388 */
389 if (!page->mapping) {
390 unlock_page(page);
Miklos Szeredi32502b82008-07-04 09:35:17 +0200391 page = find_or_create_page(mapping, index,
392 mapping_gfp_mask(mapping));
393
394 if (!page) {
395 error = -ENOMEM;
396 break;
397 }
398 page_cache_release(pages[page_nr]);
399 pages[page_nr] = page;
Jens Axboe7480a902006-04-11 13:52:47 +0200400 }
401 /*
402 * page was already under io and is now done, great
403 */
404 if (PageUptodate(page)) {
405 unlock_page(page);
406 goto fill_it;
407 }
408
Jens Axboe7480a902006-04-11 13:52:47 +0200409 /*
410 * need to read in the page
411 */
412 error = mapping->a_ops->readpage(in, page);
Jens Axboe7480a902006-04-11 13:52:47 +0200413 if (unlikely(error)) {
Jens Axboeeb207962006-04-27 11:05:22 +0200414 /*
415 * We really should re-lookup the page here,
416 * but it complicates things a lot. Instead
417 * lets just do what we already stored, and
418 * we'll get it the next time we are called.
419 */
Jens Axboe7480a902006-04-11 13:52:47 +0200420 if (error == AOP_TRUNCATED_PAGE)
Jens Axboeeb207962006-04-27 11:05:22 +0200421 error = 0;
422
Jens Axboe7480a902006-04-11 13:52:47 +0200423 break;
424 }
Jens Axboe620a3242007-06-07 09:39:42 +0200425 }
426fill_it:
427 /*
428 * i_size must be checked after PageUptodate.
429 */
430 isize = i_size_read(mapping->host);
431 end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
432 if (unlikely(!isize || index > end_index))
433 break;
434
435 /*
436 * if this is the last page, see if we need to shrink
437 * the length and stop
438 */
439 if (end_index == index) {
440 unsigned int plen;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200441
442 /*
Jens Axboe620a3242007-06-07 09:39:42 +0200443 * max good bytes in this page
Jens Axboe91ad66e2006-04-19 15:55:10 +0200444 */
Jens Axboe620a3242007-06-07 09:39:42 +0200445 plen = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
446 if (plen <= loff)
Jens Axboe91ad66e2006-04-19 15:55:10 +0200447 break;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200448
449 /*
Jens Axboe620a3242007-06-07 09:39:42 +0200450 * force quit after adding this page
Jens Axboe91ad66e2006-04-19 15:55:10 +0200451 */
Jens Axboe620a3242007-06-07 09:39:42 +0200452 this_len = min(this_len, plen - loff);
453 len = this_len;
Jens Axboe7480a902006-04-11 13:52:47 +0200454 }
Jens Axboe620a3242007-06-07 09:39:42 +0200455
Jens Axboeeb207962006-04-27 11:05:22 +0200456 partial[page_nr].offset = loff;
457 partial[page_nr].len = this_len;
Jens Axboe82aa5d62006-04-20 13:05:48 +0200458 len -= this_len;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200459 loff = 0;
Jens Axboeeb207962006-04-27 11:05:22 +0200460 spd.nr_pages++;
461 index++;
Jens Axboe5274f052006-03-30 15:15:30 +0200462 }
463
Jens Axboeeb207962006-04-27 11:05:22 +0200464 /*
Hugh Dickins475ecad2007-06-07 09:36:00 +0200465 * Release any pages at the end, if we quit early. 'page_nr' is how far
Jens Axboeeb207962006-04-27 11:05:22 +0200466 * we got, 'nr_pages' is how many pages are in the map.
467 */
468 while (page_nr < nr_pages)
469 page_cache_release(pages[page_nr++]);
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700470 in->f_ra.prev_pos = (loff_t)index << PAGE_CACHE_SHIFT;
Jens Axboeeb207962006-04-27 11:05:22 +0200471
Jens Axboe912d35f2006-04-26 10:59:21 +0200472 if (spd.nr_pages)
Jens Axboe00522fb2006-04-26 14:39:29 +0200473 return splice_to_pipe(pipe, &spd);
Jens Axboe5274f052006-03-30 15:15:30 +0200474
Jens Axboe7480a902006-04-11 13:52:47 +0200475 return error;
Jens Axboe5274f052006-03-30 15:15:30 +0200476}
477
Jens Axboe83f91352006-04-02 23:05:09 +0200478/**
479 * generic_file_splice_read - splice data from file to a pipe
480 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200481 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200482 * @pipe: pipe to splice to
483 * @len: number of bytes to splice
484 * @flags: splice modifier flags
485 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200486 * Description:
487 * Will read pages from given file and fill them into a pipe. Can be
488 * used as long as the address_space operations for the source implements
489 * a readpage() hook.
490 *
Jens Axboe83f91352006-04-02 23:05:09 +0200491 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200492ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
493 struct pipe_inode_info *pipe, size_t len,
494 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200495{
Jens Axboed366d3982007-06-01 14:54:11 +0200496 loff_t isize, left;
Jens Axboe8191ecd2008-04-10 08:24:25 +0200497 int ret;
Jens Axboed366d3982007-06-01 14:54:11 +0200498
499 isize = i_size_read(in->f_mapping->host);
500 if (unlikely(*ppos >= isize))
501 return 0;
502
503 left = isize - *ppos;
504 if (unlikely(left < len))
505 len = left;
Jens Axboe5274f052006-03-30 15:15:30 +0200506
Jens Axboe8191ecd2008-04-10 08:24:25 +0200507 ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
508 if (ret > 0)
Jens Axboecbb7e572006-04-11 14:57:50 +0200509 *ppos += ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200510
511 return ret;
512}
513
Jens Axboe059a8f32006-04-02 23:06:05 +0200514EXPORT_SYMBOL(generic_file_splice_read);
515
Jens Axboe5274f052006-03-30 15:15:30 +0200516/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200517 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200518 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200519 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200520static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200521 struct pipe_buffer *buf, struct splice_desc *sd)
522{
Jens Axboe6a14b902007-06-14 13:08:55 +0200523 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200524 loff_t pos = sd->pos;
Jens Axboef84d7512006-05-01 19:59:03 +0200525 int ret, more;
Jens Axboe5274f052006-03-30 15:15:30 +0200526
Jens Axboecac36bb02007-06-14 13:10:48 +0200527 ret = buf->ops->confirm(pipe, buf);
Jens Axboef84d7512006-05-01 19:59:03 +0200528 if (!ret) {
529 more = (sd->flags & SPLICE_F_MORE) || sd->len < sd->total_len;
Jens Axboe5274f052006-03-30 15:15:30 +0200530
Jens Axboef84d7512006-05-01 19:59:03 +0200531 ret = file->f_op->sendpage(file, buf->page, buf->offset,
532 sd->len, &pos, more);
533 }
Jens Axboe5274f052006-03-30 15:15:30 +0200534
Jens Axboe016b6612006-04-25 15:42:00 +0200535 return ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200536}
537
538/*
539 * This is a little more tricky than the file -> pipe splicing. There are
540 * basically three cases:
541 *
542 * - Destination page already exists in the address space and there
543 * are users of it. For that case we have no other option that
544 * copying the data. Tough luck.
545 * - Destination page already exists in the address space, but there
546 * are no users of it. Make sure it's uptodate, then drop it. Fall
547 * through to last case.
548 * - Destination page does not exist, we can add the pipe page to
549 * the page cache and avoid the copy.
550 *
Jens Axboe83f91352006-04-02 23:05:09 +0200551 * If asked to move pages to the output file (SPLICE_F_MOVE is set in
552 * sd->flags), we attempt to migrate pages from the pipe to the output
553 * file address space page cache. This is possible if no one else has
554 * the pipe page referenced outside of the pipe and page cache. If
555 * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create
556 * a new page in the output file page cache and fill/dirty that.
Jens Axboe5274f052006-03-30 15:15:30 +0200557 */
Miklos Szeredi328eaab2009-04-14 19:48:39 +0200558int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
559 struct splice_desc *sd)
Jens Axboe5274f052006-03-30 15:15:30 +0200560{
Jens Axboe6a14b902007-06-14 13:08:55 +0200561 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200562 struct address_space *mapping = file->f_mapping;
Jens Axboe016b6612006-04-25 15:42:00 +0200563 unsigned int offset, this_len;
Jens Axboe5274f052006-03-30 15:15:30 +0200564 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -0700565 void *fsdata;
Jens Axboe3e7ee3e2006-04-02 23:11:04 +0200566 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200567
568 /*
Jens Axboe49d0b212006-04-10 09:04:41 +0200569 * make sure the data in this buffer is uptodate
Jens Axboe5274f052006-03-30 15:15:30 +0200570 */
Jens Axboecac36bb02007-06-14 13:10:48 +0200571 ret = buf->ops->confirm(pipe, buf);
Jens Axboef84d7512006-05-01 19:59:03 +0200572 if (unlikely(ret))
573 return ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200574
Jens Axboe5274f052006-03-30 15:15:30 +0200575 offset = sd->pos & ~PAGE_CACHE_MASK;
576
Jens Axboe016b6612006-04-25 15:42:00 +0200577 this_len = sd->len;
578 if (this_len + offset > PAGE_CACHE_SIZE)
579 this_len = PAGE_CACHE_SIZE - offset;
580
Nick Pigginafddba42007-10-16 01:25:01 -0700581 ret = pagecache_write_begin(file, mapping, sd->pos, this_len,
582 AOP_FLAG_UNINTERRUPTIBLE, &page, &fsdata);
583 if (unlikely(ret))
584 goto out;
Jens Axboe5274f052006-03-30 15:15:30 +0200585
Jens Axboe0568b402006-05-01 19:50:48 +0200586 if (buf->page != page) {
Jens Axboef84d7512006-05-01 19:59:03 +0200587 /*
588 * Careful, ->map() uses KM_USER0!
589 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200590 char *src = buf->ops->map(pipe, buf, 1);
Jens Axboef84d7512006-05-01 19:59:03 +0200591 char *dst = kmap_atomic(page, KM_USER1);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200592
Jens Axboe016b6612006-04-25 15:42:00 +0200593 memcpy(dst + offset, src + buf->offset, this_len);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200594 flush_dcache_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200595 kunmap_atomic(dst, KM_USER1);
Jens Axboe76ad4d12006-05-03 10:41:33 +0200596 buf->ops->unmap(pipe, buf, src);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200597 }
Nick Pigginafddba42007-10-16 01:25:01 -0700598 ret = pagecache_write_end(file, mapping, sd->pos, this_len, this_len,
599 page, fsdata);
Jens Axboe5274f052006-03-30 15:15:30 +0200600out:
Jens Axboe5274f052006-03-30 15:15:30 +0200601 return ret;
602}
Miklos Szeredi328eaab2009-04-14 19:48:39 +0200603EXPORT_SYMBOL(pipe_to_file);
Jens Axboe5274f052006-03-30 15:15:30 +0200604
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200605static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
606{
607 smp_mb();
608 if (waitqueue_active(&pipe->wait))
609 wake_up_interruptible(&pipe->wait);
610 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
611}
612
613/**
614 * splice_from_pipe_feed - feed available data from a pipe to a file
615 * @pipe: pipe to splice from
616 * @sd: information to @actor
617 * @actor: handler that splices the data
618 *
619 * Description:
620
621 * This function loops over the pipe and calls @actor to do the
622 * actual moving of a single struct pipe_buffer to the desired
623 * destination. It returns when there's no more buffers left in
624 * the pipe or if the requested number of bytes (@sd->total_len)
625 * have been copied. It returns a positive number (one) if the
626 * pipe needs to be filled with more data, zero if the required
627 * number of bytes have been copied and -errno on error.
628 *
629 * This, together with splice_from_pipe_{begin,end,next}, may be
630 * used to implement the functionality of __splice_from_pipe() when
631 * locking is required around copying the pipe buffers to the
632 * destination.
633 */
634int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
635 splice_actor *actor)
636{
637 int ret;
638
639 while (pipe->nrbufs) {
640 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
641 const struct pipe_buf_operations *ops = buf->ops;
642
643 sd->len = buf->len;
644 if (sd->len > sd->total_len)
645 sd->len = sd->total_len;
646
647 ret = actor(pipe, buf, sd);
648 if (ret <= 0) {
649 if (ret == -ENODATA)
650 ret = 0;
651 return ret;
652 }
653 buf->offset += ret;
654 buf->len -= ret;
655
656 sd->num_spliced += ret;
657 sd->len -= ret;
658 sd->pos += ret;
659 sd->total_len -= ret;
660
661 if (!buf->len) {
662 buf->ops = NULL;
663 ops->release(pipe, buf);
664 pipe->curbuf = (pipe->curbuf + 1) & (PIPE_BUFFERS - 1);
665 pipe->nrbufs--;
666 if (pipe->inode)
667 sd->need_wakeup = true;
668 }
669
670 if (!sd->total_len)
671 return 0;
672 }
673
674 return 1;
675}
676EXPORT_SYMBOL(splice_from_pipe_feed);
677
678/**
679 * splice_from_pipe_next - wait for some data to splice from
680 * @pipe: pipe to splice from
681 * @sd: information about the splice operation
682 *
683 * Description:
684 * This function will wait for some data and return a positive
685 * value (one) if pipe buffers are available. It will return zero
686 * or -errno if no more data needs to be spliced.
687 */
688int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
689{
690 while (!pipe->nrbufs) {
691 if (!pipe->writers)
692 return 0;
693
694 if (!pipe->waiting_writers && sd->num_spliced)
695 return 0;
696
697 if (sd->flags & SPLICE_F_NONBLOCK)
698 return -EAGAIN;
699
700 if (signal_pending(current))
701 return -ERESTARTSYS;
702
703 if (sd->need_wakeup) {
704 wakeup_pipe_writers(pipe);
705 sd->need_wakeup = false;
706 }
707
708 pipe_wait(pipe);
709 }
710
711 return 1;
712}
713EXPORT_SYMBOL(splice_from_pipe_next);
714
715/**
716 * splice_from_pipe_begin - start splicing from pipe
717 * @pipe: pipe to splice from
718 *
719 * Description:
720 * This function should be called before a loop containing
721 * splice_from_pipe_next() and splice_from_pipe_feed() to
722 * initialize the necessary fields of @sd.
723 */
724void splice_from_pipe_begin(struct splice_desc *sd)
725{
726 sd->num_spliced = 0;
727 sd->need_wakeup = false;
728}
729EXPORT_SYMBOL(splice_from_pipe_begin);
730
731/**
732 * splice_from_pipe_end - finish splicing from pipe
733 * @pipe: pipe to splice from
734 * @sd: information about the splice operation
735 *
736 * Description:
737 * This function will wake up pipe writers if necessary. It should
738 * be called after a loop containing splice_from_pipe_next() and
739 * splice_from_pipe_feed().
740 */
741void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
742{
743 if (sd->need_wakeup)
744 wakeup_pipe_writers(pipe);
745}
746EXPORT_SYMBOL(splice_from_pipe_end);
747
Jens Axboe932cc6d2007-06-21 13:10:21 +0200748/**
749 * __splice_from_pipe - splice data from a pipe to given actor
750 * @pipe: pipe to splice from
751 * @sd: information to @actor
752 * @actor: handler that splices the data
753 *
754 * Description:
755 * This function does little more than loop over the pipe and call
756 * @actor to do the actual moving of a single struct pipe_buffer to
757 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
758 * pipe_to_user.
759 *
Jens Axboe83f91352006-04-02 23:05:09 +0200760 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200761ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
762 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200763{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200764 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200765
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200766 splice_from_pipe_begin(sd);
767 do {
768 ret = splice_from_pipe_next(pipe, sd);
769 if (ret > 0)
770 ret = splice_from_pipe_feed(pipe, sd, actor);
771 } while (ret > 0);
772 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200773
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200774 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200775}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100776EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200777
Jens Axboe932cc6d2007-06-21 13:10:21 +0200778/**
779 * splice_from_pipe - splice data from a pipe to a file
780 * @pipe: pipe to splice from
781 * @out: file to splice to
782 * @ppos: position in @out
783 * @len: how many bytes to splice
784 * @flags: splice modifier flags
785 * @actor: handler that splices the data
786 *
787 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200788 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200789 * otherwise it's identical to __splice_from_pipe().
790 *
791 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200792ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
793 loff_t *ppos, size_t len, unsigned int flags,
794 splice_actor *actor)
795{
796 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200797 struct splice_desc sd = {
798 .total_len = len,
799 .flags = flags,
800 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200801 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200802 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200803
Miklos Szeredi7bfac9e2009-04-06 17:41:00 +0200804 if (pipe->inode)
Miklos Szeredi29339702009-04-14 19:48:37 +0200805 mutex_lock(&pipe->inode->i_mutex);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200806 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi7bfac9e2009-04-06 17:41:00 +0200807 if (pipe->inode)
808 mutex_unlock(&pipe->inode->i_mutex);
Mark Fasheh6da61802006-10-17 18:43:07 +0200809
810 return ret;
811}
812
813/**
814 * generic_file_splice_write_nolock - generic_file_splice_write without mutexes
815 * @pipe: pipe info
816 * @out: file to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200817 * @ppos: position in @out
Mark Fasheh6da61802006-10-17 18:43:07 +0200818 * @len: number of bytes to splice
819 * @flags: splice modifier flags
820 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200821 * Description:
822 * Will either move or copy pages (determined by @flags options) from
823 * the given pipe inode to the given file. The caller is responsible
824 * for acquiring i_mutex on both inodes.
Mark Fasheh6da61802006-10-17 18:43:07 +0200825 *
826 */
827ssize_t
828generic_file_splice_write_nolock(struct pipe_inode_info *pipe, struct file *out,
829 loff_t *ppos, size_t len, unsigned int flags)
830{
831 struct address_space *mapping = out->f_mapping;
832 struct inode *inode = mapping->host;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200833 struct splice_desc sd = {
834 .total_len = len,
835 .flags = flags,
836 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200837 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200838 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200839 ssize_t ret;
840 int err;
841
Miklos Szeredi2f1936b2008-06-24 16:50:14 +0200842 err = file_remove_suid(out);
Jens Axboe8c34e2d2006-10-17 19:43:22 +0200843 if (unlikely(err))
844 return err;
845
Jens Axboec66ab6f2007-06-12 21:17:17 +0200846 ret = __splice_from_pipe(pipe, &sd, pipe_to_file);
Mark Fasheh6da61802006-10-17 18:43:07 +0200847 if (ret > 0) {
Jens Axboe17ee4f42007-06-15 13:10:37 +0200848 unsigned long nr_pages;
849
Mark Fasheh6da61802006-10-17 18:43:07 +0200850 *ppos += ret;
Jens Axboe17ee4f42007-06-15 13:10:37 +0200851 nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
Mark Fasheh6da61802006-10-17 18:43:07 +0200852
853 /*
854 * If file or inode is SYNC and we actually wrote some data,
855 * sync it.
856 */
857 if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(inode))) {
858 err = generic_osync_inode(inode, mapping,
859 OSYNC_METADATA|OSYNC_DATA);
860
861 if (err)
862 ret = err;
863 }
Jens Axboe17ee4f42007-06-15 13:10:37 +0200864 balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
Mark Fasheh6da61802006-10-17 18:43:07 +0200865 }
866
867 return ret;
868}
869
870EXPORT_SYMBOL(generic_file_splice_write_nolock);
871
Jens Axboe83f91352006-04-02 23:05:09 +0200872/**
873 * generic_file_splice_write - splice data from a pipe to a file
Ingo Molnar3a326a22006-04-10 15:18:35 +0200874 * @pipe: pipe info
Jens Axboe83f91352006-04-02 23:05:09 +0200875 * @out: file to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200876 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200877 * @len: number of bytes to splice
878 * @flags: splice modifier flags
879 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200880 * Description:
881 * Will either move or copy pages (determined by @flags options) from
882 * the given pipe inode to the given file.
Jens Axboe83f91352006-04-02 23:05:09 +0200883 *
884 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200885ssize_t
886generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200887 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200888{
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200889 struct address_space *mapping = out->f_mapping;
Jens Axboe8c34e2d2006-10-17 19:43:22 +0200890 struct inode *inode = mapping->host;
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +0200891 struct splice_desc sd = {
892 .total_len = len,
893 .flags = flags,
894 .pos = *ppos,
895 .u.file = out,
896 };
Ingo Molnar3a326a22006-04-10 15:18:35 +0200897 ssize_t ret;
Jens Axboe8c34e2d2006-10-17 19:43:22 +0200898
Miklos Szeredieb443e52009-04-14 19:48:38 +0200899 if (pipe->inode)
900 mutex_lock_nested(&pipe->inode->i_mutex, I_MUTEX_PARENT);
901
902 splice_from_pipe_begin(&sd);
903 do {
904 ret = splice_from_pipe_next(pipe, &sd);
905 if (ret <= 0)
906 break;
907
908 mutex_lock_nested(&inode->i_mutex, I_MUTEX_CHILD);
909 ret = file_remove_suid(out);
910 if (!ret)
911 ret = splice_from_pipe_feed(pipe, &sd, pipe_to_file);
912 mutex_unlock(&inode->i_mutex);
913 } while (ret > 0);
914 splice_from_pipe_end(pipe, &sd);
915
916 if (pipe->inode)
917 mutex_unlock(&pipe->inode->i_mutex);
918
919 if (sd.num_spliced)
920 ret = sd.num_spliced;
921
Jens Axboea4514eb2006-04-19 15:57:05 +0200922 if (ret > 0) {
Jens Axboe17ee4f42007-06-15 13:10:37 +0200923 unsigned long nr_pages;
924
Jens Axboea4514eb2006-04-19 15:57:05 +0200925 *ppos += ret;
Jens Axboe17ee4f42007-06-15 13:10:37 +0200926 nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200927
Jens Axboea4514eb2006-04-19 15:57:05 +0200928 /*
929 * If file or inode is SYNC and we actually wrote some data,
930 * sync it.
931 */
932 if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(inode))) {
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +0200933 int err;
934
Jens Axboea4514eb2006-04-19 15:57:05 +0200935 mutex_lock(&inode->i_mutex);
936 err = generic_osync_inode(inode, mapping,
937 OSYNC_METADATA|OSYNC_DATA);
938 mutex_unlock(&inode->i_mutex);
939
940 if (err)
941 ret = err;
942 }
Jens Axboe17ee4f42007-06-15 13:10:37 +0200943 balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200944 }
945
946 return ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200947}
948
Jens Axboe059a8f32006-04-02 23:06:05 +0200949EXPORT_SYMBOL(generic_file_splice_write);
950
Jens Axboe83f91352006-04-02 23:05:09 +0200951/**
952 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200953 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200954 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200955 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200956 * @len: number of bytes to splice
957 * @flags: splice modifier flags
958 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200959 * Description:
960 * Will send @len bytes from the pipe to a network socket. No data copying
961 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200962 *
963 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200964ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200965 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200966{
Jens Axboe00522fb2006-04-26 14:39:29 +0200967 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200968}
969
Jens Axboe059a8f32006-04-02 23:06:05 +0200970EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500971
Jens Axboe83f91352006-04-02 23:05:09 +0200972/*
973 * Attempt to initiate a splice from pipe to file.
974 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200975static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200976 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200977{
Jens Axboe5274f052006-03-30 15:15:30 +0200978 int ret;
979
Jens Axboe49570e92006-04-11 13:56:09 +0200980 if (unlikely(!out->f_op || !out->f_op->splice_write))
Jens Axboe5274f052006-03-30 15:15:30 +0200981 return -EINVAL;
982
Jens Axboe49570e92006-04-11 13:56:09 +0200983 if (unlikely(!(out->f_mode & FMODE_WRITE)))
Jens Axboe5274f052006-03-30 15:15:30 +0200984 return -EBADF;
985
Linus Torvaldsefc968d2008-10-09 14:04:54 -0700986 if (unlikely(out->f_flags & O_APPEND))
987 return -EINVAL;
988
Jens Axboecbb7e572006-04-11 14:57:50 +0200989 ret = rw_verify_area(WRITE, out, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200990 if (unlikely(ret < 0))
991 return ret;
992
Jens Axboecbb7e572006-04-11 14:57:50 +0200993 return out->f_op->splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200994}
995
Jens Axboe83f91352006-04-02 23:05:09 +0200996/*
997 * Attempt to initiate a splice from a file to a pipe.
998 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200999static long do_splice_to(struct file *in, loff_t *ppos,
1000 struct pipe_inode_info *pipe, size_t len,
1001 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001002{
Jens Axboe5274f052006-03-30 15:15:30 +02001003 int ret;
1004
Jens Axboe49570e92006-04-11 13:56:09 +02001005 if (unlikely(!in->f_op || !in->f_op->splice_read))
Jens Axboe5274f052006-03-30 15:15:30 +02001006 return -EINVAL;
1007
Jens Axboe49570e92006-04-11 13:56:09 +02001008 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +02001009 return -EBADF;
1010
Jens Axboecbb7e572006-04-11 14:57:50 +02001011 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +02001012 if (unlikely(ret < 0))
1013 return ret;
1014
Jens Axboecbb7e572006-04-11 14:57:50 +02001015 return in->f_op->splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +02001016}
1017
Jens Axboe932cc6d2007-06-21 13:10:21 +02001018/**
1019 * splice_direct_to_actor - splices data directly between two non-pipes
1020 * @in: file to splice from
1021 * @sd: actor information on where to splice to
1022 * @actor: handles the data splicing
1023 *
1024 * Description:
1025 * This is a special case helper to splice directly between two
1026 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +02001027 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +02001028 * that process.
1029 *
Jens Axboec66ab6f2007-06-12 21:17:17 +02001030 */
1031ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
1032 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +02001033{
1034 struct pipe_inode_info *pipe;
1035 long ret, bytes;
1036 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001037 size_t len;
1038 int i, flags;
Jens Axboeb92ce552006-04-11 13:52:07 +02001039
1040 /*
1041 * We require the input being a regular file, as we don't want to
1042 * randomly drop data for eg socket -> socket splicing. Use the
1043 * piped splicing for that!
1044 */
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001045 i_mode = in->f_path.dentry->d_inode->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +02001046 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
1047 return -EINVAL;
1048
1049 /*
1050 * neither in nor out is a pipe, setup an internal pipe attached to
1051 * 'out' and transfer the wanted data from 'in' to 'out' through that
1052 */
1053 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +02001054 if (unlikely(!pipe)) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001055 pipe = alloc_pipe_info(NULL);
1056 if (!pipe)
1057 return -ENOMEM;
1058
1059 /*
1060 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +02001061 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +02001062 * PIPE_READERS appropriately.
1063 */
1064 pipe->readers = 1;
1065
1066 current->splice_pipe = pipe;
1067 }
1068
1069 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +02001070 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +02001071 */
1072 ret = 0;
1073 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001074 len = sd->total_len;
1075 flags = sd->flags;
1076
1077 /*
1078 * Don't block on output, we have to drain the direct pipe.
1079 */
1080 sd->flags &= ~SPLICE_F_NONBLOCK;
Jens Axboeb92ce552006-04-11 13:52:07 +02001081
1082 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +02001083 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001084 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001085
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001086 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +02001087 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +02001088 goto out_release;
1089
1090 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001091 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +02001092
1093 /*
1094 * NOTE: nonblocking mode only applies to the input. We
1095 * must not do the output in nonblocking mode as then we
1096 * could get stuck data in the internal pipe:
1097 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001098 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +02001099 if (unlikely(ret <= 0)) {
1100 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001101 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001102 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001103
1104 bytes += ret;
1105 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001106 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001107
Tom Zanussia82c53a2008-05-09 13:28:36 +02001108 if (ret < read_len) {
1109 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001110 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001111 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001112 }
1113
Jens Axboe9e971982008-01-29 21:05:57 +01001114done:
Jens Axboeb92ce552006-04-11 13:52:07 +02001115 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001116 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001117 return bytes;
1118
1119out_release:
1120 /*
1121 * If we did an incomplete transfer we must release
1122 * the pipe buffers in question:
1123 */
1124 for (i = 0; i < PIPE_BUFFERS; i++) {
1125 struct pipe_buffer *buf = pipe->bufs + i;
1126
1127 if (buf->ops) {
1128 buf->ops->release(pipe, buf);
1129 buf->ops = NULL;
1130 }
1131 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001132
Jens Axboe9e971982008-01-29 21:05:57 +01001133 if (!bytes)
1134 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001135
Jens Axboe9e971982008-01-29 21:05:57 +01001136 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001137}
1138EXPORT_SYMBOL(splice_direct_to_actor);
1139
1140static int direct_splice_actor(struct pipe_inode_info *pipe,
1141 struct splice_desc *sd)
1142{
Jens Axboe6a14b902007-06-14 13:08:55 +02001143 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001144
1145 return do_splice_from(pipe, file, &sd->pos, sd->total_len, sd->flags);
1146}
1147
Jens Axboe932cc6d2007-06-21 13:10:21 +02001148/**
1149 * do_splice_direct - splices data directly between two files
1150 * @in: file to splice from
1151 * @ppos: input file offset
1152 * @out: file to splice to
1153 * @len: number of bytes to splice
1154 * @flags: splice modifier flags
1155 *
1156 * Description:
1157 * For use by do_sendfile(). splice can easily emulate sendfile, but
1158 * doing it in the application would incur an extra system call
1159 * (splice in + splice out, as compared to just sendfile()). So this helper
1160 * can splice directly through a process-private pipe.
1161 *
1162 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001163long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
1164 size_t len, unsigned int flags)
1165{
1166 struct splice_desc sd = {
1167 .len = len,
1168 .total_len = len,
1169 .flags = flags,
1170 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001171 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001172 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001173 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001174
1175 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001176 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001177 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001178
Jens Axboec66ab6f2007-06-12 21:17:17 +02001179 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001180}
1181
Jens Axboe83f91352006-04-02 23:05:09 +02001182/*
Jens Axboeddac0d32006-11-04 12:49:32 +01001183 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
1184 * location, so checking ->i_pipe is not enough to verify that this is a
1185 * pipe.
1186 */
1187static inline struct pipe_inode_info *pipe_info(struct inode *inode)
1188{
1189 if (S_ISFIFO(inode->i_mode))
1190 return inode->i_pipe;
1191
1192 return NULL;
1193}
1194
1195/*
Jens Axboe83f91352006-04-02 23:05:09 +02001196 * Determine where to splice to/from.
1197 */
Ingo Molnar529565d2006-04-10 15:18:58 +02001198static long do_splice(struct file *in, loff_t __user *off_in,
1199 struct file *out, loff_t __user *off_out,
1200 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001201{
Ingo Molnar3a326a22006-04-10 15:18:35 +02001202 struct pipe_inode_info *pipe;
Jens Axboecbb7e572006-04-11 14:57:50 +02001203 loff_t offset, *off;
Jens Axboea4514eb2006-04-19 15:57:05 +02001204 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001205
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001206 pipe = pipe_info(in->f_path.dentry->d_inode);
Ingo Molnar529565d2006-04-10 15:18:58 +02001207 if (pipe) {
1208 if (off_in)
1209 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001210 if (off_out) {
1211 if (out->f_op->llseek == no_llseek)
1212 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001213 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001214 return -EFAULT;
Jens Axboecbb7e572006-04-11 14:57:50 +02001215 off = &offset;
1216 } else
1217 off = &out->f_pos;
Ingo Molnar529565d2006-04-10 15:18:58 +02001218
Jens Axboea4514eb2006-04-19 15:57:05 +02001219 ret = do_splice_from(pipe, out, off, len, flags);
1220
1221 if (off_out && copy_to_user(off_out, off, sizeof(loff_t)))
1222 ret = -EFAULT;
1223
1224 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001225 }
Jens Axboe5274f052006-03-30 15:15:30 +02001226
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001227 pipe = pipe_info(out->f_path.dentry->d_inode);
Ingo Molnar529565d2006-04-10 15:18:58 +02001228 if (pipe) {
1229 if (off_out)
1230 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001231 if (off_in) {
1232 if (in->f_op->llseek == no_llseek)
1233 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001234 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001235 return -EFAULT;
Jens Axboecbb7e572006-04-11 14:57:50 +02001236 off = &offset;
1237 } else
1238 off = &in->f_pos;
Ingo Molnar529565d2006-04-10 15:18:58 +02001239
Jens Axboea4514eb2006-04-19 15:57:05 +02001240 ret = do_splice_to(in, off, pipe, len, flags);
1241
1242 if (off_in && copy_to_user(off_in, off, sizeof(loff_t)))
1243 ret = -EFAULT;
1244
1245 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001246 }
Jens Axboe5274f052006-03-30 15:15:30 +02001247
1248 return -EINVAL;
1249}
1250
Jens Axboe912d35f2006-04-26 10:59:21 +02001251/*
1252 * Map an iov into an array of pages and offset/length tupples. With the
1253 * partial_page structure, we can map several non-contiguous ranges into
1254 * our ones pages[] map instead of splitting that operation into pieces.
1255 * Could easily be exported as a generic helper for other users, in which
1256 * case one would probably want to add a 'max_nr_pages' parameter as well.
1257 */
1258static int get_iovec_page_array(const struct iovec __user *iov,
1259 unsigned int nr_vecs, struct page **pages,
Jens Axboe7afa6fd2006-05-01 20:02:33 +02001260 struct partial_page *partial, int aligned)
Jens Axboe912d35f2006-04-26 10:59:21 +02001261{
1262 int buffers = 0, error = 0;
1263
Jens Axboe912d35f2006-04-26 10:59:21 +02001264 while (nr_vecs) {
1265 unsigned long off, npages;
Linus Torvalds75723952007-10-01 13:17:28 -07001266 struct iovec entry;
Jens Axboe912d35f2006-04-26 10:59:21 +02001267 void __user *base;
1268 size_t len;
1269 int i;
1270
Linus Torvalds75723952007-10-01 13:17:28 -07001271 error = -EFAULT;
Nick Pigginbc40d732008-07-25 19:45:26 -07001272 if (copy_from_user(&entry, iov, sizeof(entry)))
Jens Axboe912d35f2006-04-26 10:59:21 +02001273 break;
Linus Torvalds75723952007-10-01 13:17:28 -07001274
1275 base = entry.iov_base;
1276 len = entry.iov_len;
Jens Axboe912d35f2006-04-26 10:59:21 +02001277
1278 /*
1279 * Sanity check this iovec. 0 read succeeds.
1280 */
Linus Torvalds75723952007-10-01 13:17:28 -07001281 error = 0;
Jens Axboe912d35f2006-04-26 10:59:21 +02001282 if (unlikely(!len))
1283 break;
1284 error = -EFAULT;
Bastian Blank712a30e2008-02-10 16:47:57 +02001285 if (!access_ok(VERIFY_READ, base, len))
Jens Axboe912d35f2006-04-26 10:59:21 +02001286 break;
1287
1288 /*
1289 * Get this base offset and number of pages, then map
1290 * in the user pages.
1291 */
1292 off = (unsigned long) base & ~PAGE_MASK;
Jens Axboe7afa6fd2006-05-01 20:02:33 +02001293
1294 /*
1295 * If asked for alignment, the offset must be zero and the
1296 * length a multiple of the PAGE_SIZE.
1297 */
1298 error = -EINVAL;
1299 if (aligned && (off || len & ~PAGE_MASK))
1300 break;
1301
Jens Axboe912d35f2006-04-26 10:59:21 +02001302 npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1303 if (npages > PIPE_BUFFERS - buffers)
1304 npages = PIPE_BUFFERS - buffers;
1305
Nick Pigginbc40d732008-07-25 19:45:26 -07001306 error = get_user_pages_fast((unsigned long)base, npages,
1307 0, &pages[buffers]);
Jens Axboe912d35f2006-04-26 10:59:21 +02001308
1309 if (unlikely(error <= 0))
1310 break;
1311
1312 /*
1313 * Fill this contiguous range into the partial page map.
1314 */
1315 for (i = 0; i < error; i++) {
Jens Axboe75914892006-05-02 12:57:18 +02001316 const int plen = min_t(size_t, len, PAGE_SIZE - off);
Jens Axboe912d35f2006-04-26 10:59:21 +02001317
1318 partial[buffers].offset = off;
1319 partial[buffers].len = plen;
1320
1321 off = 0;
1322 len -= plen;
1323 buffers++;
1324 }
1325
1326 /*
1327 * We didn't complete this iov, stop here since it probably
1328 * means we have to move some of this into a pipe to
1329 * be able to continue.
1330 */
1331 if (len)
1332 break;
1333
1334 /*
1335 * Don't continue if we mapped fewer pages than we asked for,
1336 * or if we mapped the max number of pages that we have
1337 * room for.
1338 */
1339 if (error < npages || buffers == PIPE_BUFFERS)
1340 break;
1341
1342 nr_vecs--;
1343 iov++;
1344 }
1345
Jens Axboe912d35f2006-04-26 10:59:21 +02001346 if (buffers)
1347 return buffers;
1348
1349 return error;
1350}
1351
Jens Axboe6a14b902007-06-14 13:08:55 +02001352static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1353 struct splice_desc *sd)
1354{
1355 char *src;
1356 int ret;
1357
Jens Axboecac36bb02007-06-14 13:10:48 +02001358 ret = buf->ops->confirm(pipe, buf);
Jens Axboe6a14b902007-06-14 13:08:55 +02001359 if (unlikely(ret))
1360 return ret;
1361
1362 /*
1363 * See if we can use the atomic maps, by prefaulting in the
1364 * pages and doing an atomic copy
1365 */
1366 if (!fault_in_pages_writeable(sd->u.userptr, sd->len)) {
1367 src = buf->ops->map(pipe, buf, 1);
1368 ret = __copy_to_user_inatomic(sd->u.userptr, src + buf->offset,
1369 sd->len);
1370 buf->ops->unmap(pipe, buf, src);
1371 if (!ret) {
1372 ret = sd->len;
1373 goto out;
1374 }
1375 }
1376
1377 /*
1378 * No dice, use slow non-atomic map and copy
1379 */
1380 src = buf->ops->map(pipe, buf, 0);
1381
1382 ret = sd->len;
1383 if (copy_to_user(sd->u.userptr, src + buf->offset, sd->len))
1384 ret = -EFAULT;
1385
Jens Axboe6866bef2007-10-16 10:01:29 +02001386 buf->ops->unmap(pipe, buf, src);
Jens Axboe6a14b902007-06-14 13:08:55 +02001387out:
1388 if (ret > 0)
1389 sd->u.userptr += ret;
Jens Axboe6a14b902007-06-14 13:08:55 +02001390 return ret;
1391}
1392
1393/*
1394 * For lack of a better implementation, implement vmsplice() to userspace
1395 * as a simple copy of the pipes pages to the user iov.
1396 */
1397static long vmsplice_to_user(struct file *file, const struct iovec __user *iov,
1398 unsigned long nr_segs, unsigned int flags)
1399{
1400 struct pipe_inode_info *pipe;
1401 struct splice_desc sd;
1402 ssize_t size;
1403 int error;
1404 long ret;
1405
1406 pipe = pipe_info(file->f_path.dentry->d_inode);
1407 if (!pipe)
1408 return -EBADF;
1409
1410 if (pipe->inode)
1411 mutex_lock(&pipe->inode->i_mutex);
1412
1413 error = ret = 0;
1414 while (nr_segs) {
1415 void __user *base;
1416 size_t len;
1417
1418 /*
1419 * Get user address base and length for this iovec.
1420 */
1421 error = get_user(base, &iov->iov_base);
1422 if (unlikely(error))
1423 break;
1424 error = get_user(len, &iov->iov_len);
1425 if (unlikely(error))
1426 break;
1427
1428 /*
1429 * Sanity check this iovec. 0 read succeeds.
1430 */
1431 if (unlikely(!len))
1432 break;
1433 if (unlikely(!base)) {
1434 error = -EFAULT;
1435 break;
1436 }
1437
Jens Axboe88119302008-02-08 08:49:14 -08001438 if (unlikely(!access_ok(VERIFY_WRITE, base, len))) {
1439 error = -EFAULT;
1440 break;
1441 }
1442
Jens Axboe6a14b902007-06-14 13:08:55 +02001443 sd.len = 0;
1444 sd.total_len = len;
1445 sd.flags = flags;
1446 sd.u.userptr = base;
1447 sd.pos = 0;
1448
1449 size = __splice_from_pipe(pipe, &sd, pipe_to_user);
1450 if (size < 0) {
1451 if (!ret)
1452 ret = size;
1453
1454 break;
1455 }
1456
1457 ret += size;
1458
1459 if (size < len)
1460 break;
1461
1462 nr_segs--;
1463 iov++;
1464 }
1465
1466 if (pipe->inode)
1467 mutex_unlock(&pipe->inode->i_mutex);
1468
1469 if (!ret)
1470 ret = error;
1471
1472 return ret;
1473}
1474
Jens Axboe912d35f2006-04-26 10:59:21 +02001475/*
1476 * vmsplice splices a user address range into a pipe. It can be thought of
1477 * as splice-from-memory, where the regular splice is splice-from-file (or
1478 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001479 */
Jens Axboe6a14b902007-06-14 13:08:55 +02001480static long vmsplice_to_pipe(struct file *file, const struct iovec __user *iov,
1481 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001482{
Jens Axboeddac0d32006-11-04 12:49:32 +01001483 struct pipe_inode_info *pipe;
Jens Axboe912d35f2006-04-26 10:59:21 +02001484 struct page *pages[PIPE_BUFFERS];
1485 struct partial_page partial[PIPE_BUFFERS];
1486 struct splice_pipe_desc spd = {
1487 .pages = pages,
1488 .partial = partial,
1489 .flags = flags,
1490 .ops = &user_page_pipe_buf_ops,
Jens Axboebbdfc2f2007-11-06 23:29:47 -08001491 .spd_release = spd_release_page,
Jens Axboe912d35f2006-04-26 10:59:21 +02001492 };
1493
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001494 pipe = pipe_info(file->f_path.dentry->d_inode);
Jens Axboeddac0d32006-11-04 12:49:32 +01001495 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001496 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001497
Jens Axboe7afa6fd2006-05-01 20:02:33 +02001498 spd.nr_pages = get_iovec_page_array(iov, nr_segs, pages, partial,
1499 flags & SPLICE_F_GIFT);
Jens Axboe912d35f2006-04-26 10:59:21 +02001500 if (spd.nr_pages <= 0)
1501 return spd.nr_pages;
1502
Jens Axboe00522fb2006-04-26 14:39:29 +02001503 return splice_to_pipe(pipe, &spd);
Jens Axboe912d35f2006-04-26 10:59:21 +02001504}
1505
Jens Axboe6a14b902007-06-14 13:08:55 +02001506/*
1507 * Note that vmsplice only really supports true splicing _from_ user memory
1508 * to a pipe, not the other way around. Splicing from user memory is a simple
1509 * operation that can be supported without any funky alignment restrictions
1510 * or nasty vm tricks. We simply map in the user memory and fill them into
1511 * a pipe. The reverse isn't quite as easy, though. There are two possible
1512 * solutions for that:
1513 *
1514 * - memcpy() the data internally, at which point we might as well just
1515 * do a regular read() on the buffer anyway.
1516 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1517 * has restriction limitations on both ends of the pipe).
1518 *
1519 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1520 *
1521 */
Heiko Carstens836f92a2009-01-14 14:14:33 +01001522SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1523 unsigned long, nr_segs, unsigned int, flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001524{
1525 struct file *file;
1526 long error;
1527 int fput;
1528
Jens Axboe6a14b902007-06-14 13:08:55 +02001529 if (unlikely(nr_segs > UIO_MAXIOV))
1530 return -EINVAL;
1531 else if (unlikely(!nr_segs))
1532 return 0;
1533
Jens Axboe912d35f2006-04-26 10:59:21 +02001534 error = -EBADF;
1535 file = fget_light(fd, &fput);
1536 if (file) {
1537 if (file->f_mode & FMODE_WRITE)
Jens Axboe6a14b902007-06-14 13:08:55 +02001538 error = vmsplice_to_pipe(file, iov, nr_segs, flags);
1539 else if (file->f_mode & FMODE_READ)
1540 error = vmsplice_to_user(file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001541
1542 fput_light(file, fput);
1543 }
1544
1545 return error;
1546}
1547
Heiko Carstens836f92a2009-01-14 14:14:33 +01001548SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1549 int, fd_out, loff_t __user *, off_out,
1550 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001551{
1552 long error;
1553 struct file *in, *out;
1554 int fput_in, fput_out;
1555
1556 if (unlikely(!len))
1557 return 0;
1558
1559 error = -EBADF;
Ingo Molnar529565d2006-04-10 15:18:58 +02001560 in = fget_light(fd_in, &fput_in);
Jens Axboe5274f052006-03-30 15:15:30 +02001561 if (in) {
1562 if (in->f_mode & FMODE_READ) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001563 out = fget_light(fd_out, &fput_out);
Jens Axboe5274f052006-03-30 15:15:30 +02001564 if (out) {
1565 if (out->f_mode & FMODE_WRITE)
Ingo Molnar529565d2006-04-10 15:18:58 +02001566 error = do_splice(in, off_in,
1567 out, off_out,
1568 len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +02001569 fput_light(out, fput_out);
1570 }
1571 }
1572
1573 fput_light(in, fput_in);
1574 }
1575
1576 return error;
1577}
Jens Axboe70524492006-04-11 15:51:17 +02001578
1579/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001580 * Make sure there's data to read. Wait for input if we can, otherwise
1581 * return an appropriate error.
1582 */
1583static int link_ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1584{
1585 int ret;
1586
1587 /*
1588 * Check ->nrbufs without the inode lock first. This function
1589 * is speculative anyways, so missing one is ok.
1590 */
1591 if (pipe->nrbufs)
1592 return 0;
1593
1594 ret = 0;
1595 mutex_lock(&pipe->inode->i_mutex);
1596
1597 while (!pipe->nrbufs) {
1598 if (signal_pending(current)) {
1599 ret = -ERESTARTSYS;
1600 break;
1601 }
1602 if (!pipe->writers)
1603 break;
1604 if (!pipe->waiting_writers) {
1605 if (flags & SPLICE_F_NONBLOCK) {
1606 ret = -EAGAIN;
1607 break;
1608 }
1609 }
1610 pipe_wait(pipe);
1611 }
1612
1613 mutex_unlock(&pipe->inode->i_mutex);
1614 return ret;
1615}
1616
1617/*
1618 * Make sure there's writeable room. Wait for room if we can, otherwise
1619 * return an appropriate error.
1620 */
1621static int link_opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1622{
1623 int ret;
1624
1625 /*
1626 * Check ->nrbufs without the inode lock first. This function
1627 * is speculative anyways, so missing one is ok.
1628 */
1629 if (pipe->nrbufs < PIPE_BUFFERS)
1630 return 0;
1631
1632 ret = 0;
1633 mutex_lock(&pipe->inode->i_mutex);
1634
1635 while (pipe->nrbufs >= PIPE_BUFFERS) {
1636 if (!pipe->readers) {
1637 send_sig(SIGPIPE, current, 0);
1638 ret = -EPIPE;
1639 break;
1640 }
1641 if (flags & SPLICE_F_NONBLOCK) {
1642 ret = -EAGAIN;
1643 break;
1644 }
1645 if (signal_pending(current)) {
1646 ret = -ERESTARTSYS;
1647 break;
1648 }
1649 pipe->waiting_writers++;
1650 pipe_wait(pipe);
1651 pipe->waiting_writers--;
1652 }
1653
1654 mutex_unlock(&pipe->inode->i_mutex);
1655 return ret;
1656}
1657
1658/*
Jens Axboe70524492006-04-11 15:51:17 +02001659 * Link contents of ipipe to opipe.
1660 */
1661static int link_pipe(struct pipe_inode_info *ipipe,
1662 struct pipe_inode_info *opipe,
1663 size_t len, unsigned int flags)
1664{
1665 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001666 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001667
1668 /*
1669 * Potential ABBA deadlock, work around it by ordering lock
1670 * grabbing by inode address. Otherwise two different processes
1671 * could deadlock (one doing tee from A -> B, the other from B -> A).
1672 */
Mark Fasheh62752ee2006-10-17 10:31:38 +02001673 inode_double_lock(ipipe->inode, opipe->inode);
Jens Axboe70524492006-04-11 15:51:17 +02001674
Jens Axboeaadd06e2006-07-10 11:00:01 +02001675 do {
Jens Axboe70524492006-04-11 15:51:17 +02001676 if (!opipe->readers) {
1677 send_sig(SIGPIPE, current, 0);
1678 if (!ret)
1679 ret = -EPIPE;
1680 break;
1681 }
Jens Axboe70524492006-04-11 15:51:17 +02001682
1683 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001684 * If we have iterated all input buffers or ran out of
1685 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001686 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001687 if (i >= ipipe->nrbufs || opipe->nrbufs >= PIPE_BUFFERS)
Jens Axboe70524492006-04-11 15:51:17 +02001688 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001689
1690 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (PIPE_BUFFERS - 1));
1691 nbuf = (opipe->curbuf + opipe->nrbufs) & (PIPE_BUFFERS - 1);
1692
Jens Axboe2a27250e2006-04-19 15:56:40 +02001693 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001694 * Get a reference to this pipe buffer,
1695 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001696 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001697 ibuf->ops->get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001698
Jens Axboeaadd06e2006-07-10 11:00:01 +02001699 obuf = opipe->bufs + nbuf;
1700 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001701
Jens Axboeaadd06e2006-07-10 11:00:01 +02001702 /*
1703 * Don't inherit the gift flag, we need to
1704 * prevent multiple steals of this page.
1705 */
1706 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1707
1708 if (obuf->len > len)
1709 obuf->len = len;
1710
1711 opipe->nrbufs++;
1712 ret += obuf->len;
1713 len -= obuf->len;
1714 i++;
1715 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001716
Jens Axboe02cf01a2008-02-20 10:34:51 +01001717 /*
1718 * return EAGAIN if we have the potential of some data in the
1719 * future, otherwise just return 0
1720 */
1721 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1722 ret = -EAGAIN;
1723
Mark Fasheh62752ee2006-10-17 10:31:38 +02001724 inode_double_unlock(ipipe->inode, opipe->inode);
Jens Axboe70524492006-04-11 15:51:17 +02001725
Jens Axboeaadd06e2006-07-10 11:00:01 +02001726 /*
1727 * If we put data in the output pipe, wakeup any potential readers.
1728 */
1729 if (ret > 0) {
Jens Axboe70524492006-04-11 15:51:17 +02001730 smp_mb();
1731 if (waitqueue_active(&opipe->wait))
1732 wake_up_interruptible(&opipe->wait);
1733 kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN);
1734 }
1735
1736 return ret;
1737}
1738
1739/*
1740 * This is a tee(1) implementation that works on pipes. It doesn't copy
1741 * any data, it simply references the 'in' pages on the 'out' pipe.
1742 * The 'flags' used are the SPLICE_F_* variants, currently the only
1743 * applicable one is SPLICE_F_NONBLOCK.
1744 */
1745static long do_tee(struct file *in, struct file *out, size_t len,
1746 unsigned int flags)
1747{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001748 struct pipe_inode_info *ipipe = pipe_info(in->f_path.dentry->d_inode);
1749 struct pipe_inode_info *opipe = pipe_info(out->f_path.dentry->d_inode);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001750 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001751
1752 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001753 * Duplicate the contents of ipipe to opipe without actually
1754 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001755 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001756 if (ipipe && opipe && ipipe != opipe) {
1757 /*
1758 * Keep going, unless we encounter an error. The ipipe/opipe
1759 * ordering doesn't really matter.
1760 */
1761 ret = link_ipipe_prep(ipipe, flags);
1762 if (!ret) {
1763 ret = link_opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001764 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001765 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001766 }
1767 }
Jens Axboe70524492006-04-11 15:51:17 +02001768
Jens Axboeaadd06e2006-07-10 11:00:01 +02001769 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001770}
1771
Heiko Carstens836f92a2009-01-14 14:14:33 +01001772SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001773{
1774 struct file *in;
1775 int error, fput_in;
1776
1777 if (unlikely(!len))
1778 return 0;
1779
1780 error = -EBADF;
1781 in = fget_light(fdin, &fput_in);
1782 if (in) {
1783 if (in->f_mode & FMODE_READ) {
1784 int fput_out;
1785 struct file *out = fget_light(fdout, &fput_out);
1786
1787 if (out) {
1788 if (out->f_mode & FMODE_WRITE)
1789 error = do_tee(in, out, len, flags);
1790 fput_light(out, fput_out);
1791 }
1792 }
1793 fput_light(in, fput_in);
1794 }
1795
1796 return error;
1797}