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