clang 22.0.0git
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
clang::interp::InterpFrame Class Referencefinal

Frame storing local variables. More...

#include "/work/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/AST/ByteCode/InterpFrame.h"

Inheritance diagram for clang::interp::InterpFrame:
[legend]

Public Member Functions

 InterpFrame (InterpState &S)
 Bottom Frame.
 InterpFrame (InterpState &S, const Function *Func, InterpFrame *Caller, CodePtr RetPC, unsigned ArgSize)
 Creates a new frame for a method call.
 InterpFrame (InterpState &S, const Function *Func, CodePtr RetPC, unsigned VarArgSize=0)
 Creates a new frame with the values that make sense.
 ~InterpFrame ()
 Destroys the frame, killing all live pointers to stack slots.
void destroy (unsigned Idx)
 Invokes the destructors for a scope.
void initScope (unsigned Idx)
void destroyScopes ()
void enableLocal (unsigned Idx)
bool isLocalEnabled (unsigned Idx) const
void describe (llvm::raw_ostream &OS) const override
 Describes the frame with arguments for diagnostic purposes.
Frame * getCaller () const override
 Returns the parent frame object.
SourceRange getCallRange () const override
 Returns the location of the call to the frame.
const FunctionDecl * getCallee () const override
 Returns the caller.
const Function * getFunction () const
 Returns the current function.
size_t getFrameOffset () const
 Returns the offset on the stack at which the frame starts.
template<typename T>
const T & getLocal (unsigned Offset) const
 Returns the value of a local variable.
template<typename T>
void setLocal (unsigned Offset, const T &Value)
 Mutates a local variable.
Pointer getLocalPointer (unsigned Offset) const
 Returns a pointer to a local variables.
Block * getLocalBlock (unsigned Offset) const
template<typename T>
const T & getParam (unsigned Offset) const
 Returns the value of an argument.
template<typename T>
void setParam (unsigned Offset, const T &Value)
 Mutates a local copy of a parameter.
Pointer getParamPointer (unsigned Offset)
 Returns a pointer to an argument - lazily creates a block.
bool hasThisPointer () const
const Pointer & getThis () const
 Returns the 'this' pointer.
const Pointer & getRVOPtr () const
 Returns the RVO pointer, if the Function has one.
bool isRoot () const
 Checks if the frame is a root frame - return should quit the interpreter.
CodePtr getPC () const
 Returns the PC of the frame's code start.
CodePtr getRetPC () const
 Returns the return address of the frame.
SourceInfo getSource (CodePtr PC) const
 Map a location to a source.
const Expr * getExpr (CodePtr PC) const
SourceLocation getLocation (CodePtr PC) const
SourceRange getRange (CodePtr PC) const
unsigned getDepth () const
bool isStdFunction () const
bool isBottomFrame () const
void dump () const
void dump (llvm::raw_ostream &OS, unsigned Indent=0) const
Public Member Functions inherited from clang::interp::Frame
virtual ~Frame ()=default

Static Public Member Functions

static void free (InterpFrame *F)

Public Attributes

InterpFrame * Caller
 The frame of the previous function.

Detailed Description

Frame storing local variables.

Definition at line 27 of file InterpFrame.h.

Constructor & Destructor Documentation

◆ InterpFrame() [1/3]

InterpFrame::InterpFrame ( InterpState & S)

Bottom Frame.

Definition at line 25 of file InterpFrame.cpp.

References Caller, and clang::nullptr.

Referenced by dump(), free(), getCallRange(), InterpFrame(), and InterpFrame().

◆ InterpFrame() [2/3]

InterpFrame::InterpFrame ( InterpState & S,
const Function * Func,
InterpFrame * Caller,
CodePtr RetPC,
unsigned ArgSize )

Creates a new frame for a method call.

Definition at line 29 of file InterpFrame.cpp.

References clang::interp::Block, Caller, InterpFrame(), and clang::interp::Scope::locals().

◆ InterpFrame() [3/3]

InterpFrame::InterpFrame ( InterpState & S,
const Function * Func,
CodePtr RetPC,
unsigned VarArgSize = 0 )

Creates a new frame with the values that make sense.

