LLDB mainline
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
lldb_private::StopInfo Class Referenceabstract

#include <StopInfo.h>

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

Public Member Functions

 StopInfo (Thread &thread, uint64_t value)
 
virtual ~StopInfo ()=default
 
bool IsValid () const
 
void SetThread (const lldb::ThreadSP &thread_sp)
 
lldb::ThreadSP GetThread () const
 
uint64_t GetValue () const
 
virtual lldb::StopReason GetStopReason () const =0
 
virtual bool ShouldStopSynchronous (Event *event_ptr)
 
void OverrideShouldNotify (bool override_value)
 
virtual bool ShouldNotify (Event *event_ptr)
 
virtual void WillResume (lldb::StateType resume_state)
 
virtual const char * GetDescription ()
 
virtual void SetDescription (const char *desc_cstr)
 
virtual bool IsValidForOperatingSystemThread (Thread &thread)
 
virtual bool WasContinueInterrupted (Thread &thread)
 A Continue operation can result in a false stop event before any execution has happened.
 
void OverrideShouldStop (bool override_value)
 
bool GetOverrideShouldStop ()
 
bool GetOverriddenShouldStopValue ()
 
StructuredData::ObjectSP GetExtendedInfo ()
 

Static Public Member Functions

static lldb::StopInfoSP CreateStopReasonWithBreakpointSiteID (Thread &thread, lldb::break_id_t break_id)
 
static lldb::StopInfoSP CreateStopReasonWithBreakpointSiteID (Thread &thread, lldb::break_id_t break_id, bool should_stop)
 
static lldb::StopInfoSP CreateStopReasonWithWatchpointID (Thread &thread, lldb::break_id_t watch_id, bool silently_continue=false)
 
static lldb::StopInfoSP CreateStopReasonWithSignal (Thread &thread, int signo, const char *description=nullptr, std::optional< int > code=std::nullopt)
 
static lldb::StopInfoSP CreateStopReasonToTrace (Thread &thread)
 
static lldb::StopInfoSP CreateStopReasonWithPlan (lldb::ThreadPlanSP &plan, lldb::ValueObjectSP return_valobj_sp, lldb::ExpressionVariableSP expression_variable_sp)
 
static lldb::StopInfoSP CreateStopReasonWithException (Thread &thread, const char *description)
 
static lldb::StopInfoSP CreateStopReasonWithExec (Thread &thread)
 
static lldb::StopInfoSP CreateStopReasonProcessorTrace (Thread &thread, const char *description)
 
static lldb::StopInfoSP CreateStopReasonFork (Thread &thread, lldb::pid_t child_pid, lldb::tid_t child_tid)
 
static lldb::StopInfoSP CreateStopReasonVFork (Thread &thread, lldb::pid_t child_pid, lldb::tid_t child_tid)
 
static lldb::StopInfoSP CreateStopReasonVForkDone (Thread &thread)
 
static lldb::ValueObjectSP GetReturnValueObject (lldb::StopInfoSP &stop_info_sp)
 
static lldb::ExpressionVariableSP GetExpressionVariable (lldb::StopInfoSP &stop_info_sp)
 
static lldb::ValueObjectSP GetCrashingDereference (lldb::StopInfoSP &stop_info_sp, lldb::addr_t *crashing_address=nullptr)
 

Protected Member Functions

virtual void PerformAction (Event *event_ptr)
 
virtual bool DoShouldNotify (Event *event_ptr)
 
virtual bool ShouldStop (Event *event_ptr)
 
bool HasTargetRunSinceMe ()
 
void MakeStopInfoValid ()
 

Protected Attributes

lldb::ThreadWP m_thread_wp
 
uint32_t m_stop_id
 
uint32_t m_resume_id
 
uint64_t m_value
 
std::string m_description
 
LazyBool m_override_should_notify
 
LazyBool m_override_should_stop
 
StructuredData::ObjectSP m_extended_info
 

Private Member Functions

 StopInfo (const StopInfo &)=delete
 
const StopInfo & operator= (const StopInfo &)=delete
 

Friends

class Process::ProcessEventData
 
class ThreadPlanBase
 
class Thread
 

