org.graalvm.compiler.nodes

Class LoopBeginNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.FixedNode

org.graalvm.compiler.nodes.FixedWithNextNode

org.graalvm.compiler.nodes.AbstractBeginNode

org.graalvm.compiler.nodes.BeginStateSplitNode

org.graalvm.compiler.nodes.AbstractMergeNode

org.graalvm.compiler.nodes.LoopBeginNode

All Implemented Interfaces:

Cloneable, Formattable, IterableNodeType, NodeInterface, Simplifiable, AnchoringNode, GuardingNode, FixedNodeInterface, LIRLowerable, NodeWithState, StateSplit, ValueNodeInterface

public final class LoopBeginNode
extends AbstractMergeNode
implements IterableNodeType, LIRLowerable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoopBeginNode.LoopType

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

Node.ConstantNodeParameter, Node.EdgeVisitor, Node.IndirectCanonicalization, Node.InjectedNodeParameter, Node.Input, Node.NodeInsertionStackTrace, Node.NodeIntrinsic, Node.NodeIntrinsicFactory, Node.OptionalInput, Node.Successor, Node.ValueNumberable

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canNeverOverflow Flag indicating that this loop can never overflow based on some property not visible in the loop control computations.
protected boolean	disableCounted Flag to indicate that this loop must not be detected as a counted loop.
protected int	inversionCount
static SpeculationReasonGroup	LOOP_OVERFLOW_DEOPT
protected double	loopFrequency
protected double	loopOrigFrequency
protected LoopBeginNode.LoopType	loopType
protected int	nextEndIndex
protected boolean	osrLoop
static CounterKey	overflowSpeculationNotTaken
static CounterKey	overflowSpeculationTaken
protected int	peelings
protected int	splits
static NodeClass<LoopBeginNode>	TYPE
protected int	unrollFactor
protected int	unswitches

Fields inherited from class org.graalvm.compiler.nodes.AbstractMergeNode

ends

Fields inherited from class org.graalvm.compiler.nodes.BeginStateSplitNode

stateAfter

Fields inherited from class org.graalvm.compiler.nodes.FixedWithNextNode

next

Fields inherited from class org.graalvm.compiler.nodes.ValueNode

stamp

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

NODE_LIST, NOT_ITERABLE, TRACK_CREATION_POSITION, WithAllEdges, WithNoEdges, WithOnlyInputEdges, WithOnlySucessorEdges

Constructor Summary

Constructors

Constructor and Description
LoopBeginNode()

Method Summary

Modifier and Type	Method and Description
NodeIterable<Node>	anchored()
boolean	canNeverOverflow()
void	canonicalizePhis(SimplifierTool tool) Coalesces loop phis that represent the same value (which is not handled by normal Global Value Numbering).
void	checkDisableCountedBySpeculation(int bci, StructuredGraph graph)
boolean	countedLoopDisabled()
protected void	deleteEnd(AbstractEndNode end)
void	disableSafepoint() Disables safepoint for the whole loop, i.e., for all loop ends.
AbstractEndNode	forwardEnd()
void	generate(NodeLIRBuilderTool gen)
int	getInversionCount()
int	getLoopEndCount()
GuardingNode	getOverflowGuard()
LoopEndNode	getSingleLoopEnd()
int	getUnrollFactor()
void	incrementPeelings()
void	incrementSplits()
void	incrementUnswitches()
boolean	isLoopExit(AbstractBeginNode begin)
boolean	isMainLoop()
boolean	isOsrLoop()
boolean	isPostLoop()
boolean	isPreLoop()
boolean	isSimpleLoop()
boolean	isSingleEntryLoop()
NodeIterable<LoopEndNode>	loopEnds() Returns the unordered set of LoopEndNode that correspond to back-edges for this loop.
NodeIterable<LoopExitNode>	loopExits()
double	loopFrequency()
double	loopOrigFrequency()
void	markOsrLoop()
LoopEndNode[]	orderedLoopEnds() Returns the set of LoopEndNode that correspond to back-edges for this loop, in increasing LoopBeginNode.phiPredecessorIndex(org.graalvm.compiler.nodes.AbstractEndNode) order.
int	peelings()
AbstractEndNode	phiPredecessorAt(int index)
int	phiPredecessorCount()
int	phiPredecessorIndex(AbstractEndNode pred)
void	removeExits()
void	setCanNeverOverflow()
void	setInversionCount(int count)
void	setLoopFrequency(double loopFrequency)
void	setLoopOrigFrequency(double loopOrigFrequency)
void	setMainLoop()
void	setOverflowGuard(GuardingNode overflowGuard)
void	setPostLoop()
void	setPreLoop()
void	setUnrollFactor(int currentUnrollFactor)
void	simplify(SimplifierTool tool) This simplify method can deal with a null value for tool, so that it can be used outside of canonicalization.
int	splits()
int	unswitches()
boolean	verify()
protected boolean	verifyState()

