org.graalvm.compiler.nodes.graphbuilderconf

Class InvocationPlugins

java.lang.Object

org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins

public class InvocationPlugins
extends Object

Manages a set of InvocationPlugins. Most plugins are registered during initialization (i.e., before InvocationPlugins.lookupInvocation(ResolvedJavaMethod, boolean, org.graalvm.compiler.options.OptionValues) or InvocationPlugins.getInvocationPlugins(boolean) is called). These registrations can be made with InvocationPlugins.Registration, InvocationPlugins.register(Type, InvocationPlugin) . Initialization is not thread-safe and so must only be performed by a single thread. Plugins that are not guaranteed to be made during initialization must use InvocationPlugins.LateRegistration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvocationPlugins.InvocationPluginReceiver
static class	InvocationPlugins.LateRegistration Utility for registering plugins after Graal may have been initialized.
static class	InvocationPlugins.Options
static class	InvocationPlugins.Registration Utility for registration of invocation plugins.
static class	InvocationPlugins.ResolvedJavaSymbol A symbol for an already resolved method.

Field Summary

Fields

Modifier and Type	Field and Description
protected InvocationPlugins	parent The plugins searched before searching in this object.

Constructor Summary

Constructors

Constructor and Description
InvocationPlugins() Creates a set of invocation plugins with no parent.
InvocationPlugins(Map<ResolvedJavaMethod,InvocationPlugin> resolvedPlugins, InvocationPlugins parent) Creates a set of invocation plugins.

Method Summary

Modifier and Type	Method and Description
void	addTestPlugins(InvocationPlugins other, List<org.graalvm.collections.Pair<String,InvocationPlugin>> ignored) Extends the plugins in this object with those from other.
boolean	canBeIntrinsified(ResolvedJavaType declaringClass) Determines if methods in a given class can have invocation plugins.
void	checkNewNodes(GraphBuilderContext b, InvocationPlugin plugin, NodeIterable<Node> newNodes) Checks a set of nodes added to the graph by an InvocationPlugin.
void	closeRegistration() Processes deferred registrations and then closes this object for future registration.
void	defer(Runnable deferrable) Adds a Runnable for doing registration deferred until the first time InvocationPlugins.get(ResolvedJavaMethod) or InvocationPlugins.closeRegistration() is called on this object.
void	flushDeferrables()
org.graalvm.collections.EconomicMap<String,List<InvocationPlugin>>	getInvocationPlugins(boolean includeParents) Gets the set of registered invocation plugins.
InvocationPlugins	getParent() Gets the invocation plugins searched before searching in this object.
boolean	isEmpty() Determines if this object currently contains any plugins (in any state of registration).
InvocationPlugin	lookupInvocation(ResolvedJavaMethod method, boolean allowDecorators, OptionValues options) Gets the plugin for a given method.
InvocationPlugin	lookupInvocation(ResolvedJavaMethod method, OptionValues options) Gets the plugin for a given method.
void	notifyNoPlugin(ResolvedJavaMethod targetMethod, OptionValues options) Called when no invocation plugin can be found for the given target method.
void	register(Type declaringClass, InvocationPlugin plugin) Registers an invocation plugin for a given method.
protected void	register(Type declaringClass, InvocationPlugin plugin, boolean allowOverwrite)
void	registerIntrinsificationPredicate(Predicate<ResolvedJavaType> predicate) Subclasses can choose to only allow intrinsification of types matched by at least one registered predicate.
void	removeTestPlugins(InvocationPlugins other) Removes the plugins from other in this object that were added by InvocationPlugins.addTestPlugins(org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins, java.util.List<org.graalvm.collections.Pair<java.lang.String, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin>>).
static Class<?>	resolveClass(String className, boolean optional) Resolves a name to a class.
static Constructor<?>	resolveConstructor(Class<?> declaringClass, InvocationPlugin plugin) Resolves a given invocation plugin to a constructor in a given class.
static ResolvedJavaMethod	resolveJavaMethod(ResolvedJavaType declaringClass, InvocationPlugin plugin) Same as InvocationPlugins.resolveMethod(Class, InvocationPlugin) and InvocationPlugins.resolveConstructor(Class, InvocationPlugin) except in terms of ResolvedJavaType and ResolvedJavaMethod.
static Method	resolveMethod(Class<?> declaringClass, InvocationPlugin plugin) Resolves a given invocation plugin to a method in a given class.
static Class<?>	resolveType(Type type, boolean optional) Resolves a Type to a Class.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected final InvocationPlugins parent

The plugins searched before searching in this object.

Constructor Detail

InvocationPlugins

public InvocationPlugins()

Creates a set of invocation plugins with no parent.

InvocationPlugins

public InvocationPlugins(Map<ResolvedJavaMethod,InvocationPlugin> resolvedPlugins,
                         InvocationPlugins parent)

Creates a set of invocation plugins.

Parameters:

resolvedPlugins - if non-null, this object will contain the closed set of invocation plugins for a set of resolved methods, and no further plugin registration is permitted.

parent - if non-null, this object will be searched first when looking up plugins

Method Detail

defer

public void defer(Runnable deferrable)

Adds a Runnable for doing registration deferred until the first time InvocationPlugins.get(ResolvedJavaMethod) or InvocationPlugins.closeRegistration() is called on this object.