Detailed Description

Definition at line 20 of file StopInfo.h.

Constructor & Destructor Documentation

◆ StopInfo() [1/2]

StopInfo::StopInfo ( Thread &  thread,
uint64_t  value 
)

Definition at line 33 of file StopInfo.cpp.

◆ ~StopInfo()

virtual lldb_private::StopInfo::~StopInfo ( )
virtualdefault

◆ StopInfo() [2/2]

lldb_private::StopInfo::StopInfo ( const StopInfo &  )
privatedelete

Member Function Documentation

◆ CreateStopReasonFork()

StopInfoSP StopInfo::CreateStopReasonFork ( Thread &  thread,
lldb::pid_t  child_pid,
lldb::tid_t  child_tid 
)
static

Definition at line 1418 of file StopInfo.cpp.

Referenced by lldb_private::process_gdb_remote::ProcessGDBRemote::SetThreadStopInfo().

◆ CreateStopReasonProcessorTrace()

StopInfoSP StopInfo::CreateStopReasonProcessorTrace ( Thread &  thread,
const char *  description 
)
static

Definition at line 1409 of file StopInfo.cpp.

Referenced by lldb_private::process_gdb_remote::ProcessGDBRemote::SetThreadStopInfo().

◆ CreateStopReasonToTrace()

StopInfoSP StopInfo::CreateStopReasonToTrace ( Thread &  thread)
static

Definition at line 1393 of file StopInfo.cpp.

Referenced by lldb_private::ScriptedThread::CalculateStopInfo(), lldb_private::StopInfoMachException::CreateStopReasonWithMachException(), lldb_private::ThreadPlanStepInRange::DoWillResume(), lldb_private::ProcessWindows::RefreshStateAfterStop(), and lldb_private::process_gdb_remote::ProcessGDBRemote::SetThreadStopInfo().

◆ CreateStopReasonVFork()

StopInfoSP StopInfo::CreateStopReasonVFork ( Thread &  thread,
lldb::pid_t  child_pid,
lldb::tid_t  child_tid 
)
static

Definition at line 1425 of file StopInfo.cpp.

Referenced by lldb_private::process_gdb_remote::ProcessGDBRemote::SetThreadStopInfo().

◆ CreateStopReasonVForkDone()

StopInfoSP StopInfo::CreateStopReasonVForkDone ( Thread &  thread)
static

Definition at line 1431 of file StopInfo.cpp.

Referenced by lldb_private::process_gdb_remote::ProcessGDBRemote::SetThreadStopInfo().

◆ CreateStopReasonWithBreakpointSiteID() [1/2]

static lldb::StopInfoSP lldb_private::StopInfo::CreateStopReasonWithBreakpointSiteID ( Thread &  thread,
lldb::break_id_t  break_id 
)
static

Referenced by lldb_private::ScriptedThread::CalculateStopInfo(), lldb_private::process_gdb_remote::ProcessGDBRemote::CalculateThreadStopInfo(), lldb_private::StopInfoMachException::CreateStopReasonWithMachException(), GetStopInfoForHardwareBP(), lldb_private::ProcessWindows::RefreshStateAfterStop(), and lldb_private::process_gdb_remote::ProcessGDBRemote::SetThreadStopInfo().

◆ CreateStopReasonWithBreakpointSiteID() [2/2]

static lldb::StopInfoSP lldb_private::StopInfo::CreateStopReasonWithBreakpointSiteID ( Thread &  thread,
lldb::break_id_t  break_id,
bool  should_stop 
)
static

◆ CreateStopReasonWithException()

StopInfoSP StopInfo::CreateStopReasonWithException ( Thread &  thread,
const char *  description 
)
static

Definition at line 1404 of file StopInfo.cpp.

Referenced by ThreadMachCore::CalculateStopInfo(), lldb_private::ScriptedThread::CalculateStopInfo(), lldb_private::minidump::ProcessMinidump::RefreshStateAfterStop(), lldb_private::ProcessWindows::RefreshStateAfterStop(), and lldb_private::process_gdb_remote::ProcessGDBRemote::SetThreadStopInfo().

◆ CreateStopReasonWithExec()

