An abstract interface for all nonnull attributes. More...

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

Inheritance diagram for llvm::AANonNull:

[legend]

Public Member Functions
	AANonNull (const IRPosition &IRP, Attributor &A)

bool	isAssumedNonNull () const
	Return true if we assume that the underlying value is nonnull.

bool	isKnownNonNull () const
	Return true if we know that underlying value is nonnull.

const std::string	getName () const override
	See AbstractAttribute::getName()

const char *	getIdAddr () const override
	See AbstractAttribute::getIdAddr()

Public Member Functions inherited from llvm::IRAttribute< Attribute::NonNull, StateWrapper< BooleanState, AbstractAttribute >, AANonNull >
	IRAttribute (const IRPosition &IRP)

ChangeStatus	manifest (Attributor &A) override
	See AbstractAttribute::manifest(...).

Attribute::AttrKind	getAttrKind () const
	Return the kind that identifies the abstract attribute implementation.

virtual void	getDeducedAttributes (Attributor &A, LLVMContext &Ctx, SmallVectorImpl< Attribute > &Attrs) const
	Return the deduced attributes in `Attrs`.

Public Member Functions inherited from llvm::StateWrapper< BooleanState, AbstractAttribute >
	StateWrapper (const IRPosition &IRP, Ts... Args)

StateType &	getState () override
	See AbstractAttribute::getState(...).

const StateType &	getState () const override
	See AbstractAttribute::getState(...).

Public Member Functions inherited from llvm::AbstractAttribute
	AbstractAttribute (const IRPosition &IRP)

virtual	~AbstractAttribute ()=default
	Virtual destructor.

virtual void	initialize (Attributor &A)
	Initialize the state with the information in the Attributor `A`.

virtual bool	isQueryAA () const
	A query AA is always scheduled as long as we do updates because it does lazy computation that cannot be determined to be done from the outside.

virtual StateType &	getState ()=0
	Return the internal abstract state for inspection.

virtual const StateType &	getState () const =0

const IRPosition &	getIRPosition () const
	Return an IR position, see struct IRPosition.

IRPosition &	getIRPosition ()

void	print (raw_ostream &OS) const
	Helper functions, for debug purposes only.

void	print (Attributor *, raw_ostream &OS) const override

virtual void	printWithDeps (raw_ostream &OS) const

void	dump () const

virtual const std::string	getAsStr (Attributor *A) const =0
	This function should return the "summarized" assumed state as string.

virtual const std::string	getName () const =0
	This function should return the name of the AbstractAttribute.

virtual const char *	getIdAddr () const =0
	This function should return the address of the ID of the AbstractAttribute.

Public Member Functions inherited from llvm::IRPosition
	IRPosition ()
	Default constructor available to create invalid positions implicitly.

bool	operator== (const IRPosition &RHS) const

bool	operator!= (const IRPosition &RHS) const

Value &	getAnchorValue () const
	Return the value this abstract attribute is anchored with.

Function *	getAssociatedFunction () const
	Return the associated function, if any.

Argument *	getAssociatedArgument () const
	Return the associated argument, if any.

bool	isFnInterfaceKind () const
	Return true if the position refers to a function interface, that is the function scope, the function return, or an argument.

bool	isFunctionScope () const
	Return true if this is a function or call site position.

Function *	getAnchorScope () const
	Return the Function surrounding the anchor value.

Instruction *	getCtxI () const
	Return the context instruction, if any.

Value &	getAssociatedValue () const
	Return the value this abstract attribute is associated with.

Type *	getAssociatedType () const
	Return the type this abstract attribute is associated with.

int	getCalleeArgNo () const
	Return the callee argument number of the associated value if it is an argument or call site argument, otherwise a negative value.

int	getCallSiteArgNo () const
	Return the call site argument number of the associated value if it is an argument or call site argument, otherwise a negative value.

unsigned	getAttrIdx () const
	Return the index in the attribute list for this position.

Value *	getAttrListAnchor () const
	Return the value attributes are attached to.

AttributeList	getAttrList () const
	Return the attributes associated with this function or call site scope.

void	setAttrList (const AttributeList &AttrList) const
	Update the attributes associated with this function or call site scope.

unsigned	getNumArgs () const
	Return the number of arguments associated with this function or call site scope.

Value *	getArg (unsigned ArgNo) const
	Return theargument `ArgNo` associated with this function or call site scope.

Kind	getPositionKind () const
	Return the associated position kind.

bool	isAnyCallSitePosition () const

bool	isArgumentPosition () const
	Return true if the position is an argument or call site argument.

IRPosition	stripCallBaseContext () const
	Return the same position without the call base context.

const CallBaseContext *	getCallBaseContext () const
	Get the call base context from the position.

