org.graalvm.compiler.nodes.graphbuilderconf

Class InvocationPlugin

java.lang.Object

org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin

All Implemented Interfaces:

GraphBuilderPlugin

Direct Known Subclasses:

ForeignCallPlugin, HotSpotGraphBuilderPlugins.AESCryptPlugin, HotSpotGraphBuilderPlugins.CipherBlockChainingCryptPlugin, HotSpotGraphBuilderPlugins.CounterModeCryptPlugin, HotSpotGraphBuilderPlugins.ElectronicCodeBookCryptPlugin, InvocationPlugin.InlineOnlyInvocationPlugin, InvocationPlugin.OptionalInvocationPlugin, InvocationPlugin.RequiredInvocationPlugin, StandardGraphBuilderPlugins.AllocateUninitializedArrayPlugin, StandardGraphBuilderPlugins.ArrayEqualsInvocationPlugin, StandardGraphBuilderPlugins.BoxPlugin, StandardGraphBuilderPlugins.CacheWritebackPlugin, StandardGraphBuilderPlugins.StringLatin1IndexOfCharPlugin, StandardGraphBuilderPlugins.UnboxPlugin, StandardGraphBuilderPlugins.UnsafeAccessPlugin, StandardGraphBuilderPlugins.UnsafeFencePlugin, StandardGraphBuilderPlugins.UnsignedMathPlugin

public abstract class InvocationPlugin
extends Object
implements GraphBuilderPlugin

Plugin for handling a specific method invocation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvocationPlugin.InlineOnlyInvocationPlugin
static class	InvocationPlugin.OptionalInvocationPlugin
static interface	InvocationPlugin.Receiver The receiver in a non-static method.
static class	InvocationPlugin.RequiredInlineOnlyInvocationPlugin
static class	InvocationPlugin.RequiredInvocationPlugin

Field Summary

Fields

Modifier and Type	Field and Description
String	argumentsDescriptor Argument descriptor of the method.
boolean	isStatic Determines if the method is static.
String	name Name of the method.

Constructor Summary

Constructors

Constructor and Description
InvocationPlugin(String name, Type... argumentTypes)

Method Summary

Modifier and Type	Method and Description
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2, ValueNode arg3)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2, ValueNode arg3, ValueNode arg4)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2, ValueNode arg3, ValueNode arg4, ValueNode arg5)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2, ValueNode arg3, ValueNode arg4, ValueNode arg5, ValueNode arg6)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2, ValueNode arg3, ValueNode arg4, ValueNode arg5, ValueNode arg6, ValueNode arg7)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2, ValueNode arg3, ValueNode arg4, ValueNode arg5, ValueNode arg6, ValueNode arg7, ValueNode arg8)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2, ValueNode arg3, ValueNode arg4, ValueNode arg5, ValueNode arg6, ValueNode arg7, ValueNode arg8, ValueNode arg9)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2, ValueNode arg3, ValueNode arg4, ValueNode arg5, ValueNode arg6, ValueNode arg7, ValueNode arg8, ValueNode arg9, ValueNode arg10)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2, ValueNode arg3, ValueNode arg4, ValueNode arg5, ValueNode arg6, ValueNode arg7, ValueNode arg8, ValueNode arg9, ValueNode arg10, ValueNode arg11)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2, ValueNode arg3, ValueNode arg4, ValueNode arg5, ValueNode arg6, ValueNode arg7, ValueNode arg8, ValueNode arg9, ValueNode arg10, ValueNode arg11, ValueNode arg12)
boolean	apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode arg1, ValueNode arg2, ValueNode arg3, ValueNode arg4, ValueNode arg5, ValueNode arg6, ValueNode arg7, ValueNode arg8, ValueNode arg9, ValueNode arg10, ValueNode arg11, ValueNode arg12, ValueNode arg13)
boolean	canBeDisabled() Determines if this plugin can be disabled.
boolean	defaultHandler(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode... args) Handles an invocation when a specific apply method is not available.
boolean	execute(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode[] argsIncludingReceiver) Executes this plugin against a set of invocation arguments.
int	getArgumentsSize()
String	getMethodNameWithArgumentsDescriptor()
String	getSourceLocation()
boolean	inlineOnly() Determines if this plugin can only be used when inlining the method is it associated with.
boolean	isDecorator() Determines if this plugin only decorates the method is it associated with.
boolean	isOptional() Determines if this plugin requires the original method to be resolvable.
boolean	match(InvocationPlugin other)
boolean	match(ResolvedJavaMethod method)
void	rewriteReceiverType(Type receiverType) Rewrite the first element of InvocationPlugin.argumentTypes to receiverType for non-static method.

Methods inherited from class java.lang.Object

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

Field Detail

name

public final String name

Name of the method.

isStatic

public final boolean isStatic

Determines if the method is static.

argumentsDescriptor

public final String argumentsDescriptor

Argument descriptor of the method.

Constructor Detail

