/*
* Copyright (c) 2020, 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package gc.z;
/**
* @test TestGarbageCollectorMXBean
* @requires vm.gc.ZGenerational
* @summary Test ZGC garbage collector MXBean
* @modules java.management
* @requires vm.compMode != "Xcomp"
* @run main/othervm -XX:+UseZGC -XX:+ZGenerational -Xms256M -Xmx512M -Xlog:gc gc.z.TestGarbageCollectorMXBean 256 512
* @run main/othervm -XX:+UseZGC -XX:+ZGenerational -Xms512M -Xmx512M -Xlog:gc gc.z.TestGarbageCollectorMXBean 512 512
*/
import java.lang.management.ManagementFactory;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLong;
import javax.management.Notification;
import javax.management.NotificationEmitter;
import javax.management.NotificationListener;
import javax.management.openmbean.CompositeData;
import com.sun.management.GarbageCollectionNotificationInfo;
public class TestGarbageCollectorMXBean {
private static final long startTime = System.nanoTime();
private static void log(String msg) {
final String elapsedSeconds = String.format("%.3fs", (System.nanoTime() - startTime) / 1_000_000_000.0);
System.out.println("[" + elapsedSeconds + "] (" + Thread.currentThread().getName() + ") " + msg);
}
public static void main(String[] args) throws Exception {
final long M = 1024 * 1024;
final long initialCapacity = Long.parseLong(args[0]) * M;
final long maxCapacity = Long.parseLong(args[1]) * M;
final AtomicInteger cycles = new AtomicInteger();
final AtomicInteger pauses = new AtomicInteger();
final AtomicInteger errors = new AtomicInteger();
final NotificationListener listener = (Notification notification, Object ignored) -> {
final var type = notification.getType();
if (!type.equals(GarbageCollectionNotificationInfo.GARBAGE_COLLECTION_NOTIFICATION)) {
// Ignore
return;
}
final var data = (CompositeData)notification.getUserData();
final var info = GarbageCollectionNotificationInfo.from(data);
final var name = info.getGcName();
final var id = info.getGcInfo().getId();
final var action = info.getGcAction();
final var cause = info.getGcCause();
final var startTime = info.getGcInfo().getStartTime();
final var endTime = info.getGcInfo().getEndTime();
final var duration = info.getGcInfo().getDuration();
final var youngMemoryUsageBeforeGC = info.getGcInfo().getMemoryUsageBeforeGc().get("ZGC Young Generation");
final var youngMemoryUsageAfterGC = info.getGcInfo().getMemoryUsageAfterGc().get("ZGC Young Generation");
final var oldMemoryUsageBeforeGC = info.getGcInfo().getMemoryUsageBeforeGc().get("ZGC Old Generation");
final var oldMemoryUsageAfterGC = info.getGcInfo().getMemoryUsageAfterGc().get("ZGC Old Generation");
log(name + " (" + type + ")");
log(" Id: " + id);
log(" Action: " + action);
log(" Cause: " + cause);
log(" StartTime: " + startTime);
log(" EndTime: " + endTime);
log(" Duration: " + duration);
log(" Young MemoryUsageBeforeGC: " + youngMemoryUsageBeforeGC);
log(" Young MemoryUsageAfterGC: " + youngMemoryUsageAfterGC);
log(" Old MemoryUsageBeforeGC: " + oldMemoryUsageBeforeGC);
log(" Old MemoryUsageAfterGC: " + oldMemoryUsageAfterGC);
log("");
if (name.equals("ZGC Major Cycles")) {
cycles.incrementAndGet();
if (!action.equals("end of GC cycle")) {
log("ERROR: Action");
errors.incrementAndGet();
}
if (oldMemoryUsageBeforeGC.getInit() != 0) {
log("ERROR: Old MemoryUsageBeforeGC.init");
errors.incrementAndGet();
}
if (oldMemoryUsageBeforeGC.getUsed() > initialCapacity) {
log("ERROR: Old MemoryUsageBeforeGC.used");
errors.incrementAndGet();
}
if (oldMemoryUsageBeforeGC.getCommitted() != oldMemoryUsageBeforeGC.getUsed()) {
log("ERROR: Old MemoryUsageBeforeGC.committed");
errors.incrementAndGet();
}
if (oldMemoryUsageBeforeGC.getMax() != maxCapacity) {
log("ERROR: Old MemoryUsageBeforeGC.max");
errors.incrementAndGet();
}
} else if (name.equals("ZGC Major Pauses")) {
pauses.incrementAndGet();
if (!action.equals("end of GC pause")) {
log("ERROR: Action");
errors.incrementAndGet();
}
if (oldMemoryUsageBeforeGC.getInit() != 0) {
log("ERROR: Old MemoryUsageBeforeGC.init");
errors.incrementAndGet();
}
if (oldMemoryUsageBeforeGC.getUsed() != 0) {
log("ERROR: Old MemoryUsageBeforeGC.used");
errors.incrementAndGet();
}
if (oldMemoryUsageBeforeGC.getCommitted() != 0) {
log("ERROR: Old MemoryUsageBeforeGC.committed");
errors.incrementAndGet();
}
if (oldMemoryUsageBeforeGC.getMax() != 0) {
log("ERROR: Old MemoryUsageBeforeGC.max");
errors.incrementAndGet();
}
} else if (name.equals("ZGC Minor Cycles")) {
cycles.incrementAndGet();
if (!action.equals("end of GC cycle")) {
log("ERROR: Action");
errors.incrementAndGet();
}
if (youngMemoryUsageBeforeGC.getInit() != initialCapacity) {
log("ERROR: Young MemoryUsageBeforeGC.init");
errors.incrementAndGet();
}
if (youngMemoryUsageBeforeGC.getUsed() > youngMemoryUsageBeforeGC.getCommitted()) {
log("ERROR: Young MemoryUsageBeforeGC.used");
errors.incrementAndGet();
}
if (youngMemoryUsageBeforeGC.getCommitted() > initialCapacity) {
log("ERROR: Young MemoryUsageBeforeGC.committed");
errors.incrementAndGet();
}
if (youngMemoryUsageBeforeGC.getMax() != maxCapacity) {
log("ERROR: Young MemoryUsageBeforeGC.max");
errors.incrementAndGet();
}
} else if (name.equals("ZGC Minor Pauses")) {
pauses.incrementAndGet();
if (!action.equals("end of GC pause")) {
log("ERROR: Action");
errors.incrementAndGet();
}
if (youngMemoryUsageBeforeGC.getInit() != 0) {
log("ERROR: Young MemoryUsageBeforeGC.init");
errors.incrementAndGet();
}
if (youngMemoryUsageBeforeGC.getUsed() != 0) {
log("ERROR: Young MemoryUsageBeforeGC.used");
errors.incrementAndGet();
}
if (youngMemoryUsageBeforeGC.getCommitted() != 0) {
log("ERROR: Young MemoryUsageBeforeGC.committed");
errors.incrementAndGet();
}
if (youngMemoryUsageBeforeGC.getMax() != 0) {
log("ERROR: Young MemoryUsageBeforeGC.max");
errors.incrementAndGet();
}
} else {
log("ERROR: Name");
errors.incrementAndGet();
}
//if (!cause.equals("System.gc()")) {
// log("ERROR: Cause");
// errors.incrementAndGet();
//}
if (startTime > endTime) {
log("ERROR: StartTime");
errors.incrementAndGet();
}
if (endTime - startTime != duration) {
log("ERROR: Duration");
errors.incrementAndGet();
}
};
// Collect garbage created at startup
System.gc();
// Register GC event listener
for (final var collector : ManagementFactory.getGarbageCollectorMXBeans()) {
final NotificationEmitter emitter = (NotificationEmitter)collector;
emitter.addNotificationListener(listener, null, null);
}
final int minCycles = 5;
final int minPauses = minCycles * 3;
// Run GCs
for (int i = 0; i < minCycles; i++) {
log("Starting GC " + i);
System.gc();
}
// Wait at most 90 seconds
for (int i = 0; i < 90; i++) {
log("Waiting...");
Thread.sleep(1000);
if (cycles.get() >= minCycles) {
log("All events received!");
break;
}
}
final int actualCycles = cycles.get();
final int actualPauses = pauses.get();
final int actualErrors = errors.get();
log(" minCycles: " + minCycles);
log(" minPauses: " + minPauses);
log("actualCycles: " + actualCycles);
log("actualPauses: " + actualPauses);
log("actualErrors: " + actualErrors);
// Verify number of cycle events
if (actualCycles < minCycles) {
throw new Exception("Unexpected cycles");
}
// Verify number of pause events
if (actualPauses < minPauses) {
throw new Exception("Unexpected pauses");
}
// Verify number of errors
if (actualErrors != 0) {
throw new Exception("Unexpected errors");
}
}
}