splice.c 40.2 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 21 22
 *
 */
#include <linux/fs.h>
#include <linux/file.h>
#include <linux/pagemap.h>
23
#include <linux/splice.h>
K
KAMEZAWA Hiroyuki 已提交
24
#include <linux/memcontrol.h>
25
#include <linux/mm_inline.h>
26
#include <linux/swap.h>
27
#include <linux/writeback.h>
28
#include <linux/export.h>
29
#include <linux/syscalls.h>
30
#include <linux/uio.h>
31
#include <linux/security.h>
32
#include <linux/gfp.h>
33
#include <linux/socket.h>
34
#include <linux/compat.h>
35
#include "internal.h"
36

37 38 39 40 41 42
/*
 * 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.
 */
43
static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
44 45 46
				     struct pipe_buffer *buf)
{
	struct page *page = buf->page;
47
	struct address_space *mapping;
48

49 50
	lock_page(page);

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

55 56 57 58 59 60 61 62 63
		/*
		 * 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);
64

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

69 70 71 72 73 74 75 76
		/*
		 * 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;
		}
77
	}
78

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

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

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

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

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

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

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

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

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

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

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

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

N
Namhyung Kim 已提交
163 164 165 166 167 168 169 170
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);
}

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

188 189 190
	if (!spd_pages)
		return 0;

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

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

201 202 203 204 205
		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;
206

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

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

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

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

	return ret;
}
224
EXPORT_SYMBOL_GPL(splice_to_pipe);
225

A
Al Viro 已提交
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
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;
	}
	buf->ops->release(pipe, buf);
	buf->ops = NULL;
	return ret;
}
EXPORT_SYMBOL(add_to_pipe);

247
void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
248
{
249
	put_page(spd->pages[i]);
250 251
}

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

	spd->nr_pages_max = buffers;
	if (buffers <= PIPE_DEF_BUFFERS)
262 263
		return 0;

264 265
	spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
	spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
266 267 268 269 270 271 272 273 274

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

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

275
void splice_shrink_spd(struct splice_pipe_desc *spd)
276
{
277
	if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
278 279 280 281 282 283
		return;

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

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

306 307 308 309
	isize = i_size_read(in->f_mapping->host);
	if (unlikely(*ppos >= isize))
		return 0;

310 311 312 313 314
	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);
315
	if (ret > 0) {
316
		*ppos = kiocb.ki_pos;
317
		file_accessed(in);
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
	} else if (ret < 0) {
		if (WARN_ON(to.idx != idx || to.iov_offset)) {
			/*
			 * a bogus ->read_iter() has copied something and still
			 * returned an error instead of a short read.
			 */
			to.idx = idx;
			to.iov_offset = 0;
			iov_iter_advance(&to, 0); /* to free what was emitted */
		}
		/*
		 * callers of ->splice_read() expect -EAGAIN on
		 * "can't put anything in there", rather than -EFAULT.
		 */
		if (ret == -EFAULT)
			ret = -EAGAIN;
334
	}
335 336 337

	return ret;
}
338 339
EXPORT_SYMBOL(generic_file_splice_read);

A
Al Viro 已提交
340
const struct pipe_buf_operations default_pipe_buf_ops = {
341 342 343 344 345 346 347
	.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 已提交
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
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);

364
static ssize_t kernel_readv(struct file *file, const struct kvec *vec,
365 366 367 368 369 370 371 372 373
			    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() */
374
	res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos, 0);
375 376 377 378 379
	set_fs(old_fs);

	return res;
}

380
ssize_t kernel_write(struct file *file, const char *buf, size_t count,
381
			    loff_t pos)
382 383 384 385 386 387 388
{
	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() */
389
	res = vfs_write(file, (__force const char __user *)buf, count, &pos);
390 391 392 393
	set_fs(old_fs);

	return res;
}
394
EXPORT_SYMBOL(kernel_write);
395

