#include <DebugNamesDWARFIndex.h>

Inheritance diagram for lldb_private::plugin::dwarf::DebugNamesDWARFIndex:

Public Member Functions
void	Preload () override

void	GetGlobalVariables (ConstString basename, llvm::function_ref< bool(DWARFDIE die)> callback) override
	Finds global variables with the given base name.

void	GetGlobalVariables (const RegularExpression &regex, llvm::function_ref< bool(DWARFDIE die)> callback) override

void	GetGlobalVariables (DWARFUnit &cu, llvm::function_ref< bool(DWARFDIE die)> callback) override
	cu must be the skeleton unit if possible, not GetNonSkeletonUnit().

void	GetObjCMethods (ConstString class_name, llvm::function_ref< bool(DWARFDIE die)> callback) override

void	GetCompleteObjCClass (ConstString class_name, bool must_be_implementation, llvm::function_ref< bool(DWARFDIE die)> callback) override

void	GetFullyQualifiedType (const DWARFDeclContext &context, llvm::function_ref< bool(DWARFDIE die)> callback) override
	Uses DWARF5's IDX_parent fields, when available, to speed up this query.

void	GetTypes (ConstString name, llvm::function_ref< bool(DWARFDIE die)> callback) override

void	GetTypes (const DWARFDeclContext &context, llvm::function_ref< bool(DWARFDIE die)> callback) override

void	GetNamespaces (ConstString name, llvm::function_ref< bool(DWARFDIE die)> callback) override

void	GetFunctions (const Module::LookupInfo &lookup_info, SymbolFileDWARF &dwarf, const CompilerDeclContext &parent_decl_ctx, llvm::function_ref< bool(DWARFDIE die)> callback) override

void	GetFunctions (const RegularExpression &regex, llvm::function_ref< bool(DWARFDIE die)> callback) override

void	Dump (Stream &s) override

Public Member Functions inherited from lldb_private::plugin::dwarf::DWARFIndex
	DWARFIndex (Module &module)

virtual	~DWARFIndex ()

virtual void	Preload ()=0

virtual void	GetGlobalVariables (ConstString basename, llvm::function_ref< bool(DWARFDIE die)> callback)=0
	Finds global variables with the given base name.

virtual void	GetGlobalVariables (const RegularExpression &regex, llvm::function_ref< bool(DWARFDIE die)> callback)=0

virtual void	GetGlobalVariables (DWARFUnit &cu, llvm::function_ref< bool(DWARFDIE die)> callback)=0
	cu must be the skeleton unit if possible, not GetNonSkeletonUnit().

virtual void	GetObjCMethods (ConstString class_name, llvm::function_ref< bool(DWARFDIE die)> callback)=0

virtual void	GetCompleteObjCClass (ConstString class_name, bool must_be_implementation, llvm::function_ref< bool(DWARFDIE die)> callback)=0

virtual void	GetTypes (ConstString name, llvm::function_ref< bool(DWARFDIE die)> callback)=0

virtual void	GetTypes (const DWARFDeclContext &context, llvm::function_ref< bool(DWARFDIE die)> callback)=0

virtual void	GetFullyQualifiedType (const DWARFDeclContext &context, llvm::function_ref< bool(DWARFDIE die)> callback)
	Finds all DIEs whose fully qualified name matches `context`.

virtual void	GetNamespaces (ConstString name, llvm::function_ref< bool(DWARFDIE die)> callback)=0

virtual void	GetFunctions (const Module::LookupInfo &lookup_info, SymbolFileDWARF &dwarf, const CompilerDeclContext &parent_decl_ctx, llvm::function_ref< bool(DWARFDIE die)> callback)=0

virtual void	GetFunctions (const RegularExpression &regex, llvm::function_ref< bool(DWARFDIE die)> callback)=0

virtual void	Dump (Stream &s)=0

StatsDuration::Duration	GetIndexTime ()

Static Public Member Functions
static llvm::Expected< std::unique_ptr< DebugNamesDWARFIndex > >	Create (Module &module, DWARFDataExtractor debug_names, DWARFDataExtractor debug_str, SymbolFileDWARF &dwarf)

Private Types
using	DebugNames = llvm::DWARFDebugNames

