org.evosuite.symbolic.instrument

Class ConcolicMethodAdapter

java.lang.Object

org.objectweb.asm.MethodVisitor

org.objectweb.asm.commons.LocalVariablesSorter

org.objectweb.asm.commons.GeneratorAdapter

org.evosuite.symbolic.instrument.ConcolicMethodAdapter

public final class ConcolicMethodAdapter
extends org.objectweb.asm.commons.GeneratorAdapter

Main instrumentation class

Before each user ByteCode instruction, add a call to one of our static methods, that reflects the particular ByteCode. In a few cases noted below, we add our callback after the user ByteCode, instead of before.

Author:

csallner@uta.edu (Christoph Csallner)

Field Summary

Fields inherited from class org.objectweb.asm.commons.GeneratorAdapter

ADD, AND, DIV, EQ, GE, GT, LE, LT, MUL, NE, NEG, OR, REM, SHL, SHR, SUB, USHR, XOR

Fields inherited from class org.objectweb.asm.commons.LocalVariablesSorter

firstLocal, nextLocal

Fields inherited from class org.objectweb.asm.MethodVisitor

api, mv

Method Summary

Modifier and Type	Method and Description
void	visitCode() Before first ByteCode of the method/constructor
void	visitFieldInsn(int opcode, String owner, String name, String desc) GETFIELD, PUTFIELD, GETSTATIC, PUTSTATIC http://java.sun.com/docs/books/jvms/second_edition/html/Instructions2.
void	visitIincInsn(int i, int value) IINC
void	visitInsn(int opcode) Insert call to our method directly before the corresponding user instruction
void	visitIntInsn(int opcode, int operand) BIPUSH: push one byte from instruction stream to operand stack SIPUSH: push two bytes from instruction stream to operand stack NEWARRAY
void	visitJumpInsn(int opcode, org.objectweb.asm.Label label)
void	visitLabel(org.objectweb.asm.Label label) Pseudo-instruction, inserted directly before the corresponding target instruction.
void	visitLdcInsn(Object constant) LDC, (LDC_W) -- push category one constant from constant pool LDC2_W -- push category two constant from constant pool Insert call to our method after user ByteCode instruction, allows us to use the result of LDC.
void	visitLineNumber(int line, org.objectweb.asm.Label start)
void	visitLookupSwitchInsn(org.objectweb.asm.Label dflt, int[] keys, org.objectweb.asm.Label[] labels) LOOKUPSWITCH
void	visitMaxs(int maxStack, int maxLocals)
void	visitMethodInsn(int opcode, String owner, String name, String desc) Invoke a method/constructor/class initializer: INVOKE_X -- signature and receiver (!) of invoked method CALLER_STACK_PARAM -- last parameter CALLER_STACK_PARAM -- next-to-last parameter make call CALL_RESULT
void	visitMultiANewArrayInsn(String arrayTypeDesc, int nrDimensions) MULTIANEWARRAY
void	visitTableSwitchInsn(int min, int max, org.objectweb.asm.Label dflt, org.objectweb.asm.Label[] labels) TABLESWITCH
void	visitTryCatchBlock(org.objectweb.asm.Label start, org.objectweb.asm.Label end, org.objectweb.asm.Label handler, String type)
void	visitTypeInsn(int opcode, String type) CHECKCAST, INSTANCEOF, NEW, ANEWARRAY
void	visitVarInsn(int opcode, int var) ILOAD, ISTORE, ILOAD_0, ILOAD_1, etc.

Methods inherited from class org.objectweb.asm.commons.GeneratorAdapter

arrayLength, arrayLoad, arrayStore, box, cast, catchException, checkCast, dup, dup2, dup2X1, dup2X2, dupX1, dupX2, endMethod, getField, getLocalType, getStatic, goTo, ifCmp, ifICmp, ifNonNull, ifNull, ifZCmp, iinc, instanceOf, invokeConstructor, invokeDynamic, invokeInterface, invokeStatic, invokeVirtual, loadArg, loadArgArray, loadArgs, loadArgs, loadLocal, loadLocal, loadThis, mark, mark, math, monitorEnter, monitorExit, newArray, newInstance, newLabel, not, pop, pop2, push, push, push, push, push, push, push, push, putField, putStatic, ret, returnValue, setLocalType, storeArg, storeLocal, storeLocal, swap, swap, tableSwitch, tableSwitch, throwException, throwException, unbox, valueOf

Methods inherited from class org.objectweb.asm.commons.LocalVariablesSorter

newLocal, newLocalMapping, updateNewLocals, visitFrame, visitLocalVariable, visitLocalVariableAnnotation

Methods inherited from class org.objectweb.asm.MethodVisitor

visitAnnotation, visitAnnotationDefault, visitAttribute, visitEnd, visitInsnAnnotation, visitInvokeDynamicInsn, visitMethodInsn, visitParameter, visitParameterAnnotation, visitTryCatchAnnotation, visitTypeAnnotation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

visitCode

public void visitCode()

Before first ByteCode of the method/constructor

Issue one call per argument, excluding the "this" receiver for non-constructor instance methods. Work left to right, starting with receiver.

1. METHOD_BEGIN_RECEIVER(value) -- optional
2. METHOD_BEGIN_PARAM(value, 0, 0)
3. ...
4. METHOD_BEGIN_PARAM(value, nrArgs-1, localsIndex)

Overrides:

visitCode in class org.objectweb.asm.MethodVisitor

visitInsn

public void visitInsn(int opcode)

Insert call to our method directly before the corresponding user instruction

Overrides:

visitInsn in class org.objectweb.asm.MethodVisitor

visitJumpInsn

public void visitJumpInsn(int opcode,
                          org.objectweb.asm.Label label)

