1/*
2 * Copyright (c) 2014, 2016, 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
26 * @bug 8031320
27 * @summary Verify that on high abort ratio method will be recompiled
28 *          without rtm locking.
29 * @library /test/lib /
30 * @modules java.base/jdk.internal.misc
31 *          java.management
32 * @requires vm.flavor == "server" & !vm.emulatedClient & vm.rtm.cpu & vm.rtm.os
33 * @build sun.hotspot.WhiteBox
34 * @run driver ClassFileInstaller sun.hotspot.WhiteBox
35 *                                sun.hotspot.WhiteBox$WhiteBoxPermission
36 * @run main/othervm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions
37 *                   -XX:+WhiteBoxAPI
38 *                   compiler.rtm.locking.TestRTMDeoptOnHighAbortRatio
39 */
40
41package compiler.rtm.locking;
42
43import compiler.testlibrary.rtm.AbortProvoker;
44import compiler.testlibrary.rtm.AbortType;
45import compiler.testlibrary.rtm.RTMLockingStatistics;
46import compiler.testlibrary.rtm.RTMTestBase;
47import jdk.test.lib.Asserts;
48import jdk.test.lib.process.OutputAnalyzer;
49import jdk.test.lib.cli.CommandLineOptionTest;
50
51import java.util.List;
52
53/**
54 * Test verifies that on high abort ratio method wil be deoptimized with
55 * <i>rtm_state_change</i> reason and after that RTM-based lock elision will not
56 * be used for that method.
57 * This test make asserts on total locks count done by compiled method,
58 * so in order to avoid issue with retriable locks -XX:RTMRetryCount=0 is used.
59 * For more details on that issue see {@link TestUseRTMAfterLockInflation}.
60 */
61public class TestRTMDeoptOnHighAbortRatio {
62    private static final long ABORT_THRESHOLD
63            = AbortProvoker.DEFAULT_ITERATIONS / 2L;
64
65    protected void runTestCases() throws Throwable {
66        verifyDeopt(false);
67        verifyDeopt(true);
68    }
69
70    private void verifyDeopt(boolean useStackLock) throws Throwable {
71        AbortProvoker provoker = AbortType.XABORT.provoker();
72        String logFileName = String.format("rtm_deopt_%s_stack_lock.xml",
73                (useStackLock ? "use" : "no"));
74
75        OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
76                logFileName,
77                provoker,
78                "-XX:+UseRTMDeopt",
79                CommandLineOptionTest.prepareBooleanFlag("UseRTMForStackLocks",
80                        useStackLock),
81                "-XX:RTMRetryCount=0",
82                CommandLineOptionTest.prepareNumericFlag("RTMAbortThreshold",
83                        TestRTMDeoptOnHighAbortRatio.ABORT_THRESHOLD),
84                "-XX:RTMAbortRatio=100",
85                "-XX:CompileThreshold=1",
86                "-XX:RTMTotalCountIncrRate=1",
87                "-XX:+PrintPreciseRTMLockingStatistics",
88                AbortProvoker.class.getName(),
89                AbortType.XABORT.toString(),
90                Boolean.toString(!useStackLock)
91        );
92
93        outputAnalyzer.shouldHaveExitValue(0);
94
95        int firedTraps = RTMTestBase.firedRTMStateChangeTraps(logFileName);
96
97        Asserts.assertEQ(firedTraps, 1, "Expected to get only one "
98                + "deoptimization due to rtm state change");
99
100        List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
101                provoker.getMethodWithLockName(), outputAnalyzer.getOutput());
102
103        Asserts.assertEQ(statistics.size(), 1, "VM output should contain "
104                + "exactly one RTM locking statistics entry for method "
105                + provoker.getMethodWithLockName());
106
107        Asserts.assertEQ(statistics.get(0).getTotalLocks(),
108                TestRTMDeoptOnHighAbortRatio.ABORT_THRESHOLD,
109                "After AbortThreshold was reached, method should be"
110                + " recompiled without rtm lock eliding.");
111    }
112
113    public static void main(String args[]) throws Throwable {
114        new TestRTMDeoptOnHighAbortRatio().runTestCases();
115    }
116}
117
118