C++ `__builtin_trap()` / `__debugbreak()`：手动触发程序中断以调试

哈喽，各位好！今天咱们聊聊C++里两个挺有意思的小家伙：__builtin_trap() 和 __debugbreak()。它们就像程序里的“紧急停止”按钮，或者更像那种“你瞅啥？”的眼神，能立马把程序的注意力拉到你这边来，方便你进行调试。

1. 啥是__builtin_trap() 和 __debugbreak()？

简单来说，这两个东西的作用就是：让程序崩溃，但是以一种可控的方式崩溃。听起来有点矛盾？别急，往下看。

__builtin_trap(): 这是一个GCC和Clang提供的内建函数。它的作用是直接触发一个陷阱指令。陷阱指令是啥？你可以把它想象成一个预先设定好的“坑”，程序走到这里就会掉进去，然后操作系统会接管，告诉你：“哎呀，出问题了！”。具体的表现形式通常是程序崩溃，并产生一个信号（比如SIGTRAP）。
__debugbreak(): 这个东西在不同的编译器和平台上实现方式略有不同，但效果类似。在Visual Studio和Windows上，它通常会被编译成一个int 3指令。这个指令的作用也类似，会触发一个中断，将控制权交给调试器（如果正在运行调试器），或者交给操作系统。

2. 为什么要用它们？

你可能会问：“我直接写个assert(false)或者除以0不也能让程序崩溃吗？为啥要用这么高级的玩意儿？” 问得好！ __builtin_trap() 和 __debugbreak()的优势在于：

可预测性： 它们的作用非常明确，就是触发中断。而assert只有在条件为假时才会触发，除以0的行为则可能因编译器优化而变得不可预测。
调试友好性： 当程序因为__builtin_trap() 或 __debugbreak()崩溃时，调试器会直接停在你放置这些语句的地方，让你立刻知道哪里出了问题。这比大海捞针式地排查崩溃原因要高效得多。
不依赖宏定义： assert通常会受到NDEBUG宏的影响，在release版本中会被禁用。而__builtin_trap() 和 __debugbreak() 始终有效，即使在release版本中也能触发中断。这在某些情况下非常有用，比如你想在release版本中捕获一些严重的错误。

3. 怎么用它们？

用法非常简单粗暴，就像在代码里放一颗地雷：

#include <iostream>

int main() {
  int x = 5;

  if (x > 0) {
    std::cout << "x is positive" << std::endl;
  } else {
    std::cout << "x is not positive" << std::endl;
    __builtin_trap(); // 假设这里不应该被执行到，如果执行到就触发中断
  }

  std::cout << "Program continues..." << std::endl;
  return 0;
}

或者使用__debugbreak():

#include <iostream>

int main() {
  int x = -1;

  if (x > 0) {
    std::cout << "x is positive" << std::endl;
  } else {
    std::cout << "x is not positive" << std::endl;
    __debugbreak(); // 假设这里不应该被执行到，如果执行到就触发中断
  }

  std::cout << "Program continues..." << std::endl;
  return 0;
}

如果你在调试器中运行上面的代码，程序会在__builtin_trap() 或 __debugbreak() 那一行停下来，你可以检查变量的值，单步执行，等等。如果没有运行调试器，程序会崩溃，并显示一个错误信息。

4. 使用场景举例

处理不可能发生的情况： 在某些情况下，你可能知道某个条件永远不应该为真。这时，你可以用__builtin_trap() 或 __debugbreak() 来确保这种情况真的不会发生。这就像在代码里埋下一颗“防呆雷”，一旦出现意外，程序就会立刻“爆炸”，提醒你出错了。
```
enum class State {
  IDLE,
  RUNNING,
  FINISHED
};

void processState(State state) {
  switch (state) {
    case State::IDLE:
      // ...
      break;
    case State::RUNNING:
      // ...
      break;
    case State::FINISHED:
      // ...
      break;
    default:
      __builtin_trap(); // 不应该进入default分支
  }
}
```

检查函数返回值： 如果某个函数应该总是返回特定的值，你可以用__builtin_trap() 或 __debugbreak() 来检查返回值是否符合预期。

int calculateSomething(int x) {
  // ...
  return result;
}

int main() {
  int result = calculateSomething(10);
  if (result < 0) {
    __debugbreak(); // 假设result不应该小于0
  }
  // ...
}

