org.graalvm.compiler.replacements.nodes

Class ArrayRegionEqualsNode

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.replacements.nodes.ArrayRegionEqualsNode

All Implemented Interfaces:

Cloneable, Formattable, CanonicalizableMarker, FixedNodeInterface, FixedWithNextNodeInterface, MemoryAccess, Canonicalizable, LIRLowerable, ConstantReflectionUtil.ArrayBaseOffsetProvider, ValueNodeInterface

public class ArrayRegionEqualsNode
extends FixedWithNextNode
implements Canonicalizable, LIRLowerable, MemoryAccess, ConstantReflectionUtil.ArrayBaseOffsetProvider

Compares two array regions with a given length. This node can compare regions of arrays of the same primitive element kinds. As a special case, it also supports comparing an array region interpreted as chars with an array region interpreted as bytes, in which case the byte values are zero-extended for the comparison. In this case, the first kind must be char, and the underlying array must be a byte array (this condition is not checked). Other combinations of kinds are currently not allowed.

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
protected ValueNode	arrayA Pointer to the first array object.
protected ValueNode	arrayB Pointer to the second array object.
protected ValueNode	dynamicStrides Optional argument for dispatching to any combination of strides at runtime, as described in StrideUtil.
protected MemoryKill	lastLocationAccess
protected ValueNode	length Length of the array region.
protected org.graalvm.word.LocationIdentity	locationIdentity
protected ValueNode	offsetA Byte offset to be added to the first array pointer.
protected ValueNode	offsetB Byte offset to be added to the second array pointer.
protected JavaKind	strideA JavaKind of the arrays to compare.
protected JavaKind	strideB
static NodeClass<ArrayRegionEqualsNode>	TYPE

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArrayRegionEqualsNode(NodeClass<? extends ArrayRegionEqualsNode> c, ValueNode arrayA, ValueNode offsetA, ValueNode arrayB, ValueNode offsetB, ValueNode length, ValueNode dynamicStrides, JavaKind strideA, JavaKind strideB, org.graalvm.word.LocationIdentity locationIdentity)
	ArrayRegionEqualsNode(ValueNode arrayA, ValueNode offsetA, ValueNode arrayB, ValueNode offsetB, ValueNode length, JavaKind strideA, JavaKind strideB)
	ArrayRegionEqualsNode(ValueNode arrayA, ValueNode offsetA, ValueNode arrayB, ValueNode offsetB, ValueNode length, JavaKind strideA, JavaKind strideB, org.graalvm.word.LocationIdentity locationIdentity)
	ArrayRegionEqualsNode(ValueNode arrayA, ValueNode offsetA, ValueNode arrayB, ValueNode offsetB, ValueNode length, ValueNode dynamicStrides)
	ArrayRegionEqualsNode(ValueNode arrayA, ValueNode offsetA, ValueNode arrayB, ValueNode offsetB, ValueNode length, ValueNode dynamicStrides, org.graalvm.word.LocationIdentity locationIdentity)

Method Summary

Modifier and Type	Method and Description
ValueNode	canonical(CanonicalizerTool tool) Implementations of this method can provide local optimizations like constant folding and strength reduction.
void	generate(NodeLIRBuilderTool gen)
protected void	generateArrayRegionEquals(NodeLIRBuilderTool gen)
ValueNode	getArrayA()
ValueNode	getArrayB()
int	getArrayBaseOffset(MetaAccessProvider metaAccess, ValueNode array, JavaKind elementKind)
int	getDirectStubCallIndex()
ValueNode	getDynamicStrides()
MemoryKill	getLastLocationAccess()
ValueNode	getLength()
org.graalvm.word.LocationIdentity	getLocationIdentity()
ValueNode	getOffsetA()
ValueNode	getOffsetB()
JavaKind	getStrideA()
JavaKind	getStrideB()
static boolean	regionEquals(Object arrayA, long offsetA, Object arrayB, long offsetB, int length, JavaKind kind)
static boolean	regionEquals(Object arrayA, long offsetA, Object arrayB, long offsetB, int length, JavaKind kind1, JavaKind kind2)
void	setLastLocationAccess(MemoryKill lla)

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

asNode

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

asFixedNode

Field Detail

TYPE

public static final NodeClass<ArrayRegionEqualsNode> TYPE

strideA

protected final JavaKind strideA

JavaKind of the arrays to compare.

strideB

protected final JavaKind strideB

locationIdentity

protected final org.graalvm.word.LocationIdentity locationIdentity

