A class that describes a function. More...

#include "lldb/Symbol/Function.h"

Inheritance diagram for lldb_private::Function:

Public Types
using	SourceRange = Range<uint32_t, uint32_t>

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, Address address, 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
AddressRanges	GetAddressRanges ()
const Address &	GetAddress () const
	Return the address of the function (its entry point).
bool	GetRangeContainingLoadAddress (lldb::addr_t load_addr, Target &target, AddressRange &range)
lldb::LanguageType	GetLanguage () const
void	GetStartLineSourceInfo (SupportFileNSP &source_file_sp, uint32_t &line_no)
	Find the source file and line number for the start of the function.
bool	GetStartLineTableEntry (LineEntry &line_entry, uint32_t *index=nullptr)
	Get the line table entry for the function's entry point.
llvm::Expected< std::pair< SupportFileNSP, SourceRange > >	GetSourceInfo ()
	Find the file and line number range 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.
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 Block *	CalculateSymbolContextBlock ()
virtual Symbol *	CalculateSymbolContextSymbol ()

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.
Address	m_address
	The address (entry point) of the function.
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 377 of file Function.h.

Member Typedef Documentation

◆ SourceRange

using lldb_private::Function::SourceRange = Range<uint32_t, uint32_t>

Definition at line 473 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 626 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,
		Address	address,
		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 255 of file Function.cpp.

References m_address, m_block, m_comp_unit, m_mangled, m_prologue_byte_size, m_type, m_type_uid, and lldb_private::UserID::UserID().

Referenced by CalculateSymbolContextFunction(), Function(), operator=(), and ~Function().

◆ ~Function()

Function::~Function ( )

overridedefault

Destructor.

References Function().

◆ Function() [2/2]

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

privatedelete

References Function().

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 471 of file Function.cpp.

References 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 483 of file Function.cpp.

References GetCompileUnit().

◆ CalculateSymbolContextFunction()

Function * Function::CalculateSymbolContextFunction ( )

overridevirtual

Reimplemented from lldb_private::SymbolContextScope.

Definition at line 487 of file Function.cpp.

References Function().

◆ CalculateSymbolContextModule()

ModuleSP Function::CalculateSymbolContextModule ( )

overridevirtual

Reimplemented from lldb_private::SymbolContextScope.

Definition at line 476 of file Function.cpp.

References GetCompileUnit(), lldb_private::ModuleChild::GetModule(), and m_address.

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 453 of file Function.cpp.

References lldb_private::Stream::EOL(), lldb_private::Stream::Indent(), LLDB_INVALID_UID, m_address, m_block, m_mangled, m_type, m_type_uid, lldb_private::Stream::Printf(), and lldb_private::UserID::UserID().

◆ 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 523 of file Function.cpp.

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

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

◆ GetAddress()

const Address & lldb_private::Function::GetAddress ( ) const

inline

Return the address of the function (its entry point).

This address is also used as a base address for relocation of function-scope entities (blocks and variables).

Definition at line 430 of file Function.h.

References m_address.

