This allows VectorUtilProvider tests to be executed although hardware may not fully support vectorization or if C2 is not enabled (#12376)

Author: uschindler

lucene/core/src/java/org/apache/lucene/util/VectorUtil.java

@@ -20,8 +20,7 @@
 /** Utilities for computations with numeric arrays */
 public final class VectorUtil {
 
-  // visible for testing
-  static final VectorUtilProvider PROVIDER = VectorUtilProvider.lookup();
+  private static final VectorUtilProvider PROVIDER = VectorUtilProvider.lookup(false);
 
   private VectorUtil() {}
 

lucene/core/src/java/org/apache/lucene/util/VectorUtilProvider.java

@@ -54,7 +54,7 @@ interface VectorUtilProvider {
   /** The minimal version of Java that has the bugfix for JDK-8301190. */
   static final Version VERSION_JDK8301190_FIXED = Version.parse("20.0.2");
 
-  static VectorUtilProvider lookup() {
+  static VectorUtilProvider lookup(boolean testMode) {
     final int runtimeVersion = Runtime.version().feature();
     if (runtimeVersion >= 20 && runtimeVersion <= 21) {
       // is locale sane (only buggy in Java 20)
@@ -71,7 +71,7 @@ static VectorUtilProvider lookup() {
             "Java vector incubator module is not readable. For optimal vector performance, pass '--add-modules jdk.incubator.vector' to enable Vector API.");
         return new VectorUtilDefaultProvider();
       }
-      if (isClientVM()) {
+      if (!testMode && isClientVM()) {
         LOG.warning("C2 compiler is disabled; Java vector incubator API can't be enabled");
         return new VectorUtilDefaultProvider();
       }
@@ -80,9 +80,10 @@ static VectorUtilProvider lookup() {
         // have private access through the lookup:
         final var lookup = MethodHandles.lookup();
         final var cls = lookup.findClass("org.apache.lucene.util.VectorUtilPanamaProvider");
-        final var constr = lookup.findConstructor(cls, MethodType.methodType(void.class));
+        final var constr =
+            lookup.findConstructor(cls, MethodType.methodType(void.class, boolean.class));
         try {
-          return (VectorUtilProvider) constr.invoke();
+          return (VectorUtilProvider) constr.invoke(testMode);
         } catch (UnsupportedOperationException uoe) {
           // not supported because preferred vector size too small or similar
           LOG.warning("Java vector incubator API was not enabled. " + uoe.getMessage());

lucene/core/src/java20/org/apache/lucene/util/VectorUtilPanamaProvider.java

@@ -43,8 +43,7 @@ final class VectorUtilPanamaProvider implements VectorUtilProvider {
    * <p>it could be that it has only AVX1 and integer vectors are fast. it could also be that it has
    * no AVX and integer vectors are extremely slow. don't use integer vectors to avoid landmines.
    */
-  private static final boolean IS_AMD64_WITHOUT_AVX2 =
-      Constants.OS_ARCH.equals("amd64") && INT_SPECIES_PREF_BIT_SIZE < 256;
+  private final boolean hasFastIntegerVectors;
 
   static {
     if (INT_SPECIES_PREF_BIT_SIZE >= 256) {
@@ -67,8 +66,8 @@ private static <T> T doPrivileged(PrivilegedAction<T> action) {
     return AccessController.doPrivileged(action);
   }
 
-  VectorUtilPanamaProvider() {
-    if (INT_SPECIES_PREF_BIT_SIZE < 128) {
+  VectorUtilPanamaProvider(boolean testMode) {
+    if (!testMode && INT_SPECIES_PREF_BIT_SIZE < 128) {
       throw new UnsupportedOperationException(
           "Vector bit size is less than 128: " + INT_SPECIES_PREF_BIT_SIZE);
     }
@@ -83,9 +82,16 @@ private static <T> T doPrivileged(PrivilegedAction<T> action) {
           "We hit initialization failure described in JDK-8309727: " + se);
     }
 
+    // check if the system is x86 and less than 256-bit vectors:
+    var isAMD64withoutAVX2 = Constants.OS_ARCH.equals("amd64") && INT_SPECIES_PREF_BIT_SIZE < 256;
+    this.hasFastIntegerVectors = testMode || false == isAMD64withoutAVX2;
+
     var log = Logger.getLogger(getClass().getName());
     log.info(
-        "Java vector incubator API enabled; uses preferredBitSize=" + INT_SPECIES_PREF_BIT_SIZE);
+        "Java vector incubator API enabled"
+            + (testMode ? " (test mode)" : "")
+            + "; uses preferredBitSize="
+            + INT_SPECIES_PREF_BIT_SIZE);
   }
 
   @Override
@@ -295,7 +301,7 @@ public int dotProduct(byte[] a, byte[] b) {
     int res = 0;
     // only vectorize if we'll at least enter the loop a single time, and we have at least 128-bit
     // vectors (256-bit on intel to dodge performance landmines)
-    if (a.length >= 16 && IS_AMD64_WITHOUT_AVX2 == false) {
+    if (a.length >= 16 && hasFastIntegerVectors) {
       // compute vectorized dot product consistent with VPDPBUSD instruction
       if (INT_SPECIES_PREF_BIT_SIZE >= 256) {
         // optimized 256/512 bit implementation, processes 8/16 bytes at a time
@@ -352,7 +358,7 @@ public float cosine(byte[] a, byte[] b) {
     int norm2 = 0;
     // only vectorize if we'll at least enter the loop a single time, and we have at least 128-bit
     // vectors (256-bit on intel to dodge performance landmines)
-    if (a.length >= 16 && IS_AMD64_WITHOUT_AVX2 == false) {
+    if (a.length >= 16 && hasFastIntegerVectors) {
       if (INT_SPECIES_PREF_BIT_SIZE >= 256) {
         // optimized 256/512 bit implementation, processes 8/16 bytes at a time
         int upperBound = PREF_BYTE_SPECIES.loopBound(a.length);
@@ -442,7 +448,7 @@ public int squareDistance(byte[] a, byte[] b) {
     int res = 0;
     // only vectorize if we'll at least enter the loop a single time, and we have at least 128-bit
     // vectors (256-bit on intel to dodge performance landmines)
-    if (a.length >= 16 && IS_AMD64_WITHOUT_AVX2 == false) {
+    if (a.length >= 16 && hasFastIntegerVectors) {
       if (INT_SPECIES_PREF_BIT_SIZE >= 256) {
         // optimized 256/512 bit implementation, processes 8/16 bytes at a time
         int upperBound = PREF_BYTE_SPECIES.loopBound(a.length);

lucene/core/src/test/org/apache/lucene/util/TestVectorUtilProviders.java

@@ -27,7 +27,7 @@ public class TestVectorUtilProviders extends LuceneTestCase {
 
   private static final double DELTA = 1e-3;
   private static final VectorUtilProvider LUCENE_PROVIDER = new VectorUtilDefaultProvider();
-  private static final VectorUtilProvider JDK_PROVIDER = VectorUtil.PROVIDER;
+  private static final VectorUtilProvider JDK_PROVIDER = VectorUtilProvider.lookup(true);
 
   private static final int[] VECTOR_SIZES = {
     1, 4, 6, 8, 13, 16, 25, 32, 64, 100, 128, 207, 256, 300, 512, 702, 1024