pipe.c 24.8 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 *  linux/fs/pipe.c
 *
 *  Copyright (C) 1991, 1992, 1999  Linus Torvalds
 */

#include <linux/mm.h>
#include <linux/file.h>
#include <linux/poll.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/fs.h>
#include <linux/mount.h>
#include <linux/pipe_fs_i.h>
#include <linux/uio.h>
#include <linux/highmem.h>
18
#include <linux/pagemap.h>
A
Al Viro 已提交
19
#include <linux/audit.h>
20
#include <linux/syscalls.h>
L
Linus Torvalds 已提交
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

#include <asm/uaccess.h>
#include <asm/ioctls.h>

/*
 * We use a start+len construction, which provides full use of the 
 * allocated memory.
 * -- Florian Coosmann (FGC)
 * 
 * Reads with count = 0 should always return 0.
 * -- Julian Bradfield 1999-06-07.
 *
 * FIFOs and Pipes now generate SIGIO for both readers and writers.
 * -- Jeremy Elson <jelson@circlemud.org> 2001-08-16
 *
 * pipe_read & write cleanup
 * -- Manfred Spraul <manfred@colorfullife.com> 2002-05-09
 */

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
static void pipe_lock_nested(struct pipe_inode_info *pipe, int subclass)
{
	if (pipe->inode)
		mutex_lock_nested(&pipe->inode->i_mutex, subclass);
}

void pipe_lock(struct pipe_inode_info *pipe)
{
	/*
	 * pipe_lock() nests non-pipe inode locks (for writing to a file)
	 */
	pipe_lock_nested(pipe, I_MUTEX_PARENT);
}
EXPORT_SYMBOL(pipe_lock);

void pipe_unlock(struct pipe_inode_info *pipe)
{
	if (pipe->inode)
		mutex_unlock(&pipe->inode->i_mutex);
}
EXPORT_SYMBOL(pipe_unlock);

void pipe_double_lock(struct pipe_inode_info *pipe1,
		      struct pipe_inode_info *pipe2)
{
	BUG_ON(pipe1 == pipe2);

	if (pipe1 < pipe2) {
		pipe_lock_nested(pipe1, I_MUTEX_PARENT);
		pipe_lock_nested(pipe2, I_MUTEX_CHILD);
	} else {
		pipe_lock_nested(pipe2, I_MUTEX_CHILD);
		pipe_lock_nested(pipe1, I_MUTEX_PARENT);
	}
}

L
Linus Torvalds 已提交
76
/* Drop the inode semaphore and wait for a pipe event, atomically */
77
void pipe_wait(struct pipe_inode_info *pipe)
L
Linus Torvalds 已提交
78 79 80
{
	DEFINE_WAIT(wait);

I
Ingo Molnar 已提交
81 82 83 84
	/*
	 * Pipes are system-local resources, so sleeping on them
	 * is considered a noninteractive wait:
	 */
85
	prepare_to_wait(&pipe->wait, &wait, TASK_INTERRUPTIBLE);
86
	pipe_unlock(pipe);
L
Linus Torvalds 已提交
87
	schedule();
88
	finish_wait(&pipe->wait, &wait);
89
	pipe_lock(pipe);
L
Linus Torvalds 已提交
90 91
}

92
static int
93 94
pipe_iov_copy_from_user(void *to, struct iovec *iov, unsigned long len,
			int atomic)
L
Linus Torvalds 已提交
95 96 97 98 99 100 101 102
{
	unsigned long copy;

	while (len > 0) {
		while (!iov->iov_len)
			iov++;
		copy = min_t(unsigned long, len, iov->iov_len);

103 104 105 106 107 108 109
		if (atomic) {
			if (__copy_from_user_inatomic(to, iov->iov_base, copy))
				return -EFAULT;
		} else {
			if (copy_from_user(to, iov->iov_base, copy))
				return -EFAULT;
		}
L
Linus Torvalds 已提交
110 111 112 113 114 115 116 117
		to += copy;
		len -= copy;
		iov->iov_base += copy;
		iov->iov_len -= copy;
	}
	return 0;
}

118
static int
119 120
pipe_iov_copy_to_user(struct iovec *iov, const void *from, unsigned long len,
		      int atomic)
L
Linus Torvalds 已提交
121 122 123 124 125 126 127 128
{
	unsigned long copy;

	while (len > 0) {
		while (!iov->iov_len)
			iov++;
		copy = min_t(unsigned long, len, iov->iov_len);

129 130 131 132 133 134 135
		if (atomic) {
			if (__copy_to_user_inatomic(iov->iov_base, from, copy))
				return -EFAULT;
		} else {
			if (copy_to_user(iov->iov_base, from, copy))
				return -EFAULT;
		}
L
Linus Torvalds 已提交
136 137 138 139 140 141 142 143
		from += copy;
		len -= copy;
		iov->iov_base += copy;
		iov->iov_len -= copy;
	}
	return 0;
}

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
/*
 * Attempt to pre-fault in the user memory, so we can use atomic copies.
 * Returns the number of bytes not faulted in.
 */
static int iov_fault_in_pages_write(struct iovec *iov, unsigned long len)
{
	while (!iov->iov_len)
		iov++;

	while (len > 0) {
		unsigned long this_len;

		this_len = min_t(unsigned long, len, iov->iov_len);
		if (fault_in_pages_writeable(iov->iov_base, this_len))
			break;

		len -= this_len;
		iov++;
	}

	return len;
}

