com.oracle.graal.pointsto

Interface ReachabilityAnalysis

All Known Subinterfaces:

BigBang

All Known Implementing Classes:

AbstractAnalysisEngine, PointsToAnalysis

public interface ReachabilityAnalysis

Interface to be used to query and change the state of the static analysis in Native Image. It is a first small step in a bigger effort to group together all requests changing the analysis state.

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)
AnalysisPolicy	analysisPolicy()
void	cleanupAfterAnalysis() Clears all intermediary data to reduce the footprint.
boolean	finish() Waits until the analysis is done.
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.
Iterable<AnalysisType>	getAllInstantiatedTypes()
Iterable<AnalysisType>	getAllSynchronizedTypes()
AnalysisMetaAccess	getMetaAccess()
AnalysisUniverse	getUniverse()
default void	markFieldAccessed(AnalysisField field, Object reason)
default void	markFieldRead(AnalysisField field, Object reason)
default void	markFieldWritten(AnalysisField field, Object reason)
default void	registerAsFrozenUnsafeAccessed(AnalysisField field)
void	registerAsJNIAccessed(AnalysisField field, boolean writable) Performs any necessary additional steps required by the analysis to handle JNI accessed fields.
default boolean	registerAsUnsafeAccessed(AnalysisField field, com.oracle.svm.util.UnsafePartitionKind partitionKind, Object reason)
default boolean	registerTypeAsAllocated(AnalysisType type, Object reason)
default boolean	registerTypeAsInHeap(AnalysisType type, Object reason)
default boolean	registerTypeAsReachable(AnalysisType type, Object reason)

Method Detail

addRootClass

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

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

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

addRootField

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

Marks given field as accessed.

addRootMethod

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

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.

addRootMethod

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...)

registerAsFrozenUnsafeAccessed

default void registerAsFrozenUnsafeAccessed(AnalysisField field)

registerAsUnsafeAccessed

default boolean registerAsUnsafeAccessed(AnalysisField field,
                                         com.oracle.svm.util.UnsafePartitionKind partitionKind,
                                         Object reason)

registerTypeAsReachable

default boolean registerTypeAsReachable(AnalysisType type,
                                        Object reason)

registerTypeAsAllocated

default boolean registerTypeAsAllocated(AnalysisType type,
                                        Object reason)

registerTypeAsInHeap

default boolean registerTypeAsInHeap(AnalysisType type,
                                     Object reason)

markFieldAccessed

default void markFieldAccessed(AnalysisField field,
                               Object reason)

markFieldRead

default void markFieldRead(AnalysisField field,
                           Object reason)

markFieldWritten

default void markFieldWritten(AnalysisField field,
                              Object reason)

finish

boolean finish()
        throws InterruptedException

Waits until the analysis is done.

Throws:

InterruptedException

cleanupAfterAnalysis

void cleanupAfterAnalysis()

Clears all intermediary data to reduce the footprint.

forceUnsafeUpdate

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.

Parameters:

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

registerAsJNIAccessed

void registerAsJNIAccessed(AnalysisField field,
                           boolean writable)

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

getAllSynchronizedTypes

Iterable<AnalysisType> getAllSynchronizedTypes()

Returns:

all types that need synchronization

getAllInstantiatedTypes

Iterable<AnalysisType> getAllInstantiatedTypes()

Returns:

all instantiated types

getMetaAccess

AnalysisMetaAccess getMetaAccess()

Returns:

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

getUniverse

AnalysisUniverse getUniverse()

Returns:

universe containing all known analysis types

analysisPolicy

AnalysisPolicy analysisPolicy()

Returns:

policy used when running the analysis