splice.c 41.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
 * 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 186
	if (pipe->inode)
		mutex_lock(&pipe->inode->i_mutex);
187 188

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

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

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

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

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

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

			break;
		}

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

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

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

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

248
	if (pipe->inode) {
249
		mutex_unlock(&pipe->inode->i_mutex);
250

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

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

	return ret;
}

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

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

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

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

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

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

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

340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
		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];

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

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

			/*
384 385 386 387
			 * 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.
388 389 390
			 */
			if (!page->mapping) {
				unlock_page(page);
391 392 393 394 395 396 397 398 399
				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;
400 401 402 403 404 405 406 407
			}
			/*
			 * page was already under io and is now done, great
			 */
			if (PageUptodate(page)) {
				unlock_page(page);
				goto fill_it;
			}
408

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

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

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

			/*
450
			 * force quit after adding this page
451
			 */
452 453
			this_len = min(this_len, plen - loff);
			len = this_len;
454
		}
455

456 457
		partial[page_nr].offset = loff;
		partial[page_nr].len = this_len;
458
		len -= this_len;
459
		loff = 0;
460 461
		spd.nr_pages++;
		index++;
462 463
	}

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

472
	if (spd.nr_pages)
473
		return splice_to_pipe(pipe, &spd);
474

475
	return error;
476 477
}

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

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

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

507 508
	ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
	if (ret > 0)
509
		*ppos += ret;
510 511 512 513

	return ret;
}

514 515
EXPORT_SYMBOL(generic_file_splice_read);

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

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

531 532 533
		ret = file->f_op->sendpage(file, buf->page, buf->offset,
					   sd->len, &pos, more);
	}
534

J
Jens Axboe 已提交
535
	return ret;
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
}

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

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

	offset = sd->pos & ~PAGE_CACHE_MASK;

J
Jens Axboe 已提交
577 578 579 580
	this_len = sd->len;
	if (this_len + offset > PAGE_CACHE_SIZE)
		this_len = PAGE_CACHE_SIZE - offset;

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

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

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

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

612
/**
613
 * splice_from_pipe_feed - feed available data from a pipe to a file
614 615 616 617 618
 * @pipe:	pipe to splice from
 * @sd:		information to @actor
 * @actor:	handler that splices the data
 *
 * Description:
619 620 621 622 623 624 625 626

 *    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.
627
 *
628 629 630 631
 *    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.
632
 */
633 634
int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
			  splice_actor *actor)
635
{
636
	int ret;
637

638 639 640
	while (pipe->nrbufs) {
		struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
		const struct pipe_buf_operations *ops = buf->ops;
641

642 643 644
		sd->len = buf->len;
		if (sd->len > sd->total_len)
			sd->len = sd->total_len;
645

646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
		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;
		}
668

669 670 671
		if (!sd->total_len)
			return 0;
	}
672

673 674 675
	return 1;
}
EXPORT_SYMBOL(splice_from_pipe_feed);
676

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

693 694
		if (!pipe->waiting_writers && sd->num_spliced)
			return 0;
I
Ingo Molnar 已提交
695

696 697
		if (sd->flags & SPLICE_F_NONBLOCK)
			return -EAGAIN;
698

699 700
		if (signal_pending(current))
			return -ERESTARTSYS;
701

702 703 704
		if (sd->need_wakeup) {
			wakeup_pipe_writers(pipe);
			sd->need_wakeup = false;
705 706
		}

707 708
		pipe_wait(pipe);
	}
709

710 711 712
	return 1;
}
EXPORT_SYMBOL(splice_from_pipe_next);
713

