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< BasicBlockT * >, llvm::SmallPtrSetImpl< BasicBlock * >, llvm::SmallPtrSetImpl< const BasicBlock * >, llvm::SmallPtrSetImpl< const BasicBlockT * >, llvm::SmallPtrSetImpl< const MachineBasicBlock * >, llvm::SmallPtrSetImpl< typename GraphTraits< std::conditional_t< IsConst, const BlockT, BlockT > * >::NodeRef >, llvm::SmallPtrSetImpl< PointeeType * >, llvm::SmallPtrSetImpl< typename GraphTraits< GraphT >::NodeRef >, llvm::SmallPtrSetImpl< typename GraphTraits< T >::NodeRef >, llvm::SmallPtrSetImpl< NodeRef >, llvm::SmallPtrSetImpl< const MDNode * >, llvm::SmallPtrSetImpl< Instruction * >, llvm::SmallPtrSetImpl< llvm::Value * >, llvm::SmallPtrSetImpl< llvm::MachineBasicBlock * >, llvm::SmallPtrSetImpl< llvm::LiveRange * >, llvm::SmallPtrSetImpl< const llvm::AllocaInst * >, llvm::SmallPtrSetImpl< CallBase * >, llvm::SmallPtrSetImpl< AssumeInst * >, llvm::SmallPtrSetImpl< const MachineInstr * >, 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< const llvm::MDNode * >, llvm::SmallPtrSetImpl< llvm::Instruction * >, llvm::SmallPtrSetImpl< llvm::Use * >, llvm::SmallPtrSetImpl< llvm::GlobalVariable * >, llvm::SmallPtrSetImpl< llvm::Constant * >, llvm::SmallPtrSetImpl< llvm::GlobalValue * >, llvm::SmallPtrSetImpl< const llvm::DbgDeclareInst * >, llvm::SmallPtrSetImpl< const llvm::DbgVariableRecord * >, llvm::SmallPtrSetImpl< llvm::MachineInstr * >, llvm::SmallPtrSetImpl< const BlockT * >, llvm::SmallPtrSetImpl< const CycleT * >, llvm::SmallPtrSetImpl< const InstructionT * >, llvm::SmallPtrSetImpl< const llvm::GlobalValue * >, llvm::SmallPtrSetImpl< NodeTy * >, llvm::SmallPtrSetImpl< const Loop * >, llvm::SmallPtrSetImpl< const llvm::Function * >, llvm::SmallPtrSetImpl< llvm::InterleaveGroup< llvm::Instruction > * >, llvm::SmallPtrSetImpl< const llvm::BasicBlock * >, llvm::SmallPtrSetImpl< llvm::Module * >, llvm::SmallPtrSetImpl< const llvm::VNInfo * >, llvm::SmallPtrSetImpl< llvm::PHINode * >, llvm::SmallPtrSetImpl< llvm::Type * >, llvm::SmallPtrSetImpl< const PHINode * >, llvm::SmallPtrSetImpl< const llvm::Instruction * >, llvm::SmallPtrSetImpl< const llvm::MCSymbol * >, llvm::SmallPtrSetImpl< Module * >, llvm::SmallPtrSetImpl< const llvm::LazyCallGraph::Node * >, llvm::SmallPtrSetImpl< llvm::MachineRegisterInfo::Delegate * >, llvm::SmallPtrSetImpl< const Value * >, llvm::SmallPtrSetImpl< void * >, llvm::SmallPtrSetImpl< llvm::AnalysisKey * >, llvm::SmallPtrSetImpl< const llvm::SCEV * >, llvm::SmallPtrSetImpl< const llvm::Type * >, llvm::SmallPtrSetImpl< const llvm::PHINode * >, llvm::SmallPtrSetImpl< const llvm::SCEVAddRecExpr * >, llvm::SmallPtrSetImpl< const llvm::SCEVPredicate * >, llvm::SmallPtrSetImpl< llvm::cl::SubCommand * >, llvm::SmallPtrSetImpl< Value * >, and llvm::SmallPtrSetImpl< PtrType >.

Public Types
using	size_type = unsigned

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

Protected Member Functions
	SmallPtrSetImplBase (const void **SmallStorage, const SmallPtrSetImplBase &that)
	SmallPtrSetImplBase (const void **SmallStorage, unsigned SmallSize, SmallPtrSetImplBase &&that)
	SmallPtrSetImplBase (const void **SmallStorage, unsigned SmallSize)
	~SmallPtrSetImplBase ()
const void **	EndPointer () const
std::pair< const void *const *, bool >	insert_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 *const *	find_imp (const void *Ptr) const
	Returns the raw pointer needed to construct an iterator.
