#include <DWARFCallFrameInfo.h>

Classes
struct	CIE
struct	FDE
	Parsed representation of a Frame Descriptor Entry. More...

Public Types
enum	Type { EH , DWARF }
typedef RangeVector< lldb::addr_t, uint32_t >	FunctionAddressAndSizeVector

Public Member Functions
	DWARFCallFrameInfo (ObjectFile &objfile, lldb::SectionSP &section, Type type)
	~DWARFCallFrameInfo ()=default
bool	GetAddressRange (Address addr, AddressRange &range)
std::unique_ptr< UnwindPlan >	GetUnwindPlan (const Address &addr)
	Return an UnwindPlan based on the call frame information encoded in the FDE of this DWARFCallFrameInfo section.
std::unique_ptr< UnwindPlan >	GetUnwindPlan (const Address &pc, const Address &func_start)
	Return an UnwindPlan based on the call frame information encoded in the FDE of this DWARFCallFrameInfo section.
std::unique_ptr< UnwindPlan >	GetUnwindPlan (llvm::ArrayRef< AddressRange > ranges, const Address &addr)
	Return an UnwindPlan based on the call frame information encoded in the FDE of this DWARFCallFrameInfo section.
void	GetFunctionAddressAndSizeVector (FunctionAddressAndSizeVector &function_info)
void	ForEachFDEEntries (const std::function< bool(lldb::addr_t, uint32_t, dw_offset_t)> &callback)

Private Types
enum	{ CFI_AUG_MAX_SIZE = 8 , CFI_HEADER_SIZE = 8 }
enum	CFIVersion { CFI_VERSION1 = 1 , CFI_VERSION3 = 3 , CFI_VERSION4 = 4 }
typedef std::shared_ptr< CIE >	CIESP
typedef std::map< dw_offset_t, CIESP >	cie_map_t
typedef RangeDataVector< lldb::addr_t, uint32_t, dw_offset_t >	FDEEntryMap

Private Member Functions
bool	IsEHFrame () const
std::optional< FDEEntryMap::Entry >	GetFirstFDEEntryInRange (const AddressRange &range)
void	GetFDEIndex ()
std::optional< FDE >	ParseFDE (dw_offset_t offset, const Address &startaddr)
const CIE *	GetCIE (dw_offset_t cie_offset)
void	GetCFIData ()
bool	HandleCommonDwarfOpcode (uint8_t primary_opcode, uint8_t extended_opcode, int32_t data_align, lldb::offset_t &offset, UnwindPlan::Row &row)
CIESP	ParseCIE (const dw_offset_t cie_offset)
lldb::RegisterKind	GetRegisterKind () const

Private Attributes
ObjectFile &	m_objfile
lldb::SectionSP	m_section_sp
Flags	m_flags = 0
cie_map_t	m_cie_map
DataExtractor	m_cfi_data
bool	m_cfi_data_initialized = false
FDEEntryMap	m_fde_index
bool	m_fde_index_initialized = false
std::mutex	m_fde_index_mutex
Type	m_type

Detailed Description

Definition at line 33 of file DWARFCallFrameInfo.h.

Member Typedef Documentation

◆ cie_map_t

typedef std::map<dw_offset_t, CIESP> lldb_private::DWARFCallFrameInfo::cie_map_t

private

Definition at line 126 of file DWARFCallFrameInfo.h.

◆ CIESP

typedef std::shared_ptr<CIE> lldb_private::DWARFCallFrameInfo::CIESP

private

Definition at line 124 of file DWARFCallFrameInfo.h.

◆ FDEEntryMap

typedef RangeDataVector<lldb::addr_t, uint32_t, dw_offset_t> lldb_private::DWARFCallFrameInfo::FDEEntryMap

private

Definition at line 131 of file DWARFCallFrameInfo.h.

◆ FunctionAddressAndSizeVector

typedef RangeVector<lldb::addr_t, uint32_t> lldb_private::DWARFCallFrameInfo::FunctionAddressAndSizeVector

Definition at line 66 of file DWARFCallFrameInfo.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
CFI_AUG_MAX_SIZE
CFI_HEADER_SIZE

Definition at line 89 of file DWARFCallFrameInfo.h.

◆ CFIVersion

enum lldb_private::DWARFCallFrameInfo::CFIVersion

private

Enumerator
CFI_VERSION1
CFI_VERSION3
CFI_VERSION4

