contrib/llvm/tools/lldb/source/Commands/CommandObjectFrame.cpp

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