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