org.graalvm.compiler.nodes

Class GraphState

java.lang.Object

org.graalvm.compiler.nodes.GraphState

public final class GraphState
extends Object

Describes StructuredGraph state with respect to compilation. This state is defined by fields which represent

• The progress made in the compilation (e.g. which stages have been reached (see GraphState.StageFlag), which verification is performed by FrameStates (see GraphState.FrameStateVerification))
• The properties of the intermediate representation (e.g. if new DeoptimizingNodes can be introduced (see GraphState.GuardsStage), if the graph contains nodes that require a stage to be applied on the graph (see GraphState.getFutureRequiredStages()))

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphState.FrameStateVerification The different stages of the compilation of a Graph regarding the status of FrameState verification of AbstractStateSplit state after.
static class	GraphState.FrameStateVerificationFeature Different node types verified during GraphState.FrameStateVerification.
static class	GraphState.GuardsStage The different stages of the compilation of a Graph regarding the status of GuardNodes, DeoptimizingNodes and FrameStates.
static class	GraphState.MandatoryStages Represents the necessary stages that must be applied to a StructuredGraph for a complete compilation depending on the compiler configuration chosen.
static class	GraphState.StageFlag Different stages of the compilation regarding the status of various graph properties.

Field Summary

Fields

Modifier and Type	Field and Description
static EnumSet<GraphState.StageFlag>	INITIAL_REQUIRED_STAGES This set of GraphState.StageFlags represents the stages a StructuredGraph initially requires to correctly pass all the other stages of the compilation.

Constructor Summary

Constructors

Constructor and Description
GraphState(GraphState.StageFlag currentStage, boolean disabledFrameStateVerification, boolean isSubstitution, EnumSet<GraphState.StageFlag> futureRequiredStages, GraphState.GuardsStage guardsStage, SpeculationLog speculationLog, EnumSet<GraphState.StageFlag> stageFlags) Creates a GraphState with the given fields.
GraphState(GraphState.StageFlag currentStage, boolean disabledFrameStateVerification, GraphState.FrameStateVerification frameStateVerification, EnumSet<GraphState.StageFlag> futureRequiredStages, GraphState.GuardsStage guardsStage, SpeculationLog speculationLog, EnumSet<GraphState.StageFlag> stageFlags) Creates a GraphState with the given fields.

Method Summary

Modifier and Type	Method and Description
void	addFutureStageRequirement(GraphState.StageFlag stage) Adds the given GraphState.StageFlag to the future required stages of this graph state.
boolean	canWeakenFrameStateVerification(GraphState.FrameStateVerification stage) Checks if this frame state verification can be weakened to the given GraphState.FrameStateVerification.
GraphState	copy() Creates a copy of this graph state.
GraphState	copyWith(boolean isSubstitution, SpeculationLog speculationLogForCopy) Creates a copy of this graph state with the given speculation log.
int	countMissingStages(EnumSet<GraphState.StageFlag> targetStages)
static GraphState	defaultGraphState() Creates a GraphState with guards stage set to GraphState.GuardsStage.FLOATING_GUARDS, empty EnumSet for stage flags and future required stages, frame state verification set to GraphState.FrameStateVerification.ALL and null for the other fields.
boolean	equals(Object obj)
void	forceDisableFrameStateVerification() Forcefully disable frame state verification for the rest of this compilation.
GraphState.FrameStateVerification	getFrameStateVerification()
EnumSet<GraphState.StageFlag>	getFutureRequiredStages()
GraphState.GuardsStage	getGuardsStage()
SpeculationLog	getSpeculationLog()
EnumSet<GraphState.StageFlag>	getStageFlags()
boolean	hasAllMandatoryStages(GraphState.MandatoryStages mandatoryStages) Checks if all the stages represented by the given GraphState.MandatoryStages have been applied to this graph.
int	hashCode()
boolean	isAfterStage(GraphState.StageFlag stage) Checks if a stage has already been applied to this graph.
boolean	isAfterStages(EnumSet<GraphState.StageFlag> stages) Checks if multiple stages have been already applied to this graph.
boolean	isBeforeStage(GraphState.StageFlag stage) Checks if this graph state is before a stage.
boolean	isDuringStage(GraphState.StageFlag stage) Phases may set this flag to indicate that a stage is in progress.
boolean	isFrameStateVerificationDisabled() Determines if frame state verification has been forcefully disabled.
void	removeRequirementToStage(GraphState.StageFlag stage) Removes the requirement to the given GraphState.StageFlag from this graph state.
boolean	requiresFutureStage(GraphState.StageFlag stage) Checks if the given GraphState.StageFlag is contained in this graph state's future required stages.
boolean	requiresFutureStages() Checks if this graph state has remaining GraphState.StageFlags requirements in future required stages.
void	setAfterFSA() Indicates FSA has been applied to this graph.
void	setAfterStage(GraphState.StageFlag stage) Adds the given stage to this stage flags to indicate this stage has been applied.
void	setDuringStage(GraphState.StageFlag stage) Sets this GraphState.currentStage to indicate that a stage is in progress.
void	setGuardsStage(GraphState.GuardsStage guardsStage) Sets the guards stage of this graph state.
String	toString()
String	toString(String prefix) Creates a String with this guards stage, stage flags, frame state verification and future required stages.
String	updateFromPreviousToString(GraphState previous) Creates a String representing the differences between this guards stage, stage flags, frame state verification and future required stages and previous's respective fields.
void	weakenFrameStateVerification(GraphState.FrameStateVerification newFrameStateVerification) Sets the given GraphState.FrameStateVerification as this frame state verification.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INITIAL_REQUIRED_STAGES

