1 /*
   2  * Copyright (c) 2013, 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.Bytecode;
  30 import org.graalvm.compiler.bytecode.BytecodeProvider;
  31 import org.graalvm.compiler.graph.NodeSourcePosition;
  32 import org.graalvm.compiler.nodes.StructuredGraph;
  33 import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration;
  34 import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin;
  35 import org.graalvm.compiler.options.OptionValues;
  36 
  37 import jdk.vm.ci.meta.ResolvedJavaMethod;
  38 
  39 /**
  40  * Interface for managing replacements.
  41  */
  42 public interface Replacements {
  43 
  44     OptionValues getOptions();
  45 
  46     /**
  47      * Gets the object managing the various graph builder plugins used by this object when parsing
  48      * bytecode into a graph.
  49      */
  50     GraphBuilderConfiguration.Plugins getGraphBuilderPlugins();
  51 
  52     /**
  53      * Gets the snippet graph derived from a given method.
  54      *
  55      * @param args arguments to the snippet if available, otherwise {@code null}
  56      * @param trackNodeSourcePosition
  57      * @return the snippet graph, if any, that is derived from {@code method}
  58      */
  59     StructuredGraph getSnippet(ResolvedJavaMethod method, Object[] args, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition);
  60 
  61     /**
  62      * Gets the snippet graph derived from a given method.
  63      *
  64      * @param recursiveEntry if the snippet contains a call to this method, it's considered as
  65      *            recursive call and won't be processed for {@linkplain MethodSubstitution
  66      *            substitutions}.
  67      * @param args arguments to the snippet if available, otherwise {@code null}
  68      * @param trackNodeSourcePosition
  69      * @return the snippet graph, if any, that is derived from {@code method}
  70      */
  71     StructuredGraph getSnippet(ResolvedJavaMethod method, ResolvedJavaMethod recursiveEntry, Object[] args, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition);
  72 
  73     /**
  74      * Registers a method as snippet.
  75      */
  76     void registerSnippet(ResolvedJavaMethod method, boolean trackNodeSourcePosition);
  77 
  78     /**
  79      * Gets a graph that is a substitution for a given method.
  80      *
  81      * @param invokeBci the call site BCI if this request is made for inlining a substitute
  82      *            otherwise {@code -1}
  83      * @param trackNodeSourcePosition
  84      * @return the graph, if any, that is a substitution for {@code method}
  85      */
  86     StructuredGraph getSubstitution(ResolvedJavaMethod method, int invokeBci, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition);
  87 
  88     /**
  89      * Gets the substitute bytecode for a given method.
  90      *
  91      * @return the bytecode to substitute for {@code method} or {@code null} if there is no
  92      *         substitute bytecode for {@code method}
  93      */
  94     Bytecode getSubstitutionBytecode(ResolvedJavaMethod method);
  95 
  96     /**
  97      * Determines if there may be a
  98      * {@linkplain #getSubstitution(ResolvedJavaMethod, int, boolean, NodeSourcePosition)
  99      * substitution graph} for a given method.
 100      *
 101      * A call to {@link #getSubstitution} may still return {@code null} for {@code method} and
 102      * {@code invokeBci}. A substitution may be based on an {@link InvocationPlugin} that returns
 103      * {@code false} for {@link InvocationPlugin#execute} making it impossible to create a
 104      * substitute graph.
 105      *
 106      * @param invokeBci the call site BCI if this request is made for inlining a substitute
 107      *            otherwise {@code -1}
 108      * @return true iff there may be a substitution graph available for {@code method}
 109      */
 110     boolean hasSubstitution(ResolvedJavaMethod method, int invokeBci);
 111 
 112     /**
 113      * Gets the provider for accessing the bytecode of a substitution method if no other provider is
 114      * associated with the substitution method.
 115      */
 116     BytecodeProvider getDefaultReplacementBytecodeProvider();
 117 
 118     /**
 119      * Register snippet templates.
 120      */
 121     void registerSnippetTemplateCache(SnippetTemplateCache snippetTemplates);
 122 
 123     /**
 124      * Get snippet templates that were registered with
 125      * {@link Replacements#registerSnippetTemplateCache(SnippetTemplateCache)}.
 126      */
 127     <T extends SnippetTemplateCache> T getSnippetTemplateCache(Class<T> templatesClass);
 128 }