public interface

IEImm

implements IEGeneric
com.pnfsoftware.jeb.core.units.code.asm.decompiler.ir.IEImm

Class Overview

An immutable immediate holding a sequence of bits whose interpretation can be:
- an 2-complement arithmetic integer of any length
- a single-precision 32-bit IEEE-754 floating-point value
- a double-precision 64-bit IEEE-754 floating-point value

Summary

Public Methods
abstract IEImm _add(IEImm val)
Perform an addition.
abstract IEImm _and(IEImm val)
Perform a binary-and operation.
abstract IEImm _clearbit(int pos)
Reset a given bit to 0.
abstract int _cmp(IEImm val)
Perform a signed operand comparison.
abstract int _cmpU(IEImm val)
Perform an unsigned operand comparison.
abstract IEImm _div(IEImm val)
Perform a signed division.
abstract IEImm _divU(IEImm val)
Perform an unsigned division.
abstract IEImm _fadd(IEImm val)
Add this IEEE-754 float to another float immediate and return the result.
abstract int _fcmp(IEImm val)
Compare this IEEE-754 float with another float immediate and return 0, +1, -1 depending on the result of the comparison.
abstract IEImm _fdiv(IEImm val)
Divide this IEEE-754 float by another float immediate and return the result.
abstract IEImm _fmul(IEImm val)
Multiply this IEEE-754 float to another float immediate and return the result.
abstract IEImm _fsub(IEImm val)
Subtract the IEEE-754 float parameter from this float immediate and return the result.
abstract IEImm _mul(IEImm val)
Perform a signed multiplication.
abstract IEImm _mulU(IEImm val)
Perform an unsigned multiplication.
abstract IEImm _neg()
Perform a negation.
abstract IEImm _not()
Perform a binary-not operation.
abstract IEImm _or(IEImm val)
Perform a binary-or operation.
abstract IEImm _pow(int exponent)
Perform an exponentiation.
abstract IEImm _rem(IEImm val)
Perform a signed remainder (modulo) operation.
abstract IEImm _remU(IEImm val)
Perform an unsigned remainder (modulo) operation.
abstract IEImm _rol(int cnt)
Perform a left-rotate operation.
abstract IEImm _ror(int cnt)
Perform a right-rotate operation.
abstract IEImm _sar(int cnt)
Perform an arithmetic right-shift operation (sign bit is maintained).
abstract IEImm _setbit(int pos)
Set a given bit to 1.
abstract IEImm _shl(int cnt)
Perform a left-shift operation.
abstract IEImm _shr(int cnt)
Perform a regular right-shift operation.
abstract int _signum()
Retrieve the sign number of this immediate: 0 if 0, -1 if negative, +1 if positive.
abstract IEImm _sub(IEImm val)
Perform a subtraction.
abstract boolean _testbit(int pos)
Test if a given bit is set.
abstract IEImm _xor(IEImm val)
Perform a binary-xor operation.
abstract boolean canReadAsAddress()
abstract boolean canReadAsDoubleFloat()
abstract boolean canReadAsLong()
Determine if this value can fit on a 64-bit long primitive.
abstract boolean canReadAsSingleFloat()
abstract boolean canReadAsUnsignedLong()
Determine if this value can fit as an unsigned long on a 64-bit long primitive (ie, with the MSB is set to 0).
abstract IEImm duplicate()
The resulting copy may not be mutable.
abstract IEImm duplicateToMutable()
Create a mutable copy of this immediate.
abstract IEImm duplicateWithType(IWildcardType type)
Create a mutable copy of this immediate and assign it a type.
abstract IEImm expand(int bits)
Expand (zero-extension) this immediate.
abstract IWildcardType.Group getGroup()
Determine the current group for the immediate: integer or float.
abstract BigInteger getUnsignedValue()
Get this immediate as an unsigned big integer value.
abstract BigInteger getValue()
Get this immediate as a big integer value (signed).
abstract long getValueAsAddress()
Get the immediate value as a primitive long, preferably unsigned.
abstract double getValueAsDoubleFloat()
abstract long getValueAsLong()
Get the immediate value as a signed primitive long.
abstract float getValueAsSingleFloat()
abstract long getValueAsUnsignedLong()
Get the immediate value as an unsigned, zero-extended primitive long.
abstract boolean isMutable()
Determine if this immediate is mutable.
abstract boolean isZero()
Determine whether this immediate has all its bits set to 0.
abstract IEImm normalize()
Normalize this immediate bvy generating an immediate whose internal representation better matches the type.
abstract boolean setCustomAST(ICElement customAST)
Set a custom AST element to be used when generating C code.
abstract IEImm signExtend(int newBitsize)
Sign extend the current IEGeneric.
abstract String toHexString()
Format this immediate as an unsigned hexadecimal string.
abstract IEImm truncate(int bits)
Truncate this immediate or sign-extend it.
abstract IEImm zeroExtend(int newBitsize)
Zero extend the current IEGeneric
[Expand]
Inherited Methods
From interface com.pnfsoftware.jeb.core.units.code.IInstructionOperand
From interface com.pnfsoftware.jeb.core.units.code.asm.decompiler.ir.IEGeneric

