libkern/c++/OSCollection.cpp

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* IOArray.h created by rsulack on Thu 11-Sep-1997 */
  29
  30 #include <libkern/OSDebug.h>
  31
  32 #include <libkern/c++/OSCollection.h>
  33 #include <libkern/c++/OSDictionary.h>
  34
  35 #include <IOKit/IOKitDebug.h>
  36
  37 #define super OSObject
  38
  39 OSDefineMetaClassAndAbstractStructors(OSCollection, OSObject)
  40
  41
  42 OSMetaClassDefineReservedUsed(OSCollection, 0);
  43 OSMetaClassDefineReservedUsed(OSCollection, 1);
  44 OSMetaClassDefineReservedUnused(OSCollection, 2);
  45 OSMetaClassDefineReservedUnused(OSCollection, 3);
  46 OSMetaClassDefineReservedUnused(OSCollection, 4);
  47 OSMetaClassDefineReservedUnused(OSCollection, 5);
  48 OSMetaClassDefineReservedUnused(OSCollection, 6);
  49 OSMetaClassDefineReservedUnused(OSCollection, 7);
  50
  51 bool
  52 OSCollection::init()
  53 {
  54         if (!super::init()) {
  55                 return false;
  56         }
  57
  58         updateStamp = 0;
  59
  60         return true;
  61 }
  62
  63 void
  64 OSCollection::haveUpdated()
  65 {
  66         if (fOptions & kImmutable) {
  67                 if (!(gIOKitDebug & kOSRegistryModsMode)) {
  68                         panic("Trying to change a collection in the registry");
  69                 } else {
  70                         OSReportWithBacktrace("Trying to change a collection in the registry");
  71                 }
  72         }
  73         updateStamp++;
  74 }
  75
  76 unsigned
  77 OSCollection::setOptions(unsigned options, unsigned mask, void *)
  78 {
  79         unsigned old = fOptions;
  80
  81         if (mask) {
  82                 fOptions = (old & ~mask) | (options & mask);
  83         }
  84
  85         return old;
  86 }
  87
  88 OSCollection *
  89 OSCollection::copyCollection(OSDictionary *cycleDict)
  90 {
  91         if (cycleDict) {
  92                 OSObject *obj = cycleDict->getObject((const OSSymbol *) this);
  93                 if (obj) {
  94                         obj->retain();
  95                 }
  96
  97                 return reinterpret_cast<OSCollection *>(obj);
  98         } else {
  99                 // If we are here it means that there is a collection subclass that
 100                 // hasn't overridden the copyCollection method.  In which case just
 101                 // return a reference to ourselves.
 102                 // Hopefully this collection will not be inserted into the registry
 103                 retain();
 104                 return this;
 105         }
 106 }
 107
 108 bool
 109 OSCollection::iterateObjects(void * refcon, bool (*callback)(void * refcon, OSObject * object))
 110 {
 111         uint64_t     iteratorStore[2];
 112         unsigned int initialUpdateStamp;
 113         bool         done;
 114
 115         assert(iteratorSize() < sizeof(iteratorStore));
 116
 117         if (!initIterator(&iteratorStore[0])) {
 118                 return false;
 119         }
 120
 121         initialUpdateStamp = updateStamp;
 122         done = false;
 123         do{
 124                 OSObject * object;
 125                 if (!getNextObjectForIterator(&iteratorStore[0], &object)) {
 126                         break;
 127                 }
 128                 done = callback(refcon, object);
 129         }while (!done && (initialUpdateStamp == updateStamp));
 130
 131         return initialUpdateStamp == updateStamp;
 132 }
 133
 134 static bool
 135 OSCollectionIterateObjectsBlock(void * refcon, OSObject * object)
 136 {
 137         bool (^block)(OSObject * object) = (typeof(block))refcon;
 138         return block(object);
 139 }
 140
 141 bool
 142 OSCollection::iterateObjects(bool (^block)(OSObject * object))
 143 {
 144         return iterateObjects((void *) block, OSCollectionIterateObjectsBlock);
 145 }