org.graalvm.compiler.nodes.extended

Class SwitchNode

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

All Implemented Interfaces:

Cloneable, Formattable, FixedNodeInterface, ValueNodeInterface

Direct Known Subclasses:

IntegerSwitchNode, TypeSwitchNode

public abstract class SwitchNode
extends ControlSplitNode

The SwitchNode class is the base of both lookup and table switches.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	keySuccessors
protected ProfileData.SwitchProbabilityData	profileData
protected NodeSuccessorList<AbstractBeginNode>	successors
static NodeClass<SwitchNode>	TYPE
protected ValueNode	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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SwitchNode(NodeClass<? extends SwitchNode> c, ValueNode value, AbstractBeginNode[] successors, int[] keySuccessors, ProfileData.SwitchProbabilityData profileData) Constructs a new Switch.

Method Summary

Modifier and Type	Method and Description
AbstractBeginNode	blockSuccessor(int i)
int	blockSuccessorCount()
double	defaultProbability() Returns the probability of taking the default branch.
AbstractBeginNode	defaultSuccessor() Gets the successor corresponding to the default (fall through) case.
int	defaultSuccessorIndex() Returns the index of the default (fall through) successor of this switch.
protected NodeSize	dynamicNodeSizeEstimate() Node subclasses should override this method if they need to specify a dynamically calculated NodeSize value.
abstract boolean	equalKeys(SwitchNode switchNode) Returns true if the switch has the same keys in the same order as this switch.
NodeCycles	estimatedNodeCycles()
protected double[]	getKeyProbabilities()
int[]	getKeySuccessors()
AbstractBeginNode	getPrimarySuccessor() Primary successor of the control split.
ProfileData.SwitchProbabilityData	getProfileData() Returns the source of this node's knowledge about its successor probabilities.
int	getSuccessorCount() Returns the number of successors.
abstract Stamp	getValueStampForSuccessor(AbstractBeginNode beginNode)
abstract boolean	isSorted()
abstract Constant	keyAt(int i) The key at the specified position, encoded in a Constant.
abstract int	keyCount() The number of distinct keys in this switch.
double	keyProbability(int i) Returns the probability of the key at the given index.
AbstractBeginNode	keySuccessor(int i) Returns the successor for the key at the given index.
int	keySuccessorIndex(int i) Returns the index of the successor belonging to the key at the specified index.
protected void	killOtherSuccessors(SimplifierTool tool, int survivingEdge) Delete all other successors except for the one reached by survivingEdge.
double	probability(AbstractBeginNode successor)
void	setBlockSuccessor(int i, AbstractBeginNode s)
boolean	setProbability(AbstractBeginNode successor, ProfileData.BranchProbabilityData successorProfileData) Attempts to set the probability for the given successor to the passed value (which has to be in the range of 0.0 and 1.0).
boolean	structureEquals(SwitchNode switchNode)
ValueNode	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.ValueNodeInterface

asNode

Field Detail

TYPE

public static final NodeClass<SwitchNode> TYPE

successors

protected NodeSuccessorList<AbstractBeginNode> successors

value

protected ValueNode value

keySuccessors

protected final int[] keySuccessors

profileData

protected ProfileData.SwitchProbabilityData profileData

Constructor Detail

SwitchNode

protected SwitchNode(NodeClass<? extends SwitchNode> c,
                     ValueNode value,
                     AbstractBeginNode[] successors,
                     int[] keySuccessors,
                     ProfileData.SwitchProbabilityData profileData)

Constructs a new Switch.

Parameters:

value - the instruction that provides the value to be switched over

successors - the list of successors of this switch

Method Detail

getKeyProbabilities

protected double[] getKeyProbabilities()

getSuccessorCount

public int getSuccessorCount()

Description copied from class: ControlSplitNode

Returns the number of successors.

Specified by:

getSuccessorCount in class ControlSplitNode

probability

public double probability(AbstractBeginNode successor)

Specified by:

probability in class ControlSplitNode

setProbability

public boolean setProbability(AbstractBeginNode successor,
                              ProfileData.BranchProbabilityData successorProfileData)

Description copied from class: ControlSplitNode

Attempts to set the probability for the given successor to the passed value (which has to be in the range of 0.0 and 1.0). Returns whether setting the probability was successful. When successful, sets the source of the knowledge about probabilities according to the profileData's profile source.

Specified by:

setProbability in class ControlSplitNode

getProfileData

public ProfileData.SwitchProbabilityData getProfileData()

Description copied from class: ControlSplitNode

Returns the source of this node's knowledge about its successor probabilities.

Specified by:

getProfileData in class ControlSplitNode

value

public ValueNode value()

isSorted

public abstract boolean isSorted()

keyCount

public abstract int keyCount()

The number of distinct keys in this switch.

keyAt

public abstract Constant keyAt(int i)

The key at the specified position, encoded in a Constant.

structureEquals

public boolean structureEquals(SwitchNode switchNode)

equalKeys

public abstract boolean equalKeys(SwitchNode switchNode)

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

keySuccessorIndex

public int keySuccessorIndex(int i)

Returns the index of the successor belonging to the key at the specified index.

keySuccessor

public AbstractBeginNode keySuccessor(int i)

Returns the successor for the key at the given index.

keyProbability

public double keyProbability(int i)

Returns the probability of the key at the given index.

defaultProbability

public double defaultProbability()

Returns the probability of taking the default branch.

defaultSuccessorIndex

public int defaultSuccessorIndex()

Returns the index of the default (fall through) successor of this switch.

blockSuccessor

public AbstractBeginNode blockSuccessor(int i)

setBlockSuccessor

public void setBlockSuccessor(int i,
                              AbstractBeginNode s)

blockSuccessorCount

public int blockSuccessorCount()

defaultSuccessor

public AbstractBeginNode defaultSuccessor()

Gets the successor corresponding to the default (fall through) case.

Returns:

the default successor

getPrimarySuccessor

public AbstractBeginNode getPrimarySuccessor()

Description copied from class: ControlSplitNode

Primary successor of the control split. Data dependencies on the node have to be scheduled in the primary successor. Returns null if data dependencies are not expected.

Specified by:

getPrimarySuccessor in class ControlSplitNode

Returns:

the primary successor

killOtherSuccessors

protected void killOtherSuccessors(SimplifierTool tool,
                                   int survivingEdge)

Delete all other successors except for the one reached by survivingEdge.

Parameters:

tool -

survivingEdge - index of the edge in the SwitchNode.successors list

getValueStampForSuccessor

public abstract Stamp getValueStampForSuccessor(AbstractBeginNode beginNode)

estimatedNodeCycles

public NodeCycles estimatedNodeCycles()

Overrides:

estimatedNodeCycles in class Node

dynamicNodeSizeEstimate

protected NodeSize dynamicNodeSizeEstimate()

Description copied from class: Node

Node subclasses should override this method if they need to specify a dynamically calculated NodeSize value. If the node size is static please use NodeInfo.size(). NOTE: When overriding this method, make sure that *all* field reads are null checked (even if Java semantics seemingly make the value of the field non-null). This is necessary because node size estimates are needed even during graph decoding which, for some nodes, first reflectively creates a stub and then later, reflectively, populates its fields. This method could be invoked between these two points. For this reason, when overriding this method assume that all fields can and will be null.

Overrides:

dynamicNodeSizeEstimate in class Node

Returns:

The estimated node size for this node.

getKeySuccessors

public int[] getKeySuccessors()