使用Clion 阅读/修改/注释 Linux 内核源码

2022-04-17 23:34:21 阅读：269 来源： 互联网

from：https://zhuanlan.zhihu.com/p/409007775

前言

其实，bootlin就是一个听不错的阅读源码的工具了，可以非常方便的帮我们查阅函数、宏的定义、引用等等。而且是基于浏览器，对我们本机的配置没有什么过高的要求。

但是如果想要做一些注释，修改，那我们就要将源码下载到本地了，这个时候我们可能就需要其他的工具了。

Clion我最熟悉的C/C++ IDE，我非常喜欢Jetbrains家族的IDE，因此使用Clion来阅读/注释/修改源码，就成了我的首选，很可惜的是，Linux kernel是通过Makefile进行构建的，然后Clion是用的是CMake，因此如果我们想要借助Clion来阅读源码，就需要生成Linux kernel的Cmake文件！

目前来看，可以成功的实现使用Clion来阅读/注释/修改源码，但是不能成功的进行编译，因此编译还得用make，不过这个无伤大雅！

配置要求

Clion需要大量的缓存内核文件，因此我们必须保证本机有足够的内存，并调高Clion的堆内存配置，本机至少要有8G内存，Clion堆内存至少调整到4G以上。配置方法：

点击CLion的状态栏上的"Help->Change Memory Settings"，然后修改"MAX Heap Size",如下图所示，我将其调整到了8G，我本机有24G。然后重启配置生效！

源码准备

安装编译必须的工具

sudo apt update && sudo apt upgrade
sudo apt-get install git zstd fakeroot build-essential ncurses-dev xz-utils libssl-dev bc flex libelf-dev bison

下载源码，最好到The Linux Kernel Archives下载源码的压缩包，然后再解压！

tar -zxf linux-5.14.2.tar.xz
cd linux-5.14.2

使用本机的配置文件来配置内核

cp /boot/config-$(uname -r) .config
make menuconfig

上述过程其实就是编译内核的步骤。

注意：
直接使用ubuntu的.config在编译时可能遇到如下的错误：

No rule to make target 'debian/certs/benh@debian.org.cert.pem', needed by 'certs/x509_certificate_list'

以及：

No rule to make target 'debian/canonical-revoked-certs.pem', needed by 'certs/x509_revocation_list'.  Stop.

此时需要编辑一下.config，将CONFIG_SYSTEM_TRUSTED_KEYS、CONFIG_SYSTEM_REVOCATION_KEYS置为空：

CONFIG_SYSTEM_TRUSTED_KEYS = ""
...
CONFIG_SYSTEM_REVOCATION_KEYS=""

看名字也知道，这是Ubuntu的相关的配置

生成CMakeLists.txt

安装bear工具，bear可以根据追踪make编译的过程，生成compile_commands.json文件，然后我们在通过其他工具通过compile_commands.json最终生成CMakeLists.txt

sudo apt-get install bear

使用bear，make编译内核。最新的bear应该需要在bear和make之间加上"--"。make的"-j12"表示启用12个线程同时编译，这取决你本机的core数，这个过程需要很久！

bear make -j12 vmlinux bzImage

2020年 9月21日更新
之前我一直使用make -j12来编译内核，在我这台拥有12个core的机器上，编译时间也长达30分钟，直到前几天我才发现，这样其实是非常蠢的，因为make -j12其实默认编译了所有的内容，但是如果我们仅仅编译内核，只需要编译vmlinux即可，后面为了使用qemu来调试，在加上bzImage就行了，即make -j12 vmlinux bzImage，这样一来，编译的时间只需要不到5分钟，最终生成Cmakea文件也只有5MB左右，这样Clion就可以无需那么高的内存配置了！

如果你使用了 -j 参数, 那么将会并发的编译内核，此时中间出错后，将可能不会在最后的编译输出信息上展示错误提示，需要你往前翻一下，定位具体的错误原因。

出错之后，要执行make clean，然后再重新编译，以确保生成的compile_commands.json是完整无误的。

克隆kernel-grok项目

cd ~
git clone https://github.com/habemus-papadum/kernel-grok

回到内核目录，生成CMakeLists.txt

cd linux-5.14.2
~/kernel-grok/generate_cmake  ## creates CMakeLists.txt

修改CMakeLists.txt

这个时候需要我们手动添加一些参数配置

在文件的最开头添加以下内容：

cmake_minimum_required(VERSION 2.8.8)
project(kernel)

set(SYSROOT sysroot)
SET(CMAKE_C_COMPILER "gcc")
set(CMAKE_C_STANDARD 90)
set(CMAKE_C_FLAGS  ${CMAKE_C_FLAGS} " --sysroot=${SYSROOT}" )

include_directories("include")
include_directories("include/uapi")
include_directories("arch/x86/include")
include_directories("arch/x86/include/uapi")
include_directories("arch/x86/include/generated")
include_directories("arch/x86/include/generated/uapi")

add_definitions(-D__KERNEL__)

添加内容主要包括：

修改sysroot，这需要首先在CMakeLists.txt的同目录下创建一个名为sysroot的空目录，然后设置编译参数"--sysroot=${SYSROOT}"，这是因为sysroot其实是C标准头文件的位置，显然内核是不需要这些东西的，他们存在反而会干扰clion寻找正确头的文件，产生一下不必要得冲突
添加头文件路径，如果不进行这一步，那么clion将会出现大量的错误，提示找不到头文件或者变量、常量、函数等。具体添加的内容是我反复测试过的，添加这些内容后基本上保证头文件寻找正确，其中后四个是与架构相关的，x84_64可放心使用
使用C90的C语言标准，一开始我使用的是Clion的默认C标准，一直没有出过问题，但是昨天一下子就出现大量报错，不排除是因为我升级了最新的Clion 2021.2.2 ，最终加上了set(CMAKE_C_STANDARD 90)才恢复正常

启动CLion

点击状态栏"File->Open"，然后选中我们创建的CMakeLists.txt，确定后选择"Open as Project"

然后Clion会自动加载Cmake，目前最终会加载失败，因为这个方法并不能用来编译内核！

这时候查看内核源码，正常是没有任何红色报错信息，可以正常的进行跳转和自动补全，只不过会卡卡的！

问题

除去不能编译外，还有一个问题，那就是编译选项的宏定义，显示不正常：

上面是task_struct中的一段代码，clion的代码显示表明找不到CONFIG_MEMCG，因此也就没有定义memcg_data，但是按住Ctrl是可以跳转到CONFIG_MEMCG的定义的，就在include/generated/autoconf.h中，这个很奇怪！

标签：make,编译,源码,内核,Linux,include,Clion
来源： https://www.cnblogs.com/rincloud/p/16157863.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9