org.graalvm.compiler.nodes.spi

Interface Canonicalizable

All Superinterfaces:

CanonicalizableMarker

All Known Subinterfaces:

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

All Known Implementing Classes:

AArch64BitCountNode, AbsNode, AbstractBoxingNode, AbstractNormalizeCompareNode, AddNode, AMD64ArrayRegionEqualsWithMaskNode, AMD64FloatConvertNode, AMD64X87MathIntrinsicNode, AndNode, ArrayCompareToNode, ArrayCopyCallNode, ArrayEqualsNode, ArrayIndexOfNode, ArrayLengthNode, ArrayRegionCompareToNode, ArrayRegionEqualsNode, AssertionNode, BinaryArithmeticNode, BinaryMathIntrinsicNode, BinaryNode, BinaryOpLogicNode, BitCountNode, BitScanForwardNode, BitScanReverseNode, BoxNode, BoxNode.TrustedBoxedValue, BranchProbabilityNode, BytecodeExceptionNode, CallSiteTargetNode, ClassGetHubNode, ClassIsArrayNode, ClassIsAssignableFromNode, CompareNode, CompressionNode, ConditionalNode, ConditionAnchorNode, CopySignNode, CountLeadingZerosNode, CountTrailingZerosNode, DynamicDeoptimizeNode, DynamicNewArrayNode, DynamicNewInstanceNode, DynamicPiNode, FixedBinaryNode, FixedValueAnchorNode, FloatConvertNode, FloatDivNode, FloatEqualsNode, FloatingIntegerDivRemNode, FloatingReadNode, FloatLessThanNode, FloatNormalizeCompareNode, FusedMultiplyAddNode, GetClassNode, GraphDecoder.ProxyPlaceholder, GuardedUnsafeLoadNode, GuardedValueNode, GuardNode, GuardPhiNode, GuardProxyNode, HotSpotCompressionNode, HotSpotIdentityHashCodeNode, HotSpotReflectionGetCallerClassNode, HubGetClassNode, IdentityHashCodeNode, InstanceOfDynamicNode, InstanceOfNode, IntegerAddExactNode, IntegerAddExactOverflowNode, IntegerBelowNode, IntegerConvertNode, IntegerDivRemNode, IntegerEqualsNode, IntegerExactOverflowNode, IntegerLessThanNode, IntegerLowerThanNode, IntegerMulExactNode, IntegerMulExactOverflowNode, IntegerMulHighNode, IntegerNegExactNode, IntegerNegExactOverflowNode, IntegerNormalizeCompareNode, IntegerSubExactNode, IntegerSubExactOverflowNode, IntegerTestNode, IsCompilationConstantNode, IsNullNode, JavaReadNode, KlassLayoutHelperNode, LeftShiftNode, LoadArrayComponentHubNode, LoadFieldNode, LoadHubNode, LoadHubOrNullNode, LoadIndexedNode, LoadIndexedPointerNode, LoadMethodNode, LoadSnippetVarargParameterNode, LogicNegationNode, LoweredRegisterFinalizerNode, MaxNode, MemoryAnchorNode, MemoryPhiNode, MemoryProxyNode, MinMaxNode, MinNode, MulNode, MultiGuardNode, NarrowNode, NegateNode, NewFrameNode, NotNode, ObjectEqualsNode, ObjectIsArrayNode, OffsetAddressNode, OrNode, PhiNode, PiArrayNode, PiNode, PointerCastNode, PointerEqualsNode, ProxyNode, PureFunctionMacroNode, RawLoadNode, RawStoreNode, ReachabilityFenceNode, ReadNode, ReflectionGetCallerClassNode, RegisterFinalizerNode, ReinterpretNode, RemNode, ReverseBytesNode, RightShiftNode, RoundFloatToIntegerNode, RoundNode, ShiftNode, ShortCircuitOrNode, SignedDivNode, SignedFloatingIntegerDivNode, SignedFloatingIntegerRemNode, SignedRemNode, SignExtendNode, SignumNode, SpeculativeExceptionAnchorNode, SqrtNode, StateSplitProxyNode, StoreFieldNode, StoreIndexedNode, SubNode, TernaryNode, UnaryArithmeticNode, UnaryMathIntrinsicNode, UnaryNode, UnaryOpLogicNode, UnboxNode, UnpackEndianHalfNode, UnsafeAccessNode, UnsignedDivNode, UnsignedMaxNode, UnsignedMinNode, UnsignedMulHighNode, UnsignedRemNode, UnsignedRightShiftNode, ValuePhiNode, ValueProxyNode, WordCastNode, XorNode, ZeroExtendNode

public interface Canonicalizable
extends CanonicalizableMarker

Nodes can implement Canonicalizable or one of the two sub-interfaces Canonicalizable.Unary and Canonicalizable.Binary to provide local optimizations like constant folding and strength reduction. Implementations should return a replacement that is always semantically correct for the given inputs, or "this" if they do not see an opportunity for improvement.

Implementations of Canonicalizable.canonical(CanonicalizerTool) or the equivalent methods of the two sub-interfaces must not have any side effects.
They are not allowed to change inputs, successors or properties of any node (including the current one) and they also cannot add new nodes to the graph.

In addition to pre-existing nodes they can return newly created nodes, which will be added to the graph automatically if (and only if) the effects of the canonicalization are committed. Non-cyclic graphs (DAGs) of newly created nodes (i.e., one newly created node with an input to another newly created node) will be handled correctly.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Canonicalizable.Binary<T extends Node> This sub-interface of Canonicalizable is intended for nodes that have exactly two inputs.
static interface	Canonicalizable.BinaryCommutative<T extends Node> This sub-interface of Canonicalizable.Binary is for nodes with two inputs where the operation is commutative.
static interface	Canonicalizable.Ternary<T extends Node> This sub-interface of Canonicalizable is intended for nodes that have exactly three inputs.
static interface	Canonicalizable.Unary<T extends Node> This sub-interface of Canonicalizable is intended for nodes that have exactly one input.

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.

Method Detail

canonical

Node canonical(CanonicalizerTool tool)

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.

Parameters:

tool - provides access to runtime interfaces like MetaAccessProvider