Class AbstractDemandFlowGraph

java.lang.Object

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

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

com.ibm.wala.util.graph.labeled.AbstractNumberedLabeledGraph<Object, IFlowLabel>

com.ibm.wala.util.graph.labeled.SlowSparseNumberedLabeledGraph<Object, IFlowLabel>

com.ibm.wala.demandpa.flowgraph.AbstractFlowGraph

com.ibm.wala.demandpa.flowgraph.AbstractDemandFlowGraph

All Implemented Interfaces:

IFlowGraph, EdgeManager<Object>, Graph<Object>, LabeledEdgeManager<Object, IFlowLabel>, LabeledGraph<Object, IFlowLabel>, NumberedLabeledEdgeManager<Object, IFlowLabel>, NumberedLabeledGraph<Object, IFlowLabel>, NodeManager<Object>, NumberedEdgeManager<Object>, NumberedGraph<Object>, NumberedNodeManager<Object>, Serializable, Iterable<Object>

Direct Known Subclasses:

DemandPointerFlowGraph, DemandValueFlowGraph

public abstract class AbstractDemandFlowGraph
extends AbstractFlowGraph

A graph representing program flow, constructed method-by-method on demand

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractDemandFlowGraph.FlowStatementVisitor

Field Summary

Fields inherited from class AbstractFlowGraph

callDefs, callParams, cg, cha, heapModel, mam, params, returns

Modifier and Type	Field	Description
protected final Map<PointerKey, SSAAbstractInvokeInstruction>	callDefs	Map: LocalPointerKey -> SSAInvokeInstruction.
protected final Map<PointerKey, Set<SSAAbstractInvokeInstruction>>	callParams	Map: LocalPointerKey -> Set<SSAInvokeInstruction>.
protected final CallGraph	cg
protected final IClassHierarchy	cha
protected final HeapModel	heapModel
protected final MemoryAccessMap	mam
protected final Map<PointerKey, CGNode>	params	Map: LocalPointerKey -> CGNode.
protected final Map<PointerKey, CGNode>	returns	Map: LocalPointerKey -> CGNode.

Constructor Summary

Constructors

Constructor	Description
AbstractDemandFlowGraph(CallGraph cg, HeapModel heapModel, MemoryAccessMap mam, IClassHierarchy cha)

Method Summary

Modifier and Type	Method	Description
protected void	addBlockInstructionConstraints(CGNode node, ControlFlowGraph<SSAInstruction, ISSABasicBlock> cfg, ISSABasicBlock b, AbstractDemandFlowGraph.FlowStatementVisitor v)	Add constraints for a particular basic block.
protected void	addNodeInstructionConstraints(CGNode node, IR ir)	Add pointer flow constraints based on instructions in a given node
protected abstract void	addNodesForParameters(CGNode node, IR ir)
void	addSubgraphForNode(CGNode node)	add representation of flow for a node, if not already present
Iterator<PointerKeyAndCallSite>	getParamPreds(LocalPointerKey pk)
Iterator<PointerKeyAndCallSite>	getParamSuccs(LocalPointerKey pk)
Set<CGNode>	getPossibleTargets(CGNode node, CallSiteReference site, LocalPointerKey actualPk)	get the callees that should be considered at a particular call site
Set<CallerSiteContext>	getPotentialCallers(PointerKey formalPk)
Iterator<PointerKeyAndCallSite>	getReturnPreds(LocalPointerKey pk)
Iterator<PointerKeyAndCallSite>	getReturnSuccs(LocalPointerKey pk)
boolean	hasSubgraphForNode(CGNode node)
protected abstract AbstractDemandFlowGraph.FlowStatementVisitor	makeVisitor(CGNode node)
protected void	unconditionallyAddConstraintsFromNode(CGNode node, IR ir)

Methods inherited from class AbstractFlowGraph

addExceptionDefConstraints, addNodeConstantConstraints, addNodePassthruExceptionConstraints, addNodesForInvocations, convertPointerKeyToHeapModel, getArrayReads, getInstrReturningTo, getInstrsPassingParam, getReadsOfInstanceField, getReadsOfStaticField, getWritesToInstanceField, getWritesToStaticField, isParam, visitPreds, visitSuccs

