splice.c 26.3 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 16 17
 * Copyright (C) 2005-2006 Jens Axboe <axboe@suse.de>
 * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
 * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
18 19 20 21 22 23 24
 *
 */
#include <linux/fs.h>
#include <linux/file.h>
#include <linux/pagemap.h>
#include <linux/pipe_fs_i.h>
#include <linux/mm_inline.h>
25
#include <linux/swap.h>
26 27
#include <linux/writeback.h>
#include <linux/buffer_head.h>
J
Jeff Garzik 已提交
28
#include <linux/module.h>
29
#include <linux/syscalls.h>
30 31 32 33 34 35 36 37 38 39 40

/*
 * Passed to the actors
 */
struct splice_desc {
	unsigned int len, total_len;	/* current and remaining length */
	unsigned int flags;		/* splice flags */
	struct file *file;		/* file to read/write */
	loff_t pos;			/* file position */
};

41 42 43 44 45 46
/*
 * 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.
 */
47 48 49 50
static int page_cache_pipe_buf_steal(struct pipe_inode_info *info,
				     struct pipe_buffer *buf)
{
	struct page *page = buf->page;
51
	struct address_space *mapping = page_mapping(page);
52 53 54 55

	WARN_ON(!PageLocked(page));
	WARN_ON(!PageUptodate(page));

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

65 66 67 68
	if (PagePrivate(page))
		try_to_release_page(page, mapping_gfp_mask(mapping));

	if (!remove_mapping(mapping, page))
69 70
		return 1;

71
	buf->flags |= PIPE_BUF_FLAG_STOLEN | PIPE_BUF_FLAG_LRU;
72 73 74
	return 0;
}

75 76 77 78 79
static void page_cache_pipe_buf_release(struct pipe_inode_info *info,
					struct pipe_buffer *buf)
{
	page_cache_release(buf->page);
	buf->page = NULL;
80
	buf->flags &= ~(PIPE_BUF_FLAG_STOLEN | PIPE_BUF_FLAG_LRU);
81 82 83 84 85 86 87
}

static void *page_cache_pipe_buf_map(struct file *file,
				     struct pipe_inode_info *info,
				     struct pipe_buffer *buf)
{
	struct page *page = buf->page;
88
	int err;
89 90

	if (!PageUptodate(page)) {
91 92 93 94
		lock_page(page);

		/*
		 * Page got truncated/unhashed. This will cause a 0-byte
I
Ingo Molnar 已提交
95
		 * splice, if this is the first page.
96 97 98 99 100
		 */
		if (!page->mapping) {
			err = -ENODATA;
			goto error;
		}
101

102
		/*
I
Ingo Molnar 已提交
103
		 * Uh oh, read-error from disk.
104 105 106 107 108 109 110
		 */
		if (!PageUptodate(page)) {
			err = -EIO;
			goto error;
		}

		/*
I
Ingo Molnar 已提交
111
		 * Page is ok afterall, fall through to mapping.
112
		 */
113 114 115
		unlock_page(page);
	}

116 117 118 119
	return kmap(page);
error:
	unlock_page(page);
	return ERR_PTR(err);
120 121 122 123 124 125 126 127
}

static void page_cache_pipe_buf_unmap(struct pipe_inode_info *info,
				      struct pipe_buffer *buf)
{
	kunmap(buf->page);
}

128 129 130 131 132 133
static void page_cache_pipe_buf_get(struct pipe_inode_info *info,
				    struct pipe_buffer *buf)
{
	page_cache_get(buf->page);
}

134 135 136 137 138
static struct pipe_buf_operations page_cache_pipe_buf_ops = {
	.can_merge = 0,
	.map = page_cache_pipe_buf_map,
	.unmap = page_cache_pipe_buf_unmap,
	.release = page_cache_pipe_buf_release,
139
	.steal = page_cache_pipe_buf_steal,
140
	.get = page_cache_pipe_buf_get,
141 142
};

143 144 145 146
/*
 * Pipe output worker. This sets up our pipe format with the page cache
 * pipe buffer operations. Otherwise very similar to the regular pipe_writev().
 */
