splice.c 46.5 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 91
					struct pipe_buffer *buf)
{
	page_cache_release(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, do_wakeup, page_nr;
187 188 189

	ret = 0;
	do_wakeup = 0;
190
	page_nr = 0;
191

192
	pipe_lock(pipe);
193 194

	for (;;) {
195
		if (!pipe->readers) {
196 197 198 199 200 201
			send_sig(SIGPIPE, current, 0);
			if (!ret)
				ret = -EPIPE;
			break;
		}

202 203
		if (pipe->nrbufs < pipe->buffers) {
			int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
204
			struct pipe_buffer *buf = pipe->bufs + newbuf;
205

206 207 208
			buf->page = spd->pages[page_nr];
			buf->offset = spd->partial[page_nr].offset;
			buf->len = spd->partial[page_nr].len;
209
			buf->private = spd->partial[page_nr].private;
210
			buf->ops = spd->ops;
211 212 213
			if (spd->flags & SPLICE_F_GIFT)
				buf->flags |= PIPE_BUF_FLAG_GIFT;

214
			pipe->nrbufs++;
215 216 217
			page_nr++;
			ret += buf->len;

A
Al Viro 已提交
218
			if (pipe->files)
219
				do_wakeup = 1;
220

221
			if (!--spd->nr_pages)
222
				break;
223
			if (pipe->nrbufs < pipe->buffers)
224 225 226 227 228
				continue;

			break;
		}

229
		if (spd->flags & SPLICE_F_NONBLOCK) {
230 231 232 233 234
			if (!ret)
				ret = -EAGAIN;
			break;
		}

235 236 237 238 239 240 241
		if (signal_pending(current)) {
			if (!ret)
				ret = -ERESTARTSYS;
			break;
		}

		if (do_wakeup) {
242
			smp_mb();
243 244 245
			if (waitqueue_active(&pipe->wait))
				wake_up_interruptible_sync(&pipe->wait);
			kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
246 247 248
			do_wakeup = 0;
		}

249 250 251
		pipe->waiting_writers++;
		pipe_wait(pipe);
		pipe->waiting_writers--;
252 253
	}

254
	pipe_unlock(pipe);
255

N
Namhyung Kim 已提交
256 257
	if (do_wakeup)
		wakeup_pipe_readers(pipe);
258

259
	while (page_nr < spd_pages)
260
		spd->spd_release(spd, page_nr++);
261 262 263 264

	return ret;
}

265
void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
266 267 268 269
{
	page_cache_release(spd->pages[i]);
}

270 271 272 273
/*
 * Check if we need to grow the arrays holding pages and partial page
 * descriptions.
 */
274
int splice_grow_spd(const struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
275
{
276 277 278 279
	unsigned int buffers = ACCESS_ONCE(pipe->buffers);

	spd->nr_pages_max = buffers;
	if (buffers <= PIPE_DEF_BUFFERS)
280 281
		return 0;

282 283
	spd->pages = kmalloc(buffers * sizeof(struct page *), GFP_KERNEL);
	spd->partial = kmalloc(buffers * sizeof(struct partial_page), GFP_KERNEL);
284 285 286 287 288 289 290 291 292

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

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

293
void splice_shrink_spd(struct splice_pipe_desc *spd)
294
{
295
	if (spd->nr_pages_max <= PIPE_DEF_BUFFERS)
296 297 298 299 300 301
		return;

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

302
static int
303 304 305
__generic_file_splice_read(struct file *in, loff_t *ppos,
			   struct pipe_inode_info *pipe, size_t len,
			   unsigned int flags)
306 307
{
	struct address_space *mapping = in->f_mapping;
F
Fengguang Wu 已提交
308
	unsigned int loff, nr_pages, req_pages;
309 310
	struct page *pages[PIPE_DEF_BUFFERS];
	struct partial_page partial[PIPE_DEF_BUFFERS];
311
	struct page *page;
312 313
	pgoff_t index, end_index;
	loff_t isize;
314
	int error, page_nr;
315 316 317
	struct splice_pipe_desc spd = {
		.pages = pages,
		.partial = partial,
318
		.nr_pages_max = PIPE_DEF_BUFFERS,
319 320
		.flags = flags,
		.ops = &page_cache_pipe_buf_ops,
321
		.spd_release = spd_release_page,
322
	};
323

324 325 326
	if (splice_grow_spd(pipe, &spd))
		return -ENOMEM;

327
	index = *ppos >> PAGE_CACHE_SHIFT;
328
	loff = *ppos & ~PAGE_CACHE_MASK;
F
Fengguang Wu 已提交
329
	req_pages = (len + loff + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
330
	nr_pages = min(req_pages, spd.nr_pages_max);
331

332 333 334
	/*
	 * Lookup the (hopefully) full range of pages we need.
	 */
335
	spd.nr_pages = find_get_pages_contig(mapping, index, nr_pages, spd.pages);
336
	index += spd.nr_pages;
337

338 339
	/*
	 * If find_get_pages_contig() returned fewer pages than we needed,
340
	 * readahead/allocate the rest and fill in the holes.
341
	 */
342
	if (spd.nr_pages < nr_pages)
343 344
		page_cache_sync_readahead(mapping, &in->f_ra, in,
				index, req_pages - spd.nr_pages);
345

346
	error = 0;
347
	while (spd.nr_pages < nr_pages) {
348
		/*
349 350
		 * Page could be there, find_get_pages_contig() breaks on
		 * the first hole.
351
		 */
352 353 354
		page = find_get_page(mapping, index);
		if (!page) {
			/*
355
			 * page didn't exist, allocate one.
356 357 358 359 360 361
			 */
			page = page_cache_alloc_cold(mapping);
			if (!page)
				break;

			error = add_to_page_cache_lru(page, mapping, index,
362
						GFP_KERNEL);
363 364
			if (unlikely(error)) {
				page_cache_release(page);
365 366
				if (error == -EEXIST)
					continue;
367 368
				break;
			}
369 370 371 372 373
			/*
			 * add_to_page_cache() locks the page, unlock it
			 * to avoid convoluting the logic below even more.
			 */
			unlock_page(page);
374 375
		}

376
		spd.pages[spd.nr_pages++] = page;
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
		index++;
	}

	/*
	 * Now loop over the map and see if we need to start IO on any
	 * pages, fill in the partial map, etc.
	 */
	index = *ppos >> PAGE_CACHE_SHIFT;
	nr_pages = spd.nr_pages;
	spd.nr_pages = 0;
	for (page_nr = 0; page_nr < nr_pages; page_nr++) {
		unsigned int this_len;

		if (!len)
			break;

		/*
		 * this_len is the max we'll use from this page
		 */
		this_len = min_t(unsigned long, len, PAGE_CACHE_SIZE - loff);
397
		page = spd.pages[page_nr];
398

399
		if (PageReadahead(page))
400
			page_cache_async_readahead(mapping, &in->f_ra, in,
F
Fengguang Wu 已提交
401
					page, index, req_pages - page_nr);
402

403 404 405 406
		/*
		 * If the page isn't uptodate, we may need to start io on it
		 */
		if (!PageUptodate(page)) {
407
			lock_page(page);
408 409

			/*
410 411 412 413
			 * Page was truncated, or invalidated by the
			 * filesystem.  Redo the find/create, but this time the
			 * page is kept locked, so there's no chance of another
			 * race with truncate/invalidate.
414 415 416
			 */
			if (!page->mapping) {
				unlock_page(page);
417 418 419 420 421 422 423
				page = find_or_create_page(mapping, index,
						mapping_gfp_mask(mapping));

				if (!page) {
					error = -ENOMEM;
					break;
				}
424 425
				page_cache_release(spd.pages[page_nr]);
				spd.pages[page_nr] = page;
426 427 428 429 430 431 432 433
			}
			/*
			 * page was already under io and is now done, great
			 */
			if (PageUptodate(page)) {
				unlock_page(page);
				goto fill_it;
			}
434

435 436 437 438
			/*
			 * need to read in the page
			 */
			error = mapping->a_ops->readpage(in, page);
439
			if (unlikely(error)) {
440 441 442 443 444 445
				/*
				 * We really should re-lookup the page here,
				 * but it complicates things a lot. Instead
				 * lets just do what we already stored, and
				 * we'll get it the next time we are called.
				 */
446
				if (error == AOP_TRUNCATED_PAGE)
447 448
					error = 0;

449 450
				break;
			}
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
		}
fill_it:
		/*
		 * i_size must be checked after PageUptodate.
		 */
		isize = i_size_read(mapping->host);
		end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
		if (unlikely(!isize || index > end_index))
			break;

		/*
		 * if this is the last page, see if we need to shrink
		 * the length and stop
		 */
		if (end_index == index) {
			unsigned int plen;
467 468

			/*
469
			 * max good bytes in this page
470
			 */
471 472
			plen = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
			if (plen <= loff)
473 474 475
				break;

			/*
476
			 * force quit after adding this page
477
			 */
478 479
			this_len = min(this_len, plen - loff);
			len = this_len;
480
		}
481

482 483
		spd.partial[page_nr].offset = loff;
		spd.partial[page_nr].len = this_len;
484
		len -= this_len;
485
		loff = 0;
486 487
		spd.nr_pages++;
		index++;
488 489
	}

490
	/*
491
	 * Release any pages at the end, if we quit early. 'page_nr' is how far
492 493 494
	 * we got, 'nr_pages' is how many pages are in the map.
	 */
	while (page_nr < nr_pages)
495
		page_cache_release(spd.pages[page_nr++]);
496
	in->f_ra.prev_pos = (loff_t)index << PAGE_CACHE_SHIFT;
497

498
	if (spd.nr_pages)
499
		error = splice_to_pipe(pipe, &spd);
500

501
	splice_shrink_spd(&spd);
502
	return error;
503 504
}

505 506 507
/**
 * generic_file_splice_read - splice data from file to a pipe
 * @in:		file to splice from
508
 * @ppos:	position in @in
509 510 511 512
 * @pipe:	pipe to splice to
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
513 514 515 516 517
 * Description:
 *    Will read pages from given file and fill them into a pipe. Can be
 *    used as long as the address_space operations for the source implements
 *    a readpage() hook.
 *
518
 */
519 520 521
ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
				 struct pipe_inode_info *pipe, size_t len,
				 unsigned int flags)
522
{
523
	loff_t isize, left;
524
	int ret;
525 526 527 528 529 530 531 532

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

	left = isize - *ppos;
	if (unlikely(left < len))
		len = left;
533

534
	ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
535
	if (ret > 0) {
536
		*ppos += ret;
537 538
		file_accessed(in);
	}
539 540 541

	return ret;
}
542 543
EXPORT_SYMBOL(generic_file_splice_read);

544 545 546 547 548 549 550 551
static const struct pipe_buf_operations default_pipe_buf_ops = {
	.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 已提交
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
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);

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
static ssize_t kernel_readv(struct file *file, const struct iovec *vec,
			    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() */
	res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos);
	set_fs(old_fs);

	return res;
}

584
ssize_t kernel_write(struct file *file, const char *buf, size_t count,
585
			    loff_t pos)
586 587 588 589 590 591 592
{
	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() */
593
	res = vfs_write(file, (__force const char __user *)buf, count, &pos);
594 595 596 597
	set_fs(old_fs);

	return res;
}
598
EXPORT_SYMBOL(kernel_write);
599

600 601 602 603 604 605 606
ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
				 struct pipe_inode_info *pipe, size_t len,
				 unsigned int flags)
{
	unsigned int nr_pages;
	unsigned int nr_freed;
	size_t offset;
607 608 609
	struct page *pages[PIPE_DEF_BUFFERS];
	struct partial_page partial[PIPE_DEF_BUFFERS];
	struct iovec *vec, __vec[PIPE_DEF_BUFFERS];
610 611 612 613 614 615 616
	ssize_t res;
	size_t this_len;
	int error;
	int i;
	struct splice_pipe_desc spd = {
		.pages = pages,
		.partial = partial,
617
		.nr_pages_max = PIPE_DEF_BUFFERS,
618 619 620 621 622
		.flags = flags,
		.ops = &default_pipe_buf_ops,
		.spd_release = spd_release_page,
	};

623 624 625 626 627
	if (splice_grow_spd(pipe, &spd))
		return -ENOMEM;

	res = -ENOMEM;
	vec = __vec;
628 629
	if (spd.nr_pages_max > PIPE_DEF_BUFFERS) {
		vec = kmalloc(spd.nr_pages_max * sizeof(struct iovec), GFP_KERNEL);
630 631 632 633
		if (!vec)
			goto shrink_ret;
	}

634 635 636
	offset = *ppos & ~PAGE_CACHE_MASK;
	nr_pages = (len + offset + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;

637
	for (i = 0; i < nr_pages && i < spd.nr_pages_max && len; i++) {
638 639
		struct page *page;

640
		page = alloc_page(GFP_USER);
641 642 643 644 645
		error = -ENOMEM;
		if (!page)
			goto err;

		this_len = min_t(size_t, len, PAGE_CACHE_SIZE - offset);
646
		vec[i].iov_base = (void __user *) page_address(page);
647
		vec[i].iov_len = this_len;
648
		spd.pages[i] = page;
649 650 651 652 653 654
		spd.nr_pages++;
		len -= this_len;
		offset = 0;
	}

	res = kernel_readv(in, vec, spd.nr_pages, *ppos);
A
Andrew Morton 已提交
655 656
	if (res < 0) {
		error = res;
657
		goto err;
A
Andrew Morton 已提交
658
	}
659 660 661 662 663 664 665 666

	error = 0;
	if (!res)
		goto err;

	nr_freed = 0;
	for (i = 0; i < spd.nr_pages; i++) {
		this_len = min_t(size_t, vec[i].iov_len, res);
667 668
		spd.partial[i].offset = 0;
		spd.partial[i].len = this_len;
669
		if (!this_len) {
670 671
			__free_page(spd.pages[i]);
			spd.pages[i] = NULL;
672 673 674 675 676 677 678 679 680 681
			nr_freed++;
		}
		res -= this_len;
	}
	spd.nr_pages -= nr_freed;

	res = splice_to_pipe(pipe, &spd);
	if (res > 0)
		*ppos += res;

682 683 684
shrink_ret:
	if (vec != __vec)
		kfree(vec);
685
	splice_shrink_spd(&spd);
686 687 688
	return res;

err:
689
	for (i = 0; i < spd.nr_pages; i++)
690
		__free_page(spd.pages[i]);
691

692 693
	res = error;
	goto shrink_ret;
694 695 696
}
EXPORT_SYMBOL(default_file_splice_read);

697
/*
698
 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
J
Jens Axboe 已提交
699
 * using sendpage(). Return the number of bytes sent.
700
 */
701
static int pipe_to_sendpage(struct pipe_inode_info *pipe,
702 703
			    struct pipe_buffer *buf, struct splice_desc *sd)
{
704
	struct file *file = sd->u.file;
705
	loff_t pos = sd->pos;
706
	int more;
707

A
Al Viro 已提交
708
	if (!likely(file->f_op->sendpage))
709 710
		return -EINVAL;

711
	more = (sd->flags & SPLICE_F_MORE) ? MSG_MORE : 0;
712 713

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

716 717
	return file->f_op->sendpage(file, buf->page, buf->offset,
				    sd->len, &pos, more);
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
}

/*
 * This is a little more tricky than the file -> pipe splicing. There are
 * basically three cases:
 *
 *	- Destination page already exists in the address space and there
 *	  are users of it. For that case we have no other option that
 *	  copying the data. Tough luck.
 *	- Destination page already exists in the address space, but there
 *	  are no users of it. Make sure it's uptodate, then drop it. Fall
 *	  through to last case.
 *	- Destination page does not exist, we can add the pipe page to
 *	  the page cache and avoid the copy.
 *
733 734 735 736 737 738
 * If asked to move pages to the output file (SPLICE_F_MOVE is set in
 * sd->flags), we attempt to migrate pages from the pipe to the output
 * file address space page cache. This is possible if no one else has
 * the pipe page referenced outside of the pipe and page cache. If
 * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create
 * a new page in the output file page cache and fill/dirty that.
739
 */
740 741
int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
		 struct splice_desc *sd)
742
{
743
	struct file *file = sd->u.file;
744
	struct address_space *mapping = file->f_mapping;
J
Jens Axboe 已提交
745
	unsigned int offset, this_len;
746
	struct page *page;
747
	void *fsdata;
748
	int ret;
749 750 751

	offset = sd->pos & ~PAGE_CACHE_MASK;

J
Jens Axboe 已提交
752 753 754 755
	this_len = sd->len;
	if (this_len + offset > PAGE_CACHE_SIZE)
		this_len = PAGE_CACHE_SIZE - offset;

756 757 758 759
	ret = pagecache_write_begin(file, mapping, sd->pos, this_len,
				AOP_FLAG_UNINTERRUPTIBLE, &page, &fsdata);
	if (unlikely(ret))
		goto out;
760

761
	if (buf->page != page) {
A
Al Viro 已提交
762
		char *src = kmap_atomic(buf->page);
763
		char *dst = kmap_atomic(page);
764

J
Jens Axboe 已提交
765
		memcpy(dst + offset, src + buf->offset, this_len);
766
		flush_dcache_page(page);
767
		kunmap_atomic(dst);
A
Al Viro 已提交
768
		kunmap_atomic(src);
769
	}
770 771
	ret = pagecache_write_end(file, mapping, sd->pos, this_len, this_len,
				page, fsdata);
772 773 774
out:
	return ret;
}
775
EXPORT_SYMBOL(pipe_to_file);
776

777 778 779 780 781 782 783 784
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);
}

