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 RTMSpinLoopCount affects time spent
  29  *          between locking attempts.
  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.TestRTMSpinLoopCount
  39  */
  40 
  41 package compiler.rtm.locking;
  42 
  43 import compiler.testlibrary.rtm.BusyLock;
  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.SupportedOS;
  49 import compiler.testlibrary.rtm.predicate.SupportedVM;
  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 RTMSpinLoopCount increase time spent between retries
  59  * by comparing amount of retries done with different RTMSpinLoopCount's values.
  60  */
  61 public class TestRTMSpinLoopCount extends CommandLineOptionTest {
  62     private static final int LOCKING_TIME = 1000;
  63     private static final int RTM_RETRY_COUNT = 1000;
  64     private static final boolean INFLATE_MONITOR = true;
  65     private static final long MAX_ABORTS = RTM_RETRY_COUNT + 1L;
  66     private static final int[] SPIN_LOOP_COUNTS
  67             = new int[] { 0, 100, 1_000, 1_000_000, 10_000_000 };
  68 
  69     private TestRTMSpinLoopCount() {
  70         super(new AndPredicate(new SupportedCPU(), new SupportedOS(), new SupportedVM()));
  71     }
  72 
  73     @Override
  74     protected void runTestCases() throws Throwable {
  75         long[] aborts = new long[TestRTMSpinLoopCount.SPIN_LOOP_COUNTS.length];
  76         for (int i = 0; i < TestRTMSpinLoopCount.SPIN_LOOP_COUNTS.length; i++) {
  77             aborts[i] = getAbortsCountOnLockBusy(
  78                     TestRTMSpinLoopCount.SPIN_LOOP_COUNTS[i]);
  79         }
  80 
  81         for (int i = 1; i < aborts.length; i++) {
  82             Asserts.assertLTE(aborts[i], aborts[i - 1], "Increased spin loop "
  83                     + "count should not increase retries count.");
  84         }
  85     }
  86 
  87     private long getAbortsCountOnLockBusy(int spinLoopCount) throws Throwable {
  88         CompilableTest test = new BusyLock();
  89 
  90         OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
  91                 test,
  92                 CommandLineOptionTest.prepareNumericFlag("RTMRetryCount",
  93                         TestRTMSpinLoopCount.RTM_RETRY_COUNT),
  94                 CommandLineOptionTest.prepareNumericFlag("RTMSpinLoopCount",
  95                         spinLoopCount),
  96                 "-XX:-UseRTMXendForLockBusy",
  97                 "-XX:RTMTotalCountIncrRate=1",
  98                 "-XX:+PrintPreciseRTMLockingStatistics",
  99                 BusyLock.class.getName(),
 100                 Boolean.toString(TestRTMSpinLoopCount.INFLATE_MONITOR),
 101                 Integer.toString(TestRTMSpinLoopCount.LOCKING_TIME)
 102         );
 103 
 104         outputAnalyzer.shouldHaveExitValue(0);
 105 
 106         List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
 107                 test.getMethodWithLockName(), outputAnalyzer.getOutput());
 108 
 109         Asserts.assertEQ(statistics.size(), 1,
 110                 "VM output should contain exactly one entry for method "
 111                  + test.getMethodWithLockName());
 112 
 113         RTMLockingStatistics lock = statistics.get(0);
 114 
 115         Asserts.assertLTE(lock.getTotalAborts(),
 116                 TestRTMSpinLoopCount.MAX_ABORTS, String.format("Total aborts "
 117                         + "count (%d) should be less or equal to %d",
 118                         lock.getTotalAborts(),
 119                         TestRTMSpinLoopCount.MAX_ABORTS));
 120 
 121         return lock.getTotalAborts();
 122     }
 123 
 124     public static void main(String args[]) throws Throwable {
 125         new TestRTMSpinLoopCount().test();
 126     }
 127 }