[apple/xnu.git] / osfmk / kern / kern_types.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@
 */
/*
 * @OSF_COPYRIGHT@
 */

#ifndef	_KERN_KERN_TYPES_H_
#define	_KERN_KERN_TYPES_H_

#include <stdint.h>
#include <mach/mach_types.h>
#include <mach/machine/vm_types.h>

#ifdef	KERNEL_PRIVATE

#ifndef	MACH_KERNEL_PRIVATE

struct zone ;

struct wait_queue { unsigned int opaque[2]; uintptr_t opaquep[2]; } ;

#endif	/* MACH_KERNEL_PRIVATE */

typedef struct zone			*zone_t;
#define		ZONE_NULL			((zone_t) 0)

typedef struct wait_queue		*wait_queue_t;
#define		WAIT_QUEUE_NULL 	((wait_queue_t) 0)
#define 		SIZEOF_WAITQUEUE	sizeof(struct wait_queue)

typedef vm_offset_t			ipc_kobject_t;
#define		IKO_NULL			((ipc_kobject_t) 0)

#endif	/* KERNEL_PRIVATE */

typedef	void *event_t;		/* wait event */
#define		NO_EVENT			((event_t) 0)

typedef uint64_t event64_t;		/* 64 bit wait event */
#define		NO_EVENT64		((event64_t) 0)

/*
 *	Possible wait_result_t values.
 */
typedef int wait_result_t;
#define THREAD_WAITING		-1		/* thread is waiting */
#define THREAD_AWAKENED		0		/* normal wakeup */
#define THREAD_TIMED_OUT	1		/* timeout expired */
#define THREAD_INTERRUPTED	2		/* aborted/interrupted */
#define THREAD_RESTART		3		/* restart operation entirely */


typedef	void (*thread_continue_t)(void *, wait_result_t);
#define	THREAD_CONTINUE_NULL	((thread_continue_t) 0)

/*
 * Interruptible flag for waits.
 */
typedef int wait_interrupt_t;
#define THREAD_UNINT			0		/* not interruptible      */
#define THREAD_INTERRUPTIBLE	1		/* may not be restartable */
#define THREAD_ABORTSAFE		2		/* abortable safely       */

#ifdef	KERNEL_PRIVATE

#ifdef	MACH_KERNEL_PRIVATE

#include <kern/misc_protos.h>
typedef  struct clock			*clock_t;

typedef struct mig_object		*mig_object_t;
#define MIG_OBJECT_NULL			((mig_object_t) 0)

typedef struct mig_notify		*mig_notify_t;
#define MIG_NOTIFY_NULL 		((mig_notify_t) 0)

typedef boolean_t				(*thread_roust_t)(thread_t, wait_result_t);
#define THREAD_ROUST_NULL	 	((thread_roust_t) 0)

#else	/* MACH_KERNEL_PRIVATE */

struct wait_queue_set ;
struct wait_queue_link ;

#endif	/* MACH_KERNEL_PRIVATE */

typedef struct wait_queue_set	*wait_queue_set_t;
#define WAIT_QUEUE_SET_NULL 	((wait_queue_set_t)0)
#define SIZEOF_WAITQUEUE_SET	wait_queue_set_size()

typedef struct wait_queue_link	*wait_queue_link_t;
#define WAIT_QUEUE_LINK_NULL	((wait_queue_link_t)0)
#define SIZEOF_WAITQUEUE_LINK	wait_queue_link_size()

/* legacy definitions - going away */
struct wait_queue_sub ;
typedef struct wait_queue_sub	*wait_queue_sub_t;
#define WAIT_QUEUE_SUB_NULL 	((wait_queue_sub_t)0)
#define SIZEOF_WAITQUEUE_SUB	wait_queue_set_size()

#endif	/* KERNEL_PRIVATE */

#endif	/* _KERN_KERN_TYPES_H_ */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
8f6c56a5 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.
	14	*
	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
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* @OSF_COPYRIGHT@
	30	*/
	31
	32	#ifndef _KERN_KERN_TYPES_H_
	33	#define _KERN_KERN_TYPES_H_
	34