714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
/**
 * splice_from_pipe_begin - start splicing from pipe
 * @pipe:	pipe to splice from
 *
 * 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);
729

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

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

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

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

803
	if (pipe->inode)
804
		mutex_lock(&pipe->inode->i_mutex);
J
Jens Axboe 已提交
805
	ret = __splice_from_pipe(pipe, &sd, actor);
806 807
	if (pipe->inode)
		mutex_unlock(&pipe->inode->i_mutex);
808 809 810 811 812 813 814 815

	return ret;
}

/**
 * generic_file_splice_write_nolock - generic_file_splice_write without mutexes
 * @pipe:	pipe info
 * @out:	file to write to
816
 * @ppos:	position in @out
817 818 819
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
820 821 822 823
 * Description:
 *    Will either move or copy pages (determined by @flags options) from
 *    the given pipe inode to the given file. The caller is responsible
 *    for acquiring i_mutex on both inodes.
824 825 826 827 828 829 830 831
 *
 */
ssize_t
generic_file_splice_write_nolock(struct pipe_inode_info *pipe, struct file *out,
				 loff_t *ppos, size_t len, unsigned int flags)
{
	struct address_space *mapping = out->f_mapping;
	struct inode *inode = mapping->host;
J
Jens Axboe 已提交
832 833 834 835
	struct splice_desc sd = {
		.total_len = len,
		.flags = flags,
		.pos = *ppos,
836
		.u.file = out,
J
Jens Axboe 已提交
837
	};
838 839 840
	ssize_t ret;
	int err;

841
	err = file_remove_suid(out);
842 843 844
	if (unlikely(err))
		return err;

J
Jens Axboe 已提交
845
	ret = __splice_from_pipe(pipe, &sd, pipe_to_file);
846
	if (ret > 0) {
847 848
		unsigned long nr_pages;

849
		*ppos += ret;
850
		nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
851 852 853 854 855 856 857 858 859 860 861 862

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

			if (err)
				ret = err;
		}
863
		balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
864 865 866 867 868 869 870
	}

	return ret;
}

EXPORT_SYMBOL(generic_file_splice_write_nolock);

871 872
/**
 * generic_file_splice_write - splice data from a pipe to a file
873
 * @pipe:	pipe info
874
 * @out:	file to write to
875
 * @ppos:	position in @out
876 877 878
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
879 880 881
 * Description:
 *    Will either move or copy pages (determined by @flags options) from
 *    the given pipe inode to the given file.
882 883
 *
 */
884 885
ssize_t
generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
886
			  loff_t *ppos, size_t len, unsigned int flags)
887
{
888
	struct address_space *mapping = out->f_mapping;
889
	struct inode *inode = mapping->host;
890 891 892 893 894 895
	struct splice_desc sd = {
		.total_len = len,
		.flags = flags,
		.pos = *ppos,
		.u.file = out,
	};
896 897
	ssize_t ret;

898 899
	WARN_ON(S_ISFIFO(inode->i_mode));
	mutex_lock_nested(&inode->i_mutex, I_MUTEX_PARENT);
900
	ret = file_remove_suid(out);
901 902 903
	if (likely(!ret)) {
		if (pipe->inode)
			mutex_lock_nested(&pipe->inode->i_mutex, I_MUTEX_CHILD);
904
		ret = __splice_from_pipe(pipe, &sd, pipe_to_file);
905 906 907 908
		if (pipe->inode)
			mutex_unlock(&pipe->inode->i_mutex);
	}
	mutex_unlock(&inode->i_mutex);
J
Jens Axboe 已提交
909
	if (ret > 0) {
910 911
		unsigned long nr_pages;

J
Jens Axboe 已提交
912
		*ppos += ret;
913
		nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
J
Jens Axboe 已提交
914 915 916 917 918 919

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

J
Jens Axboe 已提交
922 923 924 925
			mutex_lock(&inode->i_mutex);
			err = generic_osync_inode(inode, mapping,
						  OSYNC_METADATA|OSYNC_DATA);
			mutex_unlock(&inode->i_mutex);
926

J
Jens Axboe 已提交
927 928 929
			if (err)
				ret = err;
		}
930
		balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
931 932 933
	}

	return ret;
934 935
}

