]> git.saurik.com Git - apple/xnu.git/blame - osfmk/mach/mach_traps.h
xnu-792.18.15.tar.gz
[apple/xnu.git] / osfmk / mach / mach_traps.h
CommitLineData
1c79356b 1/*
89b3af67 2 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
1c79356b 3 *
8f6c56a5 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
8f6c56a5
A
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
8ad349bb 24 * limitations under the License.
8f6c56a5
A
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/*
29 * @OSF_COPYRIGHT@
30 */
31/*
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988,1987 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 * Definitions of general Mach system traps.
60 *
91447636
A
61 * These are the definitions as seen from user-space.
62 * The kernel definitions are in <mach/syscall_sw.h>.
1c79356b
A
63 * Kernel RPC functions are defined in <mach/mach_interface.h>.
64 */
65
66#ifndef _MACH_MACH_TRAPS_H_
67#define _MACH_MACH_TRAPS_H_
68
91447636
A
69#include <stdint.h>
70
71#include <mach/std_types.h>
72#include <mach/mach_types.h>
1c79356b
A
73#include <mach/kern_return.h>
74#include <mach/port.h>
75#include <mach/vm_types.h>
76#include <mach/clock_types.h>
1c79356b 77
91447636
A
78#include <machine/endian.h>
79
80#include <sys/cdefs.h>
81
82__BEGIN_DECLS
83
84#ifndef KERNEL
85
86#ifdef PRIVATE
1c79356b 87
91447636 88extern mach_port_name_t mach_reply_port(void);
1c79356b 89
91447636 90extern mach_port_name_t thread_self_trap(void);
1c79356b 91
91447636 92extern mach_port_name_t host_self_trap(void);
1c79356b 93
91447636
A
94extern mach_msg_return_t mach_msg_trap(
95 mach_msg_header_t *msg,
96 mach_msg_option_t option,
97 mach_msg_size_t send_size,
98 mach_msg_size_t rcv_size,
99 mach_port_name_t rcv_name,
100 mach_msg_timeout_t timeout,
101 mach_port_name_t notify);
102
103extern mach_msg_return_t mach_msg_overwrite_trap(
104 mach_msg_header_t *msg,
105 mach_msg_option_t option,
106 mach_msg_size_t send_size,
107 mach_msg_size_t rcv_size,
108 mach_port_name_t rcv_name,
109 mach_msg_timeout_t timeout,
110 mach_port_name_t notify,
111 mach_msg_header_t *rcv_msg,
112 mach_msg_size_t rcv_limit);
113
114extern kern_return_t semaphore_signal_trap(
1c79356b
A
115 mach_port_name_t signal_name);
116
91447636 117extern kern_return_t semaphore_signal_all_trap(
1c79356b
A
118 mach_port_name_t signal_name);
119
91447636 120extern kern_return_t semaphore_signal_thread_trap(
1c79356b
A
121 mach_port_name_t signal_name,
122 mach_port_name_t thread_name);
123
91447636 124extern kern_return_t semaphore_wait_trap(
1c79356b
A
125 mach_port_name_t wait_name);
126
91447636 127extern kern_return_t semaphore_wait_signal_trap(
1c79356b 128 mach_port_name_t wait_name,
91447636 129 mach_port_name_t signal_name);
1c79356b 130
91447636 131extern kern_return_t semaphore_timedwait_trap(
1c79356b 132 mach_port_name_t wait_name,
91447636
A
133 unsigned int sec,
134 clock_res_t nsec);
1c79356b 135
91447636 136extern kern_return_t semaphore_timedwait_signal_trap(
1c79356b
A
137 mach_port_name_t wait_name,
138 mach_port_name_t signal_name,
139 unsigned int sec,
140 clock_res_t nsec);
141
91447636
A
142#if !defined(__LP64__)
143/* these should go away altogether - so no 64 legacy please */
144
145extern kern_return_t init_process(void);
146
147#endif /* !defined(__LP64__) */
148
149#if !defined(__LP64__)
150
151/* more that should go away so no 64-bit legacy please */
152extern kern_return_t macx_swapon(
153 char *filename,
154 int flags,
155 int size,
156 int priority);
157
158extern kern_return_t macx_swapoff(
159 char *filename,
160 int flags);
161
162extern kern_return_t macx_triggers(
163 int hi_water,
164 int low_water,
165 int flags,
166 mach_port_t alert_port);
167
168extern kern_return_t macx_backing_store_suspend(
169 boolean_t suspend);
170
171extern kern_return_t macx_backing_store_recovery(
172 int pid);
173
174#endif /* !defined(__LP64__) */
175
176extern kern_return_t clock_sleep_trap(
177 mach_port_name_t clock_name,
178 sleep_type_t sleep_type,
179 int sleep_sec,
180 int sleep_nsec,
181 mach_timespec_t *wakeup_time);
182
183#endif /* PRIVATE */
184
185extern boolean_t swtch_pri(int pri);
186
187extern boolean_t swtch(void);
188
189extern kern_return_t thread_switch(
190 mach_port_name_t thread_name,
191 int option,
192 mach_msg_timeout_t option_time);
193
194extern mach_port_name_t task_self_trap(void);
195
196/*
197 * Obsolete interfaces.
198 */
199
200extern kern_return_t task_for_pid(
201 mach_port_name_t target_tport,
202 int pid,
203 mach_port_name_t *t);
204
89b3af67
A
205extern kern_return_t task_name_for_pid(
206 mach_port_name_t target_tport,
207 int pid,
208 mach_port_name_t *tn);
209
91447636
A
210extern kern_return_t pid_for_task(
211 mach_port_name_t t,
212 int *x);
213
214#if !defined(__LP64__)
215/* these should go away altogether - so no 64 legacy please */
216
217extern kern_return_t map_fd(
218 int fd,
219 vm_offset_t offset,
220 vm_offset_t *va,
221 boolean_t findspace,
222 vm_size_t size);
223
224#endif /* !defined(__LP64__) */
225
226#else /* KERNEL */
227
228#ifdef XNU_KERNEL_PRIVATE
229
230/* Syscall data translations routines */
91447636
A
231#define PAD_(t) (sizeof(uint64_t) <= sizeof(t) \
232 ? 0 : sizeof(uint64_t) - sizeof(t))
91447636
A
233
234#if BYTE_ORDER == LITTLE_ENDIAN
235#define PADL_(t) 0
236#define PADR_(t) PAD_(t)
237#else
238#define PADL_(t) PAD_(t)
239#define PADR_(t) 0
240#endif
241
242#define PAD_ARG_(arg_type, arg_name) \
243 char arg_name##_l_[PADL_(arg_type)]; arg_type arg_name; char arg_name##_r_[PADR_(arg_type)];
244
245#ifndef __MUNGE_ONCE
246#define __MUNGE_ONCE
247#ifdef __ppc__
248void munge_w(const void *, void *);
249void munge_ww(const void *, void *);
250void munge_www(const void *, void *);
251void munge_wwww(const void *, void *);
252void munge_wwwww(const void *, void *);
253void munge_wwwwww(const void *, void *);
254void munge_wwwwwww(const void *, void *);
255void munge_wwwwwwww(const void *, void *);
256void munge_d(const void *, void *);
257void munge_dd(const void *, void *);
258void munge_ddd(const void *, void *);
259void munge_dddd(const void *, void *);
260void munge_ddddd(const void *, void *);
261void munge_dddddd(const void *, void *);
262void munge_ddddddd(const void *, void *);
263void munge_dddddddd(const void *, void *);
264void munge_l(const void *, void *);
265void munge_wl(const void *, void *);
266void munge_wlw(const void *, void *);
267void munge_wwwl(const void *, void *);
268void munge_wwwwl(const void *, void *);
269void munge_wwwwwl(const void *, void *);
270#else
271#define munge_w NULL
272#define munge_ww NULL
273#define munge_www NULL
274#define munge_wwww NULL
275#define munge_wwwww NULL
276#define munge_wwwwww NULL
277#define munge_wwwwwww NULL
278#define munge_wwwwwwww NULL
279#define munge_d NULL
280#define munge_dd NULL
281#define munge_ddd NULL
282#define munge_dddd NULL
283#define munge_ddddd NULL
284#define munge_dddddd NULL
285#define munge_ddddddd NULL
286#define munge_dddddddd NULL
287#define munge_l NULL
288#define munge_wl NULL
289#define munge_wlw NULL
290#define munge_wwwl NULL
291#define munge_wwwwl NULL
292#define munge_wwwwwl NULL
293#endif /* __ppc__ */
294#endif /* !__MUNGE_ONCE */
295
296struct kern_invalid_args {
297 register_t dummy;
298};
299extern kern_return_t kern_invalid(
300 struct kern_invalid_args *args);
301
302struct mach_reply_port_args {
303 register_t dummy;
304};
305extern mach_port_name_t mach_reply_port(
306 struct mach_reply_port_args *args);
307
308struct thread_self_trap_args {
309 register_t dummy;
310};
311extern mach_port_name_t thread_self_trap(
312 struct thread_self_trap_args *args);
313
314struct task_self_trap_args {
315 register_t dummy;
316};
317extern mach_port_name_t task_self_trap(
318 struct task_self_trap_args *args);
319
320struct host_self_trap_args {
321 register_t dummy;
322};
323extern mach_port_name_t host_self_trap(
324 struct host_self_trap_args *args);
325
326struct mach_msg_overwrite_trap_args {
327 PAD_ARG_(mach_vm_address_t, msg);
328 PAD_ARG_(mach_msg_option_t, option);
329 PAD_ARG_(mach_msg_size_t, send_size);
330 PAD_ARG_(mach_msg_size_t, rcv_size);
331 PAD_ARG_(mach_port_name_t, rcv_name);
332 PAD_ARG_(mach_msg_timeout_t, timeout);
333 PAD_ARG_(mach_port_name_t, notify);
334 PAD_ARG_(mach_vm_address_t, rcv_msg); /* Unused on mach_msg_trap */
335};
336extern mach_msg_return_t mach_msg_trap(
337 struct mach_msg_overwrite_trap_args *args);
338extern mach_msg_return_t mach_msg_overwrite_trap(
339 struct mach_msg_overwrite_trap_args *args);
340
341struct semaphore_signal_trap_args {
342 PAD_ARG_(mach_port_name_t, signal_name);
343};
344extern kern_return_t semaphore_signal_trap(
345 struct semaphore_signal_trap_args *args);
346
347struct semaphore_signal_all_trap_args {
348 PAD_ARG_(mach_port_name_t, signal_name);
349};
350extern kern_return_t semaphore_signal_all_trap(
351 struct semaphore_signal_all_trap_args *args);
352
353struct semaphore_signal_thread_trap_args {
354 PAD_ARG_(mach_port_name_t, signal_name);
355 PAD_ARG_(mach_port_name_t, thread_name);
356};
357extern kern_return_t semaphore_signal_thread_trap(
358 struct semaphore_signal_thread_trap_args *args);
359
360struct semaphore_wait_trap_args {
361 PAD_ARG_(mach_port_name_t, wait_name);
362};
363extern kern_return_t semaphore_wait_trap(
364 struct semaphore_wait_trap_args *args);
365
366struct semaphore_wait_signal_trap_args {
367 PAD_ARG_(mach_port_name_t, wait_name);
368 PAD_ARG_(mach_port_name_t, signal_name);
369};
370extern kern_return_t semaphore_wait_signal_trap(
371 struct semaphore_wait_signal_trap_args *args);
372
373struct semaphore_timedwait_trap_args {
374 PAD_ARG_(mach_port_name_t, wait_name);
375 PAD_ARG_(unsigned int, sec);
376 PAD_ARG_(clock_res_t, nsec);
377};
378extern kern_return_t semaphore_timedwait_trap(
379 struct semaphore_timedwait_trap_args *args);
380
381struct semaphore_timedwait_signal_trap_args {
382 PAD_ARG_(mach_port_name_t, wait_name);
383 PAD_ARG_(mach_port_name_t, signal_name);
384 PAD_ARG_(unsigned int, sec);
385 PAD_ARG_(clock_res_t, nsec);
386};
387extern kern_return_t semaphore_timedwait_signal_trap(
388 struct semaphore_timedwait_signal_trap_args *args);
389
390/* not published to LP64 clients */
391struct init_process_args {
392 register_t dummy;
393};
394extern kern_return_t init_process(
395 struct init_process_args *args);
396
397struct map_fd_args {
398 PAD_ARG_(int, fd);
399 PAD_ARG_(vm_offset_t, offset);
400 PAD_ARG_(vm_offset_t *, va);
401 PAD_ARG_(boolean_t, findspace);
402 PAD_ARG_(vm_size_t, size);
403};
404extern kern_return_t map_fd(
405 struct map_fd_args *args);
406
407struct task_for_pid_args {
408 PAD_ARG_(mach_port_name_t, target_tport);
409 PAD_ARG_(int, pid);
410 PAD_ARG_(user_addr_t, t);
411};
412extern kern_return_t task_for_pid(
413 struct task_for_pid_args *args);
414
89b3af67
A
415struct task_name_for_pid_args {
416 PAD_ARG_(mach_port_name_t, target_tport);
417 PAD_ARG_(int, pid);
418 PAD_ARG_(user_addr_t, t);
419};
420extern kern_return_t task_name_for_pid(
421 struct task_name_for_pid_args *args);
422
91447636
A
423struct pid_for_task_args {
424 PAD_ARG_(mach_port_name_t, t);
425 PAD_ARG_(user_addr_t, pid);
426};
427extern kern_return_t pid_for_task(
428 struct pid_for_task_args *args);
429
430/* not published to LP64 clients*/
431struct macx_swapon_args {
432 PAD_ARG_(char *, filename);
433 PAD_ARG_(int, flags);
434 PAD_ARG_(int, size);
435 PAD_ARG_(int, priority);
436};
437extern kern_return_t macx_swapon(
438 struct macx_swapon_args *args);
439
440struct macx_swapoff_args {
441 PAD_ARG_(char *, filename);
442 PAD_ARG_(int, flags);
443};
444extern kern_return_t macx_swapoff(
445 struct macx_swapoff_args *args);
446
447struct macx_triggers_args {
448 PAD_ARG_(int, hi_water);
449 PAD_ARG_(int, low_water);
450 PAD_ARG_(int, flags);
451 PAD_ARG_(mach_port_t, alert_port);
452};
453extern kern_return_t macx_triggers(
454 struct macx_triggers_args *args);
455
456struct macx_backing_store_suspend_args {
457 PAD_ARG_(boolean_t, suspend);
458};
459extern kern_return_t macx_backing_store_suspend(
460 struct macx_backing_store_suspend_args *args);
461
462struct macx_backing_store_recovery_args {
463 PAD_ARG_(int, pid);
464};
465extern kern_return_t macx_backing_store_recovery(
466 struct macx_backing_store_recovery_args *args);
467
468struct swtch_pri_args {
469 PAD_ARG_(int, pri);
470};
471extern boolean_t swtch_pri(
472 struct swtch_pri_args *args);
473
474struct swtch_args {
475 register_t dummy;
476};
477extern boolean_t swtch(
478 struct swtch_args *args);
479
480struct clock_sleep_trap_args{
481 PAD_ARG_(mach_port_name_t, clock_name);
482 PAD_ARG_(sleep_type_t, sleep_type);
483 PAD_ARG_(int, sleep_sec);
484 PAD_ARG_(int, sleep_nsec);
485 PAD_ARG_(mach_vm_address_t, wakeup_time);
486};
487extern kern_return_t clock_sleep_trap(
488 struct clock_sleep_trap_args *args);
489
490struct thread_switch_args {
491 PAD_ARG_(mach_port_name_t, thread_name);
492 PAD_ARG_(int, option);
493 PAD_ARG_(mach_msg_timeout_t, option_time);
494};
495extern kern_return_t thread_switch(
496 struct thread_switch_args *args);
497
498struct mach_timebase_info_trap_args {
499 PAD_ARG_(mach_vm_address_t, info);
500};
501extern kern_return_t mach_timebase_info_trap(
502 struct mach_timebase_info_trap_args *args);
503
504struct mach_wait_until_trap_args {
505 PAD_ARG_(uint64_t, deadline);
506};
507extern kern_return_t mach_wait_until_trap(
508 struct mach_wait_until_trap_args *args);
509
510struct mk_timer_create_trap_args {
511 register_t dummy;
512};
513extern mach_port_name_t mk_timer_create_trap(
514 struct mk_timer_create_trap_args *args);
515
516struct mk_timer_destroy_trap_args {
517 PAD_ARG_(mach_port_name_t, name);
518};
519extern kern_return_t mk_timer_destroy_trap(
520 struct mk_timer_destroy_trap_args *args);
521
522struct mk_timer_arm_trap_args {
523 PAD_ARG_(mach_port_name_t, name);
524 PAD_ARG_(uint64_t, expire_time);
525};
526extern kern_return_t mk_timer_arm_trap(
527 struct mk_timer_arm_trap_args *args);
528
529struct mk_timer_cancel_trap_args {
530 PAD_ARG_(mach_port_name_t, name);
531 PAD_ARG_(mach_vm_address_t, result_time);
532};
533extern kern_return_t mk_timer_cancel_trap(
534 struct mk_timer_cancel_trap_args *args);
535
91447636
A
536/* not published to LP64 clients yet */
537struct iokit_user_client_trap_args {
538 PAD_ARG_(void *, userClientRef);
539 PAD_ARG_(uint32_t, index);
540 PAD_ARG_(void *, p1);
541 PAD_ARG_(void *, p2);
542 PAD_ARG_(void *, p3);
543 PAD_ARG_(void *, p4);
544 PAD_ARG_(void *, p5);
545 PAD_ARG_(void *, p6);
546};
547kern_return_t iokit_user_client_trap(
548 struct iokit_user_client_trap_args *args);
549
550#undef PAD_
551#undef PADL_
552#undef PADR_
553#undef PAD_ARG_
554
555#endif /* XNU_KERNEL_PRIVATE */
556
557#endif /* KERNEL */
558
559__END_DECLS
55e303ae 560
1c79356b 561#endif /* _MACH_MACH_TRAPS_H_ */