I.e., the caller is the current frame of S, the This() pointer is the current Pointer on the top of S's stack, and the RVO pointer is before that.

Definition at line 52 of file InterpFrame.cpp.

References clang::if(), and InterpFrame().

◆ ~InterpFrame()

InterpFrame::~InterpFrame ( )

Destroys the frame, killing all live pointers to stack slots.

Definition at line 69 of file InterpFrame.cpp.

References destroyScopes().

Member Function Documentation

◆ describe()

void InterpFrame::describe ( llvm::raw_ostream & OS) const
overridevirtual

Describes the frame with arguments for diagnostic purposes.

Implements clang::interp::Frame.

Definition at line 153 of file InterpFrame.cpp.

References clang::interp::align(), Caller, clang::cast(), getCallee(), getFunction(), clang::FunctionDecl::getNameForDiagnostic(), clang::FunctionDecl::getNumParams(), clang::FunctionDecl::getParamDecl(), getRetPC(), getThis(), clang::ValueDecl::getType(), clang::isa(), clang::interp::primSize(), print(), clang::interp::PT_Ptr, shouldSkipInBacktrace(), and TYPE_SWITCH.

Referenced by dump().

◆ destroy()

void InterpFrame::destroy ( unsigned Idx)

Invokes the destructors for a scope.

Definition at line 109 of file InterpFrame.cpp.

Referenced by clang::interp::Destroy().

◆ destroyScopes()

void InterpFrame::destroyScopes ( )

Definition at line 79 of file InterpFrame.cpp.

References clang::interp::Scope::locals().

Referenced by ~InterpFrame().

◆ dump() [1/2]

void clang::interp::InterpFrame::dump ( ) const
inline

Definition at line 149 of file InterpFrame.h.

References dump().

Referenced by dump().

◆ dump() [2/2]

LLVM_DUMP_METHOD void InterpFrame::dump ( llvm::raw_ostream & OS,
unsigned Indent = 0 ) const

Definition at line 490 of file Disasm.cpp.

References Caller, describe(), clang::ast_matchers::getCallee(), getDepth(), getFunction(), getRVOPtr(), getThis(), clang::Indent(), and InterpFrame().

◆ enableLocal()

void InterpFrame::enableLocal ( unsigned Idx)

Definition at line 98 of file InterpFrame.cpp.

Referenced by clang::interp::EnableLocal().

◆ free()

void clang::interp::InterpFrame::free ( InterpFrame * F)
inlinestatic

Definition at line 49 of file InterpFrame.h.

References InterpFrame(), and isBottomFrame().

Referenced by clang::interp::Ret(), and clang::interp::RetVoid().

◆ getCallee()

const FunctionDecl * InterpFrame::getCallee ( ) const
overridevirtual

Returns the caller.

Implements clang::interp::Frame.

Definition at line 226 of file InterpFrame.cpp.

Referenced by describe(), clang::interp::interp__builtin_is_within_lifetime(), and clang::interp::NoRet().

◆ getCaller()

Frame * clang::interp::InterpFrame::getCaller ( ) const
inlineoverridevirtual

Returns the parent frame object.

Implements clang::interp::Frame.

Definition at line 67 of file InterpFrame.h.

References Caller.

◆ getCallRange()

SourceRange InterpFrame::getCallRange ( ) const
overridevirtual

Returns the location of the call to the frame.

Implements clang::interp::Frame.

Definition at line 207 of file InterpFrame.cpp.

References clang::C, Caller, InterpFrame(), and clang::SourceRange::isValid().

◆ getDepth()

unsigned clang::interp::InterpFrame::getDepth ( ) const
inline

Definition at line 143 of file InterpFrame.h.

Referenced by clang::interp::CheckCallable(), clang::interp::CheckCallDepth(), clang::interp::CheckFunctionDecl(), dump(), clang::interp::GetPtrThisField(), clang::interp::InitThisBitField(), clang::interp::InitThisBitFieldActivate(), clang::interp::InitThisField(), clang::interp::InitThisFieldActivate(), and clang::interp::interp__builtin_is_constant_evaluated().

◆ getExpr()

const Expr * InterpFrame::getExpr ( CodePtr PC) const

Definition at line 286 of file InterpFrame.cpp.

References Caller, and funcHasUsableBody().

