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