Package com.ibm.wala.ipa.callgraph.pruned

Class PrunedCallGraph

java.lang.Object

com.ibm.wala.ipa.callgraph.pruned.PrunedCallGraph

All Implemented Interfaces:

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

public class PrunedCallGraph
extends Object
implements CallGraph

Constructor Summary

Constructors

Constructor	Description
PrunedCallGraph(CallGraph cg, Set<CGNode> keep)	Create a pruned (filtered) view of an existing call graph.
PrunedCallGraph(CallGraph cg, Set<CGNode> keep, Map<CGNode,Set<CGNode>> remove)

Method Summary

Modifier and Type	Method	Description
void	addEdge(CGNode src, CGNode dst)
void	addNode(CGNode n)	add a node to this graph
boolean	containsNode(CGNode n)
IClassHierarchy	getClassHierarchy()
Collection<CGNode>	getEntrypointNodes()
CGNode	getFakeRootNode()	Return the (fake) interprocedural root node of the call graph.
CGNode	getFakeWorldClinitNode()
int	getMaxNumber()
CGNode	getNode(int number)
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
Set<CGNode>	getNodes(MethodReference m)
int	getNumber(CGNode N)
int	getNumberOfNodes()
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
int	getPredNodeCount(CGNode n)	Return the number of immediate predecessor nodes of n
IntSet	getPredNodeNumbers(CGNode node)
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
IntSet	getSuccNodeNumbers(CGNode node)
Iterator<CGNode>	getSuccNodes(CGNode n)	Return an Iterator over the immediate successor nodes of n
boolean	hasEdge(CGNode src, CGNode dst)
Iterator<CGNode>	iterateNodes(IntSet s)
Iterator<CGNode>	iterator()
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	removeNodeAndEdges(CGNode n)	remove a node and all its incident edges
void	removeOutgoingEdges(CGNode node)
Stream<CGNode>	stream()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

PrunedCallGraph

public PrunedCallGraph(CallGraph cg,
 Set<CGNode> keep)

Create a pruned (filtered) view of an existing call graph.

Note: the created instance retains references to cg and keep without making private copies thereof. Be cautious if subsequently modifying cg or keep outside of this class's control. In particular, keep must always be a subset of the nodes in cg or else unexpected behavior may arise.

Parameters:

cg - Underlying call graph to prune

keep - Subset of cg nodes to include in the pruned graph

Throws:

IllegalArgumentException - if any keep node is not a node in cg

PrunedCallGraph

public PrunedCallGraph(CallGraph cg,
 Set<CGNode> keep,
 Map<CGNode,Set<CGNode>> remove)

Method Details

removeNodeAndEdges

public void removeNodeAndEdges(CGNode n)
                        throws UnsupportedOperationException

Description copied from interface: Graph

remove a node and all its incident edges

Specified by:

removeNodeAndEdges in interface Graph<CGNode>

Throws:

UnsupportedOperationException - if the graph implementation does not allow removal

iterator

public Iterator<CGNode> iterator()

Specified by:

iterator in interface Iterable<CGNode>

Specified by:

iterator in interface NodeManager<CGNode>

Returns:

an Iterator of the nodes in this graph

stream

public Stream<CGNode> stream()

Specified by:

stream in interface NodeManager<CGNode>

Returns:

a Stream of the nodes in this graph

getNumberOfNodes

public int getNumberOfNodes()

Specified by:

getNumberOfNodes in interface NodeManager<CGNode>

Returns:

the number of nodes in this graph

addNode

public void addNode(CGNode n)

Description copied from interface: NodeManager

add a node to this graph

Specified by:

addNode in interface NodeManager<CGNode>

removeNode

public void removeNode(CGNode n)
                throws UnsupportedOperationException

Description copied from interface: NodeManager

remove a node from this graph

Specified by:

removeNode in interface NodeManager<CGNode>

Throws:

UnsupportedOperationException

containsNode

public boolean containsNode(CGNode n)

Specified by:

containsNode in interface NodeManager<CGNode>

Returns:

true iff the graph contains the specified node

getPredNodes

public Iterator<CGNode> getPredNodes(CGNode n)

Description copied from interface: EdgeManager