936 937
EXPORT_SYMBOL(generic_file_splice_write);

938 939
/**
 * generic_splice_sendpage - splice data from a pipe to a socket
940
 * @pipe:	pipe to splice from
941
 * @out:	socket to write to
942
 * @ppos:	position in @out
943 944 945
 * @len:	number of bytes to splice
 * @flags:	splice modifier flags
 *
946 947 948
 * Description:
 *    Will send @len bytes from the pipe to a network socket. No data copying
 *    is involved.
949 950
 *
 */
951
ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
952
				loff_t *ppos, size_t len, unsigned int flags)
953
{
954
	return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
955 956
}

957
EXPORT_SYMBOL(generic_splice_sendpage);
J
Jeff Garzik 已提交
958

959 960 961
/*
 * Attempt to initiate a splice from pipe to file.
 */
962
static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
963
			   loff_t *ppos, size_t len, unsigned int flags)
964 965 966
{
	int ret;

967
	if (unlikely(!out->f_op || !out->f_op->splice_write))
968 969
		return -EINVAL;

970
	if (unlikely(!(out->f_mode & FMODE_WRITE)))
971 972
		return -EBADF;

973 974 975
	if (unlikely(out->f_flags & O_APPEND))
		return -EINVAL;

976
	ret = rw_verify_area(WRITE, out, ppos, len);
977 978 979
	if (unlikely(ret < 0))
		return ret;

980
	return out->f_op->splice_write(pipe, out, ppos, len, flags);
981 982
}

983 984 985
/*
 * Attempt to initiate a splice from a file to a pipe.
 */
986 987 988
static long do_splice_to(struct file *in, loff_t *ppos,
			 struct pipe_inode_info *pipe, size_t len,
			 unsigned int flags)
989 990 991
{
	int ret;

992
	if (unlikely(!in->f_op || !in->f_op->splice_read))
993 994
		return -EINVAL;

995
	if (unlikely(!(in->f_mode & FMODE_READ)))
996 997
		return -EBADF;

998
	ret = rw_verify_area(READ, in, ppos, len);
999 1000 1001
	if (unlikely(ret < 0))
		return ret;

1002
	return in->f_op->splice_read(in, ppos, pipe, len, flags);
1003 1004
}

1005 1006 1007 1008 1009 1010 1011 1012 1013
/**
 * 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 已提交
1014
 *    pipe is cached in the process, and reused during the lifetime of
1015 1016
 *    that process.
 *
J
Jens Axboe 已提交
1017 1018 1019
 */
ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
			       splice_direct_actor *actor)
