bsd/sys/pipe.h

   1 /*
   2  * Copyright (c) 2004-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * Copyright (c) 1996 John S. Dyson
  30  * All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice immediately at the beginning of the file, without modification,
  37  *    this list of conditions, and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. Absolutely no warranty of function or purpose is made by the author
  42  *    John S. Dyson.
  43  * 4. This work was done expressly for inclusion into FreeBSD.  Other use
  44  *    is allowed if this notation is included.
  45  * 5. Modifications may be freely made to this file if the above conditions
  46  *    are met.
  47  *
  48  * $FreeBSD: src/sys/sys/pipe.h,v 1.24 2003/08/13 20:01:38 alc Exp $
  49  */
  50 /*
  51  * NOTICE: This file was modified by SPARTA, Inc. in 2006 to introduce
  52  * support for mandatory and extensible security protections.  This notice
  53  * is included in support of clause 2.2 (b) of the Apple Public License,
  54  * Version 2.0.
  55  */
  56
  57 #ifndef _SYS_PIPE_H_
  58 #define _SYS_PIPE_H_
  59
  60 #ifdef  KERNEL
  61 #include <libkern/locks.h>
  62 #endif
  63 #include <sys/queue.h>                  /* for TAILQ macros */
  64 #include <sys/ev.h>
  65 #include <sys/cdefs.h>
  66 #include <sys/_types/_caddr_t.h>
  67 #include <sys/_types/_u_int.h>
  68
  69 /*
  70  * Pipe buffer size, keep moderate in value, pipes take kva space.
  71  */
  72 #ifndef PIPE_SIZE
  73 #define PIPE_SIZE       16384
  74 #endif
  75
  76 #define PIPE_KVAMAX     (1024 * 1024 * 16)
  77
  78 #ifndef BIG_PIPE_SIZE
  79 #define BIG_PIPE_SIZE   (64*1024)
  80 #endif
  81
  82 #ifndef SMALL_PIPE_SIZE
  83 #define SMALL_PIPE_SIZE PAGE_SIZE
  84 #endif
  85
  86 /*
  87  * PIPE_MINDIRECT MUST be smaller than PIPE_SIZE and MUST be bigger
  88  * than PIPE_BUF.
  89  */
  90 #ifndef PIPE_MINDIRECT
  91 #define PIPE_MINDIRECT  8192
  92 #endif
  93
  94 #define PIPENPAGES      (BIG_PIPE_SIZE / PAGE_SIZE + 1)
  95
  96 /*
  97  * Pipe buffer information.
  98  * Separate in, out, cnt are used to simplify calculations.
  99  * Buffered write is active when the buffer.cnt field is set.
 100  */
 101 struct pipebuf {
 102         u_int   cnt;            /* number of chars currently in buffer */
 103         u_int   in;             /* in pointer */
 104         u_int   out;            /* out pointer */
 105         u_int   size;           /* size of buffer */
 106         caddr_t buffer;         /* kva of buffer */
 107 };
 108
 109
 110 #ifdef PIPE_DIRECT
 111 /*
 112  * Information to support direct transfers between processes for pipes.
 113  */
 114 struct pipemapping {
 115         vm_offset_t     kva;            /* kernel virtual address */
 116         vm_size_t       cnt;            /* number of chars in buffer */
 117         vm_size_t       pos;            /* current position of transfer */
 118         int             npages;         /* number of pages */
 119         vm_page_t       ms[PIPENPAGES]; /* pages in source process */
 120 };
 121 #endif
 122
 123 /*
 124  * Bits in pipe_state.
 125  */
 126 #define PIPE_ASYNC      0x004   /* Async? I/O. */
 127 #define PIPE_WANTR      0x008   /* Reader wants some characters. */
 128 #define PIPE_WANTW      0x010   /* Writer wants space to put characters. */
 129 #define PIPE_WANT       0x020   /* Pipe is wanted to be run-down. */
 130 #define PIPE_SEL        0x040   /* Pipe has a select active. */
 131 #define PIPE_EOF        0x080   /* Pipe is in EOF condition. */
 132 #define PIPE_LOCKFL     0x100   /* Process has exclusive access to pointers/data. */
 133 #define PIPE_LWANT      0x200   /* Process wants exclusive access to pointers/data. */
 134 #define PIPE_DIRECTW    0x400   /* Pipe direct write active. */
 135 #define PIPE_DIRECTOK   0x800   /* Direct mode ok. */
 136 #define PIPE_KNOTE      0x1000   /* Pipe has kernel events activated */
 137 #define PIPE_DRAIN      0x2000  /* Waiting for I/O to drop for a close.  Treated like EOF;
 138                                         only separate for easier debugging. */
 139 #define PIPE_WSELECT    0x4000  /* Some thread has done an FWRITE select on the pipe */
 140 #define PIPE_DEAD       0x8000  /* Pipe is dead and needs garbage collection */
 141
 142 #ifdef  KERNEL
 143
 144 struct label;
 145
 146 /*
 147  * Per-pipe data structure.
 148  * Two of these are linked together to produce bi-directional pipes.
 149  */
 150 struct pipe {
 151         struct  pipebuf pipe_buffer;    /* data storage */
 152 #ifdef PIPE_DIRECT
 153         struct  pipemapping pipe_map;   /* pipe mapping for direct I/O */
 154 #endif
 155         struct  selinfo pipe_sel;       /* for compat with select */
 156         pid_t   pipe_pgid;              /* information for async I/O */
 157         struct  pipe *pipe_peer;        /* link with other direction */
 158         u_int   pipe_state;             /* pipe status info */
 159         int     pipe_busy;              /* busy flag, mostly to handle rundown sanely */
 160         TAILQ_HEAD(,eventqelt) pipe_evlist;
 161         lck_mtx_t *pipe_mtxp;           /* shared mutex between both pipes */
 162         struct  timespec st_atimespec;  /* time of last access */
 163         struct  timespec st_mtimespec;  /* time of last data modification */
 164         struct  timespec st_ctimespec;  /* time of last status change */
 165         struct  label *pipe_label;      /* pipe MAC label - shared */
 166 };
 167
 168 #define PIPE_MTX(pipe)          ((pipe)->pipe_mtxp)
 169
 170 #define PIPE_LOCK(pipe)         lck_mtx_lock(PIPE_MTX(pipe))
 171 #define PIPE_UNLOCK(pipe)       lck_mtx_unlock(PIPE_MTX(pipe))
 172 #define PIPE_LOCK_ASSERT(pipe, type)  LCK_MTX_ASSERT(PIPE_MTX(pipe), (type))
 173
 174 __BEGIN_DECLS
 175 void pipeinit(void);
 176 extern int pipe_stat(struct pipe *, void *, int);
 177 __END_DECLS
 178
 179 #endif  /* KERNEL */
 180
 181 #endif /* !_SYS_PIPE_H_ */