Class AbstractRTABuilder

java.lang.Object

com.ibm.wala.ipa.callgraph.propagation.PropagationCallGraphBuilder

com.ibm.wala.ipa.callgraph.propagation.rta.AbstractRTABuilder

All Implemented Interfaces:

CallGraphBuilder<InstanceKey>

Direct Known Subclasses:

BasicRTABuilder

public abstract class AbstractRTABuilder
extends PropagationCallGraphBuilder

Abstract superclass of various RTA flavors

Nested Class Summary

Nested classes/interfaces inherited from class PropagationCallGraphBuilder

PropagationCallGraphBuilder.ArrayLoadOperator, PropagationCallGraphBuilder.ArrayStoreOperator, PropagationCallGraphBuilder.FilterOperator, PropagationCallGraphBuilder.GetFieldOperator, PropagationCallGraphBuilder.InstanceArrayStoreOperator, PropagationCallGraphBuilder.InstancePutFieldOperator, PropagationCallGraphBuilder.InverseFilterOperator, PropagationCallGraphBuilder.MutableBoolean, PropagationCallGraphBuilder.PutFieldOperator, PropagationCallGraphBuilder.TypedPointerKey

Field Summary

Fields

Modifier and Type	Field	Description
protected final HashSet<IClass>	allocatedClasses	set of classes (IClass) discovered to be allocated
protected final Set<IClass>	clinitProcessed	set of classes whose clinit are processed
protected final boolean	clone2Assign	Should we change calls to clone() to assignments?
protected static final boolean	DEBUG
protected static final int	DEBUG_LEVEL

Fields inherited from class PropagationCallGraphBuilder

assignOperator, callGraph, cha, contextSelector, DEBUG_GENERAL, entrypointCallSites, filterOperator, instanceKeyFactory, inverseFilterOperator, options, pointerKeyFactory, system

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRTABuilder(IClassHierarchy cha, AnalysisOptions options, IAnalysisCacheView cache, ContextSelector appContextSelector, SSAContextInterpreter appContextInterpreter)

Method Summary

Modifier and Type	Method	Description
protected boolean	addConstraintsFromNode(CGNode node, MonitorUtil.IProgressMonitor monitor)	Visit all instructions in a node, and add dataflow constraints induced by each statement relevant to RTA
protected ExplicitCallGraph	createEmptyCallGraph(IMethod fakeRootClass, AnalysisOptions options)
protected void	customInit()
Set<IClass>	getAllocatedTypes()
protected abstract PointerKey	getKeyForSite(CallSiteReference site)
PointerAnalysis<InstanceKey>	getPointerAnalysis()
protected RTAContextInterpreter	getRTAContextInterpreter()
protected SSAContextInterpreter	makeContextInterpreter(SSAContextInterpreter appContextInterpreter)
protected ContextSelector	makeContextSelector(ContextSelector appContextSelector)
protected abstract UnaryOperator<PointsToSetVariable>	makeDispatchOperator(CallSiteReference site, CGNode node)
protected IPointsToSolver	makeSolver()
protected PropagationSystem	makeSystem(AnalysisOptions options)
protected void	processClassInitializer(IClass klass)
protected boolean	unconditionallyAddConstraintsFromNode(CGNode node, MonitorUtil.IProgressMonitor monitor)
protected abstract void	updateSetsForNewClass(IClass klass, InstanceKey iKey, CGNode node, NewSiteReference ns)	Perform needed bookkeeping when a new class is discovered.
void	visitInvoke(CGNode node, CallSiteReference site)	Add a constraint for a call instruction
void	visitNew(CGNode node, NewSiteReference newSite)	Add a constraint for an allocate

Methods inherited from class PropagationCallGraphBuilder

addAssignmentsForCatchPointerKey, addConstraintsFromChangedNode, addConstraintsFromNewNodes, assignInstanceToCatch, catches, filterForClass, getAnalysisCache, getCallGraph, getClassHierarchy, getContextInterpreter, getContextSelector, getFilteredPointerKeyForLocal, getFilteredPointerKeyForLocal, getFilteredPointerKeyForLocal, getInstanceKeyForAllocation, getInstanceKeyForConstant, getInstanceKeyForMetadataObject, getInstanceKeyForMultiNewArray, getInstanceKeys, getInstanceKeysForClass, getJavaLangObject, getMutableInstanceKeysForClass, getOptions, getPointerKeyFactory, getPointerKeyForArrayContents, getPointerKeyForExceptionalReturnValue, getPointerKeyForInstanceField, getPointerKeyForLocal, getPointerKeyForReturnValue, getPointerKeyForStaticField, getPropagationSystem, getSolver, getSystem, getTargetForCall, haveAlreadyVisited, isJavaLangObject, makeCallGraph, makeCallGraph, markAlreadyVisited, markChanged, markDiscovered, representsNullType, setContextInterpreter, setContextSelector, setInstanceKeys, setPointerKeyFactory, wasChanged

