/*

 * Copyright (c) 2009, 2010, 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.

 */

/* @test

 * @summary unit tests for java.dyn.MethodHandles

 * @compile -XDinvokedynamic MethodHandlesTest.java

 * @run junit/othervm -XX:+UnlockExperimentalVMOptions -XX:+EnableInvokeDynamic test.java.dyn.MethodHandlesTest

 */

package test.java.dyn;

import java.dyn.*;

import java.dyn.MethodHandles.Lookup;

import java.lang.reflect.*;

import java.util.*;

import org.junit.*;

import static org.junit.Assert.*;

import static org.junit.Assume.*;

/**

 *

 * @author jrose

 */

public class MethodHandlesTest {

    // How much output?

    static int verbosity = 0;

    static {

        String vstr = System.getProperty("test.java.dyn.MethodHandlesTest.verbosity");

        if (vstr != null)  verbosity = Integer.parseInt(vstr);

    }

    // Set this true during development if you want to fast-forward to

    // a particular new, non-working test.  Tests which are known to

    // work (or have recently worked) test this flag and return on true.

    static boolean CAN_SKIP_WORKING = false;

    //static { CAN_SKIP_WORKING = true; }

    // Set true to test more calls.  If false, some tests are just

    // lookups, without exercising the actual method handle.

    static boolean DO_MORE_CALLS = true;

    @Test

    public void testFirst() throws Throwable {

        verbosity += 9; try {

            // left blank for debugging

        } finally { printCounts(); verbosity -= 9; }

    }

    // current failures

    @Test @Ignore("failure in call to makeRawRetypeOnly in ToGeneric")

    public void testFail_1() throws Throwable {

        // AMH.<init>: IllegalArgumentException: bad adapter (conversion=0xfffab300): adapter pushes too many parameters

        testSpreadArguments(int.class, 0, 6);

    }

    @Test @Ignore("failure in JVM when expanding the stack using asm stub for _adapter_spread_args")

    public void testFail_2() throws Throwable {

        // if CONV_OP_IMPLEMENTED_MASK includes OP_SPREAD_ARGS, this crashes:

        testSpreadArguments(Object.class, 0, 2);

    }

    @Test @Ignore("IllArgEx failure in call to ToGeneric.make")

    public void testFail_3() throws Throwable {

        // ToGeneric.<init>: UnsupportedOperationException: NYI: primitive parameters must follow references; entryType = (int,java.lang.Object)java.lang.Object

        testSpreadArguments(int.class, 1, 2);

    }

    @Test @Ignore("IllArgEx failure in call to ToGeneric.make")

    public void testFail_4() throws Throwable {

        // ToGeneric.<init>: UnsupportedOperationException: NYI: primitive parameters must follow references; entryType = (int,java.lang.Object)java.lang.Object

        testCollectArguments(int.class, 1, 2);

    }

    @Test @Ignore("cannot collect leading primitive types")

    public void testFail_5() throws Throwable {

        // ToGeneric.<init>: UnsupportedOperationException: NYI: primitive parameters must follow references; entryType = (int,java.lang.Object)java.lang.Object

        testInvokers(MethodType.genericMethodType(2).changeParameterType(0, int.class));

    }

    @Test @Ignore("should not insert arguments beyond MethodHandlePushLimit")

    public void testFail_6() throws Throwable {

        // ValueConversions.varargsArray: UnsupportedOperationException: NYI: cannot form a varargs array of length 13

        testInsertArguments(0, 0, MAX_ARG_INCREASE+10);

    }

    static final int MAX_ARG_INCREASE = 3;

    public MethodHandlesTest() {

    }

    @Before

    public void checkImplementedPlatform() {

        boolean platformOK = false;

        Properties properties = System.getProperties();

        String vers = properties.getProperty("java.vm.version");

        String name = properties.getProperty("java.vm.name");

        String arch = properties.getProperty("os.arch");

        if ((arch.equals("amd64") || arch.equals("i386") || arch.equals("x86") ||

             arch.equals("sparc") || arch.equals("sparcv9")) &&

            (name.contains("Client") || name.contains("Server"))

            ) {

            platformOK = true;

        } else {

            System.err.println("Skipping tests for unsupported platform: "+Arrays.asList(vers, name, arch));

        }

        assumeTrue(platformOK);

    }

