BytecodeInstruction (evosuite-client 1.0.5 API)

java.lang.Object
- org.evosuite.graphs.cfg.ASMWrapper
- - org.evosuite.graphs.cfg.BytecodeInstruction

All Implemented Interfaces:

Serializable, Comparable<BytecodeInstruction>

Direct Known Subclasses:

DefUse
```
public class BytecodeInstruction
extends ASMWrapper
implements Serializable, Comparable<BytecodeInstruction>
```
Internal representation of a BytecodeInstruction Extends ASMWrapper which serves as an interface to the ASM library. Known super classes are DefUse and Branch which yield specific functionality needed to achieve theirs respective coverage criteria Old: Node of the control flow graph

Author:

Gordon Fraser, Andre Mis

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`bytecodeOffset`
`protected ClassLoader`	`classLoader`
`protected String`	`className`
`protected int`	`instructionId`
`protected String`	`methodName`

Fields inherited from class org.evosuite.graphs.cfg.ASMWrapper
asmNode, frame

Constructor Summary

Constructors
Constructor and Description
`BytecodeInstruction(BytecodeInstruction wrap)` Can represent any byteCode instruction
`BytecodeInstruction(ClassLoader classLoader, String className, String methodName, int instructionId, int bytecodeOffset, org.objectweb.asm.tree.AbstractInsnNode asmNode)` Generates a ByteCodeInstruction instance that represents a byteCode instruction as indicated by the given ASMNode in the given method and class
`BytecodeInstruction(ClassLoader classLoader, String className, String methodName, int instructionId, int bytecodeOffset, org.objectweb.asm.tree.AbstractInsnNode asmNode, int lineNumber)` Constructor for BytecodeInstruction.
`BytecodeInstruction(ClassLoader classLoader, String className, String methodName, int instructionId, int bytecodeOffset, org.objectweb.asm.tree.AbstractInsnNode asmNode, int lineNumber, BasicBlock basicBlock)` Constructor for BytecodeInstruction.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canBeExitPoint()` canBeExitPoint
`boolean`	`canBeInstrumented()` canBeInstrumented
`int`	`compareTo(BytecodeInstruction o)`
`boolean`	`equals(Object obj)`
`String`	`explain()` explain
`ActualControlFlowGraph`	`getActualCFG()` Returns the ActualControlFlowGraph of this instructions method Convenience method.
`String`	`getASMNodeString()` getASMNodeString
`BasicBlock`	`getBasicBlock()` Return's the BasicBlock that contain's this instruction in it's CFG.
`boolean`	`getBranchExpressionValue(Branch b)` getBranchExpressionValue
`int`	`getBytecodeOffset()` getBytecodeOffset
`RawControlFlowGraph`	`getCalledCFG()` Returns the RawCFG of the method called by this instruction
`ControlDependenceGraph`	`getCDG()` Returns the ControlDependenceGraph of this instructions method Convenience method.
`int`	`getCDGDepth()` getCDGDepth
`String`	`getClassName()` Getter for the field `className`.
`Set<ControlDependency>`	`getControlDependencies()` Returns a cfg.Branch object for each branch this instruction is control dependent on as determined by the ControlDependenceGraph.
`ControlDependency`	`getControlDependency(Branch branch)` getControlDependency
`Branch`	`getControlDependentBranch()` This method returns a random Branch among all Branches this instruction is control dependent on If this instruction is only dependent on the root branch, this method returns null Since EvoSuite was previously unable to detect multiple control dependencies for one instruction this method serves as a backwards compatibility bridge
`boolean`	`getControlDependentBranchExpressionValue()` This method returns the branchExpressionValue from a random Branch among all Branches this instruction is control dependent on.
`int`	`getControlDependentBranchId()` This method returns a random branchId among all branchIds this instruction is control dependent on.
`Set<Integer>`	`getControlDependentBranchIds()` Returns all branchIds of Branches this instruction is directly control dependent on as determined by the ControlDependenceGraph for this instruction's method.
`String`	`getFieldMethodCallName()` Determines the name of the field variable this method call is invoked on This is done using the getSourceOfMethodInvocationInstruction() method and returning its variable name
`int`	`getInstructionId()` getInstructionId
`int`	`getLineNumber()` getLineNumber
`String`	`getMethodName()` getMethodName
`String`	`getName()` getName
`RawControlFlowGraph`	`getRawCFG()` Returns the RawControlFlowGraph of this instructions method Convenience method.
`BytecodeInstruction`	`getSourceOfArrayReference()` If this instruction is an array instruction this method will return the BytecodeInstruction that loaded the reference of the array onto the stack.
`BytecodeInstruction`	`getSourceOfMethodInvocationInstruction()` If this is a method call instruction this method will return the instruction that loaded the reference of the Object the method is invoked onto the stack.
`BytecodeInstruction`	`getSourceOfStackInstruction(int positionFromTop)` This method returns the BytecodeInstruction that loaded the reference which is located on top of the stack minus positionFromTop when this instruction is executed.
`boolean`	`hasBasicBlockSet()` Checks whether this instance's basicBlock has already been set by the CFG or
`int`	`hashCode()`
`boolean`	`hasLineNumberSet()` At first, if this instruction constitutes a line number instruction this method tries to retrieve the lineNumber from the underlying asmNode and set the lineNumber field to the value given by the asmNode.
`boolean`	`isCallToPublicMethod()` isCallToPublicMethod
`boolean`	`isCallToStaticMethod()` isCallToStaticMethod
`boolean`	`isDirectlyControlDependentOn(Branch branch)` Determines whether this BytecodeInstruction is directly control dependent on the given Branch.
`boolean`	`isFieldMethodCallDefinition()`
`boolean`	`isFieldMethodCallUse()`
`boolean`	`isLastInstructionInMethod()` isLastInstructionInMethod
`boolean`	`isMethodCallOfField()` Determines whether this instruction calls a method on a field variable This is done using the getSourceOfMethodInvocationInstruction() method and checking if the return of that method is a field use instruction
`boolean`	`isMethodCallOnSameObject()` Determines whether this instruction calls a method on its own Object ('this') This is done using the getSourceOfMethodInvocationInstruction() method and checking if the return of that method loads this using loadsReferenceToThis()
`boolean`	`isRootBranchDependent()` Determines whether or not this instruction is control dependent on the root branch of it's method by calling getControlDependentBranchIds() to see if the return contains -1.
`boolean`	`isWithinConstructor()` isWithinConstructor
`void`	`printFrameInformation()` printFrameInformation
`boolean`	`proceedsOwnConstructorInvocation()` proceedsOwnConstructorInvocation
`void`	`setBasicBlock(BasicBlock block)` Once the CFG has been asked for this instruction's BasicBlock it sets this instance's internal basicBlock field.
`void`	`setCFGFrame(CFGFrame frame)` setCFGFrame
`void`	`setLineNumber(int lineNumber)` Setter for the field `lineNumber`.
`Branch`	`toBranch()` Convenience method: If this instruction is known by the BranchPool to be a Branch, you can call this method in order to retrieve the corresponding Branch object registered within the BranchPool.
`String`	`toString()`

Methods inherited from class org.evosuite.graphs.cfg.ASMWrapper
canReturnFromMethod, getArrayVariableName, getASMNode, getCalledMethod, getCalledMethodName, getCalledMethodsArgumentCount, getCalledMethodsClass, getFieldName, getFieldSimpleName, getFieldType, getInstructionType, getLocalVariableName, getLocalVariableSlot, getMethodCallDescriptor, getType, getVariableName, isActualBranch, isArrayLoadInstruction, isArrayStoreInstruction, isBranch, isBranchLabel, isConstant, isConstructorInvocation, isConstructorInvocation, isDefinition, isDefinitionForVariable, isDefUse, isFieldArrayDefinition, isFieldDefinition, isFieldDU, isFieldNodeDefinition, isFieldNodeDU, isFieldNodeUse, isFieldUse, isFrame, isGoto, isIfNull, isIINC, isInvokeSpecial, isInvokeStatic, isJump, isLabel, isLineNumber, isLoadConstant, isLocalArrayDefinition, isLocalDU, isLocalVariableDefinition, isLocalVariableUse, isLookupSwitch, isMethodCall, isMethodCallForClass, isReturn, isStaticArrayUsage, isStaticDefUse, isSwitch, isTableSwitch, isThrow, isUse, loadsReferenceToThis, sanityCheckAbstractInsnNode

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - classLoader
```
protected ClassLoader classLoader
```
  - className
```
protected String className
```
  - methodName
```
protected String methodName
```
  - instructionId
```
protected int instructionId
```
  - bytecodeOffset
```
protected int bytecodeOffset
```
- Constructor Detail
  - BytecodeInstruction
```
public BytecodeInstruction(ClassLoader classLoader,
                           String className,
                           String methodName,
                           int instructionId,
                           int bytecodeOffset,
                           org.objectweb.asm.tree.AbstractInsnNode asmNode)
