org.graalvm.compiler.nodes

Class GraphDecoder

java.lang.Object

org.graalvm.compiler.nodes.GraphDecoder

Direct Known Subclasses:

SimplifyingGraphDecoder

public class GraphDecoder
extends Object

Decoder for encoded graphs produced by GraphEncoder. Support for loop explosion during decoding is built into this class, because it requires many interactions with the decoding process. Subclasses can provide canonicalization and simplification of nodes during decoding, as well as method inlining during decoding.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GraphDecoder.InvokeData Additional information encoded for Invoke nodes to allow method inlining without decoding the frame state and successors beforehand.
protected static class	GraphDecoder.LoopExplosionState
protected static class	GraphDecoder.LoopScope Decoding state maintained for each loop in the encoded graph.
static class	GraphDecoder.LoopScopeTrigger Marker to distinguish the reasons for the creation of a loop scope during partial evaluation.
protected class	GraphDecoder.MethodScope Decoding state maintained for each encoded graph.
protected static class	GraphDecoder.ProxyPlaceholder A node that is created during loop explosion that can later be replaced by a ProxyNode if loop detection finds out that the value is defined in the loop, but used outside the loop.

Field Summary

Fields

Modifier and Type	Field and Description
protected Architecture	architecture
protected DebugContext	debug
static boolean	DUMP_DURING_FIXED_NODE_PROCESSING
protected StructuredGraph	graph The target graph where decoded nodes are added to.
protected OptionValues	options

Constructor Summary

Constructors

Constructor and Description
GraphDecoder(Architecture architecture, StructuredGraph graph)

Method Summary

Modifier and Type	Method and Description
protected Node	addFloatingNode(GraphDecoder.MethodScope methodScope, Node node)
protected void	afterMethodScope(GraphDecoder.MethodScope methodScope)
protected boolean	allowLazyPhis()
protected void	appendInvoke(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, GraphDecoder.InvokeData invokeData, CallTargetNode callTarget)
protected void	checkLoopExplosionIteration(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope) Hook for subclasses.
protected void	cleanupGraph(GraphDecoder.MethodScope methodScope) Removes unnecessary nodes from the graph after decoding.
protected GraphDecoder.LoopScope	createInitialLoopScope(GraphDecoder.MethodScope methodScope, FixedWithNextNode startNode)
void	decode(EncodedGraph encodedGraph)
void	decode(EncodedGraph encodedGraph, Iterable<EncodedGraph.EncodedNodeReference> nodeReferences)
protected void	decode(GraphDecoder.LoopScope initialLoopScope)
protected Node	decodeFloatingNode(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, int nodeOrderId) Decodes a non-fixed node, but does not do any post-processing and does not register it.
protected boolean	earlyCanonicalization(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, int nodeOrderId, FixedNode node) Hook for subclasses for early canonicalization of IfNodes and IntegerSwitchNodes.
protected Node	ensureNodeCreated(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, int nodeOrderId)
protected void	finishInlining(GraphDecoder.MethodScope inlineScope)
protected NodeClass<?>	getNodeClass(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, int nodeOrderId)
protected void	handleFixedNode(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, int nodeOrderId, FixedNode node) Hook for subclasses.
protected Node	handleFloatingNodeAfterAdd(GraphDecoder.MethodScope methodScope, 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 methodScope, GraphDecoder.LoopScope loopScope, Node node) Hook for subclasses to process a non-fixed node before it is added to the graph.
protected GraphDecoder.LoopScope	handleInvoke(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, GraphDecoder.InvokeData invokeData) Invoke nodes do not have the CallTargetNode, FrameState, and successors encoded.
protected void	handleLoopExplosionBegin(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, LoopBeginNode loopBegin)
protected GraphDecoder.LoopScopeTrigger	handleLoopExplosionEnd(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope)
protected void	handleLoopExplosionProxyNodes(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, GraphDecoder.LoopScope outerScope, LoopExitNode loopExit, int loopExitOrderId)
protected void	handleMergeNode(MergeNode merge) Hook for subclasses to perform simplifications for a non-loop-header control flow merge.
protected void	handlePhiFunctions(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope phiInputScope, GraphDecoder.LoopScope phiNodeScope, AbstractEndNode end, AbstractMergeNode merge)
protected void	handleProxyNodes(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, LoopExitNode loopExit)
protected Node	lookupNode(GraphDecoder.LoopScope loopScope, int nodeOrderId)
protected void	makeFixedNodeInputs(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, Node node) Process the input edges of a node.
protected void	makeFloatingNodeInputs(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, Node node)
protected FixedNode	makeStubNode(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, int nodeOrderId)
protected void	makeSuccessorStubs(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope, Node node, boolean updatePredecessors) Process successor edges of a node.
protected GraphDecoder.LoopScope	processNextNode(GraphDecoder.MethodScope methodScope, GraphDecoder.LoopScope loopScope)
protected GraphDecoder.InvokeData	readInvokeData(GraphDecoder.MethodScope methodScope, int invokeOrderId, Invoke invoke)
protected Object	readObject(GraphDecoder.MethodScope methodScope)
protected int	readOrderId(GraphDecoder.MethodScope methodScope)
protected void	readProperties(GraphDecoder.MethodScope methodScope, Node node)
protected void	registerNode(GraphDecoder.LoopScope loopScope, int nodeOrderId, Node node, boolean allowOverwrite, boolean allowNull)
protected static boolean	skipDirectEdge(Node node, Edges edges, int index)
protected boolean	verifyEdges()