785
/**
786
 * splice_from_pipe_feed - feed available data from a pipe to a file
787 788 789 790 791
 * @pipe:	pipe to splice from
 * @sd:		information to @actor
 * @actor:	handler that splices the data
 *
 * Description:
792 793 794 795 796 797 798
 *    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.
799
 *
800 801 802 803
 *    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.
804
 */
805 806
int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
			  splice_actor *actor)
807
{
808
	int ret;
809

810 811 812
	while (pipe->nrbufs) {
		struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
		const struct pipe_buf_operations *ops = buf->ops;
813

814 815 816
		sd->len = buf->len;
		if (sd->len > sd->total_len)
			sd->len = sd->total_len;
817

818 819
		ret = buf->ops->confirm(pipe, buf);
		if (unlikely(ret)) {
820 821 822 823
			if (ret == -ENODATA)
				ret = 0;
			return ret;
		}
824 825 826 827 828

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

829 830 831 832 833 834 835 836 837 838 839
		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);
840
			pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
841
			pipe->nrbufs--;
A
Al Viro 已提交
842
			if (pipe->files)
843 844
				sd->need_wakeup = true;
		}
845

846 847 848
		if (!sd->total_len)
			return 0;
	}
849

850 851 852
	return 1;
}
EXPORT_SYMBOL(splice_from_pipe_feed);
853