396
static ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
397 398 399
				 struct pipe_inode_info *pipe, size_t len,
				 unsigned int flags)
{
400 401 402
	struct kvec *vec, __vec[PIPE_DEF_BUFFERS];
	struct iov_iter to;
	struct page **pages;
403
	unsigned int nr_pages;
404
	size_t offset, dummy, copied = 0;
405 406
	ssize_t res;
	int i;
407

408 409
	if (pipe->nrbufs == pipe->buffers)
		return -EAGAIN;
410

411 412 413 414
	/*
	 * Try to keep page boundaries matching to source pagecache ones -
	 * it probably won't be much help, but...
	 */
415
	offset = *ppos & ~PAGE_MASK;
416

417
	iov_iter_pipe(&to, ITER_PIPE | READ, pipe, len + offset);
418

419 420 421
	res = iov_iter_get_pages_alloc(&to, &pages, len + offset, &dummy);
	if (res <= 0)
		return -ENOMEM;
422

423
	nr_pages = res / PAGE_SIZE;
424

425 426 427 428 429 430 431
	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 已提交
432
	}
433

434 435 436 437 438 439 440 441 442
	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;
443 444
	}

445 446 447
	res = kernel_readv(in, vec, nr_pages, *ppos);
	if (res > 0) {
		copied = res;
448
		*ppos += res;
449
	}
450

451 452
	if (vec != __vec)
		kfree(vec);
453 454 455 456 457
out:
	for (i = 0; i < nr_pages; i++)
		put_page(pages[i]);
	kvfree(pages);
	iov_iter_advance(&to, copied);	/* truncates and discards */
458 459 460
	return res;
}

461
/*
462
 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
J
Jens Axboe 已提交
463
 * using sendpage(). Return the number of bytes sent.
464
 */
465
static int pipe_to_sendpage(struct pipe_inode_info *pipe,
466 467
			    struct pipe_buffer *buf, struct splice_desc *sd)
{
468
	struct file *file = sd->u.file;
469
	loff_t pos = sd->pos;
470
	int more;
471

A
Al Viro 已提交
472
	if (!likely(file->f_op->sendpage))
473 474
		return -EINVAL;

475
	more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
476 477

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

480 481
	return file->f_op->sendpage(file, buf->page, buf->offset,
				    sd->len, &pos, more);
482 483
}

484 485 486 487 488 489 490 491
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);
}

492
/**
493
 * splice_from_pipe_feed - feed available data from a pipe to a file
494 495 496 497 498
 * @pipe:	pipe to splice from
 * @sd:		information to @actor
 * @actor:	handler that splices the data
 *
 * Description:
499 500 501 502 503 504 505
 *    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.
506
 *
507 508 509 510
 *    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.
511
 */
A
Al Viro 已提交
512
static int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
513
			  splice_actor *actor)
514
{
515
	int ret;
516

517 518 519
	while (pipe->nrbufs) {
		struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
		const struct pipe_buf_operations *ops = buf->ops;
520

521 522 523
		sd->len = buf->len;
		if (sd->len > sd->total_len)
			sd->len = sd->total_len;
524

525 526
		ret = buf->ops->confirm(pipe, buf);
		if (unlikely(ret)) {
527 528 529 530
			if (ret == -ENODATA)
				ret = 0;
			return ret;
		}
531 532 533 534 535

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

536 537 538 539 540 541 542 543 544 545 546
		buf->offset += ret;
		buf->len -= ret;

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

		if (!buf->len) {
			buf->ops = NULL;
			ops->release(pipe, buf);
547
			pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
548
			pipe->nrbufs--;
A
Al Viro 已提交
549
			if (pipe->files)
550 551
				sd->need_wakeup = true;
		}
552

553 554 555
		if (!sd->total_len)
			return 0;
	}
556

557 558
	return 1;
}
559

560 561 562 563 564 565 566 567 568 569
/**
 * 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 已提交
570
static int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
571
{
572 573 574 575 576 577 578
	/*
	 * Check for signal early to make process killable when there are
	 * always buffers available
	 */
	if (signal_pending(current))
		return -ERESTARTSYS;

579 580 581
	while (!pipe->nrbufs) {
		if (!pipe->writers)
			return 0;
J
Jens Axboe 已提交
582

583 584
		if (!pipe->waiting_writers && sd->num_spliced)
			return 0;
I
Ingo Molnar 已提交
585

586 587
		if (sd->flags & SPLICE_F_NONBLOCK)
			return -EAGAIN;
588

589 590
		if (signal_pending(current))
			return -ERESTARTSYS;
591

592 593 594
		if (sd->need_wakeup) {
			wakeup_pipe_writers(pipe);
			sd->need_wakeup = false;
595 596
		}

597 598
		pipe_wait(pipe);
	}