/*
 * Pre-fault in the user memory, so we can use atomic copies.
 */
static void iov_fault_in_pages_read(struct iovec *iov, unsigned long len)
{
	while (!iov->iov_len)
		iov++;

	while (len > 0) {
		unsigned long this_len;

		this_len = min_t(unsigned long, len, iov->iov_len);
		fault_in_pages_readable(iov->iov_base, this_len);
		len -= this_len;
		iov++;
	}
}

185 186
static void anon_pipe_buf_release(struct pipe_inode_info *pipe,
				  struct pipe_buffer *buf)
L
Linus Torvalds 已提交
187 188 189
{
	struct page *page = buf->page;

190 191 192
	/*
	 * If nobody else uses this page, and we don't already have a
	 * temporary page, let's keep track of it as a one-deep
193
	 * allocation cache. (Otherwise just release our reference to it)
194
	 */
195
	if (page_count(page) == 1 && !pipe->tmp_page)
196
		pipe->tmp_page = page;
197 198
	else
		page_cache_release(page);
L
Linus Torvalds 已提交
199 200
}

201 202 203 204 205 206 207 208
/**
 * generic_pipe_buf_map - virtually map a pipe buffer
 * @pipe:	the pipe that the buffer belongs to
 * @buf:	the buffer that should be mapped
 * @atomic:	whether to use an atomic map
 *
 * Description:
 *	This function returns a kernel virtual address mapping for the
209
 *	pipe_buffer passed in @buf. If @atomic is set, an atomic map is provided
210 211 212 213 214
 *	and the caller has to be careful not to fault before calling
 *	the unmap function.
 *
 *	Note that this function occupies KM_USER0 if @atomic != 0.
 */
215
void *generic_pipe_buf_map(struct pipe_inode_info *pipe,
216
			   struct pipe_buffer *buf, int atomic)
L
Linus Torvalds 已提交
217
{
218 219 220 221 222
	if (atomic) {
		buf->flags |= PIPE_BUF_FLAG_ATOMIC;
		return kmap_atomic(buf->page, KM_USER0);
	}

L
Linus Torvalds 已提交
223 224 225
	return kmap(buf->page);
}

226 227 228 229 230 231 232 233 234
/**
 * generic_pipe_buf_unmap - unmap a previously mapped pipe buffer
 * @pipe:	the pipe that the buffer belongs to
 * @buf:	the buffer that should be unmapped
 * @map_data:	the data that the mapping function returned
 *
 * Description:
 *	This function undoes the mapping that ->map() provided.
 */
235
void generic_pipe_buf_unmap(struct pipe_inode_info *pipe,
236
			    struct pipe_buffer *buf, void *map_data)
L
Linus Torvalds 已提交
237
{
238 239 240 241 242
	if (buf->flags & PIPE_BUF_FLAG_ATOMIC) {
		buf->flags &= ~PIPE_BUF_FLAG_ATOMIC;
		kunmap_atomic(map_data, KM_USER0);
	} else
		kunmap(buf->page);
L
Linus Torvalds 已提交
243 244
}

245
/**
246
 * generic_pipe_buf_steal - attempt to take ownership of a &pipe_buffer
247 248 249 250
 * @pipe:	the pipe that the buffer belongs to
 * @buf:	the buffer to attempt to steal
 *
 * Description:
251
 *	This function attempts to steal the &struct page attached to
252 253
 *	@buf. If successful, this function returns 0 and returns with
 *	the page locked. The caller may then reuse the page for whatever
254
 *	he wishes; the typical use is insertion into a different file
255 256
 *	page cache.
 */
257 258
int generic_pipe_buf_steal(struct pipe_inode_info *pipe,
			   struct pipe_buffer *buf)
259
{
260 261
	struct page *page = buf->page;

262 263 264 265 266
	/*
	 * A reference of one is golden, that means that the owner of this
	 * page is the only one holding a reference to it. lock the page
	 * and return OK.
	 */
267 268 269 270 271 272
	if (page_count(page) == 1) {
		lock_page(page);
		return 0;
	}

	return 1;
273 274
}

275
/**
276
 * generic_pipe_buf_get - get a reference to a &struct pipe_buffer
277 278 279 280 281 282 283 284 285
 * @pipe:	the pipe that the buffer belongs to
 * @buf:	the buffer to get a reference to
 *
 * Description:
 *	This function grabs an extra reference to @buf. It's used in
 *	in the tee() system call, when we duplicate the buffers in one
 *	pipe into another.
 */
