org.graalvm.compiler.nodes

Class IfNode

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.IfNode

All Implemented Interfaces:

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

public final class IfNode
extends ControlSplitNode
implements Simplifiable, LIRLowerable, IterableNodeType, SwitchFoldable

The IfNode represents a branch that can go one of two directions depending on the outcome of a comparison.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IfNode.NodeColor

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.KeyData, SwitchFoldable.QuickQueryKeyData, SwitchFoldable.QuickQueryList<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected ProfileData.BranchProbabilityData	profileData
static NodeClass<IfNode>	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

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

SORTER

Constructor Summary

Constructors

Constructor and Description
IfNode(LogicNode condition, AbstractBeginNode trueSuccessor, AbstractBeginNode falseSuccessor, ProfileData.BranchProbabilityData profileData)
IfNode(LogicNode condition, FixedNode trueSuccessor, FixedNode falseSuccessor, ProfileData.BranchProbabilityData profileData)

Method Summary

Modifier and Type	Method and Description
LogicNode	condition()
static Constant[]	constantValues(ValueNode node, AbstractMergeNode merge, boolean allowNull) Gets an array of constants derived from a node that is either a ConstantNode or a PhiNode whose input values are all constants.
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.
double	defaultProbability() Returns the probability of going to the default branch.
void	eliminateNegation()
AbstractBeginNode	falseSuccessor() Gets the false successor.
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.
AbstractBeginNode	getPrimarySuccessor() Primary successor of the control split.
ProfileData.BranchProbabilityData	getProfileData() Returns the source of this node's knowledge about its successor probabilities.
AbstractBeginNode	getSuccessor(boolean result)
int	getSuccessorCount() Returns the number of successors.
double	getTrueSuccessorProbability()
int	intKeyAt(int i) Returns the value of the i-th key of this node.
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.
static boolean	isWorthPerformingSplit(LogicNode newCondition, LogicNode originalCondition)
double	keyProbability(int i) Returns the probability of seeing the i-th key of this node.
AbstractBeginNode	keySuccessor(int i) Returns the branch to follow when seeing the i-th key of this node.
double	probability(AbstractBeginNode successor)
ProfileData.ProfileSource	profileSource() Returns the source of the information about branch probabilities of this node.
protected void	removeThroughFalseBranch(SimplifierTool tool, AbstractMergeNode merge)
static boolean	sameDestination(AbstractBeginNode succ1, AbstractBeginNode succ2) Check it these two blocks end up at the same place.
void	setCondition(LogicNode x)
void	setFalseSuccessor(AbstractBeginNode node)
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).
void	setTrueSuccessor(AbstractBeginNode node)
void	setTrueSuccessorProbability(ProfileData.BranchProbabilityData profileData)
void	simplify(SimplifierTool tool)
AbstractBeginNode	successor(boolean istrue) Gets the node corresponding to the specified outcome of the branch.
ValueNode	switchValue() Returns the value that will be used as the switch input.
AbstractBeginNode	trueSuccessor() Gets the true successor.
protected ProfileData.BranchProbabilityData	trueSuccessorProfile()
boolean	verify()
boolean	verifySourcePosition()

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

successorProbabilities

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

asFixedNode

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, hasExactlyOneUsageOfType, 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, 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

isDefaultSuccessor, keyCount, maybeIsInSwitch, sameSwitchValue, switchTransformationOptimization

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

asNode

Field Detail

TYPE

public static final NodeClass<IfNode> TYPE

profileData

protected ProfileData.BranchProbabilityData profileData

Constructor Detail

IfNode

public IfNode(LogicNode condition,
              FixedNode trueSuccessor,
              FixedNode falseSuccessor,
              ProfileData.BranchProbabilityData profileData)

IfNode

public IfNode(LogicNode condition,
              AbstractBeginNode trueSuccessor,
              AbstractBeginNode falseSuccessor,
              ProfileData.BranchProbabilityData profileData)

Method Detail

condition

public LogicNode condition()

setCondition

public void setCondition(LogicNode x)

trueSuccessor

public AbstractBeginNode trueSuccessor()

Gets the true successor.

Returns:

the true successor

falseSuccessor

public AbstractBeginNode falseSuccessor()

Gets the false successor.

Returns:

the false successor

getTrueSuccessorProbability

public double getTrueSuccessorProbability()

setTrueSuccessor

public void setTrueSuccessor(AbstractBeginNode node)

setFalseSuccessor

public void setFalseSuccessor(AbstractBeginNode node)

successor

public AbstractBeginNode successor(boolean istrue)

Gets the node corresponding to the specified outcome of the branch.

Parameters:

istrue - true if the true successor is requested, false otherwise

Returns:

the corresponding successor

setTrueSuccessorProbability

public void setTrueSuccessorProbability(ProfileData.BranchProbabilityData profileData)

trueSuccessorProfile

protected ProfileData.BranchProbabilityData trueSuccessorProfile()

probability

public double probability(AbstractBeginNode successor)

Specified by:

probability in class ControlSplitNode

generate

public void generate(NodeLIRBuilderTool gen)

Specified by:

generate in interface LIRLowerable

verify

public boolean verify()

Overrides:

verify in class FixedNode

verifySourcePosition

public boolean verifySourcePosition()

Overrides:

verifySourcePosition in class Node

eliminateNegation

public void eliminateNegation()

simplify

public void simplify(SimplifierTool tool)

Specified by:

simplify in interface Simplifiable

isWorthPerformingSplit

public static boolean isWorthPerformingSplit(LogicNode newCondition,
                                             LogicNode originalCondition)

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

getProfileData

public ProfileData.BranchProbabilityData getProfileData()

Description copied from class: ControlSplitNode

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

Specified by:

getProfileData in class ControlSplitNode

intKeyAt

public int intKeyAt(int i)

Description copied from interface: SwitchFoldable

Returns the value of the i-th key of this node.

Specified by:

intKeyAt in interface SwitchFoldable

keyProbability

public double keyProbability(int i)

Description copied from interface: SwitchFoldable

Returns the probability of seeing the i-th key of this node.

Specified by:

keyProbability in interface SwitchFoldable

keySuccessor

public AbstractBeginNode keySuccessor(int i)

Description copied from interface: SwitchFoldable

Returns the branch to follow when seeing the i-th key of this node.

Specified by:

keySuccessor in interface SwitchFoldable

defaultProbability

public double defaultProbability()

Description copied from interface: SwitchFoldable

Returns the probability of going to the default branch.

Specified by:

defaultProbability in interface SwitchFoldable

sameDestination

public static boolean sameDestination(AbstractBeginNode succ1,
                                      AbstractBeginNode succ2)

Check it these two blocks end up at the same place. Meeting at the same merge, or deoptimizing in the same way.

removeThroughFalseBranch

protected void removeThroughFalseBranch(SimplifierTool tool,
                                        AbstractMergeNode merge)

constantValues

public static Constant[] constantValues(ValueNode node,
                                        AbstractMergeNode merge,
                                        boolean allowNull)

Gets an array of constants derived from a node that is either a ConstantNode or a PhiNode whose input values are all constants. The length of the returned array is equal to the number of ends terminating in a given merge node.

Returns:

null if node is neither a ConstantNode nor a PhiNode whose input values are all constants

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

getSuccessor

public AbstractBeginNode getSuccessor(boolean result)

setProbability

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

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

getSuccessorCount

public int getSuccessorCount()

Description copied from class: ControlSplitNode

Returns the number of successors.

Specified by:

getSuccessorCount in class ControlSplitNode