git: d5d47e1e67cd - main - gdb: Make development a bit easier

From: Mark Johnston <markj_at_FreeBSD.org>
Date: Mon, 27 Oct 2025 16:39:11 UTC
The branch main has been updated by markj:

URL: https://cgit.FreeBSD.org/src/commit/?id=d5d47e1e67cdf1707cb460c2722894305f3cb34d

commit d5d47e1e67cdf1707cb460c2722894305f3cb34d
Author:     Mark Johnston <markj@FreeBSD.org>
AuthorDate: 2025-10-27 16:33:34 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2025-10-27 16:33:34 +0000

    gdb: Make development a bit easier
    
    Provide a command which can be used to reload gdb modules.
    
    MFC after:      1 week
---
 sys/tools/gdb/README.txt |  5 +++++
 sys/tools/kernel-gdb.py  | 36 ++++++++++++++++++++++++++++++++----
 2 files changed, 37 insertions(+), 4 deletions(-)

diff --git a/sys/tools/gdb/README.txt b/sys/tools/gdb/README.txt
index 8c31565ddc42..ad1544912c3c 100644
--- a/sys/tools/gdb/README.txt
+++ b/sys/tools/gdb/README.txt
@@ -8,6 +8,9 @@ be automatically loaded by kgdb when opening a vmcore, so if you add new GDB
 commands or functions, that script should be updated to import them, and you
 should document them here.
 
+When improving these scripts, you can use the "kgdb-reload" command to reload
+them from /usr/lib/debug/boot/kernel/gdb/*.
+
 To provide some rudimentary testing, selftest.py tries to exercise all of the
 commands and functions defined here.  To use it, run selftest.sh to panic the
 system.  Then, create a kernel dump or attach to the panicked kernel, and invoke
@@ -15,6 +18,8 @@ the script with "python import selftest" in (k)gdb.
 
 Commands:
 acttrace	Display a backtrace for all on-CPU threads
+kgdb-reload     Reload all gdb modules, useful when developing the modules
+                themselves.
 
 Functions:
 $PCPU(<field>[, <cpuid>])	Display the value of a PCPU/DPCPU field
diff --git a/sys/tools/kernel-gdb.py b/sys/tools/kernel-gdb.py
index 8a41ef6efab1..990bdaf31fda 100644
--- a/sys/tools/kernel-gdb.py
+++ b/sys/tools/kernel-gdb.py
@@ -4,12 +4,40 @@
 # SPDX-License-Identifier: BSD-2-Clause
 #
 
+import importlib
 import os
 import sys
 
 sys.path.append(os.path.join(os.path.dirname(__file__), "gdb"))
 
-# Import FreeBSD kernel debugging commands and modules below.
-import acttrace
-import pcpu
-import vnet
+modules = [
+    "acttrace",
+    "freebsd",
+    "pcpu",
+    "vnet"
+]
+
+
+def reload_modules(modules):
+    for mod in modules:
+        if mod in sys.modules:
+            importlib.reload(sys.modules[mod])
+        else:
+            importlib.import_module(mod)
+
+reload_modules(modules)
+
+
+class reload(gdb.Command):
+    """
+    Reload the FreeBSD kernel GDB helper scripts.
+    """
+    def __init__(self):
+        super(reload, self).__init__("kgdb-reload", gdb.COMMAND_USER)
+
+    def invoke(self, arg, from_tty):
+        reload_modules(modules)
+
+
+# Register the reload command with gdb.
+reload()