[apple/xnu.git] / osfmk / kern / wait_queue.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
#ifndef _KERN_WAIT_QUEUE_H_
#define _KERN_WAIT_QUEUE_H_

#include <sys/appleapiopts.h>

#ifdef	__APPLE_API_PRIVATE

#include <mach/sync_policy.h>
#include <mach/kern_return.h>		/* for kern_return_t */

#include <kern/kern_types.h>		/* for wait_queue_t */

#ifdef MACH_KERNEL_PRIVATE

#include <kern/lock.h>
#include <kern/queue.h>


/*
 *	wait_queue_t
 *	This is the definition of the common event wait queue
 *	that the scheduler APIs understand.  It is used
 *	internally by the gerneralized event waiting mechanism
 *	(assert_wait), and also for items that maintain their
 *	own wait queues (such as ports and semaphores).
 *
 *	It is not published to other kernel components.  They
 *	can create wait queues by calling wait_queue_alloc.
 *
 *	NOTE:  Hardware locks are used to protect event wait
 *	queues since interrupt code is free to post events to
 *	them.
 */
typedef struct wait_queue {
    unsigned int                    /* flags */
    /* boolean_t */	wq_type:16,		/* only public field */
					wq_fifo:1,		/* fifo wakeup policy? */
					wq_isprepost:1,	/* is waitq preposted? set only */
					:0;				/* force to long boundary */
    hw_lock_data_t	wq_interlock;	/* interlock */
    queue_head_t	wq_queue;		/* queue of elements */
} WaitQueue;

/*
 *	wait_queue_set_t
 *	This is the common definition for a set wait queue.
 *	These can be linked as members/elements of multiple regular
 *	wait queues.  They have an additional set of linkages to
 *	identify the linkage structures that point to them.
 */
typedef struct wait_queue_set {
	WaitQueue		wqs_wait_queue; /* our wait queue */
	queue_head_t	wqs_setlinks;	/* links from set perspective */
	unsigned int 	wqs_refcount;	/* refcount for preposting */
} WaitQueueSet;

#define wqs_type		wqs_wait_queue.wq_type
#define wqs_fifo		wqs_wait_queue.wq_fifo
#define wqs_isprepost	wqs_wait_queue.wq_isprepost
#define wqs_queue		wqs_wait_queue.wq_queue

/*
 *	wait_queue_element_t
 *	This structure describes the elements on an event wait
 *	queue.  It is the common first fields in a thread shuttle
 *	and wait_queue_link_t.  In that way, a wait queue can
 *	consist of both thread shuttle elements and links off of
 *	to other (set) wait queues.
 *
 *	WARNING: These fields correspond to fields in the thread
 *	shuttle (run queue links and run queue pointer). Any change in
 *	the layout here will have to be matched with a change there.
 */
typedef struct wait_queue_element {
	queue_chain_t	wqe_links;	/* link of elements on this queue */
	void *			wqe_type;	/* Identifies link vs. thread */
	wait_queue_t	wqe_queue;	/* queue this element is on */
} WaitQueueElement;

typedef WaitQueueElement *wait_queue_element_t;

/*
 *	wait_queue_link_t
 *	Specialized wait queue element type for linking set
 *	event waits queues onto a wait queue.  In this way, an event
 *	can be constructed so that any thread waiting on any number
 *	of associated wait queues can handle the event, while letting
 *	the thread only be linked on the single wait queue it blocked on.
 *
 *	One use: ports in multiple portsets.  Each thread is queued up
 *	on the portset that it specifically blocked on during a receive
 *	operation.  Each port's event queue links in all the portset
 *	event queues of which it is a member.  An IPC event post associated
 *	with that port may wake up any thread from any of those portsets,
 *	or one that was waiting locally on the port itself.
 */
typedef struct wait_queue_link {
	WaitQueueElement		wql_element;	/* element on master */
	queue_chain_t			wql_setlinks;	/* element on set */
    wait_queue_set_t		wql_setqueue;	/* set queue */
} WaitQueueLink;

#define wql_links wql_element.wqe_links
#define wql_type  wql_element.wqe_type
#define wql_queue wql_element.wqe_queue

#define _WAIT_QUEUE_inited			0xf1d0
#define _WAIT_QUEUE_SET_inited		0xf1d1

#define wait_queue_is_queue(wq)	\
	((wq)->wq_type == _WAIT_QUEUE_inited)