    String testName;

    static int allPosTests, allNegTests;

    int posTests, negTests;

    @After

    public void printCounts() {

        if (verbosity >= 2 && (posTests | negTests) != 0) {

            System.out.println();

            if (posTests != 0)  System.out.println("=== "+testName+": "+posTests+" positive test cases run");

            if (negTests != 0)  System.out.println("=== "+testName+": "+negTests+" negative test cases run");

            allPosTests += posTests;

            allNegTests += negTests;

            posTests = negTests = 0;

        }

    }

    void countTest(boolean positive) {

        if (positive) ++posTests;

        else          ++negTests;

    }

    void countTest() { countTest(true); }

    void startTest(String name) {

        if (testName != null)  printCounts();

        if (verbosity >= 1)

            System.out.println(name);

        posTests = negTests = 0;

        testName = name;

    }

    @BeforeClass

    public static void setUpClass() throws Exception {

        calledLog.clear();

        calledLog.add(null);

        nextArgVal = INITIAL_ARG_VAL;

    }

    @AfterClass

    public static void tearDownClass() throws Exception {

        int posTests = allPosTests, negTests = allNegTests;

        if (verbosity >= 2 && (posTests | negTests) != 0) {

            System.out.println();

            if (posTests != 0)  System.out.println("=== "+posTests+" total positive test cases");

            if (negTests != 0)  System.out.println("=== "+negTests+" total negative test cases");

        }

    }

    static List<Object> calledLog = new ArrayList<Object>();

    static Object logEntry(String name, Object... args) {

        return Arrays.asList(name, Arrays.asList(args));

    }

    static Object called(String name, Object... args) {

        Object entry = logEntry(name, args);

        calledLog.add(entry);

        return entry;

    }

    static void assertCalled(String name, Object... args) {

        Object expected = logEntry(name, args);

        Object actual   = calledLog.get(calledLog.size() - 1);

        if (expected.equals(actual) && verbosity < 9)  return;

        System.out.println("assertCalled "+name+":");

        System.out.println("expected:   "+expected);

        System.out.println("actual:     "+actual);

        System.out.println("ex. types:  "+getClasses(expected));

        System.out.println("act. types: "+getClasses(actual));

        assertEquals("previous method call", expected, actual);

    }

    static void printCalled(MethodHandle target, String name, Object... args) {

        if (verbosity >= 3)

            System.out.println("calling MH="+target+" to "+name+Arrays.toString(args));

    }

    static Object castToWrapper(Object value, Class<?> dst) {

        Object wrap = null;

        if (value instanceof Number)

            wrap = castToWrapperOrNull(((Number)value).longValue(), dst);

        if (value instanceof Character)

            wrap = castToWrapperOrNull((char)(Character)value, dst);

        if (wrap != null)  return wrap;

        return dst.cast(value);

    }

    static Object castToWrapperOrNull(long value, Class<?> dst) {

        if (dst == int.class || dst == Integer.class)

            return (int)(value);

        if (dst == long.class || dst == Long.class)

            return (long)(value);

        if (dst == char.class || dst == Character.class)

            return (char)(value);

        if (dst == short.class || dst == Short.class)

            return (short)(value);

        if (dst == float.class || dst == Float.class)

            return (float)(value);

        if (dst == double.class || dst == Double.class)

            return (double)(value);

        if (dst == byte.class || dst == Byte.class)

            return (byte)(value);

        if (dst == boolean.class || dst == boolean.class)

            return ((value % 29) & 1) == 0;

        return null;

    }

    static final int ONE_MILLION = (1000*1000),  // first int value

                     TEN_BILLION = (10*1000*1000*1000),  // scale factor to reach upper 32 bits

                     INITIAL_ARG_VAL = ONE_MILLION << 1;  // <<1 makes space for sign bit;

    static long nextArgVal;

    static long nextArg(boolean moreBits) {

        long val = nextArgVal++;

        long sign = -(val & 1); // alternate signs

        val >>= 1;

        if (moreBits)

            // Guarantee some bits in the high word.

            // In any case keep the decimal representation simple-looking,

            // with lots of zeroes, so as not to make the printed decimal

            // strings unnecessarily noisy.

            val += (val % ONE_MILLION) * TEN_BILLION;

        return val ^ sign;

    }