bool	isSmall () const
void	swap (SmallPtrSetImplBase &RHS)
	swap - Swaps the elements of two sets.
void	CopyFrom (const SmallPtrSetImplBase &RHS)
void	MoveFrom (unsigned SmallSize, SmallPtrSetImplBase &&RHS)

Static Protected Member Functions
static void *	getTombstoneMarker ()
static void *	getEmptyMarker ()

Protected Attributes
const void **	SmallArray
	SmallArray - Points to a fixed size set of buckets, used in 'small mode'.
const void **	CurArray
	CurArray - This is the current set of buckets.
unsigned	CurArraySize
	CurArraySize - The allocated size of CurArray, always a power of two.
unsigned	NumNonEmpty
	Number of elements in CurArray that contain a value or are a tombstone.
unsigned	NumTombstones
	Number of tombstones in CurArray.

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 classic exponentially-probed hash table. Empty buckets are represented with an illegal pointer value (-1) to allow null pointers to be inserted. Tombstones are represented with another illegal pointer value (-2), to allow deletion. The hash table is resized when the table is 3/4 or more. When this happens, the table is doubled in size.

Definition at line 52 of file SmallPtrSet.h.

Member Typedef Documentation

size_type

using llvm::SmallPtrSetImplBase::size_type = unsigned

Definition at line 90 of file SmallPtrSet.h.

Constructor & Destructor Documentation

SmallPtrSetImplBase() [1/3]

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

protected

Definition at line 139 of file SmallPtrSet.cpp.

References CurArray, CurArraySize, isSmall(), llvm::safe_malloc(), and SmallArray.

SmallPtrSetImplBase() [2/3]

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

protected

Definition at line 155 of file SmallPtrSet.cpp.

References SmallArray.

SmallPtrSetImplBase() [3/3]

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

inlineexplicitprotected

Definition at line 77 of file SmallPtrSet.h.

References assert().

~SmallPtrSetImplBase()

llvm::SmallPtrSetImplBase::~SmallPtrSetImplBase ( )

inlineprotected

Definition at line 84 of file SmallPtrSet.h.

References CurArray, and isSmall().

Member Function Documentation

capacity()

size_type llvm::SmallPtrSetImplBase::capacity ( ) const

inline

Definition at line 96 of file SmallPtrSet.h.

References CurArraySize.

clear()

void llvm::SmallPtrSetImplBase::clear ( )

inline

Definition at line 98 of file SmallPtrSet.h.

References CurArray, CurArraySize, llvm::DebugEpochBase::incrementEpoch(), isSmall(), NumNonEmpty, NumTombstones, and size().

Referenced by buildClonedLoopBlocks(), llvm::SampleProfileLoaderBaseImpl< FT >::buildEdges(), canonicalizePHIOperands(), llvm::SCEVExpander::clear(), llvm::AAExecutionDomain::ExecutionDomainTy::clearAssumeInstAndAlignedBarriers(), llvm::SCEVExpander::clearPostInc(), llvm::ObjectSizeOffsetEvaluator::compute(), ComputePostOrders(), llvm::SelectionDAG::copyExtraInfo(), llvm::slpvectorizer::BoUpSLP::deleteTree(), llvm::OpenMPIRBuilder::finalize(), findBBsToSinkInto(), llvm::LexicalScopes::getMachineBasicBlocks(), HandleMergeInputChains(), llvm::MergeBasicBlockIntoOnlyPred(), llvm::MergeBlockIntoPredecessor(), llvm::SmallPtrSet< PtrType, SmallSize >::operator=(), optimizeGlobalsInModule(), llvm::slpvectorizer::BoUpSLP::reorderBottomToTop(), llvm::SSPLayoutAnalysis::requiresStackProtector(), simplifyLoopInst(), stripDebugLocFromLoopID(), llvm::TryToSimplifyUncondBranchFromEmptyBlock(), updatePostorderSequenceForEdgeInsertion(), and llvm::LoopBase< BlockT, LoopT >::~LoopBase().

CopyFrom()

void SmallPtrSetImplBase::CopyFrom ( const SmallPtrSetImplBase &  RHS )

protected

Definition at line 162 of file SmallPtrSet.cpp.

References assert(), CurArray, CurArraySize, isSmall(), RHS, llvm::safe_malloc(), llvm::safe_realloc(), and SmallArray.

Referenced by llvm::SmallPtrSet< PtrType, SmallSize >::operator=().

empty()

bool llvm::SmallPtrSetImplBase::empty ( ) const

inline

Definition at line 94 of file SmallPtrSet.h.

References size().

