Loading...
libkern/c++/OSMetaClass.cpp xnu-123.5 xnu-792.13.8
--- xnu/xnu-123.5/libkern/c++/OSMetaClass.cpp
+++ xnu/xnu-792.13.8/libkern/c++/OSMetaClass.cpp
@@ -1,28 +1,35 @@
 /*
  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
- * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
- * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
- * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ * This file contains Original Code and/or Modifications of Original Code 
+ * as defined in and that are subject to the Apple Public Source License 
+ * Version 2.0 (the 'License'). You may not use this file except in 
+ * compliance with the License.  The rights granted to you under the 
+ * License may not be used to create, or enable the creation or 
+ * redistribution of, unlawful or unlicensed copies of an Apple operating 
+ * system, or to circumvent, violate, or enable the circumvention or 
+ * violation of, any terms of an Apple operating system software license 
+ * agreement.
+ *
+ * Please obtain a copy of the License at 
+ * http://www.opensource.apple.com/apsl/ and read it before using this 
+ * file.
+ *
+ * The Original Code and all software distributed under the License are 
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
+ * Please see the License for the specific language governing rights and 
+ * limitations under the License.
+ *
+ * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  */
 /* OSMetaClass.cpp created by gvdl on Fri 1998-11-17 */
 
 #include <string.h>
-#include <sys/systm.h>
 
 #include <libkern/OSReturn.h>
 
@@ -39,13 +46,17 @@
 #include <libkern/c++/OSLib.h>
 #include <libkern/OSAtomic.h>
 
+#include <IOKit/pwr_mgt/RootDomain.h>
+#include <IOKit/IOMessage.h>
+
 __BEGIN_DECLS
 
+#include <sys/systm.h>
 #include <mach/mach_types.h>
-#include <mach/etap_events.h>
 #include <kern/lock.h>
 #include <kern/clock.h>
 #include <kern/thread_call.h>
+#include <kern/host.h>
 #include <mach/kmod.h>
 #include <mach/mach_interface.h>
 
@@ -68,9 +79,9 @@
 
 static const int kClassCapacityIncrement = 40;
 static const int kKModCapacityIncrement = 10;
-static OSDictionary *sAllClassesDict, *sKModClassesDict;
-
-static mutex_t *loadLock;
+static OSDictionary *sAllClassesDict, *sKModClassesDict, *sSortedByClassesDict;
+
+static mutex_t *loadLock = 0;
 static struct StalledData {
     const char *kmodName;
     OSReturn result;
@@ -80,16 +91,22 @@
 } *sStalled;
 
 static unsigned int sConsiderUnloadDelay = 60;	/* secs */
+static bool unloadsEnabled = true;  // set to false when system going to sleep
+static thread_call_t unloadCallout = 0;
 
 static const char OSMetaClassBasePanicMsg[] =
     "OSMetaClassBase::_RESERVEDOSMetaClassBase%d called\n";
 
+#if SLOT_USED
 void OSMetaClassBase::_RESERVEDOSMetaClassBase0()
     { panic(OSMetaClassBasePanicMsg, 0); }
 void OSMetaClassBase::_RESERVEDOSMetaClassBase1()
     { panic(OSMetaClassBasePanicMsg, 1); }
 void OSMetaClassBase::_RESERVEDOSMetaClassBase2()
     { panic(OSMetaClassBasePanicMsg, 2); }
+#endif /* SLOT_USED */
+
+// As these slots are used move them up inside the #if above
 void OSMetaClassBase::_RESERVEDOSMetaClassBase3()
     { panic(OSMetaClassBasePanicMsg, 3); }
 void OSMetaClassBase::_RESERVEDOSMetaClassBase4()
@@ -98,6 +115,28 @@
     { panic(OSMetaClassBasePanicMsg, 5); }
 void OSMetaClassBase::_RESERVEDOSMetaClassBase6()
     { panic(OSMetaClassBasePanicMsg, 6); }
