include/llvm/ADT/SmallPtrSet.h

   1 //===- llvm/ADT/SmallPtrSet.h - 'Normally small' pointer set ----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the SmallPtrSet class.  See the doxygen comment for
  11 // SmallPtrSetImplBase for more details on the algorithm used.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_ADT_SMALLPTRSET_H
  16 #define LLVM_ADT_SMALLPTRSET_H
  17
  18 #include "llvm/Support/Compiler.h"
  19 #include "llvm/Support/DataTypes.h"
  20 #include "llvm/Support/PointerLikeTypeTraits.h"
  21 #include <cassert>
  22 #include <cstddef>
  23 #include <cstring>
  24 #include <iterator>
  25
  26 namespace llvm {
  27
  28 class SmallPtrSetIteratorImpl;
  29
  30 /// SmallPtrSetImplBase - This is the common code shared among all the
  31 /// SmallPtrSet<>'s, which is almost everything.  SmallPtrSet has two modes, one
  32 /// for small and one for large sets.
  33 ///
  34 /// Small sets use an array of pointers allocated in the SmallPtrSet object,
  35 /// which is treated as a simple array of pointers.  When a pointer is added to
  36 /// the set, the array is scanned to see if the element already exists, if not
  37 /// the element is 'pushed back' onto the array.  If we run out of space in the
  38 /// array, we grow into the 'large set' case.  SmallSet should be used when the
  39 /// sets are often small.  In this case, no memory allocation is used, and only
  40 /// light-weight and cache-efficient scanning is used.
  41 ///
  42 /// Large sets use a classic exponentially-probed hash table.  Empty buckets are
  43 /// represented with an illegal pointer value (-1) to allow null pointers to be
  44 /// inserted.  Tombstones are represented with another illegal pointer value
  45 /// (-2), to allow deletion.  The hash table is resized when the table is 3/4 or
  46 /// more.  When this happens, the table is doubled in size.
  47 ///
  48 class SmallPtrSetImplBase {
  49   friend class SmallPtrSetIteratorImpl;
  50 protected:
  51   /// SmallArray - Points to a fixed size set of buckets, used in 'small mode'.
  52   const void **SmallArray;
  53   /// CurArray - This is the current set of buckets.  If equal to SmallArray,
  54   /// then the set is in 'small mode'.
  55   const void **CurArray;
  56   /// CurArraySize - The allocated size of CurArray, always a power of two.
  57   unsigned CurArraySize;
  58
  59   // If small, this is # elts allocated consecutively
  60   unsigned NumElements;
  61   unsigned NumTombstones;
  62
  63   // Helpers to copy and move construct a SmallPtrSet.
  64   SmallPtrSetImplBase(const void **SmallStorage, const SmallPtrSetImplBase &that);
  65 #if LLVM_HAS_RVALUE_REFERENCES
  66   SmallPtrSetImplBase(const void **SmallStorage, unsigned SmallSize,
  67                   SmallPtrSetImplBase &&that);
  68 #endif
  69   explicit SmallPtrSetImplBase(const void **SmallStorage, unsigned SmallSize) :
  70     SmallArray(SmallStorage), CurArray(SmallStorage), CurArraySize(SmallSize) {
  71     assert(SmallSize && (SmallSize & (SmallSize-1)) == 0 &&
  72            "Initial size must be a power of two!");
  73     clear();
  74   }
  75   ~SmallPtrSetImplBase();
  76
  77 public:
  78   bool LLVM_ATTRIBUTE_UNUSED_RESULT empty() const { return size() == 0; }
  79   unsigned size() const { return NumElements; }
  80
  81   void clear() {
  82     // If the capacity of the array is huge, and the # elements used is small,
  83     // shrink the array.
  84     if (!isSmall() && NumElements*4 < CurArraySize && CurArraySize > 32)
  85       return shrink_and_clear();
  86
  87     // Fill the array with empty markers.
  88     memset(CurArray, -1, CurArraySize*sizeof(void*));
  89     NumElements = 0;
  90     NumTombstones = 0;
  91   }
  92
  93 protected:
  94   static void *getTombstoneMarker() { return reinterpret_cast<void*>(-2); }
  95   static void *getEmptyMarker() {
  96     // Note that -1 is chosen to make clear() efficiently implementable with
  97     // memset and because it's not a valid pointer value.
  98     return reinterpret_cast<void*>(-1);
  99   }
 100
 101   /// insert_imp - This returns true if the pointer was new to the set, false if
 102   /// it was already in the set.  This is hidden from the client so that the
 103   /// derived class can check that the right type of pointer is passed in.
 104   bool insert_imp(const void * Ptr);
 105
 106   /// erase_imp - If the set contains the specified pointer, remove it and
 107   /// return true, otherwise return false.  This is hidden from the client so
 108   /// that the derived class can check that the right type of pointer is passed
 109   /// in.
 110   bool erase_imp(const void * Ptr);
 111
 112   bool count_imp(const void * Ptr) const {
 113     if (isSmall()) {
 114       // Linear search for the item.
 115       for (const void *const *APtr = SmallArray,
 116                       *const *E = SmallArray+NumElements; APtr != E; ++APtr)
 117         if (*APtr == Ptr)
 118           return true;
 119       return false;
 120     }
 121
 122     // Big set case.
 123     return *FindBucketFor(Ptr) == Ptr;
 124   }
 125
 126 private:
 127   bool isSmall() const { return CurArray == SmallArray; }
 128
 129   const void * const *FindBucketFor(const void *Ptr) const;
 130   void shrink_and_clear();
 131
 132   /// Grow - Allocate a larger backing store for the buckets and move it over.
 133   void Grow(unsigned NewSize);
 134
 135   void operator=(const SmallPtrSetImplBase &RHS) LLVM_DELETED_FUNCTION;
 136 protected:
 137   /// swap - Swaps the elements of two sets.
 138   /// Note: This method assumes that both sets have the same small size.
 139   void swap(SmallPtrSetImplBase &RHS);
 140
 141   void CopyFrom(const SmallPtrSetImplBase &RHS);
 142 #if LLVM_HAS_RVALUE_REFERENCES
 143   void MoveFrom(unsigned SmallSize, SmallPtrSetImplBase &&RHS);
 144 #endif
 145 };
 146
 147 /// SmallPtrSetIteratorImpl - This is the common base class shared between all
 148 /// instances of SmallPtrSetIterator.
 149 class SmallPtrSetIteratorImpl {
 150 protected:
 151   const void *const *Bucket;
 152   const void *const *End;
 153 public:
 154   explicit SmallPtrSetIteratorImpl(const void *const *BP, const void*const *E)
 155     : Bucket(BP), End(E) {
 156       AdvanceIfNotValid();
 157   }
 158
 159   bool operator==(const SmallPtrSetIteratorImpl &RHS) const {
 160     return Bucket == RHS.Bucket;
 161   }
 162   bool operator!=(const SmallPtrSetIteratorImpl &RHS) const {
 163     return Bucket != RHS.Bucket;
 164   }
 165
 166 protected:
 167   /// AdvanceIfNotValid - If the current bucket isn't valid, advance to a bucket
 168   /// that is.   This is guaranteed to stop because the end() bucket is marked
 169   /// valid.
 170   void AdvanceIfNotValid() {
 171     assert(Bucket <= End);
 172     while (Bucket != End &&
 173            (*Bucket == SmallPtrSetImplBase::getEmptyMarker() ||
 174             *Bucket == SmallPtrSetImplBase::getTombstoneMarker()))
 175       ++Bucket;
 176   }
 177 };
 178
 179 /// SmallPtrSetIterator - This implements a const_iterator for SmallPtrSet.
 180 template<typename PtrTy>
 181 class SmallPtrSetIterator : public SmallPtrSetIteratorImpl {
 182   typedef PointerLikeTypeTraits<PtrTy> PtrTraits;
 183
 184 public:
 185   typedef PtrTy                     value_type;
 186   typedef PtrTy                     reference;
 187   typedef PtrTy                     pointer;
 188   typedef std::ptrdiff_t            difference_type;
 189   typedef std::forward_iterator_tag iterator_category;
 190
 191   explicit SmallPtrSetIterator(const void *const *BP, const void *const *E)
 192     : SmallPtrSetIteratorImpl(BP, E) {}
 193
 194   // Most methods provided by baseclass.
 195
 196   const PtrTy operator*() const {
 197     assert(Bucket < End);
 198     return PtrTraits::getFromVoidPointer(const_cast<void*>(*Bucket));
 199   }
 200
 201   inline SmallPtrSetIterator& operator++() {          // Preincrement
 202     ++Bucket;
 203     AdvanceIfNotValid();
 204     return *this;
 205   }
 206
 207   SmallPtrSetIterator operator++(int) {        // Postincrement
 208     SmallPtrSetIterator tmp = *this; ++*this; return tmp;
 209   }
 210 };
 211
 212 /// RoundUpToPowerOfTwo - This is a helper template that rounds N up to the next
 213 /// power of two (which means N itself if N is already a power of two).
 214 template<unsigned N>
 215 struct RoundUpToPowerOfTwo;
 216
 217 /// RoundUpToPowerOfTwoH - If N is not a power of two, increase it.  This is a
 218 /// helper template used to implement RoundUpToPowerOfTwo.
 219 template<unsigned N, bool isPowerTwo>
 220 struct RoundUpToPowerOfTwoH {
 221   enum { Val = N };
 222 };
 223 template<unsigned N>
 224 struct RoundUpToPowerOfTwoH<N, false> {
 225   enum {
 226     // We could just use NextVal = N+1, but this converges faster.  N|(N-1) sets
 227     // the right-most zero bits to one all at once, e.g. 0b0011000 -> 0b0011111.
 228     Val = RoundUpToPowerOfTwo<(N|(N-1)) + 1>::Val
 229   };
 230 };
 231
 232 template<unsigned N>
 233 struct RoundUpToPowerOfTwo {
 234   enum { Val = RoundUpToPowerOfTwoH<N, (N&(N-1)) == 0>::Val };
 235 };
 236
 237
 238 /// \brief A templated base class for \c SmallPtrSet which provides the
 239 /// typesafe interface that is common across all small sizes.
 240 ///
 241 /// This is particularly useful for passing around between interface boundaries
 242 /// to avoid encoding a particular small size in the interface boundary.
 243 template <typename PtrType>
 244 class SmallPtrSetImpl : public SmallPtrSetImplBase {
 245   typedef PointerLikeTypeTraits<PtrType> PtrTraits;
 246 protected:
 247   // Constructors that forward to the base.
 248   SmallPtrSetImpl(const void **SmallStorage, const SmallPtrSetImpl &that)
 249       : SmallPtrSetImplBase(SmallStorage, that) {}
 250 #if LLVM_HAS_RVALUE_REFERENCES
 251   SmallPtrSetImpl(const void **SmallStorage, unsigned SmallSize,
 252                   SmallPtrSetImpl &&that)
 253       : SmallPtrSetImplBase(SmallStorage, SmallSize, std::move(that)) {}
 254 #endif
 255   explicit SmallPtrSetImpl(const void **SmallStorage, unsigned SmallSize)
 256       : SmallPtrSetImplBase(SmallStorage, SmallSize) {}
 257
 258 public:
 259   /// insert - This returns true if the pointer was new to the set, false if it
 260   /// was already in the set.
 261   bool insert(PtrType Ptr) {
 262     return insert_imp(PtrTraits::getAsVoidPointer(Ptr));
 263   }
 264
 265   /// erase - If the set contains the specified pointer, remove it and return
 266   /// true, otherwise return false.
 267   bool erase(PtrType Ptr) {
 268     return erase_imp(PtrTraits::getAsVoidPointer(Ptr));
 269   }
 270
 271   /// count - Return 1 if the specified pointer is in the set, 0 otherwise.
 272   unsigned count(PtrType Ptr) const {
 273     return count_imp(PtrTraits::getAsVoidPointer(Ptr)) ? 1 : 0;
 274   }
 275
 276   template <typename IterT>
 277   void insert(IterT I, IterT E) {
 278     for (; I != E; ++I)
 279       insert(*I);
 280   }
 281
 282   typedef SmallPtrSetIterator<PtrType> iterator;
 283   typedef SmallPtrSetIterator<PtrType> const_iterator;
 284   inline iterator begin() const {
 285     return iterator(CurArray, CurArray+CurArraySize);
 286   }
 287   inline iterator end() const {
 288     return iterator(CurArray+CurArraySize, CurArray+CurArraySize);
 289   }
 290 };
 291
 292 /// SmallPtrSet - This class implements a set which is optimized for holding
 293 /// SmallSize or less elements.  This internally rounds up SmallSize to the next
 294 /// power of two if it is not already a power of two.  See the comments above
 295 /// SmallPtrSetImplBase for details of the algorithm.
 296 template<class PtrType, unsigned SmallSize>
 297 class SmallPtrSet : public SmallPtrSetImpl<PtrType> {
 298   typedef SmallPtrSetImpl<PtrType> BaseT;
 299
 300   // Make sure that SmallSize is a power of two, round up if not.
 301   enum { SmallSizePowTwo = RoundUpToPowerOfTwo<SmallSize>::Val };
 302   /// SmallStorage - Fixed size storage used in 'small mode'.
 303   const void *SmallStorage[SmallSizePowTwo];
 304 public:
 305   SmallPtrSet() : BaseT(SmallStorage, SmallSizePowTwo) {}
 306   SmallPtrSet(const SmallPtrSet &that) : BaseT(SmallStorage, that) {}
 307 #if LLVM_HAS_RVALUE_REFERENCES
 308   SmallPtrSet(SmallPtrSet &&that)
 309       : BaseT(SmallStorage, SmallSizePowTwo, std::move(that)) {}
 310 #endif
 311
 312   template<typename It>
 313   SmallPtrSet(It I, It E) : BaseT(SmallStorage, SmallSizePowTwo) {
 314     this->insert(I, E);
 315   }
 316
 317   SmallPtrSet<PtrType, SmallSize> &
 318   operator=(const SmallPtrSet<PtrType, SmallSize> &RHS) {
 319     if (&RHS != this)
 320       this->CopyFrom(RHS);
 321     return *this;
 322   }
 323
 324 #if LLVM_HAS_RVALUE_REFERENCES
 325   SmallPtrSet<PtrType, SmallSize>&
 326   operator=(SmallPtrSet<PtrType, SmallSize> &&RHS) {
 327     if (&RHS != this)
 328       this->MoveFrom(SmallSizePowTwo, std::move(RHS));
 329     return *this;
 330   }
 331 #endif
 332
 333   /// swap - Swaps the elements of two sets.
 334   void swap(SmallPtrSet<PtrType, SmallSize> &RHS) {
 335     SmallPtrSetImplBase::swap(RHS);
 336   }
 337 };
 338
 339 }
 340
 341 namespace std {
 342   /// Implement std::swap in terms of SmallPtrSet swap.
 343   template<class T, unsigned N>
 344   inline void swap(llvm::SmallPtrSet<T, N> &LHS, llvm::SmallPtrSet<T, N> &RHS) {
 345     LHS.swap(RHS);
 346   }
 347 }
 348
 349 #endif