Private Member Functions
	DebugNamesDWARFIndex (Module &module, std::unique_ptr< llvm::DWARFDebugNames > debug_names_up, DWARFDataExtractor debug_names_data, DWARFDataExtractor debug_str_data, SymbolFileDWARF &dwarf)

DWARFUnit *	GetNonSkeletonUnit (const DebugNames::Entry &entry) const

DWARFDIE	GetDIE (const DebugNames::Entry &entry) const

std::optional< DWARFTypeUnit * >	GetForeignTypeUnit (const DebugNames::Entry &entry) const
	Checks if an entry is a foreign TU and fetch the type unit.

bool	ProcessEntry (const DebugNames::Entry &entry, llvm::function_ref< bool(DWARFDIE die)> callback)

bool	SameParentChain (llvm::ArrayRef< llvm::StringRef > parent_names, llvm::ArrayRef< DebugNames::Entry > parent_entries) const
	Returns true if `parent_entries` have identical names to `parent_names`.

Static Private Member Functions
static void	MaybeLogLookupError (llvm::Error error, const DebugNames::NameIndex &ni, llvm::StringRef name)

static llvm::DenseSet< dw_offset_t >	GetUnits (const DebugNames &debug_names)

static llvm::DenseSet< uint64_t >	GetTypeUnitSignatures (const DebugNames &debug_names)

Private Attributes
DWARFDebugInfo &	m_debug_info

DWARFDataExtractor	m_debug_names_data

DWARFDataExtractor	m_debug_str_data

std::unique_ptr< DebugNames >	m_debug_names_up

ManualDWARFIndex	m_fallback

Additional Inherited Members
Protected Member Functions inherited from lldb_private::plugin::dwarf::DWARFIndex
bool	ProcessFunctionDIE (const Module::LookupInfo &lookup_info, DWARFDIE die, const CompilerDeclContext &parent_decl_ctx, llvm::function_ref< bool(DWARFDIE die)> callback)
	Helper function implementing common logic for processing function dies.

DIERefCallbackImpl	DIERefCallback (llvm::function_ref< bool(DWARFDIE die)> callback, llvm::StringRef name={}) const

void	ReportInvalidDIERef (DIERef ref, llvm::StringRef name) const

bool	GetFullyQualifiedTypeImpl (const DWARFDeclContext &context, DWARFDIE die, llvm::function_ref< bool(DWARFDIE die)> callback)
	Implementation of `GetFullyQualifiedType` to check a single entry, shareable with derived classes.

Protected Attributes inherited from lldb_private::plugin::dwarf::DWARFIndex
Module &	m_module

StatsDuration	m_index_time

Detailed Description

Definition at line 21 of file DebugNamesDWARFIndex.h.

Member Typedef Documentation

◆ DebugNames

using lldb_private::plugin::dwarf::DebugNamesDWARFIndex::DebugNames = llvm::DWARFDebugNames

private

Definition at line 83 of file DebugNamesDWARFIndex.h.

Constructor & Destructor Documentation

◆ DebugNamesDWARFIndex()

lldb_private::plugin::dwarf::DebugNamesDWARFIndex::DebugNamesDWARFIndex	(	Module &	module,
		std::unique_ptr< llvm::DWARFDebugNames >	debug_names_up,
		DWARFDataExtractor	debug_names_data,
		DWARFDataExtractor	debug_str_data,
		SymbolFileDWARF &	dwarf
	)

inlineprivate

Definition at line 65 of file DebugNamesDWARFIndex.h.

Member Function Documentation

◆ Create()

llvm::Expected< std::unique_ptr< DebugNamesDWARFIndex > > DebugNamesDWARFIndex::Create	(	Module &	module,
		DWARFDataExtractor	debug_names,
		DWARFDataExtractor	debug_str,
		SymbolFileDWARF &	dwarf
	)

static

Definition at line 26 of file DebugNamesDWARFIndex.cpp.

References lldb_private::DWARFDataExtractor::GetAsLLVM(), and lldb_private::DWARFDataExtractor::GetAsLLVMDWARF().

Referenced by lldb_private::plugin::dwarf::SymbolFileDWARF::InitializeObject().

◆ Dump()

void DebugNamesDWARFIndex::Dump ( Stream & s )

overridevirtual

