Struct symbolic::debuginfo::macho::MachObject

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

Mach Object containers, used for executables and debug companions on macOS and iOS.

Implementations

impl<'d> MachObject<'d>

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

Tests whether the buffer could contain a MachO object.

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

Tries to parse a MachO from the given slice.

pub fn load_symbolmap(&mut self, symbolmap: BcSymbolMap<'d>)

Parses and loads the BcSymbolMap into the object.

The bitcode symbol map must match the object, there is nothing in the symbol map which allows this call to verify this.

Once the symbolmap is loaded this object will transparently resolve any hidden symbols using the provided symbolmap.

Examples

use symbolic_debuginfo::macho::{BcSymbolMap, MachObject};

// let object_data = std::fs::read("dSYMs/.../Resources/DWARF/object").unwrap();
let mut object = MachObject::parse(&object_data).unwrap();

let map = object.symbol_map();
let symbol = map.lookup(0x5a74).unwrap();
assert_eq!(symbol.name.as_ref().map(|n| n.to_owned()).unwrap(), "__hidden#0_");

// let bc_symbol_map_data =
//     std::fs::read("BCSymbolMaps/c8374b6d-6e96-34d8-ae38-efaa5fec424f.bcsymbolmap")
//     .unwrap();
let bc_symbol_map = BcSymbolMap::parse(&bc_symbol_map_data).unwrap();
object.load_symbolmap(bc_symbol_map);


let map = object.symbol_map();
let symbol = map.lookup(0x5a74).unwrap();
assert_eq!(
    symbol.name.as_ref().map(|n| n.to_owned()).unwrap(),
    "-[SentryMessage initWithFormatted:]",
);

pub fn compact_unwind_info(
    &self
) -> Result<Option<CompactUnwindInfoIter<'d>>, MachError>

Gets the Compact Unwind Info of this object, if any exists.

pub fn file_format(&self) -> FileFormat

The container file format, which is always FileFormat::MachO.

pub fn name(&self) -> Option<&'d str>

The name of the dylib if any.

pub fn code_id(&self) -> Option<CodeId>

The code identifier of this object.

Mach objects use a UUID which is specified in the load commands that are part of the Mach header. This UUID is generated at compile / link time and is usually unique per compilation.

pub fn debug_id(&self) -> DebugId

The debug information identifier of a MachO file.

This uses the same UUID as code_id.

pub fn arch(&self) -> Arch

The CPU architecture of this object, as specified in the Mach header.

pub fn kind(&self) -> ObjectKind

The kind of this object, as specified in the Mach header.

pub fn load_address(&self) -> u64

The address at which the image prefers to be loaded into memory.

MachO files store all internal addresses as if it was loaded at that address. When the image is actually loaded, that spot might already be taken by other images and so it must be relocated to a new address. At runtime, a relocation table manages the arithmetics behind this.

Addresses used in symbols or debug_session have already been rebased relative to that load address, so that the caller only has to deal with addresses relative to the actual start of the image.

pub fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

pub fn symbols(&self) -> MachOSymbolIterator<'d>

Returns an iterator over symbols in the public symbol table.

pub fn symbol_map(&self) -> SymbolMap<'d>

Returns an ordered map of symbols in the symbol table.

pub fn has_debug_info(&self) -> bool

Determines whether this object contains debug information.

pub fn debug_session(&self) -> Result<DwarfDebugSession<'d>, DwarfError>

Constructs a debugging session.

A debugging session loads certain information from the object file and creates caches for efficient access to various records in the debug information. Since this can be quite a costly process, try to reuse the debugging session as long as possible.

MachO files generally use DWARF debugging information, which is also used by ELF containers on Linux.

Constructing this session will also work if the object does not contain debugging information, in which case the session will be a no-op. This can be checked via has_debug_info.

pub fn has_unwind_info(&self) -> bool

Determines whether this object contains stack unwinding information.

pub fn has_sources(&self) -> bool

Determines whether this object contains embedded source.

pub fn is_malformed(&self) -> bool

Determines whether this object is malformed and was only partially parsed

pub fn data(&self) -> &'d [u8]

Returns the raw data of the ELF file.

pub fn requires_symbolmap(&self) -> bool

Checks whether this mach object contains hidden symbols.

This is an indication that BCSymbolMaps are needed to symbolicate crash reports correctly.

Trait Implementations

impl<'slf, 'd> AsSelf<'slf> for MachObject<'d> where
    'd: 'slf, 

type Ref = MachObject<'slf>

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

fn as_self(&'slf self) -> &'slf <MachObject<'d> as AsSelf<'slf>>::Ref

Returns a reference to self with downcasted lifetime.

impl<'_> Debug for MachObject<'_>

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

Formats the value using the given formatter.

impl<'data> Dwarf<'data> for MachObject<'data>

fn endianity(&self) -> RunTimeEndian

Returns whether the file was compiled for a big-endian or little-endian machine.

fn raw_section(&self, section_name: &str) -> Option<DwarfSection<'data>>

Returns information and raw data of a section.

fn section(&self, name: &str) -> Option<DwarfSection<'data>>

Returns information and data of a section.

fn has_section(&self, name: &str) -> bool

Determines whether the specified section exists.

impl<'data, 'object> ObjectLike<'data, 'object> for MachObject<'data> where
    'data: 'object, 

type Error = DwarfError

Errors thrown when reading information from this object.

type Session = DwarfDebugSession<'data>

A session that allows optimized access to debugging information.

type SymbolIterator = MachOSymbolIterator<'data>

The iterator over the symbols in the public symbol table.

fn file_format(&self) -> FileFormat

The container format of this file.

fn code_id(&self) -> Option<CodeId>

The code identifier of this object.

fn debug_id(&self) -> DebugId

The debug information identifier of this object.

fn arch(&self) -> Arch

The CPU architecture of this object.

fn kind(&self) -> ObjectKind

The kind of this object.

fn load_address(&self) -> u64

The address at which the image prefers to be loaded into memory.

fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

fn symbols(
    &self
) -> <MachObject<'data> as ObjectLike<'data, 'object>>::SymbolIterator

Returns an iterator over symbols in the public symbol table.

fn symbol_map(&self) -> SymbolMap<'data>

Returns an ordered map of symbols in the symbol table.

fn has_debug_info(&self) -> bool

Determines whether this object contains debug information.

fn debug_session(
    &self
) -> Result<<MachObject<'data> as ObjectLike<'data, 'object>>::Session, <MachObject<'data> as ObjectLike<'data, 'object>>::Error>

Constructs a debugging session.

fn has_unwind_info(&self) -> bool

Determines whether this object contains stack unwinding information.

fn has_sources(&self) -> bool

Determines whether this object contains embedded sources.

fn is_malformed(&self) -> bool

Determines whether this object is malformed and was only partially parsed