```
    Generates a ByteCodeInstruction instance that represents a byteCode instruction as indicated by the given ASMNode in the given method and class
    
    Parameters:
    
    className - a String object.
    
    methodName - a String object.
    
    instructionId - a int.
    
    bytecodeOffset - a int.
    
    asmNode - a AbstractInsnNode object.
  - BytecodeInstruction
```
public BytecodeInstruction(BytecodeInstruction wrap)
```
    Can represent any byteCode instruction
    
    Parameters:
    
    wrap - a BytecodeInstruction object.
  - BytecodeInstruction
```
public BytecodeInstruction(ClassLoader classLoader,
                           String className,
                           String methodName,
                           int instructionId,
                           int bytecodeOffset,
                           org.objectweb.asm.tree.AbstractInsnNode asmNode,
                           int lineNumber,
                           BasicBlock basicBlock)
```
    Constructor for BytecodeInstruction.
    
    Parameters:
    
    className - a String object.
    
    methodName - a String object.
    
    instructionId - a int.
    
    bytecodeOffset - a int.
    
    asmNode - a AbstractInsnNode object.
    
    lineNumber - a int.
    
    basicBlock - a BasicBlock object.
  - BytecodeInstruction
```
public BytecodeInstruction(ClassLoader classLoader,
                           String className,
                           String methodName,
                           int instructionId,
                           int bytecodeOffset,
                           org.objectweb.asm.tree.AbstractInsnNode asmNode,
                           int lineNumber)
