Class CHACallGraph

java.lang.Object

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

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

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

com.ibm.wala.ipa.callgraph.cha.CHACallGraph

All Implemented Interfaces:

CallGraph, EdgeManager<CGNode>, Graph<CGNode>, NodeManager<CGNode>, NumberedEdgeManager<CGNode>, NumberedGraph<CGNode>, NumberedNodeManager<CGNode>, Iterable<CGNode>

public class CHACallGraph
extends BasicCallGraph<CHAContextInterpreter>

Call graph in which call targets are determined entirely based on an IClassHierarchy.

Nested Class Summary

Nested classes/interfaces inherited from class BasicCallGraph

BasicCallGraph.Key, BasicCallGraph.NodeImpl

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

Field Summary

Fields inherited from class BasicCallGraph

mr2Nodes

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

Constructor Summary

Constructors

Constructor	Description
CHACallGraph(IClassHierarchy cha)	NOTE: after calling this constructor, init(Iterable) must be invoked to complete initialization
CHACallGraph(IClassHierarchy cha, boolean applicationOnly)	NOTE: after calling this constructor, init(Iterable) must be invoked to complete initialization

Method Summary

Modifier and Type	Method	Description
CGNode	findOrCreateNode(IMethod method, Context C)	Use with extreme care.
IClassHierarchy	getClassHierarchy()
protected NumberedEdgeManager<CGNode>	getEdgeManager()
int	getNumberOfTargets(CGNode node, CallSiteReference site)
Iterator<CallSiteReference>	getPossibleSites(CGNode src, CGNode target)
Set<CGNode>	getPossibleTargets(CGNode node, CallSiteReference site)	Return the set of CGNodes that represent possible targets of a particular call site from a particular node
void	init(Iterable<Entrypoint> entrypoints)	Builds the call graph data structures.
protected CGNode	makeFakeRootNode()
protected CGNode	makeFakeWorldClinitNode()

Methods inherited from class BasicCallGraph

containsNode, getEntrypointNodes, getFakeRootNode, getFakeWorldClinitNode, getInterpreter, getNode, getNode, getNodeManager, getNodes, getNumberOfNodes, init, iterator, nodeToString, registerEntrypoint, registerNode, removeNodeAndEdges, setInterpreter, summarizeByPackage, toString

Modifier and Type	Method	Description
boolean	containsNode(CGNode N)	This implementation is necessary because the underlying SparseNumberedGraph may not support node membership tests.
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 CHAContextInterpreter	getInterpreter(CGNode node)
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 CGNode	getNode(BasicCallGraph.Key K)
protected NumberedNodeManager<CGNode>	getNodeManager()
Set<CGNode>	getNodes(MethodReference m)
int	getNumberOfNodes()	We override this since this class supports remove() on nodes, but the superclass doesn't.
void	init()
Iterator<CGNode>	iterator()	We override this since this class supports remove() on nodes, but the superclass doesn't.
static 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)	remove a node and all its incident edges
void	setInterpreter(CHAContextInterpreter interpreter)
void	summarizeByPackage()
String	toString()

Methods inherited from class AbstractNumberedGraph

getMaxNumber, getNode, getNumber, getPredNodeNumbers, getSuccNodeNumbers, iterateNodes

Modifier and Type	Method	Description
int	getMaxNumber()
CGNode	getNode(int number)
int	getNumber(CGNode N)
IntSet	getPredNodeNumbers(CGNode node)
IntSet	getSuccNodeNumbers(CGNode node)
Iterator<CGNode>	iterateNodes(IntSet s)

Methods inherited from class AbstractGraph

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

Modifier and Type	Method	Description
void	addEdge(CGNode src, CGNode dst)
void	addNode(CGNode n)	add a node to this graph
protected String	edgeString(CGNode from, CGNode to)
int	getPredNodeCount(CGNode n)	Return the number of immediate predecessor nodes of n
Iterator<CGNode>	getPredNodes(CGNode n)	Return an Iterator over the immediate predecessor nodes of n
int	getSuccNodeCount(CGNode n)	Return the number of immediate successor nodes of this Node in the Graph
Iterator<CGNode>	getSuccNodes(CGNode n)	Return an Iterator over the immediate successor nodes of n
boolean	hasEdge(CGNode src, CGNode dst)
protected String	nodeString(CGNode n, boolean forEdge)
void	removeAllIncidentEdges(CGNode node)
void	removeEdge(CGNode src, CGNode dst)
void	removeIncomingEdges(CGNode node)
void	removeNode(CGNode n)	remove a node from this graph
void	removeOutgoingEdges(CGNode node)
Stream<CGNode>	stream()

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

CHACallGraph

public CHACallGraph(IClassHierarchy cha)

NOTE: after calling this constructor, init(Iterable) must be invoked to complete initialization

CHACallGraph

public CHACallGraph(IClassHierarchy cha,
 boolean applicationOnly)

NOTE: after calling this constructor, init(Iterable) must be invoked to complete initialization

Method Details

init

public void init(Iterable<Entrypoint> entrypoints)
          throws CancelException

Builds the call graph data structures. The call graph will only include methods reachable from the provided entrypoints.

Throws:

CancelException

getClassHierarchy

public IClassHierarchy getClassHierarchy()

Returns:

the governing class hierarchy for this call graph

getPossibleTargets

public Set<CGNode> getPossibleTargets(CGNode node,
 CallSiteReference site)

Description copied from interface: CallGraph

Return the set of CGNodes that represent possible targets of a particular call site from a particular node

getNumberOfTargets

public int getNumberOfTargets(CGNode node,
 CallSiteReference site)

Returns:

the number of nodes that the call site may dispatch to

getPossibleSites

public Iterator<CallSiteReference> getPossibleSites(CGNode src,
 CGNode target)

Returns:

iterator of CallSiteReference, the call sites in a node that might dispatch to the target node.

makeFakeRootNode

protected CGNode makeFakeRootNode()
                           throws CancelException

Specified by:

makeFakeRootNode in class BasicCallGraph<CHAContextInterpreter>

Throws:

CancelException

makeFakeWorldClinitNode

protected CGNode makeFakeWorldClinitNode()
                                  throws CancelException

Specified by:

makeFakeWorldClinitNode in class BasicCallGraph<CHAContextInterpreter>

Throws:

CancelException

findOrCreateNode

public CGNode findOrCreateNode(IMethod method,
 Context C)
                        throws CancelException

Description copied from class: BasicCallGraph

Use with extreme care.

Specified by:

findOrCreateNode in class BasicCallGraph<CHAContextInterpreter>

Throws:

CancelException - TODO

getEdgeManager

protected NumberedEdgeManager<CGNode> getEdgeManager()

Specified by:

getEdgeManager in class AbstractNumberedGraph<CGNode>

Returns:

the object which manages edges in the graph