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 package compiler.rtm.cli;
26
27 import compiler.testlibrary.rtm.predicate.SupportedCPU;
28 import compiler.testlibrary.rtm.predicate.SupportedOS;
29 import compiler.testlibrary.rtm.predicate.SupportedVM;
30 import jdk.test.lib.process.ExitCode;
31 import jdk.test.lib.cli.CommandLineOptionTest;
32 import jdk.test.lib.cli.predicate.AndPredicate;
33
34 import java.util.LinkedList;
35 import java.util.List;
36
37 /**
38 * Base for all RTM-related CLI tests on options whose processing depends
39 * on UseRTMLocking value.
40 *
41 * Since UseRTMLocking option could be used when both CPU and VM supports RTM
42 * locking, this test will be skipped on all unsupported configurations.
43 */
44 public abstract class RTMLockingAwareTest
45 extends RTMGenericCommandLineOptionTest {
46 protected final String warningMessage;
47 protected final String[] correctValues;
48 protected final String[] incorrectValues;
49 /**
50 * Constructs new test for option {@code optionName} that should be executed
51 * only on CPU with RTM support.
52 * Test will be executed using set of correct values from
53 * {@code correctValues} and set of incorrect values from
54 * {@code incorrectValues}.
55 *
56 * @param optionName name of option to be tested
57 * @param isBoolean {@code true} if tested option is binary
58 * @param isExperimental {@code true} if tested option is experimental
59 * @param defaultValue default value of tested option
60 * @param correctValues array with correct values, that should not emit
61 * {@code warningMessage} to VM output
62 * @param incorrectValues array with incorrect values, that should emit
63 * {@code waningMessage} to VM output
64 * @param warningMessage warning message associated with tested option
65 */
66 protected RTMLockingAwareTest(String optionName, boolean isBoolean,
67 boolean isExperimental, String defaultValue,
68 String[] correctValues, String[] incorrectValues,
69 String warningMessage) {
70 super(new AndPredicate(new SupportedCPU(), new SupportedOS(), new SupportedVM()),
71 optionName, isBoolean, isExperimental, defaultValue);
72 this.correctValues = correctValues;
73 this.incorrectValues = incorrectValues;
74 this.warningMessage = warningMessage;
75 }
76
77 @Override
78 protected void verifyJVMStartup() throws Throwable {
79 // Run generic sanity checks
80 super.verifyJVMStartup();
81 // Verify how option values will be processed depending on
82 // UseRTMLocking value.
83 if (correctValues != null) {
84 for (String correctValue : correctValues) {
85 // For correct values it is expected to see no warnings
86 // regardless to UseRTMLocking
87 verifyStartupWarning(correctValue, true, false);
88 verifyStartupWarning(correctValue, false, false);
89 }
90 }
91
92 if (incorrectValues != null) {
93 for (String incorrectValue : incorrectValues) {
94 // For incorrect values it is expected to see warning
95 // only with -XX:+UseRTMLocking
96 verifyStartupWarning(incorrectValue, true, true);
97 verifyStartupWarning(incorrectValue, false, false);
98 }
99 }
100 }
101
102 @Override
103 protected void verifyOptionValues() throws Throwable {
104 super.verifyOptionValues();
105 // Verify how option values will be setup after processing
106 // depending on UseRTMLocking value
107 if (correctValues != null) {
108 for (String correctValue : correctValues) {
109 // Correct value could be set up regardless to UseRTMLocking
110 verifyOptionValues(correctValue, false, correctValue);
111 verifyOptionValues(correctValue, true, correctValue);
112 }
113 }
114
115 if (incorrectValues != null) {
116 for (String incorrectValue : incorrectValues) {
117 // With -XX:+UseRTMLocking, incorrect value will be changed to
118 // default value.
119 verifyOptionValues(incorrectValue, false, incorrectValue);
120 verifyOptionValues(incorrectValue, true, defaultValue);
121 }
122 }
123 }
124
125 private void verifyStartupWarning(String value, boolean useRTMLocking,
126 boolean isWarningExpected) throws Throwable {
127 String warnings[] = new String[] { warningMessage };
128 List<String> options = new LinkedList<>();
129 options.add(CommandLineOptionTest.prepareBooleanFlag("UseRTMLocking",
130 useRTMLocking));
131
132 if (isExperimental) {
133 options.add(CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS);
134 }
135 options.add(prepareOptionValue(value));
136
137 String errorString = String.format("JVM should start with option '%s'"
138 + "'%nWarnings should be shown: %s", optionName,
139 isWarningExpected);
140 CommandLineOptionTest.verifySameJVMStartup(
141 (isWarningExpected ? warnings : null),
142 (isWarningExpected ? null : warnings),
143 errorString, errorString, ExitCode.OK,
144 options.toArray(new String[options.size()]));
145 }
146
147 private void verifyOptionValues(String value, boolean useRTMLocking,
148 String expectedValue) throws Throwable {
149 List<String> options = new LinkedList<>();
150 options.add(CommandLineOptionTest.prepareBooleanFlag("UseRTMLocking",
151 useRTMLocking));
152
153 if (isExperimental) {
154 options.add(CommandLineOptionTest.UNLOCK_EXPERIMENTAL_VM_OPTIONS);
155 }
156 options.add(prepareOptionValue(value));
157
158 CommandLineOptionTest.verifyOptionValueForSameVM(optionName,
159 expectedValue, String.format("Option '%s' should have '%s' "
160 + "value if '%s' flag set",
161 optionName, expectedValue, prepareOptionValue(value)),
162 options.toArray(new String[options.size()]));
163 }
164 }