org.graalvm.compiler.nodes.graphbuilderconf

Interface NodePlugin

All Superinterfaces:

GraphBuilderPlugin

All Known Implementing Classes:

HotSpotExceptionDispatchPlugin, HotSpotNodePlugin, HotSpotWordOperationPlugin, MethodHandlePlugin, WordOperationPlugin

public interface NodePlugin
extends GraphBuilderPlugin

Method Summary

Modifier and Type	Method and Description
default 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.
default org.graalvm.collections.Pair<ResolvedJavaMethod,ValueNode[]>	convertInvokeDynamic(GraphBuilderContext b, BootstrapMethodIntrospection m) Converts an invoke dynamic (indy) call into a static call that passes the returned arguments.
default boolean	handleCheckCast(GraphBuilderContext b, ValueNode object, ResolvedJavaType type, JavaTypeProfile profile) Handle the parsing of a CHECKCAST bytecode.
default boolean	handleInstanceOf(GraphBuilderContext b, ValueNode object, ResolvedJavaType type, JavaTypeProfile profile) Handle the parsing of a INSTANCEOF bytecode.
default boolean	handleInvoke(GraphBuilderContext b, ResolvedJavaMethod method, ValueNode[] args) Handle the parsing of a method invocation bytecode to a method that can be bound statically.
default boolean	handleLoadField(GraphBuilderContext b, ValueNode object, ResolvedJavaField field) Handle the parsing of a GETFIELD bytecode.
default boolean	handleLoadIndexed(GraphBuilderContext b, ValueNode array, ValueNode index, GuardingNode boundsCheck, JavaKind elementKind) Handle the parsing of an array load bytecode.
default boolean	handleLoadStaticField(GraphBuilderContext b, ResolvedJavaField field) Handle the parsing of a GETSTATIC bytecode.
default boolean	handleNewArray(GraphBuilderContext b, ResolvedJavaType elementType, ValueNode length) Handle the parsing of a NEWARRAY and ANEWARRAY bytecode.
default boolean	handleNewInstance(GraphBuilderContext b, ResolvedJavaType type) Handle the parsing of a NEW bytecode.
default boolean	handleNewMultiArray(GraphBuilderContext b, ResolvedJavaType type, ValueNode[] dimensions) Handle the parsing of a MULTIANEWARRAY bytecode.
default boolean	handleStoreField(GraphBuilderContext b, ValueNode object, ResolvedJavaField field, ValueNode value) Handle the parsing of a PUTFIELD bytecode.
default boolean	handleStoreIndexed(GraphBuilderContext b, ValueNode array, ValueNode index, GuardingNode boundsCheck, GuardingNode storeCheck, JavaKind elementKind, ValueNode value) Handle the parsing of an array store bytecode.
default boolean	handleStoreStaticField(GraphBuilderContext b, ResolvedJavaField field, ValueNode value) Handle the parsing of a PUTSTATIC bytecode.
default FixedWithNextNode	instrumentExceptionDispatch(StructuredGraph graph, FixedWithNextNode afterExceptionLoaded, Supplier<FrameState> frameStateFunction) Allows this plugin to add nodes after the exception object has been loaded in the dispatch sequence.

Method Detail

handleInvoke

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

Handle the parsing of a method invocation bytecode to a method that can be bound statically. If the method returns true, it must push a value as the result of the method invocation using the return kind of the method.

Parameters:

b - the context

method - the statically bound, invoked method

args - the arguments of the method invocation

Returns:

true if the plugin handles the invocation, false otherwise

handleLoadField

default boolean handleLoadField(GraphBuilderContext b,
                                ValueNode object,
                                ResolvedJavaField field)

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

Parameters:

b - the context

object - the receiver object for the field access

field - the accessed field

Returns:

true if the plugin handles the field access, false otherwise

handleLoadStaticField

default boolean handleLoadStaticField(GraphBuilderContext b,
                                      ResolvedJavaField field)

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

Parameters:

b - the context

field - the accessed field

Returns:

true if the plugin handles the field access, false otherwise

handleStoreField

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

Handle the parsing of a PUTFIELD bytecode.

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

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

Handle the parsing of a PUTSTATIC bytecode.

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.

handleLoadIndexed

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

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

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.

handleStoreIndexed

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

Handle the parsing of an array store bytecode.

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.

handleCheckCast

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

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.

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

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

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.

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

handleNewInstance

default boolean handleNewInstance(GraphBuilderContext b,
                                  ResolvedJavaType type)

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

Parameters:

b - the context

type - the type to be instantiated

Returns:

true if the plugin handles the bytecode, false otherwise

handleNewArray

default boolean handleNewArray(GraphBuilderContext b,
                               ResolvedJavaType elementType,
                               ValueNode length)

Handle the parsing of a NEWARRAY and ANEWARRAY bytecode. If the method returns true, it must push a value with the result of the allocation using JavaKind.Object.

Parameters:

b - the context

elementType - the element type of the array to be instantiated

length - the length of the new array

Returns:

true if the plugin handles the bytecode, false otherwise

handleNewMultiArray

default boolean handleNewMultiArray(GraphBuilderContext b,
                                    ResolvedJavaType type,
                                    ValueNode[] dimensions)

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

Parameters:

b - the context

type - the type of the outermost array to be instantiated

dimensions - the array of lengths for all the dimensions to be instantiated

Returns:

true if the plugin handles the bytecode, false otherwise

convertInvokeDynamic

default org.graalvm.collections.Pair<ResolvedJavaMethod,ValueNode[]> convertInvokeDynamic(GraphBuilderContext b,
                                                                                          BootstrapMethodIntrospection m)

Converts an invoke dynamic (indy) call into a static call that passes the returned arguments.

Parameters:

b - the context

m - information about the indy's bootstrap method

Returns:

pair with the call target & arguments for the static call, null if the indy cannot be converted to a static call

instrumentExceptionDispatch

default FixedWithNextNode instrumentExceptionDispatch(StructuredGraph graph,
                                                      FixedWithNextNode afterExceptionLoaded,
                                                      Supplier<FrameState> frameStateFunction)

Allows this plugin to add nodes after the exception object has been loaded in the dispatch sequence. Note that a StructuredGraph is provided to this call instead of a GraphBuilderContext so that the caller has a guarantee that its current control flow insertion point is not changed by this call. This means nodes must be added to the graph with the appropriate method (e.g., Graph.unique(T) for Node.ValueNumberable nodes) and fixed nodes must be manually added as successors of afterExceptionLoaded. The reason for this constraint is that when this plugin runs, it's inserting instructions into a different block than the one currently being parsed.

Parameters:

graph - the graph being parsed

afterExceptionLoaded - the last fixed node after loading the exception

frameStateFunction - a helper that produces a FrameState suitable for deopt

Returns:

the last fixed node after instrumentation

canChangeStackKind

default 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. This disables assertion checking for value kinds.

Parameters:

b - the context