Package ghidra.app.util.opinion

Class MachoLoader

java.lang.Object

ghidra.app.util.opinion.AbstractProgramLoader

ghidra.app.util.opinion.AbstractLibrarySupportLoader

ghidra.app.util.opinion.MachoLoader

All Implemented Interfaces:

Loader, ExtensionPoint, Comparable<Loader>

public class MachoLoader
extends AbstractLibrarySupportLoader

A Loader for Mach-O files.

Nested Class Summary

Nested classes/interfaces inherited from class ghidra.app.util.opinion.AbstractLibrarySupportLoader

AbstractLibrarySupportLoader.LibrarySearchPath, AbstractLibrarySupportLoader.UnprocessedLibrary

Nested classes/interfaces inherited from interface ghidra.app.util.opinion.Loader

Loader.ImporterSettings

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MACH_O_NAME
static final String	REEXPORT_OPTION_NAME

Fields inherited from class ghidra.app.util.opinion.AbstractLibrarySupportLoader

DEPTH_OPTION_NAME, LIBRARY_DEST_FOLDER_OPTION_NAME, LIBRARY_SEARCH_PATH_DUMMY_OPTION_NAME, LINK_EXISTING_OPTION_NAME, LINK_SEARCH_FOLDER_OPTION_NAME, LOAD_LIBRARY_OPTION_NAME, LOAD_ONLY_LIBRARIES_OPTION_NAME, MIRROR_LAYOUT_OPTION_NAME

Fields inherited from class ghidra.app.util.opinion.AbstractProgramLoader

ANCHOR_LABELS_OPTION_NAME, APPLY_LABELS_OPTION_NAME

Fields inherited from interface ghidra.app.util.opinion.Loader

COMMAND_LINE_ARG_PREFIX, loggingDisabled, OPTIONS_PROJECT_SAVE_STATE_KEY

Constructor Summary

Constructors

Constructor	Description
MachoLoader()

Method Summary

Modifier and Type	Method	Description
protected ByteProvider	createLibraryByteProvider(FSRL libFsrl, LoadSpec loadSpec, MessageLog log, TaskMonitor monitor)	Overrides the default implementation to account for Universal Binary (UBI) files.
Collection<LoadSpec>	findSupportedLoadSpecs(ByteProvider provider)	If this Loader supports loading the given ByteProvider, this methods returns a Collection of all supported LoadSpecs that contain discovered load specification information that this Loader will need to load.
List<Option>	getDefaultOptions(ByteProvider provider, LoadSpec loadSpec, DomainObject domainObject, boolean loadIntoProgram, boolean mirrorFsLayout)	Gets the default Loader options.
protected Comparator<String>	getLibraryNameComparator()	Special Mach-O library Comparator to account for a "Versions" subdirectory being inserted in the library lookup path.
String	getName()	Gets the Loader's name, which is used both for display purposes, and to identify the Loader in the opinion files.
protected boolean	isValidSearchPath(FSRL fsrl, Loader.ImporterSettings settings)	Checks to make sure the given search path FSRL is valid before processing it.
void	load(Program program, Loader.ImporterSettings settings)	Loads bytes in a particular format into the given Program.
protected DomainFile	lookupLibraryInFolder(String libraryName, DomainFolder folder)	Special Mach-O library file resolver to account for a "Versions" subdirectory being inserted in the library lookup path.
protected GFile	lookupLibraryInFs(String library, GFileSystem fs)	Special Mach-O library file resolver to account for a "Versions" subdirectory being inserted in the library lookup path.
protected void	postLoadProgramFixups(List<Loaded<Program>> loadedPrograms, Loader.ImporterSettings settings)	This gets called after the given list of loaded programss is finished loading.
protected void	processLibrary(Program lib, String libName, FSRL libFsrl, Queue<AbstractLibrarySupportLoader.UnprocessedLibrary> unprocessed, int depth, Loader.ImporterSettings settings)	Performs optional follow-on actions after an the given library has been loaded
protected boolean	shouldSearchAllPaths(Program program, Loader.ImporterSettings settings)	Checks whether or not to search for libraries using all possible search paths, regardless of what options are set
String	validateOptions(ByteProvider provider, LoadSpec loadSpec, List<Option> options, Program program)	Validates the Loader's options and returns null if all options are valid; otherwise, an error message describing the problem is returned.

Methods inherited from class ghidra.app.util.opinion.AbstractLibrarySupportLoader

findLibraryInLoadedList, findLibraryInProject, getCustomLibrarySearchPaths, getLibraryDestinationFolderPath, getLibraryDestinationSearchFolder, getLibraryLoadDepth, getLibrarySearchFolders, getLibrarySearchPaths, getLinkSearchFolder, getTier, getTierPriority, isLinkExistingLibraries, isLoadLibraries, isMirroredLayout, loadProgram, loadProgramInto, matchSupportedLoadSpec, shouldLoadOnlyLibraries

