LLVM  11.0.0git
Public Member Functions | Static Public Member Functions | List of all members
AANoCaptureImpl Struct Reference

-----------------—— Variable Capturing ---------------------------—— More...

Inheritance diagram for AANoCaptureImpl:
Inheritance graph
[legend]
Collaboration diagram for AANoCaptureImpl:
Collaboration graph
[legend]

Public Member Functions

 AANoCaptureImpl (const IRPosition &IRP)
 
void initialize (Attributor &A) override
 See AbstractAttribute::initialize(...). More...
 
ChangeStatus updateImpl (Attributor &A) override
 See AbstractAttribute::updateImpl(...). More...
 
virtual void getDeducedAttributes (LLVMContext &Ctx, SmallVectorImpl< Attribute > &Attrs) const override
 see AbstractAttribute::isAssumedNoCaptureMaybeReturned(...). More...
 
const std::string getAsStr () const override
 See AbstractState::getAsStr(). More...
 
- Public Member Functions inherited from llvm::AANoCapture
 AANoCapture (const IRPosition &IRP)
 
bool isKnownNoCapture () const
 Return true if we know that the underlying value is not captured in its respective scope. More...
 
bool isAssumedNoCapture () const
 Return true if we assume that the underlying value is not captured in its respective scope. More...
 
bool isKnownNoCaptureMaybeReturned () const
 Return true if we know that the underlying value is not captured in its respective scope but we allow it to escape through a "return". More...
 
bool isAssumedNoCaptureMaybeReturned () const
 Return true if we assume that the underlying value is not captured in its respective scope but we allow it to escape through a "return". More...
 
- Public Member Functions inherited from llvm::IRAttribute< Attribute::NoCapture, StateWrapper< BitIntegerState< uint16_t, 7, 0 >, 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...
 
const IRPositiongetIRPosition () const override
 Return an IR position, see struct IRPosition. More...
 
- 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 () 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 getArgNo () const
 Return the 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) 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) 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...
 
void removeAttrs (ArrayRef< Attribute::AttrKind > AKs) const
 Remove the attribute of kind AKs existing in the IR at this position. More...
 
bool isAnyCallSitePosition () const
 
- Public Member Functions inherited from llvm::StateWrapper< BitIntegerState< uint16_t, 7, 0 >, AbstractAttribute >
StateTypegetState () override
 See AbstractAttribute::getState(...). More...
 
const AbstractStategetState () const override
 See AbstractAttribute::getState(...). More...
 
- Public Member Functions inherited from llvm::BitIntegerState< uint16_t, 7, 0 >
bool isKnown (base_t BitsEncoding) const
 Return true if the bits set in BitsEncoding are "known bits". More...
 
bool isAssumed (base_t BitsEncoding) const
 Return true if the bits set in BitsEncoding are "assumed bits". More...
 
BitIntegerStateaddKnownBits (base_t Bits)
 Add the bits in BitsEncoding to the "known bits". More...
 
BitIntegerStateremoveAssumedBits (base_t BitsEncoding)
 Remove the bits in BitsEncoding from the "assumed bits" if not known. More...
 
BitIntegerStateremoveKnownBits (base_t BitsEncoding)
 Remove the bits in BitsEncoding from the "known bits". More...
 
BitIntegerStateintersectAssumedBits (base_t BitsEncoding)
 Keep only "assumed bits" also set in BitsEncoding but all known ones. More...
 
- Public Member Functions inherited from llvm::IntegerStateBase< uint16_t, BestState, WorstState >
 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)
 
void operator&= (const IntegerStateBase< base_t, BestState, WorstState > &R)
 
- Public Member Functions inherited from llvm::AbstractState
virtual ~AbstractState ()
 
- Public Member Functions inherited from llvm::AbstractAttribute
virtual ~AbstractAttribute ()
 Virtual destructor. More...
 
virtual void print (raw_ostream &OS) const
 Helper functions, for debug purposes only. More...
 
void dump () const
 

Static Public Member Functions