StopInfoSP StopInfo::CreateStopReasonWithExec ( Thread &  thread)
static

Definition at line 1414 of file StopInfo.cpp.

Referenced by lldb_private::StopInfoMachException::CreateStopReasonWithMachException(), and lldb_private::process_gdb_remote::ProcessGDBRemote::SetThreadStopInfo().

◆ CreateStopReasonWithPlan()

StopInfoSP StopInfo::CreateStopReasonWithPlan ( lldb::ThreadPlanSP &  plan,
lldb::ValueObjectSP  return_valobj_sp,
lldb::ExpressionVariableSP  expression_variable_sp 
)
static

Definition at line 1397 of file StopInfo.cpp.

Referenced by lldb_private::Thread::GetStopInfo().

◆ CreateStopReasonWithSignal()

StopInfoSP StopInfo::CreateStopReasonWithSignal ( Thread &  thread,
int  signo,
const char *  description = nullptr,
std::optional< int >  code = std::nullopt 
)
static

Definition at line 1386 of file StopInfo.cpp.

References lldb_private::Thread::GetProcess().

Referenced by ThreadElfCore::CalculateStopInfo(), ThreadKDP::CalculateStopInfo(), lldb_private::ScriptedThread::CalculateStopInfo(), lldb_private::StopInfoMachException::CreateStopReasonWithMachException(), lldb_private::minidump::ProcessMinidump::RefreshStateAfterStop(), lldb_private::Thread::SetStopInfoToNothing(), and lldb_private::process_gdb_remote::ProcessGDBRemote::SetThreadStopInfo().

◆ CreateStopReasonWithWatchpointID()

StopInfoSP StopInfo::CreateStopReasonWithWatchpointID ( Thread &  thread,
lldb::break_id_t  watch_id,
bool  silently_continue = false 
)
static

Definition at line 1379 of file StopInfo.cpp.

Referenced by lldb_private::StopInfoMachException::CreateStopReasonWithMachException(), GetStopInfoForHardwareBP(), lldb_private::ProcessWindows::RefreshStateAfterStop(), and lldb_private::process_gdb_remote::ProcessGDBRemote::SetThreadStopInfo().

◆ DoShouldNotify()

virtual bool lldb_private::StopInfo::DoShouldNotify ( Event *  event_ptr)
inlineprotectedvirtual

Reimplemented in lldb_private::InstrumentationRuntimeStopInfo, lldb_private::StopInfoBreakpoint, and lldb_private::StopInfoUnixSignal.

Definition at line 168 of file StopInfo.h.

Referenced by ShouldNotify().

◆ GetCrashingDereference()

lldb::ValueObjectSP StopInfo::GetCrashingDereference ( lldb::StopInfoSP &  stop_info_sp,
lldb::addr_t *  crashing_address = nullptr 
)
static

Definition at line 1456 of file StopInfo.cpp.

References DoNoSelectMostRelevantFrame.

Referenced by CommandObjectFrameDiagnose::DoExecute(), and lldb_private::Process::HandleProcessStateChangedEvent().

◆ GetDescription()

virtual const char * lldb_private::StopInfo::GetDescription ( )
inlinevirtual

Reimplemented in lldb_private::InstrumentationRuntimeStopInfo, lldb_private::StopInfoMachException, lldb_private::StopInfoBreakpoint, lldb_private::StopInfoWatchpoint, lldb_private::StopInfoUnixSignal, lldb_private::StopInfoTrace, lldb_private::StopInfoException, lldb_private::StopInfoProcessorTrace, lldb_private::StopInfoThreadPlan, lldb_private::StopInfoExec, lldb_private::StopInfoFork, lldb_private::StopInfoVFork, and lldb_private::StopInfoVForkDone.

Definition at line 71 of file StopInfo.h.

References m_description.

◆ GetExpressionVariable()

ExpressionVariableSP StopInfo::GetExpressionVariable ( lldb::StopInfoSP &  stop_info_sp)
static

Definition at line 1445 of file StopInfo.cpp.

References lldb::eStopReasonPlanComplete, and lldb_private::StopInfoThreadPlan::GetExpressionVariable().

