xref: /xnu-11215.41.3/iokit/bsddev/IOKitBSDInit.cpp (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1*33de042dSApple OSS Distributions /*
2*33de042dSApple OSS Distributions  * Copyright (c) 1998-2021 Apple Inc. All rights reserved.
3*33de042dSApple OSS Distributions  *
4*33de042dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*33de042dSApple OSS Distributions  *
6*33de042dSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*33de042dSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*33de042dSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*33de042dSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*33de042dSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*33de042dSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*33de042dSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*33de042dSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*33de042dSApple OSS Distributions  *
15*33de042dSApple OSS Distributions  * Please obtain a copy of the License at
16*33de042dSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*33de042dSApple OSS Distributions  *
18*33de042dSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*33de042dSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*33de042dSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*33de042dSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*33de042dSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*33de042dSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*33de042dSApple OSS Distributions  * limitations under the License.
25*33de042dSApple OSS Distributions  *
26*33de042dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*33de042dSApple OSS Distributions  */
28*33de042dSApple OSS Distributions #include <IOKit/IOBSD.h>
29*33de042dSApple OSS Distributions #include <IOKit/IOLib.h>
30*33de042dSApple OSS Distributions #include <IOKit/IOService.h>
31*33de042dSApple OSS Distributions #include <IOKit/IOCatalogue.h>
32*33de042dSApple OSS Distributions #include <IOKit/IODeviceTreeSupport.h>
33*33de042dSApple OSS Distributions #include <IOKit/IOKitKeys.h>
34*33de042dSApple OSS Distributions #include <IOKit/IONVRAM.h>
35*33de042dSApple OSS Distributions #include <IOKit/IOPlatformExpert.h>
36*33de042dSApple OSS Distributions #include <IOKit/IOUserClient.h>
37*33de042dSApple OSS Distributions #include <libkern/c++/OSAllocation.h>
38*33de042dSApple OSS Distributions 
39*33de042dSApple OSS Distributions extern "C" {
40*33de042dSApple OSS Distributions #include <libkern/amfi/amfi.h>
41*33de042dSApple OSS Distributions #include <sys/codesign.h>
42*33de042dSApple OSS Distributions #include <sys/code_signing.h>
43*33de042dSApple OSS Distributions #include <vm/pmap.h>
44*33de042dSApple OSS Distributions #include <vm/vm_map.h>
45*33de042dSApple OSS Distributions #include <pexpert/pexpert.h>
46*33de042dSApple OSS Distributions #include <kern/clock.h>
47*33de042dSApple OSS Distributions #if CONFIG_KDP_INTERACTIVE_DEBUGGING
48*33de042dSApple OSS Distributions #include <kern/debug.h>
49*33de042dSApple OSS Distributions #endif
50*33de042dSApple OSS Distributions #include <mach/machine.h>
51*33de042dSApple OSS Distributions #include <uuid/uuid.h>
52*33de042dSApple OSS Distributions #include <sys/vnode_internal.h>
53*33de042dSApple OSS Distributions #include <sys/mount.h>
54*33de042dSApple OSS Distributions #include <corecrypto/ccsha2.h>
55*33de042dSApple OSS Distributions #include <kdp/sk_core.h>
56*33de042dSApple OSS Distributions #include <pexpert/device_tree.h>
57*33de042dSApple OSS Distributions #include <kern/startup.h>
58*33de042dSApple OSS Distributions 
59*33de042dSApple OSS Distributions // how long to wait for matching root device, secs
60*33de042dSApple OSS Distributions #if DEBUG
61*33de042dSApple OSS Distributions #define ROOTDEVICETIMEOUT       120
62*33de042dSApple OSS Distributions #else
63*33de042dSApple OSS Distributions #define ROOTDEVICETIMEOUT       60
64*33de042dSApple OSS Distributions #endif
65*33de042dSApple OSS Distributions 
66*33de042dSApple OSS Distributions extern dev_t mdevadd(int devid, uint64_t base, unsigned int size, int phys);
67*33de042dSApple OSS Distributions extern dev_t mdevlookup(int devid);
68*33de042dSApple OSS Distributions extern void mdevremoveall(void);
69*33de042dSApple OSS Distributions extern int mdevgetrange(int devid, uint64_t *base, uint64_t *size);
70*33de042dSApple OSS Distributions extern void di_root_ramfile(IORegistryEntry * entry);
71*33de042dSApple OSS Distributions extern int IODTGetDefault(const char *key, void *infoAddr, unsigned int infoSize);
72*33de042dSApple OSS Distributions extern boolean_t cpuid_vmm_present(void);
73*33de042dSApple OSS Distributions 
74*33de042dSApple OSS Distributions #define ROUNDUP(a, b) (((a) + ((b) - 1)) & (~((b) - 1)))
75*33de042dSApple OSS Distributions 
76*33de042dSApple OSS Distributions #define IOPOLLED_COREFILE       (CONFIG_KDP_INTERACTIVE_DEBUGGING)
77*33de042dSApple OSS Distributions 
78*33de042dSApple OSS Distributions #if defined(XNU_TARGET_OS_BRIDGE)
79*33de042dSApple OSS Distributions #define kIOCoreDumpPath         "/private/var/internal/kernelcore"
80*33de042dSApple OSS Distributions #elif defined(XNU_TARGET_OS_OSX)
81*33de042dSApple OSS Distributions #define kIOCoreDumpPath         "/System/Volumes/VM/kernelcore"
82*33de042dSApple OSS Distributions #else
83*33de042dSApple OSS Distributions #define kIOCoreDumpPath         "/private/var/vm/kernelcore"
84*33de042dSApple OSS Distributions #endif
85*33de042dSApple OSS Distributions 
86*33de042dSApple OSS Distributions #define kIOCoreDumpPrebootPath      "/private/preboot/kernelcore"
87*33de042dSApple OSS Distributions 
88*33de042dSApple OSS Distributions #define SYSTEM_NVRAM_PREFIX     "40A0DDD2-77F8-4392-B4A3-1E7304206516:"
89*33de042dSApple OSS Distributions 
90*33de042dSApple OSS Distributions #if CONFIG_KDP_INTERACTIVE_DEBUGGING
91*33de042dSApple OSS Distributions /*
92*33de042dSApple OSS Distributions  * Touched by IOFindBSDRoot() if a RAMDisk is used for the root device.
93*33de042dSApple OSS Distributions  */
94*33de042dSApple OSS Distributions extern uint64_t kdp_core_ramdisk_addr;
95*33de042dSApple OSS Distributions extern uint64_t kdp_core_ramdisk_size;
96*33de042dSApple OSS Distributions 
97*33de042dSApple OSS Distributions /*
98*33de042dSApple OSS Distributions  * A callback to indicate that the polled-mode corefile is now available.
99*33de042dSApple OSS Distributions  */
100*33de042dSApple OSS Distributions extern kern_return_t kdp_core_polled_io_polled_file_available(IOCoreFileAccessCallback access_data, void *access_context, void *recipient_context);
101*33de042dSApple OSS Distributions 
102*33de042dSApple OSS Distributions /*
103*33de042dSApple OSS Distributions  * A callback to indicate that the polled-mode corefile is no longer available.
104*33de042dSApple OSS Distributions  */
105*33de042dSApple OSS Distributions extern kern_return_t kdp_core_polled_io_polled_file_unavailable(void);
106*33de042dSApple OSS Distributions #endif
107*33de042dSApple OSS Distributions 
108*33de042dSApple OSS Distributions #if IOPOLLED_COREFILE
109*33de042dSApple OSS Distributions static void IOOpenPolledCoreFile(thread_call_param_t __unused, thread_call_param_t corefilename);
110*33de042dSApple OSS Distributions static void IOResolveCoreFilePath();
111*33de042dSApple OSS Distributions 
112*33de042dSApple OSS Distributions thread_call_t corefile_open_call = NULL;
113*33de042dSApple OSS Distributions SECURITY_READ_ONLY_LATE(const char*) kdp_corefile_path = kIOCoreDumpPath;
114*33de042dSApple OSS Distributions #endif
115*33de042dSApple OSS Distributions 
116*33de042dSApple OSS Distributions kern_return_t
IOKitBSDInit(void)117*33de042dSApple OSS Distributions IOKitBSDInit( void )
118*33de042dSApple OSS Distributions {
119*33de042dSApple OSS Distributions 	IOService::publishResource("IOBSD");
120*33de042dSApple OSS Distributions 
121*33de042dSApple OSS Distributions #if IOPOLLED_COREFILE
122*33de042dSApple OSS Distributions 	corefile_open_call = thread_call_allocate_with_options(IOOpenPolledCoreFile, NULL, THREAD_CALL_PRIORITY_KERNEL, THREAD_CALL_OPTIONS_ONCE);
123*33de042dSApple OSS Distributions #endif
124*33de042dSApple OSS Distributions 
125*33de042dSApple OSS Distributions 	return kIOReturnSuccess;
126*33de042dSApple OSS Distributions }
127*33de042dSApple OSS Distributions 
128*33de042dSApple OSS Distributions void
IOServicePublishResource(const char * property,boolean_t value)129*33de042dSApple OSS Distributions IOServicePublishResource( const char * property, boolean_t value )
130*33de042dSApple OSS Distributions {
131*33de042dSApple OSS Distributions 	if (value) {
132*33de042dSApple OSS Distributions 		IOService::publishResource( property, kOSBooleanTrue );
133*33de042dSApple OSS Distributions 	} else {
134*33de042dSApple OSS Distributions 		IOService::getResourceService()->removeProperty( property );
135*33de042dSApple OSS Distributions 	}
136*33de042dSApple OSS Distributions }
137*33de042dSApple OSS Distributions 
138*33de042dSApple OSS Distributions boolean_t
IOServiceWaitForMatchingResource(const char * property,uint64_t timeout)139*33de042dSApple OSS Distributions IOServiceWaitForMatchingResource( const char * property, uint64_t timeout )
140*33de042dSApple OSS Distributions {
141*33de042dSApple OSS Distributions 	OSDictionary *      dict = NULL;
142*33de042dSApple OSS Distributions 	IOService *         match = NULL;
143*33de042dSApple OSS Distributions 	boolean_t           found = false;
144*33de042dSApple OSS Distributions 
145*33de042dSApple OSS Distributions 	do {
146*33de042dSApple OSS Distributions 		dict = IOService::resourceMatching( property );
147*33de042dSApple OSS Distributions 		if (!dict) {
148*33de042dSApple OSS Distributions 			continue;
149*33de042dSApple OSS Distributions 		}
150*33de042dSApple OSS Distributions 		match = IOService::waitForMatchingService( dict, timeout );
151*33de042dSApple OSS Distributions 		if (match) {
152*33de042dSApple OSS Distributions 			found = true;
153*33de042dSApple OSS Distributions 		}
154*33de042dSApple OSS Distributions 	} while (false);
155*33de042dSApple OSS Distributions 
156*33de042dSApple OSS Distributions 	if (dict) {
157*33de042dSApple OSS Distributions 		dict->release();
158*33de042dSApple OSS Distributions 	}
159*33de042dSApple OSS Distributions 	if (match) {
160*33de042dSApple OSS Distributions 		match->release();
161*33de042dSApple OSS Distributions 	}
162*33de042dSApple OSS Distributions 
163*33de042dSApple OSS Distributions 	return found;
164*33de042dSApple OSS Distributions }
165*33de042dSApple OSS Distributions 
166*33de042dSApple OSS Distributions boolean_t
IOCatalogueMatchingDriversPresent(const char * property)167*33de042dSApple OSS Distributions IOCatalogueMatchingDriversPresent( const char * property )
168*33de042dSApple OSS Distributions {
169*33de042dSApple OSS Distributions 	OSDictionary *      dict = NULL;
170*33de042dSApple OSS Distributions 	OSOrderedSet *      set = NULL;
171*33de042dSApple OSS Distributions 	SInt32              generationCount = 0;
172*33de042dSApple OSS Distributions 	boolean_t           found = false;
173*33de042dSApple OSS Distributions 
174*33de042dSApple OSS Distributions 	do {
175*33de042dSApple OSS Distributions 		dict = OSDictionary::withCapacity(1);
176*33de042dSApple OSS Distributions 		if (!dict) {
177*33de042dSApple OSS Distributions 			continue;
178*33de042dSApple OSS Distributions 		}
179*33de042dSApple OSS Distributions 		dict->setObject( property, kOSBooleanTrue );
180*33de042dSApple OSS Distributions 		set = gIOCatalogue->findDrivers( dict, &generationCount );
181*33de042dSApple OSS Distributions 		if (set && (set->getCount() > 0)) {
182*33de042dSApple OSS Distributions 			found = true;
183*33de042dSApple OSS Distributions 		}
184*33de042dSApple OSS Distributions 	} while (false);
185*33de042dSApple OSS Distributions 
186*33de042dSApple OSS Distributions 	if (dict) {
187*33de042dSApple OSS Distributions 		dict->release();
188*33de042dSApple OSS Distributions 	}
189*33de042dSApple OSS Distributions 	if (set) {
190*33de042dSApple OSS Distributions 		set->release();
191*33de042dSApple OSS Distributions 	}
192*33de042dSApple OSS Distributions 
193*33de042dSApple OSS Distributions 	return found;
194*33de042dSApple OSS Distributions }
195*33de042dSApple OSS Distributions 
196*33de042dSApple OSS Distributions OSDictionary *
IOBSDNameMatching(const char * name)197*33de042dSApple OSS Distributions IOBSDNameMatching( const char * name )
198*33de042dSApple OSS Distributions {
199*33de042dSApple OSS Distributions 	OSDictionary *      dict;
200*33de042dSApple OSS Distributions 	const OSSymbol *    str = NULL;
201*33de042dSApple OSS Distributions 
202*33de042dSApple OSS Distributions 	do {
203*33de042dSApple OSS Distributions 		dict = IOService::serviceMatching( gIOServiceKey );
204*33de042dSApple OSS Distributions 		if (!dict) {
205*33de042dSApple OSS Distributions 			continue;
206*33de042dSApple OSS Distributions 		}
207*33de042dSApple OSS Distributions 		str = OSSymbol::withCString( name );
208*33de042dSApple OSS Distributions 		if (!str) {
209*33de042dSApple OSS Distributions 			continue;
210*33de042dSApple OSS Distributions 		}
211*33de042dSApple OSS Distributions 		dict->setObject( kIOBSDNameKey, (OSObject *) str );
212*33de042dSApple OSS Distributions 		str->release();
213*33de042dSApple OSS Distributions 
214*33de042dSApple OSS Distributions 		return dict;
215*33de042dSApple OSS Distributions 	} while (false);
216*33de042dSApple OSS Distributions 
217*33de042dSApple OSS Distributions 	if (dict) {
218*33de042dSApple OSS Distributions 		dict->release();
219*33de042dSApple OSS Distributions 	}
220*33de042dSApple OSS Distributions 	if (str) {
221*33de042dSApple OSS Distributions 		str->release();
222*33de042dSApple OSS Distributions 	}
223*33de042dSApple OSS Distributions 
224*33de042dSApple OSS Distributions 	return NULL;
225*33de042dSApple OSS Distributions }
226*33de042dSApple OSS Distributions 
227*33de042dSApple OSS Distributions OSDictionary *
IOUUIDMatching(void)228*33de042dSApple OSS Distributions IOUUIDMatching( void )
229*33de042dSApple OSS Distributions {
230*33de042dSApple OSS Distributions 	OSObject     * obj;
231*33de042dSApple OSS Distributions 	OSDictionary * result;
232*33de042dSApple OSS Distributions 
233*33de042dSApple OSS Distributions 	obj = OSUnserialize(
234*33de042dSApple OSS Distributions 		"{"
235*33de042dSApple OSS Distributions 		"'IOProviderClass' = 'IOResources';"
236*33de042dSApple OSS Distributions 		"'IOResourceMatch' = ('IOBSD', 'boot-uuid-media');"
237*33de042dSApple OSS Distributions 		"}",
238*33de042dSApple OSS Distributions 		NULL);
239*33de042dSApple OSS Distributions 	result = OSDynamicCast(OSDictionary, obj);
240*33de042dSApple OSS Distributions 	assert(result);
241*33de042dSApple OSS Distributions 
242*33de042dSApple OSS Distributions 	return result;
243*33de042dSApple OSS Distributions }
244*33de042dSApple OSS Distributions 
245*33de042dSApple OSS Distributions OSDictionary *
IONetworkNamePrefixMatching(const char * prefix)246*33de042dSApple OSS Distributions IONetworkNamePrefixMatching( const char * prefix )
247*33de042dSApple OSS Distributions {
248*33de042dSApple OSS Distributions 	OSDictionary *       matching;
249*33de042dSApple OSS Distributions 	OSDictionary *   propDict = NULL;
250*33de042dSApple OSS Distributions 	const OSSymbol * str      = NULL;
251*33de042dSApple OSS Distributions 	char networkType[128];
252*33de042dSApple OSS Distributions 
253*33de042dSApple OSS Distributions 	do {
254*33de042dSApple OSS Distributions 		matching = IOService::serviceMatching( "IONetworkInterface" );
255*33de042dSApple OSS Distributions 		if (matching == NULL) {
256*33de042dSApple OSS Distributions 			continue;
257*33de042dSApple OSS Distributions 		}
258*33de042dSApple OSS Distributions 
259*33de042dSApple OSS Distributions 		propDict = OSDictionary::withCapacity(1);
260*33de042dSApple OSS Distributions 		if (propDict == NULL) {
261*33de042dSApple OSS Distributions 			continue;
262*33de042dSApple OSS Distributions 		}
263*33de042dSApple OSS Distributions 
264*33de042dSApple OSS Distributions 		str = OSSymbol::withCString( prefix );
265*33de042dSApple OSS Distributions 		if (str == NULL) {
266*33de042dSApple OSS Distributions 			continue;
267*33de042dSApple OSS Distributions 		}
268*33de042dSApple OSS Distributions 
269*33de042dSApple OSS Distributions 		propDict->setObject( "IOInterfaceNamePrefix", (OSObject *) str );
270*33de042dSApple OSS Distributions 		str->release();
271*33de042dSApple OSS Distributions 		str = NULL;
272*33de042dSApple OSS Distributions 
273*33de042dSApple OSS Distributions 		// see if we're contrained to netroot off of specific network type
274*33de042dSApple OSS Distributions 		if (PE_parse_boot_argn( "network-type", networkType, 128 )) {
275*33de042dSApple OSS Distributions 			str = OSSymbol::withCString( networkType );
276*33de042dSApple OSS Distributions 			if (str) {
277*33de042dSApple OSS Distributions 				propDict->setObject( "IONetworkRootType", str);
278*33de042dSApple OSS Distributions 				str->release();
279*33de042dSApple OSS Distributions 				str = NULL;
280*33de042dSApple OSS Distributions 			}
281*33de042dSApple OSS Distributions 		}
282*33de042dSApple OSS Distributions 
283*33de042dSApple OSS Distributions 		if (matching->setObject( gIOPropertyMatchKey,
284*33de042dSApple OSS Distributions 		    (OSObject *) propDict ) != true) {
285*33de042dSApple OSS Distributions 			continue;
286*33de042dSApple OSS Distributions 		}
287*33de042dSApple OSS Distributions 
288*33de042dSApple OSS Distributions 		propDict->release();
289*33de042dSApple OSS Distributions 		propDict = NULL;
290*33de042dSApple OSS Distributions 
291*33de042dSApple OSS Distributions 		return matching;
292*33de042dSApple OSS Distributions 	} while (false);
293*33de042dSApple OSS Distributions 
294*33de042dSApple OSS Distributions 	if (matching) {
295*33de042dSApple OSS Distributions 		matching->release();
296*33de042dSApple OSS Distributions 	}
297*33de042dSApple OSS Distributions 	if (propDict) {
298*33de042dSApple OSS Distributions 		propDict->release();
299*33de042dSApple OSS Distributions 	}
300*33de042dSApple OSS Distributions 	if (str) {
301*33de042dSApple OSS Distributions 		str->release();
302*33de042dSApple OSS Distributions 	}
303*33de042dSApple OSS Distributions 
304*33de042dSApple OSS Distributions 	return NULL;
305*33de042dSApple OSS Distributions }
306*33de042dSApple OSS Distributions 
307*33de042dSApple OSS Distributions static bool
IORegisterNetworkInterface(IOService * netif)308*33de042dSApple OSS Distributions IORegisterNetworkInterface( IOService * netif )
309*33de042dSApple OSS Distributions {
310*33de042dSApple OSS Distributions 	// A network interface is typically named and registered
311*33de042dSApple OSS Distributions 	// with BSD after receiving a request from a user space
312*33de042dSApple OSS Distributions 	// "namer". However, for cases when the system needs to
313*33de042dSApple OSS Distributions 	// root from the network, this registration task must be
314*33de042dSApple OSS Distributions 	// done inside the kernel and completed before the root
315*33de042dSApple OSS Distributions 	// device is handed to BSD.
316*33de042dSApple OSS Distributions 
317*33de042dSApple OSS Distributions 	IOService *    stack;
318*33de042dSApple OSS Distributions 	OSNumber *     zero    = NULL;
319*33de042dSApple OSS Distributions 	OSString *     path    = NULL;
320*33de042dSApple OSS Distributions 	OSDictionary * dict    = NULL;
321*33de042dSApple OSS Distributions 	OSDataAllocation<char> pathBuf;
322*33de042dSApple OSS Distributions 	int            len;
323*33de042dSApple OSS Distributions 	enum { kMaxPathLen = 512 };
324*33de042dSApple OSS Distributions 
325*33de042dSApple OSS Distributions 	do {
326*33de042dSApple OSS Distributions 		stack = IOService::waitForService(
327*33de042dSApple OSS Distributions 			IOService::serviceMatching("IONetworkStack"));
328*33de042dSApple OSS Distributions 		if (stack == NULL) {
329*33de042dSApple OSS Distributions 			break;
330*33de042dSApple OSS Distributions 		}
331*33de042dSApple OSS Distributions 
332*33de042dSApple OSS Distributions 		dict = OSDictionary::withCapacity(3);
333*33de042dSApple OSS Distributions 		if (dict == NULL) {
334*33de042dSApple OSS Distributions 			break;
335*33de042dSApple OSS Distributions 		}
336*33de042dSApple OSS Distributions 
337*33de042dSApple OSS Distributions 		zero = OSNumber::withNumber((UInt64) 0, 32);
338*33de042dSApple OSS Distributions 		if (zero == NULL) {
339*33de042dSApple OSS Distributions 			break;
340*33de042dSApple OSS Distributions 		}
341*33de042dSApple OSS Distributions 
342*33de042dSApple OSS Distributions 		pathBuf = OSDataAllocation<char>( kMaxPathLen, OSAllocateMemory );
343*33de042dSApple OSS Distributions 		if (!pathBuf) {
344*33de042dSApple OSS Distributions 			break;
345*33de042dSApple OSS Distributions 		}
346*33de042dSApple OSS Distributions 
347*33de042dSApple OSS Distributions 		len = kMaxPathLen;
348*33de042dSApple OSS Distributions 		if (netif->getPath( pathBuf.data(), &len, gIOServicePlane )
349*33de042dSApple OSS Distributions 		    == false) {
350*33de042dSApple OSS Distributions 			break;
351*33de042dSApple OSS Distributions 		}
352*33de042dSApple OSS Distributions 
353*33de042dSApple OSS Distributions 		path = OSString::withCStringNoCopy(pathBuf.data());
354*33de042dSApple OSS Distributions 		if (path == NULL) {
355*33de042dSApple OSS Distributions 			break;
356*33de042dSApple OSS Distributions 		}
357*33de042dSApple OSS Distributions 
358*33de042dSApple OSS Distributions 		dict->setObject( "IOInterfaceUnit", zero );
359*33de042dSApple OSS Distributions 		dict->setObject( kIOPathMatchKey, path );
360*33de042dSApple OSS Distributions 
361*33de042dSApple OSS Distributions 		stack->setProperties( dict );
362*33de042dSApple OSS Distributions 	}while (false);
363*33de042dSApple OSS Distributions 
364*33de042dSApple OSS Distributions 	if (zero) {
365*33de042dSApple OSS Distributions 		zero->release();
366*33de042dSApple OSS Distributions 	}
367*33de042dSApple OSS Distributions 	if (path) {
368*33de042dSApple OSS Distributions 		path->release();
369*33de042dSApple OSS Distributions 	}
370*33de042dSApple OSS Distributions 	if (dict) {
371*33de042dSApple OSS Distributions 		dict->release();
372*33de042dSApple OSS Distributions 	}
373*33de042dSApple OSS Distributions 
374*33de042dSApple OSS Distributions 	return netif->getProperty( kIOBSDNameKey ) != NULL;
375*33de042dSApple OSS Distributions }
376*33de042dSApple OSS Distributions 
377*33de042dSApple OSS Distributions OSDictionary *
IOOFPathMatching(const char * path,char * buf,int maxLen)378*33de042dSApple OSS Distributions IOOFPathMatching( const char * path, char * buf, int maxLen )
379*33de042dSApple OSS Distributions {
380*33de042dSApple OSS Distributions 	OSDictionary *      matching = NULL;
381*33de042dSApple OSS Distributions 	OSString *          str;
382*33de042dSApple OSS Distributions 	char *              comp;
383*33de042dSApple OSS Distributions 	int                 len;
384*33de042dSApple OSS Distributions 
385*33de042dSApple OSS Distributions 	do {
386*33de042dSApple OSS Distributions 		len = ((int) strlen( kIODeviceTreePlane ":" ));
387*33de042dSApple OSS Distributions 		maxLen -= len;
388*33de042dSApple OSS Distributions 		if (maxLen <= 0) {
389*33de042dSApple OSS Distributions 			continue;
390*33de042dSApple OSS Distributions 		}
391*33de042dSApple OSS Distributions 
392*33de042dSApple OSS Distributions 		strlcpy( buf, kIODeviceTreePlane ":", len + 1 );
393*33de042dSApple OSS Distributions 		comp = buf + len;
394*33de042dSApple OSS Distributions 
395*33de042dSApple OSS Distributions 		len = ((int) strnlen( path, INT_MAX ));
396*33de042dSApple OSS Distributions 		maxLen -= len;
397*33de042dSApple OSS Distributions 		if (maxLen <= 0) {
398*33de042dSApple OSS Distributions 			continue;
399*33de042dSApple OSS Distributions 		}
400*33de042dSApple OSS Distributions 		strlcpy( comp, path, len + 1 );
401*33de042dSApple OSS Distributions 
402*33de042dSApple OSS Distributions 		matching = OSDictionary::withCapacity( 1 );
403*33de042dSApple OSS Distributions 		if (!matching) {
404*33de042dSApple OSS Distributions 			continue;
405*33de042dSApple OSS Distributions 		}
406*33de042dSApple OSS Distributions 
407*33de042dSApple OSS Distributions 		str = OSString::withCString( buf );
408*33de042dSApple OSS Distributions 		if (!str) {
409*33de042dSApple OSS Distributions 			continue;
410*33de042dSApple OSS Distributions 		}
411*33de042dSApple OSS Distributions 		matching->setObject( kIOPathMatchKey, str );
412*33de042dSApple OSS Distributions 		str->release();
413*33de042dSApple OSS Distributions 
414*33de042dSApple OSS Distributions 		return matching;
415*33de042dSApple OSS Distributions 	} while (false);
416*33de042dSApple OSS Distributions 
417*33de042dSApple OSS Distributions 	if (matching) {
418*33de042dSApple OSS Distributions 		matching->release();
419*33de042dSApple OSS Distributions 	}
420*33de042dSApple OSS Distributions 
421*33de042dSApple OSS Distributions 	return NULL;
422*33de042dSApple OSS Distributions }
423*33de042dSApple OSS Distributions 
424*33de042dSApple OSS Distributions static int didRam = 0;
425*33de042dSApple OSS Distributions enum { kMaxPathBuf = 512, kMaxBootVar = 128 };
426*33de042dSApple OSS Distributions 
427*33de042dSApple OSS Distributions bool
IOGetBootUUID(char * uuid)428*33de042dSApple OSS Distributions IOGetBootUUID(char *uuid)
429*33de042dSApple OSS Distributions {
430*33de042dSApple OSS Distributions 	IORegistryEntry *entry;
431*33de042dSApple OSS Distributions 	OSData *uuid_data = NULL;
432*33de042dSApple OSS Distributions 	bool result = false;
433*33de042dSApple OSS Distributions 
434*33de042dSApple OSS Distributions 	if ((entry = IORegistryEntry::fromPath("/chosen", gIODTPlane))) {
435*33de042dSApple OSS Distributions 		uuid_data = (OSData *)entry->getProperty("boot-uuid");
436*33de042dSApple OSS Distributions 		if (uuid_data) {
437*33de042dSApple OSS Distributions 			unsigned int length = uuid_data->getLength();
438*33de042dSApple OSS Distributions 			if (length <= sizeof(uuid_string_t)) {
439*33de042dSApple OSS Distributions 				/* ensure caller's buffer is fully initialized: */
440*33de042dSApple OSS Distributions 				bzero(uuid, sizeof(uuid_string_t));
441*33de042dSApple OSS Distributions 				/* copy the content of uuid_data->getBytesNoCopy() into uuid */
442*33de042dSApple OSS Distributions 				memcpy(uuid, uuid_data->getBytesNoCopy(), length);
443*33de042dSApple OSS Distributions 				/* guarantee nul-termination: */
444*33de042dSApple OSS Distributions 				uuid[sizeof(uuid_string_t) - 1] = '\0';
445*33de042dSApple OSS Distributions 				result = true;
446*33de042dSApple OSS Distributions 			} else {
447*33de042dSApple OSS Distributions 				uuid = NULL;
448*33de042dSApple OSS Distributions 			}
449*33de042dSApple OSS Distributions 		}
450*33de042dSApple OSS Distributions 		OSSafeReleaseNULL(entry);
451*33de042dSApple OSS Distributions 	}
452*33de042dSApple OSS Distributions 	return result;
453*33de042dSApple OSS Distributions }
454*33de042dSApple OSS Distributions 
455*33de042dSApple OSS Distributions bool
IOGetApfsPrebootUUID(char * uuid)456*33de042dSApple OSS Distributions IOGetApfsPrebootUUID(char *uuid)
457*33de042dSApple OSS Distributions {
458*33de042dSApple OSS Distributions 	IORegistryEntry *entry;
459*33de042dSApple OSS Distributions 	OSData *uuid_data = NULL;
460*33de042dSApple OSS Distributions 	bool result = false;
461*33de042dSApple OSS Distributions 
462*33de042dSApple OSS Distributions 	if ((entry = IORegistryEntry::fromPath("/chosen", gIODTPlane))) {
463*33de042dSApple OSS Distributions 		uuid_data = (OSData *)entry->getProperty("apfs-preboot-uuid");
464*33de042dSApple OSS Distributions 
465*33de042dSApple OSS Distributions 		if (uuid_data) {
466*33de042dSApple OSS Distributions 			unsigned int length = uuid_data->getLength();
467*33de042dSApple OSS Distributions 			if (length <= sizeof(uuid_string_t)) {
468*33de042dSApple OSS Distributions 				/* ensure caller's buffer is fully initialized: */
469*33de042dSApple OSS Distributions 				bzero(uuid, sizeof(uuid_string_t));
470*33de042dSApple OSS Distributions 				/* copy the content of uuid_data->getBytesNoCopy() into uuid */
471*33de042dSApple OSS Distributions 				memcpy(uuid, uuid_data->getBytesNoCopy(), length);
472*33de042dSApple OSS Distributions 				/* guarantee nul-termination: */
473*33de042dSApple OSS Distributions 				uuid[sizeof(uuid_string_t) - 1] = '\0';
474*33de042dSApple OSS Distributions 				result = true;
475*33de042dSApple OSS Distributions 			} else {
476*33de042dSApple OSS Distributions 				uuid = NULL;
477*33de042dSApple OSS Distributions 			}
478*33de042dSApple OSS Distributions 		}
479*33de042dSApple OSS Distributions 		OSSafeReleaseNULL(entry);
480*33de042dSApple OSS Distributions 	}
481*33de042dSApple OSS Distributions 	return result;
482*33de042dSApple OSS Distributions }
483*33de042dSApple OSS Distributions 
484*33de042dSApple OSS Distributions bool
IOGetAssociatedApfsVolgroupUUID(char * uuid)485*33de042dSApple OSS Distributions IOGetAssociatedApfsVolgroupUUID(char *uuid)
486*33de042dSApple OSS Distributions {
487*33de042dSApple OSS Distributions 	IORegistryEntry *entry;
488*33de042dSApple OSS Distributions 	OSData *uuid_data = NULL;
489*33de042dSApple OSS Distributions 	bool result = false;
490*33de042dSApple OSS Distributions 
491*33de042dSApple OSS Distributions 	if ((entry = IORegistryEntry::fromPath("/chosen", gIODTPlane))) {
492*33de042dSApple OSS Distributions 		uuid_data = (OSData *)entry->getProperty("associated-volume-group");
493*33de042dSApple OSS Distributions 
494*33de042dSApple OSS Distributions 		if (uuid_data) {
495*33de042dSApple OSS Distributions 			unsigned int length = uuid_data->getLength();
496*33de042dSApple OSS Distributions 
497*33de042dSApple OSS Distributions 			if (length <= sizeof(uuid_string_t)) {
498*33de042dSApple OSS Distributions 				/* ensure caller's buffer is fully initialized: */
499*33de042dSApple OSS Distributions 				bzero(uuid, sizeof(uuid_string_t));
500*33de042dSApple OSS Distributions 				/* copy the content of uuid_data->getBytesNoCopy() into uuid */
501*33de042dSApple OSS Distributions 				memcpy(uuid, uuid_data->getBytesNoCopy(), length);
502*33de042dSApple OSS Distributions 				/* guarantee nul-termination: */
503*33de042dSApple OSS Distributions 				uuid[sizeof(uuid_string_t) - 1] = '\0';
504*33de042dSApple OSS Distributions 				result = true;
505*33de042dSApple OSS Distributions 			} else {
506*33de042dSApple OSS Distributions 				uuid = NULL;
507*33de042dSApple OSS Distributions 			}
508*33de042dSApple OSS Distributions 		}
509*33de042dSApple OSS Distributions 		OSSafeReleaseNULL(entry);
510*33de042dSApple OSS Distributions 	}
511*33de042dSApple OSS Distributions 	return result;
512*33de042dSApple OSS Distributions }
513*33de042dSApple OSS Distributions 
514*33de042dSApple OSS Distributions bool
IOGetBootObjectsPath(char * path_prefix)515*33de042dSApple OSS Distributions IOGetBootObjectsPath(char *path_prefix)
516*33de042dSApple OSS Distributions {
517*33de042dSApple OSS Distributions 	IORegistryEntry *entry;
518*33de042dSApple OSS Distributions 	OSData *path_prefix_data = NULL;
519*33de042dSApple OSS Distributions 	bool result = false;
520*33de042dSApple OSS Distributions 
521*33de042dSApple OSS Distributions 	if ((entry = IORegistryEntry::fromPath("/chosen", gIODTPlane))) {
522*33de042dSApple OSS Distributions 		path_prefix_data = (OSData *)entry->getProperty("boot-objects-path");
523*33de042dSApple OSS Distributions 
524*33de042dSApple OSS Distributions 		if (path_prefix_data) {
525*33de042dSApple OSS Distributions 			unsigned int length = path_prefix_data->getLength();
526*33de042dSApple OSS Distributions 
527*33de042dSApple OSS Distributions 			if (length <= MAXPATHLEN) {
528*33de042dSApple OSS Distributions 				/* ensure caller's buffer is fully initialized: */
529*33de042dSApple OSS Distributions 				bzero(path_prefix, MAXPATHLEN);
530*33de042dSApple OSS Distributions 				/* copy the content of path_prefix_data->getBytesNoCopy() into path_prefix */
531*33de042dSApple OSS Distributions 				memcpy(path_prefix, path_prefix_data->getBytesNoCopy(), length);
532*33de042dSApple OSS Distributions 				/* guarantee nul-termination: */
533*33de042dSApple OSS Distributions 				path_prefix[MAXPATHLEN - 1] = '\0';
534*33de042dSApple OSS Distributions 				result = true;
535*33de042dSApple OSS Distributions 			} else {
536*33de042dSApple OSS Distributions 				path_prefix = NULL;
537*33de042dSApple OSS Distributions 			}
538*33de042dSApple OSS Distributions 		}
539*33de042dSApple OSS Distributions 		OSSafeReleaseNULL(entry);
540*33de042dSApple OSS Distributions 	}
541*33de042dSApple OSS Distributions 	return result;
542*33de042dSApple OSS Distributions }
543*33de042dSApple OSS Distributions 
544*33de042dSApple OSS Distributions 
545*33de042dSApple OSS Distributions bool
IOGetBootManifestHash(char * hash_data,size_t * hash_data_size)546*33de042dSApple OSS Distributions IOGetBootManifestHash(char *hash_data, size_t *hash_data_size)
547*33de042dSApple OSS Distributions {
548*33de042dSApple OSS Distributions 	IORegistryEntry *entry = NULL;
549*33de042dSApple OSS Distributions 	OSData *manifest_hash_data = NULL;
550*33de042dSApple OSS Distributions 	bool result = false;
551*33de042dSApple OSS Distributions 
552*33de042dSApple OSS Distributions 	if ((entry = IORegistryEntry::fromPath("/chosen", gIODTPlane))) {
553*33de042dSApple OSS Distributions 		manifest_hash_data = (OSData *)entry->getProperty("boot-manifest-hash");
554*33de042dSApple OSS Distributions 		if (manifest_hash_data) {
555*33de042dSApple OSS Distributions 			unsigned int length = manifest_hash_data->getLength();
556*33de042dSApple OSS Distributions 			/* hashed with SHA2-384 or SHA1, the boot manifest hash should be 48 Bytes or less */
557*33de042dSApple OSS Distributions 			if ((length <= CCSHA384_OUTPUT_SIZE) && (*hash_data_size >= CCSHA384_OUTPUT_SIZE)) {
558*33de042dSApple OSS Distributions 				/* ensure caller's buffer is fully initialized: */
559*33de042dSApple OSS Distributions 				bzero(hash_data, CCSHA384_OUTPUT_SIZE);
560*33de042dSApple OSS Distributions 				/* copy the content of manifest_hash_data->getBytesNoCopy() into hash_data */
561*33de042dSApple OSS Distributions 				memcpy(hash_data, manifest_hash_data->getBytesNoCopy(), length);
562*33de042dSApple OSS Distributions 				*hash_data_size = length;
563*33de042dSApple OSS Distributions 				result = true;
564*33de042dSApple OSS Distributions 			} else {
565*33de042dSApple OSS Distributions 				hash_data = NULL;
566*33de042dSApple OSS Distributions 				*hash_data_size = 0;
567*33de042dSApple OSS Distributions 			}
568*33de042dSApple OSS Distributions 		}
569*33de042dSApple OSS Distributions 		OSSafeReleaseNULL(entry);
570*33de042dSApple OSS Distributions 	}
571*33de042dSApple OSS Distributions 
572*33de042dSApple OSS Distributions 	return result;
573*33de042dSApple OSS Distributions }
574*33de042dSApple OSS Distributions 
575*33de042dSApple OSS Distributions /*
576*33de042dSApple OSS Distributions  * Set NVRAM to boot into the right flavor of Recovery,
577*33de042dSApple OSS Distributions  * optionally passing a UUID of a volume that failed to boot.
578*33de042dSApple OSS Distributions  * If `reboot` is true, reboot immediately.
579*33de042dSApple OSS Distributions  *
580*33de042dSApple OSS Distributions  * Returns true if `mode` was understood, false otherwise.
581*33de042dSApple OSS Distributions  * (Does not return if `reboot` is true.)
582*33de042dSApple OSS Distributions  */
583*33de042dSApple OSS Distributions boolean_t
IOSetRecoveryBoot(bsd_bootfail_mode_t mode,uuid_t volume_uuid,boolean_t reboot)584*33de042dSApple OSS Distributions IOSetRecoveryBoot(bsd_bootfail_mode_t mode, uuid_t volume_uuid, boolean_t reboot)
585*33de042dSApple OSS Distributions {
586*33de042dSApple OSS Distributions 	IODTNVRAM *nvram = NULL;
587*33de042dSApple OSS Distributions 	const OSSymbol *boot_command_sym = NULL;
588*33de042dSApple OSS Distributions 	OSString *boot_command_recover = NULL;
589*33de042dSApple OSS Distributions 
590*33de042dSApple OSS Distributions 	if (mode == BSD_BOOTFAIL_SEAL_BROKEN) {
591*33de042dSApple OSS Distributions 		const char *boot_mode = "ssv-seal-broken";
592*33de042dSApple OSS Distributions 		uuid_string_t volume_uuid_str;
593*33de042dSApple OSS Distributions 
594*33de042dSApple OSS Distributions 		// Set `recovery-broken-seal-uuid = <volume_uuid>`.
595*33de042dSApple OSS Distributions 		if (volume_uuid) {
596*33de042dSApple OSS Distributions 			uuid_unparse_upper(volume_uuid, volume_uuid_str);
597*33de042dSApple OSS Distributions 
598*33de042dSApple OSS Distributions 			if (!PEWriteNVRAMProperty(SYSTEM_NVRAM_PREFIX "recovery-broken-seal-uuid",
599*33de042dSApple OSS Distributions 			    volume_uuid_str, sizeof(uuid_string_t))) {
600*33de042dSApple OSS Distributions 				IOLog("Failed to write recovery-broken-seal-uuid to NVRAM.\n");
601*33de042dSApple OSS Distributions 			}
602*33de042dSApple OSS Distributions 		}
603*33de042dSApple OSS Distributions 
604*33de042dSApple OSS Distributions 		// Set `recovery-boot-mode = ssv-seal-broken`.
605*33de042dSApple OSS Distributions 		if (!PEWriteNVRAMProperty(SYSTEM_NVRAM_PREFIX "recovery-boot-mode", boot_mode,
606*33de042dSApple OSS Distributions 		    (const unsigned int) strlen(boot_mode))) {
607*33de042dSApple OSS Distributions 			IOLog("Failed to write recovery-boot-mode to NVRAM.\n");
608*33de042dSApple OSS Distributions 		}
609*33de042dSApple OSS Distributions 	} else if (mode == BSD_BOOTFAIL_MEDIA_MISSING) {
610*33de042dSApple OSS Distributions 		const char *boot_picker_reason = "missing-boot-media";
611*33de042dSApple OSS Distributions 
612*33de042dSApple OSS Distributions 		// Set `boot-picker-bringup-reason = missing-boot-media`.
613*33de042dSApple OSS Distributions 		if (!PEWriteNVRAMProperty(SYSTEM_NVRAM_PREFIX "boot-picker-bringup-reason",
614*33de042dSApple OSS Distributions 		    boot_picker_reason, (const unsigned int) strlen(boot_picker_reason))) {
615*33de042dSApple OSS Distributions 			IOLog("Failed to write boot-picker-bringup-reason to NVRAM.\n");
616*33de042dSApple OSS Distributions 		}
617*33de042dSApple OSS Distributions 
618*33de042dSApple OSS Distributions 		// Set `boot-command = recover-system`.
619*33de042dSApple OSS Distributions 
620*33de042dSApple OSS Distributions 		// Construct an OSSymbol and an OSString to be the (key, value) pair
621*33de042dSApple OSS Distributions 		// we write to NVRAM. Unfortunately, since our value must be an OSString
622*33de042dSApple OSS Distributions 		// instead of an OSData, we cannot use PEWriteNVRAMProperty() here.
623*33de042dSApple OSS Distributions 		boot_command_sym = OSSymbol::withCStringNoCopy(SYSTEM_NVRAM_PREFIX "boot-command");
624*33de042dSApple OSS Distributions 		boot_command_recover = OSString::withCStringNoCopy("recover-system");
625*33de042dSApple OSS Distributions 		if (boot_command_sym == NULL || boot_command_recover == NULL) {
626*33de042dSApple OSS Distributions 			IOLog("Failed to create boot-command strings.\n");
627*33de042dSApple OSS Distributions 			goto do_reboot;
628*33de042dSApple OSS Distributions 		}
629*33de042dSApple OSS Distributions 
630*33de042dSApple OSS Distributions 		// Wait for NVRAM to be readable...
631*33de042dSApple OSS Distributions 		nvram = OSDynamicCast(IODTNVRAM, IOService::waitForService(
632*33de042dSApple OSS Distributions 			    IOService::serviceMatching("IODTNVRAM")));
633*33de042dSApple OSS Distributions 		if (nvram == NULL) {
634*33de042dSApple OSS Distributions 			IOLog("Failed to acquire IODTNVRAM object.\n");
635*33de042dSApple OSS Distributions 			goto do_reboot;
636*33de042dSApple OSS Distributions 		}
637*33de042dSApple OSS Distributions 
638*33de042dSApple OSS Distributions 		// Wait for NVRAM to be writable...
639*33de042dSApple OSS Distributions 		if (!IOServiceWaitForMatchingResource("IONVRAM", UINT64_MAX)) {
640*33de042dSApple OSS Distributions 			IOLog("Failed to wait for IONVRAM service.\n");
641*33de042dSApple OSS Distributions 			// attempt the work anyway...
642*33de042dSApple OSS Distributions 		}
643*33de042dSApple OSS Distributions 
644*33de042dSApple OSS Distributions 		// Write the new boot-command to NVRAM, and sync if successful.
645*33de042dSApple OSS Distributions 		if (!nvram->setProperty(boot_command_sym, boot_command_recover)) {
646*33de042dSApple OSS Distributions 			IOLog("Failed to save new boot-command to NVRAM.\n");
647*33de042dSApple OSS Distributions 		} else {
648*33de042dSApple OSS Distributions 			nvram->sync();
649*33de042dSApple OSS Distributions 		}
650*33de042dSApple OSS Distributions 	} else {
651*33de042dSApple OSS Distributions 		IOLog("Unknown mode: %d\n", mode);
652*33de042dSApple OSS Distributions 		return false;
653*33de042dSApple OSS Distributions 	}
654*33de042dSApple OSS Distributions 
655*33de042dSApple OSS Distributions 	// Clean up and reboot!
656*33de042dSApple OSS Distributions do_reboot:
657*33de042dSApple OSS Distributions 	if (boot_command_recover != NULL) {
658*33de042dSApple OSS Distributions 		boot_command_recover->release();
659*33de042dSApple OSS Distributions 	}
660*33de042dSApple OSS Distributions 
661*33de042dSApple OSS Distributions 	if (boot_command_sym != NULL) {
662*33de042dSApple OSS Distributions 		boot_command_sym->release();
663*33de042dSApple OSS Distributions 	}
664*33de042dSApple OSS Distributions 
665*33de042dSApple OSS Distributions 	if (reboot) {
666*33de042dSApple OSS Distributions 		IOLog("\nAbout to reboot into Recovery!\n");
667*33de042dSApple OSS Distributions 		(void)PEHaltRestart(kPEPanicRestartCPUNoCallouts);
668*33de042dSApple OSS Distributions 	}
669*33de042dSApple OSS Distributions 
670*33de042dSApple OSS Distributions 	return true;
671*33de042dSApple OSS Distributions }
672*33de042dSApple OSS Distributions 
673*33de042dSApple OSS Distributions kern_return_t
IOFindBSDRoot(char * rootName,unsigned int rootNameSize,dev_t * root,u_int32_t * oflags)674*33de042dSApple OSS Distributions IOFindBSDRoot( char * rootName, unsigned int rootNameSize,
675*33de042dSApple OSS Distributions     dev_t * root, u_int32_t * oflags )
676*33de042dSApple OSS Distributions {
677*33de042dSApple OSS Distributions 	mach_timespec_t     t;
678*33de042dSApple OSS Distributions 	IOService *         service;
679*33de042dSApple OSS Distributions 	IORegistryEntry *   regEntry;
680*33de042dSApple OSS Distributions 	OSDictionary *      matching = NULL;
681*33de042dSApple OSS Distributions 	OSString *          iostr;
682*33de042dSApple OSS Distributions 	OSNumber *          off;
683*33de042dSApple OSS Distributions 	OSData *            data = NULL;
684*33de042dSApple OSS Distributions 
685*33de042dSApple OSS Distributions 	UInt32              flags = 0;
686*33de042dSApple OSS Distributions 	int                 mnr, mjr;
687*33de042dSApple OSS Distributions 	const char *        mediaProperty = NULL;
688*33de042dSApple OSS Distributions 	char *              rdBootVar;
689*33de042dSApple OSS Distributions 	OSDataAllocation<char> str;
690*33de042dSApple OSS Distributions 	const char *        look = NULL;
691*33de042dSApple OSS Distributions 	int                 len;
692*33de042dSApple OSS Distributions 	int                 wdt = 0;
693*33de042dSApple OSS Distributions 	bool                debugInfoPrintedOnce = false;
694*33de042dSApple OSS Distributions 	bool                needNetworkKexts = false;
695*33de042dSApple OSS Distributions 	const char *        uuidStr = NULL;
696*33de042dSApple OSS Distributions 
697*33de042dSApple OSS Distributions 	static int          mountAttempts = 0;
698*33de042dSApple OSS Distributions 
699*33de042dSApple OSS Distributions 	int xchar, dchar;
700*33de042dSApple OSS Distributions 
701*33de042dSApple OSS Distributions 	// stall here for anyone matching on the IOBSD resource to finish (filesystems)
702*33de042dSApple OSS Distributions 	matching = IOService::serviceMatching(gIOResourcesKey);
703*33de042dSApple OSS Distributions 	assert(matching);
704*33de042dSApple OSS Distributions 	matching->setObject(gIOResourceMatchedKey, gIOBSDKey);
705*33de042dSApple OSS Distributions 
706*33de042dSApple OSS Distributions 	if ((service = IOService::waitForMatchingService(matching, 30ULL * kSecondScale))) {
707*33de042dSApple OSS Distributions 		OSSafeReleaseNULL(service);
708*33de042dSApple OSS Distributions 	} else {
709*33de042dSApple OSS Distributions 		IOLog("!BSD\n");
710*33de042dSApple OSS Distributions 	}
711*33de042dSApple OSS Distributions 	matching->release();
712*33de042dSApple OSS Distributions 	matching = NULL;
713*33de042dSApple OSS Distributions 
714*33de042dSApple OSS Distributions 	if (mountAttempts++) {
715*33de042dSApple OSS Distributions 		IOLog("mount(%d) failed\n", mountAttempts);
716*33de042dSApple OSS Distributions 		IOSleep( 5 * 1000 );
717*33de042dSApple OSS Distributions 	}
718*33de042dSApple OSS Distributions 
719*33de042dSApple OSS Distributions 	str = OSDataAllocation<char>( kMaxPathBuf + kMaxBootVar, OSAllocateMemory );
720*33de042dSApple OSS Distributions 	if (!str) {
721*33de042dSApple OSS Distributions 		return kIOReturnNoMemory;
722*33de042dSApple OSS Distributions 	}
723*33de042dSApple OSS Distributions 	rdBootVar = str.data() + kMaxPathBuf;
724*33de042dSApple OSS Distributions 
725*33de042dSApple OSS Distributions 	if (!PE_parse_boot_argn("rd", rdBootVar, kMaxBootVar )
726*33de042dSApple OSS Distributions 	    && !PE_parse_boot_argn("rootdev", rdBootVar, kMaxBootVar )) {
727*33de042dSApple OSS Distributions 		rdBootVar[0] = 0;
728*33de042dSApple OSS Distributions 	}
729*33de042dSApple OSS Distributions 
730*33de042dSApple OSS Distributions 	if ((regEntry = IORegistryEntry::fromPath( "/chosen", gIODTPlane ))) {
731*33de042dSApple OSS Distributions 		do {
732*33de042dSApple OSS Distributions 			di_root_ramfile(regEntry);
733*33de042dSApple OSS Distributions 			OSObject* unserializedContainer = NULL;
734*33de042dSApple OSS Distributions 			data = OSDynamicCast(OSData, regEntry->getProperty( "root-matching" ));
735*33de042dSApple OSS Distributions 			if (data) {
736*33de042dSApple OSS Distributions 				unserializedContainer = OSUnserializeXML((char *)data->getBytesNoCopy());
737*33de042dSApple OSS Distributions 				matching = OSDynamicCast(OSDictionary, unserializedContainer);
738*33de042dSApple OSS Distributions 				if (matching) {
739*33de042dSApple OSS Distributions 					continue;
740*33de042dSApple OSS Distributions 				}
741*33de042dSApple OSS Distributions 			}
742*33de042dSApple OSS Distributions 			OSSafeReleaseNULL(unserializedContainer);
743*33de042dSApple OSS Distributions 
744*33de042dSApple OSS Distributions 			data = (OSData *) regEntry->getProperty( "boot-uuid" );
745*33de042dSApple OSS Distributions 			if (data) {
746*33de042dSApple OSS Distributions 				uuidStr = (const char*)data->getBytesNoCopy();
747*33de042dSApple OSS Distributions 				OSString *uuidString = OSString::withCString( uuidStr );
748*33de042dSApple OSS Distributions 
749*33de042dSApple OSS Distributions 				// match the boot-args boot-uuid processing below
750*33de042dSApple OSS Distributions 				if (uuidString) {
751*33de042dSApple OSS Distributions 					IOLog("rooting via boot-uuid from /chosen: %s\n", uuidStr);
752*33de042dSApple OSS Distributions 					IOService::publishResource( "boot-uuid", uuidString );
753*33de042dSApple OSS Distributions 					uuidString->release();
754*33de042dSApple OSS Distributions 					matching = IOUUIDMatching();
755*33de042dSApple OSS Distributions 					mediaProperty = "boot-uuid-media";
756*33de042dSApple OSS Distributions 					continue;
757*33de042dSApple OSS Distributions 				} else {
758*33de042dSApple OSS Distributions 					uuidStr = NULL;
759*33de042dSApple OSS Distributions 				}
760*33de042dSApple OSS Distributions 			}
761*33de042dSApple OSS Distributions 		} while (false);
762*33de042dSApple OSS Distributions 		OSSafeReleaseNULL(regEntry);
763*33de042dSApple OSS Distributions 	}
764*33de042dSApple OSS Distributions 
765*33de042dSApple OSS Distributions //
766*33de042dSApple OSS Distributions //	See if we have a RAMDisk property in /chosen/memory-map.  If so, make it into a device.
767*33de042dSApple OSS Distributions //	It will become /dev/mdx, where x is 0-f.
768*33de042dSApple OSS Distributions //
769*33de042dSApple OSS Distributions 
770*33de042dSApple OSS Distributions 	if (!didRam) {                                                                                           /* Have we already build this ram disk? */
771*33de042dSApple OSS Distributions 		didRam = 1;                                                                                             /* Remember we did this */
772*33de042dSApple OSS Distributions 		if ((regEntry = IORegistryEntry::fromPath( "/chosen/memory-map", gIODTPlane ))) {        /* Find the map node */
773*33de042dSApple OSS Distributions 			data = (OSData *)regEntry->getProperty("RAMDisk");      /* Find the ram disk, if there */
774*33de042dSApple OSS Distributions 			if (data) {                                                                                      /* We found one */
775*33de042dSApple OSS Distributions 				uintptr_t *ramdParms;
776*33de042dSApple OSS Distributions 				/* BEGIN IGNORE CODESTYLE */
777*33de042dSApple OSS Distributions 				__typed_allocators_ignore_push
778*33de042dSApple OSS Distributions 				ramdParms = (uintptr_t *)data->getBytesNoCopy();        /* Point to the ram disk base and size */
779*33de042dSApple OSS Distributions 				__typed_allocators_ignore_pop
780*33de042dSApple OSS Distributions 				/* END IGNORE CODESTYLE */
781*33de042dSApple OSS Distributions #if __LP64__
782*33de042dSApple OSS Distributions #define MAX_PHYS_RAM    (((uint64_t)UINT_MAX) << 12)
783*33de042dSApple OSS Distributions 				if (ramdParms[1] > MAX_PHYS_RAM) {
784*33de042dSApple OSS Distributions 					panic("ramdisk params");
785*33de042dSApple OSS Distributions 				}
786*33de042dSApple OSS Distributions #endif /* __LP64__ */
787*33de042dSApple OSS Distributions 				(void)mdevadd(-1, ml_static_ptovirt(ramdParms[0]) >> 12, (unsigned int) (ramdParms[1] >> 12), 0);        /* Initialize it and pass back the device number */
788*33de042dSApple OSS Distributions 			}
789*33de042dSApple OSS Distributions 			regEntry->release();                                                            /* Toss the entry */
790*33de042dSApple OSS Distributions 		}
791*33de042dSApple OSS Distributions 	}
792*33de042dSApple OSS Distributions 
793*33de042dSApple OSS Distributions //
794*33de042dSApple OSS Distributions //	Now check if we are trying to root on a memory device
795*33de042dSApple OSS Distributions //
796*33de042dSApple OSS Distributions 
797*33de042dSApple OSS Distributions 	if ((rdBootVar[0] == 'm') && (rdBootVar[1] == 'd') && (rdBootVar[3] == 0)) {
798*33de042dSApple OSS Distributions 		dchar = xchar = rdBootVar[2];                                                   /* Get the actual device */
799*33de042dSApple OSS Distributions 		if ((xchar >= '0') && (xchar <= '9')) {
800*33de042dSApple OSS Distributions 			xchar = xchar - '0';                                    /* If digit, convert */
801*33de042dSApple OSS Distributions 		} else {
802*33de042dSApple OSS Distributions 			xchar = xchar & ~' ';                                                           /* Fold to upper case */
803*33de042dSApple OSS Distributions 			if ((xchar >= 'A') && (xchar <= 'F')) {                          /* Is this a valid digit? */
804*33de042dSApple OSS Distributions 				xchar = (xchar & 0xF) + 9;                                              /* Convert the hex digit */
805*33de042dSApple OSS Distributions 				dchar = dchar | ' ';                                                    /* Fold to lower case */
806*33de042dSApple OSS Distributions 			} else {
807*33de042dSApple OSS Distributions 				xchar = -1;                                                                     /* Show bogus */
808*33de042dSApple OSS Distributions 			}
809*33de042dSApple OSS Distributions 		}
810*33de042dSApple OSS Distributions 		if (xchar >= 0) {                                                                                /* Do we have a valid memory device name? */
811*33de042dSApple OSS Distributions 			OSSafeReleaseNULL(matching);
812*33de042dSApple OSS Distributions 			*root = mdevlookup(xchar);                                                      /* Find the device number */
813*33de042dSApple OSS Distributions 			if (*root >= 0) {                                                                        /* Did we find one? */
814*33de042dSApple OSS Distributions 				rootName[0] = 'm';                                                              /* Build root name */
815*33de042dSApple OSS Distributions 				rootName[1] = 'd';                                                              /* Build root name */
816*33de042dSApple OSS Distributions 				rootName[2] = (char) dchar;                                                     /* Build root name */
817*33de042dSApple OSS Distributions 				rootName[3] = 0;                                                                /* Build root name */
818*33de042dSApple OSS Distributions 				IOLog("BSD root: %s, major %d, minor %d\n", rootName, major(*root), minor(*root));
819*33de042dSApple OSS Distributions 				*oflags = 0;                                                                    /* Show that this is not network */
820*33de042dSApple OSS Distributions 
821*33de042dSApple OSS Distributions #if CONFIG_KDP_INTERACTIVE_DEBUGGING
822*33de042dSApple OSS Distributions 				/* retrieve final ramdisk range and initialize KDP variables */
823*33de042dSApple OSS Distributions 				if (mdevgetrange(xchar, &kdp_core_ramdisk_addr, &kdp_core_ramdisk_size) != 0) {
824*33de042dSApple OSS Distributions 					IOLog("Unable to retrieve range for root memory device %d\n", xchar);
825*33de042dSApple OSS Distributions 					kdp_core_ramdisk_addr = 0;
826*33de042dSApple OSS Distributions 					kdp_core_ramdisk_size = 0;
827*33de042dSApple OSS Distributions 				}
828*33de042dSApple OSS Distributions #endif
829*33de042dSApple OSS Distributions 
830*33de042dSApple OSS Distributions 				goto iofrootx;                                                                  /* Join common exit... */
831*33de042dSApple OSS Distributions 			}
832*33de042dSApple OSS Distributions 			panic("IOFindBSDRoot: specified root memory device, %s, has not been configured", rdBootVar); /* Not there */
833*33de042dSApple OSS Distributions 		}
834*33de042dSApple OSS Distributions 	}
835*33de042dSApple OSS Distributions 
836*33de042dSApple OSS Distributions 	if ((!matching) && rdBootVar[0]) {
837*33de042dSApple OSS Distributions 		// by BSD name
838*33de042dSApple OSS Distributions 		look = rdBootVar;
839*33de042dSApple OSS Distributions 		if (look[0] == '*') {
840*33de042dSApple OSS Distributions 			look++;
841*33de042dSApple OSS Distributions 		}
842*33de042dSApple OSS Distributions 
843*33de042dSApple OSS Distributions 		if (strncmp( look, "en", strlen( "en" )) == 0) {
844*33de042dSApple OSS Distributions 			matching = IONetworkNamePrefixMatching( "en" );
845*33de042dSApple OSS Distributions 			needNetworkKexts = true;
846*33de042dSApple OSS Distributions 		} else if (strncmp( look, "uuid", strlen( "uuid" )) == 0) {
847*33de042dSApple OSS Distributions 			OSDataAllocation<char> uuid( kMaxBootVar, OSAllocateMemory );
848*33de042dSApple OSS Distributions 
849*33de042dSApple OSS Distributions 			if (uuid) {
850*33de042dSApple OSS Distributions 				OSString *uuidString;
851*33de042dSApple OSS Distributions 
852*33de042dSApple OSS Distributions 				if (!PE_parse_boot_argn( "boot-uuid", uuid.data(), kMaxBootVar )) {
853*33de042dSApple OSS Distributions 					panic( "rd=uuid but no boot-uuid=<value> specified" );
854*33de042dSApple OSS Distributions 				}
855*33de042dSApple OSS Distributions 				uuidString = OSString::withCString(uuid.data());
856*33de042dSApple OSS Distributions 				if (uuidString) {
857*33de042dSApple OSS Distributions 					IOService::publishResource( "boot-uuid", uuidString );
858*33de042dSApple OSS Distributions 					uuidString->release();
859*33de042dSApple OSS Distributions 					IOLog("\nWaiting for boot volume with UUID %s\n", uuid.data());
860*33de042dSApple OSS Distributions 					matching = IOUUIDMatching();
861*33de042dSApple OSS Distributions 					mediaProperty = "boot-uuid-media";
862*33de042dSApple OSS Distributions 				}
863*33de042dSApple OSS Distributions 			}
864*33de042dSApple OSS Distributions 		} else {
865*33de042dSApple OSS Distributions 			matching = IOBSDNameMatching( look );
866*33de042dSApple OSS Distributions 		}
867*33de042dSApple OSS Distributions 	}
868*33de042dSApple OSS Distributions 
869*33de042dSApple OSS Distributions 	if (!matching) {
870*33de042dSApple OSS Distributions 		OSString * astring;
871*33de042dSApple OSS Distributions 		// Match any HFS media
872*33de042dSApple OSS Distributions 
873*33de042dSApple OSS Distributions 		matching = IOService::serviceMatching( "IOMedia" );
874*33de042dSApple OSS Distributions 		assert(matching);
875*33de042dSApple OSS Distributions 		astring = OSString::withCStringNoCopy("Apple_HFS");
876*33de042dSApple OSS Distributions 		if (astring) {
877*33de042dSApple OSS Distributions 			matching->setObject("Content", astring);
878*33de042dSApple OSS Distributions 			astring->release();
879*33de042dSApple OSS Distributions 		}
880*33de042dSApple OSS Distributions 	}
881*33de042dSApple OSS Distributions 
882*33de042dSApple OSS Distributions 	if (gIOKitDebug & kIOWaitQuietBeforeRoot) {
883*33de042dSApple OSS Distributions 		IOLog( "Waiting for matching to complete\n" );
884*33de042dSApple OSS Distributions 		IOService::getPlatform()->waitQuiet();
885*33de042dSApple OSS Distributions 	}
886*33de042dSApple OSS Distributions 
887*33de042dSApple OSS Distributions 	if (matching) {
888*33de042dSApple OSS Distributions 		OSSerialize * s = OSSerialize::withCapacity( 5 );
889*33de042dSApple OSS Distributions 
890*33de042dSApple OSS Distributions 		if (matching->serialize( s )) {
891*33de042dSApple OSS Distributions 			IOLog( "Waiting on %s\n", s->text());
892*33de042dSApple OSS Distributions 		}
893*33de042dSApple OSS Distributions 		s->release();
894*33de042dSApple OSS Distributions 	}
895*33de042dSApple OSS Distributions 
896*33de042dSApple OSS Distributions 	char namep[8];
897*33de042dSApple OSS Distributions 	if (needNetworkKexts
898*33de042dSApple OSS Distributions 	    || PE_parse_boot_argn("-s", namep, sizeof(namep))) {
899*33de042dSApple OSS Distributions 		IOService::startDeferredMatches();
900*33de042dSApple OSS Distributions 	}
901*33de042dSApple OSS Distributions 
902*33de042dSApple OSS Distributions 	PE_parse_boot_argn("wdt", &wdt, sizeof(wdt));
903*33de042dSApple OSS Distributions 	do {
904*33de042dSApple OSS Distributions 		t.tv_sec = ROOTDEVICETIMEOUT;
905*33de042dSApple OSS Distributions 		t.tv_nsec = 0;
906*33de042dSApple OSS Distributions 		matching->retain();
907*33de042dSApple OSS Distributions 		service = IOService::waitForService( matching, &t );
908*33de042dSApple OSS Distributions 		if ((-1 != wdt) && (!service || (mountAttempts == 10))) {
909*33de042dSApple OSS Distributions #if !XNU_TARGET_OS_OSX || !defined(__arm64__)
910*33de042dSApple OSS Distributions 			PE_display_icon( 0, "noroot");
911*33de042dSApple OSS Distributions 			IOLog( "Still waiting for root device\n" );
912*33de042dSApple OSS Distributions #endif
913*33de042dSApple OSS Distributions 
914*33de042dSApple OSS Distributions 			if (!debugInfoPrintedOnce) {
915*33de042dSApple OSS Distributions 				debugInfoPrintedOnce = true;
916*33de042dSApple OSS Distributions 				if (gIOKitDebug & kIOLogDTree) {
917*33de042dSApple OSS Distributions 					IOLog("\nDT plane:\n");
918*33de042dSApple OSS Distributions 					IOPrintPlane( gIODTPlane );
919*33de042dSApple OSS Distributions 				}
920*33de042dSApple OSS Distributions 				if (gIOKitDebug & kIOLogServiceTree) {
921*33de042dSApple OSS Distributions 					IOLog("\nService plane:\n");
922*33de042dSApple OSS Distributions 					IOPrintPlane( gIOServicePlane );
923*33de042dSApple OSS Distributions 				}
924*33de042dSApple OSS Distributions 				if (gIOKitDebug & kIOLogMemory) {
925*33de042dSApple OSS Distributions 					IOPrintMemory();
926*33de042dSApple OSS Distributions 				}
927*33de042dSApple OSS Distributions 			}
928*33de042dSApple OSS Distributions 
929*33de042dSApple OSS Distributions #if XNU_TARGET_OS_OSX && defined(__arm64__)
930*33de042dSApple OSS Distributions 			// The disk isn't found - have the user pick from System Recovery.
931*33de042dSApple OSS Distributions 			(void)IOSetRecoveryBoot(BSD_BOOTFAIL_MEDIA_MISSING, NULL, true);
932*33de042dSApple OSS Distributions #elif XNU_TARGET_OS_IOS || XNU_TARGET_OS_XR
933*33de042dSApple OSS Distributions 			panic("Failed to mount root device");
934*33de042dSApple OSS Distributions #endif
935*33de042dSApple OSS Distributions 		}
936*33de042dSApple OSS Distributions 	} while (!service);
937*33de042dSApple OSS Distributions 
938*33de042dSApple OSS Distributions 	OSSafeReleaseNULL(matching);
939*33de042dSApple OSS Distributions 
940*33de042dSApple OSS Distributions 	if (service && mediaProperty) {
941*33de042dSApple OSS Distributions 		service = (IOService *)service->getProperty(mediaProperty);
942*33de042dSApple OSS Distributions 	}
943*33de042dSApple OSS Distributions 
944*33de042dSApple OSS Distributions 	mjr = 0;
945*33de042dSApple OSS Distributions 	mnr = 0;
946*33de042dSApple OSS Distributions 
947*33de042dSApple OSS Distributions 	// If the IOService we matched to is a subclass of IONetworkInterface,
948*33de042dSApple OSS Distributions 	// then make sure it has been registered with BSD and has a BSD name
949*33de042dSApple OSS Distributions 	// assigned.
950*33de042dSApple OSS Distributions 
951*33de042dSApple OSS Distributions 	if (service
952*33de042dSApple OSS Distributions 	    && service->metaCast( "IONetworkInterface" )
953*33de042dSApple OSS Distributions 	    && !IORegisterNetworkInterface( service )) {
954*33de042dSApple OSS Distributions 		service = NULL;
955*33de042dSApple OSS Distributions 	}
956*33de042dSApple OSS Distributions 
957*33de042dSApple OSS Distributions 	if (service) {
958*33de042dSApple OSS Distributions 		len = kMaxPathBuf;
959*33de042dSApple OSS Distributions 		service->getPath( str.data(), &len, gIOServicePlane );
960*33de042dSApple OSS Distributions 		IOLog("Got boot device = %s\n", str.data());
961*33de042dSApple OSS Distributions 
962*33de042dSApple OSS Distributions 		iostr = (OSString *) service->getProperty( kIOBSDNameKey );
963*33de042dSApple OSS Distributions 		if (iostr) {
964*33de042dSApple OSS Distributions 			strlcpy( rootName, iostr->getCStringNoCopy(), rootNameSize );
965*33de042dSApple OSS Distributions 		}
966*33de042dSApple OSS Distributions 		off = (OSNumber *) service->getProperty( kIOBSDMajorKey );
967*33de042dSApple OSS Distributions 		if (off) {
968*33de042dSApple OSS Distributions 			mjr = off->unsigned32BitValue();
969*33de042dSApple OSS Distributions 		}
970*33de042dSApple OSS Distributions 		off = (OSNumber *) service->getProperty( kIOBSDMinorKey );
971*33de042dSApple OSS Distributions 		if (off) {
972*33de042dSApple OSS Distributions 			mnr = off->unsigned32BitValue();
973*33de042dSApple OSS Distributions 		}
974*33de042dSApple OSS Distributions 
975*33de042dSApple OSS Distributions 		if (service->metaCast( "IONetworkInterface" )) {
976*33de042dSApple OSS Distributions 			flags |= 1;
977*33de042dSApple OSS Distributions 		}
978*33de042dSApple OSS Distributions 	} else {
979*33de042dSApple OSS Distributions 		IOLog( "Wait for root failed\n" );
980*33de042dSApple OSS Distributions 		strlcpy( rootName, "en0", rootNameSize );
981*33de042dSApple OSS Distributions 		flags |= 1;
982*33de042dSApple OSS Distributions 	}
983*33de042dSApple OSS Distributions 
984*33de042dSApple OSS Distributions 	IOLog( "BSD root: %s", rootName );
985*33de042dSApple OSS Distributions 	if (mjr) {
986*33de042dSApple OSS Distributions 		IOLog(", major %d, minor %d\n", mjr, mnr );
987*33de042dSApple OSS Distributions 	} else {
988*33de042dSApple OSS Distributions 		IOLog("\n");
989*33de042dSApple OSS Distributions 	}
990*33de042dSApple OSS Distributions 
991*33de042dSApple OSS Distributions 	*root = makedev( mjr, mnr );
992*33de042dSApple OSS Distributions 	*oflags = flags;
993*33de042dSApple OSS Distributions 
994*33de042dSApple OSS Distributions iofrootx:
995*33de042dSApple OSS Distributions 
996*33de042dSApple OSS Distributions 	IOService::setRootMedia(service);
997*33de042dSApple OSS Distributions 
998*33de042dSApple OSS Distributions 	if ((gIOKitDebug & (kIOLogDTree | kIOLogServiceTree | kIOLogMemory)) && !debugInfoPrintedOnce) {
999*33de042dSApple OSS Distributions 		IOService::getPlatform()->waitQuiet();
1000*33de042dSApple OSS Distributions 		if (gIOKitDebug & kIOLogDTree) {
1001*33de042dSApple OSS Distributions 			IOLog("\nDT plane:\n");
1002*33de042dSApple OSS Distributions 			IOPrintPlane( gIODTPlane );
1003*33de042dSApple OSS Distributions 		}
1004*33de042dSApple OSS Distributions 		if (gIOKitDebug & kIOLogServiceTree) {
1005*33de042dSApple OSS Distributions 			IOLog("\nService plane:\n");
1006*33de042dSApple OSS Distributions 			IOPrintPlane( gIOServicePlane );
1007*33de042dSApple OSS Distributions 		}
1008*33de042dSApple OSS Distributions 		if (gIOKitDebug & kIOLogMemory) {
1009*33de042dSApple OSS Distributions 			IOPrintMemory();
1010*33de042dSApple OSS Distributions 		}
1011*33de042dSApple OSS Distributions 	}
1012*33de042dSApple OSS Distributions 
1013*33de042dSApple OSS Distributions 	return kIOReturnSuccess;
1014*33de042dSApple OSS Distributions }
1015*33de042dSApple OSS Distributions 
1016*33de042dSApple OSS Distributions void
IOSetImageBoot(void)1017*33de042dSApple OSS Distributions IOSetImageBoot(void)
1018*33de042dSApple OSS Distributions {
1019*33de042dSApple OSS Distributions 	// this will unhide all IOMedia, without waiting for kernelmanagement to start
1020*33de042dSApple OSS Distributions 	IOService::setRootMedia(NULL);
1021*33de042dSApple OSS Distributions }
1022*33de042dSApple OSS Distributions 
1023*33de042dSApple OSS Distributions bool
IORamDiskBSDRoot(void)1024*33de042dSApple OSS Distributions IORamDiskBSDRoot(void)
1025*33de042dSApple OSS Distributions {
1026*33de042dSApple OSS Distributions 	char rdBootVar[kMaxBootVar];
1027*33de042dSApple OSS Distributions 	if (PE_parse_boot_argn("rd", rdBootVar, kMaxBootVar )
1028*33de042dSApple OSS Distributions 	    || PE_parse_boot_argn("rootdev", rdBootVar, kMaxBootVar )) {
1029*33de042dSApple OSS Distributions 		if ((rdBootVar[0] == 'm') && (rdBootVar[1] == 'd') && (rdBootVar[3] == 0)) {
1030*33de042dSApple OSS Distributions 			return true;
1031*33de042dSApple OSS Distributions 		}
1032*33de042dSApple OSS Distributions 	}
1033*33de042dSApple OSS Distributions 	return false;
1034*33de042dSApple OSS Distributions }
1035*33de042dSApple OSS Distributions 
1036*33de042dSApple OSS Distributions void
IOSecureBSDRoot(const char * rootName)1037*33de042dSApple OSS Distributions IOSecureBSDRoot(const char * rootName)
1038*33de042dSApple OSS Distributions {
1039*33de042dSApple OSS Distributions #if CONFIG_SECURE_BSD_ROOT
1040*33de042dSApple OSS Distributions 	IOReturn         result;
1041*33de042dSApple OSS Distributions 	IOPlatformExpert *pe;
1042*33de042dSApple OSS Distributions 	OSDictionary     *matching;
1043*33de042dSApple OSS Distributions 	const OSSymbol   *functionName = OSSymbol::withCStringNoCopy("SecureRootName");
1044*33de042dSApple OSS Distributions 
1045*33de042dSApple OSS Distributions 	matching = IOService::serviceMatching("IOPlatformExpert");
1046*33de042dSApple OSS Distributions 	assert(matching);
1047*33de042dSApple OSS Distributions 	pe = (IOPlatformExpert *) IOService::waitForMatchingService(matching, 30ULL * kSecondScale);
1048*33de042dSApple OSS Distributions 	matching->release();
1049*33de042dSApple OSS Distributions 	assert(pe);
1050*33de042dSApple OSS Distributions 	// Returns kIOReturnNotPrivileged is the root device is not secure.
1051*33de042dSApple OSS Distributions 	// Returns kIOReturnUnsupported if "SecureRootName" is not implemented.
1052*33de042dSApple OSS Distributions 	result = pe->callPlatformFunction(functionName, false, (void *)rootName, (void *)NULL, (void *)NULL, (void *)NULL);
1053*33de042dSApple OSS Distributions 	functionName->release();
1054*33de042dSApple OSS Distributions 	OSSafeReleaseNULL(pe);
1055*33de042dSApple OSS Distributions 
1056*33de042dSApple OSS Distributions 	if (result == kIOReturnNotPrivileged) {
1057*33de042dSApple OSS Distributions 		mdevremoveall();
1058*33de042dSApple OSS Distributions 	}
1059*33de042dSApple OSS Distributions 
1060*33de042dSApple OSS Distributions #endif  // CONFIG_SECURE_BSD_ROOT
1061*33de042dSApple OSS Distributions }
1062*33de042dSApple OSS Distributions 
1063*33de042dSApple OSS Distributions void *
IOBSDRegistryEntryForDeviceTree(char * path)1064*33de042dSApple OSS Distributions IOBSDRegistryEntryForDeviceTree(char * path)
1065*33de042dSApple OSS Distributions {
1066*33de042dSApple OSS Distributions 	return IORegistryEntry::fromPath(path, gIODTPlane);
1067*33de042dSApple OSS Distributions }
1068*33de042dSApple OSS Distributions 
1069*33de042dSApple OSS Distributions void
IOBSDRegistryEntryRelease(void * entry)1070*33de042dSApple OSS Distributions IOBSDRegistryEntryRelease(void * entry)
1071*33de042dSApple OSS Distributions {
1072*33de042dSApple OSS Distributions 	IORegistryEntry * regEntry = (IORegistryEntry *)entry;
1073*33de042dSApple OSS Distributions 
1074*33de042dSApple OSS Distributions 	if (regEntry) {
1075*33de042dSApple OSS Distributions 		regEntry->release();
1076*33de042dSApple OSS Distributions 	}
1077*33de042dSApple OSS Distributions 	return;
1078*33de042dSApple OSS Distributions }
1079*33de042dSApple OSS Distributions 
1080*33de042dSApple OSS Distributions const void *
IOBSDRegistryEntryGetData(void * entry,char * property_name,int * packet_length)1081*33de042dSApple OSS Distributions IOBSDRegistryEntryGetData(void * entry, char * property_name,
1082*33de042dSApple OSS Distributions     int * packet_length)
1083*33de042dSApple OSS Distributions {
1084*33de042dSApple OSS Distributions 	OSData *            data;
1085*33de042dSApple OSS Distributions 	IORegistryEntry *   regEntry = (IORegistryEntry *)entry;
1086*33de042dSApple OSS Distributions 
1087*33de042dSApple OSS Distributions 	data = (OSData *) regEntry->getProperty(property_name);
1088*33de042dSApple OSS Distributions 	if (data) {
1089*33de042dSApple OSS Distributions 		*packet_length = data->getLength();
1090*33de042dSApple OSS Distributions 		return data->getBytesNoCopy();
1091*33de042dSApple OSS Distributions 	}
1092*33de042dSApple OSS Distributions 	return NULL;
1093*33de042dSApple OSS Distributions }
1094*33de042dSApple OSS Distributions 
1095*33de042dSApple OSS Distributions kern_return_t
IOBSDGetPlatformUUID(uuid_t uuid,mach_timespec_t timeout)1096*33de042dSApple OSS Distributions IOBSDGetPlatformUUID( uuid_t uuid, mach_timespec_t timeout )
1097*33de042dSApple OSS Distributions {
1098*33de042dSApple OSS Distributions 	IOService * resources;
1099*33de042dSApple OSS Distributions 	OSString *  string;
1100*33de042dSApple OSS Distributions 
1101*33de042dSApple OSS Distributions 	resources = IOService::waitForService( IOService::resourceMatching( kIOPlatformUUIDKey ), (timeout.tv_sec || timeout.tv_nsec) ? &timeout : NULL );
1102*33de042dSApple OSS Distributions 	if (resources == NULL) {
1103*33de042dSApple OSS Distributions 		return KERN_OPERATION_TIMED_OUT;
1104*33de042dSApple OSS Distributions 	}
1105*33de042dSApple OSS Distributions 
1106*33de042dSApple OSS Distributions 	string = (OSString *) IOService::getPlatform()->getProvider()->getProperty( kIOPlatformUUIDKey );
1107*33de042dSApple OSS Distributions 	if (string == NULL) {
1108*33de042dSApple OSS Distributions 		return KERN_NOT_SUPPORTED;
1109*33de042dSApple OSS Distributions 	}
1110*33de042dSApple OSS Distributions 
1111*33de042dSApple OSS Distributions 	uuid_parse( string->getCStringNoCopy(), uuid );
1112*33de042dSApple OSS Distributions 
1113*33de042dSApple OSS Distributions 	return KERN_SUCCESS;
1114*33de042dSApple OSS Distributions }
1115*33de042dSApple OSS Distributions } /* extern "C" */
1116*33de042dSApple OSS Distributions 
1117*33de042dSApple OSS Distributions /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1118*33de042dSApple OSS Distributions 
1119*33de042dSApple OSS Distributions #include <sys/conf.h>
1120*33de042dSApple OSS Distributions #include <sys/lock.h>
1121*33de042dSApple OSS Distributions #include <sys/vnode.h>
1122*33de042dSApple OSS Distributions #include <sys/vnode_if.h>
1123*33de042dSApple OSS Distributions #include <sys/vnode_internal.h>
1124*33de042dSApple OSS Distributions #include <sys/fcntl.h>
1125*33de042dSApple OSS Distributions #include <sys/fsctl.h>
1126*33de042dSApple OSS Distributions #include <sys/mount.h>
1127*33de042dSApple OSS Distributions #include <IOKit/IOPolledInterface.h>
1128*33de042dSApple OSS Distributions #include <IOKit/IOBufferMemoryDescriptor.h>
1129*33de042dSApple OSS Distributions 
1130*33de042dSApple OSS Distributions // see HFSIOC_VOLUME_STATUS in APFS/HFS
1131*33de042dSApple OSS Distributions #define HFS_IOCTL_VOLUME_STATUS _IOR('h', 24, u_int32_t)
1132*33de042dSApple OSS Distributions 
1133*33de042dSApple OSS Distributions LCK_GRP_DECLARE(gIOPolledCoreFileGrp, "polled_corefile");
1134*33de042dSApple OSS Distributions LCK_MTX_DECLARE(gIOPolledCoreFileMtx, &gIOPolledCoreFileGrp);
1135*33de042dSApple OSS Distributions 
1136*33de042dSApple OSS Distributions IOPolledFileIOVars * gIOPolledCoreFileVars;
1137*33de042dSApple OSS Distributions kern_return_t gIOPolledCoreFileOpenRet = kIOReturnNotReady;
1138*33de042dSApple OSS Distributions IOPolledCoreFileMode_t gIOPolledCoreFileMode = kIOPolledCoreFileModeNotInitialized;
1139*33de042dSApple OSS Distributions 
1140*33de042dSApple OSS Distributions #if IOPOLLED_COREFILE
1141*33de042dSApple OSS Distributions 
1142*33de042dSApple OSS Distributions #define ONE_MB                  1024ULL * 1024ULL
1143*33de042dSApple OSS Distributions 
1144*33de042dSApple OSS Distributions #if defined(XNU_TARGET_OS_BRIDGE)
1145*33de042dSApple OSS Distributions // On bridgeOS allocate a 150MB corefile and leave 150MB free
1146*33de042dSApple OSS Distributions #define kIOCoreDumpSize         150ULL * ONE_MB
1147*33de042dSApple OSS Distributions #define kIOCoreDumpFreeSize     150ULL * ONE_MB
1148*33de042dSApple OSS Distributions 
1149*33de042dSApple OSS Distributions #elif defined(XNU_TARGET_OS_OSX)
1150*33de042dSApple OSS Distributions 
1151*33de042dSApple OSS Distributions // on macOS devices allocate a corefile sized at 1GB / 32GB of DRAM,
1152*33de042dSApple OSS Distributions // fallback to a 1GB corefile and leave at least 1GB free
1153*33de042dSApple OSS Distributions #define kIOCoreDumpMinSize              1024ULL * ONE_MB
1154*33de042dSApple OSS Distributions #define kIOCoreDumpIncrementalSize      1024ULL * ONE_MB
1155*33de042dSApple OSS Distributions 
1156*33de042dSApple OSS Distributions #define kIOCoreDumpFreeSize     1024ULL * ONE_MB
1157*33de042dSApple OSS Distributions 
1158*33de042dSApple OSS Distributions // on older macOS devices we allocate a 1MB file at boot
1159*33de042dSApple OSS Distributions // to store a panic time stackshot
1160*33de042dSApple OSS Distributions #define kIOStackshotFileSize    ONE_MB
1161*33de042dSApple OSS Distributions 
1162*33de042dSApple OSS Distributions #elif defined(XNU_TARGET_OS_XR)
1163*33de042dSApple OSS Distributions 
1164*33de042dSApple OSS Distributions // XR OS requries larger corefile storage because XNU core can take
1165*33de042dSApple OSS Distributions // up to ~500MB.
1166*33de042dSApple OSS Distributions 
1167*33de042dSApple OSS Distributions #define kIOCoreDumpMinSize      350ULL * ONE_MB
1168*33de042dSApple OSS Distributions #define kIOCoreDumpLargeSize    750ULL * ONE_MB
1169*33de042dSApple OSS Distributions 
1170*33de042dSApple OSS Distributions #define kIOCoreDumpFreeSize     350ULL * ONE_MB
1171*33de042dSApple OSS Distributions 
1172*33de042dSApple OSS Distributions #else /* defined(XNU_TARGET_OS_BRIDGE) */
1173*33de042dSApple OSS Distributions 
1174*33de042dSApple OSS Distributions // On embedded devices with >3GB DRAM we allocate a 500MB corefile
1175*33de042dSApple OSS Distributions // otherwise allocate a 350MB corefile. Leave 350 MB free
1176*33de042dSApple OSS Distributions #define kIOCoreDumpMinSize      350ULL * ONE_MB
1177*33de042dSApple OSS Distributions #define kIOCoreDumpLargeSize    500ULL * ONE_MB
1178*33de042dSApple OSS Distributions 
1179*33de042dSApple OSS Distributions #define kIOCoreDumpFreeSize     350ULL * ONE_MB
1180*33de042dSApple OSS Distributions 
1181*33de042dSApple OSS Distributions #endif /* defined(XNU_TARGET_OS_BRIDGE) */
1182*33de042dSApple OSS Distributions 
1183*33de042dSApple OSS Distributions static IOPolledCoreFileMode_t
GetCoreFileMode()1184*33de042dSApple OSS Distributions GetCoreFileMode()
1185*33de042dSApple OSS Distributions {
1186*33de042dSApple OSS Distributions 	if (on_device_corefile_enabled()) {
1187*33de042dSApple OSS Distributions 		return kIOPolledCoreFileModeCoredump;
1188*33de042dSApple OSS Distributions 	} else if (panic_stackshot_to_disk_enabled()) {
1189*33de042dSApple OSS Distributions 		return kIOPolledCoreFileModeStackshot;
1190*33de042dSApple OSS Distributions 	} else {
1191*33de042dSApple OSS Distributions 		return kIOPolledCoreFileModeDisabled;
1192*33de042dSApple OSS Distributions 	}
1193*33de042dSApple OSS Distributions }
1194*33de042dSApple OSS Distributions 
1195*33de042dSApple OSS Distributions static void
IOResolveCoreFilePath()1196*33de042dSApple OSS Distributions IOResolveCoreFilePath()
1197*33de042dSApple OSS Distributions {
1198*33de042dSApple OSS Distributions 	DTEntry node;
1199*33de042dSApple OSS Distributions 	const char *value = NULL;
1200*33de042dSApple OSS Distributions 	unsigned int size = 0;
1201*33de042dSApple OSS Distributions 
1202*33de042dSApple OSS Distributions 	if (kSuccess != SecureDTLookupEntry(NULL, "/product", &node)) {
1203*33de042dSApple OSS Distributions 		return;
1204*33de042dSApple OSS Distributions 	}
1205*33de042dSApple OSS Distributions 	if (kSuccess != SecureDTGetProperty(node, "kernel-core-dump-location", (void const **) &value, &size)) {
1206*33de042dSApple OSS Distributions 		return;
1207*33de042dSApple OSS Distributions 	}
1208*33de042dSApple OSS Distributions 	if (size == 0) {
1209*33de042dSApple OSS Distributions 		return;
1210*33de042dSApple OSS Distributions 	}
1211*33de042dSApple OSS Distributions 
1212*33de042dSApple OSS Distributions 	// The kdp_corefile_path is allowed to be one of 2 options to working locations.
1213*33de042dSApple OSS Distributions 	// This value is set on EARLY_BOOT since we need to know it before any volumes are mounted. The mount
1214*33de042dSApple OSS Distributions 	// event triggers IOOpenPolledCoreFile() which opens the file. Once we commit to using the path from EDT
1215*33de042dSApple OSS Distributions 	// we can't back out since a different path may reside in a different volume.
1216*33de042dSApple OSS Distributions 	// In case the path from EDT can't be opened, there will not be a kernel core-dump
1217*33de042dSApple OSS Distributions 	if (strlcmp(value, "preboot", size) == 0) {
1218*33de042dSApple OSS Distributions 		kdp_corefile_path = kIOCoreDumpPrebootPath;
1219*33de042dSApple OSS Distributions 	} else if (strlcmp(value, "default", size) != 0) {
1220*33de042dSApple OSS Distributions 		IOLog("corefile path selection in device-tree is not one of the allowed values: %s, Using default %s\n", value, kdp_corefile_path);
1221*33de042dSApple OSS Distributions 		return;
1222*33de042dSApple OSS Distributions 	}
1223*33de042dSApple OSS Distributions 
1224*33de042dSApple OSS Distributions 	IOLog("corefile path selection in device-tree was set to: %s (value: %s)\n", kdp_corefile_path, value);
1225*33de042dSApple OSS Distributions }
1226*33de042dSApple OSS Distributions STARTUP(EARLY_BOOT, STARTUP_RANK_MIDDLE, IOResolveCoreFilePath);
1227*33de042dSApple OSS Distributions 
1228*33de042dSApple OSS Distributions static void
IOCoreFileGetSize(uint64_t * ideal_size,uint64_t * fallback_size,uint64_t * free_space_to_leave,IOPolledCoreFileMode_t mode)1229*33de042dSApple OSS Distributions IOCoreFileGetSize(uint64_t *ideal_size, uint64_t *fallback_size, uint64_t *free_space_to_leave, IOPolledCoreFileMode_t mode)
1230*33de042dSApple OSS Distributions {
1231*33de042dSApple OSS Distributions 	unsigned int requested_corefile_size = 0;
1232*33de042dSApple OSS Distributions 
1233*33de042dSApple OSS Distributions 	*ideal_size = *fallback_size = *free_space_to_leave = 0;
1234*33de042dSApple OSS Distributions 
1235*33de042dSApple OSS Distributions 	// If a custom size was requested, override the ideal and requested sizes
1236*33de042dSApple OSS Distributions 	if (PE_parse_boot_argn("corefile_size_mb", &requested_corefile_size,
1237*33de042dSApple OSS Distributions 	    sizeof(requested_corefile_size))) {
1238*33de042dSApple OSS Distributions 		IOLog("Boot-args specify %d MB kernel corefile\n", requested_corefile_size);
1239*33de042dSApple OSS Distributions 
1240*33de042dSApple OSS Distributions 		*ideal_size = *fallback_size = (requested_corefile_size * ONE_MB);
1241*33de042dSApple OSS Distributions 		return;
1242*33de042dSApple OSS Distributions 	}
1243*33de042dSApple OSS Distributions 
1244*33de042dSApple OSS Distributions 	unsigned int status_flags = 0;
1245*33de042dSApple OSS Distributions 	int error = VNOP_IOCTL(rootvnode, HFS_IOCTL_VOLUME_STATUS, (caddr_t)&status_flags, 0,
1246*33de042dSApple OSS Distributions 	    vfs_context_kernel());
1247*33de042dSApple OSS Distributions 	if (!error) {
1248*33de042dSApple OSS Distributions 		if (status_flags & (VQ_VERYLOWDISK | VQ_LOWDISK | VQ_NEARLOWDISK)) {
1249*33de042dSApple OSS Distributions 			IOLog("Volume is low on space. Not allocating kernel corefile.\n");
1250*33de042dSApple OSS Distributions 			return;
1251*33de042dSApple OSS Distributions 		}
1252*33de042dSApple OSS Distributions 	} else {
1253*33de042dSApple OSS Distributions 		IOLog("Couldn't retrieve volume status. Error %d\n", error);
1254*33de042dSApple OSS Distributions 	}
1255*33de042dSApple OSS Distributions 
1256*33de042dSApple OSS Distributions #if defined(XNU_TARGET_OS_BRIDGE)
1257*33de042dSApple OSS Distributions #pragma unused(mode)
1258*33de042dSApple OSS Distributions 	*ideal_size = *fallback_size = kIOCoreDumpSize;
1259*33de042dSApple OSS Distributions 	*free_space_to_leave = kIOCoreDumpFreeSize;
1260*33de042dSApple OSS Distributions #elif !defined(XNU_TARGET_OS_OSX) /* defined(XNU_TARGET_OS_BRIDGE) */
1261*33de042dSApple OSS Distributions #pragma unused(mode)
1262*33de042dSApple OSS Distributions 	*ideal_size = *fallback_size = kIOCoreDumpMinSize;
1263*33de042dSApple OSS Distributions 
1264*33de042dSApple OSS Distributions 	if (max_mem > (3 * 1024ULL * ONE_MB)) {
1265*33de042dSApple OSS Distributions 		*ideal_size = kIOCoreDumpLargeSize;
1266*33de042dSApple OSS Distributions 	}
1267*33de042dSApple OSS Distributions 
1268*33de042dSApple OSS Distributions 	*free_space_to_leave = kIOCoreDumpFreeSize;
1269*33de042dSApple OSS Distributions #else /* defined(XNU_TARGET_OS_BRIDGE) */
1270*33de042dSApple OSS Distributions 	if (mode == kIOPolledCoreFileModeCoredump) {
1271*33de042dSApple OSS Distributions 		*ideal_size = *fallback_size = kIOCoreDumpMinSize;
1272*33de042dSApple OSS Distributions 		if (kIOCoreDumpIncrementalSize != 0 && max_mem > (32 * 1024ULL * ONE_MB)) {
1273*33de042dSApple OSS Distributions 			*ideal_size = ((ROUNDUP(max_mem, (32 * 1024ULL * ONE_MB)) / (32 * 1024ULL * ONE_MB)) * kIOCoreDumpIncrementalSize);
1274*33de042dSApple OSS Distributions 		}
1275*33de042dSApple OSS Distributions 		*free_space_to_leave = kIOCoreDumpFreeSize;
1276*33de042dSApple OSS Distributions 	} else if (mode == kIOPolledCoreFileModeStackshot) {
1277*33de042dSApple OSS Distributions 		*ideal_size = *fallback_size = *free_space_to_leave = kIOStackshotFileSize;
1278*33de042dSApple OSS Distributions 	}
1279*33de042dSApple OSS Distributions #endif /* defined(XNU_TARGET_OS_BRIDGE) */
1280*33de042dSApple OSS Distributions 
1281*33de042dSApple OSS Distributions #if EXCLAVES_COREDUMP
1282*33de042dSApple OSS Distributions 	*ideal_size += sk_core_size();
1283*33de042dSApple OSS Distributions #endif /* EXCLAVES_COREDUMP */
1284*33de042dSApple OSS Distributions 
1285*33de042dSApple OSS Distributions 	return;
1286*33de042dSApple OSS Distributions }
1287*33de042dSApple OSS Distributions 
1288*33de042dSApple OSS Distributions static IOReturn
IOAccessCoreFileData(void * context,boolean_t write,uint64_t offset,int length,void * buffer)1289*33de042dSApple OSS Distributions IOAccessCoreFileData(void *context, boolean_t write, uint64_t offset, int length, void *buffer)
1290*33de042dSApple OSS Distributions {
1291*33de042dSApple OSS Distributions 	errno_t vnode_error = 0;
1292*33de042dSApple OSS Distributions 	vfs_context_t vfs_context;
1293*33de042dSApple OSS Distributions 	vnode_t vnode_ptr = (vnode_t) context;
1294*33de042dSApple OSS Distributions 
1295*33de042dSApple OSS Distributions 	vfs_context = vfs_context_kernel();
1296*33de042dSApple OSS Distributions 	vnode_error = vn_rdwr(write ? UIO_WRITE : UIO_READ, vnode_ptr, (caddr_t)buffer, length, offset,
1297*33de042dSApple OSS Distributions 	    UIO_SYSSPACE, IO_SWAP_DISPATCH | IO_SYNC | IO_NOCACHE | IO_UNIT, vfs_context_ucred(vfs_context), NULL, vfs_context_proc(vfs_context));
1298*33de042dSApple OSS Distributions 
1299*33de042dSApple OSS Distributions 	if (vnode_error) {
1300*33de042dSApple OSS Distributions 		IOLog("Failed to %s the corefile. Error %d\n", write ? "write to" : "read from", vnode_error);
1301*33de042dSApple OSS Distributions 		return kIOReturnError;
1302*33de042dSApple OSS Distributions 	}
1303*33de042dSApple OSS Distributions 
1304*33de042dSApple OSS Distributions 	return kIOReturnSuccess;
1305*33de042dSApple OSS Distributions }
1306*33de042dSApple OSS Distributions 
1307*33de042dSApple OSS Distributions static void
IOOpenPolledCoreFile(thread_call_param_t __unused,thread_call_param_t corefilename)1308*33de042dSApple OSS Distributions IOOpenPolledCoreFile(thread_call_param_t __unused, thread_call_param_t corefilename)
1309*33de042dSApple OSS Distributions {
1310*33de042dSApple OSS Distributions 	assert(corefilename != NULL);
1311*33de042dSApple OSS Distributions 
1312*33de042dSApple OSS Distributions 	IOReturn err;
1313*33de042dSApple OSS Distributions 	char *filename = (char *) corefilename;
1314*33de042dSApple OSS Distributions 	uint64_t corefile_size_bytes = 0, corefile_fallback_size_bytes = 0, free_space_to_leave_bytes = 0;
1315*33de042dSApple OSS Distributions 	IOPolledCoreFileMode_t mode_to_init = GetCoreFileMode();
1316*33de042dSApple OSS Distributions 
1317*33de042dSApple OSS Distributions 	if (gIOPolledCoreFileVars) {
1318*33de042dSApple OSS Distributions 		return;
1319*33de042dSApple OSS Distributions 	}
1320*33de042dSApple OSS Distributions 	if (!IOPolledInterface::gMetaClass.getInstanceCount()) {
1321*33de042dSApple OSS Distributions 		return;
1322*33de042dSApple OSS Distributions 	}
1323*33de042dSApple OSS Distributions 
1324*33de042dSApple OSS Distributions 	if (gIOPolledCoreFileMode == kIOPolledCoreFileModeUnlinked) {
1325*33de042dSApple OSS Distributions 		return;
1326*33de042dSApple OSS Distributions 	}
1327*33de042dSApple OSS Distributions 
1328*33de042dSApple OSS Distributions 	if (mode_to_init == kIOPolledCoreFileModeDisabled) {
1329*33de042dSApple OSS Distributions 		gIOPolledCoreFileMode = kIOPolledCoreFileModeDisabled;
1330*33de042dSApple OSS Distributions 		return;
1331*33de042dSApple OSS Distributions 	}
1332*33de042dSApple OSS Distributions 
1333*33de042dSApple OSS Distributions 	// We'll overwrite this once we open the file, we update this to mark that we have made
1334*33de042dSApple OSS Distributions 	// it past initialization
1335*33de042dSApple OSS Distributions 	gIOPolledCoreFileMode = kIOPolledCoreFileModeClosed;
1336*33de042dSApple OSS Distributions 
1337*33de042dSApple OSS Distributions 	IOCoreFileGetSize(&corefile_size_bytes, &corefile_fallback_size_bytes, &free_space_to_leave_bytes, mode_to_init);
1338*33de042dSApple OSS Distributions 
1339*33de042dSApple OSS Distributions 	if (corefile_size_bytes == 0 && corefile_fallback_size_bytes == 0) {
1340*33de042dSApple OSS Distributions 		gIOPolledCoreFileMode = kIOPolledCoreFileModeUnlinked;
1341*33de042dSApple OSS Distributions 		return;
1342*33de042dSApple OSS Distributions 	}
1343*33de042dSApple OSS Distributions 
1344*33de042dSApple OSS Distributions 	do {
1345*33de042dSApple OSS Distributions 		// This file reference remains open long-term in case we need to write a core-dump
1346*33de042dSApple OSS Distributions 		err = IOPolledFileOpen(filename, kIOPolledFileCreate, corefile_size_bytes, free_space_to_leave_bytes,
1347*33de042dSApple OSS Distributions 		    NULL, 0, &gIOPolledCoreFileVars, NULL, NULL, NULL);
1348*33de042dSApple OSS Distributions 		if (kIOReturnSuccess == err) {
1349*33de042dSApple OSS Distributions 			break;
1350*33de042dSApple OSS Distributions 		} else if (kIOReturnNoSpace == err) {
1351*33de042dSApple OSS Distributions 			IOLog("Failed to open corefile of size %llu MB (low disk space)\n",
1352*33de042dSApple OSS Distributions 			    (corefile_size_bytes / (1024ULL * 1024ULL)));
1353*33de042dSApple OSS Distributions 			if (corefile_size_bytes == corefile_fallback_size_bytes) {
1354*33de042dSApple OSS Distributions 				gIOPolledCoreFileOpenRet = err;
1355*33de042dSApple OSS Distributions 				return;
1356*33de042dSApple OSS Distributions 			}
1357*33de042dSApple OSS Distributions 		} else {
1358*33de042dSApple OSS Distributions 			IOLog("Failed to open corefile of size %llu MB (returned error 0x%x)\n",
1359*33de042dSApple OSS Distributions 			    (corefile_size_bytes / (1024ULL * 1024ULL)), err);
1360*33de042dSApple OSS Distributions 			gIOPolledCoreFileOpenRet = err;
1361*33de042dSApple OSS Distributions 			return;
1362*33de042dSApple OSS Distributions 		}
1363*33de042dSApple OSS Distributions 
1364*33de042dSApple OSS Distributions 		err = IOPolledFileOpen(filename, kIOPolledFileCreate, corefile_fallback_size_bytes, free_space_to_leave_bytes,
1365*33de042dSApple OSS Distributions 		    NULL, 0, &gIOPolledCoreFileVars, NULL, NULL, NULL);
1366*33de042dSApple OSS Distributions 		if (kIOReturnSuccess != err) {
1367*33de042dSApple OSS Distributions 			IOLog("Failed to open corefile of size %llu MB (returned error 0x%x)\n",
1368*33de042dSApple OSS Distributions 			    (corefile_fallback_size_bytes / (1024ULL * 1024ULL)), err);
1369*33de042dSApple OSS Distributions 			gIOPolledCoreFileOpenRet = err;
1370*33de042dSApple OSS Distributions 			return;
1371*33de042dSApple OSS Distributions 		}
1372*33de042dSApple OSS Distributions 	} while (false);
1373*33de042dSApple OSS Distributions 
1374*33de042dSApple OSS Distributions 	gIOPolledCoreFileOpenRet = IOPolledFilePollersSetup(gIOPolledCoreFileVars, kIOPolledPreflightCoreDumpState);
1375*33de042dSApple OSS Distributions 	if (kIOReturnSuccess != gIOPolledCoreFileOpenRet) {
1376*33de042dSApple OSS Distributions 		IOPolledFileClose(&gIOPolledCoreFileVars, 0, NULL, 0, 0, 0, false);
1377*33de042dSApple OSS Distributions 		IOLog("IOPolledFilePollersSetup for corefile failed with error: 0x%x\n", err);
1378*33de042dSApple OSS Distributions 	} else {
1379*33de042dSApple OSS Distributions 		IOLog("Opened corefile of size %llu MB\n", (corefile_size_bytes / (1024ULL * 1024ULL)));
1380*33de042dSApple OSS Distributions 		gIOPolledCoreFileMode = mode_to_init;
1381*33de042dSApple OSS Distributions 	}
1382*33de042dSApple OSS Distributions 
1383*33de042dSApple OSS Distributions 	// Provide the "polled file available" callback with a temporary way to read from the file
1384*33de042dSApple OSS Distributions 	(void) IOProvideCoreFileAccess(kdp_core_polled_io_polled_file_available, NULL);
1385*33de042dSApple OSS Distributions 
1386*33de042dSApple OSS Distributions 	return;
1387*33de042dSApple OSS Distributions }
1388*33de042dSApple OSS Distributions 
1389*33de042dSApple OSS Distributions kern_return_t
IOProvideCoreFileAccess(IOCoreFileAccessRecipient recipient,void * recipient_context)1390*33de042dSApple OSS Distributions IOProvideCoreFileAccess(IOCoreFileAccessRecipient recipient, void *recipient_context)
1391*33de042dSApple OSS Distributions {
1392*33de042dSApple OSS Distributions 	kern_return_t error = kIOReturnSuccess;
1393*33de042dSApple OSS Distributions 	errno_t vnode_error = 0;
1394*33de042dSApple OSS Distributions 	vfs_context_t vfs_context;
1395*33de042dSApple OSS Distributions 	vnode_t vnode_ptr;
1396*33de042dSApple OSS Distributions 
1397*33de042dSApple OSS Distributions 	if (!recipient) {
1398*33de042dSApple OSS Distributions 		return kIOReturnBadArgument;
1399*33de042dSApple OSS Distributions 	}
1400*33de042dSApple OSS Distributions 
1401*33de042dSApple OSS Distributions 	if (kIOReturnSuccess != gIOPolledCoreFileOpenRet) {
1402*33de042dSApple OSS Distributions 		return kIOReturnNotReady;
1403*33de042dSApple OSS Distributions 	}
1404*33de042dSApple OSS Distributions 
1405*33de042dSApple OSS Distributions 	// Open the kernel corefile
1406*33de042dSApple OSS Distributions 	vfs_context = vfs_context_kernel();
1407*33de042dSApple OSS Distributions 	vnode_error = vnode_open(kdp_corefile_path, (FREAD | FWRITE | O_NOFOLLOW), 0600, 0, &vnode_ptr, vfs_context);
1408*33de042dSApple OSS Distributions 	if (vnode_error) {
1409*33de042dSApple OSS Distributions 		IOLog("Failed to open the corefile. Error %d\n", vnode_error);
1410*33de042dSApple OSS Distributions 		return kIOReturnError;
1411*33de042dSApple OSS Distributions 	}
1412*33de042dSApple OSS Distributions 
1413*33de042dSApple OSS Distributions 	// Call the recipient function
1414*33de042dSApple OSS Distributions 	error = recipient(IOAccessCoreFileData, (void *)vnode_ptr, recipient_context);
1415*33de042dSApple OSS Distributions 
1416*33de042dSApple OSS Distributions 	// Close the kernel corefile
1417*33de042dSApple OSS Distributions 	vnode_close(vnode_ptr, FREAD | FWRITE, vfs_context);
1418*33de042dSApple OSS Distributions 
1419*33de042dSApple OSS Distributions 	return error;
1420*33de042dSApple OSS Distributions }
1421*33de042dSApple OSS Distributions 
1422*33de042dSApple OSS Distributions static void
IOClosePolledCoreFile(void)1423*33de042dSApple OSS Distributions IOClosePolledCoreFile(void)
1424*33de042dSApple OSS Distributions {
1425*33de042dSApple OSS Distributions 	// Notify kdp core that the corefile is no longer available
1426*33de042dSApple OSS Distributions 	(void) kdp_core_polled_io_polled_file_unavailable();
1427*33de042dSApple OSS Distributions 
1428*33de042dSApple OSS Distributions 	gIOPolledCoreFileOpenRet = kIOReturnNotOpen;
1429*33de042dSApple OSS Distributions 	gIOPolledCoreFileMode = kIOPolledCoreFileModeClosed;
1430*33de042dSApple OSS Distributions 	IOPolledFilePollersClose(gIOPolledCoreFileVars, kIOPolledPostflightCoreDumpState);
1431*33de042dSApple OSS Distributions 	IOPolledFileClose(&gIOPolledCoreFileVars, 0, NULL, 0, 0, 0, false);
1432*33de042dSApple OSS Distributions }
1433*33de042dSApple OSS Distributions 
1434*33de042dSApple OSS Distributions static void
IOUnlinkPolledCoreFile(void)1435*33de042dSApple OSS Distributions IOUnlinkPolledCoreFile(void)
1436*33de042dSApple OSS Distributions {
1437*33de042dSApple OSS Distributions 	// Notify kdp core that the corefile is no longer available
1438*33de042dSApple OSS Distributions 	(void) kdp_core_polled_io_polled_file_unavailable();
1439*33de042dSApple OSS Distributions 
1440*33de042dSApple OSS Distributions 	gIOPolledCoreFileOpenRet = kIOReturnNotOpen;
1441*33de042dSApple OSS Distributions 	gIOPolledCoreFileMode = kIOPolledCoreFileModeUnlinked;
1442*33de042dSApple OSS Distributions 	IOPolledFilePollersClose(gIOPolledCoreFileVars, kIOPolledPostflightCoreDumpState);
1443*33de042dSApple OSS Distributions 	IOPolledFileClose(&gIOPolledCoreFileVars, 0, NULL, 0, 0, 0, true);
1444*33de042dSApple OSS Distributions }
1445*33de042dSApple OSS Distributions 
1446*33de042dSApple OSS Distributions #endif /* IOPOLLED_COREFILE */
1447*33de042dSApple OSS Distributions 
1448*33de042dSApple OSS Distributions extern "C" void
IOBSDMountChange(struct mount * mp,uint32_t op)1449*33de042dSApple OSS Distributions IOBSDMountChange(struct mount * mp, uint32_t op)
1450*33de042dSApple OSS Distributions {
1451*33de042dSApple OSS Distributions #if IOPOLLED_COREFILE
1452*33de042dSApple OSS Distributions 	uint64_t flags;
1453*33de042dSApple OSS Distributions 	char path[128];
1454*33de042dSApple OSS Distributions 	int pathLen;
1455*33de042dSApple OSS Distributions 	vnode_t vn;
1456*33de042dSApple OSS Distributions 	int result;
1457*33de042dSApple OSS Distributions 
1458*33de042dSApple OSS Distributions 	lck_mtx_lock(&gIOPolledCoreFileMtx);
1459*33de042dSApple OSS Distributions 
1460*33de042dSApple OSS Distributions 	switch (op) {
1461*33de042dSApple OSS Distributions 	case kIOMountChangeMount:
1462*33de042dSApple OSS Distributions 	case kIOMountChangeDidResize:
1463*33de042dSApple OSS Distributions 
1464*33de042dSApple OSS Distributions 		if (gIOPolledCoreFileVars) {
1465*33de042dSApple OSS Distributions 			break;
1466*33de042dSApple OSS Distributions 		}
1467*33de042dSApple OSS Distributions 		flags = vfs_flags(mp);
1468*33de042dSApple OSS Distributions 		if (MNT_RDONLY & flags) {
1469*33de042dSApple OSS Distributions 			break;
1470*33de042dSApple OSS Distributions 		}
1471*33de042dSApple OSS Distributions 		if (!(MNT_LOCAL & flags)) {
1472*33de042dSApple OSS Distributions 			break;
1473*33de042dSApple OSS Distributions 		}
1474*33de042dSApple OSS Distributions 
1475*33de042dSApple OSS Distributions 		vn = vfs_vnodecovered(mp);
1476*33de042dSApple OSS Distributions 		if (!vn) {
1477*33de042dSApple OSS Distributions 			break;
1478*33de042dSApple OSS Distributions 		}
1479*33de042dSApple OSS Distributions 		pathLen = sizeof(path);
1480*33de042dSApple OSS Distributions 		result = vn_getpath(vn, &path[0], &pathLen);
1481*33de042dSApple OSS Distributions 		vnode_put(vn);
1482*33de042dSApple OSS Distributions 		if (0 != result) {
1483*33de042dSApple OSS Distributions 			break;
1484*33de042dSApple OSS Distributions 		}
1485*33de042dSApple OSS Distributions 		if (!pathLen) {
1486*33de042dSApple OSS Distributions 			break;
1487*33de042dSApple OSS Distributions 		}
1488*33de042dSApple OSS Distributions #if defined(XNU_TARGET_OS_BRIDGE)
1489*33de042dSApple OSS Distributions 		// on bridgeOS systems we put the core in /private/var/internal. We don't
1490*33de042dSApple OSS Distributions 		// want to match with /private/var because /private/var/internal is often mounted
1491*33de042dSApple OSS Distributions 		// over /private/var
1492*33de042dSApple OSS Distributions 		if ((pathLen - 1) < (int) strlen("/private/var/internal")) {
1493*33de042dSApple OSS Distributions 			break;
1494*33de042dSApple OSS Distributions 		}
1495*33de042dSApple OSS Distributions #endif
1496*33de042dSApple OSS Distributions 		// Does this mount point include the kernel core-file?
1497*33de042dSApple OSS Distributions 		if (0 != strncmp(path, kdp_corefile_path, pathLen - 1)) {
1498*33de042dSApple OSS Distributions 			break;
1499*33de042dSApple OSS Distributions 		}
1500*33de042dSApple OSS Distributions 
1501*33de042dSApple OSS Distributions 		thread_call_enter1(corefile_open_call, (void *) kdp_corefile_path);
1502*33de042dSApple OSS Distributions 		break;
1503*33de042dSApple OSS Distributions 
1504*33de042dSApple OSS Distributions 	case kIOMountChangeUnmount:
1505*33de042dSApple OSS Distributions 	case kIOMountChangeWillResize:
1506*33de042dSApple OSS Distributions 		if (gIOPolledCoreFileVars && (mp == kern_file_mount(gIOPolledCoreFileVars->fileRef))) {
1507*33de042dSApple OSS Distributions 			thread_call_cancel_wait(corefile_open_call);
1508*33de042dSApple OSS Distributions 			IOClosePolledCoreFile();
1509*33de042dSApple OSS Distributions 		}
1510*33de042dSApple OSS Distributions 		break;
1511*33de042dSApple OSS Distributions 	}
1512*33de042dSApple OSS Distributions 
1513*33de042dSApple OSS Distributions 	lck_mtx_unlock(&gIOPolledCoreFileMtx);
1514*33de042dSApple OSS Distributions #endif /* IOPOLLED_COREFILE */
1515*33de042dSApple OSS Distributions }
1516*33de042dSApple OSS Distributions 
1517*33de042dSApple OSS Distributions extern "C" void
IOBSDLowSpaceUnlinkKernelCore(void)1518*33de042dSApple OSS Distributions IOBSDLowSpaceUnlinkKernelCore(void)
1519*33de042dSApple OSS Distributions {
1520*33de042dSApple OSS Distributions #if IOPOLLED_COREFILE
1521*33de042dSApple OSS Distributions 	lck_mtx_lock(&gIOPolledCoreFileMtx);
1522*33de042dSApple OSS Distributions 	if (gIOPolledCoreFileVars) {
1523*33de042dSApple OSS Distributions 		thread_call_cancel_wait(corefile_open_call);
1524*33de042dSApple OSS Distributions 		IOUnlinkPolledCoreFile();
1525*33de042dSApple OSS Distributions 	}
1526*33de042dSApple OSS Distributions 	lck_mtx_unlock(&gIOPolledCoreFileMtx);
1527*33de042dSApple OSS Distributions #endif
1528*33de042dSApple OSS Distributions }
1529*33de042dSApple OSS Distributions 
1530*33de042dSApple OSS Distributions /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1531*33de042dSApple OSS Distributions 
1532*33de042dSApple OSS Distributions static char*
copyOSStringAsCString(OSString * string)1533*33de042dSApple OSS Distributions copyOSStringAsCString(OSString *string)
1534*33de042dSApple OSS Distributions {
1535*33de042dSApple OSS Distributions 	size_t string_length = 0;
1536*33de042dSApple OSS Distributions 	char *c_string = NULL;
1537*33de042dSApple OSS Distributions 
1538*33de042dSApple OSS Distributions 	if (string == NULL) {
1539*33de042dSApple OSS Distributions 		return NULL;
1540*33de042dSApple OSS Distributions 	}
1541*33de042dSApple OSS Distributions 	string_length = string->getLength() + 1;
1542*33de042dSApple OSS Distributions 
1543*33de042dSApple OSS Distributions 	/* Allocate kernel data memory for the string */
1544*33de042dSApple OSS Distributions 	c_string = (char*)kalloc_data(string_length, (zalloc_flags_t)(Z_ZERO | Z_WAITOK | Z_NOFAIL));
1545*33de042dSApple OSS Distributions 	assert(c_string != NULL);
1546*33de042dSApple OSS Distributions 
1547*33de042dSApple OSS Distributions 	/* Copy in the string */
1548*33de042dSApple OSS Distributions 	strlcpy(c_string, string->getCStringNoCopy(), string_length);
1549*33de042dSApple OSS Distributions 
1550*33de042dSApple OSS Distributions 	return c_string;
1551*33de042dSApple OSS Distributions }
1552*33de042dSApple OSS Distributions 
1553*33de042dSApple OSS Distributions extern "C" OS_ALWAYS_INLINE boolean_t
IOCurrentTaskHasStringEntitlement(const char * entitlement,const char * value)1554*33de042dSApple OSS Distributions IOCurrentTaskHasStringEntitlement(const char *entitlement, const char *value)
1555*33de042dSApple OSS Distributions {
1556*33de042dSApple OSS Distributions 	return IOTaskHasStringEntitlement(NULL, entitlement, value);
1557*33de042dSApple OSS Distributions }
1558*33de042dSApple OSS Distributions 
1559*33de042dSApple OSS Distributions extern "C" boolean_t
IOTaskHasStringEntitlement(task_t task,const char * entitlement,const char * value)1560*33de042dSApple OSS Distributions IOTaskHasStringEntitlement(task_t task, const char *entitlement, const char *value)
1561*33de042dSApple OSS Distributions {
1562*33de042dSApple OSS Distributions 	if (task == NULL) {
1563*33de042dSApple OSS Distributions 		task = current_task();
1564*33de042dSApple OSS Distributions 	}
1565*33de042dSApple OSS Distributions 
1566*33de042dSApple OSS Distributions 	/* Validate input arguments */
1567*33de042dSApple OSS Distributions 	if (task == kernel_task || entitlement == NULL || value == NULL) {
1568*33de042dSApple OSS Distributions 		return false;
1569*33de042dSApple OSS Distributions 	}
1570*33de042dSApple OSS Distributions 	proc_t proc = (proc_t)get_bsdtask_info(task);
1571*33de042dSApple OSS Distributions 
1572*33de042dSApple OSS Distributions 	kern_return_t ret = amfi->OSEntitlements.queryEntitlementStringWithProc(
1573*33de042dSApple OSS Distributions 		proc,
1574*33de042dSApple OSS Distributions 		entitlement,
1575*33de042dSApple OSS Distributions 		value);
1576*33de042dSApple OSS Distributions 
1577*33de042dSApple OSS Distributions 	if (ret == KERN_SUCCESS) {
1578*33de042dSApple OSS Distributions 		return true;
1579*33de042dSApple OSS Distributions 	}
1580*33de042dSApple OSS Distributions 
1581*33de042dSApple OSS Distributions 	return false;
1582*33de042dSApple OSS Distributions }
1583*33de042dSApple OSS Distributions 
1584*33de042dSApple OSS Distributions extern "C" OS_ALWAYS_INLINE boolean_t
IOCurrentTaskHasEntitlement(const char * entitlement)1585*33de042dSApple OSS Distributions IOCurrentTaskHasEntitlement(const char *entitlement)
1586*33de042dSApple OSS Distributions {
1587*33de042dSApple OSS Distributions 	return IOTaskHasEntitlement(NULL, entitlement);
1588*33de042dSApple OSS Distributions }
1589*33de042dSApple OSS Distributions 
1590*33de042dSApple OSS Distributions extern "C" boolean_t
IOTaskHasEntitlement(task_t task,const char * entitlement)1591*33de042dSApple OSS Distributions IOTaskHasEntitlement(task_t task, const char *entitlement)
1592*33de042dSApple OSS Distributions {
1593*33de042dSApple OSS Distributions 	if (task == NULL) {
1594*33de042dSApple OSS Distributions 		task = current_task();
1595*33de042dSApple OSS Distributions 	}
1596*33de042dSApple OSS Distributions 
1597*33de042dSApple OSS Distributions 	/* Validate input arguments */
1598*33de042dSApple OSS Distributions 	if (task == kernel_task || entitlement == NULL) {
1599*33de042dSApple OSS Distributions 		return false;
1600*33de042dSApple OSS Distributions 	}
1601*33de042dSApple OSS Distributions 	proc_t proc = (proc_t)get_bsdtask_info(task);
1602*33de042dSApple OSS Distributions 
1603*33de042dSApple OSS Distributions 	kern_return_t ret = amfi->OSEntitlements.queryEntitlementBooleanWithProc(
1604*33de042dSApple OSS Distributions 		proc,
1605*33de042dSApple OSS Distributions 		entitlement);
1606*33de042dSApple OSS Distributions 
1607*33de042dSApple OSS Distributions 	if (ret == KERN_SUCCESS) {
1608*33de042dSApple OSS Distributions 		return true;
1609*33de042dSApple OSS Distributions 	}
1610*33de042dSApple OSS Distributions 
1611*33de042dSApple OSS Distributions 	return false;
1612*33de042dSApple OSS Distributions }
1613*33de042dSApple OSS Distributions 
1614*33de042dSApple OSS Distributions extern "C" OS_ALWAYS_INLINE char*
IOCurrentTaskGetEntitlement(const char * entitlement)1615*33de042dSApple OSS Distributions IOCurrentTaskGetEntitlement(const char *entitlement)
1616*33de042dSApple OSS Distributions {
1617*33de042dSApple OSS Distributions 	return IOTaskGetEntitlement(NULL, entitlement);
1618*33de042dSApple OSS Distributions }
1619*33de042dSApple OSS Distributions 
1620*33de042dSApple OSS Distributions extern "C" char*
IOTaskGetEntitlement(task_t task,const char * entitlement)1621*33de042dSApple OSS Distributions IOTaskGetEntitlement(task_t task, const char *entitlement)
1622*33de042dSApple OSS Distributions {
1623*33de042dSApple OSS Distributions 	void *entitlement_object = NULL;
1624*33de042dSApple OSS Distributions 	char *return_value = NULL;
1625*33de042dSApple OSS Distributions 
1626*33de042dSApple OSS Distributions 	if (task == NULL) {
1627*33de042dSApple OSS Distributions 		task = current_task();
1628*33de042dSApple OSS Distributions 	}
1629*33de042dSApple OSS Distributions 
1630*33de042dSApple OSS Distributions 	/* Validate input arguments */
1631*33de042dSApple OSS Distributions 	if (task == kernel_task || entitlement == NULL) {
1632*33de042dSApple OSS Distributions 		return NULL;
1633*33de042dSApple OSS Distributions 	}
1634*33de042dSApple OSS Distributions 	proc_t proc = (proc_t)get_bsdtask_info(task);
1635*33de042dSApple OSS Distributions 
1636*33de042dSApple OSS Distributions 	kern_return_t ret = amfi->OSEntitlements.copyEntitlementAsOSObjectWithProc(
1637*33de042dSApple OSS Distributions 		proc,
1638*33de042dSApple OSS Distributions 		entitlement,
1639*33de042dSApple OSS Distributions 		&entitlement_object);
1640*33de042dSApple OSS Distributions 
1641*33de042dSApple OSS Distributions 	if (ret != KERN_SUCCESS) {
1642*33de042dSApple OSS Distributions 		return NULL;
1643*33de042dSApple OSS Distributions 	}
1644*33de042dSApple OSS Distributions 	assert(entitlement_object != NULL);
1645*33de042dSApple OSS Distributions 
1646*33de042dSApple OSS Distributions 	OSObject *os_object = (OSObject*)entitlement_object;
1647*33de042dSApple OSS Distributions 	OSString *os_string = OSDynamicCast(OSString, os_object);
1648*33de042dSApple OSS Distributions 
1649*33de042dSApple OSS Distributions 	/* Get a C string version of the OSString */
1650*33de042dSApple OSS Distributions 	return_value = copyOSStringAsCString(os_string);
1651*33de042dSApple OSS Distributions 
1652*33de042dSApple OSS Distributions 	/* Free the OSObject which was given to us */
1653*33de042dSApple OSS Distributions 	OSSafeReleaseNULL(os_object);
1654*33de042dSApple OSS Distributions 
1655*33de042dSApple OSS Distributions 	return return_value;
1656*33de042dSApple OSS Distributions }
1657*33de042dSApple OSS Distributions 
1658*33de042dSApple OSS Distributions extern "C" boolean_t
IOVnodeHasEntitlement(vnode_t vnode,int64_t off,const char * entitlement)1659*33de042dSApple OSS Distributions IOVnodeHasEntitlement(vnode_t vnode, int64_t off, const char *entitlement)
1660*33de042dSApple OSS Distributions {
1661*33de042dSApple OSS Distributions 	OSObject * obj;
1662*33de042dSApple OSS Distributions 	off_t offset = (off_t)off;
1663*33de042dSApple OSS Distributions 
1664*33de042dSApple OSS Distributions 	obj = IOUserClient::copyClientEntitlementVnode(vnode, offset, entitlement);
1665*33de042dSApple OSS Distributions 	if (!obj) {
1666*33de042dSApple OSS Distributions 		return false;
1667*33de042dSApple OSS Distributions 	}
1668*33de042dSApple OSS Distributions 	obj->release();
1669*33de042dSApple OSS Distributions 	return obj != kOSBooleanFalse;
1670*33de042dSApple OSS Distributions }
1671*33de042dSApple OSS Distributions 
1672*33de042dSApple OSS Distributions extern "C" char *
IOVnodeGetEntitlement(vnode_t vnode,int64_t off,const char * entitlement)1673*33de042dSApple OSS Distributions IOVnodeGetEntitlement(vnode_t vnode, int64_t off, const char *entitlement)
1674*33de042dSApple OSS Distributions {
1675*33de042dSApple OSS Distributions 	OSObject *obj = NULL;
1676*33de042dSApple OSS Distributions 	OSString *str = NULL;
1677*33de042dSApple OSS Distributions 	size_t len;
1678*33de042dSApple OSS Distributions 	char *value = NULL;
1679*33de042dSApple OSS Distributions 	off_t offset = (off_t)off;
1680*33de042dSApple OSS Distributions 
1681*33de042dSApple OSS Distributions 	obj = IOUserClient::copyClientEntitlementVnode(vnode, offset, entitlement);
1682*33de042dSApple OSS Distributions 	if (obj != NULL) {
1683*33de042dSApple OSS Distributions 		str = OSDynamicCast(OSString, obj);
1684*33de042dSApple OSS Distributions 		if (str != NULL) {
1685*33de042dSApple OSS Distributions 			len = str->getLength() + 1;
1686*33de042dSApple OSS Distributions 			value = (char *)kalloc_data(len, Z_WAITOK);
1687*33de042dSApple OSS Distributions 			strlcpy(value, str->getCStringNoCopy(), len);
1688*33de042dSApple OSS Distributions 		}
1689*33de042dSApple OSS Distributions 		obj->release();
1690*33de042dSApple OSS Distributions 	}
1691*33de042dSApple OSS Distributions 	return value;
1692*33de042dSApple OSS Distributions }
1693