如何使用gdb

1. 单步执行和跟踪函数调用
看下面的程序:
例 10.1. 函数调试实例
#include <stdio.h>
int add_range(int low, int high)
{
   int i, sum;
   for (i = low; i <= high; i++)
     sum = sum + i;
   return sum;
}
int main(void)
{
   int result[100];
   result[0] = add_range(1, 10);
   result[1] = add_range(1, 100);
   printf("result[0]=%d\nresult[1]=%d\n", result[0], result[1]);
   return 0;
}
add_range函数从low加到high,在main函数中首先从1加到10,把结果保存下来,然后从1加到100,再把结果保存下来,最后打印的
两个结果是:
result[0]=55
result[1]=5105
第一个结果正确,第二个结果显然不正确,在小学我们就听说过高斯小时候的故事,从1加到100应该是5050。一段代码,第一次运行结果是对的,第二次运行却不对,这是很常见的一类错误现象,这种情况不应该怀疑代码而应该怀疑数据,因为第一次和第二次运行的都是同一段代码,如果代码是错的,那为什么第一次的结果能对呢?然而第一次和第二次运行时相关的数据却有可能不同,错误的数据会导致错误的结果。在动手调试之前,读者先试试只看代码能不能看出错误原因,只要前面几章学得扎实就应该能看出来。