Methods inherited from class java.lang.Object

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

Field Detail

architecture

protected final Architecture architecture

graph

protected final StructuredGraph graph

The target graph where decoded nodes are added to.

options

protected final OptionValues options

debug

protected final DebugContext debug

DUMP_DURING_FIXED_NODE_PROCESSING

public static final boolean DUMP_DURING_FIXED_NODE_PROCESSING

See Also:

Constant Field Values

Constructor Detail

GraphDecoder

public GraphDecoder(Architecture architecture,
                    StructuredGraph graph)

Method Detail

decode

public final void decode(EncodedGraph encodedGraph)

decode

public final void decode(EncodedGraph encodedGraph,
                         Iterable<EncodedGraph.EncodedNodeReference> nodeReferences)

createInitialLoopScope

protected final GraphDecoder.LoopScope createInitialLoopScope(GraphDecoder.MethodScope methodScope,
                                                              FixedWithNextNode startNode)

decode

protected final void decode(GraphDecoder.LoopScope initialLoopScope)

afterMethodScope

protected void afterMethodScope(GraphDecoder.MethodScope methodScope)

finishInlining

protected void finishInlining(GraphDecoder.MethodScope inlineScope)

processNextNode

protected GraphDecoder.LoopScope processNextNode(GraphDecoder.MethodScope methodScope,
                                                 GraphDecoder.LoopScope loopScope)

readInvokeData

protected GraphDecoder.InvokeData readInvokeData(GraphDecoder.MethodScope methodScope,
                                                 int invokeOrderId,
                                                 Invoke invoke)

handleInvoke

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

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.

appendInvoke

protected void appendInvoke(GraphDecoder.MethodScope methodScope,
                            GraphDecoder.LoopScope loopScope,
                            GraphDecoder.InvokeData invokeData,
                            CallTargetNode callTarget)

handleMergeNode

protected void handleMergeNode(MergeNode merge)

Hook for subclasses to perform simplifications for a non-loop-header control flow merge.

Parameters:

merge - The control flow merge.

handleLoopExplosionBegin

protected void handleLoopExplosionBegin(GraphDecoder.MethodScope methodScope,
                                        GraphDecoder.LoopScope loopScope,
                                        LoopBeginNode loopBegin)

checkLoopExplosionIteration

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

Hook for subclasses.

Parameters:

methodScope - The current method.

loopScope - The current loop.

handleLoopExplosionEnd

protected GraphDecoder.LoopScopeTrigger handleLoopExplosionEnd(GraphDecoder.MethodScope methodScope,
                                                               GraphDecoder.LoopScope loopScope)

handleFixedNode

protected void handleFixedNode(GraphDecoder.MethodScope methodScope,
                               GraphDecoder.LoopScope loopScope,
                               int nodeOrderId,
                               FixedNode node)

Hook for subclasses.

Parameters:

methodScope - The current method.

loopScope - The current loop.

nodeOrderId - The orderId of the node.

node - The node to be simplified.

earlyCanonicalization

protected boolean earlyCanonicalization(GraphDecoder.MethodScope methodScope,
                                        GraphDecoder.LoopScope loopScope,
                                        int nodeOrderId,
                                        FixedNode node)

Hook for subclasses for early canonicalization of IfNodes and IntegerSwitchNodes. "Early" means that this is called before successor stubs creation. Therefore, all successors are null a this point, and calling any method using them without prior manual initialization will fail.

Parameters:

methodScope - The current method.

loopScope - The current loop.

nodeOrderId - The orderId of the node.

node - The node to be simplified.

Returns:

true if canonicalization happened, false otherwise.

handleProxyNodes

protected void handleProxyNodes(GraphDecoder.MethodScope methodScope,
                                GraphDecoder.LoopScope loopScope,
                                LoopExitNode loopExit)

handleLoopExplosionProxyNodes

protected void handleLoopExplosionProxyNodes(GraphDecoder.MethodScope methodScope,
                                             GraphDecoder.LoopScope loopScope,
                                             GraphDecoder.LoopScope outerScope,
                                             LoopExitNode loopExit,
                                             int loopExitOrderId)

handlePhiFunctions

protected void handlePhiFunctions(GraphDecoder.MethodScope methodScope,
                                  GraphDecoder.LoopScope phiInputScope,
                                  GraphDecoder.LoopScope phiNodeScope,
                                  AbstractEndNode end,
                                  AbstractMergeNode merge)

allowLazyPhis

protected boolean allowLazyPhis()

readProperties

protected void readProperties(GraphDecoder.MethodScope methodScope,
                              Node node)

makeFixedNodeInputs

protected void makeFixedNodeInputs(GraphDecoder.MethodScope methodScope,
                                   GraphDecoder.LoopScope loopScope,
                                   Node node)

Process the input edges of a node. Input nodes that have not yet been created must be non-fixed nodes (because fixed nodes are processed in reverse postorder. Such non-fixed nodes are created on demand (recursively since they can themselves reference not yet created nodes).

makeFloatingNodeInputs

protected void makeFloatingNodeInputs(GraphDecoder.MethodScope methodScope,
                                      GraphDecoder.LoopScope loopScope,
                                      Node node)

ensureNodeCreated

protected Node ensureNodeCreated(GraphDecoder.MethodScope methodScope,
                                 GraphDecoder.LoopScope loopScope,
                                 int nodeOrderId)

addFloatingNode

protected Node addFloatingNode(GraphDecoder.MethodScope methodScope,
                               Node node)

decodeFloatingNode

protected Node decodeFloatingNode(GraphDecoder.MethodScope methodScope,
                                  GraphDecoder.LoopScope loopScope,
                                  int nodeOrderId)

Decodes a non-fixed node, but does not do any post-processing and does not register it.

handleFloatingNodeBeforeAdd

protected Node handleFloatingNodeBeforeAdd(GraphDecoder.MethodScope methodScope,
                                           GraphDecoder.LoopScope loopScope,
                                           Node node)

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

Parameters:

methodScope - The current method.

loopScope - The current loop.

node - The node to be canonicalized.

Returns:

The replacement for the node, or the node itself.

handleFloatingNodeAfterAdd

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

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.

Parameters:

methodScope - The current method.

loopScope - The current loop.

node - The node to be canonicalized.

Returns:

The replacement for the node, or the node itself.

makeSuccessorStubs

protected void makeSuccessorStubs(GraphDecoder.MethodScope methodScope,
                                  GraphDecoder.LoopScope loopScope,
                                  Node node,
                                  boolean updatePredecessors)

Process successor edges of a node. We create the successor nodes so that we can fill the successor list, but no properties or edges are loaded yet. That is done when the successor is on top of the worklist in GraphDecoder.processNextNode(org.graalvm.compiler.nodes.GraphDecoder.MethodScope, org.graalvm.compiler.nodes.GraphDecoder.LoopScope).

getNodeClass

protected NodeClass<?> getNodeClass(GraphDecoder.MethodScope methodScope,
                                    GraphDecoder.LoopScope loopScope,
                                    int nodeOrderId)

makeStubNode

protected FixedNode makeStubNode(GraphDecoder.MethodScope methodScope,
                                 GraphDecoder.LoopScope loopScope,
                                 int nodeOrderId)

skipDirectEdge

protected static boolean skipDirectEdge(Node node,
                                        Edges edges,
                                        int index)

lookupNode

protected Node lookupNode(GraphDecoder.LoopScope loopScope,
                          int nodeOrderId)

registerNode

protected void registerNode(GraphDecoder.LoopScope loopScope,
                            int nodeOrderId,
                            Node node,
                            boolean allowOverwrite,
                            boolean allowNull)

readOrderId

protected int readOrderId(GraphDecoder.MethodScope methodScope)

readObject

protected Object readObject(GraphDecoder.MethodScope methodScope)

cleanupGraph

protected void cleanupGraph(GraphDecoder.MethodScope methodScope)

Removes unnecessary nodes from the graph after decoding.

Parameters:

methodScope - The current method.

verifyEdges

protected boolean verifyEdges()