Class ExplicitCallGraph

java.lang.Object

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

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

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

com.ibm.wala.ipa.callgraph.impl.ExplicitCallGraph

All Implemented Interfaces:

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

Direct Known Subclasses:

AstCallGraph, DelegatingExplicitCallGraph

public class ExplicitCallGraph
extends BasicCallGraph<SSAContextInterpreter>
implements BytecodeConstants

A call graph which explicitly holds the target for each call site in each node.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ExplicitCallGraph.ExplicitEdgeManager
class	ExplicitCallGraph.ExplicitNode

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

Modifier and Type	Field	Description
protected final IClassHierarchy	cha
protected final AnalysisOptions	options

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.

Fields inherited from interface BytecodeConstants

JBC_aaload, JBC_aastore, JBC_aconst_null, JBC_aload, JBC_aload_0, JBC_aload_1, JBC_aload_2, JBC_aload_3, JBC_anewarray, JBC_areturn, JBC_arraylength, JBC_astore, JBC_astore_0, JBC_astore_1, JBC_astore_2, JBC_astore_3, JBC_athrow, JBC_baload, JBC_bastore, JBC_bipush, JBC_caload, JBC_castore, JBC_checkcast, JBC_d2f, JBC_d2i, JBC_d2l, JBC_dadd, JBC_daload, JBC_dastore, JBC_dcmpg, JBC_dcmpl, JBC_dconst_0, JBC_dconst_1, JBC_ddiv, JBC_dload, JBC_dload_0, JBC_dload_1, JBC_dload_2, JBC_dload_3, JBC_dmul, JBC_dneg, JBC_drem, JBC_dreturn, JBC_dstore, JBC_dstore_0, JBC_dstore_1, JBC_dstore_2, JBC_dstore_3, JBC_dsub, JBC_dup, JBC_dup_x1, JBC_dup_x2, JBC_dup2, JBC_dup2_x1, JBC_dup2_x2, JBC_f2d, JBC_f2i, JBC_f2l, JBC_fadd, JBC_faload, JBC_fastore, JBC_fcmpg, JBC_fcmpl, JBC_fconst_0, JBC_fconst_1, JBC_fconst_2, JBC_fdiv, JBC_fload, JBC_fload_0, JBC_fload_1, JBC_fload_2, JBC_fload_3, JBC_fmul, JBC_fneg, JBC_frem, JBC_freturn, JBC_fstore, JBC_fstore_0, JBC_fstore_1, JBC_fstore_2, JBC_fstore_3, JBC_fsub, JBC_getfield, JBC_getstatic, JBC_goto, JBC_goto_w, JBC_i2d, JBC_i2f, JBC_i2l, JBC_iadd, JBC_iaload, JBC_iand, JBC_iastore, JBC_iconst_0, JBC_iconst_1, JBC_iconst_2, JBC_iconst_3, JBC_iconst_4, JBC_iconst_5, JBC_iconst_m1, JBC_idiv, JBC_if_acmpeq, JBC_if_acmpne, JBC_if_icmpeq, JBC_if_icmpge, JBC_if_icmpgt, JBC_if_icmple, JBC_if_icmplt, JBC_if_icmpne, JBC_ifeq, JBC_ifge, JBC_ifgt, JBC_ifle, JBC_iflt, JBC_ifne, JBC_ifnonnull, JBC_ifnull, JBC_iinc, JBC_iload, JBC_iload_0, JBC_iload_1, JBC_iload_2, JBC_iload_3, JBC_impdep1, JBC_impdep2, JBC_imul, JBC_ineg, JBC_instanceof, JBC_int2byte, JBC_int2char, JBC_int2short, JBC_invokeinterface, JBC_invokespecial, JBC_invokestatic, JBC_invokevirtual, JBC_ior, JBC_irem, JBC_ireturn, JBC_ishl, JBC_ishr, JBC_istore, JBC_istore_0, JBC_istore_1, JBC_istore_2, JBC_istore_3, JBC_isub, JBC_iushr, JBC_ixor, JBC_jsr, JBC_jsr_w, JBC_l2d, JBC_l2f, JBC_l2i, JBC_ladd, JBC_laload, JBC_land, JBC_lastore, JBC_lcmp, JBC_lconst_0, JBC_lconst_1, JBC_ldc, JBC_ldc_w, JBC_ldc2_w, JBC_ldiv, JBC_length, JBC_lload, JBC_lload_0, JBC_lload_1, JBC_lload_2, JBC_lload_3, JBC_lmul, JBC_lneg, JBC_lookupswitch, JBC_lor, JBC_lrem, JBC_lreturn, JBC_lshl, JBC_lshr, JBC_lstore, JBC_lstore_0, JBC_lstore_1, JBC_lstore_2, JBC_lstore_3, JBC_lsub, JBC_lushr, JBC_lxor, JBC_monitorenter, JBC_monitorexit, JBC_multianewarray, JBC_name, JBC_new, JBC_newarray, JBC_nop, JBC_pop, JBC_pop2, JBC_putfield, JBC_putstatic, JBC_ret, JBC_return, JBC_saload, JBC_sastore, JBC_sipush, JBC_swap, JBC_tableswitch, JBC_wide, JBC_xxxunusedxxx