Public Methods

public abstract IEImm _add (IEImm val)

Perform an addition.

public abstract IEImm _and (IEImm val)

Perform a binary-and operation.

public abstract IEImm _clearbit (int pos)

Reset a given bit to 0.

public abstract int _cmp (IEImm val)

Perform a signed operand comparison.

Returns
  • 0, 1, or -1

public abstract int _cmpU (IEImm val)

Perform an unsigned operand comparison.

Returns
  • 0, 1, or -1

public abstract IEImm _div (IEImm val)

Perform a signed division.

public abstract IEImm _divU (IEImm val)

Perform an unsigned division.

public abstract IEImm _fadd (IEImm val)

Add this IEEE-754 float to another float immediate and return the result.

public abstract int _fcmp (IEImm val)

Compare this IEEE-754 float with another float immediate and return 0, +1, -1 depending on the result of the comparison. Usual IEEE-754 is assumed (equal: ordered and equal, unequal: unordered or unequal, etc.)

public abstract IEImm _fdiv (IEImm val)

Divide this IEEE-754 float by another float immediate and return the result.

public abstract IEImm _fmul (IEImm val)

Multiply this IEEE-754 float to another float immediate and return the result.

public abstract IEImm _fsub (IEImm val)

Subtract the IEEE-754 float parameter from this float immediate and return the result.

public abstract IEImm _mul (IEImm val)

Perform a signed multiplication.

public abstract IEImm _mulU (IEImm val)

Perform an unsigned multiplication.

public abstract IEImm _neg ()

Perform a negation.

public abstract IEImm _not ()

Perform a binary-not operation.

public abstract IEImm _or (IEImm val)

Perform a binary-or operation.

public abstract IEImm _pow (int exponent)

Perform an exponentiation.

Parameters
exponent must be positive or zero

public abstract IEImm _rem (IEImm val)

Perform a signed remainder (modulo) operation.

public abstract IEImm _remU (IEImm val)

Perform an unsigned remainder (modulo) operation.

public abstract IEImm _rol (int cnt)

Perform a left-rotate operation.

public abstract IEImm _ror (int cnt)

Perform a right-rotate operation.

public abstract IEImm _sar (int cnt)

Perform an arithmetic right-shift operation (sign bit is maintained). The effective count is computed modulo-positive getBitsize().

public abstract IEImm _setbit (int pos)

Set a given bit to 1.

public abstract IEImm _shl (int cnt)

Perform a left-shift operation. The effective count is computed modulo-positive getBitsize().

public abstract IEImm _shr (int cnt)

Perform a regular right-shift operation. The effective count is computed modulo-positive getBitsize().

public abstract int _signum ()

Retrieve the sign number of this immediate: 0 if 0, -1 if negative, +1 if positive.

public abstract IEImm _sub (IEImm val)

Perform a subtraction.

public abstract boolean _testbit (int pos)

Test if a given bit is set.

Returns
  • true if set, false if unset

