[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.
 */
#define __need_fd_set
#define __need_struct_timespec
#define __need_struct_timeval
#include <sys/_structs.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>
 */
#ifndef	_TIME_T
#define	_TIME_T
typedef	__darwin_time_t		time_t;
#endif

#ifndef _SUSECONDS_T
#define _SUSECONDS_T
typedef __darwin_suseconds_t	suseconds_t;
#endif

#ifndef _SIGSET_T
#define _SIGSET_T
typedef __darwin_sigset_t	sigset_t;
#endif

/*
 * [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.
 */
#ifndef	FD_SETSIZE
#define	FD_SETSIZE	__DARWIN_FD_SETSIZE
#endif /* FD_SETSIZE */
#ifndef FD_SET
#define	FD_SET(n, p)	__DARWIN_FD_SET(n, p)
#endif /* FD_SET */
#ifndef FD_CLR
#define	FD_CLR(n, p)	__DARWIN_FD_CLR(n, p)
#endif /* FD_CLR */
#ifndef FD_ISSET
#define	FD_ISSET(n, p)	__DARWIN_FD_ISSET(n, p)
#endif /* FD_ISSET */
#ifndef FD_ZERO
#define	FD_ZERO(p)	__DARWIN_FD_ZERO(p)
#endif /* FD_ZERO */
#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
#ifndef FD_COPY
#define	FD_COPY(f, t)	__DARWIN_FD_COPY(f, t)
#endif /* FD_COPY */
#endif	/* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */

#ifdef KERNEL
#ifdef KERNEL_PRIVATE
#include <kern/wait_queue.h>
#endif
#include <sys/kernel_types.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  wait_queue si_wait_queue;	/* wait_queue 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

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	*/
	75	#define __need_fd_set
	76	#define __need_struct_timespec
	77	#define __need_struct_timeval
	78	#include <sys/_structs.h>
	79
91447636 A	80	/*
	81	* The time_t and suseconds_t types shall be defined as described in
	82	* <sys/types.h>
	83	* The sigset_t type shall be defined as described in <signal.h>
91447636 A	84	*/
	85	#ifndef _TIME_T
	86	#define _TIME_T
	87	typedef __darwin_time_t time_t;
	88	#endif
9bccf70c	89
91447636 A	90	#ifndef _SUSECONDS_T
	91	#define _SUSECONDS_T
	92	typedef __darwin_suseconds_t suseconds_t;
	93	#endif
	94
	95	#ifndef _SIGSET_T
	96	#define _SIGSET_T
	97	typedef __darwin_sigset_t sigset_t;
	98	#endif
	99
91447636	100	/*
91447636 A	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
91447636	104	*/
91447636 A	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
2d21ac55 A	113	#define FD_SETSIZE __DARWIN_FD_SETSIZE
	114	#endif /* FD_SETSIZE */
	115	#ifndef FD_SET
	116	#define FD_SET(n, p) __DARWIN_FD_SET(n, p)
	117	#endif /* FD_SET */
	118	#ifndef FD_CLR
	119	#define FD_CLR(n, p) __DARWIN_FD_CLR(n, p)
	120	#endif /* FD_CLR */
	121	#ifndef FD_ISSET
	122	#define FD_ISSET(n, p) __DARWIN_FD_ISSET(n, p)
	123	#endif /* FD_ISSET */
	124	#ifndef FD_ZERO
	125	#define FD_ZERO(p) __DARWIN_FD_ZERO(p)
	126	#endif /* FD_ZERO */
	127	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
	128	#ifndef FD_COPY
	129	#define FD_COPY(f, t) __DARWIN_FD_COPY(f, t)
	130	#endif /* FD_COPY */
	131	#endif /* (!_POSIX_C_SOURCE \|\| _DARWIN_C_SOURCE) */
9bccf70c A	132
9bccf70c A	133	#ifdef KERNEL
91447636	134	#ifdef KERNEL_PRIVATE
0b4e3aa0	135	#include <kern/wait_queue.h>
0b4e3aa0	136	#endif
91447636	137	#include <sys/kernel_types.h>
0b4e3aa0	138
55e303ae A	139	#include <sys/event.h>
55e303ae A	140
1c79356b A	141	/*
	142	* Used to maintain information about processes that wish to be
	143	* notified when I/O becomes possible.
	144	*/
91447636	145	#ifdef KERNEL_PRIVATE
1c79356b	146	struct selinfo {
91447636 A	147	struct wait_queue si_wait_queue; /* wait_queue for wait/wakeup */
91447636 A	148	struct klist si_note; /* JMM - temporary separation */
55e303ae	149	u_int si_flags; /* see below */
1c79356b	150	};
0b4e3aa0	151
e3027f41	152	#define SI_COLL 0x0001 /* collision occurred */
0b4e3aa0 A	153	#define SI_RECORDED 0x0004 /* select has been recorded */
	154	#define SI_INITED 0x0008 /* selinfo has been inited */
	155	#define SI_CLEAR 0x0010 /* selinfo has been cleared */
1c79356b	156
91447636 A	157	#else
	158	struct selinfo;
	159	#endif
1c79356b	160
91447636 A	161	__BEGIN_DECLS
	162
	163	void selrecord(proc_t selector, struct selinfo , void );
	164	void selwakeup(struct selinfo *);
	165	void selthreadclear(struct selinfo *);
9bccf70c A	166
	167	__END_DECLS
	168
2d21ac55	169	#else /* !KERNEL */
55e303ae A	170
55e303ae A	171	__BEGIN_DECLS
2d21ac55	172
55e303ae	173	#ifndef __MWERKS__
91447636 A	174	int pselect(int, fd_set * __restrict, fd_set * __restrict,
91447636 A	175	fd_set * __restrict, const struct timespec * __restrict,
2d21ac55 A	176	const sigset_t * __restrict)
	177	#if defined(_DARWIN_C_SOURCE) \|\| defined(_DARWIN_UNLIMITED_SELECT)
	178	__DARWIN_EXTSN_C(pselect)
	179	#else /* !_DARWIN_C_SOURCE && !_DARWIN_UNLIMITED_SELECT */
	180	# if defined(__LP64__) && !__DARWIN_NON_CANCELABLE
	181	__DARWIN_1050(pselect)
	182	# else /* !__LP64__ \|\| __DARWIN_NON_CANCELABLE */
	183	__DARWIN_ALIAS_C(pselect)
	184	# endif /* __LP64__ && !__DARWIN_NON_CANCELABLE */
	185	#endif /* _DARWIN_C_SOURCE \|\| _DARWIN_UNLIMITED_SELECT */
	186	;
55e303ae	187	#endif /* __MWERKS__ */
2d21ac55 A	188
	189	#include <sys/_select.h> /* select() prototype */
	190
55e303ae	191	__END_DECLS
2d21ac55	192
55e303ae A	193	#endif /* ! KERNEL */
55e303ae A	194
1c79356b	195	#endif /* !_SYS_SELECT_H_ */