canBeIntrinsified

public boolean canBeIntrinsified(ResolvedJavaType declaringClass)

Determines if methods in a given class can have invocation plugins.

Parameters:

declaringClass - the class to test

registerIntrinsificationPredicate

public void registerIntrinsificationPredicate(Predicate<ResolvedJavaType> predicate)

Subclasses can choose to only allow intrinsification of types matched by at least one registered predicate. By default, InvocationPlugins allows any type to be intrinsified.

Parameters:

predicate - controls which types may be intrinsified.

flushDeferrables

public void flushDeferrables()

addTestPlugins

public void addTestPlugins(InvocationPlugins other,
                           List<org.graalvm.collections.Pair<String,InvocationPlugin>> ignored)

Extends the plugins in this object with those from other. The added plugins should be removed after the test. This extension mechanism exists only for tests that want to add extra invocation plugins after the compiler has been initialized.

Parameters:

ignored - if non-null, the invocation plugins from other already in this object prior to calling this method are added to this list. These plugins are not added to this object.

removeTestPlugins

public void removeTestPlugins(InvocationPlugins other)

Removes the plugins from other in this object that were added by InvocationPlugins.addTestPlugins(org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins, java.util.List<org.graalvm.collections.Pair<java.lang.String, org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin>>).

closeRegistration

public void closeRegistration()

Processes deferred registrations and then closes this object for future registration.

isEmpty

public boolean isEmpty()

Determines if this object currently contains any plugins (in any state of registration). If this object has any deferred registrations, it is assumed that executing them will result in at least one plugin being registered.

register

protected void register(Type declaringClass,
                        InvocationPlugin plugin,
                        boolean allowOverwrite)

register

public final void register(Type declaringClass,
                           InvocationPlugin plugin)

Registers an invocation plugin for a given method. There must be no plugin currently registered for method.

lookupInvocation

public InvocationPlugin lookupInvocation(ResolvedJavaMethod method,
                                         boolean allowDecorators,
                                         OptionValues options)

Gets the plugin for a given method.

Parameters:

method - the method to lookup

allowDecorators - return InvocationPlugin.isDecorator() plugins only if true

Returns:

the plugin associated with method or null if none exists

lookupInvocation

public InvocationPlugin lookupInvocation(ResolvedJavaMethod method,
                                         OptionValues options)

Gets the plugin for a given method. By default this will hide InvocationPlugin.isDecorator()} plugins since they can only be applied in certain contexts.

Parameters:

method - the method to lookup

Returns:

the plugin associated with method or null if none exists

getInvocationPlugins

public org.graalvm.collections.EconomicMap<String,List<InvocationPlugin>> getInvocationPlugins(boolean includeParents)

Gets the set of registered invocation plugins.

Returns:

a map from class names in internal form to the invocation plugins for methods in the class

getParent

public InvocationPlugins getParent()

Gets the invocation plugins searched before searching in this object.

toString

public String toString()

Overrides:

toString in class Object

checkNewNodes

public void checkNewNodes(GraphBuilderContext b,
                          InvocationPlugin plugin,
                          NodeIterable<Node> newNodes)

Checks a set of nodes added to the graph by an InvocationPlugin.

Parameters:

b - the graph builder that applied the plugin

plugin - a plugin that was just applied

newNodes - the nodes added to the graph by plugin

Throws:

AssertionError - if any check fail

resolveClass

public static Class<?> resolveClass(String className,
                                    boolean optional)

Resolves a name to a class.

Parameters:

className - the name of the class to resolve

optional - if true, resolution failure returns null

Returns:

the resolved class or null if resolution fails and optional is true

resolveType

public static Class<?> resolveType(Type type,
                                   boolean optional)

Resolves a Type to a Class.

Parameters:

type - the type to resolve

optional - if true, resolution failure returns null

Returns:

the resolved class or null if resolution fails and optional is true

resolveMethod

public static Method resolveMethod(Class<?> declaringClass,
                                   InvocationPlugin plugin)

Resolves a given invocation plugin to a method in a given class. If more than one method with the parameter types matching plugin is found and the return types of all the matching methods form an inheritance chain, the one with the most specific type is returned; otherwise NoSuchMethodError is thrown.

Parameters:

declaringClass - the class to search for a method matching plugin

Returns:

the method (if any) in declaringClass matching plugin

resolveJavaMethod

public static ResolvedJavaMethod resolveJavaMethod(ResolvedJavaType declaringClass,
                                                   InvocationPlugin plugin)

Same as InvocationPlugins.resolveMethod(Class, InvocationPlugin) and InvocationPlugins.resolveConstructor(Class, InvocationPlugin) except in terms of ResolvedJavaType and ResolvedJavaMethod.

resolveConstructor

public static Constructor<?> resolveConstructor(Class<?> declaringClass,
                                                InvocationPlugin plugin)

Resolves a given invocation plugin to a constructor in a given class.

Parameters:

declaringClass - the class to search for a constructor matching plugin

Returns:

the constructor (if any) in declaringClass matching plugin

notifyNoPlugin

public void notifyNoPlugin(ResolvedJavaMethod targetMethod,
                           OptionValues options)

Called when no invocation plugin can be found for the given target method.