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