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   template <typename Ctx>
 200   static inline void Profile(T &X, FoldingSetNodeID &ID, Ctx Context) {
 201     X.Profile(ID, Context);
 202   }
 203 };
 204
 205 //===--------------------------------------------------------------------===//
 206 /// FoldingSetNodeIDRef - This class describes a reference to an interned
 207 /// FoldingSetNodeID, which can be a useful to store node id data rather
 208 /// than using plain FoldingSetNodeIDs, since the 32-element SmallVector
 209 /// is often much larger than necessary, and the possibility of heap
 210 /// allocation means it requires a non-trivial destructor call.
 211 class FoldingSetNodeIDRef {
 212   unsigned* Data;
 213   size_t Size;
 214 public:
 215   FoldingSetNodeIDRef() : Data(0), Size(0) {}
 216   FoldingSetNodeIDRef(unsigned *D, size_t S) : Data(D), Size(S) {}
 217
 218   unsigned *getData() const { return Data; }
 219   size_t getSize() const { return Size; }
 220 };
 221
 222 //===--------------------------------------------------------------------===//
 223 /// FoldingSetNodeID - This class is used to gather all the unique data bits of
 224 /// a node.  When all the bits are gathered this class is used to produce a
 225 /// hash value for the node.
 226 ///
 227 class FoldingSetNodeID {
 228   /// Bits - Vector of all the data bits that make the node unique.
 229   /// Use a SmallVector to avoid a heap allocation in the common case.
 230   SmallVector<unsigned, 32> Bits;
 231
 232 public:
 233   FoldingSetNodeID() {}
 234
 235   FoldingSetNodeID(FoldingSetNodeIDRef Ref)
 236     : Bits(Ref.getData(), Ref.getData() + Ref.getSize()) {}
 237
 238   /// Add* - Add various data types to Bit data.
 239   ///
 240   void AddPointer(const void *Ptr);
 241   void AddInteger(signed I);
 242   void AddInteger(unsigned I);
 243   void AddInteger(long I);
 244   void AddInteger(unsigned long I);
 245   void AddInteger(long long I);
 246   void AddInteger(unsigned long long I);
 247   void AddBoolean(bool B) { AddInteger(B ? 1U : 0U); }
 248   void AddString(StringRef String);
 249
 250   template <typename T>
 251   inline void Add(const T& x) { FoldingSetTrait<T>::Profile(x, *this); }
 252
 253   /// clear - Clear the accumulated profile, allowing this FoldingSetNodeID
 254   ///  object to be used to compute a new profile.
 255   inline void clear() { Bits.clear(); }
 256
 257   /// ComputeHash - Compute a strong hash value for this FoldingSetNodeID, used
 258   ///  to lookup the node in the FoldingSetImpl.
 259   unsigned ComputeHash() const;
 260
 261   /// operator== - Used to compare two nodes to each other.
 262   ///
 263   bool operator==(const FoldingSetNodeID &RHS) const;
 264
 265   /// Intern - Copy this node's data to a memory region allocated from the
 266   /// given allocator and return a FoldingSetNodeIDRef describing the
 267   /// interned data.
 268   FoldingSetNodeIDRef Intern(BumpPtrAllocator &Allocator) const;
 269 };
 270
 271 // Convenience type to hide the implementation of the folding set.
 272 typedef FoldingSetImpl::Node FoldingSetNode;
 273 template<class T> class FoldingSetIterator;
 274 template<class T> class FoldingSetBucketIterator;
 275
 276 //===----------------------------------------------------------------------===//
 277 /// FoldingSet - This template class is used to instantiate a specialized
 278 /// implementation of the folding set to the node class T.  T must be a
 279 /// subclass of FoldingSetNode and implement a Profile function.
 280 ///
 281 template<class T> class FoldingSet : public FoldingSetImpl {
 282 private:
 283   /// GetNodeProfile - Each instantiatation of the FoldingSet needs to provide a
 284   /// way to convert nodes into a unique specifier.
 285   virtual void GetNodeProfile(FoldingSetNodeID &ID, Node *N) const {
 286     T *TN = static_cast<T *>(N);
 287     FoldingSetTrait<T>::Profile(*TN,ID);
 288   }
 289
 290 public:
 291   explicit FoldingSet(unsigned Log2InitSize = 6)
 292   : FoldingSetImpl(Log2InitSize)
 293   {}
 294
 295   typedef FoldingSetIterator<T> iterator;
 296   iterator begin() { return iterator(Buckets); }
 297   iterator end() { return iterator(Buckets+NumBuckets); }
 298
 299   typedef FoldingSetIterator<const T> const_iterator;
 300   const_iterator begin() const { return const_iterator(Buckets); }
 301   const_iterator end() const { return const_iterator(Buckets+NumBuckets); }
 302
 303   typedef FoldingSetBucketIterator<T> bucket_iterator;
 304
 305   bucket_iterator bucket_begin(unsigned hash) {
 306     return bucket_iterator(Buckets + (hash & (NumBuckets-1)));
 307   }
 308
 309   bucket_iterator bucket_end(unsigned hash) {
 310     return bucket_iterator(Buckets + (hash & (NumBuckets-1)), true);
 311   }
 312
 313   /// GetOrInsertNode - If there is an existing simple Node exactly
 314   /// equal to the specified node, return it.  Otherwise, insert 'N' and
 315   /// return it instead.
 316   T *GetOrInsertNode(Node *N) {
 317     return static_cast<T *>(FoldingSetImpl::GetOrInsertNode(N));
 318   }
 319
 320   /// FindNodeOrInsertPos - Look up the node specified by ID.  If it exists,
 321   /// return it.  If not, return the insertion token that will make insertion
 322   /// faster.
 323   T *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos) {
 324     return static_cast<T *>(FoldingSetImpl::FindNodeOrInsertPos(ID, InsertPos));
 325   }
 326 };
 327
 328 //===----------------------------------------------------------------------===//
 329 /// ContextualFoldingSet - This template class is a further refinement
 330 /// of FoldingSet which provides a context argument when calling
 331 /// Profile on its nodes.  Currently, that argument is fixed at
 332 /// initialization time.
 333 ///
 334 /// T must be a subclass of FoldingSetNode and implement a Profile
 335 /// function with signature
 336 ///   void Profile(llvm::FoldingSetNodeID &, Ctx);
 337 template <class T, class Ctx>
 338 class ContextualFoldingSet : public FoldingSetImpl {
 339   // Unfortunately, this can't derive from FoldingSet<T> because the
 340   // construction vtable for FoldingSet<T> requires
 341   // FoldingSet<T>::GetNodeProfile to be instantiated, which in turn
 342   // requires a single-argument T::Profile().
 343
 344 private:
 345   Ctx Context;
 346
 347   /// GetNodeProfile - Each instantiatation of the FoldingSet needs to provide a
 348   /// way to convert nodes into a unique specifier.
 349   virtual void GetNodeProfile(FoldingSetNodeID &ID,
 350                               FoldingSetImpl::Node *N) const {
 351     T *TN = static_cast<T *>(N);
 352
 353     // We must use explicit template arguments in case Ctx is a
 354     // reference type.
 355     FoldingSetTrait<T>::template Profile<Ctx>(*TN, ID, Context);
 356   }
 357
 358 public:
 359   explicit ContextualFoldingSet(Ctx Context, unsigned Log2InitSize = 6)
 360   : FoldingSetImpl(Log2InitSize), Context(Context)
 361   {}
 362
 363   Ctx getContext() const { return Context; }
 364
 365
 366   typedef FoldingSetIterator<T> iterator;
 367   iterator begin() { return iterator(Buckets); }
 368   iterator end() { return iterator(Buckets+NumBuckets); }
 369
 370   typedef FoldingSetIterator<const T> const_iterator;
 371   const_iterator begin() const { return const_iterator(Buckets); }
 372   const_iterator end() const { return const_iterator(Buckets+NumBuckets); }
 373
 374   typedef FoldingSetBucketIterator<T> bucket_iterator;
 375
 376   bucket_iterator bucket_begin(unsigned hash) {
 377     return bucket_iterator(Buckets + (hash & (NumBuckets-1)));
 378   }
 379
 380   bucket_iterator bucket_end(unsigned hash) {
 381     return bucket_iterator(Buckets + (hash & (NumBuckets-1)), true);
 382   }
 383
 384   /// GetOrInsertNode - If there is an existing simple Node exactly
 385   /// equal to the specified node, return it.  Otherwise, insert 'N'
 386   /// and return it instead.
 387   T *GetOrInsertNode(Node *N) {
 388     return static_cast<T *>(FoldingSetImpl::GetOrInsertNode(N));
 389   }
 390
 391   /// FindNodeOrInsertPos - Look up the node specified by ID.  If it
 392   /// exists, return it.  If not, return the insertion token that will
 393   /// make insertion faster.
 394   T *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos) {
 395     return static_cast<T *>(FoldingSetImpl::FindNodeOrInsertPos(ID, InsertPos));
 396   }
 397 };
 398
 399 //===----------------------------------------------------------------------===//
 400 /// FoldingSetIteratorImpl - This is the common iterator support shared by all
 401 /// folding sets, which knows how to walk the folding set hash table.
 402 class FoldingSetIteratorImpl {
 403 protected:
 404   FoldingSetNode *NodePtr;
 405   FoldingSetIteratorImpl(void **Bucket);
 406   void advance();
 407
 408 public:
 409   bool operator==(const FoldingSetIteratorImpl &RHS) const {
 410     return NodePtr == RHS.NodePtr;
 411   }
 412   bool operator!=(const FoldingSetIteratorImpl &RHS) const {
 413     return NodePtr != RHS.NodePtr;
 414   }
 415 };
 416
 417
 418 template<class T>
 419 class FoldingSetIterator : public FoldingSetIteratorImpl {
 420 public:
 421   explicit FoldingSetIterator(void **Bucket) : FoldingSetIteratorImpl(Bucket) {}
 422
 423   T &operator*() const {
 424     return *static_cast<T*>(NodePtr);
 425   }
 426
 427   T *operator->() const {
 428     return static_cast<T*>(NodePtr);
 429   }
 430
 431   inline FoldingSetIterator& operator++() {          // Preincrement
 432     advance();
 433     return *this;
 434   }
 435   FoldingSetIterator operator++(int) {        // Postincrement
 436     FoldingSetIterator tmp = *this; ++*this; return tmp;
 437   }
 438 };
 439
 440 //===----------------------------------------------------------------------===//
 441 /// FoldingSetBucketIteratorImpl - This is the common bucket iterator support
 442 ///  shared by all folding sets, which knows how to walk a particular bucket
 443 ///  of a folding set hash table.
 444
 445 class FoldingSetBucketIteratorImpl {
 446 protected:
 447   void *Ptr;
 448
 449   explicit FoldingSetBucketIteratorImpl(void **Bucket);
 450
 451   FoldingSetBucketIteratorImpl(void **Bucket, bool)
 452     : Ptr(Bucket) {}
 453
 454   void advance() {
 455     void *Probe = static_cast<FoldingSetNode*>(Ptr)->getNextInBucket();
 456     uintptr_t x = reinterpret_cast<uintptr_t>(Probe) & ~0x1;
 457     Ptr = reinterpret_cast<void*>(x);
 458   }
 459
 460 public:
 461   bool operator==(const FoldingSetBucketIteratorImpl &RHS) const {
 462     return Ptr == RHS.Ptr;
 463   }
 464   bool operator!=(const FoldingSetBucketIteratorImpl &RHS) const {
 465     return Ptr != RHS.Ptr;
 466   }
 467 };
 468
 469
 470 template<class T>
 471 class FoldingSetBucketIterator : public FoldingSetBucketIteratorImpl {
 472 public:
 473   explicit FoldingSetBucketIterator(void **Bucket) :
 474     FoldingSetBucketIteratorImpl(Bucket) {}
 475
 476   FoldingSetBucketIterator(void **Bucket, bool) :
 477     FoldingSetBucketIteratorImpl(Bucket, true) {}
 478
 479   T& operator*() const { return *static_cast<T*>(Ptr); }
 480   T* operator->() const { return static_cast<T*>(Ptr); }
 481
 482   inline FoldingSetBucketIterator& operator++() { // Preincrement
 483     advance();
 484     return *this;
 485   }
 486   FoldingSetBucketIterator operator++(int) {      // Postincrement
 487     FoldingSetBucketIterator tmp = *this; ++*this; return tmp;
 488   }
 489 };
 490
 491 //===----------------------------------------------------------------------===//
 492 /// FoldingSetNodeWrapper - This template class is used to "wrap" arbitrary
 493 /// types in an enclosing object so that they can be inserted into FoldingSets.
 494 template <typename T>
 495 class FoldingSetNodeWrapper : public FoldingSetNode {
 496   T data;
 497 public:
 498   explicit FoldingSetNodeWrapper(const T& x) : data(x) {}
 499   virtual ~FoldingSetNodeWrapper() {}
 500
 501   template<typename A1>
 502   explicit FoldingSetNodeWrapper(const A1& a1)
 503     : data(a1) {}
 504
 505   template <typename A1, typename A2>
 506   explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2)
 507     : data(a1,a2) {}
 508
 509   template <typename A1, typename A2, typename A3>
 510   explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2, const A3& a3)
 511     : data(a1,a2,a3) {}
 512
 513   template <typename A1, typename A2, typename A3, typename A4>
 514   explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2, const A3& a3,
 515                                  const A4& a4)
 516     : data(a1,a2,a3,a4) {}
 517
 518   template <typename A1, typename A2, typename A3, typename A4, typename A5>
 519   explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2, const A3& a3,
 520                                  const A4& a4, const A5& a5)
 521   : data(a1,a2,a3,a4,a5) {}
 522
 523
 524   void Profile(FoldingSetNodeID& ID) { FoldingSetTrait<T>::Profile(data, ID); }
 525
 526   T& getValue() { return data; }
 527   const T& getValue() const { return data; }
 528
 529   operator T&() { return data; }
 530   operator const T&() const { return data; }
 531 };
 532
 533 //===----------------------------------------------------------------------===//
 534 /// FastFoldingSetNode - This is a subclass of FoldingSetNode which stores
 535 /// a FoldingSetNodeID value rather than requiring the node to recompute it
 536 /// each time it is needed. This trades space for speed (which can be
 537 /// significant if the ID is long), and it also permits nodes to drop
 538 /// information that would otherwise only be required for recomputing an ID.
 539 class FastFoldingSetNode : public FoldingSetNode {
 540   FoldingSetNodeID FastID;
 541 protected:
 542   explicit FastFoldingSetNode(const FoldingSetNodeID &ID) : FastID(ID) {}
 543 public:
 544   void Profile(FoldingSetNodeID& ID) { ID = FastID; }
 545 };
 546
 547 //===----------------------------------------------------------------------===//
 548 // Partial specializations of FoldingSetTrait.
 549
 550 template<typename T> struct FoldingSetTrait<T*> {
 551   static inline void Profile(const T* X, FoldingSetNodeID& ID) {
 552     ID.AddPointer(X);
 553   }
 554   static inline void Profile(T* X, FoldingSetNodeID& ID) {
 555     ID.AddPointer(X);
 556   }
 557 };
 558
 559 template<typename T> struct FoldingSetTrait<const T*> {
 560   static inline void Profile(const T* X, FoldingSetNodeID& ID) {
 561     ID.AddPointer(X);
 562   }
 563 };
 564
 565 } // End of namespace llvm.
 566
 567 #endif