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 /**
  26  * @test
  27  * @bug 8031320
  28  * @summary Verify that rtm locking is used for stack locks before
  29  *          inflation and after it used for inflated locks.
  30  * @library /test/lib /
  31  * @modules java.base/jdk.internal.misc
  32  *          java.management
  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.TestUseRTMAfterLockInflation
  39  */
  40 
  41 package compiler.rtm.locking;
  42 
  43 import compiler.testlibrary.rtm.AbortProvoker;
  44 import compiler.testlibrary.rtm.AbortType;
  45 import compiler.testlibrary.rtm.RTMLockingStatistics;
  46 import compiler.testlibrary.rtm.RTMTestBase;
  47 import compiler.testlibrary.rtm.predicate.SupportedCPU;
  48 import compiler.testlibrary.rtm.predicate.SupportedOS;
  49 import compiler.testlibrary.rtm.predicate.SupportedVM;
  50 import jdk.test.lib.Asserts;
  51 import jdk.test.lib.process.OutputAnalyzer;
  52 import jdk.test.lib.cli.CommandLineOptionTest;
  53 import jdk.test.lib.cli.predicate.AndPredicate;
  54 
  55 import java.util.List;
  56 
  57 /**
  58  * Test verifies that RTM is used after lock inflation by executing compiled
  59  * method with RTM-based lock elision using stack lock first, then that lock
  60  * is inflated and the same compiled method invoked again.
  61  *
  62  * Compiled method invoked {@code AbortProvoker.DEFAULT_ITERATIONS} times before
  63  * lock inflation and the same amount of times after inflation.
  64  * As a result total locks count should be equal to
  65  * {@code 2 * AbortProvoker.DEFAULT_ITERATIONS}.
  66  * It is a pretty strict assertion which could fail if some retriable abort
  67  * happened: it could be {@code AbortType.RETRIABLE} or
  68  * {@code AbortType.MEM_CONFLICT}, but unfortunately abort can has both these
  69  * reasons simultaneously. In order to avoid false negative failures related
  70  * to incorrect aborts counting, -XX:RTMRetryCount=0 is used.
  71  */
  72 public class TestUseRTMAfterLockInflation extends CommandLineOptionTest {
  73     private static final long EXPECTED_LOCKS
  74             = 2L * AbortProvoker.DEFAULT_ITERATIONS;
  75 
  76     private TestUseRTMAfterLockInflation() {
  77         super(new AndPredicate(new SupportedCPU(), new SupportedOS(), new SupportedVM()));
  78     }
  79 
  80     @Override
  81     protected void runTestCases() throws Throwable {
  82         AbortProvoker provoker = AbortType.XABORT.provoker();
  83         long totalLocksCount = 0;
  84 
  85         OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
  86                 provoker,
  87                 "-XX:+UseRTMForStackLocks",
  88                 "-XX:RTMTotalCountIncrRate=1",
  89                 "-XX:RTMRetryCount=0",
  90                 "-XX:+PrintPreciseRTMLockingStatistics",
  91                 Test.class.getName(),
  92                 AbortType.XABORT.toString());
  93 
  94         outputAnalyzer.shouldHaveExitValue(0);
  95 
  96         List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
  97                 provoker.getMethodWithLockName(), outputAnalyzer.getOutput());
  98 
  99         Asserts.assertEQ(statistics.size(), 2,
 100                 "VM output should contain two rtm locking statistics entries "
 101                 + "for method " + provoker.getMethodWithLockName());
 102 
 103         for (RTMLockingStatistics s : statistics) {
 104             totalLocksCount += s.getTotalLocks();
 105         }
 106 
 107         Asserts.assertEQ(totalLocksCount,
 108                 TestUseRTMAfterLockInflation.EXPECTED_LOCKS,
 109                 "Total lock count should be greater or equal to "
 110                 + TestUseRTMAfterLockInflation.EXPECTED_LOCKS);
 111     }
 112 
 113     public static class Test {
 114         /**
 115          * Usage:
 116          * Test &lt;provoker type&gt;
 117          */
 118         public static void main(String args[]) throws Throwable {
 119             Asserts.assertGT(args.length, 0,
 120                     "AbortType name is expected as first argument.");
 121 
 122             AbortProvoker provoker
 123                     = AbortType.lookup(Integer.valueOf(args[0])).provoker();
 124             for (int i = 0; i < AbortProvoker.DEFAULT_ITERATIONS; i++) {
 125                 AbortProvoker.verifyMonitorState(provoker, false /*deflated*/);
 126                 provoker.forceAbort();
 127             }
 128             provoker.inflateMonitor();
 129             for (int i = 0; i < AbortProvoker.DEFAULT_ITERATIONS; i++) {
 130                 AbortProvoker.verifyMonitorState(provoker, true /*inflated*/);
 131                 provoker.forceAbort();
 132             }
 133         }
 134     }
 135 
 136     public static void main(String args[]) throws Throwable {
 137         new TestUseRTMAfterLockInflation().test();
 138     }
 139 }