1c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner//===- llvm/ADT/SmallPtrSet.h - 'Normally small' pointer set ----*- C++ -*-===// 2c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner// 3c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner// The LLVM Compiler Infrastructure 4c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner// 57ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// This file is distributed under the University of Illinois Open Source 67ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// License. See LICENSE.TXT for details. 7c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner// 8c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner//===----------------------------------------------------------------------===// 9c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner// 1018b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner// This file defines the SmallPtrSet class. See the doxygen comment for 1136b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines// SmallPtrSetImplBase for more details on the algorithm used. 12c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner// 13c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner//===----------------------------------------------------------------------===// 14c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner 15c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner#ifndef LLVM_ADT_SMALLPTRSET_H 16c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner#define LLVM_ADT_SMALLPTRSET_H 17c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner 18f630e49efc7bf3f1716b6daab3c2cc11a908754aCraig Topper#include "llvm/Support/Compiler.h" 19f630e49efc7bf3f1716b6daab3c2cc11a908754aCraig Topper#include "llvm/Support/DataTypes.h" 20f630e49efc7bf3f1716b6daab3c2cc11a908754aCraig Topper#include "llvm/Support/PointerLikeTypeTraits.h" 21c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner#include <cassert> 22476b242fe7a61e5f9ac6214b0bc5c680d24f152eNick Lewycky#include <cstddef> 23c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner#include <cstring> 247c718222cdb624f4c420b3d7b6eeb12fffc05603Douglas Gregor#include <iterator> 25c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner 26c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattnernamespace llvm { 27c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner 285471a00977ab8ce3c88414dfbad99c0296d58508Dan Gohmanclass SmallPtrSetIteratorImpl; 295471a00977ab8ce3c88414dfbad99c0296d58508Dan Gohman 3036b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines/// SmallPtrSetImplBase - This is the common code shared among all the 3118b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// SmallPtrSet<>'s, which is almost everything. SmallPtrSet has two modes, one 3218b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// for small and one for large sets. 3318b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// 3418b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// Small sets use an array of pointers allocated in the SmallPtrSet object, 3518b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// which is treated as a simple array of pointers. When a pointer is added to 3618b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// the set, the array is scanned to see if the element already exists, if not 3718b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// the element is 'pushed back' onto the array. If we run out of space in the 3818b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// array, we grow into the 'large set' case. SmallSet should be used when the 3918b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// sets are often small. In this case, no memory allocation is used, and only 4018b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// light-weight and cache-efficient scanning is used. 4118b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// 4218b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// Large sets use a classic exponentially-probed hash table. Empty buckets are 4318b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// represented with an illegal pointer value (-1) to allow null pointers to be 4418b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// inserted. Tombstones are represented with another illegal pointer value 4518b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// (-2), to allow deletion. The hash table is resized when the table is 3/4 or 4618b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// more. When this happens, the table is doubled in size. 4718b69106b7a66ac6abde37d1be6d0d952796ed04Chris Lattner/// 4836b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hinesclass SmallPtrSetImplBase { 495471a00977ab8ce3c88414dfbad99c0296d58508Dan Gohman friend class SmallPtrSetIteratorImpl; 50c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattnerprotected: 512a8bf425bd0aff1a6406805c095d99089a1dfaaeDuncan Sands /// SmallArray - Points to a fixed size set of buckets, used in 'small mode'. 522a8bf425bd0aff1a6406805c095d99089a1dfaaeDuncan Sands const void **SmallArray; 532a8bf425bd0aff1a6406805c095d99089a1dfaaeDuncan Sands /// CurArray - This is the current set of buckets. If equal to SmallArray, 542a8bf425bd0aff1a6406805c095d99089a1dfaaeDuncan Sands /// then the set is in 'small mode'. 55e992a56ae93140171f5044079e8d317f784c8cc1Owen Anderson const void **CurArray; 56c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner /// CurArraySize - The allocated size of CurArray, always a power of two. 57c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner unsigned CurArraySize; 583a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 59ab4c366274a582dd8146b2820c6b999cad5fce36Duncan Sands // If small, this is # elts allocated consecutively 60c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner unsigned NumElements; 61e237cf934fcb8a25746e068f543fbd6db44eaa70Chris Lattner unsigned NumTombstones; 62ac58a16f8584f38198cc7800bd37a896125268b7Jeff Cohen 6336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines // Helpers to copy and move construct a SmallPtrSet. 6436b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSetImplBase(const void **SmallStorage, const SmallPtrSetImplBase &that); 6536b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSetImplBase(const void **SmallStorage, unsigned SmallSize, 6636b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSetImplBase &&that); 6736b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines explicit SmallPtrSetImplBase(const void **SmallStorage, unsigned SmallSize) : 682a8bf425bd0aff1a6406805c095d99089a1dfaaeDuncan Sands SmallArray(SmallStorage), CurArray(SmallStorage), CurArraySize(SmallSize) { 69c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner assert(SmallSize && (SmallSize & (SmallSize-1)) == 0 && 70c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner "Initial size must be a power of two!"); 71c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner clear(); 72c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 7336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines ~SmallPtrSetImplBase(); 743a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 755471a00977ab8ce3c88414dfbad99c0296d58508Dan Gohmanpublic: 76cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines typedef unsigned size_type; 77cbe40cfe96a6bb3f2da56445269c2c71e55e0e56Benjamin Kramer bool LLVM_ATTRIBUTE_UNUSED_RESULT empty() const { return size() == 0; } 78cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines size_type size() const { return NumElements; } 793a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 80c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner void clear() { 8142e4bdf2577946380ce1529d5716e48b33d4186dChris Lattner // If the capacity of the array is huge, and the # elements used is small, 8242e4bdf2577946380ce1529d5716e48b33d4186dChris Lattner // shrink the array. 8342e4bdf2577946380ce1529d5716e48b33d4186dChris Lattner if (!isSmall() && NumElements*4 < CurArraySize && CurArraySize > 32) 8442e4bdf2577946380ce1529d5716e48b33d4186dChris Lattner return shrink_and_clear(); 853a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 86c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner // Fill the array with empty markers. 87c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner memset(CurArray, -1, CurArraySize*sizeof(void*)); 88c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner NumElements = 0; 89e237cf934fcb8a25746e068f543fbd6db44eaa70Chris Lattner NumTombstones = 0; 90c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 913a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 92373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattnerprotected: 935471a00977ab8ce3c88414dfbad99c0296d58508Dan Gohman static void *getTombstoneMarker() { return reinterpret_cast<void*>(-2); } 945471a00977ab8ce3c88414dfbad99c0296d58508Dan Gohman static void *getEmptyMarker() { 955471a00977ab8ce3c88414dfbad99c0296d58508Dan Gohman // Note that -1 is chosen to make clear() efficiently implementable with 965471a00977ab8ce3c88414dfbad99c0296d58508Dan Gohman // memset and because it's not a valid pointer value. 975471a00977ab8ce3c88414dfbad99c0296d58508Dan Gohman return reinterpret_cast<void*>(-1); 985471a00977ab8ce3c88414dfbad99c0296d58508Dan Gohman } 995471a00977ab8ce3c88414dfbad99c0296d58508Dan Gohman 100373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner /// insert_imp - This returns true if the pointer was new to the set, false if 101373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner /// it was already in the set. This is hidden from the client so that the 102373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner /// derived class can check that the right type of pointer is passed in. 103373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner bool insert_imp(const void * Ptr); 1043a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 105373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner /// erase_imp - If the set contains the specified pointer, remove it and 106373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner /// return true, otherwise return false. This is hidden from the client so 107373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner /// that the derived class can check that the right type of pointer is passed 108373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner /// in. 109373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner bool erase_imp(const void * Ptr); 1103a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 111373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner bool count_imp(const void * Ptr) const { 112c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner if (isSmall()) { 113c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner // Linear search for the item. 11442e4bdf2577946380ce1529d5716e48b33d4186dChris Lattner for (const void *const *APtr = SmallArray, 11542e4bdf2577946380ce1529d5716e48b33d4186dChris Lattner *const *E = SmallArray+NumElements; APtr != E; ++APtr) 116c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner if (*APtr == Ptr) 117c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner return true; 118c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner return false; 119c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 1203a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 121c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner // Big set case. 122c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner return *FindBucketFor(Ptr) == Ptr; 123c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 1243a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 125c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattnerprivate: 1262a8bf425bd0aff1a6406805c095d99089a1dfaaeDuncan Sands bool isSmall() const { return CurArray == SmallArray; } 1270b930852cf1a9899ae82dd6c31b43e754a77dcb0Chris Lattner 128e992a56ae93140171f5044079e8d317f784c8cc1Owen Anderson const void * const *FindBucketFor(const void *Ptr) const; 12942e4bdf2577946380ce1529d5716e48b33d4186dChris Lattner void shrink_and_clear(); 1303a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 131c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner /// Grow - Allocate a larger backing store for the buckets and move it over. 132e10fff6f8802d6ab4045d9d0bb22e6f37e6d3d0bJakob Stoklund Olesen void Grow(unsigned NewSize); 1333a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 13436b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines void operator=(const SmallPtrSetImplBase &RHS) LLVM_DELETED_FUNCTION; 13591f0158d4d1b16b8615126b05582d421cfb14089Chris Lattnerprotected: 1362945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer /// swap - Swaps the elements of two sets. 1372945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer /// Note: This method assumes that both sets have the same small size. 13836b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines void swap(SmallPtrSetImplBase &RHS); 1392945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer 14036b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines void CopyFrom(const SmallPtrSetImplBase &RHS); 14136b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines void MoveFrom(unsigned SmallSize, SmallPtrSetImplBase &&RHS); 142c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner}; 143c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner 144c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner/// SmallPtrSetIteratorImpl - This is the common base class shared between all 145c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner/// instances of SmallPtrSetIterator. 146c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattnerclass SmallPtrSetIteratorImpl { 147c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattnerprotected: 148e992a56ae93140171f5044079e8d317f784c8cc1Owen Anderson const void *const *Bucket; 149e1e9366281a98cd06b61d5d7e136ce2b1a433ba6Jean-Luc Duprat const void *const *End; 150c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattnerpublic: 151e1e9366281a98cd06b61d5d7e136ce2b1a433ba6Jean-Luc Duprat explicit SmallPtrSetIteratorImpl(const void *const *BP, const void*const *E) 152e1e9366281a98cd06b61d5d7e136ce2b1a433ba6Jean-Luc Duprat : Bucket(BP), End(E) { 153e1e9366281a98cd06b61d5d7e136ce2b1a433ba6Jean-Luc Duprat AdvanceIfNotValid(); 154c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 1553a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 156c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner bool operator==(const SmallPtrSetIteratorImpl &RHS) const { 157c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner return Bucket == RHS.Bucket; 158c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 159c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner bool operator!=(const SmallPtrSetIteratorImpl &RHS) const { 160c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner return Bucket != RHS.Bucket; 161c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 1623a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 163c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattnerprotected: 164c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner /// AdvanceIfNotValid - If the current bucket isn't valid, advance to a bucket 165c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner /// that is. This is guaranteed to stop because the end() bucket is marked 166c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner /// valid. 167c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner void AdvanceIfNotValid() { 168e1e9366281a98cd06b61d5d7e136ce2b1a433ba6Jean-Luc Duprat assert(Bucket <= End); 169e1e9366281a98cd06b61d5d7e136ce2b1a433ba6Jean-Luc Duprat while (Bucket != End && 17036b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines (*Bucket == SmallPtrSetImplBase::getEmptyMarker() || 17136b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines *Bucket == SmallPtrSetImplBase::getTombstoneMarker())) 172c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner ++Bucket; 173c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 174c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner}; 175c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner 176c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner/// SmallPtrSetIterator - This implements a const_iterator for SmallPtrSet. 177c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattnertemplate<typename PtrTy> 178c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattnerclass SmallPtrSetIterator : public SmallPtrSetIteratorImpl { 1798ee1b5e916249d1a64ad8cf99b08a0e160f9d052Chris Lattner typedef PointerLikeTypeTraits<PtrTy> PtrTraits; 1807c718222cdb624f4c420b3d7b6eeb12fffc05603Douglas Gregor 181c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattnerpublic: 1827c718222cdb624f4c420b3d7b6eeb12fffc05603Douglas Gregor typedef PtrTy value_type; 1837c718222cdb624f4c420b3d7b6eeb12fffc05603Douglas Gregor typedef PtrTy reference; 1847c718222cdb624f4c420b3d7b6eeb12fffc05603Douglas Gregor typedef PtrTy pointer; 1857c718222cdb624f4c420b3d7b6eeb12fffc05603Douglas Gregor typedef std::ptrdiff_t difference_type; 1867c718222cdb624f4c420b3d7b6eeb12fffc05603Douglas Gregor typedef std::forward_iterator_tag iterator_category; 1877c718222cdb624f4c420b3d7b6eeb12fffc05603Douglas Gregor 188e1e9366281a98cd06b61d5d7e136ce2b1a433ba6Jean-Luc Duprat explicit SmallPtrSetIterator(const void *const *BP, const void *const *E) 189e1e9366281a98cd06b61d5d7e136ce2b1a433ba6Jean-Luc Duprat : SmallPtrSetIteratorImpl(BP, E) {} 190c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner 191c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner // Most methods provided by baseclass. 1923a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 193e992a56ae93140171f5044079e8d317f784c8cc1Owen Anderson const PtrTy operator*() const { 194e1e9366281a98cd06b61d5d7e136ce2b1a433ba6Jean-Luc Duprat assert(Bucket < End); 1956de603071879bdc5d7d663826354c24a9d176469Chris Lattner return PtrTraits::getFromVoidPointer(const_cast<void*>(*Bucket)); 196c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 1973a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 198c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner inline SmallPtrSetIterator& operator++() { // Preincrement 199c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner ++Bucket; 200c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner AdvanceIfNotValid(); 201c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner return *this; 202c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 2033a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 204c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner SmallPtrSetIterator operator++(int) { // Postincrement 205c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner SmallPtrSetIterator tmp = *this; ++*this; return tmp; 206c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 207c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner}; 208c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner 209a71f0e1f2a7d6d2f030f147d6d426e5bb3b56328Duncan Sands/// RoundUpToPowerOfTwo - This is a helper template that rounds N up to the next 2102e502577ab3645ab5c54434671d299e35c2245ccDuncan Sands/// power of two (which means N itself if N is already a power of two). 211af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattnertemplate<unsigned N> 212a71f0e1f2a7d6d2f030f147d6d426e5bb3b56328Duncan Sandsstruct RoundUpToPowerOfTwo; 213af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattner 214a71f0e1f2a7d6d2f030f147d6d426e5bb3b56328Duncan Sands/// RoundUpToPowerOfTwoH - If N is not a power of two, increase it. This is a 215a71f0e1f2a7d6d2f030f147d6d426e5bb3b56328Duncan Sands/// helper template used to implement RoundUpToPowerOfTwo. 216af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattnertemplate<unsigned N, bool isPowerTwo> 217a71f0e1f2a7d6d2f030f147d6d426e5bb3b56328Duncan Sandsstruct RoundUpToPowerOfTwoH { 218af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattner enum { Val = N }; 219af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattner}; 220af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattnertemplate<unsigned N> 221a71f0e1f2a7d6d2f030f147d6d426e5bb3b56328Duncan Sandsstruct RoundUpToPowerOfTwoH<N, false> { 222af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattner enum { 223af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattner // We could just use NextVal = N+1, but this converges faster. N|(N-1) sets 224af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattner // the right-most zero bits to one all at once, e.g. 0b0011000 -> 0b0011111. 225a71f0e1f2a7d6d2f030f147d6d426e5bb3b56328Duncan Sands Val = RoundUpToPowerOfTwo<(N|(N-1)) + 1>::Val 226af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattner }; 227af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattner}; 228af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattner 229af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattnertemplate<unsigned N> 230a71f0e1f2a7d6d2f030f147d6d426e5bb3b56328Duncan Sandsstruct RoundUpToPowerOfTwo { 231a71f0e1f2a7d6d2f030f147d6d426e5bb3b56328Duncan Sands enum { Val = RoundUpToPowerOfTwoH<N, (N&(N-1)) == 0>::Val }; 232af3056c97e56106af7c3b9a5c856d1dc1d21e358Chris Lattner}; 2336de603071879bdc5d7d663826354c24a9d176469Chris Lattner 234c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner 23536b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines/// \brief A templated base class for \c SmallPtrSet which provides the 23636b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines/// typesafe interface that is common across all small sizes. 23736b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines/// 23836b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines/// This is particularly useful for passing around between interface boundaries 23936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines/// to avoid encoding a particular small size in the interface boundary. 24036b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hinestemplate <typename PtrType> 24136b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hinesclass SmallPtrSetImpl : public SmallPtrSetImplBase { 2428ee1b5e916249d1a64ad8cf99b08a0e160f9d052Chris Lattner typedef PointerLikeTypeTraits<PtrType> PtrTraits; 24336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hinesprotected: 24436b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines // Constructors that forward to the base. 24536b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSetImpl(const void **SmallStorage, const SmallPtrSetImpl &that) 24636b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines : SmallPtrSetImplBase(SmallStorage, that) {} 24736b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSetImpl(const void **SmallStorage, unsigned SmallSize, 24836b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSetImpl &&that) 24936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines : SmallPtrSetImplBase(SmallStorage, SmallSize, std::move(that)) {} 25036b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines explicit SmallPtrSetImpl(const void **SmallStorage, unsigned SmallSize) 25136b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines : SmallPtrSetImplBase(SmallStorage, SmallSize) {} 2523a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 25336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hinespublic: 254373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner /// insert - This returns true if the pointer was new to the set, false if it 255373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner /// was already in the set. 2566de603071879bdc5d7d663826354c24a9d176469Chris Lattner bool insert(PtrType Ptr) { 2576de603071879bdc5d7d663826354c24a9d176469Chris Lattner return insert_imp(PtrTraits::getAsVoidPointer(Ptr)); 2586de603071879bdc5d7d663826354c24a9d176469Chris Lattner } 2593a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 260373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner /// erase - If the set contains the specified pointer, remove it and return 261373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner /// true, otherwise return false. 2626de603071879bdc5d7d663826354c24a9d176469Chris Lattner bool erase(PtrType Ptr) { 2636de603071879bdc5d7d663826354c24a9d176469Chris Lattner return erase_imp(PtrTraits::getAsVoidPointer(Ptr)); 2646de603071879bdc5d7d663826354c24a9d176469Chris Lattner } 2653a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 26636b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines /// count - Return 1 if the specified pointer is in the set, 0 otherwise. 267cd81d94322a39503e4a3e87b6ee03d4fcb3465fbStephen Hines size_type count(PtrType Ptr) const { 26836b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines return count_imp(PtrTraits::getAsVoidPointer(Ptr)) ? 1 : 0; 2696de603071879bdc5d7d663826354c24a9d176469Chris Lattner } 2703a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 271373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner template <typename IterT> 272373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner void insert(IterT I, IterT E) { 273373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner for (; I != E; ++I) 274373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner insert(*I); 275373a733be031f52cebbbcdb15ab5997d9b5f9f17Chris Lattner } 2763a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 277c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner typedef SmallPtrSetIterator<PtrType> iterator; 278c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner typedef SmallPtrSetIterator<PtrType> const_iterator; 279c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner inline iterator begin() const { 280e1e9366281a98cd06b61d5d7e136ce2b1a433ba6Jean-Luc Duprat return iterator(CurArray, CurArray+CurArraySize); 281c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 282c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner inline iterator end() const { 283e1e9366281a98cd06b61d5d7e136ce2b1a433ba6Jean-Luc Duprat return iterator(CurArray+CurArraySize, CurArray+CurArraySize); 284c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner } 28536b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines}; 2863a54b3dc87a581c203b18050b4f787b4ca28a12cMisha Brukman 28736b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines/// SmallPtrSet - This class implements a set which is optimized for holding 28836b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines/// SmallSize or less elements. This internally rounds up SmallSize to the next 28936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines/// power of two if it is not already a power of two. See the comments above 29036b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines/// SmallPtrSetImplBase for details of the algorithm. 29136b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hinestemplate<class PtrType, unsigned SmallSize> 29236b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hinesclass SmallPtrSet : public SmallPtrSetImpl<PtrType> { 29336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines typedef SmallPtrSetImpl<PtrType> BaseT; 29436b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines 29536b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines // Make sure that SmallSize is a power of two, round up if not. 29636b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines enum { SmallSizePowTwo = RoundUpToPowerOfTwo<SmallSize>::Val }; 29736b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines /// SmallStorage - Fixed size storage used in 'small mode'. 29836b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines const void *SmallStorage[SmallSizePowTwo]; 29936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hinespublic: 30036b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSet() : BaseT(SmallStorage, SmallSizePowTwo) {} 30136b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSet(const SmallPtrSet &that) : BaseT(SmallStorage, that) {} 30236b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSet(SmallPtrSet &&that) 30336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines : BaseT(SmallStorage, SmallSizePowTwo, std::move(that)) {} 30436b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines 30536b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines template<typename It> 30636b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSet(It I, It E) : BaseT(SmallStorage, SmallSizePowTwo) { 30736b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines this->insert(I, E); 30836b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines } 30936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines 31036b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSet<PtrType, SmallSize> & 31195fd3189f84de5953c75d67403e7db9acdd5005dChris Lattner operator=(const SmallPtrSet<PtrType, SmallSize> &RHS) { 31236b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines if (&RHS != this) 31336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines this->CopyFrom(RHS); 31436b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines return *this; 31536b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines } 31636b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines 31736b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSet<PtrType, SmallSize>& 31836b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines operator=(SmallPtrSet<PtrType, SmallSize> &&RHS) { 31936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines if (&RHS != this) 32036b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines this->MoveFrom(SmallSizePowTwo, std::move(RHS)); 32191f0158d4d1b16b8615126b05582d421cfb14089Chris Lattner return *this; 32291f0158d4d1b16b8615126b05582d421cfb14089Chris Lattner } 32391f0158d4d1b16b8615126b05582d421cfb14089Chris Lattner 3242945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer /// swap - Swaps the elements of two sets. 3252945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer void swap(SmallPtrSet<PtrType, SmallSize> &RHS) { 32636b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines SmallPtrSetImplBase::swap(RHS); 3272945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer } 328c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner}; 329c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner 330c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner} 331c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner 3322945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramernamespace std { 3332945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer /// Implement std::swap in terms of SmallPtrSet swap. 3342945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer template<class T, unsigned N> 3352945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer inline void swap(llvm::SmallPtrSet<T, N> &LHS, llvm::SmallPtrSet<T, N> &RHS) { 3362945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer LHS.swap(RHS); 3372945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer } 3382945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer} 3392945a32ffd0bf079de1b23db12bc8a0de596a167Benjamin Kramer 340c95dc987e9e369c1c63819dbc4f76ab9b913772cChris Lattner#endif 341