LLVM 22.0.0git
llvm::AAValueConstantRange Struct Referenceabstract

An abstract interface for range value analysis. More...

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

Inheritance diagram for llvm::AAValueConstantRange:
[legend]

Public Types

using Base = StateWrapper<IntegerRangeState, AbstractAttribute, uint32_t>
Public Types inherited from llvm::StateWrapper< IntegerRangeState, AbstractAttribute, uint32_t >
using StateType
 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

Public Member Functions

 AAValueConstantRange (const IRPosition &IRP, Attributor &A)
IntegerRangeStategetState () override
 See AbstractAttribute::getState(...).
const IntegerRangeStategetState () const override
virtual ConstantRange getAssumedConstantRange (Attributor &A, const Instruction *CtxI=nullptr) const =0
 Return an assumed range for the associated value a program point CtxI.
virtual ConstantRange getKnownConstantRange (Attributor &A, const Instruction *CtxI=nullptr) const =0
 Return a known range for the associated value at a program point CtxI.
std::optional< Constant * > getAssumedConstant (Attributor &A, const Instruction *CtxI=nullptr) const
 Return an assumed constant for the associated value a program point CtxI.
StringRef getName () const override
 See AbstractAttribute::getName()
const chargetIdAddr () const override
 See AbstractAttribute::getIdAddr()
Public Member Functions inherited from llvm::StateWrapper< IntegerRangeState, AbstractAttribute, uint32_t >
 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.
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.
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.
LLVM_ABI 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
DepSetTygetDeps ()
Public Member Functions inherited from llvm::IntegerRangeState
 IntegerRangeState (uint32_t BitWidth)
 IntegerRangeState (const ConstantRange &CR)
uint32_t getBitWidth () const
 Return associated values' bit width.
bool isValidState () const override
 See AbstractState::isValidState()
bool isAtFixpoint () const override
 See AbstractState::isAtFixpoint()
ChangeStatus indicateOptimisticFixpoint () override
 See AbstractState::indicateOptimisticFixpoint(...)
ChangeStatus indicatePessimisticFixpoint () override
 See AbstractState::indicatePessimisticFixpoint(...)
ConstantRange getKnown () const
 Return the known state encoding.
ConstantRange getAssumed () const
 Return the assumed state encoding.
void unionAssumed (const ConstantRange &R)
 Unite assumed range with the passed state.
void unionAssumed (const IntegerRangeState &R)
 See IntegerRangeState::unionAssumed(..).
void intersectKnown (const ConstantRange &R)
 Intersect known range with the passed state.
void intersectKnown (const IntegerRangeState &R)
 See IntegerRangeState::intersectKnown(..).
bool operator== (const IntegerRangeState &R) const
 Equality for IntegerRangeState.
IntegerRangeState operator^= (const IntegerRangeState &R)
 "Clamp" this state with R.
IntegerRangeState operator&= (const IntegerRangeState &R)
Public Member Functions inherited from llvm::AbstractState
virtual ~AbstractState ()=default

Static Public Member Functions

static bool isValidIRPositionForInit (Attributor &A, const IRPosition &IRP)
 See AbstractAttribute::isValidIRPositionForInit.
static bool requiresCallersForArgOrFunction ()
 See AbstractAttribute::requiresCallersForArgOrFunction.
static LLVM_ABI AAValueConstantRangecreateForPosition (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 AAValueConstantRange.
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::IntegerRangeState
static ConstantRange getWorstState (uint32_t BitWidth)
 Return the worst possible representable state.
static ConstantRange getBestState (uint32_t BitWidth)
 Return the best possible representable state.
static ConstantRange getBestState (const IntegerRangeState &IRS)

Static Public Attributes

static LLVM_ABI 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 LLVM_ABI const IRPosition EmptyKey
 Special DenseMap key values.
static LLVM_ABI const IRPosition TombstoneKey

Additional Inherited Members

Public Attributes inherited from llvm::IntegerRangeState
uint32_t BitWidth
 Bitwidth of the associated value.
ConstantRange Assumed
 State representing assumed range, initially set to empty.
ConstantRange Known
 State representing known range, initially set to [-inf, inf].
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 * ()
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.

Detailed Description

An abstract interface for range value analysis.

Definition at line 4938 of file Attributor.h.

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ AAValueConstantRange()

llvm::AAValueConstantRange::AAValueConstantRange ( const IRPosition & IRP,
Attributor & A )
inline

Definition at line 4941 of file Attributor.h.

References A(), and llvm::IRPosition::getAssociatedType().

Referenced by createForPosition().

Member Function Documentation

◆ classof()

bool llvm::AAValueConstantRange::classof ( const AbstractAttribute * AA)
inlinestatic

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

Definition at line 4997 of file Attributor.h.

References ID.

◆ createForPosition()

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

Create an abstract attribute view for the position IRP.

References A(), AAValueConstantRange(), and LLVM_ABI.

◆ getAssumedConstant()

std::optional< Constant * > llvm::AAValueConstantRange::getAssumedConstant ( Attributor & A,
const Instruction * CtxI = nullptr ) const
inline

◆ getAssumedConstantRange()

virtual ConstantRange llvm::AAValueConstantRange::getAssumedConstantRange ( Attributor & A,
const Instruction * CtxI = nullptr ) const
pure virtual

Return an assumed range for the associated value a program point CtxI.

If I is nullptr, simply return an assumed range.

References A().

Referenced by getAssumedConstant().

◆ getIdAddr()

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

See AbstractAttribute::getIdAddr()

Implements llvm::AbstractAttribute.

Definition at line 4993 of file Attributor.h.

References ID.

◆ getKnownConstantRange()

virtual ConstantRange llvm::AAValueConstantRange::getKnownConstantRange ( Attributor & A,
const Instruction * CtxI = nullptr ) const
pure virtual

Return a known range for the associated value at a program point CtxI.

If I is nullptr, simply return a known range.

References A().

◆ getName()

StringRef llvm::AAValueConstantRange::getName ( ) const
inlineoverridevirtual

See AbstractAttribute::getName()

Implements llvm::AbstractAttribute.

Definition at line 4990 of file Attributor.h.

◆ getState() [1/2]

const IntegerRangeState & llvm::AAValueConstantRange::getState ( ) const
inlineoverridevirtual

Implements llvm::AbstractAttribute.

Definition at line 4956 of file Attributor.h.

◆ getState() [2/2]

IntegerRangeState & llvm::AAValueConstantRange::getState ( )
inlineoverridevirtual

See AbstractAttribute::getState(...).

Implements llvm::AbstractAttribute.

Definition at line 4955 of file Attributor.h.

◆ isValidIRPositionForInit()

bool llvm::AAValueConstantRange::isValidIRPositionForInit ( Attributor & A,
const IRPosition & IRP )
inlinestatic

◆ requiresCallersForArgOrFunction()

bool llvm::AAValueConstantRange::requiresCallersForArgOrFunction ( )
inlinestatic

Member Data Documentation

◆ ID

const char AAValueConstantRange::ID = 0
static

Unique ID (due to the unique address)

Definition at line 5002 of file Attributor.h.

Referenced by classof(), and getIdAddr().


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