From 46c60fd451e478ee0bc834de7ff129d85d437bb3 Mon Sep 17 00:00:00 2001
From: Brian Gianforcaro <b.gianfo@gmail.com>
Date: Sun, 12 Jan 2020 22:50:47 -0800
Subject: [PATCH] Debugging: Add kernel debugging support

Introduce the 'debug-kernel' script to allow developers to
quickly attach a debugger to the QEMU debug remote. The
setting (-s) is already enabled by ./run today when using
QEMU for virtualisation.

If the system is running under QEMU, the debugger
will break in when the script is run. If you add
the -S option to QEMU it will wait for the debugger
to connect before booting the kernel. This allows
you to debug the init/boot process.

Personally I use cgdb instead of gdb, so I opted
to make the debugger used by the script customizable
via an environment variable.

This change also adds -g3 to the kernel build so that
rich debug symbols are available in the kernel binary.
---
 Kernel/Makefile     |  4 ++--
 Kernel/debug-kernel | 14 ++++++++++++++
 2 files changed, 16 insertions(+), 2 deletions(-)
 create mode 100755 Kernel/debug-kernel

diff --git a/Kernel/Makefile b/Kernel/Makefile
index 1b0e2fd3f6..6bee3dd545 100644
--- a/Kernel/Makefile
+++ b/Kernel/Makefile
@@ -119,11 +119,11 @@ KERNEL = 1
 PROGRAM = kernel
 
 SUBPROJECT_CXXFLAGS += -pie -fPIE -ffreestanding -mno-80387 -mno-mmx -mno-sse -mno-sse2 -fno-asynchronous-unwind-tables
-SUBPROJECT_CXXFLAGS += -nostdlib -nostdinc -nostdinc++
+SUBPROJECT_CXXFLAGS += -nostdlib -nostdinc -nostdinc++ -g3
 SUBPROJECT_CXXFLAGS += -I../Toolchain/Local/i686-pc-serenity/include/c++/9.2.0/
 SUBPROJECT_CXXFLAGS += -I../Toolchain/Local/i686-pc-serenity/include/c++/9.2.0/i686-pc-serenity/
 
-LDFLAGS += -Ttext 0x100000 -Wl,-T linker.ld -nostdlib -lgcc -lstdc++
+LDFLAGS += -Ttext 0x100000 -Wl,-T linker.ld -nostdlib -lgcc -lstdc++ -g3
 
 all: $(PROGRAM) $(MODULE_OBJS) kernel.map
 
diff --git a/Kernel/debug-kernel b/Kernel/debug-kernel
new file mode 100755
index 0000000000..c7cd462759
--- /dev/null
+++ b/Kernel/debug-kernel
@@ -0,0 +1,14 @@
+#!/bin/sh
+
+# Set this environment variable to override the default debugger.
+#
+[ -z "$SERENITY_KERNEL_DEBUGGER" ] && SERENITY_KERNEL_DEBUGGER="gdb"
+
+# The QEMU -s option (enabled by default in ./run) sets up a debugger
+# remote on localhost:1234. So point our debugger there, and inform
+# the debugger which binary to load symbols, etc from.
+#
+$SERENITY_KERNEL_DEBUGGER \
+    -ex "file $(pwd)/kernel" \
+    -ex 'set arch i386:intel' \
+    -ex 'target remote localhost:1234'