Packages

trait Instruction extends InstructionLike

Common superclass of all instructions which are in their final form.

Source
Instruction.scala
Linear Supertypes
InstructionLike, AnyRef, Any
Known Subclasses
AALOAD, AASTORE, ACONST_NULL, ALOAD, ALOAD_0, ALOAD_1, ALOAD_2, ALOAD_3, ALoadInstruction, ANEWARRAY, ARETURN, ARRAYLENGTH, ASTORE, ASTORE_0, ASTORE_1, ASTORE_2, ASTORE_3, AStoreInstruction, ATHROW, AddInstruction, AlwaysSucceedingStackBasedBinaryArithmeticInstruction, ArithmeticInstruction, ArrayAccessInstruction, ArrayLoadInstruction, ArrayStoreInstruction, BALOAD, BASTORE, BIPUSH, BitwiseInstruction, CALOAD, CASTORE, CHECKCAST, ComparisonInstruction, CompoundConditionalBranchInstruction, ConditionalBranchInstruction, ConstantALoadInstruction, ConstantIndexAStoreInstruction, ConstantIndexDLoadInstruction, ConstantIndexDStoreInstruction, ConstantIndexFLoadInstruction, ConstantIndexFStoreInstruction, ConstantIndexILoadInstruction, ConstantIndexIStoreInstruction, ConstantIndexLLoadInstruction, ConstantIndexLStoreInstruction, ConstantLengthInstruction, ControlTransferInstruction, CreateNewArrayInstruction, CreateNewOneDimensionalArrayInstruction, D2F, D2I, D2L, DADD, DALOAD, DASTORE, DCMPG, DCMPL, DCONST_0, DCONST_1, DConstInstruction, DDIV, DEFAULT_INVOKEDYNAMIC, DLOAD, DLOAD_0, DLOAD_1, DLOAD_2, DLOAD_3, DLoadInstruction, DMUL, DNEG, DREM, DRETURN, DSTORE, DSTORE_0, DSTORE_1, DSTORE_2, DSTORE_3, DSUB, DStoreInstruction, DUP, DUP2, DUP2_X1, DUP2_X2, DUP_X1, DUP_X2, DivideInstruction, ExplicitLocalVariableIndex, F2D, F2I, F2L, FADD, FALOAD, FASTORE, FCMPG, FCMPL, FCONST_0, FCONST_1, FCONST_2, FConstInstruction, FDIV, FLOAD, FLOAD_0, FLOAD_1, FLOAD_2, FLOAD_3, FLoadInstruction, FMUL, FNEG, FREM, FRETURN, FSTORE, FSTORE_0, FSTORE_1, FSTORE_2, FSTORE_3, FSUB, FStoreInstruction, FieldAccess, FieldReadAccess, FieldWriteAccess, FloatingPointDivideInstruction, FloatingPointRemainderInstruction, GETFIELD, GETSTATIC, GOTO, GOTO_W, GotoInstruction, I2B, I2C, I2D, I2F, I2L, I2S, IADD, IALOAD, IAND, IASTORE, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5, ICONST_M1, IConstInstruction, IDIV, IF0Instruction, IFACMPInstruction, IFEQ, IFGE, IFGT, IFICMPInstruction, IFLE, IFLT, IFNE, IFNONNULL, IFNULL, IFXNullInstruction, IF_ACMPEQ, IF_ACMPNE, IF_ICMPEQ, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, IF_ICMPLT, IF_ICMPNE, IINC, ILOAD, ILOAD_0, ILOAD_1, ILOAD_2, ILOAD_3, ILoadInstruction, IMUL, INCOMPLETE_INVOKEDYNAMIC, INCOMPLETE_LDC, INCOMPLETE_LDC2_W, INCOMPLETE_LDC_W, INEG, INSTANCEOF, INVOKEDYNAMIC, INVOKEINTERFACE, INVOKESPECIAL, INVOKESTATIC, INVOKEVIRTUAL, IOR, IREM, IRETURN, ISHL, ISHR, ISTORE, ISTORE_0, ISTORE_1, ISTORE_2, ISTORE_3, ISUB, IStoreInstruction, IUSHR, IXOR, ImplicitLocalVariableIndex, ImplicitValue, IntegerDivideInstruction, IntegerRemainderInstruction, InvocationInstruction, JSR, JSRInstruction, JSR_W, L2D, L2F, L2I, LADD, LALOAD, LAND, LASTORE, LCMP, LCONST_0, LCONST_1, LConstInstruction, LDC, LDC2_W, LDC_W, LDIV, LLOAD, LLOAD_0, LLOAD_1, LLOAD_2, LLOAD_3, LLoadInstruction, LMUL, LNEG, LOOKUPSWITCH, LOR, LREM, LRETURN, LSHL, LSHR, LSTORE, LSTORE_0, LSTORE_1, LSTORE_2, LSTORE_3, LSUB, LStoreInstruction, LUSHR, LXOR, LoadClass, LoadClass_W, LoadConstantInstruction, LoadDouble, LoadDynamic, LoadDynamic2_W, LoadDynamic_W, LoadFloat, LoadFloat_W, LoadInt, LoadInt_W, LoadLocalVariableInstruction, LoadLong, LoadMethodHandle, LoadMethodHandle_W, LoadMethodType, LoadMethodType_W, LoadString, LoadString_W, MONITORENTER, MONITOREXIT, MULTIANEWARRAY, MethodInvocationInstruction, MultiplyInstruction, NEW, NEWARRAY, NOP, NegateInstruction, NonVirtualMethodInvocationInstruction, NumericConversionInstruction, POP, POP2, PUTFIELD, PUTSTATIC, PopInstruction, PrimitiveArrayStoreInstruction, PrimitiveLDC, PrimitiveLDC_W, RET, RETURN, RemainderInstruction, ReturnInstruction, ReturnValueInstruction, SALOAD, SASTORE, SIPUSH, SWAP, ShiftInstruction, SimpleBranchInstruction, SimpleConditionalBranchInstruction, StackBasedArithmeticInstruction, StackBasedBinaryArithmeticInstruction, StackManagementInstruction, StoreLocalVariableInstruction, SubtractInstruction, SynchronizationInstruction, TABLESWITCH, UnaryArithmeticInstruction, UnconditionalBranchInstruction, VirtualMethodInvocationInstruction, WIDE
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Instruction
  2. InstructionLike
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def expressionResult: ExpressionResultLocation

    Returns the location – Stack, Register or NoExpression – where the value computed by this instruction is stored.

    Returns the location – Stack, Register or NoExpression – where the value computed by this instruction is stored. In this case an instruction is only considered to be an expression if it puts a value on the stack or in a register that is the result of some kind of computation; i.e., just copying, duplicating or moving a value between the stack and the registers is not considered to be an expression.

    Definition Classes
    InstructionLike
    Note

    The CHECKCAST instruction is special in the sense that it just inspects the top-most value.

  2. abstract def indexOfNextInstruction(currentPC: Int)(implicit code: Code): Int

    The index of the next instruction in the (sparse) code array.

    The index of the next instruction in the (sparse) code array.

    Note

    This is primarily a convenience method that delegates to the method indexOfNextInstrution(PC,Boolean). However, given that this is also the standard method called by clients, it is often meaningful to directly implement this. In particular since most instructions cannot be modified by wide.

  3. abstract def indexOfNextInstruction(currentPC: Int, modifiedByWide: Boolean): Int

    The index of the next instruction in the code array.

    The index of the next instruction in the code array.

    Definition Classes
    InstructionLike
  4. abstract def indexOfReadLocal: Int

    The index of the local (variable)/register that is read is returned.

    The index of the local (variable)/register that is read is returned. This method is only defined if readsLocal returns true.

    Definition Classes
    InstructionLike
    Annotations
    @throws("thrown if no local variable is read")
  5. abstract def indexOfWrittenLocal: Int

    The index of the local (variable)/register that is written.

    The index of the local (variable)/register that is written. This method is only defined if writesLocal returns true.

    Definition Classes
    InstructionLike
    Annotations
    @throws("thrown if no local variable is written")
  6. abstract def isIsomorphic(thisPC: Int, otherPC: Int)(implicit code: Code): Boolean

    Determines if this instruction is isomorphic to the given instruction.

    Determines if this instruction is isomorphic to the given instruction.

    Two instructions are isomporphic if they access the same operand and register values and if the instructions have the same bytecode representation, except of (A) (potential) padding bytes and (B) the branch offset of JSR(_W) instructions. In the first case the branch offsets are corrected by the number of padding bytes and in the second case the absolute addresses are compared (i.e., whether both instructions call the same subroutine).

    For example, an aload_0 instruction is only isomorphic to another aload_0 instruction and is not isomorphic to an aload(0) instruction – though the runtime effect is the same. However, a LOOKUPSWITCH (TABLESWITCH) instruction is considered isomorphic to another respective instruction if the only difference is the number of padding bytes. Furthermore, two JSR(_W) instructions are isomorphic if and only if they jump to the same subroutine.

    Definition Classes
    InstructionLike
    Note

    The number of padding bytes is generally calculated by (otherPC % 4) - (thisPC %4) (=== "padding other" - "padding this") and should be added to the branch offsets of this (XYZ)switch instruction when the branch targets are compared to the other instructions branchoffsets.

    // "padding b" - "padding a"
    // === (3 - (bPC % 4)) - (3 - (aPC % 4))
    // === (aPC % 4) - (bPC %4)
    ,

    this.isIsomorphic(thisPC,thisPC) is always true

  7. abstract def jvmExceptions: List[ObjectType]

    The exceptions that may be thrown by the JVM at runtime if the execution of this instruction fails.

    The exceptions that may be thrown by the JVM at runtime if the execution of this instruction fails. I.e., these are neither exceptions that are explicitly created and then thrown by user code nor errors that may arise due to an invalid code base (in particular LinkageErrors). However, OutOfMemoryErrors are possible.

    Definition Classes
    InstructionLike
    Note

    The returned types always precisely describe the thrown exception; they are not upper bounds. All instructions – except of the InvocationInstructions and the ATHROW$ instruction – will always either succeed, throw a linkage time related exception or throw one of the specified exceptions.

  8. abstract def mayThrowExceptions: Boolean

    Returns true if the evaluation of the instruction may lead to some runtime exception.

    Returns true if the evaluation of the instruction may lead to some runtime exception. For example, in case of INVOKESTATIC jvmExceptions will return an empty list. However, in general the called method may throw an arbitrary exception.

    Errors (such as LinkageError) related to invalid projects are not considered.

    Definition Classes
    InstructionLike
  9. abstract def mnemonic: String

    The mnemonic of the instruction as defined by the JVM specification.

    The mnemonic of the instruction as defined by the JVM specification.

    Definition Classes
    InstructionLike
  10. abstract def nextInstructions(currentPC: Int, regularSuccessorsOnly: Boolean = false)(implicit code: Code, classHierarchy: ClassHierarchy = ClassHierarchy.PreInitializedClassHierarchy): List[Int]

    Returns the pcs of the instructions that may be executed next at runtime.

    Returns the pcs of the instructions that may be executed next at runtime. This method takes potentially thrown exceptions into account. I.e., every instruction that may throw an exception checks if it is handled locally and – if so – checks if an appropriate handler exists and – if so – also returns the first instruction of the handler. The chain may contain duplicates, iff the state is potentially different when the target instruction is reached.

    regularSuccessorsOnly

    If true, only those instructions are returned which are not related to an exception thrown by this instruction.

    returns

    The absolute addresses of all instructions that may be executed next at runtime.

  11. abstract def numberOfPoppedOperands(ctg: (Int) => ComputationalTypeCategory): Int

    The number of values that are popped from the operand stack.

    The number of values that are popped from the operand stack. Here, long and double values are also counted as one value though they use two stack slots. E.g., IADD (integer add) and LADD (long add) both pop two values and push one value.

    ctg

    A function that returns the computational type category of the value on the operand stack with a given value index. E.g., The top value on the operand stack has index '0' and may occupy one (for category 1 values) or two stack slots (for category 2 values.)

    Definition Classes
    InstructionLike
    Note

    In case of some of the StackManagementInstruction the number of popped values is not fixed. In that case the number depends on the concrete layout of the operand stack. E.g., the POP2 instruction may just pop one categeory 2 value (of type long or double) or two category 1 values.

  12. abstract def numberOfPushedOperands(ctg: (Int) => ComputationalTypeCategory): Int

    The number of values that are put onto the operand stack.

    The number of values that are put onto the operand stack. Here, long and double values are also counted as one value though they use two stack slots. E.g., IADD (integer add) and LADD (long add) both pop two values and push one value.

    ctg

    A function that returns the computational type category of the value on the operand stack with a given value index. The top value on the operand stack has index '0' and may occupy one (for category 1 values) or two stack slots (for category 2 values.)

    Definition Classes
    InstructionLike
    Note

    In case of some of the StackManagementInstruction this number is not fixed. In that case the number depends on the concrete layout of the operand stack. E.g., the DUP2 instruction may just duplicate one categeory 2 value (result is 1) (of type long or double) or two category 1 values (result is 2).

  13. abstract def opcode: Int

    The opcode of the instruction as defined by the JVM specification.

    The opcode of the instruction as defined by the JVM specification. The opcode is a value in the range [0..255].

    Definition Classes
    InstructionLike
  14. abstract def readsLocal: Boolean

    Returns true if this instruction reads/uses a local variable.

    Returns true if this instruction reads/uses a local variable.

    Definition Classes
    InstructionLike
  15. abstract def stackSlotsChange: Int

    The number of stack slots pushed or popped by this instruction.

    The number of stack slots pushed or popped by this instruction.

    Definition Classes
    InstructionLike
    Note

    Overall, each DUP instruction always pushes the same number of stack slots. Only the number of values that are processed may depend on the stack layout.

  16. abstract def toLabeledInstruction(currentPC: Int): LabeledInstruction

    Converts this instruction to a LabeledInstruction, where relative jump targets are replaced by symbols using the program counters of the target instructions as Symbols (i.e., absolute targets).

    Converts this instruction to a LabeledInstruction, where relative jump targets are replaced by symbols using the program counters of the target instructions as Symbols (i.e., absolute targets).

    currentPC

    The pc of the current instruction.

  17. abstract def toString(currentPC: Int): String

    Returns a string representation of this instruction.

    Returns a string representation of this instruction. If this instruction is a (conditional) jump instruction, then the PCs of the target instructions are given absolute address.

    currentPC

    The program counter of this instruction. Used to resolve relative jump targets.

    Definition Classes
    InstructionLike
  18. abstract def writesLocal: Boolean

    Returns true if this instruction writes/updates a local variable.

    Returns true if this instruction writes/updates a local variable.

    Definition Classes
    InstructionLike

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def asATHROW: ATHROW.type
  5. def asArithmeticInstruction: ArithmeticInstruction
  6. def asCompoundConditionalBranchInstruction: CompoundConditionalBranchInstruction
  7. def asControlTransferInstruction: ControlTransferInstruction
  8. def asCreateNewArrayInstruction: CreateNewArrayInstruction
  9. def asGotoInstruction: GotoInstruction
  10. def asIF0Instruction: IF0Instruction[_]
  11. def asIFACMPInstruction: IFACMPInstruction[_]
  12. def asIFICMPInstruction: IFICMPInstruction[_]
  13. def asIFXNullInstruction: IFXNullInstruction[_]
  14. def asIINC: IINC
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def asInvocationInstruction: InvocationInstruction
  17. def asLOOKUPSWITCH: LOOKUPSWITCH
  18. def asLoadLocalVariableInstruction: LoadLocalVariableInstruction
  19. def asMethodInvocationInstruction: MethodInvocationInstruction
  20. def asNEW: NEW
  21. def asReturnInstruction: ReturnInstruction
  22. def asSimpleBranchInstruction: SimpleBranchInstruction
  23. def asSimpleConditionalBranchInstruction: SimpleConditionalBranchInstruction[_]
  24. def asStoreLocalVariableInstruction: StoreLocalVariableInstruction
  25. def asTABLESWITCH: TABLESWITCH
  26. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  31. def isAthrow: Boolean
    Definition Classes
    InstructionLike
  32. def isCheckcast: Boolean
  33. def isCompoundConditionalBranchInstruction: Boolean
  34. def isControlTransferInstruction: Boolean
    Definition Classes
    InstructionLike
  35. def isGotoInstruction: Boolean
  36. def isIINC: Boolean
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. def isInvocationInstruction: Boolean
  39. def isInvokeStatic: Boolean
  40. def isLoadConstantInstruction: Boolean
    Definition Classes
    InstructionLike
  41. def isLoadLocalVariableInstruction: Boolean
  42. def isMethodInvocationInstruction: Boolean
  43. def isMonitorInstruction: Boolean
    Definition Classes
    InstructionLike
  44. def isRET: Boolean
    Definition Classes
    InstructionLike
  45. def isReturnInstruction: Boolean
    Definition Classes
    InstructionLike
  46. def isSimpleBranchInstruction: Boolean
  47. def isSimpleConditionalBranchInstruction: Boolean
  48. def isStackManagementInstruction: Boolean
  49. def isStoreLocalVariableInstruction: Boolean
  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  52. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  53. def similar(other: Instruction): Boolean

    Checks for structural equality of two instructions.

    Checks for structural equality of two instructions.

    Note

    Implemted by using the underlying (compiler generated) equals methods.

  54. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  55. def toString(): String
    Definition Classes
    AnyRef → Any
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from InstructionLike

Inherited from AnyRef

Inherited from Any

Ungrouped