com.oracle.graal.replacements

Class ReplacementsImpl

java.lang.Object

com.oracle.graal.replacements.ReplacementsImpl

All Implemented Interfaces:

GraphBuilderPlugin, InlineInvokePlugin, Replacements

Direct Known Subclasses:

HotSpotReplacementsImpl

public class ReplacementsImpl
extends Object
implements Replacements, InlineInvokePlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ReplacementsImpl.ClassReplacements Encapsulates method and macro substitutions for a single class.
static class	ReplacementsImpl.GraphMaker Creates and preprocesses a graph for a replacement.
(package private) static class	ReplacementsImpl.JavaSignature

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

InlineInvokePlugin.InlineInfo

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,AtomicReference<ReplacementsImpl.ClassReplacements>>	classReplacements Per-class replacements.
private GraphBuilderConfiguration.Plugins	graphBuilderPlugins
protected ConcurrentMap<ResolvedJavaMethod,StructuredGraph>	graphs The preprocessed replacement graphs.
private Map<String,Class<?>[]>	internalNameToSubstitutionClasses
private static int	MAX_GRAPH_INLINING_DEPTH
Providers	providers
private static DebugTimer	SnippetPreparationTime
SnippetReflectionProvider	snippetReflection
private Map<String,SnippetTemplateCache>	snippetTemplateCache
TargetDescription	target
private static boolean	UseSnippetGraphCache

Constructor Summary

Constructors

Constructor and Description
ReplacementsImpl(Providers providers, SnippetReflectionProvider snippetReflection, TargetDescription target)

Method Summary

Modifier and Type	Method and Description
private static boolean	checkSubstitutionInternalName(Class<?> substitutions, String internalName)
protected ReplacementsImpl.GraphMaker	createGraphMaker(ResolvedJavaMethod substitute, ResolvedJavaMethod original) Can be overridden to return an object that specializes various parts of graph preprocessing.
Collection<ResolvedJavaMethod>	getAllReplacements() Returns all methods that are currently registered as method/macro substitution or as a snippet.
protected ReplacementsImpl.ClassReplacements	getClassReplacements(String internalName) Gets the method and macro replacements for a given class.
GraphBuilderConfiguration.Plugins	getGraphBuilderPlugins()
private SubstitutionGuard	getGuard(Class<? extends SubstitutionGuard> guardClass)
StructuredGraph	getSnippet(ResolvedJavaMethod method, Object[] args) Gets the snippet graph derived from a given method.
StructuredGraph	getSnippet(ResolvedJavaMethod method, ResolvedJavaMethod recursiveEntry, Object[] args) Gets the snippet graph derived from a given method.
<T extends SnippetTemplateCache> T	getSnippetTemplateCache(Class<T> templatesClass) Get snippet templates that were registered with Replacements.registerSnippetTemplateCache(SnippetTemplateCache).
StructuredGraph	getSubstitution(ResolvedJavaMethod original, boolean fromBytecodeOnly, int invokeBci) Gets a graph that is a substitution for a given method.
ResolvedJavaMethod	getSubstitutionMethod(ResolvedJavaMethod original) Gets a method that is a substitution for a given method.
protected boolean	hasGenericInvocationPluginAnnotation(ResolvedJavaMethod method)
boolean	hasSubstitution(ResolvedJavaMethod method, boolean fromBytecodeOnly, int callerBci) Determines if there is a substitution graph for a given method.
StructuredGraph	makeGraph(ResolvedJavaMethod method, Object[] args, ResolvedJavaMethod original) Creates a preprocessed graph for a snippet or method substitution.
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(com.oracle.graal.graphbuilderconf.GraphBuilderContext, jdk.internal.jvmci.meta.ResolvedJavaMethod, com.oracle.graal.nodes.ValueNode[], jdk.internal.jvmci.meta.JavaType).
private static String	originalName(Method substituteMethod, String methodSubstitution)
protected ResolvedJavaMethod	registerMethodSubstitution(ReplacementsImpl.ClassReplacements cr, Executable originalMember, Method substituteMethod) Registers a method substitution.
void	registerSnippet(ResolvedJavaMethod method) Registers a method as snippet.
void	registerSnippetTemplateCache(SnippetTemplateCache templates) Register snippet templates.
void	registerSubstitutions(Type original, Class<?> substitutionClass) Registers all the method substitutions defined by a given class.
private static Class<?>	resolveClass(JavaType type)
static Class<?>	resolveClass(String className, boolean optional) Resolves a name to a class.
void	setGraphBuilderPlugins(GraphBuilderConfiguration.Plugins plugins)
InlineInvokePlugin.InlineInfo	shouldInlineInvoke(GraphBuilderContext b, ResolvedJavaMethod method, ValueNode[] args, JavaType returnType) Determines whether a given method should be inlined based on whether it has a substitution or whether the inlining context is already within a substitution.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.graal.nodes.spi.Replacements

