xref: /xnu-10002.1.13/osfmk/mach/host_special_ports.h (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1 /*
2  * Copyright (c) 2003 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 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  [email protected]
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/host_special_ports.h
60  *
61  *	Defines codes for access to host-wide special ports.
62  */
63 
64 #ifndef _MACH_HOST_SPECIAL_PORTS_H_
65 #define _MACH_HOST_SPECIAL_PORTS_H_
66 
67 /*
68  * Cannot be set or gotten from user space
69  */
70 #define HOST_SECURITY_PORT               0
71 
72 #define HOST_MIN_SPECIAL_PORT            HOST_SECURITY_PORT
73 
74 /*
75  * Always provided by kernel (cannot be set from user-space).
76  */
77 #define HOST_PORT                        1
78 #define HOST_PRIV_PORT                   2
79 #define HOST_IO_MAIN_PORT                3
80 #define HOST_MAX_SPECIAL_KERNEL_PORT     7 /* room to grow */
81 
82 #define HOST_LAST_SPECIAL_KERNEL_PORT    HOST_IO_MAIN_PORT
83 
84 /*
85  * Not provided by kernel
86  */
87 #define HOST_DYNAMIC_PAGER_PORT         (1 + HOST_MAX_SPECIAL_KERNEL_PORT)
88 #define HOST_AUDIT_CONTROL_PORT         (2 + HOST_MAX_SPECIAL_KERNEL_PORT)
89 #define HOST_USER_NOTIFICATION_PORT     (3 + HOST_MAX_SPECIAL_KERNEL_PORT)
90 #define HOST_AUTOMOUNTD_PORT            (4 + HOST_MAX_SPECIAL_KERNEL_PORT)
91 #define HOST_LOCKD_PORT                 (5 + HOST_MAX_SPECIAL_KERNEL_PORT)
92 #define HOST_KTRACE_BACKGROUND_PORT     (6 + HOST_MAX_SPECIAL_KERNEL_PORT)
93 #define HOST_SEATBELT_PORT              (7 + HOST_MAX_SPECIAL_KERNEL_PORT)
94 #define HOST_KEXTD_PORT                 (8 + HOST_MAX_SPECIAL_KERNEL_PORT)
95 #define HOST_LAUNCHCTL_PORT             (9 + HOST_MAX_SPECIAL_KERNEL_PORT)
96 #define HOST_UNFREED_PORT               (10 + HOST_MAX_SPECIAL_KERNEL_PORT)
97 #define HOST_AMFID_PORT                 (11 + HOST_MAX_SPECIAL_KERNEL_PORT)
98 #define HOST_GSSD_PORT                  (12 + HOST_MAX_SPECIAL_KERNEL_PORT)
99 #define HOST_TELEMETRY_PORT             (13 + HOST_MAX_SPECIAL_KERNEL_PORT)
100 #define HOST_ATM_NOTIFICATION_PORT      (14 + HOST_MAX_SPECIAL_KERNEL_PORT)
101 #define HOST_COALITION_PORT             (15 + HOST_MAX_SPECIAL_KERNEL_PORT)
102 #define HOST_SYSDIAGNOSE_PORT           (16 + HOST_MAX_SPECIAL_KERNEL_PORT)
103 #define HOST_XPC_EXCEPTION_PORT         (17 + HOST_MAX_SPECIAL_KERNEL_PORT)
104 #define HOST_CONTAINERD_PORT            (18 + HOST_MAX_SPECIAL_KERNEL_PORT)
105 #define HOST_NODE_PORT                  (19 + HOST_MAX_SPECIAL_KERNEL_PORT)
106 #define HOST_RESOURCE_NOTIFY_PORT       (20 + HOST_MAX_SPECIAL_KERNEL_PORT)
107 #define HOST_CLOSURED_PORT              (21 + HOST_MAX_SPECIAL_KERNEL_PORT)
108 #define HOST_SYSPOLICYD_PORT            (22 + HOST_MAX_SPECIAL_KERNEL_PORT)
109 #define HOST_FILECOORDINATIOND_PORT     (23 + HOST_MAX_SPECIAL_KERNEL_PORT)
110 #define HOST_FAIRPLAYD_PORT             (24 + HOST_MAX_SPECIAL_KERNEL_PORT)
111 #define HOST_IOCOMPRESSIONSTATS_PORT    (25 + HOST_MAX_SPECIAL_KERNEL_PORT)
112 #define HOST_MEMORY_ERROR_PORT          (26 + HOST_MAX_SPECIAL_KERNEL_PORT)
113 
114 #define HOST_MAX_SPECIAL_PORT           HOST_MEMORY_ERROR_PORT
115 /* MAX = last since rdar://59872249 */
116 
117 /* obsolete name */
118 #define HOST_CHUD_PORT HOST_LAUNCHCTL_PORT
119 
120 /*
121  * Special node identifier to always represent the local node.
122  */
123 #define HOST_LOCAL_NODE                  -1
124 
125 /*
126  * Definitions for ease of use.
127  *
128  * In the get call, the host parameter can be any host, but will generally
129  * be the local node host port. In the set call, the host must the per-node
130  * host port for the node being affected.
131  */
132 #define host_get_host_port(host, port)  \
133 	(host_get_special_port((host),  \
134 	HOST_LOCAL_NODE, HOST_PORT, (port)))
135 #define host_set_host_port(host, port) (KERN_INVALID_ARGUMENT)
136 
137 #define host_get_host_priv_port(host, port)     \
138 	(host_get_special_port((host),          \
139 	HOST_LOCAL_NODE, HOST_PRIV_PORT, (port)))
140 #define host_set_host_priv_port(host, port) (KERN_INVALID_ARGUMENT)
141 
142 #define host_get_io_main_port(host, port)     \
143 	(host_get_special_port((host),          \
144 	HOST_LOCAL_NODE, HOST_IO_MAIN_PORT, (port)))
145 #define host_set_io_main_port(host, port) (KERN_INVALID_ARGUMENT)
146 
147 /*
148  * User-settable special ports.
149  */
150 #define host_get_dynamic_pager_port(host, port) \
151 	(host_get_special_port((host),                  \
152 	HOST_LOCAL_NODE, HOST_DYNAMIC_PAGER_PORT, (port)))
153 #define host_set_dynamic_pager_port(host, port) \
154 	(host_set_special_port((host), HOST_DYNAMIC_PAGER_PORT, (port)))
155 
156 #define host_get_audit_control_port(host, port) \
157 	(host_get_special_port((host),          \
158 	HOST_LOCAL_NODE, HOST_AUDIT_CONTROL_PORT, (port)))
159 #define host_set_audit_control_port(host, port) \
160 	(host_set_special_port((host), HOST_AUDIT_CONTROL_PORT, (port)))
161 
162 #define host_get_user_notification_port(host, port)     \
163 	(host_get_special_port((host),                  \
164 	HOST_LOCAL_NODE, HOST_USER_NOTIFICATION_PORT, (port)))
165 #define host_set_user_notification_port(host, port)     \
166 	(host_set_special_port((host), HOST_USER_NOTIFICATION_PORT, (port)))
167 
168 #define host_get_automountd_port(host, port)    \
169 	(host_get_special_port((host),          \
170 	HOST_LOCAL_NODE, HOST_AUTOMOUNTD_PORT, (port)))
171 #define host_set_automountd_port(host, port)    \
172 	(host_set_special_port((host), HOST_AUTOMOUNTD_PORT, (port)))
173 
174 #define host_get_lockd_port(host, port) \
175 	(host_get_special_port((host),                  \
176 	HOST_LOCAL_NODE, HOST_LOCKD_PORT, (port)))
177 #define host_set_lockd_port(host, port) \
178 	(host_set_special_port((host), HOST_LOCKD_PORT, (port)))
179 
180 #define host_get_ktrace_background_port(host, port)     \
181 	(host_get_special_port((host),                  \
182 	HOST_LOCAL_NODE, HOST_KTRACE_BACKGROUND_PORT, (port)))
183 #define host_set_ktrace_background_port(host, port)     \
184 	(host_set_special_port((host), HOST_KTRACE_BACKGROUND_PORT, (port)))
185 
186 #define host_get_kextd_port(host, port) \
187 	(host_get_special_port((host),                  \
188 	HOST_LOCAL_NODE, HOST_KEXTD_PORT, (port)))
189 #define host_set_kextd_port(host, port) \
190 	(host_set_special_port((host), HOST_KEXTD_PORT, (port)))
191 
192 #define host_get_launchctl_port(host, port) \
193 	(host_get_special_port((host), HOST_LOCAL_NODE, HOST_LAUNCHCTL_PORT, \
194 	(port)))
195 #define host_set_launchctl_port(host, port) \
196 	(host_set_special_port((host), HOST_LAUNCHCTL_PORT, (port)))
197 
198 #define host_get_chud_port(host, port) host_get_launchctl_port(host, port)
199 #define host_set_chud_port(host, port) host_set_launchctl_port(host, port)
200 
201 #define host_get_unfreed_port(host, port)       \
202 	(host_get_special_port((host),                  \
203 	HOST_LOCAL_NODE, HOST_UNFREED_PORT, (port)))
204 #define host_set_unfreed_port(host, port)       \
205 	(host_set_special_port((host), HOST_UNFREED_PORT, (port)))
206 
207 #define host_get_amfid_port(host, port) \
208 	(host_get_special_port((host),                  \
209 	HOST_LOCAL_NODE, HOST_AMFID_PORT, (port)))
210 #define host_set_amfid_port(host, port) \
211 	(host_set_special_port((host), HOST_AMFID_PORT, (port)))
212 
213 #define host_get_gssd_port(host, port)  \
214 	(host_get_special_port((host),                  \
215 	HOST_LOCAL_NODE, HOST_GSSD_PORT, (port)))
216 #define host_set_gssd_port(host, port)  \
217 	(host_set_special_port((host), HOST_GSSD_PORT, (port)))
218 
219 #define host_get_telemetry_port(host, port)     \
220 	(host_get_special_port((host),                  \
221 	HOST_LOCAL_NODE, HOST_TELEMETRY_PORT, (port)))
222 #define host_set_telemetry_port(host, port)     \
223 	(host_set_special_port((host), HOST_TELEMETRY_PORT, (port)))
224 
225 #define host_get_atm_notification_port(host, port)      \
226 	(host_get_special_port((host),                  \
227 	HOST_LOCAL_NODE, HOST_ATM_NOTIFICATION_PORT, (port)))
228 #define host_set_atm_notification_port(host, port)      \
229 	(host_set_special_port((host), HOST_ATM_NOTIFICATION_PORT, (port)))
230 
231 #define host_get_coalition_port(host, port)     \
232 	(host_get_special_port((host),                  \
233 	HOST_LOCAL_NODE, HOST_COALITION_PORT, (port)))
234 #define host_set_coalition_port(host, port)     \
235 	(host_set_special_port((host), HOST_COALITION_PORT, (port)))
236 
237 #define host_get_sysdiagnose_port(host, port)   \
238 	(host_get_special_port((host),                  \
239 	HOST_LOCAL_NODE, HOST_SYSDIAGNOSE_PORT, (port)))
240 #define host_set_sysdiagnose_port(host, port)   \
241 	(host_set_special_port((host), HOST_SYSDIAGNOSE_PORT, (port)))
242 
243 #define host_get_container_port(host, port)     \
244 	(host_get_special_port((host),                  \
245 	HOST_LOCAL_NODE, HOST_CONTAINERD_PORT, (port)))
246 #define host_set_container_port(host, port)     \
247 	(host_set_special_port((host), HOST_CONTAINERD_PORT, (port)))
248 
249 #define host_get_node_port(host, port)  \
250 	(host_get_special_port((host),                  \
251 	HOST_LOCAL_NODE, HOST_NODE_PORT, (port)))
252 #define host_set_node_port(host, port)  \
253 	(host_set_special_port((host), HOST_NODE_PORT, (port)))
254 
255 #define host_get_closured_port(host, port)      \
256 	(host_get_special_port((host),                  \
257 	HOST_LOCAL_NODE, HOST_CLOSURED_PORT, (port)))
258 #define host_set_closured_port(host, port)      \
259 	(host_set_special_port((host), HOST_CLOSURED_PORT, (port)))
260 
261 #define host_get_syspolicyd_port(host, port)    \
262 	(host_get_special_port((host),                          \
263 	HOST_LOCAL_NODE, HOST_SYSPOLICYD_PORT, (port)))
264 #define host_set_syspolicyd_port(host, port)    \
265 	(host_set_special_port((host), HOST_SYSPOLICYD_PORT, (port)))
266 
267 #define host_get_filecoordinationd_port(host, port)     \
268 	(host_get_special_port((host),                  \
269 	HOST_LOCAL_NODE, HOST_FILECOORDINATIOND_PORT, (port)))
270 #define host_set_filecoordinationd_port(host, port)     \
271 	(host_set_special_port((host), HOST_FILECOORDINATIOND_PORT, (port)))
272 
273 #define host_get_fairplayd_port(host, port)     \
274 	(host_get_special_port((host),                  \
275 	HOST_LOCAL_NODE, HOST_FAIRPLAYD_PORT, (port)))
276 #define host_set_fairplayd_port(host, port)     \
277 	(host_set_special_port((host), HOST_FAIRPLAYD_PORT, (port)))
278 
279 #define host_get_iocompressionstats_port(host, port)     \
280 	(host_get_special_port((host),                  \
281 	HOST_LOCAL_NODE, HOST_IOCOMPRESSIONSTATS_PORT, (port)))
282 #define host_set_iocompressionstats_port(host, port)     \
283 	(host_set_special_port((host), HOST_IOCOMPRESSIONSTATS_PORT, (port)))
284 
285 #define host_get_memory_error_port(host, port)     \
286 	(host_get_special_port((host),                  \
287 	HOST_LOCAL_NODE, HOST_MEMORY_ERROR_PORT, (port)))
288 #define host_set_memory_error_port(host, port)     \
289 	(host_set_special_port((host), HOST_MEMORY_ERROR_PORT, (port)))
290 
291 /* HOST_RESOURCE_NOTIFY_PORT doesn't #defines these conveniences.
292  *  All lookups go through send_resource_violation()
293  */
294 
295 #endif  /* _MACH_HOST_SPECIAL_PORTS_H_ */
296