2010-06-09 00:52:24 +08:00
//===-- CommandObjectFrame.cpp ----------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
// C Includes
// C++ Includes
2011-09-17 05:41:42 +08:00
# include <string>
2016-02-20 03:33:46 +08:00
2010-06-09 00:52:24 +08:00
// Other libraries and framework includes
// Project includes
2016-02-20 03:33:46 +08:00
# include "CommandObjectFrame.h"
2010-06-09 00:52:24 +08:00
# include "lldb/Core/Debugger.h"
2010-09-02 08:18:39 +08:00
# include "lldb/Core/Module.h"
# include "lldb/Core/StreamFile.h"
# include "lldb/Core/Value.h"
# include "lldb/Core/ValueObject.h"
# include "lldb/Core/ValueObjectVariable.h"
2013-01-29 07:47:25 +08:00
# include "lldb/DataFormatters/DataVisualization.h"
<rdar://problem/14393032>
DumpValueObject() 2.0
This checkin restores pre-Xcode5 functionality to the "po" (expr -O) command:
- expr now has a new --description-verbosity (-v) argument, which takes either compact or full as a value (-v is the same as -vfull)
When the full mode is on, "po" will show the extended output with type name, persistent variable name and value, as in
(lldb) expr -O -v -- foo
(id) $0 = 0x000000010010baf0 {
1 = 2;
2 = 3;
}
When -v is omitted, or -vcompact is passed, the Xcode5-style output will be shown, as in
(lldb) expr -O -- foo
{
1 = 2;
2 = 3;
}
- for a non-ObjectiveC object, LLDB will still try to retrieve a summary and/or value to display
(lldb) po 5
5
-v also works in this mode
(lldb) expr -O -vfull -- 5
(int) $4 = 5
On top of that, this is a major refactoring of the ValueObject printing code. The functionality is now factored into a ValueObjectPrinter class for easier maintenance in the future
DumpValueObject() was turned into an instance method ValueObject::Dump() which simply calls through to the printer code, Dump_Impl has been removed
Test case to follow
llvm-svn: 191694
2013-10-01 03:11:51 +08:00
# include "lldb/DataFormatters/ValueObjectPrinter.h"
2011-02-01 09:31:41 +08:00
# include "lldb/Host/Host.h"
2017-03-23 07:33:16 +08:00
# include "lldb/Host/OptionParser.h"
2010-09-02 08:18:39 +08:00
# include "lldb/Interpreter/Args.h"
2010-06-09 00:52:24 +08:00
# include "lldb/Interpreter/CommandInterpreter.h"
# include "lldb/Interpreter/CommandReturnObject.h"
2011-10-25 14:44:01 +08:00
# include "lldb/Interpreter/OptionGroupFormat.h"
2011-05-04 11:43:18 +08:00
# include "lldb/Interpreter/OptionGroupValueObjectDisplay.h"
2011-07-07 12:38:25 +08:00
# include "lldb/Interpreter/OptionGroupVariable.h"
2016-09-07 04:57:50 +08:00
# include "lldb/Interpreter/Options.h"
2010-09-02 08:18:39 +08:00
# include "lldb/Symbol/ClangASTContext.h"
2016-09-07 04:57:50 +08:00
# include "lldb/Symbol/CompilerType.h"
2015-10-01 07:12:22 +08:00
# include "lldb/Symbol/Function.h"
2010-09-02 08:18:39 +08:00
# include "lldb/Symbol/ObjectFile.h"
# include "lldb/Symbol/SymbolContext.h"
# include "lldb/Symbol/Type.h"
# include "lldb/Symbol/Variable.h"
# include "lldb/Symbol/VariableList.h"
2010-06-09 00:52:24 +08:00
# include "lldb/Target/Process.h"
2013-11-04 17:33:30 +08:00
# include "lldb/Target/StackFrame.h"
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
# include "lldb/Target/StopInfo.h"
2010-09-02 08:18:39 +08:00
# include "lldb/Target/Target.h"
2016-09-07 04:57:50 +08:00
# include "lldb/Target/Thread.h"
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
# include "lldb/Utility/LLDBAssert.h"
2017-02-03 05:39:50 +08:00
# include "lldb/Utility/StreamString.h"
2017-06-29 22:32:17 +08:00
# include "lldb/Utility/Timer.h"
2010-06-09 00:52:24 +08:00
using namespace lldb ;
using namespace lldb_private ;
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
# pragma mark CommandObjectFrameDiagnose
//-------------------------------------------------------------------------
// CommandObjectFrameInfo
//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
// CommandObjectFrameDiagnose
//-------------------------------------------------------------------------
Convert option tables to ArrayRefs.
This change is very mechanical. All it does is change the
signature of `Options::GetDefinitions()` and `OptionGroup::
GetDefinitions()` to return an `ArrayRef<OptionDefinition>`
instead of a `const OptionDefinition *`. In the case of the
former, it deletes the sentinel entry from every table, and
in the case of the latter, it removes the `GetNumDefinitions()`
method from the interface. These are no longer necessary as
`ArrayRef` carries its own length.
In the former case, iteration was done by using a sentinel
entry, so there was no knowledge of length. Because of this
the individual option tables were allowed to be defined below
the corresponding class (after all, only a pointer was needed).
Now, however, the length must be known at compile time to
construct the `ArrayRef`, and as a result it is necessary to
move every option table before its corresponding class. This
results in this CL looking very big, but in terms of substance
there is not much here.
Differential revision: https://reviews.llvm.org/D24834
llvm-svn: 282188
2016-09-23 04:22:55 +08:00
static OptionDefinition g_frame_diag_options [ ] = {
// clang-format off
{ LLDB_OPT_SET_1 , false , " register " , ' r ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeRegisterName , " A register to diagnose. " } ,
{ LLDB_OPT_SET_1 , false , " address " , ' a ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeAddress , " An address to diagnose. " } ,
{ LLDB_OPT_SET_1 , false , " offset " , ' o ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeOffset , " An optional offset. Requires --register. " }
// clang-format on
} ;
2016-09-07 04:57:50 +08:00
class CommandObjectFrameDiagnose : public CommandObjectParsed {
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
public :
2016-09-07 04:57:50 +08:00
class CommandOptions : public Options {
public :
CommandOptions ( ) : Options ( ) { OptionParsingStarting ( nullptr ) ; }
~ CommandOptions ( ) override = default ;
2017-05-12 12:51:55 +08:00
Status SetOptionValue ( uint32_t option_idx , llvm : : StringRef option_arg ,
ExecutionContext * execution_context ) override {
Status error ;
2016-09-07 04:57:50 +08:00
const int short_option = m_getopt_table [ option_idx ] . val ;
switch ( short_option ) {
case ' r ' :
reg = ConstString ( option_arg ) ;
break ;
case ' a ' : {
2016-11-13 00:56:47 +08:00
address . emplace ( ) ;
if ( option_arg . getAsInteger ( 0 , * address ) ) {
2016-09-07 04:57:50 +08:00
address . reset ( ) ;
error . SetErrorStringWithFormat ( " invalid address argument '%s' " ,
2016-11-13 00:56:47 +08:00
option_arg . str ( ) . c_str ( ) ) ;
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
}
2016-09-07 04:57:50 +08:00
} break ;
case ' o ' : {
2016-11-13 00:56:47 +08:00
offset . emplace ( ) ;
if ( option_arg . getAsInteger ( 0 , * offset ) ) {
2016-09-07 04:57:50 +08:00
offset . reset ( ) ;
error . SetErrorStringWithFormat ( " invalid offset argument '%s' " ,
2016-11-13 00:56:47 +08:00
option_arg . str ( ) . c_str ( ) ) ;
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
}
2016-09-07 04:57:50 +08:00
} break ;
default :
error . SetErrorStringWithFormat ( " invalid short option character '%c' " ,
short_option ) ;
break ;
}
return error ;
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
}
2016-09-07 04:57:50 +08:00
void OptionParsingStarting ( ExecutionContext * execution_context ) override {
address . reset ( ) ;
reg . reset ( ) ;
offset . reset ( ) ;
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
}
Convert option tables to ArrayRefs.
This change is very mechanical. All it does is change the
signature of `Options::GetDefinitions()` and `OptionGroup::
GetDefinitions()` to return an `ArrayRef<OptionDefinition>`
instead of a `const OptionDefinition *`. In the case of the
former, it deletes the sentinel entry from every table, and
in the case of the latter, it removes the `GetNumDefinitions()`
method from the interface. These are no longer necessary as
`ArrayRef` carries its own length.
In the former case, iteration was done by using a sentinel
entry, so there was no knowledge of length. Because of this
the individual option tables were allowed to be defined below
the corresponding class (after all, only a pointer was needed).
Now, however, the length must be known at compile time to
construct the `ArrayRef`, and as a result it is necessary to
move every option table before its corresponding class. This
results in this CL looking very big, but in terms of substance
there is not much here.
Differential revision: https://reviews.llvm.org/D24834
llvm-svn: 282188
2016-09-23 04:22:55 +08:00
llvm : : ArrayRef < OptionDefinition > GetDefinitions ( ) override {
2016-09-23 05:06:13 +08:00
return llvm : : makeArrayRef ( g_frame_diag_options ) ;
Convert option tables to ArrayRefs.
This change is very mechanical. All it does is change the
signature of `Options::GetDefinitions()` and `OptionGroup::
GetDefinitions()` to return an `ArrayRef<OptionDefinition>`
instead of a `const OptionDefinition *`. In the case of the
former, it deletes the sentinel entry from every table, and
in the case of the latter, it removes the `GetNumDefinitions()`
method from the interface. These are no longer necessary as
`ArrayRef` carries its own length.
In the former case, iteration was done by using a sentinel
entry, so there was no knowledge of length. Because of this
the individual option tables were allowed to be defined below
the corresponding class (after all, only a pointer was needed).
Now, however, the length must be known at compile time to
construct the `ArrayRef`, and as a result it is necessary to
move every option table before its corresponding class. This
results in this CL looking very big, but in terms of substance
there is not much here.
Differential revision: https://reviews.llvm.org/D24834
llvm-svn: 282188
2016-09-23 04:22:55 +08:00
}
2016-09-07 04:57:50 +08:00
// Options.
llvm : : Optional < lldb : : addr_t > address ;
llvm : : Optional < ConstString > reg ;
llvm : : Optional < int64_t > offset ;
} ;
CommandObjectFrameDiagnose ( CommandInterpreter & interpreter )
: CommandObjectParsed ( interpreter , " frame diagnose " ,
" Try to determine what path path the current stop "
" location used to get to a register or address " ,
nullptr ,
eCommandRequiresThread | eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched |
eCommandProcessMustBePaused ) ,
m_options ( ) {
CommandArgumentEntry arg ;
CommandArgumentData index_arg ;
// Define the first (and only) variant of this arg.
index_arg . arg_type = eArgTypeFrameIndex ;
index_arg . arg_repetition = eArgRepeatOptional ;
// There is only one variant this argument could be; put it into the
// argument entry.
arg . push_back ( index_arg ) ;
// Push the data for the first argument into the m_arguments vector.
m_arguments . push_back ( arg ) ;
}
~ CommandObjectFrameDiagnose ( ) override = default ;
Options * GetOptions ( ) override { return & m_options ; }
protected :
bool DoExecute ( Args & command , CommandReturnObject & result ) override {
Thread * thread = m_exe_ctx . GetThreadPtr ( ) ;
StackFrameSP frame_sp = thread - > GetSelectedFrame ( ) ;
ValueObjectSP valobj_sp ;
if ( m_options . address . hasValue ( ) ) {
if ( m_options . reg . hasValue ( ) | | m_options . offset . hasValue ( ) ) {
result . AppendError (
" `frame diagnose --address` is incompatible with other arguments. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
valobj_sp = frame_sp - > GuessValueForAddress ( m_options . address . getValue ( ) ) ;
} else if ( m_options . reg . hasValue ( ) ) {
valobj_sp = frame_sp - > GuessValueForRegisterAndOffset (
m_options . reg . getValue ( ) , m_options . offset . getValueOr ( 0 ) ) ;
} else {
StopInfoSP stop_info_sp = thread - > GetStopInfo ( ) ;
if ( ! stop_info_sp ) {
result . AppendError ( " No arguments provided, and no stop info. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
valobj_sp = StopInfo : : GetCrashingDereference ( stop_info_sp ) ;
}
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
2016-09-07 04:57:50 +08:00
if ( ! valobj_sp ) {
result . AppendError ( " No diagnosis available. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
}
2016-09-07 04:57:50 +08:00
2017-03-02 08:05:25 +08:00
DumpValueObjectOptions : : DeclPrintingHelper helper = [ & valobj_sp ] (
ConstString type , ConstString var , const DumpValueObjectOptions & opts ,
Stream & stream ) - > bool {
2016-09-07 04:57:50 +08:00
const ValueObject : : GetExpressionPathFormat format = ValueObject : :
GetExpressionPathFormat : : eGetExpressionPathFormatHonorPointers ;
2017-03-02 18:35:53 +08:00
const bool qualify_cxx_base_classes = false ;
2016-09-07 04:57:50 +08:00
valobj_sp - > GetExpressionPath ( stream , qualify_cxx_base_classes , format ) ;
stream . PutCString ( " = " ) ;
return true ;
} ;
DumpValueObjectOptions options ;
options . SetDeclPrintingHelper ( helper ) ;
ValueObjectPrinter printer ( valobj_sp . get ( ) , & result . GetOutputStream ( ) ,
options ) ;
printer . PrintValueObject ( ) ;
return true ;
}
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
protected :
2016-09-07 04:57:50 +08:00
CommandOptions m_options ;
Added the "frame diagnose" command and use its output to make crash info better.
When a process stops due to a crash, we get the crashing instruction and the
crashing memory location (if there is one). From the user's perspective it is
often unclear what the reason for the crash is in a symbolic sense.
To address this, I have added new fuctionality to StackFrame to parse the
disassembly and reconstruct the sequence of dereferneces and offsets that were
applied to a known variable (or fuction retrn value) to obtain the invalid
pointer.
This makes use of enhancements in the disassembler, as well as new information
provided by the DWARF expression infrastructure, and is exposed through a
"frame diagnose" command. It is also used to provide symbolic information, when
available, in the event of a crash.
The algorithm is very rudimentary, and it needs a bunch of work, including
- better parsing for assembly, preferably with help from LLVM
- support for non-Apple platforms
- cleanup of the algorithm core, preferably to make it all work in terms of
Operands instead of register/offset pairs
- improvement of the GetExpressioPath() logic to make prettier expression
paths, and
- better handling of vtables.
I welcome all suggestios, improvements, and testcases.
llvm-svn: 280692
2016-09-06 12:48:36 +08:00
} ;
2010-06-09 00:52:24 +08:00
# pragma mark CommandObjectFrameInfo
//-------------------------------------------------------------------------
// CommandObjectFrameInfo
//-------------------------------------------------------------------------
2016-09-07 04:57:50 +08:00
class CommandObjectFrameInfo : public CommandObjectParsed {
2010-06-09 00:52:24 +08:00
public :
2016-09-07 04:57:50 +08:00
CommandObjectFrameInfo ( CommandInterpreter & interpreter )
: CommandObjectParsed (
interpreter , " frame info " , " List information about the current "
" stack frame in the current thread. " ,
" frame info " ,
eCommandRequiresFrame | eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched | eCommandProcessMustBePaused ) { }
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
~ CommandObjectFrameInfo ( ) override = default ;
2010-06-09 00:52:24 +08:00
2012-06-09 05:56:10 +08:00
protected :
2016-09-07 04:57:50 +08:00
bool DoExecute ( Args & command , CommandReturnObject & result ) override {
m_exe_ctx . GetFrameRef ( ) . DumpUsingSettingsFormat ( & result . GetOutputStream ( ) ) ;
result . SetStatus ( eReturnStatusSuccessFinishResult ) ;
return result . Succeeded ( ) ;
}
2010-06-09 00:52:24 +08:00
} ;
# pragma mark CommandObjectFrameSelect
//-------------------------------------------------------------------------
// CommandObjectFrameSelect
//-------------------------------------------------------------------------
Convert option tables to ArrayRefs.
This change is very mechanical. All it does is change the
signature of `Options::GetDefinitions()` and `OptionGroup::
GetDefinitions()` to return an `ArrayRef<OptionDefinition>`
instead of a `const OptionDefinition *`. In the case of the
former, it deletes the sentinel entry from every table, and
in the case of the latter, it removes the `GetNumDefinitions()`
method from the interface. These are no longer necessary as
`ArrayRef` carries its own length.
In the former case, iteration was done by using a sentinel
entry, so there was no knowledge of length. Because of this
the individual option tables were allowed to be defined below
the corresponding class (after all, only a pointer was needed).
Now, however, the length must be known at compile time to
construct the `ArrayRef`, and as a result it is necessary to
move every option table before its corresponding class. This
results in this CL looking very big, but in terms of substance
there is not much here.
Differential revision: https://reviews.llvm.org/D24834
llvm-svn: 282188
2016-09-23 04:22:55 +08:00
static OptionDefinition g_frame_select_options [ ] = {
// clang-format off
{ LLDB_OPT_SET_1 , false , " relative " , ' r ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeOffset , " A relative frame index offset from the current frame index. " } ,
// clang-format on
} ;
2016-09-07 04:57:50 +08:00
class CommandObjectFrameSelect : public CommandObjectParsed {
2010-06-09 00:52:24 +08:00
public :
2016-09-07 04:57:50 +08:00
class CommandOptions : public Options {
public :
CommandOptions ( ) : Options ( ) { OptionParsingStarting ( nullptr ) ; }
~ CommandOptions ( ) override = default ;
2017-05-12 12:51:55 +08:00
Status SetOptionValue ( uint32_t option_idx , llvm : : StringRef option_arg ,
ExecutionContext * execution_context ) override {
Status error ;
2016-09-07 04:57:50 +08:00
const int short_option = m_getopt_table [ option_idx ] . val ;
switch ( short_option ) {
case ' r ' :
2016-11-13 00:56:47 +08:00
if ( option_arg . getAsInteger ( 0 , relative_frame_offset ) ) {
relative_frame_offset = INT32_MIN ;
2016-09-07 04:57:50 +08:00
error . SetErrorStringWithFormat ( " invalid frame offset argument '%s' " ,
2016-11-13 00:56:47 +08:00
option_arg . str ( ) . c_str ( ) ) ;
}
2016-09-07 04:57:50 +08:00
break ;
default :
error . SetErrorStringWithFormat ( " invalid short option character '%c' " ,
short_option ) ;
break ;
}
return error ;
}
2010-10-11 06:28:11 +08:00
2016-09-07 04:57:50 +08:00
void OptionParsingStarting ( ExecutionContext * execution_context ) override {
relative_frame_offset = INT32_MIN ;
}
2010-10-11 06:28:11 +08:00
Convert option tables to ArrayRefs.
This change is very mechanical. All it does is change the
signature of `Options::GetDefinitions()` and `OptionGroup::
GetDefinitions()` to return an `ArrayRef<OptionDefinition>`
instead of a `const OptionDefinition *`. In the case of the
former, it deletes the sentinel entry from every table, and
in the case of the latter, it removes the `GetNumDefinitions()`
method from the interface. These are no longer necessary as
`ArrayRef` carries its own length.
In the former case, iteration was done by using a sentinel
entry, so there was no knowledge of length. Because of this
the individual option tables were allowed to be defined below
the corresponding class (after all, only a pointer was needed).
Now, however, the length must be known at compile time to
construct the `ArrayRef`, and as a result it is necessary to
move every option table before its corresponding class. This
results in this CL looking very big, but in terms of substance
there is not much here.
Differential revision: https://reviews.llvm.org/D24834
llvm-svn: 282188
2016-09-23 04:22:55 +08:00
llvm : : ArrayRef < OptionDefinition > GetDefinitions ( ) override {
2016-09-23 05:06:13 +08:00
return llvm : : makeArrayRef ( g_frame_select_options ) ;
Convert option tables to ArrayRefs.
This change is very mechanical. All it does is change the
signature of `Options::GetDefinitions()` and `OptionGroup::
GetDefinitions()` to return an `ArrayRef<OptionDefinition>`
instead of a `const OptionDefinition *`. In the case of the
former, it deletes the sentinel entry from every table, and
in the case of the latter, it removes the `GetNumDefinitions()`
method from the interface. These are no longer necessary as
`ArrayRef` carries its own length.
In the former case, iteration was done by using a sentinel
entry, so there was no knowledge of length. Because of this
the individual option tables were allowed to be defined below
the corresponding class (after all, only a pointer was needed).
Now, however, the length must be known at compile time to
construct the `ArrayRef`, and as a result it is necessary to
move every option table before its corresponding class. This
results in this CL looking very big, but in terms of substance
there is not much here.
Differential revision: https://reviews.llvm.org/D24834
llvm-svn: 282188
2016-09-23 04:22:55 +08:00
}
2010-10-11 06:28:11 +08:00
2016-09-07 04:57:50 +08:00
int32_t relative_frame_offset ;
} ;
2016-07-15 06:03:10 +08:00
2016-09-07 04:57:50 +08:00
CommandObjectFrameSelect ( CommandInterpreter & interpreter )
: CommandObjectParsed (
interpreter , " frame select " , " Select the current stack frame by "
" index from within the current thread "
" (see 'thread backtrace'.) " ,
nullptr ,
eCommandRequiresThread | eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched | eCommandProcessMustBePaused ) ,
m_options ( ) {
CommandArgumentEntry arg ;
CommandArgumentData index_arg ;
2010-10-05 06:28:36 +08:00
2016-09-07 04:57:50 +08:00
// Define the first (and only) variant of this arg.
index_arg . arg_type = eArgTypeFrameIndex ;
index_arg . arg_repetition = eArgRepeatOptional ;
2010-10-05 06:28:36 +08:00
2016-09-07 04:57:50 +08:00
// There is only one variant this argument could be; put it into the
// argument entry.
arg . push_back ( index_arg ) ;
2010-10-05 06:28:36 +08:00
2016-09-07 04:57:50 +08:00
// Push the data for the first argument into the m_arguments vector.
m_arguments . push_back ( arg ) ;
}
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
~ CommandObjectFrameSelect ( ) override = default ;
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
Options * GetOptions ( ) override { return & m_options ; }
2010-10-11 06:28:11 +08:00
2012-06-09 05:56:10 +08:00
protected :
2016-09-07 04:57:50 +08:00
bool DoExecute ( Args & command , CommandReturnObject & result ) override {
// No need to check "thread" for validity as eCommandRequiresThread ensures
// it is valid
Thread * thread = m_exe_ctx . GetThreadPtr ( ) ;
uint32_t frame_idx = UINT32_MAX ;
if ( m_options . relative_frame_offset ! = INT32_MIN ) {
// The one and only argument is a signed relative frame index
frame_idx = thread - > GetSelectedFrameIndex ( ) ;
if ( frame_idx = = UINT32_MAX )
frame_idx = 0 ;
if ( m_options . relative_frame_offset < 0 ) {
if ( static_cast < int32_t > ( frame_idx ) > = - m_options . relative_frame_offset )
frame_idx + = m_options . relative_frame_offset ;
else {
if ( frame_idx = = 0 ) {
// If you are already at the bottom of the stack, then just warn and
// don't reset the frame.
result . AppendError ( " Already at the bottom of the stack. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
} else
frame_idx = 0 ;
Expanded the flags that can be set for a command object in lldb_private::CommandObject. This list of available flags are:
enum
{
//----------------------------------------------------------------------
// eFlagRequiresTarget
//
// Ensures a valid target is contained in m_exe_ctx prior to executing
// the command. If a target doesn't exist or is invalid, the command
// will fail and CommandObject::GetInvalidTargetDescription() will be
// returned as the error. CommandObject subclasses can override the
// virtual function for GetInvalidTargetDescription() to provide custom
// strings when needed.
//----------------------------------------------------------------------
eFlagRequiresTarget = (1u << 0),
//----------------------------------------------------------------------
// eFlagRequiresProcess
//
// Ensures a valid process is contained in m_exe_ctx prior to executing
// the command. If a process doesn't exist or is invalid, the command
// will fail and CommandObject::GetInvalidProcessDescription() will be
// returned as the error. CommandObject subclasses can override the
// virtual function for GetInvalidProcessDescription() to provide custom
// strings when needed.
//----------------------------------------------------------------------
eFlagRequiresProcess = (1u << 1),
//----------------------------------------------------------------------
// eFlagRequiresThread
//
// Ensures a valid thread is contained in m_exe_ctx prior to executing
// the command. If a thread doesn't exist or is invalid, the command
// will fail and CommandObject::GetInvalidThreadDescription() will be
// returned as the error. CommandObject subclasses can override the
// virtual function for GetInvalidThreadDescription() to provide custom
// strings when needed.
//----------------------------------------------------------------------
eFlagRequiresThread = (1u << 2),
//----------------------------------------------------------------------
// eFlagRequiresFrame
//
// Ensures a valid frame is contained in m_exe_ctx prior to executing
// the command. If a frame doesn't exist or is invalid, the command
// will fail and CommandObject::GetInvalidFrameDescription() will be
// returned as the error. CommandObject subclasses can override the
// virtual function for GetInvalidFrameDescription() to provide custom
// strings when needed.
//----------------------------------------------------------------------
eFlagRequiresFrame = (1u << 3),
//----------------------------------------------------------------------
// eFlagRequiresRegContext
//
// Ensures a valid register context (from the selected frame if there
// is a frame in m_exe_ctx, or from the selected thread from m_exe_ctx)
// is availble from m_exe_ctx prior to executing the command. If a
// target doesn't exist or is invalid, the command will fail and
// CommandObject::GetInvalidRegContextDescription() will be returned as
// the error. CommandObject subclasses can override the virtual function
// for GetInvalidRegContextDescription() to provide custom strings when
// needed.
//----------------------------------------------------------------------
eFlagRequiresRegContext = (1u << 4),
//----------------------------------------------------------------------
// eFlagTryTargetAPILock
//
// Attempts to acquire the target lock if a target is selected in the
// command interpreter. If the command object fails to acquire the API
// lock, the command will fail with an appropriate error message.
//----------------------------------------------------------------------
eFlagTryTargetAPILock = (1u << 5),
//----------------------------------------------------------------------
// eFlagProcessMustBeLaunched
//
// Verifies that there is a launched process in m_exe_ctx, if there
// isn't, the command will fail with an appropriate error message.
//----------------------------------------------------------------------
eFlagProcessMustBeLaunched = (1u << 6),
//----------------------------------------------------------------------
// eFlagProcessMustBePaused
//
// Verifies that there is a paused process in m_exe_ctx, if there
// isn't, the command will fail with an appropriate error message.
//----------------------------------------------------------------------
eFlagProcessMustBePaused = (1u << 7)
};
Now each command object contains a "ExecutionContext m_exe_ctx;" member variable that gets initialized prior to running the command. The validity of the target objects in m_exe_ctx are checked to ensure that any target/process/thread/frame/reg context that are required are valid prior to executing the command. Each command object also contains a Mutex::Locker m_api_locker which gets used if eFlagTryTargetAPILock is set. This centralizes a lot of checking code that was previously and inconsistently implemented across many commands.
llvm-svn: 171990
2013-01-10 03:44:40 +08:00
}
2016-09-07 04:57:50 +08:00
} else if ( m_options . relative_frame_offset > 0 ) {
// I don't want "up 20" where "20" takes you past the top of the stack
// to produce
// an error, but rather to just go to the top. So I have to count the
// stack here...
const uint32_t num_frames = thread - > GetStackFrameCount ( ) ;
if ( static_cast < int32_t > ( num_frames - frame_idx ) >
m_options . relative_frame_offset )
frame_idx + = m_options . relative_frame_offset ;
else {
if ( frame_idx = = num_frames - 1 ) {
// If we are already at the top of the stack, just warn and don't
// reset the frame.
result . AppendError ( " Already at the top of the stack. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
} else
frame_idx = num_frames - 1 ;
Expanded the flags that can be set for a command object in lldb_private::CommandObject. This list of available flags are:
enum
{
//----------------------------------------------------------------------
// eFlagRequiresTarget
//
// Ensures a valid target is contained in m_exe_ctx prior to executing
// the command. If a target doesn't exist or is invalid, the command
// will fail and CommandObject::GetInvalidTargetDescription() will be
// returned as the error. CommandObject subclasses can override the
// virtual function for GetInvalidTargetDescription() to provide custom
// strings when needed.
//----------------------------------------------------------------------
eFlagRequiresTarget = (1u << 0),
//----------------------------------------------------------------------
// eFlagRequiresProcess
//
// Ensures a valid process is contained in m_exe_ctx prior to executing
// the command. If a process doesn't exist or is invalid, the command
// will fail and CommandObject::GetInvalidProcessDescription() will be
// returned as the error. CommandObject subclasses can override the
// virtual function for GetInvalidProcessDescription() to provide custom
// strings when needed.
//----------------------------------------------------------------------
eFlagRequiresProcess = (1u << 1),
//----------------------------------------------------------------------
// eFlagRequiresThread
//
// Ensures a valid thread is contained in m_exe_ctx prior to executing
// the command. If a thread doesn't exist or is invalid, the command
// will fail and CommandObject::GetInvalidThreadDescription() will be
// returned as the error. CommandObject subclasses can override the
// virtual function for GetInvalidThreadDescription() to provide custom
// strings when needed.
//----------------------------------------------------------------------
eFlagRequiresThread = (1u << 2),
//----------------------------------------------------------------------
// eFlagRequiresFrame
//
// Ensures a valid frame is contained in m_exe_ctx prior to executing
// the command. If a frame doesn't exist or is invalid, the command
// will fail and CommandObject::GetInvalidFrameDescription() will be
// returned as the error. CommandObject subclasses can override the
// virtual function for GetInvalidFrameDescription() to provide custom
// strings when needed.
//----------------------------------------------------------------------
eFlagRequiresFrame = (1u << 3),
//----------------------------------------------------------------------
// eFlagRequiresRegContext
//
// Ensures a valid register context (from the selected frame if there
// is a frame in m_exe_ctx, or from the selected thread from m_exe_ctx)
// is availble from m_exe_ctx prior to executing the command. If a
// target doesn't exist or is invalid, the command will fail and
// CommandObject::GetInvalidRegContextDescription() will be returned as
// the error. CommandObject subclasses can override the virtual function
// for GetInvalidRegContextDescription() to provide custom strings when
// needed.
//----------------------------------------------------------------------
eFlagRequiresRegContext = (1u << 4),
//----------------------------------------------------------------------
// eFlagTryTargetAPILock
//
// Attempts to acquire the target lock if a target is selected in the
// command interpreter. If the command object fails to acquire the API
// lock, the command will fail with an appropriate error message.
//----------------------------------------------------------------------
eFlagTryTargetAPILock = (1u << 5),
//----------------------------------------------------------------------
// eFlagProcessMustBeLaunched
//
// Verifies that there is a launched process in m_exe_ctx, if there
// isn't, the command will fail with an appropriate error message.
//----------------------------------------------------------------------
eFlagProcessMustBeLaunched = (1u << 6),
//----------------------------------------------------------------------
// eFlagProcessMustBePaused
//
// Verifies that there is a paused process in m_exe_ctx, if there
// isn't, the command will fail with an appropriate error message.
//----------------------------------------------------------------------
eFlagProcessMustBePaused = (1u << 7)
};
Now each command object contains a "ExecutionContext m_exe_ctx;" member variable that gets initialized prior to running the command. The validity of the target objects in m_exe_ctx are checked to ensure that any target/process/thread/frame/reg context that are required are valid prior to executing the command. Each command object also contains a Mutex::Locker m_api_locker which gets used if eFlagTryTargetAPILock is set. This centralizes a lot of checking code that was previously and inconsistently implemented across many commands.
llvm-svn: 171990
2013-01-10 03:44:40 +08:00
}
2016-09-07 04:57:50 +08:00
}
} else {
2016-12-08 10:02:09 +08:00
if ( command . GetArgumentCount ( ) > 1 ) {
result . AppendErrorWithFormat (
" too many arguments; expected frame-index, saw '%s'. \n " ,
2016-12-09 09:20:58 +08:00
command [ 0 ] . c_str ( ) ) ;
2016-12-08 10:02:09 +08:00
m_options . GenerateOptionUsage (
result . GetErrorStream ( ) , this ,
GetCommandInterpreter ( ) . GetDebugger ( ) . GetTerminalWidth ( ) ) ;
return false ;
}
2016-09-07 04:57:50 +08:00
if ( command . GetArgumentCount ( ) = = 1 ) {
2016-12-08 10:02:09 +08:00
if ( command [ 0 ] . ref . getAsInteger ( 0 , frame_idx ) ) {
2016-09-07 04:57:50 +08:00
result . AppendErrorWithFormat ( " invalid frame index argument '%s'. " ,
2016-12-08 10:02:09 +08:00
command [ 0 ] . c_str ( ) ) ;
2016-09-07 04:57:50 +08:00
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2010-06-09 00:52:24 +08:00
}
2016-09-07 04:57:50 +08:00
} else if ( command . GetArgumentCount ( ) = = 0 ) {
frame_idx = thread - > GetSelectedFrameIndex ( ) ;
if ( frame_idx = = UINT32_MAX ) {
frame_idx = 0 ;
2013-02-01 05:46:01 +08:00
}
2016-09-07 04:57:50 +08:00
}
}
bool success = thread - > SetSelectedFrameByIndexNoisily (
frame_idx , result . GetOutputStream ( ) ) ;
if ( success ) {
m_exe_ctx . SetFrameSP ( thread - > GetSelectedFrame ( ) ) ;
result . SetStatus ( eReturnStatusSuccessFinishResult ) ;
} else {
result . AppendErrorWithFormat ( " Frame index (%u) out of range. \n " ,
frame_idx ) ;
result . SetStatus ( eReturnStatusFailed ) ;
2010-06-09 00:52:24 +08:00
}
2010-10-11 06:28:11 +08:00
2016-09-07 04:57:50 +08:00
return result . Succeeded ( ) ;
}
2016-02-20 03:33:46 +08:00
protected :
2016-09-07 04:57:50 +08:00
CommandOptions m_options ;
2010-10-11 06:28:11 +08:00
} ;
2010-09-02 08:18:39 +08:00
# pragma mark CommandObjectFrameVariable
//----------------------------------------------------------------------
// List images with associated information
//----------------------------------------------------------------------
2016-09-07 04:57:50 +08:00
class CommandObjectFrameVariable : public CommandObjectParsed {
2010-09-02 08:18:39 +08:00
public :
2016-09-07 04:57:50 +08:00
CommandObjectFrameVariable ( CommandInterpreter & interpreter )
: CommandObjectParsed (
interpreter , " frame variable " ,
" Show variables for the current stack frame. Defaults to all "
" arguments and local variables in scope. Names of argument, "
" local, file static and file global variables can be specified. "
" Children of aggregate variables can be specified such as "
" 'var->child.x'. " ,
nullptr , eCommandRequiresFrame | eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched |
eCommandProcessMustBePaused | eCommandRequiresProcess ) ,
m_option_group ( ) ,
m_option_variable (
true ) , // Include the frame specific options by passing "true"
m_option_format ( eFormatDefault ) ,
m_varobj_options ( ) {
CommandArgumentEntry arg ;
CommandArgumentData var_name_arg ;
// Define the first (and only) variant of this arg.
var_name_arg . arg_type = eArgTypeVarName ;
var_name_arg . arg_repetition = eArgRepeatStar ;
// There is only one variant this argument could be; put it into the
// argument entry.
arg . push_back ( var_name_arg ) ;
// Push the data for the first argument into the m_arguments vector.
m_arguments . push_back ( arg ) ;
m_option_group . Append ( & m_option_variable , LLDB_OPT_SET_ALL , LLDB_OPT_SET_1 ) ;
m_option_group . Append ( & m_option_format ,
OptionGroupFormat : : OPTION_GROUP_FORMAT |
OptionGroupFormat : : OPTION_GROUP_GDB_FMT ,
LLDB_OPT_SET_1 ) ;
m_option_group . Append ( & m_varobj_options , LLDB_OPT_SET_ALL , LLDB_OPT_SET_1 ) ;
m_option_group . Finalize ( ) ;
}
~ CommandObjectFrameVariable ( ) override = default ;
Options * GetOptions ( ) override { return & m_option_group ; }
int HandleArgumentCompletion ( Args & input , int & cursor_index ,
int & cursor_char_position ,
OptionElementVector & opt_element_vector ,
int match_start_point , int max_return_elements ,
bool & word_complete ,
StringList & matches ) override {
// Arguments are the standard source file completer.
2016-11-23 01:10:15 +08:00
auto completion_str = input [ cursor_index ] . ref ;
completion_str = completion_str . take_front ( cursor_char_position ) ;
2016-09-07 04:57:50 +08:00
CommandCompletions : : InvokeCommonCompletionCallbacks (
GetCommandInterpreter ( ) , CommandCompletions : : eVariablePathCompletion ,
2016-11-23 01:10:15 +08:00
completion_str , match_start_point , max_return_elements , nullptr ,
2016-09-07 04:57:50 +08:00
word_complete , matches ) ;
return matches . GetSize ( ) ;
}
2010-09-02 08:18:39 +08:00
2012-06-09 05:56:10 +08:00
protected :
2016-10-27 03:17:49 +08:00
llvm : : StringRef GetScopeString ( VariableSP var_sp ) {
if ( ! var_sp )
return llvm : : StringRef : : withNullAsEmpty ( nullptr ) ;
switch ( var_sp - > GetScope ( ) ) {
case eValueTypeVariableGlobal :
return " GLOBAL: " ;
case eValueTypeVariableStatic :
return " STATIC: " ;
case eValueTypeVariableArgument :
return " ARG: " ;
case eValueTypeVariableLocal :
return " LOCAL: " ;
case eValueTypeVariableThreadLocal :
return " THREAD: " ;
default :
break ;
}
return llvm : : StringRef : : withNullAsEmpty ( nullptr ) ;
}
2016-09-07 04:57:50 +08:00
bool DoExecute ( Args & command , CommandReturnObject & result ) override {
// No need to check "frame" for validity as eCommandRequiresFrame ensures it
// is valid
StackFrame * frame = m_exe_ctx . GetFramePtr ( ) ;
Stream & s = result . GetOutputStream ( ) ;
// Be careful about the stack frame, if any summary formatter runs code, it
// might clear the StackFrameList
// for the thread. So hold onto a shared pointer to the frame so it stays
// alive.
VariableList * variable_list =
frame - > GetVariableList ( m_option_variable . show_globals ) ;
VariableSP var_sp ;
ValueObjectSP valobj_sp ;
TypeSummaryImplSP summary_format_sp ;
if ( ! m_option_variable . summary . IsCurrentValueEmpty ( ) )
DataVisualization : : NamedSummaryFormats : : GetSummaryFormat (
ConstString ( m_option_variable . summary . GetCurrentValue ( ) ) ,
summary_format_sp ) ;
else if ( ! m_option_variable . summary_string . IsCurrentValueEmpty ( ) )
summary_format_sp . reset ( new StringSummaryFormat (
TypeSummaryImpl : : Flags ( ) ,
m_option_variable . summary_string . GetCurrentValue ( ) ) ) ;
DumpValueObjectOptions options ( m_varobj_options . GetAsDumpOptions (
eLanguageRuntimeDescriptionDisplayVerbosityFull , eFormatDefault ,
summary_format_sp ) ) ;
const SymbolContext & sym_ctx =
frame - > GetSymbolContext ( eSymbolContextFunction ) ;
if ( sym_ctx . function & & sym_ctx . function - > IsTopLevelFunction ( ) )
m_option_variable . show_globals = true ;
if ( variable_list ) {
const Format format = m_option_format . GetFormat ( ) ;
options . SetFormat ( format ) ;
2016-10-06 04:03:37 +08:00
if ( ! command . empty ( ) ) {
2016-09-07 04:57:50 +08:00
VariableList regex_var_list ;
// If we have any args to the variable command, we will make
// variable objects from them...
2016-12-08 10:02:09 +08:00
for ( auto & entry : command ) {
2016-09-07 04:57:50 +08:00
if ( m_option_variable . use_regex ) {
const size_t regex_start_index = regex_var_list . GetSize ( ) ;
2016-12-08 10:02:09 +08:00
llvm : : StringRef name_str = entry . ref ;
2016-09-22 00:01:28 +08:00
RegularExpression regex ( name_str ) ;
if ( regex . Compile ( name_str ) ) {
2016-09-07 04:57:50 +08:00
size_t num_matches = 0 ;
const size_t num_new_regex_vars =
variable_list - > AppendVariablesIfUnique ( regex , regex_var_list ,
num_matches ) ;
if ( num_new_regex_vars > 0 ) {
for ( size_t regex_idx = regex_start_index ,
end_index = regex_var_list . GetSize ( ) ;
regex_idx < end_index ; + + regex_idx ) {
var_sp = regex_var_list . GetVariableAtIndex ( regex_idx ) ;
if ( var_sp ) {
valobj_sp = frame - > GetValueObjectForFrameVariable (
var_sp , m_varobj_options . use_dynamic ) ;
if ( valobj_sp ) {
2016-10-27 03:17:49 +08:00
std : : string scope_string ;
if ( m_option_variable . show_scope )
scope_string = GetScopeString ( var_sp ) . str ( ) ;
if ( ! scope_string . empty ( ) )
2016-11-03 04:34:10 +08:00
s . PutCString ( scope_string ) ;
2016-10-27 03:17:49 +08:00
2016-09-07 04:57:50 +08:00
if ( m_option_variable . show_decl & &
var_sp - > GetDeclaration ( ) . GetFile ( ) ) {
bool show_fullpaths = false ;
bool show_module = true ;
if ( var_sp - > DumpDeclaration ( & s , show_fullpaths ,
show_module ) )
s . PutCString ( " : " ) ;
}
valobj_sp - > Dump ( result . GetOutputStream ( ) , options ) ;
2010-09-02 08:18:39 +08:00
}
2016-09-07 04:57:50 +08:00
}
2010-09-02 08:18:39 +08:00
}
2016-09-07 04:57:50 +08:00
} else if ( num_matches = = 0 ) {
result . GetErrorStream ( ) . Printf ( " error: no variables matched "
" the regular expression '%s'. \n " ,
2016-12-08 10:02:09 +08:00
entry . c_str ( ) ) ;
2016-09-07 04:57:50 +08:00
}
} else {
char regex_error [ 1024 ] ;
if ( regex . GetErrorAsCString ( regex_error , sizeof ( regex_error ) ) )
result . GetErrorStream ( ) . Printf ( " error: %s \n " , regex_error ) ;
else
result . GetErrorStream ( ) . Printf (
" error: unknown regex error when compiling '%s' \n " ,
2016-12-08 10:02:09 +08:00
entry . c_str ( ) ) ;
2011-09-13 07:58:53 +08:00
}
2016-09-07 04:57:50 +08:00
} else // No regex, either exact variable names or variable
// expressions.
{
2017-05-12 12:51:55 +08:00
Status error ;
2016-09-07 04:57:50 +08:00
uint32_t expr_path_options =
StackFrame : : eExpressionPathOptionCheckPtrVsMember |
StackFrame : : eExpressionPathOptionsAllowDirectIVarAccess |
StackFrame : : eExpressionPathOptionsInspectAnonymousUnions ;
lldb : : VariableSP var_sp ;
valobj_sp = frame - > GetValueForVariableExpressionPath (
2016-12-08 10:02:09 +08:00
entry . ref , m_varobj_options . use_dynamic , expr_path_options ,
2016-09-07 04:57:50 +08:00
var_sp , error ) ;
if ( valobj_sp ) {
2016-10-27 03:17:49 +08:00
std : : string scope_string ;
if ( m_option_variable . show_scope )
scope_string = GetScopeString ( var_sp ) . str ( ) ;
if ( ! scope_string . empty ( ) )
2016-11-03 04:34:10 +08:00
s . PutCString ( scope_string ) ;
2016-09-07 04:57:50 +08:00
if ( m_option_variable . show_decl & & var_sp & &
var_sp - > GetDeclaration ( ) . GetFile ( ) ) {
var_sp - > GetDeclaration ( ) . DumpStopContext ( & s , false ) ;
s . PutCString ( " : " ) ;
}
options . SetFormat ( format ) ;
options . SetVariableFormatDisplayLanguage (
valobj_sp - > GetPreferredDisplayLanguage ( ) ) ;
Stream & output_stream = result . GetOutputStream ( ) ;
2016-12-08 10:02:09 +08:00
options . SetRootValueObjectName (
valobj_sp - > GetParent ( ) ? entry . c_str ( ) : nullptr ) ;
2016-09-07 04:57:50 +08:00
valobj_sp - > Dump ( output_stream , options ) ;
} else {
const char * error_cstr = error . AsCString ( nullptr ) ;
if ( error_cstr )
result . GetErrorStream ( ) . Printf ( " error: %s \n " , error_cstr ) ;
else
result . GetErrorStream ( ) . Printf ( " error: unable to find any "
" variable expression path that "
" matches '%s'. \n " ,
2016-12-08 10:02:09 +08:00
entry . c_str ( ) ) ;
2010-09-02 08:18:39 +08:00
}
2016-09-07 04:57:50 +08:00
}
2010-09-02 08:18:39 +08:00
}
2016-09-07 04:57:50 +08:00
} else // No command arg specified. Use variable_list, instead.
{
const size_t num_variables = variable_list - > GetSize ( ) ;
if ( num_variables > 0 ) {
for ( size_t i = 0 ; i < num_variables ; i + + ) {
var_sp = variable_list - > GetVariableAtIndex ( i ) ;
2017-06-19 14:57:54 +08:00
switch ( var_sp - > GetScope ( ) ) {
case eValueTypeVariableGlobal :
if ( ! m_option_variable . show_globals )
2017-04-19 00:52:16 +08:00
continue ;
2017-06-19 14:57:54 +08:00
break ;
case eValueTypeVariableStatic :
if ( ! m_option_variable . show_globals )
continue ;
break ;
case eValueTypeVariableArgument :
if ( ! m_option_variable . show_args )
continue ;
break ;
case eValueTypeVariableLocal :
if ( ! m_option_variable . show_locals )
continue ;
break ;
default :
continue ;
break ;
2017-04-19 00:52:16 +08:00
}
2017-06-19 14:57:54 +08:00
std : : string scope_string ;
if ( m_option_variable . show_scope )
scope_string = GetScopeString ( var_sp ) . str ( ) ;
2017-04-19 00:52:16 +08:00
// Use the variable object code to make sure we are
// using the same APIs as the public API will be
// using...
valobj_sp = frame - > GetValueObjectForFrameVariable (
var_sp , m_varobj_options . use_dynamic ) ;
if ( valobj_sp ) {
// When dumping all variables, don't print any variables
// that are not in scope to avoid extra unneeded output
if ( valobj_sp - > IsInScope ( ) ) {
if ( ! valobj_sp - > GetTargetSP ( )
- > GetDisplayRuntimeSupportValues ( ) & &
valobj_sp - > IsRuntimeSupportValue ( ) )
continue ;
if ( ! scope_string . empty ( ) )
s . PutCString ( scope_string ) ;
if ( m_option_variable . show_decl & &
var_sp - > GetDeclaration ( ) . GetFile ( ) ) {
var_sp - > GetDeclaration ( ) . DumpStopContext ( & s , false ) ;
s . PutCString ( " : " ) ;
2016-09-07 04:57:50 +08:00
}
2017-04-19 00:52:16 +08:00
options . SetFormat ( format ) ;
options . SetVariableFormatDisplayLanguage (
valobj_sp - > GetPreferredDisplayLanguage ( ) ) ;
options . SetRootValueObjectName (
var_sp ? var_sp - > GetName ( ) . AsCString ( ) : nullptr ) ;
valobj_sp - > Dump ( result . GetOutputStream ( ) , options ) ;
2016-09-07 04:57:50 +08:00
}
}
}
2011-08-13 00:42:31 +08:00
}
2016-09-07 04:57:50 +08:00
}
result . SetStatus ( eReturnStatusSuccessFinishResult ) ;
2010-09-02 08:18:39 +08:00
}
2016-09-07 04:57:50 +08:00
if ( m_interpreter . TruncationWarningNecessary ( ) ) {
result . GetOutputStream ( ) . Printf ( m_interpreter . TruncationWarningText ( ) ,
m_cmd_name . c_str ( ) ) ;
m_interpreter . TruncationWarningGiven ( ) ;
}
return result . Succeeded ( ) ;
}
2016-02-20 03:33:46 +08:00
protected :
2016-09-07 04:57:50 +08:00
OptionGroupOptions m_option_group ;
OptionGroupVariable m_option_variable ;
OptionGroupFormat m_option_format ;
OptionGroupValueObjectDisplay m_varobj_options ;
2010-09-02 08:18:39 +08:00
} ;
2010-06-09 00:52:24 +08:00
# pragma mark CommandObjectMultiwordFrame
//-------------------------------------------------------------------------
// CommandObjectMultiwordFrame
//-------------------------------------------------------------------------
2016-09-07 04:57:50 +08:00
CommandObjectMultiwordFrame : : CommandObjectMultiwordFrame (
CommandInterpreter & interpreter )
: CommandObjectMultiword ( interpreter , " frame " , " Commands for selecting and "
" examing the current "
" thread's stack frames. " ,
" frame <subcommand> [<subcommand-options>] " ) {
LoadSubCommand ( " diagnose " ,
CommandObjectSP ( new CommandObjectFrameDiagnose ( interpreter ) ) ) ;
LoadSubCommand ( " info " ,
CommandObjectSP ( new CommandObjectFrameInfo ( interpreter ) ) ) ;
LoadSubCommand ( " select " ,
CommandObjectSP ( new CommandObjectFrameSelect ( interpreter ) ) ) ;
LoadSubCommand ( " variable " ,
CommandObjectSP ( new CommandObjectFrameVariable ( interpreter ) ) ) ;
2010-06-09 00:52:24 +08:00
}
2016-02-20 03:33:46 +08:00
CommandObjectMultiwordFrame : : ~ CommandObjectMultiwordFrame ( ) = default ;