getSubstitution, hasSubstitution

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

notifyAfterInline, notifyBeforeInline

Field Detail

providers

public final Providers providers

snippetReflection

public final SnippetReflectionProvider snippetReflection

target

public final TargetDescription target

graphBuilderPlugins

private GraphBuilderConfiguration.Plugins graphBuilderPlugins

graphs

protected final ConcurrentMap<ResolvedJavaMethod,StructuredGraph> graphs

The preprocessed replacement graphs.

MAX_GRAPH_INLINING_DEPTH

private static final int MAX_GRAPH_INLINING_DEPTH

See Also:

Constant Field Values

classReplacements

private final Map<String,AtomicReference<ReplacementsImpl.ClassReplacements>> classReplacements

Per-class replacements. The entries in these maps are all fully initialized during single-threaded compiler startup and so do not need to be concurrent.

internalNameToSubstitutionClasses

private final Map<String,Class<?>[]> internalNameToSubstitutionClasses

snippetTemplateCache

private final Map<String,SnippetTemplateCache> snippetTemplateCache

UseSnippetGraphCache

private static final boolean UseSnippetGraphCache

SnippetPreparationTime

private static final DebugTimer SnippetPreparationTime

Constructor Detail

ReplacementsImpl

public ReplacementsImpl(Providers providers,
                        SnippetReflectionProvider snippetReflection,
                        TargetDescription target)

Method Detail

setGraphBuilderPlugins

public void setGraphBuilderPlugins(GraphBuilderConfiguration.Plugins plugins)

getGraphBuilderPlugins

public GraphBuilderConfiguration.Plugins getGraphBuilderPlugins()

hasGenericInvocationPluginAnnotation

protected boolean hasGenericInvocationPluginAnnotation(ResolvedJavaMethod method)

shouldInlineInvoke

public InlineInvokePlugin.InlineInfo shouldInlineInvoke(GraphBuilderContext b,
                                                        ResolvedJavaMethod method,
                                                        ValueNode[] args,
                                                        JavaType returnType)

Determines whether a given method should be inlined based on whether it has a substitution or whether the inlining context is already within a substitution.

Specified by:

shouldInlineInvoke in interface InlineInvokePlugin

Parameters:

b - the context

method - the target method of an invoke

args - the arguments to the invoke

returnType - the return type derived from method's signature

Returns:

an object specifying how method is to be inlined or null if it should not be inlined based on substitution related criteria

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(com.oracle.graal.graphbuilderconf.GraphBuilderContext, jdk.internal.jvmci.meta.ResolvedJavaMethod, com.oracle.graal.nodes.ValueNode[], jdk.internal.jvmci.meta.JavaType).

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

getClassReplacements

protected ReplacementsImpl.ClassReplacements getClassReplacements(String internalName)

Gets the method and macro replacements for a given class. This method will parse the replacements in the substitution classes associated with internalName the first time this method is called for internalName.

getSnippet

public StructuredGraph getSnippet(ResolvedJavaMethod method,
                                  Object[] args)

Description copied from interface: Replacements

Gets the snippet graph derived from a given method.

Specified by:

getSnippet in interface Replacements

args - arguments to the snippet if available, otherwise null

Returns:

the snippet graph, if any, that is derived from method

getSnippet

public StructuredGraph getSnippet(ResolvedJavaMethod method,
                                  ResolvedJavaMethod recursiveEntry,
                                  Object[] args)

Description copied from interface: Replacements

Gets the snippet graph derived from a given method.

Specified by:

getSnippet in interface Replacements

recursiveEntry - if the snippet contains a call to this method, it's considered as recursive call and won't be processed for substitutions.