599

600 601
	return 1;
}
602

603 604
/**
 * splice_from_pipe_begin - start splicing from pipe
605
 * @sd:		information about the splice operation
606 607 608 609 610 611
 *
 * 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 已提交
612
static void splice_from_pipe_begin(struct splice_desc *sd)
613 614 615 616
{
	sd->num_spliced = 0;
	sd->need_wakeup = false;
}
617

618 619 620 621 622 623 624 625 626 627
/**
 * 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 已提交
628
static void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
629 630 631 632
{
	if (sd->need_wakeup)
		wakeup_pipe_writers(pipe);
}
633

634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
/**
 * __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;
651

652 653
	splice_from_pipe_begin(sd);
	do {
J
Jan Kara 已提交
654
		cond_resched();
655 656 657 658 659 660 661
		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;
662
}
M
Mark Fasheh 已提交
663
EXPORT_SYMBOL(__splice_from_pipe);
664

665 666 667 668 669 670 671 672 673 674
/**
 * 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:
675
 *    See __splice_from_pipe. This function locks the pipe inode,
676 677 678
 *    otherwise it's identical to __splice_from_pipe().
 *
 */
679 680 681 682 683
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 已提交
684 685 686 687
	struct splice_desc sd = {
		.total_len = len,
		.flags = flags,
		.pos = *ppos,
688
		.u.file = out,
J
Jens Axboe 已提交
689
	};
690

691
	pipe_lock(pipe);
J
Jens Axboe 已提交
692
	ret = __splice_from_pipe(pipe, &sd, actor);
693
	pipe_unlock(pipe);
694 695 696 697

	return ret;
}

A
Al Viro 已提交
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 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
/**
 * 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;

			ret = buf->ops->confirm(pipe, buf);
			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 已提交
778 779
		iov_iter_bvec(&from, ITER_BVEC | WRITE, array, n,
			      sd.total_len - left);
780
		ret = vfs_iter_write(out, &from, &sd.pos);
A
Al Viro 已提交
781 782 783 784 785
		if (ret <= 0)
			break;

		sd.num_spliced += ret;
		sd.total_len -= ret;
786
		*ppos = sd.pos;
A
Al Viro 已提交
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821

		/* dismiss the fully eaten buffers, adjust the partial one */
		while (ret) {
			struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
			if (ret >= buf->len) {
				const struct pipe_buf_operations *ops = buf->ops;
				ret -= buf->len;
				buf->len = 0;
				buf->ops = NULL;
				ops->release(pipe, buf);
				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);

822 823
static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
			  struct splice_desc *sd)
824
{
825 826
	int ret;
	void *data;
827
	loff_t tmp = sd->pos;
828

A
Al Viro 已提交
829
	data = kmap(buf->page);
830
	ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
A
Al Viro 已提交
831
	kunmap(buf->page);
832 833

	return ret;
834 835 836 837 838 839
}

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

842 843 844
	ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
	if (ret > 0)
		*ppos += ret;
845

846
	return ret;
847 848
}

849 850
/**
 * generic_splice_sendpage - splice data from a pipe to a socket
851
 * @pipe:	pipe to splice from
852
 * @out:	socket to write to
853
 * @ppos:	position in @out
854 855 856
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
857 858 859
 * Description:
 *    Will send @len bytes from the pipe to a network socket. No data copying
 *    is involved.
860 861
 *
 */
862
ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
863
				loff_t *ppos, size_t len, unsigned int flags)
864
{
865
	return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
866 867
}

868
EXPORT_SYMBOL(generic_splice_sendpage);
J
Jeff Garzik 已提交
869

870 871 872
/*
 * Attempt to initiate a splice from pipe to file.
 */
873
static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
874
			   loff_t *ppos, size_t len, unsigned int flags)
875
{
876 877
	ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
				loff_t *, size_t, unsigned int);
878

A
Al Viro 已提交
879
	if (out->f_op->splice_write)
880 881
		splice_write = out->f_op->splice_write;
	else
882 883
		splice_write = default_file_splice_write;

884
	return splice_write(pipe, out, ppos, len, flags);
885 886
}

887 888 889
/*
 * Attempt to initiate a splice from a file to a pipe.
 */
