104 lines · python
1from abc import abstractmethod2 3import lldb4import struct5 6from lldb.plugins.scripted_process import ScriptedThread7 8 9class OperatingSystem(ScriptedThread):10 """11 Class that provides data for an instance of a LLDB 'OperatingSystemPython' plug-in class.12 13 .. code-block:: python14 15 thread_info = {16 "tid": tid,17 "name": "four",18 "queue": "queue4",19 "state": "stopped",20 "stop_reason": "none",21 "core" : 222 }23 24 - tid : thread ID (mandatory)25 - name : thread name (optional key/value pair)26 - queue : thread dispatch queue name (optional key/value pair)27 - state : thread state (mandatory, set to 'stopped' for now)28 - core : the index of the core (lldb) thread that this OS Thread should shadow29 - stop_reason : thread stop reason. (mandatory, usually set to 'none')30 Possible values include:31 - 'breakpoint': thread is stopped at a breakpoint32 - 'none': thread is stopped because the process is stopped33 - 'trace': thread is stopped after single stepping34 The usual value for this while threads are in memory is 'none'35 - register_data_addr : the address of the register data in memory (optional key/value pair)36 Specifying this key/value pair for a thread will avoid a call to get_register_data()37 and can be used when your registers are in a thread context structure that is contiguous38 in memory. Don't specify this if your register layout in memory doesn't match the layout39 described by the dictionary returned from a call to the get_register_info() method.40 """41 42 def __init__(self, process):43 """Initialization needs a valid lldb.SBProcess object. This plug-in44 will get created after a live process is valid and has stopped for the45 first time.46 47 Args:48 process (lldb.SBProcess): The process owning this thread.49 """50 self.registers = None51 super().__init__(process, None)52 self.registers = self.register_info53 self.threads = []54 55 def create_thread(self, tid, context):56 """Lazily create an operating system thread using a thread information57 dictionary and an optional operating system thread context address.58 This method is called manually, using the SBAPI59 `lldb.SBProcess.CreateOSPluginThread` affordance.60 61 Args:62 tid (int): Thread ID to get `thread_info` dictionary for.63 context (int): Address of the operating system thread struct.64 65 Returns:66 Dict: The `thread_info` dictionary containing the various information67 for lldb to create a Thread object and add it to the process thread list.68 """69 return None70 71 @abstractmethod72 def get_thread_info(self):73 """Get the list of operating system threads. This method gets called74 automatically every time the process stops and it needs to update its75 thread list.76 77 Returns:78 List[thread_info]: A list of `os_thread` dictionaries79 containing at least for each entry, the thread id, it's name,80 queue, state, stop reason. It can also contain a81 `register_data_addr`. The list can be empty.82 """83 pass84 85 @abstractmethod86 def get_register_data(self, tid):87 """Get the operating system thread register context for given a thread88 id. This method is called when unwinding the stack of one of the89 operating system threads.90 91 Args:92 tid (int): Thread ID to get register context for.93 94 Returns:95 str: A byte representing all register's value.96 """97 pass98 99 def get_register_context(self):100 pass101 102 def get_stop_reason(self):103 pass104