boomerang.callgraph

Class ObservableStaticICFG

java.lang.Object

boomerang.callgraph.ObservableStaticICFG

All Implemented Interfaces:

ObservableICFG<soot.Unit,soot.SootMethod>

public class ObservableStaticICFG
extends Object
implements ObservableICFG<soot.Unit,soot.SootMethod>

An interprocedural control-flow graph, for which caller-callee edges can be observed using CalleeListener and CallerListener. This call graph wraps a precomputed call graph and notifies listeners about all interprocedual edges for the requested relation at once.

Author:

Melanie Bruns on 04.05.2018

Constructor Summary

Constructors

Constructor and Description
ObservableStaticICFG(BoomerangICFG icfg)

Method Summary

Modifier and Type	Method and Description
void	addCalleeListener(CalleeListener<soot.Unit,soot.SootMethod> listener) Registers a listener that will be notified whenever a callee is added
void	addCallerListener(CallerListener<soot.Unit,soot.SootMethod> listener) Registers a listener that will be notified whenever a caller is added.
void	addUnbalancedMethod(soot.SootMethod method)
Set<soot.Unit>	allNonCallEndNodes()
Set<soot.Unit>	allNonCallStartNodes() Returns the set of all nodes that are neither call nor start nodes.
Collection<soot.Unit>	getAllPrecomputedCallers(soot.SootMethod sootMethod) Returns all precomputed callers for a given method.
soot.jimple.toolkits.callgraph.CallGraph	getCallGraphCopy()
Set<soot.Unit>	getCallsFromWithin(soot.SootMethod sootMethod) Returns all call sites within a given method.
Collection<soot.Unit>	getEndPointsOf(soot.SootMethod sootMethod)
soot.SootMethod	getMethodOf(soot.Unit unit) Returns the method containing a node.
int	getNumberOfEdgesTakenFromPrecomputedGraph() Returns negative number to signify all edges are precomputed.
List<soot.Value>	getParameterRefs(soot.SootMethod sootMethod) Returns the list of parameter references used in the method's body.
List<soot.Unit>	getPredsOf(soot.Unit unit)
Collection<soot.Unit>	getStartPointsOf(soot.SootMethod sootMethod) Returns all start points of a given method.
List<soot.Unit>	getSuccsOf(soot.Unit unit) Returns the successor nodes.
boolean	isCallStmt(soot.Unit stmt) Returns true if the given statement is a call site.
boolean	isExitStmt(soot.Unit stmt) Returns true if the given statement leads to a method return (exceptional or not).
boolean	isReachable(soot.Unit u) Checks whether the given statement is reachable from the entry point
boolean	isStartPoint(soot.Unit stmt) Returns true is this is a method's start statement.
boolean	isUnbalancedMethod(soot.SootMethod method)
void	resetCallGraph() Resets the call graph.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObservableStaticICFG

public ObservableStaticICFG(BoomerangICFG icfg)

Method Detail

getMethodOf

public soot.SootMethod getMethodOf(soot.Unit unit)

Description copied from interface: ObservableICFG

Returns the method containing a node.

Specified by:

getMethodOf in interface ObservableICFG<soot.Unit,soot.SootMethod>

Parameters:

unit - The node for which to get the parent method

getPredsOf

public List<soot.Unit> getPredsOf(soot.Unit unit)

Specified by:

getPredsOf in interface ObservableICFG<soot.Unit,soot.SootMethod>

getSuccsOf

public List<soot.Unit> getSuccsOf(soot.Unit unit)

Description copied from interface: ObservableICFG

Returns the successor nodes.

Specified by:

getSuccsOf in interface ObservableICFG<soot.Unit,soot.SootMethod>

addCalleeListener

public void addCalleeListener(CalleeListener<soot.Unit,soot.SootMethod> listener)

Description copied from interface: ObservableICFG

Registers a listener that will be notified whenever a callee is added

Specified by:

addCalleeListener in interface ObservableICFG<soot.Unit,soot.SootMethod>

addCallerListener

public void addCallerListener(CallerListener<soot.Unit,soot.SootMethod> listener)

Description copied from interface: ObservableICFG

Registers a listener that will be notified whenever a caller is added.

Specified by:

addCallerListener in interface ObservableICFG<soot.Unit,soot.SootMethod>

getAllPrecomputedCallers

