LLDB  mainline
Public Types | Public Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
DWARFDebugInfoEntry Class Reference

DWARFDebugInfoEntry objects assume that they are living in one big vector and do pointer arithmetic on their this pointers. More...

#include <DWARFDebugInfoEntry.h>

Collaboration diagram for DWARFDebugInfoEntry:
Collaboration graph
[legend]

Public Types

typedef std::vector< DWARFDebugInfoEntry > collection
 
typedef collection::iterator iterator
 
typedef collection::const_iterator const_iterator
 
using Recurse = DWARFBaseDIE::Recurse
 

Public Member Functions

 DWARFDebugInfoEntry ()
 
 operator bool () const
 
bool operator== (const DWARFDebugInfoEntry &rhs) const
 
bool operator!= (const DWARFDebugInfoEntry &rhs) const
 
void BuildFunctionAddressRangeTable (DWARFUnit *cu, DWARFDebugAranges *debug_aranges) const
 This function is builds a table very similar to the standard .debug_aranges table, except that the actual DIE offset for the function is placed in the table instead of the compile unit offset. More...
 
bool Extract (const lldb_private::DWARFDataExtractor &data, const DWARFUnit *cu, lldb::offset_t *offset_ptr)
 
size_t GetAttributes (DWARFUnit *cu, DWARFAttributes &attrs, Recurse recurse=Recurse::yes) const
 
dw_offset_t GetAttributeValue (const DWARFUnit *cu, const dw_attr_t attr, DWARFFormValue &formValue, dw_offset_t *end_attr_offset_ptr=nullptr, bool check_specification_or_abstract_origin=false) const
 
const char * GetAttributeValueAsString (const DWARFUnit *cu, const dw_attr_t attr, const char *fail_value, bool check_specification_or_abstract_origin=false) const
 
uint64_t GetAttributeValueAsUnsigned (const DWARFUnit *cu, const dw_attr_t attr, uint64_t fail_value, bool check_specification_or_abstract_origin=false) const
 
DWARFDIE GetAttributeValueAsReference (const DWARFUnit *cu, const dw_attr_t attr, bool check_specification_or_abstract_origin=false) const
 
uint64_t GetAttributeValueAsAddress (const DWARFUnit *cu, const dw_attr_t attr, uint64_t fail_value, bool check_specification_or_abstract_origin=false) const
 
dw_addr_t GetAttributeHighPC (const DWARFUnit *cu, dw_addr_t lo_pc, uint64_t fail_value, bool check_specification_or_abstract_origin=false) const
 
bool GetAttributeAddressRange (const DWARFUnit *cu, dw_addr_t &lo_pc, dw_addr_t &hi_pc, uint64_t fail_value, bool check_specification_or_abstract_origin=false) const
 
size_t GetAttributeAddressRanges (DWARFUnit *cu, DWARFRangeList &ranges, bool check_hi_lo_pc, bool check_specification_or_abstract_origin=false) const
 
const char * GetName (const DWARFUnit *cu) const
 
const char * GetMangledName (const DWARFUnit *cu, bool substitute_name_allowed=true) const
 
const char * GetPubname (const DWARFUnit *cu) const
 
const char * GetQualifiedName (DWARFUnit *cu, std::string &storage) const
 
const char * GetQualifiedName (DWARFUnit *cu, const DWARFAttributes &attributes, std::string &storage) const
 
bool GetDIENamesAndRanges (DWARFUnit *cu, const char *&name, const char *&mangled, DWARFRangeList &rangeList, int &decl_file, int &decl_line, int &decl_column, int &call_file, int &call_line, int &call_column, lldb_private::DWARFExpression *frame_base=nullptr) const
 
const DWARFAbbreviationDeclaration * GetAbbreviationDeclarationPtr (const DWARFUnit *cu) const
 
lldb::offset_t GetFirstAttributeOffset () const
 
dw_tag_t Tag () const
 
bool IsNULL () const
 
dw_offset_t GetOffset () const
 
bool HasChildren () const
 
void SetHasChildren (bool b)
 
DWARFDebugInfoEntry * GetParent ()
 
const DWARFDebugInfoEntry * GetParent () const
 
DWARFDebugInfoEntry * GetSibling ()
 
const DWARFDebugInfoEntry * GetSibling () const
 
