com.oracle.graal.pointsto

Class PointsToAnalysis

java.lang.Object

com.oracle.graal.pointsto.PointsToAnalysis

All Implemented Interfaces:

BigBang, HeapScanning, ReachabilityAnalysis

public abstract class PointsToAnalysis
extends Object
implements BigBang

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PointsToAnalysis.AnalysisTiming
protected static class	PointsToAnalysis.BucketTiming
static class	PointsToAnalysis.ConstantObjectsProfiler
static interface	PointsToAnalysis.TypeFlowRunnable

Field Summary

Fields

Modifier and Type	Field and Description
Timer	analysisTimer
Timer	checkObjectsTimer
protected boolean	extendedAsserts
protected HostVM	hostVM
protected AnalysisMetaAccess	metaAccess
AtomicLong	numParsedGraphs
Timer	processFeaturesTimer
protected boolean	reportAnalysisStatistics
protected boolean	trackTypeFlowInputs
Timer	typeFlowTimer
protected AnalysisUniverse	universe

Constructor Summary

Constructors

Constructor and Description
PointsToAnalysis(org.graalvm.compiler.options.OptionValues options, AnalysisUniverse universe, HostedProviders providers, HostVM hostVM, ForkJoinPool executorService, Runnable heartbeatCallback, UnsupportedFeatures unsupportedFeatures, boolean strengthenGraalGraphs)

Method Summary

Modifier and Type	Method and Description
AnalysisType	addRootClass(Class<?> clazz, boolean addFields, boolean addArrayClass) Marks given class and all its superclasses as reachable.
AnalysisType	addRootField(Class<?> clazz, String fieldName) Marks given field as accessed.
AnalysisMethod	addRootMethod(AnalysisMethod aMethod) Marks given method as reachable.
AnalysisMethod	addRootMethod(Class<?> clazz, String methodName, Class<?>... parameterTypes) Marks given method as reachable.
AnalysisMethod	addRootMethod(Executable method) Marks given method as reachable.
AnalysisType	addRootStaticField(Class<?> clazz, String fieldName)
AnalysisPolicy	analysisPolicy()
static PointsToAnalysisMethod	assertPointsToAnalysisMethod(AnalysisMethod aMethod)
protected void	checkObjectGraph(ObjectScanner objectScanner) Traverses the object graph to discover references to new types.
void	checkUserLimitations() Checks if all user defined limitations such as the number of types are satisfied.
void	cleanupAfterAnalysis() Clears all intermediary data to reduce the footprint.
AnalysisContextPolicy<AnalysisContext>	contextPolicy()
static ForkJoinPool	createExecutor(org.graalvm.compiler.debug.DebugContext debug, int numberOfThreads)
MethodTypeFlowBuilder	createMethodTypeFlowBuilder(PointsToAnalysis bb, MethodTypeFlow methodFlow)
boolean	doTypeflow()
boolean	executorIsStarted()
boolean	extendedAsserts()
boolean	finish() Performs the analysis.
void	forceUnsafeUpdate(AnalysisField field) Force update of the unsafe loads and unsafe store type flows when a field is registered as unsafe accessed 'on the fly', i.e., during the analysis.
TypeFlow<?>	getAllInstantiatedTypeFlow()
TypeState	getAllInstantiatedTypes()
TypeFlow<?>	getAllSynchronizedTypeFlow()
TypeState	getAllSynchronizedTypeState()
Timer	getAnalysisTimer()
org.graalvm.compiler.core.common.spi.ConstantFieldProvider	getConstantFieldProvider()
jdk.vm.ci.meta.ConstantReflectionProvider	getConstantReflectionProvider()
org.graalvm.compiler.debug.DebugContext	getDebug()
List<org.graalvm.compiler.debug.DebugHandlersFactory>	getDebugHandlerFactories()
CompletionExecutor	getExecutor()
AnalysisType	getGraalNodeListType()
AnalysisType	getGraalNodeType()
Runnable	getHeartbeatCallback()
HostVM	getHostVM()
AnalysisMetaAccess	getMetaAccess()
AnalysisType	getObjectArrayType()
AnalysisType	getObjectType()
org.graalvm.compiler.options.OptionValues	getOptions()
Timer	getProcessFeaturesTimer()
HostedProviders	getProviders()
org.graalvm.compiler.nodes.spi.Replacements	getReplacements()
org.graalvm.compiler.api.replacements.SnippetReflectionProvider	getSnippetReflectionProvider()
AnalysisType	getThreadType()
AnalysisType	getThrowableType()
AnalysisUniverse	getUniverse()
UnsupportedFeatures	getUnsupportedFeatures()
AnalysisType	lookup(jdk.vm.ci.meta.JavaType type)
void	postFlow(TypeFlow<?> operation)
void	postTask(CompletionExecutor.DebugContextRunnable task)
void	printTimers() Prints all analysis timers.
void	printTimerStatistics(PrintWriter out) Prints more detailed information about all analysis timers.
void	registerAsJNIAccessed(AnalysisField field, boolean writable) Performs any necessary additional steps required by the analysis to handle JNI accessed fields.
void	registerUnsafeLoad(OffsetLoadTypeFlow.AbstractUnsafeLoadTypeFlow unsafeLoad)
void	registerUnsafeStore(OffsetStoreTypeFlow.AbstractUnsafeStoreTypeFlow unsafeStore)
boolean	reportAnalysisStatistics()
void	runAnalysis(org.graalvm.compiler.debug.DebugContext debugContext, Function<AnalysisUniverse,Boolean> analysisEndCondition) Iterate until analysis reaches a fixpoint.
HeapScanningPolicy	scanningPolicy()
AnalysisType[]	skippedHeapTypes()
boolean	strengthenGraalGraphs()
boolean	trackConcreteAnalysisObjects(AnalysisType type) By default the analysis tracks all concrete objects for all types (if the analysis is context sensitive).
boolean	trackTypeFlowInputs()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.graal.pointsto.BigBang

