aoqi@0: /*
aoqi@0:  * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  *
aoqi@0:  */
aoqi@0: 
aoqi@0: /**
aoqi@0:  * @test
aoqi@0:  * @bug 8031320
aoqi@0:  * @summary Verify that if we use RTMDeopt, then deoptimization
aoqi@0:  *          caused by reason other then rtm_state_change will reset
aoqi@0:  *          method's RTM state. And if we don't use RTMDeopt, then
aoqi@0:  *          RTM state remain the same after such deoptimization.
aoqi@0:  * @library /testlibrary /testlibrary/whitebox /compiler/testlibrary
aoqi@0:  * @build TestRTMAfterNonRTMDeopt
aoqi@0:  * @run main ClassFileInstaller sun.hotspot.WhiteBox
aoqi@0:  * @run main/othervm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions
aoqi@0:  *                   -XX:+WhiteBoxAPI TestRTMAfterNonRTMDeopt
aoqi@0:  */
aoqi@0: 
aoqi@0: import java.util.List;
aoqi@0: import com.oracle.java.testlibrary.*;
aoqi@0: import com.oracle.java.testlibrary.cli.CommandLineOptionTest;
aoqi@0: import com.oracle.java.testlibrary.cli.predicate.AndPredicate;
aoqi@0: import rtm.*;
aoqi@0: import rtm.predicate.SupportedCPU;
aoqi@0: import rtm.predicate.SupportedVM;
aoqi@0: import sun.misc.Unsafe;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * To verify that with +UseRTMDeopt method's RTM state will be
aoqi@0:  * changed to ProfileRTM on deoptimization unrelated to
aoqi@0:  * rtm_state_change following sequence of events is used:
aoqi@0:  * <pre>
aoqi@0:  *
aoqi@0:  *     rtm state ^
aoqi@0:  *               |
aoqi@0:  *       UseRTM  |      ******|     ******
aoqi@0:  *               |            |
aoqi@0:  *   ProfileRTM  |******|     |*****|
aoqi@0:  *               |      |     |     |
aoqi@0:  *              0-------|-----|-----|---------------------&gt; time
aoqi@0:  *                      |     |     \ force abort
aoqi@0:  *                      |     |
aoqi@0:  *                      |     \ force deoptimization
aoqi@0:  *                      |
aoqi@0:  *                      \ force xabort
aoqi@0:  * </pre>
aoqi@0:  * When xabort is forced by native method call method should
aoqi@0:  * change it's state to UseRTM, because we use RTMAbortRatio=100
aoqi@0:  * and low RTMLockingThreshold, so at this point actual abort
aoqi@0:  * ratio will be below 100% and there should be enough lock
aoqi@0:  * attempts to recompile method without RTM profiling.
aoqi@0:  */
aoqi@0: public class TestRTMAfterNonRTMDeopt extends CommandLineOptionTest {
aoqi@0:     private static final int ABORT_THRESHOLD = 1000;
aoqi@0:     private static final String RANGE_CHECK = "range_check";
aoqi@0: 
aoqi@0:     private TestRTMAfterNonRTMDeopt() {
aoqi@0:         super(new AndPredicate(new SupportedCPU(), new SupportedVM()));
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     protected void runTestCases() throws Throwable {
aoqi@0:         verifyRTMAfterDeopt(false, false);
aoqi@0:         verifyRTMAfterDeopt(true, false);
aoqi@0: 
aoqi@0:         verifyRTMAfterDeopt(false, true);
aoqi@0:         verifyRTMAfterDeopt(true, true);
aoqi@0:     }
aoqi@0: 
aoqi@0:     private void verifyRTMAfterDeopt(boolean useStackLock,
aoqi@0:             boolean useRTMDeopt) throws Throwable {
aoqi@0:         CompilableTest test = new Test();
aoqi@0:         String logFile = String.format("rtm_%s_stack_lock_%s_deopt.xml",
aoqi@0:                 (useStackLock ? "use" : "no"), (useRTMDeopt ? "use" : "no"));
aoqi@0: 
aoqi@0:         OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(
aoqi@0:                 logFile,
aoqi@0:                 test,
aoqi@0:                 "-XX:CompileThreshold=1",
aoqi@0:                 CommandLineOptionTest.prepareBooleanFlag("UseRTMForStackLocks",
aoqi@0:                         useStackLock),
aoqi@0:                 CommandLineOptionTest.prepareBooleanFlag("UseRTMDeopt",
aoqi@0:                         useRTMDeopt),
aoqi@0:                 "-XX:RTMAbortRatio=100",
aoqi@0:                 CommandLineOptionTest.prepareNumericFlag("RTMAbortThreshold",
aoqi@0:                         TestRTMAfterNonRTMDeopt.ABORT_THRESHOLD),
aoqi@0:                 CommandLineOptionTest.prepareNumericFlag("RTMLockingThreshold",
aoqi@0:                         TestRTMAfterNonRTMDeopt.ABORT_THRESHOLD / 2L),
aoqi@0:                 "-XX:RTMTotalCountIncrRate=1",
aoqi@0:                 "-XX:+PrintPreciseRTMLockingStatistics",
aoqi@0:                 Test.class.getName(),
aoqi@0:                 Boolean.toString(!useStackLock)
aoqi@0:         );
aoqi@0: 
aoqi@0:         outputAnalyzer.shouldHaveExitValue(0);
aoqi@0: 
aoqi@0:         int traps = RTMTestBase.firedRTMStateChangeTraps(logFile);
aoqi@0: 
aoqi@0:         if (useRTMDeopt) {
aoqi@0:             Asserts.assertEQ(traps, 2, "Two uncommon traps with "
aoqi@0:                     + "reason rtm_state_change should be fired.");
aoqi@0:         } else {
aoqi@0:             Asserts.assertEQ(traps, 0, "No uncommon traps with "
aoqi@0:                     + "reason rtm_state_change should be fired.");
aoqi@0:         }
aoqi@0: 
aoqi@0:         int rangeCheckTraps = RTMTestBase.firedUncommonTraps(logFile,
aoqi@0:                 TestRTMAfterNonRTMDeopt.RANGE_CHECK);
aoqi@0: 
aoqi@0:         Asserts.assertEQ(rangeCheckTraps, 1,
aoqi@0:                 "One range_check uncommon trap should be fired.");
aoqi@0: 
aoqi@0:         List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(
aoqi@0:                 test.getMethodWithLockName(), outputAnalyzer.getOutput());
aoqi@0: 
aoqi@0:         int expectedStatEntries = (useRTMDeopt ? 4 : 2);
aoqi@0: 
aoqi@0:         Asserts.assertEQ(statistics.size(), expectedStatEntries,
aoqi@0:                 String.format("VM output should contain %d RTM locking "
aoqi@0:                         + "statistics entries.", expectedStatEntries));
aoqi@0:     }
aoqi@0: 
aoqi@0:     public static class Test implements CompilableTest {
aoqi@0:         // Following field have to be static in order to avoid escape analysis.
aoqi@0:         @SuppressWarnings("UnsuedDeclaration")
aoqi@0:         private static int field = 0;
aoqi@0:         private static final int ITERATIONS = 10000;
aoqi@0:         private static final int RANGE_CHECK_AT = ITERATIONS / 2;
aoqi@0:         private static final Unsafe UNSAFE = Utils.getUnsafe();
aoqi@0:         private final Object monitor = new Object();
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public String getMethodWithLockName() {
aoqi@0:             return this.getClass().getName() + "::forceAbort";
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public String[] getMethodsToCompileNames() {
aoqi@0:             return new String[] {
aoqi@0:                 getMethodWithLockName(),
aoqi@0:                 sun.misc.Unsafe.class.getName() + "::forceAbort"
aoqi@0:             };
aoqi@0:         }
aoqi@0: 
aoqi@0:         public void forceAbort(int a[], boolean abort) {
aoqi@0:             try {
aoqi@0:                 synchronized(monitor) {
aoqi@0:                     a[0]++;
aoqi@0:                     if (abort) {
aoqi@0:                         Test.field = Test.UNSAFE.addressSize();
aoqi@0:                     }
aoqi@0:                 }
aoqi@0:             } catch (Throwable t) {
aoqi@0:                 // suppress any throwables
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         /**
aoqi@0:          * Usage:
aoqi@0:          * Test &lt;inflate monitor&gt;
aoqi@0:          */
aoqi@0:         public static void main(String args[]) throws Throwable {
aoqi@0:             Test t = new Test();
aoqi@0: 
aoqi@0:             if (Boolean.valueOf(args[0])) {
aoqi@0:                 AbortProvoker.inflateMonitor(t.monitor);
aoqi@0:             }
aoqi@0: 
aoqi@0:             int tmp[] = new int[1];
aoqi@0: 
aoqi@0:             for (int i = 0; i < Test.ITERATIONS; i++ ) {
aoqi@0:                 if (i == Test.RANGE_CHECK_AT) {
aoqi@0:                     t.forceAbort(new int[0], false);
aoqi@0:                 } else {
aoqi@0:                     boolean isThreshold
aoqi@0:                             = (i == TestRTMAfterNonRTMDeopt.ABORT_THRESHOLD);
aoqi@0:                     boolean isThresholdPlusRange
aoqi@0:                             = (i == TestRTMAfterNonRTMDeopt.ABORT_THRESHOLD
aoqi@0:                             + Test.RANGE_CHECK_AT);
aoqi@0:                     t.forceAbort(tmp, isThreshold || isThresholdPlusRange);
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     public static void main(String args[]) throws Throwable {
aoqi@0:         new TestRTMAfterNonRTMDeopt().test();
aoqi@0:     }
aoqi@0: }
aoqi@0: