/*

 * 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

 * @bug 8136421

 * @requires vm.jvmci

 * @summary Testing compiler.jvmci.CompilerToVM.lookupKlassInPool method

 * @library /test/lib /

 * @library ../common/patches

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

 *          java.base/jdk.internal.reflect

 *          java.base/jdk.internal.org.objectweb.asm

 *          java.base/jdk.internal.org.objectweb.asm.tree

 *          jdk.internal.vm.ci/jdk.vm.ci.hotspot

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

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

 *

 * @build jdk.internal.vm.ci/jdk.vm.ci.hotspot.CompilerToVMHelper sun.hotspot.WhiteBox

 * @run driver ClassFileInstaller sun.hotspot.WhiteBox

 *                                sun.hotspot.WhiteBox$WhiteBoxPermission

 * @run main/othervm -Xbootclasspath/a:.

 *                   -XX:+UnlockExperimentalVMOptions -XX:+EnableJVMCI

 *                   -XX:+UnlockDiagnosticVMOptions -XX:+WhiteBoxAPI

 *                   compiler.jvmci.compilerToVM.LookupKlassInPoolTest

 */

package compiler.jvmci.compilerToVM;

import compiler.jvmci.compilerToVM.ConstantPoolTestCase.ConstantTypes;

import compiler.jvmci.compilerToVM.ConstantPoolTestCase.TestedCPEntry;

import compiler.jvmci.compilerToVM.ConstantPoolTestCase.Validator;

import compiler.jvmci.compilerToVM.ConstantPoolTestsHelper.DummyClasses;

import jdk.vm.ci.hotspot.CompilerToVMHelper;

import jdk.vm.ci.hotspot.HotSpotResolvedObjectType;

import jdk.vm.ci.meta.ConstantPool;

import java.util.HashMap;

import java.util.Map;

import static compiler.jvmci.compilerToVM.ConstantPoolTestCase.ConstantTypes.CONSTANT_CLASS;

/**

 * Test for {@code jdk.vm.ci.hotspot.CompilerToVM.lookupKlassInPool} method

 */

public class LookupKlassInPoolTest {

    public static void main(String[] args) throws Exception  {

        Map<ConstantTypes, Validator> typeTests = new HashMap<>();

        typeTests.put(CONSTANT_CLASS, LookupKlassInPoolTest::validate);

        ConstantPoolTestCase testCase = new ConstantPoolTestCase(typeTests);

        testCase.test();

        // The next "Class.forName" and repeating "testCase.test()"

        // are here for the following reason.

        // The first test run is without dummy class initialization,

        // which means no constant pool cache exists.

        // The second run is with initialized class (with constant pool cache available).

        // Some CompilerToVM methods require different input

        // depending on whether CP cache exists or not.

        for (DummyClasses dummy : DummyClasses.values()) {

            Class.forName(dummy.klass.getName());

        }

        testCase.test();

    }

    public static void validate(ConstantPool constantPoolCTVM,

                                ConstantTypes cpType,

                                DummyClasses dummyClass,

                                int i) {

        TestedCPEntry entry = cpType.getTestedCPEntry(dummyClass, i);

        if (entry == null) {

            return;

        }

        Object classToVerify = CompilerToVMHelper.lookupKlassInPool(constantPoolCTVM, i);

        if (!(classToVerify instanceof HotSpotResolvedObjectType) && !(classToVerify instanceof String)) {

            String msg = String.format("Output of method CTVM.lookupKlassInPool is neither"

                                               + " a HotSpotResolvedObjectType, nor a String");

            throw new AssertionError(msg);

        }

        String classNameToRefer = entry.klass;

        String outputToVerify = classToVerify.toString();

        if (!outputToVerify.contains(classNameToRefer)) {

            String msg = String.format("Wrong class accessed by constant pool index %d: %s, but should be %s",

                                       i,

                                       outputToVerify,

                                       classNameToRefer);

            throw new AssertionError(msg);

        }

    }

}