#include <ThreadPlanStepInRange.h>

Inheritance diagram for lldb_private::ThreadPlanStepInRange:

[legend]

Public Member Functions
	ThreadPlanStepInRange (Thread &thread, const AddressRange &range, const SymbolContext &addr_context, const char *step_into_target, lldb::RunMode stop_others, LazyBool step_in_avoids_code_without_debug_info, LazyBool step_out_avoids_code_without_debug_info)

	~ThreadPlanStepInRange () 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

void	SetAvoidRegexp (const char *name)

bool	IsVirtualStep () override

Public Member Functions inherited from lldb_private::ThreadPlanStepRange
	ThreadPlanStepRange (ThreadPlanKind kind, const char *name, Thread &thread, const AddressRange &range, const SymbolContext &addr_context, lldb::RunMode stop_others, bool given_ranges_only=false)

	~ThreadPlanStepRange () override

void	GetDescription (Stream *s, lldb::DescriptionLevel level) override=0
	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=0

Vote	ShouldReportStop (Event *event_ptr) override

bool	StopOthers () override

lldb::StateType	GetPlanRunState () override

bool	WillStop () override

bool	MischiefManaged () override

void	DidPush () override

bool	IsPlanStale () override

void	AddRange (const AddressRange &new_range)

Public Member Functions inherited from lldb_private::ThreadPlan
virtual	~ThreadPlan ()

const char *	GetName () const
	Returns the name of this thread plan.

Thread &	GetThread ()
	Returns the Thread that is using this thread plan.

Target &	GetTarget ()

const Target &	GetTarget () 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::ThreadPlanTracerSP &	GetThreadPlanTracer ()

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::Flags &	GetFlags ()

const lldb_private::Flags &	GetFlags () const

Static Public Member Functions
static void	SetDefaultFlagValue (uint32_t new_value)

static uint32_t	GetDefaultFlagsValue ()

Protected Member Functions
bool	DoWillResume (lldb::StateType resume_state, bool current_plan) override

bool	DoPlanExplainsStop (Event *event_ptr) override

void	SetFlagsToDefault () override

void	SetCallbacks ()

bool	FrameMatchesAvoidCriteria ()

Protected Member Functions inherited from lldb_private::ThreadPlanStepRange
bool	InRange ()

lldb::FrameComparison	CompareCurrentFrameToStartFrame ()

bool	InSymbol ()

void	DumpRanges (Stream *s)

Disassembler *	GetDisassembler ()

InstructionList *	GetInstructionsForAddress (lldb::addr_t addr, size_t &range_index, size_t &insn_offset)

bool	SetNextBranchBreakpoint ()

bool	IsNextBranchBreakpointStop (lldb::StopInfoSP stop_info_sp)

void	ClearNextBranchBreakpoint ()

void	ClearNextBranchBreakpointExplainedStop ()

bool	NextRangeBreakpointExplainsStop (lldb::StopInfoSP stop_info_sp)

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)

ThreadPlan *	GetPreviousPlan ()

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

Static Protected Member Functions
static bool	DefaultShouldStopHereCallback (ThreadPlan current_plan, Flags &flags, lldb::FrameComparison operation, Status &status, void baton)

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)

Private Member Functions
void	SetupAvoidNoDebug (LazyBool step_in_avoids_code_without_debug_info, LazyBool step_out_avoids_code_without_debug_info)

	ThreadPlanStepInRange (const ThreadPlanStepInRange &)=delete

const ThreadPlanStepInRange &	operator= (const ThreadPlanStepInRange &)=delete

Private Attributes
lldb::ThreadPlanSP	m_sub_plan_sp

std::unique_ptr< RegularExpression >	m_avoid_regexp_up

bool	m_step_past_prologue

bool	m_virtual_step

ConstString	m_step_into_target

Static Private Attributes
static uint32_t	s_default_flag_values

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) }

Protected Attributes inherited from lldb_private::ThreadPlanStepRange
SymbolContext	m_addr_context

std::vector< AddressRange >	m_address_ranges

lldb::RunMode	m_stop_others

StackID	m_stack_id

StackID	m_parent_stack_id

bool	m_no_more_plans

bool	m_first_run_event

lldb::BreakpointSP	m_next_branch_bp_sp

bool	m_use_fast_step

bool	m_given_ranges_only

bool	m_found_calls = false

Protected Attributes inherited from lldb_private::ThreadPlan
Status	m_status

Process &	m_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

ThreadPlan *	m_owner

lldb_private::Flags	m_flags

Detailed Description

Definition at line 20 of file ThreadPlanStepInRange.h.

Constructor & Destructor Documentation

◆ ThreadPlanStepInRange() [1/2]

