#include <SBFrame.h>

Public Member Functions
	SBFrame ()

	SBFrame (const lldb::SBFrame &rhs)

const lldb::SBFrame &	operator= (const lldb::SBFrame &rhs)

	~SBFrame ()

bool	IsEqual (const lldb::SBFrame &that) const

	operator bool () const

bool	IsValid () const

uint32_t	GetFrameID () const

lldb::addr_t	GetCFA () const

lldb::addr_t	GetPC () const

bool	SetPC (lldb::addr_t new_pc)

lldb::addr_t	GetSP () const

lldb::addr_t	GetFP () const

lldb::SBAddress	GetPCAddress () const

lldb::SBSymbolContext	GetSymbolContext (uint32_t resolve_scope) const

lldb::SBModule	GetModule () const

lldb::SBCompileUnit	GetCompileUnit () const

lldb::SBFunction	GetFunction () const

lldb::SBSymbol	GetSymbol () const

lldb::SBBlock	GetBlock () const
	Gets the deepest block that contains the frame PC.

const char *	GetFunctionName ()
	Get the appropriate function name for this frame.

const char *	GetDisplayFunctionName ()

const char *	GetFunctionName () const

lldb::LanguageType	GuessLanguage () const

bool	IsInlined ()
	Return true if this frame represents an inlined function.

bool	IsInlined () const

bool	IsArtificial ()

bool	IsArtificial () const

bool	IsHidden () const
	Return whether a frame recognizer decided this frame should not be displayes in backtraces etc.

lldb::SBValue	EvaluateExpression (const char *expr)
	The version that doesn't supply a 'use_dynamic' value will use the target's default.

lldb::SBValue	EvaluateExpression (const char *expr, lldb::DynamicValueType use_dynamic)

lldb::SBValue	EvaluateExpression (const char *expr, lldb::DynamicValueType use_dynamic, bool unwind_on_error)

lldb::SBValue	EvaluateExpression (const char *expr, const SBExpressionOptions &options)

SBStructuredData	GetLanguageSpecificData () const
	Language plugins can use this API to report language-specific runtime information about this compile unit, such as additional language version details or feature flags.

lldb::SBBlock	GetFrameBlock () const
	Gets the lexical block that defines the stack frame.

lldb::SBLineEntry	GetLineEntry () const

lldb::SBThread	GetThread () const

const char *	Disassemble () const

void	Clear ()

bool	operator== (const lldb::SBFrame &rhs) const

bool	operator!= (const lldb::SBFrame &rhs) const

lldb::SBValueList	GetVariables (bool arguments, bool locals, bool statics, bool in_scope_only)
	The version that doesn't supply a 'use_dynamic' value will use the target's default.

lldb::SBValueList	GetVariables (bool arguments, bool locals, bool statics, bool in_scope_only, lldb::DynamicValueType use_dynamic)

lldb::SBValueList	GetVariables (const lldb::SBVariablesOptions &options)

lldb::SBValueList	GetRegisters ()

lldb::SBValue	FindRegister (const char *name)

lldb::SBValue	FindVariable (const char *var_name)
	The version that doesn't supply a 'use_dynamic' value will use the target's default.

lldb::SBValue	FindVariable (const char *var_name, lldb::DynamicValueType use_dynamic)

lldb::SBValue	GetValueForVariablePath (const char *var_expr_cstr, DynamicValueType use_dynamic)

lldb::SBValue	GetValueForVariablePath (const char *var_path)
	The version that doesn't supply a 'use_dynamic' value will use the target's default.

lldb::SBValue	FindValue (const char *name, ValueType value_type)
	Find variables, register sets, registers, or persistent variables using the frame as the scope.

lldb::SBValue	FindValue (const char *name, ValueType value_type, lldb::DynamicValueType use_dynamic)

bool	GetDescription (lldb::SBStream &description)

SBError	GetDescriptionWithFormat (const SBFormat &format, SBStream &output)
	Similar to GetDescription() but the format of the description can be configured via the `format` parameter.

Protected Member Functions
	SBFrame (const lldb::StackFrameSP &lldb_object_sp)

lldb::StackFrameSP	GetFrameSP () const

void	SetFrameSP (const lldb::StackFrameSP &lldb_object_sp)

Protected Attributes
lldb::ExecutionContextRefSP	m_opaque_sp

Friends
class	SBBlock

class	SBExecutionContext

class	SBInstruction

class	SBThread

class	SBValue

class	lldb_private::python::SWIGBridge

class	lldb_private::lua::SWIGBridge

Detailed Description

