1 //===-- Module.cpp ----------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "lldb/lldb-python.h"
12 #include "lldb/Core/Error.h"
13 #include "lldb/Core/Module.h"
14 #include "lldb/Core/DataBuffer.h"
15 #include "lldb/Core/DataBufferHeap.h"
16 #include "lldb/Core/Log.h"
17 #include "lldb/Core/ModuleList.h"
18 #include "lldb/Core/ModuleSpec.h"
19 #include "lldb/Core/RegularExpression.h"
20 #include "lldb/Core/Section.h"
21 #include "lldb/Core/StreamString.h"
22 #include "lldb/Core/Timer.h"
23 #include "lldb/Host/Host.h"
24 #include "lldb/Host/Symbols.h"
25 #include "lldb/Interpreter/CommandInterpreter.h"
26 #include "lldb/Interpreter/ScriptInterpreter.h"
27 #include "lldb/lldb-private-log.h"
28 #include "lldb/Symbol/CompileUnit.h"
29 #include "lldb/Symbol/ObjectFile.h"
30 #include "lldb/Symbol/SymbolContext.h"
31 #include "lldb/Symbol/SymbolVendor.h"
32 #include "lldb/Target/CPPLanguageRuntime.h"
33 #include "lldb/Target/ObjCLanguageRuntime.h"
34 #include "lldb/Target/Process.h"
35 #include "lldb/Target/Target.h"
36 #include "lldb/Symbol/SymbolFile.h"
39 using namespace lldb_private;
41 // Shared pointers to modules track module lifetimes in
42 // targets and in the global module, but this collection
43 // will track all module objects that are still alive
44 typedef std::vector<Module *> ModuleCollection;
46 static ModuleCollection &
49 // This module collection needs to live past any module, so we could either make it a
50 // shared pointer in each module or just leak is. Since it is only an empty vector by
51 // the time all the modules have gone away, we just leak it for now. If we decide this
52 // is a big problem we can introduce a Finalize method that will tear everything down in
53 // a predictable order.
55 static ModuleCollection *g_module_collection = NULL;
56 if (g_module_collection == NULL)
57 g_module_collection = new ModuleCollection();
59 return *g_module_collection;
63 Module::GetAllocationModuleCollectionMutex()
65 // NOTE: The mutex below must be leaked since the global module list in
66 // the ModuleList class will get torn at some point, and we can't know
67 // if it will tear itself down before the "g_module_collection_mutex" below
68 // will. So we leak a Mutex object below to safeguard against that
70 static Mutex *g_module_collection_mutex = NULL;
71 if (g_module_collection_mutex == NULL)
72 g_module_collection_mutex = new Mutex (Mutex::eMutexTypeRecursive); // NOTE: known leak
73 return g_module_collection_mutex;
77 Module::GetNumberAllocatedModules ()
79 Mutex::Locker locker (GetAllocationModuleCollectionMutex());
80 return GetModuleCollection().size();
84 Module::GetAllocatedModuleAtIndex (size_t idx)
86 Mutex::Locker locker (GetAllocationModuleCollectionMutex());
87 ModuleCollection &modules = GetModuleCollection();
88 if (idx < modules.size())
94 // These functions help us to determine if modules are still loaded, yet don't require that
95 // you have a command interpreter and can easily be called from an external debugger.
99 ClearModuleInfo (void)
101 const bool mandatory = true;
102 ModuleList::RemoveOrphanSharedModules(mandatory);
106 DumpModuleInfo (void)
108 Mutex::Locker locker (Module::GetAllocationModuleCollectionMutex());
109 ModuleCollection &modules = GetModuleCollection();
110 const size_t count = modules.size();
111 printf ("%s: %" PRIu64 " modules:\n", __PRETTY_FUNCTION__, (uint64_t)count);
112 for (size_t i=0; i<count; ++i)
116 Module *module = modules[i];
117 const bool in_shared_module_list = ModuleList::ModuleIsInCache (module);
118 module->GetDescription(&strm, eDescriptionLevelFull);
119 printf ("%p: shared = %i, ref_count = %3u, module = %s\n",
121 in_shared_module_list,
122 (uint32_t)module->use_count(),
123 strm.GetString().c_str());
130 Module::Module (const ModuleSpec &module_spec) :
131 m_mutex (Mutex::eMutexTypeRecursive),
132 m_mod_time (module_spec.GetFileSpec().GetModificationTime()),
133 m_arch (module_spec.GetArchitecture()),
135 m_file (module_spec.GetFileSpec()),
136 m_platform_file(module_spec.GetPlatformFileSpec()),
137 m_symfile_spec (module_spec.GetSymbolFileSpec()),
138 m_object_name (module_spec.GetObjectName()),
139 m_object_offset (module_spec.GetObjectOffset()),
140 m_object_mod_time (module_spec.GetObjectModificationTime()),
144 m_source_mappings (),
145 m_did_load_objfile (false),
146 m_did_load_symbol_vendor (false),
147 m_did_parse_uuid (false),
148 m_did_init_ast (false),
149 m_is_dynamic_loader_module (false),
150 m_file_has_changed (false),
151 m_first_file_changed_log (false)
153 // Scope for locker below...
155 Mutex::Locker locker (GetAllocationModuleCollectionMutex());
156 GetModuleCollection().push_back(this);
159 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_OBJECT|LIBLLDB_LOG_MODULES));
161 log->Printf ("%p Module::Module((%s) '%s%s%s%s')",
163 m_arch.GetArchitectureName(),
164 m_file.GetPath().c_str(),
165 m_object_name.IsEmpty() ? "" : "(",
166 m_object_name.IsEmpty() ? "" : m_object_name.AsCString(""),
167 m_object_name.IsEmpty() ? "" : ")");
170 Module::Module(const FileSpec& file_spec,
171 const ArchSpec& arch,
172 const ConstString *object_name,
174 const TimeValue *object_mod_time_ptr) :
175 m_mutex (Mutex::eMutexTypeRecursive),
176 m_mod_time (file_spec.GetModificationTime()),
183 m_object_offset (object_offset),
184 m_object_mod_time (),
188 m_source_mappings (),
189 m_did_load_objfile (false),
190 m_did_load_symbol_vendor (false),
191 m_did_parse_uuid (false),
192 m_did_init_ast (false),
193 m_is_dynamic_loader_module (false),
194 m_file_has_changed (false),
195 m_first_file_changed_log (false)
197 // Scope for locker below...
199 Mutex::Locker locker (GetAllocationModuleCollectionMutex());
200 GetModuleCollection().push_back(this);
204 m_object_name = *object_name;
206 if (object_mod_time_ptr)
207 m_object_mod_time = *object_mod_time_ptr;
209 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_OBJECT|LIBLLDB_LOG_MODULES));
211 log->Printf ("%p Module::Module((%s) '%s%s%s%s')",
213 m_arch.GetArchitectureName(),
214 m_file.GetPath().c_str(),
215 m_object_name.IsEmpty() ? "" : "(",
216 m_object_name.IsEmpty() ? "" : m_object_name.AsCString(""),
217 m_object_name.IsEmpty() ? "" : ")");
222 // Lock our module down while we tear everything down to make sure
223 // we don't get any access to the module while it is being destroyed
224 Mutex::Locker locker (m_mutex);
225 // Scope for locker below...
227 Mutex::Locker locker (GetAllocationModuleCollectionMutex());
228 ModuleCollection &modules = GetModuleCollection();
229 ModuleCollection::iterator end = modules.end();
230 ModuleCollection::iterator pos = std::find(modules.begin(), end, this);
234 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_OBJECT|LIBLLDB_LOG_MODULES));
236 log->Printf ("%p Module::~Module((%s) '%s%s%s%s')",
238 m_arch.GetArchitectureName(),
239 m_file.GetPath().c_str(),
240 m_object_name.IsEmpty() ? "" : "(",
241 m_object_name.IsEmpty() ? "" : m_object_name.AsCString(""),
242 m_object_name.IsEmpty() ? "" : ")");
243 // Release any auto pointers before we start tearing down our member
244 // variables since the object file and symbol files might need to make
245 // function calls back into this module object. The ordering is important
246 // here because symbol files can require the module object file. So we tear
247 // down the symbol file first, then the object file.
248 m_sections_ap.reset();
249 m_symfile_ap.reset();
250 m_objfile_sp.reset();
254 Module::GetMemoryObjectFile (const lldb::ProcessSP &process_sp, lldb::addr_t header_addr, Error &error)
258 error.SetErrorString ("object file already exists");
262 Mutex::Locker locker (m_mutex);
265 m_did_load_objfile = true;
266 std::unique_ptr<DataBufferHeap> data_ap (new DataBufferHeap (512, 0));
268 const size_t bytes_read = process_sp->ReadMemory (header_addr,
270 data_ap->GetByteSize(),
272 if (bytes_read == 512)
274 DataBufferSP data_sp(data_ap.release());
275 m_objfile_sp = ObjectFile::FindPlugin(shared_from_this(), process_sp, header_addr, data_sp);
279 s.Printf("0x%16.16" PRIx64, header_addr);
280 m_object_name.SetCString (s.GetData());
282 // Once we get the object file, update our module with the object file's
283 // architecture since it might differ in vendor/os if some parts were
285 m_objfile_sp->GetArchitecture (m_arch);
289 error.SetErrorString ("unable to find suitable object file plug-in");
294 error.SetErrorStringWithFormat ("unable to read header from memory: %s", readmem_error.AsCString());
299 error.SetErrorString ("invalid process");
302 return m_objfile_sp.get();
306 const lldb_private::UUID&
309 Mutex::Locker locker (m_mutex);
310 if (m_did_parse_uuid == false)
312 ObjectFile * obj_file = GetObjectFile ();
314 if (obj_file != NULL)
316 obj_file->GetUUID(&m_uuid);
317 m_did_parse_uuid = true;
324 Module::GetClangASTContext ()
326 Mutex::Locker locker (m_mutex);
327 if (m_did_init_ast == false)
329 ObjectFile * objfile = GetObjectFile();
330 ArchSpec object_arch;
331 if (objfile && objfile->GetArchitecture(object_arch))
333 m_did_init_ast = true;
335 // LLVM wants this to be set to iOS or MacOSX; if we're working on
336 // a bare-boards type image, change the triple for llvm's benefit.
337 if (object_arch.GetTriple().getVendor() == llvm::Triple::Apple
338 && object_arch.GetTriple().getOS() == llvm::Triple::UnknownOS)
340 if (object_arch.GetTriple().getArch() == llvm::Triple::arm ||
341 object_arch.GetTriple().getArch() == llvm::Triple::thumb)
343 object_arch.GetTriple().setOS(llvm::Triple::IOS);
347 object_arch.GetTriple().setOS(llvm::Triple::MacOSX);
350 m_ast.SetArchitecture (object_arch);
357 Module::ParseAllDebugSymbols()
359 Mutex::Locker locker (m_mutex);
360 size_t num_comp_units = GetNumCompileUnits();
361 if (num_comp_units == 0)
365 sc.module_sp = shared_from_this();
366 SymbolVendor *symbols = GetSymbolVendor ();
368 for (size_t cu_idx = 0; cu_idx < num_comp_units; cu_idx++)
370 sc.comp_unit = symbols->GetCompileUnitAtIndex(cu_idx).get();
374 symbols->ParseVariablesForContext(sc);
376 symbols->ParseCompileUnitFunctions(sc);
378 for (size_t func_idx = 0; (sc.function = sc.comp_unit->GetFunctionAtIndex(func_idx).get()) != NULL; ++func_idx)
380 symbols->ParseFunctionBlocks(sc);
382 // Parse the variables for this function and all its blocks
383 symbols->ParseVariablesForContext(sc);
387 // Parse all types for this compile unit
389 symbols->ParseTypes(sc);
395 Module::CalculateSymbolContext(SymbolContext* sc)
397 sc->module_sp = shared_from_this();
401 Module::CalculateSymbolContextModule ()
403 return shared_from_this();
407 Module::DumpSymbolContext(Stream *s)
409 s->Printf(", Module{%p}", this);
413 Module::GetNumCompileUnits()
415 Mutex::Locker locker (m_mutex);
416 Timer scoped_timer(__PRETTY_FUNCTION__, "Module::GetNumCompileUnits (module = %p)", this);
417 SymbolVendor *symbols = GetSymbolVendor ();
419 return symbols->GetNumCompileUnits();
424 Module::GetCompileUnitAtIndex (size_t index)
426 Mutex::Locker locker (m_mutex);
427 size_t num_comp_units = GetNumCompileUnits ();
430 if (index < num_comp_units)
432 SymbolVendor *symbols = GetSymbolVendor ();
434 cu_sp = symbols->GetCompileUnitAtIndex(index);
440 Module::ResolveFileAddress (lldb::addr_t vm_addr, Address& so_addr)
442 Mutex::Locker locker (m_mutex);
443 Timer scoped_timer(__PRETTY_FUNCTION__, "Module::ResolveFileAddress (vm_addr = 0x%" PRIx64 ")", vm_addr);
444 SectionList *section_list = GetSectionList();
446 return so_addr.ResolveAddressUsingFileSections(vm_addr, section_list);
451 Module::ResolveSymbolContextForAddress (const Address& so_addr, uint32_t resolve_scope, SymbolContext& sc)
453 Mutex::Locker locker (m_mutex);
454 uint32_t resolved_flags = 0;
456 // Clear the result symbol context in case we don't find anything, but don't clear the target
459 // Get the section from the section/offset address.
460 SectionSP section_sp (so_addr.GetSection());
462 // Make sure the section matches this module before we try and match anything
463 if (section_sp && section_sp->GetModule().get() == this)
465 // If the section offset based address resolved itself, then this
466 // is the right module.
467 sc.module_sp = shared_from_this();
468 resolved_flags |= eSymbolContextModule;
470 // Resolve the compile unit, function, block, line table or line
471 // entry if requested.
472 if (resolve_scope & eSymbolContextCompUnit ||
473 resolve_scope & eSymbolContextFunction ||
474 resolve_scope & eSymbolContextBlock ||
475 resolve_scope & eSymbolContextLineEntry )
477 SymbolVendor *symbols = GetSymbolVendor ();
479 resolved_flags |= symbols->ResolveSymbolContext (so_addr, resolve_scope, sc);
482 // Resolve the symbol if requested, but don't re-look it up if we've already found it.
483 if (resolve_scope & eSymbolContextSymbol && !(resolved_flags & eSymbolContextSymbol))
485 SymbolVendor* sym_vendor = GetSymbolVendor();
488 Symtab *symtab = sym_vendor->GetSymtab();
491 if (so_addr.IsSectionOffset())
493 sc.symbol = symtab->FindSymbolContainingFileAddress(so_addr.GetFileAddress());
495 resolved_flags |= eSymbolContextSymbol;
501 return resolved_flags;
505 Module::ResolveSymbolContextForFilePath
507 const char *file_path,
510 uint32_t resolve_scope,
511 SymbolContextList& sc_list
514 FileSpec file_spec(file_path, false);
515 return ResolveSymbolContextsForFileSpec (file_spec, line, check_inlines, resolve_scope, sc_list);
519 Module::ResolveSymbolContextsForFileSpec (const FileSpec &file_spec, uint32_t line, bool check_inlines, uint32_t resolve_scope, SymbolContextList& sc_list)
521 Mutex::Locker locker (m_mutex);
522 Timer scoped_timer(__PRETTY_FUNCTION__,
523 "Module::ResolveSymbolContextForFilePath (%s:%u, check_inlines = %s, resolve_scope = 0x%8.8x)",
524 file_spec.GetPath().c_str(),
526 check_inlines ? "yes" : "no",
529 const uint32_t initial_count = sc_list.GetSize();
531 SymbolVendor *symbols = GetSymbolVendor ();
533 symbols->ResolveSymbolContext (file_spec, line, check_inlines, resolve_scope, sc_list);
535 return sc_list.GetSize() - initial_count;
540 Module::FindGlobalVariables (const ConstString &name,
541 const ClangNamespaceDecl *namespace_decl,
544 VariableList& variables)
546 SymbolVendor *symbols = GetSymbolVendor ();
548 return symbols->FindGlobalVariables(name, namespace_decl, append, max_matches, variables);
553 Module::FindGlobalVariables (const RegularExpression& regex,
556 VariableList& variables)
558 SymbolVendor *symbols = GetSymbolVendor ();
560 return symbols->FindGlobalVariables(regex, append, max_matches, variables);
565 Module::FindCompileUnits (const FileSpec &path,
567 SymbolContextList &sc_list)
572 const size_t start_size = sc_list.GetSize();
573 const size_t num_compile_units = GetNumCompileUnits();
575 sc.module_sp = shared_from_this();
576 const bool compare_directory = path.GetDirectory();
577 for (size_t i=0; i<num_compile_units; ++i)
579 sc.comp_unit = GetCompileUnitAtIndex(i).get();
582 if (FileSpec::Equal (*sc.comp_unit, path, compare_directory))
586 return sc_list.GetSize() - start_size;
590 Module::FindFunctions (const ConstString &name,
591 const ClangNamespaceDecl *namespace_decl,
592 uint32_t name_type_mask,
593 bool include_symbols,
594 bool include_inlines,
596 SymbolContextList& sc_list)
601 const size_t old_size = sc_list.GetSize();
603 // Find all the functions (not symbols, but debug information functions...
604 SymbolVendor *symbols = GetSymbolVendor ();
606 if (name_type_mask & eFunctionNameTypeAuto)
608 ConstString lookup_name;
609 uint32_t lookup_name_type_mask = 0;
610 bool match_name_after_lookup = false;
611 Module::PrepareForFunctionNameLookup (name,
614 lookup_name_type_mask,
615 match_name_after_lookup);
619 symbols->FindFunctions(lookup_name,
621 lookup_name_type_mask,
626 // Now check our symbol table for symbols that are code symbols if requested
629 Symtab *symtab = symbols->GetSymtab();
631 symtab->FindFunctionSymbols(lookup_name, lookup_name_type_mask, sc_list);
635 if (match_name_after_lookup)
639 while (i<sc_list.GetSize())
641 if (sc_list.GetContextAtIndex(i, sc))
643 const char *func_name = sc.GetFunctionName().GetCString();
644 if (func_name && strstr (func_name, name.GetCString()) == NULL)
646 // Remove the current context
647 sc_list.RemoveContextAtIndex(i);
648 // Don't increment i and continue in the loop
660 symbols->FindFunctions(name, namespace_decl, name_type_mask, include_inlines, append, sc_list);
662 // Now check our symbol table for symbols that are code symbols if requested
665 Symtab *symtab = symbols->GetSymtab();
667 symtab->FindFunctionSymbols(name, name_type_mask, sc_list);
672 return sc_list.GetSize() - old_size;
676 Module::FindFunctions (const RegularExpression& regex,
677 bool include_symbols,
678 bool include_inlines,
680 SymbolContextList& sc_list)
685 const size_t start_size = sc_list.GetSize();
687 SymbolVendor *symbols = GetSymbolVendor ();
690 symbols->FindFunctions(regex, include_inlines, append, sc_list);
692 // Now check our symbol table for symbols that are code symbols if requested
695 Symtab *symtab = symbols->GetSymtab();
698 std::vector<uint32_t> symbol_indexes;
699 symtab->AppendSymbolIndexesMatchingRegExAndType (regex, eSymbolTypeAny, Symtab::eDebugAny, Symtab::eVisibilityAny, symbol_indexes);
700 const size_t num_matches = symbol_indexes.size();
703 SymbolContext sc(this);
704 const size_t end_functions_added_index = sc_list.GetSize();
705 size_t num_functions_added_to_sc_list = end_functions_added_index - start_size;
706 if (num_functions_added_to_sc_list == 0)
708 // No functions were added, just symbols, so we can just append them
709 for (size_t i=0; i<num_matches; ++i)
711 sc.symbol = symtab->SymbolAtIndex(symbol_indexes[i]);
712 SymbolType sym_type = sc.symbol->GetType();
713 if (sc.symbol && (sym_type == eSymbolTypeCode ||
714 sym_type == eSymbolTypeResolver))
720 typedef std::map<lldb::addr_t, uint32_t> FileAddrToIndexMap;
721 FileAddrToIndexMap file_addr_to_index;
722 for (size_t i=start_size; i<end_functions_added_index; ++i)
724 const SymbolContext &sc = sc_list[i];
727 file_addr_to_index[sc.function->GetAddressRange().GetBaseAddress().GetFileAddress()] = i;
730 FileAddrToIndexMap::const_iterator end = file_addr_to_index.end();
731 // Functions were added so we need to merge symbols into any
732 // existing function symbol contexts
733 for (size_t i=start_size; i<num_matches; ++i)
735 sc.symbol = symtab->SymbolAtIndex(symbol_indexes[i]);
736 SymbolType sym_type = sc.symbol->GetType();
737 if (sc.symbol && (sym_type == eSymbolTypeCode ||
738 sym_type == eSymbolTypeResolver))
740 FileAddrToIndexMap::const_iterator pos = file_addr_to_index.find(sc.symbol->GetAddress().GetFileAddress());
744 sc_list[pos->second].symbol = sc.symbol;
752 return sc_list.GetSize() - start_size;
756 Module::FindTypes_Impl (const SymbolContext& sc,
757 const ConstString &name,
758 const ClangNamespaceDecl *namespace_decl,
763 Timer scoped_timer(__PRETTY_FUNCTION__, __PRETTY_FUNCTION__);
764 if (sc.module_sp.get() == NULL || sc.module_sp.get() == this)
766 SymbolVendor *symbols = GetSymbolVendor ();
768 return symbols->FindTypes(sc, name, namespace_decl, append, max_matches, types);
774 Module::FindTypesInNamespace (const SymbolContext& sc,
775 const ConstString &type_name,
776 const ClangNamespaceDecl *namespace_decl,
780 const bool append = true;
781 return FindTypes_Impl(sc, type_name, namespace_decl, append, max_matches, type_list);
785 Module::FindFirstType (const SymbolContext& sc,
786 const ConstString &name,
790 const size_t num_matches = FindTypes (sc, name, exact_match, 1, type_list);
792 return type_list.GetTypeAtIndex(0);
798 Module::FindTypes (const SymbolContext& sc,
799 const ConstString &name,
804 size_t num_matches = 0;
805 const char *type_name_cstr = name.GetCString();
806 std::string type_scope;
807 std::string type_basename;
808 const bool append = true;
809 TypeClass type_class = eTypeClassAny;
810 if (Type::GetTypeScopeAndBasename (type_name_cstr, type_scope, type_basename, type_class))
812 // Check if "name" starts with "::" which means the qualified type starts
813 // from the root namespace and implies and exact match. The typenames we
814 // get back from clang do not start with "::" so we need to strip this off
815 // in order to get the qualfied names to match
817 if (type_scope.size() >= 2 && type_scope[0] == ':' && type_scope[1] == ':')
819 type_scope.erase(0,2);
822 ConstString type_basename_const_str (type_basename.c_str());
823 if (FindTypes_Impl(sc, type_basename_const_str, NULL, append, max_matches, types))
825 types.RemoveMismatchedTypes (type_scope, type_basename, type_class, exact_match);
826 num_matches = types.GetSize();
831 // The type is not in a namespace/class scope, just search for it by basename
832 if (type_class != eTypeClassAny)
834 // The "type_name_cstr" will have been modified if we have a valid type class
835 // prefix (like "struct", "class", "union", "typedef" etc).
836 num_matches = FindTypes_Impl(sc, ConstString(type_name_cstr), NULL, append, max_matches, types);
837 types.RemoveMismatchedTypes (type_class);
838 num_matches = types.GetSize();
842 num_matches = FindTypes_Impl(sc, name, NULL, append, max_matches, types);
851 Module::GetSymbolVendor (bool can_create, lldb_private::Stream *feedback_strm)
853 Mutex::Locker locker (m_mutex);
854 if (m_did_load_symbol_vendor == false && can_create)
856 ObjectFile *obj_file = GetObjectFile ();
857 if (obj_file != NULL)
859 Timer scoped_timer(__PRETTY_FUNCTION__, __PRETTY_FUNCTION__);
860 m_symfile_ap.reset(SymbolVendor::FindPlugin(shared_from_this(), feedback_strm));
861 m_did_load_symbol_vendor = true;
864 return m_symfile_ap.get();
868 Module::SetFileSpecAndObjectName (const FileSpec &file, const ConstString &object_name)
870 // Container objects whose paths do not specify a file directly can call
871 // this function to correct the file and object names.
873 m_mod_time = file.GetModificationTime();
874 m_object_name = object_name;
878 Module::GetArchitecture () const
884 Module::GetSpecificationDescription () const
886 std::string spec(GetFileSpec().GetPath());
890 spec += m_object_name.GetCString();
897 Module::GetDescription (Stream *s, lldb::DescriptionLevel level)
899 Mutex::Locker locker (m_mutex);
901 if (level >= eDescriptionLevelFull)
903 if (m_arch.IsValid())
904 s->Printf("(%s) ", m_arch.GetArchitectureName());
907 if (level == eDescriptionLevelBrief)
909 const char *filename = m_file.GetFilename().GetCString();
911 s->PutCString (filename);
916 if (m_file.GetPath(path, sizeof(path)))
920 const char *object_name = m_object_name.GetCString();
922 s->Printf("(%s)", object_name);
926 Module::ReportError (const char *format, ...)
928 if (format && format[0])
931 strm.PutCString("error: ");
932 GetDescription(&strm, lldb::eDescriptionLevelBrief);
935 va_start (args, format);
936 strm.PrintfVarArg(format, args);
939 const int format_len = strlen(format);
942 const char last_char = format[format_len-1];
943 if (last_char != '\n' || last_char != '\r')
946 Host::SystemLog (Host::eSystemLogError, "%s", strm.GetString().c_str());
952 Module::FileHasChanged () const
954 if (m_file_has_changed == false)
955 m_file_has_changed = (m_file.GetModificationTime() != m_mod_time);
956 return m_file_has_changed;
960 Module::ReportErrorIfModifyDetected (const char *format, ...)
962 if (m_first_file_changed_log == false)
964 if (FileHasChanged ())
966 m_first_file_changed_log = true;
970 strm.PutCString("error: the object file ");
971 GetDescription(&strm, lldb::eDescriptionLevelFull);
972 strm.PutCString (" has been modified\n");
975 va_start (args, format);
976 strm.PrintfVarArg(format, args);
979 const int format_len = strlen(format);
982 const char last_char = format[format_len-1];
983 if (last_char != '\n' || last_char != '\r')
986 strm.PutCString("The debug session should be aborted as the original debug information has been overwritten.\n");
987 Host::SystemLog (Host::eSystemLogError, "%s", strm.GetString().c_str());
994 Module::ReportWarning (const char *format, ...)
996 if (format && format[0])
999 strm.PutCString("warning: ");
1000 GetDescription(&strm, lldb::eDescriptionLevelFull);
1004 va_start (args, format);
1005 strm.PrintfVarArg(format, args);
1008 const int format_len = strlen(format);
1011 const char last_char = format[format_len-1];
1012 if (last_char != '\n' || last_char != '\r')
1015 Host::SystemLog (Host::eSystemLogWarning, "%s", strm.GetString().c_str());
1020 Module::LogMessage (Log *log, const char *format, ...)
1024 StreamString log_message;
1025 GetDescription(&log_message, lldb::eDescriptionLevelFull);
1026 log_message.PutCString (": ");
1028 va_start (args, format);
1029 log_message.PrintfVarArg (format, args);
1031 log->PutCString(log_message.GetString().c_str());
1036 Module::LogMessageVerboseBacktrace (Log *log, const char *format, ...)
1040 StreamString log_message;
1041 GetDescription(&log_message, lldb::eDescriptionLevelFull);
1042 log_message.PutCString (": ");
1044 va_start (args, format);
1045 log_message.PrintfVarArg (format, args);
1047 if (log->GetVerbose())
1048 Host::Backtrace (log_message, 1024);
1049 log->PutCString(log_message.GetString().c_str());
1054 Module::Dump(Stream *s)
1056 Mutex::Locker locker (m_mutex);
1057 //s->Printf("%.*p: ", (int)sizeof(void*) * 2, this);
1059 s->Printf("Module %s%s%s%s\n",
1060 m_file.GetPath().c_str(),
1061 m_object_name ? "(" : "",
1062 m_object_name ? m_object_name.GetCString() : "",
1063 m_object_name ? ")" : "");
1067 ObjectFile *objfile = GetObjectFile ();
1071 SymbolVendor *symbols = GetSymbolVendor ();
1080 Module::GetTypeList ()
1082 SymbolVendor *symbols = GetSymbolVendor ();
1084 return &symbols->GetTypeList();
1089 Module::GetObjectName() const
1091 return m_object_name;
1095 Module::GetObjectFile()
1097 Mutex::Locker locker (m_mutex);
1098 if (m_did_load_objfile == false)
1100 Timer scoped_timer(__PRETTY_FUNCTION__,
1101 "Module::GetObjectFile () module = %s", GetFileSpec().GetFilename().AsCString(""));
1102 DataBufferSP data_sp;
1103 lldb::offset_t data_offset = 0;
1104 const lldb::offset_t file_size = m_file.GetByteSize();
1105 if (file_size > m_object_offset)
1107 m_did_load_objfile = true;
1108 m_objfile_sp = ObjectFile::FindPlugin (shared_from_this(),
1111 file_size - m_object_offset,
1116 // Once we get the object file, update our module with the object file's
1117 // architecture since it might differ in vendor/os if some parts were
1119 m_objfile_sp->GetArchitecture (m_arch);
1123 return m_objfile_sp.get();
1127 Module::GetSectionList()
1129 // Populate m_unified_sections_ap with sections from objfile.
1130 if (m_sections_ap.get() == NULL)
1132 ObjectFile *obj_file = GetObjectFile();
1134 obj_file->CreateSections(*GetUnifiedSectionList());
1136 return m_sections_ap.get();
1140 Module::GetUnifiedSectionList()
1142 // Populate m_unified_sections_ap with sections from objfile.
1143 if (m_sections_ap.get() == NULL)
1144 m_sections_ap.reset(new SectionList());
1145 return m_sections_ap.get();
1149 Module::FindFirstSymbolWithNameAndType (const ConstString &name, SymbolType symbol_type)
1151 Timer scoped_timer(__PRETTY_FUNCTION__,
1152 "Module::FindFirstSymbolWithNameAndType (name = %s, type = %i)",
1155 SymbolVendor* sym_vendor = GetSymbolVendor();
1158 Symtab *symtab = sym_vendor->GetSymtab();
1160 return symtab->FindFirstSymbolWithNameAndType (name, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny);
1165 Module::SymbolIndicesToSymbolContextList (Symtab *symtab, std::vector<uint32_t> &symbol_indexes, SymbolContextList &sc_list)
1167 // No need to protect this call using m_mutex all other method calls are
1168 // already thread safe.
1170 size_t num_indices = symbol_indexes.size();
1171 if (num_indices > 0)
1174 CalculateSymbolContext (&sc);
1175 for (size_t i = 0; i < num_indices; i++)
1177 sc.symbol = symtab->SymbolAtIndex (symbol_indexes[i]);
1179 sc_list.Append (sc);
1185 Module::FindFunctionSymbols (const ConstString &name,
1186 uint32_t name_type_mask,
1187 SymbolContextList& sc_list)
1189 Timer scoped_timer(__PRETTY_FUNCTION__,
1190 "Module::FindSymbolsFunctions (name = %s, mask = 0x%8.8x)",
1193 SymbolVendor* sym_vendor = GetSymbolVendor();
1196 Symtab *symtab = sym_vendor->GetSymtab();
1198 return symtab->FindFunctionSymbols (name, name_type_mask, sc_list);
1204 Module::FindSymbolsWithNameAndType (const ConstString &name, SymbolType symbol_type, SymbolContextList &sc_list)
1206 // No need to protect this call using m_mutex all other method calls are
1207 // already thread safe.
1210 Timer scoped_timer(__PRETTY_FUNCTION__,
1211 "Module::FindSymbolsWithNameAndType (name = %s, type = %i)",
1214 const size_t initial_size = sc_list.GetSize();
1215 SymbolVendor* sym_vendor = GetSymbolVendor();
1218 Symtab *symtab = sym_vendor->GetSymtab();
1221 std::vector<uint32_t> symbol_indexes;
1222 symtab->FindAllSymbolsWithNameAndType (name, symbol_type, symbol_indexes);
1223 SymbolIndicesToSymbolContextList (symtab, symbol_indexes, sc_list);
1226 return sc_list.GetSize() - initial_size;
1230 Module::FindSymbolsMatchingRegExAndType (const RegularExpression ®ex, SymbolType symbol_type, SymbolContextList &sc_list)
1232 // No need to protect this call using m_mutex all other method calls are
1233 // already thread safe.
1235 Timer scoped_timer(__PRETTY_FUNCTION__,
1236 "Module::FindSymbolsMatchingRegExAndType (regex = %s, type = %i)",
1239 const size_t initial_size = sc_list.GetSize();
1240 SymbolVendor* sym_vendor = GetSymbolVendor();
1243 Symtab *symtab = sym_vendor->GetSymtab();
1246 std::vector<uint32_t> symbol_indexes;
1247 symtab->FindAllSymbolsMatchingRexExAndType (regex, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny, symbol_indexes);
1248 SymbolIndicesToSymbolContextList (symtab, symbol_indexes, sc_list);
1251 return sc_list.GetSize() - initial_size;
1255 Module::SetSymbolFileFileSpec (const FileSpec &file)
1257 // Remove any sections in the unified section list that come from the current symbol vendor.
1260 SectionList *section_list = GetSectionList();
1261 SymbolFile *symbol_file = m_symfile_ap->GetSymbolFile();
1262 if (section_list && symbol_file)
1264 ObjectFile *obj_file = symbol_file->GetObjectFile();
1265 // Make sure we have an object file and that the symbol vendor's objfile isn't
1266 // the same as the module's objfile before we remove any sections for it...
1267 if (obj_file && obj_file != m_objfile_sp.get())
1269 size_t num_sections = section_list->GetNumSections (0);
1270 for (size_t idx = num_sections; idx > 0; --idx)
1272 lldb::SectionSP section_sp (section_list->GetSectionAtIndex (idx - 1));
1273 if (section_sp->GetObjectFile() == obj_file)
1275 section_list->DeleteSection (idx - 1);
1282 m_symfile_spec = file;
1283 m_symfile_ap.reset();
1284 m_did_load_symbol_vendor = false;
1288 Module::IsExecutable ()
1290 if (GetObjectFile() == NULL)
1293 return GetObjectFile()->IsExecutable();
1297 Module::IsLoadedInTarget (Target *target)
1299 ObjectFile *obj_file = GetObjectFile();
1302 SectionList *sections = GetSectionList();
1303 if (sections != NULL)
1305 size_t num_sections = sections->GetSize();
1306 for (size_t sect_idx = 0; sect_idx < num_sections; sect_idx++)
1308 SectionSP section_sp = sections->GetSectionAtIndex(sect_idx);
1309 if (section_sp->GetLoadBaseAddress(target) != LLDB_INVALID_ADDRESS)
1320 Module::LoadScriptingResourceInTarget (Target *target, Error& error, Stream* feedback_stream)
1324 error.SetErrorString("invalid destination Target");
1328 LoadScriptFromSymFile shoud_load = target->TargetProperties::GetLoadScriptFromSymbolFile();
1330 Debugger &debugger = target->GetDebugger();
1331 const ScriptLanguage script_language = debugger.GetScriptLanguage();
1332 if (script_language != eScriptLanguageNone)
1335 PlatformSP platform_sp(target->GetPlatform());
1339 error.SetErrorString("invalid Platform");
1343 FileSpecList file_specs = platform_sp->LocateExecutableScriptingResources (target,
1347 const uint32_t num_specs = file_specs.GetSize();
1350 ScriptInterpreter *script_interpreter = debugger.GetCommandInterpreter().GetScriptInterpreter();
1351 if (script_interpreter)
1353 for (uint32_t i=0; i<num_specs; ++i)
1355 FileSpec scripting_fspec (file_specs.GetFileSpecAtIndex(i));
1356 if (scripting_fspec && scripting_fspec.Exists())
1358 if (shoud_load == eLoadScriptFromSymFileFalse)
1360 if (shoud_load == eLoadScriptFromSymFileWarn)
1362 if (feedback_stream)
1363 feedback_stream->Printf("warning: '%s' contains a debug script. To run this script in "
1364 "this debug session:\n\n command script import \"%s\"\n\n"
1365 "To run all discovered debug scripts in this session:\n\n"
1366 " settings set target.load-script-from-symbol-file true\n",
1367 GetFileSpec().GetFileNameStrippingExtension().GetCString(),
1368 scripting_fspec.GetPath().c_str());
1371 StreamString scripting_stream;
1372 scripting_fspec.Dump(&scripting_stream);
1373 const bool can_reload = true;
1374 const bool init_lldb_globals = false;
1375 bool did_load = script_interpreter->LoadScriptingModule(scripting_stream.GetData(),
1386 error.SetErrorString("invalid ScriptInterpreter");
1395 Module::SetArchitecture (const ArchSpec &new_arch)
1397 if (!m_arch.IsValid())
1402 return m_arch.IsExactMatch(new_arch);
1406 Module::SetLoadAddress (Target &target, lldb::addr_t offset, bool &changed)
1408 size_t num_loaded_sections = 0;
1409 SectionList *section_list = GetSectionList ();
1412 const size_t num_sections = section_list->GetSize();
1413 size_t sect_idx = 0;
1414 for (sect_idx = 0; sect_idx < num_sections; ++sect_idx)
1416 // Iterate through the object file sections to find the
1417 // first section that starts of file offset zero and that
1418 // has bytes in the file...
1419 SectionSP section_sp (section_list->GetSectionAtIndex (sect_idx));
1420 // Only load non-thread specific sections when given a slide
1421 if (section_sp && !section_sp->IsThreadSpecific())
1423 if (target.GetSectionLoadList().SetSectionLoadAddress (section_sp, section_sp->GetFileAddress() + offset))
1424 ++num_loaded_sections;
1428 changed = num_loaded_sections > 0;
1429 return num_loaded_sections > 0;
1434 Module::MatchesModuleSpec (const ModuleSpec &module_ref)
1436 const UUID &uuid = module_ref.GetUUID();
1440 // If the UUID matches, then nothing more needs to match...
1441 if (uuid == GetUUID())
1447 const FileSpec &file_spec = module_ref.GetFileSpec();
1450 if (!FileSpec::Equal (file_spec, m_file, file_spec.GetDirectory()))
1454 const FileSpec &platform_file_spec = module_ref.GetPlatformFileSpec();
1455 if (platform_file_spec)
1457 if (!FileSpec::Equal (platform_file_spec, GetPlatformFileSpec (), platform_file_spec.GetDirectory()))
1461 const ArchSpec &arch = module_ref.GetArchitecture();
1464 if (!m_arch.IsCompatibleMatch(arch))
1468 const ConstString &object_name = module_ref.GetObjectName();
1471 if (object_name != GetObjectName())
1478 Module::FindSourceFile (const FileSpec &orig_spec, FileSpec &new_spec) const
1480 Mutex::Locker locker (m_mutex);
1481 return m_source_mappings.FindFile (orig_spec, new_spec);
1485 Module::RemapSourceFile (const char *path, std::string &new_path) const
1487 Mutex::Locker locker (m_mutex);
1488 return m_source_mappings.RemapPath(path, new_path);
1492 Module::GetVersion (uint32_t *versions, uint32_t num_versions)
1494 ObjectFile *obj_file = GetObjectFile();
1496 return obj_file->GetVersion (versions, num_versions);
1498 if (versions && num_versions)
1500 for (uint32_t i=0; i<num_versions; ++i)
1501 versions[i] = UINT32_MAX;
1507 Module::PrepareForFunctionNameLookup (const ConstString &name,
1508 uint32_t name_type_mask,
1509 ConstString &lookup_name,
1510 uint32_t &lookup_name_type_mask,
1511 bool &match_name_after_lookup)
1513 const char *name_cstr = name.GetCString();
1514 lookup_name_type_mask = eFunctionNameTypeNone;
1515 match_name_after_lookup = false;
1516 const char *base_name_start = NULL;
1517 const char *base_name_end = NULL;
1519 if (name_type_mask & eFunctionNameTypeAuto)
1521 if (CPPLanguageRuntime::IsCPPMangledName (name_cstr))
1522 lookup_name_type_mask = eFunctionNameTypeFull;
1523 else if (ObjCLanguageRuntime::IsPossibleObjCMethodName (name_cstr))
1524 lookup_name_type_mask = eFunctionNameTypeFull;
1527 if (ObjCLanguageRuntime::IsPossibleObjCSelector(name_cstr))
1528 lookup_name_type_mask |= eFunctionNameTypeSelector;
1530 CPPLanguageRuntime::MethodName cpp_method (name);
1531 llvm::StringRef basename (cpp_method.GetBasename());
1532 if (basename.empty())
1534 if (CPPLanguageRuntime::StripNamespacesFromVariableName (name_cstr, base_name_start, base_name_end))
1535 lookup_name_type_mask |= (eFunctionNameTypeMethod | eFunctionNameTypeBase);
1539 base_name_start = basename.data();
1540 base_name_end = base_name_start + basename.size();
1541 lookup_name_type_mask |= (eFunctionNameTypeMethod | eFunctionNameTypeBase);
1547 lookup_name_type_mask = name_type_mask;
1548 if (lookup_name_type_mask & eFunctionNameTypeMethod || name_type_mask & eFunctionNameTypeBase)
1550 // If they've asked for a CPP method or function name and it can't be that, we don't
1551 // even need to search for CPP methods or names.
1552 CPPLanguageRuntime::MethodName cpp_method (name);
1553 if (cpp_method.IsValid())
1555 llvm::StringRef basename (cpp_method.GetBasename());
1556 base_name_start = basename.data();
1557 base_name_end = base_name_start + basename.size();
1559 if (!cpp_method.GetQualifiers().empty())
1561 // There is a "const" or other qualifer following the end of the fucntion parens,
1562 // this can't be a eFunctionNameTypeBase
1563 lookup_name_type_mask &= ~(eFunctionNameTypeBase);
1564 if (lookup_name_type_mask == eFunctionNameTypeNone)
1570 if (!CPPLanguageRuntime::StripNamespacesFromVariableName (name_cstr, base_name_start, base_name_end))
1572 lookup_name_type_mask &= ~(eFunctionNameTypeMethod | eFunctionNameTypeBase);
1573 if (lookup_name_type_mask == eFunctionNameTypeNone)
1579 if (lookup_name_type_mask & eFunctionNameTypeSelector)
1581 if (!ObjCLanguageRuntime::IsPossibleObjCSelector(name_cstr))
1583 lookup_name_type_mask &= ~(eFunctionNameTypeSelector);
1584 if (lookup_name_type_mask == eFunctionNameTypeNone)
1590 if (base_name_start &&
1592 base_name_start != name_cstr &&
1593 base_name_start < base_name_end)
1595 // The name supplied was a partial C++ path like "a::count". In this case we want to do a
1596 // lookup on the basename "count" and then make sure any matching results contain "a::count"
1597 // so that it would match "b::a::count" and "a::count". This is why we set "match_name_after_lookup"
1599 lookup_name.SetCStringWithLength(base_name_start, base_name_end - base_name_start);
1600 match_name_after_lookup = true;
1604 // The name is already correct, just use the exact name as supplied, and we won't need
1605 // to check if any matches contain "name"
1607 match_name_after_lookup = false;