0b4e3aa0	35	#include <stdint.h>
9bccf70c	36	#include <mach/mach_types.h>
1c79356b	37	#include <mach/machine/vm_types.h>
9bccf70c	38
91447636	39	#ifdef KERNEL_PRIVATE
1c79356b	40
91447636	41	#ifndef MACH_KERNEL_PRIVATE
9bccf70c	42
1c79356b	43	struct zone ;
9bccf70c	44
91447636	45	struct wait_queue { unsigned int opaque[2]; uintptr_t opaquep[2]; } ;
9bccf70c	46
91447636	47	#endif /* MACH_KERNEL_PRIVATE */
1c79356b	48
9bccf70c A	49	typedef struct zone *zone_t;
	50	#define ZONE_NULL ((zone_t) 0)
	51
	52	typedef struct wait_queue *wait_queue_t;
	53	#define WAIT_QUEUE_NULL ((wait_queue_t) 0)
	54	#define SIZEOF_WAITQUEUE sizeof(struct wait_queue)
	55
	56	typedef vm_offset_t ipc_kobject_t;
	57	#define IKO_NULL ((ipc_kobject_t) 0)
	58
91447636 A	59	#endif /* KERNEL_PRIVATE */
91447636 A	60
9bccf70c A	61	typedef void event_t; / wait event */
	62	#define NO_EVENT ((event_t) 0)
	63
	64	typedef uint64_t event64_t; /* 64 bit wait event */
	65	#define NO_EVENT64 ((event64_t) 0)
	66
	67	/*
	68	* Possible wait_result_t values.
	69	*/
	70	typedef int wait_result_t;
	71	#define THREAD_WAITING -1 /* thread is waiting */
	72	#define THREAD_AWAKENED 0 /* normal wakeup */
	73	#define THREAD_TIMED_OUT 1 /* timeout expired */
	74	#define THREAD_INTERRUPTED 2 /* aborted/interrupted */
	75	#define THREAD_RESTART 3 /* restart operation entirely */
	76
	77
91447636	78	typedef void (thread_continue_t)(void , wait_result_t);
9bccf70c A	79	#define THREAD_CONTINUE_NULL ((thread_continue_t) 0)
	80
	81	/*
	82	* Interruptible flag for waits.
	83	*/
	84	typedef int wait_interrupt_t;
	85	#define THREAD_UNINT 0 /* not interruptible */
	86	#define THREAD_INTERRUPTIBLE 1 /* may not be restartable */
	87	#define THREAD_ABORTSAFE 2 /* abortable safely */
	88
91447636	89	#ifdef KERNEL_PRIVATE
9bccf70c A	90
9bccf70c A	91	#ifdef MACH_KERNEL_PRIVATE
1c79356b A	92
1c79356b A	93	#include <kern/misc_protos.h>
9bccf70c	94	typedef struct clock *clock_t;
1c79356b	95
91447636 A	96	typedef struct mig_object *mig_object_t;
	97	#define MIG_OBJECT_NULL ((mig_object_t) 0)
	98
	99	typedef struct mig_notify *mig_notify_t;
	100	#define MIG_NOTIFY_NULL ((mig_notify_t) 0)
9bccf70c	101
91447636 A	102	typedef boolean_t (*thread_roust_t)(thread_t, wait_result_t);
	103	#define THREAD_ROUST_NULL ((thread_roust_t) 0)
	104
	105	#else /* MACH_KERNEL_PRIVATE */
9bccf70c	106
9bccf70c A	107	struct wait_queue_set ;
9bccf70c A	108	struct wait_queue_link ;
91447636 A	109
91447636 A	110	#endif /* MACH_KERNEL_PRIVATE */
9bccf70c A	111
	112	typedef struct wait_queue_set *wait_queue_set_t;
	113	#define WAIT_QUEUE_SET_NULL ((wait_queue_set_t)0)
	114	#define SIZEOF_WAITQUEUE_SET wait_queue_set_size()
	115
	116	typedef struct wait_queue_link *wait_queue_link_t;
	117	#define WAIT_QUEUE_LINK_NULL ((wait_queue_link_t)0)
	118	#define SIZEOF_WAITQUEUE_LINK wait_queue_link_size()
1c79356b	119
9bccf70c A	120	/* legacy definitions - going away */
	121	struct wait_queue_sub ;
	122	typedef struct wait_queue_sub *wait_queue_sub_t;
	123	#define WAIT_QUEUE_SUB_NULL ((wait_queue_sub_t)0)
	124	#define SIZEOF_WAITQUEUE_SUB wait_queue_set_size()
1c79356b	125
91447636	126	#endif /* KERNEL_PRIVATE */
1c79356b A	127
1c79356b A	128	#endif /* _KERN_KERN_TYPES_H_ */