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 NoRTMLockEliding option could be applied to
  29  *          specified method and that such method will not use rtm.
  30  * @library /testlibrary /testlibrary/whitebox /compiler/testlibrary
  31  * @build TestNoRTMLockElidingOption
  32  * @run main ClassFileInstaller sun.hotspot.WhiteBox
  33  *                              sun.hotspot.WhiteBox$WhiteBoxPermission
  34  * @run main/othervm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions
  35  *                   -XX:+WhiteBoxAPI TestNoRTMLockElidingOption
  36  */
  37 
  38 import java.util.List;
  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 method tagged with option <i>NoRTMLockElidingOption</i>
  48  * will not use RTM-based lock elision.
  49  * Test invokes compiled method and checks that no deoptimization with
  50  * <i>rtm_state_change</i> reason had happened and that that VM output
  51  * does not contain RTM locking statistics for compiled method.
  52  */
  53 public class TestNoRTMLockElidingOption extends CommandLineOptionTest {
  54     private TestNoRTMLockElidingOption() {
  55         super(new AndPredicate(new SupportedCPU(), new SupportedVM()));
  56     }
  57 
  58     @Override
  59     public void runTestCases() throws Throwable {
  60         verifyOption(false);
  61         verifyOption(true);
  62     }
  63 
  64     public void verifyOption(boolean useStackLock) throws Throwable {
  65         AbortProvoker provoker = AbortType.XABORT.provoker();
  66         String logFileName = String.format("rtm_deopt_%s_stack_lock.xml",
  67                 (useStackLock ? "use" : "no"));
  68         String methodOption = String.format("-XX:CompileCommand=option," +
  69                 "%s,NoRTMLockEliding", provoker.getMethodWithLockName());
  70 
  71         OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
  72                 logFileName,
  73                 provoker,
  74                 CommandLineOptionTest.prepareBooleanFlag("UseRTMForStackLocks",
  75                         useStackLock),
  76                 methodOption,
  77                 "-XX:RTMTotalCountIncrRate=1",
  78                 "-XX:+UseRTMDeopt",
  79                 "-XX:+PrintPreciseRTMLockingStatistics",
  80                 AbortProvoker.class.getName(),
  81                 AbortType.XABORT.toString(),
  82                 Boolean.toString(!useStackLock)
  83         );
  84 
  85         outputAnalyzer.shouldHaveExitValue(0);
  86 
  87         int firedTraps = RTMTestBase.firedRTMStateChangeTraps(logFileName);
  88 
  89         Asserts.assertEQ(firedTraps, 0,
  90                 "No deoptimizations with rtm_state_change reason are expected");
  91 
  92         List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
  93                 provoker.getMethodWithLockName(), outputAnalyzer.getOutput());
  94 
  95         Asserts.assertEQ(statistics.size(), 0,
  96                 "VM output should not contain RTM locking statistics entries "
  97                 + "for method " + provoker.getMethodWithLockName());
  98     }
  99 
 100     public static void main(String args[]) throws Throwable {
 101         new TestNoRTMLockElidingOption().test();
 102     }
 103 }