org.graalvm.compiler.nodes.memory

Class ReadNode

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.nodes.DeoptimizingFixedWithNextNode

org.graalvm.compiler.nodes.ImplicitNullCheckNode

org.graalvm.compiler.nodes.memory.FixedAccessNode

org.graalvm.compiler.nodes.memory.FloatableAccessNode

org.graalvm.compiler.nodes.memory.ReadNode

All Implemented Interfaces:

Cloneable, Formattable, IterableNodeType, MemoryKillMarker, CanonicalizableMarker, DeoptimizingNode, DeoptimizingNode.DeoptBefore, GuardedNode, GuardingNode, FixedNodeInterface, FixedWithNextNodeInterface, AddressableMemoryAccess, GuardedMemoryAccess, LIRLowerableAccess, MemoryAccess, MemoryKill, OnHeapMemoryAccess, OrderedMemoryAccess, SingleMemoryKill, Canonicalizable, LIRLowerable, NodeWithState, Virtualizable, ValueNodeInterface

Direct Known Subclasses:

AArch64ReadNode, OrderedReadNode

public class ReadNode
extends FloatableAccessNode
implements LIRLowerableAccess, Canonicalizable, Virtualizable, GuardingNode, OrderedMemoryAccess, SingleMemoryKill

Reads an accessed value.

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>

Nested classes/interfaces inherited from interface org.graalvm.compiler.nodes.memory.MemoryKill

MemoryKill.NoLocation

Nested classes/interfaces inherited from interface org.graalvm.compiler.nodes.memory.OnHeapMemoryAccess

OnHeapMemoryAccess.BarrierType

Nested classes/interfaces inherited from interface org.graalvm.compiler.nodes.DeoptimizingNode

DeoptimizingNode.DeoptAfter, DeoptimizingNode.DeoptBefore, DeoptimizingNode.DeoptDuring

Field Summary

Fields

Modifier and Type	Field and Description
static NodeClass<ReadNode>	TYPE

Fields inherited from class org.graalvm.compiler.nodes.memory.FloatableAccessNode

forceFixed

Fields inherited from class org.graalvm.compiler.nodes.memory.FixedAccessNode

barrierType, guard, location, usedAsNullCheck

Fields inherited from class org.graalvm.compiler.nodes.ImplicitNullCheckNode

deoptReasonAndAction, deoptSpeculation

Fields inherited from class org.graalvm.compiler.nodes.DeoptimizingFixedWithNextNode

stateBefore

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

Fields inherited from interface org.graalvm.compiler.nodes.memory.MemoryKill

MULTI_KILL_NO_LOCATION, NO_LOCATION

Constructor Summary

Constructors

Modifier	Constructor and Description
	ReadNode(AddressNode address, org.graalvm.word.LocationIdentity location, Stamp stamp, OnHeapMemoryAccess.BarrierType barrierType)
protected	ReadNode(NodeClass<? extends ReadNode> c, AddressNode address, org.graalvm.word.LocationIdentity location, Stamp stamp, GuardingNode guard, OnHeapMemoryAccess.BarrierType barrierType, boolean nullCheck, FrameState stateBefore)

Method Summary

Modifier and Type	Method and Description
FloatingAccessNode	asFloatingNode()
boolean	canNullCheck() Determines if the memory touch operation represented by this node can use OS level semantics for representing the null check of the memory location with an operating system level trap.
Node	canonical(CanonicalizerTool tool) Implementations of this method can provide local optimizations like constant folding and strength reduction.
static ValueNode	canonicalizeRead(ValueNode read, AddressNode address, org.graalvm.word.LocationIdentity locationIdentity, CanonicalizerTool tool)
static ValueNode	canonicalizeRead(ValueNode read, AddressNode address, org.graalvm.word.LocationIdentity locationIdentity, CoreProviders tool, NodeView view)
static ValueNode	canonicalizeRead(ValueNode read, CanonicalizerTool tool, JavaKind accessKind, ValueNode object, ValueNode offset, org.graalvm.word.LocationIdentity locationIdentity)
void	generate(NodeLIRBuilderTool gen)
Stamp	getAccessStamp(NodeView view)
org.graalvm.word.LocationIdentity	getKilledLocationIdentity() This method is used to determine which memory location is killed by this node.
MemoryOrderMode	getMemoryOrder() Retrieves the node's required memory ordering.
boolean	isAllowedUsageType(InputType type)
void	virtualize(VirtualizerTool tool) A node class can implement this method to convey information about what its effect would be if some of its inputs were virtualized.

Methods inherited from class org.graalvm.compiler.nodes.memory.FloatableAccessNode

