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