Crate backtrace

source ·
Expand description

A library for acquiring a backtrace at runtime

This library is meant to supplement the RUST_BACKTRACE=1 support of the standard library by allowing an acquisition of a backtrace at runtime programmatically. The backtraces generated by this library do not need to be parsed, for example, and expose the functionality of multiple backend implementations.

Implementation

This library makes use of a number of strategies for actually acquiring a backtrace. For example unix uses libgcc’s libunwind bindings by default to acquire a backtrace, but coresymbolication or dladdr is used on OSX to acquire symbol names while linux uses gcc’s libbacktrace.

When using the default feature set of this library the “most reasonable” set of defaults is chosen for the current platform, but the features activated can also be controlled at a finer granularity.

API Principles

This library attempts to be as flexible as possible to accommodate different backend implementations of acquiring a backtrace. Consequently the currently exported functions are closure-based as opposed to the likely expected iterator-based versions. This is done due to limitations of the underlying APIs used from the system.

Usage

First, add this to your Cargo.toml

[dependencies]
backtrace = "0.3"

Next:

extern crate backtrace;

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
    });
}

Structs

Representation of an owned and self-contained backtrace.
A formatter for backtraces.
Captured version of a frame in a backtrace.
A formatter for just one frame of a backtrace.
Captured version of a symbol in a backtrace.
A trait representing one frame of a backtrace, yielded to the trace function of this crate.
A trait representing the resolution of a symbol in a file.
A wrapper around a symbol name to provide ergonomic accessors to the demangled name, the raw bytes, the raw string, etc.

Enums

A platform independent representation of a string. When working with std enabled it is recommended to the convenience methods for providing conversions to std types.
The styles of printing that we can print

Functions

Attempt to reclaim that cached memory used to symbolicate addresses.
Resolve an address to a symbol, passing the symbol to the specified closure.
Resolve a previously capture frame to a symbol, passing the symbol to the specified closure.
Same as resolve_frame, only unsafe as it’s unsynchronized.
Same as resolve, only unsafe as it’s unsynchronized.
Inspects the current call-stack, passing all active frames into the closure provided to calculate a stack trace.
Same as trace, only unsafe as it’s unsynchronized.