soot.jimple.toolkits.callgraph

Class CallGraph

java.lang.Object

soot.jimple.toolkits.callgraph.CallGraph

All Implemented Interfaces:

java.lang.Iterable<Edge>

Direct Known Subclasses:

SlowCallGraph

public class CallGraph
extends java.lang.Object
implements java.lang.Iterable<Edge>

Represents the edges in a call graph. This class is meant to act as only a container of edges; code for various call graph builders should be kept out of it, as well as most code for accessing the edges.

Field Summary

Fields

Modifier and Type	Field and Description
protected Edge	dummy
protected java.util.Set<Edge>	edges
protected QueueReader<Edge>	reader
protected java.util.Map<MethodOrMethodContext,Edge>	srcMethodToEdge
protected java.util.Map<Unit,Edge>	srcUnitToEdge
protected ChunkedQueue<Edge>	stream
protected java.util.Map<MethodOrMethodContext,Edge>	tgtToEdge

Constructor Summary

Constructors

Constructor and Description
CallGraph()

Method Summary

Modifier and Type	Method and Description
boolean	addEdge(Edge e) Used to add an edge to the call graph.
java.util.Iterator<Edge>	edgesInto(MethodOrMethodContext m) Returns an iterator over all edges that have m as their target method.
java.util.Iterator<Edge>	edgesOutOf(MethodOrMethodContext m) Returns an iterator over all edges that have m as their source method.
java.util.Iterator<Edge>	edgesOutOf(Unit u) Returns an iterator over all edges that have u as their source unit.
Edge	findEdge(Unit u, SootMethod callee) Find the specific call edge that is going out from the callsite u and the call target is callee.
boolean	isEntryMethod(SootMethod method) Does this method have no incoming edge?
java.util.Iterator<Edge>	iterator()
QueueReader<Edge>	listener() Returns a QueueReader object containing all edges added so far, and which will be informed of any new edges that are later added to the graph.
QueueReader<Edge>	newListener() Returns a QueueReader object which will contain ONLY NEW edges which will be added to the graph.
boolean	removeAllEdgesOutOf(Unit u) Removes all outgoing edges that start at the given unit
boolean	removeEdge(Edge e) Removes the edge e from the call graph.
int	size() Returns the number of edges in the call graph.
java.util.Iterator<MethodOrMethodContext>	sourceMethods() Returns an iterator over all methods that are the sources of at least one edge.
boolean	swapEdgesOutOf(Stmt out, Stmt in) Swaps an invocation statement.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

edges

protected java.util.Set<Edge> edges

stream

protected ChunkedQueue<Edge> stream

reader

protected QueueReader<Edge> reader

srcMethodToEdge

protected java.util.Map<MethodOrMethodContext,Edge> srcMethodToEdge

srcUnitToEdge

protected java.util.Map<Unit,Edge> srcUnitToEdge

tgtToEdge

protected java.util.Map<MethodOrMethodContext,Edge> tgtToEdge

dummy

protected Edge dummy

Constructor Detail

CallGraph

public CallGraph()

Method Detail

addEdge

public boolean addEdge(Edge e)

Used to add an edge to the call graph. Returns true iff the edge was not already present.

removeAllEdgesOutOf

public boolean removeAllEdgesOutOf(Unit u)

Removes all outgoing edges that start at the given unit

Parameters:

u - The unit from which to remove all outgoing edges

Returns:

True if at least one edge has been removed, otherwise false

swapEdgesOutOf

public boolean swapEdgesOutOf(Stmt out,
                              Stmt in)

Swaps an invocation statement. All edges that previously went from the given statement to some callee now go from the new statement to the same callee. This method is intended to be used when a Jimple statement is replaced, but the replacement does not semantically affect the edges.

Parameters:

out - The old statement

in - The new statement

Returns:

True if at least one edge was affected by this operation

removeEdge

public boolean removeEdge(Edge e)

Removes the edge e from the call graph. Returns true iff the edge was originally present in the call graph.

isEntryMethod

public boolean isEntryMethod(SootMethod method)

Does this method have no incoming edge?

Parameters:

method -

Returns:

findEdge

public Edge findEdge(Unit u,
                     SootMethod callee)

Find the specific call edge that is going out from the callsite u and the call target is callee. Without advanced data structure, we can only sequentially search for the match. Fortunately, the number of outgoing edges for a unit is not too large.

Parameters:

u -

callee -

Returns:

sourceMethods

public java.util.Iterator<MethodOrMethodContext> sourceMethods()

Returns an iterator over all methods that are the sources of at least one edge.

edgesOutOf

public java.util.Iterator<Edge> edgesOutOf(Unit u)

Returns an iterator over all edges that have u as their source unit.

edgesOutOf

public java.util.Iterator<Edge> edgesOutOf(MethodOrMethodContext m)

Returns an iterator over all edges that have m as their source method.

edgesInto

public java.util.Iterator<Edge> edgesInto(MethodOrMethodContext m)

Returns an iterator over all edges that have m as their target method.

listener

public QueueReader<Edge> listener()

Returns a QueueReader object containing all edges added so far, and which will be informed of any new edges that are later added to the graph.

newListener

public QueueReader<Edge> newListener()

Returns a QueueReader object which will contain ONLY NEW edges which will be added to the graph.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

size

public int size()

Returns the number of edges in the call graph.

iterator

public java.util.Iterator<Edge> iterator()

Specified by:

iterator in interface java.lang.Iterable<Edge>