org.graalvm.compiler.truffle.compiler

Class PartialEvaluator

java.lang.Object

org.graalvm.compiler.truffle.compiler.PartialEvaluator

Direct Known Subclasses:

HotSpotPartialEvaluator

public abstract class PartialEvaluator
extends Object

Class performing the partial evaluation starting from the root node of an AST.

Field Summary

Fields

Modifier and Type	Field and Description
protected ResolvedJavaMethod	callInlined
protected TruffleConstantFieldProvider	compilationLocalConstantProvider
protected TruffleCompilerConfiguration	config
protected InstrumentPhase.Instrumentation	instrumentation The instrumentation object is used by the Truffle instrumentation to count executions.
InstrumentPhase.InstrumentationConfiguration	instrumentationCfg Holds instrumentation options initialized in PartialEvaluator.initialize(OptionValues) method before the first compilation.
protected org.graalvm.compiler.truffle.compiler.PartialEvaluator.PELoopExplosionPlugin	loopExplosionPlugin

Constructor Summary

Constructors

Constructor and Description
PartialEvaluator(TruffleCompilerConfiguration config, GraphBuilderConfiguration configForRoot, KnownTruffleTypes knownFields)

Method Summary

Modifier and Type	Method and Description
protected void	appendParsingNodePlugins(GraphBuilderConfiguration.Plugins plugins)
static InlineInvokePlugin.InlineInfo	asInlineInfo(ResolvedJavaMethod method)
protected InvocationPlugins	createDecodingInvocationPlugins(PartialEvaluatorConfiguration peConfig, GraphBuilderConfiguration.Plugins parent, Providers tierProviders) Graph-decoding plugins are not shared between the first- and the second-tier compilations, because the different tiers intrinsify the respective methods differently.
protected PEGraphDecoder	createGraphDecoder(TruffleTierContext context, InvocationPlugins invocationPlugins, InlineInvokePlugin[] inlineInvokePlugins, ParameterPlugin parameterPlugin, NodePlugin[] nodePluginList, SourceLanguagePositionProvider sourceLanguagePositionProvider, org.graalvm.collections.EconomicMap<ResolvedJavaMethod,EncodedGraph> graphCache, Supplier<AutoCloseable> createCachedGraphScope)
protected NodePlugin[]	createNodePlugins(GraphBuilderConfiguration.Plugins plugins)
static SpeculationReason	createTruffleBoundaryExceptionSpeculation(ResolvedJavaMethod targetMethod)
protected StructuredGraph.Builder	customizeStructuredGraphBuilder(StructuredGraph.Builder builder) Hook for subclasses: customize the StructuredGraph.
void	doGraphPE(TruffleTierContext context, InlineInvokePlugin inlineInvokePlugin, org.graalvm.collections.EconomicMap<ResolvedJavaMethod,EncodedGraph> graphCache)
ResolvedJavaMethod	getCallDirect()
ResolvedJavaMethod	getCallInlined()
ResolvedJavaMethod[]	getCompilationRootMethods()
GraphBuilderConfiguration	getConfig() Returns the GraphBuilderConfiguration used by parsing.
GraphBuilderConfiguration	getConfigPrototype() Returns the root GraphBuilderConfiguration.
protected Supplier<AutoCloseable>	getCreateCachedGraphScope(boolean persistentEncodedGraphCache) Gets a closeable producer that will be used in a try-with-resources statement surrounding the creation of encoded graphs.
InstrumentPhase.Instrumentation	getInstrumentation() Gets the instrumentation manager associated with this compiler, creating it first if necessary.
KnownTruffleTypes	getKnownTruffleTypes()
ResolvedJavaMethod[]	getNeverInlineMethods()
org.graalvm.collections.EconomicMap<ResolvedJavaMethod,EncodedGraph>	getOrCreateEncodedGraphCache(boolean persistentEncodedGraphCache)
Providers	getProviders()
protected void	initialize(org.graalvm.options.OptionValues options)
ResolvedJavaMethod	inlineRootForCallTarget(CompilableTruffleAST compilable) Hook for subclasses: return a customized compilation root when inlining a specific call target.
protected void	registerGraphBuilderInvocationPlugins(InvocationPlugins invocationPlugins, boolean canDelayIntrinsification)
ResolvedJavaMethod	rootForCallTarget(CompilableTruffleAST compilable) Hook for subclasses: return a customized compilation root for a specific call target.

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final TruffleCompilerConfiguration config

callInlined

protected final ResolvedJavaMethod callInlined

loopExplosionPlugin

protected final org.graalvm.compiler.truffle.compiler.PartialEvaluator.PELoopExplosionPlugin loopExplosionPlugin

instrumentationCfg

public volatile InstrumentPhase.InstrumentationConfiguration instrumentationCfg

Holds instrumentation options initialized in PartialEvaluator.initialize(OptionValues) method before the first compilation. These options are not engine aware.

instrumentation

protected volatile InstrumentPhase.Instrumentation instrumentation

