1674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen/*** 2674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * ASM: a very small and fast Java bytecode manipulation framework 3674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * Copyright (c) 2000-2007 INRIA, France Telecom 4674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * All rights reserved. 5674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 6674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * Redistribution and use in source and binary forms, with or without 7674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * modification, are permitted provided that the following conditions 8674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * are met: 9674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 1. Redistributions of source code must retain the above copyright 10674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * notice, this list of conditions and the following disclaimer. 11674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 2. Redistributions in binary form must reproduce the above copyright 12674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * notice, this list of conditions and the following disclaimer in the 13674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * documentation and/or other materials provided with the distribution. 14674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 3. Neither the name of the copyright holders nor the names of its 15674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * contributors may be used to endorse or promote products derived from 16674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * this software without specific prior written permission. 17674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 18674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 22674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 28674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * THE POSSIBILITY OF SUCH DAMAGE. 29674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen */ 30674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogenpackage org.mockito.asm.tree.analysis; 31674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen 32674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogenimport java.util.List; 33674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen 34674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogenimport org.mockito.asm.Type; 35674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogenimport org.mockito.asm.tree.AbstractInsnNode; 36674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen 37674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen/** 38674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * A semantic bytecode interpreter. More precisely, this interpreter only 39674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * manages the computation of values from other values: it does not manage the 40674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * transfer of values to or from the stack, and to or from the local variables. 41674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * This separation allows a generic bytecode {@link Analyzer} to work with 42674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * various semantic interpreters, without needing to duplicate the code to 43674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * simulate the transfer of values. 44674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 45674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @author Eric Bruneton 46674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen */ 47674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogenpublic interface Interpreter { 48674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen 49674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen /** 50674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * Creates a new value that represents the given type. 51674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 52674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * Called for method parameters (including <code>this</code>), 53674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * exception handler variable and with <code>null</code> type 54674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * for variables reserved by long and double types. 55674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 56674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param type a primitive or reference type, or <tt>null</tt> to 57674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * represent an uninitialized value. 58674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @return a value that represents the given type. The size of the returned 59674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * value must be equal to the size of the given type. 60674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen */ 61674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen Value newValue(Type type); 62674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen 63674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen /** 64674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * Interprets a bytecode instruction without arguments. This method is 65674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * called for the following opcodes: 66674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 67674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * ACONST_NULL, ICONST_M1, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, 68674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * ICONST_5, LCONST_0, LCONST_1, FCONST_0, FCONST_1, FCONST_2, DCONST_0, 69674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * DCONST_1, BIPUSH, SIPUSH, LDC, JSR, GETSTATIC, NEW 70674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 71674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param insn the bytecode instruction to be interpreted. 72674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @return the result of the interpretation of the given instruction. 73674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @throws AnalyzerException if an error occured during the interpretation. 74674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen */ 75674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen Value newOperation(AbstractInsnNode insn) throws AnalyzerException; 76674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen 77674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen /** 78674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * Interprets a bytecode instruction that moves a value on the stack or to 79674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * or from local variables. This method is called for the following opcodes: 80674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 81674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * ILOAD, LLOAD, FLOAD, DLOAD, ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, 82674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * ASTORE, DUP, DUP_X1, DUP_X2, DUP2, DUP2_X1, DUP2_X2, SWAP 83674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 84674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param insn the bytecode instruction to be interpreted. 85674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param value the value that must be moved by the instruction. 86674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @return the result of the interpretation of the given instruction. The 87674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * returned value must be <tt>equal</tt> to the given value. 88674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @throws AnalyzerException if an error occured during the interpretation. 89674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen */ 90674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen Value copyOperation(AbstractInsnNode insn, Value value) 91674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen throws AnalyzerException; 92674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen 93674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen /** 94674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * Interprets a bytecode instruction with a single argument. This method is 95674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * called for the following opcodes: 96674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 97674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * INEG, LNEG, FNEG, DNEG, IINC, I2L, I2F, I2D, L2I, L2F, L2D, F2I, F2L, 98674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * F2D, D2I, D2L, D2F, I2B, I2C, I2S, IFEQ, IFNE, IFLT, IFGE, IFGT, IFLE, 99674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * TABLESWITCH, LOOKUPSWITCH, IRETURN, LRETURN, FRETURN, DRETURN, ARETURN, 100674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * PUTSTATIC, GETFIELD, NEWARRAY, ANEWARRAY, ARRAYLENGTH, ATHROW, CHECKCAST, 101674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * INSTANCEOF, MONITORENTER, MONITOREXIT, IFNULL, IFNONNULL 102674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 103674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param insn the bytecode instruction to be interpreted. 104674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param value the argument of the instruction to be interpreted. 105674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @return the result of the interpretation of the given instruction. 106674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @throws AnalyzerException if an error occured during the interpretation. 107674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen */ 108674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen Value unaryOperation(AbstractInsnNode insn, Value value) 109674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen throws AnalyzerException; 110674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen 111674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen /** 112674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * Interprets a bytecode instruction with two arguments. This method is 113674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * called for the following opcodes: 114674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 115674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * IALOAD, LALOAD, FALOAD, DALOAD, AALOAD, BALOAD, CALOAD, SALOAD, IADD, 116674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * LADD, FADD, DADD, ISUB, LSUB, FSUB, DSUB, IMUL, LMUL, FMUL, DMUL, IDIV, 117674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * LDIV, FDIV, DDIV, IREM, LREM, FREM, DREM, ISHL, LSHL, ISHR, LSHR, IUSHR, 118674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * LUSHR, IAND, LAND, IOR, LOR, IXOR, LXOR, LCMP, FCMPL, FCMPG, DCMPL, 119674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * DCMPG, IF_ICMPEQ, IF_ICMPNE, IF_ICMPLT, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, 120674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * IF_ACMPEQ, IF_ACMPNE, PUTFIELD 121674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 122674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param insn the bytecode instruction to be interpreted. 123674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param value1 the first argument of the instruction to be interpreted. 124674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param value2 the second argument of the instruction to be interpreted. 125674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @return the result of the interpretation of the given instruction. 126674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @throws AnalyzerException if an error occured during the interpretation. 127674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen */ 128674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen Value binaryOperation(AbstractInsnNode insn, Value value1, Value value2) 129674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen throws AnalyzerException; 130674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen 131674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen /** 132674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * Interprets a bytecode instruction with three arguments. This method is 133674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * called for the following opcodes: 134674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 135674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * IASTORE, LASTORE, FASTORE, DASTORE, AASTORE, BASTORE, CASTORE, SASTORE 136674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 137674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param insn the bytecode instruction to be interpreted. 138674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param value1 the first argument of the instruction to be interpreted. 139674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param value2 the second argument of the instruction to be interpreted. 140674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param value3 the third argument of the instruction to be interpreted. 141674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @return the result of the interpretation of the given instruction. 142674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @throws AnalyzerException if an error occured during the interpretation. 143674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen */ 144674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen Value ternaryOperation( 145674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen AbstractInsnNode insn, 146674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen Value value1, 147674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen Value value2, 148674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen Value value3) throws AnalyzerException; 149674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen 150674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen /** 151674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * Interprets a bytecode instruction with a variable number of arguments. 152674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * This method is called for the following opcodes: 153674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 154674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * INVOKEVIRTUAL, INVOKESPECIAL, INVOKESTATIC, INVOKEINTERFACE, 155674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * MULTIANEWARRAY 156674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 157674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param insn the bytecode instruction to be interpreted. 158674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param values the arguments of the instruction to be interpreted. 159674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @return the result of the interpretation of the given instruction. 160674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @throws AnalyzerException if an error occured during the interpretation. 161674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen */ 162674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen Value naryOperation(AbstractInsnNode insn, List values) 163674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen throws AnalyzerException; 164674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen 165674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen /** 166674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * Merges two values. The merge operation must return a value that 167674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * represents both values (for instance, if the two values are two types, 168674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * the merged value must be a common super type of the two types. If the two 169674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * values are integer intervals, the merged value must be an interval that 170674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * contains the previous ones. Likewise for other types of values). 171674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * 172674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param v a value. 173674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @param w another value. 174674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * @return the merged value. If the merged value is equal to <tt>v</tt>, 175674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen * this method <i>must</i> return <tt>v</tt>. 176674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen */ 177674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen Value merge(Value v, Value w); 178674060f01e9090cd21b3c5656cc3204912ad17a6Jon Boekenoogen} 179