You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
353 lines
12 KiB
353 lines
12 KiB
4 months ago
|
//===-- DWARFUnit.h ---------------------------------------------*- C++ -*-===//
|
||
|
//
|
||
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
||
|
// See https://llvm.org/LICENSE.txt for license information.
|
||
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
||
|
//
|
||
|
//===----------------------------------------------------------------------===//
|
||
|
|
||
|
#ifndef LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFUNIT_H
|
||
|
#define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFUNIT_H
|
||
|
|
||
|
#include "DWARFDIE.h"
|
||
|
#include "DWARFDebugInfoEntry.h"
|
||
|
#include "lldb/lldb-enumerations.h"
|
||
|
#include "lldb/Utility/XcodeSDK.h"
|
||
|
#include "llvm/Support/RWMutex.h"
|
||
|
#include <atomic>
|
||
|
|
||
|
class DWARFUnit;
|
||
|
class DWARFCompileUnit;
|
||
|
class NameToDIE;
|
||
|
class SymbolFileDWARF;
|
||
|
class SymbolFileDWARFDwo;
|
||
|
|
||
|
typedef std::shared_ptr<DWARFUnit> DWARFUnitSP;
|
||
|
|
||
|
enum DWARFProducer {
|
||
|
eProducerInvalid = 0,
|
||
|
eProducerClang,
|
||
|
eProducerGCC,
|
||
|
eProducerLLVMGCC,
|
||
|
eProcucerOther
|
||
|
};
|
||
|
|
||
|
/// Base class describing the header of any kind of "unit." Some information
|
||
|
/// is specific to certain unit types. We separate this class out so we can
|
||
|
/// parse the header before deciding what specific kind of unit to construct.
|
||
|
class DWARFUnitHeader {
|
||
|
dw_offset_t m_offset = 0;
|
||
|
dw_offset_t m_length = 0;
|
||
|
uint16_t m_version = 0;
|
||
|
dw_offset_t m_abbr_offset = 0;
|
||
|
|
||
|
const llvm::DWARFUnitIndex::Entry *m_index_entry = nullptr;
|
||
|
|
||
|
uint8_t m_unit_type = 0;
|
||
|
uint8_t m_addr_size = 0;
|
||
|
|
||
|
uint64_t m_type_hash = 0;
|
||
|
uint32_t m_type_offset = 0;
|
||
|
|
||
|
uint64_t m_dwo_id = 0;
|
||
|
|
||
|
DWARFUnitHeader() = default;
|
||
|
|
||
|
public:
|
||
|
dw_offset_t GetOffset() const { return m_offset; }
|
||
|
uint16_t GetVersion() const { return m_version; }
|
||
|
uint16_t GetAddressByteSize() const { return m_addr_size; }
|
||
|
dw_offset_t GetLength() const { return m_length; }
|
||
|
dw_offset_t GetAbbrOffset() const { return m_abbr_offset; }
|
||
|
uint8_t GetUnitType() const { return m_unit_type; }
|
||
|
const llvm::DWARFUnitIndex::Entry *GetIndexEntry() const {
|
||
|
return m_index_entry;
|
||
|
}
|
||
|
uint64_t GetTypeHash() const { return m_type_hash; }
|
||
|
dw_offset_t GetTypeOffset() const { return m_type_offset; }
|
||
|
bool IsTypeUnit() const {
|
||
|
return m_unit_type == DW_UT_type || m_unit_type == DW_UT_split_type;
|
||
|
}
|
||
|
uint32_t GetNextUnitOffset() const { return m_offset + m_length + 4; }
|
||
|
|
||
|
static llvm::Expected<DWARFUnitHeader>
|
||
|
extract(const lldb_private::DWARFDataExtractor &data, DIERef::Section section,
|
||
|
lldb::offset_t *offset_ptr, const llvm::DWARFUnitIndex *index);
|
||
|
};
|
||
|
|
||
|
class DWARFUnit : public lldb_private::UserID {
|
||
|
using die_iterator_range =
|
||
|
llvm::iterator_range<DWARFDebugInfoEntry::collection::iterator>;
|
||
|
|
||
|
public:
|
||
|
static llvm::Expected<DWARFUnitSP>
|
||
|
extract(SymbolFileDWARF &dwarf2Data, lldb::user_id_t uid,
|
||
|
const lldb_private::DWARFDataExtractor &debug_info,
|
||
|
DIERef::Section section, lldb::offset_t *offset_ptr,
|
||
|
const llvm::DWARFUnitIndex *index);
|
||
|
virtual ~DWARFUnit();
|
||
|
|
||
|
bool IsDWOUnit() { return m_is_dwo; }
|
||
|
|
||
|
void ExtractUnitDIEIfNeeded();
|
||
|
void ExtractDIEsIfNeeded();
|
||
|
|
||
|
class ScopedExtractDIEs {
|
||
|
DWARFUnit *m_cu;
|
||
|
public:
|
||
|
bool m_clear_dies = false;
|
||
|
ScopedExtractDIEs(DWARFUnit &cu);
|
||
|
~ScopedExtractDIEs();
|
||
|
ScopedExtractDIEs(const ScopedExtractDIEs &) = delete;
|
||
|
const ScopedExtractDIEs &operator=(const ScopedExtractDIEs &) = delete;
|
||
|
ScopedExtractDIEs(ScopedExtractDIEs &&rhs);
|
||
|
ScopedExtractDIEs &operator=(ScopedExtractDIEs &&rhs);
|
||
|
};
|
||
|
ScopedExtractDIEs ExtractDIEsScoped();
|
||
|
|
||
|
bool Verify(lldb_private::Stream *s) const;
|
||
|
virtual void Dump(lldb_private::Stream *s) const = 0;
|
||
|
/// Get the data that contains the DIE information for this unit.
|
||
|
///
|
||
|
/// This will return the correct bytes that contain the data for
|
||
|
/// this DWARFUnit. It could be .debug_info or .debug_types
|
||
|
/// depending on where the data for this unit originates.
|
||
|
///
|
||
|
/// \return
|
||
|
/// The correct data for the DIE information in this unit.
|
||
|
const lldb_private::DWARFDataExtractor &GetData() const;
|
||
|
|
||
|
/// Get the size in bytes of the unit header.
|
||
|
///
|
||
|
/// \return
|
||
|
/// Byte size of the unit header
|
||
|
uint32_t GetHeaderByteSize() const;
|
||
|
|
||
|
// Offset of the initial length field.
|
||
|
dw_offset_t GetOffset() const { return m_header.GetOffset(); }
|
||
|
/// Get the size in bytes of the length field in the header.
|
||
|
///
|
||
|
/// In DWARF32 this is just 4 bytes
|
||
|
///
|
||
|
/// \return
|
||
|
/// Byte size of the compile unit header length field
|
||
|
size_t GetLengthByteSize() const { return 4; }
|
||
|
|
||
|
bool ContainsDIEOffset(dw_offset_t die_offset) const {
|
||
|
return die_offset >= GetFirstDIEOffset() &&
|
||
|
die_offset < GetNextUnitOffset();
|
||
|
}
|
||
|
dw_offset_t GetFirstDIEOffset() const {
|
||
|
return GetOffset() + GetHeaderByteSize();
|
||
|
}
|
||
|
dw_offset_t GetNextUnitOffset() const { return m_header.GetNextUnitOffset(); }
|
||
|
// Size of the CU data (without initial length and without header).
|
||
|
size_t GetDebugInfoSize() const;
|
||
|
// Size of the CU data incl. header but without initial length.
|
||
|
uint32_t GetLength() const { return m_header.GetLength(); }
|
||
|
uint16_t GetVersion() const { return m_header.GetVersion(); }
|
||
|
const DWARFAbbreviationDeclarationSet *GetAbbreviations() const;
|
||
|
dw_offset_t GetAbbrevOffset() const;
|
||
|
uint8_t GetAddressByteSize() const { return m_header.GetAddressByteSize(); }
|
||
|
dw_addr_t GetAddrBase() const { return m_addr_base; }
|
||
|
dw_addr_t GetBaseAddress() const { return m_base_addr; }
|
||
|
dw_offset_t GetLineTableOffset();
|
||
|
dw_addr_t GetRangesBase() const { return m_ranges_base; }
|
||
|
dw_addr_t GetStrOffsetsBase() const { return m_str_offsets_base; }
|
||
|
void SetAddrBase(dw_addr_t addr_base);
|
||
|
void SetLoclistsBase(dw_addr_t loclists_base);
|
||
|
void SetRangesBase(dw_addr_t ranges_base);
|
||
|
void SetStrOffsetsBase(dw_offset_t str_offsets_base);
|
||
|
virtual void BuildAddressRangeTable(DWARFDebugAranges *debug_aranges) = 0;
|
||
|
|
||
|
lldb::ByteOrder GetByteOrder() const;
|
||
|
|
||
|
const DWARFDebugAranges &GetFunctionAranges();
|
||
|
|
||
|
void SetBaseAddress(dw_addr_t base_addr);
|
||
|
|
||
|
DWARFBaseDIE GetUnitDIEOnly() { return {this, GetUnitDIEPtrOnly()}; }
|
||
|
|
||
|
DWARFDIE DIE() { return DWARFDIE(this, DIEPtr()); }
|
||
|
|
||
|
DWARFDIE GetDIE(dw_offset_t die_offset);
|
||
|
|
||
|
DWARFUnit &GetNonSkeletonUnit();
|
||
|
|
||
|
static uint8_t GetAddressByteSize(const DWARFUnit *cu);
|
||
|
|
||
|
static uint8_t GetDefaultAddressSize();
|
||
|
|
||
|
void *GetUserData() const;
|
||
|
|
||
|
void SetUserData(void *d);
|
||
|
|
||
|
bool Supports_DW_AT_APPLE_objc_complete_type();
|
||
|
|
||
|
bool DW_AT_decl_file_attributes_are_invalid();
|
||
|
|
||
|
bool Supports_unnamed_objc_bitfields();
|
||
|
|
||
|
SymbolFileDWARF &GetSymbolFileDWARF() const { return m_dwarf; }
|
||
|
|
||
|
DWARFProducer GetProducer();
|
||
|
|
||
|
uint32_t GetProducerVersionMajor();
|
||
|
|
||
|
uint32_t GetProducerVersionMinor();
|
||
|
|
||
|
uint32_t GetProducerVersionUpdate();
|
||
|
|
||
|
uint64_t GetDWARFLanguageType();
|
||
|
|
||
|
bool GetIsOptimized();
|
||
|
|
||
|
const lldb_private::FileSpec &GetCompilationDirectory();
|
||
|
const lldb_private::FileSpec &GetAbsolutePath();
|
||
|
lldb_private::FileSpec GetFile(size_t file_idx);
|
||
|
lldb_private::FileSpec::Style GetPathStyle();
|
||
|
|
||
|
SymbolFileDWARFDwo *GetDwoSymbolFile();
|
||
|
|
||
|
die_iterator_range dies() {
|
||
|
ExtractDIEsIfNeeded();
|
||
|
return die_iterator_range(m_die_array.begin(), m_die_array.end());
|
||
|
}
|
||
|
|
||
|
DIERef::Section GetDebugSection() const { return m_section; }
|
||
|
|
||
|
uint8_t GetUnitType() const { return m_header.GetUnitType(); }
|
||
|
bool IsTypeUnit() const { return m_header.IsTypeUnit(); }
|
||
|
|
||
|
llvm::Optional<uint64_t> GetStringOffsetSectionItem(uint32_t index) const;
|
||
|
|
||
|
/// Return a list of address ranges resulting from a (possibly encoded)
|
||
|
/// range list starting at a given offset in the appropriate ranges section.
|
||
|
llvm::Expected<DWARFRangeList> FindRnglistFromOffset(dw_offset_t offset);
|
||
|
|
||
|
/// Return a list of address ranges retrieved from an encoded range
|
||
|
/// list whose offset is found via a table lookup given an index (DWARF v5
|
||
|
/// and later).
|
||
|
llvm::Expected<DWARFRangeList> FindRnglistFromIndex(uint32_t index);
|
||
|
|
||
|
/// Return a rangelist's offset based on an index. The index designates
|
||
|
/// an entry in the rangelist table's offset array and is supplied by
|
||
|
/// DW_FORM_rnglistx.
|
||
|
llvm::Optional<uint64_t> GetRnglistOffset(uint32_t Index) const {
|
||
|
if (!m_rnglist_table)
|
||
|
return llvm::None;
|
||
|
if (llvm::Optional<uint64_t> off = m_rnglist_table->getOffsetEntry(
|
||
|
m_dwarf.GetDWARFContext().getOrLoadRngListsData().GetAsLLVM(),
|
||
|
Index))
|
||
|
return *off + m_ranges_base;
|
||
|
return llvm::None;
|
||
|
}
|
||
|
|
||
|
llvm::Optional<uint64_t> GetLoclistOffset(uint32_t Index) {
|
||
|
if (!m_loclist_table_header)
|
||
|
return llvm::None;
|
||
|
|
||
|
llvm::Optional<uint64_t> Offset = m_loclist_table_header->getOffsetEntry(
|
||
|
m_dwarf.GetDWARFContext().getOrLoadLocListsData().GetAsLLVM(), Index);
|
||
|
if (!Offset)
|
||
|
return llvm::None;
|
||
|
return *Offset + m_loclists_base;
|
||
|
}
|
||
|
|
||
|
/// Return the location table for parsing the given location list data. The
|
||
|
/// format is chosen according to the unit type. Never returns null.
|
||
|
std::unique_ptr<llvm::DWARFLocationTable>
|
||
|
GetLocationTable(const lldb_private::DataExtractor &data) const;
|
||
|
|
||
|
lldb_private::DWARFDataExtractor GetLocationData() const;
|
||
|
|
||
|
protected:
|
||
|
DWARFUnit(SymbolFileDWARF &dwarf, lldb::user_id_t uid,
|
||
|
const DWARFUnitHeader &header,
|
||
|
const DWARFAbbreviationDeclarationSet &abbrevs,
|
||
|
DIERef::Section section, bool is_dwo);
|
||
|
|
||
|
llvm::Error ExtractHeader(SymbolFileDWARF &dwarf,
|
||
|
const lldb_private::DWARFDataExtractor &data,
|
||
|
lldb::offset_t *offset_ptr);
|
||
|
|
||
|
// Get the DWARF unit DWARF debug information entry. Parse the single DIE
|
||
|
// if needed.
|
||
|
const DWARFDebugInfoEntry *GetUnitDIEPtrOnly() {
|
||
|
ExtractUnitDIEIfNeeded();
|
||
|
// m_first_die_mutex is not required as m_first_die is never cleared.
|
||
|
if (!m_first_die)
|
||
|
return NULL;
|
||
|
return &m_first_die;
|
||
|
}
|
||
|
|
||
|
// Get all DWARF debug informration entries. Parse all DIEs if needed.
|
||
|
const DWARFDebugInfoEntry *DIEPtr() {
|
||
|
ExtractDIEsIfNeeded();
|
||
|
if (m_die_array.empty())
|
||
|
return NULL;
|
||
|
return &m_die_array[0];
|
||
|
}
|
||
|
|
||
|
SymbolFileDWARF &m_dwarf;
|
||
|
std::shared_ptr<DWARFUnit> m_dwo;
|
||
|
DWARFUnitHeader m_header;
|
||
|
const DWARFAbbreviationDeclarationSet *m_abbrevs = nullptr;
|
||
|
void *m_user_data = nullptr;
|
||
|
// The compile unit debug information entry item
|
||
|
DWARFDebugInfoEntry::collection m_die_array;
|
||
|
mutable llvm::sys::RWMutex m_die_array_mutex;
|
||
|
// It is used for tracking of ScopedExtractDIEs instances.
|
||
|
mutable llvm::sys::RWMutex m_die_array_scoped_mutex;
|
||
|
// ScopedExtractDIEs instances should not call ClearDIEsRWLocked()
|
||
|
// as someone called ExtractDIEsIfNeeded().
|
||
|
std::atomic<bool> m_cancel_scopes;
|
||
|
// GetUnitDIEPtrOnly() needs to return pointer to the first DIE.
|
||
|
// But the first element of m_die_array after ExtractUnitDIEIfNeeded()
|
||
|
// would possibly move in memory after later ExtractDIEsIfNeeded().
|
||
|
DWARFDebugInfoEntry m_first_die;
|
||
|
llvm::sys::RWMutex m_first_die_mutex;
|
||
|
// A table similar to the .debug_aranges table, but this one points to the
|
||
|
// exact DW_TAG_subprogram DIEs
|
||
|
std::unique_ptr<DWARFDebugAranges> m_func_aranges_up;
|
||
|
dw_addr_t m_base_addr = 0;
|
||
|
DWARFProducer m_producer = eProducerInvalid;
|
||
|
uint32_t m_producer_version_major = 0;
|
||
|
uint32_t m_producer_version_minor = 0;
|
||
|
uint32_t m_producer_version_update = 0;
|
||
|
llvm::Optional<uint64_t> m_language_type;
|
||
|
lldb_private::LazyBool m_is_optimized = lldb_private::eLazyBoolCalculate;
|
||
|
llvm::Optional<lldb_private::FileSpec> m_comp_dir;
|
||
|
llvm::Optional<lldb_private::FileSpec> m_file_spec;
|
||
|
dw_addr_t m_addr_base = 0; ///< Value of DW_AT_addr_base.
|
||
|
dw_addr_t m_loclists_base = 0; ///< Value of DW_AT_loclists_base.
|
||
|
dw_addr_t m_ranges_base = 0; ///< Value of DW_AT_rnglists_base.
|
||
|
|
||
|
/// Value of DW_AT_stmt_list.
|
||
|
dw_offset_t m_line_table_offset = DW_INVALID_OFFSET;
|
||
|
|
||
|
dw_offset_t m_str_offsets_base = 0; // Value of DW_AT_str_offsets_base.
|
||
|
|
||
|
llvm::Optional<llvm::DWARFDebugRnglistTable> m_rnglist_table;
|
||
|
llvm::Optional<llvm::DWARFListTableHeader> m_loclist_table_header;
|
||
|
|
||
|
const DIERef::Section m_section;
|
||
|
bool m_is_dwo;
|
||
|
|
||
|
private:
|
||
|
void ParseProducerInfo();
|
||
|
void ExtractDIEsRWLocked();
|
||
|
void ClearDIEsRWLocked();
|
||
|
|
||
|
void AddUnitDIE(const DWARFDebugInfoEntry &cu_die);
|
||
|
void SetDwoStrOffsetsBase();
|
||
|
|
||
|
void ComputeCompDirAndGuessPathStyle();
|
||
|
void ComputeAbsolutePath();
|
||
|
|
||
|
DWARFUnit(const DWARFUnit &) = delete;
|
||
|
const DWARFUnit &operator=(const DWARFUnit &) = delete;
|
||
|
};
|
||
|
|
||
|
#endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFUNIT_H
|