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

/*
 * Copyright (c) 1993-1995, 1999-2008 Apple 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@
 */
/*
 * Declarations for thread-based callouts.
 */

#ifndef _KERN_THREAD_CALL_H_
#define _KERN_THREAD_CALL_H_

#include <mach/mach_types.h>

#include <kern/clock.h>

#include <sys/cdefs.h>

typedef struct call_entry	*thread_call_t;
typedef void				*thread_call_param_t;
typedef void				(*thread_call_func_t)(
									thread_call_param_t		param0,
									thread_call_param_t		param1);
__BEGIN_DECLS

extern boolean_t	thread_call_enter(
						thread_call_t		call);

extern boolean_t	thread_call_enter1(
						thread_call_t			call,
						thread_call_param_t		param1);

extern boolean_t	thread_call_enter_delayed(
						thread_call_t		call,
						uint64_t			deadline);

extern boolean_t	thread_call_enter1_delayed(
						thread_call_t			call,
						thread_call_param_t		param1,
						uint64_t				deadline);

extern boolean_t	thread_call_cancel(
						thread_call_t		call);

extern thread_call_t	thread_call_allocate(
							thread_call_func_t		func,
							thread_call_param_t		param0);

extern boolean_t		thread_call_free(
							thread_call_t		call);

__END_DECLS

#ifdef	MACH_KERNEL_PRIVATE

#include <kern/call_entry.h>

typedef struct call_entry	thread_call_data_t;

extern void		thread_call_initialize(void);

extern void		thread_call_setup(
					thread_call_t			call,
					thread_call_func_t		func,
					thread_call_param_t		param0);

#endif	/* MACH_KERNEL_PRIVATE */

#ifdef	KERNEL_PRIVATE

__BEGIN_DECLS

/*
 * Obsolete interfaces.
 */

extern boolean_t	thread_call_is_delayed(
						thread_call_t		call,
						uint64_t			*deadline);

extern void		thread_call_func(
					thread_call_func_t		func,
					thread_call_param_t		param,
					boolean_t				unique_call);

extern void		thread_call_func_delayed(
					thread_call_func_t		func,
					thread_call_param_t		param,
					uint64_t				deadline);

extern boolean_t	thread_call_func_cancel(
						thread_call_func_t		func,
						thread_call_param_t		param,
						boolean_t				cancel_all);

#ifndef	MACH_KERNEL_PRIVATE

#ifndef	ABSOLUTETIME_SCALAR_TYPE

#define thread_call_enter_delayed(a, b)	\
	thread_call_enter_delayed((a), __OSAbsoluteTime(b))

#define thread_call_enter1_delayed(a, b, c)	\
	thread_call_enter1_delayed((a), (b), __OSAbsoluteTime(c))

#define thread_call_is_delayed(a, b)	\
	thread_call_is_delayed((a), __OSAbsoluteTimePtr(b))

#define thread_call_func_delayed(a, b, c)	\
	thread_call_func_delayed((a), (b), __OSAbsoluteTime(c))

#endif	/* ABSOLUTETIME_SCALAR_TYPE */

#endif	/* MACH_KERNEL_PRIVATE */

__END_DECLS

#endif	/* KERNEL_PRIVATE */

#endif	/* _KERN_THREAD_CALL_H_ */
Commit	Line	Data
1c79356b	1	/*
c910b4d9	2	* Copyright (c) 1993-1995, 1999-2008 Apple Inc. All rights reserved.
1c79356b	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	* Declarations for thread-based callouts.
1c79356b A	30	*/
	31
	32	#ifndef _KERN_THREAD_CALL_H_
	33	#define _KERN_THREAD_CALL_H_
	34
1c79356b A	35	#include <mach/mach_types.h>
1c79356b A	36
0b4e3aa0 A	37	#include <kern/clock.h>
0b4e3aa0 A	38
91447636 A	39	#include <sys/cdefs.h>
91447636 A	40
1c79356b A	41	typedef struct call_entry *thread_call_t;
	42	typedef void *thread_call_param_t;
	43	typedef void (*thread_call_func_t)(
	44	thread_call_param_t param0,
	45	thread_call_param_t param1);
91447636	46	__BEGIN_DECLS
1c79356b	47
c910b4d9 A	48	extern boolean_t thread_call_enter(
	49	thread_call_t call);
	50
	51	extern boolean_t thread_call_enter1(
	52	thread_call_t call,
	53	thread_call_param_t param1);
	54
	55	extern boolean_t thread_call_enter_delayed(
	56	thread_call_t call,
	57	uint64_t deadline);
	58
	59	extern boolean_t thread_call_enter1_delayed(
	60	thread_call_t call,
	61	thread_call_param_t param1,
	62	uint64_t deadline);
	63
	64	extern boolean_t thread_call_cancel(
	65	thread_call_t call);
	66
	67	extern thread_call_t thread_call_allocate(
	68	thread_call_func_t func,
	69	thread_call_param_t param0);
	70
	71	extern boolean_t thread_call_free(
	72	thread_call_t call);
1c79356b	73
91447636 A	74	__END_DECLS
	75
	76	#ifdef MACH_KERNEL_PRIVATE
	77
	78	#include <kern/call_entry.h>
	79
	80	typedef struct call_entry thread_call_data_t;
	81
c910b4d9	82	extern void thread_call_initialize(void);
91447636	83
c910b4d9 A	84	extern void thread_call_setup(
	85	thread_call_t call,
	86	thread_call_func_t func,
	87	thread_call_param_t param0);
91447636	88
91447636 A	89	#endif /* MACH_KERNEL_PRIVATE */
	90
	91	#ifdef KERNEL_PRIVATE
9bccf70c	92
91447636	93	__BEGIN_DECLS
9bccf70c	94
1c79356b	95	/*
91447636	96	* Obsolete interfaces.
1c79356b	97	*/
9bccf70c	98
c910b4d9 A	99	extern boolean_t thread_call_is_delayed(
	100	thread_call_t call,
	101	uint64_t *deadline);
	102
	103	extern void thread_call_func(
	104	thread_call_func_t func,
	105	thread_call_param_t param,
	106	boolean_t unique_call);
	107
	108	extern void thread_call_func_delayed(
	109	thread_call_func_t func,
	110	thread_call_param_t param,
	111	uint64_t deadline);
	112
	113	extern boolean_t thread_call_func_cancel(
	114	thread_call_func_t func,
	115	thread_call_param_t param,
	116	boolean_t cancel_all);
9bccf70c	117
91447636	118	#ifndef MACH_KERNEL_PRIVATE
9bccf70c	119
91447636	120	#ifndef ABSOLUTETIME_SCALAR_TYPE
0b4e3aa0 A	121
	122	#define thread_call_enter_delayed(a, b) \
	123	thread_call_enter_delayed((a), __OSAbsoluteTime(b))
	124
	125	#define thread_call_enter1_delayed(a, b, c) \
	126	thread_call_enter1_delayed((a), (b), __OSAbsoluteTime(c))
	127
	128	#define thread_call_is_delayed(a, b) \
	129	thread_call_is_delayed((a), __OSAbsoluteTimePtr(b))
	130
	131	#define thread_call_func_delayed(a, b, c) \
	132	thread_call_func_delayed((a), (b), __OSAbsoluteTime(c))
	133
91447636 A	134	#endif /* ABSOLUTETIME_SCALAR_TYPE */
	135
	136	#endif /* MACH_KERNEL_PRIVATE */
	137
	138	__END_DECLS
	139
	140	#endif /* KERNEL_PRIVATE */
0b4e3aa0	141
91447636	142	#endif /* _KERN_THREAD_CALL_H_ */