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 RTMSpinLoopCount affects time spent
  28  *          between locking attempts.
  29  * @library /test/lib /
  30  * @modules java.base/jdk.internal.misc
  31  *          java.management
  32  * @requires vm.flavor == "server" & !vm.emulatedClient & vm.rtm.cpu & vm.rtm.os
  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 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 RTMSpinLoopCount increase time spent between retries
  55  * by comparing amount of retries done with different RTMSpinLoopCount's values.
  56  */
  57 public class TestRTMSpinLoopCount {
  58     private static final int LOCKING_TIME = 1000;
  59     private static final int RTM_RETRY_COUNT = 1000;
  60     private static final boolean INFLATE_MONITOR = true;
  61     private static final long MAX_ABORTS = RTM_RETRY_COUNT + 1L;
  62     private static final int[] SPIN_LOOP_COUNTS
  63             = new int[] { 0, 100, 1_000, 1_000_000, 10_000_000 };
  64 
  65     protected void runTestCases() throws Throwable {
  66         long[] aborts = new long[TestRTMSpinLoopCount.SPIN_LOOP_COUNTS.length];
  67         for (int i = 0; i < TestRTMSpinLoopCount.SPIN_LOOP_COUNTS.length; i++) {
  68             aborts[i] = getAbortsCountOnLockBusy(
  69                     TestRTMSpinLoopCount.SPIN_LOOP_COUNTS[i]);
  70         }
  71 
  72         for (int i = 1; i < aborts.length; i++) {
  73             Asserts.assertLTE(aborts[i], aborts[i - 1], "Increased spin loop "
  74                     + "count should not increase retries count.");
  75         }
  76     }
  77 
  78     private long getAbortsCountOnLockBusy(int spinLoopCount) throws Throwable {
  79         CompilableTest test = new BusyLock();
  80 
  81         OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
  82                 test,
  83                 CommandLineOptionTest.prepareNumericFlag("RTMRetryCount",
  84                         TestRTMSpinLoopCount.RTM_RETRY_COUNT),
  85                 CommandLineOptionTest.prepareNumericFlag("RTMSpinLoopCount",
  86                         spinLoopCount),
  87                 "-XX:-UseRTMXendForLockBusy",
  88                 "-XX:RTMTotalCountIncrRate=1",
  89                 "-XX:+PrintPreciseRTMLockingStatistics",
  90                 BusyLock.class.getName(),
  91                 Boolean.toString(TestRTMSpinLoopCount.INFLATE_MONITOR),
  92                 Integer.toString(TestRTMSpinLoopCount.LOCKING_TIME)
  93         );
  94 
  95         outputAnalyzer.shouldHaveExitValue(0);
  96 
  97         List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
  98                 test.getMethodWithLockName(), outputAnalyzer.getOutput());
  99 
 100         Asserts.assertEQ(statistics.size(), 1,
 101                 "VM output should contain exactly one entry for method "
 102                  + test.getMethodWithLockName());
 103 
 104         RTMLockingStatistics lock = statistics.get(0);
 105 
 106         Asserts.assertLTE(lock.getTotalAborts(),
 107                 TestRTMSpinLoopCount.MAX_ABORTS, String.format("Total aborts "
 108                         + "count (%d) should be less or equal to %d",
 109                         lock.getTotalAborts(),
 110                         TestRTMSpinLoopCount.MAX_ABORTS));
 111 
 112         return lock.getTotalAborts();
 113     }
 114 
 115     public static void main(String args[]) throws Throwable {
 116         new TestRTMSpinLoopCount().runTestCases();
 117     }
 118 }