Struct symbolic::debuginfo::macho::MachObject
source · pub struct MachObject<'d> { /* private fields */ }
Expand description
Mach Object containers, used for executables and debug companions on macOS and iOS.
Implementations§
source§impl<'d> MachObject<'d>
impl<'d> MachObject<'d>
sourcepub fn parse(data: &'d [u8]) -> Result<MachObject<'d>, MachError>
pub fn parse(data: &'d [u8]) -> Result<MachObject<'d>, MachError>
Tries to parse a MachO from the given slice.
sourcepub fn load_symbolmap(&mut self, symbolmap: BcSymbolMap<'d>)
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:]",
);
sourcepub fn compact_unwind_info(
&self
) -> Result<Option<CompactUnwindInfoIter<'d>>, MachError>
pub fn compact_unwind_info(
&self
) -> Result<Option<CompactUnwindInfoIter<'d>>, MachError>
Gets the Compact Unwind Info of this object, if any exists.
sourcepub fn file_format(&self) -> FileFormat
pub fn file_format(&self) -> FileFormat
The container file format, which is always FileFormat::MachO
.
sourcepub fn code_id(&self) -> Option<CodeId>
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.
sourcepub fn debug_id(&self) -> DebugId
pub fn debug_id(&self) -> DebugId
The debug information identifier of a MachO file.
This uses the same UUID as code_id
.
sourcepub fn arch(&self) -> Arch
pub fn arch(&self) -> Arch
The CPU architecture of this object, as specified in the Mach header.
sourcepub fn kind(&self) -> ObjectKind
pub fn kind(&self) -> ObjectKind
The kind of this object, as specified in the Mach header.
sourcepub fn load_address(&self) -> u64
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.
sourcepub fn has_symbols(&self) -> bool
pub fn has_symbols(&self) -> bool
Determines whether this object exposes a public symbol table.
sourcepub fn symbols(&self) -> MachOSymbolIterator<'d> ⓘ
pub fn symbols(&self) -> MachOSymbolIterator<'d> ⓘ
Returns an iterator over symbols in the public symbol table.
sourcepub fn symbol_map(&self) -> SymbolMap<'d>
pub fn symbol_map(&self) -> SymbolMap<'d>
Returns an ordered map of symbols in the symbol table.
sourcepub fn has_debug_info(&self) -> bool
pub fn has_debug_info(&self) -> bool
Determines whether this object contains debug information.
sourcepub fn debug_session(&self) -> Result<DwarfDebugSession<'d>, DwarfError>
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
.
sourcepub fn has_unwind_info(&self) -> bool
pub fn has_unwind_info(&self) -> bool
Determines whether this object contains stack unwinding information.
sourcepub fn has_sources(&self) -> bool
pub fn has_sources(&self) -> bool
Determines whether this object contains embedded source.
sourcepub fn is_malformed(&self) -> bool
pub fn is_malformed(&self) -> bool
Determines whether this object is malformed and was only partially parsed
sourcepub fn requires_symbolmap(&self) -> bool
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§
source§impl<'slf, 'd> AsSelf<'slf> for MachObject<'d>where
'd: 'slf,
impl<'slf, 'd> AsSelf<'slf> for MachObject<'d>where
'd: 'slf,
§type Ref = MachObject<'slf>
type Ref = MachObject<'slf>
Self
type with 'slf
lifetimes, returned by as_self
.source§impl Debug for MachObject<'_>
impl Debug for MachObject<'_>
source§impl<'data> Dwarf<'data> for MachObject<'data>
impl<'data> Dwarf<'data> for MachObject<'data>
source§fn endianity(&self) -> RunTimeEndian
fn endianity(&self) -> RunTimeEndian
source§fn raw_section(&self, section_name: &str) -> Option<DwarfSection<'data>>
fn raw_section(&self, section_name: &str) -> Option<DwarfSection<'data>>
source§impl<'data, 'object> ObjectLike<'data, 'object> for MachObject<'data>where
'data: 'object,
impl<'data, 'object> ObjectLike<'data, 'object> for MachObject<'data>where
'data: 'object,
§type Error = DwarfError
type Error = DwarfError
§type Session = DwarfDebugSession<'data>
type Session = DwarfDebugSession<'data>
§type SymbolIterator = MachOSymbolIterator<'data>
type SymbolIterator = MachOSymbolIterator<'data>
source§fn file_format(&self) -> FileFormat
fn file_format(&self) -> FileFormat
source§fn kind(&self) -> ObjectKind
fn kind(&self) -> ObjectKind
source§fn load_address(&self) -> u64
fn load_address(&self) -> u64
source§fn has_symbols(&self) -> bool
fn has_symbols(&self) -> bool
source§fn symbols(
&self
) -> <MachObject<'data> as ObjectLike<'data, 'object>>::SymbolIterator
fn symbols(
&self
) -> <MachObject<'data> as ObjectLike<'data, 'object>>::SymbolIterator
source§fn symbol_map(&self) -> SymbolMap<'data>
fn symbol_map(&self) -> SymbolMap<'data>
source§fn has_debug_info(&self) -> bool
fn has_debug_info(&self) -> bool
source§fn debug_session(
&self
) -> Result<<MachObject<'data> as ObjectLike<'data, 'object>>::Session, <MachObject<'data> as ObjectLike<'data, 'object>>::Error>
fn debug_session(
&self
) -> Result<<MachObject<'data> as ObjectLike<'data, 'object>>::Session, <MachObject<'data> as ObjectLike<'data, 'object>>::Error>
source§fn has_unwind_info(&self) -> bool
fn has_unwind_info(&self) -> bool
source§fn has_sources(&self) -> bool
fn has_sources(&self) -> bool
source§fn is_malformed(&self) -> bool
fn is_malformed(&self) -> bool
Auto Trait Implementations§
impl<'d> RefUnwindSafe for MachObject<'d>
impl<'d> Send for MachObject<'d>
impl<'d> Sync for MachObject<'d>
impl<'d> Unpin for MachObject<'d>
impl<'d> UnwindSafe for MachObject<'d>
Blanket Implementations§
§impl<T> Conv for T
impl<T> Conv for T
§impl<I, T> ExtractContext<I, ()> for T
impl<I, T> ExtractContext<I, ()> for T
§fn extract_context(self, _original_input: I)
fn extract_context(self, _original_input: I)
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
§impl<I> RecreateContext<I> for I
impl<I> RecreateContext<I> for I
§fn recreate_context(_original_input: I, tail: I) -> I
fn recreate_context(_original_input: I, tail: I) -> I
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds. Read more§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds. Read more§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read more§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds. Read more§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more