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

#include <AppleThreadPlanStepThroughObjCTrampoline.h>

Inheritance diagram for lldb_private::AppleThreadPlanStepThroughDirectDispatch:
Inheritance graph
[legend]

Public Member Functions

 AppleThreadPlanStepThroughDirectDispatch (Thread &thread, AppleObjCTrampolineHandler &handler, llvm::StringRef dispatch_func_name)
 
 ~AppleThreadPlanStepThroughDirectDispatch () override
 
void GetDescription (Stream *s, lldb::DescriptionLevel level) override
 Print a description of this thread to the stream s.
 
bool ShouldStop (Event *event_ptr) override
 
bool StopOthers () override
 
bool MischiefManaged () override
 
bool DoWillResume (lldb::StateType resume_state, bool current_plan) override
 
void SetFlagsToDefault () override
 
- Public Member Functions inherited from lldb_private::ThreadPlanStepOut
 ThreadPlanStepOut (Thread &thread, SymbolContext *addr_context, bool first_insn, bool stop_others, Vote report_stop_vote, Vote report_run_vote, uint32_t frame_idx, LazyBool step_out_avoids_code_without_debug_info, bool continue_to_next_branch=false, bool gather_return_value=true)
 
 ~ThreadPlanStepOut () 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
 
void SetStopOthers (bool new_value) override
 
lldb::StateType GetPlanRunState () override
 
bool WillStop () override
 
bool MischiefManaged () override
 
void DidPush () override
 
bool IsPlanStale () override
 
lldb::ValueObjectSP GetReturnValueObject () 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 ()
 
virtual bool IsLeafPlan ()
 
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)
 
virtual lldb::StateType GetPlanRunState ()=0
 
- Public Member Functions inherited from lldb_private::UserID
 UserID (lldb::user_id_t uid=LLDB_INVALID_UID)
 Construct with optional user ID.
 
 ~UserID ()=default
 Destructor.
 
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.
 
- Public Member Functions inherited from lldb_private::ThreadPlanShouldStopHere
 ThreadPlanShouldStopHere (ThreadPlan *owner)
 
 ThreadPlanShouldStopHere (ThreadPlan *owner, const ThreadPlanShouldStopHereCallbacks *callbacks, void *baton=nullptr)
 
virtual ~ThreadPlanShouldStopHere ()
 
void SetShouldStopHereCallbacks (const ThreadPlanShouldStopHereCallbacks *callbacks, void *baton)
 
void ClearShouldStopHereCallbacks ()
 
bool InvokeShouldStopHereCallback (lldb::FrameComparison operation, Status &status)
 
lldb::ThreadPlanSP CheckShouldStopHereAndQueueStepOut (lldb::FrameComparison operation, Status &status)
 
lldb_private::FlagsGetFlags ()
 
const lldb_private::FlagsGetFlags () const
 

Protected Member Functions

bool DoPlanExplainsStop (Event *event_ptr) override
 
- Protected Member Functions inherited from lldb_private::ThreadPlanStepOut
void SetFlagsToDefault () override
 
bool DoPlanExplainsStop (Event *event_ptr) override
 
bool DoWillResume (lldb::StateType resume_state, bool current_plan) override
 
bool QueueInlinedStepPlan (bool queue_now)
 
- 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)
 
bool IsUsuallyUnexplainedStopReason (lldb::StopReason)
 
- Protected Member Functions inherited from lldb_private::ThreadPlanShouldStopHere
virtual lldb::ThreadPlanSP QueueStepOutFromHerePlan (Flags &flags, lldb::FrameComparison operation, Status &status)
 
virtual void SetFlagsToDefault ()=0
 

Protected Attributes

AppleObjCTrampolineHandlerm_trampoline_handler
 
std::string m_dispatch_func_name
 
lldb::ThreadPlanSP m_objc_step_through_sp
 Which dispatch function we're stepping through.
 
std::vector< lldb::BreakpointSPm_msgSend_bkpts
 When we hit an objc_msgSend, we'll use this plan to get to its target.
 
bool m_at_msg_send
 Breakpoints on the objc dispatch functions.
 
- 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.
 
- Protected Attributes inherited from lldb_private::ThreadPlanShouldStopHere
ThreadPlanShouldStopHereCallbacks m_callbacks
 
void * m_baton
 
ThreadPlanm_owner
 
lldb_private::Flags m_flags
 

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 , eKindSingleThreadTimeout
}
 
- Public Types inherited from lldb_private::ThreadPlanShouldStopHere
enum  { eNone = 0 , eAvoidInlines = (1 << 0) , eStepInAvoidNoDebug = (1 << 1) , eStepOutAvoidNoDebug = (1 << 2) }
 
