A class that describes a function. More...

#include "lldb/Symbol/Function.h"

Inheritance diagram for lldb_private::Function:

Public Member Functions
	Function (CompileUnit comp_unit, lldb::user_id_t func_uid, lldb::user_id_t func_type_uid, const Mangled &mangled, Type func_type, AddressRanges ranges)
	Construct with a compile unit, function UID, function type UID, optional mangled name, function type, and a section offset based address range.

	~Function () override
	Destructor.

void	CalculateSymbolContext (SymbolContext *sc) override
	Reconstruct the object's symbol context into sc.

lldb::ModuleSP	CalculateSymbolContextModule () override

CompileUnit *	CalculateSymbolContextCompileUnit () override

Function *	CalculateSymbolContextFunction () override

const AddressRange &	GetAddressRange ()
	DEPRECATED: Use GetAddressRanges instead.

AddressRanges	GetAddressRanges ()

lldb::LanguageType	GetLanguage () const

void	GetStartLineSourceInfo (lldb::SupportFileSP &source_file_sp, uint32_t &line_no)
	Find the file and line number of the source location of the start of the function.

void	GetEndLineSourceInfo (FileSpec &source_file, uint32_t &line_no)
	Find the file and line number of the source location of the end of the function.

llvm::ArrayRef< std::unique_ptr< CallEdge > >	GetCallEdges ()
	Get the outgoing call edges from this function, sorted by their return PC addresses (in increasing order).

llvm::ArrayRef< std::unique_ptr< CallEdge > >	GetTailCallingEdges ()
	Get the outgoing tail-calling edges from this function.

CallEdge *	GetCallEdgeForReturnAddress (lldb::addr_t return_pc, Target &target)
	Get the outgoing call edge from this function which has the given return address `return_pc`, or return nullptr.

Block &	GetBlock (bool can_create)
	Get accessor for the block list.

CompileUnit *	GetCompileUnit ()
	Get accessor for the compile unit that owns this function.

const CompileUnit *	GetCompileUnit () const
	Get const accessor for the compile unit that owns this function.

void	GetDescription (Stream s, lldb::DescriptionLevel level, Target target)

DWARFExpressionList &	GetFrameBaseExpression ()
	Get accessor for the frame base location.

const DWARFExpressionList &	GetFrameBaseExpression () const
	Get const accessor for the frame base location.

ConstString	GetName () const

ConstString	GetNameNoArguments () const

ConstString	GetDisplayName () const

const Mangled &	GetMangled () const

CompilerDeclContext	GetDeclContext ()
	Get the DeclContext for this function, if available.

std::vector< CompilerContext >	GetCompilerContext ()
	Get the CompilerContext for this function, if available.

Type *	GetType ()
	Get accessor for the type that describes the function return value type, and parameter types.

const Type *	GetType () const
	Get const accessor for the type that describes the function return value type, and parameter types.

CompilerType	GetCompilerType ()

uint32_t	GetPrologueByteSize ()
	Get the size of the prologue instructions for this function.

void	Dump (Stream *s, bool show_context) const
	Dump a description of this object to a Stream.

void	DumpSymbolContext (Stream *s) override
	Dump the object's symbol context to the stream s.

size_t	MemorySize () const
	Get the memory cost of this object.

bool	GetIsOptimized ()
	Get whether compiler optimizations were enabled for this function.

bool	IsTopLevelFunction ()
	Get whether this function represents a 'top-level' function.

lldb::DisassemblerSP	GetInstructions (const ExecutionContext &exe_ctx, const char *flavor, bool force_live_memory=false)

bool	GetDisassembly (const ExecutionContext &exe_ctx, const char *flavor, Stream &strm, bool force_live_memory=false)

Public Member Functions inherited from lldb_private::UserID
	UserID (lldb::user_id_t uid=LLDB_INVALID_UID)
	Construct with optional user ID.

	~UserID ()=default
	Destructor.

void	Clear ()
	Clears the object state.

lldb::user_id_t	GetID () const
	Get accessor for the user ID.

void	SetID (lldb::user_id_t uid)
	Set accessor for the user ID.

Public Member Functions inherited from lldb_private::SymbolContextScope
virtual	~SymbolContextScope ()=default

virtual void	CalculateSymbolContext (SymbolContext *sc)=0
	Reconstruct the object's symbol context into sc.

virtual lldb::ModuleSP	CalculateSymbolContextModule ()

virtual CompileUnit *	CalculateSymbolContextCompileUnit ()

virtual Function *	CalculateSymbolContextFunction ()

virtual Block *	CalculateSymbolContextBlock ()

