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

#include <ThreadPlanStepInRange.h>

Inheritance diagram for lldb_private::ThreadPlanStepInRange:
Inheritance graph
[legend]
Collaboration diagram for lldb_private::ThreadPlanStepInRange:
Collaboration graph
[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. More...
 
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
 
bool ValidatePlan (Stream *error) override
 Returns whether this plan could be successfully created. More...
 
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. 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)
 
virtual void SetStopOthers (bool new_value)
 
bool WillResume (lldb::StateType resume_state, bool current_plan)
 
bool IsMasterPlan ()
 
bool SetIsMasterPlan (bool value)
 
virtual bool OkayToDiscard ()
 
void SetOkayToDiscard (bool value)
 
virtual void ThreadDestroyed ()
 
bool GetPrivate ()
 
void SetPrivate (bool input)
 
virtual void DidPop ()
 
ThreadPlanKind GetKind () const
 
bool IsPlanComplete ()
 
void SetPlanComplete (bool success=true)
 
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 ()
 
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...
 
- 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
 

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)
 
DisassemblerGetDisassembler ()
 
InstructionListGetInstructionsForAddress (lldb::addr_t addr, size_t &range_index, size_t &insn_offset)
 
bool SetNextBranchBreakpoint ()
 
void ClearNextBranchBreakpoint ()
 
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)
 
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)
 

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 ThreadPlanStepInRangeoperator= (const ThreadPlanStepInRange &)=delete
 

Private Attributes

lldb::ThreadPlanSP m_sub_plan_sp
 
std::unique_ptr< RegularExpressionm_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
}
 
- 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< AddressRangem_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
 
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...
 
- Protected Attributes inherited from lldb_private::ThreadPlanShouldStopHere
ThreadPlanShouldStopHereCallbacks m_callbacks
 
void * m_baton
 
ThreadPlanm_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 
)

◆ ~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

◆ DoPlanExplainsStop()

bool ThreadPlanStepInRange::DoPlanExplainsStop ( Event event_ptr)
overrideprotectedvirtual

◆ DoWillResume()

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

◆ FrameMatchesAvoidCriteria()

bool ThreadPlanStepInRange::FrameMatchesAvoidCriteria ( )
protected

◆ GetDefaultFlagsValue()

static uint32_t lldb_private::ThreadPlanStepInRange::GetDefaultFlagsValue ( )
inlinestatic

◆ 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]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::ThreadPlanStepRange.

Definition at line 90 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().

◆ IsVirtualStep()

bool ThreadPlanStepInRange::IsVirtualStep ( )
overridevirtual

Reimplemented from lldb_private::ThreadPlan.

Definition at line 488 of file ThreadPlanStepInRange.cpp.

References m_virtual_step.

◆ operator=()

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

◆ SetAvoidRegexp()

void ThreadPlanStepInRange::SetAvoidRegexp ( const char *  name)

◆ SetCallbacks()

void lldb_private::ThreadPlanStepInRange::SetCallbacks ( )
inlineprotected

◆ SetDefaultFlagValue()

void ThreadPlanStepInRange::SetDefaultFlagValue ( uint32_t  new_value)
static

Definition at line 300 of file ThreadPlanStepInRange.cpp.

References s_default_flag_values.

◆ SetFlagsToDefault()

void lldb_private::ThreadPlanStepInRange::SetFlagsToDefault ( )
inlineoverrideprotectedvirtual

◆ SetupAvoidNoDebug()

void ThreadPlanStepInRange::SetupAvoidNoDebug ( LazyBool  step_in_avoids_code_without_debug_info,
LazyBool  step_out_avoids_code_without_debug_info 
)
private

◆ ShouldStop()

bool ThreadPlanStepInRange::ShouldStop ( Event event_ptr)
overridevirtual

Implements lldb_private::ThreadPlanStepRange.

Definition at line 127 of file ThreadPlanStepInRange.cpp.

