Package ghidra.pcode.exec

Enum Class BytesPcodeArithmetic

java.lang.Object
java.lang.Enum<BytesPcodeArithmetic>
ghidra.pcode.exec.BytesPcodeArithmetic
All Implemented Interfaces:
PcodeArithmetic<byte[]>, Serializable, Comparable<BytesPcodeArithmetic>, Constable
public enum BytesPcodeArithmetic extends Enum<BytesPcodeArithmetic> implements PcodeArithmetic<byte[]>
A p-code arithmetic that operates on concrete byte array values

The arithmetic interprets the arrays as big- or little-endian values, then performs the arithmetic as specified by the p-code operation. The implementation defers to OpBehavior.

  • Enum Constant Details

    • BIG_ENDIAN

      public static final BytesPcodeArithmetic BIG_ENDIAN
      The instance which interprets arrays as big-endian values

    • LITTLE_ENDIAN

      public static final BytesPcodeArithmetic LITTLE_ENDIAN
      The instance which interprets arrays as little-endian values

  • Method Details

    • values

      public static BytesPcodeArithmetic[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static BytesPcodeArithmetic valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forEndian

      public static BytesPcodeArithmetic forEndian(boolean bigEndian)
      Obtain the instance for the given endianness
      Parameters:
      bigEndian - true for BIG_ENDIAN, false of LITTLE_ENDIAN
      Returns:
      the arithmetic

    • forLanguage

      public static BytesPcodeArithmetic forLanguage(Language language)
      Obtain the instance for the given language's endianness
      Parameters:
      language - the language
      Returns:
      the arithmetic

    • getEndian

      public Endian getEndian()
      Description copied from interface: PcodeArithmetic
      Get the endianness of this arithmetic

      Often T is a byte array, or at least represents one abstractly. Ideally, it is an array where each element is an abstraction of a byte. If that is the case, then the arithmetic likely has to interpret those bytes as integral values according to an endianness. This should return that endianness.

      If the abstraction has no notion of endianness, return null. In that case, the both PcodeArithmetic.fromConst(BigInteger, int, boolean) and PcodeArithmetic.fromConst(long, int) must be overridden. Furthermore, unless PcodeArithmetic.toConcrete(Object, Purpose) is guaranteed to throw an exception, then PcodeArithmetic.toBigInteger(Object, Purpose) and PcodeArithmetic.toLong(Object, Purpose) must also be overridden.

      Specified by:
      getEndian in interface PcodeArithmetic<byte[]>
      Returns:
      the endianness or null

    • unaryOp

      public byte[] unaryOp(int opcode, int sizeout, int sizein1, byte[] in1)
      Description copied from interface: PcodeArithmetic
      Apply a unary operator to the given input

      Note the sizes of variables are given, because values don't necessarily have an intrinsic size. For example, a BigInteger may have a minimum encoding size, but that does not necessarily reflect the size of the variable from which is was read.

      Specified by:
      unaryOp in interface PcodeArithmetic<byte[]>
      Parameters:
      opcode - the p-code opcode
      sizeout - the size (in bytes) of the output variable
      sizein1 - the size (in bytes) of the input variable
      in1 - the input value
      Returns:
      the output value

    • binaryOp

      public byte[] binaryOp(int opcode, int sizeout, int sizein1, byte[] in1, int sizein2, byte[] in2)
      Description copied from interface: PcodeArithmetic
      Apply a binary operator to the given inputs

      Note the sizes of variables are given, because values don't necessarily have an intrinsic size. For example, a BigInteger may have a minimum encoding size, but that does not necessarily reflect the size of the variable from which is was read.

      Specified by:
      binaryOp in interface PcodeArithmetic<byte[]>
      Parameters:
      opcode - the operation's opcode. See PcodeOp.
      sizeout - the size (in bytes) of the output variable
      sizein1 - the size (in bytes) of the first (left) input variable
      in1 - the first (left) input value
      sizein2 - the size (in bytes) of the second (right) input variable
      in2 - the second (right) input value
      Returns:
      the output value

    • modBeforeStore

      public byte[] modBeforeStore(int sizeout, int sizeinAddress, byte[] inAddress, int sizeinValue, byte[] inValue)
      Description copied from interface: PcodeArithmetic
      Apply any modifications before a value is stored

      This implements any abstractions associated with PcodeOp.STORE. This is called on the address/offset and the value before the value is actually stored into the state.

      Specified by:
      modBeforeStore in interface PcodeArithmetic<byte[]>
      Parameters:
      sizeout - the size (in bytes) of the output variable
      sizeinAddress - the size (in bytes) of the variable used for indirection
      inAddress - the value used as the address (or offset)
      sizeinValue - the size (in bytes) of the variable to store
      inValue - the value to store
      Returns:
      the modified value to store

    • modAfterLoad

      public byte[] modAfterLoad(int sizeout, int sizeinAddress, byte[] inAddress, int sizeinValue, byte[] inValue)
      Description copied from interface: PcodeArithmetic
      Apply any modifications after a value is loaded

      This implements any abstractions associated with PcodeOp.LOAD. This is called on the address/offset and the value after the value is actually loaded from the state.

      Specified by:
      modAfterLoad in interface PcodeArithmetic<byte[]>
      Parameters:
      sizeout - the size (in bytes) of the output variable
      sizeinAddress - the size (in bytes) of the variable used for indirection
      inAddress - the value used as the address (or offset)
      sizeinValue - the size (in bytes) of the variable loaded
      inValue - the value loaded
      Returns:
      the modified value loaded

    • fromConst

      public byte[] fromConst(byte[] value)
      Description copied from interface: PcodeArithmetic
      Convert the given constant concrete value to type T having the same size.
      Specified by:
      fromConst in interface PcodeArithmetic<byte[]>
      Parameters:
      value - the constant value
      Returns:
      the value as a T

    • toConcrete

      public byte[] toConcrete(byte[] value, PcodeArithmetic.Purpose purpose)
      Description copied from interface: PcodeArithmetic
      Convert, if possible, the given abstract value to a concrete byte array
      Specified by:
      toConcrete in interface PcodeArithmetic<byte[]>
      Parameters:
      value - the abstract value
      purpose - the purpose for which the emulator needs a concrete value
      Returns:
      the array

    • sizeOf

      public long sizeOf(byte[] value)
      Description copied from interface: PcodeArithmetic
      Get the size in bytes, if possible, of the given abstract value

      If the abstract value does not conceptually have a size, throw an exception.

      Specified by:
      sizeOf in interface PcodeArithmetic<byte[]>
      Parameters:
      value - the abstract value
      Returns:
      the size in bytes