#define wait_queue_is_set(wqs)	\
	((wqs)->wqs_type == _WAIT_QUEUE_SET_inited)

#define wait_queue_is_valid(wq)	\
	(((wq)->wq_type & ~1) == _WAIT_QUEUE_inited)

#define wait_queue_empty(wq)	(queue_empty(&(wq)->wq_queue))
#define wait_queue_held(wq)		(hw_lock_held(&(wq)->wq_interlock))
#define wait_queue_lock_try(wq) (hw_lock_try(&(wq)->wq_interlock))

/*
 * Double the standard lock timeout, because wait queues tend
 * to iterate over a number of threads - locking each.  If there is
 * a problem with a thread lock, it normally times out at the wait
 * queue level first, hiding the real problem.
 */
#define wait_queue_lock(wq)	\
	((void) (!hw_lock_to(&(wq)->wq_interlock, LockTimeOut * 2) ? \
		 panic("wait queue deadlock - wq=0x%x, cpu=%d\n", \
		       wq, cpu_number()) : 0))

#define wait_queue_unlock(wq) \
	(assert(wait_queue_held(wq)), hw_lock_unlock(&(wq)->wq_interlock))

#define wqs_lock(wqs)		wait_queue_lock(&(wqs)->wqs_wait_queue)
#define wqs_unlock(wqs)		wait_queue_unlock(&(wqs)->wqs_wait_queue)
#define wqs_lock_try(wqs)	wait_queue__try_lock(&(wqs)->wqs_wait_queue)

#define wait_queue_assert_possible(thread) \
			((thread)->wait_queue == WAIT_QUEUE_NULL)

/******** Decomposed interfaces (to build higher level constructs) ***********/

/* assert intent to wait on a locked wait queue */
__private_extern__ wait_result_t wait_queue_assert_wait64_locked(
			wait_queue_t wait_queue,
			event64_t wait_event,
			wait_interrupt_t interruptible,
			boolean_t unlock);

/* peek to see which thread would be chosen for a wakeup - but keep on queue */
__private_extern__ void wait_queue_peek64_locked(
			wait_queue_t wait_queue,
			event64_t event,
			thread_t *thread,
			wait_queue_t *found_queue);

/* peek to see which thread would be chosen for a wakeup - but keep on queue */
__private_extern__ void wait_queue_pull_thread_locked(
			wait_queue_t wait_queue,
			thread_t thread,
			boolean_t unlock);

/* wakeup all threads waiting for a particular event on locked queue */
__private_extern__ kern_return_t wait_queue_wakeup64_all_locked(
			wait_queue_t wait_queue,
			event64_t wake_event,
			wait_result_t result,
			boolean_t unlock);

/* wakeup one thread waiting for a particular event on locked queue */
__private_extern__ kern_return_t wait_queue_wakeup64_one_locked(
			wait_queue_t wait_queue,
			event64_t wake_event,
			wait_result_t result,
			boolean_t unlock);

/* return identity of a thread awakened for a particular <wait_queue,event> */
__private_extern__ thread_t wait_queue_wakeup64_identity_locked(
			wait_queue_t wait_queue,
			event64_t wake_event,
			wait_result_t result,
			boolean_t unlock);

/* wakeup thread iff its still waiting for a particular event on locked queue */
__private_extern__ kern_return_t wait_queue_wakeup64_thread_locked(
			wait_queue_t wait_queue,
			event64_t wake_event,
			thread_t thread,
			wait_result_t result,
			boolean_t unlock);

#endif /* MACH_KERNEL_PRIVATE */

#ifdef __APPLE_API_UNSTABLE
/******** Semi-Public interfaces (not a part of a higher construct) ************/

extern kern_return_t wait_queue_init(
			wait_queue_t wait_queue,
			int policy);

extern wait_queue_set_t wait_queue_set_alloc(
			int policy);

extern kern_return_t wait_queue_set_free(
			wait_queue_set_t set_queue);

extern wait_queue_link_t wait_queue_link_alloc(
			int policy);

extern kern_return_t wait_queue_link_free(
			wait_queue_link_t link_element);

#endif /* __APPLE_API_UNSTABLE */

#ifdef __APPLE_API_EVOLVING

extern wait_queue_t wait_queue_alloc(
			int policy);

extern kern_return_t wait_queue_free(
			wait_queue_t wait_queue);

