org.graalvm.compiler.nodes

Class StructuredGraph

java.lang.Object

org.graalvm.compiler.graph.Graph

org.graalvm.compiler.nodes.StructuredGraph

All Implemented Interfaces:

JavaMethodContext

public final class StructuredGraph
extends Graph
implements JavaMethodContext

A graph that contains at least one distinguished node : the start node. This node is the start of the control flow of the graph.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructuredGraph.AllowAssumptions Constants denoting whether or not Assumptions can be made while processing a graph.
static class	StructuredGraph.Builder Object used to create a StructuredGraph.
static class	StructuredGraph.FrameStateVerification The different stages of the compilation of a Graph regarding the status of FrameState verification of AbstractStateSplit state after.
static class	StructuredGraph.FrameStateVerificationFeature Different node types verified during StructuredGraph.FrameStateVerification.
static class	StructuredGraph.GuardsStage The different stages of the compilation of a Graph regarding the status of GuardNodes, DeoptimizingNodes and FrameStates.
static class	StructuredGraph.ScheduleResult
static class	StructuredGraph.StageFlag Different stages of the compilation regarding the status of various graph properties.

Nested classes/interfaces inherited from class org.graalvm.compiler.graph.Graph

Graph.DuplicationReplacement, Graph.Mark, Graph.NodeEvent, Graph.NodeEventListener, Graph.NodeEventScope, Graph.Options

Field Summary

Fields

Modifier and Type	Field and Description
static long	INVALID_GRAPH_ID
static boolean	NO_PROFILING_INFO
static boolean	USE_PROFILING_INFO

Fields inherited from class org.graalvm.compiler.graph.Graph

name, trackNodeSourcePosition, verifyGraphEdges, verifyGraphs

Method Summary