Modifier and Type	Method	Description
protected void	addExceptionDefConstraints(IR ir, CGNode node, List<ProgramCounter> peis, PointerKey exceptionVar, Set<IClass> catchClasses)	Generate constraints which assign exception values into an exception pointer
protected void	addNodeConstantConstraints(CGNode node, IR ir)	add constraints for reference constants assigned to vars
protected void	addNodePassthruExceptionConstraints(CGNode node, IR ir)	Add constraints to represent the flow of exceptions to the exceptional return value for this node
protected void	addNodesForInvocations(CGNode node, IR ir)	For each invocation in the method, add nodes for actual parameters and return values
static PointerKey	convertPointerKeyToHeapModel(PointerKey pk, HeapModel h)	convert a pointer key to one in the memory access map's heap model
protected Iterator<PointerKey>	getArrayReads(PointerKey arrayRef)
SSAAbstractInvokeInstruction	getInstrReturningTo(LocalPointerKey pk)	get the SSAInvokeInstruction whose return value is assigned to a pointer key.
Iterator<SSAAbstractInvokeInstruction>	getInstrsPassingParam(LocalPointerKey pk)
Iterator<PointerKey>	getReadsOfInstanceField(PointerKey pk, IField f)
Iterator<?>	getReadsOfStaticField(StaticFieldKey sfk)
Iterator<PointerKey>	getWritesToInstanceField(PointerKey pk, IField f)
Iterator<?>	getWritesToStaticField(StaticFieldKey sfk)
boolean	isParam(LocalPointerKey pk)
void	visitPreds(Object node, IFlowLabel.IFlowLabelVisitor v)	Apply a visitor to the predecessors of some node.
void	visitSuccs(Object node, IFlowLabel.IFlowLabelVisitor v)	Apply a visitor to the successors of some node.

Methods inherited from class SlowSparseNumberedLabeledGraph

copyInto, duplicate, getEdgeManager, getNodeManager

Modifier and Type	Method	Description
static <T,U> void	copyInto(LabeledGraph<T,U> g, LabeledGraph<T,U> into)
static <T,U> SlowSparseNumberedLabeledGraph<T,U>	duplicate(LabeledGraph<T,U> g)
protected NumberedLabeledEdgeManager<Object, IFlowLabel>	getEdgeManager()
protected NumberedNodeManager<Object>	getNodeManager()

Methods inherited from class AbstractNumberedLabeledGraph

addEdge, edgeString, getDefaultLabel, getEdgeLabels, getPredLabels, getPredNodeCount, getPredNodeNumbers, getPredNodes, getSuccLabels, getSuccNodeCount, getSuccNodeNumbers, getSuccNodes, hasEdge, removeEdge

Modifier and Type	Method	Description
void	addEdge(Object src, Object dst, IFlowLabel label)	adds an edge with some label
protected String	edgeString(Object from, Object to)
IFlowLabel	getDefaultLabel()	Sets the default object used as label for operations where no specific edge label is provided.
Set<? extends IFlowLabel>	getEdgeLabels(Object src, Object dst)	Returns a set of all labeled edges between node src and node dst
Iterator<? extends IFlowLabel>	getPredLabels(Object N)
int	getPredNodeCount(Object N, IFlowLabel label)	Return the number of immediate predecessor nodes of this Node in the Graph on edges with some label.
IntSet	getPredNodeNumbers(Object node, IFlowLabel label)
Iterator<Object>	getPredNodes(Object N, IFlowLabel label)	Return an Iterator over the immediate predecessor nodes of this Node in the Graph on edges with some label.
Iterator<? extends IFlowLabel>	getSuccLabels(Object N)
int	getSuccNodeCount(Object N, IFlowLabel label)	Return the number of immediate successor nodes of this Node in the Graph
IntSet	getSuccNodeNumbers(Object node, IFlowLabel label)
Iterator<? extends Object>	getSuccNodes(Object N, IFlowLabel label)	Return an Iterator over the immediate successor nodes of this Node in the Graph on edges with some label.
boolean	hasEdge(Object src, Object dst, IFlowLabel label)
void	removeEdge(Object src, Object dst, IFlowLabel label)

