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 UseRTMXendForLockBusy option affects
28 *          method behaviour if lock is busy.
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.TestUseRTMXendForLockBusy
39 */
40
41package compiler.rtm.locking;
42
43import compiler.testlibrary.rtm.AbortType;
44import compiler.testlibrary.rtm.BusyLock;
45import compiler.testlibrary.rtm.CompilableTest;
46import compiler.testlibrary.rtm.RTMLockingStatistics;
47import compiler.testlibrary.rtm.RTMTestBase;
48import jdk.test.lib.Asserts;
49import jdk.test.lib.process.OutputAnalyzer;
50import jdk.test.lib.cli.CommandLineOptionTest;
51
52import java.util.List;
53
54/**
55 * Test verifies that with +UseRTMXendForLockBusy there will be no aborts
56 * forced by the test.
57 */
58public class TestUseRTMXendForLockBusy {
59    private final static int LOCKING_TIME = 5000;
60
61    protected void runTestCases() throws Throwable {
62        // inflated lock, xabort on lock busy
63        verifyXendForLockBusy(true, false);
64        // inflated lock, xend on lock busy
65        verifyXendForLockBusy(true, true);
66        // stack lock, xabort on lock busy
67        verifyXendForLockBusy(false, false);
68        // stack lock, xend on lock busy
69        verifyXendForLockBusy(false, true);
70    }
71
72    private void verifyXendForLockBusy(boolean inflateMonitor,
73            boolean useXend) throws Throwable {
74        CompilableTest test = new BusyLock();
75
76        OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
77                test,
78                CommandLineOptionTest.prepareBooleanFlag("UseRTMForStackLocks",
79                        inflateMonitor),
80                CommandLineOptionTest.prepareBooleanFlag(
81                        "UseRTMXendForLockBusy",
82                        useXend),
83                "-XX:RTMRetryCount=0",
84                "-XX:RTMTotalCountIncrRate=1",
85                "-XX:+PrintPreciseRTMLockingStatistics",
86                BusyLock.class.getName(),
87                Boolean.toString(inflateMonitor),
88                Integer.toString(TestUseRTMXendForLockBusy.LOCKING_TIME)
89        );
90
91        outputAnalyzer.shouldHaveExitValue(0);
92
93        List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
94                test.getMethodWithLockName(), outputAnalyzer.getOutput());
95
96        Asserts.assertEQ(statistics.size(), 1, "VM output should contain "
97                + "exactly one rtm locking statistics entry for method "
98                + test.getMethodWithLockName());
99
100        long aborts = statistics.get(0).getAborts(AbortType.XABORT);
101
102        if (useXend) {
103            Asserts.assertEQ(aborts, 0L,
104                    "Expected to get no aborts on busy lock");
105        } else {
106            Asserts.assertGT(aborts, 0L,
107                    "Expected to get at least one abort on busy lock");
108        }
109    }
110
111    public static void main(String args[]) throws Throwable {
112        new TestUseRTMXendForLockBusy().runTestCases();
113    }
114}
115