[apple/xnu.git] / libkern / c++ / OSObject.cpp

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_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 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@
 */
/* OSObject.cpp created by gvdl on Fri 1998-11-17 */

#include <libkern/c++/OSObject.h>
#include <libkern/c++/OSSerialize.h>
#include <libkern/c++/OSLib.h>
#include <libkern/c++/OSCPPDebug.h>
#include <libkern/OSAtomic.h>

#include <libkern/c++/OSCollection.h>

__BEGIN_DECLS
int debug_ivars_size;
__END_DECLS

#if OSALLOCDEBUG
#define ACCUMSIZE(s) do { debug_ivars_size += (s); } while(0)
#else
#define ACCUMSIZE(s)
#endif

// OSDefineMetaClassAndAbstractStructors(OSObject, 0);
/* Class global data */
OSObject::MetaClass OSObject::gMetaClass;
const OSMetaClass * const OSObject::metaClass = &OSObject::gMetaClass;
const OSMetaClass * const OSObject::superClass = 0;

/* Class member functions - Can't use defaults */
OSObject::OSObject()			{ retainCount = 1; }
OSObject::OSObject(const OSMetaClass *)	{ retainCount = 1; }
OSObject::~OSObject()			{ }
const OSMetaClass * OSObject::getMetaClass() const
    { return &gMetaClass; }
OSObject *OSObject::MetaClass::alloc() const { return 0; }

/* The OSObject::MetaClass constructor */
OSObject::MetaClass::MetaClass()
    : OSMetaClass("OSObject", OSObject::superClass, sizeof(OSObject))
    { }

// Virtual Padding
OSMetaClassDefineReservedUnused(OSObject,  0);
OSMetaClassDefineReservedUnused(OSObject,  1);
OSMetaClassDefineReservedUnused(OSObject,  2);
OSMetaClassDefineReservedUnused(OSObject,  3);
OSMetaClassDefineReservedUnused(OSObject,  4);
OSMetaClassDefineReservedUnused(OSObject,  5);
OSMetaClassDefineReservedUnused(OSObject,  6);
OSMetaClassDefineReservedUnused(OSObject,  7);
OSMetaClassDefineReservedUnused(OSObject,  8);
OSMetaClassDefineReservedUnused(OSObject,  9);
OSMetaClassDefineReservedUnused(OSObject, 10);
OSMetaClassDefineReservedUnused(OSObject, 11);
OSMetaClassDefineReservedUnused(OSObject, 12);
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)
{
    const OSMetaClass *meta = obj->getMetaClass();
    return (meta) ? meta->getClassName() : "unknown class?";
}

bool OSObject::init()
    { return true; }

void OSObject::free()
{
    const OSMetaClass *meta = getMetaClass();

    if (meta)
	meta->instanceDestructed();
    delete this;
}

int OSObject::getRetainCount() const
{
    return (int) ((UInt16) retainCount);
}

void OSObject::taggedRetain(const void *tag) const
{
#if !DEBUG
    volatile UInt32 *countP = (volatile UInt32 *) &retainCount;
    UInt32 inc = 1;
    UInt32 origCount;
    UInt32 newCount;

    // Increment the collecion bucket.
    if ((const void *) OSTypeID(OSCollection) == tag)
	inc |= (1UL<<16);

    do {
	origCount = *countP;
	if (-1UL == origCount)
	    // @@@ Pinot: panic("Attempting to retain a freed object");
	    return;

	newCount = origCount + inc;
    } while (!OSCompareAndSwap(origCount, newCount, (UInt32 *) countP));
#else
    volatile UInt32 *countP = (volatile UInt32 *) &retainCount;
    UInt32 inc = 1;
    UInt32 origCount;
    UInt32 newCount;

    // Increment the collecion bucket.
    if ((const void *) OSTypeID(OSCollection) == tag)
	inc |= (1UL<<16);

    do {
	origCount = *countP;
	if (-1UL == origCount)
	    return;	// We are freeing so leave now.

	newCount = origCount + inc;
    } while (!OSCompareAndSwap(origCount, newCount, (UInt32 *) countP));
#endif
}

void OSObject::taggedRelease(const void *tag) const
{
    taggedRelease(tag, 1);
}

