/*

 * Copyright (c) 2014, 2015, 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 UseRTMForStackLocks option processing on CPUs without

 *          rtm support and/or on VMs without rtm locking support.

 * @modules java.base/sun.misc

 *          java.management

 * @build TestUseRTMForStackLocksOptionOnUnsupportedConfig

 * @run main ClassFileInstaller sun.hotspot.WhiteBox

 *                              sun.hotspot.WhiteBox$WhiteBoxPermission

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

 *                   -XX:+WhiteBoxAPI

 *                    TestUseRTMForStackLocksOptionOnUnsupportedConfig

 */

import jdk.test.lib.ExitCode;

import jdk.test.lib.cli.CommandLineOptionTest;

import jdk.test.lib.cli.predicate.AndPredicate;

import jdk.test.lib.cli.predicate.NotPredicate;

import rtm.predicate.SupportedCPU;

import rtm.predicate.SupportedVM;

public class TestUseRTMForStackLocksOptionOnUnsupportedConfig

        extends RTMGenericCommandLineOptionTest {

    private static final String DEFAULT_VALUE = "false";

    private TestUseRTMForStackLocksOptionOnUnsupportedConfig() {

        super(new NotPredicate(new AndPredicate(new SupportedCPU(),

                        new SupportedVM())),

                "UseRTMForStackLocks", true, true,

                TestUseRTMForStackLocksOptionOnUnsupportedConfig.DEFAULT_VALUE,

                "true");

    }

    @Override

    protected void runX86SupportedVMTestCases() throws Throwable {

        String shouldFailMessage = String.format("VM option '%s' is "

                + "experimental%nJVM startup should fail without "

                + "-XX:+UnlockExperimentalVMOptions flag", optionName);

        // verify that option is experimental

        CommandLineOptionTest.verifySameJVMStartup(

                new String[] { experimentalOptionError }, null,

                shouldFailMessage, shouldFailMessage + "%nError message "

                        + "should be shown", ExitCode.FAIL,

                prepareOptionValue("true"));

        CommandLineOptionTest.verifySameJVMStartup(

                new String[]{ experimentalOptionError }, null,

                shouldFailMessage, shouldFailMessage + "%nError message "

                        + "should be shown", ExitCode.FAIL,

                prepareOptionValue("false"));

        String shouldPassMessage = String.format("VM option '%s' is "

                + " experimental%nJVM startup should pass with "

                + "-XX:+UnlockExperimentalVMOptions flag", optionName);

        // verify that if we turn it on, then VM output will contain

        // warning saying that this option could be turned on only

        // when we use rtm locking

        CommandLineOptionTest.verifySameJVMStartup(

                new String[]{

                    RTMGenericCommandLineOptionTest.RTM_FOR_STACK_LOCKS_WARNING

                }, null, shouldPassMessage, "There should be warning when try "

                    + "to use rtm for stack lock, but not using rtm locking",

                ExitCode.OK,

                CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,

                prepareOptionValue("true")

        );

        // verify that options is turned off by default

        CommandLineOptionTest.verifyOptionValueForSameVM(optionName,

                TestUseRTMForStackLocksOptionOnUnsupportedConfig.DEFAULT_VALUE,

                String.format("Default value of option '%s' should be '%s'",

                        optionName, DEFAULT_VALUE),

                CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS);

        // verify that it could not be turned on without rtm locking

        CommandLineOptionTest.verifyOptionValueForSameVM(optionName,

                TestUseRTMForStackLocksOptionOnUnsupportedConfig.DEFAULT_VALUE,

                String.format("Value of '%s' shouldn't able to be set to "

                        + "'true' without setting -XX:+UseRTMLocking flag",

                        optionName),

                CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,

                prepareOptionValue("true"));

    }

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

        new TestUseRTMForStackLocksOptionOnUnsupportedConfig().test();

    }

}