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