Referenced by alwaysInlineImpl(), buildClonedLoops(), llvm::buildModuleSummaryIndex(), collectInstructionsInBetween(), collectTransitivePredecessors(), dominatesMergePoint(), llvm::LoopVectorizationCostModel::getReductionPatternCost(), llvm::GenericDomTreeUpdater< DerivedT, DomTreeT, PostDomTreeT >::hasPendingDeletedBB(), llvm::GenericDomTreeUpdater< DerivedT, DomTreeT, PostDomTreeT >::isBBPendingDeletion(), llvm::ScalarEvolution::isKnownViaInduction(), llvm::isPotentiallyReachable(), isReachableImpl(), llvm::MergeBlockSuccessorsIntoGivenBlocks(), llvm::SelectionDAG::MorphNodeTo(), producesFalseLanesZero(), ReachabilityQueryInfo< ToTy >::ReachabilityQueryInfo(), rebuildLoopAfterUnswitch(), recomputeLoopBlockSet(), rewriteDebugUsers(), sink(), sinkInstruction(), llvm::MemorySSA::verifyDominationNumbers(), and llvm::LLVMContextImpl::~LLVMContextImpl().

EndPointer()

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

inlineprotected

Definition at line 143 of file SmallPtrSet.h.

References CurArray, CurArraySize, isSmall(), and NumNonEmpty.

Referenced by llvm::SmallPtrSetImpl< PtrType >::begin(), llvm::SmallPtrSetImpl< PtrType >::contains(), llvm::SmallPtrSetImpl< PtrType >::count(), llvm::SmallPtrSetImpl< PtrType >::end(), find_imp(), and llvm::SmallPtrSetImpl< PtrType >::remove_if().

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 175 of file SmallPtrSet.h.

References E, getTombstoneMarker(), llvm::DebugEpochBase::incrementEpoch(), isSmall(), NumNonEmpty, NumTombstones, Ptr, and SmallArray.

Referenced by llvm::SmallPtrSetImpl< PtrType >::erase().

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 203 of file SmallPtrSet.h.

References E, EndPointer(), isSmall(), NumNonEmpty, Ptr, and SmallArray.

Referenced by llvm::SmallPtrSetImpl< PtrType >::contains(), llvm::SmallPtrSetImpl< PtrType >::count(), and llvm::SmallPtrSetImpl< PtrType >::find().

getEmptyMarker()

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

inlinestaticprotected

Definition at line 137 of file SmallPtrSet.h.

Referenced by llvm::SmallPtrSetIteratorImpl::AdvanceIfNotValid(), llvm::SmallPtrSetImpl< PtrType >::remove_if(), and llvm::SmallPtrSetIteratorImpl::RetreatIfNotValid().

getTombstoneMarker()

static void * llvm::SmallPtrSetImplBase::getTombstoneMarker ( )

inlinestaticprotected

Definition at line 135 of file SmallPtrSet.h.

Referenced by llvm::SmallPtrSetIteratorImpl::AdvanceIfNotValid(), erase_imp(), llvm::SmallPtrSetImpl< PtrType >::remove_if(), and llvm::SmallPtrSetIteratorImpl::RetreatIfNotValid().

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 150 of file SmallPtrSet.h.

References CurArraySize, E, llvm::DebugEpochBase::incrementEpoch(), isSmall(), NumNonEmpty, Ptr, and SmallArray.

Referenced by llvm::SmallPtrSetImpl< PtrType >::insert().

isSmall()

bool llvm::SmallPtrSetImplBase::isSmall ( ) const

inlineprotected

Definition at line 219 of file SmallPtrSet.h.

References CurArray, and SmallArray.

Referenced by clear(), CopyFrom(), EndPointer(), erase_imp(), find_imp(), insert_imp(), MoveFrom(), llvm::SmallPtrSetImpl< PtrType >::remove_if(), reserve(), SmallPtrSetImplBase(), swap(), and ~SmallPtrSetImplBase().

MoveFrom()

void SmallPtrSetImplBase::MoveFrom ( unsigned  SmallSize, SmallPtrSetImplBase &&  RHS  )

protected

Definition at line 199 of file SmallPtrSet.cpp.

References CurArray, isSmall(), and RHS.

Referenced by llvm::SmallPtrSet< PtrType, SmallSize >::operator=().

operator=()

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

delete

reserve()

void llvm::SmallPtrSetImplBase::reserve ( size_type  NumEntries )

inline

Definition at line 113 of file SmallPtrSet.h.

References CurArraySize, llvm::DebugEpochBase::incrementEpoch(), isSmall(), and llvm::Log2_32_Ceil().

Referenced by llvm::IDFCalculatorBase< NodeTy, IsPostDom >::calculate(), and llvm::VETargetLowering::emitSjLjDispatchBlock().

size()

size_type llvm::SmallPtrSetImplBase::size ( ) const

