/*

 * Copyright (c) 2011, 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.  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 java.lang.invoke;

import jdk.internal.perf.PerfCounter;

import jdk.internal.vm.annotation.DontInline;

import jdk.internal.vm.annotation.Stable;

import sun.invoke.util.Wrapper;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

import java.lang.reflect.Method;

import java.util.Arrays;

import java.util.HashMap;

import static java.lang.invoke.LambdaForm.BasicType.*;

import static java.lang.invoke.MethodHandleNatives.Constants.REF_invokeStatic;

import static java.lang.invoke.MethodHandleStatics.*;

/**

 * The symbolic, non-executable form of a method handle's invocation semantics.

 * It consists of a series of names.

 * The first N (N=arity) names are parameters,

 * while any remaining names are temporary values.

 * Each temporary specifies the application of a function to some arguments.

 * The functions are method handles, while the arguments are mixes of

 * constant values and local names.

 * The result of the lambda is defined as one of the names, often the last one.

 * <p>

 * Here is an approximate grammar:

 * <blockquote><pre>{@code

 * LambdaForm = "(" ArgName* ")=>{" TempName* Result "}"

 * ArgName = "a" N ":" T

 * TempName = "t" N ":" T "=" Function "(" Argument* ");"

 * Function = ConstantValue

 * Argument = NameRef | ConstantValue

 * Result = NameRef | "void"

 * NameRef = "a" N | "t" N

 * N = (any whole number)

 * T = "L" | "I" | "J" | "F" | "D" | "V"

 * }</pre></blockquote>

 * Names are numbered consecutively from left to right starting at zero.

 * (The letters are merely a taste of syntax sugar.)

 * Thus, the first temporary (if any) is always numbered N (where N=arity).

 * Every occurrence of a name reference in an argument list must refer to

 * a name previously defined within the same lambda.

 * A lambda has a void result if and only if its result index is -1.

 * If a temporary has the type "V", it cannot be the subject of a NameRef,

 * even though possesses a number.

 * Note that all reference types are erased to "L", which stands for {@code Object}.

 * All subword types (boolean, byte, short, char) are erased to "I" which is {@code int}.

 * The other types stand for the usual primitive types.

 * <p>

 * Function invocation closely follows the static rules of the Java verifier.

 * Arguments and return values must exactly match when their "Name" types are

 * considered.

 * Conversions are allowed only if they do not change the erased type.

 * <ul>

 * <li>L = Object: casts are used freely to convert into and out of reference types

 * <li>I = int: subword types are forcibly narrowed when passed as arguments (see {@code explicitCastArguments})

 * <li>J = long: no implicit conversions

 * <li>F = float: no implicit conversions

 * <li>D = double: no implicit conversions

 * <li>V = void: a function result may be void if and only if its Name is of type "V"

 * </ul>

 * Although implicit conversions are not allowed, explicit ones can easily be

 * encoded by using temporary expressions which call type-transformed identity functions.

 * <p>

 * Examples:

 * <blockquote><pre>{@code

 * (a0:J)=>{ a0 }

 *     == identity(long)

 * (a0:I)=>{ t1:V = System.out#println(a0); void }

 *     == System.out#println(int)

 * (a0:L)=>{ t1:V = System.out#println(a0); a0 }

 *     == identity, with printing side-effect

 * (a0:L, a1:L)=>{ t2:L = BoundMethodHandle#argument(a0);

 *                 t3:L = BoundMethodHandle#target(a0);

 *                 t4:L = MethodHandle#invoke(t3, t2, a1); t4 }

 *     == general invoker for unary insertArgument combination

 * (a0:L, a1:L)=>{ t2:L = FilterMethodHandle#filter(a0);

 *                 t3:L = MethodHandle#invoke(t2, a1);

 *                 t4:L = FilterMethodHandle#target(a0);

 *                 t5:L = MethodHandle#invoke(t4, t3); t5 }

 *     == general invoker for unary filterArgument combination

 * (a0:L, a1:L)=>{ ...(same as previous example)...

 *                 t5:L = MethodHandle#invoke(t4, t3, a1); t5 }

 *     == general invoker for unary/unary foldArgument combination

 * (a0:L, a1:I)=>{ t2:I = identity(long).asType((int)->long)(a1); t2 }

 *     == invoker for identity method handle which performs i2l

 * (a0:L, a1:L)=>{ t2:L = BoundMethodHandle#argument(a0);

 *                 t3:L = Class#cast(t2,a1); t3 }

 *     == invoker for identity method handle which performs cast

 * }</pre></blockquote>

 * <p>

 * @author John Rose, JSR 292 EG

 */

