130fdc8d8SChris Lattner //===-- CommandObjectFrame.cpp ----------------------------------*- C++ -*-===// 230fdc8d8SChris Lattner // 330fdc8d8SChris Lattner // The LLVM Compiler Infrastructure 430fdc8d8SChris Lattner // 530fdc8d8SChris Lattner // This file is distributed under the University of Illinois Open Source 630fdc8d8SChris Lattner // License. See LICENSE.TXT for details. 730fdc8d8SChris Lattner // 830fdc8d8SChris Lattner //===----------------------------------------------------------------------===// 930fdc8d8SChris Lattner 1030fdc8d8SChris Lattner #include "CommandObjectFrame.h" 1130fdc8d8SChris Lattner 1230fdc8d8SChris Lattner // C Includes 1330fdc8d8SChris Lattner // C++ Includes 1430fdc8d8SChris Lattner // Other libraries and framework includes 1530fdc8d8SChris Lattner // Project includes 1630fdc8d8SChris Lattner #include "lldb/Core/Debugger.h" 176d56d2ceSJim Ingham #include "lldb/Core/Module.h" 186d56d2ceSJim Ingham #include "lldb/Core/StreamFile.h" 1930fdc8d8SChris Lattner #include "lldb/Core/Timer.h" 206d56d2ceSJim Ingham #include "lldb/Core/Value.h" 216d56d2ceSJim Ingham #include "lldb/Core/ValueObject.h" 226d56d2ceSJim Ingham #include "lldb/Core/ValueObjectVariable.h" 237fb56d0aSGreg Clayton #include "lldb/Host/Host.h" 246d56d2ceSJim Ingham #include "lldb/Interpreter/Args.h" 2530fdc8d8SChris Lattner #include "lldb/Interpreter/CommandInterpreter.h" 2630fdc8d8SChris Lattner #include "lldb/Interpreter/CommandReturnObject.h" 276d56d2ceSJim Ingham #include "lldb/Interpreter/Options.h" 286d56d2ceSJim Ingham #include "lldb/Symbol/ClangASTType.h" 296d56d2ceSJim Ingham #include "lldb/Symbol/ClangASTContext.h" 306d56d2ceSJim Ingham #include "lldb/Symbol/ObjectFile.h" 316d56d2ceSJim Ingham #include "lldb/Symbol/SymbolContext.h" 326d56d2ceSJim Ingham #include "lldb/Symbol/Type.h" 336d56d2ceSJim Ingham #include "lldb/Symbol/Variable.h" 346d56d2ceSJim Ingham #include "lldb/Symbol/VariableList.h" 3530fdc8d8SChris Lattner #include "lldb/Target/Process.h" 3630fdc8d8SChris Lattner #include "lldb/Target/StackFrame.h" 3730fdc8d8SChris Lattner #include "lldb/Target/Thread.h" 386d56d2ceSJim Ingham #include "lldb/Target/Target.h" 3930fdc8d8SChris Lattner 4030fdc8d8SChris Lattner #include "CommandObjectThread.h" 4130fdc8d8SChris Lattner 4230fdc8d8SChris Lattner using namespace lldb; 4330fdc8d8SChris Lattner using namespace lldb_private; 4430fdc8d8SChris Lattner 4530fdc8d8SChris Lattner #pragma mark CommandObjectFrameInfo 4630fdc8d8SChris Lattner 4730fdc8d8SChris Lattner //------------------------------------------------------------------------- 4830fdc8d8SChris Lattner // CommandObjectFrameInfo 4930fdc8d8SChris Lattner //------------------------------------------------------------------------- 5030fdc8d8SChris Lattner 5130fdc8d8SChris Lattner class CommandObjectFrameInfo : public CommandObject 5230fdc8d8SChris Lattner { 5330fdc8d8SChris Lattner public: 5430fdc8d8SChris Lattner 55a7015092SGreg Clayton CommandObjectFrameInfo (CommandInterpreter &interpreter) : 56a7015092SGreg Clayton CommandObject (interpreter, 57a7015092SGreg Clayton "frame info", 58e3d26315SCaroline Tice "List information about the currently selected frame in the current thread.", 5930fdc8d8SChris Lattner "frame info", 6030fdc8d8SChris Lattner eFlagProcessMustBeLaunched | eFlagProcessMustBePaused) 6130fdc8d8SChris Lattner { 6230fdc8d8SChris Lattner } 6330fdc8d8SChris Lattner 6430fdc8d8SChris Lattner ~CommandObjectFrameInfo () 6530fdc8d8SChris Lattner { 6630fdc8d8SChris Lattner } 6730fdc8d8SChris Lattner 6830fdc8d8SChris Lattner bool 69a7015092SGreg Clayton Execute (Args& command, 7030fdc8d8SChris Lattner CommandReturnObject &result) 7130fdc8d8SChris Lattner { 72a7015092SGreg Clayton ExecutionContext exe_ctx(m_interpreter.GetDebugger().GetExecutionContext()); 7330fdc8d8SChris Lattner if (exe_ctx.frame) 7430fdc8d8SChris Lattner { 750603aa9dSGreg Clayton exe_ctx.frame->DumpUsingSettingsFormat (&result.GetOutputStream()); 7630fdc8d8SChris Lattner result.GetOutputStream().EOL(); 7730fdc8d8SChris Lattner result.SetStatus (eReturnStatusSuccessFinishResult); 7830fdc8d8SChris Lattner } 7930fdc8d8SChris Lattner else 8030fdc8d8SChris Lattner { 8130fdc8d8SChris Lattner result.AppendError ("no current frame"); 8230fdc8d8SChris Lattner result.SetStatus (eReturnStatusFailed); 8330fdc8d8SChris Lattner } 8430fdc8d8SChris Lattner return result.Succeeded(); 8530fdc8d8SChris Lattner } 8630fdc8d8SChris Lattner }; 8730fdc8d8SChris Lattner 8830fdc8d8SChris Lattner #pragma mark CommandObjectFrameSelect 8930fdc8d8SChris Lattner 9030fdc8d8SChris Lattner //------------------------------------------------------------------------- 9130fdc8d8SChris Lattner // CommandObjectFrameSelect 9230fdc8d8SChris Lattner //------------------------------------------------------------------------- 9330fdc8d8SChris Lattner 9430fdc8d8SChris Lattner class CommandObjectFrameSelect : public CommandObject 9530fdc8d8SChris Lattner { 9630fdc8d8SChris Lattner public: 9730fdc8d8SChris Lattner 98864174e1SGreg Clayton class CommandOptions : public Options 99864174e1SGreg Clayton { 100864174e1SGreg Clayton public: 101864174e1SGreg Clayton 102864174e1SGreg Clayton CommandOptions () : 103864174e1SGreg Clayton Options() 104864174e1SGreg Clayton { 105864174e1SGreg Clayton ResetOptionValues (); 106864174e1SGreg Clayton } 107864174e1SGreg Clayton 108864174e1SGreg Clayton virtual 109864174e1SGreg Clayton ~CommandOptions () 110864174e1SGreg Clayton { 111864174e1SGreg Clayton } 112864174e1SGreg Clayton 113864174e1SGreg Clayton virtual Error 114864174e1SGreg Clayton SetOptionValue (int option_idx, const char *option_arg) 115864174e1SGreg Clayton { 116864174e1SGreg Clayton Error error; 117864174e1SGreg Clayton bool success = false; 118864174e1SGreg Clayton char short_option = (char) m_getopt_table[option_idx].val; 119864174e1SGreg Clayton switch (short_option) 120864174e1SGreg Clayton { 121864174e1SGreg Clayton case 'r': 122864174e1SGreg Clayton relative_frame_offset = Args::StringToSInt32 (option_arg, INT32_MIN, 0, &success); 123864174e1SGreg Clayton if (!success) 124864174e1SGreg Clayton error.SetErrorStringWithFormat ("invalid frame offset argument '%s'.\n", option_arg); 125864174e1SGreg Clayton break; 126864174e1SGreg Clayton 127864174e1SGreg Clayton default: 1282c88643aSBenjamin Kramer error.SetErrorStringWithFormat ("Invalid short option character '%c'.\n", short_option); 129864174e1SGreg Clayton break; 130864174e1SGreg Clayton } 131864174e1SGreg Clayton 132864174e1SGreg Clayton return error; 133864174e1SGreg Clayton } 134864174e1SGreg Clayton 135864174e1SGreg Clayton void 136864174e1SGreg Clayton ResetOptionValues () 137864174e1SGreg Clayton { 138864174e1SGreg Clayton Options::ResetOptionValues(); 139864174e1SGreg Clayton relative_frame_offset = INT32_MIN; 140864174e1SGreg Clayton } 141864174e1SGreg Clayton 142864174e1SGreg Clayton const lldb::OptionDefinition* 143864174e1SGreg Clayton GetDefinitions () 144864174e1SGreg Clayton { 145864174e1SGreg Clayton return g_option_table; 146864174e1SGreg Clayton } 147864174e1SGreg Clayton 148864174e1SGreg Clayton // Options table: Required for subclasses of Options. 149864174e1SGreg Clayton 150864174e1SGreg Clayton static lldb::OptionDefinition g_option_table[]; 151864174e1SGreg Clayton int32_t relative_frame_offset; 152864174e1SGreg Clayton }; 153864174e1SGreg Clayton 154a7015092SGreg Clayton CommandObjectFrameSelect (CommandInterpreter &interpreter) : 155a7015092SGreg Clayton CommandObject (interpreter, 156a7015092SGreg Clayton "frame select", 157e3d26315SCaroline Tice "Select a frame by index from within the current thread and make it the current frame.", 158405fe67fSCaroline Tice NULL, 15930fdc8d8SChris Lattner eFlagProcessMustBeLaunched | eFlagProcessMustBePaused) 16030fdc8d8SChris Lattner { 161405fe67fSCaroline Tice CommandArgumentEntry arg; 162405fe67fSCaroline Tice CommandArgumentData index_arg; 163405fe67fSCaroline Tice 164405fe67fSCaroline Tice // Define the first (and only) variant of this arg. 165405fe67fSCaroline Tice index_arg.arg_type = eArgTypeFrameIndex; 166864174e1SGreg Clayton index_arg.arg_repetition = eArgRepeatOptional; 167405fe67fSCaroline Tice 168405fe67fSCaroline Tice // There is only one variant this argument could be; put it into the argument entry. 169405fe67fSCaroline Tice arg.push_back (index_arg); 170405fe67fSCaroline Tice 171405fe67fSCaroline Tice // Push the data for the first argument into the m_arguments vector. 172405fe67fSCaroline Tice m_arguments.push_back (arg); 17330fdc8d8SChris Lattner } 17430fdc8d8SChris Lattner 17530fdc8d8SChris Lattner ~CommandObjectFrameSelect () 17630fdc8d8SChris Lattner { 17730fdc8d8SChris Lattner } 17830fdc8d8SChris Lattner 179864174e1SGreg Clayton virtual 180864174e1SGreg Clayton Options * 181864174e1SGreg Clayton GetOptions () 182864174e1SGreg Clayton { 183864174e1SGreg Clayton return &m_options; 184864174e1SGreg Clayton } 185864174e1SGreg Clayton 186864174e1SGreg Clayton 18730fdc8d8SChris Lattner bool 188a7015092SGreg Clayton Execute (Args& command, 18930fdc8d8SChris Lattner CommandReturnObject &result) 19030fdc8d8SChris Lattner { 191a7015092SGreg Clayton ExecutionContext exe_ctx (m_interpreter.GetDebugger().GetExecutionContext()); 19230fdc8d8SChris Lattner if (exe_ctx.thread) 19330fdc8d8SChris Lattner { 194864174e1SGreg Clayton const uint32_t num_frames = exe_ctx.thread->GetStackFrameCount(); 195864174e1SGreg Clayton uint32_t frame_idx = UINT32_MAX; 196864174e1SGreg Clayton if (m_options.relative_frame_offset != INT32_MIN) 197864174e1SGreg Clayton { 198864174e1SGreg Clayton // The one and only argument is a signed relative frame index 199864174e1SGreg Clayton frame_idx = exe_ctx.thread->GetSelectedFrameIndex (); 200864174e1SGreg Clayton if (frame_idx == UINT32_MAX) 201864174e1SGreg Clayton frame_idx = 0; 202864174e1SGreg Clayton 203864174e1SGreg Clayton if (m_options.relative_frame_offset < 0) 204864174e1SGreg Clayton { 205864174e1SGreg Clayton if (frame_idx >= -m_options.relative_frame_offset) 206864174e1SGreg Clayton frame_idx += m_options.relative_frame_offset; 207864174e1SGreg Clayton else 208864174e1SGreg Clayton frame_idx = 0; 209864174e1SGreg Clayton } 210864174e1SGreg Clayton else if (m_options.relative_frame_offset > 0) 211864174e1SGreg Clayton { 212864174e1SGreg Clayton if (num_frames - frame_idx > m_options.relative_frame_offset) 213864174e1SGreg Clayton frame_idx += m_options.relative_frame_offset; 214864174e1SGreg Clayton else 215864174e1SGreg Clayton frame_idx = num_frames - 1; 216864174e1SGreg Clayton } 217864174e1SGreg Clayton } 218864174e1SGreg Clayton else 219864174e1SGreg Clayton { 22030fdc8d8SChris Lattner if (command.GetArgumentCount() == 1) 22130fdc8d8SChris Lattner { 22230fdc8d8SChris Lattner const char *frame_idx_cstr = command.GetArgumentAtIndex(0); 223864174e1SGreg Clayton frame_idx = Args::StringToUInt32 (frame_idx_cstr, UINT32_MAX, 0); 224864174e1SGreg Clayton } 225864174e1SGreg Clayton else 226864174e1SGreg Clayton { 227864174e1SGreg Clayton result.AppendError ("invalid arguments.\n"); 228864174e1SGreg Clayton m_options.GenerateOptionUsage (m_interpreter, result.GetErrorStream(), this); 229864174e1SGreg Clayton } 230864174e1SGreg Clayton } 23130fdc8d8SChris Lattner 23230fdc8d8SChris Lattner if (frame_idx < num_frames) 23330fdc8d8SChris Lattner { 2342976d00aSJim Ingham exe_ctx.thread->SetSelectedFrameByIndex (frame_idx); 2352976d00aSJim Ingham exe_ctx.frame = exe_ctx.thread->GetSelectedFrame ().get(); 23630fdc8d8SChris Lattner 23730fdc8d8SChris Lattner if (exe_ctx.frame) 23830fdc8d8SChris Lattner { 239e40e4218SJim Ingham bool already_shown = false; 240e40e4218SJim Ingham SymbolContext frame_sc(exe_ctx.frame->GetSymbolContext(eSymbolContextLineEntry)); 241daccaa9eSCaroline Tice if (m_interpreter.GetDebugger().GetUseExternalEditor() && frame_sc.line_entry.file && frame_sc.line_entry.line != 0) 242e40e4218SJim Ingham { 243e40e4218SJim Ingham already_shown = Host::OpenFileInExternalEditor (frame_sc.line_entry.file, frame_sc.line_entry.line); 244e40e4218SJim Ingham } 245e40e4218SJim Ingham 24630fdc8d8SChris Lattner if (DisplayFrameForExecutionContext (exe_ctx.thread, 24730fdc8d8SChris Lattner exe_ctx.frame, 248a7015092SGreg Clayton m_interpreter, 24930fdc8d8SChris Lattner result.GetOutputStream(), 25030fdc8d8SChris Lattner true, 251e40e4218SJim Ingham !already_shown, 25230fdc8d8SChris Lattner 3, 25330fdc8d8SChris Lattner 3)) 25430fdc8d8SChris Lattner { 25530fdc8d8SChris Lattner result.SetStatus (eReturnStatusSuccessFinishResult); 25630fdc8d8SChris Lattner return result.Succeeded(); 25730fdc8d8SChris Lattner } 25830fdc8d8SChris Lattner } 25930fdc8d8SChris Lattner } 26030fdc8d8SChris Lattner result.AppendErrorWithFormat ("Frame index (%u) out of range.\n", frame_idx); 26130fdc8d8SChris Lattner } 26230fdc8d8SChris Lattner else 26330fdc8d8SChris Lattner { 26430fdc8d8SChris Lattner result.AppendError ("no current thread"); 26530fdc8d8SChris Lattner } 26630fdc8d8SChris Lattner result.SetStatus (eReturnStatusFailed); 26730fdc8d8SChris Lattner return false; 26830fdc8d8SChris Lattner } 269864174e1SGreg Clayton protected: 270864174e1SGreg Clayton 271864174e1SGreg Clayton CommandOptions m_options; 272864174e1SGreg Clayton }; 273864174e1SGreg Clayton 274864174e1SGreg Clayton lldb::OptionDefinition 275864174e1SGreg Clayton CommandObjectFrameSelect::CommandOptions::g_option_table[] = 276864174e1SGreg Clayton { 277864174e1SGreg Clayton { LLDB_OPT_SET_1, false, "relative", 'r', required_argument, NULL, 0, eArgTypeOffset, "A relative frame index offset from the current frame index."}, 278864174e1SGreg Clayton { 0, false, NULL, 0, 0, NULL, NULL, eArgTypeNone, NULL } 27930fdc8d8SChris Lattner }; 28030fdc8d8SChris Lattner 2816d56d2ceSJim Ingham #pragma mark CommandObjectFrameVariable 2826d56d2ceSJim Ingham //---------------------------------------------------------------------- 2836d56d2ceSJim Ingham // List images with associated information 2846d56d2ceSJim Ingham //---------------------------------------------------------------------- 2856d56d2ceSJim Ingham class CommandObjectFrameVariable : public CommandObject 2866d56d2ceSJim Ingham { 2876d56d2ceSJim Ingham public: 2886d56d2ceSJim Ingham 2896d56d2ceSJim Ingham class CommandOptions : public Options 2906d56d2ceSJim Ingham { 2916d56d2ceSJim Ingham public: 2926d56d2ceSJim Ingham 2936d56d2ceSJim Ingham CommandOptions () : 2946d56d2ceSJim Ingham Options() 2956d56d2ceSJim Ingham { 2966d56d2ceSJim Ingham ResetOptionValues (); 2976d56d2ceSJim Ingham } 2986d56d2ceSJim Ingham 2996d56d2ceSJim Ingham virtual 3006d56d2ceSJim Ingham ~CommandOptions () 3016d56d2ceSJim Ingham { 3026d56d2ceSJim Ingham } 3036d56d2ceSJim Ingham 3046d56d2ceSJim Ingham virtual Error 3056d56d2ceSJim Ingham SetOptionValue (int option_idx, const char *option_arg) 3066d56d2ceSJim Ingham { 3076d56d2ceSJim Ingham Error error; 3086d56d2ceSJim Ingham bool success; 3096d56d2ceSJim Ingham char short_option = (char) m_getopt_table[option_idx].val; 3106d56d2ceSJim Ingham switch (short_option) 3116d56d2ceSJim Ingham { 3126d56d2ceSJim Ingham case 'o': use_objc = true; break; 3136d56d2ceSJim Ingham case 'r': use_regex = true; break; 3146d56d2ceSJim Ingham case 'a': show_args = false; break; 3156d56d2ceSJim Ingham case 'l': show_locals = false; break; 316a134cc1bSGreg Clayton case 'g': show_globals = true; break; 317b6e8cf96SGreg Clayton case 't': show_types = true; break; 3186d56d2ceSJim Ingham case 'y': show_summary = false; break; 3196d56d2ceSJim Ingham case 'L': show_location= true; break; 320a134cc1bSGreg Clayton case 'c': show_decl = true; break; 3216d56d2ceSJim Ingham case 'D': debug = true; break; 322*ded470d3SGreg Clayton case 'f': error = Args::StringToFormat(option_arg, format); break; 323*ded470d3SGreg Clayton case 'F': flat_output = true; break; 3246d56d2ceSJim Ingham case 'd': 3256d56d2ceSJim Ingham max_depth = Args::StringToUInt32 (option_arg, UINT32_MAX, 0, &success); 3266d56d2ceSJim Ingham if (!success) 3276d56d2ceSJim Ingham error.SetErrorStringWithFormat("Invalid max depth '%s'.\n", option_arg); 3286d56d2ceSJim Ingham break; 3296d56d2ceSJim Ingham 3306d56d2ceSJim Ingham case 'p': 3316d56d2ceSJim Ingham ptr_depth = Args::StringToUInt32 (option_arg, 0, 0, &success); 3326d56d2ceSJim Ingham if (!success) 3336d56d2ceSJim Ingham error.SetErrorStringWithFormat("Invalid pointer depth '%s'.\n", option_arg); 3346d56d2ceSJim Ingham break; 3356d56d2ceSJim Ingham 3366d56d2ceSJim Ingham case 'G': 337a134cc1bSGreg Clayton globals.push_back(ConstString (option_arg)); 3386d56d2ceSJim Ingham break; 3396d56d2ceSJim Ingham 3406d56d2ceSJim Ingham case 's': 3416d56d2ceSJim Ingham show_scope = true; 3426d56d2ceSJim Ingham break; 3436d56d2ceSJim Ingham 3446d56d2ceSJim Ingham default: 3456d56d2ceSJim Ingham error.SetErrorStringWithFormat("Invalid short option character '%c'.\n", short_option); 3466d56d2ceSJim Ingham break; 3476d56d2ceSJim Ingham } 3486d56d2ceSJim Ingham 3496d56d2ceSJim Ingham return error; 3506d56d2ceSJim Ingham } 3516d56d2ceSJim Ingham 3526d56d2ceSJim Ingham void 3536d56d2ceSJim Ingham ResetOptionValues () 3546d56d2ceSJim Ingham { 3556d56d2ceSJim Ingham Options::ResetOptionValues(); 3566d56d2ceSJim Ingham 3576d56d2ceSJim Ingham use_objc = false; 3586d56d2ceSJim Ingham use_regex = false; 3596d56d2ceSJim Ingham show_args = true; 3606d56d2ceSJim Ingham show_locals = true; 361a134cc1bSGreg Clayton show_globals = false; 362b6e8cf96SGreg Clayton show_types = false; 3636d56d2ceSJim Ingham show_scope = false; 3646d56d2ceSJim Ingham show_summary = true; 3656d56d2ceSJim Ingham show_location = false; 366a134cc1bSGreg Clayton show_decl = false; 3676d56d2ceSJim Ingham debug = false; 3688f92f0a3SGreg Clayton flat_output = false; 3696d56d2ceSJim Ingham max_depth = UINT32_MAX; 3706d56d2ceSJim Ingham ptr_depth = 0; 371*ded470d3SGreg Clayton format = eFormatDefault; 3726d56d2ceSJim Ingham globals.clear(); 3736d56d2ceSJim Ingham } 3746d56d2ceSJim Ingham 3756d56d2ceSJim Ingham const lldb::OptionDefinition* 3766d56d2ceSJim Ingham GetDefinitions () 3776d56d2ceSJim Ingham { 3786d56d2ceSJim Ingham return g_option_table; 3796d56d2ceSJim Ingham } 3806d56d2ceSJim Ingham 3816d56d2ceSJim Ingham // Options table: Required for subclasses of Options. 3826d56d2ceSJim Ingham 3836d56d2ceSJim Ingham static lldb::OptionDefinition g_option_table[]; 384a134cc1bSGreg Clayton bool use_objc:1, 385a134cc1bSGreg Clayton use_regex:1, 386a134cc1bSGreg Clayton show_args:1, 387a134cc1bSGreg Clayton show_locals:1, 388a134cc1bSGreg Clayton show_globals:1, 389a134cc1bSGreg Clayton show_types:1, 390a134cc1bSGreg Clayton show_scope:1, 391a134cc1bSGreg Clayton show_summary:1, 392a134cc1bSGreg Clayton show_location:1, 393a134cc1bSGreg Clayton show_decl:1, 3948f92f0a3SGreg Clayton debug:1, 3958f92f0a3SGreg Clayton flat_output:1; 3966d56d2ceSJim Ingham uint32_t max_depth; // The depth to print when dumping concrete (not pointers) aggreate values 3976d56d2ceSJim Ingham uint32_t ptr_depth; // The default depth that is dumped when we find pointers 398*ded470d3SGreg Clayton lldb::Format format; // The format to use when dumping variables or children of variables 3996d56d2ceSJim Ingham std::vector<ConstString> globals; 4006d56d2ceSJim Ingham // Instance variables to hold the values for command options. 4016d56d2ceSJim Ingham }; 4026d56d2ceSJim Ingham 403a7015092SGreg Clayton CommandObjectFrameVariable (CommandInterpreter &interpreter) : 404a7015092SGreg Clayton CommandObject (interpreter, 4056d56d2ceSJim Ingham "frame variable", 406ed8a705cSGreg Clayton "Show frame variables. All argument and local variables " 407ed8a705cSGreg Clayton "that are in scope will be shown when no arguments are given. " 408ed8a705cSGreg Clayton "If any arguments are specified, they can be names of " 409ed8a705cSGreg Clayton "argument, local, file static and file global variables. " 410ed8a705cSGreg Clayton "Children of aggregate variables can be specified such as " 411ed8a705cSGreg Clayton "'var->child.x'.", 412ff471a94SJim Ingham NULL, 413ff471a94SJim Ingham eFlagProcessMustBeLaunched | eFlagProcessMustBePaused) 4146d56d2ceSJim Ingham { 415405fe67fSCaroline Tice CommandArgumentEntry arg; 416405fe67fSCaroline Tice CommandArgumentData var_name_arg; 417405fe67fSCaroline Tice 418405fe67fSCaroline Tice // Define the first (and only) variant of this arg. 419405fe67fSCaroline Tice var_name_arg.arg_type = eArgTypeVarName; 420405fe67fSCaroline Tice var_name_arg.arg_repetition = eArgRepeatStar; 421405fe67fSCaroline Tice 422405fe67fSCaroline Tice // There is only one variant this argument could be; put it into the argument entry. 423405fe67fSCaroline Tice arg.push_back (var_name_arg); 424405fe67fSCaroline Tice 425405fe67fSCaroline Tice // Push the data for the first argument into the m_arguments vector. 426405fe67fSCaroline Tice m_arguments.push_back (arg); 4276d56d2ceSJim Ingham } 4286d56d2ceSJim Ingham 4296d56d2ceSJim Ingham virtual 4306d56d2ceSJim Ingham ~CommandObjectFrameVariable () 4316d56d2ceSJim Ingham { 4326d56d2ceSJim Ingham } 4336d56d2ceSJim Ingham 4346d56d2ceSJim Ingham virtual 4356d56d2ceSJim Ingham Options * 4366d56d2ceSJim Ingham GetOptions () 4376d56d2ceSJim Ingham { 4386d56d2ceSJim Ingham return &m_options; 4396d56d2ceSJim Ingham } 4406d56d2ceSJim Ingham 4416d56d2ceSJim Ingham 4426d56d2ceSJim Ingham virtual bool 4436d56d2ceSJim Ingham Execute 4446d56d2ceSJim Ingham ( 4456d56d2ceSJim Ingham Args& command, 4466d56d2ceSJim Ingham CommandReturnObject &result 4476d56d2ceSJim Ingham ) 4486d56d2ceSJim Ingham { 449a7015092SGreg Clayton ExecutionContext exe_ctx(m_interpreter.GetDebugger().GetExecutionContext()); 4506d56d2ceSJim Ingham if (exe_ctx.frame == NULL) 4516d56d2ceSJim Ingham { 452340b2baaSGreg Clayton result.AppendError ("you must be stopped in a valid stack frame to view frame variables."); 4536d56d2ceSJim Ingham result.SetStatus (eReturnStatusFailed); 4546d56d2ceSJim Ingham return false; 4556d56d2ceSJim Ingham } 4566d56d2ceSJim Ingham else 4576d56d2ceSJim Ingham { 458a134cc1bSGreg Clayton Stream &s = result.GetOutputStream(); 4596d56d2ceSJim Ingham 460a134cc1bSGreg Clayton bool get_file_globals = true; 461a134cc1bSGreg Clayton VariableList *variable_list = exe_ctx.frame->GetVariableList (get_file_globals); 462a134cc1bSGreg Clayton 4636d56d2ceSJim Ingham VariableSP var_sp; 4646d56d2ceSJim Ingham ValueObjectSP valobj_sp; 4656d56d2ceSJim Ingham //ValueObjectList &valobj_list = exe_ctx.frame->GetValueObjectList(); 4666d56d2ceSJim Ingham const char *name_cstr = NULL; 4676d56d2ceSJim Ingham size_t idx; 4686d56d2ceSJim Ingham if (!m_options.globals.empty()) 4696d56d2ceSJim Ingham { 4706d56d2ceSJim Ingham uint32_t fail_count = 0; 4716d56d2ceSJim Ingham if (exe_ctx.target) 4726d56d2ceSJim Ingham { 4736d56d2ceSJim Ingham const size_t num_globals = m_options.globals.size(); 4746d56d2ceSJim Ingham for (idx = 0; idx < num_globals; ++idx) 4756d56d2ceSJim Ingham { 4766d56d2ceSJim Ingham VariableList global_var_list; 4776d56d2ceSJim Ingham const uint32_t num_matching_globals = exe_ctx.target->GetImages().FindGlobalVariables (m_options.globals[idx], true, UINT32_MAX, global_var_list); 4786d56d2ceSJim Ingham 4796d56d2ceSJim Ingham if (num_matching_globals == 0) 4806d56d2ceSJim Ingham { 4816d56d2ceSJim Ingham ++fail_count; 4826d56d2ceSJim Ingham result.GetErrorStream().Printf ("error: can't find global variable '%s'\n", m_options.globals[idx].AsCString()); 4836d56d2ceSJim Ingham } 4846d56d2ceSJim Ingham else 4856d56d2ceSJim Ingham { 4866d56d2ceSJim Ingham for (uint32_t global_idx=0; global_idx<num_matching_globals; ++global_idx) 4876d56d2ceSJim Ingham { 4886d56d2ceSJim Ingham var_sp = global_var_list.GetVariableAtIndex(global_idx); 4896d56d2ceSJim Ingham if (var_sp) 4906d56d2ceSJim Ingham { 491288bdf9cSGreg Clayton valobj_sp = exe_ctx.frame->GetValueObjectForFrameVariable (var_sp); 4926d56d2ceSJim Ingham if (!valobj_sp) 493288bdf9cSGreg Clayton valobj_sp = exe_ctx.frame->TrackGlobalVariable (var_sp); 4946d56d2ceSJim Ingham 4956d56d2ceSJim Ingham if (valobj_sp) 4966d56d2ceSJim Ingham { 497*ded470d3SGreg Clayton if (m_options.format != eFormatDefault) 498*ded470d3SGreg Clayton valobj_sp->SetFormat (m_options.format); 499*ded470d3SGreg Clayton 500a134cc1bSGreg Clayton if (m_options.show_decl && var_sp->GetDeclaration ().GetFile()) 501a134cc1bSGreg Clayton { 5026f00abd5SGreg Clayton var_sp->GetDeclaration ().DumpStopContext (&s, false); 5036f00abd5SGreg Clayton s.PutCString (": "); 504a134cc1bSGreg Clayton } 505a134cc1bSGreg Clayton 5061d3afba3SGreg Clayton ValueObject::DumpValueObject (result.GetOutputStream(), 5076f00abd5SGreg Clayton exe_ctx.frame, 5086f00abd5SGreg Clayton valobj_sp.get(), 5096f00abd5SGreg Clayton name_cstr, 5106f00abd5SGreg Clayton m_options.ptr_depth, 5116f00abd5SGreg Clayton 0, 5126f00abd5SGreg Clayton m_options.max_depth, 5131d3afba3SGreg Clayton m_options.show_types, 5141d3afba3SGreg Clayton m_options.show_location, 5156f00abd5SGreg Clayton m_options.use_objc, 5168f92f0a3SGreg Clayton false, 5178f92f0a3SGreg Clayton m_options.flat_output); 5186d56d2ceSJim Ingham } 5196d56d2ceSJim Ingham } 5206d56d2ceSJim Ingham } 5216d56d2ceSJim Ingham } 5226d56d2ceSJim Ingham } 5236d56d2ceSJim Ingham } 5246d56d2ceSJim Ingham if (fail_count) 5256d56d2ceSJim Ingham result.SetStatus (eReturnStatusFailed); 5266d56d2ceSJim Ingham } 5279df87c17SGreg Clayton else if (variable_list) 5289df87c17SGreg Clayton { 5299df87c17SGreg Clayton if (command.GetArgumentCount() > 0) 5306d56d2ceSJim Ingham { 53146747022SGreg Clayton VariableList regex_var_list; 53246747022SGreg Clayton 5336d56d2ceSJim Ingham // If we have any args to the variable command, we will make 5346d56d2ceSJim Ingham // variable objects from them... 5356d56d2ceSJim Ingham for (idx = 0; (name_cstr = command.GetArgumentAtIndex(idx)) != NULL; ++idx) 5366d56d2ceSJim Ingham { 5376d56d2ceSJim Ingham uint32_t ptr_depth = m_options.ptr_depth; 53846747022SGreg Clayton 53946747022SGreg Clayton if (m_options.use_regex) 54046747022SGreg Clayton { 54146747022SGreg Clayton const uint32_t regex_start_index = regex_var_list.GetSize(); 54246747022SGreg Clayton RegularExpression regex (name_cstr); 54346747022SGreg Clayton if (regex.Compile(name_cstr)) 54446747022SGreg Clayton { 54546747022SGreg Clayton size_t num_matches = 0; 54646747022SGreg Clayton const size_t num_new_regex_vars = variable_list->AppendVariablesIfUnique(regex, regex_var_list, num_matches); 54746747022SGreg Clayton if (num_new_regex_vars > 0) 54846747022SGreg Clayton { 54946747022SGreg Clayton for (uint32_t regex_idx = regex_start_index, end_index = regex_var_list.GetSize(); 55046747022SGreg Clayton regex_idx < end_index; 55146747022SGreg Clayton ++regex_idx) 55246747022SGreg Clayton { 55346747022SGreg Clayton var_sp = regex_var_list.GetVariableAtIndex (regex_idx); 55446747022SGreg Clayton if (var_sp) 55546747022SGreg Clayton { 55646747022SGreg Clayton valobj_sp = exe_ctx.frame->GetValueObjectForFrameVariable (var_sp); 55746747022SGreg Clayton if (valobj_sp) 55846747022SGreg Clayton { 559*ded470d3SGreg Clayton if (m_options.format != eFormatDefault) 560*ded470d3SGreg Clayton valobj_sp->SetFormat (m_options.format); 561*ded470d3SGreg Clayton 56246747022SGreg Clayton if (m_options.show_decl && var_sp->GetDeclaration ().GetFile()) 56346747022SGreg Clayton { 56446747022SGreg Clayton var_sp->GetDeclaration ().DumpStopContext (&s, false); 56546747022SGreg Clayton s.PutCString (": "); 56646747022SGreg Clayton } 56746747022SGreg Clayton 56846747022SGreg Clayton ValueObject::DumpValueObject (result.GetOutputStream(), 56946747022SGreg Clayton exe_ctx.frame, 57046747022SGreg Clayton valobj_sp.get(), 57146747022SGreg Clayton var_sp->GetName().AsCString(), 57246747022SGreg Clayton m_options.ptr_depth, 57346747022SGreg Clayton 0, 57446747022SGreg Clayton m_options.max_depth, 57546747022SGreg Clayton m_options.show_types, 57646747022SGreg Clayton m_options.show_location, 57746747022SGreg Clayton m_options.use_objc, 5788f92f0a3SGreg Clayton false, 5798f92f0a3SGreg Clayton m_options.flat_output); 58046747022SGreg Clayton } 58146747022SGreg Clayton } 58246747022SGreg Clayton } 58346747022SGreg Clayton } 58446747022SGreg Clayton else if (num_matches == 0) 58546747022SGreg Clayton { 58646747022SGreg Clayton result.GetErrorStream().Printf ("error: no variables matched the regular expression '%s'.\n", name_cstr); 58746747022SGreg Clayton } 58846747022SGreg Clayton } 58946747022SGreg Clayton else 59046747022SGreg Clayton { 59146747022SGreg Clayton char regex_error[1024]; 59246747022SGreg Clayton if (regex.GetErrorAsCString(regex_error, sizeof(regex_error))) 59346747022SGreg Clayton result.GetErrorStream().Printf ("error: %s\n", regex_error); 59446747022SGreg Clayton else 59546747022SGreg Clayton result.GetErrorStream().Printf ("error: unkown regex error when compiling '%s'\n", name_cstr); 59646747022SGreg Clayton } 59746747022SGreg Clayton } 59846747022SGreg Clayton else 59946747022SGreg Clayton { 60054979cddSGreg Clayton Error error; 6016d5e68eaSGreg Clayton const uint32_t expr_path_options = StackFrame::eExpressionPathOptionCheckPtrVsMember; 6026d5e68eaSGreg Clayton valobj_sp = exe_ctx.frame->GetValueForVariableExpressionPath (name_cstr, expr_path_options, error); 6036d56d2ceSJim Ingham if (valobj_sp) 6046d56d2ceSJim Ingham { 605*ded470d3SGreg Clayton if (m_options.format != eFormatDefault) 606*ded470d3SGreg Clayton valobj_sp->SetFormat (m_options.format); 607*ded470d3SGreg Clayton 608a134cc1bSGreg Clayton if (m_options.show_decl && var_sp->GetDeclaration ().GetFile()) 609a134cc1bSGreg Clayton { 610a134cc1bSGreg Clayton var_sp->GetDeclaration ().DumpStopContext (&s, false); 611a134cc1bSGreg Clayton s.PutCString (": "); 612a134cc1bSGreg Clayton } 6131d3afba3SGreg Clayton ValueObject::DumpValueObject (result.GetOutputStream(), 614a134cc1bSGreg Clayton exe_ctx.frame, 615a134cc1bSGreg Clayton valobj_sp.get(), 61683c5cd9dSGreg Clayton valobj_sp->GetParent() ? name_cstr : NULL, 617a134cc1bSGreg Clayton ptr_depth, 618a134cc1bSGreg Clayton 0, 619a134cc1bSGreg Clayton m_options.max_depth, 6201d3afba3SGreg Clayton m_options.show_types, 6211d3afba3SGreg Clayton m_options.show_location, 6226f00abd5SGreg Clayton m_options.use_objc, 6238f92f0a3SGreg Clayton false, 6248f92f0a3SGreg Clayton m_options.flat_output); 6256d56d2ceSJim Ingham } 6266d56d2ceSJim Ingham else 6276d56d2ceSJim Ingham { 62854979cddSGreg Clayton const char *error_cstr = error.AsCString(NULL); 62954979cddSGreg Clayton if (error_cstr) 63054979cddSGreg Clayton result.GetErrorStream().Printf("error: %s\n", error_cstr); 63154979cddSGreg Clayton else 63254979cddSGreg Clayton result.GetErrorStream().Printf ("error: unable to find any variable expression path that matches '%s'\n", name_cstr); 6336d56d2ceSJim Ingham } 6346d56d2ceSJim Ingham } 6356d56d2ceSJim Ingham } 63646747022SGreg Clayton } 6376d56d2ceSJim Ingham else 6386d56d2ceSJim Ingham { 639a134cc1bSGreg Clayton const uint32_t num_variables = variable_list->GetSize(); 6406d56d2ceSJim Ingham 6416d56d2ceSJim Ingham if (num_variables > 0) 6426d56d2ceSJim Ingham { 6436d56d2ceSJim Ingham for (uint32_t i=0; i<num_variables; i++) 6446d56d2ceSJim Ingham { 6451a65ae11SGreg Clayton var_sp = variable_list->GetVariableAtIndex(i); 6466d56d2ceSJim Ingham bool dump_variable = true; 6476d56d2ceSJim Ingham 648a134cc1bSGreg Clayton switch (var_sp->GetScope()) 6496d56d2ceSJim Ingham { 6506d56d2ceSJim Ingham case eValueTypeVariableGlobal: 6516d56d2ceSJim Ingham dump_variable = m_options.show_globals; 6526d56d2ceSJim Ingham if (dump_variable && m_options.show_scope) 653a134cc1bSGreg Clayton s.PutCString("GLOBAL: "); 6546d56d2ceSJim Ingham break; 6556d56d2ceSJim Ingham 6566d56d2ceSJim Ingham case eValueTypeVariableStatic: 6576d56d2ceSJim Ingham dump_variable = m_options.show_globals; 6586d56d2ceSJim Ingham if (dump_variable && m_options.show_scope) 659a134cc1bSGreg Clayton s.PutCString("STATIC: "); 6606d56d2ceSJim Ingham break; 6616d56d2ceSJim Ingham 6626d56d2ceSJim Ingham case eValueTypeVariableArgument: 6636d56d2ceSJim Ingham dump_variable = m_options.show_args; 6646d56d2ceSJim Ingham if (dump_variable && m_options.show_scope) 665a134cc1bSGreg Clayton s.PutCString(" ARG: "); 6666d56d2ceSJim Ingham break; 6676d56d2ceSJim Ingham 6686d56d2ceSJim Ingham case eValueTypeVariableLocal: 6696d56d2ceSJim Ingham dump_variable = m_options.show_locals; 6706d56d2ceSJim Ingham if (dump_variable && m_options.show_scope) 671a134cc1bSGreg Clayton s.PutCString(" LOCAL: "); 6726d56d2ceSJim Ingham break; 6736d56d2ceSJim Ingham 6746d56d2ceSJim Ingham default: 6756d56d2ceSJim Ingham break; 6766d56d2ceSJim Ingham } 6776d56d2ceSJim Ingham 6786d56d2ceSJim Ingham if (dump_variable) 679a134cc1bSGreg Clayton { 680a134cc1bSGreg Clayton 681a134cc1bSGreg Clayton // Use the variable object code to make sure we are 682a134cc1bSGreg Clayton // using the same APIs as the the public API will be 683a134cc1bSGreg Clayton // using... 684a134cc1bSGreg Clayton valobj_sp = exe_ctx.frame->GetValueObjectForFrameVariable (var_sp); 685a134cc1bSGreg Clayton if (valobj_sp) 686a134cc1bSGreg Clayton { 687*ded470d3SGreg Clayton if (m_options.format != eFormatDefault) 688*ded470d3SGreg Clayton valobj_sp->SetFormat (m_options.format); 689*ded470d3SGreg Clayton 6906f00abd5SGreg Clayton // When dumping all variables, don't print any variables 6916f00abd5SGreg Clayton // that are not in scope to avoid extra unneeded output 6926f00abd5SGreg Clayton if (valobj_sp->IsInScope (exe_ctx.frame)) 6936f00abd5SGreg Clayton { 694a134cc1bSGreg Clayton if (m_options.show_decl && var_sp->GetDeclaration ().GetFile()) 695a134cc1bSGreg Clayton { 696a134cc1bSGreg Clayton var_sp->GetDeclaration ().DumpStopContext (&s, false); 697a134cc1bSGreg Clayton s.PutCString (": "); 698a134cc1bSGreg Clayton } 6991d3afba3SGreg Clayton ValueObject::DumpValueObject (result.GetOutputStream(), 700a134cc1bSGreg Clayton exe_ctx.frame, 701a134cc1bSGreg Clayton valobj_sp.get(), 702a134cc1bSGreg Clayton name_cstr, 703a134cc1bSGreg Clayton m_options.ptr_depth, 704a134cc1bSGreg Clayton 0, 705a134cc1bSGreg Clayton m_options.max_depth, 7061d3afba3SGreg Clayton m_options.show_types, 7071d3afba3SGreg Clayton m_options.show_location, 7086f00abd5SGreg Clayton m_options.use_objc, 7098f92f0a3SGreg Clayton false, 7108f92f0a3SGreg Clayton m_options.flat_output); 711a134cc1bSGreg Clayton } 712a134cc1bSGreg Clayton } 7136d56d2ceSJim Ingham } 7146d56d2ceSJim Ingham } 7156d56d2ceSJim Ingham } 7166f00abd5SGreg Clayton } 7176d56d2ceSJim Ingham result.SetStatus (eReturnStatusSuccessFinishResult); 7186d56d2ceSJim Ingham } 7199df87c17SGreg Clayton } 7206d56d2ceSJim Ingham return result.Succeeded(); 7216d56d2ceSJim Ingham } 7226d56d2ceSJim Ingham protected: 7236d56d2ceSJim Ingham 7246d56d2ceSJim Ingham CommandOptions m_options; 7256d56d2ceSJim Ingham }; 7266d56d2ceSJim Ingham 7276d56d2ceSJim Ingham lldb::OptionDefinition 7286d56d2ceSJim Ingham CommandObjectFrameVariable::CommandOptions::g_option_table[] = 7296d56d2ceSJim Ingham { 730deaab222SCaroline Tice { LLDB_OPT_SET_1, false, "debug", 'D', no_argument, NULL, 0, eArgTypeNone, "Enable verbose debug information."}, 731deaab222SCaroline Tice { LLDB_OPT_SET_1, false, "depth", 'd', required_argument, NULL, 0, eArgTypeCount, "Set the max recurse depth when dumping aggregate types (default is infinity)."}, 732deaab222SCaroline Tice { LLDB_OPT_SET_1, false, "show-globals",'g', no_argument, NULL, 0, eArgTypeNone, "Show the current frame source file global and static variables."}, 733deaab222SCaroline Tice { LLDB_OPT_SET_1, false, "find-global",'G', required_argument, NULL, 0, eArgTypeVarName, "Find a global variable by name (which might not be in the current stack frame source file)."}, 734deaab222SCaroline Tice { LLDB_OPT_SET_1, false, "location", 'L', no_argument, NULL, 0, eArgTypeNone, "Show variable location information."}, 735deaab222SCaroline Tice { LLDB_OPT_SET_1, false, "show-declaration", 'c', no_argument, NULL, 0, eArgTypeNone, "Show variable declaration information (source file and line where the variable was declared)."}, 736deaab222SCaroline Tice { LLDB_OPT_SET_1, false, "no-args", 'a', no_argument, NULL, 0, eArgTypeNone, "Omit function arguments."}, 737deaab222SCaroline Tice { LLDB_OPT_SET_1, false, "no-locals", 'l', no_argument, NULL, 0, eArgTypeNone, "Omit local variables."}, 738b6e8cf96SGreg Clayton { LLDB_OPT_SET_1, false, "show-types", 't', no_argument, NULL, 0, eArgTypeNone, "Show variable types when dumping values."}, 739deaab222SCaroline Tice { LLDB_OPT_SET_1, false, "no-summary", 'y', no_argument, NULL, 0, eArgTypeNone, "Omit summary information."}, 740deaab222SCaroline Tice { LLDB_OPT_SET_1, false, "scope", 's', no_argument, NULL, 0, eArgTypeNone, "Show variable scope (argument, local, global, static)."}, 741bcf1217eSGreg Clayton { LLDB_OPT_SET_1, false, "objc", 'o', no_argument, NULL, 0, eArgTypeNone, "When looking up a variable by name, print as an Objective-C object."}, 742deaab222SCaroline Tice { LLDB_OPT_SET_1, false, "ptr-depth", 'p', required_argument, NULL, 0, eArgTypeCount, "The number of pointers to be traversed when dumping values (default is zero)."}, 74346747022SGreg Clayton { LLDB_OPT_SET_1, false, "regex", 'r', no_argument, NULL, 0, eArgTypeRegularExpression, "The <variable-name> argument for name lookups are regular expressions."}, 744*ded470d3SGreg Clayton { LLDB_OPT_SET_1, false, "flat", 'F', no_argument, NULL, 0, eArgTypeNone, "Display results in a flat format that uses expression paths for each variable or member."}, 745*ded470d3SGreg Clayton { LLDB_OPT_SET_1, false, "format", 'f', required_argument, NULL, 0, eArgTypeExprFormat, "Specify the format that the variable output should use."}, 746deaab222SCaroline Tice { 0, false, NULL, 0, 0, NULL, NULL, eArgTypeNone, NULL } 7476d56d2ceSJim Ingham }; 74830fdc8d8SChris Lattner #pragma mark CommandObjectMultiwordFrame 74930fdc8d8SChris Lattner 75030fdc8d8SChris Lattner //------------------------------------------------------------------------- 75130fdc8d8SChris Lattner // CommandObjectMultiwordFrame 75230fdc8d8SChris Lattner //------------------------------------------------------------------------- 75330fdc8d8SChris Lattner 7546611103cSGreg Clayton CommandObjectMultiwordFrame::CommandObjectMultiwordFrame (CommandInterpreter &interpreter) : 755a7015092SGreg Clayton CommandObjectMultiword (interpreter, 756a7015092SGreg Clayton "frame", 75730fdc8d8SChris Lattner "A set of commands for operating on the current thread's frames.", 75830fdc8d8SChris Lattner "frame <subcommand> [<subcommand-options>]") 75930fdc8d8SChris Lattner { 760a7015092SGreg Clayton LoadSubCommand ("info", CommandObjectSP (new CommandObjectFrameInfo (interpreter))); 761a7015092SGreg Clayton LoadSubCommand ("select", CommandObjectSP (new CommandObjectFrameSelect (interpreter))); 762a7015092SGreg Clayton LoadSubCommand ("variable", CommandObjectSP (new CommandObjectFrameVariable (interpreter))); 76330fdc8d8SChris Lattner } 76430fdc8d8SChris Lattner 76530fdc8d8SChris Lattner CommandObjectMultiwordFrame::~CommandObjectMultiwordFrame () 76630fdc8d8SChris Lattner { 76730fdc8d8SChris Lattner } 76830fdc8d8SChris Lattner 769