Merge pull request #50591 from zakkak/2025-10-16-deprecate-runtime-reinitialization

Refactorings and deprecations related to obsolete runtime (re)initialization configuration in native-image

Author: geoand

core/deployment/src/main/java/io/quarkus/deployment/NioSocketImplProcessor.java

@@ -5,7 +5,7 @@
 import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
 import io.quarkus.deployment.builditem.SslNativeConfigBuildItem;
-import io.quarkus.deployment.builditem.nativeimage.RuntimeReinitializedClassBuildItem;
+import io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem;
 import io.quarkus.runtime.annotations.ConfigPhase;
 import io.quarkus.runtime.annotations.ConfigRoot;
 import io.smallrye.config.ConfigMapping;
@@ -36,7 +36,7 @@ SslNativeConfigBuildItem setupNativeSsl() {
     }
 
     @BuildStep
-    void runtime(BuildProducer<RuntimeReinitializedClassBuildItem> reinitialized) {
-        reinitialized.produce(new RuntimeReinitializedClassBuildItem(JAVA_11_PLUS_SSL_LOGGER));
+    void runtime(BuildProducer<RuntimeInitializedClassBuildItem> reinitialized) {
+        reinitialized.produce(new RuntimeInitializedClassBuildItem(JAVA_11_PLUS_SSL_LOGGER));
     }
 }

core/deployment/src/main/java/io/quarkus/deployment/SslProcessor.java

@@ -17,26 +17,23 @@
  * during the build process.
  * It collects information such as:
  * <ul>
