2 * Copyright (c) 1996 John S. Dyson
3 * Copyright (c) 2012 Giovanni Trematerra
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice immediately at the beginning of the file, without modification,
11 * this list of conditions, and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Absolutely no warranty of function or purpose is made by the author
17 * 4. Modifications may be freely made to this file if the above conditions
22 * This file contains a high-performance replacement for the socket-based
23 * pipes scheme originally used in FreeBSD/4.4Lite. It does not support
24 * all features of sockets, but does do everything that pipes normally
29 * This code has two modes of operation, a small write mode and a large
30 * write mode. The small write mode acts like conventional pipes with
31 * a kernel buffer. If the buffer is less than PIPE_MINDIRECT, then the
32 * "normal" pipe buffering is done. If the buffer is between PIPE_MINDIRECT
33 * and PIPE_SIZE in size, the sending process pins the underlying pages in
34 * memory, and the receiving process copies directly from these pinned pages
35 * in the sending process.
37 * If the sending process receives a signal, it is possible that it will
38 * go away, and certainly its address space can change, because control
39 * is returned back to the user-mode side. In that case, the pipe code
40 * arranges to copy the buffer supplied by the user process, to a pageable
41 * kernel buffer, and the receiving process will grab the data from the
42 * pageable kernel buffer. Since signals don't happen all that often,
43 * the copy operation is normally eliminated.
45 * The constant PIPE_MINDIRECT is chosen to make sure that buffering will
46 * happen for small transfers so that the system will not spend all of
47 * its time context switching.
49 * In order to limit the resource use of pipes, two sysctls exist:
51 * kern.ipc.maxpipekva - This is a hard limit on the amount of pageable
52 * address space available to us in pipe_map. This value is normally
53 * autotuned, but may also be loader tuned.
55 * kern.ipc.pipekva - This read-only sysctl tracks the current amount of
56 * memory in use by pipes.
58 * Based on how large pipekva is relative to maxpipekva, the following
62 * New pipes are given 16K of memory backing, pipes may dynamically
63 * grow to as large as 64K where needed.
65 * New pipes are given 4K (or PAGE_SIZE) of memory backing,
66 * existing pipes may NOT grow.
68 * New pipes are given 4K (or PAGE_SIZE) of memory backing,
69 * existing pipes will be shrunk down to 4K whenever possible.
71 * Resizing may be disabled by setting kern.ipc.piperesizeallowed=0. If
72 * that is set, the only resize that will occur is the 0 -> SMALL_PIPE_SIZE
73 * resize which MUST occur for reverse-direction pipes when they are
76 * Additional information about the current state of pipes may be obtained
77 * from kern.ipc.pipes, kern.ipc.pipefragretry, kern.ipc.pipeallocfail,
78 * and kern.ipc.piperesizefail.
80 * Locking rules: There are two locks present here: A mutex, used via
81 * PIPE_LOCK, and a flag, used via pipelock(). All locking is done via
82 * the flag, as mutexes can not persist over uiomove. The mutex
83 * exists only to guard access to the flag, and is not in itself a
84 * locking mechanism. Also note that there is only a single mutex for
85 * both directions of a pipe.
87 * As pipelock() may have to sleep before it can acquire the flag, it
88 * is important to reread all data after a call to pipelock(); everything
89 * in the structure may have changed.
92 #include <sys/cdefs.h>
93 __FBSDID("$FreeBSD$");
95 #include <sys/param.h>
96 #include <sys/systm.h>
98 #include <sys/fcntl.h>
100 #include <sys/filedesc.h>
101 #include <sys/filio.h>
102 #include <sys/kernel.h>
103 #include <sys/lock.h>
104 #include <sys/mutex.h>
105 #include <sys/ttycom.h>
106 #include <sys/stat.h>
107 #include <sys/malloc.h>
108 #include <sys/poll.h>
109 #include <sys/selinfo.h>
110 #include <sys/signalvar.h>
111 #include <sys/syscallsubr.h>
112 #include <sys/sysctl.h>
113 #include <sys/sysproto.h>
114 #include <sys/pipe.h>
115 #include <sys/proc.h>
116 #include <sys/vnode.h>
118 #include <sys/event.h>
120 #include <security/mac/mac_framework.h>
123 #include <vm/vm_param.h>
124 #include <vm/vm_object.h>
125 #include <vm/vm_kern.h>
126 #include <vm/vm_extern.h>
128 #include <vm/vm_map.h>
129 #include <vm/vm_page.h>
133 * Use this define if you want to disable *fancy* VM things. Expect an
134 * approx 30% decrease in transfer rate. This could be useful for
137 /* #define PIPE_NODIRECT */
139 #define PIPE_PEER(pipe) \
140 (((pipe)->pipe_state & PIPE_NAMED) ? (pipe) : ((pipe)->pipe_peer))
143 * interfaces to the outside world
145 static fo_rdwr_t pipe_read;
146 static fo_rdwr_t pipe_write;
147 static fo_truncate_t pipe_truncate;
148 static fo_ioctl_t pipe_ioctl;
149 static fo_poll_t pipe_poll;
150 static fo_kqfilter_t pipe_kqfilter;
151 static fo_stat_t pipe_stat;
152 static fo_close_t pipe_close;
153 static fo_chmod_t pipe_chmod;
154 static fo_chown_t pipe_chown;
156 struct fileops pipeops = {
157 .fo_read = pipe_read,
158 .fo_write = pipe_write,
159 .fo_truncate = pipe_truncate,
160 .fo_ioctl = pipe_ioctl,
161 .fo_poll = pipe_poll,
162 .fo_kqfilter = pipe_kqfilter,
163 .fo_stat = pipe_stat,
164 .fo_close = pipe_close,
165 .fo_chmod = pipe_chmod,
166 .fo_chown = pipe_chown,
167 .fo_sendfile = invfo_sendfile,
168 .fo_flags = DFLAG_PASSABLE
171 static void filt_pipedetach(struct knote *kn);
172 static void filt_pipedetach_notsup(struct knote *kn);
173 static int filt_pipenotsup(struct knote *kn, long hint);
174 static int filt_piperead(struct knote *kn, long hint);
175 static int filt_pipewrite(struct knote *kn, long hint);
177 static struct filterops pipe_nfiltops = {
179 .f_detach = filt_pipedetach_notsup,
180 .f_event = filt_pipenotsup
182 static struct filterops pipe_rfiltops = {
184 .f_detach = filt_pipedetach,
185 .f_event = filt_piperead
187 static struct filterops pipe_wfiltops = {
189 .f_detach = filt_pipedetach,
190 .f_event = filt_pipewrite
194 * Default pipe buffer size(s), this can be kind-of large now because pipe
195 * space is pageable. The pipe code will try to maintain locality of
196 * reference for performance reasons, so small amounts of outstanding I/O
197 * will not wipe the cache.
199 #define MINPIPESIZE (PIPE_SIZE/3)
200 #define MAXPIPESIZE (2*PIPE_SIZE/3)
202 static long amountpipekva;
203 static int pipefragretry;
204 static int pipeallocfail;
205 static int piperesizefail;
206 static int piperesizeallowed = 1;
208 SYSCTL_LONG(_kern_ipc, OID_AUTO, maxpipekva, CTLFLAG_RDTUN,
209 &maxpipekva, 0, "Pipe KVA limit");
210 SYSCTL_LONG(_kern_ipc, OID_AUTO, pipekva, CTLFLAG_RD,
211 &amountpipekva, 0, "Pipe KVA usage");
212 SYSCTL_INT(_kern_ipc, OID_AUTO, pipefragretry, CTLFLAG_RD,
213 &pipefragretry, 0, "Pipe allocation retries due to fragmentation");
214 SYSCTL_INT(_kern_ipc, OID_AUTO, pipeallocfail, CTLFLAG_RD,
215 &pipeallocfail, 0, "Pipe allocation failures");
216 SYSCTL_INT(_kern_ipc, OID_AUTO, piperesizefail, CTLFLAG_RD,
217 &piperesizefail, 0, "Pipe resize failures");
218 SYSCTL_INT(_kern_ipc, OID_AUTO, piperesizeallowed, CTLFLAG_RW,
219 &piperesizeallowed, 0, "Pipe resizing allowed");
221 static void pipeinit(void *dummy __unused);
222 static void pipeclose(struct pipe *cpipe);
223 static void pipe_free_kmem(struct pipe *cpipe);
224 static void pipe_create(struct pipe *pipe, int backing);
225 static void pipe_paircreate(struct thread *td, struct pipepair **p_pp);
226 static __inline int pipelock(struct pipe *cpipe, int catch);
227 static __inline void pipeunlock(struct pipe *cpipe);
228 #ifndef PIPE_NODIRECT
229 static int pipe_build_write_buffer(struct pipe *wpipe, struct uio *uio);
230 static void pipe_destroy_write_buffer(struct pipe *wpipe);
231 static int pipe_direct_write(struct pipe *wpipe, struct uio *uio);
232 static void pipe_clone_write_buffer(struct pipe *wpipe);
234 static int pipespace(struct pipe *cpipe, int size);
235 static int pipespace_new(struct pipe *cpipe, int size);
237 static int pipe_zone_ctor(void *mem, int size, void *arg, int flags);
238 static int pipe_zone_init(void *mem, int size, int flags);
239 static void pipe_zone_fini(void *mem, int size);
241 static uma_zone_t pipe_zone;
242 static struct unrhdr *pipeino_unr;
243 static dev_t pipedev_ino;
245 SYSINIT(vfs, SI_SUB_VFS, SI_ORDER_ANY, pipeinit, NULL);
248 pipeinit(void *dummy __unused)
251 pipe_zone = uma_zcreate("pipe", sizeof(struct pipepair),
252 pipe_zone_ctor, NULL, pipe_zone_init, pipe_zone_fini,
254 KASSERT(pipe_zone != NULL, ("pipe_zone not initialized"));
255 pipeino_unr = new_unrhdr(1, INT32_MAX, NULL);
256 KASSERT(pipeino_unr != NULL, ("pipe fake inodes not initialized"));
257 pipedev_ino = devfs_alloc_cdp_inode();
258 KASSERT(pipedev_ino > 0, ("pipe dev inode not initialized"));
262 pipe_zone_ctor(void *mem, int size, void *arg, int flags)
265 struct pipe *rpipe, *wpipe;
267 KASSERT(size == sizeof(*pp), ("pipe_zone_ctor: wrong size"));
269 pp = (struct pipepair *)mem;
272 * We zero both pipe endpoints to make sure all the kmem pointers
273 * are NULL, flag fields are zero'd, etc. We timestamp both
274 * endpoints with the same time.
276 rpipe = &pp->pp_rpipe;
277 bzero(rpipe, sizeof(*rpipe));
278 vfs_timestamp(&rpipe->pipe_ctime);
279 rpipe->pipe_atime = rpipe->pipe_mtime = rpipe->pipe_ctime;
281 wpipe = &pp->pp_wpipe;
282 bzero(wpipe, sizeof(*wpipe));
283 wpipe->pipe_ctime = rpipe->pipe_ctime;
284 wpipe->pipe_atime = wpipe->pipe_mtime = rpipe->pipe_ctime;
286 rpipe->pipe_peer = wpipe;
287 rpipe->pipe_pair = pp;
288 wpipe->pipe_peer = rpipe;
289 wpipe->pipe_pair = pp;
292 * Mark both endpoints as present; they will later get free'd
293 * one at a time. When both are free'd, then the whole pair
296 rpipe->pipe_present = PIPE_ACTIVE;
297 wpipe->pipe_present = PIPE_ACTIVE;
300 * Eventually, the MAC Framework may initialize the label
301 * in ctor or init, but for now we do it elswhere to avoid
302 * blocking in ctor or init.
310 pipe_zone_init(void *mem, int size, int flags)
314 KASSERT(size == sizeof(*pp), ("pipe_zone_init: wrong size"));
316 pp = (struct pipepair *)mem;
318 mtx_init(&pp->pp_mtx, "pipe mutex", NULL, MTX_DEF | MTX_RECURSE);
323 pipe_zone_fini(void *mem, int size)
327 KASSERT(size == sizeof(*pp), ("pipe_zone_fini: wrong size"));
329 pp = (struct pipepair *)mem;
331 mtx_destroy(&pp->pp_mtx);
335 pipe_paircreate(struct thread *td, struct pipepair **p_pp)
338 struct pipe *rpipe, *wpipe;
340 *p_pp = pp = uma_zalloc(pipe_zone, M_WAITOK);
343 * The MAC label is shared between the connected endpoints. As a
344 * result mac_pipe_init() and mac_pipe_create() are called once
345 * for the pair, and not on the endpoints.
348 mac_pipe_create(td->td_ucred, pp);
350 rpipe = &pp->pp_rpipe;
351 wpipe = &pp->pp_wpipe;
353 knlist_init_mtx(&rpipe->pipe_sel.si_note, PIPE_MTX(rpipe));
354 knlist_init_mtx(&wpipe->pipe_sel.si_note, PIPE_MTX(wpipe));
356 /* Only the forward direction pipe is backed by default */
357 pipe_create(rpipe, 1);
358 pipe_create(wpipe, 0);
360 rpipe->pipe_state |= PIPE_DIRECTOK;
361 wpipe->pipe_state |= PIPE_DIRECTOK;
365 pipe_named_ctor(struct pipe **ppipe, struct thread *td)
369 pipe_paircreate(td, &pp);
370 pp->pp_rpipe.pipe_state |= PIPE_NAMED;
371 *ppipe = &pp->pp_rpipe;
375 pipe_dtor(struct pipe *dpipe)
379 ino = dpipe->pipe_ino;
380 funsetown(&dpipe->pipe_sigio);
382 if (dpipe->pipe_state & PIPE_NAMED) {
383 dpipe = dpipe->pipe_peer;
384 funsetown(&dpipe->pipe_sigio);
387 if (ino != 0 && ino != (ino_t)-1)
388 free_unr(pipeino_unr, ino);
392 * The pipe system call for the DTYPE_PIPE type of pipes. If we fail, let
393 * the zone pick up the pieces via pipeclose().
396 kern_pipe(struct thread *td, int fildes[2])
399 return (kern_pipe2(td, fildes, 0));
403 kern_pipe2(struct thread *td, int fildes[2], int flags)
405 struct filedesc *fdp;
406 struct file *rf, *wf;
407 struct pipe *rpipe, *wpipe;
409 int fd, fflags, error;
411 fdp = td->td_proc->p_fd;
412 pipe_paircreate(td, &pp);
413 rpipe = &pp->pp_rpipe;
414 wpipe = &pp->pp_wpipe;
415 error = falloc(td, &rf, &fd, flags);
421 /* An extra reference on `rf' has been held for us by falloc(). */
424 fflags = FREAD | FWRITE;
425 if ((flags & O_NONBLOCK) != 0)
429 * Warning: once we've gotten past allocation of the fd for the
430 * read-side, we can only drop the read side via fdrop() in order
431 * to avoid races against processes which manage to dup() the read
432 * side while we are blocked trying to allocate the write side.
434 finit(rf, fflags, DTYPE_PIPE, rpipe, &pipeops);
435 error = falloc(td, &wf, &fd, flags);
437 fdclose(fdp, rf, fildes[0], td);
439 /* rpipe has been closed by fdrop(). */
443 /* An extra reference on `wf' has been held for us by falloc(). */
444 finit(wf, fflags, DTYPE_PIPE, wpipe, &pipeops);
454 sys_pipe(struct thread *td, struct pipe_args *uap)
459 error = kern_pipe(td, fildes);
463 td->td_retval[0] = fildes[0];
464 td->td_retval[1] = fildes[1];
470 sys_pipe2(struct thread *td, struct pipe2_args *uap)
472 int error, fildes[2];
474 if (uap->flags & ~(O_CLOEXEC | O_NONBLOCK))
476 error = kern_pipe2(td, fildes, uap->flags);
479 error = copyout(fildes, uap->fildes, 2 * sizeof(int));
481 (void)kern_close(td, fildes[0]);
482 (void)kern_close(td, fildes[1]);
488 * Allocate kva for pipe circular buffer, the space is pageable
489 * This routine will 'realloc' the size of a pipe safely, if it fails
490 * it will retain the old buffer.
491 * If it fails it will return ENOMEM.
494 pipespace_new(cpipe, size)
499 int error, cnt, firstseg;
500 static int curfail = 0;
501 static struct timeval lastfail;
503 KASSERT(!mtx_owned(PIPE_MTX(cpipe)), ("pipespace: pipe mutex locked"));
504 KASSERT(!(cpipe->pipe_state & PIPE_DIRECTW),
505 ("pipespace: resize of direct writes not allowed"));
507 cnt = cpipe->pipe_buffer.cnt;
511 size = round_page(size);
512 buffer = (caddr_t) vm_map_min(pipe_map);
514 error = vm_map_find(pipe_map, NULL, 0,
515 (vm_offset_t *) &buffer, size, 0, VMFS_ANY_SPACE,
516 VM_PROT_ALL, VM_PROT_ALL, 0);
517 if (error != KERN_SUCCESS) {
518 if ((cpipe->pipe_buffer.buffer == NULL) &&
519 (size > SMALL_PIPE_SIZE)) {
520 size = SMALL_PIPE_SIZE;
524 if (cpipe->pipe_buffer.buffer == NULL) {
526 if (ppsratecheck(&lastfail, &curfail, 1))
527 printf("kern.ipc.maxpipekva exceeded; see tuning(7)\n");
534 /* copy data, then free old resources if we're resizing */
536 if (cpipe->pipe_buffer.in <= cpipe->pipe_buffer.out) {
537 firstseg = cpipe->pipe_buffer.size - cpipe->pipe_buffer.out;
538 bcopy(&cpipe->pipe_buffer.buffer[cpipe->pipe_buffer.out],
540 if ((cnt - firstseg) > 0)
541 bcopy(cpipe->pipe_buffer.buffer, &buffer[firstseg],
542 cpipe->pipe_buffer.in);
544 bcopy(&cpipe->pipe_buffer.buffer[cpipe->pipe_buffer.out],
548 pipe_free_kmem(cpipe);
549 cpipe->pipe_buffer.buffer = buffer;
550 cpipe->pipe_buffer.size = size;
551 cpipe->pipe_buffer.in = cnt;
552 cpipe->pipe_buffer.out = 0;
553 cpipe->pipe_buffer.cnt = cnt;
554 atomic_add_long(&amountpipekva, cpipe->pipe_buffer.size);
559 * Wrapper for pipespace_new() that performs locking assertions.
562 pipespace(cpipe, size)
567 KASSERT(cpipe->pipe_state & PIPE_LOCKFL,
568 ("Unlocked pipe passed to pipespace"));
569 return (pipespace_new(cpipe, size));
573 * lock a pipe for I/O, blocking other access
576 pipelock(cpipe, catch)
582 PIPE_LOCK_ASSERT(cpipe, MA_OWNED);
583 while (cpipe->pipe_state & PIPE_LOCKFL) {
584 cpipe->pipe_state |= PIPE_LWANT;
585 error = msleep(cpipe, PIPE_MTX(cpipe),
586 catch ? (PRIBIO | PCATCH) : PRIBIO,
591 cpipe->pipe_state |= PIPE_LOCKFL;
596 * unlock a pipe I/O lock
603 PIPE_LOCK_ASSERT(cpipe, MA_OWNED);
604 KASSERT(cpipe->pipe_state & PIPE_LOCKFL,
605 ("Unlocked pipe passed to pipeunlock"));
606 cpipe->pipe_state &= ~PIPE_LOCKFL;
607 if (cpipe->pipe_state & PIPE_LWANT) {
608 cpipe->pipe_state &= ~PIPE_LWANT;
618 PIPE_LOCK_ASSERT(cpipe, MA_OWNED);
619 if (cpipe->pipe_state & PIPE_SEL) {
620 selwakeuppri(&cpipe->pipe_sel, PSOCK);
621 if (!SEL_WAITING(&cpipe->pipe_sel))
622 cpipe->pipe_state &= ~PIPE_SEL;
624 if ((cpipe->pipe_state & PIPE_ASYNC) && cpipe->pipe_sigio)
625 pgsigio(&cpipe->pipe_sigio, SIGIO, 0);
626 KNOTE_LOCKED(&cpipe->pipe_sel.si_note, 0);
630 * Initialize and allocate VM and memory for pipe. The structure
631 * will start out zero'd from the ctor, so we just manage the kmem.
634 pipe_create(pipe, backing)
641 * Note that these functions can fail if pipe map is exhausted
642 * (as a result of too many pipes created), but we ignore the
643 * error as it is not fatal and could be provoked by
644 * unprivileged users. The only consequence is worse performance
647 if (amountpipekva > maxpipekva / 2)
648 (void)pipespace_new(pipe, SMALL_PIPE_SIZE);
650 (void)pipespace_new(pipe, PIPE_SIZE);
658 pipe_read(fp, uio, active_cred, flags, td)
661 struct ucred *active_cred;
673 error = pipelock(rpipe, 1);
678 error = mac_pipe_check_read(active_cred, rpipe->pipe_pair);
682 if (amountpipekva > (3 * maxpipekva) / 4) {
683 if (!(rpipe->pipe_state & PIPE_DIRECTW) &&
684 (rpipe->pipe_buffer.size > SMALL_PIPE_SIZE) &&
685 (rpipe->pipe_buffer.cnt <= SMALL_PIPE_SIZE) &&
686 (piperesizeallowed == 1)) {
688 pipespace(rpipe, SMALL_PIPE_SIZE);
693 while (uio->uio_resid) {
695 * normal pipe buffer receive
697 if (rpipe->pipe_buffer.cnt > 0) {
698 size = rpipe->pipe_buffer.size - rpipe->pipe_buffer.out;
699 if (size > rpipe->pipe_buffer.cnt)
700 size = rpipe->pipe_buffer.cnt;
701 if (size > uio->uio_resid)
702 size = uio->uio_resid;
706 &rpipe->pipe_buffer.buffer[rpipe->pipe_buffer.out],
712 rpipe->pipe_buffer.out += size;
713 if (rpipe->pipe_buffer.out >= rpipe->pipe_buffer.size)
714 rpipe->pipe_buffer.out = 0;
716 rpipe->pipe_buffer.cnt -= size;
719 * If there is no more to read in the pipe, reset
720 * its pointers to the beginning. This improves
723 if (rpipe->pipe_buffer.cnt == 0) {
724 rpipe->pipe_buffer.in = 0;
725 rpipe->pipe_buffer.out = 0;
728 #ifndef PIPE_NODIRECT
730 * Direct copy, bypassing a kernel buffer.
732 } else if ((size = rpipe->pipe_map.cnt) &&
733 (rpipe->pipe_state & PIPE_DIRECTW)) {
734 if (size > uio->uio_resid)
735 size = (u_int) uio->uio_resid;
738 error = uiomove_fromphys(rpipe->pipe_map.ms,
739 rpipe->pipe_map.pos, size, uio);
744 rpipe->pipe_map.pos += size;
745 rpipe->pipe_map.cnt -= size;
746 if (rpipe->pipe_map.cnt == 0) {
747 rpipe->pipe_state &= ~(PIPE_DIRECTW|PIPE_WANTW);
753 * detect EOF condition
754 * read returns 0 on EOF, no need to set error
756 if (rpipe->pipe_state & PIPE_EOF)
760 * If the "write-side" has been blocked, wake it up now.
762 if (rpipe->pipe_state & PIPE_WANTW) {
763 rpipe->pipe_state &= ~PIPE_WANTW;
768 * Break if some data was read.
774 * Unlock the pipe buffer for our remaining processing.
775 * We will either break out with an error or we will
776 * sleep and relock to loop.
781 * Handle non-blocking mode operation or
782 * wait for more data.
784 if (fp->f_flag & FNONBLOCK) {
787 rpipe->pipe_state |= PIPE_WANTR;
788 if ((error = msleep(rpipe, PIPE_MTX(rpipe),
791 error = pipelock(rpipe, 1);
802 /* XXX: should probably do this before getting any locks. */
804 vfs_timestamp(&rpipe->pipe_atime);
809 * PIPE_WANT processing only makes sense if pipe_busy is 0.
811 if ((rpipe->pipe_busy == 0) && (rpipe->pipe_state & PIPE_WANT)) {
812 rpipe->pipe_state &= ~(PIPE_WANT|PIPE_WANTW);
814 } else if (rpipe->pipe_buffer.cnt < MINPIPESIZE) {
816 * Handle write blocking hysteresis.
818 if (rpipe->pipe_state & PIPE_WANTW) {
819 rpipe->pipe_state &= ~PIPE_WANTW;
824 if ((rpipe->pipe_buffer.size - rpipe->pipe_buffer.cnt) >= PIPE_BUF)
825 pipeselwakeup(rpipe);
831 #ifndef PIPE_NODIRECT
833 * Map the sending processes' buffer into kernel space and wire it.
834 * This is similar to a physical write operation.
837 pipe_build_write_buffer(wpipe, uio)
844 PIPE_LOCK_ASSERT(wpipe, MA_NOTOWNED);
845 KASSERT(wpipe->pipe_state & PIPE_DIRECTW,
846 ("Clone attempt on non-direct write pipe!"));
848 if (uio->uio_iov->iov_len > wpipe->pipe_buffer.size)
849 size = wpipe->pipe_buffer.size;
851 size = uio->uio_iov->iov_len;
853 if ((i = vm_fault_quick_hold_pages(&curproc->p_vmspace->vm_map,
854 (vm_offset_t)uio->uio_iov->iov_base, size, VM_PROT_READ,
855 wpipe->pipe_map.ms, PIPENPAGES)) < 0)
859 * set up the control block
861 wpipe->pipe_map.npages = i;
862 wpipe->pipe_map.pos =
863 ((vm_offset_t) uio->uio_iov->iov_base) & PAGE_MASK;
864 wpipe->pipe_map.cnt = size;
867 * and update the uio data
870 uio->uio_iov->iov_len -= size;
871 uio->uio_iov->iov_base = (char *)uio->uio_iov->iov_base + size;
872 if (uio->uio_iov->iov_len == 0)
874 uio->uio_resid -= size;
875 uio->uio_offset += size;
880 * unmap and unwire the process buffer
883 pipe_destroy_write_buffer(wpipe)
887 PIPE_LOCK_ASSERT(wpipe, MA_OWNED);
888 vm_page_unhold_pages(wpipe->pipe_map.ms, wpipe->pipe_map.npages);
889 wpipe->pipe_map.npages = 0;
893 * In the case of a signal, the writing process might go away. This
894 * code copies the data into the circular buffer so that the source
895 * pages can be freed without loss of data.
898 pipe_clone_write_buffer(wpipe)
906 PIPE_LOCK_ASSERT(wpipe, MA_OWNED);
907 size = wpipe->pipe_map.cnt;
908 pos = wpipe->pipe_map.pos;
910 wpipe->pipe_buffer.in = size;
911 wpipe->pipe_buffer.out = 0;
912 wpipe->pipe_buffer.cnt = size;
913 wpipe->pipe_state &= ~PIPE_DIRECTW;
916 iov.iov_base = wpipe->pipe_buffer.buffer;
921 uio.uio_resid = size;
922 uio.uio_segflg = UIO_SYSSPACE;
923 uio.uio_rw = UIO_READ;
924 uio.uio_td = curthread;
925 uiomove_fromphys(wpipe->pipe_map.ms, pos, size, &uio);
927 pipe_destroy_write_buffer(wpipe);
931 * This implements the pipe buffer write mechanism. Note that only
932 * a direct write OR a normal pipe write can be pending at any given time.
933 * If there are any characters in the pipe buffer, the direct write will
934 * be deferred until the receiving process grabs all of the bytes from
935 * the pipe buffer. Then the direct mapping write is set-up.
938 pipe_direct_write(wpipe, uio)
945 PIPE_LOCK_ASSERT(wpipe, MA_OWNED);
946 error = pipelock(wpipe, 1);
947 if (wpipe->pipe_state & PIPE_EOF)
953 while (wpipe->pipe_state & PIPE_DIRECTW) {
954 if (wpipe->pipe_state & PIPE_WANTR) {
955 wpipe->pipe_state &= ~PIPE_WANTR;
958 pipeselwakeup(wpipe);
959 wpipe->pipe_state |= PIPE_WANTW;
961 error = msleep(wpipe, PIPE_MTX(wpipe),
962 PRIBIO | PCATCH, "pipdww", 0);
968 wpipe->pipe_map.cnt = 0; /* transfer not ready yet */
969 if (wpipe->pipe_buffer.cnt > 0) {
970 if (wpipe->pipe_state & PIPE_WANTR) {
971 wpipe->pipe_state &= ~PIPE_WANTR;
974 pipeselwakeup(wpipe);
975 wpipe->pipe_state |= PIPE_WANTW;
977 error = msleep(wpipe, PIPE_MTX(wpipe),
978 PRIBIO | PCATCH, "pipdwc", 0);
985 wpipe->pipe_state |= PIPE_DIRECTW;
988 error = pipe_build_write_buffer(wpipe, uio);
991 wpipe->pipe_state &= ~PIPE_DIRECTW;
997 while (!error && (wpipe->pipe_state & PIPE_DIRECTW)) {
998 if (wpipe->pipe_state & PIPE_EOF) {
999 pipe_destroy_write_buffer(wpipe);
1000 pipeselwakeup(wpipe);
1005 if (wpipe->pipe_state & PIPE_WANTR) {
1006 wpipe->pipe_state &= ~PIPE_WANTR;
1009 pipeselwakeup(wpipe);
1010 wpipe->pipe_state |= PIPE_WANTW;
1012 error = msleep(wpipe, PIPE_MTX(wpipe), PRIBIO | PCATCH,
1017 if (wpipe->pipe_state & PIPE_EOF)
1019 if (wpipe->pipe_state & PIPE_DIRECTW) {
1021 * this bit of trickery substitutes a kernel buffer for
1022 * the process that might be going away.
1024 pipe_clone_write_buffer(wpipe);
1026 pipe_destroy_write_buffer(wpipe);
1038 pipe_write(fp, uio, active_cred, flags, td)
1041 struct ucred *active_cred;
1048 struct pipe *wpipe, *rpipe;
1051 wpipe = PIPE_PEER(rpipe);
1053 error = pipelock(wpipe, 1);
1059 * detect loss of pipe read side, issue SIGPIPE if lost.
1061 if (wpipe->pipe_present != PIPE_ACTIVE ||
1062 (wpipe->pipe_state & PIPE_EOF)) {
1068 error = mac_pipe_check_write(active_cred, wpipe->pipe_pair);
1077 /* Choose a larger size if it's advantageous */
1078 desiredsize = max(SMALL_PIPE_SIZE, wpipe->pipe_buffer.size);
1079 while (desiredsize < wpipe->pipe_buffer.cnt + uio->uio_resid) {
1080 if (piperesizeallowed != 1)
1082 if (amountpipekva > maxpipekva / 2)
1084 if (desiredsize == BIG_PIPE_SIZE)
1086 desiredsize = desiredsize * 2;
1089 /* Choose a smaller size if we're in a OOM situation */
1090 if ((amountpipekva > (3 * maxpipekva) / 4) &&
1091 (wpipe->pipe_buffer.size > SMALL_PIPE_SIZE) &&
1092 (wpipe->pipe_buffer.cnt <= SMALL_PIPE_SIZE) &&
1093 (piperesizeallowed == 1))
1094 desiredsize = SMALL_PIPE_SIZE;
1096 /* Resize if the above determined that a new size was necessary */
1097 if ((desiredsize != wpipe->pipe_buffer.size) &&
1098 ((wpipe->pipe_state & PIPE_DIRECTW) == 0)) {
1100 pipespace(wpipe, desiredsize);
1103 if (wpipe->pipe_buffer.size == 0) {
1105 * This can only happen for reverse direction use of pipes
1106 * in a complete OOM situation.
1117 orig_resid = uio->uio_resid;
1119 while (uio->uio_resid) {
1123 if (wpipe->pipe_state & PIPE_EOF) {
1128 #ifndef PIPE_NODIRECT
1130 * If the transfer is large, we can gain performance if
1131 * we do process-to-process copies directly.
1132 * If the write is non-blocking, we don't use the
1133 * direct write mechanism.
1135 * The direct write mechanism will detect the reader going
1138 if (uio->uio_segflg == UIO_USERSPACE &&
1139 uio->uio_iov->iov_len >= PIPE_MINDIRECT &&
1140 wpipe->pipe_buffer.size >= PIPE_MINDIRECT &&
1141 (fp->f_flag & FNONBLOCK) == 0) {
1143 error = pipe_direct_write(wpipe, uio);
1151 * Pipe buffered writes cannot be coincidental with
1152 * direct writes. We wait until the currently executing
1153 * direct write is completed before we start filling the
1154 * pipe buffer. We break out if a signal occurs or the
1157 if (wpipe->pipe_state & PIPE_DIRECTW) {
1158 if (wpipe->pipe_state & PIPE_WANTR) {
1159 wpipe->pipe_state &= ~PIPE_WANTR;
1162 pipeselwakeup(wpipe);
1163 wpipe->pipe_state |= PIPE_WANTW;
1165 error = msleep(wpipe, PIPE_MTX(rpipe), PRIBIO | PCATCH,
1173 space = wpipe->pipe_buffer.size - wpipe->pipe_buffer.cnt;
1175 /* Writes of size <= PIPE_BUF must be atomic. */
1176 if ((space < uio->uio_resid) && (orig_resid <= PIPE_BUF))
1180 int size; /* Transfer size */
1181 int segsize; /* first segment to transfer */
1184 * Transfer size is minimum of uio transfer
1185 * and free space in pipe buffer.
1187 if (space > uio->uio_resid)
1188 size = uio->uio_resid;
1192 * First segment to transfer is minimum of
1193 * transfer size and contiguous space in
1194 * pipe buffer. If first segment to transfer
1195 * is less than the transfer size, we've got
1196 * a wraparound in the buffer.
1198 segsize = wpipe->pipe_buffer.size -
1199 wpipe->pipe_buffer.in;
1203 /* Transfer first segment */
1206 error = uiomove(&wpipe->pipe_buffer.buffer[wpipe->pipe_buffer.in],
1210 if (error == 0 && segsize < size) {
1211 KASSERT(wpipe->pipe_buffer.in + segsize ==
1212 wpipe->pipe_buffer.size,
1213 ("Pipe buffer wraparound disappeared"));
1215 * Transfer remaining part now, to
1216 * support atomic writes. Wraparound
1222 &wpipe->pipe_buffer.buffer[0],
1223 size - segsize, uio);
1227 wpipe->pipe_buffer.in += size;
1228 if (wpipe->pipe_buffer.in >=
1229 wpipe->pipe_buffer.size) {
1230 KASSERT(wpipe->pipe_buffer.in ==
1232 wpipe->pipe_buffer.size,
1233 ("Expected wraparound bad"));
1234 wpipe->pipe_buffer.in = size - segsize;
1237 wpipe->pipe_buffer.cnt += size;
1238 KASSERT(wpipe->pipe_buffer.cnt <=
1239 wpipe->pipe_buffer.size,
1240 ("Pipe buffer overflow"));
1247 * If the "read-side" has been blocked, wake it up now.
1249 if (wpipe->pipe_state & PIPE_WANTR) {
1250 wpipe->pipe_state &= ~PIPE_WANTR;
1255 * don't block on non-blocking I/O
1257 if (fp->f_flag & FNONBLOCK) {
1264 * We have no more space and have something to offer,
1265 * wake up select/poll.
1267 pipeselwakeup(wpipe);
1269 wpipe->pipe_state |= PIPE_WANTW;
1271 error = msleep(wpipe, PIPE_MTX(rpipe),
1272 PRIBIO | PCATCH, "pipewr", 0);
1281 if ((wpipe->pipe_busy == 0) && (wpipe->pipe_state & PIPE_WANT)) {
1282 wpipe->pipe_state &= ~(PIPE_WANT | PIPE_WANTR);
1284 } else if (wpipe->pipe_buffer.cnt > 0) {
1286 * If we have put any characters in the buffer, we wake up
1289 if (wpipe->pipe_state & PIPE_WANTR) {
1290 wpipe->pipe_state &= ~PIPE_WANTR;
1296 * Don't return EPIPE if I/O was successful
1298 if ((wpipe->pipe_buffer.cnt == 0) &&
1299 (uio->uio_resid == 0) &&
1305 vfs_timestamp(&wpipe->pipe_mtime);
1308 * We have something to offer,
1309 * wake up select/poll.
1311 if (wpipe->pipe_buffer.cnt)
1312 pipeselwakeup(wpipe);
1321 pipe_truncate(fp, length, active_cred, td)
1324 struct ucred *active_cred;
1328 /* For named pipes call the vnode operation. */
1329 if (fp->f_vnode != NULL)
1330 return (vnops.fo_truncate(fp, length, active_cred, td));
1335 * we implement a very minimal set of ioctls for compatibility with sockets.
1338 pipe_ioctl(fp, cmd, data, active_cred, td)
1342 struct ucred *active_cred;
1345 struct pipe *mpipe = fp->f_data;
1351 error = mac_pipe_check_ioctl(active_cred, mpipe->pipe_pair, cmd, data);
1366 mpipe->pipe_state |= PIPE_ASYNC;
1368 mpipe->pipe_state &= ~PIPE_ASYNC;
1373 if (!(fp->f_flag & FREAD)) {
1378 if (mpipe->pipe_state & PIPE_DIRECTW)
1379 *(int *)data = mpipe->pipe_map.cnt;
1381 *(int *)data = mpipe->pipe_buffer.cnt;
1386 error = fsetown(*(int *)data, &mpipe->pipe_sigio);
1390 *(int *)data = fgetown(&mpipe->pipe_sigio);
1393 /* This is deprecated, FIOSETOWN should be used instead. */
1396 error = fsetown(-(*(int *)data), &mpipe->pipe_sigio);
1399 /* This is deprecated, FIOGETOWN should be used instead. */
1401 *(int *)data = -fgetown(&mpipe->pipe_sigio);
1414 pipe_poll(fp, events, active_cred, td)
1417 struct ucred *active_cred;
1422 int levents, revents;
1429 wpipe = PIPE_PEER(rpipe);
1432 error = mac_pipe_check_poll(active_cred, rpipe->pipe_pair);
1436 if (fp->f_flag & FREAD && events & (POLLIN | POLLRDNORM))
1437 if ((rpipe->pipe_state & PIPE_DIRECTW) ||
1438 (rpipe->pipe_buffer.cnt > 0))
1439 revents |= events & (POLLIN | POLLRDNORM);
1441 if (fp->f_flag & FWRITE && events & (POLLOUT | POLLWRNORM))
1442 if (wpipe->pipe_present != PIPE_ACTIVE ||
1443 (wpipe->pipe_state & PIPE_EOF) ||
1444 (((wpipe->pipe_state & PIPE_DIRECTW) == 0) &&
1445 ((wpipe->pipe_buffer.size - wpipe->pipe_buffer.cnt) >= PIPE_BUF ||
1446 wpipe->pipe_buffer.size == 0)))
1447 revents |= events & (POLLOUT | POLLWRNORM);
1450 (POLLIN | POLLINIGNEOF | POLLPRI | POLLRDNORM | POLLRDBAND);
1451 if (rpipe->pipe_state & PIPE_NAMED && fp->f_flag & FREAD && levents &&
1452 fp->f_seqcount == rpipe->pipe_wgen)
1453 events |= POLLINIGNEOF;
1455 if ((events & POLLINIGNEOF) == 0) {
1456 if (rpipe->pipe_state & PIPE_EOF) {
1457 revents |= (events & (POLLIN | POLLRDNORM));
1458 if (wpipe->pipe_present != PIPE_ACTIVE ||
1459 (wpipe->pipe_state & PIPE_EOF))
1465 if (fp->f_flag & FREAD && events & (POLLIN | POLLRDNORM)) {
1466 selrecord(td, &rpipe->pipe_sel);
1467 if (SEL_WAITING(&rpipe->pipe_sel))
1468 rpipe->pipe_state |= PIPE_SEL;
1471 if (fp->f_flag & FWRITE && events & (POLLOUT | POLLWRNORM)) {
1472 selrecord(td, &wpipe->pipe_sel);
1473 if (SEL_WAITING(&wpipe->pipe_sel))
1474 wpipe->pipe_state |= PIPE_SEL;
1486 * We shouldn't need locks here as we're doing a read and this should
1487 * be a natural race.
1490 pipe_stat(fp, ub, active_cred, td)
1493 struct ucred *active_cred;
1505 error = mac_pipe_check_stat(active_cred, pipe->pipe_pair);
1512 /* For named pipes ask the underlying filesystem. */
1513 if (pipe->pipe_state & PIPE_NAMED) {
1515 return (vnops.fo_stat(fp, ub, active_cred, td));
1519 * Lazily allocate an inode number for the pipe. Most pipe
1520 * users do not call fstat(2) on the pipe, which means that
1521 * postponing the inode allocation until it is must be
1522 * returned to userland is useful. If alloc_unr failed,
1523 * assign st_ino zero instead of returning an error.
1524 * Special pipe_ino values:
1525 * -1 - not yet initialized;
1526 * 0 - alloc_unr failed, return 0 as st_ino forever.
1528 if (pipe->pipe_ino == (ino_t)-1) {
1529 new_unr = alloc_unr(pipeino_unr);
1531 pipe->pipe_ino = new_unr;
1537 bzero(ub, sizeof(*ub));
1538 ub->st_mode = S_IFIFO;
1539 ub->st_blksize = PAGE_SIZE;
1540 if (pipe->pipe_state & PIPE_DIRECTW)
1541 ub->st_size = pipe->pipe_map.cnt;
1543 ub->st_size = pipe->pipe_buffer.cnt;
1544 ub->st_blocks = (ub->st_size + ub->st_blksize - 1) / ub->st_blksize;
1545 ub->st_atim = pipe->pipe_atime;
1546 ub->st_mtim = pipe->pipe_mtime;
1547 ub->st_ctim = pipe->pipe_ctime;
1548 ub->st_uid = fp->f_cred->cr_uid;
1549 ub->st_gid = fp->f_cred->cr_gid;
1550 ub->st_dev = pipedev_ino;
1551 ub->st_ino = pipe->pipe_ino;
1553 * Left as 0: st_nlink, st_rdev, st_flags, st_gen.
1565 if (fp->f_vnode != NULL)
1566 return vnops.fo_close(fp, td);
1567 fp->f_ops = &badfileops;
1568 pipe_dtor(fp->f_data);
1574 pipe_chmod(struct file *fp, mode_t mode, struct ucred *active_cred, struct thread *td)
1580 if (cpipe->pipe_state & PIPE_NAMED)
1581 error = vn_chmod(fp, mode, active_cred, td);
1583 error = invfo_chmod(fp, mode, active_cred, td);
1588 pipe_chown(fp, uid, gid, active_cred, td)
1592 struct ucred *active_cred;
1599 if (cpipe->pipe_state & PIPE_NAMED)
1600 error = vn_chown(fp, uid, gid, active_cred, td);
1602 error = invfo_chown(fp, uid, gid, active_cred, td);
1607 pipe_free_kmem(cpipe)
1611 KASSERT(!mtx_owned(PIPE_MTX(cpipe)),
1612 ("pipe_free_kmem: pipe mutex locked"));
1614 if (cpipe->pipe_buffer.buffer != NULL) {
1615 atomic_subtract_long(&amountpipekva, cpipe->pipe_buffer.size);
1616 vm_map_remove(pipe_map,
1617 (vm_offset_t)cpipe->pipe_buffer.buffer,
1618 (vm_offset_t)cpipe->pipe_buffer.buffer + cpipe->pipe_buffer.size);
1619 cpipe->pipe_buffer.buffer = NULL;
1621 #ifndef PIPE_NODIRECT
1623 cpipe->pipe_map.cnt = 0;
1624 cpipe->pipe_map.pos = 0;
1625 cpipe->pipe_map.npages = 0;
1637 struct pipepair *pp;
1640 KASSERT(cpipe != NULL, ("pipeclose: cpipe == NULL"));
1644 pp = cpipe->pipe_pair;
1646 pipeselwakeup(cpipe);
1649 * If the other side is blocked, wake it up saying that
1650 * we want to close it down.
1652 cpipe->pipe_state |= PIPE_EOF;
1653 while (cpipe->pipe_busy) {
1655 cpipe->pipe_state |= PIPE_WANT;
1657 msleep(cpipe, PIPE_MTX(cpipe), PRIBIO, "pipecl", 0);
1663 * Disconnect from peer, if any.
1665 ppipe = cpipe->pipe_peer;
1666 if (ppipe->pipe_present == PIPE_ACTIVE) {
1667 pipeselwakeup(ppipe);
1669 ppipe->pipe_state |= PIPE_EOF;
1671 KNOTE_LOCKED(&ppipe->pipe_sel.si_note, 0);
1675 * Mark this endpoint as free. Release kmem resources. We
1676 * don't mark this endpoint as unused until we've finished
1677 * doing that, or the pipe might disappear out from under
1681 pipe_free_kmem(cpipe);
1683 cpipe->pipe_present = PIPE_CLOSING;
1687 * knlist_clear() may sleep dropping the PIPE_MTX. Set the
1688 * PIPE_FINALIZED, that allows other end to free the
1689 * pipe_pair, only after the knotes are completely dismantled.
1691 knlist_clear(&cpipe->pipe_sel.si_note, 1);
1692 cpipe->pipe_present = PIPE_FINALIZED;
1693 seldrain(&cpipe->pipe_sel);
1694 knlist_destroy(&cpipe->pipe_sel.si_note);
1697 * If both endpoints are now closed, release the memory for the
1698 * pipe pair. If not, unlock.
1700 if (ppipe->pipe_present == PIPE_FINALIZED) {
1703 mac_pipe_destroy(pp);
1705 uma_zfree(pipe_zone, cpipe->pipe_pair);
1712 pipe_kqfilter(struct file *fp, struct knote *kn)
1717 * If a filter is requested that is not supported by this file
1718 * descriptor, don't return an error, but also don't ever generate an
1721 if ((kn->kn_filter == EVFILT_READ) && !(fp->f_flag & FREAD)) {
1722 kn->kn_fop = &pipe_nfiltops;
1725 if ((kn->kn_filter == EVFILT_WRITE) && !(fp->f_flag & FWRITE)) {
1726 kn->kn_fop = &pipe_nfiltops;
1731 switch (kn->kn_filter) {
1733 kn->kn_fop = &pipe_rfiltops;
1736 kn->kn_fop = &pipe_wfiltops;
1737 if (cpipe->pipe_peer->pipe_present != PIPE_ACTIVE) {
1738 /* other end of pipe has been closed */
1742 cpipe = PIPE_PEER(cpipe);
1749 kn->kn_hook = cpipe;
1750 knlist_add(&cpipe->pipe_sel.si_note, kn, 1);
1756 filt_pipedetach(struct knote *kn)
1758 struct pipe *cpipe = kn->kn_hook;
1761 knlist_remove(&cpipe->pipe_sel.si_note, kn, 1);
1767 filt_piperead(struct knote *kn, long hint)
1769 struct pipe *rpipe = kn->kn_hook;
1770 struct pipe *wpipe = rpipe->pipe_peer;
1774 kn->kn_data = rpipe->pipe_buffer.cnt;
1775 if ((kn->kn_data == 0) && (rpipe->pipe_state & PIPE_DIRECTW))
1776 kn->kn_data = rpipe->pipe_map.cnt;
1778 if ((rpipe->pipe_state & PIPE_EOF) ||
1779 wpipe->pipe_present != PIPE_ACTIVE ||
1780 (wpipe->pipe_state & PIPE_EOF)) {
1781 kn->kn_flags |= EV_EOF;
1785 ret = kn->kn_data > 0;
1792 filt_pipewrite(struct knote *kn, long hint)
1796 wpipe = kn->kn_hook;
1798 if (wpipe->pipe_present != PIPE_ACTIVE ||
1799 (wpipe->pipe_state & PIPE_EOF)) {
1801 kn->kn_flags |= EV_EOF;
1805 kn->kn_data = (wpipe->pipe_buffer.size > 0) ?
1806 (wpipe->pipe_buffer.size - wpipe->pipe_buffer.cnt) : PIPE_BUF;
1807 if (wpipe->pipe_state & PIPE_DIRECTW)
1811 return (kn->kn_data >= PIPE_BUF);
1815 filt_pipedetach_notsup(struct knote *kn)
1821 filt_pipenotsup(struct knote *kn, long hint)