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'.\n", 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'.\n", 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'.\n", 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'.\n", 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'.\n", 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 } 281 282 ExecutionContext exe_ctx(m_interpreter.GetExecutionContext()); 283 Target *target = NULL; 284 285 if (exe_ctx.target) 286 target = exe_ctx.target; 287 else 288 target = m_interpreter.GetDebugger().GetSelectedTarget().get(); 289 290 if (target == NULL) 291 { 292 result.AppendError ("invalid target, create a debug target using the 'target create' command"); 293 result.SetStatus (eReturnStatusFailed); 294 return false; 295 } 296 297 if (!m_options.symbol_name.empty()) 298 { 299 // Displaying the source for a symbol: 300 SymbolContextList sc_list; 301 ConstString name(m_options.symbol_name.c_str()); 302 bool include_symbols = false; 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_spec(m_options.modules[i].c_str(), false); 312 if (module_spec) 313 { 314 matching_modules.Clear(); 315 target->GetImages().FindModules (&module_spec, NULL, NULL, NULL, matching_modules); 316 num_matches += matching_modules.FindFunctions (name, eFunctionNameTypeBase, include_symbols, append, sc_list); 317 } 318 } 319 } 320 else 321 { 322 num_matches = target->GetImages().FindFunctions (name, eFunctionNameTypeBase, include_symbols, append, sc_list); 323 } 324 325 SymbolContext sc; 326 327 if (num_matches == 0) 328 { 329 result.AppendErrorWithFormat("Could not find function named: \"%s\".\n", m_options.symbol_name.c_str()); 330 result.SetStatus (eReturnStatusFailed); 331 return false; 332 } 333 334 sc_list.GetContextAtIndex (0, sc); 335 FileSpec start_file; 336 uint32_t start_line; 337 uint32_t end_line; 338 FileSpec end_file; 339 if (sc.function != NULL) 340 { 341 sc.function->GetStartLineSourceInfo (start_file, start_line); 342 if (start_line == 0) 343 { 344 result.AppendErrorWithFormat("Could not find line information for start of function: \"%s\".\n", m_options.symbol_name.c_str()); 345 result.SetStatus (eReturnStatusFailed); 346 return false; 347 } 348 sc.function->GetEndLineSourceInfo (end_file, end_line); 349 } 350 else 351 { 352 result.AppendErrorWithFormat("Could not find function info for: \"%s\".\n", m_options.symbol_name.c_str()); 353 result.SetStatus (eReturnStatusFailed); 354 return false; 355 } 356 357 if (num_matches > 1) 358 { 359 // This could either be because there are multiple functions of this name, in which case 360 // we'll have to specify this further... Or it could be because there are multiple inlined instances 361 // of one function. So run through the matches and if they all have the same file & line then we can just 362 // list one. 363 364 bool found_multiple = false; 365 366 for (size_t i = 1; i < num_matches; i++) 367 { 368 SymbolContext scratch_sc; 369 sc_list.GetContextAtIndex (i, scratch_sc); 370 if (scratch_sc.function != NULL) 371 { 372 FileSpec scratch_file; 373 uint32_t scratch_line; 374 scratch_sc.function->GetStartLineSourceInfo (scratch_file, scratch_line); 375 if (scratch_file != start_file 376 || scratch_line != start_line) 377 { 378 found_multiple = true; 379 break; 380 } 381 } 382 } 383 if (found_multiple) 384 { 385 StreamString s; 386 for (size_t i = 0; i < num_matches; i++) 387 { 388 SymbolContext scratch_sc; 389 sc_list.GetContextAtIndex (i, scratch_sc); 390 if (scratch_sc.function != NULL) 391 { 392 s.Printf("\n%d: ", i); 393 scratch_sc.function->Dump (&s, true); 394 } 395 } 396 result.AppendErrorWithFormat("Multiple functions found matching: %s: \n%s\n", 397 m_options.symbol_name.c_str(), 398 s.GetData()); 399 result.SetStatus (eReturnStatusFailed); 400 return false; 401 } 402 } 403 404 405 // This is a little hacky, but the first line table entry for a function points to the "{" that 406 // starts the function block. It would be nice to actually get the function 407 // declaration in there too. So back up a bit, but not further than what you're going to display. 408 size_t lines_to_back_up = m_options.num_lines >= 10 ? 5 : m_options.num_lines/2; 409 uint32_t line_no; 410 if (start_line <= lines_to_back_up) 411 line_no = 1; 412 else 413 line_no = start_line - lines_to_back_up; 414 415 // For fun, if the function is shorter than the number of lines we're supposed to display, 416 // only display the function... 417 if (end_line != 0) 418 { 419 if (m_options.num_lines > end_line - line_no) 420 m_options.num_lines = end_line - line_no; 421 } 422 423 char path_buf[PATH_MAX]; 424 start_file.GetPath(path_buf, sizeof(path_buf)); 425 426 if (m_options.show_bp_locs) 427 { 428 const bool show_inlines = true; 429 m_breakpoint_locations.Reset (start_file, 0, show_inlines); 430 SearchFilter target_search_filter (exe_ctx.target->GetSP()); 431 target_search_filter.Search (m_breakpoint_locations); 432 } 433 else 434 m_breakpoint_locations.Clear(); 435 436 result.AppendMessageWithFormat("File: %s.\n", path_buf); 437 target->GetSourceManager().DisplaySourceLinesWithLineNumbers (start_file, 438 line_no, 439 0, 440 m_options.num_lines, 441 "", 442 &result.GetOutputStream(), 443 GetBreakpointLocations ()); 444 445 result.SetStatus (eReturnStatusSuccessFinishResult); 446 return true; 447 448 } 449 else if (m_options.file_name.empty()) 450 { 451 // Last valid source manager context, or the current frame if no 452 // valid last context in source manager. 453 // One little trick here, if you type the exact same list command twice in a row, it is 454 // more likely because you typed it once, then typed it again 455 if (m_options.start_line == 0) 456 { 457 if (m_interpreter.GetDebugger().GetSourceManager().DisplayMoreWithLineNumbers (&result.GetOutputStream(), 458 GetBreakpointLocations ())) 459 { 460 result.SetStatus (eReturnStatusSuccessFinishResult); 461 } 462 } 463 else 464 { 465 if (m_options.show_bp_locs) 466 { 467 SourceManager::FileSP last_file_sp (target->GetSourceManager().GetLastFile ()); 468 if (last_file_sp) 469 { 470 const bool show_inlines = true; 471 m_breakpoint_locations.Reset (last_file_sp->GetFileSpec(), 0, show_inlines); 472 SearchFilter target_search_filter (target->GetSP()); 473 target_search_filter.Search (m_breakpoint_locations); 474 } 475 } 476 else 477 m_breakpoint_locations.Clear(); 478 479 if (target->GetSourceManager().DisplaySourceLinesWithLineNumbersUsingLastFile( 480 m_options.start_line, // Line to display 481 0, // Lines before line to display 482 m_options.num_lines, // Lines after line to display 483 "", // Don't mark "line" 484 &result.GetOutputStream(), 485 GetBreakpointLocations ())) 486 { 487 result.SetStatus (eReturnStatusSuccessFinishResult); 488 } 489 490 } 491 } 492 else 493 { 494 const char *filename = m_options.file_name.c_str(); 495 496 bool check_inlines = false; 497 SymbolContextList sc_list; 498 size_t num_matches = 0; 499 500 if (m_options.modules.size() > 0) 501 { 502 ModuleList matching_modules; 503 for (unsigned i = 0, e = m_options.modules.size(); i != e; i++) 504 { 505 FileSpec module_spec(m_options.modules[i].c_str(), false); 506 if (module_spec) 507 { 508 matching_modules.Clear(); 509 target->GetImages().FindModules (&module_spec, NULL, NULL, NULL, matching_modules); 510 num_matches += matching_modules.ResolveSymbolContextForFilePath (filename, 511 0, 512 check_inlines, 513 eSymbolContextModule | eSymbolContextCompUnit, 514 sc_list); 515 } 516 } 517 } 518 else 519 { 520 num_matches = target->GetImages().ResolveSymbolContextForFilePath (filename, 521 0, 522 check_inlines, 523 eSymbolContextModule | eSymbolContextCompUnit, 524 sc_list); 525 } 526 527 if (num_matches == 0) 528 { 529 result.AppendErrorWithFormat("Could not find source file \"%s\".\n", 530 m_options.file_name.c_str()); 531 result.SetStatus (eReturnStatusFailed); 532 return false; 533 } 534 535 if (num_matches > 1) 536 { 537 SymbolContext sc; 538 bool got_multiple = false; 539 FileSpec *test_cu_spec = NULL; 540 541 for (unsigned i = 0; i < num_matches; i++) 542 { 543 sc_list.GetContextAtIndex(i, sc); 544 if (sc.comp_unit) 545 { 546 if (test_cu_spec) 547 { 548 if (test_cu_spec != static_cast<FileSpec *> (sc.comp_unit)) 549 got_multiple = true; 550 break; 551 } 552 else 553 test_cu_spec = sc.comp_unit; 554 } 555 } 556 if (got_multiple) 557 { 558 result.AppendErrorWithFormat("Multiple source files found matching: \"%s.\"\n", 559 m_options.file_name.c_str()); 560 result.SetStatus (eReturnStatusFailed); 561 return false; 562 } 563 } 564 565 SymbolContext sc; 566 if (sc_list.GetContextAtIndex(0, sc)) 567 { 568 if (sc.comp_unit) 569 { 570 if (m_options.show_bp_locs) 571 { 572 const bool show_inlines = true; 573 m_breakpoint_locations.Reset (*sc.comp_unit, 0, show_inlines); 574 SearchFilter target_search_filter (target->GetSP()); 575 target_search_filter.Search (m_breakpoint_locations); 576 } 577 else 578 m_breakpoint_locations.Clear(); 579 580 target->GetSourceManager().DisplaySourceLinesWithLineNumbers (sc.comp_unit, 581 m_options.start_line, 582 0, 583 m_options.num_lines, 584 "", 585 &result.GetOutputStream(), 586 GetBreakpointLocations ()); 587 588 result.SetStatus (eReturnStatusSuccessFinishResult); 589 } 590 else 591 { 592 result.AppendErrorWithFormat("No comp unit found for: \"%s.\"\n", 593 m_options.file_name.c_str()); 594 result.SetStatus (eReturnStatusFailed); 595 return false; 596 } 597 } 598 } 599 return result.Succeeded(); 600 } 601 602 virtual const char *GetRepeatCommand (Args ¤t_command_args, uint32_t index) 603 { 604 return m_cmd_name.c_str(); 605 } 606 607 protected: 608 const SymbolContextList * 609 GetBreakpointLocations () 610 { 611 if (m_breakpoint_locations.GetFileLineMatches().GetSize() > 0) 612 return &m_breakpoint_locations.GetFileLineMatches(); 613 return NULL; 614 } 615 CommandOptions m_options; 616 FileLineResolver m_breakpoint_locations; 617 618 }; 619 620 OptionDefinition 621 CommandObjectSourceList::CommandOptions::g_option_table[] = 622 { 623 { LLDB_OPT_SET_ALL, false, "count", 'c', required_argument, NULL, 0, eArgTypeCount, "The number of source lines to display."}, 624 { LLDB_OPT_SET_ALL, false, "shlib", 's', required_argument, NULL, CommandCompletions::eModuleCompletion, eArgTypeShlibName, "Look up the source file in the given shared library."}, 625 { 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."}, 626 { LLDB_OPT_SET_1, false, "file", 'f', required_argument, NULL, CommandCompletions::eSourceFileCompletion, eArgTypeFilename, "The file from which to display source."}, 627 { LLDB_OPT_SET_1, false, "line", 'l', required_argument, NULL, 0, eArgTypeLineNum, "The line number at which to start the display source."}, 628 { LLDB_OPT_SET_2, false, "name", 'n', required_argument, NULL, CommandCompletions::eSymbolCompletion, eArgTypeSymbol, "The name of a function whose source to display."}, 629 { 0, false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL } 630 }; 631 632 #pragma mark CommandObjectMultiwordSource 633 634 //------------------------------------------------------------------------- 635 // CommandObjectMultiwordSource 636 //------------------------------------------------------------------------- 637 638 CommandObjectMultiwordSource::CommandObjectMultiwordSource (CommandInterpreter &interpreter) : 639 CommandObjectMultiword (interpreter, 640 "source", 641 "A set of commands for accessing source file information", 642 "source <subcommand> [<subcommand-options>]") 643 { 644 LoadSubCommand ("info", CommandObjectSP (new CommandObjectSourceInfo (interpreter))); 645 LoadSubCommand ("list", CommandObjectSP (new CommandObjectSourceList (interpreter))); 646 } 647 648 CommandObjectMultiwordSource::~CommandObjectMultiwordSource () 649 { 650 } 651 652