void OSObject::taggedRelease(const void *tag, const int when) const
{
#if !DEBUG
    volatile UInt32 *countP = (volatile UInt32 *) &retainCount;
    UInt32 dec = 1;
    UInt32 origCount;
    UInt32 newCount;
    UInt32 actualCount;

    // Increment the collecion bucket.
    if ((const void *) OSTypeID(OSCollection) == tag)
	dec |= (1UL<<16);

    do {
	origCount = *countP;
	if (-1UL == origCount)
	    return;	// We are freeing already leave now.

	actualCount = origCount - dec;
        if ((SInt16) actualCount < when)
            newCount = (UInt32) -1;
        else
            newCount = actualCount;

    } while (!OSCompareAndSwap(origCount, newCount, (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
    // it is a member off.  Take a panic immediately.
    // 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));

    // Check for a 'free' condition and that if we are first through
    if ((UInt32) -1 == newCount)
	((OSObject *) this)->free();
#else
    // @@@ Pinot:  Need to update the debug build release code.
    volatile UInt32 *countP = (volatile UInt32 *) &retainCount;
    UInt32 dec = 1;
    UInt32 origCount;
    UInt32 newCount;

    // Increment the collecion bucket.
    if ((const void *) OSTypeID(OSCollection) == tag)
	dec |= (1UL<<16);

    do {
	origCount = *countP;
	if (-1UL == origCount)
	    return;	// We are freeing already leave now.

	newCount = origCount - dec;
    } while (!OSCompareAndSwap(origCount, newCount, (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
    // it is a member off.  Take a panic immediately.
    // 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) newCount < (newCount >> 16))
	panic("A driver releasing a(n) %s has corrupted the registry\n",
	    getClassName(this));

    // Check for a release too many
    if ((SInt16) newCount < 0)
	panic("An object has had a release too many\n",
	    getClassName(this));

    // Check for a 'free' condition and that if we are first through
    if ((SInt16) newCount < when
    && OSCompareAndSwap(newCount, -1UL, (UInt32 *) countP))
	((OSObject *) this)->free();
#endif
}

void OSObject::release() const
{
    taggedRelease(0);
}

void OSObject::retain() const
{
    taggedRetain(0);
}

void OSObject::release(int when) const
{
    taggedRelease(0, when);
}

bool OSObject::serialize(OSSerialize *s) const
{
    if (s->previouslySerialized(this)) return true;

    if (!s->addXMLStartTag(this, "string")) return false;

    if (!s->addString(getClassName(this))) return false;
    if (!s->addString(" is not serializable")) return false;
    
    return s->addXMLEndTag("string");
}

void *OSObject::operator new(size_t size)
{
    void *mem = (void *) kalloc(size);
    assert(mem);
    bzero(mem, size);

    ACCUMSIZE(size);

    return mem;
}

void OSObject::operator delete(void *mem, size_t size)
{
    kfree((vm_offset_t) mem, size);

    ACCUMSIZE(-size);
}
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
	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.
	11	*
	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
	18	* under the License.
	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/* OSObject.cpp created by gvdl on Fri 1998-11-17 */
	23
	24	#include <libkern/c++/OSObject.h>
	25	#include <libkern/c++/OSSerialize.h>
1c79356b A	26	#include <libkern/c++/OSLib.h>
	27	#include <libkern/c++/OSCPPDebug.h>
	28	#include <libkern/OSAtomic.h>
	29
9bccf70c A	30	#include <libkern/c++/OSCollection.h>
9bccf70c A	31
1c79356b A	32	__BEGIN_DECLS
	33	int debug_ivars_size;
	34	__END_DECLS
	35
	36	#if OSALLOCDEBUG
	37	#define ACCUMSIZE(s) do { debug_ivars_size += (s); } while(0)
	38	#else
	39	#define ACCUMSIZE(s)
	40	#endif
	41
	42	// OSDefineMetaClassAndAbstractStructors(OSObject, 0);
	43	/* Class global data */
	44	OSObject::MetaClass OSObject::gMetaClass;
	45	const OSMetaClass * const OSObject::metaClass = &OSObject::gMetaClass;
	46	const OSMetaClass * const OSObject::superClass = 0;
	47
	48	/* Class member functions - Can't use defaults */
	49	OSObject::OSObject() { retainCount = 1; }
	50	OSObject::OSObject(const OSMetaClass *) { retainCount = 1; }
	51	OSObject::~OSObject() { }
	52	const OSMetaClass * OSObject::getMetaClass() const
	53	{ return &gMetaClass; }
	54	OSObject *OSObject::MetaClass::alloc() const { return 0; }
	55
	56	/* The OSObject::MetaClass constructor */
	57	OSObject::MetaClass::MetaClass()
	58	: OSMetaClass("OSObject", OSObject::superClass, sizeof(OSObject))
	59	{ }
	60
	61	// Virtual Padding
	62	OSMetaClassDefineReservedUnused(OSObject, 0);
	63	OSMetaClassDefineReservedUnused(OSObject, 1);
	64	OSMetaClassDefineReservedUnused(OSObject, 2);
	65	OSMetaClassDefineReservedUnused(OSObject, 3);
	66	OSMetaClassDefineReservedUnused(OSObject, 4);
	67	OSMetaClassDefineReservedUnused(OSObject, 5);
	68	OSMetaClassDefineReservedUnused(OSObject, 6);
	69	OSMetaClassDefineReservedUnused(OSObject, 7);
	70	OSMetaClassDefineReservedUnused(OSObject, 8);
	71	OSMetaClassDefineReservedUnused(OSObject, 9);
	72	OSMetaClassDefineReservedUnused(OSObject, 10);
	73	OSMetaClassDefineReservedUnused(OSObject, 11);
	74	OSMetaClassDefineReservedUnused(OSObject, 12);
	75	OSMetaClassDefineReservedUnused(OSObject, 13);
	76	OSMetaClassDefineReservedUnused(OSObject, 14);
	77	OSMetaClassDefineReservedUnused(OSObject, 15);
	78	OSMetaClassDefineReservedUnused(OSObject, 16);
	79	OSMetaClassDefineReservedUnused(OSObject, 17);
	80	OSMetaClassDefineReservedUnused(OSObject, 18);
	81	OSMetaClassDefineReservedUnused(OSObject, 19);
	82	OSMetaClassDefineReservedUnused(OSObject, 20);
	83	OSMetaClassDefineReservedUnused(OSObject, 21);
	84	OSMetaClassDefineReservedUnused(OSObject, 22);
	85	OSMetaClassDefineReservedUnused(OSObject, 23);
	86	OSMetaClassDefineReservedUnused(OSObject, 24);
	87	OSMetaClassDefineReservedUnused(OSObject, 25);
	88	OSMetaClassDefineReservedUnused(OSObject, 26);
	89	OSMetaClassDefineReservedUnused(OSObject, 27);
	90	OSMetaClassDefineReservedUnused(OSObject, 28);
	91	OSMetaClassDefineReservedUnused(OSObject, 29);
	92	OSMetaClassDefineReservedUnused(OSObject, 30);
	93	OSMetaClassDefineReservedUnused(OSObject, 31);
	94
9bccf70c A	95	static const char getClassName(const OSObject obj)
	96	{
	97	const OSMetaClass *meta = obj->getMetaClass();
	98	return (meta) ? meta->getClassName() : "unknown class?";
	99	}
	100
	101	bool OSObject::init()
	102	{ return true; }
1c79356b	103
1c79356b A	104	void OSObject::free()
	105	{
	106	const OSMetaClass *meta = getMetaClass();
	107
	108	if (meta)
	109	meta->instanceDestructed();
	110	delete this;
	111	}
	112
	113	int OSObject::getRetainCount() const
	114	{
9bccf70c	115	return (int) ((UInt16) retainCount);
1c79356b A	116	}
1c79356b A	117
9bccf70c	118	void OSObject::taggedRetain(const void *tag) const
1c79356b	119	{
9bccf70c A	120	#if !DEBUG
	121	volatile UInt32 countP = (volatile UInt32 ) &retainCount;
	122	UInt32 inc = 1;
	123	UInt32 origCount;
	124	UInt32 newCount;
	125
	126	// Increment the collecion bucket.
	127	if ((const void *) OSTypeID(OSCollection) == tag)
	128	inc \|= (1UL<<16);
	129
	130	do {
	131	origCount = *countP;
	132	if (-1UL == origCount)
	133	// @@@ Pinot: panic("Attempting to retain a freed object");
	134	return;
	135
	136	newCount = origCount + inc;
	137	} while (!OSCompareAndSwap(origCount, newCount, (UInt32 *) countP));
	138	#else
	139	volatile UInt32 countP = (volatile UInt32 ) &retainCount;
	140	UInt32 inc = 1;
	141	UInt32 origCount;
	142	UInt32 newCount;
	143
	144	// Increment the collecion bucket.
	145	if ((const void *) OSTypeID(OSCollection) == tag)
	146	inc \|= (1UL<<16);
	147
	148	do {
	149	origCount = *countP;
	150	if (-1UL == origCount)
	151	return; // We are freeing so leave now.
	152
	153	newCount = origCount + inc;
	154	} while (!OSCompareAndSwap(origCount, newCount, (UInt32 *) countP));
	155	#endif
1c79356b A	156	}
1c79356b A	157
9bccf70c A	158	void OSObject::taggedRelease(const void *tag) const
	159	{
	160	taggedRelease(tag, 1);
	161	}
	162
	163	void OSObject::taggedRelease(const void *tag, const int when) const
1c79356b	164	{
9bccf70c A	165	#if !DEBUG
	166	volatile UInt32 countP = (volatile UInt32 ) &retainCount;
	167	UInt32 dec = 1;
	168	UInt32 origCount;
	169	UInt32 newCount;
	170	UInt32 actualCount;
	171
	172	// Increment the collecion bucket.
	173	if ((const void *) OSTypeID(OSCollection) == tag)
	174	dec \|= (1UL<<16);
	175
	176	do {
	177	origCount = *countP;
	178	if (-1UL == origCount)
	179	return; // We are freeing already leave now.
	180
	181	actualCount = origCount - dec;
	182	if ((SInt16) actualCount < when)
	183	newCount = (UInt32) -1;
	184	else
	185	newCount = actualCount;
	186
	187	} while (!OSCompareAndSwap(origCount, newCount, (UInt32 *) countP));
	188
	189	//
	190	// This panic means that we have just attempted to release an object
	191	// who's retain count has gone to less than the number of collections
	192	// it is a member off. Take a panic immediately.
	193	// In Fact the panic MAY not be a registry corruption but it is
	194	// ALWAYS the wrong thing to do. I call it a registry corruption 'cause
	195	// the registry is the biggest single use of a network of collections.
	196	//
	197	if ((UInt16) actualCount < (actualCount >> 16))
	198	panic("A driver releasing a(n) %s has corrupted the registry\n",
	199	getClassName(this));
	200
	201	// Check for a 'free' condition and that if we are first through
	202	if ((UInt32) -1 == newCount)
1c79356b	203	((OSObject *) this)->free();
9bccf70c A	204	#else
	205	// @@@ Pinot: Need to update the debug build release code.
	206	volatile UInt32 countP = (volatile UInt32 ) &retainCount;
	207	UInt32 dec = 1;
	208	UInt32 origCount;
	209	UInt32 newCount;
	210
	211	// Increment the collecion bucket.
	212	if ((const void *) OSTypeID(OSCollection) == tag)
	213	dec \|= (1UL<<16);
	214
	215	do {
	216	origCount = *countP;
	217	if (-1UL == origCount)
	218	return; // We are freeing already leave now.
	219
	220	newCount = origCount - dec;
	221	} while (!OSCompareAndSwap(origCount, newCount, (UInt32 *) countP));
	222
	223	//
	224	// This panic means that we have just attempted to release an object
	225	// who's retain count has gone to less than the number of collections
	226	// it is a member off. Take a panic immediately.
	227	// In Fact the panic MAY not be a registry corruption but it is
	228	// ALWAYS the wrong thing to do. I call it a registry corruption 'cause
	229	// the registry is the biggest single use of a network of collections.
	230	//
	231	if ((UInt16) newCount < (newCount >> 16))
	232	panic("A driver releasing a(n) %s has corrupted the registry\n",
	233	getClassName(this));
	234
	235	// Check for a release too many
	236	if ((SInt16) newCount < 0)
	237	panic("An object has had a release too many\n",
	238	getClassName(this));
	239
	240	// Check for a 'free' condition and that if we are first through
	241	if ((SInt16) newCount < when
	242	&& OSCompareAndSwap(newCount, -1UL, (UInt32 *) countP))
	243	((OSObject *) this)->free();
	244	#endif
1c79356b A	245	}
	246
	247	void OSObject::release() const
	248	{
9bccf70c A	249	taggedRelease(0);
	250	}
	251
	252	void OSObject::retain() const
	253	{
	254	taggedRetain(0);
	255	}
	256
	257	void OSObject::release(int when) const
	258	{
	259	taggedRelease(0, when);
1c79356b A	260	}
	261
	262	bool OSObject::serialize(OSSerialize *s) const
	263	{
	264	if (s->previouslySerialized(this)) return true;
	265
	266	if (!s->addXMLStartTag(this, "string")) return false;
	267
9bccf70c	268	if (!s->addString(getClassName(this))) return false;
1c79356b A	269	if (!s->addString(" is not serializable")) return false;
	270
	271	return s->addXMLEndTag("string");
	272	}
	273
	274	void *OSObject::operator new(size_t size)
	275	{
	276	void mem = (void ) kalloc(size);
	277	assert(mem);
	278	bzero(mem, size);
	279
	280	ACCUMSIZE(size);
	281
	282	return mem;
	283	}
	284
	285	void OSObject::operator delete(void *mem, size_t size)
	286	{
	287	kfree((vm_offset_t) mem, size);
	288
	289	ACCUMSIZE(-size);
	290	}