+    
+/*
+ * These used to be inline in the header but gcc didn't believe us
+ * Now we MUST pull the inline out at least until the compiler is
+ * repaired.
+ */
+// Helper inlines for runtime type preprocessor macros
+OSMetaClassBase *OSMetaClassBase::
+safeMetaCast(const OSMetaClassBase *me, const OSMetaClass *toType)
+    { return (me)? me->metaCast(toType) : 0; }
+
+bool OSMetaClassBase::
+checkTypeInst(const OSMetaClassBase *inst, const OSMetaClassBase *typeinst)
+{
+    const OSMetaClass *toType = OSTypeIDInst(typeinst);
+    return typeinst && inst && (0 != inst->metaCast(toType));
+}
+
+
+// If you need this slot you had better setup an IOCTL style interface.
+// 'Cause the whole kernel world depends on OSMetaClassBase and YOU
+// CANT change the VTABLE size ever.
 void OSMetaClassBase::_RESERVEDOSMetaClassBase7()
     { panic(OSMetaClassBasePanicMsg, 7); }
 
@@ -141,7 +180,7 @@
 
 OSMetaClassBase *OSMetaClassBase::metaCast(const char *toMetaCStr) const
 {
-    const OSSymbol *tempSymb = OSSymbol::withCStringNoCopy(toMetaCStr);
+    const OSSymbol *tempSymb = OSSymbol::withCString(toMetaCStr);
     OSMetaClassBase *ret = 0;
     if (tempSymb) {
         ret = metaCast(tempSymb);
@@ -246,7 +285,7 @@
 
 	    sStalled->capacity += kKModCapacityIncrement;
 	    memmove(sStalled->classes, oldStalled, oldSize);
-	    kfree((vm_offset_t)oldStalled, oldSize);
+	    kfree(oldStalled, oldSize);
 	    ACCUMSIZE(newSize - oldSize);
 	}
 
@@ -259,8 +298,10 @@
     do {
 	OSCollectionIterator *iter;
 
-	if (sAllClassesDict)
+	if (sAllClassesDict) {
 	    sAllClassesDict->removeObject(className);
+	    className->release();
+	}
 
 	iter = OSCollectionIterator::withCollection(sKModClassesDict);
 	if (!iter)
@@ -292,16 +333,16 @@
 		memmove(&sStalled->classes[i], &sStalled->classes[i+1],
 			    (sStalled->count - i) * sizeof(OSMetaClass *));
 	}
-	return;
-    }
-}
-
-// Don't do anything as these classes must be statically allocated
+    }
+}
+
 void *OSMetaClass::operator new(size_t size) { return 0; }
-void OSMetaClass::operator delete(void *mem, size_t size) { }
 void OSMetaClass::retain() const { }
 void OSMetaClass::release() const { }
-void OSMetaClass::release(int when) const { };
+void OSMetaClass::release(int when) const { }
+void OSMetaClass::taggedRetain(const void *tag) const { }
+void OSMetaClass::taggedRelease(const void *tag) const { }
+void OSMetaClass::taggedRelease(const void *tag, const int when) const { }
 int  OSMetaClass::getRetainCount() const { return 0; }
 
 const char *OSMetaClass::getClassName() const
