Home | History | Annotate | Download | only in sys
      1 /* `fd_set' type and related macros, and `select'/`pselect' declarations.
      2    Copyright (C) 1996-2003, 2009, 2011 Free Software Foundation, Inc.
      3    This file is part of the GNU C Library.
      4 
      5    The GNU C Library is free software; you can redistribute it and/or
      6    modify it under the terms of the GNU Lesser General Public
      7    License as published by the Free Software Foundation; either
      8    version 2.1 of the License, or (at your option) any later version.
      9 
     10    The GNU C Library is distributed in the hope that it will be useful,
     11    but WITHOUT ANY WARRANTY; without even the implied warranty of
     12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     13    Lesser General Public License for more details.
     14 
     15    You should have received a copy of the GNU Lesser General Public
     16    License along with the GNU C Library; if not, write to the Free
     17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
     18    02111-1307 USA.  */
     19 
     20 /*	POSIX 1003.1g: 6.2 Select from File Descriptor Sets <sys/select.h>  */
     21 
     22 #ifndef _SYS_SELECT_H
     23 #define _SYS_SELECT_H	1
     24 
     25 #include <features.h>
     26 
     27 /* Get definition of needed basic types.  */
     28 #include <bits/types.h>
     29 
     30 /* Get __FD_* definitions.  */
     31 #include <bits/select.h>
     32 
     33 /* Get __sigset_t.  */
     34 #include <bits/sigset.h>
     35 
     36 #ifndef __sigset_t_defined
     37 # define __sigset_t_defined
     38 typedef __sigset_t sigset_t;
     39 #endif
     40 
     41 /* Get definition of timer specification structures.  */
     42 #define __need_time_t
     43 #define __need_timespec
     44 #include <time.h>
     45 #define __need_timeval
     46 #include <bits/time.h>
     47 
     48 #ifndef __suseconds_t_defined
     49 typedef __suseconds_t suseconds_t;
     50 # define __suseconds_t_defined
     51 #endif
     52 
     53 
     54 /* The fd_set member is required to be an array of longs.  */
     55 typedef long int __fd_mask;
     56 
     57 /* Some versions of <linux/posix_types.h> define this macros.  */
     58 #undef	__NFDBITS
     59 /* It's easier to assume 8-bit bytes than to get CHAR_BIT.  */
     60 #define __NFDBITS	(8 * (int) sizeof (__fd_mask))
     61 #define	__FD_ELT(d)	((d) / __NFDBITS)
     62 #define	__FD_MASK(d)	((__fd_mask) 1 << ((d) % __NFDBITS))
     63 
     64 /* fd_set for select and pselect.  */
     65 typedef struct
     66   {
     67     /* XPG4.2 requires this member name.  Otherwise avoid the name
     68        from the global namespace.  */
     69 #ifdef __USE_XOPEN
     70     __fd_mask fds_bits[__FD_SETSIZE / __NFDBITS];
     71 # define __FDS_BITS(set) ((set)->fds_bits)
     72 #else
     73     __fd_mask __fds_bits[__FD_SETSIZE / __NFDBITS];
     74 # define __FDS_BITS(set) ((set)->__fds_bits)
     75 #endif
     76   } fd_set;
     77 
     78 /* Maximum number of file descriptors in `fd_set'.  */
     79 #define	FD_SETSIZE		__FD_SETSIZE
     80 
     81 #ifdef __USE_MISC
     82 /* Sometimes the fd_set member is assumed to have this type.  */
     83 typedef __fd_mask fd_mask;
     84 
     85 /* Number of bits per word of `fd_set' (some code assumes this is 32).  */
     86 # define NFDBITS		__NFDBITS
     87 #endif
     88 
     89 
     90 /* Access macros for `fd_set'.  */
     91 #define	FD_SET(fd, fdsetp)	__FD_SET (fd, fdsetp)
     92 #define	FD_CLR(fd, fdsetp)	__FD_CLR (fd, fdsetp)
     93 #define	FD_ISSET(fd, fdsetp)	__FD_ISSET (fd, fdsetp)
     94 #define	FD_ZERO(fdsetp)		__FD_ZERO (fdsetp)
     95 
     96 
     97 __BEGIN_DECLS
     98 
     99 /* Check the first NFDS descriptors each in READFDS (if not NULL) for read
    100    readiness, in WRITEFDS (if not NULL) for write readiness, and in EXCEPTFDS
    101    (if not NULL) for exceptional conditions.  If TIMEOUT is not NULL, time out
    102    after waiting the interval specified therein.  Returns the number of ready
    103    descriptors, or -1 for errors.
    104 
    105    This function is a cancellation point and therefore not marked with
    106    __THROW.  */
    107 extern int select (int __nfds, fd_set *__restrict __readfds,
    108 		   fd_set *__restrict __writefds,
    109 		   fd_set *__restrict __exceptfds,
    110 		   struct timeval *__restrict __timeout);
    111 
    112 #ifdef __USE_XOPEN2K
    113 /* Same as above only that the TIMEOUT value is given with higher
    114    resolution and a sigmask which is been set temporarily.  This version
    115    should be used.
    116 
    117    This function is a cancellation point and therefore not marked with
    118    __THROW.  */
    119 extern int pselect (int __nfds, fd_set *__restrict __readfds,
    120 		    fd_set *__restrict __writefds,
    121 		    fd_set *__restrict __exceptfds,
    122 		    const struct timespec *__restrict __timeout,
    123 		    const __sigset_t *__restrict __sigmask);
    124 #endif
    125 
    126 
    127 /* Define some inlines helping to catch common problems.  */
    128 #if __USE_FORTIFY_LEVEL > 0 && defined __GNUC__
    129 # include <bits/select2.h>
    130 #endif
    131 
    132 __END_DECLS
    133 
    134 #endif /* sys/select.h */
    135