2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * The contents of this file constitute Original Code as defined in and
7 * are subject to the Apple Public Source License Version 1.1 (the
8 * "License"). You may not use this file except in compliance with the
9 * License. Please obtain a copy of the License at
10 * http://www.apple.com/publicsource and read it before using this file.
12 * This Original Code and all software distributed under the License are
13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17 * License for the specific language governing rights and limitations
20 * @APPLE_LICENSE_HEADER_END@
22 /* OSMetaClass.cpp created by gvdl on Fri 1998-11-17 */
25 #include <sys/systm.h>
27 #include <libkern/OSReturn.h>
29 #include <libkern/c++/OSMetaClass.h>
31 #include <libkern/c++/OSObject.h>
32 #include <libkern/c++/OSCollectionIterator.h>
33 #include <libkern/c++/OSDictionary.h>
34 #include <libkern/c++/OSArray.h>
35 #include <libkern/c++/OSSet.h>
36 #include <libkern/c++/OSSymbol.h>
37 #include <libkern/c++/OSNumber.h>
38 #include <libkern/c++/OSSerialize.h>
39 #include <libkern/c++/OSLib.h>
40 #include <libkern/OSAtomic.h>
44 #include <mach/mach_types.h>
45 #include <mach/etap_events.h>
46 #include <kern/lock.h>
47 #include <kern/clock.h>
48 #include <kern/thread_call.h>
49 #include <kern/host.h>
50 #include <mach/kmod.h>
51 #include <mach/mach_interface.h>
53 extern void OSRuntimeUnloadCPP(kmod_info_t
*ki
, void *);
56 extern int debug_container_malloc_size
;
57 #define ACCUMSIZE(s) do { debug_container_malloc_size += (s); } while(0)
60 #endif /* OSALLOCDEBUG */
65 kCompletedBootstrap
= 0,
67 kMakingDictionaries
= 2
68 } sBootstrapState
= kNoDictionaries
;
70 static const int kClassCapacityIncrement
= 40;
71 static const int kKModCapacityIncrement
= 10;
72 static OSDictionary
*sAllClassesDict
, *sKModClassesDict
;
74 static mutex_t
*loadLock
;
75 static struct StalledData
{
78 unsigned int capacity
;
80 OSMetaClass
**classes
;
83 static unsigned int sConsiderUnloadDelay
= 60; /* secs */
85 static const char OSMetaClassBasePanicMsg
[] =
86 "OSMetaClassBase::_RESERVEDOSMetaClassBase%d called\n";
89 void OSMetaClassBase::_RESERVEDOSMetaClassBase0()
90 { panic(OSMetaClassBasePanicMsg
, 0); }
91 void OSMetaClassBase::_RESERVEDOSMetaClassBase1()
92 { panic(OSMetaClassBasePanicMsg
, 1); }
93 void OSMetaClassBase::_RESERVEDOSMetaClassBase2()
94 { panic(OSMetaClassBasePanicMsg
, 2); }
95 #endif /* SLOT_USED */
97 // As these slots are used move them up inside the #if above
98 void OSMetaClassBase::_RESERVEDOSMetaClassBase3()
99 { panic(OSMetaClassBasePanicMsg
, 3); }
100 void OSMetaClassBase::_RESERVEDOSMetaClassBase4()
101 { panic(OSMetaClassBasePanicMsg
, 4); }
102 void OSMetaClassBase::_RESERVEDOSMetaClassBase5()
103 { panic(OSMetaClassBasePanicMsg
, 5); }
104 void OSMetaClassBase::_RESERVEDOSMetaClassBase6()
105 { panic(OSMetaClassBasePanicMsg
, 6); }
108 * These used to be inline in the header but gcc didn't believe us
109 * Now we MUST pull the inline out at least until the compiler is
112 // Helper inlines for runtime type preprocessor macros
113 OSMetaClassBase
*OSMetaClassBase::
114 safeMetaCast(const OSMetaClassBase
*me
, const OSMetaClass
*toType
)
115 { return (me
)? me
->metaCast(toType
) : 0; }
117 bool OSMetaClassBase::
118 checkTypeInst(const OSMetaClassBase
*inst
, const OSMetaClassBase
*typeinst
)
120 const OSMetaClass
*toType
= OSTypeIDInst(typeinst
);
121 return typeinst
&& inst
&& (0 != inst
->metaCast(toType
));
125 // If you need this slot you had better setup an IOCTL style interface.
126 // 'Cause the whole kernel world depends on OSMetaClassBase and YOU
127 // CANT change the VTABLE size ever.
128 void OSMetaClassBase::_RESERVEDOSMetaClassBase7()
129 { panic(OSMetaClassBasePanicMsg
, 7); }
131 OSMetaClassBase::OSMetaClassBase()
135 OSMetaClassBase::~OSMetaClassBase()
139 thisVTable
= (void **) this;
140 *thisVTable
= (void *) -1UL;
143 bool OSMetaClassBase::isEqualTo(const OSMetaClassBase
*anObj
) const
145 return this == anObj
;
148 OSMetaClassBase
*OSMetaClassBase::metaCast(const OSMetaClass
*toMeta
) const
150 return toMeta
->checkMetaCast(this);
153 OSMetaClassBase
*OSMetaClassBase::metaCast(const OSSymbol
*toMetaSymb
) const
155 return OSMetaClass::checkMetaCastWithName(toMetaSymb
, this);
158 OSMetaClassBase
*OSMetaClassBase::metaCast(const OSString
*toMetaStr
) const
160 const OSSymbol
*tempSymb
= OSSymbol::withString(toMetaStr
);
161 OSMetaClassBase
*ret
= 0;
163 ret
= metaCast(tempSymb
);
169 OSMetaClassBase
*OSMetaClassBase::metaCast(const char *toMetaCStr
) const
171 const OSSymbol
*tempSymb
= OSSymbol::withCString(toMetaCStr
);
172 OSMetaClassBase
*ret
= 0;
174 ret
= metaCast(tempSymb
);
180 class OSMetaClassMeta
: public OSMetaClass
184 OSObject
*alloc() const;
186 OSMetaClassMeta::OSMetaClassMeta()
187 : OSMetaClass("OSMetaClass", 0, sizeof(OSMetaClass
))
189 OSObject
*OSMetaClassMeta::alloc() const { return 0; }
191 static OSMetaClassMeta sOSMetaClassMeta
;
193 const OSMetaClass
* const OSMetaClass::metaClass
= &sOSMetaClassMeta
;
194 const OSMetaClass
* OSMetaClass::getMetaClass() const
195 { return &sOSMetaClassMeta
; }
197 static const char OSMetaClassPanicMsg
[] =
198 "OSMetaClass::_RESERVEDOSMetaClass%d called\n";
200 void OSMetaClass::_RESERVEDOSMetaClass0()
201 { panic(OSMetaClassPanicMsg
, 0); }
202 void OSMetaClass::_RESERVEDOSMetaClass1()
203 { panic(OSMetaClassPanicMsg
, 1); }
204 void OSMetaClass::_RESERVEDOSMetaClass2()
205 { panic(OSMetaClassPanicMsg
, 2); }
206 void OSMetaClass::_RESERVEDOSMetaClass3()
207 { panic(OSMetaClassPanicMsg
, 3); }
208 void OSMetaClass::_RESERVEDOSMetaClass4()
209 { panic(OSMetaClassPanicMsg
, 4); }
210 void OSMetaClass::_RESERVEDOSMetaClass5()
211 { panic(OSMetaClassPanicMsg
, 5); }
212 void OSMetaClass::_RESERVEDOSMetaClass6()
213 { panic(OSMetaClassPanicMsg
, 6); }
214 void OSMetaClass::_RESERVEDOSMetaClass7()
215 { panic(OSMetaClassPanicMsg
, 7); }
217 void OSMetaClass::logError(OSReturn result
)
222 case kOSMetaClassNoInit
:
223 msg
="OSMetaClass::preModLoad wasn't called, runtime internal error";
225 case kOSMetaClassNoDicts
:
226 msg
="Allocation failure for Metaclass internal dictionaries"; break;
227 case kOSMetaClassNoKModSet
:
228 msg
="Allocation failure for internal kmodule set"; break;
229 case kOSMetaClassNoInsKModSet
:
230 msg
="Can't insert the KMod set into the module dictionary"; break;
231 case kOSMetaClassDuplicateClass
:
232 msg
="Duplicate class"; break;
233 case kOSMetaClassNoSuper
:
234 msg
="Can't associate a class with its super class"; break;
235 case kOSMetaClassInstNoSuper
:
236 msg
="Instance construction, unknown super class."; break;
238 case kOSMetaClassInternal
:
239 msg
="runtime internal error"; break;
240 case kOSReturnSuccess
:
246 OSMetaClass::OSMetaClass(const char *inClassName
,
247 const OSMetaClass
*inSuperClass
,
248 unsigned int inClassSize
)
251 classSize
= inClassSize
;
252 superClassLink
= inSuperClass
;
254 className
= (const OSSymbol
*) inClassName
;
257 printf("OSMetaClass::preModLoad wasn't called for %s, "
258 "runtime internal error\n", inClassName
);
259 } else if (!sStalled
->result
) {
260 // Grow stalled array if neccessary
261 if (sStalled
->count
>= sStalled
->capacity
) {
262 OSMetaClass
**oldStalled
= sStalled
->classes
;
263 int oldSize
= sStalled
->capacity
* sizeof(OSMetaClass
*);
264 int newSize
= oldSize
265 + kKModCapacityIncrement
* sizeof(OSMetaClass
*);
267 sStalled
->classes
= (OSMetaClass
**) kalloc(newSize
);
268 if (!sStalled
->classes
) {
269 sStalled
->classes
= oldStalled
;
270 sStalled
->result
= kOSMetaClassNoTempData
;
274 sStalled
->capacity
+= kKModCapacityIncrement
;
275 memmove(sStalled
->classes
, oldStalled
, oldSize
);
276 kfree((vm_offset_t
)oldStalled
, oldSize
);
277 ACCUMSIZE(newSize
- oldSize
);
280 sStalled
->classes
[sStalled
->count
++] = this;
284 OSMetaClass::~OSMetaClass()
287 OSCollectionIterator
*iter
;
290 sAllClassesDict
->removeObject(className
);
292 iter
= OSCollectionIterator::withCollection(sKModClassesDict
);
297 while ( (iterKey
= (OSSymbol
*) iter
->getNextObject()) ) {
299 kmodClassSet
= (OSSet
*) sKModClassesDict
->getObject(iterKey
);
300 if (kmodClassSet
&& kmodClassSet
->containsObject(this)) {
301 kmodClassSet
->removeObject(this);
311 // First pass find class in stalled list
312 for (i
= 0; i
< sStalled
->count
; i
++)
313 if (this == sStalled
->classes
[i
])
316 if (i
< sStalled
->count
) {
318 if (i
< sStalled
->count
)
319 memmove(&sStalled
->classes
[i
], &sStalled
->classes
[i
+1],
320 (sStalled
->count
- i
) * sizeof(OSMetaClass
*));
326 void *OSMetaClass::operator new(size_t size
) { return 0; }
327 void OSMetaClass::retain() const { }
328 void OSMetaClass::release() const { }
329 void OSMetaClass::release(int when
) const { }
330 void OSMetaClass::taggedRetain(const void *tag
) const { }
331 void OSMetaClass::taggedRelease(const void *tag
) const { }
332 void OSMetaClass::taggedRelease(const void *tag
, const int when
) const { }
333 int OSMetaClass::getRetainCount() const { return 0; }
335 const char *OSMetaClass::getClassName() const
337 return className
->getCStringNoCopy();
340 unsigned int OSMetaClass::getClassSize() const
345 void *OSMetaClass::preModLoad(const char *kmodName
)
348 loadLock
= mutex_alloc(ETAP_IO_AHA
);
349 mutex_lock(loadLock
);
352 mutex_lock(loadLock
);
354 sStalled
= (StalledData
*) kalloc(sizeof(*sStalled
));
356 sStalled
->classes
= (OSMetaClass
**)
357 kalloc(kKModCapacityIncrement
* sizeof(OSMetaClass
*));
358 if (!sStalled
->classes
) {
359 kfree((vm_offset_t
) sStalled
, sizeof(*sStalled
));
362 ACCUMSIZE((kKModCapacityIncrement
* sizeof(OSMetaClass
*)) + sizeof(*sStalled
));
364 sStalled
->result
= kOSReturnSuccess
;
365 sStalled
->capacity
= kKModCapacityIncrement
;
367 sStalled
->kmodName
= kmodName
;
368 bzero(sStalled
->classes
, kKModCapacityIncrement
* sizeof(OSMetaClass
*));
374 bool OSMetaClass::checkModLoad(void *loadHandle
)
376 return sStalled
&& loadHandle
== sStalled
377 && sStalled
->result
== kOSReturnSuccess
;
380 OSReturn
OSMetaClass::postModLoad(void *loadHandle
)
382 OSReturn result
= kOSReturnSuccess
;
385 if (!sStalled
|| loadHandle
!= sStalled
) {
386 logError(kOSMetaClassInternal
);
387 return kOSMetaClassInternal
;
390 if (sStalled
->result
)
391 result
= sStalled
->result
;
392 else switch (sBootstrapState
) {
393 case kNoDictionaries
:
394 sBootstrapState
= kMakingDictionaries
;
395 // No break; fall through
397 case kMakingDictionaries
:
398 sKModClassesDict
= OSDictionary::withCapacity(kKModCapacityIncrement
);
399 sAllClassesDict
= OSDictionary::withCapacity(kClassCapacityIncrement
);
400 if (!sAllClassesDict
|| !sKModClassesDict
) {
401 result
= kOSMetaClassNoDicts
;
404 // No break; fall through
406 case kCompletedBootstrap
:
410 if (!sStalled
->count
)
411 break; // Nothing to do so just get out
413 // First pass checking classes aren't already loaded
414 for (i
= 0; i
< sStalled
->count
; i
++) {
415 OSMetaClass
*me
= sStalled
->classes
[i
];
417 if (0 != sAllClassesDict
->getObject((const char *) me
->className
)) {
418 printf("Class \"%s\" is duplicate\n", (const char *) me
->className
);
419 result
= kOSMetaClassDuplicateClass
;
423 if (i
!= sStalled
->count
)
426 kmodSet
= OSSet::withCapacity(sStalled
->count
);
428 result
= kOSMetaClassNoKModSet
;
432 if (!sKModClassesDict
->setObject(sStalled
->kmodName
, kmodSet
)) {
433 result
= kOSMetaClassNoInsKModSet
;
437 // Second pass symbolling strings and inserting classes in dictionary
438 for (unsigned int i
= 0; i
< sStalled
->count
; i
++) {
439 OSMetaClass
*me
= sStalled
->classes
[i
];
441 OSSymbol::withCStringNoCopy((const char *) me
->className
);
443 sAllClassesDict
->setObject(me
->className
, me
);
444 kmodSet
->setObject(me
);
446 sBootstrapState
= kCompletedBootstrap
;
451 result
= kOSMetaClassInternal
;
459 ACCUMSIZE(-(sStalled
->capacity
* sizeof(OSMetaClass
*)
460 + sizeof(*sStalled
)));
461 kfree((vm_offset_t
) sStalled
->classes
,
462 sStalled
->capacity
* sizeof(OSMetaClass
*));
463 kfree((vm_offset_t
) sStalled
, sizeof(*sStalled
));
468 mutex_unlock(loadLock
);
473 void OSMetaClass::instanceConstructed() const
475 // if ((0 == OSIncrementAtomic((SInt32 *)&(((OSMetaClass *) this)->instanceCount))) && superClassLink)
476 if ((0 == OSIncrementAtomic((SInt32
*) &instanceCount
)) && superClassLink
)
477 superClassLink
->instanceConstructed();
480 void OSMetaClass::instanceDestructed() const
482 if ((1 == OSDecrementAtomic((SInt32
*) &instanceCount
)) && superClassLink
)
483 superClassLink
->instanceDestructed();
485 if( ((int) instanceCount
) < 0)
486 printf("%s: bad retain(%d)", getClassName(), instanceCount
);
489 bool OSMetaClass::modHasInstance(const char *kmodName
)
494 loadLock
= mutex_alloc(ETAP_IO_AHA
);
495 mutex_lock(loadLock
);
498 mutex_lock(loadLock
);
502 OSCollectionIterator
*iter
;
503 OSMetaClass
*checkClass
;
505 kmodClasses
= OSDynamicCast(OSSet
,
506 sKModClassesDict
->getObject(kmodName
));
510 iter
= OSCollectionIterator::withCollection(kmodClasses
);
514 while ( (checkClass
= (OSMetaClass
*) iter
->getNextObject()) )
515 if (checkClass
->getInstanceCount()) {
523 mutex_unlock(loadLock
);
528 void OSMetaClass::reportModInstances(const char *kmodName
)
531 OSCollectionIterator
*iter
;
532 OSMetaClass
*checkClass
;
534 kmodClasses
= OSDynamicCast(OSSet
,
535 sKModClassesDict
->getObject(kmodName
));
539 iter
= OSCollectionIterator::withCollection(kmodClasses
);
543 while ( (checkClass
= (OSMetaClass
*) iter
->getNextObject()) )
544 if (checkClass
->getInstanceCount()) {
545 printf("%s: %s has %d instance(s)\n",
547 checkClass
->getClassName(),
548 checkClass
->getInstanceCount());
554 static void _OSMetaClassConsiderUnloads(thread_call_param_t p0
,
555 thread_call_param_t p1
)
559 OSCollectionIterator
*kmods
;
560 OSCollectionIterator
*classes
;
561 OSMetaClass
*checkClass
;
566 mutex_lock(loadLock
);
570 kmods
= OSCollectionIterator::withCollection(sKModClassesDict
);
575 while ( (kmodName
= (OSSymbol
*) kmods
->getNextObject()) ) {
578 kfree(ki
, sizeof(kmod_info_t
));
582 ki
= kmod_lookupbyname_locked((char *)kmodName
->getCStringNoCopy());
586 if (ki
->reference_count
) {
590 kmodClasses
= OSDynamicCast(OSSet
,
591 sKModClassesDict
->getObject(kmodName
));
592 classes
= OSCollectionIterator::withCollection(kmodClasses
);
596 while ((checkClass
= (OSMetaClass
*) classes
->getNextObject())
597 && (0 == checkClass
->getInstanceCount()))
601 if (0 == checkClass
) {
602 OSRuntimeUnloadCPP(ki
, 0); // call destructors
603 ret
= kmod_destroy(host_priv_self(), ki
->id
);
613 mutex_unlock(loadLock
);
616 void OSMetaClass::considerUnloads()
618 static thread_call_t unloadCallout
;
621 mutex_lock(loadLock
);
624 unloadCallout
= thread_call_allocate(&_OSMetaClassConsiderUnloads
, 0);
626 thread_call_cancel(unloadCallout
);
627 clock_interval_to_deadline(sConsiderUnloadDelay
, 1000 * 1000 * 1000, &when
);
628 thread_call_enter_delayed(unloadCallout
, when
);
630 mutex_unlock(loadLock
);
633 const OSMetaClass
*OSMetaClass::getMetaClassWithName(const OSSymbol
*name
)
635 OSMetaClass
*retMeta
= 0;
641 retMeta
= (OSMetaClass
*) sAllClassesDict
->getObject(name
);
643 if (!retMeta
&& sStalled
)
645 // Oh dear we have to scan the stalled list and walk the
646 // the stalled list manually.
647 const char *cName
= name
->getCStringNoCopy();
650 // find class in stalled list
651 for (i
= 0; i
< sStalled
->count
; i
++) {
652 retMeta
= sStalled
->classes
[i
];
653 if (0 == strcmp(cName
, (const char *) retMeta
->className
))
657 if (i
< sStalled
->count
)
664 OSObject
*OSMetaClass::allocClassWithName(const OSSymbol
*name
)
667 mutex_lock(loadLock
);
669 const OSMetaClass
* const meta
= getMetaClassWithName(name
);
672 result
= meta
->alloc();
676 mutex_unlock(loadLock
);
681 OSObject
*OSMetaClass::allocClassWithName(const OSString
*name
)
683 const OSSymbol
*tmpKey
= OSSymbol::withString(name
);
684 OSObject
*result
= allocClassWithName(tmpKey
);
689 OSObject
*OSMetaClass::allocClassWithName(const char *name
)
691 const OSSymbol
*tmpKey
= OSSymbol::withCStringNoCopy(name
);
692 OSObject
*result
= allocClassWithName(tmpKey
);
698 OSMetaClassBase
*OSMetaClass::
699 checkMetaCastWithName(const OSSymbol
*name
, const OSMetaClassBase
*in
)
701 OSMetaClassBase
* result
;
702 mutex_lock(loadLock
);
703 const OSMetaClass
* const meta
= getMetaClassWithName(name
);
706 result
= meta
->checkMetaCast(in
);
710 mutex_unlock(loadLock
);
714 OSMetaClassBase
*OSMetaClass::
715 checkMetaCastWithName(const OSString
*name
, const OSMetaClassBase
*in
)
717 const OSSymbol
*tmpKey
= OSSymbol::withString(name
);
718 OSMetaClassBase
*result
= checkMetaCastWithName(tmpKey
, in
);
723 OSMetaClassBase
*OSMetaClass::
724 checkMetaCastWithName(const char *name
, const OSMetaClassBase
*in
)
726 const OSSymbol
*tmpKey
= OSSymbol::withCStringNoCopy(name
);
727 OSMetaClassBase
*result
= checkMetaCastWithName(tmpKey
, in
);
733 OSMetaClass::checkMetaCast
734 checkMetaCast(const OSMetaClassBase *check)
736 Check to see if the 'check' object has this object in it's metaclass chain. Returns check if it is indeed a kind of the current meta class, 0 otherwise.
738 Generally this method is not invoked directly but is used to implement the OSMetaClassBase::metaCast member function.
740 See also OSMetaClassBase::metaCast
743 OSMetaClassBase
*OSMetaClass::checkMetaCast(const OSMetaClassBase
*check
) const
745 const OSMetaClass
* const toMeta
= this;
746 const OSMetaClass
*fromMeta
;
748 for (fromMeta
= check
->getMetaClass(); ; fromMeta
= fromMeta
->superClassLink
) {
749 if (toMeta
== fromMeta
)
750 return (OSMetaClassBase
*) check
; // Discard const
752 if (!fromMeta
->superClassLink
)
759 void OSMetaClass::reservedCalled(int ind
) const
761 const char *cname
= className
->getCStringNoCopy();
762 panic("%s::_RESERVED%s%d called\n", cname
, cname
, ind
);
765 const OSMetaClass
*OSMetaClass::getSuperClass() const
767 return superClassLink
;
770 unsigned int OSMetaClass::getInstanceCount() const
772 return instanceCount
;
775 void OSMetaClass::printInstanceCounts()
777 OSCollectionIterator
*classes
;
781 classes
= OSCollectionIterator::withCollection(sAllClassesDict
);
785 while( (className
= (OSSymbol
*)classes
->getNextObject())) {
786 meta
= (OSMetaClass
*) sAllClassesDict
->getObject(className
);
789 printf("%24s count: %03d x 0x%03x = 0x%06x\n",
790 className
->getCStringNoCopy(),
791 meta
->getInstanceCount(),
792 meta
->getClassSize(),
793 meta
->getInstanceCount() * meta
->getClassSize() );
799 OSDictionary
* OSMetaClass::getClassDictionary()
801 return sAllClassesDict
;
804 bool OSMetaClass::serialize(OSSerialize
*s
) const
810 if (s
->previouslySerialized(this)) return true;
812 dict
= 0;// IODictionary::withCapacity(2);
813 off
= OSNumber::withNumber(getInstanceCount(), 32);
816 dict
->setObject("InstanceCount", off
);
817 ok
= dict
->serialize(s
);
819 ok
= off
->serialize(s
);