virtual Symbol *	CalculateSymbolContextSymbol ()

virtual void	DumpSymbolContext (Stream *s)=0
	Dump the object's symbol context to the stream s.

Protected Types
enum	{ flagsCalculatedPrologueSize = (1 << 0) }

Protected Attributes
CompileUnit *	m_comp_unit
	The compile unit that owns this function.

lldb::user_id_t	m_type_uid
	The user ID of for the prototype Type for this function.

Type *	m_type
	The function prototype type for this function that includes the function info (FunctionInfo), return type and parameters.

Mangled	m_mangled
	The mangled function name if any.

Block	m_block
	All lexical blocks contained in this function.

AddressRange	m_range
	The function address range that covers the widest range needed to contain all blocks.

DWARFExpressionList	m_frame_base
	The frame base expression for variables that are relative to the frame pointer.

Flags	m_flags

uint32_t	m_prologue_byte_size
	Compute the prologue size once and cache it.

std::mutex	m_call_edges_lock
	Exclusive lock that controls read/write access to m_call_edges and m_call_edges_resolved.

bool	m_call_edges_resolved = false
	Whether call site info has been parsed.

std::vector< std::unique_ptr< CallEdge > >	m_call_edges
	Outgoing call edges.

Protected Attributes inherited from lldb_private::UserID
lldb::user_id_t	m_uid
	The user ID that uniquely identifies an object.

Private Member Functions
	Function (const Function &)=delete

const Function &	operator= (const Function &)=delete

Detailed Description

A class that describes a function.

Functions belong to CompileUnit objects (Function::m_comp_unit), have unique user IDs (Function::UserID), know how to reconstruct their symbol context (Function::SymbolContextScope), have a specific function type (Function::m_type_uid), have a simple method name (FunctionInfo::m_name), be declared at a specific location (FunctionInfo::m_declaration), possibly have mangled names (Function::m_mangled), an optional return type (Function::m_type), and contains lexical blocks (Function::m_blocks).

The function information is split into a few pieces:

The concrete instance information
The abstract information

The abstract information is found in the function type (Type) that describes a function information, return type and parameter types.

The concrete information is the address range information and specific locations for an instance of this function.

Definition at line 399 of file Function.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protected

Enumerator
flagsCalculatedPrologueSize	Whether we already tried to calculate the prologue size.

Definition at line 634 of file Function.h.

Constructor & Destructor Documentation

◆ Function() [1/2]

Function::Function	(	CompileUnit *	comp_unit,
		lldb::user_id_t	func_uid,
		lldb::user_id_t	func_type_uid,
		const Mangled &	mangled,
		Type *	func_type,
		AddressRanges	ranges
	)

Construct with a compile unit, function UID, function type UID, optional mangled name, function type, and a section offset based address range.

Parameters

[in]	comp_unit	The compile unit to which this function belongs.
[in]	func_uid	The UID for this function. This value is provided by the SymbolFile plug-in and can be any value that allows the plug-in to quickly find and parse more detailed information when and if more information is needed.
[in]	func_type_uid	The type UID for the function Type to allow for lazy type parsing from the debug information.
[in]	mangled	The optional mangled name for this function. If empty, there is no mangled information.
[in]	func_type	The optional function type. If NULL, the function type will be parsed on demand when accessed using the Function::GetType() function by asking the SymbolFile plug-in to get the type for func_type_uid.
[in]	range	The section offset based address for this function.

Definition at line 277 of file Function.cpp.

References lldb_private::Block::AddRange(), lldb_private::Block::FinalizeRanges(), lldb_private::AddressRange::GetBaseAddress(), lldb_private::Address::GetFileAddress(), m_block, and m_range.

◆ ~Function()

Function::~Function ( )

overridedefault

Destructor.

◆ Function() [2/2]

lldb_private::Function::Function ( const Function & )

privatedelete

Member Function Documentation

◆ CalculateSymbolContext()

void Function::CalculateSymbolContext ( SymbolContext * sc )

overridevirtual

Reconstruct the object's symbol context into sc.

The object should fill in as much of the SymbolContext as it can so function calls that require a symbol context can be made for the given object.

Parameters

[out] sc A symbol context object pointer that gets filled in.

See also: SymbolContextScope

Implements lldb_private::SymbolContextScope.

Definition at line 465 of file Function.cpp.

References lldb_private::CompileUnit::CalculateSymbolContext(), lldb_private::SymbolContext::function, and m_comp_unit.

Referenced by GetType(), and lldb_private::StackFrameList::SynthesizeTailCallFrames().

◆ CalculateSymbolContextCompileUnit()

CompileUnit * Function::CalculateSymbolContextCompileUnit ( )

