splice.c 39.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
/*
 * "splice": joining two ropes together by interweaving their strands.
 *
 * This is the "extended pipe" functionality, where a pipe is used as
 * an arbitrary in-memory buffer. Think of a pipe as a small kernel
 * buffer that you can use to transfer data from one end to the other.
 *
 * The traditional unix read/write is extended with a "splice()" operation
 * that transfers data buffers to or from a pipe buffer.
 *
 * Named by Larry McVoy, original implementation from Linus, extended by
12 13
 * Jens to support splicing to files, network, direct splicing, etc and
 * fixing lots of bugs.
14
 *
15
 * Copyright (C) 2005-2006 Jens Axboe <axboe@kernel.dk>
16 17
 * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
 * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
18 19
 *
 */
20
#include <linux/bvec.h>
21 22 23
#include <linux/fs.h>
#include <linux/file.h>
#include <linux/pagemap.h>
24
#include <linux/splice.h>
K
KAMEZAWA Hiroyuki 已提交
25
#include <linux/memcontrol.h>
26
#include <linux/mm_inline.h>
27
#include <linux/swap.h>
28
#include <linux/writeback.h>
29
#include <linux/export.h>
30
#include <linux/syscalls.h>
31
#include <linux/uio.h>
32
#include <linux/security.h>
33
#include <linux/gfp.h>
34
#include <linux/socket.h>
35
#include <linux/compat.h>
36
#include "internal.h"
37

38 39 40 41 42 43
/*
 * Attempt to steal a page from a pipe buffer. This should perhaps go into
 * a vm helper function, it's already simplified quite a bit by the
 * addition of remove_mapping(). If success is returned, the caller may
 * attempt to reuse this page for another destination.
 */
44
static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
45 46 47
				     struct pipe_buffer *buf)
{
	struct page *page = buf->page;
48
	struct address_space *mapping;
49

50 51
	lock_page(page);

52 53 54
	mapping = page_mapping(page);
	if (mapping) {
		WARN_ON(!PageUptodate(page));
55

56 57 58 59 60 61 62 63 64
		/*
		 * At least for ext2 with nobh option, we need to wait on
		 * writeback completing on this page, since we'll remove it
		 * from the pagecache.  Otherwise truncate wont wait on the
		 * page, allowing the disk blocks to be reused by someone else
		 * before we actually wrote our data to them. fs corruption
		 * ensues.
		 */
		wait_on_page_writeback(page);
65

66 67
		if (page_has_private(page) &&
		    !try_to_release_page(page, GFP_KERNEL))
68
			goto out_unlock;
69

70 71 72 73 74 75 76 77
		/*
		 * If we succeeded in removing the mapping, set LRU flag
		 * and return good.
		 */
		if (remove_mapping(mapping, page)) {
			buf->flags |= PIPE_BUF_FLAG_LRU;
			return 0;
		}
78
	}
79

80 81 82 83
	/*
	 * Raced with truncate or failed to remove page from current
	 * address space, unlock and return failure.
	 */
84
out_unlock:
85 86
	unlock_page(page);
	return 1;
87 88
}

89
static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
90 91
					struct pipe_buffer *buf)
{
92
	put_page(buf->page);
J
Jens Axboe 已提交
93
	buf->flags &= ~PIPE_BUF_FLAG_LRU;
94 95
}

96 97 98 99
/*
 * Check whether the contents of buf is OK to access. Since the content
 * is a page cache page, IO may be in flight.
 */
100 101
static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
				       struct pipe_buffer *buf)
102 103
{
	struct page *page = buf->page;
104
	int err;
105 106

	if (!PageUptodate(page)) {
107 108 109 110
		lock_page(page);

		/*
		 * Page got truncated/unhashed. This will cause a 0-byte
I
Ingo Molnar 已提交
111
		 * splice, if this is the first page.
112 113 114 115 116
		 */
		if (!page->mapping) {
			err = -ENODATA;
			goto error;
		}
117

118
		/*
I
Ingo Molnar 已提交
119
		 * Uh oh, read-error from disk.
120 121 122 123 124 125 126
		 */
		if (!PageUptodate(page)) {
			err = -EIO;
			goto error;
		}

		/*
127
		 * Page is ok afterall, we are done.
128
		 */
129 130 131
		unlock_page(page);
	}

132
	return 0;
133 134
error:
	unlock_page(page);
135
	return err;
136 137
}

138
const struct pipe_buf_operations page_cache_pipe_buf_ops = {
139
	.can_merge = 0,
140
	.confirm = page_cache_pipe_buf_confirm,
141
	.release = page_cache_pipe_buf_release,
142
	.steal = page_cache_pipe_buf_steal,
143
	.get = generic_pipe_buf_get,
144 145
};

146 147 148
static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
				    struct pipe_buffer *buf)
{
149 150 151
	if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
		return 1;

J
Jens Axboe 已提交
152
	buf->flags |= PIPE_BUF_FLAG_LRU;
153
	return generic_pipe_buf_steal(pipe, buf);
154 155
}

156
static const struct pipe_buf_operations user_page_pipe_buf_ops = {
157
	.can_merge = 0,
158
	.confirm = generic_pipe_buf_confirm,
159 160
	.release = page_cache_pipe_buf_release,
	.steal = user_page_pipe_buf_steal,
161
	.get = generic_pipe_buf_get,
162 163
};

N
Namhyung Kim 已提交
164 165 166 167 168 169 170 171
static void wakeup_pipe_readers(struct pipe_inode_info *pipe)
{
	smp_mb();
	if (waitqueue_active(&pipe->wait))
		wake_up_interruptible(&pipe->wait);
	kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
}

172 173 174 175 176 177
/**
 * splice_to_pipe - fill passed data into a pipe
 * @pipe:	pipe to fill
 * @spd:	data to fill
 *
 * Description:
R
Randy Dunlap 已提交
178
 *    @spd contains a map of pages and len/offset tuples, along with
179 180 181
 *    the struct pipe_buf_operations associated with these pages. This
 *    function will link that data to the pipe.
 *
182
 */
183 184
ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
		       struct splice_pipe_desc *spd)
185
{
186
	unsigned int spd_pages = spd->nr_pages;
187
	int ret = 0, page_nr = 0;
188

189 190 191
	if (!spd_pages)
		return 0;

192 193 194 195 196
	if (unlikely(!pipe->readers)) {
		send_sig(SIGPIPE, current, 0);
		ret = -EPIPE;
		goto out;
	}
197

198 199 200
	while (pipe->nrbufs < pipe->buffers) {
		int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
		struct pipe_buffer *buf = pipe->bufs + newbuf;
201

202 203 204 205 206
		buf->page = spd->pages[page_nr];
		buf->offset = spd->partial[page_nr].offset;
		buf->len = spd->partial[page_nr].len;
		buf->private = spd->partial[page_nr].private;
		buf->ops = spd->ops;
207

208 209 210
		pipe->nrbufs++;
		page_nr++;
		ret += buf->len;
211

212
		if (!--spd->nr_pages)
213 214 215
			break;
	}

216 217
	if (!ret)
		ret = -EAGAIN;
218

219
out:
220
	while (page_nr < spd_pages)
221
		spd->spd_release(spd, page_nr++);
222 223 224

	return ret;
}
225
EXPORT_SYMBOL_GPL(splice_to_pipe);
226

