/*

 * Copyright (c) 2014, 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 RTMAbortRatio affects amount of aborts before

 *          deoptimization.

 * @library /testlibrary /testlibrary/whitebox /compiler/testlibrary

 * @build TestRTMAbortRatio

 * @run main ClassFileInstaller sun.hotspot.WhiteBox

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

 *                   -XX:+WhiteBoxAPI TestRTMAbortRatio

 */

import java.util.List;

import com.oracle.java.testlibrary.*;

import com.oracle.java.testlibrary.cli.CommandLineOptionTest;

import com.oracle.java.testlibrary.cli.predicate.AndPredicate;

import rtm.*;

import rtm.predicate.SupportedCPU;

import rtm.predicate.SupportedVM;

import sun.misc.Unsafe;

/**

 * Test verifies that method will be deoptimized on high abort ratio

 * as soon as abort ratio reaches RTMAbortRatio's value.

 */

public class TestRTMAbortRatio extends CommandLineOptionTest {

    private TestRTMAbortRatio() {

        super(new AndPredicate(new SupportedCPU(), new SupportedVM()));

    }

    @Override

    protected void runTestCases() throws Throwable {

        verifyAbortRatio(0, false);

        verifyAbortRatio(10, false);

        verifyAbortRatio(50, false);

        verifyAbortRatio(100, false);

        verifyAbortRatio(0, true);

        verifyAbortRatio(10, true);

        verifyAbortRatio(50, true);

        verifyAbortRatio(100, true);

    }

    private void verifyAbortRatio(int abortRatio, boolean useStackLock)

            throws Throwable {

        CompilableTest test = new Test();

        OutputAnalyzer outputAnalyzer = RTMTestBase.executeRTMTest(

                test,

                CommandLineOptionTest.prepareBooleanFlag("UseRTMForStackLocks",

                        useStackLock),

                "-XX:+UseRTMDeopt",

                "-XX:RTMTotalCountIncrRate=1",

                "-XX:RTMAbortThreshold=0",

                CommandLineOptionTest.prepareNumericFlag("RTMLockingThreshold",

                        10 * Test.TOTAL_ITERATIONS),

                CommandLineOptionTest.prepareNumericFlag("RTMAbortRatio",

                        abortRatio),

                "-XX:+PrintPreciseRTMLockingStatistics",

                test.getClass().getName(),

                Boolean.toString(!useStackLock));

        outputAnalyzer.shouldHaveExitValue(0);

        List<RTMLockingStatistics> statistics = RTMLockingStatistics.fromString(

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

        Asserts.assertEQ(statistics.size(), 1, "VM output should contain "

                + "exactly one RTM locking statistics entry.");

        RTMLockingStatistics lock = statistics.get(0);

        int actualRatio;

        if (lock.getTotalAborts() == 1L) {

            actualRatio = 0;

        } else {

            actualRatio = (int) (lock.getTotalLocks()

                    / (lock.getTotalAborts() - 1L));

        }

        Asserts.assertLTE(actualRatio, abortRatio, String.format(

                "Actual abort ratio (%d) should lower or equal to "

                + "specified (%d).", actualRatio, abortRatio));

    }

    /**

     * Force abort after {@code Test.WARMUP_ITERATIONS} is done.

     */

    public static class Test implements CompilableTest {

        private static final int TOTAL_ITERATIONS = 10000;

        private static final int WARMUP_ITERATIONS = 1000;

        private static final Unsafe UNSAFE = Utils.getUnsafe();

        private final Object monitor = new Object();

        // Following field have to be static in order to avoid escape analysis.

        @SuppressWarnings("UnsuedDeclaration")

        private static int field = 0;

        @Override

        public String getMethodWithLockName() {

             return this.getClass().getName() + "::lock";

         }

        @Override

        public String[] getMethodsToCompileNames() {

            return new String[] {

                    getMethodWithLockName(),

                    Unsafe.class.getName() + "::addressSize"

            };

        }

        public void lock(boolean abort) {

            synchronized(monitor) {

                if (abort) {

                    Test.UNSAFE.addressSize();

                }

            }

        }

        /**

         * Usage:

         * Test <inflate monitor>

         */

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

            Asserts.assertGTE(args.length, 1, "One argument required.");

            Test t = new Test();

            if (Boolean.valueOf(args[0])) {

                AbortProvoker.inflateMonitor(t.monitor);

            }

            for (int i = 0; i < Test.TOTAL_ITERATIONS; i++) {

                t.lock(i >= Test.WARMUP_ITERATIONS);

            }

        }

    }

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

        new TestRTMAbortRatio().test();

    }

}