SBThreadPlan

class lldb.SBThreadPlan(*args)

Represents a plan for the execution control of a given thread.

See also SBThread and SBFrame.

Methods Summary

Clear(SBThreadPlan self)
GetDescription(SBThreadPlan self, …)
GetStopOthers(SBThreadPlan self) Return whether this plan will ask to stop other threads when it runs.
GetStopReason(SBThreadPlan self)
GetStopReasonDataAtIndex(SBThreadPlan self, …) Get information associated with a stop reason.
GetStopReasonDataCount(SBThreadPlan self) Get the number of words associated with the stop reason.
GetThread(SBThreadPlan self)
IsPlanComplete(SBThreadPlan self)
IsPlanStale(SBThreadPlan self)
IsValid(SBThreadPlan self) IsValid(SBThreadPlan self) -> bool
QueueThreadPlanForRunToAddress(…) QueueThreadPlanForRunToAddress(SBThreadPlan self, SBAddress address, SBError error) -> SBThreadPlan
QueueThreadPlanForStepInRange(…) QueueThreadPlanForStepInRange(SBThreadPlan self, SBAddress start_address, lldb::addr_t range_size, SBError error) -> SBThreadPlan
QueueThreadPlanForStepOut(SBThreadPlan self, …) QueueThreadPlanForStepOut(SBThreadPlan self, uint32_t frame_idx_to_step_to, bool first_insn, SBError error) -> SBThreadPlan
QueueThreadPlanForStepOverRange(…) QueueThreadPlanForStepOverRange(SBThreadPlan self, SBAddress start_address, lldb::addr_t range_size, SBError error) -> SBThreadPlan
QueueThreadPlanForStepScripted(…) QueueThreadPlanForStepScripted(SBThreadPlan self, char const * script_class_name, SBError error) -> SBThreadPlan QueueThreadPlanForStepScripted(SBThreadPlan self, char const * script_class_name, SBStructuredData args_data, SBError error) -> SBThreadPlan
SetPlanComplete(SBThreadPlan self, bool success)
SetStopOthers(SBThreadPlan self, …) Set whether this plan will ask to stop other threads when it runs.

Methods Documentation

Clear(SBThreadPlan self)
GetDescription(SBThreadPlan self, SBStream description) → bool
GetStopOthers(SBThreadPlan self) → bool

Return whether this plan will ask to stop other threads when it runs.

GetStopReason(SBThreadPlan self) → lldb::StopReason
GetStopReasonDataAtIndex(SBThreadPlan self, uint32_t idx) → uint64_t

Get information associated with a stop reason.

Breakpoint stop reasons will have data that consists of pairs of breakpoint IDs followed by the breakpoint location IDs (they always come in pairs).

Stop Reason Count Data Type ======================== ===== ========================================= eStopReasonNone 0 eStopReasonTrace 0 eStopReasonBreakpoint N duple: {breakpoint id, location id} eStopReasonWatchpoint 1 watchpoint id eStopReasonSignal 1 unix signal number eStopReasonException N exception data eStopReasonExec 0 eStopReasonFork 1 pid of the child process eStopReasonVFork 1 pid of the child process eStopReasonVForkDone 0 eStopReasonPlanComplete 0

GetStopReasonDataCount(SBThreadPlan self) → size_t

Get the number of words associated with the stop reason. See also GetStopReasonDataAtIndex().

GetThread(SBThreadPlan self) → SBThread
IsPlanComplete(SBThreadPlan self) → bool
IsPlanStale(SBThreadPlan self) → bool
IsValid(SBThreadPlan self) → bool

IsValid(SBThreadPlan self) -> bool

QueueThreadPlanForRunToAddress(SBThreadPlan self, SBAddress address) → SBThreadPlan

QueueThreadPlanForRunToAddress(SBThreadPlan self, SBAddress address, SBError error) -> SBThreadPlan

QueueThreadPlanForStepInRange(SBThreadPlan self, SBAddress start_address, lldb::addr_t range_size) → SBThreadPlan

QueueThreadPlanForStepInRange(SBThreadPlan self, SBAddress start_address, lldb::addr_t range_size, SBError error) -> SBThreadPlan

QueueThreadPlanForStepOut(SBThreadPlan self, uint32_t frame_idx_to_step_to, bool first_insn=False) → SBThreadPlan

QueueThreadPlanForStepOut(SBThreadPlan self, uint32_t frame_idx_to_step_to, bool first_insn, SBError error) -> SBThreadPlan

QueueThreadPlanForStepOverRange(SBThreadPlan self, SBAddress start_address, lldb::addr_t range_size) → SBThreadPlan

QueueThreadPlanForStepOverRange(SBThreadPlan self, SBAddress start_address, lldb::addr_t range_size, SBError error) -> SBThreadPlan

QueueThreadPlanForStepScripted(SBThreadPlan self, char const * script_class_name) → SBThreadPlan

QueueThreadPlanForStepScripted(SBThreadPlan self, char const * script_class_name, SBError error) -> SBThreadPlan QueueThreadPlanForStepScripted(SBThreadPlan self, char const * script_class_name, SBStructuredData args_data, SBError error) -> SBThreadPlan

SetPlanComplete(SBThreadPlan self, bool success)
SetStopOthers(SBThreadPlan self, bool stop_others)

Set whether this plan will ask to stop other threads when it runs.