1 //===-- ModuleSpec.h --------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef liblldb_ModuleSpec_h_
11 #define liblldb_ModuleSpec_h_
14 #include "lldb/Core/ArchSpec.h"
15 #include "lldb/Target/PathMappingList.h"
16 #include "lldb/Utility/FileSpec.h"
17 #include "lldb/Utility/Stream.h"
18 #include "lldb/Utility/UUID.h"
20 // Other libraries and framework includes
21 #include "llvm/Support/Chrono.h"
28 namespace lldb_private {
33 : m_file(), m_platform_file(), m_symbol_file(), m_arch(), m_uuid(),
34 m_object_name(), m_object_offset(0), m_object_size(0),
35 m_source_mappings() {}
37 ModuleSpec(const FileSpec &file_spec)
38 : m_file(file_spec), m_platform_file(), m_symbol_file(), m_arch(),
39 m_uuid(), m_object_name(), m_object_offset(0),
40 m_object_size(file_spec.GetByteSize()), m_source_mappings() {}
42 ModuleSpec(const FileSpec &file_spec, const ArchSpec &arch)
43 : m_file(file_spec), m_platform_file(), m_symbol_file(), m_arch(arch),
44 m_uuid(), m_object_name(), m_object_offset(0),
45 m_object_size(file_spec.GetByteSize()), m_source_mappings() {}
47 ModuleSpec(const ModuleSpec &rhs)
48 : m_file(rhs.m_file), m_platform_file(rhs.m_platform_file),
49 m_symbol_file(rhs.m_symbol_file), m_arch(rhs.m_arch),
50 m_uuid(rhs.m_uuid), m_object_name(rhs.m_object_name),
51 m_object_offset(rhs.m_object_offset), m_object_size(rhs.m_object_size),
52 m_object_mod_time(rhs.m_object_mod_time),
53 m_source_mappings(rhs.m_source_mappings) {}
55 ModuleSpec &operator=(const ModuleSpec &rhs) {
58 m_platform_file = rhs.m_platform_file;
59 m_symbol_file = rhs.m_symbol_file;
62 m_object_name = rhs.m_object_name;
63 m_object_offset = rhs.m_object_offset;
64 m_object_size = rhs.m_object_size;
65 m_object_mod_time = rhs.m_object_mod_time;
66 m_source_mappings = rhs.m_source_mappings;
71 FileSpec *GetFileSpecPtr() { return (m_file ? &m_file : nullptr); }
73 const FileSpec *GetFileSpecPtr() const {
74 return (m_file ? &m_file : nullptr);
77 FileSpec &GetFileSpec() { return m_file; }
79 const FileSpec &GetFileSpec() const { return m_file; }
81 FileSpec *GetPlatformFileSpecPtr() {
82 return (m_platform_file ? &m_platform_file : nullptr);
85 const FileSpec *GetPlatformFileSpecPtr() const {
86 return (m_platform_file ? &m_platform_file : nullptr);
89 FileSpec &GetPlatformFileSpec() { return m_platform_file; }
91 const FileSpec &GetPlatformFileSpec() const { return m_platform_file; }
93 FileSpec *GetSymbolFileSpecPtr() {
94 return (m_symbol_file ? &m_symbol_file : nullptr);
97 const FileSpec *GetSymbolFileSpecPtr() const {
98 return (m_symbol_file ? &m_symbol_file : nullptr);
101 FileSpec &GetSymbolFileSpec() { return m_symbol_file; }
103 const FileSpec &GetSymbolFileSpec() const { return m_symbol_file; }
105 ArchSpec *GetArchitecturePtr() {
106 return (m_arch.IsValid() ? &m_arch : nullptr);
109 const ArchSpec *GetArchitecturePtr() const {
110 return (m_arch.IsValid() ? &m_arch : nullptr);
113 ArchSpec &GetArchitecture() { return m_arch; }
115 const ArchSpec &GetArchitecture() const { return m_arch; }
117 UUID *GetUUIDPtr() { return (m_uuid.IsValid() ? &m_uuid : nullptr); }
119 const UUID *GetUUIDPtr() const {
120 return (m_uuid.IsValid() ? &m_uuid : nullptr);
123 UUID &GetUUID() { return m_uuid; }
125 const UUID &GetUUID() const { return m_uuid; }
127 ConstString &GetObjectName() { return m_object_name; }
129 const ConstString &GetObjectName() const { return m_object_name; }
131 uint64_t GetObjectOffset() const { return m_object_offset; }
133 void SetObjectOffset(uint64_t object_offset) {
134 m_object_offset = object_offset;
137 uint64_t GetObjectSize() const { return m_object_size; }
139 void SetObjectSize(uint64_t object_size) { m_object_size = object_size; }
141 llvm::sys::TimePoint<> &GetObjectModificationTime() {
142 return m_object_mod_time;
145 const llvm::sys::TimePoint<> &GetObjectModificationTime() const {
146 return m_object_mod_time;
149 PathMappingList &GetSourceMappingList() const { return m_source_mappings; }
153 m_platform_file.Clear();
154 m_symbol_file.Clear();
157 m_object_name.Clear();
160 m_source_mappings.Clear(false);
161 m_object_mod_time = llvm::sys::TimePoint<>();
164 explicit operator bool() const {
171 if (m_arch.IsValid())
173 if (m_uuid.IsValid())
179 if (m_object_mod_time != llvm::sys::TimePoint<>())
184 void Dump(Stream &strm) const {
185 bool dumped_something = false;
187 strm.PutCString("file = '");
189 strm.PutCString("'");
190 dumped_something = true;
192 if (m_platform_file) {
193 if (dumped_something)
194 strm.PutCString(", ");
195 strm.PutCString("platform_file = '");
196 strm << m_platform_file;
197 strm.PutCString("'");
198 dumped_something = true;
201 if (dumped_something)
202 strm.PutCString(", ");
203 strm.PutCString("symbol_file = '");
204 strm << m_symbol_file;
205 strm.PutCString("'");
206 dumped_something = true;
208 if (m_arch.IsValid()) {
209 if (dumped_something)
210 strm.PutCString(", ");
211 strm.Printf("arch = ");
212 m_arch.DumpTriple(strm);
213 dumped_something = true;
215 if (m_uuid.IsValid()) {
216 if (dumped_something)
217 strm.PutCString(", ");
218 strm.PutCString("uuid = ");
220 dumped_something = true;
223 if (dumped_something)
224 strm.PutCString(", ");
225 strm.Printf("object_name = %s", m_object_name.GetCString());
226 dumped_something = true;
228 if (m_object_offset > 0) {
229 if (dumped_something)
230 strm.PutCString(", ");
231 strm.Printf("object_offset = %" PRIu64, m_object_offset);
232 dumped_something = true;
234 if (m_object_size > 0) {
235 if (dumped_something)
236 strm.PutCString(", ");
237 strm.Printf("object size = %" PRIu64, m_object_size);
238 dumped_something = true;
240 if (m_object_mod_time != llvm::sys::TimePoint<>()) {
241 if (dumped_something)
242 strm.PutCString(", ");
243 strm.Format("object_mod_time = {0:x+}",
244 uint64_t(llvm::sys::toTimeT(m_object_mod_time)));
248 bool Matches(const ModuleSpec &match_module_spec,
249 bool exact_arch_match) const {
250 if (match_module_spec.GetUUIDPtr() &&
251 match_module_spec.GetUUID() != GetUUID())
253 if (match_module_spec.GetObjectName() &&
254 match_module_spec.GetObjectName() != GetObjectName())
256 if (match_module_spec.GetFileSpecPtr()) {
257 const FileSpec &fspec = match_module_spec.GetFileSpec();
258 if (!FileSpec::Equal(fspec, GetFileSpec(),
259 fspec.GetDirectory().IsEmpty() == false))
262 if (GetPlatformFileSpec() && match_module_spec.GetPlatformFileSpecPtr()) {
263 const FileSpec &fspec = match_module_spec.GetPlatformFileSpec();
264 if (!FileSpec::Equal(fspec, GetPlatformFileSpec(),
265 fspec.GetDirectory().IsEmpty() == false))
268 // Only match the symbol file spec if there is one in this ModuleSpec
269 if (GetSymbolFileSpec() && match_module_spec.GetSymbolFileSpecPtr()) {
270 const FileSpec &fspec = match_module_spec.GetSymbolFileSpec();
271 if (!FileSpec::Equal(fspec, GetSymbolFileSpec(),
272 fspec.GetDirectory().IsEmpty() == false))
275 if (match_module_spec.GetArchitecturePtr()) {
276 if (exact_arch_match) {
277 if (!GetArchitecture().IsExactMatch(
278 match_module_spec.GetArchitecture()))
281 if (!GetArchitecture().IsCompatibleMatch(
282 match_module_spec.GetArchitecture()))
291 FileSpec m_platform_file;
292 FileSpec m_symbol_file;
295 ConstString m_object_name;
296 uint64_t m_object_offset;
297 uint64_t m_object_size;
298 llvm::sys::TimePoint<> m_object_mod_time;
299 mutable PathMappingList m_source_mappings;
302 class ModuleSpecList {
304 ModuleSpecList() : m_specs(), m_mutex() {}
306 ModuleSpecList(const ModuleSpecList &rhs) : m_specs(), m_mutex() {
307 std::lock_guard<std::recursive_mutex> lhs_guard(m_mutex);
308 std::lock_guard<std::recursive_mutex> rhs_guard(rhs.m_mutex);
309 m_specs = rhs.m_specs;
312 ~ModuleSpecList() = default;
314 ModuleSpecList &operator=(const ModuleSpecList &rhs) {
316 std::lock_guard<std::recursive_mutex> lhs_guard(m_mutex);
317 std::lock_guard<std::recursive_mutex> rhs_guard(rhs.m_mutex);
318 m_specs = rhs.m_specs;
323 size_t GetSize() const {
324 std::lock_guard<std::recursive_mutex> guard(m_mutex);
325 return m_specs.size();
329 std::lock_guard<std::recursive_mutex> guard(m_mutex);
333 void Append(const ModuleSpec &spec) {
334 std::lock_guard<std::recursive_mutex> guard(m_mutex);
335 m_specs.push_back(spec);
338 void Append(const ModuleSpecList &rhs) {
339 std::lock_guard<std::recursive_mutex> lhs_guard(m_mutex);
340 std::lock_guard<std::recursive_mutex> rhs_guard(rhs.m_mutex);
341 m_specs.insert(m_specs.end(), rhs.m_specs.begin(), rhs.m_specs.end());
344 // The index "i" must be valid and this can't be used in
345 // multi-threaded code as no mutex lock is taken.
346 ModuleSpec &GetModuleSpecRefAtIndex(size_t i) { return m_specs[i]; }
348 bool GetModuleSpecAtIndex(size_t i, ModuleSpec &module_spec) const {
349 std::lock_guard<std::recursive_mutex> guard(m_mutex);
350 if (i < m_specs.size()) {
351 module_spec = m_specs[i];
358 bool FindMatchingModuleSpec(const ModuleSpec &module_spec,
359 ModuleSpec &match_module_spec) const {
360 std::lock_guard<std::recursive_mutex> guard(m_mutex);
361 bool exact_arch_match = true;
362 for (auto spec : m_specs) {
363 if (spec.Matches(module_spec, exact_arch_match)) {
364 match_module_spec = spec;
369 // If there was an architecture, retry with a compatible arch
370 if (module_spec.GetArchitecturePtr()) {
371 exact_arch_match = false;
372 for (auto spec : m_specs) {
373 if (spec.Matches(module_spec, exact_arch_match)) {
374 match_module_spec = spec;
379 match_module_spec.Clear();
383 size_t FindMatchingModuleSpecs(const ModuleSpec &module_spec,
384 ModuleSpecList &matching_list) const {
385 std::lock_guard<std::recursive_mutex> guard(m_mutex);
386 bool exact_arch_match = true;
387 const size_t initial_match_count = matching_list.GetSize();
388 for (auto spec : m_specs) {
389 if (spec.Matches(module_spec, exact_arch_match))
390 matching_list.Append(spec);
393 // If there was an architecture, retry with a compatible arch if no matches
395 if (module_spec.GetArchitecturePtr() &&
396 (initial_match_count == matching_list.GetSize())) {
397 exact_arch_match = false;
398 for (auto spec : m_specs) {
399 if (spec.Matches(module_spec, exact_arch_match))
400 matching_list.Append(spec);
403 return matching_list.GetSize() - initial_match_count;
406 void Dump(Stream &strm) {
407 std::lock_guard<std::recursive_mutex> guard(m_mutex);
409 for (auto spec : m_specs) {
410 strm.Printf("[%u] ", idx);
418 typedef std::vector<ModuleSpec> collection; ///< The module collection type.
419 collection m_specs; ///< The collection of modules.
420 mutable std::recursive_mutex m_mutex;
423 } // namespace lldb_private
425 #endif // liblldb_ModuleSpec_h_