2 * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
34 * All Rights Reserved.
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.
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.
46 * Carnegie Mellon requests users of this software to return to
48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
59 * Definitions of general Mach system traps.
61 * These are the definitions as seen from user-space.
62 * The kernel definitions are in <mach/syscall_sw.h>.
63 * Kernel RPC functions are defined in <mach/mach_interface.h>.
66 #ifndef _MACH_MACH_TRAPS_H_
67 #define _MACH_MACH_TRAPS_H_
71 #include <mach/std_types.h>
72 #include <mach/mach_types.h>
73 #include <mach/kern_return.h>
74 #include <mach/port.h>
75 #include <mach/vm_types.h>
76 #include <mach/clock_types.h>
78 #include <machine/endian.h>
80 #include <sys/cdefs.h>
88 extern mach_port_name_t
mach_reply_port(void);
90 extern mach_port_name_t
thread_self_trap(void);
92 extern mach_port_name_t
host_self_trap(void);
94 extern 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
);
103 extern 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
);
114 extern kern_return_t
semaphore_signal_trap(
115 mach_port_name_t signal_name
);
117 extern kern_return_t
semaphore_signal_all_trap(
118 mach_port_name_t signal_name
);
120 extern kern_return_t
semaphore_signal_thread_trap(
121 mach_port_name_t signal_name
,
122 mach_port_name_t thread_name
);
124 extern kern_return_t
semaphore_wait_trap(
125 mach_port_name_t wait_name
);
127 extern kern_return_t
semaphore_wait_signal_trap(
128 mach_port_name_t wait_name
,
129 mach_port_name_t signal_name
);
131 extern kern_return_t
semaphore_timedwait_trap(
132 mach_port_name_t wait_name
,
136 extern kern_return_t
semaphore_timedwait_signal_trap(
137 mach_port_name_t wait_name
,
138 mach_port_name_t signal_name
,
144 extern kern_return_t
clock_sleep_trap(
145 mach_port_name_t clock_name
,
146 sleep_type_t sleep_type
,
149 mach_timespec_t
*wakeup_time
);
151 extern kern_return_t
_kernelrpc_mach_vm_allocate_trap(
152 mach_port_name_t target
,
153 mach_vm_offset_t
*addr
,
157 extern kern_return_t
_kernelrpc_mach_vm_deallocate_trap(
158 mach_port_name_t target
,
159 mach_vm_address_t address
,
163 extern kern_return_t
_kernelrpc_mach_vm_protect_trap(
164 mach_port_name_t target
,
165 mach_vm_address_t address
,
167 boolean_t set_maximum
,
168 vm_prot_t new_protection
171 extern kern_return_t
_kernelrpc_mach_port_allocate_trap(
172 mach_port_name_t target
,
173 mach_port_right_t right
,
174 mach_port_name_t
*name
178 extern kern_return_t
_kernelrpc_mach_port_destroy_trap(
179 mach_port_name_t target
,
180 mach_port_name_t name
183 extern kern_return_t
_kernelrpc_mach_port_deallocate_trap(
184 mach_port_name_t target
,
185 mach_port_name_t name
188 extern kern_return_t
_kernelrpc_mach_port_mod_refs_trap(
189 mach_port_name_t target
,
190 mach_port_name_t name
,
191 mach_port_right_t right
,
192 mach_port_delta_t delta
195 extern kern_return_t
_kernelrpc_mach_port_move_member_trap(
196 mach_port_name_t target
,
197 mach_port_name_t member
,
198 mach_port_name_t after
201 extern kern_return_t
_kernelrpc_mach_port_insert_right_trap(
202 mach_port_name_t target
,
203 mach_port_name_t name
,
204 mach_port_name_t poly
,
205 mach_msg_type_name_t polyPoly
208 extern kern_return_t
_kernelrpc_mach_port_insert_member_trap(
209 mach_port_name_t target
,
210 mach_port_name_t name
,
211 mach_port_name_t pset
214 extern kern_return_t
_kernelrpc_mach_port_extract_member_trap(
215 mach_port_name_t target
,
216 mach_port_name_t name
,
217 mach_port_name_t pset
220 extern kern_return_t
macx_swapon(
226 extern kern_return_t
macx_swapoff(
230 extern kern_return_t
macx_triggers(
234 mach_port_t alert_port
);
236 extern kern_return_t
macx_backing_store_suspend(
239 extern kern_return_t
macx_backing_store_recovery(
242 extern boolean_t
swtch_pri(int pri
);
244 extern boolean_t
swtch(void);
246 extern kern_return_t
thread_switch(
247 mach_port_name_t thread_name
,
249 mach_msg_timeout_t option_time
);
251 extern mach_port_name_t
task_self_trap(void);
254 * Obsolete interfaces.
257 extern kern_return_t
task_for_pid(
258 mach_port_name_t target_tport
,
260 mach_port_name_t
*t
);
262 extern kern_return_t
task_name_for_pid(
263 mach_port_name_t target_tport
,
265 mach_port_name_t
*tn
);
267 extern kern_return_t
pid_for_task(
271 #if !defined(__LP64__) && !defined(__arm__)
272 /* these should go away altogether - so no 64 legacy please */
274 extern kern_return_t
map_fd(
281 #endif /* !defined(__LP64__) && !defined(__arm__) */
285 #ifdef XNU_KERNEL_PRIVATE
287 /* Syscall data translations routines
289 * The kernel may support multiple userspace ABIs, and must use
290 * argument structures with elements large enough for any of them.
292 #define PAD_(t) (sizeof(uint64_t) <= sizeof(t) \
293 ? 0 : sizeof(uint64_t) - sizeof(t))
296 #if BYTE_ORDER == LITTLE_ENDIAN
298 #define PADR_(t) PAD_(t)
300 #define PADL_(t) PAD_(t)
304 #define PAD_ARG_(arg_type, arg_name) \
305 char arg_name##_l_[PADL_(arg_type)]; arg_type arg_name; char arg_name##_r_[PADR_(arg_type)];
308 * To support 32-bit clients as well as 64-bit clients, argument
309 * structures may need to be munged to repack the arguments. All
310 * active architectures do this inline in the code to dispatch Mach
311 * traps, without calling out to the BSD system call mungers.
314 #if 0 /* no active architectures use this */
315 void munge_w(const void *, void *);
316 void munge_ww(const void *, void *);
317 void munge_www(const void *, void *);
318 void munge_wwww(const void *, void *);
319 void munge_wwwww(const void *, void *);
320 void munge_wwwwww(const void *, void *);
321 void munge_wwwwwww(const void *, void *);
322 void munge_wwwwwwww(const void *, void *);
323 void munge_d(const void *, void *);
324 void munge_dd(const void *, void *);
325 void munge_ddd(const void *, void *);
326 void munge_dddd(const void *, void *);
327 void munge_ddddd(const void *, void *);
328 void munge_dddddd(const void *, void *);
329 void munge_ddddddd(const void *, void *);
330 void munge_dddddddd(const void *, void *);
331 void munge_l(const void *, void *);
332 void munge_lw(const void *, void *);
333 void munge_lwww(const void *, void *);
334 void munge_wl(const void *, void *);
335 void munge_wlw(const void *, void *);
336 void munge_wwwl(const void *, void *);
337 void munge_wwwwl(const void *, void *);
338 void munge_wwwwwl(const void *, void *);
341 struct kern_invalid_args
{
344 extern kern_return_t
kern_invalid(
345 struct kern_invalid_args
*args
);
347 struct mach_reply_port_args
{
350 extern mach_port_name_t
mach_reply_port(
351 struct mach_reply_port_args
*args
);
353 struct thread_self_trap_args
{
356 extern mach_port_name_t
thread_self_trap(
357 struct thread_self_trap_args
*args
);
359 struct task_self_trap_args
{
362 extern mach_port_name_t
task_self_trap(
363 struct task_self_trap_args
*args
);
365 struct host_self_trap_args
{
368 extern mach_port_name_t
host_self_trap(
369 struct host_self_trap_args
*args
);
371 struct mach_msg_overwrite_trap_args
{
372 PAD_ARG_(user_addr_t
, msg
);
373 PAD_ARG_(mach_msg_option_t
, option
);
374 PAD_ARG_(mach_msg_size_t
, send_size
);
375 PAD_ARG_(mach_msg_size_t
, rcv_size
);
376 PAD_ARG_(mach_port_name_t
, rcv_name
);
377 PAD_ARG_(mach_msg_timeout_t
, timeout
);
378 PAD_ARG_(mach_port_name_t
, notify
);
380 PAD_ARG_(user_addr_t
, rcv_msg
); /* Unused on mach_msg_trap */
382 extern mach_msg_return_t
mach_msg_trap(
383 struct mach_msg_overwrite_trap_args
*args
);
384 extern mach_msg_return_t
mach_msg_overwrite_trap(
385 struct mach_msg_overwrite_trap_args
*args
);
387 struct semaphore_signal_trap_args
{
388 PAD_ARG_(mach_port_name_t
, signal_name
);
390 extern kern_return_t
semaphore_signal_trap(
391 struct semaphore_signal_trap_args
*args
);
393 struct semaphore_signal_all_trap_args
{
394 PAD_ARG_(mach_port_name_t
, signal_name
);
396 extern kern_return_t
semaphore_signal_all_trap(
397 struct semaphore_signal_all_trap_args
*args
);
399 struct semaphore_signal_thread_trap_args
{
400 PAD_ARG_(mach_port_name_t
, signal_name
);
401 PAD_ARG_(mach_port_name_t
, thread_name
);
403 extern kern_return_t
semaphore_signal_thread_trap(
404 struct semaphore_signal_thread_trap_args
*args
);
406 struct semaphore_wait_trap_args
{
407 PAD_ARG_(mach_port_name_t
, wait_name
);
409 extern kern_return_t
semaphore_wait_trap(
410 struct semaphore_wait_trap_args
*args
);
412 struct semaphore_wait_signal_trap_args
{
413 PAD_ARG_(mach_port_name_t
, wait_name
);
414 PAD_ARG_(mach_port_name_t
, signal_name
);
416 extern kern_return_t
semaphore_wait_signal_trap(
417 struct semaphore_wait_signal_trap_args
*args
);
419 struct semaphore_timedwait_trap_args
{
420 PAD_ARG_(mach_port_name_t
, wait_name
);
421 PAD_ARG_(unsigned int, sec
);
422 PAD_ARG_(clock_res_t
, nsec
);
424 extern kern_return_t
semaphore_timedwait_trap(
425 struct semaphore_timedwait_trap_args
*args
);
427 struct semaphore_timedwait_signal_trap_args
{
428 PAD_ARG_(mach_port_name_t
, wait_name
);
429 PAD_ARG_(mach_port_name_t
, signal_name
);
430 PAD_ARG_(unsigned int, sec
);
431 PAD_ARG_(clock_res_t
, nsec
);
433 extern kern_return_t
semaphore_timedwait_signal_trap(
434 struct semaphore_timedwait_signal_trap_args
*args
);
436 #if !defined(CONFIG_EMBEDDED)
439 PAD_ARG_(vm_offset_t
, offset
);
440 PAD_ARG_(vm_offset_t
*, va
);
441 PAD_ARG_(boolean_t
, findspace
);
442 PAD_ARG_(vm_size_t
, size
);
444 extern kern_return_t
map_fd(
445 struct map_fd_args
*args
);
446 #endif /* !defined(CONFIG_EMBEDDED) */
448 struct task_for_pid_args
{
449 PAD_ARG_(mach_port_name_t
, target_tport
);
451 PAD_ARG_(user_addr_t
, t
);
453 extern kern_return_t
task_for_pid(
454 struct task_for_pid_args
*args
);
456 struct task_name_for_pid_args
{
457 PAD_ARG_(mach_port_name_t
, target_tport
);
459 PAD_ARG_(user_addr_t
, t
);
461 extern kern_return_t
task_name_for_pid(
462 struct task_name_for_pid_args
*args
);
464 struct pid_for_task_args
{
465 PAD_ARG_(mach_port_name_t
, t
);
466 PAD_ARG_(user_addr_t
, pid
);
468 extern kern_return_t
pid_for_task(
469 struct pid_for_task_args
*args
);
471 struct macx_swapon_args
{
472 PAD_ARG_(uint64_t, filename
);
473 PAD_ARG_(int, flags
);
475 PAD_ARG_(int, priority
);
477 extern kern_return_t
macx_swapon(
478 struct macx_swapon_args
*args
);
480 struct macx_swapoff_args
{
481 PAD_ARG_(uint64_t, filename
);
482 PAD_ARG_(int, flags
);
484 extern kern_return_t
macx_swapoff(
485 struct macx_swapoff_args
*args
);
487 struct macx_triggers_args
{
488 PAD_ARG_(int, hi_water
);
489 PAD_ARG_(int, low_water
);
490 PAD_ARG_(int, flags
);
491 PAD_ARG_(mach_port_t
, alert_port
);
493 extern kern_return_t
macx_triggers(
494 struct macx_triggers_args
*args
);
496 struct macx_backing_store_suspend_args
{
497 PAD_ARG_(boolean_t
, suspend
);
499 extern kern_return_t
macx_backing_store_suspend(
500 struct macx_backing_store_suspend_args
*args
);
502 struct macx_backing_store_recovery_args
{
505 extern kern_return_t
macx_backing_store_recovery(
506 struct macx_backing_store_recovery_args
*args
);
508 struct swtch_pri_args
{
511 extern boolean_t
swtch_pri(
512 struct swtch_pri_args
*args
);
514 struct pfz_exit_args
{
517 extern kern_return_t
pfz_exit(
518 struct pfz_exit_args
*args
);
523 extern boolean_t
swtch(
524 struct swtch_args
*args
);
526 struct clock_sleep_trap_args
{
527 PAD_ARG_(mach_port_name_t
, clock_name
);
528 PAD_ARG_(sleep_type_t
, sleep_type
);
529 PAD_ARG_(int, sleep_sec
);
530 PAD_ARG_(int, sleep_nsec
);
531 PAD_ARG_(user_addr_t
, wakeup_time
);
533 extern kern_return_t
clock_sleep_trap(
534 struct clock_sleep_trap_args
*args
);
536 struct thread_switch_args
{
537 PAD_ARG_(mach_port_name_t
, thread_name
);
538 PAD_ARG_(int, option
);
539 PAD_ARG_(mach_msg_timeout_t
, option_time
);
541 extern kern_return_t
thread_switch(
542 struct thread_switch_args
*args
);
544 struct mach_timebase_info_trap_args
{
545 PAD_ARG_(user_addr_t
, info
);
547 extern kern_return_t
mach_timebase_info_trap(
548 struct mach_timebase_info_trap_args
*args
);
550 struct mach_wait_until_trap_args
{
551 PAD_ARG_(uint64_t, deadline
);
553 extern kern_return_t
mach_wait_until_trap(
554 struct mach_wait_until_trap_args
*args
);
556 struct mk_timer_create_trap_args
{
559 extern mach_port_name_t
mk_timer_create_trap(
560 struct mk_timer_create_trap_args
*args
);
562 struct mk_timer_destroy_trap_args
{
563 PAD_ARG_(mach_port_name_t
, name
);
565 extern kern_return_t
mk_timer_destroy_trap(
566 struct mk_timer_destroy_trap_args
*args
);
568 struct mk_timer_arm_trap_args
{
569 PAD_ARG_(mach_port_name_t
, name
);
570 PAD_ARG_(uint64_t, expire_time
);
572 extern kern_return_t
mk_timer_arm_trap(
573 struct mk_timer_arm_trap_args
*args
);
575 struct mk_timer_cancel_trap_args
{
576 PAD_ARG_(mach_port_name_t
, name
);
577 PAD_ARG_(user_addr_t
, result_time
);
579 extern kern_return_t
mk_timer_cancel_trap(
580 struct mk_timer_cancel_trap_args
*args
);
582 struct _kernelrpc_mach_vm_allocate_trap_args
{
583 PAD_ARG_(mach_port_name_t
, target
); /* 1 word */
584 PAD_ARG_(user_addr_t
, addr
); /* 1 word */
585 PAD_ARG_(mach_vm_size_t
, size
); /* 2 words */
586 PAD_ARG_(int, flags
); /* 1 word */
589 extern kern_return_t
_kernelrpc_mach_vm_allocate_trap(
590 struct _kernelrpc_mach_vm_allocate_trap_args
*args
);
592 struct _kernelrpc_mach_vm_deallocate_args
{
593 PAD_ARG_(mach_port_name_t
, target
); /* 1 word */
594 PAD_ARG_(mach_vm_address_t
, address
); /* 2 words */
595 PAD_ARG_(mach_vm_size_t
, size
); /* 2 words */
597 extern kern_return_t
_kernelrpc_mach_vm_deallocate_trap(
598 struct _kernelrpc_mach_vm_deallocate_args
*args
);
600 struct _kernelrpc_mach_vm_protect_args
{
601 PAD_ARG_(mach_port_name_t
, target
); /* 1 word */
602 PAD_ARG_(mach_vm_address_t
, address
); /* 2 words */
603 PAD_ARG_(mach_vm_size_t
, size
); /* 2 words */
604 PAD_ARG_(boolean_t
, set_maximum
); /* 1 word */
605 PAD_ARG_(vm_prot_t
, new_protection
); /* 1 word */
607 extern kern_return_t
_kernelrpc_mach_vm_protect_trap(
608 struct _kernelrpc_mach_vm_protect_args
*args
);
610 struct _kernelrpc_mach_port_allocate_args
{
611 PAD_ARG_(mach_port_name_t
, target
);
612 PAD_ARG_(mach_port_right_t
, right
);
613 PAD_ARG_(user_addr_t
, name
);
615 extern kern_return_t
_kernelrpc_mach_port_allocate_trap(
616 struct _kernelrpc_mach_port_allocate_args
*args
);
619 struct _kernelrpc_mach_port_destroy_args
{
620 PAD_ARG_(mach_port_name_t
, target
);
621 PAD_ARG_(mach_port_name_t
, name
);
623 extern kern_return_t
_kernelrpc_mach_port_destroy_trap(
624 struct _kernelrpc_mach_port_destroy_args
*args
);
626 struct _kernelrpc_mach_port_deallocate_args
{
627 PAD_ARG_(mach_port_name_t
, target
);
628 PAD_ARG_(mach_port_name_t
, name
);
630 extern kern_return_t
_kernelrpc_mach_port_deallocate_trap(
631 struct _kernelrpc_mach_port_deallocate_args
*args
);
633 struct _kernelrpc_mach_port_mod_refs_args
{
634 PAD_ARG_(mach_port_name_t
, target
);
635 PAD_ARG_(mach_port_name_t
, name
);
636 PAD_ARG_(mach_port_right_t
, right
);
637 PAD_ARG_(mach_port_delta_t
, delta
);
639 extern kern_return_t
_kernelrpc_mach_port_mod_refs_trap(
640 struct _kernelrpc_mach_port_mod_refs_args
*args
);
642 struct _kernelrpc_mach_port_move_member_args
{
643 PAD_ARG_(mach_port_name_t
, target
);
644 PAD_ARG_(mach_port_name_t
, member
);
645 PAD_ARG_(mach_port_name_t
, after
);
647 extern kern_return_t
_kernelrpc_mach_port_move_member_trap(
648 struct _kernelrpc_mach_port_move_member_args
*args
);
650 struct _kernelrpc_mach_port_insert_right_args
{
651 PAD_ARG_(mach_port_name_t
, target
);
652 PAD_ARG_(mach_port_name_t
, name
);
653 PAD_ARG_(mach_port_name_t
, poly
);
654 PAD_ARG_(mach_msg_type_name_t
, polyPoly
);
656 extern kern_return_t
_kernelrpc_mach_port_insert_right_trap(
657 struct _kernelrpc_mach_port_insert_right_args
*args
);
659 struct _kernelrpc_mach_port_insert_member_args
{
660 PAD_ARG_(mach_port_name_t
, target
);
661 PAD_ARG_(mach_port_name_t
, name
);
662 PAD_ARG_(mach_port_name_t
, pset
);
664 extern kern_return_t
_kernelrpc_mach_port_insert_member_trap(
665 struct _kernelrpc_mach_port_insert_member_args
*args
);
667 struct _kernelrpc_mach_port_extract_member_args
{
668 PAD_ARG_(mach_port_name_t
, target
);
669 PAD_ARG_(mach_port_name_t
, name
);
670 PAD_ARG_(mach_port_name_t
, pset
);
672 extern kern_return_t
_kernelrpc_mach_port_extract_member_trap(
673 struct _kernelrpc_mach_port_extract_member_args
*args
);
675 /* not published to LP64 clients yet */
676 struct iokit_user_client_trap_args
{
677 PAD_ARG_(void *, userClientRef
);
678 PAD_ARG_(uint32_t, index
);
679 PAD_ARG_(void *, p1
);
680 PAD_ARG_(void *, p2
);
681 PAD_ARG_(void *, p3
);
682 PAD_ARG_(void *, p4
);
683 PAD_ARG_(void *, p5
);
685 PAD_ARG_(void *, p6
);
687 kern_return_t
iokit_user_client_trap(
688 struct iokit_user_client_trap_args
*args
);
696 #endif /* XNU_KERNEL_PRIVATE */
702 #endif /* _MACH_MACH_TRAPS_H_ */