Loading...
libkern/c++/OSDictionary.cpp xnu-201 xnu-4570.1.46
--- xnu/xnu-201/libkern/c++/OSDictionary.cpp
+++ xnu/xnu-4570.1.46/libkern/c++/OSDictionary.cpp
@@ -1,23 +1,29 @@
 /*
  * Copyright (c) 2000 Apple Computer, 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@
  */
 /* OSDictionary.m created by rsulack on Fri 12-Sep-1997 */
 /* OSDictionary.cpp converted to C++ by gvdl on Fri 1998-10-30 */
@@ -43,28 +49,26 @@
 OSMetaClassDefineReservedUnused(OSDictionary, 6);
 OSMetaClassDefineReservedUnused(OSDictionary, 7);
 
-#if OSALLOCDEBUG
-extern "C" {
-    extern int debug_container_malloc_size;
-};
-#define ACCUMSIZE(s) do { debug_container_malloc_size += (s); } while(0)
-#else
-#define ACCUMSIZE(s)
-#endif
+#define EXT_CAST(obj) \
+    reinterpret_cast<OSObject *>(const_cast<OSMetaClassBase *>(obj))
 
 bool OSDictionary::initWithCapacity(unsigned int inCapacity)
 {
     if (!super::init())
         return false;
 
-    int size = inCapacity * sizeof(dictEntry);
-
-    dictionary = (dictEntry *) kalloc(size);
+    if (inCapacity > (UINT_MAX / sizeof(dictEntry)))
+        return false;
+
+    unsigned int size = inCapacity * sizeof(dictEntry);
+//fOptions |= kSort;
+
+    dictionary = (dictEntry *) kalloc_container(size);
     if (!dictionary)
         return false;
 
     bzero(dictionary, size);
-    ACCUMSIZE(size);
+    OSCONTAINER_ACCUMSIZE(size);
 
     count = 0;
     capacity = inCapacity;
@@ -76,9 +80,9 @@
 bool OSDictionary::initWithObjects(const OSObject *objects[],
                                    const OSSymbol *keys[],
                                    unsigned int theCount,
-                                   unsigned int theCapacity = 0)
-{
-    unsigned int capacity = theCount;
+                                   unsigned int theCapacity)
+{
+    unsigned int newCapacity = theCount;
 
     if (!objects || !keys)
         return false;
@@ -87,10 +91,10 @@
         if (theCount > theCapacity)
             return false;
         
-        capacity = theCapacity;
-    }
-
-    if (!initWithCapacity(capacity))
+        newCapacity = theCapacity;
+    }
+
+    if (!initWithCapacity(newCapacity))
         return false;
 
     for (unsigned int i = 0; i < theCount; i++) {
@@ -106,9 +110,9 @@
 bool OSDictionary::initWithObjects(const OSObject *objects[],
                                    const OSString *keys[],
                                    unsigned int theCount,
-                                   unsigned int theCapacity = 0)
-{
-    unsigned int capacity = theCount;
+                                   unsigned int theCapacity)
+{
+    unsigned int newCapacity = theCount;
 
     if (!objects || !keys)
         return false;
@@ -117,10 +121,10 @@
         if (theCount > theCapacity)
             return false;
 
-        capacity = theCapacity;
-    }
-
-    if (!initWithCapacity(capacity))
+        newCapacity = theCapacity;
+    }
+
+    if (!initWithCapacity(newCapacity))
         return false;
 
     for (unsigned int i = 0; i < theCount; i++) {
@@ -142,30 +146,39 @@
 }
 
 bool OSDictionary::initWithDictionary(const OSDictionary *dict,
-                                      unsigned int theCapacity = 0)
-{
-    unsigned int capacity;
+                                      unsigned int theCapacity)
+{
+    unsigned int newCapacity;
 
     if ( !dict )
         return false;
 
-    capacity = dict->count;
+    newCapacity = dict->count;
 
     if ( theCapacity ) {
         if ( dict->count > theCapacity )
             return false;
         
-        capacity = theCapacity;
-    }
-
-    if (!initWithCapacity(capacity))
-        return false;
+        newCapacity = theCapacity;
+    }
+
+    if (!initWithCapacity(newCapacity))
+        return false;
+
+    if ((kSort & fOptions) && !(kSort & dict->fOptions)) {
+	for (unsigned int i = 0; i < dict->count; i++) {
+	    if (!setObject(dict->dictionary[i].key, dict->dictionary[i].value)) {
+		return false;
+	    }
+	}
+	return true;
+    }
 
     count = dict->count;
     bcopy(dict->dictionary, dictionary, count * sizeof(dictEntry));
     for (unsigned int i = 0; i < count; i++) {
-        dictionary[i].key->retain();
-        dictionary[i].value->retain();
+        dictionary[i].key->taggedRetain(OSTypeID(OSCollection));
+        dictionary[i].value->taggedRetain(OSTypeID(OSCollection));
     }
 
     return true;
