Loading...
libkern/c++/OSObject.cpp xnu-792 xnu-2422.100.13
--- xnu/xnu-792/libkern/c++/OSObject.cpp
+++ xnu/xnu-2422.100.13/libkern/c++/OSObject.cpp
@@ -1,33 +1,44 @@
 /*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_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 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.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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 OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * 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_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /* OSObject.cpp created by gvdl on Fri 1998-11-17 */
 
 #include <libkern/c++/OSObject.h>
+#include <libkern/c++/OSArray.h>
 #include <libkern/c++/OSSerialize.h>
 #include <libkern/c++/OSLib.h>
+#include <libkern/OSDebug.h>
 #include <libkern/c++/OSCPPDebug.h>
+#include <IOKit/IOKitDebug.h>
 #include <libkern/OSAtomic.h>
 
 #include <libkern/c++/OSCollection.h>
+
+#include <kern/queue.h>
 
 __BEGIN_DECLS
 int debug_ivars_size;
@@ -75,22 +86,6 @@
 OSMetaClassDefineReservedUnused(OSObject, 13);
 OSMetaClassDefineReservedUnused(OSObject, 14);
 OSMetaClassDefineReservedUnused(OSObject, 15);
-OSMetaClassDefineReservedUnused(OSObject, 16);
-OSMetaClassDefineReservedUnused(OSObject, 17);
-OSMetaClassDefineReservedUnused(OSObject, 18);
-OSMetaClassDefineReservedUnused(OSObject, 19);
-OSMetaClassDefineReservedUnused(OSObject, 20);
-OSMetaClassDefineReservedUnused(OSObject, 21);
-OSMetaClassDefineReservedUnused(OSObject, 22);
-OSMetaClassDefineReservedUnused(OSObject, 23);
-OSMetaClassDefineReservedUnused(OSObject, 24);
-OSMetaClassDefineReservedUnused(OSObject, 25);
-OSMetaClassDefineReservedUnused(OSObject, 26);
-OSMetaClassDefineReservedUnused(OSObject, 27);
-OSMetaClassDefineReservedUnused(OSObject, 28);
-OSMetaClassDefineReservedUnused(OSObject, 29);
-OSMetaClassDefineReservedUnused(OSObject, 30);
-OSMetaClassDefineReservedUnused(OSObject, 31);
 
 static const char *getClassName(const OSObject *obj)
 {
@@ -101,12 +96,6 @@
 bool OSObject::init()
     { return true; }
 
-#if (!__ppc__) || (__GNUC__ < 3)
-
-// Implemented in assembler in post gcc 3.x systems as we have a problem
-// where the destructor in gcc2.95 gets 2 arguments.  The second argument
-// appears to be a flag argument.  I have copied the assembler from Puma xnu
-// to OSRuntimeSupport.c  So for 2.95 builds use the C 
 void OSObject::free()
 {
     const OSMetaClass *meta = getMetaClass();
@@ -115,7 +104,6 @@
 	meta->instanceDestructed();
     delete this;
 }
-#endif /* (!__ppc__) || (__GNUC__ < 3) */
 
 int OSObject::getRetainCount() const
 {
@@ -151,7 +139,7 @@
 
 #if !DEBUG
 		break;	// Break out of update loop which pegs the reference
-#else DEBUG
+#else /* DEBUG */
                 // @@@ gvdl: eventually need to make this panic optional
                 // based on a boot argument i.e. debug= boot flag
                 msg = "About to wrap the reference count, reference leak?";
@@ -161,7 +149,7 @@
         }
 
 	newCount = origCount + inc;
-    } while (!OSCompareAndSwap(origCount, newCount, (UInt32 *) countP));
+    } while (!OSCompareAndSwap(origCount, newCount, const_cast<UInt32 *>(countP)));
 }
 
 void OSObject::taggedRelease(const void *tag) const
@@ -198,7 +186,7 @@
 
 #if !DEBUG
 		return;	// return out of function which pegs the reference
-#else DEBUG
+#else /* DEBUG */
                 // @@@ gvdl: eventually need to make this panic optional
                 // based on a boot argument i.e. debug= boot flag
                 panic("OSObject::refcount: %s",
@@ -212,23 +200,28 @@
         else
             newCount = actualCount;
 
-    } while (!OSCompareAndSwap(origCount, newCount, (UInt32 *) countP));
+    } while (!OSCompareAndSwap(origCount, newCount, const_cast<UInt32 *>(countP)));
 
     //
     // This panic means that we have just attempted to release an object