bool	hasCallBaseContext () const
	Check if the position has any call base context.

	operator void * () const
	}

Public Member Functions inherited from llvm::AADepGraphNode
virtual	~AADepGraphNode ()=default

aaiterator	begin ()

aaiterator	end ()

iterator	child_begin ()

iterator	child_end ()

void	print (raw_ostream &OS) const

virtual void	print (Attributor *, raw_ostream &OS) const

DepSetTy &	getDeps ()

Public Member Functions inherited from llvm::BooleanState
	BooleanState ()=default

	BooleanState (base_t Assumed)

void	setAssumed (bool Value)
	Set the assumed value to `Value` but never below the known one.

void	setKnown (bool Value)
	Set the known and asssumed value to `Value`.

bool	isAssumed () const
	Return true if the state is assumed to hold.

bool	isKnown () const
	Return true if the state is known to hold.

Public Member Functions inherited from llvm::IntegerStateBase< bool, true, false >
	IntegerStateBase ()=default

	IntegerStateBase (base_t Assumed)

bool	isValidState () const override
	See AbstractState::isValidState() NOTE: For now we simply pretend that the worst possible state is invalid.

bool	isAtFixpoint () const override
	See AbstractState::isAtFixpoint()

ChangeStatus	indicateOptimisticFixpoint () override
	See AbstractState::indicateOptimisticFixpoint(...)

ChangeStatus	indicatePessimisticFixpoint () override
	See AbstractState::indicatePessimisticFixpoint(...)

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

virtual bool	isValidState () const =0
	Return if this abstract state is in a valid state.

virtual bool	isAtFixpoint () const =0
	Return if this abstract state is fixed, thus does not need to be updated if information changes as it cannot change itself.

virtual ChangeStatus	indicateOptimisticFixpoint ()=0
	Indicate that the abstract state should converge to the optimistic state.

virtual ChangeStatus	indicatePessimisticFixpoint ()=0
	Indicate that the abstract state should converge to the pessimistic state.

Static Public Member Functions
static bool	hasTrivialInitializer ()
	See AbstractAttribute::hasTrivialInitializer.

static bool	isImpliedByUndef ()
	See IRAttribute::isImpliedByUndef.

static bool	isValidIRPositionForInit (Attributor &A, const IRPosition &IRP)
	See AbstractAttribute::isValidIRPositionForInit.

static bool	isImpliedByIR (Attributor &A, const IRPosition &IRP, Attribute::AttrKind ImpliedAttributeKind, bool IgnoreSubsumingPositions=false)
	See AbstractAttribute::isImpliedByIR(...).

static AANonNull &	createForPosition (const IRPosition &IRP, Attributor &A)
	Create an abstract attribute view for the position `IRP`.

static bool	classof (const AbstractAttribute *AA)
	This function should return true if the type of the `AA` is AANonNull.

Static Public Member Functions inherited from llvm::IRAttribute< Attribute::NonNull, StateWrapper< BooleanState, AbstractAttribute >, AANonNull >
static bool	hasTrivialInitializer ()
	Most boolean IRAttribute AAs don't do anything non-trivial in their initializers while non-boolean ones often do.

static bool	isImpliedByUndef ()
	Return true if the IR attribute(s) associated with this AA are implied for an undef value.

static bool	isImpliedByPoison ()
	Return true if the IR attribute(s) associated with this AA are implied for an poison value.

static bool	isImpliedByIR (Attributor &A, const IRPosition &IRP, Attribute::AttrKind ImpliedAttributeKind=AK, bool IgnoreSubsumingPositions=false)

Static Public Member Functions inherited from llvm::AbstractAttribute
static bool	classof (const AADepGraphNode *DGN)
	This function is used to identify if an `DGN` is of type AbstractAttribute so that the dyn_cast and cast can use such information to cast an AADepGraphNode to an AbstractAttribute.

static bool	hasTrivialInitializer ()
	Return false if this AA does anything non-trivial (hence not done by default) in its initializer.

static bool	requiresCalleeForCallBase ()
	Return true if this AA requires a "callee" (or an associted function) for a call site positon.

static bool	requiresNonAsmForCallBase ()
	Return true if this AA requires non-asm "callee" for a call site positon.

static bool	requiresCallersForArgOrFunction ()
	Return true if this AA requires all callees for an argument or function positon.

static bool	isValidIRPositionForInit (Attributor &A, const IRPosition &IRP)
	Return false if an AA should not be created for `IRP`.

static bool	isValidIRPositionForUpdate (Attributor &A, const IRPosition &IRP)
	Return false if an AA should not be updated for `IRP`.

