1 //===-- CommandObjectFrame.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 "CommandObjectFrame.h" 11 12 // C Includes 13 // C++ Includes 14 #include <string> 15 // Other libraries and framework includes 16 // Project includes 17 #include "lldb/Core/DataVisualization.h" 18 #include "lldb/Core/Debugger.h" 19 #include "lldb/Core/Module.h" 20 #include "lldb/Core/StreamFile.h" 21 #include "lldb/Core/StreamString.h" 22 #include "lldb/Core/Timer.h" 23 #include "lldb/Core/Value.h" 24 #include "lldb/Core/ValueObject.h" 25 #include "lldb/Core/ValueObjectVariable.h" 26 #include "lldb/Host/Host.h" 27 #include "lldb/Interpreter/Args.h" 28 #include "lldb/Interpreter/CommandInterpreter.h" 29 #include "lldb/Interpreter/CommandReturnObject.h" 30 #include "lldb/Interpreter/Options.h" 31 #include "lldb/Interpreter/OptionGroupFormat.h" 32 #include "lldb/Interpreter/OptionGroupValueObjectDisplay.h" 33 #include "lldb/Interpreter/OptionGroupVariable.h" 34 #include "lldb/Symbol/ClangASTType.h" 35 #include "lldb/Symbol/ClangASTContext.h" 36 #include "lldb/Symbol/ObjectFile.h" 37 #include "lldb/Symbol/SymbolContext.h" 38 #include "lldb/Symbol/Type.h" 39 #include "lldb/Symbol/Variable.h" 40 #include "lldb/Symbol/VariableList.h" 41 #include "lldb/Target/Process.h" 42 #include "lldb/Target/StackFrame.h" 43 #include "lldb/Target/Thread.h" 44 #include "lldb/Target/Target.h" 45 46 using namespace lldb; 47 using namespace lldb_private; 48 49 #pragma mark CommandObjectFrameInfo 50 51 //------------------------------------------------------------------------- 52 // CommandObjectFrameInfo 53 //------------------------------------------------------------------------- 54 55 class CommandObjectFrameInfo : public CommandObjectParsed 56 { 57 public: 58 59 CommandObjectFrameInfo (CommandInterpreter &interpreter) : 60 CommandObjectParsed (interpreter, 61 "frame info", 62 "List information about the currently selected frame in the current thread.", 63 "frame info", 64 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused) 65 { 66 } 67 68 ~CommandObjectFrameInfo () 69 { 70 } 71 72 protected: 73 bool 74 DoExecute (Args& command, 75 CommandReturnObject &result) 76 { 77 ExecutionContext exe_ctx(m_interpreter.GetExecutionContext()); 78 StackFrame *frame = exe_ctx.GetFramePtr(); 79 if (frame) 80 { 81 frame->DumpUsingSettingsFormat (&result.GetOutputStream()); 82 result.SetStatus (eReturnStatusSuccessFinishResult); 83 } 84 else 85 { 86 result.AppendError ("no current frame"); 87 result.SetStatus (eReturnStatusFailed); 88 } 89 return result.Succeeded(); 90 } 91 }; 92 93 #pragma mark CommandObjectFrameSelect 94 95 //------------------------------------------------------------------------- 96 // CommandObjectFrameSelect 97 //------------------------------------------------------------------------- 98 99 class CommandObjectFrameSelect : public CommandObjectParsed 100 { 101 public: 102 103 class CommandOptions : public Options 104 { 105 public: 106 107 CommandOptions (CommandInterpreter &interpreter) : 108 Options(interpreter) 109 { 110 OptionParsingStarting (); 111 } 112 113 virtual 114 ~CommandOptions () 115 { 116 } 117 118 virtual Error 119 SetOptionValue (uint32_t option_idx, const char *option_arg) 120 { 121 Error error; 122 bool success = false; 123 char short_option = (char) m_getopt_table[option_idx].val; 124 switch (short_option) 125 { 126 case 'r': 127 relative_frame_offset = Args::StringToSInt32 (option_arg, INT32_MIN, 0, &success); 128 if (!success) 129 error.SetErrorStringWithFormat ("invalid frame offset argument '%s'", option_arg); 130 break; 131 132 default: 133 error.SetErrorStringWithFormat ("invalid short option character '%c'", short_option); 134 break; 135 } 136 137 return error; 138 } 139 140 void 141 OptionParsingStarting () 142 { 143 relative_frame_offset = INT32_MIN; 144 } 145 146 const OptionDefinition* 147 GetDefinitions () 148 { 149 return g_option_table; 150 } 151 152 // Options table: Required for subclasses of Options. 153 154 static OptionDefinition g_option_table[]; 155 int32_t relative_frame_offset; 156 }; 157 158 CommandObjectFrameSelect (CommandInterpreter &interpreter) : 159 CommandObjectParsed (interpreter, 160 "frame select", 161 "Select a frame by index from within the current thread and make it the current frame.", 162 NULL, 163 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused), 164 m_options (interpreter) 165 { 166 CommandArgumentEntry arg; 167 CommandArgumentData index_arg; 168 169 // Define the first (and only) variant of this arg. 170 index_arg.arg_type = eArgTypeFrameIndex; 171 index_arg.arg_repetition = eArgRepeatOptional; 172 173 // There is only one variant this argument could be; put it into the argument entry. 174 arg.push_back (index_arg); 175 176 // Push the data for the first argument into the m_arguments vector. 177 m_arguments.push_back (arg); 178 } 179 180 ~CommandObjectFrameSelect () 181 { 182 } 183 184 virtual 185 Options * 186 GetOptions () 187 { 188 return &m_options; 189 } 190 191 192 protected: 193 bool 194 DoExecute (Args& command, 195 CommandReturnObject &result) 196 { 197 ExecutionContext exe_ctx (m_interpreter.GetExecutionContext()); 198 Thread *thread = exe_ctx.GetThreadPtr(); 199 if (thread) 200 { 201 uint32_t frame_idx = UINT32_MAX; 202 if (m_options.relative_frame_offset != INT32_MIN) 203 { 204 // The one and only argument is a signed relative frame index 205 frame_idx = thread->GetSelectedFrameIndex (); 206 if (frame_idx == UINT32_MAX) 207 frame_idx = 0; 208 209 if (m_options.relative_frame_offset < 0) 210 { 211 if (frame_idx >= -m_options.relative_frame_offset) 212 frame_idx += m_options.relative_frame_offset; 213 else 214 { 215 if (frame_idx == 0) 216 { 217 //If you are already at the bottom of the stack, then just warn and don't reset the frame. 218 result.AppendError("Already at the bottom of the stack"); 219 result.SetStatus(eReturnStatusFailed); 220 return false; 221 } 222 else 223 frame_idx = 0; 224 } 225 } 226 else if (m_options.relative_frame_offset > 0) 227 { 228 // I don't want "up 20" where "20" takes you past the top of the stack to produce 229 // an error, but rather to just go to the top. So I have to count the stack here... 230 const uint32_t num_frames = thread->GetStackFrameCount(); 231 if (num_frames - frame_idx > m_options.relative_frame_offset) 232 frame_idx += m_options.relative_frame_offset; 233 else 234 { 235 if (frame_idx == num_frames - 1) 236 { 237 //If we are already at the top of the stack, just warn and don't reset the frame. 238 result.AppendError("Already at the top of the stack"); 239 result.SetStatus(eReturnStatusFailed); 240 return false; 241 } 242 else 243 frame_idx = num_frames - 1; 244 } 245 } 246 } 247 else 248 { 249 if (command.GetArgumentCount() == 1) 250 { 251 const char *frame_idx_cstr = command.GetArgumentAtIndex(0); 252 frame_idx = Args::StringToUInt32 (frame_idx_cstr, UINT32_MAX, 0); 253 } 254 else if (command.GetArgumentCount() == 0) 255 { 256 frame_idx = thread->GetSelectedFrameIndex (); 257 if (frame_idx == UINT32_MAX) 258 { 259 frame_idx = 0; 260 } 261 } 262 else 263 { 264 result.AppendError ("invalid arguments.\n"); 265 m_options.GenerateOptionUsage (result.GetErrorStream(), this); 266 } 267 } 268 269 bool success = thread->SetSelectedFrameByIndex (frame_idx); 270 if (success) 271 { 272 exe_ctx.SetFrameSP(thread->GetSelectedFrame ()); 273 StackFrame *frame = exe_ctx.GetFramePtr(); 274 if (frame) 275 { 276 bool already_shown = false; 277 SymbolContext frame_sc(frame->GetSymbolContext(eSymbolContextLineEntry)); 278 if (m_interpreter.GetDebugger().GetUseExternalEditor() && frame_sc.line_entry.file && frame_sc.line_entry.line != 0) 279 { 280 already_shown = Host::OpenFileInExternalEditor (frame_sc.line_entry.file, frame_sc.line_entry.line); 281 } 282 283 bool show_frame_info = true; 284 bool show_source = !already_shown; 285 Debugger &debugger = m_interpreter.GetDebugger(); 286 const uint32_t source_lines_before = debugger.GetStopSourceLineCount(true); 287 const uint32_t source_lines_after = debugger.GetStopSourceLineCount(false); 288 if (frame->GetStatus (result.GetOutputStream(), 289 show_frame_info, 290 show_source, 291 source_lines_before, 292 source_lines_after)) 293 { 294 result.SetStatus (eReturnStatusSuccessFinishResult); 295 return result.Succeeded(); 296 } 297 } 298 } 299 result.AppendErrorWithFormat ("Frame index (%u) out of range.\n", frame_idx); 300 } 301 else 302 { 303 result.AppendError ("no current thread"); 304 } 305 result.SetStatus (eReturnStatusFailed); 306 return false; 307 } 308 protected: 309 310 CommandOptions m_options; 311 }; 312 313 OptionDefinition 314 CommandObjectFrameSelect::CommandOptions::g_option_table[] = 315 { 316 { LLDB_OPT_SET_1, false, "relative", 'r', required_argument, NULL, 0, eArgTypeOffset, "A relative frame index offset from the current frame index."}, 317 { 0, false, NULL, 0, 0, NULL, NULL, eArgTypeNone, NULL } 318 }; 319 320 #pragma mark CommandObjectFrameVariable 321 //---------------------------------------------------------------------- 322 // List images with associated information 323 //---------------------------------------------------------------------- 324 class CommandObjectFrameVariable : public CommandObjectParsed 325 { 326 public: 327 328 CommandObjectFrameVariable (CommandInterpreter &interpreter) : 329 CommandObjectParsed (interpreter, 330 "frame variable", 331 "Show frame variables. All argument and local variables " 332 "that are in scope will be shown when no arguments are given. " 333 "If any arguments are specified, they can be names of " 334 "argument, local, file static and file global variables. " 335 "Children of aggregate variables can be specified such as " 336 "'var->child.x'.", 337 NULL, 338 eFlagProcessMustBeLaunched | eFlagProcessMustBePaused), 339 m_option_group (interpreter), 340 m_option_variable(true), // Include the frame specific options by passing "true" 341 m_option_format (eFormatDefault), 342 m_varobj_options() 343 { 344 CommandArgumentEntry arg; 345 CommandArgumentData var_name_arg; 346 347 // Define the first (and only) variant of this arg. 348 var_name_arg.arg_type = eArgTypeVarName; 349 var_name_arg.arg_repetition = eArgRepeatStar; 350 351 // There is only one variant this argument could be; put it into the argument entry. 352 arg.push_back (var_name_arg); 353 354 // Push the data for the first argument into the m_arguments vector. 355 m_arguments.push_back (arg); 356 357 m_option_group.Append (&m_option_variable, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1); 358 m_option_group.Append (&m_option_format, OptionGroupFormat::OPTION_GROUP_FORMAT | OptionGroupFormat::OPTION_GROUP_GDB_FMT, LLDB_OPT_SET_1); 359 m_option_group.Append (&m_varobj_options, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1); 360 m_option_group.Finalize(); 361 } 362 363 virtual 364 ~CommandObjectFrameVariable () 365 { 366 } 367 368 virtual 369 Options * 370 GetOptions () 371 { 372 return &m_option_group; 373 } 374 375 protected: 376 virtual bool 377 DoExecute (Args& command, CommandReturnObject &result) 378 { 379 ExecutionContext exe_ctx(m_interpreter.GetExecutionContext()); 380 StackFrame *frame = exe_ctx.GetFramePtr(); 381 if (frame == NULL) 382 { 383 result.AppendError ("you must be stopped in a valid stack frame to view frame variables."); 384 result.SetStatus (eReturnStatusFailed); 385 return false; 386 } 387 388 Stream &s = result.GetOutputStream(); 389 390 bool get_file_globals = true; 391 392 // Be careful about the stack frame, if any summary formatter runs code, it might clear the StackFrameList 393 // for the thread. So hold onto a shared pointer to the frame so it stays alive. 394 395 VariableList *variable_list = frame->GetVariableList (get_file_globals); 396 397 VariableSP var_sp; 398 ValueObjectSP valobj_sp; 399 400 const char *name_cstr = NULL; 401 size_t idx; 402 403 TypeSummaryImplSP summary_format_sp; 404 if (!m_option_variable.summary.empty()) 405 DataVisualization::NamedSummaryFormats::GetSummaryFormat(ConstString(m_option_variable.summary.c_str()), summary_format_sp); 406 407 ValueObject::DumpValueObjectOptions options; 408 409 options.SetMaximumPointerDepth(m_varobj_options.ptr_depth) 410 .SetMaximumDepth(m_varobj_options.max_depth) 411 .SetShowTypes(m_varobj_options.show_types) 412 .SetShowLocation(m_varobj_options.show_location) 413 .SetUseObjectiveC(m_varobj_options.use_objc) 414 .SetUseDynamicType(m_varobj_options.use_dynamic) 415 .SetUseSyntheticValue(m_varobj_options.use_synth) 416 .SetFlatOutput(m_varobj_options.flat_output) 417 .SetOmitSummaryDepth(m_varobj_options.no_summary_depth) 418 .SetIgnoreCap(m_varobj_options.ignore_cap) 419 .SetSummary(summary_format_sp); 420 421 if (m_varobj_options.be_raw) 422 options.SetRawDisplay(true); 423 424 if (variable_list) 425 { 426 const Format format = m_option_format.GetFormat(); 427 options.SetFormat(format); 428 429 if (command.GetArgumentCount() > 0) 430 { 431 VariableList regex_var_list; 432 433 // If we have any args to the variable command, we will make 434 // variable objects from them... 435 for (idx = 0; (name_cstr = command.GetArgumentAtIndex(idx)) != NULL; ++idx) 436 { 437 if (m_option_variable.use_regex) 438 { 439 const uint32_t regex_start_index = regex_var_list.GetSize(); 440 RegularExpression regex (name_cstr); 441 if (regex.Compile(name_cstr)) 442 { 443 size_t num_matches = 0; 444 const size_t num_new_regex_vars = variable_list->AppendVariablesIfUnique(regex, 445 regex_var_list, 446 num_matches); 447 if (num_new_regex_vars > 0) 448 { 449 for (uint32_t regex_idx = regex_start_index, end_index = regex_var_list.GetSize(); 450 regex_idx < end_index; 451 ++regex_idx) 452 { 453 var_sp = regex_var_list.GetVariableAtIndex (regex_idx); 454 if (var_sp) 455 { 456 valobj_sp = frame->GetValueObjectForFrameVariable (var_sp, m_varobj_options.use_dynamic); 457 if (valobj_sp) 458 { 459 // if (format != eFormatDefault) 460 // valobj_sp->SetFormat (format); 461 462 if (m_option_variable.show_decl && var_sp->GetDeclaration ().GetFile()) 463 { 464 bool show_fullpaths = false; 465 bool show_module = true; 466 if (var_sp->DumpDeclaration(&s, show_fullpaths, show_module)) 467 s.PutCString (": "); 468 } 469 ValueObject::DumpValueObject (result.GetOutputStream(), 470 valobj_sp.get(), 471 options); 472 } 473 } 474 } 475 } 476 else if (num_matches == 0) 477 { 478 result.GetErrorStream().Printf ("error: no variables matched the regular expression '%s'.\n", name_cstr); 479 } 480 } 481 else 482 { 483 char regex_error[1024]; 484 if (regex.GetErrorAsCString(regex_error, sizeof(regex_error))) 485 result.GetErrorStream().Printf ("error: %s\n", regex_error); 486 else 487 result.GetErrorStream().Printf ("error: unkown regex error when compiling '%s'\n", name_cstr); 488 } 489 } 490 else // No regex, either exact variable names or variable expressions. 491 { 492 Error error; 493 uint32_t expr_path_options = StackFrame::eExpressionPathOptionCheckPtrVsMember; 494 lldb::VariableSP var_sp; 495 valobj_sp = frame->GetValueForVariableExpressionPath (name_cstr, 496 m_varobj_options.use_dynamic, 497 expr_path_options, 498 var_sp, 499 error); 500 if (valobj_sp) 501 { 502 // if (format != eFormatDefault) 503 // valobj_sp->SetFormat (format); 504 if (m_option_variable.show_decl && var_sp && var_sp->GetDeclaration ().GetFile()) 505 { 506 var_sp->GetDeclaration ().DumpStopContext (&s, false); 507 s.PutCString (": "); 508 } 509 510 options.SetFormat(format); 511 512 Stream &output_stream = result.GetOutputStream(); 513 options.SetRootValueObjectName(valobj_sp->GetParent() ? name_cstr : NULL); 514 ValueObject::DumpValueObject (output_stream, 515 valobj_sp.get(), 516 options); 517 } 518 else 519 { 520 const char *error_cstr = error.AsCString(NULL); 521 if (error_cstr) 522 result.GetErrorStream().Printf("error: %s\n", error_cstr); 523 else 524 result.GetErrorStream().Printf ("error: unable to find any variable expression path that matches '%s'\n", name_cstr); 525 } 526 } 527 } 528 } 529 else // No command arg specified. Use variable_list, instead. 530 { 531 const uint32_t num_variables = variable_list->GetSize(); 532 if (num_variables > 0) 533 { 534 for (uint32_t i=0; i<num_variables; i++) 535 { 536 var_sp = variable_list->GetVariableAtIndex(i); 537 bool dump_variable = true; 538 switch (var_sp->GetScope()) 539 { 540 case eValueTypeVariableGlobal: 541 dump_variable = m_option_variable.show_globals; 542 if (dump_variable && m_option_variable.show_scope) 543 s.PutCString("GLOBAL: "); 544 break; 545 546 case eValueTypeVariableStatic: 547 dump_variable = m_option_variable.show_globals; 548 if (dump_variable && m_option_variable.show_scope) 549 s.PutCString("STATIC: "); 550 break; 551 552 case eValueTypeVariableArgument: 553 dump_variable = m_option_variable.show_args; 554 if (dump_variable && m_option_variable.show_scope) 555 s.PutCString(" ARG: "); 556 break; 557 558 case eValueTypeVariableLocal: 559 dump_variable = m_option_variable.show_locals; 560 if (dump_variable && m_option_variable.show_scope) 561 s.PutCString(" LOCAL: "); 562 break; 563 564 default: 565 break; 566 } 567 568 if (dump_variable) 569 { 570 // Use the variable object code to make sure we are 571 // using the same APIs as the the public API will be 572 // using... 573 valobj_sp = frame->GetValueObjectForFrameVariable (var_sp, 574 m_varobj_options.use_dynamic); 575 if (valobj_sp) 576 { 577 // if (format != eFormatDefault) 578 // valobj_sp->SetFormat (format); 579 580 // When dumping all variables, don't print any variables 581 // that are not in scope to avoid extra unneeded output 582 if (valobj_sp->IsInScope ()) 583 { 584 if (m_option_variable.show_decl && var_sp->GetDeclaration ().GetFile()) 585 { 586 var_sp->GetDeclaration ().DumpStopContext (&s, false); 587 s.PutCString (": "); 588 } 589 590 options.SetFormat(format); 591 options.SetRootValueObjectName(name_cstr); 592 ValueObject::DumpValueObject (result.GetOutputStream(), 593 valobj_sp.get(), 594 options); 595 } 596 } 597 } 598 } 599 } 600 } 601 result.SetStatus (eReturnStatusSuccessFinishResult); 602 } 603 604 if (m_interpreter.TruncationWarningNecessary()) 605 { 606 result.GetOutputStream().Printf(m_interpreter.TruncationWarningText(), 607 m_cmd_name.c_str()); 608 m_interpreter.TruncationWarningGiven(); 609 } 610 611 return result.Succeeded(); 612 } 613 protected: 614 615 OptionGroupOptions m_option_group; 616 OptionGroupVariable m_option_variable; 617 OptionGroupFormat m_option_format; 618 OptionGroupValueObjectDisplay m_varobj_options; 619 }; 620 621 622 #pragma mark CommandObjectMultiwordFrame 623 624 //------------------------------------------------------------------------- 625 // CommandObjectMultiwordFrame 626 //------------------------------------------------------------------------- 627 628 CommandObjectMultiwordFrame::CommandObjectMultiwordFrame (CommandInterpreter &interpreter) : 629 CommandObjectMultiword (interpreter, 630 "frame", 631 "A set of commands for operating on the current thread's frames.", 632 "frame <subcommand> [<subcommand-options>]") 633 { 634 LoadSubCommand ("info", CommandObjectSP (new CommandObjectFrameInfo (interpreter))); 635 LoadSubCommand ("select", CommandObjectSP (new CommandObjectFrameSelect (interpreter))); 636 LoadSubCommand ("variable", CommandObjectSP (new CommandObjectFrameVariable (interpreter))); 637 } 638 639 CommandObjectMultiwordFrame::~CommandObjectMultiwordFrame () 640 { 641 } 642 643