Package com.pnfsoftware.jeb.core.units.codeobject

Class AbstractCodeObjectUnit

java.lang.Object

com.pnfsoftware.jeb.core.events.JebEventSource

com.pnfsoftware.jeb.core.units.AbstractUnit

com.pnfsoftware.jeb.core.units.AbstractBinaryUnit

com.pnfsoftware.jeb.core.units.codeobject.AbstractCodeObjectUnit

All Implemented Interfaces:

IUnitCreator, IUserDataSupport, ICodeObjectUnit, IBinaryUnit, IUnit, IEventSource

@Ser
public abstract class AbstractCodeObjectUnit
extends AbstractBinaryUnit
implements ICodeObjectUnit

Convenient base class for code objects.

Field Summary

Fields inherited from class com.pnfsoftware.jeb.core.events.JebEventSource

onEventCallCount

Constructor Summary

Constructors

Constructor	Description
AbstractCodeObjectUnit(IInput input, String formatType, String name, IUnitProcessor unitProcessor, IUnitCreator parent, IPropertyDefinitionManager pdm)

Method Summary

Modifier and Type	Method	Description
protected void	addAllSections(Collection<? extends ISegmentInformation> sections)
protected void	addAllSegments(Collection<? extends ISegmentInformation> segments)
protected void	addAllSymbols(Collection<? extends ISymbolInformation> symbols)
protected void	addSection(ISegmentInformation section)
protected void	addSegment(ISegmentInformation segment)
protected boolean	addSymbol(ISymbolInformation symbol)
protected abstract boolean	applyRelocations(IVirtualMemory mem, long base, ILinkInfoProvider linkInfoPrv)	Relocate a mapped code object.
long	convertFileOffsetToRelativeAddress(long offset)	Convert a file offset to a memory address, relative to the base.
long	convertRelativeAddressToFileOffset(long rel)	Convert a memory address (relative to the base) to a file offset.
protected IVirtualMemory	createSuitableMemory()	Create a virtual memory suitable to map this code object.
List<? extends ISymbolInformation>	getExportedSymbols()	Retrieve the list of exported symbols.
List<? extends ISymbolInformation>	getImportedSymbols()	Retrieve the list of imported symbols.
ILoaderInformation	getLoaderInformation()	Retrieve basic information about the object file.
protected IInput	getMappableInput()	Retrieve the input that is truly mappable.
IVirtualMemory	getRawMemoryMappedImage()	Retrieve a raw mapping of the code object.
ISegmentInformation	getSection(int i)
int	getSectionCount()
List<? extends ISegmentInformation>	getSections()	Retrieve the list of sections defined in the object file.
List<? extends ISegmentInformation>	getSections(int wflags, int bflags)	Retrieve a list of sections.
ISegmentInformation	getSegment(int i)
int	getSegmentCount()
List<? extends ISegmentInformation>	getSegments()	Retrieve the list of segments defined in the object file.
List<? extends ISegmentInformation>	getSegments(int wflags, int bflags)	Retrieve a list of segments.
int	getSymbolCount()
Collection<? extends ISymbolInformation>	getSymbols()
List<? extends ISymbolInformation>	getSymbols(int mustHaveFlags, int mustNotHaveFlags)
List<? extends ISegmentInformation>	getValidSections()	Retrieve the list of sections that are not marked INVALID.
List<? extends ISegmentInformation>	getValidSegments()	Retrieve the list of segments that are not marked INVALID.
protected void	insertSection(int index, ISegmentInformation section)
protected void	insertSegment(int index, ISegmentInformation segment)
boolean	map(IVirtualMemory mem, long wantedBase, boolean applyRelocations, ILinkInfoProvider linkInfoPrv)	Map this object file onto virtual memory.
protected boolean	mapRawNoReloc(IVirtualMemory mem, long base)	Map the object's segments at the provided base without applying relocations.
protected void	removeSection(int index)
protected void	removeSegment(int index)
protected void	setLoaderInformation(ILoaderInformation ldInfo)
protected abstract boolean	shouldAllocateFullImage()	Indicate whether the loader should allocate the full image range when preparing to load and map a code object file to memory.

Methods inherited from class com.pnfsoftware.jeb.core.units.AbstractBinaryUnit

getInput, getMimeType, setInput, setMimeType

Methods inherited from class com.pnfsoftware.jeb.core.units.AbstractUnit