The instrumentation object is used by the Truffle instrumentation to count executions. The value is lazily initialized the first time it is requested because it depends on the Truffle options, and tests that need the instrumentation table need to override these options after the TruffleRuntime object is created.

compilationLocalConstantProvider

protected final TruffleConstantFieldProvider compilationLocalConstantProvider

Constructor Detail

PartialEvaluator

public PartialEvaluator(TruffleCompilerConfiguration config,
                        GraphBuilderConfiguration configForRoot,
                        KnownTruffleTypes knownFields)

Method Detail

initialize

protected void initialize(org.graalvm.options.OptionValues options)

getOrCreateEncodedGraphCache

public org.graalvm.collections.EconomicMap<ResolvedJavaMethod,EncodedGraph> getOrCreateEncodedGraphCache(boolean persistentEncodedGraphCache)

getInstrumentation

public InstrumentPhase.Instrumentation getInstrumentation()

Gets the instrumentation manager associated with this compiler, creating it first if necessary. Each compiler instance has its own instrumentation manager.

asInlineInfo

public static InlineInvokePlugin.InlineInfo asInlineInfo(ResolvedJavaMethod method)

getProviders

public Providers getProviders()

getConfigPrototype

public GraphBuilderConfiguration getConfigPrototype()

Returns the root GraphBuilderConfiguration. The root configuration provides plugins used by this PartialEvaluator but it's not configured with engine options. The root configuration should be used in image generation time where the PartialEvaluator is not yet initialized with engine options. At runtime the PartialEvaluator.getConfig() should be used.

getConfig

public GraphBuilderConfiguration getConfig()

Returns the GraphBuilderConfiguration used by parsing. The returned configuration is configured with engine options. In the image generation time the PartialEvaluator is not yet initialized and the PartialEvaluator.getConfigPrototype() should be used instead.

Throws:

IllegalStateException - when called on non initialized PartialEvaluator

getKnownTruffleTypes

public KnownTruffleTypes getKnownTruffleTypes()

getCompilationRootMethods

public ResolvedJavaMethod[] getCompilationRootMethods()

getNeverInlineMethods

public ResolvedJavaMethod[] getNeverInlineMethods()

getCallDirect

public ResolvedJavaMethod getCallDirect()

getCallInlined

public ResolvedJavaMethod getCallInlined()

customizeStructuredGraphBuilder

protected StructuredGraph.Builder customizeStructuredGraphBuilder(StructuredGraph.Builder builder)

Hook for subclasses: customize the StructuredGraph.

rootForCallTarget

public ResolvedJavaMethod rootForCallTarget(CompilableTruffleAST compilable)

Hook for subclasses: return a customized compilation root for a specific call target.

Parameters:

compilable - the Truffle AST being compiled.

inlineRootForCallTarget

public ResolvedJavaMethod inlineRootForCallTarget(CompilableTruffleAST compilable)

Hook for subclasses: return a customized compilation root when inlining a specific call target.

Parameters:

compilable - the Truffle AST being compiled.

createGraphDecoder

protected PEGraphDecoder createGraphDecoder(TruffleTierContext context,
                                            InvocationPlugins invocationPlugins,
                                            InlineInvokePlugin[] inlineInvokePlugins,
                                            ParameterPlugin parameterPlugin,
                                            NodePlugin[] nodePluginList,
                                            SourceLanguagePositionProvider sourceLanguagePositionProvider,
                                            org.graalvm.collections.EconomicMap<ResolvedJavaMethod,EncodedGraph> graphCache,
                                            Supplier<AutoCloseable> createCachedGraphScope)

doGraphPE

public void doGraphPE(TruffleTierContext context,
                      InlineInvokePlugin inlineInvokePlugin,
                      org.graalvm.collections.EconomicMap<ResolvedJavaMethod,EncodedGraph> graphCache)

getCreateCachedGraphScope

protected Supplier<AutoCloseable> getCreateCachedGraphScope(boolean persistentEncodedGraphCache)

Gets a closeable producer that will be used in a try-with-resources statement surrounding the creation of encoded graphs. This can be used to ensure that the encoded graphs and its dependencies can be persisted across compilations. The default supplier produces null, a no-op try-with-resources/scope.

appendParsingNodePlugins

protected void appendParsingNodePlugins(GraphBuilderConfiguration.Plugins plugins)

createNodePlugins

protected NodePlugin[] createNodePlugins(GraphBuilderConfiguration.Plugins plugins)

registerGraphBuilderInvocationPlugins

protected void registerGraphBuilderInvocationPlugins(InvocationPlugins invocationPlugins,
                                                     boolean canDelayIntrinsification)

createDecodingInvocationPlugins

protected InvocationPlugins createDecodingInvocationPlugins(PartialEvaluatorConfiguration peConfig,
                                                            GraphBuilderConfiguration.Plugins parent,
                                                            Providers tierProviders)

Graph-decoding plugins are not shared between the first- and the second-tier compilations, because the different tiers intrinsify the respective methods differently.

createTruffleBoundaryExceptionSpeculation

public static SpeculationReason createTruffleBoundaryExceptionSpeculation(ResolvedJavaMethod targetMethod)