splice.c 42.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
 * 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 28
#include <linux/writeback.h>
#include <linux/buffer_head.h>
J
Jeff Garzik 已提交
29
#include <linux/module.h>
30
#include <linux/syscalls.h>
31
#include <linux/uio.h>
32
#include <linux/security.h>
33

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

46 47
	lock_page(page);

48 49 50
	mapping = page_mapping(page);
	if (mapping) {
		WARN_ON(!PageUptodate(page));
51

52 53 54 55 56 57 58 59 60
		/*
		 * 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);
61

62 63
		if (page_has_private(page) &&
		    !try_to_release_page(page, GFP_KERNEL))
64
			goto out_unlock;
65

66 67 68 69 70 71 72 73
		/*
		 * 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;
		}
74
	}
75

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

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

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

	if (!PageUptodate(page)) {
103 104 105 106
		lock_page(page);

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

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

		/*
123
		 * Page is ok afterall, we are done.
124
		 */
125 126 127
		unlock_page(page);
	}

128
	return 0;
129 130
error:
	unlock_page(page);
131
	return err;
132 133
}

134
static const struct pipe_buf_operations page_cache_pipe_buf_ops = {
135
	.can_merge = 0,
136 137
	.map = generic_pipe_buf_map,
	.unmap = generic_pipe_buf_unmap,
138
	.confirm = page_cache_pipe_buf_confirm,
139
	.release = page_cache_pipe_buf_release,
140
	.steal = page_cache_pipe_buf_steal,
141
	.get = generic_pipe_buf_get,
142 143
};

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

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

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

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

	ret = 0;
	do_wakeup = 0;
183
	page_nr = 0;
184

185
	pipe_lock(pipe);
186 187

	for (;;) {
188
		if (!pipe->readers) {
189 190 191 192 193 194
			send_sig(SIGPIPE, current, 0);
			if (!ret)
				ret = -EPIPE;
			break;
		}

195 196
		if (pipe->nrbufs < PIPE_BUFFERS) {
			int newbuf = (pipe->curbuf + pipe->nrbufs) & (PIPE_BUFFERS - 1);
197
			struct pipe_buffer *buf = pipe->bufs + newbuf;
198

199 200 201
			buf->page = spd->pages[page_nr];
			buf->offset = spd->partial[page_nr].offset;
			buf->len = spd->partial[page_nr].len;
202
			buf->private = spd->partial[page_nr].private;
203
			buf->ops = spd->ops;
204 205 206
			if (spd->flags & SPLICE_F_GIFT)
				buf->flags |= PIPE_BUF_FLAG_GIFT;

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

211 212
			if (pipe->inode)
				do_wakeup = 1;
213

214
			if (!--spd->nr_pages)
215
				break;
216
			if (pipe->nrbufs < PIPE_BUFFERS)
217 218 219 220 221
				continue;

			break;
		}

222
		if (spd->flags & SPLICE_F_NONBLOCK) {
223 224 225 226 227
			if (!ret)
				ret = -EAGAIN;
			break;
		}

228 229 230 231 232 233 234
		if (signal_pending(current)) {
			if (!ret)
				ret = -ERESTARTSYS;
			break;
		}

		if (do_wakeup) {
235
			smp_mb();
236 237 238
			if (waitqueue_active(&pipe->wait))
				wake_up_interruptible_sync(&pipe->wait);
			kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
239 240 241
			do_wakeup = 0;
		}

242 243 244
		pipe->waiting_writers++;
		pipe_wait(pipe);
		pipe->waiting_writers--;
245 246
	}

247
	pipe_unlock(pipe);
248

249 250 251 252 253
	if (do_wakeup) {
		smp_mb();
		if (waitqueue_active(&pipe->wait))
			wake_up_interruptible(&pipe->wait);
		kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
254 255
	}

256
	while (page_nr < spd_pages)
257
		spd->spd_release(spd, page_nr++);
258 259 260 261

	return ret;
}

262 263 264 265 266
static void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
{
	page_cache_release(spd->pages[i]);
}

267
static int
268 269 270
__generic_file_splice_read(struct file *in, loff_t *ppos,
			   struct pipe_inode_info *pipe, size_t len,
			   unsigned int flags)
