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