Simple state with integers encoding. More...

#include "llvm/Transforms/IPO/Attributor.h"

Inheritance diagram for llvm::IntegerStateBase< base_ty, BestState, WorstState >:

Public Types
using	base_t = base_ty

Public Member Functions
	IntegerStateBase ()=default
	IntegerStateBase (base_t Assumed)
bool	isValidState () const override
	NOTE: For now we simply pretend that the worst possible state is invalid.
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.
base_t	getKnown () const
	Return the known state encoding.
base_t	getAssumed () const
	Return the assumed state encoding.
bool	operator== (const IntegerStateBase< base_t, BestState, WorstState > &R) const
	Equality for IntegerStateBase.
bool	operator!= (const IntegerStateBase< base_t, BestState, WorstState > &R) const
	Inequality for IntegerStateBase.
void	operator^= (const IntegerStateBase< base_t, BestState, WorstState > &R)
	"Clamp" this state with `R`.
void	operator+= (const IntegerStateBase< base_t, BestState, WorstState > &R)
	"Clamp" this state with `R`.
void	operator\|= (const IntegerStateBase< base_t, BestState, WorstState > &R)
void	operator&= (const IntegerStateBase< base_t, BestState, WorstState > &R)
Public Member Functions inherited from llvm::AbstractState
virtual	~AbstractState ()=default

Static Public Member Functions
static constexpr base_t	getBestState ()
	Return the best possible representable state.
static constexpr base_t	getBestState (const IntegerStateBase &)
static constexpr base_t	getWorstState ()
	Return the worst possible representable state.
static constexpr base_t	getWorstState (const IntegerStateBase &)

Protected Member Functions
virtual void	handleNewAssumedValue (base_t Value)=0
	Handle a new assumed value `Value`. Subtype dependent.
virtual void	handleNewKnownValue (base_t Value)=0
	Handle a new known value `Value`. Subtype dependent.
virtual void	joinOR (base_t AssumedValue, base_t KnownValue)=0
	Handle a value `Value`. Subtype dependent.
virtual void	joinAND (base_t AssumedValue, base_t KnownValue)=0
	Handle a new assumed value `Value`. Subtype dependent.

Protected Attributes
base_t	Known = getWorstState()
	The known state encoding in an integer of type base_t.
base_t	Assumed = getBestState()
	The assumed state encoding in an integer of type base_t.

Detailed Description

template<typename base_ty, base_ty BestState, base_ty WorstState>
struct llvm::IntegerStateBase< base_ty, BestState, WorstState >

Simple state with integers encoding.

The interface ensures that the assumed bits are always a subset of the known bits. Users can only add known bits and, except through adding known bits, they can only remove assumed bits. This should guarantee monotonicity and thereby the existence of a fixpoint (if used correctly). The fixpoint is reached when the assumed and known state/bits are equal. Users can force/inidicate a fixpoint. If an optimistic one is indicated, the known state will catch up with the assumed one, for a pessimistic fixpoint it is the other way around.

Definition at line 2641 of file Attributor.h.

Member Typedef Documentation

◆ base_t

template<typename base_ty, base_ty BestState, base_ty WorstState>

using llvm::IntegerStateBase< base_ty, BestState, WorstState >::base_t = base_ty

Definition at line 2642 of file Attributor.h.

Constructor & Destructor Documentation

◆ IntegerStateBase() [1/2]

template<typename base_ty, base_ty BestState, base_ty WorstState>

llvm::IntegerStateBase< base_ty, BestState, WorstState >::IntegerStateBase ( )

default

◆ IntegerStateBase() [2/2]

template<typename base_ty, base_ty BestState, base_ty WorstState>

llvm::IntegerStateBase< base_ty, BestState, WorstState >::IntegerStateBase ( base_t Assumed )

inline

Definition at line 2645 of file Attributor.h.

Member Function Documentation

◆ getAssumed()

template<typename base_ty, base_ty BestState, base_ty WorstState>

base_t llvm::IntegerStateBase< base_ty, BestState, WorstState >::getAssumed ( ) const

inline

Return the assumed state encoding.

Definition at line 2678 of file Attributor.h.

Referenced by llvm::AAAlign::getAssumedAlign(), llvm::AADereferenceable::isAssumedGlobal(), llvm::operator<<(), and llvm::IntegerStateBase< bool, true, false >::operator==().

◆ getBestState() [1/2]

template<typename base_ty, base_ty BestState, base_ty WorstState>