Static Public Member Functions inherited from llvm::IRPosition
static const IRPosition	value (const Value &V, const CallBaseContext *CBContext=nullptr)
	Create a position describing the value of `V`.

static const IRPosition	inst (const Instruction &I, const CallBaseContext *CBContext=nullptr)
	Create a position describing the instruction `I`.

static const IRPosition	function (const Function &F, const CallBaseContext *CBContext=nullptr)
	Create a position describing the function scope of `F`.

static const IRPosition	returned (const Function &F, const CallBaseContext *CBContext=nullptr)
	Create a position describing the returned value of `F`.

static const IRPosition	argument (const Argument &Arg, const CallBaseContext *CBContext=nullptr)
	Create a position describing the argument `Arg`.

static const IRPosition	callsite_function (const CallBase &CB)
	Create a position describing the function scope of `CB`.

static const IRPosition	callsite_returned (const CallBase &CB)
	Create a position describing the returned value of `CB`.

static const IRPosition	callsite_argument (const CallBase &CB, unsigned ArgNo)
	Create a position describing the argument of `CB` at position `ArgNo`.

static const IRPosition	callsite_argument (AbstractCallSite ACS, unsigned ArgNo)
	Create a position describing the argument of `ACS` at position `ArgNo`.

static const IRPosition	function_scope (const IRPosition &IRP, const CallBaseContext *CBContext=nullptr)
	Create a position with function scope matching the "context" of `IRP`.

Static Public Member Functions inherited from llvm::IntegerStateBase< bool, true, false >
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 &)

Static Public Attributes
static const char	ID = 0
	Unique ID (due to the unique address)

Static Public Attributes inherited from llvm::IRAttribute< Attribute::NonNull, StateWrapper< BooleanState, AbstractAttribute >, AANonNull >
static constexpr Attribute::AttrKind	IRAttributeKind
	Compile time access to the IR attribute kind.

Static Public Attributes inherited from llvm::AbstractAttribute
static constexpr Attribute::AttrKind	IRAttributeKind = Attribute::None
	Compile time access to the IR attribute kind.

Static Public Attributes inherited from llvm::IRPosition
static const IRPosition	EmptyKey
	Special DenseMap key values.

static const IRPosition	TombstoneKey

Additional Inherited Members
Public Types inherited from llvm::StateWrapper< BooleanState, AbstractAttribute >
using	StateType = BooleanState
	Provide static access to the type of the state.

Public Types inherited from llvm::AbstractAttribute
using	StateType = AbstractState

Public Types inherited from llvm::IRPosition
enum	Kind : char { IRP_INVALID , IRP_FLOAT , IRP_RETURNED , IRP_CALL_SITE_RETURNED , IRP_FUNCTION , IRP_CALL_SITE , IRP_ARGUMENT , IRP_CALL_SITE_ARGUMENT }
	The positions we distinguish in the IR. More...

using	CallBaseContext = CallBase

Public Types inherited from llvm::AADepGraphNode
using	DepTy = PointerIntPair< AADepGraphNode *, 1 >

using	DepSetTy = SmallSetVector< DepTy, 2 >

using	iterator = mapped_iterator< DepSetTy::iterator, decltype(&DepGetVal)>

using	aaiterator = mapped_iterator< DepSetTy::iterator, decltype(&DepGetValAA)>

Public Types inherited from llvm::BooleanState
using	super = IntegerStateBase< bool, true, false >

using	base_t = IntegerStateBase::base_t

Public Types inherited from llvm::IntegerStateBase< bool, true, false >
using	base_t = bool

Protected Member Functions inherited from llvm::AbstractAttribute
ChangeStatus	update (Attributor &A)
	Hook for the Attributor to trigger an update of the internal state.

virtual ChangeStatus	manifest (Attributor &A)
	Hook for the Attributor to trigger the manifestation of the information represented by the abstract attribute in the LLVM-IR.

virtual void	trackStatistics () const =0
	Hook to enable custom statistic tracking, called after manifest that resulted in a change if statistics are enabled.

virtual ChangeStatus	updateImpl (Attributor &A)=0
	The actual update/transfer function which has to be implemented by the derived classes.

Protected Member Functions inherited from llvm::AADepGraphNode
	operator AbstractAttribute * ()

Protected Member Functions inherited from llvm::IntegerStateBase< bool, true, false >
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.

Static Protected Member Functions inherited from llvm::AADepGraphNode
static AADepGraphNode *	DepGetVal (const DepTy &DT)

static AbstractAttribute *	DepGetValAA (const DepTy &DT)

Protected Attributes inherited from llvm::AADepGraphNode
DepSetTy	Deps
	Set of dependency graph nodes which should be updated if this one is updated.

