org.graalvm.compiler.nodes.virtual

Class VirtualObjectNode

java.lang.Object

org.graalvm.compiler.graph.Node

org.graalvm.compiler.nodes.ValueNode

org.graalvm.compiler.nodes.virtual.VirtualObjectNode

All Implemented Interfaces:

Cloneable, Formattable, IterableNodeType, LIRLowerable, ValueNodeInterface

Direct Known Subclasses:

VirtualArrayNode, VirtualInstanceNode

public abstract class VirtualObjectNode
extends ValueNode
implements LIRLowerable, IterableNodeType

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

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hasIdentity
static NodeClass<VirtualObjectNode>	TYPE

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	VirtualObjectNode(NodeClass<? extends VirtualObjectNode> c, ResolvedJavaType type, boolean hasIdentity)

Method Summary

Modifier and Type	Method and Description
protected void	afterClone(Node other)
boolean	canVirtualizeLargeByteArrayUnsafeRead(ValueNode entry, int index, JavaKind accessKind, VirtualizerTool tool) Checks that a read in a virtual object is a candidate for byte array virtualization.
abstract VirtualObjectNode	duplicate() Returns an exact duplicate of this virtual object node, which has not been added to the graph yet.
abstract int	entryCount() The number of entries this virtual object has.
abstract int	entryIndexForOffset(MetaAccessProvider metaAccess, long constantOffset, JavaKind expectedEntryKind) If the given index denotes an entry in this virtual object, the index of this entry is returned.
abstract JavaKind	entryKind(MetaAccessExtensionProvider metaAccessExtensionProvider, int index) Returns the JavaKind of the entry at the given index.
abstract String	entryName(int i) Returns the name of the entry at the given index.
void	generate(NodeLIRBuilderTool gen)
abstract ValueNode	getMaterializedRepresentation(FixedNode fixed, ValueNode[] entries, LockState locks) Returns a node that can be used to materialize this virtual object.
int	getObjectId()
boolean	hasIdentity() Specifies whether this virtual object has an object identity.
boolean	isVirtualByteArray(MetaAccessExtensionProvider metaAccessExtensionProvider)
boolean	isVirtualByteArrayAccess(MetaAccessExtensionProvider metaAccessExtensionProvider, JavaKind accessKind)
void	resetObjectId()
void	setIdentity(boolean identity)
void	setObjectId(int objectId)
abstract ResolvedJavaType	type() The type of object described by this VirtualObjectNode.

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

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

Field Detail

TYPE

public static final NodeClass<VirtualObjectNode> TYPE

hasIdentity

protected boolean hasIdentity

Constructor Detail

VirtualObjectNode

protected VirtualObjectNode(NodeClass<? extends VirtualObjectNode> c,
                            ResolvedJavaType type,
                            boolean hasIdentity)

Method Detail

getObjectId

public final int getObjectId()

resetObjectId

public final void resetObjectId()

setObjectId

public final void setObjectId(int objectId)

afterClone

protected void afterClone(Node other)

Overrides:

afterClone in class Node

type

public abstract ResolvedJavaType type()

The type of object described by this VirtualObjectNode. In case of arrays, this is the array type (and not the component type).

entryCount

public abstract int entryCount()

The number of entries this virtual object has. Either the number of fields or the number of array elements.

entryName

public abstract String entryName(int i)

Returns the name of the entry at the given index. Only used for debugging purposes.

entryIndexForOffset

public abstract int entryIndexForOffset(MetaAccessProvider metaAccess,
                                        long constantOffset,
                                        JavaKind expectedEntryKind)

If the given index denotes an entry in this virtual object, the index of this entry is returned. If no such entry can be found, this method returns -1.

Parameters:

constantOffset - offset, where the value is placed.

expectedEntryKind - Specifies which type is expected at this offset (Is important when

entryKind

public abstract JavaKind entryKind(MetaAccessExtensionProvider metaAccessExtensionProvider,
                                   int index)

Returns the JavaKind of the entry at the given index.

duplicate

public abstract VirtualObjectNode duplicate()

Returns an exact duplicate of this virtual object node, which has not been added to the graph yet.

hasIdentity

public boolean hasIdentity()

Specifies whether this virtual object has an object identity. If not, then the result of a comparison of two virtual objects is determined by comparing their contents.

setIdentity

public void setIdentity(boolean identity)

getMaterializedRepresentation

public abstract ValueNode getMaterializedRepresentation(FixedNode fixed,
                                                        ValueNode[] entries,
                                                        LockState locks)

Returns a node that can be used to materialize this virtual object. If this returns an AllocatedObjectNode then this node will be attached to a CommitAllocationNode , otherwise the node will just be added to the graph.

generate

public void generate(NodeLIRBuilderTool gen)

Specified by:

generate in interface LIRLowerable

canVirtualizeLargeByteArrayUnsafeRead

public boolean canVirtualizeLargeByteArrayUnsafeRead(ValueNode entry,
                                                     int index,
                                                     JavaKind accessKind,
                                                     VirtualizerTool tool)

Checks that a read in a virtual object is a candidate for byte array virtualization. Virtualizing reads in byte arrays can happen iff all of these hold true:

The virtualized object is a virtualized byte array Both the virtualized entry and the access kind are primitives The number of bytes actually occupied by the entry is equal to the number of bytes of the access kind

isVirtualByteArrayAccess

public boolean isVirtualByteArrayAccess(MetaAccessExtensionProvider metaAccessExtensionProvider,
                                        JavaKind accessKind)

isVirtualByteArray

public boolean isVirtualByteArray(MetaAccessExtensionProvider metaAccessExtensionProvider)