1 /*
   2  * Copyright (c) 2014, 2018, 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.testlibrary.sha.predicate;
  25 
  26 import jdk.test.lib.Platform;
  27 import jdk.test.lib.cli.predicate.AndPredicate;
  28 import jdk.test.lib.cli.predicate.CPUSpecificPredicate;
  29 import jdk.test.lib.cli.predicate.OrPredicate;
  30 import sun.hotspot.WhiteBox;
  31 
  32 import java.lang.reflect.Method;
  33 import java.util.function.BooleanSupplier;
  34 
  35 /**
  36  * Helper class aimed to provide predicates on availability of SHA-related
  37  * CPU instructions and intrinsics.
  38  */
  39 public class IntrinsicPredicates {
  40     private static final WhiteBox WHITE_BOX = WhiteBox.getWhiteBox();
  41     private static final long TIERED_MAX_LEVEL = 4L;
  42     /**
  43      * Boolean supplier that check if any method could be compiled by C2.
  44      * Method potentially could be compiled by C2 if Server VM is used and
  45      * either tiered compilation is disabled or TIERED_MAX_LEVEL tier is
  46      * reachable.
  47      *
  48      * Please don't place this definition after SHA*_INTRINSICS_AVAILABLE
  49      * definitions. Otherwise its value will be {@code null} at the time when
  50      * all dependent fields will be initialized.
  51      */
  52     private static final BooleanSupplier COMPILABLE_BY_C2 = () -> {
  53         boolean isTiered = IntrinsicPredicates.WHITE_BOX.getBooleanVMFlag(
  54                 "TieredCompilation");
  55         long tieredMaxLevel = IntrinsicPredicates.WHITE_BOX.getIntxVMFlag(
  56                 "TieredStopAtLevel");
  57         boolean maxLevelIsReachable = (tieredMaxLevel
  58                 == IntrinsicPredicates.TIERED_MAX_LEVEL);
  59         return Platform.isServer() && !Platform.isEmulatedClient() && (!isTiered || maxLevelIsReachable);
  60     };
  61 
  62     public static final BooleanSupplier SHA1_INSTRUCTION_AVAILABLE
  63             = new OrPredicate(new CPUSpecificPredicate("aarch64.*", new String[] { "sha1" }, null),
  64               new OrPredicate(new CPUSpecificPredicate("s390.*",    new String[] { "sha1" }, null),
  65               new OrPredicate(new CPUSpecificPredicate("sparc.*",   new String[] { "sha1" }, null),
  66               // x86 variants
  67               new OrPredicate(new CPUSpecificPredicate("amd64.*",   new String[] { "sha" },  null),
  68               new OrPredicate(new CPUSpecificPredicate("i386.*",    new String[] { "sha" },  null),
  69                               new CPUSpecificPredicate("x86.*",     new String[] { "sha" },  null))))));
  70 
  71     public static final BooleanSupplier SHA256_INSTRUCTION_AVAILABLE
  72             = new OrPredicate(new CPUSpecificPredicate("aarch64.*", new String[] { "sha256"       }, null),
  73               new OrPredicate(new CPUSpecificPredicate("s390.*",    new String[] { "sha256"       }, null),
  74               new OrPredicate(new CPUSpecificPredicate("sparc.*",   new String[] { "sha256"       }, null),
  75               new OrPredicate(new CPUSpecificPredicate("ppc64.*",   new String[] { "sha"          }, null),
  76               new OrPredicate(new CPUSpecificPredicate("ppc64le.*", new String[] { "sha"          }, null),
  77               // x86 variants
  78               new OrPredicate(new CPUSpecificPredicate("amd64.*",   new String[] { "sha"          }, null),
  79               new OrPredicate(new CPUSpecificPredicate("i386.*",    new String[] { "sha"          }, null),
  80               new OrPredicate(new CPUSpecificPredicate("x86.*",     new String[] { "sha"          }, null),
  81               new OrPredicate(new CPUSpecificPredicate("amd64.*",   new String[] { "avx2", "bmi2" }, null),
  82                               new CPUSpecificPredicate("x86_64",    new String[] { "avx2", "bmi2" }, null))))))))));
  83 
  84     public static final BooleanSupplier SHA512_INSTRUCTION_AVAILABLE
  85             = new OrPredicate(new CPUSpecificPredicate("aarch64.*", new String[] { "sha512"       }, null),
  86               new OrPredicate(new CPUSpecificPredicate("s390.*",    new String[] { "sha512"       }, null),
  87               new OrPredicate(new CPUSpecificPredicate("sparc.*",   new String[] { "sha512"       }, null),
  88               new OrPredicate(new CPUSpecificPredicate("ppc64.*",   new String[] { "sha"          }, null),
  89               new OrPredicate(new CPUSpecificPredicate("ppc64le.*", new String[] { "sha"          }, null),
  90               // x86 variants
  91               new OrPredicate(new CPUSpecificPredicate("amd64.*",   new String[] { "sha"          }, null),
  92               new OrPredicate(new CPUSpecificPredicate("i386.*",    new String[] { "sha"          }, null),
  93               new OrPredicate(new CPUSpecificPredicate("x86.*",     new String[] { "sha"          }, null),
  94               new OrPredicate(new CPUSpecificPredicate("amd64.*",   new String[] { "avx2", "bmi2" }, null),
  95                               new CPUSpecificPredicate("x86_64",    new String[] { "avx2", "bmi2" }, null))))))))));
  96 
  97     public static final BooleanSupplier AARCH32_NEON_AVAILABLE
  98             =                 new CPUSpecificPredicate("arm.*",     new String[] { "neon" },         null);
  99 
 100     public static final BooleanSupplier ANY_SHA_INSTRUCTION_AVAILABLE
 101             = new OrPredicate(IntrinsicPredicates.SHA1_INSTRUCTION_AVAILABLE,
 102                     new OrPredicate(
 103                             IntrinsicPredicates.SHA256_INSTRUCTION_AVAILABLE,
 104                             IntrinsicPredicates.SHA512_INSTRUCTION_AVAILABLE));
 105 
 106     public static final BooleanSupplier SHA1_INTRINSICS_AVAILABLE
 107             = new AndPredicate(IntrinsicPredicates.COMPILABLE_BY_C2,
 108                                IntrinsicPredicates.isIntrinsicAvailable("sun.security.provider.SHA", "implCompress0"));
 109 
 110     public static final BooleanSupplier SHA256_INTRINSICS_AVAILABLE
 111             = new AndPredicate(IntrinsicPredicates.COMPILABLE_BY_C2,
 112                                IntrinsicPredicates.isIntrinsicAvailable("sun.security.provider.SHA2", "implCompress0"));
 113 
 114     public static final BooleanSupplier SHA512_INTRINSICS_AVAILABLE
 115             = new AndPredicate(IntrinsicPredicates.COMPILABLE_BY_C2,
 116                                IntrinsicPredicates.isIntrinsicAvailable("sun.security.provider.SHA5", "implCompress0"));
 117 
 118     private static BooleanSupplier isIntrinsicAvailable(String klass, String method) {
 119         try {
 120             Method m = Class.forName(klass).getDeclaredMethod(method, byte[].class, int.class);
 121             return () -> WHITE_BOX.isIntrinsicAvailable(m, (int)IntrinsicPredicates.TIERED_MAX_LEVEL);
 122         } catch (Exception e) {
 123             throw new RuntimeException("Intrinsified method " +  klass + "::" + method + " not found!");
 124         }
 125     };
 126 }