blob: 4ef78aa8ef61e8d0f091fe4088bc7c28035b5ef1 [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>
Al Viro06ae43f2013-03-20 13:19:30 -040036#include "internal.h"
Jens Axboe5274f052006-03-30 15:15:30 +020037
Jens Axboe83f91352006-04-02 23:05:09 +020038/*
39 * Attempt to steal a page from a pipe buffer. This should perhaps go into
40 * a vm helper function, it's already simplified quite a bit by the
41 * addition of remove_mapping(). If success is returned, the caller may
42 * attempt to reuse this page for another destination.
43 */
Jens Axboe76ad4d12006-05-03 10:41:33 +020044static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
Jens Axboe5abc97a2006-03-30 15:16:46 +020045 struct pipe_buffer *buf)
46{
47 struct page *page = buf->page;
Jens Axboe9e94cd42006-06-20 15:01:12 +020048 struct address_space *mapping;
Jens Axboe5abc97a2006-03-30 15:16:46 +020049
Jens Axboe9e0267c2006-04-19 15:57:31 +020050 lock_page(page);
51
Jens Axboe9e94cd42006-06-20 15:01:12 +020052 mapping = page_mapping(page);
53 if (mapping) {
54 WARN_ON(!PageUptodate(page));
Jens Axboe5abc97a2006-03-30 15:16:46 +020055
Jens Axboe9e94cd42006-06-20 15:01:12 +020056 /*
57 * At least for ext2 with nobh option, we need to wait on
58 * writeback completing on this page, since we'll remove it
59 * from the pagecache. Otherwise truncate wont wait on the
60 * page, allowing the disk blocks to be reused by someone else
61 * before we actually wrote our data to them. fs corruption
62 * ensues.
63 */
64 wait_on_page_writeback(page);
Jens Axboead8d6f02006-04-02 23:10:32 +020065
David Howells266cf652009-04-03 16:42:36 +010066 if (page_has_private(page) &&
67 !try_to_release_page(page, GFP_KERNEL))
Jens Axboeca39d652008-05-20 21:27:41 +020068 goto out_unlock;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020069
Jens Axboe9e94cd42006-06-20 15:01:12 +020070 /*
71 * If we succeeded in removing the mapping, set LRU flag
72 * and return good.
73 */
74 if (remove_mapping(mapping, page)) {
75 buf->flags |= PIPE_BUF_FLAG_LRU;
76 return 0;
77 }
Jens Axboe9e0267c2006-04-19 15:57:31 +020078 }
Jens Axboe5abc97a2006-03-30 15:16:46 +020079
Jens Axboe9e94cd42006-06-20 15:01:12 +020080 /*
81 * Raced with truncate or failed to remove page from current
82 * address space, unlock and return failure.
83 */
Jens Axboeca39d652008-05-20 21:27:41 +020084out_unlock:
Jens Axboe9e94cd42006-06-20 15:01:12 +020085 unlock_page(page);
86 return 1;
Jens Axboe5abc97a2006-03-30 15:16:46 +020087}
88
Jens Axboe76ad4d12006-05-03 10:41:33 +020089static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +020090 struct pipe_buffer *buf)
91{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030092 put_page(buf->page);
Jens Axboe14328732006-05-03 10:35:26 +020093 buf->flags &= ~PIPE_BUF_FLAG_LRU;
Jens Axboe5274f052006-03-30 15:15:30 +020094}
95
Jens Axboe08457182007-06-12 20:51:32 +020096/*
97 * Check whether the contents of buf is OK to access. Since the content
98 * is a page cache page, IO may be in flight.
99 */
Jens Axboecac36bb02007-06-14 13:10:48 +0200100static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
101 struct pipe_buffer *buf)
Jens Axboe5274f052006-03-30 15:15:30 +0200102{
103 struct page *page = buf->page;
Jens Axboe49d0b212006-04-10 09:04:41 +0200104 int err;
Jens Axboe5274f052006-03-30 15:15:30 +0200105
106 if (!PageUptodate(page)) {
Jens Axboe49d0b212006-04-10 09:04:41 +0200107 lock_page(page);
108
109 /*
110 * Page got truncated/unhashed. This will cause a 0-byte
Ingo Molnar73d62d82006-04-11 13:57:21 +0200111 * splice, if this is the first page.
Jens Axboe49d0b212006-04-10 09:04:41 +0200112 */
113 if (!page->mapping) {
114 err = -ENODATA;
115 goto error;
116 }
117
118 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200119 * Uh oh, read-error from disk.
Jens Axboe49d0b212006-04-10 09:04:41 +0200120 */
121 if (!PageUptodate(page)) {
122 err = -EIO;
123 goto error;
124 }
125
126 /*
Jens Axboef84d7512006-05-01 19:59:03 +0200127 * Page is ok afterall, we are done.
Jens Axboe49d0b212006-04-10 09:04:41 +0200128 */
Jens Axboe5274f052006-03-30 15:15:30 +0200129 unlock_page(page);
Jens Axboe5274f052006-03-30 15:15:30 +0200130 }
131
Jens Axboef84d7512006-05-01 19:59:03 +0200132 return 0;
Jens Axboe49d0b212006-04-10 09:04:41 +0200133error:
134 unlock_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200135 return err;
Jens Axboe70524492006-04-11 15:51:17 +0200136}
137
Hugh Dickins708e3502011-07-25 17:12:32 -0700138const struct pipe_buf_operations page_cache_pipe_buf_ops = {
Jens Axboe5274f052006-03-30 15:15:30 +0200139 .can_merge = 0,
Jens Axboecac36bb02007-06-14 13:10:48 +0200140 .confirm = page_cache_pipe_buf_confirm,
Jens Axboe5274f052006-03-30 15:15:30 +0200141 .release = page_cache_pipe_buf_release,
Jens Axboe5abc97a2006-03-30 15:16:46 +0200142 .steal = page_cache_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200143 .get = generic_pipe_buf_get,
Jens Axboe5274f052006-03-30 15:15:30 +0200144};
145
Jens Axboe912d35f2006-04-26 10:59:21 +0200146static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
147 struct pipe_buffer *buf)
148{
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200149 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
150 return 1;
151
Jens Axboe14328732006-05-03 10:35:26 +0200152 buf->flags |= PIPE_BUF_FLAG_LRU;
Jens Axboe330ab712006-05-02 15:29:57 +0200153 return generic_pipe_buf_steal(pipe, buf);
Jens Axboe912d35f2006-04-26 10:59:21 +0200154}
155
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800156static const struct pipe_buf_operations user_page_pipe_buf_ops = {
Jens Axboe912d35f2006-04-26 10:59:21 +0200157 .can_merge = 0,
Jens Axboecac36bb02007-06-14 13:10:48 +0200158 .confirm = generic_pipe_buf_confirm,
Jens Axboe912d35f2006-04-26 10:59:21 +0200159 .release = page_cache_pipe_buf_release,
160 .steal = user_page_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200161 .get = generic_pipe_buf_get,
Jens Axboe912d35f2006-04-26 10:59:21 +0200162};
163
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200164static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
165{
166 smp_mb();
167 if (waitqueue_active(&pipe->wait))
168 wake_up_interruptible(&pipe->wait);
169 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
170}
171
Jens Axboe932cc6d2007-06-21 13:10:21 +0200172/**
173 * splice_to_pipe - fill passed data into a pipe
174 * @pipe: pipe to fill
175 * @spd: data to fill
176 *
177 * Description:
Randy Dunlap79685b82007-07-27 08:08:51 +0200178 * @spd contains a map of pages and len/offset tuples, along with
Jens Axboe932cc6d2007-06-21 13:10:21 +0200179 * the struct pipe_buf_operations associated with these pages. This
180 * function will link that data to the pipe.
181 *
Jens Axboe83f91352006-04-02 23:05:09 +0200182 */
Jens Axboed6b29d72007-06-04 09:59:47 +0200183ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
184 struct splice_pipe_desc *spd)
Jens Axboe5274f052006-03-30 15:15:30 +0200185{
Jens Axboe00de00b2007-06-15 13:14:22 +0200186 unsigned int spd_pages = spd->nr_pages;
Al Viro8924fef2016-09-17 20:44:45 -0400187 int ret = 0, page_nr = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200188
Rabin Vincentd6785d92016-03-10 21:19:06 +0100189 if (!spd_pages)
190 return 0;
191
Al Viro8924fef2016-09-17 20:44:45 -0400192 if (unlikely(!pipe->readers)) {
193 send_sig(SIGPIPE, current, 0);
194 ret = -EPIPE;
195 goto out;
Jens Axboe5274f052006-03-30 15:15:30 +0200196 }
197
Al Viro8924fef2016-09-17 20:44:45 -0400198 while (pipe->nrbufs < pipe->buffers) {
199 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
200 struct pipe_buffer *buf = pipe->bufs + newbuf;
Jens Axboe5274f052006-03-30 15:15:30 +0200201
Al Viro8924fef2016-09-17 20:44:45 -0400202 buf->page = spd->pages[page_nr];
203 buf->offset = spd->partial[page_nr].offset;
204 buf->len = spd->partial[page_nr].len;
205 buf->private = spd->partial[page_nr].private;
206 buf->ops = spd->ops;
Miklos Szeredi5a81e6a2017-02-16 17:49:02 +0100207 buf->flags = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200208
Al Viro8924fef2016-09-17 20:44:45 -0400209 pipe->nrbufs++;
210 page_nr++;
211 ret += buf->len;
212
213 if (!--spd->nr_pages)
214 break;
215 }
216
217 if (!ret)
218 ret = -EAGAIN;
219
220out:
Jens Axboe00de00b2007-06-15 13:14:22 +0200221 while (page_nr < spd_pages)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800222 spd->spd_release(spd, page_nr++);
Jens Axboe5274f052006-03-30 15:15:30 +0200223
224 return ret;
225}
Hannes Frederic Sowa2b514572015-05-21 17:00:01 +0200226EXPORT_SYMBOL_GPL(splice_to_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200227
Al Viro79fddc42016-09-17 22:38:20 -0400228ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
229{
230 int ret;
231
232 if (unlikely(!pipe->readers)) {
233 send_sig(SIGPIPE, current, 0);
234 ret = -EPIPE;
235 } else if (pipe->nrbufs == pipe->buffers) {
236 ret = -EAGAIN;
237 } else {
238 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
239 pipe->bufs[newbuf] = *buf;
240 pipe->nrbufs++;
241 return buf->len;
242 }
Miklos Szeredia7796382016-09-27 10:45:12 +0200243 pipe_buf_release(pipe, buf);
Al Viro79fddc42016-09-17 22:38:20 -0400244 return ret;
245}
246EXPORT_SYMBOL(add_to_pipe);
247
Hugh Dickins708e3502011-07-25 17:12:32 -0700248void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800249{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300250 put_page(spd->pages[i]);
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800251}
252
Jens Axboe35f3d142010-05-20 10:43:18 +0200253/*
254 * Check if we need to grow the arrays holding pages and partial page
255 * descriptions.
256 */
Eric Dumazet047fe362012-06-12 15:24:40 +0200257int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200258{
Eric Dumazet047fe362012-06-12 15:24:40 +0200259 unsigned int buffers = ACCESS_ONCE(pipe->buffers);
260
261 spd->nr_pages_max = buffers;
262 if (buffers <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200263 return 0;
264
Eric Dumazet047fe362012-06-12 15:24:40 +0200265 spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
266 spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200267
268 if (spd->pages && spd->partial)
269 return 0;
270
271 kfree(spd->pages);
272 kfree(spd->partial);
273 return -ENOMEM;
274}
275
Eric Dumazet047fe362012-06-12 15:24:40 +0200276void splice_shrink_spd(struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200277{
Eric Dumazet047fe362012-06-12 15:24:40 +0200278 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200279 return;
280
281 kfree(spd->pages);
282 kfree(spd->partial);
283}
284
Jens Axboe83f91352006-04-02 23:05:09 +0200285/**
286 * generic_file_splice_read - splice data from file to a pipe
287 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200288 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200289 * @pipe: pipe to splice to
290 * @len: number of bytes to splice
291 * @flags: splice modifier flags
292 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200293 * Description:
294 * Will read pages from given file and fill them into a pipe. Can be
Al Viro82c156f2016-09-22 23:35:42 -0400295 * used as long as it has more or less sane ->read_iter().
Jens Axboe932cc6d2007-06-21 13:10:21 +0200296 *
Jens Axboe83f91352006-04-02 23:05:09 +0200297 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200298ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
299 struct pipe_inode_info *pipe, size_t len,
300 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200301{
Al Viro82c156f2016-09-22 23:35:42 -0400302 struct iov_iter to;
303 struct kiocb kiocb;
Al Viro82c156f2016-09-22 23:35:42 -0400304 int idx, ret;
Boaz Harroshbe64f882015-04-15 16:15:17 -0700305
Al Viro82c156f2016-09-22 23:35:42 -0400306 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len);
307 idx = to.idx;
308 init_sync_kiocb(&kiocb, in);
309 kiocb.ki_pos = *ppos;
310 ret = in->f_op->read_iter(&kiocb, &to);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200311 if (ret > 0) {
Al Viro82c156f2016-09-22 23:35:42 -0400312 *ppos = kiocb.ki_pos;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200313 file_accessed(in);
Al Viro82c156f2016-09-22 23:35:42 -0400314 } else if (ret < 0) {
Al Viroc3a69022016-10-10 13:26:27 -0400315 to.idx = idx;
316 to.iov_offset = 0;
317 iov_iter_advance(&to, 0); /* to free what was emitted */
Al Viro82c156f2016-09-22 23:35:42 -0400318 /*
319 * callers of ->splice_read() expect -EAGAIN on
320 * "can't put anything in there", rather than -EFAULT.
321 */
322 if (ret == -EFAULT)
323 ret = -EAGAIN;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200324 }
Jens Axboe5274f052006-03-30 15:15:30 +0200325
326 return ret;
327}
Jens Axboe059a8f32006-04-02 23:06:05 +0200328EXPORT_SYMBOL(generic_file_splice_read);
329
Al Viro241699c2016-09-22 16:33:12 -0400330const struct pipe_buf_operations default_pipe_buf_ops = {
Miklos Szeredi68181732009-05-07 15:37:36 +0200331 .can_merge = 0,
Miklos Szeredi68181732009-05-07 15:37:36 +0200332 .confirm = generic_pipe_buf_confirm,
333 .release = generic_pipe_buf_release,
334 .steal = generic_pipe_buf_steal,
335 .get = generic_pipe_buf_get,
336};
337
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100338static int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
339 struct pipe_buffer *buf)
340{
341 return 1;
342}
343
344/* Pipe buffer operations for a socket and similar. */
345const struct pipe_buf_operations nosteal_pipe_buf_ops = {
346 .can_merge = 0,
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100347 .confirm = generic_pipe_buf_confirm,
348 .release = generic_pipe_buf_release,
349 .steal = generic_pipe_buf_nosteal,
350 .get = generic_pipe_buf_get,
351};
352EXPORT_SYMBOL(nosteal_pipe_buf_ops);
353
Al Viro523ac9a2016-09-23 15:34:57 -0400354static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
Miklos Szeredi68181732009-05-07 15:37:36 +0200355 unsigned long vlen, loff_t offset)
356{
357 mm_segment_t old_fs;
358 loff_t pos = offset;
359 ssize_t res;
360
361 old_fs = get_fs();
362 set_fs(get_ds());
363 /* The cast to a user pointer is valid due to the set_fs() */
Christoph Hellwig793b80e2016-03-03 16:03:58 +0100364 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
Miklos Szeredi68181732009-05-07 15:37:36 +0200365 set_fs(old_fs);
366
367 return res;
368}
369
Al Viro7bb307e2013-02-23 14:51:48 -0500370ssize_t kernel_write(struct file *file, const char *buf, size_t count,
Miklos Szeredib2858d72009-05-19 11:37:46 +0200371 loff_t pos)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200372{
373 mm_segment_t old_fs;
374 ssize_t res;
375
376 old_fs = get_fs();
377 set_fs(get_ds());
378 /* The cast to a user pointer is valid due to the set_fs() */
Al Viro7bb307e2013-02-23 14:51:48 -0500379 res = vfs_write(file, (__force const char __user *)buf, count, &pos);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200380 set_fs(old_fs);
381
382 return res;
383}
Al Viro7bb307e2013-02-23 14:51:48 -0500384EXPORT_SYMBOL(kernel_write);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200385
Al Viro82c156f2016-09-22 23:35:42 -0400386static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
Miklos Szeredi68181732009-05-07 15:37:36 +0200387 struct pipe_inode_info *pipe, size_t len,
388 unsigned int flags)
389{
Al Viro523ac9a2016-09-23 15:34:57 -0400390 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
391 struct iov_iter to;
392 struct page **pages;
Miklos Szeredi68181732009-05-07 15:37:36 +0200393 unsigned int nr_pages;
Al Viro523ac9a2016-09-23 15:34:57 -0400394 size_t offset, dummy, copied = 0;
Miklos Szeredi68181732009-05-07 15:37:36 +0200395 ssize_t res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200396 int i;
Miklos Szeredi68181732009-05-07 15:37:36 +0200397
Al Viro523ac9a2016-09-23 15:34:57 -0400398 if (pipe->nrbufs == pipe->buffers)
399 return -EAGAIN;
400
401 /*
402 * Try to keep page boundaries matching to source pagecache ones -
403 * it probably won't be much help, but...
404 */
405 offset = *ppos & ~PAGE_MASK;
406
407 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
408
409 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &dummy);
410 if (res <= 0)
Jens Axboe35f3d142010-05-20 10:43:18 +0200411 return -ENOMEM;
412
Al Viro8e54cad2016-11-26 20:05:42 -0500413 BUG_ON(dummy);
414 nr_pages = DIV_ROUND_UP(res, PAGE_SIZE);
Al Viro523ac9a2016-09-23 15:34:57 -0400415
Jens Axboe35f3d142010-05-20 10:43:18 +0200416 vec = __vec;
Al Viro523ac9a2016-09-23 15:34:57 -0400417 if (nr_pages > PIPE_DEF_BUFFERS) {
418 vec = kmalloc(nr_pages * sizeof(struct kvec), GFP_KERNEL);
419 if (unlikely(!vec)) {
420 res = -ENOMEM;
421 goto out;
422 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200423 }
424
Al Viro523ac9a2016-09-23 15:34:57 -0400425 pipe->bufs[to.idx].offset = offset;
426 pipe->bufs[to.idx].len -= offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200427
Al Viro523ac9a2016-09-23 15:34:57 -0400428 for (i = 0; i < nr_pages; i++) {
429 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
430 vec[i].iov_base = page_address(pages[i]) + offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200431 vec[i].iov_len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200432 len -= this_len;
433 offset = 0;
434 }
435
Al Viro523ac9a2016-09-23 15:34:57 -0400436 res = kernel_readv(in, vec, nr_pages, *ppos);
437 if (res > 0) {
438 copied = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200439 *ppos += res;
Al Viro523ac9a2016-09-23 15:34:57 -0400440 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200441
Jens Axboe35f3d142010-05-20 10:43:18 +0200442 if (vec != __vec)
443 kfree(vec);
Al Viro523ac9a2016-09-23 15:34:57 -0400444out:
445 for (i = 0; i < nr_pages; i++)
446 put_page(pages[i]);
447 kvfree(pages);
448 iov_iter_advance(&to, copied); /* truncates and discards */
Miklos Szeredi68181732009-05-07 15:37:36 +0200449 return res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200450}
Miklos Szeredi68181732009-05-07 15:37:36 +0200451
Jens Axboe5274f052006-03-30 15:15:30 +0200452/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200453 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200454 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200455 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200456static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200457 struct pipe_buffer *buf, struct splice_desc *sd)
458{
Jens Axboe6a14b902007-06-14 13:08:55 +0200459 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200460 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100461 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200462
Al Viro72c2d532013-09-22 16:27:52 -0400463 if (!likely(file->f_op->sendpage))
Michał Mirosława8adbe32010-12-17 08:56:44 +0100464 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200465
Eric Dumazet35f9c092012-04-05 03:05:35 +0000466 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000467
468 if (sd->len < sd->total_len && pipe->nrbufs > 1)
Eric Dumazet35f9c092012-04-05 03:05:35 +0000469 more |= MSG_SENDPAGE_NOTLAST;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000470
Michał Mirosława8adbe32010-12-17 08:56:44 +0100471 return file->f_op->sendpage(file, buf->page, buf->offset,
472 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200473}
474
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200475static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
476{
477 smp_mb();
478 if (waitqueue_active(&pipe->wait))
479 wake_up_interruptible(&pipe->wait);
480 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
481}
482
483/**
484 * splice_from_pipe_feed - feed available data from a pipe to a file
485 * @pipe: pipe to splice from
486 * @sd: information to @actor
487 * @actor: handler that splices the data
488 *
489 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200490 * This function loops over the pipe and calls @actor to do the
491 * actual moving of a single struct pipe_buffer to the desired
492 * destination. It returns when there's no more buffers left in
493 * the pipe or if the requested number of bytes (@sd->total_len)
494 * have been copied. It returns a positive number (one) if the
495 * pipe needs to be filled with more data, zero if the required
496 * number of bytes have been copied and -errno on error.
497 *
498 * This, together with splice_from_pipe_{begin,end,next}, may be
499 * used to implement the functionality of __splice_from_pipe() when
500 * locking is required around copying the pipe buffers to the
501 * destination.
502 */
Al Viro96f9bc82014-04-05 04:35:49 -0400503static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200504 splice_actor *actor)
505{
506 int ret;
507
508 while (pipe->nrbufs) {
509 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200510
511 sd->len = buf->len;
512 if (sd->len > sd->total_len)
513 sd->len = sd->total_len;
514
Miklos Szeredifba597d2016-09-27 10:45:12 +0200515 ret = pipe_buf_confirm(pipe, buf);
Michał Mirosława8adbe32010-12-17 08:56:44 +0100516 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200517 if (ret == -ENODATA)
518 ret = 0;
519 return ret;
520 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100521
522 ret = actor(pipe, buf, sd);
523 if (ret <= 0)
524 return ret;
525
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200526 buf->offset += ret;
527 buf->len -= ret;
528
529 sd->num_spliced += ret;
530 sd->len -= ret;
531 sd->pos += ret;
532 sd->total_len -= ret;
533
534 if (!buf->len) {
Miklos Szeredia7796382016-09-27 10:45:12 +0200535 pipe_buf_release(pipe, buf);
Jens Axboe35f3d142010-05-20 10:43:18 +0200536 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200537 pipe->nrbufs--;
Al Viro6447a3c2013-03-21 11:01:38 -0400538 if (pipe->files)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200539 sd->need_wakeup = true;
540 }
541
542 if (!sd->total_len)
543 return 0;
544 }
545
546 return 1;
547}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200548
549/**
550 * splice_from_pipe_next - wait for some data to splice from
551 * @pipe: pipe to splice from
552 * @sd: information about the splice operation
553 *
554 * Description:
555 * This function will wait for some data and return a positive
556 * value (one) if pipe buffers are available. It will return zero
557 * or -errno if no more data needs to be spliced.
558 */
Al Viro96f9bc82014-04-05 04:35:49 -0400559static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200560{
Jan Karac725bfc2015-11-23 13:09:50 +0100561 /*
562 * Check for signal early to make process killable when there are
563 * always buffers available
564 */
565 if (signal_pending(current))
566 return -ERESTARTSYS;
567
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200568 while (!pipe->nrbufs) {
569 if (!pipe->writers)
570 return 0;
571
572 if (!pipe->waiting_writers && sd->num_spliced)
573 return 0;
574
575 if (sd->flags & SPLICE_F_NONBLOCK)
576 return -EAGAIN;
577
578 if (signal_pending(current))
579 return -ERESTARTSYS;
580
581 if (sd->need_wakeup) {
582 wakeup_pipe_writers(pipe);
583 sd->need_wakeup = false;
584 }
585
586 pipe_wait(pipe);
587 }
588
589 return 1;
590}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200591
592/**
593 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700594 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200595 *
596 * Description:
597 * This function should be called before a loop containing
598 * splice_from_pipe_next() and splice_from_pipe_feed() to
599 * initialize the necessary fields of @sd.
600 */
Al Viro96f9bc82014-04-05 04:35:49 -0400601static void splice_from_pipe_begin(struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200602{
603 sd->num_spliced = 0;
604 sd->need_wakeup = false;
605}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200606
607/**
608 * splice_from_pipe_end - finish splicing from pipe
609 * @pipe: pipe to splice from
610 * @sd: information about the splice operation
611 *
612 * Description:
613 * This function will wake up pipe writers if necessary. It should
614 * be called after a loop containing splice_from_pipe_next() and
615 * splice_from_pipe_feed().
616 */
Al Viro96f9bc82014-04-05 04:35:49 -0400617static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200618{
619 if (sd->need_wakeup)
620 wakeup_pipe_writers(pipe);
621}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200622
Jens Axboe932cc6d2007-06-21 13:10:21 +0200623/**
624 * __splice_from_pipe - splice data from a pipe to given actor
625 * @pipe: pipe to splice from
626 * @sd: information to @actor
627 * @actor: handler that splices the data
628 *
629 * Description:
630 * This function does little more than loop over the pipe and call
631 * @actor to do the actual moving of a single struct pipe_buffer to
632 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
633 * pipe_to_user.
634 *
Jens Axboe83f91352006-04-02 23:05:09 +0200635 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200636ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
637 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200638{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200639 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200640
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200641 splice_from_pipe_begin(sd);
642 do {
Jan Karac2489e02015-11-23 13:09:51 +0100643 cond_resched();
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200644 ret = splice_from_pipe_next(pipe, sd);
645 if (ret > 0)
646 ret = splice_from_pipe_feed(pipe, sd, actor);
647 } while (ret > 0);
648 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200649
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200650 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200651}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100652EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200653
Jens Axboe932cc6d2007-06-21 13:10:21 +0200654/**
655 * splice_from_pipe - splice data from a pipe to a file
656 * @pipe: pipe to splice from
657 * @out: file to splice to
658 * @ppos: position in @out
659 * @len: how many bytes to splice
660 * @flags: splice modifier flags
661 * @actor: handler that splices the data
662 *
663 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200664 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200665 * otherwise it's identical to __splice_from_pipe().
666 *
667 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200668ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
669 loff_t *ppos, size_t len, unsigned int flags,
670 splice_actor *actor)
671{
672 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200673 struct splice_desc sd = {
674 .total_len = len,
675 .flags = flags,
676 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200677 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200678 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200679
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200680 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200681 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200682 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200683
684 return ret;
685}
686
687/**
Al Viro8d020762014-04-05 04:27:08 -0400688 * iter_file_splice_write - splice data from a pipe to a file
689 * @pipe: pipe info
690 * @out: file to write to
691 * @ppos: position in @out
692 * @len: number of bytes to splice
693 * @flags: splice modifier flags
694 *
695 * Description:
696 * Will either move or copy pages (determined by @flags options) from
697 * the given pipe inode to the given file.
698 * This one is ->write_iter-based.
699 *
700 */
701ssize_t
702iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
703 loff_t *ppos, size_t len, unsigned int flags)
704{
705 struct splice_desc sd = {
706 .total_len = len,
707 .flags = flags,
708 .pos = *ppos,
709 .u.file = out,
710 };
711 int nbufs = pipe->buffers;
712 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
713 GFP_KERNEL);
714 ssize_t ret;
715
716 if (unlikely(!array))
717 return -ENOMEM;
718
719 pipe_lock(pipe);
720
721 splice_from_pipe_begin(&sd);
722 while (sd.total_len) {
723 struct iov_iter from;
Al Viro8d020762014-04-05 04:27:08 -0400724 size_t left;
725 int n, idx;
726
727 ret = splice_from_pipe_next(pipe, &sd);
728 if (ret <= 0)
729 break;
730
731 if (unlikely(nbufs < pipe->buffers)) {
732 kfree(array);
733 nbufs = pipe->buffers;
734 array = kcalloc(nbufs, sizeof(struct bio_vec),
735 GFP_KERNEL);
736 if (!array) {
737 ret = -ENOMEM;
738 break;
739 }
740 }
741
742 /* build the vector */
743 left = sd.total_len;
744 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
745 struct pipe_buffer *buf = pipe->bufs + idx;
746 size_t this_len = buf->len;
747
748 if (this_len > left)
749 this_len = left;
750
751 if (idx == pipe->buffers - 1)
752 idx = -1;
753
Miklos Szeredifba597d2016-09-27 10:45:12 +0200754 ret = pipe_buf_confirm(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400755 if (unlikely(ret)) {
756 if (ret == -ENODATA)
757 ret = 0;
758 goto done;
759 }
760
761 array[n].bv_page = buf->page;
762 array[n].bv_len = this_len;
763 array[n].bv_offset = buf->offset;
764 left -= this_len;
765 }
766
Al Viro05afcb72015-01-23 01:08:07 -0500767 iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
768 sd.total_len - left);
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100769 ret = vfs_iter_write(out, &from, &sd.pos);
Al Viro8d020762014-04-05 04:27:08 -0400770 if (ret <= 0)
771 break;
772
773 sd.num_spliced += ret;
774 sd.total_len -= ret;
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100775 *ppos = sd.pos;
Al Viro8d020762014-04-05 04:27:08 -0400776
777 /* dismiss the fully eaten buffers, adjust the partial one */
778 while (ret) {
779 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
780 if (ret >= buf->len) {
Al Viro8d020762014-04-05 04:27:08 -0400781 ret -= buf->len;
782 buf->len = 0;
Miklos Szeredia7796382016-09-27 10:45:12 +0200783 pipe_buf_release(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400784 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
785 pipe->nrbufs--;
786 if (pipe->files)
787 sd.need_wakeup = true;
788 } else {
789 buf->offset += ret;
790 buf->len -= ret;
791 ret = 0;
792 }
793 }
794 }
795done:
796 kfree(array);
797 splice_from_pipe_end(pipe, &sd);
798
799 pipe_unlock(pipe);
800
801 if (sd.num_spliced)
802 ret = sd.num_spliced;
803
804 return ret;
805}
806
807EXPORT_SYMBOL(iter_file_splice_write);
808
Miklos Szeredib2858d72009-05-19 11:37:46 +0200809static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
810 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200811{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200812 int ret;
813 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -0400814 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +0200815
Al Virofbb32752014-02-02 21:09:54 -0500816 data = kmap(buf->page);
Al Viro06ae43f2013-03-20 13:19:30 -0400817 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Al Virofbb32752014-02-02 21:09:54 -0500818 kunmap(buf->page);
Miklos Szeredib2858d72009-05-19 11:37:46 +0200819
820 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200821}
822
823static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
824 struct file *out, loff_t *ppos,
825 size_t len, unsigned int flags)
826{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200827 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200828
Miklos Szeredib2858d72009-05-19 11:37:46 +0200829 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
830 if (ret > 0)
831 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200832
Miklos Szeredib2858d72009-05-19 11:37:46 +0200833 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200834}
835
Jens Axboe83f91352006-04-02 23:05:09 +0200836/**
837 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200838 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200839 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200840 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200841 * @len: number of bytes to splice
842 * @flags: splice modifier flags
843 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200844 * Description:
845 * Will send @len bytes from the pipe to a network socket. No data copying
846 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200847 *
848 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200849ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200850 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200851{
Jens Axboe00522fb2006-04-26 14:39:29 +0200852 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200853}
854
Jens Axboe059a8f32006-04-02 23:06:05 +0200855EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500856
Jens Axboe83f91352006-04-02 23:05:09 +0200857/*
858 * Attempt to initiate a splice from pipe to file.
859 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200860static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200861 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200862{
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200863 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
864 loff_t *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200865
Al Viro72c2d532013-09-22 16:27:52 -0400866 if (out->f_op->splice_write)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100867 splice_write = out->f_op->splice_write;
868 else
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200869 splice_write = default_file_splice_write;
870
Al Viro500368f2013-05-23 20:07:11 -0400871 return splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200872}
873
Jens Axboe83f91352006-04-02 23:05:09 +0200874/*
875 * Attempt to initiate a splice from a file to a pipe.
876 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200877static long do_splice_to(struct file *in, loff_t *ppos,
878 struct pipe_inode_info *pipe, size_t len,
879 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200880{
Miklos Szeredi68181732009-05-07 15:37:36 +0200881 ssize_t (*splice_read)(struct file *, loff_t *,
882 struct pipe_inode_info *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200883 int ret;
884
Jens Axboe49570e92006-04-11 13:56:09 +0200885 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200886 return -EBADF;
887
Jens Axboecbb7e572006-04-11 14:57:50 +0200888 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200889 if (unlikely(ret < 0))
890 return ret;
891
Al Viro03cc0782016-04-02 14:56:58 -0400892 if (unlikely(len > MAX_RW_COUNT))
893 len = MAX_RW_COUNT;
894
Al Viro72c2d532013-09-22 16:27:52 -0400895 if (in->f_op->splice_read)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100896 splice_read = in->f_op->splice_read;
897 else
Miklos Szeredi68181732009-05-07 15:37:36 +0200898 splice_read = default_file_splice_read;
899
900 return splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200901}
902
Jens Axboe932cc6d2007-06-21 13:10:21 +0200903/**
904 * splice_direct_to_actor - splices data directly between two non-pipes
905 * @in: file to splice from
906 * @sd: actor information on where to splice to
907 * @actor: handles the data splicing
908 *
909 * Description:
910 * This is a special case helper to splice directly between two
911 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200912 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200913 * that process.
914 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200915 */
916ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
917 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200918{
919 struct pipe_inode_info *pipe;
920 long ret, bytes;
921 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200922 size_t len;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200923 int i, flags, more;
Jens Axboeb92ce552006-04-11 13:52:07 +0200924
925 /*
926 * We require the input being a regular file, as we don't want to
927 * randomly drop data for eg socket -> socket splicing. Use the
928 * piped splicing for that!
929 */
Al Viro496ad9a2013-01-23 17:07:38 -0500930 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200931 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
932 return -EINVAL;
933
934 /*
935 * neither in nor out is a pipe, setup an internal pipe attached to
936 * 'out' and transfer the wanted data from 'in' to 'out' through that
937 */
938 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200939 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -0400940 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +0200941 if (!pipe)
942 return -ENOMEM;
943
944 /*
945 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200946 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200947 * PIPE_READERS appropriately.
948 */
949 pipe->readers = 1;
950
951 current->splice_pipe = pipe;
952 }
953
954 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200955 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200956 */
957 ret = 0;
958 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200959 len = sd->total_len;
960 flags = sd->flags;
961
962 /*
963 * Don't block on output, we have to drain the direct pipe.
964 */
965 sd->flags &= ~SPLICE_F_NONBLOCK;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200966 more = sd->flags & SPLICE_F_MORE;
Jens Axboeb92ce552006-04-11 13:52:07 +0200967
968 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +0200969 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200970 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200971
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200972 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200973 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +0200974 goto out_release;
975
976 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200977 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +0200978
979 /*
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200980 * If more data is pending, set SPLICE_F_MORE
981 * If this is the last data and SPLICE_F_MORE was not set
982 * initially, clears it.
983 */
984 if (read_len < len)
985 sd->flags |= SPLICE_F_MORE;
986 else if (!more)
987 sd->flags &= ~SPLICE_F_MORE;
988 /*
Jens Axboeb92ce552006-04-11 13:52:07 +0200989 * NOTE: nonblocking mode only applies to the input. We
990 * must not do the output in nonblocking mode as then we
991 * could get stuck data in the internal pipe:
992 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200993 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +0200994 if (unlikely(ret <= 0)) {
995 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200996 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200997 }
Jens Axboeb92ce552006-04-11 13:52:07 +0200998
999 bytes += ret;
1000 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001001 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001002
Tom Zanussia82c53a2008-05-09 13:28:36 +02001003 if (ret < read_len) {
1004 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001005 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001006 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001007 }
1008
Jens Axboe9e971982008-01-29 21:05:57 +01001009done:
Jens Axboeb92ce552006-04-11 13:52:07 +02001010 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001011 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001012 return bytes;
1013
1014out_release:
1015 /*
1016 * If we did an incomplete transfer we must release
1017 * the pipe buffers in question:
1018 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001019 for (i = 0; i < pipe->buffers; i++) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001020 struct pipe_buffer *buf = pipe->bufs + i;
1021
Miklos Szeredia7796382016-09-27 10:45:12 +02001022 if (buf->ops)
1023 pipe_buf_release(pipe, buf);
Jens Axboeb92ce552006-04-11 13:52:07 +02001024 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001025
Jens Axboe9e971982008-01-29 21:05:57 +01001026 if (!bytes)
1027 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001028
Jens Axboe9e971982008-01-29 21:05:57 +01001029 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001030}
1031EXPORT_SYMBOL(splice_direct_to_actor);
1032
1033static int direct_splice_actor(struct pipe_inode_info *pipe,
1034 struct splice_desc *sd)
1035{
Jens Axboe6a14b902007-06-14 13:08:55 +02001036 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001037
Al Viro7995bd22013-06-20 18:58:36 +04001038 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001039 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001040}
1041
Jens Axboe932cc6d2007-06-21 13:10:21 +02001042/**
1043 * do_splice_direct - splices data directly between two files
1044 * @in: file to splice from
1045 * @ppos: input file offset
1046 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001047 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001048 * @len: number of bytes to splice
1049 * @flags: splice modifier flags
1050 *
1051 * Description:
1052 * For use by do_sendfile(). splice can easily emulate sendfile, but
1053 * doing it in the application would incur an extra system call
1054 * (splice in + splice out, as compared to just sendfile()). So this helper
1055 * can splice directly through a process-private pipe.
1056 *
1057 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001058long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001059 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001060{
1061 struct splice_desc sd = {
1062 .len = len,
1063 .total_len = len,
1064 .flags = flags,
1065 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001066 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001067 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001068 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001069 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001070
Al Viro18c67cb2013-06-19 15:41:54 +04001071 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1072 return -EBADF;
1073
1074 if (unlikely(out->f_flags & O_APPEND))
1075 return -EINVAL;
1076
1077 ret = rw_verify_area(WRITE, out, opos, len);
1078 if (unlikely(ret < 0))
1079 return ret;
1080
Jens Axboec66ab6f2007-06-12 21:17:17 +02001081 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001082 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001083 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001084
Jens Axboec66ab6f2007-06-12 21:17:17 +02001085 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001086}
Miklos Szeredi1c118592014-10-24 00:14:35 +02001087EXPORT_SYMBOL(do_splice_direct);
Jens Axboeb92ce552006-04-11 13:52:07 +02001088
Al Viro8924fef2016-09-17 20:44:45 -04001089static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1090{
Linus Torvalds52bce912016-12-21 10:59:34 -08001091 for (;;) {
1092 if (unlikely(!pipe->readers)) {
1093 send_sig(SIGPIPE, current, 0);
1094 return -EPIPE;
1095 }
1096 if (pipe->nrbufs != pipe->buffers)
1097 return 0;
Al Viro8924fef2016-09-17 20:44:45 -04001098 if (flags & SPLICE_F_NONBLOCK)
1099 return -EAGAIN;
1100 if (signal_pending(current))
1101 return -ERESTARTSYS;
1102 pipe->waiting_writers++;
1103 pipe_wait(pipe);
1104 pipe->waiting_writers--;
1105 }
Al Viro8924fef2016-09-17 20:44:45 -04001106}
1107
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001108static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1109 struct pipe_inode_info *opipe,
1110 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001111
1112/*
Jens Axboe83f91352006-04-02 23:05:09 +02001113 * Determine where to splice to/from.
1114 */
Ingo Molnar529565d2006-04-10 15:18:58 +02001115static long do_splice(struct file *in, loff_t __user *off_in,
1116 struct file *out, loff_t __user *off_out,
1117 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001118{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001119 struct pipe_inode_info *ipipe;
1120 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001121 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001122 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001123
Linus Torvalds71993e62010-11-28 13:56:09 -08001124 ipipe = get_pipe_info(in);
1125 opipe = get_pipe_info(out);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001126
1127 if (ipipe && opipe) {
1128 if (off_in || off_out)
1129 return -ESPIPE;
1130
1131 if (!(in->f_mode & FMODE_READ))
1132 return -EBADF;
1133
1134 if (!(out->f_mode & FMODE_WRITE))
1135 return -EBADF;
1136
1137 /* Splicing to self would be fun, but... */
1138 if (ipipe == opipe)
1139 return -EINVAL;
1140
1141 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1142 }
1143
1144 if (ipipe) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001145 if (off_in)
1146 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001147 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001148 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001149 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001150 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001151 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001152 } else {
1153 offset = out->f_pos;
1154 }
Ingo Molnar529565d2006-04-10 15:18:58 +02001155
Al Viro18c67cb2013-06-19 15:41:54 +04001156 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1157 return -EBADF;
1158
1159 if (unlikely(out->f_flags & O_APPEND))
1160 return -EINVAL;
1161
1162 ret = rw_verify_area(WRITE, out, &offset, len);
1163 if (unlikely(ret < 0))
1164 return ret;
1165
Al Viro500368f2013-05-23 20:07:11 -04001166 file_start_write(out);
Al Viro7995bd22013-06-20 18:58:36 +04001167 ret = do_splice_from(ipipe, out, &offset, len, flags);
Al Viro500368f2013-05-23 20:07:11 -04001168 file_end_write(out);
Jens Axboea4514eb2006-04-19 15:57:05 +02001169
Al Viro7995bd22013-06-20 18:58:36 +04001170 if (!off_out)
1171 out->f_pos = offset;
1172 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001173 ret = -EFAULT;
1174
1175 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001176 }
Jens Axboe5274f052006-03-30 15:15:30 +02001177
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001178 if (opipe) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001179 if (off_out)
1180 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001181 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001182 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001183 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001184 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001185 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001186 } else {
1187 offset = in->f_pos;
1188 }
Ingo Molnar529565d2006-04-10 15:18:58 +02001189
Al Viro8924fef2016-09-17 20:44:45 -04001190 pipe_lock(opipe);
1191 ret = wait_for_space(opipe, flags);
1192 if (!ret)
1193 ret = do_splice_to(in, &offset, opipe, len, flags);
1194 pipe_unlock(opipe);
1195 if (ret > 0)
1196 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001197 if (!off_in)
1198 in->f_pos = offset;
1199 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001200 ret = -EFAULT;
1201
1202 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001203 }
Jens Axboe5274f052006-03-30 15:15:30 +02001204
1205 return -EINVAL;
1206}
1207
Al Viro79fddc42016-09-17 22:38:20 -04001208static int iter_to_pipe(struct iov_iter *from,
1209 struct pipe_inode_info *pipe,
1210 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001211{
Al Viro79fddc42016-09-17 22:38:20 -04001212 struct pipe_buffer buf = {
1213 .ops = &user_page_pipe_buf_ops,
1214 .flags = flags
1215 };
1216 size_t total = 0;
1217 int ret = 0;
1218 bool failed = false;
1219
1220 while (iov_iter_count(from) && !failed) {
1221 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001222 ssize_t copied;
1223 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001224 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001225
Al Viro79fddc42016-09-17 22:38:20 -04001226 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1227 if (copied <= 0) {
1228 ret = copied;
1229 break;
1230 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001231
Al Viro79fddc42016-09-17 22:38:20 -04001232 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001233 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001234 if (!failed) {
1235 buf.page = pages[n];
1236 buf.offset = start;
1237 buf.len = size;
1238 ret = add_to_pipe(pipe, &buf);
1239 if (unlikely(ret < 0)) {
1240 failed = true;
1241 } else {
1242 iov_iter_advance(from, ret);
1243 total += ret;
1244 }
1245 } else {
1246 put_page(pages[n]);
1247 }
Al Virodb85a9e2016-09-17 20:25:06 -04001248 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001249 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001250 }
Al Viro79fddc42016-09-17 22:38:20 -04001251 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001252}
1253
Jens Axboe6a14b902007-06-14 13:08:55 +02001254static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1255 struct splice_desc *sd)
1256{
Al Viro6130f532014-02-03 18:19:51 -05001257 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1258 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001259}
1260
1261/*
1262 * For lack of a better implementation, implement vmsplice() to userspace
1263 * as a simple copy of the pipes pages to the user iov.
1264 */
Al Viro6130f532014-02-03 18:19:51 -05001265static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001266 unsigned long nr_segs, unsigned int flags)
1267{
1268 struct pipe_inode_info *pipe;
1269 struct splice_desc sd;
Jens Axboe6a14b902007-06-14 13:08:55 +02001270 long ret;
Al Viro6130f532014-02-03 18:19:51 -05001271 struct iovec iovstack[UIO_FASTIOV];
1272 struct iovec *iov = iovstack;
1273 struct iov_iter iter;
Jens Axboe6a14b902007-06-14 13:08:55 +02001274
Linus Torvalds71993e62010-11-28 13:56:09 -08001275 pipe = get_pipe_info(file);
Jens Axboe6a14b902007-06-14 13:08:55 +02001276 if (!pipe)
1277 return -EBADF;
1278
Al Viro345995f2015-03-21 19:17:55 -04001279 ret = import_iovec(READ, uiov, nr_segs,
1280 ARRAY_SIZE(iovstack), &iov, &iter);
1281 if (ret < 0)
1282 return ret;
Al Viro6130f532014-02-03 18:19:51 -05001283
Al Viro345995f2015-03-21 19:17:55 -04001284 sd.total_len = iov_iter_count(&iter);
Al Viro6130f532014-02-03 18:19:51 -05001285 sd.len = 0;
Al Viro6130f532014-02-03 18:19:51 -05001286 sd.flags = flags;
1287 sd.u.data = &iter;
1288 sd.pos = 0;
1289
Al Viro345995f2015-03-21 19:17:55 -04001290 if (sd.total_len) {
1291 pipe_lock(pipe);
1292 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1293 pipe_unlock(pipe);
1294 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001295
Al Viro345995f2015-03-21 19:17:55 -04001296 kfree(iov);
Jens Axboe6a14b902007-06-14 13:08:55 +02001297 return ret;
1298}
1299
Jens Axboe912d35f2006-04-26 10:59:21 +02001300/*
1301 * vmsplice splices a user address range into a pipe. It can be thought of
1302 * as splice-from-memory, where the regular splice is splice-from-file (or
1303 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001304 */
Al Virodb85a9e2016-09-17 20:25:06 -04001305static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001306 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001307{
Jens Axboeddac0d32006-11-04 12:49:32 +01001308 struct pipe_inode_info *pipe;
Al Virodb85a9e2016-09-17 20:25:06 -04001309 struct iovec iovstack[UIO_FASTIOV];
1310 struct iovec *iov = iovstack;
1311 struct iov_iter from;
Jens Axboe35f3d142010-05-20 10:43:18 +02001312 long ret;
Al Viro79fddc42016-09-17 22:38:20 -04001313 unsigned buf_flag = 0;
1314
1315 if (flags & SPLICE_F_GIFT)
1316 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001317
Linus Torvalds71993e62010-11-28 13:56:09 -08001318 pipe = get_pipe_info(file);
Jens Axboeddac0d32006-11-04 12:49:32 +01001319 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001320 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001321
Al Virodb85a9e2016-09-17 20:25:06 -04001322 ret = import_iovec(WRITE, uiov, nr_segs,
1323 ARRAY_SIZE(iovstack), &iov, &from);
1324 if (ret < 0)
1325 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001326
Al Viro8924fef2016-09-17 20:44:45 -04001327 pipe_lock(pipe);
1328 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001329 if (!ret)
1330 ret = iter_to_pipe(&from, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001331 pipe_unlock(pipe);
1332 if (ret > 0)
1333 wakeup_pipe_readers(pipe);
Al Virodb85a9e2016-09-17 20:25:06 -04001334 kfree(iov);
Jens Axboe35f3d142010-05-20 10:43:18 +02001335 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001336}
1337
Jens Axboe6a14b902007-06-14 13:08:55 +02001338/*
1339 * Note that vmsplice only really supports true splicing _from_ user memory
1340 * to a pipe, not the other way around. Splicing from user memory is a simple
1341 * operation that can be supported without any funky alignment restrictions
1342 * or nasty vm tricks. We simply map in the user memory and fill them into
1343 * a pipe. The reverse isn't quite as easy, though. There are two possible
1344 * solutions for that:
1345 *
1346 * - memcpy() the data internally, at which point we might as well just
1347 * do a regular read() on the buffer anyway.
1348 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1349 * has restriction limitations on both ends of the pipe).
1350 *
1351 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1352 *
1353 */
Heiko Carstens836f92a2009-01-14 14:14:33 +01001354SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1355 unsigned long, nr_segs, unsigned int, flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001356{
Al Viro2903ff02012-08-28 12:52:22 -04001357 struct fd f;
Jens Axboe912d35f2006-04-26 10:59:21 +02001358 long error;
Jens Axboe912d35f2006-04-26 10:59:21 +02001359
Jens Axboe6a14b902007-06-14 13:08:55 +02001360 if (unlikely(nr_segs > UIO_MAXIOV))
1361 return -EINVAL;
1362 else if (unlikely(!nr_segs))
1363 return 0;
1364
Jens Axboe912d35f2006-04-26 10:59:21 +02001365 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001366 f = fdget(fd);
1367 if (f.file) {
1368 if (f.file->f_mode & FMODE_WRITE)
1369 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1370 else if (f.file->f_mode & FMODE_READ)
1371 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001372
Al Viro2903ff02012-08-28 12:52:22 -04001373 fdput(f);
Jens Axboe912d35f2006-04-26 10:59:21 +02001374 }
1375
1376 return error;
1377}
1378
Al Viro76b021d2013-03-02 10:19:56 -05001379#ifdef CONFIG_COMPAT
1380COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1381 unsigned int, nr_segs, unsigned int, flags)
1382{
1383 unsigned i;
1384 struct iovec __user *iov;
1385 if (nr_segs > UIO_MAXIOV)
1386 return -EINVAL;
1387 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1388 for (i = 0; i < nr_segs; i++) {
1389 struct compat_iovec v;
1390 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1391 get_user(v.iov_len, &iov32[i].iov_len) ||
1392 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1393 put_user(v.iov_len, &iov[i].iov_len))
1394 return -EFAULT;
1395 }
1396 return sys_vmsplice(fd, iov, nr_segs, flags);
1397}
1398#endif
1399
Heiko Carstens836f92a2009-01-14 14:14:33 +01001400SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1401 int, fd_out, loff_t __user *, off_out,
1402 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001403{
Al Viro2903ff02012-08-28 12:52:22 -04001404 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001405 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001406
1407 if (unlikely(!len))
1408 return 0;
1409
1410 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001411 in = fdget(fd_in);
1412 if (in.file) {
1413 if (in.file->f_mode & FMODE_READ) {
1414 out = fdget(fd_out);
1415 if (out.file) {
1416 if (out.file->f_mode & FMODE_WRITE)
1417 error = do_splice(in.file, off_in,
1418 out.file, off_out,
Ingo Molnar529565d2006-04-10 15:18:58 +02001419 len, flags);
Al Viro2903ff02012-08-28 12:52:22 -04001420 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001421 }
1422 }
Al Viro2903ff02012-08-28 12:52:22 -04001423 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001424 }
Jens Axboe5274f052006-03-30 15:15:30 +02001425 return error;
1426}
Jens Axboe70524492006-04-11 15:51:17 +02001427
1428/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001429 * Make sure there's data to read. Wait for input if we can, otherwise
1430 * return an appropriate error.
1431 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001432static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001433{
1434 int ret;
1435
1436 /*
1437 * Check ->nrbufs without the inode lock first. This function
1438 * is speculative anyways, so missing one is ok.
1439 */
1440 if (pipe->nrbufs)
1441 return 0;
1442
1443 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001444 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001445
1446 while (!pipe->nrbufs) {
1447 if (signal_pending(current)) {
1448 ret = -ERESTARTSYS;
1449 break;
1450 }
1451 if (!pipe->writers)
1452 break;
1453 if (!pipe->waiting_writers) {
1454 if (flags & SPLICE_F_NONBLOCK) {
1455 ret = -EAGAIN;
1456 break;
1457 }
1458 }
1459 pipe_wait(pipe);
1460 }
1461
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001462 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001463 return ret;
1464}
1465
1466/*
1467 * Make sure there's writeable room. Wait for room if we can, otherwise
1468 * return an appropriate error.
1469 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001470static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001471{
1472 int ret;
1473
1474 /*
1475 * Check ->nrbufs without the inode lock first. This function
1476 * is speculative anyways, so missing one is ok.
1477 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001478 if (pipe->nrbufs < pipe->buffers)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001479 return 0;
1480
1481 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001482 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001483
Jens Axboe35f3d142010-05-20 10:43:18 +02001484 while (pipe->nrbufs >= pipe->buffers) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001485 if (!pipe->readers) {
1486 send_sig(SIGPIPE, current, 0);
1487 ret = -EPIPE;
1488 break;
1489 }
1490 if (flags & SPLICE_F_NONBLOCK) {
1491 ret = -EAGAIN;
1492 break;
1493 }
1494 if (signal_pending(current)) {
1495 ret = -ERESTARTSYS;
1496 break;
1497 }
1498 pipe->waiting_writers++;
1499 pipe_wait(pipe);
1500 pipe->waiting_writers--;
1501 }
1502
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001503 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001504 return ret;
1505}
1506
1507/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001508 * Splice contents of ipipe to opipe.
1509 */
1510static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1511 struct pipe_inode_info *opipe,
1512 size_t len, unsigned int flags)
1513{
1514 struct pipe_buffer *ibuf, *obuf;
1515 int ret = 0, nbuf;
1516 bool input_wakeup = false;
1517
1518
1519retry:
1520 ret = ipipe_prep(ipipe, flags);
1521 if (ret)
1522 return ret;
1523
1524 ret = opipe_prep(opipe, flags);
1525 if (ret)
1526 return ret;
1527
1528 /*
1529 * Potential ABBA deadlock, work around it by ordering lock
1530 * grabbing by pipe info address. Otherwise two different processes
1531 * could deadlock (one doing tee from A -> B, the other from B -> A).
1532 */
1533 pipe_double_lock(ipipe, opipe);
1534
1535 do {
1536 if (!opipe->readers) {
1537 send_sig(SIGPIPE, current, 0);
1538 if (!ret)
1539 ret = -EPIPE;
1540 break;
1541 }
1542
1543 if (!ipipe->nrbufs && !ipipe->writers)
1544 break;
1545
1546 /*
1547 * Cannot make any progress, because either the input
1548 * pipe is empty or the output pipe is full.
1549 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001550 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001551 /* Already processed some buffers, break */
1552 if (ret)
1553 break;
1554
1555 if (flags & SPLICE_F_NONBLOCK) {
1556 ret = -EAGAIN;
1557 break;
1558 }
1559
1560 /*
1561 * We raced with another reader/writer and haven't
1562 * managed to process any buffers. A zero return
1563 * value means EOF, so retry instead.
1564 */
1565 pipe_unlock(ipipe);
1566 pipe_unlock(opipe);
1567 goto retry;
1568 }
1569
1570 ibuf = ipipe->bufs + ipipe->curbuf;
Jens Axboe35f3d142010-05-20 10:43:18 +02001571 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001572 obuf = opipe->bufs + nbuf;
1573
1574 if (len >= ibuf->len) {
1575 /*
1576 * Simply move the whole buffer from ipipe to opipe
1577 */
1578 *obuf = *ibuf;
1579 ibuf->ops = NULL;
1580 opipe->nrbufs++;
Jens Axboe35f3d142010-05-20 10:43:18 +02001581 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001582 ipipe->nrbufs--;
1583 input_wakeup = true;
1584 } else {
1585 /*
1586 * Get a reference to this pipe buffer,
1587 * so we can copy the contents over.
1588 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001589 pipe_buf_get(ipipe, ibuf);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001590 *obuf = *ibuf;
1591
1592 /*
1593 * Don't inherit the gift flag, we need to
1594 * prevent multiple steals of this page.
1595 */
1596 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1597
1598 obuf->len = len;
1599 opipe->nrbufs++;
1600 ibuf->offset += obuf->len;
1601 ibuf->len -= obuf->len;
1602 }
1603 ret += obuf->len;
1604 len -= obuf->len;
1605 } while (len);
1606
1607 pipe_unlock(ipipe);
1608 pipe_unlock(opipe);
1609
1610 /*
1611 * If we put data in the output pipe, wakeup any potential readers.
1612 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001613 if (ret > 0)
1614 wakeup_pipe_readers(opipe);
1615
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001616 if (input_wakeup)
1617 wakeup_pipe_writers(ipipe);
1618
1619 return ret;
1620}
1621
1622/*
Jens Axboe70524492006-04-11 15:51:17 +02001623 * Link contents of ipipe to opipe.
1624 */
1625static int link_pipe(struct pipe_inode_info *ipipe,
1626 struct pipe_inode_info *opipe,
1627 size_t len, unsigned int flags)
1628{
1629 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001630 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001631
1632 /*
1633 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001634 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001635 * could deadlock (one doing tee from A -> B, the other from B -> A).
1636 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001637 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001638
Jens Axboeaadd06e2006-07-10 11:00:01 +02001639 do {
Jens Axboe70524492006-04-11 15:51:17 +02001640 if (!opipe->readers) {
1641 send_sig(SIGPIPE, current, 0);
1642 if (!ret)
1643 ret = -EPIPE;
1644 break;
1645 }
Jens Axboe70524492006-04-11 15:51:17 +02001646
1647 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001648 * If we have iterated all input buffers or ran out of
1649 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001650 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001651 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
Jens Axboe70524492006-04-11 15:51:17 +02001652 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001653
Jens Axboe35f3d142010-05-20 10:43:18 +02001654 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1655 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001656
Jens Axboe2a27250e2006-04-19 15:56:40 +02001657 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001658 * Get a reference to this pipe buffer,
1659 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001660 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001661 pipe_buf_get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001662
Jens Axboeaadd06e2006-07-10 11:00:01 +02001663 obuf = opipe->bufs + nbuf;
1664 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001665
Jens Axboeaadd06e2006-07-10 11:00:01 +02001666 /*
1667 * Don't inherit the gift flag, we need to
1668 * prevent multiple steals of this page.
1669 */
1670 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1671
1672 if (obuf->len > len)
1673 obuf->len = len;
1674
1675 opipe->nrbufs++;
1676 ret += obuf->len;
1677 len -= obuf->len;
1678 i++;
1679 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001680
Jens Axboe02cf01a2008-02-20 10:34:51 +01001681 /*
1682 * return EAGAIN if we have the potential of some data in the
1683 * future, otherwise just return 0
1684 */
1685 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1686 ret = -EAGAIN;
1687
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001688 pipe_unlock(ipipe);
1689 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001690
Jens Axboeaadd06e2006-07-10 11:00:01 +02001691 /*
1692 * If we put data in the output pipe, wakeup any potential readers.
1693 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001694 if (ret > 0)
1695 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001696
1697 return ret;
1698}
1699
1700/*
1701 * This is a tee(1) implementation that works on pipes. It doesn't copy
1702 * any data, it simply references the 'in' pages on the 'out' pipe.
1703 * The 'flags' used are the SPLICE_F_* variants, currently the only
1704 * applicable one is SPLICE_F_NONBLOCK.
1705 */
1706static long do_tee(struct file *in, struct file *out, size_t len,
1707 unsigned int flags)
1708{
Linus Torvalds71993e62010-11-28 13:56:09 -08001709 struct pipe_inode_info *ipipe = get_pipe_info(in);
1710 struct pipe_inode_info *opipe = get_pipe_info(out);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001711 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001712
1713 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001714 * Duplicate the contents of ipipe to opipe without actually
1715 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001716 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001717 if (ipipe && opipe && ipipe != opipe) {
1718 /*
1719 * Keep going, unless we encounter an error. The ipipe/opipe
1720 * ordering doesn't really matter.
1721 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001722 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001723 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001724 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001725 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001726 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001727 }
1728 }
Jens Axboe70524492006-04-11 15:51:17 +02001729
Jens Axboeaadd06e2006-07-10 11:00:01 +02001730 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001731}
1732
Heiko Carstens836f92a2009-01-14 14:14:33 +01001733SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001734{
Al Viro2903ff02012-08-28 12:52:22 -04001735 struct fd in;
1736 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001737
1738 if (unlikely(!len))
1739 return 0;
1740
1741 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001742 in = fdget(fdin);
1743 if (in.file) {
1744 if (in.file->f_mode & FMODE_READ) {
1745 struct fd out = fdget(fdout);
1746 if (out.file) {
1747 if (out.file->f_mode & FMODE_WRITE)
1748 error = do_tee(in.file, out.file,
1749 len, flags);
1750 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001751 }
1752 }
Al Viro2903ff02012-08-28 12:52:22 -04001753 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001754 }
1755
1756 return error;
1757}