Package ghidra.app.util.opinion

Class ElfLoader

java.lang.Object

ghidra.app.util.opinion.AbstractProgramLoader

ghidra.app.util.opinion.AbstractLibrarySupportLoader

ghidra.app.util.opinion.ElfLoader

All Implemented Interfaces:

Loader, ExtensionPoint, Comparable<Loader>

public class ElfLoader
extends AbstractLibrarySupportLoader

A Loader for processing executable and linking files (ELF).

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	ELF_ENTRY_FUNCTION_NAME
static final String	ELF_FILE_TYPE_PROPERTY
static final String	ELF_NAME
static final String	ELF_ORIGINAL_IMAGE_BASE_PROPERTY
static final String	ELF_PRELINKED_PROPERTY
static final String	ELF_SOURCE_FILE_PROPERTY_PREFIX

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

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.
static Long	getElfOriginalImageBase(Program program)	Getter for the ELF_ORIGINAL_IMAGE_BASE_PROPERTY property.
String	getName()	Gets the Loader's name, which is used both for display purposes, and to identify the Loader in the opinion files.
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.
protected void	postLoadProgramFixups(List<Loaded<Program>> loadedPrograms, Project project, LoadSpec loadSpec, List<Option> options, MessageLog messageLog, TaskMonitor monitor)	This gets called after the given list of loaded programss is finished loading.
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, 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

ELF_NAME

public static final String ELF_NAME

See Also:

• Constant Field Values

ELF_ENTRY_FUNCTION_NAME

public static final String ELF_ENTRY_FUNCTION_NAME

See Also:

• Constant Field Values

ELF_FILE_TYPE_PROPERTY

public static final String ELF_FILE_TYPE_PROPERTY

See Also:

• Constant Field Values

ELF_ORIGINAL_IMAGE_BASE_PROPERTY

public static final String ELF_ORIGINAL_IMAGE_BASE_PROPERTY

See Also:

• Constant Field Values

ELF_PRELINKED_PROPERTY

public static final String ELF_PRELINKED_PROPERTY

See Also:

• Constant Field Values

ELF_SOURCE_FILE_PROPERTY_PREFIX

public static final String ELF_SOURCE_FILE_PROPERTY_PREFIX

See Also:

• Constant Field Values

Constructor Details

ElfLoader

public ElfLoader()

Method Details

getElfOriginalImageBase

public static Long getElfOriginalImageBase(Program program)

Getter for the ELF_ORIGINAL_IMAGE_BASE_PROPERTY property.

Parameters:

program - Ghidra program that has the property to get

Returns:

Long value of the original image base, or null if the property is not present

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.

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

postLoadProgramFixups

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

Description copied from class: AbstractLibrarySupportLoader

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.

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.

loadSpec - The LoadSpec to use during load.

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.

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.