An abstract interface to determine reachability of point A to B. More...
#include "llvm/Transforms/IPO/Attributor.h"
Inheritance diagram for llvm::AAReachability:
Collaboration diagram for llvm::AAReachability:
Public Member Functions | |
| AAReachability (const IRPosition &IRP, Attributor &A) | |
| bool | isAssumedReachable (Attributor &A, const Instruction &From, const Instruction &To) const |
| Returns true if 'From' instruction is assumed to reach, 'To' instruction. More... | |
| bool | isKnownReachable (Attributor &A, const Instruction &From, const Instruction &To) const |
| Returns true if 'From' instruction is known to reach, 'To' instruction. 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::StateWrapper< BooleanState, AbstractAttribute > | |
| StateWrapper (const IRPosition &IRP, Ts... Args) | |
| StateType & | getState () override |
| See AbstractAttribute::getState(...). More... | |
| const StateType & | getState () const override |
| See AbstractAttribute::getState(...). More... | |
| Public Member Functions inherited from llvm::AbstractAttribute | |
| AbstractAttribute (const IRPosition &IRP) | |
| virtual | ~AbstractAttribute () |
| Virtual destructor. More... | |
| virtual void | initialize (Attributor &A) |
Initialize the state with the information in the Attributor A. More... | |
| virtual const StateType & | getState () const =0 |
| const IRPosition & | getIRPosition () const |
| Return an IR position, see struct IRPosition. More... | |
| IRPosition & | getIRPosition () |
| void | print (raw_ostream &OS) const override |
| Helper functions, for debug purposes only. More... | |
| 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. More... | |
| 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 |
| Value & | getAnchorValue () const |
| Return the value this abstract attribute is anchored with. More... | |
| Function * | getAssociatedFunction () const |
| Return the associated function, if any. More... | |
| Argument * | getAssociatedArgument () 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... | |
| Function * | getAnchorScope () const |
| Return the Function surrounding the anchor value. More... | |
| Instruction * | getCtxI () const |
| Return the context instruction, if any. More... | |
| Value & | getAssociatedValue () const |
| Return the value this abstract attribute is associated with. More... | |
| Type * | getAssociatedType () 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 CallBaseContext * | getCallBaseContext () 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::BooleanState | |
| BooleanState () | |
| BooleanState (base_t Assumed) | |
| void | setAssumed (bool Value) |
Set the assumed value to Value but never below the known one. More... | |
| void | setKnown (bool Value) |
Set the known and asssumed value to Value. More... | |
| bool | isAssumed () const |
| Return true if the state is assumed to hold. More... | |
| bool | isKnown () const |
| Return true if the state is known to hold. More... | |
| Public Member Functions inherited from llvm::IntegerStateBase< bool, 1, 0 > | |
| IntegerStateBase () | |
| IntegerStateBase (base_t Assumed) | |
| bool | isValidState () const override |
| See AbstractState::isValidState() NOTE: For now we simply pretend that the worst possible state is invalid. More... | |
| bool | isAtFixpoint () const override |
| See AbstractState::isAtFixpoint() More... | |
| ChangeStatus | indicateOptimisticFixpoint () override |
| See AbstractState::indicateOptimisticFixpoint(...) More... | |
| ChangeStatus | indicatePessimisticFixpoint () override |
| See AbstractState::indicatePessimisticFixpoint(...) More... | |
| base_t | getKnown () const |
| Return the known state encoding. More... | |
| base_t | getAssumed () const |
| Return the assumed state encoding. More... | |
| bool | operator== (const IntegerStateBase< base_t, BestState, WorstState > &R) const |
| Equality for IntegerStateBase. More... | |
| bool | operator!= (const IntegerStateBase< base_t, BestState, WorstState > &R) const |
| Inequality for IntegerStateBase. More... | |
| void | operator^= (const IntegerStateBase< base_t, BestState, WorstState > &R) |
"Clamp" this state with R. More... | |
| void | operator+= (const IntegerStateBase< base_t, BestState, WorstState > &R) |
"Clamp" this state with R. More... | |
| 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 () |
| virtual bool | isValidState () const =0 |
| Return if this abstract state is in a valid state. More... | |
| 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. More... | |
Static Public Member Functions | |
| static AAReachability & | createForPosition (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 AAReachability. 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 Member Functions inherited from llvm::IntegerStateBase< bool, 1, 0 > | |
| static constexpr base_t | getBestState () |
| Return the best possible representable state. More... | |
| static constexpr base_t | getBestState (const IntegerStateBase &) |
| static constexpr base_t | getWorstState () |
| Return the worst possible representable state. More... | |
| static constexpr base_t | getWorstState (const IntegerStateBase &) |
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 | |
| 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 ChangeStatus | manifest (Attributor &A) |
| Hook for the Attributor to trigger the manifestation of the information represented by the abstract attribute in the LLVM-IR. 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... | |
| Protected Member Functions inherited from llvm::AADepGraphNode | |
| operator AbstractAttribute * () | |
| Protected Member Functions inherited from llvm::IntegerStateBase< bool, 1, 0 > | |
| virtual void | handleNewAssumedValue (base_t Value)=0 |
Handle a new assumed value Value. Subtype dependent. More... | |
| virtual void | handleNewKnownValue (base_t Value)=0 |
Handle a new known value Value. Subtype dependent. More... | |
| virtual void | joinOR (base_t AssumedValue, base_t KnownValue)=0 |
Handle a value Value. Subtype dependent. More... | |
| virtual void | joinAND (base_t AssumedValue, base_t KnownValue)=0 |
Handle a new assumed value Value. Subtype dependent. More... | |
| Static Protected Member Functions inherited from llvm::AADepGraphNode | |
| static AADepGraphNode * | DepGetVal (DepTy &DT) |
| static AbstractAttribute * | DepGetValAA (DepTy &DT) |
| Protected Attributes inherited from llvm::AADepGraphNode | |
| TinyPtrVector< DepTy > | Deps |
| Set of dependency graph nodes which should be updated if this one is updated. More... | |
| Protected Attributes inherited from llvm::IntegerStateBase< bool, 1, 0 > | |
| base_t | Known |
| The known state encoding in an integer of type base_t. More... | |
| base_t | Assumed |
| The assumed state encoding in an integer of type base_t. More... | |
Detailed Description
An abstract interface to determine reachability of point A to B.
Definition at line 3132 of file Attributor.h.
Member Typedef Documentation
◆ Base
Definition at line 3133 of file Attributor.h.
Constructor & Destructor Documentation
◆ AAReachability()
|
inline |
Definition at line 3134 of file Attributor.h.
Member Function Documentation
◆ classof()
|
inlinestatic |
This function should return true if the type of the AA is AAReachability.
Definition at line 3168 of file Attributor.h.
References llvm::AbstractAttribute::getIdAddr(), and ID.
◆ createForPosition()
|
static |
Create an abstract attribute view for the position IRP.
◆ getIdAddr()
|
inlineoverridevirtual |
See AbstractAttribute::getIdAddr()
Implements llvm::AbstractAttribute.
Definition at line 3164 of file Attributor.h.
References ID.
◆ getName()
|
inlineoverridevirtual |
See AbstractAttribute::getName()
Implements llvm::AbstractAttribute.
Definition at line 3161 of file Attributor.h.
◆ isAssumedReachable()
|
inline |
Returns true if 'From' instruction is assumed to reach, 'To' instruction.
Users should provide two positions they are interested in, and the class determines (and caches) reachability.
Definition at line 3139 of file Attributor.h.
References From, llvm::StateWrapper< BooleanState, AbstractAttribute >::getState(), and llvm::IntegerStateBase< bool, 1, 0 >::isValidState().
◆ isKnownReachable()
|
inline |
Returns true if 'From' instruction is known to reach, 'To' instruction.
Users should provide two positions they are interested in, and the class determines (and caches) reachability.
Definition at line 3149 of file Attributor.h.
References From, llvm::StateWrapper< BooleanState, AbstractAttribute >::getState(), and llvm::IntegerStateBase< bool, 1, 0 >::isValidState().
Member Data Documentation
◆ ID
|
static |
Unique ID (due to the unique address)
Definition at line 3173 of file Attributor.h.
Referenced by classof(), and getIdAddr().
The documentation for this struct was generated from the following files:
- include/llvm/Transforms/IPO/Attributor.h
- lib/Transforms/IPO/AttributorAttributes.cpp