147
static ssize_t move_to_pipe(struct pipe_inode_info *pipe, struct page **pages,
148 149
			    int nr_pages, unsigned long len,
			    unsigned int offset, unsigned int flags)
150 151 152 153 154 155 156
{
	int ret, do_wakeup, i;

	ret = 0;
	do_wakeup = 0;
	i = 0;

157 158
	if (pipe->inode)
		mutex_lock(&pipe->inode->i_mutex);
159 160

	for (;;) {
161
		if (!pipe->readers) {
162 163 164 165 166 167
			send_sig(SIGPIPE, current, 0);
			if (!ret)
				ret = -EPIPE;
			break;
		}

168 169
		if (pipe->nrbufs < PIPE_BUFFERS) {
			int newbuf = (pipe->curbuf + pipe->nrbufs) & (PIPE_BUFFERS - 1);
170
			struct pipe_buffer *buf = pipe->bufs + newbuf;
171 172 173 174 175 176 177 178 179 180 181
			struct page *page = pages[i++];
			unsigned long this_len;

			this_len = PAGE_CACHE_SIZE - offset;
			if (this_len > len)
				this_len = len;

			buf->page = page;
			buf->offset = offset;
			buf->len = this_len;
			buf->ops = &page_cache_pipe_buf_ops;
182 183 184
			pipe->nrbufs++;
			if (pipe->inode)
				do_wakeup = 1;
185 186 187 188 189 190 191 192

			ret += this_len;
			len -= this_len;
			offset = 0;
			if (!--nr_pages)
				break;
			if (!len)
				break;
193
			if (pipe->nrbufs < PIPE_BUFFERS)
194 195 196 197 198
				continue;

			break;
		}

199 200 201 202 203 204
		if (flags & SPLICE_F_NONBLOCK) {
			if (!ret)
				ret = -EAGAIN;
			break;
		}

205 206 207 208 209 210 211
		if (signal_pending(current)) {
			if (!ret)
				ret = -ERESTARTSYS;
			break;
		}

		if (do_wakeup) {
212
			smp_mb();
213 214 215
			if (waitqueue_active(&pipe->wait))
				wake_up_interruptible_sync(&pipe->wait);
			kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
216 217 218
			do_wakeup = 0;
		}

219 220 221
		pipe->waiting_writers++;
		pipe_wait(pipe);
		pipe->waiting_writers--;
222 223
	}

224 225
	if (pipe->inode)
		mutex_unlock(&pipe->inode->i_mutex);
226 227

	if (do_wakeup) {
228
		smp_mb();
229 230 231
		if (waitqueue_active(&pipe->wait))
			wake_up_interruptible(&pipe->wait);
		kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
232 233 234 235 236 237 238 239
	}

	while (i < nr_pages)
		page_cache_release(pages[i++]);

	return ret;
}

240
static int
241 242 243
__generic_file_splice_read(struct file *in, loff_t *ppos,
			   struct pipe_inode_info *pipe, size_t len,
			   unsigned int flags)