Implements lldb_private::plugin::dwarf::DWARFIndex.

Definition at line 497 of file DebugNamesDWARFIndex.cpp.

References lldb_private::plugin::dwarf::ManualDWARFIndex::Dump(), m_debug_names_up, m_fallback, and lldb_private::Stream::PutCString().

◆ GetCompleteObjCClass()

void DebugNamesDWARFIndex::GetCompleteObjCClass	(	ConstString	class_name,
		bool	must_be_implementation,
		llvm::function_ref< bool(DWARFDIE die)>	callback
	)

overridevirtual

Implements lldb_private::plugin::dwarf::DWARFIndex.

Definition at line 256 of file DebugNamesDWARFIndex.cpp.

References lldb_private::plugin::dwarf::DWARFBaseDIE::GetAttributeValueAsUnsigned(), lldb_private::plugin::dwarf::ManualDWARFIndex::GetCompleteObjCClass(), lldb_private::plugin::dwarf::DWARFBaseDIE::GetCU(), GetDIE(), lldb_private::ConstString::GetStringRef(), m_debug_names_up, m_fallback, and lldb_private::plugin::dwarf::DWARFUnit::Supports_DW_AT_APPLE_objc_complete_type().

◆ GetDIE()

DWARFDIE DebugNamesDWARFIndex::GetDIE ( const DebugNames::Entry & entry ) const

private

Definition at line 139 of file DebugNamesDWARFIndex.cpp.

References lldb_private::plugin::dwarf::DWARFUnit::GetDIE(), GetNonSkeletonUnit(), lldb_private::plugin::dwarf::DWARFUnit::GetOffset(), lldb_private::plugin::dwarf::DWARFIndex::m_module, and lldb_private::Module::ReportErrorIfModifyDetected().

Referenced by GetCompleteObjCClass(), GetFunctions(), and ProcessEntry().

◆ GetForeignTypeUnit()

std::optional< DWARFTypeUnit * > DebugNamesDWARFIndex::GetForeignTypeUnit ( const DebugNames::Entry & entry ) const

private

Checks if an entry is a foreign TU and fetch the type unit.

This function checks if the DebugNames::Entry refers to a foreign TU and returns an optional with a value of the entry is a foreign type unit entry. A valid pointer will be returned if this entry is from a .dwo file or if it is from a .dwp file and it matches the type unit's originating .dwo file by verifying that the DW_TAG_type_unit DIE has a DW_AT_dwo_name that matches the DWO name from the originating skeleton compile unit.

Parameters

[in] entry The accelerator table entry to check.

Returns

A std::optional that has a value if this entry represents a foreign type unit. If the pointer is valid, then we were able to find and match the entry to the type unit in the .dwo or .dwp file. The returned value can have a valid, yet contain NULL in the following cases:

we were not able to load the .dwo file (missing or DWO ID mismatch)
we were able to load the .dwp file, but the type units DWO name doesn't match the originating skeleton compile unit's entry Returns std::nullopt if this entry is not a foreign type unit entry.

Definition at line 64 of file DebugNamesDWARFIndex.cpp.

Referenced by GetFullyQualifiedType(), and GetNonSkeletonUnit().

◆ GetFullyQualifiedType()

void DebugNamesDWARFIndex::GetFullyQualifiedType	(	const DWARFDeclContext &	context,
		llvm::function_ref< bool(DWARFDIE die)>	callback
	)

overridevirtual

Uses DWARF5's IDX_parent fields, when available, to speed up this query.

Reimplemented from lldb_private::plugin::dwarf::DWARFIndex.

Definition at line 332 of file DebugNamesDWARFIndex.cpp.

References GetForeignTypeUnit(), lldb_private::plugin::dwarf::DWARFIndex::GetFullyQualifiedTypeImpl(), lldb_private::plugin::dwarf::DWARFDeclContext::GetSize(), m_debug_names_up, ProcessEntry(), and SameParentChain().

◆ GetFunctions() [1/2]

void DebugNamesDWARFIndex::GetFunctions	(	const Module::LookupInfo &	lookup_info,
		SymbolFileDWARF &	dwarf,
		const CompilerDeclContext &	parent_decl_ctx,
		llvm::function_ref< bool(DWARFDIE die)>	callback
	)