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 llvm::DenseSet<lldb_private::SymbolFile *> &searched_symbol_files, 937 TypeMap& types) 938 { 939 Timer scoped_timer(__PRETTY_FUNCTION__, __PRETTY_FUNCTION__); 940 if (sc.module_sp.get() == NULL || sc.module_sp.get() == this) 941 { 942 SymbolVendor *symbols = GetSymbolVendor (); 943 if (symbols) 944 return symbols->FindTypes(sc, name, parent_decl_ctx, append, max_matches, searched_symbol_files, types); 945 } 946 return 0; 947 } 948 949 size_t 950 Module::FindTypesInNamespace (const SymbolContext& sc, 951 const ConstString &type_name, 952 const CompilerDeclContext *parent_decl_ctx, 953 size_t max_matches, 954 TypeList& type_list) 955 { 956 const bool append = true; 957 TypeMap types_map; 958 llvm::DenseSet<lldb_private::SymbolFile *> searched_symbol_files; 959 size_t num_types = FindTypes_Impl(sc, type_name, parent_decl_ctx, append, max_matches, searched_symbol_files, types_map); 960 if (num_types > 0) 961 sc.SortTypeList(types_map, type_list); 962 return num_types; 963 } 964 965 lldb::TypeSP 966 Module::FindFirstType (const SymbolContext& sc, 967 const ConstString &name, 968 bool exact_match) 969 { 970 TypeList type_list; 971 llvm::DenseSet<lldb_private::SymbolFile *> searched_symbol_files; 972 const size_t num_matches = FindTypes (sc, name, exact_match, 1, searched_symbol_files, type_list); 973 if (num_matches) 974 return type_list.GetTypeAtIndex(0); 975 return TypeSP(); 976 } 977 978 979 size_t 980 Module::FindTypes (const SymbolContext& sc, 981 const ConstString &name, 982 bool exact_match, 983 size_t max_matches, 984 llvm::DenseSet<lldb_private::SymbolFile *> &searched_symbol_files, 985 TypeList& types) 986 { 987 size_t num_matches = 0; 988 const char *type_name_cstr = name.GetCString(); 989 std::string type_scope; 990 std::string type_basename; 991 const bool append = true; 992 TypeClass type_class = eTypeClassAny; 993 TypeMap typesmap; 994 if (Type::GetTypeScopeAndBasename (type_name_cstr, type_scope, type_basename, type_class)) 995 { 996 // Check if "name" starts with "::" which means the qualified type starts 997 // from the root namespace and implies and exact match. The typenames we 998 // get back from clang do not start with "::" so we need to strip this off 999 // in order to get the qualified names to match 1000 1001 if (type_scope.size() >= 2 && type_scope[0] == ':' && type_scope[1] == ':') 1002 { 1003 type_scope.erase(0,2); 1004 exact_match = true; 1005 } 1006 ConstString type_basename_const_str (type_basename.c_str()); 1007 if (FindTypes_Impl(sc, type_basename_const_str, NULL, append, max_matches, searched_symbol_files, typesmap)) 1008 { 1009 typesmap.RemoveMismatchedTypes (type_scope, type_basename, type_class, exact_match); 1010 num_matches = typesmap.GetSize(); 1011 } 1012 } 1013 else 1014 { 1015 // The type is not in a namespace/class scope, just search for it by basename 1016 if (type_class != eTypeClassAny) 1017 { 1018 // The "type_name_cstr" will have been modified if we have a valid type class 1019 // prefix (like "struct", "class", "union", "typedef" etc). 1020 FindTypes_Impl(sc, ConstString(type_name_cstr), NULL, append, max_matches, searched_symbol_files, typesmap); 1021 typesmap.RemoveMismatchedTypes (type_class); 1022 num_matches = typesmap.GetSize(); 1023 } 1024 else 1025 { 1026 num_matches = FindTypes_Impl(sc, name, NULL, append, max_matches, searched_symbol_files, typesmap); 1027 } 1028 } 1029 if (num_matches > 0) 1030 sc.SortTypeList(typesmap, types); 1031 return num_matches; 1032 } 1033 1034 SymbolVendor* 1035 Module::GetSymbolVendor (bool can_create, lldb_private::Stream *feedback_strm) 1036 { 1037 if (m_did_load_symbol_vendor.load() == false) 1038 { 1039 Mutex::Locker locker (m_mutex); 1040 if (m_did_load_symbol_vendor.load() == false && can_create) 1041 { 1042 ObjectFile *obj_file = GetObjectFile (); 1043 if (obj_file != NULL) 1044 { 1045 Timer scoped_timer(__PRETTY_FUNCTION__, __PRETTY_FUNCTION__); 1046 m_symfile_ap.reset(SymbolVendor::FindPlugin(shared_from_this(), feedback_strm)); 1047 m_did_load_symbol_vendor = true; 1048 } 1049 } 1050 } 1051 return m_symfile_ap.get(); 1052 } 1053 1054 void 1055 Module::SetFileSpecAndObjectName (const FileSpec &file, const ConstString &object_name) 1056 { 1057 // Container objects whose paths do not specify a file directly can call 1058 // this function to correct the file and object names. 1059 m_file = file; 1060 m_mod_time = file.GetModificationTime(); 1061 m_object_name = object_name; 1062 } 1063 1064 const ArchSpec& 1065 Module::GetArchitecture () const 1066 { 1067 return m_arch; 1068 } 1069 1070 std::string 1071 Module::GetSpecificationDescription () const 1072 { 1073 std::string spec(GetFileSpec().GetPath()); 1074 if (m_object_name) 1075 { 1076 spec += '('; 1077 spec += m_object_name.GetCString(); 1078 spec += ')'; 1079 } 1080 return spec; 1081 } 1082 1083 void 1084 Module::GetDescription (Stream *s, lldb::DescriptionLevel level) 1085 { 1086 Mutex::Locker locker (m_mutex); 1087 1088 if (level >= eDescriptionLevelFull) 1089 { 1090 if (m_arch.IsValid()) 1091 s->Printf("(%s) ", m_arch.GetArchitectureName()); 1092 } 1093 1094 if (level == eDescriptionLevelBrief) 1095 { 1096 const char *filename = m_file.GetFilename().GetCString(); 1097 if (filename) 1098 s->PutCString (filename); 1099 } 1100 else 1101 { 1102 char path[PATH_MAX]; 1103 if (m_file.GetPath(path, sizeof(path))) 1104 s->PutCString(path); 1105 } 1106 1107 const char *object_name = m_object_name.GetCString(); 1108 if (object_name) 1109 s->Printf("(%s)", object_name); 1110 } 1111 1112 void 1113 Module::ReportError (const char *format, ...) 1114 { 1115 if (format && format[0]) 1116 { 1117 StreamString strm; 1118 strm.PutCString("error: "); 1119 GetDescription(&strm, lldb::eDescriptionLevelBrief); 1120 strm.PutChar (' '); 1121 va_list args; 1122 va_start (args, format); 1123 strm.PrintfVarArg(format, args); 1124 va_end (args); 1125 1126 const int format_len = strlen(format); 1127 if (format_len > 0) 1128 { 1129 const char last_char = format[format_len-1]; 1130 if (last_char != '\n' || last_char != '\r') 1131 strm.EOL(); 1132 } 1133 Host::SystemLog (Host::eSystemLogError, "%s", strm.GetString().c_str()); 1134 1135 } 1136 } 1137 1138 bool 1139 Module::FileHasChanged () const 1140 { 1141 if (m_file_has_changed == false) 1142 m_file_has_changed = (m_file.GetModificationTime() != m_mod_time); 1143 return m_file_has_changed; 1144 } 1145 1146 void 1147 Module::ReportErrorIfModifyDetected (const char *format, ...) 1148 { 1149 if (m_first_file_changed_log == false) 1150 { 1151 if (FileHasChanged ()) 1152 { 1153 m_first_file_changed_log = true; 1154 if (format) 1155 { 1156 StreamString strm; 1157 strm.PutCString("error: the object file "); 1158 GetDescription(&strm, lldb::eDescriptionLevelFull); 1159 strm.PutCString (" has been modified\n"); 1160 1161 va_list args; 1162 va_start (args, format); 1163 strm.PrintfVarArg(format, args); 1164 va_end (args); 1165 1166 const int format_len = strlen(format); 1167 if (format_len > 0) 1168 { 1169 const char last_char = format[format_len-1]; 1170 if (last_char != '\n' || last_char != '\r') 1171 strm.EOL(); 1172 } 1173 strm.PutCString("The debug session should be aborted as the original debug information has been overwritten.\n"); 1174 Host::SystemLog (Host::eSystemLogError, "%s", strm.GetString().c_str()); 1175 } 1176 } 1177 } 1178 } 1179 1180 void 1181 Module::ReportWarning (const char *format, ...) 1182 { 1183 if (format && format[0]) 1184 { 1185 StreamString strm; 1186 strm.PutCString("warning: "); 1187 GetDescription(&strm, lldb::eDescriptionLevelFull); 1188 strm.PutChar (' '); 1189 1190 va_list args; 1191 va_start (args, format); 1192 strm.PrintfVarArg(format, args); 1193 va_end (args); 1194 1195 const int format_len = strlen(format); 1196 if (format_len > 0) 1197 { 1198 const char last_char = format[format_len-1]; 1199 if (last_char != '\n' || last_char != '\r') 1200 strm.EOL(); 1201 } 1202 Host::SystemLog (Host::eSystemLogWarning, "%s", strm.GetString().c_str()); 1203 } 1204 } 1205 1206 void 1207 Module::LogMessage (Log *log, const char *format, ...) 1208 { 1209 if (log) 1210 { 1211 StreamString log_message; 1212 GetDescription(&log_message, lldb::eDescriptionLevelFull); 1213 log_message.PutCString (": "); 1214 va_list args; 1215 va_start (args, format); 1216 log_message.PrintfVarArg (format, args); 1217 va_end (args); 1218 log->PutCString(log_message.GetString().c_str()); 1219 } 1220 } 1221 1222 void 1223 Module::LogMessageVerboseBacktrace (Log *log, const char *format, ...) 1224 { 1225 if (log) 1226 { 1227 StreamString log_message; 1228 GetDescription(&log_message, lldb::eDescriptionLevelFull); 1229 log_message.PutCString (": "); 1230 va_list args; 1231 va_start (args, format); 1232 log_message.PrintfVarArg (format, args); 1233 va_end (args); 1234 if (log->GetVerbose()) 1235 { 1236 std::string back_trace; 1237 llvm::raw_string_ostream stream(back_trace); 1238 llvm::sys::PrintStackTrace(stream); 1239 log_message.PutCString(back_trace.c_str()); 1240 } 1241 log->PutCString(log_message.GetString().c_str()); 1242 } 1243 } 1244 1245 void 1246 Module::Dump(Stream *s) 1247 { 1248 Mutex::Locker locker (m_mutex); 1249 //s->Printf("%.*p: ", (int)sizeof(void*) * 2, this); 1250 s->Indent(); 1251 s->Printf("Module %s%s%s%s\n", 1252 m_file.GetPath().c_str(), 1253 m_object_name ? "(" : "", 1254 m_object_name ? m_object_name.GetCString() : "", 1255 m_object_name ? ")" : ""); 1256 1257 s->IndentMore(); 1258 1259 ObjectFile *objfile = GetObjectFile (); 1260 if (objfile) 1261 objfile->Dump(s); 1262 1263 SymbolVendor *symbols = GetSymbolVendor (); 1264 if (symbols) 1265 symbols->Dump(s); 1266 1267 s->IndentLess(); 1268 } 1269 1270 1271 TypeList* 1272 Module::GetTypeList () 1273 { 1274 SymbolVendor *symbols = GetSymbolVendor (); 1275 if (symbols) 1276 return &symbols->GetTypeList(); 1277 return NULL; 1278 } 1279 1280 const ConstString & 1281 Module::GetObjectName() const 1282 { 1283 return m_object_name; 1284 } 1285 1286 ObjectFile * 1287 Module::GetObjectFile() 1288 { 1289 if (m_did_load_objfile.load() == false) 1290 { 1291 Mutex::Locker locker (m_mutex); 1292 if (m_did_load_objfile.load() == false) 1293 { 1294 Timer scoped_timer(__PRETTY_FUNCTION__, 1295 "Module::GetObjectFile () module = %s", GetFileSpec().GetFilename().AsCString("")); 1296 DataBufferSP data_sp; 1297 lldb::offset_t data_offset = 0; 1298 const lldb::offset_t file_size = m_file.GetByteSize(); 1299 if (file_size > m_object_offset) 1300 { 1301 m_did_load_objfile = true; 1302 m_objfile_sp = ObjectFile::FindPlugin (shared_from_this(), 1303 &m_file, 1304 m_object_offset, 1305 file_size - m_object_offset, 1306 data_sp, 1307 data_offset); 1308 if (m_objfile_sp) 1309 { 1310 // Once we get the object file, update our module with the object file's 1311 // architecture since it might differ in vendor/os if some parts were 1312 // unknown. But since the matching arch might already be more specific 1313 // than the generic COFF architecture, only merge in those values that 1314 // overwrite unspecified unknown values. 1315 ArchSpec new_arch; 1316 m_objfile_sp->GetArchitecture(new_arch); 1317 m_arch.MergeFrom(new_arch); 1318 } 1319 else 1320 { 1321 ReportError ("failed to load objfile for %s", GetFileSpec().GetPath().c_str()); 1322 } 1323 } 1324 } 1325 } 1326 return m_objfile_sp.get(); 1327 } 1328 1329 SectionList * 1330 Module::GetSectionList() 1331 { 1332 // Populate m_unified_sections_ap with sections from objfile. 1333 if (m_sections_ap.get() == NULL) 1334 { 1335 ObjectFile *obj_file = GetObjectFile(); 1336 if (obj_file) 1337 obj_file->CreateSections(*GetUnifiedSectionList()); 1338 } 1339 return m_sections_ap.get(); 1340 } 1341 1342 void 1343 Module::SectionFileAddressesChanged () 1344 { 1345 ObjectFile *obj_file = GetObjectFile (); 1346 if (obj_file) 1347 obj_file->SectionFileAddressesChanged (); 1348 SymbolVendor* sym_vendor = GetSymbolVendor(); 1349 if (sym_vendor) 1350 sym_vendor->SectionFileAddressesChanged (); 1351 } 1352 1353 SectionList * 1354 Module::GetUnifiedSectionList() 1355 { 1356 // Populate m_unified_sections_ap with sections from objfile. 1357 if (m_sections_ap.get() == NULL) 1358 m_sections_ap.reset(new SectionList()); 1359 return m_sections_ap.get(); 1360 } 1361 1362 const Symbol * 1363 Module::FindFirstSymbolWithNameAndType (const ConstString &name, SymbolType symbol_type) 1364 { 1365 Timer scoped_timer(__PRETTY_FUNCTION__, 1366 "Module::FindFirstSymbolWithNameAndType (name = %s, type = %i)", 1367 name.AsCString(), 1368 symbol_type); 1369 SymbolVendor* sym_vendor = GetSymbolVendor(); 1370 if (sym_vendor) 1371 { 1372 Symtab *symtab = sym_vendor->GetSymtab(); 1373 if (symtab) 1374 return symtab->FindFirstSymbolWithNameAndType (name, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny); 1375 } 1376 return NULL; 1377 } 1378 void 1379 Module::SymbolIndicesToSymbolContextList (Symtab *symtab, std::vector<uint32_t> &symbol_indexes, SymbolContextList &sc_list) 1380 { 1381 // No need to protect this call using m_mutex all other method calls are 1382 // already thread safe. 1383 1384 size_t num_indices = symbol_indexes.size(); 1385 if (num_indices > 0) 1386 { 1387 SymbolContext sc; 1388 CalculateSymbolContext (&sc); 1389 for (size_t i = 0; i < num_indices; i++) 1390 { 1391 sc.symbol = symtab->SymbolAtIndex (symbol_indexes[i]); 1392 if (sc.symbol) 1393 sc_list.Append (sc); 1394 } 1395 } 1396 } 1397 1398 size_t 1399 Module::FindFunctionSymbols (const ConstString &name, 1400 uint32_t name_type_mask, 1401 SymbolContextList& sc_list) 1402 { 1403 Timer scoped_timer(__PRETTY_FUNCTION__, 1404 "Module::FindSymbolsFunctions (name = %s, mask = 0x%8.8x)", 1405 name.AsCString(), 1406 name_type_mask); 1407 SymbolVendor* sym_vendor = GetSymbolVendor(); 1408 if (sym_vendor) 1409 { 1410 Symtab *symtab = sym_vendor->GetSymtab(); 1411 if (symtab) 1412 return symtab->FindFunctionSymbols (name, name_type_mask, sc_list); 1413 } 1414 return 0; 1415 } 1416 1417 size_t 1418 Module::FindSymbolsWithNameAndType (const ConstString &name, SymbolType symbol_type, SymbolContextList &sc_list) 1419 { 1420 // No need to protect this call using m_mutex all other method calls are 1421 // already thread safe. 1422 1423 1424 Timer scoped_timer(__PRETTY_FUNCTION__, 1425 "Module::FindSymbolsWithNameAndType (name = %s, type = %i)", 1426 name.AsCString(), 1427 symbol_type); 1428 const size_t initial_size = sc_list.GetSize(); 1429 SymbolVendor* sym_vendor = GetSymbolVendor(); 1430 if (sym_vendor) 1431 { 1432 Symtab *symtab = sym_vendor->GetSymtab(); 1433 if (symtab) 1434 { 1435 std::vector<uint32_t> symbol_indexes; 1436 symtab->FindAllSymbolsWithNameAndType (name, symbol_type, symbol_indexes); 1437 SymbolIndicesToSymbolContextList (symtab, symbol_indexes, sc_list); 1438 } 1439 } 1440 return sc_list.GetSize() - initial_size; 1441 } 1442 1443 size_t 1444 Module::FindSymbolsMatchingRegExAndType (const RegularExpression ®ex, SymbolType symbol_type, SymbolContextList &sc_list) 1445 { 1446 // No need to protect this call using m_mutex all other method calls are 1447 // already thread safe. 1448 1449 Timer scoped_timer(__PRETTY_FUNCTION__, 1450 "Module::FindSymbolsMatchingRegExAndType (regex = %s, type = %i)", 1451 regex.GetText(), 1452 symbol_type); 1453 const size_t initial_size = sc_list.GetSize(); 1454 SymbolVendor* sym_vendor = GetSymbolVendor(); 1455 if (sym_vendor) 1456 { 1457 Symtab *symtab = sym_vendor->GetSymtab(); 1458 if (symtab) 1459 { 1460 std::vector<uint32_t> symbol_indexes; 1461 symtab->FindAllSymbolsMatchingRexExAndType (regex, symbol_type, Symtab::eDebugAny, Symtab::eVisibilityAny, symbol_indexes); 1462 SymbolIndicesToSymbolContextList (symtab, symbol_indexes, sc_list); 1463 } 1464 } 1465 return sc_list.GetSize() - initial_size; 1466 } 1467 1468 void 1469 Module::SetSymbolFileFileSpec (const FileSpec &file) 1470 { 1471 if (!file.Exists()) 1472 return; 1473 if (m_symfile_ap) 1474 { 1475 // Remove any sections in the unified section list that come from the current symbol vendor. 1476 SectionList *section_list = GetSectionList(); 1477 SymbolFile *symbol_file = m_symfile_ap->GetSymbolFile(); 1478 if (section_list && symbol_file) 1479 { 1480 ObjectFile *obj_file = symbol_file->GetObjectFile(); 1481 // Make sure we have an object file and that the symbol vendor's objfile isn't 1482 // the same as the module's objfile before we remove any sections for it... 1483 if (obj_file) 1484 { 1485 // Check to make sure we aren't trying to specify the file we already have 1486 if (obj_file->GetFileSpec() == file) 1487 { 1488 // We are being told to add the exact same file that we already have 1489 // we don't have to do anything. 1490 return; 1491 } 1492 1493 // Cleare the current symtab as we are going to replace it with a new one 1494 obj_file->ClearSymtab(); 1495 1496 // The symbol file might be a directory bundle ("/tmp/a.out.dSYM") instead 1497 // of a full path to the symbol file within the bundle 1498 // ("/tmp/a.out.dSYM/Contents/Resources/DWARF/a.out"). So we need to check this 1499 1500 if (file.IsDirectory()) 1501 { 1502 std::string new_path(file.GetPath()); 1503 std::string old_path(obj_file->GetFileSpec().GetPath()); 1504 if (old_path.find(new_path) == 0) 1505 { 1506 // We specified the same bundle as the symbol file that we already have 1507 return; 1508 } 1509 } 1510 1511 if (obj_file != m_objfile_sp.get()) 1512 { 1513 size_t num_sections = section_list->GetNumSections (0); 1514 for (size_t idx = num_sections; idx > 0; --idx) 1515 { 1516 lldb::SectionSP section_sp (section_list->GetSectionAtIndex (idx - 1)); 1517 if (section_sp->GetObjectFile() == obj_file) 1518 { 1519 section_list->DeleteSection (idx - 1); 1520 } 1521 } 1522 } 1523 } 1524 } 1525 // Keep all old symbol files around in case there are any lingering type references in 1526 // any SBValue objects that might have been handed out. 1527 m_old_symfiles.push_back(std::move(m_symfile_ap)); 1528 } 1529 m_symfile_spec = file; 1530 m_symfile_ap.reset(); 1531 m_did_load_symbol_vendor = false; 1532 } 1533 1534 bool 1535 Module::IsExecutable () 1536 { 1537 if (GetObjectFile() == NULL) 1538 return false; 1539 else 1540 return GetObjectFile()->IsExecutable(); 1541 } 1542 1543 bool 1544 Module::IsLoadedInTarget (Target *target) 1545 { 1546 ObjectFile *obj_file = GetObjectFile(); 1547 if (obj_file) 1548 { 1549 SectionList *sections = GetSectionList(); 1550 if (sections != NULL) 1551 { 1552 size_t num_sections = sections->GetSize(); 1553 for (size_t sect_idx = 0; sect_idx < num_sections; sect_idx++) 1554 { 1555 SectionSP section_sp = sections->GetSectionAtIndex(sect_idx); 1556 if (section_sp->GetLoadBaseAddress(target) != LLDB_INVALID_ADDRESS) 1557 { 1558 return true; 1559 } 1560 } 1561 } 1562 } 1563 return false; 1564 } 1565 1566 bool 1567 Module::LoadScriptingResourceInTarget (Target *target, Error& error, Stream* feedback_stream) 1568 { 1569 if (!target) 1570 { 1571 error.SetErrorString("invalid destination Target"); 1572 return false; 1573 } 1574 1575 LoadScriptFromSymFile should_load = target->TargetProperties::GetLoadScriptFromSymbolFile(); 1576 1577 if (should_load == eLoadScriptFromSymFileFalse) 1578 return false; 1579 1580 Debugger &debugger = target->GetDebugger(); 1581 const ScriptLanguage script_language = debugger.GetScriptLanguage(); 1582 if (script_language != eScriptLanguageNone) 1583 { 1584 1585 PlatformSP platform_sp(target->GetPlatform()); 1586 1587 if (!platform_sp) 1588 { 1589 error.SetErrorString("invalid Platform"); 1590 return false; 1591 } 1592 1593 FileSpecList file_specs = platform_sp->LocateExecutableScriptingResources (target, 1594 *this, 1595 feedback_stream); 1596 1597 1598 const uint32_t num_specs = file_specs.GetSize(); 1599 if (num_specs) 1600 { 1601 ScriptInterpreter *script_interpreter = debugger.GetCommandInterpreter().GetScriptInterpreter(); 1602 if (script_interpreter) 1603 { 1604 for (uint32_t i=0; i<num_specs; ++i) 1605 { 1606 FileSpec scripting_fspec (file_specs.GetFileSpecAtIndex(i)); 1607 if (scripting_fspec && scripting_fspec.Exists()) 1608 { 1609 if (should_load == eLoadScriptFromSymFileWarn) 1610 { 1611 if (feedback_stream) 1612 feedback_stream->Printf("warning: '%s' contains a debug script. To run this script in " 1613 "this debug session:\n\n command script import \"%s\"\n\n" 1614 "To run all discovered debug scripts in this session:\n\n" 1615 " settings set target.load-script-from-symbol-file true\n", 1616 GetFileSpec().GetFileNameStrippingExtension().GetCString(), 1617 scripting_fspec.GetPath().c_str()); 1618 return false; 1619 } 1620 StreamString scripting_stream; 1621 scripting_fspec.Dump(&scripting_stream); 1622 const bool can_reload = true; 1623 const bool init_lldb_globals = false; 1624 bool did_load = script_interpreter->LoadScriptingModule(scripting_stream.GetData(), 1625 can_reload, 1626 init_lldb_globals, 1627 error); 1628 if (!did_load) 1629 return false; 1630 } 1631 } 1632 } 1633 else 1634 { 1635 error.SetErrorString("invalid ScriptInterpreter"); 1636 return false; 1637 } 1638 } 1639 } 1640 return true; 1641 } 1642 1643 bool 1644 Module::SetArchitecture (const ArchSpec &new_arch) 1645 { 1646 if (!m_arch.IsValid()) 1647 { 1648 m_arch = new_arch; 1649 return true; 1650 } 1651 return m_arch.IsCompatibleMatch(new_arch); 1652 } 1653 1654 bool 1655 Module::SetLoadAddress (Target &target, lldb::addr_t value, bool value_is_offset, bool &changed) 1656 { 1657 ObjectFile *object_file = GetObjectFile(); 1658 if (object_file) 1659 { 1660 changed = object_file->SetLoadAddress(target, value, value_is_offset); 1661 return true; 1662 } 1663 else 1664 { 1665 changed = false; 1666 } 1667 return false; 1668 } 1669 1670 1671 bool 1672 Module::MatchesModuleSpec (const ModuleSpec &module_ref) 1673 { 1674 const UUID &uuid = module_ref.GetUUID(); 1675 1676 if (uuid.IsValid()) 1677 { 1678 // If the UUID matches, then nothing more needs to match... 1679 if (uuid == GetUUID()) 1680 return true; 1681 else 1682 return false; 1683 } 1684 1685 const FileSpec &file_spec = module_ref.GetFileSpec(); 1686 if (file_spec) 1687 { 1688 if (!FileSpec::Equal (file_spec, m_file, (bool)file_spec.GetDirectory()) && 1689 !FileSpec::Equal (file_spec, m_platform_file, (bool)file_spec.GetDirectory())) 1690 return false; 1691 } 1692 1693 const FileSpec &platform_file_spec = module_ref.GetPlatformFileSpec(); 1694 if (platform_file_spec) 1695 { 1696 if (!FileSpec::Equal (platform_file_spec, GetPlatformFileSpec (), (bool)platform_file_spec.GetDirectory())) 1697 return false; 1698 } 1699 1700 const ArchSpec &arch = module_ref.GetArchitecture(); 1701 if (arch.IsValid()) 1702 { 1703 if (!m_arch.IsCompatibleMatch(arch)) 1704 return false; 1705 } 1706 1707 const ConstString &object_name = module_ref.GetObjectName(); 1708 if (object_name) 1709 { 1710 if (object_name != GetObjectName()) 1711 return false; 1712 } 1713 return true; 1714 } 1715 1716 bool 1717 Module::FindSourceFile (const FileSpec &orig_spec, FileSpec &new_spec) const 1718 { 1719 Mutex::Locker locker (m_mutex); 1720 return m_source_mappings.FindFile (orig_spec, new_spec); 1721 } 1722 1723 bool 1724 Module::RemapSourceFile (const char *path, std::string &new_path) const 1725 { 1726 Mutex::Locker locker (m_mutex); 1727 return m_source_mappings.RemapPath(path, new_path); 1728 } 1729 1730 uint32_t 1731 Module::GetVersion (uint32_t *versions, uint32_t num_versions) 1732 { 1733 ObjectFile *obj_file = GetObjectFile(); 1734 if (obj_file) 1735 return obj_file->GetVersion (versions, num_versions); 1736 1737 if (versions && num_versions) 1738 { 1739 for (uint32_t i=0; i<num_versions; ++i) 1740 versions[i] = LLDB_INVALID_MODULE_VERSION; 1741 } 1742 return 0; 1743 } 1744 1745 void 1746 Module::PrepareForFunctionNameLookup (const ConstString &name, 1747 uint32_t name_type_mask, 1748 LanguageType language, 1749 ConstString &lookup_name, 1750 uint32_t &lookup_name_type_mask, 1751 bool &match_name_after_lookup) 1752 { 1753 const char *name_cstr = name.GetCString(); 1754 lookup_name_type_mask = eFunctionNameTypeNone; 1755 match_name_after_lookup = false; 1756 1757 llvm::StringRef basename; 1758 llvm::StringRef context; 1759 1760 if (name_type_mask & eFunctionNameTypeAuto) 1761 { 1762 if (CPlusPlusLanguage::IsCPPMangledName (name_cstr)) 1763 lookup_name_type_mask = eFunctionNameTypeFull; 1764 else if ((language == eLanguageTypeUnknown || 1765 Language::LanguageIsObjC(language)) && 1766 ObjCLanguage::IsPossibleObjCMethodName (name_cstr)) 1767 lookup_name_type_mask = eFunctionNameTypeFull; 1768 else if (Language::LanguageIsC(language)) 1769 { 1770 lookup_name_type_mask = eFunctionNameTypeFull; 1771 } 1772 else 1773 { 1774 if ((language == eLanguageTypeUnknown || 1775 Language::LanguageIsObjC(language)) && 1776 ObjCLanguage::IsPossibleObjCSelector(name_cstr)) 1777 lookup_name_type_mask |= eFunctionNameTypeSelector; 1778 1779 CPlusPlusLanguage::MethodName cpp_method (name); 1780 basename = cpp_method.GetBasename(); 1781 if (basename.empty()) 1782 { 1783 if (CPlusPlusLanguage::ExtractContextAndIdentifier (name_cstr, context, basename)) 1784 lookup_name_type_mask |= (eFunctionNameTypeMethod | eFunctionNameTypeBase); 1785 else 1786 lookup_name_type_mask |= eFunctionNameTypeFull; 1787 } 1788 else 1789 { 1790 lookup_name_type_mask |= (eFunctionNameTypeMethod | eFunctionNameTypeBase); 1791 } 1792 } 1793 } 1794 else 1795 { 1796 lookup_name_type_mask = name_type_mask; 1797 if (lookup_name_type_mask & eFunctionNameTypeMethod || name_type_mask & eFunctionNameTypeBase) 1798 { 1799 // If they've asked for a CPP method or function name and it can't be that, we don't 1800 // even need to search for CPP methods or names. 1801 CPlusPlusLanguage::MethodName cpp_method (name); 1802 if (cpp_method.IsValid()) 1803 { 1804 basename = cpp_method.GetBasename(); 1805 1806 if (!cpp_method.GetQualifiers().empty()) 1807 { 1808 // There is a "const" or other qualifier following the end of the function parens, 1809 // this can't be a eFunctionNameTypeBase 1810 lookup_name_type_mask &= ~(eFunctionNameTypeBase); 1811 if (lookup_name_type_mask == eFunctionNameTypeNone) 1812 return; 1813 } 1814 } 1815 else 1816 { 1817 // If the CPP method parser didn't manage to chop this up, try to fill in the base name if we can. 1818 // If a::b::c is passed in, we need to just look up "c", and then we'll filter the result later. 1819 CPlusPlusLanguage::ExtractContextAndIdentifier (name_cstr, context, basename); 1820 } 1821 } 1822 1823 if (lookup_name_type_mask & eFunctionNameTypeSelector) 1824 { 1825 if (!ObjCLanguage::IsPossibleObjCSelector(name_cstr)) 1826 { 1827 lookup_name_type_mask &= ~(eFunctionNameTypeSelector); 1828 if (lookup_name_type_mask == eFunctionNameTypeNone) 1829 return; 1830 } 1831 } 1832 } 1833 1834 if (!basename.empty()) 1835 { 1836 // The name supplied was a partial C++ path like "a::count". In this case we want to do a 1837 // lookup on the basename "count" and then make sure any matching results contain "a::count" 1838 // so that it would match "b::a::count" and "a::count". This is why we set "match_name_after_lookup" 1839 // to true 1840 lookup_name.SetString(basename); 1841 match_name_after_lookup = true; 1842 } 1843 else 1844 { 1845 // The name is already correct, just use the exact name as supplied, and we won't need 1846 // to check if any matches contain "name" 1847 lookup_name = name; 1848 match_name_after_lookup = false; 1849 } 1850 } 1851 1852 ModuleSP 1853 Module::CreateJITModule (const lldb::ObjectFileJITDelegateSP &delegate_sp) 1854 { 1855 if (delegate_sp) 1856 { 1857 // Must create a module and place it into a shared pointer before 1858 // we can create an object file since it has a std::weak_ptr back 1859 // to the module, so we need to control the creation carefully in 1860 // this static function 1861 ModuleSP module_sp(new Module()); 1862 module_sp->m_objfile_sp.reset (new ObjectFileJIT (module_sp, delegate_sp)); 1863 if (module_sp->m_objfile_sp) 1864 { 1865 // Once we get the object file, update our module with the object file's 1866 // architecture since it might differ in vendor/os if some parts were 1867 // unknown. 1868 module_sp->m_objfile_sp->GetArchitecture (module_sp->m_arch); 1869 } 1870 return module_sp; 1871 } 1872 return ModuleSP(); 1873 } 1874 1875 bool 1876 Module::GetIsDynamicLinkEditor() 1877 { 1878 ObjectFile * obj_file = GetObjectFile (); 1879 1880 if (obj_file) 1881 return obj_file->GetIsDynamicLinkEditor(); 1882 1883 return false; 1884 } 1885