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 Symbol *matching_symbol = nullptr; 563 564 symtab->ForEachSymbolContainingFileAddress(so_addr.GetFileAddress(), 565 [&matching_symbol](Symbol *symbol) -> bool { 566 if (symbol->GetType() != eSymbolTypeInvalid) 567 { 568 matching_symbol = symbol; 569 return false; // Stop iterating 570 } 571 return true; // Keep iterating 572 }); 573 sc.symbol = matching_symbol; 574 if (!sc.symbol && 575 resolve_scope & eSymbolContextFunction && !(resolved_flags & eSymbolContextFunction)) 576 { 577 bool verify_unique = false; // No need to check again since ResolveSymbolContext failed to find a symbol at this address. 578 if (ObjectFile *obj_file = sc.module_sp->GetObjectFile()) 579 sc.symbol = obj_file->ResolveSymbolForAddress(so_addr, verify_unique); 580 } 581 582 if (sc.symbol) 583 { 584 if (sc.symbol->IsSynthetic()) 585 { 586 // We have a synthetic symbol so lets check if the object file 587 // from the symbol file in the symbol vendor is different than 588 // the object file for the module, and if so search its symbol 589 // table to see if we can come up with a better symbol. For example 590 // dSYM files on MacOSX have an unstripped symbol table inside of 591 // them. 592 ObjectFile *symtab_objfile = symtab->GetObjectFile(); 593 if (symtab_objfile && symtab_objfile->IsStripped()) 594 { 595 SymbolFile *symfile = sym_vendor->GetSymbolFile(); 596 if (symfile) 597 { 598 ObjectFile *symfile_objfile = symfile->GetObjectFile(); 599 if (symfile_objfile != symtab_objfile) 600 { 601 Symtab *symfile_symtab = symfile_objfile->GetSymtab(); 602 if (symfile_symtab) 603 { 604 Symbol *symbol = symfile_symtab->FindSymbolContainingFileAddress(so_addr.GetFileAddress()); 605 if (symbol && !symbol->IsSynthetic()) 606 { 607 sc.symbol = symbol; 608 } 609 } 610 } 611 } 612 } 613 } 614 resolved_flags |= eSymbolContextSymbol; 615 } 616 } 617 } 618 619 // For function symbols, so_addr may be off by one. This is a convention consistent 620 // with FDE row indices in eh_frame sections, but requires extra logic here to permit 621 // symbol lookup for disassembly and unwind. 622 if (resolve_scope & eSymbolContextSymbol && !(resolved_flags & eSymbolContextSymbol) && 623 resolve_tail_call_address && so_addr.IsSectionOffset()) 624 { 625 Address previous_addr = so_addr; 626 previous_addr.Slide(-1); 627 628 bool do_resolve_tail_call_address = false; // prevent recursion 629 const uint32_t flags = ResolveSymbolContextForAddress(previous_addr, resolve_scope, sc, 630 do_resolve_tail_call_address); 631 if (flags & eSymbolContextSymbol) 632 { 633 AddressRange addr_range; 634 if (sc.GetAddressRange (eSymbolContextFunction | eSymbolContextSymbol, 0, false, addr_range)) 635 { 636 if (addr_range.GetBaseAddress().GetSection() == so_addr.GetSection()) 637 { 638 // If the requested address is one past the address range of a function (i.e. a tail call), 639 // or the decremented address is the start of a function (i.e. some forms of trampoline), 640 // indicate that the symbol has been resolved. 641 if (so_addr.GetOffset() == addr_range.GetBaseAddress().GetOffset() || 642 so_addr.GetOffset() == addr_range.GetBaseAddress().GetOffset() + addr_range.GetByteSize()) 643 { 644 resolved_flags |= flags; 645 } 646 } 647 else 648 { 649 sc.symbol = nullptr; // Don't trust the symbol if the sections didn't match. 650 } 651 } 652 } 653 } 654 } 655 return resolved_flags; 656 } 657 658 uint32_t 659 Module::ResolveSymbolContextForFilePath 660 ( 661 const char *file_path, 662 uint32_t line, 663 bool check_inlines, 664 uint32_t resolve_scope, 665 SymbolContextList& sc_list 666 ) 667 { 668 FileSpec file_spec(file_path, false); 669 return ResolveSymbolContextsForFileSpec (file_spec, line, check_inlines, resolve_scope, sc_list); 670 } 671 672 uint32_t 673 Module::ResolveSymbolContextsForFileSpec (const FileSpec &file_spec, uint32_t line, bool check_inlines, uint32_t resolve_scope, SymbolContextList& sc_list) 674 { 675 Mutex::Locker locker (m_mutex); 676 Timer scoped_timer(__PRETTY_FUNCTION__, 677 "Module::ResolveSymbolContextForFilePath (%s:%u, check_inlines = %s, resolve_scope = 0x%8.8x)", 678 file_spec.GetPath().c_str(), 679 line, 680 check_inlines ? "yes" : "no", 681 resolve_scope); 682 683 const uint32_t initial_count = sc_list.GetSize(); 684 685 SymbolVendor *symbols = GetSymbolVendor (); 686 if (symbols) 687 symbols->ResolveSymbolContext (file_spec, line, check_inlines, resolve_scope, sc_list); 688 689 return sc_list.GetSize() - initial_count; 690 } 691 692 693 size_t 694 Module::FindGlobalVariables (const ConstString &name, 695 const CompilerDeclContext *parent_decl_ctx, 696 bool append, 697 size_t max_matches, 698 VariableList& variables) 699 { 700 SymbolVendor *symbols = GetSymbolVendor (); 701 if (symbols) 702 return symbols->FindGlobalVariables(name, parent_decl_ctx, append, max_matches, variables); 703 return 0; 704 } 705 706 size_t 707 Module::FindGlobalVariables (const RegularExpression& regex, 708 bool append, 709 size_t max_matches, 710 VariableList& variables) 711 { 712 SymbolVendor *symbols = GetSymbolVendor (); 713 if (symbols) 714 return symbols->FindGlobalVariables(regex, append, max_matches, variables); 715 return 0; 716 } 717 718 size_t 719 Module::FindCompileUnits (const FileSpec &path, 720 bool append, 721 SymbolContextList &sc_list) 722 { 723 if (!append) 724 sc_list.Clear(); 725 726 const size_t start_size = sc_list.GetSize(); 727 const size_t num_compile_units = GetNumCompileUnits(); 728 SymbolContext sc; 729 sc.module_sp = shared_from_this(); 730 const bool compare_directory = (bool)path.GetDirectory(); 731 for (size_t i=0; i<num_compile_units; ++i) 732 { 733 sc.comp_unit = GetCompileUnitAtIndex(i).get(); 734 if (sc.comp_unit) 735 { 736 if (FileSpec::Equal (*sc.comp_unit, path, compare_directory)) 737 sc_list.Append(sc); 738 } 739 } 740 return sc_list.GetSize() - start_size; 741 } 742 743 size_t 744 Module::FindFunctions (const ConstString &name, 745 const CompilerDeclContext *parent_decl_ctx, 746 uint32_t name_type_mask, 747 bool include_symbols, 748 bool include_inlines, 749 bool append, 750 SymbolContextList& sc_list) 751 { 752 if (!append) 753 sc_list.Clear(); 754 755 const size_t old_size = sc_list.GetSize(); 756 757 // Find all the functions (not symbols, but debug information functions... 758 SymbolVendor *symbols = GetSymbolVendor (); 759 760 if (name_type_mask & eFunctionNameTypeAuto) 761 { 762 ConstString lookup_name; 763 uint32_t lookup_name_type_mask = 0; 764 bool match_name_after_lookup = false; 765 Module::PrepareForFunctionNameLookup (name, 766 name_type_mask, 767 eLanguageTypeUnknown, // TODO: add support 768 lookup_name, 769 lookup_name_type_mask, 770 match_name_after_lookup); 771 772 if (symbols) 773 { 774 symbols->FindFunctions(lookup_name, 775 parent_decl_ctx, 776 lookup_name_type_mask, 777 include_inlines, 778 append, 779 sc_list); 780 781 // Now check our symbol table for symbols that are code symbols if requested 782 if (include_symbols) 783 { 784 Symtab *symtab = symbols->GetSymtab(); 785 if (symtab) 786 symtab->FindFunctionSymbols(lookup_name, lookup_name_type_mask, sc_list); 787 } 788 } 789 790 if (match_name_after_lookup) 791 { 792 SymbolContext sc; 793 size_t i = old_size; 794 while (i<sc_list.GetSize()) 795 { 796 if (sc_list.GetContextAtIndex(i, sc)) 797 { 798 const char *func_name = sc.GetFunctionName().GetCString(); 799 if (func_name && strstr (func_name, name.GetCString()) == NULL) 800 { 801 // Remove the current context 802 sc_list.RemoveContextAtIndex(i); 803 // Don't increment i and continue in the loop 804 continue; 805 } 806 } 807 ++i; 808 } 809 } 810 } 811 else 812 { 813 if (symbols) 814 { 815 symbols->FindFunctions(name, parent_decl_ctx, name_type_mask, include_inlines, append, sc_list); 816 817 // Now check our symbol table for symbols that are code symbols if requested 818 if (include_symbols) 819 { 820 Symtab *symtab = symbols->GetSymtab(); 821 if (symtab) 822 symtab->FindFunctionSymbols(name, name_type_mask, sc_list); 823 } 824 } 825 } 826 827 return sc_list.GetSize() - old_size; 828 } 829 830 size_t 831 Module::FindFunctions (const RegularExpression& regex, 832 bool include_symbols, 833 bool include_inlines, 834 bool append, 835 SymbolContextList& sc_list) 836 { 837 if (!append) 838 sc_list.Clear(); 839 840 const size_t start_size = sc_list.GetSize(); 841 842 SymbolVendor *symbols = GetSymbolVendor (); 843 if (symbols) 844 { 845 symbols->FindFunctions(regex, include_inlines, append, sc_list); 846 847 // Now check our symbol table for symbols that are code symbols if requested 848 if (include_symbols) 849 { 850 Symtab *symtab = symbols->GetSymtab(); 851 if (symtab) 852 { 853 std::vector<uint32_t> symbol_indexes; 854 symtab->AppendSymbolIndexesMatchingRegExAndType (regex, eSymbolTypeAny, Symtab::eDebugAny, Symtab::eVisibilityAny, symbol_indexes); 855 const size_t num_matches = symbol_indexes.size(); 856 if (num_matches) 857 { 858 SymbolContext sc(this); 859 const size_t end_functions_added_index = sc_list.GetSize(); 860 size_t num_functions_added_to_sc_list = end_functions_added_index - start_size; 861 if (num_functions_added_to_sc_list == 0) 862 { 863 // No functions were added, just symbols, so we can just append them 864 for (size_t i=0; i<num_matches; ++i) 865 { 866 sc.symbol = symtab->SymbolAtIndex(symbol_indexes[i]); 867 SymbolType sym_type = sc.symbol->GetType(); 868 if (sc.symbol && (sym_type == eSymbolTypeCode || 869 sym_type == eSymbolTypeResolver)) 870 sc_list.Append(sc); 871 } 872 } 873 else 874 { 875 typedef std::map<lldb::addr_t, uint32_t> FileAddrToIndexMap; 876 FileAddrToIndexMap file_addr_to_index; 877 for (size_t i=start_size; i<end_functions_added_index; ++i) 878 { 879 const SymbolContext &sc = sc_list[i]; 880 if (sc.block) 881 continue; 882 file_addr_to_index[sc.function->GetAddressRange().GetBaseAddress().GetFileAddress()] = i; 883 } 884 885 FileAddrToIndexMap::const_iterator end = file_addr_to_index.end(); 886 // Functions were added so we need to merge symbols into any 887 // existing function symbol contexts 888 for (size_t i=start_size; i<num_matches; ++i) 889 { 890 sc.symbol = symtab->SymbolAtIndex(symbol_indexes[i]); 891 SymbolType sym_type = sc.symbol->GetType(); 892 if (sc.symbol && sc.symbol->ValueIsAddress() && (sym_type == eSymbolTypeCode || sym_type == eSymbolTypeResolver)) 893 { 894 FileAddrToIndexMap::const_iterator pos = file_addr_to_index.find(sc.symbol->GetAddressRef().GetFileAddress()); 895 if (pos == end) 896 sc_list.Append(sc); 897 else 898 sc_list[pos->second].symbol = sc.symbol; 899 } 900 } 901 } 902 } 903 } 904 } 905 } 906 return sc_list.GetSize() - start_size; 907 } 908 909 void 910 Module::FindAddressesForLine (const lldb::TargetSP target_sp, 911 const FileSpec &file, uint32_t line, 912 Function *function, 913 std::vector<Address> &output_local, std::vector<Address> &output_extern) 914 { 915 SearchFilterByModule filter(target_sp, m_file); 916 AddressResolverFileLine resolver(file, line, true); 917 resolver.ResolveAddress (filter); 918 919 for (size_t n=0;n<resolver.GetNumberOfAddresses();n++) 920 { 921 Address addr = resolver.GetAddressRangeAtIndex(n).GetBaseAddress(); 922 Function *f = addr.CalculateSymbolContextFunction(); 923 if (f && f == function) 924 output_local.push_back (addr); 925 else 926 output_extern.push_back (addr); 927 } 928 } 929 930 size_t 931 Module::FindTypes_Impl (const SymbolContext& sc, 932 const ConstString &name, 933 const CompilerDeclContext *parent_decl_ctx, 934 bool append, 935 size_t max_matches, 936 TypeMap& types) 937 { 938 Timer scoped_timer(__PRETTY_FUNCTION__, __PRETTY_FUNCTION__); 939 if (sc.module_sp.get() == NULL || sc.module_sp.get() == this) 940 { 941 SymbolVendor *symbols = GetSymbolVendor (); 942 if (symbols) 943 return symbols->FindTypes(sc, name, parent_decl_ctx, append, max_matches, types); 944 } 945 return 0; 946 } 947 948 size_t 949 Module::FindTypesInNamespace (const SymbolContext& sc, 950 const ConstString &type_name, 951 const CompilerDeclContext *parent_decl_ctx, 952 size_t max_matches, 953 TypeList& type_list) 954 { 955 const bool append = true; 956 TypeMap types_map; 957 size_t num_types = FindTypes_Impl(sc, type_name, parent_decl_ctx, append, max_matches, types_map); 958 if (num_types > 0) 959 sc.SortTypeList(types_map, type_list); 960 return num_types; 961 } 962 963 lldb::TypeSP 964 Module::FindFirstType (const SymbolContext& sc, 965 const ConstString &name, 966 bool exact_match) 967 { 968 TypeList type_list; 969 const size_t num_matches = FindTypes (sc, name, exact_match, 1, type_list); 970 if (num_matches) 971 return type_list.GetTypeAtIndex(0); 972 return TypeSP(); 973 } 974 975 976 size_t 977 Module::FindTypes (const SymbolContext& sc, 978 const ConstString &name, 979 bool exact_match, 980 size_t max_matches, 981 TypeList& types) 982 { 983 size_t num_matches = 0; 984 const char *type_name_cstr = name.GetCString(); 985 std::string type_scope; 986 std::string type_basename; 987 const bool append = true; 988 TypeClass type_class = eTypeClassAny; 989 TypeMap typesmap; 990 if (Type::GetTypeScopeAndBasename (type_name_cstr, type_scope, type_basename, type_class)) 991 { 992 // Check if "name" starts with "::" which means the qualified type starts 993 // from the root namespace and implies and exact match. The typenames we 994 // get back from clang do not start with "::" so we need to strip this off 995 // in order to get the qualified names to match 996 997 if (type_scope.size() >= 2 && type_scope[0] == ':' && type_scope[1] == ':') 998 { 999 type_scope.erase(0,2); 1000 exact_match = true; 1001 } 1002 ConstString type_basename_const_str (type_basename.c_str()); 1003 if (FindTypes_Impl(sc, type_basename_const_str, NULL, append, max_matches, typesmap)) 1004 { 1005 typesmap.RemoveMismatchedTypes (type_scope, type_basename, type_class, exact_match); 1006 num_matches = typesmap.GetSize(); 1007 } 1008 } 1009 else 1010 { 1011 // The type is not in a namespace/class scope, just search for it by basename 1012 if (type_class != eTypeClassAny) 1013 { 1014 // The "type_name_cstr" will have been modified if we have a valid type class 1015 // prefix (like "struct", "class", "union", "typedef" etc). 1016 FindTypes_Impl(sc, ConstString(type_name_cstr), NULL, append, max_matches, typesmap); 1017 typesmap.RemoveMismatchedTypes (type_class); 1018 num_matches = typesmap.GetSize(); 1019 } 1020 else 1021 { 1022 num_matches = FindTypes_Impl(sc, name, NULL, append, max_matches, typesmap); 1023 } 1024 } 1025 if (num_matches > 0) 1026 sc.SortTypeList(typesmap, types); 1027 return num_matches; 1028 } 1029 1030 SymbolVendor* 1031 Module::GetSymbolVendor (bool can_create, lldb_private::Stream *feedback_strm) 1032 { 1033 if (m_did_load_symbol_vendor.load() == false) 1034 { 1035 Mutex::Locker locker (m_mutex); 1036 if (m_did_load_symbol_vendor.load() == false && can_create) 1037 { 1038 ObjectFile *obj_file = GetObjectFile (); 1039 if (obj_file != NULL) 1040 { 1041 Timer scoped_timer(__PRETTY_FUNCTION__, __PRETTY_FUNCTION__); 1042 m_symfile_ap.reset(SymbolVendor::FindPlugin(shared_from_this(), feedback_strm)); 1043 m_did_load_symbol_vendor = true; 1044 } 1045 } 1046 } 1047 return m_symfile_ap.get(); 1048 } 1049 1050 void 1051 Module::SetFileSpecAndObjectName (const FileSpec &file, const ConstString &object_name) 1052 { 1053 // Container objects whose paths do not specify a file directly can call 1054 // this function to correct the file and object names. 1055 m_file = file; 1056 m_mod_time = file.GetModificationTime(); 1057 m_object_name = object_name; 1058 } 1059 1060 const ArchSpec& 1061 Module::GetArchitecture () const 1062 { 1063 return m_arch; 1064 } 1065 1066 std::string 1067 Module::GetSpecificationDescription () const 1068 { 1069 std::string spec(GetFileSpec().GetPath()); 1070 if (m_object_name) 1071 { 1072 spec += '('; 1073 spec += m_object_name.GetCString(); 1074 spec += ')'; 1075 } 1076 return spec; 1077 } 1078 1079 void 1080 Module::GetDescription (Stream *s, lldb::DescriptionLevel level) 1081 { 1082 Mutex::Locker locker (m_mutex); 1083 1084 if (level >= eDescriptionLevelFull) 1085 { 1086 if (m_arch.IsValid()) 1087 s->Printf("(%s) ", m_arch.GetArchitectureName()); 1088 } 1089 1090 if (level == eDescriptionLevelBrief) 1091 { 1092 const char *filename = m_file.GetFilename().GetCString(); 1093 if (filename) 1094 s->PutCString (filename); 1095 } 1096 else 1097 { 1098 char path[PATH_MAX]; 1099 if (m_file.GetPath(path, sizeof(path))) 1100 s->PutCString(path); 1101 } 1102 1103 const char *object_name = m_object_name.GetCString(); 1104 if (object_name) 1105 s->Printf("(%s)", object_name); 1106 } 1107 1108 void 1109 Module::ReportError (const char *format, ...) 1110 { 1111 if (format && format[0]) 1112 { 1113 StreamString strm; 1114 strm.PutCString("error: "); 1115 GetDescription(&strm, lldb::eDescriptionLevelBrief); 1116 strm.PutChar (' '); 1117 va_list args; 1118 va_start (args, format); 1119 strm.PrintfVarArg(format, args); 1120 va_end (args); 1121 1122 const int format_len = strlen(format); 1123 if (format_len > 0) 1124 { 1125 const char last_char = format[format_len-1]; 1126 if (last_char != '\n' || last_char != '\r') 1127 strm.EOL(); 1128 } 1129 Host::SystemLog (Host::eSystemLogError, "%s", strm.GetString().c_str()); 1130 1131 } 1132 } 1133 1134 bool 1135 Module::FileHasChanged () const 1136 { 1137 if (m_file_has_changed == false) 1138 m_file_has_changed = (m_file.GetModificationTime() != m_mod_time); 1139 return m_file_has_changed; 1140 } 1141 1142 void 1143 Module::ReportErrorIfModifyDetected (const char *format, ...) 1144 { 1145 if (m_first_file_changed_log == false) 1146 { 1147 if (FileHasChanged ()) 1148 { 1149 m_first_file_changed_log = true; 1150 if (format) 1151 { 1152 StreamString strm; 1153 strm.PutCString("error: the object file "); 1154 GetDescription(&strm, lldb::eDescriptionLevelFull); 1155 strm.PutCString (" has been modified\n"); 1156 1157 va_list args; 1158 va_start (args, format); 1159 strm.PrintfVarArg(format, args); 1160 va_end (args); 1161 1162 const int format_len = strlen(format); 1163 if (format_len > 0) 1164 { 1165 const char last_char = format[format_len-1]; 1166 if (last_char != '\n' || last_char != '\r') 1167 strm.EOL(); 1168 } 1169 strm.PutCString("The debug session should be aborted as the original debug information has been overwritten.\n"); 1170 Host::SystemLog (Host::eSystemLogError, "%s", strm.GetString().c_str()); 1171 } 1172 } 1173 } 1174 } 1175 1176 void 1177 Module::ReportWarning (const char *format, ...) 1178 { 1179 if (format && format[0]) 1180 { 1181 StreamString strm; 1182 strm.PutCString("warning: "); 1183 GetDescription(&strm, lldb::eDescriptionLevelFull); 1184 strm.PutChar (' '); 1185 1186 va_list args; 1187 va_start (args, format); 1188 strm.PrintfVarArg(format, args); 1189 va_end (args); 1190 1191 const int format_len = strlen(format); 1192 if (format_len > 0) 1193 { 1194 const char last_char = format[format_len-1]; 1195 if (last_char != '\n' || last_char != '\r') 1196 strm.EOL(); 1197 } 1198 Host::SystemLog (Host::eSystemLogWarning, "%s", strm.GetString().c_str()); 1199 } 1200 } 1201 1202 void 1203 Module::LogMessage (Log *log, const char *format, ...) 1204 { 1205 if (log) 1206 { 1207 StreamString log_message; 1208 GetDescription(&log_message, lldb::eDescriptionLevelFull); 1209 log_message.PutCString (": "); 1210 va_list args; 1211 va_start (args, format); 1212 log_message.PrintfVarArg (format, args); 1213 va_end (args); 1214 log->PutCString(log_message.GetString().c_str()); 1215 } 1216 } 1217 1218 void 1219 Module::LogMessageVerboseBacktrace (Log *log, const char *format, ...) 1220 { 1221 if (log) 1222 { 1223 StreamString log_message; 1224 GetDescription(&log_message, lldb::eDescriptionLevelFull); 1225 log_message.PutCString (": "); 1226 va_list args; 1227 va_start (args, format); 1228 log_message.PrintfVarArg (format, args); 1229 va_end (args); 1230 if (log->GetVerbose()) 1231 { 1232 std::string back_trace; 1233 llvm::raw_string_ostream stream(back_trace); 1234 llvm::sys::PrintStackTrace(stream); 1235 log_message.PutCString(back_trace.c_str()); 1236 } 1237 log->PutCString(log_message.GetString().c_str()); 1238 } 1239 } 1240 1241 void 1242 Module::Dump(Stream *s) 1243 { 1244 Mutex::Locker locker (m_mutex); 1245 //s->Printf("%.*p: ", (int)sizeof(void*) * 2, this); 1246 s->Indent(); 1247 s->Printf("Module %s%s%s%s\n", 1248 m_file.GetPath().c_str(), 1249 m_object_name ? "(" : "", 1250 m_object_name ? m_object_name.GetCString() : "", 1251 m_object_name ? ")" : ""); 1252 1253 s->IndentMore(); 1254 1255 ObjectFile *objfile = GetObjectFile (); 1256 if (objfile) 1257 objfile->Dump(s); 1258 1259 SymbolVendor *symbols = GetSymbolVendor (); 1260 if (symbols) 1261 symbols->Dump(s); 1262 1263 s->IndentLess(); 1264 } 1265 1266 1267 TypeList* 1268 Module::GetTypeList () 1269 { 1270 SymbolVendor *symbols = GetSymbolVendor (); 1271 if (symbols) 1272 return &symbols->GetTypeList(); 1273 return NULL; 1274 } 1275 1276 const ConstString & 1277 Module::GetObjectName() const 1278 { 1279 return m_object_name; 1280 } 1281 1282 ObjectFile * 1283 Module::GetObjectFile() 1284 { 1285 if (m_did_load_objfile.load() == false) 1286 { 1287 Mutex::Locker locker (m_mutex); 1288 if (m_did_load_objfile.load() == false) 1289 { 1290 Timer scoped_timer(__PRETTY_FUNCTION__, 1291 "Module::GetObjectFile () module = %s", GetFileSpec().GetFilename().AsCString("")); 1292 DataBufferSP data_sp; 1293 lldb::offset_t data_offset = 0; 1294 const lldb::offset_t file_size = m_file.GetByteSize(); 1295 if (file_size > m_object_offset) 1296 { 1297 m_did_load_objfile = true; 1298 m_objfile_sp = ObjectFile::FindPlugin (shared_from_this(), 1299 &m_file, 1300 m_object_offset, 1301 file_size - m_object_offset, 1302 data_sp, 1303 data_offset); 1304 if (m_objfile_sp) 1305 { 1306 // Once we get the object file, update our module with the object file's 1307 // architecture since it might differ in vendor/os if some parts were 1308 // unknown. But since the matching arch might already be more specific 1309 // than the generic COFF architecture, only merge in those values that 1310 // overwrite unspecified unknown values. 1311 ArchSpec new_arch; 1312 m_objfile_sp->GetArchitecture(new_arch); 1313 m_arch.MergeFrom(new_arch); 1314 } 1315 else 1316 { 1317 ReportError ("failed to load objfile for %s", GetFileSpec().GetPath().c_str()); 1318 } 1319 } 1320 } 1321 } 1322 return m_objfile_sp.get(); 1323 } 1324 1325 SectionList * 1326 Module::GetSectionList() 1327 { 1328 // Populate m_unified_sections_ap with sections from objfile. 1329 if (m_sections_ap.get() == NULL) 1330 { 1331 ObjectFile *obj_file = GetObjectFile(); 1332 if (obj_file) 1333 obj_file->CreateSections(*GetUnifiedSectionList()); 1334 } 1335 return m_sections_ap.get(); 1336 } 1337 1338 void 1339 Module::SectionFileAddressesChanged () 1340 { 1341 ObjectFile *obj_file = GetObjectFile (); 1342 if (obj_file) 1343 obj_file->SectionFileAddressesChanged (); 1344 SymbolVendor* sym_vendor = GetSymbolVendor(); 1345 if (sym_vendor) 1346 sym_vendor->SectionFileAddressesChanged (); 1347 } 1348 1349 SectionList * 1350 Module::GetUnifiedSectionList() 1351 { 1352 // Populate m_unified_sections_ap with sections from objfile. 1353 if (m_sections_ap.get() == NULL) 1354 m_sections_ap.reset(new SectionList()); 1355 return m_sections_ap.get(); 1356 } 1357 1358 const Symbol * 1359 Module::FindFirstSymbolWithNameAndType (const ConstString &name, SymbolType symbol_type) 1360 { 1361 Timer scoped_timer(__PRETTY_FUNCTION__, 1362 "Module::FindFirstSymbolWithNameAndType (name = %s, type = %i)", 1363 name.AsCString(), 1364 symbol_type); 1365 SymbolVendor* sym_vendor = GetSymbolVendor(); 1366 if (sym_vendor) 1367 { 1368 Symtab *symtab = sym_vendor->GetSymtab(); 1369 if (symtab) 1370 return symtab->FindFirstSymbolWithNameAndType (name, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny); 1371 } 1372 return NULL; 1373 } 1374 void 1375 Module::SymbolIndicesToSymbolContextList (Symtab *symtab, std::vector<uint32_t> &symbol_indexes, SymbolContextList &sc_list) 1376 { 1377 // No need to protect this call using m_mutex all other method calls are 1378 // already thread safe. 1379 1380 size_t num_indices = symbol_indexes.size(); 1381 if (num_indices > 0) 1382 { 1383 SymbolContext sc; 1384 CalculateSymbolContext (&sc); 1385 for (size_t i = 0; i < num_indices; i++) 1386 { 1387 sc.symbol = symtab->SymbolAtIndex (symbol_indexes[i]); 1388 if (sc.symbol) 1389 sc_list.Append (sc); 1390 } 1391 } 1392 } 1393 1394 size_t 1395 Module::FindFunctionSymbols (const ConstString &name, 1396 uint32_t name_type_mask, 1397 SymbolContextList& sc_list) 1398 { 1399 Timer scoped_timer(__PRETTY_FUNCTION__, 1400 "Module::FindSymbolsFunctions (name = %s, mask = 0x%8.8x)", 1401 name.AsCString(), 1402 name_type_mask); 1403 SymbolVendor* sym_vendor = GetSymbolVendor(); 1404 if (sym_vendor) 1405 { 1406 Symtab *symtab = sym_vendor->GetSymtab(); 1407 if (symtab) 1408 return symtab->FindFunctionSymbols (name, name_type_mask, sc_list); 1409 } 1410 return 0; 1411 } 1412 1413 size_t 1414 Module::FindSymbolsWithNameAndType (const ConstString &name, SymbolType symbol_type, SymbolContextList &sc_list) 1415 { 1416 // No need to protect this call using m_mutex all other method calls are 1417 // already thread safe. 1418 1419 1420 Timer scoped_timer(__PRETTY_FUNCTION__, 1421 "Module::FindSymbolsWithNameAndType (name = %s, type = %i)", 1422 name.AsCString(), 1423 symbol_type); 1424 const size_t initial_size = sc_list.GetSize(); 1425 SymbolVendor* sym_vendor = GetSymbolVendor(); 1426 if (sym_vendor) 1427 { 1428 Symtab *symtab = sym_vendor->GetSymtab(); 1429 if (symtab) 1430 { 1431 std::vector<uint32_t> symbol_indexes; 1432 symtab->FindAllSymbolsWithNameAndType (name, symbol_type, symbol_indexes); 1433 SymbolIndicesToSymbolContextList (symtab, symbol_indexes, sc_list); 1434 } 1435 } 1436 return sc_list.GetSize() - initial_size; 1437 } 1438 1439 size_t 1440 Module::FindSymbolsMatchingRegExAndType (const RegularExpression ®ex, SymbolType symbol_type, SymbolContextList &sc_list) 1441 { 1442 // No need to protect this call using m_mutex all other method calls are 1443 // already thread safe. 1444 1445 Timer scoped_timer(__PRETTY_FUNCTION__, 1446 "Module::FindSymbolsMatchingRegExAndType (regex = %s, type = %i)", 1447 regex.GetText(), 1448 symbol_type); 1449 const size_t initial_size = sc_list.GetSize(); 1450 SymbolVendor* sym_vendor = GetSymbolVendor(); 1451 if (sym_vendor) 1452 { 1453 Symtab *symtab = sym_vendor->GetSymtab(); 1454 if (symtab) 1455 { 1456 std::vector<uint32_t> symbol_indexes; 1457 symtab->FindAllSymbolsMatchingRexExAndType (regex, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny, symbol_indexes); 1458 SymbolIndicesToSymbolContextList (symtab, symbol_indexes, sc_list); 1459 } 1460 } 1461 return sc_list.GetSize() - initial_size; 1462 } 1463 1464 void 1465 Module::SetSymbolFileFileSpec (const FileSpec &file) 1466 { 1467 if (!file.Exists()) 1468 return; 1469 if (m_symfile_ap) 1470 { 1471 // Remove any sections in the unified section list that come from the current symbol vendor. 1472 SectionList *section_list = GetSectionList(); 1473 SymbolFile *symbol_file = m_symfile_ap->GetSymbolFile(); 1474 if (section_list && symbol_file) 1475 { 1476 ObjectFile *obj_file = symbol_file->GetObjectFile(); 1477 // Make sure we have an object file and that the symbol vendor's objfile isn't 1478 // the same as the module's objfile before we remove any sections for it... 1479 if (obj_file) 1480 { 1481 // Check to make sure we aren't trying to specify the file we already have 1482 if (obj_file->GetFileSpec() == file) 1483 { 1484 // We are being told to add the exact same file that we already have 1485 // we don't have to do anything. 1486 return; 1487 } 1488 1489 // Cleare the current symtab as we are going to replace it with a new one 1490 obj_file->ClearSymtab(); 1491 1492 // The symbol file might be a directory bundle ("/tmp/a.out.dSYM") instead 1493 // of a full path to the symbol file within the bundle 1494 // ("/tmp/a.out.dSYM/Contents/Resources/DWARF/a.out"). So we need to check this 1495 1496 if (file.IsDirectory()) 1497 { 1498 std::string new_path(file.GetPath()); 1499 std::string old_path(obj_file->GetFileSpec().GetPath()); 1500 if (old_path.find(new_path) == 0) 1501 { 1502 // We specified the same bundle as the symbol file that we already have 1503 return; 1504 } 1505 } 1506 1507 if (obj_file != m_objfile_sp.get()) 1508 { 1509 size_t num_sections = section_list->GetNumSections (0); 1510 for (size_t idx = num_sections; idx > 0; --idx) 1511 { 1512 lldb::SectionSP section_sp (section_list->GetSectionAtIndex (idx - 1)); 1513 if (section_sp->GetObjectFile() == obj_file) 1514 { 1515 section_list->DeleteSection (idx - 1); 1516 } 1517 } 1518 } 1519 } 1520 } 1521 // Keep all old symbol files around in case there are any lingering type references in 1522 // any SBValue objects that might have been handed out. 1523 m_old_symfiles.push_back(std::move(m_symfile_ap)); 1524 } 1525 m_symfile_spec = file; 1526 m_symfile_ap.reset(); 1527 m_did_load_symbol_vendor = false; 1528 } 1529 1530 bool 1531 Module::IsExecutable () 1532 { 1533 if (GetObjectFile() == NULL) 1534 return false; 1535 else 1536 return GetObjectFile()->IsExecutable(); 1537 } 1538 1539 bool 1540 Module::IsLoadedInTarget (Target *target) 1541 { 1542 ObjectFile *obj_file = GetObjectFile(); 1543 if (obj_file) 1544 { 1545 SectionList *sections = GetSectionList(); 1546 if (sections != NULL) 1547 { 1548 size_t num_sections = sections->GetSize(); 1549 for (size_t sect_idx = 0; sect_idx < num_sections; sect_idx++) 1550 { 1551 SectionSP section_sp = sections->GetSectionAtIndex(sect_idx); 1552 if (section_sp->GetLoadBaseAddress(target) != LLDB_INVALID_ADDRESS) 1553 { 1554 return true; 1555 } 1556 } 1557 } 1558 } 1559 return false; 1560 } 1561 1562 bool 1563 Module::LoadScriptingResourceInTarget (Target *target, Error& error, Stream* feedback_stream) 1564 { 1565 if (!target) 1566 { 1567 error.SetErrorString("invalid destination Target"); 1568 return false; 1569 } 1570 1571 LoadScriptFromSymFile should_load = target->TargetProperties::GetLoadScriptFromSymbolFile(); 1572 1573 if (should_load == eLoadScriptFromSymFileFalse) 1574 return false; 1575 1576 Debugger &debugger = target->GetDebugger(); 1577 const ScriptLanguage script_language = debugger.GetScriptLanguage(); 1578 if (script_language != eScriptLanguageNone) 1579 { 1580 1581 PlatformSP platform_sp(target->GetPlatform()); 1582 1583 if (!platform_sp) 1584 { 1585 error.SetErrorString("invalid Platform"); 1586 return false; 1587 } 1588 1589 FileSpecList file_specs = platform_sp->LocateExecutableScriptingResources (target, 1590 *this, 1591 feedback_stream); 1592 1593 1594 const uint32_t num_specs = file_specs.GetSize(); 1595 if (num_specs) 1596 { 1597 ScriptInterpreter *script_interpreter = debugger.GetCommandInterpreter().GetScriptInterpreter(); 1598 if (script_interpreter) 1599 { 1600 for (uint32_t i=0; i<num_specs; ++i) 1601 { 1602 FileSpec scripting_fspec (file_specs.GetFileSpecAtIndex(i)); 1603 if (scripting_fspec && scripting_fspec.Exists()) 1604 { 1605 if (should_load == eLoadScriptFromSymFileWarn) 1606 { 1607 if (feedback_stream) 1608 feedback_stream->Printf("warning: '%s' contains a debug script. To run this script in " 1609 "this debug session:\n\n command script import \"%s\"\n\n" 1610 "To run all discovered debug scripts in this session:\n\n" 1611 " settings set target.load-script-from-symbol-file true\n", 1612 GetFileSpec().GetFileNameStrippingExtension().GetCString(), 1613 scripting_fspec.GetPath().c_str()); 1614 return false; 1615 } 1616 StreamString scripting_stream; 1617 scripting_fspec.Dump(&scripting_stream); 1618 const bool can_reload = true; 1619 const bool init_lldb_globals = false; 1620 bool did_load = script_interpreter->LoadScriptingModule(scripting_stream.GetData(), 1621 can_reload, 1622 init_lldb_globals, 1623 error); 1624 if (!did_load) 1625 return false; 1626 } 1627 } 1628 } 1629 else 1630 { 1631 error.SetErrorString("invalid ScriptInterpreter"); 1632 return false; 1633 } 1634 } 1635 } 1636 return true; 1637 } 1638 1639 bool 1640 Module::SetArchitecture (const ArchSpec &new_arch) 1641 { 1642 if (!m_arch.IsValid()) 1643 { 1644 m_arch = new_arch; 1645 return true; 1646 } 1647 return m_arch.IsCompatibleMatch(new_arch); 1648 } 1649 1650 bool 1651 Module::SetLoadAddress (Target &target, lldb::addr_t value, bool value_is_offset, bool &changed) 1652 { 1653 ObjectFile *object_file = GetObjectFile(); 1654 if (object_file) 1655 { 1656 changed = object_file->SetLoadAddress(target, value, value_is_offset); 1657 return true; 1658 } 1659 else 1660 { 1661 changed = false; 1662 } 1663 return false; 1664 } 1665 1666 1667 bool 1668 Module::MatchesModuleSpec (const ModuleSpec &module_ref) 1669 { 1670 const UUID &uuid = module_ref.GetUUID(); 1671 1672 if (uuid.IsValid()) 1673 { 1674 // If the UUID matches, then nothing more needs to match... 1675 if (uuid == GetUUID()) 1676 return true; 1677 else 1678 return false; 1679 } 1680 1681 const FileSpec &file_spec = module_ref.GetFileSpec(); 1682 if (file_spec) 1683 { 1684 if (!FileSpec::Equal (file_spec, m_file, (bool)file_spec.GetDirectory()) && 1685 !FileSpec::Equal (file_spec, m_platform_file, (bool)file_spec.GetDirectory())) 1686 return false; 1687 } 1688 1689 const FileSpec &platform_file_spec = module_ref.GetPlatformFileSpec(); 1690 if (platform_file_spec) 1691 { 1692 if (!FileSpec::Equal (platform_file_spec, GetPlatformFileSpec (), (bool)platform_file_spec.GetDirectory())) 1693 return false; 1694 } 1695 1696 const ArchSpec &arch = module_ref.GetArchitecture(); 1697 if (arch.IsValid()) 1698 { 1699 if (!m_arch.IsCompatibleMatch(arch)) 1700 return false; 1701 } 1702 1703 const ConstString &object_name = module_ref.GetObjectName(); 1704 if (object_name) 1705 { 1706 if (object_name != GetObjectName()) 1707 return false; 1708 } 1709 return true; 1710 } 1711 1712 bool 1713 Module::FindSourceFile (const FileSpec &orig_spec, FileSpec &new_spec) const 1714 { 1715 Mutex::Locker locker (m_mutex); 1716 return m_source_mappings.FindFile (orig_spec, new_spec); 1717 } 1718 1719 bool 1720 Module::RemapSourceFile (const char *path, std::string &new_path) const 1721 { 1722 Mutex::Locker locker (m_mutex); 1723 return m_source_mappings.RemapPath(path, new_path); 1724 } 1725 1726 uint32_t 1727 Module::GetVersion (uint32_t *versions, uint32_t num_versions) 1728 { 1729 ObjectFile *obj_file = GetObjectFile(); 1730 if (obj_file) 1731 return obj_file->GetVersion (versions, num_versions); 1732 1733 if (versions && num_versions) 1734 { 1735 for (uint32_t i=0; i<num_versions; ++i) 1736 versions[i] = LLDB_INVALID_MODULE_VERSION; 1737 } 1738 return 0; 1739 } 1740 1741 void 1742 Module::PrepareForFunctionNameLookup (const ConstString &name, 1743 uint32_t name_type_mask, 1744 LanguageType language, 1745 ConstString &lookup_name, 1746 uint32_t &lookup_name_type_mask, 1747 bool &match_name_after_lookup) 1748 { 1749 const char *name_cstr = name.GetCString(); 1750 lookup_name_type_mask = eFunctionNameTypeNone; 1751 match_name_after_lookup = false; 1752 1753 llvm::StringRef basename; 1754 llvm::StringRef context; 1755 1756 if (name_type_mask & eFunctionNameTypeAuto) 1757 { 1758 if (CPlusPlusLanguage::IsCPPMangledName (name_cstr)) 1759 lookup_name_type_mask = eFunctionNameTypeFull; 1760 else if ((language == eLanguageTypeUnknown || 1761 Language::LanguageIsObjC(language)) && 1762 ObjCLanguage::IsPossibleObjCMethodName (name_cstr)) 1763 lookup_name_type_mask = eFunctionNameTypeFull; 1764 else if (Language::LanguageIsC(language)) 1765 { 1766 lookup_name_type_mask = eFunctionNameTypeFull; 1767 } 1768 else 1769 { 1770 if ((language == eLanguageTypeUnknown || 1771 Language::LanguageIsObjC(language)) && 1772 ObjCLanguage::IsPossibleObjCSelector(name_cstr)) 1773 lookup_name_type_mask |= eFunctionNameTypeSelector; 1774 1775 CPlusPlusLanguage::MethodName cpp_method (name); 1776 basename = cpp_method.GetBasename(); 1777 if (basename.empty()) 1778 { 1779 if (CPlusPlusLanguage::ExtractContextAndIdentifier (name_cstr, context, basename)) 1780 lookup_name_type_mask |= (eFunctionNameTypeMethod | eFunctionNameTypeBase); 1781 else 1782 lookup_name_type_mask |= eFunctionNameTypeFull; 1783 } 1784 else 1785 { 1786 lookup_name_type_mask |= (eFunctionNameTypeMethod | eFunctionNameTypeBase); 1787 } 1788 } 1789 } 1790 else 1791 { 1792 lookup_name_type_mask = name_type_mask; 1793 if (lookup_name_type_mask & eFunctionNameTypeMethod || name_type_mask & eFunctionNameTypeBase) 1794 { 1795 // If they've asked for a CPP method or function name and it can't be that, we don't 1796 // even need to search for CPP methods or names. 1797 CPlusPlusLanguage::MethodName cpp_method (name); 1798 if (cpp_method.IsValid()) 1799 { 1800 basename = cpp_method.GetBasename(); 1801 1802 if (!cpp_method.GetQualifiers().empty()) 1803 { 1804 // There is a "const" or other qualifier following the end of the function parens, 1805 // this can't be a eFunctionNameTypeBase 1806 lookup_name_type_mask &= ~(eFunctionNameTypeBase); 1807 if (lookup_name_type_mask == eFunctionNameTypeNone) 1808 return; 1809 } 1810 } 1811 else 1812 { 1813 // If the CPP method parser didn't manage to chop this up, try to fill in the base name if we can. 1814 // If a::b::c is passed in, we need to just look up "c", and then we'll filter the result later. 1815 CPlusPlusLanguage::ExtractContextAndIdentifier (name_cstr, context, basename); 1816 } 1817 } 1818 1819 if (lookup_name_type_mask & eFunctionNameTypeSelector) 1820 { 1821 if (!ObjCLanguage::IsPossibleObjCSelector(name_cstr)) 1822 { 1823 lookup_name_type_mask &= ~(eFunctionNameTypeSelector); 1824 if (lookup_name_type_mask == eFunctionNameTypeNone) 1825 return; 1826 } 1827 } 1828 } 1829 1830 if (!basename.empty()) 1831 { 1832 // The name supplied was a partial C++ path like "a::count". In this case we want to do a 1833 // lookup on the basename "count" and then make sure any matching results contain "a::count" 1834 // so that it would match "b::a::count" and "a::count". This is why we set "match_name_after_lookup" 1835 // to true 1836 lookup_name.SetString(basename); 1837 match_name_after_lookup = true; 1838 } 1839 else 1840 { 1841 // The name is already correct, just use the exact name as supplied, and we won't need 1842 // to check if any matches contain "name" 1843 lookup_name = name; 1844 match_name_after_lookup = false; 1845 } 1846 } 1847 1848 ModuleSP 1849 Module::CreateJITModule (const lldb::ObjectFileJITDelegateSP &delegate_sp) 1850 { 1851 if (delegate_sp) 1852 { 1853 // Must create a module and place it into a shared pointer before 1854 // we can create an object file since it has a std::weak_ptr back 1855 // to the module, so we need to control the creation carefully in 1856 // this static function 1857 ModuleSP module_sp(new Module()); 1858 module_sp->m_objfile_sp.reset (new ObjectFileJIT (module_sp, delegate_sp)); 1859 if (module_sp->m_objfile_sp) 1860 { 1861 // Once we get the object file, update our module with the object file's 1862 // architecture since it might differ in vendor/os if some parts were 1863 // unknown. 1864 module_sp->m_objfile_sp->GetArchitecture (module_sp->m_arch); 1865 } 1866 return module_sp; 1867 } 1868 return ModuleSP(); 1869 } 1870 1871 bool 1872 Module::GetIsDynamicLinkEditor() 1873 { 1874 ObjectFile * obj_file = GetObjectFile (); 1875 1876 if (obj_file) 1877 return obj_file->GetIsDynamicLinkEditor(); 1878 1879 return false; 1880 } 1881