org.graalvm.compiler.nodes.extended

Class IntegerSwitchNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.FixedNode

org.graalvm.compiler.nodes.ControlSplitNode

org.graalvm.compiler.nodes.extended.SwitchNode

org.graalvm.compiler.nodes.extended.IntegerSwitchNode

All Implemented Interfaces:

Cloneable, Formattable, SimplifiableMarker, FixedNodeInterface, LIRLowerable, Simplifiable, SwitchFoldable, ValueNodeInterface

public final class IntegerSwitchNode
extends SwitchNode
implements LIRLowerable, Simplifiable, SwitchFoldable

The IntegerSwitchNode represents a switch on integer keys, with a sorted array of key values. The actual implementation of the switch will be decided by the backend.

Nested Class Summary

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

Nested classes/interfaces inherited from interface org.graalvm.compiler.nodes.spi.SwitchFoldable

SwitchFoldable.Helper, SwitchFoldable.QuickQueryKeyData, SwitchFoldable.QuickQueryList<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	areKeysContiguous True if keys are contiguous ([n, n+1, n+2, n+3, ..., n+k]).
protected int[]	keys
static NodeClass<IntegerSwitchNode>	TYPE

Fields inherited from class org.graalvm.compiler.nodes.extended.SwitchNode

keySuccessors, profileData, successors, value

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

EMPTY_ARRAY, stamp

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

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

Fields inherited from interface org.graalvm.compiler.nodes.spi.SwitchFoldable

SORTER

Constructor Summary

Constructors

Constructor and Description
IntegerSwitchNode(ValueNode value, AbstractBeginNode[] successors, int[] keys, int[] keySuccessors, ProfileData.SwitchProbabilityData profileData)
IntegerSwitchNode(ValueNode value, int successorCount, int[] keys, int[] keySuccessors, ProfileData.SwitchProbabilityData profileData)

Method Summary

Modifier and Type	Method and Description
void	cutOffCascadeNode() Removes the successors of this node, while keeping it linked to the rest of the cascade.
void	cutOffLowestCascadeNode() Completely removes all successors from this node.
boolean	equalKeys(SwitchNode switchNode) Returns true if the switch has the same keys in the same order as this switch.
void	generate(NodeLIRBuilderTool gen)
AbstractBeginNode	getDefault() Returns the branch that will close this switch folding, assuming this is called on the lowest node of the cascade.
Node	getNextSwitchFoldableBranch() Returns the direct successor in the branch to check for SwitchFoldability.
Stamp	getValueStampForSuccessor(AbstractBeginNode beginNode)
int	intKeyAt(int i) Gets the key at the specified index, as a java int.
boolean	isInSwitch(ValueNode switchValue) Determines whether the node should be folded in the current folding attempt.
boolean	isNonInitializedProfile() Heuristics that tries to determine whether or not a foldable node was profiled.
boolean	isSorted()
JavaConstant	keyAt(int i) Gets the key at the specified index.
int	keyCount() The number of distinct keys in this switch.
ProfileData.ProfileSource	profileSource() Returns the source of the information about branch probabilities of this node.
void	simplify(SimplifierTool tool)
AbstractBeginNode	successorAtKey(int key)
int	successorIndexAtKey(int key)
ValueNode	switchValue() Returns the value that will be used as the switch input.
boolean	tryMergeCommonSuccessors() Coalesces branches of the switch that trivially merges together.
boolean	tryRemoveUnreachableKeys(SimplifierTool tool, Stamp valueStamp) Remove unreachable keys from the switch based on the stamp of the value, i.e., based on the known range of the switch value.

Methods inherited from class org.graalvm.compiler.nodes.extended.SwitchNode

blockSuccessor, blockSuccessorCount, defaultProbability, defaultSuccessor, defaultSuccessorIndex, dynamicNodeSizeEstimate, estimatedNodeCycles, getKeyProbabilities, getKeySuccessors, getPrimarySuccessor, getProfileData, getSuccessorCount, keyProbability, keySuccessor, keySuccessorIndex, killOtherSuccessors, probability, setBlockSuccessor, setProbability, structureEquals, value

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

successorProbabilities

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

asFixedNode, verify

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

asConstant, asJavaConstant, asNode, asSerializableConstant, checkReplaceAtUsagesInvariants, getStackKind, graph, hasUsagesOtherThan, inferStamp, isAllowedUsageType, isConstant, isConstantPredicate, isDefaultConstant, isIllegalConstant, isJavaConstant, isNullConstant, isSerializableConstant, recursivelyDataFlowEqualsUpTo, setStamp, stamp, updateStamp, updateUsagesInterface

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

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

Methods inherited from class java.lang.Object

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

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

defaultProbability, isDefaultSuccessor, keyProbability, keySuccessor, maybeIsInSwitch, sameSwitchValue, switchTransformationOptimization

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