Referenced by clang::interp::AddSubMulHelper(), clang::interp::CallVirt(), clang::interp::CastFloatingIntegral(), clang::interp::CheckBitCast(), clang::interp::CheckBitCast(), CheckBitcastType(), clang::interp::CheckDivRem(), clang::interp::CheckDowncast(), clang::interp::CheckLiteralType(), clang::interp::CheckShift(), clang::interp::CheckThis(), clang::interp::cleanupAfterFunctionCall(), clang::interp::DiagTypeid(), clang::interp::DoBitCastPtr(), clang::interp::GetDynamicDecl(), clang::interp::handleFixedPointOverflow(), clang::interp::handleOverflow(), clang::interp::IncDecHelper(), clang::interp::interp__builtin_is_constant_evaluated(), clang::interp::InvalidCast(), clang::interp::Neg(), clang::interp::PtrPtrCast(), clang::interp::ShiftFixedPoint(), and clang::interp::SizelessVectorElementSize().

◆ getFrameOffset()

size_t clang::interp::InterpFrame::getFrameOffset ( ) const
inline

Returns the offset on the stack at which the frame starts.

Definition at line 79 of file InterpFrame.h.

Referenced by clang::interp::Ret(), and clang::interp::RetVoid().

◆ getFunction()

const Function * clang::interp::InterpFrame::getFunction ( ) const
inline

Returns the current function.

Definition at line 76 of file InterpFrame.h.

Referenced by clang::interp::Call(), clang::interp::CallVar(), clang::interp::CheckLiteralType(), describe(), clang::interp::Destroy(), dump(), clang::interp::GetTypeidPtr(), clang::interp::Ret(), clang::interp::RetVoid(), clang::interp::runRecordDestructor(), clang::interp::RVOPtr(), and clang::interp::This().

◆ getLocal()

template<typename T>
const T & clang::interp::InterpFrame::getLocal ( unsigned Offset) const
inline

Returns the value of a local variable.

Definition at line 82 of file InterpFrame.h.

References clang::T.

◆ getLocalBlock()

Block * InterpFrame::getLocalBlock ( unsigned Offset) const

Definition at line 237 of file InterpFrame.cpp.

Referenced by clang::interp::GetLocal().

◆ getLocalPointer()

Pointer InterpFrame::getLocalPointer ( unsigned Offset) const

Returns a pointer to a local variables.

Definition at line 232 of file InterpFrame.cpp.

References Pointer.

Referenced by clang::interp::Destroy(), and clang::interp::GetPtrLocal().

◆ getLocation()

SourceLocation InterpFrame::getLocation ( CodePtr PC) const

Definition at line 293 of file InterpFrame.cpp.

References Caller, and funcHasUsableBody().

Referenced by clang::interp::Assume(), clang::interp::CheckCallable(), clang::interp::CheckConstant(), clang::interp::checkConstructor(), CheckGlobal(), clang::interp::CheckGlobalLoad(), clang::interp::CheckLocalLoad(), clang::interp::CheckNewTypeMismatch(), clang::interp::CheckNonNullArg(), clang::interp::CheckNonNullArgs(), clang::interp::CheckVolatile(), clang::interp::CheckWeak(), clang::interp::diagnoseCallableDecl(), clang::interp::diagnoseEnumValue(), clang::interp::InterpretBuiltin(), clang::interp::Invalid(), clang::interp::InvalidCast(), clang::interp::ShiftFixedPoint(), and clang::interp::Unsupported().

◆ getParam()

template<typename T>
const T & clang::interp::InterpFrame::getParam ( unsigned Offset) const
inline

Returns the value of an argument.

Definition at line 97 of file InterpFrame.h.

References clang::interp::Block::deref(), and clang::T.

Referenced by clang::interp::GetParam().

◆ getParamPointer()

Pointer InterpFrame::getParamPointer ( unsigned Offset)

Returns a pointer to an argument - lazily creates a block.

Definition at line 241 of file InterpFrame.cpp.

References clang::interp::Block, isBottomFrame(), Pointer, clang::T, and TYPE_SWITCH.

Referenced by clang::interp::GetPtrParam(), and setParam().

◆ getPC()

