#backtrace #stack-trace #run-time #frame #fork #com #tree

no-std pprof-backtrace

A library to acquire a stack trace (backtrace) at runtime in a Rust program. Fork from https://github.com/rust-lang/backtrace-rs/tree/0.3.61.

2 releases

0.3.63 Dec 9, 2022
0.3.62 Dec 9, 2022
0.3.61 Dec 9, 2022

#825 in Debugging

MIT/Apache

225KB
4.5K SLoC

pprof-backtrace

Documentation

A library for acquiring backtraces at runtime for Rust. This library aims to enhance the support of the standard library by providing a programmatic interface to work with, but it also supports simply easily printing the current backtrace like libstd's panics. Fork from https://github.com/rust-lang/backtrace-rs/tree/0.3.61.

Install

[dependencies]
pprof-backtrace = "0.3"

Usage

To simply capture a backtrace and defer dealing with it until a later time, you can use the top-level Backtrace type.

use backtrace::Backtrace;

fn main() {
    let bt = Backtrace::new();

    // do_some_work();

    println!("{:?}", bt);
}

If, however, you'd like more raw access to the actual tracing functionality, you can use the trace and resolve functions directly.

fn main() {
    backtrace::trace(|frame| {
        let ip = frame.ip();
        let symbol_address = frame.symbol_address();

        // Resolve this instruction pointer to a symbol name
        backtrace::resolve_frame(frame, |symbol| {
            if let Some(name) = symbol.name() {
                // ...
            }
            if let Some(filename) = symbol.filename() {
                // ...
            }
        });

        true // keep going to the next frame
    });
}

License

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in backtrace-rs by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~5MB
~96K SLoC