1/*
2 * Copyright (c) 2000-2005 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 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 * File: mach_debug/ipc_info.h
60 * Author: Rich Draves
61 * Date: March, 1990
62 *
63 * Definitions for the IPC debugging interface.
64 */
65
66#ifndef _MACH_DEBUG_IPC_INFO_H_
67#define _MACH_DEBUG_IPC_INFO_H_
68
69#include <mach/boolean.h>
70#include <mach/port.h>
71#include <mach/machine/vm_types.h>
72
73/*!
74 * @brief
75 * Type for mach_port_kobject_description() only.
76 *
77 * @discussion
78 * This type preserved the `IOT_*` values that @c ipc_kobject_type_t used
79 * to carry, whose ABI of this type was known to debugging tools of userspace,
80 * by copying XNU's source.
81 *
82 * This provides a guaranteed stable interface now (however no guarantee
83 * is made that values are still in use).
84 *
85 * Values should never be removed to that list, merely abandonned with
86 * a comment.
87 */
88__enum_decl(ipc_info_object_type_t, natural_t, {
89 IPC_OTYPE_NONE = 0,
90 IPC_OTYPE_THREAD_CONTROL = 1,
91 IPC_OTYPE_TASK_CONTROL = 2,
92 IPC_OTYPE_HOST = 3,
93 IPC_OTYPE_HOST_PRIV = 4,
94 IPC_OTYPE_PROCESSOR = 5,
95 IPC_OTYPE_PROCESSOR_SET = 6,
96 IPC_OTYPE_PROCESSOR_SET_NAME = 7,
97 IPC_OTYPE_TIMER = 8,
98 IPC_OTYPE_PORT_SUBST_ONCE = 9, /* obsolete: no instances */
99 IPC_OTYPE_MIG = 10, /* obsolete: no instances */
100 IPC_OTYPE_MEMORY_OBJECT = 11, /* no port instances */
101 IPC_OTYPE_XMM_PAGER = 12, /* obsolete: no instances */
102 IPC_OTYPE_XMM_KERNEL = 13, /* obsolete: no instances */
103 IPC_OTYPE_XMM_REPLY = 14, /* obsolete: no instances */
104 IPC_OTYPE_UND_REPLY = 15,
105 IPC_OTYPE_HOST_NOTIFY = 16, /* obsolete: no instances */
106 IPC_OTYPE_HOST_SECURITY = 17, /* obsolete: no instances */
107 IPC_OTYPE_LEDGER = 18, /* obsolete: no instances */
108 IPC_OTYPE_MAIN_DEVICE = 19,
109 IPC_OTYPE_TASK_NAME = 20,
110 IPC_OTYPE_SUBSYSTEM = 21, /* obsolete: no instances */
111 IPC_OTYPE_IO_DONE_QUEUE = 22, /* obsolete: no instances */
112 IPC_OTYPE_SEMAPHORE = 23,
113 IPC_OTYPE_LOCK_SET = 24, /* obsolete: no instances */
114 IPC_OTYPE_CLOCK = 25,
115 IPC_OTYPE_CLOCK_CTRL = 26, /* obsolete: no instances */
116 IPC_OTYPE_IOKIT_IDENT = 27,
117 IPC_OTYPE_NAMED_ENTRY = 28,
118 IPC_OTYPE_IOKIT_CONNECT = 29,
119 IPC_OTYPE_IOKIT_OBJECT = 30,
120 IPC_OTYPE_UPL = 31, /* obsolete: no instances */
121 IPC_OTYPE_MEM_OBJ_CONTROL = 32, /* obsolete: no instances */
122 IPC_OTYPE_AU_SESSIONPORT = 33,
123 IPC_OTYPE_FILEPORT = 34,
124 IPC_OTYPE_LABELH = 35, /* obsolete: no instances */
125 IPC_OTYPE_TASK_RESUME = 36,
126 IPC_OTYPE_VOUCHER = 37,
127 IPC_OTYPE_VOUCHER_ATTR_CONTROL = 38, /* obsolete: no instances */
128 IPC_OTYPE_WORK_INTERVAL = 39,
129 IPC_OTYPE_UX_HANDLER = 40,
130 IPC_OTYPE_UEXT_OBJECT = 41,
131 IPC_OTYPE_ARCADE_REG = 42,
132 IPC_OTYPE_EVENTLINK = 43,
133 IPC_OTYPE_TASK_INSPECT = 44,
134 IPC_OTYPE_TASK_READ = 45,
135 IPC_OTYPE_THREAD_INSPECT = 46,
136 IPC_OTYPE_THREAD_READ = 47,
137 IPC_OTYPE_SUID_CRED = 48, /* obsolete: no instances */
138 IPC_OTYPE_HYPERVISOR = 49,
139 IPC_OTYPE_TASK_ID_TOKEN = 50,
140 IPC_OTYPE_TASK_FATAL = 51,
141 IPC_OTYPE_KCDATA = 52,
142 IPC_OTYPE_EXCLAVES_RESOURCE = 53,
143 IPC_OTYPE_THREAD_RESUME = 54,
144
145 /* catchall */
146 IPC_OTYPE_UNKNOWN = ~0u,
147});
148
149/*
150 * Remember to update the mig type definitions
151 * in mach_debug_types.defs when adding/removing fields.
152 */
153
154typedef struct ipc_info_space {
155 natural_t iis_genno_mask; /* generation number mask */
156 natural_t iis_table_size; /* size of table */
157 natural_t iis_table_next; /* next possible size of table (UNUSED) */
158 natural_t iis_tree_size; /* size of tree (UNUSED) */
159 natural_t iis_tree_small; /* # of small entries in tree (UNUSED) */
160 natural_t iis_tree_hash; /* # of hashed entries in tree (UNUSED) */
161} ipc_info_space_t;
162
163typedef struct ipc_info_space_basic {
164 natural_t iisb_genno_mask; /* generation number mask */
165 natural_t iisb_table_size; /* size of table */
166 natural_t iisb_table_next; /* next possible size of table (UNUSED) */
167 natural_t iisb_table_inuse; /* number of entries in use */
168 natural_t iisb_reserved[2]; /* future expansion */
169} ipc_info_space_basic_t;
170
171typedef struct ipc_info_name {
172 mach_port_name_t iin_name; /* port name, including gen number */
173/*boolean_t*/ integer_t iin_collision; /* collision at this entry? */
174 mach_port_type_t iin_type; /* straight port type */
175 mach_port_urefs_t iin_urefs; /* user-references */
176 natural_t iin_object; /* object pointer/identifier */
177 natural_t iin_next; /* marequest/next in free list */
178 natural_t iin_hash; /* hash index */
179} ipc_info_name_t;
180
181typedef ipc_info_name_t *ipc_info_name_array_t;
182
183/* UNUSED */
184typedef struct ipc_info_tree_name {
185 ipc_info_name_t iitn_name;
186 mach_port_name_t iitn_lchild; /* name of left child */
187 mach_port_name_t iitn_rchild; /* name of right child */
188} ipc_info_tree_name_t;
189
190typedef ipc_info_tree_name_t *ipc_info_tree_name_array_t;
191
192typedef struct ipc_info_port {
193 natural_t iip_port_object; /* port object identifier */
194 natural_t iip_receiver_object; /* receiver task identifier (if any) */
195} ipc_info_port_t;
196
197typedef ipc_info_port_t *exception_handler_info_array_t;
198
199#endif /* _MACH_DEBUG_IPC_INFO_H_ */