C++ `std::stacktrace` (C++23)：运行时获取堆栈跟踪信息

哈喽，各位好！今天咱们聊聊C++23的新玩具——std::stacktrace，这玩意儿能让你在程序运行时抓取堆栈信息，就像侦探在犯罪现场收集指纹一样，帮你定位bug的藏身之处。别担心，我尽量用大白话，保证你听得懂，看得会用。

一、啥是堆栈跟踪？

首先，得明白啥叫堆栈跟踪。想象一下，你的程序就像一个俄罗斯套娃，一个函数调用另一个函数，一层套一层。堆栈跟踪就是把这一层层的调用关系记录下来，告诉你程序是怎么走到当前这一步的。

举个例子，假设有这么一段代码：

#include <iostream>

void funcC() {
    int x = 10;
    int y = 0;
    int z = x / y; // 哎呀，除以零了！
}

void funcB() {
    funcC();
}

void funcA() {
    funcB();
}

int main() {
    funcA();
    return 0;
}

这段代码会因为除以零而崩溃。没有堆栈跟踪，你可能只能看到"除以零"的错误信息，但不知道是谁调用的funcC，又是谁调用的funcB，最后是谁调用的funcA。有了堆栈跟踪，你就能清晰地看到：

• main 调用了 funcA
• funcA 调用了 funcB
• funcB 调用了 funcC
• funcC 出了问题（除以零）

这就像侦探找到了关键线索，沿着线索就能找到罪魁祸首。

二、std::stacktrace登场

C++23之前，获取堆栈跟踪通常需要借助平台相关的API，比如Windows的StackWalk64或者Linux的backtrace。这些API用起来比较繁琐，而且跨平台性不好。std::stacktrace的出现就是为了解决这个问题，它提供了一个标准化的、跨平台的堆栈跟踪获取方式。

三、std::stacktrace的基本用法

std::stacktrace的使用非常简单。只需要包含头文件 <stacktrace>，然后调用 std::stacktrace::current() 就可以获取当前的堆栈跟踪信息。

#include <iostream>
#include <stacktrace>

void funcC() {
    std::cout << "Entering funcC" << std::endl;
    try {
        int x = 10;
        int y = 0;
        int z = x / y; // 哎呀，除以零了！
    } catch (const std::exception& e) {
        std::cerr << "Exception caught in funcC: " << e.what() << std::endl;
        std::cerr << "Stack trace:n" << std::stacktrace::current();
    }
    std::cout << "Exiting funcC" << std::endl;
}

void funcB() {
    std::cout << "Entering funcB" << std::endl;
    funcC();
    std::cout << "Exiting funcB" << std::endl;
}

void funcA() {
    std::cout << "Entering funcA" << std::endl;
    funcB();
    std::cout << "Exiting funcA" << std::endl;
}

int main() {
    std::cout << "Entering main" << std::endl;
    funcA();
    std::cout << "Exiting main" << std::endl;
    return 0;
}

运行这段代码，你会看到类似这样的输出：

Entering main
Entering funcA
Entering funcB
Entering funcC
Exception caught in funcC: Division by zero
Stack trace:
 0 [0x...] funcC() at /path/to/your/file.cpp:7
 1 [0x...] funcB() at /path/to/your/file.cpp:19
 2 [0x...] funcA() at /path/to/your/file.cpp:25
 3 [0x...] main() at /path/to/your/file.cpp:31

输出包含了每个函数调用的地址、函数名和源代码行号。这对于定位错误非常有帮助。

四、std::stacktrace的进阶用法

除了 std::stacktrace::current() 之外，std::stacktrace还提供了一些其他的有用的功能。

• std::stacktrace::size(): 返回堆栈跟踪的深度（有多少层调用）。
• std::stacktrace::max_size(): 返回堆栈跟踪的最大深度。这个值取决于你的编译器和操作系统。
• std::stacktrace::operator[]: 访问堆栈跟踪中的每一帧。每一帧都是一个 std::stacktrace_entry 对象。
• std::stacktrace_entry::source_file(): 返回源代码文件名。
• std::stacktrace_entry::source_line(): 返回源代码行号。
• std::stacktrace_entry::name(): 返回函数名。
• std::stacktrace_entry::address(): 返回函数地址。

下面是一个更详细的例子，展示了如何使用这些功能：

#include <iostream>
#include <stacktrace>

void funcC() {
    std::cout << "Entering funcC" << std::endl;
    try {
        int x = 10;
        int y = 0;
        int z = x / y; // 哎呀，除以零了！
    } catch (const std::exception& e) {
        std::cerr << "Exception caught in funcC: " << e.what() << std::endl;
        std::stacktrace st = std::stacktrace::current();
        std::cerr << "Stack trace (size = " << st.size() << ", max_size = " << st.max_size() << "):n";
        for (size_t i = 0; i < st.size(); ++i) {
            const auto& frame = st[i];
            std::cerr << "  " << i << ":n";
            std::cerr << "    Address: " << frame.address() << "n";
            std::cerr << "    Name: " << frame.name() << "n";
            std::cerr << "    Source file: " << frame.source_file() << "n";
            std::cerr << "    Source line: " << frame.source_line() << "n";
        }
    }
    std::cout << "Exiting funcC" << std::endl;
}

void funcB() {
    std::cout << "Entering funcB" << std::endl;
    funcC();
    std::cout << "Exiting funcB" << std::endl;
}

void funcA() {
    std::cout << "Entering funcA" << std::endl;
    funcB();
    std::cout << "Exiting funcA" << std::endl;
}