Methods inherited from class org.graalvm.compiler.nodes.AbstractMergeNode

addForwardEnd, cfgPredecessors, clearEnds, forwardEndAt, forwardEndCount, forwardEndIndex, forwardEnds, isPhiAtMerge, memoryPhis, phis, removeEnd, valuePhis

Methods inherited from class org.graalvm.compiler.nodes.BeginStateSplitNode

hasSideEffect, setStateAfter, stateAfter

Methods inherited from class org.graalvm.compiler.nodes.AbstractBeginNode

getBlockNodes, guards, hasAnchored, hasSpeculationFence, isUsedAsGuardInput, prepareDelete, prepareDelete, prevBegin, setHasSpeculationFence

Methods inherited from class org.graalvm.compiler.nodes.FixedWithNextNode

asNode, next, setNext

Methods inherited from class org.graalvm.compiler.nodes.ValueNode

asConstant, asJavaConstant, asSerializableConstant, getStackKind, graph, hasUsagesOtherThan, inferStamp, isAllowedUsageType, isConstant, isConstantPredicate, isDefaultConstant, isIllegalConstant, isJavaConstant, isNullConstant, isSerializableConstant, replaceAtAllUsages, replaceAtUsages, setStamp, stamp, updateStamp

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

afterClone, applyInputs, applySuccessors, assertFalse, assertTrue, cfgSuccessors, clearInputs, clearNodeSourcePosition, clearSuccessors, copyWithInputs, copyWithInputs, dataFlowEquals, estimatedNodeCycles, estimatedNodeSize, fail, formatTo, getCreationPosition, getDebug, getDebugProperties, getDebugProperties, getInsertionPosition, getNodeClass, getNodeSourcePosition, getOptions, getUsageCount, hasExactlyOneUsage, hashCode, hasMoreThanOneUsage, hasNoUsages, hasOnlyUsagesOfType, hasUsages, inputPositions, inputs, isAlive, isDeleted, isUnregistered, markDeleted, maybeNotifyZeroUsages, modCount, predecessor, pushInputs, removeUsage, replaceAllInputs, replaceAndDelete, replaceAtMatchingUsages, replaceAtPredecessor, replaceAtUsages, replaceAtUsages, replaceAtUsages, replaceAtUsages, replaceAtUsagesAndDelete, replaceAtUsagesAndDelete, replaceFirstInput, replaceFirstInput, replaceFirstSuccessor, safeDelete, setCreationPosition, setInsertionPosition, setNodeSourcePosition, successorPositions, successors, toString, toString, updateNodeSourcePosition, updatePredecessor, updateUsages, updateUsagesInterface, usages, valueEquals, verifyEdges, verifyInputs, verifySourcePosition, withNodeSourcePosition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.graalvm.compiler.nodes.spi.NodeWithState

states

Methods inherited from interface org.graalvm.compiler.nodes.FixedNodeInterface

asNode

Field Detail

TYPE

public static final NodeClass<LoopBeginNode> TYPE

loopFrequency

protected double loopFrequency

loopOrigFrequency

protected double loopOrigFrequency

nextEndIndex

protected int nextEndIndex

unswitches

protected int unswitches

splits

protected int splits

peelings

protected int peelings

inversionCount

protected int inversionCount

loopType

protected LoopBeginNode.LoopType loopType

unrollFactor

protected int unrollFactor

osrLoop

protected boolean osrLoop

disableCounted

protected boolean disableCounted

Flag to indicate that this loop must not be detected as a counted loop.

canNeverOverflow

protected boolean canNeverOverflow

Flag indicating that this loop can never overflow based on some property not visible in the loop control computations.

overflowSpeculationTaken

public static final CounterKey overflowSpeculationTaken

overflowSpeculationNotTaken

public static final CounterKey overflowSpeculationNotTaken

LOOP_OVERFLOW_DEOPT

public static final SpeculationReasonGroup LOOP_OVERFLOW_DEOPT

Constructor Detail

LoopBeginNode

public LoopBeginNode()

Method Detail

checkDisableCountedBySpeculation

public void checkDisableCountedBySpeculation(int bci,
                                             StructuredGraph graph)

