LLDB mainline
Module.cpp
Go to the documentation of this file.
1//===-- Module.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/Module.h"
10
14#include "lldb/Core/Debugger.h"
15#include "lldb/Core/Mangled.h"
18#include "lldb/Core/Section.h"
20#include "lldb/Host/Host.h"
21#include "lldb/Host/HostInfo.h"
27#include "lldb/Symbol/Symbol.h"
32#include "lldb/Symbol/Symtab.h"
33#include "lldb/Symbol/Type.h"
35#include "lldb/Symbol/TypeMap.h"
38#include "lldb/Target/Process.h"
39#include "lldb/Target/Target.h"
44#include "lldb/Utility/Log.h"
46#include "lldb/Utility/Status.h"
47#include "lldb/Utility/Stream.h"
49#include "lldb/Utility/Timer.h"
50
51#if defined(_WIN32)
53#endif
54
57
58#include "llvm/ADT/STLExtras.h"
59#include "llvm/Support/Compiler.h"
60#include "llvm/Support/DJB.h"
61#include "llvm/Support/FileSystem.h"
62#include "llvm/Support/FormatVariadic.h"
63#include "llvm/Support/JSON.h"
64#include "llvm/Support/Signals.h"
65#include "llvm/Support/raw_ostream.h"
66
67#include <cassert>
68#include <cinttypes>
69#include <cstdarg>
70#include <cstdint>
71#include <cstring>
72#include <map>
73#include <optional>
74#include <type_traits>
75#include <utility>
76
77namespace lldb_private {
79}
80namespace lldb_private {
81class VariableList;
82}
83
84using namespace lldb;
85using namespace lldb_private;
86
87// Shared pointers to modules track module lifetimes in targets and in the
88// global module, but this collection will track all module objects that are
89// still alive
90typedef std::vector<Module *> ModuleCollection;
91
93 // This module collection needs to live past any module, so we could either
94 // make it a shared pointer in each module or just leak is. Since it is only
95 // an empty vector by the time all the modules have gone away, we just leak
96 // it for now. If we decide this is a big problem we can introduce a
97 // Finalize method that will tear everything down in a predictable order.
98
99 static ModuleCollection *g_module_collection = nullptr;
100 if (g_module_collection == nullptr)
101 g_module_collection = new ModuleCollection();
102
103 return *g_module_collection;
104}
105
107 // NOTE: The mutex below must be leaked since the global module list in
108 // the ModuleList class will get torn at some point, and we can't know if it
109 // will tear itself down before the "g_module_collection_mutex" below will.
110 // So we leak a Mutex object below to safeguard against that
111
112 static std::recursive_mutex *g_module_collection_mutex = nullptr;
113 if (g_module_collection_mutex == nullptr)
114 g_module_collection_mutex = new std::recursive_mutex; // NOTE: known leak
115 return *g_module_collection_mutex;
116}
117
119 std::lock_guard<std::recursive_mutex> guard(
121 return GetModuleCollection().size();
122}
123
125 std::lock_guard<std::recursive_mutex> guard(
128 if (idx < modules.size())
129 return modules[idx];
130 return nullptr;
131}
132
133Module::Module(const ModuleSpec &module_spec)
134 : m_file_has_changed(false), m_first_file_changed_log(false) {
135 // Scope for locker below...
136 {
137 std::lock_guard<std::recursive_mutex> guard(
139 GetModuleCollection().push_back(this);
140 }
141
143 if (log != nullptr)
144 LLDB_LOGF(log, "%p Module::Module((%s) '%s%s%s%s')",
145 static_cast<void *>(this),
146 module_spec.GetArchitecture().GetArchitectureName(),
147 module_spec.GetFileSpec().GetPath().c_str(),
148 module_spec.GetObjectName().IsEmpty() ? "" : "(",
149 module_spec.GetObjectName().AsCString(""),
150 module_spec.GetObjectName().IsEmpty() ? "" : ")");
151
152 auto data_sp = module_spec.GetData();
153 lldb::offset_t file_size = 0;
154 if (data_sp)
155 file_size = data_sp->GetByteSize();
156
157 // First extract all module specifications from the file using the local file
158 // path. If there are no specifications, then don't fill anything in
159 ModuleSpecList modules_specs;
161 module_spec.GetFileSpec(), 0, file_size, modules_specs, data_sp) == 0)
162 return;
163
164 // Now make sure that one of the module specifications matches what we just
165 // extract. We might have a module specification that specifies a file
166 // "/usr/lib/dyld" with UUID XXX, but we might have a local version of
167 // "/usr/lib/dyld" that has
168 // UUID YYY and we don't want those to match. If they don't match, just don't
169 // fill any ivars in so we don't accidentally grab the wrong file later since
170 // they don't match...
171 ModuleSpec matching_module_spec;
172 if (!modules_specs.FindMatchingModuleSpec(module_spec,
173 matching_module_spec)) {
174 if (log) {
175 LLDB_LOGF(log, "Found local object file but the specs didn't match");
176 }
177 return;
178 }
179
180 // Set m_data_sp if it was initially provided in the ModuleSpec. Note that
181 // we cannot use the data_sp variable here, because it will have been
182 // modified by GetModuleSpecifications().
183 if (auto module_spec_data_sp = module_spec.GetData()) {
184 m_data_sp = module_spec_data_sp;
185 m_mod_time = {};
186 } else {
187 if (module_spec.GetFileSpec())
188 m_mod_time =
190 else if (matching_module_spec.GetFileSpec())
192 matching_module_spec.GetFileSpec());
193 }
194
195 // Copy the architecture from the actual spec if we got one back, else use
196 // the one that was specified
197 if (matching_module_spec.GetArchitecture().IsValid())
198 m_arch = matching_module_spec.GetArchitecture();
199 else if (module_spec.GetArchitecture().IsValid())
200 m_arch = module_spec.GetArchitecture();
201
202 // Copy the file spec over and use the specified one (if there was one) so we
203 // don't use a path that might have gotten resolved a path in
204 // 'matching_module_spec'
205 if (module_spec.GetFileSpec())
206 m_file = module_spec.GetFileSpec();
207 else if (matching_module_spec.GetFileSpec())
208 m_file = matching_module_spec.GetFileSpec();
209
210 // Copy the platform file spec over
211 if (module_spec.GetPlatformFileSpec())
212 m_platform_file = module_spec.GetPlatformFileSpec();
213 else if (matching_module_spec.GetPlatformFileSpec())
214 m_platform_file = matching_module_spec.GetPlatformFileSpec();
215
216 // Copy the symbol file spec over
217 if (module_spec.GetSymbolFileSpec())
218 m_symfile_spec = module_spec.GetSymbolFileSpec();
219 else if (matching_module_spec.GetSymbolFileSpec())
220 m_symfile_spec = matching_module_spec.GetSymbolFileSpec();
221
222 // Copy the object name over
223 if (matching_module_spec.GetObjectName())
224 m_object_name = matching_module_spec.GetObjectName();
225 else
226 m_object_name = module_spec.GetObjectName();
227
228 // Always trust the object offset (file offset) and object modification time
229 // (for mod time in a BSD static archive) of from the matching module
230 // specification
231 m_object_offset = matching_module_spec.GetObjectOffset();
232 m_object_mod_time = matching_module_spec.GetObjectModificationTime();
233}
234
235Module::Module(const FileSpec &file_spec, const ArchSpec &arch,
236 ConstString object_name, lldb::offset_t object_offset,
237 const llvm::sys::TimePoint<> &object_mod_time)
238 : m_mod_time(FileSystem::Instance().GetModificationTime(file_spec)),
239 m_arch(arch), m_file(file_spec), m_object_name(object_name),
240 m_object_offset(object_offset), m_object_mod_time(object_mod_time),
241 m_file_has_changed(false), m_first_file_changed_log(false) {
242 // Scope for locker below...
243 {
244 std::lock_guard<std::recursive_mutex> guard(
246 GetModuleCollection().push_back(this);
247 }
248
250 if (log != nullptr)
251 LLDB_LOGF(log, "%p Module::Module((%s) '%s%s%s%s')",
252 static_cast<void *>(this), m_arch.GetArchitectureName(),
253 m_file.GetPath().c_str(), m_object_name.IsEmpty() ? "" : "(",
254 m_object_name.AsCString(""), m_object_name.IsEmpty() ? "" : ")");
255}
256
257Module::Module() : m_file_has_changed(false), m_first_file_changed_log(false) {
258 std::lock_guard<std::recursive_mutex> guard(
260 GetModuleCollection().push_back(this);
261}
262
264 // Lock our module down while we tear everything down to make sure we don't
265 // get any access to the module while it is being destroyed
266 std::lock_guard<std::recursive_mutex> guard(m_mutex);
267 // Scope for locker below...
268 {
269 std::lock_guard<std::recursive_mutex> guard(
272 ModuleCollection::iterator end = modules.end();
273 ModuleCollection::iterator pos = std::find(modules.begin(), end, this);
274 assert(pos != end);
275 modules.erase(pos);
276 }
278 if (log != nullptr)
279 LLDB_LOGF(log, "%p Module::~Module((%s) '%s%s%s%s')",
280 static_cast<void *>(this), m_arch.GetArchitectureName(),
281 m_file.GetPath().c_str(), m_object_name.IsEmpty() ? "" : "(",
282 m_object_name.AsCString(""), m_object_name.IsEmpty() ? "" : ")");
283 // Release any auto pointers before we start tearing down our member
284 // variables since the object file and symbol files might need to make
285 // function calls back into this module object. The ordering is important
286 // here because symbol files can require the module object file. So we tear
287 // down the symbol file first, then the object file.
288 m_sections_up.reset();
289 m_symfile_up.reset();
290 m_objfile_sp.reset();
291}
292
294 lldb::addr_t header_addr, Status &error,
295 size_t size_to_read) {
296 if (m_objfile_sp) {
297 error.SetErrorString("object file already exists");
298 } else {
299 std::lock_guard<std::recursive_mutex> guard(m_mutex);
300 if (process_sp) {
301 m_did_load_objfile = true;
302 std::shared_ptr<DataBufferHeap> data_sp =
303 std::make_shared<DataBufferHeap>(size_to_read, 0);
304 Status readmem_error;
305 const size_t bytes_read =
306 process_sp->ReadMemory(header_addr, data_sp->GetBytes(),
307 data_sp->GetByteSize(), readmem_error);
308 if (bytes_read < size_to_read)
309 data_sp->SetByteSize(bytes_read);
310 if (data_sp->GetByteSize() > 0) {
311 m_objfile_sp = ObjectFile::FindPlugin(shared_from_this(), process_sp,
312 header_addr, data_sp);
313 if (m_objfile_sp) {
314 StreamString s;
315 s.Printf("0x%16.16" PRIx64, header_addr);
317
318 // Once we get the object file, update our module with the object
319 // file's architecture since it might differ in vendor/os if some
320 // parts were unknown.
321 m_arch = m_objfile_sp->GetArchitecture();
322
323 // Augment the arch with the target's information in case
324 // we are unable to extract the os/environment from memory.
325 m_arch.MergeFrom(process_sp->GetTarget().GetArchitecture());
326 } else {
327 error.SetErrorString("unable to find suitable object file plug-in");
328 }
329 } else {
330 error.SetErrorStringWithFormat("unable to read header from memory: %s",
331 readmem_error.AsCString());
332 }
333 } else {
334 error.SetErrorString("invalid process");
335 }
336 }
337 return m_objfile_sp.get();
338}
339
341 if (!m_did_set_uuid.load()) {
342 std::lock_guard<std::recursive_mutex> guard(m_mutex);
343 if (!m_did_set_uuid.load()) {
344 ObjectFile *obj_file = GetObjectFile();
345
346 if (obj_file != nullptr) {
347 m_uuid = obj_file->GetUUID();
348 m_did_set_uuid = true;
349 }
350 }
351 }
352 return m_uuid;
353}
354
356 std::lock_guard<std::recursive_mutex> guard(m_mutex);
357 if (!m_did_set_uuid) {
358 m_uuid = uuid;
359 m_did_set_uuid = true;
360 } else {
361 lldbassert(0 && "Attempting to overwrite the existing module UUID");
362 }
363}
364
365llvm::Expected<TypeSystemSP>
367 return m_type_system_map.GetTypeSystemForLanguage(language, this, true);
368}
369
371 llvm::function_ref<bool(lldb::TypeSystemSP)> callback) {
372 m_type_system_map.ForEach(callback);
373}
374
376 std::lock_guard<std::recursive_mutex> guard(m_mutex);
377 size_t num_comp_units = GetNumCompileUnits();
378 if (num_comp_units == 0)
379 return;
380
381 SymbolFile *symbols = GetSymbolFile();
382
383 for (size_t cu_idx = 0; cu_idx < num_comp_units; cu_idx++) {
384 SymbolContext sc;
385 sc.module_sp = shared_from_this();
386 sc.comp_unit = symbols->GetCompileUnitAtIndex(cu_idx).get();
387 if (!sc.comp_unit)
388 continue;
389
390 symbols->ParseVariablesForContext(sc);
391
392 symbols->ParseFunctions(*sc.comp_unit);
393
394 sc.comp_unit->ForeachFunction([&sc, &symbols](const FunctionSP &f) {
395 symbols->ParseBlocksRecursive(*f);
396
397 // Parse the variables for this function and all its blocks
398 sc.function = f.get();
399 symbols->ParseVariablesForContext(sc);
400 return false;
401 });
402
403 // Parse all types for this compile unit
404 symbols->ParseTypes(*sc.comp_unit);
405 }
406}
407
409 sc->module_sp = shared_from_this();
410}
411
412ModuleSP Module::CalculateSymbolContextModule() { return shared_from_this(); }
413
415 s->Printf(", Module{%p}", static_cast<void *>(this));
416}
417
419 std::lock_guard<std::recursive_mutex> guard(m_mutex);
420 if (SymbolFile *symbols = GetSymbolFile())
421 return symbols->GetNumCompileUnits();
422 return 0;
423}
424
426 std::lock_guard<std::recursive_mutex> guard(m_mutex);
427 size_t num_comp_units = GetNumCompileUnits();
428 CompUnitSP cu_sp;
429
430 if (index < num_comp_units) {
431 if (SymbolFile *symbols = GetSymbolFile())
432 cu_sp = symbols->GetCompileUnitAtIndex(index);
433 }
434 return cu_sp;
435}
436
438 std::lock_guard<std::recursive_mutex> guard(m_mutex);
439 SectionList *section_list = GetSectionList();
440 if (section_list)
441 return so_addr.ResolveAddressUsingFileSections(vm_addr, section_list);
442 return false;
443}
444
446 const Address &so_addr, lldb::SymbolContextItem resolve_scope,
447 SymbolContext &sc, bool resolve_tail_call_address) {
448 std::lock_guard<std::recursive_mutex> guard(m_mutex);
449 uint32_t resolved_flags = 0;
450
451 // Clear the result symbol context in case we don't find anything, but don't
452 // clear the target
453 sc.Clear(false);
454
455 // Get the section from the section/offset address.
456 SectionSP section_sp(so_addr.GetSection());
457
458 // Make sure the section matches this module before we try and match anything
459 if (section_sp && section_sp->GetModule().get() == this) {
460 // If the section offset based address resolved itself, then this is the
461 // right module.
462 sc.module_sp = shared_from_this();
463 resolved_flags |= eSymbolContextModule;
464
465 SymbolFile *symfile = GetSymbolFile();
466 if (!symfile)
467 return resolved_flags;
468
469 // Resolve the compile unit, function, block, line table or line entry if
470 // requested.
471 if (resolve_scope & eSymbolContextCompUnit ||
472 resolve_scope & eSymbolContextFunction ||
473 resolve_scope & eSymbolContextBlock ||
474 resolve_scope & eSymbolContextLineEntry ||
475 resolve_scope & eSymbolContextVariable) {
476 symfile->SetLoadDebugInfoEnabled();
477 resolved_flags |=
478 symfile->ResolveSymbolContext(so_addr, resolve_scope, sc);
479 }
480
481 // Resolve the symbol if requested, but don't re-look it up if we've
482 // already found it.
483 if (resolve_scope & eSymbolContextSymbol &&
484 !(resolved_flags & eSymbolContextSymbol)) {
485 Symtab *symtab = symfile->GetSymtab();
486 if (symtab && so_addr.IsSectionOffset()) {
487 Symbol *matching_symbol = nullptr;
488
490 so_addr.GetFileAddress(),
491 [&matching_symbol](Symbol *symbol) -> bool {
492 if (symbol->GetType() != eSymbolTypeInvalid) {
493 matching_symbol = symbol;
494 return false; // Stop iterating
495 }
496 return true; // Keep iterating
497 });
498 sc.symbol = matching_symbol;
499 if (!sc.symbol && resolve_scope & eSymbolContextFunction &&
500 !(resolved_flags & eSymbolContextFunction)) {
501 bool verify_unique = false; // No need to check again since
502 // ResolveSymbolContext failed to find a
503 // symbol at this address.
504 if (ObjectFile *obj_file = sc.module_sp->GetObjectFile())
505 sc.symbol =
506 obj_file->ResolveSymbolForAddress(so_addr, verify_unique);
507 }
508
509 if (sc.symbol) {
510 if (sc.symbol->IsSynthetic()) {
511 // We have a synthetic symbol so lets check if the object file from
512 // the symbol file in the symbol vendor is different than the
513 // object file for the module, and if so search its symbol table to
514 // see if we can come up with a better symbol. For example dSYM
515 // files on MacOSX have an unstripped symbol table inside of them.
516 ObjectFile *symtab_objfile = symtab->GetObjectFile();
517 if (symtab_objfile && symtab_objfile->IsStripped()) {
518 ObjectFile *symfile_objfile = symfile->GetObjectFile();
519 if (symfile_objfile != symtab_objfile) {
520 Symtab *symfile_symtab = symfile_objfile->GetSymtab();
521 if (symfile_symtab) {
522 Symbol *symbol =
523 symfile_symtab->FindSymbolContainingFileAddress(
524 so_addr.GetFileAddress());
525 if (symbol && !symbol->IsSynthetic()) {
526 sc.symbol = symbol;
527 }
528 }
529 }
530 }
531 }
532 resolved_flags |= eSymbolContextSymbol;
533 }
534 }
535 }
536
537 // For function symbols, so_addr may be off by one. This is a convention
538 // consistent with FDE row indices in eh_frame sections, but requires extra
539 // logic here to permit symbol lookup for disassembly and unwind.
540 if (resolve_scope & eSymbolContextSymbol &&
541 !(resolved_flags & eSymbolContextSymbol) && resolve_tail_call_address &&
542 so_addr.IsSectionOffset()) {
543 Address previous_addr = so_addr;
544 previous_addr.Slide(-1);
545
546 bool do_resolve_tail_call_address = false; // prevent recursion
547 const uint32_t flags = ResolveSymbolContextForAddress(
548 previous_addr, resolve_scope, sc, do_resolve_tail_call_address);
549 if (flags & eSymbolContextSymbol) {
550 AddressRange addr_range;
551 if (sc.GetAddressRange(eSymbolContextFunction | eSymbolContextSymbol, 0,
552 false, addr_range)) {
553 if (addr_range.GetBaseAddress().GetSection() ==
554 so_addr.GetSection()) {
555 // If the requested address is one past the address range of a
556 // function (i.e. a tail call), or the decremented address is the
557 // start of a function (i.e. some forms of trampoline), indicate
558 // that the symbol has been resolved.
559 if (so_addr.GetOffset() ==
560 addr_range.GetBaseAddress().GetOffset() ||
561 so_addr.GetOffset() == addr_range.GetBaseAddress().GetOffset() +
562 addr_range.GetByteSize()) {
563 resolved_flags |= flags;
564 }
565 } else {
566 sc.symbol =
567 nullptr; // Don't trust the symbol if the sections didn't match.
568 }
569 }
570 }
571 }
572 }
573 return resolved_flags;
574}
575
577 const char *file_path, uint32_t line, bool check_inlines,
578 lldb::SymbolContextItem resolve_scope, SymbolContextList &sc_list) {
579 FileSpec file_spec(file_path);
580 return ResolveSymbolContextsForFileSpec(file_spec, line, check_inlines,
581 resolve_scope, sc_list);
582}
583
585 const FileSpec &file_spec, uint32_t line, bool check_inlines,
586 lldb::SymbolContextItem resolve_scope, SymbolContextList &sc_list) {
587 std::lock_guard<std::recursive_mutex> guard(m_mutex);
588 LLDB_SCOPED_TIMERF("Module::ResolveSymbolContextForFilePath (%s:%u, "
589 "check_inlines = %s, resolve_scope = 0x%8.8x)",
590 file_spec.GetPath().c_str(), line,
591 check_inlines ? "yes" : "no", resolve_scope);
592
593 const uint32_t initial_count = sc_list.GetSize();
594
595 if (SymbolFile *symbols = GetSymbolFile()) {
596 // TODO: Handle SourceLocationSpec column information
597 SourceLocationSpec location_spec(file_spec, line, /*column=*/std::nullopt,
598 check_inlines, /*exact_match=*/false);
599
600 symbols->ResolveSymbolContext(location_spec, resolve_scope, sc_list);
601 }
602
603 return sc_list.GetSize() - initial_count;
604}
605
607 const CompilerDeclContext &parent_decl_ctx,
608 size_t max_matches, VariableList &variables) {
609 if (SymbolFile *symbols = GetSymbolFile())
610 symbols->FindGlobalVariables(name, parent_decl_ctx, max_matches, variables);
611}
612
614 size_t max_matches, VariableList &variables) {
615 SymbolFile *symbols = GetSymbolFile();
616 if (symbols)
617 symbols->FindGlobalVariables(regex, max_matches, variables);
618}
619
621 SymbolContextList &sc_list) {
622 const size_t num_compile_units = GetNumCompileUnits();
623 SymbolContext sc;
624 sc.module_sp = shared_from_this();
625 for (size_t i = 0; i < num_compile_units; ++i) {
626 sc.comp_unit = GetCompileUnitAtIndex(i).get();
627 if (sc.comp_unit) {
629 sc_list.Append(sc);
630 }
631 }
632}
633
635 FunctionNameType name_type_mask,
636 LanguageType language)
637 : m_name(name), m_lookup_name(), m_language(language) {
638 const char *name_cstr = name.GetCString();
639 llvm::StringRef basename;
640 llvm::StringRef context;
641
642 if (name_type_mask & eFunctionNameTypeAuto) {
644 m_name_type_mask = eFunctionNameTypeFull;
645 else if ((language == eLanguageTypeUnknown ||
646 Language::LanguageIsObjC(language)) &&
648 m_name_type_mask = eFunctionNameTypeFull;
649 else if (Language::LanguageIsC(language)) {
650 m_name_type_mask = eFunctionNameTypeFull;
651 } else {
652 if ((language == eLanguageTypeUnknown ||
653 Language::LanguageIsObjC(language)) &&
655 m_name_type_mask |= eFunctionNameTypeSelector;
656
657 CPlusPlusLanguage::MethodName cpp_method(name);
658 basename = cpp_method.GetBasename();
659 if (basename.empty()) {
661 basename))
662 m_name_type_mask |= (eFunctionNameTypeMethod | eFunctionNameTypeBase);
663 else
664 m_name_type_mask |= eFunctionNameTypeFull;
665 } else {
666 m_name_type_mask |= (eFunctionNameTypeMethod | eFunctionNameTypeBase);
667 }
668 }
669 } else {
670 m_name_type_mask = name_type_mask;
671 if (name_type_mask & eFunctionNameTypeMethod ||
672 name_type_mask & eFunctionNameTypeBase) {
673 // If they've asked for a CPP method or function name and it can't be
674 // that, we don't even need to search for CPP methods or names.
675 CPlusPlusLanguage::MethodName cpp_method(name);
676 if (cpp_method.IsValid()) {
677 basename = cpp_method.GetBasename();
678
679 if (!cpp_method.GetQualifiers().empty()) {
680 // There is a "const" or other qualifier following the end of the
681 // function parens, this can't be a eFunctionNameTypeBase
682 m_name_type_mask &= ~(eFunctionNameTypeBase);
683 if (m_name_type_mask == eFunctionNameTypeNone)
684 return;
685 }
686 } else {
687 // If the CPP method parser didn't manage to chop this up, try to fill
688 // in the base name if we can. If a::b::c is passed in, we need to just
689 // look up "c", and then we'll filter the result later.
691 basename);
692 }
693 }
694
695 if (name_type_mask & eFunctionNameTypeSelector) {
696 if (!ObjCLanguage::IsPossibleObjCSelector(name_cstr)) {
697 m_name_type_mask &= ~(eFunctionNameTypeSelector);
698 if (m_name_type_mask == eFunctionNameTypeNone)
699 return;
700 }
701 }
702
703 // Still try and get a basename in case someone specifies a name type mask
704 // of eFunctionNameTypeFull and a name like "A::func"
705 if (basename.empty()) {
706 if (name_type_mask & eFunctionNameTypeFull &&
708 CPlusPlusLanguage::MethodName cpp_method(name);
709 basename = cpp_method.GetBasename();
710 if (basename.empty())
712 basename);
713 }
714 }
715 }
716
717 if (!basename.empty()) {
718 // The name supplied was a partial C++ path like "a::count". In this case
719 // we want to do a lookup on the basename "count" and then make sure any
720 // matching results contain "a::count" so that it would match "b::a::count"
721 // and "a::count". This is why we set "match_name_after_lookup" to true
722 m_lookup_name.SetString(basename);
723 m_match_name_after_lookup = true;
724 } else {
725 // The name is already correct, just use the exact name as supplied, and we
726 // won't need to check if any matches contain "name"
727 m_lookup_name = name;
728 m_match_name_after_lookup = false;
729 }
730}
731
733 ConstString function_name, LanguageType language_type) const {
734 // We always keep unnamed symbols
735 if (!function_name)
736 return true;
737
738 // If we match exactly, we can return early
739 if (m_name == function_name)
740 return true;
741
742 // If function_name is mangled, we'll need to demangle it.
743 // In the pathologial case where the function name "looks" mangled but is
744 // actually demangled (e.g. a method named _Zonk), this operation should be
745 // relatively inexpensive since no demangling is actually occuring. See
746 // Mangled::SetValue for more context.
747 const bool function_name_may_be_mangled =
749 ConstString demangled_function_name = function_name;
750 if (function_name_may_be_mangled) {
751 Mangled mangled_function_name(function_name);
752 demangled_function_name = mangled_function_name.GetDemangledName();
753 }
754
755 // If the symbol has a language, then let the language make the match.
756 // Otherwise just check that the demangled function name contains the
757 // demangled user-provided name.
758 if (Language *language = Language::FindPlugin(language_type))
759 return language->DemangledNameContainsPath(m_name, demangled_function_name);
760
761 llvm::StringRef function_name_ref = demangled_function_name;
762 return function_name_ref.contains(m_name);
763}
764
766 size_t start_idx) const {
767 if (m_match_name_after_lookup && m_name) {
768 SymbolContext sc;
769 size_t i = start_idx;
770 while (i < sc_list.GetSize()) {
771 if (!sc_list.GetContextAtIndex(i, sc))
772 break;
773
774 bool keep_it =
775 NameMatchesLookupInfo(sc.GetFunctionName(), sc.GetLanguage());
776 if (keep_it)
777 ++i;
778 else
779 sc_list.RemoveContextAtIndex(i);
780 }
781 }
782
783 // If we have only full name matches we might have tried to set breakpoint on
784 // "func" and specified eFunctionNameTypeFull, but we might have found
785 // "a::func()", "a::b::func()", "c::func()", "func()" and "func". Only
786 // "func()" and "func" should end up matching.
787 if (m_name_type_mask == eFunctionNameTypeFull) {
788 SymbolContext sc;
789 size_t i = start_idx;
790 while (i < sc_list.GetSize()) {
791 if (!sc_list.GetContextAtIndex(i, sc))
792 break;
793 // Make sure the mangled and demangled names don't match before we try to
794 // pull anything out
796 ConstString full_name(sc.GetFunctionName());
797 if (mangled_name != m_name && full_name != m_name) {
798 CPlusPlusLanguage::MethodName cpp_method(full_name);
799 if (cpp_method.IsValid()) {
800 if (cpp_method.GetContext().empty()) {
801 if (cpp_method.GetBasename().compare(m_name) != 0) {
802 sc_list.RemoveContextAtIndex(i);
803 continue;
804 }
805 } else {
806 std::string qualified_name;
807 llvm::StringRef anon_prefix("(anonymous namespace)");
808 if (cpp_method.GetContext() == anon_prefix)
809 qualified_name = cpp_method.GetBasename().str();
810 else
811 qualified_name = cpp_method.GetScopeQualifiedName();
812 if (qualified_name != m_name.GetCString()) {
813 sc_list.RemoveContextAtIndex(i);
814 continue;
815 }
816 }
817 }
818 }
819 ++i;
820 }
821 }
822}
823
825 const CompilerDeclContext &parent_decl_ctx,
826 const ModuleFunctionSearchOptions &options,
827 SymbolContextList &sc_list) {
828 // Find all the functions (not symbols, but debug information functions...
829 if (SymbolFile *symbols = GetSymbolFile()) {
830 symbols->FindFunctions(lookup_info, parent_decl_ctx,
831 options.include_inlines, sc_list);
832 // Now check our symbol table for symbols that are code symbols if
833 // requested
834 if (options.include_symbols) {
835 if (Symtab *symtab = symbols->GetSymtab()) {
836 symtab->FindFunctionSymbols(lookup_info.GetLookupName(),
837 lookup_info.GetNameTypeMask(), sc_list);
838 }
839 }
840 }
841}
842
844 const CompilerDeclContext &parent_decl_ctx,
845 FunctionNameType name_type_mask,
846 const ModuleFunctionSearchOptions &options,
847 SymbolContextList &sc_list) {
848 const size_t old_size = sc_list.GetSize();
849 LookupInfo lookup_info(name, name_type_mask, eLanguageTypeUnknown);
850 FindFunctions(lookup_info, parent_decl_ctx, options, sc_list);
851 if (name_type_mask & eFunctionNameTypeAuto) {
852 const size_t new_size = sc_list.GetSize();
853 if (old_size < new_size)
854 lookup_info.Prune(sc_list, old_size);
855 }
856}
857
858void Module::FindFunctions(llvm::ArrayRef<CompilerContext> compiler_ctx,
859 FunctionNameType name_type_mask,
860 const ModuleFunctionSearchOptions &options,
861 SymbolContextList &sc_list) {
862 if (compiler_ctx.empty() ||
863 compiler_ctx.back().kind != CompilerContextKind::Function)
864 return;
865 ConstString name = compiler_ctx.back().name;
866 SymbolContextList unfiltered;
867 FindFunctions(name, CompilerDeclContext(), name_type_mask, options,
868 unfiltered);
869 // Filter by context.
870 for (auto &sc : unfiltered)
871 if (sc.function && compiler_ctx.equals(sc.function->GetCompilerContext()))
872 sc_list.Append(sc);
873}
874
876 const ModuleFunctionSearchOptions &options,
877 SymbolContextList &sc_list) {
878 const size_t start_size = sc_list.GetSize();
879
880 if (SymbolFile *symbols = GetSymbolFile()) {
881 symbols->FindFunctions(regex, options.include_inlines, sc_list);
882
883 // Now check our symbol table for symbols that are code symbols if
884 // requested
885 if (options.include_symbols) {
886 Symtab *symtab = symbols->GetSymtab();
887 if (symtab) {
888 std::vector<uint32_t> symbol_indexes;
891 symbol_indexes);
892 const size_t num_matches = symbol_indexes.size();
893 if (num_matches) {
894 SymbolContext sc(this);
895 const size_t end_functions_added_index = sc_list.GetSize();
896 size_t num_functions_added_to_sc_list =
897 end_functions_added_index - start_size;
898 if (num_functions_added_to_sc_list == 0) {
899 // No functions were added, just symbols, so we can just append
900 // them
901 for (size_t i = 0; i < num_matches; ++i) {
902 sc.symbol = symtab->SymbolAtIndex(symbol_indexes[i]);
903 SymbolType sym_type = sc.symbol->GetType();
904 if (sc.symbol && (sym_type == eSymbolTypeCode ||
905 sym_type == eSymbolTypeResolver))
906 sc_list.Append(sc);
907 }
908 } else {
909 typedef std::map<lldb::addr_t, uint32_t> FileAddrToIndexMap;
910 FileAddrToIndexMap file_addr_to_index;
911 for (size_t i = start_size; i < end_functions_added_index; ++i) {
912 const SymbolContext &sc = sc_list[i];
913 if (sc.block)
914 continue;
915 file_addr_to_index[sc.function->GetAddressRange()
917 .GetFileAddress()] = i;
918 }
919
920 FileAddrToIndexMap::const_iterator end = file_addr_to_index.end();
921 // Functions were added so we need to merge symbols into any
922 // existing function symbol contexts
923 for (size_t i = start_size; i < num_matches; ++i) {
924 sc.symbol = symtab->SymbolAtIndex(symbol_indexes[i]);
925 SymbolType sym_type = sc.symbol->GetType();
926 if (sc.symbol && sc.symbol->ValueIsAddress() &&
927 (sym_type == eSymbolTypeCode ||
928 sym_type == eSymbolTypeResolver)) {
929 FileAddrToIndexMap::const_iterator pos =
930 file_addr_to_index.find(
932 if (pos == end)
933 sc_list.Append(sc);
934 else
935 sc_list[pos->second].symbol = sc.symbol;
936 }
937 }
938 }
939 }
940 }
941 }
942 }
943}
944
946 const FileSpec &file, uint32_t line,
947 Function *function,
948 std::vector<Address> &output_local,
949 std::vector<Address> &output_extern) {
950 SearchFilterByModule filter(target_sp, m_file);
951
952 // TODO: Handle SourceLocationSpec column information
953 SourceLocationSpec location_spec(file, line, /*column=*/std::nullopt,
954 /*check_inlines=*/true,
955 /*exact_match=*/false);
956 AddressResolverFileLine resolver(location_spec);
957 resolver.ResolveAddress(filter);
958
959 for (size_t n = 0; n < resolver.GetNumberOfAddresses(); n++) {
960 Address addr = resolver.GetAddressRangeAtIndex(n).GetBaseAddress();
962 if (f && f == function)
963 output_local.push_back(addr);
964 else
965 output_extern.push_back(addr);
966 }
967}
968
969void Module::FindTypes(const TypeQuery &query, TypeResults &results) {
970 if (SymbolFile *symbols = GetSymbolFile())
971 symbols->FindTypes(query, results);
972}
973
976 Debugger::DebuggerList requestors =
978 Debugger::DebuggerList interruptors;
979 if (requestors.empty())
980 return interruptors;
981
982 for (auto debugger_sp : requestors) {
983 if (!debugger_sp->InterruptRequested())
984 continue;
985 if (debugger_sp->GetTargetList()
986 .AnyTargetContainsModule(module))
987 interruptors.push_back(debugger_sp);
988 }
989 return interruptors;
990}
991
992SymbolFile *Module::GetSymbolFile(bool can_create, Stream *feedback_strm) {
993 if (!m_did_load_symfile.load()) {
994 std::lock_guard<std::recursive_mutex> guard(m_mutex);
995 if (!m_did_load_symfile.load() && can_create) {
996 Debugger::DebuggerList interruptors =
998 if (!interruptors.empty()) {
999 for (auto debugger_sp : interruptors) {
1000 REPORT_INTERRUPTION(*(debugger_sp.get()),
1001 "Interrupted fetching symbols for module {0}",
1002 this->GetFileSpec());
1003 }
1004 return nullptr;
1005 }
1006 ObjectFile *obj_file = GetObjectFile();
1007 if (obj_file != nullptr) {
1009 m_symfile_up.reset(
1010 SymbolVendor::FindPlugin(shared_from_this(), feedback_strm));
1011 m_did_load_symfile = true;
1012 if (m_unwind_table)
1013 m_unwind_table->Update();
1014 }
1015 }
1016 }
1017 return m_symfile_up ? m_symfile_up->GetSymbolFile() : nullptr;
1018}
1019
1021 if (SymbolFile *symbols = GetSymbolFile())
1022 return symbols->GetSymtab();
1023 return nullptr;
1024}
1025
1027 ConstString object_name) {
1028 // Container objects whose paths do not specify a file directly can call this
1029 // function to correct the file and object names.
1030 m_file = file;
1032 m_object_name = object_name;
1033}
1034
1035const ArchSpec &Module::GetArchitecture() const { return m_arch; }
1036
1038 std::string spec(GetFileSpec().GetPath());
1039 if (m_object_name) {
1040 spec += '(';
1041 spec += m_object_name.GetCString();
1042 spec += ')';
1043 }
1044 return spec;
1045}
1046
1047void Module::GetDescription(llvm::raw_ostream &s,
1048 lldb::DescriptionLevel level) {
1049 if (level >= eDescriptionLevelFull) {
1050 if (m_arch.IsValid())
1051 s << llvm::formatv("({0}) ", m_arch.GetArchitectureName());
1052 }
1053
1054 if (level == eDescriptionLevelBrief) {
1055 const char *filename = m_file.GetFilename().GetCString();
1056 if (filename)
1057 s << filename;
1058 } else {
1059 char path[PATH_MAX];
1060 if (m_file.GetPath(path, sizeof(path)))
1061 s << path;
1062 }
1063
1064 const char *object_name = m_object_name.GetCString();
1065 if (object_name)
1066 s << llvm::formatv("({0})", object_name);
1067}
1068
1070 // We have provided the DataBuffer for this module to avoid accessing the
1071 // filesystem. We never want to reload those files.
1072 if (m_data_sp)
1073 return false;
1074 if (!m_file_has_changed)
1077 return m_file_has_changed;
1078}
1079
1081 std::optional<lldb::user_id_t> debugger_id) {
1082 ConstString file_name = GetFileSpec().GetFilename();
1083 if (file_name.IsEmpty())
1084 return;
1085
1086 StreamString ss;
1087 ss << file_name
1088 << " was compiled with optimization - stepping may behave "
1089 "oddly; variables may not be available.";
1090 Debugger::ReportWarning(std::string(ss.GetString()), debugger_id,
1092}
1093
1095 LanguageType language, std::optional<lldb::user_id_t> debugger_id) {
1096 StreamString ss;
1097 ss << "This version of LLDB has no plugin for the language \""
1099 << "\". "
1100 "Inspection of frame variables will be limited.";
1101 Debugger::ReportWarning(std::string(ss.GetString()), debugger_id,
1103}
1104
1106 const llvm::formatv_object_base &payload) {
1108 if (FileHasChanged()) {
1110 StreamString strm;
1111 strm.PutCString("the object file ");
1113 strm.PutCString(" has been modified\n");
1114 strm.PutCString(payload.str());
1115 strm.PutCString("The debug session should be aborted as the original "
1116 "debug information has been overwritten.");
1117 Debugger::ReportError(std::string(strm.GetString()));
1118 }
1119 }
1120}
1121
1122void Module::ReportError(const llvm::formatv_object_base &payload) {
1123 StreamString strm;
1125 strm.PutChar(' ');
1126 strm.PutCString(payload.str());
1127 Debugger::ReportError(strm.GetString().str());
1128}
1129
1130void Module::ReportWarning(const llvm::formatv_object_base &payload) {
1131 StreamString strm;
1133 strm.PutChar(' ');
1134 strm.PutCString(payload.str());
1135 Debugger::ReportWarning(std::string(strm.GetString()));
1136}
1137
1138void Module::LogMessage(Log *log, const llvm::formatv_object_base &payload) {
1139 StreamString log_message;
1141 log_message.PutCString(": ");
1142 log_message.PutCString(payload.str());
1143 log->PutCString(log_message.GetData());
1144}
1145
1147 Log *log, const llvm::formatv_object_base &payload) {
1148 StreamString log_message;
1150 log_message.PutCString(": ");
1151 log_message.PutCString(payload.str());
1152 if (log->GetVerbose()) {
1153 std::string back_trace;
1154 llvm::raw_string_ostream stream(back_trace);
1155 llvm::sys::PrintStackTrace(stream);
1156 log_message.PutCString(back_trace);
1157 }
1158 log->PutCString(log_message.GetData());
1159}
1160
1162 std::lock_guard<std::recursive_mutex> guard(m_mutex);
1163 // s->Printf("%.*p: ", (int)sizeof(void*) * 2, this);
1164 s->Indent();
1165 s->Printf("Module %s%s%s%s\n", m_file.GetPath().c_str(),
1166 m_object_name ? "(" : "",
1168 m_object_name ? ")" : "");
1169
1170 s->IndentMore();
1171
1172 ObjectFile *objfile = GetObjectFile();
1173 if (objfile)
1174 objfile->Dump(s);
1175
1176 if (SymbolFile *symbols = GetSymbolFile())
1177 symbols->Dump(*s);
1178
1179 s->IndentLess();
1180}
1181
1183
1185 if (!m_did_load_objfile.load()) {
1186 std::lock_guard<std::recursive_mutex> guard(m_mutex);
1187 if (!m_did_load_objfile.load()) {
1188 LLDB_SCOPED_TIMERF("Module::GetObjectFile () module = %s",
1189 GetFileSpec().GetFilename().AsCString(""));
1190 lldb::offset_t data_offset = 0;
1191 lldb::offset_t file_size = 0;
1192
1193 if (m_data_sp)
1194 file_size = m_data_sp->GetByteSize();
1195 else if (m_file)
1197
1198 if (file_size > m_object_offset) {
1199 m_did_load_objfile = true;
1200 // FindPlugin will modify its data_sp argument. Do not let it
1201 // modify our m_data_sp member.
1202 auto data_sp = m_data_sp;
1204 shared_from_this(), &m_file, m_object_offset,
1205 file_size - m_object_offset, data_sp, data_offset);
1206 if (m_objfile_sp) {
1207 // Once we get the object file, update our module with the object
1208 // file's architecture since it might differ in vendor/os if some
1209 // parts were unknown. But since the matching arch might already be
1210 // more specific than the generic COFF architecture, only merge in
1211 // those values that overwrite unspecified unknown values.
1212 m_arch.MergeFrom(m_objfile_sp->GetArchitecture());
1213 } else {
1214 ReportError("failed to load objfile for {0}\nDebugging will be "
1215 "degraded for this module.",
1216 GetFileSpec().GetPath().c_str());
1217 }
1218 }
1219 }
1220 }
1221 return m_objfile_sp.get();
1222}
1223
1225 // Populate m_sections_up with sections from objfile.
1226 if (!m_sections_up) {
1227 ObjectFile *obj_file = GetObjectFile();
1228 if (obj_file != nullptr)
1230 }
1231 return m_sections_up.get();
1232}
1233
1235 ObjectFile *obj_file = GetObjectFile();
1236 if (obj_file)
1237 obj_file->SectionFileAddressesChanged();
1238 if (SymbolFile *symbols = GetSymbolFile())
1239 symbols->SectionFileAddressesChanged();
1240}
1241
1243 if (!m_unwind_table) {
1244 if (!m_symfile_spec)
1246 m_unwind_table.emplace(*this);
1247 }
1248 return *m_unwind_table;
1249}
1250
1252 if (!m_sections_up)
1253 m_sections_up = std::make_unique<SectionList>();
1254 return m_sections_up.get();
1255}
1256
1258 SymbolType symbol_type) {
1260 "Module::FindFirstSymbolWithNameAndType (name = %s, type = %i)",
1261 name.AsCString(), symbol_type);
1262 if (Symtab *symtab = GetSymtab())
1263 return symtab->FindFirstSymbolWithNameAndType(
1264 name, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny);
1265 return nullptr;
1266}
1268 Symtab *symtab, std::vector<uint32_t> &symbol_indexes,
1269 SymbolContextList &sc_list) {
1270 // No need to protect this call using m_mutex all other method calls are
1271 // already thread safe.
1272
1273 size_t num_indices = symbol_indexes.size();
1274 if (num_indices > 0) {
1275 SymbolContext sc;
1277 for (size_t i = 0; i < num_indices; i++) {
1278 sc.symbol = symtab->SymbolAtIndex(symbol_indexes[i]);
1279 if (sc.symbol)
1280 sc_list.Append(sc);
1281 }
1282 }
1283}
1284
1285void Module::FindFunctionSymbols(ConstString name, uint32_t name_type_mask,
1286 SymbolContextList &sc_list) {
1287 LLDB_SCOPED_TIMERF("Module::FindSymbolsFunctions (name = %s, mask = 0x%8.8x)",
1288 name.AsCString(), name_type_mask);
1289 if (Symtab *symtab = GetSymtab())
1290 symtab->FindFunctionSymbols(name, name_type_mask, sc_list);
1291}
1292
1294 SymbolType symbol_type,
1295 SymbolContextList &sc_list) {
1296 // No need to protect this call using m_mutex all other method calls are
1297 // already thread safe.
1298 if (Symtab *symtab = GetSymtab()) {
1299 std::vector<uint32_t> symbol_indexes;
1300 symtab->FindAllSymbolsWithNameAndType(name, symbol_type, symbol_indexes);
1301 SymbolIndicesToSymbolContextList(symtab, symbol_indexes, sc_list);
1302 }
1303}
1304
1306 const RegularExpression &regex, SymbolType symbol_type,
1307 SymbolContextList &sc_list, Mangled::NamePreference mangling_preference) {
1308 // No need to protect this call using m_mutex all other method calls are
1309 // already thread safe.
1311 "Module::FindSymbolsMatchingRegExAndType (regex = %s, type = %i)",
1312 regex.GetText().str().c_str(), symbol_type);
1313 if (Symtab *symtab = GetSymtab()) {
1314 std::vector<uint32_t> symbol_indexes;
1315 symtab->FindAllSymbolsMatchingRexExAndType(
1316 regex, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny,
1317 symbol_indexes, mangling_preference);
1318 SymbolIndicesToSymbolContextList(symtab, symbol_indexes, sc_list);
1319 }
1320}
1321
1323 std::lock_guard<std::recursive_mutex> guard(m_mutex);
1324 SymbolFile *sym_file = GetSymbolFile();
1325 if (!sym_file)
1326 return;
1327
1328 // Load the object file symbol table and any symbols from the SymbolFile that
1329 // get appended using SymbolFile::AddSymbols(...).
1330 if (Symtab *symtab = sym_file->GetSymtab())
1331 symtab->PreloadSymbols();
1332
1333 // Now let the symbol file preload its data and the symbol table will be
1334 // available without needing to take the module lock.
1335 sym_file->PreloadSymbols();
1336}
1337
1339 if (!FileSystem::Instance().Exists(file))
1340 return;
1341 if (m_symfile_up) {
1342 // Remove any sections in the unified section list that come from the
1343 // current symbol vendor.
1344 SectionList *section_list = GetSectionList();
1345 SymbolFile *symbol_file = GetSymbolFile();
1346 if (section_list && symbol_file) {
1347 ObjectFile *obj_file = symbol_file->GetObjectFile();
1348 // Make sure we have an object file and that the symbol vendor's objfile
1349 // isn't the same as the module's objfile before we remove any sections
1350 // for it...
1351 if (obj_file) {
1352 // Check to make sure we aren't trying to specify the file we already
1353 // have
1354 if (obj_file->GetFileSpec() == file) {
1355 // We are being told to add the exact same file that we already have
1356 // we don't have to do anything.
1357 return;
1358 }
1359
1360 // Cleare the current symtab as we are going to replace it with a new
1361 // one
1362 obj_file->ClearSymtab();
1363
1364 // The symbol file might be a directory bundle ("/tmp/a.out.dSYM")
1365 // instead of a full path to the symbol file within the bundle
1366 // ("/tmp/a.out.dSYM/Contents/Resources/DWARF/a.out"). So we need to
1367 // check this
1368 if (FileSystem::Instance().IsDirectory(file)) {
1369 std::string new_path(file.GetPath());
1370 std::string old_path(obj_file->GetFileSpec().GetPath());
1371 if (llvm::StringRef(old_path).starts_with(new_path)) {
1372 // We specified the same bundle as the symbol file that we already
1373 // have
1374 return;
1375 }
1376 }
1377
1378 if (obj_file != m_objfile_sp.get()) {
1379 size_t num_sections = section_list->GetNumSections(0);
1380 for (size_t idx = num_sections; idx > 0; --idx) {
1381 lldb::SectionSP section_sp(
1382 section_list->GetSectionAtIndex(idx - 1));
1383 if (section_sp->GetObjectFile() == obj_file) {
1384 section_list->DeleteSection(idx - 1);
1385 }
1386 }
1387 }
1388 }
1389 }
1390 // Keep all old symbol files around in case there are any lingering type
1391 // references in any SBValue objects that might have been handed out.
1392 m_old_symfiles.push_back(std::move(m_symfile_up));
1393 }
1394 m_symfile_spec = file;
1395 m_symfile_up.reset();
1396 m_did_load_symfile = false;
1397}
1398
1400 if (GetObjectFile() == nullptr)
1401 return false;
1402 else
1403 return GetObjectFile()->IsExecutable();
1404}
1405
1407 ObjectFile *obj_file = GetObjectFile();
1408 if (obj_file) {
1409 SectionList *sections = GetSectionList();
1410 if (sections != nullptr) {
1411 size_t num_sections = sections->GetSize();
1412 for (size_t sect_idx = 0; sect_idx < num_sections; sect_idx++) {
1413 SectionSP section_sp = sections->GetSectionAtIndex(sect_idx);
1414 if (section_sp->GetLoadBaseAddress(target) != LLDB_INVALID_ADDRESS) {
1415 return true;
1416 }
1417 }
1418 }
1419 }
1420 return false;
1421}
1422
1424 Stream &feedback_stream) {
1425 if (!target) {
1426 error.SetErrorString("invalid destination Target");
1427 return false;
1428 }
1429
1430 LoadScriptFromSymFile should_load =
1431 target->TargetProperties::GetLoadScriptFromSymbolFile();
1432
1433 if (should_load == eLoadScriptFromSymFileFalse)
1434 return false;
1435
1436 Debugger &debugger = target->GetDebugger();
1437 const ScriptLanguage script_language = debugger.GetScriptLanguage();
1438 if (script_language != eScriptLanguageNone) {
1439
1440 PlatformSP platform_sp(target->GetPlatform());
1441
1442 if (!platform_sp) {
1443 error.SetErrorString("invalid Platform");
1444 return false;
1445 }
1446
1447 FileSpecList file_specs = platform_sp->LocateExecutableScriptingResources(
1448 target, *this, feedback_stream);
1449
1450 const uint32_t num_specs = file_specs.GetSize();
1451 if (num_specs) {
1452 ScriptInterpreter *script_interpreter = debugger.GetScriptInterpreter();
1453 if (script_interpreter) {
1454 for (uint32_t i = 0; i < num_specs; ++i) {
1455 FileSpec scripting_fspec(file_specs.GetFileSpecAtIndex(i));
1456 if (scripting_fspec &&
1457 FileSystem::Instance().Exists(scripting_fspec)) {
1458 if (should_load == eLoadScriptFromSymFileWarn) {
1459 feedback_stream.Printf(
1460 "warning: '%s' contains a debug script. To run this script "
1461 "in "
1462 "this debug session:\n\n command script import "
1463 "\"%s\"\n\n"
1464 "To run all discovered debug scripts in this session:\n\n"
1465 " settings set target.load-script-from-symbol-file "
1466 "true\n",
1467 GetFileSpec().GetFileNameStrippingExtension().GetCString(),
1468 scripting_fspec.GetPath().c_str());
1469 return false;
1470 }
1471 StreamString scripting_stream;
1472 scripting_fspec.Dump(scripting_stream.AsRawOstream());
1473 LoadScriptOptions options;
1474 bool did_load = script_interpreter->LoadScriptingModule(
1475 scripting_stream.GetData(), options, error);
1476 if (!did_load)
1477 return false;
1478 }
1479 }
1480 } else {
1481 error.SetErrorString("invalid ScriptInterpreter");
1482 return false;
1483 }
1484 }
1485 }
1486 return true;
1487}
1488
1489bool Module::SetArchitecture(const ArchSpec &new_arch) {
1490 if (!m_arch.IsValid()) {
1491 m_arch = new_arch;
1492 return true;
1493 }
1494 return m_arch.IsCompatibleMatch(new_arch);
1495}
1496
1498 bool value_is_offset, bool &changed) {
1499 ObjectFile *object_file = GetObjectFile();
1500 if (object_file != nullptr) {
1501 changed = object_file->SetLoadAddress(target, value, value_is_offset);
1502 return true;
1503 } else {
1504 changed = false;
1505 }
1506 return false;
1507}
1508
1509bool Module::MatchesModuleSpec(const ModuleSpec &module_ref) {
1510 const UUID &uuid = module_ref.GetUUID();
1511
1512 if (uuid.IsValid()) {
1513 // If the UUID matches, then nothing more needs to match...
1514 return (uuid == GetUUID());
1515 }
1516
1517 const FileSpec &file_spec = module_ref.GetFileSpec();
1518 if (!FileSpec::Match(file_spec, m_file) &&
1519 !FileSpec::Match(file_spec, m_platform_file))
1520 return false;
1521
1522 const FileSpec &platform_file_spec = module_ref.GetPlatformFileSpec();
1523 if (!FileSpec::Match(platform_file_spec, GetPlatformFileSpec()))
1524 return false;
1525
1526 const ArchSpec &arch = module_ref.GetArchitecture();
1527 if (arch.IsValid()) {
1528 if (!m_arch.IsCompatibleMatch(arch))
1529 return false;
1530 }
1531
1532 ConstString object_name = module_ref.GetObjectName();
1533 if (object_name) {
1534 if (object_name != GetObjectName())
1535 return false;
1536 }
1537 return true;
1538}
1539
1540bool Module::FindSourceFile(const FileSpec &orig_spec,
1541 FileSpec &new_spec) const {
1542 std::lock_guard<std::recursive_mutex> guard(m_mutex);
1543 if (auto remapped = m_source_mappings.FindFile(orig_spec)) {
1544 new_spec = *remapped;
1545 return true;
1546 }
1547 return false;
1548}
1549
1550std::optional<std::string> Module::RemapSourceFile(llvm::StringRef path) const {
1551 std::lock_guard<std::recursive_mutex> guard(m_mutex);
1552 if (auto remapped = m_source_mappings.RemapPath(path))
1553 return remapped->GetPath();
1554 return {};
1555}
1556
1557void Module::RegisterXcodeSDK(llvm::StringRef sdk_name,
1558 llvm::StringRef sysroot) {
1559 auto sdk_path_or_err =
1560 HostInfo::GetSDKRoot(HostInfo::SDKOptions{sdk_name.str()});
1561
1562 if (!sdk_path_or_err) {
1563 Debugger::ReportError("Error while searching for Xcode SDK: " +
1564 toString(sdk_path_or_err.takeError()));
1565 return;
1566 }
1567
1568 auto sdk_path = *sdk_path_or_err;
1569 if (sdk_path.empty())
1570 return;
1571 // If the SDK changed for a previously registered source path, update it.
1572 // This could happend with -fdebug-prefix-map, otherwise it's unlikely.
1573 if (!m_source_mappings.Replace(sysroot, sdk_path, true))
1574 // In the general case, however, append it to the list.
1575 m_source_mappings.Append(sysroot, sdk_path, false);
1576}
1577
1578bool Module::MergeArchitecture(const ArchSpec &arch_spec) {
1579 if (!arch_spec.IsValid())
1580 return false;
1582 "module has arch %s, merging/replacing with arch %s",
1583 m_arch.GetTriple().getTriple().c_str(),
1584 arch_spec.GetTriple().getTriple().c_str());
1585 if (!m_arch.IsCompatibleMatch(arch_spec)) {
1586 // The new architecture is different, we just need to replace it.
1587 return SetArchitecture(arch_spec);
1588 }
1589
1590 // Merge bits from arch_spec into "merged_arch" and set our architecture.
1591 ArchSpec merged_arch(m_arch);
1592 merged_arch.MergeFrom(arch_spec);
1593 // SetArchitecture() is a no-op if m_arch is already valid.
1594 m_arch = ArchSpec();
1595 return SetArchitecture(merged_arch);
1596}
1597
1598llvm::VersionTuple Module::GetVersion() {
1599 if (ObjectFile *obj_file = GetObjectFile())
1600 return obj_file->GetVersion();
1601 return llvm::VersionTuple();
1602}
1603
1605 ObjectFile *obj_file = GetObjectFile();
1606
1607 if (obj_file)
1608 return obj_file->GetIsDynamicLinkEditor();
1609
1610 return false;
1611}
1612
1613uint32_t Module::Hash() {
1614 std::string identifier;
1615 llvm::raw_string_ostream id_strm(identifier);
1616 id_strm << m_arch.GetTriple().str() << '-' << m_file.GetPath();
1617 if (m_object_name)
1618 id_strm << '(' << m_object_name << ')';
1619 if (m_object_offset > 0)
1620 id_strm << m_object_offset;
1621 const auto mtime = llvm::sys::toTimeT(m_object_mod_time);
1622 if (mtime > 0)
1623 id_strm << mtime;
1624 return llvm::djbHash(id_strm.str());
1625}
1626
1627std::string Module::GetCacheKey() {
1628 std::string key;
1629 llvm::raw_string_ostream strm(key);
1630 strm << m_arch.GetTriple().str() << '-' << m_file.GetFilename();
1631 if (m_object_name)
1632 strm << '(' << m_object_name << ')';
1633 strm << '-' << llvm::format_hex(Hash(), 10);
1634 return strm.str();
1635}
1636
1638 if (!ModuleList::GetGlobalModuleListProperties().GetEnableLLDBIndexCache())
1639 return nullptr;
1640 // NOTE: intentional leak so we don't crash if global destructor chain gets
1641 // called as other threads still use the result of this function
1642 static DataFileCache *g_data_file_cache =
1644 .GetLLDBIndexCachePath()
1645 .GetPath());
1646 return g_data_file_cache;
1647}
static llvm::raw_ostream & error(Stream &strm)
#define REPORT_INTERRUPTION(debugger,...)
Definition: Debugger.h:477
#define lldbassert(x)
Definition: LLDBAssert.h:15
#define LLDB_LOGF(log,...)
Definition: Log.h:366
std::vector< Module * > ModuleCollection
Definition: Module.cpp:90
static ModuleCollection & GetModuleCollection()
Definition: Module.cpp:92
static Debugger::DebuggerList DebuggersOwningModuleRequestingInterruption(Module &module)
Definition: Module.cpp:975
#define LLDB_SCOPED_TIMER()
Definition: Timer.h:83
#define LLDB_SCOPED_TIMERF(...)
Definition: Timer.h:86
A section + offset based address range class.
Definition: AddressRange.h:25
Address & GetBaseAddress()
Get accessor for the base address of the range.
Definition: AddressRange.h:211
lldb::addr_t GetByteSize() const
Get accessor for the byte size of this range.
Definition: AddressRange.h:223
"lldb/Core/AddressResolverFileLine.h" This class finds address for source file and line.
virtual void ResolveAddress(SearchFilter &filter)
AddressRange & GetAddressRangeAtIndex(size_t idx)
A section + offset based address class.
Definition: Address.h:62
bool ResolveAddressUsingFileSections(lldb::addr_t addr, const SectionList *sections)
Resolve a file virtual address using a section list.
Definition: Address.cpp:250
lldb::SectionSP GetSection() const
Get const accessor for the section.
Definition: Address.h:439
Function * CalculateSymbolContextFunction() const
Definition: Address.cpp:872
bool Slide(int64_t offset)
Definition: Address.h:459
lldb::addr_t GetFileAddress() const
Get the file address.
Definition: Address.cpp:293
lldb::addr_t GetOffset() const
Get the section relative offset value.
Definition: Address.h:329
bool IsSectionOffset() const
Check if an address is section offset.
Definition: Address.h:342
An architecture specification class.
Definition: ArchSpec.h:31
bool IsValid() const
Tests if this ArchSpec is valid.
Definition: ArchSpec.h:348
llvm::Triple & GetTriple()
Architecture triple accessor.
Definition: ArchSpec.h:450
void MergeFrom(const ArchSpec &other)
Merges fields from another ArchSpec into this ArchSpec.
Definition: ArchSpec.cpp:809
bool IsCompatibleMatch(const ArchSpec &rhs) const
Shorthand for IsMatch(rhs, CompatibleMatch).
Definition: ArchSpec.h:502
const char * GetArchitectureName() const
Returns a static string representing the current architecture.
Definition: ArchSpec.cpp:552
static bool IsCPPMangledName(llvm::StringRef name)
static bool ExtractContextAndIdentifier(const char *name, llvm::StringRef &context, llvm::StringRef &identifier)
const FileSpec & GetPrimaryFile() const
Return the primary source spec associated with this compile unit.
Definition: CompileUnit.h:230
void ForeachFunction(llvm::function_ref< bool(const lldb::FunctionSP &)> lambda) const
Apply a lambda to each function in this compile unit.
Definition: CompileUnit.cpp:65
Represents a generic declaration context in a program.
A uniqued constant string class.
Definition: ConstString.h:40
const char * AsCString(const char *value_if_empty=nullptr) const
Get the string value as a C string.
Definition: ConstString.h:188
bool IsEmpty() const
Test for empty string.
Definition: ConstString.h:304
void SetString(llvm::StringRef s)
const char * GetCString() const
Get the string value as a C string.
Definition: ConstString.h:216
This class enables data to be cached into a directory using the llvm caching code.
Definition: DataFileCache.h:45
A class to manage flag bits.
Definition: Debugger.h:80
static void ReportWarning(std::string message, std::optional< lldb::user_id_t > debugger_id=std::nullopt, std::once_flag *once=nullptr)
Report warning events.
Definition: Debugger.cpp:1587
lldb::ScriptLanguage GetScriptLanguage() const
Definition: Debugger.cpp:345
static void ReportError(std::string message, std::optional< lldb::user_id_t > debugger_id=std::nullopt, std::once_flag *once=nullptr)
Report error events.
Definition: Debugger.cpp:1593
ScriptInterpreter * GetScriptInterpreter(bool can_create=true, std::optional< lldb::ScriptLanguage > language={})
Definition: Debugger.cpp:1684
std::vector< lldb::DebuggerSP > DebuggerList
Definition: Debugger.h:82
static DebuggerList DebuggersRequestingInterruption()
Definition: Debugger.cpp:1335
A file collection class.
Definition: FileSpecList.h:85
const FileSpec & GetFileSpecAtIndex(size_t idx) const
Get file at index.
size_t GetSize() const
Get the number of files in the file list.
A file utility class.
Definition: FileSpec.h:56
static bool Match(const FileSpec &pattern, const FileSpec &file)
Match FileSpec pattern against FileSpec file.
Definition: FileSpec.cpp:301
const ConstString & GetFilename() const
Filename string const get accessor.
Definition: FileSpec.h:240
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
Definition: FileSpec.cpp:367
void Dump(llvm::raw_ostream &s) const
Dump this object to a Stream.
Definition: FileSpec.cpp:325
uint64_t GetByteSize(const FileSpec &file_spec) const
Returns the on-disk size of the given file in bytes.
llvm::sys::TimePoint GetModificationTime(const FileSpec &file_spec) const
Returns the modification time of the given file.
static FileSystem & Instance()
A class that describes a function.
Definition: Function.h:399
const AddressRange & GetAddressRange()
Definition: Function.h:447
static Language * FindPlugin(lldb::LanguageType language)
Definition: Language.cpp:84
static const char * GetNameForLanguageType(lldb::LanguageType language)
Definition: Language.cpp:266
static bool LanguageIsC(lldb::LanguageType language)
Definition: Language.cpp:324
static bool LanguageIsObjC(lldb::LanguageType language)
Definition: Language.cpp:314
void PutCString(const char *cstr)
Definition: Log.cpp:135
bool GetVerbose() const
Definition: Log.cpp:314
A class that handles mangled names.
Definition: Mangled.h:33
static Mangled::ManglingScheme GetManglingScheme(llvm::StringRef const name)
Try to identify the mangling scheme used.
Definition: Mangled.cpp:42
ConstString GetDemangledName() const
Demangled name get accessor.
Definition: Mangled.cpp:270
static ModuleListProperties & GetGlobalModuleListProperties()
Definition: ModuleList.cpp:763
bool FindMatchingModuleSpec(const ModuleSpec &module_spec, ModuleSpec &match_module_spec) const
Definition: ModuleSpec.h:333
uint64_t GetObjectOffset() const
Definition: ModuleSpec.h:107
ConstString & GetObjectName()
Definition: ModuleSpec.h:103
FileSpec & GetPlatformFileSpec()
Definition: ModuleSpec.h:65
FileSpec & GetFileSpec()
Definition: ModuleSpec.h:53
lldb::DataBufferSP GetData() const
Definition: ModuleSpec.h:127
ArchSpec & GetArchitecture()
Definition: ModuleSpec.h:89
FileSpec & GetSymbolFileSpec()
Definition: ModuleSpec.h:77
llvm::sys::TimePoint & GetObjectModificationTime()
Definition: ModuleSpec.h:117
A class that encapsulates name lookup information.
Definition: Module.h:904
lldb::FunctionNameType GetNameTypeMask() const
Definition: Module.h:919
ConstString GetLookupName() const
Definition: Module.h:915
bool NameMatchesLookupInfo(ConstString function_name, lldb::LanguageType language_type=lldb::eLanguageTypeUnknown) const
Definition: Module.cpp:732
ConstString m_name
What the user originally typed.
Definition: Module.h:935
void Prune(SymbolContextList &sc_list, size_t start_idx) const
Definition: Module.cpp:765
A class that describes an executable image and its associated object and symbol files.
Definition: Module.h:88
const lldb_private::UUID & GetUUID()
Get a reference to the UUID value contained in this object.
Definition: Module.cpp:340
uint32_t ResolveSymbolContextForFilePath(const char *file_path, uint32_t line, bool check_inlines, lldb::SymbolContextItem resolve_scope, SymbolContextList &sc_list)
Resolve items in the symbol context for a given file and line.
Definition: Module.cpp:576
std::atomic< bool > m_did_set_uuid
Definition: Module.h:1047
void ReportWarningOptimization(std::optional< lldb::user_id_t > debugger_id)
Definition: Module.cpp:1080
std::once_flag m_optimization_warning
Definition: Module.h:1060
PathMappingList m_source_mappings
Module specific source remappings for when you have debug info for a module that doesn't match where ...
Definition: Module.h:1038
llvm::sys::TimePoint m_object_mod_time
Definition: Module.h:1014
virtual ObjectFile * GetObjectFile()
Get the object file representation for the current architecture.
Definition: Module.cpp:1184
void FindGlobalVariables(ConstString name, const CompilerDeclContext &parent_decl_ctx, size_t max_matches, VariableList &variable_list)
Find global and static variables by name.
Definition: Module.cpp:606
void ReportWarning(const char *format, Args &&...args)
Definition: Module.h:795
FileSpec m_file
The file representation on disk for this module (if there is one).
Definition: Module.h:1000
virtual SymbolFile * GetSymbolFile(bool can_create=true, Stream *feedback_strm=nullptr)
Get the module's symbol file.
Definition: Module.cpp:992
static DataFileCache * GetIndexCache()
Get the global index file cache.
Definition: Module.cpp:1637
std::vector< lldb::SymbolVendorUP > m_old_symfiles
If anyone calls Module::SetSymbolFileFileSpec() and changes the symbol file,.
Definition: Module.h:1030
void ReportWarningUnsupportedLanguage(lldb::LanguageType language, std::optional< lldb::user_id_t > debugger_id)
Definition: Module.cpp:1094
void FindCompileUnits(const FileSpec &path, SymbolContextList &sc_list)
Find compile units by partial or full path.
Definition: Module.cpp:620
ConstString GetObjectName() const
Definition: Module.cpp:1182
uint32_t Hash()
Get a unique hash for this module.
Definition: Module.cpp:1613
lldb::ModuleSP CalculateSymbolContextModule() override
Definition: Module.cpp:412
std::once_flag m_language_warning
Definition: Module.h:1061
static Module * GetAllocatedModuleAtIndex(size_t idx)
Definition: Module.cpp:124
UUID m_uuid
Each module is assumed to have a unique identifier to help match it up to debug symbols.
Definition: Module.h:998
std::optional< std::string > RemapSourceFile(llvm::StringRef path) const
Remaps a source file given path into new_path.
Definition: Module.cpp:1550
llvm::sys::TimePoint m_mod_time
The modification time for this module when it was created.
Definition: Module.h:995
lldb::CompUnitSP GetCompileUnitAtIndex(size_t idx)
Definition: Module.cpp:425
uint32_t ResolveSymbolContextForAddress(const Address &so_addr, lldb::SymbolContextItem resolve_scope, SymbolContext &sc, bool resolve_tail_call_address=false)
Resolve the symbol context for the given address.
Definition: Module.cpp:445
void SetFileSpecAndObjectName(const FileSpec &file, ConstString object_name)
Definition: Module.cpp:1026
std::recursive_mutex m_mutex
A mutex to keep this object happy in multi-threaded environments.
Definition: Module.h:991
static std::recursive_mutex & GetAllocationModuleCollectionMutex()
Definition: Module.cpp:106
lldb::DataBufferSP m_data_sp
DataBuffer containing the module image, if it was provided at construction time.
Definition: Module.h:1019
bool SetLoadAddress(Target &target, lldb::addr_t value, bool value_is_offset, bool &changed)
Set the load address for all sections in a module to be the file address plus slide.
Definition: Module.cpp:1497
void SetSymbolFileFileSpec(const FileSpec &file)
Definition: Module.cpp:1338
void RegisterXcodeSDK(llvm::StringRef sdk, llvm::StringRef sysroot)
This callback will be called by SymbolFile implementations when parsing a compile unit that contains ...
Definition: Module.cpp:1557
void FindSymbolsWithNameAndType(ConstString name, lldb::SymbolType symbol_type, SymbolContextList &sc_list)
Definition: Module.cpp:1293
void CalculateSymbolContext(SymbolContext *sc) override
Reconstruct the object's symbol context into sc.
Definition: Module.cpp:408
FileSpec m_symfile_spec
If this path is valid, then this is the file that will be used as the symbol file for this module.
Definition: Module.h:1007
bool ResolveFileAddress(lldb::addr_t vm_addr, Address &so_addr)
Definition: Module.cpp:437
ArchSpec m_arch
The architecture for this module.
Definition: Module.h:997
void ReportError(const char *format, Args &&...args)
Definition: Module.h:800
const FileSpec & GetPlatformFileSpec() const
Get accessor for the module platform file specification.
Definition: Module.h:466
lldb::SymbolVendorUP m_symfile_up
A pointer to the symbol vendor for this module.
Definition: Module.h:1028
const Symbol * FindFirstSymbolWithNameAndType(ConstString name, lldb::SymbolType symbol_type=lldb::eSymbolTypeAny)
Find a symbol in the object file's symbol table.
Definition: Module.cpp:1257
llvm::VersionTuple GetVersion()
Definition: Module.cpp:1598
void FindAddressesForLine(const lldb::TargetSP target_sp, const FileSpec &file, uint32_t line, Function *function, std::vector< Address > &output_local, std::vector< Address > &output_extern)
Find addresses by file/line.
Definition: Module.cpp:945
void FindFunctions(const LookupInfo &lookup_info, const CompilerDeclContext &parent_decl_ctx, const ModuleFunctionSearchOptions &options, SymbolContextList &sc_list)
Find functions by lookup info.
Definition: Module.cpp:824
void DumpSymbolContext(Stream *s) override
Dump the object's symbol context to the stream s.
Definition: Module.cpp:414
void FindFunctionSymbols(ConstString name, uint32_t name_type_mask, SymbolContextList &sc_list)
Find a function symbols in the object file's symbol table.
Definition: Module.cpp:1285
size_t GetNumCompileUnits()
Get the number of compile units for this module.
Definition: Module.cpp:418
ConstString m_object_name
The name an object within this module that is selected, or empty of the module is represented by m_fi...
Definition: Module.h:1010
void LogMessage(Log *log, const char *format, Args &&...args)
Definition: Module.h:783
bool MatchesModuleSpec(const ModuleSpec &module_ref)
Definition: Module.cpp:1509
Symtab * GetSymtab()
Definition: Module.cpp:1020
~Module() override
Destructor.
Definition: Module.cpp:263
static size_t GetNumberAllocatedModules()
Definition: Module.cpp:118
ObjectFile * GetMemoryObjectFile(const lldb::ProcessSP &process_sp, lldb::addr_t header_addr, Status &error, size_t size_to_read=512)
Load an object file from memory.
Definition: Module.cpp:293
bool LoadScriptingResourceInTarget(Target *target, Status &error, Stream &feedback_stream)
Definition: Module.cpp:1423
TypeSystemMap m_type_system_map
A map of any type systems associated with this module.
Definition: Module.h:1034
uint64_t m_object_offset
Definition: Module.h:1013
void ForEachTypeSystem(llvm::function_ref< bool(lldb::TypeSystemSP)> callback)
Call callback for each TypeSystem in this Module.
Definition: Module.cpp:370
lldb::SectionListUP m_sections_up
Unified section list for module that is used by the ObjectFile and ObjectFile instances for the debug...
Definition: Module.h:1041
bool IsExecutable()
Tells whether this module is capable of being the main executable for a process.
Definition: Module.cpp:1399
FileSpec m_platform_file
The path to the module on the platform on which it is being debugged.
Definition: Module.h:1002
bool MergeArchitecture(const ArchSpec &arch_spec)
Update the ArchSpec to a more specific variant.
Definition: Module.cpp:1578
bool FileHasChanged() const
Definition: Module.cpp:1069
const ArchSpec & GetArchitecture() const
Get const accessor for the module architecture.
Definition: Module.cpp:1035
void LogMessageVerboseBacktrace(Log *log, const char *format, Args &&...args)
Definition: Module.h:788
bool GetIsDynamicLinkEditor()
Definition: Module.cpp:1604
std::string GetCacheKey()
Get a unique cache key for the current module.
Definition: Module.cpp:1627
std::optional< UnwindTable > m_unwind_table
Table of FuncUnwinders objects created for this Module's functions.
Definition: Module.h:1024
virtual SectionList * GetSectionList()
Get the unified section list for the module.
Definition: Module.cpp:1224
llvm::Expected< lldb::TypeSystemSP > GetTypeSystemForLanguage(lldb::LanguageType language)
Definition: Module.cpp:366
void Dump(Stream *s)
Dump a description of this object to a Stream.
Definition: Module.cpp:1161
uint32_t ResolveSymbolContextsForFileSpec(const FileSpec &file_spec, uint32_t line, bool check_inlines, lldb::SymbolContextItem resolve_scope, SymbolContextList &sc_list)
Resolve items in the symbol context for a given file and line.
Definition: Module.cpp:584
lldb::ObjectFileSP m_objfile_sp
A shared pointer to the object file parser for this module as it may or may not be shared with the Sy...
Definition: Module.h:1021
void ReportErrorIfModifyDetected(const char *format, Args &&...args)
Definition: Module.h:807
void FindSymbolsMatchingRegExAndType(const RegularExpression &regex, lldb::SymbolType symbol_type, SymbolContextList &sc_list, Mangled::NamePreference mangling_preference=Mangled::ePreferDemangled)
Definition: Module.cpp:1305
std::atomic< bool > m_did_load_symfile
Definition: Module.h:1046
UnwindTable & GetUnwindTable()
Returns a reference to the UnwindTable for this Module.
Definition: Module.cpp:1242
std::string GetSpecificationDescription() const
Get the module path and object name.
Definition: Module.cpp:1037
const FileSpec & GetFileSpec() const
Get const accessor for the module file specification.
Definition: Module.h:452
bool IsLoadedInTarget(Target *target)
Tells whether this module has been loaded in the target passed in.
Definition: Module.cpp:1406
void GetDescription(llvm::raw_ostream &s, lldb::DescriptionLevel level=lldb::eDescriptionLevelFull)
Definition: Module.cpp:1047
void SetUUID(const lldb_private::UUID &uuid)
Definition: Module.cpp:355
bool m_first_file_changed_log
Definition: Module.h:1049
void SymbolIndicesToSymbolContextList(Symtab *symtab, std::vector< uint32_t > &symbol_indexes, SymbolContextList &sc_list)
Definition: Module.cpp:1267
virtual void SectionFileAddressesChanged()
Notify the module that the file addresses for the Sections have been updated.
Definition: Module.cpp:1234
std::atomic< bool > m_did_load_objfile
Definition: Module.h:1045
bool FindSourceFile(const FileSpec &orig_spec, FileSpec &new_spec) const
Finds a source file given a file spec using the module source path remappings (if any).
Definition: Module.cpp:1540
void FindTypes(const TypeQuery &query, TypeResults &results)
Find types using a type-matching object that contains all search parameters.
Definition: Module.cpp:969
bool SetArchitecture(const ArchSpec &new_arch)
Definition: Module.cpp:1489
SectionList * GetUnifiedSectionList()
Definition: Module.cpp:1251
void ParseAllDebugSymbols()
A debugging function that will cause everything in a module to be parsed.
Definition: Module.cpp:375
static bool IsPossibleObjCSelector(const char *name)
Definition: ObjCLanguage.h:183
static bool IsPossibleObjCMethodName(const char *name)
Definition: ObjCLanguage.h:175
A plug-in interface definition class for object file parsers.
Definition: ObjectFile.h:44
static lldb::ObjectFileSP FindPlugin(const lldb::ModuleSP &module_sp, const FileSpec *file_spec, lldb::offset_t file_offset, lldb::offset_t file_size, lldb::DataBufferSP &data_sp, lldb::offset_t &data_offset)
Find a ObjectFile plug-in that can parse file_spec.
Definition: ObjectFile.cpp:53
virtual bool SetLoadAddress(Target &target, lldb::addr_t value, bool value_is_offset)
Sets the load address for an entire module, assuming a rigid slide of sections, if possible in the im...
Definition: ObjectFile.h:399
virtual void Dump(Stream *s)=0
Dump a description of this object to a Stream.
Symtab * GetSymtab()
Gets the symbol table for the currently selected architecture (and object for archives).
Definition: ObjectFile.cpp:736
virtual bool IsStripped()=0
Detect if this object file has been stripped of local symbols.
virtual bool IsExecutable() const =0
Tells whether this object file is capable of being the main executable for a process.
virtual void ClearSymtab()
Frees the symbol table.
Definition: ObjectFile.cpp:585
virtual FileSpec & GetFileSpec()
Get accessor to the object file specification.
Definition: ObjectFile.h:275
virtual void CreateSections(SectionList &unified_section_list)=0
virtual void SectionFileAddressesChanged()
Notify the ObjectFile that the file addresses in the Sections for this module have been changed.
Definition: ObjectFile.h:305
virtual UUID GetUUID()=0
Gets the UUID for this object file.
virtual bool GetIsDynamicLinkEditor()
Return true if this file is a dynamic link editor (dyld)
Definition: ObjectFile.h:641
static size_t GetModuleSpecifications(const FileSpec &file, lldb::offset_t file_offset, lldb::offset_t file_size, ModuleSpecList &specs, lldb::DataBufferSP data_sp=lldb::DataBufferSP())
Definition: ObjectFile.cpp:196
std::optional< FileSpec > FindFile(const FileSpec &orig_spec) const
Finds a source file given a file spec using the path remappings.
bool Replace(llvm::StringRef path, llvm::StringRef replacement, bool notify)
void Append(llvm::StringRef path, llvm::StringRef replacement, bool notify)
bool RemapPath(ConstString path, ConstString &new_path) const
llvm::StringRef GetText() const
Access the regular expression text.
virtual bool LoadScriptingModule(const char *filename, const LoadScriptOptions &options, lldb_private::Status &error, StructuredData::ObjectSP *module_sp=nullptr, FileSpec extra_search_dir={})
This is a SearchFilter that restricts the search to a given module.
Definition: SearchFilter.h:314
size_t GetNumSections(uint32_t depth) const
Definition: Section.cpp:533
size_t GetSize() const
Definition: Section.h:75
bool DeleteSection(size_t idx)
Definition: Section.cpp:486
lldb::SectionSP GetSectionAtIndex(size_t idx) const
Definition: Section.cpp:544
"lldb/Core/SourceLocationSpec.h" A source location specifier class.
An error handling class.
Definition: Status.h:44
const char * AsCString(const char *default_error_str="unknown error") const
Get the error string associated with the current error.
Definition: Status.cpp:129
const char * GetData() const
Definition: StreamString.h:45
llvm::StringRef GetString() const
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
llvm::raw_ostream & AsRawOstream()
Returns a raw_ostream that forwards the data to this Stream object.
Definition: Stream.h:401
size_t Indent(llvm::StringRef s="")
Indent the current line in the stream.
Definition: Stream.cpp:157
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:134
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
Definition: Stream.cpp:65
size_t PutChar(char ch)
Definition: Stream.cpp:131
void IndentLess(unsigned amount=2)
Decrement the current indentation level.
Definition: Stream.cpp:198
void IndentMore(unsigned amount=2)
Increment the current indentation level.
Definition: Stream.cpp:195
Defines a list of symbol context objects.
bool GetContextAtIndex(size_t idx, SymbolContext &sc) const
Get accessor for a symbol context at index idx.
uint32_t GetSize() const
Get accessor for a symbol context list size.
const_iterator end() const
void Append(const SymbolContext &sc)
Append a new symbol context to the list.
Defines a symbol context baton that can be handed other debug core functions.
Definition: SymbolContext.h:34
lldb::LanguageType GetLanguage() const
Function * function
The Function for a given query.
ConstString GetFunctionName(Mangled::NamePreference preference=Mangled::ePreferDemangled) const
Find a name of the innermost function for the symbol context.
Block * block
The Block for a given query.
lldb::ModuleSP module_sp
The Module for a given query.
CompileUnit * comp_unit
The CompileUnit for a given query.
void Clear(bool clear_target)
Clear the object's state.
bool GetAddressRange(uint32_t scope, uint32_t range_idx, bool use_inline_block_range, AddressRange &range) const
Get the address range contained within a symbol context.
Symbol * symbol
The Symbol for a given query.
Provides public interface for all SymbolFiles.
Definition: SymbolFile.h:50
virtual size_t ParseTypes(CompileUnit &comp_unit)=0
virtual Symtab * GetSymtab()=0
virtual void SetLoadDebugInfoEnabled()
Specify debug info should be loaded.
Definition: SymbolFile.h:140
virtual void PreloadSymbols()
Definition: SymbolFile.cpp:32
virtual void FindGlobalVariables(ConstString name, const CompilerDeclContext &parent_decl_ctx, uint32_t max_matches, VariableList &variables)
Definition: SymbolFile.cpp:115
virtual size_t ParseFunctions(CompileUnit &comp_unit)=0
virtual size_t ParseBlocksRecursive(Function &func)=0
virtual lldb::CompUnitSP GetCompileUnitAtIndex(uint32_t idx)=0
virtual size_t ParseVariablesForContext(const SymbolContext &sc)=0
virtual ObjectFile * GetObjectFile()=0
virtual uint32_t ResolveSymbolContext(const Address &so_addr, lldb::SymbolContextItem resolve_scope, SymbolContext &sc)=0
static void DownloadSymbolFileAsync(const UUID &uuid)
Locate the symbol file for the given UUID on a background thread.
static SymbolVendor * FindPlugin(const lldb::ModuleSP &module_sp, Stream *feedback_strm)
bool ValueIsAddress() const
Definition: Symbol.cpp:165
bool IsSynthetic() const
Definition: Symbol.h:182
Address & GetAddressRef()
Definition: Symbol.h:72
lldb::SymbolType GetType() const
Definition: Symbol.h:168
Symbol * SymbolAtIndex(size_t idx)
Definition: Symtab.cpp:228
void ForEachSymbolContainingFileAddress(lldb::addr_t file_addr, std::function< bool(Symbol *)> const &callback)
Definition: Symtab.cpp:1060
Symbol * FindSymbolContainingFileAddress(lldb::addr_t file_addr)
Definition: Symtab.cpp:1044
ObjectFile * GetObjectFile() const
Definition: Symtab.h:137
uint32_t AppendSymbolIndexesMatchingRegExAndType(const RegularExpression &regex, lldb::SymbolType symbol_type, std::vector< uint32_t > &indexes, Mangled::NamePreference name_preference=Mangled::ePreferDemangled)
Definition: Symtab.cpp:757
Debugger & GetDebugger()
Definition: Target.h:1064
lldb::PlatformSP GetPlatform()
Definition: Target.h:1444
A class that contains all state required for type lookups.
Definition: Type.h:100
This class tracks the state and results of a TypeQuery.
Definition: Type.h:308
llvm::Expected< lldb::TypeSystemSP > GetTypeSystemForLanguage(lldb::LanguageType language, Module *module, bool can_create)
Definition: TypeSystem.cpp:316
void ForEach(std::function< bool(lldb::TypeSystemSP)> const &callback)
Definition: TypeSystem.cpp:238
bool IsValid() const
Definition: UUID.h:69
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:82
A class that represents a running process on the host machine.
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
Definition: Log.h:331
LoadScriptFromSymFile
Definition: Target.h:50
@ eLoadScriptFromSymFileFalse
Definition: Target.h:52
@ eLoadScriptFromSymFileWarn
Definition: Target.h:53
const char * toString(AppleArm64ExceptionClass EC)
Definition: SBAddress.h:15
std::shared_ptr< lldb_private::Function > FunctionSP
Definition: lldb-forward.h:351
ScriptLanguage
Script interpreter types.
@ eScriptLanguageNone
std::shared_ptr< lldb_private::TypeSystem > TypeSystemSP
Definition: lldb-forward.h:463
DescriptionLevel
Description levels for "void GetDescription(Stream *, DescriptionLevel)" calls.
@ eDescriptionLevelBrief
@ eDescriptionLevelFull
std::shared_ptr< lldb_private::Platform > PlatformSP
Definition: lldb-forward.h:384
uint64_t offset_t
Definition: lldb-types.h:85
LanguageType
Programming language type.
@ eLanguageTypeUnknown
Unknown or invalid language value.
std::shared_ptr< lldb_private::Process > ProcessSP
Definition: lldb-forward.h:385
SymbolType
Symbol types.
@ eSymbolTypeResolver
std::shared_ptr< lldb_private::Section > SectionSP
Definition: lldb-forward.h:412
uint64_t addr_t
Definition: lldb-types.h:80
std::shared_ptr< lldb_private::Target > TargetSP
Definition: lldb-forward.h:442
std::shared_ptr< lldb_private::Module > ModuleSP
Definition: lldb-forward.h:369
std::shared_ptr< lldb_private::CompileUnit > CompUnitSP
Definition: lldb-forward.h:331
Options used by Module::FindFunctions.
Definition: Module.h:65
bool include_inlines
Include inlined functions.
Definition: Module.h:69
bool include_symbols
Include the symbol table.
Definition: Module.h:67
#define PATH_MAX