]> git.ipfire.org Git - thirdparty/kernel/stable.git/blame - fs/splice.c
Merge branch 'ras-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[thirdparty/kernel/stable.git] / fs / splice.c
CommitLineData
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 <axboe@kernel.dk>
c2058e06
JA
17 * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
18 * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
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>
29ce2058 33#include <linux/security.h>
5a0e3ad6 34#include <linux/gfp.h>
35f9c09f 35#include <linux/socket.h>
76b021d0 36#include <linux/compat.h>
174cd4b1
IM
37#include <linux/sched/signal.h>
38
06ae43f3 39#include "internal.h"
5274f052 40
83f9135b
JA
41/*
42 * Attempt to steal a page from a pipe buffer. This should perhaps go into
43 * a vm helper function, it's already simplified quite a bit by the
44 * addition of remove_mapping(). If success is returned, the caller may
45 * attempt to reuse this page for another destination.
46 */
76ad4d11 47static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
5abc97aa
JA
48 struct pipe_buffer *buf)
49{
50 struct page *page = buf->page;
9e94cd4f 51 struct address_space *mapping;
5abc97aa 52
9e0267c2
JA
53 lock_page(page);
54
9e94cd4f
JA
55 mapping = page_mapping(page);
56 if (mapping) {
57 WARN_ON(!PageUptodate(page));
5abc97aa 58
9e94cd4f
JA
59 /*
60 * At least for ext2 with nobh option, we need to wait on
61 * writeback completing on this page, since we'll remove it
62 * from the pagecache. Otherwise truncate wont wait on the
63 * page, allowing the disk blocks to be reused by someone else
64 * before we actually wrote our data to them. fs corruption
65 * ensues.
66 */
67 wait_on_page_writeback(page);
ad8d6f0a 68
266cf658
DH
69 if (page_has_private(page) &&
70 !try_to_release_page(page, GFP_KERNEL))
ca39d651 71 goto out_unlock;
4f6f0bd2 72
9e94cd4f
JA
73 /*
74 * If we succeeded in removing the mapping, set LRU flag
75 * and return good.
76 */
77 if (remove_mapping(mapping, page)) {
78 buf->flags |= PIPE_BUF_FLAG_LRU;
79 return 0;
80 }
9e0267c2 81 }
5abc97aa 82
9e94cd4f
JA
83 /*
84 * Raced with truncate or failed to remove page from current
85 * address space, unlock and return failure.
86 */
ca39d651 87out_unlock:
9e94cd4f
JA
88 unlock_page(page);
89 return 1;
5abc97aa
JA
90}
91
76ad4d11 92static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
5274f052
JA
93 struct pipe_buffer *buf)
94{
09cbfeaf 95 put_page(buf->page);
1432873a 96 buf->flags &= ~PIPE_BUF_FLAG_LRU;
5274f052
JA
97}
98
0845718d
JA
99/*
100 * Check whether the contents of buf is OK to access. Since the content
101 * is a page cache page, IO may be in flight.
102 */
cac36bb0
JA
103static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
104 struct pipe_buffer *buf)
5274f052
JA
105{
106 struct page *page = buf->page;
49d0b21b 107 int err;
5274f052
JA
108
109 if (!PageUptodate(page)) {
49d0b21b
JA
110 lock_page(page);
111
112 /*
113 * Page got truncated/unhashed. This will cause a 0-byte
73d62d83 114 * splice, if this is the first page.
49d0b21b
JA
115 */
116 if (!page->mapping) {
117 err = -ENODATA;
118 goto error;
119 }
5274f052 120
49d0b21b 121 /*
73d62d83 122 * Uh oh, read-error from disk.
49d0b21b
JA
123 */
124 if (!PageUptodate(page)) {
125 err = -EIO;
126 goto error;
127 }
128
129 /*
f84d7519 130 * Page is ok afterall, we are done.
49d0b21b 131 */
5274f052 132 unlock_page(page);
5274f052
JA
133 }
134
f84d7519 135 return 0;
49d0b21b
JA
136error:
137 unlock_page(page);
f84d7519 138 return err;
70524490
JA
139}
140
708e3508 141const struct pipe_buf_operations page_cache_pipe_buf_ops = {
cac36bb0 142 .confirm = page_cache_pipe_buf_confirm,
5274f052 143 .release = page_cache_pipe_buf_release,
5abc97aa 144 .steal = page_cache_pipe_buf_steal,
f84d7519 145 .get = generic_pipe_buf_get,
5274f052
JA
146};
147
912d35f8
JA
148static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
149 struct pipe_buffer *buf)
150{
7afa6fd0
JA
151 if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
152 return 1;
153
1432873a 154 buf->flags |= PIPE_BUF_FLAG_LRU;
330ab716 155 return generic_pipe_buf_steal(pipe, buf);
912d35f8
JA
156}
157
d4c3cca9 158static const struct pipe_buf_operations user_page_pipe_buf_ops = {
cac36bb0 159 .confirm = generic_pipe_buf_confirm,
912d35f8
JA
160 .release = page_cache_pipe_buf_release,
161 .steal = user_page_pipe_buf_steal,
f84d7519 162 .get = generic_pipe_buf_get,
912d35f8
JA
163};
164
825cdcb1
NK
165static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
166{
167 smp_mb();
168 if (waitqueue_active(&pipe->wait))
169 wake_up_interruptible(&pipe->wait);
170 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
171}
172
932cc6d4
JA
173/**
174 * splice_to_pipe - fill passed data into a pipe
175 * @pipe: pipe to fill
176 * @spd: data to fill
177 *
178 * Description:
79685b8d 179 * @spd contains a map of pages and len/offset tuples, along with
932cc6d4
JA
180 * the struct pipe_buf_operations associated with these pages. This
181 * function will link that data to the pipe.
182 *
83f9135b 183 */
d6b29d7c
JA
184ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
185 struct splice_pipe_desc *spd)
5274f052 186{
00de00bd 187 unsigned int spd_pages = spd->nr_pages;
8924feff 188 int ret = 0, page_nr = 0;
5274f052 189
d6785d91
RV
190 if (!spd_pages)
191 return 0;
192
8924feff
AV
193 if (unlikely(!pipe->readers)) {
194 send_sig(SIGPIPE, current, 0);
195 ret = -EPIPE;
196 goto out;
197 }
5274f052 198
8924feff
AV
199 while (pipe->nrbufs < pipe->buffers) {
200 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
201 struct pipe_buffer *buf = pipe->bufs + newbuf;
5274f052 202
8924feff
AV
203 buf->page = spd->pages[page_nr];
204 buf->offset = spd->partial[page_nr].offset;
205 buf->len = spd->partial[page_nr].len;
206 buf->private = spd->partial[page_nr].private;
207 buf->ops = spd->ops;
5a81e6a1 208 buf->flags = 0;
5274f052 209
8924feff
AV
210 pipe->nrbufs++;
211 page_nr++;
212 ret += buf->len;
29e35094 213
8924feff 214 if (!--spd->nr_pages)
5274f052 215 break;
5274f052
JA
216 }
217
8924feff
AV
218 if (!ret)
219 ret = -EAGAIN;
5274f052 220
8924feff 221out:
00de00bd 222 while (page_nr < spd_pages)
bbdfc2f7 223 spd->spd_release(spd, page_nr++);
5274f052
JA
224
225 return ret;
226}
2b514574 227EXPORT_SYMBOL_GPL(splice_to_pipe);
5274f052 228
79fddc4e
AV
229ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
230{
231 int ret;
232
233 if (unlikely(!pipe->readers)) {
234 send_sig(SIGPIPE, current, 0);
235 ret = -EPIPE;
236 } else if (pipe->nrbufs == pipe->buffers) {
237 ret = -EAGAIN;
238 } else {
239 int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
240 pipe->bufs[newbuf] = *buf;
241 pipe->nrbufs++;
242 return buf->len;
243 }
a779638c 244 pipe_buf_release(pipe, buf);
79fddc4e
AV
245 return ret;
246}
247EXPORT_SYMBOL(add_to_pipe);
248
35f3d14d
JA
249/*
250 * Check if we need to grow the arrays holding pages and partial page
251 * descriptions.
252 */
047fe360 253int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
35f3d14d 254{
6aa7de05 255 unsigned int buffers = READ_ONCE(pipe->buffers);
047fe360
ED
256
257 spd->nr_pages_max = buffers;
258 if (buffers <= PIPE_DEF_BUFFERS)
35f3d14d
JA
259 return 0;
260
6da2ec56
KC
261 spd->pages = kmalloc_array(buffers, sizeof(struct page *), GFP_KERNEL);
262 spd->partial = kmalloc_array(buffers, sizeof(struct partial_page),
263 GFP_KERNEL);
35f3d14d
JA
264
265 if (spd->pages && spd->partial)
266 return 0;
267
268 kfree(spd->pages);
269 kfree(spd->partial);
270 return -ENOMEM;
271}
272
047fe360 273void splice_shrink_spd(struct splice_pipe_desc *spd)
35f3d14d 274{
047fe360 275 if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
35f3d14d
JA
276 return;
277
278 kfree(spd->pages);
279 kfree(spd->partial);
280}
281
83f9135b
JA
282/**
283 * generic_file_splice_read - splice data from file to a pipe
284 * @in: file to splice from
932cc6d4 285 * @ppos: position in @in
83f9135b
JA
286 * @pipe: pipe to splice to
287 * @len: number of bytes to splice
288 * @flags: splice modifier flags
289 *
932cc6d4
JA
290 * Description:
291 * Will read pages from given file and fill them into a pipe. Can be
82c156f8 292 * used as long as it has more or less sane ->read_iter().
932cc6d4 293 *
83f9135b 294 */
cbb7e577
JA
295ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
296 struct pipe_inode_info *pipe, size_t len,
297 unsigned int flags)
5274f052 298{
82c156f8
AV
299 struct iov_iter to;
300 struct kiocb kiocb;
82c156f8 301 int idx, ret;
be64f884 302
aa563d7b 303 iov_iter_pipe(&to, READ, pipe, len);
82c156f8
AV
304 idx = to.idx;
305 init_sync_kiocb(&kiocb, in);
306 kiocb.ki_pos = *ppos;
bb7462b6 307 ret = call_read_iter(in, &kiocb, &to);
723590ed 308 if (ret > 0) {
82c156f8 309 *ppos = kiocb.ki_pos;
723590ed 310 file_accessed(in);
82c156f8 311 } else if (ret < 0) {
c3a69024
AV
312 to.idx = idx;
313 to.iov_offset = 0;
314 iov_iter_advance(&to, 0); /* to free what was emitted */
82c156f8
AV
315 /*
316 * callers of ->splice_read() expect -EAGAIN on
317 * "can't put anything in there", rather than -EFAULT.
318 */
319 if (ret == -EFAULT)
320 ret = -EAGAIN;
723590ed 321 }
5274f052
JA
322
323 return ret;
324}
059a8f37
JA
325EXPORT_SYMBOL(generic_file_splice_read);
326
241699cd 327const struct pipe_buf_operations default_pipe_buf_ops = {
6818173b
MS
328 .confirm = generic_pipe_buf_confirm,
329 .release = generic_pipe_buf_release,
330 .steal = generic_pipe_buf_steal,
331 .get = generic_pipe_buf_get,
332};
333
b9872226
JH
334int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
335 struct pipe_buffer *buf)
28a625cb
MS
336{
337 return 1;
338}
339
340/* Pipe buffer operations for a socket and similar. */
341const struct pipe_buf_operations nosteal_pipe_buf_ops = {
28a625cb
MS
342 .confirm = generic_pipe_buf_confirm,
343 .release = generic_pipe_buf_release,
344 .steal = generic_pipe_buf_nosteal,
345 .get = generic_pipe_buf_get,
346};
347EXPORT_SYMBOL(nosteal_pipe_buf_ops);
348
523ac9af 349static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
6818173b
MS
350 unsigned long vlen, loff_t offset)
351{
352 mm_segment_t old_fs;
353 loff_t pos = offset;
354 ssize_t res;
355
356 old_fs = get_fs();
736706be 357 set_fs(KERNEL_DS);
6818173b 358 /* The cast to a user pointer is valid due to the set_fs() */
793b80ef 359 res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
6818173b
MS
360 set_fs(old_fs);
361
362 return res;
363}
364
82c156f8 365static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
6818173b
MS
366 struct pipe_inode_info *pipe, size_t len,
367 unsigned int flags)
368{
523ac9af
AV
369 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
370 struct iov_iter to;
371 struct page **pages;
6818173b 372 unsigned int nr_pages;
13c0f52b 373 size_t offset, base, copied = 0;
6818173b 374 ssize_t res;
6818173b 375 int i;
35f3d14d 376
523ac9af
AV
377 if (pipe->nrbufs == pipe->buffers)
378 return -EAGAIN;
35f3d14d 379
523ac9af
AV
380 /*
381 * Try to keep page boundaries matching to source pagecache ones -
382 * it probably won't be much help, but...
383 */
09cbfeaf 384 offset = *ppos & ~PAGE_MASK;
6818173b 385
aa563d7b 386 iov_iter_pipe(&to, READ, pipe, len + offset);
6818173b 387
13c0f52b 388 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &base);
523ac9af
AV
389 if (res <= 0)
390 return -ENOMEM;
6818173b 391
13c0f52b 392 nr_pages = DIV_ROUND_UP(res + base, PAGE_SIZE);
6818173b 393
523ac9af
AV
394 vec = __vec;
395 if (nr_pages > PIPE_DEF_BUFFERS) {
6da2ec56 396 vec = kmalloc_array(nr_pages, sizeof(struct kvec), GFP_KERNEL);
523ac9af
AV
397 if (unlikely(!vec)) {
398 res = -ENOMEM;
399 goto out;
400 }
77f6bf57 401 }
6818173b 402
523ac9af
AV
403 pipe->bufs[to.idx].offset = offset;
404 pipe->bufs[to.idx].len -= offset;
405
406 for (i = 0; i < nr_pages; i++) {
407 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
408 vec[i].iov_base = page_address(pages[i]) + offset;
409 vec[i].iov_len = this_len;
410 len -= this_len;
411 offset = 0;
6818173b 412 }
6818173b 413
523ac9af
AV
414 res = kernel_readv(in, vec, nr_pages, *ppos);
415 if (res > 0) {
416 copied = res;
6818173b 417 *ppos += res;
523ac9af 418 }
6818173b 419
35f3d14d
JA
420 if (vec != __vec)
421 kfree(vec);
523ac9af
AV
422out:
423 for (i = 0; i < nr_pages; i++)
424 put_page(pages[i]);
425 kvfree(pages);
426 iov_iter_advance(&to, copied); /* truncates and discards */
6818173b 427 return res;
6818173b 428}
6818173b 429
5274f052 430/*
4f6f0bd2 431 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
016b661e 432 * using sendpage(). Return the number of bytes sent.
5274f052 433 */
76ad4d11 434static int pipe_to_sendpage(struct pipe_inode_info *pipe,
5274f052
JA
435 struct pipe_buffer *buf, struct splice_desc *sd)
436{
6a14b90b 437 struct file *file = sd->u.file;
5274f052 438 loff_t pos = sd->pos;
a8adbe37 439 int more;
5274f052 440
72c2d531 441 if (!likely(file->f_op->sendpage))
a8adbe37
MM
442 return -EINVAL;
443
35f9c09f 444 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
ae62ca7b
ED
445
446 if (sd->len < sd->total_len && pipe->nrbufs > 1)
35f9c09f 447 more |= MSG_SENDPAGE_NOTLAST;
ae62ca7b 448
a8adbe37
MM
449 return file->f_op->sendpage(file, buf->page, buf->offset,
450 sd->len, &pos, more);
5274f052
JA
451}
452
b3c2d2dd
MS
453static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
454{
455 smp_mb();
456 if (waitqueue_active(&pipe->wait))
457 wake_up_interruptible(&pipe->wait);
458 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
459}
460
932cc6d4 461/**
b3c2d2dd 462 * splice_from_pipe_feed - feed available data from a pipe to a file
932cc6d4
JA
463 * @pipe: pipe to splice from
464 * @sd: information to @actor
465 * @actor: handler that splices the data
466 *
467 * Description:
b3c2d2dd
MS
468 * This function loops over the pipe and calls @actor to do the
469 * actual moving of a single struct pipe_buffer to the desired
470 * destination. It returns when there's no more buffers left in
471 * the pipe or if the requested number of bytes (@sd->total_len)
472 * have been copied. It returns a positive number (one) if the
473 * pipe needs to be filled with more data, zero if the required
474 * number of bytes have been copied and -errno on error.
932cc6d4 475 *
b3c2d2dd
MS
476 * This, together with splice_from_pipe_{begin,end,next}, may be
477 * used to implement the functionality of __splice_from_pipe() when
478 * locking is required around copying the pipe buffers to the
479 * destination.
83f9135b 480 */
96f9bc8f 481static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
b3c2d2dd 482 splice_actor *actor)
5274f052 483{
b3c2d2dd 484 int ret;
5274f052 485
b3c2d2dd
MS
486 while (pipe->nrbufs) {
487 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
5274f052 488
b3c2d2dd
MS
489 sd->len = buf->len;
490 if (sd->len > sd->total_len)
491 sd->len = sd->total_len;
5274f052 492
fba597db 493 ret = pipe_buf_confirm(pipe, buf);
a8adbe37 494 if (unlikely(ret)) {
b3c2d2dd
MS
495 if (ret == -ENODATA)
496 ret = 0;
497 return ret;
498 }
a8adbe37
MM
499
500 ret = actor(pipe, buf, sd);
501 if (ret <= 0)
502 return ret;
503
b3c2d2dd
MS
504 buf->offset += ret;
505 buf->len -= ret;
506
507 sd->num_spliced += ret;
508 sd->len -= ret;
509 sd->pos += ret;
510 sd->total_len -= ret;
511
512 if (!buf->len) {
a779638c 513 pipe_buf_release(pipe, buf);
35f3d14d 514 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
b3c2d2dd 515 pipe->nrbufs--;
6447a3cf 516 if (pipe->files)
b3c2d2dd
MS
517 sd->need_wakeup = true;
518 }
5274f052 519
b3c2d2dd
MS
520 if (!sd->total_len)
521 return 0;
522 }
5274f052 523
b3c2d2dd
MS
524 return 1;
525}
5274f052 526
b3c2d2dd
MS
527/**
528 * splice_from_pipe_next - wait for some data to splice from
529 * @pipe: pipe to splice from
530 * @sd: information about the splice operation
531 *
532 * Description:
533 * This function will wait for some data and return a positive
534 * value (one) if pipe buffers are available. It will return zero
535 * or -errno if no more data needs to be spliced.
536 */
96f9bc8f 537static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
b3c2d2dd 538{
c725bfce
JK
539 /*
540 * Check for signal early to make process killable when there are
541 * always buffers available
542 */
543 if (signal_pending(current))
544 return -ERESTARTSYS;
545
b3c2d2dd
MS
546 while (!pipe->nrbufs) {
547 if (!pipe->writers)
548 return 0;
016b661e 549
b3c2d2dd
MS
550 if (!pipe->waiting_writers && sd->num_spliced)
551 return 0;
73d62d83 552
b3c2d2dd
MS
553 if (sd->flags & SPLICE_F_NONBLOCK)
554 return -EAGAIN;
5274f052 555
b3c2d2dd
MS
556 if (signal_pending(current))
557 return -ERESTARTSYS;
5274f052 558
b3c2d2dd
MS
559 if (sd->need_wakeup) {
560 wakeup_pipe_writers(pipe);
561 sd->need_wakeup = false;
5274f052
JA
562 }
563
b3c2d2dd
MS
564 pipe_wait(pipe);
565 }
29e35094 566
b3c2d2dd
MS
567 return 1;
568}
5274f052 569
b3c2d2dd
MS
570/**
571 * splice_from_pipe_begin - start splicing from pipe
b80901bb 572 * @sd: information about the splice operation
b3c2d2dd
MS
573 *
574 * Description:
575 * This function should be called before a loop containing
576 * splice_from_pipe_next() and splice_from_pipe_feed() to
577 * initialize the necessary fields of @sd.
578 */
96f9bc8f 579static void splice_from_pipe_begin(struct splice_desc *sd)
b3c2d2dd
MS
580{
581 sd->num_spliced = 0;
582 sd->need_wakeup = false;
583}
5274f052 584
b3c2d2dd
MS
585/**
586 * splice_from_pipe_end - finish splicing from pipe
587 * @pipe: pipe to splice from
588 * @sd: information about the splice operation
589 *
590 * Description:
591 * This function will wake up pipe writers if necessary. It should
592 * be called after a loop containing splice_from_pipe_next() and
593 * splice_from_pipe_feed().
594 */
96f9bc8f 595static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
b3c2d2dd
MS
596{
597 if (sd->need_wakeup)
598 wakeup_pipe_writers(pipe);
599}
5274f052 600
b3c2d2dd
MS
601/**
602 * __splice_from_pipe - splice data from a pipe to given actor
603 * @pipe: pipe to splice from
604 * @sd: information to @actor
605 * @actor: handler that splices the data
606 *
607 * Description:
608 * This function does little more than loop over the pipe and call
609 * @actor to do the actual moving of a single struct pipe_buffer to
610 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
611 * pipe_to_user.
612 *
613 */
614ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
615 splice_actor *actor)
616{
617 int ret;
5274f052 618
b3c2d2dd
MS
619 splice_from_pipe_begin(sd);
620 do {
c2489e07 621 cond_resched();
b3c2d2dd
MS
622 ret = splice_from_pipe_next(pipe, sd);
623 if (ret > 0)
624 ret = splice_from_pipe_feed(pipe, sd, actor);
625 } while (ret > 0);
626 splice_from_pipe_end(pipe, sd);
627
628 return sd->num_spliced ? sd->num_spliced : ret;
5274f052 629}
40bee44e 630EXPORT_SYMBOL(__splice_from_pipe);
5274f052 631
932cc6d4
JA
632/**
633 * splice_from_pipe - splice data from a pipe to a file
634 * @pipe: pipe to splice from
635 * @out: file to splice to
636 * @ppos: position in @out
637 * @len: how many bytes to splice
638 * @flags: splice modifier flags
639 * @actor: handler that splices the data
640 *
641 * Description:
2933970b 642 * See __splice_from_pipe. This function locks the pipe inode,
932cc6d4
JA
643 * otherwise it's identical to __splice_from_pipe().
644 *
645 */
6da61809
MF
646ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
647 loff_t *ppos, size_t len, unsigned int flags,
648 splice_actor *actor)
649{
650 ssize_t ret;
c66ab6fa
JA
651 struct splice_desc sd = {
652 .total_len = len,
653 .flags = flags,
654 .pos = *ppos,
6a14b90b 655 .u.file = out,
c66ab6fa 656 };
6da61809 657
61e0d47c 658 pipe_lock(pipe);
c66ab6fa 659 ret = __splice_from_pipe(pipe, &sd, actor);
61e0d47c 660 pipe_unlock(pipe);
6da61809
MF
661
662 return ret;
663}
664
8d020765
AV
665/**
666 * iter_file_splice_write - splice data from a pipe to a file
667 * @pipe: pipe info
668 * @out: file to write to
669 * @ppos: position in @out
670 * @len: number of bytes to splice
671 * @flags: splice modifier flags
672 *
673 * Description:
674 * Will either move or copy pages (determined by @flags options) from
675 * the given pipe inode to the given file.
676 * This one is ->write_iter-based.
677 *
678 */
679ssize_t
680iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
681 loff_t *ppos, size_t len, unsigned int flags)
682{
683 struct splice_desc sd = {
684 .total_len = len,
685 .flags = flags,
686 .pos = *ppos,
687 .u.file = out,
688 };
689 int nbufs = pipe->buffers;
690 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
691 GFP_KERNEL);
692 ssize_t ret;
693
694 if (unlikely(!array))
695 return -ENOMEM;
696
697 pipe_lock(pipe);
698
699 splice_from_pipe_begin(&sd);
700 while (sd.total_len) {
701 struct iov_iter from;
8d020765
AV
702 size_t left;
703 int n, idx;
704
705 ret = splice_from_pipe_next(pipe, &sd);
706 if (ret <= 0)
707 break;
708
709 if (unlikely(nbufs < pipe->buffers)) {
710 kfree(array);
711 nbufs = pipe->buffers;
712 array = kcalloc(nbufs, sizeof(struct bio_vec),
713 GFP_KERNEL);
714 if (!array) {
715 ret = -ENOMEM;
716 break;
717 }
718 }
719
720 /* build the vector */
721 left = sd.total_len;
722 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
723 struct pipe_buffer *buf = pipe->bufs + idx;
724 size_t this_len = buf->len;
725
726 if (this_len > left)
727 this_len = left;
728
729 if (idx == pipe->buffers - 1)
730 idx = -1;
731
fba597db 732 ret = pipe_buf_confirm(pipe, buf);
8d020765
AV
733 if (unlikely(ret)) {
734 if (ret == -ENODATA)
735 ret = 0;
736 goto done;
737 }
738
739 array[n].bv_page = buf->page;
740 array[n].bv_len = this_len;
741 array[n].bv_offset = buf->offset;
742 left -= this_len;
743 }
744
aa563d7b 745 iov_iter_bvec(&from, WRITE, array, n, sd.total_len - left);
abbb6589 746 ret = vfs_iter_write(out, &from, &sd.pos, 0);
8d020765
AV
747 if (ret <= 0)
748 break;
749
750 sd.num_spliced += ret;
751 sd.total_len -= ret;
dbe4e192 752 *ppos = sd.pos;
8d020765
AV
753
754 /* dismiss the fully eaten buffers, adjust the partial one */
755 while (ret) {
756 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
757 if (ret >= buf->len) {
8d020765
AV
758 ret -= buf->len;
759 buf->len = 0;
a779638c 760 pipe_buf_release(pipe, buf);
8d020765
AV
761 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
762 pipe->nrbufs--;
763 if (pipe->files)
764 sd.need_wakeup = true;
765 } else {
766 buf->offset += ret;
767 buf->len -= ret;
768 ret = 0;
769 }
770 }
771 }
772done:
773 kfree(array);
774 splice_from_pipe_end(pipe, &sd);
775
776 pipe_unlock(pipe);
777
778 if (sd.num_spliced)
779 ret = sd.num_spliced;
780
781 return ret;
782}
783
784EXPORT_SYMBOL(iter_file_splice_write);
785
b2858d7d
MS
786static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
787 struct splice_desc *sd)
0b0a47f5 788{
b2858d7d
MS
789 int ret;
790 void *data;
06ae43f3 791 loff_t tmp = sd->pos;
b2858d7d 792
fbb32750 793 data = kmap(buf->page);
06ae43f3 794 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
fbb32750 795 kunmap(buf->page);
b2858d7d
MS
796
797 return ret;
0b0a47f5
MS
798}
799
800static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
801 struct file *out, loff_t *ppos,
802 size_t len, unsigned int flags)
803{
b2858d7d 804 ssize_t ret;
0b0a47f5 805
b2858d7d
MS
806 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
807 if (ret > 0)
808 *ppos += ret;
0b0a47f5 809
b2858d7d 810 return ret;
0b0a47f5
MS
811}
812
83f9135b
JA
813/**
814 * generic_splice_sendpage - splice data from a pipe to a socket
932cc6d4 815 * @pipe: pipe to splice from
83f9135b 816 * @out: socket to write to
932cc6d4 817 * @ppos: position in @out
83f9135b
JA
818 * @len: number of bytes to splice
819 * @flags: splice modifier flags
820 *
932cc6d4
JA
821 * Description:
822 * Will send @len bytes from the pipe to a network socket. No data copying
823 * is involved.
83f9135b
JA
824 *
825 */
3a326a2c 826ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
cbb7e577 827 loff_t *ppos, size_t len, unsigned int flags)
5274f052 828{
00522fb4 829 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
5274f052
JA
830}
831
059a8f37 832EXPORT_SYMBOL(generic_splice_sendpage);
a0f06780 833
83f9135b
JA
834/*
835 * Attempt to initiate a splice from pipe to file.
836 */
3a326a2c 837static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
cbb7e577 838 loff_t *ppos, size_t len, unsigned int flags)
5274f052 839{
0b0a47f5
MS
840 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
841 loff_t *, size_t, unsigned int);
5274f052 842
72c2d531 843 if (out->f_op->splice_write)
cc56f7de
CG
844 splice_write = out->f_op->splice_write;
845 else
0b0a47f5
MS
846 splice_write = default_file_splice_write;
847
500368f7 848 return splice_write(pipe, out, ppos, len, flags);
5274f052
JA
849}
850
83f9135b
JA
851/*
852 * Attempt to initiate a splice from a file to a pipe.
853 */
cbb7e577
JA
854static long do_splice_to(struct file *in, loff_t *ppos,
855 struct pipe_inode_info *pipe, size_t len,
856 unsigned int flags)
5274f052 857{
6818173b
MS
858 ssize_t (*splice_read)(struct file *, loff_t *,
859 struct pipe_inode_info *, size_t, unsigned int);
5274f052
JA
860 int ret;
861
49570e9b 862 if (unlikely(!(in->f_mode & FMODE_READ)))
5274f052
JA
863 return -EBADF;
864
cbb7e577 865 ret = rw_verify_area(READ, in, ppos, len);
5274f052
JA
866 if (unlikely(ret < 0))
867 return ret;
868
03cc0789
AV
869 if (unlikely(len > MAX_RW_COUNT))
870 len = MAX_RW_COUNT;
871
72c2d531 872 if (in->f_op->splice_read)
cc56f7de
CG
873 splice_read = in->f_op->splice_read;
874 else
6818173b
MS
875 splice_read = default_file_splice_read;
876
877 return splice_read(in, ppos, pipe, len, flags);
5274f052
JA
878}
879
932cc6d4
JA
880/**
881 * splice_direct_to_actor - splices data directly between two non-pipes
882 * @in: file to splice from
883 * @sd: actor information on where to splice to
884 * @actor: handles the data splicing
885 *
886 * Description:
887 * This is a special case helper to splice directly between two
888 * points, without requiring an explicit pipe. Internally an allocated
79685b8d 889 * pipe is cached in the process, and reused during the lifetime of
932cc6d4
JA
890 * that process.
891 *
c66ab6fa
JA
892 */
893ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
894 splice_direct_actor *actor)
b92ce558
JA
895{
896 struct pipe_inode_info *pipe;
897 long ret, bytes;
898 umode_t i_mode;
c66ab6fa 899 size_t len;
0ff28d9f 900 int i, flags, more;
b92ce558
JA
901
902 /*
903 * We require the input being a regular file, as we don't want to
904 * randomly drop data for eg socket -> socket splicing. Use the
905 * piped splicing for that!
906 */
496ad9aa 907 i_mode = file_inode(in)->i_mode;
b92ce558
JA
908 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
909 return -EINVAL;
910
911 /*
912 * neither in nor out is a pipe, setup an internal pipe attached to
913 * 'out' and transfer the wanted data from 'in' to 'out' through that
914 */
915 pipe = current->splice_pipe;
49570e9b 916 if (unlikely(!pipe)) {
7bee130e 917 pipe = alloc_pipe_info();
b92ce558
JA
918 if (!pipe)
919 return -ENOMEM;
920
921 /*
922 * We don't have an immediate reader, but we'll read the stuff
00522fb4 923 * out of the pipe right after the splice_to_pipe(). So set
b92ce558
JA
924 * PIPE_READERS appropriately.
925 */
926 pipe->readers = 1;
927
928 current->splice_pipe = pipe;
929 }
930
931 /*
73d62d83 932 * Do the splice.
b92ce558
JA
933 */
934 ret = 0;
935 bytes = 0;
c66ab6fa
JA
936 len = sd->total_len;
937 flags = sd->flags;
938
939 /*
940 * Don't block on output, we have to drain the direct pipe.
941 */
942 sd->flags &= ~SPLICE_F_NONBLOCK;
0ff28d9f 943 more = sd->flags & SPLICE_F_MORE;
b92ce558 944
17614445
DW
945 WARN_ON_ONCE(pipe->nrbufs != 0);
946
b92ce558 947 while (len) {
51a92c0f 948 size_t read_len;
a82c53a0 949 loff_t pos = sd->pos, prev_pos = pos;
b92ce558 950
17614445
DW
951 /* Don't try to read more the pipe has space for. */
952 read_len = min_t(size_t, len,
953 (pipe->buffers - pipe->nrbufs) << PAGE_SHIFT);
954 ret = do_splice_to(in, &pos, pipe, read_len, flags);
51a92c0f 955 if (unlikely(ret <= 0))
b92ce558
JA
956 goto out_release;
957
958 read_len = ret;
c66ab6fa 959 sd->total_len = read_len;
b92ce558 960
0ff28d9f
CL
961 /*
962 * If more data is pending, set SPLICE_F_MORE
963 * If this is the last data and SPLICE_F_MORE was not set
964 * initially, clears it.
965 */
966 if (read_len < len)
967 sd->flags |= SPLICE_F_MORE;
968 else if (!more)
969 sd->flags &= ~SPLICE_F_MORE;
b92ce558
JA
970 /*
971 * NOTE: nonblocking mode only applies to the input. We
972 * must not do the output in nonblocking mode as then we
973 * could get stuck data in the internal pipe:
974 */
c66ab6fa 975 ret = actor(pipe, sd);
a82c53a0
TZ
976 if (unlikely(ret <= 0)) {
977 sd->pos = prev_pos;
b92ce558 978 goto out_release;
a82c53a0 979 }
b92ce558
JA
980
981 bytes += ret;
982 len -= ret;
bcd4f3ac 983 sd->pos = pos;
b92ce558 984
a82c53a0
TZ
985 if (ret < read_len) {
986 sd->pos = prev_pos + ret;
51a92c0f 987 goto out_release;
a82c53a0 988 }
b92ce558
JA
989 }
990
9e97198d 991done:
b92ce558 992 pipe->nrbufs = pipe->curbuf = 0;
80848708 993 file_accessed(in);
b92ce558
JA
994 return bytes;
995
996out_release:
997 /*
998 * If we did an incomplete transfer we must release
999 * the pipe buffers in question:
1000 */
35f3d14d 1001 for (i = 0; i < pipe->buffers; i++) {
b92ce558
JA
1002 struct pipe_buffer *buf = pipe->bufs + i;
1003
a779638c
MS
1004 if (buf->ops)
1005 pipe_buf_release(pipe, buf);
b92ce558 1006 }
b92ce558 1007
9e97198d
JA
1008 if (!bytes)
1009 bytes = ret;
c66ab6fa 1010
9e97198d 1011 goto done;
c66ab6fa
JA
1012}
1013EXPORT_SYMBOL(splice_direct_to_actor);
1014
1015static int direct_splice_actor(struct pipe_inode_info *pipe,
1016 struct splice_desc *sd)
1017{
6a14b90b 1018 struct file *file = sd->u.file;
c66ab6fa 1019
7995bd28 1020 return do_splice_from(pipe, file, sd->opos, sd->total_len,
2cb4b05e 1021 sd->flags);
c66ab6fa
JA
1022}
1023
932cc6d4
JA
1024/**
1025 * do_splice_direct - splices data directly between two files
1026 * @in: file to splice from
1027 * @ppos: input file offset
1028 * @out: file to splice to
acdb37c3 1029 * @opos: output file offset
932cc6d4
JA
1030 * @len: number of bytes to splice
1031 * @flags: splice modifier flags
1032 *
1033 * Description:
1034 * For use by do_sendfile(). splice can easily emulate sendfile, but
1035 * doing it in the application would incur an extra system call
1036 * (splice in + splice out, as compared to just sendfile()). So this helper
1037 * can splice directly through a process-private pipe.
1038 *
1039 */
c66ab6fa 1040long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
7995bd28 1041 loff_t *opos, size_t len, unsigned int flags)
c66ab6fa
JA
1042{
1043 struct splice_desc sd = {
1044 .len = len,
1045 .total_len = len,
1046 .flags = flags,
1047 .pos = *ppos,
6a14b90b 1048 .u.file = out,
7995bd28 1049 .opos = opos,
c66ab6fa 1050 };
51a92c0f 1051 long ret;
c66ab6fa 1052
18c67cb9
AV
1053 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1054 return -EBADF;
1055
1056 if (unlikely(out->f_flags & O_APPEND))
1057 return -EINVAL;
1058
1059 ret = rw_verify_area(WRITE, out, opos, len);
1060 if (unlikely(ret < 0))
1061 return ret;
1062
c66ab6fa 1063 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
51a92c0f 1064 if (ret > 0)
a82c53a0 1065 *ppos = sd.pos;
51a92c0f 1066
c66ab6fa 1067 return ret;
b92ce558 1068}
1c118596 1069EXPORT_SYMBOL(do_splice_direct);
b92ce558 1070
8924feff
AV
1071static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1072{
52bce911
LT
1073 for (;;) {
1074 if (unlikely(!pipe->readers)) {
1075 send_sig(SIGPIPE, current, 0);
1076 return -EPIPE;
1077 }
1078 if (pipe->nrbufs != pipe->buffers)
1079 return 0;
8924feff
AV
1080 if (flags & SPLICE_F_NONBLOCK)
1081 return -EAGAIN;
1082 if (signal_pending(current))
1083 return -ERESTARTSYS;
1084 pipe->waiting_writers++;
1085 pipe_wait(pipe);
1086 pipe->waiting_writers--;
1087 }
8924feff
AV
1088}
1089
7c77f0b3
MS
1090static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1091 struct pipe_inode_info *opipe,
1092 size_t len, unsigned int flags);
ddac0d39 1093
83f9135b
JA
1094/*
1095 * Determine where to splice to/from.
1096 */
529565dc
IM
1097static long do_splice(struct file *in, loff_t __user *off_in,
1098 struct file *out, loff_t __user *off_out,
1099 size_t len, unsigned int flags)
5274f052 1100{
7c77f0b3
MS
1101 struct pipe_inode_info *ipipe;
1102 struct pipe_inode_info *opipe;
7995bd28 1103 loff_t offset;
a4514ebd 1104 long ret;
5274f052 1105
71993e62
LT
1106 ipipe = get_pipe_info(in);
1107 opipe = get_pipe_info(out);
7c77f0b3
MS
1108
1109 if (ipipe && opipe) {
1110 if (off_in || off_out)
1111 return -ESPIPE;
1112
1113 if (!(in->f_mode & FMODE_READ))
1114 return -EBADF;
1115
1116 if (!(out->f_mode & FMODE_WRITE))
1117 return -EBADF;
1118
1119 /* Splicing to self would be fun, but... */
1120 if (ipipe == opipe)
1121 return -EINVAL;
1122
ee5e0011
SK
1123 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1124 flags |= SPLICE_F_NONBLOCK;
1125
7c77f0b3
MS
1126 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1127 }
1128
1129 if (ipipe) {
529565dc
IM
1130 if (off_in)
1131 return -ESPIPE;
b92ce558 1132 if (off_out) {
19c9a49b 1133 if (!(out->f_mode & FMODE_PWRITE))
b92ce558 1134 return -EINVAL;
cbb7e577 1135 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
b92ce558 1136 return -EFAULT;
7995bd28
AV
1137 } else {
1138 offset = out->f_pos;
1139 }
529565dc 1140
18c67cb9
AV
1141 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1142 return -EBADF;
1143
1144 if (unlikely(out->f_flags & O_APPEND))
1145 return -EINVAL;
1146
1147 ret = rw_verify_area(WRITE, out, &offset, len);
1148 if (unlikely(ret < 0))
1149 return ret;
1150
ee5e0011
SK
1151 if (in->f_flags & O_NONBLOCK)
1152 flags |= SPLICE_F_NONBLOCK;
1153
500368f7 1154 file_start_write(out);
7995bd28 1155 ret = do_splice_from(ipipe, out, &offset, len, flags);
500368f7 1156 file_end_write(out);
a4514ebd 1157
7995bd28
AV
1158 if (!off_out)
1159 out->f_pos = offset;
1160 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
a4514ebd
JA
1161 ret = -EFAULT;
1162
1163 return ret;
529565dc 1164 }
5274f052 1165
7c77f0b3 1166 if (opipe) {
529565dc
IM
1167 if (off_out)
1168 return -ESPIPE;
b92ce558 1169 if (off_in) {
19c9a49b 1170 if (!(in->f_mode & FMODE_PREAD))
b92ce558 1171 return -EINVAL;
cbb7e577 1172 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
b92ce558 1173 return -EFAULT;
7995bd28
AV
1174 } else {
1175 offset = in->f_pos;
1176 }
529565dc 1177
ee5e0011
SK
1178 if (out->f_flags & O_NONBLOCK)
1179 flags |= SPLICE_F_NONBLOCK;
1180
8924feff
AV
1181 pipe_lock(opipe);
1182 ret = wait_for_space(opipe, flags);
1183 if (!ret)
1184 ret = do_splice_to(in, &offset, opipe, len, flags);
1185 pipe_unlock(opipe);
1186 if (ret > 0)
1187 wakeup_pipe_readers(opipe);
7995bd28
AV
1188 if (!off_in)
1189 in->f_pos = offset;
1190 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
a4514ebd
JA
1191 ret = -EFAULT;
1192
1193 return ret;
529565dc 1194 }
5274f052
JA
1195
1196 return -EINVAL;
1197}
1198
79fddc4e
AV
1199static int iter_to_pipe(struct iov_iter *from,
1200 struct pipe_inode_info *pipe,
1201 unsigned flags)
912d35f8 1202{
79fddc4e
AV
1203 struct pipe_buffer buf = {
1204 .ops = &user_page_pipe_buf_ops,
1205 .flags = flags
1206 };
1207 size_t total = 0;
1208 int ret = 0;
1209 bool failed = false;
1210
1211 while (iov_iter_count(from) && !failed) {
1212 struct page *pages[16];
db85a9eb
AV
1213 ssize_t copied;
1214 size_t start;
79fddc4e 1215 int n;
db85a9eb 1216
79fddc4e
AV
1217 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1218 if (copied <= 0) {
1219 ret = copied;
1220 break;
1221 }
db85a9eb 1222
79fddc4e 1223 for (n = 0; copied; n++, start = 0) {
db85a9eb 1224 int size = min_t(int, copied, PAGE_SIZE - start);
79fddc4e
AV
1225 if (!failed) {
1226 buf.page = pages[n];
1227 buf.offset = start;
1228 buf.len = size;
1229 ret = add_to_pipe(pipe, &buf);
1230 if (unlikely(ret < 0)) {
1231 failed = true;
1232 } else {
1233 iov_iter_advance(from, ret);
1234 total += ret;
1235 }
1236 } else {
1237 put_page(pages[n]);
1238 }
db85a9eb 1239 copied -= size;
912d35f8 1240 }
912d35f8 1241 }
79fddc4e 1242 return total ? total : ret;
912d35f8
JA
1243}
1244
6a14b90b
JA
1245static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1246 struct splice_desc *sd)
1247{
6130f531
AV
1248 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1249 return n == sd->len ? n : -EFAULT;
6a14b90b
JA
1250}
1251
1252/*
1253 * For lack of a better implementation, implement vmsplice() to userspace
1254 * as a simple copy of the pipes pages to the user iov.
1255 */
87a3002a
AV
1256static long vmsplice_to_user(struct file *file, struct iov_iter *iter,
1257 unsigned int flags)
6a14b90b 1258{
87a3002a
AV
1259 struct pipe_inode_info *pipe = get_pipe_info(file);
1260 struct splice_desc sd = {
1261 .total_len = iov_iter_count(iter),
1262 .flags = flags,
1263 .u.data = iter
1264 };
1265 long ret = 0;
6a14b90b 1266
6a14b90b
JA
1267 if (!pipe)
1268 return -EBADF;
1269
345995fa
AV
1270 if (sd.total_len) {
1271 pipe_lock(pipe);
1272 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1273 pipe_unlock(pipe);
1274 }
6a14b90b
JA
1275
1276 return ret;
1277}
1278
912d35f8
JA
1279/*
1280 * vmsplice splices a user address range into a pipe. It can be thought of
1281 * as splice-from-memory, where the regular splice is splice-from-file (or
1282 * to file). In both cases the output is a pipe, naturally.
912d35f8 1283 */
87a3002a
AV
1284static long vmsplice_to_pipe(struct file *file, struct iov_iter *iter,
1285 unsigned int flags)
912d35f8 1286{
ddac0d39 1287 struct pipe_inode_info *pipe;
87a3002a 1288 long ret = 0;
79fddc4e
AV
1289 unsigned buf_flag = 0;
1290
1291 if (flags & SPLICE_F_GIFT)
1292 buf_flag = PIPE_BUF_FLAG_GIFT;
912d35f8 1293
71993e62 1294 pipe = get_pipe_info(file);
ddac0d39 1295 if (!pipe)
912d35f8 1296 return -EBADF;
912d35f8 1297
8924feff
AV
1298 pipe_lock(pipe);
1299 ret = wait_for_space(pipe, flags);
79fddc4e 1300 if (!ret)
87a3002a 1301 ret = iter_to_pipe(iter, pipe, buf_flag);
8924feff
AV
1302 pipe_unlock(pipe);
1303 if (ret > 0)
1304 wakeup_pipe_readers(pipe);
35f3d14d 1305 return ret;
912d35f8
JA
1306}
1307
87a3002a
AV
1308static int vmsplice_type(struct fd f, int *type)
1309{
1310 if (!f.file)
1311 return -EBADF;
1312 if (f.file->f_mode & FMODE_WRITE) {
1313 *type = WRITE;
1314 } else if (f.file->f_mode & FMODE_READ) {
1315 *type = READ;
1316 } else {
1317 fdput(f);
1318 return -EBADF;
1319 }
1320 return 0;
1321}
1322
6a14b90b
JA
1323/*
1324 * Note that vmsplice only really supports true splicing _from_ user memory
1325 * to a pipe, not the other way around. Splicing from user memory is a simple
1326 * operation that can be supported without any funky alignment restrictions
1327 * or nasty vm tricks. We simply map in the user memory and fill them into
1328 * a pipe. The reverse isn't quite as easy, though. There are two possible
1329 * solutions for that:
1330 *
1331 * - memcpy() the data internally, at which point we might as well just
1332 * do a regular read() on the buffer anyway.
1333 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1334 * has restriction limitations on both ends of the pipe).
1335 *
1336 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1337 *
1338 */
87a3002a 1339static long do_vmsplice(struct file *f, struct iov_iter *iter, unsigned int flags)
912d35f8 1340{
3d6ea290
AV
1341 if (unlikely(flags & ~SPLICE_F_ALL))
1342 return -EINVAL;
6a14b90b 1343
87a3002a
AV
1344 if (!iov_iter_count(iter))
1345 return 0;
912d35f8 1346
87a3002a
AV
1347 if (iov_iter_rw(iter) == WRITE)
1348 return vmsplice_to_pipe(f, iter, flags);
1349 else
1350 return vmsplice_to_user(f, iter, flags);
912d35f8
JA
1351}
1352
87a3002a 1353SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, uiov,
30cfe4ef
DB
1354 unsigned long, nr_segs, unsigned int, flags)
1355{
87a3002a
AV
1356 struct iovec iovstack[UIO_FASTIOV];
1357 struct iovec *iov = iovstack;
1358 struct iov_iter iter;
1359 long error;
1360 struct fd f;
1361 int type;
1362
1363 f = fdget(fd);
1364 error = vmsplice_type(f, &type);
1365 if (error)
1366 return error;
1367
1368 error = import_iovec(type, uiov, nr_segs,
1369 ARRAY_SIZE(iovstack), &iov, &iter);
1370 if (!error) {
1371 error = do_vmsplice(f.file, &iter, flags);
1372 kfree(iov);
1373 }
1374 fdput(f);
1375 return error;
30cfe4ef
DB
1376}
1377
76b021d0
AV
1378#ifdef CONFIG_COMPAT
1379COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1380 unsigned int, nr_segs, unsigned int, flags)
1381{
87a3002a
AV
1382 struct iovec iovstack[UIO_FASTIOV];
1383 struct iovec *iov = iovstack;
1384 struct iov_iter iter;
1385 long error;
1386 struct fd f;
1387 int type;
1388
1389 f = fdget(fd);
1390 error = vmsplice_type(f, &type);
1391 if (error)
1392 return error;
1393
1394 error = compat_import_iovec(type, iov32, nr_segs,
1395 ARRAY_SIZE(iovstack), &iov, &iter);
1396 if (!error) {
1397 error = do_vmsplice(f.file, &iter, flags);
1398 kfree(iov);
76b021d0 1399 }
87a3002a
AV
1400 fdput(f);
1401 return error;
76b021d0
AV
1402}
1403#endif
1404
836f92ad
HC
1405SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1406 int, fd_out, loff_t __user *, off_out,
1407 size_t, len, unsigned int, flags)
5274f052 1408{
2903ff01 1409 struct fd in, out;
5274f052 1410 long error;
5274f052
JA
1411
1412 if (unlikely(!len))
1413 return 0;
1414
3d6ea290
AV
1415 if (unlikely(flags & ~SPLICE_F_ALL))
1416 return -EINVAL;
1417
5274f052 1418 error = -EBADF;
2903ff01
AV
1419 in = fdget(fd_in);
1420 if (in.file) {
1421 if (in.file->f_mode & FMODE_READ) {
1422 out = fdget(fd_out);
1423 if (out.file) {
1424 if (out.file->f_mode & FMODE_WRITE)
1425 error = do_splice(in.file, off_in,
1426 out.file, off_out,
529565dc 1427 len, flags);
2903ff01 1428 fdput(out);
5274f052
JA
1429 }
1430 }
2903ff01 1431 fdput(in);
5274f052 1432 }
5274f052
JA
1433 return error;
1434}
70524490 1435
aadd06e5
JA
1436/*
1437 * Make sure there's data to read. Wait for input if we can, otherwise
1438 * return an appropriate error.
1439 */
7c77f0b3 1440static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
aadd06e5
JA
1441{
1442 int ret;
1443
1444 /*
1445 * Check ->nrbufs without the inode lock first. This function
1446 * is speculative anyways, so missing one is ok.
1447 */
1448 if (pipe->nrbufs)
1449 return 0;
1450
1451 ret = 0;
61e0d47c 1452 pipe_lock(pipe);
aadd06e5
JA
1453
1454 while (!pipe->nrbufs) {
1455 if (signal_pending(current)) {
1456 ret = -ERESTARTSYS;
1457 break;
1458 }
1459 if (!pipe->writers)
1460 break;
1461 if (!pipe->waiting_writers) {
1462 if (flags & SPLICE_F_NONBLOCK) {
1463 ret = -EAGAIN;
1464 break;
1465 }
1466 }
1467 pipe_wait(pipe);
1468 }
1469
61e0d47c 1470 pipe_unlock(pipe);
aadd06e5
JA
1471 return ret;
1472}
1473
1474/*
1475 * Make sure there's writeable room. Wait for room if we can, otherwise
1476 * return an appropriate error.
1477 */
7c77f0b3 1478static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
aadd06e5
JA
1479{
1480 int ret;
1481
1482 /*
1483 * Check ->nrbufs without the inode lock first. This function
1484 * is speculative anyways, so missing one is ok.
1485 */
35f3d14d 1486 if (pipe->nrbufs < pipe->buffers)
aadd06e5
JA
1487 return 0;
1488
1489 ret = 0;
61e0d47c 1490 pipe_lock(pipe);
aadd06e5 1491
35f3d14d 1492 while (pipe->nrbufs >= pipe->buffers) {
aadd06e5
JA
1493 if (!pipe->readers) {
1494 send_sig(SIGPIPE, current, 0);
1495 ret = -EPIPE;
1496 break;
1497 }
1498 if (flags & SPLICE_F_NONBLOCK) {
1499 ret = -EAGAIN;
1500 break;
1501 }
1502 if (signal_pending(current)) {
1503 ret = -ERESTARTSYS;
1504 break;
1505 }
1506 pipe->waiting_writers++;
1507 pipe_wait(pipe);
1508 pipe->waiting_writers--;
1509 }
1510
61e0d47c 1511 pipe_unlock(pipe);
aadd06e5
JA
1512 return ret;
1513}
1514
7c77f0b3
MS
1515/*
1516 * Splice contents of ipipe to opipe.
1517 */
1518static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1519 struct pipe_inode_info *opipe,
1520 size_t len, unsigned int flags)
1521{
1522 struct pipe_buffer *ibuf, *obuf;
1523 int ret = 0, nbuf;
1524 bool input_wakeup = false;
1525
1526
1527retry:
1528 ret = ipipe_prep(ipipe, flags);
1529 if (ret)
1530 return ret;
1531
1532 ret = opipe_prep(opipe, flags);
1533 if (ret)
1534 return ret;
1535
1536 /*
1537 * Potential ABBA deadlock, work around it by ordering lock
1538 * grabbing by pipe info address. Otherwise two different processes
1539 * could deadlock (one doing tee from A -> B, the other from B -> A).
1540 */
1541 pipe_double_lock(ipipe, opipe);
1542
1543 do {
1544 if (!opipe->readers) {
1545 send_sig(SIGPIPE, current, 0);
1546 if (!ret)
1547 ret = -EPIPE;
1548 break;
1549 }
1550
1551 if (!ipipe->nrbufs && !ipipe->writers)
1552 break;
1553
1554 /*
1555 * Cannot make any progress, because either the input
1556 * pipe is empty or the output pipe is full.
1557 */
35f3d14d 1558 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
7c77f0b3
MS
1559 /* Already processed some buffers, break */
1560 if (ret)
1561 break;
1562
1563 if (flags & SPLICE_F_NONBLOCK) {
1564 ret = -EAGAIN;
1565 break;
1566 }
1567
1568 /*
1569 * We raced with another reader/writer and haven't
1570 * managed to process any buffers. A zero return
1571 * value means EOF, so retry instead.
1572 */
1573 pipe_unlock(ipipe);
1574 pipe_unlock(opipe);
1575 goto retry;
1576 }
1577
1578 ibuf = ipipe->bufs + ipipe->curbuf;
35f3d14d 1579 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
7c77f0b3
MS
1580 obuf = opipe->bufs + nbuf;
1581
1582 if (len >= ibuf->len) {
1583 /*
1584 * Simply move the whole buffer from ipipe to opipe
1585 */
1586 *obuf = *ibuf;
1587 ibuf->ops = NULL;
1588 opipe->nrbufs++;
35f3d14d 1589 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
7c77f0b3
MS
1590 ipipe->nrbufs--;
1591 input_wakeup = true;
1592 } else {
1593 /*
1594 * Get a reference to this pipe buffer,
1595 * so we can copy the contents over.
1596 */
15fab63e
MW
1597 if (!pipe_buf_get(ipipe, ibuf)) {
1598 if (ret == 0)
1599 ret = -EFAULT;
1600 break;
1601 }
7c77f0b3
MS
1602 *obuf = *ibuf;
1603
1604 /*
1605 * Don't inherit the gift flag, we need to
1606 * prevent multiple steals of this page.
1607 */
1608 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1609
a0ce2f0a
JH
1610 pipe_buf_mark_unmergeable(obuf);
1611
7c77f0b3
MS
1612 obuf->len = len;
1613 opipe->nrbufs++;
1614 ibuf->offset += obuf->len;
1615 ibuf->len -= obuf->len;
1616 }
1617 ret += obuf->len;
1618 len -= obuf->len;
1619 } while (len);
1620
1621 pipe_unlock(ipipe);
1622 pipe_unlock(opipe);
1623
1624 /*
1625 * If we put data in the output pipe, wakeup any potential readers.
1626 */
825cdcb1
NK
1627 if (ret > 0)
1628 wakeup_pipe_readers(opipe);
1629
7c77f0b3
MS
1630 if (input_wakeup)
1631 wakeup_pipe_writers(ipipe);
1632
1633 return ret;
1634}
1635
70524490
JA
1636/*
1637 * Link contents of ipipe to opipe.
1638 */
1639static int link_pipe(struct pipe_inode_info *ipipe,
1640 struct pipe_inode_info *opipe,
1641 size_t len, unsigned int flags)
1642{
1643 struct pipe_buffer *ibuf, *obuf;
aadd06e5 1644 int ret = 0, i = 0, nbuf;
70524490
JA
1645
1646 /*
1647 * Potential ABBA deadlock, work around it by ordering lock
61e0d47c 1648 * grabbing by pipe info address. Otherwise two different processes
70524490
JA
1649 * could deadlock (one doing tee from A -> B, the other from B -> A).
1650 */
61e0d47c 1651 pipe_double_lock(ipipe, opipe);
70524490 1652
aadd06e5 1653 do {
70524490
JA
1654 if (!opipe->readers) {
1655 send_sig(SIGPIPE, current, 0);
1656 if (!ret)
1657 ret = -EPIPE;
1658 break;
1659 }
70524490 1660
aadd06e5
JA
1661 /*
1662 * If we have iterated all input buffers or ran out of
1663 * output room, break.
1664 */
35f3d14d 1665 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
aadd06e5 1666 break;
70524490 1667
35f3d14d
JA
1668 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1669 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
70524490
JA
1670
1671 /*
aadd06e5
JA
1672 * Get a reference to this pipe buffer,
1673 * so we can copy the contents over.
70524490 1674 */
15fab63e
MW
1675 if (!pipe_buf_get(ipipe, ibuf)) {
1676 if (ret == 0)
1677 ret = -EFAULT;
1678 break;
1679 }
aadd06e5
JA
1680
1681 obuf = opipe->bufs + nbuf;
1682 *obuf = *ibuf;
1683
2a27250e 1684 /*
aadd06e5
JA
1685 * Don't inherit the gift flag, we need to
1686 * prevent multiple steals of this page.
2a27250e 1687 */
aadd06e5 1688 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
70524490 1689
a0ce2f0a
JH
1690 pipe_buf_mark_unmergeable(obuf);
1691
aadd06e5
JA
1692 if (obuf->len > len)
1693 obuf->len = len;
70524490 1694
aadd06e5
JA
1695 opipe->nrbufs++;
1696 ret += obuf->len;
1697 len -= obuf->len;
1698 i++;
1699 } while (len);
70524490 1700
02cf01ae
JA
1701 /*
1702 * return EAGAIN if we have the potential of some data in the
1703 * future, otherwise just return 0
1704 */
1705 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1706 ret = -EAGAIN;
1707
61e0d47c
MS
1708 pipe_unlock(ipipe);
1709 pipe_unlock(opipe);
70524490 1710
aadd06e5
JA
1711 /*
1712 * If we put data in the output pipe, wakeup any potential readers.
1713 */
825cdcb1
NK
1714 if (ret > 0)
1715 wakeup_pipe_readers(opipe);
70524490
JA
1716
1717 return ret;
1718}
1719
1720/*
1721 * This is a tee(1) implementation that works on pipes. It doesn't copy
1722 * any data, it simply references the 'in' pages on the 'out' pipe.
1723 * The 'flags' used are the SPLICE_F_* variants, currently the only
1724 * applicable one is SPLICE_F_NONBLOCK.
1725 */
1726static long do_tee(struct file *in, struct file *out, size_t len,
1727 unsigned int flags)
1728{
71993e62
LT
1729 struct pipe_inode_info *ipipe = get_pipe_info(in);
1730 struct pipe_inode_info *opipe = get_pipe_info(out);
aadd06e5 1731 int ret = -EINVAL;
70524490
JA
1732
1733 /*
aadd06e5
JA
1734 * Duplicate the contents of ipipe to opipe without actually
1735 * copying the data.
70524490 1736 */
aadd06e5 1737 if (ipipe && opipe && ipipe != opipe) {
ee5e0011
SK
1738 if ((in->f_flags | out->f_flags) & O_NONBLOCK)
1739 flags |= SPLICE_F_NONBLOCK;
1740
aadd06e5
JA
1741 /*
1742 * Keep going, unless we encounter an error. The ipipe/opipe
1743 * ordering doesn't really matter.
1744 */
7c77f0b3 1745 ret = ipipe_prep(ipipe, flags);
aadd06e5 1746 if (!ret) {
7c77f0b3 1747 ret = opipe_prep(opipe, flags);
02cf01ae 1748 if (!ret)
aadd06e5 1749 ret = link_pipe(ipipe, opipe, len, flags);
aadd06e5
JA
1750 }
1751 }
70524490 1752
aadd06e5 1753 return ret;
70524490
JA
1754}
1755
836f92ad 1756SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
70524490 1757{
2903ff01
AV
1758 struct fd in;
1759 int error;
70524490 1760
3d6ea290
AV
1761 if (unlikely(flags & ~SPLICE_F_ALL))
1762 return -EINVAL;
1763
70524490
JA
1764 if (unlikely(!len))
1765 return 0;
1766
1767 error = -EBADF;
2903ff01
AV
1768 in = fdget(fdin);
1769 if (in.file) {
1770 if (in.file->f_mode & FMODE_READ) {
1771 struct fd out = fdget(fdout);
1772 if (out.file) {
1773 if (out.file->f_mode & FMODE_WRITE)
1774 error = do_tee(in.file, out.file,
1775 len, flags);
1776 fdput(out);
70524490
JA
1777 }
1778 }
2903ff01 1779 fdput(in);
70524490
JA
1780 }
1781
1782 return error;
1783}