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