org.graalvm.compiler.word

Class WordOperationPlugin

java.lang.Object

org.graalvm.compiler.word.WordOperationPlugin

All Implemented Interfaces:

GraphBuilderPlugin, InlineInvokePlugin, NodePlugin, TypePlugin

Direct Known Subclasses:

HotSpotWordOperationPlugin

public class WordOperationPlugin
extends Object
implements NodePlugin, TypePlugin, InlineInvokePlugin

A plugin for calls to word operations, as well as all other nodes that need special handling for Word types.

Nested Class Summary

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

InlineInvokePlugin.InlineInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected SnippetReflectionProvider	snippetReflection
protected JavaKind	wordKind
protected WordTypes	wordTypes

Constructor Summary

Constructors

Constructor and Description
WordOperationPlugin(SnippetReflectionProvider snippetReflection, WordTypes wordTypes)

Method Summary

Modifier and Type	Method and Description
boolean	canChangeStackKind(GraphBuilderContext b) If the plugin pushes a value with a different JavaKind than specified by the bytecode, it must override this method and return true.
protected AbstractCompareAndSwapNode	casOp(JavaKind writeKind, JavaKind returnKind, AddressNode address, org.graalvm.word.LocationIdentity location, ValueNode expectedValue, ValueNode newValue)
ValueNode	convert(GraphBuilderContext b, ValueNode value, JavaKind toKind, boolean unsigned)
protected LoadIndexedNode	createLoadIndexedNode(ValueNode array, ValueNode index, GuardingNode boundsCheck)
protected StoreIndexedNode	createStoreIndexedNode(ValueNode array, ValueNode index, GuardingNode boundsCheck, ValueNode value)
ValueNode	fromSigned(GraphBuilderContext b, ValueNode value)
ValueNode	fromUnsigned(GraphBuilderContext b, ValueNode value)
boolean	handleCheckCast(GraphBuilderContext b, ValueNode object, ResolvedJavaType type, JavaTypeProfile profile) Handle the parsing of a CHECKCAST bytecode.
boolean	handleInstanceOf(GraphBuilderContext b, ValueNode object, ResolvedJavaType type, JavaTypeProfile profile) Handle the parsing of a INSTANCEOF bytecode.
boolean	handleInvoke(GraphBuilderContext b, ResolvedJavaMethod method, ValueNode[] args) Processes a call to a method if it is annotated as a word operation by adding nodes to the graph being built that implement the denoted operation.
boolean	handleLoadField(GraphBuilderContext b, ValueNode receiver, ResolvedJavaField field) Handle the parsing of a GETFIELD bytecode.
boolean	handleLoadIndexed(GraphBuilderContext b, ValueNode array, ValueNode index, GuardingNode boundsCheck, JavaKind elementKind) Handle the parsing of an array load bytecode.
boolean	handleLoadStaticField(GraphBuilderContext b, ResolvedJavaField staticField) Handle the parsing of a GETSTATIC bytecode.
boolean	handleStoreField(GraphBuilderContext b, ValueNode object, ResolvedJavaField field, ValueNode value) Handle the parsing of a PUTFIELD bytecode.
boolean	handleStoreIndexed(GraphBuilderContext b, ValueNode array, ValueNode index, GuardingNode boundsCheck, GuardingNode storeCheck, JavaKind elementKind, ValueNode value) Handle the parsing of an array store bytecode.
boolean	handleStoreStaticField(GraphBuilderContext b, ResolvedJavaField field, ValueNode value) Handle the parsing of a PUTSTATIC bytecode.
StampPair	interceptType(GraphBuilderTool b, JavaType declaredType, boolean nonNull) Intercept the type of arguments or return values.
AddressNode	makeAddress(GraphBuilderContext b, ValueNode base, ValueNode offset)
void	notifyNotInlined(GraphBuilderContext b, ResolvedJavaMethod method, Invoke invoke) Notifies this plugin of the Invoke node created for a method that was not inlined per InlineInvokePlugin.shouldInlineInvoke(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.ValueNode[]).
protected void	processWordOperation(GraphBuilderContext b, ValueNode[] args, ResolvedJavaMethod wordMethod)
static ValueNode	readOp(GraphBuilderContext b, JavaKind readKind, AddressNode address, org.graalvm.word.LocationIdentity location, OnHeapMemoryAccess.BarrierType barrierType, boolean compressible)
protected ValueNode	readOp(GraphBuilderContext b, JavaKind readKind, AddressNode address, org.graalvm.word.LocationIdentity location, Word.Opcode op)
protected ValueNode	readVolatileOp(GraphBuilderContext b, JavaKind readKind, AddressNode address, org.graalvm.word.LocationIdentity location, Word.Opcode op)
ValueNode	toUnsigned(GraphBuilderContext b, ValueNode value, JavaKind toKind)
protected void	writeOp(GraphBuilderContext b, JavaKind writeKind, AddressNode address, org.graalvm.word.LocationIdentity location, ValueNode value, Word.Opcode op)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.graalvm.compiler.nodes.graphbuilderconf.NodePlugin

convertInvokeDynamic, handleNewArray, handleNewInstance, handleNewMultiArray, instrumentExceptionDispatch

Methods inherited from interface org.graalvm.compiler.nodes.graphbuilderconf.InlineInvokePlugin

notifyAfterInline, notifyBeforeInline, shouldInlineInvoke

Field Detail

wordTypes

protected final WordTypes wordTypes

wordKind

protected final JavaKind wordKind

snippetReflection

protected final SnippetReflectionProvider snippetReflection

Constructor Detail

WordOperationPlugin

public WordOperationPlugin(SnippetReflectionProvider snippetReflection,
                           WordTypes wordTypes)

Method Detail

canChangeStackKind

public boolean canChangeStackKind(GraphBuilderContext b)

Description copied from interface: NodePlugin

If the plugin pushes a value with a different JavaKind than specified by the bytecode, it must override this method and return true. This disables assertion checking for value kinds.

Specified by:

canChangeStackKind in interface NodePlugin

Parameters:

b - the context

handleInvoke

public boolean handleInvoke(GraphBuilderContext b,
                            ResolvedJavaMethod method,
                            ValueNode[] args)

Processes a call to a method if it is annotated as a word operation by adding nodes to the graph being built that implement the denoted operation.

Specified by:

handleInvoke in interface NodePlugin

Parameters:

b - the context

method - the statically bound, invoked method

args - the arguments of the method invocation

Returns:

true iff method is annotated with Word.Operation (and was thus processed by this method)

interceptType

public StampPair interceptType(GraphBuilderTool b,
                               JavaType declaredType,
                               boolean nonNull)

Description copied from interface: TypePlugin

Intercept the type of arguments or return values.

Specified by:

interceptType in interface TypePlugin

notifyNotInlined

public void notifyNotInlined(GraphBuilderContext b,
                             ResolvedJavaMethod method,
                             Invoke invoke)

Description copied from interface: InlineInvokePlugin

Notifies this plugin of the Invoke node created for a method that was not inlined per InlineInvokePlugin.shouldInlineInvoke(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.ValueNode[]).

Specified by:

notifyNotInlined in interface InlineInvokePlugin

Parameters:

b - the context

method - the method that was not inlined

invoke - the invoke node created for the call to method

handleLoadField

public boolean handleLoadField(GraphBuilderContext b,
                               ValueNode receiver,
                               ResolvedJavaField field)

Description copied from interface: NodePlugin

Handle the parsing of a GETFIELD bytecode. If the method returns true, it must push a value using the kind of the field.

Specified by:

handleLoadField in interface NodePlugin

Parameters:

b - the context

receiver - the receiver object for the field access

field - the accessed field

Returns:

true if the plugin handles the field access, false otherwise

handleLoadStaticField

public boolean handleLoadStaticField(GraphBuilderContext b,
                                     ResolvedJavaField staticField)

Description copied from interface: NodePlugin

Handle the parsing of a GETSTATIC bytecode. If the method returns true, it must push a value using the kind of the field.

Specified by:

handleLoadStaticField in interface NodePlugin

Parameters:

b - the context

staticField - the accessed field

Returns:

true if the plugin handles the field access, false otherwise

handleLoadIndexed

public boolean handleLoadIndexed(GraphBuilderContext b,
                                 ValueNode array,
                                 ValueNode index,
                                 GuardingNode boundsCheck,
                                 JavaKind elementKind)

Description copied from interface: NodePlugin

Handle the parsing of an array load bytecode. If the method returns true, it must push a value using the provided elementKind.

Specified by:

handleLoadIndexed in interface NodePlugin

Parameters:

b - the context

array - the accessed array

index - the index for the array access

boundsCheck - the explicit bounds check already emitted, or null if no bounds check was emitted yet

elementKind - the element kind of the accessed array

Returns:

true if the plugin handles the array access, false otherwise.

createLoadIndexedNode

protected LoadIndexedNode createLoadIndexedNode(ValueNode array,
                                                ValueNode index,
                                                GuardingNode boundsCheck)

handleStoreField

public boolean handleStoreField(GraphBuilderContext b,
                                ValueNode object,
                                ResolvedJavaField field,
                                ValueNode value)

Description copied from interface: NodePlugin

Handle the parsing of a PUTFIELD bytecode.

Specified by:

handleStoreField in interface NodePlugin

Parameters:

b - the context

object - the receiver object for the field access

field - the accessed field

value - the value to be stored into the field

Returns:

