xref: /xnu-12377.81.4/osfmk/mach/host_special_ports.h (revision 043036a2b3718f7f0be807e2870f8f47d3fa0796)
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 #define HOST_MANAGEDAPPDISTD_PORT       (27 + HOST_MAX_SPECIAL_KERNEL_PORT)
114 #define HOST_DOUBLEAGENTD_PORT          (28 + HOST_MAX_SPECIAL_KERNEL_PORT)
115 
116 #define HOST_MAX_SPECIAL_PORT           HOST_DOUBLEAGENTD_PORT
117 /* MAX = last since rdar://59872249 */
118 
119 /* obsolete name */
120 #define HOST_CHUD_PORT HOST_LAUNCHCTL_PORT
121 
122 /*
123  * Special node identifier to always represent the local node.
124  */
125 #define HOST_LOCAL_NODE                  -1
126 
127 /*
128  * Definitions for ease of use.
129  *
130  * In the get call, the host parameter can be any host, but will generally
131  * be the local node host port. In the set call, the host must the per-node
132  * host port for the node being affected.
133  */
134 #define host_get_host_port(host, port)  \
135 	(host_get_special_port((host),  \
136 	HOST_LOCAL_NODE, HOST_PORT, (port)))
137 #define host_set_host_port(host, port) (KERN_INVALID_ARGUMENT)
138 
139 #define host_get_host_priv_port(host, port)     \
140 	(host_get_special_port((host),          \
141 	HOST_LOCAL_NODE, HOST_PRIV_PORT, (port)))
142 #define host_set_host_priv_port(host, port) (KERN_INVALID_ARGUMENT)
143 
144 #define host_get_io_main_port(host, port)     \
145 	(host_get_special_port((host),          \
146 	HOST_LOCAL_NODE, HOST_IO_MAIN_PORT, (port)))
147 #define host_set_io_main_port(host, port) (KERN_INVALID_ARGUMENT)
148 
149 /*
150  * User-settable special ports.
151  */
152 #define host_get_dynamic_pager_port(host, port) \
153 	(host_get_special_port((host),                  \
154 	HOST_LOCAL_NODE, HOST_DYNAMIC_PAGER_PORT, (port)))
155 #define host_set_dynamic_pager_port(host, port) \
156 	(host_set_special_port((host), HOST_DYNAMIC_PAGER_PORT, (port)))
157 
158 #define host_get_audit_control_port(host, port) \
159 	(host_get_special_port((host),          \
160 	HOST_LOCAL_NODE, HOST_AUDIT_CONTROL_PORT, (port)))
161 #define host_set_audit_control_port(host, port) \
162 	(host_set_special_port((host), HOST_AUDIT_CONTROL_PORT, (port)))
163 
164 #define host_get_user_notification_port(host, port)     \
165 	(host_get_special_port((host),                  \
166 	HOST_LOCAL_NODE, HOST_USER_NOTIFICATION_PORT, (port)))
167 #define host_set_user_notification_port(host, port)     \
168 	(host_set_special_port((host), HOST_USER_NOTIFICATION_PORT, (port)))
169 
170 #define host_get_automountd_port(host, port)    \
171 	(host_get_special_port((host),          \
172 	HOST_LOCAL_NODE, HOST_AUTOMOUNTD_PORT, (port)))
173 #define host_set_automountd_port(host, port)    \
174 	(host_set_special_port((host), HOST_AUTOMOUNTD_PORT, (port)))
175 
176 #define host_get_lockd_port(host, port) \
177 	(host_get_special_port((host),                  \
178 	HOST_LOCAL_NODE, HOST_LOCKD_PORT, (port)))
179 #define host_set_lockd_port(host, port) \
180 	(host_set_special_port((host), HOST_LOCKD_PORT, (port)))
181 
182 #define host_get_ktrace_background_port(host, port)     \
183 	(host_get_special_port((host),                  \
184 	HOST_LOCAL_NODE, HOST_KTRACE_BACKGROUND_PORT, (port)))
185 #define host_set_ktrace_background_port(host, port)     \
186 	(host_set_special_port((host), HOST_KTRACE_BACKGROUND_PORT, (port)))
187 
188 #define host_get_kextd_port(host, port) \
189 	(host_get_special_port((host),                  \
190 	HOST_LOCAL_NODE, HOST_KEXTD_PORT, (port)))
191 #define host_set_kextd_port(host, port) \
192 	(host_set_special_port((host), HOST_KEXTD_PORT, (port)))
193 
194 #define host_get_launchctl_port(host, port) \
195 	(host_get_special_port((host), HOST_LOCAL_NODE, HOST_LAUNCHCTL_PORT, \
196 	(port)))
197 #define host_set_launchctl_port(host, port) \
198 	(host_set_special_port((host), HOST_LAUNCHCTL_PORT, (port)))
199 
200 #define host_get_chud_port(host, port) host_get_launchctl_port(host, port)
201 #define host_set_chud_port(host, port) host_set_launchctl_port(host, port)
202 
203 #define host_get_unfreed_port(host, port)       \
204 	(host_get_special_port((host),                  \
205 	HOST_LOCAL_NODE, HOST_UNFREED_PORT, (port)))
206 #define host_set_unfreed_port(host, port)       \
207 	(host_set_special_port((host), HOST_UNFREED_PORT, (port)))
208 
209 #define host_get_amfid_port(host, port) \
210 	(host_get_special_port((host),                  \
211 	HOST_LOCAL_NODE, HOST_AMFID_PORT, (port)))
212 #define host_set_amfid_port(host, port) \
213 	(host_set_special_port((host), HOST_AMFID_PORT, (port)))
214 
215 #define host_get_gssd_port(host, port)  \
216 	(host_get_special_port((host),                  \
217 	HOST_LOCAL_NODE, HOST_GSSD_PORT, (port)))
218 #define host_set_gssd_port(host, port)  \
219 	(host_set_special_port((host), HOST_GSSD_PORT, (port)))
220 
221 #define host_get_telemetry_port(host, port)     \
222 	(host_get_special_port((host),                  \
223 	HOST_LOCAL_NODE, HOST_TELEMETRY_PORT, (port)))
224 #define host_set_telemetry_port(host, port)     \
225 	(host_set_special_port((host), HOST_TELEMETRY_PORT, (port)))
226 
227 #define host_get_atm_notification_port(host, port)      \
228 	(host_get_special_port((host),                  \
229 	HOST_LOCAL_NODE, HOST_ATM_NOTIFICATION_PORT, (port)))
230 #define host_set_atm_notification_port(host, port)      \
231 	(host_set_special_port((host), HOST_ATM_NOTIFICATION_PORT, (port)))
232 
233 #define host_get_coalition_port(host, port)     \
234 	(host_get_special_port((host),                  \
235 	HOST_LOCAL_NODE, HOST_COALITION_PORT, (port)))
236 #define host_set_coalition_port(host, port)     \
237 	(host_set_special_port((host), HOST_COALITION_PORT, (port)))
238 
239 #define host_get_sysdiagnose_port(host, port)   \
240 	(host_get_special_port((host),                  \
241 	HOST_LOCAL_NODE, HOST_SYSDIAGNOSE_PORT, (port)))
242 #define host_set_sysdiagnose_port(host, port)   \
243 	(host_set_special_port((host), HOST_SYSDIAGNOSE_PORT, (port)))
244 
245 #define host_get_container_port(host, port)     \
246 	(host_get_special_port((host),                  \
247 	HOST_LOCAL_NODE, HOST_CONTAINERD_PORT, (port)))
248 #define host_set_container_port(host, port)     \
249 	(host_set_special_port((host), HOST_CONTAINERD_PORT, (port)))
250 
251 #define host_get_node_port(host, port)  \
252 	(host_get_special_port((host),                  \
253 	HOST_LOCAL_NODE, HOST_NODE_PORT, (port)))
254 #define host_set_node_port(host, port)  \
255 	(host_set_special_port((host), HOST_NODE_PORT, (port)))
256 
257 #define host_get_closured_port(host, port)      \
258 	(host_get_special_port((host),                  \
259 	HOST_LOCAL_NODE, HOST_CLOSURED_PORT, (port)))
260 #define host_set_closured_port(host, port)      \
261 	(host_set_special_port((host), HOST_CLOSURED_PORT, (port)))
262 
263 #define host_get_syspolicyd_port(host, port)    \
264 	(host_get_special_port((host),                          \
265 	HOST_LOCAL_NODE, HOST_SYSPOLICYD_PORT, (port)))
266 #define host_set_syspolicyd_port(host, port)    \
267 	(host_set_special_port((host), HOST_SYSPOLICYD_PORT, (port)))
268 
269 #define host_get_filecoordinationd_port(host, port)     \
270 	(host_get_special_port((host),                  \
271 	HOST_LOCAL_NODE, HOST_FILECOORDINATIOND_PORT, (port)))
272 #define host_set_filecoordinationd_port(host, port)     \
273 	(host_set_special_port((host), HOST_FILECOORDINATIOND_PORT, (port)))
274 
275 #define host_get_fairplayd_port(host, port)     \
276 	(host_get_special_port((host),                  \
277 	HOST_LOCAL_NODE, HOST_FAIRPLAYD_PORT, (port)))
278 #define host_set_fairplayd_port(host, port)     \
279 	(host_set_special_port((host), HOST_FAIRPLAYD_PORT, (port)))
280 
281 #define host_get_iocompressionstats_port(host, port)     \
282 	(host_get_special_port((host),                  \
283 	HOST_LOCAL_NODE, HOST_IOCOMPRESSIONSTATS_PORT, (port)))
284 #define host_set_iocompressionstats_port(host, port)     \
285 	(host_set_special_port((host), HOST_IOCOMPRESSIONSTATS_PORT, (port)))
286 
287 #define host_get_memory_error_port(host, port)     \
288 	(host_get_special_port((host),                  \
289 	HOST_LOCAL_NODE, HOST_MEMORY_ERROR_PORT, (port)))
290 #define host_set_memory_error_port(host, port)     \
291 	(host_set_special_port((host), HOST_MEMORY_ERROR_PORT, (port)))
292 
293 #define host_get_managedappdistd_port(host, port)     \
294 	(host_get_special_port((host),                  \
295 	HOST_LOCAL_NODE, HOST_MANAGEDAPPDISTD_PORT, (port)))
296 #define host_set_managedappdistd_port(host, port)     \
297 	(host_set_special_port((host), HOST_MANAGEDAPPDISTD_PORT, (port)))
298 
299 #define host_get_doubleagentd_port(host, port)     \
300 	(host_get_special_port((host),                  \
301 	HOST_LOCAL_NODE, HOST_DOUBLEAGENTD_PORT, (port)))
302 #define host_set_doubleagentd_port(host, port)     \
303 	(host_set_special_port((host), HOST_DOUBLEAGENTD_PORT, (port)))
304 
305 /* HOST_RESOURCE_NOTIFY_PORT doesn't #defines these conveniences.
306  *  All lookups go through send_resource_violation()
307  */
308 
309 #endif  /* _MACH_HOST_SPECIAL_PORTS_H_ */
310