-    // who's retain count has gone to less than the number of collections
+    // whose retain count has gone to less than the number of collections
     // it is a member off.  Take a panic immediately.
-    // In Fact the panic MAY not be a registry corruption but it is 
+    // In fact the panic MAY not be a registry corruption but it is 
     // ALWAYS the wrong thing to do.  I call it a registry corruption 'cause
     // the registry is the biggest single use of a network of collections.
     //
-    if ((UInt16) actualCount < (actualCount >> 16))
-	panic("A driver releasing a(n) %s has corrupted the registry\n",
-	    getClassName(this));
+// xxx - this error message is overly-specific;
+// xxx - any code in the kernel could trip this,
+// xxx - and it applies as noted to all collections, not just the registry
+    if ((UInt16) actualCount < (actualCount >> 16)) {
+        panic("A kext releasing a(n) %s has corrupted the registry.",
+            getClassName(this));
+    }
 
     // Check for a 'free' condition and that if we are first through
-    if (newCount == 0xffff)
-	((OSObject *) this)->free();
+    if (newCount == 0xffff) {
+        (const_cast<OSObject *>(this))->free();
+    }
 }
 
 void OSObject::release() const
@@ -258,20 +251,91 @@
     return s->addXMLEndTag("string");
 }
 
+
+thread_t gOSObjectTrackThread;
+
+queue_head_t gOSObjectTrackList =
+    { (queue_t) &gOSObjectTrackList, (queue_t) &gOSObjectTrackList };
+
+lck_spin_t gOSObjectTrackLock;
+
+OSArray * OSFlushObjectTrackList(void)
+{
+    OSArray *     array;
+    queue_entry_t next;
+
+    array = OSArray::withCapacity(16);
+
+    lck_spin_lock(&gOSObjectTrackLock);
+    while (!queue_empty(&gOSObjectTrackList))
+    {
+	next = queue_first(&gOSObjectTrackList);
+	remque(next);
+	lck_spin_unlock(&gOSObjectTrackLock);
+	array->setObject((OSObject *) (next + 1));
+	lck_spin_lock(&gOSObjectTrackLock);
+    }
+    lck_spin_unlock(&gOSObjectTrackLock);
+
+    return (array);
+}
+
+struct OSObjectTracking
+{
+    queue_chain_t link;
+    void *	  bt[14];
+};
+
 void *OSObject::operator new(size_t size)
 {
-    void *mem = (void *) kalloc(size);
+    size_t tracking        = (gIOKitDebug & kOSTraceObjectAlloc) 
+			   ? sizeof(OSObjectTracking) : 0;
+    OSObjectTracking * mem = (OSObjectTracking *) kalloc(size + tracking);
+
     assert(mem);
+
+    if (tracking)
+    {
+	if ((((thread_t) 1) == gOSObjectTrackThread) || (current_thread() == gOSObjectTrackThread))
+	{
+	    (void) OSBacktrace(&mem->bt[0], sizeof(mem->bt) / sizeof(mem->bt[0]));
+	    lck_spin_lock(&gOSObjectTrackLock);
+	    enqueue_tail(&gOSObjectTrackList, &mem->link);
+	    lck_spin_unlock(&gOSObjectTrackLock);
+	}
+	else
+	    mem->link.next = 0;
+	mem++;
+    }
+
     bzero(mem, size);
 
     ACCUMSIZE(size);
 
-    return mem;
-}
-
-void OSObject::operator delete(void *mem, size_t size)
-{
-    kfree((vm_offset_t) mem, size);
+    return (void *) mem;
+}
+
+void OSObject::operator delete(void *_mem, size_t size)
+{
+    size_t             tracking = (gIOKitDebug & kOSTraceObjectAlloc)
+				? sizeof(OSObjectTracking) : 0;
+    OSObjectTracking * mem      = (OSObjectTracking *) _mem;
+
+    if (!mem)
+	return;
+
+    if (tracking)
+    {
+	mem--;
+	if (mem->link.next)
+	{
+	    lck_spin_lock(&gOSObjectTrackLock);
+	    remque(&mem->link);
+	    lck_spin_unlock(&gOSObjectTrackLock);
+	}
+    }
+
+    kfree(mem, size + tracking);
 
     ACCUMSIZE(-size);
 }