org.graalvm.compiler.nodes.calc

Class BinaryArithmeticNode<OP>

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.calc.FloatingNode

org.graalvm.compiler.nodes.calc.BinaryNode

org.graalvm.compiler.nodes.calc.BinaryArithmeticNode<OP>

All Implemented Interfaces:

Cloneable, Formattable, Node.IndirectCanonicalization, Node.ValueNumberable, CanonicalizableMarker, ArithmeticOperation, ArithmeticLIRLowerable, Canonicalizable, Canonicalizable.Binary<ValueNode>, LIRLowerable, ValueNodeInterface

Direct Known Subclasses:

AddNode, AndNode, FloatDivNode, FloatingIntegerDivRemNode, IntegerMulHighNode, MinMaxNode, MulNode, OrNode, RemNode, SubNode, UnsignedMulHighNode, XorNode

public abstract class BinaryArithmeticNode<OP>
extends BinaryNode
implements ArithmeticOperation, ArithmeticLIRLowerable, Canonicalizable.Binary<ValueNode>

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 NodeClass<BinaryArithmeticNode>	TYPE

Fields inherited from class org.graalvm.compiler.nodes.calc.BinaryNode

x, y

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

Modifier	Constructor and Description
protected	BinaryArithmeticNode(NodeClass<? extends BinaryArithmeticNode<OP>> c, ArithmeticOpTable.BinaryOp<OP> opForStampComputation, ValueNode x, ValueNode y)
protected	BinaryArithmeticNode(NodeClass<? extends BinaryArithmeticNode<OP>> c, Stamp stamp, ValueNode x, ValueNode y)

Method Summary

