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/*
73 * Always provided by kernel (cannot be set from user-space).
74 */
75#define HOST_PORT                        1
76#define HOST_PRIV_PORT                   2
77#define HOST_IO_MASTER_PORT              3
78#define HOST_MAX_SPECIAL_KERNEL_PORT     7 /* room to grow */
79
80/*
81 * Not provided by kernel
82 */
83#define HOST_DYNAMIC_PAGER_PORT         (1 + HOST_MAX_SPECIAL_KERNEL_PORT)
84#define HOST_AUDIT_CONTROL_PORT         (2 + HOST_MAX_SPECIAL_KERNEL_PORT)
85#define HOST_USER_NOTIFICATION_PORT     (3 + HOST_MAX_SPECIAL_KERNEL_PORT)
86#define HOST_AUTOMOUNTD_PORT            (4 + HOST_MAX_SPECIAL_KERNEL_PORT)
87#define HOST_LOCKD_PORT                 (5 + HOST_MAX_SPECIAL_KERNEL_PORT)
88#define HOST_SEATBELT_PORT              (7 + HOST_MAX_SPECIAL_KERNEL_PORT)
89#define HOST_KEXTD_PORT                 (8 + HOST_MAX_SPECIAL_KERNEL_PORT)
90#define HOST_CHUD_PORT                  (9 + HOST_MAX_SPECIAL_KERNEL_PORT)
91#define HOST_UNFREED_PORT		(10 + HOST_MAX_SPECIAL_KERNEL_PORT)
92#define HOST_AMFID_PORT			(11 + HOST_MAX_SPECIAL_KERNEL_PORT)
93#define HOST_GSSD_PORT			(12 + HOST_MAX_SPECIAL_KERNEL_PORT)
94#define HOST_TELEMETRY_PORT		(13 + HOST_MAX_SPECIAL_KERNEL_PORT)
95#define HOST_ATM_NOTIFICATION_PORT		(14 + HOST_MAX_SPECIAL_KERNEL_PORT)
96#define HOST_COALITION_PORT		(15 + HOST_MAX_SPECIAL_KERNEL_PORT)
97#define HOST_MAX_SPECIAL_PORT           (16 + HOST_MAX_SPECIAL_KERNEL_PORT)
98                                        /* room to grow here as well */
99
100/*
101 * Special node identifier to always represent the local node.
102 */
103#define HOST_LOCAL_NODE	                 -1
104
105/*
106 * Definitions for ease of use.
107 *
108 * In the get call, the host parameter can be any host, but will generally
109 * be the local node host port. In the set call, the host must the per-node
110 * host port for the node being affected.
111 */
112#define host_get_host_port(host, port)	\
113	(host_get_special_port((host), 	\
114	HOST_LOCAL_NODE, HOST_PORT, (port)))
115#define host_set_host_port(host, port) (KERN_INVALID_ARGUMENT)
116
117#define host_get_host_priv_port(host, port)	\
118	(host_get_special_port((host), 		\
119	HOST_LOCAL_NODE, HOST_PRIV_PORT, (port)))
120#define host_set_host_priv_port(host, port) (KERN_INVALID_ARGUMENT)
121
122#define host_get_io_master_port(host, port)	\
123	(host_get_special_port((host), 		\
124	HOST_LOCAL_NODE, HOST_IO_MASTER_PORT, (port)))
125#define host_set_io_master_port(host, port) (KERN_INVALID_ARGUMENT)
126
127/*
128 * User-settable special ports.
129 */
130#define host_get_dynamic_pager_port(host, port)	\
131	(host_get_special_port((host),			\
132	HOST_LOCAL_NODE, HOST_DYNAMIC_PAGER_PORT, (port)))
133#define host_set_dynamic_pager_port(host, port)	\
134	(host_set_special_port((host), HOST_DYNAMIC_PAGER_PORT, (port)))
135
136#define host_get_audit_control_port(host, port)	\
137	(host_get_special_port((host), 		\
138	HOST_LOCAL_NODE, HOST_AUDIT_CONTROL_PORT, (port)))
139#define host_set_audit_control_port(host, port)	\
140	(host_set_special_port((host), HOST_AUDIT_CONTROL_PORT, (port)))
141
142#define host_get_user_notification_port(host, port)	\
143	(host_get_special_port((host), 			\
144	HOST_LOCAL_NODE, HOST_USER_NOTIFICATION_PORT, (port)))
145#define host_set_user_notification_port(host, port)	\
146	(host_set_special_port((host), HOST_USER_NOTIFICATION_PORT, (port)))
147
148#define host_get_automountd_port(host, port)	\
149	(host_get_special_port((host), 		\
150	HOST_LOCAL_NODE, HOST_AUTOMOUNTD_PORT, (port)))
151#define host_set_automountd_port(host, port)	\
152	(host_set_special_port((host), HOST_AUTOMOUNTD_PORT, (port)))
153
154#define host_get_lockd_port(host, port)	\
155	(host_get_special_port((host), 			\
156	HOST_LOCAL_NODE, HOST_LOCKD_PORT, (port)))
157#define host_set_lockd_port(host, port)	\
158	(host_set_special_port((host), HOST_LOCKD_PORT, (port)))
159
160#define host_get_kextd_port(host, port)	\
161	(host_get_special_port((host), 			\
162	HOST_LOCAL_NODE, HOST_KEXTD_PORT, (port)))
163#define host_set_kextd_port(host, port)	\
164	(host_set_special_port((host), HOST_KEXTD_PORT, (port)))
165
166#define host_get_chud_port(host, port)	\
167	(host_get_special_port((host), 			\
168	HOST_LOCAL_NODE, HOST_CHUD_PORT, (port)))
169#define host_set_chud_port(host, port)	\
170	(host_set_special_port((host), HOST_CHUD_PORT, (port)))
171
172#define host_get_unfreed_port(host, port)	\
173	(host_get_special_port((host), 			\
174	HOST_LOCAL_NODE, HOST_UNFREED_PORT, (port)))
175#define host_set_unfreed_port(host, port)	\
176	(host_set_special_port((host), HOST_UNFREED_PORT, (port)))
177
178#define host_get_amfid_port(host, port)	\
179	(host_get_special_port((host), 			\
180	HOST_LOCAL_NODE, HOST_AMFID_PORT, (port)))
181#define host_set_amfid_port(host, port)	\
182	(host_set_special_port((host), HOST_AMFID_PORT, (port)))
183
184#define host_get_gssd_port(host, port)	\
185	(host_get_special_port((host),			\
186	HOST_LOCAL_NODE, HOST_GSSD_PORT, (port)))
187#define host_set_gssd_port(host, port)	\
188	(host_set_special_port((host), HOST_GSSD_PORT, (port)))
189
190#define host_get_telemetry_port(host, port)	\
191	(host_get_special_port((host),			\
192	HOST_LOCAL_NODE, HOST_TELEMETRY_PORT, (port)))
193#define host_set_telemetry_port(host, port)	\
194	(host_set_special_port((host), HOST_TELEMETRY_PORT, (port)))
195
196#define host_get_atm_notification_port(host, port)	\
197	(host_get_special_port((host),			\
198	HOST_LOCAL_NODE, HOST_ATM_NOTIFICATION_PORT, (port)))
199#define host_set_atm_notification_port(host, port)	\
200	(host_set_special_port((host), HOST_ATM_NOTIFICATION_PORT, (port)))
201
202#define host_get_coalition_port(host, port)	\
203	(host_get_special_port((host),			\
204	HOST_LOCAL_NODE, HOST_COALITION_PORT, (port)))
205#define host_set_coalition_port(host, port)	\
206	(host_set_special_port((host), HOST_COALITION_PORT, (port)))
207
208#endif	/* _MACH_HOST_SPECIAL_PORTS_H_ */
209