matos/custom_gdb_extension.py

235 lines
7.6 KiB
Python
Raw Permalink Normal View History

2020-08-20 23:38:17 +02:00
from gdb.printing import PrettyPrinter, register_pretty_printer
import gdb
class KthreadPrettyPrinter(object):
def __init__(self, val):
self.val = val
def to_string(self):
result = ""
name = self.val["name"]
state = self.val["state"]
# Should get PC on stack for non-current thread otherwise will only get address in cpu_context_switch
cpuState = self.val["cpuState"]
cmdline = "info line *%s"%int(cpuState["eip"].cast(gdb.lookup_type("long").pointer()))
line = gdb.execute(cmdline, to_string=True)
#line = gdb.find_pc_line(int(cpuState["eip"].cast(gdb.lookup_type("long").pointer()).referenced_value()))
currentThread = gdb.parse_and_eval("currentThread")
2021-11-04 20:14:48 +01:00
if self.val.address == currentThread:
2020-08-20 23:38:17 +02:00
result += "->"
else:
result += " "
2021-11-04 20:14:48 +01:00
result += "Addr: 0x%x, name: %s, state: %s, PC: %s" % (self.val.address, name, state, line)
2020-08-20 23:38:17 +02:00
return result
class CustomPrettyPrinterLocator(PrettyPrinter):
"""Given a gdb.Value, search for a custom pretty printer"""
def __init__(self):
super(CustomPrettyPrinterLocator, self).__init__(
"matos_pretty_printers", []
)
def __call__(self, val):
"""Return the custom formatter if the type can be handled"""
typename = gdb.types.get_basic_type(val.type).tag
if typename is None:
typename = val.type.name
2021-10-30 14:18:21 +02:00
if typename == "thread":
2020-08-20 23:38:17 +02:00
return KthreadPrettyPrinter(val)
2021-10-30 14:18:21 +02:00
class threadListDumpCmd(gdb.Command):
"""Prints the thread list"""
2020-08-19 15:02:56 +02:00
def __init__(self):
2021-10-30 14:18:21 +02:00
super(threadListDumpCmd, self).__init__(
"thread_list_dump", gdb.COMMAND_USER
2020-08-19 15:02:56 +02:00
)
2021-10-30 14:18:21 +02:00
def _thread_list_to_str(self, val):
2020-08-19 15:02:56 +02:00
"""Walk through the Kthread list.
We will simply follow the 'next' pointers until we encounter the HEAD again
"""
idx = 0
head = val
2021-10-30 14:18:21 +02:00
thread_ptr = val
2020-08-19 15:02:56 +02:00
result = ""
2021-10-30 14:18:21 +02:00
while thread_ptr != 0 and (idx == 0 or thread_ptr != head):
result += "\n%d: %s" % (idx, KthreadPrettyPrinter(thread_ptr).to_string())
thread_ptr = thread_ptr["next"]
2020-08-19 15:02:56 +02:00
idx += 1
2021-10-30 14:18:21 +02:00
result = ("Found a Linked List with %d thread:" % idx) + result
2020-08-19 15:02:56 +02:00
return result
def complete(self, text, word):
# We expect the argument passed to be a symbol so fallback to the
# internal tab-completion handler for symbols
return gdb.COMPLETE_SYMBOL
def invoke(self, args, from_tty):
# We can pass args here and use Python CLI utilities like argparse
# to do argument parsing
print("Args Passed: %s" % args)
2020-08-20 23:38:17 +02:00
if args:
2021-10-30 14:18:21 +02:00
thread_ptr_val = gdb.parse_and_eval(args)
2020-08-20 23:38:17 +02:00
else:
2021-10-30 14:18:21 +02:00
thread_ptr_val = gdb.parse_and_eval("currentThread")
if str(thread_ptr_val.type) != "struct thread *":
print("Expected pointer argument of type (struct thread *)")
2020-08-19 15:02:56 +02:00
return
2021-10-30 14:18:21 +02:00
print(self._thread_list_to_str(thread_ptr_val))
2020-08-19 15:02:56 +02:00
2021-04-09 20:46:49 +02:00
class PhyMemDescListDumpCmd(gdb.Command):
"""Prints the memDesc list"""
def __init__(self):
super(PhyMemDescListDumpCmd, self).__init__(
"phyMem_list_dump", gdb.COMMAND_USER)
def _phy_memDesc_lit_to_str(self, val):
result = ""
idx = 0
head = val
memDesc_ptr = val
prevAddr = None
printBegin = True
memAddrs = []
while memDesc_ptr != 0 and (idx == 0 or memDesc_ptr != head):
memAddrs.append(int(memDesc_ptr["phy_addr"]))
memDesc_ptr = memDesc_ptr["next"]
idx += 1
memAddrs.sort()
for currAddr in memAddrs:
if printBegin:
prevAddr = currAddr
result += "[0x%x" % prevAddr
printBegin = False
if currAddr > prevAddr + 4096:
result += "->0x%x[\n[0x%x" % ((prevAddr+4096), currAddr)
prevAddr = currAddr
if prevAddr:
result += "->0x%x[\n" % (prevAddr+4096)
result = ("Found a List with %d memDesc:\n" % idx) + result
return result
def complete(self, text, word):
return gdb.COMPLETE_SYMBOL
def invoke(self, args, from_tty):
if args:
desc = gdb.parse_and_eval(args)
else:
2021-04-10 21:53:03 +02:00
desc = gdb.parse_and_eval("phyFreePage")
2021-04-09 20:46:49 +02:00
if str(desc.type) != "struct memDesc *":
print("Expected pointer argument of type (struct memDesc *)")
return
print(self._phy_memDesc_lit_to_str(desc))
class PrintStructC99Cmd(gdb.Command):
def __init__(self):
super(PrintStructC99Cmd, self).__init__(
"print_struct_c99",
gdb.COMMAND_USER,
)
def complete(self, text, word):
return gdb.COMPLETE_SYMBOL
def get_count_heading(self, string):
for i, s in enumerate(string):
if s != ' ':
break
return i
def extract_typename(self, string):
first_line = string.split('\n')[0]
return first_line.split('=')[1][:-1].strip()
def invoke(self, arg, from_tty):
gdb.execute("set print pretty")
gdb.execute('set pagination off')
gdb.execute('set print repeats 0')
gdb.execute('set print elements unlimited')
ret_ptype = gdb.execute('ptype {}'.format(arg), to_string=True)
tname = self.extract_typename(ret_ptype)
print('{} {} = {{'.format(tname, arg))
r = gdb.execute('p {}'.format(arg), to_string=True)
r = r.split('\n')
for rr in r[1:]:
if '=' not in rr:
print(rr)
continue
hs = self.get_count_heading(rr)
rr_s = rr.strip().split('=', 1)
rr_rval = rr_s[1].strip()
print(' ' * hs + '.' + rr_s[0] + '= ' + rr_rval)
2021-10-30 14:18:21 +02:00
class ListDumpCmd(gdb.Command):
"""Prints a linked list"""
def __init__(self):
super(ListDumpCmd, self).__init__(
"list_dump", gdb.COMMAND_USER
)
def _print_list(self, val, next_name):
"""Walk through the linked list.
We will simply follow the 'next' pointers until we encounter the HEAD again
"""
idx = 0
head = val
2021-10-30 14:18:21 +02:00
thread_ptr = val
result = ""
2021-10-30 14:18:21 +02:00
while thread_ptr != 0 and (idx == 0 or thread_ptr != head):
result += gdb.execute('p *({}){}'.format(str(thread_ptr.type),
thread_ptr), to_string=True)
thread_ptr = thread_ptr[next_name]
idx += 1
2021-10-30 14:18:21 +02:00
result = ("Found a Linked List with %d items:" % idx) + "\n" + result
return result
def complete(self, text, word):
# We expect the argument passed to be a symbol so fallback to the
# internal tab-completion handler for symbols
return gdb.COMPLETE_SYMBOL
def invoke(self, args, from_tty):
# We can pass args here and use Python CLI utilities like argparse
# to do argument parsing
print("Args Passed: %s" % args)
thread_name = "currentThread"
next_name = "next"
if(args):
args_arr = args.split()
thread_name = args_arr[0]
if(len(args_arr) >= 2):
next_name = args_arr[1]
ptr_val = gdb.parse_and_eval(thread_name)
try:
ptr_val[next_name]
except:
print("Expected pointer argument with a %s field" % next_name)
return
print(self._print_list(ptr_val, next_name))
2021-10-30 14:18:21 +02:00
2020-08-20 23:38:17 +02:00
register_pretty_printer(None, CustomPrettyPrinterLocator(), replace=True)
2021-10-30 14:18:21 +02:00
threadListDumpCmd()
2021-04-09 20:46:49 +02:00
PhyMemDescListDumpCmd()
PrintStructC99Cmd()
ListDumpCmd()