Introduction of new API for metadata registration based on conditions.

Author: Mihailo Markovic

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/hosted/Feature.java

@@ -171,6 +171,14 @@ interface IsInConfigurationAccess extends FeatureAccess {
      */
     @Platforms(Platform.HOSTED_ONLY.class)
     interface AfterRegistrationAccess extends FeatureAccess {
+        /**
+         * Creates access for runtime registration. All registrations should happen in
+         * {@link Feature#afterRegistration}
+         *
+         */
+        ReflectionDynamicAccess getReflectionDynamicAccess();
+
+        ResourceDynamicAccess getResourceDynamicAccess();
     }
 
     /**

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/hosted/ReflectionDynamicAccess.java

@@ -0,0 +1,70 @@
+package org.graalvm.nativeimage.hosted;
+
+import java.lang.reflect.Executable;
+import java.lang.reflect.Field;
+
+/**
+ * This interface is used to register classes, methods, fields for reflection, serialization, and
+ * JNI access at runtime.
+ *
+ * All methods in {@link ReflectionDynamicAccess} require a {@link RegistrationCondition} as their
+ * first parameter. A class and its members will be registered for dynamic access only if the
+ * specified condition is satisfied.
+ *
+ * {@link ReflectionDynamicAccess} should only be used during {@link Feature#afterRegistration}. Any
+ * attempt of registration in any other phase will result as an error.
+ */
+public interface ReflectionDynamicAccess {
+
+    /**
+     * Registers the provided classes for reflection at runtime, and all of their accessible members
+     * available for reflection queries at runtime, if the {@code condition} is satisfied. A call to
+     * {@link Class#forName} for the names of the classes will return the classes at runtime.
+     *
+     * If the class is not registered for reflection at runtime, {@link Class#forName} will throw
+     * {@link org.graalvm.nativeimage.MissingReflectionRegistrationError}.
+     */
+    void register(RegistrationCondition condition, Class<?>... classes);
+
+    /**
+     * If the {@code condition} is satisfied, this method registers the class with the provided name
+     * for reflection at runtime.
+     * <ul>
+     * <li>If the class exists, a call to {@link Class#forName} for the name of the class will
+     * return the class at runtime.</li>
+     * <li>Otherwise, {@link Class#forName} will throw {@link ClassNotFoundException} at
+     * runtime.</li>
+     * </ul>
+     *
+     * If the class is not registered for reflection at runtime, {@link Class#forName} will throw
+     * {@link org.graalvm.nativeimage.MissingReflectionRegistrationError}.
+     */
+    void registerClassLookup(RegistrationCondition condition, String className);
+
+    /**
+     * Registers the provided methods for reflective invocation at runtime, if the {@code condition}
+     * is satisfied. The methods will be invocable via
+     * {@link java.lang.reflect.Method#invoke(java.lang.Object, java.lang.Object...)}.
+     */
+    void register(RegistrationCondition condition, Executable... methods);
+
+    /**
+     * Registers the provided fields for reflective access at runtime, if the {@code condition} is
+     * satisfied. The fields will be accessible via
+     * {@link java.lang.reflect.Field#set(java.lang.Object, java.lang.Object)} and
+     * {@link java.lang.reflect.Field#get(Object)}.
+     */
+    void register(RegistrationCondition condition, Field... fields);
+
+    /**
+     * Registers the provided classes for both serialization and reflection at runtime, if the
+     * {@code condition} is satisfied.
+     */
+    void registerForSerialization(RegistrationCondition condition, Class<?>... classes);
+
+    /**
+     * Registers the provided classes for both JNI access and reflection at runtime, if the
+     * {@code condition} is satisfied.
+     */
+    void registerForJNIAccess(RegistrationCondition condition, Class<?>... classes);
+}

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/hosted/ResourceDynamicAccess.java

@@ -0,0 +1,59 @@
+package org.graalvm.nativeimage.hosted;
+
+/**
+ * This interface is used to register Java resources and {@link java.util.ResourceBundle} that
+ * should be accessible at runtime.
+ *
+ * All methods in {@link ResourceDynamicAccess} require a {@link RegistrationCondition} as their
+ * first parameter. A class and its members will be registered for dynamic access only if the
+ * specified condition is satisfied.
+ *
+ * {@link ResourceDynamicAccess} should only be used during {@link Feature#afterRegistration}. Any
+ * attempt of registration in any other phase will result as an error.
+ */
+public interface ResourceDynamicAccess {
+
+    /**
+     * Registers resources from the given {@code module} described with the provided {@code glob},
+     * for dynamic access, if the {@code condition} is satisfied.
+     *
+     * @param condition represents the condition that needs to be satisfied in order to register
+     *            target resources.
+     * @param module represents the Java module instance that contains target resources. If provided
+     *            value is {@code null}, resources are looked on classpath instead.
+     * @param glob can either be exact Java resource path, or glob that contains wildcards such as
+     *            star(*) or globstar(**). Find glob syntax explanation <a href=
+     *            "/https://www.graalvm.org/latest/reference-manual/native-image/metadata/#resources">here</a>.
+     */
+    void register(RegistrationCondition condition, Module module, String glob);
+
+    /**
+     * Registers resources from classpath described with the provided {@code glob}, for dynamic
+     * access, if the {@code condition} is satisfied.
+     *
+     * @param condition represents the condition that needs to be satisfied in order to register
+     *            target resources.
+     * @param glob can either be exact Java resource path, or glob that contains wildcards such as
+     *            star(*) or globstar(**). Find glob syntax explanation <a href=
+     *            "/https://www.graalvm.org/latest/reference-manual/native-image/metadata/#resources">here</a>.
+     */
+    default void register(RegistrationCondition condition, String glob) {
+        register(condition, null, glob);
+    }
+
+    /**
+     * Registers {@link java.util.ResourceBundle} that is specified by a {@code bundleName} from
+     * provided {@code module} for dynamic access, if the {@code condition} is satisfied. If the
+     * given {@code module} value is {@code null}, the {@link java.util.ResourceBundle} is looked up
+     * on the classpath instead.
+     */
+    void registerResourceBundle(RegistrationCondition condition, Module module, String bundleName);
+
+    /**
+     * Registers {@link java.util.ResourceBundle} that is specified by a {@code bundleName} from
+     * classpath for dynamic access if the {@code condition} is satisfied.
+     */
+    default void registerResourceBundle(RegistrationCondition condition, String bundleName) {
+        registerResourceBundle(condition, null, bundleName);
+    }
+}

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/impl/RuntimeReflectionSupport.java

@@ -54,6 +54,10 @@ public interface RuntimeReflectionSupport extends ReflectionRegistry {
 
     void registerAllDeclaredMethodsQuery(RegistrationCondition condition, boolean queriedOnly, Class<?> clazz);
 
+    void registerAllFieldsQuery(RegistrationCondition condition, boolean queriedOnly, Class<?> clazz);
+
+    void registerAllDeclaredFieldsQuery(RegistrationCondition condition, boolean queriedOnly, Class<?> clazz);
+
     void registerAllConstructorsQuery(RegistrationCondition condition, boolean queriedOnly, Class<?> clazz);
 
     void registerAllDeclaredConstructorsQuery(RegistrationCondition condition, boolean queriedOnly, Class<?> clazz);

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/impl/RuntimeSerializationSupport.java

@@ -56,6 +56,10 @@ static RuntimeSerializationSupport<RegistrationCondition> singleton() {
 
     void registerIncludingAssociatedClasses(C condition, Class<?> clazz);
 
+    default void register(C condition, Class<?>... classes) {
+        Arrays.stream(classes).forEach(clazz -> register(condition, clazz));
+    }
+
     void register(C condition, Class<?> clazz);
 
     void register(C condition, String clazz);

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/ConditionalConfigurationRegistry.java

@@ -69,9 +69,7 @@ protected void registerConditionalConfiguration(RegistrationCondition condition,
             } else {
                 beforeAnalysisAccess.registerReachabilityHandler(access -> consumer.accept(runtimeCondition), ((TypeReachabilityCondition) condition).getKey());
             }
-
         }
-
     }
 
     public void setAnalysisAccess(Feature.BeforeAnalysisAccess beforeAnalysisAccess) {

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/FeatureImpl.java

@@ -50,7 +50,9 @@
 import org.graalvm.nativeimage.hosted.Feature;
 import org.graalvm.nativeimage.hosted.Feature.DuringAnalysisAccess;
 import org.graalvm.nativeimage.hosted.FieldValueTransformer;
+import org.graalvm.nativeimage.hosted.ReflectionDynamicAccess;
 import org.graalvm.nativeimage.hosted.RegistrationCondition;
+import org.graalvm.nativeimage.hosted.ResourceDynamicAccess;
 import org.graalvm.nativeimage.hosted.RuntimeReflection;
 
 import com.oracle.graal.pointsto.BigBang;
@@ -192,6 +194,16 @@ public void setMainEntryPoint(Pair<Method, CEntryPointData> mainEntryPoint) {
         public Pair<Method, CEntryPointData> getMainEntryPoint() {
             return mainEntryPoint;
         }
+
+        @Override
+        public ReflectionDynamicAccess getReflectionDynamicAccess() {
+            return new ReflectionDynamicAccessImpl();
+        }
+
+        @Override
+        public ResourceDynamicAccess getResourceDynamicAccess() {
+            return new ResourceDynamicAccessImpl();
+        }
     }
 
     abstract static class AnalysisAccessBase extends FeatureAccessImpl {

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/InternalReflectionDynamicAccess.java

@@ -0,0 +1,66 @@
+package com.oracle.svm.hosted;
+
+import java.lang.reflect.Executable;
+import java.lang.reflect.Field;
+
+import org.graalvm.nativeimage.ImageSingletons;
+import org.graalvm.nativeimage.hosted.ReflectionDynamicAccess;
+import org.graalvm.nativeimage.hosted.RegistrationCondition;
+import org.graalvm.nativeimage.impl.RuntimeJNIAccessSupport;
+import org.graalvm.nativeimage.impl.RuntimeReflectionSupport;
+import org.graalvm.nativeimage.impl.RuntimeSerializationSupport;
+
+public class InternalReflectionDynamicAccess implements ReflectionDynamicAccess {
+
+    private static RuntimeReflectionSupport rrsInstance;
+
+    InternalReflectionDynamicAccess() {
+        rrsInstance = ImageSingletons.lookup(RuntimeReflectionSupport.class);
+    }
+
+    @Override
+    public void register(RegistrationCondition condition, Class<?>... classes) {
+        rrsInstance.register(condition, classes);
+        for (Class<?> clazz : classes) {
+            rrsInstance.registerAllClassesQuery(condition, clazz);
+            rrsInstance.registerAllDeclaredClassesQuery(condition, clazz);
+            rrsInstance.registerAllDeclaredMethodsQuery(condition, true, clazz);
+            rrsInstance.registerAllMethodsQuery(condition, true, clazz);
+            rrsInstance.registerAllDeclaredConstructorsQuery(condition, true, clazz);
+            rrsInstance.registerAllConstructorsQuery(condition, true, clazz);
+            rrsInstance.registerAllFieldsQuery(condition, true, clazz);
+            rrsInstance.registerAllDeclaredFieldsQuery(condition, true, clazz);
+            rrsInstance.registerAllNestMembersQuery(condition, clazz);
+            rrsInstance.registerAllPermittedSubclassesQuery(condition, clazz);
+            rrsInstance.registerAllRecordComponentsQuery(condition, clazz);
+            rrsInstance.registerAllSignersQuery(condition, clazz);
+        }
+    }
+
+    @Override
+    public void registerClassLookup(RegistrationCondition condition, String className) {
+        rrsInstance.registerClassLookup(condition, className);
+    }
+
+    @Override
+    public void register(RegistrationCondition condition, Executable... methods) {
+        rrsInstance.register(condition, false, methods);
+    }
+
+    @Override
+    public void register(RegistrationCondition condition, Field... fields) {
+        rrsInstance.register(condition, false, fields);
+    }
+
+    @Override
+    public void registerForSerialization(RegistrationCondition condition, Class<?>... classes) {
+        register(condition, classes);
+        RuntimeSerializationSupport.singleton().register(condition, classes);
+    }
+
+    @Override
+    public void registerForJNIAccess(RegistrationCondition condition, Class<?>... classes) {
+        register(condition, classes);
+        ImageSingletons.lookup(RuntimeJNIAccessSupport.class).register(condition, classes);
+    }
+}

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/InternalResourceDynamicAccess.java

@@ -0,0 +1,37 @@
+package com.oracle.svm.hosted;
+
+import java.util.Objects;
+
+import org.graalvm.nativeimage.hosted.RegistrationCondition;
+import org.graalvm.nativeimage.hosted.ResourceDynamicAccess;
+import org.graalvm.nativeimage.impl.RuntimeResourceSupport;
+
+public class InternalResourceDynamicAccess implements ResourceDynamicAccess {
+
+    private static RuntimeResourceSupport<RegistrationCondition> rrsInstance;
+
+    InternalResourceDynamicAccess() {
+        rrsInstance = RuntimeResourceSupport.singleton();
+    }
+
+    @Override
+    public void register(RegistrationCondition condition, Module module, String pattern) {
+        if (pattern.replace("\\*", "").contains("*")) {
+            String moduleName = module == null ? null : module.getName();
+            rrsInstance.addGlob(condition, moduleName, pattern, "Registered from API");
+        } else {
+            rrsInstance.addResource(condition, module, pattern.replace("\\*", "*"), "Registered from API");
+        }
+    }
+
+    @Override
+    public void registerResourceBundle(RegistrationCondition condition, Module module, String bundleName) {
+        rrsInstance.addResourceBundles(condition, resolveModuleName(module, bundleName));
+    }
+
+    private static String resolveModuleName(Module module, String str) {
+        Objects.requireNonNull(str);
+        boolean isNamed = module == null ? false : module.isNamed();
+        return ((isNamed) ? module.getName() : "ALL-UNNAMED") + ":" + str;
+    }
+}

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/NativeImageGenerator.java

@@ -978,6 +978,8 @@ protected void setupNativeImage(String imageName, OptionValues options, Map<Meth
 
                 AfterRegistrationAccessImpl access = new AfterRegistrationAccessImpl(featureHandler, loader, originalMetaAccess, mainEntryPoint, debug);
                 featureHandler.forEachFeature(feature -> feature.afterRegistration(access));
+                ReflectionDynamicAccessImpl.setAfterRegistrationFinished();
+                ResourceDynamicAccessImpl.setAfterRegistrationFinished();
                 setDefaultLibCIfMissing();
                 if (!Pair.<Method, CEntryPointData> empty().equals(access.getMainEntryPoint())) {
                     setAndVerifyMainEntryPoint(access, entryPoints);

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/ReflectionDynamicAccessImpl.java

@@ -0,0 +1,71 @@
+package com.oracle.svm.hosted;
+
+import java.lang.reflect.Executable;
+import java.lang.reflect.Field;
+import java.util.Arrays;
+
+import org.graalvm.nativeimage.hosted.Feature;
+import org.graalvm.nativeimage.hosted.ReflectionDynamicAccess;
+import org.graalvm.nativeimage.hosted.RegistrationCondition;
+
+import com.oracle.svm.core.util.UserError;
+
+/**
+ * Instance of this class is used to register classes, methods, and fields for reflection,
+ * serialization and JNI access at runtime. It can only be created at
+ * {@link Feature#afterRegistration} via {@link Feature.AfterRegistrationAccess}.
+ */
+public final class ReflectionDynamicAccessImpl implements ReflectionDynamicAccess {
+
+    private static boolean afterRegistrationFinished;
+    private static InternalReflectionDynamicAccess rdaInstance;
+
+    public ReflectionDynamicAccessImpl() {
+        rdaInstance = new InternalReflectionDynamicAccess();
+        afterRegistrationFinished = false;
+    }
+
+    public static void setAfterRegistrationFinished() {
+        afterRegistrationFinished = true;
+    }
+
+    @Override
+    public void register(RegistrationCondition condition, Class<?>... classes) {
+        printUserError(Arrays.toString(classes));
+        rdaInstance.register(condition, classes);
+    }
+
+    @Override
+    public void registerClassLookup(RegistrationCondition condition, String className) {
+        printUserError(className + "for lookup");
+        rdaInstance.registerClassLookup(condition, className);
+    }
+
+    @Override
+    public void register(RegistrationCondition condition, Executable... methods) {
+        printUserError(Arrays.toString(methods));
+        rdaInstance.register(condition, methods);
+    }
+
+    @Override
+    public void register(RegistrationCondition condition, Field... fields) {
+        printUserError(Arrays.toString(fields));
+        rdaInstance.register(condition, fields);
+    }
+
+    @Override
+    public void registerForSerialization(RegistrationCondition condition, Class<?>... classes) {
+        printUserError(Arrays.toString(classes));
+        rdaInstance.registerForSerialization(condition, classes);
+    }
+
+    @Override
+    public void registerForJNIAccess(RegistrationCondition condition, Class<?>... classes) {
+        printUserError(Arrays.toString(classes));
+        rdaInstance.registerForJNIAccess(condition, classes);
+    }
+
+    private void printUserError(String registrationEntry) {
+        UserError.guarantee(!afterRegistrationFinished, "Registration for runtime access after Feature#afterRegistration is not allowed. You tried to register: %s", registrationEntry);
+    }
+}