org.graalvm.compiler.replacements

Class PEGraphDecoder

java.lang.Object

org.graalvm.compiler.nodes.GraphDecoder

org.graalvm.compiler.nodes.SimplifyingGraphDecoder

org.graalvm.compiler.replacements.PEGraphDecoder

Direct Known Subclasses:

CachingPEGraphDecoder

public abstract class PEGraphDecoder
extends SimplifyingGraphDecoder

A graph decoder that performs partial evaluation, i.e., that performs method inlining and canonicalization/simplification of nodes during decoding. Inlining and loop explosion are configured via the plugin mechanism also used by the GraphBuilderPhase. However, not all callback methods defined in GraphBuilderContext are available since decoding is more limited than graph building. The standard node canonicalization interface is used to canonicalize nodes during decoding. Additionally, branches and switches with constant conditions are simplified.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PEGraphDecoder.ExceptionPlaceholderNode
static class	PEGraphDecoder.Options
protected class	PEGraphDecoder.PEAppendGraphBuilderContext
protected class	PEGraphDecoder.PEMethodScope
protected class	PEGraphDecoder.PENonAppendGraphBuilderContext
protected class	PEGraphDecoder.PEPluginGraphBuilderContext
static class	PEGraphDecoder.SpecialCallTargetCacheKey

Nested classes/interfaces inherited from class org.graalvm.compiler.nodes.SimplifyingGraphDecoder

SimplifyingGraphDecoder.PECanonicalizerTool

Nested classes/interfaces inherited from class org.graalvm.compiler.nodes.GraphDecoder

GraphDecoder.InvokeData, GraphDecoder.LoopExplosionState, GraphDecoder.LoopScope, GraphDecoder.LoopScopeTrigger, GraphDecoder.MethodScope, GraphDecoder.ProxyPlaceholder

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	needsExplicitException
protected SourceLanguagePositionProvider	sourceLanguagePositionProvider

Fields inherited from class org.graalvm.compiler.nodes.SimplifyingGraphDecoder

canonicalizeReads, canonicalizerTool, providers

Fields inherited from class org.graalvm.compiler.nodes.GraphDecoder

architecture, debug, DUMP_DURING_FIXED_NODE_PROCESSING, graph, options

Constructor Summary

Constructors

Constructor and Description

PEGraphDecoder(Architecture architecture, StructuredGraph graph, CoreProviders providers, LoopExplosionPlugin loopExplosionPlugin, InvocationPlugins invocationPlugins, InlineInvokePlugin[] inlineInvokePlugins, ParameterPlugin parameterPlugin, NodePlugin[] nodePlugins, ResolvedJavaMethod peRootForInlining, SourceLanguagePositionProvider sourceLanguagePositionProvider, ConcurrentHashMap<PEGraphDecoder.SpecialCallTargetCacheKey,Object> specialCallTargetCache, ConcurrentHashMap<ResolvedJavaMethod,Object> invocationPluginCache, boolean needsExplicitException)

Method Summary

