24#include "llvm/Support/Casting.h"
32 : m_name(name), m_declaration(decl_ptr) {}
35 : m_name(name), m_declaration(decl_ptr) {}
41 *s <<
", name = \"" <<
m_name <<
"\"";
66 llvm::StringRef mangled,
70 m_call_decl(call_decl_ptr) {}
77 m_call_decl(call_decl_ptr) {}
129 : caller_address(caller_address), caller_address_type(caller_address_type),
130 is_tail_call(is_tail_call), parameters(std::move(parameters)) {}
139 if (!caller_module_sp) {
140 LLDB_LOG(log,
"GetLoadAddress: cannot get Module for caller");
144 SectionList *section_list = caller_module_sp->GetSectionList();
146 LLDB_LOG(log,
"GetLoadAddress: cannot get SectionList for Module");
165 LLDB_LOG(log,
"DirectCallEdge: Lazily parsing the call graph for {0}",
168 auto resolve_lazy_callee = [&]() ->
Function * {
172 size_t num_matches = sc_list.
GetSize();
173 if (num_matches == 0 || !sc_list[0].symbol) {
175 "DirectCallEdge: Found no symbols for {0}, cannot resolve it",
179 Address callee_addr = sc_list[0].symbol->GetAddress();
181 LLDB_LOG(log,
"DirectCallEdge: Invalid symbol address");
186 LLDB_LOG(log,
"DirectCallEdge: Could not find complete function");
199 :
CallEdge(caller_address_type, caller_address, is_tail_call,
200 std::move(parameters)) {
206 assert(
resolved &&
"Did not resolve lazy callee");
215 :
CallEdge(caller_address_type, caller_address, is_tail_call,
216 std::move(parameters)),
217 call_target(std::move(call_target)) {}
227 if (!callee_addr_val) {
229 "IndirectCallEdge: Could not evaluate expression: {0}");
236 LLDB_LOG(log,
"IndirectCallEdge: Could not extract address from scalar");
242 LLDB_LOG(log,
"IndirectCallEdge: Could not resolve callee's load address");
248 LLDB_LOG(log,
"IndirectCallEdge: Could not find complete function");
261 :
UserID(func_uid), m_comp_unit(comp_unit), m_type_uid(type_uid),
262 m_type(type), m_mangled(mangled), m_block(func_uid), m_range(range),
263 m_frame_base(), m_flags(), m_prologue_byte_size(0) {
265 assert(comp_unit !=
nullptr);
286 if (line_table ==
nullptr)
291 line_entry,
nullptr)) {
292 line_no = line_entry.
line;
293 source_file = line_entry.
GetFile();
309 if (line_table ==
nullptr)
314 line_no = line_entry.
line;
315 source_file = line_entry.
GetFile();
326 LLDB_LOG(log,
"GetCallEdges: Attempting to parse call site info for {0}",
341 llvm::sort(
m_call_edges, [](
const std::unique_ptr<CallEdge> &LHS,
342 const std::unique_ptr<CallEdge> &RHS) {
343 return LHS->GetSortKey() < RHS->GetSortKey();
353 [](
const std::unique_ptr<CallEdge> &edge) {
return edge->IsTailCall(); });
360 llvm::partition_point(edges, [&](
const std::unique_ptr<CallEdge> &edge) {
361 return std::make_pair(edge->IsTailCall(),
362 edge->GetReturnPCAddress(*
this, target)) <
363 std::make_pair(
false, return_pc);
365 if (edge_it == edges.end() ||
366 edge_it->get()->GetReturnPCAddress(*
this, target) != return_pc)
368 return edge_it->get();
375 module_sp->GetSymbolFile()->ParseBlocksRecursive(*
this);
378 "unable to find module shared pointer for function '{0}' in {1}",
395 *s <<
"id = " << (
const UserID &)*
this;
399 s->
AsRawOstream() <<
", mangled = \"" << mangled <<
'"';
401 *s <<
", decl_context = {";
404 if (decl_context.size())
405 decl_context.pop_back();
406 llvm::interleaveComma(decl_context, *s, [&](
auto &ctx) { ctx.Dump(*s); });
420 s->
Printf(
"%p: ",
static_cast<const void *
>(
this));
422 *s <<
"Function" <<
static_cast<const UserID &
>(*this);
446 return section_sp->GetModule();
459 bool prefer_file_cache) {
470 const char *flavor,
Stream &strm,
471 bool prefer_file_cache) {
474 if (disassembler_sp) {
475 const bool show_address =
true;
476 const bool show_bytes =
false;
477 const bool show_control_flow_kind =
false;
478 disassembler_sp->GetInstructionList().Dump(
479 &strm, show_address, show_bytes, show_control_flow_kind, &exe_ctx);
493 s->
Printf(
", Function{0x%8.8" PRIx64
"}",
GetID());
516 result = language->IsTopLevelFunction(*
this);
527 if (
SymbolFile *sym_file = module_sp->GetSymbolFile())
528 return sym_file->GetDeclContextForUID(
GetID());
534 if (
SymbolFile *sym_file = module_sp->GetSymbolFile())
535 return sym_file->GetCompilerContextForUID(
GetID());
550 if (sym_file ==
nullptr)
572 uint32_t prologue_end_line_idx = 0;
579 &first_line_entry_idx)) {
585 prologue_end_file_addr =
587 prologue_end_line_idx = first_line_entry_idx;
591 const uint32_t last_line_entry_idx = first_line_entry_idx + 6;
592 for (uint32_t idx = first_line_entry_idx + 1;
593 idx < last_line_entry_idx; ++idx) {
597 prologue_end_file_addr =
599 prologue_end_line_idx = idx;
611 uint32_t last_line_entry_idx = first_line_entry_idx + 6;
612 for (uint32_t idx = first_line_entry_idx + 1;
613 idx < last_line_entry_idx; ++idx) {
616 if (line_entry.
line != first_line_entry.
line) {
617 prologue_end_file_addr =
619 prologue_end_line_idx = idx;
626 prologue_end_file_addr =
629 prologue_end_line_idx = first_line_entry_idx;
633 const addr_t func_start_file_addr =
635 const addr_t func_end_file_addr =
639 uint32_t first_non_zero_line = prologue_end_line_idx;
644 if (line_entry.
line != 0)
651 first_non_zero_line++;
654 if (first_non_zero_line > prologue_end_line_idx) {
657 first_non_zero_entry)) {
658 line_zero_end_file_addr =
665 if (func_start_file_addr < prologue_end_file_addr &&
666 prologue_end_file_addr < func_end_file_addr) {
670 if (prologue_end_file_addr < line_zero_end_file_addr &&
671 line_zero_end_file_addr < func_end_file_addr) {
673 line_zero_end_file_addr - prologue_end_file_addr;
static llvm::raw_ostream & error(Stream &strm)
#define LLDB_LOG(log,...)
The LLDB_LOG* macros defined below are the way to emit log messages.
#define LLDB_LOG_ERROR(log, error,...)
A section + offset based address range class.
Address & GetBaseAddress()
Get accessor for the base address of the range.
bool Dump(Stream *s, Target *target, Address::DumpStyle style, Address::DumpStyle fallback_style=Address::DumpStyleInvalid) const
Dump a description of this object to a Stream.
lldb::addr_t GetByteSize() const
Get accessor for the byte size of this range.
A section + offset based address class.
lldb::addr_t GetLoadAddress(Target *target) const
Get the load address.
lldb::SectionSP GetSection() const
Get const accessor for the section.
Function * CalculateSymbolContextFunction() const
DumpStyle
Dump styles allow the Address::Dump(Stream *,DumpStyle) const function to display Address contents in...
@ DumpStyleFileAddress
Display as the file address (if any).
@ DumpStyleModuleWithFileAddress
Display as the file address with the module name prepended (if any).
@ DumpStyleLoadAddress
Display as the load address (if resolved).
lldb::ModuleSP GetModule() const
Get accessor for the module for this address.
lldb::addr_t GetFileAddress() const
Get the file address.
lldb::addr_t GetOffset() const
Get the section relative offset value.
bool IsValid() const
Check if the object state is valid.
bool SetOffset(lldb::addr_t offset)
Set accessor for the offset.
A class that describes a single lexical block.
bool BlockInfoHasBeenParsed() const
void SetBlockInfoHasBeenParsed(bool b, bool set_children)
void SetParentScope(SymbolContextScope *parent_scope)
SymbolFile * GetSymbolFile()
Get the symbol file which contains debug info for this block's symbol context module.
void Dump(Stream *s, lldb::addr_t base_addr, int32_t depth, bool show_context) const
Dump the block contents.
size_t MemorySize() const
Get the memory cost of this object.
Represent a call made within a Function.
lldb::addr_t GetReturnPCAddress(Function &caller, Target &target) const
Get the load PC address of the instruction which executes after the call returns.
static lldb::addr_t GetLoadAddress(lldb::addr_t unresolved_pc, Function &caller, Target &target)
Helper that finds the load address of unresolved_pc, a file address which refers to an instruction wi...
CallEdge(AddrType caller_address_type, lldb::addr_t caller_address, bool is_tail_call, CallSiteParameterArray &¶meters)
lldb::addr_t GetUnresolvedReturnPCAddress() const
Like GetReturnPCAddress, but returns an unresolved file address.
A class that describes a compilation unit.
const FileSpec & GetPrimaryFile() const
Return the primary source spec associated with this compile unit.
bool GetIsOptimized()
Get whether compiler optimizations were enabled for this compile unit.
void CalculateSymbolContext(SymbolContext *sc) override
Reconstruct the object's symbol context into sc.
void DumpSymbolContext(Stream *s) override
Dump the object's symbol context to the stream s.
lldb::LanguageType GetLanguage()
LineTable * GetLineTable()
Get the line table for the compile unit.
Represents a generic declaration context in a program.
Generic representation of a type in a programming language.
A uniqued constant string class.
size_t MemorySize() const
Get the memory cost of this object.
static int Compare(ConstString lhs, ConstString rhs, const bool case_sensitive=true)
Compare two string objects.
const char * AsCString(const char *value_if_empty=nullptr) const
Get the string value as a C string.
"lldb/Expression/DWARFExpressionList.h" Encapsulates a range map from file address range to a single ...
llvm::Expected< Value > Evaluate(ExecutionContext *exe_ctx, RegisterContext *reg_ctx, lldb::addr_t func_load_addr, const Value *initial_value_ptr, const Value *object_address_ptr) const
static void ReportError(std::string message, std::optional< lldb::user_id_t > debugger_id=std::nullopt, std::once_flag *once=nullptr)
Report error events.
A class that describes the declaration location of a lldb object.
uint32_t GetLine() const
Get accessor for the declaration line number.
size_t MemorySize() const
Get the memory cost of this object.
void Dump(Stream *s, bool show_fullpaths) const
Dump a description of this object to a Stream.
static int Compare(const Declaration &lhs, const Declaration &rhs)
Compare two declaration objects.
FileSpec & GetFile()
Get accessor for file specification.
Function * GetCallee(ModuleList &images, ExecutionContext &exe_ctx) override
Get the callee's definition.
bool resolved
Whether or not an attempt was made to find the callee's definition.
void ParseSymbolFileAndResolve(ModuleList &images)
union lldb_private::DirectCallEdge::@22 lazy_callee
DirectCallEdge(const char *symbol_name, AddrType caller_address_type, lldb::addr_t caller_address, bool is_tail_call, CallSiteParameterArray &¶meters)
Construct a call edge using a symbol name to identify the callee, and a return PC within the calling ...
static lldb::DisassemblerSP DisassembleRange(const ArchSpec &arch, const char *plugin_name, const char *flavor, Target &target, const AddressRange &disasm_range, bool force_live_memory=false)
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
Target * GetTargetPtr() const
Returns a pointer to the target object.
bool HasTargetScope() const
Returns true the ExecutionContext object contains a valid target.
Target & GetTargetRef() const
Returns a reference to the target object.
RegisterContext * GetRegisterContext() const
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
void Clear()
Clears the object state.
bool IsClear(ValueType bit) const
Test a single flag bit to see if it is clear (zero).
ValueType Set(ValueType mask)
Set one or more flags by logical OR'ing mask with the current flags.
A class that contains generic function information.
Declaration & GetDeclaration()
Get accessor for the declaration information.
void Dump(Stream *s, bool show_fullpaths) const
Dump a description of this object to a Stream.
virtual ~FunctionInfo()
Destructor.
ConstString GetName() const
Get accessor for the method name.
FunctionInfo(const char *name, const Declaration *decl_ptr)
Construct with the function method name and optional declaration information.
ConstString m_name
Function method name (not a mangled name).
virtual size_t MemorySize() const
Get the memory cost of this object.
static int Compare(const FunctionInfo &lhs, const FunctionInfo &rhs)
Compare two function information objects.
Declaration m_declaration
Information describing where this function information was defined.
A class that describes a function.
std::vector< std::unique_ptr< CallEdge > > m_call_edges
Outgoing call edges.
uint32_t m_prologue_byte_size
Compute the prologue size once and cache it.
bool GetIsOptimized()
Get whether compiler optimizations were enabled for this function.
lldb::user_id_t m_type_uid
The user ID of for the prototype Type for this function.
void GetDescription(Stream *s, lldb::DescriptionLevel level, Target *target)
const AddressRange & GetAddressRange()
CompilerType GetCompilerType()
bool IsTopLevelFunction()
Get whether this function represents a 'top-level' function.
lldb::ModuleSP CalculateSymbolContextModule() override
CompileUnit * m_comp_unit
The compile unit that owns this function.
ConstString GetName() const
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,...
llvm::ArrayRef< std::unique_ptr< CallEdge > > GetCallEdges()
Get the outgoing call edges from this function, sorted by their return PC addresses (in increasing or...
void Dump(Stream *s, bool show_context) const
Dump a description of this object to a Stream.
Block m_block
All lexical blocks contained in this function.
Function(CompileUnit *comp_unit, lldb::user_id_t func_uid, lldb::user_id_t func_type_uid, const Mangled &mangled, Type *func_type, const AddressRange &range)
Construct with a compile unit, function UID, function type UID, optional mangled name,...
Type * m_type
The function prototype type for this function that includes the function info (FunctionInfo),...
void CalculateSymbolContext(SymbolContext *sc) override
Reconstruct the object's symbol context into sc.
void GetStartLineSourceInfo(FileSpec &source_file, uint32_t &line_no)
Find the file and line number of the source location of the start of the function.
void DumpSymbolContext(Stream *s) override
Dump the object's symbol context to the stream s.
@ flagsCalculatedPrologueSize
Whether we already tried to calculate the prologue size.
llvm::ArrayRef< std::unique_ptr< CallEdge > > GetTailCallingEdges()
Get the outgoing tail-calling edges from this function.
bool GetDisassembly(const ExecutionContext &exe_ctx, const char *flavor, Stream &strm, bool force_live_memory=false)
Type * GetType()
Get accessor for the type that describes the function return value type, and parameter types.
AddressRange m_range
The function address range that covers the widest range needed to contain all blocks.
std::mutex m_call_edges_lock
Exclusive lock that controls read/write access to m_call_edges and m_call_edges_resolved.
lldb::LanguageType GetLanguage() const
uint32_t GetPrologueByteSize()
Get the size of the prologue instructions for this function.
CompilerDeclContext GetDeclContext()
Get the DeclContext for this function, if available.
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.
CompileUnit * CalculateSymbolContextCompileUnit() override
CompileUnit * GetCompileUnit()
Get accessor for the compile unit that owns this function.
~Function() override
Destructor.
bool m_call_edges_resolved
Whether call site info has been parsed.
ConstString GetDisplayName() const
ConstString GetNameNoArguments() const
lldb::DisassemblerSP GetInstructions(const ExecutionContext &exe_ctx, const char *flavor, bool force_live_memory=false)
Function * CalculateSymbolContextFunction() override
std::vector< CompilerContext > GetCompilerContext()
Get the CompilerContext for this function, if available.
size_t MemorySize() const
Get the memory cost of this object.
Mangled m_mangled
The mangled function name if any.
Block & GetBlock(bool can_create)
Get accessor for the block list.
Function * GetCallee(ModuleList &images, ExecutionContext &exe_ctx) override
Get the callee's definition.
IndirectCallEdge(DWARFExpressionList call_target, AddrType caller_address_type, lldb::addr_t caller_address, bool is_tail_call, CallSiteParameterArray &¶meters)
Construct a call edge using a DWARFExpression to identify the callee, and a return PC within the call...
DWARFExpressionList call_target
size_t MemorySize() const override
Get the memory cost of this object.
void DumpStopContext(Stream *s) const
ConstString GetDisplayName() const
Declaration & GetCallSite()
Get accessor for the call site declaration information.
ConstString GetName() const
~InlineFunctionInfo() override
Destructor.
Mangled m_mangled
Mangled inlined function name (can be empty if there is no mangled information).
InlineFunctionInfo(const char *name, llvm::StringRef mangled, const Declaration *decl_ptr, const Declaration *call_decl_ptr)
Construct with the function method name, mangled name, and optional declaration information.
void Dump(Stream *s, bool show_fullpaths) const
Dump a description of this object to a Stream.
Mangled & GetMangled()
Get accessor for the mangled name object.
static Language * FindPlugin(lldb::LanguageType language)
bool FindLineEntryByAddress(const Address &so_addr, LineEntry &line_entry, uint32_t *index_ptr=nullptr)
Find a line entry that contains the section offset address so_addr.
bool GetLineEntryAtIndex(uint32_t idx, LineEntry &line_entry)
Get the line entry from the line table at index idx.
A class that handles mangled names.
@ ePreferDemangledWithoutArguments
size_t MemorySize() const
Get the memory cost of this object.
lldb::LanguageType GuessLanguage() const
Try to guess the language from the mangling.
ConstString & GetMangledName()
Mangled name get accessor.
ConstString GetName(NamePreference preference=ePreferDemangled) const
Best name get accessor.
ConstString GetDisplayDemangledName() const
Display demangled name get accessor.
void Dump(Stream *s) const
Dump a description of this object to a Stream s.
lldb::ModuleSP GetModule() const
Get const accessor for the module pointer.
A collection class for Module objects.
void FindFunctionSymbols(ConstString name, lldb::FunctionNameType name_type_mask, SymbolContextList &sc_list)
A stream class that can stream formatted output to a file.
llvm::raw_ostream & AsRawOstream()
Returns a raw_ostream that forwards the data to this Stream object.
size_t Indent(llvm::StringRef s="")
Indent the current line in the stream.
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
size_t EOL()
Output and End of Line character to the stream.
Defines a list of symbol context objects.
uint32_t GetSize() const
Get accessor for a symbol context list size.
Defines a symbol context baton that can be handed other debug core functions.
Function * function
The Function for a given query.
lldb::ModuleSP module_sp
The Module for a given query.
Provides public interface for all SymbolFiles.
virtual Type * ResolveTypeUID(lldb::user_id_t type_uid)=0
virtual std::vector< std::unique_ptr< CallEdge > > ParseCallEdgesInFunction(UserID func_id)
bool ResolveLoadAddress(lldb::addr_t load_addr, Address &so_addr, uint32_t stop_id=SectionLoadHistory::eStopIDNow)
const lldb_private::Declaration & GetDeclaration() const
CompilerType GetFullCompilerType()
#define LLDB_INVALID_ADDRESS
A class that represents a running process on the host machine.
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
llvm::SmallVector< CallSiteParameter, 0 > CallSiteParameterArray
A vector of CallSiteParameter.
DescriptionLevel
Description levels for "void GetDescription(Stream *, DescriptionLevel)" calls.
@ eDescriptionLevelVerbose
LanguageType
Programming language type.
@ eLanguageTypeUnknown
Unknown or invalid language value.
std::shared_ptr< lldb_private::Disassembler > DisassemblerSP
std::shared_ptr< lldb_private::Section > SectionSP
std::shared_ptr< lldb_private::Module > ModuleSP
A line table entry class.
AddressRange range
The section offset address range for this line entry.
uint32_t line
The source line number, or LLDB_INVALID_LINE_NUMBER if there is no line number information.
const FileSpec & GetFile() const
Helper to access the file.
uint16_t is_prologue_end
Indicates this entry is one (of possibly many) where execution should be suspended for an entry break...
A mix in class that contains a generic user ID.
lldb::user_id_t GetID() const
Get accessor for the user ID.