org.graalvm.compiler.nodes.extended

Class BranchProbabilityNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.calc.FloatingNode

org.graalvm.compiler.nodes.extended.BranchProbabilityNode

All Implemented Interfaces:

Cloneable, Formattable, Node.ValueNumberable, CanonicalizableMarker, SimplifiableMarker, Canonicalizable, Lowerable, Simplifiable, ValueNodeInterface

public final class BranchProbabilityNode
extends FloatingNode
implements Simplifiable, Lowerable, Canonicalizable

Instances of this node class will look for a preceding if node and put the given probability into the if node's taken probability. Then the branch probability node will be removed. This node is intended primarily for snippets, so that they can define their fast and slow paths.

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

Canonicalizable.Binary<T extends Node>, Canonicalizable.BinaryCommutative<T extends Node>, Canonicalizable.Ternary<T extends Node>, Canonicalizable.Unary<T extends Node>

Field Summary

Fields

Modifier and Type	Field and Description
static double	ALWAYS_TAKEN_PROBABILITY
static ProfileData.BranchProbabilityData	ALWAYS_TAKEN_PROFILE
static double	DEOPT_PROBABILITY
static ProfileData.BranchProbabilityData	DEOPT_PROFILE
static double	EXTREMELY_FAST_PATH_PROBABILITY
static ProfileData.BranchProbabilityData	EXTREMELY_FAST_PATH_PROFILE
static double	EXTREMELY_SLOW_PATH_PROBABILITY
static ProfileData.BranchProbabilityData	EXTREMELY_SLOW_PATH_PROFILE
static double	FAST_PATH_PROBABILITY
static ProfileData.BranchProbabilityData	FAST_PATH_PROFILE
static double	FREQUENT_PROBABILITY
static ProfileData.BranchProbabilityData	FREQUENT_PROFILE
static double	LIKELY_PROBABILITY
static ProfileData.BranchProbabilityData	LIKELY_PROFILE
static double	NEVER_TAKEN_PROBABILITY
static ProfileData.BranchProbabilityData	NEVER_TAKEN_PROFILE
static double	NOT_FREQUENT_PROBABILITY
static ProfileData.BranchProbabilityData	NOT_FREQUENT_PROFILE
static double	NOT_LIKELY_PROBABILITY
static ProfileData.BranchProbabilityData	NOT_LIKELY_PROFILE
static double	SLOW_PATH_PROBABILITY
static ProfileData.BranchProbabilityData	SLOW_PATH_PROFILE
static NodeClass<BranchProbabilityNode>	TYPE
static double	VERY_FAST_PATH_PROBABILITY
static ProfileData.BranchProbabilityData	VERY_FAST_PATH_PROFILE
static double	VERY_SLOW_PATH_PROBABILITY
static ProfileData.BranchProbabilityData	VERY_SLOW_PATH_PROFILE

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

Constructor and Description
BranchProbabilityNode(ValueNode probability, ValueNode condition)

Method Summary

Modifier and Type	Method and Description
Node	canonical(CanonicalizerTool tool) Implementations of this method can provide local optimizations like constant folding and strength reduction.
ValueNode	getCondition()
ValueNode	getProbability()
void	lower(LoweringTool tool) Expand this node into lower level nodes expressing the same semantics.
static boolean	probability(double probability, boolean condition) This intrinsic should only be used for the condition of an if statement.
void	setProbability(ValueNode probability)
void	simplify(SimplifierTool tool)

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, verify, 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<BranchProbabilityNode> TYPE

LIKELY_PROBABILITY

public static final double LIKELY_PROBABILITY

See Also:

Constant Field Values

NOT_LIKELY_PROBABILITY

public static final double NOT_LIKELY_PROBABILITY

See Also:

Constant Field Values

LIKELY_PROFILE

public static final ProfileData.BranchProbabilityData LIKELY_PROFILE

NOT_LIKELY_PROFILE

public static final ProfileData.BranchProbabilityData NOT_LIKELY_PROFILE

FREQUENT_PROBABILITY

public static final double FREQUENT_PROBABILITY

See Also:

Constant Field Values

NOT_FREQUENT_PROBABILITY

public static final double NOT_FREQUENT_PROBABILITY

See Also:

Constant Field Values

FREQUENT_PROFILE

public static final ProfileData.BranchProbabilityData FREQUENT_PROFILE

