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