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