244 245
{
	struct address_space *mapping = in->f_mapping;
246
	unsigned int loff, offset, nr_pages;
247
	struct page *pages[PIPE_BUFFERS];
248
	struct page *page;
249 250 251
	pgoff_t index, end_index;
	loff_t isize;
	size_t bytes;
252
	int i, error;
253

254
	index = *ppos >> PAGE_CACHE_SHIFT;
255
	loff = offset = *ppos & ~PAGE_CACHE_MASK;
256 257 258 259 260 261
	nr_pages = (len + offset + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;

	if (nr_pages > PIPE_BUFFERS)
		nr_pages = PIPE_BUFFERS;

	/*
I
Ingo Molnar 已提交
262
	 * Initiate read-ahead on this page range. however, don't call into
263 264
	 * read-ahead if this is a non-zero offset (we are likely doing small
	 * chunk splice and the page is already there) for a single page.
265
	 */
266 267
	if (!offset || nr_pages > 1)
		do_page_cache_readahead(mapping, in, index, nr_pages);
268 269

	/*
I
Ingo Molnar 已提交
270
	 * Now fill in the holes:
271
	 */
272
	error = 0;
273
	bytes = 0;
274
	for (i = 0; i < nr_pages; i++, index++) {
275
find_page:
276
		/*
277
		 * lookup the page for this index
278
		 */
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
		page = find_get_page(mapping, index);
		if (!page) {
			/*
			 * If in nonblock mode then dont block on
			 * readpage (we've kicked readahead so there
			 * will be asynchronous progress):
			 */
			if (flags & SPLICE_F_NONBLOCK)
				break;

			/*
			 * page didn't exist, allocate one
			 */
			page = page_cache_alloc_cold(mapping);
			if (!page)
				break;

			error = add_to_page_cache_lru(page, mapping, index,
						mapping_gfp_mask(mapping));
			if (unlikely(error)) {
				page_cache_release(page);
				break;
			}

			goto readpage;
		}

		/*
		 * If the page isn't uptodate, we may need to start io on it
		 */
		if (!PageUptodate(page)) {
			lock_page(page);

			/*
			 * page was truncated, stop here. if this isn't the
			 * first page, we'll just complete what we already
			 * added
			 */
			if (!page->mapping) {
				unlock_page(page);
				page_cache_release(page);
				break;
			}
			/*
			 * page was already under io and is now done, great
			 */
			if (PageUptodate(page)) {
				unlock_page(page);
				goto fill_it;
			}
329

330 331 332 333 334
readpage:
			/*
			 * need to read in the page
			 */
			error = mapping->a_ops->readpage(in, page);
335 336 337

			if (unlikely(error)) {
				page_cache_release(page);
338 339
				if (error == AOP_TRUNCATED_PAGE)
					goto find_page;
340 341
				break;
			}
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367

			/*
			 * i_size must be checked after ->readpage().
			 */
			isize = i_size_read(mapping->host);
			end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
			if (unlikely(!isize || index > end_index)) {
				page_cache_release(page);
				break;
			}

			/*
			 * if this is the last page, see if we need to shrink
			 * the length and stop
			 */
			if (end_index == index) {
				loff = PAGE_CACHE_SIZE - (isize & ~PAGE_CACHE_MASK);
				if (bytes + loff > isize) {
					page_cache_release(page);
					break;
				}
				/*
				 * force quit after adding this page
				 */
				nr_pages = i;
			}
368
		}
369
fill_it:
370
		pages[i] = page;
371 372
		bytes += PAGE_CACHE_SIZE - loff;
		loff = 0;
373 374
	}

375
	if (i)
376
		return move_to_pipe(pipe, pages, i, bytes, offset, flags);
377

378
	return error;
379 380
}

381 382 383 384 385 386 387 388 389
/**
 * generic_file_splice_read - splice data from file to a pipe
 * @in:		file to splice from
 * @pipe:	pipe to splice to
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
 * Will read pages from given file and fill them into a pipe.
 */
390 391 392
ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
				 struct pipe_inode_info *pipe, size_t len,
				 unsigned int flags)
393 394 395 396 397 398
{
	ssize_t spliced;
	int ret;

	ret = 0;
	spliced = 0;
399

400
	while (len) {
401
		ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
402 403 404 405

		if (ret <= 0)
			break;

406
		*ppos += ret;
407 408
		len -= ret;
		spliced += ret;
409 410 411 412 413

		if (!(flags & SPLICE_F_NONBLOCK))
			continue;
		ret = -EAGAIN;
		break;
414 415 416 417 418 419 420 421
	}

	if (spliced)
		return spliced;

	return ret;
}

422 423
EXPORT_SYMBOL(generic_file_splice_read);

424
/*
425 426
 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
 * using sendpage().
427 428 429 430 431 432 433 434 435
 */
static int pipe_to_sendpage(struct pipe_inode_info *info,
			    struct pipe_buffer *buf, struct splice_desc *sd)
{
	struct file *file = sd->file;
	loff_t pos = sd->pos;
	unsigned int offset;
	ssize_t ret;
	void *ptr;
436
	int more;
437 438

