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 UseRTMForStackLocks option processing on CPU with
28 *          rtm support when VM supports rtm locking.
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.cli.TestUseRTMForStackLocksOptionOnSupportedConfig
39 */
40
41package compiler.rtm.cli;
42
43import jdk.test.lib.process.ExitCode;
44import jdk.test.lib.cli.CommandLineOptionTest;
45
46public class TestUseRTMForStackLocksOptionOnSupportedConfig {
47    private static final String DEFAULT_VALUE = "false";
48
49    public void runTestCases() throws Throwable {
50        String errorMessage
51                = CommandLineOptionTest.getExperimentalOptionErrorMessage(
52                "UseRTMForStackLocks");
53        String warningMessage
54                = RTMGenericCommandLineOptionTest.RTM_FOR_STACK_LOCKS_WARNING;
55
56        String shouldFailMessage = " VM option 'UseRTMForStackLocks' is "
57                + "experimental%nJVM startup should fail without "
58                + "-XX:+UnlockExperimentalVMOptions flag";
59
60        CommandLineOptionTest.verifySameJVMStartup(
61                new String[] { errorMessage }, null, shouldFailMessage,
62                shouldFailMessage + "%nError message expected", ExitCode.FAIL,
63                "-XX:+UseRTMForStackLocks");
64        String shouldPassMessage = " VM option 'UseRTMForStackLocks'"
65                + " is experimental%nJVM startup should pass with "
66                + "-XX:+UnlockExperimentalVMOptions flag";
67        // verify that we get a warning when trying to use rtm for stack
68        // lock, but not using rtm locking.
69        CommandLineOptionTest.verifySameJVMStartup(
70                new String[] { warningMessage }, null, shouldPassMessage,
71                "There should be warning when trying to use rtm for stack "
72                        + "lock, but not using rtm locking", ExitCode.OK,
73                CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,
74                "-XX:+UseRTMForStackLocks",
75                "-XX:-UseRTMLocking");
76        // verify that we don't get a warning when no using rtm for stack
77        // lock and not using rtm locking.
78        CommandLineOptionTest.verifySameJVMStartup(null,
79                new String[] { warningMessage }, shouldPassMessage,
80                "There should not be any warning when use both "
81                        + "-XX:-UseRTMForStackLocks and -XX:-UseRTMLocking "
82                        + "flags",
83                ExitCode.OK,
84                CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,
85                "-XX:-UseRTMForStackLocks",
86                "-XX:-UseRTMLocking");
87        // verify that we don't get a warning when using rtm for stack
88        // lock and using rtm locking.
89        CommandLineOptionTest.verifySameJVMStartup(null,
90                new String[] { warningMessage }, shouldPassMessage,
91                "There should not be any warning when use both "
92                        + "-XX:+UseRTMForStackLocks and -XX:+UseRTMLocking"
93                        + " flags",
94                ExitCode.OK,
95                CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,
96                "-XX:+UseRTMForStackLocks",
97                "-XX:+UseRTMLocking");
98        // verify that default value if false
99        CommandLineOptionTest.verifyOptionValueForSameVM("UseRTMForStackLocks",
100                TestUseRTMForStackLocksOptionOnSupportedConfig.DEFAULT_VALUE,
101                "Default value of option 'UseRTMForStackLocks' should be false",
102                CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS);
103        // verify that default value is false even with +UseRTMLocking
104        CommandLineOptionTest.verifyOptionValueForSameVM("UseRTMForStackLocks",
105                TestUseRTMForStackLocksOptionOnSupportedConfig.DEFAULT_VALUE,
106                "Default value of option 'UseRTMForStackLocks' should be false",
107                CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,
108                "-XX:+UseRTMLocking");
109        // verify that we can turn the option on
110        CommandLineOptionTest.verifyOptionValueForSameVM("UseRTMForStackLocks",
111                        "true", "Value of option 'UseRTMForStackLocks' should "
112                                + "be able to be set as 'true' when both "
113                                + "-XX:+UseRTMForStackLocks and "
114                                + "-XX:+UseRTMLocking flags used",
115                        CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,
116                        "-XX:+UseRTMLocking", "-XX:+UseRTMForStackLocks");
117    }
118
119    public static void main(String args[]) throws Throwable {
120        new TestUseRTMForStackLocksOptionOnSupportedConfig().runTestCases();
121    }
122}
123