CodePtr clang::interp::InterpFrame::getPC ( ) const
inline

Returns the PC of the frame's code start.

Definition at line 132 of file InterpFrame.h.

Referenced by clang::interp::Interpret().

◆ getRange()

SourceRange InterpFrame::getRange ( CodePtr PC) const

Definition at line 300 of file InterpFrame.cpp.

References Caller, and funcHasUsableBody().

Referenced by clang::interp::CastPointerIntegral(), clang::interp::CheckBitCast(), clang::interp::CheckFloatResult(), clang::interp::CheckLifetime(), clang::interp::CheckNull(), clang::interp::CheckPointerToIntegralCast(), clang::interp::CheckRange(), clang::interp::CheckRange(), clang::interp::CheckSubobject(), clang::interp::DiagnoseUninitialized(), clang::interp::FnPtrCast(), clang::interp::InitElem(), clang::interp::InitElemPop(), clang::interp::InterpretBuiltin(), clang::interp::Invalid(), clang::interp::InvalidCast(), clang::interp::PtrPtrCast(), clang::interp::SizelessVectorElementSize(), and clang::interp::Unsupported().

◆ getRetPC()

CodePtr clang::interp::InterpFrame::getRetPC ( ) const
inline

Returns the return address of the frame.

Definition at line 135 of file InterpFrame.h.

Referenced by clang::interp::cleanupAfterFunctionCall(), describe(), clang::interp::interp__builtin_is_constant_evaluated(), clang::interp::interp__builtin_is_within_lifetime(), clang::interp::Ret(), and clang::interp::RetVoid().

◆ getRVOPtr()

const Pointer & clang::interp::InterpFrame::getRVOPtr ( ) const
inline

Returns the RVO pointer, if the Function has one.

Definition at line 121 of file InterpFrame.h.

References isBottomFrame().

Referenced by dump(), and clang::interp::RVOPtr().

◆ getSource()

SourceInfo InterpFrame::getSource ( CodePtr PC) const

Map a location to a source.

Definition at line 272 of file InterpFrame.cpp.

References Caller, funcHasUsableBody(), and clang::Result.

Referenced by clang::interp::AllocN(), clang::interp::ArrayDecay(), clang::interp::BitCastPrim(), clang::interp::CallPtr(), clang::interp::CallVirt(), clang::interp::CastPointerIntegral(), clang::interp::CheckActive(), clang::interp::CheckArray(), clang::interp::CheckArraySize(), clang::interp::CheckArraySize(), clang::interp::CheckBitCast(), clang::interp::CheckCallDepth(), clang::interp::CheckConst(), clang::interp::CheckDeleteSource(), clang::interp::CheckDestructor(), clang::interp::CheckDivRem(), clang::interp::CheckDummy(), clang::interp::CheckDynamicMemoryAllocation(), clang::interp::CheckFloatResult(), clang::interp::CheckLifetime(), clang::interp::CheckLive(), clang::interp::CheckLoad(), clang::interp::CheckMutable(), clang::interp::CheckNewDeleteForms(), clang::interp::CheckNewTypeMismatch(), clang::interp::CheckNull(), clang::interp::CheckNull(), clang::interp::CheckPointerToIntegralCast(), clang::interp::CheckPseudoDtor(), clang::interp::CheckRange(), clang::interp::CheckRange(), clang::interp::CheckShift(), clang::interp::CheckSubobject(), CheckTemporary(), clang::interp::CMP3(), clang::interp::CmpHelper< Pointer >(), clang::interp::CmpHelperEQ< MemberPointer >(), clang::interp::CmpHelperEQ< Pointer >(), diagnoseMissingInitializer(), clang::interp::diagnoseNonConstexprBuiltin(), diagnoseNonConstVariable(), clang::interp::DiagnoseUninitialized(), diagnoseUnknownDecl(), clang::interp::Divc(), clang::interp::DoShift(), clang::interp::DoShiftAP(), clang::interp::FnPtrCast(), clang::interp::Free(), clang::interp::getField(), clang::interp::GetIntPtr(), clang::interp::GetPtrDerivedPop(), clang::interp::InitElem(), clang::interp::InitElemPop(), clang::interp::interp__builtin_elementwise_countzeroes(), clang::interp::interp__builtin_is_within_lifetime(), clang::interp::interp__builtin_memchr(), clang::interp::interp__builtin_memcmp(), clang::interp::interp__builtin_memcpy(), clang::interp::interp__builtin_operator_delete(), clang::interp::interp__builtin_operator_new(), clang::interp::InvalidDeclRef(), clang::interp::InvalidNewDeleteExpr(), clang::interp::InvalidShuffleVectorIndex(), clang::interp::InvalidStore(), clang::interp::OffsetHelper(), clang::interp::PtrPtrCast(), clang::interp::runRecordDestructor(), and clang::interp::SubPtr().

