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