/*

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

 * @summary Check that humongous objects reside in nv-dimm

 * @library /test/lib /

 * @requires vm.gc=="null" & os.family != "aix"

 * @build sun.hotspot.WhiteBox

 * @run driver ClassFileInstaller sun.hotspot.WhiteBox

 * @run main TestHumongousObjectsOnNvdimm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions

 *                                  -XX:+WhiteBoxAPI

 */

import jdk.test.lib.process.OutputAnalyzer;

import jdk.test.lib.process.ProcessTools;

import jdk.test.lib.Asserts;

import sun.hotspot.WhiteBox;

import java.util.ArrayList;

import java.util.List;

import java.util.Collections;

import gc.testlibrary.Helpers;

/**

 * Test spawns HumongousObjectTest in a separate VM and expects that it

 * completes without a RuntimeException.

 */

public class TestHumongousObjectsOnNvdimm {

    private static ArrayList<String> testOpts;

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

        testOpts = new ArrayList();

        String[] common_options = new String[] {

            "-Xbootclasspath/a:.",

            "-XX:+UnlockExperimentalVMOptions",

            "-XX:+UnlockDiagnosticVMOptions",

            "-XX:+WhiteBoxAPI",

            "-XX:AllocateOldGenAt="+System.getProperty("test.dir", "."),

            "-Xms10M", "-Xmx10M",

            "-XX:G1HeapRegionSize=1m"

        };

        String testVmOptsStr = System.getProperty("test.java.opts");

        if (!testVmOptsStr.isEmpty()) {

            String[] testVmOpts = testVmOptsStr.split(" ");

            Collections.addAll(testOpts, testVmOpts);

        }

        Collections.addAll(testOpts, common_options);

        // Test with G1 GC

        runTest("-XX:+UseG1GC");

    }

    private static void runTest(String... extraFlags) throws Exception {

        Collections.addAll(testOpts, extraFlags);

        testOpts.add(HumongousObjectTest.class.getName());

        System.out.println(testOpts);

        ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(false,

                testOpts.toArray(new String[testOpts.size()]));

        OutputAnalyzer output = new OutputAnalyzer(pb.start());

        output.shouldHaveExitValue(0);

    }

}

/**

 * This class tests that a humongous object resides in NVDIMM.

 */

class HumongousObjectTest {

    private static final WhiteBox WB = WhiteBox.getWhiteBox();

    private static void validateObject(Object o) {

        Asserts.assertTrue(WB.isObjectInOldGen(o),

                "Object is supposed to be in OldGen");

        long obj_addr = WB.getObjectAddress(o);

        long nvdimm_heap_start = WB.nvdimmReservedStart();

        long nvdimm_heap_end = WB.nvdimmReservedEnd();

        Asserts.assertTrue(WB.g1BelongsToHumongousRegion(obj_addr), "Object address should be in Humongous set");

        Asserts.assertTrue(obj_addr >= nvdimm_heap_start && obj_addr < nvdimm_heap_end,

                "Humongous object does not reside in NVDIMM");

    }

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

        // allocate an humongous object

        int byteArrayMemoryOverhead = Helpers.detectByteArrayAllocationOverhead();

        int MinByteArrayHumongousSize = (WB.g1RegionSize() / 2) - byteArrayMemoryOverhead + 1;

        byte[] obj = new byte[MinByteArrayHumongousSize];

        validateObject(obj);

    }

}