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