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