bsd/sys/select.h

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