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