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_MAX_SPECIAL_PORT           (14 + HOST_MAX_SPECIAL_KERNEL_PORT)
96                                        /* room to grow here as well */
97
98/*
99 * Special node identifier to always represent the local node.
100 */
101#define HOST_LOCAL_NODE	                 -1
102
103/*
104 * Definitions for ease of use.
105 *
106 * In the get call, the host parameter can be any host, but will generally
107 * be the local node host port. In the set call, the host must the per-node
108 * host port for the node being affected.
109 */
110#define host_get_host_port(host, port)	\
111	(host_get_special_port((host), 	\
112	HOST_LOCAL_NODE, HOST_PORT, (port)))
113#define host_set_host_port(host, port) (KERN_INVALID_ARGUMENT)
114
115#define host_get_host_priv_port(host, port)	\
116	(host_get_special_port((host), 		\
117	HOST_LOCAL_NODE, HOST_PRIV_PORT, (port)))
118#define host_set_host_priv_port(host, port) (KERN_INVALID_ARGUMENT)
119
120#define host_get_io_master_port(host, port)	\
121	(host_get_special_port((host), 		\
122	HOST_LOCAL_NODE, HOST_IO_MASTER_PORT, (port)))
123#define host_set_io_master_port(host, port) (KERN_INVALID_ARGUMENT)
124
125/*
126 * User-settable special ports.
127 */
128#define host_get_dynamic_pager_port(host, port)	\
129	(host_get_special_port((host),			\
130	HOST_LOCAL_NODE, HOST_DYNAMIC_PAGER_PORT, (port)))
131#define host_set_dynamic_pager_port(host, port)	\
132	(host_set_special_port((host), HOST_DYNAMIC_PAGER_PORT, (port)))
133
134#define host_get_audit_control_port(host, port)	\
135	(host_get_special_port((host), 		\
136	HOST_LOCAL_NODE, HOST_AUDIT_CONTROL_PORT, (port)))
137#define host_set_audit_control_port(host, port)	\
138	(host_set_special_port((host), HOST_AUDIT_CONTROL_PORT, (port)))
139
140#define host_get_user_notification_port(host, port)	\
141	(host_get_special_port((host), 			\
142	HOST_LOCAL_NODE, HOST_USER_NOTIFICATION_PORT, (port)))
143#define host_set_user_notification_port(host, port)	\
144	(host_set_special_port((host), HOST_USER_NOTIFICATION_PORT, (port)))
145
146#define host_get_automountd_port(host, port)	\
147	(host_get_special_port((host), 		\
148	HOST_LOCAL_NODE, HOST_AUTOMOUNTD_PORT, (port)))
149#define host_set_automountd_port(host, port)	\
150	(host_set_special_port((host), HOST_AUTOMOUNTD_PORT, (port)))
151
152#define host_get_lockd_port(host, port)	\
153	(host_get_special_port((host), 			\
154	HOST_LOCAL_NODE, HOST_LOCKD_PORT, (port)))
155#define host_set_lockd_port(host, port)	\
156	(host_set_special_port((host), HOST_LOCKD_PORT, (port)))
157
158#define host_get_kextd_port(host, port)	\
159	(host_get_special_port((host), 			\
160	HOST_LOCAL_NODE, HOST_KEXTD_PORT, (port)))
161#define host_set_kextd_port(host, port)	\
162	(host_set_special_port((host), HOST_KEXTD_PORT, (port)))
163
164#define host_get_chud_port(host, port)	\
165	(host_get_special_port((host), 			\
166	HOST_LOCAL_NODE, HOST_CHUD_PORT, (port)))
167#define host_set_chud_port(host, port)	\
168	(host_set_special_port((host), HOST_CHUD_PORT, (port)))
169
170#define host_get_unfreed_port(host, port)	\
171	(host_get_special_port((host), 			\
172	HOST_LOCAL_NODE, HOST_UNFREED_PORT, (port)))
173#define host_set_unfreed_port(host, port)	\
174	(host_set_special_port((host), HOST_UNFREED_PORT, (port)))
175
176#define host_get_amfid_port(host, port)	\
177	(host_get_special_port((host), 			\
178	HOST_LOCAL_NODE, HOST_AMFID_PORT, (port)))
179#define host_set_amfid_port(host, port)	\
180	(host_set_special_port((host), HOST_AMFID_PORT, (port)))
181
182#define host_get_gssd_port(host, port)	\
183	(host_get_special_port((host),			\
184	HOST_LOCAL_NODE, HOST_GSSD_PORT, (port)))
185#define host_set_gssd_port(host, port)	\
186	(host_set_special_port((host), HOST_GSSD_PORT, (port)))
187
188#define host_get_telemetry_port(host, port)	\
189	(host_get_special_port((host),			\
190	HOST_LOCAL_NODE, HOST_TELEMETRY_PORT, (port)))
191#define host_set_telemetry_port(host, port)	\
192	(host_set_special_port((host), HOST_TELEMETRY_PORT, (port)))
193#endif	/* _MACH_HOST_SPECIAL_PORTS_H_ */
194