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