A
Al Viro 已提交
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
ssize_t add_to_pipe(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
{
	int ret;

	if (unlikely(!pipe->readers)) {
		send_sig(SIGPIPE, current, 0);
		ret = -EPIPE;
	} else if (pipe->nrbufs == pipe->buffers) {
		ret = -EAGAIN;
	} else {
		int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
		pipe->bufs[newbuf] = *buf;
		pipe->nrbufs++;
		return buf->len;
	}
242
	pipe_buf_release(pipe, buf);
A
Al Viro 已提交
243 244 245 246
	return ret;
}
EXPORT_SYMBOL(add_to_pipe);

247 248 249 250
/*
 * Check if we need to grow the arrays holding pages and partial page
 * descriptions.
 */
251
int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
252
{
253 254 255 256
	unsigned int buffers = ACCESS_ONCE(pipe->buffers);

	spd->nr_pages_max = buffers;
	if (buffers <= PIPE_DEF_BUFFERS)
257 258
		return 0;

259 260
	spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
	spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
261 262 263 264 265 266 267 268 269

	if (spd->pages && spd->partial)
		return 0;

	kfree(spd->pages);
	kfree(spd->partial);
	return -ENOMEM;
}

270
void splice_shrink_spd(struct splice_pipe_desc *spd)
271
{
272
	if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
273 274 275 276 277 278
		return;

	kfree(spd->pages);
	kfree(spd->partial);
}

279 280 281
/**
 * generic_file_splice_read - splice data from file to a pipe
 * @in:		file to splice from
282
 * @ppos:	position in @in
283 284 285 286
 * @pipe:	pipe to splice to
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
287 288
 * Description:
 *    Will read pages from given file and fill them into a pipe. Can be
289
 *    used as long as it has more or less sane ->read_iter().
290
 *
291
 */
292 293 294
ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
				 struct pipe_inode_info *pipe, size_t len,
				 unsigned int flags)
295
{
296 297 298
	struct iov_iter to;
	struct kiocb kiocb;
	int idx, ret;
299

300 301 302 303 304
	iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len);
	idx = to.idx;
	init_sync_kiocb(&kiocb, in);
	kiocb.ki_pos = *ppos;
	ret = in->f_op->read_iter(&kiocb, &to);
305
	if (ret > 0) {
306
		*ppos = kiocb.ki_pos;
307
		file_accessed(in);
308
	} else if (ret < 0) {
A
Al Viro 已提交
309 310 311
		to.idx = idx;
		to.iov_offset = 0;
		iov_iter_advance(&to, 0); /* to free what was emitted */
312 313 314 315 316 317
		/*
		 * callers of ->splice_read() expect -EAGAIN on
		 * "can't put anything in there", rather than -EFAULT.
		 */
		if (ret == -EFAULT)
			ret = -EAGAIN;
318
	}
319 320 321

	return ret;
}
322 323
EXPORT_SYMBOL(generic_file_splice_read);

A
Al Viro 已提交
324
const struct pipe_buf_operations default_pipe_buf_ops = {
325 326 327 328 329 330 331
	.can_merge = 0,
	.confirm = generic_pipe_buf_confirm,
	.release = generic_pipe_buf_release,
	.steal = generic_pipe_buf_steal,
	.get = generic_pipe_buf_get,
};

M
Miklos Szeredi 已提交
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
static int generic_pipe_buf_nosteal(struct pipe_inode_info *pipe,
				    struct pipe_buffer *buf)
{
	return 1;
}

/* Pipe buffer operations for a socket and similar. */
const struct pipe_buf_operations nosteal_pipe_buf_ops = {
	.can_merge = 0,
	.confirm = generic_pipe_buf_confirm,
	.release = generic_pipe_buf_release,
	.steal = generic_pipe_buf_nosteal,
	.get = generic_pipe_buf_get,
};
EXPORT_SYMBOL(nosteal_pipe_buf_ops);

348
static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
349 350 351 352 353 354 355 356 357
			    unsigned long vlen, loff_t offset)
{
	mm_segment_t old_fs;
	loff_t pos = offset;
	ssize_t res;

	old_fs = get_fs();
	set_fs(get_ds());
	/* The cast to a user pointer is valid due to the set_fs() */
358
	res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
359 360 361 362 363
	set_fs(old_fs);

	return res;
}

364
ssize_t kernel_write(struct file *file, const char *buf, size_t count,
365
			    loff_t pos)
366 367 368 369 370 371 372
{
	mm_segment_t old_fs;
	ssize_t res;

	old_fs = get_fs();
	set_fs(get_ds());
	/* The cast to a user pointer is valid due to the set_fs() */
373
	res = vfs_write(file, (__force const char __user *)buf, count, &pos);
374 375 376 377
	set_fs(old_fs);

	return res;
}
378
EXPORT_SYMBOL(kernel_write);
379

380
static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
381 382 383
				 struct pipe_inode_info *pipe, size_t len,
				 unsigned int flags)
{
384 385 386
	struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
	struct iov_iter to;
	struct page **pages;
387
	unsigned int nr_pages;
388
	size_t offset, base, copied = 0;
389 390
	ssize_t res;
	int i;
391

392 393
	if (pipe->nrbufs == pipe->buffers)
		return -EAGAIN;
394

395 396 397 398
	/*
	 * Try to keep page boundaries matching to source pagecache ones -
	 * it probably won't be much help, but...
	 */
399
	offset = *ppos & ~PAGE_MASK;
400

401
	iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
402

403
	res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &base);
404 405
	if (res <= 0)
		return -ENOMEM;
406

407
	nr_pages = DIV_ROUND_UP(res + base, PAGE_SIZE);
408

409 410 411 412 413 414 415
	vec = __vec;
	if (nr_pages > PIPE_DEF_BUFFERS) {
		vec = kmalloc(nr_pages * sizeof(struct kvec), GFP_KERNEL);
		if (unlikely(!vec)) {
			res = -ENOMEM;
			goto out;
		}
A
Andrew Morton 已提交
416
	}
417

418 419 420 421 422 423 424 425 426
	pipe->bufs[to.idx].offset = offset;
	pipe->bufs[to.idx].len -= offset;

	for (i = 0; i < nr_pages; i++) {
		size_t this_len = min_t(size_t, len, PAGE_SIZE - offset);
		vec[i].iov_base = page_address(pages[i]) + offset;
		vec[i].iov_len = this_len;
		len -= this_len;
		offset = 0;
427 428
	}

429 430 431
	res = kernel_readv(in, vec, nr_pages, *ppos);
	if (res > 0) {
		copied = res;
432
		*ppos += res;
433
	}
