1 //===-- CommandObjectSource.cpp -------------------------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "CommandObjectSource.h" 10 11 #include "lldb/Core/Debugger.h" 12 #include "lldb/Core/FileLineResolver.h" 13 #include "lldb/Core/Module.h" 14 #include "lldb/Core/ModuleSpec.h" 15 #include "lldb/Core/SourceManager.h" 16 #include "lldb/Host/OptionParser.h" 17 #include "lldb/Interpreter/CommandOptionArgumentTable.h" 18 #include "lldb/Interpreter/CommandReturnObject.h" 19 #include "lldb/Interpreter/OptionArgParser.h" 20 #include "lldb/Interpreter/OptionValueFileColonLine.h" 21 #include "lldb/Interpreter/Options.h" 22 #include "lldb/Symbol/CompileUnit.h" 23 #include "lldb/Symbol/Function.h" 24 #include "lldb/Symbol/Symbol.h" 25 #include "lldb/Target/Process.h" 26 #include "lldb/Target/SectionLoadList.h" 27 #include "lldb/Target/StackFrame.h" 28 #include "lldb/Utility/FileSpec.h" 29 #include <optional> 30 31 using namespace lldb; 32 using namespace lldb_private; 33 34 #pragma mark CommandObjectSourceInfo 35 // CommandObjectSourceInfo - debug line entries dumping command 36 #define LLDB_OPTIONS_source_info 37 #include "CommandOptions.inc" 38 39 class CommandObjectSourceInfo : public CommandObjectParsed { 40 class CommandOptions : public Options { 41 public: 42 CommandOptions() = default; 43 44 ~CommandOptions() override = default; 45 46 Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, 47 ExecutionContext *execution_context) override { 48 Status error; 49 const int short_option = GetDefinitions()[option_idx].short_option; 50 switch (short_option) { 51 case 'l': 52 if (option_arg.getAsInteger(0, start_line)) 53 error.SetErrorStringWithFormat("invalid line number: '%s'", 54 option_arg.str().c_str()); 55 break; 56 57 case 'e': 58 if (option_arg.getAsInteger(0, end_line)) 59 error.SetErrorStringWithFormat("invalid line number: '%s'", 60 option_arg.str().c_str()); 61 break; 62 63 case 'c': 64 if (option_arg.getAsInteger(0, num_lines)) 65 error.SetErrorStringWithFormat("invalid line count: '%s'", 66 option_arg.str().c_str()); 67 break; 68 69 case 'f': 70 file_name = std::string(option_arg); 71 break; 72 73 case 'n': 74 symbol_name = std::string(option_arg); 75 break; 76 77 case 'a': { 78 address = OptionArgParser::ToAddress(execution_context, option_arg, 79 LLDB_INVALID_ADDRESS, &error); 80 } break; 81 case 's': 82 modules.push_back(std::string(option_arg)); 83 break; 84 default: 85 llvm_unreachable("Unimplemented option"); 86 } 87 88 return error; 89 } 90 91 void OptionParsingStarting(ExecutionContext *execution_context) override { 92 file_spec.Clear(); 93 file_name.clear(); 94 symbol_name.clear(); 95 address = LLDB_INVALID_ADDRESS; 96 start_line = 0; 97 end_line = 0; 98 num_lines = 0; 99 modules.clear(); 100 } 101 102 llvm::ArrayRef<OptionDefinition> GetDefinitions() override { 103 return llvm::ArrayRef(g_source_info_options); 104 } 105 106 // Instance variables to hold the values for command options. 107 FileSpec file_spec; 108 std::string file_name; 109 std::string symbol_name; 110 lldb::addr_t address; 111 uint32_t start_line; 112 uint32_t end_line; 113 uint32_t num_lines; 114 std::vector<std::string> modules; 115 }; 116 117 public: 118 CommandObjectSourceInfo(CommandInterpreter &interpreter) 119 : CommandObjectParsed( 120 interpreter, "source info", 121 "Display source line information for the current target " 122 "process. Defaults to instruction pointer in current stack " 123 "frame.", 124 nullptr, eCommandRequiresTarget) {} 125 126 ~CommandObjectSourceInfo() override = default; 127 128 Options *GetOptions() override { return &m_options; } 129 130 protected: 131 // Dump the line entries in each symbol context. Return the number of entries 132 // found. If module_list is set, only dump lines contained in one of the 133 // modules. If file_spec is set, only dump lines in the file. If the 134 // start_line option was specified, don't print lines less than start_line. 135 // If the end_line option was specified, don't print lines greater than 136 // end_line. If the num_lines option was specified, dont print more than 137 // num_lines entries. 138 uint32_t DumpLinesInSymbolContexts(Stream &strm, 139 const SymbolContextList &sc_list, 140 const ModuleList &module_list, 141 const FileSpec &file_spec) { 142 uint32_t start_line = m_options.start_line; 143 uint32_t end_line = m_options.end_line; 144 uint32_t num_lines = m_options.num_lines; 145 Target *target = m_exe_ctx.GetTargetPtr(); 146 147 uint32_t num_matches = 0; 148 // Dump all the line entries for the file in the list. 149 ConstString last_module_file_name; 150 for (const SymbolContext &sc : sc_list) { 151 if (sc.comp_unit) { 152 Module *module = sc.module_sp.get(); 153 CompileUnit *cu = sc.comp_unit; 154 const LineEntry &line_entry = sc.line_entry; 155 assert(module && cu); 156 157 // Are we looking for specific modules, files or lines? 158 if (module_list.GetSize() && 159 module_list.GetIndexForModule(module) == LLDB_INVALID_INDEX32) 160 continue; 161 if (!FileSpec::Match(file_spec, line_entry.file)) 162 continue; 163 if (start_line > 0 && line_entry.line < start_line) 164 continue; 165 if (end_line > 0 && line_entry.line > end_line) 166 continue; 167 if (num_lines > 0 && num_matches > num_lines) 168 continue; 169 170 // Print a new header if the module changed. 171 ConstString module_file_name = module->GetFileSpec().GetFilename(); 172 assert(module_file_name); 173 if (module_file_name != last_module_file_name) { 174 if (num_matches > 0) 175 strm << "\n\n"; 176 strm << "Lines found in module `" << module_file_name << "\n"; 177 } 178 // Dump the line entry. 179 line_entry.GetDescription(&strm, lldb::eDescriptionLevelBrief, cu, 180 target, /*show_address_only=*/false); 181 strm << "\n"; 182 last_module_file_name = module_file_name; 183 num_matches++; 184 } 185 } 186 return num_matches; 187 } 188 189 // Dump the requested line entries for the file in the compilation unit. 190 // Return the number of entries found. If module_list is set, only dump lines 191 // contained in one of the modules. If the start_line option was specified, 192 // don't print lines less than start_line. If the end_line option was 193 // specified, don't print lines greater than end_line. If the num_lines 194 // option was specified, dont print more than num_lines entries. 195 uint32_t DumpFileLinesInCompUnit(Stream &strm, Module *module, 196 CompileUnit *cu, const FileSpec &file_spec) { 197 uint32_t start_line = m_options.start_line; 198 uint32_t end_line = m_options.end_line; 199 uint32_t num_lines = m_options.num_lines; 200 Target *target = m_exe_ctx.GetTargetPtr(); 201 202 uint32_t num_matches = 0; 203 assert(module); 204 if (cu) { 205 assert(file_spec.GetFilename().AsCString()); 206 bool has_path = (file_spec.GetDirectory().AsCString() != nullptr); 207 const FileSpecList &cu_file_list = cu->GetSupportFiles(); 208 size_t file_idx = cu_file_list.FindFileIndex(0, file_spec, has_path); 209 if (file_idx != UINT32_MAX) { 210 // Update the file to how it appears in the CU. 211 const FileSpec &cu_file_spec = 212 cu_file_list.GetFileSpecAtIndex(file_idx); 213 214 // Dump all matching lines at or above start_line for the file in the 215 // CU. 216 ConstString file_spec_name = file_spec.GetFilename(); 217 ConstString module_file_name = module->GetFileSpec().GetFilename(); 218 bool cu_header_printed = false; 219 uint32_t line = start_line; 220 while (true) { 221 LineEntry line_entry; 222 223 // Find the lowest index of a line entry with a line equal to or 224 // higher than 'line'. 225 uint32_t start_idx = 0; 226 start_idx = cu->FindLineEntry(start_idx, line, &cu_file_spec, 227 /*exact=*/false, &line_entry); 228 if (start_idx == UINT32_MAX) 229 // No more line entries for our file in this CU. 230 break; 231 232 if (end_line > 0 && line_entry.line > end_line) 233 break; 234 235 // Loop through to find any other entries for this line, dumping 236 // each. 237 line = line_entry.line; 238 do { 239 num_matches++; 240 if (num_lines > 0 && num_matches > num_lines) 241 break; 242 assert(cu_file_spec == line_entry.file); 243 if (!cu_header_printed) { 244 if (num_matches > 0) 245 strm << "\n\n"; 246 strm << "Lines found for file " << file_spec_name 247 << " in compilation unit " 248 << cu->GetPrimaryFile().GetFilename() << " in `" 249 << module_file_name << "\n"; 250 cu_header_printed = true; 251 } 252 line_entry.GetDescription(&strm, lldb::eDescriptionLevelBrief, cu, 253 target, /*show_address_only=*/false); 254 strm << "\n"; 255 256 // Anymore after this one? 257 start_idx++; 258 start_idx = cu->FindLineEntry(start_idx, line, &cu_file_spec, 259 /*exact=*/true, &line_entry); 260 } while (start_idx != UINT32_MAX); 261 262 // Try the next higher line, starting over at start_idx 0. 263 line++; 264 } 265 } 266 } 267 return num_matches; 268 } 269 270 // Dump the requested line entries for the file in the module. Return the 271 // number of entries found. If module_list is set, only dump lines contained 272 // in one of the modules. If the start_line option was specified, don't print 273 // lines less than start_line. If the end_line option was specified, don't 274 // print lines greater than end_line. If the num_lines option was specified, 275 // dont print more than num_lines entries. 276 uint32_t DumpFileLinesInModule(Stream &strm, Module *module, 277 const FileSpec &file_spec) { 278 uint32_t num_matches = 0; 279 if (module) { 280 // Look through all the compilation units (CUs) in this module for ones 281 // that contain lines of code from this source file. 282 for (size_t i = 0; i < module->GetNumCompileUnits(); i++) { 283 // Look for a matching source file in this CU. 284 CompUnitSP cu_sp(module->GetCompileUnitAtIndex(i)); 285 if (cu_sp) { 286 num_matches += 287 DumpFileLinesInCompUnit(strm, module, cu_sp.get(), file_spec); 288 } 289 } 290 } 291 return num_matches; 292 } 293 294 // Given an address and a list of modules, append the symbol contexts of all 295 // line entries containing the address found in the modules and return the 296 // count of matches. If none is found, return an error in 'error_strm'. 297 size_t GetSymbolContextsForAddress(const ModuleList &module_list, 298 lldb::addr_t addr, 299 SymbolContextList &sc_list, 300 StreamString &error_strm) { 301 Address so_addr; 302 size_t num_matches = 0; 303 assert(module_list.GetSize() > 0); 304 Target *target = m_exe_ctx.GetTargetPtr(); 305 if (target->GetSectionLoadList().IsEmpty()) { 306 // The target isn't loaded yet, we need to lookup the file address in all 307 // modules. Note: the module list option does not apply to addresses. 308 const size_t num_modules = module_list.GetSize(); 309 for (size_t i = 0; i < num_modules; ++i) { 310 ModuleSP module_sp(module_list.GetModuleAtIndex(i)); 311 if (!module_sp) 312 continue; 313 if (module_sp->ResolveFileAddress(addr, so_addr)) { 314 SymbolContext sc; 315 sc.Clear(true); 316 if (module_sp->ResolveSymbolContextForAddress( 317 so_addr, eSymbolContextEverything, sc) & 318 eSymbolContextLineEntry) { 319 sc_list.AppendIfUnique(sc, /*merge_symbol_into_function=*/false); 320 ++num_matches; 321 } 322 } 323 } 324 if (num_matches == 0) 325 error_strm.Printf("Source information for file address 0x%" PRIx64 326 " not found in any modules.\n", 327 addr); 328 } else { 329 // The target has some things loaded, resolve this address to a compile 330 // unit + file + line and display 331 if (target->GetSectionLoadList().ResolveLoadAddress(addr, so_addr)) { 332 ModuleSP module_sp(so_addr.GetModule()); 333 // Check to make sure this module is in our list. 334 if (module_sp && module_list.GetIndexForModule(module_sp.get()) != 335 LLDB_INVALID_INDEX32) { 336 SymbolContext sc; 337 sc.Clear(true); 338 if (module_sp->ResolveSymbolContextForAddress( 339 so_addr, eSymbolContextEverything, sc) & 340 eSymbolContextLineEntry) { 341 sc_list.AppendIfUnique(sc, /*merge_symbol_into_function=*/false); 342 ++num_matches; 343 } else { 344 StreamString addr_strm; 345 so_addr.Dump(&addr_strm, nullptr, 346 Address::DumpStyleModuleWithFileAddress); 347 error_strm.Printf( 348 "Address 0x%" PRIx64 " resolves to %s, but there is" 349 " no source information available for this address.\n", 350 addr, addr_strm.GetData()); 351 } 352 } else { 353 StreamString addr_strm; 354 so_addr.Dump(&addr_strm, nullptr, 355 Address::DumpStyleModuleWithFileAddress); 356 error_strm.Printf("Address 0x%" PRIx64 357 " resolves to %s, but it cannot" 358 " be found in any modules.\n", 359 addr, addr_strm.GetData()); 360 } 361 } else 362 error_strm.Printf("Unable to resolve address 0x%" PRIx64 ".\n", addr); 363 } 364 return num_matches; 365 } 366 367 // Dump the line entries found in functions matching the name specified in 368 // the option. 369 bool DumpLinesInFunctions(CommandReturnObject &result) { 370 SymbolContextList sc_list_funcs; 371 ConstString name(m_options.symbol_name.c_str()); 372 SymbolContextList sc_list_lines; 373 Target *target = m_exe_ctx.GetTargetPtr(); 374 uint32_t addr_byte_size = target->GetArchitecture().GetAddressByteSize(); 375 376 ModuleFunctionSearchOptions function_options; 377 function_options.include_symbols = false; 378 function_options.include_inlines = true; 379 380 // Note: module_list can't be const& because FindFunctionSymbols isn't 381 // const. 382 ModuleList module_list = 383 (m_module_list.GetSize() > 0) ? m_module_list : target->GetImages(); 384 module_list.FindFunctions(name, eFunctionNameTypeAuto, function_options, 385 sc_list_funcs); 386 size_t num_matches = sc_list_funcs.GetSize(); 387 388 if (!num_matches) { 389 // If we didn't find any functions with that name, try searching for 390 // symbols that line up exactly with function addresses. 391 SymbolContextList sc_list_symbols; 392 module_list.FindFunctionSymbols(name, eFunctionNameTypeAuto, 393 sc_list_symbols); 394 for (const SymbolContext &sc : sc_list_symbols) { 395 if (sc.symbol && sc.symbol->ValueIsAddress()) { 396 const Address &base_address = sc.symbol->GetAddressRef(); 397 Function *function = base_address.CalculateSymbolContextFunction(); 398 if (function) { 399 sc_list_funcs.Append(SymbolContext(function)); 400 num_matches++; 401 } 402 } 403 } 404 } 405 if (num_matches == 0) { 406 result.AppendErrorWithFormat("Could not find function named \'%s\'.\n", 407 m_options.symbol_name.c_str()); 408 return false; 409 } 410 for (const SymbolContext &sc : sc_list_funcs) { 411 bool context_found_for_symbol = false; 412 // Loop through all the ranges in the function. 413 AddressRange range; 414 for (uint32_t r = 0; 415 sc.GetAddressRange(eSymbolContextEverything, r, 416 /*use_inline_block_range=*/true, range); 417 ++r) { 418 // Append the symbol contexts for each address in the range to 419 // sc_list_lines. 420 const Address &base_address = range.GetBaseAddress(); 421 const addr_t size = range.GetByteSize(); 422 lldb::addr_t start_addr = base_address.GetLoadAddress(target); 423 if (start_addr == LLDB_INVALID_ADDRESS) 424 start_addr = base_address.GetFileAddress(); 425 lldb::addr_t end_addr = start_addr + size; 426 for (lldb::addr_t addr = start_addr; addr < end_addr; 427 addr += addr_byte_size) { 428 StreamString error_strm; 429 if (!GetSymbolContextsForAddress(module_list, addr, sc_list_lines, 430 error_strm)) 431 result.AppendWarningWithFormat("in symbol '%s': %s", 432 sc.GetFunctionName().AsCString(), 433 error_strm.GetData()); 434 else 435 context_found_for_symbol = true; 436 } 437 } 438 if (!context_found_for_symbol) 439 result.AppendWarningWithFormat("Unable to find line information" 440 " for matching symbol '%s'.\n", 441 sc.GetFunctionName().AsCString()); 442 } 443 if (sc_list_lines.GetSize() == 0) { 444 result.AppendErrorWithFormat("No line information could be found" 445 " for any symbols matching '%s'.\n", 446 name.AsCString()); 447 return false; 448 } 449 FileSpec file_spec; 450 if (!DumpLinesInSymbolContexts(result.GetOutputStream(), sc_list_lines, 451 module_list, file_spec)) { 452 result.AppendErrorWithFormat( 453 "Unable to dump line information for symbol '%s'.\n", 454 name.AsCString()); 455 return false; 456 } 457 return true; 458 } 459 460 // Dump the line entries found for the address specified in the option. 461 bool DumpLinesForAddress(CommandReturnObject &result) { 462 Target *target = m_exe_ctx.GetTargetPtr(); 463 SymbolContextList sc_list; 464 465 StreamString error_strm; 466 if (!GetSymbolContextsForAddress(target->GetImages(), m_options.address, 467 sc_list, error_strm)) { 468 result.AppendErrorWithFormat("%s.\n", error_strm.GetData()); 469 return false; 470 } 471 ModuleList module_list; 472 FileSpec file_spec; 473 if (!DumpLinesInSymbolContexts(result.GetOutputStream(), sc_list, 474 module_list, file_spec)) { 475 result.AppendErrorWithFormat("No modules contain load address 0x%" PRIx64 476 ".\n", 477 m_options.address); 478 return false; 479 } 480 return true; 481 } 482 483 // Dump the line entries found in the file specified in the option. 484 bool DumpLinesForFile(CommandReturnObject &result) { 485 FileSpec file_spec(m_options.file_name); 486 const char *filename = m_options.file_name.c_str(); 487 Target *target = m_exe_ctx.GetTargetPtr(); 488 const ModuleList &module_list = 489 (m_module_list.GetSize() > 0) ? m_module_list : target->GetImages(); 490 491 bool displayed_something = false; 492 const size_t num_modules = module_list.GetSize(); 493 for (uint32_t i = 0; i < num_modules; ++i) { 494 // Dump lines for this module. 495 Module *module = module_list.GetModulePointerAtIndex(i); 496 assert(module); 497 if (DumpFileLinesInModule(result.GetOutputStream(), module, file_spec)) 498 displayed_something = true; 499 } 500 if (!displayed_something) { 501 result.AppendErrorWithFormat("No source filenames matched '%s'.\n", 502 filename); 503 return false; 504 } 505 return true; 506 } 507 508 // Dump the line entries for the current frame. 509 bool DumpLinesForFrame(CommandReturnObject &result) { 510 StackFrame *cur_frame = m_exe_ctx.GetFramePtr(); 511 if (cur_frame == nullptr) { 512 result.AppendError( 513 "No selected frame to use to find the default source."); 514 return false; 515 } else if (!cur_frame->HasDebugInformation()) { 516 result.AppendError("No debug info for the selected frame."); 517 return false; 518 } else { 519 const SymbolContext &sc = 520 cur_frame->GetSymbolContext(eSymbolContextLineEntry); 521 SymbolContextList sc_list; 522 sc_list.Append(sc); 523 ModuleList module_list; 524 FileSpec file_spec; 525 if (!DumpLinesInSymbolContexts(result.GetOutputStream(), sc_list, 526 module_list, file_spec)) { 527 result.AppendError( 528 "No source line info available for the selected frame."); 529 return false; 530 } 531 } 532 return true; 533 } 534 535 bool DoExecute(Args &command, CommandReturnObject &result) override { 536 Target *target = m_exe_ctx.GetTargetPtr(); 537 if (target == nullptr) { 538 target = GetDebugger().GetSelectedTarget().get(); 539 if (target == nullptr) { 540 result.AppendError("invalid target, create a debug target using the " 541 "'target create' command."); 542 return false; 543 } 544 } 545 546 uint32_t addr_byte_size = target->GetArchitecture().GetAddressByteSize(); 547 result.GetOutputStream().SetAddressByteSize(addr_byte_size); 548 result.GetErrorStream().SetAddressByteSize(addr_byte_size); 549 550 // Collect the list of modules to search. 551 m_module_list.Clear(); 552 if (!m_options.modules.empty()) { 553 for (size_t i = 0, e = m_options.modules.size(); i < e; ++i) { 554 FileSpec module_file_spec(m_options.modules[i]); 555 if (module_file_spec) { 556 ModuleSpec module_spec(module_file_spec); 557 target->GetImages().FindModules(module_spec, m_module_list); 558 if (m_module_list.IsEmpty()) 559 result.AppendWarningWithFormat("No module found for '%s'.\n", 560 m_options.modules[i].c_str()); 561 } 562 } 563 if (!m_module_list.GetSize()) { 564 result.AppendError("No modules match the input."); 565 return false; 566 } 567 } else if (target->GetImages().GetSize() == 0) { 568 result.AppendError("The target has no associated executable images."); 569 return false; 570 } 571 572 // Check the arguments to see what lines we should dump. 573 if (!m_options.symbol_name.empty()) { 574 // Print lines for symbol. 575 if (DumpLinesInFunctions(result)) 576 result.SetStatus(eReturnStatusSuccessFinishResult); 577 else 578 result.SetStatus(eReturnStatusFailed); 579 } else if (m_options.address != LLDB_INVALID_ADDRESS) { 580 // Print lines for an address. 581 if (DumpLinesForAddress(result)) 582 result.SetStatus(eReturnStatusSuccessFinishResult); 583 else 584 result.SetStatus(eReturnStatusFailed); 585 } else if (!m_options.file_name.empty()) { 586 // Dump lines for a file. 587 if (DumpLinesForFile(result)) 588 result.SetStatus(eReturnStatusSuccessFinishResult); 589 else 590 result.SetStatus(eReturnStatusFailed); 591 } else { 592 // Dump the line for the current frame. 593 if (DumpLinesForFrame(result)) 594 result.SetStatus(eReturnStatusSuccessFinishResult); 595 else 596 result.SetStatus(eReturnStatusFailed); 597 } 598 return result.Succeeded(); 599 } 600 601 CommandOptions m_options; 602 ModuleList m_module_list; 603 }; 604 605 #pragma mark CommandObjectSourceList 606 // CommandObjectSourceList 607 #define LLDB_OPTIONS_source_list 608 #include "CommandOptions.inc" 609 610 class CommandObjectSourceList : public CommandObjectParsed { 611 class CommandOptions : public Options { 612 public: 613 CommandOptions() = default; 614 615 ~CommandOptions() override = default; 616 617 Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg, 618 ExecutionContext *execution_context) override { 619 Status error; 620 const int short_option = GetDefinitions()[option_idx].short_option; 621 switch (short_option) { 622 case 'l': 623 if (option_arg.getAsInteger(0, start_line)) 624 error.SetErrorStringWithFormat("invalid line number: '%s'", 625 option_arg.str().c_str()); 626 break; 627 628 case 'c': 629 if (option_arg.getAsInteger(0, num_lines)) 630 error.SetErrorStringWithFormat("invalid line count: '%s'", 631 option_arg.str().c_str()); 632 break; 633 634 case 'f': 635 file_name = std::string(option_arg); 636 break; 637 638 case 'n': 639 symbol_name = std::string(option_arg); 640 break; 641 642 case 'a': { 643 address = OptionArgParser::ToAddress(execution_context, option_arg, 644 LLDB_INVALID_ADDRESS, &error); 645 } break; 646 case 's': 647 modules.push_back(std::string(option_arg)); 648 break; 649 650 case 'b': 651 show_bp_locs = true; 652 break; 653 case 'r': 654 reverse = true; 655 break; 656 case 'y': 657 { 658 OptionValueFileColonLine value; 659 Status fcl_err = value.SetValueFromString(option_arg); 660 if (!fcl_err.Success()) { 661 error.SetErrorStringWithFormat( 662 "Invalid value for file:line specifier: %s", 663 fcl_err.AsCString()); 664 } else { 665 file_name = value.GetFileSpec().GetPath(); 666 start_line = value.GetLineNumber(); 667 // I don't see anything useful to do with a column number, but I don't 668 // want to complain since someone may well have cut and pasted a 669 // listing from somewhere that included a column. 670 } 671 } break; 672 default: 673 llvm_unreachable("Unimplemented option"); 674 } 675 676 return error; 677 } 678 679 void OptionParsingStarting(ExecutionContext *execution_context) override { 680 file_spec.Clear(); 681 file_name.clear(); 682 symbol_name.clear(); 683 address = LLDB_INVALID_ADDRESS; 684 start_line = 0; 685 num_lines = 0; 686 show_bp_locs = false; 687 reverse = false; 688 modules.clear(); 689 } 690 691 llvm::ArrayRef<OptionDefinition> GetDefinitions() override { 692 return llvm::ArrayRef(g_source_list_options); 693 } 694 695 // Instance variables to hold the values for command options. 696 FileSpec file_spec; 697 std::string file_name; 698 std::string symbol_name; 699 lldb::addr_t address; 700 uint32_t start_line; 701 uint32_t num_lines; 702 std::vector<std::string> modules; 703 bool show_bp_locs; 704 bool reverse; 705 }; 706 707 public: 708 CommandObjectSourceList(CommandInterpreter &interpreter) 709 : CommandObjectParsed(interpreter, "source list", 710 "Display source code for the current target " 711 "process as specified by options.", 712 nullptr, eCommandRequiresTarget) {} 713 714 ~CommandObjectSourceList() override = default; 715 716 Options *GetOptions() override { return &m_options; } 717 718 std::optional<std::string> GetRepeatCommand(Args ¤t_command_args, 719 uint32_t index) override { 720 // This is kind of gross, but the command hasn't been parsed yet so we 721 // can't look at the option values for this invocation... I have to scan 722 // the arguments directly. 723 auto iter = 724 llvm::find_if(current_command_args, [](const Args::ArgEntry &e) { 725 return e.ref() == "-r" || e.ref() == "--reverse"; 726 }); 727 if (iter == current_command_args.end()) 728 return m_cmd_name; 729 730 if (m_reverse_name.empty()) { 731 m_reverse_name = m_cmd_name; 732 m_reverse_name.append(" -r"); 733 } 734 return m_reverse_name; 735 } 736 737 protected: 738 struct SourceInfo { 739 ConstString function; 740 LineEntry line_entry; 741 742 SourceInfo(ConstString name, const LineEntry &line_entry) 743 : function(name), line_entry(line_entry) {} 744 745 SourceInfo() = default; 746 747 bool IsValid() const { return (bool)function && line_entry.IsValid(); } 748 749 bool operator==(const SourceInfo &rhs) const { 750 return function == rhs.function && 751 line_entry.original_file == rhs.line_entry.original_file && 752 line_entry.line == rhs.line_entry.line; 753 } 754 755 bool operator!=(const SourceInfo &rhs) const { 756 return function != rhs.function || 757 line_entry.original_file != rhs.line_entry.original_file || 758 line_entry.line != rhs.line_entry.line; 759 } 760 761 bool operator<(const SourceInfo &rhs) const { 762 if (function.GetCString() < rhs.function.GetCString()) 763 return true; 764 if (line_entry.file.GetDirectory().GetCString() < 765 rhs.line_entry.file.GetDirectory().GetCString()) 766 return true; 767 if (line_entry.file.GetFilename().GetCString() < 768 rhs.line_entry.file.GetFilename().GetCString()) 769 return true; 770 if (line_entry.line < rhs.line_entry.line) 771 return true; 772 return false; 773 } 774 }; 775 776 size_t DisplayFunctionSource(const SymbolContext &sc, SourceInfo &source_info, 777 CommandReturnObject &result) { 778 if (!source_info.IsValid()) { 779 source_info.function = sc.GetFunctionName(); 780 source_info.line_entry = sc.GetFunctionStartLineEntry(); 781 } 782 783 if (sc.function) { 784 Target *target = m_exe_ctx.GetTargetPtr(); 785 786 FileSpec start_file; 787 uint32_t start_line; 788 uint32_t end_line; 789 FileSpec end_file; 790 791 if (sc.block == nullptr) { 792 // Not an inlined function 793 sc.function->GetStartLineSourceInfo(start_file, start_line); 794 if (start_line == 0) { 795 result.AppendErrorWithFormat("Could not find line information for " 796 "start of function: \"%s\".\n", 797 source_info.function.GetCString()); 798 return 0; 799 } 800 sc.function->GetEndLineSourceInfo(end_file, end_line); 801 } else { 802 // We have an inlined function 803 start_file = source_info.line_entry.file; 804 start_line = source_info.line_entry.line; 805 end_line = start_line + m_options.num_lines; 806 } 807 808 // This is a little hacky, but the first line table entry for a function 809 // points to the "{" that starts the function block. It would be nice to 810 // actually get the function declaration in there too. So back up a bit, 811 // but not further than what you're going to display. 812 uint32_t extra_lines; 813 if (m_options.num_lines >= 10) 814 extra_lines = 5; 815 else 816 extra_lines = m_options.num_lines / 2; 817 uint32_t line_no; 818 if (start_line <= extra_lines) 819 line_no = 1; 820 else 821 line_no = start_line - extra_lines; 822 823 // For fun, if the function is shorter than the number of lines we're 824 // supposed to display, only display the function... 825 if (end_line != 0) { 826 if (m_options.num_lines > end_line - line_no) 827 m_options.num_lines = end_line - line_no + extra_lines; 828 } 829 830 m_breakpoint_locations.Clear(); 831 832 if (m_options.show_bp_locs) { 833 const bool show_inlines = true; 834 m_breakpoint_locations.Reset(start_file, 0, show_inlines); 835 SearchFilterForUnconstrainedSearches target_search_filter( 836 m_exe_ctx.GetTargetSP()); 837 target_search_filter.Search(m_breakpoint_locations); 838 } 839 840 result.AppendMessageWithFormat("File: %s\n", 841 start_file.GetPath().c_str()); 842 // We don't care about the column here. 843 const uint32_t column = 0; 844 return target->GetSourceManager().DisplaySourceLinesWithLineNumbers( 845 start_file, line_no, column, 0, m_options.num_lines, "", 846 &result.GetOutputStream(), GetBreakpointLocations()); 847 } else { 848 result.AppendErrorWithFormat( 849 "Could not find function info for: \"%s\".\n", 850 m_options.symbol_name.c_str()); 851 } 852 return 0; 853 } 854 855 // From Jim: The FindMatchingFunctions / FindMatchingFunctionSymbols 856 // functions "take a possibly empty vector of strings which are names of 857 // modules, and run the two search functions on the subset of the full module 858 // list that matches the strings in the input vector". If we wanted to put 859 // these somewhere, there should probably be a module-filter-list that can be 860 // passed to the various ModuleList::Find* calls, which would either be a 861 // vector of string names or a ModuleSpecList. 862 void FindMatchingFunctions(Target *target, ConstString name, 863 SymbolContextList &sc_list) { 864 // Displaying the source for a symbol: 865 if (m_options.num_lines == 0) 866 m_options.num_lines = 10; 867 868 ModuleFunctionSearchOptions function_options; 869 function_options.include_symbols = true; 870 function_options.include_inlines = false; 871 872 const size_t num_modules = m_options.modules.size(); 873 if (num_modules > 0) { 874 ModuleList matching_modules; 875 for (size_t i = 0; i < num_modules; ++i) { 876 FileSpec module_file_spec(m_options.modules[i]); 877 if (module_file_spec) { 878 ModuleSpec module_spec(module_file_spec); 879 matching_modules.Clear(); 880 target->GetImages().FindModules(module_spec, matching_modules); 881 882 matching_modules.FindFunctions(name, eFunctionNameTypeAuto, 883 function_options, sc_list); 884 } 885 } 886 } else { 887 target->GetImages().FindFunctions(name, eFunctionNameTypeAuto, 888 function_options, sc_list); 889 } 890 } 891 892 void FindMatchingFunctionSymbols(Target *target, ConstString name, 893 SymbolContextList &sc_list) { 894 const size_t num_modules = m_options.modules.size(); 895 if (num_modules > 0) { 896 ModuleList matching_modules; 897 for (size_t i = 0; i < num_modules; ++i) { 898 FileSpec module_file_spec(m_options.modules[i]); 899 if (module_file_spec) { 900 ModuleSpec module_spec(module_file_spec); 901 matching_modules.Clear(); 902 target->GetImages().FindModules(module_spec, matching_modules); 903 matching_modules.FindFunctionSymbols(name, eFunctionNameTypeAuto, 904 sc_list); 905 } 906 } 907 } else { 908 target->GetImages().FindFunctionSymbols(name, eFunctionNameTypeAuto, 909 sc_list); 910 } 911 } 912 913 bool DoExecute(Args &command, CommandReturnObject &result) override { 914 Target *target = m_exe_ctx.GetTargetPtr(); 915 916 if (!m_options.symbol_name.empty()) { 917 SymbolContextList sc_list; 918 ConstString name(m_options.symbol_name.c_str()); 919 920 // Displaying the source for a symbol. Search for function named name. 921 FindMatchingFunctions(target, name, sc_list); 922 if (sc_list.GetSize() == 0) { 923 // If we didn't find any functions with that name, try searching for 924 // symbols that line up exactly with function addresses. 925 SymbolContextList sc_list_symbols; 926 FindMatchingFunctionSymbols(target, name, sc_list_symbols); 927 for (const SymbolContext &sc : sc_list_symbols) { 928 if (sc.symbol && sc.symbol->ValueIsAddress()) { 929 const Address &base_address = sc.symbol->GetAddressRef(); 930 Function *function = base_address.CalculateSymbolContextFunction(); 931 if (function) { 932 sc_list.Append(SymbolContext(function)); 933 break; 934 } 935 } 936 } 937 } 938 939 if (sc_list.GetSize() == 0) { 940 result.AppendErrorWithFormat("Could not find function named: \"%s\".\n", 941 m_options.symbol_name.c_str()); 942 return false; 943 } 944 945 std::set<SourceInfo> source_match_set; 946 bool displayed_something = false; 947 for (const SymbolContext &sc : sc_list) { 948 SourceInfo source_info(sc.GetFunctionName(), 949 sc.GetFunctionStartLineEntry()); 950 if (source_info.IsValid() && 951 source_match_set.find(source_info) == source_match_set.end()) { 952 source_match_set.insert(source_info); 953 if (DisplayFunctionSource(sc, source_info, result)) 954 displayed_something = true; 955 } 956 } 957 if (displayed_something) 958 result.SetStatus(eReturnStatusSuccessFinishResult); 959 else 960 result.SetStatus(eReturnStatusFailed); 961 return result.Succeeded(); 962 } else if (m_options.address != LLDB_INVALID_ADDRESS) { 963 Address so_addr; 964 StreamString error_strm; 965 SymbolContextList sc_list; 966 967 if (target->GetSectionLoadList().IsEmpty()) { 968 // The target isn't loaded yet, we need to lookup the file address in 969 // all modules 970 const ModuleList &module_list = target->GetImages(); 971 const size_t num_modules = module_list.GetSize(); 972 for (size_t i = 0; i < num_modules; ++i) { 973 ModuleSP module_sp(module_list.GetModuleAtIndex(i)); 974 if (module_sp && 975 module_sp->ResolveFileAddress(m_options.address, so_addr)) { 976 SymbolContext sc; 977 sc.Clear(true); 978 if (module_sp->ResolveSymbolContextForAddress( 979 so_addr, eSymbolContextEverything, sc) & 980 eSymbolContextLineEntry) 981 sc_list.Append(sc); 982 } 983 } 984 985 if (sc_list.GetSize() == 0) { 986 result.AppendErrorWithFormat( 987 "no modules have source information for file address 0x%" PRIx64 988 ".\n", 989 m_options.address); 990 return false; 991 } 992 } else { 993 // The target has some things loaded, resolve this address to a compile 994 // unit + file + line and display 995 if (target->GetSectionLoadList().ResolveLoadAddress(m_options.address, 996 so_addr)) { 997 ModuleSP module_sp(so_addr.GetModule()); 998 if (module_sp) { 999 SymbolContext sc; 1000 sc.Clear(true); 1001 if (module_sp->ResolveSymbolContextForAddress( 1002 so_addr, eSymbolContextEverything, sc) & 1003 eSymbolContextLineEntry) { 1004 sc_list.Append(sc); 1005 } else { 1006 so_addr.Dump(&error_strm, nullptr, 1007 Address::DumpStyleModuleWithFileAddress); 1008 result.AppendErrorWithFormat("address resolves to %s, but there " 1009 "is no line table information " 1010 "available for this address.\n", 1011 error_strm.GetData()); 1012 return false; 1013 } 1014 } 1015 } 1016 1017 if (sc_list.GetSize() == 0) { 1018 result.AppendErrorWithFormat( 1019 "no modules contain load address 0x%" PRIx64 ".\n", 1020 m_options.address); 1021 return false; 1022 } 1023 } 1024 for (const SymbolContext &sc : sc_list) { 1025 if (sc.comp_unit) { 1026 if (m_options.show_bp_locs) { 1027 m_breakpoint_locations.Clear(); 1028 const bool show_inlines = true; 1029 m_breakpoint_locations.Reset(sc.comp_unit->GetPrimaryFile(), 0, 1030 show_inlines); 1031 SearchFilterForUnconstrainedSearches target_search_filter( 1032 target->shared_from_this()); 1033 target_search_filter.Search(m_breakpoint_locations); 1034 } 1035 1036 bool show_fullpaths = true; 1037 bool show_module = true; 1038 bool show_inlined_frames = true; 1039 const bool show_function_arguments = true; 1040 const bool show_function_name = true; 1041 sc.DumpStopContext(&result.GetOutputStream(), 1042 m_exe_ctx.GetBestExecutionContextScope(), 1043 sc.line_entry.range.GetBaseAddress(), 1044 show_fullpaths, show_module, show_inlined_frames, 1045 show_function_arguments, show_function_name); 1046 result.GetOutputStream().EOL(); 1047 1048 if (m_options.num_lines == 0) 1049 m_options.num_lines = 10; 1050 1051 size_t lines_to_back_up = 1052 m_options.num_lines >= 10 ? 5 : m_options.num_lines / 2; 1053 1054 const uint32_t column = 1055 (GetDebugger().GetStopShowColumn() != eStopShowColumnNone) 1056 ? sc.line_entry.column 1057 : 0; 1058 target->GetSourceManager().DisplaySourceLinesWithLineNumbers( 1059 sc.comp_unit->GetPrimaryFile(), sc.line_entry.line, column, 1060 lines_to_back_up, m_options.num_lines - lines_to_back_up, "->", 1061 &result.GetOutputStream(), GetBreakpointLocations()); 1062 result.SetStatus(eReturnStatusSuccessFinishResult); 1063 } 1064 } 1065 } else if (m_options.file_name.empty()) { 1066 // Last valid source manager context, or the current frame if no valid 1067 // last context in source manager. One little trick here, if you type the 1068 // exact same list command twice in a row, it is more likely because you 1069 // typed it once, then typed it again 1070 if (m_options.start_line == 0) { 1071 if (target->GetSourceManager().DisplayMoreWithLineNumbers( 1072 &result.GetOutputStream(), m_options.num_lines, 1073 m_options.reverse, GetBreakpointLocations())) { 1074 result.SetStatus(eReturnStatusSuccessFinishResult); 1075 } 1076 } else { 1077 if (m_options.num_lines == 0) 1078 m_options.num_lines = 10; 1079 1080 if (m_options.show_bp_locs) { 1081 SourceManager::FileSP last_file_sp( 1082 target->GetSourceManager().GetLastFile()); 1083 if (last_file_sp) { 1084 const bool show_inlines = true; 1085 m_breakpoint_locations.Reset(last_file_sp->GetFileSpec(), 0, 1086 show_inlines); 1087 SearchFilterForUnconstrainedSearches target_search_filter( 1088 target->shared_from_this()); 1089 target_search_filter.Search(m_breakpoint_locations); 1090 } 1091 } else 1092 m_breakpoint_locations.Clear(); 1093 1094 const uint32_t column = 0; 1095 if (target->GetSourceManager() 1096 .DisplaySourceLinesWithLineNumbersUsingLastFile( 1097 m_options.start_line, // Line to display 1098 m_options.num_lines, // Lines after line to 1099 UINT32_MAX, // Don't mark "line" 1100 column, 1101 "", // Don't mark "line" 1102 &result.GetOutputStream(), GetBreakpointLocations())) { 1103 result.SetStatus(eReturnStatusSuccessFinishResult); 1104 } 1105 } 1106 } else { 1107 const char *filename = m_options.file_name.c_str(); 1108 1109 bool check_inlines = false; 1110 SymbolContextList sc_list; 1111 size_t num_matches = 0; 1112 1113 if (!m_options.modules.empty()) { 1114 ModuleList matching_modules; 1115 for (size_t i = 0, e = m_options.modules.size(); i < e; ++i) { 1116 FileSpec module_file_spec(m_options.modules[i]); 1117 if (module_file_spec) { 1118 ModuleSpec module_spec(module_file_spec); 1119 matching_modules.Clear(); 1120 target->GetImages().FindModules(module_spec, matching_modules); 1121 num_matches += matching_modules.ResolveSymbolContextForFilePath( 1122 filename, 0, check_inlines, 1123 SymbolContextItem(eSymbolContextModule | 1124 eSymbolContextCompUnit), 1125 sc_list); 1126 } 1127 } 1128 } else { 1129 num_matches = target->GetImages().ResolveSymbolContextForFilePath( 1130 filename, 0, check_inlines, 1131 eSymbolContextModule | eSymbolContextCompUnit, sc_list); 1132 } 1133 1134 if (num_matches == 0) { 1135 result.AppendErrorWithFormat("Could not find source file \"%s\".\n", 1136 m_options.file_name.c_str()); 1137 return false; 1138 } 1139 1140 if (num_matches > 1) { 1141 bool got_multiple = false; 1142 CompileUnit *test_cu = nullptr; 1143 1144 for (const SymbolContext &sc : sc_list) { 1145 if (sc.comp_unit) { 1146 if (test_cu) { 1147 if (test_cu != sc.comp_unit) 1148 got_multiple = true; 1149 break; 1150 } else 1151 test_cu = sc.comp_unit; 1152 } 1153 } 1154 if (got_multiple) { 1155 result.AppendErrorWithFormat( 1156 "Multiple source files found matching: \"%s.\"\n", 1157 m_options.file_name.c_str()); 1158 return false; 1159 } 1160 } 1161 1162 SymbolContext sc; 1163 if (sc_list.GetContextAtIndex(0, sc)) { 1164 if (sc.comp_unit) { 1165 if (m_options.show_bp_locs) { 1166 const bool show_inlines = true; 1167 m_breakpoint_locations.Reset(sc.comp_unit->GetPrimaryFile(), 0, 1168 show_inlines); 1169 SearchFilterForUnconstrainedSearches target_search_filter( 1170 target->shared_from_this()); 1171 target_search_filter.Search(m_breakpoint_locations); 1172 } else 1173 m_breakpoint_locations.Clear(); 1174 1175 if (m_options.num_lines == 0) 1176 m_options.num_lines = 10; 1177 const uint32_t column = 0; 1178 target->GetSourceManager().DisplaySourceLinesWithLineNumbers( 1179 sc.comp_unit->GetPrimaryFile(), m_options.start_line, column, 0, 1180 m_options.num_lines, "", &result.GetOutputStream(), 1181 GetBreakpointLocations()); 1182 1183 result.SetStatus(eReturnStatusSuccessFinishResult); 1184 } else { 1185 result.AppendErrorWithFormat("No comp unit found for: \"%s.\"\n", 1186 m_options.file_name.c_str()); 1187 return false; 1188 } 1189 } 1190 } 1191 return result.Succeeded(); 1192 } 1193 1194 const SymbolContextList *GetBreakpointLocations() { 1195 if (m_breakpoint_locations.GetFileLineMatches().GetSize() > 0) 1196 return &m_breakpoint_locations.GetFileLineMatches(); 1197 return nullptr; 1198 } 1199 1200 CommandOptions m_options; 1201 FileLineResolver m_breakpoint_locations; 1202 std::string m_reverse_name; 1203 }; 1204 1205 class CommandObjectSourceCacheDump : public CommandObjectParsed { 1206 public: 1207 CommandObjectSourceCacheDump(CommandInterpreter &interpreter) 1208 : CommandObjectParsed(interpreter, "source cache dump", 1209 "Dump the state of the source code cache. Intended " 1210 "to be used for debugging LLDB itself.", 1211 nullptr) {} 1212 1213 ~CommandObjectSourceCacheDump() override = default; 1214 1215 protected: 1216 bool DoExecute(Args &command, CommandReturnObject &result) override { 1217 // Dump the debugger source cache. 1218 result.GetOutputStream() << "Debugger Source File Cache\n"; 1219 SourceManager::SourceFileCache &cache = GetDebugger().GetSourceFileCache(); 1220 cache.Dump(result.GetOutputStream()); 1221 1222 // Dump the process source cache. 1223 if (ProcessSP process_sp = m_exe_ctx.GetProcessSP()) { 1224 result.GetOutputStream() << "\nProcess Source File Cache\n"; 1225 SourceManager::SourceFileCache &cache = process_sp->GetSourceFileCache(); 1226 cache.Dump(result.GetOutputStream()); 1227 } 1228 1229 result.SetStatus(eReturnStatusSuccessFinishResult); 1230 return result.Succeeded(); 1231 } 1232 }; 1233 1234 class CommandObjectSourceCacheClear : public CommandObjectParsed { 1235 public: 1236 CommandObjectSourceCacheClear(CommandInterpreter &interpreter) 1237 : CommandObjectParsed(interpreter, "source cache clear", 1238 "Clear the source code cache.\n", nullptr) {} 1239 1240 ~CommandObjectSourceCacheClear() override = default; 1241 1242 protected: 1243 bool DoExecute(Args &command, CommandReturnObject &result) override { 1244 // Clear the debugger cache. 1245 SourceManager::SourceFileCache &cache = GetDebugger().GetSourceFileCache(); 1246 cache.Clear(); 1247 1248 // Clear the process cache. 1249 if (ProcessSP process_sp = m_exe_ctx.GetProcessSP()) 1250 process_sp->GetSourceFileCache().Clear(); 1251 1252 result.SetStatus(eReturnStatusSuccessFinishNoResult); 1253 return result.Succeeded(); 1254 } 1255 }; 1256 1257 class CommandObjectSourceCache : public CommandObjectMultiword { 1258 public: 1259 CommandObjectSourceCache(CommandInterpreter &interpreter) 1260 : CommandObjectMultiword(interpreter, "source cache", 1261 "Commands for managing the source code cache.", 1262 "source cache <sub-command>") { 1263 LoadSubCommand( 1264 "dump", CommandObjectSP(new CommandObjectSourceCacheDump(interpreter))); 1265 LoadSubCommand("clear", CommandObjectSP(new CommandObjectSourceCacheClear( 1266 interpreter))); 1267 } 1268 1269 ~CommandObjectSourceCache() override = default; 1270 1271 private: 1272 CommandObjectSourceCache(const CommandObjectSourceCache &) = delete; 1273 const CommandObjectSourceCache & 1274 operator=(const CommandObjectSourceCache &) = delete; 1275 }; 1276 1277 #pragma mark CommandObjectMultiwordSource 1278 // CommandObjectMultiwordSource 1279 1280 CommandObjectMultiwordSource::CommandObjectMultiwordSource( 1281 CommandInterpreter &interpreter) 1282 : CommandObjectMultiword(interpreter, "source", 1283 "Commands for examining " 1284 "source code described by " 1285 "debug information for the " 1286 "current target process.", 1287 "source <subcommand> [<subcommand-options>]") { 1288 LoadSubCommand("info", 1289 CommandObjectSP(new CommandObjectSourceInfo(interpreter))); 1290 LoadSubCommand("list", 1291 CommandObjectSP(new CommandObjectSourceList(interpreter))); 1292 LoadSubCommand("cache", 1293 CommandObjectSP(new CommandObjectSourceCache(interpreter))); 1294 } 1295 1296 CommandObjectMultiwordSource::~CommandObjectMultiwordSource() = default; 1297