Skip to content

Apache Lucene open-source search software

Better detect vector module in non-default setups (e.g., custom module layers) (#12677)

Uwe Schindlerdbda33fb2f3f
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index c865712ac89..7798dc8cfb9 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -168,6 +168,9 @@ Improvements
is too old. It also logs partial vectorization support if old CPU or disabled AVX.
(Uwe Schindler, Robert Muir)
+* GITHUB#12677: Better detect vector module in non-default setups (e.g., custom module layers).
+ (Uwe Schindler)
+
Optimizations
---------------------
* GITHUB#12183: Make TermStates#build concurrent. (Shubham Chaudhary)
diff --git a/lucene/core/src/java/org/apache/lucene/internal/vectorization/VectorizationProvider.java b/lucene/core/src/java/org/apache/lucene/internal/vectorization/VectorizationProvider.java
index ec7941077c9..9f0040f3e28 100644
--- a/lucene/core/src/java/org/apache/lucene/internal/vectorization/VectorizationProvider.java
+++ b/lucene/core/src/java/org/apache/lucene/internal/vectorization/VectorizationProvider.java
@@ -25,6 +25,7 @@ import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.Locale;
import java.util.Objects;
+import java.util.Optional;
import java.util.Set;
import java.util.logging.Logger;
import org.apache.lucene.util.SuppressForbidden;
@@ -82,11 +83,14 @@ public abstract class VectorizationProvider {
}
// is the incubator module present and readable (JVM providers may to exclude them or it is
// build with jlink)
- if (!vectorModulePresentAndReadable()) {
+ final var vectorMod = lookupVectorModule();
+ if (vectorMod.isEmpty()) {
LOG.warning(
"Java vector incubator module is not readable. For optimal vector performance, pass '--add-modules jdk.incubator.vector' to enable Vector API.");
return new DefaultVectorizationProvider();
}
+ vectorMod.ifPresent(VectorizationProvider.class.getModule()::addReads);
+ // check if client VM
if (!testMode && isClientVM()) {
LOG.warning("C2 compiler is disabled; Java vector incubator API can't be enabled");
return new DefaultVectorizationProvider();
@@ -120,7 +124,7 @@ public abstract class VectorizationProvider {
} else if (runtimeVersion >= 22) {
LOG.warning(
"You are running with Java 22 or later. To make full use of the Vector API, please update Apache Lucene.");
- } else if (vectorModulePresentAndReadable()) {
+ } else if (lookupVectorModule().isPresent()) {
LOG.warning(
"Java vector incubator module was enabled by command line flags, but your Java version is too old: "
+ runtimeVersion);
@@ -128,16 +132,13 @@ public abstract class VectorizationProvider {
return new DefaultVectorizationProvider();
}
- private static boolean vectorModulePresentAndReadable() {
- var opt =
- ModuleLayer.boot().modules().stream()
- .filter(m -> m.getName().equals("jdk.incubator.vector"))
- .findFirst();
- if (opt.isPresent()) {
- VectorizationProvider.class.getModule().addReads(opt.get());
- return true;
- }
- return false;
+ /**
+ * Looks up the vector module from Lucene's {@link ModuleLayer} or the root layer (if unnamed).
+ */
+ private static Optional<Module> lookupVectorModule() {
+ return Optional.ofNullable(VectorizationProvider.class.getModule().getLayer())
+ .orElse(ModuleLayer.boot())
+ .findModule("jdk.incubator.vector");
}
/**