com.oracle.graal.pointsto

Class AbstractAnalysisEngine

java.lang.Object

com.oracle.graal.pointsto.AbstractAnalysisEngine

All Implemented Interfaces:

BigBang, HeapScanning, ReachabilityAnalysis

Direct Known Subclasses:

PointsToAnalysis

public abstract class AbstractAnalysisEngine
extends Object
implements BigBang

This abstract class is shared between Reachability and Points-to. It contains generic methods needed by both types of analysis and getters.

Field Summary

Fields

Modifier and Type	Field and Description
protected AnalysisPolicy	analysisPolicy
protected Timer	analysisTimer
protected org.graalvm.compiler.debug.DebugContext	debug
protected CompletionExecutor	executor Processing queue.
protected Boolean	extendedAsserts
protected HostVM	hostVM
protected int	maxConstantObjectsPerType
protected AnalysisMetaAccess	metaAccess
protected boolean	optimizeReturnedParameter
protected org.graalvm.compiler.options.OptionValues	options
protected Timer	processFeaturesTimer
protected boolean	profileConstantObjects
protected AnalysisUniverse	universe
protected UnsupportedFeatures	unsupportedFeatures
protected Timer	verifyHeapTimer

Constructor Summary

Constructors

Constructor and Description

AbstractAnalysisEngine(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)

Method Summary

Modifier and Type	Method and Description
AnalysisPolicy	analysisPolicy()
void	cleanupAfterAnalysis() Clears all intermediary data to reduce the footprint.
boolean	executorIsStarted()
boolean	extendedAsserts()
ConstantReflectionProvider	getConstantReflectionProvider()
org.graalvm.compiler.debug.DebugContext	getDebug()
List<org.graalvm.compiler.debug.DebugHandlersFactory>	getDebugHandlerFactories()
Runnable	getHeartbeatCallback()
HostVM	getHostVM()
AnalysisMetaAccess	getMetaAccess()
org.graalvm.compiler.options.OptionValues	getOptions()
HostedProviders	getProviders(com.oracle.svm.common.meta.MultiMethod.MultiMethodKey key)
org.graalvm.compiler.api.replacements.SnippetReflectionProvider	getSnippetReflectionProvider()
protected abstract CompletionExecutor.Timing	getTiming()
AnalysisUniverse	getUniverse()
UnsupportedFeatures	getUnsupportedFeatures()
org.graalvm.compiler.word.WordTypes	getWordTypes()
int	maxConstantObjectsPerType()
boolean	optimizeReturnedParameter()
void	postTask(CompletionExecutor.DebugContextRunnable task)
void	postTask(Runnable task)
void	printTimerStatistics(PrintWriter out) Prints more detailed information about all analysis timers.
void	profileConstantObject(AnalysisType type)
void	runAnalysis(org.graalvm.compiler.debug.DebugContext debugContext, Function<AnalysisUniverse,Boolean> analysisEndCondition) Iterate until analysis reaches a fixpoint.
HeapScanningPolicy	scanningPolicy()
protected void	schedule(Runnable task)
AnalysisType[]	skippedHeapTypes()
static BytecodePosition	sourcePosition(org.graalvm.compiler.nodes.ValueNode node) Provide a non-null position.
static BytecodePosition	syntheticSourcePosition(org.graalvm.compiler.graph.Node node, ResolvedJavaMethod method) Creates a synthetic position for the node in the given method.

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, checkUserLimitations, fallbackResolveConcreteMethod, getProviders, initializeMetaData, isCallAllowed, onFieldAccessed, onTypeInstantiated, onTypeReachable, strengthenGraalGraphs

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

addRootClass, addRootClass, addRootField, addRootMethod, addRootMethod, finish, forceUnsafeUpdate, getAllInstantiatedTypes, getAllSynchronizedTypes, markFieldAccessed, markFieldRead, markFieldWritten, registerAsFrozenUnsafeAccessed, registerAsJNIAccessed, registerAsUnsafeAccessed, registerTypeAsAllocated, registerTypeAsInHeap, registerTypeAsReachable

Field Detail

universe

protected final AnalysisUniverse universe

metaAccess

protected final AnalysisMetaAccess metaAccess

analysisPolicy

protected final AnalysisPolicy analysisPolicy

extendedAsserts

