blob: 2365ab073a2708982ba3eb74a008039aff67687f [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 */
Christoph Hellwigbe297962016-11-01 07:40:16 -060020#include <linux/bvec.h>
Jens Axboe5274f052006-03-30 15:15:30 +020021#include <linux/fs.h>
22#include <linux/file.h>
23#include <linux/pagemap.h>
Jens Axboed6b29d72007-06-04 09:59:47 +020024#include <linux/splice.h>
KAMEZAWA Hiroyuki08e552c2009-01-07 18:08:01 -080025#include <linux/memcontrol.h>
Jens Axboe5274f052006-03-30 15:15:30 +020026#include <linux/mm_inline.h>
Jens Axboe5abc97a2006-03-30 15:16:46 +020027#include <linux/swap.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020028#include <linux/writeback.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050029#include <linux/export.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020030#include <linux/syscalls.h>
Jens Axboe912d35f2006-04-26 10:59:21 +020031#include <linux/uio.h>
James Morris29ce2052007-07-13 11:44:32 +020032#include <linux/security.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090033#include <linux/gfp.h>
Eric Dumazet35f9c092012-04-05 03:05:35 +000034#include <linux/socket.h>
Al Viro76b021d2013-03-02 10:19:56 -050035#include <linux/compat.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010036#include <linux/sched/signal.h>
37
Al Viro06ae43f2013-03-20 13:19:30 -040038#include "internal.h"
Jens Axboe5274f052006-03-30 15:15:30 +020039
Jens Axboe83f91352006-04-02 23:05:09 +020040/*
41 * Attempt to steal a page from a pipe buffer. This should perhaps go into
42 * a vm helper function, it's already simplified quite a bit by the
43 * addition of remove_mapping(). If success is returned, the caller may
44 * attempt to reuse this page for another destination.
45 */
Jens Axboe76ad4d12006-05-03 10:41:33 +020046static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
Jens Axboe5abc97a2006-03-30 15:16:46 +020047 struct pipe_buffer *buf)
48{
49 struct page *page = buf->page;
Jens Axboe9e94cd42006-06-20 15:01:12 +020050 struct address_space *mapping;
Jens Axboe5abc97a2006-03-30 15:16:46 +020051
Jens Axboe9e0267c2006-04-19 15:57:31 +020052 lock_page(page);
53
Jens Axboe9e94cd42006-06-20 15:01:12 +020054 mapping = page_mapping(page);
55 if (mapping) {
56 WARN_ON(!PageUptodate(page));
Jens Axboe5abc97a2006-03-30 15:16:46 +020057
Jens Axboe9e94cd42006-06-20 15:01:12 +020058 /*
59 * At least for ext2 with nobh option, we need to wait on
60 * writeback completing on this page, since we'll remove it
61 * from the pagecache. Otherwise truncate wont wait on the
62 * page, allowing the disk blocks to be reused by someone else
63 * before we actually wrote our data to them. fs corruption
64 * ensues.
65 */
66 wait_on_page_writeback(page);
Jens Axboead8d6f02006-04-02 23:10:32 +020067
David Howells266cf652009-04-03 16:42:36 +010068 if (page_has_private(page) &&
69 !try_to_release_page(page, GFP_KERNEL))
Jens Axboeca39d652008-05-20 21:27:41 +020070 goto out_unlock;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020071
Jens Axboe9e94cd42006-06-20 15:01:12 +020072 /*
73 * If we succeeded in removing the mapping, set LRU flag
74 * and return good.
75 */
76 if (remove_mapping(mapping, page)) {
77 buf->flags |= PIPE_BUF_FLAG_LRU;
78 return 0;
79 }
Jens Axboe9e0267c2006-04-19 15:57:31 +020080 }
Jens Axboe5abc97a2006-03-30 15:16:46 +020081
Jens Axboe9e94cd42006-06-20 15:01:12 +020082 /*
83 * Raced with truncate or failed to remove page from current
84 * address space, unlock and return failure.
85 */
Jens Axboeca39d652008-05-20 21:27:41 +020086out_unlock:
Jens Axboe9e94cd42006-06-20 15:01:12 +020087 unlock_page(page);
88 return 1;
Jens Axboe5abc97a2006-03-30 15:16:46 +020089}
90
Jens Axboe76ad4d12006-05-03 10:41:33 +020091static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +020092 struct pipe_buffer *buf)
93{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030094 put_page(buf->page);
Jens Axboe14328732006-05-03 10:35:26 +020095 buf->flags &= ~PIPE_BUF_FLAG_LRU;
Jens Axboe5274f052006-03-30 15:15:30 +020096}
97
Jens Axboe08457182007-06-12 20:51:32 +020098/*
99 * Check whether the contents of buf is OK to access. Since the content
100 * is a page cache page, IO may be in flight.
101 */
Jens Axboecac36bb02007-06-14 13:10:48 +0200102static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
103 struct pipe_buffer *buf)
Jens Axboe5274f052006-03-30 15:15:30 +0200104{
105 struct page *page = buf->page;
Jens Axboe49d0b212006-04-10 09:04:41 +0200106 int err;
Jens Axboe5274f052006-03-30 15:15:30 +0200107
108 if (!PageUptodate(page)) {
Jens Axboe49d0b212006-04-10 09:04:41 +0200109 lock_page(page);
110
111 /*
112 * Page got truncated/unhashed. This will cause a 0-byte
Ingo Molnar73d62d82006-04-11 13:57:21 +0200113 * splice, if this is the first page.
Jens Axboe49d0b212006-04-10 09:04:41 +0200114 */
115 if (!page->mapping) {
116 err = -ENODATA;
117 goto error;
118 }
119
120 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200121 * Uh oh, read-error from disk.
Jens Axboe49d0b212006-04-10 09:04:41 +0200122 */
123 if (!PageUptodate(page)) {
124 err = -EIO;
125 goto error;
126 }
127
128 /*
Jens Axboef84d7512006-05-01 19:59:03 +0200129 * Page is ok afterall, we are done.
Jens Axboe49d0b212006-04-10 09:04:41 +0200130 */
Jens Axboe5274f052006-03-30 15:15:30 +0200131 unlock_page(page);
Jens Axboe5274f052006-03-30 15:15:30 +0200132 }
133
Jens Axboef84d7512006-05-01 19:59:03 +0200134 return 0;
Jens Axboe49d0b212006-04-10 09:04:41 +0200135error:
136 unlock_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200137 return err;
Jens Axboe70524492006-04-11 15:51:17 +0200138}
139
Hugh Dickins708e3502011-07-25 17:12:32 -0700140const struct pipe_buf_operations page_cache_pipe_buf_ops = {
Jens Axboe5274f052006-03-30 15:15:30 +0200141 .can_merge = 0,
Jens Axboecac36bb02007-06-14 13:10:48 +0200142 .confirm = page_cache_pipe_buf_confirm,
Jens Axboe5274f052006-03-30 15:15:30 +0200143 .release = page_cache_pipe_buf_release,
Jens Axboe5abc97a2006-03-30 15:16:46 +0200144 .steal = page_cache_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200145 .get = generic_pipe_buf_get,
Jens Axboe5274f052006-03-30 15:15:30 +0200146};
147
Jens Axboe912d35f2006-04-26 10:59:21 +0200148static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
149 struct pipe_buffer *buf)
150{
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200151 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
152 return 1;
153
Jens Axboe14328732006-05-03 10:35:26 +0200154 buf->flags |= PIPE_BUF_FLAG_LRU;
Jens Axboe330ab712006-05-02 15:29:57 +0200155 return generic_pipe_buf_steal(pipe, buf);
Jens Axboe912d35f2006-04-26 10:59:21 +0200156}
157
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800158static const struct pipe_buf_operations user_page_pipe_buf_ops = {
Jens Axboe912d35f2006-04-26 10:59:21 +0200159 .can_merge = 0,
Jens Axboecac36bb02007-06-14 13:10:48 +0200160 .confirm = generic_pipe_buf_confirm,
Jens Axboe912d35f2006-04-26 10:59:21 +0200161 .release = page_cache_pipe_buf_release,
162 .steal = user_page_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200163 .get = generic_pipe_buf_get,
Jens Axboe912d35f2006-04-26 10:59:21 +0200164};
165
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200166static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
167{
168 smp_mb();
169 if (waitqueue_active(&pipe->wait))
170 wake_up_interruptible(&pipe->wait);
171 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
172}
173
Jens Axboe932cc6d2007-06-21 13:10:21 +0200174/**
175 * splice_to_pipe - fill passed data into a pipe
176 * @pipe: pipe to fill
177 * @spd: data to fill
178 *
179 * Description:
Randy Dunlap79685b82007-07-27 08:08:51 +0200180 * @spd contains a map of pages and len/offset tuples, along with
Jens Axboe932cc6d2007-06-21 13:10:21 +0200181 * the struct pipe_buf_operations associated with these pages. This
182 * function will link that data to the pipe.
183 *
Jens Axboe83f91352006-04-02 23:05:09 +0200184 */
Jens Axboed6b29d72007-06-04 09:59:47 +0200185ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
186 struct splice_pipe_desc *spd)
Jens Axboe5274f052006-03-30 15:15:30 +0200187{
Jens Axboe00de00b2007-06-15 13:14:22 +0200188 unsigned int spd_pages = spd->nr_pages;
Al Viro8924fef2016-09-17 20:44:45 -0400189 int ret = 0, page_nr = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200190
Rabin Vincentd6785d92016-03-10 21:19:06 +0100191 if (!spd_pages)
192 return 0;
193
Al Viro8924fef2016-09-17 20:44:45 -0400194 if (unlikely(!pipe->readers)) {
195 send_sig(SIGPIPE, current, 0);
196 ret = -EPIPE;
197 goto out;
Jens Axboe5274f052006-03-30 15:15:30 +0200198 }
199
Al Viro8924fef2016-09-17 20:44:45 -0400200 while (pipe->nrbufs < pipe->buffers) {
201 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
202 struct pipe_buffer *buf = pipe->bufs + newbuf;
Jens Axboe5274f052006-03-30 15:15:30 +0200203
Al Viro8924fef2016-09-17 20:44:45 -0400204 buf->page = spd->pages[page_nr];
205 buf->offset = spd->partial[page_nr].offset;
206 buf->len = spd->partial[page_nr].len;
207 buf->private = spd->partial[page_nr].private;
208 buf->ops = spd->ops;
Miklos Szeredi5a81e6a2017-02-16 17:49:02 +0100209 buf->flags = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200210
Al Viro8924fef2016-09-17 20:44:45 -0400211 pipe->nrbufs++;
212 page_nr++;
213 ret += buf->len;
214
215 if (!--spd->nr_pages)
216 break;
217 }
218
219 if (!ret)
220 ret = -EAGAIN;
221
222out:
Jens Axboe00de00b2007-06-15 13:14:22 +0200223 while (page_nr < spd_pages)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800224 spd->spd_release(spd, page_nr++);
Jens Axboe5274f052006-03-30 15:15:30 +0200225
226 return ret;
227}
Hannes Frederic Sowa2b514572015-05-21 17:00:01 +0200228EXPORT_SYMBOL_GPL(splice_to_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200229
Al Viro79fddc42016-09-17 22:38:20 -0400230ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
231{
232 int ret;
233
234 if (unlikely(!pipe->readers)) {
235 send_sig(SIGPIPE, current, 0);
236 ret = -EPIPE;
237 } else if (pipe->nrbufs == pipe->buffers) {
238 ret = -EAGAIN;
239 } else {
240 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
241 pipe->bufs[newbuf] = *buf;
242 pipe->nrbufs++;
243 return buf->len;
244 }
Miklos Szeredia7796382016-09-27 10:45:12 +0200245 pipe_buf_release(pipe, buf);
Al Viro79fddc42016-09-17 22:38:20 -0400246 return ret;
247}
248EXPORT_SYMBOL(add_to_pipe);
249
Jens Axboe35f3d142010-05-20 10:43:18 +0200250/*
251 * Check if we need to grow the arrays holding pages and partial page
252 * descriptions.
253 */
Eric Dumazet047fe362012-06-12 15:24:40 +0200254int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200255{
Mark Rutland6aa7de02017-10-23 14:07:29 -0700256 unsigned int buffers = READ_ONCE(pipe->buffers);
Eric Dumazet047fe362012-06-12 15:24:40 +0200257
258 spd->nr_pages_max = buffers;
259 if (buffers <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200260 return 0;
261
Kees Cook6da2ec52018-06-12 13:55:00 -0700262 spd->pages = kmalloc_array(buffers, sizeof(struct page *), GFP_KERNEL);
263 spd->partial = kmalloc_array(buffers, sizeof(struct partial_page),
264 GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200265
266 if (spd->pages && spd->partial)
267 return 0;
268
269 kfree(spd->pages);
270 kfree(spd->partial);
271 return -ENOMEM;
272}
273
Eric Dumazet047fe362012-06-12 15:24:40 +0200274void splice_shrink_spd(struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200275{
Eric Dumazet047fe362012-06-12 15:24:40 +0200276 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200277 return;
278
279 kfree(spd->pages);
280 kfree(spd->partial);
281}
282
Jens Axboe83f91352006-04-02 23:05:09 +0200283/**
284 * generic_file_splice_read - splice data from file to a pipe
285 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200286 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200287 * @pipe: pipe to splice to
288 * @len: number of bytes to splice
289 * @flags: splice modifier flags
290 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200291 * Description:
292 * Will read pages from given file and fill them into a pipe. Can be
Al Viro82c156f2016-09-22 23:35:42 -0400293 * used as long as it has more or less sane ->read_iter().
Jens Axboe932cc6d2007-06-21 13:10:21 +0200294 *
Jens Axboe83f91352006-04-02 23:05:09 +0200295 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200296ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
297 struct pipe_inode_info *pipe, size_t len,
298 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200299{
Al Viro82c156f2016-09-22 23:35:42 -0400300 struct iov_iter to;
301 struct kiocb kiocb;
Al Viro82c156f2016-09-22 23:35:42 -0400302 int idx, ret;
Boaz Harroshbe64f882015-04-15 16:15:17 -0700303
Al Viro82c156f2016-09-22 23:35:42 -0400304 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len);
305 idx = to.idx;
306 init_sync_kiocb(&kiocb, in);
307 kiocb.ki_pos = *ppos;
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100308 ret = call_read_iter(in, &kiocb, &to);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200309 if (ret > 0) {
Al Viro82c156f2016-09-22 23:35:42 -0400310 *ppos = kiocb.ki_pos;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200311 file_accessed(in);
Al Viro82c156f2016-09-22 23:35:42 -0400312 } else if (ret < 0) {
Al Viroc3a69022016-10-10 13:26:27 -0400313 to.idx = idx;
314 to.iov_offset = 0;
315 iov_iter_advance(&to, 0); /* to free what was emitted */
Al Viro82c156f2016-09-22 23:35:42 -0400316 /*
317 * callers of ->splice_read() expect -EAGAIN on
318 * "can't put anything in there", rather than -EFAULT.
319 */
320 if (ret == -EFAULT)
321 ret = -EAGAIN;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200322 }
Jens Axboe5274f052006-03-30 15:15:30 +0200323
324 return ret;
325}
Jens Axboe059a8f32006-04-02 23:06:05 +0200326EXPORT_SYMBOL(generic_file_splice_read);
327
Al Viro241699c2016-09-22 16:33:12 -0400328const struct pipe_buf_operations default_pipe_buf_ops = {
Miklos Szeredi68181732009-05-07 15:37:36 +0200329 .can_merge = 0,
Miklos Szeredi68181732009-05-07 15:37:36 +0200330 .confirm = generic_pipe_buf_confirm,
331 .release = generic_pipe_buf_release,
332 .steal = generic_pipe_buf_steal,
333 .get = generic_pipe_buf_get,
334};
335
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100336static int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
337 struct pipe_buffer *buf)
338{
339 return 1;
340}
341
342/* Pipe buffer operations for a socket and similar. */
343const struct pipe_buf_operations nosteal_pipe_buf_ops = {
344 .can_merge = 0,
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100345 .confirm = generic_pipe_buf_confirm,
346 .release = generic_pipe_buf_release,
347 .steal = generic_pipe_buf_nosteal,
348 .get = generic_pipe_buf_get,
349};
350EXPORT_SYMBOL(nosteal_pipe_buf_ops);
351
Al Viro523ac9a2016-09-23 15:34:57 -0400352static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
Miklos Szeredi68181732009-05-07 15:37:36 +0200353 unsigned long vlen, loff_t offset)
354{
355 mm_segment_t old_fs;
356 loff_t pos = offset;
357 ssize_t res;
358
359 old_fs = get_fs();
360 set_fs(get_ds());
361 /* The cast to a user pointer is valid due to the set_fs() */
Christoph Hellwig793b80e2016-03-03 16:03:58 +0100362 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
Miklos Szeredi68181732009-05-07 15:37:36 +0200363 set_fs(old_fs);
364
365 return res;
366}
367
Al Viro82c156f2016-09-22 23:35:42 -0400368static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
Miklos Szeredi68181732009-05-07 15:37:36 +0200369 struct pipe_inode_info *pipe, size_t len,
370 unsigned int flags)
371{
Al Viro523ac9a2016-09-23 15:34:57 -0400372 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
373 struct iov_iter to;
374 struct page **pages;
Miklos Szeredi68181732009-05-07 15:37:36 +0200375 unsigned int nr_pages;
Al Viro13c0f522016-12-10 13:20:53 -0500376 size_t offset, base, copied = 0;
Miklos Szeredi68181732009-05-07 15:37:36 +0200377 ssize_t res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200378 int i;
Miklos Szeredi68181732009-05-07 15:37:36 +0200379
Al Viro523ac9a2016-09-23 15:34:57 -0400380 if (pipe->nrbufs == pipe->buffers)
381 return -EAGAIN;
382
383 /*
384 * Try to keep page boundaries matching to source pagecache ones -
385 * it probably won't be much help, but...
386 */
387 offset = *ppos & ~PAGE_MASK;
388
389 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
390
Al Viro13c0f522016-12-10 13:20:53 -0500391 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &base);
Al Viro523ac9a2016-09-23 15:34:57 -0400392 if (res <= 0)
Jens Axboe35f3d142010-05-20 10:43:18 +0200393 return -ENOMEM;
394
Al Viro13c0f522016-12-10 13:20:53 -0500395 nr_pages = DIV_ROUND_UP(res + base, PAGE_SIZE);
Al Viro523ac9a2016-09-23 15:34:57 -0400396
Jens Axboe35f3d142010-05-20 10:43:18 +0200397 vec = __vec;
Al Viro523ac9a2016-09-23 15:34:57 -0400398 if (nr_pages > PIPE_DEF_BUFFERS) {
Kees Cook6da2ec52018-06-12 13:55:00 -0700399 vec = kmalloc_array(nr_pages, sizeof(struct kvec), GFP_KERNEL);
Al Viro523ac9a2016-09-23 15:34:57 -0400400 if (unlikely(!vec)) {
401 res = -ENOMEM;
402 goto out;
403 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200404 }
405
Al Viro523ac9a2016-09-23 15:34:57 -0400406 pipe->bufs[to.idx].offset = offset;
407 pipe->bufs[to.idx].len -= offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200408
Al Viro523ac9a2016-09-23 15:34:57 -0400409 for (i = 0; i < nr_pages; i++) {
410 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
411 vec[i].iov_base = page_address(pages[i]) + offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200412 vec[i].iov_len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200413 len -= this_len;
414 offset = 0;
415 }
416
Al Viro523ac9a2016-09-23 15:34:57 -0400417 res = kernel_readv(in, vec, nr_pages, *ppos);
418 if (res > 0) {
419 copied = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200420 *ppos += res;
Al Viro523ac9a2016-09-23 15:34:57 -0400421 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200422
Jens Axboe35f3d142010-05-20 10:43:18 +0200423 if (vec != __vec)
424 kfree(vec);
Al Viro523ac9a2016-09-23 15:34:57 -0400425out:
426 for (i = 0; i < nr_pages; i++)
427 put_page(pages[i]);
428 kvfree(pages);
429 iov_iter_advance(&to, copied); /* truncates and discards */
Miklos Szeredi68181732009-05-07 15:37:36 +0200430 return res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200431}
Miklos Szeredi68181732009-05-07 15:37:36 +0200432
Jens Axboe5274f052006-03-30 15:15:30 +0200433/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200434 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200435 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200436 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200437static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200438 struct pipe_buffer *buf, struct splice_desc *sd)
439{
Jens Axboe6a14b902007-06-14 13:08:55 +0200440 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200441 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100442 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200443
Al Viro72c2d532013-09-22 16:27:52 -0400444 if (!likely(file->f_op->sendpage))
Michał Mirosława8adbe32010-12-17 08:56:44 +0100445 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200446
Eric Dumazet35f9c092012-04-05 03:05:35 +0000447 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000448
449 if (sd->len < sd->total_len && pipe->nrbufs > 1)
Eric Dumazet35f9c092012-04-05 03:05:35 +0000450 more |= MSG_SENDPAGE_NOTLAST;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000451
Michał Mirosława8adbe32010-12-17 08:56:44 +0100452 return file->f_op->sendpage(file, buf->page, buf->offset,
453 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200454}
455
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200456static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
457{
458 smp_mb();
459 if (waitqueue_active(&pipe->wait))
460 wake_up_interruptible(&pipe->wait);
461 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
462}
463
464/**
465 * splice_from_pipe_feed - feed available data from a pipe to a file
466 * @pipe: pipe to splice from
467 * @sd: information to @actor
468 * @actor: handler that splices the data
469 *
470 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200471 * This function loops over the pipe and calls @actor to do the
472 * actual moving of a single struct pipe_buffer to the desired
473 * destination. It returns when there's no more buffers left in
474 * the pipe or if the requested number of bytes (@sd->total_len)
475 * have been copied. It returns a positive number (one) if the
476 * pipe needs to be filled with more data, zero if the required
477 * number of bytes have been copied and -errno on error.
478 *
479 * This, together with splice_from_pipe_{begin,end,next}, may be
480 * used to implement the functionality of __splice_from_pipe() when
481 * locking is required around copying the pipe buffers to the
482 * destination.
483 */
Al Viro96f9bc82014-04-05 04:35:49 -0400484static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200485 splice_actor *actor)
486{
487 int ret;
488
489 while (pipe->nrbufs) {
490 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200491
492 sd->len = buf->len;
493 if (sd->len > sd->total_len)
494 sd->len = sd->total_len;
495
Miklos Szeredifba597d2016-09-27 10:45:12 +0200496 ret = pipe_buf_confirm(pipe, buf);
Michał Mirosława8adbe32010-12-17 08:56:44 +0100497 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200498 if (ret == -ENODATA)
499 ret = 0;
500 return ret;
501 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100502
503 ret = actor(pipe, buf, sd);
504 if (ret <= 0)
505 return ret;
506
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200507 buf->offset += ret;
508 buf->len -= ret;
509
510 sd->num_spliced += ret;
511 sd->len -= ret;
512 sd->pos += ret;
513 sd->total_len -= ret;
514
515 if (!buf->len) {
Miklos Szeredia7796382016-09-27 10:45:12 +0200516 pipe_buf_release(pipe, buf);
Jens Axboe35f3d142010-05-20 10:43:18 +0200517 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200518 pipe->nrbufs--;
Al Viro6447a3c2013-03-21 11:01:38 -0400519 if (pipe->files)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200520 sd->need_wakeup = true;
521 }
522
523 if (!sd->total_len)
524 return 0;
525 }
526
527 return 1;
528}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200529
530/**
531 * splice_from_pipe_next - wait for some data to splice from
532 * @pipe: pipe to splice from
533 * @sd: information about the splice operation
534 *
535 * Description:
536 * This function will wait for some data and return a positive
537 * value (one) if pipe buffers are available. It will return zero
538 * or -errno if no more data needs to be spliced.
539 */
Al Viro96f9bc82014-04-05 04:35:49 -0400540static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200541{
Jan Karac725bfc2015-11-23 13:09:50 +0100542 /*
543 * Check for signal early to make process killable when there are
544 * always buffers available
545 */
546 if (signal_pending(current))
547 return -ERESTARTSYS;
548
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200549 while (!pipe->nrbufs) {
550 if (!pipe->writers)
551 return 0;
552
553 if (!pipe->waiting_writers && sd->num_spliced)
554 return 0;
555
556 if (sd->flags & SPLICE_F_NONBLOCK)
557 return -EAGAIN;
558
559 if (signal_pending(current))
560 return -ERESTARTSYS;
561
562 if (sd->need_wakeup) {
563 wakeup_pipe_writers(pipe);
564 sd->need_wakeup = false;
565 }
566
567 pipe_wait(pipe);
568 }
569
570 return 1;
571}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200572
573/**
574 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700575 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200576 *
577 * Description:
578 * This function should be called before a loop containing
579 * splice_from_pipe_next() and splice_from_pipe_feed() to
580 * initialize the necessary fields of @sd.
581 */
Al Viro96f9bc82014-04-05 04:35:49 -0400582static void splice_from_pipe_begin(struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200583{
584 sd->num_spliced = 0;
585 sd->need_wakeup = false;
586}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200587
588/**
589 * splice_from_pipe_end - finish splicing from pipe
590 * @pipe: pipe to splice from
591 * @sd: information about the splice operation
592 *
593 * Description:
594 * This function will wake up pipe writers if necessary. It should
595 * be called after a loop containing splice_from_pipe_next() and
596 * splice_from_pipe_feed().
597 */
Al Viro96f9bc82014-04-05 04:35:49 -0400598static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200599{
600 if (sd->need_wakeup)
601 wakeup_pipe_writers(pipe);
602}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200603
Jens Axboe932cc6d2007-06-21 13:10:21 +0200604/**
605 * __splice_from_pipe - splice data from a pipe to given actor
606 * @pipe: pipe to splice from
607 * @sd: information to @actor
608 * @actor: handler that splices the data
609 *
610 * Description:
611 * This function does little more than loop over the pipe and call
612 * @actor to do the actual moving of a single struct pipe_buffer to
613 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
614 * pipe_to_user.
615 *
Jens Axboe83f91352006-04-02 23:05:09 +0200616 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200617ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
618 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200619{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200620 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200621
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200622 splice_from_pipe_begin(sd);
623 do {
Jan Karac2489e02015-11-23 13:09:51 +0100624 cond_resched();
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200625 ret = splice_from_pipe_next(pipe, sd);
626 if (ret > 0)
627 ret = splice_from_pipe_feed(pipe, sd, actor);
628 } while (ret > 0);
629 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200630
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200631 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200632}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100633EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200634
Jens Axboe932cc6d2007-06-21 13:10:21 +0200635/**
636 * splice_from_pipe - splice data from a pipe to a file
637 * @pipe: pipe to splice from
638 * @out: file to splice to
639 * @ppos: position in @out
640 * @len: how many bytes to splice
641 * @flags: splice modifier flags
642 * @actor: handler that splices the data
643 *
644 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200645 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200646 * otherwise it's identical to __splice_from_pipe().
647 *
648 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200649ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
650 loff_t *ppos, size_t len, unsigned int flags,
651 splice_actor *actor)
652{
653 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200654 struct splice_desc sd = {
655 .total_len = len,
656 .flags = flags,
657 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200658 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200659 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200660
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200661 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200662 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200663 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200664
665 return ret;
666}
667
668/**
Al Viro8d020762014-04-05 04:27:08 -0400669 * iter_file_splice_write - splice data from a pipe to a file
670 * @pipe: pipe info
671 * @out: file to write to
672 * @ppos: position in @out
673 * @len: number of bytes to splice
674 * @flags: splice modifier flags
675 *
676 * Description:
677 * Will either move or copy pages (determined by @flags options) from
678 * the given pipe inode to the given file.
679 * This one is ->write_iter-based.
680 *
681 */
682ssize_t
683iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
684 loff_t *ppos, size_t len, unsigned int flags)
685{
686 struct splice_desc sd = {
687 .total_len = len,
688 .flags = flags,
689 .pos = *ppos,
690 .u.file = out,
691 };
692 int nbufs = pipe->buffers;
693 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
694 GFP_KERNEL);
695 ssize_t ret;
696
697 if (unlikely(!array))
698 return -ENOMEM;
699
700 pipe_lock(pipe);
701
702 splice_from_pipe_begin(&sd);
703 while (sd.total_len) {
704 struct iov_iter from;
Al Viro8d020762014-04-05 04:27:08 -0400705 size_t left;
706 int n, idx;
707
708 ret = splice_from_pipe_next(pipe, &sd);
709 if (ret <= 0)
710 break;
711
712 if (unlikely(nbufs < pipe->buffers)) {
713 kfree(array);
714 nbufs = pipe->buffers;
715 array = kcalloc(nbufs, sizeof(struct bio_vec),
716 GFP_KERNEL);
717 if (!array) {
718 ret = -ENOMEM;
719 break;
720 }
721 }
722
723 /* build the vector */
724 left = sd.total_len;
725 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
726 struct pipe_buffer *buf = pipe->bufs + idx;
727 size_t this_len = buf->len;
728
729 if (this_len > left)
730 this_len = left;
731
732 if (idx == pipe->buffers - 1)
733 idx = -1;
734
Miklos Szeredifba597d2016-09-27 10:45:12 +0200735 ret = pipe_buf_confirm(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400736 if (unlikely(ret)) {
737 if (ret == -ENODATA)
738 ret = 0;
739 goto done;
740 }
741
742 array[n].bv_page = buf->page;
743 array[n].bv_len = this_len;
744 array[n].bv_offset = buf->offset;
745 left -= this_len;
746 }
747
Al Viro05afcb72015-01-23 01:08:07 -0500748 iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
749 sd.total_len - left);
Christoph Hellwigabbb65892017-05-27 11:16:52 +0300750 ret = vfs_iter_write(out, &from, &sd.pos, 0);
Al Viro8d020762014-04-05 04:27:08 -0400751 if (ret <= 0)
752 break;
753
754 sd.num_spliced += ret;
755 sd.total_len -= ret;
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100756 *ppos = sd.pos;
Al Viro8d020762014-04-05 04:27:08 -0400757
758 /* dismiss the fully eaten buffers, adjust the partial one */
759 while (ret) {
760 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
761 if (ret >= buf->len) {
Al Viro8d020762014-04-05 04:27:08 -0400762 ret -= buf->len;
763 buf->len = 0;
Miklos Szeredia7796382016-09-27 10:45:12 +0200764 pipe_buf_release(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400765 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
766 pipe->nrbufs--;
767 if (pipe->files)
768 sd.need_wakeup = true;
769 } else {
770 buf->offset += ret;
771 buf->len -= ret;
772 ret = 0;
773 }
774 }
775 }
776done:
777 kfree(array);
778 splice_from_pipe_end(pipe, &sd);
779
780 pipe_unlock(pipe);
781
782 if (sd.num_spliced)
783 ret = sd.num_spliced;
784
785 return ret;
786}
787
788EXPORT_SYMBOL(iter_file_splice_write);
789
Miklos Szeredib2858d72009-05-19 11:37:46 +0200790static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
791 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200792{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200793 int ret;
794 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -0400795 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +0200796
Al Virofbb32752014-02-02 21:09:54 -0500797 data = kmap(buf->page);
Al Viro06ae43f2013-03-20 13:19:30 -0400798 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Al Virofbb32752014-02-02 21:09:54 -0500799 kunmap(buf->page);
Miklos Szeredib2858d72009-05-19 11:37:46 +0200800
801 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200802}
803
804static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
805 struct file *out, loff_t *ppos,
806 size_t len, unsigned int flags)
807{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200808 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200809
Miklos Szeredib2858d72009-05-19 11:37:46 +0200810 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
811 if (ret > 0)
812 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200813
Miklos Szeredib2858d72009-05-19 11:37:46 +0200814 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200815}
816
Jens Axboe83f91352006-04-02 23:05:09 +0200817/**
818 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200819 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200820 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200821 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200822 * @len: number of bytes to splice
823 * @flags: splice modifier flags
824 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200825 * Description:
826 * Will send @len bytes from the pipe to a network socket. No data copying
827 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200828 *
829 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200830ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200831 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200832{
Jens Axboe00522fb2006-04-26 14:39:29 +0200833 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200834}
835
Jens Axboe059a8f32006-04-02 23:06:05 +0200836EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500837
Jens Axboe83f91352006-04-02 23:05:09 +0200838/*
839 * Attempt to initiate a splice from pipe to file.
840 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200841static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200842 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200843{
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200844 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
845 loff_t *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200846
Al Viro72c2d532013-09-22 16:27:52 -0400847 if (out->f_op->splice_write)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100848 splice_write = out->f_op->splice_write;
849 else
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200850 splice_write = default_file_splice_write;
851
Al Viro500368f2013-05-23 20:07:11 -0400852 return splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200853}
854
Jens Axboe83f91352006-04-02 23:05:09 +0200855/*
856 * Attempt to initiate a splice from a file to a pipe.
857 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200858static long do_splice_to(struct file *in, loff_t *ppos,
859 struct pipe_inode_info *pipe, size_t len,
860 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200861{
Miklos Szeredi68181732009-05-07 15:37:36 +0200862 ssize_t (*splice_read)(struct file *, loff_t *,
863 struct pipe_inode_info *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200864 int ret;
865
Jens Axboe49570e92006-04-11 13:56:09 +0200866 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200867 return -EBADF;
868
Jens Axboecbb7e572006-04-11 14:57:50 +0200869 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200870 if (unlikely(ret < 0))
871 return ret;
872
Al Viro03cc0782016-04-02 14:56:58 -0400873 if (unlikely(len > MAX_RW_COUNT))
874 len = MAX_RW_COUNT;
875
Al Viro72c2d532013-09-22 16:27:52 -0400876 if (in->f_op->splice_read)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100877 splice_read = in->f_op->splice_read;
878 else
Miklos Szeredi68181732009-05-07 15:37:36 +0200879 splice_read = default_file_splice_read;
880
881 return splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200882}
883
Jens Axboe932cc6d2007-06-21 13:10:21 +0200884/**
885 * splice_direct_to_actor - splices data directly between two non-pipes
886 * @in: file to splice from
887 * @sd: actor information on where to splice to
888 * @actor: handles the data splicing
889 *
890 * Description:
891 * This is a special case helper to splice directly between two
892 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200893 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200894 * that process.
895 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200896 */
897ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
898 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200899{
900 struct pipe_inode_info *pipe;
901 long ret, bytes;
902 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200903 size_t len;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200904 int i, flags, more;
Jens Axboeb92ce552006-04-11 13:52:07 +0200905
906 /*
907 * We require the input being a regular file, as we don't want to
908 * randomly drop data for eg socket -> socket splicing. Use the
909 * piped splicing for that!
910 */
Al Viro496ad9a2013-01-23 17:07:38 -0500911 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200912 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
913 return -EINVAL;
914
915 /*
916 * neither in nor out is a pipe, setup an internal pipe attached to
917 * 'out' and transfer the wanted data from 'in' to 'out' through that
918 */
919 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200920 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -0400921 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +0200922 if (!pipe)
923 return -ENOMEM;
924
925 /*
926 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200927 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200928 * PIPE_READERS appropriately.
929 */
930 pipe->readers = 1;
931
932 current->splice_pipe = pipe;
933 }
934
935 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200936 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200937 */
938 ret = 0;
939 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200940 len = sd->total_len;
941 flags = sd->flags;
942
943 /*
944 * Don't block on output, we have to drain the direct pipe.
945 */
946 sd->flags &= ~SPLICE_F_NONBLOCK;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200947 more = sd->flags & SPLICE_F_MORE;
Jens Axboeb92ce552006-04-11 13:52:07 +0200948
949 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +0200950 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200951 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200952
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200953 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200954 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +0200955 goto out_release;
956
957 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200958 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +0200959
960 /*
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200961 * If more data is pending, set SPLICE_F_MORE
962 * If this is the last data and SPLICE_F_MORE was not set
963 * initially, clears it.
964 */
965 if (read_len < len)
966 sd->flags |= SPLICE_F_MORE;
967 else if (!more)
968 sd->flags &= ~SPLICE_F_MORE;
969 /*
Jens Axboeb92ce552006-04-11 13:52:07 +0200970 * NOTE: nonblocking mode only applies to the input. We
971 * must not do the output in nonblocking mode as then we
972 * could get stuck data in the internal pipe:
973 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200974 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +0200975 if (unlikely(ret <= 0)) {
976 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200977 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200978 }
Jens Axboeb92ce552006-04-11 13:52:07 +0200979
980 bytes += ret;
981 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200982 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200983
Tom Zanussia82c53a2008-05-09 13:28:36 +0200984 if (ret < read_len) {
985 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +0200986 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200987 }
Jens Axboeb92ce552006-04-11 13:52:07 +0200988 }
989
Jens Axboe9e971982008-01-29 21:05:57 +0100990done:
Jens Axboeb92ce552006-04-11 13:52:07 +0200991 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +0100992 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +0200993 return bytes;
994
995out_release:
996 /*
997 * If we did an incomplete transfer we must release
998 * the pipe buffers in question:
999 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001000 for (i = 0; i < pipe->buffers; i++) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001001 struct pipe_buffer *buf = pipe->bufs + i;
1002
Miklos Szeredia7796382016-09-27 10:45:12 +02001003 if (buf->ops)
1004 pipe_buf_release(pipe, buf);
Jens Axboeb92ce552006-04-11 13:52:07 +02001005 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001006
Jens Axboe9e971982008-01-29 21:05:57 +01001007 if (!bytes)
1008 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001009
Jens Axboe9e971982008-01-29 21:05:57 +01001010 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001011}
1012EXPORT_SYMBOL(splice_direct_to_actor);
1013
1014static int direct_splice_actor(struct pipe_inode_info *pipe,
1015 struct splice_desc *sd)
1016{
Jens Axboe6a14b902007-06-14 13:08:55 +02001017 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001018
Al Viro7995bd22013-06-20 18:58:36 +04001019 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001020 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001021}
1022
Jens Axboe932cc6d2007-06-21 13:10:21 +02001023/**
1024 * do_splice_direct - splices data directly between two files
1025 * @in: file to splice from
1026 * @ppos: input file offset
1027 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001028 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001029 * @len: number of bytes to splice
1030 * @flags: splice modifier flags
1031 *
1032 * Description:
1033 * For use by do_sendfile(). splice can easily emulate sendfile, but
1034 * doing it in the application would incur an extra system call
1035 * (splice in + splice out, as compared to just sendfile()). So this helper
1036 * can splice directly through a process-private pipe.
1037 *
1038 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001039long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001040 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001041{
1042 struct splice_desc sd = {
1043 .len = len,
1044 .total_len = len,
1045 .flags = flags,
1046 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001047 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001048 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001049 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001050 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001051
Al Viro18c67cb2013-06-19 15:41:54 +04001052 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1053 return -EBADF;
1054
1055 if (unlikely(out->f_flags & O_APPEND))
1056 return -EINVAL;
1057
1058 ret = rw_verify_area(WRITE, out, opos, len);
1059 if (unlikely(ret < 0))
1060 return ret;
1061
Jens Axboec66ab6f2007-06-12 21:17:17 +02001062 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001063 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001064 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001065
Jens Axboec66ab6f2007-06-12 21:17:17 +02001066 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001067}
Miklos Szeredi1c118592014-10-24 00:14:35 +02001068EXPORT_SYMBOL(do_splice_direct);
Jens Axboeb92ce552006-04-11 13:52:07 +02001069
Al Viro8924fef2016-09-17 20:44:45 -04001070static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1071{
Linus Torvalds52bce912016-12-21 10:59:34 -08001072 for (;;) {
1073 if (unlikely(!pipe->readers)) {
1074 send_sig(SIGPIPE, current, 0);
1075 return -EPIPE;
1076 }
1077 if (pipe->nrbufs != pipe->buffers)
1078 return 0;
Al Viro8924fef2016-09-17 20:44:45 -04001079 if (flags & SPLICE_F_NONBLOCK)
1080 return -EAGAIN;
1081 if (signal_pending(current))
1082 return -ERESTARTSYS;
1083 pipe->waiting_writers++;
1084 pipe_wait(pipe);
1085 pipe->waiting_writers--;
1086 }
Al Viro8924fef2016-09-17 20:44:45 -04001087}
1088
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001089static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1090 struct pipe_inode_info *opipe,
1091 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001092
1093/*
Jens Axboe83f91352006-04-02 23:05:09 +02001094 * Determine where to splice to/from.
1095 */
Ingo Molnar529565dc2006-04-10 15:18:58 +02001096static long do_splice(struct file *in, loff_t __user *off_in,
1097 struct file *out, loff_t __user *off_out,
1098 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001099{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001100 struct pipe_inode_info *ipipe;
1101 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001102 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001103 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001104
Linus Torvalds71993e62010-11-28 13:56:09 -08001105 ipipe = get_pipe_info(in);
1106 opipe = get_pipe_info(out);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001107
1108 if (ipipe && opipe) {
1109 if (off_in || off_out)
1110 return -ESPIPE;
1111
1112 if (!(in->f_mode & FMODE_READ))
1113 return -EBADF;
1114
1115 if (!(out->f_mode & FMODE_WRITE))
1116 return -EBADF;
1117
1118 /* Splicing to self would be fun, but... */
1119 if (ipipe == opipe)
1120 return -EINVAL;
1121
1122 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1123 }
1124
1125 if (ipipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001126 if (off_in)
1127 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001128 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001129 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001130 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001131 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001132 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001133 } else {
1134 offset = out->f_pos;
1135 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001136
Al Viro18c67cb2013-06-19 15:41:54 +04001137 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1138 return -EBADF;
1139
1140 if (unlikely(out->f_flags & O_APPEND))
1141 return -EINVAL;
1142
1143 ret = rw_verify_area(WRITE, out, &offset, len);
1144 if (unlikely(ret < 0))
1145 return ret;
1146
Al Viro500368f2013-05-23 20:07:11 -04001147 file_start_write(out);
Al Viro7995bd22013-06-20 18:58:36 +04001148 ret = do_splice_from(ipipe, out, &offset, len, flags);
Al Viro500368f2013-05-23 20:07:11 -04001149 file_end_write(out);
Jens Axboea4514eb2006-04-19 15:57:05 +02001150
Al Viro7995bd22013-06-20 18:58:36 +04001151 if (!off_out)
1152 out->f_pos = offset;
1153 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001154 ret = -EFAULT;
1155
1156 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001157 }
Jens Axboe5274f052006-03-30 15:15:30 +02001158
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001159 if (opipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001160 if (off_out)
1161 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001162 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001163 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001164 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001165 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001166 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001167 } else {
1168 offset = in->f_pos;
1169 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001170
Al Viro8924fef2016-09-17 20:44:45 -04001171 pipe_lock(opipe);
1172 ret = wait_for_space(opipe, flags);
1173 if (!ret)
1174 ret = do_splice_to(in, &offset, opipe, len, flags);
1175 pipe_unlock(opipe);
1176 if (ret > 0)
1177 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001178 if (!off_in)
1179 in->f_pos = offset;
1180 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001181 ret = -EFAULT;
1182
1183 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001184 }
Jens Axboe5274f052006-03-30 15:15:30 +02001185
1186 return -EINVAL;
1187}
1188
Al Viro79fddc42016-09-17 22:38:20 -04001189static int iter_to_pipe(struct iov_iter *from,
1190 struct pipe_inode_info *pipe,
1191 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001192{
Al Viro79fddc42016-09-17 22:38:20 -04001193 struct pipe_buffer buf = {
1194 .ops = &user_page_pipe_buf_ops,
1195 .flags = flags
1196 };
1197 size_t total = 0;
1198 int ret = 0;
1199 bool failed = false;
1200
1201 while (iov_iter_count(from) && !failed) {
1202 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001203 ssize_t copied;
1204 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001205 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001206
Al Viro79fddc42016-09-17 22:38:20 -04001207 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1208 if (copied <= 0) {
1209 ret = copied;
1210 break;
1211 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001212
Al Viro79fddc42016-09-17 22:38:20 -04001213 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001214 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001215 if (!failed) {
1216 buf.page = pages[n];
1217 buf.offset = start;
1218 buf.len = size;
1219 ret = add_to_pipe(pipe, &buf);
1220 if (unlikely(ret < 0)) {
1221 failed = true;
1222 } else {
1223 iov_iter_advance(from, ret);
1224 total += ret;
1225 }
1226 } else {
1227 put_page(pages[n]);
1228 }
Al Virodb85a9e2016-09-17 20:25:06 -04001229 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001230 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001231 }
Al Viro79fddc42016-09-17 22:38:20 -04001232 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001233}
1234
Jens Axboe6a14b902007-06-14 13:08:55 +02001235static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1236 struct splice_desc *sd)
1237{
Al Viro6130f532014-02-03 18:19:51 -05001238 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1239 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001240}
1241
1242/*
1243 * For lack of a better implementation, implement vmsplice() to userspace
1244 * as a simple copy of the pipes pages to the user iov.
1245 */
Al Viro6130f532014-02-03 18:19:51 -05001246static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001247 unsigned long nr_segs, unsigned int flags)
1248{
1249 struct pipe_inode_info *pipe;
1250 struct splice_desc sd;
Jens Axboe6a14b902007-06-14 13:08:55 +02001251 long ret;
Al Viro6130f532014-02-03 18:19:51 -05001252 struct iovec iovstack[UIO_FASTIOV];
1253 struct iovec *iov = iovstack;
1254 struct iov_iter iter;
Jens Axboe6a14b902007-06-14 13:08:55 +02001255
Linus Torvalds71993e62010-11-28 13:56:09 -08001256 pipe = get_pipe_info(file);
Jens Axboe6a14b902007-06-14 13:08:55 +02001257 if (!pipe)
1258 return -EBADF;
1259
Al Viro345995f2015-03-21 19:17:55 -04001260 ret = import_iovec(READ, uiov, nr_segs,
1261 ARRAY_SIZE(iovstack), &iov, &iter);
1262 if (ret < 0)
1263 return ret;
Al Viro6130f532014-02-03 18:19:51 -05001264
Al Viro345995f2015-03-21 19:17:55 -04001265 sd.total_len = iov_iter_count(&iter);
Al Viro6130f532014-02-03 18:19:51 -05001266 sd.len = 0;
Al Viro6130f532014-02-03 18:19:51 -05001267 sd.flags = flags;
1268 sd.u.data = &iter;
1269 sd.pos = 0;
1270
Al Viro345995f2015-03-21 19:17:55 -04001271 if (sd.total_len) {
1272 pipe_lock(pipe);
1273 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1274 pipe_unlock(pipe);
1275 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001276
Al Viro345995f2015-03-21 19:17:55 -04001277 kfree(iov);
Jens Axboe6a14b902007-06-14 13:08:55 +02001278 return ret;
1279}
1280
Jens Axboe912d35f2006-04-26 10:59:21 +02001281/*
1282 * vmsplice splices a user address range into a pipe. It can be thought of
1283 * as splice-from-memory, where the regular splice is splice-from-file (or
1284 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001285 */
Al Virodb85a9e2016-09-17 20:25:06 -04001286static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001287 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001288{
Jens Axboeddac0d32006-11-04 12:49:32 +01001289 struct pipe_inode_info *pipe;
Al Virodb85a9e2016-09-17 20:25:06 -04001290 struct iovec iovstack[UIO_FASTIOV];
1291 struct iovec *iov = iovstack;
1292 struct iov_iter from;
Jens Axboe35f3d142010-05-20 10:43:18 +02001293 long ret;
Al Viro79fddc42016-09-17 22:38:20 -04001294 unsigned buf_flag = 0;
1295
1296 if (flags & SPLICE_F_GIFT)
1297 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001298
Linus Torvalds71993e62010-11-28 13:56:09 -08001299 pipe = get_pipe_info(file);
Jens Axboeddac0d32006-11-04 12:49:32 +01001300 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001301 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001302
Al Virodb85a9e2016-09-17 20:25:06 -04001303 ret = import_iovec(WRITE, uiov, nr_segs,
1304 ARRAY_SIZE(iovstack), &iov, &from);
1305 if (ret < 0)
1306 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001307
Al Viro8924fef2016-09-17 20:44:45 -04001308 pipe_lock(pipe);
1309 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001310 if (!ret)
1311 ret = iter_to_pipe(&from, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001312 pipe_unlock(pipe);
1313 if (ret > 0)
1314 wakeup_pipe_readers(pipe);
Al Virodb85a9e2016-09-17 20:25:06 -04001315 kfree(iov);
Jens Axboe35f3d142010-05-20 10:43:18 +02001316 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001317}
1318
Jens Axboe6a14b902007-06-14 13:08:55 +02001319/*
1320 * Note that vmsplice only really supports true splicing _from_ user memory
1321 * to a pipe, not the other way around. Splicing from user memory is a simple
1322 * operation that can be supported without any funky alignment restrictions
1323 * or nasty vm tricks. We simply map in the user memory and fill them into
1324 * a pipe. The reverse isn't quite as easy, though. There are two possible
1325 * solutions for that:
1326 *
1327 * - memcpy() the data internally, at which point we might as well just
1328 * do a regular read() on the buffer anyway.
1329 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1330 * has restriction limitations on both ends of the pipe).
1331 *
1332 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1333 *
1334 */
Dominik Brodowski30cfe4e2018-03-17 15:00:24 +01001335static long do_vmsplice(int fd, const struct iovec __user *iov,
1336 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001337{
Al Viro2903ff02012-08-28 12:52:22 -04001338 struct fd f;
Jens Axboe912d35f2006-04-26 10:59:21 +02001339 long error;
Jens Axboe912d35f2006-04-26 10:59:21 +02001340
Al Viro3d6ea292016-12-10 13:17:32 -05001341 if (unlikely(flags & ~SPLICE_F_ALL))
1342 return -EINVAL;
Jens Axboe6a14b902007-06-14 13:08:55 +02001343 if (unlikely(nr_segs > UIO_MAXIOV))
1344 return -EINVAL;
1345 else if (unlikely(!nr_segs))
1346 return 0;
1347
Jens Axboe912d35f2006-04-26 10:59:21 +02001348 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001349 f = fdget(fd);
1350 if (f.file) {
1351 if (f.file->f_mode & FMODE_WRITE)
1352 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1353 else if (f.file->f_mode & FMODE_READ)
1354 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001355
Al Viro2903ff02012-08-28 12:52:22 -04001356 fdput(f);
Jens Axboe912d35f2006-04-26 10:59:21 +02001357 }
1358
1359 return error;
1360}
1361
Dominik Brodowski30cfe4e2018-03-17 15:00:24 +01001362SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1363 unsigned long, nr_segs, unsigned int, flags)
1364{
1365 return do_vmsplice(fd, iov, nr_segs, flags);
1366}
1367
Al Viro76b021d2013-03-02 10:19:56 -05001368#ifdef CONFIG_COMPAT
1369COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1370 unsigned int, nr_segs, unsigned int, flags)
1371{
1372 unsigned i;
1373 struct iovec __user *iov;
1374 if (nr_segs > UIO_MAXIOV)
1375 return -EINVAL;
1376 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1377 for (i = 0; i < nr_segs; i++) {
1378 struct compat_iovec v;
1379 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1380 get_user(v.iov_len, &iov32[i].iov_len) ||
1381 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1382 put_user(v.iov_len, &iov[i].iov_len))
1383 return -EFAULT;
1384 }
Dominik Brodowski30cfe4e2018-03-17 15:00:24 +01001385 return do_vmsplice(fd, iov, nr_segs, flags);
Al Viro76b021d2013-03-02 10:19:56 -05001386}
1387#endif
1388
Heiko Carstens836f92a2009-01-14 14:14:33 +01001389SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1390 int, fd_out, loff_t __user *, off_out,
1391 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001392{
Al Viro2903ff02012-08-28 12:52:22 -04001393 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001394 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001395
1396 if (unlikely(!len))
1397 return 0;
1398
Al Viro3d6ea292016-12-10 13:17:32 -05001399 if (unlikely(flags & ~SPLICE_F_ALL))
1400 return -EINVAL;
1401
Jens Axboe5274f052006-03-30 15:15:30 +02001402 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001403 in = fdget(fd_in);
1404 if (in.file) {
1405 if (in.file->f_mode & FMODE_READ) {
1406 out = fdget(fd_out);
1407 if (out.file) {
1408 if (out.file->f_mode & FMODE_WRITE)
1409 error = do_splice(in.file, off_in,
1410 out.file, off_out,
Ingo Molnar529565dc2006-04-10 15:18:58 +02001411 len, flags);
Al Viro2903ff02012-08-28 12:52:22 -04001412 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001413 }
1414 }
Al Viro2903ff02012-08-28 12:52:22 -04001415 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001416 }
Jens Axboe5274f052006-03-30 15:15:30 +02001417 return error;
1418}
Jens Axboe70524492006-04-11 15:51:17 +02001419
1420/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001421 * Make sure there's data to read. Wait for input if we can, otherwise
1422 * return an appropriate error.
1423 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001424static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001425{
1426 int ret;
1427
1428 /*
1429 * Check ->nrbufs without the inode lock first. This function
1430 * is speculative anyways, so missing one is ok.
1431 */
1432 if (pipe->nrbufs)
1433 return 0;
1434
1435 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001436 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001437
1438 while (!pipe->nrbufs) {
1439 if (signal_pending(current)) {
1440 ret = -ERESTARTSYS;
1441 break;
1442 }
1443 if (!pipe->writers)
1444 break;
1445 if (!pipe->waiting_writers) {
1446 if (flags & SPLICE_F_NONBLOCK) {
1447 ret = -EAGAIN;
1448 break;
1449 }
1450 }
1451 pipe_wait(pipe);
1452 }
1453
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001454 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001455 return ret;
1456}
1457
1458/*
1459 * Make sure there's writeable room. Wait for room if we can, otherwise
1460 * return an appropriate error.
1461 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001462static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001463{
1464 int ret;
1465
1466 /*
1467 * Check ->nrbufs without the inode lock first. This function
1468 * is speculative anyways, so missing one is ok.
1469 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001470 if (pipe->nrbufs < pipe->buffers)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001471 return 0;
1472
1473 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001474 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001475
Jens Axboe35f3d142010-05-20 10:43:18 +02001476 while (pipe->nrbufs >= pipe->buffers) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001477 if (!pipe->readers) {
1478 send_sig(SIGPIPE, current, 0);
1479 ret = -EPIPE;
1480 break;
1481 }
1482 if (flags & SPLICE_F_NONBLOCK) {
1483 ret = -EAGAIN;
1484 break;
1485 }
1486 if (signal_pending(current)) {
1487 ret = -ERESTARTSYS;
1488 break;
1489 }
1490 pipe->waiting_writers++;
1491 pipe_wait(pipe);
1492 pipe->waiting_writers--;
1493 }
1494
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001495 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001496 return ret;
1497}
1498
1499/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001500 * Splice contents of ipipe to opipe.
1501 */
1502static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1503 struct pipe_inode_info *opipe,
1504 size_t len, unsigned int flags)
1505{
1506 struct pipe_buffer *ibuf, *obuf;
1507 int ret = 0, nbuf;
1508 bool input_wakeup = false;
1509
1510
1511retry:
1512 ret = ipipe_prep(ipipe, flags);
1513 if (ret)
1514 return ret;
1515
1516 ret = opipe_prep(opipe, flags);
1517 if (ret)
1518 return ret;
1519
1520 /*
1521 * Potential ABBA deadlock, work around it by ordering lock
1522 * grabbing by pipe info address. Otherwise two different processes
1523 * could deadlock (one doing tee from A -> B, the other from B -> A).
1524 */
1525 pipe_double_lock(ipipe, opipe);
1526
1527 do {
1528 if (!opipe->readers) {
1529 send_sig(SIGPIPE, current, 0);
1530 if (!ret)
1531 ret = -EPIPE;
1532 break;
1533 }
1534
1535 if (!ipipe->nrbufs && !ipipe->writers)
1536 break;
1537
1538 /*
1539 * Cannot make any progress, because either the input
1540 * pipe is empty or the output pipe is full.
1541 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001542 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001543 /* Already processed some buffers, break */
1544 if (ret)
1545 break;
1546
1547 if (flags & SPLICE_F_NONBLOCK) {
1548 ret = -EAGAIN;
1549 break;
1550 }
1551
1552 /*
1553 * We raced with another reader/writer and haven't
1554 * managed to process any buffers. A zero return
1555 * value means EOF, so retry instead.
1556 */
1557 pipe_unlock(ipipe);
1558 pipe_unlock(opipe);
1559 goto retry;
1560 }
1561
1562 ibuf = ipipe->bufs + ipipe->curbuf;
Jens Axboe35f3d142010-05-20 10:43:18 +02001563 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001564 obuf = opipe->bufs + nbuf;
1565
1566 if (len >= ibuf->len) {
1567 /*
1568 * Simply move the whole buffer from ipipe to opipe
1569 */
1570 *obuf = *ibuf;
1571 ibuf->ops = NULL;
1572 opipe->nrbufs++;
Jens Axboe35f3d142010-05-20 10:43:18 +02001573 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001574 ipipe->nrbufs--;
1575 input_wakeup = true;
1576 } else {
1577 /*
1578 * Get a reference to this pipe buffer,
1579 * so we can copy the contents over.
1580 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001581 pipe_buf_get(ipipe, ibuf);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001582 *obuf = *ibuf;
1583
1584 /*
1585 * Don't inherit the gift flag, we need to
1586 * prevent multiple steals of this page.
1587 */
1588 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1589
1590 obuf->len = len;
1591 opipe->nrbufs++;
1592 ibuf->offset += obuf->len;
1593 ibuf->len -= obuf->len;
1594 }
1595 ret += obuf->len;
1596 len -= obuf->len;
1597 } while (len);
1598
1599 pipe_unlock(ipipe);
1600 pipe_unlock(opipe);
1601
1602 /*
1603 * If we put data in the output pipe, wakeup any potential readers.
1604 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001605 if (ret > 0)
1606 wakeup_pipe_readers(opipe);
1607
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001608 if (input_wakeup)
1609 wakeup_pipe_writers(ipipe);
1610
1611 return ret;
1612}
1613
1614/*
Jens Axboe70524492006-04-11 15:51:17 +02001615 * Link contents of ipipe to opipe.
1616 */
1617static int link_pipe(struct pipe_inode_info *ipipe,
1618 struct pipe_inode_info *opipe,
1619 size_t len, unsigned int flags)
1620{
1621 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001622 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001623
1624 /*
1625 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001626 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001627 * could deadlock (one doing tee from A -> B, the other from B -> A).
1628 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001629 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001630
Jens Axboeaadd06e2006-07-10 11:00:01 +02001631 do {
Jens Axboe70524492006-04-11 15:51:17 +02001632 if (!opipe->readers) {
1633 send_sig(SIGPIPE, current, 0);
1634 if (!ret)
1635 ret = -EPIPE;
1636 break;
1637 }
Jens Axboe70524492006-04-11 15:51:17 +02001638
1639 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001640 * If we have iterated all input buffers or ran out of
1641 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001642 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001643 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
Jens Axboe70524492006-04-11 15:51:17 +02001644 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001645
Jens Axboe35f3d142010-05-20 10:43:18 +02001646 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1647 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001648
Jens Axboe2a27250e2006-04-19 15:56:40 +02001649 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001650 * Get a reference to this pipe buffer,
1651 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001652 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001653 pipe_buf_get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001654
Jens Axboeaadd06e2006-07-10 11:00:01 +02001655 obuf = opipe->bufs + nbuf;
1656 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001657
Jens Axboeaadd06e2006-07-10 11:00:01 +02001658 /*
1659 * Don't inherit the gift flag, we need to
1660 * prevent multiple steals of this page.
1661 */
1662 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1663
1664 if (obuf->len > len)
1665 obuf->len = len;
1666
1667 opipe->nrbufs++;
1668 ret += obuf->len;
1669 len -= obuf->len;
1670 i++;
1671 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001672
Jens Axboe02cf01a2008-02-20 10:34:51 +01001673 /*
1674 * return EAGAIN if we have the potential of some data in the
1675 * future, otherwise just return 0
1676 */
1677 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1678 ret = -EAGAIN;
1679
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001680 pipe_unlock(ipipe);
1681 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001682
Jens Axboeaadd06e2006-07-10 11:00:01 +02001683 /*
1684 * If we put data in the output pipe, wakeup any potential readers.
1685 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001686 if (ret > 0)
1687 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001688
1689 return ret;
1690}
1691
1692/*
1693 * This is a tee(1) implementation that works on pipes. It doesn't copy
1694 * any data, it simply references the 'in' pages on the 'out' pipe.
1695 * The 'flags' used are the SPLICE_F_* variants, currently the only
1696 * applicable one is SPLICE_F_NONBLOCK.
1697 */
1698static long do_tee(struct file *in, struct file *out, size_t len,
1699 unsigned int flags)
1700{
Linus Torvalds71993e62010-11-28 13:56:09 -08001701 struct pipe_inode_info *ipipe = get_pipe_info(in);
1702 struct pipe_inode_info *opipe = get_pipe_info(out);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001703 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001704
1705 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001706 * Duplicate the contents of ipipe to opipe without actually
1707 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001708 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001709 if (ipipe && opipe && ipipe != opipe) {
1710 /*
1711 * Keep going, unless we encounter an error. The ipipe/opipe
1712 * ordering doesn't really matter.
1713 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001714 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001715 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001716 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001717 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001718 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001719 }
1720 }
Jens Axboe70524492006-04-11 15:51:17 +02001721
Jens Axboeaadd06e2006-07-10 11:00:01 +02001722 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001723}
1724
Heiko Carstens836f92a2009-01-14 14:14:33 +01001725SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001726{
Al Viro2903ff02012-08-28 12:52:22 -04001727 struct fd in;
1728 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001729
Al Viro3d6ea292016-12-10 13:17:32 -05001730 if (unlikely(flags & ~SPLICE_F_ALL))
1731 return -EINVAL;
1732
Jens Axboe70524492006-04-11 15:51:17 +02001733 if (unlikely(!len))
1734 return 0;
1735
1736 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001737 in = fdget(fdin);
1738 if (in.file) {
1739 if (in.file->f_mode & FMODE_READ) {
1740 struct fd out = fdget(fdout);
1741 if (out.file) {
1742 if (out.file->f_mode & FMODE_WRITE)
1743 error = do_tee(in.file, out.file,
1744 len, flags);
1745 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001746 }
1747 }
Al Viro2903ff02012-08-28 12:52:22 -04001748 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001749 }
1750
1751 return error;
1752}