Package ghidra.app.util.bin.format.macho.dyld

Class DyldCacheHeader

java.lang.Object

ghidra.app.util.bin.format.macho.dyld.DyldCacheHeader

All Implemented Interfaces:

StructConverter

public class DyldCacheHeader
extends java.lang.Object
implements StructConverter

Represents a dyld_cache_header structure.

See Also:

dyld3/shared-cache/dyld_cache_format.h

Field Summary

Fields inherited from interface ghidra.app.util.bin.StructConverter

ASCII, BYTE, DWORD, IBO32, IBO64, POINTER, QWORD, STRING, UTF16, UTF8, VOID, WORD

Constructor Summary

Constructors

Constructor	Description
DyldCacheHeader(BinaryReader reader)	Create a new DyldCacheHeader.

Method Summary

Modifier and Type	Method	Description
DyldArchitecture	getArchitecture()	Gets architecture information.
long	getBaseAddress()	Gets the base address of the DYLD cache.
java.util.List<java.lang.Long>	getBranchPoolAddresses()	Gets the List of branch pool address.
java.util.List<DyldCacheMappingAndSlideInfo>	getCacheMappingAndSlideInfos()	Gets the List of DyldCacheMappingAndSlideInfos.
int	getImagesCount()	Gets the number of DyldCacheImageInfos.
int	getImagesOffset()	Gets the file offset to first DyldCacheImageInfo.
DyldCacheLocalSymbolsInfo	getLocalSymbolsInfo()	Gets the DyldCacheLocalSymbolsInfo.
byte[]	getMagic()	Gets the magic bytes, which contain version information.
java.util.List<DyldCacheImage>	getMappedImages()	Generates a List of DyldCacheImages that are mapped in by this DyldCacheHeader.
java.util.List<DyldCacheMappingInfo>	getMappingInfos()	Gets the List of DyldCacheMappingInfos.
java.util.List<DyldCacheSlideInfoCommon>	getSlideInfos()	Gets the List of DyldCacheSlideInfoCommons.
boolean	haSlideInfo()	Checks to see if any slide info exists
void	markup(Program program, AddressSpace space, TaskMonitor monitor, MessageLog log)	Marks up this DyldCacheHeader with data structures and comments.
void	parseFromFile(boolean parseSymbols, MessageLog log, TaskMonitor monitor)	Parses the structures referenced by this DyldCacheHeader from a file.
void	parseFromMemory(Program program, AddressSpace space, MessageLog log, TaskMonitor monitor)	Parses the structures referenced by this DyldCacheHeader from memory.
DataType	toDataType()	Returns a structure datatype representing the contents of the implementor of this interface.
long	unslidLoadAddress()	Get the original unslid load address.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DyldCacheHeader

public DyldCacheHeader(BinaryReader reader)
                throws java.io.IOException

Create a new DyldCacheHeader.

Parameters:

reader - A BinaryReader positioned at the start of a DYLD cache header

Throws:

java.io.IOException - if there was an IO-related problem creating the DYLD cache header

Method Detail

parseFromFile

public void parseFromFile(boolean parseSymbols,
                          MessageLog log,
                          TaskMonitor monitor)
                   throws CancelledException

Parses the structures referenced by this DyldCacheHeader from a file.

Parameters:

parseSymbols - True if symbols should be parsed (could be very slow); otherwise, false

log - The log

monitor - A cancellable task monitor

Throws:

CancelledException - if the user cancelled the operation

parseFromMemory

public void parseFromMemory(Program program,
                            AddressSpace space,
                            MessageLog log,
                            TaskMonitor monitor)
                     throws CancelledException

Parses the structures referenced by this DyldCacheHeader from memory.

Parameters:

program - The Program whose memory to parse

space - The Program's AddressSpace

log - The log

monitor - A cancellable task monitor

Throws:

CancelledException - if the user cancelled the operation

markup

public void markup(Program program,
                   AddressSpace space,
                   TaskMonitor monitor,
                   MessageLog log)
            throws CancelledException

Marks up this DyldCacheHeader with data structures and comments.

Parameters:

program - The Program to mark up

space - The Program's AddressSpace

monitor - A cancellable task monitor

log - The log

Throws:

CancelledException - if the user cancelled the operation

getBaseAddress

public long getBaseAddress()

Gets the base address of the DYLD cache. This is where the cache should be loaded in memory.

Returns:

The base address of the DYLD cache

getMagic

public byte[] getMagic()

Gets the magic bytes, which contain version information.

Returns:

The magic bytes

getMappingInfos

public java.util.List<DyldCacheMappingInfo> getMappingInfos()

Gets the List of DyldCacheMappingInfos. Requires header to have been parsed.

Returns:

The List of DyldCacheMappingInfos

getImagesOffset

public int getImagesOffset()

Gets the file offset to first DyldCacheImageInfo.

Returns:

The file offset to first DyldCacheImageInfo

getImagesCount

public int getImagesCount()

Gets the number of DyldCacheImageInfos.

Returns:

The number of DyldCacheImageInfos

getMappedImages

public java.util.List<DyldCacheImage> getMappedImages()

Generates a List of DyldCacheImages that are mapped in by this DyldCacheHeader. Requires header to have been parsed.

NOTE: A "split" DYLD Cache header may declare an image, but that image may get loaded at an address defined by the memory map of a different split header. This method will only return the images that are mapped by "this" header's memory map.

Returns:

A List of DyldCacheImages mapped by this DyldCacheHeader

getCacheMappingAndSlideInfos

public java.util.List<DyldCacheMappingAndSlideInfo> getCacheMappingAndSlideInfos()

Gets the List of DyldCacheMappingAndSlideInfos. Requires header to have been parsed.

Returns:

The List of DyldCacheMappingAndSlideInfos

getLocalSymbolsInfo

public DyldCacheLocalSymbolsInfo getLocalSymbolsInfo()

Gets the DyldCacheLocalSymbolsInfo.

Returns:

The DyldCacheLocalSymbolsInfo. Could be be null if it didn't parse.

getSlideInfos

public java.util.List<DyldCacheSlideInfoCommon> getSlideInfos()

Gets the List of DyldCacheSlideInfoCommons.

Returns:

the List of DyldCacheSlideInfoCommons.

getBranchPoolAddresses

public java.util.List<java.lang.Long> getBranchPoolAddresses()

Gets the List of branch pool address. Requires header to have been parsed.

Returns:

The List of branch pool address

getArchitecture

public DyldArchitecture getArchitecture()

Gets architecture information.

Returns:

architecture information

toDataType

public DataType toDataType()
                    throws DuplicateNameException,
                           java.io.IOException

Description copied from interface: StructConverter

Returns a structure datatype representing the contents of the implementor of this interface.

For example, given:

 class A {
     int foo;
     double bar;
 }
 

The return value should be a structure data type with two data type components; an INT and a DOUBLE. The structure should contain field names and, if possible, field comments.

Specified by:

toDataType in interface StructConverter

Returns:

returns a structure datatype representing the implementor of this interface

Throws:

DuplicateNameException - when a datatype of the same name already exists

java.io.IOException

See Also:

StructureDataType

haSlideInfo

public boolean haSlideInfo()

Checks to see if any slide info exists

Returns:

True if any slide info exists; otherwise, false

unslidLoadAddress

public long unslidLoadAddress()

Get the original unslid load address. This is found in the first mapping infos.

Returns:

the original unslid load address