xref: /xnu-12377.1.9/libsa/bootstrap.cpp (revision f6217f891ac0bb64f3d375211650a4c1ff8ca1ea)
1*f6217f89SApple OSS Distributions /*
2*f6217f89SApple OSS Distributions  * Copyright (c) 2000-2012 Apple Inc. All rights reserved.
3*f6217f89SApple OSS Distributions  *
4*f6217f89SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*f6217f89SApple OSS Distributions  *
6*f6217f89SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*f6217f89SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*f6217f89SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*f6217f89SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*f6217f89SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*f6217f89SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*f6217f89SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*f6217f89SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*f6217f89SApple OSS Distributions  *
15*f6217f89SApple OSS Distributions  * Please obtain a copy of the License at
16*f6217f89SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*f6217f89SApple OSS Distributions  *
18*f6217f89SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*f6217f89SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*f6217f89SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*f6217f89SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*f6217f89SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*f6217f89SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*f6217f89SApple OSS Distributions  * limitations under the License.
25*f6217f89SApple OSS Distributions  *
26*f6217f89SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*f6217f89SApple OSS Distributions  */
28*f6217f89SApple OSS Distributions extern "C" {
29*f6217f89SApple OSS Distributions #include <mach/kmod.h>
30*f6217f89SApple OSS Distributions #include <libkern/kernel_mach_header.h>
31*f6217f89SApple OSS Distributions #include <libkern/prelink.h>
32*f6217f89SApple OSS Distributions #include <libkern/crypto/sha2.h>
33*f6217f89SApple OSS Distributions }
34*f6217f89SApple OSS Distributions 
35*f6217f89SApple OSS Distributions #define IOKIT_ENABLE_SHARED_PTR
36*f6217f89SApple OSS Distributions 
37*f6217f89SApple OSS Distributions #include <libkern/version.h>
38*f6217f89SApple OSS Distributions #include <libkern/c++/OSContainers.h>
39*f6217f89SApple OSS Distributions #include <libkern/OSKextLibPrivate.h>
40*f6217f89SApple OSS Distributions #include <libkern/c++/OSKext.h>
41*f6217f89SApple OSS Distributions #include <IOKit/IOLib.h>
42*f6217f89SApple OSS Distributions #include <IOKit/IOService.h>
43*f6217f89SApple OSS Distributions #include <IOKit/IODeviceTreeSupport.h>
44*f6217f89SApple OSS Distributions #include <IOKit/IOCatalogue.h>
45*f6217f89SApple OSS Distributions 
46*f6217f89SApple OSS Distributions #if __x86_64__
47*f6217f89SApple OSS Distributions #define KASLR_KEXT_DEBUG 0
48*f6217f89SApple OSS Distributions #endif
49*f6217f89SApple OSS Distributions 
50*f6217f89SApple OSS Distributions #if PRAGMA_MARK
51*f6217f89SApple OSS Distributions #pragma mark Bootstrap Declarations
52*f6217f89SApple OSS Distributions #endif
53*f6217f89SApple OSS Distributions /*********************************************************************
54*f6217f89SApple OSS Distributions * Bootstrap Declarations
55*f6217f89SApple OSS Distributions *
56*f6217f89SApple OSS Distributions * The ENTIRE point of the libsa/KLD segment is to isolate bootstrap
57*f6217f89SApple OSS Distributions * code from other parts of the kernel, so function symbols are not
58*f6217f89SApple OSS Distributions * exported; rather pointers to those functions are exported.
59*f6217f89SApple OSS Distributions *
60*f6217f89SApple OSS Distributions * xxx - need to think about locking for handling the 'weak' refs.
61*f6217f89SApple OSS Distributions * xxx - do export a non-KLD function that says you've called a
62*f6217f89SApple OSS Distributions * xxx - bootstrap function that has been removed.
63*f6217f89SApple OSS Distributions *
64*f6217f89SApple OSS Distributions * ALL call-ins to this segment of the kernel must be done through
65*f6217f89SApple OSS Distributions * exported pointers. The symbols themselves are private and not to
66*f6217f89SApple OSS Distributions * be linked against.
67*f6217f89SApple OSS Distributions *********************************************************************/
68*f6217f89SApple OSS Distributions extern "C" {
69*f6217f89SApple OSS Distributions extern void (*record_startup_extensions_function)(void);
70*f6217f89SApple OSS Distributions extern void (*load_security_extensions_function)(void);
71*f6217f89SApple OSS Distributions };
72*f6217f89SApple OSS Distributions 
73*f6217f89SApple OSS Distributions static void bootstrapRecordStartupExtensions(void);
74*f6217f89SApple OSS Distributions static void bootstrapLoadSecurityExtensions(void);
75*f6217f89SApple OSS Distributions 
76*f6217f89SApple OSS Distributions 
77*f6217f89SApple OSS Distributions #if NO_KEXTD
78*f6217f89SApple OSS Distributions extern "C" bool IORamDiskBSDRoot(void);
79*f6217f89SApple OSS Distributions #endif
80*f6217f89SApple OSS Distributions 
81*f6217f89SApple OSS Distributions #if PRAGMA_MARK
82*f6217f89SApple OSS Distributions #pragma mark Macros
83*f6217f89SApple OSS Distributions #endif
84*f6217f89SApple OSS Distributions /*********************************************************************
85*f6217f89SApple OSS Distributions * Macros
86*f6217f89SApple OSS Distributions *********************************************************************/
87*f6217f89SApple OSS Distributions #define CONST_STRLEN(str) (sizeof(str) - 1)
88*f6217f89SApple OSS Distributions 
89*f6217f89SApple OSS Distributions #if PRAGMA_MARK
90*f6217f89SApple OSS Distributions #pragma mark Kernel Component Kext Identifiers
91*f6217f89SApple OSS Distributions #endif
92*f6217f89SApple OSS Distributions /*********************************************************************
93*f6217f89SApple OSS Distributions * Kernel Component Kext Identifiers
94*f6217f89SApple OSS Distributions *
95*f6217f89SApple OSS Distributions * We could have each kernel resource kext automatically "load" as
96*f6217f89SApple OSS Distributions * it's created, but it's nicer to have them listed in kextstat in
97*f6217f89SApple OSS Distributions * the order of this list. We'll walk through this after setting up
98*f6217f89SApple OSS Distributions * all the boot kexts and have them load up.
99*f6217f89SApple OSS Distributions *********************************************************************/
100*f6217f89SApple OSS Distributions static const char * sKernelComponentNames[] = {
101*f6217f89SApple OSS Distributions 	// The kexts for these IDs must have a version matching 'osrelease'.
102*f6217f89SApple OSS Distributions 	"com.apple.kernel",
103*f6217f89SApple OSS Distributions 	"com.apple.kpi.bsd",
104*f6217f89SApple OSS Distributions 	"com.apple.kpi.dsep",
105*f6217f89SApple OSS Distributions 	"com.apple.kpi.iokit",
106*f6217f89SApple OSS Distributions 	"com.apple.kpi.kasan",
107*f6217f89SApple OSS Distributions 	"com.apple.kpi.kcov",
108*f6217f89SApple OSS Distributions 	"com.apple.kpi.libkern",
109*f6217f89SApple OSS Distributions 	"com.apple.kpi.mach",
110*f6217f89SApple OSS Distributions 	"com.apple.kpi.private",
111*f6217f89SApple OSS Distributions 	"com.apple.kpi.unsupported",
112*f6217f89SApple OSS Distributions 	"com.apple.iokit.IONVRAMFamily",
113*f6217f89SApple OSS Distributions 	"com.apple.driver.AppleNMI",
114*f6217f89SApple OSS Distributions 	"com.apple.iokit.IOSystemManagementFamily",
115*f6217f89SApple OSS Distributions 	"com.apple.iokit.ApplePlatformFamily",
116*f6217f89SApple OSS Distributions 	NULL
117*f6217f89SApple OSS Distributions };
118*f6217f89SApple OSS Distributions 
119*f6217f89SApple OSS Distributions #if PRAGMA_MARK
120*f6217f89SApple OSS Distributions #pragma mark KLDBootstrap Class
121*f6217f89SApple OSS Distributions #endif
122*f6217f89SApple OSS Distributions /*********************************************************************
123*f6217f89SApple OSS Distributions * KLDBootstrap Class
124*f6217f89SApple OSS Distributions *
125*f6217f89SApple OSS Distributions * We use a C++ class here so that it can be a friend of OSKext and
126*f6217f89SApple OSS Distributions * get at private stuff. We can't hide the class itself, but we can
127*f6217f89SApple OSS Distributions * hide the instance through which we invoke the functions.
128*f6217f89SApple OSS Distributions *********************************************************************/
129*f6217f89SApple OSS Distributions class KLDBootstrap {
130*f6217f89SApple OSS Distributions 	friend void bootstrapRecordStartupExtensions(void);
131*f6217f89SApple OSS Distributions 	friend void bootstrapLoadSecurityExtensions(void);
132*f6217f89SApple OSS Distributions 
133*f6217f89SApple OSS Distributions private:
134*f6217f89SApple OSS Distributions 	void readStartupExtensions(void);
135*f6217f89SApple OSS Distributions 
136*f6217f89SApple OSS Distributions 	void readPrelinkedExtensions(kernel_mach_header_t *mh, kc_kind_t type);
137*f6217f89SApple OSS Distributions 	void readBooterExtensions(void);
138*f6217f89SApple OSS Distributions 
139*f6217f89SApple OSS Distributions 	OSReturn loadKernelComponentKexts(void);
140*f6217f89SApple OSS Distributions 	void     loadKernelExternalComponents(void);
141*f6217f89SApple OSS Distributions 	void     readBuiltinPersonalities(void);
142*f6217f89SApple OSS Distributions 
143*f6217f89SApple OSS Distributions 	void     loadSecurityExtensions(void);
144*f6217f89SApple OSS Distributions 
145*f6217f89SApple OSS Distributions public:
146*f6217f89SApple OSS Distributions 	KLDBootstrap(void);
147*f6217f89SApple OSS Distributions 	~KLDBootstrap(void);
148*f6217f89SApple OSS Distributions };
149*f6217f89SApple OSS Distributions 
150*f6217f89SApple OSS Distributions LIBKERN_ALWAYS_DESTROY static KLDBootstrap sBootstrapObject;
151*f6217f89SApple OSS Distributions 
152*f6217f89SApple OSS Distributions /*********************************************************************
153*f6217f89SApple OSS Distributions * Set the function pointers for the entry points into the bootstrap
154*f6217f89SApple OSS Distributions * segment upon C++ static constructor invocation.
155*f6217f89SApple OSS Distributions *********************************************************************/
KLDBootstrap(void)156*f6217f89SApple OSS Distributions KLDBootstrap::KLDBootstrap(void)
157*f6217f89SApple OSS Distributions {
158*f6217f89SApple OSS Distributions 	if (this != &sBootstrapObject) {
159*f6217f89SApple OSS Distributions 		panic("Attempt to access bootstrap segment.");
160*f6217f89SApple OSS Distributions 	}
161*f6217f89SApple OSS Distributions 	record_startup_extensions_function = &bootstrapRecordStartupExtensions;
162*f6217f89SApple OSS Distributions 	load_security_extensions_function = &bootstrapLoadSecurityExtensions;
163*f6217f89SApple OSS Distributions }
164*f6217f89SApple OSS Distributions 
165*f6217f89SApple OSS Distributions /*********************************************************************
166*f6217f89SApple OSS Distributions * Clear the function pointers for the entry points into the bootstrap
167*f6217f89SApple OSS Distributions * segment upon C++ static destructor invocation.
168*f6217f89SApple OSS Distributions *********************************************************************/
~KLDBootstrap(void)169*f6217f89SApple OSS Distributions KLDBootstrap::~KLDBootstrap(void)
170*f6217f89SApple OSS Distributions {
171*f6217f89SApple OSS Distributions 	if (this != &sBootstrapObject) {
172*f6217f89SApple OSS Distributions 		panic("Attempt to access bootstrap segment.");
173*f6217f89SApple OSS Distributions 	}
174*f6217f89SApple OSS Distributions 
175*f6217f89SApple OSS Distributions 
176*f6217f89SApple OSS Distributions 	record_startup_extensions_function = NULL;
177*f6217f89SApple OSS Distributions 	load_security_extensions_function = NULL;
178*f6217f89SApple OSS Distributions }
179*f6217f89SApple OSS Distributions 
180*f6217f89SApple OSS Distributions /*********************************************************************
181*f6217f89SApple OSS Distributions *********************************************************************/
182*f6217f89SApple OSS Distributions void
readStartupExtensions(void)183*f6217f89SApple OSS Distributions KLDBootstrap::readStartupExtensions(void)
184*f6217f89SApple OSS Distributions {
185*f6217f89SApple OSS Distributions 	kernel_section_t * prelinkInfoSect = NULL; // do not free
186*f6217f89SApple OSS Distributions 
187*f6217f89SApple OSS Distributions 	OSKextLog(/* kext */ NULL,
188*f6217f89SApple OSS Distributions 	    kOSKextLogProgressLevel |
189*f6217f89SApple OSS Distributions 	    kOSKextLogGeneralFlag | kOSKextLogDirectoryScanFlag |
190*f6217f89SApple OSS Distributions 	    kOSKextLogKextBookkeepingFlag,
191*f6217f89SApple OSS Distributions 	    "Reading startup extensions.");
192*f6217f89SApple OSS Distributions 
193*f6217f89SApple OSS Distributions 	kc_format_t kc_format;
194*f6217f89SApple OSS Distributions 	kernel_mach_header_t *mh = &_mh_execute_header;
195*f6217f89SApple OSS Distributions 	if (PE_get_primary_kc_format(&kc_format) && kc_format == KCFormatFileset) {
196*f6217f89SApple OSS Distributions 		mh = (kernel_mach_header_t *)PE_get_kc_header(KCKindPrimary);
197*f6217f89SApple OSS Distributions 	}
198*f6217f89SApple OSS Distributions 
199*f6217f89SApple OSS Distributions 	/* If the prelink info segment has a nonzero size, we are prelinked
200*f6217f89SApple OSS Distributions 	 * and won't have any individual kexts or mkexts to read.
201*f6217f89SApple OSS Distributions 	 * Otherwise, we need to read kexts or the mkext from what the booter
202*f6217f89SApple OSS Distributions 	 * has handed us.
203*f6217f89SApple OSS Distributions 	 */
204*f6217f89SApple OSS Distributions 	prelinkInfoSect = getsectbynamefromheader(mh, kPrelinkInfoSegment, kPrelinkInfoSection);
205*f6217f89SApple OSS Distributions 	if (prelinkInfoSect->size) {
206*f6217f89SApple OSS Distributions 		readPrelinkedExtensions(mh, KCKindPrimary);
207*f6217f89SApple OSS Distributions 	} else {
208*f6217f89SApple OSS Distributions 		readBooterExtensions();
209*f6217f89SApple OSS Distributions 	}
210*f6217f89SApple OSS Distributions 
211*f6217f89SApple OSS Distributions 	kernel_mach_header_t *akc_mh;
212*f6217f89SApple OSS Distributions 	akc_mh = (kernel_mach_header_t*)PE_get_kc_header(KCKindAuxiliary);
213*f6217f89SApple OSS Distributions 	if (akc_mh) {
214*f6217f89SApple OSS Distributions 		readPrelinkedExtensions(akc_mh, KCKindAuxiliary);
215*f6217f89SApple OSS Distributions 	}
216*f6217f89SApple OSS Distributions 
217*f6217f89SApple OSS Distributions 	loadKernelComponentKexts();
218*f6217f89SApple OSS Distributions 	loadKernelExternalComponents();
219*f6217f89SApple OSS Distributions 	readBuiltinPersonalities();
220*f6217f89SApple OSS Distributions 	OSKext::sendAllKextPersonalitiesToCatalog(true);
221*f6217f89SApple OSS Distributions 
222*f6217f89SApple OSS Distributions 	return;
223*f6217f89SApple OSS Distributions }
224*f6217f89SApple OSS Distributions 
225*f6217f89SApple OSS Distributions /*********************************************************************
226*f6217f89SApple OSS Distributions *********************************************************************/
227*f6217f89SApple OSS Distributions void
readPrelinkedExtensions(kernel_mach_header_t * mh,kc_kind_t type)228*f6217f89SApple OSS Distributions KLDBootstrap::readPrelinkedExtensions(kernel_mach_header_t *mh, kc_kind_t type)
229*f6217f89SApple OSS Distributions {
230*f6217f89SApple OSS Distributions 	bool ret;
231*f6217f89SApple OSS Distributions 	OSSharedPtr<OSData> loaded_kcUUID;
232*f6217f89SApple OSS Distributions 	OSSharedPtr<OSString> errorString;
233*f6217f89SApple OSS Distributions 	OSSharedPtr<OSObject> parsedXML;
234*f6217f89SApple OSS Distributions 	kernel_section_t *infoPlistSection = NULL;
235*f6217f89SApple OSS Distributions 	OSDictionary *infoDict = NULL;         // do not release
236*f6217f89SApple OSS Distributions 
237*f6217f89SApple OSS Distributions 	OSKextLog(/* kext */ NULL,
238*f6217f89SApple OSS Distributions 	    kOSKextLogProgressLevel |
239*f6217f89SApple OSS Distributions 	    kOSKextLogDirectoryScanFlag | kOSKextLogArchiveFlag,
240*f6217f89SApple OSS Distributions 	    "Starting from prelinked kernel.");
241*f6217f89SApple OSS Distributions 
242*f6217f89SApple OSS Distributions 	/*
243*f6217f89SApple OSS Distributions 	 * The 'infoPlistSection' should contains an XML dictionary that
244*f6217f89SApple OSS Distributions 	 * contains some meta data about the KC, and also describes each kext
245*f6217f89SApple OSS Distributions 	 * included in the kext collection. Unserialize this dictionary and
246*f6217f89SApple OSS Distributions 	 * then iterate over each kext.
247*f6217f89SApple OSS Distributions 	 */
248*f6217f89SApple OSS Distributions 	infoPlistSection = getsectbynamefromheader(mh, kPrelinkInfoSegment, kPrelinkInfoSection);
249*f6217f89SApple OSS Distributions 	parsedXML = OSUnserializeXML((const char *)infoPlistSection->addr, errorString);
250*f6217f89SApple OSS Distributions 	if (parsedXML) {
251*f6217f89SApple OSS Distributions 		infoDict = OSDynamicCast(OSDictionary, parsedXML.get());
252*f6217f89SApple OSS Distributions 	}
253*f6217f89SApple OSS Distributions 
254*f6217f89SApple OSS Distributions 	if (!infoDict) {
255*f6217f89SApple OSS Distributions 		const char *errorCString = "(unknown error)";
256*f6217f89SApple OSS Distributions 
257*f6217f89SApple OSS Distributions 		if (errorString && errorString->getCStringNoCopy()) {
258*f6217f89SApple OSS Distributions 			errorCString = errorString->getCStringNoCopy();
259*f6217f89SApple OSS Distributions 		} else if (parsedXML) {
260*f6217f89SApple OSS Distributions 			errorCString = "not a dictionary";
261*f6217f89SApple OSS Distributions 		}
262*f6217f89SApple OSS Distributions 		OSKextLog(/* kext */ NULL, kOSKextLogErrorLevel | kOSKextLogArchiveFlag,
263*f6217f89SApple OSS Distributions 		    "Error unserializing kext info plist section: %s.", errorCString);
264*f6217f89SApple OSS Distributions 		return;
265*f6217f89SApple OSS Distributions 	}
266*f6217f89SApple OSS Distributions 
267*f6217f89SApple OSS Distributions 	/* Validate that the Kext Collection is prelinked to the loaded KC */
268*f6217f89SApple OSS Distributions 	if (type == KCKindAuxiliary) {
269*f6217f89SApple OSS Distributions 		if (OSKext::validateKCFileSetUUID(infoDict, KCKindAuxiliary) != 0) {
270*f6217f89SApple OSS Distributions 			OSKextLog(/* kext */ NULL, kOSKextLogErrorLevel | kOSKextLogArchiveFlag,
271*f6217f89SApple OSS Distributions 			    "Early boot AuxKC  doesn't appear to be linked against the loaded BootKC.");
272*f6217f89SApple OSS Distributions 			return;
273*f6217f89SApple OSS Distributions 		}
274*f6217f89SApple OSS Distributions 
275*f6217f89SApple OSS Distributions 		/*
276*f6217f89SApple OSS Distributions 		 * Defer further processing of the AuxKC, but keep the
277*f6217f89SApple OSS Distributions 		 * processed info dictionary around so we can ml_static_free
278*f6217f89SApple OSS Distributions 		 * the segment.
279*f6217f89SApple OSS Distributions 		 */
280*f6217f89SApple OSS Distributions 		if (!OSKext::registerDeferredKextCollection(mh, parsedXML, KCKindAuxiliary)) {
281*f6217f89SApple OSS Distributions 			OSKextLog(/* kext */ NULL, kOSKextLogErrorLevel | kOSKextLogArchiveFlag,
282*f6217f89SApple OSS Distributions 			    "Error deferring AuxKC kext processing: Kexts in this collection will be unusable.");
283*f6217f89SApple OSS Distributions 		}
284*f6217f89SApple OSS Distributions 		goto skip_adding_kexts;
285*f6217f89SApple OSS Distributions 	}
286*f6217f89SApple OSS Distributions 
287*f6217f89SApple OSS Distributions 	/*
288*f6217f89SApple OSS Distributions 	 * this function does all the heavy lifting of adding OSKext objects
289*f6217f89SApple OSS Distributions 	 * and potentially sliding them if necessary
290*f6217f89SApple OSS Distributions 	 */
291*f6217f89SApple OSS Distributions 	ret = OSKext::addKextsFromKextCollection(mh, infoDict,
292*f6217f89SApple OSS Distributions 	    kPrelinkTextSegment, loaded_kcUUID, (mh->filetype == MH_FILESET) ? type : KCKindUnknown);
293*f6217f89SApple OSS Distributions 
294*f6217f89SApple OSS Distributions 	if (!ret) {
295*f6217f89SApple OSS Distributions 		OSKextLog(/* kext */ NULL, kOSKextLogErrorLevel | kOSKextLogArchiveFlag,
296*f6217f89SApple OSS Distributions 		    "Error loading kext info from prelinked primary KC");
297*f6217f89SApple OSS Distributions 		return;
298*f6217f89SApple OSS Distributions 	}
299*f6217f89SApple OSS Distributions 
300*f6217f89SApple OSS Distributions 	/* Copy in the kernelcache UUID */
301*f6217f89SApple OSS Distributions 	if (!loaded_kcUUID) {
302*f6217f89SApple OSS Distributions 		OSKextLog(/* kext */ NULL, kOSKextLogErrorLevel | kOSKextLogArchiveFlag,
303*f6217f89SApple OSS Distributions 		    "WARNING: did not find UUID in %s KC!", (type == KCKindAuxiliary) ? "Aux" : "Primary");
304*f6217f89SApple OSS Distributions 	} else if (type != KCKindAuxiliary) {
305*f6217f89SApple OSS Distributions 		kernelcache_uuid_valid = TRUE;
306*f6217f89SApple OSS Distributions 		memcpy((void *)&kernelcache_uuid, (const void *)loaded_kcUUID->getBytesNoCopy(), loaded_kcUUID->getLength());
307*f6217f89SApple OSS Distributions 		uuid_unparse_upper(kernelcache_uuid, kernelcache_uuid_string);
308*f6217f89SApple OSS Distributions 	} else {
309*f6217f89SApple OSS Distributions 		auxkc_uuid_valid = TRUE;
310*f6217f89SApple OSS Distributions 		memcpy((void *)&auxkc_uuid, (const void *)loaded_kcUUID->getBytesNoCopy(), loaded_kcUUID->getLength());
311*f6217f89SApple OSS Distributions 		uuid_unparse_upper(auxkc_uuid, auxkc_uuid_string);
312*f6217f89SApple OSS Distributions 	}
313*f6217f89SApple OSS Distributions 
314*f6217f89SApple OSS Distributions skip_adding_kexts:
315*f6217f89SApple OSS Distributions #if CONFIG_KEXT_BASEMENT
316*f6217f89SApple OSS Distributions 	if (mh->filetype != MH_FILESET) {
317*f6217f89SApple OSS Distributions 		/*
318*f6217f89SApple OSS Distributions 		 * On CONFIG_KEXT_BASEMENT systems which do _not_ boot the new
319*f6217f89SApple OSS Distributions 		 * MH_FILESET kext collection, kexts are copied to their own
320*f6217f89SApple OSS Distributions 		 * special VM region during OSKext init time, so we can free
321*f6217f89SApple OSS Distributions 		 * the whole segment now.
322*f6217f89SApple OSS Distributions 		 */
323*f6217f89SApple OSS Distributions 		kernel_segment_command_t *prelinkTextSegment = NULL;
324*f6217f89SApple OSS Distributions 		prelinkTextSegment = getsegbyname(kPrelinkTextSegment);
325*f6217f89SApple OSS Distributions 		if (!prelinkTextSegment) {
326*f6217f89SApple OSS Distributions 			OSKextLog(/* kext */ NULL,
327*f6217f89SApple OSS Distributions 			    kOSKextLogErrorLevel | kOSKextLogArchiveFlag,
328*f6217f89SApple OSS Distributions 			    "Can't find prelinked kexts' text segment.");
329*f6217f89SApple OSS Distributions 			return;
330*f6217f89SApple OSS Distributions 		}
331*f6217f89SApple OSS Distributions 
332*f6217f89SApple OSS Distributions 		ml_static_mfree((vm_offset_t)prelinkTextSegment->vmaddr, prelinkTextSegment->vmsize);
333*f6217f89SApple OSS Distributions 	}
334*f6217f89SApple OSS Distributions #endif /* CONFIG_KEXT_BASEMENT */
335*f6217f89SApple OSS Distributions 
336*f6217f89SApple OSS Distributions 	/*
337*f6217f89SApple OSS Distributions 	 * Free the prelink info segment, we're done with it.
338*f6217f89SApple OSS Distributions 	 */
339*f6217f89SApple OSS Distributions 
340*f6217f89SApple OSS Distributions #if !XNU_TARGET_OS_OSX
341*f6217f89SApple OSS Distributions 	/*
342*f6217f89SApple OSS Distributions 	 * For now, we are limiting this freeing to embedded platforms.
343*f6217f89SApple OSS Distributions 	 * To enable freeing of prelink info segment on macOS, we need to
344*f6217f89SApple OSS Distributions 	 * fix rdar://88929016
345*f6217f89SApple OSS Distributions 	 */
346*f6217f89SApple OSS Distributions 	bool freedPrelinkInfo = false;
347*f6217f89SApple OSS Distributions 	kernel_segment_command_t *prelinkInfoSegment = NULL;
348*f6217f89SApple OSS Distributions 	prelinkInfoSegment = getsegbynamefromheader(mh, kPrelinkInfoSegment);
349*f6217f89SApple OSS Distributions 	if (prelinkInfoSegment) {
350*f6217f89SApple OSS Distributions 		if (prelinkInfoSegment->vmsize != 0) {
351*f6217f89SApple OSS Distributions 			freedPrelinkInfo = true;
352*f6217f89SApple OSS Distributions 			ml_static_mfree((vm_offset_t)prelinkInfoSegment->vmaddr,
353*f6217f89SApple OSS Distributions 			    (vm_size_t)prelinkInfoSegment->vmsize);
354*f6217f89SApple OSS Distributions 		}
355*f6217f89SApple OSS Distributions 	}
356*f6217f89SApple OSS Distributions 
357*f6217f89SApple OSS Distributions 	if (!freedPrelinkInfo) {
358*f6217f89SApple OSS Distributions 		OSKextLog(NULL, kOSKextLogErrorLevel | kOSKextLogArchiveFlag, "Failed to free prelink info.");
359*f6217f89SApple OSS Distributions 	}
360*f6217f89SApple OSS Distributions #endif
361*f6217f89SApple OSS Distributions 	return;
362*f6217f89SApple OSS Distributions }
363*f6217f89SApple OSS Distributions 
364*f6217f89SApple OSS Distributions 
365*f6217f89SApple OSS Distributions /*********************************************************************
366*f6217f89SApple OSS Distributions *********************************************************************/
367*f6217f89SApple OSS Distributions #define BOOTER_KEXT_PREFIX   "Driver-"
368*f6217f89SApple OSS Distributions 
369*f6217f89SApple OSS Distributions typedef struct _DeviceTreeBuffer {
370*f6217f89SApple OSS Distributions 	uint32_t paddr;
371*f6217f89SApple OSS Distributions 	uint32_t length;
372*f6217f89SApple OSS Distributions } _DeviceTreeBuffer;
373*f6217f89SApple OSS Distributions 
374*f6217f89SApple OSS Distributions void
readBooterExtensions(void)375*f6217f89SApple OSS Distributions KLDBootstrap::readBooterExtensions(void)
376*f6217f89SApple OSS Distributions {
377*f6217f89SApple OSS Distributions 	OSSharedPtr<IORegistryEntry> booterMemoryMap;
378*f6217f89SApple OSS Distributions 	OSSharedPtr<OSDictionary>    propertyDict;
379*f6217f89SApple OSS Distributions 	OSSharedPtr<OSCollectionIterator>      keyIterator;
380*f6217f89SApple OSS Distributions 	OSString                  * deviceTreeName          = NULL;// do not release
381*f6217f89SApple OSS Distributions 
382*f6217f89SApple OSS Distributions 	const _DeviceTreeBuffer   * deviceTreeBuffer        = NULL;// do not free
383*f6217f89SApple OSS Distributions 	char                      * booterDataPtr           = NULL;// do not free
384*f6217f89SApple OSS Distributions 	OSSharedPtr<OSData>         booterData;
385*f6217f89SApple OSS Distributions 	OSSharedPtr<OSKext>         aKext;
386*f6217f89SApple OSS Distributions 
387*f6217f89SApple OSS Distributions 	OSKextLog(/* kext */ NULL,
388*f6217f89SApple OSS Distributions 	    kOSKextLogProgressLevel |
389*f6217f89SApple OSS Distributions 	    kOSKextLogDirectoryScanFlag | kOSKextLogKextBookkeepingFlag,
390*f6217f89SApple OSS Distributions 	    "Reading startup extensions from booter memory.");
391*f6217f89SApple OSS Distributions 
392*f6217f89SApple OSS Distributions 	booterMemoryMap = IORegistryEntry::fromPath( "/chosen/memory-map", gIODTPlane);
393*f6217f89SApple OSS Distributions 
394*f6217f89SApple OSS Distributions 	if (!booterMemoryMap) {
395*f6217f89SApple OSS Distributions 		OSKextLog(/* kext */ NULL,
396*f6217f89SApple OSS Distributions 		    kOSKextLogErrorLevel |
397*f6217f89SApple OSS Distributions 		    kOSKextLogGeneralFlag | kOSKextLogDirectoryScanFlag,
398*f6217f89SApple OSS Distributions 		    "Can't read booter memory map.");
399*f6217f89SApple OSS Distributions 		goto finish;
400*f6217f89SApple OSS Distributions 	}
401*f6217f89SApple OSS Distributions 
402*f6217f89SApple OSS Distributions 	propertyDict = booterMemoryMap->dictionaryWithProperties();
403*f6217f89SApple OSS Distributions 	if (!propertyDict) {
404*f6217f89SApple OSS Distributions 		OSKextLog(/* kext */ NULL,
405*f6217f89SApple OSS Distributions 		    kOSKextLogErrorLevel |
406*f6217f89SApple OSS Distributions 		    kOSKextLogDirectoryScanFlag,
407*f6217f89SApple OSS Distributions 		    "Can't get property dictionary from memory map.");
408*f6217f89SApple OSS Distributions 		goto finish;
409*f6217f89SApple OSS Distributions 	}
410*f6217f89SApple OSS Distributions 
411*f6217f89SApple OSS Distributions 	keyIterator = OSCollectionIterator::withCollection(propertyDict.get());
412*f6217f89SApple OSS Distributions 	if (!keyIterator) {
413*f6217f89SApple OSS Distributions 		OSKextLog(/* kext */ NULL,
414*f6217f89SApple OSS Distributions 		    kOSKextLogErrorLevel |
415*f6217f89SApple OSS Distributions 		    kOSKextLogGeneralFlag,
416*f6217f89SApple OSS Distributions 		    "Can't allocate iterator for driver images.");
417*f6217f89SApple OSS Distributions 		goto finish;
418*f6217f89SApple OSS Distributions 	}
419*f6217f89SApple OSS Distributions 
420*f6217f89SApple OSS Distributions 	/* Create dictionary of excluded kexts
421*f6217f89SApple OSS Distributions 	 */
422*f6217f89SApple OSS Distributions #ifndef CONFIG_EMBEDDED
423*f6217f89SApple OSS Distributions 	OSKext::createExcludeListFromBooterData(propertyDict.get(), keyIterator.get());
424*f6217f89SApple OSS Distributions #endif
425*f6217f89SApple OSS Distributions 	// !! reset the iterator, not the pointer
426*f6217f89SApple OSS Distributions 	keyIterator->reset();
427*f6217f89SApple OSS Distributions 
428*f6217f89SApple OSS Distributions 	while ((deviceTreeName =
429*f6217f89SApple OSS Distributions 	    OSDynamicCast(OSString, keyIterator->getNextObject()))) {
430*f6217f89SApple OSS Distributions 		const char * devTreeNameCString = deviceTreeName->getCStringNoCopy();
431*f6217f89SApple OSS Distributions 		OSData * deviceTreeEntry = OSDynamicCast(OSData,
432*f6217f89SApple OSS Distributions 		    propertyDict->getObject(deviceTreeName));
433*f6217f89SApple OSS Distributions 
434*f6217f89SApple OSS Distributions 		/* If there is no entry for the name, we can't do much with it. */
435*f6217f89SApple OSS Distributions 		if (!deviceTreeEntry) {
436*f6217f89SApple OSS Distributions 			continue;
437*f6217f89SApple OSS Distributions 		}
438*f6217f89SApple OSS Distributions 
439*f6217f89SApple OSS Distributions 		/* Make sure it is a kext */
440*f6217f89SApple OSS Distributions 		if (strncmp(devTreeNameCString,
441*f6217f89SApple OSS Distributions 		    BOOTER_KEXT_PREFIX,
442*f6217f89SApple OSS Distributions 		    CONST_STRLEN(BOOTER_KEXT_PREFIX))) {
443*f6217f89SApple OSS Distributions 			continue;
444*f6217f89SApple OSS Distributions 		}
445*f6217f89SApple OSS Distributions 
446*f6217f89SApple OSS Distributions 		deviceTreeBuffer = (const _DeviceTreeBuffer *)
447*f6217f89SApple OSS Distributions 		    deviceTreeEntry->getBytesNoCopy(0, sizeof(deviceTreeBuffer));
448*f6217f89SApple OSS Distributions 		if (!deviceTreeBuffer) {
449*f6217f89SApple OSS Distributions 			/* We can't get to the data, so we can't do anything,
450*f6217f89SApple OSS Distributions 			 * not even free it from physical memory (if it's there).
451*f6217f89SApple OSS Distributions 			 */
452*f6217f89SApple OSS Distributions 			OSKextLog(/* kext */ NULL,
453*f6217f89SApple OSS Distributions 			    kOSKextLogErrorLevel |
454*f6217f89SApple OSS Distributions 			    kOSKextLogDirectoryScanFlag,
455*f6217f89SApple OSS Distributions 			    "Device tree entry %s has NULL pointer.",
456*f6217f89SApple OSS Distributions 			    devTreeNameCString);
457*f6217f89SApple OSS Distributions 			goto finish; // xxx - continue, panic?
458*f6217f89SApple OSS Distributions 		}
459*f6217f89SApple OSS Distributions 
460*f6217f89SApple OSS Distributions 		booterDataPtr = (char *)ml_static_ptovirt(deviceTreeBuffer->paddr);
461*f6217f89SApple OSS Distributions 		if (!booterDataPtr) {
462*f6217f89SApple OSS Distributions 			OSKextLog(/* kext */ NULL,
463*f6217f89SApple OSS Distributions 			    kOSKextLogErrorLevel |
464*f6217f89SApple OSS Distributions 			    kOSKextLogDirectoryScanFlag,
465*f6217f89SApple OSS Distributions 			    "Can't get virtual address for device tree entry %s.",
466*f6217f89SApple OSS Distributions 			    devTreeNameCString);
467*f6217f89SApple OSS Distributions 			goto finish;
468*f6217f89SApple OSS Distributions 		}
469*f6217f89SApple OSS Distributions 
470*f6217f89SApple OSS Distributions 		/* Wrap the booter data buffer in an OSData and set a dealloc function
471*f6217f89SApple OSS Distributions 		 * so it will take care of the physical memory when freed. Kexts will
472*f6217f89SApple OSS Distributions 		 * retain the booterData for as long as they need it. Remove the entry
473*f6217f89SApple OSS Distributions 		 * from the booter memory map after this is done.
474*f6217f89SApple OSS Distributions 		 */
475*f6217f89SApple OSS Distributions 		booterData = OSData::withBytesNoCopy(booterDataPtr,
476*f6217f89SApple OSS Distributions 		    deviceTreeBuffer->length);
477*f6217f89SApple OSS Distributions 		if (!booterData) {
478*f6217f89SApple OSS Distributions 			OSKextLog(/* kext */ NULL,
479*f6217f89SApple OSS Distributions 			    kOSKextLogErrorLevel |
480*f6217f89SApple OSS Distributions 			    kOSKextLogGeneralFlag,
481*f6217f89SApple OSS Distributions 			    "Error - Can't allocate OSData wrapper for device tree entry %s.",
482*f6217f89SApple OSS Distributions 			    devTreeNameCString);
483*f6217f89SApple OSS Distributions 			goto finish;
484*f6217f89SApple OSS Distributions 		}
485*f6217f89SApple OSS Distributions 		booterData->setDeallocFunction(osdata_phys_free);
486*f6217f89SApple OSS Distributions 
487*f6217f89SApple OSS Distributions 		/* Create the kext for the entry, then release it, because the
488*f6217f89SApple OSS Distributions 		 * kext system keeps them around until explicitly removed.
489*f6217f89SApple OSS Distributions 		 * Any creation/registration failures are already logged for us.
490*f6217f89SApple OSS Distributions 		 */
491*f6217f89SApple OSS Distributions 		OSSharedPtr<OSKext> newKext = OSKext::withBooterData(deviceTreeName, booterData.get());
492*f6217f89SApple OSS Distributions 
493*f6217f89SApple OSS Distributions 		booterMemoryMap->removeProperty(deviceTreeName);
494*f6217f89SApple OSS Distributions 	} /* while ( (deviceTreeName = OSDynamicCast(OSString, ...) ) ) */
495*f6217f89SApple OSS Distributions 
496*f6217f89SApple OSS Distributions finish:
497*f6217f89SApple OSS Distributions 	return;
498*f6217f89SApple OSS Distributions }
499*f6217f89SApple OSS Distributions 
500*f6217f89SApple OSS Distributions /*********************************************************************
501*f6217f89SApple OSS Distributions *********************************************************************/
502*f6217f89SApple OSS Distributions #define COM_APPLE  "com.apple."
503*f6217f89SApple OSS Distributions 
504*f6217f89SApple OSS Distributions void
loadSecurityExtensions(void)505*f6217f89SApple OSS Distributions KLDBootstrap::loadSecurityExtensions(void)
506*f6217f89SApple OSS Distributions {
507*f6217f89SApple OSS Distributions 	OSSharedPtr<OSDictionary>         extensionsDict;
508*f6217f89SApple OSS Distributions 	OSSharedPtr<OSCollectionIterator> keyIterator;
509*f6217f89SApple OSS Distributions 	OSString             * bundleID       = NULL;// don't release
510*f6217f89SApple OSS Distributions 	OSKext               * theKext        = NULL;// don't release
511*f6217f89SApple OSS Distributions 
512*f6217f89SApple OSS Distributions 	OSKextLog(/* kext */ NULL,
513*f6217f89SApple OSS Distributions 	    kOSKextLogStepLevel |
514*f6217f89SApple OSS Distributions 	    kOSKextLogLoadFlag,
515*f6217f89SApple OSS Distributions 	    "Loading security extensions.");
516*f6217f89SApple OSS Distributions 
517*f6217f89SApple OSS Distributions 	extensionsDict = OSKext::copyKexts();
518*f6217f89SApple OSS Distributions 	if (!extensionsDict) {
519*f6217f89SApple OSS Distributions 		return;
520*f6217f89SApple OSS Distributions 	}
521*f6217f89SApple OSS Distributions 
522*f6217f89SApple OSS Distributions 	keyIterator = OSCollectionIterator::withCollection(extensionsDict.get());
523*f6217f89SApple OSS Distributions 	if (!keyIterator) {
524*f6217f89SApple OSS Distributions 		OSKextLog(/* kext */ NULL,
525*f6217f89SApple OSS Distributions 		    kOSKextLogErrorLevel |
526*f6217f89SApple OSS Distributions 		    kOSKextLogGeneralFlag,
527*f6217f89SApple OSS Distributions 		    "Failed to allocate iterator for security extensions.");
528*f6217f89SApple OSS Distributions 		goto finish;
529*f6217f89SApple OSS Distributions 	}
530*f6217f89SApple OSS Distributions 
531*f6217f89SApple OSS Distributions 	while ((bundleID = OSDynamicCast(OSString, keyIterator->getNextObject()))) {
532*f6217f89SApple OSS Distributions 		const char * bundle_id = bundleID->getCStringNoCopy();
533*f6217f89SApple OSS Distributions 
534*f6217f89SApple OSS Distributions 		/* Skip extensions whose bundle IDs don't start with "com.apple.".
535*f6217f89SApple OSS Distributions 		 */
536*f6217f89SApple OSS Distributions 		if (!bundle_id ||
537*f6217f89SApple OSS Distributions 		    (strncmp(bundle_id, COM_APPLE, CONST_STRLEN(COM_APPLE)) != 0)) {
538*f6217f89SApple OSS Distributions 			continue;
539*f6217f89SApple OSS Distributions 		}
540*f6217f89SApple OSS Distributions 
541*f6217f89SApple OSS Distributions 		theKext = OSDynamicCast(OSKext, extensionsDict->getObject(bundleID));
542*f6217f89SApple OSS Distributions 		if (!theKext) {
543*f6217f89SApple OSS Distributions 			continue;
544*f6217f89SApple OSS Distributions 		}
545*f6217f89SApple OSS Distributions 
546*f6217f89SApple OSS Distributions 		if (kOSBooleanTrue == theKext->getPropertyForHostArch(kAppleSecurityExtensionKey)) {
547*f6217f89SApple OSS Distributions 			OSKextLog(/* kext */ NULL,
548*f6217f89SApple OSS Distributions 			    kOSKextLogStepLevel |
549*f6217f89SApple OSS Distributions 			    kOSKextLogLoadFlag,
550*f6217f89SApple OSS Distributions 			    "Loading security extension %s.", bundleID->getCStringNoCopy());
551*f6217f89SApple OSS Distributions 			OSKext::loadKextWithIdentifier(bundleID->getCStringNoCopy(),
552*f6217f89SApple OSS Distributions 			    /* allowDefer */ false);
553*f6217f89SApple OSS Distributions 		}
554*f6217f89SApple OSS Distributions 	}
555*f6217f89SApple OSS Distributions 
556*f6217f89SApple OSS Distributions finish:
557*f6217f89SApple OSS Distributions 	return;
558*f6217f89SApple OSS Distributions }
559*f6217f89SApple OSS Distributions 
560*f6217f89SApple OSS Distributions /*********************************************************************
561*f6217f89SApple OSS Distributions * We used to require that all listed kernel components load, but
562*f6217f89SApple OSS Distributions * nowadays we can get them from userland so we only try to load the
563*f6217f89SApple OSS Distributions * ones we have. If an error occurs later, such is life.
564*f6217f89SApple OSS Distributions *
565*f6217f89SApple OSS Distributions * Note that we look the kexts up first, so we can avoid spurious
566*f6217f89SApple OSS Distributions * (in this context, anyhow) log messages about kexts not being found.
567*f6217f89SApple OSS Distributions *
568*f6217f89SApple OSS Distributions * xxx - do we even need to do this any more? Check if the kernel
569*f6217f89SApple OSS Distributions * xxx - compoonents just load in the regular paths
570*f6217f89SApple OSS Distributions *********************************************************************/
571*f6217f89SApple OSS Distributions OSReturn
loadKernelComponentKexts(void)572*f6217f89SApple OSS Distributions KLDBootstrap::loadKernelComponentKexts(void)
573*f6217f89SApple OSS Distributions {
574*f6217f89SApple OSS Distributions 	OSReturn            result      = kOSReturnSuccess;// optimistic
575*f6217f89SApple OSS Distributions 	OSSharedPtr<OSKext> theKext;
576*f6217f89SApple OSS Distributions 	const char       ** kextIDPtr   = NULL;          // do not release
577*f6217f89SApple OSS Distributions 
578*f6217f89SApple OSS Distributions 	for (kextIDPtr = &sKernelComponentNames[0]; *kextIDPtr; kextIDPtr++) {
579*f6217f89SApple OSS Distributions 		theKext = OSKext::lookupKextWithIdentifier(*kextIDPtr);
580*f6217f89SApple OSS Distributions 
581*f6217f89SApple OSS Distributions 		if (theKext) {
582*f6217f89SApple OSS Distributions 			if (kOSReturnSuccess != OSKext::loadKextWithIdentifier(
583*f6217f89SApple OSS Distributions 				    *kextIDPtr, /* allowDefer */ false)) {
584*f6217f89SApple OSS Distributions 				// xxx - check KextBookkeeping, might be redundant
585*f6217f89SApple OSS Distributions 				OSKextLog(/* kext */ NULL,
586*f6217f89SApple OSS Distributions 				    kOSKextLogErrorLevel |
587*f6217f89SApple OSS Distributions 				    kOSKextLogDirectoryScanFlag | kOSKextLogKextBookkeepingFlag,
588*f6217f89SApple OSS Distributions 				    "Failed to initialize kernel component %s.", *kextIDPtr);
589*f6217f89SApple OSS Distributions 				result = kOSReturnError;
590*f6217f89SApple OSS Distributions 			}
591*f6217f89SApple OSS Distributions 		}
592*f6217f89SApple OSS Distributions 	}
593*f6217f89SApple OSS Distributions 
594*f6217f89SApple OSS Distributions 	return result;
595*f6217f89SApple OSS Distributions }
596*f6217f89SApple OSS Distributions 
597*f6217f89SApple OSS Distributions /*********************************************************************
598*f6217f89SApple OSS Distributions * Ensure that Kernel External Components are loaded early in boot,
599*f6217f89SApple OSS Distributions * before other kext personalities get sent to the IOCatalogue. These
600*f6217f89SApple OSS Distributions * kexts are treated specially because they may provide the implementation
601*f6217f89SApple OSS Distributions * for kernel-vended KPI, so they must register themselves before
602*f6217f89SApple OSS Distributions * general purpose IOKit probing begins.
603*f6217f89SApple OSS Distributions *********************************************************************/
604*f6217f89SApple OSS Distributions 
605*f6217f89SApple OSS Distributions #define COM_APPLE_KEC  "com.apple.kec."
606*f6217f89SApple OSS Distributions 
607*f6217f89SApple OSS Distributions void
loadKernelExternalComponents(void)608*f6217f89SApple OSS Distributions KLDBootstrap::loadKernelExternalComponents(void)
609*f6217f89SApple OSS Distributions {
610*f6217f89SApple OSS Distributions 	OSSharedPtr<OSDictionary>         extensionsDict;
611*f6217f89SApple OSS Distributions 	OSSharedPtr<OSCollectionIterator> keyIterator;
612*f6217f89SApple OSS Distributions 	OSString             * bundleID       = NULL;// don't release
613*f6217f89SApple OSS Distributions 	OSKext               * theKext        = NULL;// don't release
614*f6217f89SApple OSS Distributions 	OSBoolean            * isKernelExternalComponent = NULL;// don't release
615*f6217f89SApple OSS Distributions 
616*f6217f89SApple OSS Distributions 	OSKextLog(/* kext */ NULL,
617*f6217f89SApple OSS Distributions 	    kOSKextLogStepLevel |
618*f6217f89SApple OSS Distributions 	    kOSKextLogLoadFlag,
619*f6217f89SApple OSS Distributions 	    "Loading Kernel External Components.");
620*f6217f89SApple OSS Distributions 
621*f6217f89SApple OSS Distributions 	extensionsDict = OSKext::copyKexts();
622*f6217f89SApple OSS Distributions 	if (!extensionsDict) {
623*f6217f89SApple OSS Distributions 		return;
624*f6217f89SApple OSS Distributions 	}
625*f6217f89SApple OSS Distributions 
626*f6217f89SApple OSS Distributions 	keyIterator = OSCollectionIterator::withCollection(extensionsDict.get());
627*f6217f89SApple OSS Distributions 	if (!keyIterator) {
628*f6217f89SApple OSS Distributions 		OSKextLog(/* kext */ NULL,
629*f6217f89SApple OSS Distributions 		    kOSKextLogErrorLevel |
630*f6217f89SApple OSS Distributions 		    kOSKextLogGeneralFlag,
631*f6217f89SApple OSS Distributions 		    "Failed to allocate iterator for Kernel External Components.");
632*f6217f89SApple OSS Distributions 		goto finish;
633*f6217f89SApple OSS Distributions 	}
634*f6217f89SApple OSS Distributions 
635*f6217f89SApple OSS Distributions 	while ((bundleID = OSDynamicCast(OSString, keyIterator->getNextObject()))) {
636*f6217f89SApple OSS Distributions 		const char * bundle_id = bundleID->getCStringNoCopy();
637*f6217f89SApple OSS Distributions 
638*f6217f89SApple OSS Distributions 		/* Skip extensions whose bundle IDs don't start with "com.apple.kec.".
639*f6217f89SApple OSS Distributions 		 */
640*f6217f89SApple OSS Distributions 		if (!bundle_id ||
641*f6217f89SApple OSS Distributions 		    (strncmp(bundle_id, COM_APPLE_KEC, CONST_STRLEN(COM_APPLE_KEC)) != 0)) {
642*f6217f89SApple OSS Distributions 			continue;
643*f6217f89SApple OSS Distributions 		}
644*f6217f89SApple OSS Distributions 
645*f6217f89SApple OSS Distributions 		theKext = OSDynamicCast(OSKext, extensionsDict->getObject(bundleID));
646*f6217f89SApple OSS Distributions 		if (!theKext) {
647*f6217f89SApple OSS Distributions 			continue;
648*f6217f89SApple OSS Distributions 		}
649*f6217f89SApple OSS Distributions 
650*f6217f89SApple OSS Distributions 		isKernelExternalComponent = OSDynamicCast(OSBoolean,
651*f6217f89SApple OSS Distributions 		    theKext->getPropertyForHostArch(kAppleKernelExternalComponentKey));
652*f6217f89SApple OSS Distributions 		if (isKernelExternalComponent && isKernelExternalComponent->isTrue()) {
653*f6217f89SApple OSS Distributions 			OSKextLog(/* kext */ NULL,
654*f6217f89SApple OSS Distributions 			    kOSKextLogStepLevel |
655*f6217f89SApple OSS Distributions 			    kOSKextLogLoadFlag,
656*f6217f89SApple OSS Distributions 			    "Loading kernel external component %s.", bundleID->getCStringNoCopy());
657*f6217f89SApple OSS Distributions 			OSKext::loadKextWithIdentifier(bundleID->getCStringNoCopy(),
658*f6217f89SApple OSS Distributions 			    /* allowDefer */ false);
659*f6217f89SApple OSS Distributions 		}
660*f6217f89SApple OSS Distributions 	}
661*f6217f89SApple OSS Distributions 
662*f6217f89SApple OSS Distributions finish:
663*f6217f89SApple OSS Distributions 	return;
664*f6217f89SApple OSS Distributions }
665*f6217f89SApple OSS Distributions 
666*f6217f89SApple OSS Distributions /*********************************************************************
667*f6217f89SApple OSS Distributions *********************************************************************/
668*f6217f89SApple OSS Distributions void
readBuiltinPersonalities(void)669*f6217f89SApple OSS Distributions KLDBootstrap::readBuiltinPersonalities(void)
670*f6217f89SApple OSS Distributions {
671*f6217f89SApple OSS Distributions 	OSSharedPtr<OSObject>   parsedXML;
672*f6217f89SApple OSS Distributions 	OSArray               * builtinExtensions     = NULL;// do not release
673*f6217f89SApple OSS Distributions 	OSSharedPtr<OSArray>    allPersonalities;
674*f6217f89SApple OSS Distributions 	OSSharedPtr<OSString>   errorString;
675*f6217f89SApple OSS Distributions 	kernel_section_t      * infosect              = NULL;// do not free
676*f6217f89SApple OSS Distributions 	OSSharedPtr<OSCollectionIterator>  personalitiesIterator;
677*f6217f89SApple OSS Distributions 	unsigned int            count, i;
678*f6217f89SApple OSS Distributions 
679*f6217f89SApple OSS Distributions 	OSKextLog(/* kext */ NULL,
680*f6217f89SApple OSS Distributions 	    kOSKextLogStepLevel |
681*f6217f89SApple OSS Distributions 	    kOSKextLogLoadFlag,
682*f6217f89SApple OSS Distributions 	    "Reading built-in kernel personalities for I/O Kit drivers.");
683*f6217f89SApple OSS Distributions 
684*f6217f89SApple OSS Distributions 	/* Look in the __BUILTIN __info segment for an array of Info.plist
685*f6217f89SApple OSS Distributions 	 * entries. For each one, extract the personalities dictionary, add
686*f6217f89SApple OSS Distributions 	 * it to our array, then push them all (without matching) to
687*f6217f89SApple OSS Distributions 	 * the IOCatalogue. This can be used to augment the personalities
688*f6217f89SApple OSS Distributions 	 * in gIOKernelConfigTables, especially when linking entire kexts into
689*f6217f89SApple OSS Distributions 	 * the mach_kernel image.
690*f6217f89SApple OSS Distributions 	 */
691*f6217f89SApple OSS Distributions 	infosect   = getsectbyname("__BUILTIN", "__info");
692*f6217f89SApple OSS Distributions 	if (!infosect) {
693*f6217f89SApple OSS Distributions 		// this isn't fatal
694*f6217f89SApple OSS Distributions 		goto finish;
695*f6217f89SApple OSS Distributions 	}
696*f6217f89SApple OSS Distributions 
697*f6217f89SApple OSS Distributions 	parsedXML = OSUnserializeXML((const char *) (uintptr_t)infosect->addr,
698*f6217f89SApple OSS Distributions 	    errorString);
699*f6217f89SApple OSS Distributions 	if (parsedXML) {
700*f6217f89SApple OSS Distributions 		builtinExtensions = OSDynamicCast(OSArray, parsedXML.get());
701*f6217f89SApple OSS Distributions 	}
702*f6217f89SApple OSS Distributions 	if (!builtinExtensions) {
703*f6217f89SApple OSS Distributions 		const char * errorCString = "(unknown error)";
704*f6217f89SApple OSS Distributions 
705*f6217f89SApple OSS Distributions 		if (errorString && errorString->getCStringNoCopy()) {
706*f6217f89SApple OSS Distributions 			errorCString = errorString->getCStringNoCopy();
707*f6217f89SApple OSS Distributions 		} else if (parsedXML) {
708*f6217f89SApple OSS Distributions 			errorCString = "not an array";
709*f6217f89SApple OSS Distributions 		}
710*f6217f89SApple OSS Distributions 		OSKextLog(/* kext */ NULL,
711*f6217f89SApple OSS Distributions 		    kOSKextLogErrorLevel |
712*f6217f89SApple OSS Distributions 		    kOSKextLogLoadFlag,
713*f6217f89SApple OSS Distributions 		    "Error unserializing built-in personalities: %s.", errorCString);
714*f6217f89SApple OSS Distributions 		goto finish;
715*f6217f89SApple OSS Distributions 	}
716*f6217f89SApple OSS Distributions 
717*f6217f89SApple OSS Distributions 	// estimate 3 personalities per Info.plist/kext
718*f6217f89SApple OSS Distributions 	count = builtinExtensions->getCount();
719*f6217f89SApple OSS Distributions 	allPersonalities = OSArray::withCapacity(count * 3);
720*f6217f89SApple OSS Distributions 
721*f6217f89SApple OSS Distributions 	for (i = 0; i < count; i++) {
722*f6217f89SApple OSS Distributions 		OSDictionary            * infoDict = NULL;// do not release
723*f6217f89SApple OSS Distributions 		OSString                * moduleName = NULL;// do not release
724*f6217f89SApple OSS Distributions 		OSDictionary            * personalities;// do not release
725*f6217f89SApple OSS Distributions 		OSString                * personalityName;// do not release
726*f6217f89SApple OSS Distributions 
727*f6217f89SApple OSS Distributions 		infoDict = OSDynamicCast(OSDictionary,
728*f6217f89SApple OSS Distributions 		    builtinExtensions->getObject(i));
729*f6217f89SApple OSS Distributions 		if (!infoDict) {
730*f6217f89SApple OSS Distributions 			continue;
731*f6217f89SApple OSS Distributions 		}
732*f6217f89SApple OSS Distributions 
733*f6217f89SApple OSS Distributions 		moduleName = OSDynamicCast(OSString,
734*f6217f89SApple OSS Distributions 		    infoDict->getObject(kCFBundleIdentifierKey));
735*f6217f89SApple OSS Distributions 		if (!moduleName) {
736*f6217f89SApple OSS Distributions 			continue;
737*f6217f89SApple OSS Distributions 		}
738*f6217f89SApple OSS Distributions 
739*f6217f89SApple OSS Distributions 		OSKextLog(/* kext */ NULL,
740*f6217f89SApple OSS Distributions 		    kOSKextLogStepLevel |
741*f6217f89SApple OSS Distributions 		    kOSKextLogLoadFlag,
742*f6217f89SApple OSS Distributions 		    "Adding personalities for built-in driver %s:",
743*f6217f89SApple OSS Distributions 		    moduleName->getCStringNoCopy());
744*f6217f89SApple OSS Distributions 
745*f6217f89SApple OSS Distributions 		personalities = OSDynamicCast(OSDictionary,
746*f6217f89SApple OSS Distributions 		    infoDict->getObject("IOKitPersonalities"));
747*f6217f89SApple OSS Distributions 		if (!personalities) {
748*f6217f89SApple OSS Distributions 			continue;
749*f6217f89SApple OSS Distributions 		}
750*f6217f89SApple OSS Distributions 
751*f6217f89SApple OSS Distributions 		personalitiesIterator = OSCollectionIterator::withCollection(personalities);
752*f6217f89SApple OSS Distributions 		if (!personalitiesIterator) {
753*f6217f89SApple OSS Distributions 			continue; // xxx - well really, what can we do? should we panic?
754*f6217f89SApple OSS Distributions 		}
755*f6217f89SApple OSS Distributions 
756*f6217f89SApple OSS Distributions 		while ((personalityName = OSDynamicCast(OSString,
757*f6217f89SApple OSS Distributions 		    personalitiesIterator->getNextObject()))) {
758*f6217f89SApple OSS Distributions 			OSDictionary * personality = OSDynamicCast(OSDictionary,
759*f6217f89SApple OSS Distributions 			    personalities->getObject(personalityName));
760*f6217f89SApple OSS Distributions 
761*f6217f89SApple OSS Distributions 			OSKextLog(/* kext */ NULL,
762*f6217f89SApple OSS Distributions 			    kOSKextLogDetailLevel |
763*f6217f89SApple OSS Distributions 			    kOSKextLogLoadFlag,
764*f6217f89SApple OSS Distributions 			    "Adding built-in driver personality %s.",
765*f6217f89SApple OSS Distributions 			    personalityName->getCStringNoCopy());
766*f6217f89SApple OSS Distributions 
767*f6217f89SApple OSS Distributions 			if (personality && !personality->getObject(kCFBundleIdentifierKey)) {
768*f6217f89SApple OSS Distributions 				personality->setObject(kCFBundleIdentifierKey, moduleName);
769*f6217f89SApple OSS Distributions 			}
770*f6217f89SApple OSS Distributions 			allPersonalities->setObject(personality);
771*f6217f89SApple OSS Distributions 		}
772*f6217f89SApple OSS Distributions 	}
773*f6217f89SApple OSS Distributions 
774*f6217f89SApple OSS Distributions 	gIOCatalogue->addDrivers(allPersonalities.get(), false);
775*f6217f89SApple OSS Distributions 
776*f6217f89SApple OSS Distributions finish:
777*f6217f89SApple OSS Distributions 	return;
778*f6217f89SApple OSS Distributions }
779*f6217f89SApple OSS Distributions 
780*f6217f89SApple OSS Distributions #if PRAGMA_MARK
781*f6217f89SApple OSS Distributions #pragma mark Bootstrap Functions
782*f6217f89SApple OSS Distributions #endif
783*f6217f89SApple OSS Distributions /*********************************************************************
784*f6217f89SApple OSS Distributions * Bootstrap Functions
785*f6217f89SApple OSS Distributions *********************************************************************/
786*f6217f89SApple OSS Distributions static void
bootstrapRecordStartupExtensions(void)787*f6217f89SApple OSS Distributions bootstrapRecordStartupExtensions(void)
788*f6217f89SApple OSS Distributions {
789*f6217f89SApple OSS Distributions 	sBootstrapObject.readStartupExtensions();
790*f6217f89SApple OSS Distributions 	return;
791*f6217f89SApple OSS Distributions }
792*f6217f89SApple OSS Distributions 
793*f6217f89SApple OSS Distributions static void
bootstrapLoadSecurityExtensions(void)794*f6217f89SApple OSS Distributions bootstrapLoadSecurityExtensions(void)
795*f6217f89SApple OSS Distributions {
796*f6217f89SApple OSS Distributions 	sBootstrapObject.loadSecurityExtensions();
797*f6217f89SApple OSS Distributions 	return;
798*f6217f89SApple OSS Distributions }
799*f6217f89SApple OSS Distributions 
800