434

435 436
	if (vec != __vec)
		kfree(vec);
437 438 439 440 441
out:
	for (i = 0; i < nr_pages; i++)
		put_page(pages[i]);
	kvfree(pages);
	iov_iter_advance(&to, copied);	/* truncates and discards */
442 443 444
	return res;
}

445
/*
446
 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
J
Jens Axboe 已提交
447
 * using sendpage(). Return the number of bytes sent.
448
 */
449
static int pipe_to_sendpage(struct pipe_inode_info *pipe,
450 451
			    struct pipe_buffer *buf, struct splice_desc *sd)
{
452
	struct file *file = sd->u.file;
453
	loff_t pos = sd->pos;
454
	int more;
455

A
Al Viro 已提交
456
	if (!likely(file->f_op->sendpage))
457 458
		return -EINVAL;

459
	more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
460 461

	if (sd->len < sd->total_len && pipe->nrbufs > 1)
462
		more |= MSG_SENDPAGE_NOTLAST;
463

464 465
	return file->f_op->sendpage(file, buf->page, buf->offset,
				    sd->len, &pos, more);
466 467
}

468 469 470 471 472 473 474 475
static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
{
	smp_mb();
	if (waitqueue_active(&pipe->wait))
		wake_up_interruptible(&pipe->wait);
	kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
}

476
/**
477
 * splice_from_pipe_feed - feed available data from a pipe to a file
478 479 480 481 482
 * @pipe:	pipe to splice from
 * @sd:		information to @actor
 * @actor:	handler that splices the data
 *
 * Description:
483 484 485 486 487 488 489
 *    This function loops over the pipe and calls @actor to do the
 *    actual moving of a single struct pipe_buffer to the desired
 *    destination.  It returns when there's no more buffers left in
 *    the pipe or if the requested number of bytes (@sd->total_len)
 *    have been copied.  It returns a positive number (one) if the
 *    pipe needs to be filled with more data, zero if the required
 *    number of bytes have been copied and -errno on error.
490
 *
491 492 493 494
 *    This, together with splice_from_pipe_{begin,end,next}, may be
 *    used to implement the functionality of __splice_from_pipe() when
 *    locking is required around copying the pipe buffers to the
 *    destination.
495
 */
A
Al Viro 已提交
496
static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
497
			  splice_actor *actor)
498
{
499
	int ret;
500

501 502
	while (pipe->nrbufs) {
		struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
503

504 505 506
		sd->len = buf->len;
		if (sd->len > sd->total_len)
			sd->len = sd->total_len;
507

508
		ret = pipe_buf_confirm(pipe, buf);
509
		if (unlikely(ret)) {
510 511 512 513
			if (ret == -ENODATA)
				ret = 0;
			return ret;
		}
514 515 516 517 518

		ret = actor(pipe, buf, sd);
		if (ret <= 0)
			return ret;

519 520 521 522 523 524 525 526 527
		buf->offset += ret;
		buf->len -= ret;

		sd->num_spliced += ret;
		sd->len -= ret;
		sd->pos += ret;
		sd->total_len -= ret;

		if (!buf->len) {
528
			pipe_buf_release(pipe, buf);
529
			pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
530
			pipe->nrbufs--;
A
Al Viro 已提交
531
			if (pipe->files)
532 533
				sd->need_wakeup = true;
		}
534

535 536 537
		if (!sd->total_len)
			return 0;
	}
538

539 540
	return 1;
}
541

542 543 544 545 546 547 548 549 550 551
/**
 * splice_from_pipe_next - wait for some data to splice from
 * @pipe:	pipe to splice from
 * @sd:		information about the splice operation
 *
 * Description:
 *    This function will wait for some data and return a positive
 *    value (one) if pipe buffers are available.  It will return zero
 *    or -errno if no more data needs to be spliced.
 */
A
Al Viro 已提交
552
static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
553
{
554 555 556 557 558 559 560
	/*
	 * Check for signal early to make process killable when there are
	 * always buffers available
	 */
	if (signal_pending(current))
		return -ERESTARTSYS;

561 562 563
	while (!pipe->nrbufs) {
		if (!pipe->writers)
			return 0;
J
Jens Axboe 已提交
564

565 566
		if (!pipe->waiting_writers && sd->num_spliced)
			return 0;
I
Ingo Molnar 已提交
567

568 569
		if (sd->flags & SPLICE_F_NONBLOCK)
			return -EAGAIN;
570

571 572
		if (signal_pending(current))
			return -ERESTARTSYS;
573

574 575 576
		if (sd->need_wakeup) {
			wakeup_pipe_writers(pipe);
			sd->need_wakeup = false;
577 578
		}

579 580
		pipe_wait(pipe);
	}
581

582 583
	return 1;
}
584

585 586
/**
 * splice_from_pipe_begin - start splicing from pipe
587
 * @sd:		information about the splice operation
588 589 590 591 592 593
 *
 * Description:
 *    This function should be called before a loop containing
 *    splice_from_pipe_next() and splice_from_pipe_feed() to
 *    initialize the necessary fields of @sd.
 */
A
Al Viro 已提交
594
static void splice_from_pipe_begin(struct splice_desc *sd)
595 596 597 598
{
	sd->num_spliced = 0;
	sd->need_wakeup = false;
}
599

600 601 602 603 604 605 606 607 608 609
/**
 * splice_from_pipe_end - finish splicing from pipe
 * @pipe:	pipe to splice from
 * @sd:		information about the splice operation
 *
 * Description:
 *    This function will wake up pipe writers if necessary.  It should
 *    be called after a loop containing splice_from_pipe_next() and
 *    splice_from_pipe_feed().
 */
A
Al Viro 已提交
610
static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
611 612 613 614
{
	if (sd->need_wakeup)
		wakeup_pipe_writers(pipe);
}
615

616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
/**
 * __splice_from_pipe - splice data from a pipe to given actor
 * @pipe:	pipe to splice from
 * @sd:		information to @actor
 * @actor:	handler that splices the data
 *
 * Description:
 *    This function does little more than loop over the pipe and call
 *    @actor to do the actual moving of a single struct pipe_buffer to
 *    the desired destination. See pipe_to_file, pipe_to_sendpage, or
 *    pipe_to_user.
 *
 */
ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
			   splice_actor *actor)
{
	int ret;
633

634 635
	splice_from_pipe_begin(sd);
	do {
J
Jan Kara 已提交
636
		cond_resched();
637 638 639 640 641 642 643
		ret = splice_from_pipe_next(pipe, sd);
		if (ret > 0)
			ret = splice_from_pipe_feed(pipe, sd, actor);
	} while (ret > 0);
	splice_from_pipe_end(pipe, sd);

	return sd->num_spliced ? sd->num_spliced : ret;
644
}
M
Mark Fasheh 已提交
645
EXPORT_SYMBOL(__splice_from_pipe);
646