DWARFDebugInfoEntry * GetFirstChild ()
 
const DWARFDebugInfoEntry * GetFirstChild () const
 
DWARFDeclContext GetDWARFDeclContext (DWARFUnit *cu) const
 
DWARFDIE GetParentDeclContextDIE (DWARFUnit *cu) const
 
DWARFDIE GetParentDeclContextDIE (DWARFUnit *cu, const DWARFAttributes &attributes) const
 
void SetSiblingIndex (uint32_t idx)
 
void SetParentIndex (uint32_t idx)
 
bool IsGlobalOrStaticScopeVariable () const
 

Static Protected Member Functions

static DWARFDeclContext GetDWARFDeclContextStatic (const DWARFDebugInfoEntry *die, DWARFUnit *cu)
 

Protected Attributes

dw_offset_t m_offset
 
uint32_t m_parent_idx = 0
 
uint32_t m_sibling_idx: 31
 
uint32_t m_has_children: 1
 
uint16_t m_abbr_idx = 0
 
dw_tag_t m_tag = llvm::dwarf::DW_TAG_null
 A copy of the DW_TAG value so we don't have to go through the compile unit abbrev table. More...
 

Private Member Functions

size_t GetAttributes (DWARFUnit *cu, DWARFAttributes &attrs, Recurse recurse, uint32_t curr_depth) const
 

Detailed Description

DWARFDebugInfoEntry objects assume that they are living in one big vector and do pointer arithmetic on their this pointers.

Don't pass them by value. Due to the way they are constructed in a std::vector, we cannot delete the copy constructor.

Definition at line 31 of file DWARFDebugInfoEntry.h.

Member Typedef Documentation

◆ collection

typedef std::vector<DWARFDebugInfoEntry> DWARFDebugInfoEntry::collection

Definition at line 33 of file DWARFDebugInfoEntry.h.

◆ const_iterator

typedef collection::const_iterator DWARFDebugInfoEntry::const_iterator

Definition at line 35 of file DWARFDebugInfoEntry.h.

◆ iterator

typedef collection::iterator DWARFDebugInfoEntry::iterator

Definition at line 34 of file DWARFDebugInfoEntry.h.

◆ Recurse

using DWARFDebugInfoEntry::Recurse = DWARFBaseDIE::Recurse

Definition at line 50 of file DWARFDebugInfoEntry.h.

Constructor & Destructor Documentation

◆ DWARFDebugInfoEntry()

DWARFDebugInfoEntry::DWARFDebugInfoEntry ( )
inline

Definition at line 37 of file DWARFDebugInfoEntry.h.

Member Function Documentation

◆ BuildFunctionAddressRangeTable()

void DWARFDebugInfoEntry::BuildFunctionAddressRangeTable ( DWARFUnit *  cu,
DWARFDebugAranges *  debug_aranges 
) const

This function is builds a table very similar to the standard .debug_aranges table, except that the actual DIE offset for the function is placed in the table instead of the compile unit offset.

Definition at line 693 of file DWARFDebugInfoEntry.cpp.

References DWARFDebugAranges::AppendRange(), BuildFunctionAddressRangeTable(), and GetSibling().

Referenced by BuildFunctionAddressRangeTable(), and DWARFUnit::GetFunctionAranges().

◆ Extract()

bool DWARFDebugInfoEntry::Extract ( const lldb_private::DWARFDataExtractor &  data,
const DWARFUnit *  cu,
lldb::offset_t *  offset_ptr 
)

Definition at line 39 of file DWARFDebugInfoEntry.cpp.

References DWARFUnit::GetAddressByteSize(), lldb_private::DataExtractor::GetCStr(), DWARFFormValue::GetFixedSize(), lldb_private::ModuleChild::GetModule(), lldb_private::SymbolFileCommon::GetObjectFile(), DWARFUnit::GetSymbolFileDWARF(), lldb_private::DataExtractor::GetU16_unchecked(), lldb_private::DataExtractor::GetU32(), lldb_private::DataExtractor::GetU32_unchecked(), lldb_private::DataExtractor::GetU8_unchecked(), lldb_private::DataExtractor::GetULEB128(), DWARFUnit::GetVersion(), lldbassert, lldb_private::DataExtractor::Skip_LEB128(), and UINT32_MAX.

