]>
Commit | Line | Data |
---|---|---|
457c8996 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
5274f052 JA |
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 | |
c2058e06 JA |
13 | * Jens to support splicing to files, network, direct splicing, etc and |
14 | * fixing lots of bugs. | |
5274f052 | 15 | * |
0fe23479 | 16 | * Copyright (C) 2005-2006 Jens Axboe <[email protected]> |
c2058e06 JA |
17 | * Copyright (C) 2005-2006 Linus Torvalds <[email protected]> |
18 | * Copyright (C) 2006 Ingo Molnar <[email protected]> | |
5274f052 JA |
19 | * |
20 | */ | |
be297968 | 21 | #include <linux/bvec.h> |
5274f052 JA |
22 | #include <linux/fs.h> |
23 | #include <linux/file.h> | |
24 | #include <linux/pagemap.h> | |
d6b29d7c | 25 | #include <linux/splice.h> |
08e552c6 | 26 | #include <linux/memcontrol.h> |
5274f052 | 27 | #include <linux/mm_inline.h> |
5abc97aa | 28 | #include <linux/swap.h> |
4f6f0bd2 | 29 | #include <linux/writeback.h> |
630d9c47 | 30 | #include <linux/export.h> |
4f6f0bd2 | 31 | #include <linux/syscalls.h> |
912d35f8 | 32 | #include <linux/uio.h> |
983652c6 | 33 | #include <linux/fsnotify.h> |
29ce2058 | 34 | #include <linux/security.h> |
5a0e3ad6 | 35 | #include <linux/gfp.h> |
2dc334f1 | 36 | #include <linux/net.h> |
35f9c09f | 37 | #include <linux/socket.h> |
174cd4b1 IM |
38 | #include <linux/sched/signal.h> |
39 | ||
06ae43f3 | 40 | #include "internal.h" |
5274f052 | 41 | |
0f99fc51 JA |
42 | /* |
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 | ||
83f9135b JA |
58 | /* |
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 | */ | |
c928f642 CH |
64 | static bool page_cache_pipe_buf_try_steal(struct pipe_inode_info *pipe, |
65 | struct pipe_buffer *buf) | |
5abc97aa | 66 | { |
5100da38 | 67 | struct folio *folio = page_folio(buf->page); |
9e94cd4f | 68 | struct address_space *mapping; |
5abc97aa | 69 | |
b9ccad2e | 70 | folio_lock(folio); |
9e0267c2 | 71 | |
b9ccad2e | 72 | mapping = folio_mapping(folio); |
9e94cd4f | 73 | if (mapping) { |
b9ccad2e | 74 | WARN_ON(!folio_test_uptodate(folio)); |
5abc97aa | 75 | |
9e94cd4f JA |
76 | /* |
77 | * At least for ext2 with nobh option, we need to wait on | |
b9ccad2e | 78 | * writeback completing on this folio, since we'll remove it |
9e94cd4f | 79 | * from the pagecache. Otherwise truncate wont wait on the |
b9ccad2e | 80 | * folio, allowing the disk blocks to be reused by someone else |
9e94cd4f JA |
81 | * before we actually wrote our data to them. fs corruption |
82 | * ensues. | |
83 | */ | |
b9ccad2e | 84 | folio_wait_writeback(folio); |
ad8d6f0a | 85 | |
0201ebf2 | 86 | if (!filemap_release_folio(folio, GFP_KERNEL)) |
ca39d651 | 87 | goto out_unlock; |
4f6f0bd2 | 88 | |
9e94cd4f JA |
89 | /* |
90 | * If we succeeded in removing the mapping, set LRU flag | |
91 | * and return good. | |
92 | */ | |
5100da38 | 93 | if (remove_mapping(mapping, folio)) { |
9e94cd4f | 94 | buf->flags |= PIPE_BUF_FLAG_LRU; |
c928f642 | 95 | return true; |
9e94cd4f | 96 | } |
9e0267c2 | 97 | } |
5abc97aa | 98 | |
9e94cd4f | 99 | /* |
b9ccad2e | 100 | * Raced with truncate or failed to remove folio from current |
9e94cd4f JA |
101 | * address space, unlock and return failure. |
102 | */ | |
ca39d651 | 103 | out_unlock: |
b9ccad2e | 104 | folio_unlock(folio); |
c928f642 | 105 | return false; |
5abc97aa JA |
106 | } |
107 | ||
76ad4d11 | 108 | static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe, |
5274f052 JA |
109 | struct pipe_buffer *buf) |
110 | { | |
09cbfeaf | 111 | put_page(buf->page); |
1432873a | 112 | buf->flags &= ~PIPE_BUF_FLAG_LRU; |
5274f052 JA |
113 | } |
114 | ||
0845718d JA |
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 | */ | |
cac36bb0 JA |
119 | static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe, |
120 | struct pipe_buffer *buf) | |
5274f052 | 121 | { |
781ca602 | 122 | struct folio *folio = page_folio(buf->page); |
49d0b21b | 123 | int err; |
5274f052 | 124 | |
781ca602 MWO |
125 | if (!folio_test_uptodate(folio)) { |
126 | folio_lock(folio); | |
49d0b21b JA |
127 | |
128 | /* | |
781ca602 | 129 | * Folio got truncated/unhashed. This will cause a 0-byte |
73d62d83 | 130 | * splice, if this is the first page. |
49d0b21b | 131 | */ |
781ca602 | 132 | if (!folio->mapping) { |
49d0b21b JA |
133 | err = -ENODATA; |
134 | goto error; | |
135 | } | |
5274f052 | 136 | |
49d0b21b | 137 | /* |
73d62d83 | 138 | * Uh oh, read-error from disk. |
49d0b21b | 139 | */ |
781ca602 | 140 | if (!folio_test_uptodate(folio)) { |
49d0b21b JA |
141 | err = -EIO; |
142 | goto error; | |
143 | } | |
144 | ||
781ca602 MWO |
145 | /* Folio is ok after all, we are done */ |
146 | folio_unlock(folio); | |
5274f052 JA |
147 | } |
148 | ||
f84d7519 | 149 | return 0; |
49d0b21b | 150 | error: |
781ca602 | 151 | folio_unlock(folio); |
f84d7519 | 152 | return err; |
70524490 JA |
153 | } |
154 | ||
708e3508 | 155 | const struct pipe_buf_operations page_cache_pipe_buf_ops = { |
c928f642 CH |
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, | |
5274f052 JA |
160 | }; |
161 | ||
c928f642 CH |
162 | static bool user_page_pipe_buf_try_steal(struct pipe_inode_info *pipe, |
163 | struct pipe_buffer *buf) | |
912d35f8 | 164 | { |
7afa6fd0 | 165 | if (!(buf->flags & PIPE_BUF_FLAG_GIFT)) |
c928f642 | 166 | return false; |
7afa6fd0 | 167 | |
1432873a | 168 | buf->flags |= PIPE_BUF_FLAG_LRU; |
c928f642 | 169 | return generic_pipe_buf_try_steal(pipe, buf); |
912d35f8 JA |
170 | } |
171 | ||
d4c3cca9 | 172 | static const struct pipe_buf_operations user_page_pipe_buf_ops = { |
c928f642 CH |
173 | .release = page_cache_pipe_buf_release, |
174 | .try_steal = user_page_pipe_buf_try_steal, | |
175 | .get = generic_pipe_buf_get, | |
912d35f8 JA |
176 | }; |
177 | ||
825cdcb1 NK |
178 | static void wakeup_pipe_readers(struct pipe_inode_info *pipe) |
179 | { | |
180 | smp_mb(); | |
0ddad21d LT |
181 | if (waitqueue_active(&pipe->rd_wait)) |
182 | wake_up_interruptible(&pipe->rd_wait); | |
825cdcb1 NK |
183 | kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN); |
184 | } | |
185 | ||
932cc6d4 JA |
186 | /** |
187 | * splice_to_pipe - fill passed data into a pipe | |
188 | * @pipe: pipe to fill | |
189 | * @spd: data to fill | |
190 | * | |
191 | * Description: | |
79685b8d | 192 | * @spd contains a map of pages and len/offset tuples, along with |
932cc6d4 JA |
193 | * the struct pipe_buf_operations associated with these pages. This |
194 | * function will link that data to the pipe. | |
195 | * | |
83f9135b | 196 | */ |
d6b29d7c JA |
197 | ssize_t splice_to_pipe(struct pipe_inode_info *pipe, |
198 | struct splice_pipe_desc *spd) | |
5274f052 | 199 | { |
00de00bd | 200 | unsigned int spd_pages = spd->nr_pages; |
8cefc107 DH |
201 | unsigned int tail = pipe->tail; |
202 | unsigned int head = pipe->head; | |
203 | unsigned int mask = pipe->ring_size - 1; | |
8924feff | 204 | int ret = 0, page_nr = 0; |
5274f052 | 205 | |
d6785d91 RV |
206 | if (!spd_pages) |
207 | return 0; | |
208 | ||
8924feff AV |
209 | if (unlikely(!pipe->readers)) { |
210 | send_sig(SIGPIPE, current, 0); | |
211 | ret = -EPIPE; | |
212 | goto out; | |
213 | } | |
5274f052 | 214 | |
6718b6f8 | 215 | while (!pipe_full(head, tail, pipe->max_usage)) { |
8cefc107 | 216 | struct pipe_buffer *buf = &pipe->bufs[head & mask]; |
5274f052 | 217 | |
8924feff AV |
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; | |
5a81e6a1 | 223 | buf->flags = 0; |
5274f052 | 224 | |
8cefc107 DH |
225 | head++; |
226 | pipe->head = head; | |
8924feff AV |
227 | page_nr++; |
228 | ret += buf->len; | |
29e35094 | 229 | |
8924feff | 230 | if (!--spd->nr_pages) |
5274f052 | 231 | break; |
5274f052 JA |
232 | } |
233 | ||
8924feff AV |
234 | if (!ret) |
235 | ret = -EAGAIN; | |
5274f052 | 236 | |
8924feff | 237 | out: |
00de00bd | 238 | while (page_nr < spd_pages) |
bbdfc2f7 | 239 | spd->spd_release(spd, page_nr++); |
5274f052 JA |
240 | |
241 | return ret; | |
242 | } | |
2b514574 | 243 | EXPORT_SYMBOL_GPL(splice_to_pipe); |
5274f052 | 244 | |
79fddc4e AV |
245 | ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf) |
246 | { | |
8cefc107 DH |
247 | unsigned int head = pipe->head; |
248 | unsigned int tail = pipe->tail; | |
249 | unsigned int mask = pipe->ring_size - 1; | |
79fddc4e AV |
250 | int ret; |
251 | ||
252 | if (unlikely(!pipe->readers)) { | |
253 | send_sig(SIGPIPE, current, 0); | |
254 | ret = -EPIPE; | |
6718b6f8 | 255 | } else if (pipe_full(head, tail, pipe->max_usage)) { |
79fddc4e AV |
256 | ret = -EAGAIN; |
257 | } else { | |
8cefc107 DH |
258 | pipe->bufs[head & mask] = *buf; |
259 | pipe->head = head + 1; | |
79fddc4e AV |
260 | return buf->len; |
261 | } | |
a779638c | 262 | pipe_buf_release(pipe, buf); |
79fddc4e AV |
263 | return ret; |
264 | } | |
265 | EXPORT_SYMBOL(add_to_pipe); | |
266 | ||
35f3d14d JA |
267 | /* |
268 | * Check if we need to grow the arrays holding pages and partial page | |
269 | * descriptions. | |
270 | */ | |
047fe360 | 271 | int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd) |
35f3d14d | 272 | { |
6718b6f8 | 273 | unsigned int max_usage = READ_ONCE(pipe->max_usage); |
047fe360 | 274 | |
8cefc107 DH |
275 | spd->nr_pages_max = max_usage; |
276 | if (max_usage <= PIPE_DEF_BUFFERS) | |
35f3d14d JA |
277 | return 0; |
278 | ||
8cefc107 DH |
279 | spd->pages = kmalloc_array(max_usage, sizeof(struct page *), GFP_KERNEL); |
280 | spd->partial = kmalloc_array(max_usage, sizeof(struct partial_page), | |
6da2ec56 | 281 | GFP_KERNEL); |
35f3d14d JA |
282 | |
283 | if (spd->pages && spd->partial) | |
284 | return 0; | |
285 | ||
286 | kfree(spd->pages); | |
287 | kfree(spd->partial); | |
288 | return -ENOMEM; | |
289 | } | |
290 | ||
047fe360 | 291 | void splice_shrink_spd(struct splice_pipe_desc *spd) |
35f3d14d | 292 | { |
047fe360 | 293 | if (spd->nr_pages_max <= PIPE_DEF_BUFFERS) |
35f3d14d JA |
294 | return; |
295 | ||
296 | kfree(spd->pages); | |
297 | kfree(spd->partial); | |
298 | } | |
299 | ||
9eee8bd8 DH |
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. | |
33b3b041 | 319 | */ |
69df79a4 DH |
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) | |
33b3b041 DH |
323 | { |
324 | struct iov_iter to; | |
325 | struct bio_vec *bv; | |
326 | struct kiocb kiocb; | |
327 | struct page **pages; | |
328 | ssize_t ret; | |
e69f37bc | 329 | size_t used, npages, chunk, remain, keep = 0; |
33b3b041 DH |
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 | ||
e69f37bc | 343 | pages = (struct page **)(bv + npages); |
33b3b041 DH |
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 | ||
33b3b041 | 366 | if (ret > 0) { |
e69f37bc | 367 | keep = DIV_ROUND_UP(ret, PAGE_SIZE); |
33b3b041 | 368 | *ppos = kiocb.ki_pos; |
33b3b041 DH |
369 | } |
370 | ||
2e82f6c3 CH |
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 | ||
33b3b041 | 378 | /* Free any pages that didn't get touched at all. */ |
e69f37bc DH |
379 | if (keep < npages) |
380 | release_pages(pages + keep, npages - keep); | |
33b3b041 DH |
381 | |
382 | /* Push the remaining pages into the pipe. */ | |
e69f37bc DH |
383 | remain = ret; |
384 | for (i = 0; i < keep; i++) { | |
33b3b041 DH |
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 | } | |
69df79a4 | 401 | EXPORT_SYMBOL(copy_splice_read); |
33b3b041 | 402 | |
241699cd | 403 | const struct pipe_buf_operations default_pipe_buf_ops = { |
c928f642 CH |
404 | .release = generic_pipe_buf_release, |
405 | .try_steal = generic_pipe_buf_try_steal, | |
406 | .get = generic_pipe_buf_get, | |
6818173b MS |
407 | }; |
408 | ||
28a625cb MS |
409 | /* Pipe buffer operations for a socket and similar. */ |
410 | const struct pipe_buf_operations nosteal_pipe_buf_ops = { | |
c928f642 CH |
411 | .release = generic_pipe_buf_release, |
412 | .get = generic_pipe_buf_get, | |
28a625cb MS |
413 | }; |
414 | EXPORT_SYMBOL(nosteal_pipe_buf_ops); | |
415 | ||
b3c2d2dd MS |
416 | static void wakeup_pipe_writers(struct pipe_inode_info *pipe) |
417 | { | |
418 | smp_mb(); | |
0ddad21d LT |
419 | if (waitqueue_active(&pipe->wr_wait)) |
420 | wake_up_interruptible(&pipe->wr_wait); | |
b3c2d2dd MS |
421 | kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT); |
422 | } | |
423 | ||
932cc6d4 | 424 | /** |
b3c2d2dd | 425 | * splice_from_pipe_feed - feed available data from a pipe to a file |
932cc6d4 JA |
426 | * @pipe: pipe to splice from |
427 | * @sd: information to @actor | |
428 | * @actor: handler that splices the data | |
429 | * | |
430 | * Description: | |
b3c2d2dd MS |
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. | |
932cc6d4 | 438 | * |
b3c2d2dd MS |
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. | |
83f9135b | 443 | */ |
96f9bc8f | 444 | static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd, |
b3c2d2dd | 445 | splice_actor *actor) |
5274f052 | 446 | { |
8cefc107 DH |
447 | unsigned int head = pipe->head; |
448 | unsigned int tail = pipe->tail; | |
449 | unsigned int mask = pipe->ring_size - 1; | |
b3c2d2dd | 450 | int ret; |
5274f052 | 451 | |
ec057595 | 452 | while (!pipe_empty(head, tail)) { |
8cefc107 | 453 | struct pipe_buffer *buf = &pipe->bufs[tail & mask]; |
5274f052 | 454 | |
b3c2d2dd MS |
455 | sd->len = buf->len; |
456 | if (sd->len > sd->total_len) | |
457 | sd->len = sd->total_len; | |
5274f052 | 458 | |
fba597db | 459 | ret = pipe_buf_confirm(pipe, buf); |
a8adbe37 | 460 | if (unlikely(ret)) { |
b3c2d2dd MS |
461 | if (ret == -ENODATA) |
462 | ret = 0; | |
463 | return ret; | |
464 | } | |
a8adbe37 MM |
465 | |
466 | ret = actor(pipe, buf, sd); | |
467 | if (ret <= 0) | |
468 | return ret; | |
469 | ||
b3c2d2dd MS |
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) { | |
a779638c | 479 | pipe_buf_release(pipe, buf); |
8cefc107 DH |
480 | tail++; |
481 | pipe->tail = tail; | |
6447a3cf | 482 | if (pipe->files) |
b3c2d2dd MS |
483 | sd->need_wakeup = true; |
484 | } | |
5274f052 | 485 | |
b3c2d2dd MS |
486 | if (!sd->total_len) |
487 | return 0; | |
488 | } | |
5274f052 | 489 | |
b3c2d2dd MS |
490 | return 1; |
491 | } | |
5274f052 | 492 | |
d1a819a2 LT |
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 | ||
b3c2d2dd MS |
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 | */ | |
96f9bc8f | 519 | static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd) |
b3c2d2dd | 520 | { |
c725bfce JK |
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 | ||
d1a819a2 | 528 | repeat: |
8cefc107 | 529 | while (pipe_empty(pipe->head, pipe->tail)) { |
b3c2d2dd MS |
530 | if (!pipe->writers) |
531 | return 0; | |
016b661e | 532 | |
a28c8b9d | 533 | if (sd->num_spliced) |
b3c2d2dd | 534 | return 0; |
73d62d83 | 535 | |
b3c2d2dd MS |
536 | if (sd->flags & SPLICE_F_NONBLOCK) |
537 | return -EAGAIN; | |
5274f052 | 538 | |
b3c2d2dd MS |
539 | if (signal_pending(current)) |
540 | return -ERESTARTSYS; | |
5274f052 | 541 | |
b3c2d2dd MS |
542 | if (sd->need_wakeup) { |
543 | wakeup_pipe_writers(pipe); | |
544 | sd->need_wakeup = false; | |
5274f052 JA |
545 | } |
546 | ||
472e5b05 | 547 | pipe_wait_readable(pipe); |
b3c2d2dd | 548 | } |
29e35094 | 549 | |
d1a819a2 LT |
550 | if (eat_empty_buffer(pipe)) |
551 | goto repeat; | |
552 | ||
b3c2d2dd MS |
553 | return 1; |
554 | } | |
5274f052 | 555 | |
b3c2d2dd MS |
556 | /** |
557 | * splice_from_pipe_begin - start splicing from pipe | |
b80901bb | 558 | * @sd: information about the splice operation |
b3c2d2dd MS |
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 | */ | |
96f9bc8f | 565 | static void splice_from_pipe_begin(struct splice_desc *sd) |
b3c2d2dd MS |
566 | { |
567 | sd->num_spliced = 0; | |
568 | sd->need_wakeup = false; | |
569 | } | |
5274f052 | 570 | |
b3c2d2dd MS |
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 | */ | |
96f9bc8f | 581 | static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd) |
b3c2d2dd MS |
582 | { |
583 | if (sd->need_wakeup) | |
584 | wakeup_pipe_writers(pipe); | |
585 | } | |
5274f052 | 586 | |
b3c2d2dd MS |
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 | |
2dc334f1 | 596 | * the desired destination. See pipe_to_file, pipe_to_sendmsg, or |
b3c2d2dd MS |
597 | * pipe_to_user. |
598 | * | |
599 | */ | |
600 | ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd, | |
601 | splice_actor *actor) | |
602 | { | |
603 | int ret; | |
5274f052 | 604 | |
b3c2d2dd MS |
605 | splice_from_pipe_begin(sd); |
606 | do { | |
c2489e07 | 607 | cond_resched(); |
b3c2d2dd MS |
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); | |
613 | ||
614 | return sd->num_spliced ? sd->num_spliced : ret; | |
5274f052 | 615 | } |
40bee44e | 616 | EXPORT_SYMBOL(__splice_from_pipe); |
5274f052 | 617 | |
932cc6d4 JA |
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: | |
2933970b | 628 | * See __splice_from_pipe. This function locks the pipe inode, |
932cc6d4 JA |
629 | * otherwise it's identical to __splice_from_pipe(). |
630 | * | |
631 | */ | |
6da61809 MF |
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; | |
c66ab6fa JA |
637 | struct splice_desc sd = { |
638 | .total_len = len, | |
639 | .flags = flags, | |
640 | .pos = *ppos, | |
6a14b90b | 641 | .u.file = out, |
c66ab6fa | 642 | }; |
6da61809 | 643 | |
61e0d47c | 644 | pipe_lock(pipe); |
c66ab6fa | 645 | ret = __splice_from_pipe(pipe, &sd, actor); |
61e0d47c | 646 | pipe_unlock(pipe); |
6da61809 MF |
647 | |
648 | return ret; | |
649 | } | |
650 | ||
8d020765 AV |
651 | /** |
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 | }; | |
6718b6f8 | 675 | int nbufs = pipe->max_usage; |
8d020765 AV |
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; | |
ec057595 | 688 | unsigned int head, tail, mask; |
8d020765 | 689 | size_t left; |
8cefc107 | 690 | int n; |
8d020765 AV |
691 | |
692 | ret = splice_from_pipe_next(pipe, &sd); | |
693 | if (ret <= 0) | |
694 | break; | |
695 | ||
6718b6f8 | 696 | if (unlikely(nbufs < pipe->max_usage)) { |
8d020765 | 697 | kfree(array); |
6718b6f8 | 698 | nbufs = pipe->max_usage; |
8d020765 AV |
699 | array = kcalloc(nbufs, sizeof(struct bio_vec), |
700 | GFP_KERNEL); | |
701 | if (!array) { | |
702 | ret = -ENOMEM; | |
703 | break; | |
704 | } | |
705 | } | |
706 | ||
ec057595 LT |
707 | head = pipe->head; |
708 | tail = pipe->tail; | |
709 | mask = pipe->ring_size - 1; | |
710 | ||
8d020765 AV |
711 | /* build the vector */ |
712 | left = sd.total_len; | |
0f1d344f | 713 | for (n = 0; !pipe_empty(head, tail) && left && n < nbufs; tail++) { |
8cefc107 | 714 | struct pipe_buffer *buf = &pipe->bufs[tail & mask]; |
8d020765 AV |
715 | size_t this_len = buf->len; |
716 | ||
0f1d344f PB |
717 | /* zero-length bvecs are not supported, skip them */ |
718 | if (!this_len) | |
719 | continue; | |
720 | this_len = min(this_len, left); | |
8d020765 | 721 | |
fba597db | 722 | ret = pipe_buf_confirm(pipe, buf); |
8d020765 AV |
723 | if (unlikely(ret)) { |
724 | if (ret == -ENODATA) | |
725 | ret = 0; | |
726 | goto done; | |
727 | } | |
728 | ||
664e4078 CH |
729 | bvec_set_page(&array[n], buf->page, this_len, |
730 | buf->offset); | |
8d020765 | 731 | left -= this_len; |
0f1d344f | 732 | n++; |
8d020765 AV |
733 | } |
734 | ||
de4eda9d | 735 | iov_iter_bvec(&from, ITER_SOURCE, array, n, sd.total_len - left); |
abbb6589 | 736 | ret = vfs_iter_write(out, &from, &sd.pos, 0); |
8d020765 AV |
737 | if (ret <= 0) |
738 | break; | |
739 | ||
740 | sd.num_spliced += ret; | |
741 | sd.total_len -= ret; | |
dbe4e192 | 742 | *ppos = sd.pos; |
8d020765 AV |
743 | |
744 | /* dismiss the fully eaten buffers, adjust the partial one */ | |
8cefc107 | 745 | tail = pipe->tail; |
8d020765 | 746 | while (ret) { |
8cefc107 | 747 | struct pipe_buffer *buf = &pipe->bufs[tail & mask]; |
8d020765 | 748 | if (ret >= buf->len) { |
8d020765 AV |
749 | ret -= buf->len; |
750 | buf->len = 0; | |
a779638c | 751 | pipe_buf_release(pipe, buf); |
8cefc107 DH |
752 | tail++; |
753 | pipe->tail = tail; | |
8d020765 AV |
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 | ||
2dc334f1 | 777 | #ifdef CONFIG_NET |
83f9135b | 778 | /** |
2dc334f1 | 779 | * splice_to_socket - splice data from a pipe to a socket |
932cc6d4 | 780 | * @pipe: pipe to splice from |
83f9135b | 781 | * @out: socket to write to |
932cc6d4 | 782 | * @ppos: position in @out |
83f9135b JA |
783 | * @len: number of bytes to splice |
784 | * @flags: splice modifier flags | |
785 | * | |
932cc6d4 JA |
786 | * Description: |
787 | * Will send @len bytes from the pipe to a network socket. No data copying | |
788 | * is involved. | |
83f9135b JA |
789 | * |
790 | */ | |
2dc334f1 DH |
791 | ssize_t splice_to_socket(struct pipe_inode_info *pipe, struct file *out, |
792 | loff_t *ppos, size_t len, unsigned int flags) | |
5274f052 | 793 | { |
2dc334f1 DH |
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; | |
800 | ||
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 | } | |
5274f052 | 851 | |
2dc334f1 | 852 | seg = min_t(size_t, remain, buf->len); |
2dc334f1 DH |
853 | |
854 | ret = pipe_buf_confirm(pipe, buf); | |
855 | if (unlikely(ret)) { | |
856 | if (ret == -ENODATA) | |
857 | ret = 0; | |
858 | break; | |
859 | } | |
5274f052 | 860 | |
2dc334f1 DH |
861 | bvec_set_page(&bvec[bc++], buf->page, seg, buf->offset); |
862 | remain -= seg; | |
ca2d49f7 | 863 | if (remain == 0 || bc >= ARRAY_SIZE(bvec)) |
2dc334f1 | 864 | break; |
ca2d49f7 | 865 | tail++; |
2dc334f1 DH |
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; | |
0f0fa27b JS |
876 | if (out->f_flags & O_NONBLOCK) |
877 | msg.msg_flags |= MSG_DONTWAIT; | |
2dc334f1 DH |
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 | |
a0f06780 | 916 | |
36e2c742 CH |
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 | ||
83f9135b JA |
925 | /* |
926 | * Attempt to initiate a splice from pipe to file. | |
927 | */ | |
3a326a2c | 928 | static long do_splice_from(struct pipe_inode_info *pipe, struct file *out, |
cbb7e577 | 929 | loff_t *ppos, size_t len, unsigned int flags) |
5274f052 | 930 | { |
36e2c742 CH |
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); | |
5274f052 JA |
934 | } |
935 | ||
2bfc6685 DH |
936 | /* |
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 | ||
6a3f30b8 DH |
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. | |
83f9135b | 961 | */ |
6a3f30b8 DH |
962 | long vfs_splice_read(struct file *in, loff_t *ppos, |
963 | struct pipe_inode_info *pipe, size_t len, | |
964 | unsigned int flags) | |
5274f052 | 965 | { |
313d64a3 | 966 | unsigned int p_space; |
5274f052 JA |
967 | int ret; |
968 | ||
49570e9b | 969 | if (unlikely(!(in->f_mode & FMODE_READ))) |
5274f052 | 970 | return -EBADF; |
123856f0 DH |
971 | if (!len) |
972 | return 0; | |
5274f052 | 973 | |
313d64a3 AV |
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 | ||
cbb7e577 | 978 | ret = rw_verify_area(READ, in, ppos, len); |
5274f052 JA |
979 | if (unlikely(ret < 0)) |
980 | return ret; | |
981 | ||
03cc0789 AV |
982 | if (unlikely(len > MAX_RW_COUNT)) |
983 | len = MAX_RW_COUNT; | |
984 | ||
36e2c742 CH |
985 | if (unlikely(!in->f_op->splice_read)) |
986 | return warn_unsupported(in, "read"); | |
aa3dbde8 | 987 | /* |
b85930a0 DH |
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. | |
aa3dbde8 | 990 | */ |
b85930a0 | 991 | if ((in->f_flags & O_DIRECT) || IS_DAX(in->f_mapping->host)) |
aa3dbde8 | 992 | return copy_splice_read(in, ppos, pipe, len, flags); |
36e2c742 | 993 | return in->f_op->splice_read(in, ppos, pipe, len, flags); |
5274f052 | 994 | } |
6a3f30b8 | 995 | EXPORT_SYMBOL_GPL(vfs_splice_read); |
5274f052 | 996 | |
932cc6d4 JA |
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 | |
79685b8d | 1006 | * pipe is cached in the process, and reused during the lifetime of |
932cc6d4 JA |
1007 | * that process. |
1008 | * | |
c66ab6fa JA |
1009 | */ |
1010 | ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd, | |
1011 | splice_direct_actor *actor) | |
b92ce558 JA |
1012 | { |
1013 | struct pipe_inode_info *pipe; | |
1014 | long ret, bytes; | |
c66ab6fa | 1015 | size_t len; |
0ff28d9f | 1016 | int i, flags, more; |
b92ce558 JA |
1017 | |
1018 | /* | |
97ef77c5 JD |
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! | |
b92ce558 | 1022 | */ |
97ef77c5 | 1023 | if (unlikely(!(in->f_mode & FMODE_LSEEK))) |
b92ce558 JA |
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; | |
49570e9b | 1031 | if (unlikely(!pipe)) { |
7bee130e | 1032 | pipe = alloc_pipe_info(); |
b92ce558 JA |
1033 | if (!pipe) |
1034 | return -ENOMEM; | |
1035 | ||
1036 | /* | |
1037 | * We don't have an immediate reader, but we'll read the stuff | |
00522fb4 | 1038 | * out of the pipe right after the splice_to_pipe(). So set |
b92ce558 JA |
1039 | * PIPE_READERS appropriately. |
1040 | */ | |
1041 | pipe->readers = 1; | |
1042 | ||
1043 | current->splice_pipe = pipe; | |
1044 | } | |
1045 | ||
1046 | /* | |
73d62d83 | 1047 | * Do the splice. |
b92ce558 | 1048 | */ |
b92ce558 | 1049 | bytes = 0; |
c66ab6fa | 1050 | len = sd->total_len; |
219d9205 DH |
1051 | |
1052 | /* Don't block on output, we have to drain the direct pipe. */ | |
c66ab6fa | 1053 | flags = sd->flags; |
219d9205 | 1054 | sd->flags &= ~SPLICE_F_NONBLOCK; |
c66ab6fa JA |
1055 | |
1056 | /* | |
219d9205 DH |
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. | |
c66ab6fa | 1059 | */ |
0ff28d9f | 1060 | more = sd->flags & SPLICE_F_MORE; |
219d9205 | 1061 | sd->flags |= SPLICE_F_MORE; |
b92ce558 | 1062 | |
8cefc107 | 1063 | WARN_ON_ONCE(!pipe_empty(pipe->head, pipe->tail)); |
17614445 | 1064 | |
b92ce558 | 1065 | while (len) { |
51a92c0f | 1066 | size_t read_len; |
a82c53a0 | 1067 | loff_t pos = sd->pos, prev_pos = pos; |
b92ce558 | 1068 | |
6a3f30b8 | 1069 | ret = vfs_splice_read(in, &pos, pipe, len, flags); |
51a92c0f | 1070 | if (unlikely(ret <= 0)) |
2bfc6685 | 1071 | goto read_failure; |
b92ce558 JA |
1072 | |
1073 | read_len = ret; | |
c66ab6fa | 1074 | sd->total_len = read_len; |
b92ce558 | 1075 | |
0ff28d9f | 1076 | /* |
219d9205 DH |
1077 | * If we now have sufficient data to fulfill the request then |
1078 | * we clear SPLICE_F_MORE if it was not set initially. | |
0ff28d9f | 1079 | */ |
219d9205 | 1080 | if (read_len >= len && !more) |
0ff28d9f | 1081 | sd->flags &= ~SPLICE_F_MORE; |
219d9205 | 1082 | |
b92ce558 JA |
1083 | /* |
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 | */ | |
c66ab6fa | 1088 | ret = actor(pipe, sd); |
a82c53a0 TZ |
1089 | if (unlikely(ret <= 0)) { |
1090 | sd->pos = prev_pos; | |
b92ce558 | 1091 | goto out_release; |
a82c53a0 | 1092 | } |
b92ce558 JA |
1093 | |
1094 | bytes += ret; | |
1095 | len -= ret; | |
bcd4f3ac | 1096 | sd->pos = pos; |
b92ce558 | 1097 | |
a82c53a0 TZ |
1098 | if (ret < read_len) { |
1099 | sd->pos = prev_pos + ret; | |
51a92c0f | 1100 | goto out_release; |
a82c53a0 | 1101 | } |
b92ce558 JA |
1102 | } |
1103 | ||
9e97198d | 1104 | done: |
8cefc107 | 1105 | pipe->tail = pipe->head = 0; |
80848708 | 1106 | file_accessed(in); |
b92ce558 JA |
1107 | return bytes; |
1108 | ||
2bfc6685 DH |
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); | |
b92ce558 JA |
1118 | out_release: |
1119 | /* | |
1120 | * If we did an incomplete transfer we must release | |
1121 | * the pipe buffers in question: | |
1122 | */ | |
8cefc107 DH |
1123 | for (i = 0; i < pipe->ring_size; i++) { |
1124 | struct pipe_buffer *buf = &pipe->bufs[i]; | |
b92ce558 | 1125 | |
a779638c MS |
1126 | if (buf->ops) |
1127 | pipe_buf_release(pipe, buf); | |
b92ce558 | 1128 | } |
b92ce558 | 1129 | |
9e97198d JA |
1130 | if (!bytes) |
1131 | bytes = ret; | |
c66ab6fa | 1132 | |
9e97198d | 1133 | goto done; |
c66ab6fa JA |
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 | { | |
6a14b90b | 1140 | struct file *file = sd->u.file; |
c66ab6fa | 1141 | |
7995bd28 | 1142 | return do_splice_from(pipe, file, sd->opos, sd->total_len, |
2cb4b05e | 1143 | sd->flags); |
c66ab6fa JA |
1144 | } |
1145 | ||
2bfc6685 DH |
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 | ||
932cc6d4 JA |
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 | |
acdb37c3 | 1159 | * @opos: output file offset |
932cc6d4 JA |
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 | */ | |
c66ab6fa | 1170 | long do_splice_direct(struct file *in, loff_t *ppos, struct file *out, |
7995bd28 | 1171 | loff_t *opos, size_t len, unsigned int flags) |
c66ab6fa JA |
1172 | { |
1173 | struct splice_desc sd = { | |
1174 | .len = len, | |
1175 | .total_len = len, | |
1176 | .flags = flags, | |
1177 | .pos = *ppos, | |
6a14b90b | 1178 | .u.file = out, |
2bfc6685 | 1179 | .splice_eof = direct_file_splice_eof, |
7995bd28 | 1180 | .opos = opos, |
c66ab6fa | 1181 | }; |
51a92c0f | 1182 | long ret; |
c66ab6fa | 1183 | |
18c67cb9 AV |
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 | ||
c66ab6fa | 1194 | ret = splice_direct_to_actor(in, &sd, direct_splice_actor); |
51a92c0f | 1195 | if (ret > 0) |
a82c53a0 | 1196 | *ppos = sd.pos; |
51a92c0f | 1197 | |
c66ab6fa | 1198 | return ret; |
b92ce558 | 1199 | } |
1c118596 | 1200 | EXPORT_SYMBOL(do_splice_direct); |
b92ce558 | 1201 | |
8924feff AV |
1202 | static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags) |
1203 | { | |
52bce911 LT |
1204 | for (;;) { |
1205 | if (unlikely(!pipe->readers)) { | |
1206 | send_sig(SIGPIPE, current, 0); | |
1207 | return -EPIPE; | |
1208 | } | |
6718b6f8 | 1209 | if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage)) |
52bce911 | 1210 | return 0; |
8924feff AV |
1211 | if (flags & SPLICE_F_NONBLOCK) |
1212 | return -EAGAIN; | |
1213 | if (signal_pending(current)) | |
1214 | return -ERESTARTSYS; | |
472e5b05 | 1215 | pipe_wait_writable(pipe); |
8924feff | 1216 | } |
8924feff AV |
1217 | } |
1218 | ||
7c77f0b3 MS |
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); | |
ddac0d39 | 1222 | |
b964bf53 | 1223 | long splice_file_to_pipe(struct file *in, |
faa97c48 AV |
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) | |
6a3f30b8 | 1233 | ret = vfs_splice_read(in, offset, opipe, len, flags); |
faa97c48 AV |
1234 | pipe_unlock(opipe); |
1235 | if (ret > 0) | |
1236 | wakeup_pipe_readers(opipe); | |
1237 | return ret; | |
1238 | } | |
1239 | ||
83f9135b JA |
1240 | /* |
1241 | * Determine where to splice to/from. | |
1242 | */ | |
ee6e00c8 JA |
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) | |
5274f052 | 1245 | { |
7c77f0b3 MS |
1246 | struct pipe_inode_info *ipipe; |
1247 | struct pipe_inode_info *opipe; | |
7995bd28 | 1248 | loff_t offset; |
a4514ebd | 1249 | long ret; |
5274f052 | 1250 | |
90da2e3f PB |
1251 | if (unlikely(!(in->f_mode & FMODE_READ) || |
1252 | !(out->f_mode & FMODE_WRITE))) | |
1253 | return -EBADF; | |
1254 | ||
c73be61c DH |
1255 | ipipe = get_pipe_info(in, true); |
1256 | opipe = get_pipe_info(out, true); | |
7c77f0b3 MS |
1257 | |
1258 | if (ipipe && opipe) { | |
1259 | if (off_in || off_out) | |
1260 | return -ESPIPE; | |
1261 | ||
7c77f0b3 MS |
1262 | /* Splicing to self would be fun, but... */ |
1263 | if (ipipe == opipe) | |
1264 | return -EINVAL; | |
1265 | ||
ee5e0011 SK |
1266 | if ((in->f_flags | out->f_flags) & O_NONBLOCK) |
1267 | flags |= SPLICE_F_NONBLOCK; | |
1268 | ||
12ee4b66 AZ |
1269 | ret = splice_pipe_to_pipe(ipipe, opipe, len, flags); |
1270 | } else if (ipipe) { | |
529565dc IM |
1271 | if (off_in) |
1272 | return -ESPIPE; | |
b92ce558 | 1273 | if (off_out) { |
19c9a49b | 1274 | if (!(out->f_mode & FMODE_PWRITE)) |
b92ce558 | 1275 | return -EINVAL; |
ee6e00c8 | 1276 | offset = *off_out; |
7995bd28 AV |
1277 | } else { |
1278 | offset = out->f_pos; | |
1279 | } | |
529565dc | 1280 | |
18c67cb9 AV |
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 | ||
ee5e0011 SK |
1288 | if (in->f_flags & O_NONBLOCK) |
1289 | flags |= SPLICE_F_NONBLOCK; | |
1290 | ||
500368f7 | 1291 | file_start_write(out); |
7995bd28 | 1292 | ret = do_splice_from(ipipe, out, &offset, len, flags); |
500368f7 | 1293 | file_end_write(out); |
a4514ebd | 1294 | |
7995bd28 AV |
1295 | if (!off_out) |
1296 | out->f_pos = offset; | |
ee6e00c8 JA |
1297 | else |
1298 | *off_out = offset; | |
12ee4b66 | 1299 | } else if (opipe) { |
529565dc IM |
1300 | if (off_out) |
1301 | return -ESPIPE; | |
b92ce558 | 1302 | if (off_in) { |
19c9a49b | 1303 | if (!(in->f_mode & FMODE_PREAD)) |
b92ce558 | 1304 | return -EINVAL; |
ee6e00c8 | 1305 | offset = *off_in; |
7995bd28 AV |
1306 | } else { |
1307 | offset = in->f_pos; | |
1308 | } | |
529565dc | 1309 | |
ee5e0011 SK |
1310 | if (out->f_flags & O_NONBLOCK) |
1311 | flags |= SPLICE_F_NONBLOCK; | |
1312 | ||
faa97c48 | 1313 | ret = splice_file_to_pipe(in, opipe, &offset, len, flags); |
983652c6 | 1314 | |
7995bd28 AV |
1315 | if (!off_in) |
1316 | in->f_pos = offset; | |
ee6e00c8 JA |
1317 | else |
1318 | *off_in = offset; | |
12ee4b66 AZ |
1319 | } else { |
1320 | ret = -EINVAL; | |
1321 | } | |
a4514ebd | 1322 | |
12ee4b66 AZ |
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); | |
529565dc | 1331 | } |
5274f052 | 1332 | |
12ee4b66 | 1333 | return ret; |
5274f052 JA |
1334 | } |
1335 | ||
ee6e00c8 JA |
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 | ||
0f99fc51 JA |
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 | } | |
ee6e00c8 JA |
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 | ||
79fddc4e AV |
1382 | static int iter_to_pipe(struct iov_iter *from, |
1383 | struct pipe_inode_info *pipe, | |
1384 | unsigned flags) | |
912d35f8 | 1385 | { |
79fddc4e AV |
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; | |
79fddc4e | 1392 | |
7d690c15 | 1393 | while (iov_iter_count(from)) { |
79fddc4e | 1394 | struct page *pages[16]; |
7d690c15 | 1395 | ssize_t left; |
db85a9eb | 1396 | size_t start; |
7d690c15 | 1397 | int i, n; |
db85a9eb | 1398 | |
7d690c15 AV |
1399 | left = iov_iter_get_pages2(from, pages, ~0UL, 16, &start); |
1400 | if (left <= 0) { | |
1401 | ret = left; | |
79fddc4e AV |
1402 | break; |
1403 | } | |
db85a9eb | 1404 | |
7d690c15 AV |
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; | |
79fddc4e | 1419 | } |
7d690c15 AV |
1420 | total += ret; |
1421 | left -= size; | |
1422 | start = 0; | |
912d35f8 | 1423 | } |
912d35f8 | 1424 | } |
7d690c15 | 1425 | out: |
79fddc4e | 1426 | return total ? total : ret; |
912d35f8 JA |
1427 | } |
1428 | ||
6a14b90b JA |
1429 | static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf, |
1430 | struct splice_desc *sd) | |
1431 | { | |
6130f531 AV |
1432 | int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data); |
1433 | return n == sd->len ? n : -EFAULT; | |
6a14b90b JA |
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 | */ | |
87a3002a AV |
1440 | static long vmsplice_to_user(struct file *file, struct iov_iter *iter, |
1441 | unsigned int flags) | |
6a14b90b | 1442 | { |
c73be61c | 1443 | struct pipe_inode_info *pipe = get_pipe_info(file, true); |
87a3002a AV |
1444 | struct splice_desc sd = { |
1445 | .total_len = iov_iter_count(iter), | |
1446 | .flags = flags, | |
1447 | .u.data = iter | |
1448 | }; | |
1449 | long ret = 0; | |
6a14b90b | 1450 | |
6a14b90b JA |
1451 | if (!pipe) |
1452 | return -EBADF; | |
1453 | ||
0f99fc51 JA |
1454 | pipe_clear_nowait(file); |
1455 | ||
345995fa AV |
1456 | if (sd.total_len) { |
1457 | pipe_lock(pipe); | |
1458 | ret = __splice_from_pipe(pipe, &sd, pipe_to_user); | |
1459 | pipe_unlock(pipe); | |
1460 | } | |
6a14b90b | 1461 | |
7f0f1ea0 AZ |
1462 | if (ret > 0) |
1463 | fsnotify_access(file); | |
1464 | ||
6a14b90b JA |
1465 | return ret; |
1466 | } | |
1467 | ||
912d35f8 JA |
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. | |
912d35f8 | 1472 | */ |
87a3002a AV |
1473 | static long vmsplice_to_pipe(struct file *file, struct iov_iter *iter, |
1474 | unsigned int flags) | |
912d35f8 | 1475 | { |
ddac0d39 | 1476 | struct pipe_inode_info *pipe; |
87a3002a | 1477 | long ret = 0; |
79fddc4e AV |
1478 | unsigned buf_flag = 0; |
1479 | ||
1480 | if (flags & SPLICE_F_GIFT) | |
1481 | buf_flag = PIPE_BUF_FLAG_GIFT; | |
912d35f8 | 1482 | |
c73be61c | 1483 | pipe = get_pipe_info(file, true); |
ddac0d39 | 1484 | if (!pipe) |
912d35f8 | 1485 | return -EBADF; |
912d35f8 | 1486 | |
0f99fc51 JA |
1487 | pipe_clear_nowait(file); |
1488 | ||
8924feff AV |
1489 | pipe_lock(pipe); |
1490 | ret = wait_for_space(pipe, flags); | |
79fddc4e | 1491 | if (!ret) |
87a3002a | 1492 | ret = iter_to_pipe(iter, pipe, buf_flag); |
8924feff | 1493 | pipe_unlock(pipe); |
7f0f1ea0 | 1494 | if (ret > 0) { |
8924feff | 1495 | wakeup_pipe_readers(pipe); |
7f0f1ea0 AZ |
1496 | fsnotify_modify(file); |
1497 | } | |
35f3d14d | 1498 | return ret; |
912d35f8 JA |
1499 | } |
1500 | ||
87a3002a AV |
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) { | |
de4eda9d | 1506 | *type = ITER_SOURCE; |
87a3002a | 1507 | } else if (f.file->f_mode & FMODE_READ) { |
de4eda9d | 1508 | *type = ITER_DEST; |
87a3002a AV |
1509 | } else { |
1510 | fdput(f); | |
1511 | return -EBADF; | |
1512 | } | |
1513 | return 0; | |
1514 | } | |
1515 | ||
6a14b90b JA |
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 | */ | |
87a3002a | 1532 | SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, uiov, |
30cfe4ef DB |
1533 | unsigned long, nr_segs, unsigned int, flags) |
1534 | { | |
87a3002a AV |
1535 | struct iovec iovstack[UIO_FASTIOV]; |
1536 | struct iovec *iov = iovstack; | |
1537 | struct iov_iter iter; | |
87e5e6da | 1538 | ssize_t error; |
87a3002a AV |
1539 | struct fd f; |
1540 | int type; | |
1541 | ||
598b3cec CH |
1542 | if (unlikely(flags & ~SPLICE_F_ALL)) |
1543 | return -EINVAL; | |
1544 | ||
87a3002a AV |
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); | |
598b3cec CH |
1552 | if (error < 0) |
1553 | goto out_fdput; | |
30cfe4ef | 1554 | |
598b3cec CH |
1555 | if (!iov_iter_count(&iter)) |
1556 | error = 0; | |
de4eda9d | 1557 | else if (type == ITER_SOURCE) |
598b3cec CH |
1558 | error = vmsplice_to_pipe(f.file, &iter, flags); |
1559 | else | |
1560 | error = vmsplice_to_user(f.file, &iter, flags); | |
87a3002a | 1561 | |
598b3cec CH |
1562 | kfree(iov); |
1563 | out_fdput: | |
87a3002a AV |
1564 | fdput(f); |
1565 | return error; | |
76b021d0 | 1566 | } |
76b021d0 | 1567 | |
836f92ad HC |
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) | |
5274f052 | 1571 | { |
2903ff01 | 1572 | struct fd in, out; |
5274f052 | 1573 | long error; |
5274f052 JA |
1574 | |
1575 | if (unlikely(!len)) | |
1576 | return 0; | |
1577 | ||
3d6ea290 AV |
1578 | if (unlikely(flags & ~SPLICE_F_ALL)) |
1579 | return -EINVAL; | |
1580 | ||
5274f052 | 1581 | error = -EBADF; |
2903ff01 AV |
1582 | in = fdget(fd_in); |
1583 | if (in.file) { | |
90da2e3f PB |
1584 | out = fdget(fd_out); |
1585 | if (out.file) { | |
ee6e00c8 JA |
1586 | error = __do_splice(in.file, off_in, out.file, off_out, |
1587 | len, flags); | |
90da2e3f | 1588 | fdput(out); |
5274f052 | 1589 | } |
2903ff01 | 1590 | fdput(in); |
5274f052 | 1591 | } |
5274f052 JA |
1592 | return error; |
1593 | } | |
70524490 | 1594 | |
aadd06e5 JA |
1595 | /* |
1596 | * Make sure there's data to read. Wait for input if we can, otherwise | |
1597 | * return an appropriate error. | |
1598 | */ | |
7c77f0b3 | 1599 | static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags) |
aadd06e5 JA |
1600 | { |
1601 | int ret; | |
1602 | ||
1603 | /* | |
8cefc107 | 1604 | * Check the pipe occupancy without the inode lock first. This function |
aadd06e5 JA |
1605 | * is speculative anyways, so missing one is ok. |
1606 | */ | |
8cefc107 | 1607 | if (!pipe_empty(pipe->head, pipe->tail)) |
aadd06e5 JA |
1608 | return 0; |
1609 | ||
1610 | ret = 0; | |
61e0d47c | 1611 | pipe_lock(pipe); |
aadd06e5 | 1612 | |
8cefc107 | 1613 | while (pipe_empty(pipe->head, pipe->tail)) { |
aadd06e5 JA |
1614 | if (signal_pending(current)) { |
1615 | ret = -ERESTARTSYS; | |
1616 | break; | |
1617 | } | |
1618 | if (!pipe->writers) | |
1619 | break; | |
a28c8b9d LT |
1620 | if (flags & SPLICE_F_NONBLOCK) { |
1621 | ret = -EAGAIN; | |
1622 | break; | |
aadd06e5 | 1623 | } |
472e5b05 | 1624 | pipe_wait_readable(pipe); |
aadd06e5 JA |
1625 | } |
1626 | ||
61e0d47c | 1627 | pipe_unlock(pipe); |
aadd06e5 JA |
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 | */ | |
7c77f0b3 | 1635 | static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags) |
aadd06e5 JA |
1636 | { |
1637 | int ret; | |
1638 | ||
1639 | /* | |
8cefc107 | 1640 | * Check pipe occupancy without the inode lock first. This function |
aadd06e5 JA |
1641 | * is speculative anyways, so missing one is ok. |
1642 | */ | |
566d1362 | 1643 | if (!pipe_full(pipe->head, pipe->tail, pipe->max_usage)) |
aadd06e5 JA |
1644 | return 0; |
1645 | ||
1646 | ret = 0; | |
61e0d47c | 1647 | pipe_lock(pipe); |
aadd06e5 | 1648 | |
6718b6f8 | 1649 | while (pipe_full(pipe->head, pipe->tail, pipe->max_usage)) { |
aadd06e5 JA |
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 | } | |
472e5b05 | 1663 | pipe_wait_writable(pipe); |
aadd06e5 JA |
1664 | } |
1665 | ||
61e0d47c | 1666 | pipe_unlock(pipe); |
aadd06e5 JA |
1667 | return ret; |
1668 | } | |
1669 | ||
7c77f0b3 MS |
1670 | /* |
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; | |
8cefc107 DH |
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; | |
7c77f0b3 MS |
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 | ||
8cefc107 DH |
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 | ||
7c77f0b3 | 1706 | do { |
8cefc107 DH |
1707 | size_t o_len; |
1708 | ||
7c77f0b3 MS |
1709 | if (!opipe->readers) { |
1710 | send_sig(SIGPIPE, current, 0); | |
1711 | if (!ret) | |
1712 | ret = -EPIPE; | |
1713 | break; | |
1714 | } | |
1715 | ||
8cefc107 DH |
1716 | i_head = ipipe->head; |
1717 | o_tail = opipe->tail; | |
1718 | ||
1719 | if (pipe_empty(i_head, i_tail) && !ipipe->writers) | |
7c77f0b3 MS |
1720 | break; |
1721 | ||
1722 | /* | |
1723 | * Cannot make any progress, because either the input | |
1724 | * pipe is empty or the output pipe is full. | |
1725 | */ | |
8cefc107 | 1726 | if (pipe_empty(i_head, i_tail) || |
6718b6f8 | 1727 | pipe_full(o_head, o_tail, opipe->max_usage)) { |
7c77f0b3 MS |
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 | ||
8cefc107 DH |
1747 | ibuf = &ipipe->bufs[i_tail & i_mask]; |
1748 | obuf = &opipe->bufs[o_head & o_mask]; | |
7c77f0b3 MS |
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; | |
8cefc107 DH |
1756 | i_tail++; |
1757 | ipipe->tail = i_tail; | |
7c77f0b3 | 1758 | input_wakeup = true; |
8cefc107 DH |
1759 | o_len = obuf->len; |
1760 | o_head++; | |
1761 | opipe->head = o_head; | |
7c77f0b3 MS |
1762 | } else { |
1763 | /* | |
1764 | * Get a reference to this pipe buffer, | |
1765 | * so we can copy the contents over. | |
1766 | */ | |
15fab63e MW |
1767 | if (!pipe_buf_get(ipipe, ibuf)) { |
1768 | if (ret == 0) | |
1769 | ret = -EFAULT; | |
1770 | break; | |
1771 | } | |
7c77f0b3 MS |
1772 | *obuf = *ibuf; |
1773 | ||
1774 | /* | |
f6dd9755 | 1775 | * Don't inherit the gift and merge flags, we need to |
7c77f0b3 MS |
1776 | * prevent multiple steals of this page. |
1777 | */ | |
1778 | obuf->flags &= ~PIPE_BUF_FLAG_GIFT; | |
f6dd9755 | 1779 | obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE; |
a0ce2f0a | 1780 | |
7c77f0b3 | 1781 | obuf->len = len; |
8cefc107 DH |
1782 | ibuf->offset += len; |
1783 | ibuf->len -= len; | |
1784 | o_len = len; | |
1785 | o_head++; | |
1786 | opipe->head = o_head; | |
7c77f0b3 | 1787 | } |
8cefc107 DH |
1788 | ret += o_len; |
1789 | len -= o_len; | |
7c77f0b3 MS |
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 | */ | |
825cdcb1 NK |
1798 | if (ret > 0) |
1799 | wakeup_pipe_readers(opipe); | |
1800 | ||
7c77f0b3 MS |
1801 | if (input_wakeup) |
1802 | wakeup_pipe_writers(ipipe); | |
1803 | ||
1804 | return ret; | |
1805 | } | |
1806 | ||
70524490 JA |
1807 | /* |
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; | |
8cefc107 DH |
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; | |
70524490 JA |
1819 | |
1820 | /* | |
1821 | * Potential ABBA deadlock, work around it by ordering lock | |
61e0d47c | 1822 | * grabbing by pipe info address. Otherwise two different processes |
70524490 JA |
1823 | * could deadlock (one doing tee from A -> B, the other from B -> A). |
1824 | */ | |
61e0d47c | 1825 | pipe_double_lock(ipipe, opipe); |
70524490 | 1826 | |
8cefc107 DH |
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 | ||
aadd06e5 | 1832 | do { |
70524490 JA |
1833 | if (!opipe->readers) { |
1834 | send_sig(SIGPIPE, current, 0); | |
1835 | if (!ret) | |
1836 | ret = -EPIPE; | |
1837 | break; | |
1838 | } | |
70524490 | 1839 | |
8cefc107 DH |
1840 | i_head = ipipe->head; |
1841 | o_tail = opipe->tail; | |
1842 | ||
aadd06e5 | 1843 | /* |
8cefc107 | 1844 | * If we have iterated all input buffers or run out of |
aadd06e5 JA |
1845 | * output room, break. |
1846 | */ | |
8cefc107 | 1847 | if (pipe_empty(i_head, i_tail) || |
6718b6f8 | 1848 | pipe_full(o_head, o_tail, opipe->max_usage)) |
aadd06e5 | 1849 | break; |
70524490 | 1850 | |
8cefc107 DH |
1851 | ibuf = &ipipe->bufs[i_tail & i_mask]; |
1852 | obuf = &opipe->bufs[o_head & o_mask]; | |
70524490 JA |
1853 | |
1854 | /* | |
aadd06e5 JA |
1855 | * Get a reference to this pipe buffer, |
1856 | * so we can copy the contents over. | |
70524490 | 1857 | */ |
15fab63e MW |
1858 | if (!pipe_buf_get(ipipe, ibuf)) { |
1859 | if (ret == 0) | |
1860 | ret = -EFAULT; | |
1861 | break; | |
1862 | } | |
aadd06e5 | 1863 | |
aadd06e5 JA |
1864 | *obuf = *ibuf; |
1865 | ||
2a27250e | 1866 | /* |
f6dd9755 CH |
1867 | * Don't inherit the gift and merge flag, we need to prevent |
1868 | * multiple steals of this page. | |
2a27250e | 1869 | */ |
aadd06e5 | 1870 | obuf->flags &= ~PIPE_BUF_FLAG_GIFT; |
f6dd9755 | 1871 | obuf->flags &= ~PIPE_BUF_FLAG_CAN_MERGE; |
a0ce2f0a | 1872 | |
aadd06e5 JA |
1873 | if (obuf->len > len) |
1874 | obuf->len = len; | |
aadd06e5 JA |
1875 | ret += obuf->len; |
1876 | len -= obuf->len; | |
8cefc107 DH |
1877 | |
1878 | o_head++; | |
1879 | opipe->head = o_head; | |
1880 | i_tail++; | |
aadd06e5 | 1881 | } while (len); |
70524490 | 1882 | |
61e0d47c MS |
1883 | pipe_unlock(ipipe); |
1884 | pipe_unlock(opipe); | |
70524490 | 1885 | |
aadd06e5 JA |
1886 | /* |
1887 | * If we put data in the output pipe, wakeup any potential readers. | |
1888 | */ | |
825cdcb1 NK |
1889 | if (ret > 0) |
1890 | wakeup_pipe_readers(opipe); | |
70524490 JA |
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 | */ | |
9dafdfc2 | 1901 | long do_tee(struct file *in, struct file *out, size_t len, unsigned int flags) |
70524490 | 1902 | { |
c73be61c DH |
1903 | struct pipe_inode_info *ipipe = get_pipe_info(in, true); |
1904 | struct pipe_inode_info *opipe = get_pipe_info(out, true); | |
aadd06e5 | 1905 | int ret = -EINVAL; |
70524490 | 1906 | |
90da2e3f PB |
1907 | if (unlikely(!(in->f_mode & FMODE_READ) || |
1908 | !(out->f_mode & FMODE_WRITE))) | |
1909 | return -EBADF; | |
1910 | ||
70524490 | 1911 | /* |
aadd06e5 JA |
1912 | * Duplicate the contents of ipipe to opipe without actually |
1913 | * copying the data. | |
70524490 | 1914 | */ |
aadd06e5 | 1915 | if (ipipe && opipe && ipipe != opipe) { |
ee5e0011 SK |
1916 | if ((in->f_flags | out->f_flags) & O_NONBLOCK) |
1917 | flags |= SPLICE_F_NONBLOCK; | |
1918 | ||
aadd06e5 JA |
1919 | /* |
1920 | * Keep going, unless we encounter an error. The ipipe/opipe | |
1921 | * ordering doesn't really matter. | |
1922 | */ | |
7c77f0b3 | 1923 | ret = ipipe_prep(ipipe, flags); |
aadd06e5 | 1924 | if (!ret) { |
7c77f0b3 | 1925 | ret = opipe_prep(opipe, flags); |
02cf01ae | 1926 | if (!ret) |
aadd06e5 | 1927 | ret = link_pipe(ipipe, opipe, len, flags); |
aadd06e5 JA |
1928 | } |
1929 | } | |
70524490 | 1930 | |
576d498e AZ |
1931 | if (ret > 0) { |
1932 | fsnotify_access(in); | |
1933 | fsnotify_modify(out); | |
1934 | } | |
1935 | ||
aadd06e5 | 1936 | return ret; |
70524490 JA |
1937 | } |
1938 | ||
836f92ad | 1939 | SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags) |
70524490 | 1940 | { |
90da2e3f | 1941 | struct fd in, out; |
2903ff01 | 1942 | int error; |
70524490 | 1943 | |
3d6ea290 AV |
1944 | if (unlikely(flags & ~SPLICE_F_ALL)) |
1945 | return -EINVAL; | |
1946 | ||
70524490 JA |
1947 | if (unlikely(!len)) |
1948 | return 0; | |
1949 | ||
1950 | error = -EBADF; | |
2903ff01 AV |
1951 | in = fdget(fdin); |
1952 | if (in.file) { | |
90da2e3f PB |
1953 | out = fdget(fdout); |
1954 | if (out.file) { | |
1955 | error = do_tee(in.file, out.file, len, flags); | |
1956 | fdput(out); | |
70524490 | 1957 | } |
2903ff01 | 1958 | fdput(in); |
70524490 JA |
1959 | } |
1960 | ||
1961 | return error; | |
1962 | } |