854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
/**
 * 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.
 */
int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
{
	while (!pipe->nrbufs) {
		if (!pipe->writers)
			return 0;
J
Jens Axboe 已提交
869

870 871
		if (!pipe->waiting_writers && sd->num_spliced)
			return 0;
I
Ingo Molnar 已提交
872

873 874
		if (sd->flags & SPLICE_F_NONBLOCK)
			return -EAGAIN;
875

876 877
		if (signal_pending(current))
			return -ERESTARTSYS;
878

879 880 881
		if (sd->need_wakeup) {
			wakeup_pipe_writers(pipe);
			sd->need_wakeup = false;
882 883
		}

884 885
		pipe_wait(pipe);
	}
886

887 888 889
	return 1;
}
EXPORT_SYMBOL(splice_from_pipe_next);
890

891 892
/**
 * splice_from_pipe_begin - start splicing from pipe
893
 * @sd:		information about the splice operation
894 895 896 897 898 899 900 901 902 903 904 905
 *
 * 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.
 */
void splice_from_pipe_begin(struct splice_desc *sd)
{
	sd->num_spliced = 0;
	sd->need_wakeup = false;
}
EXPORT_SYMBOL(splice_from_pipe_begin);
906

907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
/**
 * 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().
 */
void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
{
	if (sd->need_wakeup)
		wakeup_pipe_writers(pipe);
}
EXPORT_SYMBOL(splice_from_pipe_end);
923

