Crate blazesym_c

C API bindings for the library.

Compatibility

The library aims to provide forward compatibility with newer versions and backward compatibility with older ones. To make that happen, relevant types that are being passed to the library contain the type_size member that is to be set to the type’s size. The BLAZE_INPUT macro can be used for convenient initialization:

#include <string.h>
#include "blazesym.h"

int main(int argc, const char* argv[]) {
  BLAZE_INPUT(blaze_inspect_elf_src, src,
    .path = "/tmp/some/dir/test.bin",
    .debug_syms = true,
  );
}

Structs

• blaze_inspect_elf_src
  An object representing an ELF inspection source.
• blaze_normalized_output
  A file offset or non-normalized address along with an index into the associated blaze_user_meta array (such as blaze_normalized_user_output::metas).
• blaze_normalized_user_output
  An object representing normalized user addresses.
• blaze_normalizer_opts
  Options for configuring blaze_normalizer objects.
• blaze_result
  blaze_result is the result of symbolization for C API.
• blaze_sym
  The result of symbolization of an address.
• blaze_sym_info
  Information about a looked up symbol.
• blaze_symbolize_code_info
  Source code location information for a symbol or inlined function.
• blaze_symbolize_inlined_fn
  Data about an inlined function call.
• blaze_symbolize_src_elf
  The parameters to load symbols and debug information from an ELF.
• blaze_symbolize_src_gsym_data
  The parameters to load symbols and debug information from “raw” Gsym data.
• blaze_symbolize_src_gsym_file
  The parameters to load symbols and debug information from a Gsym file.
• blaze_symbolize_src_kernel
  The parameters to load symbols and debug information from a kernel.
• blaze_symbolize_src_process
  The parameters to load symbols and debug information from a process.
• blaze_symbolizer_opts
  Options for configuring blaze_symbolizer objects.
• blaze_user_meta
  C ABI compatible version of UserMeta.
• blaze_user_meta_apk
  C compatible version of Apk.
• blaze_user_meta_elf
  C compatible version of Elf.
• blaze_user_meta_unknown
  C compatible version of Unknown.

Enums

• blaze_sym_type
  The type of a symbol.
• blaze_user_meta_kind
  The valid variant kind in blaze_user_meta.

Functions

• blaze_inspect_syms_elf^⚠
  Lookup symbol information in an ELF file.
• blaze_inspect_syms_free^⚠
  Free an array returned by blaze_inspect_syms_elf.
• blaze_inspector_free^⚠
  Free a blazesym inspector.
• blaze_inspector_new
  Create an instance of a blazesym inspector.
• blaze_normalize_user_addrs^⚠
  Normalize a list of user space addresses.
• blaze_normalize_user_addrs_sorted^⚠
  Normalize a list of user space addresses.
• blaze_normalizer_free^⚠
  Free a blazesym normalizer.
• blaze_normalizer_new
  Create an instance of a blazesym normalizer.
• blaze_normalizer_new_opts^⚠
  Create an instance of a blazesym normalizer.
• blaze_result_free^⚠
  Free an array returned by any of the blaze_symbolize_* variants.
• blaze_symbolize_elf_virt_offsets^⚠
  Symbolize virtual offsets in an ELF file.
• blaze_symbolize_gsym_data_virt_offsets^⚠
  Symbolize virtual offsets using “raw” Gsym data.
• blaze_symbolize_gsym_file_virt_offsets^⚠
  Symbolize virtual offsets in a Gsym file.
• blaze_symbolize_kernel_abs_addrs^⚠
  Symbolize a list of kernel absolute addresses.
• blaze_symbolize_process_abs_addrs^⚠
  Symbolize a list of process absolute addresses.
• blaze_symbolizer_free^⚠
  Free an instance of blazesym a symbolizer for C API.
• blaze_symbolizer_new
  Create an instance of a symbolizer.
• blaze_symbolizer_new_opts^⚠
  Create an instance of a symbolizer with configurable options.
• blaze_user_output_free^⚠
  Free an object as returned by blaze_normalize_user_addrs or blaze_normalize_user_addrs_sorted.

Type Aliases

• blaze_inspector
  C ABI compatible version of blazesym::inspect::Inspector.
• blaze_normalizer
  C ABI compatible version of blazesym::normalize::Normalizer.
• blaze_symbolizer
  C ABI compatible version of blazesym::symbolize::Symbolizer.

Unions

• blaze_user_meta_variant
  The actual variant data in blaze_user_meta.