Referenced by lldb_private::FormatEntity::Format().

◆ GetExtendedInfo()

StructuredData::ObjectSP lldb_private::StopInfo::GetExtendedInfo ( )
inline

Definition at line 106 of file StopInfo.h.

References m_extended_info.

◆ GetOverriddenShouldStopValue()

bool lldb_private::StopInfo::GetOverriddenShouldStopValue ( )
inline

Definition at line 102 of file StopInfo.h.

References lldb_private::eLazyBoolYes, and m_override_should_stop.

◆ GetOverrideShouldStop()

bool lldb_private::StopInfo::GetOverrideShouldStop ( )
inline

Definition at line 98 of file StopInfo.h.

References lldb_private::eLazyBoolCalculate, and m_override_should_stop.

◆ GetReturnValueObject()

ValueObjectSP StopInfo::GetReturnValueObject ( lldb::StopInfoSP &  stop_info_sp)
static

Definition at line 1435 of file StopInfo.cpp.

References lldb::eStopReasonPlanComplete, and lldb_private::StopInfoThreadPlan::GetReturnValueObject().

Referenced by lldb_private::FormatEntity::Format(), and lldb::SBThread::GetStopReturnValue().

◆ GetStopReason()

virtual lldb::StopReason lldb_private::StopInfo::GetStopReason ( ) const
pure virtual

Implemented in lldb_private::InstrumentationRuntimeStopInfo, lldb_private::StopInfoMachException, lldb_private::StopInfoBreakpoint, lldb_private::StopInfoWatchpoint, lldb_private::StopInfoUnixSignal, lldb_private::StopInfoTrace, lldb_private::StopInfoException, lldb_private::StopInfoProcessorTrace, lldb_private::StopInfoThreadPlan, lldb_private::StopInfoExec, lldb_private::StopInfoFork, lldb_private::StopInfoVFork, and lldb_private::StopInfoVForkDone.

◆ GetThread()

lldb::ThreadSP lldb_private::StopInfo::GetThread ( ) const
inline

Definition at line 34 of file StopInfo.h.

References m_thread_wp.

Referenced by lldb_private::StopInfoBreakpoint::PerformAction().

◆ GetValue()

uint64_t lldb_private::StopInfo::GetValue ( ) const
inline

Definition at line 45 of file StopInfo.h.

References m_value.

Referenced by lldb_private::StopInfoMachException::GetDescription(), lldb_private::StopInfoWatchpoint::PerformAction(), and lldb_private::StopInfoWatchpoint::ShouldStopSynchronous().

◆ HasTargetRunSinceMe()

bool StopInfo::HasTargetRunSinceMe ( )
protected

Definition at line 55 of file StopInfo.cpp.

References lldb::eStateRunning, lldb::eStateStopped, m_resume_id, and m_thread_wp.

Referenced by lldb_private::StopInfoBreakpoint::PerformAction(), and lldb_private::StopInfoWatchpoint::PerformAction().

◆ IsValid()

bool StopInfo::IsValid ( ) const

Definition at line 40 of file StopInfo.cpp.

References m_stop_id, and m_thread_wp.

◆ IsValidForOperatingSystemThread()

virtual bool lldb_private::StopInfo::IsValidForOperatingSystemThread ( Thread &  thread)
inlinevirtual

Reimplemented in lldb_private::StopInfoBreakpoint.

Definition at line 80 of file StopInfo.h.

◆ MakeStopInfoValid()

void StopInfo::MakeStopInfoValid ( )
protected

Definition at line 47 of file StopInfo.cpp.

References m_resume_id, m_stop_id, and m_thread_wp.

◆ operator=()

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

◆ OverrideShouldNotify()

void lldb_private::StopInfo::OverrideShouldNotify ( bool  override_value)
inline

Definition at line 55 of file StopInfo.h.

References lldb_private::eLazyBoolNo, lldb_private::eLazyBoolYes, and m_override_should_notify.

◆ OverrideShouldStop()

void lldb_private::StopInfo::OverrideShouldStop ( bool  override_value)
inline

Definition at line 94 of file StopInfo.h.

References lldb_private::eLazyBoolNo, lldb_private::eLazyBoolYes, and m_override_should_stop.

◆ PerformAction()

virtual void lldb_private::StopInfo::PerformAction ( Event *  event_ptr)
inlineprotectedvirtual

Reimplemented in lldb_private::StopInfoBreakpoint, lldb_private::StopInfoWatchpoint, lldb_private::StopInfoExec, lldb_private::StopInfoFork, lldb_private::StopInfoVFork, and lldb_private::StopInfoVForkDone.

Definition at line 166 of file StopInfo.h.

◆ SetDescription()

virtual void lldb_private::StopInfo::SetDescription ( const char *  desc_cstr)
inlinevirtual

Definition at line 73 of file StopInfo.h.

References m_description.

Referenced by lldb_private::StopInfoException::StopInfoException(), lldb_private::StopInfoProcessorTrace::StopInfoProcessorTrace(), and lldb_private::StopInfoUnixSignal::StopInfoUnixSignal().

◆ SetThread()

void lldb_private::StopInfo::SetThread ( const lldb::ThreadSP &  thread_sp)
inline

Definition at line 32 of file StopInfo.h.

References m_thread_wp.

◆ ShouldNotify()

virtual bool lldb_private::StopInfo::ShouldNotify ( Event *  event_ptr)
inlinevirtual

Definition at line 60 of file StopInfo.h.

References DoShouldNotify(), lldb_private::eLazyBoolCalculate, lldb_private::eLazyBoolYes, and m_override_should_notify.

◆ ShouldStop()

virtual bool lldb_private::StopInfo::ShouldStop ( Event *  event_ptr)
inlineprotectedvirtual

Reimplemented in lldb_private::StopInfoBreakpoint, lldb_private::StopInfoWatchpoint, lldb_private::StopInfoUnixSignal, lldb_private::StopInfoThreadPlan, lldb_private::StopInfoExec, lldb_private::StopInfoFork, lldb_private::StopInfoVFork, and lldb_private::StopInfoVForkDone.

Definition at line 177 of file StopInfo.h.

Referenced by lldb_private::StopInfoThreadPlan::ShouldStop().

◆ ShouldStopSynchronous()

virtual bool lldb_private::StopInfo::ShouldStopSynchronous ( Event *  event_ptr)
inlinevirtual

Reimplemented in lldb_private::StopInfoBreakpoint, lldb_private::StopInfoWatchpoint, and lldb_private::StopInfoUnixSignal.

Definition at line 53 of file StopInfo.h.

◆ WasContinueInterrupted()

virtual bool lldb_private::StopInfo::WasContinueInterrupted ( Thread &  thread)
inlinevirtual

A Continue operation can result in a false stop event before any execution has happened.

We need to detect this and silently continue again one more time.

Reimplemented in lldb_private::StopInfoMachException.

Definition at line 85 of file StopInfo.h.

◆ WillResume()

virtual void lldb_private::StopInfo::WillResume ( lldb::StateType  resume_state)
inlinevirtual

Reimplemented in lldb_private::StopInfoUnixSignal.

Definition at line 67 of file StopInfo.h.

Referenced by lldb_private::Thread::ShouldResume().

Friends And Related Function Documentation

◆ Process::ProcessEventData

friend class Process::ProcessEventData
friend

Definition at line 21 of file StopInfo.h.

◆ Thread

friend class Thread
friend

Definition at line 203 of file StopInfo.h.

◆ ThreadPlanBase

friend class ThreadPlanBase
friend

Definition at line 22 of file StopInfo.h.

Member Data Documentation

◆ m_description

std::string lldb_private::StopInfo::m_description
protected

Definition at line 185 of file StopInfo.h.

Referenced by lldb_private::StopInfoMachException::DeterminePtrauthFailure(), GetDescription(), lldb_private::InstrumentationRuntimeStopInfo::GetDescription(), lldb_private::StopInfoMachException::GetDescription(), lldb_private::StopInfoBreakpoint::GetDescription(), lldb_private::StopInfoWatchpoint::GetDescription(), lldb_private::StopInfoUnixSignal::GetDescription(), lldb_private::StopInfoTrace::GetDescription(), lldb_private::StopInfoException::GetDescription(), lldb_private::StopInfoProcessorTrace::GetDescription(), lldb_private::StopInfoThreadPlan::GetDescription(), lldb_private::InstrumentationRuntimeStopInfo::InstrumentationRuntimeStopInfo(), and SetDescription().