Referenced by lldb_private::BreakpointResolver::AddLocation(), lldb_private::ClangExpressionDeclMap::AddOneFunction(), lldb_private::Block::AddRange(), DynamicLoaderPOSIXDYLD::AlwaysRelyOnEHUnwindInfo(), lldb_private::DynamicLoaderDarwin::AlwaysRelyOnEHUnwindInfo(), lldb_private::VariableAnnotator::AnnotateStructured(), lldb_private::npdb::SymbolFileNativePDB::CreateBlock(), lldb_private::npdb::SymbolFileNativePDB::CreateLocalVariable(), DumpAddressOffsetFromFunction(), lldb_private::Variable::DumpLocations(), lldb_private::Module::FindFunctions(), lldb_private::SearchFilter::FunctionPasses(), lldb_private::ArchitectureMips::GetBreakableLoadAddress(), lldb::SBBlock::GetDescription(), lldb_private::Block::GetDescription(), GetInstructions(), lldb_private::CallEdge::GetLoadAddress(), lldb_private::Block::GetRangeAtIndex(), lldb_private::Block::GetRangeContainingAddress(), lldb_private::Block::GetRangeIndexContainingAddress(), lldb_private::Block::GetRanges(), lldb_private::Block::GetStartAddress(), GetStartLineTableEntry(), lldb_private::CPPLanguageRuntime::GetStepThroughTrampolinePlan(), lldb_private::Variable::LocationIsValidForAddress(), lldb_private::Variable::LocationIsValidForFrame(), lldb_private::DWARFExpressionList::MatchesOperand(), lldb_private::breakpad::SymbolFileBreakpad::ParseBlocksRecursive(), RemoveFunctionsWithModuleNotEqualTo(), lldb_private::ThreadPlanStepInRange::ShouldStop(), and lldb_private::ValueObjectVariable::UpdateValue().

◆ GetAddressRanges()

AddressRanges lldb_private::Function::GetAddressRanges ( )

inline

Definition at line 425 of file Function.h.

References m_block.

Referenced by lldb_private::Disassembler::Disassemble(), CommandObjectThreadUntil::DoExecute(), lldb_private::CommandObjectDisassemble::GetCurrentFunctionRanges(), GetInstructions(), GetSourceInfo(), and lldb_private::StackFrame::GuessValueForRegisterAndOffset().

◆ 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 403 of file Function.cpp.

References CalculateSymbolContextModule(), GetName(), m_block, m_comp_unit, and lldb_private::Debugger::ReportError().

Referenced by GetCallEdges(), GetFunctionVariableList(), GetFunctionVariableList(), InferArtificialCoroType(), lldb_private::breakpad::SymbolFileBreakpad::ParseBlocksRecursive(), lldb_private::npdb::SymbolFileNativePDB::ParseBlocksRecursive(), lldb_private::plugin::dwarf::SymbolFileDWARF::ParseBlocksRecursive(), SymbolFilePDB::ParseBlocksRecursive(), lldb_private::plugin::dwarf::SymbolFileDWARF::ParseVariableDIE(), SymbolFilePDB::ParseVariableForPDBData(), SymbolFilePDB::ParseVariables(), lldb_private::plugin::dwarf::SymbolFileDWARF::ParseVariablesForContext(), SymbolFilePDB::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 388 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 351 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::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 418 of file Function.cpp.

References m_comp_unit.

Referenced by lldb_private::ClangExpressionDeclMap::AddOneFunction(), CalculateSymbolContextCompileUnit(), CalculateSymbolContextModule(), lldb::SBBlock::operator==(), 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 420 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 422 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(), GetName(), m_block, m_mangled, and lldb_private::UserID::UserID().

◆ GetDisassembly()

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

Definition at line 501 of file Function.cpp.

References GetInstructions().

◆ GetDisplayName()

ConstString Function::GetDisplayName ( ) const

Definition at line 548 of file Function.cpp.

References m_mangled.

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

◆ 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.

◆ 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 489 of file Function.cpp.

References lldb_private::Disassembler::DisassembleRange(), GetAddress(), GetAddressRanges(), lldb_private::Address::GetModule(), 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 m_comp_unit.

Referenced by lldb_private::Process::PrintWarningOptimization().

◆ GetLanguage()

lldb::LanguageType Function::GetLanguage ( ) const

Definition at line 715 of file Function.cpp.

References lldb::eLanguageTypeUnknown, m_comp_unit, and m_mangled.

Referenced by HandleFunctionNameWithArgs(), 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::Debugger::FormatDisassemblerAddress(), lldb_private::BreakpointLocation::GetDescription(), lldb_private::StackFrame::GuessLanguage(), and lldb_private::SymbolContextSpecifier::SymbolContextMatches().

◆ GetName()

