Bytecode function. More...

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

Public Types
using	ParamDescriptor = std::pair< PrimType, Descriptor * >

using	arg_reverse_iterator = SmallVectorImpl< PrimType >::const_reverse_iterator
	Range over argument types.

Public Member Functions
unsigned	getFrameSize () const
	Returns the size of the function's local stack.

unsigned	getArgSize () const
	Returns the size of the argument stack.

CodePtr	getCodeBegin () const
	Returns a pointer to the start of the code.

CodePtr	getCodeEnd () const
	Returns a pointer to the end of the code.

const FunctionDecl *	getDecl () const
	Returns the original FunctionDecl.

const std::string	getName () const
	Returns the name of the function decl this code was generated for.

SourceLocation	getLoc () const
	Returns the location.

ParamDescriptor	getParamDescriptor (unsigned Offset) const
	Returns a parameter descriptor.

bool	hasRVO () const
	Checks if the first argument is a RVO pointer.

llvm::iterator_range< llvm::SmallVector< Scope, 2 >::const_iterator >	scopes () const
	Range over the scope blocks.

llvm::iterator_range< arg_reverse_iterator >	args_reverse () const

Scope &	getScope (unsigned Idx)
	Returns a specific scope.

const Scope &	getScope (unsigned Idx) const

SourceInfo	getSource (CodePtr PC) const
	Returns the source information at a given PC.

bool	isConstexpr () const
	Checks if the function is valid to call in constexpr.

bool	isVirtual () const
	Checks if the function is virtual.

bool	isConstructor () const
	Checks if the function is a constructor.

bool	isFullyCompiled () const
	Checks if the function is fully done compiling.

bool	hasThisPointer () const

bool	hasBody () const

unsigned	getBuiltinID () const

unsigned	getNumParams () const

void	dump () const
	Dumps the disassembled bytecode to `llvm::errs()`.

void	dump (llvm::raw_ostream &OS) const

Friends
class	Program

class	ByteCodeEmitter

Detailed Description

Bytecode function.

Contains links to the bytecode of the function, as well as metadata describing all arguments and stack-local variables.

Calling Convention

When calling a function, all argument values must be on the stack.

