org.graalvm.compiler.phases

Class BasePhase<C>

java.lang.Object

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

All Implemented Interfaces:

PhaseSizeContract

Direct Known Subclasses:

AbstractInliningPhase, AddressLoweringByUsePhase, AddressLoweringPhase, AgnosticInliningPhase, BoxNodeIdentityPhase, CanonicalizerPhase, ConditionalEliminationPhase, DeoptimizationGroupingPhase, DominatorBasedGlobalValueNumberingPhase, EffectsPhase, FixReadsPhase, FrameAccessVerificationPhase, GraphBuilderPhase, GuardLoweringPhase, InliningAcrossTruffleBoundaryPhase, InstrumentPhase, IterativeConditionalEliminationPhase, LoopSafepointEliminationPhase, LoopSafepointInsertionPhase, LoweringPhase, MaterializeFramesPhase, NeverPartOfCompilationPhase, NodeCounterPhase, OnStackReplacementPhase, OptimizeDivPhase, Phase, PhaseSuite, PhiTransformPhase, PostPartialEvaluationSuite.InlineReplacementsPhase, PostRunCanonicalizationPhase, PropagateDeoptimizeProbabilityPhase, RawConditionalEliminationPhase, ReassociationPhase, ReportPerformanceWarningsPhase, SchedulePhase, SetIdentityForValueTypesPhase, SingleRunSubphase, UseTrappingDivPhase, UseTrappingOperationPhase, VerifyFrameDoesNotEscapePhase, VerifyPhase, WriteBarrierAdditionPhase

public abstract class BasePhase<C>
extends Object
implements PhaseSizeContract

Base class for all compiler phases. Subclasses should be stateless, except for subclasses of SingleRunSubphase. There will be one global instance for each compiler phase that is shared for all compilations. VM-, target- and compilation-specific data can be passed with a context object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BasePhase.ApplyScope Similar to a DebugCloseable but the BasePhase.ApplyScope.close(java.lang.Throwable) operation gets a Throwable argument indicating whether the call to BasePhase.run(org.graalvm.compiler.nodes.StructuredGraph, C) completed normally or with an exception.
static class	BasePhase.BasePhaseStatistics
static class	BasePhase.PhaseOptions
static interface	BasePhase.SharedGlobalPhaseState Marker interface for fields inside phase classes that capture some state that is shared across all compilations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasePhase()

Method Summary

Modifier and Type	Method and Description
void	apply(StructuredGraph graph, C context)
void	apply(StructuredGraph graph, C context, boolean dumpGraph)
protected BasePhase.ApplyScope	applyScope(StructuredGraph graph, C context) Return an BasePhase.ApplyScope which will surround all the work performed by the call to BasePhase.run(org.graalvm.compiler.nodes.StructuredGraph, C) in BasePhase.apply(StructuredGraph, Object, boolean).
float	codeSizeIncrease() Returns a factor >=1 that determines what the final code size in terms of the sum of the node code sizes NodeSize of all nodes is.
String	contractorName()
boolean	equals(Object obj)
CharSequence	getName()
int	hashCode() Hashing a phase is used to implement and test phase plan serialization.
protected abstract void	run(StructuredGraph graph, C context)
protected boolean	shouldDumpAfterAtBasicLevel()
protected boolean	shouldDumpBeforeAtBasicLevel()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graalvm.compiler.phases.contract.PhaseSizeContract

checkContract

Constructor Detail

BasePhase

protected BasePhase()

Method Detail

apply

public final void apply(StructuredGraph graph,
                        C context)

shouldDumpBeforeAtBasicLevel

protected boolean shouldDumpBeforeAtBasicLevel()

shouldDumpAfterAtBasicLevel

protected boolean shouldDumpAfterAtBasicLevel()

applyScope

protected BasePhase.ApplyScope applyScope(StructuredGraph graph,
                                          C context)

Return an BasePhase.ApplyScope which will surround all the work performed by the call to BasePhase.run(org.graalvm.compiler.nodes.StructuredGraph, C) in BasePhase.apply(StructuredGraph, Object, boolean). This allows subclaseses to inject work which will performed before and after the application of this phase.

apply

public final void apply(StructuredGraph graph,
                        C context,
                        boolean dumpGraph)

getName

public CharSequence getName()

run

protected abstract void run(StructuredGraph graph,
                            C context)

contractorName

public String contractorName()

Specified by:

contractorName in interface PhaseSizeContract

codeSizeIncrease

public float codeSizeIncrease()

Description copied from interface: PhaseSizeContract

Returns a factor >=1 that determines what the final code size in terms of the sum of the node code sizes NodeSize of all nodes is.

Specified by:

codeSizeIncrease in interface PhaseSizeContract

Returns:

a factor that determines how much the code size can be increased by this phase

hashCode

public int hashCode()

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 Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

BasePhase.hashCode()