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