xref: /freebsd-12.1/sys/kern/sys_pipe.c (revision dcebc28d)
1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (c) 1996 John S. Dyson
5  * Copyright (c) 2012 Giovanni Trematerra
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice immediately at the beginning of the file, without modification,
13  *    this list of conditions, and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Absolutely no warranty of function or purpose is made by the author
18  *    John S. Dyson.
19  * 4. Modifications may be freely made to this file if the above conditions
20  *    are met.
21  */
22 
23 /*
24  * This file contains a high-performance replacement for the socket-based
25  * pipes scheme originally used in FreeBSD/4.4Lite.  It does not support
26  * all features of sockets, but does do everything that pipes normally
27  * do.
28  */
29 
30 /*
31  * This code has two modes of operation, a small write mode and a large
32  * write mode.  The small write mode acts like conventional pipes with
33  * a kernel buffer.  If the buffer is less than PIPE_MINDIRECT, then the
34  * "normal" pipe buffering is done.  If the buffer is between PIPE_MINDIRECT
35  * and PIPE_SIZE in size, the sending process pins the underlying pages in
36  * memory, and the receiving process copies directly from these pinned pages
37  * in the sending process.
38  *
39  * If the sending process receives a signal, it is possible that it will
40  * go away, and certainly its address space can change, because control
41  * is returned back to the user-mode side.  In that case, the pipe code
42  * arranges to copy the buffer supplied by the user process, to a pageable
43  * kernel buffer, and the receiving process will grab the data from the
44  * pageable kernel buffer.  Since signals don't happen all that often,
45  * the copy operation is normally eliminated.
46  *
47  * The constant PIPE_MINDIRECT is chosen to make sure that buffering will
48  * happen for small transfers so that the system will not spend all of
49  * its time context switching.
50  *
51  * In order to limit the resource use of pipes, two sysctls exist:
52  *
53  * kern.ipc.maxpipekva - This is a hard limit on the amount of pageable
54  * address space available to us in pipe_map. This value is normally
55  * autotuned, but may also be loader tuned.
56  *
57  * kern.ipc.pipekva - This read-only sysctl tracks the current amount of
58  * memory in use by pipes.
59  *
60  * Based on how large pipekva is relative to maxpipekva, the following
61  * will happen:
62  *
63  * 0% - 50%:
64  *     New pipes are given 16K of memory backing, pipes may dynamically
65  *     grow to as large as 64K where needed.
66  * 50% - 75%:
67  *     New pipes are given 4K (or PAGE_SIZE) of memory backing,
68  *     existing pipes may NOT grow.
69  * 75% - 100%:
70  *     New pipes are given 4K (or PAGE_SIZE) of memory backing,
71  *     existing pipes will be shrunk down to 4K whenever possible.
72  *
73  * Resizing may be disabled by setting kern.ipc.piperesizeallowed=0.  If
74  * that is set,  the only resize that will occur is the 0 -> SMALL_PIPE_SIZE
75  * resize which MUST occur for reverse-direction pipes when they are
76  * first used.
77  *
78  * Additional information about the current state of pipes may be obtained
79  * from kern.ipc.pipes, kern.ipc.pipefragretry, kern.ipc.pipeallocfail,
80  * and kern.ipc.piperesizefail.
81  *
82  * Locking rules:  There are two locks present here:  A mutex, used via
83  * PIPE_LOCK, and a flag, used via pipelock().  All locking is done via
84  * the flag, as mutexes can not persist over uiomove.  The mutex
85  * exists only to guard access to the flag, and is not in itself a
86  * locking mechanism.  Also note that there is only a single mutex for
87  * both directions of a pipe.
88  *
89  * As pipelock() may have to sleep before it can acquire the flag, it
90  * is important to reread all data after a call to pipelock(); everything
91  * in the structure may have changed.
92  */
93 
94 #include <sys/cdefs.h>
95 __FBSDID("$FreeBSD$");
96 
97 #include <sys/param.h>
98 #include <sys/systm.h>
99 #include <sys/conf.h>
100 #include <sys/fcntl.h>
101 #include <sys/file.h>
102 #include <sys/filedesc.h>
103 #include <sys/filio.h>
104 #include <sys/kernel.h>
105 #include <sys/lock.h>
106 #include <sys/mutex.h>
107 #include <sys/ttycom.h>
108 #include <sys/stat.h>
109 #include <sys/malloc.h>
110 #include <sys/poll.h>
111 #include <sys/selinfo.h>
112 #include <sys/signalvar.h>
113 #include <sys/syscallsubr.h>
114 #include <sys/sysctl.h>
115 #include <sys/sysproto.h>
116 #include <sys/pipe.h>
117 #include <sys/proc.h>
118 #include <sys/vnode.h>
119 #include <sys/uio.h>
120 #include <sys/user.h>
121 #include <sys/event.h>
122 
123 #include <security/mac/mac_framework.h>
124 
125 #include <vm/vm.h>
126 #include <vm/vm_param.h>
127 #include <vm/vm_object.h>
128 #include <vm/vm_kern.h>
129 #include <vm/vm_extern.h>
130 #include <vm/pmap.h>
131 #include <vm/vm_map.h>
132 #include <vm/vm_page.h>
133 #include <vm/uma.h>
134 
135 /*
136  * Use this define if you want to disable *fancy* VM things.  Expect an
137  * approx 30% decrease in transfer rate.  This could be useful for
138  * NetBSD or OpenBSD.
139  */
140 /* #define PIPE_NODIRECT */
141 
142 #define PIPE_PEER(pipe)	\
143 	(((pipe)->pipe_state & PIPE_NAMED) ? (pipe) : ((pipe)->pipe_peer))
144 
145 /*
146  * interfaces to the outside world
147  */
148 static fo_rdwr_t	pipe_read;
149 static fo_rdwr_t	pipe_write;
150 static fo_truncate_t	pipe_truncate;
151 static fo_ioctl_t	pipe_ioctl;
152 static fo_poll_t	pipe_poll;
153 static fo_kqfilter_t	pipe_kqfilter;
154 static fo_stat_t	pipe_stat;
155 static fo_close_t	pipe_close;
156 static fo_chmod_t	pipe_chmod;
157 static fo_chown_t	pipe_chown;
158 static fo_fill_kinfo_t	pipe_fill_kinfo;
159 
160 struct fileops pipeops = {
161 	.fo_read = pipe_read,
162 	.fo_write = pipe_write,
163 	.fo_truncate = pipe_truncate,
164 	.fo_ioctl = pipe_ioctl,
165 	.fo_poll = pipe_poll,
166 	.fo_kqfilter = pipe_kqfilter,
167 	.fo_stat = pipe_stat,
168 	.fo_close = pipe_close,
169 	.fo_chmod = pipe_chmod,
170 	.fo_chown = pipe_chown,
171 	.fo_sendfile = invfo_sendfile,
172 	.fo_fill_kinfo = pipe_fill_kinfo,
173 	.fo_flags = DFLAG_PASSABLE
174 };
175 
176 static void	filt_pipedetach(struct knote *kn);
177 static void	filt_pipedetach_notsup(struct knote *kn);
178 static int	filt_pipenotsup(struct knote *kn, long hint);
179 static int	filt_piperead(struct knote *kn, long hint);
180 static int	filt_pipewrite(struct knote *kn, long hint);
181 
182 static struct filterops pipe_nfiltops = {
183 	.f_isfd = 1,
184 	.f_detach = filt_pipedetach_notsup,
185 	.f_event = filt_pipenotsup
186 };
187 static struct filterops pipe_rfiltops = {
188 	.f_isfd = 1,
189 	.f_detach = filt_pipedetach,
190 	.f_event = filt_piperead
191 };
192 static struct filterops pipe_wfiltops = {
193 	.f_isfd = 1,
194 	.f_detach = filt_pipedetach,
195 	.f_event = filt_pipewrite
196 };
197 
198 /*
199  * Default pipe buffer size(s), this can be kind-of large now because pipe
200  * space is pageable.  The pipe code will try to maintain locality of
201  * reference for performance reasons, so small amounts of outstanding I/O
202  * will not wipe the cache.
203  */
204 #define MINPIPESIZE (PIPE_SIZE/3)
205 #define MAXPIPESIZE (2*PIPE_SIZE/3)
206 
207 static long amountpipekva;
208 static int pipefragretry;
209 static int pipeallocfail;
210 static int piperesizefail;
211 static int piperesizeallowed = 1;
212 
213 SYSCTL_LONG(_kern_ipc, OID_AUTO, maxpipekva, CTLFLAG_RDTUN | CTLFLAG_NOFETCH,
214 	   &maxpipekva, 0, "Pipe KVA limit");
215 SYSCTL_LONG(_kern_ipc, OID_AUTO, pipekva, CTLFLAG_RD,
216 	   &amountpipekva, 0, "Pipe KVA usage");
217 SYSCTL_INT(_kern_ipc, OID_AUTO, pipefragretry, CTLFLAG_RD,
218 	  &pipefragretry, 0, "Pipe allocation retries due to fragmentation");
219 SYSCTL_INT(_kern_ipc, OID_AUTO, pipeallocfail, CTLFLAG_RD,
220 	  &pipeallocfail, 0, "Pipe allocation failures");
221 SYSCTL_INT(_kern_ipc, OID_AUTO, piperesizefail, CTLFLAG_RD,
222 	  &piperesizefail, 0, "Pipe resize failures");
223 SYSCTL_INT(_kern_ipc, OID_AUTO, piperesizeallowed, CTLFLAG_RW,
224 	  &piperesizeallowed, 0, "Pipe resizing allowed");
225 
226 static void pipeinit(void *dummy __unused);
227 static void pipeclose(struct pipe *cpipe);
228 static void pipe_free_kmem(struct pipe *cpipe);
229 static void pipe_create(struct pipe *pipe, int backing);
230 static void pipe_paircreate(struct thread *td, struct pipepair **p_pp);
231 static __inline int pipelock(struct pipe *cpipe, int catch);
232 static __inline void pipeunlock(struct pipe *cpipe);
233 #ifndef PIPE_NODIRECT
234 static int pipe_build_write_buffer(struct pipe *wpipe, struct uio *uio);
235 static void pipe_destroy_write_buffer(struct pipe *wpipe);
236 static int pipe_direct_write(struct pipe *wpipe, struct uio *uio);
237 static void pipe_clone_write_buffer(struct pipe *wpipe);
238 #endif
239 static int pipespace(struct pipe *cpipe, int size);
240 static int pipespace_new(struct pipe *cpipe, int size);
241 
242 static int	pipe_zone_ctor(void *mem, int size, void *arg, int flags);
243 static int	pipe_zone_init(void *mem, int size, int flags);
244 static void	pipe_zone_fini(void *mem, int size);
245 
246 static uma_zone_t pipe_zone;
247 static struct unrhdr64 pipeino_unr;
248 static dev_t pipedev_ino;
249 
250 SYSINIT(vfs, SI_SUB_VFS, SI_ORDER_ANY, pipeinit, NULL);
251 
252 static void
253 pipeinit(void *dummy __unused)
254 {
255 
256 	pipe_zone = uma_zcreate("pipe", sizeof(struct pipepair),
257 	    pipe_zone_ctor, NULL, pipe_zone_init, pipe_zone_fini,
258 	    UMA_ALIGN_PTR, 0);
259 	KASSERT(pipe_zone != NULL, ("pipe_zone not initialized"));
260 	new_unrhdr64(&pipeino_unr, 1);
261 	pipedev_ino = devfs_alloc_cdp_inode();
262 	KASSERT(pipedev_ino > 0, ("pipe dev inode not initialized"));
263 }
264 
265 static int
266 pipe_zone_ctor(void *mem, int size, void *arg, int flags)
267 {
268 	struct pipepair *pp;
269 	struct pipe *rpipe, *wpipe;
270 
271 	KASSERT(size == sizeof(*pp), ("pipe_zone_ctor: wrong size"));
272 
273 	pp = (struct pipepair *)mem;
274 
275 	/*
276 	 * We zero both pipe endpoints to make sure all the kmem pointers
277 	 * are NULL, flag fields are zero'd, etc.  We timestamp both
278 	 * endpoints with the same time.
279 	 */
280 	rpipe = &pp->pp_rpipe;
281 	bzero(rpipe, sizeof(*rpipe));
282 	vfs_timestamp(&rpipe->pipe_ctime);
283 	rpipe->pipe_atime = rpipe->pipe_mtime = rpipe->pipe_ctime;
284 
285 	wpipe = &pp->pp_wpipe;
286 	bzero(wpipe, sizeof(*wpipe));
287 	wpipe->pipe_ctime = rpipe->pipe_ctime;
288 	wpipe->pipe_atime = wpipe->pipe_mtime = rpipe->pipe_ctime;
289 
290 	rpipe->pipe_peer = wpipe;
291 	rpipe->pipe_pair = pp;
292 	wpipe->pipe_peer = rpipe;
293 	wpipe->pipe_pair = pp;
294 
295 	/*
296 	 * Mark both endpoints as present; they will later get free'd
297 	 * one at a time.  When both are free'd, then the whole pair
298 	 * is released.
299 	 */
300 	rpipe->pipe_present = PIPE_ACTIVE;
301 	wpipe->pipe_present = PIPE_ACTIVE;
302 
303 	/*
304 	 * Eventually, the MAC Framework may initialize the label
305 	 * in ctor or init, but for now we do it elswhere to avoid
306 	 * blocking in ctor or init.
307 	 */
308 	pp->pp_label = NULL;
309 
310 	return (0);
311 }
312 
313 static int
314 pipe_zone_init(void *mem, int size, int flags)
315 {
316 	struct pipepair *pp;
317 
318 	KASSERT(size == sizeof(*pp), ("pipe_zone_init: wrong size"));
319 
320 	pp = (struct pipepair *)mem;
321 
322 	mtx_init(&pp->pp_mtx, "pipe mutex", NULL, MTX_DEF | MTX_NEW);
323 	return (0);
324 }
325 
326 static void
327 pipe_zone_fini(void *mem, int size)
328 {
329 	struct pipepair *pp;
330 
331 	KASSERT(size == sizeof(*pp), ("pipe_zone_fini: wrong size"));
332 
333 	pp = (struct pipepair *)mem;
334 
335 	mtx_destroy(&pp->pp_mtx);
336 }
337 
338 static void
339 pipe_paircreate(struct thread *td, struct pipepair **p_pp)
340 {
341 	struct pipepair *pp;
342 	struct pipe *rpipe, *wpipe;
343 
344 	*p_pp = pp = uma_zalloc(pipe_zone, M_WAITOK);
345 #ifdef MAC
346 	/*
347 	 * The MAC label is shared between the connected endpoints.  As a
348 	 * result mac_pipe_init() and mac_pipe_create() are called once
349 	 * for the pair, and not on the endpoints.
350 	 */
351 	mac_pipe_init(pp);
352 	mac_pipe_create(td->td_ucred, pp);
353 #endif
354 	rpipe = &pp->pp_rpipe;
355 	wpipe = &pp->pp_wpipe;
356 
357 	knlist_init_mtx(&rpipe->pipe_sel.si_note, PIPE_MTX(rpipe));
358 	knlist_init_mtx(&wpipe->pipe_sel.si_note, PIPE_MTX(wpipe));
359 
360 	/* Only the forward direction pipe is backed by default */
361 	pipe_create(rpipe, 1);
362 	pipe_create(wpipe, 0);
363 
364 	rpipe->pipe_state |= PIPE_DIRECTOK;
365 	wpipe->pipe_state |= PIPE_DIRECTOK;
366 }
367 
368 void
369 pipe_named_ctor(struct pipe **ppipe, struct thread *td)
370 {
371 	struct pipepair *pp;
372 
373 	pipe_paircreate(td, &pp);
374 	pp->pp_rpipe.pipe_state |= PIPE_NAMED;
375 	*ppipe = &pp->pp_rpipe;
376 }
377 
378 void
379 pipe_dtor(struct pipe *dpipe)
380 {
381 	struct pipe *peer;
382 	ino_t ino;
383 
384 	ino = dpipe->pipe_ino;
385 	peer = (dpipe->pipe_state & PIPE_NAMED) != 0 ? dpipe->pipe_peer : NULL;
386 	funsetown(&dpipe->pipe_sigio);
387 	pipeclose(dpipe);
388 	if (peer != NULL) {
389 		funsetown(&peer->pipe_sigio);
390 		pipeclose(peer);
391 	}
392 }
393 
394 /*
395  * The pipe system call for the DTYPE_PIPE type of pipes.  If we fail, let
396  * the zone pick up the pieces via pipeclose().
397  */
398 int
399 kern_pipe(struct thread *td, int fildes[2], int flags, struct filecaps *fcaps1,
400     struct filecaps *fcaps2)
401 {
402 	struct file *rf, *wf;
403 	struct pipe *rpipe, *wpipe;
404 	struct pipepair *pp;
405 	int fd, fflags, error;
406 
407 	pipe_paircreate(td, &pp);
408 	rpipe = &pp->pp_rpipe;
409 	wpipe = &pp->pp_wpipe;
410 	error = falloc_caps(td, &rf, &fd, flags, fcaps1);
411 	if (error) {
412 		pipeclose(rpipe);
413 		pipeclose(wpipe);
414 		return (error);
415 	}
416 	/* An extra reference on `rf' has been held for us by falloc_caps(). */
417 	fildes[0] = fd;
418 
419 	fflags = FREAD | FWRITE;
420 	if ((flags & O_NONBLOCK) != 0)
421 		fflags |= FNONBLOCK;
422 
423 	/*
424 	 * Warning: once we've gotten past allocation of the fd for the
425 	 * read-side, we can only drop the read side via fdrop() in order
426 	 * to avoid races against processes which manage to dup() the read
427 	 * side while we are blocked trying to allocate the write side.
428 	 */
429 	finit(rf, fflags, DTYPE_PIPE, rpipe, &pipeops);
430 	error = falloc_caps(td, &wf, &fd, flags, fcaps2);
431 	if (error) {
432 		fdclose(td, rf, fildes[0]);
433 		fdrop(rf, td);
434 		/* rpipe has been closed by fdrop(). */
435 		pipeclose(wpipe);
436 		return (error);
437 	}
438 	/* An extra reference on `wf' has been held for us by falloc_caps(). */
439 	finit(wf, fflags, DTYPE_PIPE, wpipe, &pipeops);
440 	fdrop(wf, td);
441 	fildes[1] = fd;
442 	fdrop(rf, td);
443 
444 	return (0);
445 }
446 
447 #ifdef COMPAT_FREEBSD10
448 /* ARGSUSED */
449 int
450 freebsd10_pipe(struct thread *td, struct freebsd10_pipe_args *uap __unused)
451 {
452 	int error;
453 	int fildes[2];
454 
455 	error = kern_pipe(td, fildes, 0, NULL, NULL);
456 	if (error)
457 		return (error);
458 
459 	td->td_retval[0] = fildes[0];
460 	td->td_retval[1] = fildes[1];
461 
462 	return (0);
463 }
464 #endif
465 
466 int
467 sys_pipe2(struct thread *td, struct pipe2_args *uap)
468 {
469 	int error, fildes[2];
470 
471 	if (uap->flags & ~(O_CLOEXEC | O_NONBLOCK))
472 		return (EINVAL);
473 	error = kern_pipe(td, fildes, uap->flags, NULL, NULL);
474 	if (error)
475 		return (error);
476 	error = copyout(fildes, uap->fildes, 2 * sizeof(int));
477 	if (error) {
478 		(void)kern_close(td, fildes[0]);
479 		(void)kern_close(td, fildes[1]);
480 	}
481 	return (error);
482 }
483 
484 /*
485  * Allocate kva for pipe circular buffer, the space is pageable
486  * This routine will 'realloc' the size of a pipe safely, if it fails
487  * it will retain the old buffer.
488  * If it fails it will return ENOMEM.
489  */
490 static int
491 pipespace_new(struct pipe *cpipe, int size)
492 {
493 	caddr_t buffer;
494 	int error, cnt, firstseg;
495 	static int curfail = 0;
496 	static struct timeval lastfail;
497 
498 	KASSERT(!mtx_owned(PIPE_MTX(cpipe)), ("pipespace: pipe mutex locked"));
499 	KASSERT(!(cpipe->pipe_state & PIPE_DIRECTW),
500 		("pipespace: resize of direct writes not allowed"));
501 retry:
502 	cnt = cpipe->pipe_buffer.cnt;
503 	if (cnt > size)
504 		size = cnt;
505 
506 	size = round_page(size);
507 	buffer = (caddr_t) vm_map_min(pipe_map);
508 
509 	error = vm_map_find(pipe_map, NULL, 0, (vm_offset_t *)&buffer, size, 0,
510 	    VMFS_ANY_SPACE, VM_PROT_RW, VM_PROT_RW, 0);
511 	if (error != KERN_SUCCESS) {
512 		if ((cpipe->pipe_buffer.buffer == NULL) &&
513 			(size > SMALL_PIPE_SIZE)) {
514 			size = SMALL_PIPE_SIZE;
515 			pipefragretry++;
516 			goto retry;
517 		}
518 		if (cpipe->pipe_buffer.buffer == NULL) {
519 			pipeallocfail++;
520 			if (ppsratecheck(&lastfail, &curfail, 1))
521 				printf("kern.ipc.maxpipekva exceeded; see tuning(7)\n");
522 		} else {
523 			piperesizefail++;
524 		}
525 		return (ENOMEM);
526 	}
527 
528 	/* copy data, then free old resources if we're resizing */
529 	if (cnt > 0) {
530 		if (cpipe->pipe_buffer.in <= cpipe->pipe_buffer.out) {
531 			firstseg = cpipe->pipe_buffer.size - cpipe->pipe_buffer.out;
532 			bcopy(&cpipe->pipe_buffer.buffer[cpipe->pipe_buffer.out],
533 				buffer, firstseg);
534 			if ((cnt - firstseg) > 0)
535 				bcopy(cpipe->pipe_buffer.buffer, &buffer[firstseg],
536 					cpipe->pipe_buffer.in);
537 		} else {
538 			bcopy(&cpipe->pipe_buffer.buffer[cpipe->pipe_buffer.out],
539 				buffer, cnt);
540 		}
541 	}
542 	pipe_free_kmem(cpipe);
543 	cpipe->pipe_buffer.buffer = buffer;
544 	cpipe->pipe_buffer.size = size;
545 	cpipe->pipe_buffer.in = cnt;
546 	cpipe->pipe_buffer.out = 0;
547 	cpipe->pipe_buffer.cnt = cnt;
548 	atomic_add_long(&amountpipekva, cpipe->pipe_buffer.size);
549 	return (0);
550 }
551 
552 /*
553  * Wrapper for pipespace_new() that performs locking assertions.
554  */
555 static int
556 pipespace(struct pipe *cpipe, int size)
557 {
558 
559 	KASSERT(cpipe->pipe_state & PIPE_LOCKFL,
560 		("Unlocked pipe passed to pipespace"));
561 	return (pipespace_new(cpipe, size));
562 }
563 
564 /*
565  * lock a pipe for I/O, blocking other access
566  */
567 static __inline int
568 pipelock(struct pipe *cpipe, int catch)
569 {
570 	int error;
571 
572 	PIPE_LOCK_ASSERT(cpipe, MA_OWNED);
573 	while (cpipe->pipe_state & PIPE_LOCKFL) {
574 		cpipe->pipe_state |= PIPE_LWANT;
575 		error = msleep(cpipe, PIPE_MTX(cpipe),
576 		    catch ? (PRIBIO | PCATCH) : PRIBIO,
577 		    "pipelk", 0);
578 		if (error != 0)
579 			return (error);
580 	}
581 	cpipe->pipe_state |= PIPE_LOCKFL;
582 	return (0);
583 }
584 
585 /*
586  * unlock a pipe I/O lock
587  */
588 static __inline void
589 pipeunlock(struct pipe *cpipe)
590 {
591 
592 	PIPE_LOCK_ASSERT(cpipe, MA_OWNED);
593 	KASSERT(cpipe->pipe_state & PIPE_LOCKFL,
594 		("Unlocked pipe passed to pipeunlock"));
595 	cpipe->pipe_state &= ~PIPE_LOCKFL;
596 	if (cpipe->pipe_state & PIPE_LWANT) {
597 		cpipe->pipe_state &= ~PIPE_LWANT;
598 		wakeup(cpipe);
599 	}
600 }
601 
602 void
603 pipeselwakeup(struct pipe *cpipe)
604 {
605 
606 	PIPE_LOCK_ASSERT(cpipe, MA_OWNED);
607 	if (cpipe->pipe_state & PIPE_SEL) {
608 		selwakeuppri(&cpipe->pipe_sel, PSOCK);
609 		if (!SEL_WAITING(&cpipe->pipe_sel))
610 			cpipe->pipe_state &= ~PIPE_SEL;
611 	}
612 	if ((cpipe->pipe_state & PIPE_ASYNC) && cpipe->pipe_sigio)
613 		pgsigio(&cpipe->pipe_sigio, SIGIO, 0);
614 	KNOTE_LOCKED(&cpipe->pipe_sel.si_note, 0);
615 }
616 
617 /*
618  * Initialize and allocate VM and memory for pipe.  The structure
619  * will start out zero'd from the ctor, so we just manage the kmem.
620  */
621 static void
622 pipe_create(struct pipe *pipe, int backing)
623 {
624 
625 	if (backing) {
626 		/*
627 		 * Note that these functions can fail if pipe map is exhausted
628 		 * (as a result of too many pipes created), but we ignore the
629 		 * error as it is not fatal and could be provoked by
630 		 * unprivileged users. The only consequence is worse performance
631 		 * with given pipe.
632 		 */
633 		if (amountpipekva > maxpipekva / 2)
634 			(void)pipespace_new(pipe, SMALL_PIPE_SIZE);
635 		else
636 			(void)pipespace_new(pipe, PIPE_SIZE);
637 	}
638 
639 	pipe->pipe_ino = alloc_unr64(&pipeino_unr);
640 }
641 
642 /* ARGSUSED */
643 static int
644 pipe_read(struct file *fp, struct uio *uio, struct ucred *active_cred,
645     int flags, struct thread *td)
646 {
647 	struct pipe *rpipe;
648 	int error;
649 	int nread = 0;
650 	int size;
651 
652 	rpipe = fp->f_data;
653 	PIPE_LOCK(rpipe);
654 	++rpipe->pipe_busy;
655 	error = pipelock(rpipe, 1);
656 	if (error)
657 		goto unlocked_error;
658 
659 #ifdef MAC
660 	error = mac_pipe_check_read(active_cred, rpipe->pipe_pair);
661 	if (error)
662 		goto locked_error;
663 #endif
664 	if (amountpipekva > (3 * maxpipekva) / 4) {
665 		if (!(rpipe->pipe_state & PIPE_DIRECTW) &&
666 			(rpipe->pipe_buffer.size > SMALL_PIPE_SIZE) &&
667 			(rpipe->pipe_buffer.cnt <= SMALL_PIPE_SIZE) &&
668 			(piperesizeallowed == 1)) {
669 			PIPE_UNLOCK(rpipe);
670 			pipespace(rpipe, SMALL_PIPE_SIZE);
671 			PIPE_LOCK(rpipe);
672 		}
673 	}
674 
675 	while (uio->uio_resid) {
676 		/*
677 		 * normal pipe buffer receive
678 		 */
679 		if (rpipe->pipe_buffer.cnt > 0) {
680 			size = rpipe->pipe_buffer.size - rpipe->pipe_buffer.out;
681 			if (size > rpipe->pipe_buffer.cnt)
682 				size = rpipe->pipe_buffer.cnt;
683 			if (size > uio->uio_resid)
684 				size = uio->uio_resid;
685 
686 			PIPE_UNLOCK(rpipe);
687 			error = uiomove(
688 			    &rpipe->pipe_buffer.buffer[rpipe->pipe_buffer.out],
689 			    size, uio);
690 			PIPE_LOCK(rpipe);
691 			if (error)
692 				break;
693 
694 			rpipe->pipe_buffer.out += size;
695 			if (rpipe->pipe_buffer.out >= rpipe->pipe_buffer.size)
696 				rpipe->pipe_buffer.out = 0;
697 
698 			rpipe->pipe_buffer.cnt -= size;
699 
700 			/*
701 			 * If there is no more to read in the pipe, reset
702 			 * its pointers to the beginning.  This improves
703 			 * cache hit stats.
704 			 */
705 			if (rpipe->pipe_buffer.cnt == 0) {
706 				rpipe->pipe_buffer.in = 0;
707 				rpipe->pipe_buffer.out = 0;
708 			}
709 			nread += size;
710 #ifndef PIPE_NODIRECT
711 		/*
712 		 * Direct copy, bypassing a kernel buffer.
713 		 */
714 		} else if ((size = rpipe->pipe_map.cnt) &&
715 			   (rpipe->pipe_state & PIPE_DIRECTW)) {
716 			if (size > uio->uio_resid)
717 				size = (u_int) uio->uio_resid;
718 
719 			PIPE_UNLOCK(rpipe);
720 			error = uiomove_fromphys(rpipe->pipe_map.ms,
721 			    rpipe->pipe_map.pos, size, uio);
722 			PIPE_LOCK(rpipe);
723 			if (error)
724 				break;
725 			nread += size;
726 			rpipe->pipe_map.pos += size;
727 			rpipe->pipe_map.cnt -= size;
728 			if (rpipe->pipe_map.cnt == 0) {
729 				rpipe->pipe_state &= ~PIPE_WANTW;
730 				wakeup(rpipe);
731 			}
732 #endif
733 		} else {
734 			/*
735 			 * detect EOF condition
736 			 * read returns 0 on EOF, no need to set error
737 			 */
738 			if (rpipe->pipe_state & PIPE_EOF)
739 				break;
740 
741 			/*
742 			 * If the "write-side" has been blocked, wake it up now.
743 			 */
744 			if (rpipe->pipe_state & PIPE_WANTW) {
745 				rpipe->pipe_state &= ~PIPE_WANTW;
746 				wakeup(rpipe);
747 			}
748 
749 			/*
750 			 * Break if some data was read.
751 			 */
752 			if (nread > 0)
753 				break;
754 
755 			/*
756 			 * Unlock the pipe buffer for our remaining processing.
757 			 * We will either break out with an error or we will
758 			 * sleep and relock to loop.
759 			 */
760 			pipeunlock(rpipe);
761 
762 			/*
763 			 * Handle non-blocking mode operation or
764 			 * wait for more data.
765 			 */
766 			if (fp->f_flag & FNONBLOCK) {
767 				error = EAGAIN;
768 			} else {
769 				rpipe->pipe_state |= PIPE_WANTR;
770 				if ((error = msleep(rpipe, PIPE_MTX(rpipe),
771 				    PRIBIO | PCATCH,
772 				    "piperd", 0)) == 0)
773 					error = pipelock(rpipe, 1);
774 			}
775 			if (error)
776 				goto unlocked_error;
777 		}
778 	}
779 #ifdef MAC
780 locked_error:
781 #endif
782 	pipeunlock(rpipe);
783 
784 	/* XXX: should probably do this before getting any locks. */
785 	if (error == 0)
786 		vfs_timestamp(&rpipe->pipe_atime);
787 unlocked_error:
788 	--rpipe->pipe_busy;
789 
790 	/*
791 	 * PIPE_WANT processing only makes sense if pipe_busy is 0.
792 	 */
793 	if ((rpipe->pipe_busy == 0) && (rpipe->pipe_state & PIPE_WANT)) {
794 		rpipe->pipe_state &= ~(PIPE_WANT|PIPE_WANTW);
795 		wakeup(rpipe);
796 	} else if (rpipe->pipe_buffer.cnt < MINPIPESIZE) {
797 		/*
798 		 * Handle write blocking hysteresis.
799 		 */
800 		if (rpipe->pipe_state & PIPE_WANTW) {
801 			rpipe->pipe_state &= ~PIPE_WANTW;
802 			wakeup(rpipe);
803 		}
804 	}
805 
806 	if ((rpipe->pipe_buffer.size - rpipe->pipe_buffer.cnt) >= PIPE_BUF)
807 		pipeselwakeup(rpipe);
808 
809 	PIPE_UNLOCK(rpipe);
810 	return (error);
811 }
812 
813 #ifndef PIPE_NODIRECT
814 /*
815  * Map the sending processes' buffer into kernel space and wire it.
816  * This is similar to a physical write operation.
817  */
818 static int
819 pipe_build_write_buffer(struct pipe *wpipe, struct uio *uio)
820 {
821 	u_int size;
822 	int i;
823 
824 	PIPE_LOCK_ASSERT(wpipe, MA_NOTOWNED);
825 	KASSERT(wpipe->pipe_state & PIPE_DIRECTW,
826 		("Clone attempt on non-direct write pipe!"));
827 
828 	if (uio->uio_iov->iov_len > wpipe->pipe_buffer.size)
829                 size = wpipe->pipe_buffer.size;
830 	else
831                 size = uio->uio_iov->iov_len;
832 
833 	if ((i = vm_fault_quick_hold_pages(&curproc->p_vmspace->vm_map,
834 	    (vm_offset_t)uio->uio_iov->iov_base, size, VM_PROT_READ,
835 	    wpipe->pipe_map.ms, PIPENPAGES)) < 0)
836 		return (EFAULT);
837 
838 /*
839  * set up the control block
840  */
841 	wpipe->pipe_map.npages = i;
842 	wpipe->pipe_map.pos =
843 	    ((vm_offset_t) uio->uio_iov->iov_base) & PAGE_MASK;
844 	wpipe->pipe_map.cnt = size;
845 
846 /*
847  * and update the uio data
848  */
849 
850 	uio->uio_iov->iov_len -= size;
851 	uio->uio_iov->iov_base = (char *)uio->uio_iov->iov_base + size;
852 	if (uio->uio_iov->iov_len == 0)
853 		uio->uio_iov++;
854 	uio->uio_resid -= size;
855 	uio->uio_offset += size;
856 	return (0);
857 }
858 
859 /*
860  * Unwire the process buffer.
861  */
862 static void
863 pipe_destroy_write_buffer(struct pipe *wpipe)
864 {
865 
866 	PIPE_LOCK_ASSERT(wpipe, MA_OWNED);
867 	KASSERT((wpipe->pipe_state & PIPE_DIRECTW) != 0,
868 	    ("%s: PIPE_DIRECTW not set on %p", __func__, wpipe));
869 
870 	wpipe->pipe_state &= ~PIPE_DIRECTW;
871 	vm_page_unhold_pages(wpipe->pipe_map.ms, wpipe->pipe_map.npages);
872 	wpipe->pipe_map.npages = 0;
873 }
874 
875 /*
876  * In the case of a signal, the writing process might go away.  This
877  * code copies the data into the circular buffer so that the source
878  * pages can be freed without loss of data.
879  */
880 static void
881 pipe_clone_write_buffer(struct pipe *wpipe)
882 {
883 	struct uio uio;
884 	struct iovec iov;
885 	int size;
886 	int pos;
887 
888 	PIPE_LOCK_ASSERT(wpipe, MA_OWNED);
889 	KASSERT((wpipe->pipe_state & PIPE_DIRECTW) != 0,
890 	    ("%s: PIPE_DIRECTW not set on %p", __func__, wpipe));
891 
892 	size = wpipe->pipe_map.cnt;
893 	pos = wpipe->pipe_map.pos;
894 
895 	wpipe->pipe_buffer.in = size;
896 	wpipe->pipe_buffer.out = 0;
897 	wpipe->pipe_buffer.cnt = size;
898 
899 	PIPE_UNLOCK(wpipe);
900 	iov.iov_base = wpipe->pipe_buffer.buffer;
901 	iov.iov_len = size;
902 	uio.uio_iov = &iov;
903 	uio.uio_iovcnt = 1;
904 	uio.uio_offset = 0;
905 	uio.uio_resid = size;
906 	uio.uio_segflg = UIO_SYSSPACE;
907 	uio.uio_rw = UIO_READ;
908 	uio.uio_td = curthread;
909 	uiomove_fromphys(wpipe->pipe_map.ms, pos, size, &uio);
910 	PIPE_LOCK(wpipe);
911 	pipe_destroy_write_buffer(wpipe);
912 }
913 
914 /*
915  * This implements the pipe buffer write mechanism.  Note that only
916  * a direct write OR a normal pipe write can be pending at any given time.
917  * If there are any characters in the pipe buffer, the direct write will
918  * be deferred until the receiving process grabs all of the bytes from
919  * the pipe buffer.  Then the direct mapping write is set-up.
920  */
921 static int
922 pipe_direct_write(struct pipe *wpipe, struct uio *uio)
923 {
924 	int error;
925 
926 retry:
927 	PIPE_LOCK_ASSERT(wpipe, MA_OWNED);
928 	error = pipelock(wpipe, 1);
929 	if (error != 0)
930 		goto error1;
931 	if ((wpipe->pipe_state & PIPE_EOF) != 0) {
932 		error = EPIPE;
933 		pipeunlock(wpipe);
934 		goto error1;
935 	}
936 	if (wpipe->pipe_state & PIPE_DIRECTW) {
937 		if (wpipe->pipe_state & PIPE_WANTR) {
938 			wpipe->pipe_state &= ~PIPE_WANTR;
939 			wakeup(wpipe);
940 		}
941 		pipeselwakeup(wpipe);
942 		wpipe->pipe_state |= PIPE_WANTW;
943 		pipeunlock(wpipe);
944 		error = msleep(wpipe, PIPE_MTX(wpipe),
945 		    PRIBIO | PCATCH, "pipdww", 0);
946 		if (error)
947 			goto error1;
948 		else
949 			goto retry;
950 	}
951 	wpipe->pipe_map.cnt = 0;	/* transfer not ready yet */
952 	if (wpipe->pipe_buffer.cnt > 0) {
953 		if (wpipe->pipe_state & PIPE_WANTR) {
954 			wpipe->pipe_state &= ~PIPE_WANTR;
955 			wakeup(wpipe);
956 		}
957 		pipeselwakeup(wpipe);
958 		wpipe->pipe_state |= PIPE_WANTW;
959 		pipeunlock(wpipe);
960 		error = msleep(wpipe, PIPE_MTX(wpipe),
961 		    PRIBIO | PCATCH, "pipdwc", 0);
962 		if (error)
963 			goto error1;
964 		else
965 			goto retry;
966 	}
967 
968 	wpipe->pipe_state |= PIPE_DIRECTW;
969 
970 	PIPE_UNLOCK(wpipe);
971 	error = pipe_build_write_buffer(wpipe, uio);
972 	PIPE_LOCK(wpipe);
973 	if (error) {
974 		wpipe->pipe_state &= ~PIPE_DIRECTW;
975 		pipeunlock(wpipe);
976 		goto error1;
977 	}
978 
979 	while (wpipe->pipe_map.cnt != 0) {
980 		if (wpipe->pipe_state & PIPE_EOF) {
981 			pipe_destroy_write_buffer(wpipe);
982 			pipeselwakeup(wpipe);
983 			pipeunlock(wpipe);
984 			error = EPIPE;
985 			goto error1;
986 		}
987 		if (wpipe->pipe_state & PIPE_WANTR) {
988 			wpipe->pipe_state &= ~PIPE_WANTR;
989 			wakeup(wpipe);
990 		}
991 		pipeselwakeup(wpipe);
992 		wpipe->pipe_state |= PIPE_WANTW;
993 		pipeunlock(wpipe);
994 		error = msleep(wpipe, PIPE_MTX(wpipe), PRIBIO | PCATCH,
995 		    "pipdwt", 0);
996 		pipelock(wpipe, 0);
997 		if (error != 0)
998 			break;
999 	}
1000 
1001 	if (wpipe->pipe_state & PIPE_EOF)
1002 		error = EPIPE;
1003 	if (error == EINTR || error == ERESTART)
1004 		pipe_clone_write_buffer(wpipe);
1005 	else
1006 		pipe_destroy_write_buffer(wpipe);
1007 	pipeunlock(wpipe);
1008 	KASSERT((wpipe->pipe_state & PIPE_DIRECTW) == 0,
1009 	    ("pipe %p leaked PIPE_DIRECTW", wpipe));
1010 	return (error);
1011 
1012 error1:
1013 	wakeup(wpipe);
1014 	return (error);
1015 }
1016 #endif
1017 
1018 static int
1019 pipe_write(struct file *fp, struct uio *uio, struct ucred *active_cred,
1020     int flags, struct thread *td)
1021 {
1022 	int error = 0;
1023 	int desiredsize;
1024 	ssize_t orig_resid;
1025 	struct pipe *wpipe, *rpipe;
1026 
1027 	rpipe = fp->f_data;
1028 	wpipe = PIPE_PEER(rpipe);
1029 	PIPE_LOCK(rpipe);
1030 	error = pipelock(wpipe, 1);
1031 	if (error) {
1032 		PIPE_UNLOCK(rpipe);
1033 		return (error);
1034 	}
1035 	/*
1036 	 * detect loss of pipe read side, issue SIGPIPE if lost.
1037 	 */
1038 	if (wpipe->pipe_present != PIPE_ACTIVE ||
1039 	    (wpipe->pipe_state & PIPE_EOF)) {
1040 		pipeunlock(wpipe);
1041 		PIPE_UNLOCK(rpipe);
1042 		return (EPIPE);
1043 	}
1044 #ifdef MAC
1045 	error = mac_pipe_check_write(active_cred, wpipe->pipe_pair);
1046 	if (error) {
1047 		pipeunlock(wpipe);
1048 		PIPE_UNLOCK(rpipe);
1049 		return (error);
1050 	}
1051 #endif
1052 	++wpipe->pipe_busy;
1053 
1054 	/* Choose a larger size if it's advantageous */
1055 	desiredsize = max(SMALL_PIPE_SIZE, wpipe->pipe_buffer.size);
1056 	while (desiredsize < wpipe->pipe_buffer.cnt + uio->uio_resid) {
1057 		if (piperesizeallowed != 1)
1058 			break;
1059 		if (amountpipekva > maxpipekva / 2)
1060 			break;
1061 		if (desiredsize == BIG_PIPE_SIZE)
1062 			break;
1063 		desiredsize = desiredsize * 2;
1064 	}
1065 
1066 	/* Choose a smaller size if we're in a OOM situation */
1067 	if ((amountpipekva > (3 * maxpipekva) / 4) &&
1068 		(wpipe->pipe_buffer.size > SMALL_PIPE_SIZE) &&
1069 		(wpipe->pipe_buffer.cnt <= SMALL_PIPE_SIZE) &&
1070 		(piperesizeallowed == 1))
1071 		desiredsize = SMALL_PIPE_SIZE;
1072 
1073 	/* Resize if the above determined that a new size was necessary */
1074 	if ((desiredsize != wpipe->pipe_buffer.size) &&
1075 		((wpipe->pipe_state & PIPE_DIRECTW) == 0)) {
1076 		PIPE_UNLOCK(wpipe);
1077 		pipespace(wpipe, desiredsize);
1078 		PIPE_LOCK(wpipe);
1079 	}
1080 	if (wpipe->pipe_buffer.size == 0) {
1081 		/*
1082 		 * This can only happen for reverse direction use of pipes
1083 		 * in a complete OOM situation.
1084 		 */
1085 		error = ENOMEM;
1086 		--wpipe->pipe_busy;
1087 		pipeunlock(wpipe);
1088 		PIPE_UNLOCK(wpipe);
1089 		return (error);
1090 	}
1091 
1092 	pipeunlock(wpipe);
1093 
1094 	orig_resid = uio->uio_resid;
1095 
1096 	while (uio->uio_resid) {
1097 		int space;
1098 
1099 		pipelock(wpipe, 0);
1100 		if (wpipe->pipe_state & PIPE_EOF) {
1101 			pipeunlock(wpipe);
1102 			error = EPIPE;
1103 			break;
1104 		}
1105 #ifndef PIPE_NODIRECT
1106 		/*
1107 		 * If the transfer is large, we can gain performance if
1108 		 * we do process-to-process copies directly.
1109 		 * If the write is non-blocking, we don't use the
1110 		 * direct write mechanism.
1111 		 *
1112 		 * The direct write mechanism will detect the reader going
1113 		 * away on us.
1114 		 */
1115 		if (uio->uio_segflg == UIO_USERSPACE &&
1116 		    uio->uio_iov->iov_len >= PIPE_MINDIRECT &&
1117 		    wpipe->pipe_buffer.size >= PIPE_MINDIRECT &&
1118 		    (fp->f_flag & FNONBLOCK) == 0) {
1119 			pipeunlock(wpipe);
1120 			error = pipe_direct_write(wpipe, uio);
1121 			if (error)
1122 				break;
1123 			continue;
1124 		}
1125 #endif
1126 
1127 		/*
1128 		 * Pipe buffered writes cannot be coincidental with
1129 		 * direct writes.  We wait until the currently executing
1130 		 * direct write is completed before we start filling the
1131 		 * pipe buffer.  We break out if a signal occurs or the
1132 		 * reader goes away.
1133 		 */
1134 		if (wpipe->pipe_state & PIPE_DIRECTW) {
1135 			if (wpipe->pipe_state & PIPE_WANTR) {
1136 				wpipe->pipe_state &= ~PIPE_WANTR;
1137 				wakeup(wpipe);
1138 			}
1139 			pipeselwakeup(wpipe);
1140 			wpipe->pipe_state |= PIPE_WANTW;
1141 			pipeunlock(wpipe);
1142 			error = msleep(wpipe, PIPE_MTX(rpipe), PRIBIO | PCATCH,
1143 			    "pipbww", 0);
1144 			if (error)
1145 				break;
1146 			else
1147 				continue;
1148 		}
1149 
1150 		space = wpipe->pipe_buffer.size - wpipe->pipe_buffer.cnt;
1151 
1152 		/* Writes of size <= PIPE_BUF must be atomic. */
1153 		if ((space < uio->uio_resid) && (orig_resid <= PIPE_BUF))
1154 			space = 0;
1155 
1156 		if (space > 0) {
1157 			int size;	/* Transfer size */
1158 			int segsize;	/* first segment to transfer */
1159 
1160 			/*
1161 			 * Transfer size is minimum of uio transfer
1162 			 * and free space in pipe buffer.
1163 			 */
1164 			if (space > uio->uio_resid)
1165 				size = uio->uio_resid;
1166 			else
1167 				size = space;
1168 			/*
1169 			 * First segment to transfer is minimum of
1170 			 * transfer size and contiguous space in
1171 			 * pipe buffer.  If first segment to transfer
1172 			 * is less than the transfer size, we've got
1173 			 * a wraparound in the buffer.
1174 			 */
1175 			segsize = wpipe->pipe_buffer.size -
1176 				wpipe->pipe_buffer.in;
1177 			if (segsize > size)
1178 				segsize = size;
1179 
1180 			/* Transfer first segment */
1181 
1182 			PIPE_UNLOCK(rpipe);
1183 			error = uiomove(&wpipe->pipe_buffer.buffer[wpipe->pipe_buffer.in],
1184 					segsize, uio);
1185 			PIPE_LOCK(rpipe);
1186 
1187 			if (error == 0 && segsize < size) {
1188 				KASSERT(wpipe->pipe_buffer.in + segsize ==
1189 					wpipe->pipe_buffer.size,
1190 					("Pipe buffer wraparound disappeared"));
1191 				/*
1192 				 * Transfer remaining part now, to
1193 				 * support atomic writes.  Wraparound
1194 				 * happened.
1195 				 */
1196 
1197 				PIPE_UNLOCK(rpipe);
1198 				error = uiomove(
1199 				    &wpipe->pipe_buffer.buffer[0],
1200 				    size - segsize, uio);
1201 				PIPE_LOCK(rpipe);
1202 			}
1203 			if (error == 0) {
1204 				wpipe->pipe_buffer.in += size;
1205 				if (wpipe->pipe_buffer.in >=
1206 				    wpipe->pipe_buffer.size) {
1207 					KASSERT(wpipe->pipe_buffer.in ==
1208 						size - segsize +
1209 						wpipe->pipe_buffer.size,
1210 						("Expected wraparound bad"));
1211 					wpipe->pipe_buffer.in = size - segsize;
1212 				}
1213 
1214 				wpipe->pipe_buffer.cnt += size;
1215 				KASSERT(wpipe->pipe_buffer.cnt <=
1216 					wpipe->pipe_buffer.size,
1217 					("Pipe buffer overflow"));
1218 			}
1219 			pipeunlock(wpipe);
1220 			if (error != 0)
1221 				break;
1222 		} else {
1223 			/*
1224 			 * If the "read-side" has been blocked, wake it up now.
1225 			 */
1226 			if (wpipe->pipe_state & PIPE_WANTR) {
1227 				wpipe->pipe_state &= ~PIPE_WANTR;
1228 				wakeup(wpipe);
1229 			}
1230 
1231 			/*
1232 			 * don't block on non-blocking I/O
1233 			 */
1234 			if (fp->f_flag & FNONBLOCK) {
1235 				error = EAGAIN;
1236 				pipeunlock(wpipe);
1237 				break;
1238 			}
1239 
1240 			/*
1241 			 * We have no more space and have something to offer,
1242 			 * wake up select/poll.
1243 			 */
1244 			pipeselwakeup(wpipe);
1245 
1246 			wpipe->pipe_state |= PIPE_WANTW;
1247 			pipeunlock(wpipe);
1248 			error = msleep(wpipe, PIPE_MTX(rpipe),
1249 			    PRIBIO | PCATCH, "pipewr", 0);
1250 			if (error != 0)
1251 				break;
1252 		}
1253 	}
1254 
1255 	pipelock(wpipe, 0);
1256 	--wpipe->pipe_busy;
1257 
1258 	if ((wpipe->pipe_busy == 0) && (wpipe->pipe_state & PIPE_WANT)) {
1259 		wpipe->pipe_state &= ~(PIPE_WANT | PIPE_WANTR);
1260 		wakeup(wpipe);
1261 	} else if (wpipe->pipe_buffer.cnt > 0) {
1262 		/*
1263 		 * If we have put any characters in the buffer, we wake up
1264 		 * the reader.
1265 		 */
1266 		if (wpipe->pipe_state & PIPE_WANTR) {
1267 			wpipe->pipe_state &= ~PIPE_WANTR;
1268 			wakeup(wpipe);
1269 		}
1270 	}
1271 
1272 	/*
1273 	 * Don't return EPIPE if any byte was written.
1274 	 * EINTR and other interrupts are handled by generic I/O layer.
1275 	 * Do not pretend that I/O succeeded for obvious user error
1276 	 * like EFAULT.
1277 	 */
1278 	if (uio->uio_resid != orig_resid && error == EPIPE)
1279 		error = 0;
1280 
1281 	if (error == 0)
1282 		vfs_timestamp(&wpipe->pipe_mtime);
1283 
1284 	/*
1285 	 * We have something to offer,
1286 	 * wake up select/poll.
1287 	 */
1288 	if (wpipe->pipe_buffer.cnt)
1289 		pipeselwakeup(wpipe);
1290 
1291 	pipeunlock(wpipe);
1292 	PIPE_UNLOCK(rpipe);
1293 	return (error);
1294 }
1295 
1296 /* ARGSUSED */
1297 static int
1298 pipe_truncate(struct file *fp, off_t length, struct ucred *active_cred,
1299     struct thread *td)
1300 {
1301 	struct pipe *cpipe;
1302 	int error;
1303 
1304 	cpipe = fp->f_data;
1305 	if (cpipe->pipe_state & PIPE_NAMED)
1306 		error = vnops.fo_truncate(fp, length, active_cred, td);
1307 	else
1308 		error = invfo_truncate(fp, length, active_cred, td);
1309 	return (error);
1310 }
1311 
1312 /*
1313  * we implement a very minimal set of ioctls for compatibility with sockets.
1314  */
1315 static int
1316 pipe_ioctl(struct file *fp, u_long cmd, void *data, struct ucred *active_cred,
1317     struct thread *td)
1318 {
1319 	struct pipe *mpipe = fp->f_data;
1320 	int error;
1321 
1322 	PIPE_LOCK(mpipe);
1323 
1324 #ifdef MAC
1325 	error = mac_pipe_check_ioctl(active_cred, mpipe->pipe_pair, cmd, data);
1326 	if (error) {
1327 		PIPE_UNLOCK(mpipe);
1328 		return (error);
1329 	}
1330 #endif
1331 
1332 	error = 0;
1333 	switch (cmd) {
1334 
1335 	case FIONBIO:
1336 		break;
1337 
1338 	case FIOASYNC:
1339 		if (*(int *)data) {
1340 			mpipe->pipe_state |= PIPE_ASYNC;
1341 		} else {
1342 			mpipe->pipe_state &= ~PIPE_ASYNC;
1343 		}
1344 		break;
1345 
1346 	case FIONREAD:
1347 		if (!(fp->f_flag & FREAD)) {
1348 			*(int *)data = 0;
1349 			PIPE_UNLOCK(mpipe);
1350 			return (0);
1351 		}
1352 		if (mpipe->pipe_state & PIPE_DIRECTW)
1353 			*(int *)data = mpipe->pipe_map.cnt;
1354 		else
1355 			*(int *)data = mpipe->pipe_buffer.cnt;
1356 		break;
1357 
1358 	case FIOSETOWN:
1359 		PIPE_UNLOCK(mpipe);
1360 		error = fsetown(*(int *)data, &mpipe->pipe_sigio);
1361 		goto out_unlocked;
1362 
1363 	case FIOGETOWN:
1364 		*(int *)data = fgetown(&mpipe->pipe_sigio);
1365 		break;
1366 
1367 	/* This is deprecated, FIOSETOWN should be used instead. */
1368 	case TIOCSPGRP:
1369 		PIPE_UNLOCK(mpipe);
1370 		error = fsetown(-(*(int *)data), &mpipe->pipe_sigio);
1371 		goto out_unlocked;
1372 
1373 	/* This is deprecated, FIOGETOWN should be used instead. */
1374 	case TIOCGPGRP:
1375 		*(int *)data = -fgetown(&mpipe->pipe_sigio);
1376 		break;
1377 
1378 	default:
1379 		error = ENOTTY;
1380 		break;
1381 	}
1382 	PIPE_UNLOCK(mpipe);
1383 out_unlocked:
1384 	return (error);
1385 }
1386 
1387 static int
1388 pipe_poll(struct file *fp, int events, struct ucred *active_cred,
1389     struct thread *td)
1390 {
1391 	struct pipe *rpipe;
1392 	struct pipe *wpipe;
1393 	int levents, revents;
1394 #ifdef MAC
1395 	int error;
1396 #endif
1397 
1398 	revents = 0;
1399 	rpipe = fp->f_data;
1400 	wpipe = PIPE_PEER(rpipe);
1401 	PIPE_LOCK(rpipe);
1402 #ifdef MAC
1403 	error = mac_pipe_check_poll(active_cred, rpipe->pipe_pair);
1404 	if (error)
1405 		goto locked_error;
1406 #endif
1407 	if (fp->f_flag & FREAD && events & (POLLIN | POLLRDNORM))
1408 		if ((rpipe->pipe_state & PIPE_DIRECTW) ||
1409 		    (rpipe->pipe_buffer.cnt > 0))
1410 			revents |= events & (POLLIN | POLLRDNORM);
1411 
1412 	if (fp->f_flag & FWRITE && events & (POLLOUT | POLLWRNORM))
1413 		if (wpipe->pipe_present != PIPE_ACTIVE ||
1414 		    (wpipe->pipe_state & PIPE_EOF) ||
1415 		    (((wpipe->pipe_state & PIPE_DIRECTW) == 0) &&
1416 		     ((wpipe->pipe_buffer.size - wpipe->pipe_buffer.cnt) >= PIPE_BUF ||
1417 			 wpipe->pipe_buffer.size == 0)))
1418 			revents |= events & (POLLOUT | POLLWRNORM);
1419 
1420 	levents = events &
1421 	    (POLLIN | POLLINIGNEOF | POLLPRI | POLLRDNORM | POLLRDBAND);
1422 	if (rpipe->pipe_state & PIPE_NAMED && fp->f_flag & FREAD && levents &&
1423 	    fp->f_pipegen == rpipe->pipe_wgen)
1424 		events |= POLLINIGNEOF;
1425 
1426 	if ((events & POLLINIGNEOF) == 0) {
1427 		if (rpipe->pipe_state & PIPE_EOF) {
1428 			revents |= (events & (POLLIN | POLLRDNORM));
1429 			if (wpipe->pipe_present != PIPE_ACTIVE ||
1430 			    (wpipe->pipe_state & PIPE_EOF))
1431 				revents |= POLLHUP;
1432 		}
1433 	}
1434 
1435 	if (revents == 0) {
1436 		if (fp->f_flag & FREAD && events & (POLLIN | POLLRDNORM)) {
1437 			selrecord(td, &rpipe->pipe_sel);
1438 			if (SEL_WAITING(&rpipe->pipe_sel))
1439 				rpipe->pipe_state |= PIPE_SEL;
1440 		}
1441 
1442 		if (fp->f_flag & FWRITE && events & (POLLOUT | POLLWRNORM)) {
1443 			selrecord(td, &wpipe->pipe_sel);
1444 			if (SEL_WAITING(&wpipe->pipe_sel))
1445 				wpipe->pipe_state |= PIPE_SEL;
1446 		}
1447 	}
1448 #ifdef MAC
1449 locked_error:
1450 #endif
1451 	PIPE_UNLOCK(rpipe);
1452 
1453 	return (revents);
1454 }
1455 
1456 /*
1457  * We shouldn't need locks here as we're doing a read and this should
1458  * be a natural race.
1459  */
1460 static int
1461 pipe_stat(struct file *fp, struct stat *ub, struct ucred *active_cred,
1462     struct thread *td)
1463 {
1464 	struct pipe *pipe;
1465 #ifdef MAC
1466 	int error;
1467 #endif
1468 
1469 	pipe = fp->f_data;
1470 	PIPE_LOCK(pipe);
1471 #ifdef MAC
1472 	error = mac_pipe_check_stat(active_cred, pipe->pipe_pair);
1473 	if (error) {
1474 		PIPE_UNLOCK(pipe);
1475 		return (error);
1476 	}
1477 #endif
1478 
1479 	/* For named pipes ask the underlying filesystem. */
1480 	if (pipe->pipe_state & PIPE_NAMED) {
1481 		PIPE_UNLOCK(pipe);
1482 		return (vnops.fo_stat(fp, ub, active_cred, td));
1483 	}
1484 
1485 	PIPE_UNLOCK(pipe);
1486 
1487 	bzero(ub, sizeof(*ub));
1488 	ub->st_mode = S_IFIFO;
1489 	ub->st_blksize = PAGE_SIZE;
1490 	if (pipe->pipe_state & PIPE_DIRECTW)
1491 		ub->st_size = pipe->pipe_map.cnt;
1492 	else
1493 		ub->st_size = pipe->pipe_buffer.cnt;
1494 	ub->st_blocks = howmany(ub->st_size, ub->st_blksize);
1495 	ub->st_atim = pipe->pipe_atime;
1496 	ub->st_mtim = pipe->pipe_mtime;
1497 	ub->st_ctim = pipe->pipe_ctime;
1498 	ub->st_uid = fp->f_cred->cr_uid;
1499 	ub->st_gid = fp->f_cred->cr_gid;
1500 	ub->st_dev = pipedev_ino;
1501 	ub->st_ino = pipe->pipe_ino;
1502 	/*
1503 	 * Left as 0: st_nlink, st_rdev, st_flags, st_gen.
1504 	 */
1505 	return (0);
1506 }
1507 
1508 /* ARGSUSED */
1509 static int
1510 pipe_close(struct file *fp, struct thread *td)
1511 {
1512 
1513 	if (fp->f_vnode != NULL)
1514 		return vnops.fo_close(fp, td);
1515 	fp->f_ops = &badfileops;
1516 	pipe_dtor(fp->f_data);
1517 	fp->f_data = NULL;
1518 	return (0);
1519 }
1520 
1521 static int
1522 pipe_chmod(struct file *fp, mode_t mode, struct ucred *active_cred, struct thread *td)
1523 {
1524 	struct pipe *cpipe;
1525 	int error;
1526 
1527 	cpipe = fp->f_data;
1528 	if (cpipe->pipe_state & PIPE_NAMED)
1529 		error = vn_chmod(fp, mode, active_cred, td);
1530 	else
1531 		error = invfo_chmod(fp, mode, active_cred, td);
1532 	return (error);
1533 }
1534 
1535 static int
1536 pipe_chown(struct file *fp, uid_t uid, gid_t gid, struct ucred *active_cred,
1537     struct thread *td)
1538 {
1539 	struct pipe *cpipe;
1540 	int error;
1541 
1542 	cpipe = fp->f_data;
1543 	if (cpipe->pipe_state & PIPE_NAMED)
1544 		error = vn_chown(fp, uid, gid, active_cred, td);
1545 	else
1546 		error = invfo_chown(fp, uid, gid, active_cred, td);
1547 	return (error);
1548 }
1549 
1550 static int
1551 pipe_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
1552 {
1553 	struct pipe *pi;
1554 
1555 	if (fp->f_type == DTYPE_FIFO)
1556 		return (vn_fill_kinfo(fp, kif, fdp));
1557 	kif->kf_type = KF_TYPE_PIPE;
1558 	pi = fp->f_data;
1559 	kif->kf_un.kf_pipe.kf_pipe_addr = (uintptr_t)pi;
1560 	kif->kf_un.kf_pipe.kf_pipe_peer = (uintptr_t)pi->pipe_peer;
1561 	kif->kf_un.kf_pipe.kf_pipe_buffer_cnt = pi->pipe_buffer.cnt;
1562 	return (0);
1563 }
1564 
1565 static void
1566 pipe_free_kmem(struct pipe *cpipe)
1567 {
1568 
1569 	KASSERT(!mtx_owned(PIPE_MTX(cpipe)),
1570 	    ("pipe_free_kmem: pipe mutex locked"));
1571 
1572 	if (cpipe->pipe_buffer.buffer != NULL) {
1573 		atomic_subtract_long(&amountpipekva, cpipe->pipe_buffer.size);
1574 		vm_map_remove(pipe_map,
1575 		    (vm_offset_t)cpipe->pipe_buffer.buffer,
1576 		    (vm_offset_t)cpipe->pipe_buffer.buffer + cpipe->pipe_buffer.size);
1577 		cpipe->pipe_buffer.buffer = NULL;
1578 	}
1579 #ifndef PIPE_NODIRECT
1580 	{
1581 		cpipe->pipe_map.cnt = 0;
1582 		cpipe->pipe_map.pos = 0;
1583 		cpipe->pipe_map.npages = 0;
1584 	}
1585 #endif
1586 }
1587 
1588 /*
1589  * shutdown the pipe
1590  */
1591 static void
1592 pipeclose(struct pipe *cpipe)
1593 {
1594 	struct pipepair *pp;
1595 	struct pipe *ppipe;
1596 
1597 	KASSERT(cpipe != NULL, ("pipeclose: cpipe == NULL"));
1598 
1599 	PIPE_LOCK(cpipe);
1600 	pipelock(cpipe, 0);
1601 	pp = cpipe->pipe_pair;
1602 
1603 	pipeselwakeup(cpipe);
1604 
1605 	/*
1606 	 * If the other side is blocked, wake it up saying that
1607 	 * we want to close it down.
1608 	 */
1609 	cpipe->pipe_state |= PIPE_EOF;
1610 	while (cpipe->pipe_busy) {
1611 		wakeup(cpipe);
1612 		cpipe->pipe_state |= PIPE_WANT;
1613 		pipeunlock(cpipe);
1614 		msleep(cpipe, PIPE_MTX(cpipe), PRIBIO, "pipecl", 0);
1615 		pipelock(cpipe, 0);
1616 	}
1617 
1618 
1619 	/*
1620 	 * Disconnect from peer, if any.
1621 	 */
1622 	ppipe = cpipe->pipe_peer;
1623 	if (ppipe->pipe_present == PIPE_ACTIVE) {
1624 		pipeselwakeup(ppipe);
1625 
1626 		ppipe->pipe_state |= PIPE_EOF;
1627 		wakeup(ppipe);
1628 		KNOTE_LOCKED(&ppipe->pipe_sel.si_note, 0);
1629 	}
1630 
1631 	/*
1632 	 * Mark this endpoint as free.  Release kmem resources.  We
1633 	 * don't mark this endpoint as unused until we've finished
1634 	 * doing that, or the pipe might disappear out from under
1635 	 * us.
1636 	 */
1637 	PIPE_UNLOCK(cpipe);
1638 	pipe_free_kmem(cpipe);
1639 	PIPE_LOCK(cpipe);
1640 	cpipe->pipe_present = PIPE_CLOSING;
1641 	pipeunlock(cpipe);
1642 
1643 	/*
1644 	 * knlist_clear() may sleep dropping the PIPE_MTX. Set the
1645 	 * PIPE_FINALIZED, that allows other end to free the
1646 	 * pipe_pair, only after the knotes are completely dismantled.
1647 	 */
1648 	knlist_clear(&cpipe->pipe_sel.si_note, 1);
1649 	cpipe->pipe_present = PIPE_FINALIZED;
1650 	seldrain(&cpipe->pipe_sel);
1651 	knlist_destroy(&cpipe->pipe_sel.si_note);
1652 
1653 	/*
1654 	 * If both endpoints are now closed, release the memory for the
1655 	 * pipe pair.  If not, unlock.
1656 	 */
1657 	if (ppipe->pipe_present == PIPE_FINALIZED) {
1658 		PIPE_UNLOCK(cpipe);
1659 #ifdef MAC
1660 		mac_pipe_destroy(pp);
1661 #endif
1662 		uma_zfree(pipe_zone, cpipe->pipe_pair);
1663 	} else
1664 		PIPE_UNLOCK(cpipe);
1665 }
1666 
1667 /*ARGSUSED*/
1668 static int
1669 pipe_kqfilter(struct file *fp, struct knote *kn)
1670 {
1671 	struct pipe *cpipe;
1672 
1673 	/*
1674 	 * If a filter is requested that is not supported by this file
1675 	 * descriptor, don't return an error, but also don't ever generate an
1676 	 * event.
1677 	 */
1678 	if ((kn->kn_filter == EVFILT_READ) && !(fp->f_flag & FREAD)) {
1679 		kn->kn_fop = &pipe_nfiltops;
1680 		return (0);
1681 	}
1682 	if ((kn->kn_filter == EVFILT_WRITE) && !(fp->f_flag & FWRITE)) {
1683 		kn->kn_fop = &pipe_nfiltops;
1684 		return (0);
1685 	}
1686 	cpipe = fp->f_data;
1687 	PIPE_LOCK(cpipe);
1688 	switch (kn->kn_filter) {
1689 	case EVFILT_READ:
1690 		kn->kn_fop = &pipe_rfiltops;
1691 		break;
1692 	case EVFILT_WRITE:
1693 		kn->kn_fop = &pipe_wfiltops;
1694 		if (cpipe->pipe_peer->pipe_present != PIPE_ACTIVE) {
1695 			/* other end of pipe has been closed */
1696 			PIPE_UNLOCK(cpipe);
1697 			return (EPIPE);
1698 		}
1699 		cpipe = PIPE_PEER(cpipe);
1700 		break;
1701 	default:
1702 		PIPE_UNLOCK(cpipe);
1703 		return (EINVAL);
1704 	}
1705 
1706 	kn->kn_hook = cpipe;
1707 	knlist_add(&cpipe->pipe_sel.si_note, kn, 1);
1708 	PIPE_UNLOCK(cpipe);
1709 	return (0);
1710 }
1711 
1712 static void
1713 filt_pipedetach(struct knote *kn)
1714 {
1715 	struct pipe *cpipe = kn->kn_hook;
1716 
1717 	PIPE_LOCK(cpipe);
1718 	knlist_remove(&cpipe->pipe_sel.si_note, kn, 1);
1719 	PIPE_UNLOCK(cpipe);
1720 }
1721 
1722 /*ARGSUSED*/
1723 static int
1724 filt_piperead(struct knote *kn, long hint)
1725 {
1726 	struct pipe *rpipe = kn->kn_hook;
1727 	struct pipe *wpipe = rpipe->pipe_peer;
1728 	int ret;
1729 
1730 	PIPE_LOCK_ASSERT(rpipe, MA_OWNED);
1731 	kn->kn_data = rpipe->pipe_buffer.cnt;
1732 	if ((kn->kn_data == 0) && (rpipe->pipe_state & PIPE_DIRECTW))
1733 		kn->kn_data = rpipe->pipe_map.cnt;
1734 
1735 	if ((rpipe->pipe_state & PIPE_EOF) ||
1736 	    wpipe->pipe_present != PIPE_ACTIVE ||
1737 	    (wpipe->pipe_state & PIPE_EOF)) {
1738 		kn->kn_flags |= EV_EOF;
1739 		return (1);
1740 	}
1741 	ret = kn->kn_data > 0;
1742 	return ret;
1743 }
1744 
1745 /*ARGSUSED*/
1746 static int
1747 filt_pipewrite(struct knote *kn, long hint)
1748 {
1749 	struct pipe *wpipe;
1750 
1751 	/*
1752 	 * If this end of the pipe is closed, the knote was removed from the
1753 	 * knlist and the list lock (i.e., the pipe lock) is therefore not held.
1754 	 */
1755 	wpipe = kn->kn_hook;
1756 	if (wpipe->pipe_present != PIPE_ACTIVE ||
1757 	    (wpipe->pipe_state & PIPE_EOF)) {
1758 		kn->kn_data = 0;
1759 		kn->kn_flags |= EV_EOF;
1760 		return (1);
1761 	}
1762 	PIPE_LOCK_ASSERT(wpipe, MA_OWNED);
1763 	kn->kn_data = (wpipe->pipe_buffer.size > 0) ?
1764 	    (wpipe->pipe_buffer.size - wpipe->pipe_buffer.cnt) : PIPE_BUF;
1765 	if (wpipe->pipe_state & PIPE_DIRECTW)
1766 		kn->kn_data = 0;
1767 
1768 	return (kn->kn_data >= PIPE_BUF);
1769 }
1770 
1771 static void
1772 filt_pipedetach_notsup(struct knote *kn)
1773 {
1774 
1775 }
1776 
1777 static int
1778 filt_pipenotsup(struct knote *kn, long hint)
1779 {
1780 
1781 	return (0);
1782 }
1783