NOT_FREQUENT_PROFILE

public static final ProfileData.BranchProbabilityData NOT_FREQUENT_PROFILE

FAST_PATH_PROBABILITY

public static final double FAST_PATH_PROBABILITY

See Also:

Constant Field Values

SLOW_PATH_PROBABILITY

public static final double SLOW_PATH_PROBABILITY

See Also:

Constant Field Values

FAST_PATH_PROFILE

public static final ProfileData.BranchProbabilityData FAST_PATH_PROFILE

SLOW_PATH_PROFILE

public static final ProfileData.BranchProbabilityData SLOW_PATH_PROFILE

VERY_FAST_PATH_PROBABILITY

public static final double VERY_FAST_PATH_PROBABILITY

See Also:

Constant Field Values

VERY_SLOW_PATH_PROBABILITY

public static final double VERY_SLOW_PATH_PROBABILITY

See Also:

Constant Field Values

VERY_FAST_PATH_PROFILE

public static final ProfileData.BranchProbabilityData VERY_FAST_PATH_PROFILE

VERY_SLOW_PATH_PROFILE

public static final ProfileData.BranchProbabilityData VERY_SLOW_PATH_PROFILE

EXTREMELY_FAST_PATH_PROBABILITY

public static final double EXTREMELY_FAST_PATH_PROBABILITY

See Also:

Constant Field Values

EXTREMELY_SLOW_PATH_PROBABILITY

public static final double EXTREMELY_SLOW_PATH_PROBABILITY

See Also:

Constant Field Values

EXTREMELY_FAST_PATH_PROFILE

public static final ProfileData.BranchProbabilityData EXTREMELY_FAST_PATH_PROFILE

EXTREMELY_SLOW_PATH_PROFILE

public static final ProfileData.BranchProbabilityData EXTREMELY_SLOW_PATH_PROFILE

DEOPT_PROBABILITY

public static final double DEOPT_PROBABILITY

See Also:

Constant Field Values

DEOPT_PROFILE

public static final ProfileData.BranchProbabilityData DEOPT_PROFILE

ALWAYS_TAKEN_PROBABILITY

public static final double ALWAYS_TAKEN_PROBABILITY

See Also:

Constant Field Values

NEVER_TAKEN_PROBABILITY

public static final double NEVER_TAKEN_PROBABILITY

See Also:

Constant Field Values

ALWAYS_TAKEN_PROFILE

public static final ProfileData.BranchProbabilityData ALWAYS_TAKEN_PROFILE

NEVER_TAKEN_PROFILE

public static final ProfileData.BranchProbabilityData NEVER_TAKEN_PROFILE

Constructor Detail

BranchProbabilityNode

public BranchProbabilityNode(ValueNode probability,
                             ValueNode condition)

Method Detail

getProbability

public ValueNode getProbability()

getCondition

public ValueNode getCondition()

setProbability

public void setProbability(ValueNode probability)

canonical

public Node canonical(CanonicalizerTool tool)

Description copied from interface: Canonicalizable

Implementations of this method can provide local optimizations like constant folding and strength reduction. Implementations should look at the properties and inputs of the current node and determine if there is a more optimal and always semantically correct replacement.
The return value determines the effect that the canonicalization will have:

• Returning an pre-existing node will replace the current node with the given one.
• Returning a newly created node (that was not yet added to the graph) will replace the current node with the given one, after adding it to the graph. If both the replacement and the replacee are anchored in control flow (fixed nodes), the replacement will be added to the control flow. It is invalid to replace a non-fixed node with a newly created fixed node (because its placement in the control flow cannot be determined without scheduling).
• Returning null will delete the current node and replace it with null at all usages. Note that it is not necessary to delete floating nodes that have no more usages this way - they will be deleted automatically.

Specified by:

canonical in interface Canonicalizable

Parameters:

tool - provides access to runtime interfaces like MetaAccessProvider

simplify

public void simplify(SimplifierTool tool)

Specified by:

simplify in interface Simplifiable

probability

public static boolean probability(double probability,
                                  boolean condition)

This intrinsic should only be used for the condition of an if statement. The parameter condition should also only denote a simple condition and not a combined condition involving && or || operators. It injects the probability of the condition into the if statement.

Parameters:

probability - the probability that the given condition is true as a double value between 0.0 and 1.0.

condition - the simple condition without any && or || operators

Returns:

the condition

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