LLDB mainline
DWARFDIE.h
Go to the documentation of this file.
1//===-- DWARFDIE.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_DWARFDIE_H
10#define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFDIE_H
11
12#include "DWARFBaseDIE.h"
13#include "llvm/ADT/SmallSet.h"
14#include "llvm/ADT/iterator_range.h"
15
16class DWARFDIE : public DWARFBaseDIE {
17public:
18 class child_iterator;
20
21 // Tests
22 bool IsStructUnionOrClass() const;
23
24 bool IsMethod() const;
25
26 // Accessors
27
28 // Accessing information about a DIE
29 const char *GetMangledName() const;
30
31 const char *GetPubname() const;
32
34 void GetName(lldb_private::Stream &s) const;
35
37
39
40 // Resolve a type by UID using this DIE's DWARF file
42
43 // Functions for obtaining DIE relations and references
44
46 GetParent() const;
47
49 GetFirstChild() const;
50
52 GetSibling() const;
53
55 GetReferencedDIE(const dw_attr_t attr) const;
56
57 // Get a another DIE from the same DWARF file as this DIE. This will
58 // check the current DIE's compile unit first to see if "die_offset" is
59 // in the same compile unit, and fall back to checking the DWARF file.
61 GetDIE(dw_offset_t die_offset) const;
63
65 LookupDeepestBlock(lldb::addr_t file_addr) const;
66
69
70 // DeclContext related functions
71 std::vector<DWARFDIE> GetDeclContextDIEs() const;
72
73 /// Return this DIE's decl context as it is needed to look up types
74 /// in Clang's -gmodules debug info format.
75 void GetDeclContext(
77
78 // Getting attribute values from the DIE.
79 //
80 // GetAttributeValueAsXXX() functions should only be used if you are
81 // looking for one or two attributes on a DIE. If you are trying to
82 // parse all attributes, use GetAttributes (...) instead
85
87 const char *&name, const char *&mangled, DWARFRangeList &ranges,
88 std::optional<int> &decl_file, std::optional<int> &decl_line,
89 std::optional<int> &decl_column, std::optional<int> &call_file,
90 std::optional<int> &call_line, std::optional<int> &call_column,
91 lldb_private::DWARFExpressionList *frame_base) const;
92
93 /// The range of all the children of this DIE.
94 llvm::iterator_range<child_iterator> children() const;
95};
96
98 : public llvm::iterator_facade_base<DWARFDIE::child_iterator,
99 std::forward_iterator_tag, DWARFDIE> {
100 /// The current child or an invalid DWARFDie.
102
103public:
104 child_iterator() = default;
105 child_iterator(const DWARFDIE &parent) : m_die(parent.GetFirstChild()) {}
106 bool operator==(const child_iterator &it) const {
107 // DWARFDIE's operator== differentiates between an invalid DWARFDIE that
108 // has a CU but no DIE and one that has neither CU nor DIE. The 'end'
109 // iterator could be default constructed, so explicitly allow
110 // (CU, (DIE)nullptr) == (nullptr, nullptr) -> true
111 if (!m_die.IsValid() && !it.m_die.IsValid())
112 return true;
113 return m_die == it.m_die;
114 }
115 const DWARFDIE &operator*() const {
116 assert(m_die.IsValid() && "Derefencing invalid iterator?");
117 return m_die;
118 }
120 assert(m_die.IsValid() && "Derefencing invalid iterator?");
121 return m_die;
122 }
124 assert(m_die.IsValid() && "Incrementing invalid iterator?");
126 return *this;
127 }
128};
129
130#endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFDIE_H
DWARFBaseDIE()=default
DWARFDebugInfoEntry * GetDIE() const
Definition: DWARFBaseDIE.h:57
bool IsValid() const
Definition: DWARFBaseDIE.h:46
const char * GetName() const
DWARFDIE & operator*()
Definition: DWARFDIE.h:119
const DWARFDIE & operator*() const
Definition: DWARFDIE.h:115
child_iterator & operator++()
Definition: DWARFDIE.h:123
bool operator==(const child_iterator &it) const
Definition: DWARFDIE.h:106
child_iterator(const DWARFDIE &parent)
Definition: DWARFDIE.h:105
DWARFDIE m_die
The current child or an invalid DWARFDie.
Definition: DWARFDIE.h:101
bool IsMethod() const
Definition: DWARFDIE.cpp:432
std::vector< DWARFDIE > GetDeclContextDIEs() const
Definition: DWARFDIE.cpp:361
DWARFDebugInfoEntry * GetDIE() const
Definition: DWARFBaseDIE.h:57
DWARFDIE GetFirstChild() const
Definition: DWARFDIE.cpp:94
DWARFDIE GetParent() const
Definition: DWARFDIE.cpp:86
void GetDeclContext(llvm::SmallVectorImpl< lldb_private::CompilerContext > &context) const
Return this DIE's decl context as it is needed to look up types in Clang's -gmodules debug info forma...
Definition: DWARFDIE.cpp:375
const char * GetMangledName() const
Definition: DWARFDIE.cpp:198
llvm::iterator_range< child_iterator > children() const
The range of all the children of this DIE.
Definition: DWARFDIE.cpp:453
DWARFDIE GetParentDeclContextDIE() const
Definition: DWARFDIE.cpp:419
bool IsStructUnionOrClass() const
Definition: DWARFDIE.cpp:426
lldb_private::Type * ResolveTypeUID(const DWARFDIE &die) const
Definition: DWARFDIE.cpp:355
DWARFDIE LookupDeepestBlock(lldb::addr_t file_addr) const
Definition: DWARFDIE.cpp:139
DWARFDIE GetAttributeValueAsReferenceDIE(const dw_attr_t attr) const
Definition: DWARFDIE.cpp:126
DWARFDIE GetReferencedDIE(const dw_attr_t attr) const
Definition: DWARFDIE.cpp:110
lldb_private::Type * ResolveType() const
Definition: DWARFDIE.cpp:348
const char * GetName() 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, lldb_private::DWARFExpressionList *frame_base) const
Definition: DWARFDIE.cpp:439
void AppendTypeName(lldb_private::Stream &s) const
Definition: DWARFDIE.cpp:235
const char * GetPubname() const
Definition: DWARFDIE.cpp:205
DWARFDIE GetSibling() const
Definition: DWARFDIE.cpp:102
"lldb/Expression/DWARFExpressionList.h" Encapsulates a range map from file address range to a single ...
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
uint64_t dw_offset_t
Definition: dwarf.h:31
llvm::dwarf::Attribute dw_attr_t
Definition: dwarf.h:24
uint64_t addr_t
Definition: lldb-types.h:79