public Collection<soot.Unit> getAllPrecomputedCallers(soot.SootMethod sootMethod)

Description copied from interface: ObservableICFG

Returns all precomputed callers for a given method. Behaviour from ObservableICFG.addCalleeListener(CalleeListener) only differs when using dynamic call graph.

Specified by:

getAllPrecomputedCallers in interface ObservableICFG<soot.Unit,soot.SootMethod>

getCallsFromWithin

public Set<soot.Unit> getCallsFromWithin(soot.SootMethod sootMethod)

Description copied from interface: ObservableICFG

Returns all call sites within a given method.

Specified by:

getCallsFromWithin in interface ObservableICFG<soot.Unit,soot.SootMethod>

getStartPointsOf

public Collection<soot.Unit> getStartPointsOf(soot.SootMethod sootMethod)

Description copied from interface: ObservableICFG

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 ObservableICFG<soot.Unit,soot.SootMethod>

isCallStmt

public boolean isCallStmt(soot.Unit stmt)

Description copied from interface: ObservableICFG

Returns true if the given statement is a call site.

Specified by:

isCallStmt in interface ObservableICFG<soot.Unit,soot.SootMethod>

isExitStmt

public boolean isExitStmt(soot.Unit stmt)

Description copied from interface: ObservableICFG

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 ObservableICFG<soot.Unit,soot.SootMethod>

isStartPoint

public boolean isStartPoint(soot.Unit stmt)

Description copied from interface: ObservableICFG

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 ObservableICFG<soot.Unit,soot.SootMethod>

allNonCallStartNodes

public Set<soot.Unit> allNonCallStartNodes()

Description copied from interface: ObservableICFG

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

Specified by:

allNonCallStartNodes in interface ObservableICFG<soot.Unit,soot.SootMethod>

getEndPointsOf

public Collection<soot.Unit> getEndPointsOf(soot.SootMethod sootMethod)

Specified by:

getEndPointsOf in interface ObservableICFG<soot.Unit,soot.SootMethod>

allNonCallEndNodes

public Set<soot.Unit> allNonCallEndNodes()

Specified by:

allNonCallEndNodes in interface ObservableICFG<soot.Unit,soot.SootMethod>

getParameterRefs

public List<soot.Value> getParameterRefs(soot.SootMethod sootMethod)

Description copied from interface: ObservableICFG

Returns the list of parameter references used in the method's body. The list is as long as the number of parameters declared in the associated method's signature. The list may have null entries for parameters not referenced in the body. The returned list is of fixed size.

Specified by:

getParameterRefs in interface ObservableICFG<soot.Unit,soot.SootMethod>

isReachable

public boolean isReachable(soot.Unit u)

Description copied from interface: ObservableICFG

Checks whether the given statement is reachable from the entry point

Specified by:

isReachable in interface ObservableICFG<soot.Unit,soot.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

getCallGraphCopy

public soot.jimple.toolkits.callgraph.CallGraph getCallGraphCopy()

Specified by:

getCallGraphCopy in interface ObservableICFG<soot.Unit,soot.SootMethod>

isUnbalancedMethod

public boolean isUnbalancedMethod(soot.SootMethod method)

Specified by:

isUnbalancedMethod in interface ObservableICFG<soot.Unit,soot.SootMethod>

addUnbalancedMethod

public void addUnbalancedMethod(soot.SootMethod method)

Specified by:

addUnbalancedMethod in interface ObservableICFG<soot.Unit,soot.SootMethod>

getNumberOfEdgesTakenFromPrecomputedGraph

public int getNumberOfEdgesTakenFromPrecomputedGraph()

Returns negative number to signify all edges are precomputed. CallGraphDebugger will add the actual number in.

Specified by:

getNumberOfEdgesTakenFromPrecomputedGraph in interface ObservableICFG<soot.Unit,soot.SootMethod>

Returns:

-1 as all edges are precomputed, but we don't have access to the actual number

resetCallGraph

public void resetCallGraph()

Description copied from interface: ObservableICFG

Resets the call graph. Only affects the call graph if it was built demand-driven, otherwise graph will remain unchanged. Demand-driven call graph will keep intraprocedual information, but reset start with an empty call graph again.

Specified by:

resetCallGraph in interface ObservableICFG<soot.Unit,soot.SootMethod>