890 891 892
static long do_splice_to(struct file *in, loff_t *ppos,
			 struct pipe_inode_info *pipe, size_t len,
			 unsigned int flags)
893
{
894 895
	ssize_t (*splice_read)(struct file *, loff_t *,
			       struct pipe_inode_info *, size_t, unsigned int);
896 897
	int ret;

898
	if (unlikely(!(in->f_mode & FMODE_READ)))
899 900
		return -EBADF;

901
	ret = rw_verify_area(READ, in, ppos, len);
902 903 904
	if (unlikely(ret < 0))
		return ret;

905 906 907
	if (unlikely(len > MAX_RW_COUNT))
		len = MAX_RW_COUNT;

A
Al Viro 已提交
908
	if (in->f_op->splice_read)
909 910
		splice_read = in->f_op->splice_read;
	else
911 912 913
		splice_read = default_file_splice_read;

	return splice_read(in, ppos, pipe, len, flags);
914 915
}

916 917 918 919 920 921 922 923 924
/**
 * 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 已提交
925
 *    pipe is cached in the process, and reused during the lifetime of
926 927
 *    that process.
 *
J
Jens Axboe 已提交
928 929 930
 */
ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
			       splice_direct_actor *actor)
931 932 933 934
{
	struct pipe_inode_info *pipe;
	long ret, bytes;
	umode_t i_mode;
J
Jens Axboe 已提交
935
	size_t len;
936
	int i, flags, more;
937 938 939 940 941 942

	/*
	 * 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 已提交
943
	i_mode = file_inode(in)->i_mode;
944 945 946 947 948 949 950 951
	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;
952
	if (unlikely(!pipe)) {
A
Al Viro 已提交
953
		pipe = alloc_pipe_info();
954 955 956 957 958
		if (!pipe)
			return -ENOMEM;

		/*
		 * We don't have an immediate reader, but we'll read the stuff
959
		 * out of the pipe right after the splice_to_pipe(). So set
960 961 962 963 964 965 966 967
		 * PIPE_READERS appropriately.
		 */
		pipe->readers = 1;

		current->splice_pipe = pipe;
	}

	/*
I
Ingo Molnar 已提交
968
	 * Do the splice.
969 970 971
	 */
	ret = 0;
	bytes = 0;
J
Jens Axboe 已提交
972 973 974 975 976 977 978
	len = sd->total_len;
	flags = sd->flags;

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

	while (len) {
982
		size_t read_len;
983
		loff_t pos = sd->pos, prev_pos = pos;
984

985
		ret = do_splice_to(in, &pos, pipe, len, flags);
986
		if (unlikely(ret <= 0))
987 988 989
			goto out_release;

		read_len = ret;
J
Jens Axboe 已提交
990
		sd->total_len = read_len;
991

992 993 994 995 996 997 998 999 1000
		/*
		 * 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;
1001 1002 1003 1004 1005
		/*
		 * 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 已提交
1006
		ret = actor(pipe, sd);
1007 1008
		if (unlikely(ret <= 0)) {
			sd->pos = prev_pos;
1009
			goto out_release;
1010
		}
1011 1012 1013

		bytes += ret;
		len -= ret;
1014
		sd->pos = pos;
1015

1016 1017
		if (ret < read_len) {
			sd->pos = prev_pos + ret;
1018
			goto out_release;
1019
		}
1020 1021
	}

1022
done:
1023
	pipe->nrbufs = pipe->curbuf = 0;
1024
	file_accessed(in);
1025 1026 1027 1028 1029 1030 1031
	return bytes;

out_release:
	/*
	 * If we did an incomplete transfer we must release
	 * the pipe buffers in question:
	 */
1032
	for (i = 0; i < pipe->buffers; i++) {
1033 1034 1035 1036 1037 1038 1039 1040
		struct pipe_buffer *buf = pipe->bufs + i;

		if (buf->ops) {
			buf->ops->release(pipe, buf);
			buf->ops = NULL;
		}
	}

1041 1042
	if (!bytes)
		bytes = ret;
J
Jens Axboe 已提交
1043

1044
	goto done;
J
Jens Axboe 已提交
1045 1046 1047 1048 1049 1050
}
EXPORT_SYMBOL(splice_direct_to_actor);

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

1053
	return do_splice_from(pipe, file, sd->opos, sd->total_len,
1054
			      sd->flags);