Referenced by DWARFUnit::ExtractDIEsRWLocked(), and DWARFUnit::ExtractUnitDIENoDwoIfNeeded().

◆ GetAbbreviationDeclarationPtr()

const DWARFAbbreviationDeclaration * DWARFDebugInfoEntry::GetAbbreviationDeclarationPtr ( const DWARFUnit *  cu) const

Definition at line 853 of file DWARFDebugInfoEntry.cpp.

References DWARFAbbreviationDeclarationSet::GetAbbreviationDeclaration(), and DWARFUnit::GetAbbreviations().

◆ GetAttributeAddressRange()

bool DWARFDebugInfoEntry::GetAttributeAddressRange ( const DWARFUnit *  cu,
dw_addr_t &  lo_pc,
dw_addr_t &  hi_pc,
uint64_t  fail_value,
bool  check_specification_or_abstract_origin = false 
) const

Definition at line 601 of file DWARFDebugInfoEntry.cpp.

◆ GetAttributeAddressRanges()

size_t DWARFDebugInfoEntry::GetAttributeAddressRanges ( DWARFUnit *  cu,
DWARFRangeList &  ranges,
bool  check_hi_lo_pc,
bool  check_specification_or_abstract_origin = false 
) const

Definition at line 617 of file DWARFDebugInfoEntry.cpp.

References lldb_private::RangeVector< B, S, N >::Append(), lldb_private::RangeVector< B, S, N >::Clear(), GetRangesOrReportError(), lldb_private::RangeVector< B, S, N >::GetSize(), and LLDB_INVALID_ADDRESS.

Referenced by DWARFCompileUnit::BuildAddressRangeTable().

◆ GetAttributeHighPC()

dw_addr_t DWARFDebugInfoEntry::GetAttributeHighPC ( const DWARFUnit *  cu,
dw_addr_t  lo_pc,
uint64_t  fail_value,
bool  check_specification_or_abstract_origin = false 
) const

Definition at line 578 of file DWARFDebugInfoEntry.cpp.

References DWARFFormValue::Address(), DWARFFormValue::Form(), and DWARFFormValue::Unsigned().

◆ GetAttributes() [1/2]

size_t DWARFDebugInfoEntry::GetAttributes ( DWARFUnit *  cu,
DWARFAttributes &  attrs,
Recurse  recurse,
uint32_t  curr_depth 
) const
private

Definition at line 406 of file DWARFDebugInfoEntry.cpp.

References DWARFAttributes::Append(), DWARFAttributes::Clear(), DWARFFormValue::ExtractValue(), DWARFFormValue::Form(), DWARFBaseDIE::GetAttributes(), DWARFBaseDIE::GetCU(), DWARFUnit::GetData(), DWARFDIE::GetDIE(), DWARFFormValue::GetFixedSize(), DWARFFormValue::Reference(), DWARFAttributes::Size(), and DWARFFormValue::SkipValue().

◆ GetAttributes() [2/2]

size_t DWARFDebugInfoEntry::GetAttributes ( DWARFUnit *  cu,
DWARFAttributes &  attrs,
Recurse  recurse = Recurse::yes 
) const
inline

Definition at line 51 of file DWARFDebugInfoEntry.h.

Referenced by DWARFUnit::AddUnitDIE().

◆ GetAttributeValue()

dw_offset_t DWARFDebugInfoEntry::GetAttributeValue ( const DWARFUnit *  cu,
const dw_attr_t  attr,
DWARFFormValue &  formValue,
dw_offset_t *  end_attr_offset_ptr = nullptr,
bool  check_specification_or_abstract_origin = false 
) const

Definition at line 468 of file DWARFDebugInfoEntry.cpp.

References DW_INVALID_INDEX, DWARFFormValue::ExtractValue(), DWARFBaseDIE::GetCU(), DWARFUnit::GetData(), DWARFDIE::GetDIE(), DWARFFormValue::Reference(), DWARFFormValue::SetForm(), DWARFFormValue::SetUnit(), and DWARFFormValue::SkipValue().

◆ GetAttributeValueAsAddress()

uint64_t DWARFDebugInfoEntry::GetAttributeValueAsAddress ( const DWARFUnit *  cu,
const dw_attr_t  attr,
uint64_t  fail_value,
bool  check_specification_or_abstract_origin = false 
) const