```
    Constructor for BytecodeInstruction.
    
    Parameters:
    
    className - a String object.
    
    methodName - a String object.
    
    instructionId - a int.
    
    bytecodeOffset - a int.
    
    asmNode - a AbstractInsnNode object.
    
    lineNumber - a int.
- Method Detail
  - setCFGFrame
```
public void setCFGFrame(CFGFrame frame)
```
    setCFGFrame
    
    Parameters:
    
    frame - a CFGFrame object.
  - getInstructionId
```
public int getInstructionId()
```
    getInstructionId
    
    Specified by:
    
    getInstructionId in class ASMWrapper
    
    Returns:
    
    a int.
  - getBytecodeOffset
```
public int getBytecodeOffset()
```
    getBytecodeOffset
    
    Returns:
    
    a int.
  - getMethodName
```
public String getMethodName()
```
    getMethodName
    
    Specified by:
    
    getMethodName in class ASMWrapper
    
    Returns:
    
    a String object.
  - getClassName
```
public String getClassName()
```
    Getter for the field className.
    
    Specified by:
    
    getClassName in class ASMWrapper
    
    Returns:
    
    a String object.
  - getName
```
public String getName()
```
    getName
    
    Returns:
    
    a String object.
  - getBasicBlock
```
public BasicBlock getBasicBlock()
```
    Return's the BasicBlock that contain's this instruction in it's CFG. If no BasicBlock containing this instruction was created yet, null is returned.
    
    Returns:
    
    a BasicBlock object.
  - setBasicBlock
```
public void setBasicBlock(BasicBlock block)
```
    Once the CFG has been asked for this instruction's BasicBlock it sets this instance's internal basicBlock field.
    
    Parameters:
    
    block - a BasicBlock object.
  - hasBasicBlockSet
```
public boolean hasBasicBlockSet()
```
    Checks whether this instance's basicBlock has already been set by the CFG or
    
    Returns:
    
    a boolean.
  - getLineNumber
```
public int getLineNumber()
```
    getLineNumber
    
    Overrides:
    
    getLineNumber in class ASMWrapper
    
    Returns:
    
    a int.
  - setLineNumber
```
public void setLineNumber(int lineNumber)
```
    Setter for the field lineNumber.
    
    Parameters:
    
    lineNumber - a int.
  - hasLineNumberSet
```
public boolean hasLineNumberSet()
```
    At first, if this instruction constitutes a line number instruction this method tries to retrieve the lineNumber from the underlying asmNode and set the lineNumber field to the value given by the asmNode. This can lead to an IllegalStateException, should the lineNumber field have been set to another value previously After that, if the lineNumber field is still not initialized, this method returns false Otherwise it returns true
    
    Returns:
    
    a boolean.
  - getActualCFG
```
public ActualControlFlowGraph getActualCFG()
```
    Returns the ActualControlFlowGraph of this instructions method Convenience method. Redirects the call to GraphPool.getActualCFG()
    
    Returns:
    
    a ActualControlFlowGraph object.
  - getRawCFG
```
public RawControlFlowGraph getRawCFG()
```
    Returns the RawControlFlowGraph of this instructions method Convenience method. Redirects the call to GraphPool.getRawCFG()
    
    Specified by:
    
    getRawCFG in class ASMWrapper
    
    Returns:
    
    a RawControlFlowGraph object.
  - getCDG
```
public ControlDependenceGraph getCDG()
```
    Returns the ControlDependenceGraph of this instructions method Convenience method. Redirects the call to GraphPool.getCDG()
    
    Returns:
    
    a ControlDependenceGraph object.
  - getControlDependencies
```
public Set<ControlDependency> getControlDependencies()
```
    Returns a cfg.Branch object for each branch this instruction is control dependent on as determined by the ControlDependenceGraph. If this instruction is only dependent on the root branch this method returns an empty set If this instruction is a Branch and it is dependent on itself - which can happen in loops for example - the returned set WILL contain this. If you do not need the full set in order to avoid loops, call getAllControlDependentBranches instead
    
    Returns:
    
    a Set object.
  - getControlDependentBranch
```
public Branch getControlDependentBranch()
```
    This method returns a random Branch among all Branches this instruction is control dependent on If this instruction is only dependent on the root branch, this method returns null Since EvoSuite was previously unable to detect multiple control dependencies for one instruction this method serves as a backwards compatibility bridge
    
    Returns:
    
    a Branch object.
  - getControlDependentBranchIds
```
public Set<Integer> getControlDependentBranchIds()
```
    Returns all branchIds of Branches this instruction is directly control dependent on as determined by the ControlDependenceGraph for this instruction's method. If this instruction is control dependent on the root branch the id -1 will be contained in this set
    
    Returns:
    
    a Set object.
  - isRootBranchDependent
```
public boolean isRootBranchDependent()
```
    Determines whether or not this instruction is control dependent on the root branch of it's method by calling getControlDependentBranchIds() to see if the return contains -1.
    
    Returns:
    
    a boolean.
  - getControlDependentBranchId
```
public int getControlDependentBranchId()
```
    This method returns a random branchId among all branchIds this instruction is control dependent on. This method returns -1 if getControlDependentBranch() returns null, otherwise that Branch's branchId is returned Note: The returned branchExpressionValue comes from the same Branch getControlDependentBranch() and getControlDependentBranchId() return Since EvoSuite was previously unable to detect multiple control dependencies for one instruction this method serves as a backwards compatibility bridge
    
    Returns:
    
    a int.
  - getControlDependentBranchExpressionValue
```
public boolean getControlDependentBranchExpressionValue()
```
    This method returns the branchExpressionValue from a random Branch among all Branches this instruction is control dependent on. This method returns true if getControlDependentBranch() returns null, otherwise that Branch's branchExpressionValue is returned Note: The returned branchExpressionValue comes from the same Branch getControlDependentBranch() and getControlDependentBranchId() return Since EvoSuite was previously unable to detect multiple control dependencies for one instruction this method serves as a backwards compatibility bridge
    
    Returns:
    
    a boolean.
  - getBranchExpressionValue
```
public boolean getBranchExpressionValue(Branch b)
```
    getBranchExpressionValue
    
    Parameters:
    
    b - a Branch object.
    
    Returns:
    
    a boolean.
  - isDirectlyControlDependentOn
```
public boolean isDirectlyControlDependentOn(Branch branch)
```
    Determines whether this BytecodeInstruction is directly control dependent on the given Branch. Meaning within this instruction CDG there is an incoming ControlFlowEdge to this instructions BasicBlock holding the given Branch as it's branchInstruction. If the given Branch is null, this method checks whether the this instruction is control dependent on the root branch of it's method.
    
    Parameters:
    
    branch - a Branch object.
    
    Returns:
    
    a boolean.
  - getControlDependency
```
public ControlDependency getControlDependency(Branch branch)
```
    getControlDependency
    
    Parameters:
    
    branch - a Branch object.
    
    Returns:
    
    a ControlDependency object.
  - getCDGDepth
```
public int getCDGDepth()
```
    getCDGDepth
    
    Returns:
    
    a int.
  - explain
```
public String explain()
```
    explain
    
    Returns:
    
    a String object.
  - getASMNodeString
```
public String getASMNodeString()
```
    getASMNodeString
    
    Returns:
    
    a String object.
  - printFrameInformation
```
public void printFrameInformation()
```
    printFrameInformation
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toBranch
```
public Branch toBranch()
```
    Convenience method: If this instruction is known by the BranchPool to be a Branch, you can call this method in order to retrieve the corresponding Branch object registered within the BranchPool. Otherwise this method will return null;
    
    Returns:
    
    a Branch object.
  - proceedsOwnConstructorInvocation
```
public boolean proceedsOwnConstructorInvocation()
```
    proceedsOwnConstructorInvocation
    
    Returns:
    
    a boolean.
  - isWithinConstructor
```
public boolean isWithinConstructor()
```
    isWithinConstructor
    
    Returns:
    
    a boolean.
  - isLastInstructionInMethod
```
public boolean isLastInstructionInMethod()
```
    isLastInstructionInMethod
    
    Returns:
    
    a boolean.
  - canBeExitPoint
```
public boolean canBeExitPoint()
```
    canBeExitPoint
    
    Returns:
    
    a boolean.
  - getCalledCFG
```
public RawControlFlowGraph getCalledCFG()
```
    Returns the RawCFG of the method called by this instruction
    
    Returns:
    
    a RawControlFlowGraph object.
  - isMethodCallOnSameObject
```
public boolean isMethodCallOnSameObject()
```
    Determines whether this instruction calls a method on its own Object ('this') This is done using the getSourceOfMethodInvocationInstruction() method and checking if the return of that method loads this using loadsReferenceToThis()
    
    Returns:
    
    a boolean.
  - isMethodCallOfField
```
public boolean isMethodCallOfField()
```
    Determines whether this instruction calls a method on a field variable This is done using the getSourceOfMethodInvocationInstruction() method and checking if the return of that method is a field use instruction
    
    Specified by:
    
    isMethodCallOfField in class ASMWrapper
    
    Returns:
    
    a boolean.
  - getFieldMethodCallName
```
public String getFieldMethodCallName()
```
    Determines the name of the field variable this method call is invoked on This is done using the getSourceOfMethodInvocationInstruction() method and returning its variable name
    
    Specified by:
    
    getFieldMethodCallName in class ASMWrapper
    
    Returns:
    
    a String object.
  - getSourceOfMethodInvocationInstruction
```
public BytecodeInstruction getSourceOfMethodInvocationInstruction()
```
    If this is a method call instruction this method will return the instruction that loaded the reference of the Object the method is invoked onto the stack. This is done using getSourceOfStackInstruction() The reference is found on top of the stack minus the number of the called methods argument
  - getSourceOfArrayReference
```
public BytecodeInstruction getSourceOfArrayReference()
```
    If this instruction is an array instruction this method will return the BytecodeInstruction that loaded the reference of the array onto the stack. This is done using getSourceOfStackMethod() The reference is found on top of the stack minus two
    
    Specified by:
    
    getSourceOfArrayReference in class ASMWrapper
  - getSourceOfStackInstruction
```
public BytecodeInstruction getSourceOfStackInstruction(int positionFromTop)
```
    This method returns the BytecodeInstruction that loaded the reference which is located on top of the stack minus positionFromTop when this instruction is executed. This is done using the CFGFrame created by the SourceInterpreter() of the BytecodeAnalyzer via the CFGGenerator Note that this method may return null. This can happen when aliasing is involved. For example for method invocations on objects this can happen when you first store the object in a local variable and then call a method on that variable see PairTestClass.sourceCallerTest() for an even worse example. TODO: this could be done better by following the SourceValues even further.
  - isFieldMethodCallDefinition
```
public boolean isFieldMethodCallDefinition()
```
    Specified by:
    
    isFieldMethodCallDefinition in class ASMWrapper
  - isFieldMethodCallUse
```
public boolean isFieldMethodCallUse()
```
    Specified by:
    
    isFieldMethodCallUse in class ASMWrapper
  - isCallToPublicMethod
```
public boolean isCallToPublicMethod()
```
    isCallToPublicMethod
    
    Returns:
    
    a boolean.
  - isCallToStaticMethod
```
public boolean isCallToStaticMethod()
```
    isCallToStaticMethod
    
    Returns:
    
    a boolean.
  - canBeInstrumented
```
public boolean canBeInstrumented()
```
    canBeInstrumented
    
    Returns:
    
    a boolean.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(BytecodeInstruction o)
```
    Specified by:
    
    compareTo in interface Comparable<BytecodeInstruction>