Return an Iterator over the immediate predecessor nodes of n

This method never returns null.

Specified by:

getPredNodes in interface EdgeManager<CGNode>

Returns:

an Iterator over the immediate predecessor nodes of this Node.

getPredNodeCount

public int getPredNodeCount(CGNode n)

Description copied from interface: EdgeManager

Return the number of immediate predecessor nodes of n

Specified by:

getPredNodeCount in interface EdgeManager<CGNode>

Returns:

the number of immediate predecessors of n.

getSuccNodes

public Iterator<CGNode> getSuccNodes(CGNode n)

Description copied from interface: EdgeManager

Return an Iterator over the immediate successor nodes of n

This method never returns null.

Specified by:

getSuccNodes in interface EdgeManager<CGNode>

Returns:

an Iterator over the immediate successor nodes of n

getSuccNodeCount

public int getSuccNodeCount(CGNode n)

Description copied from interface: EdgeManager

Return the number of immediate successor nodes of this Node in the Graph

Specified by:

getSuccNodeCount in interface EdgeManager<CGNode>

Returns:

the number of immediate successor Nodes of this Node in the Graph.

addEdge

public void addEdge(CGNode src,
 CGNode dst)

Specified by:

addEdge in interface EdgeManager<CGNode>

removeEdge

public void removeEdge(CGNode src,
 CGNode dst)
                throws UnsupportedOperationException

Specified by:

removeEdge in interface EdgeManager<CGNode>

Throws:

UnsupportedOperationException

removeAllIncidentEdges

public void removeAllIncidentEdges(CGNode node)
                            throws UnsupportedOperationException

Specified by:

removeAllIncidentEdges in interface EdgeManager<CGNode>

Throws:

UnsupportedOperationException

removeIncomingEdges

public void removeIncomingEdges(CGNode node)
                         throws UnsupportedOperationException

Specified by:

removeIncomingEdges in interface EdgeManager<CGNode>

Throws:

UnsupportedOperationException

removeOutgoingEdges

public void removeOutgoingEdges(CGNode node)
                         throws UnsupportedOperationException

Specified by:

removeOutgoingEdges in interface EdgeManager<CGNode>

Throws:

UnsupportedOperationException

hasEdge

public boolean hasEdge(CGNode src,
 CGNode dst)

Specified by:

hasEdge in interface EdgeManager<CGNode>

getNumber

public int getNumber(CGNode N)

Specified by:

getNumber in interface NumberedNodeManager<CGNode>

getNode

public CGNode getNode(int number)

Specified by:

getNode in interface NumberedNodeManager<CGNode>

getMaxNumber

public int getMaxNumber()

Specified by:

getMaxNumber in interface NumberedNodeManager<CGNode>

iterateNodes

public Iterator<CGNode> iterateNodes(IntSet s)

Specified by:

iterateNodes in interface NumberedNodeManager<CGNode>

Returns:

iterator of nodes with the numbers in set s

getSuccNodeNumbers

public IntSet getSuccNodeNumbers(CGNode node)

Specified by:

getSuccNodeNumbers in interface NumberedEdgeManager<CGNode>

Returns:

the numbers identifying the immediate successors of node

getPredNodeNumbers

public IntSet getPredNodeNumbers(CGNode node)

Specified by:

getPredNodeNumbers in interface NumberedEdgeManager<CGNode>

Returns:

the numbers identifying the immediate predecessors of node

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

getEntrypointNodes

public Collection<CGNode> getEntrypointNodes()

Specified by:

getEntrypointNodes in interface CallGraph

Returns:

an Iterator of the nodes designated as "root nodes"

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:

the node corresponding a method in a context

getNodes

public 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.

getClassHierarchy

public IClassHierarchy getClassHierarchy()

Specified by:

getClassHierarchy in interface CallGraph

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

Specified by:

getPossibleTargets in interface CallGraph

getNumberOfTargets

public int getNumberOfTargets(CGNode node,
 CallSiteReference site)

Specified by:

getNumberOfTargets in interface CallGraph

Returns:

the number of nodes that the call site may dispatch to

getPossibleSites

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

Specified by:

getPossibleSites in interface CallGraph

Returns:

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