GDB动态打印：让你随时随地printf，不需修改代码，不需重新编译

引言 - 程序调试的痛

调试是程序员逃脱不了的宿命！

Linux上，有人喜欢GDB，有人喜欢简单粗暴的printf。很难说哪个好，哪个不好，两者各有各的优势和不足，大多时候是可以互补的。

printf最大的不足，就是需要修改代码，重新编译，重新部署。而程序调试本身是个复杂的工作，很多时候需要不断重复这些步骤，这就导致问题定位效率非常低。而且，当问题定位出来之后，还要花不少精力，把这些调试信息全部删掉！

对于简单的程序，这些尚可接受。但是，在大型项目中，单是编译构建过程可能就要几十分钟，甚至数个小时，而部署过程则更为复杂。你能想象得出，在这样的项目中一直重复这些过程，是一件多么痛苦的事情吗？

那么，有没有一种方法，既不需要修改源码，又能随时在程序中任何地方任意添加打印信息呢？

当然有！GDB的动态打印功能正式为此而生的！

GDB Dynamic Printf

GDB提供了Dynamic Printf功能，下文我们称之为动态打印。利用这个功能，我们可以在不修改程序源码的情况下，随时在程序的任何地方添加格式化打印。

如此一来，当然也就不需要重新编译和部署的过程了。

我们先看一个简单的示例，然后再详细介绍它的实现原理，和相关命令的用法。

示例

一个简单示例，如下图所示：

int main(int argc, char *argv[])
{
    int i, a, b;

    a = 1;
    b = 2;

    for(i = 0; i < 5; i ++)
    {
        a = a + i;
        b = a * 2;
    }

    return 0;
}

先编译一下：

gcc -g test.c -o test

然后用GDB进行调试：

和期望的一样，程序没有任何打印输出。

现在，我们在第6行、第11行、第14行分别添加一个动态打印断点，用下面的命令：

dprintf 6,"Hello, World!\n"
dprintf 11,"i = %d, a = %d, b = %d\n",i,a,b
dprintf 14,"Leaving! Bye bye!\n"

如下图：

稍微解释一下：

• 第6行的语句会打印一句“Hello, World!”
• 第11行会把i、a、b的值分别打印出来
• 第14行打印“Leaving! Bye bye!”

设置好之后，查看一下断点的信息：

已经设置成功了。然后，重新运行：

看到了吧，尽管我们并没有对源码做任何修改，且没有重新编译，但程序仍然按照我们的设置，打印出了我们想要的信息！

是不是很神奇呢？GDB的动态打印功能究竟是如何工作的呢？

GDB 动态打印实现原理

在上面的示例中，在设置好动态打印的信息之后，我们可以用info break命令查看所设置的信息。

可见，GDB的动态打印，本质上也是一种特殊的断点。但是，它与一般的断点又有所区别。

一般的断点被触发后，会中断程序执行，然后等待用户操作，并且用户必须输入continue命令让程序恢复执行。

而动态打印断点被触发后，程序也会暂时中断执行，但是不需要等待用户响应，而是直接执行用户预设的格式化打印语句，并自动恢复程序的执行。

GDB动态打印的使用方法

设置动态打印的命令是dprintf，格式如下：

dprintf location,format string,arg1,arg2,...

dprintf命令和C语言中的printf的用法很相似，支持格式化打印。

相比printf函数，dprintf命令多了一个location参数，用于指定动态打印被触发的位置。

和break命令设置断点时一样，location可以是文件名:行号、函数名、或者具体的地址等。

除了location外，剩余的几个参数，就和printf()函数一致了。format指定字符串打印的格式，后面几个参数指定打印的数据来源。

以上面示例中的命令为例：

dprintf 6,"Hello, World!\n"
dprintf 11,"i = %d, a = %d, b = %d\n",i,a,b
dprintf 14,"Leaving! Bye bye!\n"

在功能上等价于下图中右侧的代码：

到这里，GDB动态打印的最基本功能就介绍完了。

断点信息丢失怎么办？

在实际项目的调试过程中，难免会由于各种原因而必须要反复的调试才能定位出问题的原因，或者彻底理解程序的代码逻辑。

然而，dprintf本质上也是一种断点，因此，当调试结束后，本次调试时设置的断点信息就全部丢失了。如果要再次调试的话，就不得不重新设置一遍。

如果每次调试过程中，只需要设置一两个动态打印的话，那倒也简单。

可是，如果需要设置十几个甚至几十个动态打印呢？难道每次调试都要全部重新设置一遍吗？想想都是一件比较麻烦的事情，对吧？

其实，GDB也有对应的处理方案，很简单就可以解决！

保存和加载GDB断点信息

为了解决上面提到的问题，GDB很贴心地提供了对断点信息保存和加载的功能。

GDB中，可以把当前所设置的各种类型的断点信息全部保存在一个脚本文件中。这其中当然也包括dprintf设置的动态打印信息。

只需要执行下面的命令即可：

save breakpoints file_name

这条命令会把当前所有的断点信息都保存在file_name指定的文件中。

等下次进行调试时，可以把file_name文件中的断点信息重新加载起来。有两种方法：

1. 启动GDB时使用“-x file_name”参数。
2. 在GDB中执行source file_name命令。

下面分别演示一下。

保存断点信息

我们用GDB重新启动上面示例中的test程序：

1. 用dprintf设置好断点。
2. 用info break命令查看一下断点信息。
3. 执行“save breakpoints test.bp”命令，把断点信息保存在test.bp文件中。

我们看下一下test.bp中究竟保存了什么内容：

原来，就是我们之前执行的三条dprintf命令，并且是以文本形式存在test.bp中的。

接下来，我们用两种方法分别加载test.bp中的断点信息。

用-x参数加载断点信息

可见，指定-x参数后，GDB在开始调试程序之前，会从指定的文件中把断点信息加载进来，并重新设置在程序中。因此，执行run命令后，程序能够按照我们的预期正常执行动态打印功能。

source命令加载断点信息

如下图所示：

GDB把test加载起来之后，info break并没有显示出任何断点信息。然后，我们执行source test.bp命令，GDB会把断点信息从test.bp加载进来，并重新设置在test程序中。

---

欢迎关注微信公众号：【原点技术】，分享真正有用的东西！

进技术交流群，欢迎添加作者微信：CreCoding

原创文章，未经允许禁止转载，转载请联系作者：CreCoding