blob: 1af65632c371fa27407fc556812d105a336681d7 [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
Jens Axboe35f3d142010-05-20 10:43:18 +0200247/*
248 * Check if we need to grow the arrays holding pages and partial page
249 * descriptions.
250 */
Eric Dumazet047fe362012-06-12 15:24:40 +0200251int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200252{
Eric Dumazet047fe362012-06-12 15:24:40 +0200253 unsigned int buffers = ACCESS_ONCE(pipe->buffers);
254
255 spd->nr_pages_max = buffers;
256 if (buffers <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200257 return 0;
258
Eric Dumazet047fe362012-06-12 15:24:40 +0200259 spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
260 spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200261
262 if (spd->pages && spd->partial)
263 return 0;
264
265 kfree(spd->pages);
266 kfree(spd->partial);
267 return -ENOMEM;
268}
269
Eric Dumazet047fe362012-06-12 15:24:40 +0200270void splice_shrink_spd(struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200271{
Eric Dumazet047fe362012-06-12 15:24:40 +0200272 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200273 return;
274
275 kfree(spd->pages);
276 kfree(spd->partial);
277}
278
Jens Axboe83f91352006-04-02 23:05:09 +0200279/**
280 * generic_file_splice_read - splice data from file to a pipe
281 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200282 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200283 * @pipe: pipe to splice to
284 * @len: number of bytes to splice
285 * @flags: splice modifier flags
286 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200287 * Description:
288 * Will read pages from given file and fill them into a pipe. Can be
Al Viro82c156f2016-09-22 23:35:42 -0400289 * used as long as it has more or less sane ->read_iter().
Jens Axboe932cc6d2007-06-21 13:10:21 +0200290 *
Jens Axboe83f91352006-04-02 23:05:09 +0200291 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200292ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
293 struct pipe_inode_info *pipe, size_t len,
294 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200295{
Al Viro82c156f2016-09-22 23:35:42 -0400296 struct iov_iter to;
297 struct kiocb kiocb;
Al Viro82c156f2016-09-22 23:35:42 -0400298 int idx, ret;
Boaz Harroshbe64f882015-04-15 16:15:17 -0700299
Al Viro82c156f2016-09-22 23:35:42 -0400300 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len);
301 idx = to.idx;
302 init_sync_kiocb(&kiocb, in);
303 kiocb.ki_pos = *ppos;
304 ret = in->f_op->read_iter(&kiocb, &to);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200305 if (ret > 0) {
Al Viro82c156f2016-09-22 23:35:42 -0400306 *ppos = kiocb.ki_pos;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200307 file_accessed(in);
Al Viro82c156f2016-09-22 23:35:42 -0400308 } else if (ret < 0) {
Al Viroc3a69022016-10-10 13:26:27 -0400309 to.idx = idx;
310 to.iov_offset = 0;
311 iov_iter_advance(&to, 0); /* to free what was emitted */
Al Viro82c156f2016-09-22 23:35:42 -0400312 /*
313 * callers of ->splice_read() expect -EAGAIN on
314 * "can't put anything in there", rather than -EFAULT.
315 */
316 if (ret == -EFAULT)
317 ret = -EAGAIN;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200318 }
Jens Axboe5274f052006-03-30 15:15:30 +0200319
320 return ret;
321}
Jens Axboe059a8f32006-04-02 23:06:05 +0200322EXPORT_SYMBOL(generic_file_splice_read);
323
Al Viro241699c2016-09-22 16:33:12 -0400324const struct pipe_buf_operations default_pipe_buf_ops = {
Miklos Szeredi68181732009-05-07 15:37:36 +0200325 .can_merge = 0,
Miklos Szeredi68181732009-05-07 15:37:36 +0200326 .confirm = generic_pipe_buf_confirm,
327 .release = generic_pipe_buf_release,
328 .steal = generic_pipe_buf_steal,
329 .get = generic_pipe_buf_get,
330};
331
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100332static int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
333 struct pipe_buffer *buf)
334{
335 return 1;
336}
337
338/* Pipe buffer operations for a socket and similar. */
339const struct pipe_buf_operations nosteal_pipe_buf_ops = {
340 .can_merge = 0,
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100341 .confirm = generic_pipe_buf_confirm,
342 .release = generic_pipe_buf_release,
343 .steal = generic_pipe_buf_nosteal,
344 .get = generic_pipe_buf_get,
345};
346EXPORT_SYMBOL(nosteal_pipe_buf_ops);
347
Al Viro523ac9a2016-09-23 15:34:57 -0400348static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
Miklos Szeredi68181732009-05-07 15:37:36 +0200349 unsigned long vlen, loff_t offset)
350{
351 mm_segment_t old_fs;
352 loff_t pos = offset;
353 ssize_t res;
354
355 old_fs = get_fs();
356 set_fs(get_ds());
357 /* The cast to a user pointer is valid due to the set_fs() */
Christoph Hellwig793b80e2016-03-03 16:03:58 +0100358 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
Miklos Szeredi68181732009-05-07 15:37:36 +0200359 set_fs(old_fs);
360
361 return res;
362}
363
Al Viro7bb307e2013-02-23 14:51:48 -0500364ssize_t kernel_write(struct file *file, const char *buf, size_t count,
Miklos Szeredib2858d72009-05-19 11:37:46 +0200365 loff_t pos)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200366{
367 mm_segment_t old_fs;
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() */
Al Viro7bb307e2013-02-23 14:51:48 -0500373 res = vfs_write(file, (__force const char __user *)buf, count, &pos);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200374 set_fs(old_fs);
375
376 return res;
377}
Al Viro7bb307e2013-02-23 14:51:48 -0500378EXPORT_SYMBOL(kernel_write);
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200379
Al Viro82c156f2016-09-22 23:35:42 -0400380static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
Miklos Szeredi68181732009-05-07 15:37:36 +0200381 struct pipe_inode_info *pipe, size_t len,
382 unsigned int flags)
383{
Al Viro523ac9a2016-09-23 15:34:57 -0400384 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
385 struct iov_iter to;
386 struct page **pages;
Miklos Szeredi68181732009-05-07 15:37:36 +0200387 unsigned int nr_pages;
Al Viro523ac9a2016-09-23 15:34:57 -0400388 size_t offset, dummy, copied = 0;
Miklos Szeredi68181732009-05-07 15:37:36 +0200389 ssize_t res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200390 int i;
Miklos Szeredi68181732009-05-07 15:37:36 +0200391
Al Viro523ac9a2016-09-23 15:34:57 -0400392 if (pipe->nrbufs == pipe->buffers)
393 return -EAGAIN;
394
395 /*
396 * Try to keep page boundaries matching to source pagecache ones -
397 * it probably won't be much help, but...
398 */
399 offset = *ppos & ~PAGE_MASK;
400
401 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
402
403 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &dummy);
404 if (res <= 0)
Jens Axboe35f3d142010-05-20 10:43:18 +0200405 return -ENOMEM;
406
Al Viro8e54cad2016-11-26 20:05:42 -0500407 BUG_ON(dummy);
408 nr_pages = DIV_ROUND_UP(res, PAGE_SIZE);
Al Viro523ac9a2016-09-23 15:34:57 -0400409
Jens Axboe35f3d142010-05-20 10:43:18 +0200410 vec = __vec;
Al Viro523ac9a2016-09-23 15:34:57 -0400411 if (nr_pages > PIPE_DEF_BUFFERS) {
412 vec = kmalloc(nr_pages * sizeof(struct kvec), GFP_KERNEL);
413 if (unlikely(!vec)) {
414 res = -ENOMEM;
415 goto out;
416 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200417 }
418
Al Viro523ac9a2016-09-23 15:34:57 -0400419 pipe->bufs[to.idx].offset = offset;
420 pipe->bufs[to.idx].len -= offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200421
Al Viro523ac9a2016-09-23 15:34:57 -0400422 for (i = 0; i < nr_pages; i++) {
423 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
424 vec[i].iov_base = page_address(pages[i]) + offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200425 vec[i].iov_len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200426 len -= this_len;
427 offset = 0;
428 }
429
Al Viro523ac9a2016-09-23 15:34:57 -0400430 res = kernel_readv(in, vec, nr_pages, *ppos);
431 if (res > 0) {
432 copied = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200433 *ppos += res;
Al Viro523ac9a2016-09-23 15:34:57 -0400434 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200435
Jens Axboe35f3d142010-05-20 10:43:18 +0200436 if (vec != __vec)
437 kfree(vec);
Al Viro523ac9a2016-09-23 15:34:57 -0400438out:
439 for (i = 0; i < nr_pages; i++)
440 put_page(pages[i]);
441 kvfree(pages);
442 iov_iter_advance(&to, copied); /* truncates and discards */
Miklos Szeredi68181732009-05-07 15:37:36 +0200443 return res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200444}
Miklos Szeredi68181732009-05-07 15:37:36 +0200445
Jens Axboe5274f052006-03-30 15:15:30 +0200446/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200447 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200448 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200449 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200450static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200451 struct pipe_buffer *buf, struct splice_desc *sd)
452{
Jens Axboe6a14b902007-06-14 13:08:55 +0200453 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200454 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100455 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200456
Al Viro72c2d532013-09-22 16:27:52 -0400457 if (!likely(file->f_op->sendpage))
Michał Mirosława8adbe32010-12-17 08:56:44 +0100458 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200459
Eric Dumazet35f9c092012-04-05 03:05:35 +0000460 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000461
462 if (sd->len < sd->total_len && pipe->nrbufs > 1)
Eric Dumazet35f9c092012-04-05 03:05:35 +0000463 more |= MSG_SENDPAGE_NOTLAST;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000464
Michał Mirosława8adbe32010-12-17 08:56:44 +0100465 return file->f_op->sendpage(file, buf->page, buf->offset,
466 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200467}
468
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200469static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
470{
471 smp_mb();
472 if (waitqueue_active(&pipe->wait))
473 wake_up_interruptible(&pipe->wait);
474 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
475}
476
477/**
478 * splice_from_pipe_feed - feed available data from a pipe to a file
479 * @pipe: pipe to splice from
480 * @sd: information to @actor
481 * @actor: handler that splices the data
482 *
483 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200484 * This function loops over the pipe and calls @actor to do the
485 * actual moving of a single struct pipe_buffer to the desired
486 * destination. It returns when there's no more buffers left in
487 * the pipe or if the requested number of bytes (@sd->total_len)
488 * have been copied. It returns a positive number (one) if the
489 * pipe needs to be filled with more data, zero if the required
490 * number of bytes have been copied and -errno on error.
491 *
492 * This, together with splice_from_pipe_{begin,end,next}, may be
493 * used to implement the functionality of __splice_from_pipe() when
494 * locking is required around copying the pipe buffers to the
495 * destination.
496 */
Al Viro96f9bc82014-04-05 04:35:49 -0400497static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200498 splice_actor *actor)
499{
500 int ret;
501
502 while (pipe->nrbufs) {
503 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200504
505 sd->len = buf->len;
506 if (sd->len > sd->total_len)
507 sd->len = sd->total_len;
508
Miklos Szeredifba597d2016-09-27 10:45:12 +0200509 ret = pipe_buf_confirm(pipe, buf);
Michał Mirosława8adbe32010-12-17 08:56:44 +0100510 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200511 if (ret == -ENODATA)
512 ret = 0;
513 return ret;
514 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100515
516 ret = actor(pipe, buf, sd);
517 if (ret <= 0)
518 return ret;
519
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200520 buf->offset += ret;
521 buf->len -= ret;
522
523 sd->num_spliced += ret;
524 sd->len -= ret;
525 sd->pos += ret;
526 sd->total_len -= ret;
527
528 if (!buf->len) {
Miklos Szeredia7796382016-09-27 10:45:12 +0200529 pipe_buf_release(pipe, buf);
Jens Axboe35f3d142010-05-20 10:43:18 +0200530 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200531 pipe->nrbufs--;
Al Viro6447a3c2013-03-21 11:01:38 -0400532 if (pipe->files)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200533 sd->need_wakeup = true;
534 }
535
536 if (!sd->total_len)
537 return 0;
538 }
539
540 return 1;
541}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200542
543/**
544 * splice_from_pipe_next - wait for some data to splice from
545 * @pipe: pipe to splice from
546 * @sd: information about the splice operation
547 *
548 * Description:
549 * This function will wait for some data and return a positive
550 * value (one) if pipe buffers are available. It will return zero
551 * or -errno if no more data needs to be spliced.
552 */
Al Viro96f9bc82014-04-05 04:35:49 -0400553static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200554{
Jan Karac725bfc2015-11-23 13:09:50 +0100555 /*
556 * Check for signal early to make process killable when there are
557 * always buffers available
558 */
559 if (signal_pending(current))
560 return -ERESTARTSYS;
561
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200562 while (!pipe->nrbufs) {
563 if (!pipe->writers)
564 return 0;
565
566 if (!pipe->waiting_writers && sd->num_spliced)
567 return 0;
568
569 if (sd->flags & SPLICE_F_NONBLOCK)
570 return -EAGAIN;
571
572 if (signal_pending(current))
573 return -ERESTARTSYS;
574
575 if (sd->need_wakeup) {
576 wakeup_pipe_writers(pipe);
577 sd->need_wakeup = false;
578 }
579
580 pipe_wait(pipe);
581 }
582
583 return 1;
584}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200585
586/**
587 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700588 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200589 *
590 * Description:
591 * This function should be called before a loop containing
592 * splice_from_pipe_next() and splice_from_pipe_feed() to
593 * initialize the necessary fields of @sd.
594 */
Al Viro96f9bc82014-04-05 04:35:49 -0400595static void splice_from_pipe_begin(struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200596{
597 sd->num_spliced = 0;
598 sd->need_wakeup = false;
599}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200600
601/**
602 * splice_from_pipe_end - finish splicing from pipe
603 * @pipe: pipe to splice from
604 * @sd: information about the splice operation
605 *
606 * Description:
607 * This function will wake up pipe writers if necessary. It should
608 * be called after a loop containing splice_from_pipe_next() and
609 * splice_from_pipe_feed().
610 */
Al Viro96f9bc82014-04-05 04:35:49 -0400611static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200612{
613 if (sd->need_wakeup)
614 wakeup_pipe_writers(pipe);
615}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200616
Jens Axboe932cc6d2007-06-21 13:10:21 +0200617/**
618 * __splice_from_pipe - splice data from a pipe to given actor
619 * @pipe: pipe to splice from
620 * @sd: information to @actor
621 * @actor: handler that splices the data
622 *
623 * Description:
624 * This function does little more than loop over the pipe and call
625 * @actor to do the actual moving of a single struct pipe_buffer to
626 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
627 * pipe_to_user.
628 *
Jens Axboe83f91352006-04-02 23:05:09 +0200629 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200630ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
631 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200632{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200633 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200634
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200635 splice_from_pipe_begin(sd);
636 do {
Jan Karac2489e02015-11-23 13:09:51 +0100637 cond_resched();
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200638 ret = splice_from_pipe_next(pipe, sd);
639 if (ret > 0)
640 ret = splice_from_pipe_feed(pipe, sd, actor);
641 } while (ret > 0);
642 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200643
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200644 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200645}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100646EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200647
Jens Axboe932cc6d2007-06-21 13:10:21 +0200648/**
649 * splice_from_pipe - splice data from a pipe to a file
650 * @pipe: pipe to splice from
651 * @out: file to splice to
652 * @ppos: position in @out
653 * @len: how many bytes to splice
654 * @flags: splice modifier flags
655 * @actor: handler that splices the data
656 *
657 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200658 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200659 * otherwise it's identical to __splice_from_pipe().
660 *
661 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200662ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
663 loff_t *ppos, size_t len, unsigned int flags,
664 splice_actor *actor)
665{
666 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200667 struct splice_desc sd = {
668 .total_len = len,
669 .flags = flags,
670 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200671 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200672 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200673
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200674 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200675 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200676 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200677
678 return ret;
679}
680
681/**
Al Viro8d020762014-04-05 04:27:08 -0400682 * iter_file_splice_write - splice data from a pipe to a file
683 * @pipe: pipe info
684 * @out: file to write to
685 * @ppos: position in @out
686 * @len: number of bytes to splice
687 * @flags: splice modifier flags
688 *
689 * Description:
690 * Will either move or copy pages (determined by @flags options) from
691 * the given pipe inode to the given file.
692 * This one is ->write_iter-based.
693 *
694 */
695ssize_t
696iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
697 loff_t *ppos, size_t len, unsigned int flags)
698{
699 struct splice_desc sd = {
700 .total_len = len,
701 .flags = flags,
702 .pos = *ppos,
703 .u.file = out,
704 };
705 int nbufs = pipe->buffers;
706 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
707 GFP_KERNEL);
708 ssize_t ret;
709
710 if (unlikely(!array))
711 return -ENOMEM;
712
713 pipe_lock(pipe);
714
715 splice_from_pipe_begin(&sd);
716 while (sd.total_len) {
717 struct iov_iter from;
Al Viro8d020762014-04-05 04:27:08 -0400718 size_t left;
719 int n, idx;
720
721 ret = splice_from_pipe_next(pipe, &sd);
722 if (ret <= 0)
723 break;
724
725 if (unlikely(nbufs < pipe->buffers)) {
726 kfree(array);
727 nbufs = pipe->buffers;
728 array = kcalloc(nbufs, sizeof(struct bio_vec),
729 GFP_KERNEL);
730 if (!array) {
731 ret = -ENOMEM;
732 break;
733 }
734 }
735
736 /* build the vector */
737 left = sd.total_len;
738 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
739 struct pipe_buffer *buf = pipe->bufs + idx;
740 size_t this_len = buf->len;
741
742 if (this_len > left)
743 this_len = left;
744
745 if (idx == pipe->buffers - 1)
746 idx = -1;
747
Miklos Szeredifba597d2016-09-27 10:45:12 +0200748 ret = pipe_buf_confirm(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400749 if (unlikely(ret)) {
750 if (ret == -ENODATA)
751 ret = 0;
752 goto done;
753 }
754
755 array[n].bv_page = buf->page;
756 array[n].bv_len = this_len;
757 array[n].bv_offset = buf->offset;
758 left -= this_len;
759 }
760
Al Viro05afcb72015-01-23 01:08:07 -0500761 iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
762 sd.total_len - left);
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100763 ret = vfs_iter_write(out, &from, &sd.pos);
Al Viro8d020762014-04-05 04:27:08 -0400764 if (ret <= 0)
765 break;
766
767 sd.num_spliced += ret;
768 sd.total_len -= ret;
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100769 *ppos = sd.pos;
Al Viro8d020762014-04-05 04:27:08 -0400770
771 /* dismiss the fully eaten buffers, adjust the partial one */
772 while (ret) {
773 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
774 if (ret >= buf->len) {
Al Viro8d020762014-04-05 04:27:08 -0400775 ret -= buf->len;
776 buf->len = 0;
Miklos Szeredia7796382016-09-27 10:45:12 +0200777 pipe_buf_release(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400778 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
779 pipe->nrbufs--;
780 if (pipe->files)
781 sd.need_wakeup = true;
782 } else {
783 buf->offset += ret;
784 buf->len -= ret;
785 ret = 0;
786 }
787 }
788 }
789done:
790 kfree(array);
791 splice_from_pipe_end(pipe, &sd);
792
793 pipe_unlock(pipe);
794
795 if (sd.num_spliced)
796 ret = sd.num_spliced;
797
798 return ret;
799}
800
801EXPORT_SYMBOL(iter_file_splice_write);
802
Miklos Szeredib2858d72009-05-19 11:37:46 +0200803static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
804 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200805{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200806 int ret;
807 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -0400808 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +0200809
Al Virofbb32752014-02-02 21:09:54 -0500810 data = kmap(buf->page);
Al Viro06ae43f2013-03-20 13:19:30 -0400811 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Al Virofbb32752014-02-02 21:09:54 -0500812 kunmap(buf->page);
Miklos Szeredib2858d72009-05-19 11:37:46 +0200813
814 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200815}
816
817static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
818 struct file *out, loff_t *ppos,
819 size_t len, unsigned int flags)
820{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200821 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200822
Miklos Szeredib2858d72009-05-19 11:37:46 +0200823 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
824 if (ret > 0)
825 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200826
Miklos Szeredib2858d72009-05-19 11:37:46 +0200827 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200828}
829
Jens Axboe83f91352006-04-02 23:05:09 +0200830/**
831 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200832 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200833 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200834 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200835 * @len: number of bytes to splice
836 * @flags: splice modifier flags
837 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200838 * Description:
839 * Will send @len bytes from the pipe to a network socket. No data copying
840 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200841 *
842 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200843ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200844 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200845{
Jens Axboe00522fb2006-04-26 14:39:29 +0200846 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200847}
848
Jens Axboe059a8f32006-04-02 23:06:05 +0200849EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500850
Jens Axboe83f91352006-04-02 23:05:09 +0200851/*
852 * Attempt to initiate a splice from pipe to file.
853 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200854static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200855 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200856{
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200857 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
858 loff_t *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200859
Al Viro72c2d532013-09-22 16:27:52 -0400860 if (out->f_op->splice_write)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100861 splice_write = out->f_op->splice_write;
862 else
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200863 splice_write = default_file_splice_write;
864
Al Viro500368f2013-05-23 20:07:11 -0400865 return splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200866}
867
Jens Axboe83f91352006-04-02 23:05:09 +0200868/*
869 * Attempt to initiate a splice from a file to a pipe.
870 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200871static long do_splice_to(struct file *in, loff_t *ppos,
872 struct pipe_inode_info *pipe, size_t len,
873 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200874{
Miklos Szeredi68181732009-05-07 15:37:36 +0200875 ssize_t (*splice_read)(struct file *, loff_t *,
876 struct pipe_inode_info *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200877 int ret;
878
Jens Axboe49570e92006-04-11 13:56:09 +0200879 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200880 return -EBADF;
881
Jens Axboecbb7e572006-04-11 14:57:50 +0200882 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200883 if (unlikely(ret < 0))
884 return ret;
885
Al Viro03cc0782016-04-02 14:56:58 -0400886 if (unlikely(len > MAX_RW_COUNT))
887 len = MAX_RW_COUNT;
888
Al Viro72c2d532013-09-22 16:27:52 -0400889 if (in->f_op->splice_read)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100890 splice_read = in->f_op->splice_read;
891 else
Miklos Szeredi68181732009-05-07 15:37:36 +0200892 splice_read = default_file_splice_read;
893
894 return splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200895}
896
Jens Axboe932cc6d2007-06-21 13:10:21 +0200897/**
898 * splice_direct_to_actor - splices data directly between two non-pipes
899 * @in: file to splice from
900 * @sd: actor information on where to splice to
901 * @actor: handles the data splicing
902 *
903 * Description:
904 * This is a special case helper to splice directly between two
905 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200906 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200907 * that process.
908 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200909 */
910ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
911 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200912{
913 struct pipe_inode_info *pipe;
914 long ret, bytes;
915 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200916 size_t len;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200917 int i, flags, more;
Jens Axboeb92ce552006-04-11 13:52:07 +0200918
919 /*
920 * We require the input being a regular file, as we don't want to
921 * randomly drop data for eg socket -> socket splicing. Use the
922 * piped splicing for that!
923 */
Al Viro496ad9a2013-01-23 17:07:38 -0500924 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200925 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
926 return -EINVAL;
927
928 /*
929 * neither in nor out is a pipe, setup an internal pipe attached to
930 * 'out' and transfer the wanted data from 'in' to 'out' through that
931 */
932 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200933 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -0400934 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +0200935 if (!pipe)
936 return -ENOMEM;
937
938 /*
939 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200940 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200941 * PIPE_READERS appropriately.
942 */
943 pipe->readers = 1;
944
945 current->splice_pipe = pipe;
946 }
947
948 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200949 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200950 */
951 ret = 0;
952 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200953 len = sd->total_len;
954 flags = sd->flags;
955
956 /*
957 * Don't block on output, we have to drain the direct pipe.
958 */
959 sd->flags &= ~SPLICE_F_NONBLOCK;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200960 more = sd->flags & SPLICE_F_MORE;
Jens Axboeb92ce552006-04-11 13:52:07 +0200961
962 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +0200963 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200964 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200965
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200966 ret = do_splice_to(in, &pos, pipe, len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200967 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +0200968 goto out_release;
969
970 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200971 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +0200972
973 /*
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200974 * If more data is pending, set SPLICE_F_MORE
975 * If this is the last data and SPLICE_F_MORE was not set
976 * initially, clears it.
977 */
978 if (read_len < len)
979 sd->flags |= SPLICE_F_MORE;
980 else if (!more)
981 sd->flags &= ~SPLICE_F_MORE;
982 /*
Jens Axboeb92ce552006-04-11 13:52:07 +0200983 * NOTE: nonblocking mode only applies to the input. We
984 * must not do the output in nonblocking mode as then we
985 * could get stuck data in the internal pipe:
986 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200987 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +0200988 if (unlikely(ret <= 0)) {
989 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200990 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200991 }
Jens Axboeb92ce552006-04-11 13:52:07 +0200992
993 bytes += ret;
994 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200995 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200996
Tom Zanussia82c53a2008-05-09 13:28:36 +0200997 if (ret < read_len) {
998 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +0200999 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001000 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001001 }
1002
Jens Axboe9e971982008-01-29 21:05:57 +01001003done:
Jens Axboeb92ce552006-04-11 13:52:07 +02001004 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001005 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001006 return bytes;
1007
1008out_release:
1009 /*
1010 * If we did an incomplete transfer we must release
1011 * the pipe buffers in question:
1012 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001013 for (i = 0; i < pipe->buffers; i++) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001014 struct pipe_buffer *buf = pipe->bufs + i;
1015
Miklos Szeredia7796382016-09-27 10:45:12 +02001016 if (buf->ops)
1017 pipe_buf_release(pipe, buf);
Jens Axboeb92ce552006-04-11 13:52:07 +02001018 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001019
Jens Axboe9e971982008-01-29 21:05:57 +01001020 if (!bytes)
1021 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001022
Jens Axboe9e971982008-01-29 21:05:57 +01001023 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001024}
1025EXPORT_SYMBOL(splice_direct_to_actor);
1026
1027static int direct_splice_actor(struct pipe_inode_info *pipe,
1028 struct splice_desc *sd)
1029{
Jens Axboe6a14b902007-06-14 13:08:55 +02001030 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001031
Al Viro7995bd22013-06-20 18:58:36 +04001032 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001033 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001034}
1035
Jens Axboe932cc6d2007-06-21 13:10:21 +02001036/**
1037 * do_splice_direct - splices data directly between two files
1038 * @in: file to splice from
1039 * @ppos: input file offset
1040 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001041 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001042 * @len: number of bytes to splice
1043 * @flags: splice modifier flags
1044 *
1045 * Description:
1046 * For use by do_sendfile(). splice can easily emulate sendfile, but
1047 * doing it in the application would incur an extra system call
1048 * (splice in + splice out, as compared to just sendfile()). So this helper
1049 * can splice directly through a process-private pipe.
1050 *
1051 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001052long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001053 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001054{
1055 struct splice_desc sd = {
1056 .len = len,
1057 .total_len = len,
1058 .flags = flags,
1059 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001060 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001061 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001062 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001063 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001064
Al Viro18c67cb2013-06-19 15:41:54 +04001065 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1066 return -EBADF;
1067
1068 if (unlikely(out->f_flags & O_APPEND))
1069 return -EINVAL;
1070
1071 ret = rw_verify_area(WRITE, out, opos, len);
1072 if (unlikely(ret < 0))
1073 return ret;
1074
Jens Axboec66ab6f2007-06-12 21:17:17 +02001075 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001076 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001077 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001078
Jens Axboec66ab6f2007-06-12 21:17:17 +02001079 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001080}
Miklos Szeredi1c118592014-10-24 00:14:35 +02001081EXPORT_SYMBOL(do_splice_direct);
Jens Axboeb92ce552006-04-11 13:52:07 +02001082
Al Viro8924fef2016-09-17 20:44:45 -04001083static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1084{
Linus Torvalds52bce912016-12-21 10:59:34 -08001085 for (;;) {
1086 if (unlikely(!pipe->readers)) {
1087 send_sig(SIGPIPE, current, 0);
1088 return -EPIPE;
1089 }
1090 if (pipe->nrbufs != pipe->buffers)
1091 return 0;
Al Viro8924fef2016-09-17 20:44:45 -04001092 if (flags & SPLICE_F_NONBLOCK)
1093 return -EAGAIN;
1094 if (signal_pending(current))
1095 return -ERESTARTSYS;
1096 pipe->waiting_writers++;
1097 pipe_wait(pipe);
1098 pipe->waiting_writers--;
1099 }
Al Viro8924fef2016-09-17 20:44:45 -04001100}
1101
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001102static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1103 struct pipe_inode_info *opipe,
1104 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001105
1106/*
Jens Axboe83f91352006-04-02 23:05:09 +02001107 * Determine where to splice to/from.
1108 */
Ingo Molnar529565dc2006-04-10 15:18:58 +02001109static long do_splice(struct file *in, loff_t __user *off_in,
1110 struct file *out, loff_t __user *off_out,
1111 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001112{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001113 struct pipe_inode_info *ipipe;
1114 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001115 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001116 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001117
Linus Torvalds71993e62010-11-28 13:56:09 -08001118 ipipe = get_pipe_info(in);
1119 opipe = get_pipe_info(out);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001120
1121 if (ipipe && opipe) {
1122 if (off_in || off_out)
1123 return -ESPIPE;
1124
1125 if (!(in->f_mode & FMODE_READ))
1126 return -EBADF;
1127
1128 if (!(out->f_mode & FMODE_WRITE))
1129 return -EBADF;
1130
1131 /* Splicing to self would be fun, but... */
1132 if (ipipe == opipe)
1133 return -EINVAL;
1134
1135 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1136 }
1137
1138 if (ipipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001139 if (off_in)
1140 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001141 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001142 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001143 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001144 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001145 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001146 } else {
1147 offset = out->f_pos;
1148 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001149
Al Viro18c67cb2013-06-19 15:41:54 +04001150 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1151 return -EBADF;
1152
1153 if (unlikely(out->f_flags & O_APPEND))
1154 return -EINVAL;
1155
1156 ret = rw_verify_area(WRITE, out, &offset, len);
1157 if (unlikely(ret < 0))
1158 return ret;
1159
Al Viro500368f2013-05-23 20:07:11 -04001160 file_start_write(out);
Al Viro7995bd22013-06-20 18:58:36 +04001161 ret = do_splice_from(ipipe, out, &offset, len, flags);
Al Viro500368f2013-05-23 20:07:11 -04001162 file_end_write(out);
Jens Axboea4514eb2006-04-19 15:57:05 +02001163
Al Viro7995bd22013-06-20 18:58:36 +04001164 if (!off_out)
1165 out->f_pos = offset;
1166 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001167 ret = -EFAULT;
1168
1169 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001170 }
Jens Axboe5274f052006-03-30 15:15:30 +02001171
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001172 if (opipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001173 if (off_out)
1174 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001175 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001176 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001177 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001178 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001179 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001180 } else {
1181 offset = in->f_pos;
1182 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001183
Al Viro8924fef2016-09-17 20:44:45 -04001184 pipe_lock(opipe);
1185 ret = wait_for_space(opipe, flags);
1186 if (!ret)
1187 ret = do_splice_to(in, &offset, opipe, len, flags);
1188 pipe_unlock(opipe);
1189 if (ret > 0)
1190 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001191 if (!off_in)
1192 in->f_pos = offset;
1193 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001194 ret = -EFAULT;
1195
1196 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001197 }
Jens Axboe5274f052006-03-30 15:15:30 +02001198
1199 return -EINVAL;
1200}
1201
Al Viro79fddc42016-09-17 22:38:20 -04001202static int iter_to_pipe(struct iov_iter *from,
1203 struct pipe_inode_info *pipe,
1204 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001205{
Al Viro79fddc42016-09-17 22:38:20 -04001206 struct pipe_buffer buf = {
1207 .ops = &user_page_pipe_buf_ops,
1208 .flags = flags
1209 };
1210 size_t total = 0;
1211 int ret = 0;
1212 bool failed = false;
1213
1214 while (iov_iter_count(from) && !failed) {
1215 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001216 ssize_t copied;
1217 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001218 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001219
Al Viro79fddc42016-09-17 22:38:20 -04001220 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1221 if (copied <= 0) {
1222 ret = copied;
1223 break;
1224 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001225
Al Viro79fddc42016-09-17 22:38:20 -04001226 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001227 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001228 if (!failed) {
1229 buf.page = pages[n];
1230 buf.offset = start;
1231 buf.len = size;
1232 ret = add_to_pipe(pipe, &buf);
1233 if (unlikely(ret < 0)) {
1234 failed = true;
1235 } else {
1236 iov_iter_advance(from, ret);
1237 total += ret;
1238 }
1239 } else {
1240 put_page(pages[n]);
1241 }
Al Virodb85a9e2016-09-17 20:25:06 -04001242 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001243 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001244 }
Al Viro79fddc42016-09-17 22:38:20 -04001245 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001246}
1247
Jens Axboe6a14b902007-06-14 13:08:55 +02001248static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1249 struct splice_desc *sd)
1250{
Al Viro6130f532014-02-03 18:19:51 -05001251 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1252 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001253}
1254
1255/*
1256 * For lack of a better implementation, implement vmsplice() to userspace
1257 * as a simple copy of the pipes pages to the user iov.
1258 */
Al Viro6130f532014-02-03 18:19:51 -05001259static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001260 unsigned long nr_segs, unsigned int flags)
1261{
1262 struct pipe_inode_info *pipe;
1263 struct splice_desc sd;
Jens Axboe6a14b902007-06-14 13:08:55 +02001264 long ret;
Al Viro6130f532014-02-03 18:19:51 -05001265 struct iovec iovstack[UIO_FASTIOV];
1266 struct iovec *iov = iovstack;
1267 struct iov_iter iter;
Jens Axboe6a14b902007-06-14 13:08:55 +02001268
Linus Torvalds71993e62010-11-28 13:56:09 -08001269 pipe = get_pipe_info(file);
Jens Axboe6a14b902007-06-14 13:08:55 +02001270 if (!pipe)
1271 return -EBADF;
1272
Al Viro345995f2015-03-21 19:17:55 -04001273 ret = import_iovec(READ, uiov, nr_segs,
1274 ARRAY_SIZE(iovstack), &iov, &iter);
1275 if (ret < 0)
1276 return ret;
Al Viro6130f532014-02-03 18:19:51 -05001277
Al Viro345995f2015-03-21 19:17:55 -04001278 sd.total_len = iov_iter_count(&iter);
Al Viro6130f532014-02-03 18:19:51 -05001279 sd.len = 0;
Al Viro6130f532014-02-03 18:19:51 -05001280 sd.flags = flags;
1281 sd.u.data = &iter;
1282 sd.pos = 0;
1283
Al Viro345995f2015-03-21 19:17:55 -04001284 if (sd.total_len) {
1285 pipe_lock(pipe);
1286 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1287 pipe_unlock(pipe);
1288 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001289
Al Viro345995f2015-03-21 19:17:55 -04001290 kfree(iov);
Jens Axboe6a14b902007-06-14 13:08:55 +02001291 return ret;
1292}
1293
Jens Axboe912d35f2006-04-26 10:59:21 +02001294/*
1295 * vmsplice splices a user address range into a pipe. It can be thought of
1296 * as splice-from-memory, where the regular splice is splice-from-file (or
1297 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001298 */
Al Virodb85a9e2016-09-17 20:25:06 -04001299static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
Jens Axboe6a14b902007-06-14 13:08:55 +02001300 unsigned long nr_segs, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001301{
Jens Axboeddac0d32006-11-04 12:49:32 +01001302 struct pipe_inode_info *pipe;
Al Virodb85a9e2016-09-17 20:25:06 -04001303 struct iovec iovstack[UIO_FASTIOV];
1304 struct iovec *iov = iovstack;
1305 struct iov_iter from;
Jens Axboe35f3d142010-05-20 10:43:18 +02001306 long ret;
Al Viro79fddc42016-09-17 22:38:20 -04001307 unsigned buf_flag = 0;
1308
1309 if (flags & SPLICE_F_GIFT)
1310 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001311
Linus Torvalds71993e62010-11-28 13:56:09 -08001312 pipe = get_pipe_info(file);
Jens Axboeddac0d32006-11-04 12:49:32 +01001313 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001314 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001315
Al Virodb85a9e2016-09-17 20:25:06 -04001316 ret = import_iovec(WRITE, uiov, nr_segs,
1317 ARRAY_SIZE(iovstack), &iov, &from);
1318 if (ret < 0)
1319 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001320
Al Viro8924fef2016-09-17 20:44:45 -04001321 pipe_lock(pipe);
1322 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001323 if (!ret)
1324 ret = iter_to_pipe(&from, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001325 pipe_unlock(pipe);
1326 if (ret > 0)
1327 wakeup_pipe_readers(pipe);
Al Virodb85a9e2016-09-17 20:25:06 -04001328 kfree(iov);
Jens Axboe35f3d142010-05-20 10:43:18 +02001329 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001330}
1331
Jens Axboe6a14b902007-06-14 13:08:55 +02001332/*
1333 * Note that vmsplice only really supports true splicing _from_ user memory
1334 * to a pipe, not the other way around. Splicing from user memory is a simple
1335 * operation that can be supported without any funky alignment restrictions
1336 * or nasty vm tricks. We simply map in the user memory and fill them into
1337 * a pipe. The reverse isn't quite as easy, though. There are two possible
1338 * solutions for that:
1339 *
1340 * - memcpy() the data internally, at which point we might as well just
1341 * do a regular read() on the buffer anyway.
1342 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1343 * has restriction limitations on both ends of the pipe).
1344 *
1345 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1346 *
1347 */
Heiko Carstens836f92a2009-01-14 14:14:33 +01001348SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1349 unsigned long, nr_segs, unsigned int, flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001350{
Al Viro2903ff02012-08-28 12:52:22 -04001351 struct fd f;
Jens Axboe912d35f2006-04-26 10:59:21 +02001352 long error;
Jens Axboe912d35f2006-04-26 10:59:21 +02001353
Al Viro3d6ea292016-12-10 13:17:32 -05001354 if (unlikely(flags & ~SPLICE_F_ALL))
1355 return -EINVAL;
Jens Axboe6a14b902007-06-14 13:08:55 +02001356 if (unlikely(nr_segs > UIO_MAXIOV))
1357 return -EINVAL;
1358 else if (unlikely(!nr_segs))
1359 return 0;
1360
Jens Axboe912d35f2006-04-26 10:59:21 +02001361 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001362 f = fdget(fd);
1363 if (f.file) {
1364 if (f.file->f_mode & FMODE_WRITE)
1365 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1366 else if (f.file->f_mode & FMODE_READ)
1367 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001368
Al Viro2903ff02012-08-28 12:52:22 -04001369 fdput(f);
Jens Axboe912d35f2006-04-26 10:59:21 +02001370 }
1371
1372 return error;
1373}
1374
Al Viro76b021d2013-03-02 10:19:56 -05001375#ifdef CONFIG_COMPAT
1376COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1377 unsigned int, nr_segs, unsigned int, flags)
1378{
1379 unsigned i;
1380 struct iovec __user *iov;
1381 if (nr_segs > UIO_MAXIOV)
1382 return -EINVAL;
1383 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1384 for (i = 0; i < nr_segs; i++) {
1385 struct compat_iovec v;
1386 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1387 get_user(v.iov_len, &iov32[i].iov_len) ||
1388 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1389 put_user(v.iov_len, &iov[i].iov_len))
1390 return -EFAULT;
1391 }
1392 return sys_vmsplice(fd, iov, nr_segs, flags);
1393}
1394#endif
1395
Heiko Carstens836f92a2009-01-14 14:14:33 +01001396SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1397 int, fd_out, loff_t __user *, off_out,
1398 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001399{
Al Viro2903ff02012-08-28 12:52:22 -04001400 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001401 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001402
1403 if (unlikely(!len))
1404 return 0;
1405
Al Viro3d6ea292016-12-10 13:17:32 -05001406 if (unlikely(flags & ~SPLICE_F_ALL))
1407 return -EINVAL;
1408
Jens Axboe5274f052006-03-30 15:15:30 +02001409 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001410 in = fdget(fd_in);
1411 if (in.file) {
1412 if (in.file->f_mode & FMODE_READ) {
1413 out = fdget(fd_out);
1414 if (out.file) {
1415 if (out.file->f_mode & FMODE_WRITE)
1416 error = do_splice(in.file, off_in,
1417 out.file, off_out,
Ingo Molnar529565dc2006-04-10 15:18:58 +02001418 len, flags);
Al Viro2903ff02012-08-28 12:52:22 -04001419 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001420 }
1421 }
Al Viro2903ff02012-08-28 12:52:22 -04001422 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001423 }
Jens Axboe5274f052006-03-30 15:15:30 +02001424 return error;
1425}
Jens Axboe70524492006-04-11 15:51:17 +02001426
1427/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001428 * Make sure there's data to read. Wait for input if we can, otherwise
1429 * return an appropriate error.
1430 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001431static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001432{
1433 int ret;
1434
1435 /*
1436 * Check ->nrbufs without the inode lock first. This function
1437 * is speculative anyways, so missing one is ok.
1438 */
1439 if (pipe->nrbufs)
1440 return 0;
1441
1442 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001443 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001444
1445 while (!pipe->nrbufs) {
1446 if (signal_pending(current)) {
1447 ret = -ERESTARTSYS;
1448 break;
1449 }
1450 if (!pipe->writers)
1451 break;
1452 if (!pipe->waiting_writers) {
1453 if (flags & SPLICE_F_NONBLOCK) {
1454 ret = -EAGAIN;
1455 break;
1456 }
1457 }
1458 pipe_wait(pipe);
1459 }
1460
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001461 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001462 return ret;
1463}
1464
1465/*
1466 * Make sure there's writeable room. Wait for room if we can, otherwise
1467 * return an appropriate error.
1468 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001469static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001470{
1471 int ret;
1472
1473 /*
1474 * Check ->nrbufs without the inode lock first. This function
1475 * is speculative anyways, so missing one is ok.
1476 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001477 if (pipe->nrbufs < pipe->buffers)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001478 return 0;
1479
1480 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001481 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001482
Jens Axboe35f3d142010-05-20 10:43:18 +02001483 while (pipe->nrbufs >= pipe->buffers) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001484 if (!pipe->readers) {
1485 send_sig(SIGPIPE, current, 0);
1486 ret = -EPIPE;
1487 break;
1488 }
1489 if (flags & SPLICE_F_NONBLOCK) {
1490 ret = -EAGAIN;
1491 break;
1492 }
1493 if (signal_pending(current)) {
1494 ret = -ERESTARTSYS;
1495 break;
1496 }
1497 pipe->waiting_writers++;
1498 pipe_wait(pipe);
1499 pipe->waiting_writers--;
1500 }
1501
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001502 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001503 return ret;
1504}
1505
1506/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001507 * Splice contents of ipipe to opipe.
1508 */
1509static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1510 struct pipe_inode_info *opipe,
1511 size_t len, unsigned int flags)
1512{
1513 struct pipe_buffer *ibuf, *obuf;
1514 int ret = 0, nbuf;
1515 bool input_wakeup = false;
1516
1517
1518retry:
1519 ret = ipipe_prep(ipipe, flags);
1520 if (ret)
1521 return ret;
1522
1523 ret = opipe_prep(opipe, flags);
1524 if (ret)
1525 return ret;
1526
1527 /*
1528 * Potential ABBA deadlock, work around it by ordering lock
1529 * grabbing by pipe info address. Otherwise two different processes
1530 * could deadlock (one doing tee from A -> B, the other from B -> A).
1531 */
1532 pipe_double_lock(ipipe, opipe);
1533
1534 do {
1535 if (!opipe->readers) {
1536 send_sig(SIGPIPE, current, 0);
1537 if (!ret)
1538 ret = -EPIPE;
1539 break;
1540 }
1541
1542 if (!ipipe->nrbufs && !ipipe->writers)
1543 break;
1544
1545 /*
1546 * Cannot make any progress, because either the input
1547 * pipe is empty or the output pipe is full.
1548 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001549 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001550 /* Already processed some buffers, break */
1551 if (ret)
1552 break;
1553
1554 if (flags & SPLICE_F_NONBLOCK) {
1555 ret = -EAGAIN;
1556 break;
1557 }
1558
1559 /*
1560 * We raced with another reader/writer and haven't
1561 * managed to process any buffers. A zero return
1562 * value means EOF, so retry instead.
1563 */
1564 pipe_unlock(ipipe);
1565 pipe_unlock(opipe);
1566 goto retry;
1567 }
1568
1569 ibuf = ipipe->bufs + ipipe->curbuf;
Jens Axboe35f3d142010-05-20 10:43:18 +02001570 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001571 obuf = opipe->bufs + nbuf;
1572
1573 if (len >= ibuf->len) {
1574 /*
1575 * Simply move the whole buffer from ipipe to opipe
1576 */
1577 *obuf = *ibuf;
1578 ibuf->ops = NULL;
1579 opipe->nrbufs++;
Jens Axboe35f3d142010-05-20 10:43:18 +02001580 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001581 ipipe->nrbufs--;
1582 input_wakeup = true;
1583 } else {
1584 /*
1585 * Get a reference to this pipe buffer,
1586 * so we can copy the contents over.
1587 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001588 pipe_buf_get(ipipe, ibuf);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001589 *obuf = *ibuf;
1590
1591 /*
1592 * Don't inherit the gift flag, we need to
1593 * prevent multiple steals of this page.
1594 */
1595 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1596
1597 obuf->len = len;
1598 opipe->nrbufs++;
1599 ibuf->offset += obuf->len;
1600 ibuf->len -= obuf->len;
1601 }
1602 ret += obuf->len;
1603 len -= obuf->len;
1604 } while (len);
1605
1606 pipe_unlock(ipipe);
1607 pipe_unlock(opipe);
1608
1609 /*
1610 * If we put data in the output pipe, wakeup any potential readers.
1611 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001612 if (ret > 0)
1613 wakeup_pipe_readers(opipe);
1614
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001615 if (input_wakeup)
1616 wakeup_pipe_writers(ipipe);
1617
1618 return ret;
1619}
1620
1621/*
Jens Axboe70524492006-04-11 15:51:17 +02001622 * Link contents of ipipe to opipe.
1623 */
1624static int link_pipe(struct pipe_inode_info *ipipe,
1625 struct pipe_inode_info *opipe,
1626 size_t len, unsigned int flags)
1627{
1628 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001629 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001630
1631 /*
1632 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001633 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001634 * could deadlock (one doing tee from A -> B, the other from B -> A).
1635 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001636 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001637
Jens Axboeaadd06e2006-07-10 11:00:01 +02001638 do {
Jens Axboe70524492006-04-11 15:51:17 +02001639 if (!opipe->readers) {
1640 send_sig(SIGPIPE, current, 0);
1641 if (!ret)
1642 ret = -EPIPE;
1643 break;
1644 }
Jens Axboe70524492006-04-11 15:51:17 +02001645
1646 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001647 * If we have iterated all input buffers or ran out of
1648 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001649 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001650 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
Jens Axboe70524492006-04-11 15:51:17 +02001651 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001652
Jens Axboe35f3d142010-05-20 10:43:18 +02001653 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1654 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001655
Jens Axboe2a27250e2006-04-19 15:56:40 +02001656 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001657 * Get a reference to this pipe buffer,
1658 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001659 */
Miklos Szeredi7bf2d1d2016-09-27 10:45:12 +02001660 pipe_buf_get(ipipe, ibuf);
Jens Axboe70524492006-04-11 15:51:17 +02001661
Jens Axboeaadd06e2006-07-10 11:00:01 +02001662 obuf = opipe->bufs + nbuf;
1663 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001664
Jens Axboeaadd06e2006-07-10 11:00:01 +02001665 /*
1666 * Don't inherit the gift flag, we need to
1667 * prevent multiple steals of this page.
1668 */
1669 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1670
1671 if (obuf->len > len)
1672 obuf->len = len;
1673
1674 opipe->nrbufs++;
1675 ret += obuf->len;
1676 len -= obuf->len;
1677 i++;
1678 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001679
Jens Axboe02cf01a2008-02-20 10:34:51 +01001680 /*
1681 * return EAGAIN if we have the potential of some data in the
1682 * future, otherwise just return 0
1683 */
1684 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1685 ret = -EAGAIN;
1686
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001687 pipe_unlock(ipipe);
1688 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001689
Jens Axboeaadd06e2006-07-10 11:00:01 +02001690 /*
1691 * If we put data in the output pipe, wakeup any potential readers.
1692 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001693 if (ret > 0)
1694 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001695
1696 return ret;
1697}
1698
1699/*
1700 * This is a tee(1) implementation that works on pipes. It doesn't copy
1701 * any data, it simply references the 'in' pages on the 'out' pipe.
1702 * The 'flags' used are the SPLICE_F_* variants, currently the only
1703 * applicable one is SPLICE_F_NONBLOCK.
1704 */
1705static long do_tee(struct file *in, struct file *out, size_t len,
1706 unsigned int flags)
1707{
Linus Torvalds71993e62010-11-28 13:56:09 -08001708 struct pipe_inode_info *ipipe = get_pipe_info(in);
1709 struct pipe_inode_info *opipe = get_pipe_info(out);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001710 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001711
1712 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001713 * Duplicate the contents of ipipe to opipe without actually
1714 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001715 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001716 if (ipipe && opipe && ipipe != opipe) {
1717 /*
1718 * Keep going, unless we encounter an error. The ipipe/opipe
1719 * ordering doesn't really matter.
1720 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001721 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001722 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001723 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001724 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001725 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001726 }
1727 }
Jens Axboe70524492006-04-11 15:51:17 +02001728
Jens Axboeaadd06e2006-07-10 11:00:01 +02001729 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001730}
1731
Heiko Carstens836f92a2009-01-14 14:14:33 +01001732SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001733{
Al Viro2903ff02012-08-28 12:52:22 -04001734 struct fd in;
1735 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001736
Al Viro3d6ea292016-12-10 13:17:32 -05001737 if (unlikely(flags & ~SPLICE_F_ALL))
1738 return -EINVAL;
1739
Jens Axboe70524492006-04-11 15:51:17 +02001740 if (unlikely(!len))
1741 return 0;
1742
1743 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001744 in = fdget(fdin);
1745 if (in.file) {
1746 if (in.file->f_mode & FMODE_READ) {
1747 struct fd out = fdget(fdout);
1748 if (out.file) {
1749 if (out.file->f_mode & FMODE_WRITE)
1750 error = do_tee(in.file, out.file,
1751 len, flags);
1752 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001753 }
1754 }
Al Viro2903ff02012-08-28 12:52:22 -04001755 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001756 }
1757
1758 return error;
1759}