Definition at line 562 of file DWARFDebugInfoEntry.cpp.

References DWARFFormValue::Address().

◆ GetAttributeValueAsReference()

DWARFDIE DWARFDebugInfoEntry::GetAttributeValueAsReference ( const DWARFUnit *  cu,
const dw_attr_t  attr,
bool  check_specification_or_abstract_origin = false 
) const

Definition at line 552 of file DWARFDebugInfoEntry.cpp.

References DWARFFormValue::Reference().

◆ GetAttributeValueAsString()

const char * DWARFDebugInfoEntry::GetAttributeValueAsString ( const DWARFUnit *  cu,
const dw_attr_t  attr,
const char *  fail_value,
bool  check_specification_or_abstract_origin = false 
) const

Definition at line 525 of file DWARFDebugInfoEntry.cpp.

References DWARFFormValue::AsCString().

Referenced by DWARFUnit::ComputeAbsolutePath(), DWARFUnit::ComputeCompDirAndGuessPathStyle(), GetDWOName(), SymbolFileDWARF::GetDwoSymbolFileForCompileUnit(), and DWARFUnit::ParseProducerInfo().

◆ GetAttributeValueAsUnsigned()

uint64_t DWARFDebugInfoEntry::GetAttributeValueAsUnsigned ( const DWARFUnit *  cu,
const dw_attr_t  attr,
uint64_t  fail_value,
bool  check_specification_or_abstract_origin = false 
) const

Definition at line 538 of file DWARFDebugInfoEntry.cpp.

References DWARFFormValue::Unsigned().

Referenced by DWARFUnit::GetDWARFLanguageType(), GetDWOId(), and DWARFUnit::GetIsOptimized().

◆ GetDIENamesAndRanges()

bool DWARFDebugInfoEntry::GetDIENamesAndRanges ( DWARFUnit *  cu,
const char *&  name,
const char *&  mangled,
DWARFRangeList &  rangeList,
int &  decl_file,
int &  decl_line,
int &  decl_column,
int &  call_file,
int &  call_line,
int &  call_column,
lldb_private::DWARFExpression *  frame_base = nullptr 
) const

Definition at line 230 of file DWARFDebugInfoEntry.cpp.

References DWARFFormValue::Address(), lldb_private::RangeVector< B, S, N >::Append(), DWARFFormValue::AsCString(), DWARFFormValue::BlockData(), DWARFFormValue::ExtractValue(), DWARFFormValue::Form(), DWARFUnit::GetBaseAddress(), lldb_private::DataExtractor::GetByteSize(), DWARFUnit::GetData(), lldb_private::DataExtractor::GetDataStart(), DWARFUnit::GetLocationData(), lldb_private::RangeVector< B, S, N >::GetMinRangeBase(), GetRangesOrReportError(), DWARFUnit::GetSymbolFileDWARF(), lldb_private::RangeVector< B, S, N >::IsEmpty(), LLDB_INVALID_ADDRESS, DWARFFormValue::Reference(), lldb_private::DWARFExpression::SetLocationListAddresses(), DWARFFormValue::Unsigned(), and lldb_private::DataExtractor::ValidOffset().

◆ GetDWARFDeclContext()

DWARFDeclContext DWARFDebugInfoEntry::GetDWARFDeclContext ( DWARFUnit *  cu) const

Definition at line 734 of file DWARFDebugInfoEntry.cpp.

◆ GetDWARFDeclContextStatic()

DWARFDeclContext DWARFDebugInfoEntry::GetDWARFDeclContextStatic ( const DWARFDebugInfoEntry *  die,
DWARFUnit *  cu 
)
staticprotected

Definition at line 715 of file DWARFDebugInfoEntry.cpp.

References DWARFDeclContext::AppendDeclContext(), DWARFBaseDIE::GetCU(), DWARFDIE::GetDIE(), GetName(), GetParentDeclContextDIE(), DWARFBaseDIE::Tag(), and Tag().

◆ GetFirstAttributeOffset()

lldb::offset_t DWARFDebugInfoEntry::GetFirstAttributeOffset ( ) const

Definition at line 848 of file DWARFDebugInfoEntry.cpp.

