splice.c 21.6 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 128 129 130 131 132
}

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

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,
133
	.steal = page_cache_pipe_buf_steal,
134 135
};

136 137 138 139
/*
 * Pipe output worker. This sets up our pipe format with the page cache
 * pipe buffer operations. Otherwise very similar to the regular pipe_writev().
 */
140
static ssize_t move_to_pipe(struct pipe_inode_info *pipe, struct page **pages,
141
			    int nr_pages, unsigned long offset,
142
			    unsigned long len, unsigned int flags)
143 144 145 146 147 148 149
{
	int ret, do_wakeup, i;

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

150 151
	if (pipe->inode)
		mutex_lock(&pipe->inode->i_mutex);
152 153

	for (;;) {
154
		if (!pipe->readers) {
155 156 157 158 159 160
			send_sig(SIGPIPE, current, 0);
			if (!ret)
				ret = -EPIPE;
			break;
		}

161 162
		if (pipe->nrbufs < PIPE_BUFFERS) {
			int newbuf = (pipe->curbuf + pipe->nrbufs) & (PIPE_BUFFERS - 1);
163
			struct pipe_buffer *buf = pipe->bufs + newbuf;
164 165 166 167 168 169 170 171 172 173 174
			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;
175 176 177
			pipe->nrbufs++;
			if (pipe->inode)
				do_wakeup = 1;
178 179 180 181 182 183 184 185

			ret += this_len;
			len -= this_len;
			offset = 0;
			if (!--nr_pages)
				break;
			if (!len)
				break;
186
			if (pipe->nrbufs < PIPE_BUFFERS)
187 188 189 190 191
				continue;

			break;
		}

192 193 194 195 196 197
		if (flags & SPLICE_F_NONBLOCK) {
			if (!ret)
				ret = -EAGAIN;
			break;
		}

198 199 200 201 202 203 204
		if (signal_pending(current)) {
			if (!ret)
				ret = -ERESTARTSYS;
			break;
		}

		if (do_wakeup) {
205
			smp_mb();
206 207 208
			if (waitqueue_active(&pipe->wait))
				wake_up_interruptible_sync(&pipe->wait);
			kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
209 210 211
			do_wakeup = 0;
		}

212 213 214
		pipe->waiting_writers++;
		pipe_wait(pipe);
		pipe->waiting_writers--;
215 216
	}

217 218
	if (pipe->inode)
		mutex_unlock(&pipe->inode->i_mutex);
219 220

	if (do_wakeup) {
221
		smp_mb();
222 223 224
		if (waitqueue_active(&pipe->wait))
			wake_up_interruptible(&pipe->wait);
		kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
225 226 227 228 229 230 231 232
	}

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

	return ret;
}

233
static int
234 235 236
__generic_file_splice_read(struct file *in, loff_t *ppos,
			   struct pipe_inode_info *pipe, size_t len,
			   unsigned int flags)
237 238 239
{
	struct address_space *mapping = in->f_mapping;
	unsigned int offset, nr_pages;
240
	struct page *pages[PIPE_BUFFERS];
241
	struct page *page;
242
	pgoff_t index;
243
	int i, error;
244

245 246
	index = *ppos >> PAGE_CACHE_SHIFT;
	offset = *ppos & ~PAGE_CACHE_MASK;
247 248 249 250 251 252
	nr_pages = (len + offset + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;

	if (nr_pages > PIPE_BUFFERS)
		nr_pages = PIPE_BUFFERS;

	/*
I
Ingo Molnar 已提交
253
	 * Initiate read-ahead on this page range. however, don't call into
254 255
	 * 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.
256
	 */
257 258
	if (!offset || nr_pages > 1)
		do_page_cache_readahead(mapping, in, index, nr_pages);
259 260

	/*
I
Ingo Molnar 已提交
261
	 * Now fill in the holes:
262
	 */
263
	error = 0;
264
	for (i = 0; i < nr_pages; i++, index++) {
265
find_page:
266
		/*
267
		 * lookup the page for this index
268
		 */
269 270 271 272 273 274 275 276 277 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
		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;
			}
319

320 321 322 323 324
readpage:
			/*
			 * need to read in the page
			 */
			error = mapping->a_ops->readpage(in, page);
325 326 327

			if (unlikely(error)) {
				page_cache_release(page);
328 329
				if (error == AOP_TRUNCATED_PAGE)
					goto find_page;
330 331 332
				break;
			}
		}
333
fill_it:
334
		pages[i] = page;
335 336
	}

337 338
	if (i)
		return move_to_pipe(pipe, pages, i, offset, len, flags);
339

340
	return error;
341 342
}

343 344 345 346 347 348 349 350 351
/**
 * 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.
 */
352 353 354
ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
				 struct pipe_inode_info *pipe, size_t len,
				 unsigned int flags)
355 356 357 358 359 360
{
	ssize_t spliced;
	int ret;

	ret = 0;
	spliced = 0;
361

362
	while (len) {
363
		ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
364 365 366 367

		if (ret <= 0)
			break;

368
		*ppos += ret;
369 370
		len -= ret;
		spliced += ret;
371 372 373 374 375

		if (!(flags & SPLICE_F_NONBLOCK))
			continue;
		ret = -EAGAIN;
		break;
376 377 378 379 380 381 382 383
	}

	if (spliced)
		return spliced;

	return ret;
}

384 385
EXPORT_SYMBOL(generic_file_splice_read);

386
/*
387 388
 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
 * using sendpage().
389 390 391 392 393 394 395 396 397
 */
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;
398
	int more;
399 400

	/*
I
Ingo Molnar 已提交
401
	 * Sub-optimal, but we are limited by the pipe ->map. We don't
402 403
	 * 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 已提交
404
	 * page cache.
405 406 407 408 409 410
	 */
	ptr = buf->ops->map(file, info, buf);
	if (IS_ERR(ptr))
		return PTR_ERR(ptr);

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

413
	ret = file->f_op->sendpage(file, buf->page, offset, sd->len, &pos,more);
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434

	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.
 *
435 436 437 438 439 440
 * 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.
441 442 443 444 445 446
 */
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;
447
	gfp_t gfp_mask = mapping_gfp_mask(mapping);
448 449 450
	unsigned int offset;
	struct page *page;
	pgoff_t index;
451
	char *src;
452
	int ret;
453 454

	/*
455
	 * make sure the data in this buffer is uptodate
456 457 458 459 460 461 462 463 464
	 */
	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 已提交
465
	 * Reuse buf page, if SPLICE_F_MOVE is set.
466
	 */
467
	if (sd->flags & SPLICE_F_MOVE) {
468 469 470 471
		/*
		 * If steal succeeds, buf->page is now pruned from the vm
		 * side (LRU and page cache) and we can reuse it.
		 */
472 473 474
		if (buf->ops->steal(info, buf))
			goto find_page;

475 476 477
		/*
		 * this will also set the page locked
		 */
478
		page = buf->page;
479
		if (add_to_page_cache(page, mapping, index, gfp_mask))
480
			goto find_page;
481 482 483

		if (!(buf->flags & PIPE_BUF_FLAG_LRU))
			lru_cache_add(page);
484 485 486
	} else {
find_page:
		ret = -ENOMEM;
487
		page = find_or_create_page(mapping, index, gfp_mask);
488
		if (!page)
489
			goto out_nomem;
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505

		/*
		 * 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 已提交
506
					 * Page got invalidated, repeat.
507 508 509 510 511 512 513 514
					 */
					if (!page->mapping) {
						unlock_page(page);
						page_cache_release(page);
						goto find_page;
					}
					ret = -EIO;
					goto out;
515
				}
516 517 518
			} else {
				WARN_ON(!PageLocked(page));
				SetPageUptodate(page);
519 520 521 522 523
			}
		}
	}

	ret = mapping->a_ops->prepare_write(file, page, 0, sd->len);
524 525 526 527
	if (ret == AOP_TRUNCATED_PAGE) {
		page_cache_release(page);
		goto find_page;
	} else if (ret)
528 529
		goto out;

530
	if (!(buf->flags & PIPE_BUF_FLAG_STOLEN)) {
531 532 533 534 535 536
		char *dst = kmap_atomic(page, KM_USER0);

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

	ret = mapping->a_ops->commit_write(file, page, 0, sd->len);
539 540 541 542
	if (ret == AOP_TRUNCATED_PAGE) {
		page_cache_release(page);
		goto find_page;
	} else if (ret)
543 544
		goto out;

545
	mark_page_accessed(page);
546
	balance_dirty_pages_ratelimited(mapping);
547
out:
548
	if (!(buf->flags & PIPE_BUF_FLAG_STOLEN)) {
549
		page_cache_release(page);
550 551
		unlock_page(page);
	}
552
out_nomem:
553 554 555 556 557 558 559
	buf->ops->unmap(info, buf);
	return ret;
}

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

560 561 562 563 564
/*
 * 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.
 */
565
static ssize_t move_from_pipe(struct pipe_inode_info *pipe, struct file *out,
566
			      loff_t *ppos, size_t len, unsigned int flags,
567 568 569 570 571 572 573 574 575 576 577
			      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;
578
	sd.pos = *ppos;
579

580 581
	if (pipe->inode)
		mutex_lock(&pipe->inode->i_mutex);
582 583

	for (;;) {
584 585
		if (pipe->nrbufs) {
			struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
586 587 588 589 590 591
			struct pipe_buf_operations *ops = buf->ops;

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

592
			err = actor(pipe, buf, &sd);
593 594 595 596 597 598 599 600 601 602
			if (err) {
				if (!ret && err != -ENODATA)
					ret = err;

				break;
			}

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

604 605
			if (!buf->len) {
				buf->ops = NULL;
606
				ops->release(pipe, buf);
607 608 609 610
				pipe->curbuf = (pipe->curbuf + 1) & (PIPE_BUFFERS - 1);
				pipe->nrbufs--;
				if (pipe->inode)
					do_wakeup = 1;
611 612 613 614 615 616 617 618
			}

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

619
		if (pipe->nrbufs)
620
			continue;
621
		if (!pipe->writers)
622
			break;
623
		if (!pipe->waiting_writers) {
624 625 626 627
			if (ret)
				break;
		}

628 629 630 631 632 633
		if (flags & SPLICE_F_NONBLOCK) {
			if (!ret)
				ret = -EAGAIN;
			break;
		}

634 635 636 637 638 639 640
		if (signal_pending(current)) {
			if (!ret)
				ret = -ERESTARTSYS;
			break;
		}

		if (do_wakeup) {
641
			smp_mb();
642 643 644
			if (waitqueue_active(&pipe->wait))
				wake_up_interruptible_sync(&pipe->wait);
			kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
645 646 647
			do_wakeup = 0;
		}

648
		pipe_wait(pipe);
649 650
	}

651 652
	if (pipe->inode)
		mutex_unlock(&pipe->inode->i_mutex);
653 654

	if (do_wakeup) {
655
		smp_mb();
656 657 658
		if (waitqueue_active(&pipe->wait))
			wake_up_interruptible(&pipe->wait);
		kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
659 660 661 662 663
	}

	return ret;
}

664 665
/**
 * generic_file_splice_write - splice data from a pipe to a file
666
 * @pipe:	pipe info
667 668 669 670 671 672 673 674
 * @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.
 *
 */
675 676
ssize_t
generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
677
			  loff_t *ppos, size_t len, unsigned int flags)
678
{
679
	struct address_space *mapping = out->f_mapping;
680 681
	ssize_t ret;

682
	ret = move_from_pipe(pipe, out, ppos, len, flags, pipe_to_file);
683 684

	/*
I
Ingo Molnar 已提交
685
	 * If file or inode is SYNC and we actually wrote some data, sync it.
686 687 688 689 690 691 692 693
	 */
	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,
694
					  OSYNC_METADATA|OSYNC_DATA);
695 696 697 698 699 700 701
		mutex_unlock(&inode->i_mutex);

		if (err)
			ret = err;
	}

	return ret;
702 703
}

704 705
EXPORT_SYMBOL(generic_file_splice_write);

706 707 708 709 710 711 712 713 714 715 716
/**
 * 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.
 *
 */
717
ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
718
				loff_t *ppos, size_t len, unsigned int flags)
719
{
720
	return move_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
721 722
}

723
EXPORT_SYMBOL(generic_splice_sendpage);
J
Jeff Garzik 已提交
724

725 726 727
/*
 * Attempt to initiate a splice from pipe to file.
 */
728
static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
729
			   loff_t *ppos, size_t len, unsigned int flags)
