LLVM 23.0.0git
llvm::SmallPtrSetImplBase Class Reference

SmallPtrSetImplBase - This is the common code shared among all the SmallPtrSet<>'s, which is almost everything. More...

#include "llvm/ADT/SmallPtrSet.h"

Inherits llvm::DebugEpochBase.

Inherited by llvm::SmallPtrSetImpl< MachineInstr * >, llvm::SmallPtrSetImpl< MachineBasicBlock * >, llvm::SmallPtrSetImpl< BasicBlock * >, llvm::SmallPtrSetImpl< const BasicBlockT * >, llvm::SmallPtrSetImpl< PointeeType * >, llvm::SmallPtrSetImpl< NodeRef >, llvm::SmallPtrSetImpl< const llvm::MDNode * >, llvm::SmallPtrSetImpl< llvm::Instruction * >, llvm::SmallPtrSetImpl< Value * >, llvm::SmallPtrSetImpl< llvm::DIScope * >, llvm::SmallPtrSetImpl< llvm::MachineBasicBlock * >, llvm::SmallPtrSetImpl< llvm::LiveRange * >, llvm::SmallPtrSetImpl< llvm::VPRecipeBase * >, llvm::SmallPtrSetImpl< const llvm::AllocaInst * >, llvm::SmallPtrSetImpl< const llvm::GlobalVariable * >, llvm::SmallPtrSetImpl< llvm::BasicBlock * >, llvm::SmallPtrSetImpl< const llvm::Value * >, llvm::SmallPtrSetImpl< const llvm::MachineBasicBlock * >, llvm::SmallPtrSetImpl< llvm::LazyCallGraph::SCC * >, llvm::SmallPtrSetImpl< llvm::Function * >, llvm::SmallPtrSetImpl< llvm::GlobalObject * >, llvm::SmallPtrSetImpl< llvm::Value * >, llvm::SmallPtrSetImpl< llvm::Use * >, llvm::SmallPtrSetImpl< const llvm::DISubprogram * >, llvm::SmallPtrSetImpl< llvm::GlobalVariable * >, llvm::SmallPtrSetImpl< llvm::Constant * >, llvm::SmallPtrSetImpl< llvm::GlobalValue * >, llvm::SmallPtrSetImpl< const llvm::DbgVariableRecord * >, llvm::SmallPtrSetImpl< llvm::MachineInstr * >, llvm::SmallPtrSetImpl< BasicBlockT * >, llvm::SmallPtrSetImpl< const BlockT * >, llvm::SmallPtrSetImpl< const InstructionT * >, llvm::SmallPtrSetImpl< const CycleT * >, llvm::SmallPtrSetImpl< const llvm::GlobalValue * >, llvm::SmallPtrSetImpl< NodeTy * >, llvm::SmallPtrSetImpl< const llvm::Function * >, llvm::SmallPtrSetImpl< llvm::InterleaveGroup< llvm::Instruction > * >, llvm::SmallPtrSetImpl< llvm::Module * >, llvm::SmallPtrSetImpl< const llvm::VNInfo * >, llvm::SmallPtrSetImpl< const llvm::Instruction * >, llvm::SmallPtrSetImpl< const llvm::MCSymbol * >, llvm::SmallPtrSetImpl< const llvm::LazyCallGraph::Node * >, llvm::SmallPtrSetImpl< llvm::MachineRegisterInfo::Delegate * >, llvm::SmallPtrSetImpl< const llvm::BasicBlock * >, llvm::SmallPtrSetImpl< void * >, llvm::SmallPtrSetImpl< llvm::AnalysisKey * >, llvm::SmallPtrSetImpl< llvm::Rematerializer::Listener * >, llvm::SmallPtrSetImpl< const llvm::SCEV * >, llvm::SmallPtrSetImpl< const llvm::Type * >, llvm::SmallPtrSetImpl< const llvm::PHINode * >, llvm::SmallPtrSetImpl< const llvm::SCEVAddRecExpr * >, llvm::SmallPtrSetImpl< llvm::Type * >, llvm::SmallPtrSetImpl< llvm::PHINode * >, llvm::SmallPtrSetImpl< llvm::cl::SubCommand * >, llvm::SmallPtrSetImpl< llvm::orc::JITDylib const * >, llvm::SmallPtrSetImpl< const TreeEntry * >, llvm::SmallPtrSetImpl< Instruction * >, llvm::SmallPtrSetImpl< const Value * >, and llvm::SmallPtrSetImpl< PtrType >.

