A type to track pointer/struct usage and accesses for AAPointerInfo. More...

Inheritance diagram for llvm::AA::PointerInfo::State:

Public Member Functions
	State ()=default
	State (State &&SIS)=default
const State &	getAssumed () const
bool	isValidState () const override
	Return if this abstract state is in a valid state.
bool	isAtFixpoint () const override
	Return if this abstract state is fixed, thus does not need to be updated if information changes as it cannot change itself.
ChangeStatus	indicateOptimisticFixpoint () override
	Indicate that the abstract state should converge to the optimistic state.
ChangeStatus	indicatePessimisticFixpoint () override
	Indicate that the abstract state should converge to the pessimistic state.
State &	operator= (const State &R)
State &	operator= (State &&R)
ChangeStatus	addAccess (Attributor &A, const AAPointerInfo::RangeList &Ranges, Instruction &I, std::optional< Value * > Content, AAPointerInfo::AccessKind Kind, Type Ty, Instruction RemoteI=nullptr)
	Add a new Access to the state at offset `Offset` and with size `Size`.
AAPointerInfo::const_bin_iterator	begin () const
AAPointerInfo::const_bin_iterator	end () const
int64_t	numOffsetBins () const
const AAPointerInfo::Access &	getAccess (unsigned Index) const
Public Member Functions inherited from llvm::AbstractState
virtual	~AbstractState ()=default

Static Public Member Functions
static State	getBestState (const State &SIS)
	Return the best possible representable state.
static State	getWorstState (const State &SIS)
	Return the worst possible representable state.

Protected Member Functions
template<typename F>
bool	forallInterferingAccesses (AA::RangeTy Range, F CB) const
	See AAPointerInfo::forallInterferingAccesses.
template<typename F>
bool	forallInterferingAccesses (Instruction &I, F CB, AA::RangeTy &Range) const
	See AAPointerInfo::forallInterferingAccesses.

Protected Attributes
SmallVector< AAPointerInfo::Access >	AccessList
AAPointerInfo::OffsetBinsTy	OffsetBins
DenseMap< const Instruction *, SmallVector< unsigned > >	RemoteIMap
AAPointerInfo::OffsetInfo	ReturnedOffsets
	Flag to determine if the underlying pointer is reaching a return statement in the associated function or not.

Detailed Description

A type to track pointer/struct usage and accesses for AAPointerInfo.

Definition at line 774 of file AttributorAttributes.cpp.

Constructor & Destructor Documentation

◆ State() [1/2]

llvm::AA::PointerInfo::State::State ( )

default

Referenced by getAssumed(), getBestState(), getWorstState(), operator=(), operator=(), and State().

◆ State() [2/2]

llvm::AA::PointerInfo::State::State ( State && SIS )

default

References State().

Member Function Documentation

◆ addAccess()

ChangeStatus llvm::AA::PointerInfo::State::addAccess	(	Attributor &	A,
		const AAPointerInfo::RangeList &	Ranges,
		Instruction &	I,
		std::optional< Value * >	Content,
		AAPointerInfo::AccessKind	Kind,
		Type *	Ty,
		Instruction *	RemoteI = nullptr )

Add a new Access to the state at offset Offset and with size Size.

The access is associated with I, writes Content (if anything), and is of kind Kind. If an Access already exists for the same I and same RemoteI, the two are combined, potentially losing information about offset and size. The resulting access must now be moved from its original OffsetBin to the bin for its new offset.

\Returns CHANGED, if the state changed, UNCHANGED otherwise.

Definition at line 916 of file AttributorAttributes.cpp.

References A(), AccessList, assert(), llvm::Bin, llvm::CHANGED, llvm::dbgs(), I, llvm::InnerAnalysisManagerProxy< AnalysisManagerT, IRUnitT, ExtraArgTs... >::Key, LLVM_DEBUG, OffsetBins, RemoteIMap, llvm::AAPointerInfo::RangeList::set_difference(), ToRemove, and llvm::UNCHANGED.

◆ begin()

AAPointerInfo::const_bin_iterator llvm::AA::PointerInfo::State::begin ( ) const

inline

Definition at line 839 of file AttributorAttributes.cpp.

References OffsetBins.

◆ end()

AAPointerInfo::const_bin_iterator llvm::AA::PointerInfo::State::end ( ) const

inline

Definition at line 840 of file AttributorAttributes.cpp.

References OffsetBins.

◆ forallInterferingAccesses() [1/2]

template<typename F>

bool llvm::AA::PointerInfo::State::forallInterferingAccesses	(	AA::RangeTy	Range,
		F	CB ) const

inlineprotected

See AAPointerInfo::forallInterferingAccesses.

Definition at line 871 of file AttributorAttributes.cpp.

References Access, AccessList, F, isValidState(), OffsetBins, Range, and ReturnedOffsets.

Referenced by forallInterferingAccesses().

◆ forallInterferingAccesses() [2/2]

template<typename F>

bool llvm::AA::PointerInfo::State::forallInterferingAccesses	(	Instruction &	I,
		F	CB,
		AA::RangeTy &	Range ) const

inlineprotected

See AAPointerInfo::forallInterferingAccesses.

Definition at line 891 of file AttributorAttributes.cpp.

References AccessList, F, forallInterferingAccesses(), I, isValidState(), Range, RemoteIMap, and ReturnedOffsets.

