LLDB  mainline
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
lldb_private::ThreadPlanCallFunction Class Reference

#include <ThreadPlanCallFunction.h>

Inheritance diagram for lldb_private::ThreadPlanCallFunction:
Inheritance graph
[legend]
Collaboration diagram for lldb_private::ThreadPlanCallFunction:
Collaboration graph
[legend]

Public Member Functions

 ThreadPlanCallFunction (Thread &thread, const Address &function, const CompilerType &return_type, llvm::ArrayRef< lldb::addr_t > args, const EvaluateExpressionOptions &options)
 
 ThreadPlanCallFunction (Thread &thread, const Address &function, const EvaluateExpressionOptions &options)
 
 ~ThreadPlanCallFunction () override
 
void GetDescription (Stream *s, lldb::DescriptionLevel level) override
 Print a description of this thread to the stream s. More...
 
bool ValidatePlan (Stream *error) override
 Returns whether this plan could be successfully created. More...
 
bool ShouldStop (Event *event_ptr) override
 
Vote ShouldReportStop (Event *event_ptr) override
 
bool StopOthers () override
 
lldb::StateType GetPlanRunState () override
 
void DidPush () override
 
bool WillStop () override
 
bool MischiefManaged () override
 
lldb::ValueObjectSP GetReturnValueObject () override
 
lldb::addr_t GetFunctionStackPointer ()
 
void DidPop () override
 
virtual lldb::StopInfoSP GetRealStopInfo ()
 
lldb::addr_t GetStopAddress ()
 
void RestoreThreadState () override
 
void ThreadDestroyed () override
 
void SetStopOthers (bool new_value) override
 
- Public Member Functions inherited from lldb_private::ThreadPlan
virtual ~ThreadPlan ()
 
const char * GetName () const
 Returns the name of this thread plan. More...
 
ThreadGetThread ()
 Returns the Thread that is using this thread plan. More...
 
TargetGetTarget ()
 
const TargetGetTarget () const
 
void ClearThreadCache ()
 Clear the Thread* cache. More...
 
bool TracerExplainsStop ()
 
lldb::StateType RunState ()
 
bool PlanExplainsStop (Event *event_ptr)
 
virtual bool ShouldAutoContinue (Event *event_ptr)
 Returns whether this thread plan overrides the ShouldStop of subsequently processed plans. More...
 
Vote ShouldReportRun (Event *event_ptr)
 
bool WillResume (lldb::StateType resume_state, bool current_plan)
 
bool IsMasterPlan ()
 
bool SetIsMasterPlan (bool value)
 
virtual bool OkayToDiscard ()
 
void SetOkayToDiscard (bool value)
 
bool GetPrivate ()
 
void SetPrivate (bool input)
 
ThreadPlanKind GetKind () const
 
bool IsPlanComplete ()
 
void SetPlanComplete (bool success=true)
 
virtual bool IsPlanStale ()
 
bool PlanSucceeded ()
 
virtual bool IsBasePlan ()
 
lldb::ThreadPlanTracerSP & GetThreadPlanTracer ()
 
void SetThreadPlanTracer (lldb::ThreadPlanTracerSP new_tracer_sp)
 
void DoTraceLog ()
 
virtual lldb::ExpressionVariableSP GetExpressionVariable ()
 
virtual bool IsVirtualStep ()
 
bool SetIterationCount (size_t count)
 
- Public Member Functions inherited from lldb_private::UserID
 UserID (lldb::user_id_t uid=LLDB_INVALID_UID)
 Construct with optional user ID. More...
 
 ~UserID ()=default
 Destructor. More...
 
void Clear ()
 Clears the object state. More...
 
lldb::user_id_t GetID () const
 Get accessor for the user ID. More...
 
void SetID (lldb::user_id_t uid)
 Set accessor for the user ID. More...
 

Protected Member Functions

void ReportRegisterState (const char *message)
 
bool DoPlanExplainsStop (Event *event_ptr) override
 
virtual void SetReturnValue ()
 
bool ConstructorSetup (Thread &thread, ABI *&abi, lldb::addr_t &start_load_addr, lldb::addr_t &function_load_addr)
 
virtual void DoTakedown (bool success)
 
void SetBreakpoints ()
 
void ClearBreakpoints ()
 
bool BreakpointsExplainStop ()
 
- Protected Member Functions inherited from lldb_private::ThreadPlan
 ThreadPlan (ThreadPlanKind kind, const char *name, Thread &thread, Vote report_stop_vote, Vote report_run_vote)
 
virtual bool DoWillResume (lldb::StateType resume_state, bool current_plan)
 
void PushPlan (lldb::ThreadPlanSP &thread_plan_sp)
 
ThreadPlanGetPreviousPlan ()
 
lldb::StopInfoSP GetPrivateStopInfo ()
 
void SetStopInfo (lldb::StopInfoSP stop_reason_sp)
 
bool IsUsuallyUnexplainedStopReason (lldb::StopReason)
 

Protected Attributes

bool m_valid
 
bool m_stop_other_threads
 
bool m_unwind_on_error
 
bool m_ignore_breakpoints
 
bool m_debug_execution
 
bool m_trap_exceptions
 
Address m_function_addr
 
Address m_start_addr
 
lldb::addr_t m_function_sp
 
lldb::ThreadPlanSP m_subplan_sp
 
LanguageRuntimem_cxx_language_runtime
 
LanguageRuntimem_objc_language_runtime
 
Thread::ThreadStateCheckpoint m_stored_thread_state
 
lldb::StopInfoSP m_real_stop_info_sp
 
StreamString m_constructor_errors
 
lldb::ValueObjectSP m_return_valobj_sp
 
bool m_takedown_done
 
bool m_should_clear_objc_exception_bp
 
bool m_should_clear_cxx_exception_bp
 
lldb::addr_t m_stop_address
 
- Protected Attributes inherited from lldb_private::ThreadPlan
Status m_status
 
Processm_process
 
lldb::tid_t m_tid
 
Vote m_report_stop_vote
 
Vote m_report_run_vote
 
bool m_takes_iteration_count
 
bool m_could_not_resolve_hw_bp
 
int32_t m_iteration_count = 1
 
- Protected Attributes inherited from lldb_private::UserID
lldb::user_id_t m_uid
 The user ID that uniquely identifies an object. More...
 

Private Member Functions

 ThreadPlanCallFunction (const ThreadPlanCallFunction &)=delete
 
const ThreadPlanCallFunctionoperator= (const ThreadPlanCallFunction &)=delete
 

Private Attributes

CompilerType m_return_type
 

Additional Inherited Members

- Public Types inherited from lldb_private::ThreadPlan
enum  ThreadPlanKind {
  eKindGeneric, eKindNull, eKindBase, eKindCallFunction,
  eKindPython, eKindStepInstruction, eKindStepOut, eKindStepOverBreakpoint,
  eKindStepOverRange, eKindStepInRange, eKindRunToAddress, eKindStepThrough,
  eKindStepUntil
}
 

Detailed Description

Definition at line 20 of file ThreadPlanCallFunction.h.

Constructor & Destructor Documentation

◆ ThreadPlanCallFunction() [1/3]

lldb_private::ThreadPlanCallFunction::ThreadPlanCallFunction ( Thread thread,
const Address function,
const CompilerType return_type,
llvm::ArrayRef< lldb::addr_t args,
const EvaluateExpressionOptions options 
)

◆ ThreadPlanCallFunction() [2/3]

ThreadPlanCallFunction::ThreadPlanCallFunction ( Thread thread,
const Address function,
const EvaluateExpressionOptions options 
)

Definition at line 126 of file ThreadPlanCallFunction.cpp.

◆ ~ThreadPlanCallFunction()

ThreadPlanCallFunction::~ThreadPlanCallFunction ( )
override

◆ ThreadPlanCallFunction() [3/3]

lldb_private::ThreadPlanCallFunction::ThreadPlanCallFunction ( const ThreadPlanCallFunction )
privatedelete

Member Function Documentation

◆ BreakpointsExplainStop()

bool ThreadPlanCallFunction::BreakpointsExplainStop ( )
protected

◆ ClearBreakpoints()

void ThreadPlanCallFunction::ClearBreakpoints ( )
protected

◆ ConstructorSetup()

bool ThreadPlanCallFunction::ConstructorSetup ( Thread thread,
ABI *&  abi,
lldb::addr_t start_load_addr,
lldb::addr_t function_load_addr 
)
protected

◆ DidPop()

void ThreadPlanCallFunction::DidPop ( )
overridevirtual

◆ DidPush()

void ThreadPlanCallFunction::DidPush ( )
overridevirtual

◆ DoPlanExplainsStop()

bool ThreadPlanCallFunction::DoPlanExplainsStop ( Event event_ptr)
overrideprotectedvirtual

◆ DoTakedown()

void ThreadPlanCallFunction::DoTakedown ( bool  success)
protectedvirtual

◆ GetDescription()