	/*
I
Ingo Molnar 已提交
439
	 * Sub-optimal, but we are limited by the pipe ->map. We don't
440 441
	 * need a kmap'ed buffer here, we just want to make sure we
	 * have the page pinned if the pipe page originates from the
I
Ingo Molnar 已提交
442
	 * page cache.
443 444 445 446 447 448
	 */
	ptr = buf->ops->map(file, info, buf);
	if (IS_ERR(ptr))
		return PTR_ERR(ptr);

	offset = pos & ~PAGE_CACHE_MASK;
449
	more = (sd->flags & SPLICE_F_MORE) || sd->len < sd->total_len;
450

451
	ret = file->f_op->sendpage(file, buf->page, offset, sd->len, &pos,more);
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472

	buf->ops->unmap(info, buf);
	if (ret == sd->len)
		return 0;

	return -EIO;
}

/*
 * 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.
 *
473 474 475 476 477 478
 * 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.
479 480 481 482 483 484
 */
static int pipe_to_file(struct pipe_inode_info *info, struct pipe_buffer *buf,
			struct splice_desc *sd)
{
	struct file *file = sd->file;
	struct address_space *mapping = file->f_mapping;
485
	gfp_t gfp_mask = mapping_gfp_mask(mapping);
486 487 488
	unsigned int offset;
	struct page *page;
	pgoff_t index;
489
	char *src;
490
	int ret;
491 492

	/*
493
	 * make sure the data in this buffer is uptodate
494 495 496 497 498 499 500 501 502
	 */
	src = buf->ops->map(file, info, buf);
	if (IS_ERR(src))
		return PTR_ERR(src);

	index = sd->pos >> PAGE_CACHE_SHIFT;
	offset = sd->pos & ~PAGE_CACHE_MASK;

	/*
I
Ingo Molnar 已提交
503
	 * Reuse buf page, if SPLICE_F_MOVE is set.
504
	 */
505
	if (sd->flags & SPLICE_F_MOVE) {
506 507 508 509
		/*
		 * If steal succeeds, buf->page is now pruned from the vm
		 * side (LRU and page cache) and we can reuse it.
		 */
510 511 512
		if (buf->ops->steal(info, buf))
			goto find_page;

513 514 515
		/*
		 * this will also set the page locked
		 */
516
		page = buf->page;
517
		if (add_to_page_cache(page, mapping, index, gfp_mask))
518
			goto find_page;
519 520 521

		if (!(buf->flags & PIPE_BUF_FLAG_LRU))
			lru_cache_add(page);
522 523 524
	} else {
find_page:
		ret = -ENOMEM;
525
		page = find_or_create_page(mapping, index, gfp_mask);
526
		if (!page)
527
			goto out_nomem;
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543

		/*
		 * If the page is uptodate, it is also locked. If it isn't
		 * uptodate, we can mark it uptodate if we are filling the
		 * full page. Otherwise we need to read it in first...
		 */
		if (!PageUptodate(page)) {
			if (sd->len < PAGE_CACHE_SIZE) {
				ret = mapping->a_ops->readpage(file, page);
				if (unlikely(ret))
					goto out;

				lock_page(page);

				if (!PageUptodate(page)) {
					/*
I
Ingo Molnar 已提交
544
					 * Page got invalidated, repeat.
545 546 547 548 549 550 551 552
					 */
					if (!page->mapping) {
						unlock_page(page);
						page_cache_release(page);
						goto find_page;
					}
					ret = -EIO;
					goto out;
553
				}
554 555 556
			} else {
				WARN_ON(!PageLocked(page));
				SetPageUptodate(page);
557 558 559 560 561
			}
		}
	}

	ret = mapping->a_ops->prepare_write(file, page, 0, sd->len);
562 563 564 565
	if (ret == AOP_TRUNCATED_PAGE) {
		page_cache_release(page);
		goto find_page;
	} else if (ret)
566 567
		goto out;

568
	if (!(buf->flags & PIPE_BUF_FLAG_STOLEN)) {
569 570 571 572 573 574
		char *dst = kmap_atomic(page, KM_USER0);

		memcpy(dst + offset, src + buf->offset, sd->len);
		flush_dcache_page(page);
		kunmap_atomic(dst, KM_USER0);
	}
575 576

