驱动程序开发的一个重大难点就是不易调试。
本文目的就是介绍驱动开发中常用的几种直接和间接的调试手段:
一、利用printk
这是驱动开发中最朴实无华,同时也是最常用和有效的手段。
scull驱动的main.c第338行如下,
printk(KERN_ALERT "wakeup by signal in process %d\n", current->pid);
printk的功能与我们经常在应用程序中使用的printf是一样的,不同之处在于printk可以在打印字符串前面加上内核定义的宏,
例如上面例子中的KERN_ALERT(注意:宏与字符串之间没有逗号)。
这个宏是用来定义需要打印的字符串的级别。
值越小,级别越高。
内核中有个参数用来控制是否将printk打印的字符串输出到控制台(屏幕或者/sys/log/syslog日志文件)
# cat /proc/sys/kernel/printk
6 4 1 7
第一个6表示会被输出到控制台的消息级别高于(小于)6,
第二个4表示printk没有指定消息级别(宏)的级别为4,
第三个1表示接受的最高(最小)级别是1,
第四个7表示系统启动时第一个6原来的初值是7。
因此,如果发现在控制台上看不到程序中某些printk输出,
使用echo 8 >/proc/sys/kernel/printk来解决,就是把上面的那个6改为了8。
当调试完毕形成最终产品的时候必然会将这些printk语句删除。我们需要一种能方便地打开和关闭调试信息的手段。
看看一个leds驱动的源代码:
#define LEDS_DEBUG
#undef PDEBUG /* 万一某个驱动中已经定义过了这个宏,在这个驱动开头先取消 */
#ifdef LEDS_DEBUG
#ifdef__KERNEL__
#definePDEBUG(fmt, args…)printk( KERN_EMERG "leds: " fmt, ## args) /* 内核空间使用printk打印 */
#else
#definePDEBUG(fmt, args…)fprintf(stderr, fmt, ## args) /* 非内核空间使用fprintf打印 */
#endif
#else
#definePDEBUG(fmt, args…) /* 不调试的时候,这样就没打印了 */
#endif
#undef PDEBUGG
#define PDEBUGG(fmt, args…) /* 仅仅作为一个(placeholder)占位符 */
如果想打印调试消息,就可以用PDEBUG("address of i_cdev is %p\n", inode->i_cdev);,
如果不想打印调试消息,就只需要将PDEBUG改为PDEBUGG即可。
最终产品,只需要将第1行注释掉。
__KERNEL__是内核中定义的宏,编译内核(包括模块)时,它会被定义。
二、查看OOP消息
OOP意为惊讶。当你的驱动有问题,内核不惊讶才怪。
faulty.c编译出faulty.ko,并insmod faulty.ko。
执行echo yang >/dev/faulty,结果内核就惊讶了。
faulty驱动的write函数执行了*(int *)0 = 0,向内存0地址写入,内核绝对不容许。
52 ssize_t faulty_write (struct file *filp, const char __user *buf, size_t count,
53 loff_t *pos)
54 {
55 /* make a simple fault by dereferencing a NULL pointer */
56 *(int *)0 = 0;
57 return 0;
58 }
1行OOP的原因,也就是报告出错的原因;
1 Unable to handle kernel NULL pointer dereference at virtual address 00000000
2-4行是OOP信息序号;
2 pgd = c3894000
3 [00000000] *pgd=33830031, *pte=00000000, *ppte=00000000
4 Internal error: Oops: 817 [#1] PREEMPT
5行是出错时内核已加载模块;
5 Modules linked in: faulty scull
6行是发生错误的CPU序号;
6 CPU: 0 Not tainted (2.6.22.6 #4)
7-15行是发生错误的位置,以及当时CPU各个寄存器的值,这最有利于我们找出问题所在地;
7 PC is at faulty_write+0×10/0×18 [faulty]
8 LR is at vfs_write+0xc4/0×148
9 pc : [
10 sp : c3871f44 ip : c3871f54 fp : c3871f50
11 r10: 4021765c r9 : c3870000 r8 : 00000000
12 r7 : 00000004 r6 : c3871f78 r5 : 40016000 r4 : c38e5160
13 r3 : c3871f78 r2 : 00000004 r1 : 40016000 r0 : 00000000
14 Flags: NzCv IRQs on FIQs on Mode SVC_32 Segment user
15 Control: c000717f Table: 33894000 DAC: 00000015
16行是当前进程的名字及进程ID
16 Process sh (pid: 745, stack limit = 0xc3870258)
17-23行是出错时,栈内的内容
17 Stack: (0xc3871f44 to 0xc3872000)
18 1f40: c3871f74 c3871f54 c0088eb8 bf00608c 00000004 c38e5180 c38e5160
19 1f60: c3871f78 00000000 c3871fa4 c3871f78 c0088ffc c0088e04 00000000 00000000
20 1f80: 00000000 00000004 40016000 40215730 00000004 c002c0e4 00000000 c3871fa8
21 1fa0: c002bf40 c0088fc0 00000004 40016000 00000001 40016000 00000004 00000000
22 1fc0: 00000004 40016000 40215730 00000004 00000001 00000000 4021765c 00000000
23 1fe0: 00000000 bea60964 0000266c 401adb40 60000010 00000001 00000000 00000000
24-29行是栈回溯信息,可看出直到出错时的函数递进调用关系(确保CONFIG_FRAME_POINTER被定义)
24 Backtrace:
25 [
26 [
27 r7:00000000 r6:c3871f78 r5:c38e5160 r4:c38e5180
28 [
29 r8:c002c0e4 r7:00000004 r6:40215730 r5:40016000 r4:00000004
30行是出错指令及其附近指令的机器码,出错指令本身在小括号中
30 Code: e1a0c00d e92dd800 e24cb004 e3a00000 (e5800000)
反汇编faulty.ko到文件
>arm-linux-objdump -D faulty.ko >faulty.dis
>cat faulty.dis
可以从文件中看到如下的语句如下:
0000007c <faulty_write>://函数名
7c: e1a0c00d mov ip, sp
80: e92dd800 stmdb sp!, {fp, ip, lr, pc}
84: e24cb004 sub fp, ip, #4 ; 0×4
88: e3a00000 mov r0, #0 ; 0×0
8c: e5800000 str r0, [r0]
90: e89da800 ldmia sp, {fp, sp, pc}
定位出错位置以及获取相关信息的过程:
9 pc : [<bf00608c>] lr : [<c0088eb8>] psr: a0000013
25 [<bf00607c>] (faulty_write+0×0/0×18 [faulty]) from [
26 [
出错代码是faulty_write函数中的第5条指令((0xbf00608c-0xbf00607c)/4+1=5),即((pc-backtrace起始地址) / 4) + 1
该函数的首地址是0xbf00607c,该函数总共6条指令(0×18),
该函数是被0xc0088eb8的前一条指令调用的(即:函数返回地址是0xc0088eb8。这一点可以从出错时lr的值正好等于0xc0088eb8得到印证)。
调用该函数的指令是vfs_write的第49条(0xc4/4=49)指令。
达到出错处的函数调用流程是:write(用户空间的系统调用)–>sys_write–>vfs_write–>faulty_write
OOP消息不仅让我定位了出错的地方,更让我知道:
1、gcc中fp到底有何用处?
2、为什么gcc编译任何函数的时候,总是要把3条看上去傻傻的指令放在整个函数的最开始?
3、内核和gdb是如何知道函数调用栈顺序,并使用函数的名字而不是地址?
4、我如何才能知道各个函数入栈的内容?
执行>cat /dev/faulty,内核又再一次惊讶!
1 Unable to handle kernel NULL pointer dereference at virtual address 0000000b
2 pgd = c3a88000
3 [0000000b] *pgd=33a79031, *pte=00000000, *ppte=00000000
4 Internal error: Oops: 13 [#2] PREEMPT
5 Modules linked in: faulty
6 CPU: 0 Not tainted (2.6.22.6 #4)
7 PC is at vfs_read+0xe0/0×140
8 LR is at 0xffffffff
9 pc : [
10 sp : c38d9f54 ip : 0000001c fp : ffffffff
11 r10: 00000001 r9 : c38d8000 r8 : 00000000
12 r7 : 00000004 r6 : ffffffff r5 : ffffffff r4 : ffffffff
13 r3 : ffffffff r2 : 00000000 r1 : c38d9f38 r0 : 00000004
14 Flags: nzCv IRQs on FIQs on Mode SVC_32 Segment user
15 Control: c000717f Table: 33a88000 DAC: 00000015
16 Process cat (pid: 767, stack limit = 0xc38d8258)
17 Stack: (0xc38d9f54 to 0xc38da000)
18 9f40: 00002000 c3c105a0 c3c10580
19 9f60: c38d9f78 00000000 c38d9fa4 c38d9f78 c0088f88 c0088bb4 00000000 00000000
20 9f80: 00000000 00002000 bef07c80 00000003 00000003 c002c0e4 00000000 c38d9fa8
21 9fa0: c002bf40 c0088f4c 00002000 bef07c80 00000003 bef07c80 00002000 00000000
22 9fc0: 00002000 bef07c80 00000003 00000000 00000000 00000001 00000001 00000003
23 9fe0: 00000000 bef07c6c 0000266c 401adab0 60000010 00000003 00000000 00000000
24 Backtrace: invalid frame pointer 0xffffffff
25 Code: ebffff86 e3500000 e1a07000 da000015 (e594500c)
26 Segmentation fault
OOP竟然说出错的地方在vfs_read,万能的内核也不能追踪函数调用栈了,这是为什么?
faulty_read的43行,它导致入栈的r4、r5、r6、fp全部变为了0xffffffff,ip、lr的值未变,faulty_read能够成功返回到它的调用者vfs_read。但vfs_read(忠实的APTCS规则遵守者)并不知道它的r4、r5、r6已经被faulty_read改变,内核缺少了正确的fp,无法追踪函数调用栈。
36 ssize_t faulty_read(struct file *filp, char __user *buf,
37 size_t count, loff_t *pos)
38 {
39 int ret;
40 char stack_buf[4];
41
42 /* Let’s try a buffer overflow */
43 memset(stack_buf, 0xff, 20);
44 if (count > 4)
45 count = 4; /* copy 4 bytes to the user */
46 ret = copy_to_user(buf, stack_buf, count);
47 if (!ret)
48 return count;
49 return ret;
50 }
00000000 <faulty_read>:
0: e1a0c00d mov ip, sp
4: e92dd870 stmdb sp!, {r4, r5, r6, fp, ip, lr, pc} ;将寄存器的值存储在存储器栈区
8: e24cb004 sub fp, ip, #4 ; 0×4
c: e24dd004 sub sp, sp, #4 ; 0×4,这里为stack_buf[]在栈上分配1个字的空间,局部变量ret使用寄存器存储,没在栈上分配空间了
10: e24b501c sub r5, fp, #28 ; 0x1c
14: e1a04001 mov r4, r1
18: e1a06002 mov r6, r2
1c: e3a010ff mov r1, #255 ; 0xff
20: e3a02014 mov r2, #20 ; 0×14
24: e1a00005 mov r0, r5
28: ebfffffe bl 28
78: e89da878 ldmia sp, {r3, r4, r5, r6, fp, sp, pc} ;从栈区加载各寄存器的值
有时小问题可以通过监视程序、监控用户应用程序的行为来追踪,同时监视程序也有助于建立对驱动正确工作的信心。
例如,在看了读操作是如何响应不同数量数据的读请求之后,我们能够对scull正在正确工作感到有信心。
有几个方法来监视用户空间程序运行。运行一个调试器来单步过它的函数,加打印,或在strace下运行程序。
这里,我们将讨论最后一个技术,因为检查内核代码时,它是最有用的。
strace 命令是一个有力工具,它能显示所有的用户空间程序发出的系统调用。
它不仅显示调用,还以符号形式显示调用的参数和返回值。
当一个系统调用失败, 错误的符号值(例如, ENOMEM)和对应的字串(Out of memory) 都显示。
strace 有很多命令行选项,其中最有用的如下:
-t 来显示每个调用执行的时间,
-T 来显示调用中花费的时间,
-e 来限制被跟踪调用的类型(例如strace –eread,write ls表示只监控read和write调用),
-o 来重定向输出到一个文件。
strace 默认打印调用信息输出到stderr。
strace 从内核自身获取信息。跟踪一个程序不管它是否带有调试支持编译(对 gcc 是 -g 选项),也不管它是否被strip过。
也可以追踪一个正在运行中的进程,这类似于调试器连接到一个运行中的进程并控制它。
跟踪信息发给应用程序开发者作故障报告,对内核程序员也很有价值。
我们已经看到驱动代码运行如何响应系统调用,strace 允许检查每个调用的输入和输出数据的一致性。
例如,运行命令 strace ls /dev > /dev/scull0将会在屏幕上显示如下的内容:
open("/dev", O_RDONLY|O_NONBLOCK|O_LARGEFILE|O_DIRECTORY) = 3
fstat64(3, {st_mode=S_IFDIR|0755, st_size=24576, …}) = 0
fcntl64(3, F_SETFD, FD_CLOEXEC) = 0
getdents64(3, /* 141 entries */, 4096) = 4088
[...]
getdents64(3, /* 0 entries */, 4096) = 0
close(3) = 0
[...]
fstat64(1, {st_mode=S_IFCHR|0664, st_rdev=makedev(254, 0), …}) = 0
write(1, "MAKEDEV\nadmmidi0\nadmmidi1\nadmmid"…,4096) = 4000
write(1, "b\nptywc\nptywd\nptywe\nptywf\nptyx0\n"…, 96) = 96
write(1, "b\nptyxc\nptyxd\nptyxe\nptyxf\nptyy0\n"…, 4096) = 3904
write(1, "s17\nvcs18\nvcs19\nvcs2\nvcs20\nvcs21"…, 192) = 192
write(1, "\nvcs47\nvcs48\nvcs49\nvcs5\nvcs50\nvc"…, 673) = 673
close(1) = 0
exit_group(0) = ?
从第一个 write 调用看, 在ls结束查看目标目录后,它试图写4KB。但只有4000字节被成功写入, 并且操作被重复。
但当我们查看scull 中写操作的源码,发现它一次最多只允许写一个量子(quantum共4000字节),可见驱动本来就是期望部分写。
几步之后, 所有东西清空, 程序成功退出。
正是通过strace的输出,使我们确信驱动的部分写功能运行正确。
另一个例子, 读取 scull 设备(使用 wc scull0 命令):
[...]
open("/dev/scull0", O_RDONLY|O_LARGEFILE) = 3
fstat64(3, {st_mode=S_IFCHR|0664, st_rdev=makedev(254, 0), …}) = 0
read(3, "MAKEDEV\nadmmidi0\nadmmidi1\nadmmid"…,16384) = 4000
read(3, "b\nptywc\nptywd\nptywe\nptywf\nptyx0\n"…, 16384) = 4000
read(3, "s17\nvcs18\nvcs19\nvcs2\nvcs20\nvcs21"…, 16384) = 865
read(3, "", 16384) = 0
fstat64(1, {st_mode=S_IFCHR|0620, st_rdev=makedev(136, 1), …}) = 0
write(1, "8865 /dev/scull0\n", 17) = 17
close(3) = 0
exit_group(0) = ?
read 一次只能获取 4000 字节,但是数据总量等同于前个例子写入的。
这个例子,可以肯定,wc为了快速读进行了优化,它绕过了标准库(没有使用fscanf),而是直接一个系统调用以读取更多数据。
这一点,可从跟踪到的读的行里看到wc一次试图读取16 KB的数据而确认。
四、利用内核内置的hacking选项
make menuconfig的Kernel hacking提供了一些内核调试选项。当启用某些调试选项的时候,操作系统会在发现驱动运行有问题时给出一些错误提示信息,而这些信息非常有助于驱动开发者找出驱动中的问题所在。
举例:
先启用如下选项:
1、Kernel debugging — Spinlock and rw-lock debugging: basic checks (NEW)可以检查到未初始化的自旋锁
2、Kernel debugging — Mutex debugging: basic checks (NEW)可以检查到未初始化的信号量
717 //init_MUTEX(&scull_devices[i].sem);
例如,如果忘记了scull驱动中的初始化信号量(将main.c的第717行注释掉),
则在open设备scull时只会产生OOP,而没有其它信息提示我们有信号量未初始化,因此此时我们很难定位问题。
如果启用了上述选项,操作系统则会产生相关提示,使我们知道有未初始化的信号量或者自旋锁。
如下打印信息可以看出信号量的实现,其底层仍然是自旋锁。
process 751 enter scull_open
BUG:spinlock bad magic on CPU#0, sh/751
lock: c38ac1e4, .magic: 00000000, .owner:
[
r5:40000013 r4:c38ac1e4
[
[
r5:c38ac1e4 r4:c38a1e1c
[
r5:c38a0000 r4:c38ac1dc
[
r6:c3ef0300 r5:c38ac1fc r4:bf0045a0
3、Kernel debugging — Spinlock debugging:sleep-inside-spinlock checking (NEW) 可以检查出驱动在获取自旋锁后又睡眠以及死锁等状况
345 ssleep(5);
87 #define usespin
例如,第1个进程获得自旋锁后睡眠(去掉main.c第345行的注释,去掉scull.h第87行的注释),第2个进程试图获得自旋锁时将死锁系统。
但如果启用了上面的选项,则在死锁前操作系统可以给出提示信息。
process 763 enter read
semphore get, and begin sleep 5 second in process 763
BUG:scheduling while atomic: cat/0×00000001/763
[
[
process 764 enter read
BUG: spinlock cpu recursion on CPU#0, cat/764
lock: c3ae7014, .magic: dead4ead, .owner: cat/763, .owner_cpu: 0
[
[
r5:beed2c70 r4:c3ae7014
[
[
r4:c3949520
[
BUG: spinlock lockup on CPU#0, cat/764, c3ae7014
[
[
[
r4:c3949520
[
4、Magic SysRq key可以在已经死锁的情况下,打印一些有助于定位问题的信息
魔键sysrq在大部分体系上都可用,它是用PC 键盘上 alt 和 sysrq(截屏的那个键) 键组合来发出的, 或者在别的平台上使用其他特殊键(详见 documentation/sysrq.txt), 在串口控制台上也可用。
还需1个第三键, 与这2 个键一起按下, 进行许多有用的动作:
例如,在系统死锁的情况下,打印寄存器的值,则可以使用该魔法键。
SysRq : Show Regs
Pid: 764, comm: cat
CPU: 0 Not tainted (2.6.22.6 #6)
PC is at _raw_spin_lock+0xbc/0×160
LR is at _raw_spin_lock+0xcc/0×160
pc : [
sp : c3b11ecc ip : c3b11e08 fp : c3b11efc
r10: c3b10000 r9 : 00000000 r8 : 055b131f
r7 : c3ae7014 r6 : 00000000 r5 : 05f1e000 r4 : 00000000
r3 : 00000000 r2 : c3b10000 r1 : 00000001 r0 : 00000001
Flags: nZCv IRQs on FIQs on Mode SVC_32 Segment user
Control: c000717f Table: 33b48000 DAC: 00000015
[
r4:c0310c34
[
[
[
r5:00000000 r4:c03111e4
[
[
r7:c03073e8 r6:c3e52940 r5:00000046 r4:c03073bc
[
r7:00000000 r6:00000046 r5:00000001 r4:c03073bc
[
r6:c0336650 r5:0000002c r4:c0306cd4
[
[
Exception stack(0xc3b11e84 to 0xc3b11ecc)
1e80: 00000001 00000001 c3b10000 00000000 00000000 05f1e000 00000000
1ea0: c3ae7014 055b131f 00000000 c3b10000 c3b11efc c3b11e08 c3b11ecc c0130c3c
1ec0: c0130c2c 60000013 ffffffff
r7:00000002 r6:10000000 r5:f0000000 r4:ffffffff
[
[
r4:c3949520
[
[
r7:00000000 r6:c3b11f78 r5:c3949520 r4:c3949540
[
r8:c002c0a4 r7:00000003 r6:00000003 r5:beed2c70 r4:00002000
5、Debug shared IRQ handlers可用于调试共享中断
五、利用ioctl方法
驱动中的ioctl函数可以将驱动的一些信息返回给用户程序,也可以让用户程序通过ioctl系统调用设置一些驱动的参数。
在驱动的开发过程中,可以扩展一些ioctl的命令用于传递和设置调试驱动时所需各种信息和参数,以达到调试驱动的目的。
如何在驱动中实现ioctl,参见“驱动程序对ioctl的规范实现”
六、利用/proc 文件系统
/proc文件系统用于内核向用户空间暴露一些内核的信息。
因此出于调试的目的,可以在驱动代码中增加向/proc文件系统导出有助于监视驱动的信息的代码。
就可以通过查看/proc中的相关信息来监视和调试驱动。
如何在驱动中实现向/proc文件系统导出信息,参见《Linux Device Driver》的4.3节。
七、使用kgdb
kgdb是在内核源码中打用于调试内核的补丁,通过相应的硬件和软件,就可以像gdb单步调试应用程序一样来调试内核(当然包括驱动)。
kgdb如何使用,google或百度。