Definition at line 26 of file SBFrame.h.

Constructor & Destructor Documentation

◆ SBFrame() [1/3]

SBFrame::SBFrame ( )

Definition at line 61 of file SBFrame.cpp.

References LLDB_INSTRUMENT_VA.

◆ SBFrame() [2/3]

SBFrame::SBFrame ( const lldb::SBFrame & rhs )

Definition at line 70 of file SBFrame.cpp.

References lldb_private::clone(), LLDB_INSTRUMENT_VA, and m_opaque_sp.

◆ ~SBFrame()

SBFrame::~SBFrame ( )

default

References lldb::operator==().

◆ SBFrame() [3/3]

SBFrame::SBFrame ( const lldb::StackFrameSP & lldb_object_sp )

protected

Definition at line 65 of file SBFrame.cpp.

References LLDB_INSTRUMENT_VA.

Member Function Documentation

◆ Clear()

void SBFrame::Clear ( )

Definition at line 438 of file SBFrame.cpp.

References LLDB_INSTRUMENT_VA, and m_opaque_sp.

◆ Disassemble()

const char * SBFrame::Disassemble ( ) const

Definition at line 710 of file SBFrame.cpp.

References lldb_private::ConstString::GetCString(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Process::GetRunLock(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ EvaluateExpression() [1/4]

SBValue SBFrame::EvaluateExpression ( const char * expr )

The version that doesn't supply a 'use_dynamic' value will use the target's default.

Definition at line 1012 of file SBFrame.cpp.

References lldb_private::StackFrame::CalculateTarget(), lldb_private::ValueObjectConstResult::Create(), error(), EvaluateExpression(), lldb_private::Status::FromErrorString(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::StackFrame::GetLanguage(), lldb_private::TargetProperties::GetLanguage(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, lldb_private::SourceLanguage::name, lldb::SBExpressionOptions::SetFetchDynamicValue(), lldb::SBExpressionOptions::SetIgnoreBreakpoints(), lldb::SBExpressionOptions::SetLanguage(), lldb::SBValue::SetSP(), lldb::SBExpressionOptions::SetUnwindOnError(), and lldb_private::SourceLanguage::version.

Referenced by EvaluateExpression().

◆ EvaluateExpression() [2/4]

lldb::SBValue SBFrame::EvaluateExpression	(	const char *	expr,
		const SBExpressionOptions &	options
	)

Definition at line 1090 of file SBFrame.cpp.

References lldb_private::ValueObjectConstResult::Create(), lldb_private::StackFrame::DumpUsingSettingsFormat(), error(), lldb_private::Target::EvaluateExpression(), lldb_private::Status::FromErrorString(), lldb::SBError::GetCString(), lldb_private::StreamString::GetData(), lldb_private::TargetProperties::GetDisplayExpressionsInCrashlogs(), lldb::SBValue::GetError(), lldb::SBExpressionOptions::GetFetchDynamicValue(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::GetLog(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Process::GetRunLock(), lldb::SBValue::GetSummary(), lldb_private::ExecutionContext::GetTargetPtr(), lldb::SBValue::GetValue(), LLDB_INSTRUMENT_VA, LLDB_LOGF, m_opaque_sp, lldb::SBExpressionOptions::ref(), lldb::SBValue::SetSP(), lldb::SBError::Success(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ EvaluateExpression() [3/4]

SBValue SBFrame::EvaluateExpression	(	const char *	expr,
		lldb::DynamicValueType	use_dynamic
	)

Definition at line 1045 of file SBFrame.cpp.

References EvaluateExpression(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::StackFrame::GetLanguage(), lldb_private::TargetProperties::GetLanguage(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, lldb_private::SourceLanguage::name, lldb::SBExpressionOptions::SetFetchDynamicValue(), lldb::SBExpressionOptions::SetIgnoreBreakpoints(), lldb::SBExpressionOptions::SetLanguage(), lldb::SBExpressionOptions::SetUnwindOnError(), and lldb_private::SourceLanguage::version.

◆ EvaluateExpression() [4/4]

SBValue SBFrame::EvaluateExpression	(	const char *	expr,
		lldb::DynamicValueType	use_dynamic,
		bool	unwind_on_error
	)

Definition at line 1067 of file SBFrame.cpp.

References EvaluateExpression(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::StackFrame::GetLanguage(), lldb_private::TargetProperties::GetLanguage(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, lldb_private::SourceLanguage::name, lldb::SBExpressionOptions::SetFetchDynamicValue(), lldb::SBExpressionOptions::SetIgnoreBreakpoints(), lldb::SBExpressionOptions::SetLanguage(), lldb::SBExpressionOptions::SetUnwindOnError(), and lldb_private::SourceLanguage::version.

◆ FindRegister()

SBValue SBFrame::FindRegister ( const char * name )

Definition at line 921 of file SBFrame.cpp.

References lldb_private::ValueObjectRegister::Create(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::StackFrame::GetRegisterContext(), lldb_private::Process::GetRunLock(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, lldb::SBValue::SetSP(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ FindValue() [1/2]

SBValue SBFrame::FindValue	(	const char *	name,
		ValueType	value_type
	)

Find variables, register sets, registers, or persistent variables using the frame as the scope.

NB. This function does not look up ivars in the function object pointer. To do that use GetValueForVariablePath.

The version that doesn't supply a 'use_dynamic' value will use the target's default.

Definition at line 546 of file SBFrame.cpp.

References lldb_private::StackFrame::CalculateTarget(), FindValue(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, and m_opaque_sp.

Referenced by FindValue().

◆ FindValue() [2/2]

SBValue SBFrame::FindValue	(	const char *	name,
		ValueType	value_type,
		lldb::DynamicValueType	use_dynamic
	)

Definition at line 563 of file SBFrame.cpp.

References lldb_private::Block::AppendVariables(), lldb_private::VariableList::AppendVariablesIfUnique(), lldb_private::SymbolContext::block, lldb_private::ValueObjectRegister::Create(), lldb_private::ValueObjectRegisterSet::Create(), lldb::eNoDynamicValues, lldb::eValueTypeConstResult, lldb::eValueTypeRegister, lldb::eValueTypeRegisterSet, lldb::eValueTypeVariableArgument, lldb::eValueTypeVariableGlobal, lldb::eValueTypeVariableLocal, lldb::eValueTypeVariableStatic, lldb::eValueTypeVariableThreadLocal, lldb_private::VariableList::FindVariable(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::Target::GetPersistentVariable(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::StackFrame::GetRegisterContext(), lldb_private::Process::GetRunLock(), lldb_private::StackFrame::GetSymbolContext(), lldb_private::ExecutionContext::GetTargetPtr(), lldb_private::StackFrame::GetValueObjectForFrameVariable(), lldb_private::StackFrame::GetVariableList(), lldb_private::Variable::IsInScope(), LLDB_INSTRUMENT_VA, m_opaque_sp, lldb_private::RegisterSet::name, lldb::SBValue::SetSP(), lldb_private::RegisterSet::short_name, and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ FindVariable() [1/2]

SBValue SBFrame::FindVariable ( const char * var_name )

The version that doesn't supply a 'use_dynamic' value will use the target's default.

Definition at line 495 of file SBFrame.cpp.

References lldb_private::StackFrame::CalculateTarget(), FindVariable(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, and m_opaque_sp.

Referenced by FindVariable().

◆ FindVariable() [2/2]

SBValue SBFrame::FindVariable	(	const char *	var_name,
		lldb::DynamicValueType	use_dynamic
	)

Definition at line 512 of file SBFrame.cpp.

References lldb_private::StackFrame::FindVariable(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Process::GetRunLock(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, lldb::SBValue::SetSP(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ GetBlock()

SBBlock SBFrame::GetBlock ( ) const

Gets the deepest block that contains the frame PC.

◆ GetCFA()

lldb::addr_t SBFrame::GetCFA ( ) const

Definition at line 312 of file SBFrame.cpp.

References lldb_private::StackID::GetCallFrameAddress(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::StackFrame::GetStackID(), LLDB_INSTRUMENT_VA, LLDB_INVALID_ADDRESS, and m_opaque_sp.

◆ GetCompileUnit()

SBCompileUnit SBFrame::GetCompileUnit ( ) const

Definition at line 161 of file SBFrame.cpp.

References lldb_private::SymbolContext::comp_unit, lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Process::GetRunLock(), lldb_private::StackFrame::GetSymbolContext(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, lldb::SBCompileUnit::reset(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ GetDescription()

bool SBFrame::GetDescription ( lldb::SBStream & description )

Definition at line 986 of file SBFrame.cpp.

References lldb_private::StackFrame::DumpUsingSettingsFormat(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Process::GetRunLock(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, lldb_private::Stream::PutCString(), lldb::SBStream::ref(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ GetDescriptionWithFormat()

SBError SBFrame::GetDescriptionWithFormat	(	const SBFormat &	format,
		SBStream &	output
	)

Similar to GetDescription() but the format of the description can be configured via the format parameter.

See https://lldb.llvm.org/use/formatting.html for more information on format strings.

Parameters

[in]	format	The format to use for generating the description.
[out]	output	The stream where the description will be written to.

Returns: An error object with an error message in case of failures.

Definition at line 952 of file SBFrame.cpp.

References lldb_private::StackFrame::DumpUsingFormat(), error(), lldb::SBFormat::GetFormatEntrySP(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Process::GetRunLock(), lldb_private::ExecutionContext::GetTargetPtr(), m_opaque_sp, lldb::SBStream::ref(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ GetDisplayFunctionName()

const char * SBFrame::GetDisplayFunctionName ( )

Definition at line 1277 of file SBFrame.cpp.

References lldb_private::StackFrame::GetDisplayFunctionName(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Process::GetRunLock(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ GetFP()

addr_t SBFrame::GetFP ( ) const

Definition at line 394 of file SBFrame.cpp.

References lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Process::GetRunLock(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, LLDB_INVALID_ADDRESS, m_opaque_sp, and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ GetFrameBlock()

SBBlock SBFrame::GetFrameBlock ( ) const

Gets the lexical block that defines the stack frame.

Another way to think of this is it will return the block that contains all of the variables for a stack frame. Inlined functions are represented as SBBlock objects that have inlined function information: the name of the inlined function, where it was called from. The block that is returned will be the first block at or above the block for the PC (SBFrame::GetBlock()) that defines the scope of the frame. When a function contains no inlined functions, this will be the top most lexical block that defines the function. When a function has inlined functions and the PC is currently in one of those inlined functions, this method will return the inlined block that defines this frame. If the PC isn't currently in an inlined function, the lexical block that defines the function is returned.

Definition at line 253 of file SBFrame.cpp.

References lldb_private::StackFrame::GetFrameBlock(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Process::GetRunLock(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, lldb::SBBlock::SetPtr(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ GetFrameID()

uint32_t SBFrame::GetFrameID ( ) const

Definition at line 297 of file SBFrame.cpp.

References lldb_private::StackFrame::GetFrameIndex(), lldb_private::ExecutionContext::GetFramePtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, and UINT32_MAX.

◆ GetFrameSP()

StackFrameSP SBFrame::GetFrameSP ( ) const

protected

Definition at line 86 of file SBFrame.cpp.

References m_opaque_sp.

Referenced by lldb::SBInstruction::EmulateWithFrame(), lldb::SBBlock::GetVariables(), IsEqual(), lldb::SBThread::ReturnFromFrame(), lldb::SBExecutionContext::SBExecutionContext(), lldb::SBThread::StepOutOfFrame(), and lldb::SBThread::StepOverUntil().

◆ GetFunction()

SBFunction SBFrame::GetFunction ( ) const

Definition at line 185 of file SBFrame.cpp.

References lldb_private::SymbolContext::function, lldb_private::ExecutionContext::GetFramePtr(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Process::GetRunLock(), lldb_private::StackFrame::GetSymbolContext(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, lldb::SBFunction::reset(), and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ GetFunctionName() [1/2]

const char * SBFrame::GetFunctionName ( )

Get the appropriate function name for this frame.

Inlined functions in LLDB are represented by Blocks that have inlined function information, so just looking at the SBFunction or SBSymbol for a frame isn't enough. This function will return the appropriate function, symbol or inlined function name for the frame.

This function returns:

the name of the inlined function (if there is one)
the name of the concrete function (if there is one)
the name of the symbol (if there is one)
NULL

◆ GetFunctionName() [2/2]

const char * SBFrame::GetFunctionName ( ) const

Definition at line 1256 of file SBFrame.cpp.

References lldb_private::ExecutionContext::GetFramePtr(), lldb_private::StackFrame::GetFunctionName(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::Process::GetRunLock(), lldb_private::ExecutionContext::GetTargetPtr(), LLDB_INSTRUMENT_VA, m_opaque_sp, and lldb_private::ProcessRunLock::ProcessRunLocker::TryLock().

◆ GetLanguageSpecificData()

SBStructuredData SBFrame::GetLanguageSpecificData ( ) const

Language plugins can use this API to report language-specific runtime information about this compile unit, such as additional language version details or feature flags.

Definition at line 1158 of file SBFrame.cpp.

References lldb_private::ExecutionContext::GetFramePtr(), lldb_private::StackFrame::GetLanguageSpecificData(), LLDB_INSTRUMENT_VA, lldb::SBStructuredData::m_impl_up, and m_opaque_sp.