include/llvm/ADT/FoldingSet.h

   1 //===-- llvm/ADT/FoldingSet.h - 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 defines a hash set that can be used to remove duplication of nodes
  11 // in a graph.  This code was originally created by Chris Lattner for use with
  12 // SelectionDAGCSEMap, but was isolated to provide use across the llvm code set.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_ADT_FOLDINGSET_H
  17 #define LLVM_ADT_FOLDINGSET_H
  18
  19 #include "llvm/System/DataTypes.h"
  20 #include "llvm/ADT/SmallVector.h"
  21 #include "llvm/ADT/StringRef.h"
  22
  23 namespace llvm {
  24   class APFloat;
  25   class APInt;
  26   class BumpPtrAllocator;
  27
  28 /// This folding set used for two purposes:
  29 ///   1. Given information about a node we want to create, look up the unique
  30 ///      instance of the node in the set.  If the node already exists, return
  31 ///      it, otherwise return the bucket it should be inserted into.
  32 ///   2. Given a node that has already been created, remove it from the set.
  33 ///
  34 /// This class is implemented as a single-link chained hash table, where the
  35 /// "buckets" are actually the nodes themselves (the next pointer is in the
  36 /// node).  The last node points back to the bucket to simplify node removal.
  37 ///
  38 /// Any node that is to be included in the folding set must be a subclass of
  39 /// FoldingSetNode.  The node class must also define a Profile method used to
  40 /// establish the unique bits of data for the node.  The Profile method is
  41 /// passed a FoldingSetNodeID object which is used to gather the bits.  Just
  42 /// call one of the Add* functions defined in the FoldingSetImpl::NodeID class.
  43 /// NOTE: That the folding set does not own the nodes and it is the
  44 /// responsibility of the user to dispose of the nodes.
  45 ///
  46 /// Eg.
  47 ///    class MyNode : public FoldingSetNode {
  48 ///    private:
  49 ///      std::string Name;
  50 ///      unsigned Value;
  51 ///    public:
  52 ///      MyNode(const char *N, unsigned V) : Name(N), Value(V) {}
  53 ///       ...
  54 ///      void Profile(FoldingSetNodeID &ID) const {
  55 ///        ID.AddString(Name);
  56 ///        ID.AddInteger(Value);
  57 ///       }
  58 ///       ...
  59 ///     };
  60 ///
  61 /// To define the folding set itself use the FoldingSet template;
  62 ///
  63 /// Eg.
  64 ///    FoldingSet<MyNode> MyFoldingSet;
  65 ///
  66 /// Four public methods are available to manipulate the folding set;
  67 ///
  68 /// 1) If you have an existing node that you want add to the set but unsure
  69 /// that the node might already exist then call;
  70 ///
  71 ///    MyNode *M = MyFoldingSet.GetOrInsertNode(N);
  72 ///
  73 /// If The result is equal to the input then the node has been inserted.
  74 /// Otherwise, the result is the node existing in the folding set, and the
  75 /// input can be discarded (use the result instead.)
  76 ///
  77 /// 2) If you are ready to construct a node but want to check if it already
  78 /// exists, then call FindNodeOrInsertPos with a FoldingSetNodeID of the bits to
  79 /// check;
  80 ///
  81 ///   FoldingSetNodeID ID;
  82 ///   ID.AddString(Name);
  83 ///   ID.AddInteger(Value);
  84 ///   void *InsertPoint;
  85 ///
  86 ///    MyNode *M = MyFoldingSet.FindNodeOrInsertPos(ID, InsertPoint);
  87 ///
  88 /// If found then M with be non-NULL, else InsertPoint will point to where it
  89 /// should be inserted using InsertNode.
  90 ///
  91 /// 3) If you get a NULL result from FindNodeOrInsertPos then you can as a new
  92 /// node with FindNodeOrInsertPos;
  93 ///
  94 ///    InsertNode(N, InsertPoint);
  95 ///
  96 /// 4) Finally, if you want to remove a node from the folding set call;
  97 ///
  98 ///    bool WasRemoved = RemoveNode(N);
  99 ///
 100 /// The result indicates whether the node existed in the folding set.
 101
 102 class FoldingSetNodeID;
 103
 104 //===----------------------------------------------------------------------===//
 105 /// FoldingSetImpl - Implements the folding set functionality.  The main
 106 /// structure is an array of buckets.  Each bucket is indexed by the hash of
 107 /// the nodes it contains.  The bucket itself points to the nodes contained
 108 /// in the bucket via a singly linked list.  The last node in the list points
 109 /// back to the bucket to facilitate node removal.
 110 ///
 111 class FoldingSetImpl {
 112 protected:
 113   /// Buckets - Array of bucket chains.
 114   ///
 115   void **Buckets;
 116
 117   /// NumBuckets - Length of the Buckets array.  Always a power of 2.
 118   ///
 119   unsigned NumBuckets;
 120
 121   /// NumNodes - Number of nodes in the folding set. Growth occurs when NumNodes
 122   /// is greater than twice the number of buckets.
 123   unsigned NumNodes;
 124
 125 public:
 126   explicit FoldingSetImpl(unsigned Log2InitSize = 6);
 127   virtual ~FoldingSetImpl();
 128
 129   //===--------------------------------------------------------------------===//
 130   /// Node - This class is used to maintain the singly linked bucket list in
 131   /// a folding set.
 132   ///
 133   class Node {
 134   private:
 135     // NextInFoldingSetBucket - next link in the bucket list.
 136     void *NextInFoldingSetBucket;
 137
 138   public:
 139
 140     Node() : NextInFoldingSetBucket(0) {}
 141
 142     // Accessors
 143     void *getNextInBucket() const { return NextInFoldingSetBucket; }
 144     void SetNextInBucket(void *N) { NextInFoldingSetBucket = N; }
 145   };
 146
 147   /// clear - Remove all nodes from the folding set.
 148   void clear();
 149
 150   /// RemoveNode - Remove a node from the folding set, returning true if one
 151   /// was removed or false if the node was not in the folding set.
 152   bool RemoveNode(Node *N);
 153
 154   /// GetOrInsertNode - If there is an existing simple Node exactly
 155   /// equal to the specified node, return it.  Otherwise, insert 'N' and return
 156   /// it instead.
 157   Node *GetOrInsertNode(Node *N);
 158
 159   /// FindNodeOrInsertPos - Look up the node specified by ID.  If it exists,
 160   /// return it.  If not, return the insertion token that will make insertion
 161   /// faster.
 162   Node *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos);
 163
 164   /// InsertNode - Insert the specified node into the folding set, knowing that
 165   /// it is not already in the folding set.  InsertPos must be obtained from
 166   /// FindNodeOrInsertPos.
 167   void InsertNode(Node *N, void *InsertPos);
 168
 169   /// size - Returns the number of nodes in the folding set.
 170   unsigned size() const { return NumNodes; }
 171
 172   /// empty - Returns true if there are no nodes in the folding set.
 173   bool empty() const { return NumNodes == 0; }
 174
 175 private:
 176
 177   /// GrowHashTable - Double the size of the hash table and rehash everything.
 178   ///
 179   void GrowHashTable();
 180
 181 protected:
 182
 183   /// GetNodeProfile - Instantiations of the FoldingSet template implement
 184   /// this function to gather data bits for the given node.
 185   virtual void GetNodeProfile(FoldingSetNodeID &ID, Node *N) const = 0;
 186 };
 187
 188 //===----------------------------------------------------------------------===//
 189 /// FoldingSetTrait - This trait class is used to define behavior of how
 190 ///  to "profile" (in the FoldingSet parlance) an object of a given type.
 191 ///  The default behavior is to invoke a 'Profile' method on an object, but
 192 ///  through template specialization the behavior can be tailored for specific
 193 ///  types.  Combined with the FoldingSetNodeWrapper classs, one can add objects
 194 ///  to FoldingSets that were not originally designed to have that behavior.
 195 ///
 196 template<typename T> struct FoldingSetTrait {
 197   static inline void Profile(const T& X, FoldingSetNodeID& ID) { X.Profile(ID);}
 198   static inline void Profile(T& X, FoldingSetNodeID& ID) { X.Profile(ID); }
 199 };
 200
 201 //===--------------------------------------------------------------------===//
 202 /// FoldingSetNodeIDRef - This class describes a reference to an interned
 203 /// FoldingSetNodeID, which can be a useful to store node id data rather
 204 /// than using plain FoldingSetNodeIDs, since the 32-element SmallVector
 205 /// is often much larger than necessary, and the possibility of heap
 206 /// allocation means it requires a non-trivial destructor call.
 207 class FoldingSetNodeIDRef {
 208   unsigned* Data;
 209   size_t Size;
 210 public:
 211   FoldingSetNodeIDRef() : Data(0), Size(0) {}
 212   FoldingSetNodeIDRef(unsigned *D, size_t S) : Data(D), Size(S) {}
 213
 214   unsigned *getData() const { return Data; }
 215   size_t getSize() const { return Size; }
 216 };
 217
 218 //===--------------------------------------------------------------------===//
 219 /// FoldingSetNodeID - This class is used to gather all the unique data bits of
 220 /// a node.  When all the bits are gathered this class is used to produce a
 221 /// hash value for the node.
 222 ///
 223 class FoldingSetNodeID {
 224   /// Bits - Vector of all the data bits that make the node unique.
 225   /// Use a SmallVector to avoid a heap allocation in the common case.
 226   SmallVector<unsigned, 32> Bits;
 227
 228 public:
 229   FoldingSetNodeID() {}
 230
 231   FoldingSetNodeID(FoldingSetNodeIDRef Ref)
 232     : Bits(Ref.getData(), Ref.getData() + Ref.getSize()) {}
 233
 234   /// Add* - Add various data types to Bit data.
 235   ///
 236   void AddPointer(const void *Ptr);
 237   void AddInteger(signed I);
 238   void AddInteger(unsigned I);
 239   void AddInteger(long I);
 240   void AddInteger(unsigned long I);
 241   void AddInteger(long long I);
 242   void AddInteger(unsigned long long I);
 243   void AddBoolean(bool B) { AddInteger(B ? 1U : 0U); }
 244   void AddString(StringRef String);
 245
 246   template <typename T>
 247   inline void Add(const T& x) { FoldingSetTrait<T>::Profile(x, *this); }
 248
 249   /// clear - Clear the accumulated profile, allowing this FoldingSetNodeID
 250   ///  object to be used to compute a new profile.
 251   inline void clear() { Bits.clear(); }
 252
 253   /// ComputeHash - Compute a strong hash value for this FoldingSetNodeID, used
 254   ///  to lookup the node in the FoldingSetImpl.
 255   unsigned ComputeHash() const;
 256
 257   /// operator== - Used to compare two nodes to each other.
 258   ///
 259   bool operator==(const FoldingSetNodeID &RHS) const;
 260
 261   /// Intern - Copy this node's data to a memory region allocated from the
 262   /// given allocator and return a FoldingSetNodeIDRef describing the
 263   /// interned data.
 264   FoldingSetNodeIDRef Intern(BumpPtrAllocator &Allocator) const;
 265 };
 266
 267 // Convenience type to hide the implementation of the folding set.
 268 typedef FoldingSetImpl::Node FoldingSetNode;
 269 template<class T> class FoldingSetIterator;
 270 template<class T> class FoldingSetBucketIterator;
 271
 272 //===----------------------------------------------------------------------===//
 273 /// FoldingSet - This template class is used to instantiate a specialized
 274 /// implementation of the folding set to the node class T.  T must be a
 275 /// subclass of FoldingSetNode and implement a Profile function.
 276 ///
 277 template<class T> class FoldingSet : public FoldingSetImpl {
 278 private:
 279   /// GetNodeProfile - Each instantiatation of the FoldingSet needs to provide a
 280   /// way to convert nodes into a unique specifier.
 281   virtual void GetNodeProfile(FoldingSetNodeID &ID, Node *N) const {
 282     T *TN = static_cast<T *>(N);
 283     FoldingSetTrait<T>::Profile(*TN,ID);
 284   }
 285
 286 public:
 287   explicit FoldingSet(unsigned Log2InitSize = 6)
 288   : FoldingSetImpl(Log2InitSize)
 289   {}
 290
 291   typedef FoldingSetIterator<T> iterator;
 292   iterator begin() { return iterator(Buckets); }
 293   iterator end() { return iterator(Buckets+NumBuckets); }
 294
 295   typedef FoldingSetIterator<const T> const_iterator;
 296   const_iterator begin() const { return const_iterator(Buckets); }
 297   const_iterator end() const { return const_iterator(Buckets+NumBuckets); }
 298
 299   typedef FoldingSetBucketIterator<T> bucket_iterator;
 300
 301   bucket_iterator bucket_begin(unsigned hash) {
 302     return bucket_iterator(Buckets + (hash & (NumBuckets-1)));
 303   }
 304
 305   bucket_iterator bucket_end(unsigned hash) {
 306     return bucket_iterator(Buckets + (hash & (NumBuckets-1)), true);
 307   }
 308
 309   /// GetOrInsertNode - If there is an existing simple Node exactly
 310   /// equal to the specified node, return it.  Otherwise, insert 'N' and
 311   /// return it instead.
 312   T *GetOrInsertNode(Node *N) {
 313     return static_cast<T *>(FoldingSetImpl::GetOrInsertNode(N));
 314   }
 315
 316   /// FindNodeOrInsertPos - Look up the node specified by ID.  If it exists,
 317   /// return it.  If not, return the insertion token that will make insertion
 318   /// faster.
 319   T *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos) {
 320     return static_cast<T *>(FoldingSetImpl::FindNodeOrInsertPos(ID, InsertPos));
 321   }
 322 };
 323
 324 //===----------------------------------------------------------------------===//
 325 /// FoldingSetIteratorImpl - This is the common iterator support shared by all
 326 /// folding sets, which knows how to walk the folding set hash table.
 327 class FoldingSetIteratorImpl {
 328 protected:
 329   FoldingSetNode *NodePtr;
 330   FoldingSetIteratorImpl(void **Bucket);
 331   void advance();
 332
 333 public:
 334   bool operator==(const FoldingSetIteratorImpl &RHS) const {
 335     return NodePtr == RHS.NodePtr;
 336   }
 337   bool operator!=(const FoldingSetIteratorImpl &RHS) const {
 338     return NodePtr != RHS.NodePtr;
 339   }
 340 };
 341
 342
 343 template<class T>
 344 class FoldingSetIterator : public FoldingSetIteratorImpl {
 345 public:
 346   explicit FoldingSetIterator(void **Bucket) : FoldingSetIteratorImpl(Bucket) {}
 347
 348   T &operator*() const {
 349     return *static_cast<T*>(NodePtr);
 350   }
 351
 352   T *operator->() const {
 353     return static_cast<T*>(NodePtr);
 354   }
 355
 356   inline FoldingSetIterator& operator++() {          // Preincrement
 357     advance();
 358     return *this;
 359   }
 360   FoldingSetIterator operator++(int) {        // Postincrement
 361     FoldingSetIterator tmp = *this; ++*this; return tmp;
 362   }
 363 };
 364
 365 //===----------------------------------------------------------------------===//
 366 /// FoldingSetBucketIteratorImpl - This is the common bucket iterator support
 367 ///  shared by all folding sets, which knows how to walk a particular bucket
 368 ///  of a folding set hash table.
 369
 370 class FoldingSetBucketIteratorImpl {
 371 protected:
 372   void *Ptr;
 373
 374   explicit FoldingSetBucketIteratorImpl(void **Bucket);
 375
 376   FoldingSetBucketIteratorImpl(void **Bucket, bool)
 377     : Ptr(Bucket) {}
 378
 379   void advance() {
 380     void *Probe = static_cast<FoldingSetNode*>(Ptr)->getNextInBucket();
 381     uintptr_t x = reinterpret_cast<uintptr_t>(Probe) & ~0x1;
 382     Ptr = reinterpret_cast<void*>(x);
 383   }
 384
 385 public:
 386   bool operator==(const FoldingSetBucketIteratorImpl &RHS) const {
 387     return Ptr == RHS.Ptr;
 388   }
 389   bool operator!=(const FoldingSetBucketIteratorImpl &RHS) const {
 390     return Ptr != RHS.Ptr;
 391   }
 392 };
 393
 394
 395 template<class T>
 396 class FoldingSetBucketIterator : public FoldingSetBucketIteratorImpl {
 397 public:
 398   explicit FoldingSetBucketIterator(void **Bucket) :
 399     FoldingSetBucketIteratorImpl(Bucket) {}
 400
 401   FoldingSetBucketIterator(void **Bucket, bool) :
 402     FoldingSetBucketIteratorImpl(Bucket, true) {}
 403
 404   T& operator*() const { return *static_cast<T*>(Ptr); }
 405   T* operator->() const { return static_cast<T*>(Ptr); }
 406
 407   inline FoldingSetBucketIterator& operator++() { // Preincrement
 408     advance();
 409     return *this;
 410   }
 411   FoldingSetBucketIterator operator++(int) {      // Postincrement
 412     FoldingSetBucketIterator tmp = *this; ++*this; return tmp;
 413   }
 414 };
 415
 416 //===----------------------------------------------------------------------===//
 417 /// FoldingSetNodeWrapper - This template class is used to "wrap" arbitrary
 418 /// types in an enclosing object so that they can be inserted into FoldingSets.
 419 template <typename T>
 420 class FoldingSetNodeWrapper : public FoldingSetNode {
 421   T data;
 422 public:
 423   explicit FoldingSetNodeWrapper(const T& x) : data(x) {}
 424   virtual ~FoldingSetNodeWrapper() {}
 425
 426   template<typename A1>
 427   explicit FoldingSetNodeWrapper(const A1& a1)
 428     : data(a1) {}
 429
 430   template <typename A1, typename A2>
 431   explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2)
 432     : data(a1,a2) {}
 433
 434   template <typename A1, typename A2, typename A3>
 435   explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2, const A3& a3)
 436     : data(a1,a2,a3) {}
 437
 438   template <typename A1, typename A2, typename A3, typename A4>
 439   explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2, const A3& a3,
 440                                  const A4& a4)
 441     : data(a1,a2,a3,a4) {}
 442
 443   template <typename A1, typename A2, typename A3, typename A4, typename A5>
 444   explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2, const A3& a3,
 445                                  const A4& a4, const A5& a5)
 446   : data(a1,a2,a3,a4,a5) {}
 447
 448
 449   void Profile(FoldingSetNodeID& ID) { FoldingSetTrait<T>::Profile(data, ID); }
 450
 451   T& getValue() { return data; }
 452   const T& getValue() const { return data; }
 453
 454   operator T&() { return data; }
 455   operator const T&() const { return data; }
 456 };
 457
 458 //===----------------------------------------------------------------------===//
 459 /// FastFoldingSetNode - This is a subclass of FoldingSetNode which stores
 460 /// a FoldingSetNodeID value rather than requiring the node to recompute it
 461 /// each time it is needed. This trades space for speed (which can be
 462 /// significant if the ID is long), and it also permits nodes to drop
 463 /// information that would otherwise only be required for recomputing an ID.
 464 class FastFoldingSetNode : public FoldingSetNode {
 465   FoldingSetNodeID FastID;
 466 protected:
 467   explicit FastFoldingSetNode(const FoldingSetNodeID &ID) : FastID(ID) {}
 468 public:
 469   void Profile(FoldingSetNodeID& ID) { ID = FastID; }
 470 };
 471
 472 //===----------------------------------------------------------------------===//
 473 // Partial specializations of FoldingSetTrait.
 474
 475 template<typename T> struct FoldingSetTrait<T*> {
 476   static inline void Profile(const T* X, FoldingSetNodeID& ID) {
 477     ID.AddPointer(X);
 478   }
 479   static inline void Profile(T* X, FoldingSetNodeID& ID) {
 480     ID.AddPointer(X);
 481   }
 482 };
 483
 484 template<typename T> struct FoldingSetTrait<const T*> {
 485   static inline void Profile(const T* X, FoldingSetNodeID& ID) {
 486     ID.AddPointer(X);
 487   }
 488 };
 489
 490 } // End of namespace llvm.
 491
 492 #endif