isCallAllowed

Field Detail

universe

protected final AnalysisUniverse universe

metaAccess

protected final AnalysisMetaAccess metaAccess

hostVM

protected final HostVM hostVM

trackTypeFlowInputs

protected final boolean trackTypeFlowInputs

reportAnalysisStatistics

protected final boolean reportAnalysisStatistics

extendedAsserts

protected final boolean extendedAsserts

numParsedGraphs

public final AtomicLong numParsedGraphs

typeFlowTimer

public final Timer typeFlowTimer

checkObjectsTimer

public final Timer checkObjectsTimer

processFeaturesTimer

public final Timer processFeaturesTimer

analysisTimer

public final Timer analysisTimer

Constructor Detail

PointsToAnalysis

public PointsToAnalysis(org.graalvm.compiler.options.OptionValues options,
                        AnalysisUniverse universe,
                        HostedProviders providers,
                        HostVM hostVM,
                        ForkJoinPool executorService,
                        Runnable heartbeatCallback,
                        UnsupportedFeatures unsupportedFeatures,
                        boolean strengthenGraalGraphs)

Method Detail

getAnalysisTimer

public Timer getAnalysisTimer()

Specified by:

getAnalysisTimer in interface BigBang

Returns:

the timer for measuring the overall duration of the analysis

getProcessFeaturesTimer

public Timer getProcessFeaturesTimer()

Specified by:

getProcessFeaturesTimer in interface BigBang

Returns:

the timer for measuring the time spent in features

printTimers

public void printTimers()

Description copied from interface: BigBang

Prints all analysis timers.

Specified by:

printTimers in interface BigBang

printTimerStatistics

public void printTimerStatistics(PrintWriter out)

Description copied from interface: BigBang

Prints more detailed information about all analysis timers.

Specified by:

printTimerStatistics in interface BigBang

strengthenGraalGraphs

public boolean strengthenGraalGraphs()

skippedHeapTypes

public AnalysisType[] skippedHeapTypes()

Specified by:

skippedHeapTypes in interface HeapScanning

Returns:

types that should not be crawled

getHeartbeatCallback

public Runnable getHeartbeatCallback()

Specified by:

getHeartbeatCallback in interface BigBang

trackTypeFlowInputs

public boolean trackTypeFlowInputs()

reportAnalysisStatistics

public boolean reportAnalysisStatistics()

extendedAsserts

public boolean extendedAsserts()

Specified by:

extendedAsserts in interface BigBang

getOptions

public org.graalvm.compiler.options.OptionValues getOptions()

