2 * Copyright (c) 2000-2009 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 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.
62 * Routines to implement host ports.
64 #include <mach/message.h>
65 #include <mach/mach_traps.h>
66 #include <mach/mach_host_server.h>
67 #include <mach/host_priv_server.h>
68 #include <kern/host.h>
69 #include <kern/processor.h>
70 #include <kern/task.h>
71 #include <kern/thread.h>
72 #include <kern/ipc_host.h>
73 #include <kern/ipc_kobject.h>
74 #include <kern/misc_protos.h>
76 #include <ipc/ipc_port.h>
77 #include <ipc/ipc_space.h>
80 #include <security/mac_mach_internal.h>
84 * Forward declarations
89 ipc_port_t port
, boolean_t matchn
, processor_set_t
*ppset
);
92 * ipc_host_init: set up various things.
95 extern lck_grp_t host_notify_lock_grp
;
96 extern lck_attr_t host_notify_lock_attr
;
104 lck_mtx_init(&realhost
.lock
, &host_notify_lock_grp
, &host_notify_lock_attr
);
107 * Allocate and set up the two host ports.
109 port
= ipc_kobject_alloc_port((ipc_kobject_t
) &realhost
, IKOT_HOST_SECURITY
,
110 IPC_KOBJECT_ALLOC_MAKE_SEND
);
111 kernel_set_special_port(&realhost
, HOST_SECURITY_PORT
, port
);
113 port
= ipc_kobject_alloc_port((ipc_kobject_t
) &realhost
, IKOT_HOST
,
114 IPC_KOBJECT_ALLOC_MAKE_SEND
);
115 kernel_set_special_port(&realhost
, HOST_PORT
, port
);
117 port
= ipc_kobject_alloc_port((ipc_kobject_t
) &realhost
, IKOT_HOST_PRIV
,
118 IPC_KOBJECT_ALLOC_MAKE_SEND
);
119 kernel_set_special_port(&realhost
, HOST_PRIV_PORT
, port
);
121 /* the rest of the special ports will be set up later */
123 bzero(&realhost
.exc_actions
[0], sizeof(realhost
.exc_actions
[0]));
124 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
125 realhost
.exc_actions
[i
].port
= IP_NULL
;
126 /* The mac framework is not yet initialized, so we defer
127 * initializing the labels to later, when they are set
128 * for the first time. */
129 realhost
.exc_actions
[i
].label
= NULL
;
130 /* initialize the entire exception action struct */
131 realhost
.exc_actions
[i
].behavior
= 0;
132 realhost
.exc_actions
[i
].flavor
= 0;
133 realhost
.exc_actions
[i
].privileged
= FALSE
;
137 * Set up ipc for default processor set.
139 ipc_pset_init(&pset0
);
140 ipc_pset_enable(&pset0
);
143 * And for master processor
145 ipc_processor_init(master_processor
);
146 ipc_processor_enable(master_processor
);
150 * Routine: host_self_trap [mach trap]
152 * Give the caller send rights for his own host port.
156 * MACH_PORT_NULL if there are any resource failures
162 __unused
struct host_self_trap_args
*args
)
164 task_t self
= current_task();
166 mach_port_name_t name
;
169 sright
= ipc_port_copy_send(self
->itk_host
);
171 name
= ipc_port_copyout_send(sright
, current_space());
176 * ipc_processor_init:
178 * Initialize ipc access to processor by allocating port.
183 processor_t processor
)
187 port
= ipc_port_alloc_kernel();
188 if (port
== IP_NULL
) {
189 panic("ipc_processor_init");
191 processor
->processor_self
= port
;
195 * ipc_processor_enable:
197 * Enable ipc control of processor by setting port object.
200 ipc_processor_enable(
201 processor_t processor
)
205 myport
= processor
->processor_self
;
206 ipc_kobject_set(myport
, (ipc_kobject_t
) processor
, IKOT_PROCESSOR
);
212 * Initialize ipc control of a processor set by allocating its ports.
217 processor_set_t pset
)
221 port
= ipc_port_alloc_kernel();
222 if (port
== IP_NULL
) {
223 panic("ipc_pset_init");
225 pset
->pset_self
= port
;
227 port
= ipc_port_alloc_kernel();
228 if (port
== IP_NULL
) {
229 panic("ipc_pset_init");
231 pset
->pset_name_self
= port
;
237 * Enable ipc access to a processor set.
241 processor_set_t pset
)
243 ipc_kobject_set(pset
->pset_self
, (ipc_kobject_t
) pset
, IKOT_PSET
);
244 ipc_kobject_set(pset
->pset_name_self
, (ipc_kobject_t
) pset
, IKOT_PSET_NAME
);
248 * processor_set_default:
250 * Return ports for manipulating default_processor set.
253 processor_set_default(
255 processor_set_t
*pset
)
257 if (host
== HOST_NULL
) {
258 return KERN_INVALID_ARGUMENT
;
267 * Routine: convert_port_to_host
269 * Convert from a port to a host.
270 * Doesn't consume the port ref; the host produced may be null.
276 convert_port_to_host(
279 host_t host
= HOST_NULL
;
281 if (IP_VALID(port
)) {
282 if (ip_kotype(port
) == IKOT_HOST
||
283 ip_kotype(port
) == IKOT_HOST_PRIV
) {
284 host
= (host_t
) ip_get_kobject(port
);
285 require_ip_active(port
);
292 * Routine: convert_port_to_host_priv
294 * Convert from a port to a host.
295 * Doesn't consume the port ref; the host produced may be null.
301 convert_port_to_host_priv(
304 host_t host
= HOST_NULL
;
306 if (IP_VALID(port
)) {
308 if (ip_active(port
) &&
309 (ip_kotype(port
) == IKOT_HOST_PRIV
)) {
310 host
= (host_t
) ip_get_kobject(port
);
319 * Routine: convert_port_to_processor
321 * Convert from a port to a processor.
322 * Doesn't consume the port ref;
323 * the processor produced may be null.
329 convert_port_to_processor(
332 processor_t processor
= PROCESSOR_NULL
;
334 if (IP_VALID(port
)) {
336 if (ip_active(port
) &&
337 (ip_kotype(port
) == IKOT_PROCESSOR
)) {
338 processor
= (processor_t
) ip_get_kobject(port
);
347 * Routine: convert_port_to_pset
349 * Convert from a port to a pset.
350 * Doesn't consume the port ref; produces a pset ref,
357 convert_port_to_pset(
361 processor_set_t pset
= PROCESSOR_SET_NULL
;
364 while (!r
&& IP_VALID(port
)) {
366 r
= ref_pset_port_locked(port
, FALSE
, &pset
);
373 * Routine: convert_port_to_pset_name
375 * Convert from a port to a pset.
376 * Doesn't consume the port ref; produces a pset ref,
383 convert_port_to_pset_name(
387 processor_set_t pset
= PROCESSOR_SET_NULL
;
390 while (!r
&& IP_VALID(port
)) {
392 r
= ref_pset_port_locked(port
, TRUE
, &pset
);
399 ref_pset_port_locked(ipc_port_t port
, boolean_t matchn
, processor_set_t
*ppset
)
401 processor_set_t pset
;
403 pset
= PROCESSOR_SET_NULL
;
404 if (ip_active(port
) &&
405 ((ip_kotype(port
) == IKOT_PSET
) ||
406 (matchn
&& (ip_kotype(port
) == IKOT_PSET_NAME
)))) {
407 pset
= (processor_set_t
) ip_get_kobject(port
);
417 * Routine: convert_host_to_port
419 * Convert from a host to a port.
420 * Produces a naked send right which may be invalid.
426 convert_host_to_port(
431 host_get_host_port(host
, &port
);
436 * Routine: convert_processor_to_port
438 * Convert from a processor to a port.
439 * Produces a naked send right which may be invalid.
440 * Processors are not reference counted, so nothing to release.
446 convert_processor_to_port(
447 processor_t processor
)
449 ipc_port_t port
= processor
->processor_self
;
451 if (port
!= IP_NULL
) {
452 port
= ipc_port_make_send(port
);
458 * Routine: convert_pset_to_port
460 * Convert from a pset to a port.
461 * Produces a naked send right which may be invalid.
462 * Processor sets are not reference counted, so nothing to release.
468 convert_pset_to_port(
469 processor_set_t pset
)
471 ipc_port_t port
= pset
->pset_self
;
473 if (port
!= IP_NULL
) {
474 port
= ipc_port_make_send(port
);
481 * Routine: convert_pset_name_to_port
483 * Convert from a pset to a port.
484 * Produces a naked send right which may be invalid.
485 * Processor sets are not reference counted, so nothing to release.
491 convert_pset_name_to_port(
492 processor_set_name_t pset
)
494 ipc_port_t port
= pset
->pset_name_self
;
496 if (port
!= IP_NULL
) {
497 port
= ipc_port_make_send(port
);
504 * Routine: convert_port_to_host_security
506 * Convert from a port to a host security.
507 * Doesn't consume the port ref; the port produced may be null.
513 convert_port_to_host_security(
516 host_t host
= HOST_NULL
;
518 if (IP_VALID(port
)) {
520 if (ip_active(port
) &&
521 (ip_kotype(port
) == IKOT_HOST_SECURITY
)) {
522 host
= (host_t
) ip_get_kobject(port
);
531 * Routine: host_set_exception_ports [kernel call]
533 * Sets the host exception port, flavor and
534 * behavior for the exception types specified by the mask.
535 * There will be one send right per exception per valid
538 * Nothing locked. If successful, consumes
539 * the supplied send right.
541 * KERN_SUCCESS Changed the special port.
542 * KERN_INVALID_ARGUMENT The host_priv is not valid,
543 * Illegal mask bit set.
544 * Illegal exception behavior
547 host_set_exception_ports(
548 host_priv_t host_priv
,
549 exception_mask_t exception_mask
,
551 exception_behavior_t new_behavior
,
552 thread_state_flavor_t new_flavor
)
555 ipc_port_t old_port
[EXC_TYPES_COUNT
];
558 struct label
*deferred_labels
[EXC_TYPES_COUNT
];
559 struct label
*new_label
;
562 if (host_priv
== HOST_PRIV_NULL
) {
563 return KERN_INVALID_ARGUMENT
;
566 if (exception_mask
& ~EXC_MASK_VALID
) {
567 return KERN_INVALID_ARGUMENT
;
570 if (IP_VALID(new_port
)) {
571 switch (new_behavior
& ~MACH_EXCEPTION_MASK
) {
572 case EXCEPTION_DEFAULT
:
573 case EXCEPTION_STATE
:
574 case EXCEPTION_STATE_IDENTITY
:
577 return KERN_INVALID_ARGUMENT
;
582 * Check the validity of the thread_state_flavor by calling the
583 * VALID_THREAD_STATE_FLAVOR architecture dependent macro defined in
584 * osfmk/mach/ARCHITECTURE/thread_status.h
586 if (new_flavor
!= 0 && !VALID_THREAD_STATE_FLAVOR(new_flavor
)) {
587 return KERN_INVALID_ARGUMENT
;
591 if (mac_task_check_set_host_exception_ports(current_task(), exception_mask
) != 0) {
592 return KERN_NO_ACCESS
;
595 new_label
= mac_exc_create_label_for_current_proc();
597 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
598 if (host_priv
->exc_actions
[i
].label
== NULL
) {
599 deferred_labels
[i
] = mac_exc_create_label();
601 deferred_labels
[i
] = NULL
;
606 assert(host_priv
== &realhost
);
608 host_lock(host_priv
);
610 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
612 if (host_priv
->exc_actions
[i
].label
== NULL
) {
613 // Lazy initialization (see ipc_port_init).
614 mac_exc_associate_action_label(&host_priv
->exc_actions
[i
], deferred_labels
[i
]);
615 deferred_labels
[i
] = NULL
; // Label is used, do not free.
619 if ((exception_mask
& (1 << i
))
621 && mac_exc_update_action_label(&host_priv
->exc_actions
[i
], new_label
) == 0
624 old_port
[i
] = host_priv
->exc_actions
[i
].port
;
626 host_priv
->exc_actions
[i
].port
=
627 ipc_port_copy_send(new_port
);
628 host_priv
->exc_actions
[i
].behavior
= new_behavior
;
629 host_priv
->exc_actions
[i
].flavor
= new_flavor
;
631 old_port
[i
] = IP_NULL
;
636 * Consume send rights without any lock held.
638 host_unlock(host_priv
);
641 mac_exc_free_label(new_label
);
644 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
645 if (IP_VALID(old_port
[i
])) {
646 ipc_port_release_send(old_port
[i
]);
649 if (deferred_labels
[i
] != NULL
) {
650 /* Deferred label went unused: Another thread has completed the lazy initialization. */
651 mac_exc_free_label(deferred_labels
[i
]);
655 if (IP_VALID(new_port
)) { /* consume send right */
656 ipc_port_release_send(new_port
);
663 * Routine: host_get_exception_ports [kernel call]
665 * Clones a send right for each of the host's exception
666 * ports specified in the mask and returns the behaviour
667 * and flavor of said port.
669 * Returns upto [in} CountCnt elements.
674 * KERN_SUCCESS Extracted a send right.
675 * KERN_INVALID_ARGUMENT Invalid host_priv specified,
676 * Invalid special port,
677 * Illegal mask bit set.
678 * KERN_FAILURE The thread is dead.
681 host_get_exception_ports(
682 host_priv_t host_priv
,
683 exception_mask_t exception_mask
,
684 exception_mask_array_t masks
,
685 mach_msg_type_number_t
* CountCnt
,
686 exception_port_array_t ports
,
687 exception_behavior_array_t behaviors
,
688 thread_state_flavor_array_t flavors
)
690 unsigned int i
, j
, count
;
692 if (host_priv
== HOST_PRIV_NULL
) {
693 return KERN_INVALID_ARGUMENT
;
696 if (exception_mask
& ~EXC_MASK_VALID
) {
697 return KERN_INVALID_ARGUMENT
;
700 assert(host_priv
== &realhost
);
702 host_lock(host_priv
);
706 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
707 if (exception_mask
& (1 << i
)) {
708 for (j
= 0; j
< count
; j
++) {
710 * search for an identical entry, if found
711 * set corresponding mask for this exception.
713 if (host_priv
->exc_actions
[i
].port
== ports
[j
] &&
714 host_priv
->exc_actions
[i
].behavior
== behaviors
[j
]
715 && host_priv
->exc_actions
[i
].flavor
== flavors
[j
]) {
716 masks
[j
] |= (1 << i
);
723 ipc_port_copy_send(host_priv
->exc_actions
[i
].port
);
724 behaviors
[j
] = host_priv
->exc_actions
[i
].behavior
;
725 flavors
[j
] = host_priv
->exc_actions
[i
].flavor
;
727 if (count
> *CountCnt
) {
733 host_unlock(host_priv
);
740 host_swap_exception_ports(
741 host_priv_t host_priv
,
742 exception_mask_t exception_mask
,
744 exception_behavior_t new_behavior
,
745 thread_state_flavor_t new_flavor
,
746 exception_mask_array_t masks
,
747 mach_msg_type_number_t
* CountCnt
,
748 exception_port_array_t ports
,
749 exception_behavior_array_t behaviors
,
750 thread_state_flavor_array_t flavors
)
755 ipc_port_t old_port
[EXC_TYPES_COUNT
];
758 struct label
*deferred_labels
[EXC_TYPES_COUNT
];
759 struct label
*new_label
;
762 if (host_priv
== HOST_PRIV_NULL
) {
763 return KERN_INVALID_ARGUMENT
;
766 if (exception_mask
& ~EXC_MASK_VALID
) {
767 return KERN_INVALID_ARGUMENT
;
770 if (IP_VALID(new_port
)) {
771 switch (new_behavior
) {
772 case EXCEPTION_DEFAULT
:
773 case EXCEPTION_STATE
:
774 case EXCEPTION_STATE_IDENTITY
:
777 return KERN_INVALID_ARGUMENT
;
781 if (new_flavor
!= 0 && !VALID_THREAD_STATE_FLAVOR(new_flavor
)) {
782 return KERN_INVALID_ARGUMENT
;
786 if (mac_task_check_set_host_exception_ports(current_task(), exception_mask
) != 0) {
787 return KERN_NO_ACCESS
;
790 new_label
= mac_exc_create_label_for_current_proc();
792 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
793 if (host_priv
->exc_actions
[i
].label
== NULL
) {
794 deferred_labels
[i
] = mac_exc_create_label();
796 deferred_labels
[i
] = NULL
;
799 #endif /* CONFIG_MACF */
801 host_lock(host_priv
);
803 assert(EXC_TYPES_COUNT
> FIRST_EXCEPTION
);
804 for (count
= 0, i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
&& count
< *CountCnt
; i
++) {
806 if (host_priv
->exc_actions
[i
].label
== NULL
) {
807 // Lazy initialization (see ipc_port_init).
808 mac_exc_associate_action_label(&host_priv
->exc_actions
[i
], deferred_labels
[i
]);
809 deferred_labels
[i
] = NULL
; // Label is used, do not free.
813 if ((exception_mask
& (1 << i
))
815 && mac_exc_update_action_label(&host_priv
->exc_actions
[i
], new_label
) == 0
818 for (j
= 0; j
< count
; j
++) {
820 * search for an identical entry, if found
821 * set corresponding mask for this exception.
823 if (host_priv
->exc_actions
[i
].port
== ports
[j
] &&
824 host_priv
->exc_actions
[i
].behavior
== behaviors
[j
]
825 && host_priv
->exc_actions
[i
].flavor
== flavors
[j
]) {
826 masks
[j
] |= (1 << i
);
833 ipc_port_copy_send(host_priv
->exc_actions
[i
].port
);
834 behaviors
[j
] = host_priv
->exc_actions
[i
].behavior
;
835 flavors
[j
] = host_priv
->exc_actions
[i
].flavor
;
838 old_port
[i
] = host_priv
->exc_actions
[i
].port
;
839 host_priv
->exc_actions
[i
].port
=
840 ipc_port_copy_send(new_port
);
841 host_priv
->exc_actions
[i
].behavior
= new_behavior
;
842 host_priv
->exc_actions
[i
].flavor
= new_flavor
;
844 old_port
[i
] = IP_NULL
;
847 host_unlock(host_priv
);
850 mac_exc_free_label(new_label
);
854 * Consume send rights without any lock held.
856 while (--i
>= FIRST_EXCEPTION
) {
857 if (IP_VALID(old_port
[i
])) {
858 ipc_port_release_send(old_port
[i
]);
861 if (deferred_labels
[i
] != NULL
) {
862 mac_exc_free_label(deferred_labels
[i
]); // Label unused.
867 if (IP_VALID(new_port
)) { /* consume send right */
868 ipc_port_release_send(new_port
);