constexpr base_t llvm::IntegerStateBase< base_ty, BestState, WorstState >::getBestState ( )

inlinestaticconstexpr

Return the best possible representable state.

Definition at line 2648 of file Attributor.h.

Referenced by llvm::IntegerStateBase< bool, true, false >::getBestState().

◆ getBestState() [2/2]

template<typename base_ty, base_ty BestState, base_ty WorstState>

constexpr base_t llvm::IntegerStateBase< base_ty, BestState, WorstState >::getBestState ( const IntegerStateBase< base_ty, BestState, WorstState > & )

inlinestaticconstexpr

Definition at line 2649 of file Attributor.h.

◆ getKnown()

template<typename base_ty, base_ty BestState, base_ty WorstState>

base_t llvm::IntegerStateBase< base_ty, BestState, WorstState >::getKnown ( ) const

inline

Return the known state encoding.

Definition at line 2675 of file Attributor.h.

Referenced by llvm::AAAlign::getKnownAlign(), llvm::AADereferenceable::isKnownGlobal(), llvm::operator<<(), and llvm::IntegerStateBase< bool, true, false >::operator==().

◆ getWorstState() [1/2]

template<typename base_ty, base_ty BestState, base_ty WorstState>

constexpr base_t llvm::IntegerStateBase< base_ty, BestState, WorstState >::getWorstState ( )

inlinestaticconstexpr

Return the worst possible representable state.

Definition at line 2654 of file Attributor.h.

Referenced by llvm::IntegerStateBase< bool, true, false >::getWorstState(), and llvm::IntegerStateBase< bool, true, false >::isValidState().

◆ getWorstState() [2/2]

template<typename base_ty, base_ty BestState, base_ty WorstState>

constexpr base_t llvm::IntegerStateBase< base_ty, BestState, WorstState >::getWorstState ( const IntegerStateBase< base_ty, BestState, WorstState > & )

inlinestaticconstexpr

Definition at line 2655 of file Attributor.h.

◆ handleNewAssumedValue()

template<typename base_ty, base_ty BestState, base_ty WorstState>

virtual void llvm::IntegerStateBase< base_ty, BestState, WorstState >::handleNewAssumedValue ( base_t Value )

protectedpure virtual

Handle a new assumed value Value. Subtype dependent.

Referenced by llvm::IntegerStateBase< bool, true, false >::operator^=().

◆ handleNewKnownValue()

template<typename base_ty, base_ty BestState, base_ty WorstState>

virtual void llvm::IntegerStateBase< base_ty, BestState, WorstState >::handleNewKnownValue ( base_t Value )

protectedpure virtual

Handle a new known value Value. Subtype dependent.

Referenced by llvm::IntegerStateBase< bool, true, false >::operator+=().

◆ indicateOptimisticFixpoint()

template<typename base_ty, base_ty BestState, base_ty WorstState>

ChangeStatus llvm::IntegerStateBase< base_ty, BestState, WorstState >::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 2664 of file Attributor.h.

◆ indicatePessimisticFixpoint()

template<typename base_ty, base_ty BestState, base_ty WorstState>

ChangeStatus llvm::IntegerStateBase< base_ty, BestState, WorstState >::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 2669 of file Attributor.h.

◆ isAtFixpoint()

template<typename base_ty, base_ty BestState, base_ty WorstState>

bool llvm::IntegerStateBase< base_ty, BestState, WorstState >::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 2662 of file Attributor.h.

◆ isValidState()

template<typename base_ty, base_ty BestState, base_ty WorstState>

bool llvm::IntegerStateBase< base_ty, BestState, WorstState >::isValidState ( ) const

inlineoverridevirtual

NOTE: For now we simply pretend that the worst possible state is invalid.

Implements llvm::AbstractState.

Definition at line 2660 of file Attributor.h.

◆ joinAND()

template<typename base_ty, base_ty BestState, base_ty WorstState>

virtual void llvm::IntegerStateBase< base_ty, BestState, WorstState >::joinAND	(	base_t	AssumedValue,
		base_t	KnownValue )

protectedpure virtual

Handle a new assumed value Value. Subtype dependent.

Referenced by llvm::IntegerStateBase< bool, true, false >::operator&=().

◆ joinOR()

template<typename base_ty, base_ty BestState, base_ty WorstState>

virtual void llvm::IntegerStateBase< base_ty, BestState, WorstState >::joinOR	(	base_t	AssumedValue,
		base_t	KnownValue )