class LambdaForm {

    final int arity;

    final int result;

    final boolean forceInline;

    final MethodHandle customized;

    @Stable final Name[] names;

    final Kind kind;

    MemberName vmentry;   // low-level behavior, or null if not yet prepared

    private boolean isCompiled;

    // Either a LambdaForm cache (managed by LambdaFormEditor) or a link to uncustomized version (for customized LF)

    volatile Object transformCache;

    public static final int VOID_RESULT = -1, LAST_RESULT = -2;

    enum BasicType {

        L_TYPE('L', Object.class, Wrapper.OBJECT),  // all reference types

        I_TYPE('I', int.class,    Wrapper.INT),

        J_TYPE('J', long.class,   Wrapper.LONG),

        F_TYPE('F', float.class,  Wrapper.FLOAT),

        D_TYPE('D', double.class, Wrapper.DOUBLE),  // all primitive types

        V_TYPE('V', void.class,   Wrapper.VOID);    // not valid in all contexts

        static final @Stable BasicType[] ALL_TYPES = BasicType.values();

        static final @Stable BasicType[] ARG_TYPES = Arrays.copyOf(ALL_TYPES, ALL_TYPES.length-1);

        static final int ARG_TYPE_LIMIT = ARG_TYPES.length;

        static final int TYPE_LIMIT = ALL_TYPES.length;

        // Derived int constants, which (unlike the enums) can be constant folded.

        // We can remove them when JDK-8161245 is fixed.

        static final byte

                L_TYPE_NUM = (byte) L_TYPE.ordinal(),

                I_TYPE_NUM = (byte) I_TYPE.ordinal(),

                J_TYPE_NUM = (byte) J_TYPE.ordinal(),

                F_TYPE_NUM = (byte) F_TYPE.ordinal(),

                D_TYPE_NUM = (byte) D_TYPE.ordinal(),

                V_TYPE_NUM = (byte) V_TYPE.ordinal();

        final char btChar;

        final Class<?> btClass;

        final Wrapper btWrapper;

        private BasicType(char btChar, Class<?> btClass, Wrapper wrapper) {

            this.btChar = btChar;

            this.btClass = btClass;

            this.btWrapper = wrapper;

        }

        char basicTypeChar() {

            return btChar;

        }

        Class<?> basicTypeClass() {

            return btClass;

        }

        Wrapper basicTypeWrapper() {

            return btWrapper;

        }

        int basicTypeSlots() {

            return btWrapper.stackSlots();

        }

        static BasicType basicType(byte type) {

            return ALL_TYPES[type];

        }

        static BasicType basicType(char type) {

            switch (type) {

                case 'L': return L_TYPE;

                case 'I': return I_TYPE;

                case 'J': return J_TYPE;

                case 'F': return F_TYPE;

                case 'D': return D_TYPE;

                case 'V': return V_TYPE;

                // all subword types are represented as ints

                case 'Z':

                case 'B':

                case 'S':

                case 'C':

                    return I_TYPE;

                default:

                    throw newInternalError("Unknown type char: '"+type+"'");

            }

        }

        static BasicType basicType(Wrapper type) {

            char c = type.basicTypeChar();

            return basicType(c);

        }

        static BasicType basicType(Class<?> type) {

            if (!type.isPrimitive())  return L_TYPE;

            return basicType(Wrapper.forPrimitiveType(type));

        }

