2 * Copyright (c) 2000-2020 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 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.
57 * NOTICE: This file was modified by McAfee Research in 2004 to introduce
58 * support for mandatory and extensible security protections. This notice
59 * is included in support of clause 2.2 (b) of the Apple Public License,
61 * Copyright (c) 2005 SPARTA, Inc.
66 * File: ipc/ipc_init.c
70 * Functions to initialize the IPC system.
73 #include <mach_debug.h>
75 #include <mach/port.h>
76 #include <mach/message.h>
77 #include <mach/kern_return.h>
79 #include <kern/kern_types.h>
80 #include <kern/arcade.h>
81 #include <kern/kalloc.h>
82 #include <kern/simple_lock.h>
83 #include <kern/mach_param.h>
84 #include <kern/ipc_host.h>
85 #include <kern/ipc_kobject.h>
86 #include <kern/ipc_mig.h>
87 #include <kern/host_notify.h>
88 #include <kern/mk_timer.h>
89 #include <kern/misc_protos.h>
90 #include <kern/suid_cred.h>
91 #include <kern/sync_lock.h>
92 #include <kern/sync_sema.h>
93 #include <kern/ux_handler.h>
94 #include <vm/vm_map.h>
95 #include <vm/vm_kern.h>
97 #include <ipc/ipc_entry.h>
98 #include <ipc/ipc_space.h>
99 #include <ipc/ipc_object.h>
100 #include <ipc/ipc_port.h>
101 #include <ipc/ipc_pset.h>
102 #include <ipc/ipc_notify.h>
103 #include <ipc/ipc_kmsg.h>
104 #include <ipc/ipc_hash.h>
105 #include <ipc/ipc_init.h>
106 #include <ipc/ipc_table.h>
107 #include <ipc/ipc_voucher.h>
108 #include <ipc/ipc_importance.h>
109 #include <ipc/ipc_eventlink.h>
111 #include <mach/machine/ndr_def.h> /* NDR_record */
113 #define IPC_KERNEL_MAP_SIZE (CONFIG_IPC_KERNEL_MAP_SIZE * 1024 * 1024)
114 SECURITY_READ_ONLY_LATE(vm_map_t
) ipc_kernel_map
;
116 /* values to limit physical copy out-of-line memory descriptors */
117 SECURITY_READ_ONLY_LATE(vm_map_t
) ipc_kernel_copy_map
;
118 #define IPC_KERNEL_COPY_MAP_SIZE (8 * 1024 * 1024)
119 const vm_size_t ipc_kmsg_max_vm_space
= ((IPC_KERNEL_COPY_MAP_SIZE
* 7) / 8);
122 * values to limit inline message body handling
123 * avoid copyin/out limits - even after accounting for maximum descriptor expansion.
125 #define IPC_KMSG_MAX_SPACE (64 * 1024 * 1024) /* keep in sync with COPYSIZELIMIT_PANIC */
126 const vm_size_t ipc_kmsg_max_body_space
= ((IPC_KMSG_MAX_SPACE
* 3) / 4 - MAX_TRAILER_SIZE
);
128 #if XNU_TARGET_OS_OSX
129 #define IPC_CONTROL_PORT_OPTIONS_DEFAULT IPC_CONTROL_PORT_OPTIONS_NONE
131 #define IPC_CONTROL_PORT_OPTIONS_DEFAULT (IPC_CONTROL_PORT_OPTIONS_IMMOVABLE_HARD | IPC_CONTROL_PORT_OPTIONS_PINNED_SOFT)
134 TUNABLE(ipc_control_port_options_t
, ipc_control_port_options
,
135 "ipc_control_port_options", IPC_CONTROL_PORT_OPTIONS_DEFAULT
);
137 SECURITY_READ_ONLY_LATE(bool) pinned_control_port_enabled
;
138 SECURITY_READ_ONLY_LATE(bool) immovable_control_port_enabled
;
141 LCK_GRP_DECLARE(ipc_lck_grp
, "ipc");
142 LCK_ATTR_DECLARE(ipc_lck_attr
, 0, 0);
145 * XXX tunable, belongs in mach.message.h
147 #define MSG_OOL_SIZE_SMALL_MAX (2*PAGE_SIZE)
148 SECURITY_READ_ONLY_LATE(vm_size_t
) msg_ool_size_small
;
153 * Final initialization
162 /* create special spaces */
164 kr
= ipc_space_create_special(&ipc_space_kernel
);
165 assert(kr
== KERN_SUCCESS
);
167 kr
= ipc_space_create_special(&ipc_space_reply
);
168 assert(kr
== KERN_SUCCESS
);
170 /* initialize modules with hidden data structures */
172 #if IMPORTANCE_INHERITANCE
173 ipc_importance_init();
179 pinned_control_port_enabled
= !!(ipc_control_port_options
& (IPC_CONTROL_PORT_OPTIONS_PINNED_SOFT
| IPC_CONTROL_PORT_OPTIONS_PINNED_HARD
));
180 immovable_control_port_enabled
= !!(ipc_control_port_options
& (IPC_CONTROL_PORT_OPTIONS_IMMOVABLE_SOFT
| IPC_CONTROL_PORT_OPTIONS_IMMOVABLE_HARD
));
182 if (pinned_control_port_enabled
&& !immovable_control_port_enabled
) {
183 kprintf("Invalid ipc_control_port_options boot-arg: pinned control port cannot be enabled without immovability enforcement. Ignoring pinning boot-arg.");
184 pinned_control_port_enabled
= false;
185 ipc_control_port_options
&= ~(IPC_CONTROL_PORT_OPTIONS_PINNED_SOFT
| IPC_CONTROL_PORT_OPTIONS_PINNED_HARD
);
188 kr
= kmem_suballoc(kernel_map
, &min
, IPC_KERNEL_MAP_SIZE
,
191 VM_MAP_KERNEL_FLAGS_NONE
,
195 if (kr
!= KERN_SUCCESS
) {
196 panic("ipc_init: kmem_suballoc of ipc_kernel_map failed");
199 kr
= kmem_suballoc(kernel_map
, &min
, IPC_KERNEL_COPY_MAP_SIZE
,
202 VM_MAP_KERNEL_FLAGS_NONE
,
204 &ipc_kernel_copy_map
);
206 if (kr
!= KERN_SUCCESS
) {
207 panic("ipc_init: kmem_suballoc of ipc_kernel_copy_map failed");
210 ipc_kernel_copy_map
->no_zero_fill
= TRUE
;
211 ipc_kernel_copy_map
->wait_for_space
= TRUE
;
214 * As an optimization, 'small' out of line data regions using a
215 * physical copy strategy are copied into kalloc'ed buffers.
216 * The value of 'small' is determined here. Requests kalloc()
217 * with sizes greater or equal to kalloc_max_prerounded may fail.
219 if (kalloc_max_prerounded
<= MSG_OOL_SIZE_SMALL_MAX
) {
220 msg_ool_size_small
= kalloc_max_prerounded
;
222 msg_ool_size_small
= MSG_OOL_SIZE_SMALL_MAX
;
228 STARTUP(MACH_IPC
, STARTUP_RANK_LAST
, ipc_init
);
232 * Routine: ipc_thread_call_init
234 * Initialize IPC logic that needs thread call support
238 ipc_thread_call_init(void)
240 #if IMPORTANCE_INHERITANCE
241 ipc_importance_thread_call_init();