Thomas Gleixner | 457c899 | 2019-05-19 13:08:55 +0100 | [diff] [blame] | 1 | // SPDX-License-Identifier: GPL-2.0-only |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 2 | /* |
| 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 Axboe | c2058e0 | 2006-04-11 13:56:34 +0200 | [diff] [blame] | 13 | * Jens to support splicing to files, network, direct splicing, etc and |
| 14 | * fixing lots of bugs. |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 15 | * |
Jens Axboe | 0fe2347 | 2006-09-04 15:41:16 +0200 | [diff] [blame] | 16 | * Copyright (C) 2005-2006 Jens Axboe <axboe@kernel.dk> |
Jens Axboe | c2058e0 | 2006-04-11 13:56:34 +0200 | [diff] [blame] | 17 | * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org> |
| 18 | * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu> |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 19 | * |
| 20 | */ |
Christoph Hellwig | be29796 | 2016-11-01 07:40:16 -0600 | [diff] [blame] | 21 | #include <linux/bvec.h> |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 22 | #include <linux/fs.h> |
| 23 | #include <linux/file.h> |
| 24 | #include <linux/pagemap.h> |
Jens Axboe | d6b29d7 | 2007-06-04 09:59:47 +0200 | [diff] [blame] | 25 | #include <linux/splice.h> |
KAMEZAWA Hiroyuki | 08e552c | 2009-01-07 18:08:01 -0800 | [diff] [blame] | 26 | #include <linux/memcontrol.h> |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 27 | #include <linux/mm_inline.h> |
Jens Axboe | 5abc97a | 2006-03-30 15:16:46 +0200 | [diff] [blame] | 28 | #include <linux/swap.h> |
Jens Axboe | 4f6f0bd | 2006-04-02 23:04:46 +0200 | [diff] [blame] | 29 | #include <linux/writeback.h> |
Paul Gortmaker | 630d9c4 | 2011-11-16 23:57:37 -0500 | [diff] [blame] | 30 | #include <linux/export.h> |
Jens Axboe | 4f6f0bd | 2006-04-02 23:04:46 +0200 | [diff] [blame] | 31 | #include <linux/syscalls.h> |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 32 | #include <linux/uio.h> |
Chung-Chiang Cheng | 983652c | 2023-03-22 14:25:19 +0800 | [diff] [blame] | 33 | #include <linux/fsnotify.h> |
James Morris | 29ce205 | 2007-07-13 11:44:32 +0200 | [diff] [blame] | 34 | #include <linux/security.h> |
Tejun Heo | 5a0e3ad | 2010-03-24 17:04:11 +0900 | [diff] [blame] | 35 | #include <linux/gfp.h> |
David Howells | 2dc334f | 2023-06-07 19:19:09 +0100 | [diff] [blame] | 36 | #include <linux/net.h> |
Eric Dumazet | 35f9c09 | 2012-04-05 03:05:35 +0000 | [diff] [blame] | 37 | #include <linux/socket.h> |
Ingo Molnar | 174cd4b | 2017-02-02 19:15:33 +0100 | [diff] [blame] | 38 | #include <linux/sched/signal.h> |
| 39 | |
Al Viro | 06ae43f3 | 2013-03-20 13:19:30 -0400 | [diff] [blame] | 40 | #include "internal.h" |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 41 | |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 42 | /* |
Jens Axboe | 0f99fc5 | 2023-04-24 16:32:55 -0600 | [diff] [blame] | 43 | * Splice doesn't support FMODE_NOWAIT. Since pipes may set this flag to |
| 44 | * indicate they support non-blocking reads or writes, we must clear it |
| 45 | * here if set to avoid blocking other users of this pipe if splice is |
| 46 | * being done on it. |
| 47 | */ |
| 48 | static noinline void noinline pipe_clear_nowait(struct file *file) |
| 49 | { |
| 50 | fmode_t fmode = READ_ONCE(file->f_mode); |
| 51 | |
| 52 | do { |
| 53 | if (!(fmode & FMODE_NOWAIT)) |
| 54 | break; |
| 55 | } while (!try_cmpxchg(&file->f_mode, &fmode, fmode & ~FMODE_NOWAIT)); |
| 56 | } |
| 57 | |
| 58 | /* |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 59 | * Attempt to steal a page from a pipe buffer. This should perhaps go into |
| 60 | * a vm helper function, it's already simplified quite a bit by the |
| 61 | * addition of remove_mapping(). If success is returned, the caller may |
| 62 | * attempt to reuse this page for another destination. |
| 63 | */ |
Christoph Hellwig | c928f64 | 2020-05-20 17:58:16 +0200 | [diff] [blame] | 64 | static bool page_cache_pipe_buf_try_steal(struct pipe_inode_info *pipe, |
| 65 | struct pipe_buffer *buf) |
Jens Axboe | 5abc97a | 2006-03-30 15:16:46 +0200 | [diff] [blame] | 66 | { |
Matthew Wilcox (Oracle) | 5100da3 | 2022-02-12 22:48:55 -0500 | [diff] [blame] | 67 | struct folio *folio = page_folio(buf->page); |
Jens Axboe | 9e94cd4 | 2006-06-20 15:01:12 +0200 | [diff] [blame] | 68 | struct address_space *mapping; |
Jens Axboe | 5abc97a | 2006-03-30 15:16:46 +0200 | [diff] [blame] | 69 | |
Matthew Wilcox (Oracle) | b9ccad2 | 2022-02-11 23:39:03 -0500 | [diff] [blame] | 70 | folio_lock(folio); |
Jens Axboe | 9e0267c | 2006-04-19 15:57:31 +0200 | [diff] [blame] | 71 | |
Matthew Wilcox (Oracle) | b9ccad2 | 2022-02-11 23:39:03 -0500 | [diff] [blame] | 72 | mapping = folio_mapping(folio); |
Jens Axboe | 9e94cd4 | 2006-06-20 15:01:12 +0200 | [diff] [blame] | 73 | if (mapping) { |
Matthew Wilcox (Oracle) | b9ccad2 | 2022-02-11 23:39:03 -0500 | [diff] [blame] | 74 | WARN_ON(!folio_test_uptodate(folio)); |
Jens Axboe | 5abc97a | 2006-03-30 15:16:46 +0200 | [diff] [blame] | 75 | |
Jens Axboe | 9e94cd4 | 2006-06-20 15:01:12 +0200 | [diff] [blame] | 76 | /* |
| 77 | * At least for ext2 with nobh option, we need to wait on |
Matthew Wilcox (Oracle) | b9ccad2 | 2022-02-11 23:39:03 -0500 | [diff] [blame] | 78 | * writeback completing on this folio, since we'll remove it |
Jens Axboe | 9e94cd4 | 2006-06-20 15:01:12 +0200 | [diff] [blame] | 79 | * from the pagecache. Otherwise truncate wont wait on the |
Matthew Wilcox (Oracle) | b9ccad2 | 2022-02-11 23:39:03 -0500 | [diff] [blame] | 80 | * folio, allowing the disk blocks to be reused by someone else |
Jens Axboe | 9e94cd4 | 2006-06-20 15:01:12 +0200 | [diff] [blame] | 81 | * before we actually wrote our data to them. fs corruption |
| 82 | * ensues. |
| 83 | */ |
Matthew Wilcox (Oracle) | b9ccad2 | 2022-02-11 23:39:03 -0500 | [diff] [blame] | 84 | folio_wait_writeback(folio); |
Jens Axboe | ad8d6f0 | 2006-04-02 23:10:32 +0200 | [diff] [blame] | 85 | |
David Howells | 0201ebf | 2023-06-28 11:48:51 +0100 | [diff] [blame] | 86 | if (!filemap_release_folio(folio, GFP_KERNEL)) |
Jens Axboe | ca39d65 | 2008-05-20 21:27:41 +0200 | [diff] [blame] | 87 | goto out_unlock; |
Jens Axboe | 4f6f0bd | 2006-04-02 23:04:46 +0200 | [diff] [blame] | 88 | |
Jens Axboe | 9e94cd4 | 2006-06-20 15:01:12 +0200 | [diff] [blame] | 89 | /* |
| 90 | * If we succeeded in removing the mapping, set LRU flag |
| 91 | * and return good. |
| 92 | */ |
Matthew Wilcox (Oracle) | 5100da3 | 2022-02-12 22:48:55 -0500 | [diff] [blame] | 93 | if (remove_mapping(mapping, folio)) { |
Jens Axboe | 9e94cd4 | 2006-06-20 15:01:12 +0200 | [diff] [blame] | 94 | buf->flags |= PIPE_BUF_FLAG_LRU; |
Christoph Hellwig | c928f64 | 2020-05-20 17:58:16 +0200 | [diff] [blame] | 95 | return true; |
Jens Axboe | 9e94cd4 | 2006-06-20 15:01:12 +0200 | [diff] [blame] | 96 | } |
Jens Axboe | 9e0267c | 2006-04-19 15:57:31 +0200 | [diff] [blame] | 97 | } |
Jens Axboe | 5abc97a | 2006-03-30 15:16:46 +0200 | [diff] [blame] | 98 | |
Jens Axboe | 9e94cd4 | 2006-06-20 15:01:12 +0200 | [diff] [blame] | 99 | /* |
Matthew Wilcox (Oracle) | b9ccad2 | 2022-02-11 23:39:03 -0500 | [diff] [blame] | 100 | * Raced with truncate or failed to remove folio from current |
Jens Axboe | 9e94cd4 | 2006-06-20 15:01:12 +0200 | [diff] [blame] | 101 | * address space, unlock and return failure. |
| 102 | */ |
Jens Axboe | ca39d65 | 2008-05-20 21:27:41 +0200 | [diff] [blame] | 103 | out_unlock: |
Matthew Wilcox (Oracle) | b9ccad2 | 2022-02-11 23:39:03 -0500 | [diff] [blame] | 104 | folio_unlock(folio); |
Christoph Hellwig | c928f64 | 2020-05-20 17:58:16 +0200 | [diff] [blame] | 105 | return false; |
Jens Axboe | 5abc97a | 2006-03-30 15:16:46 +0200 | [diff] [blame] | 106 | } |
| 107 | |
Jens Axboe | 76ad4d1 | 2006-05-03 10:41:33 +0200 | [diff] [blame] | 108 | static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe, |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 109 | struct pipe_buffer *buf) |
| 110 | { |
Kirill A. Shutemov | 09cbfea | 2016-04-01 15:29:47 +0300 | [diff] [blame] | 111 | put_page(buf->page); |
Jens Axboe | 1432873 | 2006-05-03 10:35:26 +0200 | [diff] [blame] | 112 | buf->flags &= ~PIPE_BUF_FLAG_LRU; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 113 | } |
| 114 | |
Jens Axboe | 0845718 | 2007-06-12 20:51:32 +0200 | [diff] [blame] | 115 | /* |
| 116 | * Check whether the contents of buf is OK to access. Since the content |
| 117 | * is a page cache page, IO may be in flight. |
| 118 | */ |
Jens Axboe | cac36bb0 | 2007-06-14 13:10:48 +0200 | [diff] [blame] | 119 | static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe, |
| 120 | struct pipe_buffer *buf) |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 121 | { |
Matthew Wilcox (Oracle) | 781ca60 | 2023-08-21 15:15:41 +0100 | [diff] [blame] | 122 | struct folio *folio = page_folio(buf->page); |
Jens Axboe | 49d0b21 | 2006-04-10 09:04:41 +0200 | [diff] [blame] | 123 | int err; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 124 | |
Matthew Wilcox (Oracle) | 781ca60 | 2023-08-21 15:15:41 +0100 | [diff] [blame] | 125 | if (!folio_test_uptodate(folio)) { |
| 126 | folio_lock(folio); |
Jens Axboe | 49d0b21 | 2006-04-10 09:04:41 +0200 | [diff] [blame] | 127 | |
| 128 | /* |
Matthew Wilcox (Oracle) | 781ca60 | 2023-08-21 15:15:41 +0100 | [diff] [blame] | 129 | * Folio got truncated/unhashed. This will cause a 0-byte |
Ingo Molnar | 73d62d8 | 2006-04-11 13:57:21 +0200 | [diff] [blame] | 130 | * splice, if this is the first page. |
Jens Axboe | 49d0b21 | 2006-04-10 09:04:41 +0200 | [diff] [blame] | 131 | */ |
Matthew Wilcox (Oracle) | 781ca60 | 2023-08-21 15:15:41 +0100 | [diff] [blame] | 132 | if (!folio->mapping) { |
Jens Axboe | 49d0b21 | 2006-04-10 09:04:41 +0200 | [diff] [blame] | 133 | err = -ENODATA; |
| 134 | goto error; |
| 135 | } |
| 136 | |
| 137 | /* |
Ingo Molnar | 73d62d8 | 2006-04-11 13:57:21 +0200 | [diff] [blame] | 138 | * Uh oh, read-error from disk. |
Jens Axboe | 49d0b21 | 2006-04-10 09:04:41 +0200 | [diff] [blame] | 139 | */ |
Matthew Wilcox (Oracle) | 781ca60 | 2023-08-21 15:15:41 +0100 | [diff] [blame] | 140 | if (!folio_test_uptodate(folio)) { |
Jens Axboe | 49d0b21 | 2006-04-10 09:04:41 +0200 | [diff] [blame] | 141 | err = -EIO; |
| 142 | goto error; |
| 143 | } |
| 144 | |
Matthew Wilcox (Oracle) | 781ca60 | 2023-08-21 15:15:41 +0100 | [diff] [blame] | 145 | /* Folio is ok after all, we are done */ |
| 146 | folio_unlock(folio); |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 147 | } |
| 148 | |
Jens Axboe | f84d751 | 2006-05-01 19:59:03 +0200 | [diff] [blame] | 149 | return 0; |
Jens Axboe | 49d0b21 | 2006-04-10 09:04:41 +0200 | [diff] [blame] | 150 | error: |
Matthew Wilcox (Oracle) | 781ca60 | 2023-08-21 15:15:41 +0100 | [diff] [blame] | 151 | folio_unlock(folio); |
Jens Axboe | f84d751 | 2006-05-01 19:59:03 +0200 | [diff] [blame] | 152 | return err; |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 153 | } |
| 154 | |
Hugh Dickins | 708e350 | 2011-07-25 17:12:32 -0700 | [diff] [blame] | 155 | const struct pipe_buf_operations page_cache_pipe_buf_ops = { |
Christoph Hellwig | c928f64 | 2020-05-20 17:58:16 +0200 | [diff] [blame] | 156 | .confirm = page_cache_pipe_buf_confirm, |
| 157 | .release = page_cache_pipe_buf_release, |
| 158 | .try_steal = page_cache_pipe_buf_try_steal, |
| 159 | .get = generic_pipe_buf_get, |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 160 | }; |
| 161 | |
Christoph Hellwig | c928f64 | 2020-05-20 17:58:16 +0200 | [diff] [blame] | 162 | static bool user_page_pipe_buf_try_steal(struct pipe_inode_info *pipe, |
| 163 | struct pipe_buffer *buf) |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 164 | { |
Jens Axboe | 7afa6fd | 2006-05-01 20:02:33 +0200 | [diff] [blame] | 165 | if (!(buf->flags & PIPE_BUF_FLAG_GIFT)) |
Christoph Hellwig | c928f64 | 2020-05-20 17:58:16 +0200 | [diff] [blame] | 166 | return false; |
Jens Axboe | 7afa6fd | 2006-05-01 20:02:33 +0200 | [diff] [blame] | 167 | |
Jens Axboe | 1432873 | 2006-05-03 10:35:26 +0200 | [diff] [blame] | 168 | buf->flags |= PIPE_BUF_FLAG_LRU; |
Christoph Hellwig | c928f64 | 2020-05-20 17:58:16 +0200 | [diff] [blame] | 169 | return generic_pipe_buf_try_steal(pipe, buf); |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 170 | } |
| 171 | |
Eric Dumazet | d4c3cca | 2006-12-13 00:34:04 -0800 | [diff] [blame] | 172 | static const struct pipe_buf_operations user_page_pipe_buf_ops = { |
Christoph Hellwig | c928f64 | 2020-05-20 17:58:16 +0200 | [diff] [blame] | 173 | .release = page_cache_pipe_buf_release, |
| 174 | .try_steal = user_page_pipe_buf_try_steal, |
| 175 | .get = generic_pipe_buf_get, |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 176 | }; |
| 177 | |
Namhyung Kim | 825cdcb | 2011-05-23 19:58:53 +0200 | [diff] [blame] | 178 | static void wakeup_pipe_readers(struct pipe_inode_info *pipe) |
| 179 | { |
| 180 | smp_mb(); |
Linus Torvalds | 0ddad21 | 2019-12-09 09:48:27 -0800 | [diff] [blame] | 181 | if (waitqueue_active(&pipe->rd_wait)) |
| 182 | wake_up_interruptible(&pipe->rd_wait); |
Namhyung Kim | 825cdcb | 2011-05-23 19:58:53 +0200 | [diff] [blame] | 183 | kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN); |
| 184 | } |
| 185 | |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 186 | /** |
| 187 | * splice_to_pipe - fill passed data into a pipe |
| 188 | * @pipe: pipe to fill |
| 189 | * @spd: data to fill |
| 190 | * |
| 191 | * Description: |
Randy Dunlap | 79685b8 | 2007-07-27 08:08:51 +0200 | [diff] [blame] | 192 | * @spd contains a map of pages and len/offset tuples, along with |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 193 | * the struct pipe_buf_operations associated with these pages. This |
| 194 | * function will link that data to the pipe. |
| 195 | * |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 196 | */ |
Jens Axboe | d6b29d7 | 2007-06-04 09:59:47 +0200 | [diff] [blame] | 197 | ssize_t splice_to_pipe(struct pipe_inode_info *pipe, |
| 198 | struct splice_pipe_desc *spd) |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 199 | { |
Jens Axboe | 00de00b | 2007-06-15 13:14:22 +0200 | [diff] [blame] | 200 | unsigned int spd_pages = spd->nr_pages; |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 201 | unsigned int tail = pipe->tail; |
| 202 | unsigned int head = pipe->head; |
| 203 | unsigned int mask = pipe->ring_size - 1; |
Al Viro | 8924fef | 2016-09-17 20:44:45 -0400 | [diff] [blame] | 204 | int ret = 0, page_nr = 0; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 205 | |
Rabin Vincent | d6785d9 | 2016-03-10 21:19:06 +0100 | [diff] [blame] | 206 | if (!spd_pages) |
| 207 | return 0; |
| 208 | |
Al Viro | 8924fef | 2016-09-17 20:44:45 -0400 | [diff] [blame] | 209 | if (unlikely(!pipe->readers)) { |
| 210 | send_sig(SIGPIPE, current, 0); |
| 211 | ret = -EPIPE; |
| 212 | goto out; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 213 | } |
| 214 | |
David Howells | 6718b6f | 2019-10-16 16:47:32 +0100 | [diff] [blame] | 215 | while (!pipe_full(head, tail, pipe->max_usage)) { |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 216 | struct pipe_buffer *buf = &pipe->bufs[head & mask]; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 217 | |
Al Viro | 8924fef | 2016-09-17 20:44:45 -0400 | [diff] [blame] | 218 | buf->page = spd->pages[page_nr]; |
| 219 | buf->offset = spd->partial[page_nr].offset; |
| 220 | buf->len = spd->partial[page_nr].len; |
| 221 | buf->private = spd->partial[page_nr].private; |
| 222 | buf->ops = spd->ops; |
Miklos Szeredi | 5a81e6a | 2017-02-16 17:49:02 +0100 | [diff] [blame] | 223 | buf->flags = 0; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 224 | |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 225 | head++; |
| 226 | pipe->head = head; |
Al Viro | 8924fef | 2016-09-17 20:44:45 -0400 | [diff] [blame] | 227 | page_nr++; |
| 228 | ret += buf->len; |
| 229 | |
| 230 | if (!--spd->nr_pages) |
| 231 | break; |
| 232 | } |
| 233 | |
| 234 | if (!ret) |
| 235 | ret = -EAGAIN; |
| 236 | |
| 237 | out: |
Jens Axboe | 00de00b | 2007-06-15 13:14:22 +0200 | [diff] [blame] | 238 | while (page_nr < spd_pages) |
Jens Axboe | bbdfc2f | 2007-11-06 23:29:47 -0800 | [diff] [blame] | 239 | spd->spd_release(spd, page_nr++); |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 240 | |
| 241 | return ret; |
| 242 | } |
Hannes Frederic Sowa | 2b51457 | 2015-05-21 17:00:01 +0200 | [diff] [blame] | 243 | EXPORT_SYMBOL_GPL(splice_to_pipe); |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 244 | |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 245 | ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf) |
| 246 | { |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 247 | unsigned int head = pipe->head; |
| 248 | unsigned int tail = pipe->tail; |
| 249 | unsigned int mask = pipe->ring_size - 1; |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 250 | int ret; |
| 251 | |
| 252 | if (unlikely(!pipe->readers)) { |
| 253 | send_sig(SIGPIPE, current, 0); |
| 254 | ret = -EPIPE; |
David Howells | 6718b6f | 2019-10-16 16:47:32 +0100 | [diff] [blame] | 255 | } else if (pipe_full(head, tail, pipe->max_usage)) { |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 256 | ret = -EAGAIN; |
| 257 | } else { |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 258 | pipe->bufs[head & mask] = *buf; |
| 259 | pipe->head = head + 1; |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 260 | return buf->len; |
| 261 | } |
Miklos Szeredi | a779638 | 2016-09-27 10:45:12 +0200 | [diff] [blame] | 262 | pipe_buf_release(pipe, buf); |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 263 | return ret; |
| 264 | } |
| 265 | EXPORT_SYMBOL(add_to_pipe); |
| 266 | |
Jens Axboe | 35f3d14 | 2010-05-20 10:43:18 +0200 | [diff] [blame] | 267 | /* |
| 268 | * Check if we need to grow the arrays holding pages and partial page |
| 269 | * descriptions. |
| 270 | */ |
Eric Dumazet | 047fe36 | 2012-06-12 15:24:40 +0200 | [diff] [blame] | 271 | int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd) |
Jens Axboe | 35f3d14 | 2010-05-20 10:43:18 +0200 | [diff] [blame] | 272 | { |
David Howells | 6718b6f | 2019-10-16 16:47:32 +0100 | [diff] [blame] | 273 | unsigned int max_usage = READ_ONCE(pipe->max_usage); |
Eric Dumazet | 047fe36 | 2012-06-12 15:24:40 +0200 | [diff] [blame] | 274 | |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 275 | spd->nr_pages_max = max_usage; |
| 276 | if (max_usage <= PIPE_DEF_BUFFERS) |
Jens Axboe | 35f3d14 | 2010-05-20 10:43:18 +0200 | [diff] [blame] | 277 | return 0; |
| 278 | |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 279 | spd->pages = kmalloc_array(max_usage, sizeof(struct page *), GFP_KERNEL); |
| 280 | spd->partial = kmalloc_array(max_usage, sizeof(struct partial_page), |
Kees Cook | 6da2ec5 | 2018-06-12 13:55:00 -0700 | [diff] [blame] | 281 | GFP_KERNEL); |
Jens Axboe | 35f3d14 | 2010-05-20 10:43:18 +0200 | [diff] [blame] | 282 | |
| 283 | if (spd->pages && spd->partial) |
| 284 | return 0; |
| 285 | |
| 286 | kfree(spd->pages); |
| 287 | kfree(spd->partial); |
| 288 | return -ENOMEM; |
| 289 | } |
| 290 | |
Eric Dumazet | 047fe36 | 2012-06-12 15:24:40 +0200 | [diff] [blame] | 291 | void splice_shrink_spd(struct splice_pipe_desc *spd) |
Jens Axboe | 35f3d14 | 2010-05-20 10:43:18 +0200 | [diff] [blame] | 292 | { |
Eric Dumazet | 047fe36 | 2012-06-12 15:24:40 +0200 | [diff] [blame] | 293 | if (spd->nr_pages_max <= PIPE_DEF_BUFFERS) |
Jens Axboe | 35f3d14 | 2010-05-20 10:43:18 +0200 | [diff] [blame] | 294 | return; |
| 295 | |
| 296 | kfree(spd->pages); |
| 297 | kfree(spd->partial); |
| 298 | } |
| 299 | |
David Howells | 9eee8bd | 2023-05-22 14:50:18 +0100 | [diff] [blame] | 300 | /** |
| 301 | * copy_splice_read - Copy data from a file and splice the copy into a pipe |
| 302 | * @in: The file to read from |
| 303 | * @ppos: Pointer to the file position to read from |
| 304 | * @pipe: The pipe to splice into |
| 305 | * @len: The amount to splice |
| 306 | * @flags: The SPLICE_F_* flags |
| 307 | * |
| 308 | * This function allocates a bunch of pages sufficient to hold the requested |
| 309 | * amount of data (but limited by the remaining pipe capacity), passes it to |
| 310 | * the file's ->read_iter() to read into and then splices the used pages into |
| 311 | * the pipe. |
| 312 | * |
| 313 | * Return: On success, the number of bytes read will be returned and *@ppos |
| 314 | * will be updated if appropriate; 0 will be returned if there is no more data |
| 315 | * to be read; -EAGAIN will be returned if the pipe had no space, and some |
| 316 | * other negative error code will be returned on error. A short read may occur |
| 317 | * if the pipe has insufficient space, we reach the end of the data or we hit a |
| 318 | * hole. |
David Howells | 33b3b04 | 2023-02-07 10:45:40 +0000 | [diff] [blame] | 319 | */ |
David Howells | 69df79a | 2023-05-22 14:49:50 +0100 | [diff] [blame] | 320 | ssize_t copy_splice_read(struct file *in, loff_t *ppos, |
| 321 | struct pipe_inode_info *pipe, |
| 322 | size_t len, unsigned int flags) |
David Howells | 33b3b04 | 2023-02-07 10:45:40 +0000 | [diff] [blame] | 323 | { |
| 324 | struct iov_iter to; |
| 325 | struct bio_vec *bv; |
| 326 | struct kiocb kiocb; |
| 327 | struct page **pages; |
| 328 | ssize_t ret; |
David Howells | e69f37b | 2023-05-22 14:49:51 +0100 | [diff] [blame] | 329 | size_t used, npages, chunk, remain, keep = 0; |
David Howells | 33b3b04 | 2023-02-07 10:45:40 +0000 | [diff] [blame] | 330 | int i; |
| 331 | |
| 332 | /* Work out how much data we can actually add into the pipe */ |
| 333 | used = pipe_occupancy(pipe->head, pipe->tail); |
| 334 | npages = max_t(ssize_t, pipe->max_usage - used, 0); |
| 335 | len = min_t(size_t, len, npages * PAGE_SIZE); |
| 336 | npages = DIV_ROUND_UP(len, PAGE_SIZE); |
| 337 | |
| 338 | bv = kzalloc(array_size(npages, sizeof(bv[0])) + |
| 339 | array_size(npages, sizeof(struct page *)), GFP_KERNEL); |
| 340 | if (!bv) |
| 341 | return -ENOMEM; |
| 342 | |
David Howells | e69f37b | 2023-05-22 14:49:51 +0100 | [diff] [blame] | 343 | pages = (struct page **)(bv + npages); |
David Howells | 33b3b04 | 2023-02-07 10:45:40 +0000 | [diff] [blame] | 344 | npages = alloc_pages_bulk_array(GFP_USER, npages, pages); |
| 345 | if (!npages) { |
| 346 | kfree(bv); |
| 347 | return -ENOMEM; |
| 348 | } |
| 349 | |
| 350 | remain = len = min_t(size_t, len, npages * PAGE_SIZE); |
| 351 | |
| 352 | for (i = 0; i < npages; i++) { |
| 353 | chunk = min_t(size_t, PAGE_SIZE, remain); |
| 354 | bv[i].bv_page = pages[i]; |
| 355 | bv[i].bv_offset = 0; |
| 356 | bv[i].bv_len = chunk; |
| 357 | remain -= chunk; |
| 358 | } |
| 359 | |
| 360 | /* Do the I/O */ |
| 361 | iov_iter_bvec(&to, ITER_DEST, bv, npages, len); |
| 362 | init_sync_kiocb(&kiocb, in); |
| 363 | kiocb.ki_pos = *ppos; |
| 364 | ret = call_read_iter(in, &kiocb, &to); |
| 365 | |
David Howells | 33b3b04 | 2023-02-07 10:45:40 +0000 | [diff] [blame] | 366 | if (ret > 0) { |
David Howells | e69f37b | 2023-05-22 14:49:51 +0100 | [diff] [blame] | 367 | keep = DIV_ROUND_UP(ret, PAGE_SIZE); |
David Howells | 33b3b04 | 2023-02-07 10:45:40 +0000 | [diff] [blame] | 368 | *ppos = kiocb.ki_pos; |
David Howells | 33b3b04 | 2023-02-07 10:45:40 +0000 | [diff] [blame] | 369 | } |
| 370 | |
Christoph Hellwig | 2e82f6c | 2023-06-14 16:03:39 +0200 | [diff] [blame] | 371 | /* |
| 372 | * Callers of ->splice_read() expect -EAGAIN on "can't put anything in |
| 373 | * there", rather than -EFAULT. |
| 374 | */ |
| 375 | if (ret == -EFAULT) |
| 376 | ret = -EAGAIN; |
| 377 | |
David Howells | 33b3b04 | 2023-02-07 10:45:40 +0000 | [diff] [blame] | 378 | /* Free any pages that didn't get touched at all. */ |
David Howells | e69f37b | 2023-05-22 14:49:51 +0100 | [diff] [blame] | 379 | if (keep < npages) |
| 380 | release_pages(pages + keep, npages - keep); |
David Howells | 33b3b04 | 2023-02-07 10:45:40 +0000 | [diff] [blame] | 381 | |
| 382 | /* Push the remaining pages into the pipe. */ |
David Howells | e69f37b | 2023-05-22 14:49:51 +0100 | [diff] [blame] | 383 | remain = ret; |
| 384 | for (i = 0; i < keep; i++) { |
David Howells | 33b3b04 | 2023-02-07 10:45:40 +0000 | [diff] [blame] | 385 | struct pipe_buffer *buf = pipe_head_buf(pipe); |
| 386 | |
| 387 | chunk = min_t(size_t, remain, PAGE_SIZE); |
| 388 | *buf = (struct pipe_buffer) { |
| 389 | .ops = &default_pipe_buf_ops, |
| 390 | .page = bv[i].bv_page, |
| 391 | .offset = 0, |
| 392 | .len = chunk, |
| 393 | }; |
| 394 | pipe->head++; |
| 395 | remain -= chunk; |
| 396 | } |
| 397 | |
| 398 | kfree(bv); |
| 399 | return ret; |
| 400 | } |
David Howells | 69df79a | 2023-05-22 14:49:50 +0100 | [diff] [blame] | 401 | EXPORT_SYMBOL(copy_splice_read); |
David Howells | 33b3b04 | 2023-02-07 10:45:40 +0000 | [diff] [blame] | 402 | |
Al Viro | 241699c | 2016-09-22 16:33:12 -0400 | [diff] [blame] | 403 | const struct pipe_buf_operations default_pipe_buf_ops = { |
Christoph Hellwig | c928f64 | 2020-05-20 17:58:16 +0200 | [diff] [blame] | 404 | .release = generic_pipe_buf_release, |
| 405 | .try_steal = generic_pipe_buf_try_steal, |
| 406 | .get = generic_pipe_buf_get, |
Miklos Szeredi | 6818173 | 2009-05-07 15:37:36 +0200 | [diff] [blame] | 407 | }; |
| 408 | |
Miklos Szeredi | 28a625c | 2014-01-22 19:36:57 +0100 | [diff] [blame] | 409 | /* Pipe buffer operations for a socket and similar. */ |
| 410 | const struct pipe_buf_operations nosteal_pipe_buf_ops = { |
Christoph Hellwig | c928f64 | 2020-05-20 17:58:16 +0200 | [diff] [blame] | 411 | .release = generic_pipe_buf_release, |
| 412 | .get = generic_pipe_buf_get, |
Miklos Szeredi | 28a625c | 2014-01-22 19:36:57 +0100 | [diff] [blame] | 413 | }; |
| 414 | EXPORT_SYMBOL(nosteal_pipe_buf_ops); |
| 415 | |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 416 | static void wakeup_pipe_writers(struct pipe_inode_info *pipe) |
| 417 | { |
| 418 | smp_mb(); |
Linus Torvalds | 0ddad21 | 2019-12-09 09:48:27 -0800 | [diff] [blame] | 419 | if (waitqueue_active(&pipe->wr_wait)) |
| 420 | wake_up_interruptible(&pipe->wr_wait); |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 421 | kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT); |
| 422 | } |
| 423 | |
| 424 | /** |
| 425 | * splice_from_pipe_feed - feed available data from a pipe to a file |
| 426 | * @pipe: pipe to splice from |
| 427 | * @sd: information to @actor |
| 428 | * @actor: handler that splices the data |
| 429 | * |
| 430 | * Description: |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 431 | * This function loops over the pipe and calls @actor to do the |
| 432 | * actual moving of a single struct pipe_buffer to the desired |
| 433 | * destination. It returns when there's no more buffers left in |
| 434 | * the pipe or if the requested number of bytes (@sd->total_len) |
| 435 | * have been copied. It returns a positive number (one) if the |
| 436 | * pipe needs to be filled with more data, zero if the required |
| 437 | * number of bytes have been copied and -errno on error. |
| 438 | * |
| 439 | * This, together with splice_from_pipe_{begin,end,next}, may be |
| 440 | * used to implement the functionality of __splice_from_pipe() when |
| 441 | * locking is required around copying the pipe buffers to the |
| 442 | * destination. |
| 443 | */ |
Al Viro | 96f9bc8 | 2014-04-05 04:35:49 -0400 | [diff] [blame] | 444 | static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd, |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 445 | splice_actor *actor) |
| 446 | { |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 447 | unsigned int head = pipe->head; |
| 448 | unsigned int tail = pipe->tail; |
| 449 | unsigned int mask = pipe->ring_size - 1; |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 450 | int ret; |
| 451 | |
Linus Torvalds | ec05759 | 2019-12-06 12:40:35 -0800 | [diff] [blame] | 452 | while (!pipe_empty(head, tail)) { |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 453 | struct pipe_buffer *buf = &pipe->bufs[tail & mask]; |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 454 | |
| 455 | sd->len = buf->len; |
| 456 | if (sd->len > sd->total_len) |
| 457 | sd->len = sd->total_len; |
| 458 | |
Miklos Szeredi | fba597d | 2016-09-27 10:45:12 +0200 | [diff] [blame] | 459 | ret = pipe_buf_confirm(pipe, buf); |
MichaĆ MirosĆaw | a8adbe3 | 2010-12-17 08:56:44 +0100 | [diff] [blame] | 460 | if (unlikely(ret)) { |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 461 | if (ret == -ENODATA) |
| 462 | ret = 0; |
| 463 | return ret; |
| 464 | } |
MichaĆ MirosĆaw | a8adbe3 | 2010-12-17 08:56:44 +0100 | [diff] [blame] | 465 | |
| 466 | ret = actor(pipe, buf, sd); |
| 467 | if (ret <= 0) |
| 468 | return ret; |
| 469 | |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 470 | buf->offset += ret; |
| 471 | buf->len -= ret; |
| 472 | |
| 473 | sd->num_spliced += ret; |
| 474 | sd->len -= ret; |
| 475 | sd->pos += ret; |
| 476 | sd->total_len -= ret; |
| 477 | |
| 478 | if (!buf->len) { |
Miklos Szeredi | a779638 | 2016-09-27 10:45:12 +0200 | [diff] [blame] | 479 | pipe_buf_release(pipe, buf); |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 480 | tail++; |
| 481 | pipe->tail = tail; |
Al Viro | 6447a3c | 2013-03-21 11:01:38 -0400 | [diff] [blame] | 482 | if (pipe->files) |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 483 | sd->need_wakeup = true; |
| 484 | } |
| 485 | |
| 486 | if (!sd->total_len) |
| 487 | return 0; |
| 488 | } |
| 489 | |
| 490 | return 1; |
| 491 | } |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 492 | |
Linus Torvalds | d1a819a | 2020-10-05 11:26:27 -0700 | [diff] [blame] | 493 | /* We know we have a pipe buffer, but maybe it's empty? */ |
| 494 | static inline bool eat_empty_buffer(struct pipe_inode_info *pipe) |
| 495 | { |
| 496 | unsigned int tail = pipe->tail; |
| 497 | unsigned int mask = pipe->ring_size - 1; |
| 498 | struct pipe_buffer *buf = &pipe->bufs[tail & mask]; |
| 499 | |
| 500 | if (unlikely(!buf->len)) { |
| 501 | pipe_buf_release(pipe, buf); |
| 502 | pipe->tail = tail+1; |
| 503 | return true; |
| 504 | } |
| 505 | |
| 506 | return false; |
| 507 | } |
| 508 | |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 509 | /** |
| 510 | * splice_from_pipe_next - wait for some data to splice from |
| 511 | * @pipe: pipe to splice from |
| 512 | * @sd: information about the splice operation |
| 513 | * |
| 514 | * Description: |
| 515 | * This function will wait for some data and return a positive |
| 516 | * value (one) if pipe buffers are available. It will return zero |
| 517 | * or -errno if no more data needs to be spliced. |
| 518 | */ |
Al Viro | 96f9bc8 | 2014-04-05 04:35:49 -0400 | [diff] [blame] | 519 | static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd) |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 520 | { |
Jan Kara | c725bfc | 2015-11-23 13:09:50 +0100 | [diff] [blame] | 521 | /* |
| 522 | * Check for signal early to make process killable when there are |
| 523 | * always buffers available |
| 524 | */ |
| 525 | if (signal_pending(current)) |
| 526 | return -ERESTARTSYS; |
| 527 | |
Linus Torvalds | d1a819a | 2020-10-05 11:26:27 -0700 | [diff] [blame] | 528 | repeat: |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 529 | while (pipe_empty(pipe->head, pipe->tail)) { |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 530 | if (!pipe->writers) |
| 531 | return 0; |
| 532 | |
Linus Torvalds | a28c8b9 | 2019-12-07 13:21:01 -0800 | [diff] [blame] | 533 | if (sd->num_spliced) |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 534 | return 0; |
| 535 | |
| 536 | if (sd->flags & SPLICE_F_NONBLOCK) |
| 537 | return -EAGAIN; |
| 538 | |
| 539 | if (signal_pending(current)) |
| 540 | return -ERESTARTSYS; |
| 541 | |
| 542 | if (sd->need_wakeup) { |
| 543 | wakeup_pipe_writers(pipe); |
| 544 | sd->need_wakeup = false; |
| 545 | } |
| 546 | |
Linus Torvalds | 472e5b0 | 2020-10-01 19:14:36 -0700 | [diff] [blame] | 547 | pipe_wait_readable(pipe); |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 548 | } |
| 549 | |
Linus Torvalds | d1a819a | 2020-10-05 11:26:27 -0700 | [diff] [blame] | 550 | if (eat_empty_buffer(pipe)) |
| 551 | goto repeat; |
| 552 | |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 553 | return 1; |
| 554 | } |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 555 | |
| 556 | /** |
| 557 | * splice_from_pipe_begin - start splicing from pipe |
Randy Dunlap | b80901b | 2009-04-16 19:09:55 -0700 | [diff] [blame] | 558 | * @sd: information about the splice operation |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 559 | * |
| 560 | * Description: |
| 561 | * This function should be called before a loop containing |
| 562 | * splice_from_pipe_next() and splice_from_pipe_feed() to |
| 563 | * initialize the necessary fields of @sd. |
| 564 | */ |
Al Viro | 96f9bc8 | 2014-04-05 04:35:49 -0400 | [diff] [blame] | 565 | static void splice_from_pipe_begin(struct splice_desc *sd) |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 566 | { |
| 567 | sd->num_spliced = 0; |
| 568 | sd->need_wakeup = false; |
| 569 | } |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 570 | |
| 571 | /** |
| 572 | * splice_from_pipe_end - finish splicing from pipe |
| 573 | * @pipe: pipe to splice from |
| 574 | * @sd: information about the splice operation |
| 575 | * |
| 576 | * Description: |
| 577 | * This function will wake up pipe writers if necessary. It should |
| 578 | * be called after a loop containing splice_from_pipe_next() and |
| 579 | * splice_from_pipe_feed(). |
| 580 | */ |
Al Viro | 96f9bc8 | 2014-04-05 04:35:49 -0400 | [diff] [blame] | 581 | static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd) |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 582 | { |
| 583 | if (sd->need_wakeup) |
| 584 | wakeup_pipe_writers(pipe); |
| 585 | } |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 586 | |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 587 | /** |
| 588 | * __splice_from_pipe - splice data from a pipe to given actor |
| 589 | * @pipe: pipe to splice from |
| 590 | * @sd: information to @actor |
| 591 | * @actor: handler that splices the data |
| 592 | * |
| 593 | * Description: |
| 594 | * This function does little more than loop over the pipe and call |
| 595 | * @actor to do the actual moving of a single struct pipe_buffer to |
David Howells | 2dc334f | 2023-06-07 19:19:09 +0100 | [diff] [blame] | 596 | * the desired destination. See pipe_to_file, pipe_to_sendmsg, or |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 597 | * pipe_to_user. |
| 598 | * |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 599 | */ |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 600 | ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd, |
| 601 | splice_actor *actor) |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 602 | { |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 603 | int ret; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 604 | |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 605 | splice_from_pipe_begin(sd); |
| 606 | do { |
Jan Kara | c2489e0 | 2015-11-23 13:09:51 +0100 | [diff] [blame] | 607 | cond_resched(); |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 608 | ret = splice_from_pipe_next(pipe, sd); |
| 609 | if (ret > 0) |
| 610 | ret = splice_from_pipe_feed(pipe, sd, actor); |
| 611 | } while (ret > 0); |
| 612 | splice_from_pipe_end(pipe, sd); |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 613 | |
Miklos Szeredi | b3c2d2d | 2009-04-14 19:48:36 +0200 | [diff] [blame] | 614 | return sd->num_spliced ? sd->num_spliced : ret; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 615 | } |
Mark Fasheh | 40bee44e | 2007-03-21 13:11:02 +0100 | [diff] [blame] | 616 | EXPORT_SYMBOL(__splice_from_pipe); |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 617 | |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 618 | /** |
| 619 | * splice_from_pipe - splice data from a pipe to a file |
| 620 | * @pipe: pipe to splice from |
| 621 | * @out: file to splice to |
| 622 | * @ppos: position in @out |
| 623 | * @len: how many bytes to splice |
| 624 | * @flags: splice modifier flags |
| 625 | * @actor: handler that splices the data |
| 626 | * |
| 627 | * Description: |
Miklos Szeredi | 2933970 | 2009-04-14 19:48:37 +0200 | [diff] [blame] | 628 | * See __splice_from_pipe. This function locks the pipe inode, |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 629 | * otherwise it's identical to __splice_from_pipe(). |
| 630 | * |
| 631 | */ |
Mark Fasheh | 6da6180 | 2006-10-17 18:43:07 +0200 | [diff] [blame] | 632 | ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out, |
| 633 | loff_t *ppos, size_t len, unsigned int flags, |
| 634 | splice_actor *actor) |
| 635 | { |
| 636 | ssize_t ret; |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 637 | struct splice_desc sd = { |
| 638 | .total_len = len, |
| 639 | .flags = flags, |
| 640 | .pos = *ppos, |
Jens Axboe | 6a14b90 | 2007-06-14 13:08:55 +0200 | [diff] [blame] | 641 | .u.file = out, |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 642 | }; |
Mark Fasheh | 6da6180 | 2006-10-17 18:43:07 +0200 | [diff] [blame] | 643 | |
Miklos Szeredi | 61e0d47 | 2009-04-14 19:48:41 +0200 | [diff] [blame] | 644 | pipe_lock(pipe); |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 645 | ret = __splice_from_pipe(pipe, &sd, actor); |
Miklos Szeredi | 61e0d47 | 2009-04-14 19:48:41 +0200 | [diff] [blame] | 646 | pipe_unlock(pipe); |
Mark Fasheh | 6da6180 | 2006-10-17 18:43:07 +0200 | [diff] [blame] | 647 | |
| 648 | return ret; |
| 649 | } |
| 650 | |
| 651 | /** |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 652 | * iter_file_splice_write - splice data from a pipe to a file |
| 653 | * @pipe: pipe info |
| 654 | * @out: file to write to |
| 655 | * @ppos: position in @out |
| 656 | * @len: number of bytes to splice |
| 657 | * @flags: splice modifier flags |
| 658 | * |
| 659 | * Description: |
| 660 | * Will either move or copy pages (determined by @flags options) from |
| 661 | * the given pipe inode to the given file. |
| 662 | * This one is ->write_iter-based. |
| 663 | * |
| 664 | */ |
| 665 | ssize_t |
| 666 | iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out, |
| 667 | loff_t *ppos, size_t len, unsigned int flags) |
| 668 | { |
| 669 | struct splice_desc sd = { |
| 670 | .total_len = len, |
| 671 | .flags = flags, |
| 672 | .pos = *ppos, |
| 673 | .u.file = out, |
| 674 | }; |
David Howells | 6718b6f | 2019-10-16 16:47:32 +0100 | [diff] [blame] | 675 | int nbufs = pipe->max_usage; |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 676 | struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec), |
| 677 | GFP_KERNEL); |
| 678 | ssize_t ret; |
| 679 | |
| 680 | if (unlikely(!array)) |
| 681 | return -ENOMEM; |
| 682 | |
| 683 | pipe_lock(pipe); |
| 684 | |
| 685 | splice_from_pipe_begin(&sd); |
| 686 | while (sd.total_len) { |
| 687 | struct iov_iter from; |
Linus Torvalds | ec05759 | 2019-12-06 12:40:35 -0800 | [diff] [blame] | 688 | unsigned int head, tail, mask; |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 689 | size_t left; |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 690 | int n; |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 691 | |
| 692 | ret = splice_from_pipe_next(pipe, &sd); |
| 693 | if (ret <= 0) |
| 694 | break; |
| 695 | |
David Howells | 6718b6f | 2019-10-16 16:47:32 +0100 | [diff] [blame] | 696 | if (unlikely(nbufs < pipe->max_usage)) { |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 697 | kfree(array); |
David Howells | 6718b6f | 2019-10-16 16:47:32 +0100 | [diff] [blame] | 698 | nbufs = pipe->max_usage; |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 699 | array = kcalloc(nbufs, sizeof(struct bio_vec), |
| 700 | GFP_KERNEL); |
| 701 | if (!array) { |
| 702 | ret = -ENOMEM; |
| 703 | break; |
| 704 | } |
| 705 | } |
| 706 | |
Linus Torvalds | ec05759 | 2019-12-06 12:40:35 -0800 | [diff] [blame] | 707 | head = pipe->head; |
| 708 | tail = pipe->tail; |
| 709 | mask = pipe->ring_size - 1; |
| 710 | |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 711 | /* build the vector */ |
| 712 | left = sd.total_len; |
Pavel Begunkov | 0f1d344 | 2021-01-09 16:02:57 +0000 | [diff] [blame] | 713 | for (n = 0; !pipe_empty(head, tail) && left && n < nbufs; tail++) { |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 714 | struct pipe_buffer *buf = &pipe->bufs[tail & mask]; |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 715 | size_t this_len = buf->len; |
| 716 | |
Pavel Begunkov | 0f1d344 | 2021-01-09 16:02:57 +0000 | [diff] [blame] | 717 | /* zero-length bvecs are not supported, skip them */ |
| 718 | if (!this_len) |
| 719 | continue; |
| 720 | this_len = min(this_len, left); |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 721 | |
Miklos Szeredi | fba597d | 2016-09-27 10:45:12 +0200 | [diff] [blame] | 722 | ret = pipe_buf_confirm(pipe, buf); |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 723 | if (unlikely(ret)) { |
| 724 | if (ret == -ENODATA) |
| 725 | ret = 0; |
| 726 | goto done; |
| 727 | } |
| 728 | |
Christoph Hellwig | 664e407 | 2023-02-03 16:06:28 +0100 | [diff] [blame] | 729 | bvec_set_page(&array[n], buf->page, this_len, |
| 730 | buf->offset); |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 731 | left -= this_len; |
Pavel Begunkov | 0f1d344 | 2021-01-09 16:02:57 +0000 | [diff] [blame] | 732 | n++; |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 733 | } |
| 734 | |
Al Viro | de4eda9 | 2022-09-15 20:25:47 -0400 | [diff] [blame] | 735 | iov_iter_bvec(&from, ITER_SOURCE, array, n, sd.total_len - left); |
Christoph Hellwig | abbb6589 | 2017-05-27 11:16:52 +0300 | [diff] [blame] | 736 | ret = vfs_iter_write(out, &from, &sd.pos, 0); |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 737 | if (ret <= 0) |
| 738 | break; |
| 739 | |
| 740 | sd.num_spliced += ret; |
| 741 | sd.total_len -= ret; |
Christoph Hellwig | dbe4e19 | 2015-01-25 21:11:59 +0100 | [diff] [blame] | 742 | *ppos = sd.pos; |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 743 | |
| 744 | /* dismiss the fully eaten buffers, adjust the partial one */ |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 745 | tail = pipe->tail; |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 746 | while (ret) { |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 747 | struct pipe_buffer *buf = &pipe->bufs[tail & mask]; |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 748 | if (ret >= buf->len) { |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 749 | ret -= buf->len; |
| 750 | buf->len = 0; |
Miklos Szeredi | a779638 | 2016-09-27 10:45:12 +0200 | [diff] [blame] | 751 | pipe_buf_release(pipe, buf); |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 752 | tail++; |
| 753 | pipe->tail = tail; |
Al Viro | 8d02076 | 2014-04-05 04:27:08 -0400 | [diff] [blame] | 754 | if (pipe->files) |
| 755 | sd.need_wakeup = true; |
| 756 | } else { |
| 757 | buf->offset += ret; |
| 758 | buf->len -= ret; |
| 759 | ret = 0; |
| 760 | } |
| 761 | } |
| 762 | } |
| 763 | done: |
| 764 | kfree(array); |
| 765 | splice_from_pipe_end(pipe, &sd); |
| 766 | |
| 767 | pipe_unlock(pipe); |
| 768 | |
| 769 | if (sd.num_spliced) |
| 770 | ret = sd.num_spliced; |
| 771 | |
| 772 | return ret; |
| 773 | } |
| 774 | |
| 775 | EXPORT_SYMBOL(iter_file_splice_write); |
| 776 | |
David Howells | 2dc334f | 2023-06-07 19:19:09 +0100 | [diff] [blame] | 777 | #ifdef CONFIG_NET |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 778 | /** |
David Howells | 2dc334f | 2023-06-07 19:19:09 +0100 | [diff] [blame] | 779 | * splice_to_socket - splice data from a pipe to a socket |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 780 | * @pipe: pipe to splice from |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 781 | * @out: socket to write to |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 782 | * @ppos: position in @out |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 783 | * @len: number of bytes to splice |
| 784 | * @flags: splice modifier flags |
| 785 | * |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 786 | * Description: |
| 787 | * Will send @len bytes from the pipe to a network socket. No data copying |
| 788 | * is involved. |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 789 | * |
| 790 | */ |
David Howells | 2dc334f | 2023-06-07 19:19:09 +0100 | [diff] [blame] | 791 | ssize_t splice_to_socket(struct pipe_inode_info *pipe, struct file *out, |
| 792 | loff_t *ppos, size_t len, unsigned int flags) |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 793 | { |
David Howells | 2dc334f | 2023-06-07 19:19:09 +0100 | [diff] [blame] | 794 | struct socket *sock = sock_from_file(out); |
| 795 | struct bio_vec bvec[16]; |
| 796 | struct msghdr msg = {}; |
| 797 | ssize_t ret = 0; |
| 798 | size_t spliced = 0; |
| 799 | bool need_wakeup = false; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 800 | |
David Howells | 2dc334f | 2023-06-07 19:19:09 +0100 | [diff] [blame] | 801 | pipe_lock(pipe); |
| 802 | |
| 803 | while (len > 0) { |
| 804 | unsigned int head, tail, mask, bc = 0; |
| 805 | size_t remain = len; |
| 806 | |
| 807 | /* |
| 808 | * Check for signal early to make process killable when there |
| 809 | * are always buffers available |
| 810 | */ |
| 811 | ret = -ERESTARTSYS; |
| 812 | if (signal_pending(current)) |
| 813 | break; |
| 814 | |
| 815 | while (pipe_empty(pipe->head, pipe->tail)) { |
| 816 | ret = 0; |
| 817 | if (!pipe->writers) |
| 818 | goto out; |
| 819 | |
| 820 | if (spliced) |
| 821 | goto out; |
| 822 | |
| 823 | ret = -EAGAIN; |
| 824 | if (flags & SPLICE_F_NONBLOCK) |
| 825 | goto out; |
| 826 | |
| 827 | ret = -ERESTARTSYS; |
| 828 | if (signal_pending(current)) |
| 829 | goto out; |
| 830 | |
| 831 | if (need_wakeup) { |
| 832 | wakeup_pipe_writers(pipe); |
| 833 | need_wakeup = false; |
| 834 | } |
| 835 | |
| 836 | pipe_wait_readable(pipe); |
| 837 | } |
| 838 | |
| 839 | head = pipe->head; |
| 840 | tail = pipe->tail; |
| 841 | mask = pipe->ring_size - 1; |
| 842 | |
| 843 | while (!pipe_empty(head, tail)) { |
| 844 | struct pipe_buffer *buf = &pipe->bufs[tail & mask]; |
| 845 | size_t seg; |
| 846 | |
| 847 | if (!buf->len) { |
| 848 | tail++; |
| 849 | continue; |
| 850 | } |
| 851 | |
| 852 | seg = min_t(size_t, remain, buf->len); |
David Howells | 2dc334f | 2023-06-07 19:19:09 +0100 | [diff] [blame] | 853 | |
| 854 | ret = pipe_buf_confirm(pipe, buf); |
| 855 | if (unlikely(ret)) { |
| 856 | if (ret == -ENODATA) |
| 857 | ret = 0; |
| 858 | break; |
| 859 | } |
| 860 | |
| 861 | bvec_set_page(&bvec[bc++], buf->page, seg, buf->offset); |
| 862 | remain -= seg; |
David Howells | ca2d49f | 2023-06-14 11:09:48 +0100 | [diff] [blame] | 863 | if (remain == 0 || bc >= ARRAY_SIZE(bvec)) |
David Howells | 2dc334f | 2023-06-07 19:19:09 +0100 | [diff] [blame] | 864 | break; |
David Howells | ca2d49f | 2023-06-14 11:09:48 +0100 | [diff] [blame] | 865 | tail++; |
David Howells | 2dc334f | 2023-06-07 19:19:09 +0100 | [diff] [blame] | 866 | } |
| 867 | |
| 868 | if (!bc) |
| 869 | break; |
| 870 | |
| 871 | msg.msg_flags = MSG_SPLICE_PAGES; |
| 872 | if (flags & SPLICE_F_MORE) |
| 873 | msg.msg_flags |= MSG_MORE; |
| 874 | if (remain && pipe_occupancy(pipe->head, tail) > 0) |
| 875 | msg.msg_flags |= MSG_MORE; |
Jan Stancek | 0f0fa27 | 2023-07-24 19:39:04 +0200 | [diff] [blame] | 876 | if (out->f_flags & O_NONBLOCK) |
| 877 | msg.msg_flags |= MSG_DONTWAIT; |
David Howells | 2dc334f | 2023-06-07 19:19:09 +0100 | [diff] [blame] | 878 | |
| 879 | iov_iter_bvec(&msg.msg_iter, ITER_SOURCE, bvec, bc, |
| 880 | len - remain); |
| 881 | ret = sock_sendmsg(sock, &msg); |
| 882 | if (ret <= 0) |
| 883 | break; |
| 884 | |
| 885 | spliced += ret; |
| 886 | len -= ret; |
| 887 | tail = pipe->tail; |
| 888 | while (ret > 0) { |
| 889 | struct pipe_buffer *buf = &pipe->bufs[tail & mask]; |
| 890 | size_t seg = min_t(size_t, ret, buf->len); |
| 891 | |
| 892 | buf->offset += seg; |
| 893 | buf->len -= seg; |
| 894 | ret -= seg; |
| 895 | |
| 896 | if (!buf->len) { |
| 897 | pipe_buf_release(pipe, buf); |
| 898 | tail++; |
| 899 | } |
| 900 | } |
| 901 | |
| 902 | if (tail != pipe->tail) { |
| 903 | pipe->tail = tail; |
| 904 | if (pipe->files) |
| 905 | need_wakeup = true; |
| 906 | } |
| 907 | } |
| 908 | |
| 909 | out: |
| 910 | pipe_unlock(pipe); |
| 911 | if (need_wakeup) |
| 912 | wakeup_pipe_writers(pipe); |
| 913 | return spliced ?: ret; |
| 914 | } |
| 915 | #endif |
Jeff Garzik | a0f0678 | 2006-03-30 23:06:13 -0500 | [diff] [blame] | 916 | |
Christoph Hellwig | 36e2c74 | 2020-09-03 16:22:34 +0200 | [diff] [blame] | 917 | static int warn_unsupported(struct file *file, const char *op) |
| 918 | { |
| 919 | pr_debug_ratelimited( |
| 920 | "splice %s not supported for file %pD4 (pid: %d comm: %.20s)\n", |
| 921 | op, file, current->pid, current->comm); |
| 922 | return -EINVAL; |
| 923 | } |
| 924 | |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 925 | /* |
| 926 | * Attempt to initiate a splice from pipe to file. |
| 927 | */ |
Ingo Molnar | 3a326a2 | 2006-04-10 15:18:35 +0200 | [diff] [blame] | 928 | static long do_splice_from(struct pipe_inode_info *pipe, struct file *out, |
Jens Axboe | cbb7e57 | 2006-04-11 14:57:50 +0200 | [diff] [blame] | 929 | loff_t *ppos, size_t len, unsigned int flags) |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 930 | { |
Christoph Hellwig | 36e2c74 | 2020-09-03 16:22:34 +0200 | [diff] [blame] | 931 | if (unlikely(!out->f_op->splice_write)) |
| 932 | return warn_unsupported(out, "write"); |
| 933 | return out->f_op->splice_write(pipe, out, ppos, len, flags); |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 934 | } |
| 935 | |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 936 | /* |
David Howells | 2bfc668 | 2023-06-07 19:19:10 +0100 | [diff] [blame] | 937 | * Indicate to the caller that there was a premature EOF when reading from the |
| 938 | * source and the caller didn't indicate they would be sending more data after |
| 939 | * this. |
| 940 | */ |
| 941 | static void do_splice_eof(struct splice_desc *sd) |
| 942 | { |
| 943 | if (sd->splice_eof) |
| 944 | sd->splice_eof(sd); |
| 945 | } |
| 946 | |
David Howells | 6a3f30b | 2023-05-22 14:49:52 +0100 | [diff] [blame] | 947 | /** |
| 948 | * vfs_splice_read - Read data from a file and splice it into a pipe |
| 949 | * @in: File to splice from |
| 950 | * @ppos: Input file offset |
| 951 | * @pipe: Pipe to splice to |
| 952 | * @len: Number of bytes to splice |
| 953 | * @flags: Splice modifier flags (SPLICE_F_*) |
| 954 | * |
| 955 | * Splice the requested amount of data from the input file to the pipe. This |
| 956 | * is synchronous as the caller must hold the pipe lock across the entire |
| 957 | * operation. |
| 958 | * |
| 959 | * If successful, it returns the amount of data spliced, 0 if it hit the EOF or |
| 960 | * a hole and a negative error code otherwise. |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 961 | */ |
David Howells | 6a3f30b | 2023-05-22 14:49:52 +0100 | [diff] [blame] | 962 | long vfs_splice_read(struct file *in, loff_t *ppos, |
| 963 | struct pipe_inode_info *pipe, size_t len, |
| 964 | unsigned int flags) |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 965 | { |
Al Viro | 313d64a | 2021-01-24 23:49:04 -0500 | [diff] [blame] | 966 | unsigned int p_space; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 967 | int ret; |
| 968 | |
Jens Axboe | 49570e9 | 2006-04-11 13:56:09 +0200 | [diff] [blame] | 969 | if (unlikely(!(in->f_mode & FMODE_READ))) |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 970 | return -EBADF; |
David Howells | 123856f | 2023-05-22 14:49:53 +0100 | [diff] [blame] | 971 | if (!len) |
| 972 | return 0; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 973 | |
Al Viro | 313d64a | 2021-01-24 23:49:04 -0500 | [diff] [blame] | 974 | /* Don't try to read more the pipe has space for. */ |
| 975 | p_space = pipe->max_usage - pipe_occupancy(pipe->head, pipe->tail); |
| 976 | len = min_t(size_t, len, p_space << PAGE_SHIFT); |
| 977 | |
Jens Axboe | cbb7e57 | 2006-04-11 14:57:50 +0200 | [diff] [blame] | 978 | ret = rw_verify_area(READ, in, ppos, len); |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 979 | if (unlikely(ret < 0)) |
| 980 | return ret; |
| 981 | |
Al Viro | 03cc078 | 2016-04-02 14:56:58 -0400 | [diff] [blame] | 982 | if (unlikely(len > MAX_RW_COUNT)) |
| 983 | len = MAX_RW_COUNT; |
| 984 | |
Christoph Hellwig | 36e2c74 | 2020-09-03 16:22:34 +0200 | [diff] [blame] | 985 | if (unlikely(!in->f_op->splice_read)) |
| 986 | return warn_unsupported(in, "read"); |
David Howells | aa3dbde | 2023-05-22 14:49:54 +0100 | [diff] [blame] | 987 | /* |
David Howells | b85930a | 2023-05-22 14:49:55 +0100 | [diff] [blame] | 988 | * O_DIRECT and DAX don't deal with the pagecache, so we allocate a |
| 989 | * buffer, copy into it and splice that into the pipe. |
David Howells | aa3dbde | 2023-05-22 14:49:54 +0100 | [diff] [blame] | 990 | */ |
David Howells | b85930a | 2023-05-22 14:49:55 +0100 | [diff] [blame] | 991 | if ((in->f_flags & O_DIRECT) || IS_DAX(in->f_mapping->host)) |
David Howells | aa3dbde | 2023-05-22 14:49:54 +0100 | [diff] [blame] | 992 | return copy_splice_read(in, ppos, pipe, len, flags); |
Christoph Hellwig | 36e2c74 | 2020-09-03 16:22:34 +0200 | [diff] [blame] | 993 | return in->f_op->splice_read(in, ppos, pipe, len, flags); |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 994 | } |
David Howells | 6a3f30b | 2023-05-22 14:49:52 +0100 | [diff] [blame] | 995 | EXPORT_SYMBOL_GPL(vfs_splice_read); |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 996 | |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 997 | /** |
| 998 | * splice_direct_to_actor - splices data directly between two non-pipes |
| 999 | * @in: file to splice from |
| 1000 | * @sd: actor information on where to splice to |
| 1001 | * @actor: handles the data splicing |
| 1002 | * |
| 1003 | * Description: |
| 1004 | * This is a special case helper to splice directly between two |
| 1005 | * points, without requiring an explicit pipe. Internally an allocated |
Randy Dunlap | 79685b8 | 2007-07-27 08:08:51 +0200 | [diff] [blame] | 1006 | * pipe is cached in the process, and reused during the lifetime of |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 1007 | * that process. |
| 1008 | * |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1009 | */ |
| 1010 | ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd, |
| 1011 | splice_direct_actor *actor) |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1012 | { |
| 1013 | struct pipe_inode_info *pipe; |
| 1014 | long ret, bytes; |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1015 | size_t len; |
Christophe Leroy | 0ff28d9 | 2015-05-06 17:26:47 +0200 | [diff] [blame] | 1016 | int i, flags, more; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1017 | |
| 1018 | /* |
Jason A. Donenfeld | 97ef77c | 2022-06-29 15:06:58 +0200 | [diff] [blame] | 1019 | * We require the input to be seekable, as we don't want to randomly |
| 1020 | * drop data for eg socket -> socket splicing. Use the piped splicing |
| 1021 | * for that! |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1022 | */ |
Jason A. Donenfeld | 97ef77c | 2022-06-29 15:06:58 +0200 | [diff] [blame] | 1023 | if (unlikely(!(in->f_mode & FMODE_LSEEK))) |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1024 | return -EINVAL; |
| 1025 | |
| 1026 | /* |
| 1027 | * neither in nor out is a pipe, setup an internal pipe attached to |
| 1028 | * 'out' and transfer the wanted data from 'in' to 'out' through that |
| 1029 | */ |
| 1030 | pipe = current->splice_pipe; |
Jens Axboe | 49570e9 | 2006-04-11 13:56:09 +0200 | [diff] [blame] | 1031 | if (unlikely(!pipe)) { |
Al Viro | 7bee130 | 2013-03-21 11:04:15 -0400 | [diff] [blame] | 1032 | pipe = alloc_pipe_info(); |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1033 | if (!pipe) |
| 1034 | return -ENOMEM; |
| 1035 | |
| 1036 | /* |
| 1037 | * We don't have an immediate reader, but we'll read the stuff |
Jens Axboe | 00522fb | 2006-04-26 14:39:29 +0200 | [diff] [blame] | 1038 | * out of the pipe right after the splice_to_pipe(). So set |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1039 | * PIPE_READERS appropriately. |
| 1040 | */ |
| 1041 | pipe->readers = 1; |
| 1042 | |
| 1043 | current->splice_pipe = pipe; |
| 1044 | } |
| 1045 | |
| 1046 | /* |
Ingo Molnar | 73d62d8 | 2006-04-11 13:57:21 +0200 | [diff] [blame] | 1047 | * Do the splice. |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1048 | */ |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1049 | bytes = 0; |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1050 | len = sd->total_len; |
David Howells | 219d920 | 2023-06-07 19:19:16 +0100 | [diff] [blame] | 1051 | |
| 1052 | /* Don't block on output, we have to drain the direct pipe. */ |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1053 | flags = sd->flags; |
David Howells | 219d920 | 2023-06-07 19:19:16 +0100 | [diff] [blame] | 1054 | sd->flags &= ~SPLICE_F_NONBLOCK; |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1055 | |
| 1056 | /* |
David Howells | 219d920 | 2023-06-07 19:19:16 +0100 | [diff] [blame] | 1057 | * We signal MORE until we've read sufficient data to fulfill the |
| 1058 | * request and we keep signalling it if the caller set it. |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1059 | */ |
Christophe Leroy | 0ff28d9 | 2015-05-06 17:26:47 +0200 | [diff] [blame] | 1060 | more = sd->flags & SPLICE_F_MORE; |
David Howells | 219d920 | 2023-06-07 19:19:16 +0100 | [diff] [blame] | 1061 | sd->flags |= SPLICE_F_MORE; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1062 | |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1063 | WARN_ON_ONCE(!pipe_empty(pipe->head, pipe->tail)); |
Darrick J. Wong | 1761444 | 2018-11-30 10:37:49 -0800 | [diff] [blame] | 1064 | |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1065 | while (len) { |
Jens Axboe | 51a92c0 | 2007-07-13 14:11:43 +0200 | [diff] [blame] | 1066 | size_t read_len; |
Tom Zanussi | a82c53a | 2008-05-09 13:28:36 +0200 | [diff] [blame] | 1067 | loff_t pos = sd->pos, prev_pos = pos; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1068 | |
David Howells | 6a3f30b | 2023-05-22 14:49:52 +0100 | [diff] [blame] | 1069 | ret = vfs_splice_read(in, &pos, pipe, len, flags); |
Jens Axboe | 51a92c0 | 2007-07-13 14:11:43 +0200 | [diff] [blame] | 1070 | if (unlikely(ret <= 0)) |
David Howells | 2bfc668 | 2023-06-07 19:19:10 +0100 | [diff] [blame] | 1071 | goto read_failure; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1072 | |
| 1073 | read_len = ret; |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1074 | sd->total_len = read_len; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1075 | |
| 1076 | /* |
David Howells | 219d920 | 2023-06-07 19:19:16 +0100 | [diff] [blame] | 1077 | * If we now have sufficient data to fulfill the request then |
| 1078 | * we clear SPLICE_F_MORE if it was not set initially. |
Christophe Leroy | 0ff28d9 | 2015-05-06 17:26:47 +0200 | [diff] [blame] | 1079 | */ |
David Howells | 219d920 | 2023-06-07 19:19:16 +0100 | [diff] [blame] | 1080 | if (read_len >= len && !more) |
Christophe Leroy | 0ff28d9 | 2015-05-06 17:26:47 +0200 | [diff] [blame] | 1081 | sd->flags &= ~SPLICE_F_MORE; |
David Howells | 219d920 | 2023-06-07 19:19:16 +0100 | [diff] [blame] | 1082 | |
Christophe Leroy | 0ff28d9 | 2015-05-06 17:26:47 +0200 | [diff] [blame] | 1083 | /* |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1084 | * NOTE: nonblocking mode only applies to the input. We |
| 1085 | * must not do the output in nonblocking mode as then we |
| 1086 | * could get stuck data in the internal pipe: |
| 1087 | */ |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1088 | ret = actor(pipe, sd); |
Tom Zanussi | a82c53a | 2008-05-09 13:28:36 +0200 | [diff] [blame] | 1089 | if (unlikely(ret <= 0)) { |
| 1090 | sd->pos = prev_pos; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1091 | goto out_release; |
Tom Zanussi | a82c53a | 2008-05-09 13:28:36 +0200 | [diff] [blame] | 1092 | } |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1093 | |
| 1094 | bytes += ret; |
| 1095 | len -= ret; |
Jens Axboe | bcd4f3a | 2007-07-16 14:41:49 +0200 | [diff] [blame] | 1096 | sd->pos = pos; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1097 | |
Tom Zanussi | a82c53a | 2008-05-09 13:28:36 +0200 | [diff] [blame] | 1098 | if (ret < read_len) { |
| 1099 | sd->pos = prev_pos + ret; |
Jens Axboe | 51a92c0 | 2007-07-13 14:11:43 +0200 | [diff] [blame] | 1100 | goto out_release; |
Tom Zanussi | a82c53a | 2008-05-09 13:28:36 +0200 | [diff] [blame] | 1101 | } |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1102 | } |
| 1103 | |
Jens Axboe | 9e97198 | 2008-01-29 21:05:57 +0100 | [diff] [blame] | 1104 | done: |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1105 | pipe->tail = pipe->head = 0; |
Jens Axboe | 8084870 | 2008-01-30 12:24:48 +0100 | [diff] [blame] | 1106 | file_accessed(in); |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1107 | return bytes; |
| 1108 | |
David Howells | 2bfc668 | 2023-06-07 19:19:10 +0100 | [diff] [blame] | 1109 | read_failure: |
| 1110 | /* |
| 1111 | * If the user did *not* set SPLICE_F_MORE *and* we didn't hit that |
| 1112 | * "use all of len" case that cleared SPLICE_F_MORE, *and* we did a |
| 1113 | * "->splice_in()" that returned EOF (ie zero) *and* we have sent at |
| 1114 | * least 1 byte *then* we will also do the ->splice_eof() call. |
| 1115 | */ |
| 1116 | if (ret == 0 && !more && len > 0 && bytes) |
| 1117 | do_splice_eof(sd); |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1118 | out_release: |
| 1119 | /* |
| 1120 | * If we did an incomplete transfer we must release |
| 1121 | * the pipe buffers in question: |
| 1122 | */ |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1123 | for (i = 0; i < pipe->ring_size; i++) { |
| 1124 | struct pipe_buffer *buf = &pipe->bufs[i]; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1125 | |
Miklos Szeredi | a779638 | 2016-09-27 10:45:12 +0200 | [diff] [blame] | 1126 | if (buf->ops) |
| 1127 | pipe_buf_release(pipe, buf); |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1128 | } |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1129 | |
Jens Axboe | 9e97198 | 2008-01-29 21:05:57 +0100 | [diff] [blame] | 1130 | if (!bytes) |
| 1131 | bytes = ret; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1132 | |
Jens Axboe | 9e97198 | 2008-01-29 21:05:57 +0100 | [diff] [blame] | 1133 | goto done; |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1134 | } |
| 1135 | EXPORT_SYMBOL(splice_direct_to_actor); |
| 1136 | |
| 1137 | static int direct_splice_actor(struct pipe_inode_info *pipe, |
| 1138 | struct splice_desc *sd) |
| 1139 | { |
Jens Axboe | 6a14b90 | 2007-06-14 13:08:55 +0200 | [diff] [blame] | 1140 | struct file *file = sd->u.file; |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1141 | |
Al Viro | 7995bd2 | 2013-06-20 18:58:36 +0400 | [diff] [blame] | 1142 | return do_splice_from(pipe, file, sd->opos, sd->total_len, |
Changli Gao | 2cb4b05 | 2010-06-29 13:09:18 +0200 | [diff] [blame] | 1143 | sd->flags); |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1144 | } |
| 1145 | |
David Howells | 2bfc668 | 2023-06-07 19:19:10 +0100 | [diff] [blame] | 1146 | static void direct_file_splice_eof(struct splice_desc *sd) |
| 1147 | { |
| 1148 | struct file *file = sd->u.file; |
| 1149 | |
| 1150 | if (file->f_op->splice_eof) |
| 1151 | file->f_op->splice_eof(file); |
| 1152 | } |
| 1153 | |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 1154 | /** |
| 1155 | * do_splice_direct - splices data directly between two files |
| 1156 | * @in: file to splice from |
| 1157 | * @ppos: input file offset |
| 1158 | * @out: file to splice to |
Randy Dunlap | acdb37c | 2013-06-22 19:44:08 -0700 | [diff] [blame] | 1159 | * @opos: output file offset |
Jens Axboe | 932cc6d | 2007-06-21 13:10:21 +0200 | [diff] [blame] | 1160 | * @len: number of bytes to splice |
| 1161 | * @flags: splice modifier flags |
| 1162 | * |
| 1163 | * Description: |
| 1164 | * For use by do_sendfile(). splice can easily emulate sendfile, but |
| 1165 | * doing it in the application would incur an extra system call |
| 1166 | * (splice in + splice out, as compared to just sendfile()). So this helper |
| 1167 | * can splice directly through a process-private pipe. |
| 1168 | * |
| 1169 | */ |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1170 | long do_splice_direct(struct file *in, loff_t *ppos, struct file *out, |
Al Viro | 7995bd2 | 2013-06-20 18:58:36 +0400 | [diff] [blame] | 1171 | loff_t *opos, size_t len, unsigned int flags) |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1172 | { |
| 1173 | struct splice_desc sd = { |
| 1174 | .len = len, |
| 1175 | .total_len = len, |
| 1176 | .flags = flags, |
| 1177 | .pos = *ppos, |
Jens Axboe | 6a14b90 | 2007-06-14 13:08:55 +0200 | [diff] [blame] | 1178 | .u.file = out, |
David Howells | 2bfc668 | 2023-06-07 19:19:10 +0100 | [diff] [blame] | 1179 | .splice_eof = direct_file_splice_eof, |
Al Viro | 7995bd2 | 2013-06-20 18:58:36 +0400 | [diff] [blame] | 1180 | .opos = opos, |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1181 | }; |
Jens Axboe | 51a92c0 | 2007-07-13 14:11:43 +0200 | [diff] [blame] | 1182 | long ret; |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1183 | |
Al Viro | 18c67cb | 2013-06-19 15:41:54 +0400 | [diff] [blame] | 1184 | if (unlikely(!(out->f_mode & FMODE_WRITE))) |
| 1185 | return -EBADF; |
| 1186 | |
| 1187 | if (unlikely(out->f_flags & O_APPEND)) |
| 1188 | return -EINVAL; |
| 1189 | |
| 1190 | ret = rw_verify_area(WRITE, out, opos, len); |
| 1191 | if (unlikely(ret < 0)) |
| 1192 | return ret; |
| 1193 | |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1194 | ret = splice_direct_to_actor(in, &sd, direct_splice_actor); |
Jens Axboe | 51a92c0 | 2007-07-13 14:11:43 +0200 | [diff] [blame] | 1195 | if (ret > 0) |
Tom Zanussi | a82c53a | 2008-05-09 13:28:36 +0200 | [diff] [blame] | 1196 | *ppos = sd.pos; |
Jens Axboe | 51a92c0 | 2007-07-13 14:11:43 +0200 | [diff] [blame] | 1197 | |
Jens Axboe | c66ab6f | 2007-06-12 21:17:17 +0200 | [diff] [blame] | 1198 | return ret; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1199 | } |
Miklos Szeredi | 1c11859 | 2014-10-24 00:14:35 +0200 | [diff] [blame] | 1200 | EXPORT_SYMBOL(do_splice_direct); |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1201 | |
Al Viro | 8924fef | 2016-09-17 20:44:45 -0400 | [diff] [blame] | 1202 | static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags) |
| 1203 | { |
Linus Torvalds | 52bce91 | 2016-12-21 10:59:34 -0800 | [diff] [blame] | 1204 | for (;;) { |
| 1205 | if (unlikely(!pipe->readers)) { |
| 1206 | send_sig(SIGPIPE, current, 0); |
| 1207 | return -EPIPE; |
| 1208 | } |
David Howells | 6718b6f | 2019-10-16 16:47:32 +0100 | [diff] [blame] | 1209 | if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage)) |
Linus Torvalds | 52bce91 | 2016-12-21 10:59:34 -0800 | [diff] [blame] | 1210 | return 0; |
Al Viro | 8924fef | 2016-09-17 20:44:45 -0400 | [diff] [blame] | 1211 | if (flags & SPLICE_F_NONBLOCK) |
| 1212 | return -EAGAIN; |
| 1213 | if (signal_pending(current)) |
| 1214 | return -ERESTARTSYS; |
Linus Torvalds | 472e5b0 | 2020-10-01 19:14:36 -0700 | [diff] [blame] | 1215 | pipe_wait_writable(pipe); |
Al Viro | 8924fef | 2016-09-17 20:44:45 -0400 | [diff] [blame] | 1216 | } |
Al Viro | 8924fef | 2016-09-17 20:44:45 -0400 | [diff] [blame] | 1217 | } |
| 1218 | |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1219 | static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe, |
| 1220 | struct pipe_inode_info *opipe, |
| 1221 | size_t len, unsigned int flags); |
Jens Axboe | ddac0d3 | 2006-11-04 12:49:32 +0100 | [diff] [blame] | 1222 | |
Al Viro | b964bf5 | 2021-01-25 22:24:28 -0500 | [diff] [blame] | 1223 | long splice_file_to_pipe(struct file *in, |
Al Viro | faa97c4 | 2021-01-25 22:23:03 -0500 | [diff] [blame] | 1224 | struct pipe_inode_info *opipe, |
| 1225 | loff_t *offset, |
| 1226 | size_t len, unsigned int flags) |
| 1227 | { |
| 1228 | long ret; |
| 1229 | |
| 1230 | pipe_lock(opipe); |
| 1231 | ret = wait_for_space(opipe, flags); |
| 1232 | if (!ret) |
David Howells | 6a3f30b | 2023-05-22 14:49:52 +0100 | [diff] [blame] | 1233 | ret = vfs_splice_read(in, offset, opipe, len, flags); |
Al Viro | faa97c4 | 2021-01-25 22:23:03 -0500 | [diff] [blame] | 1234 | pipe_unlock(opipe); |
| 1235 | if (ret > 0) |
| 1236 | wakeup_pipe_readers(opipe); |
| 1237 | return ret; |
| 1238 | } |
| 1239 | |
Jens Axboe | ddac0d3 | 2006-11-04 12:49:32 +0100 | [diff] [blame] | 1240 | /* |
Jens Axboe | 83f9135 | 2006-04-02 23:05:09 +0200 | [diff] [blame] | 1241 | * Determine where to splice to/from. |
| 1242 | */ |
Jens Axboe | ee6e00c | 2020-10-22 14:15:51 -0600 | [diff] [blame] | 1243 | long do_splice(struct file *in, loff_t *off_in, struct file *out, |
| 1244 | loff_t *off_out, size_t len, unsigned int flags) |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 1245 | { |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1246 | struct pipe_inode_info *ipipe; |
| 1247 | struct pipe_inode_info *opipe; |
Al Viro | 7995bd2 | 2013-06-20 18:58:36 +0400 | [diff] [blame] | 1248 | loff_t offset; |
Jens Axboe | a4514eb | 2006-04-19 15:57:05 +0200 | [diff] [blame] | 1249 | long ret; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 1250 | |
Pavel Begunkov | 90da2e3 | 2020-05-04 22:39:35 +0300 | [diff] [blame] | 1251 | if (unlikely(!(in->f_mode & FMODE_READ) || |
| 1252 | !(out->f_mode & FMODE_WRITE))) |
| 1253 | return -EBADF; |
| 1254 | |
David Howells | c73be61 | 2020-01-14 17:07:11 +0000 | [diff] [blame] | 1255 | ipipe = get_pipe_info(in, true); |
| 1256 | opipe = get_pipe_info(out, true); |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1257 | |
| 1258 | if (ipipe && opipe) { |
| 1259 | if (off_in || off_out) |
| 1260 | return -ESPIPE; |
| 1261 | |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1262 | /* Splicing to self would be fun, but... */ |
| 1263 | if (ipipe == opipe) |
| 1264 | return -EINVAL; |
| 1265 | |
Slavomir Kaslev | ee5e001 | 2019-02-07 17:45:19 +0200 | [diff] [blame] | 1266 | if ((in->f_flags | out->f_flags) & O_NONBLOCK) |
| 1267 | flags |= SPLICE_F_NONBLOCK; |
| 1268 | |
Ahelenia ZiemiaĆska | 12ee4b6 | 2023-07-03 16:42:13 +0200 | [diff] [blame] | 1269 | ret = splice_pipe_to_pipe(ipipe, opipe, len, flags); |
| 1270 | } else if (ipipe) { |
Ingo Molnar | 529565dc | 2006-04-10 15:18:58 +0200 | [diff] [blame] | 1271 | if (off_in) |
| 1272 | return -ESPIPE; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1273 | if (off_out) { |
Changli Gao | 19c9a49 | 2010-06-29 13:10:36 +0200 | [diff] [blame] | 1274 | if (!(out->f_mode & FMODE_PWRITE)) |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1275 | return -EINVAL; |
Jens Axboe | ee6e00c | 2020-10-22 14:15:51 -0600 | [diff] [blame] | 1276 | offset = *off_out; |
Al Viro | 7995bd2 | 2013-06-20 18:58:36 +0400 | [diff] [blame] | 1277 | } else { |
| 1278 | offset = out->f_pos; |
| 1279 | } |
Ingo Molnar | 529565dc | 2006-04-10 15:18:58 +0200 | [diff] [blame] | 1280 | |
Al Viro | 18c67cb | 2013-06-19 15:41:54 +0400 | [diff] [blame] | 1281 | if (unlikely(out->f_flags & O_APPEND)) |
| 1282 | return -EINVAL; |
| 1283 | |
| 1284 | ret = rw_verify_area(WRITE, out, &offset, len); |
| 1285 | if (unlikely(ret < 0)) |
| 1286 | return ret; |
| 1287 | |
Slavomir Kaslev | ee5e001 | 2019-02-07 17:45:19 +0200 | [diff] [blame] | 1288 | if (in->f_flags & O_NONBLOCK) |
| 1289 | flags |= SPLICE_F_NONBLOCK; |
| 1290 | |
Al Viro | 500368f | 2013-05-23 20:07:11 -0400 | [diff] [blame] | 1291 | file_start_write(out); |
Al Viro | 7995bd2 | 2013-06-20 18:58:36 +0400 | [diff] [blame] | 1292 | ret = do_splice_from(ipipe, out, &offset, len, flags); |
Al Viro | 500368f | 2013-05-23 20:07:11 -0400 | [diff] [blame] | 1293 | file_end_write(out); |
Jens Axboe | a4514eb | 2006-04-19 15:57:05 +0200 | [diff] [blame] | 1294 | |
Al Viro | 7995bd2 | 2013-06-20 18:58:36 +0400 | [diff] [blame] | 1295 | if (!off_out) |
| 1296 | out->f_pos = offset; |
Jens Axboe | ee6e00c | 2020-10-22 14:15:51 -0600 | [diff] [blame] | 1297 | else |
| 1298 | *off_out = offset; |
Ahelenia ZiemiaĆska | 12ee4b6 | 2023-07-03 16:42:13 +0200 | [diff] [blame] | 1299 | } else if (opipe) { |
Ingo Molnar | 529565dc | 2006-04-10 15:18:58 +0200 | [diff] [blame] | 1300 | if (off_out) |
| 1301 | return -ESPIPE; |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1302 | if (off_in) { |
Changli Gao | 19c9a49 | 2010-06-29 13:10:36 +0200 | [diff] [blame] | 1303 | if (!(in->f_mode & FMODE_PREAD)) |
Jens Axboe | b92ce55 | 2006-04-11 13:52:07 +0200 | [diff] [blame] | 1304 | return -EINVAL; |
Jens Axboe | ee6e00c | 2020-10-22 14:15:51 -0600 | [diff] [blame] | 1305 | offset = *off_in; |
Al Viro | 7995bd2 | 2013-06-20 18:58:36 +0400 | [diff] [blame] | 1306 | } else { |
| 1307 | offset = in->f_pos; |
| 1308 | } |
Ingo Molnar | 529565dc | 2006-04-10 15:18:58 +0200 | [diff] [blame] | 1309 | |
Slavomir Kaslev | ee5e001 | 2019-02-07 17:45:19 +0200 | [diff] [blame] | 1310 | if (out->f_flags & O_NONBLOCK) |
| 1311 | flags |= SPLICE_F_NONBLOCK; |
| 1312 | |
Al Viro | faa97c4 | 2021-01-25 22:23:03 -0500 | [diff] [blame] | 1313 | ret = splice_file_to_pipe(in, opipe, &offset, len, flags); |
Chung-Chiang Cheng | 983652c | 2023-03-22 14:25:19 +0800 | [diff] [blame] | 1314 | |
Al Viro | 7995bd2 | 2013-06-20 18:58:36 +0400 | [diff] [blame] | 1315 | if (!off_in) |
| 1316 | in->f_pos = offset; |
Jens Axboe | ee6e00c | 2020-10-22 14:15:51 -0600 | [diff] [blame] | 1317 | else |
| 1318 | *off_in = offset; |
Ahelenia ZiemiaĆska | 12ee4b6 | 2023-07-03 16:42:13 +0200 | [diff] [blame] | 1319 | } else { |
| 1320 | ret = -EINVAL; |
Ingo Molnar | 529565dc | 2006-04-10 15:18:58 +0200 | [diff] [blame] | 1321 | } |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 1322 | |
Ahelenia ZiemiaĆska | 12ee4b6 | 2023-07-03 16:42:13 +0200 | [diff] [blame] | 1323 | if (ret > 0) { |
| 1324 | /* |
| 1325 | * Generate modify out before access in: |
| 1326 | * do_splice_from() may've already sent modify out, |
| 1327 | * and this ensures the events get merged. |
| 1328 | */ |
| 1329 | fsnotify_modify(out); |
| 1330 | fsnotify_access(in); |
| 1331 | } |
| 1332 | |
| 1333 | return ret; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 1334 | } |
| 1335 | |
Jens Axboe | ee6e00c | 2020-10-22 14:15:51 -0600 | [diff] [blame] | 1336 | static long __do_splice(struct file *in, loff_t __user *off_in, |
| 1337 | struct file *out, loff_t __user *off_out, |
| 1338 | size_t len, unsigned int flags) |
| 1339 | { |
| 1340 | struct pipe_inode_info *ipipe; |
| 1341 | struct pipe_inode_info *opipe; |
| 1342 | loff_t offset, *__off_in = NULL, *__off_out = NULL; |
| 1343 | long ret; |
| 1344 | |
| 1345 | ipipe = get_pipe_info(in, true); |
| 1346 | opipe = get_pipe_info(out, true); |
| 1347 | |
Jens Axboe | 0f99fc5 | 2023-04-24 16:32:55 -0600 | [diff] [blame] | 1348 | if (ipipe) { |
| 1349 | if (off_in) |
| 1350 | return -ESPIPE; |
| 1351 | pipe_clear_nowait(in); |
| 1352 | } |
| 1353 | if (opipe) { |
| 1354 | if (off_out) |
| 1355 | return -ESPIPE; |
| 1356 | pipe_clear_nowait(out); |
| 1357 | } |
Jens Axboe | ee6e00c | 2020-10-22 14:15:51 -0600 | [diff] [blame] | 1358 | |
| 1359 | if (off_out) { |
| 1360 | if (copy_from_user(&offset, off_out, sizeof(loff_t))) |
| 1361 | return -EFAULT; |
| 1362 | __off_out = &offset; |
| 1363 | } |
| 1364 | if (off_in) { |
| 1365 | if (copy_from_user(&offset, off_in, sizeof(loff_t))) |
| 1366 | return -EFAULT; |
| 1367 | __off_in = &offset; |
| 1368 | } |
| 1369 | |
| 1370 | ret = do_splice(in, __off_in, out, __off_out, len, flags); |
| 1371 | if (ret < 0) |
| 1372 | return ret; |
| 1373 | |
| 1374 | if (__off_out && copy_to_user(off_out, __off_out, sizeof(loff_t))) |
| 1375 | return -EFAULT; |
| 1376 | if (__off_in && copy_to_user(off_in, __off_in, sizeof(loff_t))) |
| 1377 | return -EFAULT; |
| 1378 | |
| 1379 | return ret; |
| 1380 | } |
| 1381 | |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 1382 | static int iter_to_pipe(struct iov_iter *from, |
| 1383 | struct pipe_inode_info *pipe, |
| 1384 | unsigned flags) |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1385 | { |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 1386 | struct pipe_buffer buf = { |
| 1387 | .ops = &user_page_pipe_buf_ops, |
| 1388 | .flags = flags |
| 1389 | }; |
| 1390 | size_t total = 0; |
| 1391 | int ret = 0; |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 1392 | |
Al Viro | 7d690c1 | 2022-06-09 11:07:52 -0400 | [diff] [blame] | 1393 | while (iov_iter_count(from)) { |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 1394 | struct page *pages[16]; |
Al Viro | 7d690c1 | 2022-06-09 11:07:52 -0400 | [diff] [blame] | 1395 | ssize_t left; |
Al Viro | db85a9e | 2016-09-17 20:25:06 -0400 | [diff] [blame] | 1396 | size_t start; |
Al Viro | 7d690c1 | 2022-06-09 11:07:52 -0400 | [diff] [blame] | 1397 | int i, n; |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1398 | |
Al Viro | 7d690c1 | 2022-06-09 11:07:52 -0400 | [diff] [blame] | 1399 | left = iov_iter_get_pages2(from, pages, ~0UL, 16, &start); |
| 1400 | if (left <= 0) { |
| 1401 | ret = left; |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 1402 | break; |
| 1403 | } |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1404 | |
Al Viro | 7d690c1 | 2022-06-09 11:07:52 -0400 | [diff] [blame] | 1405 | n = DIV_ROUND_UP(left + start, PAGE_SIZE); |
| 1406 | for (i = 0; i < n; i++) { |
| 1407 | int size = min_t(int, left, PAGE_SIZE - start); |
| 1408 | |
| 1409 | buf.page = pages[i]; |
| 1410 | buf.offset = start; |
| 1411 | buf.len = size; |
| 1412 | ret = add_to_pipe(pipe, &buf); |
| 1413 | if (unlikely(ret < 0)) { |
| 1414 | iov_iter_revert(from, left); |
| 1415 | // this one got dropped by add_to_pipe() |
| 1416 | while (++i < n) |
| 1417 | put_page(pages[i]); |
| 1418 | goto out; |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 1419 | } |
Al Viro | 7d690c1 | 2022-06-09 11:07:52 -0400 | [diff] [blame] | 1420 | total += ret; |
| 1421 | left -= size; |
| 1422 | start = 0; |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1423 | } |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1424 | } |
Al Viro | 7d690c1 | 2022-06-09 11:07:52 -0400 | [diff] [blame] | 1425 | out: |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 1426 | return total ? total : ret; |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1427 | } |
| 1428 | |
Jens Axboe | 6a14b90 | 2007-06-14 13:08:55 +0200 | [diff] [blame] | 1429 | static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf, |
| 1430 | struct splice_desc *sd) |
| 1431 | { |
Al Viro | 6130f53 | 2014-02-03 18:19:51 -0500 | [diff] [blame] | 1432 | int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data); |
| 1433 | return n == sd->len ? n : -EFAULT; |
Jens Axboe | 6a14b90 | 2007-06-14 13:08:55 +0200 | [diff] [blame] | 1434 | } |
| 1435 | |
| 1436 | /* |
| 1437 | * For lack of a better implementation, implement vmsplice() to userspace |
| 1438 | * as a simple copy of the pipes pages to the user iov. |
| 1439 | */ |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1440 | static long vmsplice_to_user(struct file *file, struct iov_iter *iter, |
| 1441 | unsigned int flags) |
Jens Axboe | 6a14b90 | 2007-06-14 13:08:55 +0200 | [diff] [blame] | 1442 | { |
David Howells | c73be61 | 2020-01-14 17:07:11 +0000 | [diff] [blame] | 1443 | struct pipe_inode_info *pipe = get_pipe_info(file, true); |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1444 | struct splice_desc sd = { |
| 1445 | .total_len = iov_iter_count(iter), |
| 1446 | .flags = flags, |
| 1447 | .u.data = iter |
| 1448 | }; |
| 1449 | long ret = 0; |
Jens Axboe | 6a14b90 | 2007-06-14 13:08:55 +0200 | [diff] [blame] | 1450 | |
Jens Axboe | 6a14b90 | 2007-06-14 13:08:55 +0200 | [diff] [blame] | 1451 | if (!pipe) |
| 1452 | return -EBADF; |
| 1453 | |
Jens Axboe | 0f99fc5 | 2023-04-24 16:32:55 -0600 | [diff] [blame] | 1454 | pipe_clear_nowait(file); |
| 1455 | |
Al Viro | 345995f | 2015-03-21 19:17:55 -0400 | [diff] [blame] | 1456 | if (sd.total_len) { |
| 1457 | pipe_lock(pipe); |
| 1458 | ret = __splice_from_pipe(pipe, &sd, pipe_to_user); |
| 1459 | pipe_unlock(pipe); |
| 1460 | } |
Jens Axboe | 6a14b90 | 2007-06-14 13:08:55 +0200 | [diff] [blame] | 1461 | |
Ahelenia ZiemiaĆska | 7f0f1ea0 | 2023-07-03 16:42:17 +0200 | [diff] [blame] | 1462 | if (ret > 0) |
| 1463 | fsnotify_access(file); |
| 1464 | |
Jens Axboe | 6a14b90 | 2007-06-14 13:08:55 +0200 | [diff] [blame] | 1465 | return ret; |
| 1466 | } |
| 1467 | |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1468 | /* |
| 1469 | * vmsplice splices a user address range into a pipe. It can be thought of |
| 1470 | * as splice-from-memory, where the regular splice is splice-from-file (or |
| 1471 | * to file). In both cases the output is a pipe, naturally. |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1472 | */ |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1473 | static long vmsplice_to_pipe(struct file *file, struct iov_iter *iter, |
| 1474 | unsigned int flags) |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1475 | { |
Jens Axboe | ddac0d3 | 2006-11-04 12:49:32 +0100 | [diff] [blame] | 1476 | struct pipe_inode_info *pipe; |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1477 | long ret = 0; |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 1478 | unsigned buf_flag = 0; |
| 1479 | |
| 1480 | if (flags & SPLICE_F_GIFT) |
| 1481 | buf_flag = PIPE_BUF_FLAG_GIFT; |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1482 | |
David Howells | c73be61 | 2020-01-14 17:07:11 +0000 | [diff] [blame] | 1483 | pipe = get_pipe_info(file, true); |
Jens Axboe | ddac0d3 | 2006-11-04 12:49:32 +0100 | [diff] [blame] | 1484 | if (!pipe) |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1485 | return -EBADF; |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1486 | |
Jens Axboe | 0f99fc5 | 2023-04-24 16:32:55 -0600 | [diff] [blame] | 1487 | pipe_clear_nowait(file); |
| 1488 | |
Al Viro | 8924fef | 2016-09-17 20:44:45 -0400 | [diff] [blame] | 1489 | pipe_lock(pipe); |
| 1490 | ret = wait_for_space(pipe, flags); |
Al Viro | 79fddc4 | 2016-09-17 22:38:20 -0400 | [diff] [blame] | 1491 | if (!ret) |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1492 | ret = iter_to_pipe(iter, pipe, buf_flag); |
Al Viro | 8924fef | 2016-09-17 20:44:45 -0400 | [diff] [blame] | 1493 | pipe_unlock(pipe); |
Ahelenia ZiemiaĆska | 7f0f1ea0 | 2023-07-03 16:42:17 +0200 | [diff] [blame] | 1494 | if (ret > 0) { |
Al Viro | 8924fef | 2016-09-17 20:44:45 -0400 | [diff] [blame] | 1495 | wakeup_pipe_readers(pipe); |
Ahelenia ZiemiaĆska | 7f0f1ea0 | 2023-07-03 16:42:17 +0200 | [diff] [blame] | 1496 | fsnotify_modify(file); |
| 1497 | } |
Jens Axboe | 35f3d14 | 2010-05-20 10:43:18 +0200 | [diff] [blame] | 1498 | return ret; |
Jens Axboe | 912d35f | 2006-04-26 10:59:21 +0200 | [diff] [blame] | 1499 | } |
| 1500 | |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1501 | static int vmsplice_type(struct fd f, int *type) |
| 1502 | { |
| 1503 | if (!f.file) |
| 1504 | return -EBADF; |
| 1505 | if (f.file->f_mode & FMODE_WRITE) { |
Al Viro | de4eda9 | 2022-09-15 20:25:47 -0400 | [diff] [blame] | 1506 | *type = ITER_SOURCE; |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1507 | } else if (f.file->f_mode & FMODE_READ) { |
Al Viro | de4eda9 | 2022-09-15 20:25:47 -0400 | [diff] [blame] | 1508 | *type = ITER_DEST; |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1509 | } else { |
| 1510 | fdput(f); |
| 1511 | return -EBADF; |
| 1512 | } |
| 1513 | return 0; |
| 1514 | } |
| 1515 | |
Jens Axboe | 6a14b90 | 2007-06-14 13:08:55 +0200 | [diff] [blame] | 1516 | /* |
| 1517 | * Note that vmsplice only really supports true splicing _from_ user memory |
| 1518 | * to a pipe, not the other way around. Splicing from user memory is a simple |
| 1519 | * operation that can be supported without any funky alignment restrictions |
| 1520 | * or nasty vm tricks. We simply map in the user memory and fill them into |
| 1521 | * a pipe. The reverse isn't quite as easy, though. There are two possible |
| 1522 | * solutions for that: |
| 1523 | * |
| 1524 | * - memcpy() the data internally, at which point we might as well just |
| 1525 | * do a regular read() on the buffer anyway. |
| 1526 | * - Lots of nasty vm tricks, that are neither fast nor flexible (it |
| 1527 | * has restriction limitations on both ends of the pipe). |
| 1528 | * |
| 1529 | * Currently we punt and implement it as a normal copy, see pipe_to_user(). |
| 1530 | * |
| 1531 | */ |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1532 | SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, uiov, |
Dominik Brodowski | 30cfe4e | 2018-03-17 15:00:24 +0100 | [diff] [blame] | 1533 | unsigned long, nr_segs, unsigned int, flags) |
| 1534 | { |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1535 | struct iovec iovstack[UIO_FASTIOV]; |
| 1536 | struct iovec *iov = iovstack; |
| 1537 | struct iov_iter iter; |
Jens Axboe | 87e5e6d | 2019-05-14 16:02:22 -0600 | [diff] [blame] | 1538 | ssize_t error; |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1539 | struct fd f; |
| 1540 | int type; |
| 1541 | |
Christoph Hellwig | 598b3ce | 2020-09-25 06:51:44 +0200 | [diff] [blame] | 1542 | if (unlikely(flags & ~SPLICE_F_ALL)) |
| 1543 | return -EINVAL; |
| 1544 | |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1545 | f = fdget(fd); |
| 1546 | error = vmsplice_type(f, &type); |
| 1547 | if (error) |
| 1548 | return error; |
| 1549 | |
| 1550 | error = import_iovec(type, uiov, nr_segs, |
| 1551 | ARRAY_SIZE(iovstack), &iov, &iter); |
Christoph Hellwig | 598b3ce | 2020-09-25 06:51:44 +0200 | [diff] [blame] | 1552 | if (error < 0) |
| 1553 | goto out_fdput; |
| 1554 | |
| 1555 | if (!iov_iter_count(&iter)) |
| 1556 | error = 0; |
Al Viro | de4eda9 | 2022-09-15 20:25:47 -0400 | [diff] [blame] | 1557 | else if (type == ITER_SOURCE) |
Christoph Hellwig | 598b3ce | 2020-09-25 06:51:44 +0200 | [diff] [blame] | 1558 | error = vmsplice_to_pipe(f.file, &iter, flags); |
| 1559 | else |
| 1560 | error = vmsplice_to_user(f.file, &iter, flags); |
| 1561 | |
| 1562 | kfree(iov); |
| 1563 | out_fdput: |
Al Viro | 87a3002 | 2018-05-26 21:39:52 -0400 | [diff] [blame] | 1564 | fdput(f); |
| 1565 | return error; |
Dominik Brodowski | 30cfe4e | 2018-03-17 15:00:24 +0100 | [diff] [blame] | 1566 | } |
| 1567 | |
Heiko Carstens | 836f92a | 2009-01-14 14:14:33 +0100 | [diff] [blame] | 1568 | SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in, |
| 1569 | int, fd_out, loff_t __user *, off_out, |
| 1570 | size_t, len, unsigned int, flags) |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 1571 | { |
Al Viro | 2903ff0 | 2012-08-28 12:52:22 -0400 | [diff] [blame] | 1572 | struct fd in, out; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 1573 | long error; |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 1574 | |
| 1575 | if (unlikely(!len)) |
| 1576 | return 0; |
| 1577 | |
Al Viro | 3d6ea29 | 2016-12-10 13:17:32 -0500 | [diff] [blame] | 1578 | if (unlikely(flags & ~SPLICE_F_ALL)) |
| 1579 | return -EINVAL; |
| 1580 | |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 1581 | error = -EBADF; |
Al Viro | 2903ff0 | 2012-08-28 12:52:22 -0400 | [diff] [blame] | 1582 | in = fdget(fd_in); |
| 1583 | if (in.file) { |
Pavel Begunkov | 90da2e3 | 2020-05-04 22:39:35 +0300 | [diff] [blame] | 1584 | out = fdget(fd_out); |
| 1585 | if (out.file) { |
Jens Axboe | ee6e00c | 2020-10-22 14:15:51 -0600 | [diff] [blame] | 1586 | error = __do_splice(in.file, off_in, out.file, off_out, |
| 1587 | len, flags); |
Pavel Begunkov | 90da2e3 | 2020-05-04 22:39:35 +0300 | [diff] [blame] | 1588 | fdput(out); |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 1589 | } |
Al Viro | 2903ff0 | 2012-08-28 12:52:22 -0400 | [diff] [blame] | 1590 | fdput(in); |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 1591 | } |
Jens Axboe | 5274f05 | 2006-03-30 15:15:30 +0200 | [diff] [blame] | 1592 | return error; |
| 1593 | } |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1594 | |
| 1595 | /* |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1596 | * Make sure there's data to read. Wait for input if we can, otherwise |
| 1597 | * return an appropriate error. |
| 1598 | */ |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1599 | static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags) |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1600 | { |
| 1601 | int ret; |
| 1602 | |
| 1603 | /* |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1604 | * Check the pipe occupancy without the inode lock first. This function |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1605 | * is speculative anyways, so missing one is ok. |
| 1606 | */ |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1607 | if (!pipe_empty(pipe->head, pipe->tail)) |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1608 | return 0; |
| 1609 | |
| 1610 | ret = 0; |
Miklos Szeredi | 61e0d47 | 2009-04-14 19:48:41 +0200 | [diff] [blame] | 1611 | pipe_lock(pipe); |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1612 | |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1613 | while (pipe_empty(pipe->head, pipe->tail)) { |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1614 | if (signal_pending(current)) { |
| 1615 | ret = -ERESTARTSYS; |
| 1616 | break; |
| 1617 | } |
| 1618 | if (!pipe->writers) |
| 1619 | break; |
Linus Torvalds | a28c8b9 | 2019-12-07 13:21:01 -0800 | [diff] [blame] | 1620 | if (flags & SPLICE_F_NONBLOCK) { |
| 1621 | ret = -EAGAIN; |
| 1622 | break; |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1623 | } |
Linus Torvalds | 472e5b0 | 2020-10-01 19:14:36 -0700 | [diff] [blame] | 1624 | pipe_wait_readable(pipe); |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1625 | } |
| 1626 | |
Miklos Szeredi | 61e0d47 | 2009-04-14 19:48:41 +0200 | [diff] [blame] | 1627 | pipe_unlock(pipe); |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1628 | return ret; |
| 1629 | } |
| 1630 | |
| 1631 | /* |
| 1632 | * Make sure there's writeable room. Wait for room if we can, otherwise |
| 1633 | * return an appropriate error. |
| 1634 | */ |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1635 | static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags) |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1636 | { |
| 1637 | int ret; |
| 1638 | |
| 1639 | /* |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1640 | * Check pipe occupancy without the inode lock first. This function |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1641 | * is speculative anyways, so missing one is ok. |
| 1642 | */ |
Tetsuo Handa | 566d136 | 2020-05-20 08:51:59 +0900 | [diff] [blame] | 1643 | if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage)) |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1644 | return 0; |
| 1645 | |
| 1646 | ret = 0; |
Miklos Szeredi | 61e0d47 | 2009-04-14 19:48:41 +0200 | [diff] [blame] | 1647 | pipe_lock(pipe); |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1648 | |
David Howells | 6718b6f | 2019-10-16 16:47:32 +0100 | [diff] [blame] | 1649 | while (pipe_full(pipe->head, pipe->tail, pipe->max_usage)) { |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1650 | if (!pipe->readers) { |
| 1651 | send_sig(SIGPIPE, current, 0); |
| 1652 | ret = -EPIPE; |
| 1653 | break; |
| 1654 | } |
| 1655 | if (flags & SPLICE_F_NONBLOCK) { |
| 1656 | ret = -EAGAIN; |
| 1657 | break; |
| 1658 | } |
| 1659 | if (signal_pending(current)) { |
| 1660 | ret = -ERESTARTSYS; |
| 1661 | break; |
| 1662 | } |
Linus Torvalds | 472e5b0 | 2020-10-01 19:14:36 -0700 | [diff] [blame] | 1663 | pipe_wait_writable(pipe); |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1664 | } |
| 1665 | |
Miklos Szeredi | 61e0d47 | 2009-04-14 19:48:41 +0200 | [diff] [blame] | 1666 | pipe_unlock(pipe); |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1667 | return ret; |
| 1668 | } |
| 1669 | |
| 1670 | /* |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1671 | * Splice contents of ipipe to opipe. |
| 1672 | */ |
| 1673 | static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe, |
| 1674 | struct pipe_inode_info *opipe, |
| 1675 | size_t len, unsigned int flags) |
| 1676 | { |
| 1677 | struct pipe_buffer *ibuf, *obuf; |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1678 | unsigned int i_head, o_head; |
| 1679 | unsigned int i_tail, o_tail; |
| 1680 | unsigned int i_mask, o_mask; |
| 1681 | int ret = 0; |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1682 | bool input_wakeup = false; |
| 1683 | |
| 1684 | |
| 1685 | retry: |
| 1686 | ret = ipipe_prep(ipipe, flags); |
| 1687 | if (ret) |
| 1688 | return ret; |
| 1689 | |
| 1690 | ret = opipe_prep(opipe, flags); |
| 1691 | if (ret) |
| 1692 | return ret; |
| 1693 | |
| 1694 | /* |
| 1695 | * Potential ABBA deadlock, work around it by ordering lock |
| 1696 | * grabbing by pipe info address. Otherwise two different processes |
| 1697 | * could deadlock (one doing tee from A -> B, the other from B -> A). |
| 1698 | */ |
| 1699 | pipe_double_lock(ipipe, opipe); |
| 1700 | |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1701 | i_tail = ipipe->tail; |
| 1702 | i_mask = ipipe->ring_size - 1; |
| 1703 | o_head = opipe->head; |
| 1704 | o_mask = opipe->ring_size - 1; |
| 1705 | |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1706 | do { |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1707 | size_t o_len; |
| 1708 | |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1709 | if (!opipe->readers) { |
| 1710 | send_sig(SIGPIPE, current, 0); |
| 1711 | if (!ret) |
| 1712 | ret = -EPIPE; |
| 1713 | break; |
| 1714 | } |
| 1715 | |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1716 | i_head = ipipe->head; |
| 1717 | o_tail = opipe->tail; |
| 1718 | |
| 1719 | if (pipe_empty(i_head, i_tail) && !ipipe->writers) |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1720 | break; |
| 1721 | |
| 1722 | /* |
| 1723 | * Cannot make any progress, because either the input |
| 1724 | * pipe is empty or the output pipe is full. |
| 1725 | */ |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1726 | if (pipe_empty(i_head, i_tail) || |
David Howells | 6718b6f | 2019-10-16 16:47:32 +0100 | [diff] [blame] | 1727 | pipe_full(o_head, o_tail, opipe->max_usage)) { |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1728 | /* Already processed some buffers, break */ |
| 1729 | if (ret) |
| 1730 | break; |
| 1731 | |
| 1732 | if (flags & SPLICE_F_NONBLOCK) { |
| 1733 | ret = -EAGAIN; |
| 1734 | break; |
| 1735 | } |
| 1736 | |
| 1737 | /* |
| 1738 | * We raced with another reader/writer and haven't |
| 1739 | * managed to process any buffers. A zero return |
| 1740 | * value means EOF, so retry instead. |
| 1741 | */ |
| 1742 | pipe_unlock(ipipe); |
| 1743 | pipe_unlock(opipe); |
| 1744 | goto retry; |
| 1745 | } |
| 1746 | |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1747 | ibuf = &ipipe->bufs[i_tail & i_mask]; |
| 1748 | obuf = &opipe->bufs[o_head & o_mask]; |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1749 | |
| 1750 | if (len >= ibuf->len) { |
| 1751 | /* |
| 1752 | * Simply move the whole buffer from ipipe to opipe |
| 1753 | */ |
| 1754 | *obuf = *ibuf; |
| 1755 | ibuf->ops = NULL; |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1756 | i_tail++; |
| 1757 | ipipe->tail = i_tail; |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1758 | input_wakeup = true; |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1759 | o_len = obuf->len; |
| 1760 | o_head++; |
| 1761 | opipe->head = o_head; |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1762 | } else { |
| 1763 | /* |
| 1764 | * Get a reference to this pipe buffer, |
| 1765 | * so we can copy the contents over. |
| 1766 | */ |
Matthew Wilcox | 15fab63 | 2019-04-05 14:02:10 -0700 | [diff] [blame] | 1767 | if (!pipe_buf_get(ipipe, ibuf)) { |
| 1768 | if (ret == 0) |
| 1769 | ret = -EFAULT; |
| 1770 | break; |
| 1771 | } |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1772 | *obuf = *ibuf; |
| 1773 | |
| 1774 | /* |
Christoph Hellwig | f6dd975 | 2020-05-20 17:58:12 +0200 | [diff] [blame] | 1775 | * Don't inherit the gift and merge flags, we need to |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1776 | * prevent multiple steals of this page. |
| 1777 | */ |
| 1778 | obuf->flags &= ~PIPE_BUF_FLAG_GIFT; |
Christoph Hellwig | f6dd975 | 2020-05-20 17:58:12 +0200 | [diff] [blame] | 1779 | obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE; |
Jann Horn | a0ce2f0 | 2019-01-23 15:19:17 +0100 | [diff] [blame] | 1780 | |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1781 | obuf->len = len; |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1782 | ibuf->offset += len; |
| 1783 | ibuf->len -= len; |
| 1784 | o_len = len; |
| 1785 | o_head++; |
| 1786 | opipe->head = o_head; |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1787 | } |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1788 | ret += o_len; |
| 1789 | len -= o_len; |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1790 | } while (len); |
| 1791 | |
| 1792 | pipe_unlock(ipipe); |
| 1793 | pipe_unlock(opipe); |
| 1794 | |
| 1795 | /* |
| 1796 | * If we put data in the output pipe, wakeup any potential readers. |
| 1797 | */ |
Namhyung Kim | 825cdcb | 2011-05-23 19:58:53 +0200 | [diff] [blame] | 1798 | if (ret > 0) |
| 1799 | wakeup_pipe_readers(opipe); |
| 1800 | |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1801 | if (input_wakeup) |
| 1802 | wakeup_pipe_writers(ipipe); |
| 1803 | |
| 1804 | return ret; |
| 1805 | } |
| 1806 | |
| 1807 | /* |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1808 | * Link contents of ipipe to opipe. |
| 1809 | */ |
| 1810 | static int link_pipe(struct pipe_inode_info *ipipe, |
| 1811 | struct pipe_inode_info *opipe, |
| 1812 | size_t len, unsigned int flags) |
| 1813 | { |
| 1814 | struct pipe_buffer *ibuf, *obuf; |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1815 | unsigned int i_head, o_head; |
| 1816 | unsigned int i_tail, o_tail; |
| 1817 | unsigned int i_mask, o_mask; |
| 1818 | int ret = 0; |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1819 | |
| 1820 | /* |
| 1821 | * Potential ABBA deadlock, work around it by ordering lock |
Miklos Szeredi | 61e0d47 | 2009-04-14 19:48:41 +0200 | [diff] [blame] | 1822 | * grabbing by pipe info address. Otherwise two different processes |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1823 | * could deadlock (one doing tee from A -> B, the other from B -> A). |
| 1824 | */ |
Miklos Szeredi | 61e0d47 | 2009-04-14 19:48:41 +0200 | [diff] [blame] | 1825 | pipe_double_lock(ipipe, opipe); |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1826 | |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1827 | i_tail = ipipe->tail; |
| 1828 | i_mask = ipipe->ring_size - 1; |
| 1829 | o_head = opipe->head; |
| 1830 | o_mask = opipe->ring_size - 1; |
| 1831 | |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1832 | do { |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1833 | if (!opipe->readers) { |
| 1834 | send_sig(SIGPIPE, current, 0); |
| 1835 | if (!ret) |
| 1836 | ret = -EPIPE; |
| 1837 | break; |
| 1838 | } |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1839 | |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1840 | i_head = ipipe->head; |
| 1841 | o_tail = opipe->tail; |
| 1842 | |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1843 | /* |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1844 | * If we have iterated all input buffers or run out of |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1845 | * output room, break. |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1846 | */ |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1847 | if (pipe_empty(i_head, i_tail) || |
David Howells | 6718b6f | 2019-10-16 16:47:32 +0100 | [diff] [blame] | 1848 | pipe_full(o_head, o_tail, opipe->max_usage)) |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1849 | break; |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1850 | |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1851 | ibuf = &ipipe->bufs[i_tail & i_mask]; |
| 1852 | obuf = &opipe->bufs[o_head & o_mask]; |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1853 | |
Jens Axboe | 2a27250e | 2006-04-19 15:56:40 +0200 | [diff] [blame] | 1854 | /* |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1855 | * Get a reference to this pipe buffer, |
| 1856 | * so we can copy the contents over. |
Jens Axboe | 2a27250e | 2006-04-19 15:56:40 +0200 | [diff] [blame] | 1857 | */ |
Matthew Wilcox | 15fab63 | 2019-04-05 14:02:10 -0700 | [diff] [blame] | 1858 | if (!pipe_buf_get(ipipe, ibuf)) { |
| 1859 | if (ret == 0) |
| 1860 | ret = -EFAULT; |
| 1861 | break; |
| 1862 | } |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1863 | |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1864 | *obuf = *ibuf; |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1865 | |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1866 | /* |
Christoph Hellwig | f6dd975 | 2020-05-20 17:58:12 +0200 | [diff] [blame] | 1867 | * Don't inherit the gift and merge flag, we need to prevent |
| 1868 | * multiple steals of this page. |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1869 | */ |
| 1870 | obuf->flags &= ~PIPE_BUF_FLAG_GIFT; |
Christoph Hellwig | f6dd975 | 2020-05-20 17:58:12 +0200 | [diff] [blame] | 1871 | obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE; |
Jann Horn | a0ce2f0 | 2019-01-23 15:19:17 +0100 | [diff] [blame] | 1872 | |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1873 | if (obuf->len > len) |
| 1874 | obuf->len = len; |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1875 | ret += obuf->len; |
| 1876 | len -= obuf->len; |
David Howells | 8cefc10 | 2019-11-15 13:30:32 +0000 | [diff] [blame] | 1877 | |
| 1878 | o_head++; |
| 1879 | opipe->head = o_head; |
| 1880 | i_tail++; |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1881 | } while (len); |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1882 | |
Miklos Szeredi | 61e0d47 | 2009-04-14 19:48:41 +0200 | [diff] [blame] | 1883 | pipe_unlock(ipipe); |
| 1884 | pipe_unlock(opipe); |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1885 | |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1886 | /* |
| 1887 | * If we put data in the output pipe, wakeup any potential readers. |
| 1888 | */ |
Namhyung Kim | 825cdcb | 2011-05-23 19:58:53 +0200 | [diff] [blame] | 1889 | if (ret > 0) |
| 1890 | wakeup_pipe_readers(opipe); |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1891 | |
| 1892 | return ret; |
| 1893 | } |
| 1894 | |
| 1895 | /* |
| 1896 | * This is a tee(1) implementation that works on pipes. It doesn't copy |
| 1897 | * any data, it simply references the 'in' pages on the 'out' pipe. |
| 1898 | * The 'flags' used are the SPLICE_F_* variants, currently the only |
| 1899 | * applicable one is SPLICE_F_NONBLOCK. |
| 1900 | */ |
Pavel Begunkov | 9dafdfc | 2020-05-17 14:18:05 +0300 | [diff] [blame] | 1901 | long do_tee(struct file *in, struct file *out, size_t len, unsigned int flags) |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1902 | { |
David Howells | c73be61 | 2020-01-14 17:07:11 +0000 | [diff] [blame] | 1903 | struct pipe_inode_info *ipipe = get_pipe_info(in, true); |
| 1904 | struct pipe_inode_info *opipe = get_pipe_info(out, true); |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1905 | int ret = -EINVAL; |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1906 | |
Pavel Begunkov | 90da2e3 | 2020-05-04 22:39:35 +0300 | [diff] [blame] | 1907 | if (unlikely(!(in->f_mode & FMODE_READ) || |
| 1908 | !(out->f_mode & FMODE_WRITE))) |
| 1909 | return -EBADF; |
| 1910 | |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1911 | /* |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1912 | * Duplicate the contents of ipipe to opipe without actually |
| 1913 | * copying the data. |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1914 | */ |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1915 | if (ipipe && opipe && ipipe != opipe) { |
Slavomir Kaslev | ee5e001 | 2019-02-07 17:45:19 +0200 | [diff] [blame] | 1916 | if ((in->f_flags | out->f_flags) & O_NONBLOCK) |
| 1917 | flags |= SPLICE_F_NONBLOCK; |
| 1918 | |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1919 | /* |
| 1920 | * Keep going, unless we encounter an error. The ipipe/opipe |
| 1921 | * ordering doesn't really matter. |
| 1922 | */ |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1923 | ret = ipipe_prep(ipipe, flags); |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1924 | if (!ret) { |
Miklos Szeredi | 7c77f0b | 2009-05-07 15:37:35 +0200 | [diff] [blame] | 1925 | ret = opipe_prep(opipe, flags); |
Jens Axboe | 02cf01a | 2008-02-20 10:34:51 +0100 | [diff] [blame] | 1926 | if (!ret) |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1927 | ret = link_pipe(ipipe, opipe, len, flags); |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1928 | } |
| 1929 | } |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1930 | |
Ahelenia ZiemiaĆska | 576d498 | 2023-07-03 16:42:21 +0200 | [diff] [blame] | 1931 | if (ret > 0) { |
| 1932 | fsnotify_access(in); |
| 1933 | fsnotify_modify(out); |
| 1934 | } |
| 1935 | |
Jens Axboe | aadd06e | 2006-07-10 11:00:01 +0200 | [diff] [blame] | 1936 | return ret; |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1937 | } |
| 1938 | |
Heiko Carstens | 836f92a | 2009-01-14 14:14:33 +0100 | [diff] [blame] | 1939 | SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags) |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1940 | { |
Pavel Begunkov | 90da2e3 | 2020-05-04 22:39:35 +0300 | [diff] [blame] | 1941 | struct fd in, out; |
Al Viro | 2903ff0 | 2012-08-28 12:52:22 -0400 | [diff] [blame] | 1942 | int error; |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1943 | |
Al Viro | 3d6ea29 | 2016-12-10 13:17:32 -0500 | [diff] [blame] | 1944 | if (unlikely(flags & ~SPLICE_F_ALL)) |
| 1945 | return -EINVAL; |
| 1946 | |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1947 | if (unlikely(!len)) |
| 1948 | return 0; |
| 1949 | |
| 1950 | error = -EBADF; |
Al Viro | 2903ff0 | 2012-08-28 12:52:22 -0400 | [diff] [blame] | 1951 | in = fdget(fdin); |
| 1952 | if (in.file) { |
Pavel Begunkov | 90da2e3 | 2020-05-04 22:39:35 +0300 | [diff] [blame] | 1953 | out = fdget(fdout); |
| 1954 | if (out.file) { |
| 1955 | error = do_tee(in.file, out.file, len, flags); |
| 1956 | fdput(out); |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1957 | } |
Al Viro | 2903ff0 | 2012-08-28 12:52:22 -0400 | [diff] [blame] | 1958 | fdput(in); |
Jens Axboe | 7052449 | 2006-04-11 15:51:17 +0200 | [diff] [blame] | 1959 | } |
| 1960 | |
| 1961 | return error; |
| 1962 | } |