Interface HeapModel

All Superinterfaces:

InstanceKeyFactory, PointerKeyFactory

All Known Subinterfaces:

AstHeapModel, ExtendedHeapModel

All Known Implementing Classes:

AstJavaCFABuilder, AstJavaSSAPropagationCallGraphBuilder, AstJavaZeroOneContainerCFABuilder, AstJavaZeroXCFABuilder, AstSSAPropagationCallGraphBuilder, CrossLanguageSSAPropagationCallGraphBuilder, DelegatingExtendedHeapModel, JavaJavaScriptHybridCallGraphBuilder, JSCFABuilder, JSSSAPropagationCallGraphBuilder, JSZeroOrOneXCFABuilder, nCFABuilder, nObjBuilder, PointerAnalysisImpl.HModel, SSAPropagationCallGraphBuilder, TypeBasedHeapModel, ZeroXCFABuilder, ZeroXContainerCFABuilder

public interface HeapModel
extends InstanceKeyFactory, PointerKeyFactory

A HeapModel embodies how a pointer analysis abstracts heap locations.

Method Summary

Modifier and Type	Method	Description
IClassHierarchy	getClassHierarchy()
Iterator<PointerKey>	iteratePointerKeys()

Methods inherited from interface InstanceKeyFactory

getInstanceKeyForAllocation, getInstanceKeyForConstant, getInstanceKeyForMetadataObject, getInstanceKeyForMultiNewArray, getInstanceKeyForPEI

Modifier and Type	Method	Description
InstanceKey	getInstanceKeyForAllocation(CGNode node, NewSiteReference allocation)
<T> InstanceKey	getInstanceKeyForConstant(TypeReference type, T S)
InstanceKey	getInstanceKeyForMetadataObject(Object obj, TypeReference objType)
InstanceKey	getInstanceKeyForMultiNewArray(CGNode node, NewSiteReference allocation, int dim)
InstanceKey	getInstanceKeyForPEI(CGNode node, ProgramCounter instr, TypeReference type)

Methods inherited from interface PointerKeyFactory

getFilteredPointerKeyForLocal, getPointerKeyForArrayContents, getPointerKeyForExceptionalReturnValue, getPointerKeyForInstanceField, getPointerKeyForLocal, getPointerKeyForReturnValue, getPointerKeyForStaticField

Modifier and Type	Method	Description
FilteredPointerKey	getFilteredPointerKeyForLocal(CGNode node, int valueNumber, FilteredPointerKey.TypeFilter filter)
PointerKey	getPointerKeyForArrayContents(InstanceKey I)	TODO: expand this API to differentiate between different array indices
PointerKey	getPointerKeyForExceptionalReturnValue(CGNode node)
PointerKey	getPointerKeyForInstanceField(InstanceKey I, IField field)
PointerKey	getPointerKeyForLocal(CGNode node, int valueNumber)
PointerKey	getPointerKeyForReturnValue(CGNode node)
PointerKey	getPointerKeyForStaticField(IField f)

Method Details

iteratePointerKeys

Iterator<PointerKey> iteratePointerKeys()

Returns:

an Iterator of all PointerKeys that are modeled.

getClassHierarchy

IClassHierarchy getClassHierarchy()

Returns:

the governing class hierarchy for this heap model