647 648 649 650 651 652 653 654 655 656
/**
 * splice_from_pipe - splice data from a pipe to a file
 * @pipe:	pipe to splice from
 * @out:	file to splice to
 * @ppos:	position in @out
 * @len:	how many bytes to splice
 * @flags:	splice modifier flags
 * @actor:	handler that splices the data
 *
 * Description:
657
 *    See __splice_from_pipe. This function locks the pipe inode,
658 659 660
 *    otherwise it's identical to __splice_from_pipe().
 *
 */
661 662 663 664 665
ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
			 loff_t *ppos, size_t len, unsigned int flags,
			 splice_actor *actor)
{
	ssize_t ret;
J
Jens Axboe 已提交
666 667 668 669
	struct splice_desc sd = {
		.total_len = len,
		.flags = flags,
		.pos = *ppos,
670
		.u.file = out,
J
Jens Axboe 已提交
671
	};
672

673
	pipe_lock(pipe);
J
Jens Axboe 已提交
674
	ret = __splice_from_pipe(pipe, &sd, actor);
675
	pipe_unlock(pipe);
676 677 678 679

	return ret;
}

A
Al Viro 已提交
680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
/**
 * iter_file_splice_write - splice data from a pipe to a file
 * @pipe:	pipe info
 * @out:	file to write to
 * @ppos:	position in @out
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
 * Description:
 *    Will either move or copy pages (determined by @flags options) from
 *    the given pipe inode to the given file.
 *    This one is ->write_iter-based.
 *
 */
ssize_t
iter_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
			  loff_t *ppos, size_t len, unsigned int flags)
{
	struct splice_desc sd = {
		.total_len = len,
		.flags = flags,
		.pos = *ppos,
		.u.file = out,
	};
	int nbufs = pipe->buffers;
	struct bio_vec *array = kcalloc(nbufs, sizeof(struct bio_vec),
					GFP_KERNEL);
	ssize_t ret;

	if (unlikely(!array))
		return -ENOMEM;

	pipe_lock(pipe);

	splice_from_pipe_begin(&sd);
	while (sd.total_len) {
		struct iov_iter from;
		size_t left;
		int n, idx;

		ret = splice_from_pipe_next(pipe, &sd);
		if (ret <= 0)
			break;

		if (unlikely(nbufs < pipe->buffers)) {
			kfree(array);
			nbufs = pipe->buffers;
			array = kcalloc(nbufs, sizeof(struct bio_vec),
					GFP_KERNEL);
			if (!array) {
				ret = -ENOMEM;
				break;
			}
		}

		/* build the vector */
		left = sd.total_len;
		for (n = 0, idx = pipe->curbuf; left && n < pipe->nrbufs; n++, idx++) {
			struct pipe_buffer *buf = pipe->bufs + idx;
			size_t this_len = buf->len;

			if (this_len > left)
				this_len = left;

			if (idx == pipe->buffers - 1)
				idx = -1;

747
			ret = pipe_buf_confirm(pipe, buf);
A
Al Viro 已提交
748 749 750 751 752 753 754 755 756 757 758 759
			if (unlikely(ret)) {
				if (ret == -ENODATA)
					ret = 0;
				goto done;
			}

			array[n].bv_page = buf->page;
			array[n].bv_len = this_len;
			array[n].bv_offset = buf->offset;
			left -= this_len;
		}

A
Al Viro 已提交
760 761
		iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
			      sd.total_len - left);
762
		ret = vfs_iter_write(out, &from, &sd.pos);
A
Al Viro 已提交
763 764 765 766 767
		if (ret <= 0)
			break;

		sd.num_spliced += ret;
		sd.total_len -= ret;
768
		*ppos = sd.pos;
A
Al Viro 已提交
769 770 771 772 773 774 775

		/* dismiss the fully eaten buffers, adjust the partial one */
		while (ret) {
			struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
			if (ret >= buf->len) {
				ret -= buf->len;
				buf->len = 0;
776
				pipe_buf_release(pipe, buf);
A
Al Viro 已提交
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
				pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
				pipe->nrbufs--;
				if (pipe->files)
					sd.need_wakeup = true;
			} else {
				buf->offset += ret;
				buf->len -= ret;
				ret = 0;
			}
		}
	}
done:
	kfree(array);
	splice_from_pipe_end(pipe, &sd);

	pipe_unlock(pipe);

	if (sd.num_spliced)
		ret = sd.num_spliced;

	return ret;
}

EXPORT_SYMBOL(iter_file_splice_write);

802 803
static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
			  struct splice_desc *sd)
804
{
805 806
	int ret;
	void *data;
807
	loff_t tmp = sd->pos;
808

A
Al Viro 已提交
809
	data = kmap(buf->page);
810
	ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
A
Al Viro 已提交
811
	kunmap(buf->page);
812 813

	return ret;
814 815 816 817 818 819
}

static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
					 struct file *out, loff_t *ppos,
					 size_t len, unsigned int flags)
{
820
	ssize_t ret;
821

822 823 824
	ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
	if (ret > 0)
		*ppos += ret;
825

826
	return ret;
827 828
}

829 830
/**
 * generic_splice_sendpage - splice data from a pipe to a socket
831
 * @pipe:	pipe to splice from
832
 * @out:	socket to write to
833
 * @ppos:	position in @out
834 835 836
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
837 838 839
 * Description:
 *    Will send @len bytes from the pipe to a network socket. No data copying
 *    is involved.
840 841
 *
 */
842
ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
843
				loff_t *ppos, size_t len, unsigned int flags)
844
{
845
	return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
846 847
}

848
EXPORT_SYMBOL(generic_splice_sendpage);
J
Jeff Garzik 已提交
849

850 851 852
/*
 * Attempt to initiate a splice from pipe to file.
 */
853
static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
854
			   loff_t *ppos, size_t len, unsigned int flags)
855
{
856 857
	ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
				loff_t *, size_t, unsigned int);
858

A
Al Viro 已提交
859
	if (out->f_op->splice_write)
860 861
		splice_write = out->f_op->splice_write;
	else
862 863
		splice_write = default_file_splice_write;

864
	return splice_write(pipe, out, ppos, len, flags);
865 866
}

867 868 869
/*
 * Attempt to initiate a splice from a file to a pipe.
 */
870 871 872
static long do_splice_to(struct file *in, loff_t *ppos,
			 struct pipe_inode_info *pipe, size_t len,
			 unsigned int flags)
873
{
874 875
	ssize_t (*splice_read)(struct file *, loff_t *,
			       struct pipe_inode_info *, size_t, unsigned int);
876 877
	int ret;

878
	if (unlikely(!(in->f_mode & FMODE_READ)))
879 880
		return -EBADF;

881
	ret = rw_verify_area(READ, in, ppos, len);
882 883 884
	if (unlikely(ret < 0))
		return ret;

885 886 887
	if (unlikely(len > MAX_RW_COUNT))
		len = MAX_RW_COUNT;

A
Al Viro 已提交
888
	if (in->f_op->splice_read)
889 890
		splice_read = in->f_op->splice_read;
	else
891 892 893
		splice_read = default_file_splice_read;

	return splice_read(in, ppos, pipe, len, flags);
894 895
}

