org.graalvm.compiler.nodes

Class FixedGuardNode

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

org.graalvm.compiler.nodes.AbstractFixedGuardNode

org.graalvm.compiler.nodes.FixedGuardNode

All Implemented Interfaces:

Cloneable, Formattable, IterableNodeType, SimplifiableMarker, DeoptimizingGuard, DeoptimizingNode, DeoptimizingNode.DeoptBefore, GuardingNode, FixedNodeInterface, FixedWithNextNodeInterface, Lowerable, NodeWithState, Simplifiable, SwitchFoldable, StaticDeoptimizingNode, ValueNodeInterface

public final class FixedGuardNode
extends AbstractFixedGuardNode
implements Lowerable, IterableNodeType, SwitchFoldable

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

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

StaticDeoptimizingNode.GuardPriority

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

DeoptimizingNode.DeoptAfter, DeoptimizingNode.DeoptBefore, DeoptimizingNode.DeoptDuring

Field Summary

Fields

Modifier and Type	Field and Description
static NodeClass<FixedGuardNode>	TYPE

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

action, condition, negated, noDeoptSuccessorPosition, reason, speculation

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

stateBefore

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

next

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
FixedGuardNode(LogicNode condition, DeoptimizationReason deoptReason, DeoptimizationAction action)
FixedGuardNode(LogicNode condition, DeoptimizationReason deoptReason, DeoptimizationAction action, boolean negated)
FixedGuardNode(LogicNode condition, DeoptimizationReason deoptReason, DeoptimizationAction action, boolean negated, NodeSourcePosition noDeoptSuccessorPosition)
FixedGuardNode(LogicNode condition, DeoptimizationReason deoptReason, DeoptimizationAction action, SpeculationLog.Speculation speculation, boolean negated)
FixedGuardNode(LogicNode condition, DeoptimizationReason deoptReason, DeoptimizationAction action, SpeculationLog.Speculation speculation, boolean negated, NodeSourcePosition noDeoptSuccessorPosition)

Method Summary

Modifier and Type	Method and Description
boolean	canDeoptimize() Determines if this node needs deoptimization information.
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.
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.
int	intKeyAt(int i) Returns the value of the i-th key of this node.
boolean	isDefaultSuccessor(AbstractBeginNode beginNode) Should be overridden if getDefault() has side effects.
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.
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.
void	lower(LoweringTool tool) Expand this node into lower level nodes expressing the same semantics.
ProfileData.ProfileSource	profileSource() Returns the source of the information about branch probabilities of this node.
void	simplify(SimplifierTool tool)
ValueNode	switchValue() Returns the value that will be used as the switch input.

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

condition, getAction, getCondition, getNoDeoptSuccessorPosition, getReason, getSpeculation, isNegated, lowerToIf, setAction, setCondition, setNoDeoptSuccessorPosition, setReason, toString

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

setStateBefore, stateBefore

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

asFixedWithNextNode, next, setNext

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

keyCount, maybeIsInSwitch, sameSwitchValue, switchTransformationOptimization

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

asNode

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

addCallerToNoDeoptSuccessorPosition

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

computePriority, mergeActions

Methods inherited from interface org.graalvm.compiler.nodes.DeoptimizingNode.DeoptBefore

canUseAsStateDuring

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

states

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

asFixedNode

Field Detail

TYPE

public static final NodeClass<FixedGuardNode> TYPE

Constructor Detail

FixedGuardNode

public FixedGuardNode(LogicNode condition,
                      DeoptimizationReason deoptReason,
                      DeoptimizationAction action)

FixedGuardNode

public FixedGuardNode(LogicNode condition,
                      DeoptimizationReason deoptReason,
                      DeoptimizationAction action,
                      boolean negated)

FixedGuardNode

public FixedGuardNode(LogicNode condition,
                      DeoptimizationReason deoptReason,
                      DeoptimizationAction action,
                      boolean negated,
                      NodeSourcePosition noDeoptSuccessorPosition)

FixedGuardNode

public FixedGuardNode(LogicNode condition,
                      DeoptimizationReason deoptReason,
                      DeoptimizationAction action,
                      SpeculationLog.Speculation speculation,
                      boolean negated)

FixedGuardNode

public FixedGuardNode(LogicNode condition,
                      DeoptimizationReason deoptReason,
                      DeoptimizationAction action,
                      SpeculationLog.Speculation speculation,
                      boolean negated,
                      NodeSourcePosition noDeoptSuccessorPosition)

Method Detail

simplify

public void simplify(SimplifierTool tool)

Specified by:

simplify in interface Simplifiable

Overrides:

simplify in class AbstractFixedGuardNode

lower

public void lower(LoweringTool tool)

Description copied from interface: Lowerable

Expand this node into lower level nodes expressing the same semantics. If the introduced nodes are themselves lowerable, they should be recursively lowered as part of this call.

Specified by:

lower in interface Lowerable

canDeoptimize

public boolean canDeoptimize()

Description copied from interface: DeoptimizingNode

Determines if this node needs deoptimization information.

Specified by:

canDeoptimize in interface DeoptimizingNode

Overrides:

canDeoptimize in class AbstractFixedGuardNode

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

isDefaultSuccessor

public boolean isDefaultSuccessor(AbstractBeginNode beginNode)

Description copied from interface: SwitchFoldable

Should be overridden if getDefault() has side effects.

Specified by:

isDefaultSuccessor 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

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