@@ -317,18 +358,18 @@
 void *OSMetaClass::preModLoad(const char *kmodName)
 {
     if (!loadLock) {
-        loadLock = mutex_alloc(ETAP_IO_AHA);
-	_mutex_lock(loadLock);
+        loadLock = mutex_alloc(0);
+	mutex_lock(loadLock);
     }
     else
-	_mutex_lock(loadLock);
+	mutex_lock(loadLock);
 
     sStalled = (StalledData *) kalloc(sizeof(*sStalled));
     if (sStalled) {
 	sStalled->classes  = (OSMetaClass **)
 			kalloc(kKModCapacityIncrement * sizeof(OSMetaClass *));
 	if (!sStalled->classes) {
-	    kfree((vm_offset_t) sStalled, sizeof(*sStalled));
+	    kfree(sStalled, sizeof(*sStalled));
 	    return 0;
 	}
 	ACCUMSIZE((kKModCapacityIncrement * sizeof(OSMetaClass *)) + sizeof(*sStalled));
@@ -353,6 +394,7 @@
 {
     OSReturn result = kOSReturnSuccess;
     OSSet *kmodSet = 0;
+    OSSymbol *myname = 0;
 
     if (!sStalled || loadHandle != sStalled) {
 	logError(kOSMetaClassInternal);
@@ -369,7 +411,8 @@
     case kMakingDictionaries:
 	sKModClassesDict = OSDictionary::withCapacity(kKModCapacityIncrement);
 	sAllClassesDict = OSDictionary::withCapacity(kClassCapacityIncrement);
-	if (!sAllClassesDict || !sKModClassesDict) {
+	sSortedByClassesDict = OSDictionary::withCapacity(kClassCapacityIncrement);
+	if (!sAllClassesDict || !sKModClassesDict || !sSortedByClassesDict) {
 	    result = kOSMetaClassNoDicts;
 	    break;
 	}
@@ -378,6 +421,7 @@
     case kCompletedBootstrap:
     {
         unsigned int i;
+        myname = (OSSymbol *)OSSymbol::withCStringNoCopy(sStalled->kmodName);
 
 	if (!sStalled->count)
 	    break;	// Nothing to do so just get out
@@ -401,19 +445,20 @@
 	    break;
 	}
 
-	if (!sKModClassesDict->setObject(sStalled->kmodName, kmodSet)) {
+	if (!sKModClassesDict->setObject(myname, kmodSet)) {
 	    result = kOSMetaClassNoInsKModSet;
 	    break;
 	}
 
 	// Second pass symbolling strings and inserting classes in dictionary
-	for (unsigned int i = 0; i < sStalled->count; i++) {
+	for (i = 0; i < sStalled->count; i++) {
 	    OSMetaClass *me = sStalled->classes[i];
 	    me->className = 
                 OSSymbol::withCStringNoCopy((const char *) me->className);
 
 	    sAllClassesDict->setObject(me->className, me);
 	    kmodSet->setObject(me);
+	    sSortedByClassesDict->setObject((const OSSymbol *)me, myname);
 	}
 	sBootstrapState = kCompletedBootstrap;
 	break;
@@ -427,12 +472,15 @@
     if (kmodSet)
 	kmodSet->release();
 
+	if (myname)
+	myname->release();
+
     if (sStalled) {
 	ACCUMSIZE(-(sStalled->capacity * sizeof(OSMetaClass *)
 		     + sizeof(*sStalled)));
-	kfree((vm_offset_t) sStalled->classes,
+	kfree(sStalled->classes,
 	      sStalled->capacity * sizeof(OSMetaClass *));
-	kfree((vm_offset_t) sStalled, sizeof(*sStalled));
+	kfree(sStalled, sizeof(*sStalled));
 	sStalled = 0;
     }
 
@@ -463,11 +511,11 @@
     bool result = false;
 
     if (!loadLock) {
-        loadLock = mutex_alloc(ETAP_IO_AHA);
-	_mutex_lock(loadLock);
+        loadLock = mutex_alloc(0);
+	mutex_lock(loadLock);
     }
     else
-	_mutex_lock(loadLock);
+	mutex_lock(loadLock);
 
     do {
 	OSSet *kmodClasses;
@@ -523,6 +571,36 @@
     iter->release();
 }
 
+
+extern "C" {
+
+IOReturn OSMetaClassSystemSleepOrWake(UInt32 messageType)
+{
+    mutex_lock(loadLock);
+
+   /* If the system is going to sleep, cancel the reaper thread timer
+    * and mark unloads disabled in case it just fired but hasn't
+    * taken the lock yet. If we are coming back from sleep, just
+    * set unloads enabled; IOService's normal operation will cause
+    * unloads to be considered soon enough.
+    */
+    if (messageType == kIOMessageSystemWillSleep) {
+        if (unloadCallout) {
+            thread_call_cancel(unloadCallout);
+        }
+        unloadsEnabled = false;
+    } else if (messageType == kIOMessageSystemHasPoweredOn) {
+        unloadsEnabled = true;
+    }
+    mutex_unlock(loadLock);
+
+    return kIOReturnSuccess;
+}
+
+};
+
+extern "C" kern_return_t kmod_unload_cache(void);
+
 static void _OSMetaClassConsiderUnloads(thread_call_param_t p0,
                                         thread_call_param_t p1)
 {
@@ -531,11 +609,16 @@
     OSCollectionIterator *kmods;
     OSCollectionIterator *classes;
     OSMetaClass *checkClass;
-    kmod_info_t *ki;
+    kmod_info_t *ki = 0;
     kern_return_t ret;
     bool didUnload;
 
-    _mutex_lock(loadLock);
+    mutex_lock(loadLock);
+
+    if (!unloadsEnabled) {
+        mutex_unlock(loadLock);
+        return;
+    }
 
     do {
 
@@ -546,12 +629,18 @@
         didUnload = false;
         while ( (kmodName = (OSSymbol *) kmods->getNextObject()) ) {
 
-            ki = kmod_lookupbyname((char *)kmodName->getCStringNoCopy());
+            if (ki) {
+                kfree(ki, sizeof(kmod_info_t));
+                ki = 0;
+            }
+
+            ki = kmod_lookupbyname_locked((char *)kmodName->getCStringNoCopy());
             if (!ki)
                 continue;
 
-            if (ki->reference_count)
-                continue;
+            if (ki->reference_count) {
+                 continue;
+            }
 
             kmodClasses = OSDynamicCast(OSSet,
                                 sKModClassesDict->getObject(kmodName));
@@ -570,21 +659,22 @@
                 didUnload = true;
             }
 
-        } while (false);
+        }
 
         kmods->release();
 
     } while (didUnload);
 
     mutex_unlock(loadLock);
+
+    kmod_unload_cache();
 }
 
 void OSMetaClass::considerUnloads()
 {
-    static thread_call_t unloadCallout;
     AbsoluteTime when;
 
-    _mutex_lock(loadLock);
+    mutex_lock(loadLock);
 
     if (!unloadCallout)
         unloadCallout = thread_call_allocate(&_OSMetaClassConsiderUnloads, 0);
@@ -630,7 +720,7 @@
 OSObject *OSMetaClass::allocClassWithName(const OSSymbol *name)
 {
     OSObject * result;
-    _mutex_lock(loadLock);
+    mutex_lock(loadLock);
 
     const OSMetaClass * const meta = getMetaClassWithName(name);
 
@@ -665,7 +755,7 @@
 checkMetaCastWithName(const OSSymbol *name, const OSMetaClassBase *in)
 {
     OSMetaClassBase * result;
-    _mutex_lock(loadLock);
+    mutex_lock(loadLock);
     const OSMetaClass * const meta = getMetaClassWithName(name);
 
     if (meta)
@@ -731,6 +821,11 @@
 const OSMetaClass *OSMetaClass::getSuperClass() const
 {
     return superClassLink;
+}
+
+const OSSymbol *OSMetaClass::getKmodName() const
+{	
+    return (const OSSymbol *)sSortedByClassesDict->getObject((OSSymbol *)this);
 }
 
 unsigned int OSMetaClass::getInstanceCount() const
@@ -764,31 +859,50 @@
 
 OSDictionary * OSMetaClass::getClassDictionary()
 {
-    return sAllClassesDict;
+    panic("OSMetaClass::getClassDictionary(): Obsoleted\n");
+    return 0;
 }
 
 bool OSMetaClass::serialize(OSSerialize *s) const
 {
-    OSDictionary *	dict;
-    OSNumber *		off;
-    bool		ok = false;
-
-    if (s->previouslySerialized(this)) return true;
-
-    dict = 0;// IODictionary::withCapacity(2);
-    off = OSNumber::withNumber(getInstanceCount(), 32);
-
-    if (dict) {
-	dict->setObject("InstanceCount", off );
-	ok = dict->serialize(s);
-    } else if( off)
-	ok = off->serialize(s);
-
-    if (dict)
-	dict->release();
-    if (off)
-	off->release();
-
-    return ok;
-}
-
+    panic("OSMetaClass::serialize(): Obsoleted\n");
+    return false;
+}
+
+void OSMetaClass::serializeClassDictionary(OSDictionary *serializeDictionary)
+{
+    OSDictionary *classDict;
+
+    classDict = OSDictionary::withCapacity(sAllClassesDict->getCount());
+    if (!classDict)
+        return;
+
+    mutex_lock(loadLock);
+    do {
+        OSCollectionIterator *classes;
+        const OSSymbol *className;
+
+        classes = OSCollectionIterator::withCollection(sAllClassesDict);
+        if (!classes)
+            break;
+    
+        while ((className = (const OSSymbol *) classes->getNextObject())) {
+            const OSMetaClass *meta;
+            OSNumber *count;
+
+            meta = (OSMetaClass *) sAllClassesDict->getObject(className);
+            count = OSNumber::withNumber(meta->getInstanceCount(), 32);
+            if (count) {
+                classDict->setObject(className, count);
+                count->release();
+            }
+        }
+        classes->release();
+
+        serializeDictionary->setObject("Classes", classDict);
+    } while (0);
+
+    mutex_unlock(loadLock);
+
+    classDict->release();
+}