Package ghidra.app.util.opinion

Class CoffLoader

java.lang.Object

ghidra.app.util.opinion.AbstractProgramLoader

ghidra.app.util.opinion.AbstractLibrarySupportLoader

ghidra.app.util.opinion.CoffLoader

All Implemented Interfaces:

Loader, ExtensionPoint, Comparable<Loader>

Direct Known Subclasses:

MSCoffLoader

public class CoffLoader
extends AbstractLibrarySupportLoader

Nested Class Summary

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

AbstractLibrarySupportLoader.LibrarySearchPath, AbstractLibrarySupportLoader.UnprocessedLibrary

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COFF_NAME
static final String	FAKE_LINK_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

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
CoffLoader()

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 int	getSectionAlignment(CoffSectionHeader section)	Query a section header for alignment information.
boolean	isMicrosoftFormat()
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.AbstractLibrarySupportLoader

createLibraryByteProvider, findLibraryInLoadedList, findLibraryInProject, getCustomLibrarySearchPaths, getLibraryDestinationFolderPath, getLibraryDestinationSearchFolder, getLibraryLoadDepth, getLibrarySearchFolders, getLibrarySearchPaths, getLinkSearchFolder, getTier, getTierPriority, isCaseInsensitiveLibraryFilenames, isLinkExistingLibraries, isLoadLibraries, isOptionalLibraryFilenameExtensions, isValidSearchPath, loadProgram, loadProgramInto, matchSupportedLoadSpec, postLoadProgramFixups, processLibrary, resolveLibraryFile, shouldLoadOnlyLibraries, shouldSearchAllPaths

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

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

COFF_NAME

public static final String COFF_NAME

See Also:

• Constant Field Values

FAKE_LINK_OPTION_NAME

public static final String FAKE_LINK_OPTION_NAME

See Also:

• Constant Field Values

Constructor Details

CoffLoader

public CoffLoader()

Method Details

isMicrosoftFormat

public boolean isMicrosoftFormat()

Returns:

true if this loader assumes the Microsoft variant of the COFF format

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.

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 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.

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.

load

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

Description copied from class: AbstractLibrarySupportLoader

Loads bytes in a particular format into the given Program.

Specified by:

load in class AbstractLibrarySupportLoader

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:

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

CancelledException - if the user cancelled the load.

getSectionAlignment

protected int getSectionAlignment(CoffSectionHeader section)

Query a section header for alignment information. The base version of this method assumes no alignment information is stored in the section header. Subclasses may implement a platform-specific check for alignment information.

Parameters:

section - header object for the section

Returns:

the alignment requested by the section

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.