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
64 lines
2.0 KiB
C++
64 lines
2.0 KiB
C++
//===-- DIERef.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 SymbolFileDWARF_DIERef_h_
|
|
#define SymbolFileDWARF_DIERef_h_
|
|
|
|
#include "lldb/Core/dwarf.h"
|
|
#include "llvm/ADT/Optional.h"
|
|
#include "llvm/Support/FormatProviders.h"
|
|
#include <cassert>
|
|
#include <vector>
|
|
|
|
/// Identifies a DWARF debug info entry within a given Module. It contains three
|
|
/// "coordinates":
|
|
/// - dwo_num: identifies the dwo file in the Module. If this field is not set,
|
|
/// the DIERef references the main file.
|
|
/// - section: identifies the section of the debug info entry in the given file:
|
|
/// debug_info or debug_types.
|
|
/// - die_offset: The offset of the debug info entry as an absolute offset from
|
|
/// the beginning of the section specified in the section field.
|
|
class DIERef {
|
|
public:
|
|
enum Section : uint8_t { DebugInfo, DebugTypes };
|
|
|
|
DIERef(llvm::Optional<uint32_t> dwo_num, Section section,
|
|
dw_offset_t die_offset)
|
|
: m_dwo_num(dwo_num.getValueOr(0)), m_dwo_num_valid(bool(dwo_num)),
|
|
m_section(section), m_die_offset(die_offset) {
|
|
assert(this->dwo_num() == dwo_num && "Dwo number out of range?");
|
|
}
|
|
|
|
llvm::Optional<uint32_t> dwo_num() const {
|
|
if (m_dwo_num_valid)
|
|
return m_dwo_num;
|
|
return llvm::None;
|
|
}
|
|
|
|
Section section() const { return static_cast<Section>(m_section); }
|
|
|
|
dw_offset_t die_offset() const { return m_die_offset; }
|
|
|
|
private:
|
|
uint32_t m_dwo_num : 30;
|
|
uint32_t m_dwo_num_valid : 1;
|
|
uint32_t m_section : 1;
|
|
dw_offset_t m_die_offset;
|
|
};
|
|
static_assert(sizeof(DIERef) == 8, "");
|
|
|
|
typedef std::vector<DIERef> DIEArray;
|
|
|
|
namespace llvm {
|
|
template<> struct format_provider<DIERef> {
|
|
static void format(const DIERef &ref, raw_ostream &OS, StringRef Style);
|
|
};
|
|
} // namespace llvm
|
|
|
|
#endif // SymbolFileDWARF_DIERef_h_
|