使用 VScode 调试 Linux Kernel

系列教程

本文记录了如何使用 VScode 调试 Linux Kernel, 环境继承自系列教程：

安装 VScode 及其插件

从 VScode 官网下载安装 VScode。

然后安装 C/C++ 插件，当然也可以把 C/C++ Extension Pack 也一起安装了。

生成并配置 compile_commands.json

在默认情况下使用 VScode 打开 Linux Kernel 项目，是无法自动补全的，因为 Linux Kernel 项目是使用 Makefile 进行编译的，而 VScode 默认是使用 compile_commands.json 文件进行补全的。

# 使用 VScode 打开 Linux Kernel 项目
cd /path/to/linux
code .

在默认情况下，可以看到 VScode 给出很多关于代码的错误提示，这是因为 VScode 缺少 compile_commands.json 配置文件。

在 Linux 项目中已经提供了一个脚本用于生成 compile_commands.json 文件，我们需要在 Linux 项目根目录下执行以下命令：

执行这个命令之前，请确保你已经编译过一遍 Linux Kernel 项目。

# 生成 compile_commands.json
./scripts/clang-tools/gen_compile_commands.py

执行完毕后，可以看到 Linux 项目根目录下多了一个 compile_commands.json 文件。

接下来我们需要在 VScode 中配置 compile_commands.json 文件，首先按快捷键 Ctrl + Shift + P 打开命令面板，输入 C/C++: Edit Configurations (JSON)，然后选择 C/C++: Edit Configurations (JSON)。

它会默认在 .vscode 目录下生成一个 c_cpp_properties.json 文件，文件内容默认如下：

我们需要在这个文件中添加一行配置，指定 compile_commands.json 文件的路径：

"compileCommands": "${workspaceFolder}/compile_commands.json"

修改后的文件内容如下：

保存文件后，重启 VScode，这时候再次打开 Linux Kernel 项目，就看不到错误提示了。

配置 launch.json

接下来我们需要配置 launch.json 文件，用于调试 Linux Kernel。

点击左侧的调试按钮，快捷键 Ctrl + Shift + D，然后点击 create a launch.json file。

此时，.vscode 目录下会生成一个默认的 launch.json 文件，文件内容如下：

{
    "version": "0.2.0",
    "configurations": [
    ]
}

然后点击右下角的 Add Configuration，选择 C/C++: GDB(启动)。

此时，launch.json 会生成默认的内容，如下图

将 launch.json 修改为如下内容：

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "qemu-kernel-gdb",
            "type": "cppdbg",
            "request": "launch",
            "program": "${workspaceFolder}/vmlinux",
            "args": [],
            "stopAtEntry": false,
            "cwd": "${workspaceFolder}",
            "environment": [],
            "externalConsole": false,
            "MIMode": "gdb",
            "miDebuggerServerAddress": "127.0.0.1:1234",
            "setupCommands": [
                {
                    "description": "为 gdb 启用整齐打印",
                    "text": "-enable-pretty-printing",
                    "ignoreFailures": true
                },
                {
                    "description": "将反汇编风格设置为 Intel",
                    "text": "-gdb-set disassembly-flavor intel",
                    "ignoreFailures": true
                }
        }
    ]
}