/*

 * Copyright (c) 2012, 2016, 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.

 */

/**

 * @test

 * @requires vm.jvmci

 * @library ../../../../../

 * @modules java.base/jdk.internal.reflect

 *          jdk.internal.vm.ci/jdk.vm.ci.meta

 *          jdk.internal.vm.ci/jdk.vm.ci.runtime

 *          jdk.internal.vm.ci/jdk.vm.ci.common

 *          java.base/jdk.internal.misc

 */

package jdk.vm.ci.runtime.test;

import static java.lang.reflect.Modifier.isAbstract;

import static java.lang.reflect.Modifier.isFinal;

import static java.lang.reflect.Modifier.isPrivate;

import static java.lang.reflect.Modifier.isProtected;

import static java.lang.reflect.Modifier.isPublic;

import static java.lang.reflect.Modifier.isStatic;

import static org.junit.Assert.assertArrayEquals;

import static org.junit.Assert.assertEquals;

import static org.junit.Assert.assertFalse;

import static org.junit.Assert.assertNotNull;

import static org.junit.Assert.assertNull;

import static org.junit.Assert.assertTrue;

import java.lang.annotation.Annotation;

import java.lang.reflect.Field;

import java.lang.reflect.Method;

import java.lang.reflect.Modifier;

import java.util.Arrays;

import java.util.Collections;

import java.util.HashMap;

import java.util.HashSet;

import java.util.Map;

import java.util.Set;

import org.junit.Test;

import jdk.internal.reflect.ConstantPool;

import jdk.vm.ci.common.JVMCIError;

import jdk.vm.ci.meta.Assumptions.AssumptionResult;

import jdk.vm.ci.meta.JavaConstant;

import jdk.vm.ci.meta.JavaKind;

import jdk.vm.ci.meta.ResolvedJavaField;

import jdk.vm.ci.meta.ResolvedJavaMethod;

import jdk.vm.ci.meta.ResolvedJavaType;

/**

 * Tests for {@link ResolvedJavaType}.

 */

@SuppressWarnings("unchecked")

public class TestResolvedJavaType extends TypeUniverse {

    private static final Class<? extends Annotation> SIGNATURE_POLYMORPHIC_CLASS = findPolymorphicSignatureClass();

    public TestResolvedJavaType() {

    }

    private static Class<? extends Annotation> findPolymorphicSignatureClass() {

        Class<? extends Annotation> signaturePolyAnnotation = null;

        try {

            for (Class<?> clazz : TestResolvedJavaType.class.getClassLoader().loadClass("java.lang.invoke.MethodHandle").getDeclaredClasses()) {

                if (clazz.getName().endsWith("PolymorphicSignature") && Annotation.class.isAssignableFrom(clazz)) {

                    signaturePolyAnnotation = (Class<? extends Annotation>) clazz;

                    break;

                }

            }

        } catch (Throwable e) {

            throw new AssertionError("Could not find annotation PolymorphicSignature in java.lang.invoke.MethodHandle", e);

        }

        assertNotNull(signaturePolyAnnotation);

        return signaturePolyAnnotation;

    }

    @Test

    public void findInstanceFieldWithOffsetTest() {

        for (Class<?> c : classes) {

            ResolvedJavaType type = metaAccess.lookupJavaType(c);

            Set<Field> reflectionFields = getInstanceFields(c, true);

            for (Field f : reflectionFields) {

                ResolvedJavaField rf = lookupField(type.getInstanceFields(true), f);

                assertNotNull(rf);

                long offset = isStatic(f.getModifiers()) ? unsafe.staticFieldOffset(f) : unsafe.objectFieldOffset(f);

                ResolvedJavaField result = type.findInstanceFieldWithOffset(offset, rf.getJavaKind());

                assertNotNull(result);

                assertTrue(fieldsEqual(f, result));

            }

        }

    }

    @Test

    public void isInterfaceTest() {

        for (Class<?> c : classes) {

            ResolvedJavaType type = metaAccess.lookupJavaType(c);

            boolean expected = c.isInterface();

            boolean actual = type.isInterface();

            assertEquals(expected, actual);

        }

    }

    @Test

    public void isInstanceClassTest() {

        for (Class<?> c : classes) {

            ResolvedJavaType type = metaAccess.lookupJavaType(c);

            boolean expected = !c.isArray() && !c.isPrimitive() && !c.isInterface();

            boolean actual = type.isInstanceClass();

            assertEquals(expected, actual);

        }

    }

    @Test

    public void isArrayTest() {

        for (Class<?> c : classes) {

            ResolvedJavaType type = metaAccess.lookupJavaType(c);

            boolean expected = c.isArray();

            boolean actual = type.isArray();

            assertEquals(expected, actual);

        }

    }