896 897 898 899 900 901 902 903 904
/**
 * splice_direct_to_actor - splices data directly between two non-pipes
 * @in:		file to splice from
 * @sd:		actor information on where to splice to
 * @actor:	handles the data splicing
 *
 * Description:
 *    This is a special case helper to splice directly between two
 *    points, without requiring an explicit pipe. Internally an allocated
R
Randy Dunlap 已提交
905
 *    pipe is cached in the process, and reused during the lifetime of
906 907
 *    that process.
 *
J
Jens Axboe 已提交
908 909 910
 */
ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
			       splice_direct_actor *actor)
911 912 913 914
{
	struct pipe_inode_info *pipe;
	long ret, bytes;
	umode_t i_mode;
J
Jens Axboe 已提交
915
	size_t len;
916
	int i, flags, more;
917 918 919 920 921 922

	/*
	 * We require the input being a regular file, as we don't want to
	 * randomly drop data for eg socket -> socket splicing. Use the
	 * piped splicing for that!
	 */
A
Al Viro 已提交
923
	i_mode = file_inode(in)->i_mode;
924 925 926 927 928 929 930 931
	if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
		return -EINVAL;

	/*
	 * neither in nor out is a pipe, setup an internal pipe attached to
	 * 'out' and transfer the wanted data from 'in' to 'out' through that
	 */
	pipe = current->splice_pipe;
932
	if (unlikely(!pipe)) {
A
Al Viro 已提交
933
		pipe = alloc_pipe_info();
934 935 936 937 938
		if (!pipe)
			return -ENOMEM;

		/*
		 * We don't have an immediate reader, but we'll read the stuff
939
		 * out of the pipe right after the splice_to_pipe(). So set
940 941 942 943 944 945 946 947
		 * PIPE_READERS appropriately.
		 */
		pipe->readers = 1;

		current->splice_pipe = pipe;
	}

	/*
I
Ingo Molnar 已提交
948
	 * Do the splice.
949 950 951
	 */
	ret = 0;
	bytes = 0;
J
Jens Axboe 已提交
952 953 954 955 956 957 958
	len = sd->total_len;
	flags = sd->flags;

	/*
	 * Don't block on output, we have to drain the direct pipe.
	 */
	sd->flags &= ~SPLICE_F_NONBLOCK;
959
	more = sd->flags & SPLICE_F_MORE;
960 961

	while (len) {
962
		size_t read_len;
963
		loff_t pos = sd->pos, prev_pos = pos;
964

965
		ret = do_splice_to(in, &pos, pipe, len, flags);
966
		if (unlikely(ret <= 0))
967 968 969
			goto out_release;

		read_len = ret;
J
Jens Axboe 已提交
970
		sd->total_len = read_len;
971

972 973 974 975 976 977 978 979 980
		/*
		 * If more data is pending, set SPLICE_F_MORE
		 * If this is the last data and SPLICE_F_MORE was not set
		 * initially, clears it.
		 */
		if (read_len < len)
			sd->flags |= SPLICE_F_MORE;
		else if (!more)
			sd->flags &= ~SPLICE_F_MORE;
981 982 983 984 985
		/*
		 * NOTE: nonblocking mode only applies to the input. We
		 * must not do the output in nonblocking mode as then we
		 * could get stuck data in the internal pipe:
		 */
J
Jens Axboe 已提交
986
		ret = actor(pipe, sd);
987 988
		if (unlikely(ret <= 0)) {
			sd->pos = prev_pos;
989
			goto out_release;
990
		}
991 992 993

		bytes += ret;
		len -= ret;
994
		sd->pos = pos;
995

996 997
		if (ret < read_len) {
			sd->pos = prev_pos + ret;
998
			goto out_release;
999
		}
1000 1001
	}

1002
done:
1003
	pipe->nrbufs = pipe->curbuf = 0;
1004
	file_accessed(in);
1005 1006 1007 1008 1009 1010 1011
	return bytes;

out_release:
	/*
	 * If we did an incomplete transfer we must release
	 * the pipe buffers in question:
	 */
1012
	for (i = 0; i < pipe->buffers; i++) {
1013 1014
		struct pipe_buffer *buf = pipe->bufs + i;

1015 1016
		if (buf->ops)
			pipe_buf_release(pipe, buf);
1017 1018
	}

1019 1020
	if (!bytes)
		bytes = ret;
J
Jens Axboe 已提交
1021

1022
	goto done;
J
Jens Axboe 已提交
1023 1024 1025 1026 1027 1028
}
EXPORT_SYMBOL(splice_direct_to_actor);

static int direct_splice_actor(struct pipe_inode_info *pipe,
			       struct splice_desc *sd)
{
1029
	struct file *file = sd->u.file;
J
Jens Axboe 已提交
1030

1031
	return do_splice_from(pipe, file, sd->opos, sd->total_len,
1032
			      sd->flags);
J
Jens Axboe 已提交
1033 1034
}

1035 1036 1037 1038 1039
/**
 * do_splice_direct - splices data directly between two files
 * @in:		file to splice from
 * @ppos:	input file offset
 * @out:	file to splice to
1040
 * @opos:	output file offset
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
 * Description:
 *    For use by do_sendfile(). splice can easily emulate sendfile, but
 *    doing it in the application would incur an extra system call
 *    (splice in + splice out, as compared to just sendfile()). So this helper
 *    can splice directly through a process-private pipe.
 *
 */
J
Jens Axboe 已提交
1051
long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
1052
		      loff_t *opos, size_t len, unsigned int flags)
J
Jens Axboe 已提交
1053 1054 1055 1056 1057 1058
{
	struct splice_desc sd = {
		.len		= len,
		.total_len	= len,
		.flags		= flags,
		.pos		= *ppos,
1059
		.u.file		= out,
1060
		.opos		= opos,
J
Jens Axboe 已提交
1061
	};
1062
	long ret;
J
Jens Axboe 已提交
1063

1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
	if (unlikely(!(out->f_mode & FMODE_WRITE)))
		return -EBADF;

	if (unlikely(out->f_flags & O_APPEND))
		return -EINVAL;

	ret = rw_verify_area(WRITE, out, opos, len);
	if (unlikely(ret < 0))
		return ret;

J
Jens Axboe 已提交
1074
	ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
1075
	if (ret > 0)
1076
		*ppos = sd.pos;
1077

J
Jens Axboe 已提交
1078
	return ret;
1079
}
1080
EXPORT_SYMBOL(do_splice_direct);
1081

1082 1083
static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
{
1084 1085 1086 1087 1088 1089 1090
	for (;;) {
		if (unlikely(!pipe->readers)) {
			send_sig(SIGPIPE, current, 0);
			return -EPIPE;
		}
		if (pipe->nrbufs != pipe->buffers)
			return 0;
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
		if (flags & SPLICE_F_NONBLOCK)
			return -EAGAIN;
		if (signal_pending(current))
			return -ERESTARTSYS;
		pipe->waiting_writers++;
		pipe_wait(pipe);
		pipe->waiting_writers--;
	}
}

