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