inline

Definition at line 95 of file SmallPtrSet.h.

References NumNonEmpty, and NumTombstones.

Referenced by adjustedSumFreq(), llvm::SampleProfileInference< FT >::apply(), buildClonedLoops(), llvm::LoopVectorizationCostModel::calculateRegisterUsage(), llvm::ScalarEvolution::canReuseInstruction(), clear(), empty(), findBBsToSinkInto(), findBestNonTrivialUnswitchCandidate(), llvm::objcarc::findSingleDependency(), llvm::InstCombinerImpl::foldFreezeIntoRecurrence(), llvm::BasicTTIImplBase< T >::getEstimatedNumberOfCaseClusters(), llvm::MemoryDependenceResults::getNonLocalCallDependency(), getOutliningPenalty(), llvm::slpvectorizer::BoUpSLP::getSpillCost(), llvm::getUnderlyingObjectAggressive(), llvm::hasPartialIVCondition(), llvm::SDNode::hasPredecessorHelper(), hasSameSuccessors(), isDeadPHICycle(), isOnlyCopiedFromConstantMemory(), isPotentiallyReachable(), llvm::CombinerHelper::matchExtendThroughPhis(), optimizeLoopExitWithUnknownExitCount(), PHIsEqualValue(), llvm::AArch64TTIImpl::preferPredicateOverEpilogue(), llvm::SCCPSolver::removeNonFeasibleEdges(), llvm::removeUnreachableBlocks(), llvm::slpvectorizer::BoUpSLP::VLOperands::reorder(), runImpl(), llvm::SPIRVMergeRegionExitTargets::runOnConvergenceRegionNoRecurse(), llvm::AbstractDependenceGraphBuilder< GraphType >::simplify(), llvm::JumpThreadingPass::simplifyPartiallyRedundantLoad(), simplifyRecipe(), sinkInstruction(), llvm::SplitBlockAndInsertIfThenElse(), updateForAIXShLibTLSModelOpt(), usersDominator(), llvm::GenericCycle< ContextT >::verifyCycle(), and llvm::MemorySSAUpdater::wireOldPredecessorsToNewImmediatePredecessor().

swap()

void SmallPtrSetImplBase::swap ( 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 231 of file SmallPtrSet.cpp.

References assert(), CurArray, CurArraySize, isSmall(), NumTombstones, RHS, SmallArray, and std::swap().

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

Friends And Related Function Documentation

SmallPtrSetIteratorImpl

friend class SmallPtrSetIteratorImpl

friend

Definition at line 53 of file SmallPtrSet.h.

Member Data Documentation

CurArray

const void** llvm::SmallPtrSetImplBase::CurArray

protected

CurArray - This is the current set of buckets.

If equal to SmallArray, then the set is in 'small mode'.

Definition at line 60 of file SmallPtrSet.h.

Referenced by llvm::SmallPtrSetImpl< PtrType >::begin(), clear(), CopyFrom(), EndPointer(), isSmall(), MoveFrom(), llvm::SmallPtrSetImpl< PtrType >::remove_if(), SmallPtrSetImplBase(), swap(), and ~SmallPtrSetImplBase().

CurArraySize

unsigned llvm::SmallPtrSetImplBase::CurArraySize

protected

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

Definition at line 62 of file SmallPtrSet.h.

Referenced by capacity(), clear(), CopyFrom(), EndPointer(), insert_imp(), reserve(), SmallPtrSetImplBase(), and swap().

NumNonEmpty

unsigned llvm::SmallPtrSetImplBase::NumNonEmpty

protected

Number of elements in CurArray that contain a value or are a tombstone.

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

Definition at line 67 of file SmallPtrSet.h.

Referenced by clear(), EndPointer(), erase_imp(), find_imp(), insert_imp(), llvm::SmallPtrSetImpl< PtrType >::remove_if(), and size().

NumTombstones

unsigned llvm::SmallPtrSetImplBase::NumTombstones

protected

Number of tombstones in CurArray.

Definition at line 69 of file SmallPtrSet.h.

Referenced by clear(), erase_imp(), llvm::SmallPtrSetImpl< PtrType >::remove_if(), size(), and swap().

SmallArray

const void** llvm::SmallPtrSetImplBase::SmallArray

protected

SmallArray - Points to a fixed size set of buckets, used in 'small mode'.

Definition at line 57 of file SmallPtrSet.h.

Referenced by CopyFrom(), erase_imp(), find_imp(), insert_imp(), isSmall(), llvm::SmallPtrSetImpl< PtrType >::remove_if(), SmallPtrSetImplBase(), and swap().

---

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

• include/llvm/ADT/SmallPtrSet.h
• lib/Support/SmallPtrSet.cpp