# 如何使用cgdb + qemu除錯linux核心模組

### 前言

Linux 程式碼龐大而繁雜，光看程式碼會使人頭暈目眩，如果能透過除錯工具對其程式碼執行流程進行除錯，則對學習Linux kernel以及解決平時遇到的問題會大有幫助。本文將講解如何使用cgdb + qemu的方式除錯Linux核心程式碼，所使用的測試機作業系統版本是`CentOS Linux release 7.2.1511 (Core)`

### 1.編譯額核心

#### 1) 獲取核心程式碼

核心程式碼下載地址：[https://www.kernel.org/] (https://www.kernel.org/)，本文以4.9.153版本作為演示. 如下圖，點選對應版本的 tarball 連結下載
![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.version.png)

下載完成後將tar檔案複製到測試機/root目錄並進行解壓。

```
# cd /root
# tar xf linux-4.9.153.tar.xz
```

#### 2) 編譯出支援除錯的核心

##### 配置編譯選項

```
# cd linux-4.9.153
# make menuconfig
```

定位到`Enable loadable module support`:

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.loadable.png)

按空格鍵`去掉`選項`Module signature verification`，防止載入模組時如下報錯：
`module verification failed: signature and/or required key missing - tainting kernel`

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.signature.png)

定位到`Exit`按鈕，回到上級選單。

定位到`File systems`, 按Enter鍵:

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.fs.png)

選中`EXT4 debugging support` 和 `JBD2 (ext4) debugging support` 兩項:

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.ext4.png)

定位到`Exit`按鈕，回到上級選單。

定位到`Kernel hacking`，按Enter鍵:

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.hacking.png)

定位到`Kernel debugging`，按空格鍵選中。

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.debugging.png)

定位到`Compile-time checks and compiler options`， 按Enter鍵。

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.options.png)

分別定位到 `Compile the kernel with debug info` 和 `Provide GDB scripts for kernel debugging` , 並按空格鍵選中。

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.debug-info.png)

儲存，退出

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.save.png)

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.save.ok.png)

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.save.exit.png)

##### 開始編譯

```
make -j 30
```

`-j 30` 表示並行編譯的CPU核數

### 2.構建initramfs根檔案系統

這裡藉助Busybox構建極簡initramfs提供基本的使用者態可執行程式.

#### 1) 編譯Busybox

[下載busybox-1.28.0] (https://busybox.net/downloads/busybox-1.28.0.tar.bz2)，並複製到測試機/root目錄下解壓。

配置`CONFIG_STATIC`引數，可編譯出靜態版Busybox, 使Busybox的可執行檔案不依賴動態庫，方便構建initramfs

```
# cd /root/busybox-1.28.0
# make menuconfig
```

選擇`Settings`, 按回車。

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.settings.png)

選擇`Build static binary (no shared libs)`, 按回車。

![version](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.static.png)

退出，提示儲存，選`Yes`

開始編譯

```
# yum install glibc-static -y
# gcc --version
  gcc (GCC) 4.8.5 20150623 (Red Hat 4.8.5-4)
# make -j 30
# make install
```

#### 2) 建立initramfs

建立initramfs, 其中包含BusyBox可執行程式，必要的裝置檔案，啟動指令碼init和需要除錯的模組。在init指令碼里只掛載了虛擬檔案系統procfs和sysfs，沒有掛載磁碟根檔案系統，所有除錯操作都在記憶體中進行，不會讀寫磁碟。本例中使用ext4.ko模組作為演示，所以需要將ext4.ko及其依賴模組一起放到initramfs。

```
# mkdir initramfs
# cd initramfs
# cp ../_install/* -rf ./
# mkdir dev proc sys
# sudo cp -a /dev/{null, console, tty1, tty2, tty3, tty4} dev/
# rm linuxrc
# touch init
# chmod a+x init
# mkdir -p lib/modules/4.9.153/
# cp /root/linux-4.9.153/fs/ext4/ext4.ko lib/modules/4.9.153/
# cp /root/linux-4.9.153/fs/jbd2/jbd2.ko lib/modules/4.9.153/
# cp /root/linux-4.9.153/fs/mbcache.ko lib/modules/4.9.153/
# ls
bin  dev  init  lib  proc  sbin  sys  usr
```

init檔案的內容