InvocationPlugin

public InvocationPlugin(String name,
                        Type... argumentTypes)

Method Detail

inlineOnly

public boolean inlineOnly()

Determines if this plugin can only be used when inlining the method is it associated with. That is, this plugin cannot be used when the associated method is the compilation root.

isDecorator

public boolean isDecorator()

Determines if this plugin only decorates the method is it associated with. That is, it inserts nodes prior to the invocation (e.g. some kind of marker nodes) but still expects the parser to process the invocation further.

isOptional

public boolean isOptional()

Determines if this plugin requires the original method to be resolvable. For instance, Reference#refersTo0 is introduced in Java 16 and is optional in earlier versions in case it may be backported.

canBeDisabled

public boolean canBeDisabled()

Determines if this plugin can be disabled. For instance, HotSpot intrinsics featuring better performance with specific CPU features can be disabled; utility methods in GraalDirectives can not be disabled. See InvocationPlugins.Options.DisableIntrinsics.

rewriteReceiverType

public void rewriteReceiverType(Type receiverType)

Rewrite the first element of InvocationPlugin.argumentTypes to receiverType for non-static method.

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2,
                     ValueNode arg3)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2,
                     ValueNode arg3,
                     ValueNode arg4)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2,
                     ValueNode arg3,
                     ValueNode arg4,
                     ValueNode arg5)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2,
                     ValueNode arg3,
                     ValueNode arg4,
                     ValueNode arg5,
                     ValueNode arg6)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2,
                     ValueNode arg3,
                     ValueNode arg4,
                     ValueNode arg5,
                     ValueNode arg6,
                     ValueNode arg7)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2,
                     ValueNode arg3,
                     ValueNode arg4,
                     ValueNode arg5,
                     ValueNode arg6,
                     ValueNode arg7,
                     ValueNode arg8)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2,
                     ValueNode arg3,
                     ValueNode arg4,
                     ValueNode arg5,
                     ValueNode arg6,
                     ValueNode arg7,
                     ValueNode arg8,
                     ValueNode arg9)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2,
                     ValueNode arg3,
                     ValueNode arg4,
                     ValueNode arg5,
                     ValueNode arg6,
                     ValueNode arg7,
                     ValueNode arg8,
                     ValueNode arg9,
                     ValueNode arg10)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2,
                     ValueNode arg3,
                     ValueNode arg4,
                     ValueNode arg5,
                     ValueNode arg6,
                     ValueNode arg7,
                     ValueNode arg8,
                     ValueNode arg9,
                     ValueNode arg10,
                     ValueNode arg11)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2,
                     ValueNode arg3,
                     ValueNode arg4,
                     ValueNode arg5,
                     ValueNode arg6,
                     ValueNode arg7,
                     ValueNode arg8,
                     ValueNode arg9,
                     ValueNode arg10,
                     ValueNode arg11,
                     ValueNode arg12)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

apply

public boolean apply(GraphBuilderContext b,
                     ResolvedJavaMethod targetMethod,
                     InvocationPlugin.Receiver receiver,
                     ValueNode arg1,
                     ValueNode arg2,
                     ValueNode arg3,
                     ValueNode arg4,
                     ValueNode arg5,
                     ValueNode arg6,
                     ValueNode arg7,
                     ValueNode arg8,
                     ValueNode arg9,
                     ValueNode arg10,
                     ValueNode arg11,
                     ValueNode arg12,
                     ValueNode arg13)

See Also:

InvocationPlugin.execute(org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext, ResolvedJavaMethod, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver, org.graalvm.compiler.nodes.ValueNode[])

execute

public boolean execute(GraphBuilderContext b,
                       ResolvedJavaMethod targetMethod,
                       InvocationPlugin.Receiver receiver,
                       ValueNode[] argsIncludingReceiver)

Executes this plugin against a set of invocation arguments. The default implementation in InvocationPlugin dispatches to the apply(...) method that matches the number of arguments.

Parameters:

targetMethod - the method for which this plugin is being applied

receiver - access to the receiver, null if targetMethod is static

argsIncludingReceiver - all arguments to the invocation include the receiver in position 0 if targetMethod is not static

Returns:

true if this plugin handled the invocation of targetMethod false if the graph builder should process the invoke further (e.g., by inlining it or creating an Invoke node). A plugin that does not handle an invocation must not modify the graph being constructed unless it is a decorator.

defaultHandler

public boolean defaultHandler(GraphBuilderContext b,
                              ResolvedJavaMethod targetMethod,
                              InvocationPlugin.Receiver receiver,
                              ValueNode... args)

Handles an invocation when a specific apply method is not available.

getSourceLocation

public String getSourceLocation()

getArgumentsSize

public int getArgumentsSize()

getMethodNameWithArgumentsDescriptor

public String getMethodNameWithArgumentsDescriptor()

match

public boolean match(InvocationPlugin other)

match

public boolean match(ResolvedJavaMethod method)