1 //===--- StringMap.h - String Hash table map interface ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Chris Lattner and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the StringMap class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ADT_STRINGMAP_H
15 #define LLVM_ADT_STRINGMAP_H
17 #include "llvm/Support/Allocator.h"
21 template<typename ValueT>
22 class StringMapConstIterator;
23 template<typename ValueT>
24 class StringMapIterator;
27 /// StringMapEntryBase - Shared base class of StringMapEntry instances.
28 class StringMapEntryBase {
31 StringMapEntryBase(unsigned Len) : StrLen(Len) {}
33 unsigned getKeyLength() const { return StrLen; }
36 /// StringMapImpl - This is the base class of StringMap that is shared among
37 /// all of its instantiations.
40 /// ItemBucket - The hash table consists of an array of these. If Item is
41 /// non-null, this is an extant entry, otherwise, it is a hole.
43 /// FullHashValue - This remembers the full hash value of the key for
45 unsigned FullHashValue;
47 /// Item - This is a pointer to the actual item object.
48 StringMapEntryBase *Item;
55 unsigned NumTombstones;
58 StringMapImpl(unsigned itemSize) : ItemSize(itemSize) {
59 // Initialize the map with zero buckets to allocation.
65 StringMapImpl(unsigned InitSize, unsigned ItemSize);
68 /// ShouldRehash - Return true if the table should be rehashed after a new
69 /// element was recently inserted.
70 bool ShouldRehash() const {
71 // If the hash table is now more than 3/4 full, or if fewer than 1/8 of
72 // the buckets are empty (meaning that many are filled with tombstones),
74 return NumItems*4 > NumBuckets*3 ||
75 NumBuckets-(NumItems+NumTombstones) < NumBuckets/8;
78 /// LookupBucketFor - Look up the bucket that the specified string should end
79 /// up in. If it already exists as a key in the map, the Item pointer for the
80 /// specified bucket will be non-null. Otherwise, it will be null. In either
81 /// case, the FullHashValue field of the bucket will be set to the hash value
83 unsigned LookupBucketFor(const char *KeyStart, const char *KeyEnd);
85 /// FindKey - Look up the bucket that contains the specified key. If it exists
86 /// in the map, return the bucket number of the key. Otherwise return -1.
87 /// This does not modify the map.
88 int FindKey(const char *KeyStart, const char *KeyEnd) const;
90 /// RemoveKey - Remove the specified StringMapEntry from the table, but do not
91 /// delete it. This aborts if the value isn't in the table.
92 void RemoveKey(StringMapEntryBase *V);
94 /// RemoveKey - Remove the StringMapEntry for the specified key from the
95 /// table, returning it. If the key is not in the table, this returns null.
96 StringMapEntryBase *RemoveKey(const char *KeyStart, const char *KeyEnd);
98 void init(unsigned Size);
100 static StringMapEntryBase *getTombstoneVal() {
101 return (StringMapEntryBase*)-1;
104 unsigned getNumBuckets() const { return NumBuckets; }
105 unsigned getNumItems() const { return NumItems; }
107 bool empty() const { return NumItems == 0; }
108 unsigned size() const { return NumItems; }
111 /// StringMapEntry - This is used to represent one value that is inserted into
112 /// a StringMap. It contains the Value itself and the key: the string length
114 template<typename ValueTy>
115 class StringMapEntry : public StringMapEntryBase {
118 StringMapEntry(unsigned StrLen)
119 : StringMapEntryBase(StrLen), Val() {}
120 StringMapEntry(unsigned StrLen, const ValueTy &V)
121 : StringMapEntryBase(StrLen), Val(V) {}
123 const ValueTy &getValue() const { return Val; }
124 ValueTy &getValue() { return Val; }
126 void setValue(const ValueTy &V) { Val = V; }
128 /// getKeyData - Return the start of the string data that is the key for this
129 /// value. The string data is always stored immediately after the
130 /// StringMapEntry object.
131 const char *getKeyData() const {return reinterpret_cast<const char*>(this+1);}
133 /// Create - Create a StringMapEntry for the specified key and default
134 /// construct the value.
135 template<typename AllocatorTy>
136 static StringMapEntry *Create(const char *KeyStart, const char *KeyEnd,
137 AllocatorTy &Allocator) {
138 unsigned KeyLength = KeyEnd-KeyStart;
140 // Okay, the item doesn't already exist, and 'Bucket' is the bucket to fill
141 // in. Allocate a new item with space for the string at the end and a null
143 unsigned AllocSize = sizeof(StringMapEntry)+KeyLength+1;
145 StringMapEntry *NewItem = static_cast<StringMapEntry*>(
146 Allocator.Allocate(AllocSize, AlignOf<StringMapEntry>::Alignment));
148 // Default construct the value.
149 new (NewItem) StringMapEntry(KeyLength);
151 // Copy the string information.
152 char *StrBuffer = const_cast<char*>(NewItem->getKeyData());
153 memcpy(StrBuffer, KeyStart, KeyLength);
154 StrBuffer[KeyLength] = 0; // Null terminate for convenience of clients.
158 /// Create - Create a StringMapEntry with normal malloc/free.
159 static StringMapEntry *Create(const char *KeyStart, const char *KeyEnd) {
161 return Create(KeyStart, KeyEnd, A);
165 /// GetStringMapEntryFromValue - Given a value that is known to be embedded
166 /// into a StringMapEntry, return the StringMapEntry itself.
167 static StringMapEntry &GetStringMapEntryFromValue(ValueTy &V) {
168 StringMapEntry *EPtr = 0;
169 char *Ptr = reinterpret_cast<char*>(&V) -
170 (reinterpret_cast<char*>(&EPtr->Val) -
171 reinterpret_cast<char*>(EPtr));
172 return *reinterpret_cast<StringMapEntry*>(Ptr);
174 static const StringMapEntry &GetStringMapEntryFromValue(const ValueTy &V) {
175 return GetStringMapEntryFromValue(const_cast<ValueTy&>(V));
178 /// Destroy - Destroy this StringMapEntry, releasing memory back to the
179 /// specified allocator.
180 template<typename AllocatorTy>
181 void Destroy(AllocatorTy &Allocator) {
182 // Free memory referenced by the item.
183 this->~StringMapEntry();
184 Allocator.Deallocate(this);
187 /// Destroy this object, releasing memory back to the malloc allocator.
195 /// StringMap - This is an unconventional map that is specialized for handling
196 /// keys that are "strings", which are basically ranges of bytes. This does some
197 /// funky memory allocation and hashing things to make it extremely efficient,
198 /// storing the string data *after* the value in the map.
199 template<typename ValueTy, typename AllocatorTy = MallocAllocator>
200 class StringMap : public StringMapImpl {
201 AllocatorTy Allocator;
202 typedef StringMapEntry<ValueTy> MapEntryTy;
204 StringMap() : StringMapImpl(sizeof(MapEntryTy)) {}
205 StringMap(unsigned InitialSize)
206 : StringMapImpl(InitialSize, sizeof(MapEntryTy)) {}
208 AllocatorTy &getAllocator() { return Allocator; }
209 const AllocatorTy &getAllocator() const { return Allocator; }
211 typedef StringMapConstIterator<ValueTy> const_iterator;
212 typedef StringMapIterator<ValueTy> iterator;
215 return iterator(TheTable, NumBuckets == 0);
218 return iterator(TheTable+NumBuckets, true);
220 const_iterator begin() const {
221 return const_iterator(TheTable, NumBuckets == 0);
223 const_iterator end() const {
224 return const_iterator(TheTable+NumBuckets, true);
227 iterator find(const char *KeyStart, const char *KeyEnd) {
228 int Bucket = FindKey(KeyStart, KeyEnd);
229 if (Bucket == -1) return end();
230 return iterator(TheTable+Bucket);
233 const_iterator find(const char *KeyStart, const char *KeyEnd) const {
234 int Bucket = FindKey(KeyStart, KeyEnd);
235 if (Bucket == -1) return end();
236 return const_iterator(TheTable+Bucket);
239 /// insert - Insert the specified key/value pair into the map. If the key
240 /// already exists in the map, return false and ignore the request, otherwise
241 /// insert it and return true.
242 bool insert(MapEntryTy *KeyValue) {
244 LookupBucketFor(KeyValue->getKeyData(),
245 KeyValue->getKeyData()+KeyValue->getKeyLength());
246 ItemBucket &Bucket = TheTable[BucketNo];
247 if (Bucket.Item && Bucket.Item != getTombstoneVal())
248 return false; // Already exists in map.
250 if (Bucket.Item == getTombstoneVal())
252 Bucket.Item = KeyValue;
260 /// GetOrCreateValue - Look up the specified key in the table. If a value
261 /// exists, return it. Otherwise, default construct a value, insert it, and
263 StringMapEntry<ValueTy> &GetOrCreateValue(const char *KeyStart,
264 const char *KeyEnd) {
265 unsigned BucketNo = LookupBucketFor(KeyStart, KeyEnd);
266 ItemBucket &Bucket = TheTable[BucketNo];
267 if (Bucket.Item && Bucket.Item != getTombstoneVal())
268 return *static_cast<MapEntryTy*>(Bucket.Item);
270 MapEntryTy *NewItem = MapEntryTy::Create(KeyStart, KeyEnd, Allocator);
272 if (Bucket.Item == getTombstoneVal())
276 // Fill in the bucket for the hash table. The FullHashValue was already
277 // filled in by LookupBucketFor.
278 Bucket.Item = NewItem;
285 /// remove - Remove the specified key/value pair from the map, but do not
286 /// erase it. This aborts if the key is not in the map.
287 void remove(MapEntryTy *KeyValue) {
291 void erase(iterator I) {
294 V.Destroy(Allocator);
298 for (ItemBucket *I = TheTable, *E = TheTable+NumBuckets; I != E; ++I) {
299 if (I->Item && I->Item != getTombstoneVal())
300 static_cast<MapEntryTy*>(I->Item)->Destroy(Allocator);
305 StringMap(const StringMap &); // FIXME: Implement.
306 void operator=(const StringMap &); // FIXME: Implement.
310 template<typename ValueTy>
311 class StringMapConstIterator {
313 StringMapImpl::ItemBucket *Ptr;
315 StringMapConstIterator(StringMapImpl::ItemBucket *Bucket,
316 bool NoAdvance = false)
318 if (!NoAdvance) AdvancePastEmptyBuckets();
321 const StringMapEntry<ValueTy> &operator*() const {
322 return *static_cast<StringMapEntry<ValueTy>*>(Ptr->Item);
324 const StringMapEntry<ValueTy> *operator->() const {
325 return static_cast<StringMapEntry<ValueTy>*>(Ptr->Item);
328 bool operator==(const StringMapConstIterator &RHS) const {
329 return Ptr == RHS.Ptr;
331 bool operator!=(const StringMapConstIterator &RHS) const {
332 return Ptr != RHS.Ptr;
335 inline StringMapConstIterator& operator++() { // Preincrement
337 AdvancePastEmptyBuckets();
340 StringMapConstIterator operator++(int) { // Postincrement
341 StringMapConstIterator tmp = *this; ++*this; return tmp;
345 void AdvancePastEmptyBuckets() {
346 while (Ptr->Item == 0 || Ptr->Item == StringMapImpl::getTombstoneVal())
351 template<typename ValueTy>
352 class StringMapIterator : public StringMapConstIterator<ValueTy> {
354 StringMapIterator(StringMapImpl::ItemBucket *Bucket,
355 bool NoAdvance = false)
356 : StringMapConstIterator<ValueTy>(Bucket, NoAdvance) {
358 StringMapEntry<ValueTy> &operator*() const {
359 return *static_cast<StringMapEntry<ValueTy>*>(this->Ptr->Item);
361 StringMapEntry<ValueTy> *operator->() const {
362 return static_cast<StringMapEntry<ValueTy>*>(this->Ptr->Item);