com.ibm.wala.ipa.callgraph.impl

Class BasicCallGraph<T>

java.lang.Object

com.ibm.wala.util.graph.AbstractGraph<T>

com.ibm.wala.util.graph.AbstractNumberedGraph<CGNode>

com.ibm.wala.ipa.callgraph.impl.BasicCallGraph<T>

All Implemented Interfaces:

CallGraph, com.ibm.wala.util.graph.EdgeManager<CGNode>, com.ibm.wala.util.graph.Graph<CGNode>, com.ibm.wala.util.graph.NodeManager<CGNode>, com.ibm.wala.util.graph.NumberedEdgeManager<CGNode>, com.ibm.wala.util.graph.NumberedGraph<CGNode>, com.ibm.wala.util.graph.NumberedNodeManager<CGNode>, java.lang.Iterable<CGNode>

Direct Known Subclasses:

CHACallGraph, ExplicitCallGraph

public abstract class BasicCallGraph<T>
extends com.ibm.wala.util.graph.AbstractNumberedGraph<CGNode>
implements CallGraph

Basic data structure support for a call graph.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BasicCallGraph.Key
static class	BasicCallGraph.NodeImpl A class that represents the a normal node in a call graph.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<MethodReference,java.util.Set<CGNode>>	mr2Nodes A mapping from MethodReference to Set of nodes that represent this methodReference.

Constructor Summary

Constructors

Constructor and Description
BasicCallGraph()

Method Summary

Modifier and Type	Method and Description
boolean	containsNode(CGNode N) This implementation is necessary because the underlying SparseNumberedGraph may not support node membership tests.
abstract CGNode	findOrCreateNode(IMethod method, Context C) Use with extreme care.
java.util.Collection<CGNode>	getEntrypointNodes() Note: not all successors of the root node are entrypoints
CGNode	getFakeRootNode() Return the (fake) interprocedural root node of the call graph.
CGNode	getFakeWorldClinitNode()
protected T	getInterpreter(CGNode node)
protected CGNode	getNode(BasicCallGraph.Key K)
CGNode	getNode(IMethod method, Context C) If you want to get all the nodes corresponding to a particular method, regardless of context, then use getNodes
protected com.ibm.wala.util.graph.NumberedNodeManager<CGNode>	getNodeManager()
java.util.Set<CGNode>	getNodes(MethodReference m)
int	getNumberOfNodes() We override this since this class supports remove() on nodes, but the superclass doesn't.
void	init()
java.util.Iterator<CGNode>	iterator() We override this since this class supports remove() on nodes, but the superclass doesn't.
protected abstract CGNode	makeFakeRootNode()
protected abstract CGNode	makeFakeWorldClinitNode()
static java.lang.String	nodeToString(CallGraph CG, CGNode n)
void	registerEntrypoint(CGNode node) record that a node is an entrypoint
protected void	registerNode(BasicCallGraph.Key K, CGNode N)
void	removeNodeAndEdges(CGNode N)
void	setInterpreter(T interpreter)
void	summarizeByPackage()
java.lang.String	toString()

Methods inherited from class com.ibm.wala.util.graph.AbstractNumberedGraph

getEdgeManager, getMaxNumber, getNode, getNumber, getPredNodeNumbers, getSuccNodeNumbers, iterateNodes

Methods inherited from class com.ibm.wala.util.graph.AbstractGraph

addEdge, addNode, edgeString, getPredNodeCount, getPredNodes, getSuccNodeCount, getSuccNodes, hasEdge, removeAllIncidentEdges, removeEdge, removeIncomingEdges, removeNode, removeOutgoingEdges, stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.wala.ipa.callgraph.CallGraph

getClassHierarchy, getNumberOfTargets, getPossibleSites, getPossibleTargets

Methods inherited from interface com.ibm.wala.util.graph.NumberedNodeManager

getMaxNumber, getNode, getNumber, iterateNodes

Methods inherited from interface com.ibm.wala.util.graph.NodeManager

addNode, removeNode, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.ibm.wala.util.graph.NumberedEdgeManager

getPredNodeNumbers, getSuccNodeNumbers

Methods inherited from interface com.ibm.wala.util.graph.EdgeManager

addEdge, getPredNodeCount, getPredNodes, getSuccNodeCount, getSuccNodes, hasEdge, removeAllIncidentEdges, removeEdge, removeIncomingEdges, removeOutgoingEdges

Field Detail

mr2Nodes

protected final java.util.Map<MethodReference,java.util.Set<CGNode>> mr2Nodes

A mapping from MethodReference to Set of nodes that represent this methodReference.

TODO: rhs of mapping doesn't have to be a set if it's a singleton; could be a node instead.

