使用VSCode进行内核开发

Posted on 2024-12-22 Edited on 2024-12-23 In How-To

Linux内核并没有任何官方IDE，所以大家都是各显神通，比较常见的就是使用Vim/Emacs结合各种插件，但这种方式普遍存在配置复杂和上手难度高的问题，我个人是不愿意浪费太多时间在IDE上的。碰巧有一款IDE，同样支持大量插件，并且社区活跃，它就是VSCode，所以今天就来看看如何通过各种插件将它打造为高效的内核开发IDE。

远程连接Linux服务器

我们要开发Linux内核，当然最好还是在Linux上进行，除非你的笔记本/台式机就是Linux系统，我们更多的还是使用Windows/Mac连接服务器来完成开发工作。

通过使用Remote - SSH插件，我们可以像在本地一样，在远程服务器上进行开发。

配置SSH连接

# <HOME>/.ssh/config

Host <IP or hostname>
    HostName kernel-dev
    User <username>

设置代码索引和代码补全

这一直是内核开发的老大难问题，因为内核源码过于庞大，以往的补全方案，要么速度快，但不精准，如ctags/cscope；要么精准，但速度慢，如C/C++ IntelliSense。

然而clangd插件的出现，非常好的解决了速度和精确性的问题，但它有一个强依赖：需要使用compile_commands.json来生成索引数据。好在内核源码树中已经有工具可以为我们生成compile_commands.json。

安装clangd
1
sudo apt install clangd
生成compile_commands.json

首先我们需要对内核或模块进行编译，编译成功后，在编译目录执行以下命令
1
./scripts/clang-tools/gen_compile_commands.py
打开compile_commands.json，确认不为空。

配置clangd插件

# Settings > Remote > Extensions > clangd > Arguments

--compile-commands-dir=${workspaceFolder}
--background-index
--completion-style=detailed
--header-insertion=never
-log=info
-pretty
-j=8

注意最后的-j=8是clangd在生成索引所创建的进程数，通常设置为CPU数量。

配置工程

因为clangd使用clang来编译每个文件，如果我们的内核是使用GCC编译的，就会存在一些clang无法识别的编译选项，这些编译选项通常是用来进行代码优化的，所以去掉也不会影响代码索引。

在VSCode中执行命令>clangd: Open project configuration file，打开.clangd文件，加入以下内容
1
2
3
4
CompileFlags:
Remove:
- -m*
- -f*
重启clangd

在VSCode中执行命令>clangd: Restart language server。