- * <li>Classes to be initialized at runtime ({@link #runtimeInitializedClasses})</li>
- * <li>Classes to be re-initialized at runtime ({@link #runtimeReinitializedClasses})</li>
- * <li>Resource bundles to include ({@link #resourceBundles})</li>
- * <li>Dynamic proxy definitions ({@link #proxyDefinitions})</li>
- * <li>System properties to be set within the native image ({@link #nativeImageSystemProperties})</li>
+ * <li>Classes to be (re-)initialized at runtime</li>
+ * <li>Resource bundles to include</li>
+ * <li>Dynamic proxy definitions</li>
+ * <li>System properties to be set within the native image</li>
  * </ul>
  * The final native image configuration is assembled by combining all produced instances of this build item.
  * Use the {@link #builder()} method to construct instances.
  */
 public final class NativeImageConfigBuildItem extends MultiBuildItem {
 
     private final Set<String> runtimeInitializedClasses;
-    private final Set<String> runtimeReinitializedClasses;
     private final Set<String> resourceBundles;
     private final Set<List<String>> proxyDefinitions;
     private final Map<String, String> nativeImageSystemProperties;
 
     public NativeImageConfigBuildItem(Builder builder) {
         this.runtimeInitializedClasses = Collections.unmodifiableSet(builder.runtimeInitializedClasses);
-        this.runtimeReinitializedClasses = Collections.unmodifiableSet(builder.runtimeReinitializedClasses);
         this.resourceBundles = Collections.unmodifiableSet(builder.resourceBundles);
         this.proxyDefinitions = Collections.unmodifiableSet(builder.proxyDefinitions);
         this.nativeImageSystemProperties = Collections.unmodifiableMap(builder.nativeImageSystemProperties);
@@ -46,8 +43,13 @@ public Iterable<String> getRuntimeInitializedClasses() {
         return runtimeInitializedClasses;
     }
 
+    /**
+     * @deprecated Starting with Mandrel/GraalVM 23.1 for JDK 21 this is functionally the same with
+     *             {@link #getRuntimeInitializedClasses()}.
+     */
+    @Deprecated(since = "3.30", forRemoval = true)
     public Iterable<String> getRuntimeReinitializedClasses() {
-        return runtimeReinitializedClasses;
+        return getRuntimeInitializedClasses();
     }
 
     public Iterable<String> getResourceBundles() {
@@ -69,7 +71,6 @@ public static Builder builder() {
     public static class Builder {
 
         final Set<String> runtimeInitializedClasses = new HashSet<>();
-        final Set<String> runtimeReinitializedClasses = new HashSet<>();
         final Set<String> resourceBundles = new HashSet<>();
         final Set<List<String>> proxyDefinitions = new HashSet<>();
         final Map<String, String> nativeImageSystemProperties = new HashMap<>();
@@ -79,9 +80,13 @@ public Builder addRuntimeInitializedClass(String className) {
             return this;
         }
 
+        /**
+         * @deprecated Starting with Mandrel/GraalVM 23.1 for JDK 21 this is functionally the same with
+         *             {@link Builder#addRuntimeInitializedClass(String)}.
+         */
+        @Deprecated(since = "3.30", forRemoval = true)
         public Builder addRuntimeReinitializedClass(String className) {
-            runtimeReinitializedClasses.add(className);
-            return this;
+            return addRuntimeInitializedClass(className);
         }
 
         public Builder addResourceBundle(String className) {

core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/NativeImageConfigBuildItem.java

@@ -9,7 +9,7 @@
  * @deprecated Starting with Mandrel/GraalVM 23.1 for JDK 21 this is functionally the same with
  *             {@link RuntimeInitializedClassBuildItem}.
  */
-@Deprecated(since = "3.18")
+@Deprecated(since = "3.18", forRemoval = true)
 public final class RuntimeReinitializedClassBuildItem extends MultiBuildItem {
 
     private final String className;

core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/RuntimeReinitializedClassBuildItem.java

@@ -91,7 +91,7 @@
 import io.quarkus.deployment.builditem.SystemPropertyBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.NativeImageSystemPropertyBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
-import io.quarkus.deployment.builditem.nativeimage.RuntimeReinitializedClassBuildItem;
+import io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ServiceProviderBuildItem;
 import io.quarkus.deployment.console.ConsoleInstalledBuildItem;
 import io.quarkus.deployment.console.QuarkusCommand;
@@ -232,12 +232,12 @@ void setUpDefaultLogCleanupFilters(List<LogCleanupFilterBuildItem> logCleanupFil
 
     @BuildStep
     void miscSetup(
-            Consumer<RuntimeReinitializedClassBuildItem> runtimeInit,
+            Consumer<RuntimeInitializedClassBuildItem> runtimeInit,
             Consumer<NativeImageSystemPropertyBuildItem> systemProp,
             Consumer<ServiceProviderBuildItem> provider) {
-        runtimeInit.accept(new RuntimeReinitializedClassBuildItem(ConsoleHandler.class.getName()));
-        runtimeInit.accept(new RuntimeReinitializedClassBuildItem("io.smallrye.common.ref.References$ReaperThread"));
-        runtimeInit.accept(new RuntimeReinitializedClassBuildItem("io.smallrye.common.os.Process"));
+        runtimeInit.accept(new RuntimeInitializedClassBuildItem(ConsoleHandler.class.getName()));
+        runtimeInit.accept(new RuntimeInitializedClassBuildItem("io.smallrye.common.ref.References$ReaperThread"));
+        runtimeInit.accept(new RuntimeInitializedClassBuildItem("io.smallrye.common.os.Process"));
         systemProp
                 .accept(new NativeImageSystemPropertyBuildItem("java.util.logging.manager", "org.jboss.logmanager.LogManager"));
         provider.accept(

core/deployment/src/main/java/io/quarkus/deployment/logging/LoggingResourceProcessor.java

@@ -22,7 +22,6 @@
 import io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBundleBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.NativeImageSystemPropertyBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem;
-import io.quarkus.deployment.builditem.nativeimage.RuntimeReinitializedClassBuildItem;
 import io.quarkus.deployment.pkg.NativeConfig;
 import io.quarkus.deployment.pkg.steps.NativeOrNativeSourcesBuild;
 import io.quarkus.runtime.ssl.SslContextConfigurationRecorder;
@@ -45,17 +44,13 @@ void build(NativeConfig nativeConfig,
             BuildProducer<NativeImageProxyDefinitionBuildItem> proxy,
             BuildProducer<NativeImageResourceBundleBuildItem> resourceBundle,
             BuildProducer<RuntimeInitializedClassBuildItem> runtimeInit,
-            BuildProducer<RuntimeReinitializedClassBuildItem> runtimeReinit,
             BuildProducer<NativeImageSystemPropertyBuildItem> nativeImage,
             BuildProducer<SystemPropertyBuildItem> systemProperty,
             BuildProducer<JavaLibraryPathAdditionalPathBuildItem> javaLibraryPathAdditionalPath) {
         for (NativeImageConfigBuildItem nativeImageConfigBuildItem : nativeImageConfigBuildItems) {
             for (String i : nativeImageConfigBuildItem.getRuntimeInitializedClasses()) {
                 runtimeInit.produce(new RuntimeInitializedClassBuildItem(i));
             }
-            for (String i : nativeImageConfigBuildItem.getRuntimeReinitializedClasses()) {
-                runtimeReinit.produce(new RuntimeReinitializedClassBuildItem(i));
-            }
             for (Map.Entry<String, String> e : nativeImageConfigBuildItem.getNativeImageSystemProperties().entrySet()) {
                 nativeImage.produce(new NativeImageSystemPropertyBuildItem(e.getKey(), e.getValue()));
             }
@@ -98,13 +93,13 @@ void build(NativeConfig nativeConfig,
     }
 
     @BuildStep(onlyIf = NativeOrNativeSourcesBuild.class)
-    void reinitHostNameUtil(BuildProducer<RuntimeReinitializedClassBuildItem> runtimeReInitClass) {
+    void reinitHostNameUtil(BuildProducer<RuntimeInitializedClassBuildItem> runtimeReInitClass) {
         // certain libraries like JBoss logging internally use this class to determine the hostname
         // of the system. This HostName class computes and stores the hostname as a static field in a class,
         // so we reinitialize this to re-compute the field (and other related fields) during native application's
         // runtime
-        runtimeReInitClass.produce(new RuntimeReinitializedClassBuildItem("org.wildfly.common.net.HostName"));
-        runtimeReInitClass.produce(new RuntimeReinitializedClassBuildItem("io.smallrye.common.net.HostName"));
+        runtimeReInitClass.produce(new RuntimeInitializedClassBuildItem("org.wildfly.common.net.HostName"));
+        runtimeReInitClass.produce(new RuntimeInitializedClassBuildItem("io.smallrye.common.net.HostName"));
     }
 
     private Boolean isSslNativeEnabled(SslNativeConfigBuildItem sslNativeConfig,

core/deployment/src/main/java/io/quarkus/deployment/steps/NativeImageConfigBuildStep.java

@@ -112,7 +112,7 @@ public void write(String s, byte[] bytes) {
             }
         }
 
-        if (!runtimeInitializedClassBuildItems.isEmpty()) {
+        if (!runtimeInitializedClassBuildItems.isEmpty() || !runtimeReinitializedClassBuildItems.isEmpty()) {
             //  Class[] runtimeInitializedClasses()
             MethodCreator runtimeInitializedClasses = file
                     .getMethodCreator("runtimeInitializedClasses", Class[].class)
@@ -123,7 +123,8 @@ public void write(String s, byte[] bytes) {
                     ofMethod(Class.class, "getClassLoader", ClassLoader.class),
                     thisClass);
             ResultHandle classesArray = runtimeInitializedClasses.newArray(Class.class,
-                    runtimeInitializedClasses.load(runtimeInitializedClassBuildItems.size()));
+                    runtimeInitializedClasses
+                            .load(runtimeInitializedClassBuildItems.size() + runtimeReinitializedClassBuildItems.size()));
             for (int i = 0; i < runtimeInitializedClassBuildItems.size(); i++) {
                 TryBlock tc = runtimeInitializedClasses.tryBlock();
                 ResultHandle clazz = tc.invokeStaticMethod(
@@ -133,6 +134,15 @@ public void write(String s, byte[] bytes) {
                 CatchBlockCreator cc = tc.addCatch(Throwable.class);
                 cc.invokeVirtualMethod(ofMethod(Throwable.class, "printStackTrace", void.class), cc.getCaughtException());
             }
+            for (int i = 0; i < runtimeReinitializedClassBuildItems.size(); i++) {
+                TryBlock tc = runtimeInitializedClasses.tryBlock();
+                ResultHandle clazz = tc.invokeStaticMethod(
+                        ofMethod(Class.class, "forName", Class.class, String.class, boolean.class, ClassLoader.class),
+                        tc.load(runtimeReinitializedClassBuildItems.get(i).getClassName()), tc.load(false), cl);
+                tc.writeArrayValue(classesArray, i, clazz);
+                CatchBlockCreator cc = tc.addCatch(Throwable.class);
+                cc.invokeVirtualMethod(ofMethod(Throwable.class, "printStackTrace", void.class), cc.getCaughtException());
+            }
             runtimeInitializedClasses.returnValue(classesArray);
 
             ResultHandle classes = overallCatch.invokeStaticMethod(runtimeInitializedClasses.getMethodDescriptor());
@@ -160,33 +170,6 @@ public void write(String s, byte[] bytes) {
             overallCatch.invokeStaticMethod(INITIALIZE_PACKAGES_AT_RUN_TIME, packages);
         }
 
-        // hack in reinitialization of process info classes
-        if (!runtimeReinitializedClassBuildItems.isEmpty()) {
-            MethodCreator runtimeReinitializedClasses = file
-                    .getMethodCreator("runtimeReinitializedClasses", Class[].class)
-                    .setModifiers(Modifier.PRIVATE | Modifier.STATIC);
-
-            ResultHandle thisClass = runtimeReinitializedClasses.loadClassFromTCCL(GRAAL_FEATURE);
-            ResultHandle cl = runtimeReinitializedClasses.invokeVirtualMethod(
-                    ofMethod(Class.class, "getClassLoader", ClassLoader.class),
-                    thisClass);
-            ResultHandle classesArray = runtimeReinitializedClasses.newArray(Class.class,
-                    runtimeReinitializedClasses.load(runtimeReinitializedClassBuildItems.size()));
-            for (int i = 0; i < runtimeReinitializedClassBuildItems.size(); i++) {
-                TryBlock tc = runtimeReinitializedClasses.tryBlock();
-                ResultHandle clazz = tc.invokeStaticMethod(
-                        ofMethod(Class.class, "forName", Class.class, String.class, boolean.class, ClassLoader.class),
-                        tc.load(runtimeReinitializedClassBuildItems.get(i).getClassName()), tc.load(false), cl);
-                tc.writeArrayValue(classesArray, i, clazz);
-                CatchBlockCreator cc = tc.addCatch(Throwable.class);
-                cc.invokeVirtualMethod(ofMethod(Throwable.class, "printStackTrace", void.class), cc.getCaughtException());
-            }
-            runtimeReinitializedClasses.returnValue(classesArray);
-
-            ResultHandle classes = overallCatch.invokeStaticMethod(runtimeReinitializedClasses.getMethodDescriptor());
-            overallCatch.invokeStaticMethod(INITIALIZE_CLASSES_AT_RUN_TIME, classes);
-        }
-
         // Ensure registration of fields being accessed through unsafe is done last to ensure that the class
         // initialization configuration is done first.  Registering the fields before configuring class initialization
         // may results in classes being marked for runtime initialization even if not explicitly requested.

core/deployment/src/main/java/io/quarkus/deployment/steps/NativeImageFeatureStep.java

@@ -8,7 +8,7 @@
 import io.quarkus.deployment.builditem.FeatureBuildItem;
 import io.quarkus.deployment.builditem.IndexDependencyBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBuildItem;
-import io.quarkus.deployment.builditem.nativeimage.RuntimeReinitializedClassBuildItem;
+import io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ServiceProviderBuildItem;
 
 public class FlywayAlwaysEnabledProcessor {
@@ -22,8 +22,8 @@ void build(BuildProducer<FeatureBuildItem> featureProducer) {
      * Reinitialize {@code InsertRowLock} to avoid using a cached seed when invoking {@code getNextRandomString}
      */
     @BuildStep
-    public RuntimeReinitializedClassBuildItem reinitInsertRowLock() {
-        return new RuntimeReinitializedClassBuildItem(
+    public RuntimeInitializedClassBuildItem reinitInsertRowLock() {
+        return new RuntimeInitializedClassBuildItem(
                 "org.flywaydb.core.internal.database.InsertRowLock");
     }
 

extensions/flyway/deployment/src/main/java/io/quarkus/flyway/deployment/FlywayAlwaysEnabledProcessor.java

@@ -90,7 +90,7 @@ NativeImageConfigBuildItem nativeImageConfiguration() {
                 .addRuntimeInitializedClass("io.grpc.netty.NettyServerBuilder")
                 .addRuntimeInitializedClass("io.grpc.netty.NettyChannelBuilder")
                 .addRuntimeInitializedClass("io.grpc.internal.RetriableStream")
-                .addRuntimeReinitializedClass("com.google.protobuf.UnsafeUtil");
+                .addRuntimeInitializedClass("com.google.protobuf.UnsafeUtil");
         return builder.build();
     }
 

extensions/grpc-common/deployment/src/main/java/io/quarkus/grpc/common/deployment/GrpcCommonProcessor.java

@@ -96,7 +96,7 @@
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveFieldBuildItem;
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveMethodBuildItem;
-import io.quarkus.deployment.builditem.nativeimage.RuntimeReinitializedClassBuildItem;
+import io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem;
 import io.quarkus.deployment.logging.LogCleanupFilterBuildItem;
 import io.quarkus.deployment.pkg.steps.NativeOrNativeSourcesBuild;
 import io.quarkus.deployment.recording.RecorderContext;
@@ -645,8 +645,8 @@ public void init(BeanContainerBuildItem beanContainerBuildItem, HibernateValidat
     }
 
     @BuildStep
-    public RuntimeReinitializedClassBuildItem reinitClockProviderSystemTimezone() {
-        return new RuntimeReinitializedClassBuildItem(
+    public RuntimeInitializedClassBuildItem reinitClockProviderSystemTimezone() {
+        return new RuntimeInitializedClassBuildItem(
                 "io.quarkus.hibernate.validator.runtime.clockprovider.HibernateValidatorClockProviderSystemZoneIdHolder");
     }