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 // Reference Processing
144 new LogMessageWithLevel("Reference Processing", Level.DEBUG),
145 new LogMessageWithLevel("Reference Enqueuing", Level.DEBUG),
146
147 new LogMessageWithLevelC2OrJVMCIOnly("DerivedPointerTable Update", Level.DEBUG),
148 new LogMessageWithLevel("Start New Collection Set", Level.DEBUG),
149 };
150
151 void checkMessagesAtLevel(OutputAnalyzer output, LogMessageWithLevel messages[], Level level) throws Exception {
152 for (LogMessageWithLevel l : messages) {
153 if (level.lessThan(l.level) || !l.isAvailable()) {
154 output.shouldNotContain(l.message);
155 } else {
156 output.shouldMatch("\\[" + l.level + ".*" + l.message);
157 }
158 }
159 }
160
161 public static void main(String[] args) throws Exception {
162 new TestGCLogMessages().testNormalLogs();
163 new TestGCLogMessages().testWithToSpaceExhaustionLogs();
164 new TestGCLogMessages().testWithInitialMark();
165 new TestGCLogMessages().testExpandHeap();
166 }
167
168 private void testNormalLogs() throws Exception {
169
170 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
171 "-Xmx10M",
172 GCTest.class.getName());
173
174 OutputAnalyzer output = new OutputAnalyzer(pb.start());
175 checkMessagesAtLevel(output, allLogMessages, Level.OFF);
176 output.shouldHaveExitValue(0);
177
178 pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
179 "-XX:+UseStringDeduplication",
180 "-Xmx10M",
181 "-Xlog:gc+phases=debug",
182 GCTest.class.getName());
183
184 output = new OutputAnalyzer(pb.start());
185 checkMessagesAtLevel(output, allLogMessages, Level.DEBUG);
186
187 pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
188 "-XX:+UseStringDeduplication",
189 "-Xmx10M",
190 "-Xlog:gc+phases=trace",
191 GCTest.class.getName());
192
193 output = new OutputAnalyzer(pb.start());
194 checkMessagesAtLevel(output, allLogMessages, Level.TRACE);
195 output.shouldHaveExitValue(0);
196 }
197
198 LogMessageWithLevel exhFailureMessages[] = new LogMessageWithLevel[] {
199 new LogMessageWithLevel("Evacuation Failure", Level.DEBUG),
200 new LogMessageWithLevel("Recalculate Used", Level.TRACE),
201 new LogMessageWithLevel("Remove Self Forwards", Level.TRACE),
202 };
203
204 private void testWithToSpaceExhaustionLogs() throws Exception {
205 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
206 "-Xmx32M",
207 "-Xmn16M",
208 "-Xlog:gc+phases=debug",
209 GCTestWithToSpaceExhaustion.class.getName());
210
211 OutputAnalyzer output = new OutputAnalyzer(pb.start());
212 checkMessagesAtLevel(output, exhFailureMessages, Level.DEBUG);
213 output.shouldHaveExitValue(0);
214
215 pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
216 "-Xmx32M",
217 "-Xmn16M",
218 "-Xlog:gc+phases=trace",
219 GCTestWithToSpaceExhaustion.class.getName());
220
221 output = new OutputAnalyzer(pb.start());
222 checkMessagesAtLevel(output, exhFailureMessages, Level.TRACE);
223 output.shouldHaveExitValue(0);
224 }
225
226 private void testWithInitialMark() throws Exception {
227 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
228 "-Xmx10M",
229 "-Xbootclasspath/a:.",
230 "-Xlog:gc*=debug",
231 "-XX:+UnlockDiagnosticVMOptions",
232 "-XX:+WhiteBoxAPI",
233 GCTestWithInitialMark.class.getName());
234
235 OutputAnalyzer output = new OutputAnalyzer(pb.start());
236 output.shouldContain("Clear Claimed Marks");
237 output.shouldHaveExitValue(0);
238 }
239
240 private void testExpandHeap() throws Exception {
241 ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
242 "-Xmx10M",
243 "-Xbootclasspath/a:.",
244 "-Xlog:gc+ergo+heap=debug",
245 "-XX:+UnlockDiagnosticVMOptions",
246 "-XX:+WhiteBoxAPI",
247 GCTest.class.getName());
248
249 OutputAnalyzer output = new OutputAnalyzer(pb.start());
250 output.shouldContain("Expand the heap. requested expansion amount: ");
251 output.shouldContain("B expansion amount: ");
252 output.shouldHaveExitValue(0);
253 }
254
255
256 static class GCTest {
257 private static byte[] garbage;
258 public static void main(String [] args) {
259 System.out.println("Creating garbage");
260 // create 128MB of garbage. This should result in at least one GC
261 for (int i = 0; i < 1024; i++) {
262 garbage = new byte[128 * 1024];
263 }
264 System.out.println("Done");
265 }
266 }
267
268 static class GCTestWithToSpaceExhaustion {
269 private static byte[] garbage;
270 private static byte[] largeObject;
271 public static void main(String [] args) {
272 largeObject = new byte[16*1024*1024];
273 System.out.println("Creating garbage");
274 // create 128MB of garbage. This should result in at least one GC,
275 // some of them with to-space exhaustion.
276 for (int i = 0; i < 1024; i++) {
277 garbage = new byte[128 * 1024];
278 }
279 System.out.println("Done");
280 }
281 }
282
283 static class GCTestWithInitialMark {
284 public static void main(String [] args) {
285 sun.hotspot.WhiteBox WB = sun.hotspot.WhiteBox.getWhiteBox();
286 WB.g1StartConcMarkCycle();
287 }
288 }
289
290 }
291