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 RTMAbortRatio affects amount of aborts before
  28  *          deoptimization.
  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.TestRTMAbortRatio
  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.SupportedOS;
  48 import compiler.testlibrary.rtm.predicate.SupportedVM;
  49 import jdk.internal.misc.Unsafe;
  50 import jdk.test.lib.Asserts;
  51 import jdk.test.lib.process.OutputAnalyzer;
  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 method will be deoptimized on high abort ratio
  59  * as soon as abort ratio reaches RTMAbortRatio's value.
  60  */
  61 public class TestRTMAbortRatio extends CommandLineOptionTest {
  62     private TestRTMAbortRatio() {
  63         super(new AndPredicate(new SupportedCPU(), new SupportedOS(), new SupportedVM()));
  64     }
  65 
  66     @Override
  67     protected void runTestCases() throws Throwable {
  68         verifyAbortRatio(0, false);
  69         verifyAbortRatio(10, false);
  70         verifyAbortRatio(50, false);
  71         verifyAbortRatio(100, false);
  72 
  73         verifyAbortRatio(0, true);
  74         verifyAbortRatio(10, true);
  75         verifyAbortRatio(50, true);
  76         verifyAbortRatio(100, true);
  77     }
  78 
  79     private void verifyAbortRatio(int abortRatio, boolean useStackLock)
  80             throws Throwable {
  81         CompilableTest test = new Test();
  82 
  83         OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
  84                 test,
  85                 CommandLineOptionTest.prepareBooleanFlag("UseRTMForStackLocks",
  86                         useStackLock),
  87                 "-XX:+UseRTMDeopt",
  88                 "-XX:RTMTotalCountIncrRate=1",
  89                 "-XX:RTMAbortThreshold=0",
  90                 CommandLineOptionTest.prepareNumericFlag("RTMLockingThreshold",
  91                         10 * Test.TOTAL_ITERATIONS),
  92                 CommandLineOptionTest.prepareNumericFlag("RTMAbortRatio",
  93                         abortRatio),
  94                 "-XX:+PrintPreciseRTMLockingStatistics",
  95                 test.getClass().getName(),
  96                 Boolean.toString(!useStackLock));
  97 
  98         outputAnalyzer.shouldHaveExitValue(0);
  99 
 100         List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
 101                 test.getMethodWithLockName(), outputAnalyzer.getOutput());
 102 
 103         Asserts.assertEQ(statistics.size(), 1, "VM output should contain "
 104                 + "exactly one RTM locking statistics entry.");
 105 
 106         RTMLockingStatistics lock = statistics.get(0);
 107         int actualRatio;
 108 
 109         if (lock.getTotalAborts() == 1L) {
 110             actualRatio = 0;
 111         } else {
 112             actualRatio = (int) (lock.getTotalLocks()
 113                     / (lock.getTotalAborts() - 1L));
 114         }
 115 
 116         Asserts.assertLTE(actualRatio, abortRatio, String.format(
 117                 "Actual abort ratio (%d) should lower or equal to "
 118                 + "specified (%d).", actualRatio, abortRatio));
 119     }
 120 
 121     /**
 122      * Force abort after {@code Test.WARMUP_ITERATIONS} is done.
 123      */
 124     public static class Test implements CompilableTest {
 125         private static final int TOTAL_ITERATIONS = 10000;
 126         private static final int WARMUP_ITERATIONS = 1000;
 127         private static final Unsafe UNSAFE = Unsafe.getUnsafe();
 128         private final Object monitor = new Object();
 129         // Following field have to be static in order to avoid escape analysis.
 130         @SuppressWarnings("UnsuedDeclaration")
 131         private static int field = 0;
 132 
 133         @Override
 134         public String getMethodWithLockName() {
 135              return this.getClass().getName() + "::lock";
 136          }
 137 
 138         @Override
 139         public String[] getMethodsToCompileNames() {
 140             return new String[] { getMethodWithLockName() };
 141         }
 142 
 143         public void lock(boolean abort) {
 144             synchronized(monitor) {
 145                 if (abort) {
 146                     Test.UNSAFE.addressSize();
 147                 }
 148             }
 149         }
 150 
 151         /**
 152          * Usage:
 153          * Test &lt;inflate monitor&gt;
 154          */
 155         public static void main(String args[]) throws Throwable {
 156             Asserts.assertGTE(args.length, 1, "One argument required.");
 157             Test t = new Test();
 158             boolean shouldBeInflated = Boolean.valueOf(args[0]);
 159             if (shouldBeInflated) {
 160                 AbortProvoker.inflateMonitor(t.monitor);
 161             }
 162             for (int i = 0; i < Test.TOTAL_ITERATIONS; i++) {
 163                 AbortProvoker.verifyMonitorState(t.monitor, shouldBeInflated);
 164                 t.lock(i >= Test.WARMUP_ITERATIONS);
 165             }
 166         }
 167     }
 168 
 169     public static void main(String args[]) throws Throwable {
 170         new TestRTMAbortRatio().test();
 171     }
 172 }
 173