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 rtm locking is used for inflated locks.
28 * @library /test/lib /
29 * @modules java.base/jdk.internal.misc
30 *          java.management
31 * @build sun.hotspot.WhiteBox
32 * @run driver ClassFileInstaller sun.hotspot.WhiteBox
33 *                                sun.hotspot.WhiteBox$WhiteBoxPermission
34 * @run main/othervm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions
35 *                   -XX:+WhiteBoxAPI compiler.rtm.locking.TestUseRTMForInflatedLocks
36 */
37
38package compiler.rtm.locking;
39
40import compiler.testlibrary.rtm.AbortProvoker;
41import compiler.testlibrary.rtm.AbortType;
42import compiler.testlibrary.rtm.RTMLockingStatistics;
43import compiler.testlibrary.rtm.RTMTestBase;
44import compiler.testlibrary.rtm.predicate.SupportedCPU;
45import compiler.testlibrary.rtm.predicate.SupportedOS;
46import compiler.testlibrary.rtm.predicate.SupportedVM;
47import jdk.test.lib.Asserts;
48import jdk.test.lib.process.OutputAnalyzer;
49import jdk.test.lib.cli.CommandLineOptionTest;
50import jdk.test.lib.cli.predicate.AndPredicate;
51
52import java.util.List;
53
54/**
55 * Test verifies that RTM-based lock elision could be used for inflated locks
56 * by calling compiled method that use RTM-based lock elision and using
57 * manually inflated lock.
58 * Compiled method invoked {@code AbortProvoker.DEFAULT_ITERATIONS} times,
59 * so total locks count should be the same.
60 * This test could also be affected by retriable aborts, so -XX:RTMRetryCount=0
61 * is used. For more information abort that issue see
62 * {@link TestUseRTMAfterLockInflation}.
63 */
64public class TestUseRTMForInflatedLocks extends CommandLineOptionTest {
65    private TestUseRTMForInflatedLocks() {
66        super(new AndPredicate(new SupportedCPU(), new SupportedOS(), new SupportedVM()));
67    }
68
69    @Override
70    protected void runTestCases() throws Throwable {
71        AbortProvoker provoker = AbortType.XABORT.provoker();
72        RTMLockingStatistics lock;
73
74        OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
75                provoker,
76                "-XX:-UseRTMForStackLocks",
77                "-XX:RTMTotalCountIncrRate=1",
78                "-XX:RTMRetryCount=0",
79                "-XX:+PrintPreciseRTMLockingStatistics",
80                AbortProvoker.class.getName(),
81                AbortType.XABORT.toString());
82
83        outputAnalyzer.shouldHaveExitValue(0);
84
85        List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
86                provoker.getMethodWithLockName(), outputAnalyzer.getOutput());
87
88        Asserts.assertEQ(statistics.size(), 1,
89                "VM output should contain exactly one rtm locking statistics "
90                + "entry for method " + provoker.getMethodWithLockName());
91
92        lock = statistics.get(0);
93        Asserts.assertEQ(lock.getTotalLocks(), AbortProvoker.DEFAULT_ITERATIONS,
94                "Total lock count should be greater or equal to "
95                + AbortProvoker.DEFAULT_ITERATIONS);
96    }
97
98    public static void main(String args[]) throws Throwable {
99        new TestUseRTMForInflatedLocks().test();
100    }
101}
102