com.oracle.graal.graphbuilderconf

Class MethodSubstitutionPlugin

java.lang.Object

com.oracle.graal.graphbuilderconf.MethodSubstitutionPlugin

All Implemented Interfaces:

GraphBuilderPlugin, InvocationPlugin

public final class MethodSubstitutionPlugin
extends Object
implements InvocationPlugin

An InvocationPlugin for a method where the implementation of the method is provided by a substitute method. A substitute method must be static even if the substituted method is not.

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.graal.graphbuilderconf.InvocationPlugin

InvocationPlugin.Receiver

Field Summary

Fields

Modifier and Type	Field and Description
private ResolvedJavaMethod	cachedSubstitute
private Class<?>	declaringClass The class in which the substitute method is declared.
private String	name The name of the original and substitute method.
private boolean	originalIsStatic
private Class<?>[]	parameters The parameter types of the substitute method.

Constructor Summary

Constructors

Constructor and Description
MethodSubstitutionPlugin(boolean originalIsStatic, Class<?> declaringClass, String name, Class<?>... parameters) Creates a method substitution plugin.
MethodSubstitutionPlugin(Class<?> declaringClass, String name, Class<?>... parameters) Creates a method substitution plugin.

Method Summary

Modifier and Type	Method and Description
boolean	execute(GraphBuilderContext b, ResolvedJavaMethod targetMethod, InvocationPlugin.Receiver receiver, ValueNode[] argsIncludingReceiver) Executes this plugin against a set of invocation arguments.
StackTraceElement	getApplySourceLocation(MetaAccessProvider metaAccess)
(package private) Method	getJavaSubstitute() Gets the reflection API version of the substitution method.
ResolvedJavaMethod	getSubstitute(MetaAccessProvider metaAccess) Gets the substitute method, resolving it first if necessary.
boolean	inlineOnly() Determines if this plugin can only be used when inlining the method is it associated with.
private boolean	isSubstitute(Method m) Determines if a given method is the substitute method of this plugin.
private Method	lookupSubstitute() Gets the substitute method of this plugin.
static Class<?>	resolveClass(String className, boolean optional) Resolves a name to a class.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.graal.graphbuilderconf.InvocationPlugin

apply, apply, apply, apply, apply, apply, applyPolymorphic, defaultHandler, isSignaturePolymorphic

Field Detail

cachedSubstitute

private ResolvedJavaMethod cachedSubstitute

declaringClass

private final Class<?> declaringClass

The class in which the substitute method is declared.

name

private final String name

The name of the original and substitute method.

parameters

private final Class<?>[] parameters

The parameter types of the substitute method.

originalIsStatic

private final boolean originalIsStatic

Constructor Detail

MethodSubstitutionPlugin

public MethodSubstitutionPlugin(Class<?> declaringClass,
                                String name,
                                Class<?>... parameters)

Creates a method substitution plugin.

Parameters:

declaringClass - the class in which the substitute method is declared

name - the name of the substitute method

parameters - the parameter types of the substitute method. If the original method is not static, then parameters[0] must be the Class value denoting InvocationPlugin.Receiver

MethodSubstitutionPlugin

public MethodSubstitutionPlugin(boolean originalIsStatic,
                                Class<?> declaringClass,
                                String name,
                                Class<?>... parameters)

Creates a method substitution plugin.

Parameters:

declaringClass - the class in which the substitute method is declared

name - the name of the substitute method

parameters - the parameter types of the substitute method

Method Detail

inlineOnly

public boolean inlineOnly()

Description copied from interface: InvocationPlugin

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.

Specified by:

inlineOnly in interface InvocationPlugin

getSubstitute

public ResolvedJavaMethod getSubstitute(MetaAccessProvider metaAccess)

Gets the substitute method, resolving it first if necessary.

getJavaSubstitute

Method getJavaSubstitute()
                  throws JVMCIError

Gets the reflection API version of the substitution method.

Throws:

JVMCIError

isSubstitute

private boolean isSubstitute(Method m)

Determines if a given method is the substitute method of this plugin.

lookupSubstitute

private Method lookupSubstitute()

Gets the substitute method of this plugin.

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

execute

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

Description copied from interface: InvocationPlugin

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 or to InvocationPlugin.applyPolymorphic(com.oracle.graal.graphbuilderconf.GraphBuilderContext, jdk.internal.jvmci.meta.ResolvedJavaMethod, com.oracle.graal.graphbuilderconf.InvocationPlugin.Receiver, com.oracle.graal.nodes.ValueNode...) if plugin is signature polymorphic.

Specified by:

execute in interface InvocationPlugin

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.

getApplySourceLocation

public StackTraceElement getApplySourceLocation(MetaAccessProvider metaAccess)

Specified by:

getApplySourceLocation in interface InvocationPlugin

toString

public String toString()

Overrides:

toString in class Object