Class FixedParametersInvokeInstruction

java.lang.Object

com.ibm.wala.ssa.SSAInstruction

com.ibm.wala.ssa.SSAAbstractInvokeInstruction

com.ibm.wala.cast.ir.ssa.MultiReturnValueInvokeInstruction

com.ibm.wala.cast.ir.ssa.FixedParametersInvokeInstruction

Direct Known Subclasses:

AstJavaInvokeInstruction

public abstract class FixedParametersInvokeInstruction
extends MultiReturnValueInvokeInstruction

This abstract instruction extends the abstract invoke with functionality to support invocations with a fixed number of arguments---the only case in some languages and a common case even in scripting languages.

Author:

Julian Dolby (dolby@us.ibm.com)

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 MultiReturnValueInvokeInstruction

results

Modifier and Type	Field	Description
protected final int[]	results

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
FixedParametersInvokeInstruction(int iindex, int[] results, int[] params, int exception, CallSiteReference site)
FixedParametersInvokeInstruction(int iindex, int[] params, int exception, CallSiteReference site)	Constructor InvokeInstruction.
FixedParametersInvokeInstruction(int iindex, int result, int[] params, int exception, CallSiteReference site)

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.
protected abstract SSAInstruction	copyInstruction(SSAInstructionFactory insts, int[] result, int[] params, int exception)
int	getNumberOfPositionalParameters()	How many parameters does this call specify?
int	getNumberOfUses()
int	getUse(int j)
int	hashCode()
void	visit(SSAInstruction.IVisitor v)	Apply an IVisitor to this instruction.

Methods inherited from class MultiReturnValueInvokeInstruction

getNumberOfReturnValues, getReturnValue

Modifier and Type	Method	Description
int	getNumberOfReturnValues()	How many distinct values does this call return?
int	getReturnValue(int i)	What is the the value number of the ith value returned by this call

Methods inherited from class SSAAbstractInvokeInstruction

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

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)
String	toString(SymbolTable symbolTable)

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

FixedParametersInvokeInstruction

public FixedParametersInvokeInstruction(int iindex,
 int[] results,
 int[] params,
 int exception,
 CallSiteReference site)

FixedParametersInvokeInstruction

public FixedParametersInvokeInstruction(int iindex,
 int result,
 int[] params,
 int exception,
 CallSiteReference site)

FixedParametersInvokeInstruction

public FixedParametersInvokeInstruction(int iindex,
 int[] params,
 int exception,
 CallSiteReference site)

Constructor InvokeInstruction. This case for void return values

Method Details

copyInstruction

protected abstract SSAInstruction copyInstruction(SSAInstructionFactory insts,
 int[] result,
 int[] params,
 int exception)

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

Specified by:

copyForSSA in class SSAInstruction

getNumberOfPositionalParameters

public int getNumberOfPositionalParameters()

Description copied from class: SSAAbstractInvokeInstruction

How many parameters does this call specify?

Specified by:

getNumberOfPositionalParameters in class SSAAbstractInvokeInstruction

visit

public void visit(SSAInstruction.IVisitor v)

Description copied from class: SSAInstruction

Apply an IVisitor to this instruction. We invoke the appropriate IVisitor method according to the type of this instruction.

Specified by:

visit in class SSAInstruction

getNumberOfUses

public int getNumberOfUses()

Overrides:

getNumberOfUses in class SSAInstruction

hashCode

public int hashCode()

Specified by:

hashCode in class SSAInstruction

getUse

public int getUse(int j)

Overrides:

getUse in class SSAInstruction

Returns:

value number representing the jth use in this instruction. -1 means TOP (i.e., the value doesn't matter)