J
Jens Axboe 已提交
1055 1056
}

1057 1058 1059 1060 1061
/**
 * do_splice_direct - splices data directly between two files
 * @in:		file to splice from
 * @ppos:	input file offset
 * @out:	file to splice to
1062
 * @opos:	output file offset
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
 * @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 已提交
1073
long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
1074
		      loff_t *opos, size_t len, unsigned int flags)
J
Jens Axboe 已提交
1075 1076 1077 1078 1079 1080
{
	struct splice_desc sd = {
		.len		= len,
		.total_len	= len,
		.flags		= flags,
		.pos		= *ppos,
1081
		.u.file		= out,
1082
		.opos		= opos,
J
Jens Axboe 已提交
1083
	};
1084
	long ret;
J
Jens Axboe 已提交
1085

1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
	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 已提交
1096
	ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
1097
	if (ret > 0)
1098
		*ppos = sd.pos;
1099

J
Jens Axboe 已提交
1100
	return ret;
1101
}
1102
EXPORT_SYMBOL(do_splice_direct);
1103

1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
static int wait_for_space(struct pipe_inode_info *pipe, unsigned flags)
{
	while (pipe->nrbufs == pipe->buffers) {
		if (flags & SPLICE_F_NONBLOCK)
			return -EAGAIN;
		if (signal_pending(current))
			return -ERESTARTSYS;
		pipe->waiting_writers++;
		pipe_wait(pipe);
		pipe->waiting_writers--;
	}
	return 0;
}

1118 1119 1120
static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
			       struct pipe_inode_info *opipe,
			       size_t len, unsigned int flags);
1121

1122 1123 1124
/*
 * Determine where to splice to/from.
 */
1125 1126 1127
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)
1128
{
1129 1130
	struct pipe_inode_info *ipipe;
	struct pipe_inode_info *opipe;
1131
	loff_t offset;
J
Jens Axboe 已提交
1132
	long ret;
1133

1134 1135
	ipipe = get_pipe_info(in);
	opipe = get_pipe_info(out);
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154

	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) {
1155 1156
		if (off_in)
			return -ESPIPE;
1157
		if (off_out) {
1158
			if (!(out->f_mode & FMODE_PWRITE))
1159
				return -EINVAL;
1160
			if (copy_from_user(&offset, off_out, sizeof(loff_t)))
1161
				return -EFAULT;
1162 1163 1164
		} else {
			offset = out->f_pos;
		}
1165

1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
		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;

1176
		file_start_write(out);
1177
		ret = do_splice_from(ipipe, out, &offset, len, flags);
1178
		file_end_write(out);
J
Jens Axboe 已提交
1179

1180 1181 1182
		if (!off_out)
			out->f_pos = offset;
		else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
J
Jens Axboe 已提交
1183 1184 1185
			ret = -EFAULT;

		return ret;
1186
	}
1187

1188
	if (opipe) {
1189 1190
		if (off_out)
			return -ESPIPE;
1191
		if (off_in) {
1192
			if (!(in->f_mode & FMODE_PREAD))
1193
				return -EINVAL;
1194
			if (copy_from_user(&offset, off_in, sizeof(loff_t)))
1195
				return -EFAULT;
1196 1197 1198
		} else {
			offset = in->f_pos;
		}
1199

1200 1201 1202 1203 1204 1205 1206
		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);
1207 1208 1209
		if (!off_in)
			in->f_pos = offset;
		else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
J
Jens Axboe 已提交
1210 1211 1212
			ret = -EFAULT;

		return ret;
1213
	}
1214 1215 1216 1217

	return -EINVAL;
}

A
Al Viro 已提交
1218 1219 1220
static int iter_to_pipe(struct iov_iter *from,
			struct pipe_inode_info *pipe,
			unsigned flags)
1221
{
A
Al Viro 已提交
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
	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];
1232 1233
		ssize_t copied;
		size_t start;
A
Al Viro 已提交
1234
		int n;
1235

A
Al Viro 已提交
1236 1237 1238 1239 1240
		copied = iov_iter_get_pages(from, pages, ~0UL, 16, &start);
		if (copied <= 0) {
			ret = copied;
			break;
		}
1241

A
Al Viro 已提交
1242
		for (n = 0; copied; n++, start = 0) {
1243
			int size = min_t(int, copied, PAGE_SIZE - start);
A
Al Viro 已提交
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
			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]);
			}
