1 /*
   2  * Copyright (c) 2014, 2020, 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 CPUs or OSs without
  28  *          rtm support and/or on VMs without rtm locking support.
  29  * @library /test/lib /
  30  * @modules java.base/jdk.internal.misc
  31  *          java.management
  32  * @requires !vm.rtm.cpu & vm.rtm.compiler
  33  * @requires vm.flagless
  34  * @run driver compiler.rtm.cli.TestUseRTMForStackLocksOptionOnUnsupportedConfig
  35  */
  36 
  37 package compiler.rtm.cli;
  38 
  39 import jdk.test.lib.process.ExitCode;
  40 import jdk.test.lib.cli.CommandLineOptionTest;
  41 
  42 public class TestUseRTMForStackLocksOptionOnUnsupportedConfig
  43         extends RTMGenericCommandLineOptionTest {
  44     private static final String DEFAULT_VALUE = "false";
  45 
  46     private TestUseRTMForStackLocksOptionOnUnsupportedConfig() {
  47         super("UseRTMForStackLocks", true, true,
  48                 TestUseRTMForStackLocksOptionOnUnsupportedConfig.DEFAULT_VALUE,
  49                 "true");
  50     }
  51 
  52     @Override
  53     protected void runX86SupportedVMTestCases() throws Throwable {
  54         String shouldFailMessage = String.format("VM option '%s' is "
  55                 + "experimental%nJVM startup should fail without "
  56                 + "-XX:+UnlockExperimentalVMOptions flag", optionName);
  57 
  58         // verify that option is experimental
  59         CommandLineOptionTest.verifySameJVMStartup(
  60                 new String[] { experimentalOptionError }, null,
  61                 shouldFailMessage, shouldFailMessage + "%nError message "
  62                         + "should be shown", ExitCode.FAIL,
  63                 prepareOptionValue("true"));
  64 
  65         CommandLineOptionTest.verifySameJVMStartup(
  66                 new String[]{ experimentalOptionError }, null,
  67                 shouldFailMessage, shouldFailMessage + "%nError message "
  68                         + "should be shown", ExitCode.FAIL,
  69                 prepareOptionValue("false"));
  70 
  71         String shouldPassMessage = String.format("VM option '%s' is "
  72                 + " experimental%nJVM startup should pass with "
  73                 + "-XX:+UnlockExperimentalVMOptions flag", optionName);
  74         // verify that if we turn it on, then VM output will contain
  75         // warning saying that this option could be turned on only
  76         // when we use rtm locking
  77         CommandLineOptionTest.verifySameJVMStartup(
  78                 new String[]{
  79                     RTMGenericCommandLineOptionTest.RTM_FOR_STACK_LOCKS_WARNING
  80                 }, null, shouldPassMessage, "There should be warning when try "
  81                     + "to use rtm for stack lock, but not using rtm locking",
  82                 ExitCode.OK,
  83                 CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,
  84                 prepareOptionValue("true")
  85         );
  86         // verify that options is turned off by default
  87         CommandLineOptionTest.verifyOptionValueForSameVM(optionName,
  88                 TestUseRTMForStackLocksOptionOnUnsupportedConfig.DEFAULT_VALUE,
  89                 String.format("Default value of option '%s' should be '%s'",
  90                         optionName, DEFAULT_VALUE),
  91                 CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS);
  92         // verify that it could not be turned on without rtm locking
  93         CommandLineOptionTest.verifyOptionValueForSameVM(optionName,
  94                 TestUseRTMForStackLocksOptionOnUnsupportedConfig.DEFAULT_VALUE,
  95                 String.format("Value of '%s' shouldn't able to be set to "
  96                         + "'true' without setting -XX:+UseRTMLocking flag",
  97                         optionName),
  98                 CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS,
  99                 prepareOptionValue("true"));
 100     }
 101 
 102     public static void main(String args[]) throws Throwable {
 103         new TestUseRTMForStackLocksOptionOnUnsupportedConfig().runTestCases();
 104     }
 105 }