LLDB mainline
DWARFBaseDIE.h
Go to the documentation of this file.
1//===-- DWARFBaseDIE.h -----------------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFBASEDIE_H
10#define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFBASEDIE_H
11
12#include "lldb/Core/dwarf.h"
13#include "lldb/lldb-types.h"
14
15#include "llvm/Support/Error.h"
16#include <optional>
17
18class DIERef;
19class DWARFASTParser;
20class DWARFAttributes;
21class DWARFUnit;
24class SymbolFileDWARF;
25
27public:
28 DWARFBaseDIE() = default;
29
31 : m_cu(cu), m_die(die) {}
32
34 : m_cu(const_cast<DWARFUnit *>(cu)), m_die(die) {}
35
37 : m_cu(cu), m_die(const_cast<DWARFDebugInfoEntry *>(die)) {}
38
40 : m_cu(const_cast<DWARFUnit *>(cu)),
41 m_die(const_cast<DWARFDebugInfoEntry *>(die)) {}
42
43 // Tests
44 explicit operator bool() const { return IsValid(); }
45
46 bool IsValid() const { return m_cu && m_die; }
47
48 bool HasChildren() const;
49
51
52 // Accessors
54
55 DWARFUnit *GetCU() const { return m_cu; }
56
57 DWARFDebugInfoEntry *GetDIE() const { return m_die; }
58
59 std::optional<DIERef> GetDIERef() const;
60
62 if (cu && die) {
63 m_cu = cu;
64 m_die = die;
65 } else {
66 Clear();
67 }
68 }
69
70 void Clear() {
71 m_cu = nullptr;
72 m_die = nullptr;
73 }
74
75 // Get the data that contains the attribute values for this DIE. Support
76 // for .debug_types means that any DIE can have its data either in the
77 // .debug_info or the .debug_types section; this method will return the
78 // correct section data.
79 //
80 // Clients must validate that this object is valid before calling this.
82
83 // Accessing information about a DIE
84 dw_tag_t Tag() const;
85
86 const char *GetTagAsCString() const;
87
88 dw_offset_t GetOffset() const;
89
90 // Get the LLDB user ID for this DIE. This is often just the DIE offset,
91 // but it might have a SymbolFileDWARF::GetID() in the high 32 bits if
92 // we are doing Darwin DWARF in .o file, or DWARF stand alone debug
93 // info.
94 lldb::user_id_t GetID() const;
95
96 const char *GetName() const;
97
98 lldb::ModuleSP GetModule() const;
99
100 // Getting attribute values from the DIE.
101 //
102 // GetAttributeValueAsXXX() functions should only be used if you are
103 // looking for one or two attributes on a DIE. If you are trying to
104 // parse all attributes, use GetAttributes (...) instead
105 const char *GetAttributeValueAsString(const dw_attr_t attr,
106 const char *fail_value) const;
107
108 uint64_t GetAttributeValueAsUnsigned(const dw_attr_t attr,
109 uint64_t fail_value) const;
110
111 std::optional<uint64_t>
113
114 uint64_t GetAttributeValueAsAddress(const dw_attr_t attr,
115 uint64_t fail_value) const;
116
117 enum class Recurse : bool { no, yes };
119
120protected:
121 DWARFUnit *m_cu = nullptr;
123};
124
125bool operator==(const DWARFBaseDIE &lhs, const DWARFBaseDIE &rhs);
126bool operator!=(const DWARFBaseDIE &lhs, const DWARFBaseDIE &rhs);
127
128#endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFBASEDIE_H
bool operator!=(const DWARFBaseDIE &lhs, const DWARFBaseDIE &rhs)
bool operator==(const DWARFBaseDIE &lhs, const DWARFBaseDIE &rhs)
Identifies a DWARF debug info entry within a given Module.
Definition: DIERef.h:28
dw_tag_t Tag() const
DWARFDebugInfoEntry * m_die
Definition: DWARFBaseDIE.h:122
DWARFBaseDIE()=default
DWARFAttributes GetAttributes(Recurse recurse=Recurse::yes) const
const char * GetTagAsCString() const
bool HasChildren() const
DWARFDebugInfoEntry * GetDIE() const
Definition: DWARFBaseDIE.h:57
std::optional< uint64_t > GetAttributeValueAsOptionalUnsigned(const dw_attr_t attr) const
DWARFBaseDIE(const DWARFUnit *cu, DWARFDebugInfoEntry *die)
Definition: DWARFBaseDIE.h:33
const lldb_private::DWARFDataExtractor & GetData() const
bool IsValid() const
Definition: DWARFBaseDIE.h:46
void Clear()
Definition: DWARFBaseDIE.h:70
DWARFUnit * m_cu
Definition: DWARFBaseDIE.h:121
const char * GetAttributeValueAsString(const dw_attr_t attr, const char *fail_value) const
DWARFUnit * GetCU() const
Definition: DWARFBaseDIE.h:55
std::optional< DIERef > GetDIERef() const
lldb::ModuleSP GetModule() const
SymbolFileDWARF * GetDWARF() const
DWARFBaseDIE(const DWARFUnit *cu, const DWARFDebugInfoEntry *die)
Definition: DWARFBaseDIE.h:39
bool Supports_DW_AT_APPLE_objc_complete_type() const
DWARFBaseDIE(DWARFUnit *cu, const DWARFDebugInfoEntry *die)
Definition: DWARFBaseDIE.h:36
const char * GetName() const
uint64_t GetAttributeValueAsUnsigned(const dw_attr_t attr, uint64_t fail_value) const
dw_offset_t GetOffset() const
uint64_t GetAttributeValueAsAddress(const dw_attr_t attr, uint64_t fail_value) const
void Set(DWARFUnit *cu, DWARFDebugInfoEntry *die)
Definition: DWARFBaseDIE.h:61
DWARFBaseDIE(DWARFUnit *cu, DWARFDebugInfoEntry *die)
Definition: DWARFBaseDIE.h:30
lldb::user_id_t GetID() const
DWARFDebugInfoEntry objects assume that they are living in one big vector and do pointer arithmetic o...
uint64_t dw_offset_t
Definition: dwarf.h:31
llvm::dwarf::Tag dw_tag_t
Definition: dwarf.h:26
llvm::dwarf::Attribute dw_attr_t
Definition: dwarf.h:24
uint64_t user_id_t
Definition: lldb-types.h:80