blob: c9f1318a3b820b363526576036c4894205552921 [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>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050028#include <linux/export.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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090032#include <linux/gfp.h>
Eric Dumazet35f9c092012-04-05 03:05:35 +000033#include <linux/socket.h>
Jens Axboe5274f052006-03-30 15:15:30 +020034
Jens Axboe83f91352006-04-02 23:05:09 +020035/*
36 * Attempt to steal a page from a pipe buffer. This should perhaps go into
37 * a vm helper function, it's already simplified quite a bit by the
38 * addition of remove_mapping(). If success is returned, the caller may
39 * attempt to reuse this page for another destination.
40 */
Jens Axboe76ad4d12006-05-03 10:41:33 +020041static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
Jens Axboe5abc97a2006-03-30 15:16:46 +020042 struct pipe_buffer *buf)
43{
44 struct page *page = buf->page;
Jens Axboe9e94cd42006-06-20 15:01:12 +020045 struct address_space *mapping;
Jens Axboe5abc97a2006-03-30 15:16:46 +020046
Jens Axboe9e0267c2006-04-19 15:57:31 +020047 lock_page(page);
48
Jens Axboe9e94cd42006-06-20 15:01:12 +020049 mapping = page_mapping(page);
50 if (mapping) {
51 WARN_ON(!PageUptodate(page));
Jens Axboe5abc97a2006-03-30 15:16:46 +020052
Jens Axboe9e94cd42006-06-20 15:01:12 +020053 /*
54 * At least for ext2 with nobh option, we need to wait on
55 * writeback completing on this page, since we'll remove it
56 * from the pagecache. Otherwise truncate wont wait on the
57 * page, allowing the disk blocks to be reused by someone else
58 * before we actually wrote our data to them. fs corruption
59 * ensues.
60 */
61 wait_on_page_writeback(page);
Jens Axboead8d6f02006-04-02 23:10:32 +020062
David Howells266cf652009-04-03 16:42:36 +010063 if (page_has_private(page) &&
64 !try_to_release_page(page, GFP_KERNEL))
Jens Axboeca39d652008-05-20 21:27:41 +020065 goto out_unlock;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020066
Jens Axboe9e94cd42006-06-20 15:01:12 +020067 /*
68 * If we succeeded in removing the mapping, set LRU flag
69 * and return good.
70 */
71 if (remove_mapping(mapping, page)) {
72 buf->flags |= PIPE_BUF_FLAG_LRU;
73 return 0;
74 }
Jens Axboe9e0267c2006-04-19 15:57:31 +020075 }
Jens Axboe5abc97a2006-03-30 15:16:46 +020076
Jens Axboe9e94cd42006-06-20 15:01:12 +020077 /*
78 * Raced with truncate or failed to remove page from current
79 * address space, unlock and return failure.
80 */
Jens Axboeca39d652008-05-20 21:27:41 +020081out_unlock:
Jens Axboe9e94cd42006-06-20 15:01:12 +020082 unlock_page(page);
83 return 1;
Jens Axboe5abc97a2006-03-30 15:16:46 +020084}
85
Jens Axboe76ad4d12006-05-03 10:41:33 +020086static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +020087 struct pipe_buffer *buf)
88{
89 page_cache_release(buf->page);
Jens Axboe14328732006-05-03 10:35:26 +020090 buf->flags &= ~PIPE_BUF_FLAG_LRU;
Jens Axboe5274f052006-03-30 15:15:30 +020091}
92
Jens Axboe08457182007-06-12 20:51:32 +020093/*
94 * Check whether the contents of buf is OK to access. Since the content
95 * is a page cache page, IO may be in flight.
96 */
Jens Axboecac36bb02007-06-14 13:10:48 +020097static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
98 struct pipe_buffer *buf)
Jens Axboe5274f052006-03-30 15:15:30 +020099{
100 struct page *page = buf->page;
Jens Axboe49d0b212006-04-10 09:04:41 +0200101 int err;
Jens Axboe5274f052006-03-30 15:15:30 +0200102
103 if (!PageUptodate(page)) {
Jens Axboe49d0b212006-04-10 09:04:41 +0200104 lock_page(page);
105
106 /*
107 * Page got truncated/unhashed. This will cause a 0-byte
Ingo Molnar73d62d82006-04-11 13:57:21 +0200108 * splice, if this is the first page.
Jens Axboe49d0b212006-04-10 09:04:41 +0200109 */
110 if (!page->mapping) {
111 err = -ENODATA;
112 goto error;
113 }
114
115 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200116 * Uh oh, read-error from disk.
Jens Axboe49d0b212006-04-10 09:04:41 +0200117 */
118 if (!PageUptodate(page)) {
119 err = -EIO;
120 goto error;
121 }
122
123 /*
Jens Axboef84d7512006-05-01 19:59:03 +0200124 * Page is ok afterall, we are done.
Jens Axboe49d0b212006-04-10 09:04:41 +0200125 */
Jens Axboe5274f052006-03-30 15:15:30 +0200126 unlock_page(page);
Jens Axboe5274f052006-03-30 15:15:30 +0200127 }
128
Jens Axboef84d7512006-05-01 19:59:03 +0200129 return 0;
Jens Axboe49d0b212006-04-10 09:04:41 +0200130error:
131 unlock_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200132 return err;
Jens Axboe70524492006-04-11 15:51:17 +0200133}
134
Hugh Dickins708e3502011-07-25 17:12:32 -0700135const struct pipe_buf_operations page_cache_pipe_buf_ops = {
Jens Axboe5274f052006-03-30 15:15:30 +0200136 .can_merge = 0,
Jens Axboef84d7512006-05-01 19:59:03 +0200137 .map = generic_pipe_buf_map,
138 .unmap = generic_pipe_buf_unmap,
Jens Axboecac36bb02007-06-14 13:10:48 +0200139 .confirm = page_cache_pipe_buf_confirm,
Jens Axboe5274f052006-03-30 15:15:30 +0200140 .release = page_cache_pipe_buf_release,
Jens Axboe5abc97a2006-03-30 15:16:46 +0200141 .steal = page_cache_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200142 .get = generic_pipe_buf_get,
Jens Axboe5274f052006-03-30 15:15:30 +0200143};
144
Jens Axboe912d35f2006-04-26 10:59:21 +0200145static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
146 struct pipe_buffer *buf)
147{
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200148 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
149 return 1;
150
Jens Axboe14328732006-05-03 10:35:26 +0200151 buf->flags |= PIPE_BUF_FLAG_LRU;
Jens Axboe330ab712006-05-02 15:29:57 +0200152 return generic_pipe_buf_steal(pipe, buf);
Jens Axboe912d35f2006-04-26 10:59:21 +0200153}
154
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800155static const struct pipe_buf_operations user_page_pipe_buf_ops = {
Jens Axboe912d35f2006-04-26 10:59:21 +0200156 .can_merge = 0,
Jens Axboef84d7512006-05-01 19:59:03 +0200157 .map = generic_pipe_buf_map,
158 .unmap = generic_pipe_buf_unmap,
Jens Axboecac36bb02007-06-14 13:10:48 +0200159 .confirm = generic_pipe_buf_confirm,
Jens Axboe912d35f2006-04-26 10:59:21 +0200160 .release = page_cache_pipe_buf_release,
161 .steal = user_page_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200162 .get = generic_pipe_buf_get,
Jens Axboe912d35f2006-04-26 10:59:21 +0200163};
164
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200165static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
166{
167 smp_mb();
168 if (waitqueue_active(&pipe->wait))
169 wake_up_interruptible(&pipe->wait);
170 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
171}
172
Jens Axboe932cc6d2007-06-21 13:10:21 +0200173/**
174 * splice_to_pipe - fill passed data into a pipe
175 * @pipe: pipe to fill
176 * @spd: data to fill
177 *
178 * Description:
Randy Dunlap79685b82007-07-27 08:08:51 +0200179 * @spd contains a map of pages and len/offset tuples, along with
Jens Axboe932cc6d2007-06-21 13:10:21 +0200180 * the struct pipe_buf_operations associated with these pages. This
181 * function will link that data to the pipe.
182 *
Jens Axboe83f91352006-04-02 23:05:09 +0200183 */
Jens Axboed6b29d72007-06-04 09:59:47 +0200184ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
185 struct splice_pipe_desc *spd)
Jens Axboe5274f052006-03-30 15:15:30 +0200186{
Jens Axboe00de00b2007-06-15 13:14:22 +0200187 unsigned int spd_pages = spd->nr_pages;
Jens Axboe912d35f2006-04-26 10:59:21 +0200188 int ret, do_wakeup, page_nr;
Jens Axboe5274f052006-03-30 15:15:30 +0200189
190 ret = 0;
191 do_wakeup = 0;
Jens Axboe912d35f2006-04-26 10:59:21 +0200192 page_nr = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200193
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200194 pipe_lock(pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200195
Jens Axboe5274f052006-03-30 15:15:30 +0200196 for (;;) {
Ingo Molnar3a326a22006-04-10 15:18:35 +0200197 if (!pipe->readers) {
Jens Axboe5274f052006-03-30 15:15:30 +0200198 send_sig(SIGPIPE, current, 0);
199 if (!ret)
200 ret = -EPIPE;
201 break;
202 }
203
Jens Axboe35f3d142010-05-20 10:43:18 +0200204 if (pipe->nrbufs < pipe->buffers) {
205 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
Ingo Molnar3a326a22006-04-10 15:18:35 +0200206 struct pipe_buffer *buf = pipe->bufs + newbuf;
Jens Axboe5274f052006-03-30 15:15:30 +0200207
Jens Axboe912d35f2006-04-26 10:59:21 +0200208 buf->page = spd->pages[page_nr];
209 buf->offset = spd->partial[page_nr].offset;
210 buf->len = spd->partial[page_nr].len;
Jens Axboe497f9622007-06-11 12:00:45 +0200211 buf->private = spd->partial[page_nr].private;
Jens Axboe912d35f2006-04-26 10:59:21 +0200212 buf->ops = spd->ops;
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200213 if (spd->flags & SPLICE_F_GIFT)
214 buf->flags |= PIPE_BUF_FLAG_GIFT;
215
Jens Axboe6f767b02006-04-11 13:53:56 +0200216 pipe->nrbufs++;
Jens Axboe912d35f2006-04-26 10:59:21 +0200217 page_nr++;
218 ret += buf->len;
219
Jens Axboe6f767b02006-04-11 13:53:56 +0200220 if (pipe->inode)
221 do_wakeup = 1;
Jens Axboe5274f052006-03-30 15:15:30 +0200222
Jens Axboe912d35f2006-04-26 10:59:21 +0200223 if (!--spd->nr_pages)
Jens Axboe5274f052006-03-30 15:15:30 +0200224 break;
Jens Axboe35f3d142010-05-20 10:43:18 +0200225 if (pipe->nrbufs < pipe->buffers)
Jens Axboe5274f052006-03-30 15:15:30 +0200226 continue;
227
228 break;
229 }
230
Jens Axboe912d35f2006-04-26 10:59:21 +0200231 if (spd->flags & SPLICE_F_NONBLOCK) {
Linus Torvalds29e35092006-04-02 12:46:35 -0700232 if (!ret)
233 ret = -EAGAIN;
234 break;
235 }
236
Jens Axboe5274f052006-03-30 15:15:30 +0200237 if (signal_pending(current)) {
238 if (!ret)
239 ret = -ERESTARTSYS;
240 break;
241 }
242
243 if (do_wakeup) {
Jens Axboec0bd1f62006-04-10 09:03:32 +0200244 smp_mb();
Ingo Molnar3a326a22006-04-10 15:18:35 +0200245 if (waitqueue_active(&pipe->wait))
246 wake_up_interruptible_sync(&pipe->wait);
247 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
Jens Axboe5274f052006-03-30 15:15:30 +0200248 do_wakeup = 0;
249 }
250
Ingo Molnar3a326a22006-04-10 15:18:35 +0200251 pipe->waiting_writers++;
252 pipe_wait(pipe);
253 pipe->waiting_writers--;
Jens Axboe5274f052006-03-30 15:15:30 +0200254 }
255
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200256 pipe_unlock(pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200257
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200258 if (do_wakeup)
259 wakeup_pipe_readers(pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200260
Jens Axboe00de00b2007-06-15 13:14:22 +0200261 while (page_nr < spd_pages)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800262 spd->spd_release(spd, page_nr++);
Jens Axboe5274f052006-03-30 15:15:30 +0200263
264 return ret;
265}
266
Hugh Dickins708e3502011-07-25 17:12:32 -0700267void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800268{
269 page_cache_release(spd->pages[i]);
270}
271
Jens Axboe35f3d142010-05-20 10:43:18 +0200272/*
273 * Check if we need to grow the arrays holding pages and partial page
274 * descriptions.
275 */
276int splice_grow_spd(struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
277{
278 if (pipe->buffers <= PIPE_DEF_BUFFERS)
279 return 0;
280
281 spd->pages = kmalloc(pipe->buffers * sizeof(struct page *), GFP_KERNEL);
282 spd->partial = kmalloc(pipe->buffers * sizeof(struct partial_page), GFP_KERNEL);
283
284 if (spd->pages && spd->partial)
285 return 0;
286
287 kfree(spd->pages);
288 kfree(spd->partial);
289 return -ENOMEM;
290}
291
292void splice_shrink_spd(struct pipe_inode_info *pipe,
293 struct splice_pipe_desc *spd)
294{
295 if (pipe->buffers <= PIPE_DEF_BUFFERS)
296 return;
297
298 kfree(spd->pages);
299 kfree(spd->partial);
300}
301
Ingo Molnar3a326a22006-04-10 15:18:35 +0200302static int
Jens Axboecbb7e572006-04-11 14:57:50 +0200303__generic_file_splice_read(struct file *in, loff_t *ppos,
304 struct pipe_inode_info *pipe, size_t len,
305 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200306{
307 struct address_space *mapping = in->f_mapping;
Fengguang Wud8983912007-07-19 01:48:06 -0700308 unsigned int loff, nr_pages, req_pages;
Jens Axboe35f3d142010-05-20 10:43:18 +0200309 struct page *pages[PIPE_DEF_BUFFERS];
310 struct partial_page partial[PIPE_DEF_BUFFERS];
Jens Axboe5274f052006-03-30 15:15:30 +0200311 struct page *page;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200312 pgoff_t index, end_index;
313 loff_t isize;
Jens Axboeeb207962006-04-27 11:05:22 +0200314 int error, page_nr;
Jens Axboe912d35f2006-04-26 10:59:21 +0200315 struct splice_pipe_desc spd = {
316 .pages = pages,
317 .partial = partial,
318 .flags = flags,
319 .ops = &page_cache_pipe_buf_ops,
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800320 .spd_release = spd_release_page,
Jens Axboe912d35f2006-04-26 10:59:21 +0200321 };
Jens Axboe5274f052006-03-30 15:15:30 +0200322
Jens Axboe35f3d142010-05-20 10:43:18 +0200323 if (splice_grow_spd(pipe, &spd))
324 return -ENOMEM;
325
Jens Axboecbb7e572006-04-11 14:57:50 +0200326 index = *ppos >> PAGE_CACHE_SHIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +0200327 loff = *ppos & ~PAGE_CACHE_MASK;
Fengguang Wud8983912007-07-19 01:48:06 -0700328 req_pages = (len + loff + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
Jens Axboe35f3d142010-05-20 10:43:18 +0200329 nr_pages = min(req_pages, pipe->buffers);
Jens Axboe5274f052006-03-30 15:15:30 +0200330
331 /*
Jens Axboeeb207962006-04-27 11:05:22 +0200332 * Lookup the (hopefully) full range of pages we need.
333 */
Jens Axboe35f3d142010-05-20 10:43:18 +0200334 spd.nr_pages = find_get_pages_contig(mapping, index, nr_pages, spd.pages);
Fengguang Wu431a48202007-07-19 01:48:05 -0700335 index += spd.nr_pages;
Jens Axboeeb207962006-04-27 11:05:22 +0200336
337 /*
338 * If find_get_pages_contig() returned fewer pages than we needed,
Fengguang Wu431a48202007-07-19 01:48:05 -0700339 * readahead/allocate the rest and fill in the holes.
Jens Axboeeb207962006-04-27 11:05:22 +0200340 */
Fengguang Wu431a48202007-07-19 01:48:05 -0700341 if (spd.nr_pages < nr_pages)
Rusty Russellcf914a72007-07-19 01:48:08 -0700342 page_cache_sync_readahead(mapping, &in->f_ra, in,
343 index, req_pages - spd.nr_pages);
Fengguang Wu431a48202007-07-19 01:48:05 -0700344
Jens Axboe932cc6d2007-06-21 13:10:21 +0200345 error = 0;
Jens Axboeeb207962006-04-27 11:05:22 +0200346 while (spd.nr_pages < nr_pages) {
347 /*
348 * Page could be there, find_get_pages_contig() breaks on
349 * the first hole.
350 */
351 page = find_get_page(mapping, index);
352 if (!page) {
Jens Axboee27dedd2006-05-01 19:59:54 +0200353 /*
Jens Axboeeb207962006-04-27 11:05:22 +0200354 * page didn't exist, allocate one.
355 */
356 page = page_cache_alloc_cold(mapping);
357 if (!page)
358 break;
359
360 error = add_to_page_cache_lru(page, mapping, index,
Nick Piggin0ae0b5d2010-05-25 10:25:26 +0200361 GFP_KERNEL);
Jens Axboeeb207962006-04-27 11:05:22 +0200362 if (unlikely(error)) {
363 page_cache_release(page);
Jens Axboea0548872006-05-03 10:58:22 +0200364 if (error == -EEXIST)
365 continue;
Jens Axboeeb207962006-04-27 11:05:22 +0200366 break;
367 }
368 /*
369 * add_to_page_cache() locks the page, unlock it
370 * to avoid convoluting the logic below even more.
371 */
372 unlock_page(page);
373 }
374
Jens Axboe35f3d142010-05-20 10:43:18 +0200375 spd.pages[spd.nr_pages++] = page;
Jens Axboeeb207962006-04-27 11:05:22 +0200376 index++;
377 }
378
379 /*
380 * Now loop over the map and see if we need to start IO on any
381 * pages, fill in the partial map, etc.
382 */
383 index = *ppos >> PAGE_CACHE_SHIFT;
384 nr_pages = spd.nr_pages;
385 spd.nr_pages = 0;
386 for (page_nr = 0; page_nr < nr_pages; page_nr++) {
Jens Axboe82aa5d62006-04-20 13:05:48 +0200387 unsigned int this_len;
388
389 if (!len)
390 break;
391
392 /*
393 * this_len is the max we'll use from this page
394 */
Andrew Mortonba5f5d92006-04-25 15:33:34 +0200395 this_len = min_t(unsigned long, len, PAGE_CACHE_SIZE - loff);
Jens Axboe35f3d142010-05-20 10:43:18 +0200396 page = spd.pages[page_nr];
Jens Axboe7480a902006-04-11 13:52:47 +0200397
Fengguang Wua08a1662007-07-19 01:48:03 -0700398 if (PageReadahead(page))
Rusty Russellcf914a72007-07-19 01:48:08 -0700399 page_cache_async_readahead(mapping, &in->f_ra, in,
Fengguang Wud8983912007-07-19 01:48:06 -0700400 page, index, req_pages - page_nr);
Fengguang Wua08a1662007-07-19 01:48:03 -0700401
Jens Axboe7480a902006-04-11 13:52:47 +0200402 /*
403 * If the page isn't uptodate, we may need to start io on it
404 */
405 if (!PageUptodate(page)) {
Miklos Szeredi69650312010-08-03 12:48:50 +0200406 lock_page(page);
Jens Axboe7480a902006-04-11 13:52:47 +0200407
408 /*
Miklos Szeredi32502b82008-07-04 09:35:17 +0200409 * Page was truncated, or invalidated by the
410 * filesystem. Redo the find/create, but this time the
411 * page is kept locked, so there's no chance of another
412 * race with truncate/invalidate.
Jens Axboe7480a902006-04-11 13:52:47 +0200413 */
414 if (!page->mapping) {
415 unlock_page(page);
Miklos Szeredi32502b82008-07-04 09:35:17 +0200416 page = find_or_create_page(mapping, index,
417 mapping_gfp_mask(mapping));
418
419 if (!page) {
420 error = -ENOMEM;
421 break;
422 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200423 page_cache_release(spd.pages[page_nr]);
424 spd.pages[page_nr] = page;
Jens Axboe7480a902006-04-11 13:52:47 +0200425 }
426 /*
427 * page was already under io and is now done, great
428 */
429 if (PageUptodate(page)) {
430 unlock_page(page);
431 goto fill_it;
432 }
433
Jens Axboe7480a902006-04-11 13:52:47 +0200434 /*
435 * need to read in the page
436 */
437 error = mapping->a_ops->readpage(in, page);
Jens Axboe7480a902006-04-11 13:52:47 +0200438 if (unlikely(error)) {
Jens Axboeeb207962006-04-27 11:05:22 +0200439 /*
440 * We really should re-lookup the page here,
441 * but it complicates things a lot. Instead
442 * lets just do what we already stored, and
443 * we'll get it the next time we are called.
444 */
Jens Axboe7480a902006-04-11 13:52:47 +0200445 if (error == AOP_TRUNCATED_PAGE)
Jens Axboeeb207962006-04-27 11:05:22 +0200446 error = 0;
447
Jens Axboe7480a902006-04-11 13:52:47 +0200448 break;
449 }
Jens Axboe620a3242007-06-07 09:39:42 +0200450 }
451fill_it:
452 /*
453 * i_size must be checked after PageUptodate.
454 */
455 isize = i_size_read(mapping->host);
456 end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
457 if (unlikely(!isize || index > end_index))
458 break;
459
460 /*
461 * if this is the last page, see if we need to shrink
462 * the length and stop
463 */
464 if (end_index == index) {
465 unsigned int plen;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200466
467 /*
Jens Axboe620a3242007-06-07 09:39:42 +0200468 * max good bytes in this page
Jens Axboe91ad66e2006-04-19 15:55:10 +0200469 */
Jens Axboe620a3242007-06-07 09:39:42 +0200470 plen = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
471 if (plen <= loff)
Jens Axboe91ad66e2006-04-19 15:55:10 +0200472 break;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200473
474 /*
Jens Axboe620a3242007-06-07 09:39:42 +0200475 * force quit after adding this page
Jens Axboe91ad66e2006-04-19 15:55:10 +0200476 */
Jens Axboe620a3242007-06-07 09:39:42 +0200477 this_len = min(this_len, plen - loff);
478 len = this_len;
Jens Axboe7480a902006-04-11 13:52:47 +0200479 }
Jens Axboe620a3242007-06-07 09:39:42 +0200480
Jens Axboe35f3d142010-05-20 10:43:18 +0200481 spd.partial[page_nr].offset = loff;
482 spd.partial[page_nr].len = this_len;
Jens Axboe82aa5d62006-04-20 13:05:48 +0200483 len -= this_len;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200484 loff = 0;
Jens Axboeeb207962006-04-27 11:05:22 +0200485 spd.nr_pages++;
486 index++;
Jens Axboe5274f052006-03-30 15:15:30 +0200487 }
488
Jens Axboeeb207962006-04-27 11:05:22 +0200489 /*
Hugh Dickins475ecad2007-06-07 09:36:00 +0200490 * Release any pages at the end, if we quit early. 'page_nr' is how far
Jens Axboeeb207962006-04-27 11:05:22 +0200491 * we got, 'nr_pages' is how many pages are in the map.
492 */
493 while (page_nr < nr_pages)
Jens Axboe35f3d142010-05-20 10:43:18 +0200494 page_cache_release(spd.pages[page_nr++]);
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700495 in->f_ra.prev_pos = (loff_t)index << PAGE_CACHE_SHIFT;
Jens Axboeeb207962006-04-27 11:05:22 +0200496
Jens Axboe912d35f2006-04-26 10:59:21 +0200497 if (spd.nr_pages)
Jens Axboe35f3d142010-05-20 10:43:18 +0200498 error = splice_to_pipe(pipe, &spd);
Jens Axboe5274f052006-03-30 15:15:30 +0200499
Jens Axboe35f3d142010-05-20 10:43:18 +0200500 splice_shrink_spd(pipe, &spd);
Jens Axboe7480a902006-04-11 13:52:47 +0200501 return error;
Jens Axboe5274f052006-03-30 15:15:30 +0200502}
503
Jens Axboe83f91352006-04-02 23:05:09 +0200504/**
505 * generic_file_splice_read - splice data from file to a pipe
506 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200507 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200508 * @pipe: pipe to splice to
509 * @len: number of bytes to splice
510 * @flags: splice modifier flags
511 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200512 * Description:
513 * Will read pages from given file and fill them into a pipe. Can be
514 * used as long as the address_space operations for the source implements
515 * a readpage() hook.
516 *
Jens Axboe83f91352006-04-02 23:05:09 +0200517 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200518ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
519 struct pipe_inode_info *pipe, size_t len,
520 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200521{
Jens Axboed366d3982007-06-01 14:54:11 +0200522 loff_t isize, left;
Jens Axboe8191ecd2008-04-10 08:24:25 +0200523 int ret;
Jens Axboed366d3982007-06-01 14:54:11 +0200524
525 isize = i_size_read(in->f_mapping->host);
526 if (unlikely(*ppos >= isize))
527 return 0;
528
529 left = isize - *ppos;
530 if (unlikely(left < len))
531 len = left;
Jens Axboe5274f052006-03-30 15:15:30 +0200532
Jens Axboe8191ecd2008-04-10 08:24:25 +0200533 ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200534 if (ret > 0) {
Jens Axboecbb7e572006-04-11 14:57:50 +0200535 *ppos += ret;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200536 file_accessed(in);
537 }
Jens Axboe5274f052006-03-30 15:15:30 +0200538
539 return ret;
540}
Jens Axboe059a8f32006-04-02 23:06:05 +0200541EXPORT_SYMBOL(generic_file_splice_read);
542
Miklos Szeredi68181732009-05-07 15:37:36 +0200543static const struct pipe_buf_operations default_pipe_buf_ops = {
544 .can_merge = 0,
545 .map = generic_pipe_buf_map,
546 .unmap = generic_pipe_buf_unmap,
547 .confirm = generic_pipe_buf_confirm,
548 .release = generic_pipe_buf_release,
549 .steal = generic_pipe_buf_steal,
550 .get = generic_pipe_buf_get,
551};
552
553static ssize_t kernel_readv(struct file *file, const struct iovec *vec,
554 unsigned long vlen, loff_t offset)
555{
556 mm_segment_t old_fs;
557 loff_t pos = offset;
558 ssize_t res;
559
560 old_fs = get_fs();
561 set_fs(get_ds());
562 /* The cast to a user pointer is valid due to the set_fs() */
563 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos);
564 set_fs(old_fs);
565
566 return res;
567}
568
Miklos Szeredib2858d72009-05-19 11:37:46 +0200569static ssize_t kernel_write(struct file *file, const char *buf, size_t count,
570 loff_t pos)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200571{
572 mm_segment_t old_fs;
573 ssize_t res;
574
575 old_fs = get_fs();
576 set_fs(get_ds());
577 /* The cast to a user pointer is valid due to the set_fs() */
Miklos Szeredib2858d72009-05-19 11:37:46 +0200578 res = vfs_write(file, (const char __user *)buf, count, &pos);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200579 set_fs(old_fs);
580
581 return res;
582}
583
Miklos Szeredi68181732009-05-07 15:37:36 +0200584ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
585 struct pipe_inode_info *pipe, size_t len,
586 unsigned int flags)
587{
588 unsigned int nr_pages;
589 unsigned int nr_freed;
590 size_t offset;
Jens Axboe35f3d142010-05-20 10:43:18 +0200591 struct page *pages[PIPE_DEF_BUFFERS];
592 struct partial_page partial[PIPE_DEF_BUFFERS];
593 struct iovec *vec, __vec[PIPE_DEF_BUFFERS];
Miklos Szeredi68181732009-05-07 15:37:36 +0200594 ssize_t res;
595 size_t this_len;
596 int error;
597 int i;
598 struct splice_pipe_desc spd = {
599 .pages = pages,
600 .partial = partial,
601 .flags = flags,
602 .ops = &default_pipe_buf_ops,
603 .spd_release = spd_release_page,
604 };
605
Jens Axboe35f3d142010-05-20 10:43:18 +0200606 if (splice_grow_spd(pipe, &spd))
607 return -ENOMEM;
608
609 res = -ENOMEM;
610 vec = __vec;
611 if (pipe->buffers > PIPE_DEF_BUFFERS) {
612 vec = kmalloc(pipe->buffers * sizeof(struct iovec), GFP_KERNEL);
613 if (!vec)
614 goto shrink_ret;
615 }
616
Miklos Szeredi68181732009-05-07 15:37:36 +0200617 offset = *ppos & ~PAGE_CACHE_MASK;
618 nr_pages = (len + offset + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
619
Jens Axboe35f3d142010-05-20 10:43:18 +0200620 for (i = 0; i < nr_pages && i < pipe->buffers && len; i++) {
Miklos Szeredi68181732009-05-07 15:37:36 +0200621 struct page *page;
622
Jens Axboe4f231222009-05-13 08:35:35 +0200623 page = alloc_page(GFP_USER);
Miklos Szeredi68181732009-05-07 15:37:36 +0200624 error = -ENOMEM;
625 if (!page)
626 goto err;
627
628 this_len = min_t(size_t, len, PAGE_CACHE_SIZE - offset);
Jens Axboe4f231222009-05-13 08:35:35 +0200629 vec[i].iov_base = (void __user *) page_address(page);
Miklos Szeredi68181732009-05-07 15:37:36 +0200630 vec[i].iov_len = this_len;
Jens Axboe35f3d142010-05-20 10:43:18 +0200631 spd.pages[i] = page;
Miklos Szeredi68181732009-05-07 15:37:36 +0200632 spd.nr_pages++;
633 len -= this_len;
634 offset = 0;
635 }
636
637 res = kernel_readv(in, vec, spd.nr_pages, *ppos);
Andrew Morton77f6bf52009-05-14 09:49:44 +0200638 if (res < 0) {
639 error = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200640 goto err;
Andrew Morton77f6bf52009-05-14 09:49:44 +0200641 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200642
643 error = 0;
644 if (!res)
645 goto err;
646
647 nr_freed = 0;
648 for (i = 0; i < spd.nr_pages; i++) {
Miklos Szeredi68181732009-05-07 15:37:36 +0200649 this_len = min_t(size_t, vec[i].iov_len, res);
Jens Axboe35f3d142010-05-20 10:43:18 +0200650 spd.partial[i].offset = 0;
651 spd.partial[i].len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200652 if (!this_len) {
Jens Axboe35f3d142010-05-20 10:43:18 +0200653 __free_page(spd.pages[i]);
654 spd.pages[i] = NULL;
Miklos Szeredi68181732009-05-07 15:37:36 +0200655 nr_freed++;
656 }
657 res -= this_len;
658 }
659 spd.nr_pages -= nr_freed;
660
661 res = splice_to_pipe(pipe, &spd);
662 if (res > 0)
663 *ppos += res;
664
Jens Axboe35f3d142010-05-20 10:43:18 +0200665shrink_ret:
666 if (vec != __vec)
667 kfree(vec);
668 splice_shrink_spd(pipe, &spd);
Miklos Szeredi68181732009-05-07 15:37:36 +0200669 return res;
670
671err:
Jens Axboe4f231222009-05-13 08:35:35 +0200672 for (i = 0; i < spd.nr_pages; i++)
Jens Axboe35f3d142010-05-20 10:43:18 +0200673 __free_page(spd.pages[i]);
Jens Axboe4f231222009-05-13 08:35:35 +0200674
Jens Axboe35f3d142010-05-20 10:43:18 +0200675 res = error;
676 goto shrink_ret;
Miklos Szeredi68181732009-05-07 15:37:36 +0200677}
678EXPORT_SYMBOL(default_file_splice_read);
679
Jens Axboe5274f052006-03-30 15:15:30 +0200680/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200681 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200682 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200683 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200684static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200685 struct pipe_buffer *buf, struct splice_desc *sd)
686{
Jens Axboe6a14b902007-06-14 13:08:55 +0200687 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200688 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100689 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200690
Michał Mirosława8adbe32010-12-17 08:56:44 +0100691 if (!likely(file->f_op && file->f_op->sendpage))
692 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200693
Eric Dumazet35f9c092012-04-05 03:05:35 +0000694 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
695 if (sd->len < sd->total_len)
696 more |= MSG_SENDPAGE_NOTLAST;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100697 return file->f_op->sendpage(file, buf->page, buf->offset,
698 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200699}
700
701/*
702 * This is a little more tricky than the file -> pipe splicing. There are
703 * basically three cases:
704 *
705 * - Destination page already exists in the address space and there
706 * are users of it. For that case we have no other option that
707 * copying the data. Tough luck.
708 * - Destination page already exists in the address space, but there
709 * are no users of it. Make sure it's uptodate, then drop it. Fall
710 * through to last case.
711 * - Destination page does not exist, we can add the pipe page to
712 * the page cache and avoid the copy.
713 *
Jens Axboe83f91352006-04-02 23:05:09 +0200714 * If asked to move pages to the output file (SPLICE_F_MOVE is set in
715 * sd->flags), we attempt to migrate pages from the pipe to the output
716 * file address space page cache. This is possible if no one else has
717 * the pipe page referenced outside of the pipe and page cache. If
718 * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create
719 * a new page in the output file page cache and fill/dirty that.
Jens Axboe5274f052006-03-30 15:15:30 +0200720 */
Miklos Szeredi328eaab2009-04-14 19:48:39 +0200721int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
722 struct splice_desc *sd)
Jens Axboe5274f052006-03-30 15:15:30 +0200723{
Jens Axboe6a14b902007-06-14 13:08:55 +0200724 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200725 struct address_space *mapping = file->f_mapping;
Jens Axboe016b6612006-04-25 15:42:00 +0200726 unsigned int offset, this_len;
Jens Axboe5274f052006-03-30 15:15:30 +0200727 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -0700728 void *fsdata;
Jens Axboe3e7ee3e2006-04-02 23:11:04 +0200729 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200730
Jens Axboe5274f052006-03-30 15:15:30 +0200731 offset = sd->pos & ~PAGE_CACHE_MASK;
732
Jens Axboe016b6612006-04-25 15:42:00 +0200733 this_len = sd->len;
734 if (this_len + offset > PAGE_CACHE_SIZE)
735 this_len = PAGE_CACHE_SIZE - offset;
736
Nick Pigginafddba42007-10-16 01:25:01 -0700737 ret = pagecache_write_begin(file, mapping, sd->pos, this_len,
738 AOP_FLAG_UNINTERRUPTIBLE, &page, &fsdata);
739 if (unlikely(ret))
740 goto out;
Jens Axboe5274f052006-03-30 15:15:30 +0200741
Jens Axboe0568b402006-05-01 19:50:48 +0200742 if (buf->page != page) {
Jens Axboe76ad4d12006-05-03 10:41:33 +0200743 char *src = buf->ops->map(pipe, buf, 1);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800744 char *dst = kmap_atomic(page);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200745
Jens Axboe016b6612006-04-25 15:42:00 +0200746 memcpy(dst + offset, src + buf->offset, this_len);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200747 flush_dcache_page(page);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800748 kunmap_atomic(dst);
Jens Axboe76ad4d12006-05-03 10:41:33 +0200749 buf->ops->unmap(pipe, buf, src);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200750 }
Nick Pigginafddba42007-10-16 01:25:01 -0700751 ret = pagecache_write_end(file, mapping, sd->pos, this_len, this_len,
752 page, fsdata);
Jens Axboe5274f052006-03-30 15:15:30 +0200753out:
Jens Axboe5274f052006-03-30 15:15:30 +0200754 return ret;
755}
Miklos Szeredi328eaab2009-04-14 19:48:39 +0200756EXPORT_SYMBOL(pipe_to_file);
Jens Axboe5274f052006-03-30 15:15:30 +0200757
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200758static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
759{
760 smp_mb();
761 if (waitqueue_active(&pipe->wait))
762 wake_up_interruptible(&pipe->wait);
763 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
764}
765
766/**
767 * splice_from_pipe_feed - feed available data from a pipe to a file
768 * @pipe: pipe to splice from
769 * @sd: information to @actor
770 * @actor: handler that splices the data
771 *
772 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200773 * This function loops over the pipe and calls @actor to do the
774 * actual moving of a single struct pipe_buffer to the desired
775 * destination. It returns when there's no more buffers left in
776 * the pipe or if the requested number of bytes (@sd->total_len)
777 * have been copied. It returns a positive number (one) if the
778 * pipe needs to be filled with more data, zero if the required
779 * number of bytes have been copied and -errno on error.
780 *
781 * This, together with splice_from_pipe_{begin,end,next}, may be
782 * used to implement the functionality of __splice_from_pipe() when
783 * locking is required around copying the pipe buffers to the
784 * destination.
785 */
786int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
787 splice_actor *actor)
788{
789 int ret;
790
791 while (pipe->nrbufs) {
792 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
793 const struct pipe_buf_operations *ops = buf->ops;
794
795 sd->len = buf->len;
796 if (sd->len > sd->total_len)
797 sd->len = sd->total_len;
798
Michał Mirosława8adbe32010-12-17 08:56:44 +0100799 ret = buf->ops->confirm(pipe, buf);
800 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200801 if (ret == -ENODATA)
802 ret = 0;
803 return ret;
804 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100805
806 ret = actor(pipe, buf, sd);
807 if (ret <= 0)
808 return ret;
809
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200810 buf->offset += ret;
811 buf->len -= ret;
812
813 sd->num_spliced += ret;
814 sd->len -= ret;
815 sd->pos += ret;
816 sd->total_len -= ret;
817
818 if (!buf->len) {
819 buf->ops = NULL;
820 ops->release(pipe, buf);
Jens Axboe35f3d142010-05-20 10:43:18 +0200821 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200822 pipe->nrbufs--;
823 if (pipe->inode)
824 sd->need_wakeup = true;
825 }
826
827 if (!sd->total_len)
828 return 0;
829 }
830
831 return 1;
832}
833EXPORT_SYMBOL(splice_from_pipe_feed);
834
835/**
836 * splice_from_pipe_next - wait for some data to splice from
837 * @pipe: pipe to splice from
838 * @sd: information about the splice operation
839 *
840 * Description:
841 * This function will wait for some data and return a positive
842 * value (one) if pipe buffers are available. It will return zero
843 * or -errno if no more data needs to be spliced.
844 */
845int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
846{
847 while (!pipe->nrbufs) {
848 if (!pipe->writers)
849 return 0;
850
851 if (!pipe->waiting_writers && sd->num_spliced)
852 return 0;
853
854 if (sd->flags & SPLICE_F_NONBLOCK)
855 return -EAGAIN;
856
857 if (signal_pending(current))
858 return -ERESTARTSYS;
859
860 if (sd->need_wakeup) {
861 wakeup_pipe_writers(pipe);
862 sd->need_wakeup = false;
863 }
864
865 pipe_wait(pipe);
866 }
867
868 return 1;
869}
870EXPORT_SYMBOL(splice_from_pipe_next);
871
872/**
873 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700874 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200875 *
876 * Description:
877 * This function should be called before a loop containing
878 * splice_from_pipe_next() and splice_from_pipe_feed() to
879 * initialize the necessary fields of @sd.
880 */
881void splice_from_pipe_begin(struct splice_desc *sd)
882{
883 sd->num_spliced = 0;
884 sd->need_wakeup = false;
885}
886EXPORT_SYMBOL(splice_from_pipe_begin);
887
888/**
889 * splice_from_pipe_end - finish splicing from pipe
890 * @pipe: pipe to splice from
891 * @sd: information about the splice operation
892 *
893 * Description:
894 * This function will wake up pipe writers if necessary. It should
895 * be called after a loop containing splice_from_pipe_next() and
896 * splice_from_pipe_feed().
897 */
898void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
899{
900 if (sd->need_wakeup)
901 wakeup_pipe_writers(pipe);
902}
903EXPORT_SYMBOL(splice_from_pipe_end);
904
Jens Axboe932cc6d2007-06-21 13:10:21 +0200905/**
906 * __splice_from_pipe - splice data from a pipe to given actor
907 * @pipe: pipe to splice from
908 * @sd: information to @actor
909 * @actor: handler that splices the data
910 *
911 * Description:
912 * This function does little more than loop over the pipe and call
913 * @actor to do the actual moving of a single struct pipe_buffer to
914 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
915 * pipe_to_user.
916 *
Jens Axboe83f91352006-04-02 23:05:09 +0200917 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200918ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
919 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200920{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200921 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200922
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200923 splice_from_pipe_begin(sd);
924 do {
925 ret = splice_from_pipe_next(pipe, sd);
926 if (ret > 0)
927 ret = splice_from_pipe_feed(pipe, sd, actor);
928 } while (ret > 0);
929 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200930
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200931 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200932}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100933EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200934
Jens Axboe932cc6d2007-06-21 13:10:21 +0200935/**
936 * splice_from_pipe - splice data from a pipe to a file
937 * @pipe: pipe to splice from
938 * @out: file to splice to
939 * @ppos: position in @out
940 * @len: how many bytes to splice
941 * @flags: splice modifier flags
942 * @actor: handler that splices the data
943 *
944 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200945 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200946 * otherwise it's identical to __splice_from_pipe().
947 *
948 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200949ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
950 loff_t *ppos, size_t len, unsigned int flags,
951 splice_actor *actor)
952{
953 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200954 struct splice_desc sd = {
955 .total_len = len,
956 .flags = flags,
957 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200958 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200959 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200960
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200961 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200962 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200963 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200964
965 return ret;
966}
967
968/**
Jens Axboe83f91352006-04-02 23:05:09 +0200969 * generic_file_splice_write - splice data from a pipe to a file
Ingo Molnar3a326a22006-04-10 15:18:35 +0200970 * @pipe: pipe info
Jens Axboe83f91352006-04-02 23:05:09 +0200971 * @out: file to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200972 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200973 * @len: number of bytes to splice
974 * @flags: splice modifier flags
975 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200976 * Description:
977 * Will either move or copy pages (determined by @flags options) from
978 * the given pipe inode to the given file.
Jens Axboe83f91352006-04-02 23:05:09 +0200979 *
980 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200981ssize_t
982generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200983 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200984{
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200985 struct address_space *mapping = out->f_mapping;
Jens Axboe8c34e2d2006-10-17 19:43:22 +0200986 struct inode *inode = mapping->host;
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +0200987 struct splice_desc sd = {
988 .total_len = len,
989 .flags = flags,
990 .pos = *ppos,
991 .u.file = out,
992 };
Ingo Molnar3a326a22006-04-10 15:18:35 +0200993 ssize_t ret;
Jens Axboe8c34e2d2006-10-17 19:43:22 +0200994
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200995 pipe_lock(pipe);
Miklos Szeredieb443e52009-04-14 19:48:38 +0200996
997 splice_from_pipe_begin(&sd);
998 do {
999 ret = splice_from_pipe_next(pipe, &sd);
1000 if (ret <= 0)
1001 break;
1002
1003 mutex_lock_nested(&inode->i_mutex, I_MUTEX_CHILD);
1004 ret = file_remove_suid(out);
Miklos Szeredi723590e2009-08-15 08:43:22 +02001005 if (!ret) {
Josef Bacikc3b2da32012-03-26 09:59:21 -04001006 ret = file_update_time(out);
1007 if (!ret)
1008 ret = splice_from_pipe_feed(pipe, &sd,
1009 pipe_to_file);
Miklos Szeredi723590e2009-08-15 08:43:22 +02001010 }
Miklos Szeredieb443e52009-04-14 19:48:38 +02001011 mutex_unlock(&inode->i_mutex);
1012 } while (ret > 0);
1013 splice_from_pipe_end(pipe, &sd);
1014
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001015 pipe_unlock(pipe);
Miklos Szeredieb443e52009-04-14 19:48:38 +02001016
1017 if (sd.num_spliced)
1018 ret = sd.num_spliced;
1019
Jens Axboea4514eb2006-04-19 15:57:05 +02001020 if (ret > 0) {
Jens Axboe17ee4f42007-06-15 13:10:37 +02001021 unsigned long nr_pages;
Jan Kara148f9482009-08-17 19:52:36 +02001022 int err;
Jens Axboe17ee4f42007-06-15 13:10:37 +02001023
Jens Axboe17ee4f42007-06-15 13:10:37 +02001024 nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +02001025
Jan Kara148f9482009-08-17 19:52:36 +02001026 err = generic_write_sync(out, *ppos, ret);
1027 if (err)
1028 ret = err;
1029 else
1030 *ppos += ret;
Jens Axboe17ee4f42007-06-15 13:10:37 +02001031 balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
Jens Axboe4f6f0bd2006-04-02 23:04:46 +02001032 }
1033
1034 return ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001035}
1036
Jens Axboe059a8f32006-04-02 23:06:05 +02001037EXPORT_SYMBOL(generic_file_splice_write);
1038
Miklos Szeredib2858d72009-05-19 11:37:46 +02001039static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1040 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001041{
Miklos Szeredib2858d72009-05-19 11:37:46 +02001042 int ret;
1043 void *data;
1044
Miklos Szeredib2858d72009-05-19 11:37:46 +02001045 data = buf->ops->map(pipe, buf, 0);
1046 ret = kernel_write(sd->u.file, data + buf->offset, sd->len, sd->pos);
1047 buf->ops->unmap(pipe, buf, data);
1048
1049 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001050}
1051
1052static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
1053 struct file *out, loff_t *ppos,
1054 size_t len, unsigned int flags)
1055{
Miklos Szeredib2858d72009-05-19 11:37:46 +02001056 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001057
Miklos Szeredib2858d72009-05-19 11:37:46 +02001058 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
1059 if (ret > 0)
1060 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001061
Miklos Szeredib2858d72009-05-19 11:37:46 +02001062 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001063}
1064
Jens Axboe83f91352006-04-02 23:05:09 +02001065/**
1066 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +02001067 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +02001068 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +02001069 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +02001070 * @len: number of bytes to splice
1071 * @flags: splice modifier flags
1072 *
Jens Axboe932cc6d2007-06-21 13:10:21 +02001073 * Description:
1074 * Will send @len bytes from the pipe to a network socket. No data copying
1075 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +02001076 *
1077 */
Ingo Molnar3a326a22006-04-10 15:18:35 +02001078ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +02001079 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001080{
Jens Axboe00522fb2006-04-26 14:39:29 +02001081 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +02001082}
1083
Jens Axboe059a8f32006-04-02 23:06:05 +02001084EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -05001085
Jens Axboe83f91352006-04-02 23:05:09 +02001086/*
1087 * Attempt to initiate a splice from pipe to file.
1088 */
Ingo Molnar3a326a22006-04-10 15:18:35 +02001089static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +02001090 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001091{
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001092 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
1093 loff_t *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +02001094 int ret;
1095
Jens Axboe49570e92006-04-11 13:56:09 +02001096 if (unlikely(!(out->f_mode & FMODE_WRITE)))
Jens Axboe5274f052006-03-30 15:15:30 +02001097 return -EBADF;
1098
Linus Torvaldsefc968d2008-10-09 14:04:54 -07001099 if (unlikely(out->f_flags & O_APPEND))
1100 return -EINVAL;
1101
Jens Axboecbb7e572006-04-11 14:57:50 +02001102 ret = rw_verify_area(WRITE, out, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +02001103 if (unlikely(ret < 0))
1104 return ret;
1105
Changli Gaocc56f7d2009-11-04 09:09:52 +01001106 if (out->f_op && out->f_op->splice_write)
1107 splice_write = out->f_op->splice_write;
1108 else
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001109 splice_write = default_file_splice_write;
1110
1111 return splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +02001112}
1113
Jens Axboe83f91352006-04-02 23:05:09 +02001114/*
1115 * Attempt to initiate a splice from a file to a pipe.
1116 */
Jens Axboecbb7e572006-04-11 14:57:50 +02001117static long do_splice_to(struct file *in, loff_t *ppos,
1118 struct pipe_inode_info *pipe, size_t len,
1119 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001120{
Miklos Szeredi68181732009-05-07 15:37:36 +02001121 ssize_t (*splice_read)(struct file *, loff_t *,
1122 struct pipe_inode_info *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +02001123 int ret;
1124
Jens Axboe49570e92006-04-11 13:56:09 +02001125 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +02001126 return -EBADF;
1127
Jens Axboecbb7e572006-04-11 14:57:50 +02001128 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +02001129 if (unlikely(ret < 0))
1130 return ret;
1131
Changli Gaocc56f7d2009-11-04 09:09:52 +01001132 if (in->f_op && in->f_op->splice_read)
1133 splice_read = in->f_op->splice_read;
1134 else
Miklos Szeredi68181732009-05-07 15:37:36 +02001135 splice_read = default_file_splice_read;
1136
1137 return splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +02001138}
1139
Jens Axboe932cc6d2007-06-21 13:10:21 +02001140/**
1141 * splice_direct_to_actor - splices data directly between two non-pipes
1142 * @in: file to splice from
1143 * @sd: actor information on where to splice to
1144 * @actor: handles the data splicing
1145 *
1146 * Description:
1147 * This is a special case helper to splice directly between two
1148 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +02001149 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +02001150 * that process.
1151 *
Jens Axboec66ab6f2007-06-12 21:17:17 +02001152 */
1153ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
1154 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +02001155{
1156 struct pipe_inode_info *pipe;
1157 long ret, bytes;
1158 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001159 size_t len;
1160 int i, flags;
Jens Axboeb92ce552006-04-11 13:52:07 +02001161
1162 /*
1163 * We require the input being a regular file, as we don't want to
1164 * randomly drop data for eg socket -> socket splicing. Use the
1165 * piped splicing for that!
1166 */
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -08001167 i_mode = in->f_path.dentry->d_inode->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +02001168 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
1169 return -EINVAL;
1170
1171 /*
1172 * neither in nor out is a pipe, setup an internal pipe attached to
1173 * 'out' and transfer the wanted data from 'in' to 'out' through that
1174 */
1175 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +02001176 if (unlikely(!pipe)) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001177 pipe = alloc_pipe_info(NULL);
1178 if (!pipe)
1179 return -ENOMEM;
1180
1181 /*
1182 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +02001183 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +02001184 * PIPE_READERS appropriately.
1185 */
1186 pipe->readers = 1;
1187
1188 current->splice_pipe = pipe;
1189 }
1190
1191 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +02001192 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +02001193 */
1194 ret = 0;
1195 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001196 len = sd->total_len;
1197 flags = sd->flags;
1198
1199 /*
1200 * Don't block on output, we have to drain the direct pipe.
1201 */
1202 sd->flags &= ~SPLICE_F_NONBLOCK;
Jens Axboeb92ce552006-04-11 13:52:07 +02001203
1204 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +02001205 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001206 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001207
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001208 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +02001209 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +02001210 goto out_release;
1211
1212 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001213 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +02001214
1215 /*
1216 * NOTE: nonblocking mode only applies to the input. We
1217 * must not do the output in nonblocking mode as then we
1218 * could get stuck data in the internal pipe:
1219 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001220 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +02001221 if (unlikely(ret <= 0)) {
1222 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001223 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001224 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001225
1226 bytes += ret;
1227 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001228 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001229
Tom Zanussia82c53a2008-05-09 13:28:36 +02001230 if (ret < read_len) {
1231 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001232 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001233 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001234 }
1235
Jens Axboe9e971982008-01-29 21:05:57 +01001236done:
Jens Axboeb92ce552006-04-11 13:52:07 +02001237 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001238 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001239 return bytes;
1240
1241out_release:
1242 /*
1243 * If we did an incomplete transfer we must release
1244 * the pipe buffers in question:
1245 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001246 for (i = 0; i < pipe->buffers; i++) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001247 struct pipe_buffer *buf = pipe->bufs + i;
1248
1249 if (buf->ops) {
1250 buf->ops->release(pipe, buf);
1251 buf->ops = NULL;
1252 }
1253 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001254
Jens Axboe9e971982008-01-29 21:05:57 +01001255 if (!bytes)
1256 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001257
Jens Axboe9e971982008-01-29 21:05:57 +01001258 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001259}
1260EXPORT_SYMBOL(splice_direct_to_actor);
1261
1262static int direct_splice_actor(struct pipe_inode_info *pipe,
1263 struct splice_desc *sd)
1264{
Jens Axboe6a14b902007-06-14 13:08:55 +02001265 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001266
Changli Gao2cb4b052010-06-29 13:09:18 +02001267 return do_splice_from(pipe, file, &file->f_pos, sd->total_len,
1268 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001269}
1270
Jens Axboe932cc6d2007-06-21 13:10:21 +02001271/**
1272 * do_splice_direct - splices data directly between two files
1273 * @in: file to splice from
1274 * @ppos: input file offset
1275 * @out: file to splice to
1276 * @len: number of bytes to splice
1277 * @flags: splice modifier flags
1278 *
1279 * Description:
1280 * For use by do_sendfile(). splice can easily emulate sendfile, but
1281 * doing it in the application would incur an extra system call
1282 * (splice in + splice out, as compared to just sendfile()). So this helper
1283 * can splice directly through a process-private pipe.
1284 *
1285 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001286long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
1287 size_t len, unsigned int flags)
1288{
1289 struct splice_desc sd = {
1290 .len = len,
1291 .total_len = len,
1292 .flags = flags,
1293 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001294 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001295 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001296 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001297
1298 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001299 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001300 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001301
Jens Axboec66ab6f2007-06-12 21:17:17 +02001302 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001303}
1304
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001305static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1306 struct pipe_inode_info *opipe,
1307 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001308
1309/*
Jens Axboe83f91352006-04-02 23:05:09 +02001310 * Determine where to splice to/from.
1311 */
Ingo Molnar529565d2006-04-10 15:18:58 +02001312static long do_splice(struct file *in, loff_t __user *off_in,
1313 struct file *out, loff_t __user *off_out,
1314 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001315{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001316 struct pipe_inode_info *ipipe;
1317 struct pipe_inode_info *opipe;
Jens Axboecbb7e572006-04-11 14:57:50 +02001318 loff_t offset, *off;
Jens Axboea4514eb2006-04-19 15:57:05 +02001319 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001320
Linus Torvalds71993e62010-11-28 13:56:09 -08001321 ipipe = get_pipe_info(in);
1322 opipe = get_pipe_info(out);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001323
1324 if (ipipe && opipe) {
1325 if (off_in || off_out)
1326 return -ESPIPE;
1327
1328 if (!(in->f_mode & FMODE_READ))
1329 return -EBADF;
1330
1331 if (!(out->f_mode & FMODE_WRITE))
1332 return -EBADF;
1333
1334 /* Splicing to self would be fun, but... */
1335 if (ipipe == opipe)
1336 return -EINVAL;
1337
1338 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1339 }
1340
1341 if (ipipe) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001342 if (off_in)
1343 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001344 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001345 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001346 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001347 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001348 return -EFAULT;
Jens Axboecbb7e572006-04-11 14:57:50 +02001349 off = &offset;
1350 } else
1351 off = &out->f_pos;
Ingo Molnar529565d2006-04-10 15:18:58 +02001352
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001353 ret = do_splice_from(ipipe, out, off, len, flags);
Jens Axboea4514eb2006-04-19 15:57:05 +02001354
1355 if (off_out && copy_to_user(off_out, off, sizeof(loff_t)))
1356 ret = -EFAULT;
1357
1358 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001359 }
Jens Axboe5274f052006-03-30 15:15:30 +02001360
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001361 if (opipe) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001362 if (off_out)
1363 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001364 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001365 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001366 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001367 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001368 return -EFAULT;
Jens Axboecbb7e572006-04-11 14:57:50 +02001369 off = &offset;
1370 } else
1371 off = &in->f_pos;
Ingo Molnar529565d2006-04-10 15:18:58 +02001372
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001373 ret = do_splice_to(in, off, opipe, len, flags);
Jens Axboea4514eb2006-04-19 15:57:05 +02001374
1375 if (off_in && copy_to_user(off_in, off, sizeof(loff_t)))
1376 ret = -EFAULT;
1377
1378 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001379 }
Jens Axboe5274f052006-03-30 15:15:30 +02001380
1381 return -EINVAL;
1382}
1383
Jens Axboe912d35f2006-04-26 10:59:21 +02001384/*
1385 * Map an iov into an array of pages and offset/length tupples. With the
1386 * partial_page structure, we can map several non-contiguous ranges into
1387 * our ones pages[] map instead of splitting that operation into pieces.
1388 * Could easily be exported as a generic helper for other users, in which
1389 * case one would probably want to add a 'max_nr_pages' parameter as well.
1390 */
1391static int get_iovec_page_array(const struct iovec __user *iov,
1392 unsigned int nr_vecs, struct page **pages,
Eric Dumazetbd1a68b2012-04-04 11:08:51 +02001393 struct partial_page *partial, bool aligned,
Jens Axboe35f3d142010-05-20 10:43:18 +02001394 unsigned int pipe_buffers)
Jens Axboe912d35f2006-04-26 10:59:21 +02001395{
1396 int buffers = 0, error = 0;
1397
Jens Axboe912d35f2006-04-26 10:59:21 +02001398 while (nr_vecs) {
1399 unsigned long off, npages;
Linus Torvalds75723952007-10-01 13:17:28 -07001400 struct iovec entry;
Jens Axboe912d35f2006-04-26 10:59:21 +02001401 void __user *base;
1402 size_t len;
1403 int i;
1404
Linus Torvalds75723952007-10-01 13:17:28 -07001405 error = -EFAULT;
Nick Pigginbc40d732008-07-25 19:45:26 -07001406 if (copy_from_user(&entry, iov, sizeof(entry)))
Jens Axboe912d35f2006-04-26 10:59:21 +02001407 break;
Linus Torvalds75723952007-10-01 13:17:28 -07001408
1409 base = entry.iov_base;
1410 len = entry.iov_len;
Jens Axboe912d35f2006-04-26 10:59:21 +02001411
1412 /*
1413 * Sanity check this iovec. 0 read succeeds.
1414 */
Linus Torvalds75723952007-10-01 13:17:28 -07001415 error = 0;
Jens Axboe912d35f2006-04-26 10:59:21 +02001416 if (unlikely(!len))
1417 break;
1418 error = -EFAULT;
Bastian Blank712a30e2008-02-10 16:47:57 +02001419 if (!access_ok(VERIFY_READ, base, len))
Jens Axboe912d35f2006-04-26 10:59:21 +02001420 break;
1421
1422 /*
1423 * Get this base offset and number of pages, then map
1424 * in the user pages.
1425 */
1426 off = (unsigned long) base & ~PAGE_MASK;
Jens Axboe7afa6fd2006-05-01 20:02:33 +02001427
1428 /*
1429 * If asked for alignment, the offset must be zero and the
1430 * length a multiple of the PAGE_SIZE.
1431 */
1432 error = -EINVAL;
1433 if (aligned && (off || len & ~PAGE_MASK))
1434 break;
1435
Jens Axboe912d35f2006-04-26 10:59:21 +02001436 npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
Jens Axboe35f3d142010-05-20 10:43:18 +02001437 if (npages > pipe_buffers - buffers)
1438 npages = pipe_buffers - buffers;
Jens Axboe912d35f2006-04-26 10:59:21 +02001439
Nick Pigginbc40d732008-07-25 19:45:26 -07001440 error = get_user_pages_fast((unsigned long)base, npages,
1441 0, &pages[buffers]);
Jens Axboe912d35f2006-04-26 10:59:21 +02001442
1443 if (unlikely(error <= 0))
1444 break;
1445
1446 /*
1447 * Fill this contiguous range into the partial page map.
1448 */
1449 for (i = 0; i < error; i++) {
Jens Axboe75914892006-05-02 12:57:18 +02001450 const int plen = min_t(size_t, len, PAGE_SIZE - off);
Jens Axboe912d35f2006-04-26 10:59:21 +02001451
1452 partial[buffers].offset = off;
1453 partial[buffers].len = plen;
1454
1455 off = 0;
1456 len -= plen;
1457 buffers++;
1458 }
1459
1460 /*
1461 * We didn't complete this iov, stop here since it probably
1462 * means we have to move some of this into a pipe to
1463 * be able to continue.
1464 */
1465 if (len)
1466 break;
1467
1468 /*
1469 * Don't continue if we mapped fewer pages than we asked for,
1470 * or if we mapped the max number of pages that we have
1471 * room for.
1472 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001473 if (error < npages || buffers == pipe_buffers)
Jens Axboe912d35f2006-04-26 10:59:21 +02001474 break;
1475
1476 nr_vecs--;
1477 iov++;
1478 }
1479
Jens Axboe912d35f2006-04-26 10:59:21 +02001480 if (buffers)
1481 return buffers;
1482
1483 return error;
1484}
1485
Jens Axboe6a14b902007-06-14 13:08:55 +02001486static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1487 struct splice_desc *sd)
1488{
1489 char *src;
1490 int ret;
1491
Jens Axboe6a14b902007-06-14 13:08:55 +02001492 /*
1493 * See if we can use the atomic maps, by prefaulting in the
1494 * pages and doing an atomic copy
1495 */
1496 if (!fault_in_pages_writeable(sd->u.userptr, sd->len)) {
1497 src = buf->ops->map(pipe, buf, 1);
1498 ret = __copy_to_user_inatomic(sd->u.userptr, src + buf->offset,
1499 sd->len);
1500 buf->ops->unmap(pipe, buf, src);
1501 if (!ret) {
1502 ret = sd->len;
1503 goto out;
1504 }
1505 }
1506
1507 /*
1508 * No dice, use slow non-atomic map and copy
1509 */
1510 src = buf->ops->map(pipe, buf, 0);
1511
1512 ret = sd->len;
1513 if (copy_to_user(sd->u.userptr, src + buf->offset, sd->len))
1514 ret = -EFAULT;
1515
Jens Axboe6866bef2007-10-16 10:01:29 +02001516 buf->ops->unmap(pipe, buf, src);
Jens Axboe6a14b902007-06-14 13:08:55 +02001517out:
1518 if (ret > 0)
1519 sd->u.userptr += ret;
Jens Axboe6a14b902007-06-14 13:08:55 +02001520 return ret;
1521}
1522
1523/*
1524 * For lack of a better implementation, implement vmsplice() to userspace
1525 * as a simple copy of the pipes pages to the user iov.
1526 */
1527static long vmsplice_to_user(struct file *file, const struct iovec __user *iov,
1528 unsigned long nr_segs, unsigned int flags)
1529{
1530 struct pipe_inode_info *pipe;
1531 struct splice_desc sd;
1532 ssize_t size;
1533 int error;
1534 long ret;
1535
Linus Torvalds71993e62010-11-28 13:56:09 -08001536 pipe = get_pipe_info(file);
Jens Axboe6a14b902007-06-14 13:08:55 +02001537 if (!pipe)
1538 return -EBADF;
1539
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001540 pipe_lock(pipe);
Jens Axboe6a14b902007-06-14 13:08:55 +02001541
1542 error = ret = 0;
1543 while (nr_segs) {
1544 void __user *base;
1545 size_t len;
1546
1547 /*
1548 * Get user address base and length for this iovec.
1549 */
1550 error = get_user(base, &iov->iov_base);
1551 if (unlikely(error))
1552 break;
1553 error = get_user(len, &iov->iov_len);
1554 if (unlikely(error))
1555 break;
1556
1557 /*
1558 * Sanity check this iovec. 0 read succeeds.
1559 */
1560 if (unlikely(!len))
1561 break;
1562 if (unlikely(!base)) {
1563 error = -EFAULT;
1564 break;
1565 }
1566
Jens Axboe88119302008-02-08 08:49:14 -08001567 if (unlikely(!access_ok(VERIFY_WRITE, base, len))) {
1568 error = -EFAULT;
1569 break;
1570 }
1571
Jens Axboe6a14b902007-06-14 13:08:55 +02001572 sd.len = 0;
1573 sd.total_len = len;
1574 sd.flags = flags;
1575 sd.u.userptr = base;
1576 sd.pos = 0;
1577
1578 size = __splice_from_pipe(pipe, &sd, pipe_to_user);
1579 if (size < 0) {
1580 if (!ret)
1581 ret = size;
1582
1583 break;
1584 }
1585
1586 ret += size;
1587
1588 if (size < len)
1589 break;
1590
1591 nr_segs--;
1592 iov++;
1593 }
1594
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001595 pipe_unlock(pipe);
Jens Axboe6a14b902007-06-14 13:08:55 +02001596
1597 if (!ret)
1598 ret = error;
1599
1600 return ret;
1601}
1602
Jens Axboe912d35f2006-04-26 10:59:21 +02001603/*
1604 * vmsplice splices a user address range into a pipe. It can be thought of
1605 * as splice-from-memory, where the regular splice is splice-from-file (or
1606 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001607 */
Jens Axboe6a14b902007-06-14 13:08:55 +02001608static long vmsplice_to_pipe(struct file *file, const struct iovec __user *iov,
1609 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001610{
Jens Axboeddac0d32006-11-04 12:49:32 +01001611 struct pipe_inode_info *pipe;
Jens Axboe35f3d142010-05-20 10:43:18 +02001612 struct page *pages[PIPE_DEF_BUFFERS];
1613 struct partial_page partial[PIPE_DEF_BUFFERS];
Jens Axboe912d35f2006-04-26 10:59:21 +02001614 struct splice_pipe_desc spd = {
1615 .pages = pages,
1616 .partial = partial,
1617 .flags = flags,
1618 .ops = &user_page_pipe_buf_ops,
Jens Axboebbdfc2f2007-11-06 23:29:47 -08001619 .spd_release = spd_release_page,
Jens Axboe912d35f2006-04-26 10:59:21 +02001620 };
Jens Axboe35f3d142010-05-20 10:43:18 +02001621 long ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001622
Linus Torvalds71993e62010-11-28 13:56:09 -08001623 pipe = get_pipe_info(file);
Jens Axboeddac0d32006-11-04 12:49:32 +01001624 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001625 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001626
Jens Axboe35f3d142010-05-20 10:43:18 +02001627 if (splice_grow_spd(pipe, &spd))
1628 return -ENOMEM;
Jens Axboe912d35f2006-04-26 10:59:21 +02001629
Jens Axboe35f3d142010-05-20 10:43:18 +02001630 spd.nr_pages = get_iovec_page_array(iov, nr_segs, spd.pages,
Eric Dumazetbd1a68b2012-04-04 11:08:51 +02001631 spd.partial, false,
Jens Axboe35f3d142010-05-20 10:43:18 +02001632 pipe->buffers);
1633 if (spd.nr_pages <= 0)
1634 ret = spd.nr_pages;
1635 else
1636 ret = splice_to_pipe(pipe, &spd);
1637
1638 splice_shrink_spd(pipe, &spd);
1639 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001640}
1641
Jens Axboe6a14b902007-06-14 13:08:55 +02001642/*
1643 * Note that vmsplice only really supports true splicing _from_ user memory
1644 * to a pipe, not the other way around. Splicing from user memory is a simple
1645 * operation that can be supported without any funky alignment restrictions
1646 * or nasty vm tricks. We simply map in the user memory and fill them into
1647 * a pipe. The reverse isn't quite as easy, though. There are two possible
1648 * solutions for that:
1649 *
1650 * - memcpy() the data internally, at which point we might as well just
1651 * do a regular read() on the buffer anyway.
1652 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1653 * has restriction limitations on both ends of the pipe).
1654 *
1655 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1656 *
1657 */
Heiko Carstens836f92a2009-01-14 14:14:33 +01001658SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1659 unsigned long, nr_segs, unsigned int, flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001660{
1661 struct file *file;
1662 long error;
1663 int fput;
1664
Jens Axboe6a14b902007-06-14 13:08:55 +02001665 if (unlikely(nr_segs > UIO_MAXIOV))
1666 return -EINVAL;
1667 else if (unlikely(!nr_segs))
1668 return 0;
1669
Jens Axboe912d35f2006-04-26 10:59:21 +02001670 error = -EBADF;
1671 file = fget_light(fd, &fput);
1672 if (file) {
1673 if (file->f_mode & FMODE_WRITE)
Jens Axboe6a14b902007-06-14 13:08:55 +02001674 error = vmsplice_to_pipe(file, iov, nr_segs, flags);
1675 else if (file->f_mode & FMODE_READ)
1676 error = vmsplice_to_user(file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001677
1678 fput_light(file, fput);
1679 }
1680
1681 return error;
1682}
1683
Heiko Carstens836f92a2009-01-14 14:14:33 +01001684SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1685 int, fd_out, loff_t __user *, off_out,
1686 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001687{
1688 long error;
1689 struct file *in, *out;
1690 int fput_in, fput_out;
1691
1692 if (unlikely(!len))
1693 return 0;
1694
1695 error = -EBADF;
Ingo Molnar529565d2006-04-10 15:18:58 +02001696 in = fget_light(fd_in, &fput_in);
Jens Axboe5274f052006-03-30 15:15:30 +02001697 if (in) {
1698 if (in->f_mode & FMODE_READ) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001699 out = fget_light(fd_out, &fput_out);
Jens Axboe5274f052006-03-30 15:15:30 +02001700 if (out) {
1701 if (out->f_mode & FMODE_WRITE)
Ingo Molnar529565d2006-04-10 15:18:58 +02001702 error = do_splice(in, off_in,
1703 out, off_out,
1704 len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +02001705 fput_light(out, fput_out);
1706 }
1707 }
1708
1709 fput_light(in, fput_in);
1710 }
1711
1712 return error;
1713}
Jens Axboe70524492006-04-11 15:51:17 +02001714
1715/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001716 * Make sure there's data to read. Wait for input if we can, otherwise
1717 * return an appropriate error.
1718 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001719static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001720{
1721 int ret;
1722
1723 /*
1724 * Check ->nrbufs without the inode lock first. This function
1725 * is speculative anyways, so missing one is ok.
1726 */
1727 if (pipe->nrbufs)
1728 return 0;
1729
1730 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001731 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001732
1733 while (!pipe->nrbufs) {
1734 if (signal_pending(current)) {
1735 ret = -ERESTARTSYS;
1736 break;
1737 }
1738 if (!pipe->writers)
1739 break;
1740 if (!pipe->waiting_writers) {
1741 if (flags & SPLICE_F_NONBLOCK) {
1742 ret = -EAGAIN;
1743 break;
1744 }
1745 }
1746 pipe_wait(pipe);
1747 }
1748
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001749 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001750 return ret;
1751}
1752
1753/*
1754 * Make sure there's writeable room. Wait for room if we can, otherwise
1755 * return an appropriate error.
1756 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001757static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001758{
1759 int ret;
1760
1761 /*
1762 * Check ->nrbufs without the inode lock first. This function
1763 * is speculative anyways, so missing one is ok.
1764 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001765 if (pipe->nrbufs < pipe->buffers)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001766 return 0;
1767
1768 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001769 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001770
Jens Axboe35f3d142010-05-20 10:43:18 +02001771 while (pipe->nrbufs >= pipe->buffers) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001772 if (!pipe->readers) {
1773 send_sig(SIGPIPE, current, 0);
1774 ret = -EPIPE;
1775 break;
1776 }
1777 if (flags & SPLICE_F_NONBLOCK) {
1778 ret = -EAGAIN;
1779 break;
1780 }
1781 if (signal_pending(current)) {
1782 ret = -ERESTARTSYS;
1783 break;
1784 }
1785 pipe->waiting_writers++;
1786 pipe_wait(pipe);
1787 pipe->waiting_writers--;
1788 }
1789
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001790 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001791 return ret;
1792}
1793
1794/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001795 * Splice contents of ipipe to opipe.
1796 */
1797static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1798 struct pipe_inode_info *opipe,
1799 size_t len, unsigned int flags)
1800{
1801 struct pipe_buffer *ibuf, *obuf;
1802 int ret = 0, nbuf;
1803 bool input_wakeup = false;
1804
1805
1806retry:
1807 ret = ipipe_prep(ipipe, flags);
1808 if (ret)
1809 return ret;
1810
1811 ret = opipe_prep(opipe, flags);
1812 if (ret)
1813 return ret;
1814
1815 /*
1816 * Potential ABBA deadlock, work around it by ordering lock
1817 * grabbing by pipe info address. Otherwise two different processes
1818 * could deadlock (one doing tee from A -> B, the other from B -> A).
1819 */
1820 pipe_double_lock(ipipe, opipe);
1821
1822 do {
1823 if (!opipe->readers) {
1824 send_sig(SIGPIPE, current, 0);
1825 if (!ret)
1826 ret = -EPIPE;
1827 break;
1828 }
1829
1830 if (!ipipe->nrbufs && !ipipe->writers)
1831 break;
1832
1833 /*
1834 * Cannot make any progress, because either the input
1835 * pipe is empty or the output pipe is full.
1836 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001837 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001838 /* Already processed some buffers, break */
1839 if (ret)
1840 break;
1841
1842 if (flags & SPLICE_F_NONBLOCK) {
1843 ret = -EAGAIN;
1844 break;
1845 }
1846
1847 /*
1848 * We raced with another reader/writer and haven't
1849 * managed to process any buffers. A zero return
1850 * value means EOF, so retry instead.
1851 */
1852 pipe_unlock(ipipe);
1853 pipe_unlock(opipe);
1854 goto retry;
1855 }
1856
1857 ibuf = ipipe->bufs + ipipe->curbuf;
Jens Axboe35f3d142010-05-20 10:43:18 +02001858 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001859 obuf = opipe->bufs + nbuf;
1860
1861 if (len >= ibuf->len) {
1862 /*
1863 * Simply move the whole buffer from ipipe to opipe
1864 */
1865 *obuf = *ibuf;
1866 ibuf->ops = NULL;
1867 opipe->nrbufs++;
Jens Axboe35f3d142010-05-20 10:43:18 +02001868 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001869 ipipe->nrbufs--;
1870 input_wakeup = true;
1871 } else {
1872 /*
1873 * Get a reference to this pipe buffer,
1874 * so we can copy the contents over.
1875 */
1876 ibuf->ops->get(ipipe, ibuf);
1877 *obuf = *ibuf;
1878
1879 /*
1880 * Don't inherit the gift flag, we need to
1881 * prevent multiple steals of this page.
1882 */
1883 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1884
1885 obuf->len = len;
1886 opipe->nrbufs++;
1887 ibuf->offset += obuf->len;
1888 ibuf->len -= obuf->len;
1889 }
1890 ret += obuf->len;
1891 len -= obuf->len;
1892 } while (len);
1893
1894 pipe_unlock(ipipe);
1895 pipe_unlock(opipe);
1896
1897 /*
1898 * If we put data in the output pipe, wakeup any potential readers.
1899 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001900 if (ret > 0)
1901 wakeup_pipe_readers(opipe);
1902
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001903 if (input_wakeup)
1904 wakeup_pipe_writers(ipipe);
1905
1906 return ret;
1907}
1908
1909/*
Jens Axboe70524492006-04-11 15:51:17 +02001910 * Link contents of ipipe to opipe.
1911 */
1912static int link_pipe(struct pipe_inode_info *ipipe,
1913 struct pipe_inode_info *opipe,
1914 size_t len, unsigned int flags)
1915{
1916 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001917 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001918
1919 /*
1920 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001921 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001922 * could deadlock (one doing tee from A -> B, the other from B -> A).
1923 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001924 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001925
Jens Axboeaadd06e2006-07-10 11:00:01 +02001926 do {
Jens Axboe70524492006-04-11 15:51:17 +02001927 if (!opipe->readers) {
1928 send_sig(SIGPIPE, current, 0);
1929 if (!ret)
1930 ret = -EPIPE;
1931 break;
1932 }
Jens Axboe70524492006-04-11 15:51:17 +02001933
1934 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001935 * If we have iterated all input buffers or ran out of
1936 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001937 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001938 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
Jens Axboe70524492006-04-11 15:51:17 +02001939 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001940
Jens Axboe35f3d142010-05-20 10:43:18 +02001941 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1942 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001943
Jens Axboe2a27250e2006-04-19 15:56:40 +02001944 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001945 * Get a reference to this pipe buffer,
1946 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001947 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001948 ibuf->ops->get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001949
Jens Axboeaadd06e2006-07-10 11:00:01 +02001950 obuf = opipe->bufs + nbuf;
1951 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001952
Jens Axboeaadd06e2006-07-10 11:00:01 +02001953 /*
1954 * Don't inherit the gift flag, we need to
1955 * prevent multiple steals of this page.
1956 */
1957 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1958
1959 if (obuf->len > len)
1960 obuf->len = len;
1961
1962 opipe->nrbufs++;
1963 ret += obuf->len;
1964 len -= obuf->len;
1965 i++;
1966 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001967
Jens Axboe02cf01a2008-02-20 10:34:51 +01001968 /*
1969 * return EAGAIN if we have the potential of some data in the
1970 * future, otherwise just return 0
1971 */
1972 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1973 ret = -EAGAIN;
1974
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001975 pipe_unlock(ipipe);
1976 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001977
Jens Axboeaadd06e2006-07-10 11:00:01 +02001978 /*
1979 * If we put data in the output pipe, wakeup any potential readers.
1980 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001981 if (ret > 0)
1982 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001983
1984 return ret;
1985}
1986
1987/*
1988 * This is a tee(1) implementation that works on pipes. It doesn't copy
1989 * any data, it simply references the 'in' pages on the 'out' pipe.
1990 * The 'flags' used are the SPLICE_F_* variants, currently the only
1991 * applicable one is SPLICE_F_NONBLOCK.
1992 */
1993static long do_tee(struct file *in, struct file *out, size_t len,
1994 unsigned int flags)
1995{
Linus Torvalds71993e62010-11-28 13:56:09 -08001996 struct pipe_inode_info *ipipe = get_pipe_info(in);
1997 struct pipe_inode_info *opipe = get_pipe_info(out);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001998 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001999
2000 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02002001 * Duplicate the contents of ipipe to opipe without actually
2002 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02002003 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02002004 if (ipipe && opipe && ipipe != opipe) {
2005 /*
2006 * Keep going, unless we encounter an error. The ipipe/opipe
2007 * ordering doesn't really matter.
2008 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02002009 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02002010 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02002011 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01002012 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02002013 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02002014 }
2015 }
Jens Axboe70524492006-04-11 15:51:17 +02002016
Jens Axboeaadd06e2006-07-10 11:00:01 +02002017 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02002018}
2019
Heiko Carstens836f92a2009-01-14 14:14:33 +01002020SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02002021{
2022 struct file *in;
2023 int error, fput_in;
2024
2025 if (unlikely(!len))
2026 return 0;
2027
2028 error = -EBADF;
2029 in = fget_light(fdin, &fput_in);
2030 if (in) {
2031 if (in->f_mode & FMODE_READ) {
2032 int fput_out;
2033 struct file *out = fget_light(fdout, &fput_out);
2034
2035 if (out) {
2036 if (out->f_mode & FMODE_WRITE)
2037 error = do_tee(in, out, len, flags);
2038 fput_light(out, fput_out);
2039 }
2040 }
2041 fput_light(in, fput_in);
2042 }
2043
2044 return error;
2045}