◆ m_extended_info

StructuredData::ObjectSP lldb_private::StopInfo::m_extended_info
protected

Definition at line 190 of file StopInfo.h.

Referenced by GetExtendedInfo(), and lldb_private::InstrumentationRuntimeStopInfo::InstrumentationRuntimeStopInfo().

◆ m_override_should_notify

LazyBool lldb_private::StopInfo::m_override_should_notify
protected

Definition at line 186 of file StopInfo.h.

Referenced by OverrideShouldNotify(), and ShouldNotify().

◆ m_override_should_stop

LazyBool lldb_private::StopInfo::m_override_should_stop
protected

Definition at line 187 of file StopInfo.h.

Referenced by GetOverriddenShouldStopValue(), GetOverrideShouldStop(), and OverrideShouldStop().

◆ m_resume_id

uint32_t lldb_private::StopInfo::m_resume_id
protected

Definition at line 182 of file StopInfo.h.

Referenced by HasTargetRunSinceMe(), and MakeStopInfoValid().

◆ m_stop_id

uint32_t lldb_private::StopInfo::m_stop_id
protected

Definition at line 181 of file StopInfo.h.

Referenced by IsValid(), and MakeStopInfoValid().

◆ m_thread_wp

lldb::ThreadWP lldb_private::StopInfo::m_thread_wp
protected

Definition at line 180 of file StopInfo.h.

Referenced by lldb_private::StopInfoUnixSignal::DoShouldNotify(), lldb_private::StopInfoMachException::GetDescription(), lldb_private::StopInfoBreakpoint::GetDescription(), lldb_private::StopInfoUnixSignal::GetDescription(), GetThread(), HasTargetRunSinceMe(), IsValid(), MakeStopInfoValid(), lldb_private::StopInfoBreakpoint::PerformAction(), lldb_private::StopInfoWatchpoint::PerformAction(), lldb_private::StopInfoExec::PerformAction(), lldb_private::StopInfoFork::PerformAction(), lldb_private::StopInfoVFork::PerformAction(), lldb_private::StopInfoVForkDone::PerformAction(), SetThread(), lldb_private::StopInfoUnixSignal::ShouldStop(), lldb_private::StopInfoExec::ShouldStop(), lldb_private::StopInfoBreakpoint::ShouldStopSynchronous(), lldb_private::StopInfoWatchpoint::ShouldStopSynchronous(), lldb_private::StopInfoUnixSignal::ShouldStopSynchronous(), lldb_private::StopInfoBreakpoint::StoreBPInfo(), and lldb_private::StopInfoUnixSignal::WillResume().

◆ m_value

uint64_t lldb_private::StopInfo::m_value
protected

Definition at line 183 of file StopInfo.h.

Referenced by lldb_private::StopInfoMachException::DeterminePtrauthFailure(), lldb_private::StopInfoUnixSignal::DoShouldNotify(), lldb_private::StopInfoMachException::GetDescription(), lldb_private::StopInfoBreakpoint::GetDescription(), lldb_private::StopInfoWatchpoint::GetDescription(), lldb_private::StopInfoUnixSignal::GetDescription(), GetValue(), lldb_private::StopInfoBreakpoint::IsValidForOperatingSystemThread(), lldb_private::StopInfoBreakpoint::PerformAction(), lldb_private::StopInfoWatchpoint::PerformAction(), lldb_private::StopInfoUnixSignal::ShouldStop(), lldb_private::StopInfoBreakpoint::ShouldStopSynchronous(), lldb_private::StopInfoUnixSignal::ShouldStopSynchronous(), lldb_private::StopInfoBreakpoint::StoreBPInfo(), and lldb_private::StopInfoUnixSignal::WillResume().

The documentation for this class was generated from the following files:
Generated on Fri Apr 19 2024 22:04:57 for LLDB by doxygen 1.9.6