1 /*
   2  * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 /*
  25  * @test
  26  * @summary Test VM Options with ranges
  27  * @library /testlibrary /runtime/CommandLine/OptionsValidation/common
  28  * @modules java.base/sun.misc
  29  *          java.management
  30  *          jdk.attach
  31  *          jdk.management/sun.tools.attach
  32  * @run main/othervm/timeout=900 TestOptionsWithRanges
  33  */
  34 
  35 import java.util.ArrayList;
  36 import java.util.List;
  37 import java.util.Map;
  38 import jdk.test.lib.Asserts;
  39 import optionsvalidation.JVMOption;
  40 import optionsvalidation.JVMOptionsUtils;
  41 
  42 public class TestOptionsWithRanges {
  43 
  44     private static Map<String, JVMOption> allOptionsAsMap;
  45 
  46     private static void excludeTestMaxRange(String optionName) {
  47         JVMOption option = allOptionsAsMap.get(optionName);
  48 
  49         if (option != null) {
  50             option.excludeTestMaxRange();
  51         }
  52     }
  53 
  54     private static void excludeTestMinRange(String optionName) {
  55         JVMOption option = allOptionsAsMap.get(optionName);
  56 
  57         if (option != null) {
  58             option.excludeTestMinRange();
  59         }
  60     }
  61 
  62     private static void excludeTestRange(String optionName) {
  63         allOptionsAsMap.remove(optionName);
  64     }
  65 
  66     private static void setAllowedExitCodes(String optionName, Integer... allowedExitCodes) {
  67         JVMOption option = allOptionsAsMap.get(optionName);
  68 
  69         if (option != null) {
  70             option.setAllowedExitCodes(allowedExitCodes);
  71         }
  72     }
  73 
  74     public static void main(String[] args) throws Exception {
  75         int failedTests;
  76         List<JVMOption> allOptions;
  77 
  78         allOptionsAsMap = JVMOptionsUtils.getOptionsWithRangeAsMap(origin -> (!(origin.contains("develop") || origin.contains("notproduct"))));
  79 
  80         /* Shared flags can cause JVM to exit with error code 2 */
  81         setAllowedExitCodes("SharedReadWriteSize", 2);
  82         setAllowedExitCodes("SharedReadOnlySize", 2);
  83         setAllowedExitCodes("SharedMiscDataSize", 2);
  84         setAllowedExitCodes("SharedMiscCodeSize", 2);
  85 
  86         /*
  87          * Remove CICompilerCount from testing because currently it can hang system
  88          */
  89         excludeTestMaxRange("CICompilerCount");
  90 
  91         /*
  92          * JDK-8136766
  93          * Temporarily remove ThreadStackSize from testing because Windows can set it to 0
  94          * (for default OS size) but other platforms insist it must be greater than 0
  95         */
  96         excludeTestRange("ThreadStackSize");
  97 
  98         /*
  99          * JDK-8143958
 100          * Temporarily exclude testing of max range for Shared* flags
 101          */
 102         excludeTestMaxRange("SharedReadWriteSize");
 103         excludeTestMaxRange("SharedReadOnlySize");
 104         excludeTestMaxRange("SharedMiscDataSize");
 105         excludeTestMaxRange("SharedMiscCodeSize");
 106 
 107         /*
 108          * Remove the flag controlling the size of the stack because the
 109          * flag has direct influence on the physical memory usage of
 110          * the VM.
 111          */
 112         allOptionsAsMap.remove("CompilerThreadStackSize");
 113 
 114         /*
 115          * Exclude MallocMaxTestWords as it is expected to exit VM at small values (>=0)
 116          */
 117         excludeTestMinRange("MallocMaxTestWords");
 118 
 119         /*
 120          * Exclude below options as their maximum value would consume too much memory
 121          * and would affect other tests that run in parallel.
 122          */
 123         excludeTestMaxRange("ConcGCThreads");
 124         excludeTestMaxRange("CMSSamplingGrain");
 125         excludeTestMaxRange("G1ConcRefinementThreads");
 126         excludeTestMaxRange("G1RSetRegionEntries");
 127         excludeTestMaxRange("G1RSetSparseRegionEntries");
 128         excludeTestMaxRange("G1UpdateBufferSize");
 129         excludeTestMaxRange("InitialBootClassLoaderMetaspaceSize");
 130         excludeTestMaxRange("InitialHeapSize");
 131         excludeTestMaxRange("MaxHeapSize");
 132         excludeTestMaxRange("MaxRAM");
 133         excludeTestMaxRange("NewSize");
 134         excludeTestMaxRange("OldSize");
 135         excludeTestMaxRange("ParallelGCThreads");
 136 
 137         excludeTestMaxRange("VMThreadStackSize");
 138 
 139         /*
 140          * Remove parameters controlling the code cache. As these
 141          * parameters have implications on the physical memory
 142          * reserved by the VM, setting them to large values may hang
 143          * the system and/or may cause concurrently executed tests to
 144          * fail. These parameters are rigorously checked when the code
 145          * cache is initialized (see
 146          * hotspot/src/shared/vm/code/codeCache.cpp), therefore
 147          * omitting testing for them does not pose a problem.
 148          */
 149         excludeTestMaxRange("InitialCodeCacheSize");
 150         excludeTestMaxRange("CodeCacheMinimumUseSpace");
 151         excludeTestMaxRange("ReservedCodeCacheSize");
 152         excludeTestMaxRange("NonProfiledCodeHeapSize");
 153         excludeTestMaxRange("ProfiledCodeHeapSize");
 154         excludeTestMaxRange("NonNMethodCodeHeapSize");
 155         excludeTestMaxRange("CodeCacheExpansionSize");
 156 
 157         allOptions = new ArrayList<>(allOptionsAsMap.values());
 158 
 159         Asserts.assertGT(allOptions.size(), 0, "Options with ranges not found!");
 160 
 161         System.out.println("Parsed " + allOptions.size() + " options with ranges. Start test!");
 162 
 163         failedTests = JVMOptionsUtils.runCommandLineTests(allOptions);
 164 
 165         Asserts.assertEQ(failedTests, 0,
 166                 String.format("%d tests failed! %s", failedTests, JVMOptionsUtils.getMessageWithFailures()));
 167     }
 168 }