Modifier and Type	Method and Description
void	addAfterFixed(FixedWithNextNode node, FixedNode newNode)
void	addBeforeFixed(FixedNode node, FixedWithNextNode newNode)
protected void	afterNodeIdChange(Node node, Object value)
protected void	afterRegister(Node node)
StructuredGraph.AllowAssumptions	allowAssumptions() Returns the AllowAssumptions status for this graph.
JavaMethod	asJavaMethod()
void	beforeNodeDuplication(Graph sourceGraph) This is called before nodes are transferred to sourceGraph by NodeClass.addGraphDuplicate(org.graalvm.compiler.graph.Graph, org.graalvm.compiler.graph.Graph, int, java.lang.Iterable<? extends org.graalvm.compiler.graph.Node>, org.graalvm.compiler.graph.Graph.DuplicationReplacement) to allow the transfer of any other state which should also be transferred.
protected Object	beforeNodeIdChange(Node node)
void	checkCancellation()
void	clearAllStateAfterForTestingOnly() For use in tests to clear all stateAfter frame states.
void	clearLastSchedule()
CompilationIdentifier	compilationId()
protected boolean	compress(boolean minimizeSize)
StructuredGraph	copy(ResolvedJavaMethod rootMethodForCopy, OptionValues optionsForCopy, DebugContext debugForCopy, boolean trackNodeSourcePositionForCopy)
protected Graph	copy(String newName, Consumer<org.graalvm.collections.UnmodifiableEconomicMap<Node,Node>> duplicationMapCallback, DebugContext debugForCopy) Creates a copy of this graph.
StructuredGraph	copy(String newName, Consumer<org.graalvm.collections.UnmodifiableEconomicMap<Node,Node>> duplicationMapCallback, DebugContext debugForCopy, OptionValues options) Creates a copy of this graph with the new option values.
StructuredGraph	copyWithIdentifier(CompilationIdentifier newCompilationId, DebugContext debugForCopy)
void	disableFrameStateVerification()
void	disableUnsafeAccessTracking()
Assumptions	getAssumptions() Gets the object for recording assumptions while constructing of this graph.
int	getBytecodeSize() Gets the input bytecode size from which this graph is constructed.
NodeSourcePosition	getCallerContext()
Cancellable	getCancellable()
void	getDebugProperties(Map<Object,Object> properties) Add any per graph properties that might be useful for debugging (e.g., to view in the ideal graph visualizer).
int	getEntryBCI()
StructuredGraph.FrameStateVerification	getFrameStateVerification()
StructuredGraph.GuardsStage	getGuardsStage()
InliningLog	getInliningLog() Gets the inlining log associated with this graph.
Iterable<Invoke>	getInvokes()
StructuredGraph.ScheduleResult	getLastSchedule()
List<ResolvedJavaMethod>	getMethods() Gets an unmodifiable view of the methods that were inlined while constructing this graph.
ParameterNode	getParameter(int index)
ProfileProvider	getProfileProvider() Return the ProfileProvider in use for the graph.
ProfilingInfo	getProfilingInfo() Gets the profiling info for the root method of this graph.
ProfilingInfo	getProfilingInfo(ResolvedJavaMethod m) Gets the profiling info for a given method that is or will be part of this graph, taking into account the StructuredGraph.getProfileProvider().
Stamp	getReturnStamp()
SpeculationLog	getSpeculationLog()
EnumSet<StructuredGraph.StageFlag>	getStageFlags()
long	graphId()
boolean	hasLoops()
boolean	hasUnsafeAccess()
boolean	hasVirtualizableAllocation()
boolean	isAfterStage(StructuredGraph.StageFlag stage)
boolean	isBeforeStage(StructuredGraph.StageFlag stage)
boolean	isDuringStage(StructuredGraph.StageFlag stage) Phases may set this flag to indicate that a stage is in progress.
boolean	isOSR()
boolean	isStateAfterClearedForTesting()
boolean	isSubstitution() Returns true if this graph is built without parsing the root method or if the root method is annotated by Snippet.
boolean	isUnsafeAccessTrackingEnabled()
void	logInliningTree()
void	markUnsafeAccess()
ResolvedJavaMethod	method() Gets the root method from which this graph was built.
void	notifyInliningDecision(Invokable invoke, boolean positive, String phase, org.graalvm.collections.EconomicMap<Node,Node> replacements, InliningLog calleeLog, String reason, Object... args) Notifies this graph of an inlining decision for invoke.
void	recordAssumptions(StructuredGraph inlineGraph)
void	recordMethod(ResolvedJavaMethod method) Records that method was used to build this graph.
void	reduceDegenerateLoopBegin(LoopBeginNode begin)
void	reduceTrivialMerge(AbstractMergeNode merge)
void	removeFixed(FixedWithNextNode node) Unlinks a node from all its control flow neighbors and then removes it from its graph.
void	removeSplit(ControlSplitNode node, AbstractBeginNode survivingSuccessor)
void	removeSplitPropagate(ControlSplitNode node, AbstractBeginNode survivingSuccessor)
void	replaceFixed(FixedWithNextNode node, Node replacement)
void	replaceFixedWithFixed(FixedWithNextNode node, FixedWithNextNode replacement)
void	replaceFixedWithFloating(FixedWithNextNode node, ValueNode replacement)
void	replaceSplit(ControlSplitNode node, Node replacement, AbstractBeginNode survivingSuccessor)
void	replaceSplitWithFixed(ControlSplitNode node, FixedWithNextNode replacement, AbstractBeginNode survivingSuccessor)
void	replaceSplitWithFloating(ControlSplitNode node, FloatingNode replacement, AbstractBeginNode survivingSuccessor)
void	replaceWithExceptionSplit(WithExceptionNode node, WithExceptionNode replacement)
void	setAfterStage(StructuredGraph.StageFlag stage)
void	setDuringStage(StructuredGraph.StageFlag stage)
void	setGuardsStage(StructuredGraph.GuardsStage guardsStage)
void	setLastSchedule(StructuredGraph.ScheduleResult result)
void	setStart(StartNode start)
StartNode	start()
String	toString()
void	updateMethods(StructuredGraph other) Updates the methods used to build this graph with the methods used to build another graph.
void	weakenFrameStateVerification(StructuredGraph.FrameStateVerification newFrameStateVerification)

Methods inherited from class org.graalvm.compiler.graph.Graph