addChild, addChild, addChild, addNotification, canBePersisted, clearAllData, dispose, finalize, generateQuickState, getAllData, getChildren, getContributions, getCreationTimestamp, getData, getDescription, getFormatter, getFormatType, getIconData, getInterpreters, getLock, getName, getNotes, getNotificationManager, getParent, getPropertyDefinitionManager, getPropertyManager, getRealName, getStatus, getUid, getUnitProcessor, hasChildren, initializePropertyObjects, internalSwapChildren, isDeserialized, isDisposed, isProcessed, isStale, isTransientChild, logError, logException, logInfo, logTrace, logWarn, onPropertyChange, postDeserialization, process, processInternal, removeChild, removeChild, setChild, setChild, setData, setName, setNotes, setParent, setProcessed, setProcessed, setRealName, setStatus, setStatus, setUnitProcessor, toString

Methods inherited from class com.pnfsoftware.jeb.core.events.JebEventSource

addListener, countListeners, getListeners, getParentSource, insertListener, notifyListeners, notifyListeners, notifyListeners, removeListener, setParentSource

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.pnfsoftware.jeb.core.units.IBinaryUnit

getInput, getMimeType

Methods inherited from interface com.pnfsoftware.jeb.util.events.IEventSource

addListener, countListeners, getListeners, getParentSource, insertListener, notifyListeners, removeListener, setParentSource

Methods inherited from interface com.pnfsoftware.jeb.core.units.IUnit

addChild, addChild, canBePersisted, dispose, execprvfunc, generateQuickState, getChildren, getContributions, getCreationTimestamp, getDescription, getExtraInputs, getFormatter, getFormatType, getIconData, getInterpreters, getLock, getName, getNotes, getNotificationManager, getParent, getParentArtifact, getParentProject, getPropertyDefinitionManager, getPropertyManager, getRealName, getStatus, getUid, getUnitProcessor, initializePropertyObjects, isDisposed, isProcessed, isStale, isTransientChild, notifyGenericChange, postDeserialization, process, removeChild, setName, setNotes, setParent, setRealName, setUnitProcessor

Methods inherited from interface com.pnfsoftware.jeb.core.IUserDataSupport

clearAllData, getAllData, getData, setData

Constructor Details

AbstractCodeObjectUnit

public AbstractCodeObjectUnit(IInput input,
 String formatType,
 String name,
 IUnitProcessor unitProcessor,
 IUnitCreator parent,
 IPropertyDefinitionManager pdm)

Method Details

getLoaderInformation

public ILoaderInformation getLoaderInformation()

Description copied from interface: ICodeObjectUnit

Retrieve basic information about the object file.

Specified by:

getLoaderInformation in interface ICodeObjectUnit

Returns:

the object file information, never null

setLoaderInformation

protected void setLoaderInformation(ILoaderInformation ldInfo)

getSegments

public List<? extends ISegmentInformation> getSegments()

Description copied from interface: ICodeObjectUnit

Retrieve the list of segments defined in the object file. Typically, segments are mapped to memory by a code object loader. Segments and sections may overlap.

Specified by:

getSegments in interface ICodeObjectUnit

Returns:

the list of segments, or null if unsupported

getValidSegments

public List<? extends ISegmentInformation> getValidSegments()

Description copied from interface: ICodeObjectUnit

Retrieve the list of segments that are not marked INVALID.

Specified by:

getValidSegments in interface ICodeObjectUnit

Returns:

getSegments

public List<? extends ISegmentInformation> getSegments(int wflags,
 int bflags)

Description copied from interface: ICodeObjectUnit

Retrieve a list of segments.

Specified by:

getSegments in interface ICodeObjectUnit

Parameters:

wflags - must-have flags

bflags - must-not-have flags

Returns:

getSegment

public ISegmentInformation getSegment(int i)

Specified by:

getSegment in interface ICodeObjectUnit

Returns:

getSegmentCount

public int getSegmentCount()

Specified by:

getSegmentCount in interface ICodeObjectUnit

Returns:

addSegment

protected void addSegment(ISegmentInformation segment)

insertSegment

protected void insertSegment(int index,
 ISegmentInformation segment)

addAllSegments

protected void addAllSegments(Collection<? extends ISegmentInformation> segments)

removeSegment

protected void removeSegment(int index)

getSections

public List<? extends ISegmentInformation> getSections()

Description copied from interface: ICodeObjectUnit

Retrieve the list of sections defined in the object file. Typically, sections are used to point to areas of interest. Sections and segments may overlap.

Specified by:

getSections in interface ICodeObjectUnit

Returns:

the list of sections, or null if unsupported

getValidSections

public List<? extends ISegmentInformation> getValidSections()

Description copied from interface: ICodeObjectUnit

Retrieve the list of sections that are not marked INVALID.

Specified by:

getValidSections in interface ICodeObjectUnit

Returns:

getSections

public List<? extends ISegmentInformation> getSections(int wflags,
 int bflags)

Description copied from interface: ICodeObjectUnit

Retrieve a list of sections.

Specified by:

getSections in interface ICodeObjectUnit

Parameters:

wflags - must-have flags

bflags - must-not-have flags

Returns:

getSection

public ISegmentInformation getSection(int i)

Specified by:

getSection in interface ICodeObjectUnit

Returns:

getSectionCount

public int getSectionCount()

Specified by:

getSectionCount in interface ICodeObjectUnit

Returns:

addSection

protected void addSection(ISegmentInformation section)

insertSection

protected void insertSection(int index,
 ISegmentInformation section)

addAllSections

protected void addAllSections(Collection<? extends ISegmentInformation> sections)

removeSection

protected void removeSection(int index)

getSymbols

public Collection<? extends ISymbolInformation> getSymbols()

Specified by:

getSymbols in interface ICodeObjectUnit

Returns:

getSymbolCount

public int getSymbolCount()

addSymbol

protected boolean addSymbol(ISymbolInformation symbol)

addAllSymbols

protected void addAllSymbols(Collection<? extends ISymbolInformation> symbols)

getImportedSymbols

public List<? extends ISymbolInformation> getImportedSymbols()

Description copied from interface: ICodeObjectUnit

Retrieve the list of imported symbols.

Specified by:

getImportedSymbols in interface ICodeObjectUnit

Returns:

the list (possibly empty) of imported symbols, or null if unsupported

getExportedSymbols

public List<? extends ISymbolInformation> getExportedSymbols()

Description copied from interface: ICodeObjectUnit

Retrieve the list of exported symbols.

Specified by:

getExportedSymbols in interface ICodeObjectUnit

Returns:

the list (possibly empty) of exported symbols, or null if unsupported

getSymbols

public List<? extends ISymbolInformation> getSymbols(int mustHaveFlags,
 int mustNotHaveFlags)

Specified by:

getSymbols in interface ICodeObjectUnit

Returns:

convertFileOffsetToRelativeAddress

public long convertFileOffsetToRelativeAddress(long offset)

Description copied from interface: ICodeObjectUnit

Convert a file offset to a memory address, relative to the base.

Specified by:

convertFileOffsetToRelativeAddress in interface ICodeObjectUnit

Parameters:

offset - a file offset

Returns:

a base-relative memory address, or -1 if unsupported or if the offset does not map to anywhere in memory

convertRelativeAddressToFileOffset

public long convertRelativeAddressToFileOffset(long rel)

Description copied from interface: ICodeObjectUnit

Convert a memory address (relative to the base) to a file offset.

Specified by:

convertRelativeAddressToFileOffset in interface ICodeObjectUnit

Parameters:

rel - the base-relative memory address

Returns:

a file offset, or -1 if unsupported or if the address does not map to anywhere in the file

getRawMemoryMappedImage

public IVirtualMemory getRawMemoryMappedImage()

Description copied from interface: ICodeObjectUnit

Retrieve a raw mapping of the code object. No relocations are applied. Do not attempt to modify the returned VM object; it should be considered read-only.

Specified by:

getRawMemoryMappedImage in interface ICodeObjectUnit

Returns:

the virtual memory containing the mapped, unresolved code object; null on error or if the code object unit decided to not map the object file

map

public boolean map(IVirtualMemory mem,
 long wantedBase,
 boolean applyRelocations,
 ILinkInfoProvider linkInfoPrv)

Description copied from interface: ICodeObjectUnit

Map this object file onto virtual memory.

Specified by:

map in interface ICodeObjectUnit

Parameters:

mem - memory image onto which the mapping should be done

wantedBase - wanted base; set to -1L to request mapping at the normal base

linkInfoPrv - optional

Returns:

success indicator

createSuitableMemory

protected IVirtualMemory createSuitableMemory()

Create a virtual memory suitable to map this code object.

Returns:

mapRawNoReloc

protected boolean mapRawNoReloc(IVirtualMemory mem,
 long base)

Map the object's segments at the provided base without applying relocations.

Parameters:

mem -

base -

Returns:

the VM, null on error

getMappableInput

protected IInput getMappableInput()

Retrieve the input that is truly mappable. The default implementation simply returns AbstractBinaryUnit.getInput(), as is expected in most cases (eg, ELF, PE). For formats requiring pre-processing of the input data, such as IHEX or other ascii-encoded code objects, this method should be overridden.

Returns:

shouldAllocateFullImage

protected abstract boolean shouldAllocateFullImage()

Indicate whether the loader should allocate the full image range when preparing to load and map a code object file to memory.

Typically, the answer is yes for PE-like files, no for ELF-like files.

Returns:

applyRelocations

protected abstract boolean applyRelocations(IVirtualMemory mem,
 long base,
 ILinkInfoProvider linkInfoPrv)

Relocate a mapped code object.

Parameters:

mem - virtual memory

base - mapping base address

linkInfoPrv - optional

Returns: