GDB 使用简介

本文内容是我个人觉得在使用 gdb 时经常会用到的一些东西，根据以下参考链接中的内容整理而来，如需更全面的内容请查看参考链接。

参考链接：

Debugging with GDB

用GDB调试程序

---

1. 使用 GDB 调试 C/C++ 程序

要调试 C/C++ 程序，在使用 gcc/g++ 编译器编译生成可执行文件时要加上 -g 选项，把调试信息加到可执行文件中。编译如下：

$ gcc -g hello.c -o hello
$ g++ -g hello.cpp -o hello

如果没有-g，你将看不见程序的函数名、变量名，所代替的全是运行时的内存地址。

当你用 -g 把调试信息加入之后，并成功编译目标代码以后，让我们来看看如何用 gdb 来调试他。

---

2. 启动 GDB 并加载被调试程序

启动 gdb 并加载被调试程序的方式有以下几种：

• gdb <program>

  program也就是你的执行文件，一般在当前目录下。

• gdb <program> core

  用gdb同时调试一个运行程序和core文件，core是程序非法执行后core dump后产生的文件。

• gdb <program> <PID>

  如果你的程序是一个服务程序，那么你可以指定这个服务程序运行时的进程ID。gdb会自动attach上去，并调试他。program应该在PATH环境变量中搜索得到。

以上三种都是在启动 gdb 的同时加载被调试程序。也可以先进入gdb环境，然后再加载被调试程序，方法如下：

1. 先启动 gdb：终端输入命令 gdb
2. 加载被调试程序：在 gdb 环境中执行 file <program>

注：上面两步与 gdb <program> 等效。

进入 gdb 的调试环境后，可以使用 help 命令来查看 gdb 相关的命令，这些帮助信息都是可以根据提示来操作的。

---

3. 查看源代码

3.1 显示源代码

GDB 可以打印出所调试程序的源代码，当然，在程序编译时一定要加上-g的参数，把源程序信息编译到执行文件中。不然就看不到源程序了。当程序停下来以后，GDB会报告程序停在了那个文件的第几行上。你可以用list命令来打印程序的源代码。还是来看一看查看源代码的GDB命令：

• list <n>

  显示程序第 n 行周围的源程序

• list <function>

  显示函数名为function的函数的源程序

• list

  显示当前行 后面 的源程序

• list -

  显示当前行 前面 的源程序

一般是打印当前行的上5行和下5行，如果显示函数是是上2行下8行，默认是10行。当然，你也可以定制显示的范围，使用下面命令可以设置一次显示源程序的行数：

• set listsize <count>

  设置一次显示 count 行源代码

• show listsize

  查看当前 listsize 的设置

list命令还有下面的用法：

• list <first>, <last>

  显示从 first 行到 last 行之间的源代码

• list ,<last>

  显示从当前行到last行之间的源代码

• list +

  往后显示源代码

总结一下，一般来说在list后面可以跟以下这些参数：

<linenum>   			行号
<+offset>   			当前行号的正偏移量
<-offset>   			当前行号的负偏移量
<filename:linenum>  	哪个文件的哪一行
<function>  			函数名
<filename:function> 	哪个文件中的哪个函数
<*address>  			程序运行时的语句在内存中的地址

---

3.2 搜索源代码

GDB 提供了以下源代码搜索命令：

• search <regexp> 或 forward-search <regexp>

  往下查找第一个符合正则表达式 regexp 的行

• reverse-search <regexp>

  往上查找第一个符合正则表达式 regexp 的行

---

3.3 指定源文件的路径

某些时候，用-g编译过后的执行程序中只是包括了源文件的名字，没有路径名。GDB提供了可以让你指定源文件的路径的命令，以便GDB进行搜索。

• directory <dirname ...> 或 dir <dirname ...>

  添加一个源文件路径到当前路径的前面。如果你要指定多个路径，UNIX下你可以使用“:”，Windows下你可以使用“;”。

• directory

  重置源文件路径为默认值（$cdir:$cwd on Unix systems）。需要确认

• show directories

  显示定义了的源文件搜索路径

---

4. 在 GDB 中运行程序

