bsd/sys/select.h

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