@@ -176,7 +189,7 @@
     OSDictionary *me = new OSDictionary;
 
     if (me && !me->initWithCapacity(capacity)) {
-        me->free();
+        me->release();
         return 0;
     }
 
@@ -186,12 +199,12 @@
 OSDictionary *OSDictionary::withObjects(const OSObject *objects[],
                                         const OSSymbol *keys[],
                                         unsigned int count,
-                                        unsigned int capacity = 0)
+                                        unsigned int capacity)
 {
     OSDictionary *me = new OSDictionary;
 
     if (me && !me->initWithObjects(objects, keys, count, capacity)) {
-        me->free();
+        me->release();
         return 0;
     }
 
@@ -201,12 +214,12 @@
 OSDictionary *OSDictionary::withObjects(const OSObject *objects[],
                                         const OSString *keys[],
                                         unsigned int count,
-                                        unsigned int capacity = 0)
+                                        unsigned int capacity)
 {
     OSDictionary *me = new OSDictionary;
 
     if (me && !me->initWithObjects(objects, keys, count, capacity)) {
-        me->free();
+        me->release();
         return 0;
     }
 
@@ -214,12 +227,12 @@
 }
 
 OSDictionary *OSDictionary::withDictionary(const OSDictionary *dict,
-                                           unsigned int capacity = 0)
+                                           unsigned int capacity)
 {
     OSDictionary *me = new OSDictionary;
 
     if (me && !me->initWithDictionary(dict, capacity)) {
-        me->free();
+        me->release();
         return 0;
     }
 
@@ -228,10 +241,11 @@
 
 void OSDictionary::free()
 {
+    (void) super::setOptions(0, kImmutable);
     flushCollection();
     if (dictionary) {
-        kfree((vm_offset_t)dictionary, capacity * sizeof(dictEntry));
-        ACCUMSIZE( -(capacity * sizeof(dictEntry)) );
+        kfree(dictionary, capacity * sizeof(dictEntry));
+        OSCONTAINER_ACCUMSIZE( -(capacity * sizeof(dictEntry)) );
     }
 
     super::free();
@@ -255,28 +269,37 @@
 unsigned int OSDictionary::ensureCapacity(unsigned int newCapacity)
 {
     dictEntry *newDict;
-    int oldSize, newSize;
+    unsigned int finalCapacity;
+    vm_size_t oldSize, newSize;
 
     if (newCapacity <= capacity)
         return capacity;
 
     // round up
-    newCapacity = (((newCapacity - 1) / capacityIncrement) + 1)
+    finalCapacity = (((newCapacity - 1) / capacityIncrement) + 1)
                 * capacityIncrement;
-    newSize = sizeof(dictEntry) * newCapacity;
-
-    newDict = (dictEntry *) kalloc(newSize);
+
+    // integer overflow check
+    if (finalCapacity < newCapacity || (finalCapacity > (UINT_MAX / sizeof(dictEntry))))
+        return capacity;
+    
+    newSize = sizeof(dictEntry) * finalCapacity;
+
+    newDict = (dictEntry *) kallocp_container(&newSize);
     if (newDict) {
+        // use all of the actual allocation size
+        finalCapacity = newSize / sizeof(dictEntry);
+
         oldSize = sizeof(dictEntry) * capacity;
 
         bcopy(dictionary, newDict, oldSize);
         bzero(&newDict[capacity], newSize - oldSize);
 
-        ACCUMSIZE(newSize - oldSize);
-        kfree((vm_offset_t)dictionary, oldSize);
+        OSCONTAINER_ACCUMSIZE(((size_t)newSize) - ((size_t)oldSize));
+        kfree(dictionary, oldSize);
 
         dictionary = newDict;
-        capacity = newCapacity;
+        capacity = finalCapacity;
     }
 
     return capacity;
@@ -287,88 +310,117 @@
     haveUpdated();
 
     for (unsigned int i = 0; i < count; i++) {
-        dictionary[i].key->release();
-        dictionary[i].value->release();
+        dictionary[i].key->taggedRelease(OSTypeID(OSCollection));
+        dictionary[i].value->taggedRelease(OSTypeID(OSCollection));
     }
     count = 0;
+}
+
+bool OSDictionary::
+setObject(const OSSymbol *aKey, const OSMetaClassBase *anObject, bool onlyAdd)
+{
+    unsigned int i;
+    bool exists;
+
+    if (!anObject || !aKey)
+        return false;
+
+    // if the key exists, replace the object
+
+    if (fOptions & kSort) {
+    	i = OSSymbol::bsearch(aKey, &dictionary[0], count, sizeof(dictionary[0]));
+	exists = (i < count) && (aKey == dictionary[i].key);
+    } else for (exists = false, i = 0; i < count; i++) {
+        if ((exists = (aKey == dictionary[i].key))) break;
+    }
+
+    if (exists) {
+
+	if (onlyAdd) return false;
+
+	const OSMetaClassBase *oldObject = dictionary[i].value;
+    
+	haveUpdated();
+    
+	anObject->taggedRetain(OSTypeID(OSCollection));
+	dictionary[i].value = anObject;
+    
+	oldObject->taggedRelease(OSTypeID(OSCollection));
+	return true;
+    }
+
+    // add new key, possibly extending our capacity
+    if (count >= capacity && count >= ensureCapacity(count+1))
+        return false;
+
+    haveUpdated();
+
+    bcopy(&dictionary[i], &dictionary[i+1], (count - i) * sizeof(dictionary[0]));
+
+    aKey->taggedRetain(OSTypeID(OSCollection));
+    anObject->taggedRetain(OSTypeID(OSCollection));
+    dictionary[i].key = aKey;
+    dictionary[i].value = anObject;
+    count++;
+
+    return true;
 }
 
 bool OSDictionary::
 setObject(const OSSymbol *aKey, const OSMetaClassBase *anObject)
 {
-    if (!anObject || !aKey)
-        return false;
-
-    // if the key exists, replace the object
-    for (unsigned int i = 0; i < count; i++) {
-        if (aKey == dictionary[i].key) {
-            const OSMetaClassBase *oldObject = dictionary[i].value;
-
-            anObject->retain();
-            dictionary[i].value = anObject;
-
-            haveUpdated();
-
-            oldObject->release();
-            return true;
-        }
-    }
-
-    // add new key, possibly extending our capacity
-    if (count >= capacity && count >= ensureCapacity(count+1))
-        return 0;
-
-    aKey->retain();
-    anObject->retain();
-    dictionary[count].key = aKey;
-    dictionary[count].value = anObject;
-    count++;
-
-    haveUpdated();
-
-    return true;
+    return (setObject(aKey, anObject, false));
 }
 
 void OSDictionary::removeObject(const OSSymbol *aKey)
 {
+    unsigned int i;
+    bool exists;
+
     if (!aKey)
         return;
 
     // if the key exists, remove the object
-    for (unsigned int i = 0; i < count; i++)
-        if (aKey == dictionary[i].key) {
-            dictEntry oldEntry = dictionary[i];
-
-            haveUpdated();
-
-            count--;
-            for (; i < count; i++)
-                dictionary[i] = dictionary[i+1];
-
-            oldEntry.key->release();
-            oldEntry.value->release();
-            return;
-        }
+
+    if (fOptions & kSort) {
+    	i = OSSymbol::bsearch(aKey, &dictionary[0], count, sizeof(dictionary[0]));
+	exists = (i < count) && (aKey == dictionary[i].key);
+    } else for (exists = false, i = 0; i < count; i++) {
+        if ((exists = (aKey == dictionary[i].key))) break;
+    }
+
+    if (exists) {
+	dictEntry oldEntry = dictionary[i];
+
+	haveUpdated();
+
+	count--;
+	bcopy(&dictionary[i+1], &dictionary[i], (count - i) * sizeof(dictionary[0]));
+
+	oldEntry.key->taggedRelease(OSTypeID(OSCollection));
+	oldEntry.value->taggedRelease(OSTypeID(OSCollection));
+	return;
+    }
 }
 
 
 // Returns true on success, false on an error condition.
-bool OSDictionary::merge(const OSDictionary *aDictionary)
+bool OSDictionary::merge(const OSDictionary *srcDict)
 {
     const OSSymbol * sym;
     OSCollectionIterator * iter;
 
-    if ( !OSDynamicCast(OSDictionary, (OSDictionary *) aDictionary) )
-        return false;
-    
-    iter = OSCollectionIterator::withCollection((OSDictionary *)aDictionary);
+    if ( !OSDynamicCast(OSDictionary, srcDict) )
+        return false;
+
+    iter = OSCollectionIterator::withCollection(const_cast<OSDictionary *>(srcDict));
     if ( !iter )
         return false;
 
     while ( (sym = (const OSSymbol *)iter->getNextObject()) ) {
         const OSMetaClassBase * obj;
 
-        obj = aDictionary->getObject(sym);
+        obj = srcDict->getObject(sym);
         if ( !setObject(sym, obj) ) {
             iter->release();
             return false;
@@ -381,13 +433,24 @@
 
 OSObject *OSDictionary::getObject(const OSSymbol *aKey) const
 {
+    unsigned int i;
+    bool exists;
+
     if (!aKey)
         return 0;
 
-    // if the key exists, remove the object
-    for (unsigned int i = 0; i < count; i++)
-        if (aKey == dictionary[i].key)
-            return (OSObject *) dictionary[i].value;
+    // if the key exists, return the object
+
+    if (fOptions & kSort) {
+    	i = OSSymbol::bsearch(aKey, &dictionary[0], count, sizeof(dictionary[0]));
+	exists = (i < count) && (aKey == dictionary[i].key);
+    } else for (exists = false, i = 0; i < count; i++) {
+        if ((exists = (aKey == dictionary[i].key))) break;
+    }
+
+    if (exists) {
+	return (const_cast<OSObject *> ((const OSObject *)dictionary[i].value));
+    }
 
     return 0;
 }
@@ -435,7 +498,7 @@
     OBJECT_WRAP_3(removeObject, OSSymbol::withCString(aKey))
 
 bool
-OSDictionary::isEqualTo(const OSDictionary *aDictionary, const OSCollection *keys) const
+OSDictionary::isEqualTo(const OSDictionary *srcDict, const OSCollection *keys) const
 {
     OSCollectionIterator * iter;
     unsigned int keysCount;
@@ -444,11 +507,11 @@
     OSString * aKey;
     bool ret;
 
-    if ( this == aDictionary )
+    if ( this == srcDict )
         return true;
 
     keysCount = keys->getCount();
-    if ( (count < keysCount) || (aDictionary->getCount() < keysCount) )
+    if ( (count < keysCount) || (srcDict->getCount() < keysCount) )
         return false;
 
     iter = OSCollectionIterator::withCollection(keys);
@@ -458,7 +521,7 @@
     ret = true;
     while ( (aKey = OSDynamicCast(OSString, iter->getNextObject())) ) {
         obj1 = getObject(aKey);
-        obj2 = aDictionary->getObject(aKey);
+        obj2 = srcDict->getObject(aKey);
         if ( !obj1 || !obj2 ) {
             ret = false;
             break;
@@ -474,19 +537,19 @@
     return ret;
 }
 
-bool OSDictionary::isEqualTo(const OSDictionary *aDictionary) const
+bool OSDictionary::isEqualTo(const OSDictionary *srcDict) const
 {
     unsigned int i;
     const OSMetaClassBase * obj;
     
-    if ( this == aDictionary )
+    if ( this == srcDict )
         return true;
 
-    if ( count != aDictionary->getCount() )
+    if ( count != srcDict->getCount() )
         return false;
 
     for ( i = 0; i < count; i++ ) {
-        obj = aDictionary->getObject(dictionary[i].key);
+        obj = srcDict->getObject(dictionary[i].key);
         if ( !obj )
             return false;
 
@@ -568,3 +631,95 @@
 
     return s->addXMLEndTag("dict");
 }
+
+unsigned OSDictionary::setOptions(unsigned options, unsigned mask, void *)
+{
+    unsigned old = super::setOptions(options, mask);
+    if ((old ^ options) & mask) {
+
+	// Value changed need to recurse over all of the child collections
+	for ( unsigned i = 0; i < count; i++ ) {
+	    OSCollection *v = OSDynamicCast(OSCollection, dictionary[i].value);
+	    if (v)
+		v->setOptions(options, mask);
+	}
+    }
+
+    return old;
+}
+
+OSCollection * OSDictionary::copyCollection(OSDictionary *cycleDict)
+{
+    bool allocDict = !cycleDict;
+    OSCollection *ret = 0;
+    OSDictionary *newDict = 0;
+
+    if (allocDict) {
+	cycleDict = OSDictionary::withCapacity(16);
+	if (!cycleDict)
+	    return 0;
+    }
+
+    do {
+	// Check for a cycle
+	ret = super::copyCollection(cycleDict);
+	if (ret)
+	    continue;
+	
+	newDict = OSDictionary::withDictionary(this);
+	if (!newDict)
+	    continue;
+
+	// Insert object into cycle Dictionary
+	cycleDict->setObject((const OSSymbol *) this, newDict);
+
+	for (unsigned int i = 0; i < count; i++) {
+	    const OSMetaClassBase *obj = dictionary[i].value;
+	    OSCollection *coll = OSDynamicCast(OSCollection, EXT_CAST(obj));
+
+	    if (coll) {
+		OSCollection *newColl = coll->copyCollection(cycleDict);
+		if (!newColl)
+		    goto abortCopy;
+
+		newDict->dictionary[i].value = newColl;
+
+		coll->taggedRelease(OSTypeID(OSCollection));
+		newColl->taggedRetain(OSTypeID(OSCollection));
+		newColl->release();
+	    };
+	}
+
+	ret = newDict;
+	newDict = 0;
+
+    } while (false);
+
+abortCopy:
+    if (newDict)
+	newDict->release();
+
+    if (allocDict)
+	cycleDict->release();
+
+    return ret;
+}
+
+OSArray * OSDictionary::copyKeys(void)
+{
+    OSArray * array;
+
+	array = OSArray::withCapacity(count);
+	if (!array) return (0);
+
+	for (unsigned int i = 0; i < count; i++)
+	{
+	    if (!array->setObject(i, dictionary[i].key))
+	    {
+            array->release();
+            array = 0;
+            break;
+        }
+	}
+    return (array);
+}