1 /*
   2  * Copyright (c) 2014, 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 intrinsics.Verifier;
  25 import sun.hotspot.WhiteBox;
  26 
  27 import java.io.FileOutputStream;
  28 import java.io.IOException;
  29 import java.util.Objects;
  30 import java.util.Properties;
  31 import java.util.function.BooleanSupplier;
  32 
  33 /**
  34  * Base class for sanity tests on SHA intrinsics support.
  35  */
  36 public class SHASanityTestBase {
  37     protected static final String SHA1_INTRINSIC_ID
  38             = "_sha_implCompress";
  39     protected static final String SHA256_INTRINSIC_ID
  40             = "_sha2_implCompress";
  41     protected static final String SHA512_INTRINSIC_ID
  42             = "_sha5_implCompress";
  43     protected static final String MB_INTRINSIC_ID
  44             = "_digestBase_implCompressMB";
  45 
  46     private static final WhiteBox WHITE_BOX = WhiteBox.getWhiteBox();
  47     private static final int MSG_SIZE = 1024;
  48     private static final int OFFSET = 0;
  49     private static final int ITERATIONS = 10000;
  50     private static final int WARMUP_ITERATIONS = 1;
  51     private static final String PROVIDER = "SUN";
  52 
  53     private final BooleanSupplier predicate;
  54     private final String intrinsicID;
  55 
  56     /**
  57      * Construct the new test on intrinsic with ID {@code intrinsicID},
  58      * which is expected to be emitted if {@code predicate} is evaluated to
  59      * {@code true}.
  60      *
  61      * @param predicate The predicate indicating if the intrinsic is expected to
  62      *                  be used.
  63      * @param intrinsicID The ID of the intrinsic to be tested.
  64      */
  65     protected SHASanityTestBase(BooleanSupplier predicate, String intrinsicID) {
  66         this.predicate = predicate;
  67         this.intrinsicID = intrinsicID;
  68     }
  69 
  70     /**
  71      * Run the test and dump properties to file.
  72      *
  73      * @throws Exception when something went wrong.
  74      */
  75     public final void test() throws Exception {
  76         String algorithm = Objects.requireNonNull(
  77                 System.getProperty("algorithm"),
  78                 "Algorithm name should be specified.");
  79 
  80         dumpProperties();
  81 
  82         TestSHA.testSHA(SHASanityTestBase.PROVIDER, algorithm,
  83                 SHASanityTestBase.MSG_SIZE, SHASanityTestBase.OFFSET,
  84                 SHASanityTestBase.ITERATIONS,
  85                 SHASanityTestBase.WARMUP_ITERATIONS);
  86     }
  87 
  88     /**
  89      * Dump properties containing information about the tested intrinsic name
  90      * and whether or not is should be used to the file
  91      * <LogFile value>.verify.properties.
  92      *
  93      * @throws IOException when something went wrong during dumping to file.
  94      */
  95     private void dumpProperties() throws IOException {
  96         Properties properties = new Properties();
  97         properties.setProperty(Verifier.INTRINSIC_NAME_PROPERTY, intrinsicID);
  98         properties.setProperty(Verifier.INTRINSIC_IS_EXPECTED_PROPERTY,
  99                 String.valueOf(predicate.getAsBoolean()));
 100 
 101         String logFileName
 102                 = SHASanityTestBase.WHITE_BOX.getStringVMFlag("LogFile");
 103         FileOutputStream fileOutputStream = new FileOutputStream(logFileName
 104                 + Verifier.PROPERTY_FILE_SUFFIX);
 105 
 106         properties.store(fileOutputStream, null);
 107         fileOutputStream.close();
 108     }
 109 }