asNode

Field Detail

TYPE

public static final NodeClass<IntegerSwitchNode> TYPE

keys

protected final int[] keys

areKeysContiguous

protected final boolean areKeysContiguous

True if keys are contiguous ([n, n+1, n+2, n+3, ..., n+k]). When this is the case, we can lookup successor index in O(1).

Constructor Detail

IntegerSwitchNode

public IntegerSwitchNode(ValueNode value,
                         AbstractBeginNode[] successors,
                         int[] keys,
                         int[] keySuccessors,
                         ProfileData.SwitchProbabilityData profileData)

IntegerSwitchNode

public IntegerSwitchNode(ValueNode value,
                         int successorCount,
                         int[] keys,
                         int[] keySuccessors,
                         ProfileData.SwitchProbabilityData profileData)

Method Detail

isSorted

public boolean isSorted()

Specified by:

isSorted in class SwitchNode

keyAt

public JavaConstant keyAt(int i)

Gets the key at the specified index.

Specified by:

keyAt in class SwitchNode

Parameters:

i - the index

Returns:

the key at that index

intKeyAt

public int intKeyAt(int i)

Gets the key at the specified index, as a java int.

Specified by:

intKeyAt in interface SwitchFoldable

keyCount

public int keyCount()

Description copied from class: SwitchNode

The number of distinct keys in this switch.

Specified by:

keyCount in interface SwitchFoldable

Specified by:

keyCount in class SwitchNode

Returns:

The number of keys the SwitchFoldable node will try to add.

equalKeys

public boolean equalKeys(SwitchNode switchNode)

Description copied from class: SwitchNode

Returns true if the switch has the same keys in the same order as this switch.

Specified by:

equalKeys in class SwitchNode

generate

public void generate(NodeLIRBuilderTool gen)

Specified by:

generate in interface LIRLowerable

successorAtKey

public AbstractBeginNode successorAtKey(int key)

successorIndexAtKey

public int successorIndexAtKey(int key)

simplify

public void simplify(SimplifierTool tool)

Specified by:

simplify in interface Simplifiable

getNextSwitchFoldableBranch

public Node getNextSwitchFoldableBranch()

Description copied from interface: SwitchFoldable

Returns the direct successor in the branch to check for SwitchFoldability.

Specified by:

getNextSwitchFoldableBranch in interface SwitchFoldable

isInSwitch

public boolean isInSwitch(ValueNode switchValue)

Description copied from interface: SwitchFoldable

Determines whether the node should be folded in the current folding attempt.

Specified by:

isInSwitch in interface SwitchFoldable

Parameters:

switchValue - the value of the switch that will spawn through this folding attempt.

Returns:

true if this node should be folded in the current folding attempt, false otherwise.

See Also:

SwitchFoldable.maybeIsInSwitch(LogicNode), SwitchFoldable.sameSwitchValue(LogicNode, ValueNode)

cutOffCascadeNode

public void cutOffCascadeNode()

Description copied from interface: SwitchFoldable

Removes the successors of this node, while keeping it linked to the rest of the cascade.

Specified by:

cutOffCascadeNode in interface SwitchFoldable

cutOffLowestCascadeNode

public void cutOffLowestCascadeNode()

Description copied from interface: SwitchFoldable

Completely removes all successors from this node.

Specified by:

cutOffLowestCascadeNode in interface SwitchFoldable

getDefault

public AbstractBeginNode getDefault()

Description copied from interface: SwitchFoldable

Returns the branch that will close this switch folding, assuming this is called on the lowest node of the cascade.

Specified by:

getDefault in interface SwitchFoldable

switchValue

public ValueNode switchValue()

Description copied from interface: SwitchFoldable

Returns the value that will be used as the switch input. This value should be an int.

Specified by:

switchValue in interface SwitchFoldable

isNonInitializedProfile

public boolean isNonInitializedProfile()

Description copied from interface: SwitchFoldable

Heuristics that tries to determine whether or not a foldable node was profiled.

Specified by:

isNonInitializedProfile in interface SwitchFoldable

profileSource

public ProfileData.ProfileSource profileSource()

Description copied from interface: SwitchFoldable

Returns the source of the information about branch probabilities of this node.

Specified by:

profileSource in interface SwitchFoldable

tryMergeCommonSuccessors

public boolean tryMergeCommonSuccessors()

Coalesces branches of the switch that trivially merges together.

tryRemoveUnreachableKeys

public boolean tryRemoveUnreachableKeys(SimplifierTool tool,
                                        Stamp valueStamp)

Remove unreachable keys from the switch based on the stamp of the value, i.e., based on the known range of the switch value.

getValueStampForSuccessor

public Stamp getValueStampForSuccessor(AbstractBeginNode beginNode)

Specified by:

getValueStampForSuccessor in class SwitchNode