1 /*
   2  * Copyright (c) 2014, 2015 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 8027962
  27  * @summary Ensure that the PrintGCDetails output for a minor GC with G1
  28  * includes the expected necessary messages.
  29  * @key gc
  30  * @library /testlibrary
  31  */
  32 
  33 import com.oracle.java.testlibrary.ProcessTools;
  34 import com.oracle.java.testlibrary.OutputAnalyzer;
  35 
  36 public class TestGCLogMessages {
  37 
  38     private enum Level {
  39         OFF, FINER, FINEST;
  40         public boolean lessOrEqualTo(Level other) {
  41             return this.compareTo(other) < 0;
  42         }
  43     }
  44 
  45     private class LogMessageWithLevel {
  46         String message;
  47         Level level;
  48 
  49         public LogMessageWithLevel(String message, Level level) {
  50             this.message = message;
  51             this.level = level;
  52         }
  53     };
  54 
  55     private LogMessageWithLevel allLogMessages[] = new LogMessageWithLevel[] {
  56         // Ext Root Scan
  57         new LogMessageWithLevel("Thread Roots (ms)", Level.FINEST),
  58         new LogMessageWithLevel("StringTable Roots (ms)", Level.FINEST),
  59         new LogMessageWithLevel("Universe Roots (ms)", Level.FINEST),
  60         new LogMessageWithLevel("JNI Handles Roots (ms)", Level.FINEST),
  61         new LogMessageWithLevel("ObjectSynchronizer Roots (ms)", Level.FINEST),
  62         new LogMessageWithLevel("FlatProfiler Roots", Level.FINEST),
  63         new LogMessageWithLevel("Management Roots", Level.FINEST),
  64         new LogMessageWithLevel("SystemDictionary Roots", Level.FINEST),
  65         new LogMessageWithLevel("CLDG Roots", Level.FINEST),
  66         new LogMessageWithLevel("JVMTI Roots", Level.FINEST),
  67         new LogMessageWithLevel("CodeCache Roots", Level.FINEST),
  68         new LogMessageWithLevel("SATB Filtering", Level.FINEST),
  69         new LogMessageWithLevel("CM RefProcessor Roots", Level.FINEST),
  70         new LogMessageWithLevel("Wait For Strong CLD", Level.FINEST),
  71         new LogMessageWithLevel("Weak CLD Roots", Level.FINEST),
  72         // Redirty Cards
  73         new LogMessageWithLevel("Redirty Cards", Level.FINER),
  74         new LogMessageWithLevel("Parallel Redirty", Level.FINEST),
  75         new LogMessageWithLevel("Redirtied Cards", Level.FINEST),
  76         // Misc Top-level
  77         new LogMessageWithLevel("Code Root Purge", Level.FINER),
  78         new LogMessageWithLevel("String Dedup Fixup", Level.FINER),
  79         // Free CSet
  80         new LogMessageWithLevel("Young Free CSet", Level.FINEST),
  81         new LogMessageWithLevel("Non-Young Free CSet", Level.FINEST),
  82         // Humongous Eager Reclaim
  83         new LogMessageWithLevel("Humongous Reclaim", Level.FINER),
  84     };
  85 
  86     void checkMessagesAtLevel(OutputAnalyzer output, LogMessageWithLevel messages[], Level level) throws Exception {
  87         for (LogMessageWithLevel l : messages) {
  88             if (level.lessOrEqualTo(l.level)) {
  89                 output.shouldNotContain(l.message);
  90             } else {
  91                 output.shouldContain(l.message);
  92             }
  93         }
  94     }
  95 
  96     public static void main(String[] args) throws Exception {
  97         new TestGCLogMessages().testNormalLogs();
  98         new TestGCLogMessages().testWithToSpaceExhaustionLogs();
  99     }
 100 
 101     private void testNormalLogs() throws Exception {
 102 
 103         ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
 104                                                                   "-Xmx10M",
 105                                                                   GCTest.class.getName());
 106 
 107         OutputAnalyzer output = new OutputAnalyzer(pb.start());
 108         checkMessagesAtLevel(output, allLogMessages, Level.OFF);
 109         output.shouldHaveExitValue(0);
 110 
 111         pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
 112                                                    "-XX:+UseStringDeduplication",
 113                                                    "-Xmx10M",
 114                                                    "-XX:+PrintGCDetails",
 115                                                    GCTest.class.getName());
 116 
 117         output = new OutputAnalyzer(pb.start());
 118         checkMessagesAtLevel(output, allLogMessages, Level.FINER);
 119 
 120         pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
 121                                                    "-XX:+UseStringDeduplication",
 122                                                    "-Xmx10M",
 123                                                    "-XX:+PrintGCDetails",
 124                                                    "-XX:+UnlockExperimentalVMOptions",
 125                                                    "-XX:G1LogLevel=finest",
 126                                                    GCTest.class.getName());
 127 
 128         output = new OutputAnalyzer(pb.start());
 129         checkMessagesAtLevel(output, allLogMessages, Level.FINEST);
 130         output.shouldHaveExitValue(0);
 131     }
 132 
 133     LogMessageWithLevel exhFailureMessages[] = new LogMessageWithLevel[] {
 134         new LogMessageWithLevel("Evacuation Failure", Level.FINER),
 135         new LogMessageWithLevel("Recalculate Used", Level.FINEST),
 136         new LogMessageWithLevel("Remove Self Forwards", Level.FINEST),
 137         new LogMessageWithLevel("Restore RemSet", Level.FINEST),
 138     };
 139 
 140     private void testWithToSpaceExhaustionLogs() throws Exception {
 141         ProcessBuilder pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
 142                                                                   "-Xmx32M",
 143                                                                   "-Xmn16M",
 144                                                                   "-XX:+PrintGCDetails",
 145                                                                   GCTestWithToSpaceExhaustion.class.getName());
 146 
 147         OutputAnalyzer output = new OutputAnalyzer(pb.start());
 148         checkMessagesAtLevel(output, exhFailureMessages, Level.FINER);
 149         output.shouldHaveExitValue(0);
 150 
 151         pb = ProcessTools.createJavaProcessBuilder("-XX:+UseG1GC",
 152                                                    "-Xmx32M",
 153                                                    "-Xmn16M",
 154                                                    "-XX:+PrintGCDetails",
 155                                                    "-XX:+UnlockExperimentalVMOptions",
 156                                                    "-XX:G1LogLevel=finest",
 157                                                    GCTestWithToSpaceExhaustion.class.getName());
 158 
 159         output = new OutputAnalyzer(pb.start());
 160         checkMessagesAtLevel(output, exhFailureMessages, Level.FINEST);
 161         output.shouldHaveExitValue(0);
 162     }
 163 
 164     static class GCTest {
 165         private static byte[] garbage;
 166         public static void main(String [] args) {
 167             System.out.println("Creating garbage");
 168             // create 128MB of garbage. This should result in at least one GC
 169             for (int i = 0; i < 1024; i++) {
 170                 garbage = new byte[128 * 1024];
 171             }
 172             System.out.println("Done");
 173         }
 174     }
 175 
 176     static class GCTestWithToSpaceExhaustion {
 177         private static byte[] garbage;
 178         private static byte[] largeObject;
 179         public static void main(String [] args) {
 180             largeObject = new byte[16*1024*1024];
 181             System.out.println("Creating garbage");
 182             // create 128MB of garbage. This should result in at least one GC,
 183             // some of them with to-space exhaustion.
 184             for (int i = 0; i < 1024; i++) {
 185                 garbage = new byte[128 * 1024];
 186             }
 187             System.out.println("Done");
 188         }
 189     }
 190 }
 191