pipe.c 22.2 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
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>
Al Viro's avatar
Al Viro committed
19
#include <linux/audit.h>
Linus Torvalds's avatar
Linus Torvalds committed
20 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
 */

/* Drop the inode semaphore and wait for a pipe event, atomically */
40
void pipe_wait(struct pipe_inode_info *pipe)
Linus Torvalds's avatar
Linus Torvalds committed
41 42 43
{
	DEFINE_WAIT(wait);

44 45 46 47
	/*
	 * Pipes are system-local resources, so sleeping on them
	 * is considered a noninteractive wait:
	 */
48 49
	prepare_to_wait(&pipe->wait, &wait,
			TASK_INTERRUPTIBLE | TASK_NONINTERACTIVE);
50 51
	if (pipe->inode)
		mutex_unlock(&pipe->inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
52
	schedule();
53 54 55
	finish_wait(&pipe->wait, &wait);
	if (pipe->inode)
		mutex_lock(&pipe->inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
56 57
}

58
static int
59 60
pipe_iov_copy_from_user(void *to, struct iovec *iov, unsigned long len,
			int atomic)
Linus Torvalds's avatar
Linus Torvalds committed
61 62 63 64 65 66 67 68
{
	unsigned long copy;

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

69 70 71 72 73 74 75
		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;
		}
Linus Torvalds's avatar
Linus Torvalds committed
76 77 78 79 80 81 82 83
		to += copy;
		len -= copy;
		iov->iov_base += copy;
		iov->iov_len -= copy;
	}
	return 0;
}

84
static int
85 86
pipe_iov_copy_to_user(struct iovec *iov, const void *from, unsigned long len,
		      int atomic)
Linus Torvalds's avatar
Linus Torvalds committed
87 88 89 90 91 92 93 94
{
	unsigned long copy;

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

95 96 97 98 99 100 101
		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;
		}
Linus Torvalds's avatar
Linus Torvalds committed
102 103 104 105 106 107 108 109
		from += copy;
		len -= copy;
		iov->iov_base += copy;
		iov->iov_len -= copy;
	}
	return 0;
}

110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
/*
 * 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++;
	}
}

151 152
static void anon_pipe_buf_release(struct pipe_inode_info *pipe,
				  struct pipe_buffer *buf)
Linus Torvalds's avatar
Linus Torvalds committed
153 154 155
{
	struct page *page = buf->page;

156 157 158
	/*
	 * 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
159
	 * allocation cache. (Otherwise just release our reference to it)
160
	 */
161
	if (page_count(page) == 1 && !pipe->tmp_page)
162
		pipe->tmp_page = page;
163 164
	else
		page_cache_release(page);
Linus Torvalds's avatar
Linus Torvalds committed
165 166
}

167
void *generic_pipe_buf_map(struct pipe_inode_info *pipe,
168
			   struct pipe_buffer *buf, int atomic)
Linus Torvalds's avatar
Linus Torvalds committed
169
{
170 171 172 173 174
	if (atomic) {
		buf->flags |= PIPE_BUF_FLAG_ATOMIC;
		return kmap_atomic(buf->page, KM_USER0);
	}

Linus Torvalds's avatar
Linus Torvalds committed
175 176 177
	return kmap(buf->page);
}

178
void generic_pipe_buf_unmap(struct pipe_inode_info *pipe,
179
			    struct pipe_buffer *buf, void *map_data)
Linus Torvalds's avatar
Linus Torvalds committed
180
{
181 182 183 184 185
	if (buf->flags & PIPE_BUF_FLAG_ATOMIC) {
		buf->flags &= ~PIPE_BUF_FLAG_ATOMIC;
		kunmap_atomic(map_data, KM_USER0);
	} else
		kunmap(buf->page);
Linus Torvalds's avatar
Linus Torvalds committed
186 187
}

188 189
int generic_pipe_buf_steal(struct pipe_inode_info *pipe,
			   struct pipe_buffer *buf)
190
{
191 192 193 194 195 196 197 198
	struct page *page = buf->page;

	if (page_count(page) == 1) {
		lock_page(page);
		return 0;
	}

	return 1;
199 200
}