1101 1102 1103
static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
			       struct pipe_inode_info *opipe,
			       size_t len, unsigned int flags);
1104

1105 1106 1107
/*
 * Determine where to splice to/from.
 */
1108 1109 1110
static long do_splice(struct file *in, loff_t __user *off_in,
		      struct file *out, loff_t __user *off_out,
		      size_t len, unsigned int flags)
1111
{
1112 1113
	struct pipe_inode_info *ipipe;
	struct pipe_inode_info *opipe;
1114
	loff_t offset;
J
Jens Axboe 已提交
1115
	long ret;
1116

1117 1118
	ipipe = get_pipe_info(in);
	opipe = get_pipe_info(out);
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137

	if (ipipe && opipe) {
		if (off_in || off_out)
			return -ESPIPE;

		if (!(in->f_mode & FMODE_READ))
			return -EBADF;

		if (!(out->f_mode & FMODE_WRITE))
			return -EBADF;

		/* Splicing to self would be fun, but... */
		if (ipipe == opipe)
			return -EINVAL;

		return splice_pipe_to_pipe(ipipe, opipe, len, flags);
	}

	if (ipipe) {
1138 1139
		if (off_in)
			return -ESPIPE;
1140
		if (off_out) {
1141
			if (!(out->f_mode & FMODE_PWRITE))
1142
				return -EINVAL;
1143
			if (copy_from_user(&offset, off_out, sizeof(loff_t)))
1144
				return -EFAULT;
1145 1146 1147
		} else {
			offset = out->f_pos;
		}
1148

1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
		if (unlikely(!(out->f_mode & FMODE_WRITE)))
			return -EBADF;

		if (unlikely(out->f_flags & O_APPEND))
			return -EINVAL;

		ret = rw_verify_area(WRITE, out, &offset, len);
		if (unlikely(ret < 0))
			return ret;

1159
		file_start_write(out);
1160
		ret = do_splice_from(ipipe, out, &offset, len, flags);
1161
		file_end_write(out);
J
Jens Axboe 已提交
1162

1163 1164 1165
		if (!off_out)
			out->f_pos = offset;
		else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
J
Jens Axboe 已提交
1166 1167 1168
			ret = -EFAULT;

		return ret;
1169
	}
1170

1171
	if (opipe) {
1172 1173
		if (off_out)
			return -ESPIPE;
1174
		if (off_in) {
1175
			if (!(in->f_mode & FMODE_PREAD))
1176
				return -EINVAL;
1177
			if (copy_from_user(&offset, off_in, sizeof(loff_t)))
1178
				return -EFAULT;
1179 1180 1181
		} else {
			offset = in->f_pos;
		}
1182

1183 1184 1185 1186 1187 1188 1189
		pipe_lock(opipe);
		ret = wait_for_space(opipe, flags);
		if (!ret)
			ret = do_splice_to(in, &offset, opipe, len, flags);
		pipe_unlock(opipe);
		if (ret > 0)
			wakeup_pipe_readers(opipe);
1190 1191 1192
		if (!off_in)
			in->f_pos = offset;
		else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
J
Jens Axboe 已提交
1193 1194 1195
			ret = -EFAULT;

		return ret;
1196
	}
1197 1198 1199 1200

	return -EINVAL;
}

A
Al Viro 已提交
1201 1202 1203
static int iter_to_pipe(struct iov_iter *from,
			struct pipe_inode_info *pipe,
			unsigned flags)
1204
{
A
Al Viro 已提交
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
	struct pipe_buffer buf = {
		.ops = &user_page_pipe_buf_ops,
		.flags = flags
	};
	size_t total = 0;
	int ret = 0;
	bool failed = false;

	while (iov_iter_count(from) && !failed) {
		struct page *pages[16];
1215 1216
		ssize_t copied;
		size_t start;
A
Al Viro 已提交
1217
		int n;
1218

A
Al Viro 已提交
1219 1220 1221 1222 1223
		copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
		if (copied <= 0) {
			ret = copied;
			break;
		}
1224

A
Al Viro 已提交
1225
		for (n = 0; copied; n++, start = 0) {
1226
			int size = min_t(int, copied, PAGE_SIZE - start);
A
Al Viro 已提交
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
			if (!failed) {
				buf.page = pages[n];
				buf.offset = start;
				buf.len = size;
				ret = add_to_pipe(pipe, &buf);
				if (unlikely(ret < 0)) {
					failed = true;
				} else {
					iov_iter_advance(from, ret);
					total += ret;
				}
			} else {
				put_page(pages[n]);
			}
1241
			copied -= size;
1242 1243
		}
	}
A
Al Viro 已提交
1244
	return total ? total : ret;
1245 1246
}

1247 1248 1249
static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
			struct splice_desc *sd)
{
1250 1251
	int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
	return n == sd->len ? n : -EFAULT;
1252 1253 1254 1255 1256 1257
}

/*
 * For lack of a better implementation, implement vmsplice() to userspace
 * as a simple copy of the pipes pages to the user iov.
 */
1258
static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
1259 1260 1261 1262 1263
			     unsigned long nr_segs, unsigned int flags)
{
	struct pipe_inode_info *pipe;
	struct splice_desc sd;
	long ret;
1264 1265 1266
	struct iovec iovstack[UIO_FASTIOV];
	struct iovec *iov = iovstack;
	struct iov_iter iter;
1267

1268
	pipe = get_pipe_info(file);
1269 1270 1271
	if (!pipe)
		return -EBADF;

1272 1273 1274 1275
	ret = import_iovec(READ, uiov, nr_segs,
			   ARRAY_SIZE(iovstack), &iov, &iter);
	if (ret < 0)
		return ret;
1276

1277
	sd.total_len = iov_iter_count(&iter);
1278 1279 1280 1281
	sd.len = 0;
	sd.flags = flags;
	sd.u.data = &iter;
	sd.pos = 0;
1282

1283 1284 1285 1286 1287
	if (sd.total_len) {
		pipe_lock(pipe);
		ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
		pipe_unlock(pipe);
	}
1288

1289
	kfree(iov);
1290 1291 1292
	return ret;
}

1293 1294 1295 1296 1297
/*
 * vmsplice splices a user address range into a pipe. It can be thought of
 * as splice-from-memory, where the regular splice is splice-from-file (or
 * to file). In both cases the output is a pipe, naturally.
 */
1298
static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
1299
			     unsigned long nr_segs, unsigned int flags)
