blob: d9305af930d878b6ca1b710974798173fbd2bfcf [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>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010036#include <linux/sched/signal.h>
37
Al Viro06ae43f2013-03-20 13:19:30 -040038#include "internal.h"
Jens Axboe5274f052006-03-30 15:15:30 +020039
Jens Axboe83f91352006-04-02 23:05:09 +020040/*
41 * Attempt to steal a page from a pipe buffer. This should perhaps go into
42 * a vm helper function, it's already simplified quite a bit by the
43 * addition of remove_mapping(). If success is returned, the caller may
44 * attempt to reuse this page for another destination.
45 */
Christoph Hellwigc928f642020-05-20 17:58:16 +020046static bool page_cache_pipe_buf_try_steal(struct pipe_inode_info *pipe,
47 struct pipe_buffer *buf)
Jens Axboe5abc97a2006-03-30 15:16:46 +020048{
49 struct page *page = buf->page;
Jens Axboe9e94cd42006-06-20 15:01:12 +020050 struct address_space *mapping;
Jens Axboe5abc97a2006-03-30 15:16:46 +020051
Jens Axboe9e0267c2006-04-19 15:57:31 +020052 lock_page(page);
53
Jens Axboe9e94cd42006-06-20 15:01:12 +020054 mapping = page_mapping(page);
55 if (mapping) {
56 WARN_ON(!PageUptodate(page));
Jens Axboe5abc97a2006-03-30 15:16:46 +020057
Jens Axboe9e94cd42006-06-20 15:01:12 +020058 /*
59 * At least for ext2 with nobh option, we need to wait on
60 * writeback completing on this page, since we'll remove it
61 * from the pagecache. Otherwise truncate wont wait on the
62 * page, allowing the disk blocks to be reused by someone else
63 * before we actually wrote our data to them. fs corruption
64 * ensues.
65 */
66 wait_on_page_writeback(page);
Jens Axboead8d6f02006-04-02 23:10:32 +020067
David Howells266cf652009-04-03 16:42:36 +010068 if (page_has_private(page) &&
69 !try_to_release_page(page, GFP_KERNEL))
Jens Axboeca39d652008-05-20 21:27:41 +020070 goto out_unlock;
Jens Axboe4f6f0bd2006-04-02 23:04:46 +020071
Jens Axboe9e94cd42006-06-20 15:01:12 +020072 /*
73 * If we succeeded in removing the mapping, set LRU flag
74 * and return good.
75 */
76 if (remove_mapping(mapping, page)) {
77 buf->flags |= PIPE_BUF_FLAG_LRU;
Christoph Hellwigc928f642020-05-20 17:58:16 +020078 return true;
Jens Axboe9e94cd42006-06-20 15:01:12 +020079 }
Jens Axboe9e0267c2006-04-19 15:57:31 +020080 }
Jens Axboe5abc97a2006-03-30 15:16:46 +020081
Jens Axboe9e94cd42006-06-20 15:01:12 +020082 /*
83 * Raced with truncate or failed to remove page from current
84 * address space, unlock and return failure.
85 */
Jens Axboeca39d652008-05-20 21:27:41 +020086out_unlock:
Jens Axboe9e94cd42006-06-20 15:01:12 +020087 unlock_page(page);
Christoph Hellwigc928f642020-05-20 17:58:16 +020088 return false;
Jens Axboe5abc97a2006-03-30 15:16:46 +020089}
90
Jens Axboe76ad4d12006-05-03 10:41:33 +020091static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +020092 struct pipe_buffer *buf)
93{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +030094 put_page(buf->page);
Jens Axboe14328732006-05-03 10:35:26 +020095 buf->flags &= ~PIPE_BUF_FLAG_LRU;
Jens Axboe5274f052006-03-30 15:15:30 +020096}
97
Jens Axboe08457182007-06-12 20:51:32 +020098/*
99 * Check whether the contents of buf is OK to access. Since the content
100 * is a page cache page, IO may be in flight.
101 */
Jens Axboecac36bb02007-06-14 13:10:48 +0200102static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
103 struct pipe_buffer *buf)
Jens Axboe5274f052006-03-30 15:15:30 +0200104{
105 struct page *page = buf->page;
Jens Axboe49d0b212006-04-10 09:04:41 +0200106 int err;
Jens Axboe5274f052006-03-30 15:15:30 +0200107
108 if (!PageUptodate(page)) {
Jens Axboe49d0b212006-04-10 09:04:41 +0200109 lock_page(page);
110
111 /*
112 * Page got truncated/unhashed. This will cause a 0-byte
Ingo Molnar73d62d82006-04-11 13:57:21 +0200113 * splice, if this is the first page.
Jens Axboe49d0b212006-04-10 09:04:41 +0200114 */
115 if (!page->mapping) {
116 err = -ENODATA;
117 goto error;
118 }
119
120 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200121 * Uh oh, read-error from disk.
Jens Axboe49d0b212006-04-10 09:04:41 +0200122 */
123 if (!PageUptodate(page)) {
124 err = -EIO;
125 goto error;
126 }
127
128 /*
Jens Axboef84d7512006-05-01 19:59:03 +0200129 * Page is ok afterall, we are done.
Jens Axboe49d0b212006-04-10 09:04:41 +0200130 */
Jens Axboe5274f052006-03-30 15:15:30 +0200131 unlock_page(page);
Jens Axboe5274f052006-03-30 15:15:30 +0200132 }
133
Jens Axboef84d7512006-05-01 19:59:03 +0200134 return 0;
Jens Axboe49d0b212006-04-10 09:04:41 +0200135error:
136 unlock_page(page);
Jens Axboef84d7512006-05-01 19:59:03 +0200137 return err;
Jens Axboe70524492006-04-11 15:51:17 +0200138}
139
Hugh Dickins708e3502011-07-25 17:12:32 -0700140const struct pipe_buf_operations page_cache_pipe_buf_ops = {
Christoph Hellwigc928f642020-05-20 17:58:16 +0200141 .confirm = page_cache_pipe_buf_confirm,
142 .release = page_cache_pipe_buf_release,
143 .try_steal = page_cache_pipe_buf_try_steal,
144 .get = generic_pipe_buf_get,
Jens Axboe5274f052006-03-30 15:15:30 +0200145};
146
Christoph Hellwigc928f642020-05-20 17:58:16 +0200147static bool user_page_pipe_buf_try_steal(struct pipe_inode_info *pipe,
148 struct pipe_buffer *buf)
Jens Axboe912d35f2006-04-26 10:59:21 +0200149{
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200150 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
Christoph Hellwigc928f642020-05-20 17:58:16 +0200151 return false;
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200152
Jens Axboe14328732006-05-03 10:35:26 +0200153 buf->flags |= PIPE_BUF_FLAG_LRU;
Christoph Hellwigc928f642020-05-20 17:58:16 +0200154 return generic_pipe_buf_try_steal(pipe, buf);
Jens Axboe912d35f2006-04-26 10:59:21 +0200155}
156
Eric Dumazetd4c3cca2006-12-13 00:34:04 -0800157static const struct pipe_buf_operations user_page_pipe_buf_ops = {
Christoph Hellwigc928f642020-05-20 17:58:16 +0200158 .release = page_cache_pipe_buf_release,
159 .try_steal = user_page_pipe_buf_try_steal,
160 .get = generic_pipe_buf_get,
Jens Axboe912d35f2006-04-26 10:59:21 +0200161};
162
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200163static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
164{
165 smp_mb();
Linus Torvalds0ddad212019-12-09 09:48:27 -0800166 if (waitqueue_active(&pipe->rd_wait))
167 wake_up_interruptible(&pipe->rd_wait);
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200168 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
169}
170
Jens Axboe932cc6d2007-06-21 13:10:21 +0200171/**
172 * splice_to_pipe - fill passed data into a pipe
173 * @pipe: pipe to fill
174 * @spd: data to fill
175 *
176 * Description:
Randy Dunlap79685b82007-07-27 08:08:51 +0200177 * @spd contains a map of pages and len/offset tuples, along with
Jens Axboe932cc6d2007-06-21 13:10:21 +0200178 * the struct pipe_buf_operations associated with these pages. This
179 * function will link that data to the pipe.
180 *
Jens Axboe83f91352006-04-02 23:05:09 +0200181 */
Jens Axboed6b29d72007-06-04 09:59:47 +0200182ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
183 struct splice_pipe_desc *spd)
Jens Axboe5274f052006-03-30 15:15:30 +0200184{
Jens Axboe00de00b2007-06-15 13:14:22 +0200185 unsigned int spd_pages = spd->nr_pages;
David Howells8cefc102019-11-15 13:30:32 +0000186 unsigned int tail = pipe->tail;
187 unsigned int head = pipe->head;
188 unsigned int mask = pipe->ring_size - 1;
Al Viro8924fef2016-09-17 20:44:45 -0400189 int ret = 0, page_nr = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200190
Rabin Vincentd6785d92016-03-10 21:19:06 +0100191 if (!spd_pages)
192 return 0;
193
Al Viro8924fef2016-09-17 20:44:45 -0400194 if (unlikely(!pipe->readers)) {
195 send_sig(SIGPIPE, current, 0);
196 ret = -EPIPE;
197 goto out;
Jens Axboe5274f052006-03-30 15:15:30 +0200198 }
199
David Howells6718b6f2019-10-16 16:47:32 +0100200 while (!pipe_full(head, tail, pipe->max_usage)) {
David Howells8cefc102019-11-15 13:30:32 +0000201 struct pipe_buffer *buf = &pipe->bufs[head & mask];
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
David Howells8cefc102019-11-15 13:30:32 +0000210 head++;
211 pipe->head = head;
Al Viro8924fef2016-09-17 20:44:45 -0400212 page_nr++;
213 ret += buf->len;
214
215 if (!--spd->nr_pages)
216 break;
217 }
218
219 if (!ret)
220 ret = -EAGAIN;
221
222out:
Jens Axboe00de00b2007-06-15 13:14:22 +0200223 while (page_nr < spd_pages)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800224 spd->spd_release(spd, page_nr++);
Jens Axboe5274f052006-03-30 15:15:30 +0200225
226 return ret;
227}
Hannes Frederic Sowa2b514572015-05-21 17:00:01 +0200228EXPORT_SYMBOL_GPL(splice_to_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200229
Al Viro79fddc42016-09-17 22:38:20 -0400230ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
231{
David Howells8cefc102019-11-15 13:30:32 +0000232 unsigned int head = pipe->head;
233 unsigned int tail = pipe->tail;
234 unsigned int mask = pipe->ring_size - 1;
Al Viro79fddc42016-09-17 22:38:20 -0400235 int ret;
236
237 if (unlikely(!pipe->readers)) {
238 send_sig(SIGPIPE, current, 0);
239 ret = -EPIPE;
David Howells6718b6f2019-10-16 16:47:32 +0100240 } else if (pipe_full(head, tail, pipe->max_usage)) {
Al Viro79fddc42016-09-17 22:38:20 -0400241 ret = -EAGAIN;
242 } else {
David Howells8cefc102019-11-15 13:30:32 +0000243 pipe->bufs[head & mask] = *buf;
244 pipe->head = head + 1;
Al Viro79fddc42016-09-17 22:38:20 -0400245 return buf->len;
246 }
Miklos Szeredia7796382016-09-27 10:45:12 +0200247 pipe_buf_release(pipe, buf);
Al Viro79fddc42016-09-17 22:38:20 -0400248 return ret;
249}
250EXPORT_SYMBOL(add_to_pipe);
251
Jens Axboe35f3d142010-05-20 10:43:18 +0200252/*
253 * Check if we need to grow the arrays holding pages and partial page
254 * descriptions.
255 */
Eric Dumazet047fe362012-06-12 15:24:40 +0200256int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200257{
David Howells6718b6f2019-10-16 16:47:32 +0100258 unsigned int max_usage = READ_ONCE(pipe->max_usage);
Eric Dumazet047fe362012-06-12 15:24:40 +0200259
David Howells8cefc102019-11-15 13:30:32 +0000260 spd->nr_pages_max = max_usage;
261 if (max_usage <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200262 return 0;
263
David Howells8cefc102019-11-15 13:30:32 +0000264 spd->pages = kmalloc_array(max_usage, sizeof(struct page *), GFP_KERNEL);
265 spd->partial = kmalloc_array(max_usage, sizeof(struct partial_page),
Kees Cook6da2ec52018-06-12 13:55:00 -0700266 GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200267
268 if (spd->pages && spd->partial)
269 return 0;
270
271 kfree(spd->pages);
272 kfree(spd->partial);
273 return -ENOMEM;
274}
275
Eric Dumazet047fe362012-06-12 15:24:40 +0200276void splice_shrink_spd(struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200277{
Eric Dumazet047fe362012-06-12 15:24:40 +0200278 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200279 return;
280
281 kfree(spd->pages);
282 kfree(spd->partial);
283}
284
Jens Axboe83f91352006-04-02 23:05:09 +0200285/**
286 * generic_file_splice_read - splice data from file to a pipe
287 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200288 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200289 * @pipe: pipe to splice to
290 * @len: number of bytes to splice
291 * @flags: splice modifier flags
292 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200293 * Description:
294 * Will read pages from given file and fill them into a pipe. Can be
Al Viro82c156f2016-09-22 23:35:42 -0400295 * used as long as it has more or less sane ->read_iter().
Jens Axboe932cc6d2007-06-21 13:10:21 +0200296 *
Jens Axboe83f91352006-04-02 23:05:09 +0200297 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200298ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
299 struct pipe_inode_info *pipe, size_t len,
300 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200301{
Al Viro82c156f2016-09-22 23:35:42 -0400302 struct iov_iter to;
303 struct kiocb kiocb;
David Howells8cefc102019-11-15 13:30:32 +0000304 unsigned int i_head;
305 int ret;
Boaz Harroshbe64f882015-04-15 16:15:17 -0700306
David Howellsaa563d72018-10-20 00:57:56 +0100307 iov_iter_pipe(&to, READ, pipe, len);
David Howells8cefc102019-11-15 13:30:32 +0000308 i_head = to.head;
Al Viro82c156f2016-09-22 23:35:42 -0400309 init_sync_kiocb(&kiocb, in);
310 kiocb.ki_pos = *ppos;
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100311 ret = call_read_iter(in, &kiocb, &to);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200312 if (ret > 0) {
Al Viro82c156f2016-09-22 23:35:42 -0400313 *ppos = kiocb.ki_pos;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200314 file_accessed(in);
Al Viro82c156f2016-09-22 23:35:42 -0400315 } else if (ret < 0) {
David Howells8cefc102019-11-15 13:30:32 +0000316 to.head = i_head;
Al Viroc3a69022016-10-10 13:26:27 -0400317 to.iov_offset = 0;
318 iov_iter_advance(&to, 0); /* to free what was emitted */
Al Viro82c156f2016-09-22 23:35:42 -0400319 /*
320 * callers of ->splice_read() expect -EAGAIN on
321 * "can't put anything in there", rather than -EFAULT.
322 */
323 if (ret == -EFAULT)
324 ret = -EAGAIN;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200325 }
Jens Axboe5274f052006-03-30 15:15:30 +0200326
327 return ret;
328}
Jens Axboe059a8f32006-04-02 23:06:05 +0200329EXPORT_SYMBOL(generic_file_splice_read);
330
Al Viro241699c2016-09-22 16:33:12 -0400331const struct pipe_buf_operations default_pipe_buf_ops = {
Christoph Hellwigc928f642020-05-20 17:58:16 +0200332 .release = generic_pipe_buf_release,
333 .try_steal = generic_pipe_buf_try_steal,
334 .get = generic_pipe_buf_get,
Miklos Szeredi68181732009-05-07 15:37:36 +0200335};
336
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100337/* Pipe buffer operations for a socket and similar. */
338const struct pipe_buf_operations nosteal_pipe_buf_ops = {
Christoph Hellwigc928f642020-05-20 17:58:16 +0200339 .release = generic_pipe_buf_release,
340 .get = generic_pipe_buf_get,
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100341};
342EXPORT_SYMBOL(nosteal_pipe_buf_ops);
343
Al Viro523ac9a2016-09-23 15:34:57 -0400344static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
Miklos Szeredi68181732009-05-07 15:37:36 +0200345 unsigned long vlen, loff_t offset)
346{
347 mm_segment_t old_fs;
348 loff_t pos = offset;
349 ssize_t res;
350
351 old_fs = get_fs();
Linus Torvalds736706b2019-03-04 10:39:05 -0800352 set_fs(KERNEL_DS);
Miklos Szeredi68181732009-05-07 15:37:36 +0200353 /* The cast to a user pointer is valid due to the set_fs() */
Christoph Hellwig793b80e2016-03-03 16:03:58 +0100354 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
Miklos Szeredi68181732009-05-07 15:37:36 +0200355 set_fs(old_fs);
356
357 return res;
358}
359
Al Viro82c156f2016-09-22 23:35:42 -0400360static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
Miklos Szeredi68181732009-05-07 15:37:36 +0200361 struct pipe_inode_info *pipe, size_t len,
362 unsigned int flags)
363{
Al Viro523ac9a2016-09-23 15:34:57 -0400364 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
365 struct iov_iter to;
366 struct page **pages;
Miklos Szeredi68181732009-05-07 15:37:36 +0200367 unsigned int nr_pages;
David Howells8cefc102019-11-15 13:30:32 +0000368 unsigned int mask;
Al Viro13c0f522016-12-10 13:20:53 -0500369 size_t offset, base, copied = 0;
Miklos Szeredi68181732009-05-07 15:37:36 +0200370 ssize_t res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200371 int i;
Miklos Szeredi68181732009-05-07 15:37:36 +0200372
David Howells6718b6f2019-10-16 16:47:32 +0100373 if (pipe_full(pipe->head, pipe->tail, pipe->max_usage))
Al Viro523ac9a2016-09-23 15:34:57 -0400374 return -EAGAIN;
375
376 /*
377 * Try to keep page boundaries matching to source pagecache ones -
378 * it probably won't be much help, but...
379 */
380 offset = *ppos & ~PAGE_MASK;
381
David Howellsaa563d72018-10-20 00:57:56 +0100382 iov_iter_pipe(&to, READ, pipe, len + offset);
Al Viro523ac9a2016-09-23 15:34:57 -0400383
Al Viro13c0f522016-12-10 13:20:53 -0500384 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &base);
Al Viro523ac9a2016-09-23 15:34:57 -0400385 if (res <= 0)
Jens Axboe35f3d142010-05-20 10:43:18 +0200386 return -ENOMEM;
387
Al Viro13c0f522016-12-10 13:20:53 -0500388 nr_pages = DIV_ROUND_UP(res + base, PAGE_SIZE);
Al Viro523ac9a2016-09-23 15:34:57 -0400389
Jens Axboe35f3d142010-05-20 10:43:18 +0200390 vec = __vec;
Al Viro523ac9a2016-09-23 15:34:57 -0400391 if (nr_pages > PIPE_DEF_BUFFERS) {
Kees Cook6da2ec52018-06-12 13:55:00 -0700392 vec = kmalloc_array(nr_pages, sizeof(struct kvec), GFP_KERNEL);
Al Viro523ac9a2016-09-23 15:34:57 -0400393 if (unlikely(!vec)) {
394 res = -ENOMEM;
395 goto out;
396 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200397 }
398
David Howells8cefc102019-11-15 13:30:32 +0000399 mask = pipe->ring_size - 1;
400 pipe->bufs[to.head & mask].offset = offset;
401 pipe->bufs[to.head & mask].len -= offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200402
Al Viro523ac9a2016-09-23 15:34:57 -0400403 for (i = 0; i < nr_pages; i++) {
404 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
405 vec[i].iov_base = page_address(pages[i]) + offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200406 vec[i].iov_len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200407 len -= this_len;
408 offset = 0;
409 }
410
Al Viro523ac9a2016-09-23 15:34:57 -0400411 res = kernel_readv(in, vec, nr_pages, *ppos);
412 if (res > 0) {
413 copied = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200414 *ppos += res;
Al Viro523ac9a2016-09-23 15:34:57 -0400415 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200416
Jens Axboe35f3d142010-05-20 10:43:18 +0200417 if (vec != __vec)
418 kfree(vec);
Al Viro523ac9a2016-09-23 15:34:57 -0400419out:
420 for (i = 0; i < nr_pages; i++)
421 put_page(pages[i]);
422 kvfree(pages);
423 iov_iter_advance(&to, copied); /* truncates and discards */
Miklos Szeredi68181732009-05-07 15:37:36 +0200424 return res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200425}
Miklos Szeredi68181732009-05-07 15:37:36 +0200426
Jens Axboe5274f052006-03-30 15:15:30 +0200427/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200428 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200429 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200430 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200431static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200432 struct pipe_buffer *buf, struct splice_desc *sd)
433{
Jens Axboe6a14b902007-06-14 13:08:55 +0200434 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200435 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100436 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200437
Al Viro72c2d532013-09-22 16:27:52 -0400438 if (!likely(file->f_op->sendpage))
Michał Mirosława8adbe32010-12-17 08:56:44 +0100439 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200440
Eric Dumazet35f9c092012-04-05 03:05:35 +0000441 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000442
David Howells8cefc102019-11-15 13:30:32 +0000443 if (sd->len < sd->total_len &&
444 pipe_occupancy(pipe->head, pipe->tail) > 1)
Eric Dumazet35f9c092012-04-05 03:05:35 +0000445 more |= MSG_SENDPAGE_NOTLAST;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000446
Michał Mirosława8adbe32010-12-17 08:56:44 +0100447 return file->f_op->sendpage(file, buf->page, buf->offset,
448 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200449}
450
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200451static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
452{
453 smp_mb();
Linus Torvalds0ddad212019-12-09 09:48:27 -0800454 if (waitqueue_active(&pipe->wr_wait))
455 wake_up_interruptible(&pipe->wr_wait);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200456 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
457}
458
459/**
460 * splice_from_pipe_feed - feed available data from a pipe to a file
461 * @pipe: pipe to splice from
462 * @sd: information to @actor
463 * @actor: handler that splices the data
464 *
465 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200466 * This function loops over the pipe and calls @actor to do the
467 * actual moving of a single struct pipe_buffer to the desired
468 * destination. It returns when there's no more buffers left in
469 * the pipe or if the requested number of bytes (@sd->total_len)
470 * have been copied. It returns a positive number (one) if the
471 * pipe needs to be filled with more data, zero if the required
472 * number of bytes have been copied and -errno on error.
473 *
474 * This, together with splice_from_pipe_{begin,end,next}, may be
475 * used to implement the functionality of __splice_from_pipe() when
476 * locking is required around copying the pipe buffers to the
477 * destination.
478 */
Al Viro96f9bc82014-04-05 04:35:49 -0400479static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200480 splice_actor *actor)
481{
David Howells8cefc102019-11-15 13:30:32 +0000482 unsigned int head = pipe->head;
483 unsigned int tail = pipe->tail;
484 unsigned int mask = pipe->ring_size - 1;
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200485 int ret;
486
Linus Torvaldsec057592019-12-06 12:40:35 -0800487 while (!pipe_empty(head, tail)) {
David Howells8cefc102019-11-15 13:30:32 +0000488 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200489
490 sd->len = buf->len;
491 if (sd->len > sd->total_len)
492 sd->len = sd->total_len;
493
Miklos Szeredifba597d2016-09-27 10:45:12 +0200494 ret = pipe_buf_confirm(pipe, buf);
Michał Mirosława8adbe32010-12-17 08:56:44 +0100495 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200496 if (ret == -ENODATA)
497 ret = 0;
498 return ret;
499 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100500
501 ret = actor(pipe, buf, sd);
502 if (ret <= 0)
503 return ret;
504
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200505 buf->offset += ret;
506 buf->len -= ret;
507
508 sd->num_spliced += ret;
509 sd->len -= ret;
510 sd->pos += ret;
511 sd->total_len -= ret;
512
513 if (!buf->len) {
Miklos Szeredia7796382016-09-27 10:45:12 +0200514 pipe_buf_release(pipe, buf);
David Howells8cefc102019-11-15 13:30:32 +0000515 tail++;
516 pipe->tail = tail;
Al Viro6447a3c2013-03-21 11:01:38 -0400517 if (pipe->files)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200518 sd->need_wakeup = true;
519 }
520
521 if (!sd->total_len)
522 return 0;
523 }
524
525 return 1;
526}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200527
Linus Torvaldsd1a819a2020-10-05 11:26:27 -0700528/* We know we have a pipe buffer, but maybe it's empty? */
529static inline bool eat_empty_buffer(struct pipe_inode_info *pipe)
530{
531 unsigned int tail = pipe->tail;
532 unsigned int mask = pipe->ring_size - 1;
533 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
534
535 if (unlikely(!buf->len)) {
536 pipe_buf_release(pipe, buf);
537 pipe->tail = tail+1;
538 return true;
539 }
540
541 return false;
542}
543
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200544/**
545 * splice_from_pipe_next - wait for some data to splice from
546 * @pipe: pipe to splice from
547 * @sd: information about the splice operation
548 *
549 * Description:
550 * This function will wait for some data and return a positive
551 * value (one) if pipe buffers are available. It will return zero
552 * or -errno if no more data needs to be spliced.
553 */
Al Viro96f9bc82014-04-05 04:35:49 -0400554static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200555{
Jan Karac725bfc2015-11-23 13:09:50 +0100556 /*
557 * Check for signal early to make process killable when there are
558 * always buffers available
559 */
560 if (signal_pending(current))
561 return -ERESTARTSYS;
562
Linus Torvaldsd1a819a2020-10-05 11:26:27 -0700563repeat:
David Howells8cefc102019-11-15 13:30:32 +0000564 while (pipe_empty(pipe->head, pipe->tail)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200565 if (!pipe->writers)
566 return 0;
567
Linus Torvaldsa28c8b92019-12-07 13:21:01 -0800568 if (sd->num_spliced)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200569 return 0;
570
571 if (sd->flags & SPLICE_F_NONBLOCK)
572 return -EAGAIN;
573
574 if (signal_pending(current))
575 return -ERESTARTSYS;
576
577 if (sd->need_wakeup) {
578 wakeup_pipe_writers(pipe);
579 sd->need_wakeup = false;
580 }
581
Linus Torvalds472e5b02020-10-01 19:14:36 -0700582 pipe_wait_readable(pipe);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200583 }
584
Linus Torvaldsd1a819a2020-10-05 11:26:27 -0700585 if (eat_empty_buffer(pipe))
586 goto repeat;
587
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200588 return 1;
589}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200590
591/**
592 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700593 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200594 *
595 * Description:
596 * This function should be called before a loop containing
597 * splice_from_pipe_next() and splice_from_pipe_feed() to
598 * initialize the necessary fields of @sd.
599 */
Al Viro96f9bc82014-04-05 04:35:49 -0400600static void splice_from_pipe_begin(struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200601{
602 sd->num_spliced = 0;
603 sd->need_wakeup = false;
604}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200605
606/**
607 * splice_from_pipe_end - finish splicing from pipe
608 * @pipe: pipe to splice from
609 * @sd: information about the splice operation
610 *
611 * Description:
612 * This function will wake up pipe writers if necessary. It should
613 * be called after a loop containing splice_from_pipe_next() and
614 * splice_from_pipe_feed().
615 */
Al Viro96f9bc82014-04-05 04:35:49 -0400616static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200617{
618 if (sd->need_wakeup)
619 wakeup_pipe_writers(pipe);
620}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200621
Jens Axboe932cc6d2007-06-21 13:10:21 +0200622/**
623 * __splice_from_pipe - splice data from a pipe to given actor
624 * @pipe: pipe to splice from
625 * @sd: information to @actor
626 * @actor: handler that splices the data
627 *
628 * Description:
629 * This function does little more than loop over the pipe and call
630 * @actor to do the actual moving of a single struct pipe_buffer to
631 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
632 * pipe_to_user.
633 *
Jens Axboe83f91352006-04-02 23:05:09 +0200634 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200635ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
636 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200637{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200638 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200639
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200640 splice_from_pipe_begin(sd);
641 do {
Jan Karac2489e02015-11-23 13:09:51 +0100642 cond_resched();
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200643 ret = splice_from_pipe_next(pipe, sd);
644 if (ret > 0)
645 ret = splice_from_pipe_feed(pipe, sd, actor);
646 } while (ret > 0);
647 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200648
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200649 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200650}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100651EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200652
Jens Axboe932cc6d2007-06-21 13:10:21 +0200653/**
654 * splice_from_pipe - splice data from a pipe to a file
655 * @pipe: pipe to splice from
656 * @out: file to splice to
657 * @ppos: position in @out
658 * @len: how many bytes to splice
659 * @flags: splice modifier flags
660 * @actor: handler that splices the data
661 *
662 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200663 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200664 * otherwise it's identical to __splice_from_pipe().
665 *
666 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200667ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
668 loff_t *ppos, size_t len, unsigned int flags,
669 splice_actor *actor)
670{
671 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200672 struct splice_desc sd = {
673 .total_len = len,
674 .flags = flags,
675 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200676 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200677 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200678
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200679 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200680 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200681 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200682
683 return ret;
684}
685
686/**
Al Viro8d020762014-04-05 04:27:08 -0400687 * iter_file_splice_write - splice data from a pipe to a file
688 * @pipe: pipe info
689 * @out: file to write to
690 * @ppos: position in @out
691 * @len: number of bytes to splice
692 * @flags: splice modifier flags
693 *
694 * Description:
695 * Will either move or copy pages (determined by @flags options) from
696 * the given pipe inode to the given file.
697 * This one is ->write_iter-based.
698 *
699 */
700ssize_t
701iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
702 loff_t *ppos, size_t len, unsigned int flags)
703{
704 struct splice_desc sd = {
705 .total_len = len,
706 .flags = flags,
707 .pos = *ppos,
708 .u.file = out,
709 };
David Howells6718b6f2019-10-16 16:47:32 +0100710 int nbufs = pipe->max_usage;
Al Viro8d020762014-04-05 04:27:08 -0400711 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
712 GFP_KERNEL);
713 ssize_t ret;
714
715 if (unlikely(!array))
716 return -ENOMEM;
717
718 pipe_lock(pipe);
719
720 splice_from_pipe_begin(&sd);
721 while (sd.total_len) {
722 struct iov_iter from;
Linus Torvaldsec057592019-12-06 12:40:35 -0800723 unsigned int head, tail, mask;
Al Viro8d020762014-04-05 04:27:08 -0400724 size_t left;
David Howells8cefc102019-11-15 13:30:32 +0000725 int n;
Al Viro8d020762014-04-05 04:27:08 -0400726
727 ret = splice_from_pipe_next(pipe, &sd);
728 if (ret <= 0)
729 break;
730
David Howells6718b6f2019-10-16 16:47:32 +0100731 if (unlikely(nbufs < pipe->max_usage)) {
Al Viro8d020762014-04-05 04:27:08 -0400732 kfree(array);
David Howells6718b6f2019-10-16 16:47:32 +0100733 nbufs = pipe->max_usage;
Al Viro8d020762014-04-05 04:27:08 -0400734 array = kcalloc(nbufs, sizeof(struct bio_vec),
735 GFP_KERNEL);
736 if (!array) {
737 ret = -ENOMEM;
738 break;
739 }
740 }
741
Linus Torvaldsec057592019-12-06 12:40:35 -0800742 head = pipe->head;
743 tail = pipe->tail;
744 mask = pipe->ring_size - 1;
745
Al Viro8d020762014-04-05 04:27:08 -0400746 /* build the vector */
747 left = sd.total_len;
David Howells8cefc102019-11-15 13:30:32 +0000748 for (n = 0; !pipe_empty(head, tail) && left && n < nbufs; tail++, n++) {
749 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
Al Viro8d020762014-04-05 04:27:08 -0400750 size_t this_len = buf->len;
751
752 if (this_len > left)
753 this_len = left;
754
Miklos Szeredifba597d2016-09-27 10:45:12 +0200755 ret = pipe_buf_confirm(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400756 if (unlikely(ret)) {
757 if (ret == -ENODATA)
758 ret = 0;
759 goto done;
760 }
761
762 array[n].bv_page = buf->page;
763 array[n].bv_len = this_len;
764 array[n].bv_offset = buf->offset;
765 left -= this_len;
766 }
767
David Howellsaa563d72018-10-20 00:57:56 +0100768 iov_iter_bvec(&from, WRITE, array, n, sd.total_len - left);
Christoph Hellwigabbb65892017-05-27 11:16:52 +0300769 ret = vfs_iter_write(out, &from, &sd.pos, 0);
Al Viro8d020762014-04-05 04:27:08 -0400770 if (ret <= 0)
771 break;
772
773 sd.num_spliced += ret;
774 sd.total_len -= ret;
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100775 *ppos = sd.pos;
Al Viro8d020762014-04-05 04:27:08 -0400776
777 /* dismiss the fully eaten buffers, adjust the partial one */
David Howells8cefc102019-11-15 13:30:32 +0000778 tail = pipe->tail;
Al Viro8d020762014-04-05 04:27:08 -0400779 while (ret) {
David Howells8cefc102019-11-15 13:30:32 +0000780 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
Al Viro8d020762014-04-05 04:27:08 -0400781 if (ret >= buf->len) {
Al Viro8d020762014-04-05 04:27:08 -0400782 ret -= buf->len;
783 buf->len = 0;
Miklos Szeredia7796382016-09-27 10:45:12 +0200784 pipe_buf_release(pipe, buf);
David Howells8cefc102019-11-15 13:30:32 +0000785 tail++;
786 pipe->tail = tail;
Al Viro8d020762014-04-05 04:27:08 -0400787 if (pipe->files)
788 sd.need_wakeup = true;
789 } else {
790 buf->offset += ret;
791 buf->len -= ret;
792 ret = 0;
793 }
794 }
795 }
796done:
797 kfree(array);
798 splice_from_pipe_end(pipe, &sd);
799
800 pipe_unlock(pipe);
801
802 if (sd.num_spliced)
803 ret = sd.num_spliced;
804
805 return ret;
806}
807
808EXPORT_SYMBOL(iter_file_splice_write);
809
Miklos Szeredib2858d72009-05-19 11:37:46 +0200810static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
811 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200812{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200813 int ret;
814 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -0400815 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +0200816
Al Virofbb32752014-02-02 21:09:54 -0500817 data = kmap(buf->page);
Al Viro06ae43f2013-03-20 13:19:30 -0400818 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Al Virofbb32752014-02-02 21:09:54 -0500819 kunmap(buf->page);
Miklos Szeredib2858d72009-05-19 11:37:46 +0200820
821 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200822}
823
824static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
825 struct file *out, loff_t *ppos,
826 size_t len, unsigned int flags)
827{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200828 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200829
Miklos Szeredib2858d72009-05-19 11:37:46 +0200830 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
831 if (ret > 0)
832 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200833
Miklos Szeredib2858d72009-05-19 11:37:46 +0200834 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200835}
836
Jens Axboe83f91352006-04-02 23:05:09 +0200837/**
838 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200839 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200840 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200841 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200842 * @len: number of bytes to splice
843 * @flags: splice modifier flags
844 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200845 * Description:
846 * Will send @len bytes from the pipe to a network socket. No data copying
847 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200848 *
849 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200850ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200851 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200852{
Jens Axboe00522fb2006-04-26 14:39:29 +0200853 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200854}
855
Jens Axboe059a8f32006-04-02 23:06:05 +0200856EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500857
Jens Axboe83f91352006-04-02 23:05:09 +0200858/*
859 * Attempt to initiate a splice from pipe to file.
860 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200861static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200862 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200863{
Al Viro72c2d532013-09-22 16:27:52 -0400864 if (out->f_op->splice_write)
Christoph Hellwig00c285d2020-05-20 17:58:11 +0200865 return out->f_op->splice_write(pipe, out, ppos, len, flags);
866 return default_file_splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200867}
868
Jens Axboe83f91352006-04-02 23:05:09 +0200869/*
870 * Attempt to initiate a splice from a file to a pipe.
871 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200872static long do_splice_to(struct file *in, loff_t *ppos,
873 struct pipe_inode_info *pipe, size_t len,
874 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200875{
Jens Axboe5274f052006-03-30 15:15:30 +0200876 int ret;
877
Jens Axboe49570e92006-04-11 13:56:09 +0200878 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200879 return -EBADF;
880
Jens Axboecbb7e572006-04-11 14:57:50 +0200881 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200882 if (unlikely(ret < 0))
883 return ret;
884
Al Viro03cc0782016-04-02 14:56:58 -0400885 if (unlikely(len > MAX_RW_COUNT))
886 len = MAX_RW_COUNT;
887
Al Viro72c2d532013-09-22 16:27:52 -0400888 if (in->f_op->splice_read)
Christoph Hellwig2bc01062020-05-20 17:58:10 +0200889 return in->f_op->splice_read(in, ppos, pipe, len, flags);
890 return default_file_splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200891}
892
Jens Axboe932cc6d2007-06-21 13:10:21 +0200893/**
894 * splice_direct_to_actor - splices data directly between two non-pipes
895 * @in: file to splice from
896 * @sd: actor information on where to splice to
897 * @actor: handles the data splicing
898 *
899 * Description:
900 * This is a special case helper to splice directly between two
901 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200902 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200903 * that process.
904 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200905 */
906ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
907 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200908{
909 struct pipe_inode_info *pipe;
910 long ret, bytes;
911 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200912 size_t len;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200913 int i, flags, more;
Jens Axboeb92ce552006-04-11 13:52:07 +0200914
915 /*
916 * We require the input being a regular file, as we don't want to
917 * randomly drop data for eg socket -> socket splicing. Use the
918 * piped splicing for that!
919 */
Al Viro496ad9a2013-01-23 17:07:38 -0500920 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200921 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
922 return -EINVAL;
923
924 /*
925 * neither in nor out is a pipe, setup an internal pipe attached to
926 * 'out' and transfer the wanted data from 'in' to 'out' through that
927 */
928 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200929 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -0400930 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +0200931 if (!pipe)
932 return -ENOMEM;
933
934 /*
935 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200936 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200937 * PIPE_READERS appropriately.
938 */
939 pipe->readers = 1;
940
941 current->splice_pipe = pipe;
942 }
943
944 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200945 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200946 */
947 ret = 0;
948 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200949 len = sd->total_len;
950 flags = sd->flags;
951
952 /*
953 * Don't block on output, we have to drain the direct pipe.
954 */
955 sd->flags &= ~SPLICE_F_NONBLOCK;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200956 more = sd->flags & SPLICE_F_MORE;
Jens Axboeb92ce552006-04-11 13:52:07 +0200957
David Howells8cefc102019-11-15 13:30:32 +0000958 WARN_ON_ONCE(!pipe_empty(pipe->head, pipe->tail));
Darrick J. Wong17614442018-11-30 10:37:49 -0800959
Jens Axboeb92ce552006-04-11 13:52:07 +0200960 while (len) {
David Howells8cefc102019-11-15 13:30:32 +0000961 unsigned int p_space;
Jens Axboe51a92c02007-07-13 14:11:43 +0200962 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200963 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200964
Darrick J. Wong17614442018-11-30 10:37:49 -0800965 /* Don't try to read more the pipe has space for. */
David Howells6718b6f2019-10-16 16:47:32 +0100966 p_space = pipe->max_usage -
David Howells8cefc102019-11-15 13:30:32 +0000967 pipe_occupancy(pipe->head, pipe->tail);
968 read_len = min_t(size_t, len, p_space << PAGE_SHIFT);
Darrick J. Wong17614442018-11-30 10:37:49 -0800969 ret = do_splice_to(in, &pos, pipe, read_len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200970 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +0200971 goto out_release;
972
973 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200974 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +0200975
976 /*
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200977 * If more data is pending, set SPLICE_F_MORE
978 * If this is the last data and SPLICE_F_MORE was not set
979 * initially, clears it.
980 */
981 if (read_len < len)
982 sd->flags |= SPLICE_F_MORE;
983 else if (!more)
984 sd->flags &= ~SPLICE_F_MORE;
985 /*
Jens Axboeb92ce552006-04-11 13:52:07 +0200986 * NOTE: nonblocking mode only applies to the input. We
987 * must not do the output in nonblocking mode as then we
988 * could get stuck data in the internal pipe:
989 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200990 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +0200991 if (unlikely(ret <= 0)) {
992 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200993 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200994 }
Jens Axboeb92ce552006-04-11 13:52:07 +0200995
996 bytes += ret;
997 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200998 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200999
Tom Zanussia82c53a2008-05-09 13:28:36 +02001000 if (ret < read_len) {
1001 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001002 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001003 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001004 }
1005
Jens Axboe9e971982008-01-29 21:05:57 +01001006done:
David Howells8cefc102019-11-15 13:30:32 +00001007 pipe->tail = pipe->head = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001008 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001009 return bytes;
1010
1011out_release:
1012 /*
1013 * If we did an incomplete transfer we must release
1014 * the pipe buffers in question:
1015 */
David Howells8cefc102019-11-15 13:30:32 +00001016 for (i = 0; i < pipe->ring_size; i++) {
1017 struct pipe_buffer *buf = &pipe->bufs[i];
Jens Axboeb92ce552006-04-11 13:52:07 +02001018
Miklos Szeredia7796382016-09-27 10:45:12 +02001019 if (buf->ops)
1020 pipe_buf_release(pipe, buf);
Jens Axboeb92ce552006-04-11 13:52:07 +02001021 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001022
Jens Axboe9e971982008-01-29 21:05:57 +01001023 if (!bytes)
1024 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001025
Jens Axboe9e971982008-01-29 21:05:57 +01001026 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001027}
1028EXPORT_SYMBOL(splice_direct_to_actor);
1029
1030static int direct_splice_actor(struct pipe_inode_info *pipe,
1031 struct splice_desc *sd)
1032{
Jens Axboe6a14b902007-06-14 13:08:55 +02001033 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001034
Al Viro7995bd22013-06-20 18:58:36 +04001035 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001036 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001037}
1038
Jens Axboe932cc6d2007-06-21 13:10:21 +02001039/**
1040 * do_splice_direct - splices data directly between two files
1041 * @in: file to splice from
1042 * @ppos: input file offset
1043 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001044 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001045 * @len: number of bytes to splice
1046 * @flags: splice modifier flags
1047 *
1048 * Description:
1049 * For use by do_sendfile(). splice can easily emulate sendfile, but
1050 * doing it in the application would incur an extra system call
1051 * (splice in + splice out, as compared to just sendfile()). So this helper
1052 * can splice directly through a process-private pipe.
1053 *
1054 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001055long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001056 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001057{
1058 struct splice_desc sd = {
1059 .len = len,
1060 .total_len = len,
1061 .flags = flags,
1062 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001063 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001064 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001065 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001066 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001067
Al Viro18c67cb2013-06-19 15:41:54 +04001068 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1069 return -EBADF;
1070
1071 if (unlikely(out->f_flags & O_APPEND))
1072 return -EINVAL;
1073
1074 ret = rw_verify_area(WRITE, out, opos, len);
1075 if (unlikely(ret < 0))
1076 return ret;
1077
Jens Axboec66ab6f2007-06-12 21:17:17 +02001078 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001079 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001080 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001081
Jens Axboec66ab6f2007-06-12 21:17:17 +02001082 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001083}
Miklos Szeredi1c118592014-10-24 00:14:35 +02001084EXPORT_SYMBOL(do_splice_direct);
Jens Axboeb92ce552006-04-11 13:52:07 +02001085
Al Viro8924fef2016-09-17 20:44:45 -04001086static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1087{
Linus Torvalds52bce912016-12-21 10:59:34 -08001088 for (;;) {
1089 if (unlikely(!pipe->readers)) {
1090 send_sig(SIGPIPE, current, 0);
1091 return -EPIPE;
1092 }
David Howells6718b6f2019-10-16 16:47:32 +01001093 if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage))
Linus Torvalds52bce912016-12-21 10:59:34 -08001094 return 0;
Al Viro8924fef2016-09-17 20:44:45 -04001095 if (flags & SPLICE_F_NONBLOCK)
1096 return -EAGAIN;
1097 if (signal_pending(current))
1098 return -ERESTARTSYS;
Linus Torvalds472e5b02020-10-01 19:14:36 -07001099 pipe_wait_writable(pipe);
Al Viro8924fef2016-09-17 20:44:45 -04001100 }
Al Viro8924fef2016-09-17 20:44:45 -04001101}
1102
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001103static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1104 struct pipe_inode_info *opipe,
1105 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001106
1107/*
Jens Axboe83f91352006-04-02 23:05:09 +02001108 * Determine where to splice to/from.
1109 */
Jens Axboeee6e00c2020-10-22 14:15:51 -06001110long do_splice(struct file *in, loff_t *off_in, struct file *out,
1111 loff_t *off_out, 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
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001118 if (unlikely(!(in->f_mode & FMODE_READ) ||
1119 !(out->f_mode & FMODE_WRITE)))
1120 return -EBADF;
1121
David Howellsc73be612020-01-14 17:07:11 +00001122 ipipe = get_pipe_info(in, true);
1123 opipe = get_pipe_info(out, true);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001124
1125 if (ipipe && opipe) {
1126 if (off_in || off_out)
1127 return -ESPIPE;
1128
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001129 /* Splicing to self would be fun, but... */
1130 if (ipipe == opipe)
1131 return -EINVAL;
1132
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001133 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1134 flags |= SPLICE_F_NONBLOCK;
1135
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001136 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1137 }
1138
1139 if (ipipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001140 if (off_in)
1141 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001142 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001143 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001144 return -EINVAL;
Jens Axboeee6e00c2020-10-22 14:15:51 -06001145 offset = *off_out;
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_flags & O_APPEND))
1151 return -EINVAL;
1152
1153 ret = rw_verify_area(WRITE, out, &offset, len);
1154 if (unlikely(ret < 0))
1155 return ret;
1156
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001157 if (in->f_flags & O_NONBLOCK)
1158 flags |= SPLICE_F_NONBLOCK;
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;
Jens Axboeee6e00c2020-10-22 14:15:51 -06001166 else
1167 *off_out = offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001168
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 Axboeee6e00c2020-10-22 14:15:51 -06001178 offset = *off_in;
Al Viro7995bd22013-06-20 18:58:36 +04001179 } else {
1180 offset = in->f_pos;
1181 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001182
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001183 if (out->f_flags & O_NONBLOCK)
1184 flags |= SPLICE_F_NONBLOCK;
1185
Al Viro8924fef2016-09-17 20:44:45 -04001186 pipe_lock(opipe);
1187 ret = wait_for_space(opipe, flags);
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001188 if (!ret) {
Linus Torvalds6a965662019-11-30 14:12:13 -08001189 unsigned int p_space;
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001190
1191 /* Don't try to read more the pipe has space for. */
Linus Torvalds6a965662019-11-30 14:12:13 -08001192 p_space = opipe->max_usage - pipe_occupancy(opipe->head, opipe->tail);
1193 len = min_t(size_t, len, p_space << PAGE_SHIFT);
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001194
Al Viro8924fef2016-09-17 20:44:45 -04001195 ret = do_splice_to(in, &offset, opipe, len, flags);
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001196 }
Al Viro8924fef2016-09-17 20:44:45 -04001197 pipe_unlock(opipe);
1198 if (ret > 0)
1199 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001200 if (!off_in)
1201 in->f_pos = offset;
Jens Axboeee6e00c2020-10-22 14:15:51 -06001202 else
1203 *off_in = offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001204
1205 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001206 }
Jens Axboe5274f052006-03-30 15:15:30 +02001207
1208 return -EINVAL;
1209}
1210
Jens Axboeee6e00c2020-10-22 14:15:51 -06001211static long __do_splice(struct file *in, loff_t __user *off_in,
1212 struct file *out, loff_t __user *off_out,
1213 size_t len, unsigned int flags)
1214{
1215 struct pipe_inode_info *ipipe;
1216 struct pipe_inode_info *opipe;
1217 loff_t offset, *__off_in = NULL, *__off_out = NULL;
1218 long ret;
1219
1220 ipipe = get_pipe_info(in, true);
1221 opipe = get_pipe_info(out, true);
1222
1223 if (ipipe && off_in)
1224 return -ESPIPE;
1225 if (opipe && off_out)
1226 return -ESPIPE;
1227
1228 if (off_out) {
1229 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
1230 return -EFAULT;
1231 __off_out = &offset;
1232 }
1233 if (off_in) {
1234 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
1235 return -EFAULT;
1236 __off_in = &offset;
1237 }
1238
1239 ret = do_splice(in, __off_in, out, __off_out, len, flags);
1240 if (ret < 0)
1241 return ret;
1242
1243 if (__off_out && copy_to_user(off_out, __off_out, sizeof(loff_t)))
1244 return -EFAULT;
1245 if (__off_in && copy_to_user(off_in, __off_in, sizeof(loff_t)))
1246 return -EFAULT;
1247
1248 return ret;
1249}
1250
Al Viro79fddc42016-09-17 22:38:20 -04001251static int iter_to_pipe(struct iov_iter *from,
1252 struct pipe_inode_info *pipe,
1253 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001254{
Al Viro79fddc42016-09-17 22:38:20 -04001255 struct pipe_buffer buf = {
1256 .ops = &user_page_pipe_buf_ops,
1257 .flags = flags
1258 };
1259 size_t total = 0;
1260 int ret = 0;
1261 bool failed = false;
1262
1263 while (iov_iter_count(from) && !failed) {
1264 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001265 ssize_t copied;
1266 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001267 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001268
Al Viro79fddc42016-09-17 22:38:20 -04001269 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1270 if (copied <= 0) {
1271 ret = copied;
1272 break;
1273 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001274
Al Viro79fddc42016-09-17 22:38:20 -04001275 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001276 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001277 if (!failed) {
1278 buf.page = pages[n];
1279 buf.offset = start;
1280 buf.len = size;
1281 ret = add_to_pipe(pipe, &buf);
1282 if (unlikely(ret < 0)) {
1283 failed = true;
1284 } else {
1285 iov_iter_advance(from, ret);
1286 total += ret;
1287 }
1288 } else {
1289 put_page(pages[n]);
1290 }
Al Virodb85a9e2016-09-17 20:25:06 -04001291 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001292 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001293 }
Al Viro79fddc42016-09-17 22:38:20 -04001294 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001295}
1296
Jens Axboe6a14b902007-06-14 13:08:55 +02001297static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1298 struct splice_desc *sd)
1299{
Al Viro6130f532014-02-03 18:19:51 -05001300 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1301 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001302}
1303
1304/*
1305 * For lack of a better implementation, implement vmsplice() to userspace
1306 * as a simple copy of the pipes pages to the user iov.
1307 */
Al Viro87a30022018-05-26 21:39:52 -04001308static long vmsplice_to_user(struct file *file, struct iov_iter *iter,
1309 unsigned int flags)
Jens Axboe6a14b902007-06-14 13:08:55 +02001310{
David Howellsc73be612020-01-14 17:07:11 +00001311 struct pipe_inode_info *pipe = get_pipe_info(file, true);
Al Viro87a30022018-05-26 21:39:52 -04001312 struct splice_desc sd = {
1313 .total_len = iov_iter_count(iter),
1314 .flags = flags,
1315 .u.data = iter
1316 };
1317 long ret = 0;
Jens Axboe6a14b902007-06-14 13:08:55 +02001318
Jens Axboe6a14b902007-06-14 13:08:55 +02001319 if (!pipe)
1320 return -EBADF;
1321
Al Viro345995f2015-03-21 19:17:55 -04001322 if (sd.total_len) {
1323 pipe_lock(pipe);
1324 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1325 pipe_unlock(pipe);
1326 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001327
Jens Axboe6a14b902007-06-14 13:08:55 +02001328 return ret;
1329}
1330
Jens Axboe912d35f2006-04-26 10:59:21 +02001331/*
1332 * vmsplice splices a user address range into a pipe. It can be thought of
1333 * as splice-from-memory, where the regular splice is splice-from-file (or
1334 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001335 */
Al Viro87a30022018-05-26 21:39:52 -04001336static long vmsplice_to_pipe(struct file *file, struct iov_iter *iter,
1337 unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001338{
Jens Axboeddac0d32006-11-04 12:49:32 +01001339 struct pipe_inode_info *pipe;
Al Viro87a30022018-05-26 21:39:52 -04001340 long ret = 0;
Al Viro79fddc42016-09-17 22:38:20 -04001341 unsigned buf_flag = 0;
1342
1343 if (flags & SPLICE_F_GIFT)
1344 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001345
David Howellsc73be612020-01-14 17:07:11 +00001346 pipe = get_pipe_info(file, true);
Jens Axboeddac0d32006-11-04 12:49:32 +01001347 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001348 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001349
Al Viro8924fef2016-09-17 20:44:45 -04001350 pipe_lock(pipe);
1351 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001352 if (!ret)
Al Viro87a30022018-05-26 21:39:52 -04001353 ret = iter_to_pipe(iter, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001354 pipe_unlock(pipe);
1355 if (ret > 0)
1356 wakeup_pipe_readers(pipe);
Jens Axboe35f3d142010-05-20 10:43:18 +02001357 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001358}
1359
Al Viro87a30022018-05-26 21:39:52 -04001360static int vmsplice_type(struct fd f, int *type)
1361{
1362 if (!f.file)
1363 return -EBADF;
1364 if (f.file->f_mode & FMODE_WRITE) {
1365 *type = WRITE;
1366 } else if (f.file->f_mode & FMODE_READ) {
1367 *type = READ;
1368 } else {
1369 fdput(f);
1370 return -EBADF;
1371 }
1372 return 0;
1373}
1374
Jens Axboe6a14b902007-06-14 13:08:55 +02001375/*
1376 * Note that vmsplice only really supports true splicing _from_ user memory
1377 * to a pipe, not the other way around. Splicing from user memory is a simple
1378 * operation that can be supported without any funky alignment restrictions
1379 * or nasty vm tricks. We simply map in the user memory and fill them into
1380 * a pipe. The reverse isn't quite as easy, though. There are two possible
1381 * solutions for that:
1382 *
1383 * - memcpy() the data internally, at which point we might as well just
1384 * do a regular read() on the buffer anyway.
1385 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1386 * has restriction limitations on both ends of the pipe).
1387 *
1388 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1389 *
1390 */
Al Viro87a30022018-05-26 21:39:52 -04001391SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, uiov,
Dominik Brodowski30cfe4e2018-03-17 15:00:24 +01001392 unsigned long, nr_segs, unsigned int, flags)
1393{
Al Viro87a30022018-05-26 21:39:52 -04001394 struct iovec iovstack[UIO_FASTIOV];
1395 struct iovec *iov = iovstack;
1396 struct iov_iter iter;
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001397 ssize_t error;
Al Viro87a30022018-05-26 21:39:52 -04001398 struct fd f;
1399 int type;
1400
Christoph Hellwig598b3ce2020-09-25 06:51:44 +02001401 if (unlikely(flags & ~SPLICE_F_ALL))
1402 return -EINVAL;
1403
Al Viro87a30022018-05-26 21:39:52 -04001404 f = fdget(fd);
1405 error = vmsplice_type(f, &type);
1406 if (error)
1407 return error;
1408
1409 error = import_iovec(type, uiov, nr_segs,
1410 ARRAY_SIZE(iovstack), &iov, &iter);
Christoph Hellwig598b3ce2020-09-25 06:51:44 +02001411 if (error < 0)
1412 goto out_fdput;
1413
1414 if (!iov_iter_count(&iter))
1415 error = 0;
1416 else if (iov_iter_rw(&iter) == WRITE)
1417 error = vmsplice_to_pipe(f.file, &iter, flags);
1418 else
1419 error = vmsplice_to_user(f.file, &iter, flags);
1420
1421 kfree(iov);
1422out_fdput:
Al Viro87a30022018-05-26 21:39:52 -04001423 fdput(f);
1424 return error;
Dominik Brodowski30cfe4e2018-03-17 15:00:24 +01001425}
1426
Heiko Carstens836f92a2009-01-14 14:14:33 +01001427SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1428 int, fd_out, loff_t __user *, off_out,
1429 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001430{
Al Viro2903ff02012-08-28 12:52:22 -04001431 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001432 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001433
1434 if (unlikely(!len))
1435 return 0;
1436
Al Viro3d6ea292016-12-10 13:17:32 -05001437 if (unlikely(flags & ~SPLICE_F_ALL))
1438 return -EINVAL;
1439
Jens Axboe5274f052006-03-30 15:15:30 +02001440 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001441 in = fdget(fd_in);
1442 if (in.file) {
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001443 out = fdget(fd_out);
1444 if (out.file) {
Jens Axboeee6e00c2020-10-22 14:15:51 -06001445 error = __do_splice(in.file, off_in, out.file, off_out,
1446 len, flags);
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001447 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001448 }
Al Viro2903ff02012-08-28 12:52:22 -04001449 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001450 }
Jens Axboe5274f052006-03-30 15:15:30 +02001451 return error;
1452}
Jens Axboe70524492006-04-11 15:51:17 +02001453
1454/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001455 * Make sure there's data to read. Wait for input if we can, otherwise
1456 * return an appropriate error.
1457 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001458static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001459{
1460 int ret;
1461
1462 /*
David Howells8cefc102019-11-15 13:30:32 +00001463 * Check the pipe occupancy without the inode lock first. This function
Jens Axboeaadd06e2006-07-10 11:00:01 +02001464 * is speculative anyways, so missing one is ok.
1465 */
David Howells8cefc102019-11-15 13:30:32 +00001466 if (!pipe_empty(pipe->head, pipe->tail))
Jens Axboeaadd06e2006-07-10 11:00:01 +02001467 return 0;
1468
1469 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001470 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001471
David Howells8cefc102019-11-15 13:30:32 +00001472 while (pipe_empty(pipe->head, pipe->tail)) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001473 if (signal_pending(current)) {
1474 ret = -ERESTARTSYS;
1475 break;
1476 }
1477 if (!pipe->writers)
1478 break;
Linus Torvaldsa28c8b92019-12-07 13:21:01 -08001479 if (flags & SPLICE_F_NONBLOCK) {
1480 ret = -EAGAIN;
1481 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001482 }
Linus Torvalds472e5b02020-10-01 19:14:36 -07001483 pipe_wait_readable(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001484 }
1485
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001486 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001487 return ret;
1488}
1489
1490/*
1491 * Make sure there's writeable room. Wait for room if we can, otherwise
1492 * return an appropriate error.
1493 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001494static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001495{
1496 int ret;
1497
1498 /*
David Howells8cefc102019-11-15 13:30:32 +00001499 * Check pipe occupancy without the inode lock first. This function
Jens Axboeaadd06e2006-07-10 11:00:01 +02001500 * is speculative anyways, so missing one is ok.
1501 */
Tetsuo Handa566d1362020-05-20 08:51:59 +09001502 if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage))
Jens Axboeaadd06e2006-07-10 11:00:01 +02001503 return 0;
1504
1505 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001506 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001507
David Howells6718b6f2019-10-16 16:47:32 +01001508 while (pipe_full(pipe->head, pipe->tail, pipe->max_usage)) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001509 if (!pipe->readers) {
1510 send_sig(SIGPIPE, current, 0);
1511 ret = -EPIPE;
1512 break;
1513 }
1514 if (flags & SPLICE_F_NONBLOCK) {
1515 ret = -EAGAIN;
1516 break;
1517 }
1518 if (signal_pending(current)) {
1519 ret = -ERESTARTSYS;
1520 break;
1521 }
Linus Torvalds472e5b02020-10-01 19:14:36 -07001522 pipe_wait_writable(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001523 }
1524
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001525 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001526 return ret;
1527}
1528
1529/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001530 * Splice contents of ipipe to opipe.
1531 */
1532static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1533 struct pipe_inode_info *opipe,
1534 size_t len, unsigned int flags)
1535{
1536 struct pipe_buffer *ibuf, *obuf;
David Howells8cefc102019-11-15 13:30:32 +00001537 unsigned int i_head, o_head;
1538 unsigned int i_tail, o_tail;
1539 unsigned int i_mask, o_mask;
1540 int ret = 0;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001541 bool input_wakeup = false;
1542
1543
1544retry:
1545 ret = ipipe_prep(ipipe, flags);
1546 if (ret)
1547 return ret;
1548
1549 ret = opipe_prep(opipe, flags);
1550 if (ret)
1551 return ret;
1552
1553 /*
1554 * Potential ABBA deadlock, work around it by ordering lock
1555 * grabbing by pipe info address. Otherwise two different processes
1556 * could deadlock (one doing tee from A -> B, the other from B -> A).
1557 */
1558 pipe_double_lock(ipipe, opipe);
1559
David Howells8cefc102019-11-15 13:30:32 +00001560 i_tail = ipipe->tail;
1561 i_mask = ipipe->ring_size - 1;
1562 o_head = opipe->head;
1563 o_mask = opipe->ring_size - 1;
1564
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001565 do {
David Howells8cefc102019-11-15 13:30:32 +00001566 size_t o_len;
1567
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001568 if (!opipe->readers) {
1569 send_sig(SIGPIPE, current, 0);
1570 if (!ret)
1571 ret = -EPIPE;
1572 break;
1573 }
1574
David Howells8cefc102019-11-15 13:30:32 +00001575 i_head = ipipe->head;
1576 o_tail = opipe->tail;
1577
1578 if (pipe_empty(i_head, i_tail) && !ipipe->writers)
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001579 break;
1580
1581 /*
1582 * Cannot make any progress, because either the input
1583 * pipe is empty or the output pipe is full.
1584 */
David Howells8cefc102019-11-15 13:30:32 +00001585 if (pipe_empty(i_head, i_tail) ||
David Howells6718b6f2019-10-16 16:47:32 +01001586 pipe_full(o_head, o_tail, opipe->max_usage)) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001587 /* Already processed some buffers, break */
1588 if (ret)
1589 break;
1590
1591 if (flags & SPLICE_F_NONBLOCK) {
1592 ret = -EAGAIN;
1593 break;
1594 }
1595
1596 /*
1597 * We raced with another reader/writer and haven't
1598 * managed to process any buffers. A zero return
1599 * value means EOF, so retry instead.
1600 */
1601 pipe_unlock(ipipe);
1602 pipe_unlock(opipe);
1603 goto retry;
1604 }
1605
David Howells8cefc102019-11-15 13:30:32 +00001606 ibuf = &ipipe->bufs[i_tail & i_mask];
1607 obuf = &opipe->bufs[o_head & o_mask];
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001608
1609 if (len >= ibuf->len) {
1610 /*
1611 * Simply move the whole buffer from ipipe to opipe
1612 */
1613 *obuf = *ibuf;
1614 ibuf->ops = NULL;
David Howells8cefc102019-11-15 13:30:32 +00001615 i_tail++;
1616 ipipe->tail = i_tail;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001617 input_wakeup = true;
David Howells8cefc102019-11-15 13:30:32 +00001618 o_len = obuf->len;
1619 o_head++;
1620 opipe->head = o_head;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001621 } else {
1622 /*
1623 * Get a reference to this pipe buffer,
1624 * so we can copy the contents over.
1625 */
Matthew Wilcox15fab632019-04-05 14:02:10 -07001626 if (!pipe_buf_get(ipipe, ibuf)) {
1627 if (ret == 0)
1628 ret = -EFAULT;
1629 break;
1630 }
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001631 *obuf = *ibuf;
1632
1633 /*
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001634 * Don't inherit the gift and merge flags, we need to
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001635 * prevent multiple steals of this page.
1636 */
1637 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001638 obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE;
Jann Horna0ce2f02019-01-23 15:19:17 +01001639
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001640 obuf->len = len;
David Howells8cefc102019-11-15 13:30:32 +00001641 ibuf->offset += len;
1642 ibuf->len -= len;
1643 o_len = len;
1644 o_head++;
1645 opipe->head = o_head;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001646 }
David Howells8cefc102019-11-15 13:30:32 +00001647 ret += o_len;
1648 len -= o_len;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001649 } while (len);
1650
1651 pipe_unlock(ipipe);
1652 pipe_unlock(opipe);
1653
1654 /*
1655 * If we put data in the output pipe, wakeup any potential readers.
1656 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001657 if (ret > 0)
1658 wakeup_pipe_readers(opipe);
1659
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001660 if (input_wakeup)
1661 wakeup_pipe_writers(ipipe);
1662
1663 return ret;
1664}
1665
1666/*
Jens Axboe70524492006-04-11 15:51:17 +02001667 * Link contents of ipipe to opipe.
1668 */
1669static int link_pipe(struct pipe_inode_info *ipipe,
1670 struct pipe_inode_info *opipe,
1671 size_t len, unsigned int flags)
1672{
1673 struct pipe_buffer *ibuf, *obuf;
David Howells8cefc102019-11-15 13:30:32 +00001674 unsigned int i_head, o_head;
1675 unsigned int i_tail, o_tail;
1676 unsigned int i_mask, o_mask;
1677 int ret = 0;
Jens Axboe70524492006-04-11 15:51:17 +02001678
1679 /*
1680 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001681 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001682 * could deadlock (one doing tee from A -> B, the other from B -> A).
1683 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001684 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001685
David Howells8cefc102019-11-15 13:30:32 +00001686 i_tail = ipipe->tail;
1687 i_mask = ipipe->ring_size - 1;
1688 o_head = opipe->head;
1689 o_mask = opipe->ring_size - 1;
1690
Jens Axboeaadd06e2006-07-10 11:00:01 +02001691 do {
Jens Axboe70524492006-04-11 15:51:17 +02001692 if (!opipe->readers) {
1693 send_sig(SIGPIPE, current, 0);
1694 if (!ret)
1695 ret = -EPIPE;
1696 break;
1697 }
Jens Axboe70524492006-04-11 15:51:17 +02001698
David Howells8cefc102019-11-15 13:30:32 +00001699 i_head = ipipe->head;
1700 o_tail = opipe->tail;
1701
Jens Axboe70524492006-04-11 15:51:17 +02001702 /*
David Howells8cefc102019-11-15 13:30:32 +00001703 * If we have iterated all input buffers or run out of
Jens Axboeaadd06e2006-07-10 11:00:01 +02001704 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001705 */
David Howells8cefc102019-11-15 13:30:32 +00001706 if (pipe_empty(i_head, i_tail) ||
David Howells6718b6f2019-10-16 16:47:32 +01001707 pipe_full(o_head, o_tail, opipe->max_usage))
Jens Axboe70524492006-04-11 15:51:17 +02001708 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001709
David Howells8cefc102019-11-15 13:30:32 +00001710 ibuf = &ipipe->bufs[i_tail & i_mask];
1711 obuf = &opipe->bufs[o_head & o_mask];
Jens Axboeaadd06e2006-07-10 11:00:01 +02001712
Jens Axboe2a27250e2006-04-19 15:56:40 +02001713 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001714 * Get a reference to this pipe buffer,
1715 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001716 */
Matthew Wilcox15fab632019-04-05 14:02:10 -07001717 if (!pipe_buf_get(ipipe, ibuf)) {
1718 if (ret == 0)
1719 ret = -EFAULT;
1720 break;
1721 }
Jens Axboe70524492006-04-11 15:51:17 +02001722
Jens Axboeaadd06e2006-07-10 11:00:01 +02001723 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001724
Jens Axboeaadd06e2006-07-10 11:00:01 +02001725 /*
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001726 * Don't inherit the gift and merge flag, we need to prevent
1727 * multiple steals of this page.
Jens Axboeaadd06e2006-07-10 11:00:01 +02001728 */
1729 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001730 obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE;
Jann Horna0ce2f02019-01-23 15:19:17 +01001731
Jens Axboeaadd06e2006-07-10 11:00:01 +02001732 if (obuf->len > len)
1733 obuf->len = len;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001734 ret += obuf->len;
1735 len -= obuf->len;
David Howells8cefc102019-11-15 13:30:32 +00001736
1737 o_head++;
1738 opipe->head = o_head;
1739 i_tail++;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001740 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001741
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001742 pipe_unlock(ipipe);
1743 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001744
Jens Axboeaadd06e2006-07-10 11:00:01 +02001745 /*
1746 * If we put data in the output pipe, wakeup any potential readers.
1747 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001748 if (ret > 0)
1749 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001750
1751 return ret;
1752}
1753
1754/*
1755 * This is a tee(1) implementation that works on pipes. It doesn't copy
1756 * any data, it simply references the 'in' pages on the 'out' pipe.
1757 * The 'flags' used are the SPLICE_F_* variants, currently the only
1758 * applicable one is SPLICE_F_NONBLOCK.
1759 */
Pavel Begunkov9dafdfc2020-05-17 14:18:05 +03001760long do_tee(struct file *in, struct file *out, size_t len, unsigned int flags)
Jens Axboe70524492006-04-11 15:51:17 +02001761{
David Howellsc73be612020-01-14 17:07:11 +00001762 struct pipe_inode_info *ipipe = get_pipe_info(in, true);
1763 struct pipe_inode_info *opipe = get_pipe_info(out, true);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001764 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001765
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001766 if (unlikely(!(in->f_mode & FMODE_READ) ||
1767 !(out->f_mode & FMODE_WRITE)))
1768 return -EBADF;
1769
Jens Axboe70524492006-04-11 15:51:17 +02001770 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001771 * Duplicate the contents of ipipe to opipe without actually
1772 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001773 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001774 if (ipipe && opipe && ipipe != opipe) {
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001775 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1776 flags |= SPLICE_F_NONBLOCK;
1777
Jens Axboeaadd06e2006-07-10 11:00:01 +02001778 /*
1779 * Keep going, unless we encounter an error. The ipipe/opipe
1780 * ordering doesn't really matter.
1781 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001782 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001783 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001784 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001785 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001786 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001787 }
1788 }
Jens Axboe70524492006-04-11 15:51:17 +02001789
Jens Axboeaadd06e2006-07-10 11:00:01 +02001790 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001791}
1792
Heiko Carstens836f92a2009-01-14 14:14:33 +01001793SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001794{
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001795 struct fd in, out;
Al Viro2903ff02012-08-28 12:52:22 -04001796 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001797
Al Viro3d6ea292016-12-10 13:17:32 -05001798 if (unlikely(flags & ~SPLICE_F_ALL))
1799 return -EINVAL;
1800
Jens Axboe70524492006-04-11 15:51:17 +02001801 if (unlikely(!len))
1802 return 0;
1803
1804 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001805 in = fdget(fdin);
1806 if (in.file) {
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001807 out = fdget(fdout);
1808 if (out.file) {
1809 error = do_tee(in.file, out.file, len, flags);
1810 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001811 }
Al Viro2903ff02012-08-28 12:52:22 -04001812 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001813 }
1814
1815 return error;
1816}