add, addDuplicates, addDuplicates, addOrUnique, addOrUniqueWithInputs, addWithoutUnique, addWithoutUniqueWithInputs, afterDecodingFields, beforeDecodingFields, copy, copy, copy, createIterativeNodeWorkList, createNodeBitMap, createNodeFlood, createNodeMap, createNodeWorkList, currentNodeSourcePosition, findDuplicate, freeze, getCompressions, getDebug, getEdgeModificationCount, getMark, getNewNodes, getNode, getNodeCount, getNodes, getNodes, getNodesDeletedSinceLastCompression, getOptions, getTotalNodesDeleted, hasNode, isFrozen, isNew, isNodeModificationCountsEnabled, maybeCompress, minimizeSize, nodeIdCount, resetDebug, setTrackNodeSourcePosition, temporaryFreeze, trackNodeEvents, trackNodeSourcePosition, trackNodeSourcePositionDefault, unfreeze, unique, verify, verifySourcePositions, withNodeSourcePosition, withNodeSourcePosition, withoutNodeSourcePosition

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_GRAPH_ID

public static final long INVALID_GRAPH_ID

See Also:

Constant Field Values

USE_PROFILING_INFO

public static final boolean USE_PROFILING_INFO

See Also:

Constant Field Values

NO_PROFILING_INFO

public static final boolean NO_PROFILING_INFO

See Also:

Constant Field Values

Method Detail

setLastSchedule

public void setLastSchedule(StructuredGraph.ScheduleResult result)

getLastSchedule

public StructuredGraph.ScheduleResult getLastSchedule()

clearLastSchedule

public void clearLastSchedule()

getDebugProperties

public void getDebugProperties(Map<Object,Object> properties)

Description copied from class: Graph

Add any per graph properties that might be useful for debugging (e.g., to view in the ideal graph visualizer).

Overrides:

getDebugProperties in class Graph

beforeNodeDuplication

public void beforeNodeDuplication(Graph sourceGraph)

Description copied from class: Graph

This is called before nodes are transferred to sourceGraph by NodeClass.addGraphDuplicate(org.graalvm.compiler.graph.Graph, org.graalvm.compiler.graph.Graph, int, java.lang.Iterable<? extends org.graalvm.compiler.graph.Node>, org.graalvm.compiler.graph.Graph.DuplicationReplacement) to allow the transfer of any other state which should also be transferred.

Overrides:

beforeNodeDuplication in class Graph

Parameters:

sourceGraph - the source of the nodes that were duplicated

beforeNodeIdChange

protected Object beforeNodeIdChange(Node node)

Overrides:

beforeNodeIdChange in class Graph

afterNodeIdChange

protected void afterNodeIdChange(Node node,
                                 Object value)

Overrides:

afterNodeIdChange in class Graph

compress

protected boolean compress(boolean minimizeSize)

Overrides:

compress in class Graph

getReturnStamp

public Stamp getReturnStamp()

toString

public String toString()

Overrides:

toString in class Graph

start

public StartNode start()

method

public ResolvedJavaMethod method()

Gets the root method from which this graph was built.

Returns:

null if this method was not built from a method or the method is not available

getEntryBCI

public int getEntryBCI()

getCancellable

public Cancellable getCancellable()

checkCancellation

public void checkCancellation()

isOSR

public boolean isOSR()

graphId

public long graphId()

compilationId

public CompilationIdentifier compilationId()

See Also:

CompilationIdentifier

setStart

public void setStart(StartNode start)

getInliningLog

public InliningLog getInliningLog()

Gets the inlining log associated with this graph. This will return null iff GraalOptions.TraceInlining is false in Graph.getOptions().

notifyInliningDecision

public void notifyInliningDecision(Invokable invoke,
                                   boolean positive,
                                   String phase,
                                   org.graalvm.collections.EconomicMap<Node,Node> replacements,
                                   InliningLog calleeLog,
                                   String reason,
                                   Object... args)

Notifies this graph of an inlining decision for invoke. An inlining decision can be either positive or negative. A positive inlining decision must be logged after replacing an Invoke with a graph. In this case, the node replacement map and the InliningLog of the inlined graph must be provided.

Parameters:

invoke - the invocation to which the inlining decision pertains

positive - true if the invocation was inlined, false otherwise

phase - name of the phase doing the inlining

replacements - the node replacement map used by inlining. Must be non-null if positive == true, ignored if positive == false.

calleeLog - the inlining log of the inlined graph. Must be non-null if positive == true, ignored if positive == false.

reason - format string that along with args provides the reason for decision

logInliningTree

public void logInliningTree()

copy

protected Graph copy(String newName,
                     Consumer<org.graalvm.collections.UnmodifiableEconomicMap<Node,Node>> duplicationMapCallback,
                     DebugContext debugForCopy)

Creates a copy of this graph. If a node contains an array of objects, only shallow copy of the field is applied.

Overrides:

copy in class Graph

Parameters:

newName - the name of the copy, used for debugging purposes (can be null)

duplicationMapCallback - consumer of the duplication map created during the copying

debugForCopy - the debug context for the graph copy. This must not be the debug for this graph if this graph can be accessed from multiple threads (e.g., it's in a cache accessed by multiple threads).

copy

public StructuredGraph copy(String newName,
                            Consumer<org.graalvm.collections.UnmodifiableEconomicMap<Node,Node>> duplicationMapCallback,
                            DebugContext debugForCopy,
                            OptionValues options)

Creates a copy of this graph with the new option values. If a node contains an array of objects, only shallow copy of the field is applied.

Parameters:

newName - the name of the copy, used for debugging purposes (can be null)

duplicationMapCallback - consumer of the duplication map created during the copying

debugForCopy - the debug context for the graph copy. This must not be the debug for this graph if this graph can be accessed from multiple threads (e.g., it's in a cache accessed by multiple threads).

options - the option values for the graph copy

copyWithIdentifier

public StructuredGraph copyWithIdentifier(CompilationIdentifier newCompilationId,
                                          DebugContext debugForCopy)

Parameters:

debugForCopy - the debug context for the graph copy. This must not be the debug for this graph if this graph can be accessed from multiple threads (e.g., it's in a cache accessed by multiple threads).

copy

public StructuredGraph copy(ResolvedJavaMethod rootMethodForCopy,
                            OptionValues optionsForCopy,
                            DebugContext debugForCopy,
                            boolean trackNodeSourcePositionForCopy)

getParameter

public ParameterNode getParameter(int index)

getInvokes

public Iterable<Invoke> getInvokes()

hasLoops

public boolean hasLoops()

removeFixed

public void removeFixed(FixedWithNextNode node)

Unlinks a node from all its control flow neighbors and then removes it from its graph. The node must have no usages.

Parameters:

node - the node to be unlinked and removed

replaceFixed

public void replaceFixed(FixedWithNextNode node,
                         Node replacement)

replaceFixedWithFixed

public void replaceFixedWithFixed(FixedWithNextNode node,
                                  FixedWithNextNode replacement)

replaceFixedWithFloating

public void replaceFixedWithFloating(FixedWithNextNode node,
                                     ValueNode replacement)

removeSplit

public void removeSplit(ControlSplitNode node,
                        AbstractBeginNode survivingSuccessor)

removeSplitPropagate

public void removeSplitPropagate(ControlSplitNode node,
                                 AbstractBeginNode survivingSuccessor)

replaceSplit

public void replaceSplit(ControlSplitNode node,
                         Node replacement,
                         AbstractBeginNode survivingSuccessor)

replaceSplitWithFixed

public void replaceSplitWithFixed(ControlSplitNode node,
                                  FixedWithNextNode replacement,
                                  AbstractBeginNode survivingSuccessor)

replaceSplitWithFloating

public void replaceSplitWithFloating(ControlSplitNode node,
                                     FloatingNode replacement,
                                     AbstractBeginNode survivingSuccessor)

replaceWithExceptionSplit

public void replaceWithExceptionSplit(WithExceptionNode node,
                                      WithExceptionNode replacement)

addAfterFixed

public void addAfterFixed(FixedWithNextNode node,
                          FixedNode newNode)

addBeforeFixed

public void addBeforeFixed(FixedNode node,
                           FixedWithNextNode newNode)

reduceDegenerateLoopBegin

public void reduceDegenerateLoopBegin(LoopBeginNode begin)

reduceTrivialMerge

public void reduceTrivialMerge(AbstractMergeNode merge)

getGuardsStage

public StructuredGraph.GuardsStage getGuardsStage()

setGuardsStage

public void setGuardsStage(StructuredGraph.GuardsStage guardsStage)

isBeforeStage

public boolean isBeforeStage(StructuredGraph.StageFlag stage)

isDuringStage

public boolean isDuringStage(StructuredGraph.StageFlag stage)

Phases may set this flag to indicate that a stage is in progress. This is optional: StructuredGraph.isAfterStage(StageFlag) may become true for a stage even if StructuredGraph.isDuringStage(StageFlag) was never set for that stage.

isAfterStage

public boolean isAfterStage(StructuredGraph.StageFlag stage)

setDuringStage

public void setDuringStage(StructuredGraph.StageFlag stage)

setAfterStage

public void setAfterStage(StructuredGraph.StageFlag stage)

getStageFlags

public EnumSet<StructuredGraph.StageFlag> getStageFlags()

getProfileProvider

public ProfileProvider getProfileProvider()

Return the ProfileProvider in use for the graph.

isSubstitution

public boolean isSubstitution()

Returns true if this graph is built without parsing the root method or if the root method is annotated by Snippet. This is preferred over querying annotations directly as querying annotations can cause class loading.

getProfilingInfo

public ProfilingInfo getProfilingInfo()

Gets the profiling info for the root method of this graph.

getProfilingInfo

public ProfilingInfo getProfilingInfo(ResolvedJavaMethod m)

Gets the profiling info for a given method that is or will be part of this graph, taking into account the StructuredGraph.getProfileProvider().

getAssumptions

public Assumptions getAssumptions()

Gets the object for recording assumptions while constructing of this graph.

Returns:

null if assumptions cannot be made for this graph

allowAssumptions

public StructuredGraph.AllowAssumptions allowAssumptions()

Returns the AllowAssumptions status for this graph.

Returns:

AllowAssumptions.YES if this graph allows recording assumptions, AllowAssumptions.NO otherwise

recordAssumptions

public void recordAssumptions(StructuredGraph inlineGraph)

getMethods

public List<ResolvedJavaMethod> getMethods()

Gets an unmodifiable view of the methods that were inlined while constructing this graph.

recordMethod

public void recordMethod(ResolvedJavaMethod method)

Records that method was used to build this graph.

updateMethods

public void updateMethods(StructuredGraph other)

Updates the methods used to build this graph with the methods used to build another graph.

getBytecodeSize

public int getBytecodeSize()

Gets the input bytecode size from which this graph is constructed. This ignores how many bytecodes in each constituent method are actually parsed (which may be none for methods whose IR is retrieved from a cache or less than the full amount for any given method due to profile guided branch pruning).

asJavaMethod

public JavaMethod asJavaMethod()

Specified by:

asJavaMethod in interface JavaMethodContext

hasUnsafeAccess

public boolean hasUnsafeAccess()

markUnsafeAccess

public void markUnsafeAccess()

disableUnsafeAccessTracking

public void disableUnsafeAccessTracking()

isUnsafeAccessTrackingEnabled

public boolean isUnsafeAccessTrackingEnabled()

getSpeculationLog

public SpeculationLog getSpeculationLog()

getFrameStateVerification

public StructuredGraph.FrameStateVerification getFrameStateVerification()

isStateAfterClearedForTesting

public boolean isStateAfterClearedForTesting()

weakenFrameStateVerification

public void weakenFrameStateVerification(StructuredGraph.FrameStateVerification newFrameStateVerification)

disableFrameStateVerification

public void disableFrameStateVerification()

clearAllStateAfterForTestingOnly

public void clearAllStateAfterForTestingOnly()

For use in tests to clear all stateAfter frame states.

hasVirtualizableAllocation

public boolean hasVirtualizableAllocation()

afterRegister

protected void afterRegister(Node node)

Overrides:

afterRegister in class Graph

getCallerContext

public NodeSourcePosition getCallerContext()