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 /**
  26  * @test
  27  * @bug 8031320
  28  * @summary Verify UseRTMForStackLocks option processing on CPU with
  29  *          rtm support when VM supports rtm locking.
  30  * @library /test/lib /
  31  * @modules java.base/jdk.internal.misc
  32  *          java.management
  33  *
  34  * @build sun.hotspot.WhiteBox
  35  * @run driver ClassFileInstaller sun.hotspot.WhiteBox
  36  *                                sun.hotspot.WhiteBox$WhiteBoxPermission
  37  * @run main/othervm -Xbootclasspath/a:. -XX:+UnlockDiagnosticVMOptions
  38  *                   -XX:+WhiteBoxAPI
  39  *                   compiler.rtm.cli.TestUseRTMForStackLocksOptionOnSupportedConfig
  40  */
  41 
  42 package compiler.rtm.cli;
  43 
  44 import compiler.testlibrary.rtm.predicate.SupportedCPU;
  45 import compiler.testlibrary.rtm.predicate.SupportedOS;
  46 import compiler.testlibrary.rtm.predicate.SupportedVM;
  47 import jdk.test.lib.process.ExitCode;
  48 import jdk.test.lib.cli.CommandLineOptionTest;
  49 import jdk.test.lib.cli.predicate.AndPredicate;
  50 
  51 public class TestUseRTMForStackLocksOptionOnSupportedConfig
  52         extends CommandLineOptionTest {
  53     private static final String DEFAULT_VALUE = "false";
  54 
  55     private TestUseRTMForStackLocksOptionOnSupportedConfig() {
  56         super(new AndPredicate(new SupportedCPU(), new SupportedOS(), new SupportedVM()));
  57     }
  58 
  59     @Override
  60     public void runTestCases() throws Throwable {
  61         String errorMessage
  62                 = CommandLineOptionTest.getExperimentalOptionErrorMessage(
  63                 "UseRTMForStackLocks");
  64         String warningMessage
  65                 = RTMGenericCommandLineOptionTest.RTM_FOR_STACK_LOCKS_WARNING;
  66 
  67         String shouldFailMessage = " VM option 'UseRTMForStackLocks' is "
  68                 + "experimental%nJVM startup should fail without "
  69                 + "-XX:+UnlockExperimentalVMOptions flag";
  70 
  71         CommandLineOptionTest.verifySameJVMStartup(
  72                 new String[] { errorMessage }, null, shouldFailMessage,
  73                 shouldFailMessage + "%nError message expected", ExitCode.FAIL,
  74                 "-XX:+UseRTMForStackLocks");
  75         String shouldPassMessage = " VM option 'UseRTMForStackLocks'"
  76                 + " is experimental%nJVM startup should pass with "
  77                 + "-XX:+UnlockExperimentalVMOptions flag";
  78         // verify that we get a warning when trying to use rtm for stack
  79         // lock, but not using rtm locking.
  80         CommandLineOptionTest.verifySameJVMStartup(
  81                 new String[] { warningMessage }, null, shouldPassMessage,
  82                 "There should be warning when trying to use rtm for stack "
  83                         + "lock, but not using rtm locking", ExitCode.OK,
  84                 CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,
  85                 "-XX:+UseRTMForStackLocks",
  86                 "-XX:-UseRTMLocking");
  87         // verify that we don't get a warning when no using rtm for stack
  88         // lock and not 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 we don't get a warning when using rtm for stack
  99         // lock and using rtm locking.
 100         CommandLineOptionTest.verifySameJVMStartup(null,
 101                 new String[] { warningMessage }, shouldPassMessage,
 102                 "There should not be any warning when use both "
 103                         + "-XX:+UseRTMForStackLocks and -XX:+UseRTMLocking"
 104                         + " flags",
 105                 ExitCode.OK,
 106                 CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,
 107                 "-XX:+UseRTMForStackLocks",
 108                 "-XX:+UseRTMLocking");
 109         // verify that default value if false
 110         CommandLineOptionTest.verifyOptionValueForSameVM("UseRTMForStackLocks",
 111                 TestUseRTMForStackLocksOptionOnSupportedConfig.DEFAULT_VALUE,
 112                 "Default value of option 'UseRTMForStackLocks' should be false",
 113                 CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS);
 114         // verify that default value is false even with +UseRTMLocking
 115         CommandLineOptionTest.verifyOptionValueForSameVM("UseRTMForStackLocks",
 116                 TestUseRTMForStackLocksOptionOnSupportedConfig.DEFAULT_VALUE,
 117                 "Default value of option 'UseRTMForStackLocks' should be false",
 118                 CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,
 119                 "-XX:+UseRTMLocking");
 120         // verify that we can turn the option on
 121         CommandLineOptionTest.verifyOptionValueForSameVM("UseRTMForStackLocks",
 122                         "true", "Value of option 'UseRTMForStackLocks' should "
 123                                 + "be able to be set as 'true' when both "
 124                                 + "-XX:+UseRTMForStackLocks and "
 125                                 + "-XX:+UseRTMLocking flags used",
 126                         CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,
 127                         "-XX:+UseRTMLocking", "-XX:+UseRTMForStackLocks");
 128     }
 129 
 130     public static void main(String args[]) throws Throwable {
 131         new TestUseRTMForStackLocksOptionOnSupportedConfig().test();
 132     }
 133 }