1300
{
1301
	struct pipe_inode_info *pipe;
1302 1303 1304
	struct iovec iovstack[UIO_FASTIOV];
	struct iovec *iov = iovstack;
	struct iov_iter from;
1305
	long ret;
A
Al Viro 已提交
1306 1307 1308 1309
	unsigned buf_flag = 0;

	if (flags & SPLICE_F_GIFT)
		buf_flag = PIPE_BUF_FLAG_GIFT;
1310

1311
	pipe = get_pipe_info(file);
1312
	if (!pipe)
1313 1314
		return -EBADF;

1315 1316 1317 1318 1319
	ret = import_iovec(WRITE, uiov, nr_segs,
			   ARRAY_SIZE(iovstack), &iov, &from);
	if (ret < 0)
		return ret;

1320 1321
	pipe_lock(pipe);
	ret = wait_for_space(pipe, flags);
A
Al Viro 已提交
1322 1323
	if (!ret)
		ret = iter_to_pipe(&from, pipe, buf_flag);
1324 1325 1326
	pipe_unlock(pipe);
	if (ret > 0)
		wakeup_pipe_readers(pipe);
1327
	kfree(iov);
1328
	return ret;
1329 1330
}

1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
/*
 * Note that vmsplice only really supports true splicing _from_ user memory
 * to a pipe, not the other way around. Splicing from user memory is a simple
 * operation that can be supported without any funky alignment restrictions
 * or nasty vm tricks. We simply map in the user memory and fill them into
 * a pipe. The reverse isn't quite as easy, though. There are two possible
 * solutions for that:
 *
 *	- memcpy() the data internally, at which point we might as well just
 *	  do a regular read() on the buffer anyway.
 *	- Lots of nasty vm tricks, that are neither fast nor flexible (it
 *	  has restriction limitations on both ends of the pipe).
 *
 * Currently we punt and implement it as a normal copy, see pipe_to_user().
 *
 */
1347 1348
SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
		unsigned long, nr_segs, unsigned int, flags)
1349
{
1350
	struct fd f;
1351 1352
	long error;

A
Al Viro 已提交
1353 1354
	if (unlikely(flags & ~SPLICE_F_ALL))
		return -EINVAL;
1355 1356 1357 1358 1359
	if (unlikely(nr_segs > UIO_MAXIOV))
		return -EINVAL;
	else if (unlikely(!nr_segs))
		return 0;

1360
	error = -EBADF;
1361 1362 1363 1364 1365 1366 1367 1368
	f = fdget(fd);
	if (f.file) {
		if (f.file->f_mode & FMODE_WRITE)
			error = vmsplice_to_pipe(f.file, iov, nr_segs, flags);
		else if (f.file->f_mode & FMODE_READ)
			error = vmsplice_to_user(f.file, iov, nr_segs, flags);

		fdput(f);
1369 1370 1371 1372 1373
	}

	return error;
}

1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
#ifdef CONFIG_COMPAT
COMPAT_SYSCALL_DEFINE4(vmsplice, int, fd, const struct compat_iovec __user *, iov32,
		    unsigned int, nr_segs, unsigned int, flags)
{
	unsigned i;
	struct iovec __user *iov;
	if (nr_segs > UIO_MAXIOV)
		return -EINVAL;
	iov = compat_alloc_user_space(nr_segs * sizeof(struct iovec));
	for (i = 0; i < nr_segs; i++) {
		struct compat_iovec v;
		if (get_user(v.iov_base, &iov32[i].iov_base) ||
		    get_user(v.iov_len, &iov32[i].iov_len) ||
		    put_user(compat_ptr(v.iov_base), &iov[i].iov_base) ||
		    put_user(v.iov_len, &iov[i].iov_len))
			return -EFAULT;
	}
	return sys_vmsplice(fd, iov, nr_segs, flags);
}
#endif

1395 1396 1397
SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
		int, fd_out, loff_t __user *, off_out,
		size_t, len, unsigned int, flags)
1398
{
1399
	struct fd in, out;
1400 1401 1402 1403 1404
	long error;

	if (unlikely(!len))
		return 0;

A
Al Viro 已提交
1405 1406 1407
	if (unlikely(flags & ~SPLICE_F_ALL))
		return -EINVAL;

1408
	error = -EBADF;
1409 1410 1411 1412 1413 1414 1415 1416
	in = fdget(fd_in);
	if (in.file) {
		if (in.file->f_mode & FMODE_READ) {
			out = fdget(fd_out);
			if (out.file) {
				if (out.file->f_mode & FMODE_WRITE)
					error = do_splice(in.file, off_in,
							  out.file, off_out,
1417
							  len, flags);
1418
				fdput(out);
1419 1420
			}
		}
1421
		fdput(in);
1422 1423 1424
	}
	return error;
}
1425

1426 1427 1428 1429
/*
 * Make sure there's data to read. Wait for input if we can, otherwise
 * return an appropriate error.
 */
1430
static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
{
	int ret;

	/*
	 * Check ->nrbufs without the inode lock first. This function
	 * is speculative anyways, so missing one is ok.
	 */
	if (pipe->nrbufs)
		return 0;

	ret = 0;
1442
	pipe_lock(pipe);
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459

	while (!pipe->nrbufs) {
		if (signal_pending(current)) {
			ret = -ERESTARTSYS;
			break;
		}
		if (!pipe->writers)
			break;
		if (!pipe->waiting_writers) {
			if (flags & SPLICE_F_NONBLOCK) {
				ret = -EAGAIN;
				break;
			}
		}
		pipe_wait(pipe);
	}

1460
	pipe_unlock(pipe);
1461 1462 1463 1464 1465 1466 1467
	return ret;
}

/*
 * Make sure there's writeable room. Wait for room if we can, otherwise
 * return an appropriate error.
 */
1468
static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1469 1470 1471 1472 1473 1474 1475
{
	int ret;

	/*
	 * Check ->nrbufs without the inode lock first. This function
	 * is speculative anyways, so missing one is ok.
	 */
1476
	if (pipe->nrbufs < pipe->buffers)
1477 1478 1479
		return 0;

	ret = 0;
1480
	pipe_lock(pipe);
1481

1482
	while (pipe->nrbufs >= pipe->buffers) {
1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500
		if (!pipe->readers) {
			send_sig(SIGPIPE, current, 0);
			ret = -EPIPE;
			break;
		}
		if (flags & SPLICE_F_NONBLOCK) {
			ret = -EAGAIN;
			break;
		}
		if (signal_pending(current)) {
			ret = -ERESTARTSYS;
			break;
		}
		pipe->waiting_writers++;
		pipe_wait(pipe);
		pipe->waiting_writers--;
	}

1501
	pipe_unlock(pipe);
1502 1503 1504
	return ret;
}

1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
/*
 * Splice contents of ipipe to opipe.
 */
