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<?>	getReadsOfStaticField(StaticFieldKey sfk)
Iterator<PointerKey>	getWritesToInstanceField(PointerKey pk, IField f)
Iterator<?>	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 EdgeManager

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

Modifier and Type	Method	Description
void	addEdge(Object src, Object dst)
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)
void	removeAllIncidentEdges(Object node)
void	removeEdge(Object src, Object dst)
void	removeIncomingEdges(Object node)
void	removeOutgoingEdges(Object node)

Methods inherited from interface Graph

removeNodeAndEdges

Modifier and Type	Method	Description
void	removeNodeAndEdges(Object n)	remove a node and all its incident edges

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface LabeledEdgeManager

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

Modifier and Type	Method	Description
void	addEdge(Object src, Object dst, IFlowLabel label)	adds an edge with some label
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.
default Iterator<Object>	getPredNodes(Object N, Predicate<IFlowLabel> pred)
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
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 interface NodeManager

addNode, containsNode, getNumberOfNodes, iterator, removeNode, stream

Modifier and Type	Method	Description
void	addNode(Object n)	add a node to this graph
boolean	containsNode(Object n)
int	getNumberOfNodes()
default Iterator<Object>	iterator()
void	removeNode(Object n)	remove a node from this graph
Stream<Object>	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<?> 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<?> 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