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