If the function has a This pointer (i.e. hasThisPointer() returns true, the argument values need to be preceeded by a Pointer for the This object.

If the function uses Return Value Optimization, the arguments (and potentially the This pointer) need to be proceeded by a Pointer pointing to the location to construct the returned value.

After the function has been called, it will remove all arguments, including RVO and This pointer, from the stack.

Definition at line 74 of file Function.h.

Member Typedef Documentation

◆ arg_reverse_iterator

using clang::interp::Function::arg_reverse_iterator = SmallVectorImpl<PrimType>::const_reverse_iterator

Range over argument types.

Definition at line 111 of file Function.h.

◆ ParamDescriptor

using clang::interp::Function::ParamDescriptor = std::pair<PrimType, Descriptor *>

Definition at line 76 of file Function.h.

Member Function Documentation

◆ args_reverse()

llvm::iterator_range< arg_reverse_iterator > clang::interp::Function::args_reverse ( ) const

inline

Definition at line 113 of file Function.h.

Referenced by clang::interp::InterpFrame::popArgs().

◆ dump() [1/2]

LLVM_DUMP_METHOD void Function::dump ( ) const

Dumps the disassembled bytecode to llvm::errs().

Definition at line 34 of file Disasm.cpp.

References dump().

◆ dump() [2/2]

LLVM_DUMP_METHOD void Function::dump ( llvm::raw_ostream & OS ) const

Definition at line 36 of file Disasm.cpp.

◆ getArgSize()

unsigned clang::interp::Function::getArgSize ( ) const

inline

Returns the size of the argument stack.

Definition at line 81 of file Function.h.

◆ getBuiltinID()

unsigned clang::interp::Function::getBuiltinID ( ) const

inline

Definition at line 141 of file Function.h.

References clang::FunctionDecl::getBuiltinID().

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

◆ getCodeBegin()

CodePtr clang::interp::Function::getCodeBegin ( ) const

inline

Returns a pointer to the start of the code.

Definition at line 84 of file Function.h.

Referenced by clang::interp::InterpFrame::getPC().

◆ getCodeEnd()

CodePtr clang::interp::Function::getCodeEnd ( ) const

inline

Returns a pointer to the end of the code.

Definition at line 86 of file Function.h.

◆ getDecl()

const FunctionDecl * clang::interp::Function::getDecl ( ) const

inline

Returns the original FunctionDecl.

Definition at line 89 of file Function.h.

Referenced by clang::interp::CheckCallable(), and clang::interp::InterpFrame::getCallee().

◆ getFrameSize()

unsigned clang::interp::Function::getFrameSize ( ) const

inline

Returns the size of the function's local stack.

Definition at line 79 of file Function.h.

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

◆ getLoc()

SourceLocation clang::interp::Function::getLoc ( ) const

inline

Returns the location.

Definition at line 96 of file Function.h.

◆ getName()

const std::string clang::interp::Function::getName ( ) const

inline

Returns the name of the function decl this code was generated for.

Definition at line 93 of file Function.h.

References clang::DeclarationNameInfo::getAsString(), and clang::FunctionDecl::getNameInfo().

◆ getNumParams()

unsigned clang::interp::Function::getNumParams ( ) const

inline

Definition at line 143 of file Function.h.

◆ getParamDescriptor()

Function::ParamDescriptor Function::getParamDescriptor ( unsigned Offset ) const

Returns a parameter descriptor.

Definition at line 26 of file Function.cpp.

References Offset.

Referenced by clang::interp::InterpFrame::getParamPointer().

◆ getScope() [1/2]

Scope & clang::interp::Function::getScope ( unsigned Idx )

inline

Returns a specific scope.

Definition at line 118 of file Function.h.

Referenced by clang::interp::InterpFrame::destroy().

◆ getScope() [2/2]

const Scope & clang::interp::Function::getScope ( unsigned Idx ) const

inline

Definition at line 119 of file Function.h.

◆ getSource()

SourceInfo Function::getSource ( CodePtr PC ) const

Returns the source information at a given PC.

Definition at line 32 of file Function.cpp.

References Offset.

Referenced by clang::interp::EvalEmitter::getSource(), and clang::interp::InterpState::getSource().

◆ hasBody()

bool clang::interp::Function::hasBody ( ) const

inline

Definition at line 139 of file Function.h.

Referenced by clang::interp::ByteCodeExprGen< Emitter >::getFunction(), and clang::interp::Context::isPotentialConstantExpr().

◆ hasRVO()

bool clang::interp::Function::hasRVO ( ) const

inline

Checks if the first argument is a RVO pointer.

Definition at line 102 of file Function.h.

Referenced by clang::interp::InterpFrame::describe(), clang::interp::InterpFrame::InterpFrame(), and clang::interp::ByteCodeExprGen< Emitter >::VisitCallExpr().

◆ hasThisPointer()

bool clang::interp::Function::hasThisPointer ( ) const

inline

Definition at line 136 of file Function.h.

Referenced by clang::interp::Call(), clang::interp::InterpFrame::describe(), and clang::interp::InterpFrame::InterpFrame().

◆ isConstexpr()

bool clang::interp::Function::isConstexpr ( ) const

inline

Checks if the function is valid to call in constexpr.

Definition at line 125 of file Function.h.

Referenced by clang::interp::CheckCallable(), clang::interp::Context::isPotentialConstantExpr(), clang::interp::ByteCodeExprGen< Emitter >::visitArrayInitializer(), clang::interp::ByteCodeExprGen< Emitter >::VisitCallExpr(), and clang::interp::ByteCodeExprGen< Emitter >::visitRecordInitializer().

◆ isConstructor()

bool clang::interp::Function::isConstructor ( ) const

inline

Checks if the function is a constructor.

Definition at line 131 of file Function.h.

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

◆ isFullyCompiled()

bool clang::interp::Function::isFullyCompiled ( ) const

inline

Checks if the function is fully done compiling.

Definition at line 134 of file Function.h.

Referenced by clang::interp::ByteCodeExprGen< Emitter >::getFunction(), and clang::interp::ByteCodeExprGen< Emitter >::VisitCallExpr().

◆ isVirtual()

bool Function::isVirtual ( ) const

Checks if the function is virtual.

Definition at line 42 of file Function.cpp.

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

◆ scopes()

llvm::iterator_range< llvm::SmallVector< Scope, 2 >::const_iterator > clang::interp::Function::scopes ( ) const

inline

Range over the scope blocks.

Definition at line 106 of file Function.h.

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

Friends And Related Function Documentation

◆ ByteCodeEmitter

friend class ByteCodeEmitter

friend

Definition at line 167 of file Function.h.

◆ Program

friend class Program

friend

Definition at line 166 of file Function.h.

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

lib/AST/Interp/Function.h
lib/AST/Interp/Disasm.cpp
lib/AST/Interp/Function.cpp

Public Types

Public Member Functions

Friends

Detailed Description

Calling Convention

Member Typedef Documentation

◆ arg_reverse_iterator

◆ ParamDescriptor

Member Function Documentation

◆ args_reverse()

◆ dump() [1/2]

◆ dump() [2/2]

◆ getArgSize()

◆ getBuiltinID()

◆ getCodeBegin()

◆ getCodeEnd()

◆ getDecl()

◆ getFrameSize()

◆ getLoc()

◆ getName()

◆ getNumParams()

◆ getParamDescriptor()

◆ getScope() [1/2]

◆ getScope() [2/2]

◆ getSource()

◆ hasBody()

◆ hasRVO()

◆ hasThisPointer()

◆ isConstexpr()

◆ isConstructor()

◆ isFullyCompiled()

◆ isVirtual()

◆ scopes()

Friends And Related Function Documentation

◆ ByteCodeEmitter

◆ Program