1258
			copied -= size;
1259 1260
		}
	}
A
Al Viro 已提交
1261
	return total ? total : ret;
1262 1263
}

1264 1265 1266
static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
			struct splice_desc *sd)
{
1267 1268
	int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
	return n == sd->len ? n : -EFAULT;
1269 1270 1271 1272 1273 1274
}

/*
 * For lack of a better implementation, implement vmsplice() to userspace
 * as a simple copy of the pipes pages to the user iov.
 */
1275
static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
1276 1277 1278 1279 1280
			     unsigned long nr_segs, unsigned int flags)
{
	struct pipe_inode_info *pipe;
	struct splice_desc sd;
	long ret;
1281 1282 1283
	struct iovec iovstack[UIO_FASTIOV];
	struct iovec *iov = iovstack;
	struct iov_iter iter;
1284

1285
	pipe = get_pipe_info(file);
1286 1287 1288
	if (!pipe)
		return -EBADF;

1289 1290 1291 1292
	ret = import_iovec(READ, uiov, nr_segs,
			   ARRAY_SIZE(iovstack), &iov, &iter);
	if (ret < 0)
		return ret;
1293

1294
	sd.total_len = iov_iter_count(&iter);
1295 1296 1297 1298
	sd.len = 0;
	sd.flags = flags;
	sd.u.data = &iter;
	sd.pos = 0;
1299

1300 1301 1302 1303 1304
	if (sd.total_len) {
		pipe_lock(pipe);
		ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
		pipe_unlock(pipe);
	}
1305

1306
	kfree(iov);
1307 1308 1309
	return ret;
}

1310 1311 1312 1313 1314
/*
 * 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.
 */
1315
static long vmsplice_to_pipe(struct file *file, const struct iovec __user *uiov,
1316
			     unsigned long nr_segs, unsigned int flags)
1317
{
1318
	struct pipe_inode_info *pipe;
1319 1320 1321
	struct iovec iovstack[UIO_FASTIOV];
	struct iovec *iov = iovstack;
	struct iov_iter from;
1322
	long ret;
A
Al Viro 已提交
1323 1324 1325 1326
	unsigned buf_flag = 0;

	if (flags & SPLICE_F_GIFT)
		buf_flag = PIPE_BUF_FLAG_GIFT;
1327

1328
	pipe = get_pipe_info(file);
1329
	if (!pipe)
1330 1331
		return -EBADF;

1332 1333 1334 1335 1336
	ret = import_iovec(WRITE, uiov, nr_segs,
			   ARRAY_SIZE(iovstack), &iov, &from);
	if (ret < 0)
		return ret;

1337 1338
	pipe_lock(pipe);
	ret = wait_for_space(pipe, flags);
A
Al Viro 已提交
1339 1340
	if (!ret)
		ret = iter_to_pipe(&from, pipe, buf_flag);
1341 1342 1343
	pipe_unlock(pipe);
	if (ret > 0)
		wakeup_pipe_readers(pipe);
1344
	kfree(iov);
1345
	return ret;
1346 1347
}

1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
/*
 * 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().
 *
 */
1364 1365
SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
		unsigned long, nr_segs, unsigned int, flags)
1366
{
1367
	struct fd f;
1368 1369
	long error;

1370 1371 1372 1373 1374
	if (unlikely(nr_segs > UIO_MAXIOV))
		return -EINVAL;
	else if (unlikely(!nr_segs))
		return 0;

1375
	error = -EBADF;
1376 1377 1378 1379 1380 1381 1382 1383
	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);
1384 1385 1386 1387 1388
	}

	return error;
}

1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
#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

1410 1411 1412
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)
1413
{
1414
	struct fd in, out;
1415 1416 1417 1418 1419 1420
	long error;

	if (unlikely(!len))
		return 0;

	error = -EBADF;
1421 1422 1423 1424 1425 1426 1427 1428
	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,
1429
							  len, flags);
1430
				fdput(out);
1431 1432
			}
		}
1433
		fdput(in);
1434 1435 1436
	}
	return error;
}
1437

1438 1439 1440 1441
/*
 * Make sure there's data to read. Wait for input if we can, otherwise
 * return an appropriate error.
 */