extern kern_return_t wait_queue_link(
			wait_queue_t wait_queue,
			wait_queue_set_t set_queue);

extern kern_return_t wait_queue_unlink(
			wait_queue_t wait_queue,
			wait_queue_set_t set_queue);

extern kern_return_t wait_queue_unlink_all(
			wait_queue_t wait_queue);

extern kern_return_t wait_queue_set_unlink_all(
			wait_queue_set_t set_queue);

/* assert intent to wait on <wait_queue,event64> pair */
extern wait_result_t wait_queue_assert_wait64(
			wait_queue_t wait_queue,
			event64_t wait_event,
			wait_interrupt_t interruptible);

/* wakeup the most appropriate thread waiting on <wait_queue,event64> pair */
extern kern_return_t wait_queue_wakeup64_one(
			wait_queue_t wait_queue,
			event64_t wake_event,
			wait_result_t result);

/* wakeup all the threads waiting on <wait_queue,event64> pair */
extern kern_return_t wait_queue_wakeup64_all(
			wait_queue_t wait_queue,
			event64_t wake_event,
			wait_result_t result);

/* wakeup a specified thread waiting iff waiting on <wait_queue,event64> pair */
extern kern_return_t wait_queue_wakeup64_thread(
			wait_queue_t wait_queue,
			event64_t wake_event,
			thread_t thread,
			wait_result_t result);

#endif  /* __APPLE_API_EVOLVING */

/*
 * Compatibility Wait Queue APIs based on pointer events instead of 64bit
 * integer events.
 */

/* assert intent to wait on <wait_queue,event> pair */
extern wait_result_t wait_queue_assert_wait(
			wait_queue_t wait_queue,
			event_t wait_event,
			wait_interrupt_t interruptible);

/* wakeup the most appropriate thread waiting on <wait_queue,event> pair */
extern kern_return_t wait_queue_wakeup_one(
			wait_queue_t wait_queue,
			event_t wake_event,
			wait_result_t result);

/* wakeup all the threads waiting on <wait_queue,event> pair */
extern kern_return_t wait_queue_wakeup_all(
			wait_queue_t wait_queue,
			event_t wake_event,
			wait_result_t result);

/* wakeup a specified thread waiting iff waiting on <wait_queue,event> pair */
extern kern_return_t wait_queue_wakeup_thread(
			wait_queue_t wait_queue,
			event_t wake_event,
			thread_t thread,
			wait_result_t result);

#endif	/* __APPLE_API_PRIVATE */

#endif /* _KERN_WAIT_QUEUE_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 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	#ifndef _KERN_WAIT_QUEUE_H_
	23	#define _KERN_WAIT_QUEUE_H_
	24
9bccf70c A	25	#include <sys/appleapiopts.h>
	26
	27	#ifdef __APPLE_API_PRIVATE
	28
1c79356b	29	#include <mach/sync_policy.h>
0b4e3aa0	30	#include <mach/kern_return.h> /* for kern_return_t */
1c79356b	31
9bccf70c A	32	#include <kern/kern_types.h> /* for wait_queue_t */
	33
	34	#ifdef MACH_KERNEL_PRIVATE
1c79356b A	35
	36	#include <kern/lock.h>
	37	#include <kern/queue.h>
	38
9bccf70c	39
1c79356b A	40	/*
	41	* wait_queue_t
	42	* This is the definition of the common event wait queue
	43	* that the scheduler APIs understand. It is used
	44	* internally by the gerneralized event waiting mechanism
	45	* (assert_wait), and also for items that maintain their
	46	* own wait queues (such as ports and semaphores).
	47	*
	48	* It is not published to other kernel components. They
	49	* can create wait queues by calling wait_queue_alloc.
	50	*
	51	* NOTE: Hardware locks are used to protect event wait
	52	* queues since interrupt code is free to post events to
	53	* them.
	54	*/
	55	typedef struct wait_queue {
9bccf70c A	56	unsigned int /* flags */
	57	/* boolean_t / wq_type:16, / only public field */
	58	wq_fifo:1, /* fifo wakeup policy? */
	59	wq_isprepost:1, /* is waitq preposted? set only */
	60	:0; /* force to long boundary */
1c79356b	61	hw_lock_data_t wq_interlock; /* interlock */
9bccf70c	62	queue_head_t wq_queue; /* queue of elements */
1c79356b A	63	} WaitQueue;
	64
	65	/*
9bccf70c A	66	* wait_queue_set_t
9bccf70c A	67	* This is the common definition for a set wait queue.
1c79356b A	68	* These can be linked as members/elements of multiple regular
	69	* wait queues. They have an additional set of linkages to
	70	* identify the linkage structures that point to them.
	71	*/
