1. 单步执行和跟踪函数调用

看下面的程序：

例 10.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.  
  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. }

add_range函数从low加到high，在main函数中首先从1加到10，把结果保存下来，然后从1加到100，再把结果保存下来，最后打印的两个结果是：

  1. result[0]=55
  2. result[1]=5105

第一个结果正确[20]，第二个结果显然不正确，在小学我们就听说过高斯小时候的故事，从1加到100应该是5050。一段代码，第一次运行结果是对的，第二次运行却不对，这是很常见的一类错误现象，这种情况不应该怀疑代码而应该怀疑数据，因为第一次和第二次运行的都是同一段代码，如果代码是错的，那为什么第一次的结果能对呢？然而第一次和第二次运行时相关的数据却有可能不同，错误的数据会导致错误的结果。在动手调试之前，读者先试试只看代码能不能看出错误原因，只要前面几章学得扎实就应该能看出来。

在编译时要加上-g选项，生成的可执行文件才能用gdb进行源码级调试：

  1. $ gcc -g main.c -o main
  2. $ gdb main
  3. GNU gdb 6.8-debian
  4. Copyright (C) 2008 Free Software Foundation, Inc.
  5. License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
  6. This is free software: you are free to change and redistribute it.
  7. There is NO WARRANTY, to the extent permitted by law.  Type "show copying"
  8. and "show warranty" for details.
  9. This GDB was configured as "i486-linux-gnu"...
  10. (gdb)

-g选项的作用是在可执行文件中加入源代码的信息，比如可执行文件中第几条机器指令对应源代码的第几行，但并不是把整个源文件嵌入到可执行文件中，所以在调试时必须保证gdb能找到源文件。gdb提供一个类似Shell的命令行环境，上面的(gdb)就是提示符，在这个提示符下输入help可以查看命令的类别：

  1. (gdb) help
  2. List of classes of commands:
  3.  
  4. aliases -- Aliases of other commands
  5. breakpoints -- Making program stop at certain points
  6. data -- Examining data
  7. files -- Specifying and examining files
  8. internals -- Maintenance commands
  9. obscure -- Obscure features
  10. running -- Running the program
  11. stack -- Examining the stack
  12. status -- Status inquiries
  13. support -- Support facilities
  14. tracepoints -- Tracing of program execution without stopping the program
  15. user-defined -- User-defined commands
  16.  
  17. Type "help" followed by a class name for a list of commands in that class.
  18. Type "help all" for the list of all commands.
  19. Type "help" followed by command name for full documentation.
  20. Type "apropos word" to search for commands related to "word".
  21. Command name abbreviations are allowed if unambiguous.

也可以进一步查看某一类别中有哪些命令，例如查看files类别下有哪些命令可用：

  1. (gdb) help files
  2. Specifying and examining files.
  3.  
  4. List of commands:
  5.  
  6. add-shared-symbol-files -- Load the symbols from shared objects in the dynamic linker's link map
  7. add-symbol-file -- Load symbols from FILE
  8. add-symbol-file-from-memory -- Load the symbols out of memory from a dynamically loaded object file
  9. cd -- Set working directory to DIR for debugger and program being debugged
  10. core-file -- Use FILE as core dump for examining memory and registers
  11. directory -- Add directory DIR to beginning of search path for source files
  12. edit -- Edit specified file or function
  13. exec-file -- Use FILE as program for getting contents of pure memory
  14. file -- Use FILE as program to be debugged
  15. forward-search -- Search for regular expression (see regex(3)) from last line listed
  16. generate-core-file -- Save a core file with the current state of the debugged process
  17. list -- List specified function or line
  18. ...

现在试试用list命令从第一行开始列出源代码：

  1. (gdb) list 1
  2. 1    #include <stdio.h>
  3. 2    
  4. 3    int add_range(int low, int high)
  5. 4    {
  6. 5        int i, sum;
  7. 6        for (i = low; i <= high; i++)
  8. 7            sum = sum + i;
  9. 8        return sum;
  10. 9    }
  11. 10

一次只列10行，如果要从第11行开始继续列源代码可以输入

  1. (gdb) list

