+
+/*********************************************************************
+*********************************************************************/
+#define BOOTER_KEXT_PREFIX "Driver-"
+
+typedef struct _DeviceTreeBuffer {
+ uint32_t paddr;
+ uint32_t length;
+} _DeviceTreeBuffer;
+
+void
+KLDBootstrap::readBooterExtensions(void)
+{
+ IORegistryEntry * booterMemoryMap = NULL; // must release
+ OSDictionary * propertyDict = NULL; // must release
+ OSCollectionIterator * keyIterator = NULL; // must release
+ OSString * deviceTreeName = NULL; // do not release
+
+ const _DeviceTreeBuffer * deviceTreeBuffer = NULL; // do not free
+ char * booterDataPtr = NULL; // do not free
+ OSData * booterData = NULL; // must release
+
+ OSKext * aKext = NULL; // must release
+
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogProgressLevel |
+ kOSKextLogDirectoryScanFlag | kOSKextLogKextBookkeepingFlag,
+ "Reading startup extensions from booter memory.");
+
+ booterMemoryMap = IORegistryEntry::fromPath( "/chosen/memory-map", gIODTPlane);
+
+ if (!booterMemoryMap) {
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogErrorLevel |
+ kOSKextLogGeneralFlag | kOSKextLogDirectoryScanFlag,
+ "Can't read booter memory map.");
+ goto finish;
+ }
+
+ propertyDict = booterMemoryMap->dictionaryWithProperties();
+ if (!propertyDict) {
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogErrorLevel |
+ kOSKextLogDirectoryScanFlag,
+ "Can't get property dictionary from memory map.");
+ goto finish;
+ }
+
+ keyIterator = OSCollectionIterator::withCollection(propertyDict);
+ if (!keyIterator) {
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogErrorLevel |
+ kOSKextLogGeneralFlag,
+ "Can't allocate iterator for driver images.");
+ goto finish;
+ }
+
+ /* Create dictionary of excluded kexts
+ */
+ OSKext::createExcludeListFromBooterData(propertyDict, keyIterator);
+ keyIterator->reset();
+
+ while ( ( deviceTreeName =
+ OSDynamicCast(OSString, keyIterator->getNextObject() ))) {
+
+ const char * devTreeNameCString = deviceTreeName->getCStringNoCopy();
+ OSData * deviceTreeEntry = OSDynamicCast(OSData,
+ propertyDict->getObject(deviceTreeName));
+
+ /* Clear out the booterData from the prior iteration.
+ */
+ OSSafeReleaseNULL(booterData);
+
+ /* If there is no entry for the name, we can't do much with it. */
+ if (!deviceTreeEntry) {
+ continue;
+ }
+
+ /* Make sure it is a kext */
+ if (strncmp(devTreeNameCString,
+ BOOTER_KEXT_PREFIX,
+ CONST_STRLEN(BOOTER_KEXT_PREFIX))) {
+ continue;
+ }
+
+ deviceTreeBuffer = (const _DeviceTreeBuffer *)
+ deviceTreeEntry->getBytesNoCopy(0, sizeof(deviceTreeBuffer));
+ if (!deviceTreeBuffer) {
+ /* We can't get to the data, so we can't do anything,
+ * not even free it from physical memory (if it's there).
+ */
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogErrorLevel |
+ kOSKextLogDirectoryScanFlag,
+ "Device tree entry %s has NULL pointer.",
+ devTreeNameCString);
+ goto finish; // xxx - continue, panic?
+ }
+
+ booterDataPtr = (char *)ml_static_ptovirt(deviceTreeBuffer->paddr);
+ if (!booterDataPtr) {
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogErrorLevel |
+ kOSKextLogDirectoryScanFlag,
+ "Can't get virtual address for device tree entry %s.",
+ devTreeNameCString);
+ goto finish;
+ }
+
+ /* Wrap the booter data buffer in an OSData and set a dealloc function
+ * so it will take care of the physical memory when freed. Kexts will
+ * retain the booterData for as long as they need it. Remove the entry
+ * from the booter memory map after this is done.
+ */
+ booterData = OSData::withBytesNoCopy(booterDataPtr,
+ deviceTreeBuffer->length);
+ if (!booterData) {
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogErrorLevel |
+ kOSKextLogGeneralFlag,
+ "Error - Can't allocate OSData wrapper for device tree entry %s.",
+ devTreeNameCString);
+ goto finish;
+ }
+ booterData->setDeallocFunction(osdata_phys_free);
+
+ /* Create the kext for the entry, then release it, because the
+ * kext system keeps them around until explicitly removed.
+ * Any creation/registration failures are already logged for us.
+ */
+ OSKext * newKext = OSKext::withBooterData(deviceTreeName, booterData);
+ OSSafeRelease(newKext);
+
+ booterMemoryMap->removeProperty(deviceTreeName);
+
+ } /* while ( (deviceTreeName = OSDynamicCast(OSString, ...) ) ) */
+
+finish:
+
+ OSSafeRelease(booterMemoryMap);
+ OSSafeRelease(propertyDict);
+ OSSafeRelease(keyIterator);
+ OSSafeRelease(booterData);
+ OSSafeRelease(aKext);
+ return;
+}
+
+/*********************************************************************
+*********************************************************************/
+#define COM_APPLE "com.apple."
+
+void
+KLDBootstrap::loadSecurityExtensions(void)
+{
+ OSDictionary * extensionsDict = NULL; // must release
+ OSCollectionIterator * keyIterator = NULL; // must release
+ OSString * bundleID = NULL; // don't release
+ OSKext * theKext = NULL; // don't release
+ OSBoolean * isSecurityKext = NULL; // don't release
+
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogStepLevel |
+ kOSKextLogLoadFlag,
+ "Loading security extensions.");
+
+ extensionsDict = OSKext::copyKexts();
+ if (!extensionsDict) {
+ return;
+ }
+
+ keyIterator = OSCollectionIterator::withCollection(extensionsDict);
+ if (!keyIterator) {
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogErrorLevel |
+ kOSKextLogGeneralFlag,
+ "Failed to allocate iterator for security extensions.");
+ goto finish;
+ }
+
+ while ((bundleID = OSDynamicCast(OSString, keyIterator->getNextObject()))) {
+
+ const char * bundle_id = bundleID->getCStringNoCopy();
+
+ /* Skip extensions whose bundle IDs don't start with "com.apple.".
+ */
+ if (!bundle_id ||
+ (strncmp(bundle_id, COM_APPLE, CONST_STRLEN(COM_APPLE)) != 0)) {
+
+ continue;
+ }
+
+ theKext = OSDynamicCast(OSKext, extensionsDict->getObject(bundleID));
+ if (!theKext) {
+ continue;
+ }
+
+ isSecurityKext = OSDynamicCast(OSBoolean,
+ theKext->getPropertyForHostArch(kAppleSecurityExtensionKey));
+ if (isSecurityKext && isSecurityKext->isTrue()) {
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogStepLevel |
+ kOSKextLogLoadFlag,
+ "Loading security extension %s.", bundleID->getCStringNoCopy());
+ OSKext::loadKextWithIdentifier(bundleID->getCStringNoCopy(),
+ /* allowDefer */ false);
+ }
+ }
+
+finish:
+ OSSafeRelease(keyIterator);
+ OSSafeRelease(extensionsDict);
+
+ return;
+}
+
+/*********************************************************************
+* We used to require that all listed kernel components load, but
+* nowadays we can get them from userland so we only try to load the
+* ones we have. If an error occurs later, such is life.
+*
+* Note that we look the kexts up first, so we can avoid spurious
+* (in this context, anyhow) log messages about kexts not being found.
+*
+* xxx - do we even need to do this any more? Check if the kernel
+* xxx - compoonents just load in the regular paths
+*********************************************************************/
+OSReturn
+KLDBootstrap::loadKernelComponentKexts(void)
+{
+ OSReturn result = kOSReturnSuccess; // optimistic
+ OSKext * theKext = NULL; // must release
+ const char ** kextIDPtr = NULL; // do not release
+
+ for (kextIDPtr = &sKernelComponentNames[0]; *kextIDPtr; kextIDPtr++) {
+
+ OSSafeReleaseNULL(theKext);
+ theKext = OSKext::lookupKextWithIdentifier(*kextIDPtr);
+
+ if (theKext) {
+ if (kOSReturnSuccess != OSKext::loadKextWithIdentifier(
+ *kextIDPtr, /* allowDefer */ false)) {
+
+ // xxx - check KextBookkeeping, might be redundant
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogErrorLevel |
+ kOSKextLogDirectoryScanFlag | kOSKextLogKextBookkeepingFlag,
+ "Failed to initialize kernel component %s.", *kextIDPtr);
+ result = kOSReturnError;
+ }
+ }
+ }
+
+ OSSafeRelease(theKext);
+ return result;
+}
+
+/*********************************************************************
+* Ensure that Kernel External Components are loaded early in boot,
+* before other kext personalities get sent to the IOCatalogue. These
+* kexts are treated specially because they may provide the implementation
+* for kernel-vended KPI, so they must register themselves before
+* general purpose IOKit probing begins.
+*********************************************************************/
+
+#define COM_APPLE_KEC "com.apple.kec."
+
+void
+KLDBootstrap::loadKernelExternalComponents(void)
+{
+ OSDictionary * extensionsDict = NULL; // must release
+ OSCollectionIterator * keyIterator = NULL; // must release
+ OSString * bundleID = NULL; // don't release
+ OSKext * theKext = NULL; // don't release
+ OSBoolean * isKernelExternalComponent = NULL; // don't release
+
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogStepLevel |
+ kOSKextLogLoadFlag,
+ "Loading Kernel External Components.");
+
+ extensionsDict = OSKext::copyKexts();
+ if (!extensionsDict) {
+ return;
+ }
+
+ keyIterator = OSCollectionIterator::withCollection(extensionsDict);
+ if (!keyIterator) {
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogErrorLevel |
+ kOSKextLogGeneralFlag,
+ "Failed to allocate iterator for Kernel External Components.");
+ goto finish;
+ }
+
+ while ((bundleID = OSDynamicCast(OSString, keyIterator->getNextObject()))) {
+
+ const char * bundle_id = bundleID->getCStringNoCopy();
+
+ /* Skip extensions whose bundle IDs don't start with "com.apple.kec.".
+ */
+ if (!bundle_id ||
+ (strncmp(bundle_id, COM_APPLE_KEC, CONST_STRLEN(COM_APPLE_KEC)) != 0)) {
+
+ continue;
+ }
+
+ theKext = OSDynamicCast(OSKext, extensionsDict->getObject(bundleID));
+ if (!theKext) {
+ continue;
+ }
+
+ isKernelExternalComponent = OSDynamicCast(OSBoolean,
+ theKext->getPropertyForHostArch(kAppleKernelExternalComponentKey));
+ if (isKernelExternalComponent && isKernelExternalComponent->isTrue()) {
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogStepLevel |
+ kOSKextLogLoadFlag,
+ "Loading kernel external component %s.", bundleID->getCStringNoCopy());
+ OSKext::loadKextWithIdentifier(bundleID->getCStringNoCopy(),
+ /* allowDefer */ false);
+ }
+ }
+
+finish:
+ OSSafeRelease(keyIterator);
+ OSSafeRelease(extensionsDict);
+
+ return;
+}
+
+/*********************************************************************
+ *********************************************************************/
+void
+KLDBootstrap::readBuiltinPersonalities(void)
+{
+ OSObject * parsedXML = NULL; // must release
+ OSArray * builtinExtensions = NULL; // do not release
+ OSArray * allPersonalities = NULL; // must release
+ OSString * errorString = NULL; // must release
+ kernel_section_t * infosect = NULL; // do not free
+ OSCollectionIterator * personalitiesIterator = NULL; // must release
+ unsigned int count, i;
+
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogStepLevel |
+ kOSKextLogLoadFlag,
+ "Reading built-in kernel personalities for I/O Kit drivers.");
+
+ /* Look in the __BUILTIN __info segment for an array of Info.plist
+ * entries. For each one, extract the personalities dictionary, add
+ * it to our array, then push them all (without matching) to
+ * the IOCatalogue. This can be used to augment the personalities
+ * in gIOKernelConfigTables, especially when linking entire kexts into
+ * the mach_kernel image.
+ */
+ infosect = getsectbyname("__BUILTIN", "__info");
+ if (!infosect) {
+ // this isn't fatal
+ goto finish;
+ }
+
+ parsedXML = OSUnserializeXML((const char *) (uintptr_t)infosect->addr,
+ &errorString);
+ if (parsedXML) {
+ builtinExtensions = OSDynamicCast(OSArray, parsedXML);
+ }
+ if (!builtinExtensions) {
+ const char * errorCString = "(unknown error)";
+
+ if (errorString && errorString->getCStringNoCopy()) {
+ errorCString = errorString->getCStringNoCopy();
+ } else if (parsedXML) {
+ errorCString = "not an array";
+ }
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogErrorLevel |
+ kOSKextLogLoadFlag,
+ "Error unserializing built-in personalities: %s.", errorCString);
+ goto finish;
+ }
+
+ // estimate 3 personalities per Info.plist/kext
+ count = builtinExtensions->getCount();
+ allPersonalities = OSArray::withCapacity(count * 3);
+
+ for (i = 0; i < count; i++) {
+ OSDictionary * infoDict = NULL; // do not release
+ OSString * moduleName = NULL; // do not release
+ OSDictionary * personalities; // do not release
+ OSString * personalityName; // do not release
+
+ OSSafeReleaseNULL(personalitiesIterator);
+
+ infoDict = OSDynamicCast(OSDictionary,
+ builtinExtensions->getObject(i));
+ if (!infoDict) {
+ continue;
+ }
+
+ moduleName = OSDynamicCast(OSString,
+ infoDict->getObject(kCFBundleIdentifierKey));
+ if (!moduleName) {
+ continue;
+ }
+
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogStepLevel |
+ kOSKextLogLoadFlag,
+ "Adding personalities for built-in driver %s:",
+ moduleName->getCStringNoCopy());
+
+ personalities = OSDynamicCast(OSDictionary,
+ infoDict->getObject("IOKitPersonalities"));
+ if (!personalities) {
+ continue;
+ }
+
+ personalitiesIterator = OSCollectionIterator::withCollection(personalities);
+ if (!personalitiesIterator) {
+ continue; // xxx - well really, what can we do? should we panic?
+ }
+
+ while ((personalityName = OSDynamicCast(OSString,
+ personalitiesIterator->getNextObject()))) {
+
+ OSDictionary * personality = OSDynamicCast(OSDictionary,
+ personalities->getObject(personalityName));
+
+ OSKextLog(/* kext */ NULL,
+ kOSKextLogDetailLevel |
+ kOSKextLogLoadFlag,
+ "Adding built-in driver personality %s.",
+ personalityName->getCStringNoCopy());
+
+ if (personality && !personality->getObject(kCFBundleIdentifierKey)) {
+ personality->setObject(kCFBundleIdentifierKey, moduleName);
+ }
+ allPersonalities->setObject(personality);
+ }
+ }
+
+ gIOCatalogue->addDrivers(allPersonalities, false);
+
+finish:
+ OSSafeRelease(parsedXML);
+ OSSafeRelease(allPersonalities);
+ OSSafeRelease(errorString);
+ OSSafeRelease(personalitiesIterator);
+ return;
+}
+
+#if PRAGMA_MARK
+#pragma mark Bootstrap Functions
+#endif
+/*********************************************************************
+* Bootstrap Functions
+*********************************************************************/
+static void bootstrapRecordStartupExtensions(void)
+{
+ sBootstrapObject.readStartupExtensions();
+ return;
+}
+
+static void bootstrapLoadSecurityExtensions(void)
+{
+ sBootstrapObject.loadSecurityExtensions();
+ return;
+}
+