201
void generic_pipe_buf_get(struct pipe_inode_info *info, struct pipe_buffer *buf)
202 203 204 205
{
	page_cache_get(buf->page);
}

206 207 208 209 210
int generic_pipe_buf_pin(struct pipe_inode_info *info, struct pipe_buffer *buf)
{
	return 0;
}

211
static const struct pipe_buf_operations anon_pipe_buf_ops = {
Linus Torvalds's avatar
Linus Torvalds committed
212
	.can_merge = 1,
213 214 215
	.map = generic_pipe_buf_map,
	.unmap = generic_pipe_buf_unmap,
	.pin = generic_pipe_buf_pin,
Linus Torvalds's avatar
Linus Torvalds committed
216
	.release = anon_pipe_buf_release,
217
	.steal = generic_pipe_buf_steal,
218
	.get = generic_pipe_buf_get,
Linus Torvalds's avatar
Linus Torvalds committed
219 220 221
};

static ssize_t
222 223
pipe_read(struct kiocb *iocb, const struct iovec *_iov,
	   unsigned long nr_segs, loff_t pos)
Linus Torvalds's avatar
Linus Torvalds committed
224
{
225
	struct file *filp = iocb->ki_filp;
226
	struct inode *inode = filp->f_path.dentry->d_inode;
227
	struct pipe_inode_info *pipe;
Linus Torvalds's avatar
Linus Torvalds committed
228 229 230 231 232 233 234 235 236 237 238 239
	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;
240
	mutex_lock(&inode->i_mutex);
241
	pipe = inode->i_pipe;
Linus Torvalds's avatar
Linus Torvalds committed
242
	for (;;) {
243
		int bufs = pipe->nrbufs;
Linus Torvalds's avatar
Linus Torvalds committed
244
		if (bufs) {
245 246
			int curbuf = pipe->curbuf;
			struct pipe_buffer *buf = pipe->bufs + curbuf;
247
			const struct pipe_buf_operations *ops = buf->ops;
Linus Torvalds's avatar
Linus Torvalds committed
248 249
			void *addr;
			size_t chars = buf->len;
250
			int error, atomic;
Linus Torvalds's avatar
Linus Torvalds committed
251 252 253 254

			if (chars > total_len)
				chars = total_len;

255 256
			error = ops->pin(pipe, buf);
			if (error) {
257
				if (!ret)
258
					error = ret;
259 260
				break;
			}
261

262 263 264 265 266
			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);
Linus Torvalds's avatar
Linus Torvalds committed
267
			if (unlikely(error)) {
268 269 270 271 272 273 274
				/*
				 * Just retry with the slow path if we failed.
				 */
				if (atomic) {
					atomic = 0;
					goto redo;
				}
275
				if (!ret)
276
					ret = error;
Linus Torvalds's avatar
Linus Torvalds committed
277 278 279 280 281 282 283
				break;
			}
			ret += chars;
			buf->offset += chars;
			buf->len -= chars;
			if (!buf->len) {
				buf->ops = NULL;
284
				ops->release(pipe, buf);
Linus Torvalds's avatar
Linus Torvalds committed
285
				curbuf = (curbuf + 1) & (PIPE_BUFFERS-1);
286 287
				pipe->curbuf = curbuf;
				pipe->nrbufs = --bufs;
Linus Torvalds's avatar
Linus Torvalds committed
288 289 290 291 292 293 294 295
				do_wakeup = 1;
			}
			total_len -= chars;
			if (!total_len)
				break;	/* common path: read succeeded */
		}
		if (bufs)	/* More to do? */
			continue;
296
		if (!pipe->writers)
Linus Torvalds's avatar
Linus Torvalds committed
297
			break;
298
		if (!pipe->waiting_writers) {
Linus Torvalds's avatar
Linus Torvalds committed
299 300 301 302 303 304 305 306 307 308 309 310 311
			/* 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)) {
312 313
			if (!ret)
				ret = -ERESTARTSYS;
Linus Torvalds's avatar
Linus Torvalds committed
314 315 316
			break;
		}
		if (do_wakeup) {
317 318
			wake_up_interruptible_sync(&pipe->wait);
 			kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
Linus Torvalds's avatar
Linus Torvalds committed
319
		}
320
		pipe_wait(pipe);
Linus Torvalds's avatar
Linus Torvalds committed
321
	}
322
	mutex_unlock(&inode->i_mutex);
323 324

	/* Signal writers asynchronously that there is more room. */
Linus Torvalds's avatar
Linus Torvalds committed
325
	if (do_wakeup) {
326 327
		wake_up_interruptible(&pipe->wait);
		kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
Linus Torvalds's avatar
Linus Torvalds committed
328 329 330 331 332 333 334
	}
	if (ret > 0)
		file_accessed(filp);
	return ret;
}

static ssize_t
335 336
pipe_write(struct kiocb *iocb, const struct iovec *_iov,
	    unsigned long nr_segs, loff_t ppos)
Linus Torvalds's avatar
Linus Torvalds committed
337
{
338
	struct file *filp = iocb->ki_filp;
339
	struct inode *inode = filp->f_path.dentry->d_inode;
340
	struct pipe_inode_info *pipe;
Linus Torvalds's avatar
Linus Torvalds committed
341 342 343 344 345 346 347 348 349 350 351 352 353
	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;
354
	mutex_lock(&inode->i_mutex);
355
	pipe = inode->i_pipe;
Linus Torvalds's avatar
Linus Torvalds committed
356

357
	if (!pipe->readers) {
Linus Torvalds's avatar
Linus Torvalds committed
358 359 360 361 362 363 364
		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 */
365
	if (pipe->nrbufs && chars != 0) {
366 367
		int lastbuf = (pipe->curbuf + pipe->nrbufs - 1) &
							(PIPE_BUFFERS-1);
368
		struct pipe_buffer *buf = pipe->bufs + lastbuf;
369
		const struct pipe_buf_operations *ops = buf->ops;
Linus Torvalds's avatar
Linus Torvalds committed
370
		int offset = buf->offset + buf->len;
371

Linus Torvalds's avatar
Linus Torvalds committed
372
		if (ops->can_merge && offset + chars <= PAGE_SIZE) {
373
			int error, atomic = 1;
374 375
			void *addr;

376 377
			error = ops->pin(pipe, buf);
			if (error)
378
				goto out;
379

380 381 382
			iov_fault_in_pages_read(iov, chars);
redo1:
			addr = ops->map(pipe, buf, atomic);
383
			error = pipe_iov_copy_from_user(offset + addr, iov,
384 385
							chars, atomic);
			ops->unmap(pipe, buf, addr);
Linus Torvalds's avatar
Linus Torvalds committed
386 387
			ret = error;
			do_wakeup = 1;
388 389 390 391 392
			if (error) {
				if (atomic) {
					atomic = 0;
					goto redo1;
				}
Linus Torvalds's avatar
Linus Torvalds committed
393
				goto out;
394
			}
Linus Torvalds's avatar
Linus Torvalds committed
395 396 397 398 399 400 401 402 403 404
			buf->len += chars;
			total_len -= chars;
			ret = chars;
			if (!total_len)
				goto out;
		}
	}

	for (;;) {
		int bufs;
405

406
		if (!pipe->readers) {
Linus Torvalds's avatar
Linus Torvalds committed
407
			send_sig(SIGPIPE, current, 0);
408 409
			if (!ret)
				ret = -EPIPE;
Linus Torvalds's avatar
Linus Torvalds committed
410 411
			break;
		}
412
		bufs = pipe->nrbufs;
Linus Torvalds's avatar
Linus Torvalds committed
413
		if (bufs < PIPE_BUFFERS) {
414 415 416
			int newbuf = (pipe->curbuf + bufs) & (PIPE_BUFFERS-1);
			struct pipe_buffer *buf = pipe->bufs + newbuf;
			struct page *page = pipe->tmp_page;
417 418
			char *src;
			int error, atomic = 1;
Linus Torvalds's avatar
Linus Torvalds committed
419 420 421 422 423 424 425

			if (!page) {
				page = alloc_page(GFP_HIGHUSER);
				if (unlikely(!page)) {
					ret = ret ? : -ENOMEM;
					break;
				}
426
				pipe->tmp_page = page;
Linus Torvalds's avatar
Linus Torvalds committed
427
			}
428
			/* Always wake up, even if the copy fails. Otherwise
Linus Torvalds's avatar
Linus Torvalds committed
429 430 431 432 433 434 435 436 437
			 * 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;

438 439 440 441 442 443 444 445 446 447 448 449 450 451
			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);

Linus Torvalds's avatar
Linus Torvalds committed
452
			if (unlikely(error)) {
453 454 455 456
				if (atomic) {
					atomic = 0;
					goto redo2;
				}
457
				if (!ret)
458
					ret = error;
Linus Torvalds's avatar
Linus Torvalds committed
459 460 461 462 463 464 465 466 467
				break;
			}
			ret += chars;

			/* Insert it into the buffer array */
			buf->page = page;
			buf->ops = &anon_pipe_buf_ops;
			buf->offset = 0;
			buf->len = chars;
468 469
			pipe->nrbufs = ++bufs;
			pipe->tmp_page = NULL;
Linus Torvalds's avatar
Linus Torvalds committed
470 471 472 473 474 475 476 477

			total_len -= chars;
			if (!total_len)
				break;
		}
		if (bufs < PIPE_BUFFERS)
			continue;
		if (filp->f_flags & O_NONBLOCK) {
478 479
			if (!ret)
				ret = -EAGAIN;
Linus Torvalds's avatar
Linus Torvalds committed
480 481 482
			break;
		}
		if (signal_pending(current)) {
483 484
			if (!ret)
				ret = -ERESTARTSYS;
Linus Torvalds's avatar
Linus Torvalds committed
485 486 487
			break;
		}
		if (do_wakeup) {
488 489
			wake_up_interruptible_sync(&pipe->wait);
			kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
Linus Torvalds's avatar
Linus Torvalds committed
490 491
			do_wakeup = 0;
		}
492 493 494
		pipe->waiting_writers++;
		pipe_wait(pipe);
		pipe->waiting_writers--;
Linus Torvalds's avatar
Linus Torvalds committed
495 496
	}
out:
497
	mutex_unlock(&inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
498
	if (do_wakeup) {
499 500
		wake_up_interruptible(&pipe->wait);
		kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
Linus Torvalds's avatar
Linus Torvalds committed
501 502
	}
	if (ret > 0)
503
		file_update_time(filp);
Linus Torvalds's avatar
Linus Torvalds committed
504 505 506 507 508 509 510 511 512 513
	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
514 515
bad_pipe_w(struct file *filp, const char __user *buf, size_t count,
	   loff_t *ppos)
Linus Torvalds's avatar
Linus Torvalds committed
516 517 518 519 520 521 522 523
{
	return -EBADF;
}

static int
pipe_ioctl(struct inode *pino, struct file *filp,
	   unsigned int cmd, unsigned long arg)
{
524
	struct inode *inode = filp->f_path.dentry->d_inode;
525
	struct pipe_inode_info *pipe;
Linus Torvalds's avatar
Linus Torvalds committed
526 527 528 529
	int count, buf, nrbufs;

	switch (cmd) {
		case FIONREAD:
530
			mutex_lock(&inode->i_mutex);
531
			pipe = inode->i_pipe;
Linus Torvalds's avatar
Linus Torvalds committed
532
			count = 0;
533 534
			buf = pipe->curbuf;
			nrbufs = pipe->nrbufs;
Linus Torvalds's avatar
Linus Torvalds committed
535
			while (--nrbufs >= 0) {
536
				count += pipe->bufs[buf].len;
Linus Torvalds's avatar
Linus Torvalds committed
537 538
				buf = (buf+1) & (PIPE_BUFFERS-1);
			}
539
			mutex_unlock(&inode->i_mutex);
540

Linus Torvalds's avatar
Linus Torvalds committed
541 542 543 544 545 546 547 548 549 550 551
			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;
552
	struct inode *inode = filp->f_path.dentry->d_inode;
553
	struct pipe_inode_info *pipe = inode->i_pipe;
Linus Torvalds's avatar
Linus Torvalds committed
554 555
	int nrbufs;

556
	poll_wait(filp, &pipe->wait, wait);
Linus Torvalds's avatar
Linus Torvalds committed
557 558

	/* Reading only -- no need for acquiring the semaphore.  */
559
	nrbufs = pipe->nrbufs;
Linus Torvalds's avatar
Linus Torvalds committed
560 561 562
	mask = 0;
	if (filp->f_mode & FMODE_READ) {
		mask = (nrbufs > 0) ? POLLIN | POLLRDNORM : 0;
563
		if (!pipe->writers && filp->f_version != pipe->w_counter)
Linus Torvalds's avatar
Linus Torvalds committed
564 565 566 567 568
			mask |= POLLHUP;
	}

	if (filp->f_mode & FMODE_WRITE) {
		mask |= (nrbufs < PIPE_BUFFERS) ? POLLOUT | POLLWRNORM : 0;
569 570 571 572
		/*
		 * Most Unices do not set POLLERR for FIFOs but on Linux they
		 * behave exactly like pipes for poll().
		 */
573
		if (!pipe->readers)
Linus Torvalds's avatar
Linus Torvalds committed
574 575 576 577 578 579 580 581 582
			mask |= POLLERR;
	}

	return mask;
}

static int
pipe_release(struct inode *inode, int decr, int decw)
{
583 584
	struct pipe_inode_info *pipe;

585
	mutex_lock(&inode->i_mutex);
586 587 588
	pipe = inode->i_pipe;
	pipe->readers -= decr;
	pipe->writers -= decw;
589

590
	if (!pipe->readers && !pipe->writers) {
Linus Torvalds's avatar
Linus Torvalds committed
591 592
		free_pipe_info(inode);
	} else {
593 594 595
		wake_up_interruptible(&pipe->wait);
		kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
		kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
Linus Torvalds's avatar
Linus Torvalds committed
596
	}
597
	mutex_unlock(&inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
598 599 600 601 602 603 604

	return 0;
}

static int
pipe_read_fasync(int fd, struct file *filp, int on)
{
605
	struct inode *inode = filp->f_path.dentry->d_inode;
Linus Torvalds's avatar
Linus Torvalds committed
606 607
	int retval;

608 609 610
	mutex_lock(&inode->i_mutex);
	retval = fasync_helper(fd, filp, on, &inode->i_pipe->fasync_readers);
	mutex_unlock(&inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
611 612 613 614 615 616 617 618 619 620 621

	if (retval < 0)
		return retval;

	return 0;
}


static int
pipe_write_fasync(int fd, struct file *filp, int on)
{
622
	struct inode *inode = filp->f_path.dentry->d_inode;
Linus Torvalds's avatar
Linus Torvalds committed
623 624
	int retval;

625 626 627
	mutex_lock(&inode->i_mutex);
	retval = fasync_helper(fd, filp, on, &inode->i_pipe->fasync_writers);
	mutex_unlock(&inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
628 629 630 631 632 633 634 635 636 637 638

	if (retval < 0)
		return retval;

	return 0;
}


static int
pipe_rdwr_fasync(int fd, struct file *filp, int on)
{
639
	struct inode *inode = filp->f_path.dentry->d_inode;
640
	struct pipe_inode_info *pipe = inode->i_pipe;
Linus Torvalds's avatar
Linus Torvalds committed
641 642
	int retval;

643
	mutex_lock(&inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
644

645
	retval = fasync_helper(fd, filp, on, &pipe->fasync_readers);
Linus Torvalds's avatar
Linus Torvalds committed
646 647

	if (retval >= 0)
648
		retval = fasync_helper(fd, filp, on, &pipe->fasync_writers);
Linus Torvalds's avatar
Linus Torvalds committed
649

650
	mutex_unlock(&inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688

	if (retval < 0)
		return retval;

	return 0;
}


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

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

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

	pipe_rdwr_fasync(-1, filp, 0);
	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.  */
689 690 691
	mutex_lock(&inode->i_mutex);
	inode->i_pipe->readers++;
	mutex_unlock(&inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
692 693 694 695 696 697 698

	return 0;
}

static int
pipe_write_open(struct inode *inode, struct file *filp)
{
699 700 701
	mutex_lock(&inode->i_mutex);
	inode->i_pipe->writers++;
	mutex_unlock(&inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
702 703 704 705 706 707 708

	return 0;
}

static int
pipe_rdwr_open(struct inode *inode, struct file *filp)
{
709
	mutex_lock(&inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
710
	if (filp->f_mode & FMODE_READ)
711
		inode->i_pipe->readers++;
Linus Torvalds's avatar
Linus Torvalds committed
712
	if (filp->f_mode & FMODE_WRITE)
713 714
		inode->i_pipe->writers++;
	mutex_unlock(&inode->i_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
715 716 717 718 719 720 721 722

	return 0;
}

/*
 * The file_operations structs are not static because they
 * are also used in linux/fs/fifo.c to do operations on FIFOs.
 */
723
const struct file_operations read_fifo_fops = {
Linus Torvalds's avatar
Linus Torvalds committed
724
	.llseek		= no_llseek,
725 726
	.read		= do_sync_read,
	.aio_read	= pipe_read,
Linus Torvalds's avatar
Linus Torvalds committed
727
	.write		= bad_pipe_w,
728
	.poll		= pipe_poll,
Linus Torvalds's avatar
Linus Torvalds committed
729 730 731 732 733 734
	.ioctl		= pipe_ioctl,
	.open		= pipe_read_open,
	.release	= pipe_read_release,
	.fasync		= pipe_read_fasync,
};

735
const struct file_operations write_fifo_fops = {
Linus Torvalds's avatar
Linus Torvalds committed
736 737
	.llseek		= no_llseek,
	.read		= bad_pipe_r,
738 739
	.write		= do_sync_write,
	.aio_write	= pipe_write,
740
	.poll		= pipe_poll,
Linus Torvalds's avatar
Linus Torvalds committed
741 742 743 744 745 746
	.ioctl		= pipe_ioctl,
	.open		= pipe_write_open,
	.release	= pipe_write_release,
	.fasync		= pipe_write_fasync,
};

747
const struct file_operations rdwr_fifo_fops = {
Linus Torvalds's avatar
Linus Torvalds committed
748
	.llseek		= no_llseek,
749 750 751 752
	.read		= do_sync_read,
	.aio_read	= pipe_read,
	.write		= do_sync_write,
	.aio_write	= pipe_write,
753
	.poll		= pipe_poll,
Linus Torvalds's avatar
Linus Torvalds committed
754 755 756 757 758 759
	.ioctl		= pipe_ioctl,
	.open		= pipe_rdwr_open,
	.release	= pipe_rdwr_release,
	.fasync		= pipe_rdwr_fasync,
};

760
static const struct file_operations read_pipe_fops = {
Linus Torvalds's avatar
Linus Torvalds committed
761
	.llseek		= no_llseek,
762 763
	.read		= do_sync_read,
	.aio_read	= pipe_read,
Linus Torvalds's avatar
Linus Torvalds committed
764 765 766 767 768 769 770 771
	.write		= bad_pipe_w,
	.poll		= pipe_poll,
	.ioctl		= pipe_ioctl,
	.open		= pipe_read_open,
	.release	= pipe_read_release,
	.fasync		= pipe_read_fasync,
};

772
static const struct file_operations write_pipe_fops = {
Linus Torvalds's avatar
Linus Torvalds committed
773 774
	.llseek		= no_llseek,
	.read		= bad_pipe_r,
775 776
	.write		= do_sync_write,
	.aio_write	= pipe_write,
Linus Torvalds's avatar
Linus Torvalds committed
777 778 779 780 781 782 783
	.poll		= pipe_poll,
	.ioctl		= pipe_ioctl,
	.open		= pipe_write_open,
	.release	= pipe_write_release,
	.fasync		= pipe_write_fasync,
};

784
static const struct file_operations rdwr_pipe_fops = {
Linus Torvalds's avatar
Linus Torvalds committed
785
	.llseek		= no_llseek,
786 787 788 789
	.read		= do_sync_read,
	.aio_read	= pipe_read,
	.write		= do_sync_write,
	.aio_write	= pipe_write,
Linus Torvalds's avatar
Linus Torvalds committed
790 791 792 793 794 795 796
	.poll		= pipe_poll,
	.ioctl		= pipe_ioctl,
	.open		= pipe_rdwr_open,
	.release	= pipe_rdwr_release,
	.fasync		= pipe_rdwr_fasync,
};

797 798
struct pipe_inode_info * alloc_pipe_info(struct inode *inode)
{
799
	struct pipe_inode_info *pipe;
800

801 802 803 804 805
	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;
806 807
	}

808
	return pipe;
809 810
}

811
void __free_pipe_info(struct pipe_inode_info *pipe)
Linus Torvalds's avatar
Linus Torvalds committed
812 813 814 815
{
	int i;

	for (i = 0; i < PIPE_BUFFERS; i++) {
816
		struct pipe_buffer *buf = pipe->bufs + i;
Linus Torvalds's avatar
Linus Torvalds committed
817
		if (buf->ops)
818
			buf->ops->release(pipe, buf);
Linus Torvalds's avatar
Linus Torvalds committed
819
	}
820 821 822
	if (pipe->tmp_page)
		__free_page(pipe->tmp_page);
	kfree(pipe);
Linus Torvalds's avatar
Linus Torvalds committed
823 824
}

825 826 827 828 829 830
void free_pipe_info(struct inode *inode)
{
	__free_pipe_info(inode->i_pipe);
	inode->i_pipe = NULL;
}

831
static struct vfsmount *pipe_mnt __read_mostly;
Linus Torvalds's avatar
Linus Torvalds committed
832 833
static int pipefs_delete_dentry(struct dentry *dentry)
{
834 835 836 837 838 839 840 841
	/*
	 * 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;
Linus Torvalds's avatar
Linus Torvalds committed
842
}
843

Linus Torvalds's avatar
Linus Torvalds committed
844 845 846 847 848 849 850
static struct dentry_operations pipefs_dentry_operations = {
	.d_delete	= pipefs_delete_dentry,
};

static struct inode * get_pipe_inode(void)
{
	struct inode *inode = new_inode(pipe_mnt->mnt_sb);
851
	struct pipe_inode_info *pipe;
Linus Torvalds's avatar
Linus Torvalds committed
852 853 854 855

	if (!inode)
		goto fail_inode;

856 857
	pipe = alloc_pipe_info(inode);
	if (!pipe)
Linus Torvalds's avatar
Linus Torvalds committed
858
		goto fail_iput;
859
	inode->i_pipe = pipe;
860

861
	pipe->readers = pipe->writers = 1;
Linus Torvalds's avatar
Linus Torvalds committed
862 863 864 865 866 867 868 869 870 871 872 873 874
	inode->i_fop = &rdwr_pipe_fops;

	/*
	 * 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;
	inode->i_uid = current->fsuid;
	inode->i_gid = current->fsgid;
	inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
875

Linus Torvalds's avatar
Linus Torvalds committed
876 877 878 879
	return inode;

fail_iput:
	iput(inode);
880

Linus Torvalds's avatar
Linus Torvalds committed
881 882 883 884
fail_inode:
	return NULL;
}

885
struct file *create_write_pipe(void)
Linus Torvalds's avatar
Linus Torvalds committed
886
{
887 888 889
	int err;
	struct inode *inode;
	struct file *f;
Linus Torvalds's avatar
Linus Torvalds committed
890
	struct dentry *dentry;
891 892
	char name[32];
	struct qstr this;
Linus Torvalds's avatar
Linus Torvalds committed
893

894 895 896 897
	f = get_empty_filp();
	if (!f)
		return ERR_PTR(-ENFILE);
	err = -ENFILE;
Linus Torvalds's avatar
Linus Torvalds committed
898 899
	inode = get_pipe_inode();
	if (!inode)
900
		goto err_file;
Linus Torvalds's avatar
Linus Torvalds committed
901

902
	this.len = sprintf(name, "[%lu]", inode->i_ino);
Linus Torvalds's avatar
Linus Torvalds committed
903
	this.name = name;
904
	this.hash = 0;
905
	err = -ENOMEM;
Linus Torvalds's avatar
Linus Torvalds committed
906 907
	dentry = d_alloc(pipe_mnt->mnt_sb->s_root, &this);
	if (!dentry)
908
		goto err_inode;
909

Linus Torvalds's avatar
Linus Torvalds committed
910
	dentry->d_op = &pipefs_dentry_operations;
911 912 913 914 915 916 917
	/*
	 * 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);
918 919
	f->f_path.mnt = mntget(pipe_mnt);
	f->f_path.dentry = dentry;
920
	f->f_mapping = inode->i_mapping;
921

922 923 924 925 926 927
	f->f_flags = O_WRONLY;
	f->f_op = &write_pipe_fops;
	f->f_mode = FMODE_WRITE;
	f->f_version = 0;

	return f;
Linus Torvalds's avatar
Linus Torvalds committed
928

929
 err_inode:
Linus Torvalds's avatar
Linus Torvalds committed
930 931
	free_pipe_info(inode);
	iput(inode);
932 933 934 935 936 937 938
 err_file:
	put_filp(f);
	return ERR_PTR(err);
}

void free_write_pipe(struct file *f)
{
939
	free_pipe_info(f->f_dentry->d_inode);
940
	dput(f->f_path.dentry);
941
	mntput(f->f_path.mnt);
942 943 944 945 946 947 948 949 950 951
	put_filp(f);
}

struct file *create_read_pipe(struct file *wrf)
{
	struct file *f = get_empty_filp();
	if (!f)
		return ERR_PTR(-ENFILE);

	/* Grab pipe from the writer */
952 953 954
	f->f_path.mnt = mntget(wrf->f_path.mnt);
	f->f_path.dentry = dget(wrf->f_path.dentry);
	f->f_mapping = wrf->f_path.dentry->d_inode->i_mapping;
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988

	f->f_pos = 0;
	f->f_flags = O_RDONLY;
	f->f_op = &read_pipe_fops;
	f->f_mode = FMODE_READ;
	f->f_version = 0;

	return f;
}

int do_pipe(int *fd)
{
	struct file *fw, *fr;
	int error;
	int fdw, fdr;

	fw = create_write_pipe();
	if (IS_ERR(fw))
		return PTR_ERR(fw);
	fr = create_read_pipe(fw);
	error = PTR_ERR(fr);
	if (IS_ERR(fr))
		goto err_write_pipe;

	error = get_unused_fd();
	if (error < 0)
		goto err_read_pipe;
	fdr = error;

	error = get_unused_fd();
	if (error < 0)
		goto err_fdr;
	fdw = error;

Al Viro's avatar
Al Viro committed
989 990 991 992
	error = audit_fd_pair(fdr, fdw);
	if (error < 0)
		goto err_fdw;

993 994 995 996 997 998 999
	fd_install(fdr, fr);
	fd_install(fdw, fw);
	fd[0] = fdr;
	fd[1] = fdw;

	return 0;

Al Viro's avatar
Al Viro committed
1000 1001
 err_fdw:
	put_unused_fd(fdw);
1002 1003 1004
 err_fdr:
	put_unused_fd(fdr);
 err_read_pipe:
1005 1006
	dput(fr->f_dentry);
	mntput(fr->f_vfsmnt);
1007 1008 1009 1010
	put_filp(fr);
 err_write_pipe:
	free_write_pipe(fw);
	return error;
Linus Torvalds's avatar
Linus Torvalds committed
1011 1012 1013 1014 1015 1016 1017 1018
}

/*
 * 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.
 */
1019 1020 1021
static int pipefs_get_sb(struct file_system_type *fs_type,
			 int flags, const char *dev_name, void *data,
			 struct vfsmount *mnt)
Linus Torvalds's avatar
Linus Torvalds committed
1022
{
1023
	return get_sb_pseudo(fs_type, "pipe:", NULL, PIPEFS_MAGIC, mnt);
Linus Torvalds's avatar
Linus Torvalds committed
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
}

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

Linus Torvalds's avatar
Linus Torvalds committed
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
	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);