Methods inherited from class ghidra.app.util.opinion.AbstractProgramLoader

addExternalBlock, createDefaultMemoryBlocks, createProgram, createProgram, generateBlockName, getLanguageService, load, loadInto, markAsFunction, postLoadCleanup, setProgramProperties, shouldApplyProcessorLabelsByDefault

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.app.util.opinion.Loader

compareTo, getPreferredFileName, loadsIntoNewFolder, supportsLoadIntoProgram, supportsLoadIntoProgram

Field Details

MACH_O_NAME

public static final String MACH_O_NAME

See Also:

• Constant Field Values

REEXPORT_OPTION_NAME

public static final String REEXPORT_OPTION_NAME

See Also:

• Constant Field Values

Constructor Details

MachoLoader

public MachoLoader()

Method Details

findSupportedLoadSpecs

public Collection<LoadSpec> findSupportedLoadSpecs(ByteProvider provider)
                                            throws IOException

Description copied from interface: Loader

If this Loader supports loading the given ByteProvider, this methods returns a Collection of all supported LoadSpecs that contain discovered load specification information that this Loader will need to load. If this Loader cannot support loading the given ByteProvider, an empty Collection is returned.

Parameters:

provider - The bytes being loaded.

Returns:

A Collection of LoadSpecs that this Loader supports loading, or an empty Collection if this Loader doesn't support loading the given ByteProvider.

Throws:

IOException - if there was an IO-related issue finding the LoadSpecs.

load

public void load(Program program,
 Loader.ImporterSettings settings)
          throws IOException

Description copied from class: AbstractLibrarySupportLoader

Loads bytes in a particular format into the given Program.

Specified by:

load in class AbstractLibrarySupportLoader

Parameters:

program - The Program to load into.

settings - The Loader.ImporterSettings

Throws:

IOException - if there was an IO-related problem loading.

getDefaultOptions

public List<Option> getDefaultOptions(ByteProvider provider,
 LoadSpec loadSpec,
 DomainObject domainObject,
 boolean loadIntoProgram,
 boolean mirrorFsLayout)

Description copied from interface: Loader

Gets the default Loader options.

Specified by:

getDefaultOptions in interface Loader

Overrides:

getDefaultOptions in class AbstractLibrarySupportLoader

Parameters:

provider - The bytes of the thing being loaded.

loadSpec - The LoadSpec.

domainObject - The DomainObject being loaded.

loadIntoProgram - True if the load is adding to an existing DomainObject; otherwise, false.

mirrorFsLayout - True if the filesystem layout should be mirrored when loading; otherwise, false

Returns:

A list of the Loader's default options.

validateOptions

public String validateOptions(ByteProvider provider,
 LoadSpec loadSpec,
 List<Option> options,
 Program program)

Description copied from interface: Loader

Validates the Loader's options and returns null if all options are valid; otherwise, an error message describing the problem is returned.

Specified by:

validateOptions in interface Loader

Overrides:

validateOptions in class AbstractLibrarySupportLoader

Parameters:

provider - The bytes of the thing being loaded.

loadSpec - The proposed LoadSpec.

options - The list of Options to validate.

program - existing program if the loader is adding to an existing program. If it is a fresh import, then this will be null.

Returns:

null if all Options are valid; otherwise, an error message describing the problem is returned.

getName

public String getName()

Description copied from interface: Loader

Gets the Loader's name, which is used both for display purposes, and to identify the Loader in the opinion files.

Returns:

The Loader's name.

isValidSearchPath

protected boolean isValidSearchPath(FSRL fsrl,
 Loader.ImporterSettings settings)
                             throws CancelledException

Description copied from class: AbstractLibrarySupportLoader

Checks to make sure the given search path FSRL is valid before processing it. Subclasses can override it as needed.

Overrides:

isValidSearchPath in class AbstractLibrarySupportLoader

Parameters:

fsrl - The search path FSRL

settings - The Loader.ImporterSettings

Returns:

True is the search path is valid; otherwise, false

Throws:

CancelledException - if the user cancelled the load

createLibraryByteProvider

protected ByteProvider createLibraryByteProvider(FSRL libFsrl,
 LoadSpec loadSpec,
 MessageLog log,
 TaskMonitor monitor)
                                          throws IOException,
CancelledException

Overrides the default implementation to account for Universal Binary (UBI) files. These must be specially parsed to find the internal file matching the current architecture.

FatHeader is used to parse the file to determine if it is a UBI. If so, each file within the archive is run through the import process until one is found that is successful (meaning it matches the correct architecture). Only one file in the UBI will ever be imported. If the provided file is NOT a UBI, default import method will be invoked.

