bsd/sys/select.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*
  31  * Copyright (c) 1992, 1993
  32  *      The Regents of the University of California.  All rights reserved.
  33  *
  34  * Redistribution and use in source and binary forms, with or without
  35  * modification, are permitted provided that the following conditions
  36  * are met:
  37  * 1. Redistributions of source code must retain the above copyright
  38  *    notice, this list of conditions and the following disclaimer.
  39  * 2. Redistributions in binary form must reproduce the above copyright
  40  *    notice, this list of conditions and the following disclaimer in the
  41  *    documentation and/or other materials provided with the distribution.
  42  * 3. All advertising materials mentioning features or use of this software
  43  *    must display the following acknowledgement:
  44  *      This product includes software developed by the University of
  45  *      California, Berkeley and its contributors.
  46  * 4. Neither the name of the University nor the names of its contributors
  47  *    may be used to endorse or promote products derived from this software
  48  *    without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  53  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  60  * SUCH DAMAGE.
  61  *
  62  *      @(#)select.h    8.2 (Berkeley) 1/4/94
  63  */
  64
  65 #ifndef _SYS_SELECT_H_
  66 #define _SYS_SELECT_H_
  67
  68 #include <sys/appleapiopts.h>
  69 #include <sys/cdefs.h>
  70 #include <sys/_types.h>
  71
  72 /*
  73  * The time_t and suseconds_t types shall be defined as described in
  74  * <sys/types.h>
  75  * The sigset_t type shall be defined as described in <signal.h>
  76  * The timespec structure shall be defined as described in <time.h>
  77  */
  78 #ifndef _TIME_T
  79 #define _TIME_T
  80 typedef __darwin_time_t         time_t;
  81 #endif
  82
  83 #ifndef _SUSECONDS_T
  84 #define _SUSECONDS_T
  85 typedef __darwin_suseconds_t    suseconds_t;
  86 #endif
  87
  88 #ifndef _SIGSET_T
  89 #define _SIGSET_T
  90 typedef __darwin_sigset_t       sigset_t;
  91 #endif
  92
  93 #ifndef _TIMESPEC
  94 #define _TIMESPEC
  95 struct timespec {
  96         time_t  tv_sec;
  97         long    tv_nsec;
  98 };
  99 #endif
 100
 101 /*
 102  * [XSI] The <sys/select.h> header shall define the fd_set type as a structure.
 103  * [XSI] FD_CLR, FD_ISSET, FD_SET, FD_ZERO may be declared as a function, or
 104  *       defined as a macro, or both
 105  * [XSI] FD_SETSIZE shall be defined as a macro
 106  *
 107  * Note:        We use _FD_SET to protect all select related
 108  *              types and macros
 109  */
 110 #ifndef _FD_SET
 111 #define _FD_SET
 112
 113 /*
 114  * Select uses bit masks of file descriptors in longs.  These macros
 115  * manipulate such bit fields (the filesystem macros use chars).  The
 116  * extra protection here is to permit application redefinition above
 117  * the default size.
 118  */
 119 #ifndef FD_SETSIZE
 120 #define FD_SETSIZE      1024
 121 #endif
 122
 123 #define __DARWIN_NBBY   8                               /* bits in a byte */
 124 #define __DARWIN_NFDBITS        (sizeof(__int32_t) * __DARWIN_NBBY) /* bits per mask */
 125 #define __DARWIN_howmany(x, y) (((x) + ((y) - 1)) / (y))        /* # y's == x bits? */
 126
 127 typedef struct fd_set {
 128         __int32_t       fds_bits[__DARWIN_howmany(FD_SETSIZE, __DARWIN_NFDBITS)];
 129 } fd_set;
 130
 131 #define FD_SET(n, p)    ((p)->fds_bits[(n)/__DARWIN_NFDBITS] |= (1<<((n) % __DARWIN_NFDBITS)))
 132 #define FD_CLR(n, p)    ((p)->fds_bits[(n)/__DARWIN_NFDBITS] &= ~(1<<((n) % __DARWIN_NFDBITS)))
 133 #define FD_ISSET(n, p)  ((p)->fds_bits[(n)/__DARWIN_NFDBITS] & (1<<((n) % __DARWIN_NFDBITS)))
 134 #if __GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ >= 3
 135 /*
 136  * Use the built-in bzero function instead of the library version so that
 137  * we do not pollute the namespace or introduce prototype warnings.
 138  */
 139 #define FD_ZERO(p)      __builtin_bzero(p, sizeof(*(p)))
 140 #else
 141 #define FD_ZERO(p)      bzero(p, sizeof(*(p)))
 142 #endif
 143 #ifndef _POSIX_C_SOURCE
 144 #define FD_COPY(f, t)   bcopy(f, t, sizeof(*(f)))
 145 #endif  /* !_POSIX_C_SOURCE */
 146
 147 #endif  /* !_FD_SET */
 148
 149 #ifdef KERNEL
 150 #ifdef KERNEL_PRIVATE
 151 #include <kern/wait_queue.h>
 152 #endif
 153 #include <sys/kernel_types.h>
 154
 155 #include <sys/event.h>
 156
 157 /*
 158  * Used to maintain information about processes that wish to be
 159  * notified when I/O becomes possible.
 160  */
 161 #ifdef KERNEL_PRIVATE
 162 struct selinfo {
 163         struct  wait_queue si_wait_queue;       /* wait_queue for wait/wakeup */
 164         struct klist si_note;           /* JMM - temporary separation */
 165         u_int   si_flags;               /* see below */
 166 };
 167
 168 #define SI_COLL         0x0001          /* collision occurred */
 169 #define SI_RECORDED     0x0004          /* select has been recorded */
 170 #define SI_INITED       0x0008          /* selinfo has been inited */
 171 #define SI_CLEAR        0x0010          /* selinfo has been cleared */
 172
 173 #else
 174 struct selinfo;
 175 #endif
 176
 177 __BEGIN_DECLS
 178
 179 void    selrecord(proc_t selector, struct selinfo *, void *);
 180 void    selwakeup(struct selinfo *);
 181 void    selthreadclear(struct selinfo *);
 182
 183 __END_DECLS
 184
 185 #endif /* KERNEL */
 186
 187
 188 #ifndef KERNEL
 189 #ifndef _POSIX_C_SOURCE
 190 #include <sys/types.h>
 191 #ifndef  __MWERKS__
 192 #include <signal.h>
 193 #endif /* __MWERKS__ */
 194 #include <sys/time.h>
 195 #endif  /* !_POSIX_C_SOURCE */
 196
 197 __BEGIN_DECLS
 198 #ifndef  __MWERKS__
 199 int      pselect(int, fd_set * __restrict, fd_set * __restrict,
 200                 fd_set * __restrict, const struct timespec * __restrict,
 201                 const sigset_t * __restrict);
 202 #endif /* __MWERKS__ */
 203 int      select(int, fd_set * __restrict, fd_set * __restrict,
 204                 fd_set * __restrict, struct timeval * __restrict);
 205 __END_DECLS
 206 #endif /* ! KERNEL */
 207
 208 #endif /* !_SYS_SELECT_H_ */