Class BytecodeInstruction

Field Summary

Fields inherited from class org.evosuite.graphs.cfg.ASMWrapper

Constructor Summary

Method Summary

Methods inherited from class org.evosuite.graphs.cfg.ASMWrapper

Methods inherited from class java.lang.Object

Field Detail

classLoader

className

methodName

instructionId

bytecodeOffset

Constructor Detail

BytecodeInstruction

BytecodeInstruction

BytecodeInstruction

BytecodeInstruction

Method Detail

setCFGFrame

getInstructionId

getBytecodeOffset

getMethodName

getClassName

getName

getBasicBlock

setBasicBlock

hasBasicBlockSet

getLineNumber

setLineNumber

hasLineNumberSet

getActualCFG

getRawCFG

getCDG

getControlDependencies

getControlDependentBranch

getControlDependentBranchIds

isRootBranchDependent

getControlDependentBranchId

getControlDependentBranchExpressionValue

getBranchExpressionValue

isDirectlyControlDependentOn

getControlDependency

getCDGDepth

explain

getASMNodeString

printFrameInformation

toString

toBranch

proceedsOwnConstructorInvocation

isWithinConstructor

isLastInstructionInMethod

canBeExitPoint

getCalledCFG

isMethodCallOnSameObject

isMethodCallOfField

getFieldMethodCallName

getSourceOfMethodInvocationInstruction

getSourceOfArrayReference

getSourceOfStackInstruction

isFieldMethodCallDefinition

isFieldMethodCallUse

isCallToPublicMethod

isCallToStaticMethod

canBeInstrumented

hashCode

equals

compareTo