blob: f183f1342c0127bc1739248c5bb1a95362b2eb08 [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>
Al Viro76b021d2013-03-02 10:19:56 -050034#include <linux/compat.h>
Al Viro06ae43f2013-03-20 13:19:30 -040035#include "internal.h"
Jens Axboe5274f052006-03-30 15:15:30 +020036
Jens Axboe83f91352006-04-02 23:05:09 +020037/*
38 * Attempt to steal a page from a pipe buffer. This should perhaps go into
39 * a vm helper function, it's already simplified quite a bit by the
40 * addition of remove_mapping(). If success is returned, the caller may
41 * attempt to reuse this page for another destination.
42 */
Jens Axboe76ad4d12006-05-03 10:41:33 +020043static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
Jens Axboe5abc97a2006-03-30 15:16:46 +020044 struct pipe_buffer *buf)
45{
46 struct page *page = buf->page;
Jens Axboe9e94cd42006-06-20 15:01:12 +020047 struct address_space *mapping;
Jens Axboe5abc97a2006-03-30 15:16:46 +020048
Jens Axboe9e0267c2006-04-19 15:57:31 +020049 lock_page(page);
50
Jens Axboe9e94cd42006-06-20 15:01:12 +020051 mapping = page_mapping(page);
52 if (mapping) {
53 WARN_ON(!PageUptodate(page));
Jens Axboe5abc97a2006-03-30 15:16:46 +020054
Jens Axboe9e94cd42006-06-20 15:01:12 +020055 /*
56 * At least for ext2 with nobh option, we need to wait on
57 * writeback completing on this page, since we'll remove it
58 * from the pagecache. Otherwise truncate wont wait on the
59 * page, allowing the disk blocks to be reused by someone else
60 * before we actually wrote our data to them. fs corruption
61 * ensues.
62 */
63 wait_on_page_writeback(page);
Jens Axboead8d6f02006-04-02 23:10:32 +020064
David Howells266cf652009-04-03 16:42:36 +010065 if (page_has_private(page) &&
66 !try_to_release_page(page, GFP_KERNEL))
Jens Axboeca39d652008-05-20 21:27:41 +020067 goto out_unlock;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020068
Jens Axboe9e94cd42006-06-20 15:01:12 +020069 /*
70 * If we succeeded in removing the mapping, set LRU flag
71 * and return good.
72 */
73 if (remove_mapping(mapping, page)) {
74 buf->flags |= PIPE_BUF_FLAG_LRU;
75 return 0;
76 }
Jens Axboe9e0267c2006-04-19 15:57:31 +020077 }
Jens Axboe5abc97a2006-03-30 15:16:46 +020078
Jens Axboe9e94cd42006-06-20 15:01:12 +020079 /*
80 * Raced with truncate or failed to remove page from current
81 * address space, unlock and return failure.
82 */
Jens Axboeca39d652008-05-20 21:27:41 +020083out_unlock:
Jens Axboe9e94cd42006-06-20 15:01:12 +020084 unlock_page(page);
85 return 1;
Jens Axboe5abc97a2006-03-30 15:16:46 +020086}
87
Jens Axboe76ad4d12006-05-03 10:41:33 +020088static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +020089 struct pipe_buffer *buf)
90{
91 page_cache_release(buf->page);
Jens Axboe14328732006-05-03 10:35:26 +020092 buf->flags &= ~PIPE_BUF_FLAG_LRU;
Jens Axboe5274f052006-03-30 15:15:30 +020093}
94
Jens Axboe08457182007-06-12 20:51:32 +020095/*
96 * Check whether the contents of buf is OK to access. Since the content
97 * is a page cache page, IO may be in flight.
98 */
Jens Axboecac36bb02007-06-14 13:10:48 +020099static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
100 struct pipe_buffer *buf)
Jens Axboe5274f052006-03-30 15:15:30 +0200101{
102 struct page *page = buf->page;
Jens Axboe49d0b212006-04-10 09:04:41 +0200103 int err;
Jens Axboe5274f052006-03-30 15:15:30 +0200104
105 if (!PageUptodate(page)) {
Jens Axboe49d0b212006-04-10 09:04:41 +0200106 lock_page(page);
107
108 /*
109 * Page got truncated/unhashed. This will cause a 0-byte
Ingo Molnar73d62d82006-04-11 13:57:21 +0200110 * splice, if this is the first page.
Jens Axboe49d0b212006-04-10 09:04:41 +0200111 */
112 if (!page->mapping) {
113 err = -ENODATA;
114 goto error;
115 }
116
117 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200118 * Uh oh, read-error from disk.
Jens Axboe49d0b212006-04-10 09:04:41 +0200119 */
120 if (!PageUptodate(page)) {
121 err = -EIO;
122 goto error;
123 }
124
125 /*
Jens Axboef84d7512006-05-01 19:59:03 +0200126 * Page is ok afterall, we are done.
Jens Axboe49d0b212006-04-10 09:04:41 +0200127 */
Jens Axboe5274f052006-03-30 15:15:30 +0200128 unlock_page(page);
Jens Axboe5274f052006-03-30 15:15:30 +0200129 }
130
Jens Axboef84d7512006-05-01 19:59:03 +0200131 return 0;
Jens Axboe49d0b212006-04-10 09:04:41 +0200132error:
133 unlock_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200134 return err;
Jens Axboe70524492006-04-11 15:51:17 +0200135}
136
Hugh Dickins708e3502011-07-25 17:12:32 -0700137const struct pipe_buf_operations page_cache_pipe_buf_ops = {
Jens Axboe5274f052006-03-30 15:15:30 +0200138 .can_merge = 0,
Jens Axboef84d7512006-05-01 19:59:03 +0200139 .map = generic_pipe_buf_map,
140 .unmap = generic_pipe_buf_unmap,
Jens Axboecac36bb02007-06-14 13:10:48 +0200141 .confirm = page_cache_pipe_buf_confirm,
Jens Axboe5274f052006-03-30 15:15:30 +0200142 .release = page_cache_pipe_buf_release,
Jens Axboe5abc97a2006-03-30 15:16:46 +0200143 .steal = page_cache_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200144 .get = generic_pipe_buf_get,
Jens Axboe5274f052006-03-30 15:15:30 +0200145};
146
Jens Axboe912d35f2006-04-26 10:59:21 +0200147static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
148 struct pipe_buffer *buf)
149{
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200150 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
151 return 1;
152
Jens Axboe14328732006-05-03 10:35:26 +0200153 buf->flags |= PIPE_BUF_FLAG_LRU;
Jens Axboe330ab712006-05-02 15:29:57 +0200154 return generic_pipe_buf_steal(pipe, buf);
Jens Axboe912d35f2006-04-26 10:59:21 +0200155}
156
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800157static const struct pipe_buf_operations user_page_pipe_buf_ops = {
Jens Axboe912d35f2006-04-26 10:59:21 +0200158 .can_merge = 0,
Jens Axboef84d7512006-05-01 19:59:03 +0200159 .map = generic_pipe_buf_map,
160 .unmap = generic_pipe_buf_unmap,
Jens Axboecac36bb02007-06-14 13:10:48 +0200161 .confirm = generic_pipe_buf_confirm,
Jens Axboe912d35f2006-04-26 10:59:21 +0200162 .release = page_cache_pipe_buf_release,
163 .steal = user_page_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200164 .get = generic_pipe_buf_get,
Jens Axboe912d35f2006-04-26 10:59:21 +0200165};
166
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200167static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
168{
169 smp_mb();
170 if (waitqueue_active(&pipe->wait))
171 wake_up_interruptible(&pipe->wait);
172 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
173}
174
Jens Axboe932cc6d2007-06-21 13:10:21 +0200175/**
176 * splice_to_pipe - fill passed data into a pipe
177 * @pipe: pipe to fill
178 * @spd: data to fill
179 *
180 * Description:
Randy Dunlap79685b82007-07-27 08:08:51 +0200181 * @spd contains a map of pages and len/offset tuples, along with
Jens Axboe932cc6d2007-06-21 13:10:21 +0200182 * the struct pipe_buf_operations associated with these pages. This
183 * function will link that data to the pipe.
184 *
Jens Axboe83f91352006-04-02 23:05:09 +0200185 */
Jens Axboed6b29d72007-06-04 09:59:47 +0200186ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
187 struct splice_pipe_desc *spd)
Jens Axboe5274f052006-03-30 15:15:30 +0200188{
Jens Axboe00de00b2007-06-15 13:14:22 +0200189 unsigned int spd_pages = spd->nr_pages;
Jens Axboe912d35f2006-04-26 10:59:21 +0200190 int ret, do_wakeup, page_nr;
Jens Axboe5274f052006-03-30 15:15:30 +0200191
192 ret = 0;
193 do_wakeup = 0;
Jens Axboe912d35f2006-04-26 10:59:21 +0200194 page_nr = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200195
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200196 pipe_lock(pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200197
Jens Axboe5274f052006-03-30 15:15:30 +0200198 for (;;) {
Ingo Molnar3a326a22006-04-10 15:18:35 +0200199 if (!pipe->readers) {
Jens Axboe5274f052006-03-30 15:15:30 +0200200 send_sig(SIGPIPE, current, 0);
201 if (!ret)
202 ret = -EPIPE;
203 break;
204 }
205
Jens Axboe35f3d142010-05-20 10:43:18 +0200206 if (pipe->nrbufs < pipe->buffers) {
207 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
Ingo Molnar3a326a22006-04-10 15:18:35 +0200208 struct pipe_buffer *buf = pipe->bufs + newbuf;
Jens Axboe5274f052006-03-30 15:15:30 +0200209
Jens Axboe912d35f2006-04-26 10:59:21 +0200210 buf->page = spd->pages[page_nr];
211 buf->offset = spd->partial[page_nr].offset;
212 buf->len = spd->partial[page_nr].len;
Jens Axboe497f9622007-06-11 12:00:45 +0200213 buf->private = spd->partial[page_nr].private;
Jens Axboe912d35f2006-04-26 10:59:21 +0200214 buf->ops = spd->ops;
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200215 if (spd->flags & SPLICE_F_GIFT)
216 buf->flags |= PIPE_BUF_FLAG_GIFT;
217
Jens Axboe6f767b02006-04-11 13:53:56 +0200218 pipe->nrbufs++;
Jens Axboe912d35f2006-04-26 10:59:21 +0200219 page_nr++;
220 ret += buf->len;
221
Al Viro6447a3c2013-03-21 11:01:38 -0400222 if (pipe->files)
Jens Axboe6f767b02006-04-11 13:53:56 +0200223 do_wakeup = 1;
Jens Axboe5274f052006-03-30 15:15:30 +0200224
Jens Axboe912d35f2006-04-26 10:59:21 +0200225 if (!--spd->nr_pages)
Jens Axboe5274f052006-03-30 15:15:30 +0200226 break;
Jens Axboe35f3d142010-05-20 10:43:18 +0200227 if (pipe->nrbufs < pipe->buffers)
Jens Axboe5274f052006-03-30 15:15:30 +0200228 continue;
229
230 break;
231 }
232
Jens Axboe912d35f2006-04-26 10:59:21 +0200233 if (spd->flags & SPLICE_F_NONBLOCK) {
Linus Torvalds29e35092006-04-02 12:46:35 -0700234 if (!ret)
235 ret = -EAGAIN;
236 break;
237 }
238
Jens Axboe5274f052006-03-30 15:15:30 +0200239 if (signal_pending(current)) {
240 if (!ret)
241 ret = -ERESTARTSYS;
242 break;
243 }
244
245 if (do_wakeup) {
Jens Axboec0bd1f62006-04-10 09:03:32 +0200246 smp_mb();
Ingo Molnar3a326a22006-04-10 15:18:35 +0200247 if (waitqueue_active(&pipe->wait))
248 wake_up_interruptible_sync(&pipe->wait);
249 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
Jens Axboe5274f052006-03-30 15:15:30 +0200250 do_wakeup = 0;
251 }
252
Ingo Molnar3a326a22006-04-10 15:18:35 +0200253 pipe->waiting_writers++;
254 pipe_wait(pipe);
255 pipe->waiting_writers--;
Jens Axboe5274f052006-03-30 15:15:30 +0200256 }
257
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200258 pipe_unlock(pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200259
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200260 if (do_wakeup)
261 wakeup_pipe_readers(pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200262
Jens Axboe00de00b2007-06-15 13:14:22 +0200263 while (page_nr < spd_pages)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800264 spd->spd_release(spd, page_nr++);
Jens Axboe5274f052006-03-30 15:15:30 +0200265
266 return ret;
267}
268
Hugh Dickins708e3502011-07-25 17:12:32 -0700269void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800270{
271 page_cache_release(spd->pages[i]);
272}
273
Jens Axboe35f3d142010-05-20 10:43:18 +0200274/*
275 * Check if we need to grow the arrays holding pages and partial page
276 * descriptions.
277 */
Eric Dumazet047fe362012-06-12 15:24:40 +0200278int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200279{
Eric Dumazet047fe362012-06-12 15:24:40 +0200280 unsigned int buffers = ACCESS_ONCE(pipe->buffers);
281
282 spd->nr_pages_max = buffers;
283 if (buffers <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200284 return 0;
285
Eric Dumazet047fe362012-06-12 15:24:40 +0200286 spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
287 spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200288
289 if (spd->pages && spd->partial)
290 return 0;
291
292 kfree(spd->pages);
293 kfree(spd->partial);
294 return -ENOMEM;
295}
296
Eric Dumazet047fe362012-06-12 15:24:40 +0200297void splice_shrink_spd(struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200298{
Eric Dumazet047fe362012-06-12 15:24:40 +0200299 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200300 return;
301
302 kfree(spd->pages);
303 kfree(spd->partial);
304}
305
Ingo Molnar3a326a22006-04-10 15:18:35 +0200306static int
Jens Axboecbb7e572006-04-11 14:57:50 +0200307__generic_file_splice_read(struct file *in, loff_t *ppos,
308 struct pipe_inode_info *pipe, size_t len,
309 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200310{
311 struct address_space *mapping = in->f_mapping;
Fengguang Wud8983912007-07-19 01:48:06 -0700312 unsigned int loff, nr_pages, req_pages;
Jens Axboe35f3d142010-05-20 10:43:18 +0200313 struct page *pages[PIPE_DEF_BUFFERS];
314 struct partial_page partial[PIPE_DEF_BUFFERS];
Jens Axboe5274f052006-03-30 15:15:30 +0200315 struct page *page;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200316 pgoff_t index, end_index;
317 loff_t isize;
Jens Axboeeb207962006-04-27 11:05:22 +0200318 int error, page_nr;
Jens Axboe912d35f2006-04-26 10:59:21 +0200319 struct splice_pipe_desc spd = {
320 .pages = pages,
321 .partial = partial,
Eric Dumazet047fe362012-06-12 15:24:40 +0200322 .nr_pages_max = PIPE_DEF_BUFFERS,
Jens Axboe912d35f2006-04-26 10:59:21 +0200323 .flags = flags,
324 .ops = &page_cache_pipe_buf_ops,
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800325 .spd_release = spd_release_page,
Jens Axboe912d35f2006-04-26 10:59:21 +0200326 };
Jens Axboe5274f052006-03-30 15:15:30 +0200327
Jens Axboe35f3d142010-05-20 10:43:18 +0200328 if (splice_grow_spd(pipe, &spd))
329 return -ENOMEM;
330
Jens Axboecbb7e572006-04-11 14:57:50 +0200331 index = *ppos >> PAGE_CACHE_SHIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +0200332 loff = *ppos & ~PAGE_CACHE_MASK;
Fengguang Wud8983912007-07-19 01:48:06 -0700333 req_pages = (len + loff + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
Eric Dumazet047fe362012-06-12 15:24:40 +0200334 nr_pages = min(req_pages, spd.nr_pages_max);
Jens Axboe5274f052006-03-30 15:15:30 +0200335
336 /*
Jens Axboeeb207962006-04-27 11:05:22 +0200337 * Lookup the (hopefully) full range of pages we need.
338 */
Jens Axboe35f3d142010-05-20 10:43:18 +0200339 spd.nr_pages = find_get_pages_contig(mapping, index, nr_pages, spd.pages);
Fengguang Wu431a4822007-07-19 01:48:05 -0700340 index += spd.nr_pages;
Jens Axboeeb207962006-04-27 11:05:22 +0200341
342 /*
343 * If find_get_pages_contig() returned fewer pages than we needed,
Fengguang Wu431a4822007-07-19 01:48:05 -0700344 * readahead/allocate the rest and fill in the holes.
Jens Axboeeb207962006-04-27 11:05:22 +0200345 */
Fengguang Wu431a4822007-07-19 01:48:05 -0700346 if (spd.nr_pages < nr_pages)
Rusty Russellcf914a72007-07-19 01:48:08 -0700347 page_cache_sync_readahead(mapping, &in->f_ra, in,
348 index, req_pages - spd.nr_pages);
Fengguang Wu431a4822007-07-19 01:48:05 -0700349
Jens Axboe932cc6d2007-06-21 13:10:21 +0200350 error = 0;
Jens Axboeeb207962006-04-27 11:05:22 +0200351 while (spd.nr_pages < nr_pages) {
352 /*
353 * Page could be there, find_get_pages_contig() breaks on
354 * the first hole.
355 */
356 page = find_get_page(mapping, index);
357 if (!page) {
Jens Axboee27dedd2006-05-01 19:59:54 +0200358 /*
Jens Axboeeb207962006-04-27 11:05:22 +0200359 * page didn't exist, allocate one.
360 */
361 page = page_cache_alloc_cold(mapping);
362 if (!page)
363 break;
364
365 error = add_to_page_cache_lru(page, mapping, index,
Nick Piggin0ae0b5d2010-05-25 10:25:26 +0200366 GFP_KERNEL);
Jens Axboeeb207962006-04-27 11:05:22 +0200367 if (unlikely(error)) {
368 page_cache_release(page);
Jens Axboea0548872006-05-03 10:58:22 +0200369 if (error == -EEXIST)
370 continue;
Jens Axboeeb207962006-04-27 11:05:22 +0200371 break;
372 }
373 /*
374 * add_to_page_cache() locks the page, unlock it
375 * to avoid convoluting the logic below even more.
376 */
377 unlock_page(page);
378 }
379
Jens Axboe35f3d142010-05-20 10:43:18 +0200380 spd.pages[spd.nr_pages++] = page;
Jens Axboeeb207962006-04-27 11:05:22 +0200381 index++;
382 }
383
384 /*
385 * Now loop over the map and see if we need to start IO on any
386 * pages, fill in the partial map, etc.
387 */
388 index = *ppos >> PAGE_CACHE_SHIFT;
389 nr_pages = spd.nr_pages;
390 spd.nr_pages = 0;
391 for (page_nr = 0; page_nr < nr_pages; page_nr++) {
Jens Axboe82aa5d62006-04-20 13:05:48 +0200392 unsigned int this_len;
393
394 if (!len)
395 break;
396
397 /*
398 * this_len is the max we'll use from this page
399 */
Andrew Mortonba5f5d92006-04-25 15:33:34 +0200400 this_len = min_t(unsigned long, len, PAGE_CACHE_SIZE - loff);
Jens Axboe35f3d142010-05-20 10:43:18 +0200401 page = spd.pages[page_nr];
Jens Axboe7480a902006-04-11 13:52:47 +0200402
Fengguang Wua08a1662007-07-19 01:48:03 -0700403 if (PageReadahead(page))
Rusty Russellcf914a72007-07-19 01:48:08 -0700404 page_cache_async_readahead(mapping, &in->f_ra, in,
Fengguang Wud8983912007-07-19 01:48:06 -0700405 page, index, req_pages - page_nr);
Fengguang Wua08a1662007-07-19 01:48:03 -0700406
Jens Axboe7480a902006-04-11 13:52:47 +0200407 /*
408 * If the page isn't uptodate, we may need to start io on it
409 */
410 if (!PageUptodate(page)) {
Miklos Szeredi69650312010-08-03 12:48:50 +0200411 lock_page(page);
Jens Axboe7480a902006-04-11 13:52:47 +0200412
413 /*
Miklos Szeredi32502b82008-07-04 09:35:17 +0200414 * Page was truncated, or invalidated by the
415 * filesystem. Redo the find/create, but this time the
416 * page is kept locked, so there's no chance of another
417 * race with truncate/invalidate.
Jens Axboe7480a902006-04-11 13:52:47 +0200418 */
419 if (!page->mapping) {
420 unlock_page(page);
Miklos Szeredi32502b82008-07-04 09:35:17 +0200421 page = find_or_create_page(mapping, index,
422 mapping_gfp_mask(mapping));
423
424 if (!page) {
425 error = -ENOMEM;
426 break;
427 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200428 page_cache_release(spd.pages[page_nr]);
429 spd.pages[page_nr] = page;
Jens Axboe7480a902006-04-11 13:52:47 +0200430 }
431 /*
432 * page was already under io and is now done, great
433 */
434 if (PageUptodate(page)) {
435 unlock_page(page);
436 goto fill_it;
437 }
438
Jens Axboe7480a902006-04-11 13:52:47 +0200439 /*
440 * need to read in the page
441 */
442 error = mapping->a_ops->readpage(in, page);
Jens Axboe7480a902006-04-11 13:52:47 +0200443 if (unlikely(error)) {
Jens Axboeeb207962006-04-27 11:05:22 +0200444 /*
445 * We really should re-lookup the page here,
446 * but it complicates things a lot. Instead
447 * lets just do what we already stored, and
448 * we'll get it the next time we are called.
449 */
Jens Axboe7480a902006-04-11 13:52:47 +0200450 if (error == AOP_TRUNCATED_PAGE)
Jens Axboeeb207962006-04-27 11:05:22 +0200451 error = 0;
452
Jens Axboe7480a902006-04-11 13:52:47 +0200453 break;
454 }
Jens Axboe620a3242007-06-07 09:39:42 +0200455 }
456fill_it:
457 /*
458 * i_size must be checked after PageUptodate.
459 */
460 isize = i_size_read(mapping->host);
461 end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
462 if (unlikely(!isize || index > end_index))
463 break;
464
465 /*
466 * if this is the last page, see if we need to shrink
467 * the length and stop
468 */
469 if (end_index == index) {
470 unsigned int plen;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200471
472 /*
Jens Axboe620a3242007-06-07 09:39:42 +0200473 * max good bytes in this page
Jens Axboe91ad66e2006-04-19 15:55:10 +0200474 */
Jens Axboe620a3242007-06-07 09:39:42 +0200475 plen = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
476 if (plen <= loff)
Jens Axboe91ad66e2006-04-19 15:55:10 +0200477 break;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200478
479 /*
Jens Axboe620a3242007-06-07 09:39:42 +0200480 * force quit after adding this page
Jens Axboe91ad66e2006-04-19 15:55:10 +0200481 */
Jens Axboe620a3242007-06-07 09:39:42 +0200482 this_len = min(this_len, plen - loff);
483 len = this_len;
Jens Axboe7480a902006-04-11 13:52:47 +0200484 }
Jens Axboe620a3242007-06-07 09:39:42 +0200485
Jens Axboe35f3d142010-05-20 10:43:18 +0200486 spd.partial[page_nr].offset = loff;
487 spd.partial[page_nr].len = this_len;
Jens Axboe82aa5d62006-04-20 13:05:48 +0200488 len -= this_len;
Jens Axboe91ad66e2006-04-19 15:55:10 +0200489 loff = 0;
Jens Axboeeb207962006-04-27 11:05:22 +0200490 spd.nr_pages++;
491 index++;
Jens Axboe5274f052006-03-30 15:15:30 +0200492 }
493
Jens Axboeeb207962006-04-27 11:05:22 +0200494 /*
Hugh Dickins475ecad2007-06-07 09:36:00 +0200495 * Release any pages at the end, if we quit early. 'page_nr' is how far
Jens Axboeeb207962006-04-27 11:05:22 +0200496 * we got, 'nr_pages' is how many pages are in the map.
497 */
498 while (page_nr < nr_pages)
Jens Axboe35f3d142010-05-20 10:43:18 +0200499 page_cache_release(spd.pages[page_nr++]);
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700500 in->f_ra.prev_pos = (loff_t)index << PAGE_CACHE_SHIFT;
Jens Axboeeb207962006-04-27 11:05:22 +0200501
Jens Axboe912d35f2006-04-26 10:59:21 +0200502 if (spd.nr_pages)
Jens Axboe35f3d142010-05-20 10:43:18 +0200503 error = splice_to_pipe(pipe, &spd);
Jens Axboe5274f052006-03-30 15:15:30 +0200504
Eric Dumazet047fe362012-06-12 15:24:40 +0200505 splice_shrink_spd(&spd);
Jens Axboe7480a902006-04-11 13:52:47 +0200506 return error;
Jens Axboe5274f052006-03-30 15:15:30 +0200507}
508
Jens Axboe83f91352006-04-02 23:05:09 +0200509/**
510 * generic_file_splice_read - splice data from file to a pipe
511 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200512 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200513 * @pipe: pipe to splice to
514 * @len: number of bytes to splice
515 * @flags: splice modifier flags
516 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200517 * Description:
518 * Will read pages from given file and fill them into a pipe. Can be
519 * used as long as the address_space operations for the source implements
520 * a readpage() hook.
521 *
Jens Axboe83f91352006-04-02 23:05:09 +0200522 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200523ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
524 struct pipe_inode_info *pipe, size_t len,
525 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200526{
Jens Axboed366d3982007-06-01 14:54:11 +0200527 loff_t isize, left;
Jens Axboe8191ecd2008-04-10 08:24:25 +0200528 int ret;
Jens Axboed366d3982007-06-01 14:54:11 +0200529
530 isize = i_size_read(in->f_mapping->host);
531 if (unlikely(*ppos >= isize))
532 return 0;
533
534 left = isize - *ppos;
535 if (unlikely(left < len))
536 len = left;
Jens Axboe5274f052006-03-30 15:15:30 +0200537
Jens Axboe8191ecd2008-04-10 08:24:25 +0200538 ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200539 if (ret > 0) {
Jens Axboecbb7e572006-04-11 14:57:50 +0200540 *ppos += ret;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200541 file_accessed(in);
542 }
Jens Axboe5274f052006-03-30 15:15:30 +0200543
544 return ret;
545}
Jens Axboe059a8f32006-04-02 23:06:05 +0200546EXPORT_SYMBOL(generic_file_splice_read);
547
Miklos Szeredi68181732009-05-07 15:37:36 +0200548static const struct pipe_buf_operations default_pipe_buf_ops = {
549 .can_merge = 0,
550 .map = generic_pipe_buf_map,
551 .unmap = generic_pipe_buf_unmap,
552 .confirm = generic_pipe_buf_confirm,
553 .release = generic_pipe_buf_release,
554 .steal = generic_pipe_buf_steal,
555 .get = generic_pipe_buf_get,
556};
557
Miklos Szeredid840f982014-01-22 19:36:57 +0100558static int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
559 struct pipe_buffer *buf)
560{
561 return 1;
562}
563
564/* Pipe buffer operations for a socket and similar. */
565const struct pipe_buf_operations nosteal_pipe_buf_ops = {
566 .can_merge = 0,
567 .map = generic_pipe_buf_map,
568 .unmap = generic_pipe_buf_unmap,
569 .confirm = generic_pipe_buf_confirm,
570 .release = generic_pipe_buf_release,
571 .steal = generic_pipe_buf_nosteal,
572 .get = generic_pipe_buf_get,
573};
574EXPORT_SYMBOL(nosteal_pipe_buf_ops);
575
Miklos Szeredi68181732009-05-07 15:37:36 +0200576static ssize_t kernel_readv(struct file *file, const struct iovec *vec,
577 unsigned long vlen, loff_t offset)
578{
579 mm_segment_t old_fs;
580 loff_t pos = offset;
581 ssize_t res;
582
583 old_fs = get_fs();
584 set_fs(get_ds());
585 /* The cast to a user pointer is valid due to the set_fs() */
586 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos);
587 set_fs(old_fs);
588
589 return res;
590}
591
Al Viro7bb307e2013-02-23 14:51:48 -0500592ssize_t kernel_write(struct file *file, const char *buf, size_t count,
Miklos Szeredib2858d72009-05-19 11:37:46 +0200593 loff_t pos)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200594{
595 mm_segment_t old_fs;
596 ssize_t res;
597
598 old_fs = get_fs();
599 set_fs(get_ds());
600 /* The cast to a user pointer is valid due to the set_fs() */
Al Viro7bb307e2013-02-23 14:51:48 -0500601 res = vfs_write(file, (__force const char __user *)buf, count, &pos);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200602 set_fs(old_fs);
603
604 return res;
605}
Al Viro7bb307e2013-02-23 14:51:48 -0500606EXPORT_SYMBOL(kernel_write);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200607
Miklos Szeredi68181732009-05-07 15:37:36 +0200608ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
609 struct pipe_inode_info *pipe, size_t len,
610 unsigned int flags)
611{
612 unsigned int nr_pages;
613 unsigned int nr_freed;
614 size_t offset;
Jens Axboe35f3d142010-05-20 10:43:18 +0200615 struct page *pages[PIPE_DEF_BUFFERS];
616 struct partial_page partial[PIPE_DEF_BUFFERS];
617 struct iovec *vec, __vec[PIPE_DEF_BUFFERS];
Miklos Szeredi68181732009-05-07 15:37:36 +0200618 ssize_t res;
619 size_t this_len;
620 int error;
621 int i;
622 struct splice_pipe_desc spd = {
623 .pages = pages,
624 .partial = partial,
Eric Dumazet047fe362012-06-12 15:24:40 +0200625 .nr_pages_max = PIPE_DEF_BUFFERS,
Miklos Szeredi68181732009-05-07 15:37:36 +0200626 .flags = flags,
627 .ops = &default_pipe_buf_ops,
628 .spd_release = spd_release_page,
629 };
630
Jens Axboe35f3d142010-05-20 10:43:18 +0200631 if (splice_grow_spd(pipe, &spd))
632 return -ENOMEM;
633
634 res = -ENOMEM;
635 vec = __vec;
Eric Dumazet047fe362012-06-12 15:24:40 +0200636 if (spd.nr_pages_max > PIPE_DEF_BUFFERS) {
637 vec = kmalloc(spd.nr_pages_max * sizeof(struct iovec), GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200638 if (!vec)
639 goto shrink_ret;
640 }
641
Miklos Szeredi68181732009-05-07 15:37:36 +0200642 offset = *ppos & ~PAGE_CACHE_MASK;
643 nr_pages = (len + offset + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
644
Eric Dumazet047fe362012-06-12 15:24:40 +0200645 for (i = 0; i < nr_pages && i < spd.nr_pages_max && len; i++) {
Miklos Szeredi68181732009-05-07 15:37:36 +0200646 struct page *page;
647
Jens Axboe4f231222009-05-13 08:35:35 +0200648 page = alloc_page(GFP_USER);
Miklos Szeredi68181732009-05-07 15:37:36 +0200649 error = -ENOMEM;
650 if (!page)
651 goto err;
652
653 this_len = min_t(size_t, len, PAGE_CACHE_SIZE - offset);
Jens Axboe4f231222009-05-13 08:35:35 +0200654 vec[i].iov_base = (void __user *) page_address(page);
Miklos Szeredi68181732009-05-07 15:37:36 +0200655 vec[i].iov_len = this_len;
Jens Axboe35f3d142010-05-20 10:43:18 +0200656 spd.pages[i] = page;
Miklos Szeredi68181732009-05-07 15:37:36 +0200657 spd.nr_pages++;
658 len -= this_len;
659 offset = 0;
660 }
661
662 res = kernel_readv(in, vec, spd.nr_pages, *ppos);
Andrew Morton77f6bf52009-05-14 09:49:44 +0200663 if (res < 0) {
664 error = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200665 goto err;
Andrew Morton77f6bf52009-05-14 09:49:44 +0200666 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200667
668 error = 0;
669 if (!res)
670 goto err;
671
672 nr_freed = 0;
673 for (i = 0; i < spd.nr_pages; i++) {
Miklos Szeredi68181732009-05-07 15:37:36 +0200674 this_len = min_t(size_t, vec[i].iov_len, res);
Jens Axboe35f3d142010-05-20 10:43:18 +0200675 spd.partial[i].offset = 0;
676 spd.partial[i].len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200677 if (!this_len) {
Jens Axboe35f3d142010-05-20 10:43:18 +0200678 __free_page(spd.pages[i]);
679 spd.pages[i] = NULL;
Miklos Szeredi68181732009-05-07 15:37:36 +0200680 nr_freed++;
681 }
682 res -= this_len;
683 }
684 spd.nr_pages -= nr_freed;
685
686 res = splice_to_pipe(pipe, &spd);
687 if (res > 0)
688 *ppos += res;
689
Jens Axboe35f3d142010-05-20 10:43:18 +0200690shrink_ret:
691 if (vec != __vec)
692 kfree(vec);
Eric Dumazet047fe362012-06-12 15:24:40 +0200693 splice_shrink_spd(&spd);
Miklos Szeredi68181732009-05-07 15:37:36 +0200694 return res;
695
696err:
Jens Axboe4f231222009-05-13 08:35:35 +0200697 for (i = 0; i < spd.nr_pages; i++)
Jens Axboe35f3d142010-05-20 10:43:18 +0200698 __free_page(spd.pages[i]);
Jens Axboe4f231222009-05-13 08:35:35 +0200699
Jens Axboe35f3d142010-05-20 10:43:18 +0200700 res = error;
701 goto shrink_ret;
Miklos Szeredi68181732009-05-07 15:37:36 +0200702}
703EXPORT_SYMBOL(default_file_splice_read);
704
Jens Axboe5274f052006-03-30 15:15:30 +0200705/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200706 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200707 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200708 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200709static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200710 struct pipe_buffer *buf, struct splice_desc *sd)
711{
Jens Axboe6a14b902007-06-14 13:08:55 +0200712 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200713 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100714 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200715
Michał Mirosława8adbe32010-12-17 08:56:44 +0100716 if (!likely(file->f_op && file->f_op->sendpage))
717 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200718
Eric Dumazet35f9c092012-04-05 03:05:35 +0000719 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000720
721 if (sd->len < sd->total_len && pipe->nrbufs > 1)
Eric Dumazet35f9c092012-04-05 03:05:35 +0000722 more |= MSG_SENDPAGE_NOTLAST;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000723
Michał Mirosława8adbe32010-12-17 08:56:44 +0100724 return file->f_op->sendpage(file, buf->page, buf->offset,
725 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200726}
727
728/*
729 * This is a little more tricky than the file -> pipe splicing. There are
730 * basically three cases:
731 *
732 * - Destination page already exists in the address space and there
733 * are users of it. For that case we have no other option that
734 * copying the data. Tough luck.
735 * - Destination page already exists in the address space, but there
736 * are no users of it. Make sure it's uptodate, then drop it. Fall
737 * through to last case.
738 * - Destination page does not exist, we can add the pipe page to
739 * the page cache and avoid the copy.
740 *
Jens Axboe83f91352006-04-02 23:05:09 +0200741 * If asked to move pages to the output file (SPLICE_F_MOVE is set in
742 * sd->flags), we attempt to migrate pages from the pipe to the output
743 * file address space page cache. This is possible if no one else has
744 * the pipe page referenced outside of the pipe and page cache. If
745 * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create
746 * a new page in the output file page cache and fill/dirty that.
Jens Axboe5274f052006-03-30 15:15:30 +0200747 */
Miklos Szeredi328eaab2009-04-14 19:48:39 +0200748int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
749 struct splice_desc *sd)
Jens Axboe5274f052006-03-30 15:15:30 +0200750{
Jens Axboe6a14b902007-06-14 13:08:55 +0200751 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200752 struct address_space *mapping = file->f_mapping;
Jens Axboe016b6612006-04-25 15:42:00 +0200753 unsigned int offset, this_len;
Jens Axboe5274f052006-03-30 15:15:30 +0200754 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -0700755 void *fsdata;
Jens Axboe3e7ee3e2006-04-02 23:11:04 +0200756 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200757
Jens Axboe5274f052006-03-30 15:15:30 +0200758 offset = sd->pos & ~PAGE_CACHE_MASK;
759
Jens Axboe016b6612006-04-25 15:42:00 +0200760 this_len = sd->len;
761 if (this_len + offset > PAGE_CACHE_SIZE)
762 this_len = PAGE_CACHE_SIZE - offset;
763
Nick Pigginafddba42007-10-16 01:25:01 -0700764 ret = pagecache_write_begin(file, mapping, sd->pos, this_len,
765 AOP_FLAG_UNINTERRUPTIBLE, &page, &fsdata);
766 if (unlikely(ret))
767 goto out;
Jens Axboe5274f052006-03-30 15:15:30 +0200768
Jens Axboe0568b402006-05-01 19:50:48 +0200769 if (buf->page != page) {
Jens Axboe76ad4d12006-05-03 10:41:33 +0200770 char *src = buf->ops->map(pipe, buf, 1);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800771 char *dst = kmap_atomic(page);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200772
Jens Axboe016b6612006-04-25 15:42:00 +0200773 memcpy(dst + offset, src + buf->offset, this_len);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200774 flush_dcache_page(page);
Cong Wange8e3c3d2011-11-25 23:14:27 +0800775 kunmap_atomic(dst);
Jens Axboe76ad4d12006-05-03 10:41:33 +0200776 buf->ops->unmap(pipe, buf, src);
Jens Axboe5abc97a2006-03-30 15:16:46 +0200777 }
Nick Pigginafddba42007-10-16 01:25:01 -0700778 ret = pagecache_write_end(file, mapping, sd->pos, this_len, this_len,
779 page, fsdata);
Jens Axboe5274f052006-03-30 15:15:30 +0200780out:
Jens Axboe5274f052006-03-30 15:15:30 +0200781 return ret;
782}
Miklos Szeredi328eaab2009-04-14 19:48:39 +0200783EXPORT_SYMBOL(pipe_to_file);
Jens Axboe5274f052006-03-30 15:15:30 +0200784
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200785static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
786{
787 smp_mb();
788 if (waitqueue_active(&pipe->wait))
789 wake_up_interruptible(&pipe->wait);
790 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
791}
792
793/**
794 * splice_from_pipe_feed - feed available data from a pipe to a file
795 * @pipe: pipe to splice from
796 * @sd: information to @actor
797 * @actor: handler that splices the data
798 *
799 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200800 * This function loops over the pipe and calls @actor to do the
801 * actual moving of a single struct pipe_buffer to the desired
802 * destination. It returns when there's no more buffers left in
803 * the pipe or if the requested number of bytes (@sd->total_len)
804 * have been copied. It returns a positive number (one) if the
805 * pipe needs to be filled with more data, zero if the required
806 * number of bytes have been copied and -errno on error.
807 *
808 * This, together with splice_from_pipe_{begin,end,next}, may be
809 * used to implement the functionality of __splice_from_pipe() when
810 * locking is required around copying the pipe buffers to the
811 * destination.
812 */
813int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
814 splice_actor *actor)
815{
816 int ret;
817
818 while (pipe->nrbufs) {
819 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
820 const struct pipe_buf_operations *ops = buf->ops;
821
822 sd->len = buf->len;
823 if (sd->len > sd->total_len)
824 sd->len = sd->total_len;
825
Michał Mirosława8adbe32010-12-17 08:56:44 +0100826 ret = buf->ops->confirm(pipe, buf);
827 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200828 if (ret == -ENODATA)
829 ret = 0;
830 return ret;
831 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100832
833 ret = actor(pipe, buf, sd);
834 if (ret <= 0)
835 return ret;
836
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200837 buf->offset += ret;
838 buf->len -= ret;
839
840 sd->num_spliced += ret;
841 sd->len -= ret;
842 sd->pos += ret;
843 sd->total_len -= ret;
844
845 if (!buf->len) {
846 buf->ops = NULL;
847 ops->release(pipe, buf);
Jens Axboe35f3d142010-05-20 10:43:18 +0200848 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200849 pipe->nrbufs--;
Al Viro6447a3c2013-03-21 11:01:38 -0400850 if (pipe->files)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200851 sd->need_wakeup = true;
852 }
853
854 if (!sd->total_len)
855 return 0;
856 }
857
858 return 1;
859}
860EXPORT_SYMBOL(splice_from_pipe_feed);
861
862/**
863 * splice_from_pipe_next - wait for some data to splice from
864 * @pipe: pipe to splice from
865 * @sd: information about the splice operation
866 *
867 * Description:
868 * This function will wait for some data and return a positive
869 * value (one) if pipe buffers are available. It will return zero
870 * or -errno if no more data needs to be spliced.
871 */
872int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
873{
874 while (!pipe->nrbufs) {
875 if (!pipe->writers)
876 return 0;
877
878 if (!pipe->waiting_writers && sd->num_spliced)
879 return 0;
880
881 if (sd->flags & SPLICE_F_NONBLOCK)
882 return -EAGAIN;
883
884 if (signal_pending(current))
885 return -ERESTARTSYS;
886
887 if (sd->need_wakeup) {
888 wakeup_pipe_writers(pipe);
889 sd->need_wakeup = false;
890 }
891
892 pipe_wait(pipe);
893 }
894
895 return 1;
896}
897EXPORT_SYMBOL(splice_from_pipe_next);
898
899/**
900 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700901 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200902 *
903 * Description:
904 * This function should be called before a loop containing
905 * splice_from_pipe_next() and splice_from_pipe_feed() to
906 * initialize the necessary fields of @sd.
907 */
908void splice_from_pipe_begin(struct splice_desc *sd)
909{
910 sd->num_spliced = 0;
911 sd->need_wakeup = false;
912}
913EXPORT_SYMBOL(splice_from_pipe_begin);
914
915/**
916 * splice_from_pipe_end - finish splicing from pipe
917 * @pipe: pipe to splice from
918 * @sd: information about the splice operation
919 *
920 * Description:
921 * This function will wake up pipe writers if necessary. It should
922 * be called after a loop containing splice_from_pipe_next() and
923 * splice_from_pipe_feed().
924 */
925void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
926{
927 if (sd->need_wakeup)
928 wakeup_pipe_writers(pipe);
929}
930EXPORT_SYMBOL(splice_from_pipe_end);
931
Jens Axboe932cc6d2007-06-21 13:10:21 +0200932/**
933 * __splice_from_pipe - splice data from a pipe to given actor
934 * @pipe: pipe to splice from
935 * @sd: information to @actor
936 * @actor: handler that splices the data
937 *
938 * Description:
939 * This function does little more than loop over the pipe and call
940 * @actor to do the actual moving of a single struct pipe_buffer to
941 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
942 * pipe_to_user.
943 *
Jens Axboe83f91352006-04-02 23:05:09 +0200944 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200945ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
946 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200947{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200948 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200949
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200950 splice_from_pipe_begin(sd);
951 do {
952 ret = splice_from_pipe_next(pipe, sd);
953 if (ret > 0)
954 ret = splice_from_pipe_feed(pipe, sd, actor);
955 } while (ret > 0);
956 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200957
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200958 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200959}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100960EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200961
Jens Axboe932cc6d2007-06-21 13:10:21 +0200962/**
963 * splice_from_pipe - splice data from a pipe to a file
964 * @pipe: pipe to splice from
965 * @out: file to splice to
966 * @ppos: position in @out
967 * @len: how many bytes to splice
968 * @flags: splice modifier flags
969 * @actor: handler that splices the data
970 *
971 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200972 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200973 * otherwise it's identical to __splice_from_pipe().
974 *
975 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200976ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
977 loff_t *ppos, size_t len, unsigned int flags,
978 splice_actor *actor)
979{
980 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200981 struct splice_desc sd = {
982 .total_len = len,
983 .flags = flags,
984 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200985 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200986 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200987
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200988 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200989 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200990 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200991
992 return ret;
993}
994
995/**
Jens Axboe83f91352006-04-02 23:05:09 +0200996 * generic_file_splice_write - splice data from a pipe to a file
Ingo Molnar3a326a22006-04-10 15:18:35 +0200997 * @pipe: pipe info
Jens Axboe83f91352006-04-02 23:05:09 +0200998 * @out: file to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200999 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +02001000 * @len: number of bytes to splice
1001 * @flags: splice modifier flags
1002 *
Jens Axboe932cc6d2007-06-21 13:10:21 +02001003 * Description:
1004 * Will either move or copy pages (determined by @flags options) from
1005 * the given pipe inode to the given file.
Jens Axboe83f91352006-04-02 23:05:09 +02001006 *
1007 */
Ingo Molnar3a326a22006-04-10 15:18:35 +02001008ssize_t
1009generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +02001010 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001011{
Jens Axboe4f6f0bd2006-04-02 23:04:46 +02001012 struct address_space *mapping = out->f_mapping;
Jens Axboe8c34e2d2006-10-17 19:43:22 +02001013 struct inode *inode = mapping->host;
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +02001014 struct splice_desc sd = {
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +02001015 .flags = flags,
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +02001016 .u.file = out,
1017 };
Ingo Molnar3a326a22006-04-10 15:18:35 +02001018 ssize_t ret;
Jens Axboe8c34e2d2006-10-17 19:43:22 +02001019
Ben Hutchings13d32f22015-01-29 02:50:33 +00001020 ret = generic_write_checks(out, ppos, &len, S_ISBLK(inode->i_mode));
1021 if (ret)
1022 return ret;
1023 sd.total_len = len;
1024 sd.pos = *ppos;
1025
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001026 pipe_lock(pipe);
Miklos Szeredieb443e52009-04-14 19:48:38 +02001027
1028 splice_from_pipe_begin(&sd);
1029 do {
1030 ret = splice_from_pipe_next(pipe, &sd);
1031 if (ret <= 0)
1032 break;
1033
1034 mutex_lock_nested(&inode->i_mutex, I_MUTEX_CHILD);
1035 ret = file_remove_suid(out);
Miklos Szeredi723590e2009-08-15 08:43:22 +02001036 if (!ret) {
Josef Bacikc3b2da32012-03-26 09:59:21 -04001037 ret = file_update_time(out);
1038 if (!ret)
1039 ret = splice_from_pipe_feed(pipe, &sd,
1040 pipe_to_file);
Miklos Szeredi723590e2009-08-15 08:43:22 +02001041 }
Miklos Szeredieb443e52009-04-14 19:48:38 +02001042 mutex_unlock(&inode->i_mutex);
1043 } while (ret > 0);
1044 splice_from_pipe_end(pipe, &sd);
1045
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001046 pipe_unlock(pipe);
Miklos Szeredieb443e52009-04-14 19:48:38 +02001047
1048 if (sd.num_spliced)
1049 ret = sd.num_spliced;
1050
Jens Axboea4514eb2006-04-19 15:57:05 +02001051 if (ret > 0) {
Jan Kara148f9482009-08-17 19:52:36 +02001052 int err;
Jens Axboe17ee4f42007-06-15 13:10:37 +02001053
Jan Kara148f9482009-08-17 19:52:36 +02001054 err = generic_write_sync(out, *ppos, ret);
1055 if (err)
1056 ret = err;
1057 else
1058 *ppos += ret;
Namjae Jeond0e1d662012-12-11 16:00:21 -08001059 balance_dirty_pages_ratelimited(mapping);
Jens Axboe4f6f0bd2006-04-02 23:04:46 +02001060 }
1061
1062 return ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001063}
1064
Jens Axboe059a8f32006-04-02 23:06:05 +02001065EXPORT_SYMBOL(generic_file_splice_write);
1066
Miklos Szeredib2858d72009-05-19 11:37:46 +02001067static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1068 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001069{
Miklos Szeredib2858d72009-05-19 11:37:46 +02001070 int ret;
1071 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -04001072 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +02001073
Miklos Szeredib2858d72009-05-19 11:37:46 +02001074 data = buf->ops->map(pipe, buf, 0);
Al Viro06ae43f2013-03-20 13:19:30 -04001075 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Miklos Szeredib2858d72009-05-19 11:37:46 +02001076 buf->ops->unmap(pipe, buf, data);
1077
1078 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001079}
1080
1081static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
1082 struct file *out, loff_t *ppos,
1083 size_t len, unsigned int flags)
1084{
Miklos Szeredib2858d72009-05-19 11:37:46 +02001085 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001086
Miklos Szeredib2858d72009-05-19 11:37:46 +02001087 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
1088 if (ret > 0)
1089 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001090
Miklos Szeredib2858d72009-05-19 11:37:46 +02001091 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001092}
1093
Jens Axboe83f91352006-04-02 23:05:09 +02001094/**
1095 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +02001096 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +02001097 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +02001098 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +02001099 * @len: number of bytes to splice
1100 * @flags: splice modifier flags
1101 *
Jens Axboe932cc6d2007-06-21 13:10:21 +02001102 * Description:
1103 * Will send @len bytes from the pipe to a network socket. No data copying
1104 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +02001105 *
1106 */
Ingo Molnar3a326a22006-04-10 15:18:35 +02001107ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +02001108 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001109{
Jens Axboe00522fb2006-04-26 14:39:29 +02001110 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +02001111}
1112
Jens Axboe059a8f32006-04-02 23:06:05 +02001113EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -05001114
Jens Axboe83f91352006-04-02 23:05:09 +02001115/*
1116 * Attempt to initiate a splice from pipe to file.
1117 */
Ingo Molnar3a326a22006-04-10 15:18:35 +02001118static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +02001119 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001120{
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001121 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
1122 loff_t *, 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(!(out->f_mode & FMODE_WRITE)))
Jens Axboe5274f052006-03-30 15:15:30 +02001126 return -EBADF;
1127
Linus Torvaldsefc968d2008-10-09 14:04:54 -07001128 if (unlikely(out->f_flags & O_APPEND))
1129 return -EINVAL;
1130
Jens Axboecbb7e572006-04-11 14:57:50 +02001131 ret = rw_verify_area(WRITE, out, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +02001132 if (unlikely(ret < 0))
1133 return ret;
1134
Changli Gaocc56f7d2009-11-04 09:09:52 +01001135 if (out->f_op && out->f_op->splice_write)
1136 splice_write = out->f_op->splice_write;
1137 else
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +02001138 splice_write = default_file_splice_write;
1139
Al Viro2dd8c9a2013-03-20 13:21:32 -04001140 file_start_write(out);
1141 ret = splice_write(pipe, out, ppos, len, flags);
1142 file_end_write(out);
1143 return ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001144}
1145
Jens Axboe83f91352006-04-02 23:05:09 +02001146/*
1147 * Attempt to initiate a splice from a file to a pipe.
1148 */
Jens Axboecbb7e572006-04-11 14:57:50 +02001149static long do_splice_to(struct file *in, loff_t *ppos,
1150 struct pipe_inode_info *pipe, size_t len,
1151 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001152{
Miklos Szeredi68181732009-05-07 15:37:36 +02001153 ssize_t (*splice_read)(struct file *, loff_t *,
1154 struct pipe_inode_info *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +02001155 int ret;
1156
Jens Axboe49570e92006-04-11 13:56:09 +02001157 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +02001158 return -EBADF;
1159
Jens Axboecbb7e572006-04-11 14:57:50 +02001160 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +02001161 if (unlikely(ret < 0))
1162 return ret;
1163
Changli Gaocc56f7d2009-11-04 09:09:52 +01001164 if (in->f_op && in->f_op->splice_read)
1165 splice_read = in->f_op->splice_read;
1166 else
Miklos Szeredi68181732009-05-07 15:37:36 +02001167 splice_read = default_file_splice_read;
1168
1169 return splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +02001170}
1171
Jens Axboe932cc6d2007-06-21 13:10:21 +02001172/**
1173 * splice_direct_to_actor - splices data directly between two non-pipes
1174 * @in: file to splice from
1175 * @sd: actor information on where to splice to
1176 * @actor: handles the data splicing
1177 *
1178 * Description:
1179 * This is a special case helper to splice directly between two
1180 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +02001181 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +02001182 * that process.
1183 *
Jens Axboec66ab6f2007-06-12 21:17:17 +02001184 */
1185ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
1186 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +02001187{
1188 struct pipe_inode_info *pipe;
1189 long ret, bytes;
1190 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001191 size_t len;
1192 int i, flags;
Jens Axboeb92ce552006-04-11 13:52:07 +02001193
1194 /*
1195 * We require the input being a regular file, as we don't want to
1196 * randomly drop data for eg socket -> socket splicing. Use the
1197 * piped splicing for that!
1198 */
Al Viro496ad9a2013-01-23 17:07:38 -05001199 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +02001200 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
1201 return -EINVAL;
1202
1203 /*
1204 * neither in nor out is a pipe, setup an internal pipe attached to
1205 * 'out' and transfer the wanted data from 'in' to 'out' through that
1206 */
1207 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +02001208 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -04001209 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +02001210 if (!pipe)
1211 return -ENOMEM;
1212
1213 /*
1214 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +02001215 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +02001216 * PIPE_READERS appropriately.
1217 */
1218 pipe->readers = 1;
1219
1220 current->splice_pipe = pipe;
1221 }
1222
1223 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +02001224 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +02001225 */
1226 ret = 0;
1227 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001228 len = sd->total_len;
1229 flags = sd->flags;
1230
1231 /*
1232 * Don't block on output, we have to drain the direct pipe.
1233 */
1234 sd->flags &= ~SPLICE_F_NONBLOCK;
Jens Axboeb92ce552006-04-11 13:52:07 +02001235
1236 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +02001237 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001238 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001239
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001240 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +02001241 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +02001242 goto out_release;
1243
1244 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001245 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +02001246
1247 /*
1248 * NOTE: nonblocking mode only applies to the input. We
1249 * must not do the output in nonblocking mode as then we
1250 * could get stuck data in the internal pipe:
1251 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001252 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +02001253 if (unlikely(ret <= 0)) {
1254 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001255 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001256 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001257
1258 bytes += ret;
1259 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001260 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001261
Tom Zanussia82c53a2008-05-09 13:28:36 +02001262 if (ret < read_len) {
1263 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001264 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001265 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001266 }
1267
Jens Axboe9e971982008-01-29 21:05:57 +01001268done:
Jens Axboeb92ce552006-04-11 13:52:07 +02001269 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001270 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001271 return bytes;
1272
1273out_release:
1274 /*
1275 * If we did an incomplete transfer we must release
1276 * the pipe buffers in question:
1277 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001278 for (i = 0; i < pipe->buffers; i++) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001279 struct pipe_buffer *buf = pipe->bufs + i;
1280
1281 if (buf->ops) {
1282 buf->ops->release(pipe, buf);
1283 buf->ops = NULL;
1284 }
1285 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001286
Jens Axboe9e971982008-01-29 21:05:57 +01001287 if (!bytes)
1288 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001289
Jens Axboe9e971982008-01-29 21:05:57 +01001290 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001291}
1292EXPORT_SYMBOL(splice_direct_to_actor);
1293
1294static int direct_splice_actor(struct pipe_inode_info *pipe,
1295 struct splice_desc *sd)
1296{
Jens Axboe6a14b902007-06-14 13:08:55 +02001297 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001298
Al Viro7995bd22013-06-20 18:58:36 +04001299 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001300 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001301}
1302
Jens Axboe932cc6d2007-06-21 13:10:21 +02001303/**
1304 * do_splice_direct - splices data directly between two files
1305 * @in: file to splice from
1306 * @ppos: input file offset
1307 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001308 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001309 * @len: number of bytes to splice
1310 * @flags: splice modifier flags
1311 *
1312 * Description:
1313 * For use by do_sendfile(). splice can easily emulate sendfile, but
1314 * doing it in the application would incur an extra system call
1315 * (splice in + splice out, as compared to just sendfile()). So this helper
1316 * can splice directly through a process-private pipe.
1317 *
1318 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001319long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001320 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001321{
1322 struct splice_desc sd = {
1323 .len = len,
1324 .total_len = len,
1325 .flags = flags,
1326 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001327 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001328 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001329 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001330 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001331
1332 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001333 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001334 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001335
Jens Axboec66ab6f2007-06-12 21:17:17 +02001336 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001337}
1338
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001339static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1340 struct pipe_inode_info *opipe,
1341 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001342
1343/*
Jens Axboe83f91352006-04-02 23:05:09 +02001344 * Determine where to splice to/from.
1345 */
Ingo Molnar529565d2006-04-10 15:18:58 +02001346static long do_splice(struct file *in, loff_t __user *off_in,
1347 struct file *out, loff_t __user *off_out,
1348 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001349{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001350 struct pipe_inode_info *ipipe;
1351 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001352 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001353 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001354
Linus Torvalds71993e62010-11-28 13:56:09 -08001355 ipipe = get_pipe_info(in);
1356 opipe = get_pipe_info(out);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001357
1358 if (ipipe && opipe) {
1359 if (off_in || off_out)
1360 return -ESPIPE;
1361
1362 if (!(in->f_mode & FMODE_READ))
1363 return -EBADF;
1364
1365 if (!(out->f_mode & FMODE_WRITE))
1366 return -EBADF;
1367
1368 /* Splicing to self would be fun, but... */
1369 if (ipipe == opipe)
1370 return -EINVAL;
1371
1372 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1373 }
1374
1375 if (ipipe) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001376 if (off_in)
1377 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001378 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001379 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001380 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001381 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001382 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001383 } else {
1384 offset = out->f_pos;
1385 }
Ingo Molnar529565d2006-04-10 15:18:58 +02001386
Al Viro7995bd22013-06-20 18:58:36 +04001387 ret = do_splice_from(ipipe, out, &offset, len, flags);
Jens Axboea4514eb2006-04-19 15:57:05 +02001388
Al Viro7995bd22013-06-20 18:58:36 +04001389 if (!off_out)
1390 out->f_pos = offset;
1391 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001392 ret = -EFAULT;
1393
1394 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001395 }
Jens Axboe5274f052006-03-30 15:15:30 +02001396
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001397 if (opipe) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001398 if (off_out)
1399 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001400 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001401 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001402 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001403 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001404 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001405 } else {
1406 offset = in->f_pos;
1407 }
Ingo Molnar529565d2006-04-10 15:18:58 +02001408
Al Viro7995bd22013-06-20 18:58:36 +04001409 ret = do_splice_to(in, &offset, opipe, len, flags);
Jens Axboea4514eb2006-04-19 15:57:05 +02001410
Al Viro7995bd22013-06-20 18:58:36 +04001411 if (!off_in)
1412 in->f_pos = offset;
1413 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001414 ret = -EFAULT;
1415
1416 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001417 }
Jens Axboe5274f052006-03-30 15:15:30 +02001418
1419 return -EINVAL;
1420}
1421
Jens Axboe912d35f2006-04-26 10:59:21 +02001422/*
1423 * Map an iov into an array of pages and offset/length tupples. With the
1424 * partial_page structure, we can map several non-contiguous ranges into
1425 * our ones pages[] map instead of splitting that operation into pieces.
1426 * Could easily be exported as a generic helper for other users, in which
1427 * case one would probably want to add a 'max_nr_pages' parameter as well.
1428 */
1429static int get_iovec_page_array(const struct iovec __user *iov,
1430 unsigned int nr_vecs, struct page **pages,
Eric Dumazetbd1a68b2012-04-04 11:08:51 +02001431 struct partial_page *partial, bool aligned,
Jens Axboe35f3d142010-05-20 10:43:18 +02001432 unsigned int pipe_buffers)
Jens Axboe912d35f2006-04-26 10:59:21 +02001433{
1434 int buffers = 0, error = 0;
1435
Jens Axboe912d35f2006-04-26 10:59:21 +02001436 while (nr_vecs) {
1437 unsigned long off, npages;
Linus Torvalds75723952007-10-01 13:17:28 -07001438 struct iovec entry;
Jens Axboe912d35f2006-04-26 10:59:21 +02001439 void __user *base;
1440 size_t len;
1441 int i;
1442
Linus Torvalds75723952007-10-01 13:17:28 -07001443 error = -EFAULT;
Nick Pigginbc40d732008-07-25 19:45:26 -07001444 if (copy_from_user(&entry, iov, sizeof(entry)))
Jens Axboe912d35f2006-04-26 10:59:21 +02001445 break;
Linus Torvalds75723952007-10-01 13:17:28 -07001446
1447 base = entry.iov_base;
1448 len = entry.iov_len;
Jens Axboe912d35f2006-04-26 10:59:21 +02001449
1450 /*
1451 * Sanity check this iovec. 0 read succeeds.
1452 */
Linus Torvalds75723952007-10-01 13:17:28 -07001453 error = 0;
Jens Axboe912d35f2006-04-26 10:59:21 +02001454 if (unlikely(!len))
1455 break;
1456 error = -EFAULT;
Bastian Blank712a30e2008-02-10 16:47:57 +02001457 if (!access_ok(VERIFY_READ, base, len))
Jens Axboe912d35f2006-04-26 10:59:21 +02001458 break;
1459
1460 /*
1461 * Get this base offset and number of pages, then map
1462 * in the user pages.
1463 */
1464 off = (unsigned long) base & ~PAGE_MASK;
Jens Axboe7afa6fd2006-05-01 20:02:33 +02001465
1466 /*
1467 * If asked for alignment, the offset must be zero and the
1468 * length a multiple of the PAGE_SIZE.
1469 */
1470 error = -EINVAL;
1471 if (aligned && (off || len & ~PAGE_MASK))
1472 break;
1473
Jens Axboe912d35f2006-04-26 10:59:21 +02001474 npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
Jens Axboe35f3d142010-05-20 10:43:18 +02001475 if (npages > pipe_buffers - buffers)
1476 npages = pipe_buffers - buffers;
Jens Axboe912d35f2006-04-26 10:59:21 +02001477
Nick Pigginbc40d732008-07-25 19:45:26 -07001478 error = get_user_pages_fast((unsigned long)base, npages,
1479 0, &pages[buffers]);
Jens Axboe912d35f2006-04-26 10:59:21 +02001480
1481 if (unlikely(error <= 0))
1482 break;
1483
1484 /*
1485 * Fill this contiguous range into the partial page map.
1486 */
1487 for (i = 0; i < error; i++) {
Jens Axboe75914892006-05-02 12:57:18 +02001488 const int plen = min_t(size_t, len, PAGE_SIZE - off);
Jens Axboe912d35f2006-04-26 10:59:21 +02001489
1490 partial[buffers].offset = off;
1491 partial[buffers].len = plen;
1492
1493 off = 0;
1494 len -= plen;
1495 buffers++;
1496 }
1497
1498 /*
1499 * We didn't complete this iov, stop here since it probably
1500 * means we have to move some of this into a pipe to
1501 * be able to continue.
1502 */
1503 if (len)
1504 break;
1505
1506 /*
1507 * Don't continue if we mapped fewer pages than we asked for,
1508 * or if we mapped the max number of pages that we have
1509 * room for.
1510 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001511 if (error < npages || buffers == pipe_buffers)
Jens Axboe912d35f2006-04-26 10:59:21 +02001512 break;
1513
1514 nr_vecs--;
1515 iov++;
1516 }
1517
Jens Axboe912d35f2006-04-26 10:59:21 +02001518 if (buffers)
1519 return buffers;
1520
1521 return error;
1522}
1523
Jens Axboe6a14b902007-06-14 13:08:55 +02001524static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1525 struct splice_desc *sd)
1526{
1527 char *src;
1528 int ret;
1529
Jens Axboe6a14b902007-06-14 13:08:55 +02001530 /*
1531 * See if we can use the atomic maps, by prefaulting in the
1532 * pages and doing an atomic copy
1533 */
1534 if (!fault_in_pages_writeable(sd->u.userptr, sd->len)) {
1535 src = buf->ops->map(pipe, buf, 1);
1536 ret = __copy_to_user_inatomic(sd->u.userptr, src + buf->offset,
1537 sd->len);
1538 buf->ops->unmap(pipe, buf, src);
1539 if (!ret) {
1540 ret = sd->len;
1541 goto out;
1542 }
1543 }
1544
1545 /*
1546 * No dice, use slow non-atomic map and copy
1547 */
1548 src = buf->ops->map(pipe, buf, 0);
1549
1550 ret = sd->len;
1551 if (copy_to_user(sd->u.userptr, src + buf->offset, sd->len))
1552 ret = -EFAULT;
1553
Jens Axboe6866bef2007-10-16 10:01:29 +02001554 buf->ops->unmap(pipe, buf, src);
Jens Axboe6a14b902007-06-14 13:08:55 +02001555out:
1556 if (ret > 0)
1557 sd->u.userptr += ret;
Jens Axboe6a14b902007-06-14 13:08:55 +02001558 return ret;
1559}
1560
1561/*
1562 * For lack of a better implementation, implement vmsplice() to userspace
1563 * as a simple copy of the pipes pages to the user iov.
1564 */
1565static long vmsplice_to_user(struct file *file, const struct iovec __user *iov,
1566 unsigned long nr_segs, unsigned int flags)
1567{
1568 struct pipe_inode_info *pipe;
1569 struct splice_desc sd;
1570 ssize_t size;
1571 int error;
1572 long ret;
1573
Linus Torvalds71993e62010-11-28 13:56:09 -08001574 pipe = get_pipe_info(file);
Jens Axboe6a14b902007-06-14 13:08:55 +02001575 if (!pipe)
1576 return -EBADF;
1577
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001578 pipe_lock(pipe);
Jens Axboe6a14b902007-06-14 13:08:55 +02001579
1580 error = ret = 0;
1581 while (nr_segs) {
1582 void __user *base;
1583 size_t len;
1584
1585 /*
1586 * Get user address base and length for this iovec.
1587 */
1588 error = get_user(base, &iov->iov_base);
1589 if (unlikely(error))
1590 break;
1591 error = get_user(len, &iov->iov_len);
1592 if (unlikely(error))
1593 break;
1594
1595 /*
1596 * Sanity check this iovec. 0 read succeeds.
1597 */
1598 if (unlikely(!len))
1599 break;
1600 if (unlikely(!base)) {
1601 error = -EFAULT;
1602 break;
1603 }
1604
Jens Axboe88119302008-02-08 08:49:14 -08001605 if (unlikely(!access_ok(VERIFY_WRITE, base, len))) {
1606 error = -EFAULT;
1607 break;
1608 }
1609
Jens Axboe6a14b902007-06-14 13:08:55 +02001610 sd.len = 0;
1611 sd.total_len = len;
1612 sd.flags = flags;
1613 sd.u.userptr = base;
1614 sd.pos = 0;
1615
1616 size = __splice_from_pipe(pipe, &sd, pipe_to_user);
1617 if (size < 0) {
1618 if (!ret)
1619 ret = size;
1620
1621 break;
1622 }
1623
1624 ret += size;
1625
1626 if (size < len)
1627 break;
1628
1629 nr_segs--;
1630 iov++;
1631 }
1632
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001633 pipe_unlock(pipe);
Jens Axboe6a14b902007-06-14 13:08:55 +02001634
1635 if (!ret)
1636 ret = error;
1637
1638 return ret;
1639}
1640
Jens Axboe912d35f2006-04-26 10:59:21 +02001641/*
1642 * vmsplice splices a user address range into a pipe. It can be thought of
1643 * as splice-from-memory, where the regular splice is splice-from-file (or
1644 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001645 */
Jens Axboe6a14b902007-06-14 13:08:55 +02001646static long vmsplice_to_pipe(struct file *file, const struct iovec __user *iov,
1647 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001648{
Jens Axboeddac0d32006-11-04 12:49:32 +01001649 struct pipe_inode_info *pipe;
Jens Axboe35f3d142010-05-20 10:43:18 +02001650 struct page *pages[PIPE_DEF_BUFFERS];
1651 struct partial_page partial[PIPE_DEF_BUFFERS];
Jens Axboe912d35f2006-04-26 10:59:21 +02001652 struct splice_pipe_desc spd = {
1653 .pages = pages,
1654 .partial = partial,
Eric Dumazet047fe362012-06-12 15:24:40 +02001655 .nr_pages_max = PIPE_DEF_BUFFERS,
Jens Axboe912d35f2006-04-26 10:59:21 +02001656 .flags = flags,
1657 .ops = &user_page_pipe_buf_ops,
Jens Axboebbdfc2f2007-11-06 23:29:47 -08001658 .spd_release = spd_release_page,
Jens Axboe912d35f2006-04-26 10:59:21 +02001659 };
Jens Axboe35f3d142010-05-20 10:43:18 +02001660 long ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001661
Linus Torvalds71993e62010-11-28 13:56:09 -08001662 pipe = get_pipe_info(file);
Jens Axboeddac0d32006-11-04 12:49:32 +01001663 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001664 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001665
Jens Axboe35f3d142010-05-20 10:43:18 +02001666 if (splice_grow_spd(pipe, &spd))
1667 return -ENOMEM;
Jens Axboe912d35f2006-04-26 10:59:21 +02001668
Jens Axboe35f3d142010-05-20 10:43:18 +02001669 spd.nr_pages = get_iovec_page_array(iov, nr_segs, spd.pages,
Eric Dumazetbd1a68b2012-04-04 11:08:51 +02001670 spd.partial, false,
Eric Dumazet047fe362012-06-12 15:24:40 +02001671 spd.nr_pages_max);
Jens Axboe35f3d142010-05-20 10:43:18 +02001672 if (spd.nr_pages <= 0)
1673 ret = spd.nr_pages;
1674 else
1675 ret = splice_to_pipe(pipe, &spd);
1676
Eric Dumazet047fe362012-06-12 15:24:40 +02001677 splice_shrink_spd(&spd);
Jens Axboe35f3d142010-05-20 10:43:18 +02001678 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001679}
1680
Jens Axboe6a14b902007-06-14 13:08:55 +02001681/*
1682 * Note that vmsplice only really supports true splicing _from_ user memory
1683 * to a pipe, not the other way around. Splicing from user memory is a simple
1684 * operation that can be supported without any funky alignment restrictions
1685 * or nasty vm tricks. We simply map in the user memory and fill them into
1686 * a pipe. The reverse isn't quite as easy, though. There are two possible
1687 * solutions for that:
1688 *
1689 * - memcpy() the data internally, at which point we might as well just
1690 * do a regular read() on the buffer anyway.
1691 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1692 * has restriction limitations on both ends of the pipe).
1693 *
1694 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1695 *
1696 */
Heiko Carstens836f92a2009-01-14 14:14:33 +01001697SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1698 unsigned long, nr_segs, unsigned int, flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001699{
Al Viro2903ff02012-08-28 12:52:22 -04001700 struct fd f;
Jens Axboe912d35f2006-04-26 10:59:21 +02001701 long error;
Jens Axboe912d35f2006-04-26 10:59:21 +02001702
Jens Axboe6a14b902007-06-14 13:08:55 +02001703 if (unlikely(nr_segs > UIO_MAXIOV))
1704 return -EINVAL;
1705 else if (unlikely(!nr_segs))
1706 return 0;
1707
Jens Axboe912d35f2006-04-26 10:59:21 +02001708 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001709 f = fdget(fd);
1710 if (f.file) {
1711 if (f.file->f_mode & FMODE_WRITE)
1712 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1713 else if (f.file->f_mode & FMODE_READ)
1714 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001715
Al Viro2903ff02012-08-28 12:52:22 -04001716 fdput(f);
Jens Axboe912d35f2006-04-26 10:59:21 +02001717 }
1718
1719 return error;
1720}
1721
Al Viro76b021d2013-03-02 10:19:56 -05001722#ifdef CONFIG_COMPAT
1723COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1724 unsigned int, nr_segs, unsigned int, flags)
1725{
1726 unsigned i;
1727 struct iovec __user *iov;
1728 if (nr_segs > UIO_MAXIOV)
1729 return -EINVAL;
1730 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1731 for (i = 0; i < nr_segs; i++) {
1732 struct compat_iovec v;
1733 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1734 get_user(v.iov_len, &iov32[i].iov_len) ||
1735 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1736 put_user(v.iov_len, &iov[i].iov_len))
1737 return -EFAULT;
1738 }
1739 return sys_vmsplice(fd, iov, nr_segs, flags);
1740}
1741#endif
1742
Heiko Carstens836f92a2009-01-14 14:14:33 +01001743SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1744 int, fd_out, loff_t __user *, off_out,
1745 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001746{
Al Viro2903ff02012-08-28 12:52:22 -04001747 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001748 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001749
1750 if (unlikely(!len))
1751 return 0;
1752
1753 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001754 in = fdget(fd_in);
1755 if (in.file) {
1756 if (in.file->f_mode & FMODE_READ) {
1757 out = fdget(fd_out);
1758 if (out.file) {
1759 if (out.file->f_mode & FMODE_WRITE)
1760 error = do_splice(in.file, off_in,
1761 out.file, off_out,
Ingo Molnar529565d2006-04-10 15:18:58 +02001762 len, flags);
Al Viro2903ff02012-08-28 12:52:22 -04001763 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001764 }
1765 }
Al Viro2903ff02012-08-28 12:52:22 -04001766 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001767 }
Jens Axboe5274f052006-03-30 15:15:30 +02001768 return error;
1769}
Jens Axboe70524492006-04-11 15:51:17 +02001770
1771/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001772 * Make sure there's data to read. Wait for input if we can, otherwise
1773 * return an appropriate error.
1774 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001775static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001776{
1777 int ret;
1778
1779 /*
1780 * Check ->nrbufs without the inode lock first. This function
1781 * is speculative anyways, so missing one is ok.
1782 */
1783 if (pipe->nrbufs)
1784 return 0;
1785
1786 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001787 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001788
1789 while (!pipe->nrbufs) {
1790 if (signal_pending(current)) {
1791 ret = -ERESTARTSYS;
1792 break;
1793 }
1794 if (!pipe->writers)
1795 break;
1796 if (!pipe->waiting_writers) {
1797 if (flags & SPLICE_F_NONBLOCK) {
1798 ret = -EAGAIN;
1799 break;
1800 }
1801 }
1802 pipe_wait(pipe);
1803 }
1804
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001805 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001806 return ret;
1807}
1808
1809/*
1810 * Make sure there's writeable room. Wait for room if we can, otherwise
1811 * return an appropriate error.
1812 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001813static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001814{
1815 int ret;
1816
1817 /*
1818 * Check ->nrbufs without the inode lock first. This function
1819 * is speculative anyways, so missing one is ok.
1820 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001821 if (pipe->nrbufs < pipe->buffers)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001822 return 0;
1823
1824 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001825 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001826
Jens Axboe35f3d142010-05-20 10:43:18 +02001827 while (pipe->nrbufs >= pipe->buffers) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001828 if (!pipe->readers) {
1829 send_sig(SIGPIPE, current, 0);
1830 ret = -EPIPE;
1831 break;
1832 }
1833 if (flags & SPLICE_F_NONBLOCK) {
1834 ret = -EAGAIN;
1835 break;
1836 }
1837 if (signal_pending(current)) {
1838 ret = -ERESTARTSYS;
1839 break;
1840 }
1841 pipe->waiting_writers++;
1842 pipe_wait(pipe);
1843 pipe->waiting_writers--;
1844 }
1845
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001846 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001847 return ret;
1848}
1849
1850/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001851 * Splice contents of ipipe to opipe.
1852 */
1853static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1854 struct pipe_inode_info *opipe,
1855 size_t len, unsigned int flags)
1856{
1857 struct pipe_buffer *ibuf, *obuf;
1858 int ret = 0, nbuf;
1859 bool input_wakeup = false;
1860
1861
1862retry:
1863 ret = ipipe_prep(ipipe, flags);
1864 if (ret)
1865 return ret;
1866
1867 ret = opipe_prep(opipe, flags);
1868 if (ret)
1869 return ret;
1870
1871 /*
1872 * Potential ABBA deadlock, work around it by ordering lock
1873 * grabbing by pipe info address. Otherwise two different processes
1874 * could deadlock (one doing tee from A -> B, the other from B -> A).
1875 */
1876 pipe_double_lock(ipipe, opipe);
1877
1878 do {
1879 if (!opipe->readers) {
1880 send_sig(SIGPIPE, current, 0);
1881 if (!ret)
1882 ret = -EPIPE;
1883 break;
1884 }
1885
1886 if (!ipipe->nrbufs && !ipipe->writers)
1887 break;
1888
1889 /*
1890 * Cannot make any progress, because either the input
1891 * pipe is empty or the output pipe is full.
1892 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001893 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001894 /* Already processed some buffers, break */
1895 if (ret)
1896 break;
1897
1898 if (flags & SPLICE_F_NONBLOCK) {
1899 ret = -EAGAIN;
1900 break;
1901 }
1902
1903 /*
1904 * We raced with another reader/writer and haven't
1905 * managed to process any buffers. A zero return
1906 * value means EOF, so retry instead.
1907 */
1908 pipe_unlock(ipipe);
1909 pipe_unlock(opipe);
1910 goto retry;
1911 }
1912
1913 ibuf = ipipe->bufs + ipipe->curbuf;
Jens Axboe35f3d142010-05-20 10:43:18 +02001914 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001915 obuf = opipe->bufs + nbuf;
1916
1917 if (len >= ibuf->len) {
1918 /*
1919 * Simply move the whole buffer from ipipe to opipe
1920 */
1921 *obuf = *ibuf;
1922 ibuf->ops = NULL;
1923 opipe->nrbufs++;
Jens Axboe35f3d142010-05-20 10:43:18 +02001924 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001925 ipipe->nrbufs--;
1926 input_wakeup = true;
1927 } else {
1928 /*
1929 * Get a reference to this pipe buffer,
1930 * so we can copy the contents over.
1931 */
1932 ibuf->ops->get(ipipe, ibuf);
1933 *obuf = *ibuf;
1934
1935 /*
1936 * Don't inherit the gift flag, we need to
1937 * prevent multiple steals of this page.
1938 */
1939 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1940
1941 obuf->len = len;
1942 opipe->nrbufs++;
1943 ibuf->offset += obuf->len;
1944 ibuf->len -= obuf->len;
1945 }
1946 ret += obuf->len;
1947 len -= obuf->len;
1948 } while (len);
1949
1950 pipe_unlock(ipipe);
1951 pipe_unlock(opipe);
1952
1953 /*
1954 * If we put data in the output pipe, wakeup any potential readers.
1955 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001956 if (ret > 0)
1957 wakeup_pipe_readers(opipe);
1958
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001959 if (input_wakeup)
1960 wakeup_pipe_writers(ipipe);
1961
1962 return ret;
1963}
1964
1965/*
Jens Axboe70524492006-04-11 15:51:17 +02001966 * Link contents of ipipe to opipe.
1967 */
1968static int link_pipe(struct pipe_inode_info *ipipe,
1969 struct pipe_inode_info *opipe,
1970 size_t len, unsigned int flags)
1971{
1972 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001973 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001974
1975 /*
1976 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001977 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001978 * could deadlock (one doing tee from A -> B, the other from B -> A).
1979 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001980 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001981
Jens Axboeaadd06e2006-07-10 11:00:01 +02001982 do {
Jens Axboe70524492006-04-11 15:51:17 +02001983 if (!opipe->readers) {
1984 send_sig(SIGPIPE, current, 0);
1985 if (!ret)
1986 ret = -EPIPE;
1987 break;
1988 }
Jens Axboe70524492006-04-11 15:51:17 +02001989
1990 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001991 * If we have iterated all input buffers or ran out of
1992 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001993 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001994 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
Jens Axboe70524492006-04-11 15:51:17 +02001995 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001996
Jens Axboe35f3d142010-05-20 10:43:18 +02001997 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1998 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001999
Jens Axboe2a27250e2006-04-19 15:56:40 +02002000 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02002001 * Get a reference to this pipe buffer,
2002 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02002003 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02002004 ibuf->ops->get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02002005
Jens Axboeaadd06e2006-07-10 11:00:01 +02002006 obuf = opipe->bufs + nbuf;
2007 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02002008
Jens Axboeaadd06e2006-07-10 11:00:01 +02002009 /*
2010 * Don't inherit the gift flag, we need to
2011 * prevent multiple steals of this page.
2012 */
2013 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
2014
2015 if (obuf->len > len)
2016 obuf->len = len;
2017
2018 opipe->nrbufs++;
2019 ret += obuf->len;
2020 len -= obuf->len;
2021 i++;
2022 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02002023
Jens Axboe02cf01a2008-02-20 10:34:51 +01002024 /*
2025 * return EAGAIN if we have the potential of some data in the
2026 * future, otherwise just return 0
2027 */
2028 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
2029 ret = -EAGAIN;
2030
Miklos Szeredi61e0d472009-04-14 19:48:41 +02002031 pipe_unlock(ipipe);
2032 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02002033
Jens Axboeaadd06e2006-07-10 11:00:01 +02002034 /*
2035 * If we put data in the output pipe, wakeup any potential readers.
2036 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02002037 if (ret > 0)
2038 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02002039
2040 return ret;
2041}
2042
2043/*
2044 * This is a tee(1) implementation that works on pipes. It doesn't copy
2045 * any data, it simply references the 'in' pages on the 'out' pipe.
2046 * The 'flags' used are the SPLICE_F_* variants, currently the only
2047 * applicable one is SPLICE_F_NONBLOCK.
2048 */
2049static long do_tee(struct file *in, struct file *out, size_t len,
2050 unsigned int flags)
2051{
Linus Torvalds71993e62010-11-28 13:56:09 -08002052 struct pipe_inode_info *ipipe = get_pipe_info(in);
2053 struct pipe_inode_info *opipe = get_pipe_info(out);
Jens Axboeaadd06e2006-07-10 11:00:01 +02002054 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02002055
2056 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02002057 * Duplicate the contents of ipipe to opipe without actually
2058 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02002059 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02002060 if (ipipe && opipe && ipipe != opipe) {
2061 /*
2062 * Keep going, unless we encounter an error. The ipipe/opipe
2063 * ordering doesn't really matter.
2064 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02002065 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02002066 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02002067 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01002068 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02002069 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02002070 }
2071 }
Jens Axboe70524492006-04-11 15:51:17 +02002072
Jens Axboeaadd06e2006-07-10 11:00:01 +02002073 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02002074}
2075
Heiko Carstens836f92a2009-01-14 14:14:33 +01002076SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02002077{
Al Viro2903ff02012-08-28 12:52:22 -04002078 struct fd in;
2079 int error;
Jens Axboe70524492006-04-11 15:51:17 +02002080
2081 if (unlikely(!len))
2082 return 0;
2083
2084 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04002085 in = fdget(fdin);
2086 if (in.file) {
2087 if (in.file->f_mode & FMODE_READ) {
2088 struct fd out = fdget(fdout);
2089 if (out.file) {
2090 if (out.file->f_mode & FMODE_WRITE)
2091 error = do_tee(in.file, out.file,
2092 len, flags);
2093 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02002094 }
2095 }
Al Viro2903ff02012-08-28 12:52:22 -04002096 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02002097 }
2098
2099 return error;
2100}