Package pascal.taie.analysis.graph.callgraph

Class AbstractCallGraph<CallSite,Method>

java.lang.Object

pascal.taie.analysis.graph.callgraph.AbstractCallGraph<CallSite,Method>

Type Parameters:

CallSite - type of call sites

Method - type of methods

All Implemented Interfaces:

Serializable, Iterable<Method>, CallGraph<CallSite,Method>, StmtResult<Set<Method>>, Graph<Method>

Direct Known Subclasses:

CSCallGraph, DefaultCallGraph

public abstract class AbstractCallGraph<CallSite,Method>
extends Object
implements CallGraph<CallSite,Method>

Common functionality for CallGraph implementations. This class contains the data structures and methods for storing and accessing information of a call graph. The logic of modifying (adding new call edges and methods) is left to its subclasses.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final MultiMap<Method,Edge<CallSite,Method>>	calleeToEdges
protected final MultiMap<Method,CallSite>	callSitesIn
protected final Map<CallSite,Method>	callSiteToContainer
protected final MultiMap<CallSite,Edge<CallSite,Method>>	callSiteToEdges
protected final Set<Method>	entryMethods
protected Set<Method>	reachableMethods	Set of reachable methods.

Constructor Summary

Constructors

Constructor	Description
AbstractCallGraph()

Method Summary

Modifier and Type	Method	Description
boolean	contains(Method method)
Stream<Edge<CallSite,Method>>	edges()
Stream<Edge<CallSite,Method>>	edgesInTo(Method method)
Stream<Edge<CallSite,Method>>	edgesOutOf(CallSite callSite)
Stream<Method>	entryMethods()
Set<Method>	getCalleesOf(CallSite callSite)
Set<Method>	getCalleesOfM(Method caller)
Set<CallSite>	getCallersOf(Method callee)
Set<CallSite>	getCallSitesIn(Method method)
Method	getContainerOf(CallSite callSite)
Set<pascal.taie.analysis.graph.callgraph.MethodEdge<CallSite,Method>>	getInEdgesOf(Method method)
Set<Method>	getNodes()
int	getNumberOfEdges()
int	getNumberOfMethods()
Set<pascal.taie.analysis.graph.callgraph.MethodEdge<CallSite,Method>>	getOutEdgesOf(Method method)
Set<Method>	getPredsOf(Method node)
Set<Method>	getSuccsOf(Method node)
Stream<Method>	reachableMethods()

Methods inherited from class java.lang.Object

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

Methods inherited from interface pascal.taie.analysis.graph.callgraph.CallGraph

callSitesIn

Methods inherited from interface pascal.taie.util.graph.Graph

getInDegreeOf, getNumberOfNodes, getOutDegreeOf, hasEdge, hasEdge, hasNode, iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface pascal.taie.analysis.StmtResult

getResult, isRelevant

Field Details

callSiteToEdges

protected final MultiMap<CallSite,Edge<CallSite,Method>> callSiteToEdges

calleeToEdges

protected final MultiMap<Method,Edge<CallSite,Method>> calleeToEdges

callSiteToContainer

protected final Map<CallSite,Method> callSiteToContainer

callSitesIn

protected final MultiMap<Method,CallSite> callSitesIn

entryMethods

protected final Set<Method> entryMethods

reachableMethods

protected Set<Method> reachableMethods

Set of reachable methods. This field is not final so that it allows subclasses choose more efficient data structure.

Constructor Details

AbstractCallGraph

public AbstractCallGraph()

Method Details

getCallersOf

public Set<CallSite> getCallersOf(Method callee)

Specified by:

getCallersOf in interface CallGraph<CallSite,Method>

Returns:

the call sites that invoke the given method.

getCalleesOf

public Set<Method> getCalleesOf(CallSite callSite)

Specified by:

getCalleesOf in interface CallGraph<CallSite,Method>

Returns:

the methods that are called by the given call site.

getCalleesOfM

public Set<Method> getCalleesOfM(Method caller)

Specified by:

getCalleesOfM in interface CallGraph<CallSite,Method>

Returns:

the methods that are called by all call sites in the given method.

getContainerOf

public Method getContainerOf(CallSite callSite)

Specified by:

getContainerOf in interface CallGraph<CallSite,Method>

Returns:

the method that contains the given call site.

getCallSitesIn

public Set<CallSite> getCallSitesIn(Method method)

Specified by:

getCallSitesIn in interface CallGraph<CallSite,Method>

Returns:

the call sites within the given method.

edgesOutOf

public Stream<Edge<CallSite,Method>> edgesOutOf(CallSite callSite)

Specified by:

edgesOutOf in interface CallGraph<CallSite,Method>

Returns:

the call edges out of the given call site.

edgesInTo

public Stream<Edge<CallSite,Method>> edgesInTo(Method method)

Specified by:

edgesInTo in interface CallGraph<CallSite,Method>

Returns:

the call edges targeting to the given method.

edges

public Stream<Edge<CallSite,Method>> edges()

Specified by:

edges in interface CallGraph<CallSite,Method>

Returns:

all call edges in this call graph.

getNumberOfEdges

public int getNumberOfEdges()

Specified by:

getNumberOfEdges in interface CallGraph<CallSite,Method>

Returns:

the number of call graph edges in this call graph.

entryMethods

public Stream<Method> entryMethods()

Specified by:

entryMethods in interface CallGraph<CallSite,Method>

Returns:

the entry methods of this call graph.

reachableMethods

public Stream<Method> reachableMethods()

Specified by:

reachableMethods in interface CallGraph<CallSite,Method>

Returns:

all reachable methods in this call graph.

getNumberOfMethods

public int getNumberOfMethods()

Specified by:

getNumberOfMethods in interface CallGraph<CallSite,Method>

Returns:

the number of reachable methods in this call graph.

contains

public boolean contains(Method method)

Specified by:

contains in interface CallGraph<CallSite,Method>

Returns:

true if this call graph contains the given method, otherwise false.

getInEdgesOf

public Set<pascal.taie.analysis.graph.callgraph.MethodEdge<CallSite,Method>> getInEdgesOf(Method method)

Specified by:

getInEdgesOf in interface Graph<CallSite>

Returns:

incoming edges of the given node.

getOutEdgesOf

public Set<pascal.taie.analysis.graph.callgraph.MethodEdge<CallSite,Method>> getOutEdgesOf(Method method)

Specified by:

getOutEdgesOf in interface Graph<CallSite>

Returns:

outgoing edges of the given node.

getPredsOf

public Set<Method> getPredsOf(Method node)

Specified by:

getPredsOf in interface Graph<CallSite>

Returns:

the predecessors of given node in this graph.

getSuccsOf

public Set<Method> getSuccsOf(Method node)

Specified by:

getSuccsOf in interface Graph<CallSite>

Returns:

the successors of given node in this graph.

getNodes

public Set<Method> getNodes()

Specified by:

getNodes in interface Graph<CallSite>

Returns:

all nodes of this graph.