protectedpure virtual

Handle a value Value. Subtype dependent.

Referenced by llvm::IntegerStateBase< bool, true, false >::operator|=().

◆ operator!=()

template<typename base_ty, base_ty BestState, base_ty WorstState>

bool llvm::IntegerStateBase< base_ty, BestState, WorstState >::operator!= ( const IntegerStateBase< base_t, BestState, WorstState > & R ) const

inline

Inequality for IntegerStateBase.

Definition at line 2689 of file Attributor.h.

◆ operator&=()

template<typename base_ty, base_ty BestState, base_ty WorstState>

void llvm::IntegerStateBase< base_ty, BestState, WorstState >::operator&= ( const IntegerStateBase< base_t, BestState, WorstState > & R )

inline

Definition at line 2711 of file Attributor.h.

◆ operator+=()

template<typename base_ty, base_ty BestState, base_ty WorstState>

void llvm::IntegerStateBase< base_ty, BestState, WorstState >::operator+= ( const IntegerStateBase< base_t, BestState, WorstState > & R )

inline

"Clamp" this state with R.

The result is subtype dependent but it is intended that information known in either state will be known in this one afterwards.

Definition at line 2703 of file Attributor.h.

◆ operator==()

template<typename base_ty, base_ty BestState, base_ty WorstState>

bool llvm::IntegerStateBase< base_ty, BestState, WorstState >::operator== ( const IntegerStateBase< base_t, BestState, WorstState > & R ) const

inline

Equality for IntegerStateBase.

Definition at line 2682 of file Attributor.h.

◆ operator^=()

template<typename base_ty, base_ty BestState, base_ty WorstState>

void llvm::IntegerStateBase< base_ty, BestState, WorstState >::operator^= ( const IntegerStateBase< base_t, BestState, WorstState > & R )

inline

"Clamp" this state with R.

The result is subtype dependent but it is intended that only information assumed in both states will be assumed in this one afterwards.

Definition at line 2696 of file Attributor.h.

◆ operator|=()

template<typename base_ty, base_ty BestState, base_ty WorstState>

void llvm::IntegerStateBase< base_ty, BestState, WorstState >::operator|= ( const IntegerStateBase< base_t, BestState, WorstState > & R )

inline

Definition at line 2707 of file Attributor.h.

Member Data Documentation

◆ Assumed

template<typename base_ty, base_ty BestState, base_ty WorstState>

base_t llvm::IntegerStateBase< base_ty, BestState, WorstState >::Assumed = getBestState()

protected

The assumed state encoding in an integer of type base_t.

Definition at line 2732 of file Attributor.h.

Referenced by llvm::IncIntegerState< uint64_t, Value::MaximumAlignment, 1 >::IncIntegerState(), llvm::IncIntegerState< uint64_t, Value::MaximumAlignment, 1 >::takeAssumedMinimum(), and llvm::IncIntegerState< uint64_t, Value::MaximumAlignment, 1 >::takeKnownMaximum().

◆ Known

template<typename base_ty, base_ty BestState, base_ty WorstState>

base_t llvm::IntegerStateBase< base_ty, BestState, WorstState >::Known = getWorstState()

protected

The known state encoding in an integer of type base_t.

Definition at line 2729 of file Attributor.h.

Referenced by llvm::IncIntegerState< uint64_t, Value::MaximumAlignment, 1 >::takeAssumedMinimum(), and llvm::IncIntegerState< uint64_t, Value::MaximumAlignment, 1 >::takeKnownMaximum().

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

include/llvm/Transforms/IPO/Attributor.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ base_t

Constructor & Destructor Documentation

◆ IntegerStateBase() [1/2]

◆ IntegerStateBase() [2/2]

Member Function Documentation

◆ getAssumed()

◆ getBestState() [1/2]

◆ getBestState() [2/2]

◆ getKnown()

◆ getWorstState() [1/2]

◆ getWorstState() [2/2]

◆ handleNewAssumedValue()

◆ handleNewKnownValue()

◆ indicateOptimisticFixpoint()

◆ indicatePessimisticFixpoint()

◆ isAtFixpoint()

◆ isValidState()

◆ joinAND()

◆ joinOR()

◆ operator!=()

◆ operator&=()

◆ operator+=()

◆ operator==()

◆ operator^=()

◆ operator|=()

Member Data Documentation

◆ Assumed

◆ Known