canFloat, setForceFixed

Methods inherited from class org.graalvm.compiler.nodes.memory.FixedAccessNode

canDeoptimize, getAddress, getBarrierType, getGuard, getLastLocationAccess, getLocationIdentity, getUsedAsNullCheck, setAddress, setGuard, setLastLocationAccess, setUsedAsNullCheck

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

getDeoptReasonAndAction, getDeoptSpeculation, setImplicitDeoptimization

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

setStateBefore, stateBefore

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, 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.memory.AddressableMemoryAccess

getAddress, setAddress

Methods inherited from interface org.graalvm.compiler.nodes.memory.MemoryAccess

getLastLocationAccess, getLocationIdentity, setLastLocationAccess

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

asNode

Methods inherited from interface org.graalvm.compiler.nodes.memory.OrderedMemoryAccess

ordersMemoryAccesses

Methods inherited from interface org.graalvm.compiler.nodes.memory.MemoryKill

asMultiMemoryKill, asSingleMemoryKill, isMemoryKill, isMultiMemoryKill, isSingleMemoryKill

Methods inherited from interface org.graalvm.compiler.nodes.DeoptimizingNode.DeoptBefore

canUseAsStateDuring

Methods inherited from interface org.graalvm.compiler.nodes.spi.NodeWithState

states

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

asFixedNode

Field Detail

TYPE

public static final NodeClass<ReadNode> TYPE

Constructor Detail

ReadNode

public ReadNode(AddressNode address,
                org.graalvm.word.LocationIdentity location,
                Stamp stamp,
                OnHeapMemoryAccess.BarrierType barrierType)

ReadNode

protected ReadNode(NodeClass<? extends ReadNode> c,
                   AddressNode address,
                   org.graalvm.word.LocationIdentity location,
                   Stamp stamp,
                   GuardingNode guard,
                   OnHeapMemoryAccess.BarrierType barrierType,
                   boolean nullCheck,
                   FrameState stateBefore)

Method Detail

generate

public void generate(NodeLIRBuilderTool gen)

Specified by:

generate in interface LIRLowerable

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

getKilledLocationIdentity

public org.graalvm.word.LocationIdentity getKilledLocationIdentity()

Description copied from interface: SingleMemoryKill

This method is used to determine which memory location is killed by this node. Returning the special value LocationIdentity.any() will kill all memory locations.

Specified by:

getKilledLocationIdentity in interface SingleMemoryKill

Returns:

the identity of the location killed by this node.

asFloatingNode

public FloatingAccessNode asFloatingNode()

Specified by:

asFloatingNode in class FloatableAccessNode

isAllowedUsageType

public boolean isAllowedUsageType(InputType type)

Overrides:

isAllowedUsageType in class ValueNode

canonicalizeRead

public static ValueNode canonicalizeRead(ValueNode read,
                                         AddressNode address,
                                         org.graalvm.word.LocationIdentity locationIdentity,
                                         CanonicalizerTool tool)

canonicalizeRead

public static ValueNode canonicalizeRead(ValueNode read,
                                         AddressNode address,
                                         org.graalvm.word.LocationIdentity locationIdentity,
                                         CoreProviders tool,
                                         NodeView view)

canonicalizeRead

public static ValueNode canonicalizeRead(ValueNode read,
                                         CanonicalizerTool tool,
                                         JavaKind accessKind,
                                         ValueNode object,
                                         ValueNode offset,
                                         org.graalvm.word.LocationIdentity locationIdentity)

virtualize

public void virtualize(VirtualizerTool tool)

Description copied from interface: Virtualizable

A node class can implement this method to convey information about what its effect would be if some of its inputs were virtualized. All modifications must be made through the supplied tool, and not directly on the node, because by the time this method is called the virtualized/non-virtualized state is still speculative and might not hold because of loops, etc.

Specified by:

virtualize in interface Virtualizable

Parameters:

tool - the tool used to describe the effects of this node

canNullCheck

public boolean canNullCheck()

Description copied from interface: AddressableMemoryAccess

Determines if the memory touch operation represented by this node can use OS level semantics for representing the null check of the memory location with an operating system level trap.

Specified by:

canNullCheck in interface AddressableMemoryAccess

getAccessStamp

public Stamp getAccessStamp(NodeView view)

Specified by:

getAccessStamp in interface LIRLowerableAccess

getMemoryOrder

public MemoryOrderMode getMemoryOrder()

Description copied from interface: OrderedMemoryAccess

Retrieves the node's required memory ordering.

Specified by:

getMemoryOrder in interface OrderedMemoryAccess