xref: /xnu-8019.80.24/osfmk/ipc/ipc_init.c (revision a325d9c4a84054e40bbe985afedcb50ab80993ea)
1 /*
2  * Copyright (c) 2000-2020 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
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
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /*
29  * @OSF_COPYRIGHT@
30  */
31 /*
32  * Mach Operating System
33  * Copyright (c) 1991,1990,1989 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  [email protected]
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  * 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,
60  * Version 2.0.
61  * Copyright (c) 2005 SPARTA, Inc.
62  */
63 /*
64  */
65 /*
66  *	File:	ipc/ipc_init.c
67  *	Author:	Rich Draves
68  *	Date:	1989
69  *
70  *	Functions to initialize the IPC system.
71  */
72 
73 #include <mach_debug.h>
74 
75 #include <mach/port.h>
76 #include <mach/message.h>
77 #include <mach/kern_return.h>
78 
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/misc_protos.h>
89 #include <kern/suid_cred.h>
90 #include <kern/sync_sema.h>
91 #include <kern/ux_handler.h>
92 #include <vm/vm_map.h>
93 #include <vm/vm_kern.h>
94 
95 #include <ipc/ipc_entry.h>
96 #include <ipc/ipc_space.h>
97 #include <ipc/ipc_object.h>
98 #include <ipc/ipc_port.h>
99 #include <ipc/ipc_pset.h>
100 #include <ipc/ipc_notify.h>
101 #include <ipc/ipc_kmsg.h>
102 #include <ipc/ipc_hash.h>
103 #include <ipc/ipc_init.h>
104 #include <ipc/ipc_table.h>
105 #include <ipc/ipc_voucher.h>
106 #include <ipc/ipc_importance.h>
107 #include <ipc/ipc_eventlink.h>
108 
109 #include <mach/machine/ndr_def.h>   /* NDR_record */
110 
111 #define IPC_KERNEL_MAP_SIZE      (CONFIG_IPC_KERNEL_MAP_SIZE * 1024 * 1024)
112 SECURITY_READ_ONLY_LATE(vm_map_t) ipc_kernel_map;
113 
114 /* values to limit physical copy out-of-line memory descriptors */
115 SECURITY_READ_ONLY_LATE(vm_map_t) ipc_kernel_copy_map;
116 #define IPC_KERNEL_COPY_MAP_SIZE (8 * 1024 * 1024)
117 const vm_size_t ipc_kmsg_max_vm_space = ((IPC_KERNEL_COPY_MAP_SIZE * 7) / 8);
118 
119 /*
120  * values to limit inline message body handling
121  * avoid copyin/out limits - even after accounting for maximum descriptor expansion.
122  */
123 #define IPC_KMSG_MAX_SPACE (64 * 1024 * 1024) /* keep in sync with COPYSIZELIMIT_PANIC */
124 const vm_size_t ipc_kmsg_max_body_space = ((IPC_KMSG_MAX_SPACE * 3) / 4 - MAX_TRAILER_SIZE);
125 
126 #if XNU_TARGET_OS_OSX
127 #define IPC_CONTROL_PORT_OPTIONS_DEFAULT (ICP_OPTIONS_NONE)
128 #else
129 #define IPC_CONTROL_PORT_OPTIONS_DEFAULT (ICP_OPTIONS_IMMOVABLE_ALL_HARD | \
130 	ICP_OPTIONS_PINNED_1P_HARD | \
131 	ICP_OPTIONS_PINNED_3P_SOFT)
132 #endif
133 
134 TUNABLE(ipc_control_port_options_t, ipc_control_port_options,
135     "ipc_control_port_options", IPC_CONTROL_PORT_OPTIONS_DEFAULT);
136 
137 LCK_GRP_DECLARE(ipc_lck_grp, "ipc");
138 LCK_ATTR_DECLARE(ipc_lck_attr, 0, 0);
139 
140 /*
141  * XXX tunable, belongs in mach.message.h
142  */
143 #define MSG_OOL_SIZE_SMALL_MAX (2*PAGE_SIZE)
144 SECURITY_READ_ONLY_LATE(vm_size_t) msg_ool_size_small;
145 
146 /*
147  *	Routine:	ipc_init
148  *	Purpose:
149  *		Final initialization
150  */
151 __startup_func
152 static void
ipc_init(void)153 ipc_init(void)
154 {
155 	kern_return_t kr;
156 	vm_offset_t min;
157 
158 	/* create special spaces */
159 
160 	kr = ipc_space_create_special(&ipc_space_kernel);
161 	assert(kr == KERN_SUCCESS);
162 
163 	kr = ipc_space_create_special(&ipc_space_reply);
164 	assert(kr == KERN_SUCCESS);
165 
166 	/* initialize modules with hidden data structures */
167 
168 #if IMPORTANCE_INHERITANCE
169 	ipc_importance_init();
170 #endif
171 #if CONFIG_ARCADE
172 	arcade_init();
173 #endif
174 
175 	bool pinned_control_port_enabled_1p = !!(ipc_control_port_options & ICP_OPTIONS_1P_PINNED);
176 	bool immovable_control_port_enabled_1p = !!(ipc_control_port_options & ICP_OPTIONS_1P_IMMOVABLE);
177 
178 	bool pinned_control_port_enabled_3p = !!(ipc_control_port_options & ICP_OPTIONS_3P_PINNED);
179 	bool immovable_control_port_enabled_3p = !!(ipc_control_port_options & ICP_OPTIONS_3P_IMMOVABLE);
180 
181 	if (pinned_control_port_enabled_1p && !immovable_control_port_enabled_1p) {
182 		kprintf("Invalid ipc_control_port_options boot-arg: pinned control port cannot be enabled without immovability enforcement. Ignoring 1p pinning boot-arg.");
183 		ipc_control_port_options &= ~ICP_OPTIONS_1P_PINNED;
184 	}
185 
186 	if (pinned_control_port_enabled_3p && !immovable_control_port_enabled_3p) {
187 		kprintf("Invalid ipc_control_port_options boot-arg: pinned control port cannot be enabled without immovability enforcement. Ignoring 3p pinning boot-arg.");
188 		ipc_control_port_options &= ~ICP_OPTIONS_3P_PINNED;
189 	}
190 
191 	kr = kmem_suballoc(kernel_map, &min, IPC_KERNEL_MAP_SIZE,
192 	    TRUE,
193 	    (VM_FLAGS_ANYWHERE),
194 	    VM_MAP_KERNEL_FLAGS_NONE,
195 	    VM_KERN_MEMORY_IPC,
196 	    &ipc_kernel_map);
197 
198 	if (kr != KERN_SUCCESS) {
199 		panic("ipc_init: kmem_suballoc of ipc_kernel_map failed");
200 	}
201 
202 	kr = kmem_suballoc(kernel_map, &min, IPC_KERNEL_COPY_MAP_SIZE,
203 	    TRUE,
204 	    (VM_FLAGS_ANYWHERE),
205 	    VM_MAP_KERNEL_FLAGS_NONE,
206 	    VM_KERN_MEMORY_IPC,
207 	    &ipc_kernel_copy_map);
208 
209 	if (kr != KERN_SUCCESS) {
210 		panic("ipc_init: kmem_suballoc of ipc_kernel_copy_map failed");
211 	}
212 
213 	ipc_kernel_copy_map->no_zero_fill = TRUE;
214 	ipc_kernel_copy_map->wait_for_space = TRUE;
215 
216 	/*
217 	 * As an optimization, 'small' out of line data regions using a
218 	 * physical copy strategy are copied into kalloc'ed buffers.
219 	 * The value of 'small' is determined here.  Requests kalloc()
220 	 * with sizes greater or equal to kalloc_max_prerounded may fail.
221 	 */
222 	if (kalloc_max_prerounded <= MSG_OOL_SIZE_SMALL_MAX) {
223 		msg_ool_size_small = kalloc_max_prerounded;
224 	} else {
225 		msg_ool_size_small = MSG_OOL_SIZE_SMALL_MAX;
226 	}
227 
228 	ipc_host_init();
229 	ux_handler_init();
230 }
231 STARTUP(MACH_IPC, STARTUP_RANK_LAST, ipc_init);
232