Files
clang-p2996/lldb/examples/python/scripted_process/my_scripted_process.py
Med Ismail Bennani a758c9f720 [lldb/Plugins] Add memory region support in ScriptedProcess
This patch adds support for memory regions in Scripted Processes.
This is necessary to read the stack memory region in order to
reconstruct each stackframe of the program.

In order to do so, this patch makes some changes to the SBAPI, namely:
- Add a new constructor for `SBMemoryRegionInfo` that takes arguments
  such as the memory region name, address range, permissions ...
  This is used when reading memory at some address to compute the offset
  in the binary blob provided by the user.
- Add a `GetMemoryRegionContainingAddress` method to `SBMemoryRegionInfoList`
  to simplify the access to a specific memory region.

With these changes, lldb is now able to unwind the stack and reconstruct
each frame. On top of that, reloading the target module at offset 0 allows
lldb to symbolicate the `ScriptedProcess` using debug info, similarly to an
ordinary Process.

To test this, I wrote a simple program with multiple function calls, ran it in
lldb, stopped at a leaf function and read the registers values and copied
the stack memory into a binary file. These are then used in the python script.

Differential Revision: https://reviews.llvm.org/D108953

Signed-off-by: Med Ismail Bennani <medismail.bennani@gmail.com>
2021-10-08 14:54:07 +02:00

136 lines
4.2 KiB
Python

import os,struct,signal
from typing import Any, Dict
import lldb
from lldb.plugins.scripted_process import ScriptedProcess
from lldb.plugins.scripted_process import ScriptedThread
class MyScriptedProcess(ScriptedProcess):
memory_regions = [
lldb.SBMemoryRegionInfo("stack", 0x1040b2000, 0x1040b4000, 0b110, True,
True)
]
stack_memory_dump = os.path.join(os.path.dirname(os.path.abspath(__file__)),
'main.stack-dump')
def __init__(self, target: lldb.SBTarget, args : lldb.SBStructuredData):
super().__init__(target, args)
def get_memory_region_containing_address(self, addr: int) -> lldb.SBMemoryRegionInfo:
for region in self.memory_regions:
if region.GetRegionBase() <= addr < region.GetRegionEnd():
return region
return None
def get_thread_with_id(self, tid: int):
return {}
def get_registers_for_thread(self, tid: int):
return {}
def read_memory_at_address(self, addr: int, size: int) -> lldb.SBData:
data = lldb.SBData()
with open(self.stack_memory_dump, 'rb') as f:
stack_mem = f.read(-1)
if not stack_mem:
return data
mem_region = self.get_memory_region_containing_address(addr)
if not mem_region or addr + size > mem_region.GetRegionEnd():
return data
offset = addr - mem_region.GetRegionBase()
shrunk_stack_mem = stack_mem[offset:offset + size]
error = lldb.SBError()
data.SetData(error, shrunk_stack_mem,
self.target.GetByteOrder(),
self.target.GetAddressByteSize())
return data
def get_loaded_images(self):
return self.loaded_images
def get_process_id(self) -> int:
return 42
def should_stop(self) -> bool:
return True
def is_alive(self) -> bool:
return True
def get_scripted_thread_plugin(self):
return MyScriptedThread.__module__ + "." + MyScriptedThread.__name__
class MyScriptedThread(ScriptedThread):
registers = {
"rax":0x00000000000006e4,
"rbx":0x00000001040b6060,
"rcx":0x00000001040b2e00,
"rdx":0x00000001040b2ba8,
"rdi":0x000000000000002a,
"rsi":0x00000001040b2b98,
"rbp":0x00000001040b2a20,
"rsp":0x00000001040b2a20,
"r8":0x00000000003e131e,
"r9":0xffffffff00000000,
"r10":0x0000000000000000,
"r11":0x0000000000000246,
"r12":0x000000010007c3a0,
"r13":0x00000001040b2b18,
"r14":0x0000000100003f90,
"r15":0x00000001040b2b88,
"rip":0x0000000100003f61,
"rflags":0x0000000000000206,
"cs":0x000000000000002b,
"fs":0x0000000000000000,
"gs":0x0000000000000000,
}
def __init__(self, target):
super().__init__(target)
def get_thread_id(self) -> int:
return 0x19
def get_name(self) -> str:
return MyScriptedThread.__name__ + ".thread-1"
def get_stop_reason(self) -> Dict[str, Any]:
return { "type": lldb.eStopReasonSignal, "data": {
"signal": signal.SIGINT
} }
def get_stackframes(self):
class ScriptedStackFrame:
def __init__(idx, cfa, pc, symbol_ctx):
self.idx = idx
self.cfa = cfa
self.pc = pc
self.symbol_ctx = symbol_ctx
symbol_ctx = lldb.SBSymbolContext()
frame_zero = ScriptedStackFrame(0, 0x42424242, 0x5000000, symbol_ctx)
self.frames.append(frame_zero)
return self.frame_zero[0:0]
def get_register_context(self) -> str:
return struct.pack("{}Q".format(len(self.registers)), *self.registers.values())
def __lldb_init_module(debugger, dict):
if not 'SKIP_SCRIPTED_PROCESS_LAUNCH' in os.environ:
debugger.HandleCommand(
"process launch -C %s.%s" % (__name__,
MyScriptedProcess.__name__))
else:
print("Name of the class that will manage the scripted process: '%s.%s'"
% (__name__, MyScriptedProcess.__name__))