overridevirtual

Reimplemented from lldb_private::SymbolContextScope.

Definition at line 478 of file Function.cpp.

References GetCompileUnit().

◆ CalculateSymbolContextFunction()

Function * Function::CalculateSymbolContextFunction ( )

overridevirtual

Reimplemented from lldb_private::SymbolContextScope.

Definition at line 482 of file Function.cpp.

◆ CalculateSymbolContextModule()

ModuleSP Function::CalculateSymbolContextModule ( )

overridevirtual

Reimplemented from lldb_private::SymbolContextScope.

Definition at line 470 of file Function.cpp.

References lldb_private::AddressRange::GetBaseAddress(), GetCompileUnit(), lldb_private::ModuleChild::GetModule(), lldb_private::Address::GetSection(), and m_range.

Referenced by GetBlock(), GetCompilerContext(), GetDeclContext(), and lldb_private::plugin::dwarf::SymbolFileDWARF::GetFunction().

◆ Dump()

void Function::Dump	(	Stream *	s,
		bool	show_context
	)		const

Dump a description of this object to a Stream.

Dump a description of the contents of this object to the supplied stream s.

Parameters

[in]	s	The stream to which to dump the object description.
[in]	show_context	If true, variables will dump their symbol context information.

Definition at line 446 of file Function.cpp.

References lldb_private::Block::BlockInfoHasBeenParsed(), lldb_private::Mangled::Dump(), lldb_private::Block::Dump(), lldb_private::Stream::EOL(), lldb_private::AddressRange::GetBaseAddress(), lldb_private::Address::GetFileAddress(), lldb_private::Stream::Indent(), LLDB_INVALID_UID, m_block, m_mangled, m_range, m_type, m_type_uid, and lldb_private::Stream::Printf().

◆ DumpSymbolContext()

void Function::DumpSymbolContext ( Stream * s )

overridevirtual

Dump the object's symbol context to the stream s.

The object should dump its symbol context to the stream s. This function is widely used in the DumpDebug and verbose output for lldb objects.

Parameters

[in] s The stream to which to dump the object's symbol context.

See also: SymbolContextScope

Implements lldb_private::SymbolContextScope.

Definition at line 518 of file Function.cpp.

References lldb_private::CompileUnit::DumpSymbolContext(), lldb_private::UserID::GetID(), m_comp_unit, and lldb_private::Stream::Printf().

Referenced by lldb_private::ClangExpressionDeclMap::AddOneFunction(), and lldb_private::Block::DumpSymbolContext().

◆ GetAddressRange()

const AddressRange & lldb_private::Function::GetAddressRange ( )

inline

DEPRECATED: Use GetAddressRanges instead.

Definition at line 448 of file Function.h.

References m_range.

Referenced by lldb_private::BreakpointResolver::AddLocation(), lldb_private::ClangExpressionDeclMap::AddOneFunction(), lldb_private::Block::AddRange(), lldb_private::DynamicLoaderDarwin::AlwaysRelyOnEHUnwindInfo(), DynamicLoaderPOSIXDYLD::AlwaysRelyOnEHUnwindInfo(), lldb_private::npdb::SymbolFileNativePDB::CreateBlock(), lldb_private::npdb::SymbolFileNativePDB::CreateLocalVariable(), lldb_private::Disassembler::Disassemble(), CommandObjectThreadUntil::DoExecute(), lldb_private::SymbolContext::Dump(), DumpAddressOffsetFromFunction(), lldb_private::Variable::DumpLocations(), lldb_private::SymbolContext::DumpStopContext(), lldb_private::Module::FindFunctions(), lldb_private::SearchFilter::FunctionPasses(), lldb_private::SymbolContext::GetAddressRange(), lldb_private::ArchitectureMips::GetBreakableLoadAddress(), lldb_private::CommandObjectDisassemble::GetCurrentFunctionRanges(), lldb::SBBlock::GetDescription(), lldb_private::Block::GetDescription(), GetEndLineSourceInfo(), lldb_private::StackFrame::GetFrameBaseValue(), lldb_private::SymbolContext::GetFunctionStartLineEntry(), GetInstructions(), lldb::SBFunction::GetInstructions(), lldb_private::CallEdge::GetLoadAddress(), GetPrologueByteSize(), lldb_private::Block::GetRangeAtIndex(), lldb_private::Block::GetRangeContainingAddress(), lldb_private::Block::GetRangeIndexContainingAddress(), lldb_private::Block::GetRanges(), lldb::SBFunction::GetStartAddress(), lldb_private::Block::GetStartAddress(), GetStartLineSourceInfo(), lldb_private::StackFrame::GuessValueForRegisterAndOffset(), lldb_private::ThreadPlanStepRange::InSymbol(), lldb_private::Variable::LocationIsValidForAddress(), lldb_private::Variable::LocationIsValidForFrame(), lldb_private::DWARFExpressionList::MatchesOperand(), lldb_private::breakpad::SymbolFileBreakpad::ParseBlocksRecursive(), RemoveFunctionsWithModuleNotEqualTo(), lldb_private::plugin::dwarf::SymbolFileDWARF::ResolveFunction(), lldb_private::ThreadPlanStepInRange::ShouldStop(), lldb::SBThread::StepOverUntil(), and lldb_private::ValueObjectVariable::UpdateValue().