	ret = mapping->a_ops->commit_write(file, page, 0, sd->len);
577 578 579 580
	if (ret == AOP_TRUNCATED_PAGE) {
		page_cache_release(page);
		goto find_page;
	} else if (ret)
581 582
		goto out;

583
	mark_page_accessed(page);
584
	balance_dirty_pages_ratelimited(mapping);
585
out:
586
	if (!(buf->flags & PIPE_BUF_FLAG_STOLEN)) {
587
		page_cache_release(page);
588 589
		unlock_page(page);
	}
590
out_nomem:
591 592 593 594 595 596 597
	buf->ops->unmap(info, buf);
	return ret;
}

typedef int (splice_actor)(struct pipe_inode_info *, struct pipe_buffer *,
			   struct splice_desc *);

598 599 600 601 602
/*
 * Pipe input worker. Most of this logic works like a regular pipe, the
 * key here is the 'actor' worker passed in that actually moves the data
 * to the wanted destination. See pipe_to_file/pipe_to_sendpage above.
 */
603
static ssize_t move_from_pipe(struct pipe_inode_info *pipe, struct file *out,
604
			      loff_t *ppos, size_t len, unsigned int flags,
605 606 607 608 609 610 611 612 613 614 615
			      splice_actor *actor)
{
	int ret, do_wakeup, err;
	struct splice_desc sd;

	ret = 0;
	do_wakeup = 0;

	sd.total_len = len;
	sd.flags = flags;
	sd.file = out;
616
	sd.pos = *ppos;
617

618 619
	if (pipe->inode)
		mutex_lock(&pipe->inode->i_mutex);
620 621

	for (;;) {
622 623
		if (pipe->nrbufs) {
			struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
624 625 626 627 628 629
			struct pipe_buf_operations *ops = buf->ops;

			sd.len = buf->len;
			if (sd.len > sd.total_len)
				sd.len = sd.total_len;

630
			err = actor(pipe, buf, &sd);
631 632 633 634 635 636 637 638 639 640
			if (err) {
				if (!ret && err != -ENODATA)
					ret = err;

				break;
			}

			ret += sd.len;
			buf->offset += sd.len;
			buf->len -= sd.len;
I
Ingo Molnar 已提交
641

642 643
			if (!buf->len) {
				buf->ops = NULL;
644
				ops->release(pipe, buf);
645 646 647 648
				pipe->curbuf = (pipe->curbuf + 1) & (PIPE_BUFFERS - 1);
				pipe->nrbufs--;
				if (pipe->inode)
					do_wakeup = 1;
649 650 651 652 653 654 655 656
			}

			sd.pos += sd.len;
			sd.total_len -= sd.len;
			if (!sd.total_len)
				break;
		}

657
		if (pipe->nrbufs)
658
			continue;
659
		if (!pipe->writers)
660
			break;
661
		if (!pipe->waiting_writers) {
662 663 664 665
			if (ret)
				break;
		}

666 667 668 669 670 671
		if (flags & SPLICE_F_NONBLOCK) {
			if (!ret)
				ret = -EAGAIN;
			break;
		}

672 673 674 675 676 677 678
		if (signal_pending(current)) {
			if (!ret)
				ret = -ERESTARTSYS;
			break;
		}

		if (do_wakeup) {
679
			smp_mb();
680 681 682
			if (waitqueue_active(&pipe->wait))
				wake_up_interruptible_sync(&pipe->wait);
			kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
683 684 685
			do_wakeup = 0;
		}

686
		pipe_wait(pipe);
687 688
	}

689 690
	if (pipe->inode)
		mutex_unlock(&pipe->inode->i_mutex);
691 692

	if (do_wakeup) {
693
		smp_mb();
694 695 696
		if (waitqueue_active(&pipe->wait))
			wake_up_interruptible(&pipe->wait);
		kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
697 698 699 700 701
	}

	return ret;
}

