com.ibm.wala.ipa.cfg

Class AbstractInterproceduralCFG<T extends ISSABasicBlock>

java.lang.Object

com.ibm.wala.ipa.cfg.AbstractInterproceduralCFG<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

ExplodedInterproceduralCFG, InterproceduralCFG

public abstract class AbstractInterproceduralCFG<T extends ISSABasicBlock>
extends java.lang.Object
implements com.ibm.wala.util.graph.NumberedGraph<BasicBlockInContext<T>>

Interprocedural control-flow graph, constructed lazily.

Constructor Summary

Constructors

Constructor and Description
AbstractInterproceduralCFG(CallGraph cg) Build an Interprocedural CFG from a call graph.
AbstractInterproceduralCFG(CallGraph CG, java.util.function.Predicate<CGNode> relevant) Build an Interprocedural CFG from a call graph.

Method Summary

Modifier and Type	Method and Description
void	addEdge(BasicBlockInContext<T> src, BasicBlockInContext<T> dst)
protected void	addEdgesToNonEntryBlock(CGNode n, ControlFlowGraph<?,T> cfg, SSAInstruction[] instrs, T bb) Add edges to the IPCFG for the incoming edges incident on a basic block bb.
void	addNode(BasicBlockInContext<T> n)
void	callGraphUpdated() Should be invoked when the underlying call graph has changed.
boolean	containsNode(BasicBlockInContext<T> N)
CallGraph	getCallGraph()
protected CallSiteReference	getCallSiteForCallBlock(IBasicBlock<SSAInstruction> B, ControlFlowGraph<SSAInstruction,T> cfg) get the CallSiteReference corresponding to the last instruction in B (assumed to be a call)
java.util.Iterator<BasicBlockInContext<T>>	getCallSites(BasicBlockInContext<T> returnBlock, CGNode callee) get the basic blocks which are call sites that may call callee and return to returnBlock if callee is null, answer return sites for which no callee was found.
java.util.Set<CGNode>	getCallTargets(BasicBlockInContext<T> B)
ControlFlowGraph<SSAInstruction,T>	getCFG(BasicBlockInContext<T> B)
abstract ControlFlowGraph<SSAInstruction,T>	getCFG(CGNode n)
CGNode	getCGNode(BasicBlockInContext<T> B)
BasicBlockInContext<T>	getEntry(CGNode n)
BasicBlockInContext<T>	getExit(CGNode n)
protected SSAInstruction	getLastInstructionForBlock(T pb, SSAInstruction[] instrs)
int	getMaxNumber()
BasicBlockInContext<T>	getNode(int number)
int	getNumber(BasicBlockInContext<T> N)
int	getNumberOfNodes()
int	getPredNodeCount(BasicBlockInContext<T> N)
com.ibm.wala.util.intset.IntSet	getPredNodeNumbers(BasicBlockInContext<T> node)
java.util.Iterator<BasicBlockInContext<T>>	getPredNodes(BasicBlockInContext<T> N)
java.util.Iterator<BasicBlockInContext<T>>	getReturnSites(BasicBlockInContext<T> callBlock)
int	getSuccNodeCount(BasicBlockInContext<T> N)
com.ibm.wala.util.intset.IntSet	getSuccNodeNumbers(BasicBlockInContext<T> node)
java.util.Iterator<BasicBlockInContext<T>>	getSuccNodes(BasicBlockInContext<T> N)
boolean	hasCall(BasicBlockInContext<T> B)
protected boolean	hasCall(BasicBlockInContext<T> B, ControlFlowGraph<SSAInstruction,T> cfg)
boolean	hasEdge(BasicBlockInContext<T> src, BasicBlockInContext<T> dst)
boolean	isReturn(BasicBlockInContext<T> bb)
java.util.Iterator<BasicBlockInContext<T>>	iterateNodes(com.ibm.wala.util.intset.IntSet s)
java.util.Iterator<BasicBlockInContext<T>>	iterator()
void	removeAllIncidentEdges(BasicBlockInContext<T> node)
void	removeEdge(BasicBlockInContext<T> src, BasicBlockInContext<T> dst)
void	removeIncomingEdges(BasicBlockInContext<T> node)
void	removeNode(BasicBlockInContext<T> n)
void	removeNodeAndEdges(BasicBlockInContext<T> N)
void	removeOutgoingEdges(BasicBlockInContext<T> node)
java.util.stream.Stream<BasicBlockInContext<T>>	stream()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractInterproceduralCFG

public AbstractInterproceduralCFG(CallGraph cg)

Build an Interprocedural CFG from a call graph. This version defaults to using whatever CFGs the call graph provides by default, and includes all nodes in the call graph.

Parameters:

cg - the call graph

AbstractInterproceduralCFG

public AbstractInterproceduralCFG(CallGraph CG,
                                  java.util.function.Predicate<CGNode> relevant)

