blob: 1bbc6f4bb09cb850cec29e64ea34bfabe083bb3b [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>
Jens Axboe5274f052006-03-30 15:15:30 +020024#include <linux/mm_inline.h>
Jens Axboe5abc97a2006-03-30 15:16:46 +020025#include <linux/swap.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020026#include <linux/writeback.h>
27#include <linux/buffer_head.h>
Jeff Garzika0f06782006-03-30 23:06:13 -050028#include <linux/module.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020029#include <linux/syscalls.h>
Jens Axboe912d35f2006-04-26 10:59:21 +020030#include <linux/uio.h>
James Morris29ce2052007-07-13 11:44:32 +020031#include <linux/security.h>
Jens Axboe5274f052006-03-30 15:15:30 +020032
Jens Axboe83f91352006-04-02 23:05:09 +020033/*
34 * Attempt to steal a page from a pipe buffer. This should perhaps go into
35 * a vm helper function, it's already simplified quite a bit by the
36 * addition of remove_mapping(). If success is returned, the caller may
37 * attempt to reuse this page for another destination.
38 */
Jens Axboe76ad4d12006-05-03 10:41:33 +020039static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
Jens Axboe5abc97a2006-03-30 15:16:46 +020040 struct pipe_buffer *buf)
41{
42 struct page *page = buf->page;
Jens Axboe9e94cd42006-06-20 15:01:12 +020043 struct address_space *mapping;
Jens Axboe5abc97a2006-03-30 15:16:46 +020044
Jens Axboe9e0267c2006-04-19 15:57:31 +020045 lock_page(page);
46
Jens Axboe9e94cd42006-06-20 15:01:12 +020047 mapping = page_mapping(page);
48 if (mapping) {
49 WARN_ON(!PageUptodate(page));
Jens Axboe5abc97a2006-03-30 15:16:46 +020050
Jens Axboe9e94cd42006-06-20 15:01:12 +020051 /*
52 * At least for ext2 with nobh option, we need to wait on
53 * writeback completing on this page, since we'll remove it
54 * from the pagecache. Otherwise truncate wont wait on the
55 * page, allowing the disk blocks to be reused by someone else
56 * before we actually wrote our data to them. fs corruption
57 * ensues.
58 */
59 wait_on_page_writeback(page);
Jens Axboead8d6f02006-04-02 23:10:32 +020060
Jens Axboeca39d652008-05-20 21:27:41 +020061 if (PagePrivate(page) && !try_to_release_page(page, GFP_KERNEL))
62 goto out_unlock;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020063
Jens Axboe9e94cd42006-06-20 15:01:12 +020064 /*
65 * If we succeeded in removing the mapping, set LRU flag
66 * and return good.
67 */
68 if (remove_mapping(mapping, page)) {
69 buf->flags |= PIPE_BUF_FLAG_LRU;
70 return 0;
71 }
Jens Axboe9e0267c2006-04-19 15:57:31 +020072 }
Jens Axboe5abc97a2006-03-30 15:16:46 +020073
Jens Axboe9e94cd42006-06-20 15:01:12 +020074 /*
75 * Raced with truncate or failed to remove page from current
76 * address space, unlock and return failure.
77 */
Jens Axboeca39d652008-05-20 21:27:41 +020078out_unlock:
Jens Axboe9e94cd42006-06-20 15:01:12 +020079 unlock_page(page);
80 return 1;
Jens Axboe5abc97a2006-03-30 15:16:46 +020081}
82
Jens Axboe76ad4d12006-05-03 10:41:33 +020083static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +020084 struct pipe_buffer *buf)
85{
86 page_cache_release(buf->page);
Jens Axboe14328732006-05-03 10:35:26 +020087 buf->flags &= ~PIPE_BUF_FLAG_LRU;
Jens Axboe5274f052006-03-30 15:15:30 +020088}
89
Jens Axboe08457182007-06-12 20:51:32 +020090/*
91 * Check whether the contents of buf is OK to access. Since the content
92 * is a page cache page, IO may be in flight.
93 */
Jens Axboecac36bb2007-06-14 13:10:48 +020094static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
95 struct pipe_buffer *buf)
Jens Axboe5274f052006-03-30 15:15:30 +020096{
97 struct page *page = buf->page;
Jens Axboe49d0b212006-04-10 09:04:41 +020098 int err;
Jens Axboe5274f052006-03-30 15:15:30 +020099
100 if (!PageUptodate(page)) {
Jens Axboe49d0b212006-04-10 09:04:41 +0200101 lock_page(page);
102
103 /*
104 * Page got truncated/unhashed. This will cause a 0-byte
Ingo Molnar73d62d82006-04-11 13:57:21 +0200105 * splice, if this is the first page.
Jens Axboe49d0b212006-04-10 09:04:41 +0200106 */
107 if (!page->mapping) {
108 err = -ENODATA;
109 goto error;
110 }
111
112 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200113 * Uh oh, read-error from disk.
Jens Axboe49d0b212006-04-10 09:04:41 +0200114 */
115 if (!PageUptodate(page)) {
116 err = -EIO;
117 goto error;
118 }
119
120 /*
Jens Axboef84d7512006-05-01 19:59:03 +0200121 * Page is ok afterall, we are done.
Jens Axboe49d0b212006-04-10 09:04:41 +0200122 */
Jens Axboe5274f052006-03-30 15:15:30 +0200123 unlock_page(page);
Jens Axboe5274f052006-03-30 15:15:30 +0200124 }
125
Jens Axboef84d7512006-05-01 19:59:03 +0200126 return 0;
Jens Axboe49d0b212006-04-10 09:04:41 +0200127error:
128 unlock_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200129 return err;
Jens Axboe70524492006-04-11 15:51:17 +0200130}
131
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800132static const struct pipe_buf_operations page_cache_pipe_buf_ops = {
Jens Axboe5274f052006-03-30 15:15:30 +0200133 .can_merge = 0,
Jens Axboef84d7512006-05-01 19:59:03 +0200134 .map = generic_pipe_buf_map,
135 .unmap = generic_pipe_buf_unmap,
Jens Axboecac36bb2007-06-14 13:10:48 +0200136 .confirm = page_cache_pipe_buf_confirm,
Jens Axboe5274f052006-03-30 15:15:30 +0200137 .release = page_cache_pipe_buf_release,
Jens Axboe5abc97a2006-03-30 15:16:46 +0200138 .steal = page_cache_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200139 .get = generic_pipe_buf_get,
Jens Axboe5274f052006-03-30 15:15:30 +0200140};
141
Jens Axboe912d35f2006-04-26 10:59:21 +0200142static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
143 struct pipe_buffer *buf)
144{
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200145 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
146 return 1;
147
Jens Axboe14328732006-05-03 10:35:26 +0200148 buf->flags |= PIPE_BUF_FLAG_LRU;
Jens Axboe330ab712006-05-02 15:29:57 +0200149 return generic_pipe_buf_steal(pipe, buf);
Jens Axboe912d35f2006-04-26 10:59:21 +0200150}
151
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800152static const struct pipe_buf_operations user_page_pipe_buf_ops = {
Jens Axboe912d35f2006-04-26 10:59:21 +0200153 .can_merge = 0,
Jens Axboef84d7512006-05-01 19:59:03 +0200154 .map = generic_pipe_buf_map,
155 .unmap = generic_pipe_buf_unmap,
Jens Axboecac36bb2007-06-14 13:10:48 +0200156 .confirm = generic_pipe_buf_confirm,
Jens Axboe912d35f2006-04-26 10:59:21 +0200157 .release = page_cache_pipe_buf_release,
158 .steal = user_page_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200159 .get = generic_pipe_buf_get,
Jens Axboe912d35f2006-04-26 10:59:21 +0200160};
161
Jens Axboe932cc6d2007-06-21 13:10:21 +0200162/**
163 * splice_to_pipe - fill passed data into a pipe
164 * @pipe: pipe to fill
165 * @spd: data to fill
166 *
167 * Description:
Randy Dunlap79685b82007-07-27 08:08:51 +0200168 * @spd contains a map of pages and len/offset tuples, along with
Jens Axboe932cc6d2007-06-21 13:10:21 +0200169 * the struct pipe_buf_operations associated with these pages. This
170 * function will link that data to the pipe.
171 *
Jens Axboe83f91352006-04-02 23:05:09 +0200172 */
Jens Axboed6b29d72007-06-04 09:59:47 +0200173ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
174 struct splice_pipe_desc *spd)
Jens Axboe5274f052006-03-30 15:15:30 +0200175{
Jens Axboe00de00b2007-06-15 13:14:22 +0200176 unsigned int spd_pages = spd->nr_pages;
Jens Axboe912d35f2006-04-26 10:59:21 +0200177 int ret, do_wakeup, page_nr;
Jens Axboe5274f052006-03-30 15:15:30 +0200178
179 ret = 0;
180 do_wakeup = 0;
Jens Axboe912d35f2006-04-26 10:59:21 +0200181 page_nr = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200182
Ingo Molnar3a326a22006-04-10 15:18:35 +0200183 if (pipe->inode)
184 mutex_lock(&pipe->inode->i_mutex);
Jens Axboe5274f052006-03-30 15:15:30 +0200185
Jens Axboe5274f052006-03-30 15:15:30 +0200186 for (;;) {
Ingo Molnar3a326a22006-04-10 15:18:35 +0200187 if (!pipe->readers) {
Jens Axboe5274f052006-03-30 15:15:30 +0200188 send_sig(SIGPIPE, current, 0);
189 if (!ret)
190 ret = -EPIPE;
191 break;
192 }
193
Jens Axboe6f767b02006-04-11 13:53:56 +0200194 if (pipe->nrbufs < PIPE_BUFFERS) {
195 int newbuf = (pipe->curbuf + pipe->nrbufs) & (PIPE_BUFFERS - 1);
Ingo Molnar3a326a22006-04-10 15:18:35 +0200196 struct pipe_buffer *buf = pipe->bufs + newbuf;
Jens Axboe5274f052006-03-30 15:15:30 +0200197
Jens Axboe912d35f2006-04-26 10:59:21 +0200198 buf->page = spd->pages[page_nr];
199 buf->offset = spd->partial[page_nr].offset;
200 buf->len = spd->partial[page_nr].len;
Jens Axboe497f9622007-06-11 12:00:45 +0200201 buf->private = spd->partial[page_nr].private;
Jens Axboe912d35f2006-04-26 10:59:21 +0200202 buf->ops = spd->ops;
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200203 if (spd->flags & SPLICE_F_GIFT)
204 buf->flags |= PIPE_BUF_FLAG_GIFT;
205
Jens Axboe6f767b02006-04-11 13:53:56 +0200206 pipe->nrbufs++;
Jens Axboe912d35f2006-04-26 10:59:21 +0200207 page_nr++;
208 ret += buf->len;
209
Jens Axboe6f767b02006-04-11 13:53:56 +0200210 if (pipe->inode)
211 do_wakeup = 1;
Jens Axboe5274f052006-03-30 15:15:30 +0200212
Jens Axboe912d35f2006-04-26 10:59:21 +0200213 if (!--spd->nr_pages)
Jens Axboe5274f052006-03-30 15:15:30 +0200214 break;
Jens Axboe6f767b02006-04-11 13:53:56 +0200215 if (pipe->nrbufs < PIPE_BUFFERS)
Jens Axboe5274f052006-03-30 15:15:30 +0200216 continue;
217
218 break;
219 }
220
Jens Axboe912d35f2006-04-26 10:59:21 +0200221 if (spd->flags & SPLICE_F_NONBLOCK) {
Linus Torvalds29e35092006-04-02 12:46:35 -0700222 if (!ret)
223 ret = -EAGAIN;
224 break;
225 }
226
Jens Axboe5274f052006-03-30 15:15:30 +0200227 if (signal_pending(current)) {
228 if (!ret)
229 ret = -ERESTARTSYS;
230 break;
231 }
232
233 if (do_wakeup) {
Jens Axboec0bd1f62006-04-10 09:03:32 +0200234 smp_mb();
Ingo Molnar3a326a22006-04-10 15:18:35 +0200235 if (waitqueue_active(&pipe->wait))
236 wake_up_interruptible_sync(&pipe->wait);
237 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
Jens Axboe5274f052006-03-30 15:15:30 +0200238 do_wakeup = 0;
239 }
240
Ingo Molnar3a326a22006-04-10 15:18:35 +0200241 pipe->waiting_writers++;
242 pipe_wait(pipe);
243 pipe->waiting_writers--;
Jens Axboe5274f052006-03-30 15:15:30 +0200244 }
245
Jens Axboe02676e52007-06-15 13:16:13 +0200246 if (pipe->inode) {
Ingo Molnar3a326a22006-04-10 15:18:35 +0200247 mutex_unlock(&pipe->inode->i_mutex);
Jens Axboe5274f052006-03-30 15:15:30 +0200248
Jens Axboe02676e52007-06-15 13:16:13 +0200249 if (do_wakeup) {
250 smp_mb();
251 if (waitqueue_active(&pipe->wait))
252 wake_up_interruptible(&pipe->wait);
253 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
254 }
Jens Axboe5274f052006-03-30 15:15:30 +0200255 }
256
Jens Axboe00de00b2007-06-15 13:14:22 +0200257 while (page_nr < spd_pages)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800258 spd->spd_release(spd, page_nr++);
Jens Axboe5274f052006-03-30 15:15:30 +0200259
260 return ret;
261}
262
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800263static void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
264{
265 page_cache_release(spd->pages[i]);
266}
267
Ingo Molnar3a326a22006-04-10 15:18:35 +0200268static int
Jens Axboecbb7e572006-04-11 14:57:50 +0200269__generic_file_splice_read(struct file *in, loff_t *ppos,
270 struct pipe_inode_info *pipe, size_t len,
271 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200272{
273 struct address_space *mapping = in->f_mapping;
Fengguang Wud8983912007-07-19 01:48:06 -0700274 unsigned int loff, nr_pages, req_pages;
Jens Axboe16c523d2006-04-10 09:03:58 +0200275 struct page *pages[PIPE_BUFFERS];
Jens Axboe912d35f2006-04-26 10:59:21 +0200276 struct partial_page partial[PIPE_BUFFERS];
Jens Axboe5274f052006-03-30 15:15:30 +0200277 struct page *page;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200278 pgoff_t index, end_index;
279 loff_t isize;
Jens Axboeeb207962006-04-27 11:05:22 +0200280 int error, page_nr;
Jens Axboe912d35f2006-04-26 10:59:21 +0200281 struct splice_pipe_desc spd = {
282 .pages = pages,
283 .partial = partial,
284 .flags = flags,
285 .ops = &page_cache_pipe_buf_ops,
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800286 .spd_release = spd_release_page,
Jens Axboe912d35f2006-04-26 10:59:21 +0200287 };
Jens Axboe5274f052006-03-30 15:15:30 +0200288
Jens Axboecbb7e572006-04-11 14:57:50 +0200289 index = *ppos >> PAGE_CACHE_SHIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +0200290 loff = *ppos & ~PAGE_CACHE_MASK;
Fengguang Wud8983912007-07-19 01:48:06 -0700291 req_pages = (len + loff + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
292 nr_pages = min(req_pages, (unsigned)PIPE_BUFFERS);
Jens Axboe5274f052006-03-30 15:15:30 +0200293
294 /*
Jens Axboeeb207962006-04-27 11:05:22 +0200295 * Lookup the (hopefully) full range of pages we need.
296 */
297 spd.nr_pages = find_get_pages_contig(mapping, index, nr_pages, pages);
Fengguang Wu431a4822007-07-19 01:48:05 -0700298 index += spd.nr_pages;
Jens Axboeeb207962006-04-27 11:05:22 +0200299
300 /*
301 * If find_get_pages_contig() returned fewer pages than we needed,
Fengguang Wu431a4822007-07-19 01:48:05 -0700302 * readahead/allocate the rest and fill in the holes.
Jens Axboeeb207962006-04-27 11:05:22 +0200303 */
Fengguang Wu431a4822007-07-19 01:48:05 -0700304 if (spd.nr_pages < nr_pages)
Rusty Russellcf914a72007-07-19 01:48:08 -0700305 page_cache_sync_readahead(mapping, &in->f_ra, in,
306 index, req_pages - spd.nr_pages);
Fengguang Wu431a4822007-07-19 01:48:05 -0700307
Jens Axboe932cc6d2007-06-21 13:10:21 +0200308 error = 0;
Jens Axboeeb207962006-04-27 11:05:22 +0200309 while (spd.nr_pages < nr_pages) {
310 /*
311 * Page could be there, find_get_pages_contig() breaks on
312 * the first hole.
313 */
314 page = find_get_page(mapping, index);
315 if (!page) {
Jens Axboee27dedd2006-05-01 19:59:54 +0200316 /*
Jens Axboeeb207962006-04-27 11:05:22 +0200317 * page didn't exist, allocate one.
318 */
319 page = page_cache_alloc_cold(mapping);
320 if (!page)
321 break;
322
323 error = add_to_page_cache_lru(page, mapping, index,
Hugh Dickins4cd13502008-04-03 23:35:22 +0100324 mapping_gfp_mask(mapping));
Jens Axboeeb207962006-04-27 11:05:22 +0200325 if (unlikely(error)) {
326 page_cache_release(page);
Jens Axboea0548872006-05-03 10:58:22 +0200327 if (error == -EEXIST)
328 continue;
Jens Axboeeb207962006-04-27 11:05:22 +0200329 break;
330 }
331 /*
332 * add_to_page_cache() locks the page, unlock it
333 * to avoid convoluting the logic below even more.
334 */
335 unlock_page(page);
336 }
337
338 pages[spd.nr_pages++] = page;
339 index++;
340 }
341
342 /*
343 * Now loop over the map and see if we need to start IO on any
344 * pages, fill in the partial map, etc.
345 */
346 index = *ppos >> PAGE_CACHE_SHIFT;
347 nr_pages = spd.nr_pages;
348 spd.nr_pages = 0;
349 for (page_nr = 0; page_nr < nr_pages; page_nr++) {
Jens Axboe82aa5d62006-04-20 13:05:48 +0200350 unsigned int this_len;
351
352 if (!len)
353 break;
354
355 /*
356 * this_len is the max we'll use from this page
357 */
Andrew Mortonba5f5d92006-04-25 15:33:34 +0200358 this_len = min_t(unsigned long, len, PAGE_CACHE_SIZE - loff);
Jens Axboeeb207962006-04-27 11:05:22 +0200359 page = pages[page_nr];
Jens Axboe7480a902006-04-11 13:52:47 +0200360
Fengguang Wua08a1662007-07-19 01:48:03 -0700361 if (PageReadahead(page))
Rusty Russellcf914a72007-07-19 01:48:08 -0700362 page_cache_async_readahead(mapping, &in->f_ra, in,
Fengguang Wud8983912007-07-19 01:48:06 -0700363 page, index, req_pages - page_nr);
Fengguang Wua08a1662007-07-19 01:48:03 -0700364
Jens Axboe7480a902006-04-11 13:52:47 +0200365 /*
366 * If the page isn't uptodate, we may need to start io on it
367 */
368 if (!PageUptodate(page)) {
Jens Axboec4f895c2006-04-19 15:56:12 +0200369 /*
370 * If in nonblock mode then dont block on waiting
371 * for an in-flight io page
372 */
Fengguang Wu9ae9d682007-05-08 08:44:36 +0200373 if (flags & SPLICE_F_NONBLOCK) {
Nick Piggin529ae9a2008-08-02 12:01:03 +0200374 if (!trylock_page(page)) {
Jens Axboe8191ecd2008-04-10 08:24:25 +0200375 error = -EAGAIN;
Fengguang Wu9ae9d682007-05-08 08:44:36 +0200376 break;
Jens Axboe8191ecd2008-04-10 08:24:25 +0200377 }
Fengguang Wu9ae9d682007-05-08 08:44:36 +0200378 } else
379 lock_page(page);
Jens Axboe7480a902006-04-11 13:52:47 +0200380
381 /*
Miklos Szeredi32502b82008-07-04 09:35:17 +0200382 * Page was truncated, or invalidated by the
383 * filesystem. Redo the find/create, but this time the
384 * page is kept locked, so there's no chance of another
385 * race with truncate/invalidate.
Jens Axboe7480a902006-04-11 13:52:47 +0200386 */
387 if (!page->mapping) {
388 unlock_page(page);
Miklos Szeredi32502b82008-07-04 09:35:17 +0200389 page = find_or_create_page(mapping, index,
390 mapping_gfp_mask(mapping));
391
392 if (!page) {
393 error = -ENOMEM;
394 break;
395 }
396 page_cache_release(pages[page_nr]);
397 pages[page_nr] = page;
Jens Axboe7480a902006-04-11 13:52:47 +0200398 }
399 /*
400 * page was already under io and is now done, great
401 */
402 if (PageUptodate(page)) {
403 unlock_page(page);
404 goto fill_it;
405 }
406
Jens Axboe7480a902006-04-11 13:52:47 +0200407 /*
408 * need to read in the page
409 */
410 error = mapping->a_ops->readpage(in, page);
Jens Axboe7480a902006-04-11 13:52:47 +0200411 if (unlikely(error)) {
Jens Axboeeb207962006-04-27 11:05:22 +0200412 /*
413 * We really should re-lookup the page here,
414 * but it complicates things a lot. Instead
415 * lets just do what we already stored, and
416 * we'll get it the next time we are called.
417 */
Jens Axboe7480a902006-04-11 13:52:47 +0200418 if (error == AOP_TRUNCATED_PAGE)
Jens Axboeeb207962006-04-27 11:05:22 +0200419 error = 0;
420
Jens Axboe7480a902006-04-11 13:52:47 +0200421 break;
422 }
Jens Axboe620a3242007-06-07 09:39:42 +0200423 }
424fill_it:
425 /*
426 * i_size must be checked after PageUptodate.
427 */
428 isize = i_size_read(mapping->host);
429 end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
430 if (unlikely(!isize || index > end_index))
431 break;
432
433 /*
434 * if this is the last page, see if we need to shrink
435 * the length and stop
436 */
437 if (end_index == index) {
438 unsigned int plen;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200439
440 /*
Jens Axboe620a3242007-06-07 09:39:42 +0200441 * max good bytes in this page
Jens Axboe91ad66e2006-04-19 15:55:10 +0200442 */
Jens Axboe620a3242007-06-07 09:39:42 +0200443 plen = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
444 if (plen <= loff)
Jens Axboe91ad66e2006-04-19 15:55:10 +0200445 break;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200446
447 /*
Jens Axboe620a3242007-06-07 09:39:42 +0200448 * force quit after adding this page
Jens Axboe91ad66e2006-04-19 15:55:10 +0200449 */
Jens Axboe620a3242007-06-07 09:39:42 +0200450 this_len = min(this_len, plen - loff);
451 len = this_len;
Jens Axboe7480a902006-04-11 13:52:47 +0200452 }
Jens Axboe620a3242007-06-07 09:39:42 +0200453
Jens Axboeeb207962006-04-27 11:05:22 +0200454 partial[page_nr].offset = loff;
455 partial[page_nr].len = this_len;
Jens Axboe82aa5d62006-04-20 13:05:48 +0200456 len -= this_len;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200457 loff = 0;
Jens Axboeeb207962006-04-27 11:05:22 +0200458 spd.nr_pages++;
459 index++;
Jens Axboe5274f052006-03-30 15:15:30 +0200460 }
461
Jens Axboeeb207962006-04-27 11:05:22 +0200462 /*
Hugh Dickins475ecad2007-06-07 09:36:00 +0200463 * Release any pages at the end, if we quit early. 'page_nr' is how far
Jens Axboeeb207962006-04-27 11:05:22 +0200464 * we got, 'nr_pages' is how many pages are in the map.
465 */
466 while (page_nr < nr_pages)
467 page_cache_release(pages[page_nr++]);
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700468 in->f_ra.prev_pos = (loff_t)index << PAGE_CACHE_SHIFT;
Jens Axboeeb207962006-04-27 11:05:22 +0200469
Jens Axboe912d35f2006-04-26 10:59:21 +0200470 if (spd.nr_pages)
Jens Axboe00522fb2006-04-26 14:39:29 +0200471 return splice_to_pipe(pipe, &spd);
Jens Axboe5274f052006-03-30 15:15:30 +0200472
Jens Axboe7480a902006-04-11 13:52:47 +0200473 return error;
Jens Axboe5274f052006-03-30 15:15:30 +0200474}
475
Jens Axboe83f91352006-04-02 23:05:09 +0200476/**
477 * generic_file_splice_read - splice data from file to a pipe
478 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200479 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200480 * @pipe: pipe to splice to
481 * @len: number of bytes to splice
482 * @flags: splice modifier flags
483 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200484 * Description:
485 * Will read pages from given file and fill them into a pipe. Can be
486 * used as long as the address_space operations for the source implements
487 * a readpage() hook.
488 *
Jens Axboe83f91352006-04-02 23:05:09 +0200489 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200490ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
491 struct pipe_inode_info *pipe, size_t len,
492 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200493{
Jens Axboed366d3982007-06-01 14:54:11 +0200494 loff_t isize, left;
Jens Axboe8191ecd2008-04-10 08:24:25 +0200495 int ret;
Jens Axboed366d3982007-06-01 14:54:11 +0200496
497 isize = i_size_read(in->f_mapping->host);
498 if (unlikely(*ppos >= isize))
499 return 0;
500
501 left = isize - *ppos;
502 if (unlikely(left < len))
503 len = left;
Jens Axboe5274f052006-03-30 15:15:30 +0200504
Jens Axboe8191ecd2008-04-10 08:24:25 +0200505 ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
506 if (ret > 0)
Jens Axboecbb7e572006-04-11 14:57:50 +0200507 *ppos += ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200508
509 return ret;
510}
511
Jens Axboe059a8f32006-04-02 23:06:05 +0200512EXPORT_SYMBOL(generic_file_splice_read);
513
Jens Axboe5274f052006-03-30 15:15:30 +0200514/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200515 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200516 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200517 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200518static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200519 struct pipe_buffer *buf, struct splice_desc *sd)
520{
Jens Axboe6a14b902007-06-14 13:08:55 +0200521 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200522 loff_t pos = sd->pos;
Jens Axboef84d7512006-05-01 19:59:03 +0200523 int ret, more;
Jens Axboe5274f052006-03-30 15:15:30 +0200524
Jens Axboecac36bb2007-06-14 13:10:48 +0200525 ret = buf->ops->confirm(pipe, buf);
Jens Axboef84d7512006-05-01 19:59:03 +0200526 if (!ret) {
527 more = (sd->flags & SPLICE_F_MORE) || sd->len < sd->total_len;
Jens Axboe5274f052006-03-30 15:15:30 +0200528
Jens Axboef84d7512006-05-01 19:59:03 +0200529 ret = file->f_op->sendpage(file, buf->page, buf->offset,
530 sd->len, &pos, more);
531 }
Jens Axboe5274f052006-03-30 15:15:30 +0200532
Jens Axboe016b6612006-04-25 15:42:00 +0200533 return ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200534}
535
536/*
537 * This is a little more tricky than the file -> pipe splicing. There are
538 * basically three cases:
539 *
540 * - Destination page already exists in the address space and there
541 * are users of it. For that case we have no other option that
542 * copying the data. Tough luck.
543 * - Destination page already exists in the address space, but there
544 * are no users of it. Make sure it's uptodate, then drop it. Fall
545 * through to last case.
546 * - Destination page does not exist, we can add the pipe page to
547 * the page cache and avoid the copy.
548 *
Jens Axboe83f91352006-04-02 23:05:09 +0200549 * If asked to move pages to the output file (SPLICE_F_MOVE is set in
550 * sd->flags), we attempt to migrate pages from the pipe to the output
551 * file address space page cache. This is possible if no one else has
552 * the pipe page referenced outside of the pipe and page cache. If
553 * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create
554 * a new page in the output file page cache and fill/dirty that.
Jens Axboe5274f052006-03-30 15:15:30 +0200555 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200556static int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
Jens Axboe5274f052006-03-30 15:15:30 +0200557 struct splice_desc *sd)
558{
Jens Axboe6a14b902007-06-14 13:08:55 +0200559 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200560 struct address_space *mapping = file->f_mapping;
Jens Axboe016b6612006-04-25 15:42:00 +0200561 unsigned int offset, this_len;
Jens Axboe5274f052006-03-30 15:15:30 +0200562 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -0700563 void *fsdata;
Jens Axboe3e7ee3e2006-04-02 23:11:04 +0200564 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200565
566 /*
Jens Axboe49d0b212006-04-10 09:04:41 +0200567 * make sure the data in this buffer is uptodate
Jens Axboe5274f052006-03-30 15:15:30 +0200568 */
Jens Axboecac36bb2007-06-14 13:10:48 +0200569 ret = buf->ops->confirm(pipe, buf);
Jens Axboef84d7512006-05-01 19:59:03 +0200570 if (unlikely(ret))
571 return ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200572
Jens Axboe5274f052006-03-30 15:15:30 +0200573 offset = sd->pos & ~PAGE_CACHE_MASK;
574
Jens Axboe016b6612006-04-25 15:42:00 +0200575 this_len = sd->len;
576 if (this_len + offset > PAGE_CACHE_SIZE)
577 this_len = PAGE_CACHE_SIZE - offset;
578
Nick Pigginafddba42007-10-16 01:25:01 -0700579 ret = pagecache_write_begin(file, mapping, sd->pos, this_len,
580 AOP_FLAG_UNINTERRUPTIBLE, &page, &fsdata);
581 if (unlikely(ret))
582 goto out;
Jens Axboe5274f052006-03-30 15:15:30 +0200583
Jens Axboe0568b402006-05-01 19:50:48 +0200584 if (buf->page != page) {
Jens Axboef84d7512006-05-01 19:59:03 +0200585 /*
586 * Careful, ->map() uses KM_USER0!
587 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200588 char *src = buf->ops->map(pipe, buf, 1);
Jens Axboef84d7512006-05-01 19:59:03 +0200589 char *dst = kmap_atomic(page, KM_USER1);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200590
Jens Axboe016b6612006-04-25 15:42:00 +0200591 memcpy(dst + offset, src + buf->offset, this_len);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200592 flush_dcache_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200593 kunmap_atomic(dst, KM_USER1);
Jens Axboe76ad4d12006-05-03 10:41:33 +0200594 buf->ops->unmap(pipe, buf, src);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200595 }
Nick Pigginafddba42007-10-16 01:25:01 -0700596 ret = pagecache_write_end(file, mapping, sd->pos, this_len, this_len,
597 page, fsdata);
Jens Axboe5274f052006-03-30 15:15:30 +0200598out:
Jens Axboe5274f052006-03-30 15:15:30 +0200599 return ret;
600}
601
Jens Axboe932cc6d2007-06-21 13:10:21 +0200602/**
603 * __splice_from_pipe - splice data from a pipe to given actor
604 * @pipe: pipe to splice from
605 * @sd: information to @actor
606 * @actor: handler that splices the data
607 *
608 * Description:
609 * This function does little more than loop over the pipe and call
610 * @actor to do the actual moving of a single struct pipe_buffer to
611 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
612 * pipe_to_user.
613 *
Jens Axboe83f91352006-04-02 23:05:09 +0200614 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200615ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
616 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200617{
Jens Axboe5274f052006-03-30 15:15:30 +0200618 int ret, do_wakeup, err;
Jens Axboe5274f052006-03-30 15:15:30 +0200619
620 ret = 0;
621 do_wakeup = 0;
622
Jens Axboe5274f052006-03-30 15:15:30 +0200623 for (;;) {
Jens Axboe6f767b02006-04-11 13:53:56 +0200624 if (pipe->nrbufs) {
625 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800626 const struct pipe_buf_operations *ops = buf->ops;
Jens Axboe5274f052006-03-30 15:15:30 +0200627
Jens Axboec66ab6f2007-06-12 21:17:17 +0200628 sd->len = buf->len;
629 if (sd->len > sd->total_len)
630 sd->len = sd->total_len;
Jens Axboe5274f052006-03-30 15:15:30 +0200631
Jens Axboec66ab6f2007-06-12 21:17:17 +0200632 err = actor(pipe, buf, sd);
Jens Axboe016b6612006-04-25 15:42:00 +0200633 if (err <= 0) {
Jens Axboe5274f052006-03-30 15:15:30 +0200634 if (!ret && err != -ENODATA)
635 ret = err;
636
637 break;
638 }
639
Jens Axboe016b6612006-04-25 15:42:00 +0200640 ret += err;
641 buf->offset += err;
642 buf->len -= err;
643
Jens Axboec66ab6f2007-06-12 21:17:17 +0200644 sd->len -= err;
645 sd->pos += err;
646 sd->total_len -= err;
647 if (sd->len)
Jens Axboe016b6612006-04-25 15:42:00 +0200648 continue;
Ingo Molnar73d62d82006-04-11 13:57:21 +0200649
Jens Axboe5274f052006-03-30 15:15:30 +0200650 if (!buf->len) {
651 buf->ops = NULL;
Ingo Molnar3a326a22006-04-10 15:18:35 +0200652 ops->release(pipe, buf);
Jens Axboe6f767b02006-04-11 13:53:56 +0200653 pipe->curbuf = (pipe->curbuf + 1) & (PIPE_BUFFERS - 1);
654 pipe->nrbufs--;
655 if (pipe->inode)
656 do_wakeup = 1;
Jens Axboe5274f052006-03-30 15:15:30 +0200657 }
658
Jens Axboec66ab6f2007-06-12 21:17:17 +0200659 if (!sd->total_len)
Jens Axboe5274f052006-03-30 15:15:30 +0200660 break;
661 }
662
Jens Axboe6f767b02006-04-11 13:53:56 +0200663 if (pipe->nrbufs)
Jens Axboe5274f052006-03-30 15:15:30 +0200664 continue;
Ingo Molnar3a326a22006-04-10 15:18:35 +0200665 if (!pipe->writers)
Jens Axboe5274f052006-03-30 15:15:30 +0200666 break;
Ingo Molnar3a326a22006-04-10 15:18:35 +0200667 if (!pipe->waiting_writers) {
Jens Axboe5274f052006-03-30 15:15:30 +0200668 if (ret)
669 break;
670 }
671
Jens Axboec66ab6f2007-06-12 21:17:17 +0200672 if (sd->flags & SPLICE_F_NONBLOCK) {
Linus Torvalds29e35092006-04-02 12:46:35 -0700673 if (!ret)
674 ret = -EAGAIN;
675 break;
676 }
677
Jens Axboe5274f052006-03-30 15:15:30 +0200678 if (signal_pending(current)) {
679 if (!ret)
680 ret = -ERESTARTSYS;
681 break;
682 }
683
684 if (do_wakeup) {
Jens Axboec0bd1f62006-04-10 09:03:32 +0200685 smp_mb();
Ingo Molnar3a326a22006-04-10 15:18:35 +0200686 if (waitqueue_active(&pipe->wait))
687 wake_up_interruptible_sync(&pipe->wait);
688 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
Jens Axboe5274f052006-03-30 15:15:30 +0200689 do_wakeup = 0;
690 }
691
Ingo Molnar3a326a22006-04-10 15:18:35 +0200692 pipe_wait(pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200693 }
694
Jens Axboe5274f052006-03-30 15:15:30 +0200695 if (do_wakeup) {
Jens Axboec0bd1f62006-04-10 09:03:32 +0200696 smp_mb();
Ingo Molnar3a326a22006-04-10 15:18:35 +0200697 if (waitqueue_active(&pipe->wait))
698 wake_up_interruptible(&pipe->wait);
699 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
Jens Axboe5274f052006-03-30 15:15:30 +0200700 }
701
Jens Axboe5274f052006-03-30 15:15:30 +0200702 return ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200703}
Mark Fasheh40bee442007-03-21 13:11:02 +0100704EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200705
Jens Axboe932cc6d2007-06-21 13:10:21 +0200706/**
707 * splice_from_pipe - splice data from a pipe to a file
708 * @pipe: pipe to splice from
709 * @out: file to splice to
710 * @ppos: position in @out
711 * @len: how many bytes to splice
712 * @flags: splice modifier flags
713 * @actor: handler that splices the data
714 *
715 * Description:
716 * See __splice_from_pipe. This function locks the input and output inodes,
717 * otherwise it's identical to __splice_from_pipe().
718 *
719 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200720ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
721 loff_t *ppos, size_t len, unsigned int flags,
722 splice_actor *actor)
723{
724 ssize_t ret;
725 struct inode *inode = out->f_mapping->host;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200726 struct splice_desc sd = {
727 .total_len = len,
728 .flags = flags,
729 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200730 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200731 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200732
733 /*
734 * The actor worker might be calling ->prepare_write and
735 * ->commit_write. Most of the time, these expect i_mutex to
736 * be held. Since this may result in an ABBA deadlock with
737 * pipe->inode, we have to order lock acquiry here.
738 */
739 inode_double_lock(inode, pipe->inode);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200740 ret = __splice_from_pipe(pipe, &sd, actor);
Mark Fasheh6da61802006-10-17 18:43:07 +0200741 inode_double_unlock(inode, pipe->inode);
742
743 return ret;
744}
745
746/**
747 * generic_file_splice_write_nolock - generic_file_splice_write without mutexes
748 * @pipe: pipe info
749 * @out: file to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200750 * @ppos: position in @out
Mark Fasheh6da61802006-10-17 18:43:07 +0200751 * @len: number of bytes to splice
752 * @flags: splice modifier flags
753 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200754 * Description:
755 * Will either move or copy pages (determined by @flags options) from
756 * the given pipe inode to the given file. The caller is responsible
757 * for acquiring i_mutex on both inodes.
Mark Fasheh6da61802006-10-17 18:43:07 +0200758 *
759 */
760ssize_t
761generic_file_splice_write_nolock(struct pipe_inode_info *pipe, struct file *out,
762 loff_t *ppos, size_t len, unsigned int flags)
763{
764 struct address_space *mapping = out->f_mapping;
765 struct inode *inode = mapping->host;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200766 struct splice_desc sd = {
767 .total_len = len,
768 .flags = flags,
769 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200770 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200771 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200772 ssize_t ret;
773 int err;
774
Miklos Szeredi2f1936b2008-06-24 16:50:14 +0200775 err = file_remove_suid(out);
Jens Axboe8c34e2d2006-10-17 19:43:22 +0200776 if (unlikely(err))
777 return err;
778
Jens Axboec66ab6f2007-06-12 21:17:17 +0200779 ret = __splice_from_pipe(pipe, &sd, pipe_to_file);
Mark Fasheh6da61802006-10-17 18:43:07 +0200780 if (ret > 0) {
Jens Axboe17ee4f42007-06-15 13:10:37 +0200781 unsigned long nr_pages;
782
Mark Fasheh6da61802006-10-17 18:43:07 +0200783 *ppos += ret;
Jens Axboe17ee4f42007-06-15 13:10:37 +0200784 nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
Mark Fasheh6da61802006-10-17 18:43:07 +0200785
786 /*
787 * If file or inode is SYNC and we actually wrote some data,
788 * sync it.
789 */
790 if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(inode))) {
791 err = generic_osync_inode(inode, mapping,
792 OSYNC_METADATA|OSYNC_DATA);
793
794 if (err)
795 ret = err;
796 }
Jens Axboe17ee4f42007-06-15 13:10:37 +0200797 balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
Mark Fasheh6da61802006-10-17 18:43:07 +0200798 }
799
800 return ret;
801}
802
803EXPORT_SYMBOL(generic_file_splice_write_nolock);
804
Jens Axboe83f91352006-04-02 23:05:09 +0200805/**
806 * generic_file_splice_write - splice data from a pipe to a file
Ingo Molnar3a326a22006-04-10 15:18:35 +0200807 * @pipe: pipe info
Jens Axboe83f91352006-04-02 23:05:09 +0200808 * @out: file to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200809 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200810 * @len: number of bytes to splice
811 * @flags: splice modifier flags
812 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200813 * Description:
814 * Will either move or copy pages (determined by @flags options) from
815 * the given pipe inode to the given file.
Jens Axboe83f91352006-04-02 23:05:09 +0200816 *
817 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200818ssize_t
819generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200820 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200821{
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200822 struct address_space *mapping = out->f_mapping;
Jens Axboe8c34e2d2006-10-17 19:43:22 +0200823 struct inode *inode = mapping->host;
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +0200824 struct splice_desc sd = {
825 .total_len = len,
826 .flags = flags,
827 .pos = *ppos,
828 .u.file = out,
829 };
Ingo Molnar3a326a22006-04-10 15:18:35 +0200830 ssize_t ret;
Jens Axboe8c34e2d2006-10-17 19:43:22 +0200831
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +0200832 inode_double_lock(inode, pipe->inode);
Miklos Szeredi2f1936b2008-06-24 16:50:14 +0200833 ret = file_remove_suid(out);
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +0200834 if (likely(!ret))
835 ret = __splice_from_pipe(pipe, &sd, pipe_to_file);
836 inode_double_unlock(inode, pipe->inode);
Jens Axboea4514eb2006-04-19 15:57:05 +0200837 if (ret > 0) {
Jens Axboe17ee4f42007-06-15 13:10:37 +0200838 unsigned long nr_pages;
839
Jens Axboea4514eb2006-04-19 15:57:05 +0200840 *ppos += ret;
Jens Axboe17ee4f42007-06-15 13:10:37 +0200841 nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200842
Jens Axboea4514eb2006-04-19 15:57:05 +0200843 /*
844 * If file or inode is SYNC and we actually wrote some data,
845 * sync it.
846 */
847 if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(inode))) {
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +0200848 int err;
849
Jens Axboea4514eb2006-04-19 15:57:05 +0200850 mutex_lock(&inode->i_mutex);
851 err = generic_osync_inode(inode, mapping,
852 OSYNC_METADATA|OSYNC_DATA);
853 mutex_unlock(&inode->i_mutex);
854
855 if (err)
856 ret = err;
857 }
Jens Axboe17ee4f42007-06-15 13:10:37 +0200858 balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200859 }
860
861 return ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200862}
863
Jens Axboe059a8f32006-04-02 23:06:05 +0200864EXPORT_SYMBOL(generic_file_splice_write);
865
Jens Axboe83f91352006-04-02 23:05:09 +0200866/**
867 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200868 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200869 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200870 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200871 * @len: number of bytes to splice
872 * @flags: splice modifier flags
873 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200874 * Description:
875 * Will send @len bytes from the pipe to a network socket. No data copying
876 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200877 *
878 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200879ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200880 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200881{
Jens Axboe00522fb2006-04-26 14:39:29 +0200882 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200883}
884
Jens Axboe059a8f32006-04-02 23:06:05 +0200885EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500886
Jens Axboe83f91352006-04-02 23:05:09 +0200887/*
888 * Attempt to initiate a splice from pipe to file.
889 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200890static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200891 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200892{
Jens Axboe5274f052006-03-30 15:15:30 +0200893 int ret;
894
Jens Axboe49570e92006-04-11 13:56:09 +0200895 if (unlikely(!out->f_op || !out->f_op->splice_write))
Jens Axboe5274f052006-03-30 15:15:30 +0200896 return -EINVAL;
897
Jens Axboe49570e92006-04-11 13:56:09 +0200898 if (unlikely(!(out->f_mode & FMODE_WRITE)))
Jens Axboe5274f052006-03-30 15:15:30 +0200899 return -EBADF;
900
Jens Axboecbb7e572006-04-11 14:57:50 +0200901 ret = rw_verify_area(WRITE, out, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200902 if (unlikely(ret < 0))
903 return ret;
904
Jens Axboecbb7e572006-04-11 14:57:50 +0200905 return out->f_op->splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200906}
907
Jens Axboe83f91352006-04-02 23:05:09 +0200908/*
909 * Attempt to initiate a splice from a file to a pipe.
910 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200911static long do_splice_to(struct file *in, loff_t *ppos,
912 struct pipe_inode_info *pipe, size_t len,
913 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200914{
Jens Axboe5274f052006-03-30 15:15:30 +0200915 int ret;
916
Jens Axboe49570e92006-04-11 13:56:09 +0200917 if (unlikely(!in->f_op || !in->f_op->splice_read))
Jens Axboe5274f052006-03-30 15:15:30 +0200918 return -EINVAL;
919
Jens Axboe49570e92006-04-11 13:56:09 +0200920 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200921 return -EBADF;
922
Jens Axboecbb7e572006-04-11 14:57:50 +0200923 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200924 if (unlikely(ret < 0))
925 return ret;
926
Jens Axboecbb7e572006-04-11 14:57:50 +0200927 return in->f_op->splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200928}
929
Jens Axboe932cc6d2007-06-21 13:10:21 +0200930/**
931 * splice_direct_to_actor - splices data directly between two non-pipes
932 * @in: file to splice from
933 * @sd: actor information on where to splice to
934 * @actor: handles the data splicing
935 *
936 * Description:
937 * This is a special case helper to splice directly between two
938 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200939 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200940 * that process.
941 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200942 */
943ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
944 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200945{
946 struct pipe_inode_info *pipe;
947 long ret, bytes;
948 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200949 size_t len;
950 int i, flags;
Jens Axboeb92ce552006-04-11 13:52:07 +0200951
952 /*
953 * We require the input being a regular file, as we don't want to
954 * randomly drop data for eg socket -> socket splicing. Use the
955 * piped splicing for that!
956 */
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800957 i_mode = in->f_path.dentry->d_inode->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200958 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
959 return -EINVAL;
960
961 /*
962 * neither in nor out is a pipe, setup an internal pipe attached to
963 * 'out' and transfer the wanted data from 'in' to 'out' through that
964 */
965 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200966 if (unlikely(!pipe)) {
Jens Axboeb92ce552006-04-11 13:52:07 +0200967 pipe = alloc_pipe_info(NULL);
968 if (!pipe)
969 return -ENOMEM;
970
971 /*
972 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200973 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200974 * PIPE_READERS appropriately.
975 */
976 pipe->readers = 1;
977
978 current->splice_pipe = pipe;
979 }
980
981 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200982 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200983 */
984 ret = 0;
985 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200986 len = sd->total_len;
987 flags = sd->flags;
988
989 /*
990 * Don't block on output, we have to drain the direct pipe.
991 */
992 sd->flags &= ~SPLICE_F_NONBLOCK;
Jens Axboeb92ce552006-04-11 13:52:07 +0200993
994 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +0200995 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200996 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200997
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200998 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200999 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +02001000 goto out_release;
1001
1002 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001003 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +02001004
1005 /*
1006 * NOTE: nonblocking mode only applies to the input. We
1007 * must not do the output in nonblocking mode as then we
1008 * could get stuck data in the internal pipe:
1009 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001010 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +02001011 if (unlikely(ret <= 0)) {
1012 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001013 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001014 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001015
1016 bytes += ret;
1017 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001018 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001019
Tom Zanussia82c53a2008-05-09 13:28:36 +02001020 if (ret < read_len) {
1021 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001022 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001023 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001024 }
1025
Jens Axboe9e971982008-01-29 21:05:57 +01001026done:
Jens Axboeb92ce552006-04-11 13:52:07 +02001027 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001028 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001029 return bytes;
1030
1031out_release:
1032 /*
1033 * If we did an incomplete transfer we must release
1034 * the pipe buffers in question:
1035 */
1036 for (i = 0; i < PIPE_BUFFERS; i++) {
1037 struct pipe_buffer *buf = pipe->bufs + i;
1038
1039 if (buf->ops) {
1040 buf->ops->release(pipe, buf);
1041 buf->ops = NULL;
1042 }
1043 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001044
Jens Axboe9e971982008-01-29 21:05:57 +01001045 if (!bytes)
1046 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001047
Jens Axboe9e971982008-01-29 21:05:57 +01001048 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001049}
1050EXPORT_SYMBOL(splice_direct_to_actor);
1051
1052static int direct_splice_actor(struct pipe_inode_info *pipe,
1053 struct splice_desc *sd)
1054{
Jens Axboe6a14b902007-06-14 13:08:55 +02001055 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001056
1057 return do_splice_from(pipe, file, &sd->pos, sd->total_len, sd->flags);
1058}
1059
Jens Axboe932cc6d2007-06-21 13:10:21 +02001060/**
1061 * do_splice_direct - splices data directly between two files
1062 * @in: file to splice from
1063 * @ppos: input file offset
1064 * @out: file to splice to
1065 * @len: number of bytes to splice
1066 * @flags: splice modifier flags
1067 *
1068 * Description:
1069 * For use by do_sendfile(). splice can easily emulate sendfile, but
1070 * doing it in the application would incur an extra system call
1071 * (splice in + splice out, as compared to just sendfile()). So this helper
1072 * can splice directly through a process-private pipe.
1073 *
1074 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001075long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
1076 size_t len, unsigned int flags)
1077{
1078 struct splice_desc sd = {
1079 .len = len,
1080 .total_len = len,
1081 .flags = flags,
1082 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001083 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001084 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001085 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001086
1087 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001088 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001089 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001090
Jens Axboec66ab6f2007-06-12 21:17:17 +02001091 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001092}
1093
Jens Axboe83f91352006-04-02 23:05:09 +02001094/*
Jens Axboeddac0d32006-11-04 12:49:32 +01001095 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
1096 * location, so checking ->i_pipe is not enough to verify that this is a
1097 * pipe.
1098 */
1099static inline struct pipe_inode_info *pipe_info(struct inode *inode)
1100{
1101 if (S_ISFIFO(inode->i_mode))
1102 return inode->i_pipe;
1103
1104 return NULL;
1105}
1106
1107/*
Jens Axboe83f91352006-04-02 23:05:09 +02001108 * Determine where to splice to/from.
1109 */
Ingo Molnar529565d2006-04-10 15:18:58 +02001110static long do_splice(struct file *in, loff_t __user *off_in,
1111 struct file *out, loff_t __user *off_out,
1112 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001113{
Ingo Molnar3a326a22006-04-10 15:18:35 +02001114 struct pipe_inode_info *pipe;
Jens Axboecbb7e572006-04-11 14:57:50 +02001115 loff_t offset, *off;
Jens Axboea4514eb2006-04-19 15:57:05 +02001116 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001117
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001118 pipe = pipe_info(in->f_path.dentry->d_inode);
Ingo Molnar529565d2006-04-10 15:18:58 +02001119 if (pipe) {
1120 if (off_in)
1121 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001122 if (off_out) {
1123 if (out->f_op->llseek == no_llseek)
1124 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001125 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001126 return -EFAULT;
Jens Axboecbb7e572006-04-11 14:57:50 +02001127 off = &offset;
1128 } else
1129 off = &out->f_pos;
Ingo Molnar529565d2006-04-10 15:18:58 +02001130
Jens Axboea4514eb2006-04-19 15:57:05 +02001131 ret = do_splice_from(pipe, out, off, len, flags);
1132
1133 if (off_out && copy_to_user(off_out, off, sizeof(loff_t)))
1134 ret = -EFAULT;
1135
1136 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001137 }
Jens Axboe5274f052006-03-30 15:15:30 +02001138
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001139 pipe = pipe_info(out->f_path.dentry->d_inode);
Ingo Molnar529565d2006-04-10 15:18:58 +02001140 if (pipe) {
1141 if (off_out)
1142 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001143 if (off_in) {
1144 if (in->f_op->llseek == no_llseek)
1145 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001146 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001147 return -EFAULT;
Jens Axboecbb7e572006-04-11 14:57:50 +02001148 off = &offset;
1149 } else
1150 off = &in->f_pos;
Ingo Molnar529565d2006-04-10 15:18:58 +02001151
Jens Axboea4514eb2006-04-19 15:57:05 +02001152 ret = do_splice_to(in, off, pipe, len, flags);
1153
1154 if (off_in && copy_to_user(off_in, off, sizeof(loff_t)))
1155 ret = -EFAULT;
1156
1157 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001158 }
Jens Axboe5274f052006-03-30 15:15:30 +02001159
1160 return -EINVAL;
1161}
1162
Jens Axboe912d35f2006-04-26 10:59:21 +02001163/*
1164 * Map an iov into an array of pages and offset/length tupples. With the
1165 * partial_page structure, we can map several non-contiguous ranges into
1166 * our ones pages[] map instead of splitting that operation into pieces.
1167 * Could easily be exported as a generic helper for other users, in which
1168 * case one would probably want to add a 'max_nr_pages' parameter as well.
1169 */
1170static int get_iovec_page_array(const struct iovec __user *iov,
1171 unsigned int nr_vecs, struct page **pages,
Jens Axboe7afa6fd2006-05-01 20:02:33 +02001172 struct partial_page *partial, int aligned)
Jens Axboe912d35f2006-04-26 10:59:21 +02001173{
1174 int buffers = 0, error = 0;
1175
Jens Axboe912d35f2006-04-26 10:59:21 +02001176 while (nr_vecs) {
1177 unsigned long off, npages;
Linus Torvalds75723952007-10-01 13:17:28 -07001178 struct iovec entry;
Jens Axboe912d35f2006-04-26 10:59:21 +02001179 void __user *base;
1180 size_t len;
1181 int i;
1182
Linus Torvalds75723952007-10-01 13:17:28 -07001183 error = -EFAULT;
Nick Pigginbc40d732008-07-25 19:45:26 -07001184 if (copy_from_user(&entry, iov, sizeof(entry)))
Jens Axboe912d35f2006-04-26 10:59:21 +02001185 break;
Linus Torvalds75723952007-10-01 13:17:28 -07001186
1187 base = entry.iov_base;
1188 len = entry.iov_len;
Jens Axboe912d35f2006-04-26 10:59:21 +02001189
1190 /*
1191 * Sanity check this iovec. 0 read succeeds.
1192 */
Linus Torvalds75723952007-10-01 13:17:28 -07001193 error = 0;
Jens Axboe912d35f2006-04-26 10:59:21 +02001194 if (unlikely(!len))
1195 break;
1196 error = -EFAULT;
Bastian Blank712a30e2008-02-10 16:47:57 +02001197 if (!access_ok(VERIFY_READ, base, len))
Jens Axboe912d35f2006-04-26 10:59:21 +02001198 break;
1199
1200 /*
1201 * Get this base offset and number of pages, then map
1202 * in the user pages.
1203 */
1204 off = (unsigned long) base & ~PAGE_MASK;
Jens Axboe7afa6fd2006-05-01 20:02:33 +02001205
1206 /*
1207 * If asked for alignment, the offset must be zero and the
1208 * length a multiple of the PAGE_SIZE.
1209 */
1210 error = -EINVAL;
1211 if (aligned && (off || len & ~PAGE_MASK))
1212 break;
1213
Jens Axboe912d35f2006-04-26 10:59:21 +02001214 npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1215 if (npages > PIPE_BUFFERS - buffers)
1216 npages = PIPE_BUFFERS - buffers;
1217
Nick Pigginbc40d732008-07-25 19:45:26 -07001218 error = get_user_pages_fast((unsigned long)base, npages,
1219 0, &pages[buffers]);
Jens Axboe912d35f2006-04-26 10:59:21 +02001220
1221 if (unlikely(error <= 0))
1222 break;
1223
1224 /*
1225 * Fill this contiguous range into the partial page map.
1226 */
1227 for (i = 0; i < error; i++) {
Jens Axboe75914892006-05-02 12:57:18 +02001228 const int plen = min_t(size_t, len, PAGE_SIZE - off);
Jens Axboe912d35f2006-04-26 10:59:21 +02001229
1230 partial[buffers].offset = off;
1231 partial[buffers].len = plen;
1232
1233 off = 0;
1234 len -= plen;
1235 buffers++;
1236 }
1237
1238 /*
1239 * We didn't complete this iov, stop here since it probably
1240 * means we have to move some of this into a pipe to
1241 * be able to continue.
1242 */
1243 if (len)
1244 break;
1245
1246 /*
1247 * Don't continue if we mapped fewer pages than we asked for,
1248 * or if we mapped the max number of pages that we have
1249 * room for.
1250 */
1251 if (error < npages || buffers == PIPE_BUFFERS)
1252 break;
1253
1254 nr_vecs--;
1255 iov++;
1256 }
1257
Jens Axboe912d35f2006-04-26 10:59:21 +02001258 if (buffers)
1259 return buffers;
1260
1261 return error;
1262}
1263
Jens Axboe6a14b902007-06-14 13:08:55 +02001264static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1265 struct splice_desc *sd)
1266{
1267 char *src;
1268 int ret;
1269
Jens Axboecac36bb2007-06-14 13:10:48 +02001270 ret = buf->ops->confirm(pipe, buf);
Jens Axboe6a14b902007-06-14 13:08:55 +02001271 if (unlikely(ret))
1272 return ret;
1273
1274 /*
1275 * See if we can use the atomic maps, by prefaulting in the
1276 * pages and doing an atomic copy
1277 */
1278 if (!fault_in_pages_writeable(sd->u.userptr, sd->len)) {
1279 src = buf->ops->map(pipe, buf, 1);
1280 ret = __copy_to_user_inatomic(sd->u.userptr, src + buf->offset,
1281 sd->len);
1282 buf->ops->unmap(pipe, buf, src);
1283 if (!ret) {
1284 ret = sd->len;
1285 goto out;
1286 }
1287 }
1288
1289 /*
1290 * No dice, use slow non-atomic map and copy
1291 */
1292 src = buf->ops->map(pipe, buf, 0);
1293
1294 ret = sd->len;
1295 if (copy_to_user(sd->u.userptr, src + buf->offset, sd->len))
1296 ret = -EFAULT;
1297
Jens Axboe6866bef2007-10-16 10:01:29 +02001298 buf->ops->unmap(pipe, buf, src);
Jens Axboe6a14b902007-06-14 13:08:55 +02001299out:
1300 if (ret > 0)
1301 sd->u.userptr += ret;
Jens Axboe6a14b902007-06-14 13:08:55 +02001302 return ret;
1303}
1304
1305/*
1306 * For lack of a better implementation, implement vmsplice() to userspace
1307 * as a simple copy of the pipes pages to the user iov.
1308 */
1309static long vmsplice_to_user(struct file *file, const struct iovec __user *iov,
1310 unsigned long nr_segs, unsigned int flags)
1311{
1312 struct pipe_inode_info *pipe;
1313 struct splice_desc sd;
1314 ssize_t size;
1315 int error;
1316 long ret;
1317
1318 pipe = pipe_info(file->f_path.dentry->d_inode);
1319 if (!pipe)
1320 return -EBADF;
1321
1322 if (pipe->inode)
1323 mutex_lock(&pipe->inode->i_mutex);
1324
1325 error = ret = 0;
1326 while (nr_segs) {
1327 void __user *base;
1328 size_t len;
1329
1330 /*
1331 * Get user address base and length for this iovec.
1332 */
1333 error = get_user(base, &iov->iov_base);
1334 if (unlikely(error))
1335 break;
1336 error = get_user(len, &iov->iov_len);
1337 if (unlikely(error))
1338 break;
1339
1340 /*
1341 * Sanity check this iovec. 0 read succeeds.
1342 */
1343 if (unlikely(!len))
1344 break;
1345 if (unlikely(!base)) {
1346 error = -EFAULT;
1347 break;
1348 }
1349
Jens Axboe88119302008-02-08 08:49:14 -08001350 if (unlikely(!access_ok(VERIFY_WRITE, base, len))) {
1351 error = -EFAULT;
1352 break;
1353 }
1354
Jens Axboe6a14b902007-06-14 13:08:55 +02001355 sd.len = 0;
1356 sd.total_len = len;
1357 sd.flags = flags;
1358 sd.u.userptr = base;
1359 sd.pos = 0;
1360
1361 size = __splice_from_pipe(pipe, &sd, pipe_to_user);
1362 if (size < 0) {
1363 if (!ret)
1364 ret = size;
1365
1366 break;
1367 }
1368
1369 ret += size;
1370
1371 if (size < len)
1372 break;
1373
1374 nr_segs--;
1375 iov++;
1376 }
1377
1378 if (pipe->inode)
1379 mutex_unlock(&pipe->inode->i_mutex);
1380
1381 if (!ret)
1382 ret = error;
1383
1384 return ret;
1385}
1386
Jens Axboe912d35f2006-04-26 10:59:21 +02001387/*
1388 * vmsplice splices a user address range into a pipe. It can be thought of
1389 * as splice-from-memory, where the regular splice is splice-from-file (or
1390 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001391 */
Jens Axboe6a14b902007-06-14 13:08:55 +02001392static long vmsplice_to_pipe(struct file *file, const struct iovec __user *iov,
1393 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001394{
Jens Axboeddac0d32006-11-04 12:49:32 +01001395 struct pipe_inode_info *pipe;
Jens Axboe912d35f2006-04-26 10:59:21 +02001396 struct page *pages[PIPE_BUFFERS];
1397 struct partial_page partial[PIPE_BUFFERS];
1398 struct splice_pipe_desc spd = {
1399 .pages = pages,
1400 .partial = partial,
1401 .flags = flags,
1402 .ops = &user_page_pipe_buf_ops,
Jens Axboebbdfc2f2007-11-06 23:29:47 -08001403 .spd_release = spd_release_page,
Jens Axboe912d35f2006-04-26 10:59:21 +02001404 };
1405
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001406 pipe = pipe_info(file->f_path.dentry->d_inode);
Jens Axboeddac0d32006-11-04 12:49:32 +01001407 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001408 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001409
Jens Axboe7afa6fd2006-05-01 20:02:33 +02001410 spd.nr_pages = get_iovec_page_array(iov, nr_segs, pages, partial,
1411 flags & SPLICE_F_GIFT);
Jens Axboe912d35f2006-04-26 10:59:21 +02001412 if (spd.nr_pages <= 0)
1413 return spd.nr_pages;
1414
Jens Axboe00522fb2006-04-26 14:39:29 +02001415 return splice_to_pipe(pipe, &spd);
Jens Axboe912d35f2006-04-26 10:59:21 +02001416}
1417
Jens Axboe6a14b902007-06-14 13:08:55 +02001418/*
1419 * Note that vmsplice only really supports true splicing _from_ user memory
1420 * to a pipe, not the other way around. Splicing from user memory is a simple
1421 * operation that can be supported without any funky alignment restrictions
1422 * or nasty vm tricks. We simply map in the user memory and fill them into
1423 * a pipe. The reverse isn't quite as easy, though. There are two possible
1424 * solutions for that:
1425 *
1426 * - memcpy() the data internally, at which point we might as well just
1427 * do a regular read() on the buffer anyway.
1428 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1429 * has restriction limitations on both ends of the pipe).
1430 *
1431 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1432 *
1433 */
Jens Axboe912d35f2006-04-26 10:59:21 +02001434asmlinkage long sys_vmsplice(int fd, const struct iovec __user *iov,
1435 unsigned long nr_segs, unsigned int flags)
1436{
1437 struct file *file;
1438 long error;
1439 int fput;
1440
Jens Axboe6a14b902007-06-14 13:08:55 +02001441 if (unlikely(nr_segs > UIO_MAXIOV))
1442 return -EINVAL;
1443 else if (unlikely(!nr_segs))
1444 return 0;
1445
Jens Axboe912d35f2006-04-26 10:59:21 +02001446 error = -EBADF;
1447 file = fget_light(fd, &fput);
1448 if (file) {
1449 if (file->f_mode & FMODE_WRITE)
Jens Axboe6a14b902007-06-14 13:08:55 +02001450 error = vmsplice_to_pipe(file, iov, nr_segs, flags);
1451 else if (file->f_mode & FMODE_READ)
1452 error = vmsplice_to_user(file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001453
1454 fput_light(file, fput);
1455 }
1456
1457 return error;
1458}
1459
Ingo Molnar529565d2006-04-10 15:18:58 +02001460asmlinkage long sys_splice(int fd_in, loff_t __user *off_in,
1461 int fd_out, loff_t __user *off_out,
1462 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001463{
1464 long error;
1465 struct file *in, *out;
1466 int fput_in, fput_out;
1467
1468 if (unlikely(!len))
1469 return 0;
1470
1471 error = -EBADF;
Ingo Molnar529565d2006-04-10 15:18:58 +02001472 in = fget_light(fd_in, &fput_in);
Jens Axboe5274f052006-03-30 15:15:30 +02001473 if (in) {
1474 if (in->f_mode & FMODE_READ) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001475 out = fget_light(fd_out, &fput_out);
Jens Axboe5274f052006-03-30 15:15:30 +02001476 if (out) {
1477 if (out->f_mode & FMODE_WRITE)
Ingo Molnar529565d2006-04-10 15:18:58 +02001478 error = do_splice(in, off_in,
1479 out, off_out,
1480 len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +02001481 fput_light(out, fput_out);
1482 }
1483 }
1484
1485 fput_light(in, fput_in);
1486 }
1487
1488 return error;
1489}
Jens Axboe70524492006-04-11 15:51:17 +02001490
1491/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001492 * Make sure there's data to read. Wait for input if we can, otherwise
1493 * return an appropriate error.
1494 */
1495static int link_ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1496{
1497 int ret;
1498
1499 /*
1500 * Check ->nrbufs without the inode lock first. This function
1501 * is speculative anyways, so missing one is ok.
1502 */
1503 if (pipe->nrbufs)
1504 return 0;
1505
1506 ret = 0;
1507 mutex_lock(&pipe->inode->i_mutex);
1508
1509 while (!pipe->nrbufs) {
1510 if (signal_pending(current)) {
1511 ret = -ERESTARTSYS;
1512 break;
1513 }
1514 if (!pipe->writers)
1515 break;
1516 if (!pipe->waiting_writers) {
1517 if (flags & SPLICE_F_NONBLOCK) {
1518 ret = -EAGAIN;
1519 break;
1520 }
1521 }
1522 pipe_wait(pipe);
1523 }
1524
1525 mutex_unlock(&pipe->inode->i_mutex);
1526 return ret;
1527}
1528
1529/*
1530 * Make sure there's writeable room. Wait for room if we can, otherwise
1531 * return an appropriate error.
1532 */
1533static int link_opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1534{
1535 int ret;
1536
1537 /*
1538 * Check ->nrbufs without the inode lock first. This function
1539 * is speculative anyways, so missing one is ok.
1540 */
1541 if (pipe->nrbufs < PIPE_BUFFERS)
1542 return 0;
1543
1544 ret = 0;
1545 mutex_lock(&pipe->inode->i_mutex);
1546
1547 while (pipe->nrbufs >= PIPE_BUFFERS) {
1548 if (!pipe->readers) {
1549 send_sig(SIGPIPE, current, 0);
1550 ret = -EPIPE;
1551 break;
1552 }
1553 if (flags & SPLICE_F_NONBLOCK) {
1554 ret = -EAGAIN;
1555 break;
1556 }
1557 if (signal_pending(current)) {
1558 ret = -ERESTARTSYS;
1559 break;
1560 }
1561 pipe->waiting_writers++;
1562 pipe_wait(pipe);
1563 pipe->waiting_writers--;
1564 }
1565
1566 mutex_unlock(&pipe->inode->i_mutex);
1567 return ret;
1568}
1569
1570/*
Jens Axboe70524492006-04-11 15:51:17 +02001571 * Link contents of ipipe to opipe.
1572 */
1573static int link_pipe(struct pipe_inode_info *ipipe,
1574 struct pipe_inode_info *opipe,
1575 size_t len, unsigned int flags)
1576{
1577 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001578 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001579
1580 /*
1581 * Potential ABBA deadlock, work around it by ordering lock
1582 * grabbing by inode address. Otherwise two different processes
1583 * could deadlock (one doing tee from A -> B, the other from B -> A).
1584 */
Mark Fasheh62752ee2006-10-17 10:31:38 +02001585 inode_double_lock(ipipe->inode, opipe->inode);
Jens Axboe70524492006-04-11 15:51:17 +02001586
Jens Axboeaadd06e2006-07-10 11:00:01 +02001587 do {
Jens Axboe70524492006-04-11 15:51:17 +02001588 if (!opipe->readers) {
1589 send_sig(SIGPIPE, current, 0);
1590 if (!ret)
1591 ret = -EPIPE;
1592 break;
1593 }
Jens Axboe70524492006-04-11 15:51:17 +02001594
1595 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001596 * If we have iterated all input buffers or ran out of
1597 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001598 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001599 if (i >= ipipe->nrbufs || opipe->nrbufs >= PIPE_BUFFERS)
Jens Axboe70524492006-04-11 15:51:17 +02001600 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001601
1602 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (PIPE_BUFFERS - 1));
1603 nbuf = (opipe->curbuf + opipe->nrbufs) & (PIPE_BUFFERS - 1);
1604
Jens Axboe2a272502006-04-19 15:56:40 +02001605 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001606 * Get a reference to this pipe buffer,
1607 * so we can copy the contents over.
Jens Axboe2a272502006-04-19 15:56:40 +02001608 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001609 ibuf->ops->get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001610
Jens Axboeaadd06e2006-07-10 11:00:01 +02001611 obuf = opipe->bufs + nbuf;
1612 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001613
Jens Axboeaadd06e2006-07-10 11:00:01 +02001614 /*
1615 * Don't inherit the gift flag, we need to
1616 * prevent multiple steals of this page.
1617 */
1618 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1619
1620 if (obuf->len > len)
1621 obuf->len = len;
1622
1623 opipe->nrbufs++;
1624 ret += obuf->len;
1625 len -= obuf->len;
1626 i++;
1627 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001628
Jens Axboe02cf01a2008-02-20 10:34:51 +01001629 /*
1630 * return EAGAIN if we have the potential of some data in the
1631 * future, otherwise just return 0
1632 */
1633 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1634 ret = -EAGAIN;
1635
Mark Fasheh62752ee2006-10-17 10:31:38 +02001636 inode_double_unlock(ipipe->inode, opipe->inode);
Jens Axboe70524492006-04-11 15:51:17 +02001637
Jens Axboeaadd06e2006-07-10 11:00:01 +02001638 /*
1639 * If we put data in the output pipe, wakeup any potential readers.
1640 */
1641 if (ret > 0) {
Jens Axboe70524492006-04-11 15:51:17 +02001642 smp_mb();
1643 if (waitqueue_active(&opipe->wait))
1644 wake_up_interruptible(&opipe->wait);
1645 kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN);
1646 }
1647
1648 return ret;
1649}
1650
1651/*
1652 * This is a tee(1) implementation that works on pipes. It doesn't copy
1653 * any data, it simply references the 'in' pages on the 'out' pipe.
1654 * The 'flags' used are the SPLICE_F_* variants, currently the only
1655 * applicable one is SPLICE_F_NONBLOCK.
1656 */
1657static long do_tee(struct file *in, struct file *out, size_t len,
1658 unsigned int flags)
1659{
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001660 struct pipe_inode_info *ipipe = pipe_info(in->f_path.dentry->d_inode);
1661 struct pipe_inode_info *opipe = pipe_info(out->f_path.dentry->d_inode);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001662 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001663
1664 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001665 * Duplicate the contents of ipipe to opipe without actually
1666 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001667 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001668 if (ipipe && opipe && ipipe != opipe) {
1669 /*
1670 * Keep going, unless we encounter an error. The ipipe/opipe
1671 * ordering doesn't really matter.
1672 */
1673 ret = link_ipipe_prep(ipipe, flags);
1674 if (!ret) {
1675 ret = link_opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001676 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001677 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001678 }
1679 }
Jens Axboe70524492006-04-11 15:51:17 +02001680
Jens Axboeaadd06e2006-07-10 11:00:01 +02001681 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001682}
1683
1684asmlinkage long sys_tee(int fdin, int fdout, size_t len, unsigned int flags)
1685{
1686 struct file *in;
1687 int error, fput_in;
1688
1689 if (unlikely(!len))
1690 return 0;
1691
1692 error = -EBADF;
1693 in = fget_light(fdin, &fput_in);
1694 if (in) {
1695 if (in->f_mode & FMODE_READ) {
1696 int fput_out;
1697 struct file *out = fget_light(fdout, &fput_out);
1698
1699 if (out) {
1700 if (out->f_mode & FMODE_WRITE)
1701 error = do_tee(in, out, len, flags);
1702 fput_light(out, fput_out);
1703 }
1704 }
1705 fput_light(in, fput_in);
1706 }
1707
1708 return error;
1709}