Methods inherited from class AbstractNumberedGraph

getMaxNumber, getNode, getNumber, getPredNodeNumbers, getSuccNodeNumbers, iterateNodes

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

Methods inherited from class AbstractGraph

addEdge, addNode, containsNode, getNumberOfNodes, getPredNodeCount, getPredNodes, getSuccNodeCount, getSuccNodes, hasEdge, iterator, nodeString, removeAllIncidentEdges, removeEdge, removeIncomingEdges, removeNode, removeNodeAndEdges, removeOutgoingEdges, stream, toString

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

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface LabeledEdgeManager

getPredNodes

Modifier and Type	Method	Description
default Iterator<Object>	getPredNodes(Object N, Predicate<IFlowLabel> pred)

Constructor Details

AbstractDemandFlowGraph

public AbstractDemandFlowGraph(CallGraph cg,
 HeapModel heapModel,
 MemoryAccessMap mam,
 IClassHierarchy cha)

Method Details

addSubgraphForNode

public void addSubgraphForNode(CGNode node)
                        throws IllegalArgumentException

Description copied from interface: IFlowGraph

add representation of flow for a node, if not already present

Throws:

IllegalArgumentException - if node == null

See Also:

• IFlowGraph.addSubgraphForNode(com.ibm.wala.ipa.callgraph.CGNode)

hasSubgraphForNode

public boolean hasSubgraphForNode(CGNode node)

See Also:

• IFlowGraph.hasSubgraphForNode(com.ibm.wala.ipa.callgraph.CGNode)

getParamSuccs

public Iterator<PointerKeyAndCallSite> getParamSuccs(LocalPointerKey pk)

See Also:

• IFlowGraph.getInstrsPassingParam(LocalPointerKey)

getParamPreds

public Iterator<PointerKeyAndCallSite> getParamPreds(LocalPointerKey pk)

See Also:

• IFlowGraph.getInstrsPassingParam(LocalPointerKey)

getReturnSuccs

public Iterator<PointerKeyAndCallSite> getReturnSuccs(LocalPointerKey pk)

See Also:

• IFlowGraph.getInstrReturningTo(LocalPointerKey)

getReturnPreds

public Iterator<PointerKeyAndCallSite> getReturnPreds(LocalPointerKey pk)

See Also:

• IFlowGraph.getInstrReturningTo(LocalPointerKey)

addNodesForParameters

protected abstract void addNodesForParameters(CGNode node,
 IR ir)

unconditionallyAddConstraintsFromNode

protected void unconditionallyAddConstraintsFromNode(CGNode node,
 IR ir)

addNodeInstructionConstraints

protected void addNodeInstructionConstraints(CGNode node,
 IR ir)

Add pointer flow constraints based on instructions in a given node

addBlockInstructionConstraints

protected void addBlockInstructionConstraints(CGNode node,
 ControlFlowGraph<SSAInstruction, ISSABasicBlock> cfg,
 ISSABasicBlock b,
 AbstractDemandFlowGraph.FlowStatementVisitor v)

Add constraints for a particular basic block.

makeVisitor

protected abstract AbstractDemandFlowGraph.FlowStatementVisitor makeVisitor(CGNode node)

getPotentialCallers

public Set<CallerSiteContext> getPotentialCallers(PointerKey formalPk)

Parameters:

formalPk - a PointerKey representing either a formal parameter or return value

Returns:

the CallerSiteContexts representing pointer callers of formalPk's method

getPossibleTargets

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

Description copied from interface: IFlowGraph

get the callees that should be considered at a particular call site

Parameters:

node - the caller

site - the call site

actualPk - a LocalPointerKey corresponding to the actual parameter or return value of interest. This may be used to filter out certain callees.

Returns:

the callees of interest