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