bsd/sys/select.h

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