练习20：Zed的强大的调试宏

原文：Exercise 20: Zed’s Awesome Debug Macros

译者：飞龙

在C中有一个永恒的问题，它伴随了你很长时间，然而在这个练习我打算使用一系列我开发的宏来解决它。到现在为止你都不知道它们的强大之处，所以你必须使用它们，总有一天你会来找我说，“Zed，这些调试宏真是太伟大了，我应该把我的第一个孩子的出生归功于你，因为你治好了我十年的心脏病，并且打消了我数次想要自杀的念头。真是要谢谢你这样一个好人，这里有一百万美元，和Leo Fender设计的Snakehead Telecaster电吉他的原型。”

是的，它们的确很强大。

C的错误处理问题

几乎每个编程语言中，错误处理都非常难。有些语言尽可能试图避免错误这个概念，而另一些语言发明了复杂了控制结构，比如异常来传递错误状态。当然的错误大多是因为程序员假定错误不会发生，并且这一乐观的思想影响了他们所用和所创造的语言。

C通过返回错误码或设置全局的errno值来解决这些问题，并且你需要检查这些值。这种机制可以检查现存的复杂代码中，你执行的东西是否发生错误。当你编写更多的C代码时，你应该按照下列模式：

  • 调用函数。
  • 如果返回值出现错误（每次都必须检查）。
  • 清理创建的所有资源。
  • 打印出所有可能有帮助的错误信息。

这意味着对于每一个函数调用（是的，每个函数）你都可能需要多编写3~4行代码来确保它正常功能。这些还不包括清理你到目前创建的所有垃圾。如果你有10个不同的结构体，3个方式。和一个数据库链接，当你发现错误时你应该写额外的14行。

之前这并不是个问题，因为发生错误时，C程序会像你以前做的那样直接退出。你不需要清理任何东西，因为OS会为你自动去做。然而现在很多C程序需要持续运行数周、数月或者数年，并且需要优雅地处理来自于多种资源的错误。你并不能仅仅让你的服务器在首次运行就退出，你也不能让你写的库使使用它的程序退出。这非常糟糕。

其它语言通过异常来解决这个问题，但是这些问题也会在C中出现（其它语言也一样）。在C中你只能够返回一个值，但是异常是基于栈的返回系统，可以返回任意值。C语言中，尝试在栈上模拟异常非常困难，并且其它库也不会兼容。

调试宏

我使用的解决方案是，使用一系列“调试宏”，它们在C中实现了基本的调试和错误处理系统。这个系统非常易于理解，兼容于每个库，并且使C代码更加健壮和简洁。

它通过实现一系列转换来处理错误，任何时候发生了错误，你的函数都会跳到执行清理和返回错误代码的“error:”区域。你可以使用check宏来检查错误代码，打印错误信息，然后跳到清理区域。你也可以使用一系列日志函数来打印出有用的调试信息。

我现在会向你展示你目前所见过的，最强大且卓越的代码的全部内容。

  1. #ifndef __dbg_h__
  2. #define __dbg_h__
  4. #include <stdio.h>
  5. #include <errno.h>
  6. #include <string.h>
  8. #ifdef NDEBUG
  9. #define debug(M, ...)
  10. #else
  11. #define debug(M, ...) fprintf(stderr, "DEBUG %s:%d: " M "\n", __FILE__, __LINE__, ##__VA_ARGS__)
  12. #endif
  14. #define clean_errno() (errno == 0 ? "None" : strerror(errno))
  16. #define log_err(M, ...) fprintf(stderr, "[ERROR] (%s:%d: errno: %s) " M "\n", __FILE__, __LINE__, clean_errno(), ##__VA_ARGS__)
  18. #define log_warn(M, ...) fprintf(stderr, "[WARN] (%s:%d: errno: %s) " M "\n", __FILE__, __LINE__, clean_errno(), ##__VA_ARGS__)
  20. #define log_info(M, ...) fprintf(stderr, "[INFO] (%s:%d) " M "\n", __FILE__, __LINE__, ##__VA_ARGS__)
  22. #define check(A, M, ...) if(!(A)) { log_err(M, ##__VA_ARGS__); errno=0; goto error; }
  24. #define sentinel(M, ...)  { log_err(M, ##__VA_ARGS__); errno=0; goto error; }
  26. #define check_mem(A) check((A), "Out of memory.")
  28. #define check_debug(A, M, ...) if(!(A)) { debug(M, ##__VA_ARGS__); errno=0; goto error; }
  30. #endif