Modifier and Type	Field	Description
static final int	JBC_aaload
static final int	JBC_aastore
static final int	JBC_aconst_null
static final int	JBC_aload
static final int	JBC_aload_0
static final int	JBC_aload_1
static final int	JBC_aload_2
static final int	JBC_aload_3
static final int	JBC_anewarray
static final int	JBC_areturn
static final int	JBC_arraylength
static final int	JBC_astore
static final int	JBC_astore_0
static final int	JBC_astore_1
static final int	JBC_astore_2
static final int	JBC_astore_3
static final int	JBC_athrow
static final int	JBC_baload
static final int	JBC_bastore
static final int	JBC_bipush
static final int	JBC_caload
static final int	JBC_castore
static final int	JBC_checkcast
static final int	JBC_d2f
static final int	JBC_d2i
static final int	JBC_d2l
static final int	JBC_dadd
static final int	JBC_daload
static final int	JBC_dastore
static final int	JBC_dcmpg
static final int	JBC_dcmpl
static final int	JBC_dconst_0
static final int	JBC_dconst_1
static final int	JBC_ddiv
static final int	JBC_dload
static final int	JBC_dload_0
static final int	JBC_dload_1
static final int	JBC_dload_2
static final int	JBC_dload_3
static final int	JBC_dmul
static final int	JBC_dneg
static final int	JBC_drem
static final int	JBC_dreturn
static final int	JBC_dstore
static final int	JBC_dstore_0
static final int	JBC_dstore_1
static final int	JBC_dstore_2
static final int	JBC_dstore_3
static final int	JBC_dsub
static final int	JBC_dup
static final int	JBC_dup_x1
static final int	JBC_dup_x2
static final int	JBC_dup2
static final int	JBC_dup2_x1
static final int	JBC_dup2_x2
static final int	JBC_f2d
static final int	JBC_f2i
static final int	JBC_f2l
static final int	JBC_fadd
static final int	JBC_faload
static final int	JBC_fastore
static final int	JBC_fcmpg
static final int	JBC_fcmpl
static final int	JBC_fconst_0
static final int	JBC_fconst_1
static final int	JBC_fconst_2
static final int	JBC_fdiv
static final int	JBC_fload
static final int	JBC_fload_0
static final int	JBC_fload_1
static final int	JBC_fload_2
static final int	JBC_fload_3
static final int	JBC_fmul
static final int	JBC_fneg
static final int	JBC_frem
static final int	JBC_freturn
static final int	JBC_fstore
static final int	JBC_fstore_0
static final int	JBC_fstore_1
static final int	JBC_fstore_2
static final int	JBC_fstore_3
static final int	JBC_fsub
static final int	JBC_getfield
static final int	JBC_getstatic
static final int	JBC_goto
static final int	JBC_goto_w
static final int	JBC_i2d
static final int	JBC_i2f
static final int	JBC_i2l
static final int	JBC_iadd
static final int	JBC_iaload
static final int	JBC_iand
static final int	JBC_iastore
static final int	JBC_iconst_0
static final int	JBC_iconst_1
static final int	JBC_iconst_2
static final int	JBC_iconst_3
static final int	JBC_iconst_4
static final int	JBC_iconst_5
static final int	JBC_iconst_m1
static final int	JBC_idiv
static final int	JBC_if_acmpeq
static final int	JBC_if_acmpne
static final int	JBC_if_icmpeq
static final int	JBC_if_icmpge
static final int	JBC_if_icmpgt
static final int	JBC_if_icmple
static final int	JBC_if_icmplt
static final int	JBC_if_icmpne
static final int	JBC_ifeq
static final int	JBC_ifge
static final int	JBC_ifgt
static final int	JBC_ifle
static final int	JBC_iflt
static final int	JBC_ifne
static final int	JBC_ifnonnull
static final int	JBC_ifnull
static final int	JBC_iinc
static final int	JBC_iload
static final int	JBC_iload_0
static final int	JBC_iload_1
static final int	JBC_iload_2
static final int	JBC_iload_3
static final int	JBC_impdep1
static final int	JBC_impdep2
static final int	JBC_imul
static final int	JBC_ineg
static final int	JBC_instanceof
static final int	JBC_int2byte
static final int	JBC_int2char
static final int	JBC_int2short
static final int	JBC_invokeinterface
static final int	JBC_invokespecial
static final int	JBC_invokestatic
static final int	JBC_invokevirtual
static final int	JBC_ior
static final int	JBC_irem
static final int	JBC_ireturn
static final int	JBC_ishl
static final int	JBC_ishr
static final int	JBC_istore
static final int	JBC_istore_0
static final int	JBC_istore_1
static final int	JBC_istore_2
static final int	JBC_istore_3
static final int	JBC_isub
static final int	JBC_iushr
static final int	JBC_ixor
static final int	JBC_jsr
static final int	JBC_jsr_w
static final int	JBC_l2d
static final int	JBC_l2f
static final int	JBC_l2i
static final int	JBC_ladd
static final int	JBC_laload
static final int	JBC_land
static final int	JBC_lastore
static final int	JBC_lcmp
static final int	JBC_lconst_0
static final int	JBC_lconst_1
static final int	JBC_ldc
static final int	JBC_ldc_w
static final int	JBC_ldc2_w
static final int	JBC_ldiv
static final byte[]	JBC_length
static final int	JBC_lload
static final int	JBC_lload_0
static final int	JBC_lload_1
static final int	JBC_lload_2
static final int	JBC_lload_3
static final int	JBC_lmul
static final int	JBC_lneg
static final int	JBC_lookupswitch
static final int	JBC_lor
static final int	JBC_lrem
static final int	JBC_lreturn
static final int	JBC_lshl
static final int	JBC_lshr
static final int	JBC_lstore
static final int	JBC_lstore_0
static final int	JBC_lstore_1
static final int	JBC_lstore_2
static final int	JBC_lstore_3
static final int	JBC_lsub
static final int	JBC_lushr
static final int	JBC_lxor
static final int	JBC_monitorenter
static final int	JBC_monitorexit
static final int	JBC_multianewarray
static final String[]	JBC_name	Bytecode names (for debugging/printing)
static final int	JBC_new
static final int	JBC_newarray
static final int	JBC_nop
static final int	JBC_pop
static final int	JBC_pop2
static final int	JBC_putfield
static final int	JBC_putstatic
static final int	JBC_ret
static final int	JBC_return
static final int	JBC_saload
static final int	JBC_sastore
static final int	JBC_sipush
static final int	JBC_swap
static final int	JBC_tableswitch
static final int	JBC_wide
static final int	JBC_xxxunusedxxx