- Static Protected Member Functions inherited from lldb_private::ThreadPlanShouldStopHere
static bool DefaultShouldStopHereCallback (ThreadPlan *current_plan, Flags &flags, lldb::FrameComparison operation, Status &status, void *baton)
 
static lldb::ThreadPlanSP DefaultStepFromHereCallback (ThreadPlan *current_plan, Flags &flags, lldb::FrameComparison operation, Status &status, void *baton)
 

Detailed Description

Definition at line 83 of file AppleThreadPlanStepThroughObjCTrampoline.h.

Constructor & Destructor Documentation

◆ AppleThreadPlanStepThroughDirectDispatch()

AppleThreadPlanStepThroughDirectDispatch::AppleThreadPlanStepThroughDirectDispatch ( Thread thread,
AppleObjCTrampolineHandler handler,
llvm::StringRef  dispatch_func_name 
)

◆ ~AppleThreadPlanStepThroughDirectDispatch()

AppleThreadPlanStepThroughDirectDispatch::~AppleThreadPlanStepThroughDirectDispatch ( )
override

Member Function Documentation

◆ DoPlanExplainsStop()

bool AppleThreadPlanStepThroughDirectDispatch::DoPlanExplainsStop ( Event event_ptr)
overrideprotectedvirtual

◆ DoWillResume()

bool AppleThreadPlanStepThroughDirectDispatch::DoWillResume ( lldb::StateType  resume_state,
bool  current_plan 
)
overridevirtual

◆ GetDescription()

void AppleThreadPlanStepThroughDirectDispatch::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.

Reimplemented from lldb_private::ThreadPlanStepOut.

Definition at line 286 of file AppleThreadPlanStepThroughObjCTrampoline.cpp.

References lldb::eDescriptionLevelBrief, m_dispatch_func_name, m_msgSend_bkpts, lldb_private::Stream::Printf(), and lldb_private::Stream::PutCString().

◆ MischiefManaged()

bool AppleThreadPlanStepThroughDirectDispatch::MischiefManaged ( )
overridevirtual

◆ SetFlagsToDefault()

void lldb_private::AppleThreadPlanStepThroughDirectDispatch::SetFlagsToDefault ( )
inlineoverridevirtual

◆ ShouldStop()

bool AppleThreadPlanStepThroughDirectDispatch::ShouldStop ( Event event_ptr)
overridevirtual

◆ StopOthers()

bool lldb_private::AppleThreadPlanStepThroughDirectDispatch::StopOthers ( )
inlineoverridevirtual

Reimplemented from lldb_private::ThreadPlanStepOut.

Definition at line 95 of file AppleThreadPlanStepThroughObjCTrampoline.h.

Member Data Documentation

◆ m_at_msg_send

bool lldb_private::AppleThreadPlanStepThroughDirectDispatch::m_at_msg_send
protected

Breakpoints on the objc dispatch functions.

Definition at line 116 of file AppleThreadPlanStepThroughObjCTrampoline.h.

Referenced by DoPlanExplainsStop(), and ShouldStop().

◆ m_dispatch_func_name

std::string lldb_private::AppleThreadPlanStepThroughDirectDispatch::m_dispatch_func_name
protected

Definition at line 109 of file AppleThreadPlanStepThroughObjCTrampoline.h.

Referenced by GetDescription().

◆ m_msgSend_bkpts

std::vector<lldb::BreakpointSP> lldb_private::AppleThreadPlanStepThroughDirectDispatch::m_msgSend_bkpts
protected

When we hit an objc_msgSend, we'll use this plan to get to its target.

Definition at line 114 of file AppleThreadPlanStepThroughObjCTrampoline.h.

Referenced by AppleThreadPlanStepThroughDirectDispatch(), DoPlanExplainsStop(), GetDescription(), ShouldStop(), and ~AppleThreadPlanStepThroughDirectDispatch().

◆ m_objc_step_through_sp

lldb::ThreadPlanSP lldb_private::AppleThreadPlanStepThroughDirectDispatch::m_objc_step_through_sp
protected

Which dispatch function we're stepping through.

Definition at line 111 of file AppleThreadPlanStepThroughObjCTrampoline.h.

Referenced by ShouldStop().

◆ m_trampoline_handler

AppleObjCTrampolineHandler& lldb_private::AppleThreadPlanStepThroughDirectDispatch::m_trampoline_handler
protected

Definition at line 108 of file AppleThreadPlanStepThroughObjCTrampoline.h.


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