void ThreadPlanCallFunction::GetDescription ( Stream s,
lldb::DescriptionLevel  level 
)
overridevirtual

Print a description of this thread to the stream s.

thread. Don't expect that the result of GetThread is valid in the description method. This might get called when the underlying Thread has not been reported, so we only know the TID and not the thread.

Parameters
[in]sThe stream to which to print the description.
[in]levelThe level of description desired. Note that eDescriptionLevelBrief will be used in the stop message printed when the plan is complete.

Implements lldb_private::ThreadPlan.

Reimplemented in lldb_private::ThreadPlanCallFunctionUsingABI, and lldb_private::ThreadPlanCallUserExpression.

Definition at line 214 of file ThreadPlanCallFunction.cpp.

References lldb::eDescriptionLevelBrief, lldb_private::Address::GetLoadAddress(), lldb_private::ThreadPlan::GetTarget(), m_function_addr, and lldb_private::Stream::Printf().

Referenced by lldb_private::ThreadPlanCallUserExpression::GetDescription().

◆ GetFunctionStackPointer()

lldb::addr_t lldb_private::ThreadPlanCallFunction::GetFunctionStackPointer ( )
inline

◆ GetPlanRunState()

StateType ThreadPlanCallFunction::GetPlanRunState ( )
overridevirtual

Implements lldb_private::ThreadPlan.

Definition at line 361 of file ThreadPlanCallFunction.cpp.

References lldb::eStateRunning.

◆ GetRealStopInfo()

virtual lldb::StopInfoSP lldb_private::ThreadPlanCallFunction::GetRealStopInfo ( )
inlinevirtual

◆ GetReturnValueObject()

lldb::ValueObjectSP lldb_private::ThreadPlanCallFunction::GetReturnValueObject ( )
inlineoverridevirtual

Reimplemented from lldb_private::ThreadPlan.

Definition at line 62 of file ThreadPlanCallFunction.h.

References m_return_valobj_sp.

◆ GetStopAddress()

lldb::addr_t lldb_private::ThreadPlanCallFunction::GetStopAddress ( )
inline

◆ MischiefManaged()

bool ThreadPlanCallFunction::MischiefManaged ( )
overridevirtual

◆ operator=()

const ThreadPlanCallFunction& lldb_private::ThreadPlanCallFunction::operator= ( const ThreadPlanCallFunction )
privatedelete

◆ ReportRegisterState()

void ThreadPlanCallFunction::ReportRegisterState ( const char *  message)
protected

◆ RestoreThreadState()

void ThreadPlanCallFunction::RestoreThreadState ( )
overridevirtual

◆ SetBreakpoints()

void ThreadPlanCallFunction::SetBreakpoints ( )
protected

◆ SetReturnValue()

void ThreadPlanCallFunction::SetReturnValue ( )
protectedvirtual

◆ SetStopOthers()

void ThreadPlanCallFunction::SetStopOthers ( bool  new_value)
overridevirtual

Reimplemented from lldb_private::ThreadPlan.

Definition at line 453 of file ThreadPlanCallFunction.cpp.

References m_subplan_sp.

◆ ShouldReportStop()

Vote ThreadPlanCallFunction::ShouldReportStop ( Event event_ptr)
overridevirtual

◆ ShouldStop()

bool ThreadPlanCallFunction::ShouldStop ( Event event_ptr)
overridevirtual

◆ StopOthers()

bool ThreadPlanCallFunction::StopOthers ( )
overridevirtual

Reimplemented from lldb_private::ThreadPlan.

Definition at line 359 of file ThreadPlanCallFunction.cpp.

References m_stop_other_threads.

◆ ThreadDestroyed()

void lldb_private::ThreadPlanCallFunction::ThreadDestroyed ( )
inlineoverridevirtual

Reimplemented from lldb_private::ThreadPlan.

Definition at line 95 of file ThreadPlanCallFunction.h.

References m_takedown_done.

◆ ValidatePlan()

bool ThreadPlanCallFunction::ValidatePlan ( Stream error)
overridevirtual

Returns whether this plan could be successfully created.

Parameters
[in]errorA stream to which to print some reason why the plan could not be created. Can be NULL.
Returns
true if the plan should be queued, false otherwise.

Implements lldb_private::ThreadPlan.

Definition at line 223 of file ThreadPlanCallFunction.cpp.

References error(), lldb_private::StreamString::GetSize(), lldb_private::StreamString::GetString(), m_constructor_errors, and m_valid.

◆ WillStop()

bool ThreadPlanCallFunction::WillStop ( )
overridevirtual

