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 on low abort ratio method will be recompiled.
  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.TestRTMDeoptOnLowAbortRatio
  38  */
  39 
  40 package compiler.rtm.locking;
  41 
  42 import compiler.testlibrary.rtm.AbortProvoker;
  43 import compiler.testlibrary.rtm.CompilableTest;
  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.internal.misc.Unsafe;
  49 import jdk.test.lib.Asserts;
  50 import jdk.test.lib.process.OutputAnalyzer;
  51 import jdk.test.lib.unsafe.UnsafeHelper;
  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 low abort ratio method will be deoptimized with
  59  * <i>rtm_state_change</i> reason and will continue to use RTM-based lock
  60  * elision after that.
  61  * This test make asserts on total locks count done by compiled method,
  62  * so in order to avoid issue with retriable locks -XX:RTMRetryCount=0 is used.
  63  * For more details on that issue see {@link TestUseRTMAfterLockInflation}.
  64  */
  65 public class TestRTMDeoptOnLowAbortRatio extends CommandLineOptionTest {
  66     private static final long LOCKING_THRESHOLD = 100L;
  67     private static final long ABORT_THRESHOLD = LOCKING_THRESHOLD / 2L;
  68 
  69     private TestRTMDeoptOnLowAbortRatio() {
  70         super(new AndPredicate(new SupportedCPU(), new SupportedVM()));
  71     }
  72 
  73     @Override
  74     protected void runTestCases() throws Throwable {
  75         verifyRTMDeopt(false);
  76         verifyRTMDeopt(true);
  77     }
  78 
  79     private void verifyRTMDeopt(boolean useStackLock) throws Throwable {
  80         CompilableTest test = new Test();
  81         String logFileName = String.format("rtm_deopt_%s_stack_lock.xml",
  82                                            useStackLock ? "use" : "no");
  83 
  84         OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
  85                 logFileName,
  86                 test,
  87                 "-XX:+UseRTMDeopt",
  88                 CommandLineOptionTest.prepareBooleanFlag("UseRTMForStackLocks",
  89                         useStackLock),
  90                 CommandLineOptionTest.prepareNumericFlag("RTMLockingThreshold",
  91                         TestRTMDeoptOnLowAbortRatio.LOCKING_THRESHOLD),
  92                 CommandLineOptionTest.prepareNumericFlag("RTMAbortThreshold",
  93                         TestRTMDeoptOnLowAbortRatio.ABORT_THRESHOLD),
  94                 "-XX:RTMAbortRatio=100",
  95                 "-XX:CompileThreshold=1",
  96                 "-XX:RTMRetryCount=0",
  97                 "-XX:RTMTotalCountIncrRate=1",
  98                 "-XX:+PrintPreciseRTMLockingStatistics",
  99                 Test.class.getName(),
 100                 Boolean.toString(!useStackLock)
 101         );
 102 
 103         outputAnalyzer.shouldHaveExitValue(0);
 104 
 105         int firedTraps = RTMTestBase.firedRTMStateChangeTraps(logFileName);
 106 
 107         Asserts.assertEQ(firedTraps, 1,
 108                         "Expected to get only one deoptimization due to rtm"
 109                         + " state change");
 110 
 111         List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
 112                 test.getMethodWithLockName(), outputAnalyzer.getOutput());
 113 
 114         Asserts.assertEQ(statistics.size(), 2,
 115                          "VM output should contain two RTM locking "
 116                          + "statistics entries for method "
 117                          + test.getMethodWithLockName());
 118 
 119         RTMLockingStatistics statisticsBeforeDeopt = null;
 120 
 121         for (RTMLockingStatistics s : statistics) {
 122             if (s.getTotalLocks()
 123                     == TestRTMDeoptOnLowAbortRatio.LOCKING_THRESHOLD) {
 124                 Asserts.assertNull(statisticsBeforeDeopt,
 125                         "Only one abort was expected during test run");
 126                 statisticsBeforeDeopt = s;
 127             }
 128         }
 129 
 130         Asserts.assertNotNull(statisticsBeforeDeopt,
 131                 "After LockThreshold was reached, method should be recompiled "
 132                 + "with rtm lock eliding.");
 133     }
 134 
 135     public static class Test implements CompilableTest {
 136         private static final Unsafe UNSAFE = UnsafeHelper.getUnsafe();
 137         private final Object monitor = new Object();
 138 
 139         @Override
 140         public String getMethodWithLockName() {
 141             return this.getClass().getName() + "::forceAbort";
 142         }
 143 
 144         @Override
 145         public String[] getMethodsToCompileNames() {
 146             return new String[] { getMethodWithLockName() };
 147         }
 148 
 149         public void forceAbort(boolean abort) {
 150             synchronized(monitor) {
 151                 if (abort) {
 152                     Test.UNSAFE.addressSize();
 153                 }
 154             }
 155         }
 156 
 157         /**
 158          * Usage:
 159          * Test &lt;inflate monitor&gt;
 160          */
 161         public static void main(String args[]) throws Throwable {
 162             Asserts.assertGTE(args.length, 1, "One argument required.");
 163             Test t = new Test();
 164             boolean shouldBeInflated = Boolean.valueOf(args[0]);
 165             if (shouldBeInflated) {
 166                 AbortProvoker.inflateMonitor(t.monitor);
 167             }
 168             for (int i = 0; i < AbortProvoker.DEFAULT_ITERATIONS; i++) {
 169                 AbortProvoker.verifyMonitorState(t.monitor, shouldBeInflated);
 170                 t.forceAbort(i >= TestRTMDeoptOnLowAbortRatio.ABORT_THRESHOLD);
 171             }
 172         }
 173     }
 174 
 175     public static void main(String args[]) throws Throwable {
 176         new TestRTMDeoptOnLowAbortRatio().test();
 177     }
 178 }