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