924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
/**
 * __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;
941

942 943 944 945 946 947 948 949 950
	splice_from_pipe_begin(sd);
	do {
		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;
951
}
M
Mark Fasheh 已提交
952
EXPORT_SYMBOL(__splice_from_pipe);
953

954 955 956 957 958 959 960 961 962 963
/**
 * 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:
964
 *    See __splice_from_pipe. This function locks the pipe inode,
965 966 967
 *    otherwise it's identical to __splice_from_pipe().
 *
 */
968 969 970 971 972
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 已提交
973 974 975 976
	struct splice_desc sd = {
		.total_len = len,
		.flags = flags,
		.pos = *ppos,
977
		.u.file = out,
J
Jens Axboe 已提交
978
	};
979

980
	pipe_lock(pipe);
J
Jens Axboe 已提交
981
	ret = __splice_from_pipe(pipe, &sd, actor);
982
	pipe_unlock(pipe);
983 984 985 986

	return ret;
}

987 988
/**
 * generic_file_splice_write - splice data from a pipe to a file
989
 * @pipe:	pipe info
990
 * @out:	file to write to
991
 * @ppos:	position in @out
992 993 994
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
995 996 997
 * Description:
 *    Will either move or copy pages (determined by @flags options) from
 *    the given pipe inode to the given file.
998 999
 *
 */
1000 1001
ssize_t
generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
1002
			  loff_t *ppos, size_t len, unsigned int flags)
