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