void generic_pipe_buf_get(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
286 287 288 289
{
	page_cache_get(buf->page);
}

290 291
/**
 * generic_pipe_buf_confirm - verify contents of the pipe buffer
R
Randy Dunlap 已提交
292
 * @info:	the pipe that the buffer belongs to
293 294 295 296 297 298
 * @buf:	the buffer to confirm
 *
 * Description:
 *	This function does nothing, because the generic pipe code uses
 *	pages that are always good when inserted into the pipe.
 */
299 300
int generic_pipe_buf_confirm(struct pipe_inode_info *info,
			     struct pipe_buffer *buf)
301 302 303 304
{
	return 0;
}

305
static const struct pipe_buf_operations anon_pipe_buf_ops = {
L
Linus Torvalds 已提交
306
	.can_merge = 1,
307 308
	.map = generic_pipe_buf_map,
	.unmap = generic_pipe_buf_unmap,
309
	.confirm = generic_pipe_buf_confirm,
L
Linus Torvalds 已提交
310
	.release = anon_pipe_buf_release,
311
	.steal = generic_pipe_buf_steal,
312
	.get = generic_pipe_buf_get,
L
Linus Torvalds 已提交
313 314 315
};

static ssize_t
316 317
pipe_read(struct kiocb *iocb, const struct iovec *_iov,
	   unsigned long nr_segs, loff_t pos)
L
Linus Torvalds 已提交
318
{
319
	struct file *filp = iocb->ki_filp;
320
	struct inode *inode = filp->f_path.dentry->d_inode;
321
	struct pipe_inode_info *pipe;
L
Linus Torvalds 已提交
322 323 324 325 326 327 328 329 330 331 332 333
	int do_wakeup;
	ssize_t ret;
	struct iovec *iov = (struct iovec *)_iov;
	size_t total_len;

	total_len = iov_length(iov, nr_segs);
	/* Null read succeeds. */
	if (unlikely(total_len == 0))
		return 0;

	do_wakeup = 0;
	ret = 0;
334
	mutex_lock(&inode->i_mutex);
335
	pipe = inode->i_pipe;
L
Linus Torvalds 已提交
336
	for (;;) {
337
		int bufs = pipe->nrbufs;
L
Linus Torvalds 已提交
338
		if (bufs) {
339 340
			int curbuf = pipe->curbuf;
			struct pipe_buffer *buf = pipe->bufs + curbuf;
341
			const struct pipe_buf_operations *ops = buf->ops;
L
Linus Torvalds 已提交
342 343
			void *addr;
			size_t chars = buf->len;
344
			int error, atomic;
L
Linus Torvalds 已提交
345 346 347 348

			if (chars > total_len)
				chars = total_len;

349
			error = ops->confirm(pipe, buf);
350
			if (error) {
351
				if (!ret)
352
					error = ret;
353 354
				break;
			}
355

356 357 358 359 360
			atomic = !iov_fault_in_pages_write(iov, chars);
redo:
			addr = ops->map(pipe, buf, atomic);
			error = pipe_iov_copy_to_user(iov, addr + buf->offset, chars, atomic);
			ops->unmap(pipe, buf, addr);
L
Linus Torvalds 已提交
361
			if (unlikely(error)) {
362 363 364 365 366 367 368
				/*
				 * Just retry with the slow path if we failed.
				 */
				if (atomic) {
					atomic = 0;
					goto redo;
				}
369
				if (!ret)
370
					ret = error;
L
Linus Torvalds 已提交
371 372 373 374 375 376 377
				break;
			}
			ret += chars;
			buf->offset += chars;
			buf->len -= chars;
			if (!buf->len) {
				buf->ops = NULL;
378
				ops->release(pipe, buf);
L
Linus Torvalds 已提交
379
				curbuf = (curbuf + 1) & (PIPE_BUFFERS-1);
380 381
				pipe->curbuf = curbuf;
				pipe->nrbufs = --bufs;
L
Linus Torvalds 已提交
382 383 384 385 386 387 388 389
				do_wakeup = 1;
			}
			total_len -= chars;
			if (!total_len)
				break;	/* common path: read succeeded */
		}
		if (bufs)	/* More to do? */
			continue;
390
		if (!pipe->writers)
L
Linus Torvalds 已提交
391
			break;
392
		if (!pipe->waiting_writers) {
L
Linus Torvalds 已提交
393 394 395 396 397 398 399 400 401 402 403 404 405
			/* syscall merging: Usually we must not sleep
			 * if O_NONBLOCK is set, or if we got some data.
			 * But if a writer sleeps in kernel space, then
			 * we can wait for that data without violating POSIX.
			 */
			if (ret)
				break;
			if (filp->f_flags & O_NONBLOCK) {
				ret = -EAGAIN;
				break;
			}
		}
		if (signal_pending(current)) {
406 407
			if (!ret)
				ret = -ERESTARTSYS;
L
Linus Torvalds 已提交
408 409 410
			break;
		}
		if (do_wakeup) {
411 412
			wake_up_interruptible_sync(&pipe->wait);
 			kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
L
Linus Torvalds 已提交
413
		}
414
		pipe_wait(pipe);
L
Linus Torvalds 已提交
415
	}
416
	mutex_unlock(&inode->i_mutex);
417 418

	/* Signal writers asynchronously that there is more room. */
L
Linus Torvalds 已提交
419
	if (do_wakeup) {
I
Ingo Molnar 已提交
420
		wake_up_interruptible_sync(&pipe->wait);
421
		kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
L
Linus Torvalds 已提交
422 423 424 425 426 427 428
	}
	if (ret > 0)
		file_accessed(filp);
	return ret;
}

static ssize_t
429 430
pipe_write(struct kiocb *iocb, const struct iovec *_iov,
	    unsigned long nr_segs, loff_t ppos)
L
Linus Torvalds 已提交
431
{
432
	struct file *filp = iocb->ki_filp;
433
	struct inode *inode = filp->f_path.dentry->d_inode;
434
	struct pipe_inode_info *pipe;
L
Linus Torvalds 已提交
435 436 437 438 439 440 441 442 443 444 445 446 447
	ssize_t ret;
	int do_wakeup;
	struct iovec *iov = (struct iovec *)_iov;
	size_t total_len;
	ssize_t chars;

	total_len = iov_length(iov, nr_segs);
	/* Null write succeeds. */
	if (unlikely(total_len == 0))
		return 0;

	do_wakeup = 0;
	ret = 0;
448
	mutex_lock(&inode->i_mutex);
449
	pipe = inode->i_pipe;
L
Linus Torvalds 已提交
450

451
	if (!pipe->readers) {
L
Linus Torvalds 已提交
452 453 454 455 456 457 458
		send_sig(SIGPIPE, current, 0);
		ret = -EPIPE;
		goto out;
	}

	/* We try to merge small writes */
	chars = total_len & (PAGE_SIZE-1); /* size of the last buffer */
459
	if (pipe->nrbufs && chars != 0) {
460 461
		int lastbuf = (pipe->curbuf + pipe->nrbufs - 1) &
							(PIPE_BUFFERS-1);
462
		struct pipe_buffer *buf = pipe->bufs + lastbuf;
463
		const struct pipe_buf_operations *ops = buf->ops;
L
Linus Torvalds 已提交
464
		int offset = buf->offset + buf->len;
465

L
Linus Torvalds 已提交
466
		if (ops->can_merge && offset + chars <= PAGE_SIZE) {
467
			int error, atomic = 1;
468 469
			void *addr;

470
			error = ops->confirm(pipe, buf);
471
			if (error)
472
				goto out;
473

474 475 476
			iov_fault_in_pages_read(iov, chars);
redo1:
			addr = ops->map(pipe, buf, atomic);
477
			error = pipe_iov_copy_from_user(offset + addr, iov,
478 479
							chars, atomic);
			ops->unmap(pipe, buf, addr);
L
Linus Torvalds 已提交
480 481
			ret = error;
			do_wakeup = 1;
482 483 484 485 486
			if (error) {
				if (atomic) {
					atomic = 0;
					goto redo1;
				}
L
Linus Torvalds 已提交
487
				goto out;
488
			}
L
Linus Torvalds 已提交
489 490 491 492 493 494 495 496 497 498
			buf->len += chars;
			total_len -= chars;
			ret = chars;
			if (!total_len)
				goto out;
		}
	}

	for (;;) {
		int bufs;
499

500
		if (!pipe->readers) {
L
Linus Torvalds 已提交
501
			send_sig(SIGPIPE, current, 0);
502 503
			if (!ret)
				ret = -EPIPE;
L
Linus Torvalds 已提交
504 505
			break;
		}
506
		bufs = pipe->nrbufs;
L
Linus Torvalds 已提交
507
		if (bufs < PIPE_BUFFERS) {
508 509 510
			int newbuf = (pipe->curbuf + bufs) & (PIPE_BUFFERS-1);
			struct pipe_buffer *buf = pipe->bufs + newbuf;
			struct page *page = pipe->tmp_page;
511 512
			char *src;
			int error, atomic = 1;
L
Linus Torvalds 已提交
513 514 515 516 517 518 519

			if (!page) {
				page = alloc_page(GFP_HIGHUSER);
				if (unlikely(!page)) {
					ret = ret ? : -ENOMEM;
					break;
				}
520
				pipe->tmp_page = page;
L
Linus Torvalds 已提交
521
			}
522
			/* Always wake up, even if the copy fails. Otherwise
L
Linus Torvalds 已提交
523 524 525 526 527 528 529 530 531
			 * we lock up (O_NONBLOCK-)readers that sleep due to
			 * syscall merging.
			 * FIXME! Is this really true?
			 */
			do_wakeup = 1;
			chars = PAGE_SIZE;
			if (chars > total_len)
				chars = total_len;

532 533 534 535 536 537 538 539 540 541 542 543 544 545
			iov_fault_in_pages_read(iov, chars);
redo2:
			if (atomic)
				src = kmap_atomic(page, KM_USER0);
			else
				src = kmap(page);

			error = pipe_iov_copy_from_user(src, iov, chars,
							atomic);
			if (atomic)
				kunmap_atomic(src, KM_USER0);
			else
				kunmap(page);

L
Linus Torvalds 已提交
546
			if (unlikely(error)) {
547 548 549 550
				if (atomic) {
					atomic = 0;
					goto redo2;
				}
551
				if (!ret)
552
					ret = error;
L
Linus Torvalds 已提交
553 554 555 556 557 558 559 560 561
				break;
			}
			ret += chars;

			/* Insert it into the buffer array */
			buf->page = page;
			buf->ops = &anon_pipe_buf_ops;
			buf->offset = 0;
			buf->len = chars;
562 563
			pipe->nrbufs = ++bufs;
			pipe->tmp_page = NULL;
L
Linus Torvalds 已提交
564 565 566 567 568 569 570 571

			total_len -= chars;
			if (!total_len)
				break;
		}
		if (bufs < PIPE_BUFFERS)
			continue;
		if (filp->f_flags & O_NONBLOCK) {
572 573
			if (!ret)
				ret = -EAGAIN;
L
Linus Torvalds 已提交
574 575 576
			break;
		}
		if (signal_pending(current)) {
577 578
			if (!ret)
				ret = -ERESTARTSYS;
L
Linus Torvalds 已提交
579 580 581
			break;
		}
		if (do_wakeup) {
582 583
			wake_up_interruptible_sync(&pipe->wait);
			kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
L
Linus Torvalds 已提交
584 585
			do_wakeup = 0;
		}
586 587 588
		pipe->waiting_writers++;
		pipe_wait(pipe);
		pipe->waiting_writers--;
L
Linus Torvalds 已提交
589 590
	}
out:
591
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
592
	if (do_wakeup) {
I
Ingo Molnar 已提交
593
		wake_up_interruptible_sync(&pipe->wait);
594
		kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
L
Linus Torvalds 已提交
595 596
	}
	if (ret > 0)
597
		file_update_time(filp);
L
Linus Torvalds 已提交
598 599 600 601 602 603 604 605 606 607
	return ret;
}

static ssize_t
bad_pipe_r(struct file *filp, char __user *buf, size_t count, loff_t *ppos)
{
	return -EBADF;
}

static ssize_t
608 609
bad_pipe_w(struct file *filp, const char __user *buf, size_t count,
	   loff_t *ppos)
L
Linus Torvalds 已提交
610 611 612 613
{
	return -EBADF;
}

614
static long pipe_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
L
Linus Torvalds 已提交
615
{
616
	struct inode *inode = filp->f_path.dentry->d_inode;
617
	struct pipe_inode_info *pipe;
L
Linus Torvalds 已提交
618 619 620 621
	int count, buf, nrbufs;

	switch (cmd) {
		case FIONREAD:
622
			mutex_lock(&inode->i_mutex);
623
			pipe = inode->i_pipe;
L
Linus Torvalds 已提交
624
			count = 0;
625 626
			buf = pipe->curbuf;
			nrbufs = pipe->nrbufs;
L
Linus Torvalds 已提交
627
			while (--nrbufs >= 0) {
628
				count += pipe->bufs[buf].len;
L
Linus Torvalds 已提交
629 630
				buf = (buf+1) & (PIPE_BUFFERS-1);
			}
631
			mutex_unlock(&inode->i_mutex);
632

L
Linus Torvalds 已提交
633 634 635 636 637 638 639 640 641 642 643
			return put_user(count, (int __user *)arg);
		default:
			return -EINVAL;
	}
}

/* No kernel lock held - fine */
static unsigned int
pipe_poll(struct file *filp, poll_table *wait)
{
	unsigned int mask;
644
	struct inode *inode = filp->f_path.dentry->d_inode;
645
	struct pipe_inode_info *pipe = inode->i_pipe;
L
Linus Torvalds 已提交
646 647
	int nrbufs;

648
	poll_wait(filp, &pipe->wait, wait);
L
Linus Torvalds 已提交
649 650

	/* Reading only -- no need for acquiring the semaphore.  */
651
	nrbufs = pipe->nrbufs;
L
Linus Torvalds 已提交
652 653 654
	mask = 0;
	if (filp->f_mode & FMODE_READ) {
		mask = (nrbufs > 0) ? POLLIN | POLLRDNORM : 0;
655
		if (!pipe->writers && filp->f_version != pipe->w_counter)
L
Linus Torvalds 已提交
656 657 658 659 660
			mask |= POLLHUP;
	}

	if (filp->f_mode & FMODE_WRITE) {
		mask |= (nrbufs < PIPE_BUFFERS) ? POLLOUT | POLLWRNORM : 0;
661 662 663 664
		/*
		 * Most Unices do not set POLLERR for FIFOs but on Linux they
		 * behave exactly like pipes for poll().
		 */
665
		if (!pipe->readers)
L
Linus Torvalds 已提交
666 667 668 669 670 671 672 673 674
			mask |= POLLERR;
	}

	return mask;
}

static int
pipe_release(struct inode *inode, int decr, int decw)
{
675 676
	struct pipe_inode_info *pipe;

677
	mutex_lock(&inode->i_mutex);
678 679 680
	pipe = inode->i_pipe;
	pipe->readers -= decr;
	pipe->writers -= decw;
681

682
	if (!pipe->readers && !pipe->writers) {
L
Linus Torvalds 已提交
683 684
		free_pipe_info(inode);
	} else {
I
Ingo Molnar 已提交
685
		wake_up_interruptible_sync(&pipe->wait);
686 687
		kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
		kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
L
Linus Torvalds 已提交
688
	}
689
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
690 691 692 693 694 695 696

	return 0;
}

static int
pipe_read_fasync(int fd, struct file *filp, int on)
{
697
	struct inode *inode = filp->f_path.dentry->d_inode;
L
Linus Torvalds 已提交
698 699
	int retval;

700 701 702
	mutex_lock(&inode->i_mutex);
	retval = fasync_helper(fd, filp, on, &inode->i_pipe->fasync_readers);
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
703

704
	return retval;
L
Linus Torvalds 已提交
705 706 707 708 709 710
}


static int
pipe_write_fasync(int fd, struct file *filp, int on)
{
711
	struct inode *inode = filp->f_path.dentry->d_inode;
L
Linus Torvalds 已提交
712 713
	int retval;

714 715 716
	mutex_lock(&inode->i_mutex);
	retval = fasync_helper(fd, filp, on, &inode->i_pipe->fasync_writers);
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
717

718
	return retval;
L
Linus Torvalds 已提交
719 720 721 722 723 724
}


static int
pipe_rdwr_fasync(int fd, struct file *filp, int on)
{
725
	struct inode *inode = filp->f_path.dentry->d_inode;
726
	struct pipe_inode_info *pipe = inode->i_pipe;
L
Linus Torvalds 已提交
727 728
	int retval;

729
	mutex_lock(&inode->i_mutex);
730
	retval = fasync_helper(fd, filp, on, &pipe->fasync_readers);
731
	if (retval >= 0) {
732
		retval = fasync_helper(fd, filp, on, &pipe->fasync_writers);
733 734 735
		if (retval < 0) /* this can happen only if on == T */
			fasync_helper(-1, filp, 0, &pipe->fasync_readers);
	}
736
	mutex_unlock(&inode->i_mutex);
737
	return retval;
L
Linus Torvalds 已提交
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
}


static int
pipe_read_release(struct inode *inode, struct file *filp)
{
	return pipe_release(inode, 1, 0);
}

static int
pipe_write_release(struct inode *inode, struct file *filp)
{
	return pipe_release(inode, 0, 1);
}

static int
pipe_rdwr_release(struct inode *inode, struct file *filp)
{
	int decr, decw;

	decr = (filp->f_mode & FMODE_READ) != 0;
	decw = (filp->f_mode & FMODE_WRITE) != 0;
	return pipe_release(inode, decr, decw);
}

static int
pipe_read_open(struct inode *inode, struct file *filp)
{
	/* We could have perhaps used atomic_t, but this and friends
	   below are the only places.  So it doesn't seem worthwhile.  */
768 769 770
	mutex_lock(&inode->i_mutex);
	inode->i_pipe->readers++;
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
771 772 773 774 775 776 777

	return 0;
}

static int
pipe_write_open(struct inode *inode, struct file *filp)
{
778 779 780
	mutex_lock(&inode->i_mutex);
	inode->i_pipe->writers++;
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
781 782 783 784 785 786 787

	return 0;
}

static int
pipe_rdwr_open(struct inode *inode, struct file *filp)
{
788
	mutex_lock(&inode->i_mutex);
L
Linus Torvalds 已提交
789
	if (filp->f_mode & FMODE_READ)
790
		inode->i_pipe->readers++;
L
Linus Torvalds 已提交
791
	if (filp->f_mode & FMODE_WRITE)
792 793
		inode->i_pipe->writers++;
	mutex_unlock(&inode->i_mutex);
L
Linus Torvalds 已提交
794 795 796 797 798 799 800

	return 0;
}

/*
 * The file_operations structs are not static because they
 * are also used in linux/fs/fifo.c to do operations on FIFOs.
801 802
 *
 * Pipes reuse fifos' file_operations structs.
L
Linus Torvalds 已提交
803
 */
804
const struct file_operations read_pipefifo_fops = {
L
Linus Torvalds 已提交
805
	.llseek		= no_llseek,
806 807
	.read		= do_sync_read,
	.aio_read	= pipe_read,
L
Linus Torvalds 已提交
808 809
	.write		= bad_pipe_w,
	.poll		= pipe_poll,
810
	.unlocked_ioctl	= pipe_ioctl,
L
Linus Torvalds 已提交
811 812 813 814 815
	.open		= pipe_read_open,
	.release	= pipe_read_release,
	.fasync		= pipe_read_fasync,
};

816
const struct file_operations write_pipefifo_fops = {
L
Linus Torvalds 已提交
817 818
	.llseek		= no_llseek,
	.read		= bad_pipe_r,
819 820
	.write		= do_sync_write,
	.aio_write	= pipe_write,
L
Linus Torvalds 已提交
821
	.poll		= pipe_poll,
822
	.unlocked_ioctl	= pipe_ioctl,
L
Linus Torvalds 已提交
823 824 825 826 827
	.open		= pipe_write_open,
	.release	= pipe_write_release,
	.fasync		= pipe_write_fasync,
};

828
const struct file_operations rdwr_pipefifo_fops = {
L
Linus Torvalds 已提交
829
	.llseek		= no_llseek,
830 831 832 833
	.read		= do_sync_read,
	.aio_read	= pipe_read,
	.write		= do_sync_write,
	.aio_write	= pipe_write,
L
Linus Torvalds 已提交
834
	.poll		= pipe_poll,
835
	.unlocked_ioctl	= pipe_ioctl,
L
Linus Torvalds 已提交
836 837 838 839 840
	.open		= pipe_rdwr_open,
	.release	= pipe_rdwr_release,
	.fasync		= pipe_rdwr_fasync,
};

841 842
struct pipe_inode_info * alloc_pipe_info(struct inode *inode)
{
843
	struct pipe_inode_info *pipe;
844

845 846 847 848 849
	pipe = kzalloc(sizeof(struct pipe_inode_info), GFP_KERNEL);
	if (pipe) {
		init_waitqueue_head(&pipe->wait);
		pipe->r_counter = pipe->w_counter = 1;
		pipe->inode = inode;
850 851
	}

852
	return pipe;
853 854
}

855
void __free_pipe_info(struct pipe_inode_info *pipe)
L
Linus Torvalds 已提交
856 857 858 859
{
	int i;

	for (i = 0; i < PIPE_BUFFERS; i++) {
860
		struct pipe_buffer *buf = pipe->bufs + i;
L
Linus Torvalds 已提交
861
		if (buf->ops)
862
			buf->ops->release(pipe, buf);
L
Linus Torvalds 已提交
863
	}
864 865 866
	if (pipe->tmp_page)
		__free_page(pipe->tmp_page);
	kfree(pipe);
L
Linus Torvalds 已提交
867 868
}

869 870 871 872 873 874
void free_pipe_info(struct inode *inode)
{
	__free_pipe_info(inode->i_pipe);
	inode->i_pipe = NULL;
}

875
static struct vfsmount *pipe_mnt __read_mostly;
L
Linus Torvalds 已提交
876 877
static int pipefs_delete_dentry(struct dentry *dentry)
{
878 879 880 881 882 883 884 885
	/*
	 * At creation time, we pretended this dentry was hashed
	 * (by clearing DCACHE_UNHASHED bit in d_flags)
	 * At delete time, we restore the truth : not hashed.
	 * (so that dput() can proceed correctly)
	 */
	dentry->d_flags |= DCACHE_UNHASHED;
	return 0;
L
Linus Torvalds 已提交
886
}
887

888 889 890 891 892 893 894 895 896
/*
 * pipefs_dname() is called from d_path().
 */
static char *pipefs_dname(struct dentry *dentry, char *buffer, int buflen)
{
	return dynamic_dname(dentry, buffer, buflen, "pipe:[%lu]",
				dentry->d_inode->i_ino);
}

A
Al Viro 已提交
897
static const struct dentry_operations pipefs_dentry_operations = {
L
Linus Torvalds 已提交
898
	.d_delete	= pipefs_delete_dentry,
899
	.d_dname	= pipefs_dname,
L
Linus Torvalds 已提交
900 901 902 903 904
};

static struct inode * get_pipe_inode(void)
{
	struct inode *inode = new_inode(pipe_mnt->mnt_sb);
905
	struct pipe_inode_info *pipe;
L
Linus Torvalds 已提交
906 907 908 909

	if (!inode)
		goto fail_inode;

910 911
	pipe = alloc_pipe_info(inode);
	if (!pipe)
L
Linus Torvalds 已提交
912
		goto fail_iput;
913
	inode->i_pipe = pipe;
914

915
	pipe->readers = pipe->writers = 1;
916
	inode->i_fop = &rdwr_pipefifo_fops;
L
Linus Torvalds 已提交
917 918 919 920 921 922 923 924 925

	/*
	 * Mark the inode dirty from the very beginning,
	 * that way it will never be moved to the dirty
	 * list because "mark_inode_dirty()" will think
	 * that it already _is_ on the dirty list.
	 */
	inode->i_state = I_DIRTY;
	inode->i_mode = S_IFIFO | S_IRUSR | S_IWUSR;
926 927
	inode->i_uid = current_fsuid();
	inode->i_gid = current_fsgid();
L
Linus Torvalds 已提交
928
	inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
929

L
Linus Torvalds 已提交
930 931 932 933
	return inode;

fail_iput:
	iput(inode);
934

L
Linus Torvalds 已提交
935 936 937 938
fail_inode:
	return NULL;
}

939
struct file *create_write_pipe(int flags)
L
Linus Torvalds 已提交
940
{
A
Andi Kleen 已提交
941 942 943
	int err;
	struct inode *inode;
	struct file *f;
L
Linus Torvalds 已提交
944
	struct dentry *dentry;
945
	struct qstr name = { .name = "" };
L
Linus Torvalds 已提交
946

A
Andi Kleen 已提交
947
	err = -ENFILE;
L
Linus Torvalds 已提交
948 949
	inode = get_pipe_inode();
	if (!inode)
D
Dave Hansen 已提交
950
		goto err;
L
Linus Torvalds 已提交
951

A
Andi Kleen 已提交
952
	err = -ENOMEM;
953
	dentry = d_alloc(pipe_mnt->mnt_sb->s_root, &name);
L
Linus Torvalds 已提交
954
	if (!dentry)
A
Andi Kleen 已提交
955
		goto err_inode;
956

L
Linus Torvalds 已提交
957
	dentry->d_op = &pipefs_dentry_operations;
958 959 960 961 962 963 964
	/*
	 * We dont want to publish this dentry into global dentry hash table.
	 * We pretend dentry is already hashed, by unsetting DCACHE_UNHASHED
	 * This permits a working /proc/$pid/fd/XXX on pipes
	 */
	dentry->d_flags &= ~DCACHE_UNHASHED;
	d_instantiate(dentry, inode);
D
Dave Hansen 已提交
965 966

	err = -ENFILE;
967
	f = alloc_file(pipe_mnt, dentry, FMODE_WRITE, &write_pipefifo_fops);
D
Dave Hansen 已提交
968 969
	if (!f)
		goto err_dentry;
A
Andi Kleen 已提交
970
	f->f_mapping = inode->i_mapping;
971

972
	f->f_flags = O_WRONLY | (flags & O_NONBLOCK);
A
Andi Kleen 已提交
973 974 975
	f->f_version = 0;

	return f;
L
Linus Torvalds 已提交
976

D
Dave Hansen 已提交
977
 err_dentry:
978
	free_pipe_info(inode);
D
Dave Hansen 已提交
979
	dput(dentry);
980 981
	return ERR_PTR(err);

A
Andi Kleen 已提交
982
 err_inode:
L
Linus Torvalds 已提交
983 984
	free_pipe_info(inode);
	iput(inode);
D
Dave Hansen 已提交
985
 err:
A
Andi Kleen 已提交
986 987 988 989 990
	return ERR_PTR(err);
}

void free_write_pipe(struct file *f)
{
991
	free_pipe_info(f->f_dentry->d_inode);
992
	path_put(&f->f_path);
A
Andi Kleen 已提交
993 994 995
	put_filp(f);
}

996
struct file *create_read_pipe(struct file *wrf, int flags)
A
Andi Kleen 已提交
997 998 999 1000 1001 1002
{
	struct file *f = get_empty_filp();
	if (!f)
		return ERR_PTR(-ENFILE);

	/* Grab pipe from the writer */
1003 1004
	f->f_path = wrf->f_path;
	path_get(&wrf->f_path);
1005
	f->f_mapping = wrf->f_path.dentry->d_inode->i_mapping;
A
Andi Kleen 已提交
1006 1007

	f->f_pos = 0;
1008
	f->f_flags = O_RDONLY | (flags & O_NONBLOCK);
1009
	f->f_op = &read_pipefifo_fops;
A
Andi Kleen 已提交
1010 1011 1012 1013 1014 1015
	f->f_mode = FMODE_READ;
	f->f_version = 0;

	return f;
}

U
Ulrich Drepper 已提交
1016
int do_pipe_flags(int *fd, int flags)
A
Andi Kleen 已提交
1017 1018 1019 1020 1021
{
	struct file *fw, *fr;
	int error;
	int fdw, fdr;

1022
	if (flags & ~(O_CLOEXEC | O_NONBLOCK))
U
Ulrich Drepper 已提交
1023 1024
		return -EINVAL;

1025
	fw = create_write_pipe(flags);
A
Andi Kleen 已提交
1026 1027
	if (IS_ERR(fw))
		return PTR_ERR(fw);
1028
	fr = create_read_pipe(fw, flags);
A
Andi Kleen 已提交
1029 1030 1031 1032
	error = PTR_ERR(fr);
	if (IS_ERR(fr))
		goto err_write_pipe;

U
Ulrich Drepper 已提交
1033
	error = get_unused_fd_flags(flags);
A
Andi Kleen 已提交
1034 1035 1036 1037
	if (error < 0)
		goto err_read_pipe;
	fdr = error;

U
Ulrich Drepper 已提交
1038
	error = get_unused_fd_flags(flags);
A
Andi Kleen 已提交
1039 1040 1041 1042
	if (error < 0)
		goto err_fdr;
	fdw = error;

A
Al Viro 已提交
1043
	audit_fd_pair(fdr, fdw);
A
Andi Kleen 已提交
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
	fd_install(fdr, fr);
	fd_install(fdw, fw);
	fd[0] = fdr;
	fd[1] = fdw;

	return 0;

 err_fdr:
	put_unused_fd(fdr);
 err_read_pipe:
1054
	path_put(&fr->f_path);
A
Andi Kleen 已提交
1055 1056 1057 1058
	put_filp(fr);
 err_write_pipe:
	free_write_pipe(fw);
	return error;
L
Linus Torvalds 已提交
1059 1060
}

1061 1062 1063 1064
/*
 * sys_pipe() is the normal C calling standard for creating
 * a pipe. It's not the way Unix traditionally does this, though.
 */
1065
SYSCALL_DEFINE2(pipe2, int __user *, fildes, int, flags)
1066 1067 1068 1069
{
	int fd[2];
	int error;

U
Ulrich Drepper 已提交
1070
	error = do_pipe_flags(fd, flags);
1071
	if (!error) {
1072 1073 1074
		if (copy_to_user(fildes, fd, sizeof(fd))) {
			sys_close(fd[0]);
			sys_close(fd[1]);
1075
			error = -EFAULT;
1076
		}
1077 1078 1079 1080
	}
	return error;
}

1081
SYSCALL_DEFINE1(pipe, int __user *, fildes)
U
Ulrich Drepper 已提交
1082 1083 1084 1085
{
	return sys_pipe2(fildes, 0);
}

L
Linus Torvalds 已提交
1086 1087 1088 1089 1090 1091
/*
 * pipefs should _never_ be mounted by userland - too much of security hassle,
 * no real gain from having the whole whorehouse mounted. So we don't need
 * any operations on the root directory. However, we need a non-trivial
 * d_name - pipe: will go nicely and kill the special-casing in procfs.
 */
1092 1093 1094
static int pipefs_get_sb(struct file_system_type *fs_type,
			 int flags, const char *dev_name, void *data,
			 struct vfsmount *mnt)
L
Linus Torvalds 已提交
1095
{
1096
	return get_sb_pseudo(fs_type, "pipe:", NULL, PIPEFS_MAGIC, mnt);
L
Linus Torvalds 已提交
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
}

static struct file_system_type pipe_fs_type = {
	.name		= "pipefs",
	.get_sb		= pipefs_get_sb,
	.kill_sb	= kill_anon_super,
};

static int __init init_pipe_fs(void)
{
	int err = register_filesystem(&pipe_fs_type);
1108

L
Linus Torvalds 已提交
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
	if (!err) {
		pipe_mnt = kern_mount(&pipe_fs_type);
		if (IS_ERR(pipe_mnt)) {
			err = PTR_ERR(pipe_mnt);
			unregister_filesystem(&pipe_fs_type);
		}
	}
	return err;
}

static void __exit exit_pipe_fs(void)
{
	unregister_filesystem(&pipe_fs_type);
	mntput(pipe_mnt);
}

fs_initcall(init_pipe_fs);
module_exit(exit_pipe_fs);