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 -
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionapplyAdditionalTypes
(IDecompiledMethod target, CFG<IEStatement> cfg) The default implementation does nothing and requests continuation.augmentSimulationContext
(INativeDecompilerContext decompiler, IERoutineContext ctx, IESimulationResults simulationContext, long offset, IEStatement insn, EState state) The default implementation does nothing and requests continuation.collectCandidateMemoryDerefs
(IEGeneric exp, EDefUseInfo defuse, boolean isDef) The default implementation does nothing and requests continuation.convertInstruction
(IEConverter<?> converter, IERoutineContext ctx, ConverterInstructionEntry<?> e) The default implementation does nothing and requests continuation.convertToInlinedCall
(IEConverter<?> converter, IERoutineContext ctx, ConverterInstructionEntry<?> e, long target) The default implementation does nothing and requests continuation.customizeIntermediateOptimizer
(INativeDecompilerContext decompiler, IEMasterOptimizer mo) The default implementation does nothing and requests continuation.executePostPipelineStage
(NativeDecompilationStage stage, IDecompiledMethod target) The default implementation returnsIN_PROCESS
and requests continuation.executePrePipelineStage
(NativeDecompilationStage stage, IDecompiledMethod target) The default implementation returnsIN_PROCESS
and requests continuation.getName()
Retrieve basic information about the plugin, such as name, version, author, and organization.isMemoryResolutionAllowed
(INativeDecompilerContext decompiler, IERoutineContext ctx, IEMem mem) The default implementation does nothing and requests continuation.The default implementation returns false and requests continuation.resolveVariableArgumentInformation
(IERoutineContext ctx, CFG<IEStatement> cfg, int iblk, IWildcardPrototype proto) protected void
Methods inherited from class com.pnfsoftware.jeb.core.AbstractPlugin
dispose, getData, setData
-
Field Details
-
logger
-
-
Constructor Details
-
AbstractNativeDecompilerExtension
public AbstractNativeDecompilerExtension() -
AbstractNativeDecompilerExtension
-
-
Method Details
-
setName
-
getName
-
getPluginInformation
Description copied from interface:IPlugin
Retrieve basic information about the plugin, such as name, version, author, and organization.- Specified by:
getPluginInformation
in interfaceIPlugin
- 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 interfaceINativeDecompilerExtension
e
- the entry to be converted, holding references to theIInstruction
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 interfaceINativeDecompilerExtension
- Returns:
-
resolveVariableArgumentInformation
public ChainedOperationResult<VariableArgumentInformation> resolveVariableArgumentInformation(IERoutineContext ctx, CFG<IEStatement> cfg, int iblk, IWildcardPrototype proto) - Specified by:
resolveVariableArgumentInformation
in interfaceINativeDecompilerExtension
-
executePrePipelineStage
public ChainedOperationResult<DecompilationStatus> executePrePipelineStage(NativeDecompilationStage stage, IDecompiledMethod target) The default implementation returnsIN_PROCESS
and requests continuation.- Specified by:
executePrePipelineStage
in interfaceINativeDecompilerExtension
target
- the method being decompiled- Returns:
-
executePostPipelineStage
public ChainedOperationResult<DecompilationStatus> executePostPipelineStage(NativeDecompilationStage stage, IDecompiledMethod target) The default implementation returnsIN_PROCESS
and requests continuation.- Specified by:
executePostPipelineStage
in interfaceINativeDecompilerExtension
target
- the method being decompiled- Returns:
-
applyAdditionalTypes
public ChainedOperationResult<Boolean> applyAdditionalTypes(IDecompiledMethod target, CFG<IEStatement> cfg) The default implementation does nothing and requests continuation.- Specified by:
applyAdditionalTypes
in interfaceINativeDecompilerExtension
- Returns:
-
customizeIntermediateOptimizer
public ChainedOperationResult<Boolean> customizeIntermediateOptimizer(INativeDecompilerContext decompiler, IEMasterOptimizer mo) The default implementation does nothing and requests continuation.- Specified by:
customizeIntermediateOptimizer
in interfaceINativeDecompilerExtension
mo
- IR master optimizer- Returns:
-
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 interfaceINativeDecompilerExtension
simulationContext
- simulation context, the extension may record information in this contextoffset
- IR offsetinsn
- IR instructionstate
- input pre-execution state at the provided instruction- Returns:
-
isMemoryResolutionAllowed
public ChainedOperationResult<Boolean> isMemoryResolutionAllowed(INativeDecompilerContext decompiler, IERoutineContext ctx, IEMem mem) The default implementation does nothing and requests continuation.- Specified by:
isMemoryResolutionAllowed
in interfaceINativeDecompilerExtension
- Returns:
-
collectCandidateMemoryDerefs
public ChainedOperationResult<Boolean> collectCandidateMemoryDerefs(IEGeneric exp, EDefUseInfo defuse, boolean isDef) The default implementation does nothing and requests continuation.- Specified by:
collectCandidateMemoryDerefs
in interfaceINativeDecompilerExtension
- Parameters:
exp
- an IR expression (in its current form, always an EMem)defuse
- sink for collection; also provides the currentIR context
isDef
- true if potentially-defined variables are to be collected, false if potentially-used variables are to be collected- Returns:
-
isOpaquePointerType
The default implementation returns false and requests continuation.- Specified by:
isOpaquePointerType
in interfaceINativeDecompilerExtension
- Parameters:
t
- a type- Returns:
- true if the type is "opaque"
-