org.graalvm.compiler.nodes.spi

Interface Canonicalizable.Binary<T extends Node>

Type Parameters:

T - the common supertype of all inputs of this node

All Superinterfaces:

Canonicalizable, CanonicalizableMarker

All Known Subinterfaces:

Canonicalizable.BinaryCommutative<T>

All Known Implementing Classes:

AbstractNormalizeCompareNode, AddNode, AndNode, BinaryArithmeticNode, BinaryMathIntrinsicNode, BinaryNode, BinaryOpLogicNode, ClassIsAssignableFromNode, CompareNode, CopySignNode, FixedBinaryNode, FloatDivNode, FloatEqualsNode, FloatingIntegerDivRemNode, FloatLessThanNode, FloatNormalizeCompareNode, InstanceOfDynamicNode, IntegerAddExactNode, IntegerAddExactOverflowNode, IntegerBelowNode, IntegerDivRemNode, IntegerEqualsNode, IntegerExactOverflowNode, IntegerLessThanNode, IntegerLowerThanNode, IntegerMulExactNode, IntegerMulExactOverflowNode, IntegerMulHighNode, IntegerNormalizeCompareNode, IntegerSubExactNode, IntegerSubExactOverflowNode, IntegerTestNode, LeftShiftNode, MaxNode, MinMaxNode, MinNode, MulNode, ObjectEqualsNode, OrNode, PointerEqualsNode, RemNode, RightShiftNode, ShiftNode, ShortCircuitOrNode, SignedDivNode, SignedFloatingIntegerDivNode, SignedFloatingIntegerRemNode, SignedRemNode, SubNode, UnsignedDivNode, UnsignedMaxNode, UnsignedMinNode, UnsignedMulHighNode, UnsignedRemNode, UnsignedRightShiftNode, XorNode

Enclosing interface:

Canonicalizable

public static interface Canonicalizable.Binary<T extends Node>
extends Canonicalizable

This sub-interface of Canonicalizable is intended for nodes that have exactly two inputs. It has an additional Canonicalizable.Binary.canonical(CanonicalizerTool, Node, Node) method that looks at the given inputs instead of the current inputs of the node - which can be used to ask "what if this input is changed to this node" - questions.

Nested Class Summary

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>

Method Summary

Modifier and Type	Method and Description
default T	canonical(CanonicalizerTool tool) Implementations of this method can provide local optimizations like constant folding and strength reduction.
Node	canonical(CanonicalizerTool tool, T forX, T forY) Similar to Canonicalizable.canonical(CanonicalizerTool), except that implementations should act as if the current input of the node was the given one, i.e., they should never look at the inputs via the this pointer.
T	getX() Gets the current value of the input, so that calling Canonicalizable.Binary.canonical(CanonicalizerTool, Node, Node) with the value returned from this method should behave exactly like Canonicalizable.canonical(CanonicalizerTool).
T	getY() Gets the current value of the input, so that calling Canonicalizable.Binary.canonical(CanonicalizerTool, Node, Node) with the value returned from this method should behave exactly like Canonicalizable.canonical(CanonicalizerTool).

Method Detail

canonical

Node canonical(CanonicalizerTool tool,
               T forX,
               T forY)

Similar to Canonicalizable.canonical(CanonicalizerTool), except that implementations should act as if the current input of the node was the given one, i.e., they should never look at the inputs via the this pointer.

getX

T getX()

Gets the current value of the input, so that calling Canonicalizable.Binary.canonical(CanonicalizerTool, Node, Node) with the value returned from this method should behave exactly like Canonicalizable.canonical(CanonicalizerTool).

getY

T getY()

Gets the current value of the input, so that calling Canonicalizable.Binary.canonical(CanonicalizerTool, Node, Node) with the value returned from this method should behave exactly like Canonicalizable.canonical(CanonicalizerTool).

canonical

default T 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