blob: 006ba50f4ece671f48367b644641ab58b04b65d8 [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
Hugh Dickins708e3502011-07-25 17:12:32 -0700250void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800251{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300252 put_page(spd->pages[i]);
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800253}
254
Jens Axboe35f3d142010-05-20 10:43:18 +0200255/*
256 * Check if we need to grow the arrays holding pages and partial page
257 * descriptions.
258 */
Eric Dumazet047fe362012-06-12 15:24:40 +0200259int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200260{
Eric Dumazet047fe362012-06-12 15:24:40 +0200261 unsigned int buffers = ACCESS_ONCE(pipe->buffers);
262
263 spd->nr_pages_max = buffers;
264 if (buffers <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200265 return 0;
266
Eric Dumazet047fe362012-06-12 15:24:40 +0200267 spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
268 spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200269
270 if (spd->pages && spd->partial)
271 return 0;
272
273 kfree(spd->pages);
274 kfree(spd->partial);
275 return -ENOMEM;
276}
277
Eric Dumazet047fe362012-06-12 15:24:40 +0200278void splice_shrink_spd(struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200279{
Eric Dumazet047fe362012-06-12 15:24:40 +0200280 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200281 return;
282
283 kfree(spd->pages);
284 kfree(spd->partial);
285}
286
Jens Axboe83f91352006-04-02 23:05:09 +0200287/**
288 * generic_file_splice_read - splice data from file to a pipe
289 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200290 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200291 * @pipe: pipe to splice to
292 * @len: number of bytes to splice
293 * @flags: splice modifier flags
294 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200295 * Description:
296 * Will read pages from given file and fill them into a pipe. Can be
Al Viro82c156f2016-09-22 23:35:42 -0400297 * used as long as it has more or less sane ->read_iter().
Jens Axboe932cc6d2007-06-21 13:10:21 +0200298 *
Jens Axboe83f91352006-04-02 23:05:09 +0200299 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200300ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
301 struct pipe_inode_info *pipe, size_t len,
302 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200303{
Al Viro82c156f2016-09-22 23:35:42 -0400304 struct iov_iter to;
305 struct kiocb kiocb;
Al Viro82c156f2016-09-22 23:35:42 -0400306 int idx, ret;
Boaz Harroshbe64f882015-04-15 16:15:17 -0700307
Al Viro82c156f2016-09-22 23:35:42 -0400308 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len);
309 idx = to.idx;
310 init_sync_kiocb(&kiocb, in);
311 kiocb.ki_pos = *ppos;
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100312 ret = call_read_iter(in, &kiocb, &to);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200313 if (ret > 0) {
Al Viro82c156f2016-09-22 23:35:42 -0400314 *ppos = kiocb.ki_pos;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200315 file_accessed(in);
Al Viro82c156f2016-09-22 23:35:42 -0400316 } else if (ret < 0) {
Al Viroc3a69022016-10-10 13:26:27 -0400317 to.idx = idx;
318 to.iov_offset = 0;
319 iov_iter_advance(&to, 0); /* to free what was emitted */
Al Viro82c156f2016-09-22 23:35:42 -0400320 /*
321 * callers of ->splice_read() expect -EAGAIN on
322 * "can't put anything in there", rather than -EFAULT.
323 */
324 if (ret == -EFAULT)
325 ret = -EAGAIN;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200326 }
Jens Axboe5274f052006-03-30 15:15:30 +0200327
328 return ret;
329}
Jens Axboe059a8f32006-04-02 23:06:05 +0200330EXPORT_SYMBOL(generic_file_splice_read);
331
Al Viro241699c2016-09-22 16:33:12 -0400332const struct pipe_buf_operations default_pipe_buf_ops = {
Miklos Szeredi68181732009-05-07 15:37:36 +0200333 .can_merge = 0,
Miklos Szeredi68181732009-05-07 15:37:36 +0200334 .confirm = generic_pipe_buf_confirm,
335 .release = generic_pipe_buf_release,
336 .steal = generic_pipe_buf_steal,
337 .get = generic_pipe_buf_get,
338};
339
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100340static int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
341 struct pipe_buffer *buf)
342{
343 return 1;
344}
345
346/* Pipe buffer operations for a socket and similar. */
347const struct pipe_buf_operations nosteal_pipe_buf_ops = {
348 .can_merge = 0,
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100349 .confirm = generic_pipe_buf_confirm,
350 .release = generic_pipe_buf_release,
351 .steal = generic_pipe_buf_nosteal,
352 .get = generic_pipe_buf_get,
353};
354EXPORT_SYMBOL(nosteal_pipe_buf_ops);
355
Al Viro523ac9a2016-09-23 15:34:57 -0400356static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
Miklos Szeredi68181732009-05-07 15:37:36 +0200357 unsigned long vlen, loff_t offset)
358{
359 mm_segment_t old_fs;
360 loff_t pos = offset;
361 ssize_t res;
362
363 old_fs = get_fs();
364 set_fs(get_ds());
365 /* The cast to a user pointer is valid due to the set_fs() */
Christoph Hellwig793b80e2016-03-03 16:03:58 +0100366 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
Miklos Szeredi68181732009-05-07 15:37:36 +0200367 set_fs(old_fs);
368
369 return res;
370}
371
Al Viro7bb307e2013-02-23 14:51:48 -0500372ssize_t kernel_write(struct file *file, const char *buf, size_t count,
Miklos Szeredib2858d72009-05-19 11:37:46 +0200373 loff_t pos)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200374{
375 mm_segment_t old_fs;
376 ssize_t res;
377
378 old_fs = get_fs();
379 set_fs(get_ds());
380 /* The cast to a user pointer is valid due to the set_fs() */
Al Viro7bb307e2013-02-23 14:51:48 -0500381 res = vfs_write(file, (__force const char __user *)buf, count, &pos);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200382 set_fs(old_fs);
383
384 return res;
385}
Al Viro7bb307e2013-02-23 14:51:48 -0500386EXPORT_SYMBOL(kernel_write);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200387
Al Viro82c156f2016-09-22 23:35:42 -0400388static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
Miklos Szeredi68181732009-05-07 15:37:36 +0200389 struct pipe_inode_info *pipe, size_t len,
390 unsigned int flags)
391{
Al Viro523ac9a2016-09-23 15:34:57 -0400392 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
393 struct iov_iter to;
394 struct page **pages;
Miklos Szeredi68181732009-05-07 15:37:36 +0200395 unsigned int nr_pages;
Al Viro523ac9a2016-09-23 15:34:57 -0400396 size_t offset, dummy, copied = 0;
Miklos Szeredi68181732009-05-07 15:37:36 +0200397 ssize_t res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200398 int i;
Miklos Szeredi68181732009-05-07 15:37:36 +0200399
Al Viro523ac9a2016-09-23 15:34:57 -0400400 if (pipe->nrbufs == pipe->buffers)
401 return -EAGAIN;
402
403 /*
404 * Try to keep page boundaries matching to source pagecache ones -
405 * it probably won't be much help, but...
406 */
407 offset = *ppos & ~PAGE_MASK;
408
409 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
410
411 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &dummy);
412 if (res <= 0)
Jens Axboe35f3d142010-05-20 10:43:18 +0200413 return -ENOMEM;
414
Al Viro8e54cad2016-11-26 20:05:42 -0500415 BUG_ON(dummy);
416 nr_pages = DIV_ROUND_UP(res, PAGE_SIZE);
Al Viro523ac9a2016-09-23 15:34:57 -0400417
Jens Axboe35f3d142010-05-20 10:43:18 +0200418 vec = __vec;
Al Viro523ac9a2016-09-23 15:34:57 -0400419 if (nr_pages > PIPE_DEF_BUFFERS) {
420 vec = kmalloc(nr_pages * sizeof(struct kvec), GFP_KERNEL);
421 if (unlikely(!vec)) {
422 res = -ENOMEM;
423 goto out;
424 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200425 }
426
Al Viro523ac9a2016-09-23 15:34:57 -0400427 pipe->bufs[to.idx].offset = offset;
428 pipe->bufs[to.idx].len -= offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200429
Al Viro523ac9a2016-09-23 15:34:57 -0400430 for (i = 0; i < nr_pages; i++) {
431 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
432 vec[i].iov_base = page_address(pages[i]) + offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200433 vec[i].iov_len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200434 len -= this_len;
435 offset = 0;
436 }
437
Al Viro523ac9a2016-09-23 15:34:57 -0400438 res = kernel_readv(in, vec, nr_pages, *ppos);
439 if (res > 0) {
440 copied = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200441 *ppos += res;
Al Viro523ac9a2016-09-23 15:34:57 -0400442 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200443
Jens Axboe35f3d142010-05-20 10:43:18 +0200444 if (vec != __vec)
445 kfree(vec);
Al Viro523ac9a2016-09-23 15:34:57 -0400446out:
447 for (i = 0; i < nr_pages; i++)
448 put_page(pages[i]);
449 kvfree(pages);
450 iov_iter_advance(&to, copied); /* truncates and discards */
Miklos Szeredi68181732009-05-07 15:37:36 +0200451 return res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200452}
Miklos Szeredi68181732009-05-07 15:37:36 +0200453
Jens Axboe5274f052006-03-30 15:15:30 +0200454/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200455 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200456 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200457 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200458static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200459 struct pipe_buffer *buf, struct splice_desc *sd)
460{
Jens Axboe6a14b902007-06-14 13:08:55 +0200461 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200462 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100463 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200464
Al Viro72c2d532013-09-22 16:27:52 -0400465 if (!likely(file->f_op->sendpage))
Michał Mirosława8adbe32010-12-17 08:56:44 +0100466 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200467
Eric Dumazet35f9c092012-04-05 03:05:35 +0000468 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000469
470 if (sd->len < sd->total_len && pipe->nrbufs > 1)
Eric Dumazet35f9c092012-04-05 03:05:35 +0000471 more |= MSG_SENDPAGE_NOTLAST;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000472
Michał Mirosława8adbe32010-12-17 08:56:44 +0100473 return file->f_op->sendpage(file, buf->page, buf->offset,
474 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200475}
476
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200477static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
478{
479 smp_mb();
480 if (waitqueue_active(&pipe->wait))
481 wake_up_interruptible(&pipe->wait);
482 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
483}
484
485/**
486 * splice_from_pipe_feed - feed available data from a pipe to a file
487 * @pipe: pipe to splice from
488 * @sd: information to @actor
489 * @actor: handler that splices the data
490 *
491 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200492 * This function loops over the pipe and calls @actor to do the
493 * actual moving of a single struct pipe_buffer to the desired
494 * destination. It returns when there's no more buffers left in
495 * the pipe or if the requested number of bytes (@sd->total_len)
496 * have been copied. It returns a positive number (one) if the
497 * pipe needs to be filled with more data, zero if the required
498 * number of bytes have been copied and -errno on error.
499 *
500 * This, together with splice_from_pipe_{begin,end,next}, may be
501 * used to implement the functionality of __splice_from_pipe() when
502 * locking is required around copying the pipe buffers to the
503 * destination.
504 */
Al Viro96f9bc82014-04-05 04:35:49 -0400505static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200506 splice_actor *actor)
507{
508 int ret;
509
510 while (pipe->nrbufs) {
511 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200512
513 sd->len = buf->len;
514 if (sd->len > sd->total_len)
515 sd->len = sd->total_len;
516
Miklos Szeredifba597d2016-09-27 10:45:12 +0200517 ret = pipe_buf_confirm(pipe, buf);
Michał Mirosława8adbe32010-12-17 08:56:44 +0100518 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200519 if (ret == -ENODATA)
520 ret = 0;
521 return ret;
522 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100523
524 ret = actor(pipe, buf, sd);
525 if (ret <= 0)
526 return ret;
527
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200528 buf->offset += ret;
529 buf->len -= ret;
530
531 sd->num_spliced += ret;
532 sd->len -= ret;
533 sd->pos += ret;
534 sd->total_len -= ret;
535
536 if (!buf->len) {
Miklos Szeredia7796382016-09-27 10:45:12 +0200537 pipe_buf_release(pipe, buf);
Jens Axboe35f3d142010-05-20 10:43:18 +0200538 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200539 pipe->nrbufs--;
Al Viro6447a3c2013-03-21 11:01:38 -0400540 if (pipe->files)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200541 sd->need_wakeup = true;
542 }
543
544 if (!sd->total_len)
545 return 0;
546 }
547
548 return 1;
549}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200550
551/**
552 * splice_from_pipe_next - wait for some data to splice from
553 * @pipe: pipe to splice from
554 * @sd: information about the splice operation
555 *
556 * Description:
557 * This function will wait for some data and return a positive
558 * value (one) if pipe buffers are available. It will return zero
559 * or -errno if no more data needs to be spliced.
560 */
Al Viro96f9bc82014-04-05 04:35:49 -0400561static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200562{
Jan Karac725bfc2015-11-23 13:09:50 +0100563 /*
564 * Check for signal early to make process killable when there are
565 * always buffers available
566 */
567 if (signal_pending(current))
568 return -ERESTARTSYS;
569
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200570 while (!pipe->nrbufs) {
571 if (!pipe->writers)
572 return 0;
573
574 if (!pipe->waiting_writers && sd->num_spliced)
575 return 0;
576
577 if (sd->flags & SPLICE_F_NONBLOCK)
578 return -EAGAIN;
579
580 if (signal_pending(current))
581 return -ERESTARTSYS;
582
583 if (sd->need_wakeup) {
584 wakeup_pipe_writers(pipe);
585 sd->need_wakeup = false;
586 }
587
588 pipe_wait(pipe);
589 }
590
591 return 1;
592}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200593
594/**
595 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700596 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200597 *
598 * Description:
599 * This function should be called before a loop containing
600 * splice_from_pipe_next() and splice_from_pipe_feed() to
601 * initialize the necessary fields of @sd.
602 */
Al Viro96f9bc82014-04-05 04:35:49 -0400603static void splice_from_pipe_begin(struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200604{
605 sd->num_spliced = 0;
606 sd->need_wakeup = false;
607}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200608
609/**
610 * splice_from_pipe_end - finish splicing from pipe
611 * @pipe: pipe to splice from
612 * @sd: information about the splice operation
613 *
614 * Description:
615 * This function will wake up pipe writers if necessary. It should
616 * be called after a loop containing splice_from_pipe_next() and
617 * splice_from_pipe_feed().
618 */
Al Viro96f9bc82014-04-05 04:35:49 -0400619static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200620{
621 if (sd->need_wakeup)
622 wakeup_pipe_writers(pipe);
623}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200624
Jens Axboe932cc6d2007-06-21 13:10:21 +0200625/**
626 * __splice_from_pipe - splice data from a pipe to given actor
627 * @pipe: pipe to splice from
628 * @sd: information to @actor
629 * @actor: handler that splices the data
630 *
631 * Description:
632 * This function does little more than loop over the pipe and call
633 * @actor to do the actual moving of a single struct pipe_buffer to
634 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
635 * pipe_to_user.
636 *
Jens Axboe83f91352006-04-02 23:05:09 +0200637 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200638ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
639 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200640{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200641 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200642
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200643 splice_from_pipe_begin(sd);
644 do {
Jan Karac2489e02015-11-23 13:09:51 +0100645 cond_resched();
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200646 ret = splice_from_pipe_next(pipe, sd);
647 if (ret > 0)
648 ret = splice_from_pipe_feed(pipe, sd, actor);
649 } while (ret > 0);
650 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200651
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200652 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200653}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100654EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200655
Jens Axboe932cc6d2007-06-21 13:10:21 +0200656/**
657 * splice_from_pipe - splice data from a pipe to a file
658 * @pipe: pipe to splice from
659 * @out: file to splice to
660 * @ppos: position in @out
661 * @len: how many bytes to splice
662 * @flags: splice modifier flags
663 * @actor: handler that splices the data
664 *
665 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200666 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200667 * otherwise it's identical to __splice_from_pipe().
668 *
669 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200670ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
671 loff_t *ppos, size_t len, unsigned int flags,
672 splice_actor *actor)
673{
674 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200675 struct splice_desc sd = {
676 .total_len = len,
677 .flags = flags,
678 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200679 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200680 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200681
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200682 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200683 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200684 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200685
686 return ret;
687}
688
689/**
Al Viro8d020762014-04-05 04:27:08 -0400690 * iter_file_splice_write - splice data from a pipe to a file
691 * @pipe: pipe info
692 * @out: file to write to
693 * @ppos: position in @out
694 * @len: number of bytes to splice
695 * @flags: splice modifier flags
696 *
697 * Description:
698 * Will either move or copy pages (determined by @flags options) from
699 * the given pipe inode to the given file.
700 * This one is ->write_iter-based.
701 *
702 */
703ssize_t
704iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
705 loff_t *ppos, size_t len, unsigned int flags)
706{
707 struct splice_desc sd = {
708 .total_len = len,
709 .flags = flags,
710 .pos = *ppos,
711 .u.file = out,
712 };
713 int nbufs = pipe->buffers;
714 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
715 GFP_KERNEL);
716 ssize_t ret;
717
718 if (unlikely(!array))
719 return -ENOMEM;
720
721 pipe_lock(pipe);
722
723 splice_from_pipe_begin(&sd);
724 while (sd.total_len) {
725 struct iov_iter from;
Al Viro8d020762014-04-05 04:27:08 -0400726 size_t left;
727 int n, idx;
728
729 ret = splice_from_pipe_next(pipe, &sd);
730 if (ret <= 0)
731 break;
732
733 if (unlikely(nbufs < pipe->buffers)) {
734 kfree(array);
735 nbufs = pipe->buffers;
736 array = kcalloc(nbufs, sizeof(struct bio_vec),
737 GFP_KERNEL);
738 if (!array) {
739 ret = -ENOMEM;
740 break;
741 }
742 }
743
744 /* build the vector */
745 left = sd.total_len;
746 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
747 struct pipe_buffer *buf = pipe->bufs + idx;
748 size_t this_len = buf->len;
749
750 if (this_len > left)
751 this_len = left;
752
753 if (idx == pipe->buffers - 1)
754 idx = -1;
755
Miklos Szeredifba597d2016-09-27 10:45:12 +0200756 ret = pipe_buf_confirm(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400757 if (unlikely(ret)) {
758 if (ret == -ENODATA)
759 ret = 0;
760 goto done;
761 }
762
763 array[n].bv_page = buf->page;
764 array[n].bv_len = this_len;
765 array[n].bv_offset = buf->offset;
766 left -= this_len;
767 }
768
Al Viro05afcb72015-01-23 01:08:07 -0500769 iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
770 sd.total_len - left);
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100771 ret = vfs_iter_write(out, &from, &sd.pos);
Al Viro8d020762014-04-05 04:27:08 -0400772 if (ret <= 0)
773 break;
774
775 sd.num_spliced += ret;
776 sd.total_len -= ret;
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100777 *ppos = sd.pos;
Al Viro8d020762014-04-05 04:27:08 -0400778
779 /* dismiss the fully eaten buffers, adjust the partial one */
780 while (ret) {
781 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
782 if (ret >= buf->len) {
Al Viro8d020762014-04-05 04:27:08 -0400783 ret -= buf->len;
784 buf->len = 0;
Miklos Szeredia7796382016-09-27 10:45:12 +0200785 pipe_buf_release(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400786 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
787 pipe->nrbufs--;
788 if (pipe->files)
789 sd.need_wakeup = true;
790 } else {
791 buf->offset += ret;
792 buf->len -= ret;
793 ret = 0;
794 }
795 }
796 }
797done:
798 kfree(array);
799 splice_from_pipe_end(pipe, &sd);
800
801 pipe_unlock(pipe);
802
803 if (sd.num_spliced)
804 ret = sd.num_spliced;
805
806 return ret;
807}
808
809EXPORT_SYMBOL(iter_file_splice_write);
810
Miklos Szeredib2858d72009-05-19 11:37:46 +0200811static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
812 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200813{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200814 int ret;
815 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -0400816 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +0200817
Al Virofbb32752014-02-02 21:09:54 -0500818 data = kmap(buf->page);
Al Viro06ae43f2013-03-20 13:19:30 -0400819 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Al Virofbb32752014-02-02 21:09:54 -0500820 kunmap(buf->page);
Miklos Szeredib2858d72009-05-19 11:37:46 +0200821
822 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200823}
824
825static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
826 struct file *out, loff_t *ppos,
827 size_t len, unsigned int flags)
828{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200829 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200830
Miklos Szeredib2858d72009-05-19 11:37:46 +0200831 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
832 if (ret > 0)
833 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200834
Miklos Szeredib2858d72009-05-19 11:37:46 +0200835 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200836}
837
Jens Axboe83f91352006-04-02 23:05:09 +0200838/**
839 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200840 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200841 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200842 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200843 * @len: number of bytes to splice
844 * @flags: splice modifier flags
845 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200846 * Description:
847 * Will send @len bytes from the pipe to a network socket. No data copying
848 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200849 *
850 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200851ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200852 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200853{
Jens Axboe00522fb2006-04-26 14:39:29 +0200854 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200855}
856
Jens Axboe059a8f32006-04-02 23:06:05 +0200857EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500858
Jens Axboe83f91352006-04-02 23:05:09 +0200859/*
860 * Attempt to initiate a splice from pipe to file.
861 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200862static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200863 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200864{
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200865 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
866 loff_t *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200867
Al Viro72c2d532013-09-22 16:27:52 -0400868 if (out->f_op->splice_write)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100869 splice_write = out->f_op->splice_write;
870 else
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200871 splice_write = default_file_splice_write;
872
Al Viro500368f2013-05-23 20:07:11 -0400873 return splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200874}
875
Jens Axboe83f91352006-04-02 23:05:09 +0200876/*
877 * Attempt to initiate a splice from a file to a pipe.
878 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200879static long do_splice_to(struct file *in, loff_t *ppos,
880 struct pipe_inode_info *pipe, size_t len,
881 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200882{
Miklos Szeredi68181732009-05-07 15:37:36 +0200883 ssize_t (*splice_read)(struct file *, loff_t *,
884 struct pipe_inode_info *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200885 int ret;
886
Jens Axboe49570e92006-04-11 13:56:09 +0200887 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200888 return -EBADF;
889
Jens Axboecbb7e572006-04-11 14:57:50 +0200890 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200891 if (unlikely(ret < 0))
892 return ret;
893
Al Viro03cc0782016-04-02 14:56:58 -0400894 if (unlikely(len > MAX_RW_COUNT))
895 len = MAX_RW_COUNT;
896
Al Viro72c2d532013-09-22 16:27:52 -0400897 if (in->f_op->splice_read)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100898 splice_read = in->f_op->splice_read;
899 else
Miklos Szeredi68181732009-05-07 15:37:36 +0200900 splice_read = default_file_splice_read;
901
902 return splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200903}
904
Jens Axboe932cc6d2007-06-21 13:10:21 +0200905/**
906 * splice_direct_to_actor - splices data directly between two non-pipes
907 * @in: file to splice from
908 * @sd: actor information on where to splice to
909 * @actor: handles the data splicing
910 *
911 * Description:
912 * This is a special case helper to splice directly between two
913 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200914 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200915 * that process.
916 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200917 */
918ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
919 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200920{
921 struct pipe_inode_info *pipe;
922 long ret, bytes;
923 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200924 size_t len;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200925 int i, flags, more;
Jens Axboeb92ce552006-04-11 13:52:07 +0200926
927 /*
928 * We require the input being a regular file, as we don't want to
929 * randomly drop data for eg socket -> socket splicing. Use the
930 * piped splicing for that!
931 */
Al Viro496ad9a2013-01-23 17:07:38 -0500932 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200933 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
934 return -EINVAL;
935
936 /*
937 * neither in nor out is a pipe, setup an internal pipe attached to
938 * 'out' and transfer the wanted data from 'in' to 'out' through that
939 */
940 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200941 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -0400942 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +0200943 if (!pipe)
944 return -ENOMEM;
945
946 /*
947 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200948 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200949 * PIPE_READERS appropriately.
950 */
951 pipe->readers = 1;
952
953 current->splice_pipe = pipe;
954 }
955
956 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200957 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200958 */
959 ret = 0;
960 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200961 len = sd->total_len;
962 flags = sd->flags;
963
964 /*
965 * Don't block on output, we have to drain the direct pipe.
966 */
967 sd->flags &= ~SPLICE_F_NONBLOCK;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200968 more = sd->flags & SPLICE_F_MORE;
Jens Axboeb92ce552006-04-11 13:52:07 +0200969
970 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +0200971 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200972 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200973
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200974 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200975 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +0200976 goto out_release;
977
978 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200979 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +0200980
981 /*
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200982 * If more data is pending, set SPLICE_F_MORE
983 * If this is the last data and SPLICE_F_MORE was not set
984 * initially, clears it.
985 */
986 if (read_len < len)
987 sd->flags |= SPLICE_F_MORE;
988 else if (!more)
989 sd->flags &= ~SPLICE_F_MORE;
990 /*
Jens Axboeb92ce552006-04-11 13:52:07 +0200991 * NOTE: nonblocking mode only applies to the input. We
992 * must not do the output in nonblocking mode as then we
993 * could get stuck data in the internal pipe:
994 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200995 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +0200996 if (unlikely(ret <= 0)) {
997 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200998 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200999 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001000
1001 bytes += ret;
1002 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001003 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001004
Tom Zanussia82c53a2008-05-09 13:28:36 +02001005 if (ret < read_len) {
1006 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001007 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001008 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001009 }
1010
Jens Axboe9e971982008-01-29 21:05:57 +01001011done:
Jens Axboeb92ce552006-04-11 13:52:07 +02001012 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001013 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001014 return bytes;
1015
1016out_release:
1017 /*
1018 * If we did an incomplete transfer we must release
1019 * the pipe buffers in question:
1020 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001021 for (i = 0; i < pipe->buffers; i++) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001022 struct pipe_buffer *buf = pipe->bufs + i;
1023
Miklos Szeredia7796382016-09-27 10:45:12 +02001024 if (buf->ops)
1025 pipe_buf_release(pipe, buf);
Jens Axboeb92ce552006-04-11 13:52:07 +02001026 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001027
Jens Axboe9e971982008-01-29 21:05:57 +01001028 if (!bytes)
1029 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001030
Jens Axboe9e971982008-01-29 21:05:57 +01001031 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001032}
1033EXPORT_SYMBOL(splice_direct_to_actor);
1034
1035static int direct_splice_actor(struct pipe_inode_info *pipe,
1036 struct splice_desc *sd)
1037{
Jens Axboe6a14b902007-06-14 13:08:55 +02001038 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001039
Al Viro7995bd22013-06-20 18:58:36 +04001040 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001041 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001042}
1043
Jens Axboe932cc6d2007-06-21 13:10:21 +02001044/**
1045 * do_splice_direct - splices data directly between two files
1046 * @in: file to splice from
1047 * @ppos: input file offset
1048 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001049 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001050 * @len: number of bytes to splice
1051 * @flags: splice modifier flags
1052 *
1053 * Description:
1054 * For use by do_sendfile(). splice can easily emulate sendfile, but
1055 * doing it in the application would incur an extra system call
1056 * (splice in + splice out, as compared to just sendfile()). So this helper
1057 * can splice directly through a process-private pipe.
1058 *
1059 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001060long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001061 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001062{
1063 struct splice_desc sd = {
1064 .len = len,
1065 .total_len = len,
1066 .flags = flags,
1067 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001068 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001069 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001070 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001071 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001072
Al Viro18c67cb2013-06-19 15:41:54 +04001073 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1074 return -EBADF;
1075
1076 if (unlikely(out->f_flags & O_APPEND))
1077 return -EINVAL;
1078
1079 ret = rw_verify_area(WRITE, out, opos, len);
1080 if (unlikely(ret < 0))
1081 return ret;
1082
Jens Axboec66ab6f2007-06-12 21:17:17 +02001083 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001084 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001085 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001086
Jens Axboec66ab6f2007-06-12 21:17:17 +02001087 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001088}
Miklos Szeredi1c118592014-10-24 00:14:35 +02001089EXPORT_SYMBOL(do_splice_direct);
Jens Axboeb92ce552006-04-11 13:52:07 +02001090
Al Viro8924fef2016-09-17 20:44:45 -04001091static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1092{
Linus Torvalds52bce912016-12-21 10:59:34 -08001093 for (;;) {
1094 if (unlikely(!pipe->readers)) {
1095 send_sig(SIGPIPE, current, 0);
1096 return -EPIPE;
1097 }
1098 if (pipe->nrbufs != pipe->buffers)
1099 return 0;
Al Viro8924fef2016-09-17 20:44:45 -04001100 if (flags & SPLICE_F_NONBLOCK)
1101 return -EAGAIN;
1102 if (signal_pending(current))
1103 return -ERESTARTSYS;
1104 pipe->waiting_writers++;
1105 pipe_wait(pipe);
1106 pipe->waiting_writers--;
1107 }
Al Viro8924fef2016-09-17 20:44:45 -04001108}
1109
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001110static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1111 struct pipe_inode_info *opipe,
1112 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001113
1114/*
Jens Axboe83f91352006-04-02 23:05:09 +02001115 * Determine where to splice to/from.
1116 */
Ingo Molnar529565d2006-04-10 15:18:58 +02001117static long do_splice(struct file *in, loff_t __user *off_in,
1118 struct file *out, loff_t __user *off_out,
1119 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001120{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001121 struct pipe_inode_info *ipipe;
1122 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001123 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001124 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001125
Linus Torvalds71993e62010-11-28 13:56:09 -08001126 ipipe = get_pipe_info(in);
1127 opipe = get_pipe_info(out);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001128
1129 if (ipipe && opipe) {
1130 if (off_in || off_out)
1131 return -ESPIPE;
1132
1133 if (!(in->f_mode & FMODE_READ))
1134 return -EBADF;
1135
1136 if (!(out->f_mode & FMODE_WRITE))
1137 return -EBADF;
1138
1139 /* Splicing to self would be fun, but... */
1140 if (ipipe == opipe)
1141 return -EINVAL;
1142
1143 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1144 }
1145
1146 if (ipipe) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001147 if (off_in)
1148 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001149 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001150 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001151 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001152 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001153 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001154 } else {
1155 offset = out->f_pos;
1156 }
Ingo Molnar529565d2006-04-10 15:18:58 +02001157
Al Viro18c67cb2013-06-19 15:41:54 +04001158 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1159 return -EBADF;
1160
1161 if (unlikely(out->f_flags & O_APPEND))
1162 return -EINVAL;
1163
1164 ret = rw_verify_area(WRITE, out, &offset, len);
1165 if (unlikely(ret < 0))
1166 return ret;
1167
Al Viro500368f2013-05-23 20:07:11 -04001168 file_start_write(out);
Al Viro7995bd22013-06-20 18:58:36 +04001169 ret = do_splice_from(ipipe, out, &offset, len, flags);
Al Viro500368f2013-05-23 20:07:11 -04001170 file_end_write(out);
Jens Axboea4514eb2006-04-19 15:57:05 +02001171
Al Viro7995bd22013-06-20 18:58:36 +04001172 if (!off_out)
1173 out->f_pos = offset;
1174 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001175 ret = -EFAULT;
1176
1177 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001178 }
Jens Axboe5274f052006-03-30 15:15:30 +02001179
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001180 if (opipe) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001181 if (off_out)
1182 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001183 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001184 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001185 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001186 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001187 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001188 } else {
1189 offset = in->f_pos;
1190 }
Ingo Molnar529565d2006-04-10 15:18:58 +02001191
Al Viro8924fef2016-09-17 20:44:45 -04001192 pipe_lock(opipe);
1193 ret = wait_for_space(opipe, flags);
1194 if (!ret)
1195 ret = do_splice_to(in, &offset, opipe, len, flags);
1196 pipe_unlock(opipe);
1197 if (ret > 0)
1198 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001199 if (!off_in)
1200 in->f_pos = offset;
1201 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001202 ret = -EFAULT;
1203
1204 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001205 }
Jens Axboe5274f052006-03-30 15:15:30 +02001206
1207 return -EINVAL;
1208}
1209
Al Viro79fddc42016-09-17 22:38:20 -04001210static int iter_to_pipe(struct iov_iter *from,
1211 struct pipe_inode_info *pipe,
1212 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001213{
Al Viro79fddc42016-09-17 22:38:20 -04001214 struct pipe_buffer buf = {
1215 .ops = &user_page_pipe_buf_ops,
1216 .flags = flags
1217 };
1218 size_t total = 0;
1219 int ret = 0;
1220 bool failed = false;
1221
1222 while (iov_iter_count(from) && !failed) {
1223 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001224 ssize_t copied;
1225 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001226 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001227
Al Viro79fddc42016-09-17 22:38:20 -04001228 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1229 if (copied <= 0) {
1230 ret = copied;
1231 break;
1232 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001233
Al Viro79fddc42016-09-17 22:38:20 -04001234 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001235 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001236 if (!failed) {
1237 buf.page = pages[n];
1238 buf.offset = start;
1239 buf.len = size;
1240 ret = add_to_pipe(pipe, &buf);
1241 if (unlikely(ret < 0)) {
1242 failed = true;
1243 } else {
1244 iov_iter_advance(from, ret);
1245 total += ret;
1246 }
1247 } else {
1248 put_page(pages[n]);
1249 }
Al Virodb85a9e2016-09-17 20:25:06 -04001250 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001251 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001252 }
Al Viro79fddc42016-09-17 22:38:20 -04001253 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001254}
1255
Jens Axboe6a14b902007-06-14 13:08:55 +02001256static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1257 struct splice_desc *sd)
1258{
Al Viro6130f532014-02-03 18:19:51 -05001259 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1260 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001261}
1262
1263/*
1264 * For lack of a better implementation, implement vmsplice() to userspace
1265 * as a simple copy of the pipes pages to the user iov.
1266 */
Al Viro6130f532014-02-03 18:19:51 -05001267static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001268 unsigned long nr_segs, unsigned int flags)
1269{
1270 struct pipe_inode_info *pipe;
1271 struct splice_desc sd;
Jens Axboe6a14b902007-06-14 13:08:55 +02001272 long ret;
Al Viro6130f532014-02-03 18:19:51 -05001273 struct iovec iovstack[UIO_FASTIOV];
1274 struct iovec *iov = iovstack;
1275 struct iov_iter iter;
Jens Axboe6a14b902007-06-14 13:08:55 +02001276
Linus Torvalds71993e62010-11-28 13:56:09 -08001277 pipe = get_pipe_info(file);
Jens Axboe6a14b902007-06-14 13:08:55 +02001278 if (!pipe)
1279 return -EBADF;
1280
Al Viro345995f2015-03-21 19:17:55 -04001281 ret = import_iovec(READ, uiov, nr_segs,
1282 ARRAY_SIZE(iovstack), &iov, &iter);
1283 if (ret < 0)
1284 return ret;
Al Viro6130f532014-02-03 18:19:51 -05001285
Al Viro345995f2015-03-21 19:17:55 -04001286 sd.total_len = iov_iter_count(&iter);
Al Viro6130f532014-02-03 18:19:51 -05001287 sd.len = 0;
Al Viro6130f532014-02-03 18:19:51 -05001288 sd.flags = flags;
1289 sd.u.data = &iter;
1290 sd.pos = 0;
1291
Al Viro345995f2015-03-21 19:17:55 -04001292 if (sd.total_len) {
1293 pipe_lock(pipe);
1294 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1295 pipe_unlock(pipe);
1296 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001297
Al Viro345995f2015-03-21 19:17:55 -04001298 kfree(iov);
Jens Axboe6a14b902007-06-14 13:08:55 +02001299 return ret;
1300}
1301
Jens Axboe912d35f2006-04-26 10:59:21 +02001302/*
1303 * vmsplice splices a user address range into a pipe. It can be thought of
1304 * as splice-from-memory, where the regular splice is splice-from-file (or
1305 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001306 */
Al Virodb85a9e2016-09-17 20:25:06 -04001307static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001308 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001309{
Jens Axboeddac0d32006-11-04 12:49:32 +01001310 struct pipe_inode_info *pipe;
Al Virodb85a9e2016-09-17 20:25:06 -04001311 struct iovec iovstack[UIO_FASTIOV];
1312 struct iovec *iov = iovstack;
1313 struct iov_iter from;
Jens Axboe35f3d142010-05-20 10:43:18 +02001314 long ret;
Al Viro79fddc42016-09-17 22:38:20 -04001315 unsigned buf_flag = 0;
1316
1317 if (flags & SPLICE_F_GIFT)
1318 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001319
Linus Torvalds71993e62010-11-28 13:56:09 -08001320 pipe = get_pipe_info(file);
Jens Axboeddac0d32006-11-04 12:49:32 +01001321 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001322 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001323
Al Virodb85a9e2016-09-17 20:25:06 -04001324 ret = import_iovec(WRITE, uiov, nr_segs,
1325 ARRAY_SIZE(iovstack), &iov, &from);
1326 if (ret < 0)
1327 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001328
Al Viro8924fef2016-09-17 20:44:45 -04001329 pipe_lock(pipe);
1330 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001331 if (!ret)
1332 ret = iter_to_pipe(&from, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001333 pipe_unlock(pipe);
1334 if (ret > 0)
1335 wakeup_pipe_readers(pipe);
Al Virodb85a9e2016-09-17 20:25:06 -04001336 kfree(iov);
Jens Axboe35f3d142010-05-20 10:43:18 +02001337 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001338}
1339
Jens Axboe6a14b902007-06-14 13:08:55 +02001340/*
1341 * Note that vmsplice only really supports true splicing _from_ user memory
1342 * to a pipe, not the other way around. Splicing from user memory is a simple
1343 * operation that can be supported without any funky alignment restrictions
1344 * or nasty vm tricks. We simply map in the user memory and fill them into
1345 * a pipe. The reverse isn't quite as easy, though. There are two possible
1346 * solutions for that:
1347 *
1348 * - memcpy() the data internally, at which point we might as well just
1349 * do a regular read() on the buffer anyway.
1350 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1351 * has restriction limitations on both ends of the pipe).
1352 *
1353 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1354 *
1355 */
Heiko Carstens836f92a2009-01-14 14:14:33 +01001356SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1357 unsigned long, nr_segs, unsigned int, flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001358{
Al Viro2903ff02012-08-28 12:52:22 -04001359 struct fd f;
Jens Axboe912d35f2006-04-26 10:59:21 +02001360 long error;
Jens Axboe912d35f2006-04-26 10:59:21 +02001361
Jens Axboe6a14b902007-06-14 13:08:55 +02001362 if (unlikely(nr_segs > UIO_MAXIOV))
1363 return -EINVAL;
1364 else if (unlikely(!nr_segs))
1365 return 0;
1366
Jens Axboe912d35f2006-04-26 10:59:21 +02001367 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001368 f = fdget(fd);
1369 if (f.file) {
1370 if (f.file->f_mode & FMODE_WRITE)
1371 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1372 else if (f.file->f_mode & FMODE_READ)
1373 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001374
Al Viro2903ff02012-08-28 12:52:22 -04001375 fdput(f);
Jens Axboe912d35f2006-04-26 10:59:21 +02001376 }
1377
1378 return error;
1379}
1380
Al Viro76b021d2013-03-02 10:19:56 -05001381#ifdef CONFIG_COMPAT
1382COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1383 unsigned int, nr_segs, unsigned int, flags)
1384{
1385 unsigned i;
1386 struct iovec __user *iov;
1387 if (nr_segs > UIO_MAXIOV)
1388 return -EINVAL;
1389 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1390 for (i = 0; i < nr_segs; i++) {
1391 struct compat_iovec v;
1392 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1393 get_user(v.iov_len, &iov32[i].iov_len) ||
1394 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1395 put_user(v.iov_len, &iov[i].iov_len))
1396 return -EFAULT;
1397 }
1398 return sys_vmsplice(fd, iov, nr_segs, flags);
1399}
1400#endif
1401
Heiko Carstens836f92a2009-01-14 14:14:33 +01001402SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1403 int, fd_out, loff_t __user *, off_out,
1404 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001405{
Al Viro2903ff02012-08-28 12:52:22 -04001406 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001407 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001408
1409 if (unlikely(!len))
1410 return 0;
1411
1412 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001413 in = fdget(fd_in);
1414 if (in.file) {
1415 if (in.file->f_mode & FMODE_READ) {
1416 out = fdget(fd_out);
1417 if (out.file) {
1418 if (out.file->f_mode & FMODE_WRITE)
1419 error = do_splice(in.file, off_in,
1420 out.file, off_out,
Ingo Molnar529565d2006-04-10 15:18:58 +02001421 len, flags);
Al Viro2903ff02012-08-28 12:52:22 -04001422 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001423 }
1424 }
Al Viro2903ff02012-08-28 12:52:22 -04001425 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001426 }
Jens Axboe5274f052006-03-30 15:15:30 +02001427 return error;
1428}
Jens Axboe70524492006-04-11 15:51:17 +02001429
1430/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001431 * Make sure there's data to read. Wait for input if we can, otherwise
1432 * return an appropriate error.
1433 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001434static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001435{
1436 int ret;
1437
1438 /*
1439 * Check ->nrbufs without the inode lock first. This function
1440 * is speculative anyways, so missing one is ok.
1441 */
1442 if (pipe->nrbufs)
1443 return 0;
1444
1445 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001446 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001447
1448 while (!pipe->nrbufs) {
1449 if (signal_pending(current)) {
1450 ret = -ERESTARTSYS;
1451 break;
1452 }
1453 if (!pipe->writers)
1454 break;
1455 if (!pipe->waiting_writers) {
1456 if (flags & SPLICE_F_NONBLOCK) {
1457 ret = -EAGAIN;
1458 break;
1459 }
1460 }
1461 pipe_wait(pipe);
1462 }
1463
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001464 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001465 return ret;
1466}
1467
1468/*
1469 * Make sure there's writeable room. Wait for room if we can, otherwise
1470 * return an appropriate error.
1471 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001472static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001473{
1474 int ret;
1475
1476 /*
1477 * Check ->nrbufs without the inode lock first. This function
1478 * is speculative anyways, so missing one is ok.
1479 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001480 if (pipe->nrbufs < pipe->buffers)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001481 return 0;
1482
1483 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001484 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001485
Jens Axboe35f3d142010-05-20 10:43:18 +02001486 while (pipe->nrbufs >= pipe->buffers) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001487 if (!pipe->readers) {
1488 send_sig(SIGPIPE, current, 0);
1489 ret = -EPIPE;
1490 break;
1491 }
1492 if (flags & SPLICE_F_NONBLOCK) {
1493 ret = -EAGAIN;
1494 break;
1495 }
1496 if (signal_pending(current)) {
1497 ret = -ERESTARTSYS;
1498 break;
1499 }
1500 pipe->waiting_writers++;
1501 pipe_wait(pipe);
1502 pipe->waiting_writers--;
1503 }
1504
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001505 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001506 return ret;
1507}
1508
1509/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001510 * Splice contents of ipipe to opipe.
1511 */
1512static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1513 struct pipe_inode_info *opipe,
1514 size_t len, unsigned int flags)
1515{
1516 struct pipe_buffer *ibuf, *obuf;
1517 int ret = 0, nbuf;
1518 bool input_wakeup = false;
1519
1520
1521retry:
1522 ret = ipipe_prep(ipipe, flags);
1523 if (ret)
1524 return ret;
1525
1526 ret = opipe_prep(opipe, flags);
1527 if (ret)
1528 return ret;
1529
1530 /*
1531 * Potential ABBA deadlock, work around it by ordering lock
1532 * grabbing by pipe info address. Otherwise two different processes
1533 * could deadlock (one doing tee from A -> B, the other from B -> A).
1534 */
1535 pipe_double_lock(ipipe, opipe);
1536
1537 do {
1538 if (!opipe->readers) {
1539 send_sig(SIGPIPE, current, 0);
1540 if (!ret)
1541 ret = -EPIPE;
1542 break;
1543 }
1544
1545 if (!ipipe->nrbufs && !ipipe->writers)
1546 break;
1547
1548 /*
1549 * Cannot make any progress, because either the input
1550 * pipe is empty or the output pipe is full.
1551 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001552 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001553 /* Already processed some buffers, break */
1554 if (ret)
1555 break;
1556
1557 if (flags & SPLICE_F_NONBLOCK) {
1558 ret = -EAGAIN;
1559 break;
1560 }
1561
1562 /*
1563 * We raced with another reader/writer and haven't
1564 * managed to process any buffers. A zero return
1565 * value means EOF, so retry instead.
1566 */
1567 pipe_unlock(ipipe);
1568 pipe_unlock(opipe);
1569 goto retry;
1570 }
1571
1572 ibuf = ipipe->bufs + ipipe->curbuf;
Jens Axboe35f3d142010-05-20 10:43:18 +02001573 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001574 obuf = opipe->bufs + nbuf;
1575
1576 if (len >= ibuf->len) {
1577 /*
1578 * Simply move the whole buffer from ipipe to opipe
1579 */
1580 *obuf = *ibuf;
1581 ibuf->ops = NULL;
1582 opipe->nrbufs++;
Jens Axboe35f3d142010-05-20 10:43:18 +02001583 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001584 ipipe->nrbufs--;
1585 input_wakeup = true;
1586 } else {
1587 /*
1588 * Get a reference to this pipe buffer,
1589 * so we can copy the contents over.
1590 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001591 pipe_buf_get(ipipe, ibuf);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001592 *obuf = *ibuf;
1593
1594 /*
1595 * Don't inherit the gift flag, we need to
1596 * prevent multiple steals of this page.
1597 */
1598 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1599
1600 obuf->len = len;
1601 opipe->nrbufs++;
1602 ibuf->offset += obuf->len;
1603 ibuf->len -= obuf->len;
1604 }
1605 ret += obuf->len;
1606 len -= obuf->len;
1607 } while (len);
1608
1609 pipe_unlock(ipipe);
1610 pipe_unlock(opipe);
1611
1612 /*
1613 * If we put data in the output pipe, wakeup any potential readers.
1614 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001615 if (ret > 0)
1616 wakeup_pipe_readers(opipe);
1617
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001618 if (input_wakeup)
1619 wakeup_pipe_writers(ipipe);
1620
1621 return ret;
1622}
1623
1624/*
Jens Axboe70524492006-04-11 15:51:17 +02001625 * Link contents of ipipe to opipe.
1626 */
1627static int link_pipe(struct pipe_inode_info *ipipe,
1628 struct pipe_inode_info *opipe,
1629 size_t len, unsigned int flags)
1630{
1631 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001632 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001633
1634 /*
1635 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001636 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001637 * could deadlock (one doing tee from A -> B, the other from B -> A).
1638 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001639 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001640
Jens Axboeaadd06e2006-07-10 11:00:01 +02001641 do {
Jens Axboe70524492006-04-11 15:51:17 +02001642 if (!opipe->readers) {
1643 send_sig(SIGPIPE, current, 0);
1644 if (!ret)
1645 ret = -EPIPE;
1646 break;
1647 }
Jens Axboe70524492006-04-11 15:51:17 +02001648
1649 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001650 * If we have iterated all input buffers or ran out of
1651 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001652 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001653 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
Jens Axboe70524492006-04-11 15:51:17 +02001654 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001655
Jens Axboe35f3d142010-05-20 10:43:18 +02001656 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1657 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001658
Jens Axboe2a27250e2006-04-19 15:56:40 +02001659 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001660 * Get a reference to this pipe buffer,
1661 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001662 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001663 pipe_buf_get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001664
Jens Axboeaadd06e2006-07-10 11:00:01 +02001665 obuf = opipe->bufs + nbuf;
1666 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001667
Jens Axboeaadd06e2006-07-10 11:00:01 +02001668 /*
1669 * Don't inherit the gift flag, we need to
1670 * prevent multiple steals of this page.
1671 */
1672 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1673
1674 if (obuf->len > len)
1675 obuf->len = len;
1676
1677 opipe->nrbufs++;
1678 ret += obuf->len;
1679 len -= obuf->len;
1680 i++;
1681 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001682
Jens Axboe02cf01a2008-02-20 10:34:51 +01001683 /*
1684 * return EAGAIN if we have the potential of some data in the
1685 * future, otherwise just return 0
1686 */
1687 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1688 ret = -EAGAIN;
1689
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001690 pipe_unlock(ipipe);
1691 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001692
Jens Axboeaadd06e2006-07-10 11:00:01 +02001693 /*
1694 * If we put data in the output pipe, wakeup any potential readers.
1695 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001696 if (ret > 0)
1697 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001698
1699 return ret;
1700}
1701
1702/*
1703 * This is a tee(1) implementation that works on pipes. It doesn't copy
1704 * any data, it simply references the 'in' pages on the 'out' pipe.
1705 * The 'flags' used are the SPLICE_F_* variants, currently the only
1706 * applicable one is SPLICE_F_NONBLOCK.
1707 */
1708static long do_tee(struct file *in, struct file *out, size_t len,
1709 unsigned int flags)
1710{
Linus Torvalds71993e62010-11-28 13:56:09 -08001711 struct pipe_inode_info *ipipe = get_pipe_info(in);
1712 struct pipe_inode_info *opipe = get_pipe_info(out);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001713 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001714
1715 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001716 * Duplicate the contents of ipipe to opipe without actually
1717 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001718 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001719 if (ipipe && opipe && ipipe != opipe) {
1720 /*
1721 * Keep going, unless we encounter an error. The ipipe/opipe
1722 * ordering doesn't really matter.
1723 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001724 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001725 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001726 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001727 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001728 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001729 }
1730 }
Jens Axboe70524492006-04-11 15:51:17 +02001731
Jens Axboeaadd06e2006-07-10 11:00:01 +02001732 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001733}
1734
Heiko Carstens836f92a2009-01-14 14:14:33 +01001735SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001736{
Al Viro2903ff02012-08-28 12:52:22 -04001737 struct fd in;
1738 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001739
1740 if (unlikely(!len))
1741 return 0;
1742
1743 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001744 in = fdget(fdin);
1745 if (in.file) {
1746 if (in.file->f_mode & FMODE_READ) {
1747 struct fd out = fdget(fdout);
1748 if (out.file) {
1749 if (out.file->f_mode & FMODE_WRITE)
1750 error = do_tee(in.file, out.file,
1751 len, flags);
1752 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001753 }
1754 }
Al Viro2903ff02012-08-28 12:52:22 -04001755 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001756 }
1757
1758 return error;
1759}