[apple/xnu.git] / bsd / sys / select.h

/*
 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1992, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)select.h	8.2 (Berkeley) 1/4/94
 */

#ifndef _SYS_SELECT_H_
#define	_SYS_SELECT_H_

#include <sys/appleapiopts.h>
#include <sys/cdefs.h>
#include <sys/_types.h>

/*
 * [XSI] The <sys/select.h> header shall define the fd_set type as a structure.
 * The timespec structure shall be defined as described in <time.h>
 * The <sys/select.h> header shall define the timeval structure.
 */
#include <sys/_types/_fd_def.h>
#include <sys/_types/_timespec.h>
#include <sys/_types/_timeval.h>

/*
 * The time_t and suseconds_t types shall be defined as described in
 * <sys/types.h>
 * The sigset_t type shall be defined as described in <signal.h>
 */
#include <sys/_types/_time_t.h>
#include <sys/_types/_suseconds_t.h>
#include <sys/_types/_sigset_t.h>

/*
 * [XSI] FD_CLR, FD_ISSET, FD_SET, FD_ZERO may be declared as a function, or
 *	 defined as a macro, or both
 * [XSI] FD_SETSIZE shall be defined as a macro
 */

/*
 * Select uses bit masks of file descriptors in longs.  These macros
 * manipulate such bit fields (the filesystem macros use chars).  The
 * extra protection here is to permit application redefinition above
 * the default size.
 */
#include <sys/_types/_fd_setsize.h>
#include <sys/_types/_fd_set.h>
#include <sys/_types/_fd_clr.h>
#include <sys/_types/_fd_isset.h>
#include <sys/_types/_fd_zero.h>

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
#include <sys/_types/_fd_copy.h>
#endif	/* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */

#ifdef KERNEL
#include <sys/kernel_types.h>
#include <kern/waitq.h>
#include <sys/event.h>

/*
 * Used to maintain information about processes that wish to be
 * notified when I/O becomes possible.
 */
#ifdef KERNEL_PRIVATE
struct selinfo {
	struct	waitq si_waitq;		/* waitq for wait/wakeup */
	struct	klist si_note;		/* JMM - temporary separation */
	u_int	si_flags;		/* see below */
};

#define	SI_COLL		0x0001		/* collision occurred */
#define	SI_RECORDED	0x0004		/* select has been recorded */ 
#define	SI_INITED	0x0008		/* selinfo has been inited */ 
#define	SI_CLEAR	0x0010		/* selinfo has been cleared */ 

#else
struct selinfo;
#endif

__BEGIN_DECLS

extern int selwait;
void	selrecord(proc_t selector, struct selinfo *, void *);
void	selwakeup(struct selinfo *);
void	selthreadclear(struct selinfo *);

__END_DECLS

#else /* !KERNEL */

__BEGIN_DECLS

#ifndef  __MWERKS__
int	 pselect(int, fd_set * __restrict, fd_set * __restrict,
		fd_set * __restrict, const struct timespec * __restrict,
		const sigset_t * __restrict)
#if defined(_DARWIN_C_SOURCE) || defined(_DARWIN_UNLIMITED_SELECT)
		__DARWIN_EXTSN_C(pselect)
#else /* !_DARWIN_C_SOURCE && !_DARWIN_UNLIMITED_SELECT */
#  if defined(__LP64__) && !__DARWIN_NON_CANCELABLE
		__DARWIN_1050(pselect)
#  else /* !__LP64__ || __DARWIN_NON_CANCELABLE */
		__DARWIN_ALIAS_C(pselect)
#  endif /* __LP64__ && !__DARWIN_NON_CANCELABLE */
#endif /* _DARWIN_C_SOURCE || _DARWIN_UNLIMITED_SELECT */
		;
#endif /* __MWERKS__ */

#include <sys/_select.h>	/* select() prototype */

__END_DECLS

#endif /* ! KERNEL */

#endif /* !_SYS_SELECT_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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
9bccf70c	66	#include <sys/appleapiopts.h>
55e303ae	67	#include <sys/cdefs.h>
91447636	68	#include <sys/_types.h>
9bccf70c	69
2d21ac55 A	70	/*
	71	* [XSI] The <sys/select.h> header shall define the fd_set type as a structure.
	72	* The timespec structure shall be defined as described in <time.h>
	73	* The <sys/select.h> header shall define the timeval structure.
	74	*/
39236c6e A	75	#include <sys/_types/_fd_def.h>
	76	#include <sys/_types/_timespec.h>
	77	#include <sys/_types/_timeval.h>