在编译时要加上-g选项,生成的可执行文件才能用gdb进行源码级调试:
$ gcc -g main.c -o main
$ gdb main
GNU gdb 6.8-debian
Copyright (C) 2008 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 "i486-linux-gnu"...
(gdb)
-g选项的作用是在可执行文件中加入源代码的信息,比如可执行文件中第几条机器指令对应源代码的第几行,但并不是把整个源文件嵌入到可执行文件中,所以在调试时必须保证gdb能找到源文件。gdb提供一个类似Shell的命令行环境,上面的(gdb)就是提示符,在这个提示符下输入help可以查看命令的类别:
(gdb) help
List of classes of commands:
aliases -- Aliases of other commands
breakpoints -- Making program stop at certain points
data -- Examining data
files -- Specifying and examining files
internals -- Maintenance commands
obscure -- Obscure features
running -- Running the program
stack -- Examining the stack
status -- Status inquiries
support -- Support facilities
tracepoints -- Tracing of program execution without stopping the program
user-defined -- User-defined commands
Type "help" followed by a class name for a list of commands in that class.
Type "help all" for the list of all commands.
Type "help" followed by command name for full documentation.
Type "apropos word" to search for commands related to "word".
Command name abbreviations are allowed if unambiguous.
也可以进一步查看某一类别中有哪些命令,例如查看files类别下有哪些命令可用:
(gdb) help files
Specifying and examining files.
List of commands:
add-shared-symbol-files -- Load the symbols from shared objects in the dynamic linker's link
map
add-symbol-file -- Load symbols from FILE
add-symbol-file-from-memory -- Load the symbols out of memory from a dynamically loaded
object file
cd -- Set working directory to DIR for debugger and program being debugged
core-file -- Use FILE as core dump for examining memory and registers
directory -- Add directory DIR to beginning of search path for source files
edit -- Edit specified file or function
exec-file -- Use FILE as program for getting contents of pure memory
file -- Use FILE as program to be debugged
forward-search -- Search for regular expression_r(see regex(3)) from last line listed
generate-core-file -- Save a core file with the current state of the debugged process
list -- List specified function or line
...
现在试试用list命令从第一行开始列出源代码:
(gdb) list 1
1 #include <stdio.h>
2
3 int add_range(int low, int high)
4 {
5 int i, sum;
6 for (i = low; i <= high; i++)
7 sum = sum + i;
8 return sum;
9 }
10
一次只列10行,如果要从第11行开始继续列源代码可以输入
(gdb) list
也可以什么都不输直接敲回车,gdb提供了一个很方便的功能,在提示符下直接敲回车表示重复上一条命令。
(gdb) (直接回车)
11 int main(void)
12 {
13 int result[100];
14 result[0] = add_range(1, 10);
15 result[1] = add_range(1, 100);
16 printf("result[0]=%d\nresult[1]=%d\n", result[0], result[1]);
17 return 0;
18
gdb的很多常用命令有简写形式,例如list命令可以写成l,要列一个函数的源代码也可以用函数名做参数:
(gdb) l add_range
1 #include <stdio.h>
2
3 int add_range(int low, int high)
4 {
5 int i,sum;
6 for(i=low;i<=high;i++)
7 sum=sum+i;
8 return sum;
9 }
10
现在退出gdb的环境:
(gdb) quit
我们做一个实验,把源代码改名或移到别处再用gdb调试,这样就列不出源代码了:
$ mv main.c mian.c
$ gdb main
...
(gdb) l
5           main.c: No such file or directory.
              in main.c
可见gcc的-g选项并不是把源代码嵌入到可执行文件中的,在调试时也需要源文件。现在把源代码恢复原样,我们继续调试。首先用start命令开始执行程序:
$ gdb main
...
(gdb) start
Breakpoint 1 at 0x80483ad: file main.c, line 14.
Starting program: /home/akaedu/main
main () at main.c:14
14          result[0] = add_range(1, 10);
(gdb)
gdb停在main函数中变量定义之后的第一条语句处等待我们发命令,gdb列出的这条语句是即将执行的下一条语句。我们可以用next命令(简写为n)控制这些语句一条一条地执行:
(gdb) n
15          result[1] = add_range(1, 100);
(gdb) (直接回车)
16          printf("result[0]=%d\nresult[1]=%d\n", result[0], result[1]);
(gdb) (直接回车)
result[0]=55
result[1]=5105
17          return 0;
用n命令依次执行两行赋值语句和一行打印语句,在执行打印语句时结果立刻打出来了,然后停在return语句之前等待我们发命令。虽然我们完全控制了程序的执行,但仍然看不出哪里错了,因为错误不在main函数中而在add_range函数中,现在用start命令重新来过,这次用step命令(简写为s)钻进add_range函数中去跟踪执行:
(gdb) start
The program being debugged has been started already.
Start it from the beginning? (y or n) y
Breakpoint 2 at 0x80483ad: file main.c, line 14.
Starting program: /home/akaedu/main
main () at main.c:14
14           result[0] = add_range(1, 10);
(gdb) s
add_range (low=1, high=10) at main.c:6
6            for (i = low; i <= high; i++)
这次停在了add_range函数中变量定义之后的第一条语句处。在函数中有几种查看状态的办法,backtrace命令(简写为bt)可以查看函数调用的栈帧:
(gdb) bt
#0     add_range (low=1, high=10) at main.c:6
#1     0x080483c1 in main () at main.c:14
可见当前的add_range函数是被main函数调用的,main传进来的参数是low=1, high=10。main函数的栈帧编号为1,add_range的栈帧编号为0。现在可以用info命令(简写为i)查看add_range函数局部变量的值:
(gdb) i locals
i = 0
sum = 0
如果想查看main函数当前局部变量的值也可以做到,先用frame命令(简写为f)选择1号栈帧然后再查看局部变量:
(gdb) f 1
#1   0x080483c1 in main () at main.c:14
14         result[0] = add_range(1, 10);
(gdb) i locals
result = {0, 0, 0, 0, 0, 0, 134513196, 225011984, -1208685768, -1081160480,
...
-1208623680}
注意到result数组中有很多元素具有杂乱无章的值,我们知道未经初始化的局部变量具有不确定的值。到目前为止一切正常。用s或n往下走几步,然后用print命令(简写为p)打印出变量sum的值:
(gdb) s
7  sum =sum + i;
(gdb) (直接回车)
6 for (i = low;i<=high;i++)
(gdb) (直接回车)
7 sum =sum+i;
(gdb) (直接回车)
6 for (i = low;i<=high;i++)
(gdb) p sum
$1 = 3
第一次循环i是1,第二次循环i是2,加起来是3,没错。这里的$1表示gdb保存着这些中间结果,$后面的编号会自动增长,在命令中可以用$1、$2、$3等编号代替相应的值。由于我们本来就知道第一次调用的结果是正确的,再往下跟也没意义了,可以用finish命令让程序一直运行到从当前函数返回为止:
(gdb) finish
Run till exit from #0 add_range (low=1, high=10) at main.c:6
0x080483c1 in main () at main.c:14
14   result[0] = add_range(1, 10);
Value returned is $2 = 55
返回值是55,当前正准备执行赋值操作,用s命令赋值,然后查看result数组:
(gdb) s
15   result[1] = add_range(1, 100);
(gdb) p result
$3 = {55, 0, 0, 0, 0, 0, 134513196, 225011984, -1208685768, -1081160480,
...
-1208623680}
第一个值55确实赋给了result数组的第0个元素。下面用s命令进入第二次add_range调用,进入之后首先查看参数和局部变量:
(gdb) s
add_range (low=1, high=100) at main.c:6
6  for (i = low; i <= high; i++)
(gdb) bt
#0 add_range (low=1, high=100) at main.c:6
#1 0x080483db in main () at main.c:15
(gdb) i locals
i = 11
sum = 55
由于局部变量i和sum没初始化,所以具有不确定的值,又由于两次调用是挨着的,i和sum正好取了上次调用时的值,原来这跟例 3.7 “验证局部变量存储空间的分配和释放”是一样的道理,只不过我这次举的例子设法让局部变量sum在第一次调用时初值为0了。i的初值不是0倒没关系,在for循环中会赋值为0的,但sum如果初值不是0,累加得到的结果就错了。好了,我们已经找到错误原因,可以退出gdb修改源代码了。如果我们不想浪费这次调试机会,可以在gdb中马上把sum的初值改为0继续运行,看看这一处改了之后还有没有别的Bug:
(gdb) set var sum=0
(gdb) finish
Run till exit from #0 add_range (low=1, high=100) at main.c:6
0x080483db in main () at main.c:15
15 result[1] = add_range(1, 100);
Value returned is $4 = 5050
(gdb) n
16 printf("result[0]=%d\nresult[1]=%d\n", result[0], result[1]);
(gdb) (直接回车)
result[0]=55
result[1]=5050
17 return 0;
这样结果就对了。修改变量的值除了用set命令之外也可以用print命令,因为print命令后面跟的是表达式,而我们知道赋值和函数调用也都是表达式,所以也可以用print命令修改变量的值或者调用函数:
(gdb) p result[2]=33
$5 = 33
(gdb) p printf("result[2]=%d\n", result[2])
result[2]=33
$6 = 13
我们讲过,printf的返回值表示实际打印的字符数,所以$6的结果是13。总结一下本节用到的gdb命令:
backtrace(或bt)           查看各级函数调用及参数
finish                    连续运行到当前函数返回为止,然后停下来等待命令
frame(或f)  帧编号        选择栈帧
info(或i) locals          查看当前栈帧局部变量的值
list(或l)                  列出源代码,接着上次的位置往下列,每次列10行
list 行号                  列出从第几行开始的源代码
list 函数名                列出某个函数的源代码
next(或n)                  行下一行语句
print(或p)                 打印表达式的值,通过表达式可以修改变量的值或者调用函数
quit(或q)                  退出gdb调试环境
set var                    修改变量的值
start                      开始执行程序,停在main函数第一行语句前面等待命令
step(或s)                  执行下一行语句,如果有函数调用则进入到函数中
break(或b) 行号            在某一行设置断点
break 函数名               在某个函数开头设置断点
break ... if ...           设置条件断点
continue(或c)              从当前位置开始连续运行程序
delete breakpoints 断点号  删除断点
display 变量名              跟踪查看某个变量,每次停下来都显示它的值
disable breakpoints 断点号  禁用断点
enable 断点号               启用断点
info(或i) breakpoints       查看当前设置了哪些断点
run(或r)                    从头开始连续运行程序
undisplay 跟踪显示号        取消跟踪显示


2. 观察点
接着上一节的步骤,经过调试我们知道,虽然sum已经赋了初值0,但仍需要在while (1)循环的开头加上sum = 0;:
例 10.3. 观察点调试实例
#include <stdio.h>
int main(void)
{
int sum = 0, i = 0;
char input[5];
while (1) {
sum = 0;
scanf("%s", input);
for (i = 0; input[i] != '\0'; i++)
sum = sum*10 + input[i] - '0';
printf("input=%d\n", sum);
}
return 0;
}
使用scanf函数是非常凶险的,即使修正了这个Bug也还存在很多问题。如果输入的字符串超长了会怎么样?我们知道数组访问越界是不会检查的,所以scanf会写出界。现象是这样的:
$ ./main
123
input=123
67
input=67
12345
input=123407
21
下面用调试器看看最后这个诡异的结果是怎么出来的。
$ gdb main
...
(gdb) start
Breakpoint 1 at 0x80483b5: file main.c, line 5.
Starting program: /home/akaedu/main
main () at main.c:5
5         int sum = 0, i = 0;
(gdb) n
9         sum = 0;
(gdb) (直接回车)
10       scanf("%s", input);
(gdb) (直接回车)
12345
11       for (i = 0; input[i] != '\0'; i++)
(gdb) p input
$1 = "12345"
input数组只有5个元素,写出界的是scanf自动添的'\0',用x命令看会更清楚一些:
(gdb) x/7b input
0xbfb8f0a7:  0x31   0x32   0x33  0x34  0x35  0x00  0x00

x命令打印指定存储单元的内容。7b是打印格式,b表示每个字节一组,7表示打印7组[ 22],从input数组的第一个字节开始连续打印7个字节。前5个字节是input数组的存储单元,打印的正是十六进制ASCII码的'1'到'5',第6个字节是写出界的'\0'。根据运行结果,前4个字符转成数字都没错,第5个错了,也就是i从0到3的循环都没错,我们设一个条件断点从i等于4开始单步调试:
(gdb) l
6  char input[5];
7
8  while (1) {
9    sum = 0;
10    scanf("%s", input);
11  for (i = 0; input[i]!='\0';i++)
12  sum = sum*10+input[i]-'0';
13  printf("input=%d\n",sum);
14  }
15  return 0;
(gdb) b 12 if i==4
Breakpoint 2 at ox80483e6: file main.c,line 12.
(gdb) c
Continuing.

Breakpoint 2, main () at main.c:12
12   sum = sum*10 + input[i] - '0';
(gdb) p sum
$2 = 1234
现在sum是1234没错,根据运行结果是123407我们知道即将进行的这步计算肯定要出错,算出来应该是12340,那就是说input[4]肯定不是'5'了,事实证明这个推理是不严谨的:
(gdb) x/7b input
0xbfb8f0a7:   0x31   0x32   0x33   0x34   0x35   0x04   0x00
input[4]的确是0x35,产生123407还有另外一种可能,就是在下一次循环中123450不是加上而是减去一个数得
到123407。可现在不是到字符串末尾了吗?怎么会有下一次循环呢?注意到循环控制条件是input[i] != '\0',而
本来应该是0x00的位置现在莫名其妙地变成了0x04,因此循环不会结束。继续单步:
(gdb) n
11  for(i=0;input[i]!='\0';i++)
(gdb) p sum
$3 = 12345
(gdb) n
12  sum=sum*10+input[i]-'0';
(gdb) x/7b input
0xbfb8f0a7:   0x31   0x32   0x33   0x34   0x35   0x05   0x00
进入下一次循环,原来的0x04又莫名其妙地变成了0x05,这是怎么回事?这个暂时解释不了,但123407这个结果可以解释了,是12345*10 + 0x05 - 0x30得到的,虽然多循环了一次,但下次一定会退出循环了,因为0x05的后是'\0'。
input[4]后面那个字节到底是什么时候变的?可以用观察点(Watchpoint)来跟踪。我们知道断点是当程序执行到某一代码行时中断,而观察点是当程序访问某个存储单元时中断,如果我们不知道某个存储单元是在哪里被改动的,这时候观察点尤其有用。下面删除原来设的断点,从头执行程序,重复上次的输入,用watch命令设置观察点,跟踪input[4]后面那个字节(可以用input[5]表示,虽然这是访问越界):
(gdb) delete breakpoints
Delete all breakpoints? (y or n) y
(gdb) start
Breakpoint 1 at 0x80483b5: file main.c, line 5.
Starting program: /home/akaedu/main
main () at main.c:5
5    int sum = 0, i = 0;
(gdb) n
9    sum = 0;
(gdb) (直接回车)
10   scanf("%s", input);
(gdb) (直接回车)
12345
11   for (i = 0; input[i] != '\0'; i++)
(gdb) watch input[5]
Hardware watchpoint 2: input[5]
(gdb) i watchpoints
Num         Type                        Disp Enb Address         What
2               hw watchpoint         keep y                          input[5]
(gdb) c
Continuing.
Hardware watchpoint 2: input[5]

Old value = 0 '\0'
New value = 1 '\001'
0x0804840c in main () at main.c:11
11   for (i = 0; input[i] != '\0'; i++)
(gdb) c
Continuing.
Hardware watchpoint 2: input[5]

Old value = 1 '\001'
New value = 2 '\002'
0x0804840c in main () at main.c:11
11      for (i = 0; input[i] != '\0'; i++)
(gdb) c
Continuing.
Hardware watchpoint 2: input[5]
Old value = 2 '\002'
New value = 3 '\003'
0x0804840c in main () at main.c:11
11      for (i = 0; input[i] != '\0'; i++)
已经很明显了,每次都是回到for循环开头的时候改变了input[5]的值,而且是每次加1,而循环变量i正是在每次回到循环开头之前加1,原来input[5]就是变量i的存储单元,换句话说,i的存储单元是紧跟在input数组后面的。修正这个Bug对初学者来说有一定难度。如果你发现了这个Bug却没想到数组访问越界这一点,也许一时想不出原因,就会先去处理另外一个更容易修正的Bug:如果输入的不是数字而是字母或别的符号也能算出结果来,这显然是不对的,可以在循环中加上判断条件检查非法字符:
while (1) {
sum = 0;
scanf("%s", input);
for (i = 0; input[i] != '\0'; i++) {
if (input[i] < '0' || input[i] > '9') {
printf("Invalid input!\n");
sum = -1;
break;
}
sum = sum*10 + input[i] - '0';
}
printf("input=%d\n", sum);
}
然后你会惊喜地发现,不仅输入字母会报错,输入超长也会报错:
$ ./main
123a
Invalid input!
input=-1
dead
Invalid input!
input=-1
1234578
Invalid input!
input=-1
1234567890abcdef
Invalid input!
input=-1
23
input=23
似乎是两个Bug一起解决掉了,但这是治标不治本的解决方法。看起来输入超长的错误是不出现了,但只要没有找到根本原因就不可能真的解决掉,等到条件一变,它可能又冒出来了,在下一节你会看到它又以一种新的形式冒出来了。现在请思考一下为什么加上检查非法字符的代码之后输入超长也会报错。

最后总结一下本节用到的gdb命令:
watch                    设置观察点
info(或i) watchpoints     查看当前设置了哪些观察点
x    从某个位置开始打印存储单元的内容,全部当成字节来看,而不区分哪个字节属于哪个变量