add scripting ability and correspoonding test

Author: ucgJhe

qiling/debugger/qdb/arch/arch.py

@@ -18,5 +18,9 @@ def __init__(self):
     def arch_insn_size(self):
         return 4
 
+    @property
+    def archbit(self):
+        return 4
+
     def read_insn(self, address: int):
         return self.read_mem(address, self.arch_insn_size)

qiling/debugger/qdb/context.py

@@ -74,7 +74,7 @@ def try_read_pointer(self, address: int) -> Optional[bytes]:
         try to read pointer size of data from ql.mem
         """
 
-        return self.try_read(address, self.arch_insn_size)
+        return self.try_read(address, self.archbit)
 
     def read_string(self, address: int) -> Optional[str]:
         """

qiling/debugger/qdb/memory.py

@@ -112,7 +112,7 @@ def parse(self, line: str):
             else:
                 args = line.split()
 
-                rest = args[0] if  len(args) == 1 else args
+                rest = [args[0]] if len(args) == 1 else args
 
                 fmt = self.get_default_fmt
 
@@ -134,10 +134,15 @@ def parse(self, line: str):
 
             line = " ".join(line)
             # substitue register name with real value
+            for each_reg in filter(lambda r: len(r) == 3, self.ql.reg.register_mapping):
+                reg = f"${each_reg}"
+                if reg in line:
+                    line = re.sub(f"\\{reg}", hex(self.ql.reg.read(each_reg)), line)
+
             for each_reg in filter(lambda r: len(r) == 2, self.ql.reg.register_mapping):
                 reg = f"${each_reg}"
                 if reg in line:
-                    line = re.sub(f"\{reg}", hex(self.ql.reg.read(each_reg)), line)
+                    line = re.sub(f"\\{reg}", hex(self.ql.reg.read(each_reg)), line)
 
 
             ft, sz, ct = fmt

qiling/debugger/qdb/qdb.py

@@ -11,7 +11,7 @@
 from qiling.const import QL_ARCH, QL_VERBOSE
 from qiling.debugger import QlDebugger
 
-from .utils import setup_context_render, setup_branch_predictor, SnapshotManager
+from .utils import setup_context_render, setup_branch_predictor, SnapshotManager, run_qdb_script
 from .memory import setup_memory_Manager
 from .misc import parse_int, Breakpoint, TempBreakpoint
 from .const import color
@@ -23,7 +23,7 @@ class QlQdb(cmd.Cmd, QlDebugger):
     The built-in debugger of Qiling Framework
     """
 
-    def __init__(self, ql: Qiling, init_hook: str = "", rr: bool = False) -> None:
+    def __init__(self, ql: Qiling, init_hook: str = "", rr: bool = False, script: str = "") -> None:
         """
         @init_hook: the entry to be paused at
         @rr: record/replay debugging
@@ -32,6 +32,7 @@ def __init__(self, ql: Qiling, init_hook: str = "", rr: bool = False) -> None:
         self.ql = ql
         self.prompt = f"{color.BOLD}{color.RED}Qdb> {color.END}"
         self._saved_reg_dump = None
+        self._script = script
         self.bp_list = {}
 
         self.rr = SnapshotManager(ql) if rr else None
@@ -82,8 +83,11 @@ def bp_handler(ql, address, size, bp_list):
         else:
             self.init_state = self.ql.save()
 
-        self.do_context()
-        self.interactive()
+        if self._script:
+            run_qdb_script(self, self._script)
+        else:
+            self.do_context()
+            self.interactive()
 
     @property
     def cur_addr(self) -> int:
@@ -354,6 +358,17 @@ def do_show(self, *args) -> None:
         if self.rr:
             qdb_print(QDB_MSG.INFO, f"Snapshots: {len([st for st in self.rr.layers if isinstance(st, self.rr.DiffedState)])}")
 
+    def do_script(self, filename: str) -> None:
+        """
+        usage: script [filename]
+        load a script for automate qdb funcitonality, execute qdb command line by line basically
+        """
+
+        if filename:
+            run_qdb_script(self, filename)
+        else:
+            qdb_print(QDB_MSG.ERROR, "parameter filename must be specified")
+
     def do_shell(self, *command) -> None:
         """
         run python code
@@ -370,12 +385,15 @@ def do_quit(self, *args) -> bool:
         """
 
         self.ql.stop()
+        if self._script:
+            return True
         exit()
 
     def do_EOF(self, *args) -> None:
         """
         handle Ctrl+D
         """
+
         if input(f"{color.RED}[!] Are you sure about saying good bye ~ ? [Y/n]{color.END} ").strip() == "Y":
             self.do_quit()
 

qiling/debugger/qdb/utils.py

@@ -80,6 +80,21 @@ def setup_context_render(ql, predictor):
             QL_ARCH.MIPS: ContextRenderMIPS,
             }.get(ql.archtype)(ql, predictor)
 
+def run_qdb_script(qdb, filename: str) -> None:
+    with open(filename) as fd:
+        for line in iter(fd.readline, ""):
+
+            # skip commented and empty line 
+            if line.startswith("#") or line == "\n":
+                continue
+
+            cmd, arg, _ = qdb.parseline(line)
+            func = getattr(qdb, f"do_{cmd}")
+            if arg:
+                func(arg)
+            else:
+                func()
+
 
 """
 

qiling/utils.py

@@ -587,4 +587,4 @@ def verify_ret(ql, err):
             else:
                 raise
     else:
-        raise
+        raise

tests/qdb_scripts/arm.qdb

@@ -0,0 +1,13 @@
+# This line is demonstrate comment in qdb script
+
+x/10wx 0x7ff3cee4
+x $sp
+x $sp + 0x10
+x/5i 0x047ba9e0
+b 0x047ba9ec
+c
+s
+n
+p
+p
+q

tests/qdb_scripts/mips32el.qdb

@@ -0,0 +1,13 @@
+# This line is demonstrate comment in qdb script
+
+x/10wx 0x7ff3cec0
+x $sp
+x $sp + 0x10
+x/5i 0x047bac40
+b 0x047bac50
+c
+s
+n
+p
+p
+q

tests/qdb_scripts/x86.qdb

@@ -0,0 +1,11 @@
+# This line is demonstrate comment in qdb script
+
+x/4wx 0x7ff3cee0
+x $esp
+x $esp + 0x4
+x/5i 0x047bac70
+s
+n
+p
+p
+q

tests/test_onlinux.sh

@@ -16,4 +16,5 @@ python3 ./test_android.py &&
 python3 ./test_mcu.py &&
 python3 ./test_evm.py &&
 python3 ./test_blob.py &&
+python3 ./test_qdb.py &&
 echo "Done Test"