org.graalvm.compiler.replacements

Class ArrayIndexOfNode

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

All Implemented Interfaces:

Cloneable, Formattable, CanonicalizableMarker, FixedNodeInterface, FixedWithNextNodeInterface, MemoryAccess, Canonicalizable, LIRLowerable, ValueNodeInterface

public class ArrayIndexOfNode
extends FixedWithNextNode
implements Canonicalizable, LIRLowerable, MemoryAccess

Stub-call node for various indexOf-operations. Parameters:

• arrayPointer: pointer to a java array or native memory location.
• arrayOffset: byte offset to be added to the array pointer. If arrayKind is JavaKind.Void, this offset must include the array base offset!
• arrayLength: array length respective to the element size given by stride.
• fromIndex: start index of the indexOf search, respective to the element size given by stride.
• searchValues: between 1-4 int values to be searched. These values are ALWAYS expected to be INT (4 bytes), if the stride is smaller, they should be zero-extended!

The boolean parameters findTwoConsecutive and withMask determine the search algorithm:

• If both are false, the operation finds the index of the first occurrence of any of the 1-4 searchValues.
• If findTwoConsecutive is true and withMask is false, the number of search values must be two. The operation will then search for the first occurrence of both values in succession.
• If withMask is true and findTwoConsecutive is false, the number of search values must be two. The operation will then search for the first index i where (array[i] | searchValues[1]) == searchValues[0].
• If findTwoConsecutive is true and withMask is true, the number of search values must be four. The operation will then search for the first index i where (array[i] | searchValues[2]) == searchValues[0] && (array[i + 1] | searchValues[3]) == searchValues[1].

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<ArrayIndexOfNode>	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

Constructor and Description
ArrayIndexOfNode(JavaKind arrayKind, JavaKind stride, boolean findTwoConsecutive, boolean withMask, org.graalvm.word.LocationIdentity locationIdentity, ValueNode arrayPointer, ValueNode arrayOffset, ValueNode arrayLength, ValueNode fromIndex, ValueNode... searchValues)
ArrayIndexOfNode(JavaKind arrayKind, JavaKind stride, boolean findTwoConsecutive, boolean withMask, ValueNode arrayPointer, ValueNode arrayOffset, ValueNode arrayLength, ValueNode fromIndex, ValueNode... searchValues)
ArrayIndexOfNode(NodeClass<? extends ArrayIndexOfNode> c, JavaKind arrayKind, JavaKind stride, boolean findTwoConsecutive, boolean withMask, org.graalvm.word.LocationIdentity locationIdentity, ValueNode arrayPointer, ValueNode arrayOffset, ValueNode arrayLength, ValueNode fromIndex, ValueNode... searchValues)

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.
void	generate(NodeLIRBuilderTool gen)
protected int	getArrayBaseOffset(MetaAccessProvider metaAccessProvider, ValueNode array, JavaKind kind)
JavaKind	getArrayKind()
ValueNode	getArrayLength()
ValueNode	getArrayOffset()
ValueNode	getArrayPointer()
ValueNode	getFromIndex()
MemoryKill	getLastLocationAccess()
org.graalvm.word.LocationIdentity	getLocationIdentity()
int	getNumberOfValues()
NodeInputList<ValueNode>	getSearchValues()
JavaKind	getStride()
static int	indexOf(JavaKind arrayKind, JavaKind stride, Object array, long arrayOffset, int arrayLength, int fromIndex, int v1)
static int	indexOf2Consecutive(JavaKind arrayKind, JavaKind stride, Object array, long arrayOffset, int arrayLength, int fromIndex, int v1, int v2)
boolean	isFindTwoConsecutive()
boolean	isWithMask()
static int	optimizedArrayIndexOf(JavaKind arrayKind, JavaKind valueKind, boolean findTwoConsecutive, boolean withMask, Object array, long arrayOffset, int arrayLength, int fromIndex, int v1)
static int	optimizedArrayIndexOf(JavaKind arrayKind, JavaKind valueKind, boolean findTwoConsecutive, boolean withMask, Object array, long arrayOffset, int arrayLength, int fromIndex, int v1, int v2)
static int	optimizedArrayIndexOf(JavaKind arrayKind, JavaKind valueKind, boolean findTwoConsecutive, boolean withMask, Object array, long arrayOffset, int arrayLength, int fromIndex, int v1, int v2, int v3)
static int	optimizedArrayIndexOf(JavaKind arrayKind, JavaKind valueKind, boolean findTwoConsecutive, boolean withMask, Object array, long arrayOffset, int arrayLength, int fromIndex, int v1, int v2, int v3, int v4)
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<ArrayIndexOfNode> TYPE