Modifier and Type	Method and Description
protected void	afterMethodScope(GraphDecoder.MethodScope methodScope)
protected Node	canonicalizeFixedNode(GraphDecoder.MethodScope s, Node node) Canonicalizes the provided node, which was originally a FixedNode but can already be canonicalized (and therefore be a non-fixed node).
protected void	checkLoopExplosionIteration(GraphDecoder.MethodScope s, GraphDecoder.LoopScope loopScope) Hook for subclasses.
protected void	cleanupGraph(GraphDecoder.MethodScope methodScope) Removes unnecessary nodes from the graph after decoding.
protected PEGraphDecoder.PEMethodScope	createMethodScope(StructuredGraph targetGraph, PEGraphDecoder.PEMethodScope caller, GraphDecoder.LoopScope callerLoopScope, EncodedGraph encodedGraph, ResolvedJavaMethod method, GraphDecoder.InvokeData invokeData, int inliningDepth, ValueNode[] arguments)
void	decode(ResolvedJavaMethod method, boolean isSubstitution, boolean trackNodeSourcePosition)
protected GraphDecoder.LoopScope	doInline(PEGraphDecoder.PEMethodScope methodScope, GraphDecoder.LoopScope loopScope, GraphDecoder.InvokeData invokeData, InlineInvokePlugin.InlineInfo inlineInfo, ValueNode[] arguments)
protected void	ensureExceptionStateDecoded(PEGraphDecoder.PEMethodScope methodScope)
protected void	ensureOuterStateDecoded(PEGraphDecoder.PEMethodScope methodScope)
protected void	ensureStateAfterDecoded(PEGraphDecoder.PEMethodScope methodScope)
protected void	finishInlining(GraphDecoder.MethodScope is)
protected IntrinsicContext	getIntrinsic()
protected Node	handleFloatingNodeAfterAdd(GraphDecoder.MethodScope s, GraphDecoder.LoopScope loopScope, Node node) Hook for subclasses to process a non-fixed node after it is added to the graph.
protected Node	handleFloatingNodeBeforeAdd(GraphDecoder.MethodScope s, GraphDecoder.LoopScope loopScope, Node n) Hook for subclasses to process a non-fixed node before it is added to the graph.
protected GraphDecoder.LoopScope	handleInvoke(GraphDecoder.MethodScope s, GraphDecoder.LoopScope loopScope, GraphDecoder.InvokeData invokeData) Invoke nodes do not have the CallTargetNode, FrameState, and successors encoded.
protected void	handleNonInlinedInvoke(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, GraphDecoder.InvokeData invokeData)
protected abstract EncodedGraph	lookupEncodedGraph(ResolvedJavaMethod method, BytecodeProvider intrinsicBytecodeProvider, boolean isSubstitution, boolean trackNodeSourcePosition)
protected static LoopExplosionPlugin.LoopExplosionKind	loopExplosionKind(ResolvedJavaMethod method, LoopExplosionPlugin loopExplosionPlugin)
protected FixedNode	nodeAfterInvoke(PEGraphDecoder.PEMethodScope methodScope, GraphDecoder.LoopScope loopScope, GraphDecoder.InvokeData invokeData, BeginNode prevBegin)
protected boolean	pluginReplacementMustSucceed()
protected GraphDecoder.LoopScope	tryInline(PEGraphDecoder.PEMethodScope methodScope, GraphDecoder.LoopScope loopScope, GraphDecoder.InvokeData invokeData, MethodCallTargetNode callTarget)
protected boolean	tryInvocationPlugin(PEGraphDecoder.PEMethodScope methodScope, GraphDecoder.LoopScope loopScope, GraphDecoder.InvokeData invokeData, MethodCallTargetNode callTarget)
protected MethodCallTargetNode	trySimplifyCallTarget(PEGraphDecoder.PEMethodScope methodScope, GraphDecoder.InvokeData invokeData, MethodCallTargetNode callTarget)
protected GraphDecoder.LoopScope	trySimplifyInvoke(PEGraphDecoder.PEMethodScope methodScope, GraphDecoder.LoopScope loopScope, GraphDecoder.InvokeData invokeData, MethodCallTargetNode callTarget)

Methods inherited from class org.graalvm.compiler.nodes.SimplifyingGraphDecoder

addFloatingNode, allowLazyPhis, earlyCanonicalization, handleFixedNode, handleMergeNode

Methods inherited from class org.graalvm.compiler.nodes.GraphDecoder

appendInvoke, createInitialLoopScope, decode, decode, decode, decodeFloatingNode, ensureNodeCreated, getNodeClass, handleLoopExplosionBegin, handleLoopExplosionEnd, handleLoopExplosionProxyNodes, handlePhiFunctions, handleProxyNodes, lookupNode, makeFixedNodeInputs, makeFloatingNodeInputs, makeStubNode, makeSuccessorStubs, processNextNode, readInvokeData, readObject, readOrderId, readProperties, registerNode, skipDirectEdge, verifyEdges

