blob: ce75aec5227441cd028b48b2b177ec73a5d173ac [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 */
Christoph Hellwigc928f642020-05-20 17:58:16 +020047static bool page_cache_pipe_buf_try_steal(struct pipe_inode_info *pipe,
48 struct pipe_buffer *buf)
Jens Axboe5abc97a2006-03-30 15:16:46 +020049{
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;
Christoph Hellwigc928f642020-05-20 17:58:16 +020079 return true;
Jens Axboe9e94cd42006-06-20 15:01:12 +020080 }
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);
Christoph Hellwigc928f642020-05-20 17:58:16 +020089 return false;
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 = {
Christoph Hellwigc928f642020-05-20 17:58:16 +0200142 .confirm = page_cache_pipe_buf_confirm,
143 .release = page_cache_pipe_buf_release,
144 .try_steal = page_cache_pipe_buf_try_steal,
145 .get = generic_pipe_buf_get,
Jens Axboe5274f052006-03-30 15:15:30 +0200146};
147
Christoph Hellwigc928f642020-05-20 17:58:16 +0200148static bool user_page_pipe_buf_try_steal(struct pipe_inode_info *pipe,
149 struct pipe_buffer *buf)
Jens Axboe912d35f2006-04-26 10:59:21 +0200150{
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200151 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
Christoph Hellwigc928f642020-05-20 17:58:16 +0200152 return false;
Jens Axboe7afa6fd2006-05-01 20:02:33 +0200153
Jens Axboe14328732006-05-03 10:35:26 +0200154 buf->flags |= PIPE_BUF_FLAG_LRU;
Christoph Hellwigc928f642020-05-20 17:58:16 +0200155 return generic_pipe_buf_try_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 = {
Christoph Hellwigc928f642020-05-20 17:58:16 +0200159 .release = page_cache_pipe_buf_release,
160 .try_steal = user_page_pipe_buf_try_steal,
161 .get = generic_pipe_buf_get,
Jens Axboe912d35f2006-04-26 10:59:21 +0200162};
163
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200164static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
165{
166 smp_mb();
Linus Torvalds0ddad212019-12-09 09:48:27 -0800167 if (waitqueue_active(&pipe->rd_wait))
168 wake_up_interruptible(&pipe->rd_wait);
Namhyung Kim825cdcb2011-05-23 19:58:53 +0200169 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
170}
171
Jens Axboe932cc6d2007-06-21 13:10:21 +0200172/**
173 * splice_to_pipe - fill passed data into a pipe
174 * @pipe: pipe to fill
175 * @spd: data to fill
176 *
177 * Description:
Randy Dunlap79685b82007-07-27 08:08:51 +0200178 * @spd contains a map of pages and len/offset tuples, along with
Jens Axboe932cc6d2007-06-21 13:10:21 +0200179 * the struct pipe_buf_operations associated with these pages. This
180 * function will link that data to the pipe.
181 *
Jens Axboe83f91352006-04-02 23:05:09 +0200182 */
Jens Axboed6b29d72007-06-04 09:59:47 +0200183ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
184 struct splice_pipe_desc *spd)
Jens Axboe5274f052006-03-30 15:15:30 +0200185{
Jens Axboe00de00b2007-06-15 13:14:22 +0200186 unsigned int spd_pages = spd->nr_pages;
David Howells8cefc102019-11-15 13:30:32 +0000187 unsigned int tail = pipe->tail;
188 unsigned int head = pipe->head;
189 unsigned int mask = pipe->ring_size - 1;
Al Viro8924fef2016-09-17 20:44:45 -0400190 int ret = 0, page_nr = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200191
Rabin Vincentd6785d92016-03-10 21:19:06 +0100192 if (!spd_pages)
193 return 0;
194
Al Viro8924fef2016-09-17 20:44:45 -0400195 if (unlikely(!pipe->readers)) {
196 send_sig(SIGPIPE, current, 0);
197 ret = -EPIPE;
198 goto out;
Jens Axboe5274f052006-03-30 15:15:30 +0200199 }
200
David Howells6718b6f2019-10-16 16:47:32 +0100201 while (!pipe_full(head, tail, pipe->max_usage)) {
David Howells8cefc102019-11-15 13:30:32 +0000202 struct pipe_buffer *buf = &pipe->bufs[head & mask];
Jens Axboe5274f052006-03-30 15:15:30 +0200203
Al Viro8924fef2016-09-17 20:44:45 -0400204 buf->page = spd->pages[page_nr];
205 buf->offset = spd->partial[page_nr].offset;
206 buf->len = spd->partial[page_nr].len;
207 buf->private = spd->partial[page_nr].private;
208 buf->ops = spd->ops;
Miklos Szeredi5a81e6a2017-02-16 17:49:02 +0100209 buf->flags = 0;
Jens Axboe5274f052006-03-30 15:15:30 +0200210
David Howells8cefc102019-11-15 13:30:32 +0000211 head++;
212 pipe->head = head;
Al Viro8924fef2016-09-17 20:44:45 -0400213 page_nr++;
214 ret += buf->len;
215
216 if (!--spd->nr_pages)
217 break;
218 }
219
220 if (!ret)
221 ret = -EAGAIN;
222
223out:
Jens Axboe00de00b2007-06-15 13:14:22 +0200224 while (page_nr < spd_pages)
Jens Axboebbdfc2f2007-11-06 23:29:47 -0800225 spd->spd_release(spd, page_nr++);
Jens Axboe5274f052006-03-30 15:15:30 +0200226
227 return ret;
228}
Hannes Frederic Sowa2b514572015-05-21 17:00:01 +0200229EXPORT_SYMBOL_GPL(splice_to_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200230
Al Viro79fddc42016-09-17 22:38:20 -0400231ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
232{
David Howells8cefc102019-11-15 13:30:32 +0000233 unsigned int head = pipe->head;
234 unsigned int tail = pipe->tail;
235 unsigned int mask = pipe->ring_size - 1;
Al Viro79fddc42016-09-17 22:38:20 -0400236 int ret;
237
238 if (unlikely(!pipe->readers)) {
239 send_sig(SIGPIPE, current, 0);
240 ret = -EPIPE;
David Howells6718b6f2019-10-16 16:47:32 +0100241 } else if (pipe_full(head, tail, pipe->max_usage)) {
Al Viro79fddc42016-09-17 22:38:20 -0400242 ret = -EAGAIN;
243 } else {
David Howells8cefc102019-11-15 13:30:32 +0000244 pipe->bufs[head & mask] = *buf;
245 pipe->head = head + 1;
Al Viro79fddc42016-09-17 22:38:20 -0400246 return buf->len;
247 }
Miklos Szeredia7796382016-09-27 10:45:12 +0200248 pipe_buf_release(pipe, buf);
Al Viro79fddc42016-09-17 22:38:20 -0400249 return ret;
250}
251EXPORT_SYMBOL(add_to_pipe);
252
Jens Axboe35f3d142010-05-20 10:43:18 +0200253/*
254 * Check if we need to grow the arrays holding pages and partial page
255 * descriptions.
256 */
Eric Dumazet047fe362012-06-12 15:24:40 +0200257int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200258{
David Howells6718b6f2019-10-16 16:47:32 +0100259 unsigned int max_usage = READ_ONCE(pipe->max_usage);
Eric Dumazet047fe362012-06-12 15:24:40 +0200260
David Howells8cefc102019-11-15 13:30:32 +0000261 spd->nr_pages_max = max_usage;
262 if (max_usage <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200263 return 0;
264
David Howells8cefc102019-11-15 13:30:32 +0000265 spd->pages = kmalloc_array(max_usage, sizeof(struct page *), GFP_KERNEL);
266 spd->partial = kmalloc_array(max_usage, sizeof(struct partial_page),
Kees Cook6da2ec52018-06-12 13:55:00 -0700267 GFP_KERNEL);
Jens Axboe35f3d142010-05-20 10:43:18 +0200268
269 if (spd->pages && spd->partial)
270 return 0;
271
272 kfree(spd->pages);
273 kfree(spd->partial);
274 return -ENOMEM;
275}
276
Eric Dumazet047fe362012-06-12 15:24:40 +0200277void splice_shrink_spd(struct splice_pipe_desc *spd)
Jens Axboe35f3d142010-05-20 10:43:18 +0200278{
Eric Dumazet047fe362012-06-12 15:24:40 +0200279 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
Jens Axboe35f3d142010-05-20 10:43:18 +0200280 return;
281
282 kfree(spd->pages);
283 kfree(spd->partial);
284}
285
Jens Axboe83f91352006-04-02 23:05:09 +0200286/**
287 * generic_file_splice_read - splice data from file to a pipe
288 * @in: file to splice from
Jens Axboe932cc6d2007-06-21 13:10:21 +0200289 * @ppos: position in @in
Jens Axboe83f91352006-04-02 23:05:09 +0200290 * @pipe: pipe to splice to
291 * @len: number of bytes to splice
292 * @flags: splice modifier flags
293 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200294 * Description:
295 * Will read pages from given file and fill them into a pipe. Can be
Al Viro82c156f2016-09-22 23:35:42 -0400296 * used as long as it has more or less sane ->read_iter().
Jens Axboe932cc6d2007-06-21 13:10:21 +0200297 *
Jens Axboe83f91352006-04-02 23:05:09 +0200298 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200299ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
300 struct pipe_inode_info *pipe, size_t len,
301 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200302{
Al Viro82c156f2016-09-22 23:35:42 -0400303 struct iov_iter to;
304 struct kiocb kiocb;
David Howells8cefc102019-11-15 13:30:32 +0000305 unsigned int i_head;
306 int ret;
Boaz Harroshbe64f882015-04-15 16:15:17 -0700307
David Howellsaa563d72018-10-20 00:57:56 +0100308 iov_iter_pipe(&to, READ, pipe, len);
David Howells8cefc102019-11-15 13:30:32 +0000309 i_head = to.head;
Al Viro82c156f2016-09-22 23:35:42 -0400310 init_sync_kiocb(&kiocb, in);
311 kiocb.ki_pos = *ppos;
Miklos Szeredibb7462b2017-02-20 16:51:23 +0100312 ret = call_read_iter(in, &kiocb, &to);
Miklos Szeredi723590e2009-08-15 08:43:22 +0200313 if (ret > 0) {
Al Viro82c156f2016-09-22 23:35:42 -0400314 *ppos = kiocb.ki_pos;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200315 file_accessed(in);
Al Viro82c156f2016-09-22 23:35:42 -0400316 } else if (ret < 0) {
David Howells8cefc102019-11-15 13:30:32 +0000317 to.head = i_head;
Al Viroc3a69022016-10-10 13:26:27 -0400318 to.iov_offset = 0;
319 iov_iter_advance(&to, 0); /* to free what was emitted */
Al Viro82c156f2016-09-22 23:35:42 -0400320 /*
321 * callers of ->splice_read() expect -EAGAIN on
322 * "can't put anything in there", rather than -EFAULT.
323 */
324 if (ret == -EFAULT)
325 ret = -EAGAIN;
Miklos Szeredi723590e2009-08-15 08:43:22 +0200326 }
Jens Axboe5274f052006-03-30 15:15:30 +0200327
328 return ret;
329}
Jens Axboe059a8f32006-04-02 23:06:05 +0200330EXPORT_SYMBOL(generic_file_splice_read);
331
Al Viro241699c2016-09-22 16:33:12 -0400332const struct pipe_buf_operations default_pipe_buf_ops = {
Christoph Hellwigc928f642020-05-20 17:58:16 +0200333 .release = generic_pipe_buf_release,
334 .try_steal = generic_pipe_buf_try_steal,
335 .get = generic_pipe_buf_get,
Miklos Szeredi68181732009-05-07 15:37:36 +0200336};
337
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100338/* Pipe buffer operations for a socket and similar. */
339const struct pipe_buf_operations nosteal_pipe_buf_ops = {
Christoph Hellwigc928f642020-05-20 17:58:16 +0200340 .release = generic_pipe_buf_release,
341 .get = generic_pipe_buf_get,
Miklos Szeredi28a625c2014-01-22 19:36:57 +0100342};
343EXPORT_SYMBOL(nosteal_pipe_buf_ops);
344
Al Viro523ac9a2016-09-23 15:34:57 -0400345static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
Miklos Szeredi68181732009-05-07 15:37:36 +0200346 unsigned long vlen, loff_t offset)
347{
348 mm_segment_t old_fs;
349 loff_t pos = offset;
350 ssize_t res;
351
352 old_fs = get_fs();
Linus Torvalds736706b2019-03-04 10:39:05 -0800353 set_fs(KERNEL_DS);
Miklos Szeredi68181732009-05-07 15:37:36 +0200354 /* The cast to a user pointer is valid due to the set_fs() */
Christoph Hellwig793b80e2016-03-03 16:03:58 +0100355 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
Miklos Szeredi68181732009-05-07 15:37:36 +0200356 set_fs(old_fs);
357
358 return res;
359}
360
Al Viro82c156f2016-09-22 23:35:42 -0400361static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
Miklos Szeredi68181732009-05-07 15:37:36 +0200362 struct pipe_inode_info *pipe, size_t len,
363 unsigned int flags)
364{
Al Viro523ac9a2016-09-23 15:34:57 -0400365 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
366 struct iov_iter to;
367 struct page **pages;
Miklos Szeredi68181732009-05-07 15:37:36 +0200368 unsigned int nr_pages;
David Howells8cefc102019-11-15 13:30:32 +0000369 unsigned int mask;
Al Viro13c0f522016-12-10 13:20:53 -0500370 size_t offset, base, copied = 0;
Miklos Szeredi68181732009-05-07 15:37:36 +0200371 ssize_t res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200372 int i;
Miklos Szeredi68181732009-05-07 15:37:36 +0200373
David Howells6718b6f2019-10-16 16:47:32 +0100374 if (pipe_full(pipe->head, pipe->tail, pipe->max_usage))
Al Viro523ac9a2016-09-23 15:34:57 -0400375 return -EAGAIN;
376
377 /*
378 * Try to keep page boundaries matching to source pagecache ones -
379 * it probably won't be much help, but...
380 */
381 offset = *ppos & ~PAGE_MASK;
382
David Howellsaa563d72018-10-20 00:57:56 +0100383 iov_iter_pipe(&to, READ, pipe, len + offset);
Al Viro523ac9a2016-09-23 15:34:57 -0400384
Al Viro13c0f522016-12-10 13:20:53 -0500385 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &base);
Al Viro523ac9a2016-09-23 15:34:57 -0400386 if (res <= 0)
Jens Axboe35f3d142010-05-20 10:43:18 +0200387 return -ENOMEM;
388
Al Viro13c0f522016-12-10 13:20:53 -0500389 nr_pages = DIV_ROUND_UP(res + base, PAGE_SIZE);
Al Viro523ac9a2016-09-23 15:34:57 -0400390
Jens Axboe35f3d142010-05-20 10:43:18 +0200391 vec = __vec;
Al Viro523ac9a2016-09-23 15:34:57 -0400392 if (nr_pages > PIPE_DEF_BUFFERS) {
Kees Cook6da2ec52018-06-12 13:55:00 -0700393 vec = kmalloc_array(nr_pages, sizeof(struct kvec), GFP_KERNEL);
Al Viro523ac9a2016-09-23 15:34:57 -0400394 if (unlikely(!vec)) {
395 res = -ENOMEM;
396 goto out;
397 }
Jens Axboe35f3d142010-05-20 10:43:18 +0200398 }
399
David Howells8cefc102019-11-15 13:30:32 +0000400 mask = pipe->ring_size - 1;
401 pipe->bufs[to.head & mask].offset = offset;
402 pipe->bufs[to.head & mask].len -= offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200403
Al Viro523ac9a2016-09-23 15:34:57 -0400404 for (i = 0; i < nr_pages; i++) {
405 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
406 vec[i].iov_base = page_address(pages[i]) + offset;
Miklos Szeredi68181732009-05-07 15:37:36 +0200407 vec[i].iov_len = this_len;
Miklos Szeredi68181732009-05-07 15:37:36 +0200408 len -= this_len;
409 offset = 0;
410 }
411
Al Viro523ac9a2016-09-23 15:34:57 -0400412 res = kernel_readv(in, vec, nr_pages, *ppos);
413 if (res > 0) {
414 copied = res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200415 *ppos += res;
Al Viro523ac9a2016-09-23 15:34:57 -0400416 }
Miklos Szeredi68181732009-05-07 15:37:36 +0200417
Jens Axboe35f3d142010-05-20 10:43:18 +0200418 if (vec != __vec)
419 kfree(vec);
Al Viro523ac9a2016-09-23 15:34:57 -0400420out:
421 for (i = 0; i < nr_pages; i++)
422 put_page(pages[i]);
423 kvfree(pages);
424 iov_iter_advance(&to, copied); /* truncates and discards */
Miklos Szeredi68181732009-05-07 15:37:36 +0200425 return res;
Miklos Szeredi68181732009-05-07 15:37:36 +0200426}
Miklos Szeredi68181732009-05-07 15:37:36 +0200427
Jens Axboe5274f052006-03-30 15:15:30 +0200428/*
Jens Axboe4f6f0bd2006-04-02 23:04:46 +0200429 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
Jens Axboe016b6612006-04-25 15:42:00 +0200430 * using sendpage(). Return the number of bytes sent.
Jens Axboe5274f052006-03-30 15:15:30 +0200431 */
Jens Axboe76ad4d12006-05-03 10:41:33 +0200432static int pipe_to_sendpage(struct pipe_inode_info *pipe,
Jens Axboe5274f052006-03-30 15:15:30 +0200433 struct pipe_buffer *buf, struct splice_desc *sd)
434{
Jens Axboe6a14b902007-06-14 13:08:55 +0200435 struct file *file = sd->u.file;
Jens Axboe5274f052006-03-30 15:15:30 +0200436 loff_t pos = sd->pos;
Michał Mirosława8adbe32010-12-17 08:56:44 +0100437 int more;
Jens Axboe5274f052006-03-30 15:15:30 +0200438
Al Viro72c2d532013-09-22 16:27:52 -0400439 if (!likely(file->f_op->sendpage))
Michał Mirosława8adbe32010-12-17 08:56:44 +0100440 return -EINVAL;
Jens Axboe5274f052006-03-30 15:15:30 +0200441
Eric Dumazet35f9c092012-04-05 03:05:35 +0000442 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000443
David Howells8cefc102019-11-15 13:30:32 +0000444 if (sd->len < sd->total_len &&
445 pipe_occupancy(pipe->head, pipe->tail) > 1)
Eric Dumazet35f9c092012-04-05 03:05:35 +0000446 more |= MSG_SENDPAGE_NOTLAST;
Eric Dumazetae62ca72013-01-06 18:21:49 +0000447
Michał Mirosława8adbe32010-12-17 08:56:44 +0100448 return file->f_op->sendpage(file, buf->page, buf->offset,
449 sd->len, &pos, more);
Jens Axboe5274f052006-03-30 15:15:30 +0200450}
451
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200452static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
453{
454 smp_mb();
Linus Torvalds0ddad212019-12-09 09:48:27 -0800455 if (waitqueue_active(&pipe->wr_wait))
456 wake_up_interruptible(&pipe->wr_wait);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200457 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
458}
459
460/**
461 * splice_from_pipe_feed - feed available data from a pipe to a file
462 * @pipe: pipe to splice from
463 * @sd: information to @actor
464 * @actor: handler that splices the data
465 *
466 * Description:
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200467 * This function loops over the pipe and calls @actor to do the
468 * actual moving of a single struct pipe_buffer to the desired
469 * destination. It returns when there's no more buffers left in
470 * the pipe or if the requested number of bytes (@sd->total_len)
471 * have been copied. It returns a positive number (one) if the
472 * pipe needs to be filled with more data, zero if the required
473 * number of bytes have been copied and -errno on error.
474 *
475 * This, together with splice_from_pipe_{begin,end,next}, may be
476 * used to implement the functionality of __splice_from_pipe() when
477 * locking is required around copying the pipe buffers to the
478 * destination.
479 */
Al Viro96f9bc82014-04-05 04:35:49 -0400480static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200481 splice_actor *actor)
482{
David Howells8cefc102019-11-15 13:30:32 +0000483 unsigned int head = pipe->head;
484 unsigned int tail = pipe->tail;
485 unsigned int mask = pipe->ring_size - 1;
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200486 int ret;
487
Linus Torvaldsec057592019-12-06 12:40:35 -0800488 while (!pipe_empty(head, tail)) {
David Howells8cefc102019-11-15 13:30:32 +0000489 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200490
491 sd->len = buf->len;
492 if (sd->len > sd->total_len)
493 sd->len = sd->total_len;
494
Miklos Szeredifba597d2016-09-27 10:45:12 +0200495 ret = pipe_buf_confirm(pipe, buf);
Michał Mirosława8adbe32010-12-17 08:56:44 +0100496 if (unlikely(ret)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200497 if (ret == -ENODATA)
498 ret = 0;
499 return ret;
500 }
Michał Mirosława8adbe32010-12-17 08:56:44 +0100501
502 ret = actor(pipe, buf, sd);
503 if (ret <= 0)
504 return ret;
505
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200506 buf->offset += ret;
507 buf->len -= ret;
508
509 sd->num_spliced += ret;
510 sd->len -= ret;
511 sd->pos += ret;
512 sd->total_len -= ret;
513
514 if (!buf->len) {
Miklos Szeredia7796382016-09-27 10:45:12 +0200515 pipe_buf_release(pipe, buf);
David Howells8cefc102019-11-15 13:30:32 +0000516 tail++;
517 pipe->tail = tail;
Al Viro6447a3c2013-03-21 11:01:38 -0400518 if (pipe->files)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200519 sd->need_wakeup = true;
520 }
521
522 if (!sd->total_len)
523 return 0;
524 }
525
526 return 1;
527}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200528
Linus Torvaldsd1a819a2020-10-05 11:26:27 -0700529/* We know we have a pipe buffer, but maybe it's empty? */
530static inline bool eat_empty_buffer(struct pipe_inode_info *pipe)
531{
532 unsigned int tail = pipe->tail;
533 unsigned int mask = pipe->ring_size - 1;
534 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
535
536 if (unlikely(!buf->len)) {
537 pipe_buf_release(pipe, buf);
538 pipe->tail = tail+1;
539 return true;
540 }
541
542 return false;
543}
544
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200545/**
546 * splice_from_pipe_next - wait for some data to splice from
547 * @pipe: pipe to splice from
548 * @sd: information about the splice operation
549 *
550 * Description:
551 * This function will wait for some data and return a positive
552 * value (one) if pipe buffers are available. It will return zero
553 * or -errno if no more data needs to be spliced.
554 */
Al Viro96f9bc82014-04-05 04:35:49 -0400555static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200556{
Jan Karac725bfc2015-11-23 13:09:50 +0100557 /*
558 * Check for signal early to make process killable when there are
559 * always buffers available
560 */
561 if (signal_pending(current))
562 return -ERESTARTSYS;
563
Linus Torvaldsd1a819a2020-10-05 11:26:27 -0700564repeat:
David Howells8cefc102019-11-15 13:30:32 +0000565 while (pipe_empty(pipe->head, pipe->tail)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200566 if (!pipe->writers)
567 return 0;
568
Linus Torvaldsa28c8b92019-12-07 13:21:01 -0800569 if (sd->num_spliced)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200570 return 0;
571
572 if (sd->flags & SPLICE_F_NONBLOCK)
573 return -EAGAIN;
574
575 if (signal_pending(current))
576 return -ERESTARTSYS;
577
578 if (sd->need_wakeup) {
579 wakeup_pipe_writers(pipe);
580 sd->need_wakeup = false;
581 }
582
Linus Torvalds472e5b02020-10-01 19:14:36 -0700583 pipe_wait_readable(pipe);
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200584 }
585
Linus Torvaldsd1a819a2020-10-05 11:26:27 -0700586 if (eat_empty_buffer(pipe))
587 goto repeat;
588
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200589 return 1;
590}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200591
592/**
593 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700594 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200595 *
596 * Description:
597 * This function should be called before a loop containing
598 * splice_from_pipe_next() and splice_from_pipe_feed() to
599 * initialize the necessary fields of @sd.
600 */
Al Viro96f9bc82014-04-05 04:35:49 -0400601static void splice_from_pipe_begin(struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200602{
603 sd->num_spliced = 0;
604 sd->need_wakeup = false;
605}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200606
607/**
608 * splice_from_pipe_end - finish splicing from pipe
609 * @pipe: pipe to splice from
610 * @sd: information about the splice operation
611 *
612 * Description:
613 * This function will wake up pipe writers if necessary. It should
614 * be called after a loop containing splice_from_pipe_next() and
615 * splice_from_pipe_feed().
616 */
Al Viro96f9bc82014-04-05 04:35:49 -0400617static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200618{
619 if (sd->need_wakeup)
620 wakeup_pipe_writers(pipe);
621}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200622
Jens Axboe932cc6d2007-06-21 13:10:21 +0200623/**
624 * __splice_from_pipe - splice data from a pipe to given actor
625 * @pipe: pipe to splice from
626 * @sd: information to @actor
627 * @actor: handler that splices the data
628 *
629 * Description:
630 * This function does little more than loop over the pipe and call
631 * @actor to do the actual moving of a single struct pipe_buffer to
632 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
633 * pipe_to_user.
634 *
Jens Axboe83f91352006-04-02 23:05:09 +0200635 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200636ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
637 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200638{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200639 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200640
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200641 splice_from_pipe_begin(sd);
642 do {
Jan Karac2489e02015-11-23 13:09:51 +0100643 cond_resched();
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200644 ret = splice_from_pipe_next(pipe, sd);
645 if (ret > 0)
646 ret = splice_from_pipe_feed(pipe, sd, actor);
647 } while (ret > 0);
648 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200649
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200650 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200651}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100652EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200653
Jens Axboe932cc6d2007-06-21 13:10:21 +0200654/**
655 * splice_from_pipe - splice data from a pipe to a file
656 * @pipe: pipe to splice from
657 * @out: file to splice to
658 * @ppos: position in @out
659 * @len: how many bytes to splice
660 * @flags: splice modifier flags
661 * @actor: handler that splices the data
662 *
663 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200664 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200665 * otherwise it's identical to __splice_from_pipe().
666 *
667 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200668ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
669 loff_t *ppos, size_t len, unsigned int flags,
670 splice_actor *actor)
671{
672 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200673 struct splice_desc sd = {
674 .total_len = len,
675 .flags = flags,
676 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200677 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200678 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200679
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200680 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200681 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200682 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200683
684 return ret;
685}
686
687/**
Al Viro8d020762014-04-05 04:27:08 -0400688 * iter_file_splice_write - splice data from a pipe to a file
689 * @pipe: pipe info
690 * @out: file to write to
691 * @ppos: position in @out
692 * @len: number of bytes to splice
693 * @flags: splice modifier flags
694 *
695 * Description:
696 * Will either move or copy pages (determined by @flags options) from
697 * the given pipe inode to the given file.
698 * This one is ->write_iter-based.
699 *
700 */
701ssize_t
702iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
703 loff_t *ppos, size_t len, unsigned int flags)
704{
705 struct splice_desc sd = {
706 .total_len = len,
707 .flags = flags,
708 .pos = *ppos,
709 .u.file = out,
710 };
David Howells6718b6f2019-10-16 16:47:32 +0100711 int nbufs = pipe->max_usage;
Al Viro8d020762014-04-05 04:27:08 -0400712 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
713 GFP_KERNEL);
714 ssize_t ret;
715
716 if (unlikely(!array))
717 return -ENOMEM;
718
719 pipe_lock(pipe);
720
721 splice_from_pipe_begin(&sd);
722 while (sd.total_len) {
723 struct iov_iter from;
Linus Torvaldsec057592019-12-06 12:40:35 -0800724 unsigned int head, tail, mask;
Al Viro8d020762014-04-05 04:27:08 -0400725 size_t left;
David Howells8cefc102019-11-15 13:30:32 +0000726 int n;
Al Viro8d020762014-04-05 04:27:08 -0400727
728 ret = splice_from_pipe_next(pipe, &sd);
729 if (ret <= 0)
730 break;
731
David Howells6718b6f2019-10-16 16:47:32 +0100732 if (unlikely(nbufs < pipe->max_usage)) {
Al Viro8d020762014-04-05 04:27:08 -0400733 kfree(array);
David Howells6718b6f2019-10-16 16:47:32 +0100734 nbufs = pipe->max_usage;
Al Viro8d020762014-04-05 04:27:08 -0400735 array = kcalloc(nbufs, sizeof(struct bio_vec),
736 GFP_KERNEL);
737 if (!array) {
738 ret = -ENOMEM;
739 break;
740 }
741 }
742
Linus Torvaldsec057592019-12-06 12:40:35 -0800743 head = pipe->head;
744 tail = pipe->tail;
745 mask = pipe->ring_size - 1;
746
Al Viro8d020762014-04-05 04:27:08 -0400747 /* build the vector */
748 left = sd.total_len;
David Howells8cefc102019-11-15 13:30:32 +0000749 for (n = 0; !pipe_empty(head, tail) && left && n < nbufs; tail++, n++) {
750 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
Al Viro8d020762014-04-05 04:27:08 -0400751 size_t this_len = buf->len;
752
753 if (this_len > left)
754 this_len = left;
755
Miklos Szeredifba597d2016-09-27 10:45:12 +0200756 ret = pipe_buf_confirm(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400757 if (unlikely(ret)) {
758 if (ret == -ENODATA)
759 ret = 0;
760 goto done;
761 }
762
763 array[n].bv_page = buf->page;
764 array[n].bv_len = this_len;
765 array[n].bv_offset = buf->offset;
766 left -= this_len;
767 }
768
David Howellsaa563d72018-10-20 00:57:56 +0100769 iov_iter_bvec(&from, WRITE, array, n, sd.total_len - left);
Christoph Hellwigabbb65892017-05-27 11:16:52 +0300770 ret = vfs_iter_write(out, &from, &sd.pos, 0);
Al Viro8d020762014-04-05 04:27:08 -0400771 if (ret <= 0)
772 break;
773
774 sd.num_spliced += ret;
775 sd.total_len -= ret;
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100776 *ppos = sd.pos;
Al Viro8d020762014-04-05 04:27:08 -0400777
778 /* dismiss the fully eaten buffers, adjust the partial one */
David Howells8cefc102019-11-15 13:30:32 +0000779 tail = pipe->tail;
Al Viro8d020762014-04-05 04:27:08 -0400780 while (ret) {
David Howells8cefc102019-11-15 13:30:32 +0000781 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
Al Viro8d020762014-04-05 04:27:08 -0400782 if (ret >= buf->len) {
Al Viro8d020762014-04-05 04:27:08 -0400783 ret -= buf->len;
784 buf->len = 0;
Miklos Szeredia7796382016-09-27 10:45:12 +0200785 pipe_buf_release(pipe, buf);
David Howells8cefc102019-11-15 13:30:32 +0000786 tail++;
787 pipe->tail = tail;
Al Viro8d020762014-04-05 04:27:08 -0400788 if (pipe->files)
789 sd.need_wakeup = true;
790 } else {
791 buf->offset += ret;
792 buf->len -= ret;
793 ret = 0;
794 }
795 }
796 }
797done:
798 kfree(array);
799 splice_from_pipe_end(pipe, &sd);
800
801 pipe_unlock(pipe);
802
803 if (sd.num_spliced)
804 ret = sd.num_spliced;
805
806 return ret;
807}
808
809EXPORT_SYMBOL(iter_file_splice_write);
810
Miklos Szeredib2858d72009-05-19 11:37:46 +0200811static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
812 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200813{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200814 int ret;
815 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -0400816 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +0200817
Al Virofbb32752014-02-02 21:09:54 -0500818 data = kmap(buf->page);
Al Viro06ae43f2013-03-20 13:19:30 -0400819 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Al Virofbb32752014-02-02 21:09:54 -0500820 kunmap(buf->page);
Miklos Szeredib2858d72009-05-19 11:37:46 +0200821
822 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200823}
824
825static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
826 struct file *out, loff_t *ppos,
827 size_t len, unsigned int flags)
828{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200829 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200830
Miklos Szeredib2858d72009-05-19 11:37:46 +0200831 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
832 if (ret > 0)
833 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200834
Miklos Szeredib2858d72009-05-19 11:37:46 +0200835 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200836}
837
Jens Axboe83f91352006-04-02 23:05:09 +0200838/**
839 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200840 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200841 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200842 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200843 * @len: number of bytes to splice
844 * @flags: splice modifier flags
845 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200846 * Description:
847 * Will send @len bytes from the pipe to a network socket. No data copying
848 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200849 *
850 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200851ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200852 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200853{
Jens Axboe00522fb2006-04-26 14:39:29 +0200854 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200855}
856
Jens Axboe059a8f32006-04-02 23:06:05 +0200857EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500858
Jens Axboe83f91352006-04-02 23:05:09 +0200859/*
860 * Attempt to initiate a splice from pipe to file.
861 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200862static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200863 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200864{
Al Viro72c2d532013-09-22 16:27:52 -0400865 if (out->f_op->splice_write)
Christoph Hellwig00c285d2020-05-20 17:58:11 +0200866 return out->f_op->splice_write(pipe, out, ppos, len, flags);
867 return default_file_splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200868}
869
Jens Axboe83f91352006-04-02 23:05:09 +0200870/*
871 * Attempt to initiate a splice from a file to a pipe.
872 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200873static long do_splice_to(struct file *in, loff_t *ppos,
874 struct pipe_inode_info *pipe, size_t len,
875 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200876{
Jens Axboe5274f052006-03-30 15:15:30 +0200877 int ret;
878
Jens Axboe49570e92006-04-11 13:56:09 +0200879 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200880 return -EBADF;
881
Jens Axboecbb7e572006-04-11 14:57:50 +0200882 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200883 if (unlikely(ret < 0))
884 return ret;
885
Al Viro03cc0782016-04-02 14:56:58 -0400886 if (unlikely(len > MAX_RW_COUNT))
887 len = MAX_RW_COUNT;
888
Al Viro72c2d532013-09-22 16:27:52 -0400889 if (in->f_op->splice_read)
Christoph Hellwig2bc01062020-05-20 17:58:10 +0200890 return in->f_op->splice_read(in, ppos, pipe, len, flags);
891 return default_file_splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200892}
893
Jens Axboe932cc6d2007-06-21 13:10:21 +0200894/**
895 * splice_direct_to_actor - splices data directly between two non-pipes
896 * @in: file to splice from
897 * @sd: actor information on where to splice to
898 * @actor: handles the data splicing
899 *
900 * Description:
901 * This is a special case helper to splice directly between two
902 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200903 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200904 * that process.
905 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200906 */
907ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
908 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200909{
910 struct pipe_inode_info *pipe;
911 long ret, bytes;
912 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200913 size_t len;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200914 int i, flags, more;
Jens Axboeb92ce552006-04-11 13:52:07 +0200915
916 /*
917 * We require the input being a regular file, as we don't want to
918 * randomly drop data for eg socket -> socket splicing. Use the
919 * piped splicing for that!
920 */
Al Viro496ad9a2013-01-23 17:07:38 -0500921 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200922 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
923 return -EINVAL;
924
925 /*
926 * neither in nor out is a pipe, setup an internal pipe attached to
927 * 'out' and transfer the wanted data from 'in' to 'out' through that
928 */
929 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200930 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -0400931 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +0200932 if (!pipe)
933 return -ENOMEM;
934
935 /*
936 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200937 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200938 * PIPE_READERS appropriately.
939 */
940 pipe->readers = 1;
941
942 current->splice_pipe = pipe;
943 }
944
945 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200946 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200947 */
948 ret = 0;
949 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200950 len = sd->total_len;
951 flags = sd->flags;
952
953 /*
954 * Don't block on output, we have to drain the direct pipe.
955 */
956 sd->flags &= ~SPLICE_F_NONBLOCK;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200957 more = sd->flags & SPLICE_F_MORE;
Jens Axboeb92ce552006-04-11 13:52:07 +0200958
David Howells8cefc102019-11-15 13:30:32 +0000959 WARN_ON_ONCE(!pipe_empty(pipe->head, pipe->tail));
Darrick J. Wong17614442018-11-30 10:37:49 -0800960
Jens Axboeb92ce552006-04-11 13:52:07 +0200961 while (len) {
David Howells8cefc102019-11-15 13:30:32 +0000962 unsigned int p_space;
Jens Axboe51a92c02007-07-13 14:11:43 +0200963 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200964 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200965
Darrick J. Wong17614442018-11-30 10:37:49 -0800966 /* Don't try to read more the pipe has space for. */
David Howells6718b6f2019-10-16 16:47:32 +0100967 p_space = pipe->max_usage -
David Howells8cefc102019-11-15 13:30:32 +0000968 pipe_occupancy(pipe->head, pipe->tail);
969 read_len = min_t(size_t, len, p_space << PAGE_SHIFT);
Darrick J. Wong17614442018-11-30 10:37:49 -0800970 ret = do_splice_to(in, &pos, pipe, read_len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200971 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +0200972 goto out_release;
973
974 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200975 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +0200976
977 /*
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200978 * If more data is pending, set SPLICE_F_MORE
979 * If this is the last data and SPLICE_F_MORE was not set
980 * initially, clears it.
981 */
982 if (read_len < len)
983 sd->flags |= SPLICE_F_MORE;
984 else if (!more)
985 sd->flags &= ~SPLICE_F_MORE;
986 /*
Jens Axboeb92ce552006-04-11 13:52:07 +0200987 * NOTE: nonblocking mode only applies to the input. We
988 * must not do the output in nonblocking mode as then we
989 * could get stuck data in the internal pipe:
990 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200991 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +0200992 if (unlikely(ret <= 0)) {
993 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200994 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200995 }
Jens Axboeb92ce552006-04-11 13:52:07 +0200996
997 bytes += ret;
998 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200999 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +02001000
Tom Zanussia82c53a2008-05-09 13:28:36 +02001001 if (ret < read_len) {
1002 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +02001003 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +02001004 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001005 }
1006
Jens Axboe9e971982008-01-29 21:05:57 +01001007done:
David Howells8cefc102019-11-15 13:30:32 +00001008 pipe->tail = pipe->head = 0;
Jens Axboe80848702008-01-30 12:24:48 +01001009 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +02001010 return bytes;
1011
1012out_release:
1013 /*
1014 * If we did an incomplete transfer we must release
1015 * the pipe buffers in question:
1016 */
David Howells8cefc102019-11-15 13:30:32 +00001017 for (i = 0; i < pipe->ring_size; i++) {
1018 struct pipe_buffer *buf = &pipe->bufs[i];
Jens Axboeb92ce552006-04-11 13:52:07 +02001019
Miklos Szeredia7796382016-09-27 10:45:12 +02001020 if (buf->ops)
1021 pipe_buf_release(pipe, buf);
Jens Axboeb92ce552006-04-11 13:52:07 +02001022 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001023
Jens Axboe9e971982008-01-29 21:05:57 +01001024 if (!bytes)
1025 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001026
Jens Axboe9e971982008-01-29 21:05:57 +01001027 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001028}
1029EXPORT_SYMBOL(splice_direct_to_actor);
1030
1031static int direct_splice_actor(struct pipe_inode_info *pipe,
1032 struct splice_desc *sd)
1033{
Jens Axboe6a14b902007-06-14 13:08:55 +02001034 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001035
Al Viro7995bd22013-06-20 18:58:36 +04001036 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001037 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001038}
1039
Jens Axboe932cc6d2007-06-21 13:10:21 +02001040/**
1041 * do_splice_direct - splices data directly between two files
1042 * @in: file to splice from
1043 * @ppos: input file offset
1044 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001045 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001046 * @len: number of bytes to splice
1047 * @flags: splice modifier flags
1048 *
1049 * Description:
1050 * For use by do_sendfile(). splice can easily emulate sendfile, but
1051 * doing it in the application would incur an extra system call
1052 * (splice in + splice out, as compared to just sendfile()). So this helper
1053 * can splice directly through a process-private pipe.
1054 *
1055 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001056long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001057 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001058{
1059 struct splice_desc sd = {
1060 .len = len,
1061 .total_len = len,
1062 .flags = flags,
1063 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001064 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001065 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001066 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001067 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001068
Al Viro18c67cb2013-06-19 15:41:54 +04001069 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1070 return -EBADF;
1071
1072 if (unlikely(out->f_flags & O_APPEND))
1073 return -EINVAL;
1074
1075 ret = rw_verify_area(WRITE, out, opos, len);
1076 if (unlikely(ret < 0))
1077 return ret;
1078
Jens Axboec66ab6f2007-06-12 21:17:17 +02001079 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001080 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001081 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001082
Jens Axboec66ab6f2007-06-12 21:17:17 +02001083 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001084}
Miklos Szeredi1c118592014-10-24 00:14:35 +02001085EXPORT_SYMBOL(do_splice_direct);
Jens Axboeb92ce552006-04-11 13:52:07 +02001086
Al Viro8924fef2016-09-17 20:44:45 -04001087static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1088{
Linus Torvalds52bce912016-12-21 10:59:34 -08001089 for (;;) {
1090 if (unlikely(!pipe->readers)) {
1091 send_sig(SIGPIPE, current, 0);
1092 return -EPIPE;
1093 }
David Howells6718b6f2019-10-16 16:47:32 +01001094 if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage))
Linus Torvalds52bce912016-12-21 10:59:34 -08001095 return 0;
Al Viro8924fef2016-09-17 20:44:45 -04001096 if (flags & SPLICE_F_NONBLOCK)
1097 return -EAGAIN;
1098 if (signal_pending(current))
1099 return -ERESTARTSYS;
Linus Torvalds472e5b02020-10-01 19:14:36 -07001100 pipe_wait_writable(pipe);
Al Viro8924fef2016-09-17 20:44:45 -04001101 }
Al Viro8924fef2016-09-17 20:44:45 -04001102}
1103
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001104static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1105 struct pipe_inode_info *opipe,
1106 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001107
1108/*
Jens Axboe83f91352006-04-02 23:05:09 +02001109 * Determine where to splice to/from.
1110 */
Pavel Begunkov444ebb52020-02-24 11:32:43 +03001111long do_splice(struct file *in, loff_t __user *off_in,
1112 struct file *out, loff_t __user *off_out,
1113 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001114{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001115 struct pipe_inode_info *ipipe;
1116 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001117 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001118 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001119
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001120 if (unlikely(!(in->f_mode & FMODE_READ) ||
1121 !(out->f_mode & FMODE_WRITE)))
1122 return -EBADF;
1123
David Howellsc73be612020-01-14 17:07:11 +00001124 ipipe = get_pipe_info(in, true);
1125 opipe = get_pipe_info(out, true);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001126
1127 if (ipipe && opipe) {
1128 if (off_in || off_out)
1129 return -ESPIPE;
1130
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001131 /* Splicing to self would be fun, but... */
1132 if (ipipe == opipe)
1133 return -EINVAL;
1134
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001135 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1136 flags |= SPLICE_F_NONBLOCK;
1137
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001138 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1139 }
1140
1141 if (ipipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001142 if (off_in)
1143 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001144 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001145 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001146 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001147 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001148 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001149 } else {
1150 offset = out->f_pos;
1151 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001152
Al Viro18c67cb2013-06-19 15:41:54 +04001153 if (unlikely(out->f_flags & O_APPEND))
1154 return -EINVAL;
1155
1156 ret = rw_verify_area(WRITE, out, &offset, len);
1157 if (unlikely(ret < 0))
1158 return ret;
1159
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001160 if (in->f_flags & O_NONBLOCK)
1161 flags |= SPLICE_F_NONBLOCK;
1162
Al Viro500368f2013-05-23 20:07:11 -04001163 file_start_write(out);
Al Viro7995bd22013-06-20 18:58:36 +04001164 ret = do_splice_from(ipipe, out, &offset, len, flags);
Al Viro500368f2013-05-23 20:07:11 -04001165 file_end_write(out);
Jens Axboea4514eb2006-04-19 15:57:05 +02001166
Al Viro7995bd22013-06-20 18:58:36 +04001167 if (!off_out)
1168 out->f_pos = offset;
1169 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001170 ret = -EFAULT;
1171
1172 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001173 }
Jens Axboe5274f052006-03-30 15:15:30 +02001174
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001175 if (opipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001176 if (off_out)
1177 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001178 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001179 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001180 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001181 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001182 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001183 } else {
1184 offset = in->f_pos;
1185 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001186
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001187 if (out->f_flags & O_NONBLOCK)
1188 flags |= SPLICE_F_NONBLOCK;
1189
Al Viro8924fef2016-09-17 20:44:45 -04001190 pipe_lock(opipe);
1191 ret = wait_for_space(opipe, flags);
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001192 if (!ret) {
Linus Torvalds6a965662019-11-30 14:12:13 -08001193 unsigned int p_space;
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001194
1195 /* Don't try to read more the pipe has space for. */
Linus Torvalds6a965662019-11-30 14:12:13 -08001196 p_space = opipe->max_usage - pipe_occupancy(opipe->head, opipe->tail);
1197 len = min_t(size_t, len, p_space << PAGE_SHIFT);
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001198
Al Viro8924fef2016-09-17 20:44:45 -04001199 ret = do_splice_to(in, &offset, opipe, len, flags);
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001200 }
Al Viro8924fef2016-09-17 20:44:45 -04001201 pipe_unlock(opipe);
1202 if (ret > 0)
1203 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001204 if (!off_in)
1205 in->f_pos = offset;
1206 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001207 ret = -EFAULT;
1208
1209 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001210 }
Jens Axboe5274f052006-03-30 15:15:30 +02001211
1212 return -EINVAL;
1213}
1214
Al Viro79fddc42016-09-17 22:38:20 -04001215static int iter_to_pipe(struct iov_iter *from,
1216 struct pipe_inode_info *pipe,
1217 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001218{
Al Viro79fddc42016-09-17 22:38:20 -04001219 struct pipe_buffer buf = {
1220 .ops = &user_page_pipe_buf_ops,
1221 .flags = flags
1222 };
1223 size_t total = 0;
1224 int ret = 0;
1225 bool failed = false;
1226
1227 while (iov_iter_count(from) && !failed) {
1228 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001229 ssize_t copied;
1230 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001231 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001232
Al Viro79fddc42016-09-17 22:38:20 -04001233 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1234 if (copied <= 0) {
1235 ret = copied;
1236 break;
1237 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001238
Al Viro79fddc42016-09-17 22:38:20 -04001239 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001240 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001241 if (!failed) {
1242 buf.page = pages[n];
1243 buf.offset = start;
1244 buf.len = size;
1245 ret = add_to_pipe(pipe, &buf);
1246 if (unlikely(ret < 0)) {
1247 failed = true;
1248 } else {
1249 iov_iter_advance(from, ret);
1250 total += ret;
1251 }
1252 } else {
1253 put_page(pages[n]);
1254 }
Al Virodb85a9e2016-09-17 20:25:06 -04001255 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001256 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001257 }
Al Viro79fddc42016-09-17 22:38:20 -04001258 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001259}
1260
Jens Axboe6a14b902007-06-14 13:08:55 +02001261static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1262 struct splice_desc *sd)
1263{
Al Viro6130f532014-02-03 18:19:51 -05001264 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1265 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001266}
1267
1268/*
1269 * For lack of a better implementation, implement vmsplice() to userspace
1270 * as a simple copy of the pipes pages to the user iov.
1271 */
Al Viro87a30022018-05-26 21:39:52 -04001272static long vmsplice_to_user(struct file *file, struct iov_iter *iter,
1273 unsigned int flags)
Jens Axboe6a14b902007-06-14 13:08:55 +02001274{
David Howellsc73be612020-01-14 17:07:11 +00001275 struct pipe_inode_info *pipe = get_pipe_info(file, true);
Al Viro87a30022018-05-26 21:39:52 -04001276 struct splice_desc sd = {
1277 .total_len = iov_iter_count(iter),
1278 .flags = flags,
1279 .u.data = iter
1280 };
1281 long ret = 0;
Jens Axboe6a14b902007-06-14 13:08:55 +02001282
Jens Axboe6a14b902007-06-14 13:08:55 +02001283 if (!pipe)
1284 return -EBADF;
1285
Al Viro345995f2015-03-21 19:17:55 -04001286 if (sd.total_len) {
1287 pipe_lock(pipe);
1288 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1289 pipe_unlock(pipe);
1290 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001291
Jens Axboe6a14b902007-06-14 13:08:55 +02001292 return ret;
1293}
1294
Jens Axboe912d35f2006-04-26 10:59:21 +02001295/*
1296 * vmsplice splices a user address range into a pipe. It can be thought of
1297 * as splice-from-memory, where the regular splice is splice-from-file (or
1298 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001299 */
Al Viro87a30022018-05-26 21:39:52 -04001300static long vmsplice_to_pipe(struct file *file, struct iov_iter *iter,
1301 unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001302{
Jens Axboeddac0d32006-11-04 12:49:32 +01001303 struct pipe_inode_info *pipe;
Al Viro87a30022018-05-26 21:39:52 -04001304 long ret = 0;
Al Viro79fddc42016-09-17 22:38:20 -04001305 unsigned buf_flag = 0;
1306
1307 if (flags & SPLICE_F_GIFT)
1308 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001309
David Howellsc73be612020-01-14 17:07:11 +00001310 pipe = get_pipe_info(file, true);
Jens Axboeddac0d32006-11-04 12:49:32 +01001311 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001312 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001313
Al Viro8924fef2016-09-17 20:44:45 -04001314 pipe_lock(pipe);
1315 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001316 if (!ret)
Al Viro87a30022018-05-26 21:39:52 -04001317 ret = iter_to_pipe(iter, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001318 pipe_unlock(pipe);
1319 if (ret > 0)
1320 wakeup_pipe_readers(pipe);
Jens Axboe35f3d142010-05-20 10:43:18 +02001321 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001322}
1323
Al Viro87a30022018-05-26 21:39:52 -04001324static int vmsplice_type(struct fd f, int *type)
1325{
1326 if (!f.file)
1327 return -EBADF;
1328 if (f.file->f_mode & FMODE_WRITE) {
1329 *type = WRITE;
1330 } else if (f.file->f_mode & FMODE_READ) {
1331 *type = READ;
1332 } else {
1333 fdput(f);
1334 return -EBADF;
1335 }
1336 return 0;
1337}
1338
Jens Axboe6a14b902007-06-14 13:08:55 +02001339/*
1340 * Note that vmsplice only really supports true splicing _from_ user memory
1341 * to a pipe, not the other way around. Splicing from user memory is a simple
1342 * operation that can be supported without any funky alignment restrictions
1343 * or nasty vm tricks. We simply map in the user memory and fill them into
1344 * a pipe. The reverse isn't quite as easy, though. There are two possible
1345 * solutions for that:
1346 *
1347 * - memcpy() the data internally, at which point we might as well just
1348 * do a regular read() on the buffer anyway.
1349 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1350 * has restriction limitations on both ends of the pipe).
1351 *
1352 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1353 *
1354 */
Al Viro87a30022018-05-26 21:39:52 -04001355static long do_vmsplice(struct file *f, struct iov_iter *iter, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001356{
Al Viro3d6ea292016-12-10 13:17:32 -05001357 if (unlikely(flags & ~SPLICE_F_ALL))
1358 return -EINVAL;
Al Viro87a30022018-05-26 21:39:52 -04001359
1360 if (!iov_iter_count(iter))
Jens Axboe6a14b902007-06-14 13:08:55 +02001361 return 0;
1362
Al Viro87a30022018-05-26 21:39:52 -04001363 if (iov_iter_rw(iter) == WRITE)
1364 return vmsplice_to_pipe(f, iter, flags);
1365 else
1366 return vmsplice_to_user(f, iter, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001367}
1368
Al Viro87a30022018-05-26 21:39:52 -04001369SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, uiov,
Dominik Brodowski30cfe4e2018-03-17 15:00:24 +01001370 unsigned long, nr_segs, unsigned int, flags)
1371{
Al Viro87a30022018-05-26 21:39:52 -04001372 struct iovec iovstack[UIO_FASTIOV];
1373 struct iovec *iov = iovstack;
1374 struct iov_iter iter;
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001375 ssize_t error;
Al Viro87a30022018-05-26 21:39:52 -04001376 struct fd f;
1377 int type;
1378
1379 f = fdget(fd);
1380 error = vmsplice_type(f, &type);
1381 if (error)
1382 return error;
1383
1384 error = import_iovec(type, uiov, nr_segs,
1385 ARRAY_SIZE(iovstack), &iov, &iter);
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001386 if (error >= 0) {
Al Viro87a30022018-05-26 21:39:52 -04001387 error = do_vmsplice(f.file, &iter, flags);
1388 kfree(iov);
1389 }
1390 fdput(f);
1391 return error;
Dominik Brodowski30cfe4e2018-03-17 15:00:24 +01001392}
1393
Al Viro76b021d2013-03-02 10:19:56 -05001394#ifdef CONFIG_COMPAT
1395COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1396 unsigned int, nr_segs, unsigned int, flags)
1397{
Al Viro87a30022018-05-26 21:39:52 -04001398 struct iovec iovstack[UIO_FASTIOV];
1399 struct iovec *iov = iovstack;
1400 struct iov_iter iter;
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001401 ssize_t error;
Al Viro87a30022018-05-26 21:39:52 -04001402 struct fd f;
1403 int type;
1404
1405 f = fdget(fd);
1406 error = vmsplice_type(f, &type);
1407 if (error)
1408 return error;
1409
1410 error = compat_import_iovec(type, iov32, nr_segs,
1411 ARRAY_SIZE(iovstack), &iov, &iter);
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001412 if (error >= 0) {
Al Viro87a30022018-05-26 21:39:52 -04001413 error = do_vmsplice(f.file, &iter, flags);
1414 kfree(iov);
Al Viro76b021d2013-03-02 10:19:56 -05001415 }
Al Viro87a30022018-05-26 21:39:52 -04001416 fdput(f);
1417 return error;
Al Viro76b021d2013-03-02 10:19:56 -05001418}
1419#endif
1420
Heiko Carstens836f92a2009-01-14 14:14:33 +01001421SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1422 int, fd_out, loff_t __user *, off_out,
1423 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001424{
Al Viro2903ff02012-08-28 12:52:22 -04001425 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001426 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001427
1428 if (unlikely(!len))
1429 return 0;
1430
Al Viro3d6ea292016-12-10 13:17:32 -05001431 if (unlikely(flags & ~SPLICE_F_ALL))
1432 return -EINVAL;
1433
Jens Axboe5274f052006-03-30 15:15:30 +02001434 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001435 in = fdget(fd_in);
1436 if (in.file) {
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001437 out = fdget(fd_out);
1438 if (out.file) {
1439 error = do_splice(in.file, off_in, out.file, off_out,
1440 len, flags);
1441 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001442 }
Al Viro2903ff02012-08-28 12:52:22 -04001443 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001444 }
Jens Axboe5274f052006-03-30 15:15:30 +02001445 return error;
1446}
Jens Axboe70524492006-04-11 15:51:17 +02001447
1448/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001449 * Make sure there's data to read. Wait for input if we can, otherwise
1450 * return an appropriate error.
1451 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001452static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001453{
1454 int ret;
1455
1456 /*
David Howells8cefc102019-11-15 13:30:32 +00001457 * Check the pipe occupancy without the inode lock first. This function
Jens Axboeaadd06e2006-07-10 11:00:01 +02001458 * is speculative anyways, so missing one is ok.
1459 */
David Howells8cefc102019-11-15 13:30:32 +00001460 if (!pipe_empty(pipe->head, pipe->tail))
Jens Axboeaadd06e2006-07-10 11:00:01 +02001461 return 0;
1462
1463 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001464 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001465
David Howells8cefc102019-11-15 13:30:32 +00001466 while (pipe_empty(pipe->head, pipe->tail)) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001467 if (signal_pending(current)) {
1468 ret = -ERESTARTSYS;
1469 break;
1470 }
1471 if (!pipe->writers)
1472 break;
Linus Torvaldsa28c8b92019-12-07 13:21:01 -08001473 if (flags & SPLICE_F_NONBLOCK) {
1474 ret = -EAGAIN;
1475 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001476 }
Linus Torvalds472e5b02020-10-01 19:14:36 -07001477 pipe_wait_readable(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001478 }
1479
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001480 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001481 return ret;
1482}
1483
1484/*
1485 * Make sure there's writeable room. Wait for room if we can, otherwise
1486 * return an appropriate error.
1487 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001488static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001489{
1490 int ret;
1491
1492 /*
David Howells8cefc102019-11-15 13:30:32 +00001493 * Check pipe occupancy without the inode lock first. This function
Jens Axboeaadd06e2006-07-10 11:00:01 +02001494 * is speculative anyways, so missing one is ok.
1495 */
Tetsuo Handa566d1362020-05-20 08:51:59 +09001496 if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage))
Jens Axboeaadd06e2006-07-10 11:00:01 +02001497 return 0;
1498
1499 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001500 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001501
David Howells6718b6f2019-10-16 16:47:32 +01001502 while (pipe_full(pipe->head, pipe->tail, pipe->max_usage)) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001503 if (!pipe->readers) {
1504 send_sig(SIGPIPE, current, 0);
1505 ret = -EPIPE;
1506 break;
1507 }
1508 if (flags & SPLICE_F_NONBLOCK) {
1509 ret = -EAGAIN;
1510 break;
1511 }
1512 if (signal_pending(current)) {
1513 ret = -ERESTARTSYS;
1514 break;
1515 }
Linus Torvalds472e5b02020-10-01 19:14:36 -07001516 pipe_wait_writable(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001517 }
1518
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001519 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001520 return ret;
1521}
1522
1523/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001524 * Splice contents of ipipe to opipe.
1525 */
1526static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1527 struct pipe_inode_info *opipe,
1528 size_t len, unsigned int flags)
1529{
1530 struct pipe_buffer *ibuf, *obuf;
David Howells8cefc102019-11-15 13:30:32 +00001531 unsigned int i_head, o_head;
1532 unsigned int i_tail, o_tail;
1533 unsigned int i_mask, o_mask;
1534 int ret = 0;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001535 bool input_wakeup = false;
1536
1537
1538retry:
1539 ret = ipipe_prep(ipipe, flags);
1540 if (ret)
1541 return ret;
1542
1543 ret = opipe_prep(opipe, flags);
1544 if (ret)
1545 return ret;
1546
1547 /*
1548 * Potential ABBA deadlock, work around it by ordering lock
1549 * grabbing by pipe info address. Otherwise two different processes
1550 * could deadlock (one doing tee from A -> B, the other from B -> A).
1551 */
1552 pipe_double_lock(ipipe, opipe);
1553
David Howells8cefc102019-11-15 13:30:32 +00001554 i_tail = ipipe->tail;
1555 i_mask = ipipe->ring_size - 1;
1556 o_head = opipe->head;
1557 o_mask = opipe->ring_size - 1;
1558
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001559 do {
David Howells8cefc102019-11-15 13:30:32 +00001560 size_t o_len;
1561
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001562 if (!opipe->readers) {
1563 send_sig(SIGPIPE, current, 0);
1564 if (!ret)
1565 ret = -EPIPE;
1566 break;
1567 }
1568
David Howells8cefc102019-11-15 13:30:32 +00001569 i_head = ipipe->head;
1570 o_tail = opipe->tail;
1571
1572 if (pipe_empty(i_head, i_tail) && !ipipe->writers)
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001573 break;
1574
1575 /*
1576 * Cannot make any progress, because either the input
1577 * pipe is empty or the output pipe is full.
1578 */
David Howells8cefc102019-11-15 13:30:32 +00001579 if (pipe_empty(i_head, i_tail) ||
David Howells6718b6f2019-10-16 16:47:32 +01001580 pipe_full(o_head, o_tail, opipe->max_usage)) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001581 /* Already processed some buffers, break */
1582 if (ret)
1583 break;
1584
1585 if (flags & SPLICE_F_NONBLOCK) {
1586 ret = -EAGAIN;
1587 break;
1588 }
1589
1590 /*
1591 * We raced with another reader/writer and haven't
1592 * managed to process any buffers. A zero return
1593 * value means EOF, so retry instead.
1594 */
1595 pipe_unlock(ipipe);
1596 pipe_unlock(opipe);
1597 goto retry;
1598 }
1599
David Howells8cefc102019-11-15 13:30:32 +00001600 ibuf = &ipipe->bufs[i_tail & i_mask];
1601 obuf = &opipe->bufs[o_head & o_mask];
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001602
1603 if (len >= ibuf->len) {
1604 /*
1605 * Simply move the whole buffer from ipipe to opipe
1606 */
1607 *obuf = *ibuf;
1608 ibuf->ops = NULL;
David Howells8cefc102019-11-15 13:30:32 +00001609 i_tail++;
1610 ipipe->tail = i_tail;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001611 input_wakeup = true;
David Howells8cefc102019-11-15 13:30:32 +00001612 o_len = obuf->len;
1613 o_head++;
1614 opipe->head = o_head;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001615 } else {
1616 /*
1617 * Get a reference to this pipe buffer,
1618 * so we can copy the contents over.
1619 */
Matthew Wilcox15fab632019-04-05 14:02:10 -07001620 if (!pipe_buf_get(ipipe, ibuf)) {
1621 if (ret == 0)
1622 ret = -EFAULT;
1623 break;
1624 }
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001625 *obuf = *ibuf;
1626
1627 /*
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001628 * Don't inherit the gift and merge flags, we need to
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001629 * prevent multiple steals of this page.
1630 */
1631 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001632 obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE;
Jann Horna0ce2f02019-01-23 15:19:17 +01001633
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001634 obuf->len = len;
David Howells8cefc102019-11-15 13:30:32 +00001635 ibuf->offset += len;
1636 ibuf->len -= len;
1637 o_len = len;
1638 o_head++;
1639 opipe->head = o_head;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001640 }
David Howells8cefc102019-11-15 13:30:32 +00001641 ret += o_len;
1642 len -= o_len;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001643 } while (len);
1644
1645 pipe_unlock(ipipe);
1646 pipe_unlock(opipe);
1647
1648 /*
1649 * If we put data in the output pipe, wakeup any potential readers.
1650 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001651 if (ret > 0)
1652 wakeup_pipe_readers(opipe);
1653
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001654 if (input_wakeup)
1655 wakeup_pipe_writers(ipipe);
1656
1657 return ret;
1658}
1659
1660/*
Jens Axboe70524492006-04-11 15:51:17 +02001661 * Link contents of ipipe to opipe.
1662 */
1663static int link_pipe(struct pipe_inode_info *ipipe,
1664 struct pipe_inode_info *opipe,
1665 size_t len, unsigned int flags)
1666{
1667 struct pipe_buffer *ibuf, *obuf;
David Howells8cefc102019-11-15 13:30:32 +00001668 unsigned int i_head, o_head;
1669 unsigned int i_tail, o_tail;
1670 unsigned int i_mask, o_mask;
1671 int ret = 0;
Jens Axboe70524492006-04-11 15:51:17 +02001672
1673 /*
1674 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001675 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001676 * could deadlock (one doing tee from A -> B, the other from B -> A).
1677 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001678 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001679
David Howells8cefc102019-11-15 13:30:32 +00001680 i_tail = ipipe->tail;
1681 i_mask = ipipe->ring_size - 1;
1682 o_head = opipe->head;
1683 o_mask = opipe->ring_size - 1;
1684
Jens Axboeaadd06e2006-07-10 11:00:01 +02001685 do {
Jens Axboe70524492006-04-11 15:51:17 +02001686 if (!opipe->readers) {
1687 send_sig(SIGPIPE, current, 0);
1688 if (!ret)
1689 ret = -EPIPE;
1690 break;
1691 }
Jens Axboe70524492006-04-11 15:51:17 +02001692
David Howells8cefc102019-11-15 13:30:32 +00001693 i_head = ipipe->head;
1694 o_tail = opipe->tail;
1695
Jens Axboe70524492006-04-11 15:51:17 +02001696 /*
David Howells8cefc102019-11-15 13:30:32 +00001697 * If we have iterated all input buffers or run out of
Jens Axboeaadd06e2006-07-10 11:00:01 +02001698 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001699 */
David Howells8cefc102019-11-15 13:30:32 +00001700 if (pipe_empty(i_head, i_tail) ||
David Howells6718b6f2019-10-16 16:47:32 +01001701 pipe_full(o_head, o_tail, opipe->max_usage))
Jens Axboe70524492006-04-11 15:51:17 +02001702 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001703
David Howells8cefc102019-11-15 13:30:32 +00001704 ibuf = &ipipe->bufs[i_tail & i_mask];
1705 obuf = &opipe->bufs[o_head & o_mask];
Jens Axboeaadd06e2006-07-10 11:00:01 +02001706
Jens Axboe2a27250e2006-04-19 15:56:40 +02001707 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001708 * Get a reference to this pipe buffer,
1709 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001710 */
Matthew Wilcox15fab632019-04-05 14:02:10 -07001711 if (!pipe_buf_get(ipipe, ibuf)) {
1712 if (ret == 0)
1713 ret = -EFAULT;
1714 break;
1715 }
Jens Axboe70524492006-04-11 15:51:17 +02001716
Jens Axboeaadd06e2006-07-10 11:00:01 +02001717 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001718
Jens Axboeaadd06e2006-07-10 11:00:01 +02001719 /*
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001720 * Don't inherit the gift and merge flag, we need to prevent
1721 * multiple steals of this page.
Jens Axboeaadd06e2006-07-10 11:00:01 +02001722 */
1723 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001724 obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE;
Jann Horna0ce2f02019-01-23 15:19:17 +01001725
Jens Axboeaadd06e2006-07-10 11:00:01 +02001726 if (obuf->len > len)
1727 obuf->len = len;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001728 ret += obuf->len;
1729 len -= obuf->len;
David Howells8cefc102019-11-15 13:30:32 +00001730
1731 o_head++;
1732 opipe->head = o_head;
1733 i_tail++;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001734 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001735
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001736 pipe_unlock(ipipe);
1737 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001738
Jens Axboeaadd06e2006-07-10 11:00:01 +02001739 /*
1740 * If we put data in the output pipe, wakeup any potential readers.
1741 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001742 if (ret > 0)
1743 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001744
1745 return ret;
1746}
1747
1748/*
1749 * This is a tee(1) implementation that works on pipes. It doesn't copy
1750 * any data, it simply references the 'in' pages on the 'out' pipe.
1751 * The 'flags' used are the SPLICE_F_* variants, currently the only
1752 * applicable one is SPLICE_F_NONBLOCK.
1753 */
Pavel Begunkov9dafdfc2020-05-17 14:18:05 +03001754long do_tee(struct file *in, struct file *out, size_t len, unsigned int flags)
Jens Axboe70524492006-04-11 15:51:17 +02001755{
David Howellsc73be612020-01-14 17:07:11 +00001756 struct pipe_inode_info *ipipe = get_pipe_info(in, true);
1757 struct pipe_inode_info *opipe = get_pipe_info(out, true);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001758 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001759
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001760 if (unlikely(!(in->f_mode & FMODE_READ) ||
1761 !(out->f_mode & FMODE_WRITE)))
1762 return -EBADF;
1763
Jens Axboe70524492006-04-11 15:51:17 +02001764 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001765 * Duplicate the contents of ipipe to opipe without actually
1766 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001767 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001768 if (ipipe && opipe && ipipe != opipe) {
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001769 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1770 flags |= SPLICE_F_NONBLOCK;
1771
Jens Axboeaadd06e2006-07-10 11:00:01 +02001772 /*
1773 * Keep going, unless we encounter an error. The ipipe/opipe
1774 * ordering doesn't really matter.
1775 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001776 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001777 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001778 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001779 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001780 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001781 }
1782 }
Jens Axboe70524492006-04-11 15:51:17 +02001783
Jens Axboeaadd06e2006-07-10 11:00:01 +02001784 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001785}
1786
Heiko Carstens836f92a2009-01-14 14:14:33 +01001787SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001788{
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001789 struct fd in, out;
Al Viro2903ff02012-08-28 12:52:22 -04001790 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001791
Al Viro3d6ea292016-12-10 13:17:32 -05001792 if (unlikely(flags & ~SPLICE_F_ALL))
1793 return -EINVAL;
1794
Jens Axboe70524492006-04-11 15:51:17 +02001795 if (unlikely(!len))
1796 return 0;
1797
1798 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001799 in = fdget(fdin);
1800 if (in.file) {
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001801 out = fdget(fdout);
1802 if (out.file) {
1803 error = do_tee(in.file, out.file, len, flags);
1804 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001805 }
Al Viro2903ff02012-08-28 12:52:22 -04001806 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001807 }
1808
1809 return error;
1810}