arrayA

protected ValueNode arrayA

Pointer to the first array object.

offsetA

protected ValueNode offsetA

Byte offset to be added to the first array pointer. Must include the array's base offset!

arrayB

protected ValueNode arrayB

Pointer to the second array object.

offsetB

protected ValueNode offsetB

Byte offset to be added to the second array pointer. Must include the array's base offset!

length

protected ValueNode length

Length of the array region.

dynamicStrides

protected ValueNode dynamicStrides

Optional argument for dispatching to any combination of strides at runtime, as described in StrideUtil.

lastLocationAccess

protected MemoryKill lastLocationAccess

Constructor Detail

ArrayRegionEqualsNode

public ArrayRegionEqualsNode(ValueNode arrayA,
                             ValueNode offsetA,
                             ValueNode arrayB,
                             ValueNode offsetB,
                             ValueNode length,
                             ValueNode dynamicStrides,
                             org.graalvm.word.LocationIdentity locationIdentity)

ArrayRegionEqualsNode

public ArrayRegionEqualsNode(ValueNode arrayA,
                             ValueNode offsetA,
                             ValueNode arrayB,
                             ValueNode offsetB,
                             ValueNode length,
                             JavaKind strideA,
                             JavaKind strideB)

ArrayRegionEqualsNode

public ArrayRegionEqualsNode(ValueNode arrayA,
                             ValueNode offsetA,
                             ValueNode arrayB,
                             ValueNode offsetB,
                             ValueNode length,
                             JavaKind strideA,
                             JavaKind strideB,
                             org.graalvm.word.LocationIdentity locationIdentity)

ArrayRegionEqualsNode

public ArrayRegionEqualsNode(ValueNode arrayA,
                             ValueNode offsetA,
                             ValueNode arrayB,
                             ValueNode offsetB,
                             ValueNode length,
                             ValueNode dynamicStrides)

ArrayRegionEqualsNode

protected ArrayRegionEqualsNode(NodeClass<? extends ArrayRegionEqualsNode> c,
                                ValueNode arrayA,
                                ValueNode offsetA,
                                ValueNode arrayB,
                                ValueNode offsetB,
                                ValueNode length,
                                ValueNode dynamicStrides,
                                JavaKind strideA,
                                JavaKind strideB,
                                org.graalvm.word.LocationIdentity locationIdentity)

Method Detail

regionEquals

public static boolean regionEquals(Object arrayA,
                                   long offsetA,
                                   Object arrayB,
                                   long offsetB,
                                   int length,
                                   JavaKind kind)

regionEquals

public static boolean regionEquals(Object arrayA,
                                   long offsetA,
                                   Object arrayB,
                                   long offsetB,
                                   int length,
                                   JavaKind kind1,
                                   JavaKind kind2)

getArrayA

public ValueNode getArrayA()

getOffsetA

public ValueNode getOffsetA()

getArrayB

public ValueNode getArrayB()

getOffsetB

public ValueNode getOffsetB()

getStrideA

public JavaKind getStrideA()

getStrideB

public JavaKind getStrideB()

getLength

public ValueNode getLength()

getDynamicStrides

public ValueNode getDynamicStrides()

getDirectStubCallIndex

public int getDirectStubCallIndex()

generate

public void generate(NodeLIRBuilderTool gen)

Specified by:

generate in interface LIRLowerable

getArrayBaseOffset

public int getArrayBaseOffset(MetaAccessProvider metaAccess,
                              ValueNode array,
                              JavaKind elementKind)

Specified by:

getArrayBaseOffset in interface ConstantReflectionUtil.ArrayBaseOffsetProvider

generateArrayRegionEquals

protected void generateArrayRegionEquals(NodeLIRBuilderTool gen)

getLocationIdentity

public org.graalvm.word.LocationIdentity getLocationIdentity()

Specified by:

getLocationIdentity in interface MemoryAccess

getLastLocationAccess

public MemoryKill getLastLocationAccess()

Specified by:

getLastLocationAccess in interface MemoryAccess

Returns:

a MemoryKill that represents the last memory state in the memory graph for the LocationIdentity returned by MemoryAccess.getLocationIdentity()

setLastLocationAccess

public void setLastLocationAccess(MemoryKill lla)

Specified by:

setLastLocationAccess in interface MemoryAccess

Parameters:

lla - the MemoryKill that represents the last kill of the LocationIdentity returned by MemoryAccess.getLocationIdentity()

canonical

public ValueNode 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