LLDB mainline
NameToDIE.cpp
Go to the documentation of this file.
1//===-- NameToDIE.cpp -----------------------------------------------------===//
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#include "NameToDIE.h"
10#include "DWARFUnit.h"
17#include "lldb/Utility/Stream.h"
19#include <optional>
20
21using namespace lldb;
22using namespace lldb_private;
23
25 m_map.Sort(std::less<DIERef>());
27}
28
29void NameToDIE::Insert(ConstString name, const DIERef &die_ref) {
30 m_map.Append(name, die_ref);
31}
32
34 llvm::function_ref<bool(DIERef ref)> callback) const {
35 for (const auto &entry : m_map.equal_range(name))
36 if (!callback(entry.value))
37 return false;
38 return true;
39}
40
42 llvm::function_ref<bool(DIERef ref)> callback) const {
43 for (const auto &entry : m_map)
44 if (regex.Execute(entry.cstring.GetCString())) {
45 if (!callback(entry.value))
46 return false;
47 }
48 return true;
49}
50
52 DWARFUnit &s_unit, llvm::function_ref<bool(DIERef ref)> callback) const {
53 const DWARFUnit &ns_unit = s_unit.GetNonSkeletonUnit();
54 const uint32_t size = m_map.GetSize();
55 for (uint32_t i = 0; i < size; ++i) {
56 const DIERef &die_ref = m_map.GetValueAtIndexUnchecked(i);
57 if (ns_unit.GetSymbolFileDWARF().GetFileIndex() == die_ref.file_index() &&
58 ns_unit.GetDebugSection() == die_ref.section() &&
59 ns_unit.GetOffset() <= die_ref.die_offset() &&
60 die_ref.die_offset() < ns_unit.GetNextUnitOffset()) {
61 if (!callback(die_ref))
62 return;
63 }
64 }
65}
66
68 const uint32_t size = m_map.GetSize();
69 for (uint32_t i = 0; i < size; ++i) {
70 s->Format("{0} \"{1}\"\n", m_map.GetValueAtIndexUnchecked(i),
72 }
73}
74
76 std::function<bool(ConstString name, const DIERef &die_ref)> const
77 &callback) const {
78 const uint32_t size = m_map.GetSize();
79 for (uint32_t i = 0; i < size; ++i) {
80 if (!callback(m_map.GetCStringAtIndexUnchecked(i),
82 break;
83 }
84}
85
86void NameToDIE::Append(const NameToDIE &other) {
87 const uint32_t size = other.m_map.GetSize();
88 for (uint32_t i = 0; i < size; ++i) {
91 }
92}
93
94constexpr llvm::StringLiteral kIdentifierNameToDIE("N2DI");
95
96bool NameToDIE::Decode(const DataExtractor &data, lldb::offset_t *offset_ptr,
97 const StringTableReader &strtab) {
98 m_map.Clear();
99 llvm::StringRef identifier((const char *)data.GetData(offset_ptr, 4), 4);
100 if (identifier != kIdentifierNameToDIE)
101 return false;
102 const uint32_t count = data.GetU32(offset_ptr);
103 m_map.Reserve(count);
104 for (uint32_t i = 0; i < count; ++i) {
105 llvm::StringRef str(strtab.Get(data.GetU32(offset_ptr)));
106 // No empty strings allowed in the name to DIE maps.
107 if (str.empty())
108 return false;
109 if (std::optional<DIERef> die_ref = DIERef::Decode(data, offset_ptr))
110 m_map.Append(ConstString(str), *die_ref);
111 else
112 return false;
113 }
114 // We must sort the UniqueCStringMap after decoding it since it is a vector
115 // of UniqueCStringMap::Entry objects which contain a ConstString and type T.
116 // ConstString objects are sorted by "const char *" and then type T and
117 // the "const char *" are point values that will depend on the order in which
118 // ConstString objects are created and in which of the 256 string pools they
119 // are created in. So after we decode all of the entries, we must sort the
120 // name map to ensure name lookups succeed. If we encode and decode within
121 // the same process we wouldn't need to sort, so unit testing didn't catch
122 // this issue when first checked in.
123 m_map.Sort(std::less<DIERef>());
124 return true;
125}
126
127void NameToDIE::Encode(DataEncoder &encoder, ConstStringTable &strtab) const {
128 encoder.AppendData(kIdentifierNameToDIE);
129 encoder.AppendU32(m_map.GetSize());
130 for (const auto &entry : m_map) {
131 // Make sure there are no empty strings.
132 assert((bool)entry.cstring);
133 encoder.AppendU32(strtab.Add(entry.cstring));
134 entry.value.Encode(encoder);
135 }
136}
137
138bool NameToDIE::operator==(const NameToDIE &rhs) const {
139 const size_t size = m_map.GetSize();
140 if (size != rhs.m_map.GetSize())
141 return false;
142 for (size_t i = 0; i < size; ++i) {
144 return false;
147 return false;
148 }
149 return true;
150}
constexpr llvm::StringLiteral kIdentifierNameToDIE("N2DI")
Identifies a DWARF debug info entry within a given Module.
Definition: DIERef.h:28
std::optional< uint32_t > file_index() const
Definition: DIERef.h:57
static std::optional< DIERef > Decode(const lldb_private::DataExtractor &data, lldb::offset_t *offset_ptr)
Decode a serialized version of this object from data.
Definition: DIERef.cpp:26
dw_offset_t die_offset() const
Definition: DIERef.h:65
Section section() const
Definition: DIERef.h:63
DIERef::Section GetDebugSection() const
Definition: DWARFUnit.h:222
SymbolFileDWARF & GetSymbolFileDWARF() const
Definition: DWARFUnit.h:200
dw_offset_t GetNextUnitOffset() const
Definition: DWARFUnit.h:150
DWARFUnit & GetNonSkeletonUnit()
Definition: DWARFUnit.cpp:662
dw_offset_t GetOffset() const
Definition: DWARFUnit.h:134
lldb_private::UniqueCStringMap< DIERef > m_map
Definition: NameToDIE.h:90
void Append(const NameToDIE &other)
Definition: NameToDIE.cpp:86
bool Find(lldb_private::ConstString name, llvm::function_ref< bool(DIERef ref)> callback) const
Definition: NameToDIE.cpp:33
void Finalize()
Definition: NameToDIE.cpp:24
bool Decode(const lldb_private::DataExtractor &data, lldb::offset_t *offset_ptr, const lldb_private::StringTableReader &strtab)
Decode a serialized version of this object from data.
Definition: NameToDIE.cpp:96
void Insert(lldb_private::ConstString name, const DIERef &die_ref)
Definition: NameToDIE.cpp:29
void FindAllEntriesForUnit(DWARFUnit &unit, llvm::function_ref< bool(DIERef ref)> callback) const
unit must be the skeleton unit if possible, not GetNonSkeletonUnit().
Definition: NameToDIE.cpp:51
void Encode(lldb_private::DataEncoder &encoder, lldb_private::ConstStringTable &strtab) const
Encode this object into a data encoder object.
Definition: NameToDIE.cpp:127
void Dump(lldb_private::Stream *s)
Definition: NameToDIE.cpp:67
bool operator==(const NameToDIE &rhs) const
Used for unit testing the encoding and decoding.
Definition: NameToDIE.cpp:138
void ForEach(std::function< bool(lldb_private::ConstString name, const DIERef &die_ref)> const &callback) const
Definition: NameToDIE.cpp:75
std::optional< uint64_t > GetFileIndex() const
Many cache files require string tables to store data efficiently.
uint32_t Add(ConstString s)
Add a string into the string table.
A uniqued constant string class.
Definition: ConstString.h:39
An data extractor class.
Definition: DataExtractor.h:48
const void * GetData(lldb::offset_t *offset_ptr, lldb::offset_t length) const
Extract length bytes from *offset_ptr.
uint32_t GetU32(lldb::offset_t *offset_ptr) const
Extract a uint32_t value from *offset_ptr.
bool Execute(llvm::StringRef string, llvm::SmallVectorImpl< llvm::StringRef > *matches=nullptr) const
Execute a regular expression match using the compiled regular expression that is already in this obje...
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
void Format(const char *format, Args &&... args)
Definition: Stream.h:309
Many cache files require string tables to store data efficiently.
llvm::StringRef Get(uint32_t offset) const
ConstString GetCStringAtIndexUnchecked(uint32_t idx) const
llvm::iterator_range< const_iterator > equal_range(ConstString unique_cstr) const
const T & GetValueRefAtIndexUnchecked(uint32_t idx) const
ConstString GetCStringAtIndex(uint32_t idx) const
T GetValueAtIndexUnchecked(uint32_t idx) const
void Append(ConstString unique_cstr, const T &value)
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
Definition: SBAddress.h:15
uint64_t offset_t
Definition: lldb-types.h:83