1020 1021 1022 1023
{
	struct pipe_inode_info *pipe;
	long ret, bytes;
	umode_t i_mode;
J
Jens Axboe 已提交
1024 1025
	size_t len;
	int i, flags;
1026 1027 1028 1029 1030 1031

	/*
	 * 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!
	 */
1032
	i_mode = in->f_path.dentry->d_inode->i_mode;
1033 1034 1035 1036 1037 1038 1039 1040
	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;
1041
	if (unlikely(!pipe)) {
1042 1043 1044 1045 1046 1047
		pipe = alloc_pipe_info(NULL);
		if (!pipe)
			return -ENOMEM;

		/*
		 * We don't have an immediate reader, but we'll read the stuff
1048
		 * out of the pipe right after the splice_to_pipe(). So set
1049 1050 1051 1052 1053 1054 1055 1056
		 * PIPE_READERS appropriately.
		 */
		pipe->readers = 1;

		current->splice_pipe = pipe;
	}

	/*
I
Ingo Molnar 已提交
1057
	 * Do the splice.
1058 1059 1060
	 */
	ret = 0;
	bytes = 0;
J
Jens Axboe 已提交
1061 1062 1063 1064 1065 1066 1067
	len = sd->total_len;
	flags = sd->flags;

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

	while (len) {
1070
		size_t read_len;
1071
		loff_t pos = sd->pos, prev_pos = pos;
1072

1073
		ret = do_splice_to(in, &pos, pipe, len, flags);
1074
		if (unlikely(ret <= 0))
1075 1076 1077
			goto out_release;

		read_len = ret;
J
Jens Axboe 已提交
1078
		sd->total_len = read_len;
1079 1080 1081 1082 1083 1084

		/*
		 * 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 已提交
1085
		ret = actor(pipe, sd);
1086 1087
		if (unlikely(ret <= 0)) {
			sd->pos = prev_pos;
1088
			goto out_release;
1089
		}
1090 1091 1092

		bytes += ret;
		len -= ret;
1093
		sd->pos = pos;
1094

1095 1096
		if (ret < read_len) {
			sd->pos = prev_pos + ret;
1097
			goto out_release;
1098
		}
1099 1100
	}

1101
done:
1102
	pipe->nrbufs = pipe->curbuf = 0;
1103
	file_accessed(in);
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
	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;
		}
	}

1120 1121
	if (!bytes)
		bytes = ret;
J
Jens Axboe 已提交
1122

1123
	goto done;
J
Jens Axboe 已提交
1124 1125 1126 1127 1128 1129
}
EXPORT_SYMBOL(splice_direct_to_actor);

static int direct_splice_actor(struct pipe_inode_info *pipe,
			       struct splice_desc *sd)
{
1130
	struct file *file = sd->u.file;
J
Jens Axboe 已提交
1131 1132 1133 1134

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

1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
/**
 * 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 已提交
1150 1151 1152 1153 1154 1155 1156 1157
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,
1158
		.u.file		= out,
J
Jens Axboe 已提交
1159
	};
1160
	long ret;
J
Jens Axboe 已提交
1161 1162

	ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
1163
	if (ret > 0)
1164
		*ppos = sd.pos;
1165

J
Jens Axboe 已提交
1166
	return ret;
1167 1168
}

1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
/*
 * 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;
}

1182 1183 1184
/*
 * Determine where to splice to/from.
 */
1185 1186 1187
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)
1188
{
1189
	struct pipe_inode_info *pipe;
1190
	loff_t offset, *off;
J
Jens Axboe 已提交
1191
	long ret;
1192

1193
	pipe = pipe_info(in->f_path.dentry->d_inode);
1194 1195 1196
	if (pipe) {
		if (off_in)
			return -ESPIPE;
1197 1198 1199
		if (off_out) {
			if (out->f_op->llseek == no_llseek)
				return -EINVAL;
1200
			if (copy_from_user(&offset, off_out, sizeof(loff_t)))
1201
				return -EFAULT;
1202 1203 1204
			off = &offset;
		} else
			off = &out->f_pos;
1205

J
Jens Axboe 已提交
1206 1207 1208 1209 1210 1211
		ret = do_splice_from(pipe, out, off, len, flags);

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

		return ret;
1212
	}
1213

1214
	pipe = pipe_info(out->f_path.dentry->d_inode);
1215 1216 1217
	if (pipe) {
		if (off_out)
			return -ESPIPE;
1218 1219 1220
		if (off_in) {
			if (in->f_op->llseek == no_llseek)
				return -EINVAL;
1221
			if (copy_from_user(&offset, off_in, sizeof(loff_t)))
1222
				return -EFAULT;
1223 1224 1225
			off = &offset;
		} else
			off = &in->f_pos;
1226

J
Jens Axboe 已提交
1227 1228 1229 1230 1231 1232
		ret = do_splice_to(in, off, pipe, len, flags);

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

		return ret;
1233
	}
1234 1235 1236 1237

	return -EINVAL;
}

1238 1239 1240 1241 1242 1243 1244 1245 1246
/*
 * 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,
1247
				struct partial_page *partial, int aligned)
1248 1249 1250 1251 1252
{
	int buffers = 0, error = 0;

	while (nr_vecs) {
		unsigned long off, npages;
1253
		struct iovec entry;
1254 1255 1256 1257
		void __user *base;
		size_t len;
		int i;

1258
		error = -EFAULT;
N
Nick Piggin 已提交
1259
		if (copy_from_user(&entry, iov, sizeof(entry)))
1260 1261
			break;

1262 1263 1264
		base = entry.iov_base;
		len = entry.iov_len;

1265 1266 1267
		/*
		 * Sanity check this iovec. 0 read succeeds.
		 */
1268
		error = 0;
1269 1270 1271
		if (unlikely(!len))
			break;
		error = -EFAULT;
1272
		if (!access_ok(VERIFY_READ, base, len))
1273 1274 1275 1276 1277 1278 1279
			break;

		/*
		 * Get this base offset and number of pages, then map
		 * in the user pages.
		 */
		off = (unsigned long) base & ~PAGE_MASK;
1280 1281 1282 1283 1284 1285 1286 1287 1288

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

1289 1290 1291 1292
		npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
		if (npages > PIPE_BUFFERS - buffers)
			npages = PIPE_BUFFERS - buffers;

N
Nick Piggin 已提交
1293 1294
		error = get_user_pages_fast((unsigned long)base, npages,
					0, &pages[buffers]);
1295 1296 1297 1298 1299 1300 1301 1302

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

		/*
		 * Fill this contiguous range into the partial page map.
		 */
		for (i = 0; i < error; i++) {
1303
			const int plen = min_t(size_t, len, PAGE_SIZE - off);
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 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

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

1339 1340 1341 1342 1343 1344
static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
			struct splice_desc *sd)
{
	char *src;
	int ret;

1345
	ret = buf->ops->confirm(pipe, buf);
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
	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;

1373
	buf->ops->unmap(pipe, buf, src);
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
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;

	if (pipe->inode)
		mutex_lock(&pipe->inode->i_mutex);

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

1425 1426 1427 1428 1429
		if (unlikely(!access_ok(VERIFY_WRITE, base, len))) {
			error = -EFAULT;
			break;
		}

1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461
		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++;
	}

	if (pipe->inode)
		mutex_unlock(&pipe->inode->i_mutex);

	if (!ret)
		ret = error;

	return ret;
}

