sys/kern/sys_pipe.c

   1 /*-
   2  * Copyright (c) 1996 John S. Dyson
   3  * Copyright (c) 2012 Giovanni Trematerra
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   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
  16  *    John S. Dyson.
  17  * 4. Modifications may be freely made to this file if the above conditions
  18  *    are met.
  19  */
  20
  21 /*
  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
  25  * do.
  26  */
  27
  28 /*
  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.
  36  *
  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.
  44  *
  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.
  48  *
  49  * In order to limit the resource use of pipes, two sysctls exist:
  50  *
  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.
  54  *
  55  * kern.ipc.pipekva - This read-only sysctl tracks the current amount of
  56  * memory in use by pipes.
  57  *
  58  * Based on how large pipekva is relative to maxpipekva, the following
  59  * will happen:
  60  *
  61  * 0% - 50%:
  62  *     New pipes are given 16K of memory backing, pipes may dynamically
  63  *     grow to as large as 64K where needed.
  64  * 50% - 75%:
  65  *     New pipes are given 4K (or PAGE_SIZE) of memory backing,
  66  *     existing pipes may NOT grow.
  67  * 75% - 100%:
  68  *     New pipes are given 4K (or PAGE_SIZE) of memory backing,
  69  *     existing pipes will be shrunk down to 4K whenever possible.
  70  *
  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
  74  * first used.
  75  *
  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.
  79  *
  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.
  86  *
  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.
  90  */
  91
  92 #include "opt_compat.h"
  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 unrhdr *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         pipeino_unr = new_unrhdr(1, INT32_MAX, NULL);
 261         KASSERT(pipeino_unr != NULL, ("pipe fake inodes not initialized"));
 262         pipedev_ino = devfs_alloc_cdp_inode();
 263         KASSERT(pipedev_ino > 0, ("pipe dev inode not initialized"));
 264 }
 265
 266 static int
 267 pipe_zone_ctor(void *mem, int size, void *arg, int flags)
 268 {
 269         struct pipepair *pp;
 270         struct pipe *rpipe, *wpipe;
 271
 272         KASSERT(size == sizeof(*pp), ("pipe_zone_ctor: wrong size"));
 273
 274         pp = (struct pipepair *)mem;
 275
 276         /*
 277          * We zero both pipe endpoints to make sure all the kmem pointers
 278          * are NULL, flag fields are zero'd, etc.  We timestamp both
 279          * endpoints with the same time.
 280          */
 281         rpipe = &pp->pp_rpipe;
 282         bzero(rpipe, sizeof(*rpipe));
 283         vfs_timestamp(&rpipe->pipe_ctime);
 284         rpipe->pipe_atime = rpipe->pipe_mtime = rpipe->pipe_ctime;
 285
 286         wpipe = &pp->pp_wpipe;
 287         bzero(wpipe, sizeof(*wpipe));
 288         wpipe->pipe_ctime = rpipe->pipe_ctime;
 289         wpipe->pipe_atime = wpipe->pipe_mtime = rpipe->pipe_ctime;
 290
 291         rpipe->pipe_peer = wpipe;
 292         rpipe->pipe_pair = pp;
 293         wpipe->pipe_peer = rpipe;
 294         wpipe->pipe_pair = pp;
 295
 296         /*
 297          * Mark both endpoints as present; they will later get free'd
 298          * one at a time.  When both are free'd, then the whole pair
 299          * is released.
 300          */
 301         rpipe->pipe_present = PIPE_ACTIVE;
 302         wpipe->pipe_present = PIPE_ACTIVE;
 303
 304         /*
 305          * Eventually, the MAC Framework may initialize the label
 306          * in ctor or init, but for now we do it elswhere to avoid
 307          * blocking in ctor or init.
 308          */
 309         pp->pp_label = NULL;
 310
 311         return (0);
 312 }
 313
 314 static int
 315 pipe_zone_init(void *mem, int size, int flags)
 316 {
 317         struct pipepair *pp;
 318
 319         KASSERT(size == sizeof(*pp), ("pipe_zone_init: wrong size"));
 320
 321         pp = (struct pipepair *)mem;
 322
 323         mtx_init(&pp->pp_mtx, "pipe mutex", NULL, MTX_DEF | MTX_NEW);
 324         return (0);
 325 }
 326
 327 static void
 328 pipe_zone_fini(void *mem, int size)
 329 {
 330         struct pipepair *pp;
 331
 332         KASSERT(size == sizeof(*pp), ("pipe_zone_fini: wrong size"));
 333
 334         pp = (struct pipepair *)mem;
 335
 336         mtx_destroy(&pp->pp_mtx);
 337 }
 338
 339 static void
 340 pipe_paircreate(struct thread *td, struct pipepair **p_pp)
 341 {
 342         struct pipepair *pp;
 343         struct pipe *rpipe, *wpipe;
 344
 345         *p_pp = pp = uma_zalloc(pipe_zone, M_WAITOK);
 346 #ifdef MAC
 347         /*
 348          * The MAC label is shared between the connected endpoints.  As a
 349          * result mac_pipe_init() and mac_pipe_create() are called once
 350          * for the pair, and not on the endpoints.
 351          */
 352         mac_pipe_init(pp);
 353         mac_pipe_create(td->td_ucred, pp);
 354 #endif
 355         rpipe = &pp->pp_rpipe;
 356         wpipe = &pp->pp_wpipe;
 357
 358         knlist_init_mtx(&rpipe->pipe_sel.si_note, PIPE_MTX(rpipe));
 359         knlist_init_mtx(&wpipe->pipe_sel.si_note, PIPE_MTX(wpipe));
 360
 361         /* Only the forward direction pipe is backed by default */
 362         pipe_create(rpipe, 1);
 363         pipe_create(wpipe, 0);
 364
 365         rpipe->pipe_state |= PIPE_DIRECTOK;
 366         wpipe->pipe_state |= PIPE_DIRECTOK;
 367 }
 368
 369 void
 370 pipe_named_ctor(struct pipe **ppipe, struct thread *td)
 371 {
 372         struct pipepair *pp;
 373
 374         pipe_paircreate(td, &pp);
 375         pp->pp_rpipe.pipe_state |= PIPE_NAMED;
 376         *ppipe = &pp->pp_rpipe;
 377 }
 378
 379 void
 380 pipe_dtor(struct pipe *dpipe)
 381 {
 382         struct pipe *peer;
 383         ino_t ino;
 384
 385         ino = dpipe->pipe_ino;
 386         peer = (dpipe->pipe_state & PIPE_NAMED) != 0 ? dpipe->pipe_peer : NULL;
 387         funsetown(&dpipe->pipe_sigio);
 388         pipeclose(dpipe);
 389         if (peer != NULL) {
 390                 funsetown(&peer->pipe_sigio);
 391                 pipeclose(peer);
 392         }
 393         if (ino != 0 && ino != (ino_t)-1)
 394                 free_unr(pipeino_unr, ino);
 395 }
 396
 397 /*
 398  * The pipe system call for the DTYPE_PIPE type of pipes.  If we fail, let
 399  * the zone pick up the pieces via pipeclose().
 400  */
 401 int
 402 kern_pipe(struct thread *td, int fildes[2], int flags, struct filecaps *fcaps1,
 403     struct filecaps *fcaps2)
 404 {
 405         struct file *rf, *wf;
 406         struct pipe *rpipe, *wpipe;
 407         struct pipepair *pp;
 408         int fd, fflags, error;
 409
 410         pipe_paircreate(td, &pp);
 411         rpipe = &pp->pp_rpipe;
 412         wpipe = &pp->pp_wpipe;
 413         error = falloc_caps(td, &rf, &fd, flags, fcaps1);
 414         if (error) {
 415                 pipeclose(rpipe);
 416                 pipeclose(wpipe);
 417                 return (error);
 418         }
 419         /* An extra reference on `rf' has been held for us by falloc_caps(). */
 420         fildes[0] = fd;
 421
 422         fflags = FREAD | FWRITE;
 423         if ((flags & O_NONBLOCK) != 0)
 424                 fflags |= FNONBLOCK;
 425
 426         /*
 427          * Warning: once we've gotten past allocation of the fd for the
 428          * read-side, we can only drop the read side via fdrop() in order
 429          * to avoid races against processes which manage to dup() the read
 430          * side while we are blocked trying to allocate the write side.
 431          */
 432         finit(rf, fflags, DTYPE_PIPE, rpipe, &pipeops);
 433         error = falloc_caps(td, &wf, &fd, flags, fcaps2);
 434         if (error) {
 435                 fdclose(td, rf, fildes[0]);
 436                 fdrop(rf, td);
 437                 /* rpipe has been closed by fdrop(). */
 438                 pipeclose(wpipe);
 439                 return (error);
 440         }
 441         /* An extra reference on `wf' has been held for us by falloc_caps(). */
 442         finit(wf, fflags, DTYPE_PIPE, wpipe, &pipeops);
 443         fdrop(wf, td);
 444         fildes[1] = fd;
 445         fdrop(rf, td);
 446
 447         return (0);
 448 }
 449
 450 #ifdef COMPAT_FREEBSD10
 451 /* ARGSUSED */
 452 int
 453 freebsd10_pipe(struct thread *td, struct freebsd10_pipe_args *uap __unused)
 454 {
 455         int error;
 456         int fildes[2];
 457
 458         error = kern_pipe(td, fildes, 0, NULL, NULL);
 459         if (error)
 460                 return (error);
 461
 462         td->td_retval[0] = fildes[0];
 463         td->td_retval[1] = fildes[1];
 464
 465         return (0);
 466 }
 467 #endif
 468
 469 int
 470 sys_pipe2(struct thread *td, struct pipe2_args *uap)
 471 {
 472         int error, fildes[2];
 473
 474         if (uap->flags & ~(O_CLOEXEC | O_NONBLOCK))
 475                 return (EINVAL);
 476         error = kern_pipe(td, fildes, uap->flags, NULL, NULL);
 477         if (error)
 478                 return (error);
 479         error = copyout(fildes, uap->fildes, 2 * sizeof(int));
 480         if (error) {
 481                 (void)kern_close(td, fildes[0]);
 482                 (void)kern_close(td, fildes[1]);
 483         }
 484         return (error);
 485 }
 486
 487 /*
 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.
 492  */
 493 static int
 494 pipespace_new(cpipe, size)
 495         struct pipe *cpipe;
 496         int size;
 497 {
 498         caddr_t buffer;
 499         int error, cnt, firstseg;
 500         static int curfail = 0;
 501         static struct timeval lastfail;
 502
 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"));
 506 retry:
 507         cnt = cpipe->pipe_buffer.cnt;
 508         if (cnt > size)
 509                 size = cnt;
 510
 511         size = round_page(size);
 512         buffer = (caddr_t) vm_map_min(pipe_map);
 513
 514         error = vm_map_find(pipe_map, NULL, 0, (vm_offset_t *)&buffer, size, 0,
 515             VMFS_ANY_SPACE, VM_PROT_RW, VM_PROT_RW, 0);
 516         if (error != KERN_SUCCESS) {
 517                 if ((cpipe->pipe_buffer.buffer == NULL) &&
 518                         (size > SMALL_PIPE_SIZE)) {
 519                         size = SMALL_PIPE_SIZE;
 520                         pipefragretry++;
 521                         goto retry;
 522                 }
 523                 if (cpipe->pipe_buffer.buffer == NULL) {
 524                         pipeallocfail++;
 525                         if (ppsratecheck(&lastfail, &curfail, 1))
 526                                 printf("kern.ipc.maxpipekva exceeded; see tuning(7)\n");
 527                 } else {
 528                         piperesizefail++;
 529                 }
 530                 return (ENOMEM);
 531         }
 532
 533         /* copy data, then free old resources if we're resizing */
 534         if (cnt > 0) {
 535                 if (cpipe->pipe_buffer.in <= cpipe->pipe_buffer.out) {
 536                         firstseg = cpipe->pipe_buffer.size - cpipe->pipe_buffer.out;
 537                         bcopy(&cpipe->pipe_buffer.buffer[cpipe->pipe_buffer.out],
 538                                 buffer, firstseg);
 539                         if ((cnt - firstseg) > 0)
 540                                 bcopy(cpipe->pipe_buffer.buffer, &buffer[firstseg],
 541                                         cpipe->pipe_buffer.in);
 542                 } else {
 543                         bcopy(&cpipe->pipe_buffer.buffer[cpipe->pipe_buffer.out],
 544                                 buffer, cnt);
 545                 }
 546         }
 547         pipe_free_kmem(cpipe);
 548         cpipe->pipe_buffer.buffer = buffer;
 549         cpipe->pipe_buffer.size = size;
 550         cpipe->pipe_buffer.in = cnt;
 551         cpipe->pipe_buffer.out = 0;
 552         cpipe->pipe_buffer.cnt = cnt;
 553         atomic_add_long(&amountpipekva, cpipe->pipe_buffer.size);
 554         return (0);
 555 }
 556
 557 /*
 558  * Wrapper for pipespace_new() that performs locking assertions.
 559  */
 560 static int
 561 pipespace(cpipe, size)
 562         struct pipe *cpipe;
 563         int size;
 564 {
 565
 566         KASSERT(cpipe->pipe_state & PIPE_LOCKFL,
 567                 ("Unlocked pipe passed to pipespace"));
 568         return (pipespace_new(cpipe, size));
 569 }
 570
 571 /*
 572  * lock a pipe for I/O, blocking other access
 573  */
 574 static __inline int
 575 pipelock(cpipe, catch)
 576         struct pipe *cpipe;
 577         int catch;
 578 {
 579         int error;
 580
 581         PIPE_LOCK_ASSERT(cpipe, MA_OWNED);
 582         while (cpipe->pipe_state & PIPE_LOCKFL) {
 583                 cpipe->pipe_state |= PIPE_LWANT;
 584                 error = msleep(cpipe, PIPE_MTX(cpipe),
 585                     catch ? (PRIBIO | PCATCH) : PRIBIO,
 586                     "pipelk", 0);
 587                 if (error != 0)
 588                         return (error);
 589         }
 590         cpipe->pipe_state |= PIPE_LOCKFL;
 591         return (0);
 592 }
 593
 594 /*
 595  * unlock a pipe I/O lock
 596  */
 597 static __inline void
 598 pipeunlock(cpipe)
 599         struct pipe *cpipe;
 600 {
 601
 602         PIPE_LOCK_ASSERT(cpipe, MA_OWNED);
 603         KASSERT(cpipe->pipe_state & PIPE_LOCKFL,
 604                 ("Unlocked pipe passed to pipeunlock"));
 605         cpipe->pipe_state &= ~PIPE_LOCKFL;
 606         if (cpipe->pipe_state & PIPE_LWANT) {
 607                 cpipe->pipe_state &= ~PIPE_LWANT;
 608                 wakeup(cpipe);
 609         }
 610 }
 611
 612 void
 613 pipeselwakeup(cpipe)
 614         struct pipe *cpipe;
 615 {
 616
 617         PIPE_LOCK_ASSERT(cpipe, MA_OWNED);
 618         if (cpipe->pipe_state & PIPE_SEL) {
 619                 selwakeuppri(&cpipe->pipe_sel, PSOCK);
 620                 if (!SEL_WAITING(&cpipe->pipe_sel))
 621                         cpipe->pipe_state &= ~PIPE_SEL;
 622         }
 623         if ((cpipe->pipe_state & PIPE_ASYNC) && cpipe->pipe_sigio)
 624                 pgsigio(&cpipe->pipe_sigio, SIGIO, 0);
 625         KNOTE_LOCKED(&cpipe->pipe_sel.si_note, 0);
 626 }
 627
 628 /*
 629  * Initialize and allocate VM and memory for pipe.  The structure
 630  * will start out zero'd from the ctor, so we just manage the kmem.
 631  */
 632 static void
 633 pipe_create(pipe, backing)
 634         struct pipe *pipe;
 635         int backing;
 636 {
 637
 638         if (backing) {
 639                 /*
 640                  * Note that these functions can fail if pipe map is exhausted
 641                  * (as a result of too many pipes created), but we ignore the
 642                  * error as it is not fatal and could be provoked by
 643                  * unprivileged users. The only consequence is worse performance
 644                  * with given pipe.
 645                  */
 646                 if (amountpipekva > maxpipekva / 2)
 647                         (void)pipespace_new(pipe, SMALL_PIPE_SIZE);
 648                 else
 649                         (void)pipespace_new(pipe, PIPE_SIZE);
 650         }
 651
 652         pipe->pipe_ino = -1;
 653 }
 654
 655 /* ARGSUSED */
 656 static int
 657 pipe_read(fp, uio, active_cred, flags, td)
 658         struct file *fp;
 659         struct uio *uio;
 660         struct ucred *active_cred;
 661         struct thread *td;
 662         int flags;
 663 {
 664         struct pipe *rpipe;
 665         int error;
 666         int nread = 0;
 667         int size;
 668
 669         rpipe = fp->f_data;
 670         PIPE_LOCK(rpipe);
 671         ++rpipe->pipe_busy;
 672         error = pipelock(rpipe, 1);
 673         if (error)
 674                 goto unlocked_error;
 675
 676 #ifdef MAC
 677         error = mac_pipe_check_read(active_cred, rpipe->pipe_pair);
 678         if (error)
 679                 goto locked_error;
 680 #endif
 681         if (amountpipekva > (3 * maxpipekva) / 4) {
 682                 if (!(rpipe->pipe_state & PIPE_DIRECTW) &&
 683                         (rpipe->pipe_buffer.size > SMALL_PIPE_SIZE) &&
 684                         (rpipe->pipe_buffer.cnt <= SMALL_PIPE_SIZE) &&
 685                         (piperesizeallowed == 1)) {
 686                         PIPE_UNLOCK(rpipe);
 687                         pipespace(rpipe, SMALL_PIPE_SIZE);
 688                         PIPE_LOCK(rpipe);
 689                 }
 690         }
 691
 692         while (uio->uio_resid) {
 693                 /*
 694                  * normal pipe buffer receive
 695                  */
 696                 if (rpipe->pipe_buffer.cnt > 0) {
 697                         size = rpipe->pipe_buffer.size - rpipe->pipe_buffer.out;
 698                         if (size > rpipe->pipe_buffer.cnt)
 699                                 size = rpipe->pipe_buffer.cnt;
 700                         if (size > uio->uio_resid)
 701                                 size = uio->uio_resid;
 702
 703                         PIPE_UNLOCK(rpipe);
 704                         error = uiomove(
 705                             &rpipe->pipe_buffer.buffer[rpipe->pipe_buffer.out],
 706                             size, uio);
 707                         PIPE_LOCK(rpipe);
 708                         if (error)
 709                                 break;
 710
 711                         rpipe->pipe_buffer.out += size;
 712                         if (rpipe->pipe_buffer.out >= rpipe->pipe_buffer.size)
 713                                 rpipe->pipe_buffer.out = 0;
 714
 715                         rpipe->pipe_buffer.cnt -= size;
 716
 717                         /*
 718                          * If there is no more to read in the pipe, reset
 719                          * its pointers to the beginning.  This improves
 720                          * cache hit stats.
 721                          */
 722                         if (rpipe->pipe_buffer.cnt == 0) {
 723                                 rpipe->pipe_buffer.in = 0;
 724                                 rpipe->pipe_buffer.out = 0;
 725                         }
 726                         nread += size;
 727 #ifndef PIPE_NODIRECT
 728                 /*
 729                  * Direct copy, bypassing a kernel buffer.
 730                  */
 731                 } else if ((size = rpipe->pipe_map.cnt) &&
 732                            (rpipe->pipe_state & PIPE_DIRECTW)) {
 733                         if (size > uio->uio_resid)
 734                                 size = (u_int) uio->uio_resid;
 735
 736                         PIPE_UNLOCK(rpipe);
 737                         error = uiomove_fromphys(rpipe->pipe_map.ms,
 738                             rpipe->pipe_map.pos, size, uio);
 739                         PIPE_LOCK(rpipe);
 740                         if (error)
 741                                 break;
 742                         nread += size;
 743                         rpipe->pipe_map.pos += size;
 744                         rpipe->pipe_map.cnt -= size;
 745                         if (rpipe->pipe_map.cnt == 0) {
 746                                 rpipe->pipe_state &= ~(PIPE_DIRECTW|PIPE_WANTW);
 747                                 wakeup(rpipe);
 748                         }
 749 #endif
 750                 } else {
 751                         /*
 752                          * detect EOF condition
 753                          * read returns 0 on EOF, no need to set error
 754                          */
 755                         if (rpipe->pipe_state & PIPE_EOF)
 756                                 break;
 757
 758                         /*
 759                          * If the "write-side" has been blocked, wake it up now.
 760                          */
 761                         if (rpipe->pipe_state & PIPE_WANTW) {
 762                                 rpipe->pipe_state &= ~PIPE_WANTW;
 763                                 wakeup(rpipe);
 764                         }
 765
 766                         /*
 767                          * Break if some data was read.
 768                          */
 769                         if (nread > 0)
 770                                 break;
 771
 772                         /*
 773                          * Unlock the pipe buffer for our remaining processing.
 774                          * We will either break out with an error or we will
 775                          * sleep and relock to loop.
 776                          */
 777                         pipeunlock(rpipe);
 778
 779                         /*
 780                          * Handle non-blocking mode operation or
 781                          * wait for more data.
 782                          */
 783                         if (fp->f_flag & FNONBLOCK) {
 784                                 error = EAGAIN;
 785                         } else {
 786                                 rpipe->pipe_state |= PIPE_WANTR;
 787                                 if ((error = msleep(rpipe, PIPE_MTX(rpipe),
 788                                     PRIBIO | PCATCH,
 789                                     "piperd", 0)) == 0)
 790                                         error = pipelock(rpipe, 1);
 791                         }
 792                         if (error)
 793                                 goto unlocked_error;
 794                 }
 795         }
 796 #ifdef MAC
 797 locked_error:
 798 #endif
 799         pipeunlock(rpipe);
 800
 801         /* XXX: should probably do this before getting any locks. */
 802         if (error == 0)
 803                 vfs_timestamp(&rpipe->pipe_atime);
 804 unlocked_error:
 805         --rpipe->pipe_busy;
 806
 807         /*
 808          * PIPE_WANT processing only makes sense if pipe_busy is 0.
 809          */
 810         if ((rpipe->pipe_busy == 0) && (rpipe->pipe_state & PIPE_WANT)) {
 811                 rpipe->pipe_state &= ~(PIPE_WANT|PIPE_WANTW);
 812                 wakeup(rpipe);
 813         } else if (rpipe->pipe_buffer.cnt < MINPIPESIZE) {
 814                 /*
 815                  * Handle write blocking hysteresis.
 816                  */
 817                 if (rpipe->pipe_state & PIPE_WANTW) {
 818                         rpipe->pipe_state &= ~PIPE_WANTW;
 819                         wakeup(rpipe);
 820                 }
 821         }
 822
 823         if ((rpipe->pipe_buffer.size - rpipe->pipe_buffer.cnt) >= PIPE_BUF)
 824                 pipeselwakeup(rpipe);
 825
 826         PIPE_UNLOCK(rpipe);
 827         return (error);
 828 }
 829
 830 #ifndef PIPE_NODIRECT
 831 /*
 832  * Map the sending processes' buffer into kernel space and wire it.
 833  * This is similar to a physical write operation.
 834  */
 835 static int
 836 pipe_build_write_buffer(wpipe, uio)
 837         struct pipe *wpipe;
 838         struct uio *uio;
 839 {
 840         u_int size;
 841         int i;
 842
 843         PIPE_LOCK_ASSERT(wpipe, MA_NOTOWNED);
 844         KASSERT(wpipe->pipe_state & PIPE_DIRECTW,
 845                 ("Clone attempt on non-direct write pipe!"));
 846
 847         if (uio->uio_iov->iov_len > wpipe->pipe_buffer.size)
 848                 size = wpipe->pipe_buffer.size;
 849         else
 850                 size = uio->uio_iov->iov_len;
 851
 852         if ((i = vm_fault_quick_hold_pages(&curproc->p_vmspace->vm_map,
 853             (vm_offset_t)uio->uio_iov->iov_base, size, VM_PROT_READ,
 854             wpipe->pipe_map.ms, PIPENPAGES)) < 0)
 855                 return (EFAULT);
 856
 857 /*
 858  * set up the control block
 859  */
 860         wpipe->pipe_map.npages = i;
 861         wpipe->pipe_map.pos =
 862             ((vm_offset_t) uio->uio_iov->iov_base) & PAGE_MASK;
 863         wpipe->pipe_map.cnt = size;
 864
 865 /*
 866  * and update the uio data
 867  */
 868
 869         uio->uio_iov->iov_len -= size;
 870         uio->uio_iov->iov_base = (char *)uio->uio_iov->iov_base + size;
 871         if (uio->uio_iov->iov_len == 0)
 872                 uio->uio_iov++;
 873         uio->uio_resid -= size;
 874         uio->uio_offset += size;
 875         return (0);
 876 }
 877
 878 /*
 879  * unmap and unwire the process buffer
 880  */
 881 static void
 882 pipe_destroy_write_buffer(wpipe)
 883         struct pipe *wpipe;
 884 {
 885
 886         PIPE_LOCK_ASSERT(wpipe, MA_OWNED);
 887         vm_page_unhold_pages(wpipe->pipe_map.ms, wpipe->pipe_map.npages);
 888         wpipe->pipe_map.npages = 0;
 889 }
 890
 891 /*
 892  * In the case of a signal, the writing process might go away.  This
 893  * code copies the data into the circular buffer so that the source
 894  * pages can be freed without loss of data.
 895  */
 896 static void
 897 pipe_clone_write_buffer(wpipe)
 898         struct pipe *wpipe;
 899 {
 900         struct uio uio;
 901         struct iovec iov;
 902         int size;
 903         int pos;
 904
 905         PIPE_LOCK_ASSERT(wpipe, MA_OWNED);
 906         size = wpipe->pipe_map.cnt;
 907         pos = wpipe->pipe_map.pos;
 908
 909         wpipe->pipe_buffer.in = size;
 910         wpipe->pipe_buffer.out = 0;
 911         wpipe->pipe_buffer.cnt = size;
 912         wpipe->pipe_state &= ~PIPE_DIRECTW;
 913
 914         PIPE_UNLOCK(wpipe);
 915         iov.iov_base = wpipe->pipe_buffer.buffer;
 916         iov.iov_len = size;
 917         uio.uio_iov = &iov;
 918         uio.uio_iovcnt = 1;
 919         uio.uio_offset = 0;
 920         uio.uio_resid = size;
 921         uio.uio_segflg = UIO_SYSSPACE;
 922         uio.uio_rw = UIO_READ;
 923         uio.uio_td = curthread;
 924         uiomove_fromphys(wpipe->pipe_map.ms, pos, size, &uio);
 925         PIPE_LOCK(wpipe);
 926         pipe_destroy_write_buffer(wpipe);
 927 }
 928
 929 /*
 930  * This implements the pipe buffer write mechanism.  Note that only
 931  * a direct write OR a normal pipe write can be pending at any given time.
 932  * If there are any characters in the pipe buffer, the direct write will
 933  * be deferred until the receiving process grabs all of the bytes from
 934  * the pipe buffer.  Then the direct mapping write is set-up.
 935  */
 936 static int
 937 pipe_direct_write(wpipe, uio)
 938         struct pipe *wpipe;
 939         struct uio *uio;
 940 {
 941         int error;
 942
 943 retry:
 944         PIPE_LOCK_ASSERT(wpipe, MA_OWNED);
 945         error = pipelock(wpipe, 1);
 946         if (error != 0)
 947                 goto error1;
 948         if ((wpipe->pipe_state & PIPE_EOF) != 0) {
 949                 error = EPIPE;
 950                 pipeunlock(wpipe);
 951                 goto error1;
 952         }
 953         while (wpipe->pipe_state & PIPE_DIRECTW) {
 954                 if (wpipe->pipe_state & PIPE_WANTR) {
 955                         wpipe->pipe_state &= ~PIPE_WANTR;
 956                         wakeup(wpipe);
 957                 }
 958                 pipeselwakeup(wpipe);
 959                 wpipe->pipe_state |= PIPE_WANTW;
 960                 pipeunlock(wpipe);
 961                 error = msleep(wpipe, PIPE_MTX(wpipe),
 962                     PRIBIO | PCATCH, "pipdww", 0);
 963                 if (error)
 964                         goto error1;
 965                 else
 966                         goto retry;
 967         }
 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;
 972                         wakeup(wpipe);
 973                 }
 974                 pipeselwakeup(wpipe);
 975                 wpipe->pipe_state |= PIPE_WANTW;
 976                 pipeunlock(wpipe);
 977                 error = msleep(wpipe, PIPE_MTX(wpipe),
 978                     PRIBIO | PCATCH, "pipdwc", 0);
 979                 if (error)
 980                         goto error1;
 981                 else
 982                         goto retry;
 983         }
 984
 985         wpipe->pipe_state |= PIPE_DIRECTW;
 986
 987         PIPE_UNLOCK(wpipe);
 988         error = pipe_build_write_buffer(wpipe, uio);
 989         PIPE_LOCK(wpipe);
 990         if (error) {
 991                 wpipe->pipe_state &= ~PIPE_DIRECTW;
 992                 pipeunlock(wpipe);
 993                 goto error1;
 994         }
 995
 996         error = 0;
 997         while (!error && (wpipe->pipe_state & PIPE_DIRECTW)) {
 998                 if (wpipe->pipe_state & PIPE_EOF) {
 999                         pipe_destroy_write_buffer(wpipe);
1000                         pipeselwakeup(wpipe);
1001                         pipeunlock(wpipe);
1002                         error = EPIPE;
1003                         goto error1;
1004                 }
1005                 if (wpipe->pipe_state & PIPE_WANTR) {
1006                         wpipe->pipe_state &= ~PIPE_WANTR;
1007                         wakeup(wpipe);
1008                 }
1009                 pipeselwakeup(wpipe);
1010                 wpipe->pipe_state |= PIPE_WANTW;
1011                 pipeunlock(wpipe);
1012                 error = msleep(wpipe, PIPE_MTX(wpipe), PRIBIO | PCATCH,
1013                     "pipdwt", 0);
1014                 pipelock(wpipe, 0);
1015         }
1016
1017         if (wpipe->pipe_state & PIPE_EOF)
1018                 error = EPIPE;
1019         if (wpipe->pipe_state & PIPE_DIRECTW) {
1020                 /*
1021                  * this bit of trickery substitutes a kernel buffer for
1022                  * the process that might be going away.
1023                  */
1024                 pipe_clone_write_buffer(wpipe);
1025         } else {
1026                 pipe_destroy_write_buffer(wpipe);
1027         }
1028         pipeunlock(wpipe);
1029         return (error);
1030
1031 error1:
1032         wakeup(wpipe);
1033         return (error);
1034 }
1035 #endif
1036
1037 static int
1038 pipe_write(fp, uio, active_cred, flags, td)
1039         struct file *fp;
1040         struct uio *uio;
1041         struct ucred *active_cred;
1042         struct thread *td;
1043         int flags;
1044 {
1045         int error = 0;
1046         int desiredsize;
1047         ssize_t orig_resid;
1048         struct pipe *wpipe, *rpipe;
1049
1050         rpipe = fp->f_data;
1051         wpipe = PIPE_PEER(rpipe);
1052         PIPE_LOCK(rpipe);
1053         error = pipelock(wpipe, 1);
1054         if (error) {
1055                 PIPE_UNLOCK(rpipe);
1056                 return (error);
1057         }
1058         /*
1059          * detect loss of pipe read side, issue SIGPIPE if lost.
1060          */
1061         if (wpipe->pipe_present != PIPE_ACTIVE ||
1062             (wpipe->pipe_state & PIPE_EOF)) {
1063                 pipeunlock(wpipe);
1064                 PIPE_UNLOCK(rpipe);
1065                 return (EPIPE);
1066         }
1067 #ifdef MAC
1068         error = mac_pipe_check_write(active_cred, wpipe->pipe_pair);
1069         if (error) {
1070                 pipeunlock(wpipe);
1071                 PIPE_UNLOCK(rpipe);
1072                 return (error);
1073         }
1074 #endif
1075         ++wpipe->pipe_busy;
1076
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)
1081                         break;
1082                 if (amountpipekva > maxpipekva / 2)
1083                         break;
1084                 if (desiredsize == BIG_PIPE_SIZE)
1085                         break;
1086                 desiredsize = desiredsize * 2;
1087         }
1088
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;
1095
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)) {
1099                 PIPE_UNLOCK(wpipe);
1100                 pipespace(wpipe, desiredsize);
1101                 PIPE_LOCK(wpipe);
1102         }
1103         if (wpipe->pipe_buffer.size == 0) {
1104                 /*
1105                  * This can only happen for reverse direction use of pipes
1106                  * in a complete OOM situation.
1107                  */
1108                 error = ENOMEM;
1109                 --wpipe->pipe_busy;
1110                 pipeunlock(wpipe);
1111                 PIPE_UNLOCK(wpipe);
1112                 return (error);
1113         }
1114
1115         pipeunlock(wpipe);
1116
1117         orig_resid = uio->uio_resid;
1118
1119         while (uio->uio_resid) {
1120                 int space;
1121
1122                 pipelock(wpipe, 0);
1123                 if (wpipe->pipe_state & PIPE_EOF) {
1124                         pipeunlock(wpipe);
1125                         error = EPIPE;
1126                         break;
1127                 }
1128 #ifndef PIPE_NODIRECT
1129                 /*
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.
1134                  *
1135                  * The direct write mechanism will detect the reader going
1136                  * away on us.
1137                  */
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) {
1142                         pipeunlock(wpipe);
1143                         error = pipe_direct_write(wpipe, uio);
1144                         if (error)
1145                                 break;
1146                         continue;
1147                 }
1148 #endif
1149
1150                 /*
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
1155                  * reader goes away.
1156                  */
1157                 if (wpipe->pipe_state & PIPE_DIRECTW) {
1158                         if (wpipe->pipe_state & PIPE_WANTR) {
1159                                 wpipe->pipe_state &= ~PIPE_WANTR;
1160                                 wakeup(wpipe);
1161                         }
1162                         pipeselwakeup(wpipe);
1163                         wpipe->pipe_state |= PIPE_WANTW;
1164                         pipeunlock(wpipe);
1165                         error = msleep(wpipe, PIPE_MTX(rpipe), PRIBIO | PCATCH,
1166                             "pipbww", 0);
1167                         if (error)
1168                                 break;
1169                         else
1170                                 continue;
1171                 }
1172
1173                 space = wpipe->pipe_buffer.size - wpipe->pipe_buffer.cnt;
1174
1175                 /* Writes of size <= PIPE_BUF must be atomic. */
1176                 if ((space < uio->uio_resid) && (orig_resid <= PIPE_BUF))
1177                         space = 0;
1178
1179                 if (space > 0) {
1180                         int size;       /* Transfer size */
1181                         int segsize;    /* first segment to transfer */
1182
1183                         /*
1184                          * Transfer size is minimum of uio transfer
1185                          * and free space in pipe buffer.
1186                          */
1187                         if (space > uio->uio_resid)
1188                                 size = uio->uio_resid;
1189                         else
1190                                 size = space;
1191                         /*
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.
1197                          */
1198                         segsize = wpipe->pipe_buffer.size -
1199                                 wpipe->pipe_buffer.in;
1200                         if (segsize > size)
1201                                 segsize = size;
1202
1203                         /* Transfer first segment */
1204
1205                         PIPE_UNLOCK(rpipe);
1206                         error = uiomove(&wpipe->pipe_buffer.buffer[wpipe->pipe_buffer.in],
1207                                         segsize, uio);
1208                         PIPE_LOCK(rpipe);
1209
1210                         if (error == 0 && segsize < size) {
1211                                 KASSERT(wpipe->pipe_buffer.in + segsize ==
1212                                         wpipe->pipe_buffer.size,
1213                                         ("Pipe buffer wraparound disappeared"));
1214                                 /*
1215                                  * Transfer remaining part now, to
1216                                  * support atomic writes.  Wraparound
1217                                  * happened.
1218                                  */
1219
1220                                 PIPE_UNLOCK(rpipe);
1221                                 error = uiomove(
1222                                     &wpipe->pipe_buffer.buffer[0],
1223                                     size - segsize, uio);
1224                                 PIPE_LOCK(rpipe);
1225                         }
1226                         if (error == 0) {
1227                                 wpipe->pipe_buffer.in += size;
1228                                 if (wpipe->pipe_buffer.in >=
1229                                     wpipe->pipe_buffer.size) {
1230                                         KASSERT(wpipe->pipe_buffer.in ==
1231                                                 size - segsize +
1232                                                 wpipe->pipe_buffer.size,
1233                                                 ("Expected wraparound bad"));
1234                                         wpipe->pipe_buffer.in = size - segsize;
1235                                 }
1236
1237                                 wpipe->pipe_buffer.cnt += size;
1238                                 KASSERT(wpipe->pipe_buffer.cnt <=
1239                                         wpipe->pipe_buffer.size,
1240                                         ("Pipe buffer overflow"));
1241                         }
1242                         pipeunlock(wpipe);
1243                         if (error != 0)
1244                                 break;
1245                 } else {
1246                         /*
1247                          * If the "read-side" has been blocked, wake it up now.
1248                          */
1249                         if (wpipe->pipe_state & PIPE_WANTR) {
1250                                 wpipe->pipe_state &= ~PIPE_WANTR;
1251                                 wakeup(wpipe);
1252                         }
1253
1254                         /*
1255                          * don't block on non-blocking I/O
1256                          */
1257                         if (fp->f_flag & FNONBLOCK) {
1258                                 error = EAGAIN;
1259                                 pipeunlock(wpipe);
1260                                 break;
1261                         }
1262
1263                         /*
1264                          * We have no more space and have something to offer,
1265                          * wake up select/poll.
1266                          */
1267                         pipeselwakeup(wpipe);
1268
1269                         wpipe->pipe_state |= PIPE_WANTW;
1270                         pipeunlock(wpipe);
1271                         error = msleep(wpipe, PIPE_MTX(rpipe),
1272                             PRIBIO | PCATCH, "pipewr", 0);
1273                         if (error != 0)
1274                                 break;
1275                 }
1276         }
1277
1278         pipelock(wpipe, 0);
1279         --wpipe->pipe_busy;
1280
1281         if ((wpipe->pipe_busy == 0) && (wpipe->pipe_state & PIPE_WANT)) {
1282                 wpipe->pipe_state &= ~(PIPE_WANT | PIPE_WANTR);
1283                 wakeup(wpipe);
1284         } else if (wpipe->pipe_buffer.cnt > 0) {
1285                 /*
1286                  * If we have put any characters in the buffer, we wake up
1287                  * the reader.
1288                  */
1289                 if (wpipe->pipe_state & PIPE_WANTR) {
1290                         wpipe->pipe_state &= ~PIPE_WANTR;
1291                         wakeup(wpipe);
1292                 }
1293         }
1294
1295         /*
1296          * Don't return EPIPE if any byte was written.
1297          * EINTR and other interrupts are handled by generic I/O layer.
1298          * Do not pretend that I/O succeeded for obvious user error
1299          * like EFAULT.
1300          */
1301         if (uio->uio_resid != orig_resid && error == EPIPE)
1302                 error = 0;
1303
1304         if (error == 0)
1305                 vfs_timestamp(&wpipe->pipe_mtime);
1306
1307         /*
1308          * We have something to offer,
1309          * wake up select/poll.
1310          */
1311         if (wpipe->pipe_buffer.cnt)
1312                 pipeselwakeup(wpipe);
1313
1314         pipeunlock(wpipe);
1315         PIPE_UNLOCK(rpipe);
1316         return (error);
1317 }
1318
1319 /* ARGSUSED */
1320 static int
1321 pipe_truncate(fp, length, active_cred, td)
1322         struct file *fp;
1323         off_t length;
1324         struct ucred *active_cred;
1325         struct thread *td;
1326 {
1327         struct pipe *cpipe;
1328         int error;
1329
1330         cpipe = fp->f_data;
1331         if (cpipe->pipe_state & PIPE_NAMED)
1332                 error = vnops.fo_truncate(fp, length, active_cred, td);
1333         else
1334                 error = invfo_truncate(fp, length, active_cred, td);
1335         return (error);
1336 }
1337
1338 /*
1339  * we implement a very minimal set of ioctls for compatibility with sockets.
1340  */
1341 static int
1342 pipe_ioctl(fp, cmd, data, active_cred, td)
1343         struct file *fp;
1344         u_long cmd;
1345         void *data;
1346         struct ucred *active_cred;
1347         struct thread *td;
1348 {
1349         struct pipe *mpipe = fp->f_data;
1350         int error;
1351
1352         PIPE_LOCK(mpipe);
1353
1354 #ifdef MAC
1355         error = mac_pipe_check_ioctl(active_cred, mpipe->pipe_pair, cmd, data);
1356         if (error) {
1357                 PIPE_UNLOCK(mpipe);
1358                 return (error);
1359         }
1360 #endif
1361
1362         error = 0;
1363         switch (cmd) {
1364
1365         case FIONBIO:
1366                 break;
1367
1368         case FIOASYNC:
1369                 if (*(int *)data) {
1370                         mpipe->pipe_state |= PIPE_ASYNC;
1371                 } else {
1372                         mpipe->pipe_state &= ~PIPE_ASYNC;
1373                 }
1374                 break;
1375
1376         case FIONREAD:
1377                 if (!(fp->f_flag & FREAD)) {
1378                         *(int *)data = 0;
1379                         PIPE_UNLOCK(mpipe);
1380                         return (0);
1381                 }
1382                 if (mpipe->pipe_state & PIPE_DIRECTW)
1383                         *(int *)data = mpipe->pipe_map.cnt;
1384                 else
1385                         *(int *)data = mpipe->pipe_buffer.cnt;
1386                 break;
1387
1388         case FIOSETOWN:
1389                 PIPE_UNLOCK(mpipe);
1390                 error = fsetown(*(int *)data, &mpipe->pipe_sigio);
1391                 goto out_unlocked;
1392
1393         case FIOGETOWN:
1394                 *(int *)data = fgetown(&mpipe->pipe_sigio);
1395                 break;
1396
1397         /* This is deprecated, FIOSETOWN should be used instead. */
1398         case TIOCSPGRP:
1399                 PIPE_UNLOCK(mpipe);
1400                 error = fsetown(-(*(int *)data), &mpipe->pipe_sigio);
1401                 goto out_unlocked;
1402
1403         /* This is deprecated, FIOGETOWN should be used instead. */
1404         case TIOCGPGRP:
1405                 *(int *)data = -fgetown(&mpipe->pipe_sigio);
1406                 break;
1407
1408         default:
1409                 error = ENOTTY;
1410                 break;
1411         }
1412         PIPE_UNLOCK(mpipe);
1413 out_unlocked:
1414         return (error);
1415 }
1416
1417 static int
1418 pipe_poll(fp, events, active_cred, td)
1419         struct file *fp;
1420         int events;
1421         struct ucred *active_cred;
1422         struct thread *td;
1423 {
1424         struct pipe *rpipe;
1425         struct pipe *wpipe;
1426         int levents, revents;
1427 #ifdef MAC
1428         int error;
1429 #endif
1430
1431         revents = 0;
1432         rpipe = fp->f_data;
1433         wpipe = PIPE_PEER(rpipe);
1434         PIPE_LOCK(rpipe);
1435 #ifdef MAC
1436         error = mac_pipe_check_poll(active_cred, rpipe->pipe_pair);
1437         if (error)
1438                 goto locked_error;
1439 #endif
1440         if (fp->f_flag & FREAD && events & (POLLIN | POLLRDNORM))
1441                 if ((rpipe->pipe_state & PIPE_DIRECTW) ||
1442                     (rpipe->pipe_buffer.cnt > 0))
1443                         revents |= events & (POLLIN | POLLRDNORM);
1444
1445         if (fp->f_flag & FWRITE && events & (POLLOUT | POLLWRNORM))
1446                 if (wpipe->pipe_present != PIPE_ACTIVE ||
1447                     (wpipe->pipe_state & PIPE_EOF) ||
1448                     (((wpipe->pipe_state & PIPE_DIRECTW) == 0) &&
1449                      ((wpipe->pipe_buffer.size - wpipe->pipe_buffer.cnt) >= PIPE_BUF ||
1450                          wpipe->pipe_buffer.size == 0)))
1451                         revents |= events & (POLLOUT | POLLWRNORM);
1452
1453         levents = events &
1454             (POLLIN | POLLINIGNEOF | POLLPRI | POLLRDNORM | POLLRDBAND);
1455         if (rpipe->pipe_state & PIPE_NAMED && fp->f_flag & FREAD && levents &&
1456             fp->f_seqcount == rpipe->pipe_wgen)
1457                 events |= POLLINIGNEOF;
1458
1459         if ((events & POLLINIGNEOF) == 0) {
1460                 if (rpipe->pipe_state & PIPE_EOF) {
1461                         revents |= (events & (POLLIN | POLLRDNORM));
1462                         if (wpipe->pipe_present != PIPE_ACTIVE ||
1463                             (wpipe->pipe_state & PIPE_EOF))
1464                                 revents |= POLLHUP;
1465                 }
1466         }
1467
1468         if (revents == 0) {
1469                 if (fp->f_flag & FREAD && events & (POLLIN | POLLRDNORM)) {
1470                         selrecord(td, &rpipe->pipe_sel);
1471                         if (SEL_WAITING(&rpipe->pipe_sel))
1472                                 rpipe->pipe_state |= PIPE_SEL;
1473                 }
1474
1475                 if (fp->f_flag & FWRITE && events & (POLLOUT | POLLWRNORM)) {
1476                         selrecord(td, &wpipe->pipe_sel);
1477                         if (SEL_WAITING(&wpipe->pipe_sel))
1478                                 wpipe->pipe_state |= PIPE_SEL;
1479                 }
1480         }
1481 #ifdef MAC
1482 locked_error:
1483 #endif
1484         PIPE_UNLOCK(rpipe);
1485
1486         return (revents);
1487 }
1488
1489 /*
1490  * We shouldn't need locks here as we're doing a read and this should
1491  * be a natural race.
1492  */
1493 static int
1494 pipe_stat(fp, ub, active_cred, td)
1495         struct file *fp;
1496         struct stat *ub;
1497         struct ucred *active_cred;
1498         struct thread *td;
1499 {
1500         struct pipe *pipe;
1501         int new_unr;
1502 #ifdef MAC
1503         int error;
1504 #endif
1505
1506         pipe = fp->f_data;
1507         PIPE_LOCK(pipe);
1508 #ifdef MAC
1509         error = mac_pipe_check_stat(active_cred, pipe->pipe_pair);
1510         if (error) {
1511                 PIPE_UNLOCK(pipe);
1512                 return (error);
1513         }
1514 #endif
1515
1516         /* For named pipes ask the underlying filesystem. */
1517         if (pipe->pipe_state & PIPE_NAMED) {
1518                 PIPE_UNLOCK(pipe);
1519                 return (vnops.fo_stat(fp, ub, active_cred, td));
1520         }
1521
1522         /*
1523          * Lazily allocate an inode number for the pipe.  Most pipe
1524          * users do not call fstat(2) on the pipe, which means that
1525          * postponing the inode allocation until it is must be
1526          * returned to userland is useful.  If alloc_unr failed,
1527          * assign st_ino zero instead of returning an error.
1528          * Special pipe_ino values:
1529          *  -1 - not yet initialized;
1530          *  0  - alloc_unr failed, return 0 as st_ino forever.
1531          */
1532         if (pipe->pipe_ino == (ino_t)-1) {
1533                 new_unr = alloc_unr(pipeino_unr);
1534                 if (new_unr != -1)
1535                         pipe->pipe_ino = new_unr;
1536                 else
1537                         pipe->pipe_ino = 0;
1538         }
1539         PIPE_UNLOCK(pipe);
1540
1541         bzero(ub, sizeof(*ub));
1542         ub->st_mode = S_IFIFO;
1543         ub->st_blksize = PAGE_SIZE;
1544         if (pipe->pipe_state & PIPE_DIRECTW)
1545                 ub->st_size = pipe->pipe_map.cnt;
1546         else
1547                 ub->st_size = pipe->pipe_buffer.cnt;
1548         ub->st_blocks = howmany(ub->st_size, ub->st_blksize);
1549         ub->st_atim = pipe->pipe_atime;
1550         ub->st_mtim = pipe->pipe_mtime;
1551         ub->st_ctim = pipe->pipe_ctime;
1552         ub->st_uid = fp->f_cred->cr_uid;
1553         ub->st_gid = fp->f_cred->cr_gid;
1554         ub->st_dev = pipedev_ino;
1555         ub->st_ino = pipe->pipe_ino;
1556         /*
1557          * Left as 0: st_nlink, st_rdev, st_flags, st_gen.
1558          */
1559         return (0);
1560 }
1561
1562 /* ARGSUSED */
1563 static int
1564 pipe_close(fp, td)
1565         struct file *fp;
1566         struct thread *td;
1567 {
1568
1569         if (fp->f_vnode != NULL)
1570                 return vnops.fo_close(fp, td);
1571         fp->f_ops = &badfileops;
1572         pipe_dtor(fp->f_data);
1573         fp->f_data = NULL;
1574         return (0);
1575 }
1576
1577 static int
1578 pipe_chmod(struct file *fp, mode_t mode, struct ucred *active_cred, struct thread *td)
1579 {
1580         struct pipe *cpipe;
1581         int error;
1582
1583         cpipe = fp->f_data;
1584         if (cpipe->pipe_state & PIPE_NAMED)
1585                 error = vn_chmod(fp, mode, active_cred, td);
1586         else
1587                 error = invfo_chmod(fp, mode, active_cred, td);
1588         return (error);
1589 }
1590
1591 static int
1592 pipe_chown(fp, uid, gid, active_cred, td)
1593         struct file *fp;
1594         uid_t uid;
1595         gid_t gid;
1596         struct ucred *active_cred;
1597         struct thread *td;
1598 {
1599         struct pipe *cpipe;
1600         int error;
1601
1602         cpipe = fp->f_data;
1603         if (cpipe->pipe_state & PIPE_NAMED)
1604                 error = vn_chown(fp, uid, gid, active_cred, td);
1605         else
1606                 error = invfo_chown(fp, uid, gid, active_cred, td);
1607         return (error);
1608 }
1609
1610 static int
1611 pipe_fill_kinfo(struct file *fp, struct kinfo_file *kif, struct filedesc *fdp)
1612 {
1613         struct pipe *pi;
1614
1615         if (fp->f_type == DTYPE_FIFO)
1616                 return (vn_fill_kinfo(fp, kif, fdp));
1617         kif->kf_type = KF_TYPE_PIPE;
1618         pi = fp->f_data;
1619         kif->kf_un.kf_pipe.kf_pipe_addr = (uintptr_t)pi;
1620         kif->kf_un.kf_pipe.kf_pipe_peer = (uintptr_t)pi->pipe_peer;
1621         kif->kf_un.kf_pipe.kf_pipe_buffer_cnt = pi->pipe_buffer.cnt;
1622         return (0);
1623 }
1624
1625 static void
1626 pipe_free_kmem(cpipe)
1627         struct pipe *cpipe;
1628 {
1629
1630         KASSERT(!mtx_owned(PIPE_MTX(cpipe)),
1631             ("pipe_free_kmem: pipe mutex locked"));
1632
1633         if (cpipe->pipe_buffer.buffer != NULL) {
1634                 atomic_subtract_long(&amountpipekva, cpipe->pipe_buffer.size);
1635                 vm_map_remove(pipe_map,
1636                     (vm_offset_t)cpipe->pipe_buffer.buffer,
1637                     (vm_offset_t)cpipe->pipe_buffer.buffer + cpipe->pipe_buffer.size);
1638                 cpipe->pipe_buffer.buffer = NULL;
1639         }
1640 #ifndef PIPE_NODIRECT
1641         {
1642                 cpipe->pipe_map.cnt = 0;
1643                 cpipe->pipe_map.pos = 0;
1644                 cpipe->pipe_map.npages = 0;
1645         }
1646 #endif
1647 }
1648
1649 /*
1650  * shutdown the pipe
1651  */
1652 static void
1653 pipeclose(cpipe)
1654         struct pipe *cpipe;
1655 {
1656         struct pipepair *pp;
1657         struct pipe *ppipe;
1658
1659         KASSERT(cpipe != NULL, ("pipeclose: cpipe == NULL"));
1660
1661         PIPE_LOCK(cpipe);
1662         pipelock(cpipe, 0);
1663         pp = cpipe->pipe_pair;
1664
1665         pipeselwakeup(cpipe);
1666
1667         /*
1668          * If the other side is blocked, wake it up saying that
1669          * we want to close it down.
1670          */
1671         cpipe->pipe_state |= PIPE_EOF;
1672         while (cpipe->pipe_busy) {
1673                 wakeup(cpipe);
1674                 cpipe->pipe_state |= PIPE_WANT;
1675                 pipeunlock(cpipe);
1676                 msleep(cpipe, PIPE_MTX(cpipe), PRIBIO, "pipecl", 0);
1677                 pipelock(cpipe, 0);
1678         }
1679
1680
1681         /*
1682          * Disconnect from peer, if any.
1683          */
1684         ppipe = cpipe->pipe_peer;
1685         if (ppipe->pipe_present == PIPE_ACTIVE) {
1686                 pipeselwakeup(ppipe);
1687
1688                 ppipe->pipe_state |= PIPE_EOF;
1689                 wakeup(ppipe);
1690                 KNOTE_LOCKED(&ppipe->pipe_sel.si_note, 0);
1691         }
1692
1693         /*
1694          * Mark this endpoint as free.  Release kmem resources.  We
1695          * don't mark this endpoint as unused until we've finished
1696          * doing that, or the pipe might disappear out from under
1697          * us.
1698          */
1699         PIPE_UNLOCK(cpipe);
1700         pipe_free_kmem(cpipe);
1701         PIPE_LOCK(cpipe);
1702         cpipe->pipe_present = PIPE_CLOSING;
1703         pipeunlock(cpipe);
1704
1705         /*
1706          * knlist_clear() may sleep dropping the PIPE_MTX. Set the
1707          * PIPE_FINALIZED, that allows other end to free the
1708          * pipe_pair, only after the knotes are completely dismantled.
1709          */
1710         knlist_clear(&cpipe->pipe_sel.si_note, 1);
1711         cpipe->pipe_present = PIPE_FINALIZED;
1712         seldrain(&cpipe->pipe_sel);
1713         knlist_destroy(&cpipe->pipe_sel.si_note);
1714
1715         /*
1716          * If both endpoints are now closed, release the memory for the
1717          * pipe pair.  If not, unlock.
1718          */
1719         if (ppipe->pipe_present == PIPE_FINALIZED) {
1720                 PIPE_UNLOCK(cpipe);
1721 #ifdef MAC
1722                 mac_pipe_destroy(pp);
1723 #endif
1724                 uma_zfree(pipe_zone, cpipe->pipe_pair);
1725         } else
1726                 PIPE_UNLOCK(cpipe);
1727 }
1728
1729 /*ARGSUSED*/
1730 static int
1731 pipe_kqfilter(struct file *fp, struct knote *kn)
1732 {
1733         struct pipe *cpipe;
1734
1735         /*
1736          * If a filter is requested that is not supported by this file
1737          * descriptor, don't return an error, but also don't ever generate an
1738          * event.
1739          */
1740         if ((kn->kn_filter == EVFILT_READ) && !(fp->f_flag & FREAD)) {
1741                 kn->kn_fop = &pipe_nfiltops;
1742                 return (0);
1743         }
1744         if ((kn->kn_filter == EVFILT_WRITE) && !(fp->f_flag & FWRITE)) {
1745                 kn->kn_fop = &pipe_nfiltops;
1746                 return (0);
1747         }
1748         cpipe = fp->f_data;
1749         PIPE_LOCK(cpipe);
1750         switch (kn->kn_filter) {
1751         case EVFILT_READ:
1752                 kn->kn_fop = &pipe_rfiltops;
1753                 break;
1754         case EVFILT_WRITE:
1755                 kn->kn_fop = &pipe_wfiltops;
1756                 if (cpipe->pipe_peer->pipe_present != PIPE_ACTIVE) {
1757                         /* other end of pipe has been closed */
1758                         PIPE_UNLOCK(cpipe);
1759                         return (EPIPE);
1760                 }
1761                 cpipe = PIPE_PEER(cpipe);
1762                 break;
1763         default:
1764                 PIPE_UNLOCK(cpipe);
1765                 return (EINVAL);
1766         }
1767
1768         kn->kn_hook = cpipe;
1769         knlist_add(&cpipe->pipe_sel.si_note, kn, 1);
1770         PIPE_UNLOCK(cpipe);
1771         return (0);
1772 }
1773
1774 static void
1775 filt_pipedetach(struct knote *kn)
1776 {
1777         struct pipe *cpipe = kn->kn_hook;
1778
1779         PIPE_LOCK(cpipe);
1780         knlist_remove(&cpipe->pipe_sel.si_note, kn, 1);
1781         PIPE_UNLOCK(cpipe);
1782 }
1783
1784 /*ARGSUSED*/
1785 static int
1786 filt_piperead(struct knote *kn, long hint)
1787 {
1788         struct pipe *rpipe = kn->kn_hook;
1789         struct pipe *wpipe = rpipe->pipe_peer;
1790         int ret;
1791
1792         PIPE_LOCK_ASSERT(rpipe, MA_OWNED);
1793         kn->kn_data = rpipe->pipe_buffer.cnt;
1794         if ((kn->kn_data == 0) && (rpipe->pipe_state & PIPE_DIRECTW))
1795                 kn->kn_data = rpipe->pipe_map.cnt;
1796
1797         if ((rpipe->pipe_state & PIPE_EOF) ||
1798             wpipe->pipe_present != PIPE_ACTIVE ||
1799             (wpipe->pipe_state & PIPE_EOF)) {
1800                 kn->kn_flags |= EV_EOF;
1801                 return (1);
1802         }
1803         ret = kn->kn_data > 0;
1804         return ret;
1805 }
1806
1807 /*ARGSUSED*/
1808 static int
1809 filt_pipewrite(struct knote *kn, long hint)
1810 {
1811         struct pipe *wpipe;
1812
1813         /*
1814          * If this end of the pipe is closed, the knote was removed from the
1815          * knlist and the list lock (i.e., the pipe lock) is therefore not held.
1816          */
1817         wpipe = kn->kn_hook;
1818         if (wpipe->pipe_present != PIPE_ACTIVE ||
1819             (wpipe->pipe_state & PIPE_EOF)) {
1820                 kn->kn_data = 0;
1821                 kn->kn_flags |= EV_EOF;
1822                 return (1);
1823         }
1824         PIPE_LOCK_ASSERT(wpipe, MA_OWNED);
1825         kn->kn_data = (wpipe->pipe_buffer.size > 0) ?
1826             (wpipe->pipe_buffer.size - wpipe->pipe_buffer.cnt) : PIPE_BUF;
1827         if (wpipe->pipe_state & PIPE_DIRECTW)
1828                 kn->kn_data = 0;
1829
1830         return (kn->kn_data >= PIPE_BUF);
1831 }
1832
1833 static void
1834 filt_pipedetach_notsup(struct knote *kn)
1835 {
1836
1837 }
1838
1839 static int
1840 filt_pipenotsup(struct knote *kn, long hint)
1841 {
1842
1843         return (0);
1844 }