是的，这就是全部代码了，下面是它每一行所做的事情。

dbg.h:1-2

防止意外包含多次的保护措施，你已经在上一个练习中见过了。

dbg.h:4-6

包含这些宏所需的函数。

dbg.h:8

#ifdef的起始，它可以让你重新编译程序来移除所有调试日志信息。

dbg.h:9

如果你定义了NDEBUG之后编译，没有任何调试信息会输出。你可以看到#define debug()被替换为空（右边没有任何东西）。

dbg.h:10

上面的#ifdef所匹配的#else。

dbg.h:11

用于替代的#define debug，它将任何使用debug("format", arg1, arg2)的地方替换成fprintf对stderr的调用。许多程序员并不知道，但是你的确可以创建与printf类似的可变参数宏。许多C编译器（实际上是C预处理器）并不支持它，但是gcc可以做到。这里的魔法是使用##__VA_ARGS__，意思是将剩余的所有额外参数放到这里。同时也要注意，使用了__FILE__和__LINE__来获取当前fine:line用于调试信息。这会非常有帮助。

dbg.h:12

#ifdef的结尾。

dbg.h:14

clean_errno宏用于获取errno的安全可读的版本。中间奇怪的语法是“三元运算符”，你会在后面学到它。

dbg.h:16-20

log_err，log_warn和log_info宏用于为最终用户记录信息。它们类似于debug但不能被编译。

dbg.h:22

到目前为止最棒的宏。check会保证条件A为真，否则会记录错误M（带着log_err的可变参数），之后跳到函数的error:区域来执行清理。

dbg.h:24

第二个最棒的宏，sentinel可以放在函数的任何不应该执行的地方，它会打印错误信息并且跳到error:标签。你可以将它放到if-statements或者switch-statements的不该被执行的分支中，比如default。

dbg.h:26

简写的check_mem宏，用于确保指针有效，否则会报告“内存耗尽”的错误。

dbg.h:28

用于替代的check_debug宏，它仍然会检查并处理错误，尤其是你并不想报告的普遍错误。它里面使用了debug代替log_err来报告错误，所以当你定义了NDEBUG，它仍然会检查并且发生错误时跳出，但是不会打印消息了。

使用dbg.h

