IEAssign

Class Overview

IR expression representing an assignment. A special case is the assignment to the PC (see below).

The only valid destination operands of an EAssign are:
- EVar, including PC
- EMem
- ESlice(any_of_the_above_recursively_except_PC)
- ECompose(any_of_the_above_recursively_except_PC)
- EGroupElt

Examples of valid destinations:
- REG1, REG2
- [REG1], [any_memory_address]
- ESlice(REG1), ESlice(ESlice(REG2))
- ECompose(REG1, REG2, REG3)

The following are illegal destinations:
- EImm, ERange or any other irrelevant IRE for a destination-of-assignment position
- ESlice(PC, REG1)
- EComposition(REGX, PC, ...)

Summary

[Expand] Inherited Constants

From interface com.pnfsoftware.jeb.core.units.code.asm.decompiler.ir.IEStatement 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, i.e. int FLAG_OPT_BLOCK_SUBSTITUTIONS Statement having this flag cannot be the recipient of substituted expressions propagated by an expression optimizer.

[Expand] Inherited Methods
From interface com.pnfsoftware.jeb.core.units.code.IInstruction abstract boolean canThrow() Determine if the instruction can throw an exception. abstract IFlowInformation collectIndirectCallReferences(long instructionAddress) Collect the list of dereferenced addresses computed by a call-to-sub instruction. abstract String format(Object context) Format the instruction for printing abstract ACS getACS() abstract IFlowInformation getBreakingFlow(long instructionAddress) Determine if an instruction breaks the flow of execution. abstract byte[] getCode() Get the binary code that makes up this instruction. abstract int getCountOfOperands() abstract void getDefUse(List<Integer> def, List<Integer> use, Object context) Determine the variables defined and used by the instruction. abstract void getDefUse(List<Integer> def, List<Integer> use) Determine the variables defined and used by the instruction. abstract DefUseInfo getDefUseInfo(long instructionAddress, int flags) Determine the variables defined and used by the instruction. abstract Collection<InstructionFlags> getInstructionFlags() abstract String getMnemonic() The instruction mnemonic. abstract IInstructionOperand getOperand(int index) Get an operand by index. abstract IInstructionOperand[] getOperands() Get the list of operands for this instruction. abstract String getPrefix() Get the instruction's optional prefix(es). abstract int getProcessorMode() Get the mode the processor was in when it parsed and created this instruction. abstract IFlowInformation getRoutineCall(long instructionAddress) Determine if an instruction branches to (or calls into) a sub-routine. abstract int getSize() Get the instruction size in bytes.
From interface com.pnfsoftware.jeb.core.units.code.IInstructionOperand abstract String format(IInstruction insn, long address) Format the operand, assuming it is used by an instruction at the provided address.
From interface com.pnfsoftware.jeb.core.units.code.IResizableInstruction abstract void adjustSize(int delta) Update the the size of this statement. abstract void setSize(int newsize) Set the new instruction size.
From interface com.pnfsoftware.jeb.core.units.code.asm.decompiler.ir.IEGeneric abstract boolean accessesMemory() abstract boolean addFlags(int addedFlags) abstract IECompose asCompose() abstract IECond asCond() abstract IEGroup asGroup() abstract IEGroupElt asGroupElt() abstract IEImm asImm() abstract IEMem asMem() abstract IEOperation asOperation() abstract IERange asRange() abstract IESlice asSlice() abstract IEStatement asStatement() abstract IEVar asVar() abstract IEGeneric bit(int pos) Retrieve a one bit value at the pos position abstract void collectSubExpressions(Collection<IEGeneric> sink) Perform a shallow collection of the sub-expressions of this expression. abstract IECond countSuccessiveBits(boolean ones, boolean fromMsb, int bitsize) Count successive bits in an integer, starting from MSB or LSB. abstract IEGeneric duplicate() Clone (deep copy) the expression. abstract boolean equalsEx(Object obj, boolean includeType) Same as #equals() with the possibility to include the type in the comparisson. abstract IEImm evaluate(EState state) Evaluate the IRE. abstract long evaluateAddress(EState state) Evaluate the IRE as a 64-bit address.@return abstract long evaluateUnsignedLong(EState state) Evaluate the IRE as an unsigned long value. abstract boolean examine(Predicate<IEGeneric> tester) Visit the constituents of this expression, and check if one of them is passing the provided test. abstract Couple<IEGeneric, IEGeneric> find(IEGeneric elt, int start, int comparisonMethod, IEGeneric thisParent) Find the parent of the the provided child element. abstract <T extends IEGeneric> T findByType(Class<T> clazz, int start) Find a child element by type. abstract <T extends IEGeneric> T findByType(Class<T> clazz) Find the first child element by type. abstract IEGeneric findParent(IEGeneric elt, int start) Find the parent of the the provided child element. abstract IEGeneric findParent(IEGeneric elt) Find the parent of the first instance of the provided child element. abstract ICElement generateC(IERoutineContext ectx, ICMethod cctx) Generate the C abstract syntax tree portion for this expression. abstract int getBitsize() Get the size, in bits, of the IR expression. abstract void getDefinedOrUsedAsDestination(EDefUseInfo defuse) For non-statements only. abstract void getExplicitlyUsed(EDefUseInfo defuse) Get a list of variable or variable bits 'explicitly used' (read) by the instruction. abstract IdRanges getExplicitlyUsed() Convenience method around #getExplictlyUsed(EDefUseInfo). abstract int getFlags() abstract int getPriority() Get the base priority level of the expression. abstract IWildcardType getSafeType(IWildcardTypeManager etypeman) Generate a safe wildcard type for the expression, if it doesn't already have one. abstract void getSubExpressions(List<IEGeneric> list) This method is deprecated. use collectSubExpressions(Collection) instead abstract IWildcardType getType() Get the currently set intermediate-type. abstract IdRanges getUsed() Convenience method around getUsed(EDefUseInfo). abstract void getUsed(EDefUseInfo defuse) Retrieve the variables or variable bits 'used' (read) by the instruction. abstract boolean hasFlags(int checkedFlags) abstract boolean isCompose() abstract boolean isCond() abstract boolean isGroup() abstract boolean isGroupElt() abstract boolean isImm() abstract boolean isMem() abstract boolean isOperation(String name) abstract boolean isOperation() abstract boolean isOperation(OperationType... candidateOps) abstract boolean isOperation(OperationType expectedOp) abstract boolean isRange() abstract boolean isSlice() abstract boolean isSlice(int wantedStart, int wantedEnd) abstract boolean isStatement() abstract boolean isVar() abstract boolean isVar(int wantedVarId) abstract IEGeneric leftShift(int shift) left shift of an expression abstract IEGeneric leftShift(int shift, int bitsize) left shift of an expression, with an optional slice(int, int) abstract IEGeneric lsb() Return the least significant bit (lsb) of an expression. abstract IEGeneric msb() Return the most significant bit (msb) of an expression. abstract IEGeneric part(int cnt) Equivalent to slice(0, cnt) abstract void removeFlags(int removedFlags) abstract boolean replaceSubExpression(IEGeneric oldExp, IEGeneric newExp) Shallow replacement, by reference. abstract int replaceVar(IEVar var, IEGeneric repl) Deep replace. abstract IEGeneric rightShift(int shift) right shift of an expression abstract IEGeneric rightShift(int shift, int bitsize) right shift of an expression, with an optional slice(int, int) abstract IWildcardType safelyType(IWildcardTypeManager etypeman) Generate and assign a safe wildcard type to the expression if it doesn't already have one. abstract void setFlags(int newFlags) abstract boolean setType(IWildcardType newType, ETypeInfo ti, boolean forceUpdate) Set a pre-propagation intermediate-type. abstract boolean setType(IWildcardType newType, ETypeInfo ti) Set a pre-propagation intermediate-type. abstract boolean setType(IWildcardType type) Set a pre-propagation intermediate-type. abstract IEGeneric signExtend(int newBitsize) Sign extend the current IEGeneric. abstract IEGeneric slice(IERange r) Slice of an IEGeneric. abstract IEGeneric slice(int begin) Equivalent to slice(begin, bitsize). abstract IEGeneric slice(int begin, int end) Slice of an IEGeneric. abstract void updateTypes(ETypeInfo ti) Deep update the types of the constituents of this IRE, update the IRE type as well the direct constituents if needed. abstract void verify() Verify the legality of this IR expression. abstract boolean visitDepthPost(IEVisitor visitor, IEGeneric parent) Depth-first search, post-order visit of an expression tree or sub-tree. abstract boolean visitDepthPost(IEVisitor visitor, IEGeneric parent, EVisitResults results) Depth-first search, post-order visit of an expression tree or sub-tree. abstract boolean visitDepthPost(IEVisitor visitor) Depth-first search, post-order visit of an expression tree or sub-tree. abstract boolean visitDepthPre(IEVisitor visitor, IEGeneric parent) Depth-first search, pre-order visit of an expression tree or sub-tree. abstract boolean visitDepthPre(IEVisitor visitor) Depth-first search, pre-order visit of an expression tree or sub-tree. abstract boolean visitDepthPre(IEVisitor visitor, IEGeneric parent, EVisitResults results) Depth-first search, pre-order visit of an expression tree or sub-tree. abstract IEGeneric zeroExtend(int newBitsize) Zero extend the current IEGeneric
From interface com.pnfsoftware.jeb.core.units.code.asm.decompiler.ir.IEStatement abstract void addLowerLevelAddress(long address) abstract void addLowerLevelAddresses(Collection<Long> addresses) 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. abstract int replaceVar(IEVar var, IEGeneric repl, boolean doNotReplaceDefinedVariables) Deep replace. abstract void resetLowerLevelAddress() abstract void resetLowerLevelAddresses() abstract void setLowerLevelAddress(long address) abstract void setLowerLevelAddresses(Collection<Long> addresses) abstract void setPrimaryLowerLevelAddress(long addr) 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 IEStatement withLowerLevelAddress(long address) abstract IEStatement withLowerLevelAddresses(Collection<Long> addresses) abstract boolean writesMemory()