CHANGELOG.md

Unreleased

• Added support for relocatable ELF and DWARF
• Added support for kernel module symbolization with DWARF data
• Bumped minimum supported Rust version to 1.88

0.2.3

• Added support for /usr/lib/debug/.build-id debug link target directory
• Added support for compressed .gnu_debugdata ELF sections (MiniDebugInfo)

0.2.2

• Improved data caching for debug link targets and DWP files
• Improved kernel symbolization performance when no KASLR offset is provided by the user
• Fixed backtrace reporting on contextualized errors
• Added bindings for Go language

0.2.1

• Adjusted symbolize::Symbolizer::symbolize behavior to stop being short-circuiting
  • Added Reason::IgnoredError variant
• Fixed reporting of code info directory for DWARF symbolization if not explicitly overwritten by source file

0.2.0

• Adjusted symbolize::{Resolved,}Sym::code_info to be heap allocated
• Made symbolize::ResolvedSym non-exhaustive
• Report special module string when symbolizing vDSO and BPF symbols

0.2.0-rc.5

• Added support for discovering and using DWARF packages (*.dwp)
• Added Symbolizer::register_elf_resolver method
• Adjusted ELF logic to include STT_NOTYPE symbols in symbolization

0.2.0-rc.4

• Added support for symbolizing addresses in a vDSO
  • Added vdso attribute to symbolize::Process type
• Added support for normalizing addresses in a vDSO
  • Added normalize::UserMeta::Sym variant
• Adjusted debug link resolution to handle self-referential debug links more gracefully
• Report "symbolic" path in symbolize::Sym::module when using process symbolization on APKs with map_files set to true
• Improved handling of symbolic links to prevent duplicate work for same symbol source reached through different links
• Fixed reading of compressed ELF section data with unaligned compression headers
• Adjusted symbol names reported for BPF programs to contain bpf_prog_ prefix and program tag
• Made inspect::SymInfo type non-exhaustive
• Merged normalize::Reason and symbolize::Reason
• Changed CodeInfo::to_owned to into_owned
• Bumped minimum supported Rust version to 1.75

0.2.0-rc.3

• Added support for 32 bit ELF binaries
• Added symbolize::Symbolizer::cache method for caching process VMA as well as ELF metadata
• Added normalize::NormalizeOpts::apk_to_elf attribute for normalizing addresses mapping to APKs to the contained ELF file
• Added symbolize::Sym::module attribute
• Renamed symbolize::Source::kernel_image to vmlinux
• Renamed inspect::SymInfo::obj_file_name to module
• Adjusted kernel symbolization logic to give preference to vmlinux file, if present
• Changed symbolize::Kernel::{kallsyms,kernel_image} to support disabling of the source
• Adjusted vmlinux based kernel address symbolization logic to take into account system KASLR state
  • Added kaslr_offset member to symbolize::Kernel
• Moved symbolization and inspection sources into source sub-module
• Moved normalize::Apk behind existing apk feature
• Changed inspect::SymInfo::size to be an Option
• Fixed unsoundness in internally used InsertMap type
• Bumped minimum supported Rust version to 1.70

0.2.0-rc.2

• Added support for symbolizing BPF kernel program addresses including source code information
  • Added bpf (default disabled) feature
• Added Mac OS to list of supported operating systems for file based symbolization
• Added support for iteration over DWARF symbols to inspect::Inspector
• Adjusted normalization logic to use "symbolic path" for reading build IDs when normalizing with NormalizeOpts::map_files equal to false
• Adjusted inspect::Inspector::for_each to accept callback returning std::ops::ControlFlow to facilitate early termination
• Improved kallsyms parsing performance to speed up overall kernel address symbolization
• Fixed incorrect file offset to virtual offset translation, resulting in wrong symbolization in certain binaries
• Bumped minimum supported Rust version to 1.69

0.2.0-rc.1

• Added support for using PROCMAP_QUERY ioctl during address normalization
  • Added enable_procmap_query to normalize::Normalizer
  • Added is_procmap_query_supported function to helper module
• Adjusted normalization logic to not fail overall operation on build ID read failure
• Added support for file based symbolization on the Windows operating system
• Improved performance for parsing Breakpad files
• Made sure to not emit "self" component in normalized paths when map_files is in use
• Fixed potentially invalid reading of debug link checksum when .gnu_debuglink section is unaligned
• Renamed enable_maps_caching method of normalize::Normalizer to enable_vma_caching
• Renamed UserMeta::{apk,elf,unknown} methods by prefixing them with as_

0.2.0-rc.0

• Added support for transparently following debug links in ELF binaries
  • Added symbolize::Builder::set_debug_dirs for configuring directories searched for targets
• Introduced normalize::NormalizeOpts type for configurable address normalization
  • Removed normalize::Normalizer::normalize_user_addrs_sorted in favor of normalize::Normalizer::normalize_user_addrs_opts
• Fixed handling of zero sized symbols in Gsym symbolization logic
• Fixed reading of ELF section contents of sections without actual data

0.2.0-alpha.12

• Added support for advanced symbolization workflows involving containers (process or APKs) via configurable dispatch functions
• Added cache_maps and cache_build_ids properties to normalize::Normalizer type
  • Adjusted normalization logic to return references to cached build IDs if cache_build_ids is true
• Added support for compressed debug information
  • Added zlib (default enabled) and zstd (default disabled) features
• Adjusted Inspector::for_each signature to no longer carry explicit state around
• Introduced normalize::Reason enum to provide best guess at why normalization was not successful as part of the normalize::UserMeta::Unknown variant
• Added From<Box<dyn std::error::Error>> conversion to Error
• Added Display impl to ErrorKind
• Added read_elf_build_id_from_mmap function to helper module
• Reduced number of allocations performed on address normalization and process symbolization paths
• Improved symbolization performance on certain unoptimized DWARF data
• Fixed potential numeric overflow when parsing non-UTF-8 (invalid) Breakpad files
• Removed Clone impl of symbolize::Builder type

0.2.0-alpha.11

• Added support for Breakpad format behind breakpad feature (disabled by default)
• Added support for usage of perf map files as part of process symbolization
  • Added perf_map attribute to symbolize::Process type
• Added map_files attribute to symbolize::Process type
• Added support for symbolizing addresses mapping to ELF variables and for looking them up using inspect APIs
• Added support for GNU indirect functions to ELF logic
• Overhauled SymType enum
  • Made it non-exhaustive
  • Moved it out of inspect module
  • Renamed Unknown variant to Undefined
• Made auto reloading of symbolization sources on change configurable
• Fixed DWARF symbolization in the presence of cross compilation unit references

0.2.0-alpha.10

• Introduced symbolize::Reason enum to provide best guess at why symbolization was not successful as part of the symbolize::Symbolized::Unknown variant
• Introduced apk and gsym compile-time features (disabled by default)
• Improved handling of dynamic ELF symbols for symbolization and inspection
• Fixed Gsym symbolization issue for "large" addresses
• Reordered pid argument to normalization functions before addresses
• Reordered src argument to inspection functions before names

0.2.0-alpha.9

• Added caching logic for Gsym resolvers to symbolize::Symbolizer
• Adjusted various symbolization related types to contain Cow objects to facilitate hand out of memory mapped data without unnecessary allocations
  • Adjusted various symbolization code paths to stop heap-allocating
• Adjusted normalization logic to honor executable and readable proc maps entries
• Changed debug_syms to be a symbolization source property instead of a symbolize::Symbolizer attribute
• Renamed inspect::Elf::debug_info to debug_syms
• Handled potential numeric overflow in Gsym inlined function parser more gracefully
• Moved C API definitions into blazesym-c crate
• Fixed build for some Android flavors

0.2.0-alpha.8

• Fixed build failure when dwarf feature is not enabled
• Changed Addr to map to 64 bit integer
• Reworked normalization APIs to produce file offsets instead of virtual offsets
• Introduced symbolize::Input enum and made it part of symbolization APIs to distinguish between and support different input types
  • Added support for ELF symbolization using file offsets instead of addresses