◆ GetFirstChild() [1/2]

DWARFDebugInfoEntry* DWARFDebugInfoEntry::GetFirstChild ( )
inline

Definition at line 143 of file DWARFDebugInfoEntry.h.

References HasChildren().

◆ GetFirstChild() [2/2]

const DWARFDebugInfoEntry* DWARFDebugInfoEntry::GetFirstChild ( ) const
inline

Definition at line 146 of file DWARFDebugInfoEntry.h.

References HasChildren().

◆ GetMangledName()

const char * DWARFDebugInfoEntry::GetMangledName ( const DWARFUnit *  cu,
bool  substitute_name_allowed = true 
) const

Definition at line 650 of file DWARFDebugInfoEntry.cpp.

◆ GetName()

const char * DWARFDebugInfoEntry::GetName ( const DWARFUnit *  cu) const

Definition at line 641 of file DWARFDebugInfoEntry.cpp.

Referenced by GetDWARFDeclContextStatic().

◆ GetOffset()

dw_offset_t DWARFDebugInfoEntry::GetOffset ( ) const
inline

Definition at line 118 of file DWARFDebugInfoEntry.h.

References m_offset.

Referenced by CompareDIEOffset(), and GetRangesOrReportError().

◆ GetParent() [1/2]

DWARFDebugInfoEntry* DWARFDebugInfoEntry::GetParent ( )
inline

Definition at line 126 of file DWARFDebugInfoEntry.h.

References m_parent_idx.

Referenced by UniqueDWARFASTTypeList::Find(), SymbolFileDWARF::GetTypeForDIE(), and IsGlobalOrStaticScopeVariable().

◆ GetParent() [2/2]

const DWARFDebugInfoEntry* DWARFDebugInfoEntry::GetParent ( ) const
inline

Definition at line 129 of file DWARFDebugInfoEntry.h.

References m_parent_idx.

◆ GetParentDeclContextDIE() [1/2]

DWARFDIE DWARFDebugInfoEntry::GetParentDeclContextDIE ( DWARFUnit *  cu) const

Definition at line 739 of file DWARFDebugInfoEntry.cpp.

Referenced by GetDWARFDeclContextStatic().

◆ GetParentDeclContextDIE() [2/2]

DWARFDIE DWARFDebugInfoEntry::GetParentDeclContextDIE ( DWARFUnit *  cu,
const DWARFAttributes &  attributes 
) const

Definition at line 746 of file DWARFDebugInfoEntry.cpp.

References DWARFAttributes::FormValueAsReference(), DWARFDIE::GetDIE(), DWARFDIE::GetParent(), DWARFDIE::GetParentDeclContextDIE(), and DWARFBaseDIE::Tag().

◆ GetPubname()

const char * DWARFDebugInfoEntry::GetPubname ( const DWARFUnit *  cu) const

Definition at line 673 of file DWARFDebugInfoEntry.cpp.

◆ GetQualifiedName() [1/2]

const char * DWARFDebugInfoEntry::GetQualifiedName ( DWARFUnit *  cu,
const DWARFAttributes &  attributes,
std::string &  storage 
) const

Definition at line 796 of file DWARFDebugInfoEntry.cpp.

References DWARFBaseDIE::Clear(), GetName(), DWARFDIE::GetName(), DWARFDIE::GetParentDeclContextDIE(), and DWARFBaseDIE::Tag().

◆ GetQualifiedName() [2/2]

const char * DWARFDebugInfoEntry::GetQualifiedName ( DWARFUnit *  cu,
std::string &  storage 
) const

Definition at line 788 of file DWARFDebugInfoEntry.cpp.

◆ GetSibling() [1/2]

DWARFDebugInfoEntry* DWARFDebugInfoEntry::GetSibling ( )
inline

Definition at line 134 of file DWARFDebugInfoEntry.h.

References m_sibling_idx.

Referenced by BuildFunctionAddressRangeTable().

◆ GetSibling() [2/2]

const DWARFDebugInfoEntry* DWARFDebugInfoEntry::GetSibling ( ) const
inline

Definition at line 137 of file DWARFDebugInfoEntry.h.

References m_sibling_idx.

◆ HasChildren()

bool DWARFDebugInfoEntry::HasChildren ( ) const
inline

Definition at line 120 of file DWARFDebugInfoEntry.h.

References m_has_children.

Referenced by DWARFUnit::ExtractDIEsRWLocked(), and GetFirstChild().

◆ IsGlobalOrStaticScopeVariable()

bool DWARFDebugInfoEntry::IsGlobalOrStaticScopeVariable ( ) const

Definition at line 862 of file DWARFDebugInfoEntry.cpp.

References GetParent(), and Tag().

◆ IsNULL()

bool DWARFDebugInfoEntry::IsNULL ( ) const
inline

Definition at line 116 of file DWARFDebugInfoEntry.h.

References m_abbr_idx.

Referenced by DWARFUnit::ExtractDIEsRWLocked().

◆ operator bool()

DWARFDebugInfoEntry::operator bool ( ) const
inlineexplicit

Definition at line 40 of file DWARFDebugInfoEntry.h.

References DW_INVALID_OFFSET, and m_offset.

◆ operator!=()

bool DWARFDebugInfoEntry::operator!= ( const DWARFDebugInfoEntry &  rhs) const

Definition at line 892 of file DWARFDebugInfoEntry.cpp.

◆ operator==()

bool DWARFDebugInfoEntry::operator== ( const DWARFDebugInfoEntry &  rhs) const

Definition at line 885 of file DWARFDebugInfoEntry.cpp.

References m_abbr_idx, m_has_children, m_offset, m_parent_idx, m_sibling_idx, and m_tag.

◆ SetHasChildren()

void DWARFDebugInfoEntry::SetHasChildren ( bool  b)
inline

Definition at line 122 of file DWARFDebugInfoEntry.h.

References m_has_children.

Referenced by DWARFUnit::ExtractDIEsRWLocked().

◆ SetParentIndex()

void DWARFDebugInfoEntry::SetParentIndex ( uint32_t  idx)
inline

Definition at line 157 of file DWARFDebugInfoEntry.h.

References m_parent_idx.

Referenced by DWARFUnit::ExtractDIEsRWLocked().

◆ SetSiblingIndex()

void DWARFDebugInfoEntry::SetSiblingIndex ( uint32_t  idx)
inline

Definition at line 156 of file DWARFDebugInfoEntry.h.

References m_sibling_idx.

◆ Tag()

dw_tag_t DWARFDebugInfoEntry::Tag ( ) const
inline

Definition at line 114 of file DWARFDebugInfoEntry.h.

References m_tag.

Referenced by GetDWARFDeclContextStatic(), SymbolFileDWARF::GetTypeForDIE(), and IsGlobalOrStaticScopeVariable().

Member Data Documentation

◆ m_abbr_idx

uint16_t DWARFDebugInfoEntry::m_abbr_idx = 0
protected

Definition at line 176 of file DWARFDebugInfoEntry.h.

Referenced by IsNULL(), and operator==().

◆ m_has_children

uint32_t DWARFDebugInfoEntry::m_has_children
protected

Definition at line 175 of file DWARFDebugInfoEntry.h.

Referenced by HasChildren(), operator==(), and SetHasChildren().

◆ m_offset

dw_offset_t DWARFDebugInfoEntry::m_offset
protected

Definition at line 168 of file DWARFDebugInfoEntry.h.

Referenced by GetOffset(), operator bool(), and operator==().

◆ m_parent_idx

uint32_t DWARFDebugInfoEntry::m_parent_idx = 0
protected

Definition at line 169 of file DWARFDebugInfoEntry.h.

Referenced by GetParent(), operator==(), and SetParentIndex().

◆ m_sibling_idx

uint32_t DWARFDebugInfoEntry::m_sibling_idx
protected

Definition at line 171 of file DWARFDebugInfoEntry.h.

Referenced by GetSibling(), operator==(), and SetSiblingIndex().

◆ m_tag

dw_tag_t DWARFDebugInfoEntry::m_tag = llvm::dwarf::DW_TAG_null
protected

A copy of the DW_TAG value so we don't have to go through the compile unit abbrev table.

Definition at line 179 of file DWARFDebugInfoEntry.h.

Referenced by operator==(), and Tag().

The documentation for this class was generated from the following files:
Generated on Tue Jul 5 2022 13:39:19 for LLDB by   doxygen 1.8.17