◆ getThis()

const Pointer & clang::interp::InterpFrame::getThis ( ) const
inline

Returns the 'this' pointer.

Definition at line 114 of file InterpFrame.h.

References hasThisPointer(), and isBottomFrame().

Referenced by clang::interp::ActivateThisField(), clang::interp::CheckLiteralType(), describe(), dump(), clang::interp::GetPtrThisBase(), clang::interp::GetPtrThisField(), clang::interp::GetPtrThisVirtBase(), clang::interp::GetThisField(), clang::interp::InitThisBitField(), clang::interp::InitThisBitFieldActivate(), clang::interp::InitThisField(), clang::interp::InitThisFieldActivate(), clang::interp::runRecordDestructor(), clang::interp::SetThisField(), and clang::interp::This().

◆ hasThisPointer()

bool clang::interp::InterpFrame::hasThisPointer ( ) const
inline

Definition at line 112 of file InterpFrame.h.

Referenced by clang::interp::ActivateThisField(), clang::interp::CheckThis(), getThis(), and clang::interp::runRecordDestructor().

◆ initScope()

void InterpFrame::initScope ( unsigned Idx)

Definition at line 89 of file InterpFrame.cpp.

Referenced by clang::interp::InitScope().

◆ isBottomFrame()

bool clang::interp::InterpFrame::isBottomFrame ( ) const
inline

Definition at line 147 of file InterpFrame.h.

References Caller.

Referenced by clang::interp::CheckLiteralType(), free(), getParamPointer(), clang::interp::GetPtrParam(), getRVOPtr(), and getThis().

◆ isLocalEnabled()

bool clang::interp::InterpFrame::isLocalEnabled ( unsigned Idx) const
inline

Definition at line 59 of file InterpFrame.h.

Referenced by clang::interp::EnableLocal(), and clang::interp::GetLocalEnabled().

◆ isRoot()

bool clang::interp::InterpFrame::isRoot ( ) const
inline

Checks if the frame is a root frame - return should quit the interpreter.

Definition at line 129 of file InterpFrame.h.

Referenced by clang::interp::Interpret().

◆ isStdFunction()

bool InterpFrame::isStdFunction ( ) const

Definition at line 307 of file InterpFrame.cpp.

References clang::DeclContext::getParent().

Referenced by clang::interp::InvalidNewDeleteExpr().

◆ setLocal()

template<typename T>
void clang::interp::InterpFrame::setLocal ( unsigned Offset,
const T & Value )
inline

Mutates a local variable.

Definition at line 87 of file InterpFrame.h.

References clang::T.

Referenced by clang::interp::SetLocal().

◆ setParam()

template<typename T>
void clang::interp::InterpFrame::setParam ( unsigned Offset,
const T & Value )
inline

Mutates a local copy of a parameter.

Definition at line 105 of file InterpFrame.h.

References clang::interp::Pointer::deref(), getParamPointer(), and clang::T.

Referenced by clang::interp::SetParam().

Member Data Documentation

◆ Caller

InterpFrame* clang::interp::InterpFrame::Caller

The frame of the previous function.

Definition at line 30 of file InterpFrame.h.

Referenced by clang::interp::cleanupAfterFunctionCall(), describe(), dump(), getCaller(), getCallRange(), getExpr(), getLocation(), getRange(), getSource(), clang::interp::interp__builtin_is_within_lifetime(), InterpFrame(), InterpFrame(), isBottomFrame(), clang::interp::Ret(), and clang::interp::RetVoid().

The documentation for this class was generated from the following files:
Generated on for clang by doxygen 1.14.0