9bccf70c A	72	typedef struct wait_queue_set {
	73	WaitQueue wqs_wait_queue; /* our wait queue */
	74	queue_head_t wqs_setlinks; /* links from set perspective */
0b4e3aa0	75	unsigned int wqs_refcount; /* refcount for preposting */
9bccf70c	76	} WaitQueueSet;
1c79356b	77
9bccf70c A	78	#define wqs_type wqs_wait_queue.wq_type
	79	#define wqs_fifo wqs_wait_queue.wq_fifo
	80	#define wqs_isprepost wqs_wait_queue.wq_isprepost
	81	#define wqs_queue wqs_wait_queue.wq_queue
1c79356b A	82
	83	/*
	84	* wait_queue_element_t
	85	* This structure describes the elements on an event wait
	86	* queue. It is the common first fields in a thread shuttle
	87	* and wait_queue_link_t. In that way, a wait queue can
	88	* consist of both thread shuttle elements and links off of
9bccf70c	89	* to other (set) wait queues.
1c79356b	90	*
9bccf70c A	91	* WARNING: These fields correspond to fields in the thread
9bccf70c A	92	* shuttle (run queue links and run queue pointer). Any change in
1c79356b A	93	* the layout here will have to be matched with a change there.
	94	*/
	95	typedef struct wait_queue_element {
	96	queue_chain_t wqe_links; /* link of elements on this queue */
9bccf70c	97	void * wqe_type; /* Identifies link vs. thread */
1c79356b	98	wait_queue_t wqe_queue; /* queue this element is on */
9bccf70c	99	} WaitQueueElement;
1c79356b	100
9bccf70c	101	typedef WaitQueueElement *wait_queue_element_t;
0b4e3aa0	102
1c79356b A	103	/*
1c79356b A	104	* wait_queue_link_t
9bccf70c	105	* Specialized wait queue element type for linking set
1c79356b A	106	* event waits queues onto a wait queue. In this way, an event
	107	* can be constructed so that any thread waiting on any number
	108	* of associated wait queues can handle the event, while letting
	109	* the thread only be linked on the single wait queue it blocked on.
	110	*
	111	* One use: ports in multiple portsets. Each thread is queued up
	112	* on the portset that it specifically blocked on during a receive
	113	* operation. Each port's event queue links in all the portset
	114	* event queues of which it is a member. An IPC event post associated
	115	* with that port may wake up any thread from any of those portsets,
	116	* or one that was waiting locally on the port itself.
	117	*/
	118	typedef struct wait_queue_link {
9bccf70c A	119	WaitQueueElement wql_element; /* element on master */
	120	queue_chain_t wql_setlinks; /* element on set */
	121	wait_queue_set_t wql_setqueue; /* set queue */
0b4e3aa0 A	122	} WaitQueueLink;
0b4e3aa0 A	123
1c79356b	124	#define wql_links wql_element.wqe_links
9bccf70c	125	#define wql_type wql_element.wqe_type
1c79356b	126	#define wql_queue wql_element.wqe_queue
0b4e3aa0	127
9bccf70c A	128	#define _WAIT_QUEUE_inited 0xf1d0
9bccf70c A	129	#define _WAIT_QUEUE_SET_inited 0xf1d1
0b4e3aa0	130
9bccf70c A	131	#define wait_queue_is_queue(wq) \
9bccf70c A	132	((wq)->wq_type == _WAIT_QUEUE_inited)
1c79356b	133
9bccf70c A	134	#define wait_queue_is_set(wqs) \
9bccf70c A	135	((wqs)->wqs_type == _WAIT_QUEUE_SET_inited)
1c79356b	136
9bccf70c A	137	#define wait_queue_is_valid(wq) \
9bccf70c A	138	(((wq)->wq_type & ~1) == _WAIT_QUEUE_inited)
1c79356b	139
9bccf70c A	140	#define wait_queue_empty(wq) (queue_empty(&(wq)->wq_queue))
	141	#define wait_queue_held(wq) (hw_lock_held(&(wq)->wq_interlock))
	142	#define wait_queue_lock_try(wq) (hw_lock_try(&(wq)->wq_interlock))
