Rust嵌入式开发库esp-backtrace的使用：ESP32/ESP8266异常堆栈追踪与调试工具

esp-backtrace是一个为ESP32系列裸机开发提供的堆栈追踪库，支持ESP32、ESP32-C2/C3/C6、ESP32-H2、ESP32-P4和ESP32-S2/S3等芯片。

特性

使用说明

1. 当目标是RISC-V设备时，需要强制使用帧指针(即在.cargo/config.toml中添加"-C", "force-frame-pointers")，对于Xtensa则不需要。

2. 可以通过arch::backtrace()获取堆栈地址数组(目前限制为10个)，如果你想自己创建堆栈追踪(即不使用panic或异常处理程序)。

3. 当使用panic和/或异常处理程序时，确保包含use esp_backtrace as _;。

示例代码

// 在Cargo.toml中添加依赖
// esp-backtrace = "0.17.0"

use esp_backtrace as _; // 引入panic和异常处理程序

fn main() {
    // 强制触发一个panic
    panic!("This is a test panic");
    
    // 或者手动获取堆栈追踪
    // let backtrace = arch::backtrace();
    // println!("Backtrace: {:?}", backtrace);
}

完整示例代码

// Cargo.toml 依赖配置
/*
[dependencies]
esp-backtrace = { version = "0.17.0", features = ["panic-handler", "println"] }
*/

// main.rs
use esp_backtrace as _; // 引入panic处理程序

// 自定义函数用于演示堆栈追踪
fn cause_panic() {
    // 这里会触发panic
    panic!("Intentional panic for backtrace demonstration");
}

fn another_function() {
    // 调用会触发panic的函数
    cause_panic();
}

fn main() {
    // 打印初始化信息
    println!("Starting backtrace demo...");
    
    // 调用链: main -> another_function -> cause_panic -> panic!
    another_function();
    
    // 这行代码不会执行，因为前面已经panic了
    println!("This line won't be reached");
}

// 目标为RISC-V时的配置示例 (放在.cargo/config.toml中)
/*
[target.riscv32imc-unknown-none-elf]
rustflags = ["-C", "force-frame-pointers"]
*/

配置示例

在.cargo/config.toml中添加(针对RISC-V设备):

[target.riscv32imc-unknown-none-elf]
rustflags = ["-C", "force-frame-pointers"]

安装

在项目目录中运行以下Cargo命令:

cargo add esp-backtrace

或者在Cargo.toml中添加:

esp-backtrace = "0.17.0"

许可证

本库采用以下任一许可证:

• Apache License, Version 2.0
• MIT license

最低支持的Rust版本(MSRV)

本库保证在发布时的最新稳定Rust版本下编译通过。它可能能在旧版本下编译，但这可能在新的发布(包括补丁)中改变。