1462 1463 1464 1465 1466
/*
 * 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.
 */
1467 1468
static long vmsplice_to_pipe(struct file *file, const struct iovec __user *iov,
			     unsigned long nr_segs, unsigned int flags)
1469
{
1470
	struct pipe_inode_info *pipe;
1471 1472 1473 1474 1475 1476 1477
	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,
1478
		.spd_release = spd_release_page,
1479 1480
	};

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

1485 1486
	spd.nr_pages = get_iovec_page_array(iov, nr_segs, pages, partial,
					    flags & SPLICE_F_GIFT);
1487 1488 1489
	if (spd.nr_pages <= 0)
		return spd.nr_pages;

1490
	return splice_to_pipe(pipe, &spd);
1491 1492
}

1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
/*
 * 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().
 *
 */
1509 1510
SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
		unsigned long, nr_segs, unsigned int, flags)
1511 1512 1513 1514 1515
{
	struct file *file;
	long error;
	int fput;

1516 1517 1518 1519 1520
	if (unlikely(nr_segs > UIO_MAXIOV))
		return -EINVAL;
	else if (unlikely(!nr_segs))
		return 0;

1521 1522 1523 1524
	error = -EBADF;
	file = fget_light(fd, &fput);
	if (file) {
		if (file->f_mode & FMODE_WRITE)
1525 1526 1527
			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);
1528 1529 1530 1531 1532 1533 1534

		fput_light(file, fput);
	}

	return error;
}

