blob: d2d043663575daecea6c7aa2fc310c9b6c8d4e3b [file] [log] [blame]
/*
* Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package org.graalvm.compiler.bytecode;
import static org.graalvm.compiler.bytecode.Bytecodes.Flags.ASSOCIATIVE;
import static org.graalvm.compiler.bytecode.Bytecodes.Flags.BRANCH;
import static org.graalvm.compiler.bytecode.Bytecodes.Flags.COMMUTATIVE;
import static org.graalvm.compiler.bytecode.Bytecodes.Flags.FALL_THROUGH;
import static org.graalvm.compiler.bytecode.Bytecodes.Flags.FIELD_READ;
import static org.graalvm.compiler.bytecode.Bytecodes.Flags.FIELD_WRITE;
import static org.graalvm.compiler.bytecode.Bytecodes.Flags.INVOKE;
import static org.graalvm.compiler.bytecode.Bytecodes.Flags.LOAD;
import static org.graalvm.compiler.bytecode.Bytecodes.Flags.STOP;
import static org.graalvm.compiler.bytecode.Bytecodes.Flags.STORE;
import static org.graalvm.compiler.bytecode.Bytecodes.Flags.TRAP;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
/**
* Definitions of the standard Java bytecodes defined by
* <a href= "http://java.sun.com/docs/books/jvms/second_edition/html/VMSpecTOC.doc.html"> Java
* Virtual Machine Specification</a>.
*/
public class Bytecodes {
// @formatter:off
public static final int NOP = 0; // 0x00
public static final int ACONST_NULL = 1; // 0x01
public static final int ICONST_M1 = 2; // 0x02
public static final int ICONST_0 = 3; // 0x03
public static final int ICONST_1 = 4; // 0x04
public static final int ICONST_2 = 5; // 0x05
public static final int ICONST_3 = 6; // 0x06
public static final int ICONST_4 = 7; // 0x07
public static final int ICONST_5 = 8; // 0x08
public static final int LCONST_0 = 9; // 0x09
public static final int LCONST_1 = 10; // 0x0A
public static final int FCONST_0 = 11; // 0x0B
public static final int FCONST_1 = 12; // 0x0C
public static final int FCONST_2 = 13; // 0x0D
public static final int DCONST_0 = 14; // 0x0E
public static final int DCONST_1 = 15; // 0x0F
public static final int BIPUSH = 16; // 0x10
public static final int SIPUSH = 17; // 0x11
public static final int LDC = 18; // 0x12
public static final int LDC_W = 19; // 0x13
public static final int LDC2_W = 20; // 0x14
public static final int ILOAD = 21; // 0x15
public static final int LLOAD = 22; // 0x16
public static final int FLOAD = 23; // 0x17
public static final int DLOAD = 24; // 0x18
public static final int ALOAD = 25; // 0x19
public static final int ILOAD_0 = 26; // 0x1A
public static final int ILOAD_1 = 27; // 0x1B
public static final int ILOAD_2 = 28; // 0x1C
public static final int ILOAD_3 = 29; // 0x1D
public static final int LLOAD_0 = 30; // 0x1E
public static final int LLOAD_1 = 31; // 0x1F
public static final int LLOAD_2 = 32; // 0x20
public static final int LLOAD_3 = 33; // 0x21
public static final int FLOAD_0 = 34; // 0x22
public static final int FLOAD_1 = 35; // 0x23
public static final int FLOAD_2 = 36; // 0x24
public static final int FLOAD_3 = 37; // 0x25
public static final int DLOAD_0 = 38; // 0x26
public static final int DLOAD_1 = 39; // 0x27
public static final int DLOAD_2 = 40; // 0x28
public static final int DLOAD_3 = 41; // 0x29
public static final int ALOAD_0 = 42; // 0x2A
public static final int ALOAD_1 = 43; // 0x2B
public static final int ALOAD_2 = 44; // 0x2C
public static final int ALOAD_3 = 45; // 0x2D
public static final int IALOAD = 46; // 0x2E
public static final int LALOAD = 47; // 0x2F
public static final int FALOAD = 48; // 0x30
public static final int DALOAD = 49; // 0x31
public static final int AALOAD = 50; // 0x32
public static final int BALOAD = 51; // 0x33
public static final int CALOAD = 52; // 0x34
public static final int SALOAD = 53; // 0x35
public static final int ISTORE = 54; // 0x36
public static final int LSTORE = 55; // 0x37
public static final int FSTORE = 56; // 0x38
public static final int DSTORE = 57; // 0x39
public static final int ASTORE = 58; // 0x3A
public static final int ISTORE_0 = 59; // 0x3B
public static final int ISTORE_1 = 60; // 0x3C
public static final int ISTORE_2 = 61; // 0x3D
public static final int ISTORE_3 = 62; // 0x3E
public static final int LSTORE_0 = 63; // 0x3F
public static final int LSTORE_1 = 64; // 0x40
public static final int LSTORE_2 = 65; // 0x41
public static final int LSTORE_3 = 66; // 0x42
public static final int FSTORE_0 = 67; // 0x43
public static final int FSTORE_1 = 68; // 0x44
public static final int FSTORE_2 = 69; // 0x45
public static final int FSTORE_3 = 70; // 0x46
public static final int DSTORE_0 = 71; // 0x47
public static final int DSTORE_1 = 72; // 0x48
public static final int DSTORE_2 = 73; // 0x49
public static final int DSTORE_3 = 74; // 0x4A
public static final int ASTORE_0 = 75; // 0x4B
public static final int ASTORE_1 = 76; // 0x4C
public static final int ASTORE_2 = 77; // 0x4D
public static final int ASTORE_3 = 78; // 0x4E
public static final int IASTORE = 79; // 0x4F
public static final int LASTORE = 80; // 0x50
public static final int FASTORE = 81; // 0x51
public static final int DASTORE = 82; // 0x52
public static final int AASTORE = 83; // 0x53
public static final int BASTORE = 84; // 0x54
public static final int CASTORE = 85; // 0x55
public static final int SASTORE = 86; // 0x56
public static final int POP = 87; // 0x57
public static final int POP2 = 88; // 0x58
public static final int DUP = 89; // 0x59
public static final int DUP_X1 = 90; // 0x5A
public static final int DUP_X2 = 91; // 0x5B
public static final int DUP2 = 92; // 0x5C
public static final int DUP2_X1 = 93; // 0x5D
public static final int DUP2_X2 = 94; // 0x5E
public static final int SWAP = 95; // 0x5F
public static final int IADD = 96; // 0x60
public static final int LADD = 97; // 0x61
public static final int FADD = 98; // 0x62
public static final int DADD = 99; // 0x63
public static final int ISUB = 100; // 0x64
public static final int LSUB = 101; // 0x65
public static final int FSUB = 102; // 0x66
public static final int DSUB = 103; // 0x67
public static final int IMUL = 104; // 0x68
public static final int LMUL = 105; // 0x69
public static final int FMUL = 106; // 0x6A
public static final int DMUL = 107; // 0x6B
public static final int IDIV = 108; // 0x6C
public static final int LDIV = 109; // 0x6D
public static final int FDIV = 110; // 0x6E
public static final int DDIV = 111; // 0x6F
public static final int IREM = 112; // 0x70
public static final int LREM = 113; // 0x71
public static final int FREM = 114; // 0x72
public static final int DREM = 115; // 0x73
public static final int INEG = 116; // 0x74
public static final int LNEG = 117; // 0x75
public static final int FNEG = 118; // 0x76
public static final int DNEG = 119; // 0x77
public static final int ISHL = 120; // 0x78
public static final int LSHL = 121; // 0x79
public static final int ISHR = 122; // 0x7A
public static final int LSHR = 123; // 0x7B
public static final int IUSHR = 124; // 0x7C
public static final int LUSHR = 125; // 0x7D
public static final int IAND = 126; // 0x7E
public static final int LAND = 127; // 0x7F
public static final int IOR = 128; // 0x80
public static final int LOR = 129; // 0x81
public static final int IXOR = 130; // 0x82
public static final int LXOR = 131; // 0x83
public static final int IINC = 132; // 0x84
public static final int I2L = 133; // 0x85
public static final int I2F = 134; // 0x86
public static final int I2D = 135; // 0x87
public static final int L2I = 136; // 0x88
public static final int L2F = 137; // 0x89
public static final int L2D = 138; // 0x8A
public static final int F2I = 139; // 0x8B
public static final int F2L = 140; // 0x8C
public static final int F2D = 141; // 0x8D
public static final int D2I = 142; // 0x8E
public static final int D2L = 143; // 0x8F
public static final int D2F = 144; // 0x90
public static final int I2B = 145; // 0x91
public static final int I2C = 146; // 0x92
public static final int I2S = 147; // 0x93
public static final int LCMP = 148; // 0x94
public static final int FCMPL = 149; // 0x95
public static final int FCMPG = 150; // 0x96
public static final int DCMPL = 151; // 0x97
public static final int DCMPG = 152; // 0x98
public static final int IFEQ = 153; // 0x99
public static final int IFNE = 154; // 0x9A
public static final int IFLT = 155; // 0x9B
public static final int IFGE = 156; // 0x9C
public static final int IFGT = 157; // 0x9D
public static final int IFLE = 158; // 0x9E
public static final int IF_ICMPEQ = 159; // 0x9F
public static final int IF_ICMPNE = 160; // 0xA0
public static final int IF_ICMPLT = 161; // 0xA1
public static final int IF_ICMPGE = 162; // 0xA2
public static final int IF_ICMPGT = 163; // 0xA3
public static final int IF_ICMPLE = 164; // 0xA4
public static final int IF_ACMPEQ = 165; // 0xA5
public static final int IF_ACMPNE = 166; // 0xA6
public static final int GOTO = 167; // 0xA7
public static final int JSR = 168; // 0xA8
public static final int RET = 169; // 0xA9
public static final int TABLESWITCH = 170; // 0xAA
public static final int LOOKUPSWITCH = 171; // 0xAB
public static final int IRETURN = 172; // 0xAC
public static final int LRETURN = 173; // 0xAD
public static final int FRETURN = 174; // 0xAE
public static final int DRETURN = 175; // 0xAF
public static final int ARETURN = 176; // 0xB0
public static final int RETURN = 177; // 0xB1
public static final int GETSTATIC = 178; // 0xB2
public static final int PUTSTATIC = 179; // 0xB3
public static final int GETFIELD = 180; // 0xB4
public static final int PUTFIELD = 181; // 0xB5
public static final int INVOKEVIRTUAL = 182; // 0xB6
public static final int INVOKESPECIAL = 183; // 0xB7
public static final int INVOKESTATIC = 184; // 0xB8
public static final int INVOKEINTERFACE = 185; // 0xB9
public static final int INVOKEDYNAMIC = 186; // 0xBA
public static final int NEW = 187; // 0xBB
public static final int NEWARRAY = 188; // 0xBC
public static final int ANEWARRAY = 189; // 0xBD
public static final int ARRAYLENGTH = 190; // 0xBE
public static final int ATHROW = 191; // 0xBF
public static final int CHECKCAST = 192; // 0xC0
public static final int INSTANCEOF = 193; // 0xC1
public static final int MONITORENTER = 194; // 0xC2
public static final int MONITOREXIT = 195; // 0xC3
public static final int WIDE = 196; // 0xC4
public static final int MULTIANEWARRAY = 197; // 0xC5
public static final int IFNULL = 198; // 0xC6
public static final int IFNONNULL = 199; // 0xC7
public static final int GOTO_W = 200; // 0xC8
public static final int JSR_W = 201; // 0xC9
public static final int BREAKPOINT = 202; // 0xCA
public static final int ILLEGAL = 255;
public static final int END = 256;
// @formatter:on
/**
* The last opcode defined by the JVM specification. To iterate over all JVM bytecodes:
*
* <pre>
* for (int opcode = 0; opcode &lt;= Bytecodes.LAST_JVM_OPCODE; ++opcode) {
* //
* }
* </pre>
*/
public static final int LAST_JVM_OPCODE = JSR_W;
/**
* A collection of flags describing various bytecode attributes.
*/
static class Flags {
/**
* Denotes an instruction that ends a basic block and does not let control flow fall through
* to its lexical successor.
*/
static final int STOP = 0x00000001;
/**
* Denotes an instruction that ends a basic block and may let control flow fall through to
* its lexical successor. In practice this means it is a conditional branch.
*/
static final int FALL_THROUGH = 0x00000002;
/**
* Denotes an instruction that has a 2 or 4 byte operand that is an offset to another
* instruction in the same method. This does not include the {@link Bytecodes#TABLESWITCH}
* or {@link Bytecodes#LOOKUPSWITCH} instructions.
*/
static final int BRANCH = 0x00000004;
/**
* Denotes an instruction that reads the value of a static or instance field.
*/
static final int FIELD_READ = 0x00000008;
/**
* Denotes an instruction that writes the value of a static or instance field.
*/
static final int FIELD_WRITE = 0x00000010;
/**
* Denotes an instruction that can cause a trap.
*/
static final int TRAP = 0x00000080;
/**
* Denotes an instruction that is commutative.
*/
static final int COMMUTATIVE = 0x00000100;
/**
* Denotes an instruction that is associative.
*/
static final int ASSOCIATIVE = 0x00000200;
/**
* Denotes an instruction that loads an operand.
*/
static final int LOAD = 0x00000400;
/**
* Denotes an instruction that stores an operand.
*/
static final int STORE = 0x00000800;
/**
* Denotes the 4 INVOKE* instructions.
*/
static final int INVOKE = 0x00001000;
}
// Performs a sanity check that none of the flags overlap.
static {
int allFlags = 0;
try {
for (Field field : Flags.class.getDeclaredFields()) {
int flagsFilter = Modifier.FINAL | Modifier.STATIC;
if ((field.getModifiers() & flagsFilter) == flagsFilter && !field.isSynthetic()) {
assert field.getType() == int.class : "Field is not int : " + field;
final int flag = field.getInt(null);
assert flag != 0;
assert (flag & allFlags) == 0 : field.getName() + " has a value conflicting with another flag";
allFlags |= flag;
}
}
} catch (Exception e) {
throw new InternalError(e.toString());
}
}
/**
* An array that maps from a bytecode value to a {@link String} for the corresponding
* instruction mnemonic.
*/
private static final String[] nameArray = new String[256];
/**
* An array that maps from a bytecode value to the set of {@link Flags} for the corresponding
* instruction.
*/
private static final int[] flagsArray = new int[256];
/**
* An array that maps from a bytecode value to the length in bytes for the corresponding
* instruction.
*/
private static final int[] lengthArray = new int[256];
/**
* An array that maps from a bytecode value to the number of slots pushed on the stack by the
* corresponding instruction.
*/
private static final int[] stackEffectArray = new int[256];
// Checkstyle: stop
// @formatter:off
static {
def(NOP , "nop" , "b" , 0);
def(ACONST_NULL , "aconst_null" , "b" , 1);
def(ICONST_M1 , "iconst_m1" , "b" , 1);
def(ICONST_0 , "iconst_0" , "b" , 1);
def(ICONST_1 , "iconst_1" , "b" , 1);
def(ICONST_2 , "iconst_2" , "b" , 1);
def(ICONST_3 , "iconst_3" , "b" , 1);
def(ICONST_4 , "iconst_4" , "b" , 1);
def(ICONST_5 , "iconst_5" , "b" , 1);
def(LCONST_0 , "lconst_0" , "b" , 2);
def(LCONST_1 , "lconst_1" , "b" , 2);
def(FCONST_0 , "fconst_0" , "b" , 1);
def(FCONST_1 , "fconst_1" , "b" , 1);
def(FCONST_2 , "fconst_2" , "b" , 1);
def(DCONST_0 , "dconst_0" , "b" , 2);
def(DCONST_1 , "dconst_1" , "b" , 2);
def(BIPUSH , "bipush" , "bc" , 1);
def(SIPUSH , "sipush" , "bcc" , 1);
def(LDC , "ldc" , "bi" , 1, TRAP);
def(LDC_W , "ldc_w" , "bii" , 1, TRAP);
def(LDC2_W , "ldc2_w" , "bii" , 2, TRAP);
def(ILOAD , "iload" , "bi" , 1, LOAD);
def(LLOAD , "lload" , "bi" , 2, LOAD);
def(FLOAD , "fload" , "bi" , 1, LOAD);
def(DLOAD , "dload" , "bi" , 2, LOAD);
def(ALOAD , "aload" , "bi" , 1, LOAD);
def(ILOAD_0 , "iload_0" , "b" , 1, LOAD);
def(ILOAD_1 , "iload_1" , "b" , 1, LOAD);
def(ILOAD_2 , "iload_2" , "b" , 1, LOAD);
def(ILOAD_3 , "iload_3" , "b" , 1, LOAD);
def(LLOAD_0 , "lload_0" , "b" , 2, LOAD);
def(LLOAD_1 , "lload_1" , "b" , 2, LOAD);
def(LLOAD_2 , "lload_2" , "b" , 2, LOAD);
def(LLOAD_3 , "lload_3" , "b" , 2, LOAD);
def(FLOAD_0 , "fload_0" , "b" , 1, LOAD);
def(FLOAD_1 , "fload_1" , "b" , 1, LOAD);
def(FLOAD_2 , "fload_2" , "b" , 1, LOAD);
def(FLOAD_3 , "fload_3" , "b" , 1, LOAD);
def(DLOAD_0 , "dload_0" , "b" , 2, LOAD);
def(DLOAD_1 , "dload_1" , "b" , 2, LOAD);
def(DLOAD_2 , "dload_2" , "b" , 2, LOAD);
def(DLOAD_3 , "dload_3" , "b" , 2, LOAD);
def(ALOAD_0 , "aload_0" , "b" , 1, LOAD);
def(ALOAD_1 , "aload_1" , "b" , 1, LOAD);
def(ALOAD_2 , "aload_2" , "b" , 1, LOAD);
def(ALOAD_3 , "aload_3" , "b" , 1, LOAD);
def(IALOAD , "iaload" , "b" , -1, TRAP);
def(LALOAD , "laload" , "b" , 0, TRAP);
def(FALOAD , "faload" , "b" , -1, TRAP);
def(DALOAD , "daload" , "b" , 0, TRAP);
def(AALOAD , "aaload" , "b" , -1, TRAP);
def(BALOAD , "baload" , "b" , -1, TRAP);
def(CALOAD , "caload" , "b" , -1, TRAP);
def(SALOAD , "saload" , "b" , -1, TRAP);
def(ISTORE , "istore" , "bi" , -1, STORE);
def(LSTORE , "lstore" , "bi" , -2, STORE);
def(FSTORE , "fstore" , "bi" , -1, STORE);
def(DSTORE , "dstore" , "bi" , -2, STORE);
def(ASTORE , "astore" , "bi" , -1, STORE);
def(ISTORE_0 , "istore_0" , "b" , -1, STORE);
def(ISTORE_1 , "istore_1" , "b" , -1, STORE);
def(ISTORE_2 , "istore_2" , "b" , -1, STORE);
def(ISTORE_3 , "istore_3" , "b" , -1, STORE);
def(LSTORE_0 , "lstore_0" , "b" , -2, STORE);
def(LSTORE_1 , "lstore_1" , "b" , -2, STORE);
def(LSTORE_2 , "lstore_2" , "b" , -2, STORE);
def(LSTORE_3 , "lstore_3" , "b" , -2, STORE);
def(FSTORE_0 , "fstore_0" , "b" , -1, STORE);
def(FSTORE_1 , "fstore_1" , "b" , -1, STORE);
def(FSTORE_2 , "fstore_2" , "b" , -1, STORE);
def(FSTORE_3 , "fstore_3" , "b" , -1, STORE);
def(DSTORE_0 , "dstore_0" , "b" , -2, STORE);
def(DSTORE_1 , "dstore_1" , "b" , -2, STORE);
def(DSTORE_2 , "dstore_2" , "b" , -2, STORE);
def(DSTORE_3 , "dstore_3" , "b" , -2, STORE);
def(ASTORE_0 , "astore_0" , "b" , -1, STORE);
def(ASTORE_1 , "astore_1" , "b" , -1, STORE);
def(ASTORE_2 , "astore_2" , "b" , -1, STORE);
def(ASTORE_3 , "astore_3" , "b" , -1, STORE);
def(IASTORE , "iastore" , "b" , -3, TRAP);
def(LASTORE , "lastore" , "b" , -4, TRAP);
def(FASTORE , "fastore" , "b" , -3, TRAP);
def(DASTORE , "dastore" , "b" , -4, TRAP);
def(AASTORE , "aastore" , "b" , -3, TRAP);
def(BASTORE , "bastore" , "b" , -3, TRAP);
def(CASTORE , "castore" , "b" , -3, TRAP);
def(SASTORE , "sastore" , "b" , -3, TRAP);
def(POP , "pop" , "b" , -1);
def(POP2 , "pop2" , "b" , -2);
def(DUP , "dup" , "b" , 1);
def(DUP_X1 , "dup_x1" , "b" , 1);
def(DUP_X2 , "dup_x2" , "b" , 1);
def(DUP2 , "dup2" , "b" , 2);
def(DUP2_X1 , "dup2_x1" , "b" , 2);
def(DUP2_X2 , "dup2_x2" , "b" , 2);
def(SWAP , "swap" , "b" , 0);
def(IADD , "iadd" , "b" , -1, COMMUTATIVE | ASSOCIATIVE);
def(LADD , "ladd" , "b" , -2, COMMUTATIVE | ASSOCIATIVE);
def(FADD , "fadd" , "b" , -1, COMMUTATIVE | ASSOCIATIVE);
def(DADD , "dadd" , "b" , -2, COMMUTATIVE | ASSOCIATIVE);
def(ISUB , "isub" , "b" , -1);
def(LSUB , "lsub" , "b" , -2);
def(FSUB , "fsub" , "b" , -1);
def(DSUB , "dsub" , "b" , -2);
def(IMUL , "imul" , "b" , -1, COMMUTATIVE | ASSOCIATIVE);
def(LMUL , "lmul" , "b" , -2, COMMUTATIVE | ASSOCIATIVE);
def(FMUL , "fmul" , "b" , -1, COMMUTATIVE | ASSOCIATIVE);
def(DMUL , "dmul" , "b" , -2, COMMUTATIVE | ASSOCIATIVE);
def(IDIV , "idiv" , "b" , -1, TRAP);
def(LDIV , "ldiv" , "b" , -2, TRAP);
def(FDIV , "fdiv" , "b" , -1);
def(DDIV , "ddiv" , "b" , -2);
def(IREM , "irem" , "b" , -1, TRAP);
def(LREM , "lrem" , "b" , -2, TRAP);
def(FREM , "frem" , "b" , -1);
def(DREM , "drem" , "b" , -2);
def(INEG , "ineg" , "b" , 0);
def(LNEG , "lneg" , "b" , 0);
def(FNEG , "fneg" , "b" , 0);
def(DNEG , "dneg" , "b" , 0);
def(ISHL , "ishl" , "b" , -1);
def(LSHL , "lshl" , "b" , -1);
def(ISHR , "ishr" , "b" , -1);
def(LSHR , "lshr" , "b" , -1);
def(IUSHR , "iushr" , "b" , -1);
def(LUSHR , "lushr" , "b" , -1);
def(IAND , "iand" , "b" , -1, COMMUTATIVE | ASSOCIATIVE);
def(LAND , "land" , "b" , -2, COMMUTATIVE | ASSOCIATIVE);
def(IOR , "ior" , "b" , -1, COMMUTATIVE | ASSOCIATIVE);
def(LOR , "lor" , "b" , -2, COMMUTATIVE | ASSOCIATIVE);
def(IXOR , "ixor" , "b" , -1, COMMUTATIVE | ASSOCIATIVE);
def(LXOR , "lxor" , "b" , -2, COMMUTATIVE | ASSOCIATIVE);
def(IINC , "iinc" , "bic" , 0, LOAD | STORE);
def(I2L , "i2l" , "b" , 1);
def(I2F , "i2f" , "b" , 0);
def(I2D , "i2d" , "b" , 1);
def(L2I , "l2i" , "b" , -1);
def(L2F , "l2f" , "b" , -1);
def(L2D , "l2d" , "b" , 0);
def(F2I , "f2i" , "b" , 0);
def(F2L , "f2l" , "b" , 1);
def(F2D , "f2d" , "b" , 1);
def(D2I , "d2i" , "b" , -1);
def(D2L , "d2l" , "b" , 0);
def(D2F , "d2f" , "b" , -1);
def(I2B , "i2b" , "b" , 0);
def(I2C , "i2c" , "b" , 0);
def(I2S , "i2s" , "b" , 0);
def(LCMP , "lcmp" , "b" , -3);
def(FCMPL , "fcmpl" , "b" , -1);
def(FCMPG , "fcmpg" , "b" , -1);
def(DCMPL , "dcmpl" , "b" , -3);
def(DCMPG , "dcmpg" , "b" , -3);
def(IFEQ , "ifeq" , "boo" , -1, FALL_THROUGH | BRANCH);
def(IFNE , "ifne" , "boo" , -1, FALL_THROUGH | BRANCH);
def(IFLT , "iflt" , "boo" , -1, FALL_THROUGH | BRANCH);
def(IFGE , "ifge" , "boo" , -1, FALL_THROUGH | BRANCH);
def(IFGT , "ifgt" , "boo" , -1, FALL_THROUGH | BRANCH);
def(IFLE , "ifle" , "boo" , -1, FALL_THROUGH | BRANCH);
def(IF_ICMPEQ , "if_icmpeq" , "boo" , -2, COMMUTATIVE | FALL_THROUGH | BRANCH);
def(IF_ICMPNE , "if_icmpne" , "boo" , -2, COMMUTATIVE | FALL_THROUGH | BRANCH);
def(IF_ICMPLT , "if_icmplt" , "boo" , -2, FALL_THROUGH | BRANCH);
def(IF_ICMPGE , "if_icmpge" , "boo" , -2, FALL_THROUGH | BRANCH);
def(IF_ICMPGT , "if_icmpgt" , "boo" , -2, FALL_THROUGH | BRANCH);
def(IF_ICMPLE , "if_icmple" , "boo" , -2, FALL_THROUGH | BRANCH);
def(IF_ACMPEQ , "if_acmpeq" , "boo" , -2, COMMUTATIVE | FALL_THROUGH | BRANCH);
def(IF_ACMPNE , "if_acmpne" , "boo" , -2, COMMUTATIVE | FALL_THROUGH | BRANCH);
def(GOTO , "goto" , "boo" , 0, STOP | BRANCH);
def(JSR , "jsr" , "boo" , 0, STOP | BRANCH);
def(RET , "ret" , "bi" , 0, STOP);
def(TABLESWITCH , "tableswitch" , "" , -1, STOP);
def(LOOKUPSWITCH , "lookupswitch" , "" , -1, STOP);
def(IRETURN , "ireturn" , "b" , -1, TRAP | STOP);
def(LRETURN , "lreturn" , "b" , -2, TRAP | STOP);
def(FRETURN , "freturn" , "b" , -1, TRAP | STOP);
def(DRETURN , "dreturn" , "b" , -2, TRAP | STOP);
def(ARETURN , "areturn" , "b" , -1, TRAP | STOP);
def(RETURN , "return" , "b" , 0, TRAP | STOP);
def(GETSTATIC , "getstatic" , "bjj" , 1, TRAP | FIELD_READ);
def(PUTSTATIC , "putstatic" , "bjj" , -1, TRAP | FIELD_WRITE);
def(GETFIELD , "getfield" , "bjj" , 0, TRAP | FIELD_READ);
def(PUTFIELD , "putfield" , "bjj" , -2, TRAP | FIELD_WRITE);
def(INVOKEVIRTUAL , "invokevirtual" , "bjj" , -1, TRAP | INVOKE);
def(INVOKESPECIAL , "invokespecial" , "bjj" , -1, TRAP | INVOKE);
def(INVOKESTATIC , "invokestatic" , "bjj" , 0, TRAP | INVOKE);
def(INVOKEINTERFACE , "invokeinterface" , "bjja_", -1, TRAP | INVOKE);
def(INVOKEDYNAMIC , "invokedynamic" , "bjjjj", 0, TRAP | INVOKE);
def(NEW , "new" , "bii" , 1, TRAP);
def(NEWARRAY , "newarray" , "bc" , 0, TRAP);
def(ANEWARRAY , "anewarray" , "bii" , 0, TRAP);
def(ARRAYLENGTH , "arraylength" , "b" , 0, TRAP);
def(ATHROW , "athrow" , "b" , -1, TRAP | STOP);
def(CHECKCAST , "checkcast" , "bii" , 0, TRAP);
def(INSTANCEOF , "instanceof" , "bii" , 0, TRAP);
def(MONITORENTER , "monitorenter" , "b" , -1, TRAP);
def(MONITOREXIT , "monitorexit" , "b" , -1, TRAP);
def(WIDE , "wide" , "" , 0);
def(MULTIANEWARRAY , "multianewarray" , "biic" , 1, TRAP);
def(IFNULL , "ifnull" , "boo" , -1, FALL_THROUGH | BRANCH);
def(IFNONNULL , "ifnonnull" , "boo" , -1, FALL_THROUGH | BRANCH);
def(GOTO_W , "goto_w" , "boooo", 0, STOP | BRANCH);
def(JSR_W , "jsr_w" , "boooo", 0, STOP | BRANCH);
def(BREAKPOINT , "breakpoint" , "b" , 0, TRAP);
}
// @formatter:on
// Checkstyle: resume
/**
* Determines if an opcode is commutative.
*
* @param opcode the opcode to check
* @return {@code true} iff commutative
*/
public static boolean isCommutative(int opcode) {
return (flagsArray[opcode & 0xff] & COMMUTATIVE) != 0;
}
/**
* Gets the length of an instruction denoted by a given opcode.
*
* @param opcode an instruction opcode
* @return the length of the instruction denoted by {@code opcode}. If {@code opcode} is an
* illegal instruction or denotes a variable length instruction (e.g.
* {@link #TABLESWITCH}), then 0 is returned.
*/
public static int lengthOf(int opcode) {
return lengthArray[opcode & 0xff];
}
/**
* Gets the effect on the depth of the expression stack of an instruction denoted by a given
* opcode.
*
* @param opcode an instruction opcode
* @return the change in the stack caused by the instruction denoted by {@code opcode}. If
* {@code opcode} is an illegal instruction then 0 is returned. Note that invoke
* instructions may pop more arguments so this value is a minimum stack effect.
*/
public static int stackEffectOf(int opcode) {
return stackEffectArray[opcode & 0xff];
}
/**
* Gets the lower-case mnemonic for a given opcode.
*
* @param opcode an opcode
* @return the mnemonic for {@code opcode} or {@code "<illegal opcode: " + opcode + ">"} if
* {@code opcode} is not a legal opcode
*/
public static String nameOf(int opcode) throws IllegalArgumentException {
String name = nameArray[opcode & 0xff];
if (name == null) {
return "<illegal opcode: " + opcode + ">";
}
return name;
}
/**
* Allocation-free version of {@linkplain #nameOf(int)}.
*
* @param opcode an opcode.
* @return the mnemonic for {@code opcode} or {@code "<illegal opcode>"} if {@code opcode} is
* not a legal opcode.
*/
public static String baseNameOf(int opcode) {
String name = nameArray[opcode & 0xff];
if (name == null) {
return "<illegal opcode>";
}
return name;
}
/**
* Gets the opcode corresponding to a given mnemonic.
*
* @param name an opcode mnemonic
* @return the opcode corresponding to {@code mnemonic}
* @throws IllegalArgumentException if {@code name} does not denote a valid opcode
*/
public static int valueOf(String name) {
for (int opcode = 0; opcode < nameArray.length; ++opcode) {
if (name.equalsIgnoreCase(nameArray[opcode])) {
return opcode;
}
}
throw new IllegalArgumentException("No opcode for " + name);
}
/**
* Determines if a given opcode denotes an instruction that can cause an implicit exception.
*
* @param opcode an opcode to test
* @return {@code true} iff {@code opcode} can cause an implicit exception, {@code false}
* otherwise
*/
public static boolean canTrap(int opcode) {
return (flagsArray[opcode & 0xff] & TRAP) != 0;
}
/**
* Determines if a given opcode denotes an instruction that loads a local variable to the
* operand stack.
*
* @param opcode an opcode to test
* @return {@code true} iff {@code opcode} loads a local variable to the operand stack,
* {@code false} otherwise
*/
public static boolean isLoad(int opcode) {
return (flagsArray[opcode & 0xff] & LOAD) != 0;
}
/**
* Determines if a given opcode denotes an instruction that ends a basic block and does not let
* control flow fall through to its lexical successor.
*
* @param opcode an opcode to test
* @return {@code true} iff {@code opcode} properly ends a basic block
*/
public static boolean isStop(int opcode) {
return (flagsArray[opcode & 0xff] & STOP) != 0;
}
/**
* Determines if a given opcode denotes an instruction that stores a value to a local variable
* after popping it from the operand stack.
*
* @param opcode an opcode to test
* @return {@code true} iff {@code opcode} stores a value to a local variable, {@code false}
* otherwise
*/
public static boolean isInvoke(int opcode) {
return (flagsArray[opcode & 0xff] & INVOKE) != 0;
}
/**
* Determines if a given opcode denotes an instruction that stores a value to a local variable
* after popping it from the operand stack.
*
* @param opcode an opcode to test
* @return {@code true} iff {@code opcode} stores a value to a local variable, {@code false}
* otherwise
*/
public static boolean isStore(int opcode) {
return (flagsArray[opcode & 0xff] & STORE) != 0;
}
/**
* Determines if a given opcode is an instruction that delimits a basic block.
*
* @param opcode an opcode to test
* @return {@code true} iff {@code opcode} delimits a basic block
*/
public static boolean isBlockEnd(int opcode) {
return (flagsArray[opcode & 0xff] & (STOP | FALL_THROUGH)) != 0;
}
/**
* Determines if a given opcode is an instruction that has a 2 or 4 byte operand that is an
* offset to another instruction in the same method. This does not include the
* {@linkplain #TABLESWITCH switch} instructions.
*
* @param opcode an opcode to test
* @return {@code true} iff {@code opcode} is a branch instruction with a single operand
*/
public static boolean isBranch(int opcode) {
return (flagsArray[opcode & 0xff] & BRANCH) != 0;
}
/**
* Determines if a given opcode denotes a conditional branch.
*
* @param opcode
* @return {@code true} iff {@code opcode} is a conditional branch
*/
public static boolean isConditionalBranch(int opcode) {
return (flagsArray[opcode & 0xff] & FALL_THROUGH) != 0;
}
/**
* Gets the arithmetic operator name for a given opcode. If {@code opcode} does not denote an
* arithmetic instruction, then the {@linkplain #nameOf(int) name} of the opcode is returned
* instead.
*
* @param op an opcode
* @return the arithmetic operator name
*/
public static String operator(int op) {
// Checkstyle: stop
switch (op) {
// arithmetic ops
case IADD: // fall through
case LADD: // fall through
case FADD: // fall through
case DADD:
return "+";
case ISUB: // fall through
case LSUB: // fall through
case FSUB: // fall through
case DSUB:
return "-";
case IMUL: // fall through
case LMUL: // fall through
case FMUL: // fall through
case DMUL:
return "*";
case IDIV: // fall through
case LDIV: // fall through
case FDIV: // fall through
case DDIV:
return "/";
case IREM: // fall through
case LREM: // fall through
case FREM: // fall through
case DREM:
return "%";
// shift ops
case ISHL: // fall through
case LSHL:
return "<<";
case ISHR: // fall through
case LSHR:
return ">>";
case IUSHR: // fall through
case LUSHR:
return ">>>";
// logic ops
case IAND: // fall through
case LAND:
return "&";
case IOR: // fall through
case LOR:
return "|";
case IXOR: // fall through
case LXOR:
return "^";
}
// Checkstyle: resume
return nameOf(op);
}
/**
* Defines a bytecode by entering it into the arrays that record its name, length and flags.
*
* @param name instruction name (should be lower case)
* @param format encodes the length of the instruction
*/
private static void def(int opcode, String name, String format, int stackEffect) {
def(opcode, name, format, stackEffect, 0);
}
/**
* Defines a bytecode by entering it into the arrays that record its name, length and flags.
*
* @param name instruction name (lower case)
* @param format encodes the length of the instruction
* @param flags the set of {@link Flags} associated with the instruction
*/
private static void def(int opcode, String name, String format, int stackEffect, int flags) {
assert nameArray[opcode] == null : "opcode " + opcode + " is already bound to name " + nameArray[opcode];
nameArray[opcode] = name;
int instructionLength = format.length();
lengthArray[opcode] = instructionLength;
stackEffectArray[opcode] = stackEffect;
Bytecodes.flagsArray[opcode] = flags;
assert !isConditionalBranch(opcode) || isBranch(opcode) : "a conditional branch must also be a branch";
}
}