true if the plugin handles the field access, false otherwise

handleStoreStaticField

public boolean handleStoreStaticField(GraphBuilderContext b,
                                      ResolvedJavaField field,
                                      ValueNode value)

Description copied from interface: NodePlugin

Handle the parsing of a PUTSTATIC bytecode.

Specified by:

handleStoreStaticField in interface NodePlugin

Parameters:

b - the context

field - the accessed field

value - the value to be stored into the field

Returns:

true if the plugin handles the field access, false otherwise.

handleStoreIndexed

public boolean handleStoreIndexed(GraphBuilderContext b,
                                  ValueNode array,
                                  ValueNode index,
                                  GuardingNode boundsCheck,
                                  GuardingNode storeCheck,
                                  JavaKind elementKind,
                                  ValueNode value)

Description copied from interface: NodePlugin

Handle the parsing of an array store bytecode.

Specified by:

handleStoreIndexed in interface NodePlugin

Parameters:

b - the context

array - the accessed array

index - the index for the array access

boundsCheck - the explicit array bounds check already emitted, or null if no array bounds check was emitted yet

storeCheck - the explicit array store check already emitted, or null if no array store check was emitted yet

elementKind - the element kind of the accessed array

value - the value to be stored into the array

Returns:

true if the plugin handles the array access, false otherwise.

createStoreIndexedNode

protected StoreIndexedNode createStoreIndexedNode(ValueNode array,
                                                  ValueNode index,
                                                  GuardingNode boundsCheck,
                                                  ValueNode value)

handleCheckCast

public boolean handleCheckCast(GraphBuilderContext b,
                               ValueNode object,
                               ResolvedJavaType type,
                               JavaTypeProfile profile)

Description copied from interface: NodePlugin

Handle the parsing of a CHECKCAST bytecode. If the method returns true, it must push a value with the result of the cast using JavaKind.Object.

Specified by:

handleCheckCast in interface NodePlugin

Parameters:

b - the context

object - the object to be type checked

type - the type that the object is checked against

profile - the profiling information for the type check, or null if no profiling information is available

Returns:

true if the plugin handles the cast, false otherwise

handleInstanceOf

public boolean handleInstanceOf(GraphBuilderContext b,
                                ValueNode object,
                                ResolvedJavaType type,
                                JavaTypeProfile profile)

Description copied from interface: NodePlugin

Handle the parsing of a INSTANCEOF bytecode. If the method returns true, it must push a value with the result of the instanceof using JavaKind.Int.

Specified by:

handleInstanceOf in interface NodePlugin

Parameters:

b - the context

object - the object to be type checked

type - the type that the object is checked against

profile - the profiling information for the type check, or null if no profiling information is available

Returns:

true if the plugin handles the instanceof, false otherwise

processWordOperation

protected void processWordOperation(GraphBuilderContext b,
                                    ValueNode[] args,
                                    ResolvedJavaMethod wordMethod)
                             throws GraalError

Throws:

GraalError

readOp

protected ValueNode readOp(GraphBuilderContext b,
                           JavaKind readKind,
                           AddressNode address,
                           org.graalvm.word.LocationIdentity location,
                           Word.Opcode op)

readOp

public static ValueNode readOp(GraphBuilderContext b,
                               JavaKind readKind,
                               AddressNode address,
                               org.graalvm.word.LocationIdentity location,
                               OnHeapMemoryAccess.BarrierType barrierType,
                               boolean compressible)

readVolatileOp

protected ValueNode readVolatileOp(GraphBuilderContext b,
                                   JavaKind readKind,
                                   AddressNode address,
                                   org.graalvm.word.LocationIdentity location,
                                   Word.Opcode op)

writeOp

protected void writeOp(GraphBuilderContext b,
                       JavaKind writeKind,
                       AddressNode address,
                       org.graalvm.word.LocationIdentity location,
                       ValueNode value,
                       Word.Opcode op)

casOp

protected AbstractCompareAndSwapNode casOp(JavaKind writeKind,
                                           JavaKind returnKind,
                                           AddressNode address,
                                           org.graalvm.word.LocationIdentity location,
                                           ValueNode expectedValue,
                                           ValueNode newValue)

makeAddress

public AddressNode makeAddress(GraphBuilderContext b,
                               ValueNode base,
                               ValueNode offset)

fromUnsigned

public ValueNode fromUnsigned(GraphBuilderContext b,
                              ValueNode value)

fromSigned

public ValueNode fromSigned(GraphBuilderContext b,
                            ValueNode value)

toUnsigned

public ValueNode toUnsigned(GraphBuilderContext b,
                            ValueNode value,
                            JavaKind toKind)

convert

public ValueNode convert(GraphBuilderContext b,
                         ValueNode value,
                         JavaKind toKind,
                         boolean unsigned)