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("Scan HCC", Level.TRACE),
100 // Scan RS
101 new LogMessageWithLevel("Scan RS", Level.DEBUG),
102 new LogMessageWithLevel("Scanned Cards", Level.DEBUG),
103 new LogMessageWithLevel("Claimed Cards", Level.DEBUG),
104 new LogMessageWithLevel("Skipped Cards", Level.DEBUG),
105 // Ext Root Scan
106 new LogMessageWithLevel("Thread Roots", Level.TRACE),
107 new LogMessageWithLevel("StringTable Roots", Level.TRACE),
108 new LogMessageWithLevel("Universe Roots", Level.TRACE),
109 new LogMessageWithLevel("JNI Handles Roots", Level.TRACE),
110 new LogMessageWithLevel("ObjectSynchronizer Roots", Level.TRACE),
111 new LogMessageWithLevel("FlatProfiler Roots", Level.TRACE),
112 new LogMessageWithLevel("Management Roots", Level.TRACE),
113 new LogMessageWithLevel("SystemDictionary Roots", Level.TRACE),
114 new LogMessageWithLevel("CLDG Roots", Level.TRACE),
115 new LogMessageWithLevel("JVMTI Roots", Level.TRACE),
116 new LogMessageWithLevel("SATB Filtering", Level.TRACE),
117 new LogMessageWithLevel("CM RefProcessor Roots", Level.TRACE),
118 new LogMessageWithLevel("Wait For Strong CLD", Level.TRACE),
119 new LogMessageWithLevel("Weak CLD Roots", Level.TRACE),
120 // Redirty Cards
121 new LogMessageWithLevel("Redirty Cards", Level.DEBUG),
122 new LogMessageWithLevel("Parallel Redirty", Level.TRACE),
123 new LogMessageWithLevel("Redirtied Cards", Level.TRACE),
124 // Misc Top-level
125 new LogMessageWithLevel("Code Roots Purge", Level.DEBUG),
126 new LogMessageWithLevel("String Dedup Fixup", Level.DEBUG),
127 new LogMessageWithLevel("Expand Heap After Collection", Level.DEBUG),
128 // Free CSet
129 new LogMessageWithLevel("Free Collection Set", Level.DEBUG),
130 new LogMessageWithLevel("Free Collection Set Serial", Level.TRACE),
131 new LogMessageWithLevel("Young Free Collection Set", Level.TRACE),
132 new LogMessageWithLevel("Non-Young Free Collection Set", Level.TRACE),
133 // Humongous Eager Reclaim
134 new LogMessageWithLevel("Humongous Reclaim", Level.DEBUG),
135 new LogMessageWithLevel("Humongous Register", Level.DEBUG),
136 // Preserve CM Referents
137 new LogMessageWithLevel("Preserve CM Refs", Level.DEBUG),
138 // Merge PSS
139 new LogMessageWithLevel("Merge Per-Thread State", Level.DEBUG),
140 // TLAB handling
141 new LogMessageWithLevel("Prepare TLABs", Level.DEBUG),
142 new LogMessageWithLevel("Resize TLABs", Level.DEBUG),
143
144 new LogMessageWithLevelC2OrJVMCIOnly("DerivedPointerTable Update", Level.DEBUG),
145 new LogMessageWithLevel("Start New Collection Set", Level.DEBUG),
146 };
147
148 void checkMessagesAtLevel(OutputAnalyzer output, LogMessageWithLevel messages[], Level level) throws Exception {
149 for (LogMessageWithLevel l : messages) {
150 if (level.lessThan(l.level) || !l.isAvailable()) {
151 output.shouldNotContain(l.message);
152 } else {
153 output.shouldMatch("\\[" + l.level + ".*" + l.message);
154 }
155 }
156 }
157
158 public static void main(String[] args) throws Exception {
159 new TestGCLogMessages().testNormalLogs();
160 new TestGCLogMessages().testWithToSpaceExhaustionLogs();
161 new TestGCLogMessages().testWithInitialMark();
162 new TestGCLogMessages().testExpandHeap();
163 }
164
165 private void testNormalLogs() throws Exception {
166
167 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
168 "-Xmx10M",
169 GCTest.class.getName());
170
171 OutputAnalyzer output = new OutputAnalyzer(pb.start());
172 checkMessagesAtLevel(output, allLogMessages, Level.OFF);
173 output.shouldHaveExitValue(0);
174
175 pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
176 "-XX:+UseStringDeduplication",
177 "-Xmx10M",
178 "-Xlog:gc+phases=debug",
179 GCTest.class.getName());
180
181 output = new OutputAnalyzer(pb.start());
182 checkMessagesAtLevel(output, allLogMessages, Level.DEBUG);
183
184 pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
185 "-XX:+UseStringDeduplication",
186 "-Xmx10M",
187 "-Xlog:gc+phases=trace",
188 GCTest.class.getName());
189
190 output = new OutputAnalyzer(pb.start());
191 checkMessagesAtLevel(output, allLogMessages, Level.TRACE);
192 output.shouldHaveExitValue(0);
193 }
194
195 LogMessageWithLevel exhFailureMessages[] = new LogMessageWithLevel[] {
196 new LogMessageWithLevel("Evacuation Failure", Level.DEBUG),
197 new LogMessageWithLevel("Recalculate Used", Level.TRACE),
198 new LogMessageWithLevel("Remove Self Forwards", Level.TRACE),
199 new LogMessageWithLevel("Restore RemSet", Level.TRACE),
200 };
201
202 private void testWithToSpaceExhaustionLogs() throws Exception {
203 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
204 "-Xmx32M",
205 "-Xmn16M",
206 "-Xlog:gc+phases=debug",
207 GCTestWithToSpaceExhaustion.class.getName());
208
209 OutputAnalyzer output = new OutputAnalyzer(pb.start());
210 checkMessagesAtLevel(output, exhFailureMessages, Level.DEBUG);
211 output.shouldHaveExitValue(0);
212
213 pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
214 "-Xmx32M",
215 "-Xmn16M",
216 "-Xlog:gc+phases=trace",
217 GCTestWithToSpaceExhaustion.class.getName());
218
219 output = new OutputAnalyzer(pb.start());
220 checkMessagesAtLevel(output, exhFailureMessages, Level.TRACE);
221 output.shouldHaveExitValue(0);
222 }
223
224 private void testWithInitialMark() throws Exception {
225 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
226 "-Xmx10M",
227 "-Xbootclasspath/a:.",
228 "-Xlog:gc*=debug",
229 "-XX:+UnlockDiagnosticVMOptions",
230 "-XX:+WhiteBoxAPI",
231 GCTestWithInitialMark.class.getName());
232
233 OutputAnalyzer output = new OutputAnalyzer(pb.start());
234 output.shouldContain("Clear Claimed Marks");
235 output.shouldHaveExitValue(0);
236 }
237
238 private void testExpandHeap() throws Exception {
239 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
240 "-Xmx10M",
241 "-Xbootclasspath/a:.",
242 "-Xlog:gc+ergo+heap=debug",
243 "-XX:+UnlockDiagnosticVMOptions",
244 "-XX:+WhiteBoxAPI",
245 GCTest.class.getName());
246
247 OutputAnalyzer output = new OutputAnalyzer(pb.start());
248 output.shouldContain("Expand the heap. requested expansion amount: ");
249 output.shouldContain("B expansion amount: ");
250 output.shouldHaveExitValue(0);
251 }
252
253
254 static class GCTest {
255 private static byte[] garbage;
256 public static void main(String [] args) {
257 System.out.println("Creating garbage");
258 // create 128MB of garbage. This should result in at least one GC
259 for (int i = 0; i < 1024; i++) {
260 garbage = new byte[128 * 1024];
261 }
262 System.out.println("Done");
263 }
264 }
265
266 static class GCTestWithToSpaceExhaustion {
267 private static byte[] garbage;
268 private static byte[] largeObject;
269 public static void main(String [] args) {
270 largeObject = new byte[16*1024*1024];
271 System.out.println("Creating garbage");
272 // create 128MB of garbage. This should result in at least one GC,
273 // some of them with to-space exhaustion.
274 for (int i = 0; i < 1024; i++) {
275 garbage = new byte[128 * 1024];
276 }
277 System.out.println("Done");
278 }
279 }
280
281 static class GCTestWithInitialMark {
282 public static void main(String [] args) {
283 sun.hotspot.WhiteBox WB = sun.hotspot.WhiteBox.getWhiteBox();
284 WB.g1StartConcMarkCycle();
285 }
286 }
287
288 }
289