An abstract attribute for the returned values of a function. More...

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

Inheritance diagram for llvm::AAReturnedValues:

[legend]

Public Types
using	iterator = MapVector< Value , SmallSetVector< ReturnInst , 4 > >::iterator

using	const_iterator = MapVector< Value , SmallSetVector< ReturnInst , 4 > >::const_iterator

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 Member Functions
	AAReturnedValues (const IRPosition &IRP, Attributor &A)

virtual bool	checkForAllReturnedValuesAndReturnInsts (function_ref< bool(Value &, const SmallSetVector< ReturnInst *, 4 > &)> Pred) const =0
	Check `Pred` on all returned values.

virtual llvm::iterator_range< iterator >	returned_values ()=0

virtual llvm::iterator_range< const_iterator >	returned_values () const =0

virtual size_t	getNumReturnValues () const =0

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::Returned, AbstractAttribute >
	IRAttribute (const IRPosition &IRP)

void	initialize (Attributor &A) override
	See AbstractAttribute::initialize(...).

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

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

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

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 override
	Helper functions, for debug purposes only.

virtual void	printWithDeps (raw_ostream &OS) const

void	dump () const

virtual const std::string	getAsStr () 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.

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.

Kind	getPositionKind () const
	Return the associated position kind.

bool	hasAttr (ArrayRef< Attribute::AttrKind > AKs, bool IgnoreSubsumingPositions=false, Attributor *A=nullptr) const
	TODO: Figure out if the attribute related helper functions should live here or somewhere else.

void	getAttrs (ArrayRef< Attribute::AttrKind > AKs, SmallVectorImpl< Attribute > &Attrs, bool IgnoreSubsumingPositions=false, Attributor *A=nullptr) const
	Return the attributes of any kind in `AKs` existing in the IR at a position that will affect this one.

void	removeAttrs (ArrayRef< Attribute::AttrKind > AKs) const
	Remove the attribute of kind `AKs` existing in the IR at this position.

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 ()

virtual void	print (raw_ostream &OS) const

DepSetTy &	getDeps ()

Static Public Member Functions
static AAReturnedValues &	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 AAReturnedValues.

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 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 Attributes
static const char	ID = 0
	Unique ID (due to the unique address)

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

static const IRPosition	TombstoneKey

Additional Inherited Members
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 * ()

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.

Detailed Description

An abstract attribute for the returned values of a function.

Abstract Attribute Classes

Definition at line 3289 of file Attributor.h.

Member Typedef Documentation

◆ const_iterator

using llvm::AAReturnedValues::const_iterator = MapVector<Value *, SmallSetVector<ReturnInst *, 4> >::const_iterator

Definition at line 3307 of file Attributor.h.

◆ iterator

using llvm::AAReturnedValues::iterator = MapVector<Value *, SmallSetVector<ReturnInst *, 4> >::iterator

Definition at line 3305 of file Attributor.h.

Constructor & Destructor Documentation

◆ AAReturnedValues()

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

inline

Definition at line 3291 of file Attributor.h.

Member Function Documentation

◆ checkForAllReturnedValuesAndReturnInsts()

virtual bool llvm::AAReturnedValues::checkForAllReturnedValuesAndReturnInsts ( function_ref< bool(Value &, const SmallSetVector< ReturnInst *, 4 > &)> Pred ) const

pure virtual

Check Pred on all returned values.

This method will evaluate Pred on returned values and return true if (1) all returned values are known, and (2) Pred returned true for all returned values.

Note: Unlike the Attributor::checkForAllReturnedValuesAndReturnInsts method, this one will not filter dead return instructions.

◆ classof()

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

inlinestatic

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

Definition at line 3326 of file Attributor.h.

References llvm::AbstractAttribute::getIdAddr().

◆ createForPosition()

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

static

Create an abstract attribute view for the position IRP.

◆ getIdAddr()

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

inlineoverridevirtual

See AbstractAttribute::getIdAddr()

Implements llvm::AbstractAttribute.

Definition at line 3322 of file Attributor.h.

References ID.

◆ getName()

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

inlineoverridevirtual

See AbstractAttribute::getName()

Implements llvm::AbstractAttribute.

Definition at line 3319 of file Attributor.h.

◆ getNumReturnValues()

virtual size_t llvm::AAReturnedValues::getNumReturnValues ( ) const

pure virtual

◆ returned_values() [1/2]

virtual llvm::iterator_range< const_iterator > llvm::AAReturnedValues::returned_values ( ) const

pure virtual

◆ returned_values() [2/2]

virtual llvm::iterator_range< iterator > llvm::AAReturnedValues::returned_values ( )

pure virtual

Member Data Documentation

◆ ID

const char AAReturnedValues::ID = 0

static

Unique ID (due to the unique address)

Definition at line 3331 of file Attributor.h.

Referenced by getIdAddr().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Abstract Attribute Classes

Member Typedef Documentation

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ AAReturnedValues()

Member Function Documentation

◆ checkForAllReturnedValuesAndReturnInsts()

◆ classof()

◆ createForPosition()

◆ getIdAddr()

◆ getName()

◆ getNumReturnValues()

◆ returned_values() [1/2]

◆ returned_values() [2/2]

Member Data Documentation

◆ ID