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 NoRTMLockEliding option could be applied to
  28  *          specified method and that such method will not use rtm.
  29  * @library /test/lib /
  30  * @modules java.base/jdk.internal.misc
  31  *          java.management
  32  * @requires vm.rtm.cpu & vm.rtm.compiler
  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.method_options.TestNoRTMLockElidingOption
  39  */
  40 
  41 package compiler.rtm.method_options;
  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 jdk.test.lib.Asserts;
  48 import jdk.test.lib.process.OutputAnalyzer;
  49 import jdk.test.lib.cli.CommandLineOptionTest;
  50 
  51 import java.util.List;
  52 
  53 /**
  54  * Test verifies that method tagged with option <i>NoRTMLockElidingOption</i>
  55  * will not use RTM-based lock elision.
  56  * Test invokes compiled method and checks that no deoptimization with
  57  * <i>rtm_state_change</i> reason had happened and that that VM output
  58  * does not contain RTM locking statistics for compiled method.
  59  */
  60 public class TestNoRTMLockElidingOption {
  61 
  62     public void runTestCases() throws Throwable {
  63         verifyOption(false);
  64         verifyOption(true);
  65     }
  66 
  67     public void verifyOption(boolean useStackLock) throws Throwable {
  68         AbortProvoker provoker = AbortType.XABORT.provoker();
  69         String logFileName = String.format("rtm_deopt_%s_stack_lock.xml",
  70                 (useStackLock ? "use" : "no"));
  71         String methodOption = String.format("-XX:CompileCommand=option," +
  72                 "%s,NoRTMLockEliding", provoker.getMethodWithLockName());
  73 
  74         OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
  75                 logFileName,
  76                 provoker,
  77                 CommandLineOptionTest.prepareBooleanFlag("UseRTMForStackLocks",
  78                         useStackLock),
  79                 methodOption,
  80                 "-XX:RTMTotalCountIncrRate=1",
  81                 "-XX:+UseRTMDeopt",
  82                 "-XX:+PrintPreciseRTMLockingStatistics",
  83                 AbortProvoker.class.getName(),
  84                 AbortType.XABORT.toString(),
  85                 Boolean.toString(!useStackLock)
  86         );
  87 
  88         outputAnalyzer.shouldHaveExitValue(0);
  89 
  90         int firedTraps = RTMTestBase.firedRTMStateChangeTraps(logFileName);
  91 
  92         Asserts.assertEQ(firedTraps, 0,
  93                 "No deoptimizations with rtm_state_change reason are expected");
  94 
  95         List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
  96                 provoker.getMethodWithLockName(), outputAnalyzer.getOutput());
  97 
  98         Asserts.assertEQ(statistics.size(), 0,
  99                 "VM output should not contain RTM locking statistics entries "
 100                 + "for method " + provoker.getMethodWithLockName());
 101     }
 102 
 103     public static void main(String args[]) throws Throwable {
 104         new TestNoRTMLockElidingOption().runTestCases();
 105     }
 106 }