include/llvm/ADT/StringMap.h

   1 //===--- StringMap.h - String Hash table map interface ----------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   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.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the StringMap class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ADT_STRINGMAP_H
  15 #define LLVM_ADT_STRINGMAP_H
  16
  17 #include "llvm/Support/Allocator.h"
  18 #include <cstring>
  19
  20 namespace llvm {
  21   template<typename ValueT>
  22   class StringMapConstIterator;
  23   template<typename ValueT>
  24   class StringMapIterator;
  25
  26
  27 /// StringMapEntryBase - Shared base class of StringMapEntry instances.
  28 class StringMapEntryBase {
  29   unsigned StrLen;
  30 public:
  31   explicit StringMapEntryBase(unsigned Len) : StrLen(Len) {}
  32
  33   unsigned getKeyLength() const { return StrLen; }
  34 };
  35
  36 /// StringMapImpl - This is the base class of StringMap that is shared among
  37 /// all of its instantiations.
  38 class StringMapImpl {
  39 public:
  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.
  42   struct ItemBucket {
  43     /// FullHashValue - This remembers the full hash value of the key for
  44     /// easy scanning.
  45     unsigned FullHashValue;
  46
  47     /// Item - This is a pointer to the actual item object.
  48     StringMapEntryBase *Item;
  49   };
  50
  51 protected:
  52   ItemBucket *TheTable;
  53   unsigned NumBuckets;
  54   unsigned NumItems;
  55   unsigned NumTombstones;
  56   unsigned ItemSize;
  57 protected:
  58   explicit StringMapImpl(unsigned itemSize) : ItemSize(itemSize) {
  59     // Initialize the map with zero buckets to allocation.
  60     TheTable = 0;
  61     NumBuckets = 0;
  62     NumItems = 0;
  63     NumTombstones = 0;
  64   }
  65   StringMapImpl(unsigned InitSize, unsigned ItemSize);
  66   void RehashTable();
  67
  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),
  73     // grow the table.
  74     return NumItems*4 > NumBuckets*3 ||
  75            NumBuckets-(NumItems+NumTombstones) < NumBuckets/8;
  76   }
  77
  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
  82   /// of the string.
  83   unsigned LookupBucketFor(const char *KeyStart, const char *KeyEnd);
  84
  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;
  89
  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);
  93
  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);
  97 private:
  98   void init(unsigned Size);
  99 public:
 100   static StringMapEntryBase *getTombstoneVal() {
 101     return (StringMapEntryBase*)-1;
 102   }
 103
 104   unsigned getNumBuckets() const { return NumBuckets; }
 105   unsigned getNumItems() const { return NumItems; }
 106
 107   bool empty() const { return NumItems == 0; }
 108   unsigned size() const { return NumItems; }
 109 };
 110
 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
 113 /// and data.
 114 template<typename ValueTy>
 115 class StringMapEntry : public StringMapEntryBase {
 116   ValueTy Val;
 117 public:
 118   explicit StringMapEntry(unsigned StrLen)
 119     : StringMapEntryBase(StrLen), Val() {}
 120   StringMapEntry(unsigned StrLen, const ValueTy &V)
 121     : StringMapEntryBase(StrLen), Val(V) {}
 122
 123   const ValueTy &getValue() const { return Val; }
 124   ValueTy &getValue() { return Val; }
 125
 126   void setValue(const ValueTy &V) { Val = V; }
 127
 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);}
 132
 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;
 139
 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
 142     // terminator.
 143
 144     unsigned AllocSize = sizeof(StringMapEntry)+KeyLength+1;
 145     unsigned Alignment = alignof<StringMapEntry>();
 146
 147     StringMapEntry *NewItem =
 148       static_cast<StringMapEntry*>(Allocator.Allocate(AllocSize,Alignment));
 149
 150     // Default construct the value.
 151     new (NewItem) StringMapEntry(KeyLength);
 152
 153     // Copy the string information.
 154     char *StrBuffer = const_cast<char*>(NewItem->getKeyData());
 155     memcpy(StrBuffer, KeyStart, KeyLength);
 156     StrBuffer[KeyLength] = 0;  // Null terminate for convenience of clients.
 157     return NewItem;
 158   }
 159
 160   /// Create - Create a StringMapEntry with normal malloc/free.
 161   static StringMapEntry *Create(const char *KeyStart, const char *KeyEnd) {
 162     MallocAllocator A;
 163     return Create(KeyStart, KeyEnd, A);
 164   }
 165
 166
 167   /// GetStringMapEntryFromValue - Given a value that is known to be embedded
 168   /// into a StringMapEntry, return the StringMapEntry itself.
 169   static StringMapEntry &GetStringMapEntryFromValue(ValueTy &V) {
 170     StringMapEntry *EPtr = 0;
 171     char *Ptr = reinterpret_cast<char*>(&V) -
 172                   (reinterpret_cast<char*>(&EPtr->Val) -
 173                    reinterpret_cast<char*>(EPtr));
 174     return *reinterpret_cast<StringMapEntry*>(Ptr);
 175   }
 176   static const StringMapEntry &GetStringMapEntryFromValue(const ValueTy &V) {
 177     return GetStringMapEntryFromValue(const_cast<ValueTy&>(V));
 178   }
 179
 180   /// Destroy - Destroy this StringMapEntry, releasing memory back to the
 181   /// specified allocator.
 182   template<typename AllocatorTy>
 183   void Destroy(AllocatorTy &Allocator) {
 184     // Free memory referenced by the item.
 185     this->~StringMapEntry();
 186     Allocator.Deallocate(this);
 187   }
 188
 189   /// Destroy this object, releasing memory back to the malloc allocator.
 190   void Destroy() {
 191     MallocAllocator A;
 192     Destroy(A);
 193   }
 194 };
 195
 196
 197 /// StringMap - This is an unconventional map that is specialized for handling
 198 /// keys that are "strings", which are basically ranges of bytes. This does some
 199 /// funky memory allocation and hashing things to make it extremely efficient,
 200 /// storing the string data *after* the value in the map.
 201 template<typename ValueTy, typename AllocatorTy = MallocAllocator>
 202 class StringMap : public StringMapImpl {
 203   AllocatorTy Allocator;
 204   typedef StringMapEntry<ValueTy> MapEntryTy;
 205 public:
 206   StringMap() : StringMapImpl(sizeof(MapEntryTy)) {}
 207   explicit StringMap(unsigned InitialSize)
 208     : StringMapImpl(InitialSize, sizeof(MapEntryTy)) {}
 209
 210   AllocatorTy &getAllocator() { return Allocator; }
 211   const AllocatorTy &getAllocator() const { return Allocator; }
 212
 213   typedef StringMapConstIterator<ValueTy> const_iterator;
 214   typedef StringMapIterator<ValueTy> iterator;
 215
 216   iterator begin() {
 217     return iterator(TheTable, NumBuckets == 0);
 218   }
 219   iterator end() {
 220     return iterator(TheTable+NumBuckets, true);
 221   }
 222   const_iterator begin() const {
 223     return const_iterator(TheTable, NumBuckets == 0);
 224   }
 225   const_iterator end() const {
 226     return const_iterator(TheTable+NumBuckets, true);
 227   }
 228
 229   iterator find(const char *KeyStart, const char *KeyEnd) {
 230     int Bucket = FindKey(KeyStart, KeyEnd);
 231     if (Bucket == -1) return end();
 232     return iterator(TheTable+Bucket);
 233   }
 234
 235   const_iterator find(const char *KeyStart, const char *KeyEnd) const {
 236     int Bucket = FindKey(KeyStart, KeyEnd);
 237     if (Bucket == -1) return end();
 238     return const_iterator(TheTable+Bucket);
 239   }
 240
 241   /// insert - Insert the specified key/value pair into the map.  If the key
 242   /// already exists in the map, return false and ignore the request, otherwise
 243   /// insert it and return true.
 244   bool insert(MapEntryTy *KeyValue) {
 245     unsigned BucketNo =
 246       LookupBucketFor(KeyValue->getKeyData(),
 247                       KeyValue->getKeyData()+KeyValue->getKeyLength());
 248     ItemBucket &Bucket = TheTable[BucketNo];
 249     if (Bucket.Item && Bucket.Item != getTombstoneVal())
 250       return false;  // Already exists in map.
 251
 252     if (Bucket.Item == getTombstoneVal())
 253       --NumTombstones;
 254     Bucket.Item = KeyValue;
 255     ++NumItems;
 256
 257     if (ShouldRehash())
 258       RehashTable();
 259     return true;
 260   }
 261
 262   /// GetOrCreateValue - Look up the specified key in the table.  If a value
 263   /// exists, return it.  Otherwise, default construct a value, insert it, and
 264   /// return.
 265   StringMapEntry<ValueTy> &GetOrCreateValue(const char *KeyStart,
 266                                             const char *KeyEnd) {
 267     unsigned BucketNo = LookupBucketFor(KeyStart, KeyEnd);
 268     ItemBucket &Bucket = TheTable[BucketNo];
 269     if (Bucket.Item && Bucket.Item != getTombstoneVal())
 270       return *static_cast<MapEntryTy*>(Bucket.Item);
 271
 272     MapEntryTy *NewItem = MapEntryTy::Create(KeyStart, KeyEnd, Allocator);
 273
 274     if (Bucket.Item == getTombstoneVal())
 275       --NumTombstones;
 276     ++NumItems;
 277
 278     // Fill in the bucket for the hash table.  The FullHashValue was already
 279     // filled in by LookupBucketFor.
 280     Bucket.Item = NewItem;
 281
 282     if (ShouldRehash())
 283       RehashTable();
 284     return *NewItem;
 285   }
 286
 287   /// remove - Remove the specified key/value pair from the map, but do not
 288   /// erase it.  This aborts if the key is not in the map.
 289   void remove(MapEntryTy *KeyValue) {
 290     RemoveKey(KeyValue);
 291   }
 292
 293   void erase(iterator I) {
 294     MapEntryTy &V = *I;
 295     remove(&V);
 296     V.Destroy(Allocator);
 297   }
 298
 299   ~StringMap() {
 300     for (ItemBucket *I = TheTable, *E = TheTable+NumBuckets; I != E; ++I) {
 301       if (I->Item && I->Item != getTombstoneVal())
 302         static_cast<MapEntryTy*>(I->Item)->Destroy(Allocator);
 303     }
 304     free(TheTable);
 305   }
 306 private:
 307   StringMap(const StringMap &);  // FIXME: Implement.
 308   void operator=(const StringMap &);  // FIXME: Implement.
 309 };
 310
 311
 312 template<typename ValueTy>
 313 class StringMapConstIterator {
 314 protected:
 315   StringMapImpl::ItemBucket *Ptr;
 316 public:
 317   explicit StringMapConstIterator(StringMapImpl::ItemBucket *Bucket,
 318                                   bool NoAdvance = false)
 319   : Ptr(Bucket) {
 320     if (!NoAdvance) AdvancePastEmptyBuckets();
 321   }
 322
 323   const StringMapEntry<ValueTy> &operator*() const {
 324     return *static_cast<StringMapEntry<ValueTy>*>(Ptr->Item);
 325   }
 326   const StringMapEntry<ValueTy> *operator->() const {
 327     return static_cast<StringMapEntry<ValueTy>*>(Ptr->Item);
 328   }
 329
 330   bool operator==(const StringMapConstIterator &RHS) const {
 331     return Ptr == RHS.Ptr;
 332   }
 333   bool operator!=(const StringMapConstIterator &RHS) const {
 334     return Ptr != RHS.Ptr;
 335   }
 336
 337   inline StringMapConstIterator& operator++() {          // Preincrement
 338     ++Ptr;
 339     AdvancePastEmptyBuckets();
 340     return *this;
 341   }
 342   StringMapConstIterator operator++(int) {        // Postincrement
 343     StringMapConstIterator tmp = *this; ++*this; return tmp;
 344   }
 345
 346 private:
 347   void AdvancePastEmptyBuckets() {
 348     while (Ptr->Item == 0 || Ptr->Item == StringMapImpl::getTombstoneVal())
 349       ++Ptr;
 350   }
 351 };
 352
 353 template<typename ValueTy>
 354 class StringMapIterator : public StringMapConstIterator<ValueTy> {
 355 public:
 356   StringMapIterator(StringMapImpl::ItemBucket *Bucket,
 357                     bool NoAdvance = false)
 358     : StringMapConstIterator<ValueTy>(Bucket, NoAdvance) {
 359   }
 360   StringMapEntry<ValueTy> &operator*() const {
 361     return *static_cast<StringMapEntry<ValueTy>*>(this->Ptr->Item);
 362   }
 363   StringMapEntry<ValueTy> *operator->() const {
 364     return static_cast<StringMapEntry<ValueTy>*>(this->Ptr->Item);
 365   }
 366 };
 367
 368 }
 369
 370 #endif
 371