702 703
/**
 * generic_file_splice_write - splice data from a pipe to a file
704
 * @pipe:	pipe info
705 706 707 708 709 710 711 712
 * @out:	file to write to
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
 * Will either move or copy pages (determined by @flags options) from
 * the given pipe inode to the given file.
 *
 */
713 714
ssize_t
generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
715
			  loff_t *ppos, size_t len, unsigned int flags)
716
{
717
	struct address_space *mapping = out->f_mapping;
718 719
	ssize_t ret;

720
	ret = move_from_pipe(pipe, out, ppos, len, flags, pipe_to_file);
721 722

	/*
I
Ingo Molnar 已提交
723
	 * If file or inode is SYNC and we actually wrote some data, sync it.
724 725 726 727 728 729 730 731
	 */
	if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(mapping->host))
	    && ret > 0) {
		struct inode *inode = mapping->host;
		int err;

		mutex_lock(&inode->i_mutex);
		err = generic_osync_inode(mapping->host, mapping,
732
					  OSYNC_METADATA|OSYNC_DATA);
733 734 735 736 737 738 739
		mutex_unlock(&inode->i_mutex);

		if (err)
			ret = err;
	}

	return ret;
740 741
}

742 743
EXPORT_SYMBOL(generic_file_splice_write);

744 745 746 747 748 749 750 751 752 753 754
/**
 * generic_splice_sendpage - splice data from a pipe to a socket
 * @inode:	pipe inode
 * @out:	socket to write to
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
 * Will send @len bytes from the pipe to a network socket. No data copying
 * is involved.
 *
 */
755
ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
756
				loff_t *ppos, size_t len, unsigned int flags)
757
{
758
	return move_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
759 760
}

761
EXPORT_SYMBOL(generic_splice_sendpage);
J
Jeff Garzik 已提交
762

763 764 765
/*
 * Attempt to initiate a splice from pipe to file.
 */
766
static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
767
			   loff_t *ppos, size_t len, unsigned int flags)
768 769 770
{
	int ret;

771
	if (unlikely(!out->f_op || !out->f_op->splice_write))
772 773
		return -EINVAL;

774
	if (unlikely(!(out->f_mode & FMODE_WRITE)))
775 776
		return -EBADF;

777
	ret = rw_verify_area(WRITE, out, ppos, len);
778 779 780
	if (unlikely(ret < 0))
		return ret;

781
	return out->f_op->splice_write(pipe, out, ppos, len, flags);
782 783
}

784 785 786
/*
 * Attempt to initiate a splice from a file to a pipe.
 */
787 788 789
static long do_splice_to(struct file *in, loff_t *ppos,
			 struct pipe_inode_info *pipe, size_t len,
			 unsigned int flags)
790
{
791
	loff_t isize, left;
792 793
	int ret;

794
	if (unlikely(!in->f_op || !in->f_op->splice_read))
795 796
		return -EINVAL;

797
	if (unlikely(!(in->f_mode & FMODE_READ)))
798 799
		return -EBADF;

800
	ret = rw_verify_area(READ, in, ppos, len);
801 802 803 804
	if (unlikely(ret < 0))
		return ret;

	isize = i_size_read(in->f_mapping->host);
805
	if (unlikely(*ppos >= isize))
806 807
		return 0;
	
808
	left = isize - *ppos;
809
	if (unlikely(left < len))
810 811
		len = left;

812
	return in->f_op->splice_read(in, ppos, pipe, len, flags);
813 814
}

815 816
long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
		      size_t len, unsigned int flags)
