org.graalvm.compiler.replacements.nodes

Class ArrayRegionCompareToNode

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

All Implemented Interfaces:

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

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

Lexicographically compares two array regions with a given length. Supported strides are JavaKind.Byte, JavaKind.Char and JavaKind.Int. The first array's stride must be greater or equal to the second array's stride. Array strides are not required to match the respective array's element sizes, e.g. this node can also read char values from byte arrays. If strideA is greater than strideB, elements read from arrayB are zero-extended to match strideA for the comparison. This node differs from ArrayCompareToNode in the following features:

• Support for arbitrary byte offsets into the given arrays
• Support for 32-bit strides
• The length parameter denotes the length of the region to be compared instead of the full array length. The region given by the respective array offset and the region length must be inside the array's bounds.

Returns the result of arrayA[i] - arrayB[i] at the first index i where arrayA[i] != arrayB[i]. If no such index exists, returns 0.

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 (as number of array elements).
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<ArrayRegionCompareToNode>	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	ArrayRegionCompareToNode(NodeClass<? extends ArrayRegionCompareToNode> c, ValueNode arrayA, ValueNode offsetA, ValueNode arrayB, ValueNode offsetB, ValueNode length, ValueNode dynamicStrides, JavaKind strideA, JavaKind strideB, org.graalvm.word.LocationIdentity locationIdentity)
	ArrayRegionCompareToNode(ValueNode arrayA, ValueNode offsetA, ValueNode arrayB, ValueNode offsetB, ValueNode length, JavaKind strideA, JavaKind strideB)
	ArrayRegionCompareToNode(ValueNode arrayA, ValueNode offsetA, ValueNode arrayB, ValueNode offsetB, ValueNode length, JavaKind strideA, JavaKind strideB, org.graalvm.word.LocationIdentity locationIdentity)
	ArrayRegionCompareToNode(ValueNode arrayA, ValueNode offsetA, ValueNode arrayB, ValueNode offsetB, ValueNode length, ValueNode dynamicStrides)
	ArrayRegionCompareToNode(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.
static int	compare(Object arrayA, long offsetA, Object arrayB, long offsetB, int length, int stride)
static int	compare(Object arrayA, long offsetA, Object arrayB, long offsetB, int length, JavaKind strideA, JavaKind strideB)
void	generate(NodeLIRBuilderTool gen)
protected void	generateArrayCompare(NodeLIRBuilderTool gen)
ValueNode	getArrayA()
ValueNode	getArrayB()
int	getArrayBaseOffset(MetaAccessProvider metaAccess, ValueNode array, JavaKind elementKind)
int	getDirectStubCallIndex()
MemoryKill	getLastLocationAccess()
ValueNode	getLength()
org.graalvm.word.LocationIdentity	getLocationIdentity()
ValueNode	getOffsetA()
ValueNode	getOffsetB()
JavaKind	getStrideA()
JavaKind	getStrideB()
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<ArrayRegionCompareToNode> 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 (as number of array elements). The caller is responsible for ensuring that the region, starting at the respective offset, is within array bounds.

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

ArrayRegionCompareToNode

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

ArrayRegionCompareToNode

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

ArrayRegionCompareToNode

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

ArrayRegionCompareToNode

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

ArrayRegionCompareToNode

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

Method Detail

compare

public static int compare(Object arrayA,
                          long offsetA,
                          Object arrayB,
                          long offsetB,
                          int length,
                          JavaKind strideA,
                          JavaKind strideB)

compare

public static int compare(Object arrayA,
                          long offsetA,
                          Object arrayB,
                          long offsetB,
                          int length,
                          int stride)

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()

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

generateArrayCompare

protected void generateArrayCompare(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