1442
static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
{
	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;
1454
	pipe_lock(pipe);
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471

	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);
	}

1472
	pipe_unlock(pipe);
1473 1474 1475 1476 1477 1478 1479
	return ret;
}

/*
 * Make sure there's writeable room. Wait for room if we can, otherwise
 * return an appropriate error.
 */
1480
static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1481 1482 1483 1484 1485 1486 1487
{
	int ret;

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

	ret = 0;
1492
	pipe_lock(pipe);
1493

1494
	while (pipe->nrbufs >= pipe->buffers) {
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
		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--;
	}

1513
	pipe_unlock(pipe);
1514 1515 1516
	return ret;
}

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 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
/*
 * 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.
		 */
1560
		if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
			/* 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;
1581
		nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1582 1583 1584 1585 1586 1587 1588 1589 1590
		obuf = opipe->bufs + nbuf;

		if (len >= ibuf->len) {
			/*
			 * Simply move the whole buffer from ipipe to opipe
			 */
			*obuf = *ibuf;
			ibuf->ops = NULL;
			opipe->nrbufs++;
1591
			ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
			ipipe->nrbufs--;
			input_wakeup = true;
		} else {
			/*
			 * Get a reference to this pipe buffer,
			 * so we can copy the contents over.
			 */
			ibuf->ops->get(ipipe, ibuf);
			*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 已提交
1623 1624 1625
	if (ret > 0)
		wakeup_pipe_readers(opipe);

1626 1627 1628 1629 1630 1631
	if (input_wakeup)
		wakeup_pipe_writers(ipipe);

	return ret;
}

1632 1633 1634 1635 1636 1637 1638 1639
/*
 * 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;
1640
	int ret = 0, i = 0, nbuf;
1641 1642 1643

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

1649
	do {
1650 1651 1652 1653 1654 1655 1656
		if (!opipe->readers) {
			send_sig(SIGPIPE, current, 0);
			if (!ret)
				ret = -EPIPE;
			break;
		}

1657 1658 1659 1660
		/*
		 * If we have iterated all input buffers or ran out of
		 * output room, break.
		 */
1661
		if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
1662
			break;
1663

1664 1665
		ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
		nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1666 1667

		/*
1668 1669
		 * Get a reference to this pipe buffer,
		 * so we can copy the contents over.
1670
		 */
1671 1672 1673 1674 1675
		ibuf->ops->get(ipipe, ibuf);

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

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

1682 1683
		if (obuf->len > len)
			obuf->len = len;
1684

1685 1686 1687 1688 1689
		opipe->nrbufs++;
		ret += obuf->len;
		len -= obuf->len;
		i++;
	} while (len);
1690

1691 1692 1693 1694 1695 1696 1697
	/*
	 * 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;

1698 1699
	pipe_unlock(ipipe);
	pipe_unlock(opipe);
1700

1701 1702 1703
	/*
	 * If we put data in the output pipe, wakeup any potential readers.
	 */
N
Namhyung Kim 已提交
1704 1705
	if (ret > 0)
		wakeup_pipe_readers(opipe);
1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718

	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)
{
1719 1720
	struct pipe_inode_info *ipipe = get_pipe_info(in);
	struct pipe_inode_info *opipe = get_pipe_info(out);
1721
	int ret = -EINVAL;
1722 1723

	/*
1724 1725
	 * Duplicate the contents of ipipe to opipe without actually
	 * copying the data.
1726
	 */
1727 1728 1729 1730 1731
	if (ipipe && opipe && ipipe != opipe) {
		/*
		 * Keep going, unless we encounter an error. The ipipe/opipe
		 * ordering doesn't really matter.
		 */
1732
		ret = ipipe_prep(ipipe, flags);
1733
		if (!ret) {
1734
			ret = opipe_prep(opipe, flags);
1735
			if (!ret)
1736 1737 1738
				ret = link_pipe(ipipe, opipe, len, flags);
		}
	}
1739

1740
	return ret;
1741 1742
}

1743
SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
1744
{
1745 1746
	struct fd in;
	int error;
1747 1748 1749 1750 1751

	if (unlikely(!len))
		return 0;

	error = -EBADF;
1752 1753 1754 1755 1756 1757 1758 1759 1760
	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);
1761 1762
			}
		}
1763
 		fdput(in);
1764 1765 1766 1767
 	}

	return error;
}