TODO: this is a bit redundant with the nodes Map. Restructure these data structures for space efficiency.

Constructor Detail

BasicCallGraph

public BasicCallGraph()

Method Detail

init

public void init()
          throws com.ibm.wala.util.CancelException

Throws:

com.ibm.wala.util.CancelException

makeFakeRootNode

protected abstract CGNode makeFakeRootNode()
                                    throws com.ibm.wala.util.CancelException

Throws:

com.ibm.wala.util.CancelException

makeFakeWorldClinitNode

protected abstract CGNode makeFakeWorldClinitNode()
                                           throws com.ibm.wala.util.CancelException

Throws:

com.ibm.wala.util.CancelException

findOrCreateNode

public abstract CGNode findOrCreateNode(IMethod method,
                                        Context C)
                                 throws com.ibm.wala.util.CancelException

Use with extreme care.

Throws:

com.ibm.wala.util.CancelException - TODO

registerNode

protected void registerNode(BasicCallGraph.Key K,
                            CGNode N)

getNode

protected CGNode getNode(BasicCallGraph.Key K)

getFakeRootNode

public CGNode getFakeRootNode()

Description copied from interface: CallGraph

Return the (fake) interprocedural root node of the call graph.

Specified by:

getFakeRootNode in interface CallGraph

Returns:

the "fake" root node the call graph

getFakeWorldClinitNode

public CGNode getFakeWorldClinitNode()

Specified by:

getFakeWorldClinitNode in interface CallGraph

registerEntrypoint

public void registerEntrypoint(CGNode node)

record that a node is an entrypoint

getEntrypointNodes

public java.util.Collection<CGNode> getEntrypointNodes()

Note: not all successors of the root node are entrypoints

Specified by:

getEntrypointNodes in interface CallGraph

Returns:

an Iterator of the nodes designated as "root nodes"

toString

public java.lang.String toString()

Overrides:

toString in class com.ibm.wala.util.graph.AbstractGraph<CGNode>

nodeToString

public static java.lang.String nodeToString(CallGraph CG,
                                            CGNode n)

removeNodeAndEdges

public void removeNodeAndEdges(CGNode N)
                        throws com.ibm.wala.util.debug.UnimplementedError

Specified by:

removeNodeAndEdges in interface com.ibm.wala.util.graph.Graph<CGNode>

Overrides:

removeNodeAndEdges in class com.ibm.wala.util.graph.AbstractGraph<CGNode>

Throws:

com.ibm.wala.util.debug.UnimplementedError

getNode

public CGNode getNode(IMethod method,
                      Context C)

Description copied from interface: CallGraph

If you want to get all the nodes corresponding to a particular method, regardless of context, then use getNodes

Specified by:

getNode in interface CallGraph

Returns:

NodeImpl, or null if none found

getNodes

public java.util.Set<CGNode> getNodes(MethodReference m)

Specified by:

getNodes in interface CallGraph

Parameters:

m - a method reference

Returns:

the set of all nodes in the call graph that represent this method.

getInterpreter

protected T getInterpreter(CGNode node)

Parameters:

node - a call graph node we want information about

Returns:

an object that knows how to interpret information about the node

getNumberOfNodes

public int getNumberOfNodes()

We override this since this class supports remove() on nodes, but the superclass doesn't.

Specified by:

getNumberOfNodes in interface com.ibm.wala.util.graph.NodeManager<CGNode>

Overrides:

getNumberOfNodes in class com.ibm.wala.util.graph.AbstractGraph<CGNode>

See Also:

NodeManager.getNumberOfNodes()

iterator

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

We override this since this class supports remove() on nodes, but the superclass doesn't.

Specified by:

iterator in interface com.ibm.wala.util.graph.NodeManager<CGNode>

Specified by:

iterator in interface java.lang.Iterable<CGNode>

Overrides:

iterator in class com.ibm.wala.util.graph.AbstractGraph<CGNode>

See Also:

NodeManager.iterator()

containsNode

public boolean containsNode(CGNode N)

This implementation is necessary because the underlying SparseNumberedGraph may not support node membership tests.

Specified by:

containsNode in interface com.ibm.wala.util.graph.NodeManager<CGNode>

Overrides:

containsNode in class com.ibm.wala.util.graph.AbstractGraph<CGNode>

Throws:

java.lang.IllegalArgumentException - if N is null

setInterpreter

public void setInterpreter(T interpreter)

getNodeManager

protected com.ibm.wala.util.graph.NumberedNodeManager<CGNode> getNodeManager()

Overrides:

getNodeManager in class com.ibm.wala.util.graph.AbstractNumberedGraph<CGNode>

summarizeByPackage

public void summarizeByPackage()