下面是一个例子，在一个小的程序中使用了dbg.h的所有函数。这实际上并没有做什么事情，只是向你演示了如何使用每个宏。我们将在接下来的所有程序中使用这些宏，所有要确保理解了如何使用它们。

  1. #include "dbg.h"
  2. #include <stdlib.h>
  3. #include <stdio.h>
  6. void test_debug()
  7. {
  8.     // notice you don't need the \n
  9.     debug("I have Brown Hair.");
  11.     // passing in arguments like printf
  12.     debug("I am %d years old.", 37);
  13. }
  15. void test_log_err()
  16. {
  17.     log_err("I believe everything is broken.");
  18.     log_err("There are %d problems in %s.", 0, "space");
  19. }
  21. void test_log_warn()
  22. {
  23.     log_warn("You can safely ignore this.");
  24.     log_warn("Maybe consider looking at: %s.", "/etc/passwd");
  25. }
  27. void test_log_info()
  28. {
  29.     log_info("Well I did something mundane.");
  30.     log_info("It happened %f times today.", 1.3f);
  31. }
  33. int test_check(char *file_name)
  34. {
  35.     FILE *input = NULL;
  36.     char *block = NULL;
  38.     block = malloc(100);
  39.     check_mem(block); // should work
  41.     input = fopen(file_name,"r");
  42.     check(input, "Failed to open %s.", file_name);
  44.     free(block);
  45.     fclose(input);
  46.     return 0;
  48. error:
  49.     if(block) free(block);
  50.     if(input) fclose(input);
  51.     return -1;
  52. }
  54. int test_sentinel(int code)
  55. {
  56.     char *temp = malloc(100);
  57.     check_mem(temp);
  59.     switch(code) {
  60.         case 1:
  61.             log_info("It worked.");
  62.             break;
  63.         default:
  64.             sentinel("I shouldn't run.");
  65.     }
  67.     free(temp);
  68.     return 0;
  70. error:
  71.     if(temp) free(temp);
  72.     return -1;
  73. }
  75. int test_check_mem()
  76. {
  77.     char *test = NULL;
  78.     check_mem(test);
  80.     free(test);
  81.     return 1;
  83. error:
  84.     return -1;
  85. }
  87. int test_check_debug()
  88. {
  89.     int i = 0;
  90.     check_debug(i != 0, "Oops, I was 0.");
  92.     return 0;
  93. error:
  94.     return -1;
  95. }
  97. int main(int argc, char *argv[])
  98. {
  99.     check(argc == 2, "Need an argument.");
  101.     test_debug();
  102.     test_log_err();
  103.     test_log_warn();
  104.     test_log_info();
  106.     check(test_check("ex20.c") == 0, "failed with ex20.c");
  107.     check(test_check(argv[1]) == -1, "failed with argv");
  108.     check(test_sentinel(1) == 0, "test_sentinel failed.");
  109.     check(test_sentinel(100) == -1, "test_sentinel failed.");
  110.     check(test_check_mem() == -1, "test_check_mem failed.");
  111.     check(test_check_debug() == -1, "test_check_debug failed.");
  113.     return 0;
  115. error:
  116.     return 1;
  117. }

要注意check是如何使用的，并且当它为false时会跳到error:标签来执行清理。这一行读作“检查A是否为真，不为真就打印M并跳出”。

你会看到什么

当你执行这段代码并且向第一个参数提供一些东西，你会看到：

  1. $ make ex20
  2. cc -Wall -g -DNDEBUG    ex20.c   -o ex20
  3. $ ./ex20 test
  4. [ERROR] (ex20.c:16: errno: None) I believe everything is broken.
  5. [ERROR] (ex20.c:17: errno: None) There are 0 problems in space.
  6. [WARN] (ex20.c:22: errno: None) You can safely ignore this.
  7. [WARN] (ex20.c:23: errno: None) Maybe consider looking at: /etc/passwd.
  8. [INFO] (ex20.c:28) Well I did something mundane.
  9. [INFO] (ex20.c:29) It happened 1.300000 times today.
  10. [ERROR] (ex20.c:38: errno: No such file or directory) Failed to open test.
  11. [INFO] (ex20.c:57) It worked.
  12. [ERROR] (ex20.c:60: errno: None) I shouldn't run.
  13. [ERROR] (ex20.c:74: errno: None) Out of memory.

看到check失败之后，它是如何打印具体的行号了吗？这会为接下来的调试工作节省时间。同时也观察errno被设置时它如何打印错误信息。同样，这也可以节省你调试的时间。

C预处理器如何扩展宏

现在我会向你简单介绍一些预处理器的工作原理，让你知道这些宏是如何工作的。我会拆分dbg.h中阿最复杂的宏并且让你运行cpp来让你观察它实际上是如何工作的。

假设我有一个函数叫做dosomething()，执行成功是返回0，发生错误时返回-1。每次我调用dosomething的时候，我都要检查错误码，所以我将代码写成这样：

  1. int rc = dosomething();
  3. if(rc != 0) {
  4.     fprintf(stderr, "There was an error: %s\n", strerror());
  5.     goto error;
  6. }