Definition at line 90 of file DWARFCallFrameInfo.h.

◆ Type

enum lldb_private::DWARFCallFrameInfo::Type

Enumerator
EH
DWARF

Definition at line 35 of file DWARFCallFrameInfo.h.

Constructor & Destructor Documentation

◆ DWARFCallFrameInfo()

DWARFCallFrameInfo::DWARFCallFrameInfo	(	ObjectFile &	objfile,
		lldb::SectionSP &	section,
		Type	type )

Definition at line 169 of file DWARFCallFrameInfo.cpp.

References m_objfile, m_section_sp, and m_type.

◆ ~DWARFCallFrameInfo()

lldb_private::DWARFCallFrameInfo::~DWARFCallFrameInfo ( )

default

References pc.

Member Function Documentation

◆ ForEachFDEEntries()

void DWARFCallFrameInfo::ForEachFDEEntries ( const std::function< bool(lldb::addr_t, uint32_t, dw_offset_t)> & callback )

Definition at line 1028 of file DWARFCallFrameInfo.cpp.

References lldb_private::Range< B, S >::base, lldb_private::RangeData< B, S, T >::data, GetFDEIndex(), m_fde_index, and lldb_private::Range< B, S >::size.

Referenced by ObjectFileELF::ParseUnwindSymbols().

◆ GetAddressRange()

bool DWARFCallFrameInfo::GetAddressRange	(	Address	addr,
		AddressRange &	range )

Definition at line 232 of file DWARFCallFrameInfo.cpp.

References lldb_private::Range< B, S >::base, GetFDEIndex(), lldb_private::Address::GetFileAddress(), lldb_private::Address::GetModule(), m_fde_index, m_objfile, m_section_sp, and lldb_private::Range< B, S >::size.

◆ GetCFIData()

void DWARFCallFrameInfo::GetCFIData ( )

private

Definition at line 458 of file DWARFCallFrameInfo.cpp.

References lldb_private::GetLog(), m_cfi_data, m_cfi_data_initialized, m_objfile, m_section_sp, and lldb_private::Unwind.

Referenced by GetFDEIndex(), ParseCIE(), and ParseFDE().

◆ GetCIE()

const DWARFCallFrameInfo::CIE * DWARFCallFrameInfo::GetCIE ( dw_offset_t cie_offset )

private

Definition at line 290 of file DWARFCallFrameInfo.cpp.

References m_cie_map, and ParseCIE().

Referenced by GetFDEIndex(), and ParseFDE().

◆ GetFDEIndex()

void DWARFCallFrameInfo::GetFDEIndex ( )

private

◆ GetFirstFDEEntryInRange()

std::optional< DWARFCallFrameInfo::FDEEntryMap::Entry > DWARFCallFrameInfo::GetFirstFDEEntryInRange ( const AddressRange & range )

private

Definition at line 255 of file DWARFCallFrameInfo.cpp.

References lldb_private::Range< B, S >::DoesIntersect(), lldb_private::AddressRange::GetBaseAddress(), lldb_private::AddressRange::GetByteSize(), GetFDEIndex(), lldb_private::Address::GetFileAddress(), m_fde_index, and m_section_sp.

Referenced by GetUnwindPlan().

◆ GetFunctionAddressAndSizeVector()

void DWARFCallFrameInfo::GetFunctionAddressAndSizeVector ( FunctionAddressAndSizeVector & function_info )

Definition at line 271 of file DWARFCallFrameInfo.cpp.

References lldb_private::RangeVector< B, S, N >::Append(), lldb_private::Range< B, S >::base, lldb_private::RangeVector< B, S, N >::Clear(), GetFDEIndex(), m_fde_index, lldb_private::RangeVector< B, S, N >::Reserve(), and lldb_private::Range< B, S >::size.

Referenced by ObjectFileMachO::ParseSymtab().

◆ GetRegisterKind()

lldb::RegisterKind lldb_private::DWARFCallFrameInfo::GetRegisterKind ( ) const

inlineprivate

Definition at line 179 of file DWARFCallFrameInfo.h.

References EH, lldb::eRegisterKindDWARF, lldb::eRegisterKindEHFrame, and m_type.

Referenced by GetUnwindPlan().

◆ GetUnwindPlan() [1/3]

std::unique_ptr< UnwindPlan > DWARFCallFrameInfo::GetUnwindPlan ( const Address & addr )