Methods inherited from class java.lang.Object

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

Field Detail

sourceLanguagePositionProvider

protected final SourceLanguagePositionProvider sourceLanguagePositionProvider

needsExplicitException

protected final boolean needsExplicitException

Constructor Detail

PEGraphDecoder

public PEGraphDecoder(Architecture architecture,
                      StructuredGraph graph,
                      CoreProviders providers,
                      LoopExplosionPlugin loopExplosionPlugin,
                      InvocationPlugins invocationPlugins,
                      InlineInvokePlugin[] inlineInvokePlugins,
                      ParameterPlugin parameterPlugin,
                      NodePlugin[] nodePlugins,
                      ResolvedJavaMethod peRootForInlining,
                      SourceLanguagePositionProvider sourceLanguagePositionProvider,
                      ConcurrentHashMap<PEGraphDecoder.SpecialCallTargetCacheKey,Object> specialCallTargetCache,
                      ConcurrentHashMap<ResolvedJavaMethod,Object> invocationPluginCache,
                      boolean needsExplicitException)

Method Detail

getIntrinsic

protected IntrinsicContext getIntrinsic()

loopExplosionKind

protected static LoopExplosionPlugin.LoopExplosionKind loopExplosionKind(ResolvedJavaMethod method,
                                                                         LoopExplosionPlugin loopExplosionPlugin)

decode

public void decode(ResolvedJavaMethod method,
                   boolean isSubstitution,
                   boolean trackNodeSourcePosition)

createMethodScope

protected PEGraphDecoder.PEMethodScope createMethodScope(StructuredGraph targetGraph,
                                                         PEGraphDecoder.PEMethodScope caller,
                                                         GraphDecoder.LoopScope callerLoopScope,
                                                         EncodedGraph encodedGraph,
                                                         ResolvedJavaMethod method,
                                                         GraphDecoder.InvokeData invokeData,
                                                         int inliningDepth,
                                                         ValueNode[] arguments)

cleanupGraph

protected void cleanupGraph(GraphDecoder.MethodScope methodScope)

Description copied from class: GraphDecoder

Removes unnecessary nodes from the graph after decoding.

Overrides:

cleanupGraph in class SimplifyingGraphDecoder

Parameters:

methodScope - The current method.

checkLoopExplosionIteration

protected void checkLoopExplosionIteration(GraphDecoder.MethodScope s,
                                           GraphDecoder.LoopScope loopScope)

Description copied from class: GraphDecoder

Hook for subclasses.

Overrides:

checkLoopExplosionIteration in class GraphDecoder

Parameters:

s - The current method.

loopScope - The current loop.

handleInvoke

protected GraphDecoder.LoopScope handleInvoke(GraphDecoder.MethodScope s,
                                              GraphDecoder.LoopScope loopScope,
                                              GraphDecoder.InvokeData invokeData)

Description copied from class: GraphDecoder

Invoke nodes do not have the CallTargetNode, FrameState, and successors encoded. Instead, this information is provided separately to allow method inlining without decoding and adding them to the graph upfront. For non-inlined methods, this method restores the normal state. Subclasses can override it to perform method inlining. The return value is the loop scope where decoding should continue. When method inlining should be performed, the returned loop scope must be a new loop scope for the inlined method. Without inlining, the original loop scope must be returned.

Overrides:

handleInvoke in class GraphDecoder

handleNonInlinedInvoke

protected void handleNonInlinedInvoke(GraphDecoder.MethodScope methodScope,
                                      GraphDecoder.LoopScope loopScope,
                                      GraphDecoder.InvokeData invokeData)

trySimplifyCallTarget

protected MethodCallTargetNode trySimplifyCallTarget(PEGraphDecoder.PEMethodScope methodScope,
                                                     GraphDecoder.InvokeData invokeData,
                                                     MethodCallTargetNode callTarget)

trySimplifyInvoke

