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