    static int nextArg() {

        // Produce a 32-bit result something like ONE_MILLION+(smallint).

        // Example: 1_000_042.

        return (int) nextArg(false);

    }

    static long nextArg(Class<?> kind) {

        if (kind == long.class   || kind == Long.class ||

            kind == double.class || kind == Double.class)

            // produce a 64-bit result something like

            // ((TEN_BILLION+1) * (ONE_MILLION+(smallint)))

            // Example: 10_000_420_001_000_042.

            return nextArg(true);

        return (long) nextArg();

    }

    static Object randomArg(Class<?> param) {

        Object wrap = castToWrapperOrNull(nextArg(param), param);

        if (wrap != null) {

            return wrap;

        }

//        import sun.dyn.util.Wrapper;

//        Wrapper wrap = Wrapper.forBasicType(dst);

//        if (wrap == Wrapper.OBJECT && Wrapper.isWrapperType(dst))

//            wrap = Wrapper.forWrapperType(dst);

//        if (wrap != Wrapper.OBJECT)

//            return wrap.wrap(nextArg++);

        if (param.isInterface()) {

            for (Class<?> c : param.getClasses()) {

                if (param.isAssignableFrom(c) && !c.isInterface())

                    { param = c; break; }

            }

        }

        if (param.isInterface() || param.isAssignableFrom(String.class))

            return "#"+nextArg();

        else

            try {

                return param.newInstance();

            } catch (InstantiationException ex) {

            } catch (IllegalAccessException ex) {

            }

        return null;  // random class not Object, String, Integer, etc.

    }

    static Object[] randomArgs(Class<?>... params) {

        Object[] args = new Object[params.length];

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

            args[i] = randomArg(params[i]);

        return args;

    }

    static Object[] randomArgs(int nargs, Class<?> param) {

        Object[] args = new Object[nargs];

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

            args[i] = randomArg(param);

        return args;

    }

    static <T, E extends T> T[] array(Class<T[]> atype, E... a) {

        return Arrays.copyOf(a, a.length, atype);

    }

    static <T> T[] cat(T[] a, T... b) {

        int alen = a.length, blen = b.length;

        if (blen == 0)  return a;

        T[] c = Arrays.copyOf(a, alen + blen);

        System.arraycopy(b, 0, c, alen, blen);

        return c;

    }

    static Integer[] boxAll(int... vx) {

        Integer[] res = new Integer[vx.length];

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

            res[i] = vx[i];

        }