2d21ac55	78
91447636 A	79	/*
	80	* The time_t and suseconds_t types shall be defined as described in
	81	* <sys/types.h>
	82	* The sigset_t type shall be defined as described in <signal.h>
91447636	83	*/
39236c6e A	84	#include <sys/_types/_time_t.h>
	85	#include <sys/_types/_suseconds_t.h>
	86	#include <sys/_types/_sigset_t.h>
91447636	87
91447636	88	/*
91447636 A	89	* [XSI] FD_CLR, FD_ISSET, FD_SET, FD_ZERO may be declared as a function, or
	90	* defined as a macro, or both
	91	* [XSI] FD_SETSIZE shall be defined as a macro
91447636	92	*/
91447636 A	93
	94	/*
	95	* Select uses bit masks of file descriptors in longs. These macros
	96	* manipulate such bit fields (the filesystem macros use chars). The
	97	* extra protection here is to permit application redefinition above
	98	* the default size.
	99	*/
39236c6e A	100	#include <sys/_types/_fd_setsize.h>
	101	#include <sys/_types/_fd_set.h>
	102	#include <sys/_types/_fd_clr.h>
	103	#include <sys/_types/_fd_isset.h>
	104	#include <sys/_types/_fd_zero.h>
	105
2d21ac55	106	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
39236c6e	107	#include <sys/_types/_fd_copy.h>
2d21ac55	108	#endif /* (!_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE) */
9bccf70c A	109
9bccf70c A	110	#ifdef KERNEL
91447636	111	#include <sys/kernel_types.h>
3e170ce0	112	#include <kern/waitq.h>
55e303ae A	113	#include <sys/event.h>
55e303ae A	114
1c79356b A	115	/*
	116	* Used to maintain information about processes that wish to be
	117	* notified when I/O becomes possible.
	118	*/
91447636	119	#ifdef KERNEL_PRIVATE
1c79356b	120	struct selinfo {
3e170ce0 A	121	struct waitq si_waitq; /* waitq for wait/wakeup */
3e170ce0 A	122	struct klist si_note; /* JMM - temporary separation */
55e303ae	123	u_int si_flags; /* see below */
1c79356b	124	};
0b4e3aa0	125
e3027f41	126	#define SI_COLL 0x0001 /* collision occurred */
0b4e3aa0 A	127	#define SI_RECORDED 0x0004 /* select has been recorded */
	128	#define SI_INITED 0x0008 /* selinfo has been inited */
	129	#define SI_CLEAR 0x0010 /* selinfo has been cleared */
1c79356b	130
91447636 A	131	#else
	132	struct selinfo;
	133	#endif
1c79356b	134
91447636 A	135	__BEGIN_DECLS
91447636 A	136
b0d623f7	137	extern int selwait;
91447636 A	138	void selrecord(proc_t selector, struct selinfo , void );
	139	void selwakeup(struct selinfo *);
	140	void selthreadclear(struct selinfo *);
9bccf70c A	141
	142	__END_DECLS
	143
2d21ac55	144	#else /* !KERNEL */
55e303ae A	145
55e303ae A	146	__BEGIN_DECLS
2d21ac55	147
55e303ae	148	#ifndef __MWERKS__
91447636 A	149	int pselect(int, fd_set * __restrict, fd_set * __restrict,
91447636 A	150	fd_set * __restrict, const struct timespec * __restrict,
2d21ac55 A	151	const sigset_t * __restrict)
	152	#if defined(_DARWIN_C_SOURCE) \|\| defined(_DARWIN_UNLIMITED_SELECT)
	153	__DARWIN_EXTSN_C(pselect)
	154	#else /* !_DARWIN_C_SOURCE && !_DARWIN_UNLIMITED_SELECT */
	155	# if defined(__LP64__) && !__DARWIN_NON_CANCELABLE
	156	__DARWIN_1050(pselect)
	157	# else /* !__LP64__ \|\| __DARWIN_NON_CANCELABLE */
	158	__DARWIN_ALIAS_C(pselect)
	159	# endif /* __LP64__ && !__DARWIN_NON_CANCELABLE */
	160	#endif /* _DARWIN_C_SOURCE \|\| _DARWIN_UNLIMITED_SELECT */
	161	;
55e303ae	162	#endif /* __MWERKS__ */
2d21ac55 A	163
	164	#include <sys/_select.h> /* select() prototype */
	165
55e303ae	166	__END_DECLS
2d21ac55	167
55e303ae A	168	#endif /* ! KERNEL */
55e303ae A	169
1c79356b	170	#endif /* !_SYS_SELECT_H_ */