Public Types

using size_type = unsigned

Public Member Functions

SmallPtrSetImplBaseoperator= (const SmallPtrSetImplBase &)=delete
bool empty () const
size_type size () const
size_type capacity () const
void clear ()
void reserve (size_type NewNumEntries)
Public Member Functions inherited from llvm::DebugEpochBase
void incrementEpoch ()

Protected Member Functions

LLVM_ABI SmallPtrSetImplBase (const void **SmallStorage, const SmallPtrSetImplBase &that)
LLVM_ABI SmallPtrSetImplBase (const void **SmallStorage, unsigned SmallSize, const void **RHSSmallStorage, SmallPtrSetImplBase &&that)
 SmallPtrSetImplBase (const void **SmallStorage, unsigned SmallSize)
 ~SmallPtrSetImplBase ()
const void ** EndPointer () const
iterator_range< const void ** > small_buckets ()
iterator_range< const void *const * > small_buckets () const
iterator_range< const void ** > buckets ()
iterator_range< const void *const * > buckets () const
std::pair< const void *const *, boolinsert_imp (const void *Ptr)
 insert_imp - This returns true if the pointer was new to the set, false if it was already in the set.
bool erase_imp (const void *Ptr)
 erase_imp - If the set contains the specified pointer, remove it and return true, otherwise return false.
const void *constfind_imp (const void *Ptr) const
 Returns the raw pointer needed to construct an iterator.
bool contains_imp (const void *Ptr) const
bool isSmall () const
LLVM_ABI void eraseFromBucket (const void **Bucket)
 Erase the entry at Bucket and close the resulting hole via Knuth TAOCP 6.4 Algorithm R.
LLVM_ABI void Grow (unsigned NewSize)
 Allocate a larger backing store for the buckets and move it over.
LLVM_ABI void swap (const void **SmallStorage, const void **RHSSmallStorage, SmallPtrSetImplBase &RHS)
 swap - Swaps the elements of two sets.
LLVM_ABI void copyFrom (const void **SmallStorage, const SmallPtrSetImplBase &RHS)
LLVM_ABI void moveFrom (const void **SmallStorage, unsigned SmallSize, const void **RHSSmallStorage, SmallPtrSetImplBase &&RHS)

Static Protected Member Functions

static void * getEmptyMarker ()

Protected Attributes

const void ** CurArray
 The current set of buckets, in either small or big representation.
unsigned CurArraySize
 CurArraySize - The allocated size of CurArray, always a power of two.
unsigned NumEntries
 Number of elements in CurArray that contain a value.
bool IsSmall
 Whether the set is in small representation.

Friends

class SmallPtrSetIteratorImpl

Detailed Description

SmallPtrSetImplBase - This is the common code shared among all the SmallPtrSet<>'s, which is almost everything.

SmallPtrSet has two modes, one for small and one for large sets.

Small sets use an array of pointers allocated in the SmallPtrSet object, which is treated as a simple array of pointers. When a pointer is added to the set, the array is scanned to see if the element already exists, if not the element is 'pushed back' onto the array. If we run out of space in the array, we grow into the 'large set' case. SmallSet should be used when the sets are often small. In this case, no memory allocation is used, and only light-weight and cache-efficient scanning is used.

