Struct object::read::macho::MachOFile

pub struct MachOFile<'data, Mach, R = &'data [u8]>
where
    Mach: MachHeader,
    R: ReadRef<'data>,
{
    pub(super) endian: Mach::Endian,
    pub(super) data: R,
    pub(super) header_offset: u64,
    pub(super) header: &'data Mach,
    pub(super) segments: Vec<MachOSegmentInternal<'data, Mach, R>>,
    pub(super) sections: Vec<MachOSectionInternal<'data, Mach, R>>,
    pub(super) symbols: SymbolTable<'data, Mach, R>,
}

A partially parsed Mach-O file.

Most of the functionality of this type is provided by the Object trait implementation.

Fields

endian: Mach::Endian

data: R

header_offset: u64

header: &'data Mach

segments: Vec<MachOSegmentInternal<'data, Mach, R>>

sections: Vec<MachOSectionInternal<'data, Mach, R>>

symbols: SymbolTable<'data, Mach, R>

Implementations

impl<'data, Mach, R> MachOFile<'data, Mach, R>

where Mach: MachHeader, R: ReadRef<'data>,

pub fn parse(data: R) -> Result<Self>

Parse the raw Mach-O file data.

pub fn parse_dyld_cache_image<'cache, E: Endian>( image: &DyldCacheImage<'data, 'cache, E, R>, ) -> Result<Self>

Parse the Mach-O file for the given image from the dyld shared cache. This will read different sections from different subcaches, if necessary.

pub(super) fn section_internal( &self, index: SectionIndex, ) -> Result<&MachOSectionInternal<'data, Mach, R>>

Return the section at the given index.

pub fn endian(&self) -> Mach::Endian

Returns the endianness.

pub fn data(&self) -> R

Returns the raw data.

pub fn raw_header(&self) -> &'data Mach

👎Deprecated: Use macho_header instead

Returns the raw Mach-O file header.

pub fn macho_header(&self) -> &'data Mach

Get the raw Mach-O file header.

pub fn macho_load_commands( &self, ) -> Result<LoadCommandIterator<'data, Mach::Endian>>

Get the Mach-O load commands.

pub fn macho_symbol_table(&self) -> &SymbolTable<'data, Mach, R>

Get the Mach-O symbol table.

Returns an empty symbol table if the file has no symbol table.

pub fn build_version( &self, ) -> Result<Option<&'data BuildVersionCommand<Mach::Endian>>>

Return the LC_BUILD_VERSION load command if present.

Trait Implementations

impl<'data, Mach, R> Debug for MachOFile<'data, Mach, R>

where Mach: MachHeader + Debug, R: ReadRef<'data> + Debug, Mach::Endian: Debug,

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

Formats the value using the given formatter.

impl<'data, Mach, R> Object<'data> for MachOFile<'data, Mach, R>

where Mach: MachHeader, R: ReadRef<'data>,

type Segment<'file> = MachOSegment<'data, 'file, Mach, R> where Self: 'file, 'data: 'file

A loadable segment in the object file.

type SegmentIterator<'file> = MachOSegmentIterator<'data, 'file, Mach, R> where Self: 'file, 'data: 'file

An iterator for the loadable segments in the object file.

type Section<'file> = MachOSection<'data, 'file, Mach, R> where Self: 'file, 'data: 'file

A section in the object file.

type SectionIterator<'file> = MachOSectionIterator<'data, 'file, Mach, R> where Self: 'file, 'data: 'file

An iterator for the sections in the object file.

type Comdat<'file> = MachOComdat<'data, 'file, Mach, R> where Self: 'file, 'data: 'file

A COMDAT section group in the object file.

type ComdatIterator<'file> = MachOComdatIterator<'data, 'file, Mach, R> where Self: 'file, 'data: 'file

An iterator for the COMDAT section groups in the object file.

type Symbol<'file> = MachOSymbol<'data, 'file, Mach, R> where Self: 'file, 'data: 'file

A symbol in the object file.

type SymbolIterator<'file> = MachOSymbolIterator<'data, 'file, Mach, R> where Self: 'file, 'data: 'file

An iterator for symbols in the object file.

type SymbolTable<'file> = MachOSymbolTable<'data, 'file, Mach, R> where Self: 'file, 'data: 'file

A symbol table in the object file.