1003
{
1004
	struct address_space *mapping = out->f_mapping;
1005
	struct inode *inode = mapping->host;
1006 1007 1008 1009 1010 1011
	struct splice_desc sd = {
		.total_len = len,
		.flags = flags,
		.pos = *ppos,
		.u.file = out,
	};
1012 1013
	ssize_t ret;

1014
	pipe_lock(pipe);
1015 1016 1017 1018 1019 1020 1021 1022 1023

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

		mutex_lock_nested(&inode->i_mutex, I_MUTEX_CHILD);
		ret = file_remove_suid(out);
1024
		if (!ret) {
1025 1026 1027 1028
			ret = file_update_time(out);
			if (!ret)
				ret = splice_from_pipe_feed(pipe, &sd,
							    pipe_to_file);
1029
		}
1030 1031 1032 1033
		mutex_unlock(&inode->i_mutex);
	} while (ret > 0);
	splice_from_pipe_end(pipe, &sd);

1034
	pipe_unlock(pipe);
1035 1036 1037 1038

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

J
Jens Axboe 已提交
1039
	if (ret > 0) {
1040
		int err;
1041

1042 1043 1044 1045 1046
		err = generic_write_sync(out, *ppos, ret);
		if (err)
			ret = err;
		else
			*ppos += ret;
1047
		balance_dirty_pages_ratelimited(mapping);
1048 1049 1050
	}

	return ret;
1051 1052
}

1053 1054
EXPORT_SYMBOL(generic_file_splice_write);

1055 1056
static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
			  struct splice_desc *sd)
1057
{
1058 1059
	int ret;
	void *data;
1060
	loff_t tmp = sd->pos;
1061

A
Al Viro 已提交
1062
	data = kmap(buf->page);
1063
	ret = __kernel_write(sd->u.file, data + buf->offset, sd->len, &tmp);
A
Al Viro 已提交
1064
	kunmap(buf->page);
1065 1066

	return ret;
1067 1068 1069 1070 1071 1072
}

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

1075 1076 1077
	ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
	if (ret > 0)
		*ppos += ret;
1078

1079
	return ret;
1080 1081
}

1082 1083
/**
 * generic_splice_sendpage - splice data from a pipe to a socket
1084
 * @pipe:	pipe to splice from
1085
 * @out:	socket to write to
1086
 * @ppos:	position in @out
1087 1088 1089
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
1090 1091 1092
 * Description:
 *    Will send @len bytes from the pipe to a network socket. No data copying
 *    is involved.
1093 1094
 *
 */
1095
ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
1096
				loff_t *ppos, size_t len, unsigned int flags)
1097
{
1098
	return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
1099 1100
}

1101
EXPORT_SYMBOL(generic_splice_sendpage);
J
Jeff Garzik 已提交
1102

1103 1104 1105
/*
 * Attempt to initiate a splice from pipe to file.
 */
1106
static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
1107
			   loff_t *ppos, size_t len, unsigned int flags)
1108
{
1109 1110
	ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
				loff_t *, size_t, unsigned int);
1111

A
Al Viro 已提交
1112
	if (out->f_op->splice_write)
1113 1114
		splice_write = out->f_op->splice_write;
	else
1115 1116
		splice_write = default_file_splice_write;

1117
	return splice_write(pipe, out, ppos, len, flags);
1118 1119
}

1120 1121 1122
/*
 * Attempt to initiate a splice from a file to a pipe.
 */
1123 1124 1125
static long do_splice_to(struct file *in, loff_t *ppos,
			 struct pipe_inode_info *pipe, size_t len,
			 unsigned int flags)
1126
{
1127 1128
	ssize_t (*splice_read)(struct file *, loff_t *,
			       struct pipe_inode_info *, size_t, unsigned int);
1129 1130
	int ret;

1131
	if (unlikely(!(in->f_mode & FMODE_READ)))
1132 1133
		return -EBADF;

1134
	ret = rw_verify_area(READ, in, ppos, len);
1135 1136 1137
	if (unlikely(ret < 0))
		return ret;

A
Al Viro 已提交
1138
	if (in->f_op->splice_read)
1139 1140
		splice_read = in->f_op->splice_read;
	else
1141 1142 1143
		splice_read = default_file_splice_read;

	return splice_read(in, ppos, pipe, len, flags);
1144 1145
}

1146 1147 1148 1149 1150 1151 1152 1153 1154
/**
 * 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 已提交
1155
 *    pipe is cached in the process, and reused during the lifetime of
1156 1157
 *    that process.
 *
J
Jens Axboe 已提交
1158 1159 1160
 */
ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
			       splice_direct_actor *actor)
1161 1162 1163 1164
{
	struct pipe_inode_info *pipe;
	long ret, bytes;
	umode_t i_mode;
J
Jens Axboe 已提交
1165 1166
	size_t len;
	int i, flags;
1167 1168 1169 1170 1171 1172

	/*
	 * 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 已提交
1173
	i_mode = file_inode(in)->i_mode;
1174 1175 1176 1177 1178 1179 1180 1181
	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;
1182
	if (unlikely(!pipe)) {
A
Al Viro 已提交
1183
		pipe = alloc_pipe_info();
1184 1185 1186 1187 1188
		if (!pipe)
			return -ENOMEM;

		/*
		 * We don't have an immediate reader, but we'll read the stuff
1189
		 * out of the pipe right after the splice_to_pipe(). So set
1190 1191 1192 1193 1194 1195 1196 1197
		 * PIPE_READERS appropriately.
		 */
		pipe->readers = 1;

		current->splice_pipe = pipe;
	}

	/*
I
Ingo Molnar 已提交
1198
	 * Do the splice.
1199 1200 1201
	 */
	ret = 0;
	bytes = 0;
J
Jens Axboe 已提交
1202 1203 1204 1205 1206 1207 1208
	len = sd->total_len;
	flags = sd->flags;

	/*
	 * Don't block on output, we have to drain the direct pipe.
	 */
	sd->flags &= ~SPLICE_F_NONBLOCK;
