Interface IFlowGraph

All Superinterfaces:

EdgeManager<Object>, Graph<Object>, Iterable<Object>, LabeledEdgeManager<Object,IFlowLabel>, LabeledGraph<Object,IFlowLabel>, NodeManager<Object>

All Known Implementing Classes:

AbstractDemandFlowGraph, AbstractFlowGraph, DemandPointerFlowGraph, DemandValueFlowGraph

public interface IFlowGraph
extends LabeledGraph<Object,IFlowLabel>

Method Summary

Modifier and Type	Method	Description
void	addSubgraphForNode(CGNode node)	add representation of flow for a node, if not already present
SSAAbstractInvokeInstruction	getInstrReturningTo(LocalPointerKey pk)	get the SSAInvokeInstruction whose return value is assigned to a pointer key.
Iterator<SSAAbstractInvokeInstruction>	getInstrsPassingParam(LocalPointerKey pk)
Set<CGNode>	getPossibleTargets(CGNode caller, CallSiteReference site, LocalPointerKey actualPk)	get the callees that should be considered at a particular call site
Set<CallerSiteContext>	getPotentialCallers(PointerKey formalPk)
Iterator<PointerKey>	getReadsOfInstanceField(PointerKey pk, IField f)
Iterator<? extends Object>	getReadsOfStaticField(StaticFieldKey sfk)
Iterator<PointerKey>	getWritesToInstanceField(PointerKey pk, IField f)
Iterator<? extends Object>	getWritesToStaticField(StaticFieldKey sfk)
boolean	hasSubgraphForNode(CGNode node)
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 interface com.ibm.wala.util.graph.EdgeManager

addEdge, getPredNodeCount, getPredNodes, getSuccNodeCount, getSuccNodes, hasEdge, removeAllIncidentEdges, removeEdge, removeIncomingEdges, removeOutgoingEdges

Methods inherited from interface com.ibm.wala.util.graph.Graph

removeNodeAndEdges

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.ibm.wala.util.graph.labeled.LabeledEdgeManager

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

Methods inherited from interface com.ibm.wala.util.graph.NodeManager

addNode, containsNode, getNumberOfNodes, iterator, removeNode, stream

Method Details

visitSuccs

void visitSuccs(Object node,
 IFlowLabel.IFlowLabelVisitor v)

Apply a visitor to the successors of some node.

visitPreds

void visitPreds(Object node,
 IFlowLabel.IFlowLabelVisitor v)

Apply a visitor to the predecessors of some node.

addSubgraphForNode

void addSubgraphForNode(CGNode node)
                 throws IllegalArgumentException

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

Throws:

IllegalArgumentException - if node == null

hasSubgraphForNode

boolean hasSubgraphForNode(CGNode node)

isParam

boolean isParam(LocalPointerKey pk)

Returns:

true iff pk is a formal parameter

getInstrsPassingParam

Iterator<SSAAbstractInvokeInstruction> getInstrsPassingParam(LocalPointerKey pk)

Returns:

the SSAInvokeInstructions passing some pointer as a parameter

getInstrReturningTo

SSAAbstractInvokeInstruction getInstrReturningTo(LocalPointerKey pk)

get the SSAInvokeInstruction whose return value is assigned to a pointer key.

Returns:

the instruction, or null if no return value is assigned to pk

getWritesToStaticField

Iterator<? extends Object> getWritesToStaticField(StaticFieldKey sfk)
                                           throws IllegalArgumentException

Parameters:

sfk - the static field

Returns:

all the variables whose values are written to sfk

Throws:

IllegalArgumentException - if sfk == null

getReadsOfStaticField

Iterator<? extends Object> getReadsOfStaticField(StaticFieldKey sfk)
                                          throws IllegalArgumentException

Parameters:

sfk - the static field

Returns:

all the variables that get the value of sfk

Throws:

IllegalArgumentException - if sfk == null

getWritesToInstanceField

Iterator<PointerKey> getWritesToInstanceField(PointerKey pk,
 IField f)

getReadsOfInstanceField

Iterator<PointerKey> getReadsOfInstanceField(PointerKey pk,
 IField f)

getPotentialCallers

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

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

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

Parameters:

caller - 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