/*

 * Copyright (c) 2014, 2016, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

/**

 * @test

 * @bug 8031320

 * @summary Verify that UseRTMLockEliding option could be applied to

 *          specified method and that such method will not be deoptimized

 *          on high abort ratio.

 * @library /test/lib /

 * @modules java.base/jdk.internal.misc

 *          java.management

 * @requires vm.rtm.cpu & vm.rtm.compiler

 * @build sun.hotspot.WhiteBox

 * @run driver ClassFileInstaller sun.hotspot.WhiteBox

 *                                sun.hotspot.WhiteBox$WhiteBoxPermission

 * @run main/othervm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions

 *                   -XX:+WhiteBoxAPI

 *                   compiler.rtm.method_options.TestUseRTMLockElidingOption

 */

package compiler.rtm.method_options;

import compiler.testlibrary.rtm.AbortProvoker;

import compiler.testlibrary.rtm.AbortType;

import compiler.testlibrary.rtm.RTMLockingStatistics;

import compiler.testlibrary.rtm.RTMTestBase;

import jdk.test.lib.Asserts;

import jdk.test.lib.process.OutputAnalyzer;

import jdk.test.lib.cli.CommandLineOptionTest;

import java.util.List;

/**

 * Test verifies that method tagged with option <i>UseRTMLockElidingOption</i>

 * will use RTM-based lock elision, but will be never deoptimized with

 * <i>rtm_state_change reason</i>.

 * Test invokes compiled method and checks that no deoptimization with

 * <i>rtm_state_change</i> reason had happened and that that VM output

 * contains RTM locking statistics for compiled method and that total locks

 * count equals to method's invocations.

 * Since last assert is pretty strict, test uses -XX:RTMRetryCount=0 in order

 * to avoid issue with retriable aborts described in

 * {@link TestUseRTMAfterLockInflation}.

 */

public class TestUseRTMLockElidingOption {

    public void runTestCases() throws Throwable {

        verifyOption(false);

        verifyOption(true);

    }

    public void verifyOption(boolean useStackLock) throws Throwable {

        AbortProvoker provoker = AbortType.XABORT.provoker();

        String logFileName = String.format("rtm_deopt_%s_stack_lock.xml",

                (useStackLock ? "use" : "no"));

        String methodOption = String.format("-XX:CompileCommand=option," +

                "%s,UseRTMLockEliding", provoker.getMethodWithLockName());

        OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(

                logFileName,

                provoker,

                CommandLineOptionTest.prepareBooleanFlag("UseRTMForStackLocks",

                        useStackLock),

                methodOption,

                "-XX:RTMTotalCountIncrRate=1",

                "-XX:RTMRetryCount=0",

                "-XX:+UseRTMDeopt",

                "-XX:+PrintPreciseRTMLockingStatistics",

                provoker.getClass().getName(),

                AbortType.XABORT.toString(),

                Boolean.toString(!useStackLock)

        );

        outputAnalyzer.shouldHaveExitValue(0);

        int firedTraps = RTMTestBase.firedRTMStateChangeTraps(logFileName);

        Asserts.assertEQ(firedTraps, 0,

                "Method deoptimization with rtm_state_change is unexpected");

        List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(

                provoker.getMethodWithLockName(), outputAnalyzer.getOutput());

        Asserts.assertEQ(statistics.size(), 1,

                "VM output should contain exactly one RTM locking "

                + "statistics entry for method "

                + provoker.getMethodWithLockName());

        RTMLockingStatistics lock = statistics.get(0);

        Asserts.assertEQ(lock.getTotalLocks(), AbortProvoker.DEFAULT_ITERATIONS,

                "Expected to get total locks count equal to total amount of "

                + "lock attempts.");

    }

    public static void main(String args[]) throws Throwable {

        new TestUseRTMLockElidingOption().runTestCases();

    }

}