271 272
{
	struct address_space *mapping = in->f_mapping;
F
Fengguang Wu 已提交
273
	unsigned int loff, nr_pages, req_pages;
274
	struct page *pages[PIPE_BUFFERS];
275
	struct partial_page partial[PIPE_BUFFERS];
276
	struct page *page;
277 278
	pgoff_t index, end_index;
	loff_t isize;
279
	int error, page_nr;
280 281 282 283 284
	struct splice_pipe_desc spd = {
		.pages = pages,
		.partial = partial,
		.flags = flags,
		.ops = &page_cache_pipe_buf_ops,
285
		.spd_release = spd_release_page,
286
	};
287

288
	index = *ppos >> PAGE_CACHE_SHIFT;
289
	loff = *ppos & ~PAGE_CACHE_MASK;
F
Fengguang Wu 已提交
290 291
	req_pages = (len + loff + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
	nr_pages = min(req_pages, (unsigned)PIPE_BUFFERS);
292

293 294 295 296
	/*
	 * Lookup the (hopefully) full range of pages we need.
	 */
	spd.nr_pages = find_get_pages_contig(mapping, index, nr_pages, pages);
297
	index += spd.nr_pages;
298

299 300
	/*
	 * If find_get_pages_contig() returned fewer pages than we needed,
301
	 * readahead/allocate the rest and fill in the holes.
302
	 */
303
	if (spd.nr_pages < nr_pages)
304 305
		page_cache_sync_readahead(mapping, &in->f_ra, in,
				index, req_pages - spd.nr_pages);
306

307
	error = 0;
308
	while (spd.nr_pages < nr_pages) {
309
		/*
310 311
		 * Page could be there, find_get_pages_contig() breaks on
		 * the first hole.
312
		 */
313 314 315
		page = find_get_page(mapping, index);
		if (!page) {
			/*
316
			 * page didn't exist, allocate one.
317 318 319 320 321 322
			 */
			page = page_cache_alloc_cold(mapping);
			if (!page)
				break;

			error = add_to_page_cache_lru(page, mapping, index,
H
Hugh Dickins 已提交
323
						mapping_gfp_mask(mapping));
324 325
			if (unlikely(error)) {
				page_cache_release(page);
326 327
				if (error == -EEXIST)
					continue;
328 329
				break;
			}
330 331 332 333 334
			/*
			 * add_to_page_cache() locks the page, unlock it
			 * to avoid convoluting the logic below even more.
			 */
			unlock_page(page);
335 336
		}

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
		pages[spd.nr_pages++] = page;
		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);
		page = pages[page_nr];

360
		if (PageReadahead(page))
361
			page_cache_async_readahead(mapping, &in->f_ra, in,
F
Fengguang Wu 已提交
362
					page, index, req_pages - page_nr);
363

364 365 366 367
		/*
		 * If the page isn't uptodate, we may need to start io on it
		 */
		if (!PageUptodate(page)) {
368 369 370 371
			/*
			 * If in nonblock mode then dont block on waiting
			 * for an in-flight io page
			 */
372
			if (flags & SPLICE_F_NONBLOCK) {
N
Nick Piggin 已提交
373
				if (!trylock_page(page)) {
374
					error = -EAGAIN;
375
					break;
376
				}
377 378
			} else
				lock_page(page);
379 380

			/*
381 382 383 384
			 * 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.
385 386 387
			 */
			if (!page->mapping) {
				unlock_page(page);
388 389 390 391 392 393 394 395 396
				page = find_or_create_page(mapping, index,
						mapping_gfp_mask(mapping));

				if (!page) {
					error = -ENOMEM;
					break;
				}
				page_cache_release(pages[page_nr]);
				pages[page_nr] = page;
397 398 399 400 401 402 403 404
			}
			/*
			 * page was already under io and is now done, great
			 */
			if (PageUptodate(page)) {
				unlock_page(page);
				goto fill_it;
			}
405

406 407 408 409
			/*
			 * need to read in the page
			 */
			error = mapping->a_ops->readpage(in, page);
410
			if (unlikely(error)) {
411 412 413 414 415 416
				/*
				 * 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.
				 */
417
				if (error == AOP_TRUNCATED_PAGE)
418 419
					error = 0;

420 421
				break;
			}
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
		}
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;
438 439

			/*
440
			 * max good bytes in this page
441
			 */
442 443
			plen = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
			if (plen <= loff)
444 445 446
				break;

			/*
447
			 * force quit after adding this page
448
			 */
449 450
			this_len = min(this_len, plen - loff);
			len = this_len;
451
		}
452

453 454
		partial[page_nr].offset = loff;
		partial[page_nr].len = this_len;
455
		len -= this_len;
456
		loff = 0;
457 458
		spd.nr_pages++;
		index++;
459 460
	}

461
	/*
462
	 * Release any pages at the end, if we quit early. 'page_nr' is how far
463 464 465 466
	 * we got, 'nr_pages' is how many pages are in the map.
	 */
	while (page_nr < nr_pages)
		page_cache_release(pages[page_nr++]);
467
	in->f_ra.prev_pos = (loff_t)index << PAGE_CACHE_SHIFT;
468

469
	if (spd.nr_pages)
470
		return splice_to_pipe(pipe, &spd);
471

472
	return error;
473 474
}

475 476 477
/**
 * generic_file_splice_read - splice data from file to a pipe
 * @in:		file to splice from
478
 * @ppos:	position in @in
479 480 481 482
 * @pipe:	pipe to splice to
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
483 484 485 486 487
 * 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.
 *
488
 */
489 490 491
ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
				 struct pipe_inode_info *pipe, size_t len,
				 unsigned int flags)
492
{
493
	loff_t isize, left;
494
	int ret;
495 496 497 498 499 500 501 502

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

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

504 505
	ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
	if (ret > 0)
506
		*ppos += ret;
507 508 509 510

	return ret;
}

511 512
EXPORT_SYMBOL(generic_file_splice_read);

513
/*
514
 * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
J
Jens Axboe 已提交
515
 * using sendpage(). Return the number of bytes sent.
516
 */
517
static int pipe_to_sendpage(struct pipe_inode_info *pipe,
518 519
			    struct pipe_buffer *buf, struct splice_desc *sd)
{
520
	struct file *file = sd->u.file;
521
	loff_t pos = sd->pos;
522
	int ret, more;
523

524
	ret = buf->ops->confirm(pipe, buf);
525 526
	if (!ret) {
		more = (sd->flags & SPLICE_F_MORE) || sd->len < sd->total_len;
527

528 529 530
		ret = file->f_op->sendpage(file, buf->page, buf->offset,
					   sd->len, &pos, more);
	}
531

J
Jens Axboe 已提交
532
	return ret;
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
}

/*
 * 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.
 *
548 549 550 551 552 553
 * 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.
554
 */
555 556
int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
		 struct splice_desc *sd)
557
{
558
	struct file *file = sd->u.file;
559
	struct address_space *mapping = file->f_mapping;
J
Jens Axboe 已提交
560
	unsigned int offset, this_len;
561
	struct page *page;
562
	void *fsdata;
563
	int ret;
564 565

	/*
566
	 * make sure the data in this buffer is uptodate
567
	 */
568
	ret = buf->ops->confirm(pipe, buf);
569 570
	if (unlikely(ret))
		return ret;
571 572 573

	offset = sd->pos & ~PAGE_CACHE_MASK;

J
Jens Axboe 已提交
574 575 576 577
	this_len = sd->len;
	if (this_len + offset > PAGE_CACHE_SIZE)
		this_len = PAGE_CACHE_SIZE - offset;

578 579 580 581
	ret = pagecache_write_begin(file, mapping, sd->pos, this_len,
				AOP_FLAG_UNINTERRUPTIBLE, &page, &fsdata);
	if (unlikely(ret))
		goto out;
582

583
	if (buf->page != page) {
584 585 586
		/*
		 * Careful, ->map() uses KM_USER0!
		 */
587
		char *src = buf->ops->map(pipe, buf, 1);
588
		char *dst = kmap_atomic(page, KM_USER1);
589

J
Jens Axboe 已提交
590
		memcpy(dst + offset, src + buf->offset, this_len);
591
		flush_dcache_page(page);
592
		kunmap_atomic(dst, KM_USER1);
593
		buf->ops->unmap(pipe, buf, src);
594
	}
595 596
	ret = pagecache_write_end(file, mapping, sd->pos, this_len, this_len,
				page, fsdata);
597 598 599
out:
	return ret;
}
600
EXPORT_SYMBOL(pipe_to_file);
601

602 603 604 605 606 607 608 609
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);
}

610
/**
611
 * splice_from_pipe_feed - feed available data from a pipe to a file
612 613 614 615 616
 * @pipe:	pipe to splice from
 * @sd:		information to @actor
 * @actor:	handler that splices the data
 *
 * Description:
617 618 619 620 621 622 623
 *    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.
624
 *
625 626 627 628
 *    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.
629
 */
630 631
int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
			  splice_actor *actor)
632
{
633
	int ret;
634

635 636 637
	while (pipe->nrbufs) {
		struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
		const struct pipe_buf_operations *ops = buf->ops;
638

639 640 641
		sd->len = buf->len;
		if (sd->len > sd->total_len)
			sd->len = sd->total_len;
642

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
		ret = actor(pipe, buf, sd);
		if (ret <= 0) {
			if (ret == -ENODATA)
				ret = 0;
			return ret;
		}
		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);
			pipe->curbuf = (pipe->curbuf + 1) & (PIPE_BUFFERS - 1);
			pipe->nrbufs--;
			if (pipe->inode)
				sd->need_wakeup = true;
		}
665

666 667 668
		if (!sd->total_len)
			return 0;
	}
669

670 671 672
	return 1;
}
EXPORT_SYMBOL(splice_from_pipe_feed);
673

674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
/**
 * 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 已提交
689

690 691
		if (!pipe->waiting_writers && sd->num_spliced)
			return 0;
I
Ingo Molnar 已提交
692

693 694
		if (sd->flags & SPLICE_F_NONBLOCK)
			return -EAGAIN;
695

696 697
		if (signal_pending(current))
			return -ERESTARTSYS;
698

699 700 701
		if (sd->need_wakeup) {
			wakeup_pipe_writers(pipe);
			sd->need_wakeup = false;
702 703
		}

704 705
		pipe_wait(pipe);
	}
706

707 708 709
	return 1;
}
EXPORT_SYMBOL(splice_from_pipe_next);
710

711 712
/**
 * splice_from_pipe_begin - start splicing from pipe
713
 * @sd:		information about the splice operation
714 715 716 717 718 719 720 721 722 723 724 725
 *
 * 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);
726

727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
/**
 * 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);
743

744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
/**
 * __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;
761

762 763 764 765 766 767 768 769 770
	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;
771
}
M
Mark Fasheh 已提交
772
EXPORT_SYMBOL(__splice_from_pipe);
773

774 775 776 777 778 779 780 781 782 783
/**
 * 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:
784
 *    See __splice_from_pipe. This function locks the pipe inode,
785 786 787
 *    otherwise it's identical to __splice_from_pipe().
 *
 */
788 789 790 791 792
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 已提交
793 794 795 796
	struct splice_desc sd = {
		.total_len = len,
		.flags = flags,
		.pos = *ppos,
797
		.u.file = out,
J
Jens Axboe 已提交
798
	};
799

800
	pipe_lock(pipe);
J
Jens Axboe 已提交
801
	ret = __splice_from_pipe(pipe, &sd, actor);
802
	pipe_unlock(pipe);
803 804 805 806

	return ret;
}

807 808
/**
 * generic_file_splice_write - splice data from a pipe to a file
809
 * @pipe:	pipe info
810
 * @out:	file to write to
811
 * @ppos:	position in @out
812 813 814
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
815 816 817
 * Description:
 *    Will either move or copy pages (determined by @flags options) from
 *    the given pipe inode to the given file.
818 819
 *
 */
820 821
ssize_t
generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
822
			  loff_t *ppos, size_t len, unsigned int flags)
823
{
824
	struct address_space *mapping = out->f_mapping;
825
	struct inode *inode = mapping->host;
826 827 828 829 830 831
	struct splice_desc sd = {
		.total_len = len,
		.flags = flags,
		.pos = *ppos,
		.u.file = out,
	};
832 833
	ssize_t ret;

834
	pipe_lock(pipe);
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849

	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);
		if (!ret)
			ret = splice_from_pipe_feed(pipe, &sd, pipe_to_file);
		mutex_unlock(&inode->i_mutex);
	} while (ret > 0);
	splice_from_pipe_end(pipe, &sd);

850
	pipe_unlock(pipe);
851 852 853 854

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

J
Jens Axboe 已提交
855
	if (ret > 0) {
856 857
		unsigned long nr_pages;

J
Jens Axboe 已提交
858
		*ppos += ret;
859
		nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
J
Jens Axboe 已提交
860 861 862 863 864 865

		/*
		 * If file or inode is SYNC and we actually wrote some data,
		 * sync it.
		 */
		if (unlikely((out->f_flags & O_SYNC) || IS_SYNC(inode))) {
866 867
			int err;

J
Jens Axboe 已提交
868 869 870 871
			mutex_lock(&inode->i_mutex);
			err = generic_osync_inode(inode, mapping,
						  OSYNC_METADATA|OSYNC_DATA);
			mutex_unlock(&inode->i_mutex);
872

J
Jens Axboe 已提交
873 874 875
			if (err)
				ret = err;
		}
876
		balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
877 878 879
	}

	return ret;
880 881
}

882 883
EXPORT_SYMBOL(generic_file_splice_write);

884 885
/**
 * generic_splice_sendpage - splice data from a pipe to a socket
886
 * @pipe:	pipe to splice from
887
 * @out:	socket to write to
888
 * @ppos:	position in @out
889 890 891
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
892 893 894
 * Description:
 *    Will send @len bytes from the pipe to a network socket. No data copying
 *    is involved.
895 896
 *
 */
897
ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
898
				loff_t *ppos, size_t len, unsigned int flags)
899
{
900
	return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
901 902
}

903
EXPORT_SYMBOL(generic_splice_sendpage);
J
Jeff Garzik 已提交
904

905 906 907
/*
 * Attempt to initiate a splice from pipe to file.
 */
908
static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
909
			   loff_t *ppos, size_t len, unsigned int flags)
910 911 912
{
	int ret;

913
	if (unlikely(!out->f_op || !out->f_op->splice_write))
914 915
		return -EINVAL;

916
	if (unlikely(!(out->f_mode & FMODE_WRITE)))
917 918
		return -EBADF;

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

922
	ret = rw_verify_area(WRITE, out, ppos, len);
923 924 925
	if (unlikely(ret < 0))
		return ret;

926
	return out->f_op->splice_write(pipe, out, ppos, len, flags);
927 928
}

929 930 931
/*
 * Attempt to initiate a splice from a file to a pipe.
 */
932 933 934
static long do_splice_to(struct file *in, loff_t *ppos,
			 struct pipe_inode_info *pipe, size_t len,
			 unsigned int flags)
935 936 937
{
	int ret;

938
	if (unlikely(!in->f_op || !in->f_op->splice_read))
939 940
		return -EINVAL;

941
	if (unlikely(!(in->f_mode & FMODE_READ)))
942 943
		return -EBADF;

944
	ret = rw_verify_area(READ, in, ppos, len);
945 946 947
	if (unlikely(ret < 0))
		return ret;

948
	return in->f_op->splice_read(in, ppos, pipe, len, flags);
949 950
}

951 952 953 954 955 956 957 958 959
/**
 * 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 已提交
960
 *    pipe is cached in the process, and reused during the lifetime of
961 962
 *    that process.
 *
J
Jens Axboe 已提交
963 964 965
 */
ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
			       splice_direct_actor *actor)
966 967 968 969
{
	struct pipe_inode_info *pipe;
	long ret, bytes;
	umode_t i_mode;
J
Jens Axboe 已提交
970 971
	size_t len;
	int i, flags;
972 973 974 975 976 977

	/*
	 * 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!
	 */
978
	i_mode = in->f_path.dentry->d_inode->i_mode;
979 980 981 982 983 984 985 986
	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;
987
	if (unlikely(!pipe)) {
988 989 990 991 992 993
		pipe = alloc_pipe_info(NULL);
		if (!pipe)
			return -ENOMEM;

		/*
		 * We don't have an immediate reader, but we'll read the stuff
994
		 * out of the pipe right after the splice_to_pipe(). So set
995 996 997 998 999 1000 1001 1002
		 * PIPE_READERS appropriately.
		 */
		pipe->readers = 1;

		current->splice_pipe = pipe;
	}

	/*
I
Ingo Molnar 已提交
1003
	 * Do the splice.
1004 1005 1006
	 */
	ret = 0;
	bytes = 0;
J
Jens Axboe 已提交
1007 1008 1009 1010 1011 1012 1013
	len = sd->total_len;
	flags = sd->flags;

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

	while (len) {
1016
		size_t read_len;
1017
		loff_t pos = sd->pos, prev_pos = pos;
1018

1019
		ret = do_splice_to(in, &pos, pipe, len, flags);
1020
		if (unlikely(ret <= 0))
1021 1022 1023
			goto out_release;

		read_len = ret;
J
Jens Axboe 已提交
1024
		sd->total_len = read_len;
1025 1026 1027 1028 1029 1030

		/*
		 * 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 已提交
1031
		ret = actor(pipe, sd);
1032 1033
		if (unlikely(ret <= 0)) {
			sd->pos = prev_pos;
1034
			goto out_release;
1035
		}
1036 1037 1038

		bytes += ret;
		len -= ret;
1039
		sd->pos = pos;
1040

1041 1042
		if (ret < read_len) {
			sd->pos = prev_pos + ret;
1043
			goto out_release;
1044
		}
1045 1046
	}

1047
done:
1048
	pipe->nrbufs = pipe->curbuf = 0;
1049
	file_accessed(in);
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
	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;
		}
	}

1066 1067
	if (!bytes)
		bytes = ret;
J
Jens Axboe 已提交
1068

1069
	goto done;
J
Jens Axboe 已提交
1070 1071 1072 1073 1074 1075
}
EXPORT_SYMBOL(splice_direct_to_actor);

static int direct_splice_actor(struct pipe_inode_info *pipe,
			       struct splice_desc *sd)
{
1076
	struct file *file = sd->u.file;
J
Jens Axboe 已提交
1077 1078 1079 1080

	return do_splice_from(pipe, file, &sd->pos, sd->total_len, sd->flags);
}

1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
/**
 * do_splice_direct - splices data directly between two files
 * @in:		file to splice from
 * @ppos:	input file offset
 * @out:	file to splice to
 * @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 已提交
1096 1097 1098 1099 1100 1101 1102 1103
long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
		      size_t len, unsigned int flags)
{
	struct splice_desc sd = {
		.len		= len,
		.total_len	= len,
		.flags		= flags,
		.pos		= *ppos,
1104
		.u.file		= out,
J
Jens Axboe 已提交
1105
	};
1106
	long ret;
J
Jens Axboe 已提交
1107 1108

	ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
1109
	if (ret > 0)
1110
		*ppos = sd.pos;
1111

J
Jens Axboe 已提交
1112
	return ret;
1113 1114
}

1115 1116 1117
static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
			       struct pipe_inode_info *opipe,
			       size_t len, unsigned int flags);
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
/*
 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
 * location, so checking ->i_pipe is not enough to verify that this is a
 * pipe.
 */
static inline struct pipe_inode_info *pipe_info(struct inode *inode)
{
	if (S_ISFIFO(inode->i_mode))
		return inode->i_pipe;

	return NULL;
}

1131 1132 1133
/*
 * Determine where to splice to/from.
 */
1134 1135 1136
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)
1137
{
1138 1139
	struct pipe_inode_info *ipipe;
	struct pipe_inode_info *opipe;
1140
	loff_t offset, *off;
J
Jens Axboe 已提交
1141
	long ret;
1142

1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
	ipipe = pipe_info(in->f_path.dentry->d_inode);
	opipe = pipe_info(out->f_path.dentry->d_inode);

	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) {
1164 1165
		if (off_in)
			return -ESPIPE;
1166 1167 1168
		if (off_out) {
			if (out->f_op->llseek == no_llseek)
				return -EINVAL;
1169
			if (copy_from_user(&offset, off_out, sizeof(loff_t)))
1170
				return -EFAULT;
1171 1172 1173
			off = &offset;
		} else
			off = &out->f_pos;
1174

1175
		ret = do_splice_from(ipipe, out, off, len, flags);
J
Jens Axboe 已提交
1176 1177 1178 1179 1180

		if (off_out && copy_to_user(off_out, off, sizeof(loff_t)))
			ret = -EFAULT;

		return ret;
1181
	}
1182

1183
	if (opipe) {
1184 1185
		if (off_out)
			return -ESPIPE;
1186 1187 1188
		if (off_in) {
			if (in->f_op->llseek == no_llseek)
				return -EINVAL;
1189
			if (copy_from_user(&offset, off_in, sizeof(loff_t)))
1190
				return -EFAULT;
1191 1192 1193
			off = &offset;
		} else
			off = &in->f_pos;
1194

1195
		ret = do_splice_to(in, off, opipe, len, flags);
J
Jens Axboe 已提交
1196 1197 1198 1199 1200

		if (off_in && copy_to_user(off_in, off, sizeof(loff_t)))
			ret = -EFAULT;

		return ret;
1201
	}
1202 1203 1204 1205

	return -EINVAL;
}

1206 1207 1208 1209 1210 1211 1212 1213 1214
/*
 * 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,
1215
				struct partial_page *partial, int aligned)
1216 1217 1218 1219 1220
{
	int buffers = 0, error = 0;

	while (nr_vecs) {
		unsigned long off, npages;
1221
		struct iovec entry;
1222 1223 1224 1225
		void __user *base;
		size_t len;
		int i;

1226
		error = -EFAULT;
N
Nick Piggin 已提交
1227
		if (copy_from_user(&entry, iov, sizeof(entry)))
1228 1229
			break;

1230 1231 1232
		base = entry.iov_base;
		len = entry.iov_len;

1233 1234 1235
		/*
		 * Sanity check this iovec. 0 read succeeds.
		 */
1236
		error = 0;
1237 1238 1239
		if (unlikely(!len))
			break;
		error = -EFAULT;
1240
		if (!access_ok(VERIFY_READ, base, len))
1241 1242 1243 1244 1245 1246 1247
			break;

		/*
		 * Get this base offset and number of pages, then map
		 * in the user pages.
		 */
		off = (unsigned long) base & ~PAGE_MASK;
1248 1249 1250 1251 1252 1253 1254 1255 1256

		/*
		 * 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;

1257 1258 1259 1260
		npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
		if (npages > PIPE_BUFFERS - buffers)
			npages = PIPE_BUFFERS - buffers;

N
Nick Piggin 已提交
1261 1262
		error = get_user_pages_fast((unsigned long)base, npages,
					0, &pages[buffers]);
1263 1264 1265 1266 1267 1268 1269 1270

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

		/*
		 * Fill this contiguous range into the partial page map.
		 */
		for (i = 0; i < error; i++) {
1271
			const int plen = min_t(size_t, len, PAGE_SIZE - off);
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306

			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.
		 */
		if (error < npages || buffers == PIPE_BUFFERS)
			break;

		nr_vecs--;
		iov++;
	}

	if (buffers)
		return buffers;

	return error;
}

1307 1308 1309 1310 1311 1312
static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
			struct splice_desc *sd)
{
	char *src;
	int ret;

1313
	ret = buf->ops->confirm(pipe, buf);
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
	if (unlikely(ret))
		return ret;

	/*
	 * See if we can use the atomic maps, by prefaulting in the
	 * pages and doing an atomic copy
	 */
	if (!fault_in_pages_writeable(sd->u.userptr, sd->len)) {
		src = buf->ops->map(pipe, buf, 1);
		ret = __copy_to_user_inatomic(sd->u.userptr, src + buf->offset,
							sd->len);
		buf->ops->unmap(pipe, buf, src);
		if (!ret) {
			ret = sd->len;
			goto out;
		}
	}

	/*
	 * No dice, use slow non-atomic map and copy
 	 */
	src = buf->ops->map(pipe, buf, 0);

	ret = sd->len;
	if (copy_to_user(sd->u.userptr, src + buf->offset, sd->len))
		ret = -EFAULT;

1341
	buf->ops->unmap(pipe, buf, src);
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
out:
	if (ret > 0)
		sd->u.userptr += ret;
	return ret;
}

/*
 * For lack of a better implementation, implement vmsplice() to userspace
 * as a simple copy of the pipes pages to the user iov.
 */
static long vmsplice_to_user(struct file *file, const struct iovec __user *iov,
			     unsigned long nr_segs, unsigned int flags)
{
	struct pipe_inode_info *pipe;
	struct splice_desc sd;
	ssize_t size;
	int error;
	long ret;

	pipe = pipe_info(file->f_path.dentry->d_inode);
	if (!pipe)
		return -EBADF;

1365
	pipe_lock(pipe);
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391

	error = ret = 0;
	while (nr_segs) {
		void __user *base;
		size_t len;

		/*
		 * Get user address base and length for this iovec.
		 */
		error = get_user(base, &iov->iov_base);
		if (unlikely(error))
			break;
		error = get_user(len, &iov->iov_len);
		if (unlikely(error))
			break;

		/*
		 * Sanity check this iovec. 0 read succeeds.
		 */
		if (unlikely(!len))
			break;
		if (unlikely(!base)) {
			error = -EFAULT;
			break;
		}

1392 1393 1394 1395 1396
		if (unlikely(!access_ok(VERIFY_WRITE, base, len))) {
			error = -EFAULT;
			break;
		}

1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
		sd.len = 0;
		sd.total_len = len;
		sd.flags = flags;
		sd.u.userptr = base;
		sd.pos = 0;

		size = __splice_from_pipe(pipe, &sd, pipe_to_user);
		if (size < 0) {
			if (!ret)
				ret = size;

			break;
		}

		ret += size;

		if (size < len)
			break;

		nr_segs--;
		iov++;
	}

1420
	pipe_unlock(pipe);
1421 1422 1423 1424 1425 1426 1427

	if (!ret)
		ret = error;

	return ret;
}

1428 1429 1430 1431 1432
/*
 * 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.
 */
1433 1434
static long vmsplice_to_pipe(struct file *file, const struct iovec __user *iov,
			     unsigned long nr_segs, unsigned int flags)
1435
{
1436
	struct pipe_inode_info *pipe;
1437 1438 1439 1440 1441 1442 1443
	struct page *pages[PIPE_BUFFERS];
	struct partial_page partial[PIPE_BUFFERS];
	struct splice_pipe_desc spd = {
		.pages = pages,
		.partial = partial,
		.flags = flags,
		.ops = &user_page_pipe_buf_ops,
1444
		.spd_release = spd_release_page,
1445 1446
	};

1447
	pipe = pipe_info(file->f_path.dentry->d_inode);
1448
	if (!pipe)
1449 1450
		return -EBADF;

1451 1452
	spd.nr_pages = get_iovec_page_array(iov, nr_segs, pages, partial,
					    flags & SPLICE_F_GIFT);
1453 1454 1455
	if (spd.nr_pages <= 0)
		return spd.nr_pages;

1456
	return splice_to_pipe(pipe, &spd);
1457 1458
}

1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
/*
 * 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().
 *
 */
1475 1476
SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
		unsigned long, nr_segs, unsigned int, flags)
1477 1478 1479 1480 1481
{
	struct file *file;
	long error;
	int fput;

1482 1483 1484 1485 1486
	if (unlikely(nr_segs > UIO_MAXIOV))
		return -EINVAL;
	else if (unlikely(!nr_segs))
		return 0;

1487 1488 1489 1490
	error = -EBADF;
	file = fget_light(fd, &fput);
	if (file) {
		if (file->f_mode & FMODE_WRITE)
1491 1492 1493
			error = vmsplice_to_pipe(file, iov, nr_segs, flags);
		else if (file->f_mode & FMODE_READ)
			error = vmsplice_to_user(file, iov, nr_segs, flags);
1494 1495 1496 1497 1498 1499 1500

		fput_light(file, fput);
	}

	return error;
}

1501 1502 1503
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)
1504 1505 1506 1507 1508 1509 1510 1511 1512
{
	long error;
	struct file *in, *out;
	int fput_in, fput_out;

	if (unlikely(!len))
		return 0;

	error = -EBADF;
1513
	in = fget_light(fd_in, &fput_in);
1514 1515
	if (in) {
		if (in->f_mode & FMODE_READ) {
1516
			out = fget_light(fd_out, &fput_out);
1517 1518
			if (out) {
				if (out->f_mode & FMODE_WRITE)
1519 1520 1521
					error = do_splice(in, off_in,
							  out, off_out,
							  len, flags);
1522 1523 1524 1525 1526 1527 1528 1529 1530
				fput_light(out, fput_out);
			}
		}

		fput_light(in, fput_in);
	}

	return error;
}
1531

1532 1533 1534 1535
/*
 * Make sure there's data to read. Wait for input if we can, otherwise
 * return an appropriate error.
 */
1536
static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
{
	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;
1548
	pipe_lock(pipe);
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565

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

1566
	pipe_unlock(pipe);
1567 1568 1569 1570 1571 1572 1573
	return ret;
}

/*
 * Make sure there's writeable room. Wait for room if we can, otherwise
 * return an appropriate error.
 */
1574
static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
{
	int ret;

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

	ret = 0;
1586
	pipe_lock(pipe);
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606

	while (pipe->nrbufs >= PIPE_BUFFERS) {
		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--;
	}

1607
	pipe_unlock(pipe);
1608 1609 1610
	return ret;
}

1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
/*
 * 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.
		 */
		if (!ipipe->nrbufs || opipe->nrbufs >= PIPE_BUFFERS) {
			/* 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;
		nbuf = (opipe->curbuf + opipe->nrbufs) % PIPE_BUFFERS;
		obuf = opipe->bufs + nbuf;

		if (len >= ibuf->len) {
			/*
			 * Simply move the whole buffer from ipipe to opipe
			 */
			*obuf = *ibuf;
			ibuf->ops = NULL;
			opipe->nrbufs++;
			ipipe->curbuf = (ipipe->curbuf + 1) % PIPE_BUFFERS;
			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.
	 */
	if (ret > 0) {
		smp_mb();
		if (waitqueue_active(&opipe->wait))
			wake_up_interruptible(&opipe->wait);
		kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN);
	}
	if (input_wakeup)
		wakeup_pipe_writers(ipipe);

	return ret;
}

1729 1730 1731 1732 1733 1734 1735 1736
/*
 * 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;
1737
	int ret = 0, i = 0, nbuf;
1738 1739 1740

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

1746
	do {
1747 1748 1749 1750 1751 1752 1753
		if (!opipe->readers) {
			send_sig(SIGPIPE, current, 0);
			if (!ret)
				ret = -EPIPE;
			break;
		}

1754 1755 1756 1757 1758 1759
		/*
		 * If we have iterated all input buffers or ran out of
		 * output room, break.
		 */
		if (i >= ipipe->nrbufs || opipe->nrbufs >= PIPE_BUFFERS)
			break;
1760

1761 1762
		ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (PIPE_BUFFERS - 1));
		nbuf = (opipe->curbuf + opipe->nrbufs) & (PIPE_BUFFERS - 1);
1763 1764

		/*
1765 1766
		 * Get a reference to this pipe buffer,
		 * so we can copy the contents over.
1767
		 */
1768 1769 1770 1771 1772
		ibuf->ops->get(ipipe, ibuf);

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

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

1779 1780
		if (obuf->len > len)
			obuf->len = len;
1781

1782 1783 1784 1785 1786
		opipe->nrbufs++;
		ret += obuf->len;
		len -= obuf->len;
		i++;
	} while (len);
1787

1788 1789 1790 1791 1792 1793 1794
	/*
	 * 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;

1795 1796
	pipe_unlock(ipipe);
	pipe_unlock(opipe);
1797

1798 1799 1800 1801
	/*
	 * If we put data in the output pipe, wakeup any potential readers.
	 */
	if (ret > 0) {
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819
		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)
{
1820 1821
	struct pipe_inode_info *ipipe = pipe_info(in->f_path.dentry->d_inode);
	struct pipe_inode_info *opipe = pipe_info(out->f_path.dentry->d_inode);
1822
	int ret = -EINVAL;
1823 1824

	/*
1825 1826
	 * Duplicate the contents of ipipe to opipe without actually
	 * copying the data.
1827
	 */
1828 1829 1830 1831 1832
	if (ipipe && opipe && ipipe != opipe) {
		/*
		 * Keep going, unless we encounter an error. The ipipe/opipe
		 * ordering doesn't really matter.
		 */
1833
		ret = ipipe_prep(ipipe, flags);
1834
		if (!ret) {
1835
			ret = opipe_prep(opipe, flags);
1836
			if (!ret)
1837 1838 1839
				ret = link_pipe(ipipe, opipe, len, flags);
		}
	}
1840

1841
	return ret;
1842 1843
}

1844
SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869
{
	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;
}