LLVM  14.0.0git
Public Member Functions | List of all members
AAReturnedValuesImpl Class Reference

------------------— Function Return Values ----------------------------— More...

Inheritance diagram for AAReturnedValuesImpl:
Inheritance graph
[legend]
Collaboration diagram for AAReturnedValuesImpl:
Collaboration graph
[legend]

Public Member Functions

 AAReturnedValuesImpl (const IRPosition &IRP, Attributor &A)
 } More...
 
void initialize (Attributor &A) override
 See AbstractAttribute::initialize(...). More...
 
ChangeStatus manifest (Attributor &A) override
 See AbstractAttribute::manifest(...). More...
 
AbstractStategetState () override
 See AbstractAttribute::getState(...). More...
 
const AbstractStategetState () const override
 See AbstractAttribute::getState(...). More...
 
ChangeStatus updateImpl (Attributor &A) override
 See AbstractAttribute::updateImpl(Attributor &A). More...
 
llvm::iterator_range< iteratorreturned_values () override
 
llvm::iterator_range< const_iteratorreturned_values () const override
 
size_t getNumReturnValues () const override
 Return the number of potential return values, -1 if unknown. More...
 
Optional< Value * > getAssumedUniqueReturnValue (Attributor &A) const
 Return an assumed unique return value if a single candidate is found. More...
 
bool checkForAllReturnedValuesAndReturnInsts (function_ref< bool(Value &, const SmallSetVector< ReturnInst *, 4 > &)> Pred) const override
 See AbstractState::checkForAllReturnedValues(...). More...
 
const std::string getAsStr () const override
 Pretty print the attribute similar to the IR representation. More...
 
bool isAtFixpoint () const override
 See AbstractState::isAtFixpoint(). More...
 
bool isValidState () const override
 See AbstractState::isValidState(). More...
 
ChangeStatus indicateOptimisticFixpoint () override
 See AbstractState::indicateOptimisticFixpoint(...). More...
 
ChangeStatus indicatePessimisticFixpoint () override
 Indicate that the abstract state should converge to the pessimistic state. More...
 
- Public Member Functions inherited from llvm::AAReturnedValues
 AAReturnedValues (const IRPosition &IRP, Attributor &A)
 
Optional< Value * > getAssumedUniqueReturnValue (Attributor &A) const
 Return an assumed unique return value if a single candidate is found. More...
 
const std::string getName () const override
 See AbstractAttribute::getName() More...
 
const char * getIdAddr () const override
 See AbstractAttribute::getIdAddr() More...
 
- Public Member Functions inherited from llvm::IRAttribute< Attribute::Returned, AbstractAttribute >
 IRAttribute (const IRPosition &IRP)
 
ChangeStatus manifest (Attributor &A) override
 See AbstractAttribute::manifest(...). More...
 
Attribute::AttrKind getAttrKind () const
 Return the kind that identifies the abstract attribute implementation. More...
 
virtual void getDeducedAttributes (LLVMContext &Ctx, SmallVectorImpl< Attribute > &Attrs) const
 Return the deduced attributes in Attrs. More...
 
- Public Member Functions inherited from llvm::AbstractAttribute
 AbstractAttribute (const IRPosition &IRP)
 
virtual ~AbstractAttribute ()
 Virtual destructor. More...
 
const IRPositiongetIRPosition () const
 Return an IR position, see struct IRPosition. More...
 
IRPositiongetIRPosition ()
 
void print (raw_ostream &OS) const override
 Helper functions, for debug purposes only. More...
 
virtual void printWithDeps (raw_ostream &OS) const
 
void dump () const
 
- Public Member Functions inherited from llvm::IRPosition
 IRPosition ()
 Default constructor available to create invalid positions implicitly. More...
 
bool operator== (const IRPosition &RHS) const
 
bool operator!= (const IRPosition &RHS) const
 
ValuegetAnchorValue () const
 Return the value this abstract attribute is anchored with. More...
 
FunctiongetAssociatedFunction () const
 Return the associated function, if any. More...
 
ArgumentgetAssociatedArgument () const
 Return the associated argument, if any. More...
 
bool isFnInterfaceKind () const
 Return true if the position refers to a function interface, that is the function scope, the function return, or an argument. More...
 
FunctiongetAnchorScope () const
 Return the Function surrounding the anchor value. More...
 
InstructiongetCtxI () const
 Return the context instruction, if any. More...
 