protected final Boolean extendedAsserts

maxConstantObjectsPerType

protected final int maxConstantObjectsPerType

profileConstantObjects

protected final boolean profileConstantObjects

optimizeReturnedParameter

protected final boolean optimizeReturnedParameter

options

protected final org.graalvm.compiler.options.OptionValues options

debug

protected final org.graalvm.compiler.debug.DebugContext debug

hostVM

protected final HostVM hostVM

unsupportedFeatures

protected final UnsupportedFeatures unsupportedFeatures

executor

protected final CompletionExecutor executor

Processing queue.

processFeaturesTimer

protected final Timer processFeaturesTimer

analysisTimer

protected final Timer analysisTimer

verifyHeapTimer

protected final Timer verifyHeapTimer

Constructor Detail

AbstractAnalysisEngine

public AbstractAnalysisEngine(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)

Method Detail

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

getTiming

protected abstract CompletionExecutor.Timing getTiming()

cleanupAfterAnalysis

public void cleanupAfterAnalysis()

Description copied from interface: ReachabilityAnalysis

Clears all intermediary data to reduce the footprint.

Specified by:

cleanupAfterAnalysis in interface ReachabilityAnalysis

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

skippedHeapTypes

public AnalysisType[] skippedHeapTypes()

Specified by:

skippedHeapTypes in interface HeapScanning

Returns:

types that should not be crawled

extendedAsserts

public boolean extendedAsserts()

Specified by:

extendedAsserts in interface BigBang

maxConstantObjectsPerType

public int maxConstantObjectsPerType()

optimizeReturnedParameter

public boolean optimizeReturnedParameter()

profileConstantObject

public void profileConstantObject(AnalysisType type)

getOptions

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

Specified by:

getOptions in interface BigBang

getHeartbeatCallback

public Runnable getHeartbeatCallback()

Specified by:

getHeartbeatCallback in interface BigBang

getDebug

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

Specified by:

getDebug in interface BigBang

getDebugHandlerFactories

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

Specified by:

getDebugHandlerFactories in interface BigBang

analysisPolicy

public AnalysisPolicy analysisPolicy()

Specified by:

analysisPolicy in interface ReachabilityAnalysis

Returns:

policy used when running the analysis

getUniverse

public AnalysisUniverse getUniverse()

Specified by:

getUniverse in interface ReachabilityAnalysis

Returns:

universe containing all known analysis types

getProviders

public final HostedProviders getProviders(com.oracle.svm.common.meta.MultiMethod.MultiMethodKey key)

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

getUnsupportedFeatures

public UnsupportedFeatures getUnsupportedFeatures()

Specified by:

getUnsupportedFeatures in interface BigBang

getSnippetReflectionProvider

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

Specified by:

getSnippetReflectionProvider in interface BigBang

getConstantReflectionProvider

public final ConstantReflectionProvider getConstantReflectionProvider()

Specified by:

getConstantReflectionProvider in interface BigBang

getWordTypes

public org.graalvm.compiler.word.WordTypes getWordTypes()

Specified by:

getWordTypes in interface BigBang

scanningPolicy

public HeapScanningPolicy scanningPolicy()

Specified by:

scanningPolicy in interface HeapScanning

Returns:

policy deciding what to scan

getHostVM

public HostVM getHostVM()

Specified by:

getHostVM in interface BigBang

schedule

protected void schedule(Runnable task)

postTask

public final void postTask(CompletionExecutor.DebugContextRunnable task)

Specified by:

postTask in interface BigBang

postTask

public void postTask(Runnable task)

executorIsStarted

public final boolean executorIsStarted()

Specified by:

executorIsStarted in interface BigBang

sourcePosition

public static BytecodePosition sourcePosition(org.graalvm.compiler.nodes.ValueNode node)

Provide a non-null position. Some flows like newInstance and invoke require a non-null position, for others is just better. The constructed position is best-effort, i.e., it contains at least the method, and a BCI only if the node provides it.

This is necessary because Node.getNodeSourcePosition() doesn't always provide a position, like for example for generated factory methods in FactoryThrowMethodHolder.

syntheticSourcePosition

public static BytecodePosition syntheticSourcePosition(org.graalvm.compiler.graph.Node node,
                                                       ResolvedJavaMethod method)

Creates a synthetic position for the node in the given method.