Package com.pnfsoftware.jeb.core.units.code.asm.decompiler

Class AbstractNativeDecompilerExtension

java.lang.Object

com.pnfsoftware.jeb.core.AbstractPlugin

com.pnfsoftware.jeb.core.units.code.asm.decompiler.AbstractNativeDecompilerExtension

All Implemented Interfaces:

IPlugin, INativeDecompilerExtension

public abstract class AbstractNativeDecompilerExtension
extends AbstractPlugin
implements INativeDecompilerExtension

Skeleton for native decompiler extensions. Implementations must extend this class, they should not directly implement the extension interface.

Decompiler extensions are of two kinds:
- the primary extension, optionally provided by a decompiler plugin: this extension is always executed first by an extensions manager (and therefore, can decide to stop the execution of any subsequent extension), in the context of its decompiler
- secondary (additional) extensions, provided as external plugins to JEB: those extensions are shared objects among the native decompiler objects instantiated during a session. They must check the type of decompiler before performing meaningful operations (eg, an secondary extension meant to enhance an EVM decompiler should first make sure that it is called within the context of an EVM decompiler)

Field Summary

Fields

Modifier and Type	Field	Description
protected static final ILogger	logger

Constructor Summary

Constructors

Constructor	Description
AbstractNativeDecompilerExtension()	Create an unnamed native decompiler extension.
AbstractNativeDecompilerExtension(String name)	Create a native decompiler extension.

Method Summary

Modifier and Type	Method	Description
ChainedOperationResult<Boolean>	applyAdditionalTypes(IDecompiledMethod target, CFG<IEStatement> cfg)	The default implementation does nothing and requests continuation.
ChainedOperationResult<Boolean>	augmentSimulationContext(INativeDecompilerContext decompiler, IERoutineContext ctx, IESimulationResults simulationContext, long offset, IEStatement insn, EState state)	The default implementation does nothing and requests continuation.
ChainedOperationResult<Boolean>	collectCandidateMemoryDerefs(IEGeneric exp, EDefUseInfo defuse, boolean isDef)	The default implementation does nothing and requests continuation.
ChainedOperationResult<Boolean>	convertInstruction(IEConverter<?> converter, IERoutineContext ctx, ConverterInstructionEntry<?> e)	The default implementation does nothing and requests continuation.
ChainedOperationResult<Boolean>	convertToInlinedCall(IEConverter<?> converter, IERoutineContext ctx, ConverterInstructionEntry<?> e, long target)	The default implementation does nothing and requests continuation.
ChainedOperationResult<Boolean>	customizeIntermediateOptimizer(INativeDecompilerContext decompiler, IEMasterOptimizer mo)	The default implementation does nothing and requests continuation.
ChainedOperationResult<DecompilationStatus>	executePostPipelineStage(NativeDecompilationStage stage, IDecompiledMethod target)	The default implementation returns IN_PROCESS and requests continuation.
ChainedOperationResult<DecompilationStatus>	executePrePipelineStage(NativeDecompilationStage stage, IDecompiledMethod target)	The default implementation returns IN_PROCESS and requests continuation.
String	getName()	Retrieve the extension name.
EditablePluginInformation	getPluginInformation()	Retrieve basic information about the plugin, such as name, version, author, and organization.
ChainedOperationResult<Boolean>	isMemoryResolutionAllowed(INativeDecompilerContext decompiler, IERoutineContext ctx, IEMem mem)	The default implementation does nothing and requests continuation.
ChainedOperationResult<Boolean>	isOpaquePointerType(IWildcardType t)	The default implementation returns false and requests continuation.
ChainedOperationResult<VariableArgumentInformation>	resolveVariableArgumentInformation(IERoutineContext ctx, CFG<IEStatement> cfg, int iblk, IWildcardPrototype proto)	Resolve variable argument information for a routine call.
protected void	setName(String name)

Methods inherited from class com.pnfsoftware.jeb.core.AbstractPlugin

dispose, getData, setData

Methods inherited from class java.lang.Object

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

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

dispose, getData, setData

Field Details

logger

protected static final ILogger logger

Constructor Details

AbstractNativeDecompilerExtension

public AbstractNativeDecompilerExtension()

Create an unnamed native decompiler extension.

AbstractNativeDecompilerExtension

public AbstractNativeDecompilerExtension(String name)

Create a native decompiler extension.

Parameters:

name - extension name

Method Details

setName

protected void setName(String name)

getName

public String getName()

Retrieve the extension name.

Returns:

extension name

getPluginInformation

public EditablePluginInformation getPluginInformation()

Description copied from interface: IPlugin

Retrieve basic information about the plugin, such as name, version, author, and organization.

Specified by:

getPluginInformation in interface IPlugin

Returns:

the plugin information

convertInstruction

public ChainedOperationResult<Boolean> convertInstruction(IEConverter<?> converter,
 IERoutineContext ctx,
 ConverterInstructionEntry<?> e)

The default implementation does nothing and requests continuation.

Specified by:

convertInstruction in interface INativeDecompilerExtension

Parameters:

converter - converter requesting the extension

ctx - routine context

e - the entry to be converted, holding references to the IInstruction and current state of the IR basic block

Returns:

success indicator - upon success, an extension must return TRUE/STOP, else another conversion will be attempted, leading to undefined behavior

convertToInlinedCall

public ChainedOperationResult<Boolean> convertToInlinedCall(IEConverter<?> converter,
 IERoutineContext ctx,
 ConverterInstructionEntry<?> e,
 long target)

The default implementation does nothing and requests continuation.

Specified by:

convertToInlinedCall in interface INativeDecompilerExtension

Parameters:

converter - converter requesting the extension

ctx - routine context

e - instruction entry being converted

target - target native address

Returns:

success indicator

resolveVariableArgumentInformation

public ChainedOperationResult<VariableArgumentInformation> resolveVariableArgumentInformation(IERoutineContext ctx,
 CFG<IEStatement> cfg,
 int iblk,
 IWildcardPrototype proto)

Description copied from interface: INativeDecompilerExtension

Resolve variable argument information for a routine call.

Specified by:

resolveVariableArgumentInformation in interface INativeDecompilerExtension

Parameters:

ctx - routine context

cfg - routine CFG

iblk - block index

proto - call prototype

Returns:

variable argument information, if resolved

executePrePipelineStage

public ChainedOperationResult<DecompilationStatus> executePrePipelineStage(NativeDecompilationStage stage,
 IDecompiledMethod target)

The default implementation returns IN_PROCESS and requests continuation.

Specified by:

executePrePipelineStage in interface INativeDecompilerExtension

Parameters:

stage - the stage about to be executed

target - the method being decompiled

Returns:

DecompilationStatus.IN_PROCESS to continue; for this method, returning DecompilationStatus.COMPLETED means to skip the stage execution (it does not mean the decompilation is complete)

executePostPipelineStage

public ChainedOperationResult<DecompilationStatus> executePostPipelineStage(NativeDecompilationStage stage,
 IDecompiledMethod target)

The default implementation returns IN_PROCESS and requests continuation.

Specified by:

executePostPipelineStage in interface INativeDecompilerExtension

Parameters:

stage - stage that just executed

target - the method being decompiled

Returns:

decompilation status override

applyAdditionalTypes

public ChainedOperationResult<Boolean> applyAdditionalTypes(IDecompiledMethod target,
 CFG<IEStatement> cfg)

The default implementation does nothing and requests continuation.

Specified by:

applyAdditionalTypes in interface INativeDecompilerExtension

Parameters:

target - method being decompiled

cfg - routine CFG

Returns:

success indicator

customizeIntermediateOptimizer

public ChainedOperationResult<Boolean> customizeIntermediateOptimizer(INativeDecompilerContext decompiler,
 IEMasterOptimizer mo)

The default implementation does nothing and requests continuation.

Specified by:

customizeIntermediateOptimizer in interface INativeDecompilerExtension

Parameters:

decompiler - native decompiler context

mo - IR master optimizer

Returns:

success indicator

augmentSimulationContext

public ChainedOperationResult<Boolean> augmentSimulationContext(INativeDecompilerContext decompiler,
 IERoutineContext ctx,
 IESimulationResults simulationContext,
 long offset,
 IEStatement insn,
 EState state)

The default implementation does nothing and requests continuation.

Specified by:

augmentSimulationContext in interface INativeDecompilerExtension

Parameters:

decompiler - native decompiler context

ctx - routine context

simulationContext - simulation context, the extension may record information in this context

offset - IR offset

insn - IR instruction

state - input pre-execution state at the provided instruction

Returns:

success indicator

isMemoryResolutionAllowed

public ChainedOperationResult<Boolean> isMemoryResolutionAllowed(INativeDecompilerContext decompiler,
 IERoutineContext ctx,
 IEMem mem)

The default implementation does nothing and requests continuation.

Specified by:

isMemoryResolutionAllowed in interface INativeDecompilerExtension

Parameters:

decompiler - native decompiler context

ctx - routine context

mem - memory expression considered for resolution

Returns:

resolution policy override

collectCandidateMemoryDerefs

public ChainedOperationResult<Boolean> collectCandidateMemoryDerefs(IEGeneric exp,
 EDefUseInfo defuse,
 boolean isDef)

The default implementation does nothing and requests continuation.

Specified by:

collectCandidateMemoryDerefs in interface INativeDecompilerExtension

Parameters:

exp - an IR expression (in its current form, always an EMem)

defuse - sink for collection; also provides the current IR context

isDef - true if potentially-defined variables are to be collected, false if potentially-used variables are to be collected

Returns:

success indicator

isOpaquePointerType

public ChainedOperationResult<Boolean> isOpaquePointerType(IWildcardType t)

The default implementation returns false and requests continuation.

Specified by:

isOpaquePointerType in interface INativeDecompilerExtension

Parameters:

t - a type

Returns:

true if the type is "opaque"