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

#include <ThreadPlanStepInstruction.h>

Inheritance diagram for lldb_private::ThreadPlanStepInstruction:
Inheritance graph

Public Member Functions

 ThreadPlanStepInstruction (Thread &thread, bool step_over, bool stop_others, Vote report_stop_vote, Vote report_run_vote)
 ~ThreadPlanStepInstruction () override
void GetDescription (Stream *s, lldb::DescriptionLevel level) override
 Print a description of this thread to the stream s.
bool ValidatePlan (Stream *error) override
 Returns whether this plan could be successfully created.
bool ShouldStop (Event *event_ptr) override
bool StopOthers () override
lldb::StateType GetPlanRunState () override
bool WillStop () override
bool MischiefManaged () override
bool IsPlanStale () override
- Public Member Functions inherited from lldb_private::ThreadPlan
virtual ~ThreadPlan ()
const char * GetName () const
 Returns the name of this thread plan.
ThreadGetThread ()
 Returns the Thread that is using this thread plan.
TargetGetTarget ()
const TargetGetTarget () const
void ClearThreadCache ()
 Clear the Thread* cache.
virtual void GetDescription (Stream *s, lldb::DescriptionLevel level)=0
 Print a description of this thread to the stream s.
virtual bool ValidatePlan (Stream *error)=0
 Returns whether this plan could be successfully created.
bool TracerExplainsStop ()
lldb::StateType RunState ()
bool PlanExplainsStop (Event *event_ptr)
virtual bool ShouldStop (Event *event_ptr)=0
virtual bool ShouldAutoContinue (Event *event_ptr)
 Returns whether this thread plan overrides the ShouldStop of subsequently processed plans.
virtual Vote ShouldReportStop (Event *event_ptr)
Vote ShouldReportRun (Event *event_ptr)
virtual void SetStopOthers (bool new_value)
virtual bool StopOthers ()
virtual bool ShouldRunBeforePublicStop ()
bool WillResume (lldb::StateType resume_state, bool current_plan)
virtual bool WillStop ()=0
bool IsControllingPlan ()
bool SetIsControllingPlan (bool value)
virtual bool OkayToDiscard ()
void SetOkayToDiscard (bool value)
virtual bool MischiefManaged ()
virtual void ThreadDestroyed ()
bool GetPrivate ()
void SetPrivate (bool input)
virtual void DidPush ()
virtual void DidPop ()
ThreadPlanKind GetKind () const
bool IsPlanComplete ()
void SetPlanComplete (bool success=true)
virtual bool IsPlanStale ()
bool PlanSucceeded ()
virtual bool IsBasePlan ()
lldb::ThreadPlanTracerSPGetThreadPlanTracer ()
void SetThreadPlanTracer (lldb::ThreadPlanTracerSP new_tracer_sp)
void DoTraceLog ()
virtual lldb::ValueObjectSP GetReturnValueObject ()
virtual lldb::ExpressionVariableSP GetExpressionVariable ()
virtual void RestoreThreadState ()
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.
 ~UserID ()=default
void Clear ()
 Clears the object state.
lldb::user_id_t GetID () const
 Get accessor for the user ID.
void SetID (lldb::user_id_t uid)
 Set accessor for the user ID.

Protected Member Functions

bool DoPlanExplainsStop (Event *event_ptr) override
void SetUpState ()
- 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)
virtual bool DoPlanExplainsStop (Event *event_ptr)=0
void PushPlan (lldb::ThreadPlanSP &thread_plan_sp)
ThreadPlanGetPreviousPlan ()
lldb::StopInfoSP GetPrivateStopInfo ()
void SetStopInfo (lldb::StopInfoSP stop_reason_sp)
virtual lldb::StateType GetPlanRunState ()=0
bool IsUsuallyUnexplainedStopReason (lldb::StopReason)

Private Member Functions

 ThreadPlanStepInstruction (const ThreadPlanStepInstruction &)=delete
const ThreadPlanStepInstructionoperator= (const ThreadPlanStepInstruction &)=delete

Private Attributes

lldb::addr_t m_instruction_addr
bool m_stop_other_threads
bool m_step_over
bool m_start_has_symbol
StackID m_stack_id
StackID m_parent_frame_id


lldb::ThreadPlanSP Thread::QueueThreadPlanForStepSingleInstruction (bool step_over, bool abort_other_plans, bool stop_other_threads, Status &status)

Additional Inherited Members