Protected Attributes inherited from llvm::IntegerStateBase< bool, true, false >
base_t	Known
	The known state encoding in an integer of type base_t.

base_t	Assumed
	The assumed state encoding in an integer of type base_t.

Detailed Description

An abstract interface for all nonnull attributes.

Definition at line 3631 of file Attributor.h.

Constructor & Destructor Documentation

◆ AANonNull()

llvm::AANonNull::AANonNull	(	const IRPosition &	IRP,
		Attributor &	A
	)

inline

Definition at line 3635 of file Attributor.h.

Member Function Documentation

◆ classof()

static bool llvm::AANonNull::classof ( const AbstractAttribute * AA )

inlinestatic

This function should return true if the type of the AA is AANonNull.

Definition at line 3673 of file Attributor.h.

References llvm::AbstractAttribute::getIdAddr().

◆ createForPosition()

static AANonNull & llvm::AANonNull::createForPosition	(	const IRPosition &	IRP,
		Attributor &	A
	)

static

Create an abstract attribute view for the position IRP.

◆ getIdAddr()

const char * llvm::AANonNull::getIdAddr ( ) const

inlineoverridevirtual

See AbstractAttribute::getIdAddr()

Implements llvm::AbstractAttribute.

Definition at line 3670 of file Attributor.h.

References ID.

◆ getName()

const std::string llvm::AANonNull::getName ( ) const

inlineoverridevirtual

See AbstractAttribute::getName()

Implements llvm::AbstractAttribute.

Definition at line 3667 of file Attributor.h.

◆ hasTrivialInitializer()

static bool llvm::AANonNull::hasTrivialInitializer ( )

inlinestatic

See AbstractAttribute::hasTrivialInitializer.

Definition at line 3638 of file Attributor.h.

◆ isAssumedNonNull()

bool llvm::AANonNull::isAssumedNonNull ( ) const

inline

Return true if we assume that the underlying value is nonnull.

Definition at line 3658 of file Attributor.h.

References llvm::IntegerStateBase< bool, true, false >::getAssumed().

◆ isImpliedByIR()

bool AANonNull::isImpliedByIR	(	Attributor &	A,
		const IRPosition &	IRP,
		Attribute::AttrKind	ImpliedAttributeKind,
		bool	IgnoreSubsumingPositions = `false`
	)

static

See AbstractAttribute::isImpliedByIR(...).

---------------------— NonNull Argument Attribute ---------------------—

Definition at line 2464 of file AttributorAttributes.cpp.

References A, llvm::InformationCache::getAnalysisResultForFunction(), llvm::IRPosition::getAnchorScope(), llvm::IRPosition::getAssociatedFunction(), llvm::IRPosition::getAssociatedType(), llvm::IRPosition::getAssociatedValue(), llvm::IRPosition::getCtxI(), llvm::Type::getPointerAddressSpace(), llvm::IRPosition::getPositionKind(), I, llvm::NullPointerIsDefined(), and llvm::SmallVectorTemplateBase< T, bool >::push_back().

◆ isImpliedByUndef()

static bool llvm::AANonNull::isImpliedByUndef ( )

inlinestatic

See IRAttribute::isImpliedByUndef.

Undef is not necessarily nonnull as nonnull + noundef would cause poison. Poison implies nonnull though.

Definition at line 3643 of file Attributor.h.

◆ isKnownNonNull()

bool llvm::AANonNull::isKnownNonNull ( ) const

inline

Return true if we know that underlying value is nonnull.

Definition at line 3661 of file Attributor.h.

References llvm::IntegerStateBase< bool, true, false >::getKnown().

◆ isValidIRPositionForInit()

static bool llvm::AANonNull::isValidIRPositionForInit	(	Attributor &	A,
		const IRPosition &	IRP
	)

inlinestatic

See AbstractAttribute::isValidIRPositionForInit.

Definition at line 3646 of file Attributor.h.

References A, llvm::IRPosition::getAssociatedType(), and llvm::Type::isPtrOrPtrVectorTy().

Member Data Documentation

◆ ID

const char AANonNull::ID = 0

static

Unique ID (due to the unique address)

Definition at line 3678 of file Attributor.h.

Referenced by getIdAddr(), and runAttributorLightOnFunctions().

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

include/llvm/Transforms/IPO/Attributor.h
lib/Transforms/IPO/AttributorAttributes.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AANonNull()

Member Function Documentation

◆ classof()

◆ createForPosition()

◆ getIdAddr()

◆ getName()

◆ hasTrivialInitializer()

◆ isAssumedNonNull()

◆ isImpliedByIR()

◆ isImpliedByUndef()

◆ isKnownNonNull()

◆ isValidIRPositionForInit()

Member Data Documentation

◆ ID