◆ GetAddressRanges()

AddressRanges lldb_private::Function::GetAddressRanges ( )

inline

Definition at line 450 of file Function.h.

References lldb_private::Block::GetRanges(), and m_block.

Referenced by lldb::SBFunction::GetRanges().

◆ GetBlock()

Block & Function::GetBlock ( bool can_create )

Get accessor for the block list.

Returns: The block list object that describes all lexical blocks in the function.

See also: BlockList

Definition at line 396 of file Function.cpp.

References lldb_private::Block::BlockInfoHasBeenParsed(), CalculateSymbolContextModule(), GetName(), lldb_private::FileSpec::GetPath(), lldb_private::CompileUnit::GetPrimaryFile(), m_block, m_comp_unit, lldb_private::Debugger::ReportError(), and lldb_private::Block::SetBlockInfoHasBeenParsed().

Referenced by lldb_private::FormatEntity::Format(), lldb::SBFunction::GetArgumentName(), lldb::SBFunction::GetBlock(), GetCallEdges(), lldb_private::StackFrame::GetFrameBlock(), lldb_private::SymbolContext::GetFunctionBlock(), lldb_private::CPlusPlusLanguage::GetFunctionDisplayName(), InferPromiseType(), lldb_private::breakpad::SymbolFileBreakpad::ParseBlocksRecursive(), lldb_private::plugin::dwarf::SymbolFileDWARF::ParseBlocksRecursive(), SymbolFilePDB::ParseBlocksRecursive(), lldb_private::plugin::dwarf::SymbolFileDWARF::ParseVariableDIE(), SymbolFilePDB::ParseVariableForPDBData(), SymbolFilePDB::ParseVariables(), SymbolFilePDB::ParseVariablesForContext(), lldb_private::plugin::dwarf::SymbolFileDWARF::ParseVariablesForContext(), lldb_private::plugin::dwarf::SymbolFileDWARF::ParseVariablesInFunctionContextRecursive(), lldb_private::plugin::dwarf::SymbolFileDWARF::ResolveFunction(), lldb_private::plugin::dwarf::SymbolFileDWARF::ResolveFunctionAndBlock(), lldb_private::CompileUnit::ResolveSymbolContext(), and DWARFASTParserClang::UpdateSymbolContextScopeForType().

◆ GetCallEdgeForReturnAddress()

CallEdge * Function::GetCallEdgeForReturnAddress	(	lldb::addr_t	return_pc,
		Target &	target
	)

Get the outgoing call edge from this function which has the given return address return_pc, or return nullptr.

Note that this will not return a tail-calling edge.

Definition at line 381 of file Function.cpp.

References GetCallEdges().

Referenced by Evaluate_DW_OP_entry_value(), and FindInterveningFrames().

◆ GetCallEdges()

llvm::ArrayRef< std::unique_ptr< CallEdge > > Function::GetCallEdges ( )

Get the outgoing call edges from this function, sorted by their return PC addresses (in increasing order).

Definition at line 344 of file Function.cpp.

References GetBlock(), GetDisplayName(), lldb_private::UserID::GetID(), lldb_private::GetLog(), lldb_private::Block::GetSymbolFile(), LLDB_LOG, m_call_edges, m_call_edges_lock, m_call_edges_resolved, lldb_private::SymbolFile::ParseCallEdgesInFunction(), and lldb_private::Step.

Referenced by FindInterveningFrames(), GetCallEdgeForReturnAddress(), and GetTailCallingEdges().

◆ GetCompilerContext()

std::vector< CompilerContext > Function::GetCompilerContext ( )

Get the CompilerContext for this function, if available.

Returns: The CompilerContext, or an empty vector if none is available.

Definition at line 559 of file Function.cpp.

References CalculateSymbolContextModule(), and lldb_private::UserID::GetID().

Referenced by GetDescription().

◆ GetCompilerType()

CompilerType Function::GetCompilerType ( )