- Public Types inherited from lldb_private::ThreadPlan
enum  ThreadPlanKind {
  eKindGeneric , eKindNull , eKindBase , eKindCallFunction ,
  eKindPython , eKindStepInstruction , eKindStepOut , eKindStepOverBreakpoint ,
  eKindStepOverRange , eKindStepInRange , eKindRunToAddress , eKindStepThrough ,
- Protected Attributes inherited from lldb_private::ThreadPlan
Status m_status
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.

Detailed Description

Definition at line 18 of file ThreadPlanStepInstruction.h.

Constructor & Destructor Documentation

◆ ThreadPlanStepInstruction() [1/2]

ThreadPlanStepInstruction::ThreadPlanStepInstruction ( Thread thread,
bool  step_over,
bool  stop_others,
Vote  report_stop_vote,
Vote  report_run_vote 

◆ ~ThreadPlanStepInstruction()

ThreadPlanStepInstruction::~ThreadPlanStepInstruction ( )

◆ ThreadPlanStepInstruction() [2/2]

lldb_private::ThreadPlanStepInstruction::ThreadPlanStepInstruction ( const ThreadPlanStepInstruction )

Member Function Documentation

◆ DoPlanExplainsStop()

bool ThreadPlanStepInstruction::DoPlanExplainsStop ( Event event_ptr)

◆ GetDescription()

void ThreadPlanStepInstruction::GetDescription ( Stream s,
lldb::DescriptionLevel  level 

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.

[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.

Definition at line 53 of file ThreadPlanStepInstruction.cpp.

References lldb_private::Status::AsCString(), lldb_private::Stream::AsRawOstream(), lldb_private::DumpAddress(), lldb::eDescriptionLevelBrief, m_instruction_addr, m_start_has_symbol, lldb_private::ThreadPlan::m_status, m_step_over, lldb_private::Stream::Printf(), and lldb_private::Status::Success().

◆ GetPlanRunState()

StateType ThreadPlanStepInstruction::GetPlanRunState ( )

Implements lldb_private::ThreadPlan.

Definition at line 239 of file ThreadPlanStepInstruction.cpp.

References lldb::eStateStepping.

◆ IsPlanStale()

bool ThreadPlanStepInstruction::IsPlanStale ( )

◆ MischiefManaged()

bool ThreadPlanStepInstruction::MischiefManaged ( )

◆ operator=()

const ThreadPlanStepInstruction & lldb_private::ThreadPlanStepInstruction::operator= ( const ThreadPlanStepInstruction )

◆ SetUpState()

void ThreadPlanStepInstruction::SetUpState ( )

◆ ShouldStop()

bool ThreadPlanStepInstruction::ShouldStop ( Event event_ptr)

◆ StopOthers()

bool ThreadPlanStepInstruction::StopOthers ( )

Reimplemented from lldb_private::ThreadPlan.

Definition at line 237 of file ThreadPlanStepInstruction.cpp.

References m_stop_other_threads.

◆ ValidatePlan()

bool ThreadPlanStepInstruction::ValidatePlan ( Stream error)

Returns whether this plan could be successfully created.

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

Implements lldb_private::ThreadPlan.

Definition at line 83 of file ThreadPlanStepInstruction.cpp.

◆ WillStop()

bool ThreadPlanStepInstruction::WillStop ( )

Implements lldb_private::ThreadPlan.

Definition at line 243 of file ThreadPlanStepInstruction.cpp.

Friends And Related Function Documentation

◆ Thread::QueueThreadPlanForStepSingleInstruction

lldb::ThreadPlanSP Thread::QueueThreadPlanForStepSingleInstruction ( bool  step_over,
bool  abort_other_plans,
bool  stop_other_threads,
Status status 

Member Data Documentation

◆ m_instruction_addr

lldb::addr_t lldb_private::ThreadPlanStepInstruction::m_instruction_addr

Definition at line 44 of file ThreadPlanStepInstruction.h.

Referenced by GetDescription(), IsPlanStale(), SetUpState(), and ShouldStop().

◆ m_parent_frame_id

StackID lldb_private::ThreadPlanStepInstruction::m_parent_frame_id

Definition at line 50 of file ThreadPlanStepInstruction.h.

Referenced by SetUpState(), and ShouldStop().

◆ m_stack_id

StackID lldb_private::ThreadPlanStepInstruction::m_stack_id

Definition at line 49 of file ThreadPlanStepInstruction.h.

Referenced by IsPlanStale(), SetUpState(), and ShouldStop().

◆ m_start_has_symbol

bool lldb_private::ThreadPlanStepInstruction::m_start_has_symbol

Definition at line 48 of file ThreadPlanStepInstruction.h.

Referenced by GetDescription(), SetUpState(), and ShouldStop().

◆ m_step_over

bool lldb_private::ThreadPlanStepInstruction::m_step_over

Definition at line 46 of file ThreadPlanStepInstruction.h.

Referenced by GetDescription(), IsPlanStale(), and ShouldStop().

◆ m_stop_other_threads

bool lldb_private::ThreadPlanStepInstruction::m_stop_other_threads

Definition at line 45 of file ThreadPlanStepInstruction.h.

Referenced by StopOthers().

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