| com.pnfsoftware.jeb.core.units.code.asm.decompiler.ir.IEStatement |
 Known Indirect Subclasses
|
Class Overview
Base class for all IR statements. Statements are specialized expressions. The most common
statement is IEAssign. Additional statements introduced as the IR gets optimized and
refined are: IENop, IECall, IEReturn, IEJump, and
IEJumpFar, IESwitch and the almighty IEUntranslatedInstruction.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | FLAG_LIKELY_EPILOGUE | This instruction has been identified as being part of an epilogue stub. | |||||||||
| int | FLAG_LIKELY_PROLOGUE | This instruction has been identified as being part of a prologue stub. | |||||||||
| int | FLAG_OPT_BLOCK_PROPAGATION | Statement having this flag cannot be propagated, ie they cannot be the source (replacement) expression in substituted expressions. | |||||||||
| int | FLAG_OPT_BLOCK_SUBSTITUTIONS | Statement having this flag cannot be the recipient of substituted expressions propagated by an expression optimizer. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void | addLowerLevelAddress(long address) | ||||||||||
| abstract IEAssign | asAssign() | ||||||||||
| abstract IECall | asCall() | ||||||||||
| abstract IEJump | asJump() | ||||||||||
| abstract IEJumpFar | asJumpFar() | ||||||||||
| abstract IENop | asNop() | ||||||||||
| abstract IEReturn | asReturn() | ||||||||||
| abstract IESwitch | asSwitch() | ||||||||||
| abstract IEUntranslatedInstruction | asUntranslated() | ||||||||||
| abstract void |
collectSubExpressions(Collection<IEGeneric> sink, Boolean usedOnly)
Perform a shallow collection of the sub-expressions of this statement.
| ||||||||||
| abstract void |
collectSubExpressions(Collection<IEGeneric> sink)
Perform a shallow collection of the sub-expressions of this expression.
| ||||||||||
| abstract void |
collectUsedExpressions(Collection<Couple<IEGeneric, IEGeneric>> sink)
Perform a shallow collection of the first-level expressions used by this statement.
| ||||||||||
| abstract void | copyLowerLevelAddresses(IEStatement srcStm) | ||||||||||
| abstract void |
copyProperties(IEStatement srcStm)
Copy over the generic statement properties of the source statement onto this statement.
| ||||||||||
| abstract boolean |
equalsEx(Object obj, boolean includeType, boolean includeContext)
Same as #equals() with the possibility to include the type and the context in the
comparisson.
| ||||||||||
| abstract ICStatement |
generateC(IERoutineContext ectx, ICMethod cctx)
Generate the C abstract syntax tree portion for this expression.
| ||||||||||
| abstract IERoutineContext |
getContext()
Get the decompiled routine context that owns this statement.
| ||||||||||
| abstract void |
getDefUse(EDefUseInfo defuse)
A variant of
getDefUse(java.util.List, java.util.List, Object) used to retrieve the
range of vbits defined and used by the statement. | ||||||||||
| abstract EDefUseInfo |
getDefUseInfo(long instructionAddress, int flags)
Determine the variables defined and used by the instruction.
| ||||||||||
| abstract Collection<Long> | getLowerLevelAddresses() | ||||||||||
| abstract Long | getPrimaryLowerLevelAddress() | ||||||||||
| abstract Integer | getSPDelta() | ||||||||||
| abstract boolean | isAssign() | ||||||||||
| abstract boolean | isAssignTo(int dstVarid) | ||||||||||
| abstract boolean | isAssignTo(IEVar dst) | ||||||||||
| abstract boolean | isAssignToVar() | ||||||||||
| abstract boolean | isCall() | ||||||||||
| abstract boolean |
isConditionalJump()
Determine if this IR is a conditional
IEJump, i.e. | ||||||||||
| abstract boolean | isConditionalJumpFar() | ||||||||||
| abstract boolean | isJump() | ||||||||||
| abstract boolean | isJumpFar() | ||||||||||
| abstract boolean | isNop() | ||||||||||
| abstract boolean | isReturn() | ||||||||||
| abstract boolean | isSwitch() | ||||||||||
| abstract boolean |
isUnconditionalJump()
Determine if this IR is a simple
goto, that is, an unconditional IEJump, i.e. | ||||||||||
| abstract boolean | isUnconditionalJumpFar() | ||||||||||
| abstract boolean | isUntranslatedInstruction() | ||||||||||
| abstract void |
postUpdateTypes(ETypeInfo ti)
Called once by the normalizer component in later stages.
| ||||||||||
| abstract void |
preUpdateTypes(ETypeInfo ti)
Called once by the type setter component during the typing stage, before propagating all
types to the IR elements.
| ||||||||||
| abstract void | removeLowerLevelAddress(long address) | ||||||||||
| abstract int |
replaceDefinedVar(IEVar var, IEGeneric repl)
Replace (deep) the variables that are defined by this statement.
| ||||||||||
| abstract int |
replaceUsedVar(IEVar var, IEGeneric repl)
Replace (deep) the variables that are defined by this statement.@return
| ||||||||||
| abstract int |
replaceVar(IEVar var, IEGeneric repl, boolean doNotReplaceDefinedVariables)
Deep replace.
| ||||||||||
| abstract void | resetLowerLevelAddress() | ||||||||||
| abstract void | setSPDelta(Integer delta) | ||||||||||
| abstract boolean | visitInstruction(IEVisitor visitor) | ||||||||||
| abstract boolean | visitInstruction(IEVisitor visitor, boolean skipAssignmentDestination) | ||||||||||
| abstract boolean | visitInstructionPostOrder(IEVisitor visitor, boolean skipAssignmentDestination) | ||||||||||
| abstract boolean | visitInstructionPreOrder(IEVisitor visitor, boolean skipAssignmentDestination) | ||||||||||
| abstract boolean | writesMemory() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.pnfsoftware.jeb.core.units.code.IInstruction
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.units.code.IInstructionOperand
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.units.code.IResizableInstruction
| |||||||||||
|
From interface
com.pnfsoftware.jeb.core.units.code.asm.decompiler.ir.IEGeneric
| |||||||||||
Constants
public static final int FLAG_LIKELY_EPILOGUE
This instruction has been identified as being part of an epilogue stub.
A routine's epilogue is a small instruction stub responsible for restoring registers previously saved by the prologue as well as freeing space that may have been allocated on the stack.
public static final int FLAG_LIKELY_PROLOGUE
This instruction has been identified as being part of a prologue stub.
A routine's prologue is a small instruction stub responsible for saving registers that need to be preserved as well as allocating some space on the stack.
public static final int FLAG_OPT_BLOCK_PROPAGATION
Statement having this flag cannot be propagated, ie they cannot be the source (replacement) expression in substituted expressions.
Note: even in AGGRESSIVE mode, this flag is NOT ignored.
Eg, in the example below, r0 in instruction A will not be propagated to B.
A) r0 = r1 <---- marked FLAG_OPT_BLOCK_PROPAGATION ... B) r4 = .... + r0 + ...
public static final int FLAG_OPT_BLOCK_SUBSTITUTIONS
Statement having this flag cannot be the recipient of substituted expressions propagated by an expression optimizer.
Note: even in AGGRESSIVE mode, this flag is NOT ignored.
Eg, in the example below, r0 in instruction A could be (under conditions) substituted in instruction B. However, if instruction B has FLAG_OPT_BLOCK_SUBSTITUTIONS set, that candidate substitution will be prevented, regardless of other factors.
A) r0 = r1 ... B) r4 = .... + r0 + ... <---- marked FLAG_OPT_BLOCK_SUBSTITUTIONSNote that this flag does not prevent the statement itself to be the source of a substitution. (To prevent that, use
FLAG_OPT_BLOCK_PROPAGATION.)
Eg, in the example below, r0 of A can be propagated to B (with A ending up discarded), even though A is marked FLAG_OPT_BLOCK_SUBSTITUTIONS.
A) r0 = r1 <---- marked FLAG_OPT_BLOCK_SUBSTITUTIONS ... B) r4 = .... + r0 + ...
Public Methods
public abstract void addLowerLevelAddress (long address)
public abstract void collectSubExpressions (Collection<IEGeneric> sink, Boolean usedOnly)
Perform a shallow collection of the sub-expressions of this statement. All collected expressions are directly rooted in this IRE (i.e. their parent is this IR expression).
Parameters
| sink | recipient (elements are appended) |
|---|---|
| usedOnly | if null: all top-level elements are collected (same as
collectSubExpressions(Collection)); else:- if false: only defined (written) top-level sub-expressions are collected - if true: only used (read) top-level sub-expressions are collected |
public abstract void collectSubExpressions (Collection<IEGeneric> sink)
Perform a shallow collection of the sub-expressions of this expression. All collected expressions are directly rooted in this IRE (i.e. their parent is this IR expression).
This method appends to the provided sink (existing elements are not cleared). The current element (this) is not appended; only the sub-expressions are considered.
public abstract void collectUsedExpressions (Collection<Couple<IEGeneric, IEGeneric>> sink)
Perform a shallow collection of the first-level expressions used by this statement.
Invoking this method is not the same as calling collectSubExpressions(sink, true)!
This method examines top-level defined (written) expressions that are EMem; the
memory reference of those EMems are returned. Therefore, not all values returned by this
method are directly rooted in this IRE. It is for that reasons that this method returns a
collection of tuples (parent, expression) instead of a simple collection of expressions.
Parameters
| sink | a collection of tuples (parent, expression) |
|---|
public abstract void copyProperties (IEStatement srcStm)
Copy over the generic statement properties of the source statement onto this statement. Only
generic (common) properties should be ported. The context is not copied
over. Some properties are overwritten, others are completed (augmented).
public abstract boolean equalsEx (Object obj, boolean includeType, boolean includeContext)
Same as #equals() with the possibility to include the type and the context in the comparisson.
Parameters
| obj | object to compare |
|---|
public abstract ICStatement generateC (IERoutineContext ectx, ICMethod cctx)
Generate the C abstract syntax tree portion for this expression.
Parameters
| ectx | IR routine context |
|---|---|
| cctx | C routine local context |
Returns
- the C AST element (may contain sub-elements)
public abstract IERoutineContext getContext ()
Get the decompiled routine context that owns this statement.
public abstract void getDefUse (EDefUseInfo defuse)
A variant of getDefUse(java.util.List, java.util.List, Object) used to retrieve the
range of vbits defined and used by the statement.
public abstract EDefUseInfo getDefUseInfo (long instructionAddress, int flags)
Determine the variables defined and used by the instruction. This method is an extended
version of getDefUse(List, List, Object).@return
Parameters
| instructionAddress | address of the instruction |
|---|---|
| flags | see DefUseInfo.XXX static final flags |
public abstract Collection<Long> getLowerLevelAddresses ()
Returns
- the returned collection does not contain duplicates; the first entry is the primary
lower-level address (if there are multiple native addresses mapping to this IR
statement,
getLowerLevelAddresses()would return 2+ entries)
public abstract Long getPrimaryLowerLevelAddress ()
Returns
- the primary native address; null if this IR does not contain lower-mapping information
public abstract Integer getSPDelta ()
public abstract boolean isAssign ()
public abstract boolean isAssignTo (int dstVarid)
public abstract boolean isAssignToVar ()
public abstract boolean isCall ()
public abstract boolean isConditionalJump ()
Determine if this IR is a conditional IEJump, i.e. getCondition() is
not null.
public abstract boolean isConditionalJumpFar ()
public abstract boolean isJump ()
public abstract boolean isJumpFar ()
public abstract boolean isNop ()
public abstract boolean isReturn ()
public abstract boolean isSwitch ()
public abstract boolean isUnconditionalJump ()
Determine if this IR is a simple goto, that is, an unconditional IEJump, i.e.
getCondition() is null.
public abstract boolean isUnconditionalJumpFar ()
public abstract boolean isUntranslatedInstruction ()
public abstract void postUpdateTypes (ETypeInfo ti)
Called once by the normalizer component in later stages. Implementations may perform IRE
replacement, unlike updateTypes's.
public abstract void preUpdateTypes (ETypeInfo ti)
Called once by the type setter component during the typing stage, before propagating all
types to the IR elements. Implementations may perform IRE replacement, unlike
updateTypes's.
public abstract void removeLowerLevelAddress (long address)
public abstract int replaceDefinedVar (IEVar var, IEGeneric repl)
Replace (deep) the variables that are defined by this statement.
public abstract int replaceUsedVar (IEVar var, IEGeneric repl)
Replace (deep) the variables that are defined by this statement.@return
Throws
| IllegalIntermediateExpressionException | if an illegal replacement was attempted |
|---|
public abstract int replaceVar (IEVar var, IEGeneric repl, boolean doNotReplaceDefinedVariables)
Deep replace. Specialized version allows used-vars replacement only. The implementation is responsible for IRE duplication before statements, to ensure that the resulting statement or group of statement does not contain duplicate references to mutable objects.@return
Throws
| IllegalIntermediateExpressionException | if an illegal replacement was attempted |
|---|