Summary: When dwo support was introduced, it used a trick where debug info entries were referenced by the offset of the compile unit in the main file, but the die offset was relative to the dwo file. Although there was some elegance to it, this representation was starting to reach its breaking point: - the fact that the skeleton compile unit owned the DWO file meant that it was impossible (or at least hard and unintuitive) to support DWO files containing more than one compile unit. These kinds of files are produced by LTO for example. - it made it impossible to reference any DIEs in the skeleton compile unit (although the skeleton units are generally empty, clang still puts some info into them with -fsplit-dwarf-inlining). - (current motivation) it made it very hard to support type units placed in DWO files, as type units don't have any skeleton units which could be referenced in the main file This patch addresses this problem by introducing an new "dwo_num" field to the DIERef class, whose purpose is to identify the dwo file. It's kind of similar to the dwo_id field in DWARF5 unit headers, but while this is a 64bit hash whose main purpose is to catch file mismatches, this is just a smaller integer used to indentify a loaded dwo file. Currently, this is based on the index of the skeleton compile unit which owns the dwo file, but it is intended to be eventually independent of that (to support the LTO use case). Simultaneously the cu_offset is dropped to conserve space, as it is no longer necessary. This means we can remove the "BaseObjectOffset" field from the DWARFUnit class. It also means we can remove some of the workarounds put in place to support the skeleton-unit+dwo-die combo. More work is needed to remove all of them, which is out of scope of this patch. Reviewers: JDevlieghere, clayborg, aprantl Subscribers: mehdi_amini, dexonsmith, arphaman, lldb-commits Differential Revision: https://reviews.llvm.org/D63428 llvm-svn: 364009
82 lines
3.4 KiB
C++
82 lines
3.4 KiB
C++
//===-- DebugNamesDWARFIndex.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_DEBUGNAMESDWARFINDEX_H
|
|
#define LLDB_DEBUGNAMESDWARFINDEX_H
|
|
|
|
#include "Plugins/SymbolFile/DWARF/DWARFIndex.h"
|
|
#include "Plugins/SymbolFile/DWARF/LogChannelDWARF.h"
|
|
#include "Plugins/SymbolFile/DWARF/ManualDWARFIndex.h"
|
|
#include "lldb/Utility/ConstString.h"
|
|
#include "llvm/DebugInfo/DWARF/DWARFAcceleratorTable.h"
|
|
|
|
namespace lldb_private {
|
|
class DebugNamesDWARFIndex : public DWARFIndex {
|
|
public:
|
|
static llvm::Expected<std::unique_ptr<DebugNamesDWARFIndex>>
|
|
Create(Module &module, DWARFDataExtractor debug_names,
|
|
DWARFDataExtractor debug_str, DWARFDebugInfo *debug_info);
|
|
|
|
void Preload() override { m_fallback.Preload(); }
|
|
|
|
void GetGlobalVariables(ConstString basename, DIEArray &offsets) override;
|
|
void GetGlobalVariables(const RegularExpression ®ex,
|
|
DIEArray &offsets) override;
|
|
void GetGlobalVariables(const DWARFUnit &cu, DIEArray &offsets) override;
|
|
void GetObjCMethods(ConstString class_name, DIEArray &offsets) override {}
|
|
void GetCompleteObjCClass(ConstString class_name, bool must_be_implementation,
|
|
DIEArray &offsets) override;
|
|
void GetTypes(ConstString name, DIEArray &offsets) override;
|
|
void GetTypes(const DWARFDeclContext &context, DIEArray &offsets) override;
|
|
void GetNamespaces(ConstString name, DIEArray &offsets) override;
|
|
void GetFunctions(ConstString name, SymbolFileDWARF &dwarf,
|
|
const CompilerDeclContext &parent_decl_ctx,
|
|
uint32_t name_type_mask,
|
|
std::vector<DWARFDIE> &dies) override;
|
|
void GetFunctions(const RegularExpression ®ex,
|
|
DIEArray &offsets) override;
|
|
|
|
void ReportInvalidDIERef(const DIERef &ref, llvm::StringRef name) override {}
|
|
void Dump(Stream &s) override;
|
|
|
|
private:
|
|
DebugNamesDWARFIndex(Module &module,
|
|
std::unique_ptr<llvm::DWARFDebugNames> debug_names_up,
|
|
DWARFDataExtractor debug_names_data,
|
|
DWARFDataExtractor debug_str_data,
|
|
DWARFDebugInfo &debug_info)
|
|
: DWARFIndex(module), m_debug_info(debug_info),
|
|
m_debug_names_data(debug_names_data), m_debug_str_data(debug_str_data),
|
|
m_debug_names_up(std::move(debug_names_up)),
|
|
m_fallback(module, &debug_info, GetUnits(*m_debug_names_up)) {}
|
|
|
|
DWARFDebugInfo &m_debug_info;
|
|
|
|
// LLVM DWARFDebugNames will hold a non-owning reference to this data, so keep
|
|
// track of the ownership here.
|
|
DWARFDataExtractor m_debug_names_data;
|
|
DWARFDataExtractor m_debug_str_data;
|
|
|
|
using DebugNames = llvm::DWARFDebugNames;
|
|
std::unique_ptr<DebugNames> m_debug_names_up;
|
|
ManualDWARFIndex m_fallback;
|
|
|
|
llvm::Optional<DIERef> ToDIERef(const DebugNames::Entry &entry);
|
|
void Append(const DebugNames::Entry &entry, DIEArray &offsets);
|
|
|
|
static void MaybeLogLookupError(llvm::Error error,
|
|
const DebugNames::NameIndex &ni,
|
|
llvm::StringRef name);
|
|
|
|
static llvm::DenseSet<dw_offset_t> GetUnits(const DebugNames &debug_names);
|
|
};
|
|
|
|
} // namespace lldb_private
|
|
|
|
#endif // LLDB_DEBUGNAMESDWARFINDEX_H
|