1c79356b	143
9bccf70c A	144	/*
	145	* Double the standard lock timeout, because wait queues tend
	146	* to iterate over a number of threads - locking each. If there is
	147	* a problem with a thread lock, it normally times out at the wait
	148	* queue level first, hiding the real problem.
	149	*/
	150	#define wait_queue_lock(wq) \
	151	((void) (!hw_lock_to(&(wq)->wq_interlock, LockTimeOut * 2) ? \
	152	panic("wait queue deadlock - wq=0x%x, cpu=%d\n", \
	153	wq, cpu_number()) : 0))
1c79356b	154
9bccf70c A	155	#define wait_queue_unlock(wq) \
9bccf70c A	156	(assert(wait_queue_held(wq)), hw_lock_unlock(&(wq)->wq_interlock))
1c79356b	157
9bccf70c A	158	#define wqs_lock(wqs) wait_queue_lock(&(wqs)->wqs_wait_queue)
	159	#define wqs_unlock(wqs) wait_queue_unlock(&(wqs)->wqs_wait_queue)
	160	#define wqs_lock_try(wqs) wait_queue__try_lock(&(wqs)->wqs_wait_queue)
1c79356b A	161
	162	#define wait_queue_assert_possible(thread) \
	163	((thread)->wait_queue == WAIT_QUEUE_NULL)
	164
1c79356b A	165	/****** Decomposed interfaces (to build higher level constructs) *********/
1c79356b A	166
1c79356b	167	/* assert intent to wait on a locked wait queue */
9bccf70c	168	__private_extern__ wait_result_t wait_queue_assert_wait64_locked(
1c79356b	169	wait_queue_t wait_queue,
9bccf70c A	170	event64_t wait_event,
9bccf70c A	171	wait_interrupt_t interruptible,
1c79356b A	172	boolean_t unlock);
	173
	174	/* peek to see which thread would be chosen for a wakeup - but keep on queue */
9bccf70c	175	__private_extern__ void wait_queue_peek64_locked(
1c79356b	176	wait_queue_t wait_queue,
9bccf70c	177	event64_t event,
1c79356b A	178	thread_t *thread,
	179	wait_queue_t *found_queue);
	180
	181	/* peek to see which thread would be chosen for a wakeup - but keep on queue */
9bccf70c	182	__private_extern__ void wait_queue_pull_thread_locked(
1c79356b A	183	wait_queue_t wait_queue,
	184	thread_t thread,
	185	boolean_t unlock);
	186
	187	/* wakeup all threads waiting for a particular event on locked queue */
9bccf70c	188	__private_extern__ kern_return_t wait_queue_wakeup64_all_locked(
1c79356b	189	wait_queue_t wait_queue,
9bccf70c A	190	event64_t wake_event,
9bccf70c A	191	wait_result_t result,
1c79356b A	192	boolean_t unlock);
	193
	194	/* wakeup one thread waiting for a particular event on locked queue */
9bccf70c	195	__private_extern__ kern_return_t wait_queue_wakeup64_one_locked(
1c79356b	196	wait_queue_t wait_queue,
9bccf70c A	197	event64_t wake_event,
9bccf70c A	198	wait_result_t result,
1c79356b A	199	boolean_t unlock);
1c79356b A	200
1c79356b	201	/* return identity of a thread awakened for a particular <wait_queue,event> */
9bccf70c	202	__private_extern__ thread_t wait_queue_wakeup64_identity_locked(
1c79356b	203	wait_queue_t wait_queue,
9bccf70c A	204	event64_t wake_event,
9bccf70c A	205	wait_result_t result,
1c79356b A	206	boolean_t unlock);
	207
	208	/* wakeup thread iff its still waiting for a particular event on locked queue */
9bccf70c	209	__private_extern__ kern_return_t wait_queue_wakeup64_thread_locked(
1c79356b	210	wait_queue_t wait_queue,
9bccf70c	211	event64_t wake_event,
1c79356b	212	thread_t thread,
9bccf70c	213	wait_result_t result,
1c79356b A	214	boolean_t unlock);
	215
	216	#endif /* MACH_KERNEL_PRIVATE */
	217
