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/jdk.internal.misc
  29  *          java.management
  30  *          jdk.attach/sun.tools.attach
  31  *          jdk.jvmstat/sun.jvmstat.monitor
  32  * @build jdk.test.lib.* TestOptionsWithRanges
  33  * @run main/othervm/timeout=900 TestOptionsWithRanges
  34  */
  35 
  36 import java.util.ArrayList;
  37 import java.util.List;
  38 import java.util.Map;
  39 import jdk.test.lib.Asserts;
  40 import optionsvalidation.JVMOption;
  41 import optionsvalidation.JVMOptionsUtils;
  42 
  43 public class TestOptionsWithRanges {
  44 
  45     private static Map<String, JVMOption> allOptionsAsMap;
  46 
  47     private static void excludeTestMaxRange(String optionName) {
  48         JVMOption option = allOptionsAsMap.get(optionName);
  49 
  50         if (option != null) {
  51             option.excludeTestMaxRange();
  52         }
  53     }
  54 
  55     private static void excludeTestMinRange(String optionName) {
  56         JVMOption option = allOptionsAsMap.get(optionName);
  57 
  58         if (option != null) {
  59             option.excludeTestMinRange();
  60         }
  61     }
  62 
  63     private static void excludeTestRange(String optionName) {
  64         allOptionsAsMap.remove(optionName);
  65     }
  66 
  67     private static void setAllowedExitCodes(String optionName, Integer... allowedExitCodes) {
  68         JVMOption option = allOptionsAsMap.get(optionName);
  69 
  70         if (option != null) {
  71             option.setAllowedExitCodes(allowedExitCodes);
  72         }
  73     }
  74 
  75     public static void main(String[] args) throws Exception {
  76         int failedTests;
  77         List<JVMOption> allOptions;
  78 
  79         allOptionsAsMap = JVMOptionsUtils.getOptionsWithRangeAsMap(origin -> (!(origin.contains("develop") || origin.contains("notproduct"))));
  80 
  81         /* Shared flags can cause JVM to exit with error code 2 */
  82         setAllowedExitCodes("SharedReadWriteSize", 2);
  83         setAllowedExitCodes("SharedReadOnlySize", 2);
  84         setAllowedExitCodes("SharedMiscDataSize", 2);
  85         setAllowedExitCodes("SharedMiscCodeSize", 2);
  86 
  87         /*
  88          * Remove CICompilerCount from testing because currently it can hang system
  89          */
  90         excludeTestMaxRange("CICompilerCount");
  91 
  92         /*
  93          * JDK-8156679
  94          * Temporarily exclude from range testing as the range is not
  95          * valid for all platforms
  96          */
  97         excludeTestRange("AllocatePrefetchLines");
  98         excludeTestRange("AllocateInstancePrefetchLines");
  99 
 100         /*
 101          * JDK-8136766
 102          * Temporarily remove ThreadStackSize from testing because Windows can set it to 0
 103          * (for default OS size) but other platforms insist it must be greater than 0
 104         */
 105         excludeTestRange("ThreadStackSize");
 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("G1ConcRefinementThreads");
 125         excludeTestMaxRange("G1RSetRegionEntries");
 126         excludeTestMaxRange("G1RSetSparseRegionEntries");
 127         excludeTestMaxRange("G1UpdateBufferSize");
 128         excludeTestMaxRange("InitialBootClassLoaderMetaspaceSize");
 129         excludeTestMaxRange("InitialHeapSize");
 130         excludeTestMaxRange("MaxHeapSize");
 131         excludeTestMaxRange("MaxRAM");
 132         excludeTestMaxRange("NewSize");
 133         excludeTestMaxRange("OldSize");
 134         excludeTestMaxRange("ParallelGCThreads");
 135 
 136         excludeTestMaxRange("VMThreadStackSize");
 137 
 138         /*
 139          * Remove parameters controlling the code cache. As these
 140          * parameters have implications on the physical memory
 141          * reserved by the VM, setting them to large values may hang
 142          * the system and/or may cause concurrently executed tests to
 143          * fail. These parameters are rigorously checked when the code
 144          * cache is initialized (see
 145          * hotspot/src/shared/vm/code/codeCache.cpp), therefore
 146          * omitting testing for them does not pose a problem.
 147          */
 148         excludeTestMaxRange("InitialCodeCacheSize");
 149         excludeTestMaxRange("CodeCacheMinimumUseSpace");
 150         excludeTestMaxRange("ReservedCodeCacheSize");
 151         excludeTestMaxRange("NonProfiledCodeHeapSize");
 152         excludeTestMaxRange("ProfiledCodeHeapSize");
 153         excludeTestMaxRange("NonNMethodCodeHeapSize");
 154         excludeTestMaxRange("CodeCacheExpansionSize");
 155 
 156         allOptions = new ArrayList<>(allOptionsAsMap.values());
 157 
 158         Asserts.assertGT(allOptions.size(), 0, "Options with ranges not found!");
 159 
 160         System.out.println("Parsed " + allOptions.size() + " options with ranges. Start test!");
 161 
 162         failedTests = JVMOptionsUtils.runCommandLineTests(allOptions);
 163 
 164         Asserts.assertEQ(failedTests, 0,
 165                 String.format("%d tests failed! %s", failedTests, JVMOptionsUtils.getMessageWithFailures()));
 166     }
 167 }