org.graalvm.compiler.phases

Class PhaseSuite<C>

java.lang.Object

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

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

All Implemented Interfaces:

PhasePlan<BasePhase<? super C>>, PhaseSizeContract

Direct Known Subclasses:

BaseTier, InstrumentationSuite, PostPartialEvaluationSuite

public class PhaseSuite<C>
extends BasePhase<C>
implements PhasePlan<BasePhase<? super C>>

A compiler phase that can apply an ordered collection of phases to a graph.

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface org.graalvm.compiler.core.common.util.PhasePlan

PhasePlan.Printer

Constructor Summary

Constructors

Constructor and Description
PhaseSuite()

Method Summary

Modifier and Type	Method and Description
void	addBeforeLast(BasePhase<? super C> phase) Inserts a phase before the last phase in the suite.
void	appendPhase(BasePhase<? super C> phase) Add a new phase at the end of this suite.
boolean	checkContract()
PhaseSuite<C>	copy()
ListIterator<BasePhase<? super C>>	findLastPhase() Returns a ListIterator at the position of the last phase in the suite.
static <C> boolean	findNextPhase(ListIterator<BasePhase<? super C>> it, Class<? extends BasePhase<? super C>> phaseClass)
static <C> boolean	findNextPhase(ListIterator<BasePhase<? super C>> it, Class<? extends BasePhase<? super C>> phaseClass, boolean recursive)
ListIterator<BasePhase<? super C>>	findPhase(Class<? extends BasePhase<? super C>> phaseClass) Returns a ListIterator at the position of the first phase which is an instance of phaseClass or null if no such phase can be found.
ListIterator<BasePhase<? super C>>	findPhase(Class<? extends BasePhase<? super C>> phaseClass, boolean recursive) Returns a ListIterator at the position of the first phase which is an instance of phaseClass or, if recursive is true, is a PhaseSuite containing a phase which is an instance of phaseClass.
String	getPhaseName(BasePhase<? super C> phase) Gets a name for a phase in the plan.
List<BasePhase<? super C>>	getPhases() Gets an unmodifiable view on the phases in this suite.
boolean	isImmutable()
void	prependPhase(BasePhase<? super C> phase) Add a new phase at the beginning of this suite.
boolean	removePhase(Class<? extends BasePhase<? super C>> phaseClass) Removes the first instance of the given phase class, looking recursively into inner phase suites.
boolean	replaceAllPhases(Class<? extends BasePhase<? super C>> phaseClass, Supplier<BasePhase<? super C>> newPhase) Replaces all instances of the given phase class, looking recursively into inner phase suites.
boolean	replacePhase(Class<? extends BasePhase<? super C>> phaseClass, BasePhase<? super C> newPhase) Replaces the first instance of the given phase class, looking recursively into inner phase suites.
protected void	run(StructuredGraph graph, C context)
void	setImmutable()
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PhaseSuite

public PhaseSuite()

Method Detail

checkContract

public boolean checkContract()

Specified by:

checkContract in interface PhaseSizeContract

isImmutable

public boolean isImmutable()

setImmutable

public void setImmutable()

prependPhase

public final void prependPhase(BasePhase<? super C> phase)

Add a new phase at the beginning of this suite.

appendPhase

public final void appendPhase(BasePhase<? super C> phase)

Add a new phase at the end of this suite.

addBeforeLast

public final void addBeforeLast(BasePhase<? super C> phase)

Inserts a phase before the last phase in the suite. If the suite contains no phases the new phase will be inserted as the first phase.

findLastPhase

public ListIterator<BasePhase<? super C>> findLastPhase()

Returns a ListIterator at the position of the last phase in the suite. If the suite has no phases then it will return an empty iterator.

getPhases

public List<BasePhase<? super C>> getPhases()

Gets an unmodifiable view on the phases in this suite.

Specified by:

getPhases in interface PhasePlan<BasePhase<? super C>>

getPhaseName

public String getPhaseName(BasePhase<? super C> phase)

Description copied from interface: PhasePlan

Gets a name for a phase in the plan. This should be in the format of a qualified Java class name.

Specified by:

getPhaseName in interface PhasePlan<BasePhase<? super C>>

toString

public String toString()

Overrides:

toString in class Object

findPhase

public final ListIterator<BasePhase<? super C>> findPhase(Class<? extends BasePhase<? super C>> phaseClass)

Returns a ListIterator at the position of the first phase which is an instance of phaseClass or null if no such phase can be found. Calling ListIterator.previous() would return the phase that was found.

Parameters:

phaseClass - the type of phase to look for.

findPhase

public final ListIterator<BasePhase<? super C>> findPhase(Class<? extends BasePhase<? super C>> phaseClass,
                                                          boolean recursive)

Returns a ListIterator at the position of the first phase which is an instance of phaseClass or, if recursive is true, is a PhaseSuite containing a phase which is an instance of phaseClass. This method returns null if no such phase can be found. Calling ListIterator.previous() would return the phase or phase suite that was found.

Parameters:

phaseClass - the type of phase to look for

recursive - whether to recursively look into phase suites.

findNextPhase

public static <C> boolean findNextPhase(ListIterator<BasePhase<? super C>> it,
                                        Class<? extends BasePhase<? super C>> phaseClass)

findNextPhase

public static <C> boolean findNextPhase(ListIterator<BasePhase<? super C>> it,
                                        Class<? extends BasePhase<? super C>> phaseClass,
                                        boolean recursive)

removePhase

public boolean removePhase(Class<? extends BasePhase<? super C>> phaseClass)

Removes the first instance of the given phase class, looking recursively into inner phase suites.

replacePhase

public boolean replacePhase(Class<? extends BasePhase<? super C>> phaseClass,
                            BasePhase<? super C> newPhase)

Replaces the first instance of the given phase class, looking recursively into inner phase suites.

replaceAllPhases

public boolean replaceAllPhases(Class<? extends BasePhase<? super C>> phaseClass,
                                Supplier<BasePhase<? super C>> newPhase)

Replaces all instances of the given phase class, looking recursively into inner phase suites.

Returns:

true if at least one replacement was made, false otherwise.

run

protected void run(StructuredGraph graph,
                   C context)

Specified by:

run in class BasePhase<C>

copy

public PhaseSuite<C> copy()