ValuegetAssociatedValue () const
 Return the value this abstract attribute is associated with. More...
 
TypegetAssociatedType () const
 Return the type this abstract attribute is associated with. More...
 
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. More...
 
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. More...
 
unsigned getAttrIdx () const
 Return the index in the attribute list for this position. More...
 
Kind getPositionKind () const
 Return the associated position kind. More...
 
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. More...
 
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. More...
 
void removeAttrs (ArrayRef< Attribute::AttrKind > AKs) const
 Remove the attribute of kind AKs existing in the IR at this position. More...
 
bool isAnyCallSitePosition () const
 
bool isArgumentPosition () const
 Return true if the position is an argument or call site argument. More...
 
IRPosition stripCallBaseContext () const
 Return the same position without the call base context. More...
 
const CallBaseContextgetCallBaseContext () const
 Get the call base context from the position. More...
 
bool hasCallBaseContext () const
 Check if the position has any call base context. More...
 
 operator void * () const
 } More...
 
- Public Member Functions inherited from llvm::AADepGraphNode
virtual ~AADepGraphNode ()
 
aaiterator begin ()
 
aaiterator end ()
 
iterator child_begin ()
 
iterator child_end ()
 
TinyPtrVector< DepTy > & getDeps ()
 
- Public Member Functions inherited from llvm::AbstractState
virtual ~AbstractState ()
 

Additional Inherited Members

- Public Types inherited from llvm::AAReturnedValues
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 iterator = mapped_iterator< TinyPtrVector< DepTy >::iterator, decltype(&DepGetVal)>
 
using aaiterator = mapped_iterator< TinyPtrVector< DepTy >::iterator, decltype(&DepGetValAA)>
 
- Static Public Member Functions inherited from llvm::AAReturnedValues
static AAReturnedValuescreateForPosition (const IRPosition &IRP, Attributor &A)
 Create an abstract attribute view for the position IRP. More...
 
static bool classof (const AbstractAttribute *AA)
 This function should return true if the type of the AA is AAReturnedValues. More...
 
- 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. More...
 
- 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. More...
 
static const IRPosition function (const Function &F, const CallBaseContext *CBContext=nullptr)
 Create a position describing the function scope of F. More...
 
static const IRPosition returned (const Function &F, const CallBaseContext *CBContext=nullptr)
 Create a position describing the returned value of F. More...
 
static const IRPosition argument (const Argument &Arg, const CallBaseContext *CBContext=nullptr)
 Create a position describing the argument Arg. More...
 
static const IRPosition callsite_function (const CallBase &CB)
 Create a position describing the function scope of CB. More...
 
static const IRPosition callsite_returned (const CallBase &CB)
 Create a position describing the returned value of CB. More...
 
static const IRPosition callsite_argument (const CallBase &CB, unsigned ArgNo)
 Create a position describing the argument of CB at position ArgNo. More...
 
static const IRPosition callsite_argument (AbstractCallSite ACS, unsigned ArgNo)
 Create a position describing the argument of ACS at position ArgNo. More...
 
static const IRPosition function_scope (const IRPosition &IRP, const CallBaseContext *CBContext=nullptr)
 Create a position with function scope matching the "context" of IRP. More...
 
- Static Public Attributes inherited from llvm::AAReturnedValues
static const char ID = 0
 Unique ID (due to the unique address) More...
 
- Static Public Attributes inherited from llvm::IRPosition
static const IRPosition EmptyKey
 Special DenseMap key values. More...
 
static const IRPosition TombstoneKey
 
- Protected Member Functions inherited from llvm::AbstractAttribute
ChangeStatus update (Attributor &A)
 Hook for the Attributor to trigger an update of the internal state. More...
 
virtual void trackStatistics () const =0
 Hook to enable custom statistic tracking, called after manifest that resulted in a change if statistics are enabled. More...
 
- Protected Member Functions inherited from llvm::AADepGraphNode
 operator AbstractAttribute * ()
 
- Static Protected Member Functions inherited from llvm::AADepGraphNode
static AADepGraphNodeDepGetVal (DepTy &DT)
 
static AbstractAttributeDepGetValAA (DepTy &DT)
 
- Protected Attributes inherited from llvm::AADepGraphNode
TinyPtrVector< DepTyDeps
 Set of dependency graph nodes which should be updated if this one is updated. More...
 