817 818 819
{
	struct pipe_inode_info *pipe;
	long ret, bytes;
820
	loff_t out_off;
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
	umode_t i_mode;
	int i;

	/*
	 * 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!
	 */
	i_mode = in->f_dentry->d_inode->i_mode;
	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;
838
	if (unlikely(!pipe)) {
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
		pipe = alloc_pipe_info(NULL);
		if (!pipe)
			return -ENOMEM;

		/*
		 * We don't have an immediate reader, but we'll read the stuff
		 * out of the pipe right after the move_to_pipe(). So set
		 * PIPE_READERS appropriately.
		 */
		pipe->readers = 1;

		current->splice_pipe = pipe;
	}

	/*
I
Ingo Molnar 已提交
854
	 * Do the splice.
855 856 857
	 */
	ret = 0;
	bytes = 0;
858
	out_off = 0;
859 860 861 862 863 864 865 866 867

	while (len) {
		size_t read_len, max_read_len;

		/*
		 * Do at most PIPE_BUFFERS pages worth of transfer:
		 */
		max_read_len = min(len, (size_t)(PIPE_BUFFERS*PAGE_SIZE));

868
		ret = do_splice_to(in, ppos, pipe, max_read_len, flags);
869 870 871 872 873 874 875 876 877 878
		if (unlikely(ret < 0))
			goto out_release;

		read_len = ret;

		/*
		 * 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:
		 */
879
		ret = do_splice_from(pipe, out, &out_off, read_len,
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
				     flags & ~SPLICE_F_NONBLOCK);
		if (unlikely(ret < 0))
			goto out_release;

		bytes += ret;
		len -= ret;

		/*
		 * In nonblocking mode, if we got back a short read then
		 * that was due to either an IO error or due to the
		 * pagecache entry not being there. In the IO error case
		 * the _next_ splice attempt will produce a clean IO error
		 * return value (not a short read), so in both cases it's
		 * correct to break out of the loop here:
		 */
		if ((flags & SPLICE_F_NONBLOCK) && (read_len < max_read_len))
			break;
	}

	pipe->nrbufs = pipe->curbuf = 0;

	return bytes;

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

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

	/*
	 * If we transferred some data, return the number of bytes:
	 */
	if (bytes > 0)
		return bytes;

	return ret;
}

EXPORT_SYMBOL(do_splice_direct);

929 930 931
/*
 * Determine where to splice to/from.
 */
932 933 934
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)
935
{
936
	struct pipe_inode_info *pipe;
937
	loff_t offset, *off;
938

939
	pipe = in->f_dentry->d_inode->i_pipe;
940 941 942
	if (pipe) {
		if (off_in)
			return -ESPIPE;
943 944 945
		if (off_out) {
			if (out->f_op->llseek == no_llseek)
				return -EINVAL;
946
			if (copy_from_user(&offset, off_out, sizeof(loff_t)))
947
				return -EFAULT;
948 949 950
			off = &offset;
		} else
			off = &out->f_pos;
951

952
		return do_splice_from(pipe, out, off, len, flags);
953
	}
954

955
	pipe = out->f_dentry->d_inode->i_pipe;
956 957 958
	if (pipe) {
		if (off_out)
			return -ESPIPE;
959 960 961
		if (off_in) {
			if (in->f_op->llseek == no_llseek)
				return -EINVAL;
962
			if (copy_from_user(&offset, off_in, sizeof(loff_t)))
963
				return -EFAULT;
964 965 966
			off = &offset;
		} else
			off = &in->f_pos;
967

968
		return do_splice_to(in, off, pipe, len, flags);
969
	}
970 971 972 973

	return -EINVAL;
}

974 975 976
asmlinkage long sys_splice(int fd_in, loff_t __user *off_in,
			   int fd_out, loff_t __user *off_out,
			   size_t len, unsigned int flags)
977 978 979 980 981 982 983 984 985
{
	long error;
	struct file *in, *out;
	int fput_in, fput_out;

	if (unlikely(!len))
		return 0;

	error = -EBADF;
986
	in = fget_light(fd_in, &fput_in);
987 988
	if (in) {
		if (in->f_mode & FMODE_READ) {
989
			out = fget_light(fd_out, &fput_out);
990 991
			if (out) {
				if (out->f_mode & FMODE_WRITE)
992 993 994
					error = do_splice(in, off_in,
							  out, off_out,
							  len, flags);
995 996 997 998 999 1000 1001 1002 1003
				fput_light(out, fput_out);
			}
		}

		fput_light(in, fput_in);
	}

	return error;
}
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182

