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 RTMRetryCount affects actual amount of retries.
28 * @library /test/lib /
29 * @modules java.base/jdk.internal.misc
30 *          java.management
31 * @requires vm.flavor == "server" & !vm.emulatedClient & vm.rtm.cpu & vm.rtm.os
32 * @build sun.hotspot.WhiteBox
33 * @run driver ClassFileInstaller sun.hotspot.WhiteBox
34 *                                sun.hotspot.WhiteBox$WhiteBoxPermission
35 * @run main/othervm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions
36 *                   -XX:+WhiteBoxAPI
37 *                   compiler.rtm.locking.TestRTMRetryCount
38 */
39
40package compiler.rtm.locking;
41
42import compiler.testlibrary.rtm.BusyLock;
43import compiler.testlibrary.rtm.CompilableTest;
44import compiler.testlibrary.rtm.RTMLockingStatistics;
45import compiler.testlibrary.rtm.RTMTestBase;
46import jdk.test.lib.Asserts;
47import jdk.test.lib.process.OutputAnalyzer;
48import jdk.test.lib.cli.CommandLineOptionTest;
49
50import java.util.List;
51
52/**
53 * Test verifies that RTMRetryCount option actually affects amount of
54 * retries on lock busy.
55 */
56public class TestRTMRetryCount {
57    /**
58     * Time in ms, during which busy lock will be locked.
59     */
60    private static final int LOCKING_TIME = 5000;
61    private static final boolean INFLATE_MONITOR = true;
62
63    protected void runTestCases() throws Throwable {
64        verifyRTMRetryCount(0);
65        verifyRTMRetryCount(1);
66        verifyRTMRetryCount(5);
67        verifyRTMRetryCount(10);
68    }
69
70    private void verifyRTMRetryCount(int retryCount) throws Throwable {
71        CompilableTest busyLock = new BusyLock();
72        long expectedAborts = retryCount + 1L;
73
74        OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
75                busyLock,
76                "-XX:-UseRTMXendForLockBusy",
77                "-XX:RTMTotalCountIncrRate=1",
78                CommandLineOptionTest.prepareNumericFlag("RTMRetryCount",
79                        retryCount),
80                "-XX:RTMTotalCountIncrRate=1",
81                "-XX:+PrintPreciseRTMLockingStatistics",
82                BusyLock.class.getName(),
83                Boolean.toString(TestRTMRetryCount.INFLATE_MONITOR),
84                Integer.toString(TestRTMRetryCount.LOCKING_TIME)
85        );
86
87        outputAnalyzer.shouldHaveExitValue(0);
88
89        List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
90                busyLock.getMethodWithLockName(), outputAnalyzer.getStdout());
91
92        Asserts.assertEQ(statistics.size(), 1, "VM output should contain "
93                + "exactly one rtm locking statistics entry for method "
94                + busyLock.getMethodWithLockName());
95
96        Asserts.assertEQ(statistics.get(0).getTotalAborts(), expectedAborts,
97                String.format("It is expected to get %d aborts",
98                        expectedAborts));
99    }
100
101    public static void main(String args[]) throws Throwable {
102        new TestRTMRetryCount().runTestCases();
103    }
104}
105