Detailed Description

------------------— Function Return Values ----------------------------—

"Attribute" that collects all potential returned values and the return instructions that they arise from.

If there is a unique returned value R, the manifest method will:

Definition at line 1511 of file AttributorAttributes.cpp.

Constructor & Destructor Documentation

◆ AAReturnedValuesImpl()

AAReturnedValuesImpl::AAReturnedValuesImpl ( const IRPosition IRP,
Attributor A 
)
inline

}

Definition at line 1525 of file AttributorAttributes.cpp.

Member Function Documentation

◆ checkForAllReturnedValuesAndReturnInsts()

bool AAReturnedValuesImpl::checkForAllReturnedValuesAndReturnInsts ( function_ref< bool(Value &, const SmallSetVector< ReturnInst *, 4 > &)>  Pred) const
overridevirtual

See AbstractState::checkForAllReturnedValues(...).

Implements llvm::AAReturnedValues.

Definition at line 1674 of file AttributorAttributes.cpp.

◆ getAsStr()

const std::string AAReturnedValuesImpl::getAsStr ( ) const
overridevirtual

Pretty print the attribute similar to the IR representation.

Implements llvm::AbstractAttribute.

Definition at line 1648 of file AttributorAttributes.cpp.

References llvm::to_string().

◆ getAssumedUniqueReturnValue()

Optional< Value * > AAReturnedValuesImpl::getAssumedUniqueReturnValue ( Attributor A) const

Return an assumed unique return value if a single candidate is found.

If there cannot be one, return a nullptr. If it is not clear yet, return the Optional::NoneType.

Definition at line 1654 of file AttributorAttributes.cpp.

References llvm::AA::combineOptionalValuesInAAValueLatice().

◆ getNumReturnValues()

size_t AAReturnedValuesImpl::getNumReturnValues ( ) const
inlineoverridevirtual

Return the number of potential return values, -1 if unknown.

Implements llvm::AAReturnedValues.

Definition at line 1584 of file AttributorAttributes.cpp.

References llvm::MapVector< KeyT, ValueT, MapType, VectorType >::size().

◆ getState() [1/2]

const AbstractState& AAReturnedValuesImpl::getState ( ) const
inlineoverridevirtual

See AbstractAttribute::getState(...).

Implements llvm::AbstractAttribute.

Definition at line 1570 of file AttributorAttributes.cpp.

◆ getState() [2/2]

AbstractState& AAReturnedValuesImpl::getState ( )
inlineoverridevirtual

See AbstractAttribute::getState(...).

Implements llvm::AbstractAttribute.

Definition at line 1567 of file AttributorAttributes.cpp.

◆ indicateOptimisticFixpoint()

ChangeStatus AAReturnedValuesImpl::indicateOptimisticFixpoint ( )
inlineoverridevirtual

See AbstractState::indicateOptimisticFixpoint(...).

Implements llvm::AbstractState.

Definition at line 1608 of file AttributorAttributes.cpp.

References llvm::UNCHANGED.

◆ indicatePessimisticFixpoint()

ChangeStatus AAReturnedValuesImpl::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 1613 of file AttributorAttributes.cpp.

References llvm::CHANGED.

◆ initialize()

void AAReturnedValuesImpl::initialize ( Attributor A)
inlineoverridevirtual

◆ isAtFixpoint()

bool AAReturnedValuesImpl::isAtFixpoint ( ) const
inlineoverridevirtual

See AbstractState::isAtFixpoint().

Implements llvm::AbstractState.

Definition at line 1602 of file AttributorAttributes.cpp.

◆ isValidState()

bool AAReturnedValuesImpl::isValidState ( ) const
inlineoverridevirtual

See AbstractState::isValidState().

Implements llvm::AbstractState.

Definition at line 1605 of file AttributorAttributes.cpp.

◆ manifest()

ChangeStatus AAReturnedValuesImpl::manifest ( Attributor A)
overridevirtual

◆ returned_values() [1/2]

llvm::iterator_range<const_iterator> AAReturnedValuesImpl::returned_values ( ) const
inlineoverridevirtual

◆ returned_values() [2/2]

llvm::iterator_range<iterator> AAReturnedValuesImpl::returned_values ( )
inlineoverridevirtual

◆ updateImpl()

ChangeStatus AAReturnedValuesImpl::updateImpl ( Attributor A)
overridevirtual

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