LLVM  10.0.0svn
Public Types | Public Member Functions | Static Public Attributes | List of all members
llvm::AAReturnedValues Struct Referenceabstract


Abstract Attribute Classes

More...

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

Inheritance diagram for llvm::AAReturnedValues:
Inheritance graph
[legend]
Collaboration diagram for llvm::AAReturnedValues:
Collaboration graph
[legend]

Public Types

using iterator = DenseMap< Value *, SmallPtrSet< ReturnInst *, 2 > >::iterator
 
using const_iterator = DenseMap< Value *, SmallPtrSet< ReturnInst *, 2 > >::const_iterator
 
- Public Types inherited from llvm::IRPosition
enum  Kind : int {
  IRP_INVALID = -6, IRP_FLOAT = -5, IRP_RETURNED = -4, IRP_CALL_SITE_RETURNED = -3,
  IRP_FUNCTION = -2, IRP_CALL_SITE = -1, IRP_ARGUMENT = 0, IRP_CALL_SITE_ARGUMENT = 1
}
 The positions we distinguish in the IR. More...
 
- Public Types inherited from llvm::AbstractAttribute
using StateType = AbstractState
 

Public Member Functions

 AAReturnedValues (const IRPosition &IRP)
 
Optional< Value * > getAssumedUniqueReturnValue (Attributor &A) const
 Return an assumed unique return value if a single candidate is found. More...
 
virtual bool checkForAllReturnedValuesAndReturnInsts (const function_ref< bool(Value &, const SmallPtrSetImpl< ReturnInst *> &)> &Pred) const =0
 Check Pred on all returned values. More...
 
virtual llvm::iterator_range< iteratorreturned_values ()=0
 
virtual llvm::iterator_range< const_iteratorreturned_values () const =0
 
virtual size_t getNumReturnValues () const =0
 
virtual const SmallPtrSetImpl< CallBase * > & getUnresolvedCalls () const =0
 
- Public Member Functions inherited from llvm::IRAttribute< Attribute::Returned, AbstractAttribute >
 IRAttribute (const IRPosition &IRP)
 
 ~IRAttribute ()
 
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...
 
IRPositiongetIRPosition () override
 Return an IR position, see struct IRPosition. More...
 
const IRPositiongetIRPosition () const override
 
- Public Member Functions inherited from llvm::IRPosition
virtual ~IRPosition ()
 
 IRPosition ()
 Default constructor available to create invalid positions implicitly. More...
 
bool operator== (const IRPosition &RHS) const
 
bool operator!= (const IRPosition &RHS) const
 
ValuegetAnchorValue ()
 Return the value this abstract attribute is anchored with. More...
 
const ValuegetAnchorValue () const
 
FunctiongetAssociatedFunction ()
 } More...
 
const FunctiongetAssociatedFunction () const
 
FunctiongetAnchorScope ()
 } More...
 
const FunctiongetAnchorScope () const
 
InstructiongetCtxI ()
 } More...
 
const InstructiongetCtxI () const
 
ValuegetAssociatedValue ()
 } More...
 
const ValuegetAssociatedValue () const
 
int getArgNo () const
 } 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) 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) const
 Return the attributes of any kind in AKs existing in the IR at a position that will affect this one. More...
 
Attribute getAttr (Attribute::AttrKind AK) const
 Return the attribute of kind AK existing in the IR at this position. More...
 
bool isAnyCallSitePosition () const
 
- Public Member Functions inherited from llvm::AbstractAttribute
virtual ~AbstractAttribute ()
 Virtual destructor. More...
 
virtual void initialize (Attributor &A)
 Initialize the state with the information in the Attributor A. More...
 
virtual StateTypegetState ()=0
 Return the internal abstract state for inspection. More...
 
virtual const StateTypegetState () const =0
 
virtual void print (raw_ostream &OS) const
 Helper functions, for debug purposes only. More...
 
void dump () const
 
virtual const std::string getAsStr () const =0
 This function should return the "summarized" assumed state as string. More...
 

Static Public Attributes

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
 

Additional Inherited Members

- Static Public Member Functions inherited from llvm::IRPosition
static const IRPosition value (const Value &V)
 Create a position describing the value of V. More...
 
static const IRPosition function (const Function &F)
 Create a position describing the function scope of F. More...
 
static const IRPosition returned (const Function &F)
 Create a position describing the returned value of F. More...
 
static const IRPosition argument (const Argument &Arg)
 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_function (ImmutableCallSite ICS)
 Create a position describing the function scope of ICS. More...
 
static const IRPosition callsite_returned (ImmutableCallSite ICS)
 Create a position describing the returned value of ICS. More...
 
static const IRPosition callsite_argument (ImmutableCallSite ICS, unsigned ArgNo)
 Create a position describing the argument of ICS at position ArgNo. More...
 
static const IRPosition function_scope (const IRPosition &IRP)
 Create a position with function scope matching the "context" of IRP. More...
 
- 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...
 
virtual ChangeStatus updateImpl (Attributor &A)=0
 The actual update/transfer function which has to be implemented by the derived classes. More...
 

Detailed Description


Abstract Attribute Classes

An abstract attribute for the returned values of a function.

Definition at line 1115 of file Attributor.h.

Member Typedef Documentation

◆ const_iterator

Definition at line 1138 of file Attributor.h.

◆ iterator

Definition at line 1136 of file Attributor.h.

Constructor & Destructor Documentation

◆ AAReturnedValues()

llvm::AAReturnedValues::AAReturnedValues ( const IRPosition IRP)
inline

Definition at line 1117 of file Attributor.h.

Member Function Documentation

◆ checkForAllReturnedValuesAndReturnInsts()

virtual bool llvm::AAReturnedValues::checkForAllReturnedValuesAndReturnInsts ( const function_ref< bool(Value &, const SmallPtrSetImpl< ReturnInst *> &)> &  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.

Implemented in AAReturnedValuesImpl.

◆ getAssumedUniqueReturnValue()

Optional<Value *> llvm::AAReturnedValues::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.

◆ getNumReturnValues()

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

Implemented in AAReturnedValuesImpl.

◆ getUnresolvedCalls()

virtual const SmallPtrSetImpl<CallBase *>& llvm::AAReturnedValues::getUnresolvedCalls ( ) const
pure virtual

Implemented in AAReturnedValuesImpl.

◆ returned_values() [1/2]

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

Implemented in AAReturnedValuesImpl.

◆ returned_values() [2/2]

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

Implemented in AAReturnedValuesImpl.

Member Data Documentation

◆ ID

const char AAReturnedValues::ID = 0
static

Unique ID (due to the unique address)

Definition at line 1146 of file Attributor.h.

Referenced by llvm::createAttributorLegacyPass().


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