org.graalvm.compiler.phases.common

Class CanonicalizerPhase

java.lang.Object

org.graalvm.compiler.phases.BasePhase<CoreProviders>

org.graalvm.compiler.phases.common.CanonicalizerPhase

All Implemented Interfaces:

PhaseSizeContract

Direct Known Subclasses:

FinalCanonicalizerPhase, IncrementalCanonicalizerPhase

public class CanonicalizerPhase
extends BasePhase<CoreProviders>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CanonicalizerPhase.CanonicalizerFeature Constants for types of canonicalization that can be performed.
static interface	CanonicalizerPhase.CustomSimplification
protected class	CanonicalizerPhase.Tool

Nested classes/interfaces inherited from class org.graalvm.compiler.phases.BasePhase

BasePhase.ApplyScope, BasePhase.BasePhaseStatistics, BasePhase.NotApplicable, BasePhase.PhaseOptions, BasePhase.SharedGlobalPhaseState

Field Summary

Fields

Modifier and Type	Field and Description
protected CanonicalizerPhase.CustomSimplification	customSimplification
protected EnumSet<CanonicalizerPhase.CanonicalizerFeature>	features
protected static int	MAX_ITERATION_PER_NODE

Fields inherited from class org.graalvm.compiler.phases.BasePhase

ALWAYS_APPLICABLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CanonicalizerPhase()
protected	CanonicalizerPhase(CanonicalizerPhase.CustomSimplification customSimplification)
protected	CanonicalizerPhase(CanonicalizerPhase.CustomSimplification customSimplification, EnumSet<CanonicalizerPhase.CanonicalizerFeature> features)
protected	CanonicalizerPhase(EnumSet<CanonicalizerPhase.CanonicalizerFeature> features)

Method Summary

Modifier and Type	Method and Description
void	applyIncremental(StructuredGraph graph, CoreProviders context, Graph.Mark newNodesMark)
void	applyIncremental(StructuredGraph graph, CoreProviders context, Iterable<? extends Node> workingSet)
Optional<BasePhase.NotApplicable>	canApply(GraphState graphState) Checks if all the preconditions to BasePhase.apply(StructuredGraph, Object, boolean) the phase are met.
boolean	checkContract()
CanonicalizerPhase	copyWithCustomSimplification(CanonicalizerPhase.CustomSimplification newSimplification)
CanonicalizerPhase	copyWithoutGVN()
CanonicalizerPhase	copyWithoutSimplification()
static CanonicalizerPhase	create()
static CanonicalizerPhase	createWithoutCFGSimplification()
static CanonicalizerPhase	createWithoutGVN()
static CanonicalizerPhase	createWithoutReadCanonicalization()
boolean	equals(Object obj)
boolean	getCanonicalizeReads()
int	hashCode() Hashing a phase is used to implement and test phase plan serialization.
protected boolean	isFinalCanonicalizationPhase()
boolean	mustApply(GraphState graphState) Checks if a phase must be applied at some point in the future for the compilation of a StructuredGraph to be correct.
protected int	processWorkSet(StructuredGraph graph, CanonicalizerPhase.Tool tool)
protected void	run(StructuredGraph graph, CoreProviders context)
boolean	tryCanonicalize(Node node, NodeClass<?> nodeClass, CanonicalizerPhase.Tool tool)
boolean	tryGlobalValueNumbering(Node node, NodeClass<?> nodeClass, CanonicalizerPhase.Tool tool)
void	updateGraphState(GraphState graphState) Applies all the changes on the GraphState caused by BasePhase.apply(StructuredGraph, Object, boolean).

Methods inherited from class org.graalvm.compiler.phases.BasePhase

apply, apply, applyScope, codeSizeIncrease, contractorName, getName, shouldDumpAfterAtBasicLevel, shouldDumpBeforeAtBasicLevel

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ITERATION_PER_NODE

protected static final int MAX_ITERATION_PER_NODE

See Also:

Constant Field Values

features

protected final EnumSet<CanonicalizerPhase.CanonicalizerFeature> features

customSimplification

protected final CanonicalizerPhase.CustomSimplification customSimplification

Constructor Detail

CanonicalizerPhase

protected CanonicalizerPhase(EnumSet<CanonicalizerPhase.CanonicalizerFeature> features)

CanonicalizerPhase

protected CanonicalizerPhase()

CanonicalizerPhase

protected CanonicalizerPhase(CanonicalizerPhase.CustomSimplification customSimplification)

CanonicalizerPhase

protected CanonicalizerPhase(CanonicalizerPhase.CustomSimplification customSimplification,
                             EnumSet<CanonicalizerPhase.CanonicalizerFeature> features)

Method Detail

copyWithCustomSimplification

public CanonicalizerPhase copyWithCustomSimplification(CanonicalizerPhase.CustomSimplification newSimplification)

copyWithoutGVN

public CanonicalizerPhase copyWithoutGVN()

copyWithoutSimplification

public CanonicalizerPhase copyWithoutSimplification()

create

public static CanonicalizerPhase create()

createWithoutReadCanonicalization

public static CanonicalizerPhase createWithoutReadCanonicalization()

createWithoutGVN

public static CanonicalizerPhase createWithoutGVN()

createWithoutCFGSimplification

public static CanonicalizerPhase createWithoutCFGSimplification()

checkContract

public boolean checkContract()

isFinalCanonicalizationPhase

protected boolean isFinalCanonicalizationPhase()

mustApply

public boolean mustApply(GraphState graphState)

Description copied from class: BasePhase

Checks if a phase must be applied at some point in the future for the compilation of a StructuredGraph to be correct.

Overrides:

mustApply in class BasePhase<CoreProviders>

Parameters:

graphState - represents the state of the StructuredGraph used for compilation and contains the required stages that help in determining if a phase must be applied.

canApply

public Optional<BasePhase.NotApplicable> canApply(GraphState graphState)

Description copied from class: BasePhase

Checks if all the preconditions to BasePhase.apply(StructuredGraph, Object, boolean) the phase are met.

Overrides:

canApply in class BasePhase<CoreProviders>

Parameters:

graphState - represents the state of the StructuredGraph used for compilation and contains the required information to determine if a phase can be applied.

Returns:

Optional.empty() if all the checks pass, Optional#of(NotApplicable) containing why this phase is not applicable on this graphState otherwise.

run

protected void run(StructuredGraph graph,
                   CoreProviders context)

Specified by:

run in class BasePhase<CoreProviders>

updateGraphState

public void updateGraphState(GraphState graphState)

Description copied from class: BasePhase

Applies all the changes on the GraphState caused by BasePhase.apply(StructuredGraph, Object, boolean).

Overrides:

updateGraphState in class BasePhase<CoreProviders>

Parameters:

graphState - represents the state of the StructuredGraph used for compilation.

applyIncremental

public void applyIncremental(StructuredGraph graph,
                             CoreProviders context,
                             Graph.Mark newNodesMark)

Parameters:

newNodesMark - only the new nodes specified by this mark are processed

applyIncremental

public void applyIncremental(StructuredGraph graph,
                             CoreProviders context,
                             Iterable<? extends Node> workingSet)

Parameters:

workingSet - the initial working set of nodes on which the canonicalizer works, should be an auto-grow node bitmap

hashCode

public int hashCode()

Description copied from class: BasePhase

Hashing a phase is used to implement and test phase plan serialization. Hashing a phase should take into account any fields that configure a phase. This will be done properly once a PhaseInfo annotation is introduced (c.f. NodeInfo). The hash code returned needs to be stable across VM executions.

Overrides:

hashCode in class BasePhase<CoreProviders>

equals

public boolean equals(Object obj)

Overrides:

equals in class BasePhase<CoreProviders>

See Also:

BasePhase.hashCode()

processWorkSet

protected int processWorkSet(StructuredGraph graph,
                             CanonicalizerPhase.Tool tool)

tryGlobalValueNumbering

public boolean tryGlobalValueNumbering(Node node,
                                       NodeClass<?> nodeClass,
                                       CanonicalizerPhase.Tool tool)

tryCanonicalize

public boolean tryCanonicalize(Node node,
                               NodeClass<?> nodeClass,
                               CanonicalizerPhase.Tool tool)

getCanonicalizeReads

public boolean getCanonicalizeReads()