blob: d7c8a7c4db07fff8cfc54a83adefba53207691a0 [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
529/**
530 * splice_from_pipe_next - wait for some data to splice from
531 * @pipe: pipe to splice from
532 * @sd: information about the splice operation
533 *
534 * Description:
535 * This function will wait for some data and return a positive
536 * value (one) if pipe buffers are available. It will return zero
537 * or -errno if no more data needs to be spliced.
538 */
Al Viro96f9bc82014-04-05 04:35:49 -0400539static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200540{
Jan Karac725bfc2015-11-23 13:09:50 +0100541 /*
542 * Check for signal early to make process killable when there are
543 * always buffers available
544 */
545 if (signal_pending(current))
546 return -ERESTARTSYS;
547
David Howells8cefc102019-11-15 13:30:32 +0000548 while (pipe_empty(pipe->head, pipe->tail)) {
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200549 if (!pipe->writers)
550 return 0;
551
Linus Torvaldsa28c8b92019-12-07 13:21:01 -0800552 if (sd->num_spliced)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200553 return 0;
554
555 if (sd->flags & SPLICE_F_NONBLOCK)
556 return -EAGAIN;
557
558 if (signal_pending(current))
559 return -ERESTARTSYS;
560
561 if (sd->need_wakeup) {
562 wakeup_pipe_writers(pipe);
563 sd->need_wakeup = false;
564 }
565
566 pipe_wait(pipe);
567 }
568
569 return 1;
570}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200571
572/**
573 * splice_from_pipe_begin - start splicing from pipe
Randy Dunlapb80901b2009-04-16 19:09:55 -0700574 * @sd: information about the splice operation
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200575 *
576 * Description:
577 * This function should be called before a loop containing
578 * splice_from_pipe_next() and splice_from_pipe_feed() to
579 * initialize the necessary fields of @sd.
580 */
Al Viro96f9bc82014-04-05 04:35:49 -0400581static void splice_from_pipe_begin(struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200582{
583 sd->num_spliced = 0;
584 sd->need_wakeup = false;
585}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200586
587/**
588 * splice_from_pipe_end - finish splicing from pipe
589 * @pipe: pipe to splice from
590 * @sd: information about the splice operation
591 *
592 * Description:
593 * This function will wake up pipe writers if necessary. It should
594 * be called after a loop containing splice_from_pipe_next() and
595 * splice_from_pipe_feed().
596 */
Al Viro96f9bc82014-04-05 04:35:49 -0400597static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200598{
599 if (sd->need_wakeup)
600 wakeup_pipe_writers(pipe);
601}
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200602
Jens Axboe932cc6d2007-06-21 13:10:21 +0200603/**
604 * __splice_from_pipe - splice data from a pipe to given actor
605 * @pipe: pipe to splice from
606 * @sd: information to @actor
607 * @actor: handler that splices the data
608 *
609 * Description:
610 * This function does little more than loop over the pipe and call
611 * @actor to do the actual moving of a single struct pipe_buffer to
612 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
613 * pipe_to_user.
614 *
Jens Axboe83f91352006-04-02 23:05:09 +0200615 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200616ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
617 splice_actor *actor)
Jens Axboe5274f052006-03-30 15:15:30 +0200618{
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200619 int ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200620
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200621 splice_from_pipe_begin(sd);
622 do {
Jan Karac2489e02015-11-23 13:09:51 +0100623 cond_resched();
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200624 ret = splice_from_pipe_next(pipe, sd);
625 if (ret > 0)
626 ret = splice_from_pipe_feed(pipe, sd, actor);
627 } while (ret > 0);
628 splice_from_pipe_end(pipe, sd);
Jens Axboe5274f052006-03-30 15:15:30 +0200629
Miklos Szeredib3c2d2d2009-04-14 19:48:36 +0200630 return sd->num_spliced ? sd->num_spliced : ret;
Jens Axboe5274f052006-03-30 15:15:30 +0200631}
Mark Fasheh40bee44e2007-03-21 13:11:02 +0100632EXPORT_SYMBOL(__splice_from_pipe);
Jens Axboe5274f052006-03-30 15:15:30 +0200633
Jens Axboe932cc6d2007-06-21 13:10:21 +0200634/**
635 * splice_from_pipe - splice data from a pipe to a file
636 * @pipe: pipe to splice from
637 * @out: file to splice to
638 * @ppos: position in @out
639 * @len: how many bytes to splice
640 * @flags: splice modifier flags
641 * @actor: handler that splices the data
642 *
643 * Description:
Miklos Szeredi29339702009-04-14 19:48:37 +0200644 * See __splice_from_pipe. This function locks the pipe inode,
Jens Axboe932cc6d2007-06-21 13:10:21 +0200645 * otherwise it's identical to __splice_from_pipe().
646 *
647 */
Mark Fasheh6da61802006-10-17 18:43:07 +0200648ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
649 loff_t *ppos, size_t len, unsigned int flags,
650 splice_actor *actor)
651{
652 ssize_t ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200653 struct splice_desc sd = {
654 .total_len = len,
655 .flags = flags,
656 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +0200657 .u.file = out,
Jens Axboec66ab6f2007-06-12 21:17:17 +0200658 };
Mark Fasheh6da61802006-10-17 18:43:07 +0200659
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200660 pipe_lock(pipe);
Jens Axboec66ab6f2007-06-12 21:17:17 +0200661 ret = __splice_from_pipe(pipe, &sd, actor);
Miklos Szeredi61e0d472009-04-14 19:48:41 +0200662 pipe_unlock(pipe);
Mark Fasheh6da61802006-10-17 18:43:07 +0200663
664 return ret;
665}
666
667/**
Al Viro8d020762014-04-05 04:27:08 -0400668 * iter_file_splice_write - splice data from a pipe to a file
669 * @pipe: pipe info
670 * @out: file to write to
671 * @ppos: position in @out
672 * @len: number of bytes to splice
673 * @flags: splice modifier flags
674 *
675 * Description:
676 * Will either move or copy pages (determined by @flags options) from
677 * the given pipe inode to the given file.
678 * This one is ->write_iter-based.
679 *
680 */
681ssize_t
682iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
683 loff_t *ppos, size_t len, unsigned int flags)
684{
685 struct splice_desc sd = {
686 .total_len = len,
687 .flags = flags,
688 .pos = *ppos,
689 .u.file = out,
690 };
David Howells6718b6f2019-10-16 16:47:32 +0100691 int nbufs = pipe->max_usage;
Al Viro8d020762014-04-05 04:27:08 -0400692 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
693 GFP_KERNEL);
694 ssize_t ret;
695
696 if (unlikely(!array))
697 return -ENOMEM;
698
699 pipe_lock(pipe);
700
701 splice_from_pipe_begin(&sd);
702 while (sd.total_len) {
703 struct iov_iter from;
Linus Torvaldsec057592019-12-06 12:40:35 -0800704 unsigned int head, tail, mask;
Al Viro8d020762014-04-05 04:27:08 -0400705 size_t left;
David Howells8cefc102019-11-15 13:30:32 +0000706 int n;
Al Viro8d020762014-04-05 04:27:08 -0400707
708 ret = splice_from_pipe_next(pipe, &sd);
709 if (ret <= 0)
710 break;
711
David Howells6718b6f2019-10-16 16:47:32 +0100712 if (unlikely(nbufs < pipe->max_usage)) {
Al Viro8d020762014-04-05 04:27:08 -0400713 kfree(array);
David Howells6718b6f2019-10-16 16:47:32 +0100714 nbufs = pipe->max_usage;
Al Viro8d020762014-04-05 04:27:08 -0400715 array = kcalloc(nbufs, sizeof(struct bio_vec),
716 GFP_KERNEL);
717 if (!array) {
718 ret = -ENOMEM;
719 break;
720 }
721 }
722
Linus Torvaldsec057592019-12-06 12:40:35 -0800723 head = pipe->head;
724 tail = pipe->tail;
725 mask = pipe->ring_size - 1;
726
Al Viro8d020762014-04-05 04:27:08 -0400727 /* build the vector */
728 left = sd.total_len;
David Howells8cefc102019-11-15 13:30:32 +0000729 for (n = 0; !pipe_empty(head, tail) && left && n < nbufs; tail++, n++) {
730 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
Al Viro8d020762014-04-05 04:27:08 -0400731 size_t this_len = buf->len;
732
733 if (this_len > left)
734 this_len = left;
735
Miklos Szeredifba597d2016-09-27 10:45:12 +0200736 ret = pipe_buf_confirm(pipe, buf);
Al Viro8d020762014-04-05 04:27:08 -0400737 if (unlikely(ret)) {
738 if (ret == -ENODATA)
739 ret = 0;
740 goto done;
741 }
742
743 array[n].bv_page = buf->page;
744 array[n].bv_len = this_len;
745 array[n].bv_offset = buf->offset;
746 left -= this_len;
747 }
748
David Howellsaa563d72018-10-20 00:57:56 +0100749 iov_iter_bvec(&from, WRITE, array, n, sd.total_len - left);
Christoph Hellwigabbb65892017-05-27 11:16:52 +0300750 ret = vfs_iter_write(out, &from, &sd.pos, 0);
Al Viro8d020762014-04-05 04:27:08 -0400751 if (ret <= 0)
752 break;
753
754 sd.num_spliced += ret;
755 sd.total_len -= ret;
Christoph Hellwigdbe4e192015-01-25 21:11:59 +0100756 *ppos = sd.pos;
Al Viro8d020762014-04-05 04:27:08 -0400757
758 /* dismiss the fully eaten buffers, adjust the partial one */
David Howells8cefc102019-11-15 13:30:32 +0000759 tail = pipe->tail;
Al Viro8d020762014-04-05 04:27:08 -0400760 while (ret) {
David Howells8cefc102019-11-15 13:30:32 +0000761 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
Al Viro8d020762014-04-05 04:27:08 -0400762 if (ret >= buf->len) {
Al Viro8d020762014-04-05 04:27:08 -0400763 ret -= buf->len;
764 buf->len = 0;
Miklos Szeredia7796382016-09-27 10:45:12 +0200765 pipe_buf_release(pipe, buf);
David Howells8cefc102019-11-15 13:30:32 +0000766 tail++;
767 pipe->tail = tail;
Al Viro8d020762014-04-05 04:27:08 -0400768 if (pipe->files)
769 sd.need_wakeup = true;
770 } else {
771 buf->offset += ret;
772 buf->len -= ret;
773 ret = 0;
774 }
775 }
776 }
777done:
778 kfree(array);
779 splice_from_pipe_end(pipe, &sd);
780
781 pipe_unlock(pipe);
782
783 if (sd.num_spliced)
784 ret = sd.num_spliced;
785
786 return ret;
787}
788
789EXPORT_SYMBOL(iter_file_splice_write);
790
Miklos Szeredib2858d72009-05-19 11:37:46 +0200791static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
792 struct splice_desc *sd)
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200793{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200794 int ret;
795 void *data;
Al Viro06ae43f2013-03-20 13:19:30 -0400796 loff_t tmp = sd->pos;
Miklos Szeredib2858d72009-05-19 11:37:46 +0200797
Al Virofbb32752014-02-02 21:09:54 -0500798 data = kmap(buf->page);
Al Viro06ae43f2013-03-20 13:19:30 -0400799 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
Al Virofbb32752014-02-02 21:09:54 -0500800 kunmap(buf->page);
Miklos Szeredib2858d72009-05-19 11:37:46 +0200801
802 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200803}
804
805static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
806 struct file *out, loff_t *ppos,
807 size_t len, unsigned int flags)
808{
Miklos Szeredib2858d72009-05-19 11:37:46 +0200809 ssize_t ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200810
Miklos Szeredib2858d72009-05-19 11:37:46 +0200811 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
812 if (ret > 0)
813 *ppos += ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200814
Miklos Szeredib2858d72009-05-19 11:37:46 +0200815 return ret;
Miklos Szeredi0b0a47f2009-05-07 15:37:37 +0200816}
817
Jens Axboe83f91352006-04-02 23:05:09 +0200818/**
819 * generic_splice_sendpage - splice data from a pipe to a socket
Jens Axboe932cc6d2007-06-21 13:10:21 +0200820 * @pipe: pipe to splice from
Jens Axboe83f91352006-04-02 23:05:09 +0200821 * @out: socket to write to
Jens Axboe932cc6d2007-06-21 13:10:21 +0200822 * @ppos: position in @out
Jens Axboe83f91352006-04-02 23:05:09 +0200823 * @len: number of bytes to splice
824 * @flags: splice modifier flags
825 *
Jens Axboe932cc6d2007-06-21 13:10:21 +0200826 * Description:
827 * Will send @len bytes from the pipe to a network socket. No data copying
828 * is involved.
Jens Axboe83f91352006-04-02 23:05:09 +0200829 *
830 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200831ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200832 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200833{
Jens Axboe00522fb2006-04-26 14:39:29 +0200834 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
Jens Axboe5274f052006-03-30 15:15:30 +0200835}
836
Jens Axboe059a8f32006-04-02 23:06:05 +0200837EXPORT_SYMBOL(generic_splice_sendpage);
Jeff Garzika0f06782006-03-30 23:06:13 -0500838
Jens Axboe83f91352006-04-02 23:05:09 +0200839/*
840 * Attempt to initiate a splice from pipe to file.
841 */
Ingo Molnar3a326a22006-04-10 15:18:35 +0200842static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
Jens Axboecbb7e572006-04-11 14:57:50 +0200843 loff_t *ppos, size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200844{
Al Viro72c2d532013-09-22 16:27:52 -0400845 if (out->f_op->splice_write)
Christoph Hellwig00c285d2020-05-20 17:58:11 +0200846 return out->f_op->splice_write(pipe, out, ppos, len, flags);
847 return default_file_splice_write(pipe, out, ppos, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200848}
849
Jens Axboe83f91352006-04-02 23:05:09 +0200850/*
851 * Attempt to initiate a splice from a file to a pipe.
852 */
Jens Axboecbb7e572006-04-11 14:57:50 +0200853static long do_splice_to(struct file *in, loff_t *ppos,
854 struct pipe_inode_info *pipe, size_t len,
855 unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +0200856{
Jens Axboe5274f052006-03-30 15:15:30 +0200857 int ret;
858
Jens Axboe49570e92006-04-11 13:56:09 +0200859 if (unlikely(!(in->f_mode & FMODE_READ)))
Jens Axboe5274f052006-03-30 15:15:30 +0200860 return -EBADF;
861
Jens Axboecbb7e572006-04-11 14:57:50 +0200862 ret = rw_verify_area(READ, in, ppos, len);
Jens Axboe5274f052006-03-30 15:15:30 +0200863 if (unlikely(ret < 0))
864 return ret;
865
Al Viro03cc0782016-04-02 14:56:58 -0400866 if (unlikely(len > MAX_RW_COUNT))
867 len = MAX_RW_COUNT;
868
Al Viro72c2d532013-09-22 16:27:52 -0400869 if (in->f_op->splice_read)
Christoph Hellwig2bc01062020-05-20 17:58:10 +0200870 return in->f_op->splice_read(in, ppos, pipe, len, flags);
871 return default_file_splice_read(in, ppos, pipe, len, flags);
Jens Axboe5274f052006-03-30 15:15:30 +0200872}
873
Jens Axboe932cc6d2007-06-21 13:10:21 +0200874/**
875 * splice_direct_to_actor - splices data directly between two non-pipes
876 * @in: file to splice from
877 * @sd: actor information on where to splice to
878 * @actor: handles the data splicing
879 *
880 * Description:
881 * This is a special case helper to splice directly between two
882 * points, without requiring an explicit pipe. Internally an allocated
Randy Dunlap79685b82007-07-27 08:08:51 +0200883 * pipe is cached in the process, and reused during the lifetime of
Jens Axboe932cc6d2007-06-21 13:10:21 +0200884 * that process.
885 *
Jens Axboec66ab6f2007-06-12 21:17:17 +0200886 */
887ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
888 splice_direct_actor *actor)
Jens Axboeb92ce552006-04-11 13:52:07 +0200889{
890 struct pipe_inode_info *pipe;
891 long ret, bytes;
892 umode_t i_mode;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200893 size_t len;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200894 int i, flags, more;
Jens Axboeb92ce552006-04-11 13:52:07 +0200895
896 /*
897 * We require the input being a regular file, as we don't want to
898 * randomly drop data for eg socket -> socket splicing. Use the
899 * piped splicing for that!
900 */
Al Viro496ad9a2013-01-23 17:07:38 -0500901 i_mode = file_inode(in)->i_mode;
Jens Axboeb92ce552006-04-11 13:52:07 +0200902 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
903 return -EINVAL;
904
905 /*
906 * neither in nor out is a pipe, setup an internal pipe attached to
907 * 'out' and transfer the wanted data from 'in' to 'out' through that
908 */
909 pipe = current->splice_pipe;
Jens Axboe49570e92006-04-11 13:56:09 +0200910 if (unlikely(!pipe)) {
Al Viro7bee1302013-03-21 11:04:15 -0400911 pipe = alloc_pipe_info();
Jens Axboeb92ce552006-04-11 13:52:07 +0200912 if (!pipe)
913 return -ENOMEM;
914
915 /*
916 * We don't have an immediate reader, but we'll read the stuff
Jens Axboe00522fb2006-04-26 14:39:29 +0200917 * out of the pipe right after the splice_to_pipe(). So set
Jens Axboeb92ce552006-04-11 13:52:07 +0200918 * PIPE_READERS appropriately.
919 */
920 pipe->readers = 1;
921
922 current->splice_pipe = pipe;
923 }
924
925 /*
Ingo Molnar73d62d82006-04-11 13:57:21 +0200926 * Do the splice.
Jens Axboeb92ce552006-04-11 13:52:07 +0200927 */
928 ret = 0;
929 bytes = 0;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200930 len = sd->total_len;
931 flags = sd->flags;
932
933 /*
934 * Don't block on output, we have to drain the direct pipe.
935 */
936 sd->flags &= ~SPLICE_F_NONBLOCK;
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200937 more = sd->flags & SPLICE_F_MORE;
Jens Axboeb92ce552006-04-11 13:52:07 +0200938
David Howells8cefc102019-11-15 13:30:32 +0000939 WARN_ON_ONCE(!pipe_empty(pipe->head, pipe->tail));
Darrick J. Wong17614442018-11-30 10:37:49 -0800940
Jens Axboeb92ce552006-04-11 13:52:07 +0200941 while (len) {
David Howells8cefc102019-11-15 13:30:32 +0000942 unsigned int p_space;
Jens Axboe51a92c02007-07-13 14:11:43 +0200943 size_t read_len;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200944 loff_t pos = sd->pos, prev_pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200945
Darrick J. Wong17614442018-11-30 10:37:49 -0800946 /* Don't try to read more the pipe has space for. */
David Howells6718b6f2019-10-16 16:47:32 +0100947 p_space = pipe->max_usage -
David Howells8cefc102019-11-15 13:30:32 +0000948 pipe_occupancy(pipe->head, pipe->tail);
949 read_len = min_t(size_t, len, p_space << PAGE_SHIFT);
Darrick J. Wong17614442018-11-30 10:37:49 -0800950 ret = do_splice_to(in, &pos, pipe, read_len, flags);
Jens Axboe51a92c02007-07-13 14:11:43 +0200951 if (unlikely(ret <= 0))
Jens Axboeb92ce552006-04-11 13:52:07 +0200952 goto out_release;
953
954 read_len = ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +0200955 sd->total_len = read_len;
Jens Axboeb92ce552006-04-11 13:52:07 +0200956
957 /*
Christophe Leroy0ff28d92015-05-06 17:26:47 +0200958 * If more data is pending, set SPLICE_F_MORE
959 * If this is the last data and SPLICE_F_MORE was not set
960 * initially, clears it.
961 */
962 if (read_len < len)
963 sd->flags |= SPLICE_F_MORE;
964 else if (!more)
965 sd->flags &= ~SPLICE_F_MORE;
966 /*
Jens Axboeb92ce552006-04-11 13:52:07 +0200967 * NOTE: nonblocking mode only applies to the input. We
968 * must not do the output in nonblocking mode as then we
969 * could get stuck data in the internal pipe:
970 */
Jens Axboec66ab6f2007-06-12 21:17:17 +0200971 ret = actor(pipe, sd);
Tom Zanussia82c53a2008-05-09 13:28:36 +0200972 if (unlikely(ret <= 0)) {
973 sd->pos = prev_pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200974 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200975 }
Jens Axboeb92ce552006-04-11 13:52:07 +0200976
977 bytes += ret;
978 len -= ret;
Jens Axboebcd4f3a2007-07-16 14:41:49 +0200979 sd->pos = pos;
Jens Axboeb92ce552006-04-11 13:52:07 +0200980
Tom Zanussia82c53a2008-05-09 13:28:36 +0200981 if (ret < read_len) {
982 sd->pos = prev_pos + ret;
Jens Axboe51a92c02007-07-13 14:11:43 +0200983 goto out_release;
Tom Zanussia82c53a2008-05-09 13:28:36 +0200984 }
Jens Axboeb92ce552006-04-11 13:52:07 +0200985 }
986
Jens Axboe9e971982008-01-29 21:05:57 +0100987done:
David Howells8cefc102019-11-15 13:30:32 +0000988 pipe->tail = pipe->head = 0;
Jens Axboe80848702008-01-30 12:24:48 +0100989 file_accessed(in);
Jens Axboeb92ce552006-04-11 13:52:07 +0200990 return bytes;
991
992out_release:
993 /*
994 * If we did an incomplete transfer we must release
995 * the pipe buffers in question:
996 */
David Howells8cefc102019-11-15 13:30:32 +0000997 for (i = 0; i < pipe->ring_size; i++) {
998 struct pipe_buffer *buf = &pipe->bufs[i];
Jens Axboeb92ce552006-04-11 13:52:07 +0200999
Miklos Szeredia7796382016-09-27 10:45:12 +02001000 if (buf->ops)
1001 pipe_buf_release(pipe, buf);
Jens Axboeb92ce552006-04-11 13:52:07 +02001002 }
Jens Axboeb92ce552006-04-11 13:52:07 +02001003
Jens Axboe9e971982008-01-29 21:05:57 +01001004 if (!bytes)
1005 bytes = ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001006
Jens Axboe9e971982008-01-29 21:05:57 +01001007 goto done;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001008}
1009EXPORT_SYMBOL(splice_direct_to_actor);
1010
1011static int direct_splice_actor(struct pipe_inode_info *pipe,
1012 struct splice_desc *sd)
1013{
Jens Axboe6a14b902007-06-14 13:08:55 +02001014 struct file *file = sd->u.file;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001015
Al Viro7995bd22013-06-20 18:58:36 +04001016 return do_splice_from(pipe, file, sd->opos, sd->total_len,
Changli Gao2cb4b052010-06-29 13:09:18 +02001017 sd->flags);
Jens Axboec66ab6f2007-06-12 21:17:17 +02001018}
1019
Jens Axboe932cc6d2007-06-21 13:10:21 +02001020/**
1021 * do_splice_direct - splices data directly between two files
1022 * @in: file to splice from
1023 * @ppos: input file offset
1024 * @out: file to splice to
Randy Dunlapacdb37c2013-06-22 19:44:08 -07001025 * @opos: output file offset
Jens Axboe932cc6d2007-06-21 13:10:21 +02001026 * @len: number of bytes to splice
1027 * @flags: splice modifier flags
1028 *
1029 * Description:
1030 * For use by do_sendfile(). splice can easily emulate sendfile, but
1031 * doing it in the application would incur an extra system call
1032 * (splice in + splice out, as compared to just sendfile()). So this helper
1033 * can splice directly through a process-private pipe.
1034 *
1035 */
Jens Axboec66ab6f2007-06-12 21:17:17 +02001036long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
Al Viro7995bd22013-06-20 18:58:36 +04001037 loff_t *opos, size_t len, unsigned int flags)
Jens Axboec66ab6f2007-06-12 21:17:17 +02001038{
1039 struct splice_desc sd = {
1040 .len = len,
1041 .total_len = len,
1042 .flags = flags,
1043 .pos = *ppos,
Jens Axboe6a14b902007-06-14 13:08:55 +02001044 .u.file = out,
Al Viro7995bd22013-06-20 18:58:36 +04001045 .opos = opos,
Jens Axboec66ab6f2007-06-12 21:17:17 +02001046 };
Jens Axboe51a92c02007-07-13 14:11:43 +02001047 long ret;
Jens Axboec66ab6f2007-06-12 21:17:17 +02001048
Al Viro18c67cb2013-06-19 15:41:54 +04001049 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1050 return -EBADF;
1051
1052 if (unlikely(out->f_flags & O_APPEND))
1053 return -EINVAL;
1054
1055 ret = rw_verify_area(WRITE, out, opos, len);
1056 if (unlikely(ret < 0))
1057 return ret;
1058
Jens Axboec66ab6f2007-06-12 21:17:17 +02001059 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
Jens Axboe51a92c02007-07-13 14:11:43 +02001060 if (ret > 0)
Tom Zanussia82c53a2008-05-09 13:28:36 +02001061 *ppos = sd.pos;
Jens Axboe51a92c02007-07-13 14:11:43 +02001062
Jens Axboec66ab6f2007-06-12 21:17:17 +02001063 return ret;
Jens Axboeb92ce552006-04-11 13:52:07 +02001064}
Miklos Szeredi1c118592014-10-24 00:14:35 +02001065EXPORT_SYMBOL(do_splice_direct);
Jens Axboeb92ce552006-04-11 13:52:07 +02001066
Al Viro8924fef2016-09-17 20:44:45 -04001067static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1068{
Linus Torvalds52bce912016-12-21 10:59:34 -08001069 for (;;) {
1070 if (unlikely(!pipe->readers)) {
1071 send_sig(SIGPIPE, current, 0);
1072 return -EPIPE;
1073 }
David Howells6718b6f2019-10-16 16:47:32 +01001074 if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage))
Linus Torvalds52bce912016-12-21 10:59:34 -08001075 return 0;
Al Viro8924fef2016-09-17 20:44:45 -04001076 if (flags & SPLICE_F_NONBLOCK)
1077 return -EAGAIN;
1078 if (signal_pending(current))
1079 return -ERESTARTSYS;
Al Viro8924fef2016-09-17 20:44:45 -04001080 pipe_wait(pipe);
Al Viro8924fef2016-09-17 20:44:45 -04001081 }
Al Viro8924fef2016-09-17 20:44:45 -04001082}
1083
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001084static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1085 struct pipe_inode_info *opipe,
1086 size_t len, unsigned int flags);
Jens Axboeddac0d32006-11-04 12:49:32 +01001087
1088/*
Jens Axboe83f91352006-04-02 23:05:09 +02001089 * Determine where to splice to/from.
1090 */
Pavel Begunkov444ebb52020-02-24 11:32:43 +03001091long do_splice(struct file *in, loff_t __user *off_in,
1092 struct file *out, loff_t __user *off_out,
1093 size_t len, unsigned int flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001094{
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001095 struct pipe_inode_info *ipipe;
1096 struct pipe_inode_info *opipe;
Al Viro7995bd22013-06-20 18:58:36 +04001097 loff_t offset;
Jens Axboea4514eb2006-04-19 15:57:05 +02001098 long ret;
Jens Axboe5274f052006-03-30 15:15:30 +02001099
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001100 if (unlikely(!(in->f_mode & FMODE_READ) ||
1101 !(out->f_mode & FMODE_WRITE)))
1102 return -EBADF;
1103
David Howellsc73be612020-01-14 17:07:11 +00001104 ipipe = get_pipe_info(in, true);
1105 opipe = get_pipe_info(out, true);
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001106
1107 if (ipipe && opipe) {
1108 if (off_in || off_out)
1109 return -ESPIPE;
1110
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001111 /* Splicing to self would be fun, but... */
1112 if (ipipe == opipe)
1113 return -EINVAL;
1114
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001115 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1116 flags |= SPLICE_F_NONBLOCK;
1117
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001118 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1119 }
1120
1121 if (ipipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001122 if (off_in)
1123 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001124 if (off_out) {
Changli Gao19c9a492010-06-29 13:10:36 +02001125 if (!(out->f_mode & FMODE_PWRITE))
Jens Axboeb92ce552006-04-11 13:52:07 +02001126 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001127 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001128 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001129 } else {
1130 offset = out->f_pos;
1131 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001132
Al Viro18c67cb2013-06-19 15:41:54 +04001133 if (unlikely(out->f_flags & O_APPEND))
1134 return -EINVAL;
1135
1136 ret = rw_verify_area(WRITE, out, &offset, len);
1137 if (unlikely(ret < 0))
1138 return ret;
1139
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001140 if (in->f_flags & O_NONBLOCK)
1141 flags |= SPLICE_F_NONBLOCK;
1142
Al Viro500368f2013-05-23 20:07:11 -04001143 file_start_write(out);
Al Viro7995bd22013-06-20 18:58:36 +04001144 ret = do_splice_from(ipipe, out, &offset, len, flags);
Al Viro500368f2013-05-23 20:07:11 -04001145 file_end_write(out);
Jens Axboea4514eb2006-04-19 15:57:05 +02001146
Al Viro7995bd22013-06-20 18:58:36 +04001147 if (!off_out)
1148 out->f_pos = offset;
1149 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001150 ret = -EFAULT;
1151
1152 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001153 }
Jens Axboe5274f052006-03-30 15:15:30 +02001154
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001155 if (opipe) {
Ingo Molnar529565dc2006-04-10 15:18:58 +02001156 if (off_out)
1157 return -ESPIPE;
Jens Axboeb92ce552006-04-11 13:52:07 +02001158 if (off_in) {
Changli Gao19c9a492010-06-29 13:10:36 +02001159 if (!(in->f_mode & FMODE_PREAD))
Jens Axboeb92ce552006-04-11 13:52:07 +02001160 return -EINVAL;
Jens Axboecbb7e572006-04-11 14:57:50 +02001161 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
Jens Axboeb92ce552006-04-11 13:52:07 +02001162 return -EFAULT;
Al Viro7995bd22013-06-20 18:58:36 +04001163 } else {
1164 offset = in->f_pos;
1165 }
Ingo Molnar529565dc2006-04-10 15:18:58 +02001166
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001167 if (out->f_flags & O_NONBLOCK)
1168 flags |= SPLICE_F_NONBLOCK;
1169
Al Viro8924fef2016-09-17 20:44:45 -04001170 pipe_lock(opipe);
1171 ret = wait_for_space(opipe, flags);
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001172 if (!ret) {
Linus Torvalds6a965662019-11-30 14:12:13 -08001173 unsigned int p_space;
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001174
1175 /* Don't try to read more the pipe has space for. */
Linus Torvalds6a965662019-11-30 14:12:13 -08001176 p_space = opipe->max_usage - pipe_occupancy(opipe->head, opipe->tail);
1177 len = min_t(size_t, len, p_space << PAGE_SHIFT);
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001178
Al Viro8924fef2016-09-17 20:44:45 -04001179 ret = do_splice_to(in, &offset, opipe, len, flags);
Darrick J. Wong3253d9d2019-10-15 08:44:32 -07001180 }
Al Viro8924fef2016-09-17 20:44:45 -04001181 pipe_unlock(opipe);
1182 if (ret > 0)
1183 wakeup_pipe_readers(opipe);
Al Viro7995bd22013-06-20 18:58:36 +04001184 if (!off_in)
1185 in->f_pos = offset;
1186 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
Jens Axboea4514eb2006-04-19 15:57:05 +02001187 ret = -EFAULT;
1188
1189 return ret;
Ingo Molnar529565dc2006-04-10 15:18:58 +02001190 }
Jens Axboe5274f052006-03-30 15:15:30 +02001191
1192 return -EINVAL;
1193}
1194
Al Viro79fddc42016-09-17 22:38:20 -04001195static int iter_to_pipe(struct iov_iter *from,
1196 struct pipe_inode_info *pipe,
1197 unsigned flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001198{
Al Viro79fddc42016-09-17 22:38:20 -04001199 struct pipe_buffer buf = {
1200 .ops = &user_page_pipe_buf_ops,
1201 .flags = flags
1202 };
1203 size_t total = 0;
1204 int ret = 0;
1205 bool failed = false;
1206
1207 while (iov_iter_count(from) && !failed) {
1208 struct page *pages[16];
Al Virodb85a9e2016-09-17 20:25:06 -04001209 ssize_t copied;
1210 size_t start;
Al Viro79fddc42016-09-17 22:38:20 -04001211 int n;
Jens Axboe912d35f2006-04-26 10:59:21 +02001212
Al Viro79fddc42016-09-17 22:38:20 -04001213 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1214 if (copied <= 0) {
1215 ret = copied;
1216 break;
1217 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001218
Al Viro79fddc42016-09-17 22:38:20 -04001219 for (n = 0; copied; n++, start = 0) {
Al Virodb85a9e2016-09-17 20:25:06 -04001220 int size = min_t(int, copied, PAGE_SIZE - start);
Al Viro79fddc42016-09-17 22:38:20 -04001221 if (!failed) {
1222 buf.page = pages[n];
1223 buf.offset = start;
1224 buf.len = size;
1225 ret = add_to_pipe(pipe, &buf);
1226 if (unlikely(ret < 0)) {
1227 failed = true;
1228 } else {
1229 iov_iter_advance(from, ret);
1230 total += ret;
1231 }
1232 } else {
1233 put_page(pages[n]);
1234 }
Al Virodb85a9e2016-09-17 20:25:06 -04001235 copied -= size;
Jens Axboe912d35f2006-04-26 10:59:21 +02001236 }
Jens Axboe912d35f2006-04-26 10:59:21 +02001237 }
Al Viro79fddc42016-09-17 22:38:20 -04001238 return total ? total : ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001239}
1240
Jens Axboe6a14b902007-06-14 13:08:55 +02001241static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1242 struct splice_desc *sd)
1243{
Al Viro6130f532014-02-03 18:19:51 -05001244 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1245 return n == sd->len ? n : -EFAULT;
Jens Axboe6a14b902007-06-14 13:08:55 +02001246}
1247
1248/*
1249 * For lack of a better implementation, implement vmsplice() to userspace
1250 * as a simple copy of the pipes pages to the user iov.
1251 */
Al Viro87a30022018-05-26 21:39:52 -04001252static long vmsplice_to_user(struct file *file, struct iov_iter *iter,
1253 unsigned int flags)
Jens Axboe6a14b902007-06-14 13:08:55 +02001254{
David Howellsc73be612020-01-14 17:07:11 +00001255 struct pipe_inode_info *pipe = get_pipe_info(file, true);
Al Viro87a30022018-05-26 21:39:52 -04001256 struct splice_desc sd = {
1257 .total_len = iov_iter_count(iter),
1258 .flags = flags,
1259 .u.data = iter
1260 };
1261 long ret = 0;
Jens Axboe6a14b902007-06-14 13:08:55 +02001262
Jens Axboe6a14b902007-06-14 13:08:55 +02001263 if (!pipe)
1264 return -EBADF;
1265
Al Viro345995f2015-03-21 19:17:55 -04001266 if (sd.total_len) {
1267 pipe_lock(pipe);
1268 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1269 pipe_unlock(pipe);
1270 }
Jens Axboe6a14b902007-06-14 13:08:55 +02001271
Jens Axboe6a14b902007-06-14 13:08:55 +02001272 return ret;
1273}
1274
Jens Axboe912d35f2006-04-26 10:59:21 +02001275/*
1276 * vmsplice splices a user address range into a pipe. It can be thought of
1277 * as splice-from-memory, where the regular splice is splice-from-file (or
1278 * to file). In both cases the output is a pipe, naturally.
Jens Axboe912d35f2006-04-26 10:59:21 +02001279 */
Al Viro87a30022018-05-26 21:39:52 -04001280static long vmsplice_to_pipe(struct file *file, struct iov_iter *iter,
1281 unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001282{
Jens Axboeddac0d32006-11-04 12:49:32 +01001283 struct pipe_inode_info *pipe;
Al Viro87a30022018-05-26 21:39:52 -04001284 long ret = 0;
Al Viro79fddc42016-09-17 22:38:20 -04001285 unsigned buf_flag = 0;
1286
1287 if (flags & SPLICE_F_GIFT)
1288 buf_flag = PIPE_BUF_FLAG_GIFT;
Jens Axboe912d35f2006-04-26 10:59:21 +02001289
David Howellsc73be612020-01-14 17:07:11 +00001290 pipe = get_pipe_info(file, true);
Jens Axboeddac0d32006-11-04 12:49:32 +01001291 if (!pipe)
Jens Axboe912d35f2006-04-26 10:59:21 +02001292 return -EBADF;
Jens Axboe912d35f2006-04-26 10:59:21 +02001293
Al Viro8924fef2016-09-17 20:44:45 -04001294 pipe_lock(pipe);
1295 ret = wait_for_space(pipe, flags);
Al Viro79fddc42016-09-17 22:38:20 -04001296 if (!ret)
Al Viro87a30022018-05-26 21:39:52 -04001297 ret = iter_to_pipe(iter, pipe, buf_flag);
Al Viro8924fef2016-09-17 20:44:45 -04001298 pipe_unlock(pipe);
1299 if (ret > 0)
1300 wakeup_pipe_readers(pipe);
Jens Axboe35f3d142010-05-20 10:43:18 +02001301 return ret;
Jens Axboe912d35f2006-04-26 10:59:21 +02001302}
1303
Al Viro87a30022018-05-26 21:39:52 -04001304static int vmsplice_type(struct fd f, int *type)
1305{
1306 if (!f.file)
1307 return -EBADF;
1308 if (f.file->f_mode & FMODE_WRITE) {
1309 *type = WRITE;
1310 } else if (f.file->f_mode & FMODE_READ) {
1311 *type = READ;
1312 } else {
1313 fdput(f);
1314 return -EBADF;
1315 }
1316 return 0;
1317}
1318
Jens Axboe6a14b902007-06-14 13:08:55 +02001319/*
1320 * Note that vmsplice only really supports true splicing _from_ user memory
1321 * to a pipe, not the other way around. Splicing from user memory is a simple
1322 * operation that can be supported without any funky alignment restrictions
1323 * or nasty vm tricks. We simply map in the user memory and fill them into
1324 * a pipe. The reverse isn't quite as easy, though. There are two possible
1325 * solutions for that:
1326 *
1327 * - memcpy() the data internally, at which point we might as well just
1328 * do a regular read() on the buffer anyway.
1329 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1330 * has restriction limitations on both ends of the pipe).
1331 *
1332 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1333 *
1334 */
Al Viro87a30022018-05-26 21:39:52 -04001335static long do_vmsplice(struct file *f, struct iov_iter *iter, unsigned int flags)
Jens Axboe912d35f2006-04-26 10:59:21 +02001336{
Al Viro3d6ea292016-12-10 13:17:32 -05001337 if (unlikely(flags & ~SPLICE_F_ALL))
1338 return -EINVAL;
Al Viro87a30022018-05-26 21:39:52 -04001339
1340 if (!iov_iter_count(iter))
Jens Axboe6a14b902007-06-14 13:08:55 +02001341 return 0;
1342
Al Viro87a30022018-05-26 21:39:52 -04001343 if (iov_iter_rw(iter) == WRITE)
1344 return vmsplice_to_pipe(f, iter, flags);
1345 else
1346 return vmsplice_to_user(f, iter, flags);
Jens Axboe912d35f2006-04-26 10:59:21 +02001347}
1348
Al Viro87a30022018-05-26 21:39:52 -04001349SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, uiov,
Dominik Brodowski30cfe4e2018-03-17 15:00:24 +01001350 unsigned long, nr_segs, unsigned int, flags)
1351{
Al Viro87a30022018-05-26 21:39:52 -04001352 struct iovec iovstack[UIO_FASTIOV];
1353 struct iovec *iov = iovstack;
1354 struct iov_iter iter;
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001355 ssize_t error;
Al Viro87a30022018-05-26 21:39:52 -04001356 struct fd f;
1357 int type;
1358
1359 f = fdget(fd);
1360 error = vmsplice_type(f, &type);
1361 if (error)
1362 return error;
1363
1364 error = import_iovec(type, uiov, nr_segs,
1365 ARRAY_SIZE(iovstack), &iov, &iter);
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001366 if (error >= 0) {
Al Viro87a30022018-05-26 21:39:52 -04001367 error = do_vmsplice(f.file, &iter, flags);
1368 kfree(iov);
1369 }
1370 fdput(f);
1371 return error;
Dominik Brodowski30cfe4e2018-03-17 15:00:24 +01001372}
1373
Al Viro76b021d2013-03-02 10:19:56 -05001374#ifdef CONFIG_COMPAT
1375COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1376 unsigned int, nr_segs, unsigned int, flags)
1377{
Al Viro87a30022018-05-26 21:39:52 -04001378 struct iovec iovstack[UIO_FASTIOV];
1379 struct iovec *iov = iovstack;
1380 struct iov_iter iter;
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001381 ssize_t error;
Al Viro87a30022018-05-26 21:39:52 -04001382 struct fd f;
1383 int type;
1384
1385 f = fdget(fd);
1386 error = vmsplice_type(f, &type);
1387 if (error)
1388 return error;
1389
1390 error = compat_import_iovec(type, iov32, nr_segs,
1391 ARRAY_SIZE(iovstack), &iov, &iter);
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001392 if (error >= 0) {
Al Viro87a30022018-05-26 21:39:52 -04001393 error = do_vmsplice(f.file, &iter, flags);
1394 kfree(iov);
Al Viro76b021d2013-03-02 10:19:56 -05001395 }
Al Viro87a30022018-05-26 21:39:52 -04001396 fdput(f);
1397 return error;
Al Viro76b021d2013-03-02 10:19:56 -05001398}
1399#endif
1400
Heiko Carstens836f92a2009-01-14 14:14:33 +01001401SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1402 int, fd_out, loff_t __user *, off_out,
1403 size_t, len, unsigned int, flags)
Jens Axboe5274f052006-03-30 15:15:30 +02001404{
Al Viro2903ff02012-08-28 12:52:22 -04001405 struct fd in, out;
Jens Axboe5274f052006-03-30 15:15:30 +02001406 long error;
Jens Axboe5274f052006-03-30 15:15:30 +02001407
1408 if (unlikely(!len))
1409 return 0;
1410
Al Viro3d6ea292016-12-10 13:17:32 -05001411 if (unlikely(flags & ~SPLICE_F_ALL))
1412 return -EINVAL;
1413
Jens Axboe5274f052006-03-30 15:15:30 +02001414 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001415 in = fdget(fd_in);
1416 if (in.file) {
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001417 out = fdget(fd_out);
1418 if (out.file) {
1419 error = do_splice(in.file, off_in, out.file, off_out,
1420 len, flags);
1421 fdput(out);
Jens Axboe5274f052006-03-30 15:15:30 +02001422 }
Al Viro2903ff02012-08-28 12:52:22 -04001423 fdput(in);
Jens Axboe5274f052006-03-30 15:15:30 +02001424 }
Jens Axboe5274f052006-03-30 15:15:30 +02001425 return error;
1426}
Jens Axboe70524492006-04-11 15:51:17 +02001427
1428/*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001429 * Make sure there's data to read. Wait for input if we can, otherwise
1430 * return an appropriate error.
1431 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001432static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001433{
1434 int ret;
1435
1436 /*
David Howells8cefc102019-11-15 13:30:32 +00001437 * Check the pipe occupancy without the inode lock first. This function
Jens Axboeaadd06e2006-07-10 11:00:01 +02001438 * is speculative anyways, so missing one is ok.
1439 */
David Howells8cefc102019-11-15 13:30:32 +00001440 if (!pipe_empty(pipe->head, pipe->tail))
Jens Axboeaadd06e2006-07-10 11:00:01 +02001441 return 0;
1442
1443 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001444 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001445
David Howells8cefc102019-11-15 13:30:32 +00001446 while (pipe_empty(pipe->head, pipe->tail)) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001447 if (signal_pending(current)) {
1448 ret = -ERESTARTSYS;
1449 break;
1450 }
1451 if (!pipe->writers)
1452 break;
Linus Torvaldsa28c8b92019-12-07 13:21:01 -08001453 if (flags & SPLICE_F_NONBLOCK) {
1454 ret = -EAGAIN;
1455 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001456 }
1457 pipe_wait(pipe);
1458 }
1459
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001460 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001461 return ret;
1462}
1463
1464/*
1465 * Make sure there's writeable room. Wait for room if we can, otherwise
1466 * return an appropriate error.
1467 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001468static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001469{
1470 int ret;
1471
1472 /*
David Howells8cefc102019-11-15 13:30:32 +00001473 * Check pipe occupancy without the inode lock first. This function
Jens Axboeaadd06e2006-07-10 11:00:01 +02001474 * is speculative anyways, so missing one is ok.
1475 */
Tetsuo Handa566d1362020-05-20 08:51:59 +09001476 if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage))
Jens Axboeaadd06e2006-07-10 11:00:01 +02001477 return 0;
1478
1479 ret = 0;
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001480 pipe_lock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001481
David Howells6718b6f2019-10-16 16:47:32 +01001482 while (pipe_full(pipe->head, pipe->tail, pipe->max_usage)) {
Jens Axboeaadd06e2006-07-10 11:00:01 +02001483 if (!pipe->readers) {
1484 send_sig(SIGPIPE, current, 0);
1485 ret = -EPIPE;
1486 break;
1487 }
1488 if (flags & SPLICE_F_NONBLOCK) {
1489 ret = -EAGAIN;
1490 break;
1491 }
1492 if (signal_pending(current)) {
1493 ret = -ERESTARTSYS;
1494 break;
1495 }
Jens Axboeaadd06e2006-07-10 11:00:01 +02001496 pipe_wait(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001497 }
1498
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001499 pipe_unlock(pipe);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001500 return ret;
1501}
1502
1503/*
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001504 * Splice contents of ipipe to opipe.
1505 */
1506static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1507 struct pipe_inode_info *opipe,
1508 size_t len, unsigned int flags)
1509{
1510 struct pipe_buffer *ibuf, *obuf;
David Howells8cefc102019-11-15 13:30:32 +00001511 unsigned int i_head, o_head;
1512 unsigned int i_tail, o_tail;
1513 unsigned int i_mask, o_mask;
1514 int ret = 0;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001515 bool input_wakeup = false;
1516
1517
1518retry:
1519 ret = ipipe_prep(ipipe, flags);
1520 if (ret)
1521 return ret;
1522
1523 ret = opipe_prep(opipe, flags);
1524 if (ret)
1525 return ret;
1526
1527 /*
1528 * Potential ABBA deadlock, work around it by ordering lock
1529 * grabbing by pipe info address. Otherwise two different processes
1530 * could deadlock (one doing tee from A -> B, the other from B -> A).
1531 */
1532 pipe_double_lock(ipipe, opipe);
1533
David Howells8cefc102019-11-15 13:30:32 +00001534 i_tail = ipipe->tail;
1535 i_mask = ipipe->ring_size - 1;
1536 o_head = opipe->head;
1537 o_mask = opipe->ring_size - 1;
1538
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001539 do {
David Howells8cefc102019-11-15 13:30:32 +00001540 size_t o_len;
1541
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001542 if (!opipe->readers) {
1543 send_sig(SIGPIPE, current, 0);
1544 if (!ret)
1545 ret = -EPIPE;
1546 break;
1547 }
1548
David Howells8cefc102019-11-15 13:30:32 +00001549 i_head = ipipe->head;
1550 o_tail = opipe->tail;
1551
1552 if (pipe_empty(i_head, i_tail) && !ipipe->writers)
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001553 break;
1554
1555 /*
1556 * Cannot make any progress, because either the input
1557 * pipe is empty or the output pipe is full.
1558 */
David Howells8cefc102019-11-15 13:30:32 +00001559 if (pipe_empty(i_head, i_tail) ||
David Howells6718b6f2019-10-16 16:47:32 +01001560 pipe_full(o_head, o_tail, opipe->max_usage)) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001561 /* Already processed some buffers, break */
1562 if (ret)
1563 break;
1564
1565 if (flags & SPLICE_F_NONBLOCK) {
1566 ret = -EAGAIN;
1567 break;
1568 }
1569
1570 /*
1571 * We raced with another reader/writer and haven't
1572 * managed to process any buffers. A zero return
1573 * value means EOF, so retry instead.
1574 */
1575 pipe_unlock(ipipe);
1576 pipe_unlock(opipe);
1577 goto retry;
1578 }
1579
David Howells8cefc102019-11-15 13:30:32 +00001580 ibuf = &ipipe->bufs[i_tail & i_mask];
1581 obuf = &opipe->bufs[o_head & o_mask];
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001582
1583 if (len >= ibuf->len) {
1584 /*
1585 * Simply move the whole buffer from ipipe to opipe
1586 */
1587 *obuf = *ibuf;
1588 ibuf->ops = NULL;
David Howells8cefc102019-11-15 13:30:32 +00001589 i_tail++;
1590 ipipe->tail = i_tail;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001591 input_wakeup = true;
David Howells8cefc102019-11-15 13:30:32 +00001592 o_len = obuf->len;
1593 o_head++;
1594 opipe->head = o_head;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001595 } else {
1596 /*
1597 * Get a reference to this pipe buffer,
1598 * so we can copy the contents over.
1599 */
Matthew Wilcox15fab632019-04-05 14:02:10 -07001600 if (!pipe_buf_get(ipipe, ibuf)) {
1601 if (ret == 0)
1602 ret = -EFAULT;
1603 break;
1604 }
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001605 *obuf = *ibuf;
1606
1607 /*
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001608 * Don't inherit the gift and merge flags, we need to
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001609 * prevent multiple steals of this page.
1610 */
1611 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001612 obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE;
Jann Horna0ce2f02019-01-23 15:19:17 +01001613
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001614 obuf->len = len;
David Howells8cefc102019-11-15 13:30:32 +00001615 ibuf->offset += len;
1616 ibuf->len -= len;
1617 o_len = len;
1618 o_head++;
1619 opipe->head = o_head;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001620 }
David Howells8cefc102019-11-15 13:30:32 +00001621 ret += o_len;
1622 len -= o_len;
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001623 } while (len);
1624
1625 pipe_unlock(ipipe);
1626 pipe_unlock(opipe);
1627
1628 /*
1629 * If we put data in the output pipe, wakeup any potential readers.
1630 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001631 if (ret > 0)
1632 wakeup_pipe_readers(opipe);
1633
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001634 if (input_wakeup)
1635 wakeup_pipe_writers(ipipe);
1636
1637 return ret;
1638}
1639
1640/*
Jens Axboe70524492006-04-11 15:51:17 +02001641 * Link contents of ipipe to opipe.
1642 */
1643static int link_pipe(struct pipe_inode_info *ipipe,
1644 struct pipe_inode_info *opipe,
1645 size_t len, unsigned int flags)
1646{
1647 struct pipe_buffer *ibuf, *obuf;
David Howells8cefc102019-11-15 13:30:32 +00001648 unsigned int i_head, o_head;
1649 unsigned int i_tail, o_tail;
1650 unsigned int i_mask, o_mask;
1651 int ret = 0;
Jens Axboe70524492006-04-11 15:51:17 +02001652
1653 /*
1654 * Potential ABBA deadlock, work around it by ordering lock
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001655 * grabbing by pipe info address. Otherwise two different processes
Jens Axboe70524492006-04-11 15:51:17 +02001656 * could deadlock (one doing tee from A -> B, the other from B -> A).
1657 */
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001658 pipe_double_lock(ipipe, opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001659
David Howells8cefc102019-11-15 13:30:32 +00001660 i_tail = ipipe->tail;
1661 i_mask = ipipe->ring_size - 1;
1662 o_head = opipe->head;
1663 o_mask = opipe->ring_size - 1;
1664
Jens Axboeaadd06e2006-07-10 11:00:01 +02001665 do {
Jens Axboe70524492006-04-11 15:51:17 +02001666 if (!opipe->readers) {
1667 send_sig(SIGPIPE, current, 0);
1668 if (!ret)
1669 ret = -EPIPE;
1670 break;
1671 }
Jens Axboe70524492006-04-11 15:51:17 +02001672
David Howells8cefc102019-11-15 13:30:32 +00001673 i_head = ipipe->head;
1674 o_tail = opipe->tail;
1675
Jens Axboe70524492006-04-11 15:51:17 +02001676 /*
David Howells8cefc102019-11-15 13:30:32 +00001677 * If we have iterated all input buffers or run out of
Jens Axboeaadd06e2006-07-10 11:00:01 +02001678 * output room, break.
Jens Axboe70524492006-04-11 15:51:17 +02001679 */
David Howells8cefc102019-11-15 13:30:32 +00001680 if (pipe_empty(i_head, i_tail) ||
David Howells6718b6f2019-10-16 16:47:32 +01001681 pipe_full(o_head, o_tail, opipe->max_usage))
Jens Axboe70524492006-04-11 15:51:17 +02001682 break;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001683
David Howells8cefc102019-11-15 13:30:32 +00001684 ibuf = &ipipe->bufs[i_tail & i_mask];
1685 obuf = &opipe->bufs[o_head & o_mask];
Jens Axboeaadd06e2006-07-10 11:00:01 +02001686
Jens Axboe2a27250e2006-04-19 15:56:40 +02001687 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001688 * Get a reference to this pipe buffer,
1689 * so we can copy the contents over.
Jens Axboe2a27250e2006-04-19 15:56:40 +02001690 */
Matthew Wilcox15fab632019-04-05 14:02:10 -07001691 if (!pipe_buf_get(ipipe, ibuf)) {
1692 if (ret == 0)
1693 ret = -EFAULT;
1694 break;
1695 }
Jens Axboe70524492006-04-11 15:51:17 +02001696
Jens Axboeaadd06e2006-07-10 11:00:01 +02001697 *obuf = *ibuf;
Jens Axboe70524492006-04-11 15:51:17 +02001698
Jens Axboeaadd06e2006-07-10 11:00:01 +02001699 /*
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001700 * Don't inherit the gift and merge flag, we need to prevent
1701 * multiple steals of this page.
Jens Axboeaadd06e2006-07-10 11:00:01 +02001702 */
1703 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
Christoph Hellwigf6dd9752020-05-20 17:58:12 +02001704 obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE;
Jann Horna0ce2f02019-01-23 15:19:17 +01001705
Jens Axboeaadd06e2006-07-10 11:00:01 +02001706 if (obuf->len > len)
1707 obuf->len = len;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001708 ret += obuf->len;
1709 len -= obuf->len;
David Howells8cefc102019-11-15 13:30:32 +00001710
1711 o_head++;
1712 opipe->head = o_head;
1713 i_tail++;
Jens Axboeaadd06e2006-07-10 11:00:01 +02001714 } while (len);
Jens Axboe70524492006-04-11 15:51:17 +02001715
Miklos Szeredi61e0d472009-04-14 19:48:41 +02001716 pipe_unlock(ipipe);
1717 pipe_unlock(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001718
Jens Axboeaadd06e2006-07-10 11:00:01 +02001719 /*
1720 * If we put data in the output pipe, wakeup any potential readers.
1721 */
Namhyung Kim825cdcb2011-05-23 19:58:53 +02001722 if (ret > 0)
1723 wakeup_pipe_readers(opipe);
Jens Axboe70524492006-04-11 15:51:17 +02001724
1725 return ret;
1726}
1727
1728/*
1729 * This is a tee(1) implementation that works on pipes. It doesn't copy
1730 * any data, it simply references the 'in' pages on the 'out' pipe.
1731 * The 'flags' used are the SPLICE_F_* variants, currently the only
1732 * applicable one is SPLICE_F_NONBLOCK.
1733 */
Pavel Begunkov9dafdfc2020-05-17 14:18:05 +03001734long do_tee(struct file *in, struct file *out, size_t len, unsigned int flags)
Jens Axboe70524492006-04-11 15:51:17 +02001735{
David Howellsc73be612020-01-14 17:07:11 +00001736 struct pipe_inode_info *ipipe = get_pipe_info(in, true);
1737 struct pipe_inode_info *opipe = get_pipe_info(out, true);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001738 int ret = -EINVAL;
Jens Axboe70524492006-04-11 15:51:17 +02001739
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001740 if (unlikely(!(in->f_mode & FMODE_READ) ||
1741 !(out->f_mode & FMODE_WRITE)))
1742 return -EBADF;
1743
Jens Axboe70524492006-04-11 15:51:17 +02001744 /*
Jens Axboeaadd06e2006-07-10 11:00:01 +02001745 * Duplicate the contents of ipipe to opipe without actually
1746 * copying the data.
Jens Axboe70524492006-04-11 15:51:17 +02001747 */
Jens Axboeaadd06e2006-07-10 11:00:01 +02001748 if (ipipe && opipe && ipipe != opipe) {
Slavomir Kaslevee5e0012019-02-07 17:45:19 +02001749 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1750 flags |= SPLICE_F_NONBLOCK;
1751
Jens Axboeaadd06e2006-07-10 11:00:01 +02001752 /*
1753 * Keep going, unless we encounter an error. The ipipe/opipe
1754 * ordering doesn't really matter.
1755 */
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001756 ret = ipipe_prep(ipipe, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001757 if (!ret) {
Miklos Szeredi7c77f0b2009-05-07 15:37:35 +02001758 ret = opipe_prep(opipe, flags);
Jens Axboe02cf01a2008-02-20 10:34:51 +01001759 if (!ret)
Jens Axboeaadd06e2006-07-10 11:00:01 +02001760 ret = link_pipe(ipipe, opipe, len, flags);
Jens Axboeaadd06e2006-07-10 11:00:01 +02001761 }
1762 }
Jens Axboe70524492006-04-11 15:51:17 +02001763
Jens Axboeaadd06e2006-07-10 11:00:01 +02001764 return ret;
Jens Axboe70524492006-04-11 15:51:17 +02001765}
1766
Heiko Carstens836f92a2009-01-14 14:14:33 +01001767SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
Jens Axboe70524492006-04-11 15:51:17 +02001768{
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001769 struct fd in, out;
Al Viro2903ff02012-08-28 12:52:22 -04001770 int error;
Jens Axboe70524492006-04-11 15:51:17 +02001771
Al Viro3d6ea292016-12-10 13:17:32 -05001772 if (unlikely(flags & ~SPLICE_F_ALL))
1773 return -EINVAL;
1774
Jens Axboe70524492006-04-11 15:51:17 +02001775 if (unlikely(!len))
1776 return 0;
1777
1778 error = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -04001779 in = fdget(fdin);
1780 if (in.file) {
Pavel Begunkov90da2e32020-05-04 22:39:35 +03001781 out = fdget(fdout);
1782 if (out.file) {
1783 error = do_tee(in.file, out.file, len, flags);
1784 fdput(out);
Jens Axboe70524492006-04-11 15:51:17 +02001785 }
Al Viro2903ff02012-08-28 12:52:22 -04001786 fdput(in);
Jens Axboe70524492006-04-11 15:51:17 +02001787 }
1788
1789 return error;
1790}