blazesym

Crates.ioblazesym
lib.rsblazesym
version0.2.0-alpha.12
sourcesrc
created_at2022-07-12 05:21:54.552648
updated_at2024-05-06 20:29:08.314387
descriptionblazesym is a library for address symbolization and related tasks.
homepage
repositoryhttps://github.com/libbpf/blazesym
max_upload_size
id624169
size1,182,785
(danielocfb)

documentation

README

pipeline coverage crates.io Docs rustc

blazesym

blazesym is a library that can be used to symbolize addresses. Address symbolization is a common problem in tracing contexts, for example, where users want to reason about functions by name, but low level components report only the "raw" addresses (e.g., in the form of stacktraces).

In addition to symbolization, blazesym also provides APIs for the reverse operation: looking up addresses from symbol names. That can be useful, for example, for configuring breakpoints or tracepoints.

The library aims to provide a "batteries-included" experience. That is to say, it tries to do the expected thing by default. When offering such convenience comes at the cost of performance, we aim to provide advanced APIs that allow for runtime configuration of the corresponding features.

blazesym supports a variety of formats, such as DWARF, ELF, Breakpad, and Gsym (see below for an up-to-date list).

The library is written in Rust and provides a first class C API. This crate adheres to Cargo's semantic versioning rules. At a minimum, it builds with the most recent Rust stable release minus five minor versions ("N - 5"). E.g., assuming the most recent Rust stable is 1.68, the crate is guaranteed to build with 1.63 and higher.

Status

blazesym is at the core of Meta's internal continuous profiling solution, where it handles billions of symbolization requests per day.

The library is being actively worked on, with a major goal being stabilization of the API surface. Feel free to contribute with discussions, feature suggestions, or code contributions!

As alluded to above, the library provides support for a variety of formats. For symbolization specifically, the following table lays out what features each format supports and whether blazesym can currently use this feature:

Format Feature Supported by format? Supported by blazesym?
Breakpad symbol size :heavy_check_mark: :heavy_check_mark:
source code location information :heavy_check_mark: :heavy_check_mark:
inlined function information :heavy_check_mark: :heavy_check_mark:
ELF symbol size :heavy_check_mark: :heavy_check_mark:
source code location information :heavy_multiplication_x: :heavy_multiplication_x:
inlined function information :heavy_multiplication_x: :heavy_multiplication_x:
DWARF symbol size :heavy_check_mark: :heavy_check_mark:
source code location information :heavy_check_mark: :heavy_check_mark:
inlined function information :heavy_check_mark: :heavy_check_mark:
Gsym symbol size :heavy_check_mark: :heavy_check_mark:
source code location information :heavy_check_mark: :heavy_check_mark:
inlined function information :heavy_check_mark: :heavy_check_mark:
Ksym symbol size :heavy_multiplication_x: :heavy_multiplication_x:
source code location information :heavy_multiplication_x: :heavy_multiplication_x:
inlined function information :heavy_multiplication_x: :heavy_multiplication_x:

Here is rough roadmap of currently planned features (in no particular order):

OS Support

The library's primary target operating system is Linux (it should work on all semi-recent kernel versions and distributions). MacOS is not actively supported at this point (though it may work), but we would be happy to incorporate pull requests to fix any potential short comings.

Build & Use

blazesym requires a standard Rust toolchain and can be built using the Cargo project manager (e.g., cargo build).

Rust

Consumption from a Rust project should happen via Cargo.toml:

[dependencies]
blazesym = "=0.2.0-alpha.12"

For a quick set of examples please refer to the examples/ folder. Please refer to the documentation for a comprehensive explanation of individual types and functions.

C

The companion crate blazesym-c provides the means for interfacing with the library from C. Please refer to its README for usage details.

Command-line

The library also comes with a command line interface for quick experimentation and debugging. You can run it directly from the repository, e.g.:

cargo run -p blazecli -- symbolize elf --path /lib64/libc.so.6 00000000000caee1

Please refer to its README as well as the help text for additional information and usage instructions.

Statically linked binaries for various target triples are available on-demand here.

Commit count: 1158

cargo fmt