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