1 //===-- llvm/ADT/FoldingSet.h - Uniquing Hash Set ---------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_ADT_FOLDINGSET_H
17 #define LLVM_ADT_FOLDINGSET_H
19 #include "llvm/ADT/SmallVector.h"
20 #include "llvm/ADT/StringRef.h"
21 #include "llvm/Support/DataTypes.h"
26 class BumpPtrAllocator;
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.
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.
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.
47 /// class MyNode : public FoldingSetNode {
52 /// MyNode(const char *N, unsigned V) : Name(N), Value(V) {}
54 /// void Profile(FoldingSetNodeID &ID) const {
55 /// ID.AddString(Name);
56 /// ID.AddInteger(Value);
61 /// To define the folding set itself use the FoldingSet template;
64 /// FoldingSet<MyNode> MyFoldingSet;
66 /// Four public methods are available to manipulate the folding set;
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;
71 /// MyNode *M = MyFoldingSet.GetOrInsertNode(N);
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.)
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
81 /// FoldingSetNodeID ID;
82 /// ID.AddString(Name);
83 /// ID.AddInteger(Value);
84 /// void *InsertPoint;
86 /// MyNode *M = MyFoldingSet.FindNodeOrInsertPos(ID, InsertPoint);
88 /// If found then M with be non-NULL, else InsertPoint will point to where it
89 /// should be inserted using InsertNode.
91 /// 3) If you get a NULL result from FindNodeOrInsertPos then you can as a new
92 /// node with FindNodeOrInsertPos;
94 /// InsertNode(N, InsertPoint);
96 /// 4) Finally, if you want to remove a node from the folding set call;
98 /// bool WasRemoved = RemoveNode(N);
100 /// The result indicates whether the node existed in the folding set.
102 class FoldingSetNodeID;
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.
111 class FoldingSetImpl {
113 /// Buckets - Array of bucket chains.
117 /// NumBuckets - Length of the Buckets array. Always a power of 2.
121 /// NumNodes - Number of nodes in the folding set. Growth occurs when NumNodes
122 /// is greater than twice the number of buckets.
126 explicit FoldingSetImpl(unsigned Log2InitSize = 6);
127 virtual ~FoldingSetImpl();
129 //===--------------------------------------------------------------------===//
130 /// Node - This class is used to maintain the singly linked bucket list in
135 // NextInFoldingSetBucket - next link in the bucket list.
136 void *NextInFoldingSetBucket;
140 Node() : NextInFoldingSetBucket(0) {}
143 void *getNextInBucket() const { return NextInFoldingSetBucket; }
144 void SetNextInBucket(void *N) { NextInFoldingSetBucket = N; }
147 /// clear - Remove all nodes from the folding set.
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);
154 /// GetOrInsertNode - If there is an existing simple Node exactly
155 /// equal to the specified node, return it. Otherwise, insert 'N' and return
157 Node *GetOrInsertNode(Node *N);
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
162 Node *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos);
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);
169 /// InsertNode - Insert the specified node into the folding set, knowing that
170 /// it is not already in the folding set.
171 void InsertNode(Node *N) {
172 Node *Inserted = GetOrInsertNode(N);
174 assert(Inserted == N && "Node already inserted!");
177 /// size - Returns the number of nodes in the folding set.
178 unsigned size() const { return NumNodes; }
180 /// empty - Returns true if there are no nodes in the folding set.
181 bool empty() const { return NumNodes == 0; }
185 /// GrowHashTable - Double the size of the hash table and rehash everything.
187 void GrowHashTable();
191 /// GetNodeProfile - Instantiations of the FoldingSet template implement
192 /// this function to gather data bits for the given node.
193 virtual void GetNodeProfile(Node *N, FoldingSetNodeID &ID) const = 0;
194 /// NodeEquals - Instantiations of the FoldingSet template implement
195 /// this function to compare the given node with the given ID.
196 virtual bool NodeEquals(Node *N, const FoldingSetNodeID &ID, unsigned IDHash,
197 FoldingSetNodeID &TempID) const=0;
198 /// ComputeNodeHash - Instantiations of the FoldingSet template implement
199 /// this function to compute a hash value for the given node.
200 virtual unsigned ComputeNodeHash(Node *N, FoldingSetNodeID &TempID) const = 0;
203 //===----------------------------------------------------------------------===//
205 template<typename T> struct FoldingSetTrait;
207 /// DefaultFoldingSetTrait - This class provides default implementations
208 /// for FoldingSetTrait implementations.
210 template<typename T> struct DefaultFoldingSetTrait {
211 static void Profile(const T &X, FoldingSetNodeID &ID) {
214 static void Profile(T &X, FoldingSetNodeID &ID) {
218 // Equals - Test if the profile for X would match ID, using TempID
219 // to compute a temporary ID if necessary. The default implementation
220 // just calls Profile and does a regular comparison. Implementations
221 // can override this to provide more efficient implementations.
222 static inline bool Equals(T &X, const FoldingSetNodeID &ID, unsigned IDHash,
223 FoldingSetNodeID &TempID);
225 // ComputeHash - Compute a hash value for X, using TempID to
226 // compute a temporary ID if necessary. The default implementation
227 // just calls Profile and does a regular hash computation.
228 // Implementations can override this to provide more efficient
230 static inline unsigned ComputeHash(T &X, FoldingSetNodeID &TempID);
233 /// FoldingSetTrait - This trait class is used to define behavior of how
234 /// to "profile" (in the FoldingSet parlance) an object of a given type.
235 /// The default behavior is to invoke a 'Profile' method on an object, but
236 /// through template specialization the behavior can be tailored for specific
237 /// types. Combined with the FoldingSetNodeWrapper class, one can add objects
238 /// to FoldingSets that were not originally designed to have that behavior.
239 template<typename T> struct FoldingSetTrait
240 : public DefaultFoldingSetTrait<T> {};
242 template<typename T, typename Ctx> struct ContextualFoldingSetTrait;
244 /// DefaultContextualFoldingSetTrait - Like DefaultFoldingSetTrait, but
245 /// for ContextualFoldingSets.
246 template<typename T, typename Ctx>
247 struct DefaultContextualFoldingSetTrait {
248 static void Profile(T &X, FoldingSetNodeID &ID, Ctx Context) {
249 X.Profile(ID, Context);
251 static inline bool Equals(T &X, const FoldingSetNodeID &ID, unsigned IDHash,
252 FoldingSetNodeID &TempID, Ctx Context);
253 static inline unsigned ComputeHash(T &X, FoldingSetNodeID &TempID,
257 /// ContextualFoldingSetTrait - Like FoldingSetTrait, but for
258 /// ContextualFoldingSets.
259 template<typename T, typename Ctx> struct ContextualFoldingSetTrait
260 : public DefaultContextualFoldingSetTrait<T, Ctx> {};
262 //===--------------------------------------------------------------------===//
263 /// FoldingSetNodeIDRef - This class describes a reference to an interned
264 /// FoldingSetNodeID, which can be a useful to store node id data rather
265 /// than using plain FoldingSetNodeIDs, since the 32-element SmallVector
266 /// is often much larger than necessary, and the possibility of heap
267 /// allocation means it requires a non-trivial destructor call.
268 class FoldingSetNodeIDRef {
269 const unsigned *Data;
272 FoldingSetNodeIDRef() : Data(0), Size(0) {}
273 FoldingSetNodeIDRef(const unsigned *D, size_t S) : Data(D), Size(S) {}
275 /// ComputeHash - Compute a strong hash value for this FoldingSetNodeIDRef,
276 /// used to lookup the node in the FoldingSetImpl.
277 unsigned ComputeHash() const;
279 bool operator==(FoldingSetNodeIDRef) const;
281 bool operator!=(FoldingSetNodeIDRef RHS) const { return !(*this == RHS); }
283 /// Used to compare the "ordering" of two nodes as defined by the
284 /// profiled bits and their ordering defined by memcmp().
285 bool operator<(FoldingSetNodeIDRef) const;
287 const unsigned *getData() const { return Data; }
288 size_t getSize() const { return Size; }
291 //===--------------------------------------------------------------------===//
292 /// FoldingSetNodeID - This class is used to gather all the unique data bits of
293 /// a node. When all the bits are gathered this class is used to produce a
294 /// hash value for the node.
296 class FoldingSetNodeID {
297 /// Bits - Vector of all the data bits that make the node unique.
298 /// Use a SmallVector to avoid a heap allocation in the common case.
299 SmallVector<unsigned, 32> Bits;
302 FoldingSetNodeID() {}
304 FoldingSetNodeID(FoldingSetNodeIDRef Ref)
305 : Bits(Ref.getData(), Ref.getData() + Ref.getSize()) {}
307 /// Add* - Add various data types to Bit data.
309 void AddPointer(const void *Ptr);
310 void AddInteger(signed I);
311 void AddInteger(unsigned I);
312 void AddInteger(long I);
313 void AddInteger(unsigned long I);
314 void AddInteger(long long I);
315 void AddInteger(unsigned long long I);
316 void AddBoolean(bool B) { AddInteger(B ? 1U : 0U); }
317 void AddString(StringRef String);
318 void AddNodeID(const FoldingSetNodeID &ID);
320 template <typename T>
321 inline void Add(const T &x) { FoldingSetTrait<T>::Profile(x, *this); }
323 /// clear - Clear the accumulated profile, allowing this FoldingSetNodeID
324 /// object to be used to compute a new profile.
325 inline void clear() { Bits.clear(); }
327 /// ComputeHash - Compute a strong hash value for this FoldingSetNodeID, used
328 /// to lookup the node in the FoldingSetImpl.
329 unsigned ComputeHash() const;
331 /// operator== - Used to compare two nodes to each other.
333 bool operator==(const FoldingSetNodeID &RHS) const;
334 bool operator==(const FoldingSetNodeIDRef RHS) const;
336 bool operator!=(const FoldingSetNodeID &RHS) const { return !(*this == RHS); }
337 bool operator!=(const FoldingSetNodeIDRef RHS) const { return !(*this ==RHS);}
339 /// Used to compare the "ordering" of two nodes as defined by the
340 /// profiled bits and their ordering defined by memcmp().
341 bool operator<(const FoldingSetNodeID &RHS) const;
342 bool operator<(const FoldingSetNodeIDRef RHS) const;
344 /// Intern - Copy this node's data to a memory region allocated from the
345 /// given allocator and return a FoldingSetNodeIDRef describing the
347 FoldingSetNodeIDRef Intern(BumpPtrAllocator &Allocator) const;
350 // Convenience type to hide the implementation of the folding set.
351 typedef FoldingSetImpl::Node FoldingSetNode;
352 template<class T> class FoldingSetIterator;
353 template<class T> class FoldingSetBucketIterator;
355 // Definitions of FoldingSetTrait and ContextualFoldingSetTrait functions, which
356 // require the definition of FoldingSetNodeID.
359 DefaultFoldingSetTrait<T>::Equals(T &X, const FoldingSetNodeID &ID,
361 FoldingSetNodeID &TempID) {
362 FoldingSetTrait<T>::Profile(X, TempID);
367 DefaultFoldingSetTrait<T>::ComputeHash(T &X, FoldingSetNodeID &TempID) {
368 FoldingSetTrait<T>::Profile(X, TempID);
369 return TempID.ComputeHash();
371 template<typename T, typename Ctx>
373 DefaultContextualFoldingSetTrait<T, Ctx>::Equals(T &X,
374 const FoldingSetNodeID &ID,
376 FoldingSetNodeID &TempID,
378 ContextualFoldingSetTrait<T, Ctx>::Profile(X, TempID, Context);
381 template<typename T, typename Ctx>
383 DefaultContextualFoldingSetTrait<T, Ctx>::ComputeHash(T &X,
384 FoldingSetNodeID &TempID,
386 ContextualFoldingSetTrait<T, Ctx>::Profile(X, TempID, Context);
387 return TempID.ComputeHash();
390 //===----------------------------------------------------------------------===//
391 /// FoldingSet - This template class is used to instantiate a specialized
392 /// implementation of the folding set to the node class T. T must be a
393 /// subclass of FoldingSetNode and implement a Profile function.
395 template<class T> class FoldingSet : public FoldingSetImpl {
397 /// GetNodeProfile - Each instantiatation of the FoldingSet needs to provide a
398 /// way to convert nodes into a unique specifier.
399 virtual void GetNodeProfile(Node *N, FoldingSetNodeID &ID) const {
400 T *TN = static_cast<T *>(N);
401 FoldingSetTrait<T>::Profile(*TN, ID);
403 /// NodeEquals - Instantiations may optionally provide a way to compare a
404 /// node with a specified ID.
405 virtual bool NodeEquals(Node *N, const FoldingSetNodeID &ID, unsigned IDHash,
406 FoldingSetNodeID &TempID) const {
407 T *TN = static_cast<T *>(N);
408 return FoldingSetTrait<T>::Equals(*TN, ID, IDHash, TempID);
410 /// ComputeNodeHash - Instantiations may optionally provide a way to compute a
411 /// hash value directly from a node.
412 virtual unsigned ComputeNodeHash(Node *N, FoldingSetNodeID &TempID) const {
413 T *TN = static_cast<T *>(N);
414 return FoldingSetTrait<T>::ComputeHash(*TN, TempID);
418 explicit FoldingSet(unsigned Log2InitSize = 6)
419 : FoldingSetImpl(Log2InitSize)
422 typedef FoldingSetIterator<T> iterator;
423 iterator begin() { return iterator(Buckets); }
424 iterator end() { return iterator(Buckets+NumBuckets); }
426 typedef FoldingSetIterator<const T> const_iterator;
427 const_iterator begin() const { return const_iterator(Buckets); }
428 const_iterator end() const { return const_iterator(Buckets+NumBuckets); }
430 typedef FoldingSetBucketIterator<T> bucket_iterator;
432 bucket_iterator bucket_begin(unsigned hash) {
433 return bucket_iterator(Buckets + (hash & (NumBuckets-1)));
436 bucket_iterator bucket_end(unsigned hash) {
437 return bucket_iterator(Buckets + (hash & (NumBuckets-1)), true);
440 /// GetOrInsertNode - If there is an existing simple Node exactly
441 /// equal to the specified node, return it. Otherwise, insert 'N' and
442 /// return it instead.
443 T *GetOrInsertNode(Node *N) {
444 return static_cast<T *>(FoldingSetImpl::GetOrInsertNode(N));
447 /// FindNodeOrInsertPos - Look up the node specified by ID. If it exists,
448 /// return it. If not, return the insertion token that will make insertion
450 T *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos) {
451 return static_cast<T *>(FoldingSetImpl::FindNodeOrInsertPos(ID, InsertPos));
455 //===----------------------------------------------------------------------===//
456 /// ContextualFoldingSet - This template class is a further refinement
457 /// of FoldingSet which provides a context argument when calling
458 /// Profile on its nodes. Currently, that argument is fixed at
459 /// initialization time.
461 /// T must be a subclass of FoldingSetNode and implement a Profile
462 /// function with signature
463 /// void Profile(llvm::FoldingSetNodeID &, Ctx);
464 template <class T, class Ctx>
465 class ContextualFoldingSet : public FoldingSetImpl {
466 // Unfortunately, this can't derive from FoldingSet<T> because the
467 // construction vtable for FoldingSet<T> requires
468 // FoldingSet<T>::GetNodeProfile to be instantiated, which in turn
469 // requires a single-argument T::Profile().
474 /// GetNodeProfile - Each instantiatation of the FoldingSet needs to provide a
475 /// way to convert nodes into a unique specifier.
476 virtual void GetNodeProfile(FoldingSetImpl::Node *N,
477 FoldingSetNodeID &ID) const {
478 T *TN = static_cast<T *>(N);
479 ContextualFoldingSetTrait<T, Ctx>::Profile(*TN, ID, Context);
481 virtual bool NodeEquals(FoldingSetImpl::Node *N,
482 const FoldingSetNodeID &ID, unsigned IDHash,
483 FoldingSetNodeID &TempID) const {
484 T *TN = static_cast<T *>(N);
485 return ContextualFoldingSetTrait<T, Ctx>::Equals(*TN, ID, IDHash, TempID,
488 virtual unsigned ComputeNodeHash(FoldingSetImpl::Node *N,
489 FoldingSetNodeID &TempID) const {
490 T *TN = static_cast<T *>(N);
491 return ContextualFoldingSetTrait<T, Ctx>::ComputeHash(*TN, TempID, Context);
495 explicit ContextualFoldingSet(Ctx Context, unsigned Log2InitSize = 6)
496 : FoldingSetImpl(Log2InitSize), Context(Context)
499 Ctx getContext() const { return Context; }
502 typedef FoldingSetIterator<T> iterator;
503 iterator begin() { return iterator(Buckets); }
504 iterator end() { return iterator(Buckets+NumBuckets); }
506 typedef FoldingSetIterator<const T> const_iterator;
507 const_iterator begin() const { return const_iterator(Buckets); }
508 const_iterator end() const { return const_iterator(Buckets+NumBuckets); }
510 typedef FoldingSetBucketIterator<T> bucket_iterator;
512 bucket_iterator bucket_begin(unsigned hash) {
513 return bucket_iterator(Buckets + (hash & (NumBuckets-1)));
516 bucket_iterator bucket_end(unsigned hash) {
517 return bucket_iterator(Buckets + (hash & (NumBuckets-1)), true);
520 /// GetOrInsertNode - If there is an existing simple Node exactly
521 /// equal to the specified node, return it. Otherwise, insert 'N'
522 /// and return it instead.
523 T *GetOrInsertNode(Node *N) {
524 return static_cast<T *>(FoldingSetImpl::GetOrInsertNode(N));
527 /// FindNodeOrInsertPos - Look up the node specified by ID. If it
528 /// exists, return it. If not, return the insertion token that will
529 /// make insertion faster.
530 T *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos) {
531 return static_cast<T *>(FoldingSetImpl::FindNodeOrInsertPos(ID, InsertPos));
535 //===----------------------------------------------------------------------===//
536 /// FoldingSetVectorIterator - This implements an iterator for
537 /// FoldingSetVector. It is only necessary because FoldingSetIterator provides
538 /// a value_type of T, while the vector in FoldingSetVector exposes
539 /// a value_type of T*. Fortunately, FoldingSetIterator doesn't expose very
540 /// much besides operator* and operator->, so we just wrap the inner vector
541 /// iterator and perform the extra dereference.
542 template <class T, class VectorIteratorT>
543 class FoldingSetVectorIterator {
544 // Provide a typedef to workaround the lack of correct injected class name
545 // support in older GCCs.
546 typedef FoldingSetVectorIterator<T, VectorIteratorT> SelfT;
548 VectorIteratorT Iterator;
551 FoldingSetVectorIterator(VectorIteratorT I) : Iterator(I) {}
553 bool operator==(const SelfT &RHS) const {
554 return Iterator == RHS.Iterator;
556 bool operator!=(const SelfT &RHS) const {
557 return Iterator != RHS.Iterator;
560 T &operator*() const { return **Iterator; }
562 T *operator->() const { return *Iterator; }
564 inline SelfT &operator++() {
568 SelfT operator++(int) {
575 //===----------------------------------------------------------------------===//
576 /// FoldingSetVector - This template class combines a FoldingSet and a vector
577 /// to provide the interface of FoldingSet but with deterministic iteration
578 /// order based on the insertion order. T must be a subclass of FoldingSetNode
579 /// and implement a Profile function.
580 template <class T, class VectorT = SmallVector<T*, 8> >
581 class FoldingSetVector {
586 explicit FoldingSetVector(unsigned Log2InitSize = 6)
587 : Set(Log2InitSize) {
590 typedef FoldingSetVectorIterator<T, typename VectorT::iterator> iterator;
591 iterator begin() { return Vector.begin(); }
592 iterator end() { return Vector.end(); }
594 typedef FoldingSetVectorIterator<const T, typename VectorT::const_iterator>
596 const_iterator begin() const { return Vector.begin(); }
597 const_iterator end() const { return Vector.end(); }
599 /// clear - Remove all nodes from the folding set.
600 void clear() { Set.clear(); Vector.clear(); }
602 /// FindNodeOrInsertPos - Look up the node specified by ID. If it exists,
603 /// return it. If not, return the insertion token that will make insertion
605 T *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos) {
606 return Set.FindNodeOrInsertPos(ID, InsertPos);
609 /// GetOrInsertNode - If there is an existing simple Node exactly
610 /// equal to the specified node, return it. Otherwise, insert 'N' and
611 /// return it instead.
612 T *GetOrInsertNode(T *N) {
613 T *Result = Set.GetOrInsertNode(N);
614 if (Result == N) Vector.push_back(N);
618 /// InsertNode - Insert the specified node into the folding set, knowing that
619 /// it is not already in the folding set. InsertPos must be obtained from
620 /// FindNodeOrInsertPos.
621 void InsertNode(T *N, void *InsertPos) {
622 Set.InsertNode(N, InsertPos);
626 /// InsertNode - Insert the specified node into the folding set, knowing that
627 /// it is not already in the folding set.
628 void InsertNode(T *N) {
633 /// size - Returns the number of nodes in the folding set.
634 unsigned size() const { return Set.size(); }
636 /// empty - Returns true if there are no nodes in the folding set.
637 bool empty() const { return Set.empty(); }
640 //===----------------------------------------------------------------------===//
641 /// FoldingSetIteratorImpl - This is the common iterator support shared by all
642 /// folding sets, which knows how to walk the folding set hash table.
643 class FoldingSetIteratorImpl {
645 FoldingSetNode *NodePtr;
646 FoldingSetIteratorImpl(void **Bucket);
650 bool operator==(const FoldingSetIteratorImpl &RHS) const {
651 return NodePtr == RHS.NodePtr;
653 bool operator!=(const FoldingSetIteratorImpl &RHS) const {
654 return NodePtr != RHS.NodePtr;
660 class FoldingSetIterator : public FoldingSetIteratorImpl {
662 explicit FoldingSetIterator(void **Bucket) : FoldingSetIteratorImpl(Bucket) {}
664 T &operator*() const {
665 return *static_cast<T*>(NodePtr);
668 T *operator->() const {
669 return static_cast<T*>(NodePtr);
672 inline FoldingSetIterator &operator++() { // Preincrement
676 FoldingSetIterator operator++(int) { // Postincrement
677 FoldingSetIterator tmp = *this; ++*this; return tmp;
681 //===----------------------------------------------------------------------===//
682 /// FoldingSetBucketIteratorImpl - This is the common bucket iterator support
683 /// shared by all folding sets, which knows how to walk a particular bucket
684 /// of a folding set hash table.
686 class FoldingSetBucketIteratorImpl {
690 explicit FoldingSetBucketIteratorImpl(void **Bucket);
692 FoldingSetBucketIteratorImpl(void **Bucket, bool)
696 void *Probe = static_cast<FoldingSetNode*>(Ptr)->getNextInBucket();
697 uintptr_t x = reinterpret_cast<uintptr_t>(Probe) & ~0x1;
698 Ptr = reinterpret_cast<void*>(x);
702 bool operator==(const FoldingSetBucketIteratorImpl &RHS) const {
703 return Ptr == RHS.Ptr;
705 bool operator!=(const FoldingSetBucketIteratorImpl &RHS) const {
706 return Ptr != RHS.Ptr;
712 class FoldingSetBucketIterator : public FoldingSetBucketIteratorImpl {
714 explicit FoldingSetBucketIterator(void **Bucket) :
715 FoldingSetBucketIteratorImpl(Bucket) {}
717 FoldingSetBucketIterator(void **Bucket, bool) :
718 FoldingSetBucketIteratorImpl(Bucket, true) {}
720 T &operator*() const { return *static_cast<T*>(Ptr); }
721 T *operator->() const { return static_cast<T*>(Ptr); }
723 inline FoldingSetBucketIterator &operator++() { // Preincrement
727 FoldingSetBucketIterator operator++(int) { // Postincrement
728 FoldingSetBucketIterator tmp = *this; ++*this; return tmp;
732 //===----------------------------------------------------------------------===//
733 /// FoldingSetNodeWrapper - This template class is used to "wrap" arbitrary
734 /// types in an enclosing object so that they can be inserted into FoldingSets.
735 template <typename T>
736 class FoldingSetNodeWrapper : public FoldingSetNode {
739 explicit FoldingSetNodeWrapper(const T &x) : data(x) {}
740 virtual ~FoldingSetNodeWrapper() {}
742 template<typename A1>
743 explicit FoldingSetNodeWrapper(const A1 &a1)
746 template <typename A1, typename A2>
747 explicit FoldingSetNodeWrapper(const A1 &a1, const A2 &a2)
750 template <typename A1, typename A2, typename A3>
751 explicit FoldingSetNodeWrapper(const A1 &a1, const A2 &a2, const A3 &a3)
754 template <typename A1, typename A2, typename A3, typename A4>
755 explicit FoldingSetNodeWrapper(const A1 &a1, const A2 &a2, const A3 &a3,
757 : data(a1,a2,a3,a4) {}
759 template <typename A1, typename A2, typename A3, typename A4, typename A5>
760 explicit FoldingSetNodeWrapper(const A1 &a1, const A2 &a2, const A3 &a3,
761 const A4 &a4, const A5 &a5)
762 : data(a1,a2,a3,a4,a5) {}
765 void Profile(FoldingSetNodeID &ID) { FoldingSetTrait<T>::Profile(data, ID); }
767 T &getValue() { return data; }
768 const T &getValue() const { return data; }
770 operator T&() { return data; }
771 operator const T&() const { return data; }
774 //===----------------------------------------------------------------------===//
775 /// FastFoldingSetNode - This is a subclass of FoldingSetNode which stores
776 /// a FoldingSetNodeID value rather than requiring the node to recompute it
777 /// each time it is needed. This trades space for speed (which can be
778 /// significant if the ID is long), and it also permits nodes to drop
779 /// information that would otherwise only be required for recomputing an ID.
780 class FastFoldingSetNode : public FoldingSetNode {
781 FoldingSetNodeID FastID;
783 explicit FastFoldingSetNode(const FoldingSetNodeID &ID) : FastID(ID) {}
785 void Profile(FoldingSetNodeID &ID) const {
786 ID.AddNodeID(FastID);
790 //===----------------------------------------------------------------------===//
791 // Partial specializations of FoldingSetTrait.
793 template<typename T> struct FoldingSetTrait<T*> {
794 static inline void Profile(T *X, FoldingSetNodeID &ID) {
798 } // End of namespace llvm.