Definition at line 587 of file Function.cpp.

References lldb_private::Type::GetFullCompilerType(), and GetType().

Referenced by lldb_private::ThreadPlanStepOut::CalculateReturnValue(), lldb_private::ClangFunctionCaller::CompileFunction(), lldb_private::Thread::ReturnFromFrame(), and ValueObjectVTableChild::UpdateValue().

◆ GetCompileUnit() [1/2]

CompileUnit * Function::GetCompileUnit ( )

Get accessor for the compile unit that owns this function.

Returns: A compile unit object pointer.

Definition at line 411 of file Function.cpp.

References m_comp_unit.

Referenced by lldb_private::ClangExpressionDeclMap::AddOneFunction(), CalculateSymbolContextCompileUnit(), CalculateSymbolContextModule(), lldb::SBFunction::GetIsOptimized(), lldb::SBFunction::GetLanguage(), lldb_private::breakpad::SymbolFileBreakpad::ParseBlocksRecursive(), lldb_private::plugin::dwarf::SymbolFileDWARF::ParseBlocksRecursive(), and lldb_private::plugin::dwarf::SymbolFileDWARFDebugMap::ParseBlocksRecursive().

◆ GetCompileUnit() [2/2]

const CompileUnit * Function::GetCompileUnit ( ) const

Get const accessor for the compile unit that owns this function.

Returns: A const compile unit object pointer.

Definition at line 413 of file Function.cpp.

References m_comp_unit.

◆ GetDeclContext()

CompilerDeclContext Function::GetDeclContext ( )

Get the DeclContext for this function, if available.

Returns: The DeclContext, or NULL if none exists.

Definition at line 552 of file Function.cpp.

References CalculateSymbolContextModule(), and lldb_private::UserID::GetID().

Referenced by lldb_private::ClangExpressionDeclMap::AddOneFunction(), and lldb_private::ClangExpressionDeclMap::SearchFunctionsInSymbolContexts().

◆ GetDescription()

void Function::GetDescription	(	Stream *	s,
		lldb::DescriptionLevel	level,
		Target *	target
	)

Definition at line 415 of file Function.cpp.

References lldb_private::Stream::AsRawOstream(), lldb_private::AddressRange::Dump(), lldb_private::Address::DumpStyleFileAddress, lldb_private::Address::DumpStyleLoadAddress, lldb_private::Address::DumpStyleModuleWithFileAddress, lldb::eDescriptionLevelVerbose, GetCompilerContext(), lldb_private::Mangled::GetMangledName(), GetName(), lldb_private::Block::GetNumRanges(), lldb_private::Block::GetRangeAtIndex(), m_block, and m_mangled.

Referenced by lldb_private::SymbolContext::GetDescription().

◆ GetDisassembly()

bool Function::GetDisassembly	(	const ExecutionContext &	exe_ctx,
		const char *	flavor,
		Stream &	strm,
		bool	force_live_memory = `false`
	)

Definition at line 496 of file Function.cpp.

References GetInstructions().

◆ GetDisplayName()

ConstString Function::GetDisplayName ( ) const

Definition at line 548 of file Function.cpp.

References lldb_private::Mangled::GetDisplayDemangledName(), and m_mangled.

Referenced by lldb_private::SymbolContext::DumpStopContext(), FindInterveningFrames(), GetCallEdges(), lldb_private::StackFrame::GetDisplayFunctionName(), and lldb_private::StackFrameList::SynthesizeTailCallFrames().

◆ GetEndLineSourceInfo()

void Function::GetEndLineSourceInfo	(	FileSpec &	source_file,
		uint32_t &	line_no
	)

Find the file and line number of the source location of the end of the function.

Parameters

[out]	source_file	The source file.
[out]	line_no	The line number.

Definition at line 323 of file Function.cpp.

References lldb_private::FileSpec::Clear(), lldb_private::LineTable::FindLineEntryByAddress(), GetAddressRange(), lldb_private::LineEntry::GetFile(), lldb_private::CompileUnit::GetLineTable(), lldb_private::Address::GetOffset(), lldb_private::LineEntry::line, m_comp_unit, and lldb_private::Address::SetOffset().

Referenced by CommandObjectSourceList::DisplayFunctionSource().

◆ GetFrameBaseExpression() [1/2]

DWARFExpressionList & lldb_private::Function::GetFrameBaseExpression ( )

inline

Get accessor for the frame base location.

Returns: A location expression that describes the function frame base.

Definition at line 518 of file Function.h.

References m_frame_base.

Referenced by lldb_private::StackFrame::GetFrameBaseExpression(), and lldb_private::StackFrame::GetFrameBaseValue().

