]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - fs/splice.c
UBUNTU: Ubuntu-4.13.0-45.50
[mirror_ubuntu-artful-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{
047fe360
ED
256 unsigned int buffers = ACCESS_ONCE(pipe->buffers);
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
7bb307e8 367ssize_t kernel_write(struct file *file, const char *buf, size_t count,
b2858d7d 368 loff_t pos)
0b0a47f5
MS
369{
370 mm_segment_t old_fs;
371 ssize_t res;
372
373 old_fs = get_fs();
374 set_fs(get_ds());
375 /* The cast to a user pointer is valid due to the set_fs() */
7bb307e8 376 res = vfs_write(file, (__force const char __user *)buf, count, &pos);
0b0a47f5
MS
377 set_fs(old_fs);
378
379 return res;
380}
7bb307e8 381EXPORT_SYMBOL(kernel_write);
0b0a47f5 382
82c156f8 383static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
6818173b
MS
384 struct pipe_inode_info *pipe, size_t len,
385 unsigned int flags)
386{
523ac9af
AV
387 struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
388 struct iov_iter to;
389 struct page **pages;
6818173b 390 unsigned int nr_pages;
13c0f52b 391 size_t offset, base, copied = 0;
6818173b 392 ssize_t res;
6818173b 393 int i;
35f3d14d 394
523ac9af
AV
395 if (pipe->nrbufs == pipe->buffers)
396 return -EAGAIN;
35f3d14d 397
523ac9af
AV
398 /*
399 * Try to keep page boundaries matching to source pagecache ones -
400 * it probably won't be much help, but...
401 */
09cbfeaf 402 offset = *ppos & ~PAGE_MASK;
6818173b 403
523ac9af 404 iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
6818173b 405
13c0f52b 406 res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &base);
523ac9af
AV
407 if (res <= 0)
408 return -ENOMEM;
6818173b 409
13c0f52b 410 nr_pages = DIV_ROUND_UP(res + base, PAGE_SIZE);
6818173b 411
523ac9af
AV
412 vec = __vec;
413 if (nr_pages > PIPE_DEF_BUFFERS) {
414 vec = kmalloc(nr_pages * sizeof(struct kvec), GFP_KERNEL);
415 if (unlikely(!vec)) {
416 res = -ENOMEM;
417 goto out;
418 }
77f6bf57 419 }
6818173b 420
523ac9af
AV
421 pipe->bufs[to.idx].offset = offset;
422 pipe->bufs[to.idx].len -= offset;
423
424 for (i = 0; i < nr_pages; i++) {
425 size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
426 vec[i].iov_base = page_address(pages[i]) + offset;
427 vec[i].iov_len = this_len;
428 len -= this_len;
429 offset = 0;
6818173b 430 }
6818173b 431
523ac9af
AV
432 res = kernel_readv(in, vec, nr_pages, *ppos);
433 if (res > 0) {
434 copied = res;
6818173b 435 *ppos += res;
523ac9af 436 }
6818173b 437
35f3d14d
JA
438 if (vec != __vec)
439 kfree(vec);
523ac9af
AV
440out:
441 for (i = 0; i < nr_pages; i++)
442 put_page(pages[i]);
443 kvfree(pages);
444 iov_iter_advance(&to, copied); /* truncates and discards */
6818173b 445 return res;
6818173b 446}
6818173b 447
5274f052 448/*
4f6f0bd2 449 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
016b661e 450 * using sendpage(). Return the number of bytes sent.
5274f052 451 */
76ad4d11 452static int pipe_to_sendpage(struct pipe_inode_info *pipe,
5274f052
JA
453 struct pipe_buffer *buf, struct splice_desc *sd)
454{
6a14b90b 455 struct file *file = sd->u.file;
5274f052 456 loff_t pos = sd->pos;
a8adbe37 457 int more;
5274f052 458
72c2d531 459 if (!likely(file->f_op->sendpage))
a8adbe37
MM
460 return -EINVAL;
461
35f9c09f 462 more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
ae62ca7b
ED
463
464 if (sd->len < sd->total_len && pipe->nrbufs > 1)
35f9c09f 465 more |= MSG_SENDPAGE_NOTLAST;
ae62ca7b 466
a8adbe37
MM
467 return file->f_op->sendpage(file, buf->page, buf->offset,
468 sd->len, &pos, more);
5274f052
JA
469}
470
b3c2d2dd
MS
471static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
472{
473 smp_mb();
474 if (waitqueue_active(&pipe->wait))
475 wake_up_interruptible(&pipe->wait);
476 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
477}
478
932cc6d4 479/**
b3c2d2dd 480 * splice_from_pipe_feed - feed available data from a pipe to a file
932cc6d4
JA
481 * @pipe: pipe to splice from
482 * @sd: information to @actor
483 * @actor: handler that splices the data
484 *
485 * Description:
b3c2d2dd
MS
486 * This function loops over the pipe and calls @actor to do the
487 * actual moving of a single struct pipe_buffer to the desired
488 * destination. It returns when there's no more buffers left in
489 * the pipe or if the requested number of bytes (@sd->total_len)
490 * have been copied. It returns a positive number (one) if the
491 * pipe needs to be filled with more data, zero if the required
492 * number of bytes have been copied and -errno on error.
932cc6d4 493 *
b3c2d2dd
MS
494 * This, together with splice_from_pipe_{begin,end,next}, may be
495 * used to implement the functionality of __splice_from_pipe() when
496 * locking is required around copying the pipe buffers to the
497 * destination.
83f9135b 498 */
96f9bc8f 499static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
b3c2d2dd 500 splice_actor *actor)
5274f052 501{
b3c2d2dd 502 int ret;
5274f052 503
b3c2d2dd
MS
504 while (pipe->nrbufs) {
505 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
5274f052 506
b3c2d2dd
MS
507 sd->len = buf->len;
508 if (sd->len > sd->total_len)
509 sd->len = sd->total_len;
5274f052 510
fba597db 511 ret = pipe_buf_confirm(pipe, buf);
a8adbe37 512 if (unlikely(ret)) {
b3c2d2dd
MS
513 if (ret == -ENODATA)
514 ret = 0;
515 return ret;
516 }
a8adbe37
MM
517
518 ret = actor(pipe, buf, sd);
519 if (ret <= 0)
520 return ret;
521
b3c2d2dd
MS
522 buf->offset += ret;
523 buf->len -= ret;
524
525 sd->num_spliced += ret;
526 sd->len -= ret;
527 sd->pos += ret;
528 sd->total_len -= ret;
529
530 if (!buf->len) {
a779638c 531 pipe_buf_release(pipe, buf);
35f3d14d 532 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
b3c2d2dd 533 pipe->nrbufs--;
6447a3cf 534 if (pipe->files)
b3c2d2dd
MS
535 sd->need_wakeup = true;
536 }
5274f052 537
b3c2d2dd
MS
538 if (!sd->total_len)
539 return 0;
540 }
5274f052 541
b3c2d2dd
MS
542 return 1;
543}
5274f052 544
b3c2d2dd
MS
545/**
546 * splice_from_pipe_next - wait for some data to splice from
547 * @pipe: pipe to splice from
548 * @sd: information about the splice operation
549 *
550 * Description:
551 * This function will wait for some data and return a positive
552 * value (one) if pipe buffers are available. It will return zero
553 * or -errno if no more data needs to be spliced.
554 */
96f9bc8f 555static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
b3c2d2dd 556{
c725bfce
JK
557 /*
558 * Check for signal early to make process killable when there are
559 * always buffers available
560 */
561 if (signal_pending(current))
562 return -ERESTARTSYS;
563
b3c2d2dd
MS
564 while (!pipe->nrbufs) {
565 if (!pipe->writers)
566 return 0;
016b661e 567
b3c2d2dd
MS
568 if (!pipe->waiting_writers && sd->num_spliced)
569 return 0;
73d62d83 570
b3c2d2dd
MS
571 if (sd->flags & SPLICE_F_NONBLOCK)
572 return -EAGAIN;
5274f052 573
b3c2d2dd
MS
574 if (signal_pending(current))
575 return -ERESTARTSYS;
5274f052 576
b3c2d2dd
MS
577 if (sd->need_wakeup) {
578 wakeup_pipe_writers(pipe);
579 sd->need_wakeup = false;
5274f052
JA
580 }
581
b3c2d2dd
MS
582 pipe_wait(pipe);
583 }
29e35094 584
b3c2d2dd
MS
585 return 1;
586}
5274f052 587
b3c2d2dd
MS
588/**
589 * splice_from_pipe_begin - start splicing from pipe
b80901bb 590 * @sd: information about the splice operation
b3c2d2dd
MS
591 *
592 * Description:
593 * This function should be called before a loop containing
594 * splice_from_pipe_next() and splice_from_pipe_feed() to
595 * initialize the necessary fields of @sd.
596 */
96f9bc8f 597static void splice_from_pipe_begin(struct splice_desc *sd)
b3c2d2dd
MS
598{
599 sd->num_spliced = 0;
600 sd->need_wakeup = false;
601}
5274f052 602
b3c2d2dd
MS
603/**
604 * splice_from_pipe_end - finish splicing from pipe
605 * @pipe: pipe to splice from
606 * @sd: information about the splice operation
607 *
608 * Description:
609 * This function will wake up pipe writers if necessary. It should
610 * be called after a loop containing splice_from_pipe_next() and
611 * splice_from_pipe_feed().
612 */
96f9bc8f 613static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
b3c2d2dd
MS
614{
615 if (sd->need_wakeup)
616 wakeup_pipe_writers(pipe);
617}
5274f052 618
b3c2d2dd
MS
619/**
620 * __splice_from_pipe - splice data from a pipe to given actor
621 * @pipe: pipe to splice from
622 * @sd: information to @actor
623 * @actor: handler that splices the data
624 *
625 * Description:
626 * This function does little more than loop over the pipe and call
627 * @actor to do the actual moving of a single struct pipe_buffer to
628 * the desired destination. See pipe_to_file, pipe_to_sendpage, or
629 * pipe_to_user.
630 *
631 */
632ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
633 splice_actor *actor)
634{
635 int ret;
5274f052 636
b3c2d2dd
MS
637 splice_from_pipe_begin(sd);
638 do {
c2489e07 639 cond_resched();
b3c2d2dd
MS
640 ret = splice_from_pipe_next(pipe, sd);
641 if (ret > 0)
642 ret = splice_from_pipe_feed(pipe, sd, actor);
643 } while (ret > 0);
644 splice_from_pipe_end(pipe, sd);
645
646 return sd->num_spliced ? sd->num_spliced : ret;
5274f052 647}
40bee44e 648EXPORT_SYMBOL(__splice_from_pipe);
5274f052 649
932cc6d4
JA
650/**
651 * splice_from_pipe - splice data from a pipe to a file
652 * @pipe: pipe to splice from
653 * @out: file to splice to
654 * @ppos: position in @out
655 * @len: how many bytes to splice
656 * @flags: splice modifier flags
657 * @actor: handler that splices the data
658 *
659 * Description:
2933970b 660 * See __splice_from_pipe. This function locks the pipe inode,
932cc6d4
JA
661 * otherwise it's identical to __splice_from_pipe().
662 *
663 */
6da61809
MF
664ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
665 loff_t *ppos, size_t len, unsigned int flags,
666 splice_actor *actor)
667{
668 ssize_t ret;
c66ab6fa
JA
669 struct splice_desc sd = {
670 .total_len = len,
671 .flags = flags,
672 .pos = *ppos,
6a14b90b 673 .u.file = out,
c66ab6fa 674 };
6da61809 675
61e0d47c 676 pipe_lock(pipe);
c66ab6fa 677 ret = __splice_from_pipe(pipe, &sd, actor);
61e0d47c 678 pipe_unlock(pipe);
6da61809
MF
679
680 return ret;
681}
682
8d020765
AV
683/**
684 * iter_file_splice_write - splice data from a pipe to a file
685 * @pipe: pipe info
686 * @out: file to write to
687 * @ppos: position in @out
688 * @len: number of bytes to splice
689 * @flags: splice modifier flags
690 *
691 * Description:
692 * Will either move or copy pages (determined by @flags options) from
693 * the given pipe inode to the given file.
694 * This one is ->write_iter-based.
695 *
696 */
697ssize_t
698iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
699 loff_t *ppos, size_t len, unsigned int flags)
700{
701 struct splice_desc sd = {
702 .total_len = len,
703 .flags = flags,
704 .pos = *ppos,
705 .u.file = out,
706 };
707 int nbufs = pipe->buffers;
708 struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
709 GFP_KERNEL);
710 ssize_t ret;
711
712 if (unlikely(!array))
713 return -ENOMEM;
714
715 pipe_lock(pipe);
716
717 splice_from_pipe_begin(&sd);
718 while (sd.total_len) {
719 struct iov_iter from;
8d020765
AV
720 size_t left;
721 int n, idx;
722
723 ret = splice_from_pipe_next(pipe, &sd);
724 if (ret <= 0)
725 break;
726
727 if (unlikely(nbufs < pipe->buffers)) {
728 kfree(array);
729 nbufs = pipe->buffers;
730 array = kcalloc(nbufs, sizeof(struct bio_vec),
731 GFP_KERNEL);
732 if (!array) {
733 ret = -ENOMEM;
734 break;
735 }
736 }
737
738 /* build the vector */
739 left = sd.total_len;
740 for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
741 struct pipe_buffer *buf = pipe->bufs + idx;
742 size_t this_len = buf->len;
743
744 if (this_len > left)
745 this_len = left;
746
747 if (idx == pipe->buffers - 1)
748 idx = -1;
749
fba597db 750 ret = pipe_buf_confirm(pipe, buf);
8d020765
AV
751 if (unlikely(ret)) {
752 if (ret == -ENODATA)
753 ret = 0;
754 goto done;
755 }
756
757 array[n].bv_page = buf->page;
758 array[n].bv_len = this_len;
759 array[n].bv_offset = buf->offset;
760 left -= this_len;
761 }
762
05afcb77
AV
763 iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
764 sd.total_len - left);
abbb6589 765 ret = vfs_iter_write(out, &from, &sd.pos, 0);
8d020765
AV
766 if (ret <= 0)
767 break;
768
769 sd.num_spliced += ret;
770 sd.total_len -= ret;
dbe4e192 771 *ppos = sd.pos;
8d020765
AV
772
773 /* dismiss the fully eaten buffers, adjust the partial one */
774 while (ret) {
775 struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
776 if (ret >= buf->len) {
8d020765
AV
777 ret -= buf->len;
778 buf->len = 0;
a779638c 779 pipe_buf_release(pipe, buf);
8d020765
AV
780 pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
781 pipe->nrbufs--;
782 if (pipe->files)
783 sd.need_wakeup = true;
784 } else {
785 buf->offset += ret;
786 buf->len -= ret;
787 ret = 0;
788 }
789 }
790 }
791done:
792 kfree(array);
793 splice_from_pipe_end(pipe, &sd);
794
795 pipe_unlock(pipe);
796
797 if (sd.num_spliced)
798 ret = sd.num_spliced;
799
800 return ret;
801}
802
803EXPORT_SYMBOL(iter_file_splice_write);
804
b2858d7d
MS
805static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
806 struct splice_desc *sd)
0b0a47f5 807{
b2858d7d
MS
808 int ret;
809 void *data;
06ae43f3 810 loff_t tmp = sd->pos;
b2858d7d 811
fbb32750 812 data = kmap(buf->page);
06ae43f3 813 ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
fbb32750 814 kunmap(buf->page);
b2858d7d
MS
815
816 return ret;
0b0a47f5
MS
817}
818
819static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
820 struct file *out, loff_t *ppos,
821 size_t len, unsigned int flags)
822{
b2858d7d 823 ssize_t ret;
0b0a47f5 824
b2858d7d
MS
825 ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
826 if (ret > 0)
827 *ppos += ret;
0b0a47f5 828
b2858d7d 829 return ret;
0b0a47f5
MS
830}
831
83f9135b
JA
832/**
833 * generic_splice_sendpage - splice data from a pipe to a socket
932cc6d4 834 * @pipe: pipe to splice from
83f9135b 835 * @out: socket to write to
932cc6d4 836 * @ppos: position in @out
83f9135b
JA
837 * @len: number of bytes to splice
838 * @flags: splice modifier flags
839 *
932cc6d4
JA
840 * Description:
841 * Will send @len bytes from the pipe to a network socket. No data copying
842 * is involved.
83f9135b
JA
843 *
844 */
3a326a2c 845ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
cbb7e577 846 loff_t *ppos, size_t len, unsigned int flags)
5274f052 847{
00522fb4 848 return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
5274f052
JA
849}
850
059a8f37 851EXPORT_SYMBOL(generic_splice_sendpage);
a0f06780 852
83f9135b
JA
853/*
854 * Attempt to initiate a splice from pipe to file.
855 */
b6450630
SF
856long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
857 loff_t *ppos, size_t len, unsigned int flags)
5274f052 858{
0b0a47f5
MS
859 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
860 loff_t *, size_t, unsigned int);
5274f052 861
72c2d531 862 if (out->f_op->splice_write)
cc56f7de
CG
863 splice_write = out->f_op->splice_write;
864 else
0b0a47f5
MS
865 splice_write = default_file_splice_write;
866
500368f7 867 return splice_write(pipe, out, ppos, len, flags);
5274f052 868}
b6450630 869EXPORT_SYMBOL_GPL(do_splice_from);
5274f052 870
83f9135b
JA
871/*
872 * Attempt to initiate a splice from a file to a pipe.
873 */
b6450630
SF
874long do_splice_to(struct file *in, loff_t *ppos,
875 struct pipe_inode_info *pipe, size_t len,
876 unsigned int flags)
5274f052 877{
6818173b
MS
878 ssize_t (*splice_read)(struct file *, loff_t *,
879 struct pipe_inode_info *, size_t, unsigned int);
5274f052
JA
880 int ret;
881
49570e9b 882 if (unlikely(!(in->f_mode & FMODE_READ)))
5274f052
JA
883 return -EBADF;
884
cbb7e577 885 ret = rw_verify_area(READ, in, ppos, len);
5274f052
JA
886 if (unlikely(ret < 0))
887 return ret;
888
03cc0789
AV
889 if (unlikely(len > MAX_RW_COUNT))
890 len = MAX_RW_COUNT;
891
72c2d531 892 if (in->f_op->splice_read)
cc56f7de
CG
893 splice_read = in->f_op->splice_read;
894 else
6818173b
MS
895 splice_read = default_file_splice_read;
896
897 return splice_read(in, ppos, pipe, len, flags);
5274f052 898}
b6450630 899EXPORT_SYMBOL_GPL(do_splice_to);
5274f052 900
932cc6d4
JA
901/**
902 * splice_direct_to_actor - splices data directly between two non-pipes
903 * @in: file to splice from
904 * @sd: actor information on where to splice to
905 * @actor: handles the data splicing
906 *
907 * Description:
908 * This is a special case helper to splice directly between two
909 * points, without requiring an explicit pipe. Internally an allocated
79685b8d 910 * pipe is cached in the process, and reused during the lifetime of
932cc6d4
JA
911 * that process.
912 *
c66ab6fa
JA
913 */
914ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
915 splice_direct_actor *actor)
b92ce558
JA
916{
917 struct pipe_inode_info *pipe;
918 long ret, bytes;
919 umode_t i_mode;
c66ab6fa 920 size_t len;
0ff28d9f 921 int i, flags, more;
b92ce558
JA
922
923 /*
924 * We require the input being a regular file, as we don't want to
925 * randomly drop data for eg socket -> socket splicing. Use the
926 * piped splicing for that!
927 */
496ad9aa 928 i_mode = file_inode(in)->i_mode;
b92ce558
JA
929 if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
930 return -EINVAL;
931
932 /*
933 * neither in nor out is a pipe, setup an internal pipe attached to
934 * 'out' and transfer the wanted data from 'in' to 'out' through that
935 */
936 pipe = current->splice_pipe;
49570e9b 937 if (unlikely(!pipe)) {
7bee130e 938 pipe = alloc_pipe_info();
b92ce558
JA
939 if (!pipe)
940 return -ENOMEM;
941
942 /*
943 * We don't have an immediate reader, but we'll read the stuff
00522fb4 944 * out of the pipe right after the splice_to_pipe(). So set
b92ce558
JA
945 * PIPE_READERS appropriately.
946 */
947 pipe->readers = 1;
948
949 current->splice_pipe = pipe;
950 }
951
952 /*
73d62d83 953 * Do the splice.
b92ce558
JA
954 */
955 ret = 0;
956 bytes = 0;
c66ab6fa
JA
957 len = sd->total_len;
958 flags = sd->flags;
959
960 /*
961 * Don't block on output, we have to drain the direct pipe.
962 */
963 sd->flags &= ~SPLICE_F_NONBLOCK;
0ff28d9f 964 more = sd->flags & SPLICE_F_MORE;
b92ce558
JA
965
966 while (len) {
51a92c0f 967 size_t read_len;
a82c53a0 968 loff_t pos = sd->pos, prev_pos = pos;
b92ce558 969
bcd4f3ac 970 ret = do_splice_to(in, &pos, pipe, len, flags);
51a92c0f 971 if (unlikely(ret <= 0))
b92ce558
JA
972 goto out_release;
973
974 read_len = ret;
c66ab6fa 975 sd->total_len = read_len;
b92ce558 976
0ff28d9f
CL
977 /*
978 * If more data is pending, set SPLICE_F_MORE
979 * If this is the last data and SPLICE_F_MORE was not set
980 * initially, clears it.
981 */
982 if (read_len < len)
983 sd->flags |= SPLICE_F_MORE;
984 else if (!more)
985 sd->flags &= ~SPLICE_F_MORE;
b92ce558
JA
986 /*
987 * NOTE: nonblocking mode only applies to the input. We
988 * must not do the output in nonblocking mode as then we
989 * could get stuck data in the internal pipe:
990 */
c66ab6fa 991 ret = actor(pipe, sd);
a82c53a0
TZ
992 if (unlikely(ret <= 0)) {
993 sd->pos = prev_pos;
b92ce558 994 goto out_release;
a82c53a0 995 }
b92ce558
JA
996
997 bytes += ret;
998 len -= ret;
bcd4f3ac 999 sd->pos = pos;
b92ce558 1000
a82c53a0
TZ
1001 if (ret < read_len) {
1002 sd->pos = prev_pos + ret;
51a92c0f 1003 goto out_release;
a82c53a0 1004 }
b92ce558
JA
1005 }
1006
9e97198d 1007done:
b92ce558 1008 pipe->nrbufs = pipe->curbuf = 0;
80848708 1009 file_accessed(in);
b92ce558
JA
1010 return bytes;
1011
1012out_release:
1013 /*
1014 * If we did an incomplete transfer we must release
1015 * the pipe buffers in question:
1016 */
35f3d14d 1017 for (i = 0; i < pipe->buffers; i++) {
b92ce558
JA
1018 struct pipe_buffer *buf = pipe->bufs + i;
1019
a779638c
MS
1020 if (buf->ops)
1021 pipe_buf_release(pipe, buf);
b92ce558 1022 }
b92ce558 1023
9e97198d
JA
1024 if (!bytes)
1025 bytes = ret;
c66ab6fa 1026
9e97198d 1027 goto done;
c66ab6fa
JA
1028}
1029EXPORT_SYMBOL(splice_direct_to_actor);
1030
1031static int direct_splice_actor(struct pipe_inode_info *pipe,
1032 struct splice_desc *sd)
1033{
6a14b90b 1034 struct file *file = sd->u.file;
c66ab6fa 1035
7995bd28 1036 return do_splice_from(pipe, file, sd->opos, sd->total_len,
2cb4b05e 1037 sd->flags);
c66ab6fa
JA
1038}
1039
932cc6d4
JA
1040/**
1041 * do_splice_direct - splices data directly between two files
1042 * @in: file to splice from
1043 * @ppos: input file offset
1044 * @out: file to splice to
acdb37c3 1045 * @opos: output file offset
932cc6d4
JA
1046 * @len: number of bytes to splice
1047 * @flags: splice modifier flags
1048 *
1049 * Description:
1050 * For use by do_sendfile(). splice can easily emulate sendfile, but
1051 * doing it in the application would incur an extra system call
1052 * (splice in + splice out, as compared to just sendfile()). So this helper
1053 * can splice directly through a process-private pipe.
1054 *
1055 */
c66ab6fa 1056long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
7995bd28 1057 loff_t *opos, size_t len, unsigned int flags)
c66ab6fa
JA
1058{
1059 struct splice_desc sd = {
1060 .len = len,
1061 .total_len = len,
1062 .flags = flags,
1063 .pos = *ppos,
6a14b90b 1064 .u.file = out,
7995bd28 1065 .opos = opos,
c66ab6fa 1066 };
51a92c0f 1067 long ret;
c66ab6fa 1068
18c67cb9
AV
1069 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1070 return -EBADF;
1071
1072 if (unlikely(out->f_flags & O_APPEND))
1073 return -EINVAL;
1074
1075 ret = rw_verify_area(WRITE, out, opos, len);
1076 if (unlikely(ret < 0))
1077 return ret;
1078
c66ab6fa 1079 ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
51a92c0f 1080 if (ret > 0)
a82c53a0 1081 *ppos = sd.pos;
51a92c0f 1082
c66ab6fa 1083 return ret;
b92ce558 1084}
1c118596 1085EXPORT_SYMBOL(do_splice_direct);
b92ce558 1086
8924feff
AV
1087static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
1088{
52bce911
LT
1089 for (;;) {
1090 if (unlikely(!pipe->readers)) {
1091 send_sig(SIGPIPE, current, 0);
1092 return -EPIPE;
1093 }
1094 if (pipe->nrbufs != pipe->buffers)
1095 return 0;
8924feff
AV
1096 if (flags & SPLICE_F_NONBLOCK)
1097 return -EAGAIN;
1098 if (signal_pending(current))
1099 return -ERESTARTSYS;
1100 pipe->waiting_writers++;
1101 pipe_wait(pipe);
1102 pipe->waiting_writers--;
1103 }
8924feff
AV
1104}
1105
7c77f0b3
MS
1106static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1107 struct pipe_inode_info *opipe,
1108 size_t len, unsigned int flags);
ddac0d39 1109
83f9135b
JA
1110/*
1111 * Determine where to splice to/from.
1112 */
529565dc
IM
1113static long do_splice(struct file *in, loff_t __user *off_in,
1114 struct file *out, loff_t __user *off_out,
1115 size_t len, unsigned int flags)
5274f052 1116{
7c77f0b3
MS
1117 struct pipe_inode_info *ipipe;
1118 struct pipe_inode_info *opipe;
7995bd28 1119 loff_t offset;
a4514ebd 1120 long ret;
5274f052 1121
71993e62
LT
1122 ipipe = get_pipe_info(in);
1123 opipe = get_pipe_info(out);
7c77f0b3
MS
1124
1125 if (ipipe && opipe) {
1126 if (off_in || off_out)
1127 return -ESPIPE;
1128
1129 if (!(in->f_mode & FMODE_READ))
1130 return -EBADF;
1131
1132 if (!(out->f_mode & FMODE_WRITE))
1133 return -EBADF;
1134
1135 /* Splicing to self would be fun, but... */
1136 if (ipipe == opipe)
1137 return -EINVAL;
1138
1139 return splice_pipe_to_pipe(ipipe, opipe, len, flags);
1140 }
1141
1142 if (ipipe) {
529565dc
IM
1143 if (off_in)
1144 return -ESPIPE;
b92ce558 1145 if (off_out) {
19c9a49b 1146 if (!(out->f_mode & FMODE_PWRITE))
b92ce558 1147 return -EINVAL;
cbb7e577 1148 if (copy_from_user(&offset, off_out, sizeof(loff_t)))
b92ce558 1149 return -EFAULT;
7995bd28
AV
1150 } else {
1151 offset = out->f_pos;
1152 }
529565dc 1153
18c67cb9
AV
1154 if (unlikely(!(out->f_mode & FMODE_WRITE)))
1155 return -EBADF;
1156
1157 if (unlikely(out->f_flags & O_APPEND))
1158 return -EINVAL;
1159
1160 ret = rw_verify_area(WRITE, out, &offset, len);
1161 if (unlikely(ret < 0))
1162 return ret;
1163
500368f7 1164 file_start_write(out);
7995bd28 1165 ret = do_splice_from(ipipe, out, &offset, len, flags);
500368f7 1166 file_end_write(out);
a4514ebd 1167
7995bd28
AV
1168 if (!off_out)
1169 out->f_pos = offset;
1170 else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
a4514ebd
JA
1171 ret = -EFAULT;
1172
1173 return ret;
529565dc 1174 }
5274f052 1175
7c77f0b3 1176 if (opipe) {
529565dc
IM
1177 if (off_out)
1178 return -ESPIPE;
b92ce558 1179 if (off_in) {
19c9a49b 1180 if (!(in->f_mode & FMODE_PREAD))
b92ce558 1181 return -EINVAL;
cbb7e577 1182 if (copy_from_user(&offset, off_in, sizeof(loff_t)))
b92ce558 1183 return -EFAULT;
7995bd28
AV
1184 } else {
1185 offset = in->f_pos;
1186 }
529565dc 1187
8924feff
AV
1188 pipe_lock(opipe);
1189 ret = wait_for_space(opipe, flags);
1190 if (!ret)
1191 ret = do_splice_to(in, &offset, opipe, len, flags);
1192 pipe_unlock(opipe);
1193 if (ret > 0)
1194 wakeup_pipe_readers(opipe);
7995bd28
AV
1195 if (!off_in)
1196 in->f_pos = offset;
1197 else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
a4514ebd
JA
1198 ret = -EFAULT;
1199
1200 return ret;
529565dc 1201 }
5274f052
JA
1202
1203 return -EINVAL;
1204}
1205
79fddc4e
AV
1206static int iter_to_pipe(struct iov_iter *from,
1207 struct pipe_inode_info *pipe,
1208 unsigned flags)
912d35f8 1209{
79fddc4e
AV
1210 struct pipe_buffer buf = {
1211 .ops = &user_page_pipe_buf_ops,
1212 .flags = flags
1213 };
1214 size_t total = 0;
1215 int ret = 0;
1216 bool failed = false;
1217
1218 while (iov_iter_count(from) && !failed) {
1219 struct page *pages[16];
db85a9eb
AV
1220 ssize_t copied;
1221 size_t start;
79fddc4e 1222 int n;
db85a9eb 1223
79fddc4e
AV
1224 copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
1225 if (copied <= 0) {
1226 ret = copied;
1227 break;
1228 }
db85a9eb 1229
79fddc4e 1230 for (n = 0; copied; n++, start = 0) {
db85a9eb 1231 int size = min_t(int, copied, PAGE_SIZE - start);
79fddc4e
AV
1232 if (!failed) {
1233 buf.page = pages[n];
1234 buf.offset = start;
1235 buf.len = size;
1236 ret = add_to_pipe(pipe, &buf);
1237 if (unlikely(ret < 0)) {
1238 failed = true;
1239 } else {
1240 iov_iter_advance(from, ret);
1241 total += ret;
1242 }
1243 } else {
1244 put_page(pages[n]);
1245 }
db85a9eb 1246 copied -= size;
912d35f8 1247 }
912d35f8 1248 }
79fddc4e 1249 return total ? total : ret;
912d35f8
JA
1250}
1251
6a14b90b
JA
1252static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
1253 struct splice_desc *sd)
1254{
6130f531
AV
1255 int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
1256 return n == sd->len ? n : -EFAULT;
6a14b90b
JA
1257}
1258
1259/*
1260 * For lack of a better implementation, implement vmsplice() to userspace
1261 * as a simple copy of the pipes pages to the user iov.
1262 */
6130f531 1263static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
6a14b90b
JA
1264 unsigned long nr_segs, unsigned int flags)
1265{
1266 struct pipe_inode_info *pipe;
1267 struct splice_desc sd;
6a14b90b 1268 long ret;
6130f531
AV
1269 struct iovec iovstack[UIO_FASTIOV];
1270 struct iovec *iov = iovstack;
1271 struct iov_iter iter;
6a14b90b 1272
71993e62 1273 pipe = get_pipe_info(file);
6a14b90b
JA
1274 if (!pipe)
1275 return -EBADF;
1276
345995fa
AV
1277 ret = import_iovec(READ, uiov, nr_segs,
1278 ARRAY_SIZE(iovstack), &iov, &iter);
1279 if (ret < 0)
1280 return ret;
6a14b90b 1281
345995fa 1282 sd.total_len = iov_iter_count(&iter);
6130f531 1283 sd.len = 0;
6130f531
AV
1284 sd.flags = flags;
1285 sd.u.data = &iter;
1286 sd.pos = 0;
6a14b90b 1287
345995fa
AV
1288 if (sd.total_len) {
1289 pipe_lock(pipe);
1290 ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1291 pipe_unlock(pipe);
1292 }
6a14b90b 1293
345995fa 1294 kfree(iov);
6a14b90b
JA
1295 return ret;
1296}
1297
912d35f8
JA
1298/*
1299 * vmsplice splices a user address range into a pipe. It can be thought of
1300 * as splice-from-memory, where the regular splice is splice-from-file (or
1301 * to file). In both cases the output is a pipe, naturally.
912d35f8 1302 */
db85a9eb 1303static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
6a14b90b 1304 unsigned long nr_segs, unsigned int flags)
912d35f8 1305{
ddac0d39 1306 struct pipe_inode_info *pipe;
db85a9eb
AV
1307 struct iovec iovstack[UIO_FASTIOV];
1308 struct iovec *iov = iovstack;
1309 struct iov_iter from;
35f3d14d 1310 long ret;
79fddc4e
AV
1311 unsigned buf_flag = 0;
1312
1313 if (flags & SPLICE_F_GIFT)
1314 buf_flag = PIPE_BUF_FLAG_GIFT;
912d35f8 1315
71993e62 1316 pipe = get_pipe_info(file);
ddac0d39 1317 if (!pipe)
912d35f8 1318 return -EBADF;
912d35f8 1319
db85a9eb
AV
1320 ret = import_iovec(WRITE, uiov, nr_segs,
1321 ARRAY_SIZE(iovstack), &iov, &from);
1322 if (ret < 0)
1323 return ret;
1324
8924feff
AV
1325 pipe_lock(pipe);
1326 ret = wait_for_space(pipe, flags);
79fddc4e
AV
1327 if (!ret)
1328 ret = iter_to_pipe(&from, pipe, buf_flag);
8924feff
AV
1329 pipe_unlock(pipe);
1330 if (ret > 0)
1331 wakeup_pipe_readers(pipe);
db85a9eb 1332 kfree(iov);
35f3d14d 1333 return ret;
912d35f8
JA
1334}
1335
6a14b90b
JA
1336/*
1337 * Note that vmsplice only really supports true splicing _from_ user memory
1338 * to a pipe, not the other way around. Splicing from user memory is a simple
1339 * operation that can be supported without any funky alignment restrictions
1340 * or nasty vm tricks. We simply map in the user memory and fill them into
1341 * a pipe. The reverse isn't quite as easy, though. There are two possible
1342 * solutions for that:
1343 *
1344 * - memcpy() the data internally, at which point we might as well just
1345 * do a regular read() on the buffer anyway.
1346 * - Lots of nasty vm tricks, that are neither fast nor flexible (it
1347 * has restriction limitations on both ends of the pipe).
1348 *
1349 * Currently we punt and implement it as a normal copy, see pipe_to_user().
1350 *
1351 */
836f92ad
HC
1352SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
1353 unsigned long, nr_segs, unsigned int, flags)
912d35f8 1354{
2903ff01 1355 struct fd f;
912d35f8 1356 long error;
912d35f8 1357
3d6ea290
AV
1358 if (unlikely(flags & ~SPLICE_F_ALL))
1359 return -EINVAL;
6a14b90b
JA
1360 if (unlikely(nr_segs > UIO_MAXIOV))
1361 return -EINVAL;
1362 else if (unlikely(!nr_segs))
1363 return 0;
1364
912d35f8 1365 error = -EBADF;
2903ff01
AV
1366 f = fdget(fd);
1367 if (f.file) {
1368 if (f.file->f_mode & FMODE_WRITE)
1369 error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
1370 else if (f.file->f_mode & FMODE_READ)
1371 error = vmsplice_to_user(f.file, iov, nr_segs, flags);
1372
1373 fdput(f);
912d35f8
JA
1374 }
1375
1376 return error;
1377}
1378
76b021d0
AV
1379#ifdef CONFIG_COMPAT
1380COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
1381 unsigned int, nr_segs, unsigned int, flags)
1382{
1383 unsigned i;
1384 struct iovec __user *iov;
1385 if (nr_segs > UIO_MAXIOV)
1386 return -EINVAL;
1387 iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
1388 for (i = 0; i < nr_segs; i++) {
1389 struct compat_iovec v;
1390 if (get_user(v.iov_base, &iov32[i].iov_base) ||
1391 get_user(v.iov_len, &iov32[i].iov_len) ||
1392 put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
1393 put_user(v.iov_len, &iov[i].iov_len))
1394 return -EFAULT;
1395 }
1396 return sys_vmsplice(fd, iov, nr_segs, flags);
1397}
1398#endif
1399
836f92ad
HC
1400SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
1401 int, fd_out, loff_t __user *, off_out,
1402 size_t, len, unsigned int, flags)
5274f052 1403{
2903ff01 1404 struct fd in, out;
5274f052 1405 long error;
5274f052
JA
1406
1407 if (unlikely(!len))
1408 return 0;
1409
3d6ea290
AV
1410 if (unlikely(flags & ~SPLICE_F_ALL))
1411 return -EINVAL;
1412
5274f052 1413 error = -EBADF;
2903ff01
AV
1414 in = fdget(fd_in);
1415 if (in.file) {
1416 if (in.file->f_mode & FMODE_READ) {
1417 out = fdget(fd_out);
1418 if (out.file) {
1419 if (out.file->f_mode & FMODE_WRITE)
1420 error = do_splice(in.file, off_in,
1421 out.file, off_out,
529565dc 1422 len, flags);
2903ff01 1423 fdput(out);
5274f052
JA
1424 }
1425 }
2903ff01 1426 fdput(in);
5274f052 1427 }
5274f052
JA
1428 return error;
1429}
70524490 1430
aadd06e5
JA
1431/*
1432 * Make sure there's data to read. Wait for input if we can, otherwise
1433 * return an appropriate error.
1434 */
7c77f0b3 1435static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
aadd06e5
JA
1436{
1437 int ret;
1438
1439 /*
1440 * Check ->nrbufs without the inode lock first. This function
1441 * is speculative anyways, so missing one is ok.
1442 */
1443 if (pipe->nrbufs)
1444 return 0;
1445
1446 ret = 0;
61e0d47c 1447 pipe_lock(pipe);
aadd06e5
JA
1448
1449 while (!pipe->nrbufs) {
1450 if (signal_pending(current)) {
1451 ret = -ERESTARTSYS;
1452 break;
1453 }
1454 if (!pipe->writers)
1455 break;
1456 if (!pipe->waiting_writers) {
1457 if (flags & SPLICE_F_NONBLOCK) {
1458 ret = -EAGAIN;
1459 break;
1460 }
1461 }
1462 pipe_wait(pipe);
1463 }
1464
61e0d47c 1465 pipe_unlock(pipe);
aadd06e5
JA
1466 return ret;
1467}
1468
1469/*
1470 * Make sure there's writeable room. Wait for room if we can, otherwise
1471 * return an appropriate error.
1472 */
7c77f0b3 1473static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
aadd06e5
JA
1474{
1475 int ret;
1476
1477 /*
1478 * Check ->nrbufs without the inode lock first. This function
1479 * is speculative anyways, so missing one is ok.
1480 */
35f3d14d 1481 if (pipe->nrbufs < pipe->buffers)
aadd06e5
JA
1482 return 0;
1483
1484 ret = 0;
61e0d47c 1485 pipe_lock(pipe);
aadd06e5 1486
35f3d14d 1487 while (pipe->nrbufs >= pipe->buffers) {
aadd06e5
JA
1488 if (!pipe->readers) {
1489 send_sig(SIGPIPE, current, 0);
1490 ret = -EPIPE;
1491 break;
1492 }
1493 if (flags & SPLICE_F_NONBLOCK) {
1494 ret = -EAGAIN;
1495 break;
1496 }
1497 if (signal_pending(current)) {
1498 ret = -ERESTARTSYS;
1499 break;
1500 }
1501 pipe->waiting_writers++;
1502 pipe_wait(pipe);
1503 pipe->waiting_writers--;
1504 }
1505
61e0d47c 1506 pipe_unlock(pipe);
aadd06e5
JA
1507 return ret;
1508}
1509
7c77f0b3
MS
1510/*
1511 * Splice contents of ipipe to opipe.
1512 */
1513static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
1514 struct pipe_inode_info *opipe,
1515 size_t len, unsigned int flags)
1516{
1517 struct pipe_buffer *ibuf, *obuf;
1518 int ret = 0, nbuf;
1519 bool input_wakeup = false;
1520
1521
1522retry:
1523 ret = ipipe_prep(ipipe, flags);
1524 if (ret)
1525 return ret;
1526
1527 ret = opipe_prep(opipe, flags);
1528 if (ret)
1529 return ret;
1530
1531 /*
1532 * Potential ABBA deadlock, work around it by ordering lock
1533 * grabbing by pipe info address. Otherwise two different processes
1534 * could deadlock (one doing tee from A -> B, the other from B -> A).
1535 */
1536 pipe_double_lock(ipipe, opipe);
1537
1538 do {
1539 if (!opipe->readers) {
1540 send_sig(SIGPIPE, current, 0);
1541 if (!ret)
1542 ret = -EPIPE;
1543 break;
1544 }
1545
1546 if (!ipipe->nrbufs && !ipipe->writers)
1547 break;
1548
1549 /*
1550 * Cannot make any progress, because either the input
1551 * pipe is empty or the output pipe is full.
1552 */
35f3d14d 1553 if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
7c77f0b3
MS
1554 /* Already processed some buffers, break */
1555 if (ret)
1556 break;
1557
1558 if (flags & SPLICE_F_NONBLOCK) {
1559 ret = -EAGAIN;
1560 break;
1561 }
1562
1563 /*
1564 * We raced with another reader/writer and haven't
1565 * managed to process any buffers. A zero return
1566 * value means EOF, so retry instead.
1567 */
1568 pipe_unlock(ipipe);
1569 pipe_unlock(opipe);
1570 goto retry;
1571 }
1572
1573 ibuf = ipipe->bufs + ipipe->curbuf;
35f3d14d 1574 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
7c77f0b3
MS
1575 obuf = opipe->bufs + nbuf;
1576
1577 if (len >= ibuf->len) {
1578 /*
1579 * Simply move the whole buffer from ipipe to opipe
1580 */
1581 *obuf = *ibuf;
1582 ibuf->ops = NULL;
1583 opipe->nrbufs++;
35f3d14d 1584 ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
7c77f0b3
MS
1585 ipipe->nrbufs--;
1586 input_wakeup = true;
1587 } else {
1588 /*
1589 * Get a reference to this pipe buffer,
1590 * so we can copy the contents over.
1591 */
7bf2d1df 1592 pipe_buf_get(ipipe, ibuf);
7c77f0b3
MS
1593 *obuf = *ibuf;
1594
1595 /*
1596 * Don't inherit the gift flag, we need to
1597 * prevent multiple steals of this page.
1598 */
1599 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1600
1601 obuf->len = len;
1602 opipe->nrbufs++;
1603 ibuf->offset += obuf->len;
1604 ibuf->len -= obuf->len;
1605 }
1606 ret += obuf->len;
1607 len -= obuf->len;
1608 } while (len);
1609
1610 pipe_unlock(ipipe);
1611 pipe_unlock(opipe);
1612
1613 /*
1614 * If we put data in the output pipe, wakeup any potential readers.
1615 */
825cdcb1
NK
1616 if (ret > 0)
1617 wakeup_pipe_readers(opipe);
1618
7c77f0b3
MS
1619 if (input_wakeup)
1620 wakeup_pipe_writers(ipipe);
1621
1622 return ret;
1623}
1624
70524490
JA
1625/*
1626 * Link contents of ipipe to opipe.
1627 */
1628static int link_pipe(struct pipe_inode_info *ipipe,
1629 struct pipe_inode_info *opipe,
1630 size_t len, unsigned int flags)
1631{
1632 struct pipe_buffer *ibuf, *obuf;
aadd06e5 1633 int ret = 0, i = 0, nbuf;
70524490
JA
1634
1635 /*
1636 * Potential ABBA deadlock, work around it by ordering lock
61e0d47c 1637 * grabbing by pipe info address. Otherwise two different processes
70524490
JA
1638 * could deadlock (one doing tee from A -> B, the other from B -> A).
1639 */
61e0d47c 1640 pipe_double_lock(ipipe, opipe);
70524490 1641
aadd06e5 1642 do {
70524490
JA
1643 if (!opipe->readers) {
1644 send_sig(SIGPIPE, current, 0);
1645 if (!ret)
1646 ret = -EPIPE;
1647 break;
1648 }
70524490 1649
aadd06e5
JA
1650 /*
1651 * If we have iterated all input buffers or ran out of
1652 * output room, break.
1653 */
35f3d14d 1654 if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
aadd06e5 1655 break;
70524490 1656
35f3d14d
JA
1657 ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
1658 nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
70524490
JA
1659
1660 /*
aadd06e5
JA
1661 * Get a reference to this pipe buffer,
1662 * so we can copy the contents over.
70524490 1663 */
7bf2d1df 1664 pipe_buf_get(ipipe, ibuf);
aadd06e5
JA
1665
1666 obuf = opipe->bufs + nbuf;
1667 *obuf = *ibuf;
1668
2a27250e 1669 /*
aadd06e5
JA
1670 * Don't inherit the gift flag, we need to
1671 * prevent multiple steals of this page.
2a27250e 1672 */
aadd06e5 1673 obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
70524490 1674
aadd06e5
JA
1675 if (obuf->len > len)
1676 obuf->len = len;
70524490 1677
aadd06e5
JA
1678 opipe->nrbufs++;
1679 ret += obuf->len;
1680 len -= obuf->len;
1681 i++;
1682 } while (len);
70524490 1683
02cf01ae
JA
1684 /*
1685 * return EAGAIN if we have the potential of some data in the
1686 * future, otherwise just return 0
1687 */
1688 if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
1689 ret = -EAGAIN;
1690
61e0d47c
MS
1691 pipe_unlock(ipipe);
1692 pipe_unlock(opipe);
70524490 1693
aadd06e5
JA
1694 /*
1695 * If we put data in the output pipe, wakeup any potential readers.
1696 */
825cdcb1
NK
1697 if (ret > 0)
1698 wakeup_pipe_readers(opipe);
70524490
JA
1699
1700 return ret;
1701}
1702
1703/*
1704 * This is a tee(1) implementation that works on pipes. It doesn't copy
1705 * any data, it simply references the 'in' pages on the 'out' pipe.
1706 * The 'flags' used are the SPLICE_F_* variants, currently the only
1707 * applicable one is SPLICE_F_NONBLOCK.
1708 */
1709static long do_tee(struct file *in, struct file *out, size_t len,
1710 unsigned int flags)
1711{
71993e62
LT
1712 struct pipe_inode_info *ipipe = get_pipe_info(in);
1713 struct pipe_inode_info *opipe = get_pipe_info(out);
aadd06e5 1714 int ret = -EINVAL;
70524490
JA
1715
1716 /*
aadd06e5
JA
1717 * Duplicate the contents of ipipe to opipe without actually
1718 * copying the data.
70524490 1719 */
aadd06e5
JA
1720 if (ipipe && opipe && ipipe != opipe) {
1721 /*
1722 * Keep going, unless we encounter an error. The ipipe/opipe
1723 * ordering doesn't really matter.
1724 */
7c77f0b3 1725 ret = ipipe_prep(ipipe, flags);
aadd06e5 1726 if (!ret) {
7c77f0b3 1727 ret = opipe_prep(opipe, flags);
02cf01ae 1728 if (!ret)
aadd06e5 1729 ret = link_pipe(ipipe, opipe, len, flags);
aadd06e5
JA
1730 }
1731 }
70524490 1732
aadd06e5 1733 return ret;
70524490
JA
1734}
1735
836f92ad 1736SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
70524490 1737{
2903ff01
AV
1738 struct fd in;
1739 int error;
70524490 1740
3d6ea290
AV
1741 if (unlikely(flags & ~SPLICE_F_ALL))
1742 return -EINVAL;
1743
70524490
JA
1744 if (unlikely(!len))
1745 return 0;
1746
1747 error = -EBADF;
2903ff01
AV
1748 in = fdget(fdin);
1749 if (in.file) {
1750 if (in.file->f_mode & FMODE_READ) {
1751 struct fd out = fdget(fdout);
1752 if (out.file) {
1753 if (out.file->f_mode & FMODE_WRITE)
1754 error = do_tee(in.file, out.file,
1755 len, flags);
1756 fdput(out);
70524490
JA
1757 }
1758 }
2903ff01 1759 fdput(in);
70524490
JA
1760 }
1761
1762 return error;
1763}