Constructor Summary

Constructors

Constructor	Description
ExplicitCallGraph(IMethod fakeRootMethod, AnalysisOptions options, IAnalysisCacheView cache)

Method Summary

Modifier and Type	Method	Description
CGNode	findOrCreateNode(IMethod method, Context context)	Use with extreme care.
IAnalysisCacheView	getAnalysisCache()
IClassHierarchy	getClassHierarchy()
NumberedEdgeManager<CGNode>	getEdgeManager()
int	getNumberOfTargets(CGNode node, CallSiteReference site)
Iterator<CallSiteReference>	getPossibleSites(CGNode src, CGNode target)
IntSet	getPossibleTargetNumbers(CGNode node, CallSiteReference site)
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
protected ExplicitCallGraph.ExplicitEdgeManager	makeEdgeManger()
protected CGNode	makeFakeRootNode()	subclasses may wish to override!
protected CGNode	makeFakeWorldClinitNode()	subclasses may wish to override!
protected ExplicitCallGraph.ExplicitNode	makeNode(IMethod method, Context context)	subclasses may wish to override!

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 SSAContextInterpreter	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(SSAContextInterpreter 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

Field Details

cha

protected final IClassHierarchy cha

options

protected final AnalysisOptions options

Constructor Details

ExplicitCallGraph

public ExplicitCallGraph(IMethod fakeRootMethod,
 AnalysisOptions options,
 IAnalysisCacheView cache)

Method Details

makeNode

protected ExplicitCallGraph.ExplicitNode makeNode(IMethod method,
 Context context)

subclasses may wish to override!

makeFakeRootNode

protected CGNode makeFakeRootNode()
                           throws CancelException

subclasses may wish to override!

Specified by:

makeFakeRootNode in class BasicCallGraph<SSAContextInterpreter>

Throws:

CancelException

makeFakeWorldClinitNode

protected CGNode makeFakeWorldClinitNode()
                                  throws CancelException

subclasses may wish to override!

Specified by:

makeFakeWorldClinitNode in class BasicCallGraph<SSAContextInterpreter>

Throws:

CancelException

findOrCreateNode

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

Description copied from class: BasicCallGraph

Use with extreme care.

Specified by:

findOrCreateNode in class BasicCallGraph<SSAContextInterpreter>

Throws:

CancelException - TODO

getClassHierarchy

public IClassHierarchy getClassHierarchy()

Specified by:

getClassHierarchy in interface CallGraph

Returns:

the governing class hierarchy for this call graph

See Also:

• CallGraph.getClassHierarchy()

getEdgeManager

public NumberedEdgeManager<CGNode> getEdgeManager()

Specified by:

getEdgeManager in class AbstractNumberedGraph<CGNode>

Returns:

Returns the edgeManger.

makeEdgeManger

protected ExplicitCallGraph.ExplicitEdgeManager makeEdgeManger()

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.

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

getPossibleTargetNumbers

public IntSet getPossibleTargetNumbers(CGNode node,
 CallSiteReference site)

getAnalysisCache

public IAnalysisCacheView getAnalysisCache()