blob: a1f595b9db40bb4b1535bdd716ff41bdfe5faaa0 [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 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200558static int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
Jens Axboe5274f052006-03-30 15:15:30 +0200559 struct splice_desc *sd)
560{
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}
603
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200604static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
605{
606 smp_mb();
607 if (waitqueue_active(&pipe->wait))
608 wake_up_interruptible(&pipe->wait);
609 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
610}
611
612/**
613 * splice_from_pipe_feed - feed available data from a pipe to a file
614 * @pipe: pipe to splice from
615 * @sd: information to @actor
616 * @actor: handler that splices the data
617 *
618 * Description:
619
620 * This function loops over the pipe and calls @actor to do the
621 * actual moving of a single struct pipe_buffer to the desired
622 * destination. It returns when there's no more buffers left in
623 * the pipe or if the requested number of bytes (@sd->total_len)
624 * have been copied. It returns a positive number (one) if the
625 * pipe needs to be filled with more data, zero if the required
626 * number of bytes have been copied and -errno on error.
627 *
628 * This, together with splice_from_pipe_{begin,end,next}, may be
629 * used to implement the functionality of __splice_from_pipe() when
630 * locking is required around copying the pipe buffers to the
631 * destination.
632 */
633int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
634 splice_actor *actor)
635{
636 int ret;
637
638 while (pipe->nrbufs) {
639 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
640 const struct pipe_buf_operations *ops = buf->ops;
641
642 sd->len = buf->len;
643 if (sd->len > sd->total_len)
644 sd->len = sd->total_len;
645
646 ret = actor(pipe, buf, sd);
647 if (ret <= 0) {
648 if (ret == -ENODATA)
649 ret = 0;
650 return ret;
651 }
652 buf->offset += ret;
653 buf->len -= ret;
654
655 sd->num_spliced += ret;
656 sd->len -= ret;
657 sd->pos += ret;
658 sd->total_len -= ret;
659
660 if (!buf->len) {
661 buf->ops = NULL;
662 ops->release(pipe, buf);
663 pipe->curbuf = (pipe->curbuf + 1) & (PIPE_BUFFERS - 1);
664 pipe->nrbufs--;
665 if (pipe->inode)
666 sd->need_wakeup = true;
667 }
668
669 if (!sd->total_len)
670 return 0;
671 }
672
673 return 1;
674}
675EXPORT_SYMBOL(splice_from_pipe_feed);
676
677/**
678 * splice_from_pipe_next - wait for some data to splice from
679 * @pipe: pipe to splice from
680 * @sd: information about the splice operation
681 *
682 * Description:
683 * This function will wait for some data and return a positive
684 * value (one) if pipe buffers are available. It will return zero
685 * or -errno if no more data needs to be spliced.
686 */
687int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
688{
689 while (!pipe->nrbufs) {
690 if (!pipe->writers)
691 return 0;
692
693 if (!pipe->waiting_writers && sd->num_spliced)
694 return 0;
695
696 if (sd->flags & SPLICE_F_NONBLOCK)
697 return -EAGAIN;
698
699 if (signal_pending(current))
700 return -ERESTARTSYS;
701
702 if (sd->need_wakeup) {
703 wakeup_pipe_writers(pipe);
704 sd->need_wakeup = false;
705 }
706
707 pipe_wait(pipe);
708 }
709
710 return 1;
711}
712EXPORT_SYMBOL(splice_from_pipe_next);
713
714/**
715 * splice_from_pipe_begin - start splicing from pipe
716 * @pipe: pipe to splice from
717 *
718 * Description:
719 * This function should be called before a loop containing
720 * splice_from_pipe_next() and splice_from_pipe_feed() to
721 * initialize the necessary fields of @sd.
722 */
723void splice_from_pipe_begin(struct splice_desc *sd)
724{
725 sd->num_spliced = 0;
726 sd->need_wakeup = false;
727}
728EXPORT_SYMBOL(splice_from_pipe_begin);
729
730/**
731 * splice_from_pipe_end - finish splicing from pipe
732 * @pipe: pipe to splice from
733 * @sd: information about the splice operation
734 *
735 * Description:
736 * This function will wake up pipe writers if necessary. It should
737 * be called after a loop containing splice_from_pipe_next() and
738 * splice_from_pipe_feed().
739 */
740void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
741{
742 if (sd->need_wakeup)
743 wakeup_pipe_writers(pipe);
744}
745EXPORT_SYMBOL(splice_from_pipe_end);
746
Jens Axboe932cc6d2007-06-21 13:10:21 +0200747/**
748 * __splice_from_pipe - splice data from a pipe to given actor
749 * @pipe: pipe to splice from
750 * @sd: information to @actor
751 * @actor: handler that splices the data
752 *
753 * Description:
754 * This function does little more than loop over the pipe and call
755 * @actor to do the actual moving of a single struct pipe_buffer to
756 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
757 * pipe_to_user.
758 *
Jens Axboe83f91352006-04-02 23:05:09 +0200759 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200760ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
761 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200762{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200763 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200764
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200765 splice_from_pipe_begin(sd);
766 do {
767 ret = splice_from_pipe_next(pipe, sd);
768 if (ret > 0)
769 ret = splice_from_pipe_feed(pipe, sd, actor);
770 } while (ret > 0);
771 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200772
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200773 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200774}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100775EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200776
Jens Axboe932cc6d2007-06-21 13:10:21 +0200777/**
778 * splice_from_pipe - splice data from a pipe to a file
779 * @pipe: pipe to splice from
780 * @out: file to splice to
781 * @ppos: position in @out
782 * @len: how many bytes to splice
783 * @flags: splice modifier flags
784 * @actor: handler that splices the data
785 *
786 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200787 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200788 * otherwise it's identical to __splice_from_pipe().
789 *
790 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200791ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
792 loff_t *ppos, size_t len, unsigned int flags,
793 splice_actor *actor)
794{
795 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200796 struct splice_desc sd = {
797 .total_len = len,
798 .flags = flags,
799 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200800 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200801 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200802
Miklos Szeredi7bfac9e2009-04-06 17:41:00 +0200803 if (pipe->inode)
Miklos Szeredi29339702009-04-14 19:48:37 +0200804 mutex_lock(&pipe->inode->i_mutex);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200805 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi7bfac9e2009-04-06 17:41:00 +0200806 if (pipe->inode)
807 mutex_unlock(&pipe->inode->i_mutex);
Mark Fasheh6da61802006-10-17 18:43:07 +0200808
809 return ret;
810}
811
812/**
813 * generic_file_splice_write_nolock - generic_file_splice_write without mutexes
814 * @pipe: pipe info
815 * @out: file to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200816 * @ppos: position in @out
Mark Fasheh6da61802006-10-17 18:43:07 +0200817 * @len: number of bytes to splice
818 * @flags: splice modifier flags
819 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200820 * Description:
821 * Will either move or copy pages (determined by @flags options) from
822 * the given pipe inode to the given file. The caller is responsible
823 * for acquiring i_mutex on both inodes.
Mark Fasheh6da61802006-10-17 18:43:07 +0200824 *
825 */
826ssize_t
827generic_file_splice_write_nolock(struct pipe_inode_info *pipe, struct file *out,
828 loff_t *ppos, size_t len, unsigned int flags)
829{
830 struct address_space *mapping = out->f_mapping;
831 struct inode *inode = mapping->host;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200832 struct splice_desc sd = {
833 .total_len = len,
834 .flags = flags,
835 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200836 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200837 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200838 ssize_t ret;
839 int err;
840
Miklos Szeredi2f1936b2008-06-24 16:50:14 +0200841 err = file_remove_suid(out);
Jens Axboe8c34e2d2006-10-17 19:43:22 +0200842 if (unlikely(err))
843 return err;
844
Jens Axboec66ab6f2007-06-12 21:17:17 +0200845 ret = __splice_from_pipe(pipe, &sd, pipe_to_file);
Mark Fasheh6da61802006-10-17 18:43:07 +0200846 if (ret > 0) {
Jens Axboe17ee4f42007-06-15 13:10:37 +0200847 unsigned long nr_pages;
848
Mark Fasheh6da61802006-10-17 18:43:07 +0200849 *ppos += ret;
Jens Axboe17ee4f42007-06-15 13:10:37 +0200850 nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
Mark Fasheh6da61802006-10-17 18:43:07 +0200851
852 /*
853 * If file or inode is SYNC and we actually wrote some data,
854 * sync it.
855 */
856 if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(inode))) {
857 err = generic_osync_inode(inode, mapping,
858 OSYNC_METADATA|OSYNC_DATA);
859
860 if (err)
861 ret = err;
862 }
Jens Axboe17ee4f42007-06-15 13:10:37 +0200863 balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
Mark Fasheh6da61802006-10-17 18:43:07 +0200864 }
865
866 return ret;
867}
868
869EXPORT_SYMBOL(generic_file_splice_write_nolock);
870
Jens Axboe83f91352006-04-02 23:05:09 +0200871/**
872 * generic_file_splice_write - splice data from a pipe to a file
Ingo Molnar3a326a22006-04-10 15:18:35 +0200873 * @pipe: pipe info
Jens Axboe83f91352006-04-02 23:05:09 +0200874 * @out: file to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200875 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200876 * @len: number of bytes to splice
877 * @flags: splice modifier flags
878 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200879 * Description:
880 * Will either move or copy pages (determined by @flags options) from
881 * the given pipe inode to the given file.
Jens Axboe83f91352006-04-02 23:05:09 +0200882 *
883 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200884ssize_t
885generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200886 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200887{
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200888 struct address_space *mapping = out->f_mapping;
Jens Axboe8c34e2d2006-10-17 19:43:22 +0200889 struct inode *inode = mapping->host;
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +0200890 struct splice_desc sd = {
891 .total_len = len,
892 .flags = flags,
893 .pos = *ppos,
894 .u.file = out,
895 };
Ingo Molnar3a326a22006-04-10 15:18:35 +0200896 ssize_t ret;
Jens Axboe8c34e2d2006-10-17 19:43:22 +0200897
Miklos Szeredieb443e52009-04-14 19:48:38 +0200898 if (pipe->inode)
899 mutex_lock_nested(&pipe->inode->i_mutex, I_MUTEX_PARENT);
900
901 splice_from_pipe_begin(&sd);
902 do {
903 ret = splice_from_pipe_next(pipe, &sd);
904 if (ret <= 0)
905 break;
906
907 mutex_lock_nested(&inode->i_mutex, I_MUTEX_CHILD);
908 ret = file_remove_suid(out);
909 if (!ret)
910 ret = splice_from_pipe_feed(pipe, &sd, pipe_to_file);
911 mutex_unlock(&inode->i_mutex);
912 } while (ret > 0);
913 splice_from_pipe_end(pipe, &sd);
914
915 if (pipe->inode)
916 mutex_unlock(&pipe->inode->i_mutex);
917
918 if (sd.num_spliced)
919 ret = sd.num_spliced;
920
Jens Axboea4514eb2006-04-19 15:57:05 +0200921 if (ret > 0) {
Jens Axboe17ee4f42007-06-15 13:10:37 +0200922 unsigned long nr_pages;
923
Jens Axboea4514eb2006-04-19 15:57:05 +0200924 *ppos += ret;
Jens Axboe17ee4f42007-06-15 13:10:37 +0200925 nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200926
Jens Axboea4514eb2006-04-19 15:57:05 +0200927 /*
928 * If file or inode is SYNC and we actually wrote some data,
929 * sync it.
930 */
931 if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(inode))) {
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +0200932 int err;
933
Jens Axboea4514eb2006-04-19 15:57:05 +0200934 mutex_lock(&inode->i_mutex);
935 err = generic_osync_inode(inode, mapping,
936 OSYNC_METADATA|OSYNC_DATA);
937 mutex_unlock(&inode->i_mutex);
938
939 if (err)
940 ret = err;
941 }
Jens Axboe17ee4f42007-06-15 13:10:37 +0200942 balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200943 }
944
945 return ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200946}
947
Jens Axboe059a8f32006-04-02 23:06:05 +0200948EXPORT_SYMBOL(generic_file_splice_write);
949
Jens Axboe83f91352006-04-02 23:05:09 +0200950/**
951 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200952 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200953 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200954 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200955 * @len: number of bytes to splice
956 * @flags: splice modifier flags
957 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200958 * Description:
959 * Will send @len bytes from the pipe to a network socket. No data copying
960 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200961 *
962 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200963ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200964 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200965{
Jens Axboe00522fb2006-04-26 14:39:29 +0200966 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200967}
968
Jens Axboe059a8f32006-04-02 23:06:05 +0200969EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500970
Jens Axboe83f91352006-04-02 23:05:09 +0200971/*
972 * Attempt to initiate a splice from pipe to file.
973 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200974static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200975 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200976{
Jens Axboe5274f052006-03-30 15:15:30 +0200977 int ret;
978
Jens Axboe49570e92006-04-11 13:56:09 +0200979 if (unlikely(!out->f_op || !out->f_op->splice_write))
Jens Axboe5274f052006-03-30 15:15:30 +0200980 return -EINVAL;
981
Jens Axboe49570e92006-04-11 13:56:09 +0200982 if (unlikely(!(out->f_mode & FMODE_WRITE)))
Jens Axboe5274f052006-03-30 15:15:30 +0200983 return -EBADF;
984
Linus Torvaldsefc968d2008-10-09 14:04:54 -0700985 if (unlikely(out->f_flags & O_APPEND))
986 return -EINVAL;
987
Jens Axboecbb7e572006-04-11 14:57:50 +0200988 ret = rw_verify_area(WRITE, out, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200989 if (unlikely(ret < 0))
990 return ret;
991
Jens Axboecbb7e572006-04-11 14:57:50 +0200992 return out->f_op->splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200993}
994
Jens Axboe83f91352006-04-02 23:05:09 +0200995/*
996 * Attempt to initiate a splice from a file to a pipe.
997 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200998static long do_splice_to(struct file *in, loff_t *ppos,
999 struct pipe_inode_info *pipe, size_t len,
1000 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001001{
Jens Axboe5274f052006-03-30 15:15:30 +02001002 int ret;
1003
Jens Axboe49570e92006-04-11 13:56:09 +02001004 if (unlikely(!in->f_op || !in->f_op->splice_read))
Jens Axboe5274f052006-03-30 15:15:30 +02001005 return -EINVAL;
1006
Jens Axboe49570e92006-04-11 13:56:09 +02001007 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +02001008 return -EBADF;
1009
Jens Axboecbb7e572006-04-11 14:57:50 +02001010 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +02001011 if (unlikely(ret < 0))
1012 return ret;
1013
Jens Axboecbb7e572006-04-11 14:57:50 +02001014 return in->f_op->splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +02001015}
1016
Jens Axboe932cc6d2007-06-21 13:10:21 +02001017/**
1018 * splice_direct_to_actor - splices data directly between two non-pipes
1019 * @in: file to splice from
1020 * @sd: actor information on where to splice to
1021 * @actor: handles the data splicing
1022 *
1023 * Description:
1024 * This is a special case helper to splice directly between two
1025 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +02001026 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +02001027 * that process.
1028 *
Jens Axboec66ab6f2007-06-12 21:17:17 +02001029 */
1030ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
1031 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +02001032{
1033 struct pipe_inode_info *pipe;
1034 long ret, bytes;
1035 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001036 size_t len;
1037 int i, flags;
Jens Axboeb92ce552006-04-11 13:52:07 +02001038
1039 /*
1040 * We require the input being a regular file, as we don't want to
1041 * randomly drop data for eg socket -> socket splicing. Use the
1042 * piped splicing for that!
1043 */
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001044 i_mode = in->f_path.dentry->d_inode->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +02001045 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
1046 return -EINVAL;
1047
1048 /*
1049 * neither in nor out is a pipe, setup an internal pipe attached to
1050 * 'out' and transfer the wanted data from 'in' to 'out' through that
1051 */
1052 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +02001053 if (unlikely(!pipe)) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001054 pipe = alloc_pipe_info(NULL);
1055 if (!pipe)
1056 return -ENOMEM;
1057
1058 /*
1059 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +02001060 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +02001061 * PIPE_READERS appropriately.
1062 */
1063 pipe->readers = 1;
1064
1065 current->splice_pipe = pipe;
1066 }
1067
1068 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +02001069 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +02001070 */
1071 ret = 0;
1072 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001073 len = sd->total_len;
1074 flags = sd->flags;
1075
1076 /*
1077 * Don't block on output, we have to drain the direct pipe.
1078 */
1079 sd->flags &= ~SPLICE_F_NONBLOCK;
Jens Axboeb92ce552006-04-11 13:52:07 +02001080
1081 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +02001082 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001083 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001084
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001085 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +02001086 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +02001087 goto out_release;
1088
1089 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001090 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +02001091
1092 /*
1093 * NOTE: nonblocking mode only applies to the input. We
1094 * must not do the output in nonblocking mode as then we
1095 * could get stuck data in the internal pipe:
1096 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001097 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +02001098 if (unlikely(ret <= 0)) {
1099 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001100 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001101 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001102
1103 bytes += ret;
1104 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001105 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001106
Tom Zanussia82c53a2008-05-09 13:28:36 +02001107 if (ret < read_len) {
1108 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001109 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001110 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001111 }
1112
Jens Axboe9e971982008-01-29 21:05:57 +01001113done:
Jens Axboeb92ce552006-04-11 13:52:07 +02001114 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001115 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001116 return bytes;
1117
1118out_release:
1119 /*
1120 * If we did an incomplete transfer we must release
1121 * the pipe buffers in question:
1122 */
1123 for (i = 0; i < PIPE_BUFFERS; i++) {
1124 struct pipe_buffer *buf = pipe->bufs + i;
1125
1126 if (buf->ops) {
1127 buf->ops->release(pipe, buf);
1128 buf->ops = NULL;
1129 }
1130 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001131
Jens Axboe9e971982008-01-29 21:05:57 +01001132 if (!bytes)
1133 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001134
Jens Axboe9e971982008-01-29 21:05:57 +01001135 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001136}
1137EXPORT_SYMBOL(splice_direct_to_actor);
1138
1139static int direct_splice_actor(struct pipe_inode_info *pipe,
1140 struct splice_desc *sd)
1141{
Jens Axboe6a14b902007-06-14 13:08:55 +02001142 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001143
1144 return do_splice_from(pipe, file, &sd->pos, sd->total_len, sd->flags);
1145}
1146
Jens Axboe932cc6d2007-06-21 13:10:21 +02001147/**
1148 * do_splice_direct - splices data directly between two files
1149 * @in: file to splice from
1150 * @ppos: input file offset
1151 * @out: file to splice to
1152 * @len: number of bytes to splice
1153 * @flags: splice modifier flags
1154 *
1155 * Description:
1156 * For use by do_sendfile(). splice can easily emulate sendfile, but
1157 * doing it in the application would incur an extra system call
1158 * (splice in + splice out, as compared to just sendfile()). So this helper
1159 * can splice directly through a process-private pipe.
1160 *
1161 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001162long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
1163 size_t len, unsigned int flags)
1164{
1165 struct splice_desc sd = {
1166 .len = len,
1167 .total_len = len,
1168 .flags = flags,
1169 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001170 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001171 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001172 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001173
1174 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001175 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001176 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001177
Jens Axboec66ab6f2007-06-12 21:17:17 +02001178 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001179}
1180
Jens Axboe83f91352006-04-02 23:05:09 +02001181/*
Jens Axboeddac0d32006-11-04 12:49:32 +01001182 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
1183 * location, so checking ->i_pipe is not enough to verify that this is a
1184 * pipe.
1185 */
1186static inline struct pipe_inode_info *pipe_info(struct inode *inode)
1187{
1188 if (S_ISFIFO(inode->i_mode))
1189 return inode->i_pipe;
1190
1191 return NULL;
1192}
1193
1194/*
Jens Axboe83f91352006-04-02 23:05:09 +02001195 * Determine where to splice to/from.
1196 */
Ingo Molnar529565d2006-04-10 15:18:58 +02001197static long do_splice(struct file *in, loff_t __user *off_in,
1198 struct file *out, loff_t __user *off_out,
1199 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001200{
Ingo Molnar3a326a22006-04-10 15:18:35 +02001201 struct pipe_inode_info *pipe;
Jens Axboecbb7e572006-04-11 14:57:50 +02001202 loff_t offset, *off;
Jens Axboea4514eb2006-04-19 15:57:05 +02001203 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001204
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001205 pipe = pipe_info(in->f_path.dentry->d_inode);
Ingo Molnar529565d2006-04-10 15:18:58 +02001206 if (pipe) {
1207 if (off_in)
1208 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001209 if (off_out) {
1210 if (out->f_op->llseek == no_llseek)
1211 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001212 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001213 return -EFAULT;
Jens Axboecbb7e572006-04-11 14:57:50 +02001214 off = &offset;
1215 } else
1216 off = &out->f_pos;
Ingo Molnar529565d2006-04-10 15:18:58 +02001217
Jens Axboea4514eb2006-04-19 15:57:05 +02001218 ret = do_splice_from(pipe, out, off, len, flags);
1219
1220 if (off_out && copy_to_user(off_out, off, sizeof(loff_t)))
1221 ret = -EFAULT;
1222
1223 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001224 }
Jens Axboe5274f052006-03-30 15:15:30 +02001225
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001226 pipe = pipe_info(out->f_path.dentry->d_inode);
Ingo Molnar529565d2006-04-10 15:18:58 +02001227 if (pipe) {
1228 if (off_out)
1229 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001230 if (off_in) {
1231 if (in->f_op->llseek == no_llseek)
1232 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001233 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001234 return -EFAULT;
Jens Axboecbb7e572006-04-11 14:57:50 +02001235 off = &offset;
1236 } else
1237 off = &in->f_pos;
Ingo Molnar529565d2006-04-10 15:18:58 +02001238
Jens Axboea4514eb2006-04-19 15:57:05 +02001239 ret = do_splice_to(in, off, pipe, len, flags);
1240
1241 if (off_in && copy_to_user(off_in, off, sizeof(loff_t)))
1242 ret = -EFAULT;
1243
1244 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001245 }
Jens Axboe5274f052006-03-30 15:15:30 +02001246
1247 return -EINVAL;
1248}
1249
Jens Axboe912d35f2006-04-26 10:59:21 +02001250/*
1251 * Map an iov into an array of pages and offset/length tupples. With the
1252 * partial_page structure, we can map several non-contiguous ranges into
1253 * our ones pages[] map instead of splitting that operation into pieces.
1254 * Could easily be exported as a generic helper for other users, in which
1255 * case one would probably want to add a 'max_nr_pages' parameter as well.
1256 */
1257static int get_iovec_page_array(const struct iovec __user *iov,
1258 unsigned int nr_vecs, struct page **pages,
Jens Axboe7afa6fd2006-05-01 20:02:33 +02001259 struct partial_page *partial, int aligned)
Jens Axboe912d35f2006-04-26 10:59:21 +02001260{
1261 int buffers = 0, error = 0;
1262
Jens Axboe912d35f2006-04-26 10:59:21 +02001263 while (nr_vecs) {
1264 unsigned long off, npages;
Linus Torvalds75723952007-10-01 13:17:28 -07001265 struct iovec entry;
Jens Axboe912d35f2006-04-26 10:59:21 +02001266 void __user *base;
1267 size_t len;
1268 int i;
1269
Linus Torvalds75723952007-10-01 13:17:28 -07001270 error = -EFAULT;
Nick Pigginbc40d732008-07-25 19:45:26 -07001271 if (copy_from_user(&entry, iov, sizeof(entry)))
Jens Axboe912d35f2006-04-26 10:59:21 +02001272 break;
Linus Torvalds75723952007-10-01 13:17:28 -07001273
1274 base = entry.iov_base;
1275 len = entry.iov_len;
Jens Axboe912d35f2006-04-26 10:59:21 +02001276
1277 /*
1278 * Sanity check this iovec. 0 read succeeds.
1279 */
Linus Torvalds75723952007-10-01 13:17:28 -07001280 error = 0;
Jens Axboe912d35f2006-04-26 10:59:21 +02001281 if (unlikely(!len))
1282 break;
1283 error = -EFAULT;
Bastian Blank712a30e2008-02-10 16:47:57 +02001284 if (!access_ok(VERIFY_READ, base, len))
Jens Axboe912d35f2006-04-26 10:59:21 +02001285 break;
1286
1287 /*
1288 * Get this base offset and number of pages, then map
1289 * in the user pages.
1290 */
1291 off = (unsigned long) base & ~PAGE_MASK;
Jens Axboe7afa6fd2006-05-01 20:02:33 +02001292
1293 /*
1294 * If asked for alignment, the offset must be zero and the
1295 * length a multiple of the PAGE_SIZE.
1296 */
1297 error = -EINVAL;
1298 if (aligned && (off || len & ~PAGE_MASK))
1299 break;
1300
Jens Axboe912d35f2006-04-26 10:59:21 +02001301 npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1302 if (npages > PIPE_BUFFERS - buffers)
1303 npages = PIPE_BUFFERS - buffers;
1304
Nick Pigginbc40d732008-07-25 19:45:26 -07001305 error = get_user_pages_fast((unsigned long)base, npages,
1306 0, &pages[buffers]);
Jens Axboe912d35f2006-04-26 10:59:21 +02001307
1308 if (unlikely(error <= 0))
1309 break;
1310
1311 /*
1312 * Fill this contiguous range into the partial page map.
1313 */
1314 for (i = 0; i < error; i++) {
Jens Axboe75914892006-05-02 12:57:18 +02001315 const int plen = min_t(size_t, len, PAGE_SIZE - off);
Jens Axboe912d35f2006-04-26 10:59:21 +02001316
1317 partial[buffers].offset = off;
1318 partial[buffers].len = plen;
1319
1320 off = 0;
1321 len -= plen;
1322 buffers++;
1323 }
1324
1325 /*
1326 * We didn't complete this iov, stop here since it probably
1327 * means we have to move some of this into a pipe to
1328 * be able to continue.
1329 */
1330 if (len)
1331 break;
1332
1333 /*
1334 * Don't continue if we mapped fewer pages than we asked for,
1335 * or if we mapped the max number of pages that we have
1336 * room for.
1337 */
1338 if (error < npages || buffers == PIPE_BUFFERS)
1339 break;
1340
1341 nr_vecs--;
1342 iov++;
1343 }
1344
Jens Axboe912d35f2006-04-26 10:59:21 +02001345 if (buffers)
1346 return buffers;
1347
1348 return error;
1349}
1350
Jens Axboe6a14b902007-06-14 13:08:55 +02001351static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1352 struct splice_desc *sd)
1353{
1354 char *src;
1355 int ret;
1356
Jens Axboecac36bb02007-06-14 13:10:48 +02001357 ret = buf->ops->confirm(pipe, buf);
Jens Axboe6a14b902007-06-14 13:08:55 +02001358 if (unlikely(ret))
1359 return ret;
1360
1361 /*
1362 * See if we can use the atomic maps, by prefaulting in the
1363 * pages and doing an atomic copy
1364 */
1365 if (!fault_in_pages_writeable(sd->u.userptr, sd->len)) {
1366 src = buf->ops->map(pipe, buf, 1);
1367 ret = __copy_to_user_inatomic(sd->u.userptr, src + buf->offset,
1368 sd->len);
1369 buf->ops->unmap(pipe, buf, src);
1370 if (!ret) {
1371 ret = sd->len;
1372 goto out;
1373 }
1374 }
1375
1376 /*
1377 * No dice, use slow non-atomic map and copy
1378 */
1379 src = buf->ops->map(pipe, buf, 0);
1380
1381 ret = sd->len;
1382 if (copy_to_user(sd->u.userptr, src + buf->offset, sd->len))
1383 ret = -EFAULT;
1384
Jens Axboe6866bef2007-10-16 10:01:29 +02001385 buf->ops->unmap(pipe, buf, src);
Jens Axboe6a14b902007-06-14 13:08:55 +02001386out:
1387 if (ret > 0)
1388 sd->u.userptr += ret;
Jens Axboe6a14b902007-06-14 13:08:55 +02001389 return ret;
1390}
1391
1392/*
1393 * For lack of a better implementation, implement vmsplice() to userspace
1394 * as a simple copy of the pipes pages to the user iov.
1395 */
1396static long vmsplice_to_user(struct file *file, const struct iovec __user *iov,
1397 unsigned long nr_segs, unsigned int flags)
1398{
1399 struct pipe_inode_info *pipe;
1400 struct splice_desc sd;
1401 ssize_t size;
1402 int error;
1403 long ret;
1404
1405 pipe = pipe_info(file->f_path.dentry->d_inode);
1406 if (!pipe)
1407 return -EBADF;
1408
1409 if (pipe->inode)
1410 mutex_lock(&pipe->inode->i_mutex);
1411
1412 error = ret = 0;
1413 while (nr_segs) {
1414 void __user *base;
1415 size_t len;
1416
1417 /*
1418 * Get user address base and length for this iovec.
1419 */
1420 error = get_user(base, &iov->iov_base);
1421 if (unlikely(error))
1422 break;
1423 error = get_user(len, &iov->iov_len);
1424 if (unlikely(error))
1425 break;
1426
1427 /*
1428 * Sanity check this iovec. 0 read succeeds.
1429 */
1430 if (unlikely(!len))
1431 break;
1432 if (unlikely(!base)) {
1433 error = -EFAULT;
1434 break;
1435 }
1436
Jens Axboe88119302008-02-08 08:49:14 -08001437 if (unlikely(!access_ok(VERIFY_WRITE, base, len))) {
1438 error = -EFAULT;
1439 break;
1440 }
1441
Jens Axboe6a14b902007-06-14 13:08:55 +02001442 sd.len = 0;
1443 sd.total_len = len;
1444 sd.flags = flags;
1445 sd.u.userptr = base;
1446 sd.pos = 0;
1447
1448 size = __splice_from_pipe(pipe, &sd, pipe_to_user);
1449 if (size < 0) {
1450 if (!ret)
1451 ret = size;
1452
1453 break;
1454 }
1455
1456 ret += size;
1457
1458 if (size < len)
1459 break;
1460
1461 nr_segs--;
1462 iov++;
1463 }
1464
1465 if (pipe->inode)
1466 mutex_unlock(&pipe->inode->i_mutex);
1467
1468 if (!ret)
1469 ret = error;
1470
1471 return ret;
1472}
1473
Jens Axboe912d35f2006-04-26 10:59:21 +02001474/*
1475 * vmsplice splices a user address range into a pipe. It can be thought of
1476 * as splice-from-memory, where the regular splice is splice-from-file (or
1477 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001478 */
Jens Axboe6a14b902007-06-14 13:08:55 +02001479static long vmsplice_to_pipe(struct file *file, const struct iovec __user *iov,
1480 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001481{
Jens Axboeddac0d32006-11-04 12:49:32 +01001482 struct pipe_inode_info *pipe;
Jens Axboe912d35f2006-04-26 10:59:21 +02001483 struct page *pages[PIPE_BUFFERS];
1484 struct partial_page partial[PIPE_BUFFERS];
1485 struct splice_pipe_desc spd = {
1486 .pages = pages,
1487 .partial = partial,
1488 .flags = flags,
1489 .ops = &user_page_pipe_buf_ops,
Jens Axboebbdfc2f2007-11-06 23:29:47 -08001490 .spd_release = spd_release_page,
Jens Axboe912d35f2006-04-26 10:59:21 +02001491 };
1492
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001493 pipe = pipe_info(file->f_path.dentry->d_inode);
Jens Axboeddac0d32006-11-04 12:49:32 +01001494 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001495 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001496
Jens Axboe7afa6fd2006-05-01 20:02:33 +02001497 spd.nr_pages = get_iovec_page_array(iov, nr_segs, pages, partial,
1498 flags & SPLICE_F_GIFT);
Jens Axboe912d35f2006-04-26 10:59:21 +02001499 if (spd.nr_pages <= 0)
1500 return spd.nr_pages;
1501
Jens Axboe00522fb2006-04-26 14:39:29 +02001502 return splice_to_pipe(pipe, &spd);
Jens Axboe912d35f2006-04-26 10:59:21 +02001503}
1504
Jens Axboe6a14b902007-06-14 13:08:55 +02001505/*
1506 * Note that vmsplice only really supports true splicing _from_ user memory
1507 * to a pipe, not the other way around. Splicing from user memory is a simple
1508 * operation that can be supported without any funky alignment restrictions
1509 * or nasty vm tricks. We simply map in the user memory and fill them into
1510 * a pipe. The reverse isn't quite as easy, though. There are two possible
1511 * solutions for that:
1512 *
1513 * - memcpy() the data internally, at which point we might as well just
1514 * do a regular read() on the buffer anyway.
1515 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1516 * has restriction limitations on both ends of the pipe).
1517 *
1518 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1519 *
1520 */
Heiko Carstens836f92a2009-01-14 14:14:33 +01001521SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1522 unsigned long, nr_segs, unsigned int, flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001523{
1524 struct file *file;
1525 long error;
1526 int fput;
1527
Jens Axboe6a14b902007-06-14 13:08:55 +02001528 if (unlikely(nr_segs > UIO_MAXIOV))
1529 return -EINVAL;
1530 else if (unlikely(!nr_segs))
1531 return 0;
1532
Jens Axboe912d35f2006-04-26 10:59:21 +02001533 error = -EBADF;
1534 file = fget_light(fd, &fput);
1535 if (file) {
1536 if (file->f_mode & FMODE_WRITE)
Jens Axboe6a14b902007-06-14 13:08:55 +02001537 error = vmsplice_to_pipe(file, iov, nr_segs, flags);
1538 else if (file->f_mode & FMODE_READ)
1539 error = vmsplice_to_user(file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001540
1541 fput_light(file, fput);
1542 }
1543
1544 return error;
1545}
1546
Heiko Carstens836f92a2009-01-14 14:14:33 +01001547SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1548 int, fd_out, loff_t __user *, off_out,
1549 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001550{
1551 long error;
1552 struct file *in, *out;
1553 int fput_in, fput_out;
1554
1555 if (unlikely(!len))
1556 return 0;
1557
1558 error = -EBADF;
Ingo Molnar529565d2006-04-10 15:18:58 +02001559 in = fget_light(fd_in, &fput_in);
Jens Axboe5274f052006-03-30 15:15:30 +02001560 if (in) {
1561 if (in->f_mode & FMODE_READ) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001562 out = fget_light(fd_out, &fput_out);
Jens Axboe5274f052006-03-30 15:15:30 +02001563 if (out) {
1564 if (out->f_mode & FMODE_WRITE)
Ingo Molnar529565d2006-04-10 15:18:58 +02001565 error = do_splice(in, off_in,
1566 out, off_out,
1567 len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +02001568 fput_light(out, fput_out);
1569 }
1570 }
1571
1572 fput_light(in, fput_in);
1573 }
1574
1575 return error;
1576}
Jens Axboe70524492006-04-11 15:51:17 +02001577
1578/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001579 * Make sure there's data to read. Wait for input if we can, otherwise
1580 * return an appropriate error.
1581 */
1582static int link_ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1583{
1584 int ret;
1585
1586 /*
1587 * Check ->nrbufs without the inode lock first. This function
1588 * is speculative anyways, so missing one is ok.
1589 */
1590 if (pipe->nrbufs)
1591 return 0;
1592
1593 ret = 0;
1594 mutex_lock(&pipe->inode->i_mutex);
1595
1596 while (!pipe->nrbufs) {
1597 if (signal_pending(current)) {
1598 ret = -ERESTARTSYS;
1599 break;
1600 }
1601 if (!pipe->writers)
1602 break;
1603 if (!pipe->waiting_writers) {
1604 if (flags & SPLICE_F_NONBLOCK) {
1605 ret = -EAGAIN;
1606 break;
1607 }
1608 }
1609 pipe_wait(pipe);
1610 }
1611
1612 mutex_unlock(&pipe->inode->i_mutex);
1613 return ret;
1614}
1615
1616/*
1617 * Make sure there's writeable room. Wait for room if we can, otherwise
1618 * return an appropriate error.
1619 */
1620static int link_opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1621{
1622 int ret;
1623
1624 /*
1625 * Check ->nrbufs without the inode lock first. This function
1626 * is speculative anyways, so missing one is ok.
1627 */
1628 if (pipe->nrbufs < PIPE_BUFFERS)
1629 return 0;
1630
1631 ret = 0;
1632 mutex_lock(&pipe->inode->i_mutex);
1633
1634 while (pipe->nrbufs >= PIPE_BUFFERS) {
1635 if (!pipe->readers) {
1636 send_sig(SIGPIPE, current, 0);
1637 ret = -EPIPE;
1638 break;
1639 }
1640 if (flags & SPLICE_F_NONBLOCK) {
1641 ret = -EAGAIN;
1642 break;
1643 }
1644 if (signal_pending(current)) {
1645 ret = -ERESTARTSYS;
1646 break;
1647 }
1648 pipe->waiting_writers++;
1649 pipe_wait(pipe);
1650 pipe->waiting_writers--;
1651 }
1652
1653 mutex_unlock(&pipe->inode->i_mutex);
1654 return ret;
1655}
1656
1657/*
Jens Axboe70524492006-04-11 15:51:17 +02001658 * Link contents of ipipe to opipe.
1659 */
1660static int link_pipe(struct pipe_inode_info *ipipe,
1661 struct pipe_inode_info *opipe,
1662 size_t len, unsigned int flags)
1663{
1664 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001665 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001666
1667 /*
1668 * Potential ABBA deadlock, work around it by ordering lock
1669 * grabbing by inode address. Otherwise two different processes
1670 * could deadlock (one doing tee from A -> B, the other from B -> A).
1671 */
Mark Fasheh62752ee2006-10-17 10:31:38 +02001672 inode_double_lock(ipipe->inode, opipe->inode);
Jens Axboe70524492006-04-11 15:51:17 +02001673
Jens Axboeaadd06e2006-07-10 11:00:01 +02001674 do {
Jens Axboe70524492006-04-11 15:51:17 +02001675 if (!opipe->readers) {
1676 send_sig(SIGPIPE, current, 0);
1677 if (!ret)
1678 ret = -EPIPE;
1679 break;
1680 }
Jens Axboe70524492006-04-11 15:51:17 +02001681
1682 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001683 * If we have iterated all input buffers or ran out of
1684 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001685 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001686 if (i >= ipipe->nrbufs || opipe->nrbufs >= PIPE_BUFFERS)
Jens Axboe70524492006-04-11 15:51:17 +02001687 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001688
1689 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (PIPE_BUFFERS - 1));
1690 nbuf = (opipe->curbuf + opipe->nrbufs) & (PIPE_BUFFERS - 1);
1691
Jens Axboe2a27250e2006-04-19 15:56:40 +02001692 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001693 * Get a reference to this pipe buffer,
1694 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001695 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001696 ibuf->ops->get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001697
Jens Axboeaadd06e2006-07-10 11:00:01 +02001698 obuf = opipe->bufs + nbuf;
1699 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001700
Jens Axboeaadd06e2006-07-10 11:00:01 +02001701 /*
1702 * Don't inherit the gift flag, we need to
1703 * prevent multiple steals of this page.
1704 */
1705 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1706
1707 if (obuf->len > len)
1708 obuf->len = len;
1709
1710 opipe->nrbufs++;
1711 ret += obuf->len;
1712 len -= obuf->len;
1713 i++;
1714 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001715
Jens Axboe02cf01a2008-02-20 10:34:51 +01001716 /*
1717 * return EAGAIN if we have the potential of some data in the
1718 * future, otherwise just return 0
1719 */
1720 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1721 ret = -EAGAIN;
1722
Mark Fasheh62752ee2006-10-17 10:31:38 +02001723 inode_double_unlock(ipipe->inode, opipe->inode);
Jens Axboe70524492006-04-11 15:51:17 +02001724
Jens Axboeaadd06e2006-07-10 11:00:01 +02001725 /*
1726 * If we put data in the output pipe, wakeup any potential readers.
1727 */
1728 if (ret > 0) {
Jens Axboe70524492006-04-11 15:51:17 +02001729 smp_mb();
1730 if (waitqueue_active(&opipe->wait))
1731 wake_up_interruptible(&opipe->wait);
1732 kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN);
1733 }
1734
1735 return ret;
1736}
1737
1738/*
1739 * This is a tee(1) implementation that works on pipes. It doesn't copy
1740 * any data, it simply references the 'in' pages on the 'out' pipe.
1741 * The 'flags' used are the SPLICE_F_* variants, currently the only
1742 * applicable one is SPLICE_F_NONBLOCK.
1743 */
1744static long do_tee(struct file *in, struct file *out, size_t len,
1745 unsigned int flags)
1746{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001747 struct pipe_inode_info *ipipe = pipe_info(in->f_path.dentry->d_inode);
1748 struct pipe_inode_info *opipe = pipe_info(out->f_path.dentry->d_inode);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001749 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001750
1751 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001752 * Duplicate the contents of ipipe to opipe without actually
1753 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001754 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001755 if (ipipe && opipe && ipipe != opipe) {
1756 /*
1757 * Keep going, unless we encounter an error. The ipipe/opipe
1758 * ordering doesn't really matter.
1759 */
1760 ret = link_ipipe_prep(ipipe, flags);
1761 if (!ret) {
1762 ret = link_opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001763 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001764 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001765 }
1766 }
Jens Axboe70524492006-04-11 15:51:17 +02001767
Jens Axboeaadd06e2006-07-10 11:00:01 +02001768 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001769}
1770
Heiko Carstens836f92a2009-01-14 14:14:33 +01001771SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001772{
1773 struct file *in;
1774 int error, fput_in;
1775
1776 if (unlikely(!len))
1777 return 0;
1778
1779 error = -EBADF;
1780 in = fget_light(fdin, &fput_in);
1781 if (in) {
1782 if (in->f_mode & FMODE_READ) {
1783 int fput_out;
1784 struct file *out = fget_light(fdout, &fput_out);
1785
1786 if (out) {
1787 if (out->f_mode & FMODE_WRITE)
1788 error = do_tee(in, out, len, flags);
1789 fput_light(out, fput_out);
1790 }
1791 }
1792 fput_light(in, fput_in);
1793 }
1794
1795 return error;
1796}