        return res;

    }

    static Object getClasses(Object x) {

        if (x == null)  return x;

        if (x instanceof String)  return x;  // keep the name

        if (x instanceof List) {

            // recursively report classes of the list elements

            Object[] xa = ((List)x).toArray();

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

                xa[i] = getClasses(xa[i]);

            return Arrays.asList(xa);

        }

        return x.getClass().getSimpleName();

    }

    static MethodHandle changeArgTypes(MethodHandle target, Class<?> argType) {

        return changeArgTypes(target, 0, 999, argType);

    }

    static MethodHandle changeArgTypes(MethodHandle target,

            int beg, int end, Class<?> argType) {

        MethodType targetType = target.type();

        end = Math.min(end, targetType.parameterCount());

        ArrayList<Class<?>> argTypes = new ArrayList<Class<?>>(targetType.parameterList());

        Collections.fill(argTypes.subList(beg, end), argType);

        MethodType ttype2 = MethodType.methodType(targetType.returnType(), argTypes);

        return MethodHandles.convertArguments(target, ttype2);

    }

    // This lookup is good for all members in and under MethodHandlesTest.

    static final Lookup PRIVATE = MethodHandles.lookup();

    // This lookup is good for package-private members but not private ones.

    static final Lookup PACKAGE = PackageSibling.lookup();

    // This lookup is good only for public members.

    static final Lookup PUBLIC  = MethodHandles.publicLookup();

    // Subject methods...

    static class Example implements IntExample {

        final String name;

        public Example() { name = "Example#"+nextArg(); }

        protected Example(String name) { this.name = name; }

        protected Example(int x) { this(); called("protected <init>", this, x); }

        @Override public String toString() { return name; }

        public void            v0()     { called("v0", this); }

        void                   pkg_v0() { called("pkg_v0", this); }

        private void           pri_v0() { called("pri_v0", this); }

        public static void     s0()     { called("s0"); }

        static void            pkg_s0() { called("pkg_s0"); }

        private static void    pri_s0() { called("pri_s0"); }

        public Object          v1(Object x) { return called("v1", this, x); }

        public Object          v2(Object x, Object y) { return called("v2", this, x, y); }

        public Object          v2(Object x, int    y) { return called("v2", this, x, y); }

        public Object          v2(int    x, Object y) { return called("v2", this, x, y); }

        public Object          v2(int    x, int    y) { return called("v2", this, x, y); }

        public static Object   s1(Object x) { return called("s1", x); }

        public static Object   s2(int x)    { return called("s2", x); }

        public static Object   s3(long x)   { return called("s3", x); }

        public static Object   s4(int x, int y) { return called("s4", x, y); }

        public static Object   s5(long x, int y) { return called("s5", x, y); }

        public static Object   s6(int x, long y) { return called("s6", x, y); }

        public static Object   s7(float x, double y) { return called("s7", x, y); }

        static final Lookup EXAMPLE = MethodHandles.lookup();  // for testing findSpecial

    }

    static final Lookup EXAMPLE = Example.EXAMPLE;

    public static class PubExample extends Example {

        public PubExample() { super("PubExample#"+nextArg()); }

    }

    static class SubExample extends Example {

        @Override public void  v0()     { called("Sub/v0", this); }

        @Override void         pkg_v0() { called("Sub/pkg_v0", this); }

        private      SubExample(int x)  { called("<init>", this, x); }

        public SubExample() { super("SubExample#"+nextArg()); }

    }

    public static interface IntExample {

        public void            v0();

        public static class Impl implements IntExample {

            public void        v0()     { called("Int/v0", this); }

            final String name;

            public Impl() { name = "Impl#"+nextArg(); }

            @Override public String toString() { return name; }

        }

    }

    static final Object[][][] ACCESS_CASES = {

        { { false, PUBLIC }, { false, PACKAGE }, { false, PRIVATE }, { false, EXAMPLE } }, //[0]: all false

        { { false, PUBLIC }, { false, PACKAGE }, { true,  PRIVATE }, { true,  EXAMPLE } }, //[1]: only PRIVATE

        { { false, PUBLIC }, { true,  PACKAGE }, { true,  PRIVATE }, { true,  EXAMPLE } }, //[2]: PUBLIC false

        { { true,  PUBLIC }, { true,  PACKAGE }, { true,  PRIVATE }, { true,  EXAMPLE } }, //[3]: all true

    };

    static Object[][] accessCases(Class<?> defc, String name, boolean isSpecial) {

        Object[][] cases;

        if (name.contains("pri_") || isSpecial) {

            cases = ACCESS_CASES[1]; // PRIVATE only

        } else if (name.contains("pkg_") || !Modifier.isPublic(defc.getModifiers())) {

            cases = ACCESS_CASES[2]; // not PUBLIC

        } else {

            assertTrue(name.indexOf('_') < 0);

            boolean pubc = Modifier.isPublic(defc.getModifiers());

            if (pubc)

                cases = ACCESS_CASES[3]; // all access levels

            else

                cases = ACCESS_CASES[2]; // PACKAGE but not PUBLIC

        }

        if (defc != Example.class && cases[cases.length-1][1] == EXAMPLE)

            cases = Arrays.copyOfRange(cases, 0, cases.length-1);

        return cases;

    }

    static Object[][] accessCases(Class<?> defc, String name) {

        return accessCases(defc, name, false);

    }

    @Test

    public void testFindStatic() throws Throwable {

        if (CAN_SKIP_WORKING)  return;

        startTest("findStatic");

        testFindStatic(PubExample.class, void.class, "s0");

        testFindStatic(Example.class, void.class, "s0");

        testFindStatic(Example.class, void.class, "pkg_s0");

        testFindStatic(Example.class, void.class, "pri_s0");

        testFindStatic(Example.class, Object.class, "s1", Object.class);

        testFindStatic(Example.class, Object.class, "s2", int.class);

        testFindStatic(Example.class, Object.class, "s3", long.class);

        testFindStatic(Example.class, Object.class, "s4", int.class, int.class);

        testFindStatic(Example.class, Object.class, "s5", long.class, int.class);

        testFindStatic(Example.class, Object.class, "s6", int.class, long.class);

        testFindStatic(Example.class, Object.class, "s7", float.class, double.class);

        testFindStatic(false, PRIVATE, Example.class, void.class, "bogus");

    }

    void testFindStatic(Class<?> defc, Class<?> ret, String name, Class<?>... params) throws Throwable {

        for (Object[] ac : accessCases(defc, name)) {

            testFindStatic((Boolean)ac[0], (Lookup)ac[1], defc, ret, name, params);

        }

    }

    void testFindStatic(Lookup lookup, Class<?> defc, Class<?> ret, String name, Class<?>... params) throws Throwable {

        testFindStatic(true, lookup, defc, ret, name, params);

    }

    void testFindStatic(boolean positive, Lookup lookup, Class<?> defc, Class<?> ret, String name, Class<?>... params) throws Throwable {

        countTest(positive);

        MethodType type = MethodType.methodType(ret, params);

        MethodHandle target = null;

        Exception noAccess = null;

        try {

            if (verbosity >= 4)  System.out.println("lookup via "+lookup+" of "+defc+" "+name+type);

            target = lookup.findStatic(defc, name, type);

        } catch (NoAccessException ex) {

            noAccess = ex;

        }

        if (verbosity >= 3)

            System.out.println("findStatic "+lookup+": "+defc.getName()+"."+name+"/"+type+" => "+target

                    +(noAccess == null ? "" : " !! "+noAccess));

        if (positive && noAccess != null)  throw noAccess;

        assertEquals(positive ? "positive test" : "negative test erroneously passed", positive, target != null);

        if (!positive)  return; // negative test failed as expected

        assertEquals(type, target.type());

        assertTrue(target.toString().contains(name));  // rough check

        if (!DO_MORE_CALLS && lookup != PRIVATE)  return;

        Object[] args = randomArgs(params);

        printCalled(target, name, args);

        target.invokeVarargs(args);

        assertCalled(name, args);

        if (verbosity >= 1)

            System.out.print(':');

    }

    @Test

    public void testFindVirtual() throws Throwable {

        if (CAN_SKIP_WORKING)  return;

        startTest("findVirtual");

        testFindVirtual(Example.class, void.class, "v0");

        testFindVirtual(Example.class, void.class, "pkg_v0");

        testFindVirtual(Example.class, void.class, "pri_v0");

        testFindVirtual(Example.class, Object.class, "v1", Object.class);

        testFindVirtual(Example.class, Object.class, "v2", Object.class, Object.class);

        testFindVirtual(Example.class, Object.class, "v2", Object.class, int.class);

        testFindVirtual(Example.class, Object.class, "v2", int.class, Object.class);

        testFindVirtual(Example.class, Object.class, "v2", int.class, int.class);

        testFindVirtual(false, PRIVATE, Example.class, Example.class, void.class, "bogus");

        // test dispatch

        testFindVirtual(SubExample.class,      SubExample.class, void.class, "Sub/v0");

        testFindVirtual(SubExample.class,         Example.class, void.class, "Sub/v0");

        testFindVirtual(SubExample.class,      IntExample.class, void.class, "Sub/v0");

        testFindVirtual(SubExample.class,      SubExample.class, void.class, "Sub/pkg_v0");

        testFindVirtual(SubExample.class,         Example.class, void.class, "Sub/pkg_v0");

        testFindVirtual(Example.class,         IntExample.class, void.class, "v0");

        testFindVirtual(IntExample.Impl.class, IntExample.class, void.class, "Int/v0");

    }

    void testFindVirtual(Class<?> defc, Class<?> ret, String name, Class<?>... params) throws Throwable {

        Class<?> rcvc = defc;

        testFindVirtual(rcvc, defc, ret, name, params);

    }

    void testFindVirtual(Class<?> rcvc, Class<?> defc, Class<?> ret, String name, Class<?>... params) throws Throwable {

        for (Object[] ac : accessCases(defc, name)) {