jdk-24/test/hotspot/jtreg/runtime/CommandLine/OptionsValidation/TestOptionsWithRanges.java

/*
 * Copyright (c) 2015, 2024, 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.
 */

// --- start auto-generated
// the following portion is auto-generated by TestOptionsWithRanges_generate.sh. Do not edit manually.
/*
 * @test
 * @bug 8205633
 * @summary Test VM Options with ranges (1 of 10)
 * @requires vm.flagless
 * @library /test/lib /runtime/CommandLine/OptionsValidation/common
 * @modules java.base/jdk.internal.misc
 *          java.management
 *          jdk.attach/sun.tools.attach
 *          jdk.internal.jvmstat/sun.jvmstat.monitor
 * @run driver/timeout=1800 TestOptionsWithRanges 1 of 10
 */
/*
 * @test
 * @bug 8205633
 * @summary Test VM Options with ranges (2 of 10)
 * @requires vm.flagless
 * @library /test/lib /runtime/CommandLine/OptionsValidation/common
 * @modules java.base/jdk.internal.misc
 *          java.management
 *          jdk.attach/sun.tools.attach
 *          jdk.internal.jvmstat/sun.jvmstat.monitor
 * @run driver/timeout=1800 TestOptionsWithRanges 2 of 10
 */
/*
 * @test
 * @bug 8205633
 * @summary Test VM Options with ranges (3 of 10)
 * @requires vm.flagless
 * @library /test/lib /runtime/CommandLine/OptionsValidation/common
 * @modules java.base/jdk.internal.misc
 *          java.management
 *          jdk.attach/sun.tools.attach
 *          jdk.internal.jvmstat/sun.jvmstat.monitor
 * @run driver/timeout=1800 TestOptionsWithRanges 3 of 10
 */
/*
 * @test
 * @bug 8205633
 * @summary Test VM Options with ranges (4 of 10)
 * @requires vm.flagless
 * @library /test/lib /runtime/CommandLine/OptionsValidation/common
 * @modules java.base/jdk.internal.misc
 *          java.management
 *          jdk.attach/sun.tools.attach
 *          jdk.internal.jvmstat/sun.jvmstat.monitor
 * @run driver/timeout=1800 TestOptionsWithRanges 4 of 10
 */
/*
 * @test
 * @bug 8205633
 * @summary Test VM Options with ranges (5 of 10)
 * @requires vm.flagless
 * @library /test/lib /runtime/CommandLine/OptionsValidation/common
 * @modules java.base/jdk.internal.misc
 *          java.management
 *          jdk.attach/sun.tools.attach
 *          jdk.internal.jvmstat/sun.jvmstat.monitor
 * @run driver/timeout=1800 TestOptionsWithRanges 5 of 10
 */
/*
 * @test
 * @bug 8205633
 * @summary Test VM Options with ranges (6 of 10)
 * @requires vm.flagless
 * @library /test/lib /runtime/CommandLine/OptionsValidation/common
 * @modules java.base/jdk.internal.misc
 *          java.management
 *          jdk.attach/sun.tools.attach
 *          jdk.internal.jvmstat/sun.jvmstat.monitor
 * @run driver/timeout=1800 TestOptionsWithRanges 6 of 10
 */
/*
 * @test
 * @bug 8205633
 * @summary Test VM Options with ranges (7 of 10)
 * @requires vm.flagless
 * @library /test/lib /runtime/CommandLine/OptionsValidation/common
 * @modules java.base/jdk.internal.misc
 *          java.management
 *          jdk.attach/sun.tools.attach
 *          jdk.internal.jvmstat/sun.jvmstat.monitor
 * @run driver/timeout=1800 TestOptionsWithRanges 7 of 10
 */
/*
 * @test
 * @bug 8205633
 * @summary Test VM Options with ranges (8 of 10)
 * @requires vm.flagless
 * @library /test/lib /runtime/CommandLine/OptionsValidation/common
 * @modules java.base/jdk.internal.misc
 *          java.management
 *          jdk.attach/sun.tools.attach
 *          jdk.internal.jvmstat/sun.jvmstat.monitor
 * @run driver/timeout=1800 TestOptionsWithRanges 8 of 10
 */
/*
 * @test
 * @bug 8205633
 * @summary Test VM Options with ranges (9 of 10)
 * @requires vm.flagless
 * @library /test/lib /runtime/CommandLine/OptionsValidation/common
 * @modules java.base/jdk.internal.misc
 *          java.management
 *          jdk.attach/sun.tools.attach
 *          jdk.internal.jvmstat/sun.jvmstat.monitor
 * @run driver/timeout=1800 TestOptionsWithRanges 9 of 10
 */
/*
 * @test
 * @bug 8205633
 * @summary Test VM Options with ranges (10 of 10)
 * @requires vm.flagless
 * @library /test/lib /runtime/CommandLine/OptionsValidation/common
 * @modules java.base/jdk.internal.misc
 *          java.management
 *          jdk.attach/sun.tools.attach
 *          jdk.internal.jvmstat/sun.jvmstat.monitor
 * @run driver/timeout=1800 TestOptionsWithRanges 10 of 10
 */
