blob: 153d4f3bd441febd7004b1862cd218afc0ee6252 [file] [log] [blame]
Jens Axboe5274f052006-03-30 15:15:30 +02001/*
2 * "splice": joining two ropes together by interweaving their strands.
3 *
4 * This is the "extended pipe" functionality, where a pipe is used as
5 * an arbitrary in-memory buffer. Think of a pipe as a small kernel
6 * buffer that you can use to transfer data from one end to the other.
7 *
8 * The traditional unix read/write is extended with a "splice()" operation
9 * that transfers data buffers to or from a pipe buffer.
10 *
11 * Named by Larry McVoy, original implementation from Linus, extended by
Jens Axboec2058e02006-04-11 13:56:34 +020012 * Jens to support splicing to files, network, direct splicing, etc and
13 * fixing lots of bugs.
Jens Axboe5274f052006-03-30 15:15:30 +020014 *
Jens Axboe0fe23472006-09-04 15:41:16 +020015 * Copyright (C) 2005-2006 Jens Axboe <axboe@kernel.dk>
Jens Axboec2058e02006-04-11 13:56:34 +020016 * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
17 * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
Jens Axboe5274f052006-03-30 15:15:30 +020018 *
19 */
20#include <linux/fs.h>
21#include <linux/file.h>
22#include <linux/pagemap.h>
Jens Axboed6b29d72007-06-04 09:59:47 +020023#include <linux/splice.h>
KAMEZAWA Hiroyuki08e552c2009-01-07 18:08:01 -080024#include <linux/memcontrol.h>
Jens Axboe5274f052006-03-30 15:15:30 +020025#include <linux/mm_inline.h>
Jens Axboe5abc97a2006-03-30 15:16:46 +020026#include <linux/swap.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020027#include <linux/writeback.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050028#include <linux/export.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020029#include <linux/syscalls.h>
Jens Axboe912d35f2006-04-26 10:59:21 +020030#include <linux/uio.h>
James Morris29ce2052007-07-13 11:44:32 +020031#include <linux/security.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090032#include <linux/gfp.h>
Eric Dumazet35f9c092012-04-05 03:05:35 +000033#include <linux/socket.h>
Al Viro76b021d2013-03-02 10:19:56 -050034#include <linux/compat.h>
Al Viro06ae43f2013-03-20 13:19:30 -040035#include "internal.h"
Jens Axboe5274f052006-03-30 15:15:30 +020036
Jens Axboe83f91352006-04-02 23:05:09 +020037/*
38 * Attempt to steal a page from a pipe buffer. This should perhaps go into
39 * a vm helper function, it's already simplified quite a bit by the
40 * addition of remove_mapping(). If success is returned, the caller may
41 * attempt to reuse this page for another destination.
42 */
Jens Axboe76ad4d12006-05-03 10:41:33 +020043static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
Jens Axboe5abc97a2006-03-30 15:16:46 +020044 struct pipe_buffer *buf)
45{
46 struct page *page = buf->page;
Jens Axboe9e94cd42006-06-20 15:01:12 +020047 struct address_space *mapping;
Jens Axboe5abc97a2006-03-30 15:16:46 +020048
Jens Axboe9e0267c2006-04-19 15:57:31 +020049 lock_page(page);
50
Jens Axboe9e94cd42006-06-20 15:01:12 +020051 mapping = page_mapping(page);
52 if (mapping) {
53 WARN_ON(!PageUptodate(page));
Jens Axboe5abc97a2006-03-30 15:16:46 +020054
Jens Axboe9e94cd42006-06-20 15:01:12 +020055 /*
56 * At least for ext2 with nobh option, we need to wait on
57 * writeback completing on this page, since we'll remove it
58 * from the pagecache. Otherwise truncate wont wait on the
59 * page, allowing the disk blocks to be reused by someone else
60 * before we actually wrote our data to them. fs corruption
61 * ensues.
62 */
63 wait_on_page_writeback(page);
Jens Axboead8d6f02006-04-02 23:10:32 +020064
David Howells266cf652009-04-03 16:42:36 +010065 if (page_has_private(page) &&
66 !try_to_release_page(page, GFP_KERNEL))
Jens Axboeca39d652008-05-20 21:27:41 +020067 goto out_unlock;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020068
Jens Axboe9e94cd42006-06-20 15:01:12 +020069 /*
70 * If we succeeded in removing the mapping, set LRU flag
71 * and return good.
72 */
73 if (remove_mapping(mapping, page)) {
74 buf->flags |= PIPE_BUF_FLAG_LRU;
75 return 0;
76 }
Jens Axboe9e0267c2006-04-19 15:57:31 +020077 }
Jens Axboe5abc97a2006-03-30 15:16:46 +020078
Jens Axboe9e94cd42006-06-20 15:01:12 +020079 /*
80 * Raced with truncate or failed to remove page from current
81 * address space, unlock and return failure.
82 */
Jens Axboeca39d652008-05-20 21:27:41 +020083out_unlock:
Jens Axboe9e94cd42006-06-20 15:01:12 +020084 unlock_page(page);
85 return 1;
Jens Axboe5abc97a2006-03-30 15:16:46 +020086}
87
Jens Axboe76ad4d12006-05-03 10:41:33 +020088static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +020089 struct pipe_buffer *buf)
90{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030091 put_page(buf->page);
Jens Axboe14328732006-05-03 10:35:26 +020092 buf->flags &= ~PIPE_BUF_FLAG_LRU;
Jens Axboe5274f052006-03-30 15:15:30 +020093}
94
Jens Axboe08457182007-06-12 20:51:32 +020095/*
96 * Check whether the contents of buf is OK to access. Since the content
97 * is a page cache page, IO may be in flight.
98 */
Jens Axboecac36bb02007-06-14 13:10:48 +020099static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
100 struct pipe_buffer *buf)
Jens Axboe5274f052006-03-30 15:15:30 +0200101{
102 struct page *page = buf->page;
Jens Axboe49d0b212006-04-10 09:04:41 +0200103 int err;
Jens Axboe5274f052006-03-30 15:15:30 +0200104
105 if (!PageUptodate(page)) {
Jens Axboe49d0b212006-04-10 09:04:41 +0200106 lock_page(page);
107
108 /*
109 * Page got truncated/unhashed. This will cause a 0-byte
Ingo Molnar73d62d82006-04-11 13:57:21 +0200110 * splice, if this is the first page.
Jens Axboe49d0b212006-04-10 09:04:41 +0200111 */
112 if (!page->mapping) {
113 err = -ENODATA;
114 goto error;
115 }
116
117 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200118 * Uh oh, read-error from disk.
Jens Axboe49d0b212006-04-10 09:04:41 +0200119 */
120 if (!PageUptodate(page)) {
121 err = -EIO;
122 goto error;
123 }
124
125 /*
Jens Axboef84d7512006-05-01 19:59:03 +0200126 * Page is ok afterall, we are done.
Jens Axboe49d0b212006-04-10 09:04:41 +0200127 */
Jens Axboe5274f052006-03-30 15:15:30 +0200128 unlock_page(page);
Jens Axboe5274f052006-03-30 15:15:30 +0200129 }
130
Jens Axboef84d7512006-05-01 19:59:03 +0200131 return 0;
Jens Axboe49d0b212006-04-10 09:04:41 +0200132error:
133 unlock_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200134 return err;
Jens Axboe70524492006-04-11 15:51:17 +0200135}
136
Hugh Dickins708e3502011-07-25 17:12:32 -0700137const struct pipe_buf_operations page_cache_pipe_buf_ops = {
Jens Axboe5274f052006-03-30 15:15:30 +0200138 .can_merge = 0,
Jens Axboecac36bb02007-06-14 13:10:48 +0200139 .confirm = page_cache_pipe_buf_confirm,
Jens Axboe5274f052006-03-30 15:15:30 +0200140 .release = page_cache_pipe_buf_release,
Jens Axboe5abc97a2006-03-30 15:16:46 +0200141 .steal = page_cache_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200142 .get = generic_pipe_buf_get,
Jens Axboe5274f052006-03-30 15:15:30 +0200143};
144
Jens Axboe912d35f2006-04-26 10:59:21 +0200145static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
146 struct pipe_buffer *buf)
147{
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200148 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
149 return 1;
150
Jens Axboe14328732006-05-03 10:35:26 +0200151 buf->flags |= PIPE_BUF_FLAG_LRU;
Jens Axboe330ab712006-05-02 15:29:57 +0200152 return generic_pipe_buf_steal(pipe, buf);
Jens Axboe912d35f2006-04-26 10:59:21 +0200153}
154
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800155static const struct pipe_buf_operations user_page_pipe_buf_ops = {
Jens Axboe912d35f2006-04-26 10:59:21 +0200156 .can_merge = 0,
Jens Axboecac36bb02007-06-14 13:10:48 +0200157 .confirm = generic_pipe_buf_confirm,
Jens Axboe912d35f2006-04-26 10:59:21 +0200158 .release = page_cache_pipe_buf_release,
159 .steal = user_page_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200160 .get = generic_pipe_buf_get,
Jens Axboe912d35f2006-04-26 10:59:21 +0200161};
162
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200163static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
164{
165 smp_mb();
166 if (waitqueue_active(&pipe->wait))
167 wake_up_interruptible(&pipe->wait);
168 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
169}
170
Jens Axboe932cc6d2007-06-21 13:10:21 +0200171/**
172 * splice_to_pipe - fill passed data into a pipe
173 * @pipe: pipe to fill
174 * @spd: data to fill
175 *
176 * Description:
Randy Dunlap79685b82007-07-27 08:08:51 +0200177 * @spd contains a map of pages and len/offset tuples, along with
Jens Axboe932cc6d2007-06-21 13:10:21 +0200178 * the struct pipe_buf_operations associated with these pages. This
179 * function will link that data to the pipe.
180 *
Jens Axboe83f91352006-04-02 23:05:09 +0200181 */
Jens Axboed6b29d72007-06-04 09:59:47 +0200182ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
183 struct splice_pipe_desc *spd)
Jens Axboe5274f052006-03-30 15:15:30 +0200184{
Jens Axboe00de00b2007-06-15 13:14:22 +0200185 unsigned int spd_pages = spd->nr_pages;
Al Viro8924fef2016-09-17 20:44:45 -0400186 int ret = 0, page_nr = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200187
Rabin Vincentd6785d92016-03-10 21:19:06 +0100188 if (!spd_pages)
189 return 0;
190
Al Viro8924fef2016-09-17 20:44:45 -0400191 if (unlikely(!pipe->readers)) {
192 send_sig(SIGPIPE, current, 0);
193 ret = -EPIPE;
194 goto out;
Jens Axboe5274f052006-03-30 15:15:30 +0200195 }
196
Al Viro8924fef2016-09-17 20:44:45 -0400197 while (pipe->nrbufs < pipe->buffers) {
198 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
199 struct pipe_buffer *buf = pipe->bufs + newbuf;
Jens Axboe5274f052006-03-30 15:15:30 +0200200
Al Viro8924fef2016-09-17 20:44:45 -0400201 buf->page = spd->pages[page_nr];
202 buf->offset = spd->partial[page_nr].offset;
203 buf->len = spd->partial[page_nr].len;
204 buf->private = spd->partial[page_nr].private;
205 buf->ops = spd->ops;
Jens Axboe5274f052006-03-30 15:15:30 +0200206
Al Viro8924fef2016-09-17 20:44:45 -0400207 pipe->nrbufs++;
208 page_nr++;
209 ret += buf->len;
210
211 if (!--spd->nr_pages)
212 break;
213 }
214
215 if (!ret)
216 ret = -EAGAIN;
217
218out:
Jens Axboe00de00b2007-06-15 13:14:22 +0200219 while (page_nr < spd_pages)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800220 spd->spd_release(spd, page_nr++);
Jens Axboe5274f052006-03-30 15:15:30 +0200221
222 return ret;
223}
Hannes Frederic Sowa2b514572015-05-21 17:00:01 +0200224EXPORT_SYMBOL_GPL(splice_to_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200225
Al Viro79fddc42016-09-17 22:38:20 -0400226ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
227{
228 int ret;
229
230 if (unlikely(!pipe->readers)) {
231 send_sig(SIGPIPE, current, 0);
232 ret = -EPIPE;
233 } else if (pipe->nrbufs == pipe->buffers) {
234 ret = -EAGAIN;
235 } else {
236 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
237 pipe->bufs[newbuf] = *buf;
238 pipe->nrbufs++;
239 return buf->len;
240 }
Miklos Szeredia7796382016-09-27 10:45:12 +0200241 pipe_buf_release(pipe, buf);
Al Viro79fddc42016-09-17 22:38:20 -0400242 return ret;
243}
244EXPORT_SYMBOL(add_to_pipe);
245
Hugh Dickins708e3502011-07-25 17:12:32 -0700246void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800247{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300248 put_page(spd->pages[i]);
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800249}
250
Jens Axboe35f3d142010-05-20 10:43:18 +0200251/*
252 * Check if we need to grow the arrays holding pages and partial page
253 * descriptions.
254 */
Eric Dumazet047fe362012-06-12 15:24:40 +0200255int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200256{
Eric Dumazet047fe362012-06-12 15:24:40 +0200257 unsigned int buffers = ACCESS_ONCE(pipe->buffers);
258
259 spd->nr_pages_max = buffers;
260 if (buffers <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200261 return 0;
262
Eric Dumazet047fe362012-06-12 15:24:40 +0200263 spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
264 spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200265
266 if (spd->pages && spd->partial)
267 return 0;
268
269 kfree(spd->pages);
270 kfree(spd->partial);
271 return -ENOMEM;
272}
273
Eric Dumazet047fe362012-06-12 15:24:40 +0200274void splice_shrink_spd(struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200275{
Eric Dumazet047fe362012-06-12 15:24:40 +0200276 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200277 return;
278
279 kfree(spd->pages);
280 kfree(spd->partial);
281}
282
Jens Axboe83f91352006-04-02 23:05:09 +0200283/**
284 * generic_file_splice_read - splice data from file to a pipe
285 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200286 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200287 * @pipe: pipe to splice to
288 * @len: number of bytes to splice
289 * @flags: splice modifier flags
290 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200291 * Description:
292 * Will read pages from given file and fill them into a pipe. Can be
Al Viro82c156f2016-09-22 23:35:42 -0400293 * used as long as it has more or less sane ->read_iter().
Jens Axboe932cc6d2007-06-21 13:10:21 +0200294 *
Jens Axboe83f91352006-04-02 23:05:09 +0200295 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200296ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
297 struct pipe_inode_info *pipe, size_t len,
298 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200299{
Al Viro82c156f2016-09-22 23:35:42 -0400300 struct iov_iter to;
301 struct kiocb kiocb;
302 loff_t isize;
303 int idx, ret;
Boaz Harroshbe64f882015-04-15 16:15:17 -0700304
Jens Axboed366d3982007-06-01 14:54:11 +0200305 isize = i_size_read(in->f_mapping->host);
306 if (unlikely(*ppos >= isize))
307 return 0;
308
Al Viro82c156f2016-09-22 23:35:42 -0400309 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len);
310 idx = to.idx;
311 init_sync_kiocb(&kiocb, in);
312 kiocb.ki_pos = *ppos;
313 ret = in->f_op->read_iter(&kiocb, &to);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200314 if (ret > 0) {
Al Viro82c156f2016-09-22 23:35:42 -0400315 *ppos = kiocb.ki_pos;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200316 file_accessed(in);
Al Viro82c156f2016-09-22 23:35:42 -0400317 } else if (ret < 0) {
Al Viroc3a69022016-10-10 13:26:27 -0400318 to.idx = idx;
319 to.iov_offset = 0;
320 iov_iter_advance(&to, 0); /* to free what was emitted */
Al Viro82c156f2016-09-22 23:35:42 -0400321 /*
322 * callers of ->splice_read() expect -EAGAIN on
323 * "can't put anything in there", rather than -EFAULT.
324 */
325 if (ret == -EFAULT)
326 ret = -EAGAIN;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200327 }
Jens Axboe5274f052006-03-30 15:15:30 +0200328
329 return ret;
330}
Jens Axboe059a8f32006-04-02 23:06:05 +0200331EXPORT_SYMBOL(generic_file_splice_read);
332
Al Viro241699c2016-09-22 16:33:12 -0400333const struct pipe_buf_operations default_pipe_buf_ops = {
Miklos Szeredi68181732009-05-07 15:37:36 +0200334 .can_merge = 0,
Miklos Szeredi68181732009-05-07 15:37:36 +0200335 .confirm = generic_pipe_buf_confirm,
336 .release = generic_pipe_buf_release,
337 .steal = generic_pipe_buf_steal,
338 .get = generic_pipe_buf_get,
339};
340
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100341static int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
342 struct pipe_buffer *buf)
343{
344 return 1;
345}
346
347/* Pipe buffer operations for a socket and similar. */
348const struct pipe_buf_operations nosteal_pipe_buf_ops = {
349 .can_merge = 0,
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100350 .confirm = generic_pipe_buf_confirm,
351 .release = generic_pipe_buf_release,
352 .steal = generic_pipe_buf_nosteal,
353 .get = generic_pipe_buf_get,
354};
355EXPORT_SYMBOL(nosteal_pipe_buf_ops);
356
Al Viro523ac9a2016-09-23 15:34:57 -0400357static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
Miklos Szeredi68181732009-05-07 15:37:36 +0200358 unsigned long vlen, loff_t offset)
359{
360 mm_segment_t old_fs;
361 loff_t pos = offset;
362 ssize_t res;
363
364 old_fs = get_fs();
365 set_fs(get_ds());
366 /* The cast to a user pointer is valid due to the set_fs() */
Christoph Hellwig793b80e2016-03-03 16:03:58 +0100367 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
Miklos Szeredi68181732009-05-07 15:37:36 +0200368 set_fs(old_fs);
369
370 return res;
371}
372
Al Viro7bb307e2013-02-23 14:51:48 -0500373ssize_t kernel_write(struct file *file, const char *buf, size_t count,
Miklos Szeredib2858d72009-05-19 11:37:46 +0200374 loff_t pos)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200375{
376 mm_segment_t old_fs;
377 ssize_t res;
378
379 old_fs = get_fs();
380 set_fs(get_ds());
381 /* The cast to a user pointer is valid due to the set_fs() */
Al Viro7bb307e2013-02-23 14:51:48 -0500382 res = vfs_write(file, (__force const char __user *)buf, count, &pos);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200383 set_fs(old_fs);
384
385 return res;
386}
Al Viro7bb307e2013-02-23 14:51:48 -0500387EXPORT_SYMBOL(kernel_write);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200388
Al Viro82c156f2016-09-22 23:35:42 -0400389static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
Miklos Szeredi68181732009-05-07 15:37:36 +0200390 struct pipe_inode_info *pipe, size_t len,
391 unsigned int flags)
392{
Al Viro523ac9a2016-09-23 15:34:57 -0400393 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
394 struct iov_iter to;
395 struct page **pages;
Miklos Szeredi68181732009-05-07 15:37:36 +0200396 unsigned int nr_pages;
Al Viro523ac9a2016-09-23 15:34:57 -0400397 size_t offset, dummy, copied = 0;
Miklos Szeredi68181732009-05-07 15:37:36 +0200398 ssize_t res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200399 int i;
Miklos Szeredi68181732009-05-07 15:37:36 +0200400
Al Viro523ac9a2016-09-23 15:34:57 -0400401 if (pipe->nrbufs == pipe->buffers)
402 return -EAGAIN;
403
404 /*
405 * Try to keep page boundaries matching to source pagecache ones -
406 * it probably won't be much help, but...
407 */
408 offset = *ppos & ~PAGE_MASK;
409
410 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
411
412 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &dummy);
413 if (res <= 0)
Jens Axboe35f3d142010-05-20 10:43:18 +0200414 return -ENOMEM;
415
Al Viro523ac9a2016-09-23 15:34:57 -0400416 nr_pages = res / PAGE_SIZE;
417
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{
1093 while (pipe->nrbufs == pipe->buffers) {
1094 if (flags & SPLICE_F_NONBLOCK)
1095 return -EAGAIN;
1096 if (signal_pending(current))
1097 return -ERESTARTSYS;
1098 pipe->waiting_writers++;
1099 pipe_wait(pipe);
1100 pipe->waiting_writers--;
1101 }
1102 return 0;
1103}
1104
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001105static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1106 struct pipe_inode_info *opipe,
1107 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001108
1109/*
Jens Axboe83f91352006-04-02 23:05:09 +02001110 * Determine where to splice to/from.
1111 */
Ingo Molnar529565dc2006-04-10 15:18:58 +02001112static long do_splice(struct file *in, loff_t __user *off_in,
1113 struct file *out, loff_t __user *off_out,
1114 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001115{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001116 struct pipe_inode_info *ipipe;
1117 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001118 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001119 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001120
Linus Torvalds71993e62010-11-28 13:56:09 -08001121 ipipe = get_pipe_info(in);
1122 opipe = get_pipe_info(out);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001123
1124 if (ipipe && opipe) {
1125 if (off_in || off_out)
1126 return -ESPIPE;
1127
1128 if (!(in->f_mode & FMODE_READ))
1129 return -EBADF;
1130
1131 if (!(out->f_mode & FMODE_WRITE))
1132 return -EBADF;
1133
1134 /* Splicing to self would be fun, but... */
1135 if (ipipe == opipe)
1136 return -EINVAL;
1137
1138 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1139 }
1140
1141 if (ipipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001142 if (off_in)
1143 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001144 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001145 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001146 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001147 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001148 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001149 } else {
1150 offset = out->f_pos;
1151 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001152
Al Viro18c67cb2013-06-19 15:41:54 +04001153 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1154 return -EBADF;
1155
1156 if (unlikely(out->f_flags & O_APPEND))
1157 return -EINVAL;
1158
1159 ret = rw_verify_area(WRITE, out, &offset, len);
1160 if (unlikely(ret < 0))
1161 return ret;
1162
Al Viro500368f2013-05-23 20:07:11 -04001163 file_start_write(out);
Al Viro7995bd22013-06-20 18:58:36 +04001164 ret = do_splice_from(ipipe, out, &offset, len, flags);
Al Viro500368f2013-05-23 20:07:11 -04001165 file_end_write(out);
Jens Axboea4514eb2006-04-19 15:57:05 +02001166
Al Viro7995bd22013-06-20 18:58:36 +04001167 if (!off_out)
1168 out->f_pos = offset;
1169 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001170 ret = -EFAULT;
1171
1172 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001173 }
Jens Axboe5274f052006-03-30 15:15:30 +02001174
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001175 if (opipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001176 if (off_out)
1177 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001178 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001179 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001180 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001181 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001182 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001183 } else {
1184 offset = in->f_pos;
1185 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001186
Al Viro8924fef2016-09-17 20:44:45 -04001187 pipe_lock(opipe);
1188 ret = wait_for_space(opipe, flags);
1189 if (!ret)
1190 ret = do_splice_to(in, &offset, opipe, len, flags);
1191 pipe_unlock(opipe);
1192 if (ret > 0)
1193 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001194 if (!off_in)
1195 in->f_pos = offset;
1196 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001197 ret = -EFAULT;
1198
1199 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001200 }
Jens Axboe5274f052006-03-30 15:15:30 +02001201
1202 return -EINVAL;
1203}
1204
Al Viro79fddc42016-09-17 22:38:20 -04001205static int iter_to_pipe(struct iov_iter *from,
1206 struct pipe_inode_info *pipe,
1207 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001208{
Al Viro79fddc42016-09-17 22:38:20 -04001209 struct pipe_buffer buf = {
1210 .ops = &user_page_pipe_buf_ops,
1211 .flags = flags
1212 };
1213 size_t total = 0;
1214 int ret = 0;
1215 bool failed = false;
1216
1217 while (iov_iter_count(from) && !failed) {
1218 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001219 ssize_t copied;
1220 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001221 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001222
Al Viro79fddc42016-09-17 22:38:20 -04001223 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1224 if (copied <= 0) {
1225 ret = copied;
1226 break;
1227 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001228
Al Viro79fddc42016-09-17 22:38:20 -04001229 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001230 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001231 if (!failed) {
1232 buf.page = pages[n];
1233 buf.offset = start;
1234 buf.len = size;
1235 ret = add_to_pipe(pipe, &buf);
1236 if (unlikely(ret < 0)) {
1237 failed = true;
1238 } else {
1239 iov_iter_advance(from, ret);
1240 total += ret;
1241 }
1242 } else {
1243 put_page(pages[n]);
1244 }
Al Virodb85a9e2016-09-17 20:25:06 -04001245 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001246 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001247 }
Al Viro79fddc42016-09-17 22:38:20 -04001248 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001249}
1250
Jens Axboe6a14b902007-06-14 13:08:55 +02001251static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1252 struct splice_desc *sd)
1253{
Al Viro6130f532014-02-03 18:19:51 -05001254 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1255 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001256}
1257
1258/*
1259 * For lack of a better implementation, implement vmsplice() to userspace
1260 * as a simple copy of the pipes pages to the user iov.
1261 */
Al Viro6130f532014-02-03 18:19:51 -05001262static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001263 unsigned long nr_segs, unsigned int flags)
1264{
1265 struct pipe_inode_info *pipe;
1266 struct splice_desc sd;
Jens Axboe6a14b902007-06-14 13:08:55 +02001267 long ret;
Al Viro6130f532014-02-03 18:19:51 -05001268 struct iovec iovstack[UIO_FASTIOV];
1269 struct iovec *iov = iovstack;
1270 struct iov_iter iter;
Jens Axboe6a14b902007-06-14 13:08:55 +02001271
Linus Torvalds71993e62010-11-28 13:56:09 -08001272 pipe = get_pipe_info(file);
Jens Axboe6a14b902007-06-14 13:08:55 +02001273 if (!pipe)
1274 return -EBADF;
1275
Al Viro345995f2015-03-21 19:17:55 -04001276 ret = import_iovec(READ, uiov, nr_segs,
1277 ARRAY_SIZE(iovstack), &iov, &iter);
1278 if (ret < 0)
1279 return ret;
Al Viro6130f532014-02-03 18:19:51 -05001280
Al Viro345995f2015-03-21 19:17:55 -04001281 sd.total_len = iov_iter_count(&iter);
Al Viro6130f532014-02-03 18:19:51 -05001282 sd.len = 0;
Al Viro6130f532014-02-03 18:19:51 -05001283 sd.flags = flags;
1284 sd.u.data = &iter;
1285 sd.pos = 0;
1286
Al Viro345995f2015-03-21 19:17:55 -04001287 if (sd.total_len) {
1288 pipe_lock(pipe);
1289 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1290 pipe_unlock(pipe);
1291 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001292
Al Viro345995f2015-03-21 19:17:55 -04001293 kfree(iov);
Jens Axboe6a14b902007-06-14 13:08:55 +02001294 return ret;
1295}
1296
Jens Axboe912d35f2006-04-26 10:59:21 +02001297/*
1298 * vmsplice splices a user address range into a pipe. It can be thought of
1299 * as splice-from-memory, where the regular splice is splice-from-file (or
1300 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001301 */
Al Virodb85a9e2016-09-17 20:25:06 -04001302static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001303 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001304{
Jens Axboeddac0d32006-11-04 12:49:32 +01001305 struct pipe_inode_info *pipe;
Al Virodb85a9e2016-09-17 20:25:06 -04001306 struct iovec iovstack[UIO_FASTIOV];
1307 struct iovec *iov = iovstack;
1308 struct iov_iter from;
Jens Axboe35f3d142010-05-20 10:43:18 +02001309 long ret;
Al Viro79fddc42016-09-17 22:38:20 -04001310 unsigned buf_flag = 0;
1311
1312 if (flags & SPLICE_F_GIFT)
1313 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001314
Linus Torvalds71993e62010-11-28 13:56:09 -08001315 pipe = get_pipe_info(file);
Jens Axboeddac0d32006-11-04 12:49:32 +01001316 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001317 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001318
Al Virodb85a9e2016-09-17 20:25:06 -04001319 ret = import_iovec(WRITE, uiov, nr_segs,
1320 ARRAY_SIZE(iovstack), &iov, &from);
1321 if (ret < 0)
1322 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001323
Al Viro8924fef2016-09-17 20:44:45 -04001324 pipe_lock(pipe);
1325 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001326 if (!ret)
1327 ret = iter_to_pipe(&from, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001328 pipe_unlock(pipe);
1329 if (ret > 0)
1330 wakeup_pipe_readers(pipe);
Al Virodb85a9e2016-09-17 20:25:06 -04001331 kfree(iov);
Jens Axboe35f3d142010-05-20 10:43:18 +02001332 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001333}
1334
Jens Axboe6a14b902007-06-14 13:08:55 +02001335/*
1336 * Note that vmsplice only really supports true splicing _from_ user memory
1337 * to a pipe, not the other way around. Splicing from user memory is a simple
1338 * operation that can be supported without any funky alignment restrictions
1339 * or nasty vm tricks. We simply map in the user memory and fill them into
1340 * a pipe. The reverse isn't quite as easy, though. There are two possible
1341 * solutions for that:
1342 *
1343 * - memcpy() the data internally, at which point we might as well just
1344 * do a regular read() on the buffer anyway.
1345 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1346 * has restriction limitations on both ends of the pipe).
1347 *
1348 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1349 *
1350 */
Heiko Carstens836f92a2009-01-14 14:14:33 +01001351SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1352 unsigned long, nr_segs, unsigned int, flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001353{
Al Viro2903ff02012-08-28 12:52:22 -04001354 struct fd f;
Jens Axboe912d35f2006-04-26 10:59:21 +02001355 long error;
Jens Axboe912d35f2006-04-26 10:59:21 +02001356
Jens Axboe6a14b902007-06-14 13:08:55 +02001357 if (unlikely(nr_segs > UIO_MAXIOV))
1358 return -EINVAL;
1359 else if (unlikely(!nr_segs))
1360 return 0;
1361
Jens Axboe912d35f2006-04-26 10:59:21 +02001362 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001363 f = fdget(fd);
1364 if (f.file) {
1365 if (f.file->f_mode & FMODE_WRITE)
1366 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1367 else if (f.file->f_mode & FMODE_READ)
1368 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001369
Al Viro2903ff02012-08-28 12:52:22 -04001370 fdput(f);
Jens Axboe912d35f2006-04-26 10:59:21 +02001371 }
1372
1373 return error;
1374}
1375
Al Viro76b021d2013-03-02 10:19:56 -05001376#ifdef CONFIG_COMPAT
1377COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1378 unsigned int, nr_segs, unsigned int, flags)
1379{
1380 unsigned i;
1381 struct iovec __user *iov;
1382 if (nr_segs > UIO_MAXIOV)
1383 return -EINVAL;
1384 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1385 for (i = 0; i < nr_segs; i++) {
1386 struct compat_iovec v;
1387 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1388 get_user(v.iov_len, &iov32[i].iov_len) ||
1389 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1390 put_user(v.iov_len, &iov[i].iov_len))
1391 return -EFAULT;
1392 }
1393 return sys_vmsplice(fd, iov, nr_segs, flags);
1394}
1395#endif
1396
Heiko Carstens836f92a2009-01-14 14:14:33 +01001397SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1398 int, fd_out, loff_t __user *, off_out,
1399 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001400{
Al Viro2903ff02012-08-28 12:52:22 -04001401 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001402 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001403
1404 if (unlikely(!len))
1405 return 0;
1406
1407 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001408 in = fdget(fd_in);
1409 if (in.file) {
1410 if (in.file->f_mode & FMODE_READ) {
1411 out = fdget(fd_out);
1412 if (out.file) {
1413 if (out.file->f_mode & FMODE_WRITE)
1414 error = do_splice(in.file, off_in,
1415 out.file, off_out,
Ingo Molnar529565dc2006-04-10 15:18:58 +02001416 len, flags);
Al Viro2903ff02012-08-28 12:52:22 -04001417 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001418 }
1419 }
Al Viro2903ff02012-08-28 12:52:22 -04001420 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001421 }
Jens Axboe5274f052006-03-30 15:15:30 +02001422 return error;
1423}
Jens Axboe70524492006-04-11 15:51:17 +02001424
1425/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001426 * Make sure there's data to read. Wait for input if we can, otherwise
1427 * return an appropriate error.
1428 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001429static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001430{
1431 int ret;
1432
1433 /*
1434 * Check ->nrbufs without the inode lock first. This function
1435 * is speculative anyways, so missing one is ok.
1436 */
1437 if (pipe->nrbufs)
1438 return 0;
1439
1440 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001441 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001442
1443 while (!pipe->nrbufs) {
1444 if (signal_pending(current)) {
1445 ret = -ERESTARTSYS;
1446 break;
1447 }
1448 if (!pipe->writers)
1449 break;
1450 if (!pipe->waiting_writers) {
1451 if (flags & SPLICE_F_NONBLOCK) {
1452 ret = -EAGAIN;
1453 break;
1454 }
1455 }
1456 pipe_wait(pipe);
1457 }
1458
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001459 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001460 return ret;
1461}
1462
1463/*
1464 * Make sure there's writeable room. Wait for room if we can, otherwise
1465 * return an appropriate error.
1466 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001467static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001468{
1469 int ret;
1470
1471 /*
1472 * Check ->nrbufs without the inode lock first. This function
1473 * is speculative anyways, so missing one is ok.
1474 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001475 if (pipe->nrbufs < pipe->buffers)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001476 return 0;
1477
1478 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001479 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001480
Jens Axboe35f3d142010-05-20 10:43:18 +02001481 while (pipe->nrbufs >= pipe->buffers) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001482 if (!pipe->readers) {
1483 send_sig(SIGPIPE, current, 0);
1484 ret = -EPIPE;
1485 break;
1486 }
1487 if (flags & SPLICE_F_NONBLOCK) {
1488 ret = -EAGAIN;
1489 break;
1490 }
1491 if (signal_pending(current)) {
1492 ret = -ERESTARTSYS;
1493 break;
1494 }
1495 pipe->waiting_writers++;
1496 pipe_wait(pipe);
1497 pipe->waiting_writers--;
1498 }
1499
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001500 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001501 return ret;
1502}
1503
1504/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001505 * Splice contents of ipipe to opipe.
1506 */
1507static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1508 struct pipe_inode_info *opipe,
1509 size_t len, unsigned int flags)
1510{
1511 struct pipe_buffer *ibuf, *obuf;
1512 int ret = 0, nbuf;
1513 bool input_wakeup = false;
1514
1515
1516retry:
1517 ret = ipipe_prep(ipipe, flags);
1518 if (ret)
1519 return ret;
1520
1521 ret = opipe_prep(opipe, flags);
1522 if (ret)
1523 return ret;
1524
1525 /*
1526 * Potential ABBA deadlock, work around it by ordering lock
1527 * grabbing by pipe info address. Otherwise two different processes
1528 * could deadlock (one doing tee from A -> B, the other from B -> A).
1529 */
1530 pipe_double_lock(ipipe, opipe);
1531
1532 do {
1533 if (!opipe->readers) {
1534 send_sig(SIGPIPE, current, 0);
1535 if (!ret)
1536 ret = -EPIPE;
1537 break;
1538 }
1539
1540 if (!ipipe->nrbufs && !ipipe->writers)
1541 break;
1542
1543 /*
1544 * Cannot make any progress, because either the input
1545 * pipe is empty or the output pipe is full.
1546 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001547 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001548 /* Already processed some buffers, break */
1549 if (ret)
1550 break;
1551
1552 if (flags & SPLICE_F_NONBLOCK) {
1553 ret = -EAGAIN;
1554 break;
1555 }
1556
1557 /*
1558 * We raced with another reader/writer and haven't
1559 * managed to process any buffers. A zero return
1560 * value means EOF, so retry instead.
1561 */
1562 pipe_unlock(ipipe);
1563 pipe_unlock(opipe);
1564 goto retry;
1565 }
1566
1567 ibuf = ipipe->bufs + ipipe->curbuf;
Jens Axboe35f3d142010-05-20 10:43:18 +02001568 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001569 obuf = opipe->bufs + nbuf;
1570
1571 if (len >= ibuf->len) {
1572 /*
1573 * Simply move the whole buffer from ipipe to opipe
1574 */
1575 *obuf = *ibuf;
1576 ibuf->ops = NULL;
1577 opipe->nrbufs++;
Jens Axboe35f3d142010-05-20 10:43:18 +02001578 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001579 ipipe->nrbufs--;
1580 input_wakeup = true;
1581 } else {
1582 /*
1583 * Get a reference to this pipe buffer,
1584 * so we can copy the contents over.
1585 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001586 pipe_buf_get(ipipe, ibuf);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001587 *obuf = *ibuf;
1588
1589 /*
1590 * Don't inherit the gift flag, we need to
1591 * prevent multiple steals of this page.
1592 */
1593 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1594
1595 obuf->len = len;
1596 opipe->nrbufs++;
1597 ibuf->offset += obuf->len;
1598 ibuf->len -= obuf->len;
1599 }
1600 ret += obuf->len;
1601 len -= obuf->len;
1602 } while (len);
1603
1604 pipe_unlock(ipipe);
1605 pipe_unlock(opipe);
1606
1607 /*
1608 * If we put data in the output pipe, wakeup any potential readers.
1609 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001610 if (ret > 0)
1611 wakeup_pipe_readers(opipe);
1612
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001613 if (input_wakeup)
1614 wakeup_pipe_writers(ipipe);
1615
1616 return ret;
1617}
1618
1619/*
Jens Axboe70524492006-04-11 15:51:17 +02001620 * Link contents of ipipe to opipe.
1621 */
1622static int link_pipe(struct pipe_inode_info *ipipe,
1623 struct pipe_inode_info *opipe,
1624 size_t len, unsigned int flags)
1625{
1626 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001627 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001628
1629 /*
1630 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001631 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001632 * could deadlock (one doing tee from A -> B, the other from B -> A).
1633 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001634 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001635
Jens Axboeaadd06e2006-07-10 11:00:01 +02001636 do {
Jens Axboe70524492006-04-11 15:51:17 +02001637 if (!opipe->readers) {
1638 send_sig(SIGPIPE, current, 0);
1639 if (!ret)
1640 ret = -EPIPE;
1641 break;
1642 }
Jens Axboe70524492006-04-11 15:51:17 +02001643
1644 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001645 * If we have iterated all input buffers or ran out of
1646 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001647 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001648 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
Jens Axboe70524492006-04-11 15:51:17 +02001649 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001650
Jens Axboe35f3d142010-05-20 10:43:18 +02001651 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1652 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001653
Jens Axboe2a27250e2006-04-19 15:56:40 +02001654 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001655 * Get a reference to this pipe buffer,
1656 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001657 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001658 pipe_buf_get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001659
Jens Axboeaadd06e2006-07-10 11:00:01 +02001660 obuf = opipe->bufs + nbuf;
1661 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001662
Jens Axboeaadd06e2006-07-10 11:00:01 +02001663 /*
1664 * Don't inherit the gift flag, we need to
1665 * prevent multiple steals of this page.
1666 */
1667 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1668
1669 if (obuf->len > len)
1670 obuf->len = len;
1671
1672 opipe->nrbufs++;
1673 ret += obuf->len;
1674 len -= obuf->len;
1675 i++;
1676 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001677
Jens Axboe02cf01a2008-02-20 10:34:51 +01001678 /*
1679 * return EAGAIN if we have the potential of some data in the
1680 * future, otherwise just return 0
1681 */
1682 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1683 ret = -EAGAIN;
1684
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001685 pipe_unlock(ipipe);
1686 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001687
Jens Axboeaadd06e2006-07-10 11:00:01 +02001688 /*
1689 * If we put data in the output pipe, wakeup any potential readers.
1690 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001691 if (ret > 0)
1692 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001693
1694 return ret;
1695}
1696
1697/*
1698 * This is a tee(1) implementation that works on pipes. It doesn't copy
1699 * any data, it simply references the 'in' pages on the 'out' pipe.
1700 * The 'flags' used are the SPLICE_F_* variants, currently the only
1701 * applicable one is SPLICE_F_NONBLOCK.
1702 */
1703static long do_tee(struct file *in, struct file *out, size_t len,
1704 unsigned int flags)
1705{
Linus Torvalds71993e62010-11-28 13:56:09 -08001706 struct pipe_inode_info *ipipe = get_pipe_info(in);
1707 struct pipe_inode_info *opipe = get_pipe_info(out);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001708 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001709
1710 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001711 * Duplicate the contents of ipipe to opipe without actually
1712 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001713 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001714 if (ipipe && opipe && ipipe != opipe) {
1715 /*
1716 * Keep going, unless we encounter an error. The ipipe/opipe
1717 * ordering doesn't really matter.
1718 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001719 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001720 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001721 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001722 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001723 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001724 }
1725 }
Jens Axboe70524492006-04-11 15:51:17 +02001726
Jens Axboeaadd06e2006-07-10 11:00:01 +02001727 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001728}
1729
Heiko Carstens836f92a2009-01-14 14:14:33 +01001730SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001731{
Al Viro2903ff02012-08-28 12:52:22 -04001732 struct fd in;
1733 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001734
1735 if (unlikely(!len))
1736 return 0;
1737
1738 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001739 in = fdget(fdin);
1740 if (in.file) {
1741 if (in.file->f_mode & FMODE_READ) {
1742 struct fd out = fdget(fdout);
1743 if (out.file) {
1744 if (out.file->f_mode & FMODE_WRITE)
1745 error = do_tee(in.file, out.file,
1746 len, flags);
1747 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001748 }
1749 }
Al Viro2903ff02012-08-28 12:52:22 -04001750 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001751 }
1752
1753 return error;
1754}