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