        static BasicType[] basicTypes(String types) {

            BasicType[] btypes = new BasicType[types.length()];

            for (int i = 0; i < btypes.length; i++) {

                btypes[i] = basicType(types.charAt(i));

            }

            return btypes;

        }

        static String basicTypeDesc(BasicType[] types) {

            if (types == null) {

                return null;

            }

            if (types.length == 0) {

                return "";

            }

            StringBuilder sb = new StringBuilder();

            for (BasicType bt : types) {

                sb.append(bt.basicTypeChar());

            }

            return sb.toString();

        }

        static int[] basicTypeOrds(BasicType[] types) {

            if (types == null) {

                return null;

            }

            int[] a = new int[types.length];

            for(int i = 0; i < types.length; ++i) {

                a[i] = types[i].ordinal();

            }

            return a;

        }

        static char basicTypeChar(Class<?> type) {

            return basicType(type).btChar;

        }

        static byte[] basicTypesOrd(Class<?>[] types) {

            byte[] ords = new byte[types.length];

            for (int i = 0; i < ords.length; i++) {

                ords[i] = (byte)basicType(types[i]).ordinal();

            }

            return ords;

        }

        static boolean isBasicTypeChar(char c) {

            return "LIJFDV".indexOf(c) >= 0;

        }

        static boolean isArgBasicTypeChar(char c) {

            return "LIJFD".indexOf(c) >= 0;

        }

        static { assert(checkBasicType()); }

        private static boolean checkBasicType() {

            for (int i = 0; i < ARG_TYPE_LIMIT; i++) {

                assert ARG_TYPES[i].ordinal() == i;

                assert ARG_TYPES[i] == ALL_TYPES[i];

            }

            for (int i = 0; i < TYPE_LIMIT; i++) {

                assert ALL_TYPES[i].ordinal() == i;

            }

            assert ALL_TYPES[TYPE_LIMIT - 1] == V_TYPE;

            assert !Arrays.asList(ARG_TYPES).contains(V_TYPE);

            return true;

        }

    }

    enum Kind {

        GENERIC("invoke"),

        ZERO("zero"),

        IDENTITY("identity"),

        BOUND_REINVOKER("BMH.reinvoke", "reinvoke"),

        REINVOKER("MH.reinvoke", "reinvoke"),

        DELEGATE("MH.delegate", "delegate"),

        EXACT_LINKER("MH.invokeExact_MT", "invokeExact_MT"),

        EXACT_INVOKER("MH.exactInvoker", "exactInvoker"),

        GENERIC_LINKER("MH.invoke_MT", "invoke_MT"),

        GENERIC_INVOKER("MH.invoker", "invoker"),

        LINK_TO_TARGET_METHOD("linkToTargetMethod"),

        LINK_TO_CALL_SITE("linkToCallSite"),

        DIRECT_INVOKE_VIRTUAL("DMH.invokeVirtual", "invokeVirtual"),

        DIRECT_INVOKE_SPECIAL("DMH.invokeSpecial", "invokeSpecial"),

        DIRECT_INVOKE_SPECIAL_IFC("DMH.invokeSpecialIFC", "invokeSpecialIFC"),

        DIRECT_INVOKE_STATIC("DMH.invokeStatic", "invokeStatic"),

        DIRECT_NEW_INVOKE_SPECIAL("DMH.newInvokeSpecial", "newInvokeSpecial"),

        DIRECT_INVOKE_INTERFACE("DMH.invokeInterface", "invokeInterface"),

        DIRECT_INVOKE_STATIC_INIT("DMH.invokeStaticInit", "invokeStaticInit"),

        GET_INT("getInt"),

        PUT_INT("putInt"),

        GET_INT_VOLATILE("getIntVolatile"),

        PUT_INT_VOLATILE("putIntVolatile"),

        GET_BOOLEAN("getBoolean"),

        PUT_BOOLEAN("putBoolean"),