public static final EnumSet<GraphState.StageFlag> INITIAL_REQUIRED_STAGES

This set of GraphState.StageFlags represents the stages a StructuredGraph initially requires to correctly pass all the other stages of the compilation. (See GraphState.getFutureRequiredStages())

Constructor Detail

GraphState

public GraphState(GraphState.StageFlag currentStage,
                  boolean disabledFrameStateVerification,
                  boolean isSubstitution,
                  EnumSet<GraphState.StageFlag> futureRequiredStages,
                  GraphState.GuardsStage guardsStage,
                  SpeculationLog speculationLog,
                  EnumSet<GraphState.StageFlag> stageFlags)

Creates a GraphState with the given fields.

Parameters:

isSubstitution - determines this frame state verification. GraphState.FrameStateVerification.NONE is used if it is true, otherwise it is GraphState.FrameStateVerification.ALL. If it is true, GraphState.isFrameStateVerificationDisabled() will be true.

GraphState

public GraphState(GraphState.StageFlag currentStage,
                  boolean disabledFrameStateVerification,
                  GraphState.FrameStateVerification frameStateVerification,
                  EnumSet<GraphState.StageFlag> futureRequiredStages,
                  GraphState.GuardsStage guardsStage,
                  SpeculationLog speculationLog,
                  EnumSet<GraphState.StageFlag> stageFlags)

Creates a GraphState with the given fields.

Parameters:

guardsStage - the GraphState.GuardsStage of this graph state, GraphState.GuardsStage.FLOATING_GUARDS if it is null.

Method Detail

defaultGraphState

public static GraphState defaultGraphState()

Creates a GraphState with guards stage set to GraphState.GuardsStage.FLOATING_GUARDS, empty EnumSet for stage flags and future required stages, frame state verification set to GraphState.FrameStateVerification.ALL and null for the other fields.

copy

public GraphState copy()

Creates a copy of this graph state. The copy's stage flags and future required stages are deep copy of this graph state's respective fields.

copyWith

public GraphState copyWith(boolean isSubstitution,
                           SpeculationLog speculationLogForCopy)

Creates a copy of this graph state with the given speculation log. The copy's stage flags and future required stages are deep copy of this graph state's respective fields.

Parameters:

isSubstitution - determines the copy's frame state verification. (See GraphState.GraphState(StageFlag, boolean, boolean, EnumSet, GuardsStage, SpeculationLog, EnumSet))

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(String prefix)

Creates a String with this guards stage, stage flags, frame state verification and future required stages.

Parameters:

prefix - the string inserted at the beginning of each line of the resulting string.

updateFromPreviousToString

public String updateFromPreviousToString(GraphState previous)

Creates a String representing the differences between this guards stage, stage flags, frame state verification and future required stages and previous's respective fields. If this GraphState.equals(java.lang.Object) previous, an empty string is returned.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getSpeculationLog

public SpeculationLog getSpeculationLog()

Returns:

the SpeculationLog used to perform speculative operations on this graph.

isFrameStateVerificationDisabled

