lib/Support/FoldingSet.cpp

   1 //===-- Support/FoldingSet.cpp - Uniquing Hash Set --------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements a hash set that can be used to remove duplication of
  11 // nodes in a graph.  This code was originally created by Chris Lattner for use
  12 // with SelectionDAGCSEMap, but was isolated to provide use across the llvm code
  13 // set.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "llvm/ADT/FoldingSet.h"
  18 #include "llvm/Support/MathExtras.h"
  19 #include <cassert>
  20 #include <cstring>
  21 using namespace llvm;
  22
  23 //===----------------------------------------------------------------------===//
  24 // FoldingSetNodeID Implementation
  25
  26 /// Add* - Add various data types to Bit data.
  27 ///
  28 void FoldingSetNodeID::AddPointer(const void *Ptr) {
  29   // Note: this adds pointers to the hash using sizes and endianness that
  30   // depend on the host.  It doesn't matter however, because hashing on
  31   // pointer values in inherently unstable.  Nothing  should depend on the
  32   // ordering of nodes in the folding set.
  33   intptr_t PtrI = (intptr_t)Ptr;
  34   Bits.push_back(unsigned(PtrI));
  35   if (sizeof(intptr_t) > sizeof(unsigned))
  36     Bits.push_back(unsigned(uint64_t(PtrI) >> 32));
  37 }
  38 void FoldingSetNodeID::AddInteger(signed I) {
  39   Bits.push_back(I);
  40 }
  41 void FoldingSetNodeID::AddInteger(unsigned I) {
  42   Bits.push_back(I);
  43 }
  44 void FoldingSetNodeID::AddInteger(long I) {
  45   AddInteger((unsigned long)I);
  46 }
  47 void FoldingSetNodeID::AddInteger(unsigned long I) {
  48   if (sizeof(long) == sizeof(int))
  49     AddInteger(unsigned(I));
  50   else if (sizeof(long) == sizeof(long long)) {
  51     AddInteger((unsigned long long)I);
  52   } else {
  53     assert(0 && "unexpected sizeof(long)");
  54   }
  55 }
  56 void FoldingSetNodeID::AddInteger(long long I) {
  57   AddInteger((unsigned long long)I);
  58 }
  59 void FoldingSetNodeID::AddInteger(unsigned long long I) {
  60   AddInteger(unsigned(I));
  61   if ((uint64_t)(int)I != I)
  62     Bits.push_back(unsigned(I >> 32));
  63 }
  64
  65 void FoldingSetNodeID::AddString(const char *String, const char *End) {
  66   unsigned Size =  static_cast<unsigned>(End - String);
  67   Bits.push_back(Size);
  68   if (!Size) return;
  69
  70   unsigned Units = Size / 4;
  71   unsigned Pos = 0;
  72   const unsigned *Base = (const unsigned *)String;
  73
  74   // If the string is aligned do a bulk transfer.
  75   if (!((intptr_t)Base & 3)) {
  76     Bits.append(Base, Base + Units);
  77     Pos = (Units + 1) * 4;
  78   } else {
  79     // Otherwise do it the hard way.
  80     for (Pos += 4; Pos <= Size; Pos += 4) {
  81       unsigned V = ((unsigned char)String[Pos - 4] << 24) |
  82                    ((unsigned char)String[Pos - 3] << 16) |
  83                    ((unsigned char)String[Pos - 2] << 8) |
  84                     (unsigned char)String[Pos - 1];
  85       Bits.push_back(V);
  86     }
  87   }
  88
  89   // With the leftover bits.
  90   unsigned V = 0;
  91   // Pos will have overshot size by 4 - #bytes left over.
  92   switch (Pos - Size) {
  93   case 1: V = (V << 8) | (unsigned char)String[Size - 3]; // Fall thru.
  94   case 2: V = (V << 8) | (unsigned char)String[Size - 2]; // Fall thru.
  95   case 3: V = (V << 8) | (unsigned char)String[Size - 1]; break;
  96   default: return; // Nothing left.
  97   }
  98
  99   Bits.push_back(V);
 100 }
 101
 102 void FoldingSetNodeID::AddString(const char *String) {
 103   AddString(String, String + strlen(String));
 104 }
 105
 106 void FoldingSetNodeID::AddString(const std::string &String) {
 107   AddString(&*String.begin(), &*String.end());
 108 }
 109
 110 /// ComputeHash - Compute a strong hash value for this FoldingSetNodeID, used to
 111 /// lookup the node in the FoldingSetImpl.
 112 unsigned FoldingSetNodeID::ComputeHash() const {
 113   // This is adapted from SuperFastHash by Paul Hsieh.
 114   unsigned Hash = static_cast<unsigned>(Bits.size());
 115   for (const unsigned *BP = &Bits[0], *E = BP+Bits.size(); BP != E; ++BP) {
 116     unsigned Data = *BP;
 117     Hash         += Data & 0xFFFF;
 118     unsigned Tmp  = ((Data >> 16) << 11) ^ Hash;
 119     Hash          = (Hash << 16) ^ Tmp;
 120     Hash         += Hash >> 11;
 121   }
 122
 123   // Force "avalanching" of final 127 bits.
 124   Hash ^= Hash << 3;
 125   Hash += Hash >> 5;
 126   Hash ^= Hash << 4;
 127   Hash += Hash >> 17;
 128   Hash ^= Hash << 25;
 129   Hash += Hash >> 6;
 130   return Hash;
 131 }
 132
 133 /// operator== - Used to compare two nodes to each other.
 134 ///
 135 bool FoldingSetNodeID::operator==(const FoldingSetNodeID &RHS)const{
 136   if (Bits.size() != RHS.Bits.size()) return false;
 137   return memcmp(&Bits[0], &RHS.Bits[0], Bits.size()*sizeof(Bits[0])) == 0;
 138 }
 139
 140
 141 //===----------------------------------------------------------------------===//
 142 /// Helper functions for FoldingSetImpl.
 143
 144 /// GetNextPtr - In order to save space, each bucket is a
 145 /// singly-linked-list. In order to make deletion more efficient, we make
 146 /// the list circular, so we can delete a node without computing its hash.
 147 /// The problem with this is that the start of the hash buckets are not
 148 /// Nodes.  If NextInBucketPtr is a bucket pointer, this method returns null:
 149 /// use GetBucketPtr when this happens.
 150 static FoldingSetImpl::Node *GetNextPtr(void *NextInBucketPtr) {
 151   // The low bit is set if this is the pointer back to the bucket.
 152   if (reinterpret_cast<intptr_t>(NextInBucketPtr) & 1)
 153     return 0;
 154
 155   return static_cast<FoldingSetImpl::Node*>(NextInBucketPtr);
 156 }
 157
 158
 159 /// testing.
 160 static void **GetBucketPtr(void *NextInBucketPtr) {
 161   intptr_t Ptr = reinterpret_cast<intptr_t>(NextInBucketPtr);
 162   assert((Ptr & 1) && "Not a bucket pointer");
 163   return reinterpret_cast<void**>(Ptr & ~intptr_t(1));
 164 }
 165
 166 /// GetBucketFor - Hash the specified node ID and return the hash bucket for
 167 /// the specified ID.
 168 static void **GetBucketFor(const FoldingSetNodeID &ID,
 169                            void **Buckets, unsigned NumBuckets) {
 170   // NumBuckets is always a power of 2.
 171   unsigned BucketNum = ID.ComputeHash() & (NumBuckets-1);
 172   return Buckets + BucketNum;
 173 }
 174
 175 //===----------------------------------------------------------------------===//
 176 // FoldingSetImpl Implementation
 177
 178 FoldingSetImpl::FoldingSetImpl(unsigned Log2InitSize) {
 179   assert(5 < Log2InitSize && Log2InitSize < 32 &&
 180          "Initial hash table size out of range");
 181   NumBuckets = 1 << Log2InitSize;
 182   Buckets = new void*[NumBuckets+1];
 183   clear();
 184 }
 185 FoldingSetImpl::~FoldingSetImpl() {
 186   delete [] Buckets;
 187 }
 188 void FoldingSetImpl::clear() {
 189   // Set all but the last bucket to null pointers.
 190   memset(Buckets, 0, NumBuckets*sizeof(void*));
 191
 192   // Set the very last bucket to be a non-null "pointer".
 193   Buckets[NumBuckets] = reinterpret_cast<void*>(-1);
 194
 195   // Reset the node count to zero.
 196   NumNodes = 0;
 197 }
 198
 199 /// GrowHashTable - Double the size of the hash table and rehash everything.
 200 ///
 201 void FoldingSetImpl::GrowHashTable() {
 202   void **OldBuckets = Buckets;
 203   unsigned OldNumBuckets = NumBuckets;
 204   NumBuckets <<= 1;
 205
 206   // Clear out new buckets.
 207   Buckets = new void*[NumBuckets+1];
 208   clear();
 209
 210   // Walk the old buckets, rehashing nodes into their new place.
 211   FoldingSetNodeID ID;
 212   for (unsigned i = 0; i != OldNumBuckets; ++i) {
 213     void *Probe = OldBuckets[i];
 214     if (!Probe) continue;
 215     while (Node *NodeInBucket = GetNextPtr(Probe)) {
 216       // Figure out the next link, remove NodeInBucket from the old link.
 217       Probe = NodeInBucket->getNextInBucket();
 218       NodeInBucket->SetNextInBucket(0);
 219
 220       // Insert the node into the new bucket, after recomputing the hash.
 221       GetNodeProfile(ID, NodeInBucket);
 222       InsertNode(NodeInBucket, GetBucketFor(ID, Buckets, NumBuckets));
 223       ID.clear();
 224     }
 225   }
 226
 227   delete[] OldBuckets;
 228 }
 229
 230 /// FindNodeOrInsertPos - Look up the node specified by ID.  If it exists,
 231 /// return it.  If not, return the insertion token that will make insertion
 232 /// faster.
 233 FoldingSetImpl::Node
 234 *FoldingSetImpl::FindNodeOrInsertPos(const FoldingSetNodeID &ID,
 235                                      void *&InsertPos) {
 236
 237   void **Bucket = GetBucketFor(ID, Buckets, NumBuckets);
 238   void *Probe = *Bucket;
 239
 240   InsertPos = 0;
 241
 242   FoldingSetNodeID OtherID;
 243   while (Node *NodeInBucket = GetNextPtr(Probe)) {
 244     GetNodeProfile(OtherID, NodeInBucket);
 245     if (OtherID == ID)
 246       return NodeInBucket;
 247
 248     Probe = NodeInBucket->getNextInBucket();
 249     OtherID.clear();
 250   }
 251
 252   // Didn't find the node, return null with the bucket as the InsertPos.
 253   InsertPos = Bucket;
 254   return 0;
 255 }
 256
 257 /// InsertNode - Insert the specified node into the folding set, knowing that it
 258 /// is not already in the map.  InsertPos must be obtained from
 259 /// FindNodeOrInsertPos.
 260 void FoldingSetImpl::InsertNode(Node *N, void *InsertPos) {
 261   assert(N->getNextInBucket() == 0);
 262   // Do we need to grow the hashtable?
 263   if (NumNodes+1 > NumBuckets*2) {
 264     GrowHashTable();
 265     FoldingSetNodeID ID;
 266     GetNodeProfile(ID, N);
 267     InsertPos = GetBucketFor(ID, Buckets, NumBuckets);
 268   }
 269
 270   ++NumNodes;
 271
 272   /// The insert position is actually a bucket pointer.
 273   void **Bucket = static_cast<void**>(InsertPos);
 274
 275   void *Next = *Bucket;
 276
 277   // If this is the first insertion into this bucket, its next pointer will be
 278   // null.  Pretend as if it pointed to itself, setting the low bit to indicate
 279   // that it is a pointer to the bucket.
 280   if (Next == 0)
 281     Next = reinterpret_cast<void*>(reinterpret_cast<intptr_t>(Bucket)|1);
 282
 283   // Set the node's next pointer, and make the bucket point to the node.
 284   N->SetNextInBucket(Next);
 285   *Bucket = N;
 286 }
 287
 288 /// RemoveNode - Remove a node from the folding set, returning true if one was
 289 /// removed or false if the node was not in the folding set.
 290 bool FoldingSetImpl::RemoveNode(Node *N) {
 291   // Because each bucket is a circular list, we don't need to compute N's hash
 292   // to remove it.
 293   void *Ptr = N->getNextInBucket();
 294   if (Ptr == 0) return false;  // Not in folding set.
 295
 296   --NumNodes;
 297   N->SetNextInBucket(0);
 298
 299   // Remember what N originally pointed to, either a bucket or another node.
 300   void *NodeNextPtr = Ptr;
 301
 302   // Chase around the list until we find the node (or bucket) which points to N.
 303   while (true) {
 304     if (Node *NodeInBucket = GetNextPtr(Ptr)) {
 305       // Advance pointer.
 306       Ptr = NodeInBucket->getNextInBucket();
 307
 308       // We found a node that points to N, change it to point to N's next node,
 309       // removing N from the list.
 310       if (Ptr == N) {
 311         NodeInBucket->SetNextInBucket(NodeNextPtr);
 312         return true;
 313       }
 314     } else {
 315       void **Bucket = GetBucketPtr(Ptr);
 316       Ptr = *Bucket;
 317
 318       // If we found that the bucket points to N, update the bucket to point to
 319       // whatever is next.
 320       if (Ptr == N) {
 321         *Bucket = NodeNextPtr;
 322         return true;
 323       }
 324     }
 325   }
 326 }
 327
 328 /// GetOrInsertNode - If there is an existing simple Node exactly
 329 /// equal to the specified node, return it.  Otherwise, insert 'N' and it
 330 /// instead.
 331 FoldingSetImpl::Node *FoldingSetImpl::GetOrInsertNode(FoldingSetImpl::Node *N) {
 332   FoldingSetNodeID ID;
 333   GetNodeProfile(ID, N);
 334   void *IP;
 335   if (Node *E = FindNodeOrInsertPos(ID, IP))
 336     return E;
 337   InsertNode(N, IP);
 338   return N;
 339 }
 340
 341 //===----------------------------------------------------------------------===//
 342 // FoldingSetIteratorImpl Implementation
 343
 344 FoldingSetIteratorImpl::FoldingSetIteratorImpl(void **Bucket) {
 345   // Skip to the first non-null non-self-cycle bucket.
 346   while (*Bucket != reinterpret_cast<void*>(-1) &&
 347          (*Bucket == 0 || GetNextPtr(*Bucket) == 0))
 348     ++Bucket;
 349
 350   NodePtr = static_cast<FoldingSetNode*>(*Bucket);
 351 }
 352
 353 void FoldingSetIteratorImpl::advance() {
 354   // If there is another link within this bucket, go to it.
 355   void *Probe = NodePtr->getNextInBucket();
 356
 357   if (FoldingSetNode *NextNodeInBucket = GetNextPtr(Probe))
 358     NodePtr = NextNodeInBucket;
 359   else {
 360     // Otherwise, this is the last link in this bucket.
 361     void **Bucket = GetBucketPtr(Probe);
 362
 363     // Skip to the next non-null non-self-cycle bucket.
 364     do {
 365       ++Bucket;
 366     } while (*Bucket != reinterpret_cast<void*>(-1) &&
 367              (*Bucket == 0 || GetNextPtr(*Bucket) == 0));
 368
 369     NodePtr = static_cast<FoldingSetNode*>(*Bucket);
 370   }
 371 }
 372
 373 //===----------------------------------------------------------------------===//
 374 // FoldingSetBucketIteratorImpl Implementation
 375
 376 FoldingSetBucketIteratorImpl::FoldingSetBucketIteratorImpl(void **Bucket) {
 377   Ptr = (*Bucket == 0 || GetNextPtr(*Bucket) == 0) ? (void*) Bucket : *Bucket;
 378 }