1 //===-- CommandObjectSource.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 "CommandObjectSource.h" 11 12 // C Includes 13 // C++ Includes 14 // Other libraries and framework includes 15 // Project includes 16 #include "lldb/Interpreter/Args.h" 17 #include "lldb/Core/Debugger.h" 18 #include "lldb/Core/FileLineResolver.h" 19 #include "lldb/Core/SourceManager.h" 20 #include "lldb/Interpreter/CommandInterpreter.h" 21 #include "lldb/Interpreter/CommandReturnObject.h" 22 #include "lldb/Host/FileSpec.h" 23 #include "lldb/Target/Process.h" 24 #include "lldb/Target/TargetList.h" 25 #include "lldb/Interpreter/CommandCompletions.h" 26 #include "lldb/Interpreter/Options.h" 27 28 using namespace lldb; 29 using namespace lldb_private; 30 31 //------------------------------------------------------------------------- 32 // CommandObjectSourceInfo 33 //------------------------------------------------------------------------- 34 35 class CommandObjectSourceInfo : public CommandObject 36 { 37 38 class CommandOptions : public Options 39 { 40 public: 41 CommandOptions (CommandInterpreter &interpreter) : 42 Options(interpreter) 43 { 44 } 45 46 ~CommandOptions () 47 { 48 } 49 50 Error 51 SetOptionValue (uint32_t option_idx, const char *option_arg) 52 { 53 Error error; 54 const char short_option = g_option_table[option_idx].short_option; 55 switch (short_option) 56 { 57 case 'l': 58 start_line = Args::StringToUInt32 (option_arg, 0); 59 if (start_line == 0) 60 error.SetErrorStringWithFormat("invalid line number: '%s'", option_arg); 61 break; 62 63 case 'f': 64 file_name = option_arg; 65 break; 66 67 default: 68 error.SetErrorStringWithFormat("unrecognized short option '%c'", short_option); 69 break; 70 } 71 72 return error; 73 } 74 75 void 76 OptionParsingStarting () 77 { 78 file_spec.Clear(); 79 file_name.clear(); 80 start_line = 0; 81 } 82 83 const OptionDefinition* 84 GetDefinitions () 85 { 86 return g_option_table; 87 } 88 static OptionDefinition g_option_table[]; 89 90 // Instance variables to hold the values for command options. 91 FileSpec file_spec; 92 std::string file_name; 93 uint32_t start_line; 94 95 }; 96 97 public: 98 CommandObjectSourceInfo(CommandInterpreter &interpreter) : 99 CommandObject (interpreter, 100 "source info", 101 "Display information about the source lines from the current executable's debug info.", 102 "source info [<cmd-options>]"), 103 m_options (interpreter) 104 { 105 } 106 107 ~CommandObjectSourceInfo () 108 { 109 } 110 111 112 Options * 113 GetOptions () 114 { 115 return &m_options; 116 } 117 118 119 bool 120 Execute 121 ( 122 Args& args, 123 CommandReturnObject &result 124 ) 125 { 126 result.AppendError ("Not yet implemented"); 127 result.SetStatus (eReturnStatusFailed); 128 return false; 129 } 130 protected: 131 CommandOptions m_options; 132 }; 133 134 OptionDefinition 135 CommandObjectSourceInfo::CommandOptions::g_option_table[] = 136 { 137 { LLDB_OPT_SET_1, false, "line", 'l', required_argument, NULL, 0, eArgTypeLineNum, "The line number at which to start the display source."}, 138 { LLDB_OPT_SET_1, false, "file", 'f', required_argument, NULL, CommandCompletions::eSourceFileCompletion, eArgTypeFilename, "The file from which to display source."}, 139 { 0, false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL } 140 }; 141 142 #pragma mark CommandObjectSourceList 143 //------------------------------------------------------------------------- 144 // CommandObjectSourceList 145 //------------------------------------------------------------------------- 146 147 class CommandObjectSourceList : public CommandObject 148 { 149 150 class CommandOptions : public Options 151 { 152 public: 153 CommandOptions (CommandInterpreter &interpreter) : 154 Options(interpreter) 155 { 156 } 157 158 ~CommandOptions () 159 { 160 } 161 162 Error 163 SetOptionValue (uint32_t option_idx, const char *option_arg) 164 { 165 Error error; 166 const char short_option = g_option_table[option_idx].short_option; 167 switch (short_option) 168 { 169 case 'l': 170 start_line = Args::StringToUInt32 (option_arg, 0); 171 if (start_line == 0) 172 error.SetErrorStringWithFormat("invalid line number: '%s'", option_arg); 173 break; 174 175 case 'c': 176 num_lines = Args::StringToUInt32 (option_arg, 0); 177 if (num_lines == 0) 178 error.SetErrorStringWithFormat("invalid line count: '%s'", option_arg); 179 break; 180 181 case 'f': 182 file_name = option_arg; 183 break; 184 185 case 'n': 186 symbol_name = option_arg; 187 break; 188 189 case 's': 190 modules.push_back (std::string (option_arg)); 191 break; 192 193 case 'b': 194 show_bp_locs = true; 195 break; 196 default: 197 error.SetErrorStringWithFormat("unrecognized short option '%c'", short_option); 198 break; 199 } 200 201 return error; 202 } 203 204 void 205 OptionParsingStarting () 206 { 207 file_spec.Clear(); 208 file_name.clear(); 209 symbol_name.clear(); 210 start_line = 0; 211 num_lines = 10; 212 show_bp_locs = false; 213 modules.clear(); 214 } 215 216 const OptionDefinition* 217 GetDefinitions () 218 { 219 return g_option_table; 220 } 221 static OptionDefinition g_option_table[]; 222 223 // Instance variables to hold the values for command options. 224 FileSpec file_spec; 225 std::string file_name; 226 std::string symbol_name; 227 uint32_t start_line; 228 uint32_t num_lines; 229 STLStringArray modules; 230 bool show_bp_locs; 231 }; 232 233 public: 234 CommandObjectSourceList(CommandInterpreter &interpreter) : 235 CommandObject (interpreter, 236 "source list", 237 "Display source code (as specified) based on the current executable's debug info.", 238 NULL), 239 m_options (interpreter) 240 { 241 CommandArgumentEntry arg; 242 CommandArgumentData file_arg; 243 244 // Define the first (and only) variant of this arg. 245 file_arg.arg_type = eArgTypeFilename; 246 file_arg.arg_repetition = eArgRepeatOptional; 247 248 // There is only one variant this argument could be; put it into the argument entry. 249 arg.push_back (file_arg); 250 251 // Push the data for the first argument into the m_arguments vector. 252 m_arguments.push_back (arg); 253 } 254 255 ~CommandObjectSourceList () 256 { 257 } 258 259 260 Options * 261 GetOptions () 262 { 263 return &m_options; 264 } 265 266 267 bool 268 Execute 269 ( 270 Args& args, 271 CommandReturnObject &result 272 ) 273 { 274 const int argc = args.GetArgumentCount(); 275 276 if (argc != 0) 277 { 278 result.AppendErrorWithFormat("'%s' takes no arguments, only flags.\n", GetCommandName()); 279 result.SetStatus (eReturnStatusFailed); 280 return false; 281 } 282 283 ExecutionContext exe_ctx(m_interpreter.GetExecutionContext()); 284 Target *target = exe_ctx.GetTargetPtr(); 285 286 if (target == NULL) 287 target = m_interpreter.GetDebugger().GetSelectedTarget().get(); 288 289 if (target == NULL) 290 { 291 result.AppendError ("invalid target, create a debug target using the 'target create' command"); 292 result.SetStatus (eReturnStatusFailed); 293 return false; 294 } 295 296 if (!m_options.symbol_name.empty()) 297 { 298 // Displaying the source for a symbol: 299 SymbolContextList sc_list; 300 ConstString name(m_options.symbol_name.c_str()); 301 bool include_symbols = false; 302 bool include_inlines = true; 303 bool append = true; 304 size_t num_matches = 0; 305 306 if (m_options.modules.size() > 0) 307 { 308 ModuleList matching_modules; 309 for (unsigned i = 0, e = m_options.modules.size(); i != e; i++) 310 { 311 FileSpec module_file_spec(m_options.modules[i].c_str(), false); 312 if (module_file_spec) 313 { 314 ModuleSpec module_spec (module_file_spec); 315 matching_modules.Clear(); 316 target->GetImages().FindModules (module_spec, matching_modules); 317 num_matches += matching_modules.FindFunctions (name, eFunctionNameTypeAuto, include_symbols, include_inlines, append, sc_list); 318 } 319 } 320 } 321 else 322 { 323 num_matches = target->GetImages().FindFunctions (name, eFunctionNameTypeAuto, include_symbols, include_inlines, append, sc_list); 324 } 325 326 SymbolContext sc; 327 328 if (num_matches == 0) 329 { 330 result.AppendErrorWithFormat("Could not find function named: \"%s\".\n", m_options.symbol_name.c_str()); 331 result.SetStatus (eReturnStatusFailed); 332 return false; 333 } 334 335 sc_list.GetContextAtIndex (0, sc); 336 FileSpec start_file; 337 uint32_t start_line; 338 uint32_t end_line; 339 FileSpec end_file; 340 if (sc.function != NULL) 341 { 342 sc.function->GetStartLineSourceInfo (start_file, start_line); 343 if (start_line == 0) 344 { 345 result.AppendErrorWithFormat("Could not find line information for start of function: \"%s\".\n", m_options.symbol_name.c_str()); 346 result.SetStatus (eReturnStatusFailed); 347 return false; 348 } 349 sc.function->GetEndLineSourceInfo (end_file, end_line); 350 } 351 else 352 { 353 result.AppendErrorWithFormat("Could not find function info for: \"%s\".\n", m_options.symbol_name.c_str()); 354 result.SetStatus (eReturnStatusFailed); 355 return false; 356 } 357 358 if (num_matches > 1) 359 { 360 // This could either be because there are multiple functions of this name, in which case 361 // we'll have to specify this further... Or it could be because there are multiple inlined instances 362 // of one function. So run through the matches and if they all have the same file & line then we can just 363 // list one. 364 365 bool found_multiple = false; 366 367 for (size_t i = 1; i < num_matches; i++) 368 { 369 SymbolContext scratch_sc; 370 sc_list.GetContextAtIndex (i, scratch_sc); 371 if (scratch_sc.function != NULL) 372 { 373 FileSpec scratch_file; 374 uint32_t scratch_line; 375 scratch_sc.function->GetStartLineSourceInfo (scratch_file, scratch_line); 376 if (scratch_file != start_file 377 || scratch_line != start_line) 378 { 379 found_multiple = true; 380 break; 381 } 382 } 383 } 384 if (found_multiple) 385 { 386 StreamString s; 387 for (size_t i = 0; i < num_matches; i++) 388 { 389 SymbolContext scratch_sc; 390 sc_list.GetContextAtIndex (i, scratch_sc); 391 if (scratch_sc.function != NULL) 392 { 393 s.Printf("\n%lu: ", i); 394 scratch_sc.function->Dump (&s, true); 395 } 396 } 397 result.AppendErrorWithFormat("Multiple functions found matching: %s: \n%s\n", 398 m_options.symbol_name.c_str(), 399 s.GetData()); 400 result.SetStatus (eReturnStatusFailed); 401 return false; 402 } 403 } 404 405 406 // This is a little hacky, but the first line table entry for a function points to the "{" that 407 // starts the function block. It would be nice to actually get the function 408 // declaration in there too. So back up a bit, but not further than what you're going to display. 409 size_t lines_to_back_up = m_options.num_lines >= 10 ? 5 : m_options.num_lines/2; 410 uint32_t line_no; 411 if (start_line <= lines_to_back_up) 412 line_no = 1; 413 else 414 line_no = start_line - lines_to_back_up; 415 416 // For fun, if the function is shorter than the number of lines we're supposed to display, 417 // only display the function... 418 if (end_line != 0) 419 { 420 if (m_options.num_lines > end_line - line_no) 421 m_options.num_lines = end_line - line_no; 422 } 423 424 char path_buf[PATH_MAX]; 425 start_file.GetPath(path_buf, sizeof(path_buf)); 426 427 if (m_options.show_bp_locs) 428 { 429 const bool show_inlines = true; 430 m_breakpoint_locations.Reset (start_file, 0, show_inlines); 431 SearchFilter target_search_filter (exe_ctx.GetTargetSP()); 432 target_search_filter.Search (m_breakpoint_locations); 433 } 434 else 435 m_breakpoint_locations.Clear(); 436 437 result.AppendMessageWithFormat("File: %s.\n", path_buf); 438 target->GetSourceManager().DisplaySourceLinesWithLineNumbers (start_file, 439 line_no, 440 0, 441 m_options.num_lines, 442 "", 443 &result.GetOutputStream(), 444 GetBreakpointLocations ()); 445 446 result.SetStatus (eReturnStatusSuccessFinishResult); 447 return true; 448 449 } 450 else if (m_options.file_name.empty()) 451 { 452 // Last valid source manager context, or the current frame if no 453 // valid last context in source manager. 454 // One little trick here, if you type the exact same list command twice in a row, it is 455 // more likely because you typed it once, then typed it again 456 if (m_options.start_line == 0) 457 { 458 if (target->GetSourceManager().DisplayMoreWithLineNumbers (&result.GetOutputStream(), 459 GetBreakpointLocations ())) 460 { 461 result.SetStatus (eReturnStatusSuccessFinishResult); 462 } 463 } 464 else 465 { 466 if (m_options.show_bp_locs) 467 { 468 SourceManager::FileSP last_file_sp (target->GetSourceManager().GetLastFile ()); 469 if (last_file_sp) 470 { 471 const bool show_inlines = true; 472 m_breakpoint_locations.Reset (last_file_sp->GetFileSpec(), 0, show_inlines); 473 SearchFilter target_search_filter (target->shared_from_this()); 474 target_search_filter.Search (m_breakpoint_locations); 475 } 476 } 477 else 478 m_breakpoint_locations.Clear(); 479 480 if (target->GetSourceManager().DisplaySourceLinesWithLineNumbersUsingLastFile( 481 m_options.start_line, // Line to display 482 0, // Lines before line to display 483 m_options.num_lines, // Lines after line to display 484 "", // Don't mark "line" 485 &result.GetOutputStream(), 486 GetBreakpointLocations ())) 487 { 488 result.SetStatus (eReturnStatusSuccessFinishResult); 489 } 490 491 } 492 } 493 else 494 { 495 const char *filename = m_options.file_name.c_str(); 496 497 bool check_inlines = false; 498 SymbolContextList sc_list; 499 size_t num_matches = 0; 500 501 if (m_options.modules.size() > 0) 502 { 503 ModuleList matching_modules; 504 for (unsigned i = 0, e = m_options.modules.size(); i != e; i++) 505 { 506 FileSpec module_file_spec(m_options.modules[i].c_str(), false); 507 if (module_file_spec) 508 { 509 ModuleSpec module_spec (module_file_spec); 510 matching_modules.Clear(); 511 target->GetImages().FindModules (module_spec, matching_modules); 512 num_matches += matching_modules.ResolveSymbolContextForFilePath (filename, 513 0, 514 check_inlines, 515 eSymbolContextModule | eSymbolContextCompUnit, 516 sc_list); 517 } 518 } 519 } 520 else 521 { 522 num_matches = target->GetImages().ResolveSymbolContextForFilePath (filename, 523 0, 524 check_inlines, 525 eSymbolContextModule | eSymbolContextCompUnit, 526 sc_list); 527 } 528 529 if (num_matches == 0) 530 { 531 result.AppendErrorWithFormat("Could not find source file \"%s\".\n", 532 m_options.file_name.c_str()); 533 result.SetStatus (eReturnStatusFailed); 534 return false; 535 } 536 537 if (num_matches > 1) 538 { 539 SymbolContext sc; 540 bool got_multiple = false; 541 FileSpec *test_cu_spec = NULL; 542 543 for (unsigned i = 0; i < num_matches; i++) 544 { 545 sc_list.GetContextAtIndex(i, sc); 546 if (sc.comp_unit) 547 { 548 if (test_cu_spec) 549 { 550 if (test_cu_spec != static_cast<FileSpec *> (sc.comp_unit)) 551 got_multiple = true; 552 break; 553 } 554 else 555 test_cu_spec = sc.comp_unit; 556 } 557 } 558 if (got_multiple) 559 { 560 result.AppendErrorWithFormat("Multiple source files found matching: \"%s.\"\n", 561 m_options.file_name.c_str()); 562 result.SetStatus (eReturnStatusFailed); 563 return false; 564 } 565 } 566 567 SymbolContext sc; 568 if (sc_list.GetContextAtIndex(0, sc)) 569 { 570 if (sc.comp_unit) 571 { 572 if (m_options.show_bp_locs) 573 { 574 const bool show_inlines = true; 575 m_breakpoint_locations.Reset (*sc.comp_unit, 0, show_inlines); 576 SearchFilter target_search_filter (target->shared_from_this()); 577 target_search_filter.Search (m_breakpoint_locations); 578 } 579 else 580 m_breakpoint_locations.Clear(); 581 582 target->GetSourceManager().DisplaySourceLinesWithLineNumbers (sc.comp_unit, 583 m_options.start_line, 584 0, 585 m_options.num_lines, 586 "", 587 &result.GetOutputStream(), 588 GetBreakpointLocations ()); 589 590 result.SetStatus (eReturnStatusSuccessFinishResult); 591 } 592 else 593 { 594 result.AppendErrorWithFormat("No comp unit found for: \"%s.\"\n", 595 m_options.file_name.c_str()); 596 result.SetStatus (eReturnStatusFailed); 597 return false; 598 } 599 } 600 } 601 return result.Succeeded(); 602 } 603 604 virtual const char *GetRepeatCommand (Args ¤t_command_args, uint32_t index) 605 { 606 return m_cmd_name.c_str(); 607 } 608 609 protected: 610 const SymbolContextList * 611 GetBreakpointLocations () 612 { 613 if (m_breakpoint_locations.GetFileLineMatches().GetSize() > 0) 614 return &m_breakpoint_locations.GetFileLineMatches(); 615 return NULL; 616 } 617 CommandOptions m_options; 618 FileLineResolver m_breakpoint_locations; 619 620 }; 621 622 OptionDefinition 623 CommandObjectSourceList::CommandOptions::g_option_table[] = 624 { 625 { LLDB_OPT_SET_ALL, false, "count", 'c', required_argument, NULL, 0, eArgTypeCount, "The number of source lines to display."}, 626 { LLDB_OPT_SET_ALL, false, "shlib", 's', required_argument, NULL, CommandCompletions::eModuleCompletion, eArgTypeShlibName, "Look up the source file in the given shared library."}, 627 { LLDB_OPT_SET_ALL, false, "show-breakpoints", 'b', no_argument, NULL, 0, eArgTypeNone, "Show the line table locations from the debug information that indicate valid places to set source level breakpoints."}, 628 { LLDB_OPT_SET_1, false, "file", 'f', required_argument, NULL, CommandCompletions::eSourceFileCompletion, eArgTypeFilename, "The file from which to display source."}, 629 { LLDB_OPT_SET_1, false, "line", 'l', required_argument, NULL, 0, eArgTypeLineNum, "The line number at which to start the display source."}, 630 { LLDB_OPT_SET_2, false, "name", 'n', required_argument, NULL, CommandCompletions::eSymbolCompletion, eArgTypeSymbol, "The name of a function whose source to display."}, 631 { 0, false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL } 632 }; 633 634 #pragma mark CommandObjectMultiwordSource 635 636 //------------------------------------------------------------------------- 637 // CommandObjectMultiwordSource 638 //------------------------------------------------------------------------- 639 640 CommandObjectMultiwordSource::CommandObjectMultiwordSource (CommandInterpreter &interpreter) : 641 CommandObjectMultiword (interpreter, 642 "source", 643 "A set of commands for accessing source file information", 644 "source <subcommand> [<subcommand-options>]") 645 { 646 LoadSubCommand ("info", CommandObjectSP (new CommandObjectSourceInfo (interpreter))); 647 LoadSubCommand ("list", CommandObjectSP (new CommandObjectSourceList (interpreter))); 648 } 649 650 CommandObjectMultiwordSource::~CommandObjectMultiwordSource () 651 { 652 } 653 654