• Added symbolize::Source::Apk variant
• Made symbolization source caching unconditional and removed least-recently-used semantics in favor of full user control
• Added caching for APK related symbolization data structures
• Added caching logic to inspect::Inspector
• Adjusted inspect::SymInfo type to optionally just reference cached data as opposed to having to heap-allocate copies of it
• Added support for iterating over all symbols in a source to inspect::Inspector
• Made inspect::SymInfo::file_offset member optional
• Added ability to contain backtraces in Error objects
• Added support for symbolizing Gsym addresses to blazecli
• Fixed bogus inlined function reporting for Gsym
• Bumped minimum supported Rust version to 1.65

0.2.0-alpha.7

• "Flattened" return type of symbolize::Symbolizer::symbolize method from nested Vec to a single level Vec of newly introduced symbolize::Symbolized enum
• Further changes to symbolize::Sym:
  • Added size member and to_path helper method
  • Factored out CodeInfo type capturing all source code location information
  • Included optional inlined function information via inlined attribute
• Added support for reporting inlined functions for DWARF and Gsym formats
• Introduced symbolize::Symbolizer::symbolize_single for more convenient symbolization of a single address
• Introduced normalize::Builder type for customization of a normalize::Normalizer instance and made reading of build IDs configurable
• Adjusted ELF symbolization code to honor symbol sizes
• Renamed symbolize::Builder::enable_src_location to enable_code_info
• Bumped minimum supported Rust version to 1.64

0.2.0-alpha.6

• Fixed potential panic when normalizing an APK ELF file using the C APIs

0.2.0-alpha.5

• Fixed potentially incorrect reporting of symbols from ELF source

0.2.0-alpha.4

• Added support for automatic demangling of symbols, controlled by demangle feature (at compile time) and corresponding flag in symbolize::Builder (at runtime)
• Renamed symbolize::SymbolizedResult to Sym and reworked it
  • Made it non-exhaustive
  • Renamed symbol member to name
  • Added offset member
  • Changed line member to be of type u32 and column to u16
  • Made all source code location information optional
  • Split path member into dir and file
• Added additional end-to-end benchmarks
  • Added benchmark result summary to CI runs
• Fixed spurious maps file path creation for low addresses as part of normalization/symbolization
• Improved symbolization of addresses in ELF files with potentially bogus symbol sizes
• Introduced blazecli command line interface for the library
• Introduced helper module exposing read_elf_build_id function

0.2.0-alpha.3

• Introduced custom Error type instead of relying solely on std::io::Error
• Switched to using gimli for DWARF support
  • Added support for DWARF versions v2, v3, and v5 for symbol lookup and source code information retrieval
  • Introduced dwarf feature to make dependency optional
• Switched from log to using tracing as the logging backend
  • Added spans to a couple of relevant call sites
• Added support for using DWARF information for symbol lookup (instead of just ELF symbols; so far DWARF was only used for mapping names to symbol information)
• Added support for normalizing and symbolizing addresses in an ELF file contained in an APK
• Adjusted symbolize::Source::Gsym variant to support symbolizing Gsym from user provided "raw" data
• Renamed normalize::UserAddrMeta::Binary variant to Elf
• Renamed blaze_user_addr_meta_unknown::__unused member to _unused

0.2.0-alpha.2

• Added extern "C" guards in blazesym.h header for easy of use from C++ code
• Added unused member variable to blaze_user_addr_meta_unknown type for compliance with C standard, stating undefined behavior for empty structs
• Changed blaze_inspect_elf_src::path type to *const _
• Fixed incorrect NULL checks when working with blaze_symbolize_src_kernel objects
• Switched away from using Git LFS for large benchmark files towards on-demand downloading from a different repository, controlled by generate-bench-files feature

0.2.0-alpha.1

• Removed no longer necessary base_address member from various types
• Renamed SymInfo::address member to addr
• Fixed incorrect allocation size calculation in C API
• Fixed file offset lookup potentially reporting subtly wrong offsets on certain ELF file segment constellations

0.2.0-alpha.0

• Initial documented release