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

Frame storing local variables. More...

#include "/home/buildbot/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/AST/Interp/InterpFrame.h"

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

Public Member Functions

 InterpFrame (InterpState &S, const Function *Func, InterpFrame *Caller, CodePtr RetPC)
 Creates a new frame for a method call. More...
 
 InterpFrame (InterpState &S, const Function *Func, CodePtr RetPC)
 Creates a new frame with the values that make sense. More...
 
 ~InterpFrame ()
 Destroys the frame, killing all live pointers to stack slots. More...
 
void destroy (unsigned Idx)
 Invokes the destructors for a scope. More...
 
void popArgs ()
 Pops the arguments off the stack. More...
 
void describe (llvm::raw_ostream &OS) override
 Describes the frame with arguments for diagnostic purposes. More...
 
FramegetCaller () const override
 Returns the parent frame object. More...
 
SourceLocation getCallLocation () const override
 Returns the location of the call to the frame. More...
 
const FunctionDeclgetCallee () const override
 Returns the caller. More...
 
const FunctiongetFunction () const
 Returns the current function. More...
 
size_t getFrameOffset () const
 Returns the offset on the stack at which the frame starts. More...
 
template<typename T >
const T & getLocal (unsigned Offset) const
 Returns the value of a local variable. More...
 
template<typename T >
void setLocal (unsigned Offset, const T &Value)
 Mutates a local variable. More...
 
Pointer getLocalPointer (unsigned Offset) const
 Returns a pointer to a local variables. More...
 
template<typename T >
const T & getParam (unsigned Offset) const
 Returns the value of an argument. More...
 
template<typename T >
void setParam (unsigned Offset, const T &Value)
 Mutates a local copy of a parameter. More...
 
Pointer getParamPointer (unsigned Offset)
 Returns a pointer to an argument - lazily creates a block. More...
 
const PointergetThis () const
 Returns the 'this' pointer. More...
 
const PointergetRVOPtr () const
 Returns the RVO pointer, if the Function has one. More...
 
bool isRoot () const
 Checks if the frame is a root frame - return should quit the interpreter. More...
 
CodePtr getPC () const
 Returns the PC of the frame's code start. More...
 
CodePtr getRetPC () const
 Returns the return address of the frame. More...
 
virtual SourceInfo getSource (CodePtr PC) const
 Map a location to a source. More...
 
const ExprgetExpr (CodePtr PC) const
 
SourceLocation getLocation (CodePtr PC) const
 
- Public Member Functions inherited from clang::interp::Frame
virtual ~Frame ()
 

Public Attributes

InterpFrameCaller
 The frame of the previous function. More...
 

Detailed Description

Frame storing local variables.

Definition at line 29 of file InterpFrame.h.

Constructor & Destructor Documentation

◆ InterpFrame() [1/2]

InterpFrame::InterpFrame ( InterpState S,
const Function Func,
InterpFrame Caller,
CodePtr  RetPC 
)

Creates a new frame for a method call.

Definition at line 24 of file InterpFrame.cpp.

◆ InterpFrame() [2/2]

InterpFrame::InterpFrame ( InterpState S,
const Function Func,
CodePtr  RetPC 
)

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 53 of file InterpFrame.cpp.

◆ ~InterpFrame()

InterpFrame::~InterpFrame ( )

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

Definition at line 72 of file InterpFrame.cpp.

References clang::interp::InterpState::deallocate().

Member Function Documentation

◆ describe()

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

◆ destroy()

void InterpFrame::destroy ( unsigned  Idx)

Invokes the destructors for a scope.

Definition at line 77 of file InterpFrame.cpp.

References clang::interp::InterpState::deallocate(), clang::interp::Function::getScope(), and clang::interp::Scope::locals().

◆ getCallee()

const FunctionDecl * InterpFrame::getCallee ( ) const
overridevirtual

Returns the caller.

Implements clang::interp::Frame.

Definition at line 182 of file InterpFrame.cpp.

References clang::interp::Function::getDecl().

Referenced by describe().

◆ getCaller()

Frame * InterpFrame::getCaller ( ) const
overridevirtual

Returns the parent frame object.

Implements clang::interp::Frame.

Definition at line 170 of file InterpFrame.cpp.

References Caller, and clang::interp::InterpState::getSplitFrame().

◆ getCallLocation()

SourceLocation InterpFrame::getCallLocation ( ) const
overridevirtual

Returns the location of the call to the frame.

Implements clang::interp::Frame.

Definition at line 176 of file InterpFrame.cpp.

References Caller, and clang::interp::SourceMapper::getLocation().

◆ getExpr()

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

Definition at line 216 of file InterpFrame.cpp.

References clang::interp::SourceMapper::getExpr().

◆ getFrameOffset()

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

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

Definition at line 69 of file InterpFrame.h.

◆ getFunction()

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

Returns the current function.

Definition at line 66 of file InterpFrame.h.

◆ getLocal()

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

Returns the value of a local variable.

Definition at line 72 of file InterpFrame.h.

References Offset.

◆ getLocalPointer()

Pointer InterpFrame::getLocalPointer ( unsigned  Offset) const

Returns a pointer to a local variables.

Definition at line 186 of file InterpFrame.cpp.

References Offset.

◆ getLocation()

SourceLocation InterpFrame::getLocation ( CodePtr  PC) const

Definition at line 220 of file InterpFrame.cpp.

References clang::interp::SourceMapper::getLocation().

◆ getParam()

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

Returns the value of an argument.

Definition at line 86 of file InterpFrame.h.

References clang::interp::Pointer::deref(), and Offset.

◆ getParamPointer()

Pointer InterpFrame::getParamPointer ( unsigned  Offset)

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

Definition at line 191 of file InterpFrame.cpp.

References clang::interp::Function::getParamDescriptor(), and TYPE_SWITCH.

Referenced by setParam().

◆ getPC()

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

Returns the PC of the frame's code start.

Definition at line 113 of file InterpFrame.h.

References clang::interp::Function::getCodeBegin().

◆ getRetPC()

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

Returns the return address of the frame.

Definition at line 116 of file InterpFrame.h.

◆ getRVOPtr()

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

Returns the RVO pointer, if the Function has one.

Definition at line 107 of file InterpFrame.h.

◆ getSource()

SourceInfo InterpFrame::getSource ( CodePtr  PC) const
virtual

Map a location to a source.

Definition at line 212 of file InterpFrame.cpp.

References clang::interp::InterpState::getSource().

◆ getThis()

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

Returns the 'this' pointer.

Definition at line 104 of file InterpFrame.h.

◆ isRoot()

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

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

Definition at line 110 of file InterpFrame.h.

◆ popArgs()

void InterpFrame::popArgs ( )

◆ setLocal()

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

Mutates a local variable.

Definition at line 77 of file InterpFrame.h.

References clang::interp::InlineDescriptor::IsInitialized, and Offset.

◆ 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 96 of file InterpFrame.h.

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

Member Data Documentation

◆ Caller

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

The frame of the previous function.

Definition at line 32 of file InterpFrame.h.

Referenced by getCaller(), getCallLocation(), and clang::interp::InterpState::getCurrentFrame().


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