public abstract IEImm _xor (IEImm val)

Perform a binary-xor operation.

public abstract boolean canReadAsAddress ()

public abstract boolean canReadAsDoubleFloat ()

public abstract boolean canReadAsLong ()

Determine if this value can fit on a 64-bit long primitive.

public abstract boolean canReadAsSingleFloat ()

public abstract boolean canReadAsUnsignedLong ()

Determine if this value can fit as an unsigned long on a 64-bit long primitive (ie, with the MSB is set to 0).

public abstract IEImm duplicate ()

The resulting copy may not be mutable. It will be mutable IFF this object is mutable itself. To ensure that the copy is mutable, use duplicateWithType(IWildcardType) or duplicateToMutable().

Returns
  • the duplicate expression

public abstract IEImm duplicateToMutable ()

Create a mutable copy of this immediate. Those immediates can be assigned types and custom AST elements.

Returns
  • a non-factory controlled, mutable immediate

public abstract IEImm duplicateWithType (IWildcardType type)

Create a mutable copy of this immediate and assign it a type. Those immediates can be assigned types and custom AST elements..

Parameters
type the initial type, may be null
Returns
  • a non-factory controlled, mutable immediate

public abstract IEImm expand (int bits)

Expand (zero-extension) this immediate. If bits if less than the bitsize of this immediate, this method is the same as truncate. If bits is greater than the bitsize of this immediate, then the resulting value is zero-extended.

public abstract IWildcardType.Group getGroup ()

Determine the current group for the immediate: integer or float. Do not confuse with getType(), although the group can be used to infer an appropriate type.

public abstract BigInteger getUnsignedValue ()

Get this immediate as an unsigned big integer value.

public abstract BigInteger getValue ()

Get this immediate as a big integer value (signed).

public abstract long getValueAsAddress ()

Get the immediate value as a primitive long, preferably unsigned. Will raise if the value does not fit on 64-bits.

public abstract double getValueAsDoubleFloat ()

public abstract long getValueAsLong ()

Get the immediate value as a signed primitive long. Will raise if the value does not fit in [LONG_MIN, LONG_MAX] range (64 bits).

public abstract float getValueAsSingleFloat ()

public abstract long getValueAsUnsignedLong ()

Get the immediate value as an unsigned, zero-extended primitive long. Will raise if the value does not fit within [0, LONG_MAX] range (63 bits).

getValueAsLong() is a safer method.

public abstract boolean isMutable ()

Determine if this immediate is mutable. By default, they are not. Use duplicateWithType(IWildcardType) to create a mutable immediate to which a type and custom AST element can be assigned.

public abstract boolean isZero ()

Determine whether this immediate has all its bits set to 0.

Note: do not mix this up with a zero-value equality check. That works if the underlying value is to be interpreted as an 2-complement integer, but may not work if the imm is to be understood as an ieee754 float value.

public abstract IEImm normalize ()

Normalize this immediate bvy generating an immediate whose internal representation better matches the type. If this immediate is not typed, it cannot be normalized. If the immediate is already normalized or cannot be normalized, this method returns null.

Returns
  • a new (normalized) immediate, or null if the imm is already normalized or cannot be normalized

public abstract boolean setCustomAST (ICElement customAST)

Set a custom AST element to be used when generating C code. Reserved for mutable elements.

public abstract IEImm signExtend (int newBitsize)

Sign extend the current IEGeneric. This method will create a valid IEGeneric (meaning IEGeneric will not have duplicates id - in particular, in the form C(x, x.msb()?ones():zeros()) where x will be present in base value and msb predicate)

Parameters
newBitsize must be superior to getBitsize()

public abstract String toHexString ()

Format this immediate as an unsigned hexadecimal string.

public abstract IEImm truncate (int bits)

Truncate this immediate or sign-extend it. If bits if less than the bitsize of this immediate, it is truncated. If bits is greater than the bitsize of this immediate, then the resulting value is sign-extended.

public abstract IEImm zeroExtend (int newBitsize)

Zero extend the current IEGeneric

Parameters
newBitsize must be superior to getBitsize()