debug: add kapi formatter support

3 files changed, 51 insertions, 1 deletions

diff --git a/scripts/gdb/kapi/__init__.py b/scripts/gdb/kapi/__init__.py
new file mode 100644
index 0000000..c37c7b7
--- /dev/null
+++ b/scripts/gdb/kapi/__init__.py
@@ -0,0 +1,15 @@
+import gdb.printing
+
+from .address import KapiMemoryAddressPrinter
+
+
+def build_pretty_printers():
+    pp = gdb.printing.RegexpCollectionPrettyPrinter("kapi")
+    pp.add_printer(
+        "kapi_memory_address", "^kapi::memory::address<.*>$", KapiMemoryAddressPrinter
+    )
+    return pp
+
+
+def register_printers(objfile):
+    gdb.printing.register_pretty_printer(objfile, build_pretty_printers(), replace=True)
diff --git a/scripts/gdb/kapi/address.py b/scripts/gdb/kapi/address.py
new file mode 100644
index 0000000..677c9aa
--- /dev/null
+++ b/scripts/gdb/kapi/address.py
@@ -0,0 +1,33 @@
+import gdb
+
+
+class KapiMemoryAddressPrinter:
+    """Print kapi::MemoryAddress."""
+
+    def __init__(self, val):
+        self.val = val
+        self.address_type = val.type.template_argument(0)
+
+    def to_string(self):
+        try:
+            raw_address = int(self.val["m_value"])
+            type_string = str(self.address_type)
+
+            if "linear" in type_string:
+                suffix = "%lin"
+            elif "physical" in type_string:
+                suffix = "%phy"
+            else:
+                suffix = "%???"
+
+            return f"{raw_address:#018x}{suffix}"
+        except Exception as e:
+            return f"{self.val}: {e}"
+
+    def children(self):
+        if "linear" in str(self.address_type):
+            yield (
+                "std::byte *",
+                self.val["m_value"].cast(gdb.lookup_type("std::byte").pointer()),
+            )
+        yield ("m_value", self.val["m_value"])
diff --git a/scripts/gdb/load_kstd.py b/scripts/gdb/load.py
index f3adce1..ec512b7 100644
--- a/scripts/gdb/load_kstd.py
+++ b/scripts/gdb/load.py
@@ -8,7 +8,9 @@ if script_dir not in sys.path:
     sys.path.insert(0, script_dir)
 
 import kstd
+import kapi
 
 kstd.register_printers(gdb.current_objfile())
+kapi.register_printers(gdb.current_objfile())
 
-gdb.write("Loaded kstd pretty printers.\n")
+gdb.write("Loaded TeachOS pretty printers.\n")