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