教育示例表明有时 printf 作为调试可能会隐藏错误

Question

我记得当我在学习 C 编程课程时，一位老师曾经建议我使用 printf 来观察我试图调试的程序的执行情况。这个程序有一个分段错误，原因我现在不记得了。我听从了他的建议，分段错误消失了。幸运的是，一位聪明的助教告诉我要调试而不是使用 printf。在这种情况下，这是一件有用的事情。

所以，今天我想向某人展示使用 printf 可能会隐藏一个错误，但我找不到有这个奇怪错误的旧代码（功能？嗯）。

问题：你们中也有人遇到过这种行为吗？我怎样才能重现这样的东西？

编辑：

我发现我的问题部分将我的观点定位为“使用 printf 是错误的”。我并不是这么说的，而且我不喜欢采取极端的意见，所以我正在编辑一下这个问题。我同意 printf 是一个很好的工具，但我只是想重新创建一个例子，其中 printf 使分段错误消失，因此证明必须小心。

Answer 1

在某些情况下，添加 printf 调用会改变代码的行为，但在某些情况下，调试也会改变代码的行为。最突出的例子是调试多线程代码，其中停止线程的执行可能会改变程序的行为，因此您正在寻找的错误可能不会发生。

所以使用 printf 语句确实有充分的理由。是调试还是 printf 应根据具体情况决定。请注意，无论如何，两者并不排斥 - 即使代码包含 printf 调用，您可以调试代码:-)

Answer 2

你很难说服我不要使用日志记录（在这种情况下 printf 是一种特殊的日志记录形式）来调试。显然，要调试崩溃，首先要做的是获取回溯并使用 purify 或类似的工具，但如果原因不明显，那么日志记录是迄今为止您可以使用的最佳工具之一。调试器可以让您专注于细节，日志记录可以让您了解更大的情况。两者都有用。

Answer 3

听起来您正在处理 heisenbug。

我不认为使用 printf 作为调试工具有什么本质上的“错误”。但是，是的，就像任何其他工具一样，它也有其缺陷，而且，添加 printf 语句不止一次会产生 heisenbug。然而，我也遇到过由于调试器引入内存布局更改而出现的 heisenbug，在这种情况下，printf 在跟踪导致崩溃的步骤方面被证明是非常有价值的。

Answer 4

恕我直言，每个开发人员仍然时不时地依赖打印输出。我们刚刚学会称它们为“详细日志”。

更重要的是，我看到的主要问题是人们对待 printfs 就好像它们是无敌的。例如，在 Java 中经常会看到类似

System.out.println("The value of z is " + z + " while " + obj.someMethod().someOtherMethod());

This is Great 的情况，只不过 z 实际上参与了该方法，而其他对象却没有参与，并且可以确保您不会从 obj 的表达式中得到异常。

打印输出的另一件事是它们会带来延迟。我见过在引入打印输出时有时会“修复”具有竞争条件的代码。如果某些代码使用它，我不会感到惊讶。

Answer 5

我记得有一次尝试在 Macintosh 上调试一个程序（大约 1991 年），其中编译器为 32K 到 64K 之间的堆栈帧生成的清理代码是错误的，因为它使用 16 位地址加法而不是 32 位地址加法（16 位地址加法）。添加到地址寄存器的位数将在 68000 上进行符号扩展。序列是这样的：

  copy stack pointer to some register
  push some other registers on stack
  subtract about 40960 from stack pointer
  do some stuff which leaves saved stack-pointer register alone
  add -8192 (signed interpretation of 0xA000) to stack pointer
  pop registers
  reload stack pointer from that other register

最终效果是一切都很好除了保存的寄存器已损坏，并且其中一个保存了一个常量（全局数组的地址）。如果编译器在一段代码期间将变量优化为寄存器，它会在调试信息文件中报告该变量，以便调试器可以正确输出它。当一个常量被如此优化时，编译器显然不包含此类信息，因为应该没有必要。我通过对数组的地址执行“printf”来跟踪情况，并设置断点，以便我可以查看 printf 之前和之后的地址。调试器正确报告了 printf 前后的地址，但 printf 输出了错误的值，因此我反汇编了代码，发现 printf 将寄存器 A3 压入堆栈；在 printf 之前查看寄存器 A3，发现它的值与数组的地址相当不同（printf 显示 A3 实际保存的值）。

如果我不能同时使用调试器和 printf （或者，就这一点而言，如果我不理解 68000 汇编代码），我不知道如何跟踪该代码。

Answer 6

我设法做到了这一点。我正在从平面文件中读取数据。我的错误算法如下：

1. 获取输入文件的长度（以字节为单位）
2. 分配可变长度的字符数组以用作缓冲区
   • 文件很小，所以我不担心堆栈溢出，但是零长度输入文件怎么办？哎呀！
3. 如果输入文件长度为 0，则返回错误代码

