soot.jimple.toolkits.ide.icfg

Class BackwardsInterproceduralCFG

java.lang.Object

soot.jimple.toolkits.ide.icfg.BackwardsInterproceduralCFG

All Implemented Interfaces:

InterproceduralCFG<Unit,SootMethod>, BiDiInterproceduralCFG<Unit,SootMethod>

public class BackwardsInterproceduralCFG
extends java.lang.Object
implements BiDiInterproceduralCFG<Unit,SootMethod>

Same as JimpleBasedInterproceduralCFG but based on inverted unit graphs. This should be used for backward analyses.

Field Summary

Fields

Modifier and Type	Field and Description
protected BiDiInterproceduralCFG<Unit,SootMethod>	delegate

Constructor Summary

Constructors

Constructor and Description
BackwardsInterproceduralCFG(BiDiInterproceduralCFG<Unit,SootMethod> fwICFG)

Method Summary

Modifier and Type	Method and Description
java.util.Set<Unit>	allNonCallEndNodes()
java.util.Set<Unit>	allNonCallStartNodes() Returns the set of all nodes that are neither call nor start nodes.
java.util.Collection<SootMethod>	getCalleesOfCallAt(Unit n) Returns all callee methods for a given call.
java.util.Collection<Unit>	getCallersOf(SootMethod m) Returns all caller statements/nodes of a given method.
java.util.Set<Unit>	getCallsFromWithin(SootMethod m) Returns all call sites within a given method.
java.util.Collection<Unit>	getEndPointsOf(SootMethod m)
SootMethod	getMethodOf(Unit n) Returns the method containing a node.
DirectedGraph<Unit>	getOrCreateUnitGraph(SootMethod m)
java.util.List<Value>	getParameterRefs(SootMethod m)
java.util.List<Unit>	getPredsOf(Unit u)
java.util.List<Unit>	getPredsOfCallAt(Unit u)
java.util.List<Unit>	getReturnSitesOfCallAt(Unit n) Returns all statements to which a call could return.
java.util.Collection<Unit>	getStartPointsOf(SootMethod m) Returns all start points of a given method.
java.util.List<Unit>	getSuccsOf(Unit n) Returns the successor nodes.
boolean	isBranchTarget(Unit stmt, Unit succ) Returns whether succ is a branch target of stmt.
boolean	isCallStmt(Unit stmt) Returns true if the given statement is a call site.
boolean	isExitStmt(Unit stmt) Returns true if the given statement leads to a method return (exceptional or not).
boolean	isFallThroughSuccessor(Unit stmt, Unit succ) Returns whether succ is the fall-through successor of stmt, i.e., the unique successor that is be reached when stmt does not branch.
boolean	isReachable(Unit u) Checks whether the given statement is rachable from the entry point
boolean	isReturnSite(Unit n) Gets whether the given statement is a return site of at least one call
boolean	isStartPoint(Unit stmt) Returns true is this is a method's start statement.

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected final BiDiInterproceduralCFG<Unit,SootMethod> delegate

Constructor Detail

BackwardsInterproceduralCFG

public BackwardsInterproceduralCFG(BiDiInterproceduralCFG<Unit,SootMethod> fwICFG)

Method Detail

getSuccsOf

public java.util.List<Unit> getSuccsOf(Unit n)

Description copied from interface: InterproceduralCFG

Returns the successor nodes.

Specified by:

getSuccsOf in interface InterproceduralCFG<Unit,SootMethod>

getStartPointsOf

public java.util.Collection<Unit> getStartPointsOf(SootMethod m)

Description copied from interface: InterproceduralCFG

Returns all start points of a given method. There may be more than one start point in case of a backward analysis.

Specified by:

getStartPointsOf in interface InterproceduralCFG<Unit,SootMethod>

getReturnSitesOfCallAt

public java.util.List<Unit> getReturnSitesOfCallAt(Unit n)

Description copied from interface: InterproceduralCFG

Returns all statements to which a call could return. In the RHS paper, for every call there is just one return site. We, however, use as return site the successor statements, of which there can be many in case of exceptional flow.

Specified by:

getReturnSitesOfCallAt in interface InterproceduralCFG<Unit,SootMethod>

isExitStmt

public boolean isExitStmt(Unit stmt)

Description copied from interface: InterproceduralCFG

Returns true if the given statement leads to a method return (exceptional or not). For backward analyses may also be start statements.

Specified by:

isExitStmt in interface InterproceduralCFG<Unit,SootMethod>

isStartPoint

public boolean isStartPoint(Unit stmt)

Description copied from interface: InterproceduralCFG

Returns true is this is a method's start statement. For backward analyses those may also be return or throws statements.

Specified by:

isStartPoint in interface InterproceduralCFG<Unit,SootMethod>

allNonCallStartNodes

public java.util.Set<Unit> allNonCallStartNodes()

Description copied from interface: InterproceduralCFG

Returns the set of all nodes that are neither call nor start nodes.

Specified by:

allNonCallStartNodes in interface InterproceduralCFG<Unit,SootMethod>

getPredsOf

public java.util.List<Unit> getPredsOf(Unit u)

Specified by:

getPredsOf in interface InterproceduralCFG<Unit,SootMethod>

Specified by:

getPredsOf in interface BiDiInterproceduralCFG<Unit,SootMethod>

getEndPointsOf

public java.util.Collection<Unit> getEndPointsOf(SootMethod m)

Specified by:

getEndPointsOf in interface BiDiInterproceduralCFG<Unit,SootMethod>

getPredsOfCallAt

public java.util.List<Unit> getPredsOfCallAt(Unit u)

Specified by:

getPredsOfCallAt in interface BiDiInterproceduralCFG<Unit,SootMethod>

allNonCallEndNodes

public java.util.Set<Unit> allNonCallEndNodes()

Specified by:

allNonCallEndNodes in interface BiDiInterproceduralCFG<Unit,SootMethod>

getMethodOf

public SootMethod getMethodOf(Unit n)

Description copied from interface: InterproceduralCFG

Returns the method containing a node.

Specified by:

getMethodOf in interface InterproceduralCFG<Unit,SootMethod>

Parameters:

n - The node for which to get the parent method

getCalleesOfCallAt

public java.util.Collection<SootMethod> getCalleesOfCallAt(Unit n)

Description copied from interface: InterproceduralCFG

Returns all callee methods for a given call.

Specified by:

getCalleesOfCallAt in interface InterproceduralCFG<Unit,SootMethod>

getCallersOf

public java.util.Collection<Unit> getCallersOf(SootMethod m)

Description copied from interface: InterproceduralCFG

Returns all caller statements/nodes of a given method.

Specified by:

getCallersOf in interface InterproceduralCFG<Unit,SootMethod>

getCallsFromWithin

public java.util.Set<Unit> getCallsFromWithin(SootMethod m)

Description copied from interface: InterproceduralCFG

Returns all call sites within a given method.

Specified by:

getCallsFromWithin in interface InterproceduralCFG<Unit,SootMethod>

isCallStmt

public boolean isCallStmt(Unit stmt)

Description copied from interface: InterproceduralCFG

Returns true if the given statement is a call site.

Specified by:

isCallStmt in interface InterproceduralCFG<Unit,SootMethod>

getOrCreateUnitGraph

public DirectedGraph<Unit> getOrCreateUnitGraph(SootMethod m)

Specified by:

getOrCreateUnitGraph in interface BiDiInterproceduralCFG<Unit,SootMethod>

getParameterRefs

public java.util.List<Value> getParameterRefs(SootMethod m)

Specified by:

getParameterRefs in interface BiDiInterproceduralCFG<Unit,SootMethod>

isFallThroughSuccessor

public boolean isFallThroughSuccessor(Unit stmt,
                                      Unit succ)

Description copied from interface: InterproceduralCFG

Returns whether succ is the fall-through successor of stmt, i.e., the unique successor that is be reached when stmt does not branch.

Specified by:

isFallThroughSuccessor in interface InterproceduralCFG<Unit,SootMethod>

isBranchTarget

public boolean isBranchTarget(Unit stmt,
                              Unit succ)

Description copied from interface: InterproceduralCFG

Returns whether succ is a branch target of stmt.

Specified by:

isBranchTarget in interface InterproceduralCFG<Unit,SootMethod>

isReturnSite

public boolean isReturnSite(Unit n)

Description copied from interface: BiDiInterproceduralCFG

Gets whether the given statement is a return site of at least one call

Specified by:

isReturnSite in interface BiDiInterproceduralCFG<Unit,SootMethod>

Parameters:

n - The statement to check

Returns:

True if the given statement is a return site, otherwise false

isReachable

public boolean isReachable(Unit u)

Description copied from interface: BiDiInterproceduralCFG

Checks whether the given statement is rachable from the entry point

Specified by:

isReachable in interface BiDiInterproceduralCFG<Unit,SootMethod>

Parameters:

u - The statement to check

Returns:

True if there is a control flow path from the entry point of the program to the given statement, otherwise false