1209 1210

	while (len) {
1211
		size_t read_len;
1212
		loff_t pos = sd->pos, prev_pos = pos;
1213

1214
		ret = do_splice_to(in, &pos, pipe, len, flags);
1215
		if (unlikely(ret <= 0))
1216 1217 1218
			goto out_release;

		read_len = ret;
J
Jens Axboe 已提交
1219
		sd->total_len = read_len;
1220 1221 1222 1223 1224 1225

		/*
		 * 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 已提交
1226
		ret = actor(pipe, sd);
1227 1228
		if (unlikely(ret <= 0)) {
			sd->pos = prev_pos;
1229
			goto out_release;
1230
		}
1231 1232 1233

		bytes += ret;
		len -= ret;
1234
		sd->pos = pos;
1235

1236 1237
		if (ret < read_len) {
			sd->pos = prev_pos + ret;
1238
			goto out_release;
1239
		}
1240 1241
	}

1242
done:
1243
	pipe->nrbufs = pipe->curbuf = 0;
1244
	file_accessed(in);
1245 1246 1247 1248 1249 1250 1251
	return bytes;

out_release:
	/*
	 * If we did an incomplete transfer we must release
	 * the pipe buffers in question:
	 */
1252
	for (i = 0; i < pipe->buffers; i++) {
1253 1254 1255 1256 1257 1258 1259 1260
		struct pipe_buffer *buf = pipe->bufs + i;

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

1261 1262
	if (!bytes)
		bytes = ret;
J
Jens Axboe 已提交
1263

1264
	goto done;
J
Jens Axboe 已提交
1265 1266 1267 1268 1269 1270
}
EXPORT_SYMBOL(splice_direct_to_actor);

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

1273
	return do_splice_from(pipe, file, sd->opos, sd->total_len,
1274
			      sd->flags);
J
Jens Axboe 已提交
1275 1276
}

1277 1278 1279 1280 1281
/**
 * do_splice_direct - splices data directly between two files
 * @in:		file to splice from
 * @ppos:	input file offset
 * @out:	file to splice to
1282
 * @opos:	output file offset
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
 * @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 已提交
1293
long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
1294
		      loff_t *opos, size_t len, unsigned int flags)
J
Jens Axboe 已提交
1295 1296 1297 1298 1299 1300
{
	struct splice_desc sd = {
		.len		= len,
		.total_len	= len,
		.flags		= flags,
		.pos		= *ppos,
1301
		.u.file		= out,
1302
		.opos		= opos,
J
Jens Axboe 已提交
1303
	};
1304
	long ret;
J
Jens Axboe 已提交
1305

1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
	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 已提交
1316
	ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
1317
	if (ret > 0)
1318
		*ppos = sd.pos;
1319

J
Jens Axboe 已提交
1320
	return ret;
1321 1322
}

1323 1324 1325
static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
			       struct pipe_inode_info *opipe,
			       size_t len, unsigned int flags);
1326

1327 1328 1329
/*
 * Determine where to splice to/from.
 */
1330 1331 1332
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)
1333
{
1334 1335
	struct pipe_inode_info *ipipe;
	struct pipe_inode_info *opipe;
1336
	loff_t offset;
J
Jens Axboe 已提交
1337
	long ret;
1338

1339 1340
	ipipe = get_pipe_info(in);
	opipe = get_pipe_info(out);
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359

	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) {
1360 1361
		if (off_in)
			return -ESPIPE;
1362
		if (off_out) {
1363
			if (!(out->f_mode & FMODE_PWRITE))
1364
				return -EINVAL;
1365
			if (copy_from_user(&offset, off_out, sizeof(loff_t)))
1366
				return -EFAULT;
1367 1368 1369
		} else {
			offset = out->f_pos;
		}
1370

1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
		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;

1381
		file_start_write(out);
1382
		ret = do_splice_from(ipipe, out, &offset, len, flags);
1383
		file_end_write(out);
J
Jens Axboe 已提交
1384

1385 1386 1387
		if (!off_out)
			out->f_pos = offset;
		else if (copy_to_user(off_out, &offset, sizeof(loff_t)))
J
Jens Axboe 已提交
1388 1389 1390
			ret = -EFAULT;

		return ret;
1391
	}
1392

1393
	if (opipe) {
1394 1395
		if (off_out)
			return -ESPIPE;
1396
		if (off_in) {
1397
			if (!(in->f_mode & FMODE_PREAD))
1398
				return -EINVAL;
1399
			if (copy_from_user(&offset, off_in, sizeof(loff_t)))
1400
				return -EFAULT;
1401 1402 1403
		} else {
			offset = in->f_pos;
		}
1404

1405
		ret = do_splice_to(in, &offset, opipe, len, flags);
J
Jens Axboe 已提交
1406

1407 1408 1409
		if (!off_in)
			in->f_pos = offset;
		else if (copy_to_user(off_in, &offset, sizeof(loff_t)))
J
Jens Axboe 已提交
1410 1411 1412
			ret = -EFAULT;

		return ret;
1413
	}
1414 1415 1416 1417

	return -EINVAL;
}

1418 1419 1420 1421 1422 1423 1424 1425 1426
/*
 * Map an iov into an array of pages and offset/length tupples. With the
 * partial_page structure, we can map several non-contiguous ranges into
 * our ones pages[] map instead of splitting that operation into pieces.
 * Could easily be exported as a generic helper for other users, in which
 * case one would probably want to add a 'max_nr_pages' parameter as well.
 */
static int get_iovec_page_array(const struct iovec __user *iov,
				unsigned int nr_vecs, struct page **pages,
1427
				struct partial_page *partial, bool aligned,
1428
				unsigned int pipe_buffers)
