1 /*
2 * Copyright (c) 2014, 2017, 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 TestGCLogMessages
26 * @bug 8035406 8027295 8035398 8019342 8027959 8048179 8027962 8069330 8076463 8150630 8160055 8177059 8166191
27 * @summary Ensure the output for a minor GC with G1
28 * includes the expected necessary messages.
29 * @key gc
30 * @requires vm.gc.G1
31 * @library /test/lib
32 * @modules java.base/jdk.internal.misc
33 * java.management
34 * @build sun.hotspot.WhiteBox
35 * @run main ClassFileInstaller sun.hotspot.WhiteBox
36 * @run main TestGCLogMessages
37 */
38
39 import jdk.test.lib.process.OutputAnalyzer;
40 import jdk.test.lib.process.ProcessTools;
41 import jdk.test.lib.Platform;
42
43 public class TestGCLogMessages {
44
45 private enum Level {
46 OFF(""),
47 INFO("info"),
48 DEBUG("debug"),
49 TRACE("trace");
50
51 private String logName;
52
53 Level(String logName) {
54 this.logName = logName;
55 }
56
57 public boolean lessThan(Level other) {
58 return this.compareTo(other) < 0;
59 }
60
61 public String toString() {
62 return logName;
63 }
64 }
65
66 private class LogMessageWithLevel {
67 String message;
68 Level level;
69
70 public LogMessageWithLevel(String message, Level level) {
71 this.message = message;
72 this.level = level;
73 }
74
75 public boolean isAvailable() {
76 return true;
77 }
78 };
79
80 private class LogMessageWithLevelC2OrJVMCIOnly extends LogMessageWithLevel {
81 public LogMessageWithLevelC2OrJVMCIOnly(String message, Level level) {
82 super(message, level);
83 }
84
85 public boolean isAvailable() {
86 return Platform.isGraal() || Platform.isServer();
87 }
88 }
89
90 private LogMessageWithLevel allLogMessages[] = new LogMessageWithLevel[] {
91 new LogMessageWithLevel("Pre Evacuate Collection Set", Level.INFO),
92 new LogMessageWithLevel("Evacuate Collection Set", Level.INFO),
93 new LogMessageWithLevel("Post Evacuate Collection Set", Level.INFO),
94 new LogMessageWithLevel("Other", Level.INFO),
95
96 // Update RS
97 new LogMessageWithLevel("Update RS", Level.DEBUG),
98 new LogMessageWithLevel("Processed Buffers", Level.DEBUG),
99 new LogMessageWithLevel("Scanned Cards", Level.DEBUG),
100 new LogMessageWithLevel("Skipped Cards", Level.DEBUG),
101 new LogMessageWithLevel("Scan HCC", Level.TRACE),
102 // Scan RS
103 new LogMessageWithLevel("Scan RS", Level.DEBUG),
104 new LogMessageWithLevel("Scanned Cards", Level.DEBUG),
105 new LogMessageWithLevel("Claimed Cards", Level.DEBUG),
106 new LogMessageWithLevel("Skipped Cards", Level.DEBUG),
107 // Ext Root Scan
108 new LogMessageWithLevel("Thread Roots", Level.TRACE),
109 new LogMessageWithLevel("StringTable Roots", Level.TRACE),
110 new LogMessageWithLevel("Universe Roots", Level.TRACE),
111 new LogMessageWithLevel("JNI Handles Roots", Level.TRACE),
112 new LogMessageWithLevel("ObjectSynchronizer Roots", Level.TRACE),
113 new LogMessageWithLevel("FlatProfiler Roots", Level.TRACE),
114 new LogMessageWithLevel("Management Roots", Level.TRACE),
115 new LogMessageWithLevel("SystemDictionary Roots", Level.TRACE),
116 new LogMessageWithLevel("CLDG Roots", Level.TRACE),
117 new LogMessageWithLevel("JVMTI Roots", Level.TRACE),
118 new LogMessageWithLevel("SATB Filtering", Level.TRACE),
119 new LogMessageWithLevel("CM RefProcessor Roots", Level.TRACE),
120 new LogMessageWithLevel("Wait For Strong CLD", Level.TRACE),
121 new LogMessageWithLevel("Weak CLD Roots", Level.TRACE),
122 // Redirty Cards
123 new LogMessageWithLevel("Redirty Cards", Level.DEBUG),
124 new LogMessageWithLevel("Parallel Redirty", Level.TRACE),
125 new LogMessageWithLevel("Redirtied Cards", Level.TRACE),
126 // Misc Top-level
127 new LogMessageWithLevel("Code Roots Purge", Level.DEBUG),
128 new LogMessageWithLevel("String Dedup Fixup", Level.DEBUG),
129 new LogMessageWithLevel("Expand Heap After Collection", Level.DEBUG),
130 // Free CSet
131 new LogMessageWithLevel("Free Collection Set", Level.DEBUG),
132 new LogMessageWithLevel("Free Collection Set Serial", Level.TRACE),
133 new LogMessageWithLevel("Young Free Collection Set", Level.TRACE),
134 new LogMessageWithLevel("Non-Young Free Collection Set", Level.TRACE),
135 // Humongous Eager Reclaim
136 new LogMessageWithLevel("Humongous Reclaim", Level.DEBUG),
137 new LogMessageWithLevel("Humongous Register", Level.DEBUG),
138 // Preserve CM Referents
139 new LogMessageWithLevel("Preserve CM Refs", Level.DEBUG),
140 // Merge PSS
141 new LogMessageWithLevel("Merge Per-Thread State", Level.DEBUG),
142 // TLAB handling
143 new LogMessageWithLevel("Prepare TLABs", Level.DEBUG),
144 new LogMessageWithLevel("Resize TLABs", Level.DEBUG),
145
146 new LogMessageWithLevelC2OrJVMCIOnly("DerivedPointerTable Update", Level.DEBUG),
147 new LogMessageWithLevel("Start New Collection Set", Level.DEBUG),
148 };
149
150 void checkMessagesAtLevel(OutputAnalyzer output, LogMessageWithLevel messages[], Level level) throws Exception {
151 for (LogMessageWithLevel l : messages) {
152 if (level.lessThan(l.level) || !l.isAvailable()) {
153 output.shouldNotContain(l.message);
154 } else {
155 output.shouldMatch("\\[" + l.level + ".*" + l.message);
156 }
157 }
158 }
159
160 public static void main(String[] args) throws Exception {
161 new TestGCLogMessages().testNormalLogs();
162 new TestGCLogMessages().testWithToSpaceExhaustionLogs();
163 new TestGCLogMessages().testWithInitialMark();
164 new TestGCLogMessages().testExpandHeap();
165 }
166
167 private void testNormalLogs() throws Exception {
168
169 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
170 "-Xmx10M",
171 GCTest.class.getName());
172
173 OutputAnalyzer output = new OutputAnalyzer(pb.start());
174 checkMessagesAtLevel(output, allLogMessages, Level.OFF);
175 output.shouldHaveExitValue(0);
176
177 pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
178 "-XX:+UseStringDeduplication",
179 "-Xmx10M",
180 "-Xlog:gc+phases=debug",
181 GCTest.class.getName());
182
183 output = new OutputAnalyzer(pb.start());
184 checkMessagesAtLevel(output, allLogMessages, Level.DEBUG);
185
186 pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
187 "-XX:+UseStringDeduplication",
188 "-Xmx10M",
189 "-Xlog:gc+phases=trace",
190 GCTest.class.getName());
191
192 output = new OutputAnalyzer(pb.start());
193 checkMessagesAtLevel(output, allLogMessages, Level.TRACE);
194 output.shouldHaveExitValue(0);
195 }
196
197 LogMessageWithLevel exhFailureMessages[] = new LogMessageWithLevel[] {
198 new LogMessageWithLevel("Evacuation Failure", Level.DEBUG),
199 new LogMessageWithLevel("Recalculate Used", Level.TRACE),
200 new LogMessageWithLevel("Remove Self Forwards", Level.TRACE),
201 };
202
203 private void testWithToSpaceExhaustionLogs() throws Exception {
204 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
205 "-Xmx32M",
206 "-Xmn16M",
207 "-Xlog:gc+phases=debug",
208 GCTestWithToSpaceExhaustion.class.getName());
209
210 OutputAnalyzer output = new OutputAnalyzer(pb.start());
211 checkMessagesAtLevel(output, exhFailureMessages, Level.DEBUG);
212 output.shouldHaveExitValue(0);
213
214 pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
215 "-Xmx32M",
216 "-Xmn16M",
217 "-Xlog:gc+phases=trace",
218 GCTestWithToSpaceExhaustion.class.getName());
219
220 output = new OutputAnalyzer(pb.start());
221 checkMessagesAtLevel(output, exhFailureMessages, Level.TRACE);
222 output.shouldHaveExitValue(0);
223 }
224
225 private void testWithInitialMark() throws Exception {
226 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
227 "-Xmx10M",
228 "-Xbootclasspath/a:.",
229 "-Xlog:gc*=debug",
230 "-XX:+UnlockDiagnosticVMOptions",
231 "-XX:+WhiteBoxAPI",
232 GCTestWithInitialMark.class.getName());
233
234 OutputAnalyzer output = new OutputAnalyzer(pb.start());
235 output.shouldContain("Clear Claimed Marks");
236 output.shouldHaveExitValue(0);
237 }
238
239 private void testExpandHeap() throws Exception {
240 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
241 "-Xmx10M",
242 "-Xbootclasspath/a:.",
243 "-Xlog:gc+ergo+heap=debug",
244 "-XX:+UnlockDiagnosticVMOptions",
245 "-XX:+WhiteBoxAPI",
246 GCTest.class.getName());
247
248 OutputAnalyzer output = new OutputAnalyzer(pb.start());
249 output.shouldContain("Expand the heap. requested expansion amount: ");
250 output.shouldContain("B expansion amount: ");
251 output.shouldHaveExitValue(0);
252 }
253
254
255 static class GCTest {
256 private static byte[] garbage;
257 public static void main(String [] args) {
258 System.out.println("Creating garbage");
259 // create 128MB of garbage. This should result in at least one GC
260 for (int i = 0; i < 1024; i++) {
261 garbage = new byte[128 * 1024];
262 }
263 System.out.println("Done");
264 }
265 }
266
267 static class GCTestWithToSpaceExhaustion {
268 private static byte[] garbage;
269 private static byte[] largeObject;
270 public static void main(String [] args) {
271 largeObject = new byte[16*1024*1024];
272 System.out.println("Creating garbage");
273 // create 128MB of garbage. This should result in at least one GC,
274 // some of them with to-space exhaustion.
275 for (int i = 0; i < 1024; i++) {
276 garbage = new byte[128 * 1024];
277 }
278 System.out.println("Done");
279 }
280 }
281
282 static class GCTestWithInitialMark {
283 public static void main(String [] args) {
284 sun.hotspot.WhiteBox WB = sun.hotspot.WhiteBox.getWhiteBox();
285 WB.g1StartConcMarkCycle();
286 }
287 }
288
289 }
290