Package ghidra.app.util.opinion
Class PeLoader
- All Implemented Interfaces:
Loader
,ExtensionPoint
,Comparable<Loader>
Microsoft Portable Executable (PE) loader.
-
Nested Class Summary
Nested classes/interfaces inherited from class ghidra.app.util.opinion.AbstractLibrarySupportLoader
AbstractLibrarySupportLoader.FileSystemSearchPath
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The name of the PE headers memory block.static final String
PE loader option to control parsing CLI headersstatic final String
The name of the PE loaderstatic final String
Loader option to display line numbersFields inherited from class ghidra.app.util.opinion.AbstractOrdinalSupportLoader
ORDINAL_LOOKUP_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
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
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
addExternalReference
(Data pointerData, ImportInfo importInfo, MessageLog log) protected FileBytes
createFileBytes
(ByteProvider provider, Program program, TaskMonitor monitor) findSupportedLoadSpecs
(ByteProvider provider) If thisLoader
supports loading the givenByteProvider
, this methods returns aCollection
of all supportedLoadSpec
s that contain discovered load specification information that thisLoader
will need to load.getDefaultOptions
(ByteProvider provider, LoadSpec loadSpec, DomainObject domainObject, boolean loadIntoProgram) Gets the defaultLoader
options.getName()
protected PortableExecutable.SectionLayout
protected int
getVirtualSize
(PortableExecutable pe, SectionHeader[] sections, AddressSpace space) protected boolean
hasComment
(int type, Address address) protected boolean
Specifies if the library filenames specified by this loader should be exact case match or case-insensitive.protected void
load
(ByteProvider provider, LoadSpec loadSpec, List<Option> options, Program program, TaskMonitor monitor, MessageLog log) Loads bytes in a particular format into the givenProgram
.protected void
processComments
(Listing listing, TaskMonitor monitor) protected void
processDebug
(DebugDirectoryParser parser, NTHeader ntHeader, Map<SectionHeader, Address> sectionToAddress, Program program, List<Option> options, TaskMonitor monitor) protected boolean
processDebugCoffSymbol
(DebugCOFFSymbol symbol, NTHeader ntHeader, Map<SectionHeader, Address> sectionToAddress, Program program, TaskMonitor monitor) protected Map
<SectionHeader, Address> processMemoryBlocks
(PortableExecutable pe, Program prog, FileBytes fileBytes, TaskMonitor monitor, MessageLog log) protected void
setComment
(int type, Address address, String comment) validateOptions
(ByteProvider provider, LoadSpec loadSpec, List<Option> options, Program program) Validates theLoader
'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.AbstractOrdinalSupportLoader
postLoadCleanup, postLoadProgramFixups, processLibrary, shouldSearchAllPaths
Methods inherited from class ghidra.app.util.opinion.AbstractLibrarySupportLoader
createLibraryByteProvider, getCustomLibrarySearchPaths, getLibraryDestinationFolderPath, getLibraryDestinationSearchFolder, getLibraryLoadDepth, getLinkSearchFolder, getTier, getTierPriority, isLinkExistingLibraries, isLoadLibraries, isOptionalLibraryFilenameExtensions, 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, getPreferredFileName, loadsIntoNewFolder, supportsLoadIntoProgram, supportsLoadIntoProgram
-
Field Details
-
PE_NAME
The name of the PE loader- See Also:
-
HEADERS
The name of the PE headers memory block.- See Also:
-
PARSE_CLI_HEADERS_OPTION_NAME
PE loader option to control parsing CLI headers- See Also:
-
SHOW_LINE_NUMBERS_OPTION_NAME
Loader option to display line numbers- See Also:
-
-
Constructor Details
-
PeLoader
public PeLoader()
-
-
Method Details
-
findSupportedLoadSpecs
Description copied from interface:Loader
If thisLoader
supports loading the givenByteProvider
, this methods returns aCollection
of all supportedLoadSpec
s that contain discovered load specification information that thisLoader
will need to load. If thisLoader
cannot support loading the givenByteProvider
, an emptyCollection
is returned.- Parameters:
provider
- The bytes being loaded.- Returns:
- A
Collection
ofLoadSpec
s that thisLoader
supports loading, or an emptyCollection
if thisLoader
doesn't support loading the givenByteProvider
. - Throws:
IOException
- if there was an IO-related issue finding theLoadSpec
s.
-
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 givenProgram
.- Specified by:
load
in classAbstractLibrarySupportLoader
- Parameters:
provider
- The bytes to load.loadSpec
- TheLoadSpec
to use during load.options
- The load options.program
- TheProgram
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.
-
getSectionLayout
-
createFileBytes
protected FileBytes createFileBytes(ByteProvider provider, Program program, TaskMonitor monitor) throws IOException, CancelledException - Throws:
IOException
CancelledException
-
getDefaultOptions
public List<Option> getDefaultOptions(ByteProvider provider, LoadSpec loadSpec, DomainObject domainObject, boolean loadIntoProgram) Description copied from interface:Loader
Gets the defaultLoader
options.- Specified by:
getDefaultOptions
in interfaceLoader
- Parameters:
provider
- The bytes of the thing being loaded.loadSpec
- TheLoadSpec
.domainObject
- TheDomainObject
being loaded.loadIntoProgram
- True if the load is adding to an existingDomainObject
; 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 theLoader
's options and returns null if all options are valid; otherwise, an error message describing the problem is returned.- Specified by:
validateOptions
in interfaceLoader
- Parameters:
provider
- The bytes of the thing being loaded.loadSpec
- The proposedLoadSpec
.options
- The list ofOption
s 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
Option
s are valid; otherwise, an error message describing the problem is returned.
-
isCaseInsensitiveLibraryFilenames
protected boolean isCaseInsensitiveLibraryFilenames()Description copied from class:AbstractLibrarySupportLoader
Specifies if the library filenames specified by this loader should be exact case match or case-insensitive.Derived loader classes should override this method and specify if the OS that normally handles this type of binary is case-insensitive.
- Overrides:
isCaseInsensitiveLibraryFilenames
in classAbstractLibrarySupportLoader
- Returns:
- True if case-insensitive or false if case-sensitive.
-
addExternalReference
-
processMemoryBlocks
protected Map<SectionHeader,Address> processMemoryBlocks(PortableExecutable pe, Program prog, FileBytes fileBytes, TaskMonitor monitor, MessageLog log) throws AddressOverflowException - Throws:
AddressOverflowException
-
getVirtualSize
-
getName
Description copied from interface:Loader
Gets theLoader
's name, which is used both for display purposes, and to identify theLoader
in the opinion files.- Returns:
- The
Loader
's name.
-
processComments
-
processDebug
protected void processDebug(DebugDirectoryParser parser, NTHeader ntHeader, Map<SectionHeader, Address> sectionToAddress, Program program, List<Option> options, TaskMonitor monitor) -
processDebugCoffSymbol
protected boolean processDebugCoffSymbol(DebugCOFFSymbol symbol, NTHeader ntHeader, Map<SectionHeader, Address> sectionToAddress, Program program, TaskMonitor monitor) -
hasComment
-
setComment
-