libdatadog 10.0.0.1.0 → 12.0.0.1.0

data/vendor/libdatadog-12.0.0/x86_64-linux-musl/libdatadog-x86_64-alpine-linux-musl/include/datadog/blazesym.h

@@ -0,0 +1,1229 @@
+// BSD-3-Clause License
+// Synchronized from blazesym repository
+
+/*
+* Please refer to the documentation hosted at
+*
+*   https://docs.rs/blazesym-c/0.1.0-alpha.1
+*/
+
+#ifndef __blazesym_h_
+#define __blazesym_h_
+
+#include <stdarg.h>
+#include <stdbool.h>
+#include <stddef.h>
+#include <stdint.h>
+#include <stdlib.h>
+
+/**
+* An enum providing a rough classification of errors.
+*
+* C ABI compatible version of [`blazesym::ErrorKind`].
+*/
+typedef enum blaze_err {
+ /**
+  * The operation was successful.
+  */
+ BLAZE_ERR_OK = 0,
+ /**
+  * An entity was not found, often a file.
+  */
+ BLAZE_ERR_NOT_FOUND = -2,
+ /**
+  * The operation lacked the necessary privileges to complete.
+  */
+ BLAZE_ERR_PERMISSION_DENIED = -1,
+ /**
+  * An entity already exists, often a file.
+  */
+ BLAZE_ERR_ALREADY_EXISTS = -17,
+ /**
+  * The operation needs to block to complete, but the blocking
+  * operation was requested to not occur.
+  */
+ BLAZE_ERR_WOULD_BLOCK = -11,
+ /**
+  * Data not valid for the operation were encountered.
+  */
+ BLAZE_ERR_INVALID_DATA = -22,
+ /**
+  * The I/O operation's timeout expired, causing it to be canceled.
+  */
+ BLAZE_ERR_TIMED_OUT = -110,
+ /**
+  * This operation is unsupported on this platform.
+  */
+ BLAZE_ERR_UNSUPPORTED = -95,
+ /**
+  * An operation could not be completed, because it failed
+  * to allocate enough memory.
+  */
+ BLAZE_ERR_OUT_OF_MEMORY = -12,
+ /**
+  * A parameter was incorrect.
+  */
+ BLAZE_ERR_INVALID_INPUT = -256,
+ /**
+  * An error returned when an operation could not be completed
+  * because a call to [`write`] returned [`Ok(0)`].
+  */
+ BLAZE_ERR_WRITE_ZERO = -257,
+ /**
+  * An error returned when an operation could not be completed
+  * because an "end of file" was reached prematurely.
+  */
+ BLAZE_ERR_UNEXPECTED_EOF = -258,
+ /**
+  * DWARF input data was invalid.
+  */
+ BLAZE_ERR_INVALID_DWARF = -259,
+ /**
+  * A custom error that does not fall under any other I/O error
+  * kind.
+  */
+ BLAZE_ERR_OTHER = -260,
+} blaze_err;
+
+/**
+* The reason why normalization failed.
+*
+* The reason is generally only meant as a hint. Reasons reported may change
+* over time and, hence, should not be relied upon for the correctness of the
+* application.
+*/
+enum blaze_normalize_reason
+#ifdef __cplusplus
+   : uint8_t
+#endif // __cplusplus
+{
+ /**
+  * The absolute address was not found in the corresponding process' virtual
+  * memory map.
+  */
+ BLAZE_NORMALIZE_REASON_UNMAPPED,
+ /**
+  * The `/proc/<pid>/maps` entry corresponding to the address does not have
+  * a component (file system path, object, ...) associated with it.
+  */
+ BLAZE_NORMALIZE_REASON_MISSING_COMPONENT,
+ /**
+  * The address belonged to an entity that is currently unsupported.
+  */
+ BLAZE_NORMALIZE_REASON_UNSUPPORTED,
+};
+#ifndef __cplusplus
+typedef uint8_t blaze_normalize_reason;
+#endif // __cplusplus
+
+/**
+* The type of a symbol.
+*/
+enum blaze_sym_type
+#ifdef __cplusplus
+   : uint8_t
+#endif // __cplusplus
+{
+ /**
+  * The symbol type is unspecified or unknown.
+  *
+  * In input contexts this variant can be used to encompass all
+  * other variants (functions and variables), whereas in output
+  * contexts it means that the type is not known.
+  */
+ BLAZE_SYM_UNDEF,
+ /**
+  * The symbol is a function.
+  */
+ BLAZE_SYM_FUNC,
+ /**
+  * The symbol is a variable.
+  */
+ BLAZE_SYM_VAR,
+};
+#ifndef __cplusplus
+typedef uint8_t blaze_sym_type;
+#endif // __cplusplus
+
+/**
+* The reason why symbolization failed.
+*
+* The reason is generally only meant as a hint. Reasons reported may
+* change over time and, hence, should not be relied upon for the
+* correctness of the application.
+*/
+enum blaze_symbolize_reason
+#ifdef __cplusplus
+   : uint8_t
+#endif // __cplusplus
+{
+ /**
+  * Symbolization was successful.
+  */
+ BLAZE_SYMBOLIZE_REASON_SUCCESS = 0,
+ /**
+  * The absolute address was not found in the corresponding process'
+  * virtual memory map.
+  */
+ BLAZE_SYMBOLIZE_REASON_UNMAPPED,
+ /**
+  * The file offset does not map to a valid piece of code/data.
+  */
+ BLAZE_SYMBOLIZE_REASON_INVALID_FILE_OFFSET,
+ /**
+  * The `/proc/<pid>/maps` entry corresponding to the address does
+  * not have a component (file system path, object, ...) associated
+  * with it.
+  */
+ BLAZE_SYMBOLIZE_REASON_MISSING_COMPONENT,
+ /**
+  * The symbolization source has no or no relevant symbols.
+  */
+ BLAZE_SYMBOLIZE_REASON_MISSING_SYMS,
+ /**
+  * The address could not be found in the symbolization source.
+  */
+ BLAZE_SYMBOLIZE_REASON_UNKNOWN_ADDR,
+ /**
+  * The address belonged to an entity that is currently unsupported.
+  */
+ BLAZE_SYMBOLIZE_REASON_UNSUPPORTED,
+};
+#ifndef __cplusplus
+typedef uint8_t blaze_symbolize_reason;
+#endif // __cplusplus
+
+/**
+* The valid variant kind in [`blaze_user_meta`].
+*/
+typedef enum blaze_user_meta_kind {
+ /**
+  * [`blaze_user_meta_variant::unknown`] is valid.
+  */
+ BLAZE_USER_META_UNKNOWN,
+ /**
+  * [`blaze_user_meta_variant::apk`] is valid.
+  */
+ BLAZE_USER_META_APK,
+ /**
+  * [`blaze_user_meta_variant::elf`] is valid.
+  */
+ BLAZE_USER_META_ELF,
+} blaze_user_meta_kind;
+
+/**
+* Information about a looked up symbol.
+*/
+typedef struct blaze_sym_info {
+ /**
+  * See [`inspect::SymInfo::name`].
+  */
+ const char *name;
+ /**
+  * See [`inspect::SymInfo::addr`].
+  */
+ uintptr_t addr;
+ /**
+  * See [`inspect::SymInfo::size`].
+  */
+ size_t size;
+ /**
+  * See [`inspect::SymInfo::file_offset`].
+  */
+ uint64_t file_offset;
+ /**
+  * See [`inspect::SymInfo::obj_file_name`].
+  */
+ const char *obj_file_name;
+ /**
+  * See [`inspect::SymInfo::sym_type`].
+  */
+ blaze_sym_type sym_type;
+ /**
+  * Unused member available for future expansion.
+  */
+ uint8_t reserved[15];
+} blaze_sym_info;
+
+/**
+* C ABI compatible version of [`blazesym::inspect::Inspector`].
+*/
+typedef struct blaze_inspector blaze_inspector;
+
+/**
+* An object representing an ELF inspection source.
+*
+* C ABI compatible version of [`inspect::Elf`].
+*/
+typedef struct blaze_inspect_elf_src {
+ /**
+  * The size of this object's type.
+  *
+  * Make sure to initialize it to `sizeof(<type>)`. This member is used to
+  * ensure compatibility in the presence of member additions.
+  */
+ size_t type_size;
+ /**
+  * The path to the ELF file. This member is always present.
+  */
+ const char *path;
+ /**
+  * Whether or not to consult debug symbols to satisfy the request
+  * (if present).
+  */
+ bool debug_syms;
+ /**
+  * Unused member available for future expansion. Must be initialized
+  * to zero.
+  */
+ uint8_t reserved[7];
+} blaze_inspect_elf_src;
+
+/**
+* C ABI compatible version of [`blazesym::normalize::Normalizer`].
+*/
+typedef struct blaze_normalizer blaze_normalizer;
+
+/**
+* Options for configuring [`blaze_normalizer`] objects.
+*/
+typedef struct blaze_normalizer_opts {
+ /**
+  * The size of this object's type.
+  *
+  * Make sure to initialize it to `sizeof(<type>)`. This member is used to
+  * ensure compatibility in the presence of member additions.
+  */
+ size_t type_size;
+ /**
+  * Whether or not to cache `/proc/<pid>/maps` contents.
+  *
+  * Setting this flag to `true` is not generally recommended, because it
+  * could result in addresses corresponding to mappings added after caching
+  * may not be normalized successfully, as there is no reasonable way of
+  * detecting staleness.
+  */
+ bool cache_maps;
+ /**
+  * Whether to read and report build IDs as part of the normalization
+  * process.
+  */
+ bool build_ids;
+ /**
+  * Whether or not to cache build IDs. This flag only has an effect
+  * if build ID reading is enabled in the first place.
+  */
+ bool cache_build_ids;
+ /**
+  * Unused member available for future expansion. Must be initialized
+  * to zero.
+  */
+ uint8_t reserved[5];
+} blaze_normalizer_opts;
+
+/**
+* C compatible version of [`Apk`].
+*/
+typedef struct blaze_user_meta_apk {
+ /**
+  * The canonical absolute path to the APK, including its name.
+  * This member is always present.
+  */
+ char *path;
+ /**
+  * Unused member available for future expansion.
+  */
+ uint8_t reserved[8];
+} blaze_user_meta_apk;
+
+/**
+* C compatible version of [`Elf`].
+*/
+typedef struct blaze_user_meta_elf {
+ /**
+  * The path to the ELF file. This member is always present.
+  */
+ char *path;
+ /**
+  * The length of the build ID, in bytes.
+  */
+ size_t build_id_len;
+ /**
+  * The optional build ID of the ELF file, if found.
+  */
+ uint8_t *build_id;
+ /**
+  * Unused member available for future expansion.
+  */
+ uint8_t reserved[8];
+} blaze_user_meta_elf;
+
+/**
+* C compatible version of [`Unknown`].
+*/
+typedef struct blaze_user_meta_unknown {
+ /**
+  * The reason why normalization failed.
+  *
+  * The provided reason is a best guess, hinting at what ultimately
+  * prevented the normalization from being successful.
+  */
+ blaze_normalize_reason reason;
+ /**
+  * Unused member available for future expansion.
+  */
+ uint8_t reserved[7];
+} blaze_user_meta_unknown;
+
+/**
+* The actual variant data in [`blaze_user_meta`].
+*/
+typedef union blaze_user_meta_variant {
+ /**
+  * Valid on [`blaze_user_meta_kind::BLAZE_USER_META_APK`].
+  */
+ struct blaze_user_meta_apk apk;
+ /**
+  * Valid on [`blaze_user_meta_kind::BLAZE_USER_META_ELF`].
+  */
+ struct blaze_user_meta_elf elf;
+ /**
+  * Valid on [`blaze_user_meta_kind::BLAZE_USER_META_UNKNOWN`].
+  */
+ struct blaze_user_meta_unknown unknown;
+} blaze_user_meta_variant;
+
+/**
+* C ABI compatible version of [`UserMeta`].
+*/
+typedef struct blaze_user_meta {
+ /**
+  * The variant kind that is present.
+  */
+ enum blaze_user_meta_kind kind;
+ /**
+  * The actual variant with its data.
+  */
+ union blaze_user_meta_variant variant;
+} blaze_user_meta;
+
+/**
+* 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`]).
+*/
+typedef struct blaze_normalized_output {
+ /**
+  * The file offset or non-normalized address.
+  */
+ uint64_t output;
+ /**
+  * The index into the associated [`blaze_user_meta`] array.
+  */
+ size_t meta_idx;
+} blaze_normalized_output;
+
+/**
+* An object representing normalized user addresses.
+*
+* C ABI compatible version of [`UserOutput`].
+*/
+typedef struct blaze_normalized_user_output {
+ /**
+  * The number of [`blaze_user_meta`] objects present in `metas`.
+  */
+ size_t meta_cnt;
+ /**
+  * An array of `meta_cnt` objects.
+  */
+ struct blaze_user_meta *metas;
+ /**
+  * The number of [`blaze_normalized_output`] objects present in `outputs`.
+  */
+ size_t output_cnt;
+ /**
+  * An array of `output_cnt` objects.
+  */
+ struct blaze_normalized_output *outputs;
+ /**
+  * Unused member available for future expansion.
+  */
+ uint8_t reserved[8];
+} blaze_normalized_user_output;
+
+/**
+* Options influencing the address normalization process.
+*/
+typedef struct blaze_normalize_opts {
+ /**
+  * The size of this object's type.
+  *
+  * Make sure to initialize it to `sizeof(<type>)`. This member is used to
+  * ensure compatibility in the presence of member additions.
+  */
+ size_t type_size;
+ /**
+  * Whether or not addresses are sorted (in ascending order) already.
+  *
+  * Normalization always happens on sorted addresses and if the addresses
+  * are sorted already, the library does not need to sort and later restore
+  * original ordering, speeding up the normalization process.
+  */
+ bool sorted_addrs;
+ /**
+  * Whether to report `/proc/<pid>/map_files/` entry paths or work
+  * with symbolic paths mentioned in `/proc/<pid>/maps` instead.
+  *
+  * Relying on `map_files` may make sense in cases where
+  * symbolization happens on the local system and the reported paths
+  * can be worked with directly. In most other cases where one wants
+  * to attach meaning to symbolic paths on a remote system (e.g., by
+  * using them for file look up) symbolic paths are probably the
+  * better choice.
+  */
+ bool map_files;
+ /**
+  * Unused member available for future expansion. Must be initialized
+  * to zero.
+  */
+ uint8_t reserved[6];
+} blaze_normalize_opts;
+
+/**
+* C ABI compatible version of [`blazesym::symbolize::Symbolizer`].
+*
+* It is returned by [`blaze_symbolizer_new`] and should be free by
+* [`blaze_symbolizer_free`].
+*/
+typedef struct blaze_symbolizer blaze_symbolizer;
+
+/**
+* Options for configuring [`blaze_symbolizer`] objects.
+*/
+typedef struct blaze_symbolizer_opts {
+ /**
+  * The size of this object's type.
+  *
+  * Make sure to initialize it to `sizeof(<type>)`. This member is used to
+  * ensure compatibility in the presence of member additions.
+  */
+ size_t type_size;
+ /**
+  * Array of debug directories to search for split debug information.
+  *
+  * These directories will be consulted (in given order) when resolving
+  * debug links in binaries. By default and when this member is NULL,
+  * `/usr/lib/debug` and `/lib/debug/` will be searched. Setting an array
+  * here will overwrite these defaults, so make sure to include these
+  * directories as desired.
+  *
+  * Note that the directory containing a symbolization source is always an
+  * implicit candidate target directory of the highest precedence.
+  */
+ const char *const *debug_dirs;
+ /**
+  * The number of array elements in `debug_dirs`.
+  */
+ size_t debug_dirs_len;
+ /**
+  * Whether or not to automatically reload file system based
+  * symbolization sources that were updated since the last
+  * symbolization operation.
+  */
+ bool auto_reload;
+ /**
+  * Whether to attempt to gather source code location information.
+  *
+  * This setting implies `debug_syms` (and forces it to `true`).
+  */
+ bool code_info;
+ /**
+  * Whether to report inlined functions as part of symbolization.
+  */
+ bool inlined_fns;
+ /**
+  * Whether or not to transparently demangle symbols.
+  *
+  * Demangling happens on a best-effort basis. Currently supported
+  * languages are Rust and C++ and the flag will have no effect if
+  * the underlying language does not mangle symbols (such as C).
+  */
+ bool demangle;
+ /**
+  * Unused member available for future expansion. Must be initialized
+  * to zero.
+  */
+ uint8_t reserved[4];
+} blaze_symbolizer_opts;
+
+/**
+* Source code location information for a symbol or inlined function.
+*/
+typedef struct blaze_symbolize_code_info {
+ /**
+  * The directory in which the source file resides.
+  *
+  * This attribute is optional and may be NULL.
+  */
+ const char *dir;
+ /**
+  * The file that defines the symbol.
+  *
+  * This attribute is optional and may be NULL.
+  */
+ const char *file;
+ /**
+  * The line number on which the symbol is located in the source
+  * code.
+  */
+ uint32_t line;
+ /**
+  * The column number of the symbolized instruction in the source
+  * code.
+  */
+ uint16_t column;
+ /**
+  * Unused member available for future expansion.
+  */
+ uint8_t reserved[10];
+} blaze_symbolize_code_info;
+
+/**
+* Data about an inlined function call.
+*/
+typedef struct blaze_symbolize_inlined_fn {
+ /**
+  * The symbol name of the inlined function.
+  */
+ const char *name;
+ /**
+  * Source code location information for the inlined function.
+  */
+ struct blaze_symbolize_code_info code_info;
+ /**
+  * Unused member available for future expansion.
+  */
+ uint8_t reserved[8];
+} blaze_symbolize_inlined_fn;
+
+/**
+* The result of symbolization of an address.
+*
+* A `blaze_sym` is the information of a symbol found for an
+* address.
+*/
+typedef struct blaze_sym {
+ /**
+  * The symbol name is where the given address should belong to.
+  *
+  * If an address could not be symbolized, this member will be NULL.
+  */
+ const char *name;
+ /**
+  * The address at which the symbol is located (i.e., its "start").
+  *
+  * This is the "normalized" address of the symbol, as present in
+  * the file (and reported by tools such as `readelf(1)`,
+  * `llvm-gsymutil`, or similar).
+  */
+ uintptr_t addr;
+ /**
+  * The byte offset of the address that got symbolized from the
+  * start of the symbol (i.e., from `addr`).
+  *
+  * E.g., when symbolizing address 0x1337 of a function that starts at
+  * 0x1330, the offset will be set to 0x07 (and `addr` will be 0x1330). This
+  * member is especially useful in contexts when input addresses are not
+  * already normalized, such as when symbolizing an address in a process
+  * context (which may have been relocated and/or have layout randomizations
+  * applied).
+  */
+ size_t offset;
+ /**
+  * Source code location information for the symbol.
+  */
+ struct blaze_symbolize_code_info code_info;
+ /**
+  * The number of symbolized inlined function calls present.
+  */
+ size_t inlined_cnt;
+ /**
+  * An array of `inlined_cnt` symbolized inlined function calls.
+  */
+ const struct blaze_symbolize_inlined_fn *inlined;
+ /**
+  * On error (i.e., if `name` is NULL), a reason trying to explain
+  * why symbolization failed.
+  */
+ blaze_symbolize_reason reason;
+ /**
+  * Unused member available for future expansion.
+  */
+ uint8_t reserved[7];
+} blaze_sym;
+
+/**
+* `blaze_result` is the result of symbolization for C API.
+*
+* Instances of [`blaze_result`] are returned by any of the `blaze_symbolize_*`
+* variants. They should be freed by calling [`blaze_result_free`].
+*/
+typedef struct blaze_result {
+ /**
+  * The number of symbols being reported.
+  */
+ size_t cnt;
+ /**
+  * The symbols corresponding to input addresses.
+  *
+  * Symbolization happens based on the ordering of (input) addresses.
+  * Therefore, every input address has an associated symbol.
+  */
+ struct blaze_sym syms[0];
+} blaze_result;
+
+/**
+* The parameters to load symbols and debug information from a process.
+*
+* Load all ELF files in a process as the sources of symbols and debug
+* information.
+*/
+typedef struct blaze_symbolize_src_process {
+ /**
+  * The size of this object's type.
+  *
+  * Make sure to initialize it to `sizeof(<type>)`. This member is used to
+  * ensure compatibility in the presence of member additions.
+  */
+ size_t type_size;
+ /**
+  * It is the PID of a process to symbolize.
+  *
+  * blazesym will parse `/proc/<pid>/maps` and load all the object
+  * files.
+  */
+ uint32_t pid;
+ /**
+  * Whether or not to consult debug symbols to satisfy the request
+  * (if present).
+  */
+ bool debug_syms;
+ /**
+  * Whether to incorporate a process' perf map file into the symbolization
+  * procedure.
+  */
+ bool perf_map;
+ /**
+  * Whether to work with `/proc/<pid>/map_files/` entries or with
+  * symbolic paths mentioned in `/proc/<pid>/maps` instead.
+  * `map_files` usage is generally strongly encouraged, as symbolic
+  * path usage is unlikely to work reliably in mount namespace
+  * contexts or when files have been deleted from the file system.
+  * However, by using symbolic paths the need for requiring the
+  * `SYS_ADMIN` capability is eliminated.
+  */
+ bool map_files;
+ /**
+  * Unused member available for future expansion. Must be initialized
+  * to zero.
+  */
+ uint8_t reserved[1];
+} blaze_symbolize_src_process;
+
+/**
+* The parameters to load symbols and debug information from a kernel.
+*
+* Use a kernel image and a snapshot of its kallsyms as a source of symbols and
+* debug information.
+*/
+typedef struct blaze_symbolize_src_kernel {
+ /**
+  * The size of this object's type.
+  *
+  * Make sure to initialize it to `sizeof(<type>)`. This member is used to
+  * ensure compatibility in the presence of member additions.
+  */
+ size_t type_size;
+ /**
+  * The path of a copy of kallsyms.
+  *
+  * It can be `"/proc/kallsyms"` for the running kernel on the
+  * device.  However, you can make copies for later.  In that situation,
+  * you should give the path of a copy.
+  * Passing a `NULL`, by default, will result in `"/proc/kallsyms"`.
+  */
+ const char *kallsyms;
+ /**
+  * The path of a kernel image.
+  *
+  * The path of a kernel image should be, for instance,
+  * `"/boot/vmlinux-xxxx"`.  For a `NULL` value, it will locate the
+  * kernel image of the running kernel in `"/boot/"` or
+  * `"/usr/lib/debug/boot/"`.
+  */
+ const char *kernel_image;
+ /**
+  * Whether or not to consult debug symbols from `kernel_image`
+  * to satisfy the request (if present).
+  */
+ bool debug_syms;
+ /**
+  * Unused member available for future expansion. Must be initialized
+  * to zero.
+  */
+ uint8_t reserved[7];
+} blaze_symbolize_src_kernel;
+
+/**
+* The parameters to load symbols and debug information from an ELF.
+*
+* Describes the path and address of an ELF file loaded in a
+* process.
+*/
+typedef struct blaze_symbolize_src_elf {
+ /**
+  * The size of this object's type.
+  *
+  * Make sure to initialize it to `sizeof(<type>)`. This member is used to
+  * ensure compatibility in the presence of member additions.
+  */
+ size_t type_size;
+ /**
+  * The path to the ELF file.
+  *
+  * The referenced file may be an executable or shared object. For example,
+  * passing "/bin/sh" will load symbols and debug information from `sh` and
+  * passing "/lib/libc.so.xxx" will load symbols and debug information from
+  * libc.
+  */
+ const char *path;
+ /**
+  * Whether or not to consult debug symbols to satisfy the request
+  * (if present).
+  */
+ bool debug_syms;
+ /**
+  * Unused member available for future expansion. Must be initialized
+  * to zero.
+  */
+ uint8_t reserved[7];
+} blaze_symbolize_src_elf;
+
+/**
+* The parameters to load symbols and debug information from "raw" Gsym data.
+*/
+typedef struct blaze_symbolize_src_gsym_data {
+ /**
+  * The size of this object's type.
+  *
+  * Make sure to initialize it to `sizeof(<type>)`. This member is used to
+  * ensure compatibility in the presence of member additions.
+  */
+ size_t type_size;
+ /**
+  * The Gsym data.
+  */
+ const uint8_t *data;
+ /**
+  * The size of the Gsym data.
+  */
+ size_t data_len;
+} blaze_symbolize_src_gsym_data;
+
+/**
+* The parameters to load symbols and debug information from a Gsym file.
+*/
+typedef struct blaze_symbolize_src_gsym_file {
+ /**
+  * The size of this object's type.
+  *
+  * Make sure to initialize it to `sizeof(<type>)`. This member is used to
+  * ensure compatibility in the presence of member additions.
+  */
+ size_t type_size;
+ /**
+  * The path to a gsym file.
+  */
+ const char *path;
+} blaze_symbolize_src_gsym_file;
+
+#ifdef __cplusplus
+extern "C" {
+#endif // __cplusplus
+
+/**
+* Retrieve the error reported by the last fallible API function invoked.
+*/
+enum blaze_err blaze_err_last(void);
+
+/**
+* Retrieve a textual representation of the error code.
+*/
+const char *blaze_err_str(enum blaze_err err);
+
+/**
+* Lookup symbol information in an ELF file.
+*
+* On success, returns an array with `name_cnt` elements. Each such element, in
+* turn, is NULL terminated array comprised of each symbol found. The returned
+* object should be released using [`blaze_inspect_syms_free`] once it is no
+* longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*
+* # Safety
+* - `inspector` needs to point to an initialized [`blaze_inspector`] object
+* - `src` needs to point to an initialized [`blaze_inspect_syms_elf`] object
+* - `names` needs to be a valid pointer to `name_cnt` NUL terminated strings
+*/
+const struct blaze_sym_info *const *blaze_inspect_syms_elf(const blaze_inspector *inspector,
+                                                          const struct blaze_inspect_elf_src *src,
+                                                          const char *const *names,
+                                                          size_t name_cnt);
+
+/**
+* Free an array returned by [`blaze_inspect_syms_elf`].
+*
+* # Safety
+*
+* The pointer must be returned by [`blaze_inspect_syms_elf`].
+*/
+void blaze_inspect_syms_free(const struct blaze_sym_info *const *syms);
+
+/**
+* Create an instance of a blazesym inspector.
+*
+* C ABI compatible version of [`blazesym::inspect::Inspector::new()`].
+* Please refer to its documentation for the default configuration in
+* use.
+*
+* On success, the function creates a new [`blaze_inspector`] object
+* and returns it. The resulting object should be released using
+* [`blaze_inspector_free`] once it is no longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*/
+blaze_inspector *blaze_inspector_new(void);
+
+/**
+* Free a blazesym inspector.
+*
+* Release resources associated with a inspector as created by
+* [`blaze_inspector_new`], for example.
+*
+* # Safety
+* The provided inspector should have been created by
+* [`blaze_inspector_new`].
+*/
+void blaze_inspector_free(blaze_inspector *inspector);
+
+/**
+* Create an instance of a blazesym normalizer in the default
+* configuration.
+*
+* C ABI compatible version of [`blazesym::normalize::Normalizer::new()`].
+* Please refer to its documentation for the default configuration in use.
+*
+* On success, the function creates a new [`blaze_normalizer`] object and
+* returns it. The resulting object should be released using
+* [`blaze_normalizer_free`] once it is no longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*/
+blaze_normalizer *blaze_normalizer_new(void);
+
+/**
+* Create an instance of a blazesym normalizer.
+*
+* On success, the function creates a new [`blaze_normalizer`] object and
+* returns it. The resulting object should be released using
+* [`blaze_normalizer_free`] once it is no longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*
+* # Safety
+* - `opts` needs to point to a valid [`blaze_normalizer_opts`] object
+*/
+blaze_normalizer *blaze_normalizer_new_opts(const struct blaze_normalizer_opts *opts);
+
+/**
+* Free a blazesym normalizer.
+*
+* Release resources associated with a normalizer as created by
+* [`blaze_normalizer_new`], for example.
+*
+* # Safety
+* The provided normalizer should have been created by
+* [`blaze_normalizer_new`].
+*/
+void blaze_normalizer_free(blaze_normalizer *normalizer);
+
+/**
+* Retrieve a textual representation of the reason of a normalization failure.
+*/
+const char *blaze_normalize_reason_str(blaze_normalize_reason err);
+
+/**
+* Normalize a list of user space addresses.
+*
+* C ABI compatible version of [`Normalizer::normalize_user_addrs`].
+*
+* `pid` should describe the PID of the process to which the addresses
+* belongs. It may be `0` if they belong to the calling process.
+*
+* On success, the function creates a new [`blaze_normalized_user_output`]
+* object and returns it. The resulting object should be released using
+* [`blaze_user_output_free`] once it is no longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*
+* # Safety
+* - `addrs` needs to be a valid pointer to `addr_cnt` addresses
+*/
+struct blaze_normalized_user_output *blaze_normalize_user_addrs(const blaze_normalizer *normalizer,
+                                                               uint32_t pid,
+                                                               const uintptr_t *addrs,
+                                                               size_t addr_cnt);
+
+/**
+* Normalize a list of user space addresses.
+*
+* C ABI compatible version of [`Normalizer::normalize_user_addrs_opts`].
+*
+* `pid` should describe the PID of the process to which the addresses
+* belongs. It may be `0` if they belong to the calling process.
+*
+* `opts` should point to a valid [`blaze_normalize_opts`] object.
+*
+* On success, the function creates a new [`blaze_normalized_user_output`]
+* object and returns it. The resulting object should be released using
+* [`blaze_user_output_free`] once it is no longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*
+* # Safety
+* - `addrs` needs to be a valid pointer to `addr_cnt` addresses
+*/
+struct blaze_normalized_user_output *blaze_normalize_user_addrs_opts(const blaze_normalizer *normalizer,
+                                                                    uint32_t pid,
+                                                                    const uintptr_t *addrs,
+                                                                    size_t addr_cnt,
+                                                                    const struct blaze_normalize_opts *opts);
+
+/**
+* Free an object as returned by [`blaze_normalize_user_addrs`] or
+* [`blaze_normalize_user_addrs_opts`].
+*
+* # Safety
+* The provided object should have been created by
+* [`blaze_normalize_user_addrs`] or
+* [`blaze_normalize_user_addrs_opts`].
+*/
+void blaze_user_output_free(struct blaze_normalized_user_output *output);
+
+/**
+* Retrieve a textual representation of the reason of a symbolization
+* failure.
+*/
+const char *blaze_symbolize_reason_str(blaze_symbolize_reason err);
+
+/**
+* Create an instance of a symbolizer.
+*
+* C ABI compatible version of [`blazesym::symbolize::Symbolizer::new()`].
+* Please refer to its documentation for the default configuration in use.
+*
+* On success, the function creates a new [`blaze_symbolizer`] object
+* and returns it. The resulting object should be released using
+* [`blaze_symbolizer_free`] once it is no longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*/
+blaze_symbolizer *blaze_symbolizer_new(void);
+
+/**
+* Create an instance of a symbolizer with configurable options.
+*
+* On success, the function creates a new [`blaze_symbolizer`] object
+* and returns it. The resulting object should be released using
+* [`blaze_symbolizer_free`] once it is no longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*
+* # Safety
+* - `opts` needs to point to a valid [`blaze_symbolizer_opts`] object
+*/
+blaze_symbolizer *blaze_symbolizer_new_opts(const struct blaze_symbolizer_opts *opts);
+
+/**
+* Free an instance of blazesym a symbolizer for C API.
+*
+* # Safety
+*
+* The pointer must have been returned by [`blaze_symbolizer_new`] or
+* [`blaze_symbolizer_new_opts`].
+*/
+void blaze_symbolizer_free(blaze_symbolizer *symbolizer);
+
+/**
+* Symbolize a list of process absolute addresses.
+*
+* On success, the function returns a [`blaze_result`] containing an
+* array of `abs_addr_cnt` [`blaze_sym`] objects. The returned object
+* should be released using [`blaze_result_free`] once it is no longer
+* needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*
+* # Safety
+* - `symbolizer` needs to point to a valid [`blaze_symbolizer`] object
+* - `src` needs to point to a valid [`blaze_symbolize_src_process`] object
+* -`abs_addrs` point to an array of `abs_addr_cnt` addresses
+*/
+const struct blaze_result *blaze_symbolize_process_abs_addrs(blaze_symbolizer *symbolizer,
+                                                            const struct blaze_symbolize_src_process *src,
+                                                            const uintptr_t *abs_addrs,
+                                                            size_t abs_addr_cnt);
+
+/**
+* Symbolize a list of kernel absolute addresses.
+*
+* On success, the function returns a [`blaze_result`] containing an
+* array of `abs_addr_cnt` [`blaze_sym`] objects. The returned object
+* should be released using [`blaze_result_free`] once it is no longer
+* needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*
+* # Safety
+* - `symbolizer` needs to point to a valid [`blaze_symbolizer`] object
+* - `src` needs to point to a valid [`blaze_symbolize_src_kernel`] object
+* -`abs_addrs` point to an array of `abs_addr_cnt` addresses
+*/
+const struct blaze_result *blaze_symbolize_kernel_abs_addrs(blaze_symbolizer *symbolizer,
+                                                           const struct blaze_symbolize_src_kernel *src,
+                                                           const uintptr_t *abs_addrs,
+                                                           size_t abs_addr_cnt);
+
+/**
+* Symbolize virtual offsets in an ELF file.
+*
+* On success, the function returns a [`blaze_result`] containing an
+* array of `virt_offset_cnt` [`blaze_sym`] objects. The returned
+* object should be released using [`blaze_result_free`] once it is no
+* longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*
+* # Safety
+* - `symbolizer` needs to point to a valid [`blaze_symbolizer`] object
+* - `src` needs to point to a valid [`blaze_symbolize_src_elf`] object
+* -`virt_offsets` point to an array of `virt_offset_cnt` addresses
+*/
+const struct blaze_result *blaze_symbolize_elf_virt_offsets(blaze_symbolizer *symbolizer,
+                                                           const struct blaze_symbolize_src_elf *src,
+                                                           const uintptr_t *virt_offsets,
+                                                           size_t virt_offset_cnt);
+
+/**
+* Symbolize file offsets in an ELF file.
+*
+* On success, the function returns a [`blaze_result`] containing an
+* array of `file_offset_cnt` [`blaze_sym`] objects. The returned
+* object should be released using [`blaze_result_free`] once it is no
+* longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*
+* # Safety
+* - `symbolizer` needs to point to a valid [`blaze_symbolizer`] object
+* - `src` needs to point to a valid [`blaze_symbolize_src_elf`] object
+* -`file_offsets` point to an array of `file_offset_cnt` addresses
+*/
+const struct blaze_result *blaze_symbolize_elf_file_offsets(blaze_symbolizer *symbolizer,
+                                                           const struct blaze_symbolize_src_elf *src,
+                                                           const uintptr_t *file_offsets,
+                                                           size_t file_offset_cnt);
+
+/**
+* Symbolize virtual offsets using "raw" Gsym data.
+*
+* On success, the function returns a [`blaze_result`] containing an
+* array of `virt_offset_cnt` [`blaze_sym`] objects. The returned
+* object should be released using [`blaze_result_free`] once it is no
+* longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*
+* # Safety
+* - `symbolizer` needs to point to a valid [`blaze_symbolizer`] object
+* - `src` needs to point to a valid [`blaze_symbolize_src_gsym_data`] object
+* -`virt_offsets` point to an array of `virt_offset_cnt` addresses
+*/
+const struct blaze_result *blaze_symbolize_gsym_data_virt_offsets(blaze_symbolizer *symbolizer,
+                                                                 const struct blaze_symbolize_src_gsym_data *src,
+                                                                 const uintptr_t *virt_offsets,
+                                                                 size_t virt_offset_cnt);
+
+/**
+* Symbolize virtual offsets in a Gsym file.
+*
+* On success, the function returns a [`blaze_result`] containing an
+* array of `virt_offset_cnt` [`blaze_sym`] objects. The returned
+* object should be released using [`blaze_result_free`] once it is no
+* longer needed.
+*
+* On error, the function returns `NULL` and sets the thread's last error to
+* indicate the problem encountered. Use [`blaze_err_last`] to retrieve this
+* error.
+*
+* # Safety
+* - `symbolizer` needs to point to a valid [`blaze_symbolizer`] object
+* - `src` needs to point to a valid [`blaze_symbolize_src_gsym_file`] object
+* -`virt_offsets` point to an array of `virt_offset_cnt` addresses
+*/
+const struct blaze_result *blaze_symbolize_gsym_file_virt_offsets(blaze_symbolizer *symbolizer,
+                                                                 const struct blaze_symbolize_src_gsym_file *src,
+                                                                 const uintptr_t *virt_offsets,
+                                                                 size_t virt_offset_cnt);
+
+/**
+* Free an array returned by any of the `blaze_symbolize_*` variants.
+*
+* # Safety
+* The pointer must have been returned by any of the `blaze_symbolize_*`
+* variants.
+*/
+void blaze_result_free(const struct blaze_result *results);
+
+#ifdef __cplusplus
+} // extern "C"
+#endif // __cplusplus
+
+#endif /* __blazesym_h_ */