当以 gdb <program> 方式启动 gdb 后，运行程序使用 r 或是 run 命令。程序的运行，你有可能需要设置下面四方面的事：

1. 程序运行参数

   set args ：可指定运行时参数。（如：set args 10 20 30 40 50）
   show args ：命令可以查看设置好的运行参数。

2. 运行环境

   path <dir> ：可设定程序的运行路径。
   show paths： 查看程序的运行路径。
   set environment varname [=value]： 设置环境变量。如：set env USER=hchen
show environment [varname] ：查看环境变量。

3. 工作目录

   cd <dir> ：相当于 shell 的 cd 命令。
   pwd： 显示当前的所在目录。

4. 程序的输入输出

   info terminal：显示你程序用到的终端的模式。
   run > outfile ：使用重定向控制程序输出。
   tty /dev/ttyb：tty命令可以指定输入输出的终端设备。

---

5. 暂停程序运行

调试程序中，暂停程序运行是必须的，GDB可以方便地暂停程序的运行。你可以设置程序的在哪行停住，在什么条件下停住，在收到什么信号时停往等等。以便于你查看运行时的变量，以及运行时的流程。

当进程被gdb停住时，你可以使用info program 来查看程序的是否在运行，进程号，被暂停的原因。

在gdb中，我们可以有以下几种暂停方式：

• 断点（BreakPoint）；
• 观察点（Watch Point）；
• 捕捉点（Catch Point）；
• 信号（Signals）；
• 线程停止（Thread Stops）。

如果要恢复程序运行，可以使用 c 或是 continue命令。

5.1 断点设置

我们用 break 命令（简写为 b）来设置断点。下面有几点设置断点的方法：

• break <function>

  在进入指定函数时停住。C++ 中可以使用 class::function 或 function(type,type) 格式来指定函数名.

• break <linenum>

  在指定行号设置断点。

• break +offset 与 break -offset

  在当前行号的前面或后面的 offset 行停住。offiset为自然数。

• break filename:linenum

  在源文件 filename 的 linenum 行处停住。

• break filename:linenum

  在源文件 filename 的 function 函数的入口处停住。

• break *address

  在程序运行的内存地址处停住。

• break

  break命令没有参数时，表示在下一条指令处停住。

• break ... if <condition>

  …可以是上述的参数，condition表示条件，在条件成立时停住。比如在循环体中，可以设置break if i==100，表示当i为100时停住程序。

查看断点时，可使用info命令，如下所示：

• info breakpoints [n]
• info break [n]

注：n表示断点号。也可以不加 n，表示显示所有断点。

断点菜单：

在C++中，可能会重复出现同一个名字的函数若干次（函数重载），在这种情况下，break 不能告诉GDB要停在哪个函数的入口。当然，你可以使用break <function(type)>也就是把函数的参数类型告诉GDB，以指定一个函数。否则的话，GDB会给你列出一个断点菜单供你选择你所需要的断点。你只要输入你菜单列表中的编号就可以了。如：

(gdb) b String::after
[0] cancel
[1] all
[2] file:String.cc; line number:867
[3] file:String.cc; line number:860
[4] file:String.cc; line number:875
[5] file:String.cc; line number:853
[6] file:String.cc; line number:846
[7] file:String.cc; line number:735
> 2 4 6
Breakpoint 1 at 0xb26c: file String.cc, line 867.
Breakpoint 2 at 0xb344: file String.cc, line 875.
Breakpoint 3 at 0xafcc: file String.cc, line 846.
Multiple breakpoints were set.
Use the "delete" command to delete unwanted
breakpoints.
(gdb)

可见，GDB 列出了所有 after 的重载函数，你可以选一下列表编号就行了。0表示放弃设置断点，1表示所有函数都设置断点。

---

5.2 观察点设置

观察点一般来观察某个表达式（变量也是一种表达式）的值是否有变化了，如果有变化，马上停住程序。我们有下面的几种方法来设置观察点：

• watch <expr>

  为表达式（变量）expr 设置一个观察点。一表达式值有变化时，马上停住程序。

• rwatch <expr>

  当表达式（变量）expr被读时，停住程序。

• awatch <expr>

  当表达式（变量）的值被读或被写时，停住程序。

• info watchpoints

  列出当前所设置的所有观察点。

---

5.3 捕捉点设置

你可设置捕捉点来捕捉程序运行时的一些事件。如：载入共享库（动态链接库）或是C++的异常。用以下格式设置捕捉点：

• catch <event>

  当event发生时，停住程序。event可以是下面的内容：

  • throw 一个C++抛出的异常。（throw为关键字）
  • catch 一个C++捕捉到的异常。（catch为关键字）
  • exec 调用系统调用exec时。（exec为关键字，目前此功能只在HP-UX下有用）
  • fork 调用系统调用fork时。（fork为关键字，目前此功能只在HP-UX下有用）
  • vfork 调用系统调用vfork时。（vfork为关键字，目前此功能只在HP-UX下有用）
  • load 或 load 载入共享库（动态链接库）时。（load为关键字，目前此功能只在HP-UX下有用）
  • unload 或 unload 卸载共享库（动态链接库）时。（unload为关键字，目前此功能只在HP-UX下有用）

• tcatch <event>

  只设置一次捕捉点，当程序停住以後，该点被自动删除。

---

5.4 维护停止点

上面说了如何设置程序的停止点，GDB中的停止点也就是上述的三类。在GDB中，如果你觉得已定义好的停止点没有用了，你可以使用delete、clear、disable、enable这几个命令来进行维护：

• clear

  清除所有的已定义的停止点。

• clear <function> 与 clear <filename:function>

  清除所有设置在函数上的停止点。

• clear <linenum> 与 clear <filename:linenum>

  清除所有设置在指定行上的停止点。

• delete [breakpoints][range...]

  删除指定的断点，breakpoints为断点号。如果不指定断点号，则表示删除所有的断点。range 表示断点号的范围（如：3-7）。其简写命令为 d。

• disable [breakpoints][range...]

  disable所指定的停止点，breakpoints为停止点号。如果什么都不指定，表示disable所有的停止点。简写命令是dis。这是一种比删除更好的方法，在需要时可以通过 enable 再次启用。

• enable [breakpoints][range...]

  enable所指定的停止点，breakpoints为停止点号。

• enable [breakpoints] once range...

  enable所指定的停止点一次，当程序停止后，该停止点马上被GDB自动disable。

• enable [breakpoints] delete range...

  enable所指定的停止点一次，当程序停止后，该停止点马上被GDB自动删除。

---

6. 恢复程序运行和单步调试

当程序被停住了，你可以用 continue 命令恢复程序的运行直到程序结束，或下一个断点到来。也可以使用 step或 next 命令单步跟踪程序。

• continue [ignore-count] 或 c [ignore-count] 或 fg [ignore-count]

  恢复程序运行，直到程序结束，或是下一个断点到来。ignore-count表示忽略其后的断点次数。continue，c，fg三个命令都是一样的意思。

• step <count>

  单步跟踪，如果有函数调用，他会进入该函数。进入函数的前提是，此函数被编译有debug信息。很像VC等工具中的step in。后面可以加count也可以不加，不加表示一条条地执行，加表示执行后面的count条指令，然后再停住。

• next <count>

  同样单步跟踪，如果有函数调用，他不会进入该函数。很像VC等工具中的step over。后面可以加count也可以不加，不加表示一条条地执行，加表示执行后面的count条指令，然后再停住。

• set step-mode 或 set step-mode on

  打开step-mode模式，于是，在进行单步跟踪时，程序不会因为没有 debug 信息而不停住。这个参数很有利于查看机器码。

• set step-mode off

  关闭step-mode模式

• finish

  运行程序，直到当前函数完成返回。并打印函数返回时的堆栈地址和返回值及参数值等信息。

• until 或 u

  当你厌倦了在一个循环体内单步跟踪时，这个命令可以运行程序直到退出循环体。

• stepi 或 si | nexti 或 ni

  单步跟踪一条机器指令！一条程序代码有可能由数条机器指令完成，stepi和nexti可以单步执行机器指令。与之一样有相同功能的命令是 “display/i $pc” ，当运行完这个命令后，单步跟踪会在打出程序代码的同时打出机器指令（也就是汇编代码）

---

7. 查看栈信息

当程序被停住了，你需要做的第一件事就是查看程序是在哪里停住的。当你的程序调用了一个函数，函数的地址，函数参数，函数内的局部变量都会被压入“栈”（Stack）中。你可以用GDB命令来查看当前的栈中的信息。

下面是一些查看函数调用栈信息的 GDB 命令：

• backtrace 或 bt

  打印当前的函数调用栈的所有信息。

• backtrace <n> 或 bt <n>

  n是一个正整数，表示只打印栈顶上n层的栈信息。

• backtrace <-n> 或 bt <-n>

  -n表一个负整数，表示只打印栈底下n层的栈信息。

如果你要查看某一层的信息，你需要切换当前栈，一般来说，程序停止时，最顶层的栈就是当前栈，如果你要查看栈下面层的详细信息，首先要做的是切换当前栈：

• frame <n> 或 f <n>

  n是一个从0开始的整数，是栈中的层编号。比如：frame 0，表示栈顶，frame 1，表示栈的第二层。

• up <n>

  表示向栈的上面移动n层，可以不打n，表示向上移动一层。

• down <n>

  表示向栈的下面移动n层，可以不打n，表示向下移动一层。

查看当前栈层的信息，你可以用以下GDB命令：

• frame 或 f

  会打印出这些信息：栈的层编号，当前的函数名，函数参数值，函数所在文件及行号，函数执行到的语句。

• info frame 或 info f

  这个命令会打印出更为详细的当前栈层的信息，只不过，大多数都是运行时的内存地址。比如：函数地址，调用函数的地址，被调用函数的地址，目前的函数是由什么样的程序语言写成的、函数参数地址及值、局部变量的地址等等。

• info args

  打印出当前函数的参数名及其值。

• info locals

  打印出当前函数中所有局部变量及其值。

• info catch

  打印出当前的函数中的异常处理信息。

---

8. 查看运行时数据

在你调试程序时，当程序被停住时，你可以使用 print 命令（简写命令为p），或是同义命令 inspect 来查看当前程序的运行数据。print 命令的格式是：

print <expr>
print /<f> <expr>

<expr> 是表达式，是你所调试的程序的语言的表达式（GDB可以调试多种编程语言），<f> 是输出的格式，比如，如果要把表达式按16进制的格式输出，那么就是 /x。

8.1 程序变量

在GDB中，你可以随时查看以下三种变量的值：

1. 全局变量（所有文件可见的）
2. 静态全局变量（当前文件可见的）
3. 局部变量（当前Scope可见的）

如果你的局部变量和全局变量发生冲突（也就是重名），一般情况下是局部变量会隐藏全局变量，也就是说，如果一个全局变量和一个函数中的局部变量同名时，如果当前停止点在函数中，用 print 显示出的变量的值会是函数中的局部变量的值。如果此时你想查看全局变量的值时，你可以使用 “::” 操作符：

print  file::variable
print  function::variable

---

8.2 自动显示

你可以设置一些自动显示的变量，当程序停住时，或是在你单步跟踪时，这些变量会自动显示。相关的GDB命令是 display：

display <expr>
display/<fmt> <expr>
display/<fmt> <addr>

expr是一个表达式，fmt表示显示的格式，addr表示内存地址，当你用display设定好了一个或多个表达式后，只要你的程序被停下来，GDB会自动显示你所设置的这些表达式的值。

下面是一些和display相关的GDB命令：

undisplay <dnums...>
delete display <dnums...>

删除自动显示，dnums意为所设置好了的自动显式的编号。如果要同时删除几个，编号可以用空格分隔，如果要删除一个范围内的编号，可以用减号表示（如：2-5）

disable display <dnums...>
enable display <dnums...>

disable和enalbe不删除自动显示的设置，而只是让其失效和恢复。

info display

查看display设置的自动显示的信息。GDB会打出一张表格，向你报告当前调试中设置了多少个自动显示设置，其中包括，设置的编号，表达式，是否enable。

---

后记

---