blob: ae41201d032581a7c03f00a5cc86287782e000d4 [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{
Eric Dumazet047fe362012-06-12 15:24:40 +0200256 unsigned int buffers = ACCESS_ONCE(pipe->buffers);
257
258 spd->nr_pages_max = buffers;
259 if (buffers <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200260 return 0;
261
Eric Dumazet047fe362012-06-12 15:24:40 +0200262 spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
263 spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200264
265 if (spd->pages && spd->partial)
266 return 0;
267
268 kfree(spd->pages);
269 kfree(spd->partial);
270 return -ENOMEM;
271}
272
Eric Dumazet047fe362012-06-12 15:24:40 +0200273void splice_shrink_spd(struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200274{
Eric Dumazet047fe362012-06-12 15:24:40 +0200275 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200276 return;
277
278 kfree(spd->pages);
279 kfree(spd->partial);
280}
281
Jens Axboe83f91352006-04-02 23:05:09 +0200282/**
283 * generic_file_splice_read - splice data from file to a pipe
284 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200285 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200286 * @pipe: pipe to splice to
287 * @len: number of bytes to splice
288 * @flags: splice modifier flags
289 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200290 * Description:
291 * Will read pages from given file and fill them into a pipe. Can be
Al Viro82c156f2016-09-22 23:35:42 -0400292 * used as long as it has more or less sane ->read_iter().
Jens Axboe932cc6d2007-06-21 13:10:21 +0200293 *
Jens Axboe83f91352006-04-02 23:05:09 +0200294 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200295ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
296 struct pipe_inode_info *pipe, size_t len,
297 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200298{
Al Viro82c156f2016-09-22 23:35:42 -0400299 struct iov_iter to;
300 struct kiocb kiocb;
Al Viro82c156f2016-09-22 23:35:42 -0400301 int idx, ret;
Boaz Harroshbe64f882015-04-15 16:15:17 -0700302
Al Viro82c156f2016-09-22 23:35:42 -0400303 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len);
304 idx = to.idx;
305 init_sync_kiocb(&kiocb, in);
306 kiocb.ki_pos = *ppos;
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100307 ret = call_read_iter(in, &kiocb, &to);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200308 if (ret > 0) {
Al Viro82c156f2016-09-22 23:35:42 -0400309 *ppos = kiocb.ki_pos;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200310 file_accessed(in);
Al Viro82c156f2016-09-22 23:35:42 -0400311 } else if (ret < 0) {
Al Viroc3a69022016-10-10 13:26:27 -0400312 to.idx = idx;
313 to.iov_offset = 0;
314 iov_iter_advance(&to, 0); /* to free what was emitted */
Al Viro82c156f2016-09-22 23:35:42 -0400315 /*
316 * callers of ->splice_read() expect -EAGAIN on
317 * "can't put anything in there", rather than -EFAULT.
318 */
319 if (ret == -EFAULT)
320 ret = -EAGAIN;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200321 }
Jens Axboe5274f052006-03-30 15:15:30 +0200322
323 return ret;
324}
Jens Axboe059a8f32006-04-02 23:06:05 +0200325EXPORT_SYMBOL(generic_file_splice_read);
326
Al Viro241699c2016-09-22 16:33:12 -0400327const struct pipe_buf_operations default_pipe_buf_ops = {
Miklos Szeredi68181732009-05-07 15:37:36 +0200328 .can_merge = 0,
Miklos Szeredi68181732009-05-07 15:37:36 +0200329 .confirm = generic_pipe_buf_confirm,
330 .release = generic_pipe_buf_release,
331 .steal = generic_pipe_buf_steal,
332 .get = generic_pipe_buf_get,
333};
334
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100335static int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
336 struct pipe_buffer *buf)
337{
338 return 1;
339}
340
341/* Pipe buffer operations for a socket and similar. */
342const struct pipe_buf_operations nosteal_pipe_buf_ops = {
343 .can_merge = 0,
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100344 .confirm = generic_pipe_buf_confirm,
345 .release = generic_pipe_buf_release,
346 .steal = generic_pipe_buf_nosteal,
347 .get = generic_pipe_buf_get,
348};
349EXPORT_SYMBOL(nosteal_pipe_buf_ops);
350
Al Viro523ac9a2016-09-23 15:34:57 -0400351static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
Miklos Szeredi68181732009-05-07 15:37:36 +0200352 unsigned long vlen, loff_t offset)
353{
354 mm_segment_t old_fs;
355 loff_t pos = offset;
356 ssize_t res;
357
358 old_fs = get_fs();
359 set_fs(get_ds());
360 /* The cast to a user pointer is valid due to the set_fs() */
Christoph Hellwig793b80e2016-03-03 16:03:58 +0100361 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
Miklos Szeredi68181732009-05-07 15:37:36 +0200362 set_fs(old_fs);
363
364 return res;
365}
366
Al Viro7bb307e2013-02-23 14:51:48 -0500367ssize_t kernel_write(struct file *file, const char *buf, size_t count,
Miklos Szeredib2858d72009-05-19 11:37:46 +0200368 loff_t pos)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200369{
370 mm_segment_t old_fs;
371 ssize_t res;
372
373 old_fs = get_fs();
374 set_fs(get_ds());
375 /* The cast to a user pointer is valid due to the set_fs() */
Al Viro7bb307e2013-02-23 14:51:48 -0500376 res = vfs_write(file, (__force const char __user *)buf, count, &pos);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200377 set_fs(old_fs);
378
379 return res;
380}
Al Viro7bb307e2013-02-23 14:51:48 -0500381EXPORT_SYMBOL(kernel_write);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200382
Al Viro82c156f2016-09-22 23:35:42 -0400383static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
Miklos Szeredi68181732009-05-07 15:37:36 +0200384 struct pipe_inode_info *pipe, size_t len,
385 unsigned int flags)
386{
Al Viro523ac9a2016-09-23 15:34:57 -0400387 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
388 struct iov_iter to;
389 struct page **pages;
Miklos Szeredi68181732009-05-07 15:37:36 +0200390 unsigned int nr_pages;
Al Viro13c0f522016-12-10 13:20:53 -0500391 size_t offset, base, copied = 0;
Miklos Szeredi68181732009-05-07 15:37:36 +0200392 ssize_t res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200393 int i;
Miklos Szeredi68181732009-05-07 15:37:36 +0200394
Al Viro523ac9a2016-09-23 15:34:57 -0400395 if (pipe->nrbufs == pipe->buffers)
396 return -EAGAIN;
397
398 /*
399 * Try to keep page boundaries matching to source pagecache ones -
400 * it probably won't be much help, but...
401 */
402 offset = *ppos & ~PAGE_MASK;
403
404 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
405
Al Viro13c0f522016-12-10 13:20:53 -0500406 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &base);
Al Viro523ac9a2016-09-23 15:34:57 -0400407 if (res <= 0)
Jens Axboe35f3d142010-05-20 10:43:18 +0200408 return -ENOMEM;
409
Al Viro13c0f522016-12-10 13:20:53 -0500410 nr_pages = DIV_ROUND_UP(res + base, PAGE_SIZE);
Al Viro523ac9a2016-09-23 15:34:57 -0400411
Jens Axboe35f3d142010-05-20 10:43:18 +0200412 vec = __vec;
Al Viro523ac9a2016-09-23 15:34:57 -0400413 if (nr_pages > PIPE_DEF_BUFFERS) {
414 vec = kmalloc(nr_pages * sizeof(struct kvec), GFP_KERNEL);
415 if (unlikely(!vec)) {
416 res = -ENOMEM;
417 goto out;
418 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200419 }
420
Al Viro523ac9a2016-09-23 15:34:57 -0400421 pipe->bufs[to.idx].offset = offset;
422 pipe->bufs[to.idx].len -= offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200423
Al Viro523ac9a2016-09-23 15:34:57 -0400424 for (i = 0; i < nr_pages; i++) {
425 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
426 vec[i].iov_base = page_address(pages[i]) + offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200427 vec[i].iov_len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200428 len -= this_len;
429 offset = 0;
430 }
431
Al Viro523ac9a2016-09-23 15:34:57 -0400432 res = kernel_readv(in, vec, nr_pages, *ppos);
433 if (res > 0) {
434 copied = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200435 *ppos += res;
Al Viro523ac9a2016-09-23 15:34:57 -0400436 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200437
Jens Axboe35f3d142010-05-20 10:43:18 +0200438 if (vec != __vec)
439 kfree(vec);
Al Viro523ac9a2016-09-23 15:34:57 -0400440out:
441 for (i = 0; i < nr_pages; i++)
442 put_page(pages[i]);
443 kvfree(pages);
444 iov_iter_advance(&to, copied); /* truncates and discards */
Miklos Szeredi68181732009-05-07 15:37:36 +0200445 return res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200446}
Miklos Szeredi68181732009-05-07 15:37:36 +0200447
Jens Axboe5274f052006-03-30 15:15:30 +0200448/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200449 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200450 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200451 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200452static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200453 struct pipe_buffer *buf, struct splice_desc *sd)
454{
Jens Axboe6a14b902007-06-14 13:08:55 +0200455 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200456 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100457 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200458
Al Viro72c2d532013-09-22 16:27:52 -0400459 if (!likely(file->f_op->sendpage))
Michał Mirosława8adbe32010-12-17 08:56:44 +0100460 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200461
Eric Dumazet35f9c092012-04-05 03:05:35 +0000462 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000463
464 if (sd->len < sd->total_len && pipe->nrbufs > 1)
Eric Dumazet35f9c092012-04-05 03:05:35 +0000465 more |= MSG_SENDPAGE_NOTLAST;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000466
Michał Mirosława8adbe32010-12-17 08:56:44 +0100467 return file->f_op->sendpage(file, buf->page, buf->offset,
468 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200469}
470
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200471static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
472{
473 smp_mb();
474 if (waitqueue_active(&pipe->wait))
475 wake_up_interruptible(&pipe->wait);
476 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
477}
478
479/**
480 * splice_from_pipe_feed - feed available data from a pipe to a file
481 * @pipe: pipe to splice from
482 * @sd: information to @actor
483 * @actor: handler that splices the data
484 *
485 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200486 * This function loops over the pipe and calls @actor to do the
487 * actual moving of a single struct pipe_buffer to the desired
488 * destination. It returns when there's no more buffers left in
489 * the pipe or if the requested number of bytes (@sd->total_len)
490 * have been copied. It returns a positive number (one) if the
491 * pipe needs to be filled with more data, zero if the required
492 * number of bytes have been copied and -errno on error.
493 *
494 * This, together with splice_from_pipe_{begin,end,next}, may be
495 * used to implement the functionality of __splice_from_pipe() when
496 * locking is required around copying the pipe buffers to the
497 * destination.
498 */
Al Viro96f9bc82014-04-05 04:35:49 -0400499static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200500 splice_actor *actor)
501{
502 int ret;
503
504 while (pipe->nrbufs) {
505 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200506
507 sd->len = buf->len;
508 if (sd->len > sd->total_len)
509 sd->len = sd->total_len;
510
Miklos Szeredifba597d2016-09-27 10:45:12 +0200511 ret = pipe_buf_confirm(pipe, buf);
Michał Mirosława8adbe32010-12-17 08:56:44 +0100512 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200513 if (ret == -ENODATA)
514 ret = 0;
515 return ret;
516 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100517
518 ret = actor(pipe, buf, sd);
519 if (ret <= 0)
520 return ret;
521
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200522 buf->offset += ret;
523 buf->len -= ret;
524
525 sd->num_spliced += ret;
526 sd->len -= ret;
527 sd->pos += ret;
528 sd->total_len -= ret;
529
530 if (!buf->len) {
Miklos Szeredia7796382016-09-27 10:45:12 +0200531 pipe_buf_release(pipe, buf);
Jens Axboe35f3d142010-05-20 10:43:18 +0200532 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200533 pipe->nrbufs--;
Al Viro6447a3c2013-03-21 11:01:38 -0400534 if (pipe->files)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200535 sd->need_wakeup = true;
536 }
537
538 if (!sd->total_len)
539 return 0;
540 }
541
542 return 1;
543}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200544
545/**
546 * splice_from_pipe_next - wait for some data to splice from
547 * @pipe: pipe to splice from
548 * @sd: information about the splice operation
549 *
550 * Description:
551 * This function will wait for some data and return a positive
552 * value (one) if pipe buffers are available. It will return zero
553 * or -errno if no more data needs to be spliced.
554 */
Al Viro96f9bc82014-04-05 04:35:49 -0400555static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200556{
Jan Karac725bfc2015-11-23 13:09:50 +0100557 /*
558 * Check for signal early to make process killable when there are
559 * always buffers available
560 */
561 if (signal_pending(current))
562 return -ERESTARTSYS;
563
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200564 while (!pipe->nrbufs) {
565 if (!pipe->writers)
566 return 0;
567
568 if (!pipe->waiting_writers && sd->num_spliced)
569 return 0;
570
571 if (sd->flags & SPLICE_F_NONBLOCK)
572 return -EAGAIN;
573
574 if (signal_pending(current))
575 return -ERESTARTSYS;
576
577 if (sd->need_wakeup) {
578 wakeup_pipe_writers(pipe);
579 sd->need_wakeup = false;
580 }
581
582 pipe_wait(pipe);
583 }
584
585 return 1;
586}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200587
588/**
589 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700590 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200591 *
592 * Description:
593 * This function should be called before a loop containing
594 * splice_from_pipe_next() and splice_from_pipe_feed() to
595 * initialize the necessary fields of @sd.
596 */
Al Viro96f9bc82014-04-05 04:35:49 -0400597static void splice_from_pipe_begin(struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200598{
599 sd->num_spliced = 0;
600 sd->need_wakeup = false;
601}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200602
603/**
604 * splice_from_pipe_end - finish splicing from pipe
605 * @pipe: pipe to splice from
606 * @sd: information about the splice operation
607 *
608 * Description:
609 * This function will wake up pipe writers if necessary. It should
610 * be called after a loop containing splice_from_pipe_next() and
611 * splice_from_pipe_feed().
612 */
Al Viro96f9bc82014-04-05 04:35:49 -0400613static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200614{
615 if (sd->need_wakeup)
616 wakeup_pipe_writers(pipe);
617}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200618
Jens Axboe932cc6d2007-06-21 13:10:21 +0200619/**
620 * __splice_from_pipe - splice data from a pipe to given actor
621 * @pipe: pipe to splice from
622 * @sd: information to @actor
623 * @actor: handler that splices the data
624 *
625 * Description:
626 * This function does little more than loop over the pipe and call
627 * @actor to do the actual moving of a single struct pipe_buffer to
628 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
629 * pipe_to_user.
630 *
Jens Axboe83f91352006-04-02 23:05:09 +0200631 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200632ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
633 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200634{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200635 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200636
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200637 splice_from_pipe_begin(sd);
638 do {
Jan Karac2489e02015-11-23 13:09:51 +0100639 cond_resched();
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200640 ret = splice_from_pipe_next(pipe, sd);
641 if (ret > 0)
642 ret = splice_from_pipe_feed(pipe, sd, actor);
643 } while (ret > 0);
644 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200645
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200646 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200647}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100648EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200649
Jens Axboe932cc6d2007-06-21 13:10:21 +0200650/**
651 * splice_from_pipe - splice data from a pipe to a file
652 * @pipe: pipe to splice from
653 * @out: file to splice to
654 * @ppos: position in @out
655 * @len: how many bytes to splice
656 * @flags: splice modifier flags
657 * @actor: handler that splices the data
658 *
659 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200660 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200661 * otherwise it's identical to __splice_from_pipe().
662 *
663 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200664ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
665 loff_t *ppos, size_t len, unsigned int flags,
666 splice_actor *actor)
667{
668 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200669 struct splice_desc sd = {
670 .total_len = len,
671 .flags = flags,
672 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200673 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200674 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200675
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200676 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200677 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200678 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200679
680 return ret;
681}
682
683/**
Al Viro8d020762014-04-05 04:27:08 -0400684 * iter_file_splice_write - splice data from a pipe to a file
685 * @pipe: pipe info
686 * @out: file to write to
687 * @ppos: position in @out
688 * @len: number of bytes to splice
689 * @flags: splice modifier flags
690 *
691 * Description:
692 * Will either move or copy pages (determined by @flags options) from
693 * the given pipe inode to the given file.
694 * This one is ->write_iter-based.
695 *
696 */
697ssize_t
698iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
699 loff_t *ppos, size_t len, unsigned int flags)
700{
701 struct splice_desc sd = {
702 .total_len = len,
703 .flags = flags,
704 .pos = *ppos,
705 .u.file = out,
706 };
707 int nbufs = pipe->buffers;
708 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
709 GFP_KERNEL);
710 ssize_t ret;
711
712 if (unlikely(!array))
713 return -ENOMEM;
714
715 pipe_lock(pipe);
716
717 splice_from_pipe_begin(&sd);
718 while (sd.total_len) {
719 struct iov_iter from;
Al Viro8d020762014-04-05 04:27:08 -0400720 size_t left;
721 int n, idx;
722
723 ret = splice_from_pipe_next(pipe, &sd);
724 if (ret <= 0)
725 break;
726
727 if (unlikely(nbufs < pipe->buffers)) {
728 kfree(array);
729 nbufs = pipe->buffers;
730 array = kcalloc(nbufs, sizeof(struct bio_vec),
731 GFP_KERNEL);
732 if (!array) {
733 ret = -ENOMEM;
734 break;
735 }
736 }
737
738 /* build the vector */
739 left = sd.total_len;
740 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
741 struct pipe_buffer *buf = pipe->bufs + idx;
742 size_t this_len = buf->len;
743
744 if (this_len > left)
745 this_len = left;
746
747 if (idx == pipe->buffers - 1)
748 idx = -1;
749
Miklos Szeredifba597d2016-09-27 10:45:12 +0200750 ret = pipe_buf_confirm(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400751 if (unlikely(ret)) {
752 if (ret == -ENODATA)
753 ret = 0;
754 goto done;
755 }
756
757 array[n].bv_page = buf->page;
758 array[n].bv_len = this_len;
759 array[n].bv_offset = buf->offset;
760 left -= this_len;
761 }
762
Al Viro05afcb72015-01-23 01:08:07 -0500763 iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
764 sd.total_len - left);
Christoph Hellwigabbb65892017-05-27 11:16:52 +0300765 ret = vfs_iter_write(out, &from, &sd.pos, 0);
Al Viro8d020762014-04-05 04:27:08 -0400766 if (ret <= 0)
767 break;
768
769 sd.num_spliced += ret;
770 sd.total_len -= ret;
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100771 *ppos = sd.pos;
Al Viro8d020762014-04-05 04:27:08 -0400772
773 /* dismiss the fully eaten buffers, adjust the partial one */
774 while (ret) {
775 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
776 if (ret >= buf->len) {
Al Viro8d020762014-04-05 04:27:08 -0400777 ret -= buf->len;
778 buf->len = 0;
Miklos Szeredia7796382016-09-27 10:45:12 +0200779 pipe_buf_release(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400780 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
781 pipe->nrbufs--;
782 if (pipe->files)
783 sd.need_wakeup = true;
784 } else {
785 buf->offset += ret;
786 buf->len -= ret;
787 ret = 0;
788 }
789 }
790 }
791done:
792 kfree(array);
793 splice_from_pipe_end(pipe, &sd);
794
795 pipe_unlock(pipe);
796
797 if (sd.num_spliced)
798 ret = sd.num_spliced;
799
800 return ret;
801}
802
803EXPORT_SYMBOL(iter_file_splice_write);
804
Miklos Szeredib2858d72009-05-19 11:37:46 +0200805static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
806 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200807{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200808 int ret;
809 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -0400810 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +0200811
Al Virofbb32752014-02-02 21:09:54 -0500812 data = kmap(buf->page);
Al Viro06ae43f2013-03-20 13:19:30 -0400813 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Al Virofbb32752014-02-02 21:09:54 -0500814 kunmap(buf->page);
Miklos Szeredib2858d72009-05-19 11:37:46 +0200815
816 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200817}
818
819static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
820 struct file *out, loff_t *ppos,
821 size_t len, unsigned int flags)
822{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200823 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200824
Miklos Szeredib2858d72009-05-19 11:37:46 +0200825 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
826 if (ret > 0)
827 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200828
Miklos Szeredib2858d72009-05-19 11:37:46 +0200829 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200830}
831
Jens Axboe83f91352006-04-02 23:05:09 +0200832/**
833 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200834 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200835 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200836 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200837 * @len: number of bytes to splice
838 * @flags: splice modifier flags
839 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200840 * Description:
841 * Will send @len bytes from the pipe to a network socket. No data copying
842 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200843 *
844 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200845ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200846 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200847{
Jens Axboe00522fb2006-04-26 14:39:29 +0200848 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200849}
850
Jens Axboe059a8f32006-04-02 23:06:05 +0200851EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500852
Jens Axboe83f91352006-04-02 23:05:09 +0200853/*
854 * Attempt to initiate a splice from pipe to file.
855 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200856static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200857 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200858{
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200859 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
860 loff_t *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200861
Al Viro72c2d532013-09-22 16:27:52 -0400862 if (out->f_op->splice_write)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100863 splice_write = out->f_op->splice_write;
864 else
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200865 splice_write = default_file_splice_write;
866
Al Viro500368f2013-05-23 20:07:11 -0400867 return splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200868}
869
Jens Axboe83f91352006-04-02 23:05:09 +0200870/*
871 * Attempt to initiate a splice from a file to a pipe.
872 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200873static long do_splice_to(struct file *in, loff_t *ppos,
874 struct pipe_inode_info *pipe, size_t len,
875 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200876{
Miklos Szeredi68181732009-05-07 15:37:36 +0200877 ssize_t (*splice_read)(struct file *, loff_t *,
878 struct pipe_inode_info *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200879 int ret;
880
Jens Axboe49570e92006-04-11 13:56:09 +0200881 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200882 return -EBADF;
883
Jens Axboecbb7e572006-04-11 14:57:50 +0200884 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200885 if (unlikely(ret < 0))
886 return ret;
887
Al Viro03cc0782016-04-02 14:56:58 -0400888 if (unlikely(len > MAX_RW_COUNT))
889 len = MAX_RW_COUNT;
890
Al Viro72c2d532013-09-22 16:27:52 -0400891 if (in->f_op->splice_read)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100892 splice_read = in->f_op->splice_read;
893 else
Miklos Szeredi68181732009-05-07 15:37:36 +0200894 splice_read = default_file_splice_read;
895
896 return splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200897}
898
Jens Axboe932cc6d2007-06-21 13:10:21 +0200899/**
900 * splice_direct_to_actor - splices data directly between two non-pipes
901 * @in: file to splice from
902 * @sd: actor information on where to splice to
903 * @actor: handles the data splicing
904 *
905 * Description:
906 * This is a special case helper to splice directly between two
907 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200908 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200909 * that process.
910 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200911 */
912ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
913 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200914{
915 struct pipe_inode_info *pipe;
916 long ret, bytes;
917 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200918 size_t len;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200919 int i, flags, more;
Jens Axboeb92ce552006-04-11 13:52:07 +0200920
921 /*
922 * We require the input being a regular file, as we don't want to
923 * randomly drop data for eg socket -> socket splicing. Use the
924 * piped splicing for that!
925 */
Al Viro496ad9a2013-01-23 17:07:38 -0500926 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200927 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
928 return -EINVAL;
929
930 /*
931 * neither in nor out is a pipe, setup an internal pipe attached to
932 * 'out' and transfer the wanted data from 'in' to 'out' through that
933 */
934 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200935 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -0400936 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +0200937 if (!pipe)
938 return -ENOMEM;
939
940 /*
941 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200942 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200943 * PIPE_READERS appropriately.
944 */
945 pipe->readers = 1;
946
947 current->splice_pipe = pipe;
948 }
949
950 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200951 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200952 */
953 ret = 0;
954 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200955 len = sd->total_len;
956 flags = sd->flags;
957
958 /*
959 * Don't block on output, we have to drain the direct pipe.
960 */
961 sd->flags &= ~SPLICE_F_NONBLOCK;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200962 more = sd->flags & SPLICE_F_MORE;
Jens Axboeb92ce552006-04-11 13:52:07 +0200963
964 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +0200965 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200966 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200967
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200968 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200969 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +0200970 goto out_release;
971
972 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200973 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +0200974
975 /*
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200976 * If more data is pending, set SPLICE_F_MORE
977 * If this is the last data and SPLICE_F_MORE was not set
978 * initially, clears it.
979 */
980 if (read_len < len)
981 sd->flags |= SPLICE_F_MORE;
982 else if (!more)
983 sd->flags &= ~SPLICE_F_MORE;
984 /*
Jens Axboeb92ce552006-04-11 13:52:07 +0200985 * NOTE: nonblocking mode only applies to the input. We
986 * must not do the output in nonblocking mode as then we
987 * could get stuck data in the internal pipe:
988 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200989 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +0200990 if (unlikely(ret <= 0)) {
991 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200992 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200993 }
Jens Axboeb92ce552006-04-11 13:52:07 +0200994
995 bytes += ret;
996 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200997 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200998
Tom Zanussia82c53a2008-05-09 13:28:36 +0200999 if (ret < read_len) {
1000 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001001 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001002 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001003 }
1004
Jens Axboe9e971982008-01-29 21:05:57 +01001005done:
Jens Axboeb92ce552006-04-11 13:52:07 +02001006 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001007 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001008 return bytes;
1009
1010out_release:
1011 /*
1012 * If we did an incomplete transfer we must release
1013 * the pipe buffers in question:
1014 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001015 for (i = 0; i < pipe->buffers; i++) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001016 struct pipe_buffer *buf = pipe->bufs + i;
1017
Miklos Szeredia7796382016-09-27 10:45:12 +02001018 if (buf->ops)
1019 pipe_buf_release(pipe, buf);
Jens Axboeb92ce552006-04-11 13:52:07 +02001020 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001021
Jens Axboe9e971982008-01-29 21:05:57 +01001022 if (!bytes)
1023 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001024
Jens Axboe9e971982008-01-29 21:05:57 +01001025 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001026}
1027EXPORT_SYMBOL(splice_direct_to_actor);
1028
1029static int direct_splice_actor(struct pipe_inode_info *pipe,
1030 struct splice_desc *sd)
1031{
Jens Axboe6a14b902007-06-14 13:08:55 +02001032 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001033
Al Viro7995bd22013-06-20 18:58:36 +04001034 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001035 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001036}
1037
Jens Axboe932cc6d2007-06-21 13:10:21 +02001038/**
1039 * do_splice_direct - splices data directly between two files
1040 * @in: file to splice from
1041 * @ppos: input file offset
1042 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001043 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001044 * @len: number of bytes to splice
1045 * @flags: splice modifier flags
1046 *
1047 * Description:
1048 * For use by do_sendfile(). splice can easily emulate sendfile, but
1049 * doing it in the application would incur an extra system call
1050 * (splice in + splice out, as compared to just sendfile()). So this helper
1051 * can splice directly through a process-private pipe.
1052 *
1053 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001054long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001055 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001056{
1057 struct splice_desc sd = {
1058 .len = len,
1059 .total_len = len,
1060 .flags = flags,
1061 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001062 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001063 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001064 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001065 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001066
Al Viro18c67cb2013-06-19 15:41:54 +04001067 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1068 return -EBADF;
1069
1070 if (unlikely(out->f_flags & O_APPEND))
1071 return -EINVAL;
1072
1073 ret = rw_verify_area(WRITE, out, opos, len);
1074 if (unlikely(ret < 0))
1075 return ret;
1076
Jens Axboec66ab6f2007-06-12 21:17:17 +02001077 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001078 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001079 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001080
Jens Axboec66ab6f2007-06-12 21:17:17 +02001081 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001082}
Miklos Szeredi1c118592014-10-24 00:14:35 +02001083EXPORT_SYMBOL(do_splice_direct);
Jens Axboeb92ce552006-04-11 13:52:07 +02001084
Al Viro8924fef2016-09-17 20:44:45 -04001085static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1086{
Linus Torvalds52bce912016-12-21 10:59:34 -08001087 for (;;) {
1088 if (unlikely(!pipe->readers)) {
1089 send_sig(SIGPIPE, current, 0);
1090 return -EPIPE;
1091 }
1092 if (pipe->nrbufs != pipe->buffers)
1093 return 0;
Al Viro8924fef2016-09-17 20:44:45 -04001094 if (flags & SPLICE_F_NONBLOCK)
1095 return -EAGAIN;
1096 if (signal_pending(current))
1097 return -ERESTARTSYS;
1098 pipe->waiting_writers++;
1099 pipe_wait(pipe);
1100 pipe->waiting_writers--;
1101 }
Al Viro8924fef2016-09-17 20:44:45 -04001102}
1103
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001104static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1105 struct pipe_inode_info *opipe,
1106 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001107
1108/*
Jens Axboe83f91352006-04-02 23:05:09 +02001109 * Determine where to splice to/from.
1110 */
Ingo Molnar529565dc2006-04-10 15:18:58 +02001111static long do_splice(struct file *in, loff_t __user *off_in,
1112 struct file *out, loff_t __user *off_out,
1113 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001114{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001115 struct pipe_inode_info *ipipe;
1116 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001117 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001118 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001119
Linus Torvalds71993e62010-11-28 13:56:09 -08001120 ipipe = get_pipe_info(in);
1121 opipe = get_pipe_info(out);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001122
1123 if (ipipe && opipe) {
1124 if (off_in || off_out)
1125 return -ESPIPE;
1126
1127 if (!(in->f_mode & FMODE_READ))
1128 return -EBADF;
1129
1130 if (!(out->f_mode & FMODE_WRITE))
1131 return -EBADF;
1132
1133 /* Splicing to self would be fun, but... */
1134 if (ipipe == opipe)
1135 return -EINVAL;
1136
1137 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1138 }
1139
1140 if (ipipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001141 if (off_in)
1142 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001143 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001144 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001145 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001146 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001147 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001148 } else {
1149 offset = out->f_pos;
1150 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001151
Al Viro18c67cb2013-06-19 15:41:54 +04001152 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1153 return -EBADF;
1154
1155 if (unlikely(out->f_flags & O_APPEND))
1156 return -EINVAL;
1157
1158 ret = rw_verify_area(WRITE, out, &offset, len);
1159 if (unlikely(ret < 0))
1160 return ret;
1161
Al Viro500368f2013-05-23 20:07:11 -04001162 file_start_write(out);
Al Viro7995bd22013-06-20 18:58:36 +04001163 ret = do_splice_from(ipipe, out, &offset, len, flags);
Al Viro500368f2013-05-23 20:07:11 -04001164 file_end_write(out);
Jens Axboea4514eb2006-04-19 15:57:05 +02001165
Al Viro7995bd22013-06-20 18:58:36 +04001166 if (!off_out)
1167 out->f_pos = offset;
1168 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001169 ret = -EFAULT;
1170
1171 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001172 }
Jens Axboe5274f052006-03-30 15:15:30 +02001173
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001174 if (opipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001175 if (off_out)
1176 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001177 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001178 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001179 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001180 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001181 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001182 } else {
1183 offset = in->f_pos;
1184 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001185
Al Viro8924fef2016-09-17 20:44:45 -04001186 pipe_lock(opipe);
1187 ret = wait_for_space(opipe, flags);
1188 if (!ret)
1189 ret = do_splice_to(in, &offset, opipe, len, flags);
1190 pipe_unlock(opipe);
1191 if (ret > 0)
1192 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001193 if (!off_in)
1194 in->f_pos = offset;
1195 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001196 ret = -EFAULT;
1197
1198 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001199 }
Jens Axboe5274f052006-03-30 15:15:30 +02001200
1201 return -EINVAL;
1202}
1203
Al Viro79fddc42016-09-17 22:38:20 -04001204static int iter_to_pipe(struct iov_iter *from,
1205 struct pipe_inode_info *pipe,
1206 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001207{
Al Viro79fddc42016-09-17 22:38:20 -04001208 struct pipe_buffer buf = {
1209 .ops = &user_page_pipe_buf_ops,
1210 .flags = flags
1211 };
1212 size_t total = 0;
1213 int ret = 0;
1214 bool failed = false;
1215
1216 while (iov_iter_count(from) && !failed) {
1217 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001218 ssize_t copied;
1219 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001220 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001221
Al Viro79fddc42016-09-17 22:38:20 -04001222 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1223 if (copied <= 0) {
1224 ret = copied;
1225 break;
1226 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001227
Al Viro79fddc42016-09-17 22:38:20 -04001228 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001229 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001230 if (!failed) {
1231 buf.page = pages[n];
1232 buf.offset = start;
1233 buf.len = size;
1234 ret = add_to_pipe(pipe, &buf);
1235 if (unlikely(ret < 0)) {
1236 failed = true;
1237 } else {
1238 iov_iter_advance(from, ret);
1239 total += ret;
1240 }
1241 } else {
1242 put_page(pages[n]);
1243 }
Al Virodb85a9e2016-09-17 20:25:06 -04001244 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001245 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001246 }
Al Viro79fddc42016-09-17 22:38:20 -04001247 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001248}
1249
Jens Axboe6a14b902007-06-14 13:08:55 +02001250static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1251 struct splice_desc *sd)
1252{
Al Viro6130f532014-02-03 18:19:51 -05001253 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1254 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001255}
1256
1257/*
1258 * For lack of a better implementation, implement vmsplice() to userspace
1259 * as a simple copy of the pipes pages to the user iov.
1260 */
Al Viro6130f532014-02-03 18:19:51 -05001261static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001262 unsigned long nr_segs, unsigned int flags)
1263{
1264 struct pipe_inode_info *pipe;
1265 struct splice_desc sd;
Jens Axboe6a14b902007-06-14 13:08:55 +02001266 long ret;
Al Viro6130f532014-02-03 18:19:51 -05001267 struct iovec iovstack[UIO_FASTIOV];
1268 struct iovec *iov = iovstack;
1269 struct iov_iter iter;
Jens Axboe6a14b902007-06-14 13:08:55 +02001270
Linus Torvalds71993e62010-11-28 13:56:09 -08001271 pipe = get_pipe_info(file);
Jens Axboe6a14b902007-06-14 13:08:55 +02001272 if (!pipe)
1273 return -EBADF;
1274
Al Viro345995f2015-03-21 19:17:55 -04001275 ret = import_iovec(READ, uiov, nr_segs,
1276 ARRAY_SIZE(iovstack), &iov, &iter);
1277 if (ret < 0)
1278 return ret;
Al Viro6130f532014-02-03 18:19:51 -05001279
Al Viro345995f2015-03-21 19:17:55 -04001280 sd.total_len = iov_iter_count(&iter);
Al Viro6130f532014-02-03 18:19:51 -05001281 sd.len = 0;
Al Viro6130f532014-02-03 18:19:51 -05001282 sd.flags = flags;
1283 sd.u.data = &iter;
1284 sd.pos = 0;
1285
Al Viro345995f2015-03-21 19:17:55 -04001286 if (sd.total_len) {
1287 pipe_lock(pipe);
1288 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1289 pipe_unlock(pipe);
1290 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001291
Al Viro345995f2015-03-21 19:17:55 -04001292 kfree(iov);
Jens Axboe6a14b902007-06-14 13:08:55 +02001293 return ret;
1294}
1295
Jens Axboe912d35f2006-04-26 10:59:21 +02001296/*
1297 * vmsplice splices a user address range into a pipe. It can be thought of
1298 * as splice-from-memory, where the regular splice is splice-from-file (or
1299 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001300 */
Al Virodb85a9e2016-09-17 20:25:06 -04001301static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001302 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001303{
Jens Axboeddac0d32006-11-04 12:49:32 +01001304 struct pipe_inode_info *pipe;
Al Virodb85a9e2016-09-17 20:25:06 -04001305 struct iovec iovstack[UIO_FASTIOV];
1306 struct iovec *iov = iovstack;
1307 struct iov_iter from;
Jens Axboe35f3d142010-05-20 10:43:18 +02001308 long ret;
Al Viro79fddc42016-09-17 22:38:20 -04001309 unsigned buf_flag = 0;
1310
1311 if (flags & SPLICE_F_GIFT)
1312 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001313
Linus Torvalds71993e62010-11-28 13:56:09 -08001314 pipe = get_pipe_info(file);
Jens Axboeddac0d32006-11-04 12:49:32 +01001315 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001316 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001317
Al Virodb85a9e2016-09-17 20:25:06 -04001318 ret = import_iovec(WRITE, uiov, nr_segs,
1319 ARRAY_SIZE(iovstack), &iov, &from);
1320 if (ret < 0)
1321 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001322
Al Viro8924fef2016-09-17 20:44:45 -04001323 pipe_lock(pipe);
1324 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001325 if (!ret)
1326 ret = iter_to_pipe(&from, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001327 pipe_unlock(pipe);
1328 if (ret > 0)
1329 wakeup_pipe_readers(pipe);
Al Virodb85a9e2016-09-17 20:25:06 -04001330 kfree(iov);
Jens Axboe35f3d142010-05-20 10:43:18 +02001331 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001332}
1333
Jens Axboe6a14b902007-06-14 13:08:55 +02001334/*
1335 * Note that vmsplice only really supports true splicing _from_ user memory
1336 * to a pipe, not the other way around. Splicing from user memory is a simple
1337 * operation that can be supported without any funky alignment restrictions
1338 * or nasty vm tricks. We simply map in the user memory and fill them into
1339 * a pipe. The reverse isn't quite as easy, though. There are two possible
1340 * solutions for that:
1341 *
1342 * - memcpy() the data internally, at which point we might as well just
1343 * do a regular read() on the buffer anyway.
1344 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1345 * has restriction limitations on both ends of the pipe).
1346 *
1347 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1348 *
1349 */
Heiko Carstens836f92a2009-01-14 14:14:33 +01001350SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1351 unsigned long, nr_segs, unsigned int, flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001352{
Al Viro2903ff02012-08-28 12:52:22 -04001353 struct fd f;
Jens Axboe912d35f2006-04-26 10:59:21 +02001354 long error;
Jens Axboe912d35f2006-04-26 10:59:21 +02001355
Al Viro3d6ea292016-12-10 13:17:32 -05001356 if (unlikely(flags & ~SPLICE_F_ALL))
1357 return -EINVAL;
Jens Axboe6a14b902007-06-14 13:08:55 +02001358 if (unlikely(nr_segs > UIO_MAXIOV))
1359 return -EINVAL;
1360 else if (unlikely(!nr_segs))
1361 return 0;
1362
Jens Axboe912d35f2006-04-26 10:59:21 +02001363 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001364 f = fdget(fd);
1365 if (f.file) {
1366 if (f.file->f_mode & FMODE_WRITE)
1367 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1368 else if (f.file->f_mode & FMODE_READ)
1369 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001370
Al Viro2903ff02012-08-28 12:52:22 -04001371 fdput(f);
Jens Axboe912d35f2006-04-26 10:59:21 +02001372 }
1373
1374 return error;
1375}
1376
Al Viro76b021d2013-03-02 10:19:56 -05001377#ifdef CONFIG_COMPAT
1378COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1379 unsigned int, nr_segs, unsigned int, flags)
1380{
1381 unsigned i;
1382 struct iovec __user *iov;
1383 if (nr_segs > UIO_MAXIOV)
1384 return -EINVAL;
1385 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1386 for (i = 0; i < nr_segs; i++) {
1387 struct compat_iovec v;
1388 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1389 get_user(v.iov_len, &iov32[i].iov_len) ||
1390 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1391 put_user(v.iov_len, &iov[i].iov_len))
1392 return -EFAULT;
1393 }
1394 return sys_vmsplice(fd, iov, nr_segs, flags);
1395}
1396#endif
1397
Heiko Carstens836f92a2009-01-14 14:14:33 +01001398SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1399 int, fd_out, loff_t __user *, off_out,
1400 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001401{
Al Viro2903ff02012-08-28 12:52:22 -04001402 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001403 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001404
1405 if (unlikely(!len))
1406 return 0;
1407
Al Viro3d6ea292016-12-10 13:17:32 -05001408 if (unlikely(flags & ~SPLICE_F_ALL))
1409 return -EINVAL;
1410
Jens Axboe5274f052006-03-30 15:15:30 +02001411 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001412 in = fdget(fd_in);
1413 if (in.file) {
1414 if (in.file->f_mode & FMODE_READ) {
1415 out = fdget(fd_out);
1416 if (out.file) {
1417 if (out.file->f_mode & FMODE_WRITE)
1418 error = do_splice(in.file, off_in,
1419 out.file, off_out,
Ingo Molnar529565dc2006-04-10 15:18:58 +02001420 len, flags);
Al Viro2903ff02012-08-28 12:52:22 -04001421 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001422 }
1423 }
Al Viro2903ff02012-08-28 12:52:22 -04001424 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001425 }
Jens Axboe5274f052006-03-30 15:15:30 +02001426 return error;
1427}
Jens Axboe70524492006-04-11 15:51:17 +02001428
1429/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001430 * Make sure there's data to read. Wait for input if we can, otherwise
1431 * return an appropriate error.
1432 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001433static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001434{
1435 int ret;
1436
1437 /*
1438 * Check ->nrbufs without the inode lock first. This function
1439 * is speculative anyways, so missing one is ok.
1440 */
1441 if (pipe->nrbufs)
1442 return 0;
1443
1444 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001445 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001446
1447 while (!pipe->nrbufs) {
1448 if (signal_pending(current)) {
1449 ret = -ERESTARTSYS;
1450 break;
1451 }
1452 if (!pipe->writers)
1453 break;
1454 if (!pipe->waiting_writers) {
1455 if (flags & SPLICE_F_NONBLOCK) {
1456 ret = -EAGAIN;
1457 break;
1458 }
1459 }
1460 pipe_wait(pipe);
1461 }
1462
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001463 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001464 return ret;
1465}
1466
1467/*
1468 * Make sure there's writeable room. Wait for room if we can, otherwise
1469 * return an appropriate error.
1470 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001471static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001472{
1473 int ret;
1474
1475 /*
1476 * Check ->nrbufs without the inode lock first. This function
1477 * is speculative anyways, so missing one is ok.
1478 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001479 if (pipe->nrbufs < pipe->buffers)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001480 return 0;
1481
1482 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001483 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001484
Jens Axboe35f3d142010-05-20 10:43:18 +02001485 while (pipe->nrbufs >= pipe->buffers) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001486 if (!pipe->readers) {
1487 send_sig(SIGPIPE, current, 0);
1488 ret = -EPIPE;
1489 break;
1490 }
1491 if (flags & SPLICE_F_NONBLOCK) {
1492 ret = -EAGAIN;
1493 break;
1494 }
1495 if (signal_pending(current)) {
1496 ret = -ERESTARTSYS;
1497 break;
1498 }
1499 pipe->waiting_writers++;
1500 pipe_wait(pipe);
1501 pipe->waiting_writers--;
1502 }
1503
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001504 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001505 return ret;
1506}
1507
1508/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001509 * Splice contents of ipipe to opipe.
1510 */
1511static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1512 struct pipe_inode_info *opipe,
1513 size_t len, unsigned int flags)
1514{
1515 struct pipe_buffer *ibuf, *obuf;
1516 int ret = 0, nbuf;
1517 bool input_wakeup = false;
1518
1519
1520retry:
1521 ret = ipipe_prep(ipipe, flags);
1522 if (ret)
1523 return ret;
1524
1525 ret = opipe_prep(opipe, flags);
1526 if (ret)
1527 return ret;
1528
1529 /*
1530 * Potential ABBA deadlock, work around it by ordering lock
1531 * grabbing by pipe info address. Otherwise two different processes
1532 * could deadlock (one doing tee from A -> B, the other from B -> A).
1533 */
1534 pipe_double_lock(ipipe, opipe);
1535
1536 do {
1537 if (!opipe->readers) {
1538 send_sig(SIGPIPE, current, 0);
1539 if (!ret)
1540 ret = -EPIPE;
1541 break;
1542 }
1543
1544 if (!ipipe->nrbufs && !ipipe->writers)
1545 break;
1546
1547 /*
1548 * Cannot make any progress, because either the input
1549 * pipe is empty or the output pipe is full.
1550 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001551 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001552 /* Already processed some buffers, break */
1553 if (ret)
1554 break;
1555
1556 if (flags & SPLICE_F_NONBLOCK) {
1557 ret = -EAGAIN;
1558 break;
1559 }
1560
1561 /*
1562 * We raced with another reader/writer and haven't
1563 * managed to process any buffers. A zero return
1564 * value means EOF, so retry instead.
1565 */
1566 pipe_unlock(ipipe);
1567 pipe_unlock(opipe);
1568 goto retry;
1569 }
1570
1571 ibuf = ipipe->bufs + ipipe->curbuf;
Jens Axboe35f3d142010-05-20 10:43:18 +02001572 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001573 obuf = opipe->bufs + nbuf;
1574
1575 if (len >= ibuf->len) {
1576 /*
1577 * Simply move the whole buffer from ipipe to opipe
1578 */
1579 *obuf = *ibuf;
1580 ibuf->ops = NULL;
1581 opipe->nrbufs++;
Jens Axboe35f3d142010-05-20 10:43:18 +02001582 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001583 ipipe->nrbufs--;
1584 input_wakeup = true;
1585 } else {
1586 /*
1587 * Get a reference to this pipe buffer,
1588 * so we can copy the contents over.
1589 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001590 pipe_buf_get(ipipe, ibuf);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001591 *obuf = *ibuf;
1592
1593 /*
1594 * Don't inherit the gift flag, we need to
1595 * prevent multiple steals of this page.
1596 */
1597 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1598
1599 obuf->len = len;
1600 opipe->nrbufs++;
1601 ibuf->offset += obuf->len;
1602 ibuf->len -= obuf->len;
1603 }
1604 ret += obuf->len;
1605 len -= obuf->len;
1606 } while (len);
1607
1608 pipe_unlock(ipipe);
1609 pipe_unlock(opipe);
1610
1611 /*
1612 * If we put data in the output pipe, wakeup any potential readers.
1613 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001614 if (ret > 0)
1615 wakeup_pipe_readers(opipe);
1616
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001617 if (input_wakeup)
1618 wakeup_pipe_writers(ipipe);
1619
1620 return ret;
1621}
1622
1623/*
Jens Axboe70524492006-04-11 15:51:17 +02001624 * Link contents of ipipe to opipe.
1625 */
1626static int link_pipe(struct pipe_inode_info *ipipe,
1627 struct pipe_inode_info *opipe,
1628 size_t len, unsigned int flags)
1629{
1630 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001631 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001632
1633 /*
1634 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001635 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001636 * could deadlock (one doing tee from A -> B, the other from B -> A).
1637 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001638 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001639
Jens Axboeaadd06e2006-07-10 11:00:01 +02001640 do {
Jens Axboe70524492006-04-11 15:51:17 +02001641 if (!opipe->readers) {
1642 send_sig(SIGPIPE, current, 0);
1643 if (!ret)
1644 ret = -EPIPE;
1645 break;
1646 }
Jens Axboe70524492006-04-11 15:51:17 +02001647
1648 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001649 * If we have iterated all input buffers or ran out of
1650 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001651 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001652 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
Jens Axboe70524492006-04-11 15:51:17 +02001653 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001654
Jens Axboe35f3d142010-05-20 10:43:18 +02001655 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1656 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001657
Jens Axboe2a27250e2006-04-19 15:56:40 +02001658 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001659 * Get a reference to this pipe buffer,
1660 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001661 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001662 pipe_buf_get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001663
Jens Axboeaadd06e2006-07-10 11:00:01 +02001664 obuf = opipe->bufs + nbuf;
1665 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001666
Jens Axboeaadd06e2006-07-10 11:00:01 +02001667 /*
1668 * Don't inherit the gift flag, we need to
1669 * prevent multiple steals of this page.
1670 */
1671 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1672
1673 if (obuf->len > len)
1674 obuf->len = len;
1675
1676 opipe->nrbufs++;
1677 ret += obuf->len;
1678 len -= obuf->len;
1679 i++;
1680 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001681
Jens Axboe02cf01a2008-02-20 10:34:51 +01001682 /*
1683 * return EAGAIN if we have the potential of some data in the
1684 * future, otherwise just return 0
1685 */
1686 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1687 ret = -EAGAIN;
1688
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001689 pipe_unlock(ipipe);
1690 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001691
Jens Axboeaadd06e2006-07-10 11:00:01 +02001692 /*
1693 * If we put data in the output pipe, wakeup any potential readers.
1694 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001695 if (ret > 0)
1696 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001697
1698 return ret;
1699}
1700
1701/*
1702 * This is a tee(1) implementation that works on pipes. It doesn't copy
1703 * any data, it simply references the 'in' pages on the 'out' pipe.
1704 * The 'flags' used are the SPLICE_F_* variants, currently the only
1705 * applicable one is SPLICE_F_NONBLOCK.
1706 */
1707static long do_tee(struct file *in, struct file *out, size_t len,
1708 unsigned int flags)
1709{
Linus Torvalds71993e62010-11-28 13:56:09 -08001710 struct pipe_inode_info *ipipe = get_pipe_info(in);
1711 struct pipe_inode_info *opipe = get_pipe_info(out);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001712 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001713
1714 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001715 * Duplicate the contents of ipipe to opipe without actually
1716 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001717 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001718 if (ipipe && opipe && ipipe != opipe) {
1719 /*
1720 * Keep going, unless we encounter an error. The ipipe/opipe
1721 * ordering doesn't really matter.
1722 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001723 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001724 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001725 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001726 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001727 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001728 }
1729 }
Jens Axboe70524492006-04-11 15:51:17 +02001730
Jens Axboeaadd06e2006-07-10 11:00:01 +02001731 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001732}
1733
Heiko Carstens836f92a2009-01-14 14:14:33 +01001734SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001735{
Al Viro2903ff02012-08-28 12:52:22 -04001736 struct fd in;
1737 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001738
Al Viro3d6ea292016-12-10 13:17:32 -05001739 if (unlikely(flags & ~SPLICE_F_ALL))
1740 return -EINVAL;
1741
Jens Axboe70524492006-04-11 15:51:17 +02001742 if (unlikely(!len))
1743 return 0;
1744
1745 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001746 in = fdget(fdin);
1747 if (in.file) {
1748 if (in.file->f_mode & FMODE_READ) {
1749 struct fd out = fdget(fdout);
1750 if (out.file) {
1751 if (out.file->f_mode & FMODE_WRITE)
1752 error = do_tee(in.file, out.file,
1753 len, flags);
1754 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001755 }
1756 }
Al Viro2903ff02012-08-28 12:52:22 -04001757 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001758 }
1759
1760 return error;
1761}