// --- end auto-generated

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import jdk.test.lib.Asserts;
import optionsvalidation.JVMOption;
import optionsvalidation.JVMOptionsUtils;

public class TestOptionsWithRanges {

    private static Map<String, JVMOption> allOptionsAsMap;

    private static void excludeTestMaxRange(String optionName) {
        JVMOption option = allOptionsAsMap.get(optionName);

        if (option != null) {
            option.excludeTestMaxRange();
        }
    }

    private static void excludeTestMinRange(String optionName) {
        JVMOption option = allOptionsAsMap.get(optionName);

        if (option != null) {
            option.excludeTestMinRange();
        }
    }

    private static void excludeTestRange(String optionName) {
        allOptionsAsMap.remove(optionName);
    }

    private static void setAllowedExitCodes(String optionName, Integer... allowedExitCodes) {
        JVMOption option = allOptionsAsMap.get(optionName);

        if (option != null) {
            option.setAllowedExitCodes(allowedExitCodes);
        }
    }

    // Return a subset of the test cases, so we can break up allOptionsAsMap into small parts
    // and use them in separate JTREG @test blocks (for parallel execution).
    //
    // args[] must be {part, "of", numParts}. The first part should be "1".
    private static List<JVMOption> getTestSubset(String[] args) throws Exception {
        int part = Integer.parseInt(args[0]) - 1;
        int numParts = Integer.parseInt(args[2]);
        List<String> keys = new ArrayList<>(allOptionsAsMap.keySet());
        Collections.sort(keys);
        int numTests = keys.size();
        int start = numTests * (part    ) / numParts;
        int end   = numTests * (part + 1) / numParts;

        List<JVMOption> subset = new ArrayList<>();
        for (int i=start; i < end; i++) {
            subset.add(allOptionsAsMap.get(keys.get(i)));
        }
        System.out.println("Generating subset [" + start + " ... " + end + ") of " +
                           subset.size() + " tests out of " + keys.size() + " total tests");
        return subset;
    }

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

        allOptionsAsMap = JVMOptionsUtils.getOptionsWithRangeAsMap(origin -> (!origin.contains("develop")));

        /*
         * Exclude VMThreadStackSize from max range testing, because it will always exit with code 1,
         * which technically passes, but really it fails, and worse yet, it produces hs_err_pid file.
         */
        excludeTestMaxRange("VMThreadStackSize");

        /*
         * Exclude CICompilerCount from testing because currently it can hang system
         */
        excludeTestMaxRange("CICompilerCount");

        /*
         * Exclude JVMCI threads counts from testing similar to other threads counts.
         */
        excludeTestMaxRange("JVMCIThreads");
        excludeTestMaxRange("JVMCIHostThreads");

        /*
         * Exclude below options as their maximum value would consume too much memory
         * and would affect other tests that run in parallel.
         */
        excludeTestMaxRange("ConcGCThreads");
        excludeTestMaxRange("G1ConcRefinementThreads");
        excludeTestMaxRange("G1UpdateBufferSize");
        excludeTestMaxRange("InitialHeapSize");
        excludeTestMaxRange("MaxHeapSize");
        excludeTestMaxRange("MaxRAM");
        excludeTestMaxRange("NewSize");
        excludeTestMaxRange("ParallelGCThreads");
        excludeTestMaxRange("TLABSize");

        /*
         * Remove parameters controlling the code cache. As these
         * parameters have implications on the physical memory
         * reserved by the VM, setting them to large values may hang
         * the system and/or may cause concurrently executed tests to
         * fail. These parameters are rigorously checked when the code
         * cache is initialized (see
         * hotspot/src/shared/vm/code/codeCache.cpp), therefore
         * omitting testing for them does not pose a problem.
         */
        excludeTestMaxRange("InitialCodeCacheSize");
        excludeTestMaxRange("CodeCacheMinimumUseSpace");
        excludeTestMaxRange("ReservedCodeCacheSize");
        excludeTestMaxRange("NonProfiledCodeHeapSize");
        excludeTestMaxRange("ProfiledCodeHeapSize");
        excludeTestMaxRange("NonNMethodCodeHeapSize");
        excludeTestMaxRange("CodeCacheExpansionSize");

        /*
         * Exclude CompileThresholdScaling from max range testing, because
         * it is expected to print "outside the allowed range" warnings for the
         * scaled flag and the "outside the allowed range" warning does not
         * refer to CompileThresholdScaling itself.
         */
        excludeTestMaxRange("CompileThresholdScaling");

        List<JVMOption> testSubset = getTestSubset(args);

        Asserts.assertGT(testSubset.size(), 0, "Options with ranges not found!");

        System.out.println("Parsed " + testSubset.size() + " options with ranges. Start test!");

        failedTests = JVMOptionsUtils.runCommandLineTests(testSubset);

        Asserts.assertEQ(failedTests, 0,
                String.format("%d tests failed! %s", failedTests, JVMOptionsUtils.getMessageWithFailures()));
    }
}