1/*
2 * Copyright (c) 1999-2014 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 * Mach Operating System
30 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
31 * All Rights Reserved.
32 *
33 * Permission to use, copy, modify and distribute this software and its
34 * documentation is hereby granted, provided that both the copyright
35 * notice and this permission notice appear in all copies of the
36 * software, derivative works or modified versions, and any portions
37 * thereof, and that both notices appear in supporting documentation.
38 *
39 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
40 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
41 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
42 *
43 * Carnegie Mellon requests users of this software to return to
44 *
45 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
46 * School of Computer Science
47 * Carnegie Mellon University
48 * Pittsburgh PA 15213-3890
49 *
50 * any improvements or extensions that they make and grant Carnegie Mellon
51 * the rights to redistribute these changes.
52 */
53
54/*
55 * Includes all the types that a normal user
56 * of Mach programs should need
57 */
58
59#ifndef _MACH_H_
60#define _MACH_H_
61
62#define __MACH30__
63#define MACH_IPC_FLAVOR UNTYPED
64
65#include <mach/std_types.h>
66#include <mach/mach_types.h>
67#include <mach/mach_interface.h>
68#include <mach/mach_port.h>
69#include <mach/mach_init.h>
70#include <mach/mach_host.h>
71#include <mach/thread_switch.h>
72
73#include <mach/rpc.h> /* for compatibility only */
74#include <mach/mig.h>
75
76#include <mach/mig_errors.h>
77#include <mach/mach_error.h>
78
79#include <sys/cdefs.h>
80
81__BEGIN_DECLS
82/*
83 * Standard prototypes
84 */
85extern void panic_init(mach_port_t);
86extern void panic(const char *, ...);
87
88extern void slot_name(cpu_type_t,
89 cpu_subtype_t,
90 char **,
91 char **);
92
93extern void mig_reply_setup(mach_msg_header_t *,
94 mach_msg_header_t *);
95
96__WATCHOS_PROHIBITED __TVOS_PROHIBITED
97extern void mach_msg_destroy(mach_msg_header_t *);
98
99__WATCHOS_PROHIBITED __TVOS_PROHIBITED
100extern mach_msg_return_t mach_msg_receive(mach_msg_header_t *);
101
102__WATCHOS_PROHIBITED __TVOS_PROHIBITED
103extern mach_msg_return_t mach_msg_send(mach_msg_header_t *);
104
105__WATCHOS_PROHIBITED __TVOS_PROHIBITED
106extern mach_msg_return_t mach_msg_server_once(boolean_t (*)
107 (mach_msg_header_t *,
108 mach_msg_header_t *),
109 mach_msg_size_t,
110 mach_port_t,
111 mach_msg_options_t);
112
113__WATCHOS_PROHIBITED __TVOS_PROHIBITED
114extern mach_msg_return_t mach_msg_server(boolean_t (*)
115 (mach_msg_header_t *,
116 mach_msg_header_t *),
117 mach_msg_size_t,
118 mach_port_t,
119 mach_msg_options_t);
120
121__WATCHOS_PROHIBITED __TVOS_PROHIBITED
122extern mach_msg_return_t mach_msg_server_importance(boolean_t (*)
123 (mach_msg_header_t *,
124 mach_msg_header_t *),
125 mach_msg_size_t,
126 mach_port_t,
127 mach_msg_options_t);
128
129/*
130 * Prototypes for compatibility
131 */
132extern kern_return_t clock_get_res(mach_port_t,
133 clock_res_t *);
134extern kern_return_t clock_set_res(mach_port_t,
135 clock_res_t);
136
137extern kern_return_t clock_sleep(mach_port_t,
138 int,
139 mach_timespec_t,
140 mach_timespec_t *);
141
142/*!
143 * @group voucher_mach_msg Prototypes
144 */
145
146#define VOUCHER_MACH_MSG_API_VERSION 20140205
147
148/*!
149 * @typedef voucher_mach_msg_state_t
150 *
151 * @abstract
152 * Opaque object encapsulating state changed by voucher_mach_msg_adopt().
153 */
154typedef struct voucher_mach_msg_state_s *voucher_mach_msg_state_t;
155
156/*!
157 * @const VOUCHER_MACH_MSG_STATE_UNCHANGED
158 *
159 * @discussion
160 * Constant indicating no state change occurred.
161 */
162#define VOUCHER_MACH_MSG_STATE_UNCHANGED ((voucher_mach_msg_state_t)~0ul)
163
164/*!
165 * @function voucher_mach_msg_set
166 *
167 * @abstract
168 * Change specified message header to contain current mach voucher with a
169 * COPY_SEND disposition.
170 * Does not change message if it already has non-zero MACH_MSGH_BITS_VOUCHER.
171 *
172 * @discussion
173 * Borrows reference to current thread voucher so message should be sent
174 * immediately (without intervening calls that might change that voucher).
175 *
176 * @param msg
177 * The message to modify.
178 *
179 * @result
180 * True if header was changed.
181 */
182extern boolean_t voucher_mach_msg_set(mach_msg_header_t *msg);
183
184/*!
185 * @function voucher_mach_msg_clear
186 *
187 * @abstract
188 * Removes changes made to specified message header by voucher_mach_msg_set()
189 * and any mach_msg() send operations (successful or not).
190 * If the message is not needed further, mach_msg_destroy() should be called
191 * instead.
192 *
193 * @discussion
194 * Not intended to be called if voucher_mach_msg_set() returned false.
195 * Releases reference to message mach voucher if an extra reference was
196 * acquired due to an unsuccessful send operation (pseudo-receive).
197 *
198 * @param msg
199 * The message to modify.
200 */
201extern void voucher_mach_msg_clear(mach_msg_header_t *msg);
202
203/*!
204 * @function voucher_mach_msg_adopt
205 *
206 * @abstract
207 * Adopt the voucher contained in the specified message on the current thread
208 * and return the previous thread voucher state.
209 *
210 * @discussion
211 * Ownership of the mach voucher in the message is transferred to the current
212 * thread and the message header voucher fields are cleared.
213 *
214 * @param msg
215 * The message to query and modify.
216 *
217 * @result
218 * The previous thread voucher state or VOUCHER_MACH_MSG_STATE_UNCHANGED if no
219 * state change occurred.
220 */
221extern voucher_mach_msg_state_t voucher_mach_msg_adopt(mach_msg_header_t *msg);
222
223/*!
224 * @function voucher_mach_msg_revert
225 *
226 * @abstract
227 * Restore thread voucher state previously modified by voucher_mach_msg_adopt().
228 *
229 * @discussion
230 * Current thread voucher reference is released.
231 * No change to thread voucher state if passed VOUCHER_MACH_MSG_STATE_UNCHANGED.
232 *
233 * @param state
234 * The thread voucher state to restore.
235 */
236extern void voucher_mach_msg_revert(voucher_mach_msg_state_t state);
237
238
239__END_DECLS
240
241#endif /* _MACH_H_ */