/*
 * Copyright (c) 2013, 2020, 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * 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.BytecodeProvider;
import org.graalvm.compiler.core.common.CompilationIdentifier;
import org.graalvm.compiler.debug.DebugContext;
import org.graalvm.compiler.graph.NodeSourcePosition;
import org.graalvm.compiler.nodes.Cancellable;
import org.graalvm.compiler.nodes.Invoke;
import org.graalvm.compiler.nodes.StructuredGraph;
import org.graalvm.compiler.nodes.StructuredGraph.AllowAssumptions;
import org.graalvm.compiler.nodes.graphbuilderconf.GeneratedPluginInjectionProvider;
import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration;
import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderPlugin;
import org.graalvm.compiler.nodes.graphbuilderconf.IntrinsicContext;
import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin;
import org.graalvm.compiler.nodes.graphbuilderconf.MethodSubstitutionPlugin;
import org.graalvm.compiler.options.OptionValues;

import jdk.vm.ci.meta.ResolvedJavaMethod;

Interface for managing replacements.
/**
 * Interface for managing replacements.
 */
public interface Replacements extends GeneratedPluginInjectionProvider {

    CoreProviders getProviders();

    
Gets the object managing the various graph builder plugins used by this object when parsing
bytecode into a graph.
/**
     * Gets the object managing the various graph builder plugins used by this object when parsing
     * bytecode into a graph.
     */
    GraphBuilderConfiguration.Plugins getGraphBuilderPlugins();

    
Gets the plugin type that intrinsifies calls to method. /**
     * Gets the plugin type that intrinsifies calls to {@code method}.
     */
    Class<? extends GraphBuilderPlugin> getIntrinsifyingPlugin(ResolvedJavaMethod method);

    
Gets the snippet graph derived from a given method.
Params:
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
trackNodeSourcePosition – 
options – 
Returns:
the snippet graph, if any, that is derived from method/**
     * 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
     * @param options
     * @return the snippet graph, if any, that is derived from {@code method}
     */
    StructuredGraph getSnippet(ResolvedJavaMethod method, ResolvedJavaMethod recursiveEntry, Object[] args, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition,
                    OptionValues options);

    
Get the snippet metadata required to inline the snippet.
/**
     * Get the snippet metadata required to inline the snippet.
     */
    SnippetParameterInfo getSnippetParameterInfo(ResolvedJavaMethod method);

    
Return true if the method is a Snippet. /**
     * Return true if the method is a {@link org.graalvm.compiler.api.replacements.Snippet}.
     */
    boolean isSnippet(ResolvedJavaMethod method);

    
Returns true if this Replacements is being used for preparation of snippets and substitutions for libgraal. /**
     * Returns {@code true} if this {@code Replacements} is being used for preparation of snippets
     * and substitutions for libgraal.
     */
    default boolean isEncodingSnippets() {
        return false;
    }

    
Registers a method as snippet.
/**
     * Registers a method as snippet.
     */
    void registerSnippet(ResolvedJavaMethod method, ResolvedJavaMethod original, Object receiver, boolean trackNodeSourcePosition, OptionValues options);

    
Gets a graph that is a substitution for a given plugin in the 
context. 
Params:
plugin – the plugin being substituted
original – the method being substituted
context – the kind of inlining to be performed for the substitution
allowAssumptions – 
cancellable – 
options – 
Returns:
the method substitution graph, if any, that is derived from method/**
     * Gets a graph that is a substitution for a given {@link MethodSubstitutionPlugin plugin} in
     * the {@link org.graalvm.compiler.nodes.graphbuilderconf.IntrinsicContext.CompilationContext
     * context}.
     *
     * @param plugin the plugin being substituted
     * @param original the method being substituted
     * @param context the kind of inlining to be performed for the substitution
     * @param allowAssumptions
     * @param cancellable
     * @param options
     * @return the method substitution graph, if any, that is derived from {@code method}
     */
    StructuredGraph getMethodSubstitution(MethodSubstitutionPlugin plugin, ResolvedJavaMethod original, IntrinsicContext.CompilationContext context,
                    AllowAssumptions allowAssumptions, Cancellable cancellable, OptionValues options);

    
Registers a plugin as a substitution.
/**
     * Registers a plugin as a substitution.
     */
    void registerMethodSubstitution(MethodSubstitutionPlugin plugin);

    
Marks a plugin as conditionally applied. In the contenxt of libgraal conditional plugins
can't be used in during graph encoding for snippets and method substitutions and this is used
to detect violations of this restriction.
/**
     * Marks a plugin as conditionally applied. In the contenxt of libgraal conditional plugins
     * can't be used in during graph encoding for snippets and method substitutions and this is used
     * to detect violations of this restriction.
     */
    void registerConditionalPlugin(InvocationPlugin plugin);

    
Gets a graph that is a substitution for a given method.
Params:
invokeBci – the call site BCI for the substitution
inlineControl – 
trackNodeSourcePosition – 
replaceePosition – 
allowAssumptions – 
options – 
Returns:
the graph, if any, that is a substitution for method/**
     * Gets a graph that is a substitution for a given method.
     *
     * @param invokeBci the call site BCI for the substitution
     * @param inlineControl
     * @param trackNodeSourcePosition
     * @param replaceePosition
     * @param allowAssumptions
     * @param options
     * @return the graph, if any, that is a substitution for {@code method}
     */
    StructuredGraph getInlineSubstitution(ResolvedJavaMethod method, int invokeBci, Invoke.InlineControl inlineControl, boolean trackNodeSourcePosition, NodeSourcePosition replaceePosition,
                    AllowAssumptions allowAssumptions, OptionValues options);

    
Gets a graph produced from the intrinsic for a given method that can be compiled and
installed for the method.
Params:
method – 
compilationId – 
debug – 
allowAssumptions – 
cancellable – 
Returns:
an intrinsic graph that can be compiled and installed for method or null/**
     * Gets a graph produced from the intrinsic for a given method that can be compiled and
     * installed for the method.
     *
     * @param method
     * @param compilationId
     * @param debug
     * @param allowAssumptions
     * @param cancellable
     * @return an intrinsic graph that can be compiled and installed for {@code method} or null
     */
    StructuredGraph getIntrinsicGraph(ResolvedJavaMethod method, CompilationIdentifier compilationId, DebugContext debug, AllowAssumptions allowAssumptions, Cancellable cancellable);

    
Determines if there may be a 
substitution graph for a given method. A call to getInlineSubstitution may still return null for method and substitution may be based on an InvocationPlugin that returns false for InvocationPlugin.execute making it impossible to create a substitute graph. 
Returns:
true iff there may be a substitution graph available for method/**
     * Determines if there may be a
     * {@linkplain #getInlineSubstitution(ResolvedJavaMethod, int, Invoke.InlineControl, boolean, NodeSourcePosition, AllowAssumptions, OptionValues)
     * substitution graph} for a given method.
     *
     * A call to {@link #getInlineSubstitution} may still return {@code null} for {@code method} and
     * substitution may be based on an {@link InvocationPlugin} that returns {@code false} for
     * {@link InvocationPlugin#execute} making it impossible to create a substitute graph.
     *
     * @return true iff there may be a substitution graph available for {@code method}
     */
    boolean hasSubstitution(ResolvedJavaMethod method);

    
Gets the provider for accessing the bytecode of a substitution method if no other provider is
associated with the substitution method.
/**
     * 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.
/**
     * Register snippet templates.
     */
    void registerSnippetTemplateCache(SnippetTemplateCache snippetTemplates);

    
Get snippet templates that were registered with registerSnippetTemplateCache(SnippetTemplateCache). /**
     * Get snippet templates that were registered with
     * {@link Replacements#registerSnippetTemplateCache(SnippetTemplateCache)}.
     */
    <T extends SnippetTemplateCache> T getSnippetTemplateCache(Class<T> templatesClass);

    
Notifies this method that no further snippets will be registered via registerSnippet or registerSnippetTemplateCache. This is a hook for an implementation to check for or forbid late registration. /**
     * Notifies this method that no further snippets will be registered via {@link #registerSnippet}
     * or {@link #registerSnippetTemplateCache}.
     *
     * This is a hook for an implementation to check for or forbid late registration.
     */
    default void closeSnippetRegistration() {
    }
}