/*

 * Copyright (c) 2019, 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

 * @comment the test uses -XX:ArchiveRelocationMode=1 to force relocation.

 * @requires vm.cds

 * @summary Testing relocation of dynamic CDS archive (during both dump time and run time)

 * @comment JDK-8231610 Relocate the CDS archive if it cannot be mapped to the requested address

 * @bug 8231610

 * @library /test/lib /test/hotspot/jtreg/runtime/cds/appcds /test/hotspot/jtreg/runtime/cds/appcds/test-classes

 * @build Hello

 * @run driver ClassFileInstaller -jar hello.jar Hello

 * @run driver DynamicArchiveRelocationTest

 */

import jdk.test.lib.process.OutputAnalyzer;

import jtreg.SkippedException;

public class DynamicArchiveRelocationTest extends DynamicArchiveTestBase {

    public static void main(String... args) throws Exception {

        try {

            testOuter(false);

            testOuter(true);

        } catch (SkippedException s) {

            s.printStackTrace();

            throw new RuntimeException("Archive mapping should always succeed after JDK-8231610 (did the machine run out of memory?)");

        }

    }

    static void testOuter(boolean dump_base_reloc) throws Exception {

        testInner(dump_base_reloc, true,  false);

        testInner(dump_base_reloc, false, true);

        testInner(dump_base_reloc, true,  true);

    }

    static boolean dump_base_reloc, dump_top_reloc, run_reloc;

    // dump_base_reloc - force relocation of archive when dumping base archive

    // dump_top_reloc  - force relocation of archive when dumping top  archive

    // run_reloc       - force relocation of archive when running

    static void testInner(boolean dump_base_reloc, boolean dump_top_reloc, boolean run_reloc) throws Exception {

        DynamicArchiveRelocationTest.dump_base_reloc = dump_base_reloc;

        DynamicArchiveRelocationTest.dump_top_reloc  = dump_top_reloc;

        DynamicArchiveRelocationTest.run_reloc       = run_reloc;

        runTest(DynamicArchiveRelocationTest::doTest);

    }

    static int caseCount = 0;

    static void doTest() throws Exception {

        caseCount += 1;

        System.out.println("============================================================");

        System.out.println("case = " + caseCount + ", base = " + dump_base_reloc

                           + ", top = " + dump_top_reloc

                           + ", run = " + run_reloc);

        System.out.println("============================================================");

        String appJar = ClassFileInstaller.getJarPath("hello.jar");

        String mainClass = "Hello";

        String forceRelocation = "-XX:ArchiveRelocationMode=1";

        String dumpBaseRelocArg = dump_base_reloc ? forceRelocation : "-showversion";

        String dumpTopRelocArg  = dump_top_reloc  ? forceRelocation : "-showversion";

        String runRelocArg      = run_reloc       ? forceRelocation : "-showversion";

        String logArg = "-Xlog:cds=debug,cds+reloc=debug";

        String baseArchiveName = getNewArchiveName("base");

        String topArchiveName  = getNewArchiveName("top");

        String unlockArg = "-XX:+UnlockDiagnosticVMOptions";

        // (1) Dump base archive (static)

        OutputAnalyzer out = dumpBaseArchive(baseArchiveName, unlockArg, dumpBaseRelocArg, logArg);

        if (dump_base_reloc) {

            out.shouldContain("ArchiveRelocationMode == 1: always allocate class space at an alternative address");

            out.shouldContain("Relocating archive from");

        }

        // (2) Dump top archive (dynamic)

        dump2(baseArchiveName, topArchiveName,

              unlockArg,

              dumpTopRelocArg,

              logArg,

              "-cp", appJar, mainClass)

            .assertNormalExit(output -> {

                    if (dump_top_reloc) {

                        output.shouldContain(runtimeMsg1);

                        output.shouldContain(runtimeMsg2);

                    }

                });

        run2(baseArchiveName, topArchiveName,

             unlockArg,

             runRelocArg,

             logArg,

            "-cp", appJar, mainClass)

            .assertNormalExit(output -> {

                    if (run_reloc) {

                        output.shouldContain(runtimeMsg1);

                        output.shouldContain(runtimeMsg2);

                    }

                });

    }

}