1535 1536 1537
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)
1538 1539 1540 1541 1542 1543 1544 1545 1546
{
	long error;
	struct file *in, *out;
	int fput_in, fput_out;

	if (unlikely(!len))
		return 0;

	error = -EBADF;
1547
	in = fget_light(fd_in, &fput_in);
1548 1549
	if (in) {
		if (in->f_mode & FMODE_READ) {
1550
			out = fget_light(fd_out, &fput_out);
1551 1552
			if (out) {
				if (out->f_mode & FMODE_WRITE)
1553 1554 1555
					error = do_splice(in, off_in,
							  out, off_out,
							  len, flags);
1556 1557 1558 1559 1560 1561 1562 1563 1564
				fput_light(out, fput_out);
			}
		}

		fput_light(in, fput_in);
	}

	return error;
}
1565

1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644
/*
 * Make sure there's data to read. Wait for input if we can, otherwise
 * return an appropriate error.
 */
static int link_ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
{
	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;
	mutex_lock(&pipe->inode->i_mutex);

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

	mutex_unlock(&pipe->inode->i_mutex);
	return ret;
}

/*
 * Make sure there's writeable room. Wait for room if we can, otherwise
 * return an appropriate error.
 */
static int link_opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
{
	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;
	mutex_lock(&pipe->inode->i_mutex);

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

	mutex_unlock(&pipe->inode->i_mutex);
	return ret;
}

1645 1646 1647 1648 1649 1650 1651 1652
/*
 * 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;
1653
	int ret = 0, i = 0, nbuf;
1654 1655 1656 1657 1658 1659

	/*
	 * 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).
	 */
1660
	inode_double_lock(ipipe->inode, opipe->inode);
1661

1662
	do {
1663 1664 1665 1666 1667 1668 1669
		if (!opipe->readers) {
			send_sig(SIGPIPE, current, 0);
			if (!ret)
				ret = -EPIPE;
			break;
		}

1670 1671 1672 1673 1674 1675
		/*
		 * If we have iterated all input buffers or ran out of
		 * output room, break.
		 */
		if (i >= ipipe->nrbufs || opipe->nrbufs >= PIPE_BUFFERS)
			break;
1676

1677 1678
		ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (PIPE_BUFFERS - 1));
		nbuf = (opipe->curbuf + opipe->nrbufs) & (PIPE_BUFFERS - 1);
1679 1680

		/*
1681 1682
		 * Get a reference to this pipe buffer,
		 * so we can copy the contents over.
1683
		 */
1684 1685 1686 1687 1688
		ibuf->ops->get(ipipe, ibuf);

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

1689
		/*
1690 1691
		 * Don't inherit the gift flag, we need to
		 * prevent multiple steals of this page.
1692
		 */
1693
		obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
1694

1695 1696
		if (obuf->len > len)
			obuf->len = len;
1697

1698 1699 1700 1701 1702
		opipe->nrbufs++;
		ret += obuf->len;
		len -= obuf->len;
		i++;
	} while (len);
1703

1704 1705 1706 1707 1708 1709 1710
	/*
	 * 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;

1711
	inode_double_unlock(ipipe->inode, opipe->inode);
1712

1713 1714 1715 1716
	/*
	 * If we put data in the output pipe, wakeup any potential readers.
	 */
	if (ret > 0) {
1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
		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)
{
1735 1736
	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);
1737
	int ret = -EINVAL;
1738 1739

	/*
1740 1741
	 * Duplicate the contents of ipipe to opipe without actually
	 * copying the data.
1742
	 */
1743 1744 1745 1746 1747 1748 1749 1750
	if (ipipe && opipe && ipipe != opipe) {
		/*
		 * Keep going, unless we encounter an error. The ipipe/opipe
		 * ordering doesn't really matter.
		 */
		ret = link_ipipe_prep(ipipe, flags);
		if (!ret) {
			ret = link_opipe_prep(opipe, flags);
1751
			if (!ret)
1752 1753 1754
				ret = link_pipe(ipipe, opipe, len, flags);
		}
	}
1755

1756
	return ret;
1757 1758
}

1759
SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
{
	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;
}