static void determineFunctionCaptureCapabilities (const IRPosition &IRP, const Function &F, BitIntegerState &State)
 Set the NOT_CAPTURED_IN_MEM and NOT_CAPTURED_IN_RET bits in Known depending on the ability of the function associated with IRP to capture state in memory and through "returning/throwing", respectively. More...
 
- Static Public Member Functions inherited from llvm::AANoCapture
static AANoCapturecreateForPosition (const IRPosition &IRP, Attributor &A)
 Create an abstract attribute view for the position IRP. More...
 
- 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 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)
 Create a position with function scope matching the "context" of IRP. More...
 
- Static Public Member Functions inherited from llvm::IntegerStateBase< uint16_t, BestState, WorstState >
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...
 

Additional Inherited Members

- Public Types inherited from llvm::AANoCapture
enum  {
  NOT_CAPTURED_IN_MEM = 1 << 0, NOT_CAPTURED_IN_INT = 1 << 1, NOT_CAPTURED_IN_RET = 1 << 2, NO_CAPTURE_MAYBE_RETURNED = NOT_CAPTURED_IN_MEM | NOT_CAPTURED_IN_INT,
  NO_CAPTURE
}
 State encoding bits. More...
 
- 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::StateWrapper< BitIntegerState< uint16_t, 7, 0 >, AbstractAttribute >
using StateType = BitIntegerState< uint16_t, 7, 0 >
 Provide static access to the type of the state. More...
 
- Public Types inherited from llvm::BitIntegerState< uint16_t, 7, 0 >
using base_t = uint16_t
 
- Public Types inherited from llvm::IntegerStateBase< uint16_t, BestState, WorstState >
using base_t = uint16_t
 
- Public Types inherited from llvm::AbstractAttribute
using StateType = AbstractState
 
- Static Public Attributes inherited from llvm::AANoCapture
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
 
- 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...
 
- Protected Attributes inherited from llvm::IRPosition
ValueAnchorVal
 The value this position is anchored at. More...
 
int KindOrArgNo
 The argument number, if non-negative, or the position "kind". More...
 
- Protected Attributes inherited from llvm::IntegerStateBase< uint16_t, BestState, WorstState >
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

-----------------—— Variable Capturing ---------------------------——

A class to hold the state of for no-capture attributes.

Definition at line 4019 of file Attributor.cpp.

Constructor & Destructor Documentation

◆ AANoCaptureImpl()

AANoCaptureImpl::AANoCaptureImpl ( const IRPosition IRP)
inline

Definition at line 4020 of file Attributor.cpp.

Member Function Documentation

◆ determineFunctionCaptureCapabilities()

static void AANoCaptureImpl::determineFunctionCaptureCapabilities ( const IRPosition IRP,
const Function F,
BitIntegerState State 
)
inlinestatic

Set the NOT_CAPTURED_IN_MEM and NOT_CAPTURED_IN_RET bits in Known depending on the ability of the function associated with IRP to capture state in memory and through "returning/throwing", respectively.

Definition at line 4072 of file Attributor.cpp.

References llvm::BitIntegerState< base_ty, BestState, WorstState >::addKnownBits(), llvm::Function::arg_size(), llvm::Function::doesNotThrow(), llvm::numbers::e, llvm::IRPosition::getArgNo(), llvm::Function::getReturnType(), llvm::Function::hasParamAttribute(), llvm::Type::isVoidTy(), llvm::Function::onlyReadsMemory(), and llvm::BitIntegerState< base_ty, BestState, WorstState >::removeAssumedBits().

◆ getAsStr()

const std::string AANoCaptureImpl::getAsStr ( ) const
inlineoverridevirtual

See AbstractState::getAsStr().

Implements llvm::AbstractAttribute.

Definition at line 4113 of file Attributor.cpp.

◆ getDeducedAttributes()

virtual void AANoCaptureImpl::getDeducedAttributes ( LLVMContext Ctx,
SmallVectorImpl< Attribute > &  Attrs 
) const
inlineoverridevirtual

◆ initialize()

void AANoCaptureImpl::initialize ( Attributor A)
inlineoverridevirtual

◆ updateImpl()

ChangeStatus AANoCaptureImpl::updateImpl ( Attributor A)
overridevirtual

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