    @Test

    public void getModifiersTest() {

        for (Class<?> c : classes) {

            ResolvedJavaType type = metaAccess.lookupJavaType(c);

            int mask = Modifier.classModifiers() & ~Modifier.STATIC;

            int expected = c.getModifiers() & mask;

            int actual = type.getModifiers() & mask;

            Class<?> elementalType = c;

            while (elementalType.isArray()) {

                elementalType = elementalType.getComponentType();

            }

            if (elementalType.isMemberClass()) {

                // member class get their modifiers from the inner-class attribute in the JVM and

                // from the classfile header in jvmci

                expected &= ~(Modifier.PUBLIC | Modifier.PRIVATE | Modifier.PROTECTED);

                actual &= ~(Modifier.PUBLIC | Modifier.PRIVATE | Modifier.PROTECTED);

            }

            assertEquals(String.format("%s: 0x%x != 0x%x", type, expected, actual), expected, actual);

        }

    }

    @Test

    public void isAssignableFromTest() {

        Class<?>[] all = classes.toArray(new Class<?>[classes.size()]);

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

            Class<?> c1 = all[i];

            for (int j = i; j < all.length; j++) {

                Class<?> c2 = all[j];

                ResolvedJavaType t1 = metaAccess.lookupJavaType(c1);

                ResolvedJavaType t2 = metaAccess.lookupJavaType(c2);

                boolean expected = c1.isAssignableFrom(c2);

                boolean actual = t1.isAssignableFrom(t2);

                assertEquals(expected, actual);

                if (expected && t1 != t2) {

                    assertFalse(t2.isAssignableFrom(t1));

                }

            }

        }

    }

    @Test

    public void isInstanceTest() {

        for (ConstantValue cv : constants()) {

            JavaConstant c = cv.value;

            if (c.getJavaKind() == JavaKind.Object && !c.isNull()) {

                ResolvedJavaType cType = metaAccess.lookupJavaType(c);

                for (ResolvedJavaType t : javaTypes) {

                    if (t.isAssignableFrom(cType)) {

                        assertTrue(t.isInstance(c));

                    } else {

                        assertFalse(t.isInstance(c));

                    }

                }

            }

        }

    }

    @Test

    public void getSuperclassTest() {

        for (Class<?> c : classes) {

            ResolvedJavaType type = metaAccess.lookupJavaType(c);

            Class<?> expected = c.getSuperclass();

            ResolvedJavaType actual = type.getSuperclass();

            if (expected == null) {

                assertTrue(actual == null);

            } else {

                assertNotNull(actual);

                assertTrue(actual.equals(metaAccess.lookupJavaType(expected)));

            }

        }

    }

    @Test

    public void getInterfacesTest() {

        for (Class<?> c : classes) {

            ResolvedJavaType type = metaAccess.lookupJavaType(c);

            Class<?>[] expected = c.getInterfaces();

            ResolvedJavaType[] actual = type.getInterfaces();

            assertEquals(expected.length, actual.length);

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

                assertTrue(actual[i].equals(metaAccess.lookupJavaType(expected[i])));

            }

        }

    }

    public Class<?> getSupertype(Class<?> c) {

        assert !c.isPrimitive();

        if (c.isArray()) {

            Class<?> componentType = c.getComponentType();

            if (componentType.isPrimitive() || componentType == Object.class) {

                return Object.class;

            }

            return getArrayClass(getSupertype(componentType));

        }

        if (c.isInterface()) {

            return Object.class;

        }

        return c.getSuperclass();

    }

    public Class<?> findLeastCommonAncestor(Class<?> c1Initial, Class<?> c2Initial) {

        if (c1Initial.isPrimitive() || c2Initial.isPrimitive()) {

            return null;

        } else {

            Class<?> c1 = c1Initial;

            Class<?> c2 = c2Initial;

            while (true) {

                if (c1.isAssignableFrom(c2)) {

                    return c1;

                }

                if (c2.isAssignableFrom(c1)) {

                    return c2;

                }

                c1 = getSupertype(c1);

                c2 = getSupertype(c2);

            }

        }

    }

    @Test

    public void findLeastCommonAncestorTest() {

        Class<?>[] all = classes.toArray(new Class<?>[classes.size()]);

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

            Class<?> c1 = all[i];

            for (int j = i; j < all.length; j++) {

                Class<?> c2 = all[j];

                ResolvedJavaType t1 = metaAccess.lookupJavaType(c1);

                ResolvedJavaType t2 = metaAccess.lookupJavaType(c2);

                Class<?> expected = findLeastCommonAncestor(c1, c2);

                ResolvedJavaType actual = t1.findLeastCommonAncestor(t2);

                if (expected == null) {

                    assertTrue(actual == null);

                } else {

                    assertNotNull(actual);

                    assertTrue(actual.equals(metaAccess.lookupJavaType(expected)));

                }

            }

        }

    }

    private static class Base {

    }

    abstract static class Abstract1 extends Base {

    }

    interface Interface1 {

    }

    static class Concrete1 extends Abstract1 {

    }

    static class Concrete2 extends Abstract1 implements Interface1 {

    }

    static class Concrete3 extends Concrete2 {

    }

    static final class Final1 extends Abstract1 {

    }

    abstract static class Abstract4 extends Concrete3 {

    }

    void checkConcreteSubtype(ResolvedJavaType type, ResolvedJavaType expected) {

        AssumptionResult<ResolvedJavaType> leafConcreteSubtype = type.findLeafConcreteSubtype();

        if (leafConcreteSubtype == null) {

            // findLeafConcreteSubtype() is conservative

        } else {

            if (expected == null) {

                assertNull(leafConcreteSubtype);

            } else {

                assertTrue(leafConcreteSubtype.getResult().equals(expected));

            }

            assertTrue(!type.isLeaf() || leafConcreteSubtype.isAssumptionFree());

        }

        if (!type.isArray()) {

            ResolvedJavaType arrayType = type.getArrayClass();

            AssumptionResult<ResolvedJavaType> arraySubtype = arrayType.findLeafConcreteSubtype();

            if (arraySubtype != null) {

                assertEquals(arraySubtype.getResult(), arrayType);

            } else {

                // findLeafConcreteSubtype() method is conservative

            }

        }

    }

    @Test

    public void findLeafConcreteSubtypeTest() {

        ResolvedJavaType base = metaAccess.lookupJavaType(Base.class);

        checkConcreteSubtype(base, base);

        ResolvedJavaType a1 = metaAccess.lookupJavaType(Abstract1.class);

        ResolvedJavaType c1 = metaAccess.lookupJavaType(Concrete1.class);

        checkConcreteSubtype(base, null);

        checkConcreteSubtype(a1, c1);

        checkConcreteSubtype(c1, c1);

        ResolvedJavaType i1 = metaAccess.lookupJavaType(Interface1.class);

        ResolvedJavaType c2 = metaAccess.lookupJavaType(Concrete2.class);

        checkConcreteSubtype(base, null);

        checkConcreteSubtype(a1, null);

        checkConcreteSubtype(c1, c1);

        checkConcreteSubtype(i1, c2);

        checkConcreteSubtype(c2, c2);

        ResolvedJavaType c3 = metaAccess.lookupJavaType(Concrete3.class);

        checkConcreteSubtype(c2, null);

        checkConcreteSubtype(c3, c3);

        ResolvedJavaType a4 = metaAccess.lookupJavaType(Abstract4.class);

        checkConcreteSubtype(c3, null);

        checkConcreteSubtype(a4, null);

        ResolvedJavaType a1a = metaAccess.lookupJavaType(Abstract1[].class);

        checkConcreteSubtype(a1a, null);

        ResolvedJavaType i1a = metaAccess.lookupJavaType(Interface1[].class);

        checkConcreteSubtype(i1a, null);

        ResolvedJavaType c1a = metaAccess.lookupJavaType(Concrete1[].class);

        checkConcreteSubtype(c1a, c1a);

        ResolvedJavaType f1a = metaAccess.lookupJavaType(Final1[].class);

        checkConcreteSubtype(f1a, f1a);

        ResolvedJavaType obja = metaAccess.lookupJavaType(Object[].class);

        checkConcreteSubtype(obja, null);

        ResolvedJavaType inta = metaAccess.lookupJavaType(int[].class);

        checkConcreteSubtype(inta, inta);

    }

    interface NoImplementor {

    }

    interface SingleImplementorInterface {

    }

    static class SingleConcreteImplementor implements SingleImplementorInterface {

    }

    interface SingleAbstractImplementorInterface {

    }

    abstract static class SingleAbstractImplementor implements SingleAbstractImplementorInterface {

    }

    interface MultiImplementorInterface {

    }

    static class ConcreteImplementor1 implements MultiImplementorInterface {

    }

    static class ConcreteImplementor2 implements MultiImplementorInterface {

    }

    interface MultipleAbstractImplementorInterface {

    }

    abstract static class MultiAbstractImplementor1 implements MultipleAbstractImplementorInterface {

    }

    abstract static class MultiAbstractImplementor2 implements MultipleAbstractImplementorInterface {

    }

    interface SingleAbstractImplementorInterface2 {

    }

    interface ExtendedSingleImplementorInterface {

    }

    abstract static class SingleAbstractImplementor2 implements SingleAbstractImplementorInterface2 {

    }

    static class ConcreteTransitiveImplementor1 extends SingleAbstractImplementor2 implements ExtendedSingleImplementorInterface {

    }

    static class ConcreteTransitiveImplementor2 extends SingleAbstractImplementor2 implements ExtendedSingleImplementorInterface {

    }

    @Test

    public void getSingleImplementorTest() {

        ResolvedJavaType iNi = metaAccess.lookupJavaType(NoImplementor.class);

        assertNull(iNi.getSingleImplementor());

        ResolvedJavaType iSi = metaAccess.lookupJavaType(SingleImplementorInterface.class);

        ResolvedJavaType cSi = metaAccess.lookupJavaType(SingleConcreteImplementor.class);

        assertEquals(cSi, iSi.getSingleImplementor());

        ResolvedJavaType iSai = metaAccess.lookupJavaType(SingleAbstractImplementorInterface.class);

        ResolvedJavaType aSai = metaAccess.lookupJavaType(SingleAbstractImplementor.class);

        assertEquals(aSai, iSai.getSingleImplementor());

        ResolvedJavaType iMi = metaAccess.lookupJavaType(MultiImplementorInterface.class);

        metaAccess.lookupJavaType(ConcreteImplementor1.class);

        metaAccess.lookupJavaType(ConcreteImplementor2.class);

        assertEquals(iMi, iMi.getSingleImplementor());

        ResolvedJavaType iMai = metaAccess.lookupJavaType(MultipleAbstractImplementorInterface.class);

        metaAccess.lookupJavaType(MultiAbstractImplementor1.class);

        metaAccess.lookupJavaType(MultiAbstractImplementor2.class);

        assertEquals(iMai, iMai.getSingleImplementor());

        ResolvedJavaType iSai2 = metaAccess.lookupJavaType(SingleAbstractImplementorInterface2.class);

        ResolvedJavaType aSai2 = metaAccess.lookupJavaType(SingleAbstractImplementor2.class);

        metaAccess.lookupJavaType(ConcreteTransitiveImplementor1.class);

        metaAccess.lookupJavaType(ConcreteTransitiveImplementor2.class);

        assertEquals(aSai2, iSai2.getSingleImplementor());

    }

    @Test(expected = JVMCIError.class)

    public void getSingleImplementorTestClassReceiver() {

        ResolvedJavaType base = metaAccess.lookupJavaType(Base.class);

        base.getSingleImplementor();

    }

    @Test(expected = JVMCIError.class)

    public void getSingleImplementorTestPrimitiveReceiver() {

        ResolvedJavaType primitive = metaAccess.lookupJavaType(int.class);

        primitive.getSingleImplementor();

    }

    @Test

    public void getComponentTypeTest() {

        for (Class<?> c : classes) {

            ResolvedJavaType type = metaAccess.lookupJavaType(c);

            Class<?> expected = c.getComponentType();

            ResolvedJavaType actual = type.getComponentType();

            if (expected == null) {

                assertNull(actual);

            } else {

                assertTrue(actual.equals(metaAccess.lookupJavaType(expected)));

            }

        }

    }

    @Test

    public void getArrayClassTest() {

        for (Class<?> c : classes) {

            if (c != void.class) {

                ResolvedJavaType type = metaAccess.lookupJavaType(c);

                Class<?> expected = getArrayClass(c);

                ResolvedJavaType actual = type.getArrayClass();

                assertTrue(actual.equals(metaAccess.lookupJavaType(expected)));

            }

        }

    }

    static class Declarations {

        final Method implementation;

        final Set<Method> declarations;

        Declarations(Method impl) {

            this.implementation = impl;

            declarations = new HashSet<>();

        }

    }

    /**

     * See <a href="http://docs.oracle.com/javase/specs/jvms/se7/html/jvms-5.html#jvms-5.4.5">Method

     * overriding</a>.

     */

    static boolean isOverriderOf(Method impl, Method m) {

        if (!isPrivate(m.getModifiers()) && !isFinal(m.getModifiers())) {

            if (m.getName().equals(impl.getName())) {

                if (m.getReturnType() == impl.getReturnType()) {

                    if (Arrays.equals(m.getParameterTypes(), impl.getParameterTypes())) {

                        if (isPublic(m.getModifiers()) || isProtected(m.getModifiers())) {

                            // m is public or protected

                            return isPublic(impl.getModifiers()) || isProtected(impl.getModifiers());

                        } else {

                            // m is package-private

                            return impl.getDeclaringClass().getPackage() == m.getDeclaringClass().getPackage();

                        }

                    }

                }