程序调试：从 GDB 到 VSCode¶

概述¶

在写代码时很难一蹴而就，往往需要反复观察、不断调试。

最简单的调试方法即“ printf 大法”：在代码中插入 printf 语句，然后打印程序中间状态，观察输出结果。

尽管便利，但手动插入输出不仅需要调整源码、反复编译，而且不适合本课程的场景。课程要求结合 QEMU 开发操作系统内核，简单的输出无法完全支持实验观察内核的运行状态如寄存器、内存乃至函数调用栈的需求。

因此，本章 Wiki 将从 GDB 出发，介绍更为便利的程序调试方法论，同时结合先进的插件（gef）和强大的 IDE（VSCode）介绍进一步提高调试效率的方法。

基本方法：GDB¶

GDB（GNU Debugger）是一个功能强大的开源调试器，用于调试各种编程语言的程序。它是 GNU 项目的一部分，可在多个操作系统上使用。GDB 提供了一系列强大的调试功能，如断点调试、内存查看、堆栈跟踪以及远程调试等，帮助开发者诊断和修复程序中的错误。

在正式开始之前，需要准备好 GDB。GDB 的安装非常简单，主流的 Linux 的包管理器都提供了 GDB 的安装包。在 Ubuntu 下，只需要执行以下指令：

1

sudo apt install gdb

其次，为了能够在 GDB 中调试内核，需要在编译时开启调试符号的生成。

贴心的 TA 已经在 Makefile 中为大家准备好了相关指令，只需要在编译时加上 DBG_INFO=true 即可，指令示例如下：

1

make build DBG_INFO=true

如果你没有配置好的 make 环境（比如 Windows 下），你也可以通过 ysos.py 脚本来编译内核，指令示例如下：

1

python ysos.py build -p debug

当观察到终端输出如下信息时，说明带调试符号已经生成成功：

1

Finished release-with-debug [optimized + debuginfo] target(s) in 0.04s

最后，是一些 GDB 的基本使用方法。在本实验中，主要使用 GDB 的以下几个功能：

1. file <path-to-binary>：加载调试的二进制文件，如加载 ysos 内核二进制: file esp/KERNEL.ELF

2. 远程连接：QEMU 提供了 GDB 服务器暴露远程调试接口。可以通过 GDB 连接到对应服务器，进而调试 QEMU 中运行的内核。

   • QEMU 设置：请参考QEMU Wiki中对-s参数的解释。
   • GDB 设置： target remote <ip>:<port>：连接到远程调试服务器，如连接到 QEMU 的 GDB 服务器：target remote localhost:1234
   • 使用 gef 时进行远程调试：gef-remote <ip> <port>：连接到远程调试服务器，如：gef-remote localhost 1234

3. run：运行程序，简写为 r。

4. continue：继续执行程序，直到遇到断点或者程序结束。简写为 c。

5. next：执行下一条指令，不会进入函数。简写为 n。

6. step：执行下一条指令，会进入函数。简写为 s。

7. list：查看源代码和可用断点，简写为 l。

8. break <function>：在指定函数处设置断点，如在main函数处设置断点：break ysos_kernel::<todo>。简写为 b。

9. bt：查看函数调用栈。

10. x/<n>x <addr>：查看内存中的数据，从 <addr> 开始，连续查看 <n> 个字节。

    • 若要查看内存中的前 16 个字节：x/16x <addr>。简写为 x。
    • 若要查看 \(rdi\) 寄存器指向的内存中的前 16 个字节，可以使用 x/16x $rdi。
    • 若要查看内存中对应的 20 条汇编指令，可以使用 x/20i <addr>：

11. info registers：查看寄存器的值。

12. grep <pattern>：在内存中搜索 <pattern>，如搜索字符串 "YatSenOS"：grep YatSenOS。详细可见文档：search-pattern - gef

一些简单的命令使用示例如下图展示：

为了方便初始化一个调试会话，通常使用 .gdbinit 来配置和初始化 gdb。

GDB 在启动时会默认调用该脚本，你可以在其中设置GDB的默认行为，减少重复操作。这里附上一个 .gdbinit 以供参考：

1
2
3
4
5

file esp/KERNEL.ELF
gef config context.layout "-legend regs -stack code -args source -threads -trace extra memory"
gef-remote localhost 1234
tmux-setup
b ysos_kernel::init

以上是 GDB 的基本使用方法，更多的 GDB 使用方法请参考：

• 官方文档
• 知乎：GDB 调试入门指南

命令行调试进阶：gef¶

gef 是一个功能更为强大的调试器插件，用于调试和分析二进制程序。gef 基于 GDB（GNU Debugger），并提供了一系列功能来简化二进制程序的调试过程。在实验场景下，其主要的帮助有：

1. 进阶调试指令：在原生 GDB 的基础上，gef 提供了一个更加丰富的调试指令集，辅助进阶调试。

2. 调试信息展示：gef 可以显示二进制程序的调试信息，如符号表、函数名、堆栈跟踪等。相较于 GDB，其默认常驻显示以上信息，简化操作。

3. 脚本和扩展支持：gef 允许用户编写脚本和扩展，以满足特定的调试需求。用户可以编写自定义命令、自动化调试任务、定制常驻显示窗口等。

参照官方文档，以下是数个参考的安装流程，大家可以根据自己的网络情况灵活选择：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

# via the install script
## using curl
$ bash -c "$(curl -fsSL https://gef.blah.cat/sh)"

## using wget
$ bash -c "$(wget https://gef.blah.cat/sh -O -)"

# or manually
$ wget -O ~/.gdbinit-gef.py -q https://gef.blah.cat/py
$ echo source ~/.gdbinit-gef.py >> ~/.gdbinit

完整调试效果如下：

IDE 调试进阶：VSCode¶

VSCode 是一个轻量级的跨平台编辑器，支持多种编程语言，同时提供了丰富的插件支持。因此，除了简单的代码编辑器功能，VSCode 还可以作为强大的 IDE 使用。在本节中，将介绍如何使用 VSCode 进行调试。

配置 VSCode¶

需要安装 VSCode 的插件：CodeLLDB，它基于 LLDB、用于调试，安装时会自动安装 LLDB 调试器，无需额外安装。

之后需要在 VSCode 中配置调试器。在当前目录下创建 .vscode/launch.json 文件，内容如下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "(lldb) YSOS",
            "type": "lldb",
            "request": "launch",
            "program": "${workspaceFolder}/esp/KERNEL.ELF",
            "args": [],
            "cwd": "${workspaceFolder}",
            "processCreateCommands": ["gdb-remote 1234"]
        }
    ]
}

启动调试¶

完成以上配置后，你应该可以在 VSCode 中调试内核了。

首先，完成内核编译，并启动 QEMU 调试。贴心的 TA 已经将指令集成进 Makefile 中，只需要执行以下指令即可：

1
2

make build DBG_INFO=true
make debug

同样的，如果你没有配置好的 make 环境，也可以通过 ysos.py 脚本来运行内核：

1

python ysos.py run -p debug -d

在 VSCode 中设置断点，按下 F5 即可开始调试。例如，调试内核入口函数：

以上即是 VSCode + LLDB 的调试效果。可以看到，VSCode 提供了一个非常方便的调试界面，同时也提供了丰富的调试功能：

• 可以在左侧的 VARIABLES 中查看变量的值；
• 也可以在 CALL STACK 中查看函数调用栈。
• 更多的调试功能请参考官方文档。

以上即基本调试方法入门，欢迎大家探索属于自己的调试工具链。