◆ getAccess()

const AAPointerInfo::Access & llvm::AA::PointerInfo::State::getAccess ( unsigned Index ) const

inline

Definition at line 843 of file AttributorAttributes.cpp.

References AccessList.

◆ getAssumed()

const State & llvm::AA::PointerInfo::State::getAssumed ( ) const

inline

Definition at line 788 of file AttributorAttributes.cpp.

References State().

◆ getBestState()

State llvm::AA::PointerInfo::State::getBestState ( const State & SIS )

inlinestatic

Return the best possible representable state.

Definition at line 776 of file AttributorAttributes.cpp.

References State().

◆ getWorstState()

State llvm::AA::PointerInfo::State::getWorstState ( const State & SIS )

inlinestatic

Return the worst possible representable state.

Definition at line 779 of file AttributorAttributes.cpp.

References State().

◆ indicateOptimisticFixpoint()

ChangeStatus llvm::AA::PointerInfo::State::indicateOptimisticFixpoint ( )

inlineoverridevirtual

Indicate that the abstract state should converge to the optimistic state.

This will usually make the optimistically assumed state the known to be true state.

Returns: ChangeStatus::UNCHANGED as the assumed value should not change.

Implements llvm::AbstractState.

Definition at line 794 of file AttributorAttributes.cpp.

References llvm::UNCHANGED.

◆ indicatePessimisticFixpoint()

ChangeStatus llvm::AA::PointerInfo::State::indicatePessimisticFixpoint ( )

inlineoverridevirtual

Indicate that the abstract state should converge to the pessimistic state.

This will usually revert the optimistically assumed state to the known to be true state.

Returns: ChangeStatus::CHANGED as the assumed value may change.

Implements llvm::AbstractState.

Definition at line 799 of file AttributorAttributes.cpp.

References llvm::CHANGED.

◆ isAtFixpoint()

bool llvm::AA::PointerInfo::State::isAtFixpoint ( ) const

inlineoverridevirtual

Return if this abstract state is fixed, thus does not need to be updated if information changes as it cannot change itself.

Implements llvm::AbstractState.

Definition at line 792 of file AttributorAttributes.cpp.

◆ isValidState()

bool llvm::AA::PointerInfo::State::isValidState ( ) const

inlineoverridevirtual

Return if this abstract state is in a valid state.

If false, no information provided should be used.

Implements llvm::AbstractState.

Definition at line 790 of file AttributorAttributes.cpp.

Referenced by forallInterferingAccesses(), and forallInterferingAccesses().

◆ numOffsetBins()

int64_t llvm::AA::PointerInfo::State::numOffsetBins ( ) const

inline

Definition at line 841 of file AttributorAttributes.cpp.

References OffsetBins.

◆ operator=() [1/2]

State & llvm::AA::PointerInfo::State::operator= ( const State & R )

inline

Definition at line 804 of file AttributorAttributes.cpp.

References AccessList, OffsetBins, RemoteIMap, ReturnedOffsets, and State().

◆ operator=() [2/2]

State & llvm::AA::PointerInfo::State::operator= ( State && R )

inline

Definition at line 815 of file AttributorAttributes.cpp.

References AccessList, OffsetBins, RemoteIMap, ReturnedOffsets, State(), and std::swap().

Member Data Documentation

◆ AccessList

SmallVector<AAPointerInfo::Access> llvm::AA::PointerInfo::State::AccessList

protected

Definition at line 860 of file AttributorAttributes.cpp.

Referenced by addAccess(), forallInterferingAccesses(), forallInterferingAccesses(), getAccess(), operator=(), and operator=().

◆ OffsetBins

AAPointerInfo::OffsetBinsTy llvm::AA::PointerInfo::State::OffsetBins

protected

Definition at line 861 of file AttributorAttributes.cpp.

Referenced by addAccess(), begin(), end(), forallInterferingAccesses(), numOffsetBins(), operator=(), and operator=().

◆ RemoteIMap

DenseMap<const Instruction *, SmallVector<unsigned> > llvm::AA::PointerInfo::State::RemoteIMap

protected

Definition at line 862 of file AttributorAttributes.cpp.

Referenced by addAccess(), forallInterferingAccesses(), operator=(), and operator=().

◆ ReturnedOffsets

AAPointerInfo::OffsetInfo llvm::AA::PointerInfo::State::ReturnedOffsets

protected

Flag to determine if the underlying pointer is reaching a return statement in the associated function or not.

Returns in other functions cause invalidation.

Definition at line 867 of file AttributorAttributes.cpp.

Referenced by forallInterferingAccesses(), forallInterferingAccesses(), operator=(), and operator=().

The documentation for this struct was generated from the following file:

lib/Transforms/IPO/AttributorAttributes.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ State() [1/2]

◆ State() [2/2]

Member Function Documentation

◆ addAccess()

◆ begin()

◆ end()

◆ forallInterferingAccesses() [1/2]

◆ forallInterferingAccesses() [2/2]

◆ getAccess()

◆ getAssumed()

◆ getBestState()

◆ getWorstState()

◆ indicateOptimisticFixpoint()

◆ indicatePessimisticFixpoint()

◆ isAtFixpoint()

◆ isValidState()

◆ numOffsetBins()

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ AccessList

◆ OffsetBins

◆ RemoteIMap

◆ ReturnedOffsets