Package ghidra.app.util.opinion

Class UnixAoutLoader

java.lang.Object

ghidra.app.util.opinion.AbstractProgramLoader

ghidra.app.util.opinion.AbstractProgramWrapperLoader

ghidra.app.util.opinion.UnixAoutLoader

All Implemented Interfaces:

Loader, ExtensionPoint, Comparable<Loader>

public class UnixAoutLoader
extends AbstractProgramWrapperLoader

A Loader for processing UNIX-style A.out executables

This style was also used by UNIX-like systems such as SunOS, BSD, and VxWorks, as well as some early distributions of Linux. Although there do exist implementations of A.out with 64-bit and \ GNU extensions, this loader does not currently support them.

See Also:

• OSDev.org A.out
• FreeBSD manpage

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPTION_NAME_BASE_ADDR
static final String	UNIX_AOUT_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
UnixAoutLoader()

Method Summary

Modifier and Type	Method	Description
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)	Gets the default Loader options.
String	getName()	Gets the Loader's name, which is used both for display purposes, and to identify the Loader in the opinion files.
protected void	load(ByteProvider provider, LoadSpec loadSpec, List<Option> options, Program program, TaskMonitor monitor, MessageLog log)	Loads bytes in a particular format into the given Program.
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.AbstractProgramWrapperLoader

getTier, getTierPriority, loadProgram, loadProgramInto

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

createDefaultMemoryBlocks, createProgram, generateBlockName, getLanguageService, joinPaths, load, loadInto, markAsFunction, postLoadCleanup, postLoadProgramFixups, release, 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

UNIX_AOUT_NAME

public static final String UNIX_AOUT_NAME

See Also:

• Constant Field Values

OPTION_NAME_BASE_ADDR

public static final String OPTION_NAME_BASE_ADDR

See Also:

• Constant Field Values

Constructor Details

UnixAoutLoader

public UnixAoutLoader()

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

protected void load(ByteProvider provider,
 LoadSpec loadSpec,
 List<Option> options,
 Program program,
 TaskMonitor monitor,
 MessageLog log)
             throws CancelledException,
IOException

Description copied from class: AbstractProgramWrapperLoader

Loads bytes in a particular format into the given Program.

Specified by:

load in class AbstractProgramWrapperLoader

Parameters:

provider - The bytes to load.

loadSpec - The LoadSpec to use during load.

options - The load options.

program - The Program to load into.

monitor - A cancelable task monitor.

log - The message log.

Throws:

CancelledException - if the user cancelled the load.

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

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 AbstractProgramLoader

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.

getDefaultOptions

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

Description copied from interface: Loader

Gets the default Loader options.

Specified by:

getDefaultOptions in interface Loader

Overrides:

getDefaultOptions in class AbstractProgramLoader

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.

Returns:

A list of the Loader's default options.

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.