1/*
2 * Copyright (c) 2000-2010 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
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
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/*
29 * @OSF_COPYRIGHT@
30 */
31/*
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University
34 * All Rights Reserved.
35 *
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
41 *
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45 *
46 * Carnegie Mellon requests users of this software to return to
47 *
48 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
49 *  School of Computer Science
50 *  Carnegie Mellon University
51 *  Pittsburgh PA 15213-3890
52 *
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
55 */
56/*
57 */
58/*
59 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
60 * support for mandatory and extensible security protections.  This notice
61 * is included in support of clause 2.2 (b) of the Apple Public License,
62 * Version 2.0.
63 */
64/*
65 *	File:	mach/mach_types.h
66 *	Author:	Avadis Tevanian, Jr., Michael Wayne Young
67 *	Date:	1986
68 *
69 *	Mach external interface definitions.
70 *
71 */
72
73#ifndef	_MACH_MACH_TYPES_H_
74#define _MACH_MACH_TYPES_H_
75
76#include <stdint.h>
77
78#include <sys/cdefs.h>
79
80#include <mach/host_info.h>
81#include <mach/host_notify.h>
82#include <mach/host_special_ports.h>
83#include <mach/machine.h>
84#include <mach/machine/vm_types.h>
85#include <mach/memory_object_types.h>
86#include <mach/message.h>
87#include <mach/exception_types.h>
88#include <mach/port.h>
89#include <mach/processor_info.h>
90#include <mach/task_info.h>
91#include <mach/task_policy.h>
92#include <mach/task_special_ports.h>
93#include <mach/thread_info.h>
94#include <mach/thread_policy.h>
95#include <mach/thread_special_ports.h>
96#include <mach/thread_status.h>
97#include <mach/time_value.h>
98#include <mach/clock_types.h>
99#include <mach/vm_attributes.h>
100#include <mach/vm_inherit.h>
101#include <mach/vm_purgable.h>
102#include <mach/vm_behavior.h>
103#include <mach/vm_prot.h>
104#include <mach/vm_statistics.h>
105#include <mach/vm_sync.h>
106#include <mach/vm_types.h>
107#include <mach/vm_region.h>
108#include <mach/kmod.h>
109
110#ifdef	KERNEL
111
112#include <mach/vm_param.h>
113
114/*
115 * If we are in the kernel, then pick up the kernel definitions for
116 * the basic mach types.
117 */
118typedef struct task			*task_t, *task_name_t, *task_suspension_token_t;
119typedef struct thread		*thread_t, *thread_act_t;
120typedef struct ipc_space		*ipc_space_t;
121typedef struct host			*host_t;
122typedef struct host			*host_priv_t;
123typedef struct host			*host_security_t;
124typedef struct processor		*processor_t;
125typedef struct processor_set		*processor_set_t;
126typedef struct processor_set		*processor_set_control_t;
127typedef struct semaphore 		*semaphore_t;
128typedef struct ledger 			*ledger_t;
129typedef	struct alarm			*alarm_t;
130typedef	struct clock			*clock_serv_t;
131typedef	struct clock			*clock_ctrl_t;
132
133/*
134 * OBSOLETE: lock_set interfaces are obsolete.
135 */
136typedef struct lock_set 		*lock_set_t;
137struct lock_set ;
138
139#ifndef	MACH_KERNEL_PRIVATE
140
141__BEGIN_DECLS
142
143struct task ;
144struct thread ;
145struct host ;
146struct processor ;
147struct processor_set ;
148struct semaphore ;
149struct ledger ;
150struct alarm ;
151struct clock ;
152
153__END_DECLS
154
155#endif	/* MACH_KERNEL_PRIVATE */
156
157#else	/* KERNEL */
158
159/*
160 * If we are not in the kernel, then these will all be represented by
161 * ports at user-space.
162 */
163typedef mach_port_t		task_t;
164typedef mach_port_t		task_name_t;
165typedef mach_port_t		task_suspension_token_t;
166typedef mach_port_t		thread_t;
167typedef	mach_port_t		thread_act_t;
168typedef mach_port_t		ipc_space_t;
169typedef mach_port_t		host_t;
170typedef mach_port_t		host_priv_t;
171typedef mach_port_t		host_security_t;
172typedef mach_port_t		processor_t;
173typedef mach_port_t		processor_set_t;
174typedef mach_port_t		processor_set_control_t;
175typedef mach_port_t		semaphore_t;
176typedef mach_port_t		lock_set_t;
177typedef mach_port_t		ledger_t;
178typedef mach_port_t		alarm_t;
179typedef mach_port_t		clock_serv_t;
180typedef mach_port_t		clock_ctrl_t;
181
182#endif	/* KERNEL */
183
184/*
185 * These aren't really unique types.  They are just called
186 * out as unique types at one point in history.  So we list
187 * them here for compatibility.
188 */
189typedef processor_set_t		processor_set_name_t;
190
191/*
192 * These types are just hard-coded as ports
193 */
194typedef mach_port_t		clock_reply_t;
195typedef mach_port_t		bootstrap_t;
196typedef	mach_port_t		mem_entry_name_port_t;
197typedef mach_port_t		exception_handler_t;
198typedef exception_handler_t	*exception_handler_array_t;
199typedef mach_port_t		vm_task_entry_t;
200typedef mach_port_t		io_master_t;
201typedef mach_port_t		UNDServerRef;
202
203/*
204 * Mig doesn't translate the components of an array.
205 * For example, Mig won't use the thread_t translations
206 * to translate a thread_array_t argument.  So, these definitions
207 * are not completely accurate at the moment for other kernel
208 * components.
209 */
210typedef task_t			*task_array_t;
211typedef thread_t		*thread_array_t;
212typedef processor_set_t		*processor_set_array_t;
213typedef processor_set_t		*processor_set_name_array_t;
214typedef processor_t		*processor_array_t;
215typedef	thread_act_t		*thread_act_array_t;
216typedef ledger_t		*ledger_array_t;
217
218/*
219 * However the real mach_types got declared, we also have to declare
220 * types with "port" in the name for compatability with the way OSF
221 * had declared the user interfaces at one point.  Someday these should
222 * go away.
223 */
224typedef task_t			task_port_t;
225typedef	task_array_t		task_port_array_t;
226typedef thread_t		thread_port_t;
227typedef	thread_array_t		thread_port_array_t;
228typedef ipc_space_t		ipc_space_port_t;
229typedef host_t			host_name_t;
230typedef host_t			host_name_port_t;
231typedef processor_set_t		processor_set_port_t;
232typedef processor_set_t		processor_set_name_port_t;
233typedef processor_set_array_t	processor_set_name_port_array_t;
234typedef processor_set_t		processor_set_control_port_t;
235typedef processor_t		processor_port_t;
236typedef processor_array_t	processor_port_array_t;
237typedef thread_act_t		thread_act_port_t;
238typedef	thread_act_array_t	thread_act_port_array_t;
239typedef semaphore_t		semaphore_port_t;
240typedef lock_set_t		lock_set_port_t;
241typedef ledger_t		ledger_port_t;
242typedef ledger_array_t		ledger_port_array_t;
243typedef alarm_t			alarm_port_t;
244typedef clock_serv_t		clock_serv_port_t;
245typedef clock_ctrl_t		clock_ctrl_port_t;
246typedef exception_handler_t	exception_port_t;
247typedef exception_handler_array_t exception_port_arrary_t;
248
249
250#define TASK_NULL		((task_t) 0)
251#define TASK_NAME_NULL		((task_name_t) 0)
252#define THREAD_NULL		((thread_t) 0)
253#define TID_NULL		((uint64_t) 0)
254#define THR_ACT_NULL 		((thread_act_t) 0)
255#define IPC_SPACE_NULL		((ipc_space_t) 0)
256#define HOST_NULL		((host_t) 0)
257#define HOST_PRIV_NULL		((host_priv_t)0)
258#define HOST_SECURITY_NULL	((host_security_t)0)
259#define PROCESSOR_SET_NULL	((processor_set_t) 0)
260#define PROCESSOR_NULL		((processor_t) 0)
261#define SEMAPHORE_NULL		((semaphore_t) 0)
262#define LOCK_SET_NULL		((lock_set_t) 0)
263#define LEDGER_NULL 		((ledger_t) 0)
264#define ALARM_NULL		((alarm_t) 0)
265#define CLOCK_NULL		((clock_t) 0)
266#define UND_SERVER_NULL		((UNDServerRef) 0)
267
268/* DEPRECATED */
269typedef natural_t	ledger_item_t;
270#define LEDGER_ITEM_INFINITY	((ledger_item_t) (~0))
271
272typedef int64_t 		ledger_amount_t;
273#define LEDGER_LIMIT_INFINITY   ((ledger_amount_t)((1ULL << 63) - 1))
274
275typedef mach_vm_offset_t	*emulation_vector_t;
276typedef char			*user_subsystem_t;
277
278typedef char			*labelstr_t;
279/*
280 *	Backwards compatibility, for those programs written
281 *	before mach/{std,mach}_types.{defs,h} were set up.
282 */
283#include <mach/std_types.h>
284
285#endif	/* _MACH_MACH_TYPES_H_ */
286