int main() {
    std::cout << "Entering main" << std::endl;
    funcA();
    std::cout << "Exiting main" << std::endl;
    return 0;
}

运行结果类似：

Entering main
Entering funcA
Entering funcB
Entering funcC
Exception caught in funcC: Division by zero
Stack trace (size = 4, max_size = 63):
  0:
    Address: 0x...
    Name: funcC()
    Source file: /path/to/your/file.cpp
    Source line: 8
  1:
    Address: 0x...
    Name: funcB()
    Source file: /path/to/your/file.cpp
    Source line: 26
  2:
    Address: 0x...
    Name: funcA()
    Source file: /path/to/your/file.cpp
    Source line: 32
  3:
    Address: 0x...
    Name: main()
    Source file: /path/to/your/file.cpp
    Source line: 38
Exiting funcC
Exiting funcB
Exiting funcA
Exiting main

五、std::stacktrace的注意事项

• 性能开销： 获取堆栈跟踪是有性能开销的。不要在性能敏感的代码中频繁使用 std::stacktrace::current()。最好只在发生错误或者需要调试的时候才使用。
• 编译器支持： std::stacktrace是C++23的新特性，需要编译器支持。目前主流的编译器（如GCC 13+, Clang 16+, MSVC 17.7+）都已经支持。
• 调试信息： 为了能够正确地获取函数名和源代码行号，你需要确保你的程序在编译时包含了调试信息。通常可以通过添加 -g 编译选项来实现（例如 g++ -g your_file.cpp -o your_program）。
• 内联函数： 内联函数可能会影响堆栈跟踪的结果。编译器可能会将内联函数展开到调用它的函数中，导致堆栈跟踪中缺少内联函数的调用信息。
• 优化级别： 较高的优化级别可能会导致编译器对代码进行重排或者删除，从而影响堆栈跟踪的结果。
• 链接时优化(LTO): 链接时优化也可能影响堆栈信息。

六、std::stacktrace在实际项目中的应用

std::stacktrace在实际项目中有很多应用场景。

• 错误报告： 在程序崩溃或者发生异常时，可以将堆栈跟踪信息包含在错误报告中，方便开发者定位问题。
• 日志记录： 在关键代码路径中，可以记录堆栈跟踪信息，用于分析程序的行为。
• 性能分析： 虽然 std::stacktrace 本身不适合用于高性能的性能分析，但是可以结合其他工具，例如 perf，来分析程序的性能瓶颈。
• 单元测试： 在单元测试中，可以使用 std::stacktrace 来验证函数的调用关系。

七、一个更复杂的例子：自定义异常处理

我们可以创建一个自定义的异常类，并在异常处理程序中包含堆栈跟踪信息。

#include <iostream>
#include <stacktrace>
#include <stdexcept>

class MyException : public std::runtime_error {
public:
    MyException(const std::string& message) : std::runtime_error(message), stacktrace_(std::stacktrace::current()) {}

    const std::stacktrace& get_stacktrace() const {
        return stacktrace_;
    }

private:
    std::stacktrace stacktrace_;
};

void funcC() {
    std::cout << "Entering funcC" << std::endl;
    try {
        int x = 10;
        int y = 0;
        if (y == 0) {
            throw MyException("Division by zero detected!");
        }
        int z = x / y; // 哎呀，除以零了！
    } catch (const MyException& e) {
        std::cerr << "MyException caught in funcC: " << e.what() << std::endl;
        std::cerr << "Stack trace:n" << e.get_stacktrace();
    }
    std::cout << "Exiting funcC" << std::endl;
}

void funcB() {
    std::cout << "Entering funcB" << std::endl;
    funcC();
    std::cout << "Exiting funcB" << std::endl;
}

void funcA() {
    std::cout << "Entering funcA" << std::endl;
    funcB();
    std::cout << "Exiting funcA" << std::endl;
}

int main() {
    std::cout << "Entering main" << std::endl;
    funcA();
    std::cout << "Exiting main" << std::endl;
    return 0;
}

在这个例子中，MyException 类保存了创建异常时的堆栈跟踪信息。在 catch 块中，我们可以通过 get_stacktrace() 方法获取堆栈跟踪信息并打印出来。

八、与现有工具的比较

在 std::stacktrace 出现之前，有很多工具可以用来获取堆栈跟踪信息，例如：

工具	优点	缺点
GDB/LLDB	功能强大，可以进行各种调试操作	需要手动启动调试器，不适合在生产环境中使用
backtrace (Linux)	简单易用	平台相关，需要处理符号解析
StackWalk64 (Windows)	平台相关	使用复杂，需要手动处理符号解析
Boost.Stacktrace	跨平台，提供了一些额外的功能	需要依赖 Boost 库
addr2line	可以将地址转换为函数名和源代码行号	需要手动调用，不方便集成到程序中
Google Breakpad	专门用于生成崩溃报告，支持多种平台	较为复杂，需要配置符号服务器

std::stacktrace 的优势在于它是 C++ 标准库的一部分，不需要依赖任何第三方库，并且提供了跨平台的解决方案。

九、总结

std::stacktrace 是 C++23 中一个非常有用的新特性，它可以帮助你更好地理解程序的运行状态，快速定位 bug。虽然它有一些性能开销，但是在错误报告、日志记录和单元测试等场景中，std::stacktrace 都能发挥重要的作用。掌握 std::stacktrace 的使用方法，可以提高你的开发效率，减少调试时间。

希望今天的讲解对你有所帮助！ 记住，调试是编程的乐趣之一，std::stacktrace 就是你的秘密武器，助你披荆斩棘，成为bug终结者！