Modifier and Type	Method and Description
static ValueNode	add(StructuredGraph graph, ValueNode v1, ValueNode v2, NodeView view)
static ValueNode	add(ValueNode v1, ValueNode v2)
static ValueNode	add(ValueNode v1, ValueNode v2, NodeView view)
static ValueNode	branchlessMax(ValueNode v1, ValueNode v2, NodeView view)
static ValueNode	branchlessMin(ValueNode v1, ValueNode v2, NodeView view)
ValueNode	canonical(CanonicalizerTool tool, ValueNode forX, ValueNode 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.
Stamp	foldStamp(Stamp stampX, Stamp stampY) Compute an improved for this node using the passed in stamps.
ArithmeticOpTable.BinaryOp<OP>	getArithmeticOp()
static ArithmeticOpTable	getArithmeticOpTable(ValueNode forValue)
protected abstract ArithmeticOpTable.BinaryOp<OP>	getOp(ArithmeticOpTable table)
protected ArithmeticOpTable.BinaryOp<OP>	getOp(ValueNode forX, ValueNode forY)
boolean	isAssociative()
BinaryNode	maybeCommuteInputs() Ensure a canonical ordering of inputs for commutative nodes to improve GVN results.
static ValueNode	mul(StructuredGraph graph, ValueNode v1, ValueNode v2, NodeView view)
static ValueNode	mul(ValueNode v1, ValueNode v2)
static ValueNode	mul(ValueNode v1, ValueNode v2, NodeView view)
static ValueNode	reassociateMatchedValues(BinaryArithmeticNode<?> node, NodePredicate criterion, ValueNode forX, ValueNode forY, NodeView view) Tries to re-associate values which satisfy the criterion.
static ValueNode	reassociateUnmatchedValues(BinaryArithmeticNode<?> node, NodePredicate criterion, NodeView view) Tries to push down values which satisfy the criterion.
protected boolean	shouldSwapInputs(NodeValueMap nodeValueMap) Determines if it would be better to swap the inputs in order to produce better assembly code.
static ValueNode	sub(StructuredGraph graph, ValueNode v1, ValueNode v2, NodeView view)
static ValueNode	sub(ValueNode v1, ValueNode v2)
static ValueNode	sub(ValueNode v1, ValueNode v2, NodeView view)
static <OP> ConstantNode	tryConstantFold(ArithmeticOpTable.BinaryOp<OP> op, ValueNode forX, ValueNode forY, Stamp stamp, NodeView view)

Methods inherited from class org.graalvm.compiler.nodes.calc.BinaryNode

getX, getY, inferStamp, setX, setY

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

asConstant, asJavaConstant, asNode, asSerializableConstant, checkReplaceAtUsagesInvariants, getStackKind, graph, hasUsagesOtherThan, 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.spi.ArithmeticLIRLowerable

generate, generate

Methods inherited from interface org.graalvm.compiler.nodes.spi.Canonicalizable.Binary

canonical, getX, getY

Field Detail

TYPE

public static final NodeClass<BinaryArithmeticNode> TYPE

Constructor Detail

BinaryArithmeticNode

protected BinaryArithmeticNode(NodeClass<? extends BinaryArithmeticNode<OP>> c,
                               ArithmeticOpTable.BinaryOp<OP> opForStampComputation,
                               ValueNode x,
                               ValueNode y)

BinaryArithmeticNode

protected BinaryArithmeticNode(NodeClass<? extends BinaryArithmeticNode<OP>> c,
                               Stamp stamp,
                               ValueNode x,
                               ValueNode y)

Method Detail

getArithmeticOpTable

public static ArithmeticOpTable getArithmeticOpTable(ValueNode forValue)

getOp

protected abstract ArithmeticOpTable.BinaryOp<OP> getOp(ArithmeticOpTable table)

getOp

protected final ArithmeticOpTable.BinaryOp<OP> getOp(ValueNode forX,
                                                     ValueNode forY)

getArithmeticOp

public final ArithmeticOpTable.BinaryOp<OP> getArithmeticOp()

Specified by:

getArithmeticOp in interface ArithmeticOperation

isAssociative

public boolean isAssociative()

canonical

public ValueNode canonical(CanonicalizerTool tool,
                           ValueNode forX,
                           ValueNode forY)

Description copied from interface: Canonicalizable.Binary

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.

Specified by:

canonical in interface Canonicalizable.Binary<ValueNode>

tryConstantFold

public static <OP> ConstantNode tryConstantFold(ArithmeticOpTable.BinaryOp<OP> op,
                                                ValueNode forX,
                                                ValueNode forY,
                                                Stamp stamp,
                                                NodeView view)

foldStamp

public Stamp foldStamp(Stamp stampX,
                       Stamp stampY)

Description copied from class: BinaryNode

Compute an improved for this node using the passed in stamps. The stamps must be compatible with the current values of BinaryNode.x and BinaryNode.y. This code is used to provide the default implementation of BinaryNode.inferStamp() and may be used by external optimizations.

Specified by:

foldStamp in class BinaryNode

add

public static ValueNode add(StructuredGraph graph,
                            ValueNode v1,
                            ValueNode v2,
                            NodeView view)

add

public static ValueNode add(ValueNode v1,
                            ValueNode v2,
                            NodeView view)

add

public static ValueNode add(ValueNode v1,
                            ValueNode v2)

mul

public static ValueNode mul(StructuredGraph graph,
                            ValueNode v1,
                            ValueNode v2,
                            NodeView view)

mul

public static ValueNode mul(ValueNode v1,
                            ValueNode v2,
                            NodeView view)

mul

public static ValueNode mul(ValueNode v1,
                            ValueNode v2)

sub

public static ValueNode sub(StructuredGraph graph,
                            ValueNode v1,
                            ValueNode v2,
                            NodeView view)

sub

public static ValueNode sub(ValueNode v1,
                            ValueNode v2,
                            NodeView view)

sub

public static ValueNode sub(ValueNode v1,
                            ValueNode v2)

branchlessMin

public static ValueNode branchlessMin(ValueNode v1,
                                      ValueNode v2,
                                      NodeView view)

branchlessMax

public static ValueNode branchlessMax(ValueNode v1,
                                      ValueNode v2,
                                      NodeView view)

reassociateUnmatchedValues

public static ValueNode reassociateUnmatchedValues(BinaryArithmeticNode<?> node,
                                                   NodePredicate criterion,
                                                   NodeView view)

Tries to push down values which satisfy the criterion. This is an assistant function for BinaryArithmeticNode.reassociateMatchedValues(org.graalvm.compiler.nodes.calc.BinaryArithmeticNode<?>, org.graalvm.compiler.graph.iterators.NodePredicate, org.graalvm.compiler.nodes.ValueNode, org.graalvm.compiler.nodes.ValueNode, org.graalvm.compiler.nodes.NodeView) reassociateMatchedValues}. For example with a constantness criterion: (a * 2) * b => (a * b) * 2 This method accepts only associative operations such as +, -, *, &, | and ^

reassociateMatchedValues

public static ValueNode reassociateMatchedValues(BinaryArithmeticNode<?> node,
                                                 NodePredicate criterion,
                                                 ValueNode forX,
                                                 ValueNode forY,
                                                 NodeView view)

Tries to re-associate values which satisfy the criterion. For example with a constantness criterion: (a + 2) + 1 => a + (1 + 2)

This method accepts only associative operations such as +, -, *, &, |, ^, min, max

Parameters:

forY -

forX -

maybeCommuteInputs

public BinaryNode maybeCommuteInputs()

Ensure a canonical ordering of inputs for commutative nodes to improve GVN results. Order the inputs by increasing Node.id and call Graph.findDuplicate(Node) on the node if it's currently in a graph. It's assumed that if there was a constant on the left it's been moved to the right by other code and that ordering is left alone.

Returns:

the original node or another node with the same input ordering

shouldSwapInputs

protected boolean shouldSwapInputs(NodeValueMap nodeValueMap)

Determines if it would be better to swap the inputs in order to produce better assembly code. First we try to pick a value which is dead after this use. If both values are dead at this use then we try pick an induction variable phi to encourage the phi to live in a single register.

Parameters:

nodeValueMap -

Returns:

true if inputs should be swapped, false otherwise