blob: 98412721f0562c3e2f20332e28f756df6eddc7a1 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Jens Axboe5274f052006-03-30 15:15:30 +02002/*
3 * "splice": joining two ropes together by interweaving their strands.
4 *
5 * This is the "extended pipe" functionality, where a pipe is used as
6 * an arbitrary in-memory buffer. Think of a pipe as a small kernel
7 * buffer that you can use to transfer data from one end to the other.
8 *
9 * The traditional unix read/write is extended with a "splice()" operation
10 * that transfers data buffers to or from a pipe buffer.
11 *
12 * Named by Larry McVoy, original implementation from Linus, extended by
Jens Axboec2058e02006-04-11 13:56:34 +020013 * Jens to support splicing to files, network, direct splicing, etc and
14 * fixing lots of bugs.
Jens Axboe5274f052006-03-30 15:15:30 +020015 *
Jens Axboe0fe23472006-09-04 15:41:16 +020016 * Copyright (C) 2005-2006 Jens Axboe <axboe@kernel.dk>
Jens Axboec2058e02006-04-11 13:56:34 +020017 * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
18 * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
Jens Axboe5274f052006-03-30 15:15:30 +020019 *
20 */
Christoph Hellwigbe297962016-11-01 07:40:16 -060021#include <linux/bvec.h>
Jens Axboe5274f052006-03-30 15:15:30 +020022#include <linux/fs.h>
23#include <linux/file.h>
24#include <linux/pagemap.h>
Jens Axboed6b29d72007-06-04 09:59:47 +020025#include <linux/splice.h>
KAMEZAWA Hiroyuki08e552c2009-01-07 18:08:01 -080026#include <linux/memcontrol.h>
Jens Axboe5274f052006-03-30 15:15:30 +020027#include <linux/mm_inline.h>
Jens Axboe5abc97a2006-03-30 15:16:46 +020028#include <linux/swap.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020029#include <linux/writeback.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050030#include <linux/export.h>
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020031#include <linux/syscalls.h>
Jens Axboe912d35f2006-04-26 10:59:21 +020032#include <linux/uio.h>
James Morris29ce2052007-07-13 11:44:32 +020033#include <linux/security.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090034#include <linux/gfp.h>
Eric Dumazet35f9c092012-04-05 03:05:35 +000035#include <linux/socket.h>
Al Viro76b021d2013-03-02 10:19:56 -050036#include <linux/compat.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010037#include <linux/sched/signal.h>
38
Al Viro06ae43f2013-03-20 13:19:30 -040039#include "internal.h"
Jens Axboe5274f052006-03-30 15:15:30 +020040
Jens Axboe83f91352006-04-02 23:05:09 +020041/*
42 * Attempt to steal a page from a pipe buffer. This should perhaps go into
43 * a vm helper function, it's already simplified quite a bit by the
44 * addition of remove_mapping(). If success is returned, the caller may
45 * attempt to reuse this page for another destination.
46 */
Jens Axboe76ad4d12006-05-03 10:41:33 +020047static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
Jens Axboe5abc97a2006-03-30 15:16:46 +020048 struct pipe_buffer *buf)
49{
50 struct page *page = buf->page;
Jens Axboe9e94cd42006-06-20 15:01:12 +020051 struct address_space *mapping;
Jens Axboe5abc97a2006-03-30 15:16:46 +020052
Jens Axboe9e0267c2006-04-19 15:57:31 +020053 lock_page(page);
54
Jens Axboe9e94cd42006-06-20 15:01:12 +020055 mapping = page_mapping(page);
56 if (mapping) {
57 WARN_ON(!PageUptodate(page));
Jens Axboe5abc97a2006-03-30 15:16:46 +020058
Jens Axboe9e94cd42006-06-20 15:01:12 +020059 /*
60 * At least for ext2 with nobh option, we need to wait on
61 * writeback completing on this page, since we'll remove it
62 * from the pagecache. Otherwise truncate wont wait on the
63 * page, allowing the disk blocks to be reused by someone else
64 * before we actually wrote our data to them. fs corruption
65 * ensues.
66 */
67 wait_on_page_writeback(page);
Jens Axboead8d6f02006-04-02 23:10:32 +020068
David Howells266cf652009-04-03 16:42:36 +010069 if (page_has_private(page) &&
70 !try_to_release_page(page, GFP_KERNEL))
Jens Axboeca39d652008-05-20 21:27:41 +020071 goto out_unlock;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020072
Jens Axboe9e94cd42006-06-20 15:01:12 +020073 /*
74 * If we succeeded in removing the mapping, set LRU flag
75 * and return good.
76 */
77 if (remove_mapping(mapping, page)) {
78 buf->flags |= PIPE_BUF_FLAG_LRU;
79 return 0;
80 }
Jens Axboe9e0267c2006-04-19 15:57:31 +020081 }
Jens Axboe5abc97a2006-03-30 15:16:46 +020082
Jens Axboe9e94cd42006-06-20 15:01:12 +020083 /*
84 * Raced with truncate or failed to remove page from current
85 * address space, unlock and return failure.
86 */
Jens Axboeca39d652008-05-20 21:27:41 +020087out_unlock:
Jens Axboe9e94cd42006-06-20 15:01:12 +020088 unlock_page(page);
89 return 1;
Jens Axboe5abc97a2006-03-30 15:16:46 +020090}
91
Jens Axboe76ad4d12006-05-03 10:41:33 +020092static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +020093 struct pipe_buffer *buf)
94{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030095 put_page(buf->page);
Jens Axboe14328732006-05-03 10:35:26 +020096 buf->flags &= ~PIPE_BUF_FLAG_LRU;
Jens Axboe5274f052006-03-30 15:15:30 +020097}
98
Jens Axboe08457182007-06-12 20:51:32 +020099/*
100 * Check whether the contents of buf is OK to access. Since the content
101 * is a page cache page, IO may be in flight.
102 */
Jens Axboecac36bb02007-06-14 13:10:48 +0200103static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
104 struct pipe_buffer *buf)
Jens Axboe5274f052006-03-30 15:15:30 +0200105{
106 struct page *page = buf->page;
Jens Axboe49d0b212006-04-10 09:04:41 +0200107 int err;
Jens Axboe5274f052006-03-30 15:15:30 +0200108
109 if (!PageUptodate(page)) {
Jens Axboe49d0b212006-04-10 09:04:41 +0200110 lock_page(page);
111
112 /*
113 * Page got truncated/unhashed. This will cause a 0-byte
Ingo Molnar73d62d82006-04-11 13:57:21 +0200114 * splice, if this is the first page.
Jens Axboe49d0b212006-04-10 09:04:41 +0200115 */
116 if (!page->mapping) {
117 err = -ENODATA;
118 goto error;
119 }
120
121 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200122 * Uh oh, read-error from disk.
Jens Axboe49d0b212006-04-10 09:04:41 +0200123 */
124 if (!PageUptodate(page)) {
125 err = -EIO;
126 goto error;
127 }
128
129 /*
Jens Axboef84d7512006-05-01 19:59:03 +0200130 * Page is ok afterall, we are done.
Jens Axboe49d0b212006-04-10 09:04:41 +0200131 */
Jens Axboe5274f052006-03-30 15:15:30 +0200132 unlock_page(page);
Jens Axboe5274f052006-03-30 15:15:30 +0200133 }
134
Jens Axboef84d7512006-05-01 19:59:03 +0200135 return 0;
Jens Axboe49d0b212006-04-10 09:04:41 +0200136error:
137 unlock_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200138 return err;
Jens Axboe70524492006-04-11 15:51:17 +0200139}
140
Hugh Dickins708e3502011-07-25 17:12:32 -0700141const struct pipe_buf_operations page_cache_pipe_buf_ops = {
Jens Axboecac36bb02007-06-14 13:10:48 +0200142 .confirm = page_cache_pipe_buf_confirm,
Jens Axboe5274f052006-03-30 15:15:30 +0200143 .release = page_cache_pipe_buf_release,
Jens Axboe5abc97a2006-03-30 15:16:46 +0200144 .steal = page_cache_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200145 .get = generic_pipe_buf_get,
Jens Axboe5274f052006-03-30 15:15:30 +0200146};
147
Jens Axboe912d35f2006-04-26 10:59:21 +0200148static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
149 struct pipe_buffer *buf)
150{
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200151 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
152 return 1;
153
Jens Axboe14328732006-05-03 10:35:26 +0200154 buf->flags |= PIPE_BUF_FLAG_LRU;
Jens Axboe330ab712006-05-02 15:29:57 +0200155 return generic_pipe_buf_steal(pipe, buf);
Jens Axboe912d35f2006-04-26 10:59:21 +0200156}
157
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800158static const struct pipe_buf_operations user_page_pipe_buf_ops = {
Jens Axboecac36bb02007-06-14 13:10:48 +0200159 .confirm = generic_pipe_buf_confirm,
Jens Axboe912d35f2006-04-26 10:59:21 +0200160 .release = page_cache_pipe_buf_release,
161 .steal = user_page_pipe_buf_steal,
Jens Axboef84d7512006-05-01 19:59:03 +0200162 .get = generic_pipe_buf_get,
Jens Axboe912d35f2006-04-26 10:59:21 +0200163};
164
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200165static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
166{
167 smp_mb();
168 if (waitqueue_active(&pipe->wait))
169 wake_up_interruptible(&pipe->wait);
170 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
171}
172
Jens Axboe932cc6d2007-06-21 13:10:21 +0200173/**
174 * splice_to_pipe - fill passed data into a pipe
175 * @pipe: pipe to fill
176 * @spd: data to fill
177 *
178 * Description:
Randy Dunlap79685b82007-07-27 08:08:51 +0200179 * @spd contains a map of pages and len/offset tuples, along with
Jens Axboe932cc6d2007-06-21 13:10:21 +0200180 * the struct pipe_buf_operations associated with these pages. This
181 * function will link that data to the pipe.
182 *
Jens Axboe83f91352006-04-02 23:05:09 +0200183 */
Jens Axboed6b29d72007-06-04 09:59:47 +0200184ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
185 struct splice_pipe_desc *spd)
Jens Axboe5274f052006-03-30 15:15:30 +0200186{
Jens Axboe00de00b2007-06-15 13:14:22 +0200187 unsigned int spd_pages = spd->nr_pages;
Al Viro8924fef2016-09-17 20:44:45 -0400188 int ret = 0, page_nr = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200189
Rabin Vincentd6785d92016-03-10 21:19:06 +0100190 if (!spd_pages)
191 return 0;
192
Al Viro8924fef2016-09-17 20:44:45 -0400193 if (unlikely(!pipe->readers)) {
194 send_sig(SIGPIPE, current, 0);
195 ret = -EPIPE;
196 goto out;
Jens Axboe5274f052006-03-30 15:15:30 +0200197 }
198
Al Viro8924fef2016-09-17 20:44:45 -0400199 while (pipe->nrbufs < pipe->buffers) {
200 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
201 struct pipe_buffer *buf = pipe->bufs + newbuf;
Jens Axboe5274f052006-03-30 15:15:30 +0200202
Al Viro8924fef2016-09-17 20:44:45 -0400203 buf->page = spd->pages[page_nr];
204 buf->offset = spd->partial[page_nr].offset;
205 buf->len = spd->partial[page_nr].len;
206 buf->private = spd->partial[page_nr].private;
207 buf->ops = spd->ops;
Miklos Szeredi5a81e6a2017-02-16 17:49:02 +0100208 buf->flags = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200209
Al Viro8924fef2016-09-17 20:44:45 -0400210 pipe->nrbufs++;
211 page_nr++;
212 ret += buf->len;
213
214 if (!--spd->nr_pages)
215 break;
216 }
217
218 if (!ret)
219 ret = -EAGAIN;
220
221out:
Jens Axboe00de00b2007-06-15 13:14:22 +0200222 while (page_nr < spd_pages)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800223 spd->spd_release(spd, page_nr++);
Jens Axboe5274f052006-03-30 15:15:30 +0200224
225 return ret;
226}
Hannes Frederic Sowa2b514572015-05-21 17:00:01 +0200227EXPORT_SYMBOL_GPL(splice_to_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200228
Al Viro79fddc42016-09-17 22:38:20 -0400229ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
230{
231 int ret;
232
233 if (unlikely(!pipe->readers)) {
234 send_sig(SIGPIPE, current, 0);
235 ret = -EPIPE;
236 } else if (pipe->nrbufs == pipe->buffers) {
237 ret = -EAGAIN;
238 } else {
239 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
240 pipe->bufs[newbuf] = *buf;
241 pipe->nrbufs++;
242 return buf->len;
243 }
Miklos Szeredia7796382016-09-27 10:45:12 +0200244 pipe_buf_release(pipe, buf);
Al Viro79fddc42016-09-17 22:38:20 -0400245 return ret;
246}
247EXPORT_SYMBOL(add_to_pipe);
248
Jens Axboe35f3d142010-05-20 10:43:18 +0200249/*
250 * Check if we need to grow the arrays holding pages and partial page
251 * descriptions.
252 */
Eric Dumazet047fe362012-06-12 15:24:40 +0200253int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200254{
Mark Rutland6aa7de02017-10-23 14:07:29 -0700255 unsigned int buffers = READ_ONCE(pipe->buffers);
Eric Dumazet047fe362012-06-12 15:24:40 +0200256
257 spd->nr_pages_max = buffers;
258 if (buffers <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200259 return 0;
260
Kees Cook6da2ec52018-06-12 13:55:00 -0700261 spd->pages = kmalloc_array(buffers, sizeof(struct page *), GFP_KERNEL);
262 spd->partial = kmalloc_array(buffers, sizeof(struct partial_page),
263 GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200264
265 if (spd->pages && spd->partial)
266 return 0;
267
268 kfree(spd->pages);
269 kfree(spd->partial);
270 return -ENOMEM;
271}
272
Eric Dumazet047fe362012-06-12 15:24:40 +0200273void splice_shrink_spd(struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200274{
Eric Dumazet047fe362012-06-12 15:24:40 +0200275 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200276 return;
277
278 kfree(spd->pages);
279 kfree(spd->partial);
280}
281
Jens Axboe83f91352006-04-02 23:05:09 +0200282/**
283 * generic_file_splice_read - splice data from file to a pipe
284 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200285 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200286 * @pipe: pipe to splice to
287 * @len: number of bytes to splice
288 * @flags: splice modifier flags
289 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200290 * Description:
291 * Will read pages from given file and fill them into a pipe. Can be
Al Viro82c156f2016-09-22 23:35:42 -0400292 * used as long as it has more or less sane ->read_iter().
Jens Axboe932cc6d2007-06-21 13:10:21 +0200293 *
Jens Axboe83f91352006-04-02 23:05:09 +0200294 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200295ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
296 struct pipe_inode_info *pipe, size_t len,
297 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200298{
Al Viro82c156f2016-09-22 23:35:42 -0400299 struct iov_iter to;
300 struct kiocb kiocb;
Al Viro82c156f2016-09-22 23:35:42 -0400301 int idx, ret;
Boaz Harroshbe64f882015-04-15 16:15:17 -0700302
David Howellsaa563d72018-10-20 00:57:56 +0100303 iov_iter_pipe(&to, READ, pipe, len);
Al Viro82c156f2016-09-22 23:35:42 -0400304 idx = to.idx;
305 init_sync_kiocb(&kiocb, in);
306 kiocb.ki_pos = *ppos;
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100307 ret = call_read_iter(in, &kiocb, &to);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200308 if (ret > 0) {
Al Viro82c156f2016-09-22 23:35:42 -0400309 *ppos = kiocb.ki_pos;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200310 file_accessed(in);
Al Viro82c156f2016-09-22 23:35:42 -0400311 } else if (ret < 0) {
Al Viroc3a69022016-10-10 13:26:27 -0400312 to.idx = idx;
313 to.iov_offset = 0;
314 iov_iter_advance(&to, 0); /* to free what was emitted */
Al Viro82c156f2016-09-22 23:35:42 -0400315 /*
316 * callers of ->splice_read() expect -EAGAIN on
317 * "can't put anything in there", rather than -EFAULT.
318 */
319 if (ret == -EFAULT)
320 ret = -EAGAIN;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200321 }
Jens Axboe5274f052006-03-30 15:15:30 +0200322
323 return ret;
324}
Jens Axboe059a8f32006-04-02 23:06:05 +0200325EXPORT_SYMBOL(generic_file_splice_read);
326
Al Viro241699c2016-09-22 16:33:12 -0400327const struct pipe_buf_operations default_pipe_buf_ops = {
Miklos Szeredi68181732009-05-07 15:37:36 +0200328 .confirm = generic_pipe_buf_confirm,
329 .release = generic_pipe_buf_release,
330 .steal = generic_pipe_buf_steal,
331 .get = generic_pipe_buf_get,
332};
333
Jann Hornb9872222019-04-04 23:59:25 +0200334int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
335 struct pipe_buffer *buf)
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100336{
337 return 1;
338}
339
340/* Pipe buffer operations for a socket and similar. */
341const struct pipe_buf_operations nosteal_pipe_buf_ops = {
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100342 .confirm = generic_pipe_buf_confirm,
343 .release = generic_pipe_buf_release,
344 .steal = generic_pipe_buf_nosteal,
345 .get = generic_pipe_buf_get,
346};
347EXPORT_SYMBOL(nosteal_pipe_buf_ops);
348
Al Viro523ac9a2016-09-23 15:34:57 -0400349static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
Miklos Szeredi68181732009-05-07 15:37:36 +0200350 unsigned long vlen, loff_t offset)
351{
352 mm_segment_t old_fs;
353 loff_t pos = offset;
354 ssize_t res;
355
356 old_fs = get_fs();
Linus Torvalds736706b2019-03-04 10:39:05 -0800357 set_fs(KERNEL_DS);
Miklos Szeredi68181732009-05-07 15:37:36 +0200358 /* The cast to a user pointer is valid due to the set_fs() */
Christoph Hellwig793b80e2016-03-03 16:03:58 +0100359 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
Miklos Szeredi68181732009-05-07 15:37:36 +0200360 set_fs(old_fs);
361
362 return res;
363}
364
Al Viro82c156f2016-09-22 23:35:42 -0400365static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
Miklos Szeredi68181732009-05-07 15:37:36 +0200366 struct pipe_inode_info *pipe, size_t len,
367 unsigned int flags)
368{
Al Viro523ac9a2016-09-23 15:34:57 -0400369 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
370 struct iov_iter to;
371 struct page **pages;
Miklos Szeredi68181732009-05-07 15:37:36 +0200372 unsigned int nr_pages;
Al Viro13c0f522016-12-10 13:20:53 -0500373 size_t offset, base, copied = 0;
Miklos Szeredi68181732009-05-07 15:37:36 +0200374 ssize_t res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200375 int i;
Miklos Szeredi68181732009-05-07 15:37:36 +0200376
Al Viro523ac9a2016-09-23 15:34:57 -0400377 if (pipe->nrbufs == pipe->buffers)
378 return -EAGAIN;
379
380 /*
381 * Try to keep page boundaries matching to source pagecache ones -
382 * it probably won't be much help, but...
383 */
384 offset = *ppos & ~PAGE_MASK;
385
David Howellsaa563d72018-10-20 00:57:56 +0100386 iov_iter_pipe(&to, READ, pipe, len + offset);
Al Viro523ac9a2016-09-23 15:34:57 -0400387
Al Viro13c0f522016-12-10 13:20:53 -0500388 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &base);
Al Viro523ac9a2016-09-23 15:34:57 -0400389 if (res <= 0)
Jens Axboe35f3d142010-05-20 10:43:18 +0200390 return -ENOMEM;
391
Al Viro13c0f522016-12-10 13:20:53 -0500392 nr_pages = DIV_ROUND_UP(res + base, PAGE_SIZE);
Al Viro523ac9a2016-09-23 15:34:57 -0400393
Jens Axboe35f3d142010-05-20 10:43:18 +0200394 vec = __vec;
Al Viro523ac9a2016-09-23 15:34:57 -0400395 if (nr_pages > PIPE_DEF_BUFFERS) {
Kees Cook6da2ec52018-06-12 13:55:00 -0700396 vec = kmalloc_array(nr_pages, sizeof(struct kvec), GFP_KERNEL);
Al Viro523ac9a2016-09-23 15:34:57 -0400397 if (unlikely(!vec)) {
398 res = -ENOMEM;
399 goto out;
400 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200401 }
402
Al Viro523ac9a2016-09-23 15:34:57 -0400403 pipe->bufs[to.idx].offset = offset;
404 pipe->bufs[to.idx].len -= offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200405
Al Viro523ac9a2016-09-23 15:34:57 -0400406 for (i = 0; i < nr_pages; i++) {
407 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
408 vec[i].iov_base = page_address(pages[i]) + offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200409 vec[i].iov_len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200410 len -= this_len;
411 offset = 0;
412 }
413
Al Viro523ac9a2016-09-23 15:34:57 -0400414 res = kernel_readv(in, vec, nr_pages, *ppos);
415 if (res > 0) {
416 copied = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200417 *ppos += res;
Al Viro523ac9a2016-09-23 15:34:57 -0400418 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200419
Jens Axboe35f3d142010-05-20 10:43:18 +0200420 if (vec != __vec)
421 kfree(vec);
Al Viro523ac9a2016-09-23 15:34:57 -0400422out:
423 for (i = 0; i < nr_pages; i++)
424 put_page(pages[i]);
425 kvfree(pages);
426 iov_iter_advance(&to, copied); /* truncates and discards */
Miklos Szeredi68181732009-05-07 15:37:36 +0200427 return res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200428}
Miklos Szeredi68181732009-05-07 15:37:36 +0200429
Jens Axboe5274f052006-03-30 15:15:30 +0200430/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200431 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200432 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200433 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200434static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200435 struct pipe_buffer *buf, struct splice_desc *sd)
436{
Jens Axboe6a14b902007-06-14 13:08:55 +0200437 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200438 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100439 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200440
Al Viro72c2d532013-09-22 16:27:52 -0400441 if (!likely(file->f_op->sendpage))
Michał Mirosława8adbe32010-12-17 08:56:44 +0100442 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200443
Eric Dumazet35f9c092012-04-05 03:05:35 +0000444 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000445
446 if (sd->len < sd->total_len && pipe->nrbufs > 1)
Eric Dumazet35f9c092012-04-05 03:05:35 +0000447 more |= MSG_SENDPAGE_NOTLAST;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000448
Michał Mirosława8adbe32010-12-17 08:56:44 +0100449 return file->f_op->sendpage(file, buf->page, buf->offset,
450 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200451}
452
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200453static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
454{
455 smp_mb();
456 if (waitqueue_active(&pipe->wait))
457 wake_up_interruptible(&pipe->wait);
458 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
459}
460
461/**
462 * splice_from_pipe_feed - feed available data from a pipe to a file
463 * @pipe: pipe to splice from
464 * @sd: information to @actor
465 * @actor: handler that splices the data
466 *
467 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200468 * This function loops over the pipe and calls @actor to do the
469 * actual moving of a single struct pipe_buffer to the desired
470 * destination. It returns when there's no more buffers left in
471 * the pipe or if the requested number of bytes (@sd->total_len)
472 * have been copied. It returns a positive number (one) if the
473 * pipe needs to be filled with more data, zero if the required
474 * number of bytes have been copied and -errno on error.
475 *
476 * This, together with splice_from_pipe_{begin,end,next}, may be
477 * used to implement the functionality of __splice_from_pipe() when
478 * locking is required around copying the pipe buffers to the
479 * destination.
480 */
Al Viro96f9bc82014-04-05 04:35:49 -0400481static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200482 splice_actor *actor)
483{
484 int ret;
485
486 while (pipe->nrbufs) {
487 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200488
489 sd->len = buf->len;
490 if (sd->len > sd->total_len)
491 sd->len = sd->total_len;
492
Miklos Szeredifba597d2016-09-27 10:45:12 +0200493 ret = pipe_buf_confirm(pipe, buf);
Michał Mirosława8adbe32010-12-17 08:56:44 +0100494 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200495 if (ret == -ENODATA)
496 ret = 0;
497 return ret;
498 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100499
500 ret = actor(pipe, buf, sd);
501 if (ret <= 0)
502 return ret;
503
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200504 buf->offset += ret;
505 buf->len -= ret;
506
507 sd->num_spliced += ret;
508 sd->len -= ret;
509 sd->pos += ret;
510 sd->total_len -= ret;
511
512 if (!buf->len) {
Miklos Szeredia7796382016-09-27 10:45:12 +0200513 pipe_buf_release(pipe, buf);
Jens Axboe35f3d142010-05-20 10:43:18 +0200514 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200515 pipe->nrbufs--;
Al Viro6447a3c2013-03-21 11:01:38 -0400516 if (pipe->files)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200517 sd->need_wakeup = true;
518 }
519
520 if (!sd->total_len)
521 return 0;
522 }
523
524 return 1;
525}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200526
527/**
528 * splice_from_pipe_next - wait for some data to splice from
529 * @pipe: pipe to splice from
530 * @sd: information about the splice operation
531 *
532 * Description:
533 * This function will wait for some data and return a positive
534 * value (one) if pipe buffers are available. It will return zero
535 * or -errno if no more data needs to be spliced.
536 */
Al Viro96f9bc82014-04-05 04:35:49 -0400537static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200538{
Jan Karac725bfc2015-11-23 13:09:50 +0100539 /*
540 * Check for signal early to make process killable when there are
541 * always buffers available
542 */
543 if (signal_pending(current))
544 return -ERESTARTSYS;
545
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200546 while (!pipe->nrbufs) {
547 if (!pipe->writers)
548 return 0;
549
550 if (!pipe->waiting_writers && sd->num_spliced)
551 return 0;
552
553 if (sd->flags & SPLICE_F_NONBLOCK)
554 return -EAGAIN;
555
556 if (signal_pending(current))
557 return -ERESTARTSYS;
558
559 if (sd->need_wakeup) {
560 wakeup_pipe_writers(pipe);
561 sd->need_wakeup = false;
562 }
563
564 pipe_wait(pipe);
565 }
566
567 return 1;
568}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200569
570/**
571 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700572 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200573 *
574 * Description:
575 * This function should be called before a loop containing
576 * splice_from_pipe_next() and splice_from_pipe_feed() to
577 * initialize the necessary fields of @sd.
578 */
Al Viro96f9bc82014-04-05 04:35:49 -0400579static void splice_from_pipe_begin(struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200580{
581 sd->num_spliced = 0;
582 sd->need_wakeup = false;
583}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200584
585/**
586 * splice_from_pipe_end - finish splicing from pipe
587 * @pipe: pipe to splice from
588 * @sd: information about the splice operation
589 *
590 * Description:
591 * This function will wake up pipe writers if necessary. It should
592 * be called after a loop containing splice_from_pipe_next() and
593 * splice_from_pipe_feed().
594 */
Al Viro96f9bc82014-04-05 04:35:49 -0400595static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200596{
597 if (sd->need_wakeup)
598 wakeup_pipe_writers(pipe);
599}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200600
Jens Axboe932cc6d2007-06-21 13:10:21 +0200601/**
602 * __splice_from_pipe - splice data from a pipe to given actor
603 * @pipe: pipe to splice from
604 * @sd: information to @actor
605 * @actor: handler that splices the data
606 *
607 * Description:
608 * This function does little more than loop over the pipe and call
609 * @actor to do the actual moving of a single struct pipe_buffer to
610 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
611 * pipe_to_user.
612 *
Jens Axboe83f91352006-04-02 23:05:09 +0200613 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200614ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
615 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200616{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200617 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200618
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200619 splice_from_pipe_begin(sd);
620 do {
Jan Karac2489e02015-11-23 13:09:51 +0100621 cond_resched();
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200622 ret = splice_from_pipe_next(pipe, sd);
623 if (ret > 0)
624 ret = splice_from_pipe_feed(pipe, sd, actor);
625 } while (ret > 0);
626 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200627
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200628 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200629}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100630EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200631
Jens Axboe932cc6d2007-06-21 13:10:21 +0200632/**
633 * splice_from_pipe - splice data from a pipe to a file
634 * @pipe: pipe to splice from
635 * @out: file to splice to
636 * @ppos: position in @out
637 * @len: how many bytes to splice
638 * @flags: splice modifier flags
639 * @actor: handler that splices the data
640 *
641 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200642 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200643 * otherwise it's identical to __splice_from_pipe().
644 *
645 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200646ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
647 loff_t *ppos, size_t len, unsigned int flags,
648 splice_actor *actor)
649{
650 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200651 struct splice_desc sd = {
652 .total_len = len,
653 .flags = flags,
654 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200655 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200656 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200657
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200658 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200659 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200660 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200661
662 return ret;
663}
664
665/**
Al Viro8d020762014-04-05 04:27:08 -0400666 * iter_file_splice_write - splice data from a pipe to a file
667 * @pipe: pipe info
668 * @out: file to write to
669 * @ppos: position in @out
670 * @len: number of bytes to splice
671 * @flags: splice modifier flags
672 *
673 * Description:
674 * Will either move or copy pages (determined by @flags options) from
675 * the given pipe inode to the given file.
676 * This one is ->write_iter-based.
677 *
678 */
679ssize_t
680iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
681 loff_t *ppos, size_t len, unsigned int flags)
682{
683 struct splice_desc sd = {
684 .total_len = len,
685 .flags = flags,
686 .pos = *ppos,
687 .u.file = out,
688 };
689 int nbufs = pipe->buffers;
690 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
691 GFP_KERNEL);
692 ssize_t ret;
693
694 if (unlikely(!array))
695 return -ENOMEM;
696
697 pipe_lock(pipe);
698
699 splice_from_pipe_begin(&sd);
700 while (sd.total_len) {
701 struct iov_iter from;
Al Viro8d020762014-04-05 04:27:08 -0400702 size_t left;
703 int n, idx;
704
705 ret = splice_from_pipe_next(pipe, &sd);
706 if (ret <= 0)
707 break;
708
709 if (unlikely(nbufs < pipe->buffers)) {
710 kfree(array);
711 nbufs = pipe->buffers;
712 array = kcalloc(nbufs, sizeof(struct bio_vec),
713 GFP_KERNEL);
714 if (!array) {
715 ret = -ENOMEM;
716 break;
717 }
718 }
719
720 /* build the vector */
721 left = sd.total_len;
722 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
723 struct pipe_buffer *buf = pipe->bufs + idx;
724 size_t this_len = buf->len;
725
726 if (this_len > left)
727 this_len = left;
728
729 if (idx == pipe->buffers - 1)
730 idx = -1;
731
Miklos Szeredifba597d2016-09-27 10:45:12 +0200732 ret = pipe_buf_confirm(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400733 if (unlikely(ret)) {
734 if (ret == -ENODATA)
735 ret = 0;
736 goto done;
737 }
738
739 array[n].bv_page = buf->page;
740 array[n].bv_len = this_len;
741 array[n].bv_offset = buf->offset;
742 left -= this_len;
743 }
744
David Howellsaa563d72018-10-20 00:57:56 +0100745 iov_iter_bvec(&from, WRITE, array, n, sd.total_len - left);
Christoph Hellwigabbb65892017-05-27 11:16:52 +0300746 ret = vfs_iter_write(out, &from, &sd.pos, 0);
Al Viro8d020762014-04-05 04:27:08 -0400747 if (ret <= 0)
748 break;
749
750 sd.num_spliced += ret;
751 sd.total_len -= ret;
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100752 *ppos = sd.pos;
Al Viro8d020762014-04-05 04:27:08 -0400753
754 /* dismiss the fully eaten buffers, adjust the partial one */
755 while (ret) {
756 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
757 if (ret >= buf->len) {
Al Viro8d020762014-04-05 04:27:08 -0400758 ret -= buf->len;
759 buf->len = 0;
Miklos Szeredia7796382016-09-27 10:45:12 +0200760 pipe_buf_release(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400761 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
762 pipe->nrbufs--;
763 if (pipe->files)
764 sd.need_wakeup = true;
765 } else {
766 buf->offset += ret;
767 buf->len -= ret;
768 ret = 0;
769 }
770 }
771 }
772done:
773 kfree(array);
774 splice_from_pipe_end(pipe, &sd);
775
776 pipe_unlock(pipe);
777
778 if (sd.num_spliced)
779 ret = sd.num_spliced;
780
781 return ret;
782}
783
784EXPORT_SYMBOL(iter_file_splice_write);
785
Miklos Szeredib2858d72009-05-19 11:37:46 +0200786static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
787 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200788{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200789 int ret;
790 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -0400791 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +0200792
Al Virofbb32752014-02-02 21:09:54 -0500793 data = kmap(buf->page);
Al Viro06ae43f2013-03-20 13:19:30 -0400794 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Al Virofbb32752014-02-02 21:09:54 -0500795 kunmap(buf->page);
Miklos Szeredib2858d72009-05-19 11:37:46 +0200796
797 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200798}
799
800static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
801 struct file *out, loff_t *ppos,
802 size_t len, unsigned int flags)
803{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200804 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200805
Miklos Szeredib2858d72009-05-19 11:37:46 +0200806 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
807 if (ret > 0)
808 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200809
Miklos Szeredib2858d72009-05-19 11:37:46 +0200810 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200811}
812
Jens Axboe83f91352006-04-02 23:05:09 +0200813/**
814 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200815 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200816 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200817 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200818 * @len: number of bytes to splice
819 * @flags: splice modifier flags
820 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200821 * Description:
822 * Will send @len bytes from the pipe to a network socket. No data copying
823 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200824 *
825 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200826ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200827 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200828{
Jens Axboe00522fb2006-04-26 14:39:29 +0200829 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200830}
831
Jens Axboe059a8f32006-04-02 23:06:05 +0200832EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500833
Jens Axboe83f91352006-04-02 23:05:09 +0200834/*
835 * Attempt to initiate a splice from pipe to file.
836 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200837static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200838 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200839{
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200840 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
841 loff_t *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200842
Al Viro72c2d532013-09-22 16:27:52 -0400843 if (out->f_op->splice_write)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100844 splice_write = out->f_op->splice_write;
845 else
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200846 splice_write = default_file_splice_write;
847
Al Viro500368f2013-05-23 20:07:11 -0400848 return splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200849}
850
Jens Axboe83f91352006-04-02 23:05:09 +0200851/*
852 * Attempt to initiate a splice from a file to a pipe.
853 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200854static long do_splice_to(struct file *in, loff_t *ppos,
855 struct pipe_inode_info *pipe, size_t len,
856 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200857{
Miklos Szeredi68181732009-05-07 15:37:36 +0200858 ssize_t (*splice_read)(struct file *, loff_t *,
859 struct pipe_inode_info *, size_t, unsigned int);
Jens Axboe5274f052006-03-30 15:15:30 +0200860 int ret;
861
Jens Axboe49570e92006-04-11 13:56:09 +0200862 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200863 return -EBADF;
864
Jens Axboecbb7e572006-04-11 14:57:50 +0200865 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200866 if (unlikely(ret < 0))
867 return ret;
868
Al Viro03cc0782016-04-02 14:56:58 -0400869 if (unlikely(len > MAX_RW_COUNT))
870 len = MAX_RW_COUNT;
871
Al Viro72c2d532013-09-22 16:27:52 -0400872 if (in->f_op->splice_read)
Changli Gaocc56f7d2009-11-04 09:09:52 +0100873 splice_read = in->f_op->splice_read;
874 else
Miklos Szeredi68181732009-05-07 15:37:36 +0200875 splice_read = default_file_splice_read;
876
877 return splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200878}
879
Jens Axboe932cc6d2007-06-21 13:10:21 +0200880/**
881 * splice_direct_to_actor - splices data directly between two non-pipes
882 * @in: file to splice from
883 * @sd: actor information on where to splice to
884 * @actor: handles the data splicing
885 *
886 * Description:
887 * This is a special case helper to splice directly between two
888 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200889 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200890 * that process.
891 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200892 */
893ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
894 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200895{
896 struct pipe_inode_info *pipe;
897 long ret, bytes;
898 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200899 size_t len;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200900 int i, flags, more;
Jens Axboeb92ce552006-04-11 13:52:07 +0200901
902 /*
903 * We require the input being a regular file, as we don't want to
904 * randomly drop data for eg socket -> socket splicing. Use the
905 * piped splicing for that!
906 */
Al Viro496ad9a2013-01-23 17:07:38 -0500907 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200908 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
909 return -EINVAL;
910
911 /*
912 * neither in nor out is a pipe, setup an internal pipe attached to
913 * 'out' and transfer the wanted data from 'in' to 'out' through that
914 */
915 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200916 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -0400917 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +0200918 if (!pipe)
919 return -ENOMEM;
920
921 /*
922 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200923 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200924 * PIPE_READERS appropriately.
925 */
926 pipe->readers = 1;
927
928 current->splice_pipe = pipe;
929 }
930
931 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200932 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200933 */
934 ret = 0;
935 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200936 len = sd->total_len;
937 flags = sd->flags;
938
939 /*
940 * Don't block on output, we have to drain the direct pipe.
941 */
942 sd->flags &= ~SPLICE_F_NONBLOCK;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200943 more = sd->flags & SPLICE_F_MORE;
Jens Axboeb92ce552006-04-11 13:52:07 +0200944
Darrick J. Wong17614442018-11-30 10:37:49 -0800945 WARN_ON_ONCE(pipe->nrbufs != 0);
946
Jens Axboeb92ce552006-04-11 13:52:07 +0200947 while (len) {
Jens Axboe51a92c02007-07-13 14:11:43 +0200948 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200949 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200950
Darrick J. Wong17614442018-11-30 10:37:49 -0800951 /* Don't try to read more the pipe has space for. */
952 read_len = min_t(size_t, len,
953 (pipe->buffers - pipe->nrbufs) << PAGE_SHIFT);
954 ret = do_splice_to(in, &pos, pipe, read_len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200955 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +0200956 goto out_release;
957
958 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200959 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +0200960
961 /*
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200962 * If more data is pending, set SPLICE_F_MORE
963 * If this is the last data and SPLICE_F_MORE was not set
964 * initially, clears it.
965 */
966 if (read_len < len)
967 sd->flags |= SPLICE_F_MORE;
968 else if (!more)
969 sd->flags &= ~SPLICE_F_MORE;
970 /*
Jens Axboeb92ce552006-04-11 13:52:07 +0200971 * NOTE: nonblocking mode only applies to the input. We
972 * must not do the output in nonblocking mode as then we
973 * could get stuck data in the internal pipe:
974 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200975 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +0200976 if (unlikely(ret <= 0)) {
977 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200978 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200979 }
Jens Axboeb92ce552006-04-11 13:52:07 +0200980
981 bytes += ret;
982 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200983 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200984
Tom Zanussia82c53a2008-05-09 13:28:36 +0200985 if (ret < read_len) {
986 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +0200987 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200988 }
Jens Axboeb92ce552006-04-11 13:52:07 +0200989 }
990
Jens Axboe9e971982008-01-29 21:05:57 +0100991done:
Jens Axboeb92ce552006-04-11 13:52:07 +0200992 pipe->nrbufs = pipe->curbuf = 0;
Jens Axboe80848702008-01-30 12:24:48 +0100993 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +0200994 return bytes;
995
996out_release:
997 /*
998 * If we did an incomplete transfer we must release
999 * the pipe buffers in question:
1000 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001001 for (i = 0; i < pipe->buffers; i++) {
Jens Axboeb92ce552006-04-11 13:52:07 +02001002 struct pipe_buffer *buf = pipe->bufs + i;
1003
Miklos Szeredia7796382016-09-27 10:45:12 +02001004 if (buf->ops)
1005 pipe_buf_release(pipe, buf);
Jens Axboeb92ce552006-04-11 13:52:07 +02001006 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001007
Jens Axboe9e971982008-01-29 21:05:57 +01001008 if (!bytes)
1009 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001010
Jens Axboe9e971982008-01-29 21:05:57 +01001011 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001012}
1013EXPORT_SYMBOL(splice_direct_to_actor);
1014
1015static int direct_splice_actor(struct pipe_inode_info *pipe,
1016 struct splice_desc *sd)
1017{
Jens Axboe6a14b902007-06-14 13:08:55 +02001018 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001019
Al Viro7995bd22013-06-20 18:58:36 +04001020 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001021 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001022}
1023
Jens Axboe932cc6d2007-06-21 13:10:21 +02001024/**
1025 * do_splice_direct - splices data directly between two files
1026 * @in: file to splice from
1027 * @ppos: input file offset
1028 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001029 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001030 * @len: number of bytes to splice
1031 * @flags: splice modifier flags
1032 *
1033 * Description:
1034 * For use by do_sendfile(). splice can easily emulate sendfile, but
1035 * doing it in the application would incur an extra system call
1036 * (splice in + splice out, as compared to just sendfile()). So this helper
1037 * can splice directly through a process-private pipe.
1038 *
1039 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001040long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001041 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001042{
1043 struct splice_desc sd = {
1044 .len = len,
1045 .total_len = len,
1046 .flags = flags,
1047 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001048 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001049 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001050 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001051 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001052
Al Viro18c67cb2013-06-19 15:41:54 +04001053 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1054 return -EBADF;
1055
1056 if (unlikely(out->f_flags & O_APPEND))
1057 return -EINVAL;
1058
1059 ret = rw_verify_area(WRITE, out, opos, len);
1060 if (unlikely(ret < 0))
1061 return ret;
1062
Jens Axboec66ab6f2007-06-12 21:17:17 +02001063 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001064 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001065 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001066
Jens Axboec66ab6f2007-06-12 21:17:17 +02001067 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001068}
Miklos Szeredi1c118592014-10-24 00:14:35 +02001069EXPORT_SYMBOL(do_splice_direct);
Jens Axboeb92ce552006-04-11 13:52:07 +02001070
Al Viro8924fef2016-09-17 20:44:45 -04001071static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1072{
Linus Torvalds52bce912016-12-21 10:59:34 -08001073 for (;;) {
1074 if (unlikely(!pipe->readers)) {
1075 send_sig(SIGPIPE, current, 0);
1076 return -EPIPE;
1077 }
1078 if (pipe->nrbufs != pipe->buffers)
1079 return 0;
Al Viro8924fef2016-09-17 20:44:45 -04001080 if (flags & SPLICE_F_NONBLOCK)
1081 return -EAGAIN;
1082 if (signal_pending(current))
1083 return -ERESTARTSYS;
1084 pipe->waiting_writers++;
1085 pipe_wait(pipe);
1086 pipe->waiting_writers--;
1087 }
Al Viro8924fef2016-09-17 20:44:45 -04001088}
1089
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001090static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1091 struct pipe_inode_info *opipe,
1092 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001093
1094/*
Jens Axboe83f91352006-04-02 23:05:09 +02001095 * Determine where to splice to/from.
1096 */
Ingo Molnar529565dc2006-04-10 15:18:58 +02001097static long do_splice(struct file *in, loff_t __user *off_in,
1098 struct file *out, loff_t __user *off_out,
1099 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001100{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001101 struct pipe_inode_info *ipipe;
1102 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001103 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001104 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001105
Linus Torvalds71993e62010-11-28 13:56:09 -08001106 ipipe = get_pipe_info(in);
1107 opipe = get_pipe_info(out);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001108
1109 if (ipipe && opipe) {
1110 if (off_in || off_out)
1111 return -ESPIPE;
1112
1113 if (!(in->f_mode & FMODE_READ))
1114 return -EBADF;
1115
1116 if (!(out->f_mode & FMODE_WRITE))
1117 return -EBADF;
1118
1119 /* Splicing to self would be fun, but... */
1120 if (ipipe == opipe)
1121 return -EINVAL;
1122
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001123 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1124 flags |= SPLICE_F_NONBLOCK;
1125
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001126 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1127 }
1128
1129 if (ipipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001130 if (off_in)
1131 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001132 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001133 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001134 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001135 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001136 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001137 } else {
1138 offset = out->f_pos;
1139 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001140
Al Viro18c67cb2013-06-19 15:41:54 +04001141 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1142 return -EBADF;
1143
1144 if (unlikely(out->f_flags & O_APPEND))
1145 return -EINVAL;
1146
1147 ret = rw_verify_area(WRITE, out, &offset, len);
1148 if (unlikely(ret < 0))
1149 return ret;
1150
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001151 if (in->f_flags & O_NONBLOCK)
1152 flags |= SPLICE_F_NONBLOCK;
1153
Al Viro500368f2013-05-23 20:07:11 -04001154 file_start_write(out);
Al Viro7995bd22013-06-20 18:58:36 +04001155 ret = do_splice_from(ipipe, out, &offset, len, flags);
Al Viro500368f2013-05-23 20:07:11 -04001156 file_end_write(out);
Jens Axboea4514eb2006-04-19 15:57:05 +02001157
Al Viro7995bd22013-06-20 18:58:36 +04001158 if (!off_out)
1159 out->f_pos = offset;
1160 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001161 ret = -EFAULT;
1162
1163 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001164 }
Jens Axboe5274f052006-03-30 15:15:30 +02001165
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001166 if (opipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001167 if (off_out)
1168 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001169 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001170 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001171 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001172 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001173 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001174 } else {
1175 offset = in->f_pos;
1176 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001177
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001178 if (out->f_flags & O_NONBLOCK)
1179 flags |= SPLICE_F_NONBLOCK;
1180
Al Viro8924fef2016-09-17 20:44:45 -04001181 pipe_lock(opipe);
1182 ret = wait_for_space(opipe, flags);
1183 if (!ret)
1184 ret = do_splice_to(in, &offset, opipe, len, flags);
1185 pipe_unlock(opipe);
1186 if (ret > 0)
1187 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001188 if (!off_in)
1189 in->f_pos = offset;
1190 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001191 ret = -EFAULT;
1192
1193 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001194 }
Jens Axboe5274f052006-03-30 15:15:30 +02001195
1196 return -EINVAL;
1197}
1198
Al Viro79fddc42016-09-17 22:38:20 -04001199static int iter_to_pipe(struct iov_iter *from,
1200 struct pipe_inode_info *pipe,
1201 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001202{
Al Viro79fddc42016-09-17 22:38:20 -04001203 struct pipe_buffer buf = {
1204 .ops = &user_page_pipe_buf_ops,
1205 .flags = flags
1206 };
1207 size_t total = 0;
1208 int ret = 0;
1209 bool failed = false;
1210
1211 while (iov_iter_count(from) && !failed) {
1212 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001213 ssize_t copied;
1214 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001215 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001216
Al Viro79fddc42016-09-17 22:38:20 -04001217 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1218 if (copied <= 0) {
1219 ret = copied;
1220 break;
1221 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001222
Al Viro79fddc42016-09-17 22:38:20 -04001223 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001224 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001225 if (!failed) {
1226 buf.page = pages[n];
1227 buf.offset = start;
1228 buf.len = size;
1229 ret = add_to_pipe(pipe, &buf);
1230 if (unlikely(ret < 0)) {
1231 failed = true;
1232 } else {
1233 iov_iter_advance(from, ret);
1234 total += ret;
1235 }
1236 } else {
1237 put_page(pages[n]);
1238 }
Al Virodb85a9e2016-09-17 20:25:06 -04001239 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001240 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001241 }
Al Viro79fddc42016-09-17 22:38:20 -04001242 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001243}
1244
Jens Axboe6a14b902007-06-14 13:08:55 +02001245static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1246 struct splice_desc *sd)
1247{
Al Viro6130f532014-02-03 18:19:51 -05001248 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1249 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001250}
1251
1252/*
1253 * For lack of a better implementation, implement vmsplice() to userspace
1254 * as a simple copy of the pipes pages to the user iov.
1255 */
Al Viro87a30022018-05-26 21:39:52 -04001256static long vmsplice_to_user(struct file *file, struct iov_iter *iter,
1257 unsigned int flags)
Jens Axboe6a14b902007-06-14 13:08:55 +02001258{
Al Viro87a30022018-05-26 21:39:52 -04001259 struct pipe_inode_info *pipe = get_pipe_info(file);
1260 struct splice_desc sd = {
1261 .total_len = iov_iter_count(iter),
1262 .flags = flags,
1263 .u.data = iter
1264 };
1265 long ret = 0;
Jens Axboe6a14b902007-06-14 13:08:55 +02001266
Jens Axboe6a14b902007-06-14 13:08:55 +02001267 if (!pipe)
1268 return -EBADF;
1269
Al Viro345995f2015-03-21 19:17:55 -04001270 if (sd.total_len) {
1271 pipe_lock(pipe);
1272 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1273 pipe_unlock(pipe);
1274 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001275
Jens Axboe6a14b902007-06-14 13:08:55 +02001276 return ret;
1277}
1278
Jens Axboe912d35f2006-04-26 10:59:21 +02001279/*
1280 * vmsplice splices a user address range into a pipe. It can be thought of
1281 * as splice-from-memory, where the regular splice is splice-from-file (or
1282 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001283 */
Al Viro87a30022018-05-26 21:39:52 -04001284static long vmsplice_to_pipe(struct file *file, struct iov_iter *iter,
1285 unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001286{
Jens Axboeddac0d32006-11-04 12:49:32 +01001287 struct pipe_inode_info *pipe;
Al Viro87a30022018-05-26 21:39:52 -04001288 long ret = 0;
Al Viro79fddc42016-09-17 22:38:20 -04001289 unsigned buf_flag = 0;
1290
1291 if (flags & SPLICE_F_GIFT)
1292 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001293
Linus Torvalds71993e62010-11-28 13:56:09 -08001294 pipe = get_pipe_info(file);
Jens Axboeddac0d32006-11-04 12:49:32 +01001295 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001296 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001297
Al Viro8924fef2016-09-17 20:44:45 -04001298 pipe_lock(pipe);
1299 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001300 if (!ret)
Al Viro87a30022018-05-26 21:39:52 -04001301 ret = iter_to_pipe(iter, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001302 pipe_unlock(pipe);
1303 if (ret > 0)
1304 wakeup_pipe_readers(pipe);
Jens Axboe35f3d142010-05-20 10:43:18 +02001305 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001306}
1307
Al Viro87a30022018-05-26 21:39:52 -04001308static int vmsplice_type(struct fd f, int *type)
1309{
1310 if (!f.file)
1311 return -EBADF;
1312 if (f.file->f_mode & FMODE_WRITE) {
1313 *type = WRITE;
1314 } else if (f.file->f_mode & FMODE_READ) {
1315 *type = READ;
1316 } else {
1317 fdput(f);
1318 return -EBADF;
1319 }
1320 return 0;
1321}
1322
Jens Axboe6a14b902007-06-14 13:08:55 +02001323/*
1324 * Note that vmsplice only really supports true splicing _from_ user memory
1325 * to a pipe, not the other way around. Splicing from user memory is a simple
1326 * operation that can be supported without any funky alignment restrictions
1327 * or nasty vm tricks. We simply map in the user memory and fill them into
1328 * a pipe. The reverse isn't quite as easy, though. There are two possible
1329 * solutions for that:
1330 *
1331 * - memcpy() the data internally, at which point we might as well just
1332 * do a regular read() on the buffer anyway.
1333 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1334 * has restriction limitations on both ends of the pipe).
1335 *
1336 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1337 *
1338 */
Al Viro87a30022018-05-26 21:39:52 -04001339static long do_vmsplice(struct file *f, struct iov_iter *iter, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001340{
Al Viro3d6ea292016-12-10 13:17:32 -05001341 if (unlikely(flags & ~SPLICE_F_ALL))
1342 return -EINVAL;
Al Viro87a30022018-05-26 21:39:52 -04001343
1344 if (!iov_iter_count(iter))
Jens Axboe6a14b902007-06-14 13:08:55 +02001345 return 0;
1346
Al Viro87a30022018-05-26 21:39:52 -04001347 if (iov_iter_rw(iter) == WRITE)
1348 return vmsplice_to_pipe(f, iter, flags);
1349 else
1350 return vmsplice_to_user(f, iter, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001351}
1352
Al Viro87a30022018-05-26 21:39:52 -04001353SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, uiov,
Dominik Brodowski30cfe4e2018-03-17 15:00:24 +01001354 unsigned long, nr_segs, unsigned int, flags)
1355{
Al Viro87a30022018-05-26 21:39:52 -04001356 struct iovec iovstack[UIO_FASTIOV];
1357 struct iovec *iov = iovstack;
1358 struct iov_iter iter;
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001359 ssize_t error;
Al Viro87a30022018-05-26 21:39:52 -04001360 struct fd f;
1361 int type;
1362
1363 f = fdget(fd);
1364 error = vmsplice_type(f, &type);
1365 if (error)
1366 return error;
1367
1368 error = import_iovec(type, uiov, nr_segs,
1369 ARRAY_SIZE(iovstack), &iov, &iter);
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001370 if (error >= 0) {
Al Viro87a30022018-05-26 21:39:52 -04001371 error = do_vmsplice(f.file, &iter, flags);
1372 kfree(iov);
1373 }
1374 fdput(f);
1375 return error;
Dominik Brodowski30cfe4e2018-03-17 15:00:24 +01001376}
1377
Al Viro76b021d2013-03-02 10:19:56 -05001378#ifdef CONFIG_COMPAT
1379COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1380 unsigned int, nr_segs, unsigned int, flags)
1381{
Al Viro87a30022018-05-26 21:39:52 -04001382 struct iovec iovstack[UIO_FASTIOV];
1383 struct iovec *iov = iovstack;
1384 struct iov_iter iter;
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001385 ssize_t error;
Al Viro87a30022018-05-26 21:39:52 -04001386 struct fd f;
1387 int type;
1388
1389 f = fdget(fd);
1390 error = vmsplice_type(f, &type);
1391 if (error)
1392 return error;
1393
1394 error = compat_import_iovec(type, iov32, nr_segs,
1395 ARRAY_SIZE(iovstack), &iov, &iter);
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001396 if (error >= 0) {
Al Viro87a30022018-05-26 21:39:52 -04001397 error = do_vmsplice(f.file, &iter, flags);
1398 kfree(iov);
Al Viro76b021d2013-03-02 10:19:56 -05001399 }
Al Viro87a30022018-05-26 21:39:52 -04001400 fdput(f);
1401 return error;
Al Viro76b021d2013-03-02 10:19:56 -05001402}
1403#endif
1404
Heiko Carstens836f92a2009-01-14 14:14:33 +01001405SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1406 int, fd_out, loff_t __user *, off_out,
1407 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001408{
Al Viro2903ff02012-08-28 12:52:22 -04001409 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001410 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001411
1412 if (unlikely(!len))
1413 return 0;
1414
Al Viro3d6ea292016-12-10 13:17:32 -05001415 if (unlikely(flags & ~SPLICE_F_ALL))
1416 return -EINVAL;
1417
Jens Axboe5274f052006-03-30 15:15:30 +02001418 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001419 in = fdget(fd_in);
1420 if (in.file) {
1421 if (in.file->f_mode & FMODE_READ) {
1422 out = fdget(fd_out);
1423 if (out.file) {
1424 if (out.file->f_mode & FMODE_WRITE)
1425 error = do_splice(in.file, off_in,
1426 out.file, off_out,
Ingo Molnar529565dc2006-04-10 15:18:58 +02001427 len, flags);
Al Viro2903ff02012-08-28 12:52:22 -04001428 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001429 }
1430 }
Al Viro2903ff02012-08-28 12:52:22 -04001431 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001432 }
Jens Axboe5274f052006-03-30 15:15:30 +02001433 return error;
1434}
Jens Axboe70524492006-04-11 15:51:17 +02001435
1436/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001437 * Make sure there's data to read. Wait for input if we can, otherwise
1438 * return an appropriate error.
1439 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001440static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001441{
1442 int ret;
1443
1444 /*
1445 * Check ->nrbufs without the inode lock first. This function
1446 * is speculative anyways, so missing one is ok.
1447 */
1448 if (pipe->nrbufs)
1449 return 0;
1450
1451 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001452 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001453
1454 while (!pipe->nrbufs) {
1455 if (signal_pending(current)) {
1456 ret = -ERESTARTSYS;
1457 break;
1458 }
1459 if (!pipe->writers)
1460 break;
1461 if (!pipe->waiting_writers) {
1462 if (flags & SPLICE_F_NONBLOCK) {
1463 ret = -EAGAIN;
1464 break;
1465 }
1466 }
1467 pipe_wait(pipe);
1468 }
1469
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001470 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001471 return ret;
1472}
1473
1474/*
1475 * Make sure there's writeable room. Wait for room if we can, otherwise
1476 * return an appropriate error.
1477 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001478static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001479{
1480 int ret;
1481
1482 /*
1483 * Check ->nrbufs without the inode lock first. This function
1484 * is speculative anyways, so missing one is ok.
1485 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001486 if (pipe->nrbufs < pipe->buffers)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001487 return 0;
1488
1489 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001490 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001491
Jens Axboe35f3d142010-05-20 10:43:18 +02001492 while (pipe->nrbufs >= pipe->buffers) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001493 if (!pipe->readers) {
1494 send_sig(SIGPIPE, current, 0);
1495 ret = -EPIPE;
1496 break;
1497 }
1498 if (flags & SPLICE_F_NONBLOCK) {
1499 ret = -EAGAIN;
1500 break;
1501 }
1502 if (signal_pending(current)) {
1503 ret = -ERESTARTSYS;
1504 break;
1505 }
1506 pipe->waiting_writers++;
1507 pipe_wait(pipe);
1508 pipe->waiting_writers--;
1509 }
1510
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001511 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001512 return ret;
1513}
1514
1515/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001516 * Splice contents of ipipe to opipe.
1517 */
1518static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1519 struct pipe_inode_info *opipe,
1520 size_t len, unsigned int flags)
1521{
1522 struct pipe_buffer *ibuf, *obuf;
1523 int ret = 0, nbuf;
1524 bool input_wakeup = false;
1525
1526
1527retry:
1528 ret = ipipe_prep(ipipe, flags);
1529 if (ret)
1530 return ret;
1531
1532 ret = opipe_prep(opipe, flags);
1533 if (ret)
1534 return ret;
1535
1536 /*
1537 * Potential ABBA deadlock, work around it by ordering lock
1538 * grabbing by pipe info address. Otherwise two different processes
1539 * could deadlock (one doing tee from A -> B, the other from B -> A).
1540 */
1541 pipe_double_lock(ipipe, opipe);
1542
1543 do {
1544 if (!opipe->readers) {
1545 send_sig(SIGPIPE, current, 0);
1546 if (!ret)
1547 ret = -EPIPE;
1548 break;
1549 }
1550
1551 if (!ipipe->nrbufs && !ipipe->writers)
1552 break;
1553
1554 /*
1555 * Cannot make any progress, because either the input
1556 * pipe is empty or the output pipe is full.
1557 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001558 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001559 /* Already processed some buffers, break */
1560 if (ret)
1561 break;
1562
1563 if (flags & SPLICE_F_NONBLOCK) {
1564 ret = -EAGAIN;
1565 break;
1566 }
1567
1568 /*
1569 * We raced with another reader/writer and haven't
1570 * managed to process any buffers. A zero return
1571 * value means EOF, so retry instead.
1572 */
1573 pipe_unlock(ipipe);
1574 pipe_unlock(opipe);
1575 goto retry;
1576 }
1577
1578 ibuf = ipipe->bufs + ipipe->curbuf;
Jens Axboe35f3d142010-05-20 10:43:18 +02001579 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001580 obuf = opipe->bufs + nbuf;
1581
1582 if (len >= ibuf->len) {
1583 /*
1584 * Simply move the whole buffer from ipipe to opipe
1585 */
1586 *obuf = *ibuf;
1587 ibuf->ops = NULL;
1588 opipe->nrbufs++;
Jens Axboe35f3d142010-05-20 10:43:18 +02001589 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001590 ipipe->nrbufs--;
1591 input_wakeup = true;
1592 } else {
1593 /*
1594 * Get a reference to this pipe buffer,
1595 * so we can copy the contents over.
1596 */
Matthew Wilcox15fab632019-04-05 14:02:10 -07001597 if (!pipe_buf_get(ipipe, ibuf)) {
1598 if (ret == 0)
1599 ret = -EFAULT;
1600 break;
1601 }
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001602 *obuf = *ibuf;
1603
1604 /*
1605 * Don't inherit the gift flag, we need to
1606 * prevent multiple steals of this page.
1607 */
1608 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1609
Jann Horna0ce2f02019-01-23 15:19:17 +01001610 pipe_buf_mark_unmergeable(obuf);
1611
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001612 obuf->len = len;
1613 opipe->nrbufs++;
1614 ibuf->offset += obuf->len;
1615 ibuf->len -= obuf->len;
1616 }
1617 ret += obuf->len;
1618 len -= obuf->len;
1619 } while (len);
1620
1621 pipe_unlock(ipipe);
1622 pipe_unlock(opipe);
1623
1624 /*
1625 * If we put data in the output pipe, wakeup any potential readers.
1626 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001627 if (ret > 0)
1628 wakeup_pipe_readers(opipe);
1629
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001630 if (input_wakeup)
1631 wakeup_pipe_writers(ipipe);
1632
1633 return ret;
1634}
1635
1636/*
Jens Axboe70524492006-04-11 15:51:17 +02001637 * Link contents of ipipe to opipe.
1638 */
1639static int link_pipe(struct pipe_inode_info *ipipe,
1640 struct pipe_inode_info *opipe,
1641 size_t len, unsigned int flags)
1642{
1643 struct pipe_buffer *ibuf, *obuf;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001644 int ret = 0, i = 0, nbuf;
Jens Axboe70524492006-04-11 15:51:17 +02001645
1646 /*
1647 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001648 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001649 * could deadlock (one doing tee from A -> B, the other from B -> A).
1650 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001651 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001652
Jens Axboeaadd06e2006-07-10 11:00:01 +02001653 do {
Jens Axboe70524492006-04-11 15:51:17 +02001654 if (!opipe->readers) {
1655 send_sig(SIGPIPE, current, 0);
1656 if (!ret)
1657 ret = -EPIPE;
1658 break;
1659 }
Jens Axboe70524492006-04-11 15:51:17 +02001660
1661 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001662 * If we have iterated all input buffers or ran out of
1663 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001664 */
Jens Axboe35f3d142010-05-20 10:43:18 +02001665 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
Jens Axboe70524492006-04-11 15:51:17 +02001666 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001667
Jens Axboe35f3d142010-05-20 10:43:18 +02001668 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1669 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001670
Jens Axboe2a27250e2006-04-19 15:56:40 +02001671 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001672 * Get a reference to this pipe buffer,
1673 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001674 */
Matthew Wilcox15fab632019-04-05 14:02:10 -07001675 if (!pipe_buf_get(ipipe, ibuf)) {
1676 if (ret == 0)
1677 ret = -EFAULT;
1678 break;
1679 }
Jens Axboe70524492006-04-11 15:51:17 +02001680
Jens Axboeaadd06e2006-07-10 11:00:01 +02001681 obuf = opipe->bufs + nbuf;
1682 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001683
Jens Axboeaadd06e2006-07-10 11:00:01 +02001684 /*
1685 * Don't inherit the gift flag, we need to
1686 * prevent multiple steals of this page.
1687 */
1688 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1689
Jann Horna0ce2f02019-01-23 15:19:17 +01001690 pipe_buf_mark_unmergeable(obuf);
1691
Jens Axboeaadd06e2006-07-10 11:00:01 +02001692 if (obuf->len > len)
1693 obuf->len = len;
1694
1695 opipe->nrbufs++;
1696 ret += obuf->len;
1697 len -= obuf->len;
1698 i++;
1699 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001700
Jens Axboe02cf01a2008-02-20 10:34:51 +01001701 /*
1702 * return EAGAIN if we have the potential of some data in the
1703 * future, otherwise just return 0
1704 */
1705 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1706 ret = -EAGAIN;
1707
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001708 pipe_unlock(ipipe);
1709 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001710
Jens Axboeaadd06e2006-07-10 11:00:01 +02001711 /*
1712 * If we put data in the output pipe, wakeup any potential readers.
1713 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001714 if (ret > 0)
1715 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001716
1717 return ret;
1718}
1719
1720/*
1721 * This is a tee(1) implementation that works on pipes. It doesn't copy
1722 * any data, it simply references the 'in' pages on the 'out' pipe.
1723 * The 'flags' used are the SPLICE_F_* variants, currently the only
1724 * applicable one is SPLICE_F_NONBLOCK.
1725 */
1726static long do_tee(struct file *in, struct file *out, size_t len,
1727 unsigned int flags)
1728{
Linus Torvalds71993e62010-11-28 13:56:09 -08001729 struct pipe_inode_info *ipipe = get_pipe_info(in);
1730 struct pipe_inode_info *opipe = get_pipe_info(out);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001731 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001732
1733 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001734 * Duplicate the contents of ipipe to opipe without actually
1735 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001736 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001737 if (ipipe && opipe && ipipe != opipe) {
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001738 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1739 flags |= SPLICE_F_NONBLOCK;
1740
Jens Axboeaadd06e2006-07-10 11:00:01 +02001741 /*
1742 * Keep going, unless we encounter an error. The ipipe/opipe
1743 * ordering doesn't really matter.
1744 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001745 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001746 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001747 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001748 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001749 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001750 }
1751 }
Jens Axboe70524492006-04-11 15:51:17 +02001752
Jens Axboeaadd06e2006-07-10 11:00:01 +02001753 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001754}
1755
Heiko Carstens836f92a2009-01-14 14:14:33 +01001756SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001757{
Al Viro2903ff02012-08-28 12:52:22 -04001758 struct fd in;
1759 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001760
Al Viro3d6ea292016-12-10 13:17:32 -05001761 if (unlikely(flags & ~SPLICE_F_ALL))
1762 return -EINVAL;
1763
Jens Axboe70524492006-04-11 15:51:17 +02001764 if (unlikely(!len))
1765 return 0;
1766
1767 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001768 in = fdget(fdin);
1769 if (in.file) {
1770 if (in.file->f_mode & FMODE_READ) {
1771 struct fd out = fdget(fdout);
1772 if (out.file) {
1773 if (out.file->f_mode & FMODE_WRITE)
1774 error = do_tee(in.file, out.file,
1775 len, flags);
1776 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001777 }
1778 }
Al Viro2903ff02012-08-28 12:52:22 -04001779 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001780 }
1781
1782 return error;
1783}