KGDB调试搭建使用心得

---

前言

  最近遇到一个棘手的问题，反复加入printk添加打印语句，重新编译内核或者模块太麻烦，想找个方法能一步步看下去，gdb是一个不错的选择，所以使用kgdb来调试开发板是个不错的选择。

---

一、kgdb是什么？

  kgdb是用于Linux操作系统的内核级调试器。可以通过远程调试接口连接到正在运行的内核，实时调试内核代码。

二、使用步骤

1. 配置内核KGDB

配置名称	作用
CONFIG_KGDB_SERIAL_CONSOLE	使KGDB通过串口与主机通信(使用串口KGDB时必须打开)
CONFIG_KGDB_KDB	打开KGDB调试
CONFIG_DEBUG_INFO	使内核包含基本调试信息
CONFIG_DEBUG_KERNEL	包含驱动调试信息

2.启动KGDB

  启动KGDB的方式有两种：

1. 方法1：
   主要用于调试内核初始化，在kernel的启动参数上添加kgdboc=ttyXXX,115200 kgdbwait，前者设置开发板使用的串口，后者数字设置波特率。kgdbwait这个字符串的作用就是让内核停在刚启动的地方。

启动参数如何加？
  对于GRUB引导可以在grub中设置参数，如下图箭头所示的地方的末尾进行添加：

  另一种对于uboot启动的可以直接进uboot的命令行，在原来的bootargs环境变量里加上“kgdboc=ttyXXXX,115200 kgdbwait”

2. 方法2：
   在系统启动后，设置进入kgdb模式

# 设置调试串口
echo "kgdboc=ttyXXX,115200" > /sys/module/kgdboc/parameters/kgdboc

# 设置魔术键，g就是进行KGDB模式
echo g > /proc/sysrq-trigger

需要注意：
  这里设置魔术键执行完后，开发板进入kgdb模块，这时开发板按任何键都不会有任何反应，内核等待接受gdb调试请求

3. 开始调试

  首先，在主机上安装gdb-multiarch

sudo apt-get install gdb-multiarch

  进入到内核源码根目录，执行

sudo gdb-multiarch vmlinux

一切正常的话，会在终端输出如下提示：

GNU gdb (Ubuntu 9.1-0kylin1) 9.1
Copyright (C) 2020 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
Type "show copying" and "show warranty" for details.
This GDB was configured as "x86_64-linux-gnu".
Type "show configuration" for configuration details.
For bug reporting instructions, please see:
<http://www.gnu.org/software/gdb/bugs/>.
Find the GDB manual and other documentation resources online at:
    <http://www.gnu.org/software/gdb/documentation/>.

For help, type "help".
Type "apropos word" to search for commands related to "word"...
Reading symbols from vmlinux...
warning: File "/home/xxx/kernel-5.15/scripts/gdb/vmlinux-gdb.py" auto-loading has been declined by your `auto-load safe-path' set to "$debugdir:$datadir/auto-load".
To enable execution of this file add
	add-auto-load-safe-path /home/xxx/project_data/startkylin/gerrit-5.15/scripts/gdb/vmlinux-gdb.py
--Type <RET> for more, q to quit, c to continue without paging--
line to your configuration file "/root/.gdbinit".
To completely disable this security protection add
	set auto-load safe-path /
line to your configuration file "/root/.gdbinit".
For more information about this security protection see the
"Auto-loading safe path" section in the GDB manual.  E.g., run from the shell:
	info "(gdb)Auto-loading safe path"
(gdb) 

  然后，我们需要设置目标平台，串口波特率，并且通过串口连接到开发板上的kgdb上

# 设备目标平台
set architecture aarch64
# 设置串口波特率
set serial baud 115200
# 主机通过串口连接到开发板上的kgdb
target remote /dev/ttyUSB0

  设置成功后会有如下提示：

(gdb) set architecture aarch64
The target architecture is assumed to be aarch64
(gdb) set serial baud 115200
(gdb) target remote /dev/ttyUSB0
Remote debugging using /dev/ttyUSB0
arch_kgdb_breakpoint () at ./arch/arm64/include/asm/kgdb.h:21
21		asm ("brk %0" : : "I" (KGDB_COMPILED_DBG_BRK_IMM));

  设置断点，并继续运行，并停止在断点

(gdb) b user_path_at_empty
Breakpoint 1 at 0xffffffc0082acb40: file fs/namei.c, line 2799.
(gdb) c
Continuing.
[Switching to Thread 5657]

Thread 1152 hit Breakpoint 1, user_path_at_empty (dfd=dfd@entry=-100, 
    name=name@entry=0x7299bdc630, flags=flags@entry=16384, 
    path=0xffffffc014d03df8, path@entry=0xffffffc014d03e48, empty=0xffffffc014d03df4, empty@entry=0xffffffc014d03e44)
    at fs/namei.c:2799
2799	{
(gdb) 

  如果此时，设置的断点不是系统必跑的地方，那么会发现，此时adb又可以输入命令了，可以用指令来触发断点。
  再回到gdb界面，继续使用n、s、l、p的方式去debug代码了。

最后，再贴上比较常用的gdb指令：

指令简写	全称	作用
r	run	gdb filename只是attach到一个调试文件，run启动程序
c	continue	使用continue让程序继续运行
b	break	设置断点
d x	delete x	删除断点，可以通过i b获取到断点编号x
n	next	单步步过，遇到函数调用会直接跳过，不会进入函数内
s	step	单步步入，遇到函数调用会进入函数内部
l	list	查看当前执行点前后5行代码
p	print	查看变量的值，得到函数执行结果
finish	\	直接执行完当前函数，返回调用处，并输出返回值
u	util	快速执行到指定行
jump	\	可以跳转到指定行或函数，中间的被略过，如果指定位置没有断点，将继续执行
display xxx	\	监视某变量（xxx），每一步都会自动输出变量的值
d display xxx	delete display xxx	移除对指定变量的监视，可以通过i display获取编号x
bt	backtrace	查看当前位置的调用堆栈
f	frame	与backtrace结合使用，切换不同堆栈
i b	info break	查看断点信息
i locals	info locals	查看当前函数当前执行点的本地变量值
i args	info args	查看当前函数的传入参数值
i display	info display	查看当前监控那些变量

---

总结

  上面是个人使用kgdb时的一些心得，kgdb很方便，但有时候使用kgdb容易卡死，或者在一个函数需要很久才能返回，还是有一些缺陷。