Large sets use a linear-probed hash table with deletion implemented using Knuth TAOCP 6.4 Algorithm R: erase opens a hole, walks forward sliding each following entry whose probe path crosses the hole back into it (the hole moves with each slide), and stops at the next empty slot. Empty buckets are represented with an illegal pointer value (-1) to allow null pointers to be inserted; no tombstone state is needed. The hash table is resized when the table is 2/3 or more. When this happens, the table is doubled in size.

Definition at line 58 of file SmallPtrSet.h.

Member Typedef Documentation

◆ size_type

Definition at line 94 of file SmallPtrSet.h.

Constructor & Destructor Documentation

◆ SmallPtrSetImplBase() [1/3]

SmallPtrSetImplBase::SmallPtrSetImplBase ( const void ** SmallStorage,
const SmallPtrSetImplBase & that )
protected

◆ SmallPtrSetImplBase() [2/3]

SmallPtrSetImplBase::SmallPtrSetImplBase ( const void ** SmallStorage,
unsigned SmallSize,
const void ** RHSSmallStorage,
SmallPtrSetImplBase && that )
protected

Definition at line 143 of file SmallPtrSet.cpp.

References SmallPtrSetImplBase().

◆ SmallPtrSetImplBase() [3/3]

llvm::SmallPtrSetImplBase::SmallPtrSetImplBase ( const void ** SmallStorage,
unsigned SmallSize )
inlineexplicitprotected

Definition at line 81 of file SmallPtrSet.h.

References assert(), CurArray, CurArraySize, llvm::has_single_bit(), IsSmall, and NumEntries.

◆ ~SmallPtrSetImplBase()

llvm::SmallPtrSetImplBase::~SmallPtrSetImplBase ( )
inlineprotected

Definition at line 88 of file SmallPtrSet.h.

References CurArray, and isSmall().

Member Function Documentation

◆ buckets() [1/2]

iterator_range< const void ** > llvm::SmallPtrSetImplBase::buckets ( )
inlineprotected

◆ buckets() [2/2]

iterator_range< const void *const * > llvm::SmallPtrSetImplBase::buckets ( ) const
inlineprotected

Definition at line 160 of file SmallPtrSet.h.

References CurArray, EndPointer(), and llvm::make_range().

◆ capacity()

size_type llvm::SmallPtrSetImplBase::capacity ( ) const
inlinenodiscard

Definition at line 100 of file SmallPtrSet.h.

References CurArraySize.

◆ clear()

◆ contains_imp()

bool llvm::SmallPtrSetImplBase::contains_imp ( const void * Ptr) const
inlineprotected

◆ copyFrom()

void SmallPtrSetImplBase::copyFrom ( const void ** SmallStorage,
const SmallPtrSetImplBase & RHS )
protected

◆ empty()

◆ EndPointer()

const void ** llvm::SmallPtrSetImplBase::EndPointer ( ) const
inlineprotected

◆ erase_imp()

bool llvm::SmallPtrSetImplBase::erase_imp ( const void * Ptr)
inlineprotected

erase_imp - If the set contains the specified pointer, remove it and return true, otherwise return false.

This is hidden from the client so that the derived class can check that the right type of pointer is passed in.

Definition at line 190 of file SmallPtrSet.h.

References CurArray, eraseFromBucket(), llvm::DebugEpochBase::incrementEpoch(), isSmall(), NumEntries, and small_buckets().

Referenced by llvm::SmallPtrSetImpl< MachineInstr * >::erase().

◆ eraseFromBucket()

void SmallPtrSetImplBase::eraseFromBucket ( const void ** Bucket)
protected

Erase the entry at Bucket and close the resulting hole via Knuth TAOCP 6.4 Algorithm R.

Caller must update NumEntries and the epoch.

Definition at line 85 of file SmallPtrSet.cpp.

References CurArray, CurArraySize, DenseMapInfo< LocallyHashedType >::Empty, getEmptyMarker(), and I.

Referenced by erase_imp().