        GET_BOOLEAN_VOLATILE("getBooleanVolatile"),

        PUT_BOOLEAN_VOLATILE("putBooleanVolatile"),

        GET_BYTE("getByte"),

        PUT_BYTE("putByte"),

        GET_BYTE_VOLATILE("getByteVolatile"),

        PUT_BYTE_VOLATILE("putByteVolatile"),

        GET_CHAR("getChar"),

        PUT_CHAR("putChar"),

        GET_CHAR_VOLATILE("getCharVolatile"),

        PUT_CHAR_VOLATILE("putCharVolatile"),

        GET_SHORT("getShort"),

        PUT_SHORT("putShort"),

        GET_SHORT_VOLATILE("getShortVolatile"),

        PUT_SHORT_VOLATILE("putShortVolatile"),

        GET_LONG("getLong"),

        PUT_LONG("putLong"),

        GET_LONG_VOLATILE("getLongVolatile"),

        PUT_LONG_VOLATILE("putLongVolatile"),

        GET_FLOAT("getFloat"),

        PUT_FLOAT("putFloat"),

        GET_FLOAT_VOLATILE("getFloatVolatile"),

        PUT_FLOAT_VOLATILE("putFloatVolatile"),

        GET_DOUBLE("getDouble"),

        PUT_DOUBLE("putDouble"),

        GET_DOUBLE_VOLATILE("getDoubleVolatile"),

        PUT_DOUBLE_VOLATILE("putDoubleVolatile"),

        TRY_FINALLY("tryFinally"),

        COLLECT("collect"),

        CONVERT("convert"),

        SPREAD("spread"),

        LOOP("loop"),

        FIELD("field"),

        GUARD("guard"),

        GUARD_WITH_CATCH("guardWithCatch"),

        VARHANDLE_EXACT_INVOKER("VH.exactInvoker"),

        VARHANDLE_INVOKER("VH.invoker", "invoker"),

        VARHANDLE_LINKER("VH.invoke_MT", "invoke_MT");

        final String defaultLambdaName;

        final String methodName;

        private Kind(String defaultLambdaName) {

            this(defaultLambdaName, defaultLambdaName);

        }

        private Kind(String defaultLambdaName, String methodName) {

            this.defaultLambdaName = defaultLambdaName;

            this.methodName = methodName;

        }

    }

    LambdaForm(int arity, Name[] names, int result) {

        this(arity, names, result, /*forceInline=*/true, /*customized=*/null, Kind.GENERIC);

    }

    LambdaForm(int arity, Name[] names, int result, Kind kind) {

        this(arity, names, result, /*forceInline=*/true, /*customized=*/null, kind);

    }

    LambdaForm(int arity, Name[] names, int result, boolean forceInline, MethodHandle customized) {

        this(arity, names, result, forceInline, customized, Kind.GENERIC);

    }

    LambdaForm(int arity, Name[] names, int result, boolean forceInline, MethodHandle customized, Kind kind) {

        assert(namesOK(arity, names));

        this.arity = arity;

        this.result = fixResult(result, names);

        this.names = names.clone();

        this.forceInline = forceInline;

        this.customized = customized;

        this.kind = kind;

        int maxOutArity = normalize();

        if (maxOutArity > MethodType.MAX_MH_INVOKER_ARITY) {

            // Cannot use LF interpreter on very high arity expressions.

            assert(maxOutArity <= MethodType.MAX_JVM_ARITY);

            compileToBytecode();

        }

    }

    LambdaForm(int arity, Name[] names) {

        this(arity, names, LAST_RESULT, /*forceInline=*/true, /*customized=*/null, Kind.GENERIC);

    }

    LambdaForm(int arity, Name[] names, Kind kind) {

        this(arity, names, LAST_RESULT, /*forceInline=*/true, /*customized=*/null, kind);

    }

    LambdaForm(int arity, Name[] names, boolean forceInline) {

        this(arity, names, LAST_RESULT, forceInline, /*customized=*/null, Kind.GENERIC);

    }

