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

前言

其实,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 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在编译时可能遇到如下的错误:

make[1]: *** No rule to make target 'debian/certs/benh@debian.org.cert.pem', needed by 'certs/x509_certificate_list'

此时需要编辑一下.config,将CONFIG_SYSTEM_TRUSTED_KEYS置为空:

CONFIG_SYSTEM_TRUSTED_KEYS = ""

生成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

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

克隆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__)

添加内容主要包括:

  1. 修改sysroot,这需要首先在CMakeLists.txt的同目录下创建一个名为sysroot的空目录,然后设置编译参数"--sysroot=${SYSROOT}",这是因为sysroot其实是C标准头文件的位置,显然内核是不需要这些东西的,他们存在反而会干扰clion寻找正确头的文件,产生一下不必要得冲突
  2. 添加头文件路径,如果不进行这一步,那么clion将会出现大量的错误,提示找不到头文件或者变量、常量、函数等。具体添加的内容是我反复测试过的,添加这些内容后基本上保证头文件寻找正确,其中后四个是与架构相关的,x84_64可放心使用
  3. 使用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中,这个很奇怪!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 77,640评论 1 169
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 26,109评论 1 142
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 29,070评论 0 100
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 16,169评论 0 86
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 21,395评论 0 144
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 17,620评论 0 87
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 10,426评论 2 161
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 9,829评论 0 77
  • 想象着我的养父在大火中拼命挣扎,窒息,最后皮肤化为焦炭。我心中就已经是抑制不住地欢快,这就叫做以其人之道,还治其人...
    爱写小说的胖达阅读 8,349评论 5 111
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 11,609评论 0 128
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 10,379评论 1 124
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 11,185评论 0 127
  • 白月光回国,霸总把我这个替身辞退。还一脸阴沉的警告我。[不要出现在思思面前, 不然我有一百种方法让你生不如死。]我...
    爱写小说的胖达阅读 6,045评论 0 17
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 8,842评论 2 114
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 11,917评论 3 121
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 7,691评论 0 3
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 7,903评论 0 76
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 12,353评论 2 132
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 13,030评论 2 130

推荐阅读更多精彩内容