◆ find_imp()

const void *const * llvm::SmallPtrSetImplBase::find_imp ( const void * Ptr) const
inlineprotected

Returns the raw pointer needed to construct an iterator.

If element not found, this will be EndPointer. Otherwise, it will be a pointer to the slot which stores Ptr;

Definition at line 215 of file SmallPtrSet.h.

References EndPointer(), isSmall(), and small_buckets().

Referenced by llvm::SmallPtrSetImpl< MachineInstr * >::find().

◆ getEmptyMarker()

void * llvm::SmallPtrSetImplBase::getEmptyMarker ( )
inlinestaticprotected

◆ Grow()

void SmallPtrSetImplBase::Grow ( unsigned NewSize)
protected

Allocate a larger backing store for the buckets and move it over.

Grow - Allocate a larger backing store for the buckets and move it over.

Passing the current size triggers a same-size rehash, used by batch erase to compact away empty slots left by mark-then-rebuild.

Definition at line 104 of file SmallPtrSet.cpp.

References buckets(), CurArray, CurArraySize, getEmptyMarker(), IsSmall, isSmall(), and llvm::safe_malloc().

Referenced by llvm::SmallPtrSetImpl< MachineInstr * >::remove_if(), and reserve().

◆ insert_imp()

std::pair< const void *const *, bool > llvm::SmallPtrSetImplBase::insert_imp ( const void * Ptr)
inlineprotected

insert_imp - This returns true if the pointer was new to the set, false if it was already in the set.

This is hidden from the client so that the derived class can check that the right type of pointer is passed in.

Definition at line 167 of file SmallPtrSet.h.

References CurArray, CurArraySize, llvm::DebugEpochBase::incrementEpoch(), isSmall(), NumEntries, and small_buckets().

Referenced by llvm::SmallPtrSetImpl< MachineInstr * >::insert().

◆ isSmall()

◆ moveFrom()

void SmallPtrSetImplBase::moveFrom ( const void ** SmallStorage,
unsigned SmallSize,
const void ** RHSSmallStorage,
SmallPtrSetImplBase && RHS )
protected

◆ operator=()

SmallPtrSetImplBase & llvm::SmallPtrSetImplBase::operator= ( const SmallPtrSetImplBase & )
delete

References SmallPtrSetImplBase().

◆ reserve()

void llvm::SmallPtrSetImplBase::reserve ( size_type NewNumEntries)
inline

◆ size()

size_type llvm::SmallPtrSetImplBase::size ( ) const
inlinenodiscard

Definition at line 99 of file SmallPtrSet.h.

References NumEntries.

Referenced by adjustedSumFreq(), llvm::applyDebugifyMetadataToMachineFunction(), llvm::sandboxir::LegalityAnalysis::areUnique(), buildClonedLoops(), llvm::MachineIDFSSAUpdater::calculate(), llvm::calculateRegisterUsageForPlan(), slpvectorizer::BoUpSLP::canBuildSplitNode(), canFoldStoreIntoLibCallOutputPointers(), llvm::ScalarEvolution::canReuseInstruction(), llvm::changeToUnreachable(), checkIVUsers(), clear(), llvm::DomTreeNodeBase< BlockT >::compare(), llvm::compareLoops(), llvm::ConstantFoldTerminator(), containsUnreachable(), empty(), feedsIntoVectorReduction(), findBBsToSinkInto(), findBestNonTrivialUnswitchCandidate(), findReaching(), llvm::objcarc::findSingleDependency(), llvm::InstCombinerImpl::foldDeadPhiWeb(), llvm::InstCombinerImpl::foldFreezeIntoRecurrence(), llvm::LoopBase< BasicBlock, Loop >::getLoopLatch(), llvm::MemoryDependenceResults::getNonLocalCallDependency(), getOutliningPenalty(), llvm::getUnderlyingObjectAggressive(), llvm::ReachingDefInfo::getUniqueReachingMIDef(), llvm::hasPartialIVCondition(), llvm::SDNode::hasPredecessorHelper(), hasSameSuccessors(), isOnlyCopiedFromConstantMemory(), isPotentiallyReachable(), llvm::CombinerHelper::matchExtendThroughPhis(), optimizeLoopExitWithUnknownExitCount(), PHIsEqualValue(), llvm::PointerMayBeCaptured(), llvm::AArch64TTIImpl::preferTailFoldingOverEpilogue(), llvm::SCCPSolver::removeNonFeasibleEdges(), slpvectorizer::BoUpSLP::VLOperands::reorder(), llvm::SSAUpdaterBulk::RewriteAllUses(), runImpl(), llvm::AbstractDependenceGraphBuilder< GraphType >::simplify(), simplifyBlends(), llvm::JumpThreadingPass::simplifyPartiallyRedundantLoad(), sinkInstruction(), llvm::SplitBlockAndInsertIfThenElse(), updateForAIXShLibTLSModelOpt(), usersDominator(), llvm::GenericCycle< ContextT >::verifyCycle(), and llvm::MemorySSAUpdater::wireOldPredecessorsToNewImmediatePredecessor().