canNeverOverflow

public boolean canNeverOverflow()

setCanNeverOverflow

public void setCanNeverOverflow()

countedLoopDisabled

public boolean countedLoopDisabled()

isSimpleLoop

public boolean isSimpleLoop()

setPreLoop

public void setPreLoop()

isPreLoop

public boolean isPreLoop()

setMainLoop

public void setMainLoop()

isMainLoop

public boolean isMainLoop()

setPostLoop

public void setPostLoop()

isPostLoop

public boolean isPostLoop()

getUnrollFactor

public int getUnrollFactor()

setUnrollFactor

public void setUnrollFactor(int currentUnrollFactor)

disableSafepoint

public void disableSafepoint()

Disables safepoint for the whole loop, i.e., for all loop ends.

loopOrigFrequency

public double loopOrigFrequency()

setLoopOrigFrequency

public void setLoopOrigFrequency(double loopOrigFrequency)

loopFrequency

public double loopFrequency()

setLoopFrequency

public void setLoopFrequency(double loopFrequency)

loopEnds

public NodeIterable<LoopEndNode> loopEnds()

Returns the unordered set of LoopEndNode that correspond to back-edges for this loop. The order of the back-edges is unspecified, if you need to get an ordering compatible for PhiNode creation, use LoopBeginNode.orderedLoopEnds().

Returns:

the set of LoopEndNode that correspond to back-edges for this loop

loopExits

public NodeIterable<LoopExitNode> loopExits()

anchored

public NodeIterable<Node> anchored()

Overrides:

anchored in class AbstractMergeNode

orderedLoopEnds

public LoopEndNode[] orderedLoopEnds()

Returns the set of LoopEndNode that correspond to back-edges for this loop, in increasing LoopBeginNode.phiPredecessorIndex(org.graalvm.compiler.nodes.AbstractEndNode) order. This method is suited to create new loop PhiNode.
For example a new PhiNode may be added as follow:

 PhiNode phi = new ValuePhiNode(stamp, loop);
 phi.addInput(forwardEdgeValue);
 for (LoopEndNode loopEnd : loop.orderedLoopEnds()) {
     phi.addInput(backEdgeValue(loopEnd));
 }
 

Returns:

the set of LoopEndNode that correspond to back-edges for this loop

isSingleEntryLoop

public boolean isSingleEntryLoop()

forwardEnd

public AbstractEndNode forwardEnd()

splits

public int splits()

incrementSplits

public void incrementSplits()

peelings

public int peelings()

incrementPeelings

public void incrementPeelings()

generate

public void generate(NodeLIRBuilderTool gen)

Specified by:

generate in interface LIRLowerable

Overrides:

generate in class AbstractMergeNode

deleteEnd

protected void deleteEnd(AbstractEndNode end)

Overrides:

deleteEnd in class AbstractMergeNode

phiPredecessorCount

public int phiPredecessorCount()

Overrides:

phiPredecessorCount in class AbstractMergeNode

phiPredecessorIndex

public int phiPredecessorIndex(AbstractEndNode pred)

Overrides:

phiPredecessorIndex in class AbstractMergeNode

phiPredecessorAt

public AbstractEndNode phiPredecessorAt(int index)

Overrides:

phiPredecessorAt in class AbstractMergeNode

verify

public boolean verify()

Overrides:

verify in class AbstractMergeNode

getLoopEndCount

public int getLoopEndCount()

unswitches

public int unswitches()

incrementUnswitches

public void incrementUnswitches()

getInversionCount

public int getInversionCount()

setInversionCount

public void setInversionCount(int count)

simplify

public void simplify(SimplifierTool tool)

Description copied from class: AbstractMergeNode

This simplify method can deal with a null value for tool, so that it can be used outside of canonicalization.

Specified by:

simplify in interface Simplifiable

Overrides:

simplify in class AbstractMergeNode

isLoopExit

public boolean isLoopExit(AbstractBeginNode begin)

getSingleLoopEnd

public LoopEndNode getSingleLoopEnd()

removeExits

public void removeExits()

getOverflowGuard

public GuardingNode getOverflowGuard()

setOverflowGuard

public void setOverflowGuard(GuardingNode overflowGuard)

canonicalizePhis

public void canonicalizePhis(SimplifierTool tool)

Coalesces loop phis that represent the same value (which is not handled by normal Global Value Numbering).

markOsrLoop

public void markOsrLoop()

isOsrLoop

public boolean isOsrLoop()

verifyState

protected boolean verifyState()

Overrides:

verifyState in class AbstractMergeNode