ConstString Function::GetName ( ) const

Definition at line 726 of file Function.cpp.

References m_mangled.

Referenced by Evaluate_DW_OP_entry_value(), GetBlock(), lldb_private::BreakpointLocation::GetDescription(), GetDescription(), lldb_private::StackFrame::GetFunctionName(), GetSourceInfo(), GetSymbolOrFunctionName(), lldb_private::ClangExpressionDeclMap::SearchFunctionsInSymbolContexts(), and SymbolContextsMightBeEquivalent().

◆ GetNameNoArguments()

ConstString Function::GetNameNoArguments ( ) const

Definition at line 730 of file Function.cpp.

References lldb_private::Mangled::ePreferDemangledWithoutArguments, and m_mangled.

◆ 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 flagsCalculatedPrologueSize, lldb_private::AddressRange::GetBaseAddress(), lldb_private::AddressRange::GetByteSize(), lldb_private::Address::GetFileAddress(), lldb_private::LineTable::GetLineEntryAtIndex(), GetStartLineTableEntry(), lldb_private::LineEntry::is_prologue_end, lldb_private::LineEntry::line, LLDB_INVALID_ADDRESS, m_address, m_block, m_comp_unit, m_flags, m_prologue_byte_size, lldb_private::LineEntry::range, and UINT32_MAX.

Referenced by lldb_private::BreakpointResolver::AddLocation(), lldb_private::Symbol::GetPrologueByteSize(), lldb_private::CPPLanguageRuntime::GetStepThroughTrampolinePlan(), and lldb_private::ThreadPlanStepInRange::ShouldStop().

◆ GetRangeContainingLoadAddress()

bool lldb_private::Function::GetRangeContainingLoadAddress	(	lldb::addr_t	load_addr,
		Target &	target,
		AddressRange &	range )

inline

Definition at line 432 of file Function.h.

References m_block.

Referenced by CommandObjectThreadUntil::DoExecute(), lldb_private::StackFrame::GuessValueForRegisterAndOffset(), and lldb::SBThread::StepOverUntil().

◆ GetSourceInfo()

llvm::Expected< std::pair< SupportFileNSP, Function::SourceRange > > Function::GetSourceInfo ( )

Find the file and line number range of the function.

Definition at line 325 of file Function.cpp.

References lldb_private::SupportFile::eEqualFileSpecAndChecksumIfSet, lldb_private::LineEntry::file_sp, GetAddressRanges(), lldb_private::LineTable::GetLineEntryAtIndex(), lldb_private::LineTable::GetLineEntryIndexRange(), GetName(), GetStartLineSourceInfo(), lldb_private::LineEntry::line, and m_comp_unit.

Referenced by CommandObjectSourceList::DisplayFunctionSource().

◆ GetStartLineSourceInfo()

void Function::GetStartLineSourceInfo	(	SupportFileNSP &	source_file_sp,
		uint32_t &	line_no )

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

This prefers the function's declaration and only falls back to GetStartLineTableEntry when the function has none. The declaration line need not correspond to any line table row, which is why this reports a bare source file and line rather than a LineEntry.

Parameters

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

Definition at line 300 of file Function.cpp.

References lldb_private::LineEntry::file_sp, GetStartLineTableEntry(), GetType(), lldb_private::LineEntry::line, m_comp_unit, and m_type.

Referenced by lldb_private::BreakpointResolverFileLine::FilterContexts(), lldb_private::Disassembler::GetFunctionDeclLineEntry(), GetSourceInfo(), and lldb_private::Disassembler::PrintInstructions().

◆ GetStartLineTableEntry()

bool Function::GetStartLineTableEntry	(	LineEntry &	line_entry,
		uint32_t *	index = nullptr )

Get the line table entry for the function's entry point.

When the entry address is not covered by a line row, this returns the first line entry that begins within the function's range instead.

Unlike GetStartLineSourceInfo, this consults only the line table, never the declaration, so the result is always a real line table entry and carries its address range and index.