1429 1430 1431 1432 1433
{
	int buffers = 0, error = 0;

	while (nr_vecs) {
		unsigned long off, npages;
1434
		struct iovec entry;
1435 1436 1437 1438
		void __user *base;
		size_t len;
		int i;

1439
		error = -EFAULT;
N
Nick Piggin 已提交
1440
		if (copy_from_user(&entry, iov, sizeof(entry)))
1441 1442
			break;

1443 1444 1445
		base = entry.iov_base;
		len = entry.iov_len;

1446 1447 1448
		/*
		 * Sanity check this iovec. 0 read succeeds.
		 */
1449
		error = 0;
1450 1451 1452
		if (unlikely(!len))
			break;
		error = -EFAULT;
1453
		if (!access_ok(VERIFY_READ, base, len))
1454 1455 1456 1457 1458 1459 1460
			break;

		/*
		 * Get this base offset and number of pages, then map
		 * in the user pages.
		 */
		off = (unsigned long) base & ~PAGE_MASK;
1461 1462 1463 1464 1465 1466 1467 1468 1469

		/*
		 * If asked for alignment, the offset must be zero and the
		 * length a multiple of the PAGE_SIZE.
		 */
		error = -EINVAL;
		if (aligned && (off || len & ~PAGE_MASK))
			break;

1470
		npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1471 1472
		if (npages > pipe_buffers - buffers)
			npages = pipe_buffers - buffers;
1473

N
Nick Piggin 已提交
1474 1475
		error = get_user_pages_fast((unsigned long)base, npages,
					0, &pages[buffers]);
1476 1477 1478 1479 1480 1481 1482 1483

		if (unlikely(error <= 0))
			break;

		/*
		 * Fill this contiguous range into the partial page map.
		 */
		for (i = 0; i < error; i++) {
1484
			const int plen = min_t(size_t, len, PAGE_SIZE - off);
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506

			partial[buffers].offset = off;
			partial[buffers].len = plen;

			off = 0;
			len -= plen;
			buffers++;
		}

		/*
		 * We didn't complete this iov, stop here since it probably
		 * means we have to move some of this into a pipe to
		 * be able to continue.
		 */
		if (len)
			break;

		/*
		 * Don't continue if we mapped fewer pages than we asked for,
		 * or if we mapped the max number of pages that we have
		 * room for.
		 */
1507
		if (error < npages || buffers == pipe_buffers)
1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
			break;

		nr_vecs--;
		iov++;
	}

	if (buffers)
		return buffers;

	return error;
}

1520 1521 1522
static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
			struct splice_desc *sd)
{
1523 1524
	int n = copy_page_to_iter(buf->page, buf->offset, sd->len, sd->u.data);
	return n == sd->len ? n : -EFAULT;
1525 1526 1527 1528 1529 1530
}

/*
 * For lack of a better implementation, implement vmsplice() to userspace
 * as a simple copy of the pipes pages to the user iov.
 */
1531
static long vmsplice_to_user(struct file *file, const struct iovec __user *uiov,
1532 1533 1534 1535 1536
			     unsigned long nr_segs, unsigned int flags)
{
	struct pipe_inode_info *pipe;
	struct splice_desc sd;
	long ret;
1537 1538 1539
	struct iovec iovstack[UIO_FASTIOV];
	struct iovec *iov = iovstack;
	struct iov_iter iter;
M
Miklos Szeredi 已提交
1540
	ssize_t count;
1541

1542
	pipe = get_pipe_info(file);
1543 1544 1545
	if (!pipe)
		return -EBADF;

1546 1547 1548
	ret = rw_copy_check_uvector(READ, uiov, nr_segs,
				    ARRAY_SIZE(iovstack), iovstack, &iov);
	if (ret <= 0)
M
Miklos Szeredi 已提交
1549
		goto out;
1550

M
Miklos Szeredi 已提交
1551
	count = ret;
1552
	iov_iter_init(&iter, iov, nr_segs, count, 0);
1553

1554 1555 1556 1557 1558
	sd.len = 0;
	sd.total_len = count;
	sd.flags = flags;
	sd.u.data = &iter;
	sd.pos = 0;
1559

1560 1561
	pipe_lock(pipe);
	ret = __splice_from_pipe(pipe, &sd, pipe_to_user);
1562
	pipe_unlock(pipe);
1563

M
Miklos Szeredi 已提交
1564
out:
1565 1566
	if (iov != iovstack)
		kfree(iov);
1567 1568 1569 1570

	return ret;
}

1571 1572 1573 1574 1575
/*
 * 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.
 */
1576 1577
static long vmsplice_to_pipe(struct file *file, const struct iovec __user *iov,
			     unsigned long nr_segs, unsigned int flags)
1578
{
1579
	struct pipe_inode_info *pipe;
1580 1581
	struct page *pages[PIPE_DEF_BUFFERS];
	struct partial_page partial[PIPE_DEF_BUFFERS];
1582 1583 1584
	struct splice_pipe_desc spd = {
		.pages = pages,
		.partial = partial,
1585
		.nr_pages_max = PIPE_DEF_BUFFERS,
1586 1587
		.flags = flags,
		.ops = &user_page_pipe_buf_ops,
1588
		.spd_release = spd_release_page,
1589
	};
1590
	long ret;
1591

1592
	pipe = get_pipe_info(file);
1593
	if (!pipe)
1594 1595
		return -EBADF;

1596 1597 1598 1599
	if (splice_grow_spd(pipe, &spd))
		return -ENOMEM;

	spd.nr_pages = get_iovec_page_array(iov, nr_segs, spd.pages,
1600
					    spd.partial, false,
1601
					    spd.nr_pages_max);
1602
	if (spd.nr_pages <= 0)
1603 1604 1605
		ret = spd.nr_pages;
	else
		ret = splice_to_pipe(pipe, &spd);
1606

1607
	splice_shrink_spd(&spd);
1608
	return ret;
1609 1610
}

