com.ibm.wala.ssa
Class SSANewInstruction

java.lang.Object
  extended by com.ibm.wala.ssa.SSAInstruction
      extended by com.ibm.wala.ssa.SSANewInstruction
Direct Known Subclasses:
AstJavaNewEnclosingInstruction

public abstract class SSANewInstruction
extends SSAInstruction

An allocation instruction ("new") for SSA form. This includes allocations of both scalars and arrays.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.wala.ssa.SSAInstruction
SSAInstruction.IVisitor, SSAInstruction.Visitor
 
Constructor Summary
protected SSANewInstruction(int result, NewSiteReference site)
          Create a new instruction to allocate a scalar.
protected SSANewInstruction(int result, NewSiteReference site, int[] params)
          Create a new instruction to allocate an array.
 
Method Summary
 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.
 TypeReference getConcreteType()
           
 int getDef()
           
 int getDef(int i)
          Return the ith def
 NewSiteReference getNewSite()
           
 int getNumberOfDefs()
           
 int getNumberOfUses()
           
 int getUse(int j)
           
 boolean hasDef()
          Does this instruction define a normal value, as distinct from a set of exceptions possibly thrown by it (e.g.
 int hashCode()
           
 boolean isFallThrough()
           
 boolean isPEI()
           
 java.lang.String toString(SymbolTable symbolTable)
           
 void visit(SSAInstruction.IVisitor v)
          Apply an IVisitor to this instruction.
 
Methods inherited from class com.ibm.wala.ssa.SSAInstruction
equals, getExceptionTypes, getValueString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SSANewInstruction

protected SSANewInstruction(int result,
                            NewSiteReference site)
                     throws java.lang.IllegalArgumentException
Create a new instruction to allocate a scalar.

Throws:
java.lang.IllegalArgumentException

SSANewInstruction

protected SSANewInstruction(int result,
                            NewSiteReference site,
                            int[] params)
Create a new instruction to allocate an array.

Throws:
java.lang.IllegalArgumentException - if site is null
java.lang.IllegalArgumentException - if params is null
Method Detail

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

toString

public java.lang.String toString(SymbolTable symbolTable)
Specified by:
toString in class SSAInstruction

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
Throws:
java.lang.IllegalArgumentException - if v is null
See Also:
SSAInstruction.visit(IVisitor)

hasDef

public boolean hasDef()
Description copied from class: SSAInstruction
Does this instruction define a normal value, as distinct from a set of exceptions possibly thrown by it (e.g. for invoke instructions).

Overrides:
hasDef in class SSAInstruction
Returns:
true if the instruction does define a proper value.
See Also:
SSAInstruction.getDef()

getDef

public int getDef()
Overrides:
getDef in class SSAInstruction

getDef

public int getDef(int i)
Description copied from class: SSAInstruction
Return the ith def

Overrides:
getDef in class SSAInstruction
Parameters:
i - number of the def, starting at 0.

getNumberOfDefs

public int getNumberOfDefs()
Overrides:
getNumberOfDefs in class SSAInstruction

getConcreteType

public TypeReference getConcreteType()
Returns:
TypeReference

getNewSite

public NewSiteReference getNewSite()

hashCode

public int hashCode()
Specified by:
hashCode in class SSAInstruction

getNumberOfUses

public int getNumberOfUses()
Overrides:
getNumberOfUses 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)

isPEI

public boolean isPEI()
Overrides:
isPEI in class SSAInstruction
Returns:
true iff this instruction may throw an exception.

isFallThrough

public boolean isFallThrough()
Specified by:
isFallThrough in class SSAInstruction
Returns:
true iff this instruction may fall through to the next