jdk-24/test/hotspot/jtreg/compiler/c2/irTests/gc/ReferenceClearTests.java
Aleksey Shipilev 7625b29920 8329597: C2: Intrinsify Reference.clear
Reviewed-by: rcastanedalo, eosterlund, kvn
2024-10-16 14:08:10 +00:00

139 lines
5.1 KiB
Java

/*
* Copyright Amazon.com Inc. 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 compiler.c2.irTests.gc;
import jdk.test.lib.Asserts;
import compiler.lib.ir_framework.*;
import jdk.test.whitebox.gc.GC;
import java.lang.ref.*;
import java.util.*;
/*
* @test
* @bug 8329597
* @summary Test that Reference.clear intrinsics are properly handled
* @library /test/lib /
* @build jdk.test.whitebox.WhiteBox
* @requires vm.compiler2.enabled
* @run driver jdk.test.lib.helpers.ClassFileInstaller jdk.test.whitebox.WhiteBox
* @run main/othervm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions -XX:+WhiteBoxAPI compiler.c2.irTests.gc.ReferenceClearTests
*/
public class ReferenceClearTests {
private static String[] args(String... add) {
List<String> args = new ArrayList<>();
// Use PerMethodTrapLimit=0 to compile all branches in the intrinsics.
args.add("-XX:PerMethodTrapLimit=0");
// Forcefully inline all methods to reach the intrinsic code.
args.add("-XX:CompileCommand=inline,compiler.c2.irTests.gc.ReferenceClearTests::*");
args.add("-XX:CompileCommand=inline,java.lang.ref.Reference::*");
args.add("-XX:CompileCommand=inline,java.lang.ref.PhantomReference::*");
// Mix in test config code.
args.addAll(Arrays.asList(add));
return args.toArray(new String[0]);
}
public static void main(String[] args) {
TestFramework framework = new TestFramework();
int idx = 0;
if (GC.isSelectedErgonomically() && GC.Serial.isSupported()) {
// Serial does not have SATB/keep-alive barriers at all.
// There are inter-generational barriers on stores, but they are
// folded away for null stores like clear().
framework.addScenarios(new Scenario(idx++, args(
"-XX:+UseSerialGC"
)));
}
if (GC.isSelectedErgonomically() && GC.Parallel.isSupported()) {
// Parallel does not have SATB/keep-alive barriers at all.
// There are inter-generational barriers on stores, but they
// should be folded away for null stores like clear().
framework.addScenarios(new Scenario(idx++, args(
"-XX:+UseParallelGC"
)));
}
if (GC.isSelectedErgonomically() && GC.G1.isSupported()) {
// G1 does not have barriers in C2 IR.
framework.addScenarios(new Scenario(idx++, args(
"-XX:+UseG1GC"
)));
}
if (GC.isSelectedErgonomically() && GC.Shenandoah.isSupported()) {
// Shenandoah has SATB/keep-alive barriers, but they should not be
// present clear()-s. There are load-reference barriers, which would
// confuse the tests, so we enable only SATB barriers.
framework.addScenarios(new Scenario(idx++, args(
"-XX:+UnlockDiagnosticVMOptions",
"-XX:ShenandoahGCMode=passive",
"-XX:+ShenandoahSATBBarrier",
"-XX:+UseShenandoahGC"
)));
}
if (GC.isSelectedErgonomically() && GC.Z.isSupported()) {
// Z does not have barriers in C2 IR.
framework.addScenarios(new Scenario(idx++, args(
"-XX:+UseZGC"
)));
}
framework.start();
}
static final Object REF = new Object();
static final SoftReference<Object> SR = new SoftReference<>(REF);
static final WeakReference<Object> WR = new WeakReference<>(REF);
static final PhantomReference<Object> PR = new PhantomReference<>(REF, null);
// We assert there is only a single load and a single store of Reference.referent.
// This serves as signal that no GC barriers are emitted in IR.
@Test
@IR(counts = { IRNode.STORE, "1",
IRNode.LOAD, "1" })
public void soft() {
SR.clear();
}
@Test
@IR(counts = { IRNode.STORE, "1",
IRNode.LOAD, "1" })
public void weak() {
WR.clear();
}
@Test
@IR(counts = { IRNode.STORE, "1",
IRNode.LOAD, "1" })
public void phantom() {
PR.clear();
}
}