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