Creates a ByteProvider for the given library FSRL

Overrides:

createLibraryByteProvider in class AbstractLibrarySupportLoader

Parameters:

libFsrl - The library FSRL to get a ByteProvider for

loadSpec - An optional LoadSpec the ByteProvider should conform to

log - The log

monitor - A cancellable monitor

Returns:

A ByteProvider for the given library FSRL, or null if one could not be created that matches the given LoadSpec

Throws:

IOException - If there was an IO-related issue

CancelledException - If the user cancelled the operation

lookupLibraryInFs

protected GFile lookupLibraryInFs(String library,
 GFileSystem fs)
                           throws IOException

Special Mach-O library file resolver to account for a "Versions" subdirectory being inserted in the library lookup path. For example, a reference to:

/System/Library/Frameworks/Foundation.framework/Foundation

might be found at:

/System/Library/Frameworks/Foundation.framework/Versions/C/Foundation

Looks in the given GFileSystem for the given library using the loader's library name comparator

Overrides:

lookupLibraryInFs in class AbstractLibrarySupportLoader

Parameters:

library - The library. Depending on the type of library, this could be a simple filename or an absolute path.

fs - The file system to look in in

Returns:

A matching library GFile, or null if one was not found

Throws:

IOException - If an IO-related problem occurred

lookupLibraryInFolder

protected DomainFile lookupLibraryInFolder(String libraryName,
 DomainFolder folder)

Special Mach-O library file resolver to account for a "Versions" subdirectory being inserted in the library lookup path. For example, a reference to:

/System/Library/Frameworks/Foundation.framework/Foundation

might be found at:

/System/Library/Frameworks/Foundation.framework/Versions/C/Foundation

Looks in the given DomainFolder for the given name using the loader's library name comparator

Overrides:

lookupLibraryInFolder in class AbstractLibrarySupportLoader

Parameters:

libraryName - The library name to search for (no path included)

folder - The DomainFolder to search in

Returns:

A matching library DomainFile, or null if one was not found

getLibraryNameComparator

protected Comparator<String> getLibraryNameComparator()

Special Mach-O library Comparator to account for a "Versions" subdirectory being inserted in the library lookup path. For example, a reference to:

/System/Library/Frameworks/Foundation.framework/Foundation

might be found at:

/System/Library/Frameworks/Foundation.framework/Versions/C/Foundation

Returns a Comparator for comparing library names.

No assumptions should be made about whether the library name includes path information or not.

Overrides:

getLibraryNameComparator in class AbstractLibrarySupportLoader

Returns:

a Comparator for comparing library names

shouldSearchAllPaths

protected boolean shouldSearchAllPaths(Program program,
 Loader.ImporterSettings settings)

Checks whether or not to search for libraries using all possible search paths, regardless of what options are set

If we aren't loading libraries, we still want to search all paths if the reexport option is set and the Mach-O actually has LC_REEXPORT_DYLIB entries.

Overrides:

shouldSearchAllPaths in class AbstractLibrarySupportLoader

Parameters:

program - The Program being loaded

settings - The Loader.ImporterSettings

Returns:

True if all possible search paths should be used, regardless of what options are set

processLibrary

protected void processLibrary(Program lib,
 String libName,
 FSRL libFsrl,
 Queue<AbstractLibrarySupportLoader.UnprocessedLibrary> unprocessed,
 int depth,
 Loader.ImporterSettings settings)
                       throws IOException,
CancelledException

Performs optional follow-on actions after an the given library has been loaded

The goal here is to add each reexported library to the unprocessed list at the current depth to be sure they get loaded. However, if the current depth is 1, we need to marked them as "discard" so we know not to save them in the end (since their actual depth would have prevented their save as a normal library)

Overrides:

processLibrary in class AbstractLibrarySupportLoader

Parameters:

lib - The loaded library Program

libName - The name of the library

libFsrl - The library FSRL

unprocessed - The Queue of unprocessed libraries

depth - The load depth of the library to load

settings - The Loader.ImporterSettings

Throws:

IOException - If an IO-related error occurred

CancelledException - If the user cancelled the action

postLoadProgramFixups

protected void postLoadProgramFixups(List<Loaded<Program>> loadedPrograms,
 Loader.ImporterSettings settings)
                              throws CancelledException,
IOException

This gets called after the given list of loaded programss is finished loading. It provides subclasses an opportunity to do follow-on actions to the load.

Fix up program's external library entries so that they point to a path in the project.

Adds reexported symbols to each Loaded Program.

Overrides:

postLoadProgramFixups in class AbstractLibrarySupportLoader

Parameters:

loadedPrograms - The loaded programs to be fixed up.

settings - The Loader.ImporterSettings.

Throws:

CancelledException - if the user cancelled the load.

IOException - if there was an IO-related problem loading.