type DynamicRelocationIterator<'file> = NoDynamicRelocationIterator where Self: 'file, 'data: 'file

An iterator for the dynamic relocations in the file.

fn architecture(&self) -> Architecture

Get the architecture type of the file.

fn sub_architecture(&self) -> Option<SubArchitecture>

Get the sub-architecture type of the file if known.

fn is_little_endian(&self) -> bool

Return true if the file is little endian, false if it is big endian.

fn is_64(&self) -> bool

Return true if the file can contain 64-bit addresses.

fn kind(&self) -> ObjectKind

Return the kind of this object.

fn segments(&self) -> MachOSegmentIterator<'data, '_, Mach, R>

Get an iterator for the loadable segments in the file.

fn section_by_name_bytes<'file>( &'file self, section_name: &[u8], ) -> Option<MachOSection<'data, 'file, Mach, R>>

Like Self::section_by_name, but allows names that are not UTF-8.

fn section_by_index( &self, index: SectionIndex, ) -> Result<MachOSection<'data, '_, Mach, R>>

Get the section at the given index.

fn sections(&self) -> MachOSectionIterator<'data, '_, Mach, R>

Get an iterator for the sections in the file.

fn comdats(&self) -> MachOComdatIterator<'data, '_, Mach, R>

Get an iterator for the COMDAT section groups in the file.

fn symbol_by_index( &self, index: SymbolIndex, ) -> Result<MachOSymbol<'data, '_, Mach, R>>

Get the debugging symbol at the given index.

fn symbols(&self) -> MachOSymbolIterator<'data, '_, Mach, R>

Get an iterator for the debugging symbols in the file.

fn symbol_table(&self) -> Option<MachOSymbolTable<'data, '_, Mach, R>>

Get the debugging symbol table, if any.

fn dynamic_symbols(&self) -> MachOSymbolIterator<'data, '_, Mach, R>

Get an iterator for the dynamic linking symbols in the file.

fn dynamic_symbol_table(&self) -> Option<MachOSymbolTable<'data, '_, Mach, R>>

Get the dynamic linking symbol table, if any.

fn object_map(&self) -> ObjectMap<'data>

Construct a map from addresses to symbol names and object file names.

fn imports(&self) -> Result<Vec<Import<'data>>>

Get the imported symbols.

fn exports(&self) -> Result<Vec<Export<'data>>>

Get the exported symbols that expose both a name and an address.

fn dynamic_relocations(&self) -> Option<NoDynamicRelocationIterator>

Get the dynamic relocations for this file.

fn has_debug_symbols(&self) -> bool

Return true if the file contains DWARF debug information sections, false if not.

fn mach_uuid(&self) -> Result<Option<[u8; 16]>>

The UUID from a Mach-O LC_UUID load command.

fn relative_address_base(&self) -> u64

Get the base address used for relative virtual addresses.

fn entry(&self) -> u64

Get the virtual address of the entry point of the binary.

fn flags(&self) -> FileFlags

File flags that are specific to each file format.

fn endianness(&self) -> Endianness

Get the endianness of the file.

fn section_by_name(&self, section_name: &str) -> Option<Self::Section<'_>>

Get the section named section_name, if such a section exists.

fn symbol_by_name<'file>( &'file self, symbol_name: &str, ) -> Option<Self::Symbol<'file>>

Get the symbol named symbol_name, if the symbol exists.

fn symbol_by_name_bytes<'file>( &'file self, symbol_name: &[u8], ) -> Option<Self::Symbol<'file>>

Like Self::symbol_by_name, but allows names that are not UTF-8.

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

Construct a map from addresses to symbol names.

fn build_id(&self) -> Result<Option<&'data [u8]>>

The build ID from an ELF NT_GNU_BUILD_ID note.

fn gnu_debuglink(&self) -> Result<Option<(&'data [u8], u32)>>

The filename and CRC from a .gnu_debuglink section.

fn gnu_debugaltlink(&self) -> Result<Option<(&'data [u8], &'data [u8])>>

The filename and build ID from a .gnu_debugaltlink section.

fn pdb_info(&self) -> Result<Option<CodeView<'_>>>

The filename and GUID from the PE CodeView section.

impl<'data, Mach, R> Sealed for MachOFile<'data, Mach, R>

where Mach: MachHeader, R: ReadRef<'data>,