◆ GetFrameBaseExpression() [2/2]

const DWARFExpressionList & lldb_private::Function::GetFrameBaseExpression ( ) const

inline

Get const accessor for the frame base location.

Returns: A const compile unit object pointer.

Definition at line 524 of file Function.h.

References m_frame_base.

◆ GetInstructions()

lldb::DisassemblerSP Function::GetInstructions	(	const ExecutionContext &	exe_ctx,
		const char *	flavor,
		bool	force_live_memory = `false`
	)

Definition at line 484 of file Function.cpp.

References lldb_private::Disassembler::DisassembleRange(), GetAddressRange(), lldb_private::ExecutionContext::GetTargetRef(), and lldb_private::ExecutionContext::HasTargetScope().

Referenced by CalculateDisass(), and GetDisassembly().

◆ GetIsOptimized()

bool Function::GetIsOptimized ( )

Get whether compiler optimizations were enabled for this function.

The debug information may provide information about whether this function was compiled with optimization or not. In this case, "optimized" means that the debug experience may be difficult for the user to understand. Variables may not be available when the developer would expect them, stepping through the source lines in the function may appear strange, etc.

Returns: Returns 'true' if this function was compiled with optimization. 'false' indicates that either the optimization is unknown, or this function was built without optimization.

Definition at line 528 of file Function.cpp.

References lldb_private::CompileUnit::GetIsOptimized(), and m_comp_unit.

Referenced by lldb_private::FormatEntity::Format(), and lldb_private::Process::PrintWarningOptimization().

◆ GetLanguage()

lldb::LanguageType Function::GetLanguage ( ) const

Definition at line 709 of file Function.cpp.

References lldb::eLanguageTypeUnknown, lldb_private::CompileUnit::GetLanguage(), lldb_private::Mangled::GuessLanguage(), m_comp_unit, and m_mangled.

Referenced by lldb_private::FormatEntity::Format(), lldb_private::SymbolContext::GetLanguage(), and IsTopLevelFunction().

◆ GetMangled()

const Mangled & lldb_private::Function::GetMangled ( ) const

inline

Definition at line 532 of file Function.h.

References m_mangled.

Referenced by lldb_private::ClangExpressionDeclMap::AddOneFunction(), lldb_private::FormatEntity::Format(), lldb_private::Debugger::FormatDisassemblerAddress(), lldb_private::BreakpointLocation::GetDescription(), lldb::SBFunction::GetDisplayName(), lldb_private::SymbolContext::GetFunctionName(), lldb::SBFunction::GetMangledName(), lldb_private::StackFrame::GuessLanguage(), and lldb_private::SymbolContextSpecifier::SymbolContextMatches().

◆ GetName()

ConstString Function::GetName ( ) const

Definition at line 720 of file Function.cpp.

References lldb_private::Mangled::GetName(), and m_mangled.

Referenced by lldb_private::SymbolContext::DumpStopContext(), Evaluate_DW_OP_entry_value(), lldb_private::FormatEntity::Format(), GetBlock(), lldb::SBFunction::GetDescription(), lldb_private::BreakpointLocation::GetDescription(), GetDescription(), lldb_private::CPlusPlusLanguage::GetFunctionDisplayName(), lldb_private::StackFrame::GetFunctionName(), lldb::SBFunction::GetName(), GetSymbolOrFunctionName(), lldb_private::RegisterContextUnwind::IsTrapHandlerSymbol(), lldb_private::ClangExpressionDeclMap::SearchFunctionsInSymbolContexts(), and SymbolContextsMightBeEquivalent().

◆ GetNameNoArguments()

ConstString Function::GetNameNoArguments ( ) const

Definition at line 724 of file Function.cpp.

References lldb_private::Mangled::ePreferDemangledWithoutArguments, lldb_private::Mangled::GetName(), and m_mangled.

Referenced by lldb_private::SymbolContext::DumpStopContext(), and lldb_private::FormatEntity::Format().

◆ GetPrologueByteSize()

uint32_t Function::GetPrologueByteSize ( )

Get the size of the prologue instructions for this function.

The "prologue" instructions include any instructions given line number 0 immediately following the prologue end.

Returns: The size of the prologue.

Definition at line 594 of file Function.cpp.

