org.graalvm.compiler.nodes

Class ControlSplitNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.FixedNode

org.graalvm.compiler.nodes.ControlSplitNode

All Implemented Interfaces:

Cloneable, Formattable, FixedNodeInterface, ValueNodeInterface

Direct Known Subclasses:

IfNode, IntegerExactArithmeticSplitNode, SwitchNode, WithExceptionNode

public abstract class ControlSplitNode
extends FixedNode

The ControlSplitNode is a base class for all instructions that split the control flow (i.e., have more than one successor).

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
static NodeClass<ControlSplitNode>	TYPE

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	ControlSplitNode(NodeClass<? extends ControlSplitNode> c, Stamp stamp)

Method Summary

Modifier and Type	Method and Description
abstract AbstractBeginNode	getPrimarySuccessor() Primary successor of the control split.
abstract ProfileData	getProfileData() Returns the source of this node's knowledge about its successor probabilities.
abstract int	getSuccessorCount() Returns the number of successors.
abstract double	probability(AbstractBeginNode successor)
abstract boolean	setProbability(AbstractBeginNode successor, ProfileData.BranchProbabilityData profileData) 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).
double[]	successorProbabilities() Returns an array containing the successors' probabilities.

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, dynamicNodeSizeEstimate, estimatedNodeCycles, 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<ControlSplitNode> TYPE

Constructor Detail

ControlSplitNode

protected ControlSplitNode(NodeClass<? extends ControlSplitNode> c,
                           Stamp stamp)

Method Detail

probability

public abstract double probability(AbstractBeginNode successor)

setProbability

public abstract boolean setProbability(AbstractBeginNode successor,
                                       ProfileData.BranchProbabilityData profileData)

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.

successorProbabilities

public double[] successorProbabilities()

Returns an array containing the successors' probabilities. The positions in the array correspond to the order of iteration over the successors.

Returns:

the array of successor probabilities

getPrimarySuccessor

public abstract AbstractBeginNode getPrimarySuccessor()

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.

Returns:

the primary successor

getSuccessorCount

public abstract int getSuccessorCount()

Returns the number of successors.

getProfileData

public abstract ProfileData getProfileData()

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