    LambdaForm(int arity, Name[] names, boolean forceInline, Kind kind) {

        this(arity, names, LAST_RESULT, forceInline, /*customized=*/null, kind);

    }

    LambdaForm(Name[] formals, Name[] temps, Name result) {

        this(formals.length, buildNames(formals, temps, result), LAST_RESULT, /*forceInline=*/true, /*customized=*/null);

    }

    LambdaForm(Name[] formals, Name[] temps, Name result, boolean forceInline) {

        this(formals.length, buildNames(formals, temps, result), LAST_RESULT, forceInline, /*customized=*/null);

    }

    private static Name[] buildNames(Name[] formals, Name[] temps, Name result) {

        int arity = formals.length;

        int length = arity + temps.length + (result == null ? 0 : 1);

        Name[] names = Arrays.copyOf(formals, length);

        System.arraycopy(temps, 0, names, arity, temps.length);

        if (result != null)

            names[length - 1] = result;

        return names;

    }

    private LambdaForm(MethodType mt) {

        // Make a blank lambda form, which returns a constant zero or null.

        // It is used as a template for managing the invocation of similar forms that are non-empty.

        // Called only from getPreparedForm.

        this.arity = mt.parameterCount();

        this.result = (mt.returnType() == void.class || mt.returnType() == Void.class) ? -1 : arity;

        this.names = buildEmptyNames(arity, mt, result == -1);

        this.forceInline = true;

        this.customized = null;

        this.kind = Kind.ZERO;

        assert(nameRefsAreLegal());

        assert(isEmpty());

        String sig = null;

        assert(isValidSignature(sig = basicTypeSignature()));

        assert(sig.equals(basicTypeSignature())) : sig + " != " + basicTypeSignature();

    }

    private static Name[] buildEmptyNames(int arity, MethodType mt, boolean isVoid) {

        Name[] names = arguments(isVoid ? 0 : 1, mt);

        if (!isVoid) {

            Name zero = new Name(constantZero(basicType(mt.returnType())));

            names[arity] = zero.newIndex(arity);

        }

        return names;

    }

    private static int fixResult(int result, Name[] names) {

        if (result == LAST_RESULT)

            result = names.length - 1;  // might still be void

        if (result >= 0 && names[result].type == V_TYPE)

            result = VOID_RESULT;

        return result;

    }

    static boolean debugNames() {

        return DEBUG_NAME_COUNTERS != null;

    }

    static void associateWithDebugName(LambdaForm form, String name) {

        assert (debugNames());

        synchronized (DEBUG_NAMES) {

            DEBUG_NAMES.put(form, name);

        }

    }

    String lambdaName() {

        if (DEBUG_NAMES != null) {

            synchronized (DEBUG_NAMES) {

                String name = DEBUG_NAMES.get(this);

                if (name == null) {

                    name = generateDebugName();

                }

                return name;

            }

        }

        return kind.defaultLambdaName;

    }

    private String generateDebugName() {

        assert (debugNames());

        String debugNameStem = kind.defaultLambdaName;

        Integer ctr = DEBUG_NAME_COUNTERS.getOrDefault(debugNameStem, 0);

        DEBUG_NAME_COUNTERS.put(debugNameStem, ctr + 1);

        StringBuilder buf = new StringBuilder(debugNameStem);

        int leadingZero = buf.length();

        buf.append((int) ctr);

        for (int i = buf.length() - leadingZero; i < 3; i++) {

            buf.insert(leadingZero, '0');

        }

        buf.append('_');

        buf.append(basicTypeSignature());

        String name = buf.toString();

        associateWithDebugName(this, name);

        return name;

    }

    private static boolean namesOK(int arity, Name[] names) {

        for (int i = 0; i < names.length; i++) {

            Name n = names[i];

            assert(n != null) : "n is null";

            if (i < arity)

                assert( n.isParam()) : n + " is not param at " + i;

            else

                assert(!n.isParam()) : n + " is param at " + i;

        }

        return true;

    }