1 /*
  2  * Copyright (c) 2014, 2021, 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 UseRTMLocking option processing on CPUs without
 28  *          rtm support.
 29  * @library /test/lib /
 30  * @modules java.base/jdk.internal.misc
 31  *          java.management
 32  * @requires vm.flagless
 33  * @requires !vm.rtm.cpu & vm.rtm.compiler
 34  * @run driver compiler.rtm.cli.TestUseRTMLockingOptionOnUnsupportedCPU
 35  */
 36 
 37 package compiler.rtm.cli;
 38 
 39 import jdk.test.lib.process.ExitCode;
 40 import jdk.test.lib.Platform;
 41 import jdk.test.lib.cli.CommandLineOptionTest;
 42 
 43 public class TestUseRTMLockingOptionOnUnsupportedCPU {
 44     private static final String DEFAULT_VALUE = "false";
 45 
 46     public void runTestCases() throws Throwable {
 47         String unrecognizedOption
 48                 = CommandLineOptionTest.getUnrecognizedOptionErrorMessage(
 49                 "UseRTMLocking");
 50         String errorMessage = RTMGenericCommandLineOptionTest.RTM_INSTR_ERROR;
 51 
 52         if (Platform.isX86() || Platform.isX64() || Platform.isPPC()) {
 53             String shouldFailMessage = "JVM startup should fail with option " +
 54                                        "-XX:+UseRTMLocking on unsupported CPU";
 55 
 56             try {
 57                 // verify that we get an error when use +UseRTMLocking
 58                 // on unsupported CPU
 59                 CommandLineOptionTest.verifySameJVMStartup(
 60                         new String[] { errorMessage },
 61                         new String[] { unrecognizedOption }, shouldFailMessage,
 62                         shouldFailMessage + ". Error message should be shown.",
 63                         ExitCode.FAIL, "-XX:+UseRTMLocking");
 64             } catch (Throwable e) {
 65                 // verify that we get an error when use +UseRTMLocking
 66                 // on unsupported OS. It might be the case that although CPU
 67                 // supports RTM the OS version does not support RTM
 68                 if (Platform.isPPC()) {
 69                     String errorMessage2 = RTMGenericCommandLineOptionTest.RTM_OS_ERROR;
 70                     String shouldFailMessage2 = "JVM startup should fail with option " +
 71                                                 "-XX:+UseRTMLocking on unsupported CPU or " +
 72                                                 "OS version";
 73 
 74                     CommandLineOptionTest.verifySameJVMStartup(
 75                             new String[] { errorMessage2 },
 76                             new String[] { unrecognizedOption}, shouldFailMessage2,
 77                             shouldFailMessage2 + ". Error message should be shown.",
 78                             ExitCode.FAIL, "-XX:+UseRTMLocking");
 79                 } else {
 80                     throw e; // checking unsupported OS error is not necessary
 81                 }
 82             }
 83 
 84             String shouldPassMessage = "JVM startup should pass with option "
 85                     + "-XX:-UseRTMLocking even on unsupported CPU";
 86             // verify that we can pass -UseRTMLocking without
 87             // getting any error messages
 88             CommandLineOptionTest.verifySameJVMStartup(null, new String[] {
 89                     errorMessage, unrecognizedOption }, shouldPassMessage,
 90                     shouldPassMessage + " without any warnings", ExitCode.OK,
 91                     "-XX:-UseRTMLocking");
 92 
 93             // verify that UseRTMLocking is false by default
 94             CommandLineOptionTest.verifyOptionValueForSameVM("UseRTMLocking",
 95                     TestUseRTMLockingOptionOnUnsupportedCPU.DEFAULT_VALUE,
 96                     String.format("Default value of option 'UseRTMLocking' "
 97                         +"should be '%s'", DEFAULT_VALUE));
 98         } else {
 99             String shouldFailMessage = "RTMLocking should be unrecognized"
100                     + " on non-x86 CPUs. JVM startup should fail."
101                     + "Error message should be shown";
102             // verify that on non-x86 CPUs RTMLocking could not be used
103             CommandLineOptionTest.verifySameJVMStartup(
104                     new String[] { unrecognizedOption },
105                     null, shouldFailMessage, shouldFailMessage,
106                     ExitCode.FAIL, "-XX:+UseRTMLocking");
107 
108             CommandLineOptionTest.verifySameJVMStartup(
109                     new String[] { unrecognizedOption },
110                     null, shouldFailMessage, shouldFailMessage,
111                     ExitCode.FAIL, "-XX:-UseRTMLocking");
112         }
113     }
114 
115     public static void main(String args[]) throws Throwable {
116         new TestUseRTMLockingOptionOnUnsupportedCPU().runTestCases();
117     }
118 }