Class SSAInvokeDynamicInstruction

java.lang.Object

com.ibm.wala.ssa.SSAInstruction

com.ibm.wala.ssa.SSAAbstractInvokeInstruction

com.ibm.wala.ssa.SSAInvokeInstruction

com.ibm.wala.ssa.SSAInvokeDynamicInstruction

public class SSAInvokeDynamicInstruction
extends SSAInvokeInstruction

Used for representing the JVML invokedynamic instruction. When generated by the Java compiler for compilation of Java lambdas / method references, the instruction components are:

• the bootstrap method, which refers to LambdaMetafactory.metafactory(java.lang.invoke.MethodHandles.Lookup, String, java.lang.invoke.MethodType, java.lang.invoke.MethodType, java.lang.invoke.MethodHandle, java.lang.invoke.MethodType),
• the call site, which contains the static arguments passed to the bootstrap method (i.e., the method signature for the corresponding functional interface method), and
• the standard invoke instruction parameters, representing the dynamic arguments (captured local variables)

The behavior of WALA for other uses of invokedynamic is currently unspecified (though it aims to not crash for any valid use).

Nested Class Summary

Nested classes/interfaces inherited from class SSAInstruction

SSAInstruction.IVisitor, SSAInstruction.Visitor

Modifier and Type	Class	Description
static interface	SSAInstruction.IVisitor	This interface is used by Instruction.visit to dispatch based on the instruction type.
static class	SSAInstruction.Visitor	A base visitor implementation that does nothing.

Field Summary

Fields inherited from class SSAInvokeInstruction

params, result

Modifier and Type	Field	Description
protected final int[]	params	The value numbers of the arguments passed to the call.
protected final int	result

Fields inherited from class SSAAbstractInvokeInstruction

exception, site

Modifier and Type	Field	Description
protected final int	exception	The value number which represents the exception object which the call may throw.
protected final CallSiteReference	site	The call site, containing the program counter location and the method being called.

Fields inherited from class SSAInstruction

NO_INDEX

Modifier and Type	Field	Description
static final int	NO_INDEX

Constructor Summary

Constructors

Constructor	Description
SSAInvokeDynamicInstruction(int iindex, int[] params, int exception, CallSiteReference site, BootstrapMethodsReader.BootstrapMethod bootstrap)
SSAInvokeDynamicInstruction(int iindex, int result, int[] params, int exception, CallSiteReference site, BootstrapMethodsReader.BootstrapMethod bootstrap)

Method Summary

Modifier and Type	Method	Description
SSAInstruction	copyForSSA(SSAInstructionFactory insts, int[] defs, int[] uses)	This method is meant to be used during SSA conversion for an IR that is not in SSA form.
BootstrapMethodsReader.BootstrapMethod	getBootstrap()
String	toString(SymbolTable symbolTable)	Mark the instruction as an invokedynamic.

Methods inherited from class SSAInvokeInstruction

assertParamsKosher, getNumberOfPositionalParameters, getNumberOfReturnValues, getNumberOfUses, getReturnValue, getUse, hashCode, visit

Modifier and Type	Method	Description
static void	assertParamsKosher(int result, int[] params, CallSiteReference site)
int	getNumberOfPositionalParameters()	How many parameters does this call specify?
int	getNumberOfReturnValues()	How many distinct values does this call return?
int	getNumberOfUses()
int	getReturnValue(int i)	What is the the value number of the ith value returned by this call
int	getUse(int j)
int	hashCode()
void	visit(SSAInstruction.IVisitor v)	Apply an IVisitor to this instruction.

Methods inherited from class SSAAbstractInvokeInstruction

getCallSite, getDeclaredResultType, getDeclaredTarget, getDef, getDef, getException, getInvocationCode, getNumberOfDefs, getProgramCounter, getReceiver, hasDef, isDispatch, isFallThrough, isPEI, isSpecial, isStatic

Modifier and Type	Method	Description
CallSiteReference	getCallSite()
TypeReference	getDeclaredResultType()	What is the declared return type of the called method
MethodReference	getDeclaredTarget()	What method is the declared callee?
int	getDef()
int	getDef(int i)	Return the ith def
int	getException()	Return the value number which is def'fed by this call instruction if the call returns exceptionally.
IInvokeInstruction.IDispatch	getInvocationCode()
int	getNumberOfDefs()
int	getProgramCounter()
int	getReceiver()
boolean	hasDef()	Does this instruction define a normal value, as distinct from a set of exceptions possibly thrown by it (e.g.
boolean	isDispatch()	Might this call dispatch to one of several possible methods? i.e., in Java, is it an invokeinterface or invokevirtual
boolean	isFallThrough()
boolean	isPEI()
boolean	isSpecial()	Is this a 'special' call? (invokespecial in Java)
boolean	isStatic()	Is this a 'static' call? (invokestatic in Java)

Methods inherited from class SSAInstruction

equals, getExceptionTypes, getValueString, iIndex, setInstructionIndex, toString

Modifier and Type	Method	Description
final boolean	equals(Object obj)	We assume these instructions are canonical and managed by a governing IR object.
Collection<TypeReference>	getExceptionTypes()	This method should never return null.
protected String	getValueString(SymbolTable symbolTable, int valueNumber)
int	iIndex()
void	setInstructionIndex(int instructionIndex)
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SSAInvokeDynamicInstruction

public SSAInvokeDynamicInstruction(int iindex,
 int result,
 int[] params,
 int exception,
 CallSiteReference site,
 BootstrapMethodsReader.BootstrapMethod bootstrap)

SSAInvokeDynamicInstruction

public SSAInvokeDynamicInstruction(int iindex,
 int[] params,
 int exception,
 CallSiteReference site,
 BootstrapMethodsReader.BootstrapMethod bootstrap)

Method Details

copyForSSA

public SSAInstruction copyForSSA(SSAInstructionFactory insts,
 int[] defs,
 int[] uses)

Description copied from class: SSAInstruction

This method is meant to be used during SSA conversion for an IR that is not in SSA form. It creates a new SSAInstruction of the same type as the receiver, with a combination of the receiver's uses and defs and those from the method parameters.

In particular, if the 'defs' parameter is null, then the new instruction has the same defs as the receiver. If 'defs' is not null, it must be an array with a size equal to the number of defs that the receiver instruction has. In this case, the new instruction has defs taken from the array. The uses of the new instruction work in the same way with the 'uses' parameter.

Note that this only applies to CAst-based IR translation, since Java bytecode-based IR generation uses a different SSA construction mechanism.

TODO: move this into the SSAInstructionFactory

Overrides:

copyForSSA in class SSAInvokeInstruction

getBootstrap

public BootstrapMethodsReader.BootstrapMethod getBootstrap()

toString

public String toString(SymbolTable symbolTable)

Mark the instruction as an invokedynamic. The String will also contain the invocation type of the boostrap method

Overrides:

toString in class SSAAbstractInvokeInstruction

Parameters:

symbolTable - the symbol table

Returns:

result of SSAAbstractInvokeInstruction.toString(SymbolTable) with "[invokedynamic] " pre-pended