LLVM 18.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
llvm::AAInterFnReachability Struct Referenceabstract

An abstract Attribute for computing reachability between functions. More...

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

Inheritance diagram for llvm::AAInterFnReachability:
Inheritance graph
[legend]

Public Types

using Base = StateWrapper< BooleanState, AbstractAttribute >
 
- 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
 

Public Member Functions

 AAInterFnReachability (const IRPosition &IRP, Attributor &A)
 
bool canReach (Attributor &A, const Function &Fn) const
 If the function represented by this possition can reach Fn.
 
virtual bool instructionCanReach (Attributor &A, const Instruction &Inst, const Function &Fn, const AA::InstExclusionSetTy *ExclusionSet=nullptr) const =0
 Can Inst reach Fn.
 
const std::string getName () const override
 See AbstractAttribute::getName()
 
const chargetIdAddr () const override
 See AbstractAttribute::getIdAddr()
 
- Public Member Functions inherited from llvm::StateWrapper< BooleanState, AbstractAttribute >
 StateWrapper (const IRPosition &IRP, Ts... Args)
 
StateTypegetState () override
 See AbstractAttribute::getState(...).
 
const StateTypegetState () 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 StateTypegetState ()=0
 Return the internal abstract state for inspection.
 
virtual const StateTypegetState () const =0
 
const IRPositiongetIRPosition () const
 Return an IR position, see struct IRPosition.
 
IRPositiongetIRPosition ()
 
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 chargetIdAddr () 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
 
ValuegetAnchorValue () const
 Return the value this abstract attribute is anchored with.
 
FunctiongetAssociatedFunction () const
 Return the associated function, if any.
 
ArgumentgetAssociatedArgument () 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.
 
FunctiongetAnchorScope () const
 Return the Function surrounding the anchor value.
 
InstructiongetCtxI () const
 Return the context instruction, if any.
 
ValuegetAssociatedValue () const
 Return the value this abstract attribute is associated with.
 
TypegetAssociatedType () 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.
 
ValuegetAttrListAnchor () 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.
 
ValuegetArg (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 CallBaseContextgetCallBaseContext () 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
 
DepSetTygetDeps ()
 
- 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 AAInterFnReachabilitycreateForPosition (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 AACallEdges.
 
- 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::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

- 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 AADepGraphNodeDepGetVal (const DepTy &DT)
 
static AbstractAttributeDepGetValAA (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 Attribute for computing reachability between functions.

Definition at line 5682 of file Attributor.h.

Member Typedef Documentation

◆ Base

Definition at line 5684 of file Attributor.h.

Constructor & Destructor Documentation

◆ AAInterFnReachability()

llvm::AAInterFnReachability::AAInterFnReachability ( const IRPosition IRP,
Attributor A 
)
inline

Definition at line 5686 of file Attributor.h.

Member Function Documentation

◆ canReach()

bool llvm::AAInterFnReachability::canReach ( Attributor A,
const Function Fn 
) const
inline

If the function represented by this possition can reach Fn.

Definition at line 5689 of file Attributor.h.

References A, llvm::IRPosition::getAnchorScope(), and instructionCanReach().

◆ classof()

static bool llvm::AAInterFnReachability::classof ( const AbstractAttribute AA)
inlinestatic

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

Definition at line 5713 of file Attributor.h.

References llvm::AbstractAttribute::getIdAddr().

◆ createForPosition()

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

Create an abstract attribute view for the position IRP.

◆ getIdAddr()

const char * llvm::AAInterFnReachability::getIdAddr ( ) const
inlineoverridevirtual

See AbstractAttribute::getIdAddr()

Implements llvm::AbstractAttribute.

Definition at line 5710 of file Attributor.h.

References ID.

◆ getName()

const std::string llvm::AAInterFnReachability::getName ( ) const
inlineoverridevirtual

See AbstractAttribute::getName()

Implements llvm::AbstractAttribute.

Definition at line 5707 of file Attributor.h.

◆ instructionCanReach()

virtual bool llvm::AAInterFnReachability::instructionCanReach ( Attributor A,
const Instruction Inst,
const Function Fn,
const AA::InstExclusionSetTy ExclusionSet = nullptr 
) const
pure virtual

Can Inst reach Fn.

See also AA::isPotentiallyReachable.

Referenced by canReach().

Member Data Documentation

◆ ID

const char AAInterFnReachability::ID = 0
static

Unique ID (due to the unique address)

Definition at line 5718 of file Attributor.h.

Referenced by getIdAddr(), and runAttributorLightOnFunctions().


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