我想使用预处理器做的是，将这个if语句封装为更可读并且便于记忆的一行代码。于是可以使用这个check来执行dbg.h中的宏所做的事情：

  1. int rc = dosomething();
  2. check(rc == 0, "There was an error.");

这样更加简洁，并且恰好解释了所做的事情：检查函数是否正常工作，如果没有就报告错误。我们需要一些特别的预处理器“技巧”来完成它，这些技巧使预处理器作为代码生成工具更加易用。再次看看check和log_err宏：

  1. #define log_err(M, ...) fprintf(stderr, "[ERROR] (%s:%d: errno: %s) " M "\n", __FILE__, __LINE__, clean_errno(), ##__VA_ARGS__)
  2. #define check(A, M, ...) if(!(A)) { log_err(M, ##__VA_ARGS__); errno=0; goto error; }

第一个宏，log_err更简单一些，只是将它自己替换为fprintf对stderr的调用。这个宏唯一的技巧性部分就是在log_err(M, ...)的定义中使用...。它所做的是让你向宏传入可变参数，从而传入fprintf需要接收的参数。它们是如何注入fprintf的呢？观察末尾的##__VA_ARGS__，它告诉预处理器将...所在位置的参数注入到fprintf调用的相应位置。于是你可以像这样调用了：

  1. log_err("Age: %d, name: %s", age, name);

age, name参数就是...所定义的部分，这些参数会被注入到fprintf中，输出会变成：

  1. fprintf(stderr, "[ERROR] (%s:%d: errno: %s) Age %d: name %d\n",
  2.     __FILE__, __LINE__, clean_errno(), age, name);

看到末尾的age, name了吗？这就是...和##__VA_ARGS__的工作机制，在调用其它变参宏（或者函数）的时候它会起作用。观察check宏调用log_err的方式，它也是用了...和##__VA_ARGS__。这就是传递整个printf风格的格式字符串给check的途径，它之后会传给log_err，二者的机制都像printf一样。

下一步是学习check如何为错误检查构造if语句，如果我们剖析log_err的用法，我们会得到：

  1. if(!(A)) { errno=0; goto error; }

它的意思是，如果A为假，则重置errno并且调用error标签。check宏会被上述if语句·替换，所以如果我们手动扩展check(rc == 0, "There was an error.")，我们会得到：

  1. if(!(rc == 0)) {
  2.     log_err("There was an error.");
  3.     errno=0;
  4.     goto error;
  5. }

在这两个宏的展开过程中，你应该了解了预处理器会将宏替换为它的定义的扩展版本，并且递归地来执行这个步骤，扩展宏定义中的宏。预处理器是个递归的模板系统，就像我之前提到的那样。它的强大来源于使用参数化的代码来生成整个代码块，这使它成为便利的代码生成工具。

下面只剩一个问题了：为什么不像die一样使用函数呢？原因是需要在错误处理时使用file:line的数值和goto操作。如果你在函数在内部执行这些，你不会得到错误真正出现位置的行号，并且goto的实现也相当麻烦。

另一个原因是，如果你编写原始的if语句，它看起来就像是你代码中的其它的if语句，所以它看起来并不像一个错误检查。通过将if语句包装成check宏，就会使这一错误检查的逻辑更清晰，而不是主控制流的一部分。

最后，C预处理器提供了条件编译部分代码的功能，所以你可以编写只在构建程序的开发或调试版本时需要的代码。你可以看到这在dbg.h中已经用到了，debug宏的主体部分只被编译器用到。如果没有这个功能，你需要多出一个if语句来检查是否为“调试模式”，也浪费了CPU资源来进行没有必要的检查。

附加题

  • 将#define NDEBUG放在文件顶端来消除所有调试信息。
  • 撤销上面添加的一行，并在MakeFile顶端将-D NDEBUG添加到CFLAGS，之后重新编译来达到同样效果。
  • 修改日志宏，使之包含函数名称和file:line。