blob: aa38901a4f101a963861e8cc0e211918ffa9c5bc [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) {
318 if (WARN_ON(to.idx != idx || to.iov_offset)) {
319 /*
320 * a bogus ->read_iter() has copied something and still
321 * returned an error instead of a short read.
322 */
323 to.idx = idx;
324 to.iov_offset = 0;
325 iov_iter_advance(&to, 0); /* to free what was emitted */
326 }
327 /*
328 * callers of ->splice_read() expect -EAGAIN on
329 * "can't put anything in there", rather than -EFAULT.
330 */
331 if (ret == -EFAULT)
332 ret = -EAGAIN;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200333 }
Jens Axboe5274f052006-03-30 15:15:30 +0200334
335 return ret;
336}
Jens Axboe059a8f32006-04-02 23:06:05 +0200337EXPORT_SYMBOL(generic_file_splice_read);
338
Al Viro241699c2016-09-22 16:33:12 -0400339const struct pipe_buf_operations default_pipe_buf_ops = {
Miklos Szeredi68181732009-05-07 15:37:36 +0200340 .can_merge = 0,
Miklos Szeredi68181732009-05-07 15:37:36 +0200341 .confirm = generic_pipe_buf_confirm,
342 .release = generic_pipe_buf_release,
343 .steal = generic_pipe_buf_steal,
344 .get = generic_pipe_buf_get,
345};
346
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100347static int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
348 struct pipe_buffer *buf)
349{
350 return 1;
351}
352
353/* Pipe buffer operations for a socket and similar. */
354const struct pipe_buf_operations nosteal_pipe_buf_ops = {
355 .can_merge = 0,
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100356 .confirm = generic_pipe_buf_confirm,
357 .release = generic_pipe_buf_release,
358 .steal = generic_pipe_buf_nosteal,
359 .get = generic_pipe_buf_get,
360};
361EXPORT_SYMBOL(nosteal_pipe_buf_ops);
362
Al Viro523ac9a2016-09-23 15:34:57 -0400363static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
Miklos Szeredi68181732009-05-07 15:37:36 +0200364 unsigned long vlen, loff_t offset)
365{
366 mm_segment_t old_fs;
367 loff_t pos = offset;
368 ssize_t res;
369
370 old_fs = get_fs();
371 set_fs(get_ds());
372 /* The cast to a user pointer is valid due to the set_fs() */
Christoph Hellwig793b80e2016-03-03 16:03:58 +0100373 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
Miklos Szeredi68181732009-05-07 15:37:36 +0200374 set_fs(old_fs);
375
376 return res;
377}
378
Al Viro7bb307e2013-02-23 14:51:48 -0500379ssize_t kernel_write(struct file *file, const char *buf, size_t count,
Miklos Szeredib2858d72009-05-19 11:37:46 +0200380 loff_t pos)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200381{
382 mm_segment_t old_fs;
383 ssize_t res;
384
385 old_fs = get_fs();
386 set_fs(get_ds());
387 /* The cast to a user pointer is valid due to the set_fs() */
Al Viro7bb307e2013-02-23 14:51:48 -0500388 res = vfs_write(file, (__force const char __user *)buf, count, &pos);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200389 set_fs(old_fs);
390
391 return res;
392}
Al Viro7bb307e2013-02-23 14:51:48 -0500393EXPORT_SYMBOL(kernel_write);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200394
Al Viro82c156f2016-09-22 23:35:42 -0400395static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
Miklos Szeredi68181732009-05-07 15:37:36 +0200396 struct pipe_inode_info *pipe, size_t len,
397 unsigned int flags)
398{
Al Viro523ac9a2016-09-23 15:34:57 -0400399 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
400 struct iov_iter to;
401 struct page **pages;
Miklos Szeredi68181732009-05-07 15:37:36 +0200402 unsigned int nr_pages;
Al Viro523ac9a2016-09-23 15:34:57 -0400403 size_t offset, dummy, copied = 0;
Miklos Szeredi68181732009-05-07 15:37:36 +0200404 ssize_t res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200405 int i;
Miklos Szeredi68181732009-05-07 15:37:36 +0200406
Al Viro523ac9a2016-09-23 15:34:57 -0400407 if (pipe->nrbufs == pipe->buffers)
408 return -EAGAIN;
409
410 /*
411 * Try to keep page boundaries matching to source pagecache ones -
412 * it probably won't be much help, but...
413 */
414 offset = *ppos & ~PAGE_MASK;
415
416 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
417
418 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &dummy);
419 if (res <= 0)
Jens Axboe35f3d142010-05-20 10:43:18 +0200420 return -ENOMEM;
421
Al Viro523ac9a2016-09-23 15:34:57 -0400422 nr_pages = res / PAGE_SIZE;
423
Jens Axboe35f3d142010-05-20 10:43:18 +0200424 vec = __vec;
Al Viro523ac9a2016-09-23 15:34:57 -0400425 if (nr_pages > PIPE_DEF_BUFFERS) {
426 vec = kmalloc(nr_pages * sizeof(struct kvec), GFP_KERNEL);
427 if (unlikely(!vec)) {
428 res = -ENOMEM;
429 goto out;
430 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200431 }
432
Al Viro523ac9a2016-09-23 15:34:57 -0400433 pipe->bufs[to.idx].offset = offset;
434 pipe->bufs[to.idx].len -= offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200435
Al Viro523ac9a2016-09-23 15:34:57 -0400436 for (i = 0; i < nr_pages; i++) {
437 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
438 vec[i].iov_base = page_address(pages[i]) + offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200439 vec[i].iov_len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200440 len -= this_len;
441 offset = 0;
442 }
443
Al Viro523ac9a2016-09-23 15:34:57 -0400444 res = kernel_readv(in, vec, nr_pages, *ppos);
445 if (res > 0) {
446 copied = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200447 *ppos += res;
Al Viro523ac9a2016-09-23 15:34:57 -0400448 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200449
Jens Axboe35f3d142010-05-20 10:43:18 +0200450 if (vec != __vec)
451 kfree(vec);
Al Viro523ac9a2016-09-23 15:34:57 -0400452out:
453 for (i = 0; i < nr_pages; i++)
454 put_page(pages[i]);
455 kvfree(pages);
456 iov_iter_advance(&to, copied); /* truncates and discards */
Miklos Szeredi68181732009-05-07 15:37:36 +0200457 return res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200458}
Miklos Szeredi68181732009-05-07 15:37:36 +0200459
Jens Axboe5274f052006-03-30 15:15:30 +0200460/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200461 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200462 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200463 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200464static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200465 struct pipe_buffer *buf, struct splice_desc *sd)
466{
Jens Axboe6a14b902007-06-14 13:08:55 +0200467 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200468 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100469 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200470
Al Viro72c2d532013-09-22 16:27:52 -0400471 if (!likely(file->f_op->sendpage))
Michał Mirosława8adbe32010-12-17 08:56:44 +0100472 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200473
Eric Dumazet35f9c092012-04-05 03:05:35 +0000474 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000475
476 if (sd->len < sd->total_len && pipe->nrbufs > 1)
Eric Dumazet35f9c092012-04-05 03:05:35 +0000477 more |= MSG_SENDPAGE_NOTLAST;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000478
Michał Mirosława8adbe32010-12-17 08:56:44 +0100479 return file->f_op->sendpage(file, buf->page, buf->offset,
480 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200481}
482
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200483static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
484{
485 smp_mb();
486 if (waitqueue_active(&pipe->wait))
487 wake_up_interruptible(&pipe->wait);
488 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
489}
490
491/**
492 * splice_from_pipe_feed - feed available data from a pipe to a file
493 * @pipe: pipe to splice from
494 * @sd: information to @actor
495 * @actor: handler that splices the data
496 *
497 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200498 * This function loops over the pipe and calls @actor to do the
499 * actual moving of a single struct pipe_buffer to the desired
500 * destination. It returns when there's no more buffers left in
501 * the pipe or if the requested number of bytes (@sd->total_len)
502 * have been copied. It returns a positive number (one) if the
503 * pipe needs to be filled with more data, zero if the required
504 * number of bytes have been copied and -errno on error.
505 *
506 * This, together with splice_from_pipe_{begin,end,next}, may be
507 * used to implement the functionality of __splice_from_pipe() when
508 * locking is required around copying the pipe buffers to the
509 * destination.
510 */
Al Viro96f9bc82014-04-05 04:35:49 -0400511static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200512 splice_actor *actor)
513{
514 int ret;
515
516 while (pipe->nrbufs) {
517 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200518
519 sd->len = buf->len;
520 if (sd->len > sd->total_len)
521 sd->len = sd->total_len;
522
Miklos Szeredifba597d2016-09-27 10:45:12 +0200523 ret = pipe_buf_confirm(pipe, buf);
Michał Mirosława8adbe32010-12-17 08:56:44 +0100524 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200525 if (ret == -ENODATA)
526 ret = 0;
527 return ret;
528 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100529
530 ret = actor(pipe, buf, sd);
531 if (ret <= 0)
532 return ret;
533
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200534 buf->offset += ret;
535 buf->len -= ret;
536
537 sd->num_spliced += ret;
538 sd->len -= ret;
539 sd->pos += ret;
540 sd->total_len -= ret;
541
542 if (!buf->len) {
Miklos Szeredia7796382016-09-27 10:45:12 +0200543 pipe_buf_release(pipe, buf);
Jens Axboe35f3d142010-05-20 10:43:18 +0200544 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200545 pipe->nrbufs--;
Al Viro6447a3c2013-03-21 11:01:38 -0400546 if (pipe->files)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200547 sd->need_wakeup = true;
548 }
549
550 if (!sd->total_len)
551 return 0;
552 }
553
554 return 1;
555}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200556
557/**
558 * splice_from_pipe_next - wait for some data to splice from
559 * @pipe: pipe to splice from
560 * @sd: information about the splice operation
561 *
562 * Description:
563 * This function will wait for some data and return a positive
564 * value (one) if pipe buffers are available. It will return zero
565 * or -errno if no more data needs to be spliced.
566 */
Al Viro96f9bc82014-04-05 04:35:49 -0400567static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200568{
Jan Karac725bfc2015-11-23 13:09:50 +0100569 /*
570 * Check for signal early to make process killable when there are
571 * always buffers available
572 */
573 if (signal_pending(current))
574 return -ERESTARTSYS;
575
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200576 while (!pipe->nrbufs) {
577 if (!pipe->writers)
578 return 0;
579
580 if (!pipe->waiting_writers && sd->num_spliced)
581 return 0;
582
583 if (sd->flags & SPLICE_F_NONBLOCK)
584 return -EAGAIN;
585
586 if (signal_pending(current))
587 return -ERESTARTSYS;
588
589 if (sd->need_wakeup) {
590 wakeup_pipe_writers(pipe);
591 sd->need_wakeup = false;
592 }
593
594 pipe_wait(pipe);
595 }
596
597 return 1;
598}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200599
600/**
601 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700602 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200603 *
604 * Description:
605 * This function should be called before a loop containing
606 * splice_from_pipe_next() and splice_from_pipe_feed() to
607 * initialize the necessary fields of @sd.
608 */
Al Viro96f9bc82014-04-05 04:35:49 -0400609static void splice_from_pipe_begin(struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200610{
611 sd->num_spliced = 0;
612 sd->need_wakeup = false;
613}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200614
615/**
616 * splice_from_pipe_end - finish splicing from pipe
617 * @pipe: pipe to splice from
618 * @sd: information about the splice operation
619 *
620 * Description:
621 * This function will wake up pipe writers if necessary. It should
622 * be called after a loop containing splice_from_pipe_next() and
623 * splice_from_pipe_feed().
624 */
Al Viro96f9bc82014-04-05 04:35:49 -0400625static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200626{
627 if (sd->need_wakeup)
628 wakeup_pipe_writers(pipe);
629}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200630
Jens Axboe932cc6d2007-06-21 13:10:21 +0200631/**
632 * __splice_from_pipe - splice data from a pipe to given actor
633 * @pipe: pipe to splice from
634 * @sd: information to @actor
635 * @actor: handler that splices the data
636 *
637 * Description:
638 * This function does little more than loop over the pipe and call
639 * @actor to do the actual moving of a single struct pipe_buffer to
640 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
641 * pipe_to_user.
642 *
Jens Axboe83f91352006-04-02 23:05:09 +0200643 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200644ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
645 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200646{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200647 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200648
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200649 splice_from_pipe_begin(sd);
650 do {
Jan Karac2489e02015-11-23 13:09:51 +0100651 cond_resched();
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200652 ret = splice_from_pipe_next(pipe, sd);
653 if (ret > 0)
654 ret = splice_from_pipe_feed(pipe, sd, actor);
655 } while (ret > 0);
656 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200657
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200658 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200659}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100660EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200661
Jens Axboe932cc6d2007-06-21 13:10:21 +0200662/**
663 * splice_from_pipe - splice data from a pipe to a file
664 * @pipe: pipe to splice from
665 * @out: file to splice to
666 * @ppos: position in @out
667 * @len: how many bytes to splice
668 * @flags: splice modifier flags
669 * @actor: handler that splices the data
670 *
671 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200672 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200673 * otherwise it's identical to __splice_from_pipe().
674 *
675 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200676ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
677 loff_t *ppos, size_t len, unsigned int flags,
678 splice_actor *actor)
679{
680 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200681 struct splice_desc sd = {
682 .total_len = len,
683 .flags = flags,
684 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200685 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200686 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200687
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200688 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200689 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200690 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200691
692 return ret;
693}
694
695/**
Al Viro8d020762014-04-05 04:27:08 -0400696 * iter_file_splice_write - splice data from a pipe to a file
697 * @pipe: pipe info
698 * @out: file to write to
699 * @ppos: position in @out
700 * @len: number of bytes to splice
701 * @flags: splice modifier flags
702 *
703 * Description:
704 * Will either move or copy pages (determined by @flags options) from
705 * the given pipe inode to the given file.
706 * This one is ->write_iter-based.
707 *
708 */
709ssize_t
710iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
711 loff_t *ppos, size_t len, unsigned int flags)
712{
713 struct splice_desc sd = {
714 .total_len = len,
715 .flags = flags,
716 .pos = *ppos,
717 .u.file = out,
718 };
719 int nbufs = pipe->buffers;
720 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
721 GFP_KERNEL);
722 ssize_t ret;
723
724 if (unlikely(!array))
725 return -ENOMEM;
726
727 pipe_lock(pipe);
728
729 splice_from_pipe_begin(&sd);
730 while (sd.total_len) {
731 struct iov_iter from;
Al Viro8d020762014-04-05 04:27:08 -0400732 size_t left;
733 int n, idx;
734
735 ret = splice_from_pipe_next(pipe, &sd);
736 if (ret <= 0)
737 break;
738
739 if (unlikely(nbufs < pipe->buffers)) {
740 kfree(array);
741 nbufs = pipe->buffers;
742 array = kcalloc(nbufs, sizeof(struct bio_vec),
743 GFP_KERNEL);
744 if (!array) {
745 ret = -ENOMEM;
746 break;
747 }
748 }
749
750 /* build the vector */
751 left = sd.total_len;
752 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
753 struct pipe_buffer *buf = pipe->bufs + idx;
754 size_t this_len = buf->len;
755
756 if (this_len > left)
757 this_len = left;
758
759 if (idx == pipe->buffers - 1)
760 idx = -1;
761
Miklos Szeredifba597d2016-09-27 10:45:12 +0200762 ret = pipe_buf_confirm(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400763 if (unlikely(ret)) {
764 if (ret == -ENODATA)
765 ret = 0;
766 goto done;
767 }
768
769 array[n].bv_page = buf->page;
770 array[n].bv_len = this_len;
771 array[n].bv_offset = buf->offset;
772 left -= this_len;
773 }
774
Al Viro05afcb72015-01-23 01:08:07 -0500775 iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
776 sd.total_len - left);
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100777 ret = vfs_iter_write(out, &from, &sd.pos);
Al Viro8d020762014-04-05 04:27:08 -0400778 if (ret <= 0)
779 break;
780
781 sd.num_spliced += ret;
782 sd.total_len -= ret;
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100783 *ppos = sd.pos;
Al Viro8d020762014-04-05 04:27:08 -0400784
785 /* dismiss the fully eaten buffers, adjust the partial one */
786 while (ret) {
787 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
788 if (ret >= buf->len) {
Al Viro8d020762014-04-05 04:27:08 -0400789 ret -= buf->len;
790 buf->len = 0;
Miklos Szeredia7796382016-09-27 10:45:12 +0200791 pipe_buf_release(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400792 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
793 pipe->nrbufs--;
794 if (pipe->files)
795 sd.need_wakeup = true;
796 } else {
797 buf->offset += ret;
798 buf->len -= ret;
799 ret = 0;
800 }
801 }
802 }
803done:
804 kfree(array);
805 splice_from_pipe_end(pipe, &sd);
806
807 pipe_unlock(pipe);
808
809 if (sd.num_spliced)
810 ret = sd.num_spliced;
811
812 return ret;
813}
814
815EXPORT_SYMBOL(iter_file_splice_write);
816
Miklos Szeredib2858d72009-05-19 11:37:46 +0200817static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
818 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200819{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200820 int ret;
821 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -0400822 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +0200823
Al Virofbb32752014-02-02 21:09:54 -0500824 data = kmap(buf->page);
Al Viro06ae43f2013-03-20 13:19:30 -0400825 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Al Virofbb32752014-02-02 21:09:54 -0500826 kunmap(buf->page);
Miklos Szeredib2858d72009-05-19 11:37:46 +0200827
828 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200829}
830
831static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
832 struct file *out, loff_t *ppos,
833 size_t len, unsigned int flags)
834{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200835 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200836
Miklos Szeredib2858d72009-05-19 11:37:46 +0200837 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
838 if (ret > 0)
839 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200840
Miklos Szeredib2858d72009-05-19 11:37:46 +0200841 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200842}
843
Jens Axboe83f91352006-04-02 23:05:09 +0200844/**
845 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200846 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200847 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200848 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200849 * @len: number of bytes to splice
850 * @flags: splice modifier flags
851 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200852 * Description:
853 * Will send @len bytes from the pipe to a network socket. No data copying
854 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200855 *
856 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200857ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200858 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200859{
Jens Axboe00522fb2006-04-26 14:39:29 +0200860 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200861}
862
Jens Axboe059a8f32006-04-02 23:06:05 +0200863EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500864
Jens Axboe83f91352006-04-02 23:05:09 +0200865/*
866 * Attempt to initiate a splice from pipe to file.
867 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200868static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200869 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200870{
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200871 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
872 loff_t *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200873
Al Viro72c2d532013-09-22 16:27:52 -0400874 if (out->f_op->splice_write)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100875 splice_write = out->f_op->splice_write;
876 else
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200877 splice_write = default_file_splice_write;
878
Al Viro500368f2013-05-23 20:07:11 -0400879 return splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200880}
881
Jens Axboe83f91352006-04-02 23:05:09 +0200882/*
883 * Attempt to initiate a splice from a file to a pipe.
884 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200885static long do_splice_to(struct file *in, loff_t *ppos,
886 struct pipe_inode_info *pipe, size_t len,
887 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200888{
Miklos Szeredi68181732009-05-07 15:37:36 +0200889 ssize_t (*splice_read)(struct file *, loff_t *,
890 struct pipe_inode_info *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200891 int ret;
892
Jens Axboe49570e92006-04-11 13:56:09 +0200893 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200894 return -EBADF;
895
Jens Axboecbb7e572006-04-11 14:57:50 +0200896 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200897 if (unlikely(ret < 0))
898 return ret;
899
Al Viro03cc0782016-04-02 14:56:58 -0400900 if (unlikely(len > MAX_RW_COUNT))
901 len = MAX_RW_COUNT;
902
Al Viro72c2d532013-09-22 16:27:52 -0400903 if (in->f_op->splice_read)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100904 splice_read = in->f_op->splice_read;
905 else
Miklos Szeredi68181732009-05-07 15:37:36 +0200906 splice_read = default_file_splice_read;
907
908 return splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200909}
910
Jens Axboe932cc6d2007-06-21 13:10:21 +0200911/**
912 * splice_direct_to_actor - splices data directly between two non-pipes
913 * @in: file to splice from
914 * @sd: actor information on where to splice to
915 * @actor: handles the data splicing
916 *
917 * Description:
918 * This is a special case helper to splice directly between two
919 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200920 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200921 * that process.
922 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200923 */
924ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
925 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200926{
927 struct pipe_inode_info *pipe;
928 long ret, bytes;
929 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200930 size_t len;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200931 int i, flags, more;
Jens Axboeb92ce552006-04-11 13:52:07 +0200932
933 /*
934 * We require the input being a regular file, as we don't want to
935 * randomly drop data for eg socket -> socket splicing. Use the
936 * piped splicing for that!
937 */
Al Viro496ad9a2013-01-23 17:07:38 -0500938 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200939 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
940 return -EINVAL;
941
942 /*
943 * neither in nor out is a pipe, setup an internal pipe attached to
944 * 'out' and transfer the wanted data from 'in' to 'out' through that
945 */
946 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200947 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -0400948 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +0200949 if (!pipe)
950 return -ENOMEM;
951
952 /*
953 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200954 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200955 * PIPE_READERS appropriately.
956 */
957 pipe->readers = 1;
958
959 current->splice_pipe = pipe;
960 }
961
962 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200963 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200964 */
965 ret = 0;
966 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200967 len = sd->total_len;
968 flags = sd->flags;
969
970 /*
971 * Don't block on output, we have to drain the direct pipe.
972 */
973 sd->flags &= ~SPLICE_F_NONBLOCK;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200974 more = sd->flags & SPLICE_F_MORE;
Jens Axboeb92ce552006-04-11 13:52:07 +0200975
976 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +0200977 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200978 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200979
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200980 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200981 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +0200982 goto out_release;
983
984 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200985 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +0200986
987 /*
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200988 * If more data is pending, set SPLICE_F_MORE
989 * If this is the last data and SPLICE_F_MORE was not set
990 * initially, clears it.
991 */
992 if (read_len < len)
993 sd->flags |= SPLICE_F_MORE;
994 else if (!more)
995 sd->flags &= ~SPLICE_F_MORE;
996 /*
Jens Axboeb92ce552006-04-11 13:52:07 +0200997 * NOTE: nonblocking mode only applies to the input. We
998 * must not do the output in nonblocking mode as then we
999 * could get stuck data in the internal pipe:
1000 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001001 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +02001002 if (unlikely(ret <= 0)) {
1003 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001004 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001005 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001006
1007 bytes += ret;
1008 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001009 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001010
Tom Zanussia82c53a2008-05-09 13:28:36 +02001011 if (ret < read_len) {
1012 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001013 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001014 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001015 }
1016
Jens Axboe9e971982008-01-29 21:05:57 +01001017done:
Jens Axboeb92ce552006-04-11 13:52:07 +02001018 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001019 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001020 return bytes;
1021
1022out_release:
1023 /*
1024 * If we did an incomplete transfer we must release
1025 * the pipe buffers in question:
1026 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001027 for (i = 0; i < pipe->buffers; i++) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001028 struct pipe_buffer *buf = pipe->bufs + i;
1029
Miklos Szeredia7796382016-09-27 10:45:12 +02001030 if (buf->ops)
1031 pipe_buf_release(pipe, buf);
Jens Axboeb92ce552006-04-11 13:52:07 +02001032 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001033
Jens Axboe9e971982008-01-29 21:05:57 +01001034 if (!bytes)
1035 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001036
Jens Axboe9e971982008-01-29 21:05:57 +01001037 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001038}
1039EXPORT_SYMBOL(splice_direct_to_actor);
1040
1041static int direct_splice_actor(struct pipe_inode_info *pipe,
1042 struct splice_desc *sd)
1043{
Jens Axboe6a14b902007-06-14 13:08:55 +02001044 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001045
Al Viro7995bd22013-06-20 18:58:36 +04001046 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001047 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001048}
1049
Jens Axboe932cc6d2007-06-21 13:10:21 +02001050/**
1051 * do_splice_direct - splices data directly between two files
1052 * @in: file to splice from
1053 * @ppos: input file offset
1054 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001055 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001056 * @len: number of bytes to splice
1057 * @flags: splice modifier flags
1058 *
1059 * Description:
1060 * For use by do_sendfile(). splice can easily emulate sendfile, but
1061 * doing it in the application would incur an extra system call
1062 * (splice in + splice out, as compared to just sendfile()). So this helper
1063 * can splice directly through a process-private pipe.
1064 *
1065 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001066long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001067 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001068{
1069 struct splice_desc sd = {
1070 .len = len,
1071 .total_len = len,
1072 .flags = flags,
1073 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001074 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001075 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001076 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001077 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001078
Al Viro18c67cb2013-06-19 15:41:54 +04001079 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1080 return -EBADF;
1081
1082 if (unlikely(out->f_flags & O_APPEND))
1083 return -EINVAL;
1084
1085 ret = rw_verify_area(WRITE, out, opos, len);
1086 if (unlikely(ret < 0))
1087 return ret;
1088
Jens Axboec66ab6f2007-06-12 21:17:17 +02001089 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001090 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001091 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001092
Jens Axboec66ab6f2007-06-12 21:17:17 +02001093 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001094}
Miklos Szeredi1c118592014-10-24 00:14:35 +02001095EXPORT_SYMBOL(do_splice_direct);
Jens Axboeb92ce552006-04-11 13:52:07 +02001096
Al Viro8924fef2016-09-17 20:44:45 -04001097static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1098{
1099 while (pipe->nrbufs == pipe->buffers) {
1100 if (flags & SPLICE_F_NONBLOCK)
1101 return -EAGAIN;
1102 if (signal_pending(current))
1103 return -ERESTARTSYS;
1104 pipe->waiting_writers++;
1105 pipe_wait(pipe);
1106 pipe->waiting_writers--;
1107 }
1108 return 0;
1109}
1110
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001111static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1112 struct pipe_inode_info *opipe,
1113 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001114
1115/*
Jens Axboe83f91352006-04-02 23:05:09 +02001116 * Determine where to splice to/from.
1117 */
Ingo Molnar529565d2006-04-10 15:18:58 +02001118static long do_splice(struct file *in, loff_t __user *off_in,
1119 struct file *out, loff_t __user *off_out,
1120 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001121{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001122 struct pipe_inode_info *ipipe;
1123 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001124 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001125 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001126
Linus Torvalds71993e62010-11-28 13:56:09 -08001127 ipipe = get_pipe_info(in);
1128 opipe = get_pipe_info(out);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001129
1130 if (ipipe && opipe) {
1131 if (off_in || off_out)
1132 return -ESPIPE;
1133
1134 if (!(in->f_mode & FMODE_READ))
1135 return -EBADF;
1136
1137 if (!(out->f_mode & FMODE_WRITE))
1138 return -EBADF;
1139
1140 /* Splicing to self would be fun, but... */
1141 if (ipipe == opipe)
1142 return -EINVAL;
1143
1144 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1145 }
1146
1147 if (ipipe) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001148 if (off_in)
1149 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001150 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001151 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001152 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001153 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001154 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001155 } else {
1156 offset = out->f_pos;
1157 }
Ingo Molnar529565d2006-04-10 15:18:58 +02001158
Al Viro18c67cb2013-06-19 15:41:54 +04001159 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1160 return -EBADF;
1161
1162 if (unlikely(out->f_flags & O_APPEND))
1163 return -EINVAL;
1164
1165 ret = rw_verify_area(WRITE, out, &offset, len);
1166 if (unlikely(ret < 0))
1167 return ret;
1168
Al Viro500368f2013-05-23 20:07:11 -04001169 file_start_write(out);
Al Viro7995bd22013-06-20 18:58:36 +04001170 ret = do_splice_from(ipipe, out, &offset, len, flags);
Al Viro500368f2013-05-23 20:07:11 -04001171 file_end_write(out);
Jens Axboea4514eb2006-04-19 15:57:05 +02001172
Al Viro7995bd22013-06-20 18:58:36 +04001173 if (!off_out)
1174 out->f_pos = offset;
1175 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001176 ret = -EFAULT;
1177
1178 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001179 }
Jens Axboe5274f052006-03-30 15:15:30 +02001180
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001181 if (opipe) {
Ingo Molnar529565d2006-04-10 15:18:58 +02001182 if (off_out)
1183 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001184 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001185 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001186 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001187 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001188 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001189 } else {
1190 offset = in->f_pos;
1191 }
Ingo Molnar529565d2006-04-10 15:18:58 +02001192
Al Viro8924fef2016-09-17 20:44:45 -04001193 pipe_lock(opipe);
1194 ret = wait_for_space(opipe, flags);
1195 if (!ret)
1196 ret = do_splice_to(in, &offset, opipe, len, flags);
1197 pipe_unlock(opipe);
1198 if (ret > 0)
1199 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001200 if (!off_in)
1201 in->f_pos = offset;
1202 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001203 ret = -EFAULT;
1204
1205 return ret;
Ingo Molnar529565d2006-04-10 15:18:58 +02001206 }
Jens Axboe5274f052006-03-30 15:15:30 +02001207
1208 return -EINVAL;
1209}
1210
Al Viro79fddc42016-09-17 22:38:20 -04001211static int iter_to_pipe(struct iov_iter *from,
1212 struct pipe_inode_info *pipe,
1213 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001214{
Al Viro79fddc42016-09-17 22:38:20 -04001215 struct pipe_buffer buf = {
1216 .ops = &user_page_pipe_buf_ops,
1217 .flags = flags
1218 };
1219 size_t total = 0;
1220 int ret = 0;
1221 bool failed = false;
1222
1223 while (iov_iter_count(from) && !failed) {
1224 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001225 ssize_t copied;
1226 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001227 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001228
Al Viro79fddc42016-09-17 22:38:20 -04001229 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1230 if (copied <= 0) {
1231 ret = copied;
1232 break;
1233 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001234
Al Viro79fddc42016-09-17 22:38:20 -04001235 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001236 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001237 if (!failed) {
1238 buf.page = pages[n];
1239 buf.offset = start;
1240 buf.len = size;
1241 ret = add_to_pipe(pipe, &buf);
1242 if (unlikely(ret < 0)) {
1243 failed = true;
1244 } else {
1245 iov_iter_advance(from, ret);
1246 total += ret;
1247 }
1248 } else {
1249 put_page(pages[n]);
1250 }
Al Virodb85a9e2016-09-17 20:25:06 -04001251 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001252 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001253 }
Al Viro79fddc42016-09-17 22:38:20 -04001254 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001255}
1256
Jens Axboe6a14b902007-06-14 13:08:55 +02001257static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1258 struct splice_desc *sd)
1259{
Al Viro6130f532014-02-03 18:19:51 -05001260 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1261 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001262}
1263
1264/*
1265 * For lack of a better implementation, implement vmsplice() to userspace
1266 * as a simple copy of the pipes pages to the user iov.
1267 */
Al Viro6130f532014-02-03 18:19:51 -05001268static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001269 unsigned long nr_segs, unsigned int flags)
1270{
1271 struct pipe_inode_info *pipe;
1272 struct splice_desc sd;
Jens Axboe6a14b902007-06-14 13:08:55 +02001273 long ret;
Al Viro6130f532014-02-03 18:19:51 -05001274 struct iovec iovstack[UIO_FASTIOV];
1275 struct iovec *iov = iovstack;
1276 struct iov_iter iter;
Jens Axboe6a14b902007-06-14 13:08:55 +02001277
Linus Torvalds71993e62010-11-28 13:56:09 -08001278 pipe = get_pipe_info(file);
Jens Axboe6a14b902007-06-14 13:08:55 +02001279 if (!pipe)
1280 return -EBADF;
1281
Al Viro345995f2015-03-21 19:17:55 -04001282 ret = import_iovec(READ, uiov, nr_segs,
1283 ARRAY_SIZE(iovstack), &iov, &iter);
1284 if (ret < 0)
1285 return ret;
Al Viro6130f532014-02-03 18:19:51 -05001286
Al Viro345995f2015-03-21 19:17:55 -04001287 sd.total_len = iov_iter_count(&iter);
Al Viro6130f532014-02-03 18:19:51 -05001288 sd.len = 0;
Al Viro6130f532014-02-03 18:19:51 -05001289 sd.flags = flags;
1290 sd.u.data = &iter;
1291 sd.pos = 0;
1292
Al Viro345995f2015-03-21 19:17:55 -04001293 if (sd.total_len) {
1294 pipe_lock(pipe);
1295 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1296 pipe_unlock(pipe);
1297 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001298
Al Viro345995f2015-03-21 19:17:55 -04001299 kfree(iov);
Jens Axboe6a14b902007-06-14 13:08:55 +02001300 return ret;
1301}
1302
Jens Axboe912d35f2006-04-26 10:59:21 +02001303/*
1304 * vmsplice splices a user address range into a pipe. It can be thought of
1305 * as splice-from-memory, where the regular splice is splice-from-file (or
1306 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001307 */
Al Virodb85a9e2016-09-17 20:25:06 -04001308static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001309 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001310{
Jens Axboeddac0d32006-11-04 12:49:32 +01001311 struct pipe_inode_info *pipe;
Al Virodb85a9e2016-09-17 20:25:06 -04001312 struct iovec iovstack[UIO_FASTIOV];
1313 struct iovec *iov = iovstack;
1314 struct iov_iter from;
Jens Axboe35f3d142010-05-20 10:43:18 +02001315 long ret;
Al Viro79fddc42016-09-17 22:38:20 -04001316 unsigned buf_flag = 0;
1317
1318 if (flags & SPLICE_F_GIFT)
1319 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001320
Linus Torvalds71993e62010-11-28 13:56:09 -08001321 pipe = get_pipe_info(file);
Jens Axboeddac0d32006-11-04 12:49:32 +01001322 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001323 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001324
Al Virodb85a9e2016-09-17 20:25:06 -04001325 ret = import_iovec(WRITE, uiov, nr_segs,
1326 ARRAY_SIZE(iovstack), &iov, &from);
1327 if (ret < 0)
1328 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001329
Al Viro8924fef2016-09-17 20:44:45 -04001330 pipe_lock(pipe);
1331 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001332 if (!ret)
1333 ret = iter_to_pipe(&from, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001334 pipe_unlock(pipe);
1335 if (ret > 0)
1336 wakeup_pipe_readers(pipe);
Al Virodb85a9e2016-09-17 20:25:06 -04001337 kfree(iov);
Jens Axboe35f3d142010-05-20 10:43:18 +02001338 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001339}
1340
Jens Axboe6a14b902007-06-14 13:08:55 +02001341/*
1342 * Note that vmsplice only really supports true splicing _from_ user memory
1343 * to a pipe, not the other way around. Splicing from user memory is a simple
1344 * operation that can be supported without any funky alignment restrictions
1345 * or nasty vm tricks. We simply map in the user memory and fill them into
1346 * a pipe. The reverse isn't quite as easy, though. There are two possible
1347 * solutions for that:
1348 *
1349 * - memcpy() the data internally, at which point we might as well just
1350 * do a regular read() on the buffer anyway.
1351 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1352 * has restriction limitations on both ends of the pipe).
1353 *
1354 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1355 *
1356 */
Heiko Carstens836f92a2009-01-14 14:14:33 +01001357SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1358 unsigned long, nr_segs, unsigned int, flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001359{
Al Viro2903ff02012-08-28 12:52:22 -04001360 struct fd f;
Jens Axboe912d35f2006-04-26 10:59:21 +02001361 long error;
Jens Axboe912d35f2006-04-26 10:59:21 +02001362
Jens Axboe6a14b902007-06-14 13:08:55 +02001363 if (unlikely(nr_segs > UIO_MAXIOV))
1364 return -EINVAL;
1365 else if (unlikely(!nr_segs))
1366 return 0;
1367
Jens Axboe912d35f2006-04-26 10:59:21 +02001368 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001369 f = fdget(fd);
1370 if (f.file) {
1371 if (f.file->f_mode & FMODE_WRITE)
1372 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1373 else if (f.file->f_mode & FMODE_READ)
1374 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001375
Al Viro2903ff02012-08-28 12:52:22 -04001376 fdput(f);
Jens Axboe912d35f2006-04-26 10:59:21 +02001377 }
1378
1379 return error;
1380}
1381
Al Viro76b021d2013-03-02 10:19:56 -05001382#ifdef CONFIG_COMPAT
1383COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1384 unsigned int, nr_segs, unsigned int, flags)
1385{
1386 unsigned i;
1387 struct iovec __user *iov;
1388 if (nr_segs > UIO_MAXIOV)
1389 return -EINVAL;
1390 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1391 for (i = 0; i < nr_segs; i++) {
1392 struct compat_iovec v;
1393 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1394 get_user(v.iov_len, &iov32[i].iov_len) ||
1395 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1396 put_user(v.iov_len, &iov[i].iov_len))
1397 return -EFAULT;
1398 }
1399 return sys_vmsplice(fd, iov, nr_segs, flags);
1400}
1401#endif
1402
Heiko Carstens836f92a2009-01-14 14:14:33 +01001403SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1404 int, fd_out, loff_t __user *, off_out,
1405 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001406{
Al Viro2903ff02012-08-28 12:52:22 -04001407 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001408 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001409
1410 if (unlikely(!len))
1411 return 0;
1412
1413 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001414 in = fdget(fd_in);
1415 if (in.file) {
1416 if (in.file->f_mode & FMODE_READ) {
1417 out = fdget(fd_out);
1418 if (out.file) {
1419 if (out.file->f_mode & FMODE_WRITE)
1420 error = do_splice(in.file, off_in,
1421 out.file, off_out,
Ingo Molnar529565d2006-04-10 15:18:58 +02001422 len, flags);
Al Viro2903ff02012-08-28 12:52:22 -04001423 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001424 }
1425 }
Al Viro2903ff02012-08-28 12:52:22 -04001426 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001427 }
Jens Axboe5274f052006-03-30 15:15:30 +02001428 return error;
1429}
Jens Axboe70524492006-04-11 15:51:17 +02001430
1431/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001432 * Make sure there's data to read. Wait for input if we can, otherwise
1433 * return an appropriate error.
1434 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001435static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001436{
1437 int ret;
1438
1439 /*
1440 * Check ->nrbufs without the inode lock first. This function
1441 * is speculative anyways, so missing one is ok.
1442 */
1443 if (pipe->nrbufs)
1444 return 0;
1445
1446 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001447 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001448
1449 while (!pipe->nrbufs) {
1450 if (signal_pending(current)) {
1451 ret = -ERESTARTSYS;
1452 break;
1453 }
1454 if (!pipe->writers)
1455 break;
1456 if (!pipe->waiting_writers) {
1457 if (flags & SPLICE_F_NONBLOCK) {
1458 ret = -EAGAIN;
1459 break;
1460 }
1461 }
1462 pipe_wait(pipe);
1463 }
1464
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001465 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001466 return ret;
1467}
1468
1469/*
1470 * Make sure there's writeable room. Wait for room if we can, otherwise
1471 * return an appropriate error.
1472 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001473static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001474{
1475 int ret;
1476
1477 /*
1478 * Check ->nrbufs without the inode lock first. This function
1479 * is speculative anyways, so missing one is ok.
1480 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001481 if (pipe->nrbufs < pipe->buffers)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001482 return 0;
1483
1484 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001485 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001486
Jens Axboe35f3d142010-05-20 10:43:18 +02001487 while (pipe->nrbufs >= pipe->buffers) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001488 if (!pipe->readers) {
1489 send_sig(SIGPIPE, current, 0);
1490 ret = -EPIPE;
1491 break;
1492 }
1493 if (flags & SPLICE_F_NONBLOCK) {
1494 ret = -EAGAIN;
1495 break;
1496 }
1497 if (signal_pending(current)) {
1498 ret = -ERESTARTSYS;
1499 break;
1500 }
1501 pipe->waiting_writers++;
1502 pipe_wait(pipe);
1503 pipe->waiting_writers--;
1504 }
1505
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001506 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001507 return ret;
1508}
1509
1510/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001511 * Splice contents of ipipe to opipe.
1512 */
1513static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1514 struct pipe_inode_info *opipe,
1515 size_t len, unsigned int flags)
1516{
1517 struct pipe_buffer *ibuf, *obuf;
1518 int ret = 0, nbuf;
1519 bool input_wakeup = false;
1520
1521
1522retry:
1523 ret = ipipe_prep(ipipe, flags);
1524 if (ret)
1525 return ret;
1526
1527 ret = opipe_prep(opipe, flags);
1528 if (ret)
1529 return ret;
1530
1531 /*
1532 * Potential ABBA deadlock, work around it by ordering lock
1533 * grabbing by pipe info address. Otherwise two different processes
1534 * could deadlock (one doing tee from A -> B, the other from B -> A).
1535 */
1536 pipe_double_lock(ipipe, opipe);
1537
1538 do {
1539 if (!opipe->readers) {
1540 send_sig(SIGPIPE, current, 0);
1541 if (!ret)
1542 ret = -EPIPE;
1543 break;
1544 }
1545
1546 if (!ipipe->nrbufs && !ipipe->writers)
1547 break;
1548
1549 /*
1550 * Cannot make any progress, because either the input
1551 * pipe is empty or the output pipe is full.
1552 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001553 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001554 /* Already processed some buffers, break */
1555 if (ret)
1556 break;
1557
1558 if (flags & SPLICE_F_NONBLOCK) {
1559 ret = -EAGAIN;
1560 break;
1561 }
1562
1563 /*
1564 * We raced with another reader/writer and haven't
1565 * managed to process any buffers. A zero return
1566 * value means EOF, so retry instead.
1567 */
1568 pipe_unlock(ipipe);
1569 pipe_unlock(opipe);
1570 goto retry;
1571 }
1572
1573 ibuf = ipipe->bufs + ipipe->curbuf;
Jens Axboe35f3d142010-05-20 10:43:18 +02001574 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001575 obuf = opipe->bufs + nbuf;
1576
1577 if (len >= ibuf->len) {
1578 /*
1579 * Simply move the whole buffer from ipipe to opipe
1580 */
1581 *obuf = *ibuf;
1582 ibuf->ops = NULL;
1583 opipe->nrbufs++;
Jens Axboe35f3d142010-05-20 10:43:18 +02001584 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001585 ipipe->nrbufs--;
1586 input_wakeup = true;
1587 } else {
1588 /*
1589 * Get a reference to this pipe buffer,
1590 * so we can copy the contents over.
1591 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001592 pipe_buf_get(ipipe, ibuf);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001593 *obuf = *ibuf;
1594
1595 /*
1596 * Don't inherit the gift flag, we need to
1597 * prevent multiple steals of this page.
1598 */
1599 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1600
1601 obuf->len = len;
1602 opipe->nrbufs++;
1603 ibuf->offset += obuf->len;
1604 ibuf->len -= obuf->len;
1605 }
1606 ret += obuf->len;
1607 len -= obuf->len;
1608 } while (len);
1609
1610 pipe_unlock(ipipe);
1611 pipe_unlock(opipe);
1612
1613 /*
1614 * If we put data in the output pipe, wakeup any potential readers.
1615 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001616 if (ret > 0)
1617 wakeup_pipe_readers(opipe);
1618
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001619 if (input_wakeup)
1620 wakeup_pipe_writers(ipipe);
1621
1622 return ret;
1623}
1624
1625/*
Jens Axboe70524492006-04-11 15:51:17 +02001626 * Link contents of ipipe to opipe.
1627 */
1628static int link_pipe(struct pipe_inode_info *ipipe,
1629 struct pipe_inode_info *opipe,
1630 size_t len, unsigned int flags)
1631{
1632 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001633 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001634
1635 /*
1636 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001637 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001638 * could deadlock (one doing tee from A -> B, the other from B -> A).
1639 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001640 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001641
Jens Axboeaadd06e2006-07-10 11:00:01 +02001642 do {
Jens Axboe70524492006-04-11 15:51:17 +02001643 if (!opipe->readers) {
1644 send_sig(SIGPIPE, current, 0);
1645 if (!ret)
1646 ret = -EPIPE;
1647 break;
1648 }
Jens Axboe70524492006-04-11 15:51:17 +02001649
1650 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001651 * If we have iterated all input buffers or ran out of
1652 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001653 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001654 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
Jens Axboe70524492006-04-11 15:51:17 +02001655 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001656
Jens Axboe35f3d142010-05-20 10:43:18 +02001657 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1658 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001659
Jens Axboe2a27250e2006-04-19 15:56:40 +02001660 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001661 * Get a reference to this pipe buffer,
1662 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001663 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001664 pipe_buf_get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001665
Jens Axboeaadd06e2006-07-10 11:00:01 +02001666 obuf = opipe->bufs + nbuf;
1667 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001668
Jens Axboeaadd06e2006-07-10 11:00:01 +02001669 /*
1670 * Don't inherit the gift flag, we need to
1671 * prevent multiple steals of this page.
1672 */
1673 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1674
1675 if (obuf->len > len)
1676 obuf->len = len;
1677
1678 opipe->nrbufs++;
1679 ret += obuf->len;
1680 len -= obuf->len;
1681 i++;
1682 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001683
Jens Axboe02cf01a2008-02-20 10:34:51 +01001684 /*
1685 * return EAGAIN if we have the potential of some data in the
1686 * future, otherwise just return 0
1687 */
1688 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1689 ret = -EAGAIN;
1690
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001691 pipe_unlock(ipipe);
1692 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001693
Jens Axboeaadd06e2006-07-10 11:00:01 +02001694 /*
1695 * If we put data in the output pipe, wakeup any potential readers.
1696 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001697 if (ret > 0)
1698 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001699
1700 return ret;
1701}
1702
1703/*
1704 * This is a tee(1) implementation that works on pipes. It doesn't copy
1705 * any data, it simply references the 'in' pages on the 'out' pipe.
1706 * The 'flags' used are the SPLICE_F_* variants, currently the only
1707 * applicable one is SPLICE_F_NONBLOCK.
1708 */
1709static long do_tee(struct file *in, struct file *out, size_t len,
1710 unsigned int flags)
1711{
Linus Torvalds71993e62010-11-28 13:56:09 -08001712 struct pipe_inode_info *ipipe = get_pipe_info(in);
1713 struct pipe_inode_info *opipe = get_pipe_info(out);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001714 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001715
1716 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001717 * Duplicate the contents of ipipe to opipe without actually
1718 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001719 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001720 if (ipipe && opipe && ipipe != opipe) {
1721 /*
1722 * Keep going, unless we encounter an error. The ipipe/opipe
1723 * ordering doesn't really matter.
1724 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001725 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001726 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001727 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001728 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001729 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001730 }
1731 }
Jens Axboe70524492006-04-11 15:51:17 +02001732
Jens Axboeaadd06e2006-07-10 11:00:01 +02001733 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001734}
1735
Heiko Carstens836f92a2009-01-14 14:14:33 +01001736SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001737{
Al Viro2903ff02012-08-28 12:52:22 -04001738 struct fd in;
1739 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001740
1741 if (unlikely(!len))
1742 return 0;
1743
1744 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001745 in = fdget(fdin);
1746 if (in.file) {
1747 if (in.file->f_mode & FMODE_READ) {
1748 struct fd out = fdget(fdout);
1749 if (out.file) {
1750 if (out.file->f_mode & FMODE_WRITE)
1751 error = do_tee(in.file, out.file,
1752 len, flags);
1753 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001754 }
1755 }
Al Viro2903ff02012-08-28 12:52:22 -04001756 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001757 }
1758
1759 return error;
1760}