1 /* 2 * Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 */ 23 24 25 package org.graalvm.compiler.nodes.spi; 26 27 import org.graalvm.compiler.api.replacements.MethodSubstitution; 28 import org.graalvm.compiler.api.replacements.SnippetTemplateCache; 29 import org.graalvm.compiler.bytecode.BytecodeProvider; 30 import org.graalvm.compiler.core.common.CompilationIdentifier; 31 import org.graalvm.compiler.debug.DebugContext; 32 import org.graalvm.compiler.graph.NodeSourcePosition; 33 import org.graalvm.compiler.nodes.Cancellable; 34 import org.graalvm.compiler.nodes.StructuredGraph; 35 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration; 36 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderPlugin; 37 import org.graalvm.compiler.nodes.graphbuilderconf.IntrinsicContext; 38 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin; 39 import org.graalvm.compiler.nodes.graphbuilderconf.MethodSubstitutionPlugin; 40 import org.graalvm.compiler.options.OptionValues; 41 42 import jdk.vm.ci.meta.ResolvedJavaMethod; 43 44 /** 45 * Interface for managing replacements. 46 */ 47 public interface Replacements { 48 getProviders()49 CoreProviders getProviders(); 50 51 /** 52 * Gets the object managing the various graph builder plugins used by this object when parsing 53 * bytecode into a graph. 54 */ getGraphBuilderPlugins()55 GraphBuilderConfiguration.Plugins getGraphBuilderPlugins(); 56 57 /** 58 * Gets the plugin type that intrinsifies calls to {@code method}. 59 */ getIntrinsifyingPlugin(ResolvedJavaMethod method)60 Class<? extends GraphBuilderPlugin> getIntrinsifyingPlugin(ResolvedJavaMethod method); 61 62 /** 63 * Gets the snippet graph derived from a given method. 64 * 65 * @param recursiveEntry if the snippet contains a call to this method, it's considered as 66 * recursive call and won't be processed for {@linkplain MethodSubstitution 67 * substitutions}. 68 * @param args arguments to the snippet if available, otherwise {@code null} 69 * @param trackNodeSourcePosition 70 * @param options 71 * @return the snippet graph, if any, that is derived from {@code method} 72 */ getSnippet(ResolvedJavaMethod method, ResolvedJavaMethod recursiveEntry, Object[] args, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition, OptionValues options)73 StructuredGraph getSnippet(ResolvedJavaMethod method, ResolvedJavaMethod recursiveEntry, Object[] args, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition, 74 OptionValues options); 75 76 /** 77 * Registers a method as snippet. 78 */ registerSnippet(ResolvedJavaMethod method, ResolvedJavaMethod original, Object receiver, boolean trackNodeSourcePosition, OptionValues options)79 void registerSnippet(ResolvedJavaMethod method, ResolvedJavaMethod original, Object receiver, boolean trackNodeSourcePosition, OptionValues options); 80 81 /** 82 * Gets a graph that is a substitution for a given {@link MethodSubstitutionPlugin plugin} in 83 * the {@link org.graalvm.compiler.nodes.graphbuilderconf.IntrinsicContext.CompilationContext 84 * context}. 85 * 86 * @param plugin the plugin being substituted 87 * @param original the method being substituted 88 * @param context the kind of inlining to be performed for the substitution 89 * @param allowAssumptions 90 * @param cancellable 91 * @param options 92 * @return the method substitution graph, if any, that is derived from {@code method} 93 */ getMethodSubstitution(MethodSubstitutionPlugin plugin, ResolvedJavaMethod original, IntrinsicContext.CompilationContext context, StructuredGraph.AllowAssumptions allowAssumptions, Cancellable cancellable, OptionValues options)94 StructuredGraph getMethodSubstitution(MethodSubstitutionPlugin plugin, ResolvedJavaMethod original, IntrinsicContext.CompilationContext context, 95 StructuredGraph.AllowAssumptions allowAssumptions, Cancellable cancellable, OptionValues options); 96 97 /** 98 * Registers a plugin as a substitution. 99 */ registerMethodSubstitution(MethodSubstitutionPlugin plugin)100 void registerMethodSubstitution(MethodSubstitutionPlugin plugin); 101 102 /** 103 * Marks a plugin as conditionally applied. In the contenxt of libgraal conditional plugins 104 * can't be used in during graph encoding for snippets and method substitutions and this is used 105 * to detect violations of this restriction. 106 */ registerConditionalPlugin(InvocationPlugin plugin)107 void registerConditionalPlugin(InvocationPlugin plugin); 108 109 /** 110 * Gets a graph that is a substitution for a given method. 111 * 112 * @param invokeBci the call site BCI if this request is made for inlining a substitute 113 * otherwise {@code -1} 114 * @param trackNodeSourcePosition 115 * @param options 116 * @return the graph, if any, that is a substitution for {@code method} 117 */ getSubstitution(ResolvedJavaMethod method, int invokeBci, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition, OptionValues options)118 StructuredGraph getSubstitution(ResolvedJavaMethod method, int invokeBci, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition, OptionValues options); 119 120 /** 121 * Gets a graph produced from the intrinsic for a given method that can be compiled and 122 * installed for the method. 123 * 124 * @param method 125 * @param compilationId 126 * @param debug 127 * @param cancellable 128 * @return an intrinsic graph that can be compiled and installed for {@code method} or null 129 */ getIntrinsicGraph(ResolvedJavaMethod method, CompilationIdentifier compilationId, DebugContext debug, Cancellable cancellable)130 StructuredGraph getIntrinsicGraph(ResolvedJavaMethod method, CompilationIdentifier compilationId, DebugContext debug, Cancellable cancellable); 131 132 /** 133 * Determines if there may be a 134 * {@linkplain #getSubstitution(ResolvedJavaMethod, int, boolean, NodeSourcePosition, OptionValues) 135 * substitution graph} for a given method. 136 * 137 * A call to {@link #getSubstitution} may still return {@code null} for {@code method} and 138 * {@code invokeBci}. A substitution may be based on an {@link InvocationPlugin} that returns 139 * {@code false} for {@link InvocationPlugin#execute} making it impossible to create a 140 * substitute graph. 141 * 142 * @param invokeBci the call site BCI if this request is made for inlining a substitute 143 * otherwise {@code -1} 144 * @return true iff there may be a substitution graph available for {@code method} 145 */ hasSubstitution(ResolvedJavaMethod method, int invokeBci)146 boolean hasSubstitution(ResolvedJavaMethod method, int invokeBci); 147 148 /** 149 * Gets the provider for accessing the bytecode of a substitution method if no other provider is 150 * associated with the substitution method. 151 */ getDefaultReplacementBytecodeProvider()152 BytecodeProvider getDefaultReplacementBytecodeProvider(); 153 154 /** 155 * Register snippet templates. 156 */ registerSnippetTemplateCache(SnippetTemplateCache snippetTemplates)157 void registerSnippetTemplateCache(SnippetTemplateCache snippetTemplates); 158 159 /** 160 * Get snippet templates that were registered with 161 * {@link Replacements#registerSnippetTemplateCache(SnippetTemplateCache)}. 162 */ getSnippetTemplateCache(Class<T> templatesClass)163 <T extends SnippetTemplateCache> T getSnippetTemplateCache(Class<T> templatesClass); 164 165 /** 166 * Notifies this method that no further snippets will be registered via {@link #registerSnippet} 167 * or {@link #registerSnippetTemplateCache}. 168 * 169 * This is a hook for an implementation to check for or forbid late registration. 170 */ closeSnippetRegistration()171 default void closeSnippetRegistration() { 172 } 173 } 174