LLVM  16.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
llvm::AAPotentialConstantValues Struct Reference

An abstract interface for potential values analysis. More...

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

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

Public Types

using Base = StateWrapper< PotentialConstantIntValuesState, AbstractAttribute >
 
- Public Types inherited from llvm::StateWrapper< PotentialConstantIntValuesState, AbstractAttribute >
using StateType = PotentialConstantIntValuesState
 Provide static access to the type of the state. More...
 
- 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)>
 
- Public Types inherited from llvm::PotentialValuesState< MemberTy >
using SetTy = SmallSetVector< MemberTy, 8 >
 

Public Member Functions

 AAPotentialConstantValues (const IRPosition &IRP, Attributor &A)
 
PotentialConstantIntValuesStategetState () override
 See AbstractAttribute::getState(...). More...
 
const PotentialConstantIntValuesStategetState () const override
 
Optional< Constant * > getAssumedConstant (Attributor &A, const Instruction *CtxI=nullptr) const
 Return assumed constant for the associated value. 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< PotentialConstantIntValuesState, AbstractAttribute >
 StateWrapper (const IRPosition &IRP, Ts... Args)
 
StateTypegetState () override
 See AbstractAttribute::getState(...). More...
 
const StateTypegetState () const override
 See AbstractAttribute::getState(...). More...
 
- Public Member Functions inherited from llvm::AbstractAttribute
 AbstractAttribute (const IRPosition &IRP)
 
virtual ~AbstractAttribute ()=default
 Virtual destructor. More...
 
virtual void initialize (Attributor &A)
 Initialize the state with the information in the Attributor A. More...
 
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. 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
 
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
 
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 ()=default
 
aaiterator begin ()
 
aaiterator end ()
 
iterator child_begin ()
 
iterator child_end ()
 
TinyPtrVector< DepTy > & getDeps ()
 
- Public Member Functions inherited from llvm::PotentialValuesState< MemberTy >
 PotentialValuesState ()
 
 PotentialValuesState (bool IsValid)
 
bool isValidState () const override
 See AbstractState::isValidState(...) More...
 
bool isAtFixpoint () const override
 See AbstractState::isAtFixpoint(...) More...
 
ChangeStatus indicatePessimisticFixpoint () override
 See AbstractState::indicatePessimisticFixpoint(...) More...
 
ChangeStatus indicateOptimisticFixpoint () override
 See AbstractState::indicateOptimisticFixpoint(...) More...
 
PotentialValuesStategetAssumed ()
 Return the assumed state. More...
 
const PotentialValuesStategetAssumed () const
 
const SetTygetAssumedSet () const
 Return this set. More...
 
bool undefIsContained () const
 Returns whether this state contains an undef value or not. More...
 
bool operator== (const PotentialValuesState &RHS) const
 
void unionAssumed (const MemberTy &C)
 Union assumed set with the passed value. More...
 
void unionAssumed (const PotentialValuesState &PVS)
 Union assumed set with assumed set of the passed state PVS. More...
 
void unionAssumedWithUndef ()
 Union assumed set with an undef value. More...
 
PotentialValuesState operator^= (const PotentialValuesState &PVS)
 "Clamp" this state with PVS. More...
 
PotentialValuesState operator&= (const PotentialValuesState &PVS)
 
bool contains (const MemberTy &V) const
 
- Public Member Functions inherited from llvm::AbstractState
virtual ~AbstractState ()=default
 

Static Public Member Functions

static AAPotentialConstantValuescreateForPosition (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 AAPotentialConstantValues. 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 inst (const Instruction &I, const CallBaseContext *CBContext=nullptr)
 Create a position describing the instruction I. 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::PotentialValuesState< MemberTy >
static PotentialValuesState getBestState ()
 Return empty set as the best state of potential values. More...
 
static PotentialValuesState getBestState (const PotentialValuesState &PVS)
 
static PotentialValuesState getWorstState ()
 Return full set as the worst state of potential values. 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
 
- Static Public Attributes inherited from llvm::PotentialValuesState< MemberTy >
static unsigned MaxPotentialValues = 0
 Maximum number of potential values to be tracked. More...
 

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::PotentialValuesState< MemberTy >
SetTygetAssumedSet ()
 
- 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

An abstract interface for potential values analysis.

This AA collects potential values for each IR position. An assumed set of potential values is initialized with the empty set (the best state) and it will grow monotonically as we find more potential values for this position. The set might be forced to the worst state, that is, to contain every possible value for this position in 2 cases.

  1. We surpassed the MaxPotentialValues threshold. This includes the case that this position is affected (e.g. because of an operation) by a Value that is in the worst state.
  2. We tried to initialize on a Value that we cannot handle (e.g. an operator we do not currently handle).

For non constant integers see AAPotentialValues.

Definition at line 4621 of file Attributor.h.

Member Typedef Documentation

◆ Base

Definition at line 4623 of file Attributor.h.

Constructor & Destructor Documentation

◆ AAPotentialConstantValues()

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

Definition at line 4624 of file Attributor.h.

Member Function Documentation

◆ classof()

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

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

Definition at line 4666 of file Attributor.h.

References llvm::AbstractAttribute::getIdAddr().

◆ createForPosition()

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

Create an abstract attribute view for the position IRP.

◆ getAssumedConstant()

Optional<Constant *> llvm::AAPotentialConstantValues::getAssumedConstant ( Attributor A,
const Instruction CtxI = nullptr 
) const
inline

◆ getIdAddr()

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

See AbstractAttribute::getIdAddr()

Implements llvm::AbstractAttribute.

Definition at line 4662 of file Attributor.h.

References ID.

◆ getName()

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

See AbstractAttribute::getName()

Implements llvm::AbstractAttribute.

Definition at line 4657 of file Attributor.h.

◆ getState() [1/2]

const PotentialConstantIntValuesState& llvm::AAPotentialConstantValues::getState ( ) const
inlineoverridevirtual

Implements llvm::AbstractAttribute.

Definition at line 4628 of file Attributor.h.

◆ getState() [2/2]

PotentialConstantIntValuesState& llvm::AAPotentialConstantValues::getState ( )
inlineoverridevirtual

See AbstractAttribute::getState(...).

Implements llvm::AbstractAttribute.

Definition at line 4627 of file Attributor.h.

Member Data Documentation

◆ ID

const char AAPotentialConstantValues::ID = 0
static

Unique ID (due to the unique address)

Definition at line 4671 of file Attributor.h.

Referenced by getIdAddr().


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