com.oracle.graal.pointsto

Class PointsToAnalysis

java.lang.Object

com.oracle.graal.pointsto.AbstractAnalysisEngine

com.oracle.graal.pointsto.PointsToAnalysis

All Implemented Interfaces:

BigBang, HeapScanning, ReachabilityAnalysis

public abstract class PointsToAnalysis
extends AbstractAnalysisEngine

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
AtomicLong	numParsedGraphs
protected boolean	reportAnalysisStatistics
protected boolean	trackTypeFlowInputs
Timer	typeFlowTimer

Fields inherited from class com.oracle.graal.pointsto.AbstractAnalysisEngine

analysisPolicy, analysisTimer, debug, executor, extendedAsserts, hostVM, maxConstantObjectsPerType, metaAccess, optimizeReturnedParameter, options, processFeaturesTimer, profileConstantObjects, universe, unsupportedFeatures, verifyHeapTimer

Constructor Summary

Constructors

Constructor and Description

PointsToAnalysis(org.graalvm.compiler.options.OptionValues options, AnalysisUniverse universe, HostVM hostVM, AnalysisMetaAccess metaAccess, org.graalvm.compiler.api.replacements.SnippetReflectionProvider snippetReflectionProvider, ConstantReflectionProvider constantReflectionProvider, org.graalvm.compiler.word.WordTypes wordTypes, ForkJoinPool executorService, Runnable heartbeatCallback, UnsupportedFeatures unsupportedFeatures, TimerCollection timerCollection, boolean strengthenGraalGraphs)

Method Summary

Modifier and Type	Method and Description
AnalysisType	addRootClass(AnalysisType type, boolean addFields, boolean addArrayClass)
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, boolean invokeSpecial, Object reason, com.oracle.svm.common.meta.MultiMethod.MultiMethodKey... otherRoots) Registers the method as root.
AnalysisMethod	addRootMethod(Executable method, boolean invokeSpecial, Object reason, com.oracle.svm.common.meta.MultiMethod.MultiMethodKey... otherRoots)
AnalysisType	addRootStaticField(Class<?> clazz, String fieldName)
static PointsToAnalysisMethod	assertPointsToAnalysisMethod(AnalysisMethod aMethod)
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.
static ForkJoinPool	createExecutor(org.graalvm.compiler.debug.DebugContext debug, int numberOfThreads)
MethodTypeFlowBuilder	createMethodTypeFlowBuilder(PointsToAnalysis bb, PointsToAnalysisMethod method, MethodFlowsGraph flowsGraph, MethodFlowsGraph.GraphKind graphKind)
boolean	doTypeflow()
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()
Iterable<AnalysisType>	getAllInstantiatedTypes()
TypeFlow<?>	getAllSynchronizedTypeFlow()
Iterable<AnalysisType>	getAllSynchronizedTypes()
AnalysisType	getGraalNodeListType()
AnalysisType	getGraalNodeType()
AnalysisType	getObjectArrayType()
AnalysisType	getObjectType()
protected CompletionExecutor.Timing	getTiming()
AnalysisType	lookup(JavaType type)
void	onTypeInstantiated(AnalysisType type, AnalysisType.UsageKind usageKind)
void	postFlow(TypeFlow<?> operation)
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()
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 com.oracle.graal.pointsto.AbstractAnalysisEngine

analysisPolicy, executorIsStarted, extendedAsserts, getConstantReflectionProvider, getDebug, getDebugHandlerFactories, getHeartbeatCallback, getHostVM, getMetaAccess, getOptions, getProviders, getSnippetReflectionProvider, getUniverse, getUnsupportedFeatures, getWordTypes, maxConstantObjectsPerType, optimizeReturnedParameter, postTask, postTask, profileConstantObject, runAnalysis, scanningPolicy, schedule, skippedHeapTypes, sourcePosition, syntheticSourcePosition

Methods inherited from class java.lang.Object

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

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

afterAnalysis, fallbackResolveConcreteMethod, getProviders, initializeMetaData, isCallAllowed, onFieldAccessed, onTypeReachable

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

markFieldAccessed, markFieldRead, markFieldWritten, registerAsFrozenUnsafeAccessed, registerAsUnsafeAccessed, registerTypeAsAllocated, registerTypeAsInHeap, registerTypeAsReachable

Field Detail

trackTypeFlowInputs

protected final boolean trackTypeFlowInputs

reportAnalysisStatistics

protected final boolean reportAnalysisStatistics

numParsedGraphs

public final AtomicLong numParsedGraphs

typeFlowTimer

public final Timer typeFlowTimer

Constructor Detail

PointsToAnalysis

public PointsToAnalysis(org.graalvm.compiler.options.OptionValues options,
                        AnalysisUniverse universe,
                        HostVM hostVM,
                        AnalysisMetaAccess metaAccess,
                        org.graalvm.compiler.api.replacements.SnippetReflectionProvider snippetReflectionProvider,
                        ConstantReflectionProvider constantReflectionProvider,
                        org.graalvm.compiler.word.WordTypes wordTypes,
                        ForkJoinPool executorService,
                        Runnable heartbeatCallback,
                        UnsupportedFeatures unsupportedFeatures,
                        TimerCollection timerCollection,
                        boolean strengthenGraalGraphs)

Method Detail

getTiming

protected CompletionExecutor.Timing getTiming()

Specified by:

getTiming in class AbstractAnalysisEngine

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

Overrides:

printTimerStatistics in class AbstractAnalysisEngine

strengthenGraalGraphs

public boolean strengthenGraalGraphs()

trackTypeFlowInputs

public boolean trackTypeFlowInputs()

reportAnalysisStatistics

public boolean reportAnalysisStatistics()

createMethodTypeFlowBuilder

public MethodTypeFlowBuilder createMethodTypeFlowBuilder(PointsToAnalysis bb,
                                                         PointsToAnalysisMethod method,
                                                         MethodFlowsGraph flowsGraph,
                                                         MethodFlowsGraph.GraphKind graphKind)

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.

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.

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

Overrides:

cleanupAfterAnalysis in class AbstractAnalysisEngine

lookup

public AnalysisType lookup(JavaType type)

getObjectType

public AnalysisType getObjectType()

getObjectArrayType

public AnalysisType getObjectArrayType()

getGraalNodeType

public AnalysisType getGraalNodeType()

getGraalNodeListType

public AnalysisType getGraalNodeListType()

getAllInstantiatedTypeFlow

public TypeFlow<?> getAllInstantiatedTypeFlow()

getAllInstantiatedTypes

public Iterable<AnalysisType> getAllInstantiatedTypes()

Returns:

all instantiated types

getAllSynchronizedTypeFlow

public TypeFlow<?> getAllSynchronizedTypeFlow()

getAllSynchronizedTypes

public Iterable<AnalysisType> getAllSynchronizedTypes()

Returns:

all types that need synchronization

addRootMethod

public AnalysisMethod addRootMethod(Executable method,
                                    boolean invokeSpecial,
                                    Object reason,
                                    com.oracle.svm.common.meta.MultiMethod.MultiMethodKey... otherRoots)

See Also:

ReachabilityAnalysis.addRootMethod(AnalysisMethod, boolean, Object, MultiMethod.MultiMethodKey...)

addRootMethod

public AnalysisMethod addRootMethod(AnalysisMethod aMethod,
                                    boolean invokeSpecial,
                                    Object reason,
                                    com.oracle.svm.common.meta.MultiMethod.MultiMethodKey... otherRoots)

Description copied from interface: ReachabilityAnalysis

Registers the method as root. Must be an MultiMethod.ORIGINAL_METHOD. Static methods are immediately analyzed and marked as implementation-invoked which will also trigger their compilation. Special and virtual invoked methods are conditionally linked. Only when the receiver type (or one of its subtypes) is marked as instantiated the resolved concrete method is analyzed and marked as implementation-invoked and later compiled. This also means that abstract methods can be marked as virtual invoked roots; only the implementation methods whose declaring class is instantiated will actually be linked. Trying to register an abstract method as a special invoked root will result in an error. If otherRoots are specified, these versions of the method will also be registered as root methods.

Parameters:

aMethod - the method to register as root

invokeSpecial - if true only the target method is analyzed, even if it has overrides, or it is itself an override. If the method is static this flag is ignored.

otherRoots - other versions of this method to also register as roots.

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.

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

addRootClass

public AnalysisType addRootClass(AnalysisType type,
                                 boolean addFields,
                                 boolean addArrayClass)

addRootField

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

Description copied from interface: ReachabilityAnalysis

Marks given field as accessed.

addRootStaticField

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

checkUserLimitations

public void checkUserLimitations()

Description copied from interface: BigBang

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

postFlow

public void postFlow(TypeFlow<?> operation)

finish

public boolean finish()
               throws InterruptedException

Performs the analysis.

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

createExecutor

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

onTypeInstantiated

public void onTypeInstantiated(AnalysisType type,
                               AnalysisType.UsageKind usageKind)