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