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