Merge branch 'develop-BA-FS26' into 'develop'HEADdevelop

Merge of BA-FS26 branch into develop

See merge request teachos/kernel!49

9 files changed, 198 insertions, 0 deletions

diff --git a/kapi/gdb/__init__.py b/kapi/gdb/__init__.py
new file mode 100644
index 0000000..1b36753
--- /dev/null
+++ b/kapi/gdb/__init__.py
@@ -0,0 +1,35 @@
+import gdb.printing
+
+from .boot_modules import *
+from .devices import *
+from .memory import *
+
+
+def build_pretty_printers():
+    pp = gdb.printing.RegexpCollectionPrettyPrinter("kapi")
+    pp.add_printer(
+        "kapi_memory_address", "^kapi::memory::address<.*>$", KapiMemoryAddressPrinter
+    )
+    pp.add_printer(
+        "kapi_memory_chunk", "^kapi::memory::chunk<.*>$", KapiMemoryChunkPrinter
+    )
+    pp.add_printer("kapi_memory_frame", "^kapi::memory::frame$", KapiMemoryFramePrinter)
+    pp.add_printer("kapi_memory_page", "^kapi::memory::page$", KapiMemoryPagePrinter)
+    pp.add_printer(
+        "kapi_devices_device", "^kapi::devices::device$", KapiDevicesDevicePrinter
+    )
+    pp.add_printer(
+        "kapi_boot_modules_boot_module",
+        "^kapi::boot_modules::boot_module$",
+        KapiBootModulesBootModulePrinter,
+    )
+    pp.add_printer(
+        "kapi_boot_modules_boot_module_registry",
+        "^kapi::boot_modules::boot_module_registry$",
+        KapiBootModulesBootModuleRegistryPrinter,
+    )
+    return pp
+
+
+def register_printers(objfile):
+    gdb.printing.register_pretty_printer(objfile, build_pretty_printers(), replace=True)
diff --git a/kapi/gdb/boot_modules/__init__.py b/kapi/gdb/boot_modules/__init__.py
new file mode 100644
index 0000000..2a54136
--- /dev/null
+++ b/kapi/gdb/boot_modules/__init__.py
@@ -0,0 +1,2 @@
+from .boot_module import KapiBootModulesBootModulePrinter
+from .boot_module_registry import KapiBootModulesBootModuleRegistryPrinter
diff --git a/kapi/gdb/boot_modules/boot_module.py b/kapi/gdb/boot_modules/boot_module.py
new file mode 100644
index 0000000..97e6584
--- /dev/null
+++ b/kapi/gdb/boot_modules/boot_module.py
@@ -0,0 +1,44 @@
+import gdb
+from teachos import format_size
+
+
+class KapiBootModulesBootModulePrinter(gdb.ValuePrinter):
+    class Iterator:
+        def __init__(self, begin: gdb.Value, end: gdb.Value):
+            self._item = begin
+            self._end = end
+            self._count = 0
+
+        def __iter__(self):
+            return self
+
+        def __next__(self):
+            count = self._count
+            self._count = count + 1
+
+            if self._item == self._end:
+                raise StopIteration
+
+            element = self._item.dereference()
+            self._item += 1
+            return (f"[{count}]", element)
+
+    def __init__(self, val):
+        self.__pointer_type = gdb.lookup_type("std::byte").pointer()
+
+        self.__val = val
+        self.__name = val["name"]
+        self.__start = val["start_address"]
+        self.__size = int(val["size"])
+        self.__begin = val["start_address"]["m_value"].cast(self.__pointer_type)
+        self.__end = self.__begin + self.__size
+        self.__pretty_name = " " + str(self.__name) if str(self.__name) != '""' else ""
+
+    def to_string(self):
+        return f"boot module{self.__pretty_name} of size {format_size(self.__size)}, at {self.__start.cast(self.__pointer_type)}"
+
+    def children(self):
+        return self.Iterator(self.__begin, self.__end)
+
+    def display_hint(self):
+        return "array"
diff --git a/kapi/gdb/boot_modules/boot_module_registry.py b/kapi/gdb/boot_modules/boot_module_registry.py
new file mode 100644
index 0000000..599a823
--- /dev/null
+++ b/kapi/gdb/boot_modules/boot_module_registry.py
@@ -0,0 +1,20 @@
+import gdb
+from teachos import format_size
+
+
+class KapiBootModulesBootModuleRegistryPrinter(gdb.ValuePrinter):
+    def __init__(self, val: gdb.Value):
+        self.__val = val
+        self.__modules = val["m_modules"]
+        self.__size = int(self.__modules["m_size"])
+        self.__element_type = gdb.lookup_type("kapi::boot_modules::boot_module")
+
+    def to_string(self):
+        return f"boot module registry of size {self.__size}"
+
+    def children(self):
+        yield ("[size]", self.__size)
+        yield ("m_modules", self.__modules)
+
+    def display_hint(self):
+        return None
diff --git a/kapi/gdb/devices/__init__.py b/kapi/gdb/devices/__init__.py
new file mode 100644
index 0000000..3bab1ea
--- /dev/null
+++ b/kapi/gdb/devices/__init__.py
@@ -0,0 +1 @@
+from .device import KapiDevicesDevicePrinter
diff --git a/kapi/gdb/devices/device.py b/kapi/gdb/devices/device.py
new file mode 100644
index 0000000..8e515ef
--- /dev/null
+++ b/kapi/gdb/devices/device.py
@@ -0,0 +1,20 @@
+import gdb
+
+
+class KapiDevicesDevicePrinter(gdb.ValuePrinter):
+    def __init__(self, val):
+        self.__val = val
+
+    def to_string(self):
+        return (
+            f"{self.__val['m_name']} @ {self.__val['m_major']}:{self.__val['m_minor']}"
+        )
+
+    def children(self):
+        yield ("major", self.__val["m_major"])
+        yield ("minor", self.__val["m_minor"])
+        yield ("name", self.__val["m_name"])
+        yield ("parent", self.__val["m_parent"])
+
+    def display_hint(self):
+        return None
diff --git a/kapi/gdb/memory/__init__.py b/kapi/gdb/memory/__init__.py
new file mode 100644
index 0000000..2aa6564
--- /dev/null
+++ b/kapi/gdb/memory/__init__.py
@@ -0,0 +1,4 @@
+from .address import KapiMemoryAddressPrinter
+from .chunk import KapiMemoryFramePrinter
+from .chunk import KapiMemoryPagePrinter
+from .chunk import KapiMemoryChunkPrinter
diff --git a/kapi/gdb/memory/address.py b/kapi/gdb/memory/address.py
new file mode 100644
index 0000000..429db1d
--- /dev/null
+++ b/kapi/gdb/memory/address.py
@@ -0,0 +1,31 @@
+import gdb
+
+
+class KapiMemoryAddressPrinter(gdb.ValuePrinter):
+    def __init__(self, val):
+        self.__val = val
+        self.__type = val.type.template_argument(0)
+
+    def to_string(self):
+        try:
+            raw_address = int(self.__val["m_value"])
+            type_string = str(self.__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.__type):
+            pointer_type = gdb.lookup_type("std::byte").pointer()
+            yield ("[bytes]", self.__val["m_value"].cast(pointer_type))
+
+    def display_hint(self):
+        return None
diff --git a/kapi/gdb/memory/chunk.py b/kapi/gdb/memory/chunk.py
new file mode 100644
index 0000000..74b1407
--- /dev/null
+++ b/kapi/gdb/memory/chunk.py
@@ -0,0 +1,41 @@
+import gdb
+from teachos import format_size
+
+
+class KapiMemoryChunkPrinter(gdb.ValuePrinter):
+
+    def __init__(self, val: gdb.Value, typename="chunk"):
+        self.__val = val
+        try:
+            self.__number = int(val["m_number"])
+        except gdb.error:
+            self.__number = "<number unreadable>"
+
+        try:
+            self.__size = int(gdb.parse_and_eval(f"{val.type.name}::size")["value"])
+        except gdb.error:
+            self.__size = "<size unreadable>"
+
+        self.__typename = typename
+
+    def to_string(self):
+        return f"{self.__typename} {self.__number} of size {format_size(self.__size)}"
+
+    def children(self):
+        yield ("number", self.__number)
+        yield ("size", self.__size)
+
+    def display_hint(self):
+        return None
+
+
+class KapiMemoryFramePrinter(KapiMemoryChunkPrinter):
+
+    def __init__(self, val):
+        super().__init__(val, "frame")
+
+
+class KapiMemoryPagePrinter(KapiMemoryChunkPrinter):
+
+    def __init__(self, val):
+        super().__init__(val, "page")