References lldb_private::LineTable::FindLineEntryByAddress(), flagsCalculatedPrologueSize, GetAddressRange(), lldb_private::AddressRange::GetBaseAddress(), lldb_private::AddressRange::GetByteSize(), lldb_private::Address::GetFileAddress(), lldb_private::LineTable::GetLineEntryAtIndex(), lldb_private::CompileUnit::GetLineTable(), lldb_private::LineEntry::is_prologue_end, lldb_private::Flags::IsClear(), lldb_private::LineEntry::line, LLDB_INVALID_ADDRESS, m_comp_unit, m_flags, m_prologue_byte_size, m_range, lldb_private::LineEntry::range, lldb_private::Flags::Set(), and UINT32_MAX.

Referenced by lldb_private::BreakpointResolver::AddLocation(), lldb::SBFunction::GetPrologueByteSize(), lldb_private::Symbol::GetPrologueByteSize(), and lldb_private::ThreadPlanStepInRange::ShouldStop().

◆ GetStartLineSourceInfo()

void Function::GetStartLineSourceInfo	(	lldb::SupportFileSP &	source_file_sp,
		uint32_t &	line_no
	)

Find the file and line number of the source location of the start of the function.

This will use the declaration if present and fall back on the line table if that fails. So there may NOT be a line table entry for this source file/line combo.

Parameters

[out]	source_file	The source file.
[out]	line_no	The line number.

Definition at line 294 of file Function.cpp.

References lldb_private::LineEntry::file_sp, lldb_private::LineTable::FindLineEntryByAddress(), GetAddressRange(), lldb_private::Type::GetDeclaration(), lldb_private::Declaration::GetFile(), lldb_private::Declaration::GetLine(), lldb_private::CompileUnit::GetLineTable(), GetType(), lldb_private::LineEntry::line, m_comp_unit, and m_type.

Referenced by CommandObjectSourceList::DisplayFunctionSource(), lldb_private::BreakpointResolverFileLine::FilterContexts(), lldb_private::Disassembler::GetFunctionDeclLineEntry(), lldb_private::StackFrame::GetStatus(), and lldb_private::Disassembler::PrintInstructions().

◆ GetTailCallingEdges()

llvm::ArrayRef< std::unique_ptr< CallEdge > > Function::GetTailCallingEdges ( )

Get the outgoing tail-calling edges from this function.

If none exist, return std::nullopt.

Definition at line 374 of file Function.cpp.

References GetCallEdges().

Referenced by Evaluate_DW_OP_entry_value(), and FindInterveningFrames().

◆ GetType() [1/2]

Type * Function::GetType ( )

Get accessor for the type that describes the function return value type, and parameter types.

Returns: A type object pointer.

Definition at line 566 of file Function.cpp.

References CalculateSymbolContext(), m_type, m_type_uid, lldb_private::SymbolContext::module_sp, and lldb_private::SymbolFile::ResolveTypeUID().

Referenced by lldb_private::ClangExpressionDeclMap::AddOneFunction(), lldb_private::Block::AddRange(), lldb_private::SymbolContext::Dump(), GetCompilerType(), lldb::SBFunction::GetDescription(), lldb_private::SymbolContext::GetDescription(), GetStartLineSourceInfo(), lldb::SBFunction::GetType(), lldb_private::Thread::ReturnFromFrame(), and lldb_private::ClangExpressionDeclMap::SearchFunctionsInSymbolContexts().

◆ GetType() [2/2]

const Type * Function::GetType ( ) const

Get const accessor for the type that describes the function return value type, and parameter types.

Returns: A const type object pointer.

Definition at line 585 of file Function.cpp.

References m_type.

◆ IsTopLevelFunction()

bool Function::IsTopLevelFunction ( )

Get whether this function represents a 'top-level' function.

The concept of a top-level function is language-specific, mostly meant to represent the notion of scripting-style code that has global visibility of the variables/symbols/functions/... defined within the containing file/module

If stopped in a top-level function, LLDB will expose global variables as-if locals in the 'frame variable' command

Returns: Returns 'true' if this function is a top-level function, 'false' otherwise.

Definition at line 539 of file Function.cpp.

References lldb_private::Language::FindPlugin(), and GetLanguage().

Referenced by CommandObjectFrameVariable::DoExecute().

◆ MemorySize()

size_t Function::MemorySize ( ) const

Get the memory cost of this object.

Returns: The number of bytes that this object occupies in memory. The returned value does not include the bytes for any shared string values.

Definition at line 523 of file Function.cpp.

References m_block, and lldb_private::Block::MemorySize().

◆ operator=()

const Function & lldb_private::Function::operator= ( const Function & )

privatedelete

Member Data Documentation

◆ m_block

Block lldb_private::Function::m_block

protected

All lexical blocks contained in this function.

Definition at line 654 of file Function.h.

Referenced by Dump(), Function(), GetAddressRanges(), GetBlock(), GetDescription(), and MemorySize().

◆ m_call_edges

