ScriptedThread#

class lldb.plugins.scripted_process.ScriptedThread(process, args)#

The base class for a scripted thread.

Most of the base class methods are @abstractmethod that need to be overwritten by the inheriting class.

Methods Summary

get_extended_info()	Get scripted thread extended information.
get_name()	Get the scripted thread name.
get_queue()	Get the scripted thread associated queue name.
get_register_context()	Get the scripted thread register context
get_register_info()
get_stackframes()	Get the list of stack frames for the scripted thread.
get_state()	Get the scripted thread state type.
get_stop_reason()	Get the dictionary describing the stop reason type with some data.
get_thread_id()	Get the scripted thread identifier.
get_thread_idx()	Get the scripted thread index.

Methods Documentation

get_extended_info()#

Get scripted thread extended information.

Returns:

List: A list containing the extended information for the scripted process.

None if the thread as no extended information.

get_name()#

Get the scripted thread name.

Returns:

str: The name of the scripted thread.

get_queue()#

Get the scripted thread associated queue name.

This method is optional.

Returns:

str: The queue name associated with the scripted thread.

abstract get_register_context()#

Get the scripted thread register context

Returns:

str: A byte representing all register’s value.

get_register_info()#

get_stackframes()#

Get the list of stack frames for the scripted thread.

scripted_frame = {
    idx = 0,
    pc = 0xbadc0ffee
}

Returns:

List[scripted_frame]: A list of scripted_frame dictionaries

containing at least for each entry, the frame index and the program counter value for that frame. The list can be empty.

get_state()#

Get the scripted thread state type.

eStateStopped,   ///< Process or thread is stopped and can be examined.
eStateRunning,   ///< Process or thread is running and can't be examined.
eStateStepping,  ///< Process or thread is in the process of stepping and
                 /// can not be examined.
eStateCrashed,   ///< Process or thread has crashed and can be examined.

Returns:

int: The state type of the scripted thread.

Returns lldb.eStateStopped by default.

abstract get_stop_reason()#

Get the dictionary describing the stop reason type with some data.

This method is optional.

Returns:

Dict: The dictionary holding the stop reason type and the possibly the stop reason data.

get_thread_id()#

Get the scripted thread identifier.

Returns:

int: The identifier of the scripted thread.

get_thread_idx()#

Get the scripted thread index.

Returns:

int: The index of the scripted thread in the scripted process.