protected GraphDecoder.LoopScope trySimplifyInvoke(PEGraphDecoder.PEMethodScope methodScope,
                                                   GraphDecoder.LoopScope loopScope,
                                                   GraphDecoder.InvokeData invokeData,
                                                   MethodCallTargetNode callTarget)

tryInvocationPlugin

protected boolean tryInvocationPlugin(PEGraphDecoder.PEMethodScope methodScope,
                                      GraphDecoder.LoopScope loopScope,
                                      GraphDecoder.InvokeData invokeData,
                                      MethodCallTargetNode callTarget)

tryInline

protected GraphDecoder.LoopScope tryInline(PEGraphDecoder.PEMethodScope methodScope,
                                           GraphDecoder.LoopScope loopScope,
                                           GraphDecoder.InvokeData invokeData,
                                           MethodCallTargetNode callTarget)

doInline

protected GraphDecoder.LoopScope doInline(PEGraphDecoder.PEMethodScope methodScope,
                                          GraphDecoder.LoopScope loopScope,
                                          GraphDecoder.InvokeData invokeData,
                                          InlineInvokePlugin.InlineInfo inlineInfo,
                                          ValueNode[] arguments)

afterMethodScope

protected void afterMethodScope(GraphDecoder.MethodScope methodScope)

Overrides:

afterMethodScope in class GraphDecoder

finishInlining

protected void finishInlining(GraphDecoder.MethodScope is)

Overrides:

finishInlining in class GraphDecoder

nodeAfterInvoke

protected FixedNode nodeAfterInvoke(PEGraphDecoder.PEMethodScope methodScope,
                                    GraphDecoder.LoopScope loopScope,
                                    GraphDecoder.InvokeData invokeData,
                                    BeginNode prevBegin)

lookupEncodedGraph

protected abstract EncodedGraph lookupEncodedGraph(ResolvedJavaMethod method,
                                                   BytecodeProvider intrinsicBytecodeProvider,
                                                   boolean isSubstitution,
                                                   boolean trackNodeSourcePosition)

canonicalizeFixedNode

protected Node canonicalizeFixedNode(GraphDecoder.MethodScope s,
                                     Node node)

Description copied from class: SimplifyingGraphDecoder

Canonicalizes the provided node, which was originally a FixedNode but can already be canonicalized (and therefore be a non-fixed node).

Overrides:

canonicalizeFixedNode in class SimplifyingGraphDecoder

Parameters:

s - The current method.

node - The node to be canonicalized.

pluginReplacementMustSucceed

protected boolean pluginReplacementMustSucceed()

handleFloatingNodeBeforeAdd

protected Node handleFloatingNodeBeforeAdd(GraphDecoder.MethodScope s,
                                           GraphDecoder.LoopScope loopScope,
                                           Node n)

Description copied from class: GraphDecoder

Hook for subclasses to process a non-fixed node before it is added to the graph.

Overrides:

handleFloatingNodeBeforeAdd in class SimplifyingGraphDecoder

Parameters:

s - The current method.

loopScope - The current loop.

n - The node to be canonicalized.

Returns:

The replacement for the node, or the node itself.

ensureOuterStateDecoded

protected void ensureOuterStateDecoded(PEGraphDecoder.PEMethodScope methodScope)

ensureStateAfterDecoded

protected void ensureStateAfterDecoded(PEGraphDecoder.PEMethodScope methodScope)

ensureExceptionStateDecoded

protected void ensureExceptionStateDecoded(PEGraphDecoder.PEMethodScope methodScope)

handleFloatingNodeAfterAdd

protected Node handleFloatingNodeAfterAdd(GraphDecoder.MethodScope s,
                                          GraphDecoder.LoopScope loopScope,
                                          Node node)

Description copied from class: GraphDecoder

Hook for subclasses to process a non-fixed node after it is added to the graph. If this method replaces a node with another node, it must update its source position if the original node has the source position set.

Overrides:

handleFloatingNodeAfterAdd in class GraphDecoder

Parameters:

s - The current method.

loopScope - The current loop.

node - The node to be canonicalized.

Returns:

The replacement for the node, or the node itself.