Overrides:

visitJumpInsn in class org.objectweb.asm.MethodVisitor

visitLineNumber

public void visitLineNumber(int line,
                            org.objectweb.asm.Label start)

Overrides:

visitLineNumber in class org.objectweb.asm.MethodVisitor

visitLabel

public void visitLabel(org.objectweb.asm.Label label)

Pseudo-instruction, inserted directly before the corresponding target instruction.

Our instrumentation code does not change the shape of the instrumented method's control flow graph. So hopefully we do not need to modify any label and trust that ASM will recompute the concrete offsets correctly for us.

Overrides:

visitLabel in class org.objectweb.asm.MethodVisitor

visitIntInsn

public void visitIntInsn(int opcode,
                         int operand)

• BIPUSH: push one byte from instruction stream to operand stack
• SIPUSH: push two bytes from instruction stream to operand stack
• NEWARRAY

Overrides:

visitIntInsn in class org.objectweb.asm.MethodVisitor

visitLdcInsn

public void visitLdcInsn(Object constant)

• LDC, (LDC_W) -- push category one constant from constant pool
• LDC2_W -- push category two constant from constant pool

Insert call to our method after user ByteCode instruction, allows us to use the result of LDC.

Overrides:

visitLdcInsn in class org.objectweb.asm.MethodVisitor

See Also:

://java.sun.com/docs/books/jvms/second_edition/html/Instructions2 .doc8.html#ldc, ://java.sun.com/docs/books/jvms/second_edition/html/Instructions2 .doc8.html#ldc2_w

visitVarInsn

public void visitVarInsn(int opcode,
                         int var)

ILOAD, ISTORE, ILOAD_0, ILOAD_1, etc.

These may follow a WIDE instruction.

Overrides:

visitVarInsn in class org.objectweb.asm.commons.LocalVariablesSorter

visitFieldInsn

public void visitFieldInsn(int opcode,
                           String owner,
                           String name,
                           String desc)

GETFIELD, PUTFIELD, GETSTATIC, PUTSTATIC http://java.sun.com/docs/books/jvms/second_edition/html/Instructions2. doc5.html#getfield http://java.sun.com/docs/books/jvms/second_edition/html /Instructions2.doc11.html#putfield

Overrides:

visitFieldInsn in class org.objectweb.asm.MethodVisitor

visitMethodInsn

public void visitMethodInsn(int opcode,
                            String owner,
                            String name,
                            String desc)

Invoke a method/constructor/class initializer:

1. INVOKE_X -- signature and receiver (!) of invoked method
2. CALLER_STACK_PARAM -- last parameter
3. CALLER_STACK_PARAM -- next-to-last parameter
4. make call
5. CALL_RESULT

Add callback before any invocation. Besides all method calls (static, instance, private, public, native, etc.) and all constructor calls, this also works for the special case of the (implicit) super call that the Java compiler adds to the beginning of each constructor: "InvokeSpecial MySuperType "

Although the Java compiler does not allow any statement before this super call, we can still add a callback at the JVM level. It seems that the Java compiler (and language) is overly restrictive here.

TODO: Pass receiver for more than two parameters. http://java.sun.com/docs/books/jvms/second_edition/html/Concepts.doc.html #16411

Overrides:

visitMethodInsn in class org.objectweb.asm.MethodVisitor

visitIincInsn

public void visitIincInsn(int i,
                          int value)

IINC

Increment i-th local (int) variable by constant (int) value.

May follow a WIDE instruction.

Overrides:

visitIincInsn in class org.objectweb.asm.commons.LocalVariablesSorter

visitMultiANewArrayInsn

public void visitMultiANewArrayInsn(String arrayTypeDesc,
                                    int nrDimensions)

MULTIANEWARRAY

 boolean[] b1 = new boolean[1]; // NEWARRAY T_BOOLEAN
 Boolean[] B1 = new Boolean[1]; // ANEWARRAY java/lang/Boolean
 boolean[][] b2 = new boolean[1][2]; // MULTIANEWARRAY [[Z 2
 Boolean[][] B2 = new Boolean[1][2]; // MULTIANEWARRAY [[Ljava/lang/Boolean; 2
 

Overrides:

visitMultiANewArrayInsn in class org.objectweb.asm.MethodVisitor

visitTableSwitchInsn

public void visitTableSwitchInsn(int min,
                                 int max,
                                 org.objectweb.asm.Label dflt,
                                 org.objectweb.asm.Label[] labels)

TABLESWITCH

Overrides:

visitTableSwitchInsn in class org.objectweb.asm.MethodVisitor

visitLookupSwitchInsn

public void visitLookupSwitchInsn(org.objectweb.asm.Label dflt,
                                  int[] keys,
                                  org.objectweb.asm.Label[] labels)

LOOKUPSWITCH

TODO: Optimize this. Do we really need to create a new array every time we execute this switch statement?

Overrides:

visitLookupSwitchInsn in class org.objectweb.asm.MethodVisitor

visitTypeInsn

public void visitTypeInsn(int opcode,
                          String type)

CHECKCAST, INSTANCEOF, NEW, ANEWARRAY

Overrides:

visitTypeInsn in class org.objectweb.asm.MethodVisitor

visitTryCatchBlock

public void visitTryCatchBlock(org.objectweb.asm.Label start,
                               org.objectweb.asm.Label end,
                               org.objectweb.asm.Label handler,
                               String type)

Overrides:

visitTryCatchBlock in class org.objectweb.asm.MethodVisitor

visitMaxs

public void visitMaxs(int maxStack,
                      int maxLocals)

Overrides:

visitMaxs in class org.objectweb.asm.commons.LocalVariablesSorter