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