◆ small_buckets() [1/2]

iterator_range< const void ** > llvm::SmallPtrSetImplBase::small_buckets ( )
inlineprotected

◆ small_buckets() [2/2]

iterator_range< const void *const * > llvm::SmallPtrSetImplBase::small_buckets ( ) const
inlineprotected

Definition at line 152 of file SmallPtrSet.h.

References CurArray, and NumEntries.

◆ swap()

void SmallPtrSetImplBase::swap ( const void ** SmallStorage,
const void ** RHSSmallStorage,
SmallPtrSetImplBase & RHS )
protected

swap - Swaps the elements of two sets.

Note: This method assumes that both sets have the same small size.

Definition at line 224 of file SmallPtrSet.cpp.

References assert(), llvm::copy(), CurArray, CurArraySize, IsSmall, isSmall(), NumEntries, small_buckets(), SmallPtrSetImplBase(), and std::swap().

Referenced by llvm::SmallPtrSet< NodeRef, SmallSize >::swap().

◆ SmallPtrSetIteratorImpl

friend class SmallPtrSetIteratorImpl
friend

Definition at line 59 of file SmallPtrSet.h.

References SmallPtrSetIteratorImpl.

Referenced by SmallPtrSetIteratorImpl.

Member Data Documentation

◆ CurArray

◆ CurArraySize

unsigned llvm::SmallPtrSetImplBase::CurArraySize
protected

CurArraySize - The allocated size of CurArray, always a power of two.

Definition at line 65 of file SmallPtrSet.h.

Referenced by capacity(), clear(), copyFrom(), EndPointer(), eraseFromBucket(), Grow(), insert_imp(), llvm::SmallPtrSetImpl< MachineInstr * >::remove_if(), reserve(), SmallPtrSetImplBase(), SmallPtrSetImplBase(), and swap().

◆ IsSmall

bool llvm::SmallPtrSetImplBase::IsSmall
protected

Whether the set is in small representation.

Definition at line 72 of file SmallPtrSet.h.

Referenced by copyFrom(), Grow(), isSmall(), SmallPtrSetImplBase(), SmallPtrSetImplBase(), and swap().

◆ NumEntries

unsigned llvm::SmallPtrSetImplBase::NumEntries
protected

Number of elements in CurArray that contain a value.

If small, all these elements are at the beginning of CurArray and the rest is uninitialized.

Definition at line 70 of file SmallPtrSet.h.

Referenced by clear(), EndPointer(), erase_imp(), insert_imp(), llvm::SmallPtrSetImpl< MachineInstr * >::remove_if(), size(), small_buckets(), small_buckets(), SmallPtrSetImplBase(), and swap().


The documentation for this class was generated from the following files: