blob: 51492f26915afbf0e7ecd5952a194b2c7d9ff4a6 [file] [log] [blame]
Jens Axboe5274f052006-03-30 15:15:30 +02001/*
2 * "splice": joining two ropes together by interweaving their strands.
3 *
4 * This is the "extended pipe" functionality, where a pipe is used as
5 * an arbitrary in-memory buffer. Think of a pipe as a small kernel
6 * buffer that you can use to transfer data from one end to the other.
7 *
8 * The traditional unix read/write is extended with a "splice()" operation
9 * that transfers data buffers to or from a pipe buffer.
10 *
11 * Named by Larry McVoy, original implementation from Linus, extended by
Jens Axboec2058e02006-04-11 13:56:34 +020012 * Jens to support splicing to files, network, direct splicing, etc and
13 * fixing lots of bugs.
Jens Axboe5274f052006-03-30 15:15:30 +020014 *
Jens Axboe0fe23472006-09-04 15:41:16 +020015 * Copyright (C) 2005-2006 Jens Axboe <axboe@kernel.dk>
Jens Axboec2058e02006-04-11 13:56:34 +020016 * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
17 * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
Jens Axboe5274f052006-03-30 15:15:30 +020018 *
19 */
Christoph Hellwigbe297962016-11-01 07:40:16 -060020#include <linux/bvec.h>
Jens Axboe5274f052006-03-30 15:15:30 +020021#include <linux/fs.h>
22#include <linux/file.h>
23#include <linux/pagemap.h>
Jens Axboed6b29d72007-06-04 09:59:47 +020024#include <linux/splice.h>
KAMEZAWA Hiroyuki08e552c2009-01-07 18:08:01 -080025#include <linux/memcontrol.h>
Jens Axboe5274f052006-03-30 15:15:30 +020026#include <linux/mm_inline.h>
Jens Axboe5abc97a2006-03-30 15:16:46 +020027#include <linux/swap.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020028#include <linux/writeback.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050029#include <linux/export.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020030#include <linux/syscalls.h>
Jens Axboe912d35f2006-04-26 10:59:21 +020031#include <linux/uio.h>
James Morris29ce2052007-07-13 11:44:32 +020032#include <linux/security.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090033#include <linux/gfp.h>
Eric Dumazet35f9c092012-04-05 03:05:35 +000034#include <linux/socket.h>
Al Viro76b021d2013-03-02 10:19:56 -050035#include <linux/compat.h>
Al Viro06ae43f2013-03-20 13:19:30 -040036#include "internal.h"
Jens Axboe5274f052006-03-30 15:15:30 +020037
Jens Axboe83f91352006-04-02 23:05:09 +020038/*
39 * Attempt to steal a page from a pipe buffer. This should perhaps go into
40 * a vm helper function, it's already simplified quite a bit by the
41 * addition of remove_mapping(). If success is returned, the caller may
42 * attempt to reuse this page for another destination.
43 */
Jens Axboe76ad4d12006-05-03 10:41:33 +020044static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
Jens Axboe5abc97a2006-03-30 15:16:46 +020045 struct pipe_buffer *buf)
46{
47 struct page *page = buf->page;
Jens Axboe9e94cd42006-06-20 15:01:12 +020048 struct address_space *mapping;
Jens Axboe5abc97a2006-03-30 15:16:46 +020049
Jens Axboe9e0267c2006-04-19 15:57:31 +020050 lock_page(page);
51
Jens Axboe9e94cd42006-06-20 15:01:12 +020052 mapping = page_mapping(page);
53 if (mapping) {
54 WARN_ON(!PageUptodate(page));
Jens Axboe5abc97a2006-03-30 15:16:46 +020055
Jens Axboe9e94cd42006-06-20 15:01:12 +020056 /*
57 * At least for ext2 with nobh option, we need to wait on
58 * writeback completing on this page, since we'll remove it
59 * from the pagecache. Otherwise truncate wont wait on the
60 * page, allowing the disk blocks to be reused by someone else
61 * before we actually wrote our data to them. fs corruption
62 * ensues.
63 */
64 wait_on_page_writeback(page);
Jens Axboead8d6f02006-04-02 23:10:32 +020065
David Howells266cf652009-04-03 16:42:36 +010066 if (page_has_private(page) &&
67 !try_to_release_page(page, GFP_KERNEL))
Jens Axboeca39d652008-05-20 21:27:41 +020068 goto out_unlock;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020069
Jens Axboe9e94cd42006-06-20 15:01:12 +020070 /*
71 * If we succeeded in removing the mapping, set LRU flag
72 * and return good.
73 */
74 if (remove_mapping(mapping, page)) {
75 buf->flags |= PIPE_BUF_FLAG_LRU;
76 return 0;
77 }
Jens Axboe9e0267c2006-04-19 15:57:31 +020078 }
Jens Axboe5abc97a2006-03-30 15:16:46 +020079
Jens Axboe9e94cd42006-06-20 15:01:12 +020080 /*
81 * Raced with truncate or failed to remove page from current
82 * address space, unlock and return failure.
83 */
Jens Axboeca39d652008-05-20 21:27:41 +020084out_unlock:
Jens Axboe9e94cd42006-06-20 15:01:12 +020085 unlock_page(page);
86 return 1;
Jens Axboe5abc97a2006-03-30 15:16:46 +020087}
88
Jens Axboe76ad4d12006-05-03 10:41:33 +020089static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +020090 struct pipe_buffer *buf)
91{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030092 put_page(buf->page);
Jens Axboe14328732006-05-03 10:35:26 +020093 buf->flags &= ~PIPE_BUF_FLAG_LRU;
Jens Axboe5274f052006-03-30 15:15:30 +020094}
95
Jens Axboe08457182007-06-12 20:51:32 +020096/*
97 * Check whether the contents of buf is OK to access. Since the content
98 * is a page cache page, IO may be in flight.
99 */
Jens Axboecac36bb02007-06-14 13:10:48 +0200100static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
101 struct pipe_buffer *buf)
Jens Axboe5274f052006-03-30 15:15:30 +0200102{
103 struct page *page = buf->page;
Jens Axboe49d0b212006-04-10 09:04:41 +0200104 int err;
Jens Axboe5274f052006-03-30 15:15:30 +0200105
106 if (!PageUptodate(page)) {
Jens Axboe49d0b212006-04-10 09:04:41 +0200107 lock_page(page);
108
109 /*
110 * Page got truncated/unhashed. This will cause a 0-byte
Ingo Molnar73d62d82006-04-11 13:57:21 +0200111 * splice, if this is the first page.
Jens Axboe49d0b212006-04-10 09:04:41 +0200112 */
113 if (!page->mapping) {
114 err = -ENODATA;
115 goto error;
116 }
117
118 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200119 * Uh oh, read-error from disk.
Jens Axboe49d0b212006-04-10 09:04:41 +0200120 */
121 if (!PageUptodate(page)) {
122 err = -EIO;
123 goto error;
124 }
125
126 /*
Jens Axboef84d7512006-05-01 19:59:03 +0200127 * Page is ok afterall, we are done.
Jens Axboe49d0b212006-04-10 09:04:41 +0200128 */
Jens Axboe5274f052006-03-30 15:15:30 +0200129 unlock_page(page);
Jens Axboe5274f052006-03-30 15:15:30 +0200130 }
131
Jens Axboef84d7512006-05-01 19:59:03 +0200132 return 0;
Jens Axboe49d0b212006-04-10 09:04:41 +0200133error:
134 unlock_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200135 return err;
Jens Axboe70524492006-04-11 15:51:17 +0200136}
137
Hugh Dickins708e3502011-07-25 17:12:32 -0700138const struct pipe_buf_operations page_cache_pipe_buf_ops = {
Jens Axboe5274f052006-03-30 15:15:30 +0200139 .can_merge = 0,
Jens Axboecac36bb02007-06-14 13:10:48 +0200140 .confirm = page_cache_pipe_buf_confirm,
Jens Axboe5274f052006-03-30 15:15:30 +0200141 .release = page_cache_pipe_buf_release,
Jens Axboe5abc97a2006-03-30 15:16:46 +0200142 .steal = page_cache_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200143 .get = generic_pipe_buf_get,
Jens Axboe5274f052006-03-30 15:15:30 +0200144};
145
Jens Axboe912d35f2006-04-26 10:59:21 +0200146static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
147 struct pipe_buffer *buf)
148{
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200149 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
150 return 1;
151
Jens Axboe14328732006-05-03 10:35:26 +0200152 buf->flags |= PIPE_BUF_FLAG_LRU;
Jens Axboe330ab712006-05-02 15:29:57 +0200153 return generic_pipe_buf_steal(pipe, buf);
Jens Axboe912d35f2006-04-26 10:59:21 +0200154}
155
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800156static const struct pipe_buf_operations user_page_pipe_buf_ops = {
Jens Axboe912d35f2006-04-26 10:59:21 +0200157 .can_merge = 0,
Jens Axboecac36bb02007-06-14 13:10:48 +0200158 .confirm = generic_pipe_buf_confirm,
Jens Axboe912d35f2006-04-26 10:59:21 +0200159 .release = page_cache_pipe_buf_release,
160 .steal = user_page_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200161 .get = generic_pipe_buf_get,
Jens Axboe912d35f2006-04-26 10:59:21 +0200162};
163
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200164static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
165{
166 smp_mb();
167 if (waitqueue_active(&pipe->wait))
168 wake_up_interruptible(&pipe->wait);
169 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
170}
171
Jens Axboe932cc6d2007-06-21 13:10:21 +0200172/**
173 * splice_to_pipe - fill passed data into a pipe
174 * @pipe: pipe to fill
175 * @spd: data to fill
176 *
177 * Description:
Randy Dunlap79685b82007-07-27 08:08:51 +0200178 * @spd contains a map of pages and len/offset tuples, along with
Jens Axboe932cc6d2007-06-21 13:10:21 +0200179 * the struct pipe_buf_operations associated with these pages. This
180 * function will link that data to the pipe.
181 *
Jens Axboe83f91352006-04-02 23:05:09 +0200182 */
Jens Axboed6b29d72007-06-04 09:59:47 +0200183ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
184 struct splice_pipe_desc *spd)
Jens Axboe5274f052006-03-30 15:15:30 +0200185{
Jens Axboe00de00b2007-06-15 13:14:22 +0200186 unsigned int spd_pages = spd->nr_pages;
Al Viro8924fef2016-09-17 20:44:45 -0400187 int ret = 0, page_nr = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200188
Rabin Vincentd6785d92016-03-10 21:19:06 +0100189 if (!spd_pages)
190 return 0;
191
Al Viro8924fef2016-09-17 20:44:45 -0400192 if (unlikely(!pipe->readers)) {
193 send_sig(SIGPIPE, current, 0);
194 ret = -EPIPE;
195 goto out;
Jens Axboe5274f052006-03-30 15:15:30 +0200196 }
197
Al Viro8924fef2016-09-17 20:44:45 -0400198 while (pipe->nrbufs < pipe->buffers) {
199 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
200 struct pipe_buffer *buf = pipe->bufs + newbuf;
Jens Axboe5274f052006-03-30 15:15:30 +0200201
Al Viro8924fef2016-09-17 20:44:45 -0400202 buf->page = spd->pages[page_nr];
203 buf->offset = spd->partial[page_nr].offset;
204 buf->len = spd->partial[page_nr].len;
205 buf->private = spd->partial[page_nr].private;
206 buf->ops = spd->ops;
Jens Axboe5274f052006-03-30 15:15:30 +0200207
Al Viro8924fef2016-09-17 20:44:45 -0400208 pipe->nrbufs++;
209 page_nr++;
210 ret += buf->len;
211
212 if (!--spd->nr_pages)
213 break;
214 }
215
216 if (!ret)
217 ret = -EAGAIN;
218
219out:
Jens Axboe00de00b2007-06-15 13:14:22 +0200220 while (page_nr < spd_pages)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800221 spd->spd_release(spd, page_nr++);
Jens Axboe5274f052006-03-30 15:15:30 +0200222
223 return ret;
224}
Hannes Frederic Sowa2b514572015-05-21 17:00:01 +0200225EXPORT_SYMBOL_GPL(splice_to_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200226
Al Viro79fddc42016-09-17 22:38:20 -0400227ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
228{
229 int ret;
230
231 if (unlikely(!pipe->readers)) {
232 send_sig(SIGPIPE, current, 0);
233 ret = -EPIPE;
234 } else if (pipe->nrbufs == pipe->buffers) {
235 ret = -EAGAIN;
236 } else {
237 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
238 pipe->bufs[newbuf] = *buf;
239 pipe->nrbufs++;
240 return buf->len;
241 }
Miklos Szeredia7796382016-09-27 10:45:12 +0200242 pipe_buf_release(pipe, buf);
Al Viro79fddc42016-09-17 22:38:20 -0400243 return ret;
244}
245EXPORT_SYMBOL(add_to_pipe);
246
Hugh Dickins708e3502011-07-25 17:12:32 -0700247void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800248{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300249 put_page(spd->pages[i]);
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800250}
251
Jens Axboe35f3d142010-05-20 10:43:18 +0200252/*
253 * Check if we need to grow the arrays holding pages and partial page
254 * descriptions.
255 */
Eric Dumazet047fe362012-06-12 15:24:40 +0200256int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200257{
Eric Dumazet047fe362012-06-12 15:24:40 +0200258 unsigned int buffers = ACCESS_ONCE(pipe->buffers);
259
260 spd->nr_pages_max = buffers;
261 if (buffers <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200262 return 0;
263
Eric Dumazet047fe362012-06-12 15:24:40 +0200264 spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
265 spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200266
267 if (spd->pages && spd->partial)
268 return 0;
269
270 kfree(spd->pages);
271 kfree(spd->partial);
272 return -ENOMEM;
273}
274
Eric Dumazet047fe362012-06-12 15:24:40 +0200275void splice_shrink_spd(struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200276{
Eric Dumazet047fe362012-06-12 15:24:40 +0200277 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200278 return;
279
280 kfree(spd->pages);
281 kfree(spd->partial);
282}
283
Jens Axboe83f91352006-04-02 23:05:09 +0200284/**
285 * generic_file_splice_read - splice data from file to a pipe
286 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200287 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200288 * @pipe: pipe to splice to
289 * @len: number of bytes to splice
290 * @flags: splice modifier flags
291 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200292 * Description:
293 * Will read pages from given file and fill them into a pipe. Can be
Al Viro82c156f2016-09-22 23:35:42 -0400294 * used as long as it has more or less sane ->read_iter().
Jens Axboe932cc6d2007-06-21 13:10:21 +0200295 *
Jens Axboe83f91352006-04-02 23:05:09 +0200296 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200297ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
298 struct pipe_inode_info *pipe, size_t len,
299 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200300{
Al Viro82c156f2016-09-22 23:35:42 -0400301 struct iov_iter to;
302 struct kiocb kiocb;
303 loff_t isize;
304 int idx, ret;
Boaz Harroshbe64f882015-04-15 16:15:17 -0700305
Jens Axboed366d3982007-06-01 14:54:11 +0200306 isize = i_size_read(in->f_mapping->host);
307 if (unlikely(*ppos >= isize))
308 return 0;
309
Al Viro82c156f2016-09-22 23:35:42 -0400310 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len);
311 idx = to.idx;
312 init_sync_kiocb(&kiocb, in);
313 kiocb.ki_pos = *ppos;
314 ret = in->f_op->read_iter(&kiocb, &to);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200315 if (ret > 0) {
Al Viro82c156f2016-09-22 23:35:42 -0400316 *ppos = kiocb.ki_pos;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200317 file_accessed(in);
Al Viro82c156f2016-09-22 23:35:42 -0400318 } else if (ret < 0) {
Al Viroc3a69022016-10-10 13:26:27 -0400319 to.idx = idx;
320 to.iov_offset = 0;
321 iov_iter_advance(&to, 0); /* to free what was emitted */
Al Viro82c156f2016-09-22 23:35:42 -0400322 /*
323 * callers of ->splice_read() expect -EAGAIN on
324 * "can't put anything in there", rather than -EFAULT.
325 */
326 if (ret == -EFAULT)
327 ret = -EAGAIN;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200328 }
Jens Axboe5274f052006-03-30 15:15:30 +0200329
330 return ret;
331}
Jens Axboe059a8f32006-04-02 23:06:05 +0200332EXPORT_SYMBOL(generic_file_splice_read);
333
Al Viro241699c2016-09-22 16:33:12 -0400334const struct pipe_buf_operations default_pipe_buf_ops = {
Miklos Szeredi68181732009-05-07 15:37:36 +0200335 .can_merge = 0,
Miklos Szeredi68181732009-05-07 15:37:36 +0200336 .confirm = generic_pipe_buf_confirm,
337 .release = generic_pipe_buf_release,
338 .steal = generic_pipe_buf_steal,
339 .get = generic_pipe_buf_get,
340};
341
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100342static int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
343 struct pipe_buffer *buf)
344{
345 return 1;
346}
347
348/* Pipe buffer operations for a socket and similar. */
349const struct pipe_buf_operations nosteal_pipe_buf_ops = {
350 .can_merge = 0,
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100351 .confirm = generic_pipe_buf_confirm,
352 .release = generic_pipe_buf_release,
353 .steal = generic_pipe_buf_nosteal,
354 .get = generic_pipe_buf_get,
355};
356EXPORT_SYMBOL(nosteal_pipe_buf_ops);
357
Al Viro523ac9a2016-09-23 15:34:57 -0400358static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
Miklos Szeredi68181732009-05-07 15:37:36 +0200359 unsigned long vlen, loff_t offset)
360{
361 mm_segment_t old_fs;
362 loff_t pos = offset;
363 ssize_t res;
364
365 old_fs = get_fs();
366 set_fs(get_ds());
367 /* The cast to a user pointer is valid due to the set_fs() */
Christoph Hellwig793b80e2016-03-03 16:03:58 +0100368 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
Miklos Szeredi68181732009-05-07 15:37:36 +0200369 set_fs(old_fs);
370
371 return res;
372}
373
Al Viro7bb307e2013-02-23 14:51:48 -0500374ssize_t kernel_write(struct file *file, const char *buf, size_t count,
Miklos Szeredib2858d72009-05-19 11:37:46 +0200375 loff_t pos)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200376{
377 mm_segment_t old_fs;
378 ssize_t res;
379
380 old_fs = get_fs();
381 set_fs(get_ds());
382 /* The cast to a user pointer is valid due to the set_fs() */
Al Viro7bb307e2013-02-23 14:51:48 -0500383 res = vfs_write(file, (__force const char __user *)buf, count, &pos);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200384 set_fs(old_fs);
385
386 return res;
387}
Al Viro7bb307e2013-02-23 14:51:48 -0500388EXPORT_SYMBOL(kernel_write);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200389
Al Viro82c156f2016-09-22 23:35:42 -0400390static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
Miklos Szeredi68181732009-05-07 15:37:36 +0200391 struct pipe_inode_info *pipe, size_t len,
392 unsigned int flags)
393{
Al Viro523ac9a2016-09-23 15:34:57 -0400394 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
395 struct iov_iter to;
396 struct page **pages;
Miklos Szeredi68181732009-05-07 15:37:36 +0200397 unsigned int nr_pages;
Al Viro523ac9a2016-09-23 15:34:57 -0400398 size_t offset, dummy, copied = 0;
Miklos Szeredi68181732009-05-07 15:37:36 +0200399 ssize_t res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200400 int i;
Miklos Szeredi68181732009-05-07 15:37:36 +0200401
Al Viro523ac9a2016-09-23 15:34:57 -0400402 if (pipe->nrbufs == pipe->buffers)
403 return -EAGAIN;
404
405 /*
406 * Try to keep page boundaries matching to source pagecache ones -
407 * it probably won't be much help, but...
408 */
409 offset = *ppos & ~PAGE_MASK;
410
411 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
412
413 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &dummy);
414 if (res <= 0)
Jens Axboe35f3d142010-05-20 10:43:18 +0200415 return -ENOMEM;
416
Al Viro523ac9a2016-09-23 15:34:57 -0400417 nr_pages = res / PAGE_SIZE;
418
Jens Axboe35f3d142010-05-20 10:43:18 +0200419 vec = __vec;
Al Viro523ac9a2016-09-23 15:34:57 -0400420 if (nr_pages > PIPE_DEF_BUFFERS) {
421 vec = kmalloc(nr_pages * sizeof(struct kvec), GFP_KERNEL);
422 if (unlikely(!vec)) {
423 res = -ENOMEM;
424 goto out;
425 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200426 }
427
Al Viro523ac9a2016-09-23 15:34:57 -0400428 pipe->bufs[to.idx].offset = offset;
429 pipe->bufs[to.idx].len -= offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200430
Al Viro523ac9a2016-09-23 15:34:57 -0400431 for (i = 0; i < nr_pages; i++) {
432 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
433 vec[i].iov_base = page_address(pages[i]) + offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200434 vec[i].iov_len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200435 len -= this_len;
436 offset = 0;
437 }
438
Al Viro523ac9a2016-09-23 15:34:57 -0400439 res = kernel_readv(in, vec, nr_pages, *ppos);
440 if (res > 0) {
441 copied = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200442 *ppos += res;
Al Viro523ac9a2016-09-23 15:34:57 -0400443 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200444
Jens Axboe35f3d142010-05-20 10:43:18 +0200445 if (vec != __vec)
446 kfree(vec);
Al Viro523ac9a2016-09-23 15:34:57 -0400447out:
448 for (i = 0; i < nr_pages; i++)
449 put_page(pages[i]);
450 kvfree(pages);
451 iov_iter_advance(&to, copied); /* truncates and discards */
Miklos Szeredi68181732009-05-07 15:37:36 +0200452 return res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200453}
Miklos Szeredi68181732009-05-07 15:37:36 +0200454
Jens Axboe5274f052006-03-30 15:15:30 +0200455/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200456 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200457 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200458 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200459static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200460 struct pipe_buffer *buf, struct splice_desc *sd)
461{
Jens Axboe6a14b902007-06-14 13:08:55 +0200462 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200463 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100464 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200465
Al Viro72c2d532013-09-22 16:27:52 -0400466 if (!likely(file->f_op->sendpage))
Michał Mirosława8adbe32010-12-17 08:56:44 +0100467 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200468
Eric Dumazet35f9c092012-04-05 03:05:35 +0000469 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000470
471 if (sd->len < sd->total_len && pipe->nrbufs > 1)
Eric Dumazet35f9c092012-04-05 03:05:35 +0000472 more |= MSG_SENDPAGE_NOTLAST;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000473
Michał Mirosława8adbe32010-12-17 08:56:44 +0100474 return file->f_op->sendpage(file, buf->page, buf->offset,
475 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200476}
477
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200478static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
479{
480 smp_mb();
481 if (waitqueue_active(&pipe->wait))
482 wake_up_interruptible(&pipe->wait);
483 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
484}
485
486/**
487 * splice_from_pipe_feed - feed available data from a pipe to a file
488 * @pipe: pipe to splice from
489 * @sd: information to @actor
490 * @actor: handler that splices the data
491 *
492 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200493 * This function loops over the pipe and calls @actor to do the
494 * actual moving of a single struct pipe_buffer to the desired
495 * destination. It returns when there's no more buffers left in
496 * the pipe or if the requested number of bytes (@sd->total_len)
497 * have been copied. It returns a positive number (one) if the
498 * pipe needs to be filled with more data, zero if the required
499 * number of bytes have been copied and -errno on error.
500 *
501 * This, together with splice_from_pipe_{begin,end,next}, may be
502 * used to implement the functionality of __splice_from_pipe() when
503 * locking is required around copying the pipe buffers to the
504 * destination.
505 */
Al Viro96f9bc82014-04-05 04:35:49 -0400506static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200507 splice_actor *actor)
508{
509 int ret;
510
511 while (pipe->nrbufs) {
512 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200513
514 sd->len = buf->len;
515 if (sd->len > sd->total_len)
516 sd->len = sd->total_len;
517
Miklos Szeredifba597d2016-09-27 10:45:12 +0200518 ret = pipe_buf_confirm(pipe, buf);
Michał Mirosława8adbe32010-12-17 08:56:44 +0100519 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200520 if (ret == -ENODATA)
521 ret = 0;
522 return ret;
523 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100524
525 ret = actor(pipe, buf, sd);
526 if (ret <= 0)
527 return ret;
528
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200529 buf->offset += ret;
530 buf->len -= ret;
531
532 sd->num_spliced += ret;
533 sd->len -= ret;
534 sd->pos += ret;
535 sd->total_len -= ret;
536
537 if (!buf->len) {
Miklos Szeredia7796382016-09-27 10:45:12 +0200538 pipe_buf_release(pipe, buf);
Jens Axboe35f3d142010-05-20 10:43:18 +0200539 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200540 pipe->nrbufs--;
Al Viro6447a3c2013-03-21 11:01:38 -0400541 if (pipe->files)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200542 sd->need_wakeup = true;
543 }
544
545 if (!sd->total_len)
546 return 0;
547 }
548
549 return 1;
550}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200551
552/**
553 * splice_from_pipe_next - wait for some data to splice from
554 * @pipe: pipe to splice from
555 * @sd: information about the splice operation
556 *
557 * Description:
558 * This function will wait for some data and return a positive
559 * value (one) if pipe buffers are available. It will return zero
560 * or -errno if no more data needs to be spliced.
561 */
Al Viro96f9bc82014-04-05 04:35:49 -0400562static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200563{
Jan Karac725bfc2015-11-23 13:09:50 +0100564 /*
565 * Check for signal early to make process killable when there are
566 * always buffers available
567 */
568 if (signal_pending(current))
569 return -ERESTARTSYS;
570
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200571 while (!pipe->nrbufs) {
572 if (!pipe->writers)
573 return 0;
574
575 if (!pipe->waiting_writers && sd->num_spliced)
576 return 0;
577
578 if (sd->flags & SPLICE_F_NONBLOCK)
579 return -EAGAIN;
580
581 if (signal_pending(current))
582 return -ERESTARTSYS;
583
584 if (sd->need_wakeup) {
585 wakeup_pipe_writers(pipe);
586 sd->need_wakeup = false;
587 }
588
589 pipe_wait(pipe);
590 }
591
592 return 1;
593}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200594
595/**
596 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700597 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200598 *
599 * Description:
600 * This function should be called before a loop containing
601 * splice_from_pipe_next() and splice_from_pipe_feed() to
602 * initialize the necessary fields of @sd.
603 */
Al Viro96f9bc82014-04-05 04:35:49 -0400604static void splice_from_pipe_begin(struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200605{
606 sd->num_spliced = 0;
607 sd->need_wakeup = false;
608}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200609
610/**
611 * splice_from_pipe_end - finish splicing from pipe
612 * @pipe: pipe to splice from
613 * @sd: information about the splice operation
614 *
615 * Description:
616 * This function will wake up pipe writers if necessary. It should
617 * be called after a loop containing splice_from_pipe_next() and
618 * splice_from_pipe_feed().
619 */
Al Viro96f9bc82014-04-05 04:35:49 -0400620static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200621{
622 if (sd->need_wakeup)
623 wakeup_pipe_writers(pipe);
624}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200625
Jens Axboe932cc6d2007-06-21 13:10:21 +0200626/**
627 * __splice_from_pipe - splice data from a pipe to given actor
628 * @pipe: pipe to splice from
629 * @sd: information to @actor
630 * @actor: handler that splices the data
631 *
632 * Description:
633 * This function does little more than loop over the pipe and call
634 * @actor to do the actual moving of a single struct pipe_buffer to
635 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
636 * pipe_to_user.
637 *
Jens Axboe83f91352006-04-02 23:05:09 +0200638 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200639ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
640 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200641{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200642 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200643
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200644 splice_from_pipe_begin(sd);
645 do {
Jan Karac2489e02015-11-23 13:09:51 +0100646 cond_resched();
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200647 ret = splice_from_pipe_next(pipe, sd);
648 if (ret > 0)
649 ret = splice_from_pipe_feed(pipe, sd, actor);
650 } while (ret > 0);
651 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200652
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200653 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200654}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100655EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200656
Jens Axboe932cc6d2007-06-21 13:10:21 +0200657/**
658 * splice_from_pipe - splice data from a pipe to a file
659 * @pipe: pipe to splice from
660 * @out: file to splice to
661 * @ppos: position in @out
662 * @len: how many bytes to splice
663 * @flags: splice modifier flags
664 * @actor: handler that splices the data
665 *
666 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200667 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200668 * otherwise it's identical to __splice_from_pipe().
669 *
670 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200671ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
672 loff_t *ppos, size_t len, unsigned int flags,
673 splice_actor *actor)
674{
675 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200676 struct splice_desc sd = {
677 .total_len = len,
678 .flags = flags,
679 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200680 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200681 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200682
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200683 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200684 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200685 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200686
687 return ret;
688}
689
690/**
Al Viro8d020762014-04-05 04:27:08 -0400691 * iter_file_splice_write - splice data from a pipe to a file
692 * @pipe: pipe info
693 * @out: file to write to
694 * @ppos: position in @out
695 * @len: number of bytes to splice
696 * @flags: splice modifier flags
697 *
698 * Description:
699 * Will either move or copy pages (determined by @flags options) from
700 * the given pipe inode to the given file.
701 * This one is ->write_iter-based.
702 *
703 */
704ssize_t
705iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
706 loff_t *ppos, size_t len, unsigned int flags)
707{
708 struct splice_desc sd = {
709 .total_len = len,
710 .flags = flags,
711 .pos = *ppos,
712 .u.file = out,
713 };
714 int nbufs = pipe->buffers;
715 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
716 GFP_KERNEL);
717 ssize_t ret;
718
719 if (unlikely(!array))
720 return -ENOMEM;
721
722 pipe_lock(pipe);
723
724 splice_from_pipe_begin(&sd);
725 while (sd.total_len) {
726 struct iov_iter from;
Al Viro8d020762014-04-05 04:27:08 -0400727 size_t left;
728 int n, idx;
729
730 ret = splice_from_pipe_next(pipe, &sd);
731 if (ret <= 0)
732 break;
733
734 if (unlikely(nbufs < pipe->buffers)) {
735 kfree(array);
736 nbufs = pipe->buffers;
737 array = kcalloc(nbufs, sizeof(struct bio_vec),
738 GFP_KERNEL);
739 if (!array) {
740 ret = -ENOMEM;
741 break;
742 }
743 }
744
745 /* build the vector */
746 left = sd.total_len;
747 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
748 struct pipe_buffer *buf = pipe->bufs + idx;
749 size_t this_len = buf->len;
750
751 if (this_len > left)
752 this_len = left;
753
754 if (idx == pipe->buffers - 1)
755 idx = -1;
756
Miklos Szeredifba597d2016-09-27 10:45:12 +0200757 ret = pipe_buf_confirm(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400758 if (unlikely(ret)) {
759 if (ret == -ENODATA)
760 ret = 0;
761 goto done;
762 }
763
764 array[n].bv_page = buf->page;
765 array[n].bv_len = this_len;
766 array[n].bv_offset = buf->offset;
767 left -= this_len;
768 }
769
Al Viro05afcb72015-01-23 01:08:07 -0500770 iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
771 sd.total_len - left);
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100772 ret = vfs_iter_write(out, &from, &sd.pos);
Al Viro8d020762014-04-05 04:27:08 -0400773 if (ret <= 0)
774 break;
775
776 sd.num_spliced += ret;
777 sd.total_len -= ret;
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100778 *ppos = sd.pos;
Al Viro8d020762014-04-05 04:27:08 -0400779
780 /* dismiss the fully eaten buffers, adjust the partial one */
781 while (ret) {
782 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
783 if (ret >= buf->len) {
Al Viro8d020762014-04-05 04:27:08 -0400784 ret -= buf->len;
785 buf->len = 0;
Miklos Szeredia7796382016-09-27 10:45:12 +0200786 pipe_buf_release(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400787 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
788 pipe->nrbufs--;
789 if (pipe->files)
790 sd.need_wakeup = true;
791 } else {
792 buf->offset += ret;
793 buf->len -= ret;
794 ret = 0;
795 }
796 }
797 }
798done:
799 kfree(array);
800 splice_from_pipe_end(pipe, &sd);
801
802 pipe_unlock(pipe);
803
804 if (sd.num_spliced)
805 ret = sd.num_spliced;
806
807 return ret;
808}
809
810EXPORT_SYMBOL(iter_file_splice_write);
811
Miklos Szeredib2858d72009-05-19 11:37:46 +0200812static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
813 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200814{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200815 int ret;
816 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -0400817 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +0200818
Al Virofbb32752014-02-02 21:09:54 -0500819 data = kmap(buf->page);
Al Viro06ae43f2013-03-20 13:19:30 -0400820 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Al Virofbb32752014-02-02 21:09:54 -0500821 kunmap(buf->page);
Miklos Szeredib2858d72009-05-19 11:37:46 +0200822
823 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200824}
825
826static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
827 struct file *out, loff_t *ppos,
828 size_t len, unsigned int flags)
829{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200830 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200831
Miklos Szeredib2858d72009-05-19 11:37:46 +0200832 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
833 if (ret > 0)
834 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200835
Miklos Szeredib2858d72009-05-19 11:37:46 +0200836 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200837}
838
Jens Axboe83f91352006-04-02 23:05:09 +0200839/**
840 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200841 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200842 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200843 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200844 * @len: number of bytes to splice
845 * @flags: splice modifier flags
846 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200847 * Description:
848 * Will send @len bytes from the pipe to a network socket. No data copying
849 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200850 *
851 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200852ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200853 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200854{
Jens Axboe00522fb2006-04-26 14:39:29 +0200855 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200856}
857
Jens Axboe059a8f32006-04-02 23:06:05 +0200858EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500859
Jens Axboe83f91352006-04-02 23:05:09 +0200860/*
861 * Attempt to initiate a splice from pipe to file.
862 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200863static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200864 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200865{
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200866 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
867 loff_t *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200868
Al Viro72c2d532013-09-22 16:27:52 -0400869 if (out->f_op->splice_write)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100870 splice_write = out->f_op->splice_write;
871 else
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200872 splice_write = default_file_splice_write;
873
Al Viro500368f2013-05-23 20:07:11 -0400874 return splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200875}
876
Jens Axboe83f91352006-04-02 23:05:09 +0200877/*
878 * Attempt to initiate a splice from a file to a pipe.
879 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200880static long do_splice_to(struct file *in, loff_t *ppos,
881 struct pipe_inode_info *pipe, size_t len,
882 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200883{
Miklos Szeredi68181732009-05-07 15:37:36 +0200884 ssize_t (*splice_read)(struct file *, loff_t *,
885 struct pipe_inode_info *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200886 int ret;
887
Jens Axboe49570e92006-04-11 13:56:09 +0200888 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200889 return -EBADF;
890
Jens Axboecbb7e572006-04-11 14:57:50 +0200891 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200892 if (unlikely(ret < 0))
893 return ret;
894
Al Viro03cc0782016-04-02 14:56:58 -0400895 if (unlikely(len > MAX_RW_COUNT))
896 len = MAX_RW_COUNT;
897
Al Viro72c2d532013-09-22 16:27:52 -0400898 if (in->f_op->splice_read)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100899 splice_read = in->f_op->splice_read;
900 else
Miklos Szeredi68181732009-05-07 15:37:36 +0200901 splice_read = default_file_splice_read;
902
903 return splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200904}
905
Jens Axboe932cc6d2007-06-21 13:10:21 +0200906/**
907 * splice_direct_to_actor - splices data directly between two non-pipes
908 * @in: file to splice from
909 * @sd: actor information on where to splice to
910 * @actor: handles the data splicing
911 *
912 * Description:
913 * This is a special case helper to splice directly between two
914 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200915 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200916 * that process.
917 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200918 */
919ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
920 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200921{
922 struct pipe_inode_info *pipe;
923 long ret, bytes;
924 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200925 size_t len;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200926 int i, flags, more;
Jens Axboeb92ce552006-04-11 13:52:07 +0200927
928 /*
929 * We require the input being a regular file, as we don't want to
930 * randomly drop data for eg socket -> socket splicing. Use the
931 * piped splicing for that!
932 */
Al Viro496ad9a2013-01-23 17:07:38 -0500933 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200934 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
935 return -EINVAL;
936
937 /*
938 * neither in nor out is a pipe, setup an internal pipe attached to
939 * 'out' and transfer the wanted data from 'in' to 'out' through that
940 */
941 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200942 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -0400943 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +0200944 if (!pipe)
945 return -ENOMEM;
946
947 /*
948 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200949 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200950 * PIPE_READERS appropriately.
951 */
952 pipe->readers = 1;
953
954 current->splice_pipe = pipe;
955 }
956
957 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200958 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200959 */
960 ret = 0;
961 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200962 len = sd->total_len;
963 flags = sd->flags;
964
965 /*
966 * Don't block on output, we have to drain the direct pipe.
967 */
968 sd->flags &= ~SPLICE_F_NONBLOCK;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200969 more = sd->flags & SPLICE_F_MORE;
Jens Axboeb92ce552006-04-11 13:52:07 +0200970
971 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +0200972 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200973 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200974
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200975 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200976 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +0200977 goto out_release;
978
979 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200980 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +0200981
982 /*
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200983 * If more data is pending, set SPLICE_F_MORE
984 * If this is the last data and SPLICE_F_MORE was not set
985 * initially, clears it.
986 */
987 if (read_len < len)
988 sd->flags |= SPLICE_F_MORE;
989 else if (!more)
990 sd->flags &= ~SPLICE_F_MORE;
991 /*
Jens Axboeb92ce552006-04-11 13:52:07 +0200992 * NOTE: nonblocking mode only applies to the input. We
993 * must not do the output in nonblocking mode as then we
994 * could get stuck data in the internal pipe:
995 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200996 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +0200997 if (unlikely(ret <= 0)) {
998 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200999 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001000 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001001
1002 bytes += ret;
1003 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +02001004 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001005
Tom Zanussia82c53a2008-05-09 13:28:36 +02001006 if (ret < read_len) {
1007 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001008 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001009 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001010 }
1011
Jens Axboe9e971982008-01-29 21:05:57 +01001012done:
Jens Axboeb92ce552006-04-11 13:52:07 +02001013 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001014 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001015 return bytes;
1016
1017out_release:
1018 /*
1019 * If we did an incomplete transfer we must release
1020 * the pipe buffers in question:
1021 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001022 for (i = 0; i < pipe->buffers; i++) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001023 struct pipe_buffer *buf = pipe->bufs + i;
1024
Miklos Szeredia7796382016-09-27 10:45:12 +02001025 if (buf->ops)
1026 pipe_buf_release(pipe, buf);
Jens Axboeb92ce552006-04-11 13:52:07 +02001027 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001028
Jens Axboe9e971982008-01-29 21:05:57 +01001029 if (!bytes)
1030 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001031
Jens Axboe9e971982008-01-29 21:05:57 +01001032 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001033}
1034EXPORT_SYMBOL(splice_direct_to_actor);
1035
1036static int direct_splice_actor(struct pipe_inode_info *pipe,
1037 struct splice_desc *sd)
1038{
Jens Axboe6a14b902007-06-14 13:08:55 +02001039 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001040
Al Viro7995bd22013-06-20 18:58:36 +04001041 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001042 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001043}
1044
Jens Axboe932cc6d2007-06-21 13:10:21 +02001045/**
1046 * do_splice_direct - splices data directly between two files
1047 * @in: file to splice from
1048 * @ppos: input file offset
1049 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001050 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001051 * @len: number of bytes to splice
1052 * @flags: splice modifier flags
1053 *
1054 * Description:
1055 * For use by do_sendfile(). splice can easily emulate sendfile, but
1056 * doing it in the application would incur an extra system call
1057 * (splice in + splice out, as compared to just sendfile()). So this helper
1058 * can splice directly through a process-private pipe.
1059 *
1060 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001061long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001062 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001063{
1064 struct splice_desc sd = {
1065 .len = len,
1066 .total_len = len,
1067 .flags = flags,
1068 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001069 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001070 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001071 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001072 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001073
Al Viro18c67cb2013-06-19 15:41:54 +04001074 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1075 return -EBADF;
1076
1077 if (unlikely(out->f_flags & O_APPEND))
1078 return -EINVAL;
1079
1080 ret = rw_verify_area(WRITE, out, opos, len);
1081 if (unlikely(ret < 0))
1082 return ret;
1083
Jens Axboec66ab6f2007-06-12 21:17:17 +02001084 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001085 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001086 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001087
Jens Axboec66ab6f2007-06-12 21:17:17 +02001088 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001089}
Miklos Szeredi1c118592014-10-24 00:14:35 +02001090EXPORT_SYMBOL(do_splice_direct);
Jens Axboeb92ce552006-04-11 13:52:07 +02001091
Al Viro8924fef2016-09-17 20:44:45 -04001092static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1093{
1094 while (pipe->nrbufs == pipe->buffers) {
1095 if (flags & SPLICE_F_NONBLOCK)
1096 return -EAGAIN;
1097 if (signal_pending(current))
1098 return -ERESTARTSYS;
1099 pipe->waiting_writers++;
1100 pipe_wait(pipe);
1101 pipe->waiting_writers--;
1102 }
1103 return 0;
1104}
1105
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001106static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1107 struct pipe_inode_info *opipe,
1108 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001109
1110/*
Jens Axboe83f91352006-04-02 23:05:09 +02001111 * Determine where to splice to/from.
1112 */
Ingo Molnar529565dc2006-04-10 15:18:58 +02001113static long do_splice(struct file *in, loff_t __user *off_in,
1114 struct file *out, loff_t __user *off_out,
1115 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001116{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001117 struct pipe_inode_info *ipipe;
1118 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001119 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001120 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001121
Linus Torvalds71993e62010-11-28 13:56:09 -08001122 ipipe = get_pipe_info(in);
1123 opipe = get_pipe_info(out);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001124
1125 if (ipipe && opipe) {
1126 if (off_in || off_out)
1127 return -ESPIPE;
1128
1129 if (!(in->f_mode & FMODE_READ))
1130 return -EBADF;
1131
1132 if (!(out->f_mode & FMODE_WRITE))
1133 return -EBADF;
1134
1135 /* Splicing to self would be fun, but... */
1136 if (ipipe == opipe)
1137 return -EINVAL;
1138
1139 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1140 }
1141
1142 if (ipipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001143 if (off_in)
1144 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001145 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001146 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001147 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001148 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001149 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001150 } else {
1151 offset = out->f_pos;
1152 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001153
Al Viro18c67cb2013-06-19 15:41:54 +04001154 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1155 return -EBADF;
1156
1157 if (unlikely(out->f_flags & O_APPEND))
1158 return -EINVAL;
1159
1160 ret = rw_verify_area(WRITE, out, &offset, len);
1161 if (unlikely(ret < 0))
1162 return ret;
1163
Al Viro500368f2013-05-23 20:07:11 -04001164 file_start_write(out);
Al Viro7995bd22013-06-20 18:58:36 +04001165 ret = do_splice_from(ipipe, out, &offset, len, flags);
Al Viro500368f2013-05-23 20:07:11 -04001166 file_end_write(out);
Jens Axboea4514eb2006-04-19 15:57:05 +02001167
Al Viro7995bd22013-06-20 18:58:36 +04001168 if (!off_out)
1169 out->f_pos = offset;
1170 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001171 ret = -EFAULT;
1172
1173 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001174 }
Jens Axboe5274f052006-03-30 15:15:30 +02001175
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001176 if (opipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001177 if (off_out)
1178 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001179 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001180 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001181 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001182 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001183 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001184 } else {
1185 offset = in->f_pos;
1186 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001187
Al Viro8924fef2016-09-17 20:44:45 -04001188 pipe_lock(opipe);
1189 ret = wait_for_space(opipe, flags);
1190 if (!ret)
1191 ret = do_splice_to(in, &offset, opipe, len, flags);
1192 pipe_unlock(opipe);
1193 if (ret > 0)
1194 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001195 if (!off_in)
1196 in->f_pos = offset;
1197 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001198 ret = -EFAULT;
1199
1200 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001201 }
Jens Axboe5274f052006-03-30 15:15:30 +02001202
1203 return -EINVAL;
1204}
1205
Al Viro79fddc42016-09-17 22:38:20 -04001206static int iter_to_pipe(struct iov_iter *from,
1207 struct pipe_inode_info *pipe,
1208 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001209{
Al Viro79fddc42016-09-17 22:38:20 -04001210 struct pipe_buffer buf = {
1211 .ops = &user_page_pipe_buf_ops,
1212 .flags = flags
1213 };
1214 size_t total = 0;
1215 int ret = 0;
1216 bool failed = false;
1217
1218 while (iov_iter_count(from) && !failed) {
1219 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001220 ssize_t copied;
1221 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001222 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001223
Al Viro79fddc42016-09-17 22:38:20 -04001224 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1225 if (copied <= 0) {
1226 ret = copied;
1227 break;
1228 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001229
Al Viro79fddc42016-09-17 22:38:20 -04001230 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001231 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001232 if (!failed) {
1233 buf.page = pages[n];
1234 buf.offset = start;
1235 buf.len = size;
1236 ret = add_to_pipe(pipe, &buf);
1237 if (unlikely(ret < 0)) {
1238 failed = true;
1239 } else {
1240 iov_iter_advance(from, ret);
1241 total += ret;
1242 }
1243 } else {
1244 put_page(pages[n]);
1245 }
Al Virodb85a9e2016-09-17 20:25:06 -04001246 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001247 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001248 }
Al Viro79fddc42016-09-17 22:38:20 -04001249 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001250}
1251
Jens Axboe6a14b902007-06-14 13:08:55 +02001252static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1253 struct splice_desc *sd)
1254{
Al Viro6130f532014-02-03 18:19:51 -05001255 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1256 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001257}
1258
1259/*
1260 * For lack of a better implementation, implement vmsplice() to userspace
1261 * as a simple copy of the pipes pages to the user iov.
1262 */
Al Viro6130f532014-02-03 18:19:51 -05001263static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001264 unsigned long nr_segs, unsigned int flags)
1265{
1266 struct pipe_inode_info *pipe;
1267 struct splice_desc sd;
Jens Axboe6a14b902007-06-14 13:08:55 +02001268 long ret;
Al Viro6130f532014-02-03 18:19:51 -05001269 struct iovec iovstack[UIO_FASTIOV];
1270 struct iovec *iov = iovstack;
1271 struct iov_iter iter;
Jens Axboe6a14b902007-06-14 13:08:55 +02001272
Linus Torvalds71993e62010-11-28 13:56:09 -08001273 pipe = get_pipe_info(file);
Jens Axboe6a14b902007-06-14 13:08:55 +02001274 if (!pipe)
1275 return -EBADF;
1276
Al Viro345995f2015-03-21 19:17:55 -04001277 ret = import_iovec(READ, uiov, nr_segs,
1278 ARRAY_SIZE(iovstack), &iov, &iter);
1279 if (ret < 0)
1280 return ret;
Al Viro6130f532014-02-03 18:19:51 -05001281
Al Viro345995f2015-03-21 19:17:55 -04001282 sd.total_len = iov_iter_count(&iter);
Al Viro6130f532014-02-03 18:19:51 -05001283 sd.len = 0;
Al Viro6130f532014-02-03 18:19:51 -05001284 sd.flags = flags;
1285 sd.u.data = &iter;
1286 sd.pos = 0;
1287
Al Viro345995f2015-03-21 19:17:55 -04001288 if (sd.total_len) {
1289 pipe_lock(pipe);
1290 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1291 pipe_unlock(pipe);
1292 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001293
Al Viro345995f2015-03-21 19:17:55 -04001294 kfree(iov);
Jens Axboe6a14b902007-06-14 13:08:55 +02001295 return ret;
1296}
1297
Jens Axboe912d35f2006-04-26 10:59:21 +02001298/*
1299 * vmsplice splices a user address range into a pipe. It can be thought of
1300 * as splice-from-memory, where the regular splice is splice-from-file (or
1301 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001302 */
Al Virodb85a9e2016-09-17 20:25:06 -04001303static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001304 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001305{
Jens Axboeddac0d32006-11-04 12:49:32 +01001306 struct pipe_inode_info *pipe;
Al Virodb85a9e2016-09-17 20:25:06 -04001307 struct iovec iovstack[UIO_FASTIOV];
1308 struct iovec *iov = iovstack;
1309 struct iov_iter from;
Jens Axboe35f3d142010-05-20 10:43:18 +02001310 long ret;
Al Viro79fddc42016-09-17 22:38:20 -04001311 unsigned buf_flag = 0;
1312
1313 if (flags & SPLICE_F_GIFT)
1314 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001315
Linus Torvalds71993e62010-11-28 13:56:09 -08001316 pipe = get_pipe_info(file);
Jens Axboeddac0d32006-11-04 12:49:32 +01001317 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001318 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001319
Al Virodb85a9e2016-09-17 20:25:06 -04001320 ret = import_iovec(WRITE, uiov, nr_segs,
1321 ARRAY_SIZE(iovstack), &iov, &from);
1322 if (ret < 0)
1323 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001324
Al Viro8924fef2016-09-17 20:44:45 -04001325 pipe_lock(pipe);
1326 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001327 if (!ret)
1328 ret = iter_to_pipe(&from, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001329 pipe_unlock(pipe);
1330 if (ret > 0)
1331 wakeup_pipe_readers(pipe);
Al Virodb85a9e2016-09-17 20:25:06 -04001332 kfree(iov);
Jens Axboe35f3d142010-05-20 10:43:18 +02001333 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001334}
1335
Jens Axboe6a14b902007-06-14 13:08:55 +02001336/*
1337 * Note that vmsplice only really supports true splicing _from_ user memory
1338 * to a pipe, not the other way around. Splicing from user memory is a simple
1339 * operation that can be supported without any funky alignment restrictions
1340 * or nasty vm tricks. We simply map in the user memory and fill them into
1341 * a pipe. The reverse isn't quite as easy, though. There are two possible
1342 * solutions for that:
1343 *
1344 * - memcpy() the data internally, at which point we might as well just
1345 * do a regular read() on the buffer anyway.
1346 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1347 * has restriction limitations on both ends of the pipe).
1348 *
1349 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1350 *
1351 */
Heiko Carstens836f92a2009-01-14 14:14:33 +01001352SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1353 unsigned long, nr_segs, unsigned int, flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001354{
Al Viro2903ff02012-08-28 12:52:22 -04001355 struct fd f;
Jens Axboe912d35f2006-04-26 10:59:21 +02001356 long error;
Jens Axboe912d35f2006-04-26 10:59:21 +02001357
Jens Axboe6a14b902007-06-14 13:08:55 +02001358 if (unlikely(nr_segs > UIO_MAXIOV))
1359 return -EINVAL;
1360 else if (unlikely(!nr_segs))
1361 return 0;
1362
Jens Axboe912d35f2006-04-26 10:59:21 +02001363 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001364 f = fdget(fd);
1365 if (f.file) {
1366 if (f.file->f_mode & FMODE_WRITE)
1367 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1368 else if (f.file->f_mode & FMODE_READ)
1369 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001370
Al Viro2903ff02012-08-28 12:52:22 -04001371 fdput(f);
Jens Axboe912d35f2006-04-26 10:59:21 +02001372 }
1373
1374 return error;
1375}
1376
Al Viro76b021d2013-03-02 10:19:56 -05001377#ifdef CONFIG_COMPAT
1378COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1379 unsigned int, nr_segs, unsigned int, flags)
1380{
1381 unsigned i;
1382 struct iovec __user *iov;
1383 if (nr_segs > UIO_MAXIOV)
1384 return -EINVAL;
1385 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1386 for (i = 0; i < nr_segs; i++) {
1387 struct compat_iovec v;
1388 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1389 get_user(v.iov_len, &iov32[i].iov_len) ||
1390 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1391 put_user(v.iov_len, &iov[i].iov_len))
1392 return -EFAULT;
1393 }
1394 return sys_vmsplice(fd, iov, nr_segs, flags);
1395}
1396#endif
1397
Heiko Carstens836f92a2009-01-14 14:14:33 +01001398SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1399 int, fd_out, loff_t __user *, off_out,
1400 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001401{
Al Viro2903ff02012-08-28 12:52:22 -04001402 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001403 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001404
1405 if (unlikely(!len))
1406 return 0;
1407
1408 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001409 in = fdget(fd_in);
1410 if (in.file) {
1411 if (in.file->f_mode & FMODE_READ) {
1412 out = fdget(fd_out);
1413 if (out.file) {
1414 if (out.file->f_mode & FMODE_WRITE)
1415 error = do_splice(in.file, off_in,
1416 out.file, off_out,
Ingo Molnar529565dc2006-04-10 15:18:58 +02001417 len, flags);
Al Viro2903ff02012-08-28 12:52:22 -04001418 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001419 }
1420 }
Al Viro2903ff02012-08-28 12:52:22 -04001421 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001422 }
Jens Axboe5274f052006-03-30 15:15:30 +02001423 return error;
1424}
Jens Axboe70524492006-04-11 15:51:17 +02001425
1426/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001427 * Make sure there's data to read. Wait for input if we can, otherwise
1428 * return an appropriate error.
1429 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001430static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001431{
1432 int ret;
1433
1434 /*
1435 * Check ->nrbufs without the inode lock first. This function
1436 * is speculative anyways, so missing one is ok.
1437 */
1438 if (pipe->nrbufs)
1439 return 0;
1440
1441 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001442 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001443
1444 while (!pipe->nrbufs) {
1445 if (signal_pending(current)) {
1446 ret = -ERESTARTSYS;
1447 break;
1448 }
1449 if (!pipe->writers)
1450 break;
1451 if (!pipe->waiting_writers) {
1452 if (flags & SPLICE_F_NONBLOCK) {
1453 ret = -EAGAIN;
1454 break;
1455 }
1456 }
1457 pipe_wait(pipe);
1458 }
1459
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001460 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001461 return ret;
1462}
1463
1464/*
1465 * Make sure there's writeable room. Wait for room if we can, otherwise
1466 * return an appropriate error.
1467 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001468static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001469{
1470 int ret;
1471
1472 /*
1473 * Check ->nrbufs without the inode lock first. This function
1474 * is speculative anyways, so missing one is ok.
1475 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001476 if (pipe->nrbufs < pipe->buffers)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001477 return 0;
1478
1479 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001480 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001481
Jens Axboe35f3d142010-05-20 10:43:18 +02001482 while (pipe->nrbufs >= pipe->buffers) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001483 if (!pipe->readers) {
1484 send_sig(SIGPIPE, current, 0);
1485 ret = -EPIPE;
1486 break;
1487 }
1488 if (flags & SPLICE_F_NONBLOCK) {
1489 ret = -EAGAIN;
1490 break;
1491 }
1492 if (signal_pending(current)) {
1493 ret = -ERESTARTSYS;
1494 break;
1495 }
1496 pipe->waiting_writers++;
1497 pipe_wait(pipe);
1498 pipe->waiting_writers--;
1499 }
1500
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001501 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001502 return ret;
1503}
1504
1505/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001506 * Splice contents of ipipe to opipe.
1507 */
1508static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1509 struct pipe_inode_info *opipe,
1510 size_t len, unsigned int flags)
1511{
1512 struct pipe_buffer *ibuf, *obuf;
1513 int ret = 0, nbuf;
1514 bool input_wakeup = false;
1515
1516
1517retry:
1518 ret = ipipe_prep(ipipe, flags);
1519 if (ret)
1520 return ret;
1521
1522 ret = opipe_prep(opipe, flags);
1523 if (ret)
1524 return ret;
1525
1526 /*
1527 * Potential ABBA deadlock, work around it by ordering lock
1528 * grabbing by pipe info address. Otherwise two different processes
1529 * could deadlock (one doing tee from A -> B, the other from B -> A).
1530 */
1531 pipe_double_lock(ipipe, opipe);
1532
1533 do {
1534 if (!opipe->readers) {
1535 send_sig(SIGPIPE, current, 0);
1536 if (!ret)
1537 ret = -EPIPE;
1538 break;
1539 }
1540
1541 if (!ipipe->nrbufs && !ipipe->writers)
1542 break;
1543
1544 /*
1545 * Cannot make any progress, because either the input
1546 * pipe is empty or the output pipe is full.
1547 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001548 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001549 /* Already processed some buffers, break */
1550 if (ret)
1551 break;
1552
1553 if (flags & SPLICE_F_NONBLOCK) {
1554 ret = -EAGAIN;
1555 break;
1556 }
1557
1558 /*
1559 * We raced with another reader/writer and haven't
1560 * managed to process any buffers. A zero return
1561 * value means EOF, so retry instead.
1562 */
1563 pipe_unlock(ipipe);
1564 pipe_unlock(opipe);
1565 goto retry;
1566 }
1567
1568 ibuf = ipipe->bufs + ipipe->curbuf;
Jens Axboe35f3d142010-05-20 10:43:18 +02001569 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001570 obuf = opipe->bufs + nbuf;
1571
1572 if (len >= ibuf->len) {
1573 /*
1574 * Simply move the whole buffer from ipipe to opipe
1575 */
1576 *obuf = *ibuf;
1577 ibuf->ops = NULL;
1578 opipe->nrbufs++;
Jens Axboe35f3d142010-05-20 10:43:18 +02001579 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001580 ipipe->nrbufs--;
1581 input_wakeup = true;
1582 } else {
1583 /*
1584 * Get a reference to this pipe buffer,
1585 * so we can copy the contents over.
1586 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001587 pipe_buf_get(ipipe, ibuf);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001588 *obuf = *ibuf;
1589
1590 /*
1591 * Don't inherit the gift flag, we need to
1592 * prevent multiple steals of this page.
1593 */
1594 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1595
1596 obuf->len = len;
1597 opipe->nrbufs++;
1598 ibuf->offset += obuf->len;
1599 ibuf->len -= obuf->len;
1600 }
1601 ret += obuf->len;
1602 len -= obuf->len;
1603 } while (len);
1604
1605 pipe_unlock(ipipe);
1606 pipe_unlock(opipe);
1607
1608 /*
1609 * If we put data in the output pipe, wakeup any potential readers.
1610 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001611 if (ret > 0)
1612 wakeup_pipe_readers(opipe);
1613
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001614 if (input_wakeup)
1615 wakeup_pipe_writers(ipipe);
1616
1617 return ret;
1618}
1619
1620/*
Jens Axboe70524492006-04-11 15:51:17 +02001621 * Link contents of ipipe to opipe.
1622 */
1623static int link_pipe(struct pipe_inode_info *ipipe,
1624 struct pipe_inode_info *opipe,
1625 size_t len, unsigned int flags)
1626{
1627 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001628 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001629
1630 /*
1631 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001632 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001633 * could deadlock (one doing tee from A -> B, the other from B -> A).
1634 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001635 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001636
Jens Axboeaadd06e2006-07-10 11:00:01 +02001637 do {
Jens Axboe70524492006-04-11 15:51:17 +02001638 if (!opipe->readers) {
1639 send_sig(SIGPIPE, current, 0);
1640 if (!ret)
1641 ret = -EPIPE;
1642 break;
1643 }
Jens Axboe70524492006-04-11 15:51:17 +02001644
1645 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001646 * If we have iterated all input buffers or ran out of
1647 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001648 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001649 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
Jens Axboe70524492006-04-11 15:51:17 +02001650 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001651
Jens Axboe35f3d142010-05-20 10:43:18 +02001652 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1653 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001654
Jens Axboe2a27250e2006-04-19 15:56:40 +02001655 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001656 * Get a reference to this pipe buffer,
1657 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001658 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001659 pipe_buf_get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001660
Jens Axboeaadd06e2006-07-10 11:00:01 +02001661 obuf = opipe->bufs + nbuf;
1662 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001663
Jens Axboeaadd06e2006-07-10 11:00:01 +02001664 /*
1665 * Don't inherit the gift flag, we need to
1666 * prevent multiple steals of this page.
1667 */
1668 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1669
1670 if (obuf->len > len)
1671 obuf->len = len;
1672
1673 opipe->nrbufs++;
1674 ret += obuf->len;
1675 len -= obuf->len;
1676 i++;
1677 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001678
Jens Axboe02cf01a2008-02-20 10:34:51 +01001679 /*
1680 * return EAGAIN if we have the potential of some data in the
1681 * future, otherwise just return 0
1682 */
1683 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1684 ret = -EAGAIN;
1685
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001686 pipe_unlock(ipipe);
1687 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001688
Jens Axboeaadd06e2006-07-10 11:00:01 +02001689 /*
1690 * If we put data in the output pipe, wakeup any potential readers.
1691 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001692 if (ret > 0)
1693 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001694
1695 return ret;
1696}
1697
1698/*
1699 * This is a tee(1) implementation that works on pipes. It doesn't copy
1700 * any data, it simply references the 'in' pages on the 'out' pipe.
1701 * The 'flags' used are the SPLICE_F_* variants, currently the only
1702 * applicable one is SPLICE_F_NONBLOCK.
1703 */
1704static long do_tee(struct file *in, struct file *out, size_t len,
1705 unsigned int flags)
1706{
Linus Torvalds71993e62010-11-28 13:56:09 -08001707 struct pipe_inode_info *ipipe = get_pipe_info(in);
1708 struct pipe_inode_info *opipe = get_pipe_info(out);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001709 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001710
1711 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001712 * Duplicate the contents of ipipe to opipe without actually
1713 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001714 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001715 if (ipipe && opipe && ipipe != opipe) {
1716 /*
1717 * Keep going, unless we encounter an error. The ipipe/opipe
1718 * ordering doesn't really matter.
1719 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001720 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001721 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001722 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001723 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001724 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001725 }
1726 }
Jens Axboe70524492006-04-11 15:51:17 +02001727
Jens Axboeaadd06e2006-07-10 11:00:01 +02001728 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001729}
1730
Heiko Carstens836f92a2009-01-14 14:14:33 +01001731SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001732{
Al Viro2903ff02012-08-28 12:52:22 -04001733 struct fd in;
1734 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001735
1736 if (unlikely(!len))
1737 return 0;
1738
1739 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001740 in = fdget(fdin);
1741 if (in.file) {
1742 if (in.file->f_mode & FMODE_READ) {
1743 struct fd out = fdget(fdout);
1744 if (out.file) {
1745 if (out.file->f_mode & FMODE_WRITE)
1746 error = do_tee(in.file, out.file,
1747 len, flags);
1748 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001749 }
1750 }
Al Viro2903ff02012-08-28 12:52:22 -04001751 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001752 }
1753
1754 return error;
1755}