也可以什么都不输直接敲回车，gdb提供了一个很方便的功能，在提示符下直接敲回车表示重复上一条命令。

  1. (gdb) （直接回车）
  2. 11    int main(void)
  3. 12    {
  4. 13        int result[100];
  5. 14        result[0] = add_range(1, 10);
  6. 15        result[1] = add_range(1, 100);
  7. 16        printf("result[0]=%d\nresult[1]=%d\n", result[0], result[1]);
  8. 17        return 0;
  9. 18

gdb的很多常用命令有简写形式，例如list命令可以写成l，要列一个函数的源代码也可以用函数名做参数：

  1. (gdb) l add_range
  2. 1    #include <stdio.h>
  3. 2    
  4. 3    int add_range(int low, int high)
  5. 4    {
  6. 5        int i, sum;
  7. 6        for (i = low; i <= high; i++)
  8. 7            sum = sum + i;
  9. 8        return sum;
  10. 9    }
  11. 10

现在退出gdb的环境：

  1. (gdb) quit

我们做一个实验，把源代码改名或移到别处再用gdb调试，这样就列不出源代码了：

  1. $ mv main.c mian.c
  2. $ gdb main
  3. ...
  4. (gdb) l
  5. 5    main.c: No such file or directory.
  6.     in main.c

可见gcc的-g选项并不是把源代码嵌入到可执行文件中的，在调试时也需要源文件。现在把源代码恢复原样，我们继续调试。首先用start命令开始执行程序：

  1. $ gdb main
  2. ...
  3. (gdb) start
  4. Breakpoint 1 at 0x80483ad: file main.c, line 14.
  5. Starting program: /home/akaedu/main 
  6. main () at main.c:14
  7. 14        result[0] = add_range(1, 10);
  8. (gdb)

gdb停在main函数中变量定义之后的第一条语句处等待我们发命令，gdb列出的这条语句是即将执行的下一条语句。我们可以用next命令（简写为n）控制这些语句一条一条地执行：

  1. (gdb) n
  2. 15        result[1] = add_range(1, 100);
  3. (gdb) （直接回车）
  4. 16        printf("result[0]=%d\nresult[1]=%d\n", result[0], result[1]);
  5. (gdb) （直接回车）
  6. result[0]=55
  7. result[1]=5105
  8. 17        return 0;

用n命令依次执行两行赋值语句和一行打印语句，在执行打印语句时结果立刻打出来了，然后停在return语句之前等待我们发命令。虽然我们完全控制了程序的执行，但仍然看不出哪里错了，因为错误不在main函数中而在add_range函数中，现在用start命令重新来过，这次用step命令（简写为s）钻进add_range函数中去跟踪执行：

  1. (gdb) start
  2. The program being debugged has been started already.
  3. Start it from the beginning? (y or n) y
  4.  
  5. Breakpoint 2 at 0x80483ad: file main.c, line 14.
  6. Starting program: /home/akaedu/main 
  7. main () at main.c:14
  8. 14        result[0] = add_range(1, 10);
  9. (gdb) s
  10. add_range (low=1, high=10) at main.c:6
  11. 6        for (i = low; i <= high; i++)

这次停在了add_range函数中变量定义之后的第一条语句处。在函数中有几种查看状态的办法，backtrace命令（简写为bt）可以查看函数调用的栈帧：

  1. (gdb) bt
  2. #0  add_range (low=1, high=10) at main.c:6
  3. #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函数局部变量的值：

  1. (gdb) i locals
  2. i = 0
  3. sum = 0

如果想查看main函数当前局部变量的值也可以做到，先用frame命令（简写为f）选择1号栈帧然后再查看局部变量：

  1. (gdb) f 1
  2. #1  0x080483c1 in main () at main.c:14
  3. 14        result[0] = add_range(1, 10);
  4. (gdb) i locals 
  5. result = {0, 0, 0, 0, 0, 0, 134513196, 225011984, -1208685768, -1081160480, 
  6. ...
  7.   -1208623680}

注意到result数组中有很多元素具有杂乱无章的值，我们知道未经初始化的局部变量具有不确定的值。到目前为止一切正常。用s或n往下走几步，然后用print命令（简写为p）打印出变量sum的值：

  1. (gdb) s
  2. 7            sum = sum + i;
  3. (gdb) （直接回车）
  4. 6        for (i = low; i <= high; i++)
  5. (gdb) （直接回车）
  6. 7            sum = sum + i;
  7. (gdb) （直接回车）
  8. 6        for (i = low; i <= high; i++)
  9. (gdb) p sum
  10. $1 = 3

第一次循环i是1，第二次循环i是2，加起来是3，没错。这里的$1表示gdb保存着这些中间结果，$后面的编号会自动增长，在命令中可以用$1、$2、$3等编号代替相应的值。由于我们本来就知道第一次调用的结果是正确的，再往下跟也没意义了，可以用finish命令让程序一直运行到从当前函数返回为止：

  1. (gdb) finish
  2. Run till exit from #0  add_range (low=1, high=10) at main.c:6
  3. 0x080483c1 in main () at main.c:14
  4. 14        result[0] = add_range(1, 10);
  5. Value returned is $2 = 55

返回值是55，当前正准备执行赋值操作，用s命令赋值，然后查看result数组：

  1. (gdb) s
  2. 15        result[1] = add_range(1, 100);
  3. (gdb) p result
  4. $3 = {55, 0, 0, 0, 0, 0, 134513196, 225011984, -1208685768, -1081160480, 
  5. ...
  6.   -1208623680}

第一个值55确实赋给了result数组的第0个元素。下面用s命令进入第二次add_range调用，进入之后首先查看参数和局部变量：

  1. (gdb) s
  2. add_range (low=1, high=100) at main.c:6
  3. 6        for (i = low; i <= high; i++)
  4. (gdb) bt
  5. #0  add_range (low=1, high=100) at main.c:6
  6. #1  0x080483db in main () at main.c:15
  7. (gdb) i locals 
  8. i = 11
  9. sum = 55

由于局部变量i和sum没初始化，所以具有不确定的值，又由于两次调用是挨着的，i和sum正好取了上次调用时的值，原来这跟例 3.7 “验证局部变量存储空间的分配和释放”是一样的道理，只不过我这次举的例子设法让局部变量sum在第一次调用时初值为0了。i的初值不是0倒没关系，在for循环中会赋值为0的，但sum如果初值不是0，累加得到的结果就错了。好了，我们已经找到错误原因，可以退出gdb修改源代码了。如果我们不想浪费这次调试机会，可以在gdb中马上把sum的初值改为0继续运行，看看这一处改了之后还有没有别的Bug：

  1. (gdb) set var sum=0
  2. (gdb) finish
  3. Run till exit from #0  add_range (low=1, high=100) at main.c:6
  4. 0x080483db in main () at main.c:15
  5. 15        result[1] = add_range(1, 100);
  6. Value returned is $4 = 5050
  7. (gdb) n
  8. 16        printf("result[0]=%d\nresult[1]=%d\n", result[0], result[1]);
  9. (gdb) （直接回车）
  10. result[0]=55
  11. result[1]=5050
  12. 17        return 0;

这样结果就对了。修改变量的值除了用set命令之外也可以用print命令，因为print命令后面跟的是表达式，而我们知道赋值和函数调用也都是表达式，所以也可以用print命令修改变量的值或者调用函数：

  1. (gdb) p result[2]=33
  2. $5 = 33
  3. (gdb) p printf("result[2]=%d\n", result[2])
  4. result[2]=33
  5. $6 = 13

我们讲过，printf的返回值表示实际打印的字符数，所以$6的结果是13。总结一下本节用到的gdb命令：

表 10.1. gdb基本命令1

命令描述
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）执行下一行语句，如果有函数调用则进入到函数中

习题

1、用gdb一步一步跟踪第 3 节 “递归”讲的factorial函数，对照着图 5.2 “factorial(3)的调用过程”查看各层栈帧的变化情况，练习本节所学的各种gdb命令。

[20] 这么说不够准确，在有些平台和操作系统上第一个结果也未必正确，如果在你机器上运行第一个结果也不正确，首先检查一下程序有没有抄错，如果没抄错那就没关系了，顺着我的讲解往下看就好了，结果是多少都无关紧要。