我发现我的函数会可靠地抛出 seg 错误 - 除非函数主体中的某处有 printf，在这种情况下它将完全按照我的预期工作。 seg 错误的修复方法是在步骤 2 中分配文件的长度加一。

Answer 7

我刚刚有过类似的经历。这是我的具体问题及其原因：

// Makes the first character of a word capital, and the rest small
// (Must be compiled with -std=c99)
void FixCap( char *word )
{
  *word = toupper( *word );
  for( int i=1 ; *(word+i) != '\n' ; ++i )
    *(word+i) = tolower( *(word+i) );
}

问题出在循环条件上 - 我使用“\n”而不是空字符“\0”。现在，我不知道 printf 是如何工作的，但从这次经验来看，我猜测它在我的变量之后使用一些内存位置作为临时/工作空间。如果 printf 语句导致在存储我的单词之后的某个位置写入“\n”字符，则 FixCap 函数将能够在某个时刻停止。如果我删除 printf，那么它会继续循环，寻找 '\n' 但永远找不到它，直到出现段错误。

所以最后，我的问题的根本原因是有时我在表示“\0”时输入“\n”。这是我以前犯过的错误，而且很可能还会再犯。但现在我知道要寻找它。

Answer 8

好吧，也许你可以教他如何使用 gdb 或其他调试程序？
告诉他，如果 bug 仅仅由于“printf”而消失，那么它并没有真正消失，并且可能会在稍后再次出现。错误应该被修复，而不是被忽略。

Answer 9

当删除 printf 行时，这将为您提供除以 0 的结果：

int a=10;
int b=0;
float c = 0.0;

int CalculateB()
{
  b=2;
  return b;
}
float CalculateC()
{
  return a*1.0/b;
}
void Process()
{
  printf("%d", CalculateB()); // without this, b remains 0
  c = CalculateC();
}

Answer 10

调试情况会怎样？在调用 exec() 之前打印一个 char *[] 数组，只是为了看看它是如何标记化的 - 我认为这是 printf()< 的一个非常有效的用途/代码>。

然而，如果输入到 printf() 的格式具有足够的成本和复杂性，它实际上可能会改变程序执行（主要是速度），那么调试器可能是更好的选择。不过，调试器和分析器也是有代价的。任何一个都可能会揭露在他们缺席的情况下可能不会出现的种族。

这一切都取决于您正在编写的内容以及您正在追踪的错误。可用的工具包括调试器、printf()（也将记录器分组到 printf 中）断言和分析器。

刀片螺丝刀比其他类型的螺丝刀好吗？取决于你需要什么。请注意，我并不是说断言是好还是坏。它们只是另一个工具。

Answer 11

解决这个问题的一种方法是建立一个宏系统，这样可以轻松关闭 printfs，而无需在代码中删除它们。我使用这样的东西：

#define LOGMESSAGE(LEVEL, ...) logging_messagef(LEVEL, __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__);

/* Generally speaking, user code should only use these macros.  They
 * are pithy. You can use them like a printf:
 *
 *    DBGMESSAGE("%f%% chance of fnords for the next %d days.", fnordProb, days);
 *
 * You don't need to put newlines in them; the logging functions will
 * do that when appropriate.
 */
#define FATALMESSAGE(...) LOGMESSAGE(LOG_FATAL, __VA_ARGS__);
#define EMERGMESSAGE(...) LOGMESSAGE(LOG_EMERG, __VA_ARGS__);
#define ALERTMESSAGE(...) LOGMESSAGE(LOG_ALERT, __VA_ARGS__);
#define CRITMESSAGE(...) LOGMESSAGE(LOG_CRIT, __VA_ARGS__);
#define ERRMESSAGE(...) LOGMESSAGE(LOG_ERR, __VA_ARGS__);
#define WARNMESSAGE(...) LOGMESSAGE(LOG_WARNING, __VA_ARGS__);
#define NOTICEMESSAGE(...) LOGMESSAGE(LOG_NOTICE, __VA_ARGS__);
#define INFOMESSAGE(...) LOGMESSAGE(LOG_INFO, __VA_ARGS__);
#define DBGMESSAGE(...) LOGMESSAGE(LOG_DEBUG, __VA_ARGS__);
#if defined(PAINFULLY_VERBOSE)
#   define PV_DBGMESSAGE(...) LOGMESSAGE(LOG_DEBUG, __VA_ARGS__);
#else
#   define PV_DBGMESSAGE(...) ((void)0);
#endif

logging_messagef() 是一个在单独的 .c 文件中定义的函数。根据消息的目的，在代码中使用 XMESSAGE(...) 宏。此设置最好的一点是它可以同时用于调试和日志记录，并且可以更改 logging_messagef() 函数来执行多种不同的操作（printf 到 stderr、到日志文件、使用 syslog 或其他一些系统日志记录工具等），并且当您不需要时，可以在 logging_messagef() 中忽略低于特定级别的消息。 PV_DBGMESSAGE() 用于那些您肯定希望在生产中关闭的大量调试消息。