move some stuff from common.c to neighbor.c
[cor.git] / fs / pipe.c
blobb901c8eefafd72829f76580cc6f13bbe5ed347f6
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * linux/fs/pipe.c
5 * Copyright (C) 1991, 1992, 1999 Linus Torvalds
6 */
8 #include <linux/mm.h>
9 #include <linux/file.h>
10 #include <linux/poll.h>
11 #include <linux/slab.h>
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/fs.h>
15 #include <linux/log2.h>
16 #include <linux/mount.h>
17 #include <linux/pseudo_fs.h>
18 #include <linux/magic.h>
19 #include <linux/pipe_fs_i.h>
20 #include <linux/uio.h>
21 #include <linux/highmem.h>
22 #include <linux/pagemap.h>
23 #include <linux/audit.h>
24 #include <linux/syscalls.h>
25 #include <linux/fcntl.h>
26 #include <linux/memcontrol.h>
28 #include <linux/uaccess.h>
29 #include <asm/ioctls.h>
31 #include "internal.h"
34 * The max size that a non-root user is allowed to grow the pipe. Can
35 * be set by root in /proc/sys/fs/pipe-max-size
37 unsigned int pipe_max_size = 1048576;
39 /* Maximum allocatable pages per user. Hard limit is unset by default, soft
40 * matches default values.
42 unsigned long pipe_user_pages_hard;
43 unsigned long pipe_user_pages_soft = PIPE_DEF_BUFFERS * INR_OPEN_CUR;
46 * We use head and tail indices that aren't masked off, except at the point of
47 * dereference, but rather they're allowed to wrap naturally. This means there
48 * isn't a dead spot in the buffer, but the ring has to be a power of two and
49 * <= 2^31.
50 * -- David Howells 2019-09-23.
52 * Reads with count = 0 should always return 0.
53 * -- Julian Bradfield 1999-06-07.
55 * FIFOs and Pipes now generate SIGIO for both readers and writers.
56 * -- Jeremy Elson <jelson@circlemud.org> 2001-08-16
58 * pipe_read & write cleanup
59 * -- Manfred Spraul <manfred@colorfullife.com> 2002-05-09
62 static void pipe_lock_nested(struct pipe_inode_info *pipe, int subclass)
64 if (pipe->files)
65 mutex_lock_nested(&pipe->mutex, subclass);
68 void pipe_lock(struct pipe_inode_info *pipe)
71 * pipe_lock() nests non-pipe inode locks (for writing to a file)
73 pipe_lock_nested(pipe, I_MUTEX_PARENT);
75 EXPORT_SYMBOL(pipe_lock);
77 void pipe_unlock(struct pipe_inode_info *pipe)
79 if (pipe->files)
80 mutex_unlock(&pipe->mutex);
82 EXPORT_SYMBOL(pipe_unlock);
84 static inline void __pipe_lock(struct pipe_inode_info *pipe)
86 mutex_lock_nested(&pipe->mutex, I_MUTEX_PARENT);
89 static inline void __pipe_unlock(struct pipe_inode_info *pipe)
91 mutex_unlock(&pipe->mutex);
94 void pipe_double_lock(struct pipe_inode_info *pipe1,
95 struct pipe_inode_info *pipe2)
97 BUG_ON(pipe1 == pipe2);
99 if (pipe1 < pipe2) {
100 pipe_lock_nested(pipe1, I_MUTEX_PARENT);
101 pipe_lock_nested(pipe2, I_MUTEX_CHILD);
102 } else {
103 pipe_lock_nested(pipe2, I_MUTEX_PARENT);
104 pipe_lock_nested(pipe1, I_MUTEX_CHILD);
108 /* Drop the inode semaphore and wait for a pipe event, atomically */
109 void pipe_wait(struct pipe_inode_info *pipe)
111 DEFINE_WAIT(wait);
114 * Pipes are system-local resources, so sleeping on them
115 * is considered a noninteractive wait:
117 prepare_to_wait(&pipe->wait, &wait, TASK_INTERRUPTIBLE);
118 pipe_unlock(pipe);
119 schedule();
120 finish_wait(&pipe->wait, &wait);
121 pipe_lock(pipe);
124 static void anon_pipe_buf_release(struct pipe_inode_info *pipe,
125 struct pipe_buffer *buf)
127 struct page *page = buf->page;
130 * If nobody else uses this page, and we don't already have a
131 * temporary page, let's keep track of it as a one-deep
132 * allocation cache. (Otherwise just release our reference to it)
134 if (page_count(page) == 1 && !pipe->tmp_page)
135 pipe->tmp_page = page;
136 else
137 put_page(page);
140 static int anon_pipe_buf_steal(struct pipe_inode_info *pipe,
141 struct pipe_buffer *buf)
143 struct page *page = buf->page;
145 if (page_count(page) == 1) {
146 memcg_kmem_uncharge(page, 0);
147 __SetPageLocked(page);
148 return 0;
150 return 1;
154 * generic_pipe_buf_steal - attempt to take ownership of a &pipe_buffer
155 * @pipe: the pipe that the buffer belongs to
156 * @buf: the buffer to attempt to steal
158 * Description:
159 * This function attempts to steal the &struct page attached to
160 * @buf. If successful, this function returns 0 and returns with
161 * the page locked. The caller may then reuse the page for whatever
162 * he wishes; the typical use is insertion into a different file
163 * page cache.
165 int generic_pipe_buf_steal(struct pipe_inode_info *pipe,
166 struct pipe_buffer *buf)
168 struct page *page = buf->page;
171 * A reference of one is golden, that means that the owner of this
172 * page is the only one holding a reference to it. lock the page
173 * and return OK.
175 if (page_count(page) == 1) {
176 lock_page(page);
177 return 0;
180 return 1;
182 EXPORT_SYMBOL(generic_pipe_buf_steal);
185 * generic_pipe_buf_get - get a reference to a &struct pipe_buffer
186 * @pipe: the pipe that the buffer belongs to
187 * @buf: the buffer to get a reference to
189 * Description:
190 * This function grabs an extra reference to @buf. It's used in
191 * in the tee() system call, when we duplicate the buffers in one
192 * pipe into another.
194 bool generic_pipe_buf_get(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
196 return try_get_page(buf->page);
198 EXPORT_SYMBOL(generic_pipe_buf_get);
201 * generic_pipe_buf_confirm - verify contents of the pipe buffer
202 * @info: the pipe that the buffer belongs to
203 * @buf: the buffer to confirm
205 * Description:
206 * This function does nothing, because the generic pipe code uses
207 * pages that are always good when inserted into the pipe.
209 int generic_pipe_buf_confirm(struct pipe_inode_info *info,
210 struct pipe_buffer *buf)
212 return 0;
214 EXPORT_SYMBOL(generic_pipe_buf_confirm);
217 * generic_pipe_buf_release - put a reference to a &struct pipe_buffer
218 * @pipe: the pipe that the buffer belongs to
219 * @buf: the buffer to put a reference to
221 * Description:
222 * This function releases a reference to @buf.
224 void generic_pipe_buf_release(struct pipe_inode_info *pipe,
225 struct pipe_buffer *buf)
227 put_page(buf->page);
229 EXPORT_SYMBOL(generic_pipe_buf_release);
231 /* New data written to a pipe may be appended to a buffer with this type. */
232 static const struct pipe_buf_operations anon_pipe_buf_ops = {
233 .confirm = generic_pipe_buf_confirm,
234 .release = anon_pipe_buf_release,
235 .steal = anon_pipe_buf_steal,
236 .get = generic_pipe_buf_get,
239 static const struct pipe_buf_operations anon_pipe_buf_nomerge_ops = {
240 .confirm = generic_pipe_buf_confirm,
241 .release = anon_pipe_buf_release,
242 .steal = anon_pipe_buf_steal,
243 .get = generic_pipe_buf_get,
246 static const struct pipe_buf_operations packet_pipe_buf_ops = {
247 .confirm = generic_pipe_buf_confirm,
248 .release = anon_pipe_buf_release,
249 .steal = anon_pipe_buf_steal,
250 .get = generic_pipe_buf_get,
254 * pipe_buf_mark_unmergeable - mark a &struct pipe_buffer as unmergeable
255 * @buf: the buffer to mark
257 * Description:
258 * This function ensures that no future writes will be merged into the
259 * given &struct pipe_buffer. This is necessary when multiple pipe buffers
260 * share the same backing page.
262 void pipe_buf_mark_unmergeable(struct pipe_buffer *buf)
264 if (buf->ops == &anon_pipe_buf_ops)
265 buf->ops = &anon_pipe_buf_nomerge_ops;
268 static bool pipe_buf_can_merge(struct pipe_buffer *buf)
270 return buf->ops == &anon_pipe_buf_ops;
273 static ssize_t
274 pipe_read(struct kiocb *iocb, struct iov_iter *to)
276 size_t total_len = iov_iter_count(to);
277 struct file *filp = iocb->ki_filp;
278 struct pipe_inode_info *pipe = filp->private_data;
279 int do_wakeup;
280 ssize_t ret;
282 /* Null read succeeds. */
283 if (unlikely(total_len == 0))
284 return 0;
286 do_wakeup = 0;
287 ret = 0;
288 __pipe_lock(pipe);
289 for (;;) {
290 unsigned int head = pipe->head;
291 unsigned int tail = pipe->tail;
292 unsigned int mask = pipe->ring_size - 1;
294 if (!pipe_empty(head, tail)) {
295 struct pipe_buffer *buf = &pipe->bufs[tail & mask];
296 size_t chars = buf->len;
297 size_t written;
298 int error;
300 if (chars > total_len)
301 chars = total_len;
303 error = pipe_buf_confirm(pipe, buf);
304 if (error) {
305 if (!ret)
306 ret = error;
307 break;
310 written = copy_page_to_iter(buf->page, buf->offset, chars, to);
311 if (unlikely(written < chars)) {
312 if (!ret)
313 ret = -EFAULT;
314 break;
316 ret += chars;
317 buf->offset += chars;
318 buf->len -= chars;
320 /* Was it a packet buffer? Clean up and exit */
321 if (buf->flags & PIPE_BUF_FLAG_PACKET) {
322 total_len = chars;
323 buf->len = 0;
326 if (!buf->len) {
327 bool wake;
328 pipe_buf_release(pipe, buf);
329 spin_lock_irq(&pipe->wait.lock);
330 tail++;
331 pipe->tail = tail;
332 do_wakeup = 1;
333 wake = head - (tail - 1) == pipe->max_usage / 2;
334 if (wake)
335 wake_up_locked_poll(
336 &pipe->wait, EPOLLOUT | EPOLLWRNORM);
337 spin_unlock_irq(&pipe->wait.lock);
338 if (wake)
339 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
341 total_len -= chars;
342 if (!total_len)
343 break; /* common path: read succeeded */
344 if (!pipe_empty(head, tail)) /* More to do? */
345 continue;
348 if (!pipe->writers)
349 break;
350 if (!pipe->waiting_writers) {
351 /* syscall merging: Usually we must not sleep
352 * if O_NONBLOCK is set, or if we got some data.
353 * But if a writer sleeps in kernel space, then
354 * we can wait for that data without violating POSIX.
356 if (ret)
357 break;
358 if (filp->f_flags & O_NONBLOCK) {
359 ret = -EAGAIN;
360 break;
363 if (signal_pending(current)) {
364 if (!ret)
365 ret = -ERESTARTSYS;
366 break;
368 pipe_wait(pipe);
370 __pipe_unlock(pipe);
372 /* Signal writers asynchronously that there is more room. */
373 if (do_wakeup) {
374 wake_up_interruptible_poll(&pipe->wait, EPOLLOUT | EPOLLWRNORM);
375 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
377 if (ret > 0)
378 file_accessed(filp);
379 return ret;
382 static inline int is_packetized(struct file *file)
384 return (file->f_flags & O_DIRECT) != 0;
387 static ssize_t
388 pipe_write(struct kiocb *iocb, struct iov_iter *from)
390 struct file *filp = iocb->ki_filp;
391 struct pipe_inode_info *pipe = filp->private_data;
392 unsigned int head;
393 ssize_t ret = 0;
394 int do_wakeup = 0;
395 size_t total_len = iov_iter_count(from);
396 ssize_t chars;
398 /* Null write succeeds. */
399 if (unlikely(total_len == 0))
400 return 0;
402 __pipe_lock(pipe);
404 if (!pipe->readers) {
405 send_sig(SIGPIPE, current, 0);
406 ret = -EPIPE;
407 goto out;
410 head = pipe->head;
412 /* We try to merge small writes */
413 chars = total_len & (PAGE_SIZE-1); /* size of the last buffer */
414 if (!pipe_empty(head, pipe->tail) && chars != 0) {
415 unsigned int mask = pipe->ring_size - 1;
416 struct pipe_buffer *buf = &pipe->bufs[(head - 1) & mask];
417 int offset = buf->offset + buf->len;
419 if (pipe_buf_can_merge(buf) && offset + chars <= PAGE_SIZE) {
420 ret = pipe_buf_confirm(pipe, buf);
421 if (ret)
422 goto out;
424 ret = copy_page_from_iter(buf->page, offset, chars, from);
425 if (unlikely(ret < chars)) {
426 ret = -EFAULT;
427 goto out;
429 do_wakeup = 1;
430 buf->len += ret;
431 if (!iov_iter_count(from))
432 goto out;
436 for (;;) {
437 if (!pipe->readers) {
438 send_sig(SIGPIPE, current, 0);
439 if (!ret)
440 ret = -EPIPE;
441 break;
444 head = pipe->head;
445 if (!pipe_full(head, pipe->tail, pipe->max_usage)) {
446 unsigned int mask = pipe->ring_size - 1;
447 struct pipe_buffer *buf = &pipe->bufs[head & mask];
448 struct page *page = pipe->tmp_page;
449 int copied;
451 if (!page) {
452 page = alloc_page(GFP_HIGHUSER | __GFP_ACCOUNT);
453 if (unlikely(!page)) {
454 ret = ret ? : -ENOMEM;
455 break;
457 pipe->tmp_page = page;
460 /* Allocate a slot in the ring in advance and attach an
461 * empty buffer. If we fault or otherwise fail to use
462 * it, either the reader will consume it or it'll still
463 * be there for the next write.
465 spin_lock_irq(&pipe->wait.lock);
467 head = pipe->head;
468 if (pipe_full(head, pipe->tail, pipe->max_usage)) {
469 spin_unlock_irq(&pipe->wait.lock);
470 continue;
473 pipe->head = head + 1;
475 /* Always wake up, even if the copy fails. Otherwise
476 * we lock up (O_NONBLOCK-)readers that sleep due to
477 * syscall merging.
478 * FIXME! Is this really true?
480 wake_up_locked_poll(
481 &pipe->wait, EPOLLIN | EPOLLRDNORM);
483 spin_unlock_irq(&pipe->wait.lock);
484 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
486 /* Insert it into the buffer array */
487 buf = &pipe->bufs[head & mask];
488 buf->page = page;
489 buf->ops = &anon_pipe_buf_ops;
490 buf->offset = 0;
491 buf->len = 0;
492 buf->flags = 0;
493 if (is_packetized(filp)) {
494 buf->ops = &packet_pipe_buf_ops;
495 buf->flags = PIPE_BUF_FLAG_PACKET;
497 pipe->tmp_page = NULL;
499 copied = copy_page_from_iter(page, 0, PAGE_SIZE, from);
500 if (unlikely(copied < PAGE_SIZE && iov_iter_count(from))) {
501 if (!ret)
502 ret = -EFAULT;
503 break;
505 ret += copied;
506 buf->offset = 0;
507 buf->len = copied;
509 if (!iov_iter_count(from))
510 break;
513 if (!pipe_full(head, pipe->tail, pipe->max_usage))
514 continue;
516 /* Wait for buffer space to become available. */
517 if (filp->f_flags & O_NONBLOCK) {
518 if (!ret)
519 ret = -EAGAIN;
520 break;
522 if (signal_pending(current)) {
523 if (!ret)
524 ret = -ERESTARTSYS;
525 break;
527 pipe->waiting_writers++;
528 pipe_wait(pipe);
529 pipe->waiting_writers--;
531 out:
532 __pipe_unlock(pipe);
533 if (do_wakeup) {
534 wake_up_interruptible_poll(&pipe->wait, EPOLLIN | EPOLLRDNORM);
535 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
537 if (ret > 0 && sb_start_write_trylock(file_inode(filp)->i_sb)) {
538 int err = file_update_time(filp);
539 if (err)
540 ret = err;
541 sb_end_write(file_inode(filp)->i_sb);
543 return ret;
546 static long pipe_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
548 struct pipe_inode_info *pipe = filp->private_data;
549 int count, head, tail, mask;
551 switch (cmd) {
552 case FIONREAD:
553 __pipe_lock(pipe);
554 count = 0;
555 head = pipe->head;
556 tail = pipe->tail;
557 mask = pipe->ring_size - 1;
559 while (tail != head) {
560 count += pipe->bufs[tail & mask].len;
561 tail++;
563 __pipe_unlock(pipe);
565 return put_user(count, (int __user *)arg);
566 default:
567 return -ENOIOCTLCMD;
571 /* No kernel lock held - fine */
572 static __poll_t
573 pipe_poll(struct file *filp, poll_table *wait)
575 __poll_t mask;
576 struct pipe_inode_info *pipe = filp->private_data;
577 unsigned int head = READ_ONCE(pipe->head);
578 unsigned int tail = READ_ONCE(pipe->tail);
580 poll_wait(filp, &pipe->wait, wait);
582 /* Reading only -- no need for acquiring the semaphore. */
583 mask = 0;
584 if (filp->f_mode & FMODE_READ) {
585 if (!pipe_empty(head, tail))
586 mask |= EPOLLIN | EPOLLRDNORM;
587 if (!pipe->writers && filp->f_version != pipe->w_counter)
588 mask |= EPOLLHUP;
591 if (filp->f_mode & FMODE_WRITE) {
592 if (!pipe_full(head, tail, pipe->max_usage))
593 mask |= EPOLLOUT | EPOLLWRNORM;
595 * Most Unices do not set EPOLLERR for FIFOs but on Linux they
596 * behave exactly like pipes for poll().
598 if (!pipe->readers)
599 mask |= EPOLLERR;
602 return mask;
605 static void put_pipe_info(struct inode *inode, struct pipe_inode_info *pipe)
607 int kill = 0;
609 spin_lock(&inode->i_lock);
610 if (!--pipe->files) {
611 inode->i_pipe = NULL;
612 kill = 1;
614 spin_unlock(&inode->i_lock);
616 if (kill)
617 free_pipe_info(pipe);
620 static int
621 pipe_release(struct inode *inode, struct file *file)
623 struct pipe_inode_info *pipe = file->private_data;
625 __pipe_lock(pipe);
626 if (file->f_mode & FMODE_READ)
627 pipe->readers--;
628 if (file->f_mode & FMODE_WRITE)
629 pipe->writers--;
631 if (pipe->readers || pipe->writers) {
632 wake_up_interruptible_sync_poll(&pipe->wait, EPOLLIN | EPOLLOUT | EPOLLRDNORM | EPOLLWRNORM | EPOLLERR | EPOLLHUP);
633 kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
634 kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
636 __pipe_unlock(pipe);
638 put_pipe_info(inode, pipe);
639 return 0;
642 static int
643 pipe_fasync(int fd, struct file *filp, int on)
645 struct pipe_inode_info *pipe = filp->private_data;
646 int retval = 0;
648 __pipe_lock(pipe);
649 if (filp->f_mode & FMODE_READ)
650 retval = fasync_helper(fd, filp, on, &pipe->fasync_readers);
651 if ((filp->f_mode & FMODE_WRITE) && retval >= 0) {
652 retval = fasync_helper(fd, filp, on, &pipe->fasync_writers);
653 if (retval < 0 && (filp->f_mode & FMODE_READ))
654 /* this can happen only if on == T */
655 fasync_helper(-1, filp, 0, &pipe->fasync_readers);
657 __pipe_unlock(pipe);
658 return retval;
661 static unsigned long account_pipe_buffers(struct user_struct *user,
662 unsigned long old, unsigned long new)
664 return atomic_long_add_return(new - old, &user->pipe_bufs);
667 static bool too_many_pipe_buffers_soft(unsigned long user_bufs)
669 unsigned long soft_limit = READ_ONCE(pipe_user_pages_soft);
671 return soft_limit && user_bufs > soft_limit;
674 static bool too_many_pipe_buffers_hard(unsigned long user_bufs)
676 unsigned long hard_limit = READ_ONCE(pipe_user_pages_hard);
678 return hard_limit && user_bufs > hard_limit;
681 static bool is_unprivileged_user(void)
683 return !capable(CAP_SYS_RESOURCE) && !capable(CAP_SYS_ADMIN);
686 struct pipe_inode_info *alloc_pipe_info(void)
688 struct pipe_inode_info *pipe;
689 unsigned long pipe_bufs = PIPE_DEF_BUFFERS;
690 struct user_struct *user = get_current_user();
691 unsigned long user_bufs;
692 unsigned int max_size = READ_ONCE(pipe_max_size);
694 pipe = kzalloc(sizeof(struct pipe_inode_info), GFP_KERNEL_ACCOUNT);
695 if (pipe == NULL)
696 goto out_free_uid;
698 if (pipe_bufs * PAGE_SIZE > max_size && !capable(CAP_SYS_RESOURCE))
699 pipe_bufs = max_size >> PAGE_SHIFT;
701 user_bufs = account_pipe_buffers(user, 0, pipe_bufs);
703 if (too_many_pipe_buffers_soft(user_bufs) && is_unprivileged_user()) {
704 user_bufs = account_pipe_buffers(user, pipe_bufs, 1);
705 pipe_bufs = 1;
708 if (too_many_pipe_buffers_hard(user_bufs) && is_unprivileged_user())
709 goto out_revert_acct;
711 pipe->bufs = kcalloc(pipe_bufs, sizeof(struct pipe_buffer),
712 GFP_KERNEL_ACCOUNT);
714 if (pipe->bufs) {
715 init_waitqueue_head(&pipe->wait);
716 pipe->r_counter = pipe->w_counter = 1;
717 pipe->max_usage = pipe_bufs;
718 pipe->ring_size = pipe_bufs;
719 pipe->user = user;
720 mutex_init(&pipe->mutex);
721 return pipe;
724 out_revert_acct:
725 (void) account_pipe_buffers(user, pipe_bufs, 0);
726 kfree(pipe);
727 out_free_uid:
728 free_uid(user);
729 return NULL;
732 void free_pipe_info(struct pipe_inode_info *pipe)
734 int i;
736 (void) account_pipe_buffers(pipe->user, pipe->ring_size, 0);
737 free_uid(pipe->user);
738 for (i = 0; i < pipe->ring_size; i++) {
739 struct pipe_buffer *buf = pipe->bufs + i;
740 if (buf->ops)
741 pipe_buf_release(pipe, buf);
743 if (pipe->tmp_page)
744 __free_page(pipe->tmp_page);
745 kfree(pipe->bufs);
746 kfree(pipe);
749 static struct vfsmount *pipe_mnt __read_mostly;
752 * pipefs_dname() is called from d_path().
754 static char *pipefs_dname(struct dentry *dentry, char *buffer, int buflen)
756 return dynamic_dname(dentry, buffer, buflen, "pipe:[%lu]",
757 d_inode(dentry)->i_ino);
760 static const struct dentry_operations pipefs_dentry_operations = {
761 .d_dname = pipefs_dname,
764 static struct inode * get_pipe_inode(void)
766 struct inode *inode = new_inode_pseudo(pipe_mnt->mnt_sb);
767 struct pipe_inode_info *pipe;
769 if (!inode)
770 goto fail_inode;
772 inode->i_ino = get_next_ino();
774 pipe = alloc_pipe_info();
775 if (!pipe)
776 goto fail_iput;
778 inode->i_pipe = pipe;
779 pipe->files = 2;
780 pipe->readers = pipe->writers = 1;
781 inode->i_fop = &pipefifo_fops;
784 * Mark the inode dirty from the very beginning,
785 * that way it will never be moved to the dirty
786 * list because "mark_inode_dirty()" will think
787 * that it already _is_ on the dirty list.
789 inode->i_state = I_DIRTY;
790 inode->i_mode = S_IFIFO | S_IRUSR | S_IWUSR;
791 inode->i_uid = current_fsuid();
792 inode->i_gid = current_fsgid();
793 inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
795 return inode;
797 fail_iput:
798 iput(inode);
800 fail_inode:
801 return NULL;
804 int create_pipe_files(struct file **res, int flags)
806 struct inode *inode = get_pipe_inode();
807 struct file *f;
809 if (!inode)
810 return -ENFILE;
812 f = alloc_file_pseudo(inode, pipe_mnt, "",
813 O_WRONLY | (flags & (O_NONBLOCK | O_DIRECT)),
814 &pipefifo_fops);
815 if (IS_ERR(f)) {
816 free_pipe_info(inode->i_pipe);
817 iput(inode);
818 return PTR_ERR(f);
821 f->private_data = inode->i_pipe;
823 res[0] = alloc_file_clone(f, O_RDONLY | (flags & O_NONBLOCK),
824 &pipefifo_fops);
825 if (IS_ERR(res[0])) {
826 put_pipe_info(inode, inode->i_pipe);
827 fput(f);
828 return PTR_ERR(res[0]);
830 res[0]->private_data = inode->i_pipe;
831 res[1] = f;
832 stream_open(inode, res[0]);
833 stream_open(inode, res[1]);
834 return 0;
837 static int __do_pipe_flags(int *fd, struct file **files, int flags)
839 int error;
840 int fdw, fdr;
842 if (flags & ~(O_CLOEXEC | O_NONBLOCK | O_DIRECT))
843 return -EINVAL;
845 error = create_pipe_files(files, flags);
846 if (error)
847 return error;
849 error = get_unused_fd_flags(flags);
850 if (error < 0)
851 goto err_read_pipe;
852 fdr = error;
854 error = get_unused_fd_flags(flags);
855 if (error < 0)
856 goto err_fdr;
857 fdw = error;
859 audit_fd_pair(fdr, fdw);
860 fd[0] = fdr;
861 fd[1] = fdw;
862 return 0;
864 err_fdr:
865 put_unused_fd(fdr);
866 err_read_pipe:
867 fput(files[0]);
868 fput(files[1]);
869 return error;
872 int do_pipe_flags(int *fd, int flags)
874 struct file *files[2];
875 int error = __do_pipe_flags(fd, files, flags);
876 if (!error) {
877 fd_install(fd[0], files[0]);
878 fd_install(fd[1], files[1]);
880 return error;
884 * sys_pipe() is the normal C calling standard for creating
885 * a pipe. It's not the way Unix traditionally does this, though.
887 static int do_pipe2(int __user *fildes, int flags)
889 struct file *files[2];
890 int fd[2];
891 int error;
893 error = __do_pipe_flags(fd, files, flags);
894 if (!error) {
895 if (unlikely(copy_to_user(fildes, fd, sizeof(fd)))) {
896 fput(files[0]);
897 fput(files[1]);
898 put_unused_fd(fd[0]);
899 put_unused_fd(fd[1]);
900 error = -EFAULT;
901 } else {
902 fd_install(fd[0], files[0]);
903 fd_install(fd[1], files[1]);
906 return error;
909 SYSCALL_DEFINE2(pipe2, int __user *, fildes, int, flags)
911 return do_pipe2(fildes, flags);
914 SYSCALL_DEFINE1(pipe, int __user *, fildes)
916 return do_pipe2(fildes, 0);
919 static int wait_for_partner(struct pipe_inode_info *pipe, unsigned int *cnt)
921 int cur = *cnt;
923 while (cur == *cnt) {
924 pipe_wait(pipe);
925 if (signal_pending(current))
926 break;
928 return cur == *cnt ? -ERESTARTSYS : 0;
931 static void wake_up_partner(struct pipe_inode_info *pipe)
933 wake_up_interruptible(&pipe->wait);
936 static int fifo_open(struct inode *inode, struct file *filp)
938 struct pipe_inode_info *pipe;
939 bool is_pipe = inode->i_sb->s_magic == PIPEFS_MAGIC;
940 int ret;
942 filp->f_version = 0;
944 spin_lock(&inode->i_lock);
945 if (inode->i_pipe) {
946 pipe = inode->i_pipe;
947 pipe->files++;
948 spin_unlock(&inode->i_lock);
949 } else {
950 spin_unlock(&inode->i_lock);
951 pipe = alloc_pipe_info();
952 if (!pipe)
953 return -ENOMEM;
954 pipe->files = 1;
955 spin_lock(&inode->i_lock);
956 if (unlikely(inode->i_pipe)) {
957 inode->i_pipe->files++;
958 spin_unlock(&inode->i_lock);
959 free_pipe_info(pipe);
960 pipe = inode->i_pipe;
961 } else {
962 inode->i_pipe = pipe;
963 spin_unlock(&inode->i_lock);
966 filp->private_data = pipe;
967 /* OK, we have a pipe and it's pinned down */
969 __pipe_lock(pipe);
971 /* We can only do regular read/write on fifos */
972 stream_open(inode, filp);
974 switch (filp->f_mode & (FMODE_READ | FMODE_WRITE)) {
975 case FMODE_READ:
977 * O_RDONLY
978 * POSIX.1 says that O_NONBLOCK means return with the FIFO
979 * opened, even when there is no process writing the FIFO.
981 pipe->r_counter++;
982 if (pipe->readers++ == 0)
983 wake_up_partner(pipe);
985 if (!is_pipe && !pipe->writers) {
986 if ((filp->f_flags & O_NONBLOCK)) {
987 /* suppress EPOLLHUP until we have
988 * seen a writer */
989 filp->f_version = pipe->w_counter;
990 } else {
991 if (wait_for_partner(pipe, &pipe->w_counter))
992 goto err_rd;
995 break;
997 case FMODE_WRITE:
999 * O_WRONLY
1000 * POSIX.1 says that O_NONBLOCK means return -1 with
1001 * errno=ENXIO when there is no process reading the FIFO.
1003 ret = -ENXIO;
1004 if (!is_pipe && (filp->f_flags & O_NONBLOCK) && !pipe->readers)
1005 goto err;
1007 pipe->w_counter++;
1008 if (!pipe->writers++)
1009 wake_up_partner(pipe);
1011 if (!is_pipe && !pipe->readers) {
1012 if (wait_for_partner(pipe, &pipe->r_counter))
1013 goto err_wr;
1015 break;
1017 case FMODE_READ | FMODE_WRITE:
1019 * O_RDWR
1020 * POSIX.1 leaves this case "undefined" when O_NONBLOCK is set.
1021 * This implementation will NEVER block on a O_RDWR open, since
1022 * the process can at least talk to itself.
1025 pipe->readers++;
1026 pipe->writers++;
1027 pipe->r_counter++;
1028 pipe->w_counter++;
1029 if (pipe->readers == 1 || pipe->writers == 1)
1030 wake_up_partner(pipe);
1031 break;
1033 default:
1034 ret = -EINVAL;
1035 goto err;
1038 /* Ok! */
1039 __pipe_unlock(pipe);
1040 return 0;
1042 err_rd:
1043 if (!--pipe->readers)
1044 wake_up_interruptible(&pipe->wait);
1045 ret = -ERESTARTSYS;
1046 goto err;
1048 err_wr:
1049 if (!--pipe->writers)
1050 wake_up_interruptible(&pipe->wait);
1051 ret = -ERESTARTSYS;
1052 goto err;
1054 err:
1055 __pipe_unlock(pipe);
1057 put_pipe_info(inode, pipe);
1058 return ret;
1061 const struct file_operations pipefifo_fops = {
1062 .open = fifo_open,
1063 .llseek = no_llseek,
1064 .read_iter = pipe_read,
1065 .write_iter = pipe_write,
1066 .poll = pipe_poll,
1067 .unlocked_ioctl = pipe_ioctl,
1068 .release = pipe_release,
1069 .fasync = pipe_fasync,
1073 * Currently we rely on the pipe array holding a power-of-2 number
1074 * of pages. Returns 0 on error.
1076 unsigned int round_pipe_size(unsigned long size)
1078 if (size > (1U << 31))
1079 return 0;
1081 /* Minimum pipe size, as required by POSIX */
1082 if (size < PAGE_SIZE)
1083 return PAGE_SIZE;
1085 return roundup_pow_of_two(size);
1089 * Allocate a new array of pipe buffers and copy the info over. Returns the
1090 * pipe size if successful, or return -ERROR on error.
1092 static long pipe_set_size(struct pipe_inode_info *pipe, unsigned long arg)
1094 struct pipe_buffer *bufs;
1095 unsigned int size, nr_slots, head, tail, mask, n;
1096 unsigned long user_bufs;
1097 long ret = 0;
1099 size = round_pipe_size(arg);
1100 nr_slots = size >> PAGE_SHIFT;
1102 if (!nr_slots)
1103 return -EINVAL;
1106 * If trying to increase the pipe capacity, check that an
1107 * unprivileged user is not trying to exceed various limits
1108 * (soft limit check here, hard limit check just below).
1109 * Decreasing the pipe capacity is always permitted, even
1110 * if the user is currently over a limit.
1112 if (nr_slots > pipe->ring_size &&
1113 size > pipe_max_size && !capable(CAP_SYS_RESOURCE))
1114 return -EPERM;
1116 user_bufs = account_pipe_buffers(pipe->user, pipe->ring_size, nr_slots);
1118 if (nr_slots > pipe->ring_size &&
1119 (too_many_pipe_buffers_hard(user_bufs) ||
1120 too_many_pipe_buffers_soft(user_bufs)) &&
1121 is_unprivileged_user()) {
1122 ret = -EPERM;
1123 goto out_revert_acct;
1127 * We can shrink the pipe, if arg is greater than the ring occupancy.
1128 * Since we don't expect a lot of shrink+grow operations, just free and
1129 * allocate again like we would do for growing. If the pipe currently
1130 * contains more buffers than arg, then return busy.
1132 mask = pipe->ring_size - 1;
1133 head = pipe->head;
1134 tail = pipe->tail;
1135 n = pipe_occupancy(pipe->head, pipe->tail);
1136 if (nr_slots < n) {
1137 ret = -EBUSY;
1138 goto out_revert_acct;
1141 bufs = kcalloc(nr_slots, sizeof(*bufs),
1142 GFP_KERNEL_ACCOUNT | __GFP_NOWARN);
1143 if (unlikely(!bufs)) {
1144 ret = -ENOMEM;
1145 goto out_revert_acct;
1149 * The pipe array wraps around, so just start the new one at zero
1150 * and adjust the indices.
1152 if (n > 0) {
1153 unsigned int h = head & mask;
1154 unsigned int t = tail & mask;
1155 if (h > t) {
1156 memcpy(bufs, pipe->bufs + t,
1157 n * sizeof(struct pipe_buffer));
1158 } else {
1159 unsigned int tsize = pipe->ring_size - t;
1160 if (h > 0)
1161 memcpy(bufs + tsize, pipe->bufs,
1162 h * sizeof(struct pipe_buffer));
1163 memcpy(bufs, pipe->bufs + t,
1164 tsize * sizeof(struct pipe_buffer));
1168 head = n;
1169 tail = 0;
1171 kfree(pipe->bufs);
1172 pipe->bufs = bufs;
1173 pipe->ring_size = nr_slots;
1174 pipe->max_usage = nr_slots;
1175 pipe->tail = tail;
1176 pipe->head = head;
1177 wake_up_interruptible_all(&pipe->wait);
1178 return pipe->max_usage * PAGE_SIZE;
1180 out_revert_acct:
1181 (void) account_pipe_buffers(pipe->user, nr_slots, pipe->ring_size);
1182 return ret;
1186 * After the inode slimming patch, i_pipe/i_bdev/i_cdev share the same
1187 * location, so checking ->i_pipe is not enough to verify that this is a
1188 * pipe.
1190 struct pipe_inode_info *get_pipe_info(struct file *file)
1192 return file->f_op == &pipefifo_fops ? file->private_data : NULL;
1195 long pipe_fcntl(struct file *file, unsigned int cmd, unsigned long arg)
1197 struct pipe_inode_info *pipe;
1198 long ret;
1200 pipe = get_pipe_info(file);
1201 if (!pipe)
1202 return -EBADF;
1204 __pipe_lock(pipe);
1206 switch (cmd) {
1207 case F_SETPIPE_SZ:
1208 ret = pipe_set_size(pipe, arg);
1209 break;
1210 case F_GETPIPE_SZ:
1211 ret = pipe->max_usage * PAGE_SIZE;
1212 break;
1213 default:
1214 ret = -EINVAL;
1215 break;
1218 __pipe_unlock(pipe);
1219 return ret;
1222 static const struct super_operations pipefs_ops = {
1223 .destroy_inode = free_inode_nonrcu,
1224 .statfs = simple_statfs,
1228 * pipefs should _never_ be mounted by userland - too much of security hassle,
1229 * no real gain from having the whole whorehouse mounted. So we don't need
1230 * any operations on the root directory. However, we need a non-trivial
1231 * d_name - pipe: will go nicely and kill the special-casing in procfs.
1234 static int pipefs_init_fs_context(struct fs_context *fc)
1236 struct pseudo_fs_context *ctx = init_pseudo(fc, PIPEFS_MAGIC);
1237 if (!ctx)
1238 return -ENOMEM;
1239 ctx->ops = &pipefs_ops;
1240 ctx->dops = &pipefs_dentry_operations;
1241 return 0;
1244 static struct file_system_type pipe_fs_type = {
1245 .name = "pipefs",
1246 .init_fs_context = pipefs_init_fs_context,
1247 .kill_sb = kill_anon_super,
1250 static int __init init_pipe_fs(void)
1252 int err = register_filesystem(&pipe_fs_type);
1254 if (!err) {
1255 pipe_mnt = kern_mount(&pipe_fs_type);
1256 if (IS_ERR(pipe_mnt)) {
1257 err = PTR_ERR(pipe_mnt);
1258 unregister_filesystem(&pipe_fs_type);
1261 return err;
1264 fs_initcall(init_pipe_fs);