Package ghidra.app.util.opinion

Class AbstractOrdinalSupportLoader

java.lang.Object

ghidra.app.util.opinion.AbstractProgramLoader

ghidra.app.util.opinion.AbstractLibrarySupportLoader

ghidra.app.util.opinion.AbstractOrdinalSupportLoader

All Implemented Interfaces:

Loader, ExtensionPoint, Comparable<Loader>

Direct Known Subclasses:

DbgLoader, NeLoader, PeLoader

public abstract class AbstractOrdinalSupportLoader
extends AbstractLibrarySupportLoader

An abstract Loader that provides support for programs that link to external libraries with an ordinal mechanism. Supports caching library lookup information to XML files.

Nested Class Summary

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

AbstractLibrarySupportLoader.FileSystemSearchPath

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDINAL_LOOKUP_OPTION_NAME

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

DEPTH_OPTION_NAME, LIBRARY_DEST_FOLDER_OPTION_NAME, LINK_EXISTING_OPTION_NAME, LINK_SEARCH_FOLDER_OPTION_NAME, LOCAL_LIBRARY_OPTION_NAME, SYSTEM_LIBRARY_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, OPTIONS_PROJECT_SAVE_STATE_KEY

Constructor Summary

Constructors

Constructor	Description
AbstractOrdinalSupportLoader()

Method Summary

Modifier and Type	Method	Description
List<Option>	getDefaultOptions(ByteProvider provider, LoadSpec loadSpec, DomainObject domainObject, boolean loadIntoProgram)	Gets the default Loader options.
protected void	postLoadCleanup(boolean success)	This gets called as the final step of the load process.
protected void	postLoadProgramFixups(List<Loaded<Program>> loadedPrograms, Project project, List<Option> options, MessageLog messageLog, TaskMonitor monitor)	This gets called after the given list of loaded programss is finished loading.
protected void	processLibrary(Program lib, String libName, FSRL libFsrl, ByteProvider provider, LoadSpec loadSpec, List<Option> options, MessageLog log, TaskMonitor monitor)	Performs optional follow-on actions after an the given library has been loaded
protected boolean	shouldLoadLibrary(String libName, FSRL libFsrl, ByteProvider provider, LoadSpec loadSpec, MessageLog log)	Checks whether or not the given library should be loaded.
protected boolean	shouldSearchAllPaths(List<Option> options)	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

createLibraryByteProvider, getCustomLibrarySearchPaths, getLibraryDestinationFolderPath, getLibraryDestinationSearchFolder, getLibraryLoadDepth, getLinkSearchFolder, getTier, getTierPriority, isCaseInsensitiveLibraryFilenames, isLinkExistingLibraries, isLoadLocalLibraries, isLoadSystemLibraries, isOptionalLibraryFilenameExtensions, load, loadProgram, loadProgramInto, matchSupportedLoadSpec, resolveLibraryFile

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

concatenatePaths, createDefaultMemoryBlocks, createProgram, generateBlockName, getLanguageService, load, loadInto, markAsFunction, 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, findSupportedLoadSpecs, getName, getPreferredFileName, loadsIntoNewFolder, supportsLoadIntoProgram, supportsLoadIntoProgram

Field Details

ORDINAL_LOOKUP_OPTION_NAME

public static final String ORDINAL_LOOKUP_OPTION_NAME

See Also:

• Constant Field Values

Constructor Details

AbstractOrdinalSupportLoader

public AbstractOrdinalSupportLoader()

Method Details

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.

shouldSearchAllPaths

protected boolean shouldSearchAllPaths(List<Option> options)

Description copied from class: AbstractLibrarySupportLoader

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

Overrides:

shouldSearchAllPaths in class AbstractLibrarySupportLoader

Parameters:

options - a List of Options

Returns:

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

shouldLoadLibrary

protected boolean shouldLoadLibrary(String libName,
 FSRL libFsrl,
 ByteProvider provider,
 LoadSpec loadSpec,
 MessageLog log)
                             throws IOException

Description copied from class: AbstractLibrarySupportLoader

Checks whether or not the given library should be loaded.

It may be appropriate to not load a specific library after examining its bytes.

Overrides:

shouldLoadLibrary in class AbstractLibrarySupportLoader

Parameters:

libName - The name of the library

libFsrl - The library FSRL

provider - The library bytes

loadSpec - The desired LoadSpec

log - The log

Returns:

True if the given library should be loaded; otherwise, false

Throws:

IOException - If an IO-related error occurred

processLibrary

protected void processLibrary(Program lib,
 String libName,
 FSRL libFsrl,
 ByteProvider provider,
 LoadSpec loadSpec,
 List<Option> options,
 MessageLog log,
 TaskMonitor monitor)
                       throws IOException,
CancelledException

Description copied from class: AbstractLibrarySupportLoader

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

Overrides:

processLibrary in class AbstractLibrarySupportLoader

Parameters:

lib - The loaded library Program

libName - The name of the library

libFsrl - The library FSRL

provider - The library bytes

loadSpec - The LoadSpec used for the load

options - The options

log - The log

monitor - A cancelable monitor

Throws:

IOException - If an IO-related error occurred

CancelledException - If the user cancelled the action

postLoadProgramFixups

protected void postLoadProgramFixups(List<Loaded<Program>> loadedPrograms,
 Project project,
 List<Option> options,
 MessageLog messageLog,
 TaskMonitor monitor)
                              throws CancelledException,
IOException

Description copied from class: AbstractProgramLoader

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.

Overrides:

postLoadProgramFixups in class AbstractLibrarySupportLoader

Parameters:

loadedPrograms - The loaded programs to be fixed up.

project - The Project to load into. Could be null if there is no project.

options - The load options.

messageLog - The message log.

monitor - A cancelable task monitor.

Throws:

CancelledException - if the user cancelled the load.

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

postLoadCleanup

protected void postLoadCleanup(boolean success)

Description copied from class: AbstractProgramLoader

This gets called as the final step of the load process. Subclasses may override it to ensure any resources they created can be cleaned up after the load finishes.

NOTE: Subclasses should not use this method to release any Programs they created when failure occurs. That should be done by the subclass as soon as it detects failure has occurred.

Overrides:

postLoadCleanup in class AbstractProgramLoader

Parameters:

success - True if the load completed successfully; otherwise, false