xref: /llvm-project/lldb/source/Core/ModuleList.cpp (revision 678e3ee12351e525fa9d94e7ff68ba7c1a8ca657)
1 //===-- ModuleList.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 "lldb/Core/ModuleList.h"
10 #include "lldb/Core/Module.h"
11 #include "lldb/Core/ModuleSpec.h"
12 #include "lldb/Host/FileSystem.h"
13 #include "lldb/Interpreter/OptionValueFileSpec.h"
14 #include "lldb/Interpreter/OptionValueFileSpecList.h"
15 #include "lldb/Interpreter/OptionValueProperties.h"
16 #include "lldb/Interpreter/Property.h"
17 #include "lldb/Symbol/LocateSymbolFile.h"
18 #include "lldb/Symbol/ObjectFile.h"
19 #include "lldb/Symbol/SymbolContext.h"
20 #include "lldb/Symbol/TypeList.h"
21 #include "lldb/Symbol/VariableList.h"
22 #include "lldb/Utility/ArchSpec.h"
23 #include "lldb/Utility/ConstString.h"
24 #include "lldb/Utility/FileSpecList.h"
25 #include "lldb/Utility/LLDBLog.h"
26 #include "lldb/Utility/Log.h"
27 #include "lldb/Utility/UUID.h"
28 #include "lldb/lldb-defines.h"
29 
30 #if defined(_WIN32)
31 #include "lldb/Host/windows/PosixApi.h"
32 #endif
33 
34 #include "clang/Driver/Driver.h"
35 #include "llvm/ADT/StringRef.h"
36 #include "llvm/Support/FileSystem.h"
37 #include "llvm/Support/Threading.h"
38 #include "llvm/Support/raw_ostream.h"
39 
40 #include <chrono>
41 #include <memory>
42 #include <mutex>
43 #include <string>
44 #include <utility>
45 
46 namespace lldb_private {
47 class Function;
48 }
49 namespace lldb_private {
50 class RegularExpression;
51 }
52 namespace lldb_private {
53 class Stream;
54 }
55 namespace lldb_private {
56 class SymbolFile;
57 }
58 namespace lldb_private {
59 class Target;
60 }
61 
62 using namespace lldb;
63 using namespace lldb_private;
64 
65 namespace {
66 
67 #define LLDB_PROPERTIES_modulelist
68 #include "CoreProperties.inc"
69 
70 enum {
71 #define LLDB_PROPERTIES_modulelist
72 #include "CorePropertiesEnum.inc"
73 };
74 
75 } // namespace
76 
77 ModuleListProperties::ModuleListProperties() {
78   m_collection_sp = std::make_shared<OptionValueProperties>("symbols");
79   m_collection_sp->Initialize(g_modulelist_properties);
80   m_collection_sp->SetValueChangedCallback(ePropertySymLinkPaths,
81                                            [this] { UpdateSymlinkMappings(); });
82 
83   llvm::SmallString<128> path;
84   if (clang::driver::Driver::getDefaultModuleCachePath(path)) {
85     lldbassert(SetClangModulesCachePath(FileSpec(path)));
86   }
87 
88   path.clear();
89   if (llvm::sys::path::cache_directory(path)) {
90     llvm::sys::path::append(path, "lldb");
91     llvm::sys::path::append(path, "IndexCache");
92     lldbassert(SetLLDBIndexCachePath(FileSpec(path)));
93   }
94 
95 }
96 
97 bool ModuleListProperties::GetEnableExternalLookup() const {
98   const uint32_t idx = ePropertyEnableExternalLookup;
99   return GetPropertyAtIndexAs<bool>(
100       idx, g_modulelist_properties[idx].default_uint_value != 0);
101 }
102 
103 bool ModuleListProperties::SetEnableExternalLookup(bool new_value) {
104   return SetPropertyAtIndex(ePropertyEnableExternalLookup, new_value);
105 }
106 
107 bool ModuleListProperties::GetEnableBackgroundLookup() const {
108   const uint32_t idx = ePropertyEnableBackgroundLookup;
109   return GetPropertyAtIndexAs<bool>(
110       idx, g_modulelist_properties[idx].default_uint_value != 0);
111 }
112 
113 FileSpec ModuleListProperties::GetClangModulesCachePath() const {
114   const uint32_t idx = ePropertyClangModulesCachePath;
115   return GetPropertyAtIndexAs<FileSpec>(idx, {});
116 }
117 
118 bool ModuleListProperties::SetClangModulesCachePath(const FileSpec &path) {
119   const uint32_t idx = ePropertyClangModulesCachePath;
120   return SetPropertyAtIndex(idx, path);
121 }
122 
123 FileSpec ModuleListProperties::GetLLDBIndexCachePath() const {
124   const uint32_t idx = ePropertyLLDBIndexCachePath;
125   return GetPropertyAtIndexAs<FileSpec>(idx, {});
126 }
127 
128 bool ModuleListProperties::SetLLDBIndexCachePath(const FileSpec &path) {
129   const uint32_t idx = ePropertyLLDBIndexCachePath;
130   return SetPropertyAtIndex(idx, path);
131 }
132 
133 bool ModuleListProperties::GetEnableLLDBIndexCache() const {
134   const uint32_t idx = ePropertyEnableLLDBIndexCache;
135   return GetPropertyAtIndexAs<bool>(
136       idx, g_modulelist_properties[idx].default_uint_value != 0);
137 }
138 
139 bool ModuleListProperties::SetEnableLLDBIndexCache(bool new_value) {
140   return SetPropertyAtIndex(ePropertyEnableLLDBIndexCache, new_value);
141 }
142 
143 uint64_t ModuleListProperties::GetLLDBIndexCacheMaxByteSize() {
144   const uint32_t idx = ePropertyLLDBIndexCacheMaxByteSize;
145   return GetPropertyAtIndexAs<uint64_t>(
146       idx, g_modulelist_properties[idx].default_uint_value);
147 }
148 
149 uint64_t ModuleListProperties::GetLLDBIndexCacheMaxPercent() {
150   const uint32_t idx = ePropertyLLDBIndexCacheMaxPercent;
151   return GetPropertyAtIndexAs<uint64_t>(
152       idx, g_modulelist_properties[idx].default_uint_value);
153 }
154 
155 uint64_t ModuleListProperties::GetLLDBIndexCacheExpirationDays() {
156   const uint32_t idx = ePropertyLLDBIndexCacheExpirationDays;
157   return GetPropertyAtIndexAs<uint64_t>(
158       idx, g_modulelist_properties[idx].default_uint_value);
159 }
160 
161 void ModuleListProperties::UpdateSymlinkMappings() {
162   FileSpecList list =
163       GetPropertyAtIndexAs<FileSpecList>(ePropertySymLinkPaths, {});
164   llvm::sys::ScopedWriter lock(m_symlink_paths_mutex);
165   const bool notify = false;
166   m_symlink_paths.Clear(notify);
167   for (FileSpec symlink : list) {
168     FileSpec resolved;
169     Status status = FileSystem::Instance().Readlink(symlink, resolved);
170     if (status.Success())
171       m_symlink_paths.Append(symlink.GetPath(), resolved.GetPath(), notify);
172   }
173 }
174 
175 PathMappingList ModuleListProperties::GetSymlinkMappings() const {
176   llvm::sys::ScopedReader lock(m_symlink_paths_mutex);
177   return m_symlink_paths;
178 }
179 
180 bool ModuleListProperties::GetLoadSymbolOnDemand() {
181   const uint32_t idx = ePropertyLoadSymbolOnDemand;
182   return GetPropertyAtIndexAs<bool>(
183       idx, g_modulelist_properties[idx].default_uint_value != 0);
184 }
185 
186 ModuleList::ModuleList() : m_modules(), m_modules_mutex() {}
187 
188 ModuleList::ModuleList(const ModuleList &rhs) : m_modules(), m_modules_mutex() {
189   std::lock_guard<std::recursive_mutex> lhs_guard(m_modules_mutex);
190   std::lock_guard<std::recursive_mutex> rhs_guard(rhs.m_modules_mutex);
191   m_modules = rhs.m_modules;
192 }
193 
194 ModuleList::ModuleList(ModuleList::Notifier *notifier)
195     : m_modules(), m_modules_mutex(), m_notifier(notifier) {}
196 
197 const ModuleList &ModuleList::operator=(const ModuleList &rhs) {
198   if (this != &rhs) {
199     std::lock(m_modules_mutex, rhs.m_modules_mutex);
200     std::lock_guard<std::recursive_mutex> lhs_guard(m_modules_mutex,
201                                                     std::adopt_lock);
202     std::lock_guard<std::recursive_mutex> rhs_guard(rhs.m_modules_mutex,
203                                                     std::adopt_lock);
204     m_modules = rhs.m_modules;
205   }
206   return *this;
207 }
208 
209 ModuleList::~ModuleList() = default;
210 
211 void ModuleList::AppendImpl(const ModuleSP &module_sp, bool use_notifier) {
212   if (module_sp) {
213     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
214     m_modules.push_back(module_sp);
215     if (use_notifier && m_notifier)
216       m_notifier->NotifyModuleAdded(*this, module_sp);
217   }
218 }
219 
220 void ModuleList::Append(const ModuleSP &module_sp, bool notify) {
221   AppendImpl(module_sp, notify);
222 }
223 
224 void ModuleList::ReplaceEquivalent(
225     const ModuleSP &module_sp,
226     llvm::SmallVectorImpl<lldb::ModuleSP> *old_modules) {
227   if (module_sp) {
228     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
229 
230     // First remove any equivalent modules. Equivalent modules are modules
231     // whose path, platform path and architecture match.
232     ModuleSpec equivalent_module_spec(module_sp->GetFileSpec(),
233                                       module_sp->GetArchitecture());
234     equivalent_module_spec.GetPlatformFileSpec() =
235         module_sp->GetPlatformFileSpec();
236 
237     size_t idx = 0;
238     while (idx < m_modules.size()) {
239       ModuleSP test_module_sp(m_modules[idx]);
240       if (test_module_sp->MatchesModuleSpec(equivalent_module_spec)) {
241         if (old_modules)
242           old_modules->push_back(test_module_sp);
243         RemoveImpl(m_modules.begin() + idx);
244       } else {
245         ++idx;
246       }
247     }
248     // Now add the new module to the list
249     Append(module_sp);
250   }
251 }
252 
253 bool ModuleList::AppendIfNeeded(const ModuleSP &new_module, bool notify) {
254   if (new_module) {
255     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
256     for (const ModuleSP &module_sp : m_modules) {
257       if (module_sp.get() == new_module.get())
258         return false; // Already in the list
259     }
260     // Only push module_sp on the list if it wasn't already in there.
261     Append(new_module, notify);
262     return true;
263   }
264   return false;
265 }
266 
267 void ModuleList::Append(const ModuleList &module_list) {
268   for (auto pos : module_list.m_modules)
269     Append(pos);
270 }
271 
272 bool ModuleList::AppendIfNeeded(const ModuleList &module_list) {
273   bool any_in = false;
274   for (auto pos : module_list.m_modules) {
275     if (AppendIfNeeded(pos))
276       any_in = true;
277   }
278   return any_in;
279 }
280 
281 bool ModuleList::RemoveImpl(const ModuleSP &module_sp, bool use_notifier) {
282   if (module_sp) {
283     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
284     collection::iterator pos, end = m_modules.end();
285     for (pos = m_modules.begin(); pos != end; ++pos) {
286       if (pos->get() == module_sp.get()) {
287         m_modules.erase(pos);
288         if (use_notifier && m_notifier)
289           m_notifier->NotifyModuleRemoved(*this, module_sp);
290         return true;
291       }
292     }
293   }
294   return false;
295 }
296 
297 ModuleList::collection::iterator
298 ModuleList::RemoveImpl(ModuleList::collection::iterator pos,
299                        bool use_notifier) {
300   ModuleSP module_sp(*pos);
301   collection::iterator retval = m_modules.erase(pos);
302   if (use_notifier && m_notifier)
303     m_notifier->NotifyModuleRemoved(*this, module_sp);
304   return retval;
305 }
306 
307 bool ModuleList::Remove(const ModuleSP &module_sp, bool notify) {
308   return RemoveImpl(module_sp, notify);
309 }
310 
311 bool ModuleList::ReplaceModule(const lldb::ModuleSP &old_module_sp,
312                                const lldb::ModuleSP &new_module_sp) {
313   if (!RemoveImpl(old_module_sp, false))
314     return false;
315   AppendImpl(new_module_sp, false);
316   if (m_notifier)
317     m_notifier->NotifyModuleUpdated(*this, old_module_sp, new_module_sp);
318   return true;
319 }
320 
321 bool ModuleList::RemoveIfOrphaned(const Module *module_ptr) {
322   if (module_ptr) {
323     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
324     collection::iterator pos, end = m_modules.end();
325     for (pos = m_modules.begin(); pos != end; ++pos) {
326       if (pos->get() == module_ptr) {
327         if (pos->unique()) {
328           pos = RemoveImpl(pos);
329           return true;
330         } else
331           return false;
332       }
333     }
334   }
335   return false;
336 }
337 
338 size_t ModuleList::RemoveOrphans(bool mandatory) {
339   std::unique_lock<std::recursive_mutex> lock(m_modules_mutex, std::defer_lock);
340 
341   if (mandatory) {
342     lock.lock();
343   } else {
344     // Not mandatory, remove orphans if we can get the mutex
345     if (!lock.try_lock())
346       return 0;
347   }
348   size_t remove_count = 0;
349   // Modules might hold shared pointers to other modules, so removing one
350   // module might make other modules orphans. Keep removing modules until
351   // there are no further modules that can be removed.
352   bool made_progress = true;
353   while (made_progress) {
354     // Keep track if we make progress this iteration.
355     made_progress = false;
356     collection::iterator pos = m_modules.begin();
357     while (pos != m_modules.end()) {
358       if (pos->unique()) {
359         pos = RemoveImpl(pos);
360         ++remove_count;
361         // We did make progress.
362         made_progress = true;
363       } else {
364         ++pos;
365       }
366     }
367   }
368   return remove_count;
369 }
370 
371 size_t ModuleList::Remove(ModuleList &module_list) {
372   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
373   size_t num_removed = 0;
374   collection::iterator pos, end = module_list.m_modules.end();
375   for (pos = module_list.m_modules.begin(); pos != end; ++pos) {
376     if (Remove(*pos, false /* notify */))
377       ++num_removed;
378   }
379   if (m_notifier)
380     m_notifier->NotifyModulesRemoved(module_list);
381   return num_removed;
382 }
383 
384 void ModuleList::Clear() { ClearImpl(); }
385 
386 void ModuleList::Destroy() { ClearImpl(); }
387 
388 void ModuleList::ClearImpl(bool use_notifier) {
389   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
390   if (use_notifier && m_notifier)
391     m_notifier->NotifyWillClearList(*this);
392   m_modules.clear();
393 }
394 
395 Module *ModuleList::GetModulePointerAtIndex(size_t idx) const {
396   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
397   if (idx < m_modules.size())
398     return m_modules[idx].get();
399   return nullptr;
400 }
401 
402 ModuleSP ModuleList::GetModuleAtIndex(size_t idx) const {
403   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
404   return GetModuleAtIndexUnlocked(idx);
405 }
406 
407 ModuleSP ModuleList::GetModuleAtIndexUnlocked(size_t idx) const {
408   ModuleSP module_sp;
409   if (idx < m_modules.size())
410     module_sp = m_modules[idx];
411   return module_sp;
412 }
413 
414 void ModuleList::FindFunctions(ConstString name,
415                                FunctionNameType name_type_mask,
416                                const ModuleFunctionSearchOptions &options,
417                                SymbolContextList &sc_list) const {
418   const size_t old_size = sc_list.GetSize();
419 
420   if (name_type_mask & eFunctionNameTypeAuto) {
421     Module::LookupInfo lookup_info(name, name_type_mask, eLanguageTypeUnknown);
422 
423     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
424     for (const ModuleSP &module_sp : m_modules) {
425       module_sp->FindFunctions(lookup_info, CompilerDeclContext(), options,
426                                sc_list);
427     }
428 
429     const size_t new_size = sc_list.GetSize();
430 
431     if (old_size < new_size)
432       lookup_info.Prune(sc_list, old_size);
433   } else {
434     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
435     for (const ModuleSP &module_sp : m_modules) {
436       module_sp->FindFunctions(name, CompilerDeclContext(), name_type_mask,
437                                options, sc_list);
438     }
439   }
440 }
441 
442 void ModuleList::FindFunctionSymbols(ConstString name,
443                                      lldb::FunctionNameType name_type_mask,
444                                      SymbolContextList &sc_list) {
445   const size_t old_size = sc_list.GetSize();
446 
447   if (name_type_mask & eFunctionNameTypeAuto) {
448     Module::LookupInfo lookup_info(name, name_type_mask, eLanguageTypeUnknown);
449 
450     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
451     for (const ModuleSP &module_sp : m_modules) {
452       module_sp->FindFunctionSymbols(lookup_info.GetLookupName(),
453                                      lookup_info.GetNameTypeMask(), sc_list);
454     }
455 
456     const size_t new_size = sc_list.GetSize();
457 
458     if (old_size < new_size)
459       lookup_info.Prune(sc_list, old_size);
460   } else {
461     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
462     for (const ModuleSP &module_sp : m_modules) {
463       module_sp->FindFunctionSymbols(name, name_type_mask, sc_list);
464     }
465   }
466 }
467 
468 void ModuleList::FindFunctions(const RegularExpression &name,
469                                const ModuleFunctionSearchOptions &options,
470                                SymbolContextList &sc_list) {
471   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
472   for (const ModuleSP &module_sp : m_modules)
473     module_sp->FindFunctions(name, options, sc_list);
474 }
475 
476 void ModuleList::FindCompileUnits(const FileSpec &path,
477                                   SymbolContextList &sc_list) const {
478   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
479   for (const ModuleSP &module_sp : m_modules)
480     module_sp->FindCompileUnits(path, sc_list);
481 }
482 
483 void ModuleList::FindGlobalVariables(ConstString name, size_t max_matches,
484                                      VariableList &variable_list) const {
485   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
486   for (const ModuleSP &module_sp : m_modules) {
487     module_sp->FindGlobalVariables(name, CompilerDeclContext(), max_matches,
488                                    variable_list);
489   }
490 }
491 
492 void ModuleList::FindGlobalVariables(const RegularExpression &regex,
493                                      size_t max_matches,
494                                      VariableList &variable_list) const {
495   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
496   for (const ModuleSP &module_sp : m_modules)
497     module_sp->FindGlobalVariables(regex, max_matches, variable_list);
498 }
499 
500 void ModuleList::FindSymbolsWithNameAndType(ConstString name,
501                                             SymbolType symbol_type,
502                                             SymbolContextList &sc_list) const {
503   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
504   for (const ModuleSP &module_sp : m_modules)
505     module_sp->FindSymbolsWithNameAndType(name, symbol_type, sc_list);
506 }
507 
508 void ModuleList::FindSymbolsMatchingRegExAndType(
509     const RegularExpression &regex, lldb::SymbolType symbol_type,
510     SymbolContextList &sc_list) const {
511   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
512   for (const ModuleSP &module_sp : m_modules)
513     module_sp->FindSymbolsMatchingRegExAndType(regex, symbol_type, sc_list);
514 }
515 
516 void ModuleList::FindModules(const ModuleSpec &module_spec,
517                              ModuleList &matching_module_list) const {
518   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
519   for (const ModuleSP &module_sp : m_modules) {
520     if (module_sp->MatchesModuleSpec(module_spec))
521       matching_module_list.Append(module_sp);
522   }
523 }
524 
525 ModuleSP ModuleList::FindModule(const Module *module_ptr) const {
526   ModuleSP module_sp;
527 
528   // Scope for "locker"
529   {
530     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
531     collection::const_iterator pos, end = m_modules.end();
532 
533     for (pos = m_modules.begin(); pos != end; ++pos) {
534       if ((*pos).get() == module_ptr) {
535         module_sp = (*pos);
536         break;
537       }
538     }
539   }
540   return module_sp;
541 }
542 
543 ModuleSP ModuleList::FindModule(const UUID &uuid) const {
544   ModuleSP module_sp;
545 
546   if (uuid.IsValid()) {
547     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
548     collection::const_iterator pos, end = m_modules.end();
549 
550     for (pos = m_modules.begin(); pos != end; ++pos) {
551       if ((*pos)->GetUUID() == uuid) {
552         module_sp = (*pos);
553         break;
554       }
555     }
556   }
557   return module_sp;
558 }
559 
560 void ModuleList::FindTypes(Module *search_first, ConstString name,
561                            bool name_is_fully_qualified, size_t max_matches,
562                            llvm::DenseSet<SymbolFile *> &searched_symbol_files,
563                            TypeList &types) const {
564   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
565 
566   collection::const_iterator pos, end = m_modules.end();
567   if (search_first) {
568     for (pos = m_modules.begin(); pos != end; ++pos) {
569       if (search_first == pos->get()) {
570         search_first->FindTypes(name, name_is_fully_qualified, max_matches,
571                                 searched_symbol_files, types);
572 
573         if (types.GetSize() >= max_matches)
574           return;
575       }
576     }
577   }
578 
579   for (pos = m_modules.begin(); pos != end; ++pos) {
580     // Search the module if the module is not equal to the one in the symbol
581     // context "sc". If "sc" contains a empty module shared pointer, then the
582     // comparison will always be true (valid_module_ptr != nullptr).
583     if (search_first != pos->get())
584       (*pos)->FindTypes(name, name_is_fully_qualified, max_matches,
585                         searched_symbol_files, types);
586 
587     if (types.GetSize() >= max_matches)
588       return;
589   }
590 }
591 
592 bool ModuleList::FindSourceFile(const FileSpec &orig_spec,
593                                 FileSpec &new_spec) const {
594   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
595   for (const ModuleSP &module_sp : m_modules) {
596     if (module_sp->FindSourceFile(orig_spec, new_spec))
597       return true;
598   }
599   return false;
600 }
601 
602 void ModuleList::FindAddressesForLine(const lldb::TargetSP target_sp,
603                                       const FileSpec &file, uint32_t line,
604                                       Function *function,
605                                       std::vector<Address> &output_local,
606                                       std::vector<Address> &output_extern) {
607   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
608   for (const ModuleSP &module_sp : m_modules) {
609     module_sp->FindAddressesForLine(target_sp, file, line, function,
610                                     output_local, output_extern);
611   }
612 }
613 
614 ModuleSP ModuleList::FindFirstModule(const ModuleSpec &module_spec) const {
615   ModuleSP module_sp;
616   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
617   collection::const_iterator pos, end = m_modules.end();
618   for (pos = m_modules.begin(); pos != end; ++pos) {
619     ModuleSP module_sp(*pos);
620     if (module_sp->MatchesModuleSpec(module_spec))
621       return module_sp;
622   }
623   return module_sp;
624 }
625 
626 size_t ModuleList::GetSize() const {
627   size_t size = 0;
628   {
629     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
630     size = m_modules.size();
631   }
632   return size;
633 }
634 
635 void ModuleList::Dump(Stream *s) const {
636   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
637   for (const ModuleSP &module_sp : m_modules)
638     module_sp->Dump(s);
639 }
640 
641 void ModuleList::LogUUIDAndPaths(Log *log, const char *prefix_cstr) {
642   if (log != nullptr) {
643     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
644     collection::const_iterator pos, begin = m_modules.begin(),
645                                     end = m_modules.end();
646     for (pos = begin; pos != end; ++pos) {
647       Module *module = pos->get();
648       const FileSpec &module_file_spec = module->GetFileSpec();
649       LLDB_LOGF(log, "%s[%u] %s (%s) \"%s\"", prefix_cstr ? prefix_cstr : "",
650                 (uint32_t)std::distance(begin, pos),
651                 module->GetUUID().GetAsString().c_str(),
652                 module->GetArchitecture().GetArchitectureName(),
653                 module_file_spec.GetPath().c_str());
654     }
655   }
656 }
657 
658 bool ModuleList::ResolveFileAddress(lldb::addr_t vm_addr,
659                                     Address &so_addr) const {
660   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
661   for (const ModuleSP &module_sp : m_modules) {
662     if (module_sp->ResolveFileAddress(vm_addr, so_addr))
663       return true;
664   }
665 
666   return false;
667 }
668 
669 uint32_t
670 ModuleList::ResolveSymbolContextForAddress(const Address &so_addr,
671                                            SymbolContextItem resolve_scope,
672                                            SymbolContext &sc) const {
673   // The address is already section offset so it has a module
674   uint32_t resolved_flags = 0;
675   ModuleSP module_sp(so_addr.GetModule());
676   if (module_sp) {
677     resolved_flags =
678         module_sp->ResolveSymbolContextForAddress(so_addr, resolve_scope, sc);
679   } else {
680     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
681     collection::const_iterator pos, end = m_modules.end();
682     for (pos = m_modules.begin(); pos != end; ++pos) {
683       resolved_flags =
684           (*pos)->ResolveSymbolContextForAddress(so_addr, resolve_scope, sc);
685       if (resolved_flags != 0)
686         break;
687     }
688   }
689 
690   return resolved_flags;
691 }
692 
693 uint32_t ModuleList::ResolveSymbolContextForFilePath(
694     const char *file_path, uint32_t line, bool check_inlines,
695     SymbolContextItem resolve_scope, SymbolContextList &sc_list) const {
696   FileSpec file_spec(file_path);
697   return ResolveSymbolContextsForFileSpec(file_spec, line, check_inlines,
698                                           resolve_scope, sc_list);
699 }
700 
701 uint32_t ModuleList::ResolveSymbolContextsForFileSpec(
702     const FileSpec &file_spec, uint32_t line, bool check_inlines,
703     SymbolContextItem resolve_scope, SymbolContextList &sc_list) const {
704   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
705   for (const ModuleSP &module_sp : m_modules) {
706     module_sp->ResolveSymbolContextsForFileSpec(file_spec, line, check_inlines,
707                                                 resolve_scope, sc_list);
708   }
709 
710   return sc_list.GetSize();
711 }
712 
713 size_t ModuleList::GetIndexForModule(const Module *module) const {
714   if (module) {
715     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
716     collection::const_iterator pos;
717     collection::const_iterator begin = m_modules.begin();
718     collection::const_iterator end = m_modules.end();
719     for (pos = begin; pos != end; ++pos) {
720       if ((*pos).get() == module)
721         return std::distance(begin, pos);
722     }
723   }
724   return LLDB_INVALID_INDEX32;
725 }
726 
727 namespace {
728 struct SharedModuleListInfo {
729   ModuleList module_list;
730   ModuleListProperties module_list_properties;
731 };
732 }
733 static SharedModuleListInfo &GetSharedModuleListInfo()
734 {
735   static SharedModuleListInfo *g_shared_module_list_info = nullptr;
736   static llvm::once_flag g_once_flag;
737   llvm::call_once(g_once_flag, []() {
738     // NOTE: Intentionally leak the module list so a program doesn't have to
739     // cleanup all modules and object files as it exits. This just wastes time
740     // doing a bunch of cleanup that isn't required.
741     if (g_shared_module_list_info == nullptr)
742       g_shared_module_list_info = new SharedModuleListInfo();
743   });
744   return *g_shared_module_list_info;
745 }
746 
747 static ModuleList &GetSharedModuleList() {
748   return GetSharedModuleListInfo().module_list;
749 }
750 
751 ModuleListProperties &ModuleList::GetGlobalModuleListProperties() {
752   return GetSharedModuleListInfo().module_list_properties;
753 }
754 
755 bool ModuleList::ModuleIsInCache(const Module *module_ptr) {
756   if (module_ptr) {
757     ModuleList &shared_module_list = GetSharedModuleList();
758     return shared_module_list.FindModule(module_ptr).get() != nullptr;
759   }
760   return false;
761 }
762 
763 void ModuleList::FindSharedModules(const ModuleSpec &module_spec,
764                                    ModuleList &matching_module_list) {
765   GetSharedModuleList().FindModules(module_spec, matching_module_list);
766 }
767 
768 lldb::ModuleSP ModuleList::FindSharedModule(const UUID &uuid) {
769   return GetSharedModuleList().FindModule(uuid);
770 }
771 
772 size_t ModuleList::RemoveOrphanSharedModules(bool mandatory) {
773   return GetSharedModuleList().RemoveOrphans(mandatory);
774 }
775 
776 Status
777 ModuleList::GetSharedModule(const ModuleSpec &module_spec, ModuleSP &module_sp,
778                             const FileSpecList *module_search_paths_ptr,
779                             llvm::SmallVectorImpl<lldb::ModuleSP> *old_modules,
780                             bool *did_create_ptr, bool always_create) {
781   ModuleList &shared_module_list = GetSharedModuleList();
782   std::lock_guard<std::recursive_mutex> guard(
783       shared_module_list.m_modules_mutex);
784   char path[PATH_MAX];
785 
786   Status error;
787 
788   module_sp.reset();
789 
790   if (did_create_ptr)
791     *did_create_ptr = false;
792 
793   const UUID *uuid_ptr = module_spec.GetUUIDPtr();
794   const FileSpec &module_file_spec = module_spec.GetFileSpec();
795   const ArchSpec &arch = module_spec.GetArchitecture();
796 
797   // Make sure no one else can try and get or create a module while this
798   // function is actively working on it by doing an extra lock on the global
799   // mutex list.
800   if (!always_create) {
801     ModuleList matching_module_list;
802     shared_module_list.FindModules(module_spec, matching_module_list);
803     const size_t num_matching_modules = matching_module_list.GetSize();
804 
805     if (num_matching_modules > 0) {
806       for (size_t module_idx = 0; module_idx < num_matching_modules;
807            ++module_idx) {
808         module_sp = matching_module_list.GetModuleAtIndex(module_idx);
809 
810         // Make sure the file for the module hasn't been modified
811         if (module_sp->FileHasChanged()) {
812           if (old_modules)
813             old_modules->push_back(module_sp);
814 
815           Log *log = GetLog(LLDBLog::Modules);
816           if (log != nullptr)
817             LLDB_LOGF(
818                 log, "%p '%s' module changed: removing from global module list",
819                 static_cast<void *>(module_sp.get()),
820                 module_sp->GetFileSpec().GetFilename().GetCString());
821 
822           shared_module_list.Remove(module_sp);
823           module_sp.reset();
824         } else {
825           // The module matches and the module was not modified from when it
826           // was last loaded.
827           return error;
828         }
829       }
830     }
831   }
832 
833   if (module_sp)
834     return error;
835 
836   module_sp = std::make_shared<Module>(module_spec);
837   // Make sure there are a module and an object file since we can specify a
838   // valid file path with an architecture that might not be in that file. By
839   // getting the object file we can guarantee that the architecture matches
840   if (module_sp->GetObjectFile()) {
841     // If we get in here we got the correct arch, now we just need to verify
842     // the UUID if one was given
843     if (uuid_ptr && *uuid_ptr != module_sp->GetUUID()) {
844       module_sp.reset();
845     } else {
846       if (module_sp->GetObjectFile() &&
847           module_sp->GetObjectFile()->GetType() ==
848               ObjectFile::eTypeStubLibrary) {
849         module_sp.reset();
850       } else {
851         if (did_create_ptr) {
852           *did_create_ptr = true;
853         }
854 
855         shared_module_list.ReplaceEquivalent(module_sp, old_modules);
856         return error;
857       }
858     }
859   } else {
860     module_sp.reset();
861   }
862 
863   if (module_search_paths_ptr) {
864     const auto num_directories = module_search_paths_ptr->GetSize();
865     for (size_t idx = 0; idx < num_directories; ++idx) {
866       auto search_path_spec = module_search_paths_ptr->GetFileSpecAtIndex(idx);
867       FileSystem::Instance().Resolve(search_path_spec);
868       namespace fs = llvm::sys::fs;
869       if (!FileSystem::Instance().IsDirectory(search_path_spec))
870         continue;
871       search_path_spec.AppendPathComponent(
872           module_spec.GetFileSpec().GetFilename().GetStringRef());
873       if (!FileSystem::Instance().Exists(search_path_spec))
874         continue;
875 
876       auto resolved_module_spec(module_spec);
877       resolved_module_spec.GetFileSpec() = search_path_spec;
878       module_sp = std::make_shared<Module>(resolved_module_spec);
879       if (module_sp->GetObjectFile()) {
880         // If we get in here we got the correct arch, now we just need to
881         // verify the UUID if one was given
882         if (uuid_ptr && *uuid_ptr != module_sp->GetUUID()) {
883           module_sp.reset();
884         } else {
885           if (module_sp->GetObjectFile()->GetType() ==
886               ObjectFile::eTypeStubLibrary) {
887             module_sp.reset();
888           } else {
889             if (did_create_ptr)
890               *did_create_ptr = true;
891 
892             shared_module_list.ReplaceEquivalent(module_sp, old_modules);
893             return Status();
894           }
895         }
896       } else {
897         module_sp.reset();
898       }
899     }
900   }
901 
902   // Either the file didn't exist where at the path, or no path was given, so
903   // we now have to use more extreme measures to try and find the appropriate
904   // module.
905 
906   // Fixup the incoming path in case the path points to a valid file, yet the
907   // arch or UUID (if one was passed in) don't match.
908   ModuleSpec located_binary_modulespec =
909       Symbols::LocateExecutableObjectFile(module_spec);
910 
911   // Don't look for the file if it appears to be the same one we already
912   // checked for above...
913   if (located_binary_modulespec.GetFileSpec() != module_file_spec) {
914     if (!FileSystem::Instance().Exists(
915             located_binary_modulespec.GetFileSpec())) {
916       located_binary_modulespec.GetFileSpec().GetPath(path, sizeof(path));
917       if (path[0] == '\0')
918         module_file_spec.GetPath(path, sizeof(path));
919       // How can this check ever be true? This branch it is false, and we
920       // haven't modified file_spec.
921       if (FileSystem::Instance().Exists(
922               located_binary_modulespec.GetFileSpec())) {
923         std::string uuid_str;
924         if (uuid_ptr && uuid_ptr->IsValid())
925           uuid_str = uuid_ptr->GetAsString();
926 
927         if (arch.IsValid()) {
928           if (!uuid_str.empty())
929             error.SetErrorStringWithFormat(
930                 "'%s' does not contain the %s architecture and UUID %s", path,
931                 arch.GetArchitectureName(), uuid_str.c_str());
932           else
933             error.SetErrorStringWithFormat(
934                 "'%s' does not contain the %s architecture.", path,
935                 arch.GetArchitectureName());
936         }
937       } else {
938         error.SetErrorStringWithFormat("'%s' does not exist", path);
939       }
940       if (error.Fail())
941         module_sp.reset();
942       return error;
943     }
944 
945     // Make sure no one else can try and get or create a module while this
946     // function is actively working on it by doing an extra lock on the global
947     // mutex list.
948     ModuleSpec platform_module_spec(module_spec);
949     platform_module_spec.GetFileSpec() =
950         located_binary_modulespec.GetFileSpec();
951     platform_module_spec.GetPlatformFileSpec() =
952         located_binary_modulespec.GetFileSpec();
953     platform_module_spec.GetSymbolFileSpec() =
954         located_binary_modulespec.GetSymbolFileSpec();
955     ModuleList matching_module_list;
956     shared_module_list.FindModules(platform_module_spec, matching_module_list);
957     if (!matching_module_list.IsEmpty()) {
958       module_sp = matching_module_list.GetModuleAtIndex(0);
959 
960       // If we didn't have a UUID in mind when looking for the object file,
961       // then we should make sure the modification time hasn't changed!
962       if (platform_module_spec.GetUUIDPtr() == nullptr) {
963         auto file_spec_mod_time = FileSystem::Instance().GetModificationTime(
964             located_binary_modulespec.GetFileSpec());
965         if (file_spec_mod_time != llvm::sys::TimePoint<>()) {
966           if (file_spec_mod_time != module_sp->GetModificationTime()) {
967             if (old_modules)
968               old_modules->push_back(module_sp);
969             shared_module_list.Remove(module_sp);
970             module_sp.reset();
971           }
972         }
973       }
974     }
975 
976     if (!module_sp) {
977       module_sp = std::make_shared<Module>(platform_module_spec);
978       // Make sure there are a module and an object file since we can specify a
979       // valid file path with an architecture that might not be in that file.
980       // By getting the object file we can guarantee that the architecture
981       // matches
982       if (module_sp && module_sp->GetObjectFile()) {
983         if (module_sp->GetObjectFile()->GetType() ==
984             ObjectFile::eTypeStubLibrary) {
985           module_sp.reset();
986         } else {
987           if (did_create_ptr)
988             *did_create_ptr = true;
989 
990           shared_module_list.ReplaceEquivalent(module_sp, old_modules);
991         }
992       } else {
993         located_binary_modulespec.GetFileSpec().GetPath(path, sizeof(path));
994 
995         if (located_binary_modulespec.GetFileSpec()) {
996           if (arch.IsValid())
997             error.SetErrorStringWithFormat(
998                 "unable to open %s architecture in '%s'",
999                 arch.GetArchitectureName(), path);
1000           else
1001             error.SetErrorStringWithFormat("unable to open '%s'", path);
1002         } else {
1003           std::string uuid_str;
1004           if (uuid_ptr && uuid_ptr->IsValid())
1005             uuid_str = uuid_ptr->GetAsString();
1006 
1007           if (!uuid_str.empty())
1008             error.SetErrorStringWithFormat(
1009                 "cannot locate a module for UUID '%s'", uuid_str.c_str());
1010           else
1011             error.SetErrorString("cannot locate a module");
1012         }
1013       }
1014     }
1015   }
1016 
1017   return error;
1018 }
1019 
1020 bool ModuleList::RemoveSharedModule(lldb::ModuleSP &module_sp) {
1021   return GetSharedModuleList().Remove(module_sp);
1022 }
1023 
1024 bool ModuleList::RemoveSharedModuleIfOrphaned(const Module *module_ptr) {
1025   return GetSharedModuleList().RemoveIfOrphaned(module_ptr);
1026 }
1027 
1028 bool ModuleList::LoadScriptingResourcesInTarget(Target *target,
1029                                                 std::list<Status> &errors,
1030                                                 Stream &feedback_stream,
1031                                                 bool continue_on_error) {
1032   if (!target)
1033     return false;
1034   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
1035   for (auto module : m_modules) {
1036     Status error;
1037     if (module) {
1038       if (!module->LoadScriptingResourceInTarget(target, error,
1039                                                  feedback_stream)) {
1040         if (error.Fail() && error.AsCString()) {
1041           error.SetErrorStringWithFormat("unable to load scripting data for "
1042                                          "module %s - error reported was %s",
1043                                          module->GetFileSpec()
1044                                              .GetFileNameStrippingExtension()
1045                                              .GetCString(),
1046                                          error.AsCString());
1047           errors.push_back(error);
1048 
1049           if (!continue_on_error)
1050             return false;
1051         }
1052       }
1053     }
1054   }
1055   return errors.empty();
1056 }
1057 
1058 void ModuleList::ForEach(
1059     std::function<bool(const ModuleSP &module_sp)> const &callback) const {
1060   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
1061   for (const auto &module_sp : m_modules) {
1062     assert(module_sp != nullptr);
1063     // If the callback returns false, then stop iterating and break out
1064     if (!callback(module_sp))
1065       break;
1066   }
1067 }
1068 
1069 bool ModuleList::AnyOf(
1070     std::function<bool(lldb_private::Module &module_sp)> const &callback)
1071     const {
1072   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
1073   for (const auto &module_sp : m_modules) {
1074     assert(module_sp != nullptr);
1075     if (callback(*module_sp))
1076       return true;
1077   }
1078 
1079   return false;
1080 }
1081 
1082 
1083 void ModuleList::Swap(ModuleList &other) {
1084   // scoped_lock locks both mutexes at once.
1085   std::scoped_lock<std::recursive_mutex, std::recursive_mutex> lock(
1086       m_modules_mutex, other.m_modules_mutex);
1087   m_modules.swap(other.m_modules);
1088 }
1089