730 731 732
{
	int ret;

733
	if (unlikely(!out->f_op || !out->f_op->splice_write))
734 735
		return -EINVAL;

736
	if (unlikely(!(out->f_mode & FMODE_WRITE)))
737 738
		return -EBADF;

739
	ret = rw_verify_area(WRITE, out, ppos, len);
740 741 742
	if (unlikely(ret < 0))
		return ret;

743
	return out->f_op->splice_write(pipe, out, ppos, len, flags);
744 745
}

746 747 748
/*
 * Attempt to initiate a splice from a file to a pipe.
 */
749 750 751
static long do_splice_to(struct file *in, loff_t *ppos,
			 struct pipe_inode_info *pipe, size_t len,
			 unsigned int flags)
752
{
753
	loff_t isize, left;
754 755
	int ret;

756
	if (unlikely(!in->f_op || !in->f_op->splice_read))
757 758
		return -EINVAL;

759
	if (unlikely(!(in->f_mode & FMODE_READ)))
760 761
		return -EBADF;

762
	ret = rw_verify_area(READ, in, ppos, len);
763 764 765 766
	if (unlikely(ret < 0))
		return ret;

	isize = i_size_read(in->f_mapping->host);
767
	if (unlikely(*ppos >= isize))
768 769
		return 0;
	
770
	left = isize - *ppos;
771
	if (unlikely(left < len))
772 773
		len = left;

774
	return in->f_op->splice_read(in, ppos, pipe, len, flags);
775 776
}

777 778
long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
		      size_t len, unsigned int flags)
779 780 781
{
	struct pipe_inode_info *pipe;
	long ret, bytes;
782
	loff_t out_off;
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
	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;
800
	if (unlikely(!pipe)) {
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
		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 已提交
816
	 * Do the splice.
817 818 819
	 */
	ret = 0;
	bytes = 0;
820
	out_off = 0;
821 822 823 824 825 826 827 828 829

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

830
		ret = do_splice_to(in, ppos, pipe, max_read_len, flags);
831 832 833 834 835 836 837 838 839 840
		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:
		 */
841
		ret = do_splice_from(pipe, out, &out_off, read_len,
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
				     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);

891 892 893
/*
 * Determine where to splice to/from.
 */
894 895 896
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)
897
{
898
	struct pipe_inode_info *pipe;
899
	loff_t offset, *off;
900

901
	pipe = in->f_dentry->d_inode->i_pipe;
902 903 904
	if (pipe) {
		if (off_in)
			return -ESPIPE;
905 906 907
		if (off_out) {
			if (out->f_op->llseek == no_llseek)
				return -EINVAL;
908
			if (copy_from_user(&offset, off_out, sizeof(loff_t)))
909
				return -EFAULT;
910 911 912
			off = &offset;
		} else
			off = &out->f_pos;
913

914
		return do_splice_from(pipe, out, off, len, flags);
915
	}
916

917
	pipe = out->f_dentry->d_inode->i_pipe;
918 919 920
	if (pipe) {
		if (off_out)
			return -ESPIPE;
921 922 923
		if (off_in) {
			if (in->f_op->llseek == no_llseek)
				return -EINVAL;
924
			if (copy_from_user(&offset, off_in, sizeof(loff_t)))
925
				return -EFAULT;
926 927 928
			off = &offset;
		} else
			off = &in->f_pos;
929

930
		return do_splice_to(in, off, pipe, len, flags);
931
	}
932 933 934 935

	return -EINVAL;
}

936 937 938
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)
939 940 941 942 943 944 945 946 947
{
	long error;
	struct file *in, *out;
	int fput_in, fput_out;

	if (unlikely(!len))
		return 0;

	error = -EBADF;
948
	in = fget_light(fd_in, &fput_in);
949 950
	if (in) {
		if (in->f_mode & FMODE_READ) {
951
			out = fget_light(fd_out, &fput_out);
952 953
			if (out) {
				if (out->f_mode & FMODE_WRITE)
954 955 956
					error = do_splice(in, off_in,
							  out, off_out,
							  len, flags);
957 958 959 960 961 962 963 964 965
				fput_light(out, fput_out);
			}
		}

		fput_light(in, fput_in);
	}

	return error;
}