Struct symbolic::debuginfo::macho::BcSymbolMap

pub struct BcSymbolMap<'d> { /* private fields */ }

An in-memory representation of the Apple bitcode symbol map.

This is an auxiliary file, not an object file. It can be used to provide de-obfuscated symbol names to a MachObject object using its load_symbolmap method.

It is common for bitcode builds to obfuscate the names in the object file’s symbol table so that even the DWARF files do not have the actual symbol names. In this case the build process will create a .bcsymbolmap file which maps the obfuscated symbol names back to the original ones. This structure can parse these files and allows providing this information to the MachObject so that it has the original symbol names instead of __hidden#NNN_ ones.

See MachObject::load_symbolmap for an example of how to use this.

Implementations

impl<'d> BcSymbolMap<'d>

pub fn test(bytes: &[u8]) -> bool

Tests whether the buffer could contain a BcSymbolMap.

pub fn parse(data: &'d [u8]) -> Result<BcSymbolMap<'d>, BcSymbolMapError>

Parses the BCSymbolMap.

A symbol map does not contain the UUID of its symbols, instead this is normally encoded in the filename.

pub fn get(&self, index: usize) -> Option<&'d str>

Returns the name of a symbol if it exists in this mapping.

Examples

use symbolic_debuginfo::macho::BcSymbolMap;

// let data = std::fs::read("c8374b6d-6e96-34d8-ae38-efaa5fec424f.bcsymbolmap").unwrap();
let map = BcSymbolMap::parse(&data).unwrap();

assert_eq!(map.get(43), Some("Sources/Sentry/Public/SentryMessage.h"));
assert_eq!(map.get(usize::MAX), None);  // We do not have this many entries

pub fn resolve(&self, name: &'d str) -> &'d str

Resolves a name using this mapping.

If the name matches the __hidden#NNN_ pattern that indicates a BcSymbolMap lookup it will be looked up the resolved name will be returned. Otherwise the name is returned unchanged.

Examples

use symbolic_debuginfo::macho::BcSymbolMap;

// let data = std::fs::read("c8374b6d-6e96-34d8-ae38-efaa5fec424f.bcsymbolmap").unwrap();
let map = BcSymbolMap::parse(&data).unwrap();

assert_eq!(map.resolve("__hidden#43_"), "Sources/Sentry/Public/SentryMessage.h");
assert_eq!(map.resolve("_addJSONData"), "_addJSONData");  // #64

pub fn iter(&self) -> BcSymbolMapIterator<'_, 'd>

Returns an iterator over all the names in this bitcode symbol map.

Trait Implementations

impl<'slf> AsSelf<'slf> for BcSymbolMap<'_>

type Ref = BcSymbolMap<'slf>

The Self type with 'slf lifetimes, returned by as_self.

fn as_self(&'slf self) -> &'slf <BcSymbolMap<'_> as AsSelf<'slf>>::Ref

Returns a reference to self with downcasted lifetime.

impl<'d> Clone for BcSymbolMap<'d>

fn clone(&self) -> BcSymbolMap<'d>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'d> Debug for BcSymbolMap<'d>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Transformer for BcSymbolMap<'_>

fn transform_function<'f>(&'f mut self, f: Function<'f>) -> Function<'f>

Transforms a Function record.

fn transform_source_location<'f>(
    &'f mut self,
    sl: SourceLocation<'f>
) -> SourceLocation<'f>

Transforms a SourceLocation.