args - arguments to the snippet if available, otherwise null

Returns:

the snippet graph, if any, that is derived from method

registerSnippet

public void registerSnippet(ResolvedJavaMethod method)

Description copied from interface: Replacements

Registers a method as snippet.

Specified by:

registerSnippet in interface Replacements

getSubstitution

public StructuredGraph getSubstitution(ResolvedJavaMethod original,
                                       boolean fromBytecodeOnly,
                                       int invokeBci)

Description copied from interface: Replacements

Gets a graph that is a substitution for a given method.

Specified by:

getSubstitution in interface Replacements

fromBytecodeOnly - only return a graph created by parsing the bytecode of another method

invokeBci - the call site BCI if this request is made for inlining a substitute otherwise -1

Returns:

the graph, if any, that is a substitution for method

getGuard

private SubstitutionGuard getGuard(Class<? extends SubstitutionGuard> guardClass)

checkSubstitutionInternalName

private static boolean checkSubstitutionInternalName(Class<?> substitutions,
                                                     String internalName)

registerSubstitutions

public void registerSubstitutions(Type original,
                                  Class<?> substitutionClass)

Description copied from interface: Replacements

Registers all the method substitutions defined by a given class.

Specified by:

registerSubstitutions in interface Replacements

Parameters:

original - the original class for which substitutions are being registered. This must be the same type denoted by the ClassSubstitution annotation on substitutions. It is required here so that an implementation is not forced to read annotations during registration.

substitutionClass - the class defining substitutions for original. This class must be annotated with ClassSubstitution.

registerMethodSubstitution

protected ResolvedJavaMethod registerMethodSubstitution(ReplacementsImpl.ClassReplacements cr,
                                                        Executable originalMember,
                                                        Method substituteMethod)

Registers a method substitution.

Parameters:

originalMember - a method or constructor being substituted

substituteMethod - the substitute method

Returns:

the original method

makeGraph

public StructuredGraph makeGraph(ResolvedJavaMethod method,
                                 Object[] args,
                                 ResolvedJavaMethod original)

Creates a preprocessed graph for a snippet or method substitution.

Parameters:

method - the snippet or method substitution for which a graph will be created

args -

original - the original method if method is a substitution otherwise null

createGraphMaker

protected ReplacementsImpl.GraphMaker createGraphMaker(ResolvedJavaMethod substitute,
                                                       ResolvedJavaMethod original)

Can be overridden to return an object that specializes various parts of graph preprocessing.

originalName

private static String originalName(Method substituteMethod,
                                   String methodSubstitution)

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

resolveClass

private static Class<?> resolveClass(JavaType type)

getAllReplacements

public Collection<ResolvedJavaMethod> getAllReplacements()

Description copied from interface: Replacements

Returns all methods that are currently registered as method/macro substitution or as a snippet.

Specified by:

getAllReplacements in interface Replacements

hasSubstitution

public boolean hasSubstitution(ResolvedJavaMethod method,
                               boolean fromBytecodeOnly,
                               int callerBci)

Description copied from interface: Replacements

Determines if there is a substitution graph for a given method.

Specified by:

hasSubstitution in interface Replacements

fromBytecodeOnly - only consider graphs created by parsing the bytecode of another method

callerBci - the call site BCI if this request is made for inlining a substitute otherwise -1

Returns:

true iff there is a substitution graph available for method

getSubstitutionMethod

public ResolvedJavaMethod getSubstitutionMethod(ResolvedJavaMethod original)

Description copied from interface: Replacements

Gets a method that is a substitution for a given method.

Specified by:

getSubstitutionMethod in interface Replacements

Returns:

the method, if any, whose bytecode are a substitution for method

registerSnippetTemplateCache

public void registerSnippetTemplateCache(SnippetTemplateCache templates)

Description copied from interface: Replacements

Register snippet templates.

Specified by:

registerSnippetTemplateCache in interface Replacements

getSnippetTemplateCache

public <T extends SnippetTemplateCache> T getSnippetTemplateCache(Class<T> templatesClass)

Description copied from interface: Replacements

Get snippet templates that were registered with Replacements.registerSnippetTemplateCache(SnippetTemplateCache).

Specified by:

getSnippetTemplateCache in interface Replacements