2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the
10 * License may not be used to create, or enable the creation or
11 * redistribution of, unlawful or unlicensed copies of an Apple operating
12 * system, or to circumvent, violate, or enable the circumvention or
13 * violation of, any terms of an Apple operating system software license
16 * Please obtain a copy of the License at
17 * http://www.opensource.apple.com/apsl/ and read it before using this
20 * The Original Code and all software distributed under the License are
21 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
22 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
23 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
25 * Please see the License for the specific language governing rights and
26 * limitations under the License.
28 * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
30 #include <libkern/c++/OSContainers.h>
31 #include <IOKit/IOCatalogue.h>
32 #include <IOKit/IOLib.h>
33 #include <libsa/kext.h>
34 #include <libsa/catalogue.h>
37 #include <mach-o/kld.h>
38 #include <libsa/vers_rsrc.h>
39 #include <libsa/stdlib.h>
40 #include <mach/kmod.h>
41 #include <vm/vm_kern.h>
42 #include <mach/kern_return.h>
43 #include <mach-o/fat.h>
44 #include <mach_loader.h>
46 #include "kld_patch.h"
59 kmod_destroy_internal(kmod_t id
);
66 mach_msg_type_number_t
*dataCount
);
68 extern kern_return_t
kmod_retain(kmod_t id
);
69 extern kern_return_t
kmod_release(kmod_t id
);
71 extern void flush_dcache(vm_offset_t addr
, unsigned cnt
, int phys
);
72 extern void invalidate_icache(vm_offset_t addr
, unsigned cnt
, int phys
);
77 #define LOG_DELAY(x) IODelay((x) * 1000000)
78 #define VTYELLOW "\033[33m"
79 #define VTRESET "\033[0m"
86 /*********************************************************************
88 *********************************************************************/
91 const char * bundleid
,
92 OSDictionary
** plist
,
93 unsigned char ** code
,
94 unsigned long * code_size
,
95 bool * caller_owns_code
)
98 OSDictionary
* extensionsDict
; // don't release
99 OSDictionary
* extDict
; // don't release
100 OSDictionary
* extPlist
; // don't release
101 unsigned long code_size_local
;
103 /* Get the dictionary of startup extensions.
104 * This is keyed by module name.
106 extensionsDict
= getStartupExtensions();
107 if (!extensionsDict
) {
108 IOLog("startup extensions dictionary is missing\n");
113 /* Get the requested extension's dictionary entry and its property
114 * list, containing module dependencies.
116 extDict
= OSDynamicCast(OSDictionary
,
117 extensionsDict
->getObject(bundleid
));
120 IOLog("extension \"%s\" cannot be found\n",
127 extPlist
= OSDynamicCast(OSDictionary
, extDict
->getObject("plist"));
129 IOLog("extension \"%s\" has no info dictionary\n",
139 /* If asking for code, the caller must provide a return buffer
142 if (!caller_owns_code
) {
143 IOLog("getKext(): invalid usage (caller_owns_code not provided)\n");
152 *caller_owns_code
= false;
154 *code
= (unsigned char *)kld_file_getaddr(bundleid
,
155 (long *)&code_size_local
);
158 *code_size
= code_size_local
;
161 OSData
* driverCode
= 0; // release only if uncompressing!
163 driverCode
= OSDynamicCast(OSData
, extDict
->getObject("code"));
165 *code
= (unsigned char *)driverCode
->getBytesNoCopy();
167 *code_size
= driverCode
->getLength();
169 } else { // Look for compressed code and uncompress it
170 OSData
* compressedCode
= 0;
171 compressedCode
= OSDynamicCast(OSData
,
172 extDict
->getObject("compressedCode"));
173 if (compressedCode
) {
174 if (!uncompressModule(compressedCode
, &driverCode
)) {
175 IOLog("extension \"%s\": couldn't uncompress code\n",
181 *caller_owns_code
= true;
182 *code
= (unsigned char *)driverCode
->getBytesNoCopy();
184 *code_size
= driverCode
->getLength();
186 driverCode
->release();
198 /*********************************************************************
200 *********************************************************************/
202 bool verifyCompatibility(OSString
* extName
, OSString
* requiredVersion
)
204 OSDictionary
* extPlist
; // don't release
205 OSString
* extVersion
; // don't release
206 OSString
* extCompatVersion
; // don't release
207 VERS_version ext_version
;
208 VERS_version ext_compat_version
;
209 VERS_version required_version
;
211 if (!getKext(extName
->getCStringNoCopy(), &extPlist
, NULL
, NULL
, NULL
)) {
215 extVersion
= OSDynamicCast(OSString
,
216 extPlist
->getObject("CFBundleVersion"));
218 IOLog("verifyCompatibility(): "
219 "Extension \"%s\" has no \"CFBundleVersion\" property.\n",
220 extName
->getCStringNoCopy());
224 extCompatVersion
= OSDynamicCast(OSString
,
225 extPlist
->getObject("OSBundleCompatibleVersion"));
226 if (!extCompatVersion
) {
227 IOLog("verifyCompatibility(): "
228 "Extension \"%s\" has no \"OSBundleCompatibleVersion\" property.\n",
229 extName
->getCStringNoCopy());
233 required_version
= VERS_parse_string(requiredVersion
->getCStringNoCopy());
234 if (required_version
< 0) {
235 IOLog("verifyCompatibility(): "
236 "Can't parse required version \"%s\" of dependency %s.\n",
237 requiredVersion
->getCStringNoCopy(),
238 extName
->getCStringNoCopy());
241 ext_version
= VERS_parse_string(extVersion
->getCStringNoCopy());
242 if (ext_version
< 0) {
243 IOLog("verifyCompatibility(): "
244 "Can't parse version \"%s\" of dependency %s.\n",
245 extVersion
->getCStringNoCopy(),
246 extName
->getCStringNoCopy());
249 ext_compat_version
= VERS_parse_string(extCompatVersion
->getCStringNoCopy());
250 if (ext_compat_version
< 0) {
251 IOLog("verifyCompatibility(): "
252 "Can't parse compatible version \"%s\" of dependency %s.\n",
253 extCompatVersion
->getCStringNoCopy(),
254 extName
->getCStringNoCopy());
258 if (required_version
> ext_version
|| required_version
< ext_compat_version
) {
265 /*********************************************************************
266 *********************************************************************/
268 bool kextIsDependency(const char * kext_name
, char * is_kernel
) {
270 OSDictionary
* extensionsDict
= 0; // don't release
271 OSDictionary
* extDict
= 0; // don't release
272 OSDictionary
* extPlist
= 0; // don't release
273 OSBoolean
* isKernelResourceObj
= 0; // don't release
274 OSData
* driverCode
= 0; // don't release
275 OSData
* compressedCode
= 0; // don't release
281 /* Get the dictionary of startup extensions.
282 * This is keyed by module name.
284 extensionsDict
= getStartupExtensions();
285 if (!extensionsDict
) {
286 IOLog("startup extensions dictionary is missing\n");
291 /* Get the requested extension's dictionary entry and its property
292 * list, containing module dependencies.
294 extDict
= OSDynamicCast(OSDictionary
,
295 extensionsDict
->getObject(kext_name
));
298 IOLog("extension \"%s\" cannot be found\n",
304 extPlist
= OSDynamicCast(OSDictionary
, extDict
->getObject("plist"));
306 IOLog("extension \"%s\" has no info dictionary\n",
312 /* A kext that is a kernel component is still a dependency, as there
313 * are fake kmod entries for them.
315 isKernelResourceObj
= OSDynamicCast(OSBoolean
,
316 extPlist
->getObject("OSKernelResource"));
317 if (isKernelResourceObj
&& isKernelResourceObj
->isTrue()) {
323 driverCode
= OSDynamicCast(OSData
, extDict
->getObject("code"));
324 compressedCode
= OSDynamicCast(OSData
,
325 extDict
->getObject("compressedCode"));
327 if ((driverCode
|| compressedCode
) && is_kernel
&& *is_kernel
) {
331 if (!driverCode
&& !compressedCode
&& !isKernelResourceObj
) {
341 /*********************************************************************
342 *********************************************************************/
344 figureDependenciesForKext(OSDictionary
* kextPlist
,
345 OSDictionary
* dependencies
,
346 OSString
* trueParent
,
347 Boolean skipKernelDependencies
)
350 bool hasDirectKernelDependency
= false;
351 OSString
* kextName
= 0; // don't release
352 OSDictionary
* libraries
= 0; // don't release
353 OSCollectionIterator
* keyIterator
= 0; // must release
354 OSString
* libraryName
= 0; // don't release
356 kextName
= OSDynamicCast(OSString
,
357 kextPlist
->getObject("CFBundleIdentifier"));
359 // XXX: Add log message
364 libraries
= OSDynamicCast(OSDictionary
,
365 kextPlist
->getObject("OSBundleLibraries"));
371 keyIterator
= OSCollectionIterator::withCollection(libraries
);
373 // XXX: Add log message
378 while ( (libraryName
= OSDynamicCast(OSString
,
379 keyIterator
->getNextObject())) ) {
381 OSString
* libraryVersion
= OSDynamicCast(OSString
,
382 libraries
->getObject(libraryName
));
383 if (!libraryVersion
) {
384 // XXX: Add log message
388 if (!verifyCompatibility(libraryName
, libraryVersion
)) {
392 char is_kernel_component
;
394 if (!kextIsDependency(libraryName
->getCStringNoCopy(), &is_kernel_component
))
395 is_kernel_component
= false;
397 if (!skipKernelDependencies
|| !is_kernel_component
) {
398 dependencies
->setObject(libraryName
,
399 trueParent
? trueParent
: kextName
);
401 if (!hasDirectKernelDependency
&& is_kernel_component
) {
402 hasDirectKernelDependency
= true;
406 if (!hasDirectKernelDependency
) {
407 /* a kext without any kernel dependency is assumed dependent on 6.0 */
408 dependencies
->setObject("com.apple.kernel.libkern",
409 trueParent
? trueParent
: kextName
);
410 IOLog("Extension \"%s\" has no kernel dependency.\n",
411 kextName
->getCStringNoCopy());
415 if (keyIterator
) keyIterator
->release();
419 /*********************************************************************
420 *********************************************************************/
422 bool getVersionForKext(OSDictionary
* kextPlist
, char ** version
)
424 OSString
* kextName
= 0; // don't release
425 OSString
* kextVersion
; // don't release
427 kextName
= OSDynamicCast(OSString
,
428 kextPlist
->getObject("CFBundleIdentifier"));
430 // XXX: Add log message
434 kextVersion
= OSDynamicCast(OSString
,
435 kextPlist
->getObject("CFBundleVersion"));
437 IOLog("getVersionForKext(): "
438 "Extension \"%s\" has no \"CFBundleVersion\" property.\n",
439 kextName
->getCStringNoCopy());
444 *version
= (char *)kextVersion
->getCStringNoCopy();
450 /*********************************************************************
451 *********************************************************************/
453 bool add_dependencies_for_kmod(const char * kmod_name
, dgraph_t
* dgraph
)
456 OSDictionary
* kextPlist
= 0; // don't release
457 OSDictionary
* workingDependencies
= 0; // must release
458 OSDictionary
* pendingDependencies
= 0; // must release
459 OSDictionary
* swapDict
= 0; // don't release
460 OSString
* dependentName
= 0; // don't release
461 const char * dependent_name
= 0; // don't free
462 OSString
* libraryName
= 0; // don't release
463 const char * library_name
= 0; // don't free
464 OSCollectionIterator
* dependencyIterator
= 0; // must release
465 unsigned char * code
= 0;
466 unsigned long code_length
= 0;
467 bool code_is_kmem
= false;
468 char * kmod_vers
= 0; // from plist, don't free
469 char is_kernel_component
= false;
470 dgraph_entry_t
* dgraph_entry
= 0; // don't free
471 dgraph_entry_t
* dgraph_dependency
= 0; // don't free
472 unsigned int graph_depth
= 0;
473 bool kext_is_dependency
= true;
475 if (!getKext(kmod_name
, &kextPlist
, &code
, &code_length
,
477 IOLog("can't find extension %s\n", kmod_name
);
482 if (!kextIsDependency(kmod_name
, &is_kernel_component
)) {
483 IOLog("extension %s is not loadable\n", kmod_name
);
488 if (!getVersionForKext(kextPlist
, &kmod_vers
)) {
489 IOLog("can't get version for extension %s\n", kmod_name
);
494 dgraph_entry
= dgraph_add_dependent(dgraph
, kmod_name
,
495 code
, code_length
, code_is_kmem
,
496 kmod_name
, kmod_vers
,
497 0 /* load_address not yet known */, is_kernel_component
);
499 IOLog("can't record %s in dependency graph\n", kmod_name
);
501 // kmem_alloc()ed code is freed in finish: block.
505 // pass ownership of code to kld patcher
508 if (kload_map_entry(dgraph_entry
) != kload_error_none
) {
509 IOLog("can't map %s in preparation for loading\n", kmod_name
);
511 // kmem_alloc()ed code is freed in finish: block.
515 // clear local record of code
518 code_is_kmem
= false;
520 workingDependencies
= OSDictionary::withCapacity(5);
521 if (!workingDependencies
) {
522 IOLog("memory allocation failure\n");
527 pendingDependencies
= OSDictionary::withCapacity(5);
528 if (!pendingDependencies
) {
529 IOLog("memory allocation failure\n");
534 if (!figureDependenciesForKext(kextPlist
, workingDependencies
, NULL
, false)) {
535 IOLog("can't determine immediate dependencies for extension %s\n",
542 while (workingDependencies
->getCount()) {
543 if (graph_depth
> 255) {
544 IOLog("extension dependency graph ridiculously long, indicating a loop\n");
549 if (dependencyIterator
) {
550 dependencyIterator
->release();
551 dependencyIterator
= 0;
554 dependencyIterator
= OSCollectionIterator::withCollection(
555 workingDependencies
);
556 if (!dependencyIterator
) {
557 IOLog("memory allocation failure\n");
562 while ( (libraryName
=
563 OSDynamicCast(OSString
, dependencyIterator
->getNextObject())) ) {
565 library_name
= libraryName
->getCStringNoCopy();
567 dependentName
= OSDynamicCast(OSString
,
568 workingDependencies
->getObject(libraryName
));
570 dependent_name
= dependentName
->getCStringNoCopy();
572 if (!getKext(library_name
, &kextPlist
, NULL
, NULL
, NULL
)) {
573 IOLog("can't find extension %s\n", library_name
);
579 if ((string
= OSDynamicCast(OSString
,
580 kextPlist
->getObject("OSBundleSharedExecutableIdentifier"))))
582 library_name
= string
->getCStringNoCopy();
583 if (!getKext(library_name
, &kextPlist
, NULL
, NULL
, NULL
)) {
584 IOLog("can't find extension %s\n", library_name
);
590 kext_is_dependency
= kextIsDependency(library_name
,
591 &is_kernel_component
);
593 if (!kext_is_dependency
) {
595 /* For binaryless kexts, add a new pending dependency from the
596 * original dependent onto the dependencies of the current,
597 * binaryless, dependency.
599 if (!figureDependenciesForKext(kextPlist
, pendingDependencies
,
600 dependentName
, true)) {
602 IOLog("can't determine immediate dependencies for extension %s\n",
609 dgraph_entry
= dgraph_find_dependent(dgraph
, dependent_name
);
611 IOLog("internal error with dependency graph\n");
617 if (!getVersionForKext(kextPlist
, &kmod_vers
)) {
618 IOLog("can't get version for extension %s\n", library_name
);
623 /* It's okay for code to be zero, as for a pseudokext
624 * representing a kernel component.
626 if (!getKext(library_name
, NULL
/* already got it */,
627 &code
, &code_length
, &code_is_kmem
)) {
628 IOLog("can't find extension %s\n", library_name
);
633 dgraph_dependency
= dgraph_add_dependency(dgraph
, dgraph_entry
,
634 library_name
, code
, code_length
, code_is_kmem
,
635 library_name
, kmod_vers
,
636 0 /* load_address not yet known */, is_kernel_component
);
638 if (!dgraph_dependency
) {
639 IOLog("can't record dependency %s -> %s\n", dependent_name
,
642 // kmem_alloc()ed code is freed in finish: block.
646 // pass ownership of code to kld patcher
648 if (kload_map_entry(dgraph_dependency
) != kload_error_none
) {
649 IOLog("can't map %s in preparation for loading\n", library_name
);
651 // kmem_alloc()ed code is freed in finish: block.
655 // clear local record of code
658 code_is_kmem
= false;
661 /* Now put the library's dependencies onto the pending set.
663 if (!figureDependenciesForKext(kextPlist
, pendingDependencies
,
666 IOLog("can't determine immediate dependencies for extension %s\n",
673 dependencyIterator
->release();
674 dependencyIterator
= 0;
676 workingDependencies
->flushCollection();
677 swapDict
= workingDependencies
;
678 workingDependencies
= pendingDependencies
;
679 pendingDependencies
= swapDict
;
684 if (code
&& code_is_kmem
) {
685 kmem_free(kernel_map
, (unsigned int)code
, code_length
);
687 if (workingDependencies
) workingDependencies
->release();
688 if (pendingDependencies
) pendingDependencies
->release();
689 if (dependencyIterator
) dependencyIterator
->release();
693 /*********************************************************************
694 * This is the function that IOCatalogue calls in order to load a kmod.
695 * It first checks whether the kmod is already loaded. If the kmod
696 * isn't loaded, this function builds a dependency list and calls
697 * load_kmod() repeatedly to guarantee that each dependency is in fact
699 *********************************************************************/
701 kern_return_t
load_kernel_extension(char * kmod_name
)
703 kern_return_t result
= KERN_SUCCESS
;
704 kload_error load_result
= kload_error_none
;
706 bool free_dgraph
= false;
707 kmod_info_t
* kmod_info
;
709 // Put this in for lots of messages about kext loading.
711 kload_set_log_level(kload_log_level_load_details
);
714 /* See if the kmod is already loaded.
716 if ((kmod_info
= kmod_lookupbyname_locked(kmod_name
))) {
717 kfree((vm_offset_t
) kmod_info
, sizeof(kmod_info_t
));
721 if (dgraph_init(&dgraph
) != dgraph_valid
) {
722 IOLog("Can't initialize dependency graph to load %s.\n",
724 result
= KERN_FAILURE
;
729 if (!add_dependencies_for_kmod(kmod_name
, &dgraph
)) {
730 IOLog("Can't determine dependencies for %s.\n",
732 result
= KERN_FAILURE
;
736 dgraph
.root
= dgraph_find_root(&dgraph
);
739 IOLog("Dependency graph to load %s has no root.\n",
741 result
= KERN_FAILURE
;
745 /* A kernel component is built in and need not be loaded.
747 if (dgraph
.root
->is_kernel_component
) {
748 result
= KERN_SUCCESS
;
752 dgraph_establish_load_order(&dgraph
);
754 load_result
= kload_load_dgraph(&dgraph
);
755 if (load_result
!= kload_error_none
&&
756 load_result
!= kload_error_already_loaded
) {
758 IOLog(VTYELLOW
"Failed to load extension %s.\n" VTRESET
, kmod_name
);
760 result
= KERN_FAILURE
;
767 dgraph_free(&dgraph
, 0 /* don't free dgraph itself */);