References lldb_private::Stream::AsRawOstream(), lldb_private::ThreadPlanShouldStopHere::CheckShouldStopHereAndQueueStepOut(), lldb_private::ThreadPlanStepRange::ClearNextBranchBreakpoint(), lldb_private::ThreadPlanStepRange::CompareCurrentFrameToStartFrame(), lldb_private::DumpAddress(), lldb::eFrameCompareEqual, lldb::eFrameCompareOlder, lldb::eFrameCompareSameParent, lldb::eFrameCompareYounger, lldb::eOnlyThisThread, lldb_private::SymbolContext::function, lldb_private::Symbol::GetAddress(), lldb_private::Function::GetAddressRange(), lldb_private::Target::GetArchitecturePlugin(), lldb_private::AddressRange::GetBaseAddress(), lldb_private::Architecture::GetBytesToSkip(), lldb_private::StreamString::GetData(), lldb_private::Address::GetLoadAddress(), lldb_private::GetLogIfAllCategoriesSet(), lldb_private::Symbol::GetPrologueByteSize(), lldb_private::Function::GetPrologueByteSize(), lldb_private::Thread::GetRegisterContext(), lldb_private::Target::GetSectionLoadList(), lldb_private::Thread::GetStackFrameAtIndex(), lldb_private::ThreadPlan::GetTarget(), lldb_private::ThreadPlan::GetThread(), lldb_private::ThreadPlanStepRange::InRange(), lldb_private::ThreadPlanStepRange::InSymbol(), lldb_private::ThreadPlan::IsPlanComplete(), LIBLLDB_LOG_STEP, LLDB_LOGF, lldb_private::ThreadPlanStepRange::m_no_more_plans, lldb_private::ThreadPlanStepRange::m_stack_id, lldb_private::ThreadPlan::m_status, m_step_past_prologue, lldb_private::ThreadPlanStepRange::m_stop_others, m_sub_plan_sp, m_virtual_step, lldb_private::Thread::QueueThreadPlanForRunToAddress(), lldb_private::Thread::QueueThreadPlanForStepThrough(), lldb_private::SectionLoadList::ResolveLoadAddress(), lldb_private::ThreadPlanStepRange::SetNextBranchBreakpoint(), lldb_private::ThreadPlan::SetPlanComplete(), lldb_private::Address::Slide(), and lldb_private::SymbolContext::symbol.

Member Data Documentation

◆ m_avoid_regexp_up

std::unique_ptr<RegularExpression> lldb_private::ThreadPlanStepInRange::m_avoid_regexp_up
private

Definition at line 79 of file ThreadPlanStepInRange.h.

Referenced by FrameMatchesAvoidCriteria(), and SetAvoidRegexp().

◆ m_step_into_target

ConstString lldb_private::ThreadPlanStepInRange::m_step_into_target
private

Definition at line 85 of file ThreadPlanStepInRange.h.

Referenced by DefaultShouldStopHereCallback(), and GetDescription().

◆ m_step_past_prologue

bool lldb_private::ThreadPlanStepInRange::m_step_past_prologue
private

Definition at line 80 of file ThreadPlanStepInRange.h.

Referenced by ShouldStop().

◆ m_sub_plan_sp

lldb::ThreadPlanSP lldb_private::ThreadPlanStepInRange::m_sub_plan_sp
private

Definition at line 77 of file ThreadPlanStepInRange.h.

Referenced by ShouldStop().

◆ m_virtual_step

bool lldb_private::ThreadPlanStepInRange::m_virtual_step
private

◆ s_default_flag_values

uint32_t ThreadPlanStepInRange::s_default_flag_values
staticprivate

The documentation for this class was generated from the following files:
lldb_private::ThreadPlanShouldStopHere::eStepInAvoidNoDebug
@ eStepInAvoidNoDebug
Definition: ThreadPlanShouldStopHere.h:61