public boolean isFrameStateVerificationDisabled()

Determines if frame state verification has been forcefully disabled.

Returns:

true if GraphState.forceDisableFrameStateVerification() or StructuredGraph.clearAllStateAfterForTestingOnly() has been called or if this graph was build as a substitution (see GraphState.GraphState(StageFlag, boolean, boolean, EnumSet, GuardsStage, SpeculationLog, EnumSet)).

getFrameStateVerification

public GraphState.FrameStateVerification getFrameStateVerification()

Returns:

the status of the FrameState verification of AbstractStateSplit state after.

canWeakenFrameStateVerification

public boolean canWeakenFrameStateVerification(GraphState.FrameStateVerification stage)

Checks if this frame state verification can be weakened to the given GraphState.FrameStateVerification. Verification can only be relaxed over the course of compilation.

weakenFrameStateVerification

public void weakenFrameStateVerification(GraphState.FrameStateVerification newFrameStateVerification)

Sets the given GraphState.FrameStateVerification as this frame state verification.

forceDisableFrameStateVerification

public void forceDisableFrameStateVerification()

Forcefully disable frame state verification for the rest of this compilation. This must only be used for stubs, snippets, and test code that builds custom compilation pipelines. Normal compilations must use GraphState.weakenFrameStateVerification(FrameStateVerification) to progress through the standard stages of frame state verification. Calling this method is not equivalent to calling weakenFrameStateVerification(NONE).

getGuardsStage

public GraphState.GuardsStage getGuardsStage()

Returns:

the current GraphState.GuardsStage for this graph state.

setGuardsStage

public void setGuardsStage(GraphState.GuardsStage guardsStage)

Sets the guards stage of this graph state. The new GraphState.GuardsStage needs to indicate a progression in the compilation, not a regression.

setAfterFSA

public void setAfterFSA()

Indicates FSA has been applied to this graph. (See GraphState.setGuardsStage(GuardsStage) and GraphState.setAfterStage(StageFlag))

isBeforeStage

public boolean isBeforeStage(GraphState.StageFlag stage)

Checks if this graph state is before a stage. This stage must not be in progress (see GraphState.isDuringStage(StageFlag)) nor have been applied yet (see GraphState.isAfterStage(StageFlag)).

isDuringStage

public boolean isDuringStage(GraphState.StageFlag stage)

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

isAfterStage

public boolean isAfterStage(GraphState.StageFlag stage)

Checks if a stage has already been applied to this graph.

isAfterStages

public boolean isAfterStages(EnumSet<GraphState.StageFlag> stages)

Checks if multiple stages have been already applied to this graph.

setDuringStage

public void setDuringStage(GraphState.StageFlag stage)

Sets this GraphState.currentStage to indicate that a stage is in progress. This stage must not have been applied yet.

setAfterStage

public void setAfterStage(GraphState.StageFlag stage)

Adds the given stage to this stage flags to indicate this stage has been applied. This stage must not have been applied yet.

getStageFlags

public EnumSet<GraphState.StageFlag> getStageFlags()

Returns:

the stages (see GraphState.StageFlag) that were applied to this graph.

hasAllMandatoryStages

public boolean hasAllMandatoryStages(GraphState.MandatoryStages mandatoryStages)

Checks if all the stages represented by the given GraphState.MandatoryStages have been applied to this graph.

countMissingStages

public int countMissingStages(EnumSet<GraphState.StageFlag> targetStages)

Returns:

the number of stages that are in targetStages but not in the stage flags of this graph state.

addFutureStageRequirement

public void addFutureStageRequirement(GraphState.StageFlag stage)

Adds the given GraphState.StageFlag to the future required stages of this graph state.

removeRequirementToStage

public void removeRequirementToStage(GraphState.StageFlag stage)

Removes the requirement to the given GraphState.StageFlag from this graph state.

requiresFutureStage

public boolean requiresFutureStage(GraphState.StageFlag stage)

Checks if the given GraphState.StageFlag is contained in this graph state's future required stages.

requiresFutureStages

public boolean requiresFutureStages()

Checks if this graph state has remaining GraphState.StageFlags requirements in future required stages.

getFutureRequiredStages

public EnumSet<GraphState.StageFlag> getFutureRequiredStages()

Returns:

which stages this graph state requires. These future required stages might includes lowering phases for nodes that were introduced in the graph by previous stages for example.