ThreadPlanStepInRange::ThreadPlanStepInRange	(	Thread &	thread,
		const AddressRange &	range,
		const SymbolContext &	addr_context,
		const char *	step_into_target,
		lldb::RunMode	stop_others,
		LazyBool	step_in_avoids_code_without_debug_info,
		LazyBool	step_out_avoids_code_without_debug_info
	)

Definition at line 35 of file ThreadPlanStepInRange.cpp.

References SetCallbacks(), SetFlagsToDefault(), and SetupAvoidNoDebug().

◆ ~ThreadPlanStepInRange()

ThreadPlanStepInRange::~ThreadPlanStepInRange ( )

overridedefault

◆ ThreadPlanStepInRange() [2/2]

lldb_private::ThreadPlanStepInRange::ThreadPlanStepInRange ( const ThreadPlanStepInRange & )

privatedelete

Member Function Documentation

◆ DefaultShouldStopHereCallback()

bool ThreadPlanStepInRange::DefaultShouldStopHereCallback	(	ThreadPlan *	current_plan,
		Flags &	flags,
		lldb::FrameComparison	operation,
		Status &	status,
		void *	baton
	)

staticprotected

Definition at line 359 of file ThreadPlanStepInRange.cpp.

References lldb_private::ConstString::AsCString(), lldb_private::ThreadPlanShouldStopHere::DefaultShouldStopHereCallback(), lldb::eFrameCompareYounger, lldb_private::ThreadPlan::eKindStepInRange, FrameMatchesAvoidCriteria(), lldb_private::SymbolContext::GetFunctionName(), lldb_private::ThreadPlan::GetKind(), lldb_private::GetLog(), lldb_private::Thread::GetStackFrameAtIndex(), lldb_private::StackFrame::GetSymbolContext(), lldb_private::ThreadPlan::GetThread(), LLDB_LOGF, m_step_into_target, lldb_private::Step, and lldb_private::SymbolContext::symbol.

Referenced by SetCallbacks().

◆ DoPlanExplainsStop()

bool ThreadPlanStepInRange::DoPlanExplainsStop ( Event * event_ptr )

overrideprotectedvirtual

Implements lldb_private::ThreadPlan.

Definition at line 416 of file ThreadPlanStepInRange.cpp.

References lldb::eStopReasonBreakpoint, lldb_private::GetLog(), lldb_private::ThreadPlan::GetPrivateStopInfo(), lldb_private::ThreadPlan::IsUsuallyUnexplainedStopReason(), m_virtual_step, lldb_private::ThreadPlanStepRange::NextRangeBreakpointExplainsStop(), lldb_private::Log::PutCString(), and lldb_private::Step.

◆ DoWillResume()

bool ThreadPlanStepInRange::DoWillResume	(	lldb::StateType	resume_state,
		bool	current_plan
	)

overrideprotectedvirtual

Reimplemented from lldb_private::ThreadPlan.

Definition at line 461 of file ThreadPlanStepInRange.cpp.

References lldb_private::StopInfo::CreateStopReasonToTrace(), lldb_private::Thread::DecrementCurrentInlinedDepth(), lldb::eStateStepping, lldb_private::Thread::GetCurrentInlinedDepth(), lldb_private::GetLog(), lldb_private::ThreadPlan::GetThread(), LLDB_LOGF, m_virtual_step, lldb_private::ThreadPlan::SetStopInfo(), and lldb_private::Step.

◆ FrameMatchesAvoidCriteria()

bool ThreadPlanStepInRange::FrameMatchesAvoidCriteria ( )

protected

◆ GetDefaultFlagsValue()

static uint32_t lldb_private::ThreadPlanStepInRange::GetDefaultFlagsValue ( )

inlinestatic

Definition at line 43 of file ThreadPlanStepInRange.h.

References s_default_flag_values.

Referenced by lldb_private::AppleThreadPlanStepThroughDirectDispatch::SetFlagsToDefault().

◆ GetDescription()

void ThreadPlanStepInRange::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]	s	The stream to which to print the description.
[in]	level	The level of description desired. Note that eDescriptionLevelBrief will be used in the stop message printed when the plan is complete.

Implements lldb_private::ThreadPlanStepRange.

Definition at line 91 of file ThreadPlanStepInRange.cpp.

References lldb_private::Status::AsCString(), lldb_private::ConstString::AsCString(), lldb_private::ThreadPlanStepRange::DumpRanges(), lldb_private::LineEntry::DumpStopContext(), lldb::eDescriptionLevelBrief, lldb::eDescriptionLevelVerbose, lldb_private::LineEntry::IsValid(), lldb_private::SymbolContext::line_entry, lldb_private::ThreadPlanStepRange::m_addr_context, lldb_private::ThreadPlan::m_status, m_step_into_target, lldb_private::Stream::Printf(), lldb_private::Stream::PutChar(), and lldb_private::Status::Success().