在release版本中捕获严重错误： assert在release版本中会被禁用，但__builtin_trap() 和 __debugbreak() 始终有效。你可以用它们来捕获一些严重的错误，即使在release版本中也能及时发现问题。当然，在release版本中使用时要谨慎，因为这会导致程序崩溃。可以考虑结合条件编译，只在特定的情况下触发中断。
```
#ifdef DEBUG_TRAP_ON_ERROR
#define TRAP_ON_ERROR __builtin_trap()
#else
#define TRAP_ON_ERROR
#endif

int main() {
  int* ptr = nullptr;
  if (ptr == nullptr) {
    TRAP_ON_ERROR; // 在定义了DEBUG_TRAP_ON_ERROR时，触发中断
  }
  // ...
}
```
测试未完成的代码： 当你正在开发一个新功能，但还没有完成时，可以用__builtin_trap() 或 __debugbreak() 暂时阻止程序执行到未完成的代码，避免出现意外错误。
```
void newFeature() {
  // ... 未完成的代码 ...
  __debugbreak(); // 提醒自己这里还没有完成
}
```
在复杂逻辑中定位问题： 在复杂的代码逻辑中，如果程序行为不符合预期，可以用__builtin_trap() 或 __debugbreak() 在不同的地方设置断点，逐步缩小问题范围。这比单步执行整个程序要高效得多。

5. __builtin_trap() vs __debugbreak()：区别和选择

虽然它们的作用类似，但还是有一些区别：

特性	`__builtin_trap()`	`__debugbreak()`
标准化	GCC和Clang的内建函数，相对更标准化	实现方式和行为可能因编译器和平台而异
可移植性	理论上更好，只要编译器支持`__builtin_trap()`就能用	略差，需要考虑不同平台和编译器的兼容性
调试器行为	通常会触发一个信号（比如`SIGTRAP`），调试器会捕获这个信号并停止程序	在Visual Studio和Windows上，通常会被编译成`int 3`指令，调试器会直接停在这一行
Release版本行为	始终有效，即使在release版本中也会触发中断	始终有效，即使在release版本中也会触发中断
适用场景	更适合需要明确触发陷阱指令，并且对可移植性有较高要求的场景	更适合在特定平台（比如Windows）上使用，或者需要利用`int 3`指令的特定行为的场景

如何选择？

如果你需要更高的可移植性，并且不依赖于特定的调试器行为，可以选择__builtin_trap()。
如果你在Windows平台上开发，并且使用Visual Studio，__debugbreak()可能更方便，因为它可以直接让调试器停在断点处。
如果你的代码需要在不同的编译器和平台上编译，可以考虑使用条件编译，根据不同的平台选择不同的方法。

#ifdef _WIN32
  #define DEBUG_BREAK __debugbreak()
#else
  #define DEBUG_BREAK __builtin_trap()
#endif

int main() {
  // ...
  DEBUG_BREAK; // 在Windows上使用__debugbreak()，在其他平台上使用__builtin_trap()
  // ...
}

6. 高级用法：结合信号处理

你可以结合信号处理函数，在__builtin_trap()触发中断时执行一些自定义的操作。例如，你可以记录一些调试信息，或者尝试从错误中恢复。

#include <iostream>
#include <signal.h>
#include <stdlib.h> // exit

void signalHandler(int signum) {
  std::cout << "Interrupt signal (" << signum << ") received.n";

  // 清理资源，记录日志，等等...

  exit(signum);
}

int main() {
  // 注册信号处理函数
  signal(SIGTRAP, signalHandler);

  int x = -1;
  if (x < 0) {
    std::cout << "x is negative, trapping!n";
    __builtin_trap(); // 触发SIGTRAP信号
  }

  std::cout << "This line will probably not be executed.n";
  return 0;
}

在这个例子中，当__builtin_trap()被调用时，程序会触发一个SIGTRAP信号。操作系统会调用我们注册的signalHandler函数来处理这个信号。在signalHandler函数中，我们可以执行一些清理工作，记录日志，或者尝试从错误中恢复。最后，我们调用exit函数来终止程序。

7. 注意事项

不要滥用： __builtin_trap() 和 __debugbreak() 应该只用于调试和错误处理，不要在生产代码中留下它们。否则，你的程序可能会在用户不知情的情况下崩溃。
注意性能： 虽然__builtin_trap() 和 __debugbreak() 的开销很小，但在某些对性能要求极高的场景下，仍然需要谨慎使用。
结合条件编译： 为了避免在release版本中触发中断，可以结合条件编译，只在debug版本中启用__builtin_trap() 和 __debugbreak()。
理解平台差异： __debugbreak() 的行为可能因平台而异，需要仔细阅读相关文档，确保其行为符合预期。
考虑替代方案： 在某些情况下，assert、日志记录或其他调试工具可能更适合。选择最合适的工具取决于具体的需求。

8. 总结

__builtin_trap() 和 __debugbreak() 是C++中非常有用的调试工具。它们可以帮助你快速定位和解决问题，提高开发效率。但要注意，它们也需要谨慎使用，避免在生产代码中留下隐患。

希望今天的讲解对你有所帮助！记住，编程就像侦探破案，需要耐心、细致，以及一些“非常规”的手段。 __builtin_trap() 和 __debugbreak() 就是你手中的“非常规”武器，好好利用它们吧！

发表回复 取消回复

发表回复取消回复