Build an Interprocedural CFG from a call graph.

Parameters:

CG - the call graph

relevant - a filter which accepts those call graph nodes which should be included in the I-CFG. Other nodes are ignored.

Method Detail

callGraphUpdated

public void callGraphUpdated()

Should be invoked when the underlying call graph has changed. This will cause certain successor and predecessor edges to be recomputed. USE WITH EXTREME CARE.

getCFG

public abstract ControlFlowGraph<SSAInstruction,T> getCFG(CGNode n)

addEdgesToNonEntryBlock

protected void addEdgesToNonEntryBlock(CGNode n,
                                       ControlFlowGraph<?,T> cfg,
                                       SSAInstruction[] instrs,
                                       T bb)

Add edges to the IPCFG for the incoming edges incident on a basic block bb.

Parameters:

n - a call graph node

cfg - the CFG for n

instrs - the instructions for node n

bb - a basic block in the CFG

getLastInstructionForBlock

protected SSAInstruction getLastInstructionForBlock(T pb,
                                                    SSAInstruction[] instrs)

getCFG

public ControlFlowGraph<SSAInstruction,T> getCFG(BasicBlockInContext<T> B)
                                          throws java.lang.IllegalArgumentException

Returns:

the original CFG from whence B came

Throws:

java.lang.IllegalArgumentException - if B == null

getCGNode

public CGNode getCGNode(BasicBlockInContext<T> B)
                 throws java.lang.IllegalArgumentException

Returns:

the original CGNode from whence B came

Throws:

java.lang.IllegalArgumentException - if B == null

removeNodeAndEdges

public void removeNodeAndEdges(BasicBlockInContext<T> N)
                        throws java.lang.UnsupportedOperationException

Specified by:

removeNodeAndEdges in interface com.ibm.wala.util.graph.Graph<BasicBlockInContext<T extends ISSABasicBlock>>

Throws:

java.lang.UnsupportedOperationException

iterator

public java.util.Iterator<BasicBlockInContext<T>> iterator()

Specified by:

iterator in interface com.ibm.wala.util.graph.NodeManager<BasicBlockInContext<T extends ISSABasicBlock>>

Specified by:

iterator in interface java.lang.Iterable<BasicBlockInContext<T extends ISSABasicBlock>>

stream

public java.util.stream.Stream<BasicBlockInContext<T>> stream()

Specified by:

stream in interface com.ibm.wala.util.graph.NodeManager<BasicBlockInContext<T extends ISSABasicBlock>>

getNumberOfNodes

public int getNumberOfNodes()

Specified by:

getNumberOfNodes in interface com.ibm.wala.util.graph.NodeManager<BasicBlockInContext<T extends ISSABasicBlock>>

addNode

public void addNode(BasicBlockInContext<T> n)
             throws java.lang.UnsupportedOperationException

Specified by:

addNode in interface com.ibm.wala.util.graph.NodeManager<BasicBlockInContext<T extends ISSABasicBlock>>

Throws:

java.lang.UnsupportedOperationException

removeNode

public void removeNode(BasicBlockInContext<T> n)
                throws java.lang.UnsupportedOperationException

Specified by:

removeNode in interface com.ibm.wala.util.graph.NodeManager<BasicBlockInContext<T extends ISSABasicBlock>>

Throws:

java.lang.UnsupportedOperationException

getPredNodes

public java.util.Iterator<BasicBlockInContext<T>> getPredNodes(BasicBlockInContext<T> N)

Specified by:

getPredNodes in interface com.ibm.wala.util.graph.EdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

getPredNodeCount

public int getPredNodeCount(BasicBlockInContext<T> N)

Specified by:

getPredNodeCount in interface com.ibm.wala.util.graph.EdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

getSuccNodes

public java.util.Iterator<BasicBlockInContext<T>> getSuccNodes(BasicBlockInContext<T> N)

Specified by:

getSuccNodes in interface com.ibm.wala.util.graph.EdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

getSuccNodeCount

public int getSuccNodeCount(BasicBlockInContext<T> N)

Specified by:

getSuccNodeCount in interface com.ibm.wala.util.graph.EdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

addEdge

public void addEdge(BasicBlockInContext<T> src,
                    BasicBlockInContext<T> dst)
             throws java.lang.UnsupportedOperationException

Specified by:

addEdge in interface com.ibm.wala.util.graph.EdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

Throws:

java.lang.UnsupportedOperationException

removeEdge

public void removeEdge(BasicBlockInContext<T> src,
                       BasicBlockInContext<T> dst)
                throws java.lang.UnsupportedOperationException

Specified by:

removeEdge in interface com.ibm.wala.util.graph.EdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

Throws:

java.lang.UnsupportedOperationException

removeAllIncidentEdges

public void removeAllIncidentEdges(BasicBlockInContext<T> node)
                            throws java.lang.UnsupportedOperationException

Specified by:

removeAllIncidentEdges in interface com.ibm.wala.util.graph.EdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

Throws:

java.lang.UnsupportedOperationException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

containsNode

public boolean containsNode(BasicBlockInContext<T> N)

Specified by:

containsNode in interface com.ibm.wala.util.graph.NodeManager<BasicBlockInContext<T extends ISSABasicBlock>>

hasCall

public boolean hasCall(BasicBlockInContext<T> B)

Returns:

true iff basic block B ends in a call instuction

hasCall

protected boolean hasCall(BasicBlockInContext<T> B,
                          ControlFlowGraph<SSAInstruction,T> cfg)

Returns:

true iff basic block B ends in a call instuction

getCallTargets

public java.util.Set<CGNode> getCallTargets(BasicBlockInContext<T> B)

Returns:

the set of CGNodes that B may call, according to the governing call graph.

Throws:

java.lang.IllegalArgumentException - if B is null

getCallSiteForCallBlock

protected CallSiteReference getCallSiteForCallBlock(IBasicBlock<SSAInstruction> B,
                                                    ControlFlowGraph<SSAInstruction,T> cfg)

get the CallSiteReference corresponding to the last instruction in B (assumed to be a call)

removeIncomingEdges

public void removeIncomingEdges(BasicBlockInContext<T> node)
                         throws java.lang.UnsupportedOperationException

Specified by:

removeIncomingEdges in interface com.ibm.wala.util.graph.EdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

Throws:

java.lang.UnsupportedOperationException

removeOutgoingEdges

public void removeOutgoingEdges(BasicBlockInContext<T> node)
                         throws java.lang.UnsupportedOperationException

Specified by:

removeOutgoingEdges in interface com.ibm.wala.util.graph.EdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

Throws:

java.lang.UnsupportedOperationException

hasEdge

public boolean hasEdge(BasicBlockInContext<T> src,
                       BasicBlockInContext<T> dst)

Specified by:

hasEdge in interface com.ibm.wala.util.graph.EdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

getNumber

public int getNumber(BasicBlockInContext<T> N)

Specified by:

getNumber in interface com.ibm.wala.util.graph.NumberedNodeManager<BasicBlockInContext<T extends ISSABasicBlock>>

getNode

public BasicBlockInContext<T> getNode(int number)
                               throws com.ibm.wala.util.debug.UnimplementedError

Specified by:

getNode in interface com.ibm.wala.util.graph.NumberedNodeManager<BasicBlockInContext<T extends ISSABasicBlock>>

Throws:

com.ibm.wala.util.debug.UnimplementedError

getMaxNumber

public int getMaxNumber()

Specified by:

getMaxNumber in interface com.ibm.wala.util.graph.NumberedNodeManager<BasicBlockInContext<T extends ISSABasicBlock>>

iterateNodes

public java.util.Iterator<BasicBlockInContext<T>> iterateNodes(com.ibm.wala.util.intset.IntSet s)
                                                        throws com.ibm.wala.util.debug.UnimplementedError

Specified by:

iterateNodes in interface com.ibm.wala.util.graph.NumberedNodeManager<BasicBlockInContext<T extends ISSABasicBlock>>

Throws:

com.ibm.wala.util.debug.UnimplementedError

getSuccNodeNumbers

public com.ibm.wala.util.intset.IntSet getSuccNodeNumbers(BasicBlockInContext<T> node)

Specified by:

getSuccNodeNumbers in interface com.ibm.wala.util.graph.NumberedEdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

getPredNodeNumbers

public com.ibm.wala.util.intset.IntSet getPredNodeNumbers(BasicBlockInContext<T> node)

Specified by:

getPredNodeNumbers in interface com.ibm.wala.util.graph.NumberedEdgeManager<BasicBlockInContext<T extends ISSABasicBlock>>

getEntry

public BasicBlockInContext<T> getEntry(CGNode n)

getExit

public BasicBlockInContext<T> getExit(CGNode n)

getReturnSites

public java.util.Iterator<BasicBlockInContext<T>> getReturnSites(BasicBlockInContext<T> callBlock)

Parameters:

callBlock - node in the IPCFG that ends in a call

Returns:

the nodes that are return sites for this call.

Throws:

java.lang.IllegalArgumentException - if bb is null

getCallSites

public java.util.Iterator<BasicBlockInContext<T>> getCallSites(BasicBlockInContext<T> returnBlock,
                                                               CGNode callee)

get the basic blocks which are call sites that may call callee and return to returnBlock if callee is null, answer return sites for which no callee was found.

isReturn

public boolean isReturn(BasicBlockInContext<T> bb)
                 throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getCallGraph

public CallGraph getCallGraph()

Returns:

the governing CallGraph used to build this ICFG