Specified by:

getOptions in interface BigBang

getDebugHandlerFactories

public List<org.graalvm.compiler.debug.DebugHandlersFactory> getDebugHandlerFactories()

Specified by:

getDebugHandlerFactories in interface BigBang

getDebug

public org.graalvm.compiler.debug.DebugContext getDebug()

Specified by:

getDebug in interface BigBang

createMethodTypeFlowBuilder

public MethodTypeFlowBuilder createMethodTypeFlowBuilder(PointsToAnalysis bb,
                                                         MethodTypeFlow methodFlow)

registerUnsafeLoad

public void registerUnsafeLoad(OffsetLoadTypeFlow.AbstractUnsafeLoadTypeFlow unsafeLoad)

registerUnsafeStore

public void registerUnsafeStore(OffsetStoreTypeFlow.AbstractUnsafeStoreTypeFlow unsafeStore)

forceUnsafeUpdate

public void forceUnsafeUpdate(AnalysisField field)

Description copied from interface: ReachabilityAnalysis

Force update of the unsafe loads and unsafe store type flows when a field is registered as unsafe accessed 'on the fly', i.e., during the analysis.

Specified by:

forceUnsafeUpdate in interface ReachabilityAnalysis

Parameters:

field - the newly unsafe registered field. We use its declaring type to filter the unsafe access flows that need to be updated.

registerAsJNIAccessed

public void registerAsJNIAccessed(AnalysisField field,
                                  boolean writable)

Description copied from interface: ReachabilityAnalysis

Performs any necessary additional steps required by the analysis to handle JNI accessed fields.

Specified by:

registerAsJNIAccessed in interface ReachabilityAnalysis

trackConcreteAnalysisObjects

public boolean trackConcreteAnalysisObjects(AnalysisType type)

By default the analysis tracks all concrete objects for all types (if the analysis is context sensitive). However, the client of the analysis can opt that some types should be analyzed without tracking concrete objects even when the analysis is context sensitive.

cleanupAfterAnalysis

public void cleanupAfterAnalysis()

Description copied from interface: ReachabilityAnalysis

Clears all intermediary data to reduce the footprint.

Specified by:

cleanupAfterAnalysis in interface ReachabilityAnalysis

analysisPolicy

public AnalysisPolicy analysisPolicy()

Specified by:

analysisPolicy in interface ReachabilityAnalysis

Returns:

policy used when running the analysis

contextPolicy

public AnalysisContextPolicy<AnalysisContext> contextPolicy()

getUniverse

public AnalysisUniverse getUniverse()

Specified by:

getUniverse in interface ReachabilityAnalysis

Returns:

universe containing all known analysis types

getProviders

public HostedProviders getProviders()

Specified by:

getProviders in interface BigBang

getMetaAccess

public AnalysisMetaAccess getMetaAccess()

Specified by:

getMetaAccess in interface ReachabilityAnalysis

Returns:

query interface used for looking up analysis objects from java.lang.reflect references

getReplacements

public org.graalvm.compiler.nodes.spi.Replacements getReplacements()

getUnsupportedFeatures

public UnsupportedFeatures getUnsupportedFeatures()

Specified by:

getUnsupportedFeatures in interface BigBang

lookup

public AnalysisType lookup(jdk.vm.ci.meta.JavaType type)

getObjectType

public AnalysisType getObjectType()

getObjectArrayType

public AnalysisType getObjectArrayType()

getGraalNodeType

public AnalysisType getGraalNodeType()

getGraalNodeListType

public AnalysisType getGraalNodeListType()

getThrowableType

public AnalysisType getThrowableType()

getThreadType

public AnalysisType getThreadType()

getAllInstantiatedTypeFlow

public TypeFlow<?> getAllInstantiatedTypeFlow()

getAllInstantiatedTypes

public TypeState getAllInstantiatedTypes()

getAllSynchronizedTypeFlow

public TypeFlow<?> getAllSynchronizedTypeFlow()

getAllSynchronizedTypeState

public TypeState getAllSynchronizedTypeState()

Specified by:

getAllSynchronizedTypeState in interface ReachabilityAnalysis

Returns:

typestate representing all types that need synchronization

executorIsStarted

public boolean executorIsStarted()

addRootMethod

public AnalysisMethod addRootMethod(Executable method)

Description copied from interface: ReachabilityAnalysis

Marks given method as reachable.

Specified by:

addRootMethod in interface ReachabilityAnalysis

addRootMethod

public AnalysisMethod addRootMethod(AnalysisMethod aMethod)

Description copied from interface: ReachabilityAnalysis

Marks given method as reachable.

Specified by:

addRootMethod in interface ReachabilityAnalysis

assertPointsToAnalysisMethod

public static PointsToAnalysisMethod assertPointsToAnalysisMethod(AnalysisMethod aMethod)

addRootClass

public AnalysisType addRootClass(Class<?> clazz,
                                 boolean addFields,
                                 boolean addArrayClass)

Description copied from interface: ReachabilityAnalysis

Marks given class and all its superclasses as reachable.

Specified by:

addRootClass in interface ReachabilityAnalysis

Parameters:

clazz - class to be marked

addFields - if true, all instance fiels are marked as accessed

addArrayClass - if true, the array class is registered as well

addRootField

public AnalysisType addRootField(Class<?> clazz,
                                 String fieldName)

Description copied from interface: ReachabilityAnalysis

Marks given field as accessed.

Specified by:

addRootField in interface ReachabilityAnalysis

addRootStaticField

public AnalysisType addRootStaticField(Class<?> clazz,
                                       String fieldName)

addRootMethod

public AnalysisMethod addRootMethod(Class<?> clazz,
                                    String methodName,
                                    Class<?>... parameterTypes)

Description copied from interface: ReachabilityAnalysis

Marks given method as reachable.

Specified by:

addRootMethod in interface ReachabilityAnalysis

getSnippetReflectionProvider

public final org.graalvm.compiler.api.replacements.SnippetReflectionProvider getSnippetReflectionProvider()

Specified by:

getSnippetReflectionProvider in interface BigBang

getConstantReflectionProvider

public final jdk.vm.ci.meta.ConstantReflectionProvider getConstantReflectionProvider()

Specified by:

getConstantReflectionProvider in interface BigBang

getConstantFieldProvider

public org.graalvm.compiler.core.common.spi.ConstantFieldProvider getConstantFieldProvider()

getExecutor

public CompletionExecutor getExecutor()

checkUserLimitations

public void checkUserLimitations()

Description copied from interface: BigBang

Checks if all user defined limitations such as the number of types are satisfied.

Specified by:

checkUserLimitations in interface BigBang

postFlow

public void postFlow(TypeFlow<?> operation)

postTask

public void postTask(CompletionExecutor.DebugContextRunnable task)

finish

public boolean finish()
               throws InterruptedException

Performs the analysis.

Specified by:

finish in interface ReachabilityAnalysis

Returns:

Returns true if any changes are made, i.e. if any type flows are updated

Throws:

InterruptedException

doTypeflow

public boolean doTypeflow()
                   throws InterruptedException

Throws:

InterruptedException

scanningPolicy

public HeapScanningPolicy scanningPolicy()

Specified by:

scanningPolicy in interface HeapScanning

Returns:

policy deciding what to scan

checkObjectGraph

protected void checkObjectGraph(ObjectScanner objectScanner)

Traverses the object graph to discover references to new types.

Parameters:

objectScanner -

getHostVM

public HostVM getHostVM()

Specified by:

getHostVM in interface BigBang

runAnalysis

public void runAnalysis(org.graalvm.compiler.debug.DebugContext debugContext,
                        Function<AnalysisUniverse,Boolean> analysisEndCondition)
                 throws InterruptedException

Iterate until analysis reaches a fixpoint.

Specified by:

runAnalysis in interface BigBang

Parameters:

debugContext - debug context

analysisEndCondition - hook for actions to be taken during analysis. It also dictates when the analysis should end, i.e., it returns true if no more iterations are required. When the analysis is used for Native Image generation the actions could for example be specified via Feature.duringAnalysis(Feature.DuringAnalysisAccess). The ending condition could be provided by Feature.DuringAnalysisAccess.requireAnalysisIteration().

Throws:

AnalysisError - if the analysis fails

InterruptedException

createExecutor

public static ForkJoinPool createExecutor(org.graalvm.compiler.debug.DebugContext debug,
                                          int numberOfThreads)