2010-06-09 00:52:24 +08:00
//===-- CommandObjectThread.cpp ---------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
# include "CommandObjectThread.h"
// C Includes
// C++ Includes
// Other libraries and framework includes
// Project includes
# include "lldb/Core/SourceManager.h"
2016-09-07 04:57:50 +08:00
# include "lldb/Core/State.h"
2015-03-04 07:11:11 +08:00
# include "lldb/Core/ValueObject.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"
2015-01-16 04:08:35 +08:00
# include "lldb/Host/StringConvert.h"
2010-06-09 00:52:24 +08:00
# include "lldb/Interpreter/CommandInterpreter.h"
# include "lldb/Interpreter/CommandReturnObject.h"
2018-04-10 17:03:59 +08:00
# include "lldb/Interpreter/OptionArgParser.h"
<rdar://problem/11757916>
Make breakpoint setting by file and line much more efficient by only looking for inlined breakpoint locations if we are setting a breakpoint in anything but a source implementation file. Implementing this complex for a many reasons. Turns out that parsing compile units lazily had some issues with respect to how we need to do things with DWARF in .o files. So the fixes in the checkin for this makes these changes:
- Add a new setting called "target.inline-breakpoint-strategy" which can be set to "never", "always", or "headers". "never" will never try and set any inlined breakpoints (fastest). "always" always looks for inlined breakpoint locations (slowest, but most accurate). "headers", which is the default setting, will only look for inlined breakpoint locations if the breakpoint is set in what are consudered to be header files, which is realy defined as "not in an implementation source file".
- modify the breakpoint setting by file and line to check the current "target.inline-breakpoint-strategy" setting and act accordingly
- Modify compile units to be able to get their language and other info lazily. This allows us to create compile units from the debug map and not have to fill all of the details in, and then lazily discover this information as we go on debuggging. This is needed to avoid parsing all .o files when setting breakpoints in implementation only files (no inlines). Otherwise we would need to parse the .o file, the object file (mach-o in our case) and the symbol file (DWARF in the object file) just to see what the compile unit was.
- modify the "SymbolFileDWARFDebugMap" to subclass lldb_private::Module so that the virtual "GetObjectFile()" and "GetSymbolVendor()" functions can be intercepted when the .o file contenst are later lazilly needed. Prior to this fix, when we first instantiated the "SymbolFileDWARFDebugMap" class, we would also make modules, object files and symbol files for every .o file in the debug map because we needed to fix up the sections in the .o files with information that is in the executable debug map. Now we lazily do this in the DebugMapModule::GetObjectFile()
Cleaned up header includes a bit as well.
llvm-svn: 162860
2012-08-30 05:13:06 +08:00
# include "lldb/Interpreter/Options.h"
# include "lldb/Symbol/CompileUnit.h"
# include "lldb/Symbol/Function.h"
# include "lldb/Symbol/LineEntry.h"
2016-09-07 04:57:50 +08:00
# include "lldb/Symbol/LineTable.h"
2010-06-09 00:52:24 +08:00
# include "lldb/Target/Process.h"
# include "lldb/Target/RegisterContext.h"
2013-11-12 15:02:07 +08:00
# include "lldb/Target/SystemRuntime.h"
2010-06-09 00:52:24 +08:00
# include "lldb/Target/Target.h"
# include "lldb/Target/Thread.h"
# include "lldb/Target/ThreadPlan.h"
2016-09-07 04:57:50 +08:00
# include "lldb/Target/ThreadPlanStepInRange.h"
2010-06-09 00:52:24 +08:00
# include "lldb/Target/ThreadPlanStepInstruction.h"
# include "lldb/Target/ThreadPlanStepOut.h"
# include "lldb/Target/ThreadPlanStepRange.h"
2016-09-07 04:57:50 +08:00
# include "lldb/lldb-private.h"
<rdar://problem/11757916>
Make breakpoint setting by file and line much more efficient by only looking for inlined breakpoint locations if we are setting a breakpoint in anything but a source implementation file. Implementing this complex for a many reasons. Turns out that parsing compile units lazily had some issues with respect to how we need to do things with DWARF in .o files. So the fixes in the checkin for this makes these changes:
- Add a new setting called "target.inline-breakpoint-strategy" which can be set to "never", "always", or "headers". "never" will never try and set any inlined breakpoints (fastest). "always" always looks for inlined breakpoint locations (slowest, but most accurate). "headers", which is the default setting, will only look for inlined breakpoint locations if the breakpoint is set in what are consudered to be header files, which is realy defined as "not in an implementation source file".
- modify the breakpoint setting by file and line to check the current "target.inline-breakpoint-strategy" setting and act accordingly
- Modify compile units to be able to get their language and other info lazily. This allows us to create compile units from the debug map and not have to fill all of the details in, and then lazily discover this information as we go on debuggging. This is needed to avoid parsing all .o files when setting breakpoints in implementation only files (no inlines). Otherwise we would need to parse the .o file, the object file (mach-o in our case) and the symbol file (DWARF in the object file) just to see what the compile unit was.
- modify the "SymbolFileDWARFDebugMap" to subclass lldb_private::Module so that the virtual "GetObjectFile()" and "GetSymbolVendor()" functions can be intercepted when the .o file contenst are later lazilly needed. Prior to this fix, when we first instantiated the "SymbolFileDWARFDebugMap" class, we would also make modules, object files and symbol files for every .o file in the debug map because we needed to fix up the sections in the .o files with information that is in the executable debug map. Now we lazily do this in the DebugMapModule::GetObjectFile()
Cleaned up header includes a bit as well.
llvm-svn: 162860
2012-08-30 05:13:06 +08:00
2010-06-09 00:52:24 +08:00
using namespace lldb ;
using namespace lldb_private ;
//-------------------------------------------------------------------------
2017-06-13 00:25:24 +08:00
// CommandObjectIterateOverThreads
2010-06-09 00:52:24 +08:00
//-------------------------------------------------------------------------
2016-09-07 04:57:50 +08:00
class CommandObjectIterateOverThreads : public CommandObjectParsed {
2017-06-13 00:25:24 +08:00
class UniqueStack {
public :
UniqueStack ( std : : stack < lldb : : addr_t > stack_frames , uint32_t thread_index_id )
: m_stack_frames ( stack_frames ) {
m_thread_index_ids . push_back ( thread_index_id ) ;
}
void AddThread ( uint32_t thread_index_id ) const {
m_thread_index_ids . push_back ( thread_index_id ) ;
}
const std : : vector < uint32_t > & GetUniqueThreadIndexIDs ( ) const {
return m_thread_index_ids ;
}
lldb : : tid_t GetRepresentativeThread ( ) const {
return m_thread_index_ids . front ( ) ;
}
friend bool inline operator < ( const UniqueStack & lhs ,
const UniqueStack & rhs ) {
return lhs . m_stack_frames < rhs . m_stack_frames ;
}
protected :
// Mark the thread index as mutable, as we don't care about it from a const
// perspective, we only care about m_stack_frames so we keep our std::set
// sorted.
mutable std : : vector < uint32_t > m_thread_index_ids ;
std : : stack < lldb : : addr_t > m_stack_frames ;
} ;
2014-09-30 07:17:18 +08:00
public :
2016-09-07 04:57:50 +08:00
CommandObjectIterateOverThreads ( CommandInterpreter & interpreter ,
const char * name , const char * help ,
const char * syntax , uint32_t flags )
: CommandObjectParsed ( interpreter , name , help , syntax , flags ) { }
~ CommandObjectIterateOverThreads ( ) override = default ;
bool DoExecute ( Args & command , CommandReturnObject & result ) override {
result . SetStatus ( m_success_return ) ;
2017-06-13 00:25:24 +08:00
bool all_threads = false ;
2016-09-07 04:57:50 +08:00
if ( command . GetArgumentCount ( ) = = 0 ) {
Thread * thread = m_exe_ctx . GetThreadPtr ( ) ;
2017-09-20 02:07:33 +08:00
if ( ! thread | | ! HandleOneThread ( thread - > GetID ( ) , result ) )
2016-09-07 04:57:50 +08:00
return false ;
return result . Succeeded ( ) ;
2017-06-13 00:25:24 +08:00
} else if ( command . GetArgumentCount ( ) = = 1 ) {
all_threads = : : strcmp ( command . GetArgumentAtIndex ( 0 ) , " all " ) = = 0 ;
m_unique_stacks = : : strcmp ( command . GetArgumentAtIndex ( 0 ) , " unique " ) = = 0 ;
2014-09-30 07:17:18 +08:00
}
2016-09-07 04:57:50 +08:00
// Use tids instead of ThreadSPs to prevent deadlocking problems which
2018-05-01 00:49:04 +08:00
// result from JIT-ing code while iterating over the (locked) ThreadSP
// list.
2016-09-07 04:57:50 +08:00
std : : vector < lldb : : tid_t > tids ;
2015-10-08 00:56:17 +08:00
2017-06-13 00:25:24 +08:00
if ( all_threads | | m_unique_stacks ) {
2016-09-07 04:57:50 +08:00
Process * process = m_exe_ctx . GetProcessPtr ( ) ;
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
for ( ThreadSP thread_sp : process - > Threads ( ) )
tids . push_back ( thread_sp - > GetID ( ) ) ;
} else {
const size_t num_args = command . GetArgumentCount ( ) ;
Process * process = m_exe_ctx . GetProcessPtr ( ) ;
2016-03-18 02:52:41 +08:00
2016-09-07 04:57:50 +08:00
std : : lock_guard < std : : recursive_mutex > guard (
process - > GetThreadList ( ) . GetMutex ( ) ) ;
2016-03-18 02:52:41 +08:00
2016-09-07 04:57:50 +08:00
for ( size_t i = 0 ; i < num_args ; i + + ) {
bool success ;
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
uint32_t thread_idx = StringConvert : : ToUInt32 (
command . GetArgumentAtIndex ( i ) , 0 , 0 , & success ) ;
if ( ! success ) {
result . AppendErrorWithFormat ( " invalid thread specification: \" %s \" \n " ,
command . GetArgumentAtIndex ( i ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2014-09-30 07:17:18 +08:00
}
2016-09-07 04:57:50 +08:00
ThreadSP thread =
process - > GetThreadList ( ) . FindThreadByIndexID ( thread_idx ) ;
if ( ! thread ) {
result . AppendErrorWithFormat ( " no thread with index: \" %s \" \n " ,
command . GetArgumentAtIndex ( i ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2014-09-30 07:17:18 +08:00
}
2016-03-18 02:52:41 +08:00
2016-09-07 04:57:50 +08:00
tids . push_back ( thread - > GetID ( ) ) ;
}
}
2016-03-18 02:52:41 +08:00
2017-06-13 00:25:24 +08:00
if ( m_unique_stacks ) {
// Iterate over threads, finding unique stack buckets.
std : : set < UniqueStack > unique_stacks ;
for ( const lldb : : tid_t & tid : tids ) {
if ( ! BucketThread ( tid , unique_stacks , result ) ) {
return false ;
}
}
2016-03-18 02:52:41 +08:00
2017-06-13 00:25:24 +08:00
// Write the thread id's and unique call stacks to the output stream
Stream & strm = result . GetOutputStream ( ) ;
Process * process = m_exe_ctx . GetProcessPtr ( ) ;
for ( const UniqueStack & stack : unique_stacks ) {
// List the common thread ID's
const std : : vector < uint32_t > & thread_index_ids =
stack . GetUniqueThreadIndexIDs ( ) ;
2017-07-05 22:54:46 +08:00
strm . Format ( " {0} thread(s) " , thread_index_ids . size ( ) ) ;
2017-06-13 00:25:24 +08:00
for ( const uint32_t & thread_index_id : thread_index_ids ) {
2017-07-05 22:54:46 +08:00
strm . Format ( " #{0} " , thread_index_id ) ;
2017-06-13 00:25:24 +08:00
}
strm . EOL ( ) ;
// List the shared call stack for this set of threads
uint32_t representative_thread_id = stack . GetRepresentativeThread ( ) ;
ThreadSP thread = process - > GetThreadList ( ) . FindThreadByIndexID (
representative_thread_id ) ;
if ( ! HandleOneThread ( thread - > GetID ( ) , result ) ) {
return false ;
}
}
} else {
uint32_t idx = 0 ;
for ( const lldb : : tid_t & tid : tids ) {
if ( idx ! = 0 & & m_add_return )
result . AppendMessage ( " " ) ;
2016-09-07 04:57:50 +08:00
2017-06-13 00:25:24 +08:00
if ( ! HandleOneThread ( tid , result ) )
return false ;
+ + idx ;
}
2014-09-30 07:17:18 +08:00
}
2016-09-07 04:57:50 +08:00
return result . Succeeded ( ) ;
}
2014-09-30 07:17:18 +08:00
protected :
2016-09-07 04:57:50 +08:00
// Override this to do whatever you need to do for one thread.
//
// If you return false, the iteration will stop, otherwise it will proceed.
// The result is set to m_success_return (defaults to
2018-05-01 00:49:04 +08:00
// eReturnStatusSuccessFinishResult) before the iteration, so you only need
// to set the return status in HandleOneThread if you want to indicate an
// error. If m_add_return is true, a blank line will be inserted between each
// of the listings (except the last one.)
2016-09-07 04:57:50 +08:00
virtual bool HandleOneThread ( lldb : : tid_t , CommandReturnObject & result ) = 0 ;
2017-06-13 00:25:24 +08:00
bool BucketThread ( lldb : : tid_t tid , std : : set < UniqueStack > & unique_stacks ,
CommandReturnObject & result ) {
// Grab the corresponding thread for the given thread id.
Process * process = m_exe_ctx . GetProcessPtr ( ) ;
Thread * thread = process - > GetThreadList ( ) . FindThreadByID ( tid ) . get ( ) ;
if ( thread = = nullptr ) {
2017-07-05 22:54:46 +08:00
result . AppendErrorWithFormatv ( " Failed to process thread #{0}. \n " , tid ) ;
2017-06-13 00:25:24 +08:00
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
// Collect the each frame's address for this call-stack
std : : stack < lldb : : addr_t > stack_frames ;
const uint32_t frame_count = thread - > GetStackFrameCount ( ) ;
for ( uint32_t frame_index = 0 ; frame_index < frame_count ; frame_index + + ) {
const lldb : : StackFrameSP frame_sp =
thread - > GetStackFrameAtIndex ( frame_index ) ;
const lldb : : addr_t pc = frame_sp - > GetStackID ( ) . GetPC ( ) ;
stack_frames . push ( pc ) ;
}
uint32_t thread_index_id = thread - > GetIndexID ( ) ;
UniqueStack new_unique_stack ( stack_frames , thread_index_id ) ;
// Try to match the threads stack to and existing entry.
std : : set < UniqueStack > : : iterator matching_stack =
unique_stacks . find ( new_unique_stack ) ;
if ( matching_stack ! = unique_stacks . end ( ) ) {
matching_stack - > AddThread ( thread_index_id ) ;
} else {
unique_stacks . insert ( new_unique_stack ) ;
}
return true ;
}
2016-09-07 04:57:50 +08:00
ReturnStatus m_success_return = eReturnStatusSuccessFinishResult ;
2017-06-13 00:25:24 +08:00
bool m_unique_stacks = false ;
2016-09-07 04:57:50 +08:00
bool m_add_return = true ;
2014-09-30 07:17:18 +08:00
} ;
//-------------------------------------------------------------------------
// CommandObjectThreadBacktrace
//-------------------------------------------------------------------------
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_thread_backtrace_options [ ] = {
// clang-format off
{ LLDB_OPT_SET_1 , false , " count " , ' c ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeCount , " How many frames to display (-1 for all) " } ,
{ LLDB_OPT_SET_1 , false , " start " , ' s ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeFrameIndex , " Frame in which to start the backtrace " } ,
{ LLDB_OPT_SET_1 , false , " extended " , ' e ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeBoolean , " Show the extended backtrace, if available " }
// clang-format on
} ;
2016-09-07 04:57:50 +08:00
class CommandObjectThreadBacktrace : public CommandObjectIterateOverThreads {
2010-06-09 00:52:24 +08:00
public :
2016-09-07 04:57:50 +08:00
class CommandOptions : public Options {
public :
CommandOptions ( ) : Options ( ) {
// Keep default values of all options in one place: OptionParsingStarting
// ()
OptionParsingStarting ( nullptr ) ;
}
2010-08-27 07:36:03 +08:00
2016-09-07 04:57:50 +08:00
~ CommandOptions ( ) override = default ;
2010-08-27 07:36:03 +08:00
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 ;
2010-08-27 07:36:03 +08:00
2016-09-07 04:57:50 +08:00
switch ( short_option ) {
case ' c ' : {
2016-11-13 00:56:47 +08:00
int32_t input_count = 0 ;
if ( option_arg . getAsInteger ( 0 , m_count ) ) {
m_count = UINT32_MAX ;
2016-09-07 04:57:50 +08:00
error . SetErrorStringWithFormat (
" invalid integer value for option '%c' " , short_option ) ;
2016-11-13 00:56:47 +08:00
} else if ( input_count < 0 )
2016-09-07 04:57:50 +08:00
m_count = UINT32_MAX ;
} break ;
2016-11-13 00:56:47 +08:00
case ' s ' :
if ( option_arg . getAsInteger ( 0 , m_start ) )
2016-09-07 04:57:50 +08:00
error . SetErrorStringWithFormat (
" invalid integer value for option '%c' " , short_option ) ;
2016-11-13 00:56:47 +08:00
break ;
2016-09-07 04:57:50 +08:00
case ' e ' : {
bool success ;
m_extended_backtrace =
2018-04-10 17:03:59 +08:00
OptionArgParser : : ToBoolean ( option_arg , false , & success ) ;
2016-09-07 04:57:50 +08:00
if ( ! success )
error . SetErrorStringWithFormat (
" invalid boolean value for option '%c' " , short_option ) ;
} break ;
default :
error . SetErrorStringWithFormat ( " invalid short option character '%c' " ,
short_option ) ;
break ;
}
return error ;
}
2010-08-27 07:36:03 +08:00
2016-09-07 04:57:50 +08:00
void OptionParsingStarting ( ExecutionContext * execution_context ) override {
m_count = UINT32_MAX ;
m_start = 0 ;
m_extended_backtrace = false ;
}
2010-08-27 07:36:03 +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_thread_backtrace_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-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
// Instance variables to hold the values for command options.
uint32_t m_count ;
uint32_t m_start ;
bool m_extended_backtrace ;
} ;
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
CommandObjectThreadBacktrace ( CommandInterpreter & interpreter )
: CommandObjectIterateOverThreads (
interpreter , " thread backtrace " ,
" Show thread call stacks. Defaults to the current thread, thread "
2017-06-13 00:25:24 +08:00
" indexes can be specified as arguments. \n "
" Use the thread-index \" all \" to see all threads. \n "
" Use the thread-index \" unique \" to see threads grouped by unique "
" call stacks. " ,
2016-09-07 04:57:50 +08:00
nullptr ,
eCommandRequiresProcess | eCommandRequiresThread |
eCommandTryTargetAPILock | eCommandProcessMustBeLaunched |
eCommandProcessMustBePaused ) ,
m_options ( ) { }
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
~ CommandObjectThreadBacktrace ( ) override = default ;
2013-11-12 15:02:07 +08:00
2016-09-07 04:57:50 +08:00
Options * GetOptions ( ) override { return & m_options ; }
2016-03-18 02:52:41 +08:00
2016-09-07 04:57:50 +08:00
protected :
void DoExtendedBacktrace ( Thread * thread , CommandReturnObject & result ) {
SystemRuntime * runtime = thread - > GetProcess ( ) - > GetSystemRuntime ( ) ;
if ( runtime ) {
Stream & strm = result . GetOutputStream ( ) ;
const std : : vector < ConstString > & types =
runtime - > GetExtendedBacktraceTypes ( ) ;
for ( auto type : types ) {
ThreadSP ext_thread_sp = runtime - > GetExtendedBacktraceThread (
thread - > shared_from_this ( ) , type ) ;
if ( ext_thread_sp & & ext_thread_sp - > IsValid ( ) ) {
const uint32_t num_frames_with_source = 0 ;
2016-11-09 04:36:40 +08:00
const bool stop_format = false ;
2016-09-07 04:57:50 +08:00
if ( ext_thread_sp - > GetStatus ( strm , m_options . m_start ,
m_options . m_count ,
2016-11-09 04:36:40 +08:00
num_frames_with_source ,
stop_format ) ) {
2016-09-07 04:57:50 +08:00
DoExtendedBacktrace ( ext_thread_sp . get ( ) , result ) ;
}
}
}
}
}
bool HandleOneThread ( lldb : : tid_t tid , CommandReturnObject & result ) override {
ThreadSP thread_sp =
m_exe_ctx . GetProcessPtr ( ) - > GetThreadList ( ) . FindThreadByID ( tid ) ;
if ( ! thread_sp ) {
result . AppendErrorWithFormat (
" thread disappeared while computing backtraces: 0x% " PRIx64 " \n " ,
tid ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
2016-03-18 02:52:41 +08:00
2016-09-07 04:57:50 +08:00
Thread * thread = thread_sp . get ( ) ;
Centralized a lot of the status information for processes,
threads, and stack frame down in the lldb_private::Process,
lldb_private::Thread, lldb_private::StackFrameList and the
lldb_private::StackFrame classes. We had some command line
commands that had duplicate versions of the process status
output ("thread list" and "process status" for example).
Removed the "file" command and placed it where it should
have been: "target create". Made an alias for "file" to
"target create" so we stay compatible with GDB commands.
We can now have multple usable targets in lldb at the
same time. This is nice for comparing two runs of a program
or debugging more than one binary at the same time. The
new command is "target select <target-idx>" and also to see
a list of the current targets you can use the new "target list"
command. The flow in a debug session can be:
(lldb) target create /path/to/exe/a.out
(lldb) breakpoint set --name main
(lldb) run
... hit breakpoint
(lldb) target create /bin/ls
(lldb) run /tmp
Process 36001 exited with status = 0 (0x00000000)
(lldb) target list
Current targets:
target #0: /tmp/args/a.out ( arch=x86_64-apple-darwin, platform=localhost, pid=35999, state=stopped )
* target #1: /bin/ls ( arch=x86_64-apple-darwin, platform=localhost, pid=36001, state=exited )
(lldb) target select 0
Current targets:
* target #0: /tmp/args/a.out ( arch=x86_64-apple-darwin, platform=localhost, pid=35999, state=stopped )
target #1: /bin/ls ( arch=x86_64-apple-darwin, platform=localhost, pid=36001, state=exited )
(lldb) bt
* thread #1: tid = 0x2d03, 0x0000000100000b9a a.out`main + 42 at main.c:16, stop reason = breakpoint 1.1
frame #0: 0x0000000100000b9a a.out`main + 42 at main.c:16
frame #1: 0x0000000100000b64 a.out`start + 52
Above we created a target for "a.out" and ran and hit a
breakpoint at "main". Then we created a new target for /bin/ls
and ran it. Then we listed the targest and selected our original
"a.out" program, so we showed two concurent debug sessions
going on at the same time.
llvm-svn: 129695
2011-04-18 16:33:37 +08:00
2016-09-07 04:57:50 +08:00
Stream & strm = result . GetOutputStream ( ) ;
2014-09-30 07:17:18 +08:00
2017-06-13 00:25:24 +08:00
// Only dump stack info if we processing unique stacks.
const bool only_stacks = m_unique_stacks ;
2016-09-07 04:57:50 +08:00
// Don't show source context when doing backtraces.
const uint32_t num_frames_with_source = 0 ;
2016-11-09 07:43:36 +08:00
const bool stop_format = true ;
2016-09-07 04:57:50 +08:00
if ( ! thread - > GetStatus ( strm , m_options . m_start , m_options . m_count ,
2017-06-13 00:25:24 +08:00
num_frames_with_source , stop_format , only_stacks ) ) {
2016-09-07 04:57:50 +08:00
result . AppendErrorWithFormat (
" error displaying backtrace for thread: \" 0x%4.4x \" \n " ,
thread - > GetIndexID ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
if ( m_options . m_extended_backtrace ) {
DoExtendedBacktrace ( thread , result ) ;
2010-06-09 00:52:24 +08:00
}
2012-06-09 05:56:10 +08:00
2016-09-07 04:57:50 +08:00
return true ;
}
CommandOptions m_options ;
2010-06-09 00:52:24 +08:00
} ;
2016-09-07 04:57:50 +08:00
enum StepScope { eStepScopeSource , eStepScopeInstruction } ;
2010-06-09 00:52:24 +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
static OptionEnumValueElement g_tri_running_mode [ ] = {
{ eOnlyThisThread , " this-thread " , " Run only this thread " } ,
{ eAllThreads , " all-threads " , " Run all threads " } ,
{ eOnlyDuringStepping , " while-stepping " ,
" Run only this thread while stepping " } ,
{ 0 , nullptr , nullptr } } ;
static OptionEnumValueElement g_duo_running_mode [ ] = {
{ eOnlyThisThread , " this-thread " , " Run only this thread " } ,
{ eAllThreads , " all-threads " , " Run all threads " } ,
{ 0 , nullptr , nullptr } } ;
static OptionDefinition g_thread_step_scope_options [ ] = {
// clang-format off
{ LLDB_OPT_SET_1 , false , " step-in-avoids-no-debug " , ' a ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeBoolean , " A boolean value that sets whether stepping into functions will step over functions with no debug information. " } ,
{ LLDB_OPT_SET_1 , false , " step-out-avoids-no-debug " , ' A ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeBoolean , " A boolean value, if true stepping out of functions will continue to step out till it hits a function with debug information. " } ,
{ LLDB_OPT_SET_1 , false , " count " , ' c ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 1 , eArgTypeCount , " How many times to perform the stepping operation - currently only supported for step-inst and next-inst. " } ,
{ LLDB_OPT_SET_1 , false , " end-linenumber " , ' e ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 1 , eArgTypeLineNum , " The line at which to stop stepping - defaults to the next line and only supported for step-in and step-over. You can also pass the string 'block' to step to the end of the current block. This is particularly useful in conjunction with --step-target to step through a complex calling sequence. " } ,
{ LLDB_OPT_SET_1 , false , " run-mode " , ' m ' , OptionParser : : eRequiredArgument , nullptr , g_tri_running_mode , 0 , eArgTypeRunMode , " Determine how to run other threads while stepping the current thread. " } ,
{ LLDB_OPT_SET_1 , false , " step-over-regexp " , ' r ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeRegularExpression , " A regular expression that defines function names to not to stop at when stepping in. " } ,
{ LLDB_OPT_SET_1 , false , " step-in-target " , ' t ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeFunctionName , " The name of the directly called function step in should stop at when stepping into. " } ,
{ LLDB_OPT_SET_2 , false , " python-class " , ' C ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypePythonClass , " The name of the class that will manage this step - only supported for Scripted Step. " }
// clang-format on
} ;
2016-09-07 04:57:50 +08:00
class CommandObjectThreadStepWithTypeAndScope : 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 ( ) {
// Keep default values of all options in one place: OptionParsingStarting
// ()
OptionParsingStarting ( nullptr ) ;
}
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
~ CommandOptions ( ) override = default ;
2010-06-09 00:52:24 +08:00
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 ;
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
switch ( short_option ) {
case ' a ' : {
bool success ;
2018-04-10 17:03:59 +08:00
bool avoid_no_debug =
OptionArgParser : : ToBoolean ( option_arg , true , & success ) ;
2016-09-07 04:57:50 +08:00
if ( ! success )
error . SetErrorStringWithFormat (
" invalid boolean value for option '%c' " , short_option ) ;
else {
m_step_in_avoid_no_debug =
avoid_no_debug ? eLazyBoolYes : eLazyBoolNo ;
2010-06-09 00:52:24 +08:00
}
2016-09-07 04:57:50 +08:00
} break ;
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
case ' A ' : {
bool success ;
2018-04-10 17:03:59 +08:00
bool avoid_no_debug =
OptionArgParser : : ToBoolean ( option_arg , true , & success ) ;
2016-09-07 04:57:50 +08:00
if ( ! success )
error . SetErrorStringWithFormat (
" invalid boolean value for option '%c' " , short_option ) ;
else {
m_step_out_avoid_no_debug =
avoid_no_debug ? eLazyBoolYes : eLazyBoolNo ;
}
} break ;
case ' c ' :
2016-11-13 00:56:47 +08:00
if ( option_arg . getAsInteger ( 0 , m_step_count ) )
error . SetErrorStringWithFormat ( " invalid step count '%s' " ,
option_arg . str ( ) . c_str ( ) ) ;
2016-09-07 04:57:50 +08:00
break ;
case ' C ' :
m_class_name . clear ( ) ;
m_class_name . assign ( option_arg ) ;
break ;
case ' m ' : {
OptionEnumValueElement * enum_values =
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
GetDefinitions ( ) [ option_idx ] . enum_values ;
2018-04-10 17:03:59 +08:00
m_run_mode = ( lldb : : RunMode ) OptionArgParser : : ToOptionEnum (
2016-11-13 00:56:47 +08:00
option_arg , enum_values , eOnlyDuringStepping , error ) ;
2016-09-07 04:57:50 +08:00
} break ;
2016-11-13 00:56:47 +08:00
case ' e ' :
if ( option_arg = = " block " ) {
2016-09-07 04:57:50 +08:00
m_end_line_is_block_end = 1 ;
break ;
}
2016-11-13 00:56:47 +08:00
if ( option_arg . getAsInteger ( 0 , m_end_line ) )
2016-09-07 04:57:50 +08:00
error . SetErrorStringWithFormat ( " invalid end line number '%s' " ,
2016-11-13 00:56:47 +08:00
option_arg . str ( ) . c_str ( ) ) ;
2016-09-07 04:57:50 +08:00
break ;
case ' r ' :
m_avoid_regexp . clear ( ) ;
m_avoid_regexp . assign ( option_arg ) ;
break ;
case ' t ' :
m_step_in_target . clear ( ) ;
m_step_in_target . assign ( option_arg ) ;
break ;
default :
error . SetErrorStringWithFormat ( " invalid short option character '%c' " ,
short_option ) ;
break ;
}
return error ;
2010-06-09 00:52:24 +08:00
}
2016-09-07 04:57:50 +08:00
void OptionParsingStarting ( ExecutionContext * execution_context ) override {
m_step_in_avoid_no_debug = eLazyBoolCalculate ;
m_step_out_avoid_no_debug = eLazyBoolCalculate ;
m_run_mode = eOnlyDuringStepping ;
// Check if we are in Non-Stop mode
TargetSP target_sp =
execution_context ? execution_context - > GetTargetSP ( ) : TargetSP ( ) ;
if ( target_sp & & target_sp - > GetNonStopModeEnabled ( ) )
m_run_mode = eOnlyThisThread ;
m_avoid_regexp . clear ( ) ;
m_step_in_target . clear ( ) ;
m_class_name . clear ( ) ;
m_step_count = 1 ;
m_end_line = LLDB_INVALID_LINE_NUMBER ;
m_end_line_is_block_end = false ;
2010-06-09 00:52:24 +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_thread_step_scope_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
// Instance variables to hold the values for command options.
LazyBool m_step_in_avoid_no_debug ;
LazyBool m_step_out_avoid_no_debug ;
RunMode m_run_mode ;
std : : string m_avoid_regexp ;
std : : string m_step_in_target ;
std : : string m_class_name ;
uint32_t m_step_count ;
uint32_t m_end_line ;
bool m_end_line_is_block_end ;
} ;
CommandObjectThreadStepWithTypeAndScope ( CommandInterpreter & interpreter ,
const char * name , const char * help ,
const char * syntax ,
StepType step_type ,
StepScope step_scope )
: CommandObjectParsed ( interpreter , name , help , syntax ,
eCommandRequiresProcess | eCommandRequiresThread |
eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched |
eCommandProcessMustBePaused ) ,
m_step_type ( step_type ) , m_step_scope ( step_scope ) , m_options ( ) {
CommandArgumentEntry arg ;
CommandArgumentData thread_id_arg ;
// Define the first (and only) variant of this arg.
thread_id_arg . arg_type = eArgTypeThreadID ;
thread_id_arg . arg_repetition = eArgRepeatOptional ;
// There is only one variant this argument could be; put it into the
// argument entry.
arg . push_back ( thread_id_arg ) ;
// Push the data for the first argument into the m_arguments vector.
m_arguments . push_back ( arg ) ;
}
~ CommandObjectThreadStepWithTypeAndScope ( ) override = default ;
Options * GetOptions ( ) override { return & m_options ; }
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
protected :
bool DoExecute ( Args & command , CommandReturnObject & result ) override {
Process * process = m_exe_ctx . GetProcessPtr ( ) ;
bool synchronous_execution = m_interpreter . GetSynchronous ( ) ;
const uint32_t num_threads = process - > GetThreadList ( ) . GetSize ( ) ;
Thread * thread = nullptr ;
if ( command . GetArgumentCount ( ) = = 0 ) {
thread = GetDefaultThread ( ) ;
if ( thread = = nullptr ) {
result . AppendError ( " no selected thread in process " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
} else {
const char * thread_idx_cstr = command . GetArgumentAtIndex ( 0 ) ;
uint32_t step_thread_idx =
StringConvert : : ToUInt32 ( thread_idx_cstr , LLDB_INVALID_INDEX32 ) ;
if ( step_thread_idx = = LLDB_INVALID_INDEX32 ) {
result . AppendErrorWithFormat ( " invalid thread index '%s'. \n " ,
thread_idx_cstr ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
thread =
process - > GetThreadList ( ) . FindThreadByIndexID ( step_thread_idx ) . get ( ) ;
if ( thread = = nullptr ) {
result . AppendErrorWithFormat (
" Thread index %u is out of range (valid values are 0 - %u). \n " ,
step_thread_idx , num_threads ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
}
2016-03-12 10:45:34 +08:00
2016-09-07 04:57:50 +08:00
if ( m_step_type = = eStepTypeScripted ) {
if ( m_options . m_class_name . empty ( ) ) {
result . AppendErrorWithFormat ( " empty class name for scripted step. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
} else if ( ! m_interpreter . GetScriptInterpreter ( ) - > CheckObjectExists (
m_options . m_class_name . c_str ( ) ) ) {
result . AppendErrorWithFormat (
" class for scripted step: \" %s \" does not exist. " ,
m_options . m_class_name . c_str ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
}
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
if ( m_options . m_end_line ! = LLDB_INVALID_LINE_NUMBER & &
m_step_type ! = eStepTypeInto ) {
result . AppendErrorWithFormat (
" end line option is only valid for step into " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
const bool abort_other_plans = false ;
const lldb : : RunMode stop_other_threads = m_options . m_run_mode ;
// This is a bit unfortunate, but not all the commands in this command
2018-05-01 00:49:04 +08:00
// object support only while stepping, so I use the bool for them.
2016-09-07 04:57:50 +08:00
bool bool_stop_other_threads ;
if ( m_options . m_run_mode = = eAllThreads )
bool_stop_other_threads = false ;
else if ( m_options . m_run_mode = = eOnlyDuringStepping )
bool_stop_other_threads =
( m_step_type ! = eStepTypeOut & & m_step_type ! = eStepTypeScripted ) ;
else
bool_stop_other_threads = true ;
ThreadPlanSP new_plan_sp ;
if ( m_step_type = = eStepTypeInto ) {
StackFrame * frame = thread - > GetStackFrameAtIndex ( 0 ) . get ( ) ;
assert ( frame ! = nullptr ) ;
if ( frame - > HasDebugInformation ( ) ) {
AddressRange range ;
SymbolContext sc = frame - > GetSymbolContext ( eSymbolContextEverything ) ;
if ( m_options . m_end_line ! = LLDB_INVALID_LINE_NUMBER ) {
2017-05-12 12:51:55 +08:00
Status error ;
2016-09-07 04:57:50 +08:00
if ( ! sc . GetAddressRangeFromHereToEndLine ( m_options . m_end_line , range ,
error ) ) {
result . AppendErrorWithFormat ( " invalid end-line option: %s. " ,
error . AsCString ( ) ) ;
2016-02-10 11:25:24 +08:00
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2016-09-07 04:57:50 +08:00
}
} else if ( m_options . m_end_line_is_block_end ) {
2017-05-12 12:51:55 +08:00
Status error ;
2016-09-07 04:57:50 +08:00
Block * block = frame - > GetSymbolContext ( eSymbolContextBlock ) . block ;
if ( ! block ) {
result . AppendErrorWithFormat ( " Could not find the current block. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
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
return false ;
2016-09-07 04:57:50 +08:00
}
AddressRange block_range ;
Address pc_address = frame - > GetFrameCodeAddress ( ) ;
block - > GetRangeContainingAddress ( pc_address , block_range ) ;
if ( ! block_range . GetBaseAddress ( ) . IsValid ( ) ) {
result . AppendErrorWithFormat (
" Could not find the current block address. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
lldb : : addr_t pc_offset_in_block =
pc_address . GetFileAddress ( ) -
block_range . GetBaseAddress ( ) . GetFileAddress ( ) ;
lldb : : addr_t range_length =
block_range . GetByteSize ( ) - pc_offset_in_block ;
range = AddressRange ( pc_address , range_length ) ;
} else {
range = sc . line_entry . range ;
}
new_plan_sp = thread - > QueueThreadPlanForStepInRange (
abort_other_plans , range ,
frame - > GetSymbolContext ( eSymbolContextEverything ) ,
m_options . m_step_in_target . c_str ( ) , stop_other_threads ,
m_options . m_step_in_avoid_no_debug ,
m_options . m_step_out_avoid_no_debug ) ;
if ( new_plan_sp & & ! m_options . m_avoid_regexp . empty ( ) ) {
ThreadPlanStepInRange * step_in_range_plan =
static_cast < ThreadPlanStepInRange * > ( new_plan_sp . get ( ) ) ;
step_in_range_plan - > SetAvoidRegexp ( m_options . m_avoid_regexp . c_str ( ) ) ;
}
} else
new_plan_sp = thread - > QueueThreadPlanForStepSingleInstruction (
false , abort_other_plans , bool_stop_other_threads ) ;
} else if ( m_step_type = = eStepTypeOver ) {
StackFrame * frame = thread - > GetStackFrameAtIndex ( 0 ) . get ( ) ;
if ( frame - > HasDebugInformation ( ) )
new_plan_sp = thread - > QueueThreadPlanForStepOverRange (
abort_other_plans ,
frame - > GetSymbolContext ( eSymbolContextEverything ) . line_entry ,
frame - > GetSymbolContext ( eSymbolContextEverything ) ,
stop_other_threads , m_options . m_step_out_avoid_no_debug ) ;
else
new_plan_sp = thread - > QueueThreadPlanForStepSingleInstruction (
true , abort_other_plans , bool_stop_other_threads ) ;
} else if ( m_step_type = = eStepTypeTrace ) {
new_plan_sp = thread - > QueueThreadPlanForStepSingleInstruction (
false , abort_other_plans , bool_stop_other_threads ) ;
} else if ( m_step_type = = eStepTypeTraceOver ) {
new_plan_sp = thread - > QueueThreadPlanForStepSingleInstruction (
true , abort_other_plans , bool_stop_other_threads ) ;
} else if ( m_step_type = = eStepTypeOut ) {
new_plan_sp = thread - > QueueThreadPlanForStepOut (
abort_other_plans , nullptr , false , bool_stop_other_threads , eVoteYes ,
eVoteNoOpinion , thread - > GetSelectedFrameIndex ( ) ,
m_options . m_step_out_avoid_no_debug ) ;
} else if ( m_step_type = = eStepTypeScripted ) {
new_plan_sp = thread - > QueueThreadPlanForStepScripted (
abort_other_plans , m_options . m_class_name . c_str ( ) ,
bool_stop_other_threads ) ;
} else {
result . AppendError ( " step type is not supported " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
2014-10-21 09:00:42 +08:00
2016-09-07 04:57:50 +08:00
// If we got a new plan, then set it to be a master plan (User level Plans
2018-05-01 00:49:04 +08:00
// should be master plans so that they can be interruptible). Then resume
// the process.
2016-09-07 04:57:50 +08:00
if ( new_plan_sp ) {
new_plan_sp - > SetIsMasterPlan ( true ) ;
new_plan_sp - > SetOkayToDiscard ( false ) ;
if ( m_options . m_step_count > 1 ) {
2017-05-25 10:24:18 +08:00
if ( ! new_plan_sp - > SetIterationCount ( m_options . m_step_count ) ) {
2016-09-07 04:57:50 +08:00
result . AppendWarning (
" step operation does not support iteration count. " ) ;
}
}
process - > GetThreadList ( ) . SetSelectedThreadByID ( thread - > GetID ( ) ) ;
const uint32_t iohandler_id = process - > GetIOHandlerID ( ) ;
StreamString stream ;
2017-05-12 12:51:55 +08:00
Status error ;
2016-09-07 04:57:50 +08:00
if ( synchronous_execution )
error = process - > ResumeSynchronous ( & stream ) ;
else
error = process - > Resume ( ) ;
2017-09-20 02:07:33 +08:00
if ( ! error . Success ( ) ) {
result . AppendMessage ( error . AsCString ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
2016-09-07 04:57:50 +08:00
// There is a race condition where this thread will return up the call
2018-05-01 00:49:04 +08:00
// stack to the main command handler and show an (lldb) prompt before
// HandlePrivateEvent (from PrivateStateThread) has a chance to call
// PushProcessIOHandler().
2016-09-07 04:57:50 +08:00
process - > SyncIOHandler ( iohandler_id , 2000 ) ;
if ( synchronous_execution ) {
// If any state changed events had anything to say, add that to the
// result
2016-11-17 05:15:24 +08:00
if ( stream . GetSize ( ) > 0 )
result . AppendMessage ( stream . GetString ( ) ) ;
2016-09-07 04:57:50 +08:00
process - > GetThreadList ( ) . SetSelectedThreadByID ( thread - > GetID ( ) ) ;
result . SetDidChangeProcessState ( true ) ;
result . SetStatus ( eReturnStatusSuccessFinishNoResult ) ;
} else {
result . SetStatus ( eReturnStatusSuccessContinuingNoResult ) ;
}
} else {
result . AppendError ( " Couldn't find thread plan to implement step type. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
2010-06-09 00:52:24 +08:00
}
2016-09-07 04:57:50 +08:00
return result . Succeeded ( ) ;
}
2010-06-09 00:52:24 +08:00
protected :
2016-09-07 04:57:50 +08:00
StepType m_step_type ;
StepScope m_step_scope ;
CommandOptions m_options ;
2010-06-09 00:52:24 +08:00
} ;
//-------------------------------------------------------------------------
// CommandObjectThreadContinue
//-------------------------------------------------------------------------
2016-09-07 04:57:50 +08:00
class CommandObjectThreadContinue : public CommandObjectParsed {
2010-06-09 00:52:24 +08:00
public :
2016-09-07 04:57:50 +08:00
CommandObjectThreadContinue ( CommandInterpreter & interpreter )
: CommandObjectParsed (
interpreter , " thread continue " ,
" Continue execution of the current target process. One "
" or more threads may be specified, by default all "
" threads continue. " ,
nullptr ,
eCommandRequiresThread | eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched | eCommandProcessMustBePaused ) {
CommandArgumentEntry arg ;
CommandArgumentData thread_idx_arg ;
// Define the first (and only) variant of this arg.
thread_idx_arg . arg_type = eArgTypeThreadIndex ;
thread_idx_arg . arg_repetition = eArgRepeatPlus ;
// There is only one variant this argument could be; put it into the
// argument entry.
arg . push_back ( thread_idx_arg ) ;
// Push the data for the first argument into the m_arguments vector.
m_arguments . push_back ( arg ) ;
}
~ CommandObjectThreadContinue ( ) override = default ;
bool DoExecute ( Args & command , CommandReturnObject & result ) override {
bool synchronous_execution = m_interpreter . GetSynchronous ( ) ;
if ( ! m_interpreter . GetDebugger ( ) . GetSelectedTarget ( ) ) {
result . AppendError ( " invalid target, create a debug target using the "
" 'target create' command " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2010-06-09 00:52:24 +08:00
}
2016-09-07 04:57:50 +08:00
Process * process = m_exe_ctx . GetProcessPtr ( ) ;
if ( process = = nullptr ) {
result . AppendError ( " no process exists. Cannot continue " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
2013-09-13 03:15:05 +08:00
2016-09-07 04:57:50 +08:00
StateType state = process - > GetState ( ) ;
if ( ( state = = eStateCrashed ) | | ( state = = eStateStopped ) | |
( state = = eStateSuspended ) ) {
const size_t argc = command . GetArgumentCount ( ) ;
if ( argc > 0 ) {
2018-05-01 00:49:04 +08:00
// These two lines appear at the beginning of both blocks in this
// if..else, but that is because we need to release the lock before
// calling process->Resume below.
2016-09-07 04:57:50 +08:00
std : : lock_guard < std : : recursive_mutex > guard (
process - > GetThreadList ( ) . GetMutex ( ) ) ;
const uint32_t num_threads = process - > GetThreadList ( ) . GetSize ( ) ;
std : : vector < Thread * > resume_threads ;
2016-10-06 07:40:23 +08:00
for ( auto & entry : command . entries ( ) ) {
uint32_t thread_idx ;
if ( entry . ref . getAsInteger ( 0 , thread_idx ) ) {
2016-09-07 04:57:50 +08:00
result . AppendErrorWithFormat (
2016-10-06 07:40:23 +08:00
" invalid thread index argument: \" %s \" . \n " , entry . c_str ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
Thread * thread =
process - > GetThreadList ( ) . FindThreadByIndexID ( thread_idx ) . get ( ) ;
if ( thread ) {
resume_threads . push_back ( thread ) ;
} else {
result . AppendErrorWithFormat ( " invalid thread index %u. \n " ,
thread_idx ) ;
2016-09-07 04:57:50 +08:00
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
}
if ( resume_threads . empty ( ) ) {
result . AppendError ( " no valid thread indexes were specified " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
} else {
if ( resume_threads . size ( ) = = 1 )
result . AppendMessageWithFormat ( " Resuming thread: " ) ;
else
result . AppendMessageWithFormat ( " Resuming threads: " ) ;
for ( uint32_t idx = 0 ; idx < num_threads ; + + idx ) {
Thread * thread =
process - > GetThreadList ( ) . GetThreadAtIndex ( idx ) . get ( ) ;
std : : vector < Thread * > : : iterator this_thread_pos =
find ( resume_threads . begin ( ) , resume_threads . end ( ) , thread ) ;
if ( this_thread_pos ! = resume_threads . end ( ) ) {
resume_threads . erase ( this_thread_pos ) ;
if ( ! resume_threads . empty ( ) )
result . AppendMessageWithFormat ( " %u, " , thread - > GetIndexID ( ) ) ;
else
result . AppendMessageWithFormat ( " %u " , thread - > GetIndexID ( ) ) ;
const bool override_suspend = true ;
thread - > SetResumeState ( eStateRunning , override_suspend ) ;
} else {
thread - > SetResumeState ( eStateSuspended ) ;
2010-06-09 00:52:24 +08:00
}
2016-09-07 04:57:50 +08:00
}
result . AppendMessageWithFormat ( " in process % " PRIu64 " \n " ,
process - > GetID ( ) ) ;
}
} else {
2018-05-01 00:49:04 +08:00
// These two lines appear at the beginning of both blocks in this
// if..else, but that is because we need to release the lock before
// calling process->Resume below.
2016-09-07 04:57:50 +08:00
std : : lock_guard < std : : recursive_mutex > guard (
process - > GetThreadList ( ) . GetMutex ( ) ) ;
const uint32_t num_threads = process - > GetThreadList ( ) . GetSize ( ) ;
Thread * current_thread = GetDefaultThread ( ) ;
if ( current_thread = = nullptr ) {
result . AppendError ( " the process doesn't have a current thread " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
// Set the actions that the threads should each take when resuming
for ( uint32_t idx = 0 ; idx < num_threads ; + + idx ) {
Thread * thread = process - > GetThreadList ( ) . GetThreadAtIndex ( idx ) . get ( ) ;
if ( thread = = current_thread ) {
result . AppendMessageWithFormat ( " Resuming thread 0x%4.4 " PRIx64
" in process % " PRIu64 " \n " ,
thread - > GetID ( ) , process - > GetID ( ) ) ;
const bool override_suspend = true ;
thread - > SetResumeState ( eStateRunning , override_suspend ) ;
} else {
thread - > SetResumeState ( eStateSuspended ) ;
}
}
}
StreamString stream ;
2017-05-12 12:51:55 +08:00
Status error ;
2016-09-07 04:57:50 +08:00
if ( synchronous_execution )
error = process - > ResumeSynchronous ( & stream ) ;
else
error = process - > Resume ( ) ;
// We should not be holding the thread list lock when we do this.
if ( error . Success ( ) ) {
result . AppendMessageWithFormat ( " Process % " PRIu64 " resuming \n " ,
process - > GetID ( ) ) ;
if ( synchronous_execution ) {
// If any state changed events had anything to say, add that to the
// result
2016-11-17 05:15:24 +08:00
if ( stream . GetSize ( ) > 0 )
result . AppendMessage ( stream . GetString ( ) ) ;
2016-09-07 04:57:50 +08:00
result . SetDidChangeProcessState ( true ) ;
result . SetStatus ( eReturnStatusSuccessFinishNoResult ) ;
} else {
result . SetStatus ( eReturnStatusSuccessContinuingNoResult ) ;
}
} else {
result . AppendErrorWithFormat ( " Failed to resume process: %s \n " ,
error . AsCString ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
}
} else {
result . AppendErrorWithFormat (
" Process cannot be continued from its current state (%s). \n " ,
StateAsCString ( state ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
2010-06-09 00:52:24 +08:00
}
2016-09-07 04:57:50 +08:00
return result . Succeeded ( ) ;
}
2010-06-09 00:52:24 +08:00
} ;
//-------------------------------------------------------------------------
// CommandObjectThreadUntil
//-------------------------------------------------------------------------
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_thread_until_options [ ] = {
// clang-format off
{ LLDB_OPT_SET_1 , false , " frame " , ' f ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeFrameIndex , " Frame index for until operation - defaults to 0 " } ,
{ LLDB_OPT_SET_1 , false , " thread " , ' t ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeThreadIndex , " Thread index for the thread for until operation " } ,
{ LLDB_OPT_SET_1 , false , " run-mode " , ' m ' , OptionParser : : eRequiredArgument , nullptr , g_duo_running_mode , 0 , eArgTypeRunMode , " Determine how to run other threads while stepping this one " } ,
{ LLDB_OPT_SET_1 , false , " address " , ' a ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeAddressOrExpression , " Run until we reach the specified address, or leave the function - can be specified multiple times. " }
// clang-format on
} ;
2016-09-07 04:57:50 +08:00
class CommandObjectThreadUntil : public CommandObjectParsed {
2010-06-09 00:52:24 +08:00
public :
2016-09-07 04:57:50 +08:00
class CommandOptions : public Options {
public :
uint32_t m_thread_idx ;
uint32_t m_frame_idx ;
CommandOptions ( )
: Options ( ) , m_thread_idx ( LLDB_INVALID_THREAD_ID ) ,
m_frame_idx ( LLDB_INVALID_FRAME_ID ) {
// Keep default values of all options in one place: OptionParsingStarting
// ()
OptionParsingStarting ( nullptr ) ;
}
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
~ 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 ' a ' : {
2018-04-10 17:03:59 +08:00
lldb : : addr_t tmp_addr = OptionArgParser : : ToAddress (
2016-09-07 04:57:50 +08:00
execution_context , option_arg , LLDB_INVALID_ADDRESS , & error ) ;
if ( error . Success ( ) )
m_until_addrs . push_back ( tmp_addr ) ;
} break ;
case ' t ' :
2016-11-13 00:56:47 +08:00
if ( option_arg . getAsInteger ( 0 , m_thread_idx ) ) {
m_thread_idx = LLDB_INVALID_INDEX32 ;
2016-09-07 04:57:50 +08:00
error . SetErrorStringWithFormat ( " invalid thread index '%s' " ,
2016-11-13 00:56:47 +08:00
option_arg . str ( ) . c_str ( ) ) ;
2016-09-07 04:57:50 +08:00
}
break ;
case ' f ' :
2016-11-13 00:56:47 +08:00
if ( option_arg . getAsInteger ( 0 , m_frame_idx ) ) {
m_frame_idx = LLDB_INVALID_FRAME_ID ;
2016-09-07 04:57:50 +08:00
error . SetErrorStringWithFormat ( " invalid frame index '%s' " ,
2016-11-13 00:56:47 +08:00
option_arg . str ( ) . c_str ( ) ) ;
2016-09-07 04:57:50 +08:00
}
break ;
case ' m ' : {
OptionEnumValueElement * enum_values =
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
GetDefinitions ( ) [ option_idx ] . enum_values ;
2018-04-10 17:03:59 +08:00
lldb : : RunMode run_mode = ( lldb : : RunMode ) OptionArgParser : : ToOptionEnum (
2016-11-13 00:56:47 +08:00
option_arg , enum_values , eOnlyDuringStepping , error ) ;
2016-09-07 04:57:50 +08:00
if ( error . Success ( ) ) {
if ( run_mode = = eAllThreads )
2010-06-09 00:52:24 +08:00
m_stop_others = false ;
2016-09-07 04:57:50 +08:00
else
m_stop_others = true ;
}
} break ;
default :
error . SetErrorStringWithFormat ( " invalid short option character '%c' " ,
short_option ) ;
break ;
}
return error ;
}
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
void OptionParsingStarting ( ExecutionContext * execution_context ) override {
m_thread_idx = LLDB_INVALID_THREAD_ID ;
m_frame_idx = 0 ;
m_stop_others = false ;
m_until_addrs . clear ( ) ;
}
2010-06-09 00:52:24 +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_thread_until_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-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
uint32_t m_step_thread_idx ;
bool m_stop_others ;
std : : vector < lldb : : addr_t > m_until_addrs ;
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
// Instance variables to hold the values for command options.
} ;
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
CommandObjectThreadUntil ( CommandInterpreter & interpreter )
: CommandObjectParsed (
interpreter , " thread until " ,
" Continue until a line number or address is reached by the "
" current or specified thread. Stops when returning from "
2016-11-19 06:06:10 +08:00
" the current function as a safety measure. "
" The target line number(s) are given as arguments, and if more than one "
2016-11-24 18:01:34 +08:00
" is provided, stepping will stop when the first one is hit. " ,
2016-09-07 04:57:50 +08:00
nullptr ,
eCommandRequiresThread | eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched | eCommandProcessMustBePaused ) ,
m_options ( ) {
CommandArgumentEntry arg ;
CommandArgumentData line_num_arg ;
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
// Define the first (and only) variant of this arg.
line_num_arg . arg_type = eArgTypeLineNum ;
line_num_arg . arg_repetition = eArgRepeatPlain ;
2010-06-09 00:52:24 +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 ( line_num_arg ) ;
2010-06-09 00:52:24 +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
~ CommandObjectThreadUntil ( ) 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-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
protected :
bool DoExecute ( Args & command , CommandReturnObject & result ) override {
bool synchronous_execution = m_interpreter . GetSynchronous ( ) ;
Target * target = m_interpreter . GetDebugger ( ) . GetSelectedTarget ( ) . get ( ) ;
if ( target = = nullptr ) {
result . AppendError ( " invalid target, create a debug target using the "
" 'target create' command " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
Process * process = m_exe_ctx . GetProcessPtr ( ) ;
if ( process = = nullptr ) {
result . AppendError ( " need a valid process to step " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
} else {
Thread * thread = nullptr ;
std : : vector < uint32_t > line_numbers ;
if ( command . GetArgumentCount ( ) > = 1 ) {
size_t num_args = command . GetArgumentCount ( ) ;
for ( size_t i = 0 ; i < num_args ; i + + ) {
uint32_t line_number ;
2016-11-19 06:06:10 +08:00
line_number = StringConvert : : ToUInt32 ( command . GetArgumentAtIndex ( i ) ,
2016-09-07 04:57:50 +08:00
UINT32_MAX ) ;
if ( line_number = = UINT32_MAX ) {
result . AppendErrorWithFormat ( " invalid line number: '%s'. \n " ,
2016-11-19 06:06:10 +08:00
command . GetArgumentAtIndex ( i ) ) ;
2016-09-07 04:57:50 +08:00
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
} else
line_numbers . push_back ( line_number ) ;
}
} else if ( m_options . m_until_addrs . empty ( ) ) {
result . AppendErrorWithFormat ( " No line number or address provided: \n %s " ,
2016-11-15 08:45:18 +08:00
GetSyntax ( ) . str ( ) . c_str ( ) ) ;
2016-09-07 04:57:50 +08:00
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
if ( m_options . m_thread_idx = = LLDB_INVALID_THREAD_ID ) {
thread = GetDefaultThread ( ) ;
} else {
thread = process - > GetThreadList ( )
. FindThreadByIndexID ( m_options . m_thread_idx )
. get ( ) ;
}
if ( thread = = nullptr ) {
const uint32_t num_threads = process - > GetThreadList ( ) . GetSize ( ) ;
result . AppendErrorWithFormat (
" Thread index %u is out of range (valid values are 0 - %u). \n " ,
m_options . m_thread_idx , num_threads ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
const bool abort_other_plans = false ;
StackFrame * frame =
thread - > GetStackFrameAtIndex ( m_options . m_frame_idx ) . get ( ) ;
if ( frame = = nullptr ) {
result . AppendErrorWithFormat (
" Frame index %u is out of range for thread %u. \n " ,
m_options . m_frame_idx , m_options . m_thread_idx ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
ThreadPlanSP new_plan_sp ;
if ( frame - > HasDebugInformation ( ) ) {
2018-05-01 00:49:04 +08:00
// Finally we got here... Translate the given line number to a bunch
// of addresses:
2016-09-07 04:57:50 +08:00
SymbolContext sc ( frame - > GetSymbolContext ( eSymbolContextCompUnit ) ) ;
LineTable * line_table = nullptr ;
if ( sc . comp_unit )
line_table = sc . comp_unit - > GetLineTable ( ) ;
if ( line_table = = nullptr ) {
result . AppendErrorWithFormat ( " Failed to resolve the line table for "
" frame %u of thread index %u. \n " ,
m_options . m_frame_idx ,
m_options . m_thread_idx ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
LineEntry function_start ;
uint32_t index_ptr = 0 , end_ptr ;
std : : vector < addr_t > address_list ;
// Find the beginning & end index of the
AddressRange fun_addr_range = sc . function - > GetAddressRange ( ) ;
Address fun_start_addr = fun_addr_range . GetBaseAddress ( ) ;
line_table - > FindLineEntryByAddress ( fun_start_addr , function_start ,
& index_ptr ) ;
Address fun_end_addr ( fun_start_addr . GetSection ( ) ,
fun_start_addr . GetOffset ( ) +
fun_addr_range . GetByteSize ( ) ) ;
bool all_in_function = true ;
line_table - > FindLineEntryByAddress ( fun_end_addr , function_start ,
& end_ptr ) ;
for ( uint32_t line_number : line_numbers ) {
uint32_t start_idx_ptr = index_ptr ;
while ( start_idx_ptr < = end_ptr ) {
LineEntry line_entry ;
const bool exact = false ;
start_idx_ptr = sc . comp_unit - > FindLineEntry (
start_idx_ptr , line_number , sc . comp_unit , exact , & line_entry ) ;
if ( start_idx_ptr = = UINT32_MAX )
break ;
addr_t address =
line_entry . range . GetBaseAddress ( ) . GetLoadAddress ( target ) ;
if ( address ! = LLDB_INVALID_ADDRESS ) {
if ( fun_addr_range . ContainsLoadAddress ( address , target ) )
address_list . push_back ( address ) ;
else
all_in_function = false ;
2010-06-09 00:52:24 +08:00
}
2016-09-07 04:57:50 +08:00
start_idx_ptr + + ;
}
}
for ( lldb : : addr_t address : m_options . m_until_addrs ) {
if ( fun_addr_range . ContainsLoadAddress ( address , target ) )
address_list . push_back ( address ) ;
else
all_in_function = false ;
}
if ( address_list . empty ( ) ) {
if ( all_in_function )
result . AppendErrorWithFormat (
" No line entries matching until target. \n " ) ;
else
result . AppendErrorWithFormat (
" Until target outside of the current function. \n " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
new_plan_sp = thread - > QueueThreadPlanForStepUntil (
abort_other_plans , & address_list . front ( ) , address_list . size ( ) ,
m_options . m_stop_others , m_options . m_frame_idx ) ;
// User level plans should be master plans so they can be interrupted
2018-05-01 00:49:04 +08:00
// (e.g. by hitting a breakpoint) and other plans executed by the user
// (stepping around the breakpoint) and then a "continue" will resume
// the original plan.
2016-09-07 04:57:50 +08:00
new_plan_sp - > SetIsMasterPlan ( true ) ;
new_plan_sp - > SetOkayToDiscard ( false ) ;
} else {
result . AppendErrorWithFormat (
" Frame index %u of thread %u has no debug information. \n " ,
m_options . m_frame_idx , m_options . m_thread_idx ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
process - > GetThreadList ( ) . SetSelectedThreadByID ( m_options . m_thread_idx ) ;
StreamString stream ;
2017-05-12 12:51:55 +08:00
Status error ;
2016-09-07 04:57:50 +08:00
if ( synchronous_execution )
error = process - > ResumeSynchronous ( & stream ) ;
else
error = process - > Resume ( ) ;
if ( error . Success ( ) ) {
result . AppendMessageWithFormat ( " Process % " PRIu64 " resuming \n " ,
process - > GetID ( ) ) ;
if ( synchronous_execution ) {
// If any state changed events had anything to say, add that to the
// result
2016-11-17 05:15:24 +08:00
if ( stream . GetSize ( ) > 0 )
result . AppendMessage ( stream . GetString ( ) ) ;
2016-09-07 04:57:50 +08:00
result . SetDidChangeProcessState ( true ) ;
result . SetStatus ( eReturnStatusSuccessFinishNoResult ) ;
} else {
result . SetStatus ( eReturnStatusSuccessContinuingNoResult ) ;
}
} else {
result . AppendErrorWithFormat ( " Failed to resume process: %s. \n " ,
error . AsCString ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
}
2010-06-09 00:52:24 +08:00
}
2016-09-07 04:57:50 +08:00
return result . Succeeded ( ) ;
}
2012-06-09 05:56:10 +08:00
2016-09-07 04:57:50 +08:00
CommandOptions m_options ;
2010-06-09 00:52:24 +08:00
} ;
//-------------------------------------------------------------------------
// CommandObjectThreadSelect
//-------------------------------------------------------------------------
2016-09-07 04:57:50 +08:00
class CommandObjectThreadSelect : public CommandObjectParsed {
2010-06-09 00:52:24 +08:00
public :
2016-09-07 04:57:50 +08:00
CommandObjectThreadSelect ( CommandInterpreter & interpreter )
: CommandObjectParsed ( interpreter , " thread select " ,
" Change the currently selected thread. " , nullptr ,
eCommandRequiresProcess | eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched |
eCommandProcessMustBePaused ) {
CommandArgumentEntry arg ;
CommandArgumentData thread_idx_arg ;
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
// Define the first (and only) variant of this arg.
thread_idx_arg . arg_type = eArgTypeThreadIndex ;
thread_idx_arg . arg_repetition = eArgRepeatPlain ;
2010-06-09 00:52:24 +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 ( thread_idx_arg ) ;
2010-06-09 00:52:24 +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
~ CommandObjectThreadSelect ( ) override = default ;
2010-06-09 00:52:24 +08:00
2016-09-07 04:57:50 +08:00
protected :
bool DoExecute ( Args & command , CommandReturnObject & result ) override {
Process * process = m_exe_ctx . GetProcessPtr ( ) ;
if ( process = = nullptr ) {
result . AppendError ( " no process " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
} else if ( command . GetArgumentCount ( ) ! = 1 ) {
result . AppendErrorWithFormat (
" '%s' takes exactly one thread index argument: \n Usage: %s \n " ,
m_cmd_name . c_str ( ) , m_cmd_syntax . c_str ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2010-06-09 00:52:24 +08:00
}
2016-09-07 04:57:50 +08:00
uint32_t index_id =
StringConvert : : ToUInt32 ( command . GetArgumentAtIndex ( 0 ) , 0 , 0 ) ;
Thread * new_thread =
process - > GetThreadList ( ) . FindThreadByIndexID ( index_id ) . get ( ) ;
if ( new_thread = = nullptr ) {
result . AppendErrorWithFormat ( " invalid thread #%s. \n " ,
command . GetArgumentAtIndex ( 0 ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
process - > GetThreadList ( ) . SetSelectedThreadByID ( new_thread - > GetID ( ) , true ) ;
result . SetStatus ( eReturnStatusSuccessFinishNoResult ) ;
return result . Succeeded ( ) ;
}
2010-06-09 00:52:24 +08:00
} ;
//-------------------------------------------------------------------------
// CommandObjectThreadList
//-------------------------------------------------------------------------
2016-09-07 04:57:50 +08:00
class CommandObjectThreadList : public CommandObjectParsed {
2010-06-23 09:19:29 +08:00
public :
2016-09-07 04:57:50 +08:00
CommandObjectThreadList ( CommandInterpreter & interpreter )
: CommandObjectParsed (
interpreter , " thread list " ,
" Show a summary of each thread in the current target process. " ,
" thread list " ,
eCommandRequiresProcess | eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched | eCommandProcessMustBePaused ) { }
2010-06-23 09:19:29 +08:00
2016-09-07 04:57:50 +08:00
~ CommandObjectThreadList ( ) 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 {
Stream & strm = result . GetOutputStream ( ) ;
result . SetStatus ( eReturnStatusSuccessFinishNoResult ) ;
Process * process = m_exe_ctx . GetProcessPtr ( ) ;
const bool only_threads_with_stop_reason = false ;
const uint32_t start_frame = 0 ;
const uint32_t num_frames = 0 ;
const uint32_t num_frames_with_source = 0 ;
process - > GetStatus ( strm ) ;
process - > GetThreadStatus ( strm , only_threads_with_stop_reason , start_frame ,
2016-11-09 04:36:40 +08:00
num_frames , num_frames_with_source , false ) ;
2016-09-07 04:57:50 +08:00
return result . Succeeded ( ) ;
}
2010-06-23 09:19:29 +08:00
} ;
2010-06-09 00:52:24 +08:00
2014-06-13 10:37:02 +08:00
//-------------------------------------------------------------------------
// CommandObjectThreadInfo
//-------------------------------------------------------------------------
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_thread_info_options [ ] = {
// clang-format off
{ LLDB_OPT_SET_ALL , false , " json " , ' j ' , OptionParser : : eNoArgument , nullptr , nullptr , 0 , eArgTypeNone , " Display the thread info in JSON format. " } ,
{ LLDB_OPT_SET_ALL , false , " stop-info " , ' s ' , OptionParser : : eNoArgument , nullptr , nullptr , 0 , eArgTypeNone , " Display the extended stop info in JSON format. " }
// clang-format on
} ;
2016-09-07 04:57:50 +08:00
class CommandObjectThreadInfo : public CommandObjectIterateOverThreads {
2014-06-13 10:37:02 +08:00
public :
2016-09-07 04:57:50 +08:00
class CommandOptions : public Options {
public :
CommandOptions ( ) : Options ( ) { OptionParsingStarting ( nullptr ) ; }
2016-02-26 07:46:36 +08:00
2016-09-07 04:57:50 +08:00
~ CommandOptions ( ) override = default ;
2014-06-13 10:37:02 +08:00
2016-09-07 04:57:50 +08:00
void OptionParsingStarting ( ExecutionContext * execution_context ) override {
m_json_thread = false ;
m_json_stopinfo = false ;
}
2014-06-13 10:37:02 +08:00
2017-05-12 12:51:55 +08:00
Status SetOptionValue ( uint32_t option_idx , llvm : : StringRef option_arg ,
ExecutionContext * execution_context ) override {
2016-09-07 04:57:50 +08:00
const int short_option = m_getopt_table [ option_idx ] . val ;
2017-05-12 12:51:55 +08:00
Status error ;
2014-06-13 10:37:02 +08:00
2016-09-07 04:57:50 +08:00
switch ( short_option ) {
case ' j ' :
m_json_thread = true ;
break ;
2014-06-13 10:37:02 +08:00
2016-09-07 04:57:50 +08:00
case ' s ' :
m_json_stopinfo = true ;
break ;
2014-06-13 10:37:02 +08:00
2016-09-07 04:57:50 +08:00
default :
2017-05-12 12:51:55 +08:00
return Status ( " invalid short option character '%c' " , short_option ) ;
2016-09-07 04:57:50 +08:00
}
return error ;
2014-06-13 10:37:02 +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_thread_info_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
bool m_json_thread ;
bool m_json_stopinfo ;
} ;
CommandObjectThreadInfo ( CommandInterpreter & interpreter )
: CommandObjectIterateOverThreads (
interpreter , " thread info " , " Show an extended summary of one or "
" more threads. Defaults to the "
" current thread. " ,
" thread info " ,
eCommandRequiresProcess | eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched | eCommandProcessMustBePaused ) ,
m_options ( ) {
m_add_return = false ;
}
~ CommandObjectThreadInfo ( ) override = default ;
Options * GetOptions ( ) override { return & m_options ; }
bool HandleOneThread ( lldb : : tid_t tid , CommandReturnObject & result ) override {
ThreadSP thread_sp =
m_exe_ctx . GetProcessPtr ( ) - > GetThreadList ( ) . FindThreadByID ( tid ) ;
if ( ! thread_sp ) {
result . AppendErrorWithFormat ( " thread no longer exists: 0x% " PRIx64 " \n " ,
tid ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2014-06-13 10:37:02 +08:00
}
2016-09-07 04:57:50 +08:00
Thread * thread = thread_sp . get ( ) ;
2016-03-18 02:52:41 +08:00
2016-09-07 04:57:50 +08:00
Stream & strm = result . GetOutputStream ( ) ;
if ( ! thread - > GetDescription ( strm , eDescriptionLevelFull ,
m_options . m_json_thread ,
m_options . m_json_stopinfo ) ) {
result . AppendErrorWithFormat ( " error displaying info for thread: \" %d \" \n " ,
thread - > GetIndexID ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2014-06-13 10:37:02 +08:00
}
2016-09-07 04:57:50 +08:00
return true ;
}
2014-06-13 10:37:02 +08:00
2016-09-07 04:57:50 +08:00
CommandOptions m_options ;
2014-06-13 10:37:02 +08:00
} ;
2013-02-01 05:46:01 +08:00
//-------------------------------------------------------------------------
// CommandObjectThreadReturn
//-------------------------------------------------------------------------
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_thread_return_options [ ] = {
// clang-format off
{ LLDB_OPT_SET_ALL , false , " from-expression " , ' x ' , OptionParser : : eNoArgument , nullptr , nullptr , 0 , eArgTypeNone , " Return from the innermost expression evaluation. " }
// clang-format on
} ;
2016-09-07 04:57:50 +08:00
class CommandObjectThreadReturn : public CommandObjectRaw {
2012-09-14 10:14:15 +08:00
public :
2016-09-07 04:57:50 +08:00
class CommandOptions : public Options {
public :
CommandOptions ( ) : Options ( ) , m_from_expression ( false ) {
// Keep default values of all options in one place: OptionParsingStarting
// ()
OptionParsingStarting ( nullptr ) ;
}
2013-02-01 05:46:01 +08:00
2016-09-07 04:57:50 +08:00
~ CommandOptions ( ) override = default ;
2013-02-01 05:46:01 +08:00
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 ;
2013-02-01 05:46:01 +08:00
2016-09-07 04:57:50 +08:00
switch ( short_option ) {
case ' x ' : {
bool success ;
2018-04-10 17:03:59 +08:00
bool tmp_value =
OptionArgParser : : ToBoolean ( option_arg , false , & success ) ;
2016-09-07 04:57:50 +08:00
if ( success )
m_from_expression = tmp_value ;
else {
error . SetErrorStringWithFormat (
2016-11-13 00:56:47 +08:00
" invalid boolean value '%s' for 'x' option " ,
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 ;
}
2013-02-01 05:46:01 +08:00
2016-09-07 04:57:50 +08:00
void OptionParsingStarting ( ExecutionContext * execution_context ) override {
m_from_expression = false ;
}
2013-02-01 05:46:01 +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_thread_return_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
}
2013-02-01 05:46:01 +08:00
2016-09-07 04:57:50 +08:00
bool m_from_expression ;
2013-02-01 05:46:01 +08:00
2016-09-07 04:57:50 +08:00
// Instance variables to hold the values for command options.
} ;
CommandObjectThreadReturn ( CommandInterpreter & interpreter )
: CommandObjectRaw ( interpreter , " thread return " ,
" Prematurely return from a stack frame, "
" short-circuiting execution of newer frames "
" and optionally yielding a specified value. Defaults "
" to the exiting the current stack "
" frame. " ,
" thread return " ,
eCommandRequiresFrame | eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched |
eCommandProcessMustBePaused ) ,
m_options ( ) {
CommandArgumentEntry arg ;
CommandArgumentData expression_arg ;
// Define the first (and only) variant of this arg.
expression_arg . arg_type = eArgTypeExpression ;
expression_arg . arg_repetition = eArgRepeatOptional ;
2012-09-14 10:14:15 +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 ( expression_arg ) ;
2012-09-14 10:14:15 +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 ) ;
}
2012-09-14 10:14:15 +08:00
2016-09-07 04:57:50 +08:00
~ CommandObjectThreadReturn ( ) override = default ;
Options * GetOptions ( ) override { return & m_options ; }
protected :
bool DoExecute ( const char * command , CommandReturnObject & result ) override {
// I am going to handle this by hand, because I don't want you to have to
// say:
// "thread return -- -5".
if ( command [ 0 ] = = ' - ' & & command [ 1 ] = = ' x ' ) {
if ( command & & command [ 2 ] ! = ' \0 ' )
result . AppendWarning ( " Return values ignored when returning from user "
" called expressions " ) ;
Thread * thread = m_exe_ctx . GetThreadPtr ( ) ;
2017-05-12 12:51:55 +08:00
Status error ;
2016-09-07 04:57:50 +08:00
error = thread - > UnwindInnermostExpression ( ) ;
if ( ! error . Success ( ) ) {
result . AppendErrorWithFormat ( " Unwinding expression failed - %s. " ,
error . AsCString ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
} else {
bool success =
thread - > SetSelectedFrameByIndexNoisily ( 0 , result . GetOutputStream ( ) ) ;
if ( success ) {
m_exe_ctx . SetFrameSP ( thread - > GetSelectedFrame ( ) ) ;
result . SetStatus ( eReturnStatusSuccessFinishResult ) ;
} else {
result . AppendErrorWithFormat (
" Could not select 0th frame after unwinding expression. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
}
}
return result . Succeeded ( ) ;
2012-09-14 10:14:15 +08:00
}
2016-02-26 07:46:36 +08:00
2016-09-07 04:57:50 +08:00
ValueObjectSP return_valobj_sp ;
2016-02-26 07:46:36 +08:00
2016-09-07 04:57:50 +08:00
StackFrameSP frame_sp = m_exe_ctx . GetFrameSP ( ) ;
uint32_t frame_idx = frame_sp - > GetFrameIndex ( ) ;
if ( frame_sp - > IsInlined ( ) ) {
result . AppendError ( " Don't know how to return from inlined frames. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2012-09-14 10:14:15 +08:00
}
2016-09-07 04:57:50 +08:00
if ( command & & command [ 0 ] ! = ' \0 ' ) {
Target * target = m_exe_ctx . GetTargetPtr ( ) ;
EvaluateExpressionOptions options ;
options . SetUnwindOnError ( true ) ;
options . SetUseDynamic ( eNoDynamicValues ) ;
ExpressionResults exe_results = eExpressionSetupError ;
exe_results = target - > EvaluateExpression ( command , frame_sp . get ( ) ,
return_valobj_sp , options ) ;
if ( exe_results ! = eExpressionCompleted ) {
if ( return_valobj_sp )
result . AppendErrorWithFormat (
" Error evaluating result expression: %s " ,
return_valobj_sp - > GetError ( ) . AsCString ( ) ) ;
else
result . AppendErrorWithFormat (
" Unknown error evaluating result expression. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
}
2012-09-14 10:14:15 +08:00
2017-05-12 12:51:55 +08:00
Status error ;
2016-09-07 04:57:50 +08:00
ThreadSP thread_sp = m_exe_ctx . GetThreadSP ( ) ;
const bool broadcast = true ;
error = thread_sp - > ReturnFromFrame ( frame_sp , return_valobj_sp , broadcast ) ;
if ( ! error . Success ( ) ) {
result . AppendErrorWithFormat (
" Error returning from frame %d of thread %d: %s. " , frame_idx ,
thread_sp - > GetIndexID ( ) , error . AsCString ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2012-09-14 10:14:15 +08:00
}
2016-09-07 04:57:50 +08:00
result . SetStatus ( eReturnStatusSuccessFinishResult ) ;
return true ;
}
CommandOptions m_options ;
2012-09-14 10:14:15 +08:00
} ;
2016-02-26 07:46:36 +08:00
2013-09-12 10:20:34 +08:00
//-------------------------------------------------------------------------
// CommandObjectThreadJump
//-------------------------------------------------------------------------
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_thread_jump_options [ ] = {
// clang-format off
{ LLDB_OPT_SET_1 , false , " file " , ' f ' , OptionParser : : eRequiredArgument , nullptr , nullptr , CommandCompletions : : eSourceFileCompletion , eArgTypeFilename , " Specifies the source file to jump to. " } ,
{ LLDB_OPT_SET_1 , true , " line " , ' l ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeLineNum , " Specifies the line number to jump to. " } ,
{ LLDB_OPT_SET_2 , true , " by " , ' b ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeOffset , " Jumps by a relative line offset from the current line. " } ,
{ LLDB_OPT_SET_3 , true , " address " , ' a ' , OptionParser : : eRequiredArgument , nullptr , nullptr , 0 , eArgTypeAddressOrExpression , " Jumps to a specific address. " } ,
{ LLDB_OPT_SET_1 | LLDB_OPT_SET_2 | LLDB_OPT_SET_3 , false , " force " , ' r ' , OptionParser : : eNoArgument , nullptr , nullptr , 0 , eArgTypeNone , " Allows the PC to leave the current function. " }
// clang-format on
} ;
2016-09-07 04:57:50 +08:00
class CommandObjectThreadJump : public CommandObjectParsed {
2013-09-12 10:20:34 +08:00
public :
2016-09-07 04:57:50 +08:00
class CommandOptions : public Options {
public :
CommandOptions ( ) : Options ( ) { OptionParsingStarting ( nullptr ) ; }
~ CommandOptions ( ) override = default ;
void OptionParsingStarting ( ExecutionContext * execution_context ) override {
m_filenames . Clear ( ) ;
m_line_num = 0 ;
m_line_offset = 0 ;
m_load_addr = LLDB_INVALID_ADDRESS ;
m_force = false ;
2013-09-12 10:20:34 +08:00
}
2017-05-12 12:51:55 +08:00
Status SetOptionValue ( uint32_t option_idx , llvm : : StringRef option_arg ,
ExecutionContext * execution_context ) override {
2016-09-07 04:57:50 +08:00
const int short_option = m_getopt_table [ option_idx ] . val ;
2017-05-12 12:51:55 +08:00
Status error ;
2016-09-07 04:57:50 +08:00
switch ( short_option ) {
case ' f ' :
m_filenames . AppendIfUnique ( FileSpec ( option_arg , false ) ) ;
if ( m_filenames . GetSize ( ) > 1 )
2017-05-12 12:51:55 +08:00
return Status ( " only one source file expected. " ) ;
2016-09-07 04:57:50 +08:00
break ;
case ' l ' :
2016-11-13 00:56:47 +08:00
if ( option_arg . getAsInteger ( 0 , m_line_num ) )
2017-05-12 12:51:55 +08:00
return Status ( " invalid line number: '%s'. " , option_arg . str ( ) . c_str ( ) ) ;
2016-09-07 04:57:50 +08:00
break ;
case ' b ' :
2016-11-13 00:56:47 +08:00
if ( option_arg . getAsInteger ( 0 , m_line_offset ) )
2017-05-12 12:51:55 +08:00
return Status ( " invalid line offset: '%s'. " , option_arg . str ( ) . c_str ( ) ) ;
2016-09-07 04:57:50 +08:00
break ;
case ' a ' :
2018-04-10 17:03:59 +08:00
m_load_addr = OptionArgParser : : ToAddress ( execution_context , option_arg ,
LLDB_INVALID_ADDRESS , & error ) ;
2016-09-07 04:57:50 +08:00
break ;
case ' r ' :
m_force = true ;
break ;
default :
2017-05-12 12:51:55 +08:00
return Status ( " invalid short option character '%c' " , short_option ) ;
2016-09-07 04:57:50 +08:00
}
return error ;
2013-09-12 10:20:34 +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_thread_jump_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
}
2013-09-12 10:20:34 +08:00
2016-09-07 04:57:50 +08:00
FileSpecList m_filenames ;
uint32_t m_line_num ;
int32_t m_line_offset ;
lldb : : addr_t m_load_addr ;
bool m_force ;
} ;
2013-09-12 10:20:34 +08:00
2016-09-07 04:57:50 +08:00
CommandObjectThreadJump ( CommandInterpreter & interpreter )
: CommandObjectParsed (
interpreter , " thread jump " ,
" Sets the program counter to a new address. " , " thread jump " ,
eCommandRequiresFrame | eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched | eCommandProcessMustBePaused ) ,
m_options ( ) { }
2013-09-12 10:20:34 +08:00
2016-09-07 04:57:50 +08:00
~ CommandObjectThreadJump ( ) override = default ;
2013-09-12 10:20:34 +08:00
2016-09-07 04:57:50 +08:00
Options * GetOptions ( ) override { return & m_options ; }
protected :
bool DoExecute ( Args & args , CommandReturnObject & result ) override {
RegisterContext * reg_ctx = m_exe_ctx . GetRegisterContext ( ) ;
StackFrame * frame = m_exe_ctx . GetFramePtr ( ) ;
Thread * thread = m_exe_ctx . GetThreadPtr ( ) ;
Target * target = m_exe_ctx . GetTargetPtr ( ) ;
const SymbolContext & sym_ctx =
frame - > GetSymbolContext ( eSymbolContextLineEntry ) ;
if ( m_options . m_load_addr ! = LLDB_INVALID_ADDRESS ) {
// Use this address directly.
Address dest = Address ( m_options . m_load_addr ) ;
lldb : : addr_t callAddr = dest . GetCallableLoadAddress ( target ) ;
if ( callAddr = = LLDB_INVALID_ADDRESS ) {
result . AppendErrorWithFormat ( " Invalid destination address. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
if ( ! reg_ctx - > SetPC ( callAddr ) ) {
result . AppendErrorWithFormat ( " Error changing PC value for thread %d. " ,
thread - > GetIndexID ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
} else {
// Pick either the absolute line, or work out a relative one.
int32_t line = ( int32_t ) m_options . m_line_num ;
if ( line = = 0 )
line = sym_ctx . line_entry . line + m_options . m_line_offset ;
// Try the current file, but override if asked.
FileSpec file = sym_ctx . line_entry . file ;
if ( m_options . m_filenames . GetSize ( ) = = 1 )
file = m_options . m_filenames . GetFileSpecAtIndex ( 0 ) ;
if ( ! file ) {
result . AppendErrorWithFormat (
" No source file available for the current location. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
std : : string warnings ;
2017-05-12 12:51:55 +08:00
Status err = thread - > JumpToLine ( file , line , m_options . m_force , & warnings ) ;
2016-09-07 04:57:50 +08:00
if ( err . Fail ( ) ) {
result . SetError ( err ) ;
return false ;
}
if ( ! warnings . empty ( ) )
result . AppendWarning ( warnings . c_str ( ) ) ;
2013-09-12 10:20:34 +08:00
}
2016-09-07 04:57:50 +08:00
result . SetStatus ( eReturnStatusSuccessFinishResult ) ;
return true ;
}
CommandOptions m_options ;
2013-09-12 10:20:34 +08:00
} ;
2016-02-26 07:46:36 +08:00
2014-09-30 07:17:18 +08:00
//-------------------------------------------------------------------------
// Next are the subcommands of CommandObjectMultiwordThreadPlan
//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
// CommandObjectThreadPlanList
//-------------------------------------------------------------------------
2016-02-26 07:46: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
static OptionDefinition g_thread_plan_list_options [ ] = {
// clang-format off
{ LLDB_OPT_SET_1 , false , " verbose " , ' v ' , OptionParser : : eNoArgument , nullptr , nullptr , 0 , eArgTypeNone , " Display more information about the thread plans " } ,
{ LLDB_OPT_SET_1 , false , " internal " , ' i ' , OptionParser : : eNoArgument , nullptr , nullptr , 0 , eArgTypeNone , " Display internal as well as user thread plans " }
// clang-format on
} ;
2016-09-07 04:57:50 +08:00
class CommandObjectThreadPlanList : public CommandObjectIterateOverThreads {
2014-09-30 07:17:18 +08:00
public :
2016-09-07 04:57:50 +08:00
class CommandOptions : public Options {
public :
CommandOptions ( ) : Options ( ) {
// Keep default values of all options in one place: OptionParsingStarting
// ()
OptionParsingStarting ( nullptr ) ;
}
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
~ 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 ' i ' :
m_internal = true ;
break ;
case ' v ' :
m_verbose = true ;
break ;
default :
error . SetErrorStringWithFormat ( " invalid short option character '%c' " ,
short_option ) ;
break ;
}
return error ;
}
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
void OptionParsingStarting ( ExecutionContext * execution_context ) override {
m_verbose = false ;
m_internal = false ;
}
2014-09-30 07:17:18 +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_thread_plan_list_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
}
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
// Instance variables to hold the values for command options.
bool m_verbose ;
bool m_internal ;
} ;
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
CommandObjectThreadPlanList ( CommandInterpreter & interpreter )
: CommandObjectIterateOverThreads (
interpreter , " thread plan list " ,
" Show thread plans for one or more threads. If no threads are "
" specified, show the "
" current thread. Use the thread-index \" all \" to see all threads. " ,
nullptr ,
eCommandRequiresProcess | eCommandRequiresThread |
eCommandTryTargetAPILock | eCommandProcessMustBeLaunched |
eCommandProcessMustBePaused ) ,
m_options ( ) { }
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
~ CommandObjectThreadPlanList ( ) override = default ;
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
Options * GetOptions ( ) override { return & m_options ; }
2014-09-30 07:17:18 +08:00
protected :
2016-09-07 04:57:50 +08:00
bool HandleOneThread ( lldb : : tid_t tid , CommandReturnObject & result ) override {
ThreadSP thread_sp =
m_exe_ctx . GetProcessPtr ( ) - > GetThreadList ( ) . FindThreadByID ( tid ) ;
if ( ! thread_sp ) {
result . AppendErrorWithFormat ( " thread no longer exists: 0x% " PRIx64 " \n " ,
tid ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
2016-03-18 02:52:41 +08:00
2016-09-07 04:57:50 +08:00
Thread * thread = thread_sp . get ( ) ;
2016-03-18 02:52:41 +08:00
2016-09-07 04:57:50 +08:00
Stream & strm = result . GetOutputStream ( ) ;
DescriptionLevel desc_level = eDescriptionLevelFull ;
if ( m_options . m_verbose )
desc_level = eDescriptionLevelVerbose ;
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
thread - > DumpThreadPlans ( & strm , desc_level , m_options . m_internal , true ) ;
return true ;
}
2016-02-26 07:46:36 +08:00
2016-09-07 04:57:50 +08:00
CommandOptions m_options ;
2014-09-30 07:17:18 +08:00
} ;
2016-09-07 04:57:50 +08:00
class CommandObjectThreadPlanDiscard : public CommandObjectParsed {
2014-09-30 07:17:18 +08:00
public :
2016-09-07 04:57:50 +08:00
CommandObjectThreadPlanDiscard ( CommandInterpreter & interpreter )
: CommandObjectParsed ( interpreter , " thread plan discard " ,
" Discards thread plans up to and including the "
" specified index (see 'thread plan list'.) "
" Only user visible plans can be discarded. " ,
nullptr ,
eCommandRequiresProcess | eCommandRequiresThread |
eCommandTryTargetAPILock |
eCommandProcessMustBeLaunched |
eCommandProcessMustBePaused ) {
CommandArgumentEntry arg ;
CommandArgumentData plan_index_arg ;
// Define the first (and only) variant of this arg.
plan_index_arg . arg_type = eArgTypeUnsignedInteger ;
plan_index_arg . arg_repetition = eArgRepeatPlain ;
// There is only one variant this argument could be; put it into the
// argument entry.
arg . push_back ( plan_index_arg ) ;
// Push the data for the first argument into the m_arguments vector.
m_arguments . push_back ( arg ) ;
}
~ CommandObjectThreadPlanDiscard ( ) override = default ;
bool DoExecute ( Args & args , CommandReturnObject & result ) override {
Thread * thread = m_exe_ctx . GetThreadPtr ( ) ;
if ( args . GetArgumentCount ( ) ! = 1 ) {
result . AppendErrorWithFormat ( " Too many arguments, expected one - the "
" thread plan index - but got %zu. " ,
args . GetArgumentCount ( ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2014-09-30 07:17:18 +08:00
}
2016-09-07 04:57:50 +08:00
bool success ;
uint32_t thread_plan_idx =
StringConvert : : ToUInt32 ( args . GetArgumentAtIndex ( 0 ) , 0 , 0 , & success ) ;
if ( ! success ) {
result . AppendErrorWithFormat (
" Invalid thread index: \" %s \" - should be unsigned int. " ,
args . GetArgumentAtIndex ( 0 ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
if ( thread_plan_idx = = 0 ) {
result . AppendErrorWithFormat (
" You wouldn't really want me to discard the base thread plan. " ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
}
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
if ( thread - > DiscardUserThreadPlansUpToIndex ( thread_plan_idx ) ) {
result . SetStatus ( eReturnStatusSuccessFinishNoResult ) ;
return true ;
} else {
result . AppendErrorWithFormat (
" Could not find User thread plan with index %s. " ,
args . GetArgumentAtIndex ( 0 ) ) ;
result . SetStatus ( eReturnStatusFailed ) ;
return false ;
2014-09-30 07:17:18 +08:00
}
2016-09-07 04:57:50 +08:00
}
2014-09-30 07:17:18 +08:00
} ;
//-------------------------------------------------------------------------
// CommandObjectMultiwordThreadPlan
//-------------------------------------------------------------------------
2016-09-07 04:57:50 +08:00
class CommandObjectMultiwordThreadPlan : public CommandObjectMultiword {
2014-09-30 07:17:18 +08:00
public :
2016-09-07 04:57:50 +08:00
CommandObjectMultiwordThreadPlan ( CommandInterpreter & interpreter )
: CommandObjectMultiword (
interpreter , " plan " ,
" Commands for managing thread plans that control execution. " ,
" thread plan <subcommand> [<subcommand objects] " ) {
LoadSubCommand (
" list " , CommandObjectSP ( new CommandObjectThreadPlanList ( interpreter ) ) ) ;
LoadSubCommand (
" discard " ,
CommandObjectSP ( new CommandObjectThreadPlanDiscard ( interpreter ) ) ) ;
}
2014-09-30 07:17:18 +08:00
2016-09-07 04:57:50 +08:00
~ CommandObjectMultiwordThreadPlan ( ) override = default ;
2014-09-30 07:17:18 +08:00
} ;
2010-06-09 00:52:24 +08:00
//-------------------------------------------------------------------------
// CommandObjectMultiwordThread
//-------------------------------------------------------------------------
2016-09-07 04:57:50 +08:00
CommandObjectMultiwordThread : : CommandObjectMultiwordThread (
CommandInterpreter & interpreter )
: CommandObjectMultiword ( interpreter , " thread " , " Commands for operating on "
" one or more threads in "
" the current process. " ,
" thread <subcommand> [<subcommand-options>] " ) {
LoadSubCommand ( " backtrace " , CommandObjectSP ( new CommandObjectThreadBacktrace (
interpreter ) ) ) ;
LoadSubCommand ( " continue " ,
CommandObjectSP ( new CommandObjectThreadContinue ( interpreter ) ) ) ;
LoadSubCommand ( " list " ,
CommandObjectSP ( new CommandObjectThreadList ( interpreter ) ) ) ;
LoadSubCommand ( " return " ,
CommandObjectSP ( new CommandObjectThreadReturn ( interpreter ) ) ) ;
LoadSubCommand ( " jump " ,
CommandObjectSP ( new CommandObjectThreadJump ( interpreter ) ) ) ;
LoadSubCommand ( " select " ,
CommandObjectSP ( new CommandObjectThreadSelect ( interpreter ) ) ) ;
LoadSubCommand ( " until " ,
CommandObjectSP ( new CommandObjectThreadUntil ( interpreter ) ) ) ;
LoadSubCommand ( " info " ,
CommandObjectSP ( new CommandObjectThreadInfo ( interpreter ) ) ) ;
LoadSubCommand ( " step-in " ,
CommandObjectSP ( new CommandObjectThreadStepWithTypeAndScope (
interpreter , " thread step-in " ,
" Source level single step, stepping into calls. Defaults "
" to current thread unless specified. " ,
nullptr , eStepTypeInto , eStepScopeSource ) ) ) ;
LoadSubCommand ( " step-out " ,
CommandObjectSP ( new CommandObjectThreadStepWithTypeAndScope (
interpreter , " thread step-out " ,
" Finish executing the current stack frame and stop after "
" returning. Defaults to current thread unless specified. " ,
nullptr , eStepTypeOut , eStepScopeSource ) ) ) ;
LoadSubCommand ( " step-over " ,
CommandObjectSP ( new CommandObjectThreadStepWithTypeAndScope (
interpreter , " thread step-over " ,
" Source level single step, stepping over calls. Defaults "
" to current thread unless specified. " ,
nullptr , eStepTypeOver , eStepScopeSource ) ) ) ;
LoadSubCommand ( " step-inst " ,
CommandObjectSP ( new CommandObjectThreadStepWithTypeAndScope (
interpreter , " thread step-inst " ,
" Instruction level single step, stepping into calls. "
" Defaults to current thread unless specified. " ,
nullptr , eStepTypeTrace , eStepScopeInstruction ) ) ) ;
LoadSubCommand ( " step-inst-over " ,
CommandObjectSP ( new CommandObjectThreadStepWithTypeAndScope (
interpreter , " thread step-inst-over " ,
" Instruction level single step, stepping over calls. "
" Defaults to current thread unless specified. " ,
nullptr , eStepTypeTraceOver , eStepScopeInstruction ) ) ) ;
LoadSubCommand (
" step-scripted " ,
CommandObjectSP ( new CommandObjectThreadStepWithTypeAndScope (
interpreter , " thread step-scripted " ,
" Step as instructed by the script class passed in the -C option. " ,
nullptr , eStepTypeScripted , eStepScopeSource ) ) ) ;
LoadSubCommand ( " plan " , CommandObjectSP ( new CommandObjectMultiwordThreadPlan (
interpreter ) ) ) ;
2010-06-09 00:52:24 +08:00
}
2016-02-26 07:46:36 +08:00
CommandObjectMultiwordThread : : ~ CommandObjectMultiwordThread ( ) = default ;