1 //===-- Module.cpp ----------------------------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #include "lldb/Core/AddressResolverFileLine.h" 11 #include "lldb/Core/Error.h" 12 #include "lldb/Core/Module.h" 13 #include "lldb/Core/DataBuffer.h" 14 #include "lldb/Core/DataBufferHeap.h" 15 #include "lldb/Core/Log.h" 16 #include "lldb/Core/ModuleList.h" 17 #include "lldb/Core/ModuleSpec.h" 18 #include "lldb/Core/PluginManager.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/Symbol/CompileUnit.h" 28 #include "lldb/Symbol/ObjectFile.h" 29 #include "lldb/Symbol/SymbolContext.h" 30 #include "lldb/Symbol/SymbolFile.h" 31 #include "lldb/Symbol/SymbolVendor.h" 32 #include "lldb/Symbol/TypeSystem.h" 33 #include "lldb/Target/Language.h" 34 #include "lldb/Target/Process.h" 35 #include "lldb/Target/SectionLoadList.h" 36 #include "lldb/Target/Target.h" 37 #include "Plugins/Language/CPlusPlus/CPlusPlusLanguage.h" 38 #include "Plugins/Language/ObjC/ObjCLanguage.h" 39 #include "lldb/Symbol/TypeMap.h" 40 41 #include "Plugins/ObjectFile/JIT/ObjectFileJIT.h" 42 43 #include "llvm/Support/raw_os_ostream.h" 44 #include "llvm/Support/Signals.h" 45 46 using namespace lldb; 47 using namespace lldb_private; 48 49 // Shared pointers to modules track module lifetimes in 50 // targets and in the global module, but this collection 51 // will track all module objects that are still alive 52 typedef std::vector<Module *> ModuleCollection; 53 54 static ModuleCollection & 55 GetModuleCollection() 56 { 57 // This module collection needs to live past any module, so we could either make it a 58 // shared pointer in each module or just leak is. Since it is only an empty vector by 59 // the time all the modules have gone away, we just leak it for now. If we decide this 60 // is a big problem we can introduce a Finalize method that will tear everything down in 61 // a predictable order. 62 63 static ModuleCollection *g_module_collection = NULL; 64 if (g_module_collection == NULL) 65 g_module_collection = new ModuleCollection(); 66 67 return *g_module_collection; 68 } 69 70 Mutex * 71 Module::GetAllocationModuleCollectionMutex() 72 { 73 // NOTE: The mutex below must be leaked since the global module list in 74 // the ModuleList class will get torn at some point, and we can't know 75 // if it will tear itself down before the "g_module_collection_mutex" below 76 // will. So we leak a Mutex object below to safeguard against that 77 78 static Mutex *g_module_collection_mutex = NULL; 79 if (g_module_collection_mutex == NULL) 80 g_module_collection_mutex = new Mutex (Mutex::eMutexTypeRecursive); // NOTE: known leak 81 return g_module_collection_mutex; 82 } 83 84 size_t 85 Module::GetNumberAllocatedModules () 86 { 87 Mutex::Locker locker (GetAllocationModuleCollectionMutex()); 88 return GetModuleCollection().size(); 89 } 90 91 Module * 92 Module::GetAllocatedModuleAtIndex (size_t idx) 93 { 94 Mutex::Locker locker (GetAllocationModuleCollectionMutex()); 95 ModuleCollection &modules = GetModuleCollection(); 96 if (idx < modules.size()) 97 return modules[idx]; 98 return NULL; 99 } 100 #if 0 101 102 // These functions help us to determine if modules are still loaded, yet don't require that 103 // you have a command interpreter and can easily be called from an external debugger. 104 namespace lldb { 105 106 void 107 ClearModuleInfo (void) 108 { 109 const bool mandatory = true; 110 ModuleList::RemoveOrphanSharedModules(mandatory); 111 } 112 113 void 114 DumpModuleInfo (void) 115 { 116 Mutex::Locker locker (Module::GetAllocationModuleCollectionMutex()); 117 ModuleCollection &modules = GetModuleCollection(); 118 const size_t count = modules.size(); 119 printf ("%s: %" PRIu64 " modules:\n", __PRETTY_FUNCTION__, (uint64_t)count); 120 for (size_t i=0; i<count; ++i) 121 { 122 123 StreamString strm; 124 Module *module = modules[i]; 125 const bool in_shared_module_list = ModuleList::ModuleIsInCache (module); 126 module->GetDescription(&strm, eDescriptionLevelFull); 127 printf ("%p: shared = %i, ref_count = %3u, module = %s\n", 128 module, 129 in_shared_module_list, 130 (uint32_t)module->use_count(), 131 strm.GetString().c_str()); 132 } 133 } 134 } 135 136 #endif 137 138 Module::Module (const ModuleSpec &module_spec) : 139 m_mutex (Mutex::eMutexTypeRecursive), 140 m_mod_time (), 141 m_arch (), 142 m_uuid (), 143 m_file (), 144 m_platform_file(), 145 m_remote_install_file(), 146 m_symfile_spec (), 147 m_object_name (), 148 m_object_offset (), 149 m_object_mod_time (), 150 m_objfile_sp (), 151 m_symfile_ap (), 152 m_type_system_map(), 153 m_source_mappings (), 154 m_sections_ap(), 155 m_did_load_objfile (false), 156 m_did_load_symbol_vendor (false), 157 m_did_parse_uuid (false), 158 m_file_has_changed (false), 159 m_first_file_changed_log (false) 160 { 161 // Scope for locker below... 162 { 163 Mutex::Locker locker (GetAllocationModuleCollectionMutex()); 164 GetModuleCollection().push_back(this); 165 } 166 167 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_OBJECT|LIBLLDB_LOG_MODULES)); 168 if (log) 169 log->Printf ("%p Module::Module((%s) '%s%s%s%s')", 170 static_cast<void*>(this), 171 module_spec.GetArchitecture().GetArchitectureName(), 172 module_spec.GetFileSpec().GetPath().c_str(), 173 module_spec.GetObjectName().IsEmpty() ? "" : "(", 174 module_spec.GetObjectName().IsEmpty() ? "" : module_spec.GetObjectName().AsCString(""), 175 module_spec.GetObjectName().IsEmpty() ? "" : ")"); 176 177 // First extract all module specifications from the file using the local 178 // file path. If there are no specifications, then don't fill anything in 179 ModuleSpecList modules_specs; 180 if (ObjectFile::GetModuleSpecifications(module_spec.GetFileSpec(), 0, 0, modules_specs) == 0) 181 return; 182 183 // Now make sure that one of the module specifications matches what we just 184 // extract. We might have a module specification that specifies a file "/usr/lib/dyld" 185 // with UUID XXX, but we might have a local version of "/usr/lib/dyld" that has 186 // UUID YYY and we don't want those to match. If they don't match, just don't 187 // fill any ivars in so we don't accidentally grab the wrong file later since 188 // they don't match... 189 ModuleSpec matching_module_spec; 190 if (modules_specs.FindMatchingModuleSpec(module_spec, matching_module_spec) == 0) 191 return; 192 193 if (module_spec.GetFileSpec()) 194 m_mod_time = module_spec.GetFileSpec().GetModificationTime(); 195 else if (matching_module_spec.GetFileSpec()) 196 m_mod_time = matching_module_spec.GetFileSpec().GetModificationTime(); 197 198 // Copy the architecture from the actual spec if we got one back, else use the one that was specified 199 if (matching_module_spec.GetArchitecture().IsValid()) 200 m_arch = matching_module_spec.GetArchitecture(); 201 else if (module_spec.GetArchitecture().IsValid()) 202 m_arch = module_spec.GetArchitecture(); 203 204 // Copy the file spec over and use the specified one (if there was one) so we 205 // don't use a path that might have gotten resolved a path in 'matching_module_spec' 206 if (module_spec.GetFileSpec()) 207 m_file = module_spec.GetFileSpec(); 208 else if (matching_module_spec.GetFileSpec()) 209 m_file = matching_module_spec.GetFileSpec(); 210 211 // Copy the platform file spec over 212 if (module_spec.GetPlatformFileSpec()) 213 m_platform_file = module_spec.GetPlatformFileSpec(); 214 else if (matching_module_spec.GetPlatformFileSpec()) 215 m_platform_file = matching_module_spec.GetPlatformFileSpec(); 216 217 // Copy the symbol file spec over 218 if (module_spec.GetSymbolFileSpec()) 219 m_symfile_spec = module_spec.GetSymbolFileSpec(); 220 else if (matching_module_spec.GetSymbolFileSpec()) 221 m_symfile_spec = matching_module_spec.GetSymbolFileSpec(); 222 223 // Copy the object name over 224 if (matching_module_spec.GetObjectName()) 225 m_object_name = matching_module_spec.GetObjectName(); 226 else 227 m_object_name = module_spec.GetObjectName(); 228 229 // Always trust the object offset (file offset) and object modification 230 // time (for mod time in a BSD static archive) of from the matching 231 // module specification 232 m_object_offset = matching_module_spec.GetObjectOffset(); 233 m_object_mod_time = matching_module_spec.GetObjectModificationTime(); 234 235 } 236 237 Module::Module(const FileSpec& file_spec, 238 const ArchSpec& arch, 239 const ConstString *object_name, 240 lldb::offset_t object_offset, 241 const TimeValue *object_mod_time_ptr) : 242 m_mutex (Mutex::eMutexTypeRecursive), 243 m_mod_time (file_spec.GetModificationTime()), 244 m_arch (arch), 245 m_uuid (), 246 m_file (file_spec), 247 m_platform_file(), 248 m_remote_install_file (), 249 m_symfile_spec (), 250 m_object_name (), 251 m_object_offset (object_offset), 252 m_object_mod_time (), 253 m_objfile_sp (), 254 m_symfile_ap (), 255 m_type_system_map(), 256 m_source_mappings (), 257 m_sections_ap(), 258 m_did_load_objfile (false), 259 m_did_load_symbol_vendor (false), 260 m_did_parse_uuid (false), 261 m_file_has_changed (false), 262 m_first_file_changed_log (false) 263 { 264 // Scope for locker below... 265 { 266 Mutex::Locker locker (GetAllocationModuleCollectionMutex()); 267 GetModuleCollection().push_back(this); 268 } 269 270 if (object_name) 271 m_object_name = *object_name; 272 273 if (object_mod_time_ptr) 274 m_object_mod_time = *object_mod_time_ptr; 275 276 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_OBJECT|LIBLLDB_LOG_MODULES)); 277 if (log) 278 log->Printf ("%p Module::Module((%s) '%s%s%s%s')", 279 static_cast<void*>(this), m_arch.GetArchitectureName(), 280 m_file.GetPath().c_str(), 281 m_object_name.IsEmpty() ? "" : "(", 282 m_object_name.IsEmpty() ? "" : m_object_name.AsCString(""), 283 m_object_name.IsEmpty() ? "" : ")"); 284 } 285 286 Module::Module () : 287 m_mutex (Mutex::eMutexTypeRecursive), 288 m_mod_time (), 289 m_arch (), 290 m_uuid (), 291 m_file (), 292 m_platform_file(), 293 m_remote_install_file (), 294 m_symfile_spec (), 295 m_object_name (), 296 m_object_offset (0), 297 m_object_mod_time (), 298 m_objfile_sp (), 299 m_symfile_ap (), 300 m_type_system_map(), 301 m_source_mappings (), 302 m_sections_ap(), 303 m_did_load_objfile (false), 304 m_did_load_symbol_vendor (false), 305 m_did_parse_uuid (false), 306 m_file_has_changed (false), 307 m_first_file_changed_log (false) 308 { 309 Mutex::Locker locker (GetAllocationModuleCollectionMutex()); 310 GetModuleCollection().push_back(this); 311 } 312 313 Module::~Module() 314 { 315 // Lock our module down while we tear everything down to make sure 316 // we don't get any access to the module while it is being destroyed 317 Mutex::Locker locker (m_mutex); 318 // Scope for locker below... 319 { 320 Mutex::Locker locker (GetAllocationModuleCollectionMutex()); 321 ModuleCollection &modules = GetModuleCollection(); 322 ModuleCollection::iterator end = modules.end(); 323 ModuleCollection::iterator pos = std::find(modules.begin(), end, this); 324 assert (pos != end); 325 modules.erase(pos); 326 } 327 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_OBJECT|LIBLLDB_LOG_MODULES)); 328 if (log) 329 log->Printf ("%p Module::~Module((%s) '%s%s%s%s')", 330 static_cast<void*>(this), 331 m_arch.GetArchitectureName(), 332 m_file.GetPath().c_str(), 333 m_object_name.IsEmpty() ? "" : "(", 334 m_object_name.IsEmpty() ? "" : m_object_name.AsCString(""), 335 m_object_name.IsEmpty() ? "" : ")"); 336 // Release any auto pointers before we start tearing down our member 337 // variables since the object file and symbol files might need to make 338 // function calls back into this module object. The ordering is important 339 // here because symbol files can require the module object file. So we tear 340 // down the symbol file first, then the object file. 341 m_sections_ap.reset(); 342 m_symfile_ap.reset(); 343 m_objfile_sp.reset(); 344 } 345 346 ObjectFile * 347 Module::GetMemoryObjectFile (const lldb::ProcessSP &process_sp, lldb::addr_t header_addr, Error &error, size_t size_to_read) 348 { 349 if (m_objfile_sp) 350 { 351 error.SetErrorString ("object file already exists"); 352 } 353 else 354 { 355 Mutex::Locker locker (m_mutex); 356 if (process_sp) 357 { 358 m_did_load_objfile = true; 359 std::unique_ptr<DataBufferHeap> data_ap (new DataBufferHeap (size_to_read, 0)); 360 Error readmem_error; 361 const size_t bytes_read = process_sp->ReadMemory (header_addr, 362 data_ap->GetBytes(), 363 data_ap->GetByteSize(), 364 readmem_error); 365 if (bytes_read == size_to_read) 366 { 367 DataBufferSP data_sp(data_ap.release()); 368 m_objfile_sp = ObjectFile::FindPlugin(shared_from_this(), process_sp, header_addr, data_sp); 369 if (m_objfile_sp) 370 { 371 StreamString s; 372 s.Printf("0x%16.16" PRIx64, header_addr); 373 m_object_name.SetCString (s.GetData()); 374 375 // Once we get the object file, update our module with the object file's 376 // architecture since it might differ in vendor/os if some parts were 377 // unknown. 378 m_objfile_sp->GetArchitecture (m_arch); 379 } 380 else 381 { 382 error.SetErrorString ("unable to find suitable object file plug-in"); 383 } 384 } 385 else 386 { 387 error.SetErrorStringWithFormat ("unable to read header from memory: %s", readmem_error.AsCString()); 388 } 389 } 390 else 391 { 392 error.SetErrorString ("invalid process"); 393 } 394 } 395 return m_objfile_sp.get(); 396 } 397 398 399 const lldb_private::UUID& 400 Module::GetUUID() 401 { 402 if (m_did_parse_uuid.load() == false) 403 { 404 Mutex::Locker locker (m_mutex); 405 if (m_did_parse_uuid.load() == false) 406 { 407 ObjectFile * obj_file = GetObjectFile (); 408 409 if (obj_file != NULL) 410 { 411 obj_file->GetUUID(&m_uuid); 412 m_did_parse_uuid = true; 413 } 414 } 415 } 416 return m_uuid; 417 } 418 419 TypeSystem * 420 Module::GetTypeSystemForLanguage (LanguageType language) 421 { 422 return m_type_system_map.GetTypeSystemForLanguage(language, this, true); 423 } 424 425 void 426 Module::ParseAllDebugSymbols() 427 { 428 Mutex::Locker locker (m_mutex); 429 size_t num_comp_units = GetNumCompileUnits(); 430 if (num_comp_units == 0) 431 return; 432 433 SymbolContext sc; 434 sc.module_sp = shared_from_this(); 435 SymbolVendor *symbols = GetSymbolVendor (); 436 437 for (size_t cu_idx = 0; cu_idx < num_comp_units; cu_idx++) 438 { 439 sc.comp_unit = symbols->GetCompileUnitAtIndex(cu_idx).get(); 440 if (sc.comp_unit) 441 { 442 sc.function = NULL; 443 symbols->ParseVariablesForContext(sc); 444 445 symbols->ParseCompileUnitFunctions(sc); 446 447 for (size_t func_idx = 0; (sc.function = sc.comp_unit->GetFunctionAtIndex(func_idx).get()) != NULL; ++func_idx) 448 { 449 symbols->ParseFunctionBlocks(sc); 450 451 // Parse the variables for this function and all its blocks 452 symbols->ParseVariablesForContext(sc); 453 } 454 455 456 // Parse all types for this compile unit 457 sc.function = NULL; 458 symbols->ParseTypes(sc); 459 } 460 } 461 } 462 463 void 464 Module::CalculateSymbolContext(SymbolContext* sc) 465 { 466 sc->module_sp = shared_from_this(); 467 } 468 469 ModuleSP 470 Module::CalculateSymbolContextModule () 471 { 472 return shared_from_this(); 473 } 474 475 void 476 Module::DumpSymbolContext(Stream *s) 477 { 478 s->Printf(", Module{%p}", static_cast<void*>(this)); 479 } 480 481 size_t 482 Module::GetNumCompileUnits() 483 { 484 Mutex::Locker locker (m_mutex); 485 Timer scoped_timer(__PRETTY_FUNCTION__, 486 "Module::GetNumCompileUnits (module = %p)", 487 static_cast<void*>(this)); 488 SymbolVendor *symbols = GetSymbolVendor (); 489 if (symbols) 490 return symbols->GetNumCompileUnits(); 491 return 0; 492 } 493 494 CompUnitSP 495 Module::GetCompileUnitAtIndex (size_t index) 496 { 497 Mutex::Locker locker (m_mutex); 498 size_t num_comp_units = GetNumCompileUnits (); 499 CompUnitSP cu_sp; 500 501 if (index < num_comp_units) 502 { 503 SymbolVendor *symbols = GetSymbolVendor (); 504 if (symbols) 505 cu_sp = symbols->GetCompileUnitAtIndex(index); 506 } 507 return cu_sp; 508 } 509 510 bool 511 Module::ResolveFileAddress (lldb::addr_t vm_addr, Address& so_addr) 512 { 513 Mutex::Locker locker (m_mutex); 514 Timer scoped_timer(__PRETTY_FUNCTION__, "Module::ResolveFileAddress (vm_addr = 0x%" PRIx64 ")", vm_addr); 515 SectionList *section_list = GetSectionList(); 516 if (section_list) 517 return so_addr.ResolveAddressUsingFileSections(vm_addr, section_list); 518 return false; 519 } 520 521 uint32_t 522 Module::ResolveSymbolContextForAddress (const Address& so_addr, uint32_t resolve_scope, SymbolContext& sc, 523 bool resolve_tail_call_address) 524 { 525 Mutex::Locker locker (m_mutex); 526 uint32_t resolved_flags = 0; 527 528 // Clear the result symbol context in case we don't find anything, but don't clear the target 529 sc.Clear(false); 530 531 // Get the section from the section/offset address. 532 SectionSP section_sp (so_addr.GetSection()); 533 534 // Make sure the section matches this module before we try and match anything 535 if (section_sp && section_sp->GetModule().get() == this) 536 { 537 // If the section offset based address resolved itself, then this 538 // is the right module. 539 sc.module_sp = shared_from_this(); 540 resolved_flags |= eSymbolContextModule; 541 542 SymbolVendor* sym_vendor = GetSymbolVendor(); 543 if (!sym_vendor) 544 return resolved_flags; 545 546 // Resolve the compile unit, function, block, line table or line 547 // entry if requested. 548 if (resolve_scope & eSymbolContextCompUnit || 549 resolve_scope & eSymbolContextFunction || 550 resolve_scope & eSymbolContextBlock || 551 resolve_scope & eSymbolContextLineEntry ) 552 { 553 resolved_flags |= sym_vendor->ResolveSymbolContext (so_addr, resolve_scope, sc); 554 } 555 556 // Resolve the symbol if requested, but don't re-look it up if we've already found it. 557 if (resolve_scope & eSymbolContextSymbol && !(resolved_flags & eSymbolContextSymbol)) 558 { 559 Symtab *symtab = sym_vendor->GetSymtab(); 560 if (symtab && so_addr.IsSectionOffset()) 561 { 562 sc.symbol = symtab->FindSymbolContainingFileAddress(so_addr.GetFileAddress()); 563 if (!sc.symbol && 564 resolve_scope & eSymbolContextFunction && !(resolved_flags & eSymbolContextFunction)) 565 { 566 bool verify_unique = false; // No need to check again since ResolveSymbolContext failed to find a symbol at this address. 567 if (ObjectFile *obj_file = sc.module_sp->GetObjectFile()) 568 sc.symbol = obj_file->ResolveSymbolForAddress(so_addr, verify_unique); 569 } 570 571 if (sc.symbol) 572 { 573 if (sc.symbol->IsSynthetic()) 574 { 575 // We have a synthetic symbol so lets check if the object file 576 // from the symbol file in the symbol vendor is different than 577 // the object file for the module, and if so search its symbol 578 // table to see if we can come up with a better symbol. For example 579 // dSYM files on MacOSX have an unstripped symbol table inside of 580 // them. 581 ObjectFile *symtab_objfile = symtab->GetObjectFile(); 582 if (symtab_objfile && symtab_objfile->IsStripped()) 583 { 584 SymbolFile *symfile = sym_vendor->GetSymbolFile(); 585 if (symfile) 586 { 587 ObjectFile *symfile_objfile = symfile->GetObjectFile(); 588 if (symfile_objfile != symtab_objfile) 589 { 590 Symtab *symfile_symtab = symfile_objfile->GetSymtab(); 591 if (symfile_symtab) 592 { 593 Symbol *symbol = symfile_symtab->FindSymbolContainingFileAddress(so_addr.GetFileAddress()); 594 if (symbol && !symbol->IsSynthetic()) 595 { 596 sc.symbol = symbol; 597 } 598 } 599 } 600 } 601 } 602 } 603 resolved_flags |= eSymbolContextSymbol; 604 } 605 } 606 } 607 608 // For function symbols, so_addr may be off by one. This is a convention consistent 609 // with FDE row indices in eh_frame sections, but requires extra logic here to permit 610 // symbol lookup for disassembly and unwind. 611 if (resolve_scope & eSymbolContextSymbol && !(resolved_flags & eSymbolContextSymbol) && 612 resolve_tail_call_address && so_addr.IsSectionOffset()) 613 { 614 Address previous_addr = so_addr; 615 previous_addr.Slide(-1); 616 617 bool do_resolve_tail_call_address = false; // prevent recursion 618 const uint32_t flags = ResolveSymbolContextForAddress(previous_addr, resolve_scope, sc, 619 do_resolve_tail_call_address); 620 if (flags & eSymbolContextSymbol) 621 { 622 AddressRange addr_range; 623 if (sc.GetAddressRange (eSymbolContextFunction | eSymbolContextSymbol, 0, false, addr_range)) 624 { 625 if (addr_range.GetBaseAddress().GetSection() == so_addr.GetSection()) 626 { 627 // If the requested address is one past the address range of a function (i.e. a tail call), 628 // or the decremented address is the start of a function (i.e. some forms of trampoline), 629 // indicate that the symbol has been resolved. 630 if (so_addr.GetOffset() == addr_range.GetBaseAddress().GetOffset() || 631 so_addr.GetOffset() == addr_range.GetBaseAddress().GetOffset() + addr_range.GetByteSize()) 632 { 633 resolved_flags |= flags; 634 } 635 } 636 else 637 { 638 sc.symbol = nullptr; // Don't trust the symbol if the sections didn't match. 639 } 640 } 641 } 642 } 643 } 644 return resolved_flags; 645 } 646 647 uint32_t 648 Module::ResolveSymbolContextForFilePath 649 ( 650 const char *file_path, 651 uint32_t line, 652 bool check_inlines, 653 uint32_t resolve_scope, 654 SymbolContextList& sc_list 655 ) 656 { 657 FileSpec file_spec(file_path, false); 658 return ResolveSymbolContextsForFileSpec (file_spec, line, check_inlines, resolve_scope, sc_list); 659 } 660 661 uint32_t 662 Module::ResolveSymbolContextsForFileSpec (const FileSpec &file_spec, uint32_t line, bool check_inlines, uint32_t resolve_scope, SymbolContextList& sc_list) 663 { 664 Mutex::Locker locker (m_mutex); 665 Timer scoped_timer(__PRETTY_FUNCTION__, 666 "Module::ResolveSymbolContextForFilePath (%s:%u, check_inlines = %s, resolve_scope = 0x%8.8x)", 667 file_spec.GetPath().c_str(), 668 line, 669 check_inlines ? "yes" : "no", 670 resolve_scope); 671 672 const uint32_t initial_count = sc_list.GetSize(); 673 674 SymbolVendor *symbols = GetSymbolVendor (); 675 if (symbols) 676 symbols->ResolveSymbolContext (file_spec, line, check_inlines, resolve_scope, sc_list); 677 678 return sc_list.GetSize() - initial_count; 679 } 680 681 682 size_t 683 Module::FindGlobalVariables (const ConstString &name, 684 const CompilerDeclContext *parent_decl_ctx, 685 bool append, 686 size_t max_matches, 687 VariableList& variables) 688 { 689 SymbolVendor *symbols = GetSymbolVendor (); 690 if (symbols) 691 return symbols->FindGlobalVariables(name, parent_decl_ctx, append, max_matches, variables); 692 return 0; 693 } 694 695 size_t 696 Module::FindGlobalVariables (const RegularExpression& regex, 697 bool append, 698 size_t max_matches, 699 VariableList& variables) 700 { 701 SymbolVendor *symbols = GetSymbolVendor (); 702 if (symbols) 703 return symbols->FindGlobalVariables(regex, append, max_matches, variables); 704 return 0; 705 } 706 707 size_t 708 Module::FindCompileUnits (const FileSpec &path, 709 bool append, 710 SymbolContextList &sc_list) 711 { 712 if (!append) 713 sc_list.Clear(); 714 715 const size_t start_size = sc_list.GetSize(); 716 const size_t num_compile_units = GetNumCompileUnits(); 717 SymbolContext sc; 718 sc.module_sp = shared_from_this(); 719 const bool compare_directory = (bool)path.GetDirectory(); 720 for (size_t i=0; i<num_compile_units; ++i) 721 { 722 sc.comp_unit = GetCompileUnitAtIndex(i).get(); 723 if (sc.comp_unit) 724 { 725 if (FileSpec::Equal (*sc.comp_unit, path, compare_directory)) 726 sc_list.Append(sc); 727 } 728 } 729 return sc_list.GetSize() - start_size; 730 } 731 732 size_t 733 Module::FindFunctions (const ConstString &name, 734 const CompilerDeclContext *parent_decl_ctx, 735 uint32_t name_type_mask, 736 bool include_symbols, 737 bool include_inlines, 738 bool append, 739 SymbolContextList& sc_list) 740 { 741 if (!append) 742 sc_list.Clear(); 743 744 const size_t old_size = sc_list.GetSize(); 745 746 // Find all the functions (not symbols, but debug information functions... 747 SymbolVendor *symbols = GetSymbolVendor (); 748 749 if (name_type_mask & eFunctionNameTypeAuto) 750 { 751 ConstString lookup_name; 752 uint32_t lookup_name_type_mask = 0; 753 bool match_name_after_lookup = false; 754 Module::PrepareForFunctionNameLookup (name, 755 name_type_mask, 756 eLanguageTypeUnknown, // TODO: add support 757 lookup_name, 758 lookup_name_type_mask, 759 match_name_after_lookup); 760 761 if (symbols) 762 { 763 symbols->FindFunctions(lookup_name, 764 parent_decl_ctx, 765 lookup_name_type_mask, 766 include_inlines, 767 append, 768 sc_list); 769 770 // Now check our symbol table for symbols that are code symbols if requested 771 if (include_symbols) 772 { 773 Symtab *symtab = symbols->GetSymtab(); 774 if (symtab) 775 symtab->FindFunctionSymbols(lookup_name, lookup_name_type_mask, sc_list); 776 } 777 } 778 779 if (match_name_after_lookup) 780 { 781 SymbolContext sc; 782 size_t i = old_size; 783 while (i<sc_list.GetSize()) 784 { 785 if (sc_list.GetContextAtIndex(i, sc)) 786 { 787 const char *func_name = sc.GetFunctionName().GetCString(); 788 if (func_name && strstr (func_name, name.GetCString()) == NULL) 789 { 790 // Remove the current context 791 sc_list.RemoveContextAtIndex(i); 792 // Don't increment i and continue in the loop 793 continue; 794 } 795 } 796 ++i; 797 } 798 } 799 } 800 else 801 { 802 if (symbols) 803 { 804 symbols->FindFunctions(name, parent_decl_ctx, name_type_mask, include_inlines, append, sc_list); 805 806 // Now check our symbol table for symbols that are code symbols if requested 807 if (include_symbols) 808 { 809 Symtab *symtab = symbols->GetSymtab(); 810 if (symtab) 811 symtab->FindFunctionSymbols(name, name_type_mask, sc_list); 812 } 813 } 814 } 815 816 return sc_list.GetSize() - old_size; 817 } 818 819 size_t 820 Module::FindFunctions (const RegularExpression& regex, 821 bool include_symbols, 822 bool include_inlines, 823 bool append, 824 SymbolContextList& sc_list) 825 { 826 if (!append) 827 sc_list.Clear(); 828 829 const size_t start_size = sc_list.GetSize(); 830 831 SymbolVendor *symbols = GetSymbolVendor (); 832 if (symbols) 833 { 834 symbols->FindFunctions(regex, include_inlines, append, sc_list); 835 836 // Now check our symbol table for symbols that are code symbols if requested 837 if (include_symbols) 838 { 839 Symtab *symtab = symbols->GetSymtab(); 840 if (symtab) 841 { 842 std::vector<uint32_t> symbol_indexes; 843 symtab->AppendSymbolIndexesMatchingRegExAndType (regex, eSymbolTypeAny, Symtab::eDebugAny, Symtab::eVisibilityAny, symbol_indexes); 844 const size_t num_matches = symbol_indexes.size(); 845 if (num_matches) 846 { 847 SymbolContext sc(this); 848 const size_t end_functions_added_index = sc_list.GetSize(); 849 size_t num_functions_added_to_sc_list = end_functions_added_index - start_size; 850 if (num_functions_added_to_sc_list == 0) 851 { 852 // No functions were added, just symbols, so we can just append them 853 for (size_t i=0; i<num_matches; ++i) 854 { 855 sc.symbol = symtab->SymbolAtIndex(symbol_indexes[i]); 856 SymbolType sym_type = sc.symbol->GetType(); 857 if (sc.symbol && (sym_type == eSymbolTypeCode || 858 sym_type == eSymbolTypeResolver)) 859 sc_list.Append(sc); 860 } 861 } 862 else 863 { 864 typedef std::map<lldb::addr_t, uint32_t> FileAddrToIndexMap; 865 FileAddrToIndexMap file_addr_to_index; 866 for (size_t i=start_size; i<end_functions_added_index; ++i) 867 { 868 const SymbolContext &sc = sc_list[i]; 869 if (sc.block) 870 continue; 871 file_addr_to_index[sc.function->GetAddressRange().GetBaseAddress().GetFileAddress()] = i; 872 } 873 874 FileAddrToIndexMap::const_iterator end = file_addr_to_index.end(); 875 // Functions were added so we need to merge symbols into any 876 // existing function symbol contexts 877 for (size_t i=start_size; i<num_matches; ++i) 878 { 879 sc.symbol = symtab->SymbolAtIndex(symbol_indexes[i]); 880 SymbolType sym_type = sc.symbol->GetType(); 881 if (sc.symbol && sc.symbol->ValueIsAddress() && (sym_type == eSymbolTypeCode || sym_type == eSymbolTypeResolver)) 882 { 883 FileAddrToIndexMap::const_iterator pos = file_addr_to_index.find(sc.symbol->GetAddressRef().GetFileAddress()); 884 if (pos == end) 885 sc_list.Append(sc); 886 else 887 sc_list[pos->second].symbol = sc.symbol; 888 } 889 } 890 } 891 } 892 } 893 } 894 } 895 return sc_list.GetSize() - start_size; 896 } 897 898 void 899 Module::FindAddressesForLine (const lldb::TargetSP target_sp, 900 const FileSpec &file, uint32_t line, 901 Function *function, 902 std::vector<Address> &output_local, std::vector<Address> &output_extern) 903 { 904 SearchFilterByModule filter(target_sp, m_file); 905 AddressResolverFileLine resolver(file, line, true); 906 resolver.ResolveAddress (filter); 907 908 for (size_t n=0;n<resolver.GetNumberOfAddresses();n++) 909 { 910 Address addr = resolver.GetAddressRangeAtIndex(n).GetBaseAddress(); 911 Function *f = addr.CalculateSymbolContextFunction(); 912 if (f && f == function) 913 output_local.push_back (addr); 914 else 915 output_extern.push_back (addr); 916 } 917 } 918 919 size_t 920 Module::FindTypes_Impl (const SymbolContext& sc, 921 const ConstString &name, 922 const CompilerDeclContext *parent_decl_ctx, 923 bool append, 924 size_t max_matches, 925 TypeMap& types) 926 { 927 Timer scoped_timer(__PRETTY_FUNCTION__, __PRETTY_FUNCTION__); 928 if (sc.module_sp.get() == NULL || sc.module_sp.get() == this) 929 { 930 SymbolVendor *symbols = GetSymbolVendor (); 931 if (symbols) 932 return symbols->FindTypes(sc, name, parent_decl_ctx, append, max_matches, types); 933 } 934 return 0; 935 } 936 937 size_t 938 Module::FindTypesInNamespace (const SymbolContext& sc, 939 const ConstString &type_name, 940 const CompilerDeclContext *parent_decl_ctx, 941 size_t max_matches, 942 TypeList& type_list) 943 { 944 const bool append = true; 945 TypeMap types_map; 946 size_t num_types = FindTypes_Impl(sc, type_name, parent_decl_ctx, append, max_matches, types_map); 947 if (num_types > 0) 948 sc.SortTypeList(types_map, type_list); 949 return num_types; 950 } 951 952 lldb::TypeSP 953 Module::FindFirstType (const SymbolContext& sc, 954 const ConstString &name, 955 bool exact_match) 956 { 957 TypeList type_list; 958 const size_t num_matches = FindTypes (sc, name, exact_match, 1, type_list); 959 if (num_matches) 960 return type_list.GetTypeAtIndex(0); 961 return TypeSP(); 962 } 963 964 965 size_t 966 Module::FindTypes (const SymbolContext& sc, 967 const ConstString &name, 968 bool exact_match, 969 size_t max_matches, 970 TypeList& types) 971 { 972 size_t num_matches = 0; 973 const char *type_name_cstr = name.GetCString(); 974 std::string type_scope; 975 std::string type_basename; 976 const bool append = true; 977 TypeClass type_class = eTypeClassAny; 978 TypeMap typesmap; 979 if (Type::GetTypeScopeAndBasename (type_name_cstr, type_scope, type_basename, type_class)) 980 { 981 // Check if "name" starts with "::" which means the qualified type starts 982 // from the root namespace and implies and exact match. The typenames we 983 // get back from clang do not start with "::" so we need to strip this off 984 // in order to get the qualified names to match 985 986 if (type_scope.size() >= 2 && type_scope[0] == ':' && type_scope[1] == ':') 987 { 988 type_scope.erase(0,2); 989 exact_match = true; 990 } 991 ConstString type_basename_const_str (type_basename.c_str()); 992 if (FindTypes_Impl(sc, type_basename_const_str, NULL, append, max_matches, typesmap)) 993 { 994 typesmap.RemoveMismatchedTypes (type_scope, type_basename, type_class, exact_match); 995 num_matches = typesmap.GetSize(); 996 } 997 } 998 else 999 { 1000 // The type is not in a namespace/class scope, just search for it by basename 1001 if (type_class != eTypeClassAny) 1002 { 1003 // The "type_name_cstr" will have been modified if we have a valid type class 1004 // prefix (like "struct", "class", "union", "typedef" etc). 1005 FindTypes_Impl(sc, ConstString(type_name_cstr), NULL, append, max_matches, typesmap); 1006 typesmap.RemoveMismatchedTypes (type_class); 1007 num_matches = typesmap.GetSize(); 1008 } 1009 else 1010 { 1011 num_matches = FindTypes_Impl(sc, name, NULL, append, max_matches, typesmap); 1012 } 1013 } 1014 if (num_matches > 0) 1015 sc.SortTypeList(typesmap, types); 1016 return num_matches; 1017 } 1018 1019 SymbolVendor* 1020 Module::GetSymbolVendor (bool can_create, lldb_private::Stream *feedback_strm) 1021 { 1022 if (m_did_load_symbol_vendor.load() == false) 1023 { 1024 Mutex::Locker locker (m_mutex); 1025 if (m_did_load_symbol_vendor.load() == false && can_create) 1026 { 1027 ObjectFile *obj_file = GetObjectFile (); 1028 if (obj_file != NULL) 1029 { 1030 Timer scoped_timer(__PRETTY_FUNCTION__, __PRETTY_FUNCTION__); 1031 m_symfile_ap.reset(SymbolVendor::FindPlugin(shared_from_this(), feedback_strm)); 1032 m_did_load_symbol_vendor = true; 1033 } 1034 } 1035 } 1036 return m_symfile_ap.get(); 1037 } 1038 1039 void 1040 Module::SetFileSpecAndObjectName (const FileSpec &file, const ConstString &object_name) 1041 { 1042 // Container objects whose paths do not specify a file directly can call 1043 // this function to correct the file and object names. 1044 m_file = file; 1045 m_mod_time = file.GetModificationTime(); 1046 m_object_name = object_name; 1047 } 1048 1049 const ArchSpec& 1050 Module::GetArchitecture () const 1051 { 1052 return m_arch; 1053 } 1054 1055 std::string 1056 Module::GetSpecificationDescription () const 1057 { 1058 std::string spec(GetFileSpec().GetPath()); 1059 if (m_object_name) 1060 { 1061 spec += '('; 1062 spec += m_object_name.GetCString(); 1063 spec += ')'; 1064 } 1065 return spec; 1066 } 1067 1068 void 1069 Module::GetDescription (Stream *s, lldb::DescriptionLevel level) 1070 { 1071 Mutex::Locker locker (m_mutex); 1072 1073 if (level >= eDescriptionLevelFull) 1074 { 1075 if (m_arch.IsValid()) 1076 s->Printf("(%s) ", m_arch.GetArchitectureName()); 1077 } 1078 1079 if (level == eDescriptionLevelBrief) 1080 { 1081 const char *filename = m_file.GetFilename().GetCString(); 1082 if (filename) 1083 s->PutCString (filename); 1084 } 1085 else 1086 { 1087 char path[PATH_MAX]; 1088 if (m_file.GetPath(path, sizeof(path))) 1089 s->PutCString(path); 1090 } 1091 1092 const char *object_name = m_object_name.GetCString(); 1093 if (object_name) 1094 s->Printf("(%s)", object_name); 1095 } 1096 1097 void 1098 Module::ReportError (const char *format, ...) 1099 { 1100 if (format && format[0]) 1101 { 1102 StreamString strm; 1103 strm.PutCString("error: "); 1104 GetDescription(&strm, lldb::eDescriptionLevelBrief); 1105 strm.PutChar (' '); 1106 va_list args; 1107 va_start (args, format); 1108 strm.PrintfVarArg(format, args); 1109 va_end (args); 1110 1111 const int format_len = strlen(format); 1112 if (format_len > 0) 1113 { 1114 const char last_char = format[format_len-1]; 1115 if (last_char != '\n' || last_char != '\r') 1116 strm.EOL(); 1117 } 1118 Host::SystemLog (Host::eSystemLogError, "%s", strm.GetString().c_str()); 1119 1120 } 1121 } 1122 1123 bool 1124 Module::FileHasChanged () const 1125 { 1126 if (m_file_has_changed == false) 1127 m_file_has_changed = (m_file.GetModificationTime() != m_mod_time); 1128 return m_file_has_changed; 1129 } 1130 1131 void 1132 Module::ReportErrorIfModifyDetected (const char *format, ...) 1133 { 1134 if (m_first_file_changed_log == false) 1135 { 1136 if (FileHasChanged ()) 1137 { 1138 m_first_file_changed_log = true; 1139 if (format) 1140 { 1141 StreamString strm; 1142 strm.PutCString("error: the object file "); 1143 GetDescription(&strm, lldb::eDescriptionLevelFull); 1144 strm.PutCString (" has been modified\n"); 1145 1146 va_list args; 1147 va_start (args, format); 1148 strm.PrintfVarArg(format, args); 1149 va_end (args); 1150 1151 const int format_len = strlen(format); 1152 if (format_len > 0) 1153 { 1154 const char last_char = format[format_len-1]; 1155 if (last_char != '\n' || last_char != '\r') 1156 strm.EOL(); 1157 } 1158 strm.PutCString("The debug session should be aborted as the original debug information has been overwritten.\n"); 1159 Host::SystemLog (Host::eSystemLogError, "%s", strm.GetString().c_str()); 1160 } 1161 } 1162 } 1163 } 1164 1165 void 1166 Module::ReportWarning (const char *format, ...) 1167 { 1168 if (format && format[0]) 1169 { 1170 StreamString strm; 1171 strm.PutCString("warning: "); 1172 GetDescription(&strm, lldb::eDescriptionLevelFull); 1173 strm.PutChar (' '); 1174 1175 va_list args; 1176 va_start (args, format); 1177 strm.PrintfVarArg(format, args); 1178 va_end (args); 1179 1180 const int format_len = strlen(format); 1181 if (format_len > 0) 1182 { 1183 const char last_char = format[format_len-1]; 1184 if (last_char != '\n' || last_char != '\r') 1185 strm.EOL(); 1186 } 1187 Host::SystemLog (Host::eSystemLogWarning, "%s", strm.GetString().c_str()); 1188 } 1189 } 1190 1191 void 1192 Module::LogMessage (Log *log, const char *format, ...) 1193 { 1194 if (log) 1195 { 1196 StreamString log_message; 1197 GetDescription(&log_message, lldb::eDescriptionLevelFull); 1198 log_message.PutCString (": "); 1199 va_list args; 1200 va_start (args, format); 1201 log_message.PrintfVarArg (format, args); 1202 va_end (args); 1203 log->PutCString(log_message.GetString().c_str()); 1204 } 1205 } 1206 1207 void 1208 Module::LogMessageVerboseBacktrace (Log *log, const char *format, ...) 1209 { 1210 if (log) 1211 { 1212 StreamString log_message; 1213 GetDescription(&log_message, lldb::eDescriptionLevelFull); 1214 log_message.PutCString (": "); 1215 va_list args; 1216 va_start (args, format); 1217 log_message.PrintfVarArg (format, args); 1218 va_end (args); 1219 if (log->GetVerbose()) 1220 { 1221 std::string back_trace; 1222 llvm::raw_string_ostream stream(back_trace); 1223 llvm::sys::PrintStackTrace(stream); 1224 log_message.PutCString(back_trace.c_str()); 1225 } 1226 log->PutCString(log_message.GetString().c_str()); 1227 } 1228 } 1229 1230 void 1231 Module::Dump(Stream *s) 1232 { 1233 Mutex::Locker locker (m_mutex); 1234 //s->Printf("%.*p: ", (int)sizeof(void*) * 2, this); 1235 s->Indent(); 1236 s->Printf("Module %s%s%s%s\n", 1237 m_file.GetPath().c_str(), 1238 m_object_name ? "(" : "", 1239 m_object_name ? m_object_name.GetCString() : "", 1240 m_object_name ? ")" : ""); 1241 1242 s->IndentMore(); 1243 1244 ObjectFile *objfile = GetObjectFile (); 1245 if (objfile) 1246 objfile->Dump(s); 1247 1248 SymbolVendor *symbols = GetSymbolVendor (); 1249 if (symbols) 1250 symbols->Dump(s); 1251 1252 s->IndentLess(); 1253 } 1254 1255 1256 TypeList* 1257 Module::GetTypeList () 1258 { 1259 SymbolVendor *symbols = GetSymbolVendor (); 1260 if (symbols) 1261 return &symbols->GetTypeList(); 1262 return NULL; 1263 } 1264 1265 const ConstString & 1266 Module::GetObjectName() const 1267 { 1268 return m_object_name; 1269 } 1270 1271 ObjectFile * 1272 Module::GetObjectFile() 1273 { 1274 if (m_did_load_objfile.load() == false) 1275 { 1276 Mutex::Locker locker (m_mutex); 1277 if (m_did_load_objfile.load() == false) 1278 { 1279 Timer scoped_timer(__PRETTY_FUNCTION__, 1280 "Module::GetObjectFile () module = %s", GetFileSpec().GetFilename().AsCString("")); 1281 DataBufferSP data_sp; 1282 lldb::offset_t data_offset = 0; 1283 const lldb::offset_t file_size = m_file.GetByteSize(); 1284 if (file_size > m_object_offset) 1285 { 1286 m_did_load_objfile = true; 1287 m_objfile_sp = ObjectFile::FindPlugin (shared_from_this(), 1288 &m_file, 1289 m_object_offset, 1290 file_size - m_object_offset, 1291 data_sp, 1292 data_offset); 1293 if (m_objfile_sp) 1294 { 1295 // Once we get the object file, update our module with the object file's 1296 // architecture since it might differ in vendor/os if some parts were 1297 // unknown. But since the matching arch might already be more specific 1298 // than the generic COFF architecture, only merge in those values that 1299 // overwrite unspecified unknown values. 1300 ArchSpec new_arch; 1301 m_objfile_sp->GetArchitecture(new_arch); 1302 m_arch.MergeFrom(new_arch); 1303 } 1304 else 1305 { 1306 ReportError ("failed to load objfile for %s", GetFileSpec().GetPath().c_str()); 1307 } 1308 } 1309 } 1310 } 1311 return m_objfile_sp.get(); 1312 } 1313 1314 SectionList * 1315 Module::GetSectionList() 1316 { 1317 // Populate m_unified_sections_ap with sections from objfile. 1318 if (m_sections_ap.get() == NULL) 1319 { 1320 ObjectFile *obj_file = GetObjectFile(); 1321 if (obj_file) 1322 obj_file->CreateSections(*GetUnifiedSectionList()); 1323 } 1324 return m_sections_ap.get(); 1325 } 1326 1327 void 1328 Module::SectionFileAddressesChanged () 1329 { 1330 ObjectFile *obj_file = GetObjectFile (); 1331 if (obj_file) 1332 obj_file->SectionFileAddressesChanged (); 1333 SymbolVendor* sym_vendor = GetSymbolVendor(); 1334 if (sym_vendor) 1335 sym_vendor->SectionFileAddressesChanged (); 1336 } 1337 1338 SectionList * 1339 Module::GetUnifiedSectionList() 1340 { 1341 // Populate m_unified_sections_ap with sections from objfile. 1342 if (m_sections_ap.get() == NULL) 1343 m_sections_ap.reset(new SectionList()); 1344 return m_sections_ap.get(); 1345 } 1346 1347 const Symbol * 1348 Module::FindFirstSymbolWithNameAndType (const ConstString &name, SymbolType symbol_type) 1349 { 1350 Timer scoped_timer(__PRETTY_FUNCTION__, 1351 "Module::FindFirstSymbolWithNameAndType (name = %s, type = %i)", 1352 name.AsCString(), 1353 symbol_type); 1354 SymbolVendor* sym_vendor = GetSymbolVendor(); 1355 if (sym_vendor) 1356 { 1357 Symtab *symtab = sym_vendor->GetSymtab(); 1358 if (symtab) 1359 return symtab->FindFirstSymbolWithNameAndType (name, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny); 1360 } 1361 return NULL; 1362 } 1363 void 1364 Module::SymbolIndicesToSymbolContextList (Symtab *symtab, std::vector<uint32_t> &symbol_indexes, SymbolContextList &sc_list) 1365 { 1366 // No need to protect this call using m_mutex all other method calls are 1367 // already thread safe. 1368 1369 size_t num_indices = symbol_indexes.size(); 1370 if (num_indices > 0) 1371 { 1372 SymbolContext sc; 1373 CalculateSymbolContext (&sc); 1374 for (size_t i = 0; i < num_indices; i++) 1375 { 1376 sc.symbol = symtab->SymbolAtIndex (symbol_indexes[i]); 1377 if (sc.symbol) 1378 sc_list.Append (sc); 1379 } 1380 } 1381 } 1382 1383 size_t 1384 Module::FindFunctionSymbols (const ConstString &name, 1385 uint32_t name_type_mask, 1386 SymbolContextList& sc_list) 1387 { 1388 Timer scoped_timer(__PRETTY_FUNCTION__, 1389 "Module::FindSymbolsFunctions (name = %s, mask = 0x%8.8x)", 1390 name.AsCString(), 1391 name_type_mask); 1392 SymbolVendor* sym_vendor = GetSymbolVendor(); 1393 if (sym_vendor) 1394 { 1395 Symtab *symtab = sym_vendor->GetSymtab(); 1396 if (symtab) 1397 return symtab->FindFunctionSymbols (name, name_type_mask, sc_list); 1398 } 1399 return 0; 1400 } 1401 1402 size_t 1403 Module::FindSymbolsWithNameAndType (const ConstString &name, SymbolType symbol_type, SymbolContextList &sc_list) 1404 { 1405 // No need to protect this call using m_mutex all other method calls are 1406 // already thread safe. 1407 1408 1409 Timer scoped_timer(__PRETTY_FUNCTION__, 1410 "Module::FindSymbolsWithNameAndType (name = %s, type = %i)", 1411 name.AsCString(), 1412 symbol_type); 1413 const size_t initial_size = sc_list.GetSize(); 1414 SymbolVendor* sym_vendor = GetSymbolVendor(); 1415 if (sym_vendor) 1416 { 1417 Symtab *symtab = sym_vendor->GetSymtab(); 1418 if (symtab) 1419 { 1420 std::vector<uint32_t> symbol_indexes; 1421 symtab->FindAllSymbolsWithNameAndType (name, symbol_type, symbol_indexes); 1422 SymbolIndicesToSymbolContextList (symtab, symbol_indexes, sc_list); 1423 } 1424 } 1425 return sc_list.GetSize() - initial_size; 1426 } 1427 1428 size_t 1429 Module::FindSymbolsMatchingRegExAndType (const RegularExpression ®ex, SymbolType symbol_type, SymbolContextList &sc_list) 1430 { 1431 // No need to protect this call using m_mutex all other method calls are 1432 // already thread safe. 1433 1434 Timer scoped_timer(__PRETTY_FUNCTION__, 1435 "Module::FindSymbolsMatchingRegExAndType (regex = %s, type = %i)", 1436 regex.GetText(), 1437 symbol_type); 1438 const size_t initial_size = sc_list.GetSize(); 1439 SymbolVendor* sym_vendor = GetSymbolVendor(); 1440 if (sym_vendor) 1441 { 1442 Symtab *symtab = sym_vendor->GetSymtab(); 1443 if (symtab) 1444 { 1445 std::vector<uint32_t> symbol_indexes; 1446 symtab->FindAllSymbolsMatchingRexExAndType (regex, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny, symbol_indexes); 1447 SymbolIndicesToSymbolContextList (symtab, symbol_indexes, sc_list); 1448 } 1449 } 1450 return sc_list.GetSize() - initial_size; 1451 } 1452 1453 void 1454 Module::SetSymbolFileFileSpec (const FileSpec &file) 1455 { 1456 if (!file.Exists()) 1457 return; 1458 if (m_symfile_ap) 1459 { 1460 // Remove any sections in the unified section list that come from the current symbol vendor. 1461 SectionList *section_list = GetSectionList(); 1462 SymbolFile *symbol_file = m_symfile_ap->GetSymbolFile(); 1463 if (section_list && symbol_file) 1464 { 1465 ObjectFile *obj_file = symbol_file->GetObjectFile(); 1466 // Make sure we have an object file and that the symbol vendor's objfile isn't 1467 // the same as the module's objfile before we remove any sections for it... 1468 if (obj_file) 1469 { 1470 // Check to make sure we aren't trying to specify the file we already have 1471 if (obj_file->GetFileSpec() == file) 1472 { 1473 // We are being told to add the exact same file that we already have 1474 // we don't have to do anything. 1475 return; 1476 } 1477 1478 // Cleare the current symtab as we are going to replace it with a new one 1479 obj_file->ClearSymtab(); 1480 1481 // The symbol file might be a directory bundle ("/tmp/a.out.dSYM") instead 1482 // of a full path to the symbol file within the bundle 1483 // ("/tmp/a.out.dSYM/Contents/Resources/DWARF/a.out"). So we need to check this 1484 1485 if (file.IsDirectory()) 1486 { 1487 std::string new_path(file.GetPath()); 1488 std::string old_path(obj_file->GetFileSpec().GetPath()); 1489 if (old_path.find(new_path) == 0) 1490 { 1491 // We specified the same bundle as the symbol file that we already have 1492 return; 1493 } 1494 } 1495 1496 if (obj_file != m_objfile_sp.get()) 1497 { 1498 size_t num_sections = section_list->GetNumSections (0); 1499 for (size_t idx = num_sections; idx > 0; --idx) 1500 { 1501 lldb::SectionSP section_sp (section_list->GetSectionAtIndex (idx - 1)); 1502 if (section_sp->GetObjectFile() == obj_file) 1503 { 1504 section_list->DeleteSection (idx - 1); 1505 } 1506 } 1507 } 1508 } 1509 } 1510 // Keep all old symbol files around in case there are any lingering type references in 1511 // any SBValue objects that might have been handed out. 1512 m_old_symfiles.push_back(std::move(m_symfile_ap)); 1513 } 1514 m_symfile_spec = file; 1515 m_symfile_ap.reset(); 1516 m_did_load_symbol_vendor = false; 1517 } 1518 1519 bool 1520 Module::IsExecutable () 1521 { 1522 if (GetObjectFile() == NULL) 1523 return false; 1524 else 1525 return GetObjectFile()->IsExecutable(); 1526 } 1527 1528 bool 1529 Module::IsLoadedInTarget (Target *target) 1530 { 1531 ObjectFile *obj_file = GetObjectFile(); 1532 if (obj_file) 1533 { 1534 SectionList *sections = GetSectionList(); 1535 if (sections != NULL) 1536 { 1537 size_t num_sections = sections->GetSize(); 1538 for (size_t sect_idx = 0; sect_idx < num_sections; sect_idx++) 1539 { 1540 SectionSP section_sp = sections->GetSectionAtIndex(sect_idx); 1541 if (section_sp->GetLoadBaseAddress(target) != LLDB_INVALID_ADDRESS) 1542 { 1543 return true; 1544 } 1545 } 1546 } 1547 } 1548 return false; 1549 } 1550 1551 bool 1552 Module::LoadScriptingResourceInTarget (Target *target, Error& error, Stream* feedback_stream) 1553 { 1554 if (!target) 1555 { 1556 error.SetErrorString("invalid destination Target"); 1557 return false; 1558 } 1559 1560 LoadScriptFromSymFile should_load = target->TargetProperties::GetLoadScriptFromSymbolFile(); 1561 1562 if (should_load == eLoadScriptFromSymFileFalse) 1563 return false; 1564 1565 Debugger &debugger = target->GetDebugger(); 1566 const ScriptLanguage script_language = debugger.GetScriptLanguage(); 1567 if (script_language != eScriptLanguageNone) 1568 { 1569 1570 PlatformSP platform_sp(target->GetPlatform()); 1571 1572 if (!platform_sp) 1573 { 1574 error.SetErrorString("invalid Platform"); 1575 return false; 1576 } 1577 1578 FileSpecList file_specs = platform_sp->LocateExecutableScriptingResources (target, 1579 *this, 1580 feedback_stream); 1581 1582 1583 const uint32_t num_specs = file_specs.GetSize(); 1584 if (num_specs) 1585 { 1586 ScriptInterpreter *script_interpreter = debugger.GetCommandInterpreter().GetScriptInterpreter(); 1587 if (script_interpreter) 1588 { 1589 for (uint32_t i=0; i<num_specs; ++i) 1590 { 1591 FileSpec scripting_fspec (file_specs.GetFileSpecAtIndex(i)); 1592 if (scripting_fspec && scripting_fspec.Exists()) 1593 { 1594 if (should_load == eLoadScriptFromSymFileWarn) 1595 { 1596 if (feedback_stream) 1597 feedback_stream->Printf("warning: '%s' contains a debug script. To run this script in " 1598 "this debug session:\n\n command script import \"%s\"\n\n" 1599 "To run all discovered debug scripts in this session:\n\n" 1600 " settings set target.load-script-from-symbol-file true\n", 1601 GetFileSpec().GetFileNameStrippingExtension().GetCString(), 1602 scripting_fspec.GetPath().c_str()); 1603 return false; 1604 } 1605 StreamString scripting_stream; 1606 scripting_fspec.Dump(&scripting_stream); 1607 const bool can_reload = true; 1608 const bool init_lldb_globals = false; 1609 bool did_load = script_interpreter->LoadScriptingModule(scripting_stream.GetData(), 1610 can_reload, 1611 init_lldb_globals, 1612 error); 1613 if (!did_load) 1614 return false; 1615 } 1616 } 1617 } 1618 else 1619 { 1620 error.SetErrorString("invalid ScriptInterpreter"); 1621 return false; 1622 } 1623 } 1624 } 1625 return true; 1626 } 1627 1628 bool 1629 Module::SetArchitecture (const ArchSpec &new_arch) 1630 { 1631 if (!m_arch.IsValid()) 1632 { 1633 m_arch = new_arch; 1634 return true; 1635 } 1636 return m_arch.IsCompatibleMatch(new_arch); 1637 } 1638 1639 bool 1640 Module::SetLoadAddress (Target &target, lldb::addr_t value, bool value_is_offset, bool &changed) 1641 { 1642 ObjectFile *object_file = GetObjectFile(); 1643 if (object_file) 1644 { 1645 changed = object_file->SetLoadAddress(target, value, value_is_offset); 1646 return true; 1647 } 1648 else 1649 { 1650 changed = false; 1651 } 1652 return false; 1653 } 1654 1655 1656 bool 1657 Module::MatchesModuleSpec (const ModuleSpec &module_ref) 1658 { 1659 const UUID &uuid = module_ref.GetUUID(); 1660 1661 if (uuid.IsValid()) 1662 { 1663 // If the UUID matches, then nothing more needs to match... 1664 if (uuid == GetUUID()) 1665 return true; 1666 else 1667 return false; 1668 } 1669 1670 const FileSpec &file_spec = module_ref.GetFileSpec(); 1671 if (file_spec) 1672 { 1673 if (!FileSpec::Equal (file_spec, m_file, (bool)file_spec.GetDirectory()) && 1674 !FileSpec::Equal (file_spec, m_platform_file, (bool)file_spec.GetDirectory())) 1675 return false; 1676 } 1677 1678 const FileSpec &platform_file_spec = module_ref.GetPlatformFileSpec(); 1679 if (platform_file_spec) 1680 { 1681 if (!FileSpec::Equal (platform_file_spec, GetPlatformFileSpec (), (bool)platform_file_spec.GetDirectory())) 1682 return false; 1683 } 1684 1685 const ArchSpec &arch = module_ref.GetArchitecture(); 1686 if (arch.IsValid()) 1687 { 1688 if (!m_arch.IsCompatibleMatch(arch)) 1689 return false; 1690 } 1691 1692 const ConstString &object_name = module_ref.GetObjectName(); 1693 if (object_name) 1694 { 1695 if (object_name != GetObjectName()) 1696 return false; 1697 } 1698 return true; 1699 } 1700 1701 bool 1702 Module::FindSourceFile (const FileSpec &orig_spec, FileSpec &new_spec) const 1703 { 1704 Mutex::Locker locker (m_mutex); 1705 return m_source_mappings.FindFile (orig_spec, new_spec); 1706 } 1707 1708 bool 1709 Module::RemapSourceFile (const char *path, std::string &new_path) const 1710 { 1711 Mutex::Locker locker (m_mutex); 1712 return m_source_mappings.RemapPath(path, new_path); 1713 } 1714 1715 uint32_t 1716 Module::GetVersion (uint32_t *versions, uint32_t num_versions) 1717 { 1718 ObjectFile *obj_file = GetObjectFile(); 1719 if (obj_file) 1720 return obj_file->GetVersion (versions, num_versions); 1721 1722 if (versions && num_versions) 1723 { 1724 for (uint32_t i=0; i<num_versions; ++i) 1725 versions[i] = LLDB_INVALID_MODULE_VERSION; 1726 } 1727 return 0; 1728 } 1729 1730 void 1731 Module::PrepareForFunctionNameLookup (const ConstString &name, 1732 uint32_t name_type_mask, 1733 LanguageType language, 1734 ConstString &lookup_name, 1735 uint32_t &lookup_name_type_mask, 1736 bool &match_name_after_lookup) 1737 { 1738 const char *name_cstr = name.GetCString(); 1739 lookup_name_type_mask = eFunctionNameTypeNone; 1740 match_name_after_lookup = false; 1741 1742 llvm::StringRef basename; 1743 llvm::StringRef context; 1744 1745 if (name_type_mask & eFunctionNameTypeAuto) 1746 { 1747 if (CPlusPlusLanguage::IsCPPMangledName (name_cstr)) 1748 lookup_name_type_mask = eFunctionNameTypeFull; 1749 else if ((language == eLanguageTypeUnknown || 1750 Language::LanguageIsObjC(language)) && 1751 ObjCLanguage::IsPossibleObjCMethodName (name_cstr)) 1752 lookup_name_type_mask = eFunctionNameTypeFull; 1753 else if (Language::LanguageIsC(language)) 1754 { 1755 lookup_name_type_mask = eFunctionNameTypeFull; 1756 } 1757 else 1758 { 1759 if ((language == eLanguageTypeUnknown || 1760 Language::LanguageIsObjC(language)) && 1761 ObjCLanguage::IsPossibleObjCSelector(name_cstr)) 1762 lookup_name_type_mask |= eFunctionNameTypeSelector; 1763 1764 CPlusPlusLanguage::MethodName cpp_method (name); 1765 basename = cpp_method.GetBasename(); 1766 if (basename.empty()) 1767 { 1768 if (CPlusPlusLanguage::ExtractContextAndIdentifier (name_cstr, context, basename)) 1769 lookup_name_type_mask |= (eFunctionNameTypeMethod | eFunctionNameTypeBase); 1770 else 1771 lookup_name_type_mask |= eFunctionNameTypeFull; 1772 } 1773 else 1774 { 1775 lookup_name_type_mask |= (eFunctionNameTypeMethod | eFunctionNameTypeBase); 1776 } 1777 } 1778 } 1779 else 1780 { 1781 lookup_name_type_mask = name_type_mask; 1782 if (lookup_name_type_mask & eFunctionNameTypeMethod || name_type_mask & eFunctionNameTypeBase) 1783 { 1784 // If they've asked for a CPP method or function name and it can't be that, we don't 1785 // even need to search for CPP methods or names. 1786 CPlusPlusLanguage::MethodName cpp_method (name); 1787 if (cpp_method.IsValid()) 1788 { 1789 basename = cpp_method.GetBasename(); 1790 1791 if (!cpp_method.GetQualifiers().empty()) 1792 { 1793 // There is a "const" or other qualifier following the end of the function parens, 1794 // this can't be a eFunctionNameTypeBase 1795 lookup_name_type_mask &= ~(eFunctionNameTypeBase); 1796 if (lookup_name_type_mask == eFunctionNameTypeNone) 1797 return; 1798 } 1799 } 1800 else 1801 { 1802 // If the CPP method parser didn't manage to chop this up, try to fill in the base name if we can. 1803 // If a::b::c is passed in, we need to just look up "c", and then we'll filter the result later. 1804 CPlusPlusLanguage::ExtractContextAndIdentifier (name_cstr, context, basename); 1805 } 1806 } 1807 1808 if (lookup_name_type_mask & eFunctionNameTypeSelector) 1809 { 1810 if (!ObjCLanguage::IsPossibleObjCSelector(name_cstr)) 1811 { 1812 lookup_name_type_mask &= ~(eFunctionNameTypeSelector); 1813 if (lookup_name_type_mask == eFunctionNameTypeNone) 1814 return; 1815 } 1816 } 1817 } 1818 1819 if (!basename.empty()) 1820 { 1821 // The name supplied was a partial C++ path like "a::count". In this case we want to do a 1822 // lookup on the basename "count" and then make sure any matching results contain "a::count" 1823 // so that it would match "b::a::count" and "a::count". This is why we set "match_name_after_lookup" 1824 // to true 1825 lookup_name.SetString(basename); 1826 match_name_after_lookup = true; 1827 } 1828 else 1829 { 1830 // The name is already correct, just use the exact name as supplied, and we won't need 1831 // to check if any matches contain "name" 1832 lookup_name = name; 1833 match_name_after_lookup = false; 1834 } 1835 } 1836 1837 ModuleSP 1838 Module::CreateJITModule (const lldb::ObjectFileJITDelegateSP &delegate_sp) 1839 { 1840 if (delegate_sp) 1841 { 1842 // Must create a module and place it into a shared pointer before 1843 // we can create an object file since it has a std::weak_ptr back 1844 // to the module, so we need to control the creation carefully in 1845 // this static function 1846 ModuleSP module_sp(new Module()); 1847 module_sp->m_objfile_sp.reset (new ObjectFileJIT (module_sp, delegate_sp)); 1848 if (module_sp->m_objfile_sp) 1849 { 1850 // Once we get the object file, update our module with the object file's 1851 // architecture since it might differ in vendor/os if some parts were 1852 // unknown. 1853 module_sp->m_objfile_sp->GetArchitecture (module_sp->m_arch); 1854 } 1855 return module_sp; 1856 } 1857 return ModuleSP(); 1858 } 1859 1860 bool 1861 Module::GetIsDynamicLinkEditor() 1862 { 1863 ObjectFile * obj_file = GetObjectFile (); 1864 1865 if (obj_file) 1866 return obj_file->GetIsDynamicLinkEditor(); 1867 1868 return false; 1869 } 1870