test/gc/arguments/TestMaxHeapSizeTools.java

Thu, 18 Jul 2013 03:38:10 -0700

author
cl
date
Thu, 18 Jul 2013 03:38:10 -0700
changeset 5396
bb416ee2a79b
parent 5116
7a95933197d0
child 6085
8f07aa079343
permissions
-rw-r--r--

Added tag jdk8-b99 for changeset 81b6cb70717c

     1 /*
     2 * Copyright (c) 2013, 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 */
    24 import java.util.regex.Matcher;
    25 import java.util.regex.Pattern;
    26 import java.util.ArrayList;
    27 import java.util.Arrays;
    29 import com.oracle.java.testlibrary.*;
    30 import sun.hotspot.WhiteBox;
    32 class ErgoArgsPrinter {
    33   public static void main(String[] args) throws Exception {
    34     WhiteBox wb = WhiteBox.getWhiteBox();
    35     wb.printHeapSizes();
    36   }
    37 }
    39 final class MinInitialMaxValues {
    40   public long minHeapSize;
    41   public long initialHeapSize;
    42   public long maxHeapSize;
    44   public long minAlignment;
    45   public long maxAlignment;
    46 }
    48 class TestMaxHeapSizeTools {
    50   public static void checkMinInitialMaxHeapFlags(String gcflag) throws Exception {
    51     checkInvalidMinInitialHeapCombinations(gcflag);
    52     checkValidMinInitialHeapCombinations(gcflag);
    53     checkInvalidInitialMaxHeapCombinations(gcflag);
    54     checkValidInitialMaxHeapCombinations(gcflag);
    55   }
    57   public static void checkMinInitialErgonomics(String gcflag) throws Exception {
    58     // heap sizing ergonomics use the value NewSize + OldSize as default values
    59     // for ergonomics calculation. Retrieve these values.
    60     long[] values = new long[2];
    61     getNewOldSize(gcflag, values);
    63     // we check cases with values smaller and larger than this default value.
    64     long newPlusOldSize = values[0] + values[1];
    65     long smallValue = newPlusOldSize / 2;
    66     long largeValue = newPlusOldSize * 2;
    68     // -Xms is not set
    69     checkErgonomics(new String[] { gcflag, "-Xmx16M" }, values, -1, -1);
    70     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-XX:InitialHeapSize=" + smallValue }, values, smallValue, smallValue);
    71     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-XX:InitialHeapSize=" + largeValue }, values, -1, largeValue);
    72     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-XX:InitialHeapSize=0" }, values, -1, -1);
    74     // -Xms is set to zero
    75     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms0" }, values, -1, -1);
    76     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms0", "-XX:InitialHeapSize=" + smallValue }, values, smallValue, smallValue);
    77     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms0", "-XX:InitialHeapSize=" + largeValue }, values, -1, largeValue);
    78     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms0", "-XX:InitialHeapSize=0" }, values, -1, -1);
    80     // -Xms is set to small value
    81     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + smallValue }, values, -1, -1);
    82     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + smallValue, "-XX:InitialHeapSize=" + smallValue }, values, smallValue, smallValue);
    83     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + smallValue, "-XX:InitialHeapSize=" + largeValue }, values, smallValue, largeValue);
    84     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + smallValue, "-XX:InitialHeapSize=0" }, values, smallValue, -1);
    86     // -Xms is set to large value
    87     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + largeValue }, values, largeValue, largeValue);
    88     // the next case has already been checked elsewhere and gives an error
    89     // checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + largeValue, "-XX:InitialHeapSize=" + smallValue }, values, smallValue, smallValue);
    90     // the next case has already been checked elsewhere too
    91     // checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + largeValue, "-XX:InitialHeapSize=" + largeValue }, values, values[0], largeValue);
    92     checkErgonomics(new String[] { gcflag, "-Xmx16M", "-Xms" + largeValue, "-XX:InitialHeapSize=0" }, values, largeValue, -1);
    93   }
    95   private static long align_up(long value, long alignment) {
    96     long alignmentMinusOne = alignment - 1;
    97     return (value + alignmentMinusOne) & ~alignmentMinusOne;
    98   }
   100   private static void getNewOldSize(String gcflag, long[] values) throws Exception {
   101     ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(gcflag,
   102       "-XX:+PrintFlagsFinal", "-version");
   103     OutputAnalyzer output = new OutputAnalyzer(pb.start());
   104     output.shouldHaveExitValue(0);
   106     String stdout = output.getStdout();
   107     values[0] = getFlagValue(" NewSize", stdout);
   108     values[1] = getFlagValue(" OldSize", stdout);
   109   }
   111   public static void checkGenMaxHeapErgo(String gcflag) throws Exception {
   112     TestMaxHeapSizeTools.checkGenMaxHeapSize(gcflag, 3);
   113     TestMaxHeapSizeTools.checkGenMaxHeapSize(gcflag, 4);
   114     TestMaxHeapSizeTools.checkGenMaxHeapSize(gcflag, 5);
   115   }
   117   private static void checkInvalidMinInitialHeapCombinations(String gcflag) throws Exception {
   118     expectError(new String[] { gcflag, "-Xms8M", "-XX:InitialHeapSize=4M", "-version" });
   119   }
   121   private static void checkValidMinInitialHeapCombinations(String gcflag) throws Exception {
   122     expectValid(new String[] { gcflag, "-XX:InitialHeapSize=8M", "-Xms4M", "-version" });
   123     expectValid(new String[] { gcflag, "-Xms4M", "-XX:InitialHeapSize=8M", "-version" });
   124     expectValid(new String[] { gcflag, "-XX:InitialHeapSize=8M", "-Xms8M", "-version" });
   125     // the following is not an error as -Xms sets both minimal and initial heap size
   126     expectValid(new String[] { gcflag, "-XX:InitialHeapSize=4M", "-Xms8M", "-version" });
   127   }
   129   private static void checkInvalidInitialMaxHeapCombinations(String gcflag) throws Exception {
   130     expectError(new String[] { gcflag, "-XX:MaxHeapSize=4M", "-XX:InitialHeapSize=8M", "-version" });
   131     expectError(new String[] { gcflag, "-XX:InitialHeapSize=8M", "-XX:MaxHeapSize=4M", "-version" });
   132   }
   134   private static void checkValidInitialMaxHeapCombinations(String gcflag) throws Exception {
   135     expectValid(new String[] { gcflag, "-XX:InitialHeapSize=4M", "-XX:MaxHeapSize=8M", "-version" });
   136     expectValid(new String[] { gcflag, "-XX:MaxHeapSize=8M", "-XX:InitialHeapSize=4M", "-version" });
   137     expectValid(new String[] { gcflag, "-XX:MaxHeapSize=4M", "-XX:InitialHeapSize=4M", "-version" });
   138     // a value of "0" for initial heap size means auto-detect
   139     expectValid(new String[] { gcflag, "-XX:MaxHeapSize=4M", "-XX:InitialHeapSize=0M", "-version" });
   140   }
   142   private static long valueAfter(String source, String match) {
   143     int start = source.indexOf(match) + match.length();
   144     String tail = source.substring(start).split(" ")[0];
   145     return Long.parseLong(tail);
   146   }
   148   /**
   149    * Executes a new VM process with the given class and parameters.
   150    * @param vmargs Arguments to the VM to run
   151    * @param classname Name of the class to run
   152    * @param arguments Arguments to the class
   153    * @param useTestDotJavaDotOpts Use test.java.opts as part of the VM argument string
   154    * @return The OutputAnalyzer with the results for the invocation.
   155    */
   156   public static OutputAnalyzer runWhiteBoxTest(String[] vmargs, String classname, String[] arguments, boolean useTestDotJavaDotOpts) throws Exception {
   157     ArrayList<String> finalargs = new ArrayList<String>();
   159     String[] whiteboxOpts = new String[] {
   160       "-Xbootclasspath/a:.",
   161       "-XX:+UnlockDiagnosticVMOptions", "-XX:+WhiteBoxAPI",
   162       "-cp", System.getProperty("java.class.path"),
   163     };
   165     if (useTestDotJavaDotOpts) {
   166       // System.getProperty("test.java.opts") is '' if no options is set,
   167       // we need to skip such a result
   168       String[] externalVMOpts = new String[0];
   169       if (System.getProperty("test.java.opts") != null && System.getProperty("test.java.opts").length() != 0) {
   170         externalVMOpts = System.getProperty("test.java.opts").split(" ");
   171       }
   172       finalargs.addAll(Arrays.asList(externalVMOpts));
   173     }
   175     finalargs.addAll(Arrays.asList(vmargs));
   176     finalargs.addAll(Arrays.asList(whiteboxOpts));
   177     finalargs.add(classname);
   178     finalargs.addAll(Arrays.asList(arguments));
   180     ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(finalargs.toArray(new String[0]));
   181     OutputAnalyzer output = new OutputAnalyzer(pb.start());
   182     output.shouldHaveExitValue(0);
   184     return output;
   185   }
   187   private static void getMinInitialMaxHeap(String[] args, MinInitialMaxValues val) throws Exception {
   188     OutputAnalyzer output = runWhiteBoxTest(args, ErgoArgsPrinter.class.getName(), new String[] {}, false);
   190     // the output we watch for has the following format:
   191     //
   192     // "Minimum heap X Initial heap Y Maximum heap Z Min alignment A Max Alignment B"
   193     //
   194     // where A, B, X, Y and Z are sizes in bytes.
   195     // Unfortunately there is no other way to retrieve the minimum heap size and
   196     // the alignments.
   198     Matcher m = Pattern.compile("Minimum heap \\d+ Initial heap \\d+ Maximum heap \\d+ Min alignment \\d+ Max alignment \\d+").
   199       matcher(output.getStdout());
   200     if (!m.find()) {
   201       throw new RuntimeException("Could not find heap size string.");
   202     }
   204     String match = m.group();
   206     // actual values
   207     val.minHeapSize = valueAfter(match, "Minimum heap ");
   208     val.initialHeapSize = valueAfter(match, "Initial heap ");
   209     val.maxHeapSize = valueAfter(match, "Maximum heap ");
   210     val.minAlignment = valueAfter(match, "Min alignment ");
   211     val.maxAlignment = valueAfter(match, "Max alignment ");
   212   }
   214   /**
   215    * Verify whether the VM automatically synchronizes minimum and initial heap size if only
   216    * one is given for the GC specified.
   217    */
   218   public static void checkErgonomics(String[] args, long[] newoldsize,
   219     long expectedMin, long expectedInitial) throws Exception {
   221     MinInitialMaxValues v = new MinInitialMaxValues();
   222     getMinInitialMaxHeap(args, v);
   224     if ((expectedMin != -1) && (align_up(expectedMin, v.minAlignment) != v.minHeapSize)) {
   225       throw new RuntimeException("Actual minimum heap size of " + v.minHeapSize +
   226         " differs from expected minimum heap size of " + expectedMin);
   227     }
   229     if ((expectedInitial != -1) && (align_up(expectedInitial, v.minAlignment) != v.initialHeapSize)) {
   230       throw new RuntimeException("Actual initial heap size of " + v.initialHeapSize +
   231         " differs from expected initial heap size of " + expectedInitial);
   232     }
   234     // always check the invariant min <= initial <= max heap size
   235     if (!(v.minHeapSize <= v.initialHeapSize && v.initialHeapSize <= v.maxHeapSize)) {
   236       throw new RuntimeException("Inconsistent min/initial/max heap sizes, they are " +
   237         v.minHeapSize + "/" + v.initialHeapSize + "/" + v.maxHeapSize);
   238     }
   239   }
   241   /**
   242    * Verify whether the VM respects the given maximum heap size in MB for the
   243    * GC specified.
   244    * @param gcflag The garbage collector to test as command line flag. E.g. -XX:+UseG1GC
   245    * @param maxHeapSize the maximum heap size to verify, in MB.
   246    */
   247   public static void checkGenMaxHeapSize(String gcflag, long maxHeapsize) throws Exception {
   248     final long K = 1024;
   250     MinInitialMaxValues v = new MinInitialMaxValues();
   251     getMinInitialMaxHeap(new String[] { gcflag, "-XX:MaxHeapSize=" + maxHeapsize + "M" }, v);
   253     long expectedHeapSize = align_up(maxHeapsize * K * K, v.maxAlignment);
   254     long actualHeapSize = v.maxHeapSize;
   256     if (actualHeapSize > expectedHeapSize) {
   257       throw new RuntimeException("Heap has " + actualHeapSize  +
   258         " bytes, expected to be less than " + expectedHeapSize);
   259     }
   260   }
   262   private static long getFlagValue(String flag, String where) {
   263     Matcher m = Pattern.compile(flag + "\\s+:?=\\s+\\d+").matcher(where);
   264     if (!m.find()) {
   265       throw new RuntimeException("Could not find value for flag " + flag + " in output string");
   266     }
   267     String match = m.group();
   268     return Long.parseLong(match.substring(match.lastIndexOf(" ") + 1, match.length()));
   269   }
   271   private static void shouldContainOrNot(OutputAnalyzer output, boolean contains, String message) throws Exception {
   272     if (contains) {
   273       output.shouldContain(message);
   274     } else {
   275       output.shouldNotContain(message);
   276     }
   277   }
   279   private static void expect(String[] flags, boolean hasWarning, boolean hasError, int errorcode) throws Exception {
   280     ProcessBuilder pb = ProcessTools.createJavaProcessBuilder(flags);
   281     OutputAnalyzer output = new OutputAnalyzer(pb.start());
   282     shouldContainOrNot(output, hasWarning, "Warning");
   283     shouldContainOrNot(output, hasError, "Error");
   284     output.shouldHaveExitValue(errorcode);
   285   }
   287   private static void expectError(String[] flags) throws Exception {
   288     expect(flags, false, true, 1);
   289   }
   291   private static void expectValid(String[] flags) throws Exception {
   292     expect(flags, false, false, 0);
   293   }
   294 }

mercurial