1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
|
//===-- DWARFDIE.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_DWARFDIE_H
#define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFDIE_H
#include "DWARFBaseDIE.h"
#include "llvm/ADT/SmallSet.h"
#include "llvm/ADT/iterator_range.h"
namespace lldb_private::plugin {
namespace dwarf {
class DWARFDIE : public DWARFBaseDIE {
public:
class child_iterator;
using DWARFBaseDIE::DWARFBaseDIE;
// Tests
bool IsStructUnionOrClass() const;
bool IsMethod() const;
// Accessors
// Accessing information about a DIE
const char *GetMangledName() const;
bool IsGenericTrampoline() const;
const char *GetPubname() const;
using DWARFBaseDIE::GetName;
void GetName(Stream &s) const;
void AppendTypeName(Stream &s) const;
Type *ResolveType() const;
// Resolve a type by UID using this DIE's DWARF file
Type *ResolveTypeUID(const DWARFDIE &die) const;
// Functions for obtaining DIE relations and references
DWARFDIE
GetParent() const;
DWARFDIE
GetFirstChild() const;
DWARFDIE
GetSibling() const;
DWARFDIE
GetReferencedDIE(const dw_attr_t attr) const;
// Get a another DIE from the same DWARF file as this DIE. This will
// check the current DIE's compile unit first to see if "die_offset" is
// in the same compile unit, and fall back to checking the DWARF file.
DWARFDIE
GetDIE(dw_offset_t die_offset) const;
using DWARFBaseDIE::GetDIE;
DWARFDIE
LookupDeepestBlock(lldb::addr_t file_addr) const;
DWARFDIE
GetParentDeclContextDIE() const;
// DeclContext related functions
std::vector<DWARFDIE> GetDeclContextDIEs() const;
/// Return this DIE's decl context as it is needed to look up types
/// in Clang modules. This context will include any modules or functions that
/// the type is declared in so an exact module match can be efficiently made.
std::vector<CompilerContext> GetDeclContext() const;
/// Get a context to a type so it can be looked up.
///
/// This function uses the current DIE to fill in a CompilerContext array
/// that is suitable for type lookup for comparison to a TypeQuery's compiler
/// context (TypeQuery::GetContextRef()). If this DIE represents a named type,
/// it should fill out the compiler context with the type itself as the last
/// entry. The declaration context should be above the type and stop at an
/// appropriate time, like either the translation unit or at a function
/// context. This is designed to allow users to efficiently look for types
/// using a full or partial CompilerContext array.
std::vector<CompilerContext> GetTypeLookupContext() const;
// Getting attribute values from the DIE.
//
// GetAttributeValueAsXXX() functions should only be used if you are
// looking for one or two attributes on a DIE. If you are trying to
// parse all attributes, use GetAttributes (...) instead
DWARFDIE
GetAttributeValueAsReferenceDIE(const dw_attr_t attr) const;
bool GetDIENamesAndRanges(
const char *&name, const char *&mangled, DWARFRangeList &ranges,
std::optional<int> &decl_file, std::optional<int> &decl_line,
std::optional<int> &decl_column, std::optional<int> &call_file,
std::optional<int> &call_line, std::optional<int> &call_column,
DWARFExpressionList *frame_base) const;
/// The range of all the children of this DIE.
llvm::iterator_range<child_iterator> children() const;
};
class DWARFDIE::child_iterator
: public llvm::iterator_facade_base<DWARFDIE::child_iterator,
std::forward_iterator_tag, DWARFDIE> {
/// The current child or an invalid DWARFDie.
DWARFDIE m_die;
public:
child_iterator() = default;
child_iterator(const DWARFDIE &parent) : m_die(parent.GetFirstChild()) {}
bool operator==(const child_iterator &it) const {
// DWARFDIE's operator== differentiates between an invalid DWARFDIE that
// has a CU but no DIE and one that has neither CU nor DIE. The 'end'
// iterator could be default constructed, so explicitly allow
// (CU, (DIE)nullptr) == (nullptr, nullptr) -> true
if (!m_die.IsValid() && !it.m_die.IsValid())
return true;
return m_die == it.m_die;
}
const DWARFDIE &operator*() const {
assert(m_die.IsValid() && "Derefencing invalid iterator?");
return m_die;
}
DWARFDIE &operator*() {
assert(m_die.IsValid() && "Derefencing invalid iterator?");
return m_die;
}
child_iterator &operator++() {
assert(m_die.IsValid() && "Incrementing invalid iterator?");
m_die = m_die.GetSibling();
return *this;
}
};
} // namespace dwarf
} // namespace lldb_private::plugin
#endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFDIE_H
|