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 #define IOKIT_ENABLE_SHARED_PTR 31 32 #include <libkern/OSDebug.h> 33 34 #include <libkern/c++/OSCollection.h> 35 #include <libkern/c++/OSDictionary.h> 36 37 #include <IOKit/IOKitDebug.h> 38 39 #define super OSObject 40 41 OSDefineMetaClassAndAbstractStructors(OSCollection, OSObject) 42 43 44 OSMetaClassDefineReservedUsedX86(OSCollection, 0); 45 OSMetaClassDefineReservedUsedX86(OSCollection, 1); 46 OSMetaClassDefineReservedUnused(OSCollection, 2); 47 OSMetaClassDefineReservedUnused(OSCollection, 3); 48 OSMetaClassDefineReservedUnused(OSCollection, 4); 49 OSMetaClassDefineReservedUnused(OSCollection, 5); 50 OSMetaClassDefineReservedUnused(OSCollection, 6); 51 OSMetaClassDefineReservedUnused(OSCollection, 7); 52 53 bool 54 OSCollection::init() 55 { 56 if (!super::init()) { 57 return false; 58 } 59 60 updateStamp = 0; 61 62 return true; 63 } 64 65 void 66 OSCollection::haveUpdated() 67 { 68 if (fOptions & kImmutable) { 69 if (!(gIOKitDebug & kOSRegistryModsMode)) { 70 panic("Trying to change a collection in the registry"); 71 } else { 72 OSReportWithBacktrace("Trying to change a collection in the registry"); 73 } 74 } 75 updateStamp++; 76 } 77 78 unsigned 79 OSCollection::setOptions(unsigned options, unsigned mask, void *) 80 { 81 unsigned old = fOptions; 82 83 if (mask) { 84 fOptions = (old & ~mask) | (options & mask); 85 } 86 87 return old; 88 } 89 90 OSSharedPtr<OSCollection> 91 OSCollection::copyCollection(OSDictionary *cycleDict) 92 { 93 if (cycleDict) { 94 OSObject *obj = cycleDict->getObject((const OSSymbol *) this); 95 96 return OSSharedPtr<OSCollection>(reinterpret_cast<OSCollection *>(obj), OSRetain); 97 } else { 98 // If we are here it means that there is a collection subclass that 99 // hasn't overridden the copyCollection method. In which case just 100 // return a reference to ourselves. 101 // Hopefully this collection will not be inserted into the registry 102 return OSSharedPtr<OSCollection>(this, OSRetain); 103 } 104 } 105 106 bool 107 OSCollection::iterateObjects(void * refcon, bool (*callback)(void * refcon, OSObject * object)) 108 { 109 uint64_t iteratorStore[2]; 110 unsigned int initialUpdateStamp; 111 bool done; 112 113 assert(iteratorSize() < sizeof(iteratorStore)); 114 115 if (!initIterator(&iteratorStore[0])) { 116 return false; 117 } 118 119 initialUpdateStamp = updateStamp; 120 done = false; 121 do{ 122 OSObject * object; 123 if (!getNextObjectForIterator(&iteratorStore[0], &object)) { 124 break; 125 } 126 done = callback(refcon, object); 127 }while (!done && (initialUpdateStamp == updateStamp)); 128 129 return initialUpdateStamp == updateStamp; 130 } 131 132 static bool 133 OSCollectionIterateObjectsBlock(void * refcon, OSObject * object) 134 { 135 bool (^block)(OSObject * object) = (typeof(block))refcon; 136 return block(object); 137 } 138 139 bool 140 OSCollection::iterateObjects(bool (^block)(OSObject * object)) 141 { 142 return iterateObjects((void *) block, OSCollectionIterateObjectsBlock); 143 } 144