lib/Support/FoldingSet.cpp

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