```
#!/bin/busybox sh
mount -t proc mone /proc
mount -t sysfs none /sys
mdev -s
exec /sbin/init
```

打包initramfs:

```
# find . -print0 | cpio --null -ov --format=newc | gzip -9 > ../initramfs.cpio.gz
```

### 3.啟動虛擬機器

```
# yum install qemu-system-x86-2.0.0
# cd ..
# pwd
/root/busybox-1.28.0
# qemu-system-x86_64 -s -kernel /root/linux-4.9.153/arch/x86_64/boot/bzImage -initrd initramfs.cpio.gz -nographic -append "console=ttyS0"  -m 1G
```

qemu-system-x86_64 命令用到的引數說明：

- `-s` 是 `-gdb tcp::1234` 的縮寫，表示監聽1234埠，在gdb中可以透過 `target remote localhost:1234` 連線；
- `-kernel` 指定編譯好的除錯版核心；
- `-initrd` 指定製作好的initramfs；
- `-nographic` 取消圖形輸出視窗，使QEMU成為簡單的命令列程式；
- `-append console=ttyS0` 將輸出重定向到console，將會顯示在標準輸出中stdio, 注：這裡ttyS0中的S大寫;
- `-m 1G` 設定虛擬機器記憶體大小。

啟動完成後可按Enter鍵進入命令列互動介面

```
...
[    1.645828] Freeing unused kernel memory: 836K
[    1.659842] Freeing unused kernel memory: 748K
can't run '/etc/init.d/rcS': No such file or directory

Please press Enter to activate this console. [    2.144752] tsc: Refined TSC clocksource calibration: 2194.896 MHz
[    2.145315] clocksource: tsc: mask: 0xffffffffffffffff max_cycles: 0x1fa35d3c521, max_idle_ns: 440795261667 ns
[    2.377779] input: ImExPS/2 Generic Explorer Mouse as /devices/platform/i8042/serio1/input/input3
[    3.153834] clocksource: Switched to clocksource tsc

/ # ls
bin   dev   init  proc  root  sbin  sys   usr
/ #
```

### 4.使用cgdb進行除錯

cgdb 是gdb的一個增強版，除錯的時候看程式碼會美觀許多。我們將在另外的一個視窗登入測試機，執行cgdb除錯核心。

```
# yum install cgdb -y
# cgdb -v
  CGDB 0.6.8
# cd /root/linux-4.9.153
# cgdb vmlinux
```

在gdb命令列裡輸入`target remote :1234`進行遠端除錯，在函式`register_filesystem`裡設定斷點後輸入`c`回車，然後在虛擬機器裡執行命令`modprobe ext4`載入ext4檔案系統模組即可進入函式`register_filesystem`命中斷點。命中斷點後，我們列印`fs->name`，發現是`ext3`，這是因為在ext4的模組初始化函式`ext4_init_fs`裡先呼叫了`register_as_ext3();`之後又呼叫了`register_as_ext2();` 和 `register_filesystem(&ext4_fs_type);`

```
(gdb) target remote :1234
Remote debugging using :1234
native_safe_halt () at ./arch/x86/include/asm/irqflags.h:57
(gdb) b register_filesystem
Breakpoint 1 at 0xffffffff81257dd0: file fs/filesystems.c, line 70.
(gdb) c
Continuing.

Breakpoint 1, register_filesystem (fs=0xffffffffa00a0ac0) at fs/filesystems.c:70
(gdb) p fs->name
$1 = 0xffffffffa0095cc0 "ext3"
(gdb)
```

![cgdb](https://xjw-img-not-delete.s3.didiyunapi.com/yx-way-blog-nodel/cgdb-qemu-linux.cgdb.png)

###作者：袁鑫【滴滴出行高階軟體開發工程師】
- [	現在註冊滴滴雲，得10000元立減紅包](https://app.didiyun.com/#/auth/signup?channel=14816)
- [8月特惠，1C2G1M雲伺服器 9.9元/月限時搶](https://www.didiyun.com/?channel=14816)
- [滴滴雲使者專屬特惠，包年雲伺服器低至68元/年](https://www.didiyun.com/envoy/e-index.html?channel=14816)
- [輸入大師碼【7886】，GPU全線產品9折優惠](https://www.didiyun.com/production/gpu.html?channel=14816)

如何使用cgdb + qemu除錯linux核心模組

相關文章