std::vector<std::unique_ptr<CallEdge> > lldb_private::Function::m_call_edges

protected

Outgoing call edges.

Definition at line 678 of file Function.h.

Referenced by GetCallEdges().

◆ m_call_edges_lock

std::mutex lldb_private::Function::m_call_edges_lock

protected

Exclusive lock that controls read/write access to m_call_edges and m_call_edges_resolved.

Definition at line 672 of file Function.h.

Referenced by GetCallEdges().

◆ m_call_edges_resolved

bool lldb_private::Function::m_call_edges_resolved = false

protected

Whether call site info has been parsed.

Definition at line 675 of file Function.h.

Referenced by GetCallEdges().

◆ m_comp_unit

CompileUnit* lldb_private::Function::m_comp_unit

protected

The compile unit that owns this function.

Definition at line 640 of file Function.h.

Referenced by CalculateSymbolContext(), DumpSymbolContext(), GetBlock(), GetCompileUnit(), GetEndLineSourceInfo(), GetIsOptimized(), GetLanguage(), GetPrologueByteSize(), and GetStartLineSourceInfo().

◆ m_flags

Flags lldb_private::Function::m_flags

protected

Definition at line 665 of file Function.h.

Referenced by GetPrologueByteSize().

◆ m_frame_base

DWARFExpressionList lldb_private::Function::m_frame_base

protected

The frame base expression for variables that are relative to the frame pointer.

Definition at line 663 of file Function.h.

Referenced by GetFrameBaseExpression().

◆ m_mangled

Mangled lldb_private::Function::m_mangled

protected

The mangled function name if any.

If empty, there is no mangled information.

Definition at line 651 of file Function.h.

Referenced by Dump(), GetDescription(), GetDisplayName(), GetLanguage(), GetMangled(), GetName(), and GetNameNoArguments().

◆ m_prologue_byte_size

uint32_t lldb_private::Function::m_prologue_byte_size

protected

Compute the prologue size once and cache it.

Definition at line 668 of file Function.h.

Referenced by GetPrologueByteSize().

◆ m_range

AddressRange lldb_private::Function::m_range

protected

The function address range that covers the widest range needed to contain all blocks.

DEPRECATED: do not use this field in new code as the range may include addresses belonging to other functions.

Definition at line 659 of file Function.h.

Referenced by CalculateSymbolContextModule(), Dump(), Function(), GetAddressRange(), and GetPrologueByteSize().

◆ m_type

Type* lldb_private::Function::m_type

protected

The function prototype type for this function that includes the function info (FunctionInfo), return type and parameters.

Definition at line 647 of file Function.h.

Referenced by Dump(), GetStartLineSourceInfo(), and GetType().

◆ m_type_uid

lldb::user_id_t lldb_private::Function::m_type_uid

protected

The user ID of for the prototype Type for this function.

Definition at line 643 of file Function.h.

Referenced by Dump(), and GetType().

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

Public Member Functions

Protected Types

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Function() [1/2]

◆ ~Function()

◆ Function() [2/2]

Member Function Documentation

◆ CalculateSymbolContext()

◆ CalculateSymbolContextCompileUnit()

◆ CalculateSymbolContextFunction()

◆ CalculateSymbolContextModule()

◆ Dump()

◆ DumpSymbolContext()

◆ GetAddressRange()

◆ GetAddressRanges()

◆ GetBlock()

◆ GetCallEdgeForReturnAddress()

◆ GetCallEdges()

◆ GetCompilerContext()

◆ GetCompilerType()

◆ GetCompileUnit() [1/2]

◆ GetCompileUnit() [2/2]

◆ GetDeclContext()

◆ GetDescription()

◆ GetDisassembly()

◆ GetDisplayName()

◆ GetEndLineSourceInfo()

◆ GetFrameBaseExpression() [1/2]

◆ GetFrameBaseExpression() [2/2]

◆ GetInstructions()

◆ GetIsOptimized()

◆ GetLanguage()

◆ GetMangled()

◆ GetName()

◆ GetNameNoArguments()

◆ GetPrologueByteSize()

◆ GetStartLineSourceInfo()

◆ GetTailCallingEdges()

◆ GetType() [1/2]

◆ GetType() [2/2]

◆ IsTopLevelFunction()

◆ MemorySize()

◆ operator=()

Member Data Documentation

◆ m_block

◆ m_call_edges

◆ m_call_edges_lock

◆ m_call_edges_resolved

◆ m_comp_unit

◆ m_flags

◆ m_frame_base

◆ m_mangled

◆ m_prologue_byte_size

◆ m_range

◆ m_type

◆ m_type_uid