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