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
;
98 void ipc_host_init(void)
103 lck_mtx_init(&realhost
.lock
, &host_notify_lock_grp
, &host_notify_lock_attr
);
106 * Allocate and set up the two host ports.
108 port
= ipc_port_alloc_kernel();
110 panic("ipc_host_init");
112 ipc_kobject_set(port
, (ipc_kobject_t
) &realhost
, IKOT_HOST_SECURITY
);
113 kernel_set_special_port(&realhost
, HOST_SECURITY_PORT
,
114 ipc_port_make_send(port
));
116 port
= ipc_port_alloc_kernel();
118 panic("ipc_host_init");
120 ipc_kobject_set(port
, (ipc_kobject_t
) &realhost
, IKOT_HOST
);
121 kernel_set_special_port(&realhost
, HOST_PORT
,
122 ipc_port_make_send(port
));
124 port
= ipc_port_alloc_kernel();
126 panic("ipc_host_init");
128 ipc_kobject_set(port
, (ipc_kobject_t
) &realhost
, IKOT_HOST_PRIV
);
129 kernel_set_special_port(&realhost
, HOST_PRIV_PORT
,
130 ipc_port_make_send(port
));
132 /* the rest of the special ports will be set up later */
134 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
135 realhost
.exc_actions
[i
].port
= IP_NULL
;
136 /* The mac framework is not yet initialized, so we defer
137 * initializing the labels to later, when they are set
138 * for the first time. */
139 realhost
.exc_actions
[i
].label
= NULL
;
143 * Set up ipc for default processor set.
145 ipc_pset_init(&pset0
);
146 ipc_pset_enable(&pset0
);
149 * And for master processor
151 ipc_processor_init(master_processor
);
152 ipc_processor_enable(master_processor
);
156 * Routine: host_self_trap [mach trap]
158 * Give the caller send rights for his own host port.
162 * MACH_PORT_NULL if there are any resource failures
168 __unused
struct host_self_trap_args
*args
)
170 task_t self
= current_task();
172 mach_port_name_t name
;
175 sright
= ipc_port_copy_send(self
->itk_host
);
177 name
= ipc_port_copyout_send(sright
, current_space());
182 * ipc_processor_init:
184 * Initialize ipc access to processor by allocating port.
189 processor_t processor
)
193 port
= ipc_port_alloc_kernel();
195 panic("ipc_processor_init");
196 processor
->processor_self
= port
;
200 * ipc_processor_enable:
202 * Enable ipc control of processor by setting port object.
205 ipc_processor_enable(
206 processor_t processor
)
210 myport
= processor
->processor_self
;
211 ipc_kobject_set(myport
, (ipc_kobject_t
) processor
, IKOT_PROCESSOR
);
217 * Initialize ipc control of a processor set by allocating its ports.
222 processor_set_t pset
)
226 port
= ipc_port_alloc_kernel();
228 panic("ipc_pset_init");
229 pset
->pset_self
= port
;
231 port
= ipc_port_alloc_kernel();
233 panic("ipc_pset_init");
234 pset
->pset_name_self
= port
;
240 * Enable ipc access to a processor set.
244 processor_set_t pset
)
246 ipc_kobject_set(pset
->pset_self
, (ipc_kobject_t
) pset
, IKOT_PSET
);
247 ipc_kobject_set(pset
->pset_name_self
, (ipc_kobject_t
) pset
, IKOT_PSET_NAME
);
251 * processor_set_default:
253 * Return ports for manipulating default_processor set.
256 processor_set_default(
258 processor_set_t
*pset
)
260 if (host
== HOST_NULL
)
261 return(KERN_INVALID_ARGUMENT
);
265 return (KERN_SUCCESS
);
269 * Routine: convert_port_to_host
271 * Convert from a port to a host.
272 * Doesn't consume the port ref; the host produced may be null.
278 convert_port_to_host(
281 host_t host
= HOST_NULL
;
283 if (IP_VALID(port
)) {
284 if (ip_kotype(port
) == IKOT_HOST
||
285 ip_kotype(port
) == IKOT_HOST_PRIV
) {
286 host
= (host_t
) port
->ip_kobject
;
287 assert(ip_active(port
));
294 * Routine: convert_port_to_host_priv
296 * Convert from a port to a host.
297 * Doesn't consume the port ref; the host produced may be null.
303 convert_port_to_host_priv(
306 host_t host
= HOST_NULL
;
308 if (IP_VALID(port
)) {
310 if (ip_active(port
) &&
311 (ip_kotype(port
) == IKOT_HOST_PRIV
))
312 host
= (host_t
) port
->ip_kobject
;
320 * Routine: convert_port_to_processor
322 * Convert from a port to a processor.
323 * Doesn't consume the port ref;
324 * the processor produced may be null.
330 convert_port_to_processor(
333 processor_t processor
= PROCESSOR_NULL
;
335 if (IP_VALID(port
)) {
337 if (ip_active(port
) &&
338 (ip_kotype(port
) == IKOT_PROCESSOR
))
339 processor
= (processor_t
) port
->ip_kobject
;
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
) port
->ip_kobject
;
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
;
452 port
= ipc_port_make_send(port
);
457 * Routine: convert_pset_to_port
459 * Convert from a pset to a port.
460 * Produces a naked send right which may be invalid.
461 * Processor sets are not reference counted, so nothing to release.
467 convert_pset_to_port(
468 processor_set_t pset
)
470 ipc_port_t port
= pset
->pset_self
;
473 port
= ipc_port_make_send(port
);
479 * Routine: convert_pset_name_to_port
481 * Convert from a pset to a port.
482 * Produces a naked send right which may be invalid.
483 * Processor sets are not reference counted, so nothing to release.
489 convert_pset_name_to_port(
490 processor_set_name_t pset
)
492 ipc_port_t port
= pset
->pset_name_self
;
495 port
= ipc_port_make_send(port
);
501 * Routine: convert_port_to_host_security
503 * Convert from a port to a host security.
504 * Doesn't consume the port ref; the port produced may be null.
510 convert_port_to_host_security(
513 host_t host
= HOST_NULL
;
515 if (IP_VALID(port
)) {
517 if (ip_active(port
) &&
518 (ip_kotype(port
) == IKOT_HOST_SECURITY
))
519 host
= (host_t
) port
->ip_kobject
;
527 * Routine: host_set_exception_ports [kernel call]
529 * Sets the host exception port, flavor and
530 * behavior for the exception types specified by the mask.
531 * There will be one send right per exception per valid
534 * Nothing locked. If successful, consumes
535 * the supplied send right.
537 * KERN_SUCCESS Changed the special port.
538 * KERN_INVALID_ARGUMENT The host_priv is not valid,
539 * Illegal mask bit set.
540 * Illegal exception behavior
543 host_set_exception_ports(
544 host_priv_t host_priv
,
545 exception_mask_t exception_mask
,
547 exception_behavior_t new_behavior
,
548 thread_state_flavor_t new_flavor
)
551 ipc_port_t old_port
[EXC_TYPES_COUNT
];
554 struct label
*deferred_labels
[EXC_TYPES_COUNT
];
555 struct label
*new_label
;
558 if (host_priv
== HOST_PRIV_NULL
) {
559 return KERN_INVALID_ARGUMENT
;
562 if (exception_mask
& ~EXC_MASK_VALID
) {
563 return KERN_INVALID_ARGUMENT
;
566 if (IP_VALID(new_port
)) {
567 switch (new_behavior
& ~MACH_EXCEPTION_CODES
) {
568 case EXCEPTION_DEFAULT
:
569 case EXCEPTION_STATE
:
570 case EXCEPTION_STATE_IDENTITY
:
573 return KERN_INVALID_ARGUMENT
;
578 * Check the validity of the thread_state_flavor by calling the
579 * VALID_THREAD_STATE_FLAVOR architecture dependent macro defined in
580 * osfmk/mach/ARCHITECTURE/thread_status.h
582 if (new_flavor
!= 0 && !VALID_THREAD_STATE_FLAVOR(new_flavor
))
583 return (KERN_INVALID_ARGUMENT
);
586 if (mac_task_check_set_host_exception_ports(current_task(), exception_mask
) != 0)
587 return KERN_NO_ACCESS
;
589 new_label
= mac_exc_create_label_for_current_proc();
591 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
592 if (host_priv
->exc_actions
[i
].label
== NULL
) {
593 deferred_labels
[i
] = mac_exc_create_label();
595 deferred_labels
[i
] = NULL
;
600 assert(host_priv
== &realhost
);
602 host_lock(host_priv
);
604 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
606 if (host_priv
->exc_actions
[i
].label
== NULL
) {
607 // Lazy initialization (see ipc_port_init).
608 mac_exc_associate_action_label(&host_priv
->exc_actions
[i
], deferred_labels
[i
]);
609 deferred_labels
[i
] = NULL
; // Label is used, do not free.
613 if ((exception_mask
& (1 << i
))
615 && mac_exc_update_action_label(&host_priv
->exc_actions
[i
], new_label
) == 0
618 old_port
[i
] = host_priv
->exc_actions
[i
].port
;
620 host_priv
->exc_actions
[i
].port
=
621 ipc_port_copy_send(new_port
);
622 host_priv
->exc_actions
[i
].behavior
= new_behavior
;
623 host_priv
->exc_actions
[i
].flavor
= new_flavor
;
625 old_port
[i
] = IP_NULL
;
630 * Consume send rights without any lock held.
632 host_unlock(host_priv
);
635 mac_exc_free_label(new_label
);
638 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
639 if (IP_VALID(old_port
[i
]))
640 ipc_port_release_send(old_port
[i
]);
642 if (deferred_labels
[i
] != NULL
) {
643 /* Deferred label went unused: Another thread has completed the lazy initialization. */
644 mac_exc_free_label(deferred_labels
[i
]);
648 if (IP_VALID(new_port
)) /* consume send right */
649 ipc_port_release_send(new_port
);
655 * Routine: host_get_exception_ports [kernel call]
657 * Clones a send right for each of the host's exception
658 * ports specified in the mask and returns the behaviour
659 * and flavor of said port.
661 * Returns upto [in} CountCnt elements.
666 * KERN_SUCCESS Extracted a send right.
667 * KERN_INVALID_ARGUMENT Invalid host_priv specified,
668 * Invalid special port,
669 * Illegal mask bit set.
670 * KERN_FAILURE The thread is dead.
673 host_get_exception_ports(
674 host_priv_t host_priv
,
675 exception_mask_t exception_mask
,
676 exception_mask_array_t masks
,
677 mach_msg_type_number_t
* CountCnt
,
678 exception_port_array_t ports
,
679 exception_behavior_array_t behaviors
,
680 thread_state_flavor_array_t flavors
)
682 unsigned int i
, j
, count
;
684 if (host_priv
== HOST_PRIV_NULL
)
685 return KERN_INVALID_ARGUMENT
;
687 if (exception_mask
& ~EXC_MASK_VALID
) {
688 return KERN_INVALID_ARGUMENT
;
691 assert (host_priv
== &realhost
);
693 host_lock(host_priv
);
697 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
698 if (exception_mask
& (1 << i
)) {
699 for (j
= 0; j
< count
; j
++) {
701 * search for an identical entry, if found
702 * set corresponding mask for this exception.
704 if (host_priv
->exc_actions
[i
].port
== ports
[j
] &&
705 host_priv
->exc_actions
[i
].behavior
== behaviors
[j
]
706 && host_priv
->exc_actions
[i
].flavor
== flavors
[j
])
708 masks
[j
] |= (1 << i
);
715 ipc_port_copy_send(host_priv
->exc_actions
[i
].port
);
716 behaviors
[j
] = host_priv
->exc_actions
[i
].behavior
;
717 flavors
[j
] = host_priv
->exc_actions
[i
].flavor
;
719 if (count
> *CountCnt
) {
725 host_unlock(host_priv
);
732 host_swap_exception_ports(
733 host_priv_t host_priv
,
734 exception_mask_t exception_mask
,
736 exception_behavior_t new_behavior
,
737 thread_state_flavor_t new_flavor
,
738 exception_mask_array_t masks
,
739 mach_msg_type_number_t
* CountCnt
,
740 exception_port_array_t ports
,
741 exception_behavior_array_t behaviors
,
742 thread_state_flavor_array_t flavors
)
747 ipc_port_t old_port
[EXC_TYPES_COUNT
];
750 struct label
*deferred_labels
[EXC_TYPES_COUNT
];
751 struct label
*new_label
;
754 if (host_priv
== HOST_PRIV_NULL
)
755 return KERN_INVALID_ARGUMENT
;
757 if (exception_mask
& ~EXC_MASK_VALID
) {
758 return KERN_INVALID_ARGUMENT
;
761 if (IP_VALID(new_port
)) {
762 switch (new_behavior
) {
763 case EXCEPTION_DEFAULT
:
764 case EXCEPTION_STATE
:
765 case EXCEPTION_STATE_IDENTITY
:
768 return KERN_INVALID_ARGUMENT
;
772 if (new_flavor
!= 0 && !VALID_THREAD_STATE_FLAVOR(new_flavor
))
773 return (KERN_INVALID_ARGUMENT
);
776 if (mac_task_check_set_host_exception_ports(current_task(), exception_mask
) != 0)
777 return KERN_NO_ACCESS
;
779 new_label
= mac_exc_create_label_for_current_proc();
781 for (i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
; i
++) {
782 if (host_priv
->exc_actions
[i
].label
== NULL
) {
783 deferred_labels
[i
] = mac_exc_create_label();
785 deferred_labels
[i
] = NULL
;
788 #endif /* CONFIG_MACF */
790 host_lock(host_priv
);
792 assert(EXC_TYPES_COUNT
> FIRST_EXCEPTION
);
793 for (count
=0, i
= FIRST_EXCEPTION
; i
< EXC_TYPES_COUNT
&& count
< *CountCnt
; i
++) {
795 if (host_priv
->exc_actions
[i
].label
== NULL
) {
796 // Lazy initialization (see ipc_port_init).
797 mac_exc_associate_action_label(&host_priv
->exc_actions
[i
], deferred_labels
[i
]);
798 deferred_labels
[i
] = NULL
; // Label is used, do not free.
802 if ((exception_mask
& (1 << i
))
804 && mac_exc_update_action_label(&host_priv
->exc_actions
[i
], new_label
) == 0
807 for (j
= 0; j
< count
; j
++) {
809 * search for an identical entry, if found
810 * set corresponding mask for this exception.
812 if (host_priv
->exc_actions
[i
].port
== ports
[j
] &&
813 host_priv
->exc_actions
[i
].behavior
== behaviors
[j
]
814 && host_priv
->exc_actions
[i
].flavor
== flavors
[j
])
816 masks
[j
] |= (1 << i
);
823 ipc_port_copy_send(host_priv
->exc_actions
[i
].port
);
824 behaviors
[j
] = host_priv
->exc_actions
[i
].behavior
;
825 flavors
[j
] = host_priv
->exc_actions
[i
].flavor
;
828 old_port
[i
] = host_priv
->exc_actions
[i
].port
;
829 host_priv
->exc_actions
[i
].port
=
830 ipc_port_copy_send(new_port
);
831 host_priv
->exc_actions
[i
].behavior
= new_behavior
;
832 host_priv
->exc_actions
[i
].flavor
= new_flavor
;
834 old_port
[i
] = IP_NULL
;
837 host_unlock(host_priv
);
840 mac_exc_free_label(new_label
);
844 * Consume send rights without any lock held.
846 while (--i
>= FIRST_EXCEPTION
) {
847 if (IP_VALID(old_port
[i
]))
848 ipc_port_release_send(old_port
[i
]);
850 if (deferred_labels
[i
] != NULL
) {
851 mac_exc_free_label(deferred_labels
[i
]); // Label unused.
856 if (IP_VALID(new_port
)) /* consume send right */
857 ipc_port_release_send(new_port
);