static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
			       struct pipe_inode_info *opipe,
			       size_t len, unsigned int flags)
{
	struct pipe_buffer *ibuf, *obuf;
	int ret = 0, nbuf;
	bool input_wakeup = false;


retry:
	ret = ipipe_prep(ipipe, flags);
	if (ret)
		return ret;

	ret = opipe_prep(opipe, flags);
	if (ret)
		return ret;

	/*
	 * Potential ABBA deadlock, work around it by ordering lock
	 * grabbing by pipe info address. Otherwise two different processes
	 * could deadlock (one doing tee from A -> B, the other from B -> A).
	 */
	pipe_double_lock(ipipe, opipe);

	do {
		if (!opipe->readers) {
			send_sig(SIGPIPE, current, 0);
			if (!ret)
				ret = -EPIPE;
			break;
		}

		if (!ipipe->nrbufs && !ipipe->writers)
			break;

		/*
		 * Cannot make any progress, because either the input
		 * pipe is empty or the output pipe is full.
		 */
1548
		if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568
			/* Already processed some buffers, break */
			if (ret)
				break;

			if (flags & SPLICE_F_NONBLOCK) {
				ret = -EAGAIN;
				break;
			}

			/*
			 * We raced with another reader/writer and haven't
			 * managed to process any buffers.  A zero return
			 * value means EOF, so retry instead.
			 */
			pipe_unlock(ipipe);
			pipe_unlock(opipe);
			goto retry;
		}

		ibuf = ipipe->bufs + ipipe->curbuf;
1569
		nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1570 1571 1572 1573 1574 1575 1576 1577 1578
		obuf = opipe->bufs + nbuf;

		if (len >= ibuf->len) {
			/*
			 * Simply move the whole buffer from ipipe to opipe
			 */
			*obuf = *ibuf;
			ibuf->ops = NULL;
			opipe->nrbufs++;
1579
			ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
1580 1581 1582 1583 1584 1585 1586
			ipipe->nrbufs--;
			input_wakeup = true;
		} else {
			/*
			 * Get a reference to this pipe buffer,
			 * so we can copy the contents over.
			 */
M
Miklos Szeredi 已提交
1587
			pipe_buf_get(ipipe, ibuf);
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610
			*obuf = *ibuf;

			/*
			 * Don't inherit the gift flag, we need to
			 * prevent multiple steals of this page.
			 */
			obuf->flags &= ~PIPE_BUF_FLAG_GIFT;

			obuf->len = len;
			opipe->nrbufs++;
			ibuf->offset += obuf->len;
			ibuf->len -= obuf->len;
		}
		ret += obuf->len;
		len -= obuf->len;
	} while (len);

	pipe_unlock(ipipe);
	pipe_unlock(opipe);

	/*
	 * If we put data in the output pipe, wakeup any potential readers.
	 */
N
Namhyung Kim 已提交
1611 1612 1613
	if (ret > 0)
		wakeup_pipe_readers(opipe);

1614 1615 1616 1617 1618 1619
	if (input_wakeup)
		wakeup_pipe_writers(ipipe);

	return ret;
}

1620 1621 1622 1623 1624 1625 1626 1627
/*
 * Link contents of ipipe to opipe.
 */
static int link_pipe(struct pipe_inode_info *ipipe,
		     struct pipe_inode_info *opipe,
		     size_t len, unsigned int flags)
{
	struct pipe_buffer *ibuf, *obuf;
1628
	int ret = 0, i = 0, nbuf;
1629 1630 1631

	/*
	 * Potential ABBA deadlock, work around it by ordering lock
1632
	 * grabbing by pipe info address. Otherwise two different processes
1633 1634
	 * could deadlock (one doing tee from A -> B, the other from B -> A).
	 */
1635
	pipe_double_lock(ipipe, opipe);
1636

1637
	do {
1638 1639 1640 1641 1642 1643 1644
		if (!opipe->readers) {
			send_sig(SIGPIPE, current, 0);
			if (!ret)
				ret = -EPIPE;
			break;
		}

1645 1646 1647 1648
		/*
		 * If we have iterated all input buffers or ran out of
		 * output room, break.
		 */
1649
		if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
1650
			break;
1651

1652 1653
		ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
		nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1654 1655

		/*
1656 1657
		 * Get a reference to this pipe buffer,
		 * so we can copy the contents over.
1658
		 */
M
Miklos Szeredi 已提交
1659
		pipe_buf_get(ipipe, ibuf);
1660 1661 1662 1663

		obuf = opipe->bufs + nbuf;
		*obuf = *ibuf;

1664
		/*
1665 1666
		 * Don't inherit the gift flag, we need to
		 * prevent multiple steals of this page.
1667
		 */
1668
		obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1669

1670 1671
		if (obuf->len > len)
			obuf->len = len;
1672

1673 1674 1675 1676 1677
		opipe->nrbufs++;
		ret += obuf->len;
		len -= obuf->len;
		i++;
	} while (len);
1678

1679 1680 1681 1682 1683 1684 1685
	/*
	 * return EAGAIN if we have the potential of some data in the
	 * future, otherwise just return 0
	 */
	if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
		ret = -EAGAIN;

1686 1687
	pipe_unlock(ipipe);
	pipe_unlock(opipe);
1688

1689 1690 1691
	/*
	 * If we put data in the output pipe, wakeup any potential readers.
	 */
N
Namhyung Kim 已提交
1692 1693
	if (ret > 0)
		wakeup_pipe_readers(opipe);
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706

	return ret;
}

/*
 * This is a tee(1) implementation that works on pipes. It doesn't copy
 * any data, it simply references the 'in' pages on the 'out' pipe.
 * The 'flags' used are the SPLICE_F_* variants, currently the only
 * applicable one is SPLICE_F_NONBLOCK.
 */
static long do_tee(struct file *in, struct file *out, size_t len,
		   unsigned int flags)
{
1707 1708
	struct pipe_inode_info *ipipe = get_pipe_info(in);
	struct pipe_inode_info *opipe = get_pipe_info(out);
1709
	int ret = -EINVAL;
1710 1711

	/*
1712 1713
	 * Duplicate the contents of ipipe to opipe without actually
	 * copying the data.
1714
	 */
1715 1716 1717 1718 1719
	if (ipipe && opipe && ipipe != opipe) {
		/*
		 * Keep going, unless we encounter an error. The ipipe/opipe
		 * ordering doesn't really matter.
		 */
1720
		ret = ipipe_prep(ipipe, flags);
1721
		if (!ret) {
1722
			ret = opipe_prep(opipe, flags);
1723
			if (!ret)
1724 1725 1726
				ret = link_pipe(ipipe, opipe, len, flags);
		}
	}
1727

1728
	return ret;
1729 1730
}

1731
SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
1732
{
1733 1734
	struct fd in;
	int error;
1735

A
Al Viro 已提交
1736 1737 1738
	if (unlikely(flags & ~SPLICE_F_ALL))
		return -EINVAL;

1739 1740 1741 1742
	if (unlikely(!len))
		return 0;

	error = -EBADF;
1743 1744 1745 1746 1747 1748 1749 1750 1751
	in = fdget(fdin);
	if (in.file) {
		if (in.file->f_mode & FMODE_READ) {
			struct fd out = fdget(fdout);
			if (out.file) {
				if (out.file->f_mode & FMODE_WRITE)
					error = do_tee(in.file, out.file,
							len, flags);
				fdput(out);
1752 1753
			}
		}
1754
 		fdput(in);
1755 1756 1757 1758
 	}

	return error;
}