1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
/*
 * 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().
 *
 */
1627 1628
SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
		unsigned long, nr_segs, unsigned int, flags)
1629
{
1630
	struct fd f;
1631 1632
	long error;

1633 1634 1635 1636 1637
	if (unlikely(nr_segs > UIO_MAXIOV))
		return -EINVAL;
	else if (unlikely(!nr_segs))
		return 0;

1638
	error = -EBADF;
1639 1640 1641 1642 1643 1644 1645 1646
	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);
1647 1648 1649 1650 1651
	}

	return error;
}

1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672
#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

1673 1674 1675
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)
1676
{
1677
	struct fd in, out;
1678 1679 1680 1681 1682 1683
	long error;

	if (unlikely(!len))
		return 0;

	error = -EBADF;
1684 1685 1686 1687 1688 1689 1690 1691
	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,
1692
							  len, flags);
1693
				fdput(out);
1694 1695
			}
		}
1696
		fdput(in);
1697 1698 1699
	}
	return error;
}
1700

1701 1702 1703 1704
/*
 * Make sure there's data to read. Wait for input if we can, otherwise
 * return an appropriate error.
 */
1705
static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
{
	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;
1717
	pipe_lock(pipe);
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734

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

1735
	pipe_unlock(pipe);
1736 1737 1738 1739 1740 1741 1742
	return ret;
}

/*
 * Make sure there's writeable room. Wait for room if we can, otherwise
 * return an appropriate error.
 */
1743
static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1744 1745 1746 1747 1748 1749 1750
{
	int ret;

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

	ret = 0;
1755
	pipe_lock(pipe);
1756

1757
	while (pipe->nrbufs >= pipe->buffers) {
1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775
		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--;
	}

1776
	pipe_unlock(pipe);
1777 1778 1779
	return ret;
}

1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822
/*
 * 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.
		 */
1823
		if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843
			/* 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;
1844
		nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1845 1846 1847 1848 1849 1850 1851 1852 1853
		obuf = opipe->bufs + nbuf;

		if (len >= ibuf->len) {
			/*
			 * Simply move the whole buffer from ipipe to opipe
			 */
			*obuf = *ibuf;
			ibuf->ops = NULL;
			opipe->nrbufs++;
1854
			ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885
			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 已提交
1886 1887 1888
	if (ret > 0)
		wakeup_pipe_readers(opipe);

1889 1890 1891 1892 1893 1894
	if (input_wakeup)
		wakeup_pipe_writers(ipipe);

	return ret;
}

1895 1896 1897 1898 1899 1900 1901 1902
/*
 * 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;
1903
	int ret = 0, i = 0, nbuf;
1904 1905 1906

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

1912
	do {
1913 1914 1915 1916 1917 1918 1919
		if (!opipe->readers) {
			send_sig(SIGPIPE, current, 0);
			if (!ret)
				ret = -EPIPE;
			break;
		}

1920 1921 1922 1923
		/*
		 * If we have iterated all input buffers or ran out of
		 * output room, break.
		 */
1924
		if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
1925
			break;
1926

1927 1928
		ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
		nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
1929 1930

		/*
1931 1932
		 * Get a reference to this pipe buffer,
		 * so we can copy the contents over.
1933
		 */
1934 1935 1936 1937 1938
		ibuf->ops->get(ipipe, ibuf);

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

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

1945 1946
		if (obuf->len > len)
			obuf->len = len;
1947

1948 1949 1950 1951 1952
		opipe->nrbufs++;
		ret += obuf->len;
		len -= obuf->len;
		i++;
	} while (len);
1953

1954 1955 1956 1957 1958 1959 1960
	/*
	 * 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;

1961 1962
	pipe_unlock(ipipe);
	pipe_unlock(opipe);
1963

1964 1965 1966
	/*
	 * If we put data in the output pipe, wakeup any potential readers.
	 */
N
Namhyung Kim 已提交
1967 1968
	if (ret > 0)
		wakeup_pipe_readers(opipe);
1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981

	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)
{
1982 1983
	struct pipe_inode_info *ipipe = get_pipe_info(in);
	struct pipe_inode_info *opipe = get_pipe_info(out);
1984
	int ret = -EINVAL;
1985 1986

	/*
1987 1988
	 * Duplicate the contents of ipipe to opipe without actually
	 * copying the data.
1989
	 */
1990 1991 1992 1993 1994
	if (ipipe && opipe && ipipe != opipe) {
		/*
		 * Keep going, unless we encounter an error. The ipipe/opipe
		 * ordering doesn't really matter.
		 */
1995
		ret = ipipe_prep(ipipe, flags);
1996
		if (!ret) {
1997
			ret = opipe_prep(opipe, flags);
1998
			if (!ret)
1999 2000 2001
				ret = link_pipe(ipipe, opipe, len, flags);
		}
	}
2002

2003
	return ret;
2004 2005
}

2006
SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
2007
{
2008 2009
	struct fd in;
	int error;
2010 2011 2012 2013 2014

	if (unlikely(!len))
		return 0;

	error = -EBADF;
2015 2016 2017 2018 2019 2020 2021 2022 2023
	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);
2024 2025
			}
		}
2026
 		fdput(in);
2027 2028 2029 2030
 	}

	return error;
}