Return an UnwindPlan based on the call frame information encoded in the FDE of this DWARFCallFrameInfo section.

The returned plan will be valid (at least) for the given address.

Definition at line 174 of file DWARFCallFrameInfo.cpp.

References GetUnwindPlan().

Referenced by GetUnwindPlan(), and GetUnwindPlan().

◆ GetUnwindPlan() [2/3]

std::unique_ptr< UnwindPlan > DWARFCallFrameInfo::GetUnwindPlan	(	const Address &	pc,
		const Address &	func_start )

Return an UnwindPlan based on the call frame information encoded in the FDE of this DWARFCallFrameInfo section.

The returned plan will be valid (at least) for pc. func_start corresponds to the offset zero in the returned UnwindPlan.

Definition at line 179 of file DWARFCallFrameInfo.cpp.

References GetUnwindPlan(), and pc.

◆ GetUnwindPlan() [3/3]

std::unique_ptr< UnwindPlan > DWARFCallFrameInfo::GetUnwindPlan	(	llvm::ArrayRef< AddressRange >	ranges,
		const Address &	addr )

Return an UnwindPlan based on the call frame information encoded in the FDE of this DWARFCallFrameInfo section.

The returned plan will be valid (at least) for some address in the given ranges. If no unwind information is found, nullptr is returned. addr represents the entry point of the function. It corresponds to the offset zero in the returned UnwindPlan.

Definition at line 185 of file DWARFCallFrameInfo.cpp.

References EH, lldb_private::eLazyBoolNo, lldb_private::eLazyBoolYes, lldb_private::Address::GetFileAddress(), GetFirstFDEEntryInRange(), lldb_private::Address::GetModule(), GetRegisterKind(), m_objfile, m_type, ParseFDE(), and lldb_private::UnwindPlan::Row::SlideOffset().

◆ HandleCommonDwarfOpcode()

bool DWARFCallFrameInfo::HandleCommonDwarfOpcode	(	uint8_t	primary_opcode,
		uint8_t	extended_opcode,
		int32_t	data_align,
		lldb::offset_t &	offset,
		UnwindPlan::Row &	row )

private

Definition at line 830 of file DWARFCallFrameInfo.cpp.

Referenced by ParseCIE(), and ParseFDE().

◆ IsEHFrame()

bool lldb_private::DWARFCallFrameInfo::IsEHFrame ( ) const

private

◆ ParseCIE()

DWARFCallFrameInfo::CIESP DWARFCallFrameInfo::ParseCIE ( const dw_offset_t cie_offset )

private

Definition at line 304 of file DWARFCallFrameInfo.cpp.

References CFI_AUG_MAX_SIZE, CFI_VERSION3, CFI_VERSION4, DWARF, GetCFIData(), GetGNUEHPointer(), HandleCommonDwarfOpcode(), IsCIEMarker(), LLDB_INVALID_ADDRESS, m_cfi_data, m_cfi_data_initialized, m_section_sp, m_type, and lldb_private::Debugger::ReportError().

Referenced by GetCIE(), and GetFDEIndex().

◆ ParseFDE()

std::optional< DWARFCallFrameInfo::FDE > DWARFCallFrameInfo::ParseFDE	(	dw_offset_t	offset,
		const Address &	startaddr )

private

Definition at line 580 of file DWARFCallFrameInfo.cpp.

References DW_EH_PE_MASK_ENCODING, EH, lldb_private::DWARFCallFrameInfo::FDE::for_signal_trap, GetCFIData(), GetCIE(), lldb_private::Address::GetFileAddress(), GetGNUEHPointer(), lldb_private::GetLog(), lldb_private::UnwindPlan::Row::GetOffset(), HandleCommonDwarfOpcode(), LLDB_INVALID_ADDRESS, LLDB_LOG, m_cfi_data, m_cfi_data_initialized, m_objfile, m_section_sp, m_type, lldb_private::DWARFCallFrameInfo::FDE::range, lldb_private::UnwindPlan::Row::RemoveRegisterInfo(), lldb_private::DWARFCallFrameInfo::FDE::return_addr_reg_num, lldb_private::DWARFCallFrameInfo::FDE::rows, lldb_private::AddressRange::SetByteSize(), lldb_private::UnwindPlan::Row::AbstractRegisterLocation::SetIsCFAPlusOffset(), lldb_private::UnwindPlan::Row::SetOffset(), lldb_private::UnwindPlan::Row::SetRegisterInfo(), lldb_private::UnwindPlan::Row::SlideOffset(), and lldb_private::Unwind.

