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