1 //===-- SymbolContext.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/Symbol/SymbolContext.h" 11 12 #include "lldb/Core/Log.h" 13 #include "lldb/Core/Module.h" 14 #include "lldb/Core/ModuleSpec.h" 15 #include "lldb/Host/Host.h" 16 #include "lldb/Host/StringConvert.h" 17 #include "lldb/Symbol/Block.h" 18 #include "lldb/Symbol/ClangASTContext.h" 19 #include "lldb/Symbol/CompileUnit.h" 20 #include "lldb/Symbol/ObjectFile.h" 21 #include "lldb/Symbol/Symbol.h" 22 #include "lldb/Symbol/SymbolFile.h" 23 #include "lldb/Symbol/SymbolVendor.h" 24 #include "lldb/Symbol/Variable.h" 25 #include "lldb/Target/Target.h" 26 27 using namespace lldb; 28 using namespace lldb_private; 29 30 SymbolContext::SymbolContext() : 31 target_sp (), 32 module_sp (), 33 comp_unit (nullptr), 34 function (nullptr), 35 block (nullptr), 36 line_entry (), 37 symbol (nullptr), 38 variable (nullptr) 39 { 40 } 41 42 SymbolContext::SymbolContext(const ModuleSP& m, CompileUnit *cu, Function *f, Block *b, LineEntry *le, Symbol *s) : 43 target_sp (), 44 module_sp (m), 45 comp_unit (cu), 46 function (f), 47 block (b), 48 line_entry (), 49 symbol (s), 50 variable (nullptr) 51 { 52 if (le) 53 line_entry = *le; 54 } 55 56 SymbolContext::SymbolContext(const TargetSP &t, const ModuleSP& m, CompileUnit *cu, Function *f, Block *b, LineEntry *le, Symbol *s) : 57 target_sp (t), 58 module_sp (m), 59 comp_unit (cu), 60 function (f), 61 block (b), 62 line_entry (), 63 symbol (s), 64 variable (nullptr) 65 { 66 if (le) 67 line_entry = *le; 68 } 69 70 SymbolContext::SymbolContext(const SymbolContext& rhs) : 71 target_sp (rhs.target_sp), 72 module_sp (rhs.module_sp), 73 comp_unit (rhs.comp_unit), 74 function (rhs.function), 75 block (rhs.block), 76 line_entry (rhs.line_entry), 77 symbol (rhs.symbol), 78 variable (rhs.variable) 79 { 80 } 81 82 83 SymbolContext::SymbolContext (SymbolContextScope *sc_scope) : 84 target_sp (), 85 module_sp (), 86 comp_unit (nullptr), 87 function (nullptr), 88 block (nullptr), 89 line_entry (), 90 symbol (nullptr), 91 variable (nullptr) 92 { 93 sc_scope->CalculateSymbolContext (this); 94 } 95 96 SymbolContext::~SymbolContext () 97 { 98 } 99 100 const SymbolContext& 101 SymbolContext::operator= (const SymbolContext& rhs) 102 { 103 if (this != &rhs) 104 { 105 target_sp = rhs.target_sp; 106 module_sp = rhs.module_sp; 107 comp_unit = rhs.comp_unit; 108 function = rhs.function; 109 block = rhs.block; 110 line_entry = rhs.line_entry; 111 symbol = rhs.symbol; 112 variable = rhs.variable; 113 } 114 return *this; 115 } 116 117 void 118 SymbolContext::Clear(bool clear_target) 119 { 120 if (clear_target) 121 target_sp.reset(); 122 module_sp.reset(); 123 comp_unit = nullptr; 124 function = nullptr; 125 block = nullptr; 126 line_entry.Clear(); 127 symbol = nullptr; 128 variable = nullptr; 129 } 130 131 bool 132 SymbolContext::DumpStopContext ( 133 Stream *s, 134 ExecutionContextScope *exe_scope, 135 const Address &addr, 136 bool show_fullpaths, 137 bool show_module, 138 bool show_inlined_frames, 139 bool show_function_arguments, 140 bool show_function_name 141 ) const 142 { 143 bool dumped_something = false; 144 if (show_module && module_sp) 145 { 146 if (show_fullpaths) 147 *s << module_sp->GetFileSpec(); 148 else 149 *s << module_sp->GetFileSpec().GetFilename(); 150 s->PutChar('`'); 151 dumped_something = true; 152 } 153 154 if (function != nullptr) 155 { 156 SymbolContext inline_parent_sc; 157 Address inline_parent_addr; 158 if (show_function_name == false) 159 { 160 s->Printf("<"); 161 dumped_something = true; 162 } 163 else 164 { 165 ConstString name; 166 if (show_function_arguments == false) 167 name = function->GetNameNoArguments(); 168 if (!name) 169 name = function->GetName(); 170 if (name) 171 name.Dump(s); 172 } 173 174 if (addr.IsValid()) 175 { 176 const addr_t function_offset = addr.GetOffset() - function->GetAddressRange().GetBaseAddress().GetOffset(); 177 if (show_function_name == false) 178 { 179 // Print +offset even if offset is 0 180 dumped_something = true; 181 s->Printf("+%" PRIu64 ">", function_offset); 182 } 183 else if (function_offset) 184 { 185 dumped_something = true; 186 s->Printf(" + %" PRIu64, function_offset); 187 } 188 } 189 190 if (GetParentOfInlinedScope (addr, inline_parent_sc, inline_parent_addr)) 191 { 192 dumped_something = true; 193 Block *inlined_block = block->GetContainingInlinedBlock(); 194 const InlineFunctionInfo* inlined_block_info = inlined_block->GetInlinedFunctionInfo(); 195 s->Printf (" [inlined] %s", inlined_block_info->GetName(function->GetLanguage()).GetCString()); 196 197 lldb_private::AddressRange block_range; 198 if (inlined_block->GetRangeContainingAddress(addr, block_range)) 199 { 200 const addr_t inlined_function_offset = addr.GetOffset() - block_range.GetBaseAddress().GetOffset(); 201 if (inlined_function_offset) 202 { 203 s->Printf(" + %" PRIu64, inlined_function_offset); 204 } 205 } 206 const Declaration &call_site = inlined_block_info->GetCallSite(); 207 if (call_site.IsValid()) 208 { 209 s->PutCString(" at "); 210 call_site.DumpStopContext (s, show_fullpaths); 211 } 212 if (show_inlined_frames) 213 { 214 s->EOL(); 215 s->Indent(); 216 const bool show_function_name = true; 217 return inline_parent_sc.DumpStopContext (s, exe_scope, inline_parent_addr, show_fullpaths, show_module, show_inlined_frames, show_function_arguments, show_function_name); 218 } 219 } 220 else 221 { 222 if (line_entry.IsValid()) 223 { 224 dumped_something = true; 225 s->PutCString(" at "); 226 if (line_entry.DumpStopContext(s, show_fullpaths)) 227 dumped_something = true; 228 } 229 } 230 } 231 else if (symbol != nullptr) 232 { 233 if (show_function_name == false) 234 { 235 s->Printf("<"); 236 dumped_something = true; 237 } 238 else if (symbol->GetName()) 239 { 240 dumped_something = true; 241 if (symbol->GetType() == eSymbolTypeTrampoline) 242 s->PutCString("symbol stub for: "); 243 symbol->GetName().Dump(s); 244 } 245 246 if (addr.IsValid() && symbol->ValueIsAddress()) 247 { 248 const addr_t symbol_offset = addr.GetOffset() - symbol->GetAddressRef().GetOffset(); 249 if (show_function_name == false) 250 { 251 // Print +offset even if offset is 0 252 dumped_something = true; 253 s->Printf("+%" PRIu64 ">", symbol_offset); 254 } 255 else if (symbol_offset) 256 { 257 dumped_something = true; 258 s->Printf(" + %" PRIu64, symbol_offset); 259 } 260 } 261 } 262 else if (addr.IsValid()) 263 { 264 addr.Dump(s, exe_scope, Address::DumpStyleModuleWithFileAddress); 265 dumped_something = true; 266 } 267 return dumped_something; 268 } 269 270 void 271 SymbolContext::GetDescription(Stream *s, lldb::DescriptionLevel level, Target *target) const 272 { 273 if (module_sp) 274 { 275 s->Indent(" Module: file = \""); 276 module_sp->GetFileSpec().Dump(s); 277 *s << '"'; 278 if (module_sp->GetArchitecture().IsValid()) 279 s->Printf (", arch = \"%s\"", module_sp->GetArchitecture().GetArchitectureName()); 280 s->EOL(); 281 } 282 283 if (comp_unit != nullptr) 284 { 285 s->Indent("CompileUnit: "); 286 comp_unit->GetDescription (s, level); 287 s->EOL(); 288 } 289 290 if (function != nullptr) 291 { 292 s->Indent(" Function: "); 293 function->GetDescription (s, level, target); 294 s->EOL(); 295 296 Type *func_type = function->GetType(); 297 if (func_type) 298 { 299 s->Indent(" FuncType: "); 300 func_type->GetDescription (s, level, false); 301 s->EOL(); 302 } 303 } 304 305 if (block != nullptr) 306 { 307 std::vector<Block *> blocks; 308 blocks.push_back (block); 309 Block *parent_block = block->GetParent(); 310 311 while (parent_block) 312 { 313 blocks.push_back (parent_block); 314 parent_block = parent_block->GetParent(); 315 } 316 std::vector<Block *>::reverse_iterator pos; 317 std::vector<Block *>::reverse_iterator begin = blocks.rbegin(); 318 std::vector<Block *>::reverse_iterator end = blocks.rend(); 319 for (pos = begin; pos != end; ++pos) 320 { 321 if (pos == begin) 322 s->Indent(" Blocks: "); 323 else 324 s->Indent(" "); 325 (*pos)->GetDescription(s, function, level, target); 326 s->EOL(); 327 } 328 } 329 330 if (line_entry.IsValid()) 331 { 332 s->Indent(" LineEntry: "); 333 line_entry.GetDescription (s, level, comp_unit, target, false); 334 s->EOL(); 335 } 336 337 if (symbol != nullptr) 338 { 339 s->Indent(" Symbol: "); 340 symbol->GetDescription(s, level, target); 341 s->EOL(); 342 } 343 344 if (variable != nullptr) 345 { 346 s->Indent(" Variable: "); 347 348 s->Printf("id = {0x%8.8" PRIx64 "}, ", variable->GetID()); 349 350 switch (variable->GetScope()) 351 { 352 case eValueTypeVariableGlobal: 353 s->PutCString("kind = global, "); 354 break; 355 356 case eValueTypeVariableStatic: 357 s->PutCString("kind = static, "); 358 break; 359 360 case eValueTypeVariableArgument: 361 s->PutCString("kind = argument, "); 362 break; 363 364 case eValueTypeVariableLocal: 365 s->PutCString("kind = local, "); 366 break; 367 368 default: 369 break; 370 } 371 372 s->Printf ("name = \"%s\"\n", variable->GetName().GetCString()); 373 } 374 } 375 376 uint32_t 377 SymbolContext::GetResolvedMask () const 378 { 379 uint32_t resolved_mask = 0; 380 if (target_sp) resolved_mask |= eSymbolContextTarget; 381 if (module_sp) resolved_mask |= eSymbolContextModule; 382 if (comp_unit) resolved_mask |= eSymbolContextCompUnit; 383 if (function) resolved_mask |= eSymbolContextFunction; 384 if (block) resolved_mask |= eSymbolContextBlock; 385 if (line_entry.IsValid()) resolved_mask |= eSymbolContextLineEntry; 386 if (symbol) resolved_mask |= eSymbolContextSymbol; 387 if (variable) resolved_mask |= eSymbolContextVariable; 388 return resolved_mask; 389 } 390 391 void 392 SymbolContext::Dump(Stream *s, Target *target) const 393 { 394 *s << this << ": "; 395 s->Indent(); 396 s->PutCString("SymbolContext"); 397 s->IndentMore(); 398 s->EOL(); 399 s->IndentMore(); 400 s->Indent(); 401 *s << "Module = " << module_sp.get() << ' '; 402 if (module_sp) 403 module_sp->GetFileSpec().Dump(s); 404 s->EOL(); 405 s->Indent(); 406 *s << "CompileUnit = " << comp_unit; 407 if (comp_unit != nullptr) 408 *s << " {0x" << comp_unit->GetID() << "} " << *(static_cast<FileSpec*> (comp_unit)); 409 s->EOL(); 410 s->Indent(); 411 *s << "Function = " << function; 412 if (function != nullptr) 413 { 414 *s << " {0x" << function->GetID() << "} " << function->GetType()->GetName() << ", address-range = "; 415 function->GetAddressRange().Dump(s, target, Address::DumpStyleLoadAddress, Address::DumpStyleModuleWithFileAddress); 416 s->EOL(); 417 s->Indent(); 418 Type* func_type = function->GetType(); 419 if (func_type) 420 { 421 *s << " Type = "; 422 func_type->Dump (s, false); 423 } 424 } 425 s->EOL(); 426 s->Indent(); 427 *s << "Block = " << block; 428 if (block != nullptr) 429 *s << " {0x" << block->GetID() << '}'; 430 // Dump the block and pass it a negative depth to we print all the parent blocks 431 //if (block != NULL) 432 // block->Dump(s, function->GetFileAddress(), INT_MIN); 433 s->EOL(); 434 s->Indent(); 435 *s << "LineEntry = "; 436 line_entry.Dump (s, target, true, Address::DumpStyleLoadAddress, Address::DumpStyleModuleWithFileAddress, true); 437 s->EOL(); 438 s->Indent(); 439 *s << "Symbol = " << symbol; 440 if (symbol != nullptr && symbol->GetMangled()) 441 *s << ' ' << symbol->GetName().AsCString(); 442 s->EOL(); 443 *s << "Variable = " << variable; 444 if (variable != nullptr) 445 { 446 *s << " {0x" << variable->GetID() << "} " << variable->GetType()->GetName(); 447 s->EOL(); 448 } 449 s->IndentLess(); 450 s->IndentLess(); 451 } 452 453 bool 454 lldb_private::operator== (const SymbolContext& lhs, const SymbolContext& rhs) 455 { 456 return lhs.function == rhs.function 457 && lhs.symbol == rhs.symbol 458 && lhs.module_sp.get() == rhs.module_sp.get() 459 && lhs.comp_unit == rhs.comp_unit 460 && lhs.target_sp.get() == rhs.target_sp.get() 461 && LineEntry::Compare(lhs.line_entry, rhs.line_entry) == 0 462 && lhs.variable == rhs.variable; 463 } 464 465 bool 466 lldb_private::operator!= (const SymbolContext& lhs, const SymbolContext& rhs) 467 { 468 return lhs.function != rhs.function 469 || lhs.symbol != rhs.symbol 470 || lhs.module_sp.get() != rhs.module_sp.get() 471 || lhs.comp_unit != rhs.comp_unit 472 || lhs.target_sp.get() != rhs.target_sp.get() 473 || LineEntry::Compare(lhs.line_entry, rhs.line_entry) != 0 474 || lhs.variable != rhs.variable; 475 } 476 477 bool 478 SymbolContext::GetAddressRange (uint32_t scope, 479 uint32_t range_idx, 480 bool use_inline_block_range, 481 AddressRange &range) const 482 { 483 if ((scope & eSymbolContextLineEntry) && line_entry.IsValid()) 484 { 485 range = line_entry.range; 486 return true; 487 } 488 489 if ((scope & eSymbolContextBlock) && (block != nullptr)) 490 { 491 if (use_inline_block_range) 492 { 493 Block *inline_block = block->GetContainingInlinedBlock(); 494 if (inline_block) 495 return inline_block->GetRangeAtIndex (range_idx, range); 496 } 497 else 498 { 499 return block->GetRangeAtIndex (range_idx, range); 500 } 501 } 502 503 if ((scope & eSymbolContextFunction) && (function != nullptr)) 504 { 505 if (range_idx == 0) 506 { 507 range = function->GetAddressRange(); 508 return true; 509 } 510 } 511 512 if ((scope & eSymbolContextSymbol) && (symbol != nullptr)) 513 { 514 if (range_idx == 0) 515 { 516 if (symbol->ValueIsAddress()) 517 { 518 range.GetBaseAddress() = symbol->GetAddressRef(); 519 range.SetByteSize (symbol->GetByteSize()); 520 return true; 521 } 522 } 523 } 524 range.Clear(); 525 return false; 526 } 527 528 bool 529 SymbolContext::GetParentOfInlinedScope (const Address &curr_frame_pc, 530 SymbolContext &next_frame_sc, 531 Address &next_frame_pc) const 532 { 533 next_frame_sc.Clear(false); 534 next_frame_pc.Clear(); 535 536 if (block) 537 { 538 //const addr_t curr_frame_file_addr = curr_frame_pc.GetFileAddress(); 539 540 // In order to get the parent of an inlined function we first need to 541 // see if we are in an inlined block as "this->block" could be an 542 // inlined block, or a parent of "block" could be. So lets check if 543 // this block or one of this blocks parents is an inlined function. 544 Block *curr_inlined_block = block->GetContainingInlinedBlock(); 545 if (curr_inlined_block) 546 { 547 // "this->block" is contained in an inline function block, so to 548 // get the scope above the inlined block, we get the parent of the 549 // inlined block itself 550 Block *next_frame_block = curr_inlined_block->GetParent(); 551 // Now calculate the symbol context of the containing block 552 next_frame_block->CalculateSymbolContext (&next_frame_sc); 553 554 // If we get here we weren't able to find the return line entry using the nesting of the blocks and 555 // the line table. So just use the call site info from our inlined block. 556 557 AddressRange range; 558 if (curr_inlined_block->GetRangeContainingAddress (curr_frame_pc, range)) 559 { 560 // To see there this new frame block it, we need to look at the 561 // call site information from 562 const InlineFunctionInfo* curr_inlined_block_inlined_info = curr_inlined_block->GetInlinedFunctionInfo(); 563 next_frame_pc = range.GetBaseAddress(); 564 next_frame_sc.line_entry.range.GetBaseAddress() = next_frame_pc; 565 next_frame_sc.line_entry.file = curr_inlined_block_inlined_info->GetCallSite().GetFile(); 566 next_frame_sc.line_entry.line = curr_inlined_block_inlined_info->GetCallSite().GetLine(); 567 next_frame_sc.line_entry.column = curr_inlined_block_inlined_info->GetCallSite().GetColumn(); 568 return true; 569 } 570 else 571 { 572 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_SYMBOLS)); 573 574 if (log) 575 { 576 log->Printf ("warning: inlined block 0x%8.8" PRIx64 " doesn't have a range that contains file address 0x%" PRIx64, 577 curr_inlined_block->GetID(), curr_frame_pc.GetFileAddress()); 578 } 579 #ifdef LLDB_CONFIGURATION_DEBUG 580 else 581 { 582 ObjectFile *objfile = NULL; 583 if (module_sp) 584 { 585 SymbolVendor *symbol_vendor = module_sp->GetSymbolVendor(); 586 if (symbol_vendor) 587 { 588 SymbolFile *symbol_file = symbol_vendor->GetSymbolFile(); 589 if (symbol_file) 590 objfile = symbol_file->GetObjectFile(); 591 } 592 } 593 if (objfile) 594 { 595 Host::SystemLog (Host::eSystemLogWarning, 596 "warning: inlined block 0x%8.8" PRIx64 " doesn't have a range that contains file address 0x%" PRIx64 " in %s\n", 597 curr_inlined_block->GetID(), 598 curr_frame_pc.GetFileAddress(), 599 objfile->GetFileSpec().GetPath().c_str()); 600 } 601 else 602 { 603 Host::SystemLog (Host::eSystemLogWarning, 604 "warning: inlined block 0x%8.8" PRIx64 " doesn't have a range that contains file address 0x%" PRIx64 "\n", 605 curr_inlined_block->GetID(), 606 curr_frame_pc.GetFileAddress()); 607 } 608 } 609 #endif 610 } 611 } 612 } 613 614 return false; 615 } 616 617 Block * 618 SymbolContext::GetFunctionBlock () 619 { 620 if (function) 621 { 622 if (block) 623 { 624 // If this symbol context has a block, check to see if this block 625 // is itself, or is contained within a block with inlined function 626 // information. If so, then the inlined block is the block that 627 // defines the function. 628 Block *inlined_block = block->GetContainingInlinedBlock(); 629 if (inlined_block) 630 return inlined_block; 631 632 // The block in this symbol context is not inside an inlined 633 // block, so the block that defines the function is the function's 634 // top level block, which is returned below. 635 } 636 637 // There is no block information in this symbol context, so we must 638 // assume that the block that is desired is the top level block of 639 // the function itself. 640 return &function->GetBlock(true); 641 } 642 return nullptr; 643 } 644 645 bool 646 SymbolContext::GetFunctionMethodInfo (lldb::LanguageType &language, 647 bool &is_instance_method, 648 ConstString &language_object_name) 649 650 651 { 652 Block *function_block = GetFunctionBlock(); 653 if (function_block) 654 { 655 CompilerDeclContext decl_ctx = function_block->GetDeclContext(); 656 if (decl_ctx) 657 return decl_ctx.IsClassMethod(&language, &is_instance_method, &language_object_name); 658 } 659 return false; 660 } 661 662 void 663 SymbolContext::SortTypeList(TypeMap &type_map, TypeList &type_list) const 664 { 665 Block * curr_block = block; 666 bool isInlinedblock = false; 667 if (curr_block != nullptr && curr_block->GetContainingInlinedBlock() != nullptr) 668 isInlinedblock = true; 669 670 //---------------------------------------------------------------------- 671 // Find all types that match the current block if we have one and put 672 // them first in the list. Keep iterating up through all blocks. 673 //---------------------------------------------------------------------- 674 while (curr_block != nullptr && !isInlinedblock) 675 { 676 type_map.ForEach([curr_block, &type_list](const lldb::TypeSP& type_sp) -> bool { 677 SymbolContextScope *scs = type_sp->GetSymbolContextScope(); 678 if (scs && curr_block == scs->CalculateSymbolContextBlock()) 679 type_list.Insert(type_sp); 680 return true; // Keep iterating 681 }); 682 683 // Remove any entries that are now in "type_list" from "type_map" 684 // since we can't remove from type_map while iterating 685 type_list.ForEach([&type_map](const lldb::TypeSP& type_sp) -> bool { 686 type_map.Remove(type_sp); 687 return true; // Keep iterating 688 }); 689 curr_block = curr_block->GetParent(); 690 } 691 //---------------------------------------------------------------------- 692 // Find all types that match the current function, if we have onem, and 693 // put them next in the list. 694 //---------------------------------------------------------------------- 695 if (function != nullptr && !type_map.Empty()) 696 { 697 const size_t old_type_list_size = type_list.GetSize(); 698 type_map.ForEach([this, &type_list](const lldb::TypeSP& type_sp) -> bool { 699 SymbolContextScope *scs = type_sp->GetSymbolContextScope(); 700 if (scs && function == scs->CalculateSymbolContextFunction()) 701 type_list.Insert(type_sp); 702 return true; // Keep iterating 703 }); 704 705 // Remove any entries that are now in "type_list" from "type_map" 706 // since we can't remove from type_map while iterating 707 const size_t new_type_list_size = type_list.GetSize(); 708 if (new_type_list_size > old_type_list_size) 709 { 710 for (size_t i=old_type_list_size; i<new_type_list_size; ++i) 711 type_map.Remove(type_list.GetTypeAtIndex(i)); 712 } 713 } 714 //---------------------------------------------------------------------- 715 // Find all types that match the current compile unit, if we have one, 716 // and put them next in the list. 717 //---------------------------------------------------------------------- 718 if (comp_unit != nullptr && !type_map.Empty()) 719 { 720 const size_t old_type_list_size = type_list.GetSize(); 721 722 type_map.ForEach([this, &type_list](const lldb::TypeSP& type_sp) -> bool { 723 SymbolContextScope *scs = type_sp->GetSymbolContextScope(); 724 if (scs && comp_unit == scs->CalculateSymbolContextCompileUnit()) 725 type_list.Insert(type_sp); 726 return true; // Keep iterating 727 }); 728 729 // Remove any entries that are now in "type_list" from "type_map" 730 // since we can't remove from type_map while iterating 731 const size_t new_type_list_size = type_list.GetSize(); 732 if (new_type_list_size > old_type_list_size) 733 { 734 for (size_t i=old_type_list_size; i<new_type_list_size; ++i) 735 type_map.Remove(type_list.GetTypeAtIndex(i)); 736 } 737 } 738 //---------------------------------------------------------------------- 739 // Find all types that match the current module, if we have one, and put 740 // them next in the list. 741 //---------------------------------------------------------------------- 742 if (module_sp && !type_map.Empty()) 743 { 744 const size_t old_type_list_size = type_list.GetSize(); 745 type_map.ForEach([this, &type_list](const lldb::TypeSP& type_sp) -> bool { 746 SymbolContextScope *scs = type_sp->GetSymbolContextScope(); 747 if (scs && module_sp == scs->CalculateSymbolContextModule()) 748 type_list.Insert(type_sp); 749 return true; // Keep iterating 750 }); 751 // Remove any entries that are now in "type_list" from "type_map" 752 // since we can't remove from type_map while iterating 753 const size_t new_type_list_size = type_list.GetSize(); 754 if (new_type_list_size > old_type_list_size) 755 { 756 for (size_t i=old_type_list_size; i<new_type_list_size; ++i) 757 type_map.Remove(type_list.GetTypeAtIndex(i)); 758 } 759 } 760 //---------------------------------------------------------------------- 761 // Any types that are left get copied into the list an any order. 762 //---------------------------------------------------------------------- 763 if (!type_map.Empty()) 764 { 765 type_map.ForEach([&type_list](const lldb::TypeSP& type_sp) -> bool { 766 type_list.Insert(type_sp); 767 return true; // Keep iterating 768 }); 769 } 770 } 771 772 ConstString 773 SymbolContext::GetFunctionName (Mangled::NamePreference preference) const 774 { 775 if (function) 776 { 777 if (block) 778 { 779 Block *inlined_block = block->GetContainingInlinedBlock(); 780 781 if (inlined_block) 782 { 783 const InlineFunctionInfo *inline_info = inlined_block->GetInlinedFunctionInfo(); 784 if (inline_info) 785 return inline_info->GetName(function->GetLanguage()); 786 } 787 } 788 return function->GetMangled().GetName(function->GetLanguage(), preference); 789 } 790 else if (symbol && symbol->ValueIsAddress()) 791 { 792 return symbol->GetMangled().GetName(symbol->GetLanguage(), preference); 793 } 794 else 795 { 796 // No function, return an empty string. 797 return ConstString(); 798 } 799 } 800 801 LineEntry 802 SymbolContext::GetFunctionStartLineEntry () const 803 { 804 LineEntry line_entry; 805 Address start_addr; 806 if (block) 807 { 808 Block *inlined_block = block->GetContainingInlinedBlock(); 809 if (inlined_block) 810 { 811 if (inlined_block->GetStartAddress (start_addr)) 812 { 813 if (start_addr.CalculateSymbolContextLineEntry (line_entry)) 814 return line_entry; 815 } 816 return LineEntry(); 817 } 818 } 819 820 if (function) 821 { 822 if (function->GetAddressRange().GetBaseAddress().CalculateSymbolContextLineEntry(line_entry)) 823 return line_entry; 824 } 825 return LineEntry(); 826 } 827 828 //---------------------------------------------------------------------- 829 // 830 // SymbolContextSpecifier 831 // 832 //---------------------------------------------------------------------- 833 834 SymbolContextSpecifier::SymbolContextSpecifier (const TargetSP &target_sp) : 835 m_target_sp (target_sp), 836 m_module_spec (), 837 m_module_sp (), 838 m_file_spec_ap (), 839 m_start_line (0), 840 m_end_line (0), 841 m_function_spec (), 842 m_class_name (), 843 m_address_range_ap (), 844 m_type (eNothingSpecified) 845 { 846 } 847 848 SymbolContextSpecifier::~SymbolContextSpecifier() 849 { 850 } 851 852 bool 853 SymbolContextSpecifier::AddLineSpecification (uint32_t line_no, SpecificationType type) 854 { 855 bool return_value = true; 856 switch (type) 857 { 858 case eNothingSpecified: 859 Clear(); 860 break; 861 case eLineStartSpecified: 862 m_start_line = line_no; 863 m_type |= eLineStartSpecified; 864 break; 865 case eLineEndSpecified: 866 m_end_line = line_no; 867 m_type |= eLineEndSpecified; 868 break; 869 default: 870 return_value = false; 871 break; 872 } 873 return return_value; 874 } 875 876 bool 877 SymbolContextSpecifier::AddSpecification (const char *spec_string, SpecificationType type) 878 { 879 bool return_value = true; 880 switch (type) 881 { 882 case eNothingSpecified: 883 Clear(); 884 break; 885 case eModuleSpecified: 886 { 887 // See if we can find the Module, if so stick it in the SymbolContext. 888 FileSpec module_file_spec(spec_string, false); 889 ModuleSpec module_spec (module_file_spec); 890 lldb::ModuleSP module_sp (m_target_sp->GetImages().FindFirstModule (module_spec)); 891 m_type |= eModuleSpecified; 892 if (module_sp) 893 m_module_sp = module_sp; 894 else 895 m_module_spec.assign (spec_string); 896 } 897 break; 898 case eFileSpecified: 899 // CompUnits can't necessarily be resolved here, since an inlined function might show up in 900 // a number of CompUnits. Instead we just convert to a FileSpec and store it away. 901 m_file_spec_ap.reset (new FileSpec (spec_string, false)); 902 m_type |= eFileSpecified; 903 break; 904 case eLineStartSpecified: 905 m_start_line = StringConvert::ToSInt32(spec_string, 0, 0, &return_value); 906 if (return_value) 907 m_type |= eLineStartSpecified; 908 break; 909 case eLineEndSpecified: 910 m_end_line = StringConvert::ToSInt32(spec_string, 0, 0, &return_value); 911 if (return_value) 912 m_type |= eLineEndSpecified; 913 break; 914 case eFunctionSpecified: 915 m_function_spec.assign(spec_string); 916 m_type |= eFunctionSpecified; 917 break; 918 case eClassOrNamespaceSpecified: 919 Clear(); 920 m_class_name.assign (spec_string); 921 m_type = eClassOrNamespaceSpecified; 922 break; 923 case eAddressRangeSpecified: 924 // Not specified yet... 925 break; 926 } 927 928 return return_value; 929 } 930 931 void 932 SymbolContextSpecifier::Clear() 933 { 934 m_module_spec.clear(); 935 m_file_spec_ap.reset(); 936 m_function_spec.clear(); 937 m_class_name.clear(); 938 m_start_line = 0; 939 m_end_line = 0; 940 m_address_range_ap.reset(); 941 942 m_type = eNothingSpecified; 943 } 944 945 bool 946 SymbolContextSpecifier::SymbolContextMatches(SymbolContext &sc) 947 { 948 if (m_type == eNothingSpecified) 949 return true; 950 951 if (m_target_sp.get() != sc.target_sp.get()) 952 return false; 953 954 if (m_type & eModuleSpecified) 955 { 956 if (sc.module_sp) 957 { 958 if (m_module_sp.get() != nullptr) 959 { 960 if (m_module_sp.get() != sc.module_sp.get()) 961 return false; 962 } 963 else 964 { 965 FileSpec module_file_spec (m_module_spec.c_str(), false); 966 if (!FileSpec::Equal (module_file_spec, sc.module_sp->GetFileSpec(), false)) 967 return false; 968 } 969 } 970 } 971 if (m_type & eFileSpecified) 972 { 973 if (m_file_spec_ap.get()) 974 { 975 // If we don't have a block or a comp_unit, then we aren't going to match a source file. 976 if (sc.block == nullptr && sc.comp_unit == nullptr) 977 return false; 978 979 // Check if the block is present, and if so is it inlined: 980 bool was_inlined = false; 981 if (sc.block != nullptr) 982 { 983 const InlineFunctionInfo *inline_info = sc.block->GetInlinedFunctionInfo(); 984 if (inline_info != nullptr) 985 { 986 was_inlined = true; 987 if (!FileSpec::Equal (inline_info->GetDeclaration().GetFile(), *(m_file_spec_ap.get()), false)) 988 return false; 989 } 990 } 991 992 // Next check the comp unit, but only if the SymbolContext was not inlined. 993 if (!was_inlined && sc.comp_unit != nullptr) 994 { 995 if (!FileSpec::Equal (*(sc.comp_unit), *(m_file_spec_ap.get()), false)) 996 return false; 997 } 998 } 999 } 1000 if (m_type & eLineStartSpecified 1001 || m_type & eLineEndSpecified) 1002 { 1003 if (sc.line_entry.line < m_start_line || sc.line_entry.line > m_end_line) 1004 return false; 1005 } 1006 1007 if (m_type & eFunctionSpecified) 1008 { 1009 // First check the current block, and if it is inlined, get the inlined function name: 1010 bool was_inlined = false; 1011 ConstString func_name(m_function_spec.c_str()); 1012 1013 if (sc.block != nullptr) 1014 { 1015 const InlineFunctionInfo *inline_info = sc.block->GetInlinedFunctionInfo(); 1016 if (inline_info != nullptr) 1017 { 1018 was_inlined = true; 1019 const Mangled &name = inline_info->GetMangled(); 1020 if (!name.NameMatches (func_name, sc.function->GetLanguage())) 1021 return false; 1022 } 1023 } 1024 // If it wasn't inlined, check the name in the function or symbol: 1025 if (!was_inlined) 1026 { 1027 if (sc.function != nullptr) 1028 { 1029 if (!sc.function->GetMangled().NameMatches(func_name, sc.function->GetLanguage())) 1030 return false; 1031 } 1032 else if (sc.symbol != nullptr) 1033 { 1034 if (!sc.symbol->GetMangled().NameMatches(func_name, sc.symbol->GetLanguage())) 1035 return false; 1036 } 1037 } 1038 1039 1040 } 1041 1042 return true; 1043 } 1044 1045 bool 1046 SymbolContextSpecifier::AddressMatches(lldb::addr_t addr) 1047 { 1048 if (m_type & eAddressRangeSpecified) 1049 { 1050 1051 } 1052 else 1053 { 1054 Address match_address (addr, nullptr); 1055 SymbolContext sc; 1056 m_target_sp->GetImages().ResolveSymbolContextForAddress(match_address, eSymbolContextEverything, sc); 1057 return SymbolContextMatches(sc); 1058 } 1059 return true; 1060 } 1061 1062 void 1063 SymbolContextSpecifier::GetDescription (Stream *s, lldb::DescriptionLevel level) const 1064 { 1065 char path_str[PATH_MAX + 1]; 1066 1067 if (m_type == eNothingSpecified) 1068 { 1069 s->Printf ("Nothing specified.\n"); 1070 } 1071 1072 if (m_type == eModuleSpecified) 1073 { 1074 s->Indent(); 1075 if (m_module_sp) 1076 { 1077 m_module_sp->GetFileSpec().GetPath (path_str, PATH_MAX); 1078 s->Printf ("Module: %s\n", path_str); 1079 } 1080 else 1081 s->Printf ("Module: %s\n", m_module_spec.c_str()); 1082 } 1083 1084 if (m_type == eFileSpecified && m_file_spec_ap.get() != nullptr) 1085 { 1086 m_file_spec_ap->GetPath (path_str, PATH_MAX); 1087 s->Indent(); 1088 s->Printf ("File: %s", path_str); 1089 if (m_type == eLineStartSpecified) 1090 { 1091 s->Printf (" from line %" PRIu64 "", (uint64_t)m_start_line); 1092 if (m_type == eLineEndSpecified) 1093 s->Printf ("to line %" PRIu64 "", (uint64_t)m_end_line); 1094 else 1095 s->Printf ("to end"); 1096 } 1097 else if (m_type == eLineEndSpecified) 1098 { 1099 s->Printf (" from start to line %" PRIu64 "", (uint64_t)m_end_line); 1100 } 1101 s->Printf (".\n"); 1102 } 1103 1104 if (m_type == eLineStartSpecified) 1105 { 1106 s->Indent(); 1107 s->Printf ("From line %" PRIu64 "", (uint64_t)m_start_line); 1108 if (m_type == eLineEndSpecified) 1109 s->Printf ("to line %" PRIu64 "", (uint64_t)m_end_line); 1110 else 1111 s->Printf ("to end"); 1112 s->Printf (".\n"); 1113 } 1114 else if (m_type == eLineEndSpecified) 1115 { 1116 s->Printf ("From start to line %" PRIu64 ".\n", (uint64_t)m_end_line); 1117 } 1118 1119 if (m_type == eFunctionSpecified) 1120 { 1121 s->Indent(); 1122 s->Printf ("Function: %s.\n", m_function_spec.c_str()); 1123 } 1124 1125 if (m_type == eClassOrNamespaceSpecified) 1126 { 1127 s->Indent(); 1128 s->Printf ("Class name: %s.\n", m_class_name.c_str()); 1129 } 1130 1131 if (m_type == eAddressRangeSpecified && m_address_range_ap.get() != nullptr) 1132 { 1133 s->Indent(); 1134 s->PutCString ("Address range: "); 1135 m_address_range_ap->Dump (s, m_target_sp.get(), Address::DumpStyleLoadAddress, Address::DumpStyleFileAddress); 1136 s->PutCString ("\n"); 1137 } 1138 } 1139 1140 //---------------------------------------------------------------------- 1141 // 1142 // SymbolContextList 1143 // 1144 //---------------------------------------------------------------------- 1145 1146 1147 SymbolContextList::SymbolContextList() : 1148 m_symbol_contexts() 1149 { 1150 } 1151 1152 SymbolContextList::~SymbolContextList() 1153 { 1154 } 1155 1156 void 1157 SymbolContextList::Append(const SymbolContext& sc) 1158 { 1159 m_symbol_contexts.push_back(sc); 1160 } 1161 1162 void 1163 SymbolContextList::Append (const SymbolContextList& sc_list) 1164 { 1165 collection::const_iterator pos, end = sc_list.m_symbol_contexts.end(); 1166 for (pos = sc_list.m_symbol_contexts.begin(); pos != end; ++pos) 1167 m_symbol_contexts.push_back (*pos); 1168 } 1169 1170 1171 uint32_t 1172 SymbolContextList::AppendIfUnique (const SymbolContextList& sc_list, bool merge_symbol_into_function) 1173 { 1174 uint32_t unique_sc_add_count = 0; 1175 collection::const_iterator pos, end = sc_list.m_symbol_contexts.end(); 1176 for (pos = sc_list.m_symbol_contexts.begin(); pos != end; ++pos) 1177 { 1178 if (AppendIfUnique (*pos, merge_symbol_into_function)) 1179 ++unique_sc_add_count; 1180 } 1181 return unique_sc_add_count; 1182 } 1183 1184 bool 1185 SymbolContextList::AppendIfUnique (const SymbolContext& sc, bool merge_symbol_into_function) 1186 { 1187 collection::iterator pos, end = m_symbol_contexts.end(); 1188 for (pos = m_symbol_contexts.begin(); pos != end; ++pos) 1189 { 1190 if (*pos == sc) 1191 return false; 1192 } 1193 if (merge_symbol_into_function 1194 && sc.symbol != nullptr 1195 && sc.comp_unit == nullptr 1196 && sc.function == nullptr 1197 && sc.block == nullptr 1198 && sc.line_entry.IsValid() == false) 1199 { 1200 if (sc.symbol->ValueIsAddress()) 1201 { 1202 for (pos = m_symbol_contexts.begin(); pos != end; ++pos) 1203 { 1204 // Don't merge symbols into inlined function symbol contexts 1205 if (pos->block && pos->block->GetContainingInlinedBlock()) 1206 continue; 1207 1208 if (pos->function) 1209 { 1210 if (pos->function->GetAddressRange().GetBaseAddress() == sc.symbol->GetAddressRef()) 1211 { 1212 // Do we already have a function with this symbol? 1213 if (pos->symbol == sc.symbol) 1214 return false; 1215 if (pos->symbol == nullptr) 1216 { 1217 pos->symbol = sc.symbol; 1218 return false; 1219 } 1220 } 1221 } 1222 } 1223 } 1224 } 1225 m_symbol_contexts.push_back(sc); 1226 return true; 1227 } 1228 1229 bool 1230 SymbolContextList::MergeSymbolContextIntoFunctionContext (const SymbolContext& symbol_sc, 1231 uint32_t start_idx, 1232 uint32_t stop_idx) 1233 { 1234 if (symbol_sc.symbol != nullptr 1235 && symbol_sc.comp_unit == nullptr 1236 && symbol_sc.function == nullptr 1237 && symbol_sc.block == nullptr 1238 && symbol_sc.line_entry.IsValid() == false) 1239 { 1240 if (symbol_sc.symbol->ValueIsAddress()) 1241 { 1242 const size_t end = std::min<size_t>(m_symbol_contexts.size(), stop_idx); 1243 for (size_t i=start_idx; i<end; ++i) 1244 { 1245 const SymbolContext &function_sc = m_symbol_contexts[i]; 1246 // Don't merge symbols into inlined function symbol contexts 1247 if (function_sc.block && function_sc.block->GetContainingInlinedBlock()) 1248 continue; 1249 1250 if (function_sc.function) 1251 { 1252 if (function_sc.function->GetAddressRange().GetBaseAddress() == symbol_sc.symbol->GetAddressRef()) 1253 { 1254 // Do we already have a function with this symbol? 1255 if (function_sc.symbol == symbol_sc.symbol) 1256 return true; // Already have a symbol context with this symbol, return true 1257 1258 if (function_sc.symbol == nullptr) 1259 { 1260 // We successfully merged this symbol into an existing symbol context 1261 m_symbol_contexts[i].symbol = symbol_sc.symbol; 1262 return true; 1263 } 1264 } 1265 } 1266 } 1267 } 1268 } 1269 return false; 1270 } 1271 1272 void 1273 SymbolContextList::Clear() 1274 { 1275 m_symbol_contexts.clear(); 1276 } 1277 1278 void 1279 SymbolContextList::Dump(Stream *s, Target *target) const 1280 { 1281 1282 *s << this << ": "; 1283 s->Indent(); 1284 s->PutCString("SymbolContextList"); 1285 s->EOL(); 1286 s->IndentMore(); 1287 1288 collection::const_iterator pos, end = m_symbol_contexts.end(); 1289 for (pos = m_symbol_contexts.begin(); pos != end; ++pos) 1290 { 1291 //pos->Dump(s, target); 1292 pos->GetDescription(s, eDescriptionLevelVerbose, target); 1293 } 1294 s->IndentLess(); 1295 } 1296 1297 bool 1298 SymbolContextList::GetContextAtIndex(size_t idx, SymbolContext& sc) const 1299 { 1300 if (idx < m_symbol_contexts.size()) 1301 { 1302 sc = m_symbol_contexts[idx]; 1303 return true; 1304 } 1305 return false; 1306 } 1307 1308 bool 1309 SymbolContextList::GetLastContext(SymbolContext& sc) const 1310 { 1311 if (!m_symbol_contexts.empty()) 1312 { 1313 sc = m_symbol_contexts.back(); 1314 return true; 1315 } 1316 return false; 1317 } 1318 1319 bool 1320 SymbolContextList::RemoveContextAtIndex (size_t idx) 1321 { 1322 if (idx < m_symbol_contexts.size()) 1323 { 1324 m_symbol_contexts.erase(m_symbol_contexts.begin() + idx); 1325 return true; 1326 } 1327 return false; 1328 } 1329 1330 uint32_t 1331 SymbolContextList::GetSize() const 1332 { 1333 return m_symbol_contexts.size(); 1334 } 1335 1336 uint32_t 1337 SymbolContextList::NumLineEntriesWithLine (uint32_t line) const 1338 { 1339 uint32_t match_count = 0; 1340 const size_t size = m_symbol_contexts.size(); 1341 for (size_t idx = 0; idx<size; ++idx) 1342 { 1343 if (m_symbol_contexts[idx].line_entry.line == line) 1344 ++match_count; 1345 } 1346 return match_count; 1347 } 1348 1349 void 1350 SymbolContextList::GetDescription(Stream *s, 1351 lldb::DescriptionLevel level, 1352 Target *target) const 1353 { 1354 const size_t size = m_symbol_contexts.size(); 1355 for (size_t idx = 0; idx<size; ++idx) 1356 m_symbol_contexts[idx].GetDescription (s, level, target); 1357 } 1358 1359 bool 1360 lldb_private::operator== (const SymbolContextList& lhs, const SymbolContextList& rhs) 1361 { 1362 const uint32_t size = lhs.GetSize(); 1363 if (size != rhs.GetSize()) 1364 return false; 1365 1366 SymbolContext lhs_sc; 1367 SymbolContext rhs_sc; 1368 for (uint32_t i=0; i<size; ++i) 1369 { 1370 lhs.GetContextAtIndex(i, lhs_sc); 1371 rhs.GetContextAtIndex(i, rhs_sc); 1372 if (lhs_sc != rhs_sc) 1373 return false; 1374 } 1375 return true; 1376 } 1377 1378 bool 1379 lldb_private::operator!= (const SymbolContextList& lhs, const SymbolContextList& rhs) 1380 { 1381 return !(lhs == rhs); 1382 } 1383 1384