X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FADT%2FFoldingSet.h;h=d6010adfb9f7dda5fc672089d8d699f06effce00;hb=4715f6395ef152fd92c9b74d5f3e62e2cff29d27;hp=e626b6e62eedeaf4f947393a6a4b271274b88018;hpb=0a3fecad0a4bf48a83eb7370a4d46880efdc6971;p=oota-llvm.git diff --git a/include/llvm/ADT/FoldingSet.h b/include/llvm/ADT/FoldingSet.h index e626b6e62ee..d6010adfb9f 100644 --- a/include/llvm/ADT/FoldingSet.h +++ b/include/llvm/ADT/FoldingSet.h @@ -9,7 +9,7 @@ // // This file defines a hash set that can be used to remove duplication of nodes // in a graph. This code was originally created by Chris Lattner for use with -// SelectionDAGCSEMap, but was isolated to provide use across the llvm code set. +// SelectionDAGCSEMap, but was isolated to provide use across the llvm code set. // //===----------------------------------------------------------------------===// @@ -22,21 +22,22 @@ namespace llvm { class APFloat; + class APInt; /// This folding set used for two purposes: /// 1. Given information about a node we want to create, look up the unique /// instance of the node in the set. If the node already exists, return /// it, otherwise return the bucket it should be inserted into. /// 2. Given a node that has already been created, remove it from the set. -/// +/// /// This class is implemented as a single-link chained hash table, where the /// "buckets" are actually the nodes themselves (the next pointer is in the -/// node). The last node points back to the bucket to simplified node removal. +/// node). The last node points back to the bucket to simplify node removal. /// /// Any node that is to be included in the folding set must be a subclass of /// FoldingSetNode. The node class must also define a Profile method used to /// establish the unique bits of data for the node. The Profile method is -/// passed a FoldingSetNodeID object which is used to gather the bits. Just +/// passed a FoldingSetNodeID object which is used to gather the bits. Just /// call one of the Add* functions defined in the FoldingSetImpl::NodeID class. /// NOTE: That the folding set does not own the nodes and it is the /// responsibility of the user to dispose of the nodes. @@ -61,7 +62,7 @@ namespace llvm { /// Eg. /// FoldingSet MyFoldingSet; /// -/// Four public methods are available to manipulate the folding set; +/// Four public methods are available to manipulate the folding set; /// /// 1) If you have an existing node that you want add to the set but unsure /// that the node might already exist then call; @@ -96,34 +97,34 @@ namespace llvm { /// bool WasRemoved = RemoveNode(N); /// /// The result indicates whether the node existed in the folding set. - + class FoldingSetNodeID; - + //===----------------------------------------------------------------------===// /// FoldingSetImpl - Implements the folding set functionality. The main /// structure is an array of buckets. Each bucket is indexed by the hash of /// the nodes it contains. The bucket itself points to the nodes contained /// in the bucket via a singly linked list. The last node in the list points /// back to the bucket to facilitate node removal. -/// +/// class FoldingSetImpl { protected: /// Buckets - Array of bucket chains. /// void **Buckets; - + /// NumBuckets - Length of the Buckets array. Always a power of 2. /// unsigned NumBuckets; - + /// NumNodes - Number of nodes in the folding set. Growth occurs when NumNodes /// is greater than twice the number of buckets. unsigned NumNodes; - + public: explicit FoldingSetImpl(unsigned Log2InitSize = 6); virtual ~FoldingSetImpl(); - + //===--------------------------------------------------------------------===// /// Node - This class is used to maintain the singly linked bucket list in /// a folding set. @@ -132,44 +133,50 @@ public: private: // NextInFoldingSetBucket - next link in the bucket list. void *NextInFoldingSetBucket; - + public: Node() : NextInFoldingSetBucket(0) {} - + // Accessors void *getNextInBucket() const { return NextInFoldingSetBucket; } void SetNextInBucket(void *N) { NextInFoldingSetBucket = N; } }; + /// clear - Remove all nodes from the folding set. + void clear(); + /// RemoveNode - Remove a node from the folding set, returning true if one /// was removed or false if the node was not in the folding set. bool RemoveNode(Node *N); - + /// GetOrInsertNode - If there is an existing simple Node exactly /// equal to the specified node, return it. Otherwise, insert 'N' and return /// it instead. Node *GetOrInsertNode(Node *N); - + /// FindNodeOrInsertPos - Look up the node specified by ID. If it exists, /// return it. If not, return the insertion token that will make insertion /// faster. Node *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos); - + /// InsertNode - Insert the specified node into the folding set, knowing that - /// it is not already in the folding set. InsertPos must be obtained from + /// it is not already in the folding set. InsertPos must be obtained from /// FindNodeOrInsertPos. void InsertNode(Node *N, void *InsertPos); - + /// size - Returns the number of nodes in the folding set. unsigned size() const { return NumNodes; } - + + /// empty - Returns true if there are no nodes in the folding set. + bool empty() const { return NumNodes == 0; } + private: /// GrowHashTable - Double the size of the hash table and rehash everything. /// void GrowHashTable(); - + protected: /// GetNodeProfile - Instantiations of the FoldingSet template implement @@ -177,66 +184,74 @@ protected: virtual void GetNodeProfile(FoldingSetNodeID &ID, Node *N) const = 0; }; +//===----------------------------------------------------------------------===// +/// FoldingSetTrait - This trait class is used to define behavior of how +/// to "profile" (in the FoldingSet parlance) an object of a given type. +/// The default behavior is to invoke a 'Profile' method on an object, but +/// through template specialization the behavior can be tailored for specific +/// types. Combined with the FoldingSetNodeWrapper classs, one can add objects +/// to FoldingSets that were not originally designed to have that behavior. +/// +template struct FoldingSetTrait { + static inline void Profile(const T& X, FoldingSetNodeID& ID) { X.Profile(ID);} + static inline void Profile(T& X, FoldingSetNodeID& ID) { X.Profile(ID); } +}; + //===--------------------------------------------------------------------===// /// FoldingSetNodeID - This class is used to gather all the unique data bits of /// a node. When all the bits are gathered this class is used to produce a -/// hash value for the node. +/// hash value for the node. /// class FoldingSetNodeID { /// Bits - Vector of all the data bits that make the node unique. /// Use a SmallVector to avoid a heap allocation in the common case. SmallVector Bits; - + public: FoldingSetNodeID() {} - + /// getRawData - Return the ith entry in the Bits data. /// unsigned getRawData(unsigned i) const { return Bits[i]; } - + /// Add* - Add various data types to Bit data. /// void AddPointer(const void *Ptr); void AddInteger(signed I); void AddInteger(unsigned I); - void AddInteger(int64_t I); - void AddInteger(uint64_t I); - void AddFloat(float F); - void AddDouble(double D); - void AddAPFloat(const APFloat& apf); + void AddInteger(long I); + void AddInteger(unsigned long I); + void AddInteger(long long I); + void AddInteger(unsigned long long I); void AddString(const std::string &String); - + void AddString(const char* String); + + template + inline void Add(const T& x) { FoldingSetTrait::Profile(x, *this); } + + /// clear - Clear the accumulated profile, allowing this FoldingSetNodeID + /// object to be used to compute a new profile. + inline void clear() { Bits.clear(); } + /// ComputeHash - Compute a strong hash value for this FoldingSetNodeID, used /// to lookup the node in the FoldingSetImpl. unsigned ComputeHash() const; - + /// operator== - Used to compare two nodes to each other. /// bool operator==(const FoldingSetNodeID &RHS) const; -}; +}; // Convenience type to hide the implementation of the folding set. typedef FoldingSetImpl::Node FoldingSetNode; template class FoldingSetIterator; +template class FoldingSetBucketIterator; -//===----------------------------------------------------------------------===// -/// FoldingSetTrait - This trait class is used to define behavior of how -/// to "profile" (in the FoldingSet parlance) an object of a given type. -/// The default behavior is to invoke a 'Profile' method on an object, but -/// through template specialization the behavior can be tailored for specific -/// types. Combined with the FoldingSetNodeWrapper classs, one can add objects -/// to FoldingSets that were not originally designed to have that behavior. -/// -template struct FoldingSetTrait { - static inline void Profile(const T& X, FoldingSetNodeID& ID) { X.Profile(ID);} - static inline void Profile(T& X, FoldingSetNodeID& ID) { X.Profile(ID); } -}; - //===----------------------------------------------------------------------===// /// FoldingSet - This template class is used to instantiate a specialized -/// implementation of the folding set to the node class T. T must be a +/// implementation of the folding set to the node class T. T must be a /// subclass of FoldingSetNode and implement a Profile function. /// template class FoldingSet : public FoldingSetImpl { @@ -247,12 +262,12 @@ private: T *TN = static_cast(N); FoldingSetTrait::Profile(*TN,ID); } - + public: explicit FoldingSet(unsigned Log2InitSize = 6) : FoldingSetImpl(Log2InitSize) {} - + typedef FoldingSetIterator iterator; iterator begin() { return iterator(Buckets); } iterator end() { return iterator(Buckets+NumBuckets); } @@ -261,13 +276,23 @@ public: const_iterator begin() const { return const_iterator(Buckets); } const_iterator end() const { return const_iterator(Buckets+NumBuckets); } + typedef FoldingSetBucketIterator bucket_iterator; + + bucket_iterator bucket_begin(unsigned hash) { + return bucket_iterator(Buckets + (hash & (NumBuckets-1))); + } + + bucket_iterator bucket_end(unsigned hash) { + return bucket_iterator(Buckets + (hash & (NumBuckets-1)), true); + } + /// GetOrInsertNode - If there is an existing simple Node exactly /// equal to the specified node, return it. Otherwise, insert 'N' and /// return it instead. T *GetOrInsertNode(Node *N) { return static_cast(FoldingSetImpl::GetOrInsertNode(N)); } - + /// FindNodeOrInsertPos - Look up the node specified by ID. If it exists, /// return it. If not, return the insertion token that will make insertion /// faster. @@ -284,7 +309,7 @@ protected: FoldingSetNode *NodePtr; FoldingSetIteratorImpl(void **Bucket); void advance(); - + public: bool operator==(const FoldingSetIteratorImpl &RHS) const { return NodePtr == RHS.NodePtr; @@ -298,16 +323,16 @@ public: template class FoldingSetIterator : public FoldingSetIteratorImpl { public: - FoldingSetIterator(void **Bucket) : FoldingSetIteratorImpl(Bucket) {} - + explicit FoldingSetIterator(void **Bucket) : FoldingSetIteratorImpl(Bucket) {} + T &operator*() const { return *static_cast(NodePtr); } - + T *operator->() const { return static_cast(NodePtr); } - + inline FoldingSetIterator& operator++() { // Preincrement advance(); return *this; @@ -316,7 +341,58 @@ public: FoldingSetIterator tmp = *this; ++*this; return tmp; } }; - + +//===----------------------------------------------------------------------===// +/// FoldingSetBucketIteratorImpl - This is the common bucket iterator support +/// shared by all folding sets, which knows how to walk a particular bucket +/// of a folding set hash table. + +class FoldingSetBucketIteratorImpl { +protected: + void *Ptr; + + explicit FoldingSetBucketIteratorImpl(void **Bucket); + + FoldingSetBucketIteratorImpl(void **Bucket, bool) + : Ptr(Bucket) {} + + void advance() { + void *Probe = static_cast(Ptr)->getNextInBucket(); + uintptr_t x = reinterpret_cast(Probe) & ~0x1; + Ptr = reinterpret_cast(x); + } + +public: + bool operator==(const FoldingSetBucketIteratorImpl &RHS) const { + return Ptr == RHS.Ptr; + } + bool operator!=(const FoldingSetBucketIteratorImpl &RHS) const { + return Ptr != RHS.Ptr; + } +}; + + +template +class FoldingSetBucketIterator : public FoldingSetBucketIteratorImpl { +public: + explicit FoldingSetBucketIterator(void **Bucket) : + FoldingSetBucketIteratorImpl(Bucket) {} + + FoldingSetBucketIterator(void **Bucket, bool) : + FoldingSetBucketIteratorImpl(Bucket, true) {} + + T& operator*() const { return *static_cast(Ptr); } + T* operator->() const { return static_cast(Ptr); } + + inline FoldingSetBucketIterator& operator++() { // Preincrement + advance(); + return *this; + } + FoldingSetBucketIterator operator++(int) { // Postincrement + FoldingSetBucketIterator tmp = *this; ++*this; return tmp; + } +}; + //===----------------------------------------------------------------------===// /// FoldingSetNodeWrapper - This template class is used to "wrap" arbitrary /// types in an enclosing object so that they can be inserted into FoldingSets. @@ -324,40 +400,59 @@ template class FoldingSetNodeWrapper : public FoldingSetNode { T data; public: - FoldingSetNodeWrapper(const T& x) : data(x) {} - virtual ~FoldingSetNodeWrapper(); - + explicit FoldingSetNodeWrapper(const T& x) : data(x) {} + virtual ~FoldingSetNodeWrapper() {} + template explicit FoldingSetNodeWrapper(const A1& a1) : data(a1) {} - + template explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2) : data(a1,a2) {} - + template explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2, const A3& a3) : data(a1,a2,a3) {} - + template explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2, const A3& a3, const A4& a4) : data(a1,a2,a3,a4) {} - + template explicit FoldingSetNodeWrapper(const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5) : data(a1,a2,a3,a4,a5) {} - + void Profile(FoldingSetNodeID& ID) { FoldingSetTrait::Profile(data, ID); } + T& getValue() { return data; } + const T& getValue() const { return data; } + operator T&() { return data; } operator const T&() const { return data; } }; -} // End of namespace llvm. +//===----------------------------------------------------------------------===// +// Partial specializations of FoldingSetTrait. +template struct FoldingSetTrait { + static inline void Profile(const T* X, FoldingSetNodeID& ID) { + ID.AddPointer(X); + } + static inline void Profile(T* X, FoldingSetNodeID& ID) { + ID.AddPointer(X); + } +}; -#endif +template struct FoldingSetTrait { + static inline void Profile(const T* X, FoldingSetNodeID& ID) { + ID.AddPointer(X); + } +}; +} // End of namespace llvm. + +#endif