Class DataflowSolver<T, V extends IVariable<V>>

java.lang.Object

com.ibm.wala.fixedpoint.impl.AbstractFixedPointSolver<V>

com.ibm.wala.fixedpoint.impl.DefaultFixedPointSolver<V>

com.ibm.wala.dataflow.graph.DataflowSolver<T,V>

All Implemented Interfaces:

FixedPointConstants, IFixedPointSolver<V>, VerboseAction

Direct Known Subclasses:

BitVectorSolver, BooleanSolver, NullPointerSolver

public abstract class DataflowSolver<T, V extends IVariable<V>>
extends DefaultFixedPointSolver<V>

Iterative solver for a Killdall dataflow framework

Nested Class Summary

Nested classes/interfaces inherited from class AbstractFixedPointSolver

AbstractFixedPointSolver.Statement

Modifier and Type	Class	Description
protected class	AbstractFixedPointSolver.Statement

Field Summary

Fields inherited from class AbstractFixedPointSolver

DEFAULT_PERIODIC_MAINTENANCE_INTERVAL, DEFAULT_VERBOSE_INTERVAL, verbose, workList

Modifier and Type	Field	Description
static final int	DEFAULT_PERIODIC_MAINTENANCE_INTERVAL
static final int	DEFAULT_VERBOSE_INTERVAL
static final boolean	verbose
protected Worklist	workList	worklist for the iterative solver

Fields inherited from interface FixedPointConstants

CHANGED, CHANGED_AND_FIXED, CHANGED_MASK, FIXED_MASK, NOT_CHANGED, NOT_CHANGED_AND_FIXED, SIDE_EFFECT_MASK

Modifier and Type	Field	Description
static final byte	CHANGED	A return value which indicates that a lhs has changed, and the statement might need to be evaluated again.
static final byte	CHANGED_AND_FIXED	A return value which indicates that lhs has changed, and the statement need not be evaluated again.
static final int	CHANGED_MASK	The bit-mask which defines the "CHANGED" flag
static final int	FIXED_MASK	The bit-mask which defines the "FIXED" flag
static final byte	NOT_CHANGED	A return value which indicates that lhs has not changed, and the statement might need to be evaluated again.
static final byte	NOT_CHANGED_AND_FIXED	A return value which indicates that lhs has not changed, and the statement need not be evaluated again.
static final int	SIDE_EFFECT_MASK	The bit-mask which defines the "SIDE EFFECT" flag

Constructor Summary

Constructors

Constructor	Description
DataflowSolver(IKilldallFramework<T,V> problem)

Method Summary

Modifier and Type	Method	Description
protected void	buildEquations(boolean toWorkList, boolean eager)
@Nullable V	getEdge(Object key)
V	getEdge(Object src, Object dst)
V	getIn(Object node)
V	getOut(Object node)
IKilldallFramework<T,V>	getProblem()
protected void	initializeVariables()	Initialize all lattice vars in the system.
protected void	initializeWorkList()	Initialize the work list for iteration.j
protected abstract V	makeEdgeVariable(T src, T dst)
protected abstract V	makeNodeVariable(T n, boolean IN)

Methods inherited from class DefaultFixedPointSolver

getFixedPointSystem

Modifier and Type	Method	Description
IFixedPointSystem<V>	getFixedPointSystem()

Methods inherited from class AbstractFixedPointSolver

addAllStatementsToWorkList, addToWorkList, changedVariable, emptyWorkList, getMaxEvalBetweenTopo, getMinSizeForTopSort, getNumberOfEvaluations, getPeriodicMaintainInterval, getStatements, getTopologicalGrowthFactor, getVerboseInterval, incNumberOfEvaluations, initForFirstSolve, isChanged, isFixed, isSideEffect, lineBreak, makeStmtRHS, newStatement, newStatement, newStatement, newStatement, newStatement, orderStatements, performVerboseAction, periodicMaintenance, removeStatement, setMaxEvalBetweenTopo, setMinEquationsForTopSort, setTopologicalGrowthFactor, solve, toString

Modifier and Type	Method	Description
void	addAllStatementsToWorkList()	Add all to the work list.
void	addToWorkList(AbstractStatement s)	Add a step to the work list.
void	changedVariable(V v)	Call this method when the contents of a variable changes.
boolean	emptyWorkList()
int	getMaxEvalBetweenTopo()
int	getMinSizeForTopSort()
int	getNumberOfEvaluations()
protected int	getPeriodicMaintainInterval()	subclasses should override as desired.
Iterator<? extends INodeWithNumber>	getStatements()
double	getTopologicalGrowthFactor()
protected int	getVerboseInterval()	subclasses should override as desired.
void	incNumberOfEvaluations()
void	initForFirstSolve()	Some setup which occurs only before the first solve
static boolean	isChanged(byte code)
static boolean	isFixed(byte code)
static boolean	isSideEffect(byte code)
static String	lineBreak(String string, int wrap)
protected abstract V[]	makeStmtRHS(int size)
boolean	newStatement(V lhs, NullaryOperator<V> operator, boolean toWorkList, boolean eager)	Add a step with zero operands on the right-hand side.
boolean	newStatement(V lhs, AbstractOperator<V> operator, V[] rhs, boolean toWorkList, boolean eager)	Add a step to the system with an arbitrary number of operands on the right-hand side.
boolean	newStatement(V lhs, AbstractOperator<V> operator, V op1, V op2, boolean toWorkList, boolean eager)	Add an equation with two operands on the right-hand side.
boolean	newStatement(V lhs, AbstractOperator<V> operator, V op1, V op2, V op3, boolean toWorkList, boolean eager)	Add a step with three operands on the right-hand side.
boolean	newStatement(V lhs, UnaryOperator<V> operator, V rhs, boolean toWorkList, boolean eager)	Add a step with one operand on the right-hand side.
void	orderStatements()
void	performVerboseAction()	optional method used for performance debugging
protected void	periodicMaintenance()	a method that will be called every N evaluations.
void	removeStatement(AbstractStatement<V,?> s)
void	setMaxEvalBetweenTopo(int i)
void	setMinEquationsForTopSort(int i)
void	setTopologicalGrowthFactor(double d)
boolean	solve(MonitorUtil.IProgressMonitor monitor)	Solve the set of dataflow graph.
String	toString()

Methods inherited from class Object

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

Constructor Details

DataflowSolver

public DataflowSolver(IKilldallFramework<T,V> problem)

Method Details

makeNodeVariable

protected abstract V makeNodeVariable(T n,
 boolean IN)

Parameters:

n - a node

Returns:

a fresh variable to represent the lattice value at the IN or OUT of n

makeEdgeVariable

protected abstract V makeEdgeVariable(T src,
 T dst)

initializeVariables

protected void initializeVariables()

Description copied from class: AbstractFixedPointSolver

Initialize all lattice vars in the system.

Specified by:

initializeVariables in class AbstractFixedPointSolver<V extends IVariable<V>>

initializeWorkList

protected void initializeWorkList()

Description copied from class: AbstractFixedPointSolver

Initialize the work list for iteration.j

Specified by:

initializeWorkList in class AbstractFixedPointSolver<V extends IVariable<V>>

getOut

@NullUnmarked
public V getOut(Object node)

getIn

@NullUnmarked
public V getIn(Object node)

getEdge

public @Nullable V getEdge(Object key)

getEdge

public V getEdge(Object src,
 Object dst)

buildEquations

protected void buildEquations(boolean toWorkList,
 boolean eager)

getProblem

public IKilldallFramework<T,V> getProblem()