Parameters

[out]	line_entry	The resulting line entry.
[out]	index	If non-null, set to the index of the line entry in the line table.

Returns: True if a line entry was found, false otherwise.

Definition at line 272 of file Function.cpp.

References lldb_private::LineTable::FindLineEntryByAddress(), GetAddress(), lldb_private::LineTable::GetLineEntryAtIndex(), lldb_private::LineTable::GetLineEntryIndexRange(), m_address, m_block, m_comp_unit, and UINT32_MAX.

Referenced by GetPrologueByteSize(), and GetStartLineSourceInfo().

◆ 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 381 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(), GetCompilerType(), GetStartLineSourceInfo(), 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().

◆ operator=()

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

privatedelete

References Function().

Member Data Documentation

◆ m_address

Address lldb_private::Function::m_address

protected

The address (entry point) of the function.

Definition at line 649 of file Function.h.

Referenced by CalculateSymbolContextModule(), Dump(), Function(), GetAddress(), GetPrologueByteSize(), and GetStartLineTableEntry().

◆ m_block

Block lldb_private::Function::m_block

protected

All lexical blocks contained in this function.

Definition at line 646 of file Function.h.

Referenced by Dump(), Function(), GetAddressRanges(), GetBlock(), GetDescription(), GetPrologueByteSize(), GetRangeContainingLoadAddress(), and GetStartLineTableEntry().

◆ m_call_edges

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

protected

Outgoing call edges.

Definition at line 668 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 662 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 665 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 632 of file Function.h.

Referenced by CalculateSymbolContext(), DumpSymbolContext(), Function(), GetBlock(), GetCompileUnit(), GetCompileUnit(), GetIsOptimized(), GetLanguage(), GetPrologueByteSize(), GetSourceInfo(), GetStartLineSourceInfo(), and GetStartLineTableEntry().

◆ m_flags

Flags lldb_private::Function::m_flags

protected

Definition at line 655 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 653 of file Function.h.

Referenced by GetFrameBaseExpression(), and 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 643 of file Function.h.

Referenced by Dump(), Function(), 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 658 of file Function.h.

Referenced by Function(), 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 639 of file Function.h.

Referenced by Dump(), Function(), GetStartLineSourceInfo(), GetType(), 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 635 of file Function.h.

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

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

Public Types

Public Member Functions

Protected Types

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ SourceRange

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Function() [1/2]

◆ ~Function()

◆ Function() [2/2]

Member Function Documentation

◆ CalculateSymbolContext()

◆ CalculateSymbolContextCompileUnit()

◆ CalculateSymbolContextFunction()

◆ CalculateSymbolContextModule()

◆ Dump()

◆ DumpSymbolContext()

◆ GetAddress()

◆ GetAddressRanges()

◆ GetBlock()

◆ GetCallEdgeForReturnAddress()

◆ GetCallEdges()

◆ GetCompilerContext()

◆ GetCompilerType()

◆ GetCompileUnit() [1/2]

◆ GetCompileUnit() [2/2]

◆ GetDeclContext()

◆ GetDescription()

◆ GetDisassembly()

◆ GetDisplayName()

◆ GetFrameBaseExpression() [1/2]

◆ GetFrameBaseExpression() [2/2]

◆ GetInstructions()

◆ GetIsOptimized()

◆ GetLanguage()

◆ GetMangled()

◆ GetName()

◆ GetNameNoArguments()

◆ GetPrologueByteSize()

◆ GetRangeContainingLoadAddress()

◆ GetSourceInfo()

◆ GetStartLineSourceInfo()

◆ GetStartLineTableEntry()

◆ GetTailCallingEdges()

◆ GetType() [1/2]

◆ GetType() [2/2]

◆ IsTopLevelFunction()

◆ operator=()

Member Data Documentation

◆ m_address

◆ 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_type

◆ m_type_uid