Referenced by GetUnwindPlan().

Member Data Documentation

◆ m_cfi_data

DataExtractor lldb_private::DWARFCallFrameInfo::m_cfi_data

private

Definition at line 167 of file DWARFCallFrameInfo.h.

Referenced by GetCFIData(), GetFDEIndex(), HandleCommonDwarfOpcode(), ParseCIE(), and ParseFDE().

◆ m_cfi_data_initialized

bool lldb_private::DWARFCallFrameInfo::m_cfi_data_initialized = false

private

Definition at line 168 of file DWARFCallFrameInfo.h.

Referenced by GetCFIData(), GetFDEIndex(), ParseCIE(), and ParseFDE().

◆ m_cie_map

cie_map_t lldb_private::DWARFCallFrameInfo::m_cie_map

private

Definition at line 165 of file DWARFCallFrameInfo.h.

Referenced by GetCIE(), and GetFDEIndex().

◆ m_fde_index

FDEEntryMap lldb_private::DWARFCallFrameInfo::m_fde_index

private

Definition at line 170 of file DWARFCallFrameInfo.h.

Referenced by ForEachFDEEntries(), GetAddressRange(), GetFDEIndex(), GetFirstFDEEntryInRange(), and GetFunctionAddressAndSizeVector().

◆ m_fde_index_initialized

bool lldb_private::DWARFCallFrameInfo::m_fde_index_initialized = false

private

Definition at line 171 of file DWARFCallFrameInfo.h.

Referenced by GetFDEIndex().

◆ m_fde_index_mutex

std::mutex lldb_private::DWARFCallFrameInfo::m_fde_index_mutex

private

Definition at line 172 of file DWARFCallFrameInfo.h.

Referenced by GetFDEIndex().

◆ m_flags

Flags lldb_private::DWARFCallFrameInfo::m_flags = 0

private

Definition at line 164 of file DWARFCallFrameInfo.h.

◆ m_objfile

ObjectFile& lldb_private::DWARFCallFrameInfo::m_objfile

private

Definition at line 162 of file DWARFCallFrameInfo.h.

Referenced by DWARFCallFrameInfo(), GetAddressRange(), GetCFIData(), GetFDEIndex(), GetUnwindPlan(), and ParseFDE().

◆ m_section_sp

lldb::SectionSP lldb_private::DWARFCallFrameInfo::m_section_sp

private

Definition at line 163 of file DWARFCallFrameInfo.h.

Referenced by DWARFCallFrameInfo(), GetAddressRange(), GetCFIData(), GetFDEIndex(), GetFirstFDEEntryInRange(), ParseCIE(), and ParseFDE().

◆ m_type

Type lldb_private::DWARFCallFrameInfo::m_type

private

Definition at line 174 of file DWARFCallFrameInfo.h.

Referenced by DWARFCallFrameInfo(), GetFDEIndex(), GetRegisterKind(), GetUnwindPlan(), ParseCIE(), and ParseFDE().

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

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ cie_map_t

◆ CIESP

◆ FDEEntryMap

◆ FunctionAddressAndSizeVector

Member Enumeration Documentation

◆ anonymous enum

◆ CFIVersion

◆ Type

Constructor & Destructor Documentation

◆ DWARFCallFrameInfo()

◆ ~DWARFCallFrameInfo()

Member Function Documentation

◆ ForEachFDEEntries()

◆ GetAddressRange()

◆ GetCFIData()

◆ GetCIE()

◆ GetFDEIndex()

◆ GetFirstFDEEntryInRange()

◆ GetFunctionAddressAndSizeVector()

◆ GetRegisterKind()

◆ GetUnwindPlan() [1/3]

◆ GetUnwindPlan() [2/3]

◆ GetUnwindPlan() [3/3]

◆ HandleCommonDwarfOpcode()

◆ IsEHFrame()

◆ ParseCIE()

◆ ParseFDE()

Member Data Documentation

◆ m_cfi_data

◆ m_cfi_data_initialized

◆ m_cie_map

◆ m_fde_index

◆ m_fde_index_initialized

◆ m_fde_index_mutex

◆ m_flags

◆ m_objfile

◆ m_section_sp

◆ m_type