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 import jdk.test.lib.Platform;
25 import jdk.test.lib.cli.CommandLineOptionTest;
26 import compiler.testlibrary.sha.predicate.IntrinsicPredicates;
27
28 import java.util.function.BooleanSupplier;
29
30 /**
31 * Base class for all CLI tests on SHA-related options.
32 *
33 * Instead of using huge complex tests for each option, each test is constructed
34 * from several test cases shared among different tests.
35 */
36 public class SHAOptionsBase extends CommandLineOptionTest {
37 protected static final String USE_SHA_OPTION = "UseSHA";
38 protected static final String USE_SHA1_INTRINSICS_OPTION
39 = "UseSHA1Intrinsics";
40 protected static final String USE_SHA256_INTRINSICS_OPTION
41 = "UseSHA256Intrinsics";
42 protected static final String USE_SHA512_INTRINSICS_OPTION
43 = "UseSHA512Intrinsics";
44
45 // Intrinsics flags are of diagnostic type
46 // and must be preceded by UnlockDiagnosticVMOptions.
47 protected static final String UNLOCK_DIAGNOSTIC_VM_OPTIONS
48 = "-XX:+UnlockDiagnosticVMOptions";
49
50 // Note that strings below will be passed to
51 // CommandLineOptionTest.verifySameJVMStartup and thus are regular
52 // expressions, not just a plain strings.
53 protected static final String SHA_INSTRUCTIONS_ARE_NOT_AVAILABLE
54 = "SHA instructions are not available on this CPU";
55 protected static final String SHA1_INTRINSICS_ARE_NOT_AVAILABLE
56 = "Intrinsics for SHA-1 crypto hash functions not available on this CPU.";
57 protected static final String SHA256_INTRINSICS_ARE_NOT_AVAILABLE
58 = "Intrinsics for SHA-224 and SHA-256 crypto hash functions not available on this CPU.";
59 protected static final String SHA512_INTRINSICS_ARE_NOT_AVAILABLE
60 = "Intrinsics for SHA-384 and SHA-512 crypto hash functions not available on this CPU.";
61
62 private final TestCase[] testCases;
63
64 /**
65 * Returns warning message that should occur in VM output if an option with
66 * the name {@code optionName} was turned on and CPU does not support
67 * required instructions.
68 *
69 * @param optionName The name of the option for which warning message should
70 * be returned.
71 * @return A warning message that will be printed out to VM output if CPU
72 * instructions required by the option are not supported.
73 */
74 protected static String getWarningForUnsupportedCPU(String optionName) {
75 if (Platform.isSparc() || Platform.isAArch64() ||
76 Platform.isX64() || Platform.isX86()) {
77 switch (optionName) {
78 case SHAOptionsBase.USE_SHA_OPTION:
79 return SHAOptionsBase.SHA_INSTRUCTIONS_ARE_NOT_AVAILABLE;
80 case SHAOptionsBase.USE_SHA1_INTRINSICS_OPTION:
81 return SHAOptionsBase.SHA1_INTRINSICS_ARE_NOT_AVAILABLE;
82 case SHAOptionsBase.USE_SHA256_INTRINSICS_OPTION:
83 return SHAOptionsBase.SHA256_INTRINSICS_ARE_NOT_AVAILABLE;
84 case SHAOptionsBase.USE_SHA512_INTRINSICS_OPTION:
85 return SHAOptionsBase.SHA512_INTRINSICS_ARE_NOT_AVAILABLE;
86 default:
87 throw new Error("Unexpected option " + optionName);
88 }
89 } else {
90 throw new Error("Support for CPUs different fromn X86, SPARC, and AARCH64 "
91 + "is not implemented");
92 }
93 }
94
95 /**
96 * Returns the predicate indicating whether or not CPU instructions required
97 * by the option with name {@code optionName} are available.
98 *
99 * @param optionName The name of the option for which a predicate should be
100 * returned.
101 * @return The predicate on availability of CPU instructions required by the
102 * option.
103 */
104 protected static BooleanSupplier getPredicateForOption(String optionName) {
105 switch (optionName) {
106 case SHAOptionsBase.USE_SHA_OPTION:
107 return IntrinsicPredicates.ANY_SHA_INSTRUCTION_AVAILABLE;
108 case SHAOptionsBase.USE_SHA1_INTRINSICS_OPTION:
109 return IntrinsicPredicates.SHA1_INSTRUCTION_AVAILABLE;
110 case SHAOptionsBase.USE_SHA256_INTRINSICS_OPTION:
111 return IntrinsicPredicates.SHA256_INSTRUCTION_AVAILABLE;
112 case SHAOptionsBase.USE_SHA512_INTRINSICS_OPTION:
113 return IntrinsicPredicates.SHA512_INSTRUCTION_AVAILABLE;
114 default:
115 throw new Error("Unexpected option " + optionName);
116 }
117 }
118
119 public SHAOptionsBase(TestCase... testCases) {
120 super(Boolean.TRUE::booleanValue);
121 this.testCases = testCases;
122 }
123
124 @Override
125 protected void runTestCases() throws Throwable {
126 for (TestCase testCase : testCases) {
127 testCase.test();
128 }
129 }
130
131 public static abstract class TestCase {
132 protected final String optionName;
133 private final BooleanSupplier predicate;
134
135 protected TestCase(String optionName, BooleanSupplier predicate) {
136 this.optionName = optionName;
137 this.predicate = predicate;
138 }
139
140 protected final void test() throws Throwable {
141 String testCaseName = this.getClass().getName();
142 if (!predicate.getAsBoolean()) {
143 System.out.println("Skipping " + testCaseName
144 + " due to predicate failure.");
145 return;
146 } else {
147 System.out.println("Running " + testCaseName);
148 }
149
150 verifyWarnings();
151 verifyOptionValues();
152 }
153
154 protected void verifyWarnings() throws Throwable {
155 }
156
157 protected void verifyOptionValues() throws Throwable {
158 }
159 }
160 }