Methods inherited from class Object

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

Field Details

DEBUG_LEVEL

protected static final int DEBUG_LEVEL

See Also:

• Constant Field Values

DEBUG

protected static final boolean DEBUG

See Also:

• Constant Field Values

clone2Assign

protected final boolean clone2Assign

Should we change calls to clone() to assignments?

See Also:

• Constant Field Values

clinitProcessed

protected final Set<IClass> clinitProcessed

set of classes whose clinit are processed

allocatedClasses

protected final HashSet<IClass> allocatedClasses

set of classes (IClass) discovered to be allocated

Constructor Details

AbstractRTABuilder

protected AbstractRTABuilder(IClassHierarchy cha,
 AnalysisOptions options,
 IAnalysisCacheView cache,
 ContextSelector appContextSelector,
 SSAContextInterpreter appContextInterpreter)

Method Details

getRTAContextInterpreter

protected RTAContextInterpreter getRTAContextInterpreter()

addConstraintsFromNode

protected boolean addConstraintsFromNode(CGNode node,
 MonitorUtil.IProgressMonitor monitor)

Visit all instructions in a node, and add dataflow constraints induced by each statement relevant to RTA

Specified by:

addConstraintsFromNode in class PropagationCallGraphBuilder

Returns:

true iff any new constraints are added.

processClassInitializer

protected void processClassInitializer(IClass klass)

visitInvoke

public void visitInvoke(CGNode node,
 CallSiteReference site)

Add a constraint for a call instruction

Throws:

IllegalArgumentException - if site is null

makeDispatchOperator

protected abstract UnaryOperator<PointsToSetVariable> makeDispatchOperator(CallSiteReference site,
 CGNode node)

getKeyForSite

protected abstract PointerKey getKeyForSite(CallSiteReference site)

visitNew

public void visitNew(CGNode node,
 NewSiteReference newSite)

Add a constraint for an allocate

Throws:

IllegalArgumentException - if newSite is null

updateSetsForNewClass

protected abstract void updateSetsForNewClass(IClass klass,
 InstanceKey iKey,
 CGNode node,
 NewSiteReference ns)

Perform needed bookkeeping when a new class is discovered.

customInit

protected void customInit()

Overrides:

customInit in class PropagationCallGraphBuilder

getAllocatedTypes

public Set<IClass> getAllocatedTypes()

Returns:

set of IClasses determined to be allocated

makeSolver

protected IPointsToSolver makeSolver()

Specified by:

makeSolver in class PropagationCallGraphBuilder

makeContextSelector

protected ContextSelector makeContextSelector(ContextSelector appContextSelector)

makeContextInterpreter

protected SSAContextInterpreter makeContextInterpreter(SSAContextInterpreter appContextInterpreter)

unconditionallyAddConstraintsFromNode

protected boolean unconditionallyAddConstraintsFromNode(CGNode node,
 MonitorUtil.IProgressMonitor monitor)

Specified by:

unconditionallyAddConstraintsFromNode in class PropagationCallGraphBuilder

createEmptyCallGraph

protected ExplicitCallGraph createEmptyCallGraph(IMethod fakeRootClass,
 AnalysisOptions options)

Overrides:

createEmptyCallGraph in class PropagationCallGraphBuilder

makeSystem

protected PropagationSystem makeSystem(AnalysisOptions options)

Overrides:

makeSystem in class PropagationCallGraphBuilder

getPointerAnalysis

public PointerAnalysis<InstanceKey> getPointerAnalysis()

Specified by:

getPointerAnalysis in interface CallGraphBuilder<InstanceKey>

Overrides:

getPointerAnalysis in class PropagationCallGraphBuilder

Returns:

the Pointer Analysis information computed as a side-effect of call graph construction.

See Also:

• CallGraphBuilder.getPointerAnalysis()