/*

 * Copyright (c) 2015, 2018, 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.replacements;

import static jdk.vm.ci.code.MemoryBarriers.JMM_POST_VOLATILE_READ;

import static jdk.vm.ci.code.MemoryBarriers.JMM_POST_VOLATILE_WRITE;

import static jdk.vm.ci.code.MemoryBarriers.JMM_PRE_VOLATILE_READ;

import static jdk.vm.ci.code.MemoryBarriers.JMM_PRE_VOLATILE_WRITE;

import static jdk.vm.ci.code.MemoryBarriers.LOAD_LOAD;

import static jdk.vm.ci.code.MemoryBarriers.LOAD_STORE;

import static jdk.vm.ci.code.MemoryBarriers.STORE_LOAD;

import static jdk.vm.ci.code.MemoryBarriers.STORE_STORE;

import static org.graalvm.compiler.nodes.NamedLocationIdentity.OFF_HEAP_LOCATION;

import static org.graalvm.compiler.serviceprovider.GraalServices.Java8OrEarlier;

import java.lang.reflect.Array;

import java.lang.reflect.Field;

import java.util.Arrays;

import org.graalvm.compiler.api.directives.GraalDirectives;

import org.graalvm.compiler.api.replacements.SnippetReflectionProvider;

import org.graalvm.compiler.bytecode.BytecodeProvider;

import org.graalvm.compiler.core.common.calc.Condition;

import org.graalvm.compiler.core.common.calc.Condition.CanonicalizedCondition;

import org.graalvm.compiler.core.common.calc.UnsignedMath;

import org.graalvm.compiler.core.common.type.ObjectStamp;

import org.graalvm.compiler.core.common.type.Stamp;

import org.graalvm.compiler.core.common.type.StampFactory;

import org.graalvm.compiler.core.common.type.TypeReference;

import org.graalvm.compiler.debug.GraalError;

import org.graalvm.compiler.graph.Edges;

import org.graalvm.compiler.graph.Node;

import org.graalvm.compiler.graph.NodeList;

import org.graalvm.compiler.nodes.ConstantNode;

import org.graalvm.compiler.nodes.DeoptimizeNode;

import org.graalvm.compiler.nodes.FixedGuardNode;

import org.graalvm.compiler.nodes.LogicNode;

import org.graalvm.compiler.nodes.NodeView;

import org.graalvm.compiler.nodes.StructuredGraph;

import org.graalvm.compiler.nodes.ValueNode;

import org.graalvm.compiler.nodes.calc.AbsNode;

import org.graalvm.compiler.nodes.calc.CompareNode;

import org.graalvm.compiler.nodes.calc.ConditionalNode;

import org.graalvm.compiler.nodes.calc.FloatEqualsNode;

import org.graalvm.compiler.nodes.calc.IntegerEqualsNode;

import org.graalvm.compiler.nodes.calc.NarrowNode;

import org.graalvm.compiler.nodes.calc.ReinterpretNode;

import org.graalvm.compiler.nodes.calc.RightShiftNode;

import org.graalvm.compiler.nodes.calc.SignExtendNode;

import org.graalvm.compiler.nodes.calc.SqrtNode;

import org.graalvm.compiler.nodes.calc.UnsignedDivNode;

import org.graalvm.compiler.nodes.calc.UnsignedRemNode;

import org.graalvm.compiler.nodes.calc.ZeroExtendNode;

import org.graalvm.compiler.nodes.debug.BindToRegisterNode;

import org.graalvm.compiler.nodes.debug.BlackholeNode;

import org.graalvm.compiler.nodes.debug.ControlFlowAnchorNode;

import org.graalvm.compiler.nodes.debug.OpaqueNode;

import org.graalvm.compiler.nodes.debug.SpillRegistersNode;

import org.graalvm.compiler.nodes.extended.BoxNode;

import org.graalvm.compiler.nodes.extended.BranchProbabilityNode;

import org.graalvm.compiler.nodes.extended.GetClassNode;

import org.graalvm.compiler.nodes.extended.MembarNode;

import org.graalvm.compiler.nodes.extended.RawLoadNode;

import org.graalvm.compiler.nodes.extended.RawStoreNode;

import org.graalvm.compiler.nodes.extended.UnboxNode;

import org.graalvm.compiler.nodes.extended.UnsafeMemoryLoadNode;

import org.graalvm.compiler.nodes.extended.UnsafeMemoryStoreNode;

import org.graalvm.compiler.nodes.graphbuilderconf.GraphBuilderContext;

import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin;

import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugin.Receiver;

import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins;

import org.graalvm.compiler.nodes.graphbuilderconf.InvocationPlugins.Registration;

import org.graalvm.compiler.nodes.java.ClassIsAssignableFromNode;

import org.graalvm.compiler.nodes.java.DynamicNewArrayNode;

import org.graalvm.compiler.nodes.java.DynamicNewInstanceNode;

import org.graalvm.compiler.nodes.java.InstanceOfDynamicNode;

import org.graalvm.compiler.nodes.java.LoadFieldNode;

import org.graalvm.compiler.nodes.java.RegisterFinalizerNode;

import org.graalvm.compiler.nodes.java.UnsafeCompareAndExchangeNode;

import org.graalvm.compiler.nodes.java.UnsafeCompareAndSwapNode;

import org.graalvm.compiler.nodes.util.GraphUtil;

import org.graalvm.compiler.nodes.virtual.EnsureVirtualizedNode;

import org.graalvm.compiler.replacements.nodes.ReverseBytesNode;

import org.graalvm.compiler.replacements.nodes.VirtualizableInvokeMacroNode;

import org.graalvm.compiler.replacements.nodes.arithmetic.IntegerAddExactNode;

import org.graalvm.compiler.replacements.nodes.arithmetic.IntegerMulExactNode;

import org.graalvm.compiler.replacements.nodes.arithmetic.IntegerSubExactNode;

import jdk.internal.vm.compiler.word.LocationIdentity;

import jdk.vm.ci.code.BytecodePosition;

import jdk.vm.ci.meta.DeoptimizationAction;

import jdk.vm.ci.meta.DeoptimizationReason;

import jdk.vm.ci.meta.JavaConstant;

import jdk.vm.ci.meta.JavaKind;

import jdk.vm.ci.meta.MetaAccessProvider;

import jdk.vm.ci.meta.ResolvedJavaField;

import jdk.vm.ci.meta.ResolvedJavaMethod;

import jdk.vm.ci.meta.ResolvedJavaType;

import jdk.vm.ci.meta.SpeculationLog;

import sun.misc.Unsafe;

/**

 * Provides non-runtime specific {@link InvocationPlugin}s.

 */

public class StandardGraphBuilderPlugins {

    public static void registerInvocationPlugins(MetaAccessProvider metaAccess, SnippetReflectionProvider snippetReflection, InvocationPlugins plugins, BytecodeProvider bytecodeProvider,

        registerObjectPlugins(plugins);

        registerClassPlugins(plugins);

        registerMathPlugins(plugins, allowDeoptimization);

        registerUnsignedMathPlugins(plugins);

        registerStringPlugins(plugins, bytecodeProvider, snippetReflection);

        registerCharacterPlugins(plugins);

        registerShortPlugins(plugins);

        registerIntegerLongPlugins(plugins, JavaKind.Int);

        registerIntegerLongPlugins(plugins, JavaKind.Long);

        registerFloatPlugins(plugins);

        registerDoublePlugins(plugins);

        registerArraysPlugins(plugins, bytecodeProvider);

        registerArrayPlugins(plugins, bytecodeProvider);

        registerEdgesPlugins(metaAccess, plugins);

        registerGraalDirectivesPlugins(plugins);

        registerBoxingPlugins(plugins);

        registerJMHBlackholePlugins(plugins, bytecodeProvider);

        registerJFRThrowablePlugins(plugins, bytecodeProvider);

        registerMethodHandleImplPlugins(plugins, snippetReflection, bytecodeProvider);

        registerJcovCollectPlugins(plugins, bytecodeProvider);

    }

    private static final Field STRING_VALUE_FIELD;

    static {

        try {

            STRING_VALUE_FIELD = String.class.getDeclaredField("value");

        } catch (NoSuchFieldException e) {

            throw new GraalError(e);

        }

    }

    private static void registerStringPlugins(InvocationPlugins plugins, BytecodeProvider bytecodeProvider, SnippetReflectionProvider snippetReflection) {

        final Registration r = new Registration(plugins, String.class, bytecodeProvider);

        r.register1("hashCode", Receiver.class, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver) {

                if (receiver.isConstant()) {

                    String s = snippetReflection.asObject(String.class, (JavaConstant) receiver.get().asConstant());

                    b.addPush(JavaKind.Int, b.add(ConstantNode.forInt(s.hashCode())));

                    return true;

                }

                return false;

            }

        });

        if (Java8OrEarlier) {

            r.registerMethodSubstitution(StringSubstitutions.class, "equals", Receiver.class, Object.class);

            r.register7("indexOf", char[].class, int.class, int.class, char[].class, int.class, int.class, int.class, new StringIndexOfConstantPlugin());

            Registration sr = new Registration(plugins, StringSubstitutions.class);

            sr.register1("getValue", String.class, new InvocationPlugin() {

                @Override

                public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) {

                    ResolvedJavaField field = b.getMetaAccess().lookupJavaField(STRING_VALUE_FIELD);

                    b.addPush(JavaKind.Object, LoadFieldNode.create(b.getConstantFieldProvider(), b.getConstantReflection(), b.getMetaAccess(),

                                    b.getOptions(), b.getAssumptions(), value, field, false, false));

                    return true;

                }

            });

        }

    }

    private static void registerArraysPlugins(InvocationPlugins plugins, BytecodeProvider bytecodeProvider) {

        Registration r = new Registration(plugins, Arrays.class, bytecodeProvider);

        r.registerMethodSubstitution(ArraysSubstitutions.class, "equals", boolean[].class, boolean[].class);

        r.registerMethodSubstitution(ArraysSubstitutions.class, "equals", byte[].class, byte[].class);

        r.registerMethodSubstitution(ArraysSubstitutions.class, "equals", short[].class, short[].class);

        r.registerMethodSubstitution(ArraysSubstitutions.class, "equals", char[].class, char[].class);

        r.registerMethodSubstitution(ArraysSubstitutions.class, "equals", int[].class, int[].class);

        r.registerMethodSubstitution(ArraysSubstitutions.class, "equals", long[].class, long[].class);

    }

    private static void registerArrayPlugins(InvocationPlugins plugins, BytecodeProvider bytecodeProvider) {

        Registration r = new Registration(plugins, Array.class, bytecodeProvider);

        r.register2("newInstance", Class.class, int.class, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver unused, ValueNode componentType, ValueNode length) {

                b.addPush(JavaKind.Object, new DynamicNewArrayNode(componentType, length, true));

                return true;

            }

        });

        r.registerMethodSubstitution(ArraySubstitutions.class, "getLength", Object.class);

    }

    private abstract static class UnsafeCompareAndUpdatePluginsRegistrar {

            for (JavaKind kind : compareAndSwapTypes) {

                Class<?> javaClass = kind == JavaKind.Object ? Object.class : kind.toJavaClass();

                    @Override

                    public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver unsafe, ValueNode object, ValueNode offset, ValueNode expected, ValueNode x) {

                        // Emits a null-check for the otherwise unused receiver

                        unsafe.get();

                        return true;

                    }

                });

            }

        }

        public abstract JavaKind returnKind(JavaKind accessKind);

    }

    private static class UnsafeCompareAndSwapPluginsRegistrar extends UnsafeCompareAndUpdatePluginsRegistrar {

        @Override

        }

        @Override

        public JavaKind returnKind(JavaKind accessKind) {

            return JavaKind.Boolean.getStackKind();

        }

    }

    private static UnsafeCompareAndSwapPluginsRegistrar unsafeCompareAndSwapPluginsRegistrar = new UnsafeCompareAndSwapPluginsRegistrar();

    private static class UnsafeCompareAndExchangePluginsRegistrar extends UnsafeCompareAndUpdatePluginsRegistrar {

        @Override

        }

        @Override

        public JavaKind returnKind(JavaKind accessKind) {

            if (accessKind.isNumericInteger()) {

                return accessKind.getStackKind();

            } else {

                return accessKind;

            }

        }

    }

    private static UnsafeCompareAndExchangePluginsRegistrar unsafeCompareAndExchangePluginsRegistrar = new UnsafeCompareAndExchangePluginsRegistrar();

        if (!Java8OrEarlier) {

        }

    }

        if (java8OrEarlier) {

        } else {

        }

    }

        if (!Java8OrEarlier) {

        }

    }

        for (JavaKind kind : JavaKind.values()) {

            if ((kind.isPrimitive() && kind != JavaKind.Void) || kind == JavaKind.Object) {

                Class<?> javaClass = kind == JavaKind.Object ? Object.class : kind.toJavaClass();

                String kindName = kind.name();

                String getName = "get" + kindName;

                String putName = "put" + kindName;

                // Object-based accesses

                // Volatile object-based accesses

                // Ordered object-based accesses

                if (java8OrEarlier) {

                    if (kind == JavaKind.Int || kind == JavaKind.Long || kind == JavaKind.Object) {

                    }

                } else {

                }

                if (kind != JavaKind.Boolean && kind != JavaKind.Object) {

                    // Raw accesses to memory addresses

                }

            }

        }

        // Accesses to native memory addresses.

        r.register2("allocateInstance", Receiver.class, Class.class, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver unsafe, ValueNode clazz) {

                // Emits a null-check for the otherwise unused receiver

                unsafe.get();

                b.addPush(JavaKind.Object, new DynamicNewInstanceNode(b.nullCheckedValue(clazz, DeoptimizationAction.None), true));

                return true;

            }

        });

        r.register1("loadFence", Receiver.class, new UnsafeFencePlugin(LOAD_LOAD | LOAD_STORE));

        r.register1("storeFence", Receiver.class, new UnsafeFencePlugin(STORE_STORE | LOAD_STORE));

        r.register1("fullFence", Receiver.class, new UnsafeFencePlugin(LOAD_LOAD | STORE_STORE | LOAD_STORE | STORE_LOAD));

    }

    private static void registerIntegerLongPlugins(InvocationPlugins plugins, JavaKind kind) {

        Class<?> declaringClass = kind.toBoxedJavaClass();

        Class<?> type = kind.toJavaClass();

        Registration r = new Registration(plugins, declaringClass);

        r.register1("reverseBytes", type, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) {

                b.push(kind, b.append(new ReverseBytesNode(value).canonical(null)));

                return true;

            }

        });

        r.register2("divideUnsigned", type, type, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode dividend, ValueNode divisor) {

                b.push(kind, b.append(UnsignedDivNode.create(dividend, divisor, null, NodeView.DEFAULT)));

                return true;

            }

        });

        r.register2("remainderUnsigned", type, type, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode dividend, ValueNode divisor) {

                b.push(kind, b.append(UnsignedRemNode.create(dividend, divisor, null, NodeView.DEFAULT)));

                return true;

            }

        });

    }

    private static void registerCharacterPlugins(InvocationPlugins plugins) {

        Registration r = new Registration(plugins, Character.class);

        r.register1("reverseBytes", char.class, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) {

                // return (char) (Integer.reverse(i) >> 16);

                ReverseBytesNode reverse = b.add(new ReverseBytesNode(value));

                RightShiftNode rightShift = b.add(new RightShiftNode(reverse, b.add(ConstantNode.forInt(16))));

                ZeroExtendNode charCast = b.add(new ZeroExtendNode(b.add(new NarrowNode(rightShift, 16)), 32));

                b.push(JavaKind.Char, b.append(charCast.canonical(null)));

                return true;

            }

        });

    }

    private static void registerShortPlugins(InvocationPlugins plugins) {

        Registration r = new Registration(plugins, Short.class);

        r.register1("reverseBytes", short.class, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) {

                // return (short) (Integer.reverse(i) >> 16);

                ReverseBytesNode reverse = b.add(new ReverseBytesNode(value));

                RightShiftNode rightShift = b.add(new RightShiftNode(reverse, b.add(ConstantNode.forInt(16))));

                SignExtendNode charCast = b.add(new SignExtendNode(b.add(new NarrowNode(rightShift, 16)), 32));

                b.push(JavaKind.Short, b.append(charCast.canonical(null)));

                return true;

            }

        });

    }

    private static void registerFloatPlugins(InvocationPlugins plugins) {

        Registration r = new Registration(plugins, Float.class);

        r.register1("floatToRawIntBits", float.class, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) {

                b.push(JavaKind.Int, b.append(ReinterpretNode.create(JavaKind.Int, value, NodeView.DEFAULT)));

                return true;

            }

        });

        r.register1("floatToIntBits", float.class, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) {

                LogicNode notNan = b.append(FloatEqualsNode.create(value, value, NodeView.DEFAULT));

                ValueNode raw = b.append(ReinterpretNode.create(JavaKind.Int, value, NodeView.DEFAULT));

                ValueNode result = b.append(ConditionalNode.create(notNan, raw, ConstantNode.forInt(0x7fc00000), NodeView.DEFAULT));

                b.push(JavaKind.Int, result);

                return true;

            }

        });

        r.register1("intBitsToFloat", int.class, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) {

                b.push(JavaKind.Float, b.append(ReinterpretNode.create(JavaKind.Float, value, NodeView.DEFAULT)));

                return true;

            }

        });

    }

    private static void registerDoublePlugins(InvocationPlugins plugins) {

        Registration r = new Registration(plugins, Double.class);

        r.register1("doubleToRawLongBits", double.class, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) {

                b.push(JavaKind.Long, b.append(ReinterpretNode.create(JavaKind.Long, value, NodeView.DEFAULT)));

                return true;

            }

        });

        r.register1("doubleToLongBits", double.class, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) {

                LogicNode notNan = b.append(FloatEqualsNode.create(value, value, NodeView.DEFAULT));

                ValueNode raw = b.append(ReinterpretNode.create(JavaKind.Long, value, NodeView.DEFAULT));

                ValueNode result = b.append(ConditionalNode.create(notNan, raw, ConstantNode.forLong(0x7ff8000000000000L), NodeView.DEFAULT));

                b.push(JavaKind.Long, result);

                return true;

            }

        });

        r.register1("longBitsToDouble", long.class, new InvocationPlugin() {

            @Override

            public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode value) {

                b.push(JavaKind.Double, b.append(ReinterpretNode.create(JavaKind.Double, value, NodeView.DEFAULT)));

                return true;

            }

        });

    }

    private static void registerMathPlugins(InvocationPlugins plugins, boolean allowDeoptimization) {

        Registration r = new Registration(plugins, Math.class);

        if (allowDeoptimization) {

            for (JavaKind kind : new JavaKind[]{JavaKind.Int, JavaKind.Long}) {

                Class<?> type = kind.toJavaClass();

                r.register1("decrementExact", type, new InvocationPlugin() {

                    @Override

                    public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode x) {

                        b.addPush(kind, new IntegerSubExactNode(x, ConstantNode.forIntegerKind(kind, 1)));

                        return true;

                    }

                });

                r.register1("incrementExact", type, new InvocationPlugin() {

                    @Override

                    public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode x) {

                        b.addPush(kind, new IntegerAddExactNode(x, ConstantNode.forIntegerKind(kind, 1)));

                        return true;

                    }

                });

                r.register2("addExact", type, type, new InvocationPlugin() {

                    @Override

                    public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode x, ValueNode y) {

                        b.addPush(kind, new IntegerAddExactNode(x, y));

                        return true;

                    }

                });

                r.register2("subtractExact", type, type, new InvocationPlugin() {

                    @Override

                    public boolean apply(GraphBuilderContext b, ResolvedJavaMethod targetMethod, Receiver receiver, ValueNode x, ValueNode y) {

                        b.addPush(kind, new IntegerSubExactNode(x, y));

                        return true;

                    }

                });

                r.register2("multiplyExact", type, type, new InvocationPlugin() {

                    @Override