LLVM 19.0.0git
FoldingSet.h
Go to the documentation of this file.
1//===- llvm/ADT/FoldingSet.h - Uniquing Hash Set ----------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8///
9/// \file
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
13/// set.
14//===----------------------------------------------------------------------===//
15
16#ifndef LLVM_ADT_FOLDINGSET_H
17#define LLVM_ADT_FOLDINGSET_H
18
19#include "llvm/ADT/APInt.h"
20#include "llvm/ADT/Hashing.h"
23#include "llvm/ADT/iterator.h"
25#include <cassert>
26#include <cstddef>
27#include <cstdint>
28#include <type_traits>
29#include <utility>
30
31namespace llvm {
32
33/// This folding set used for two purposes:
34/// 1. Given information about a node we want to create, look up the unique
35/// instance of the node in the set. If the node already exists, return
36/// it, otherwise return the bucket it should be inserted into.
37/// 2. Given a node that has already been created, remove it from the set.
38///
39/// This class is implemented as a single-link chained hash table, where the
40/// "buckets" are actually the nodes themselves (the next pointer is in the
41/// node). The last node points back to the bucket to simplify node removal.
42///
43/// Any node that is to be included in the folding set must be a subclass of
44/// FoldingSetNode. The node class must also define a Profile method used to
45/// establish the unique bits of data for the node. The Profile method is
46/// passed a FoldingSetNodeID object which is used to gather the bits. Just
47/// call one of the Add* functions defined in the FoldingSetBase::NodeID class.
48/// NOTE: That the folding set does not own the nodes and it is the
49/// responsibility of the user to dispose of the nodes.
50///
51/// Eg.
52/// class MyNode : public FoldingSetNode {
53/// private:
54/// std::string Name;
55/// unsigned Value;
56/// public:
57/// MyNode(const char *N, unsigned V) : Name(N), Value(V) {}
58/// ...
59/// void Profile(FoldingSetNodeID &ID) const {
60/// ID.AddString(Name);
61/// ID.AddInteger(Value);
62/// }
63/// ...
64/// };
65///
66/// To define the folding set itself use the FoldingSet template;
67///
68/// Eg.
69/// FoldingSet<MyNode> MyFoldingSet;
70///
71/// Four public methods are available to manipulate the folding set;
72///
73/// 1) If you have an existing node that you want add to the set but unsure
74/// that the node might already exist then call;
75///
76/// MyNode *M = MyFoldingSet.GetOrInsertNode(N);
77///
78/// If The result is equal to the input then the node has been inserted.
79/// Otherwise, the result is the node existing in the folding set, and the
80/// input can be discarded (use the result instead.)
81///
82/// 2) If you are ready to construct a node but want to check if it already
83/// exists, then call FindNodeOrInsertPos with a FoldingSetNodeID of the bits to
84/// check;
85///
86/// FoldingSetNodeID ID;
87/// ID.AddString(Name);
88/// ID.AddInteger(Value);
89/// void *InsertPoint;
90///
91/// MyNode *M = MyFoldingSet.FindNodeOrInsertPos(ID, InsertPoint);
92///
93/// If found then M will be non-NULL, else InsertPoint will point to where it
94/// should be inserted using InsertNode.
95///
96/// 3) If you get a NULL result from FindNodeOrInsertPos then you can insert a
97/// new node with InsertNode;
98///
99/// MyFoldingSet.InsertNode(M, InsertPoint);
100///
101/// 4) Finally, if you want to remove a node from the folding set call;
102///
103/// bool WasRemoved = MyFoldingSet.RemoveNode(M);
104///
105/// The result indicates whether the node existed in the folding set.
106
107class FoldingSetNodeID;
108class StringRef;
109
110//===----------------------------------------------------------------------===//
111/// FoldingSetBase - Implements the folding set functionality. The main
112/// structure is an array of buckets. Each bucket is indexed by the hash of
113/// the nodes it contains. The bucket itself points to the nodes contained
114/// in the bucket via a singly linked list. The last node in the list points
115/// back to the bucket to facilitate node removal.
116///
118protected:
119 /// Buckets - Array of bucket chains.
120 void **Buckets;
121
122 /// NumBuckets - Length of the Buckets array. Always a power of 2.
123 unsigned NumBuckets;
124
125 /// NumNodes - Number of nodes in the folding set. Growth occurs when NumNodes
126 /// is greater than twice the number of buckets.
127 unsigned NumNodes;
128
129 explicit FoldingSetBase(unsigned Log2InitSize = 6);
133
134public:
135 //===--------------------------------------------------------------------===//
136 /// Node - This class is used to maintain the singly linked bucket list in
137 /// a folding set.
138 class Node {
139 private:
140 // NextInFoldingSetBucket - next link in the bucket list.
141 void *NextInFoldingSetBucket = nullptr;
142
143 public:
144 Node() = default;
145
146 // Accessors
147 void *getNextInBucket() const { return NextInFoldingSetBucket; }
148 void SetNextInBucket(void *N) { NextInFoldingSetBucket = N; }
149 };
150
151 /// clear - Remove all nodes from the folding set.
152 void clear();
153
154 /// size - Returns the number of nodes in the folding set.
155 unsigned size() const { return NumNodes; }
156
157 /// empty - Returns true if there are no nodes in the folding set.
158 bool empty() const { return NumNodes == 0; }
159
160 /// capacity - Returns the number of nodes permitted in the folding set
161 /// before a rebucket operation is performed.
162 unsigned capacity() {
163 // We allow a load factor of up to 2.0,
164 // so that means our capacity is NumBuckets * 2
165 return NumBuckets * 2;
166 }
167
168protected:
169 /// Functions provided by the derived class to compute folding properties.
170 /// This is effectively a vtable for FoldingSetBase, except that we don't
171 /// actually store a pointer to it in the object.
173 /// GetNodeProfile - Instantiations of the FoldingSet template implement
174 /// this function to gather data bits for the given node.
175 void (*GetNodeProfile)(const FoldingSetBase *Self, Node *N,
177
178 /// NodeEquals - Instantiations of the FoldingSet template implement
179 /// this function to compare the given node with the given ID.
181 const FoldingSetNodeID &ID, unsigned IDHash,
182 FoldingSetNodeID &TempID);
183
184 /// ComputeNodeHash - Instantiations of the FoldingSet template implement
185 /// this function to compute a hash value for the given node.
187 FoldingSetNodeID &TempID);
188 };
189
190private:
191 /// GrowHashTable - Double the size of the hash table and rehash everything.
192 void GrowHashTable(const FoldingSetInfo &Info);
193
194 /// GrowBucketCount - resize the hash table and rehash everything.
195 /// NewBucketCount must be a power of two, and must be greater than the old
196 /// bucket count.
197 void GrowBucketCount(unsigned NewBucketCount, const FoldingSetInfo &Info);
198
199protected:
200 // The below methods are protected to encourage subclasses to provide a more
201 // type-safe API.
202
203 /// reserve - Increase the number of buckets such that adding the
204 /// EltCount-th node won't cause a rebucket operation. reserve is permitted
205 /// to allocate more space than requested by EltCount.
206 void reserve(unsigned EltCount, const FoldingSetInfo &Info);
207
208 /// RemoveNode - Remove a node from the folding set, returning true if one
209 /// was removed or false if the node was not in the folding set.
210 bool RemoveNode(Node *N);
211
212 /// GetOrInsertNode - If there is an existing simple Node exactly
213 /// equal to the specified node, return it. Otherwise, insert 'N' and return
214 /// it instead.
216
217 /// FindNodeOrInsertPos - Look up the node specified by ID. If it exists,
218 /// return it. If not, return the insertion token that will make insertion
219 /// faster.
220 Node *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos,
221 const FoldingSetInfo &Info);
222
223 /// InsertNode - Insert the specified node into the folding set, knowing that
224 /// it is not already in the folding set. InsertPos must be obtained from
225 /// FindNodeOrInsertPos.
226 void InsertNode(Node *N, void *InsertPos, const FoldingSetInfo &Info);
227};
228
229//===----------------------------------------------------------------------===//
230
231/// DefaultFoldingSetTrait - This class provides default implementations
232/// for FoldingSetTrait implementations.
233template<typename T> struct DefaultFoldingSetTrait {
234 static void Profile(const T &X, FoldingSetNodeID &ID) {
235 X.Profile(ID);
236 }
237 static void Profile(T &X, FoldingSetNodeID &ID) {
238 X.Profile(ID);
239 }
240
241 // Equals - Test if the profile for X would match ID, using TempID
242 // to compute a temporary ID if necessary. The default implementation
243 // just calls Profile and does a regular comparison. Implementations
244 // can override this to provide more efficient implementations.
245 static inline bool Equals(T &X, const FoldingSetNodeID &ID, unsigned IDHash,
246 FoldingSetNodeID &TempID);
247
248 // ComputeHash - Compute a hash value for X, using TempID to
249 // compute a temporary ID if necessary. The default implementation
250 // just calls Profile and does a regular hash computation.
251 // Implementations can override this to provide more efficient
252 // implementations.
253 static inline unsigned ComputeHash(T &X, FoldingSetNodeID &TempID);
254};
255
256/// FoldingSetTrait - This trait class is used to define behavior of how
257/// to "profile" (in the FoldingSet parlance) an object of a given type.
258/// The default behavior is to invoke a 'Profile' method on an object, but
259/// through template specialization the behavior can be tailored for specific
260/// types. Combined with the FoldingSetNodeWrapper class, one can add objects
261/// to FoldingSets that were not originally designed to have that behavior.
262template <typename T, typename Enable = void>
264
265/// DefaultContextualFoldingSetTrait - Like DefaultFoldingSetTrait, but
266/// for ContextualFoldingSets.
267template<typename T, typename Ctx>
269 static void Profile(T &X, FoldingSetNodeID &ID, Ctx Context) {
270 X.Profile(ID, Context);
271 }
272
273 static inline bool Equals(T &X, const FoldingSetNodeID &ID, unsigned IDHash,
274 FoldingSetNodeID &TempID, Ctx Context);
275 static inline unsigned ComputeHash(T &X, FoldingSetNodeID &TempID,
276 Ctx Context);
277};
278
279/// ContextualFoldingSetTrait - Like FoldingSetTrait, but for
280/// ContextualFoldingSets.
281template<typename T, typename Ctx> struct ContextualFoldingSetTrait
282 : public DefaultContextualFoldingSetTrait<T, Ctx> {};
283
284//===--------------------------------------------------------------------===//
285/// FoldingSetNodeIDRef - This class describes a reference to an interned
286/// FoldingSetNodeID, which can be a useful to store node id data rather
287/// than using plain FoldingSetNodeIDs, since the 32-element SmallVector
288/// is often much larger than necessary, and the possibility of heap
289/// allocation means it requires a non-trivial destructor call.
291 const unsigned *Data = nullptr;
292 size_t Size = 0;
293
294public:
296 FoldingSetNodeIDRef(const unsigned *D, size_t S) : Data(D), Size(S) {}
297
298 /// ComputeHash - Compute a strong hash value for this FoldingSetNodeIDRef,
299 /// used to lookup the node in the FoldingSetBase.
300 unsigned ComputeHash() const {
301 return static_cast<unsigned>(hash_combine_range(Data, Data + Size));
302 }
303
305
306 bool operator!=(FoldingSetNodeIDRef RHS) const { return !(*this == RHS); }
307
308 /// Used to compare the "ordering" of two nodes as defined by the
309 /// profiled bits and their ordering defined by memcmp().
310 bool operator<(FoldingSetNodeIDRef) const;
311
312 const unsigned *getData() const { return Data; }
313 size_t getSize() const { return Size; }
314};
315
316//===--------------------------------------------------------------------===//
317/// FoldingSetNodeID - This class is used to gather all the unique data bits of
318/// a node. When all the bits are gathered this class is used to produce a
319/// hash value for the node.
321 /// Bits - Vector of all the data bits that make the node unique.
322 /// Use a SmallVector to avoid a heap allocation in the common case.
324
325public:
326 FoldingSetNodeID() = default;
327
329 : Bits(Ref.getData(), Ref.getData() + Ref.getSize()) {}
330
331 /// Add* - Add various data types to Bit data.
332 void AddPointer(const void *Ptr) {
333 // Note: this adds pointers to the hash using sizes and endianness that
334 // depend on the host. It doesn't matter, however, because hashing on
335 // pointer values is inherently unstable. Nothing should depend on the
336 // ordering of nodes in the folding set.
337 static_assert(sizeof(uintptr_t) <= sizeof(unsigned long long),
338 "unexpected pointer size");
339 AddInteger(reinterpret_cast<uintptr_t>(Ptr));
340 }
341 void AddInteger(signed I) { Bits.push_back(I); }
342 void AddInteger(unsigned I) { Bits.push_back(I); }
343 void AddInteger(long I) { AddInteger((unsigned long)I); }
344 void AddInteger(unsigned long I) {
345 if (sizeof(long) == sizeof(int))
346 AddInteger(unsigned(I));
347 else if (sizeof(long) == sizeof(long long)) {
348 AddInteger((unsigned long long)I);
349 } else {
350 llvm_unreachable("unexpected sizeof(long)");
351 }
352 }
353 void AddInteger(long long I) { AddInteger((unsigned long long)I); }
354 void AddInteger(unsigned long long I) {
355 AddInteger(unsigned(I));
356 AddInteger(unsigned(I >> 32));
357 }
358 void AddInteger(const APInt &Int) {
359 const auto *Parts = Int.getRawData();
360 for (int i = 0, N = Int.getNumWords(); i < N; ++i) {
361 AddInteger(Parts[i]);
362 }
363 }
364
365 void AddBoolean(bool B) { AddInteger(B ? 1U : 0U); }
367 void AddNodeID(const FoldingSetNodeID &ID);
368
369 template <typename T>
370 inline void Add(const T &x) { FoldingSetTrait<T>::Profile(x, *this); }
371
372 /// clear - Clear the accumulated profile, allowing this FoldingSetNodeID
373 /// object to be used to compute a new profile.
374 inline void clear() { Bits.clear(); }
375
376 /// ComputeHash - Compute a strong hash value for this FoldingSetNodeID, used
377 /// to lookup the node in the FoldingSetBase.
378 unsigned ComputeHash() const {
379 return FoldingSetNodeIDRef(Bits.data(), Bits.size()).ComputeHash();
380 }
381
382 /// operator== - Used to compare two nodes to each other.
383 bool operator==(const FoldingSetNodeID &RHS) const;
384 bool operator==(const FoldingSetNodeIDRef RHS) const;
385
386 bool operator!=(const FoldingSetNodeID &RHS) const { return !(*this == RHS); }
387 bool operator!=(const FoldingSetNodeIDRef RHS) const { return !(*this ==RHS);}
388
389 /// Used to compare the "ordering" of two nodes as defined by the
390 /// profiled bits and their ordering defined by memcmp().
391 bool operator<(const FoldingSetNodeID &RHS) const;
392 bool operator<(const FoldingSetNodeIDRef RHS) const;
393
394 /// Intern - Copy this node's data to a memory region allocated from the
395 /// given allocator and return a FoldingSetNodeIDRef describing the
396 /// interned data.
398};
399
400// Convenience type to hide the implementation of the folding set.
402template<class T> class FoldingSetIterator;
403template<class T> class FoldingSetBucketIterator;
404
405// Definitions of FoldingSetTrait and ContextualFoldingSetTrait functions, which
406// require the definition of FoldingSetNodeID.
407template<typename T>
408inline bool
410 unsigned /*IDHash*/,
411 FoldingSetNodeID &TempID) {
413 return TempID == ID;
414}
415template<typename T>
416inline unsigned
419 return TempID.ComputeHash();
420}
421template<typename T, typename Ctx>
422inline bool
424 const FoldingSetNodeID &ID,
425 unsigned /*IDHash*/,
426 FoldingSetNodeID &TempID,
427 Ctx Context) {
429 return TempID == ID;
430}
431template<typename T, typename Ctx>
432inline unsigned
434 FoldingSetNodeID &TempID,
435 Ctx Context) {
437 return TempID.ComputeHash();
438}
439
440//===----------------------------------------------------------------------===//
441/// FoldingSetImpl - An implementation detail that lets us share code between
442/// FoldingSet and ContextualFoldingSet.
443template <class Derived, class T> class FoldingSetImpl : public FoldingSetBase {
444protected:
445 explicit FoldingSetImpl(unsigned Log2InitSize)
446 : FoldingSetBase(Log2InitSize) {}
447
450 ~FoldingSetImpl() = default;
451
452public:
454
457
459
462
464
466 return bucket_iterator(Buckets + (hash & (NumBuckets-1)));
467 }
468
470 return bucket_iterator(Buckets + (hash & (NumBuckets-1)), true);
471 }
472
473 /// reserve - Increase the number of buckets such that adding the
474 /// EltCount-th node won't cause a rebucket operation. reserve is permitted
475 /// to allocate more space than requested by EltCount.
476 void reserve(unsigned EltCount) {
477 return FoldingSetBase::reserve(EltCount, Derived::getFoldingSetInfo());
478 }
479
480 /// RemoveNode - Remove a node from the folding set, returning true if one
481 /// was removed or false if the node was not in the folding set.
482 bool RemoveNode(T *N) {
484 }
485
486 /// GetOrInsertNode - If there is an existing simple Node exactly
487 /// equal to the specified node, return it. Otherwise, insert 'N' and
488 /// return it instead.
490 return static_cast<T *>(
491 FoldingSetBase::GetOrInsertNode(N, Derived::getFoldingSetInfo()));
492 }
493
494 /// FindNodeOrInsertPos - Look up the node specified by ID. If it exists,
495 /// return it. If not, return the insertion token that will make insertion
496 /// faster.
497 T *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos) {
498 return static_cast<T *>(FoldingSetBase::FindNodeOrInsertPos(
499 ID, InsertPos, Derived::getFoldingSetInfo()));
500 }
501
502 /// InsertNode - Insert the specified node into the folding set, knowing that
503 /// it is not already in the folding set. InsertPos must be obtained from
504 /// FindNodeOrInsertPos.
505 void InsertNode(T *N, void *InsertPos) {
506 FoldingSetBase::InsertNode(N, InsertPos, Derived::getFoldingSetInfo());
507 }
508
509 /// InsertNode - Insert the specified node into the folding set, knowing that
510 /// it is not already in the folding set.
511 void InsertNode(T *N) {
512 T *Inserted = GetOrInsertNode(N);
513 (void)Inserted;
514 assert(Inserted == N && "Node already inserted!");
515 }
516};
517
518//===----------------------------------------------------------------------===//
519/// FoldingSet - This template class is used to instantiate a specialized
520/// implementation of the folding set to the node class T. T must be a
521/// subclass of FoldingSetNode and implement a Profile function.
522///
523/// Note that this set type is movable and move-assignable. However, its
524/// moved-from state is not a valid state for anything other than
525/// move-assigning and destroying. This is primarily to enable movable APIs
526/// that incorporate these objects.
527template <class T>
528class FoldingSet : public FoldingSetImpl<FoldingSet<T>, T> {
530 using Node = typename Super::Node;
531
532 /// GetNodeProfile - Each instantiation of the FoldingSet needs to provide a
533 /// way to convert nodes into a unique specifier.
534 static void GetNodeProfile(const FoldingSetBase *, Node *N,
536 T *TN = static_cast<T *>(N);
538 }
539
540 /// NodeEquals - Instantiations may optionally provide a way to compare a
541 /// node with a specified ID.
542 static bool NodeEquals(const FoldingSetBase *, Node *N,
543 const FoldingSetNodeID &ID, unsigned IDHash,
544 FoldingSetNodeID &TempID) {
545 T *TN = static_cast<T *>(N);
546 return FoldingSetTrait<T>::Equals(*TN, ID, IDHash, TempID);
547 }
548
549 /// ComputeNodeHash - Instantiations may optionally provide a way to compute a
550 /// hash value directly from a node.
551 static unsigned ComputeNodeHash(const FoldingSetBase *, Node *N,
552 FoldingSetNodeID &TempID) {
553 T *TN = static_cast<T *>(N);
554 return FoldingSetTrait<T>::ComputeHash(*TN, TempID);
555 }
556
557 static const FoldingSetBase::FoldingSetInfo &getFoldingSetInfo() {
558 static constexpr FoldingSetBase::FoldingSetInfo Info = {
559 GetNodeProfile, NodeEquals, ComputeNodeHash};
560 return Info;
561 }
562 friend Super;
563
564public:
565 explicit FoldingSet(unsigned Log2InitSize = 6) : Super(Log2InitSize) {}
566 FoldingSet(FoldingSet &&Arg) = default;
568};
569
570//===----------------------------------------------------------------------===//
571/// ContextualFoldingSet - This template class is a further refinement
572/// of FoldingSet which provides a context argument when calling
573/// Profile on its nodes. Currently, that argument is fixed at
574/// initialization time.
575///
576/// T must be a subclass of FoldingSetNode and implement a Profile
577/// function with signature
578/// void Profile(FoldingSetNodeID &, Ctx);
579template <class T, class Ctx>
581 : public FoldingSetImpl<ContextualFoldingSet<T, Ctx>, T> {
582 // Unfortunately, this can't derive from FoldingSet<T> because the
583 // construction of the vtable for FoldingSet<T> requires
584 // FoldingSet<T>::GetNodeProfile to be instantiated, which in turn
585 // requires a single-argument T::Profile().
586
588 using Node = typename Super::Node;
589
590 Ctx Context;
591
592 static const Ctx &getContext(const FoldingSetBase *Base) {
593 return static_cast<const ContextualFoldingSet*>(Base)->Context;
594 }
595
596 /// GetNodeProfile - Each instantiatation of the FoldingSet needs to provide a
597 /// way to convert nodes into a unique specifier.
598 static void GetNodeProfile(const FoldingSetBase *Base, Node *N,
600 T *TN = static_cast<T *>(N);
602 }
603
604 static bool NodeEquals(const FoldingSetBase *Base, Node *N,
605 const FoldingSetNodeID &ID, unsigned IDHash,
606 FoldingSetNodeID &TempID) {
607 T *TN = static_cast<T *>(N);
608 return ContextualFoldingSetTrait<T, Ctx>::Equals(*TN, ID, IDHash, TempID,
610 }
611
612 static unsigned ComputeNodeHash(const FoldingSetBase *Base, Node *N,
613 FoldingSetNodeID &TempID) {
614 T *TN = static_cast<T *>(N);
617 }
618
619 static const FoldingSetBase::FoldingSetInfo &getFoldingSetInfo() {
620 static constexpr FoldingSetBase::FoldingSetInfo Info = {
621 GetNodeProfile, NodeEquals, ComputeNodeHash};
622 return Info;
623 }
624 friend Super;
625
626public:
627 explicit ContextualFoldingSet(Ctx Context, unsigned Log2InitSize = 6)
628 : Super(Log2InitSize), Context(Context) {}
629
630 Ctx getContext() const { return Context; }
631};
632
633//===----------------------------------------------------------------------===//
634/// FoldingSetVector - This template class combines a FoldingSet and a vector
635/// to provide the interface of FoldingSet but with deterministic iteration
636/// order based on the insertion order. T must be a subclass of FoldingSetNode
637/// and implement a Profile function.
638template <class T, class VectorT = SmallVector<T*, 8>>
640 FoldingSet<T> Set;
641 VectorT Vector;
642
643public:
644 explicit FoldingSetVector(unsigned Log2InitSize = 6) : Set(Log2InitSize) {}
645
647
648 iterator begin() { return Vector.begin(); }
649 iterator end() { return Vector.end(); }
650
652
653 const_iterator begin() const { return Vector.begin(); }
654 const_iterator end() const { return Vector.end(); }
655
656 /// clear - Remove all nodes from the folding set.
657 void clear() { Set.clear(); Vector.clear(); }
658
659 /// FindNodeOrInsertPos - Look up the node specified by ID. If it exists,
660 /// return it. If not, return the insertion token that will make insertion
661 /// faster.
662 T *FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos) {
663 return Set.FindNodeOrInsertPos(ID, InsertPos);
664 }
665
666 /// GetOrInsertNode - If there is an existing simple Node exactly
667 /// equal to the specified node, return it. Otherwise, insert 'N' and
668 /// return it instead.
670 T *Result = Set.GetOrInsertNode(N);
671 if (Result == N) Vector.push_back(N);
672 return Result;
673 }
674
675 /// InsertNode - Insert the specified node into the folding set, knowing that
676 /// it is not already in the folding set. InsertPos must be obtained from
677 /// FindNodeOrInsertPos.
678 void InsertNode(T *N, void *InsertPos) {
679 Set.InsertNode(N, InsertPos);
680 Vector.push_back(N);
681 }
682
683 /// InsertNode - Insert the specified node into the folding set, knowing that
684 /// it is not already in the folding set.
685 void InsertNode(T *N) {
686 Set.InsertNode(N);
687 Vector.push_back(N);
688 }
689
690 /// size - Returns the number of nodes in the folding set.
691 unsigned size() const { return Set.size(); }
692
693 /// empty - Returns true if there are no nodes in the folding set.
694 bool empty() const { return Set.empty(); }
695};
696
697//===----------------------------------------------------------------------===//
698/// FoldingSetIteratorImpl - This is the common iterator support shared by all
699/// folding sets, which knows how to walk the folding set hash table.
701protected:
703
704 FoldingSetIteratorImpl(void **Bucket);
705
706 void advance();
707
708public:
710 return NodePtr == RHS.NodePtr;
711 }
713 return NodePtr != RHS.NodePtr;
714 }
715};
716
717template <class T> class FoldingSetIterator : public FoldingSetIteratorImpl {
718public:
719 explicit FoldingSetIterator(void **Bucket) : FoldingSetIteratorImpl(Bucket) {}
720
721 T &operator*() const {
722 return *static_cast<T*>(NodePtr);
723 }
724
725 T *operator->() const {
726 return static_cast<T*>(NodePtr);
727 }
728
729 inline FoldingSetIterator &operator++() { // Preincrement
730 advance();
731 return *this;
732 }
733 FoldingSetIterator operator++(int) { // Postincrement
734 FoldingSetIterator tmp = *this; ++*this; return tmp;
735 }
736};
737
738//===----------------------------------------------------------------------===//
739/// FoldingSetBucketIteratorImpl - This is the common bucket iterator support
740/// shared by all folding sets, which knows how to walk a particular bucket
741/// of a folding set hash table.
743protected:
744 void *Ptr;
745
746 explicit FoldingSetBucketIteratorImpl(void **Bucket);
747
748 FoldingSetBucketIteratorImpl(void **Bucket, bool) : Ptr(Bucket) {}
749
750 void advance() {
751 void *Probe = static_cast<FoldingSetNode*>(Ptr)->getNextInBucket();
752 uintptr_t x = reinterpret_cast<uintptr_t>(Probe) & ~0x1;
753 Ptr = reinterpret_cast<void*>(x);
754 }
755
756public:
758 return Ptr == RHS.Ptr;
759 }
761 return Ptr != RHS.Ptr;
762 }
763};
764
765template <class T>
767public:
768 explicit FoldingSetBucketIterator(void **Bucket) :
770
771 FoldingSetBucketIterator(void **Bucket, bool) :
773
774 T &operator*() const { return *static_cast<T*>(Ptr); }
775 T *operator->() const { return static_cast<T*>(Ptr); }
776
777 inline FoldingSetBucketIterator &operator++() { // Preincrement
778 advance();
779 return *this;
780 }
781 FoldingSetBucketIterator operator++(int) { // Postincrement
782 FoldingSetBucketIterator tmp = *this; ++*this; return tmp;
783 }
784};
785
786//===----------------------------------------------------------------------===//
787/// FoldingSetNodeWrapper - This template class is used to "wrap" arbitrary
788/// types in an enclosing object so that they can be inserted into FoldingSets.
789template <typename T>
791 T data;
792
793public:
794 template <typename... Ts>
795 explicit FoldingSetNodeWrapper(Ts &&... Args)
796 : data(std::forward<Ts>(Args)...) {}
797
799
800 T &getValue() { return data; }
801 const T &getValue() const { return data; }
802
803 operator T&() { return data; }
804 operator const T&() const { return data; }
805};
806
807//===----------------------------------------------------------------------===//
808/// FastFoldingSetNode - This is a subclass of FoldingSetNode which stores
809/// a FoldingSetNodeID value rather than requiring the node to recompute it
810/// each time it is needed. This trades space for speed (which can be
811/// significant if the ID is long), and it also permits nodes to drop
812/// information that would otherwise only be required for recomputing an ID.
814 FoldingSetNodeID FastID;
815
816protected:
817 explicit FastFoldingSetNode(const FoldingSetNodeID &ID) : FastID(ID) {}
818
819public:
820 void Profile(FoldingSetNodeID &ID) const { ID.AddNodeID(FastID); }
821};
822
823//===----------------------------------------------------------------------===//
824// Partial specializations of FoldingSetTrait.
825
826template<typename T> struct FoldingSetTrait<T*> {
827 static inline void Profile(T *X, FoldingSetNodeID &ID) {
828 ID.AddPointer(X);
829 }
830};
831template <typename T1, typename T2>
832struct FoldingSetTrait<std::pair<T1, T2>> {
833 static inline void Profile(const std::pair<T1, T2> &P,
835 ID.Add(P.first);
836 ID.Add(P.second);
837 }
838};
839
840template <typename T>
841struct FoldingSetTrait<T, std::enable_if_t<std::is_enum<T>::value>> {
842 static void Profile(const T &X, FoldingSetNodeID &ID) {
843 ID.AddInteger(llvm::to_underlying(X));
844 }
845};
846
847} // end namespace llvm
848
849#endif // LLVM_ADT_FOLDINGSET_H
This file implements a class to represent arbitrary precision integral constant values and operations...
This file defines the BumpPtrAllocator interface.
basic Basic Alias true
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
Analysis containing CSE Info
Definition: CSEInfo.cpp:27
static GCMetadataPrinterRegistry::Add< ErlangGCPrinter > X("erlang", "erlang-compatible garbage collector")
#define I(x, y, z)
Definition: MD5.cpp:58
LLVMContext & Context
#define P(N)
Basic Register Allocator
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file contains library features backported from future STL versions.
This file defines the SmallVector class.
Value * RHS
static unsigned getSize(unsigned Kind)
Class for arbitrary precision integers.
Definition: APInt.h:76
Allocate memory in an ever growing pool, as if by bump-pointer.
Definition: Allocator.h:66
ContextualFoldingSet - This template class is a further refinement of FoldingSet which provides a con...
Definition: FoldingSet.h:581
ContextualFoldingSet(Ctx Context, unsigned Log2InitSize=6)
Definition: FoldingSet.h:627
FastFoldingSetNode - This is a subclass of FoldingSetNode which stores a FoldingSetNodeID value rathe...
Definition: FoldingSet.h:813
FastFoldingSetNode(const FoldingSetNodeID &ID)
Definition: FoldingSet.h:817
void Profile(FoldingSetNodeID &ID) const
Definition: FoldingSet.h:820
Node - This class is used to maintain the singly linked bucket list in a folding set.
Definition: FoldingSet.h:138
void * getNextInBucket() const
Definition: FoldingSet.h:147
void SetNextInBucket(void *N)
Definition: FoldingSet.h:148
FoldingSetBase - Implements the folding set functionality.
Definition: FoldingSet.h:117
void ** Buckets
Buckets - Array of bucket chains.
Definition: FoldingSet.h:120
unsigned size() const
size - Returns the number of nodes in the folding set.
Definition: FoldingSet.h:155
void reserve(unsigned EltCount, const FoldingSetInfo &Info)
reserve - Increase the number of buckets such that adding the EltCount-th node won't cause a rebucket...
Definition: FoldingSet.cpp:266
bool RemoveNode(Node *N)
RemoveNode - Remove a node from the folding set, returning true if one was removed or false if the no...
Definition: FoldingSet.cpp:334
FoldingSetBase & operator=(FoldingSetBase &&RHS)
Definition: FoldingSet.cpp:198
unsigned NumBuckets
NumBuckets - Length of the Buckets array. Always a power of 2.
Definition: FoldingSet.h:123
unsigned NumNodes
NumNodes - Number of nodes in the folding set.
Definition: FoldingSet.h:127
unsigned capacity()
capacity - Returns the number of nodes permitted in the folding set before a rebucket operation is pe...
Definition: FoldingSet.h:162
Node * GetOrInsertNode(Node *N, const FoldingSetInfo &Info)
GetOrInsertNode - If there is an existing simple Node exactly equal to the specified node,...
Definition: FoldingSet.cpp:376
bool empty() const
empty - Returns true if there are no nodes in the folding set.
Definition: FoldingSet.h:158
void InsertNode(Node *N, void *InsertPos, const FoldingSetInfo &Info)
InsertNode - Insert the specified node into the folding set, knowing that it is not already in the fo...
Definition: FoldingSet.cpp:303
void clear()
clear - Remove all nodes from the folding set.
Definition: FoldingSet.cpp:213
Node * FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos, const FoldingSetInfo &Info)
FindNodeOrInsertPos - Look up the node specified by ID.
Definition: FoldingSet.cpp:278
FoldingSetBucketIteratorImpl - This is the common bucket iterator support shared by all folding sets,...
Definition: FoldingSet.h:742
FoldingSetBucketIteratorImpl(void **Bucket, bool)
Definition: FoldingSet.h:748
bool operator!=(const FoldingSetBucketIteratorImpl &RHS) const
Definition: FoldingSet.h:760
bool operator==(const FoldingSetBucketIteratorImpl &RHS) const
Definition: FoldingSet.h:757
FoldingSetBucketIterator(void **Bucket, bool)
Definition: FoldingSet.h:771
FoldingSetBucketIterator(void **Bucket)
Definition: FoldingSet.h:768
FoldingSetBucketIterator operator++(int)
Definition: FoldingSet.h:781
FoldingSetBucketIterator & operator++()
Definition: FoldingSet.h:777
FoldingSetImpl - An implementation detail that lets us share code between FoldingSet and ContextualFo...
Definition: FoldingSet.h:443
void reserve(unsigned EltCount)
reserve - Increase the number of buckets such that adding the EltCount-th node won't cause a rebucket...
Definition: FoldingSet.h:476
FoldingSetIterator< T > iterator
Definition: FoldingSet.h:453
const_iterator end() const
Definition: FoldingSet.h:461
bucket_iterator bucket_begin(unsigned hash)
Definition: FoldingSet.h:465
bool RemoveNode(T *N)
RemoveNode - Remove a node from the folding set, returning true if one was removed or false if the no...
Definition: FoldingSet.h:482
~FoldingSetImpl()=default
FoldingSetImpl(FoldingSetImpl &&Arg)=default
FoldingSetBucketIterator< T > bucket_iterator
Definition: FoldingSet.h:463
void InsertNode(T *N)
InsertNode - Insert the specified node into the folding set, knowing that it is not already in the fo...
Definition: FoldingSet.h:511
void InsertNode(T *N, void *InsertPos)
InsertNode - Insert the specified node into the folding set, knowing that it is not already in the fo...
Definition: FoldingSet.h:505
T * FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos)
FindNodeOrInsertPos - Look up the node specified by ID.
Definition: FoldingSet.h:497
const_iterator begin() const
Definition: FoldingSet.h:460
FoldingSetIterator< const T > const_iterator
Definition: FoldingSet.h:458
FoldingSetImpl & operator=(FoldingSetImpl &&RHS)=default
T * GetOrInsertNode(T *N)
GetOrInsertNode - If there is an existing simple Node exactly equal to the specified node,...
Definition: FoldingSet.h:489
FoldingSetImpl(unsigned Log2InitSize)
Definition: FoldingSet.h:445
bucket_iterator bucket_end(unsigned hash)
Definition: FoldingSet.h:469
FoldingSetIteratorImpl - This is the common iterator support shared by all folding sets,...
Definition: FoldingSet.h:700
FoldingSetNode * NodePtr
Definition: FoldingSet.h:702
bool operator==(const FoldingSetIteratorImpl &RHS) const
Definition: FoldingSet.h:709
bool operator!=(const FoldingSetIteratorImpl &RHS) const
Definition: FoldingSet.h:712
FoldingSetIterator(void **Bucket)
Definition: FoldingSet.h:719
FoldingSetIterator operator++(int)
Definition: FoldingSet.h:733
FoldingSetIterator & operator++()
Definition: FoldingSet.h:729
FoldingSetNodeIDRef - This class describes a reference to an interned FoldingSetNodeID,...
Definition: FoldingSet.h:290
bool operator==(FoldingSetNodeIDRef) const
Definition: FoldingSet.cpp:27
FoldingSetNodeIDRef(const unsigned *D, size_t S)
Definition: FoldingSet.h:296
bool operator<(FoldingSetNodeIDRef) const
Used to compare the "ordering" of two nodes as defined by the profiled bits and their ordering define...
Definition: FoldingSet.cpp:34
bool operator!=(FoldingSetNodeIDRef RHS) const
Definition: FoldingSet.h:306
unsigned ComputeHash() const
ComputeHash - Compute a strong hash value for this FoldingSetNodeIDRef, used to lookup the node in th...
Definition: FoldingSet.h:300
size_t getSize() const
Definition: FoldingSet.h:313
const unsigned * getData() const
Definition: FoldingSet.h:312
FoldingSetNodeID - This class is used to gather all the unique data bits of a node.
Definition: FoldingSet.h:320
FoldingSetNodeIDRef Intern(BumpPtrAllocator &Allocator) const
Intern - Copy this node's data to a memory region allocated from the given allocator and return a Fol...
Definition: FoldingSet.cpp:132
void AddInteger(signed I)
Definition: FoldingSet.h:341
void AddInteger(unsigned long I)
Definition: FoldingSet.h:344
FoldingSetNodeID(FoldingSetNodeIDRef Ref)
Definition: FoldingSet.h:328
void AddPointer(const void *Ptr)
Add* - Add various data types to Bit data.
Definition: FoldingSet.h:332
bool operator!=(const FoldingSetNodeIDRef RHS) const
Definition: FoldingSet.h:387
void clear()
clear - Clear the accumulated profile, allowing this FoldingSetNodeID object to be used to compute a ...
Definition: FoldingSet.h:374
void AddInteger(const APInt &Int)
Definition: FoldingSet.h:358
void AddInteger(unsigned I)
Definition: FoldingSet.h:342
void AddInteger(long I)
Definition: FoldingSet.h:343
void AddBoolean(bool B)
Definition: FoldingSet.h:365
bool operator==(const FoldingSetNodeID &RHS) const
operator== - Used to compare two nodes to each other.
Definition: FoldingSet.cpp:108
bool operator!=(const FoldingSetNodeID &RHS) const
Definition: FoldingSet.h:386
void AddInteger(unsigned long long I)
Definition: FoldingSet.h:354
void AddInteger(long long I)
Definition: FoldingSet.h:353
unsigned ComputeHash() const
ComputeHash - Compute a strong hash value for this FoldingSetNodeID, used to lookup the node in the F...
Definition: FoldingSet.h:378
bool operator<(const FoldingSetNodeID &RHS) const
Used to compare the "ordering" of two nodes as defined by the profiled bits and their ordering define...
Definition: FoldingSet.cpp:120
void AddNodeID(const FoldingSetNodeID &ID)
Definition: FoldingSet.cpp:102
void Add(const T &x)
Definition: FoldingSet.h:370
void AddString(StringRef String)
Add* - Add various data types to Bit data.
Definition: FoldingSet.cpp:45
FoldingSetNodeWrapper - This template class is used to "wrap" arbitrary types in an enclosing object ...
Definition: FoldingSet.h:790
FoldingSetNodeWrapper(Ts &&... Args)
Definition: FoldingSet.h:795
const T & getValue() const
Definition: FoldingSet.h:801
void Profile(FoldingSetNodeID &ID)
Definition: FoldingSet.h:798
FoldingSetVector - This template class combines a FoldingSet and a vector to provide the interface of...
Definition: FoldingSet.h:639
T * GetOrInsertNode(T *N)
GetOrInsertNode - If there is an existing simple Node exactly equal to the specified node,...
Definition: FoldingSet.h:669
const_iterator end() const
Definition: FoldingSet.h:654
void InsertNode(T *N)
InsertNode - Insert the specified node into the folding set, knowing that it is not already in the fo...
Definition: FoldingSet.h:685
T * FindNodeOrInsertPos(const FoldingSetNodeID &ID, void *&InsertPos)
FindNodeOrInsertPos - Look up the node specified by ID.
Definition: FoldingSet.h:662
unsigned size() const
size - Returns the number of nodes in the folding set.
Definition: FoldingSet.h:691
void clear()
clear - Remove all nodes from the folding set.
Definition: FoldingSet.h:657
bool empty() const
empty - Returns true if there are no nodes in the folding set.
Definition: FoldingSet.h:694
FoldingSetVector(unsigned Log2InitSize=6)
Definition: FoldingSet.h:644
void InsertNode(T *N, void *InsertPos)
InsertNode - Insert the specified node into the folding set, knowing that it is not already in the fo...
Definition: FoldingSet.h:678
const_iterator begin() const
Definition: FoldingSet.h:653
FoldingSet - This template class is used to instantiate a specialized implementation of the folding s...
Definition: FoldingSet.h:528
FoldingSet(FoldingSet &&Arg)=default
FoldingSet(unsigned Log2InitSize=6)
Definition: FoldingSet.h:565
FoldingSet & operator=(FoldingSet &&RHS)=default
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1209
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition: CallingConv.h:24
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
constexpr std::underlying_type_t< Enum > to_underlying(Enum E)
Returns underlying integer value of an enum.
@ Ref
The access may reference the value stored in memory.
hash_code hash_combine_range(InputIteratorT first, InputIteratorT last)
Compute a hash_code for a sequence of values.
Definition: Hashing.h:491
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858
#define N
ContextualFoldingSetTrait - Like FoldingSetTrait, but for ContextualFoldingSets.
Definition: FoldingSet.h:282
DefaultContextualFoldingSetTrait - Like DefaultFoldingSetTrait, but for ContextualFoldingSets.
Definition: FoldingSet.h:268
static bool Equals(T &X, const FoldingSetNodeID &ID, unsigned IDHash, FoldingSetNodeID &TempID, Ctx Context)
Definition: FoldingSet.h:423
static void Profile(T &X, FoldingSetNodeID &ID, Ctx Context)
Definition: FoldingSet.h:269
static unsigned ComputeHash(T &X, FoldingSetNodeID &TempID, Ctx Context)
Definition: FoldingSet.h:433
DefaultFoldingSetTrait - This class provides default implementations for FoldingSetTrait implementati...
Definition: FoldingSet.h:233
static void Profile(const T &X, FoldingSetNodeID &ID)
Definition: FoldingSet.h:234
static unsigned ComputeHash(T &X, FoldingSetNodeID &TempID)
Definition: FoldingSet.h:417
static bool Equals(T &X, const FoldingSetNodeID &ID, unsigned IDHash, FoldingSetNodeID &TempID)
Definition: FoldingSet.h:409
static void Profile(T &X, FoldingSetNodeID &ID)
Definition: FoldingSet.h:237
Functions provided by the derived class to compute folding properties.
Definition: FoldingSet.h:172
unsigned(* ComputeNodeHash)(const FoldingSetBase *Self, Node *N, FoldingSetNodeID &TempID)
ComputeNodeHash - Instantiations of the FoldingSet template implement this function to compute a hash...
Definition: FoldingSet.h:186
bool(* NodeEquals)(const FoldingSetBase *Self, Node *N, const FoldingSetNodeID &ID, unsigned IDHash, FoldingSetNodeID &TempID)
NodeEquals - Instantiations of the FoldingSet template implement this function to compare the given n...
Definition: FoldingSet.h:180
void(* GetNodeProfile)(const FoldingSetBase *Self, Node *N, FoldingSetNodeID &ID)
GetNodeProfile - Instantiations of the FoldingSet template implement this function to gather data bit...
Definition: FoldingSet.h:175
static void Profile(const T &X, FoldingSetNodeID &ID)
Definition: FoldingSet.h:842
static void Profile(T *X, FoldingSetNodeID &ID)
Definition: FoldingSet.h:827
static void Profile(const std::pair< T1, T2 > &P, FoldingSetNodeID &ID)
Definition: FoldingSet.h:833
FoldingSetTrait - This trait class is used to define behavior of how to "profile" (in the FoldingSet ...
Definition: FoldingSet.h:263
An iterator type that allows iterating over the pointees via some other iterator.
Definition: iterator.h:324