/*
 * 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;
	int ret = 0, do_wakeup = 0, i;

	/*
	 * Potential ABBA deadlock, work around it by ordering lock
	 * grabbing by inode address. Otherwise two different processes
	 * could deadlock (one doing tee from A -> B, the other from B -> A).
	 */
	if (ipipe->inode < opipe->inode) {
		mutex_lock(&ipipe->inode->i_mutex);
		mutex_lock(&opipe->inode->i_mutex);
	} else {
		mutex_lock(&opipe->inode->i_mutex);
		mutex_lock(&ipipe->inode->i_mutex);
	}

	for (i = 0;; i++) {
		if (!opipe->readers) {
			send_sig(SIGPIPE, current, 0);
			if (!ret)
				ret = -EPIPE;
			break;
		}
		if (ipipe->nrbufs - i) {
			ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (PIPE_BUFFERS - 1));

			/*
			 * If we have room, fill this buffer
			 */
			if (opipe->nrbufs < PIPE_BUFFERS) {
				int nbuf = (opipe->curbuf + opipe->nrbufs) & (PIPE_BUFFERS - 1);

				/*
				 * Get a reference to this pipe buffer,
				 * so we can copy the contents over.
				 */
				ibuf->ops->get(ipipe, ibuf);

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

				if (obuf->len > len)
					obuf->len = len;

				opipe->nrbufs++;
				do_wakeup = 1;
				ret += obuf->len;
				len -= obuf->len;

				if (!len)
					break;
				if (opipe->nrbufs < PIPE_BUFFERS)
					continue;
			}

			/*
			 * We have input available, but no output room.
			 * If we already copied data, return that.
			 */
			if (flags & SPLICE_F_NONBLOCK) {
				if (!ret)
					ret = -EAGAIN;
				break;
			}
			if (signal_pending(current)) {
				if (!ret)
					ret = -ERESTARTSYS;
				break;
			}
			if (do_wakeup) {
				smp_mb();
				if (waitqueue_active(&opipe->wait))
					wake_up_interruptible(&opipe->wait);
				kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN);
				do_wakeup = 0;
			}

			opipe->waiting_writers++;
			pipe_wait(opipe);
			opipe->waiting_writers--;
			continue;
		}

		/*
		 * No input buffers, do the usual checks for available
		 * writers and blocking and wait if necessary
		 */
		if (!ipipe->writers)
			break;
		if (!ipipe->waiting_writers) {
			if (ret)
				break;
		}
		if (flags & SPLICE_F_NONBLOCK) {
			if (!ret)
				ret = -EAGAIN;
			break;
		}
		if (signal_pending(current)) {
			if (!ret)
				ret = -ERESTARTSYS;
			break;
		}

		if (waitqueue_active(&ipipe->wait))
			wake_up_interruptible_sync(&ipipe->wait);
		kill_fasync(&ipipe->fasync_writers, SIGIO, POLL_OUT);

		pipe_wait(ipipe);
	}

	mutex_unlock(&ipipe->inode->i_mutex);
	mutex_unlock(&opipe->inode->i_mutex);

	if (do_wakeup) {
		smp_mb();
		if (waitqueue_active(&opipe->wait))
			wake_up_interruptible(&opipe->wait);
		kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN);
	}

	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)
{
	struct pipe_inode_info *ipipe = in->f_dentry->d_inode->i_pipe;
	struct pipe_inode_info *opipe = out->f_dentry->d_inode->i_pipe;

	/*
	 * Link ipipe to the two output pipes, consuming as we go along.
	 */
	if (ipipe && opipe)
		return link_pipe(ipipe, opipe, len, flags);

	return -EINVAL;
}

asmlinkage long sys_tee(int fdin, int fdout, size_t len, unsigned int flags)
{
	struct file *in;
	int error, fput_in;

	if (unlikely(!len))
		return 0;

	error = -EBADF;
	in = fget_light(fdin, &fput_in);
	if (in) {
		if (in->f_mode & FMODE_READ) {
			int fput_out;
			struct file *out = fget_light(fdout, &fput_out);

			if (out) {
				if (out->f_mode & FMODE_WRITE)
					error = do_tee(in, out, len, flags);
				fput_light(out, fput_out);
			}
		}
 		fput_light(in, fput_in);
 	}

	return error;
}