| /* |
| * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| |
| package org.graalvm.compiler.nodes.spi; |
| |
| import org.graalvm.compiler.api.replacements.MethodSubstitution; |
| import org.graalvm.compiler.api.replacements.SnippetTemplateCache; |
| import org.graalvm.compiler.bytecode.Bytecode; |
| import org.graalvm.compiler.bytecode.BytecodeProvider; |
| import org.graalvm.compiler.graph.NodeSourcePosition; |
| import org.graalvm.compiler.nodes.StructuredGraph; |
| import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration; |
| import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin; |
| import org.graalvm.compiler.options.OptionValues; |
| |
| import jdk.vm.ci.meta.ResolvedJavaMethod; |
| |
| /** |
| * Interface for managing replacements. |
| */ |
| public interface Replacements { |
| |
| OptionValues getOptions(); |
| |
| /** |
| * Gets the object managing the various graph builder plugins used by this object when parsing |
| * bytecode into a graph. |
| */ |
| GraphBuilderConfiguration.Plugins getGraphBuilderPlugins(); |
| |
| /** |
| * Gets the snippet graph derived from a given method. |
| * |
| * @param args arguments to the snippet if available, otherwise {@code null} |
| * @param trackNodeSourcePosition |
| * @return the snippet graph, if any, that is derived from {@code method} |
| */ |
| StructuredGraph getSnippet(ResolvedJavaMethod method, Object[] args, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition); |
| |
| /** |
| * Gets the snippet graph derived from a given method. |
| * |
| * @param recursiveEntry if the snippet contains a call to this method, it's considered as |
| * recursive call and won't be processed for {@linkplain MethodSubstitution |
| * substitutions}. |
| * @param args arguments to the snippet if available, otherwise {@code null} |
| * @param trackNodeSourcePosition |
| * @return the snippet graph, if any, that is derived from {@code method} |
| */ |
| StructuredGraph getSnippet(ResolvedJavaMethod method, ResolvedJavaMethod recursiveEntry, Object[] args, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition); |
| |
| /** |
| * Registers a method as snippet. |
| */ |
| void registerSnippet(ResolvedJavaMethod method, boolean trackNodeSourcePosition); |
| |
| /** |
| * Gets a graph that is a substitution for a given method. |
| * |
| * @param invokeBci the call site BCI if this request is made for inlining a substitute |
| * otherwise {@code -1} |
| * @param trackNodeSourcePosition |
| * @return the graph, if any, that is a substitution for {@code method} |
| */ |
| StructuredGraph getSubstitution(ResolvedJavaMethod method, int invokeBci, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition); |
| |
| /** |
| * Gets the substitute bytecode for a given method. |
| * |
| * @return the bytecode to substitute for {@code method} or {@code null} if there is no |
| * substitute bytecode for {@code method} |
| */ |
| Bytecode getSubstitutionBytecode(ResolvedJavaMethod method); |
| |
| /** |
| * Determines if there may be a |
| * {@linkplain #getSubstitution(ResolvedJavaMethod, int, boolean, NodeSourcePosition) |
| * substitution graph} for a given method. |
| * |
| * A call to {@link #getSubstitution} may still return {@code null} for {@code method} and |
| * {@code invokeBci}. A substitution may be based on an {@link InvocationPlugin} that returns |
| * {@code false} for {@link InvocationPlugin#execute} making it impossible to create a |
| * substitute graph. |
| * |
| * @param invokeBci the call site BCI if this request is made for inlining a substitute |
| * otherwise {@code -1} |
| * @return true iff there may be a substitution graph available for {@code method} |
| */ |
| boolean hasSubstitution(ResolvedJavaMethod method, int invokeBci); |
| |
| /** |
| * Gets the provider for accessing the bytecode of a substitution method if no other provider is |
| * associated with the substitution method. |
| */ |
| BytecodeProvider getDefaultReplacementBytecodeProvider(); |
| |
| /** |
| * Register snippet templates. |
| */ |
| void registerSnippetTemplateCache(SnippetTemplateCache snippetTemplates); |
| |
| /** |
| * Get snippet templates that were registered with |
| * {@link Replacements#registerSnippetTemplateCache(SnippetTemplateCache)}. |
| */ |
| <T extends SnippetTemplateCache> T getSnippetTemplateCache(Class<T> templatesClass); |
| } |