Constructor Detail

ArrayIndexOfNode

public ArrayIndexOfNode(JavaKind arrayKind,
                        JavaKind stride,
                        boolean findTwoConsecutive,
                        boolean withMask,
                        ValueNode arrayPointer,
                        ValueNode arrayOffset,
                        ValueNode arrayLength,
                        ValueNode fromIndex,
                        ValueNode... searchValues)

ArrayIndexOfNode

public ArrayIndexOfNode(JavaKind arrayKind,
                        JavaKind stride,
                        boolean findTwoConsecutive,
                        boolean withMask,
                        org.graalvm.word.LocationIdentity locationIdentity,
                        ValueNode arrayPointer,
                        ValueNode arrayOffset,
                        ValueNode arrayLength,
                        ValueNode fromIndex,
                        ValueNode... searchValues)

ArrayIndexOfNode

public ArrayIndexOfNode(NodeClass<? extends ArrayIndexOfNode> c,
                        JavaKind arrayKind,
                        JavaKind stride,
                        boolean findTwoConsecutive,
                        boolean withMask,
                        org.graalvm.word.LocationIdentity locationIdentity,
                        ValueNode arrayPointer,
                        ValueNode arrayOffset,
                        ValueNode arrayLength,
                        ValueNode fromIndex,
                        ValueNode... searchValues)

Method Detail

getArrayKind

public JavaKind getArrayKind()

isFindTwoConsecutive

public boolean isFindTwoConsecutive()

isWithMask

public boolean isWithMask()

getArrayPointer

public ValueNode getArrayPointer()

getArrayOffset

public ValueNode getArrayOffset()

getArrayLength

public ValueNode getArrayLength()

getFromIndex

public ValueNode getFromIndex()

getSearchValues

public NodeInputList<ValueNode> getSearchValues()

getNumberOfValues

public int getNumberOfValues()

getStride

public JavaKind getStride()

generate

public void generate(NodeLIRBuilderTool gen)

Specified by:

generate in interface LIRLowerable

getArrayBaseOffset

protected int getArrayBaseOffset(MetaAccessProvider metaAccessProvider,
                                 ValueNode array,
                                 JavaKind kind)

getLocationIdentity

public org.graalvm.word.LocationIdentity getLocationIdentity()

Specified by:

getLocationIdentity in interface MemoryAccess

canonical

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

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

optimizedArrayIndexOf

public static int optimizedArrayIndexOf(JavaKind arrayKind,
                                        JavaKind valueKind,
                                        boolean findTwoConsecutive,
                                        boolean withMask,
                                        Object array,
                                        long arrayOffset,
                                        int arrayLength,
                                        int fromIndex,
                                        int v1)

optimizedArrayIndexOf

public static int optimizedArrayIndexOf(JavaKind arrayKind,
                                        JavaKind valueKind,
                                        boolean findTwoConsecutive,
                                        boolean withMask,
                                        Object array,
                                        long arrayOffset,
                                        int arrayLength,
                                        int fromIndex,
                                        int v1,
                                        int v2)

optimizedArrayIndexOf

public static int optimizedArrayIndexOf(JavaKind arrayKind,
                                        JavaKind valueKind,
                                        boolean findTwoConsecutive,
                                        boolean withMask,
                                        Object array,
                                        long arrayOffset,
                                        int arrayLength,
                                        int fromIndex,
                                        int v1,
                                        int v2,
                                        int v3)

optimizedArrayIndexOf

public static int optimizedArrayIndexOf(JavaKind arrayKind,
                                        JavaKind valueKind,
                                        boolean findTwoConsecutive,
                                        boolean withMask,
                                        Object array,
                                        long arrayOffset,
                                        int arrayLength,
                                        int fromIndex,
                                        int v1,
                                        int v2,
                                        int v3,
                                        int v4)

indexOf

public static int indexOf(JavaKind arrayKind,
                          JavaKind stride,
                          Object array,
                          long arrayOffset,
                          int arrayLength,
                          int fromIndex,
                          int v1)

indexOf2Consecutive

public static int indexOf2Consecutive(JavaKind arrayKind,
                                      JavaKind stride,
                                      Object array,
                                      long arrayOffset,
                                      int arrayLength,
                                      int fromIndex,
                                      int v1,
                                      int v2)