9bccf70c A	218	#ifdef __APPLE_API_UNSTABLE
	219	/****** Semi-Public interfaces (not a part of a higher construct) **********/
	220
	221	extern kern_return_t wait_queue_init(
	222	wait_queue_t wait_queue,
	223	int policy);
	224
	225	extern wait_queue_set_t wait_queue_set_alloc(
	226	int policy);
	227
	228	extern kern_return_t wait_queue_set_free(
	229	wait_queue_set_t set_queue);
	230
	231	extern wait_queue_link_t wait_queue_link_alloc(
	232	int policy);
	233
	234	extern kern_return_t wait_queue_link_free(
	235	wait_queue_link_t link_element);
	236
	237	#endif /* __APPLE_API_UNSTABLE */
	238
	239	#ifdef __APPLE_API_EVOLVING
	240
1c79356b	241	extern wait_queue_t wait_queue_alloc(
9bccf70c A	242	int policy);
	243
	244	extern kern_return_t wait_queue_free(
	245	wait_queue_t wait_queue);
1c79356b	246
9bccf70c A	247	extern kern_return_t wait_queue_link(
	248	wait_queue_t wait_queue,
	249	wait_queue_set_t set_queue);
	250
	251	extern kern_return_t wait_queue_unlink(
	252	wait_queue_t wait_queue,
	253	wait_queue_set_t set_queue);
	254
	255	extern kern_return_t wait_queue_unlink_all(
1c79356b A	256	wait_queue_t wait_queue);
1c79356b A	257
9bccf70c A	258	extern kern_return_t wait_queue_set_unlink_all(
	259	wait_queue_set_t set_queue);
	260
	261	/* assert intent to wait on <wait_queue,event64> pair */
	262	extern wait_result_t wait_queue_assert_wait64(
	263	wait_queue_t wait_queue,
	264	event64_t wait_event,
	265	wait_interrupt_t interruptible);
	266
	267	/* wakeup the most appropriate thread waiting on <wait_queue,event64> pair */
	268	extern kern_return_t wait_queue_wakeup64_one(
	269	wait_queue_t wait_queue,
	270	event64_t wake_event,
	271	wait_result_t result);
	272
	273	/* wakeup all the threads waiting on <wait_queue,event64> pair */
	274	extern kern_return_t wait_queue_wakeup64_all(
	275	wait_queue_t wait_queue,
	276	event64_t wake_event,
	277	wait_result_t result);
	278
	279	/* wakeup a specified thread waiting iff waiting on <wait_queue,event64> pair */
	280	extern kern_return_t wait_queue_wakeup64_thread(
	281	wait_queue_t wait_queue,
	282	event64_t wake_event,
	283	thread_t thread,
	284	wait_result_t result);
	285
	286	#endif /* __APPLE_API_EVOLVING */
	287
	288	/*
	289	* Compatibility Wait Queue APIs based on pointer events instead of 64bit
	290	* integer events.
	291	*/
1c79356b A	292
1c79356b A	293	/* assert intent to wait on <wait_queue,event> pair */
9bccf70c	294	extern wait_result_t wait_queue_assert_wait(
1c79356b A	295	wait_queue_t wait_queue,
1c79356b A	296	event_t wait_event,
9bccf70c	297	wait_interrupt_t interruptible);
1c79356b A	298
1c79356b A	299	/* wakeup the most appropriate thread waiting on <wait_queue,event> pair */
9bccf70c	300	extern kern_return_t wait_queue_wakeup_one(
1c79356b A	301	wait_queue_t wait_queue,
1c79356b A	302	event_t wake_event,
9bccf70c	303	wait_result_t result);
1c79356b A	304
1c79356b A	305	/* wakeup all the threads waiting on <wait_queue,event> pair */
9bccf70c	306	extern kern_return_t wait_queue_wakeup_all(
1c79356b A	307	wait_queue_t wait_queue,
1c79356b A	308	event_t wake_event,
9bccf70c	309	wait_result_t result);
1c79356b A	310
1c79356b A	311	/* wakeup a specified thread waiting iff waiting on <wait_queue,event> pair */
9bccf70c	312	extern kern_return_t wait_queue_wakeup_thread(
1c79356b A	313	wait_queue_t wait_queue,
	314	event_t wake_event,
	315	thread_t thread,
9bccf70c A	316	wait_result_t result);
	317
	318	#endif /* __APPLE_API_PRIVATE */
1c79356b A	319
1c79356b A	320	#endif /* _KERN_WAIT_QUEUE_H_ */