1 //===- llvm/ADT/SmallPtrSet.h - 'Normally small' pointer set ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Chris Lattner and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the SmallPtrSet class. See the doxygen comment for
11 // SmallPtrSetImpl for more details on the algorithm used.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_ADT_SMALLPTRSET_H
16 #define LLVM_ADT_SMALLPTRSET_H
20 #include "llvm/Support/DataTypes.h"
24 /// SmallPtrSetImpl - This is the common code shared among all the
25 /// SmallPtrSet<>'s, which is almost everything. SmallPtrSet has two modes, one
26 /// for small and one for large sets.
28 /// Small sets use an array of pointers allocated in the SmallPtrSet object,
29 /// which is treated as a simple array of pointers. When a pointer is added to
30 /// the set, the array is scanned to see if the element already exists, if not
31 /// the element is 'pushed back' onto the array. If we run out of space in the
32 /// array, we grow into the 'large set' case. SmallSet should be used when the
33 /// sets are often small. In this case, no memory allocation is used, and only
34 /// light-weight and cache-efficient scanning is used.
36 /// Large sets use a classic exponentially-probed hash table. Empty buckets are
37 /// represented with an illegal pointer value (-1) to allow null pointers to be
38 /// inserted. Tombstones are represented with another illegal pointer value
39 /// (-2), to allow deletion. The hash table is resized when the table is 3/4 or
40 /// more. When this happens, the table is doubled in size.
42 class SmallPtrSetImpl {
44 /// CurArray - This is the current set of buckets. If it points to
45 /// SmallArray, then the set is in 'small mode'.
47 /// CurArraySize - The allocated size of CurArray, always a power of two.
48 /// Note that CurArray points to an array that has CurArraySize+1 elements in
49 /// it, so that the end iterator actually points to valid memory.
50 unsigned CurArraySize;
52 // If small, this is # elts allocated consequtively
54 unsigned NumTombstones;
55 void *SmallArray[1]; // Must be last ivar.
57 // Helper to copy construct a SmallPtrSet.
58 SmallPtrSetImpl(const SmallPtrSetImpl& that);
60 SmallPtrSetImpl(unsigned SmallSize) {
61 assert(SmallSize && (SmallSize & (SmallSize-1)) == 0 &&
62 "Initial size must be a power of two!");
63 CurArray = &SmallArray[0];
64 CurArraySize = SmallSize;
65 // The end pointer, always valid, is set to a valid element to help the
67 CurArray[SmallSize] = 0;
75 bool empty() const { return size() == 0; }
76 unsigned size() const { return NumElements; }
78 static void *getTombstoneMarker() { return reinterpret_cast<void*>(-2); }
79 static void *getEmptyMarker() {
80 // Note that -1 is chosen to make clear() efficiently implementable with
81 // memset and because it's not a valid pointer value.
82 return reinterpret_cast<void*>(-1);
86 // Fill the array with empty markers.
87 memset(CurArray, -1, CurArraySize*sizeof(void*));
92 /// insert - This returns true if the pointer was new to the set, false if it
93 /// was already in the set.
94 bool insert(void *Ptr);
96 template <typename IterT>
97 void insert(IterT I, IterT E) {
102 /// erase - If the set contains the specified pointer, remove it and return
103 /// true, otherwise return false.
104 bool erase(void *Ptr);
106 bool count(void *Ptr) const {
108 // Linear search for the item.
109 for (void *const *APtr = SmallArray, *const *E = SmallArray+NumElements;
117 return *FindBucketFor(Ptr) == Ptr;
121 bool isSmall() const { return CurArray == &SmallArray[0]; }
123 unsigned Hash(void *Ptr) const {
124 return ((uintptr_t)Ptr >> 4) & (CurArraySize-1);
126 void * const *FindBucketFor(void *Ptr) const;
128 /// Grow - Allocate a larger backing store for the buckets and move it over.
132 /// SmallPtrSetIteratorImpl - This is the common base class shared between all
133 /// instances of SmallPtrSetIterator.
134 class SmallPtrSetIteratorImpl {
138 SmallPtrSetIteratorImpl(void *const *BP) : Bucket(BP) {
142 bool operator==(const SmallPtrSetIteratorImpl &RHS) const {
143 return Bucket == RHS.Bucket;
145 bool operator!=(const SmallPtrSetIteratorImpl &RHS) const {
146 return Bucket != RHS.Bucket;
150 /// AdvanceIfNotValid - If the current bucket isn't valid, advance to a bucket
151 /// that is. This is guaranteed to stop because the end() bucket is marked
153 void AdvanceIfNotValid() {
154 while (*Bucket == SmallPtrSetImpl::getEmptyMarker() ||
155 *Bucket == SmallPtrSetImpl::getTombstoneMarker())
160 /// SmallPtrSetIterator - This implements a const_iterator for SmallPtrSet.
161 template<typename PtrTy>
162 class SmallPtrSetIterator : public SmallPtrSetIteratorImpl {
164 SmallPtrSetIterator(void *const *BP) : SmallPtrSetIteratorImpl(BP) {}
166 // Most methods provided by baseclass.
168 PtrTy operator*() const {
169 return static_cast<PtrTy>(*Bucket);
172 inline SmallPtrSetIterator& operator++() { // Preincrement
178 SmallPtrSetIterator operator++(int) { // Postincrement
179 SmallPtrSetIterator tmp = *this; ++*this; return tmp;
183 /// NextPowerOfTwo - This is a helper template that rounds N up to the next
186 struct NextPowerOfTwo;
188 /// NextPowerOfTwoH - If N is not a power of two, increase it. This is a helper
189 /// template used to implement NextPowerOfTwo.
190 template<unsigned N, bool isPowerTwo>
191 struct NextPowerOfTwoH {
195 struct NextPowerOfTwoH<N, false> {
197 // We could just use NextVal = N+1, but this converges faster. N|(N-1) sets
198 // the right-most zero bits to one all at once, e.g. 0b0011000 -> 0b0011111.
199 Val = NextPowerOfTwo<(N|(N-1)) + 1>::Val
204 struct NextPowerOfTwo {
205 enum { Val = NextPowerOfTwoH<N, (N&(N-1)) == 0>::Val };
209 /// SmallPtrSet - This class implements a set which is optimizer for holding
210 /// SmallSize or less elements. This internally rounds up SmallSize to the next
211 /// power of two if it is not already a power of two. See the comments above
212 /// SmallPtrSetImpl for details of the algorithm.
213 template<class PtrType, unsigned SmallSize>
214 class SmallPtrSet : public SmallPtrSetImpl {
215 // Make sure that SmallSize is a power of two, round up if not.
216 enum { SmallSizePowTwo = NextPowerOfTwo<SmallSize>::Val };
217 void *SmallArray[SmallSizePowTwo];
219 SmallPtrSet() : SmallPtrSetImpl(NextPowerOfTwo<SmallSizePowTwo>::Val) {}
220 SmallPtrSet(const SmallPtrSet &that) : SmallPtrSetImpl(that) {}
222 template<typename It>
223 SmallPtrSet(It I, It E)
224 : SmallPtrSetImpl(NextPowerOfTwo<SmallSizePowTwo>::Val) {
228 typedef SmallPtrSetIterator<PtrType> iterator;
229 typedef SmallPtrSetIterator<PtrType> const_iterator;
230 inline iterator begin() const {
231 return iterator(CurArray);
233 inline iterator end() const {
234 return iterator(CurArray+CurArraySize);