Implements lldb_private::ThreadPlan.

Definition at line 382 of file ThreadPlanCallFunction.cpp.

Member Data Documentation

◆ m_constructor_errors

StreamString lldb_private::ThreadPlanCallFunction::m_constructor_errors
protected

Definition at line 136 of file ThreadPlanCallFunction.h.

Referenced by ValidatePlan().

◆ m_cxx_language_runtime

LanguageRuntime* lldb_private::ThreadPlanCallFunction::m_cxx_language_runtime
protected

◆ m_debug_execution

bool lldb_private::ThreadPlanCallFunction::m_debug_execution
protected

Definition at line 122 of file ThreadPlanCallFunction.h.

◆ m_function_addr

Address lldb_private::ThreadPlanCallFunction::m_function_addr
protected

◆ m_function_sp

lldb::addr_t lldb_private::ThreadPlanCallFunction::m_function_sp
protected

◆ m_ignore_breakpoints

bool lldb_private::ThreadPlanCallFunction::m_ignore_breakpoints
protected

Definition at line 121 of file ThreadPlanCallFunction.h.

Referenced by DoPlanExplainsStop().

◆ m_objc_language_runtime

LanguageRuntime* lldb_private::ThreadPlanCallFunction::m_objc_language_runtime
protected

◆ m_real_stop_info_sp

lldb::StopInfoSP lldb_private::ThreadPlanCallFunction::m_real_stop_info_sp
protected

Definition at line 132 of file ThreadPlanCallFunction.h.

Referenced by DoPlanExplainsStop(), DoTakedown(), and GetRealStopInfo().

◆ m_return_type

CompilerType lldb_private::ThreadPlanCallFunction::m_return_type
private

Definition at line 148 of file ThreadPlanCallFunction.h.

Referenced by SetReturnValue().

◆ m_return_valobj_sp

lldb::ValueObjectSP lldb_private::ThreadPlanCallFunction::m_return_valobj_sp
protected

◆ m_should_clear_cxx_exception_bp

bool lldb_private::ThreadPlanCallFunction::m_should_clear_cxx_exception_bp
protected

Definition at line 143 of file ThreadPlanCallFunction.h.

Referenced by ClearBreakpoints(), and SetBreakpoints().

◆ m_should_clear_objc_exception_bp

bool lldb_private::ThreadPlanCallFunction::m_should_clear_objc_exception_bp
protected

Definition at line 142 of file ThreadPlanCallFunction.h.

Referenced by ClearBreakpoints(), and SetBreakpoints().

◆ m_start_addr

Address lldb_private::ThreadPlanCallFunction::m_start_addr
protected

Definition at line 125 of file ThreadPlanCallFunction.h.

Referenced by DidPush().

◆ m_stop_address

lldb::addr_t lldb_private::ThreadPlanCallFunction::m_stop_address
protected

Definition at line 144 of file ThreadPlanCallFunction.h.

Referenced by DoTakedown(), and GetStopAddress().

◆ m_stop_other_threads

bool lldb_private::ThreadPlanCallFunction::m_stop_other_threads
protected

Definition at line 119 of file ThreadPlanCallFunction.h.

Referenced by DidPush(), and StopOthers().

◆ m_stored_thread_state

Thread::ThreadStateCheckpoint lldb_private::ThreadPlanCallFunction::m_stored_thread_state
protected

Definition at line 130 of file ThreadPlanCallFunction.h.

Referenced by DoTakedown(), and RestoreThreadState().

◆ m_subplan_sp

lldb::ThreadPlanSP lldb_private::ThreadPlanCallFunction::m_subplan_sp
protected

Definition at line 127 of file ThreadPlanCallFunction.h.

Referenced by DidPush(), DoPlanExplainsStop(), and SetStopOthers().

◆ m_takedown_done

bool lldb_private::ThreadPlanCallFunction::m_takedown_done
protected

Definition at line 140 of file ThreadPlanCallFunction.h.

Referenced by DoTakedown(), ShouldReportStop(), and ThreadDestroyed().

◆ m_trap_exceptions

bool lldb_private::ThreadPlanCallFunction::m_trap_exceptions
protected

◆ m_unwind_on_error

bool lldb_private::ThreadPlanCallFunction::m_unwind_on_error
protected

Definition at line 120 of file ThreadPlanCallFunction.h.

Referenced by DoPlanExplainsStop().

◆ m_valid

bool lldb_private::ThreadPlanCallFunction::m_valid
protected

The documentation for this class was generated from the following files: