added hook for object reachability notifications

Author: dougxc

sdk/src/org.graalvm.nativeimage/snapshot.sigtest

@@ -1017,6 +1017,7 @@ meth public abstract void registerClassInitializerReachabilityHandler(java.util.
 meth public abstract void registerFieldValueTransformer(java.lang.reflect.Field,org.graalvm.nativeimage.hosted.FieldValueTransformer)
 meth public abstract void registerMethodOverrideReachabilityHandler(java.util.function.BiConsumer<org.graalvm.nativeimage.hosted.Feature$DuringAnalysisAccess,java.lang.reflect.Executable>,java.lang.reflect.Executable)
 meth public abstract void registerSubtypeReachabilityHandler(java.util.function.BiConsumer<org.graalvm.nativeimage.hosted.Feature$DuringAnalysisAccess,java.lang.Class<?>>,java.lang.Class<?>)
+meth public abstract void registerObjectReachabilityHandler(java.util.function.Consumer<T>,java.lang.Class<T>)
 
 CLSS public abstract interface static org.graalvm.nativeimage.hosted.Feature$BeforeCompilationAccess
  outer org.graalvm.nativeimage.hosted.Feature

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

@@ -312,6 +312,14 @@ interface BeforeAnalysisAccess extends FeatureAccess {
          * @since 22.3
          */
         void registerFieldValueTransformer(Field field, FieldValueTransformer transformer);
+
+        /**
+         * Register a callback that is executed when an object of type {@code clazz}, or any of its
+         * subtypes, is marked as reachable during heap scanning.
+         *
+         * @since 24.2
+         */
+        <T> void registerObjectReachabilityHandler(Consumer<T> callback, Class<T> clazz);
     }
 
     /**

substratevm/CHANGELOG.md

@@ -3,6 +3,7 @@
 This changelog summarizes major changes to GraalVM Native Image.
 
 ## GraalVM for JDK 24 (Internal Version 24.2.0)
+* (GR-59717) Added `BeforeAnalysisAccess.registerObjectReachabilityHandler` to allow registering a callback that is executed when an object of a specified type is marked as reachable during heap scanning.
 * (GR-55708) (Alibaba contribution) Support for running premain methods of Java agents at runtime as an experimental feature. At build time, `-H:PremainClasses` is used to set the premain classes.
 At runtime, premain runtime options are set along with main class' arguments in the format of `-XXpremain:[class]:[options]`.
 * (GR-54476): Issue a deprecation warning on first use of a legacy `graal.` prefix (see GR-49960 in [Compiler changelog](../compiler/CHANGELOG.md)).

substratevm/src/com.oracle.graal.pointsto.standalone/src/com/oracle/graal/pointsto/standalone/features/StandaloneAnalysisFeatureImpl.java

@@ -260,6 +260,10 @@ public void registerClassInitializerReachabilityHandler(Consumer<Feature.DuringA
         @Override
         public void registerFieldValueTransformer(Field field, FieldValueTransformer transformer) {
         }
+
+        @Override
+        public <T> void registerObjectReachabilityHandler(Consumer<T> callback, Class<T> clazz) {
+        }
     }
 
     public static class DuringAnalysisAccessImpl extends BeforeAnalysisAccessImpl implements Feature.DuringAnalysisAccess {

substratevm/src/com.oracle.svm.graal.hotspot.libgraal/src/com/oracle/svm/graal/hotspot/libgraal/LibGraalFeature.java

@@ -53,9 +53,7 @@
 import org.graalvm.nativeimage.hosted.RuntimeReflection;
 
 import com.oracle.graal.pointsto.BigBang;
-import com.oracle.graal.pointsto.ObjectScanner;
 import com.oracle.graal.pointsto.meta.AnalysisType;
-import com.oracle.graal.pointsto.meta.ObjectReachableCallback;
 import com.oracle.graal.pointsto.reports.CallTreePrinter;
 import com.oracle.svm.core.SubstrateTargetDescription;
 import com.oracle.svm.core.hub.ClassForNameSupport;
@@ -255,9 +253,6 @@ public void duringSetup(DuringSetupAccess access) {
 
         DuringSetupAccessImpl accessImpl = (DuringSetupAccessImpl) access;
         accessImpl.registerClassReachabilityListener(this::registerPhaseStatistics);
-        optionCollector = new OptionCollector(LibGraalEntryPoints.vmOptionDescriptors);
-        accessImpl.registerObjectReachableCallback(OptionKey.class, optionCollector::doCallback);
-        accessImpl.registerObjectReachableCallback(loadClassOrFail(OptionKey.class.getName()), optionCollector::doCallback);
         GetJNIConfig.register(loader);
     }
 
@@ -270,7 +265,7 @@ public void duringSetup(DuringSetupAccess access) {
      * compiler options are instances of {@link OptionKey} loaded by the
      * {@code HostedLibGraalClassLoader}.
      */
-    private class OptionCollector implements ObjectReachableCallback<Object> {
+    private class OptionCollector implements Consumer<Object> {
         private final Set<Object> options = Collections.newSetFromMap(new ConcurrentHashMap<>());
 
         /**
@@ -297,7 +292,7 @@ private class OptionCollector implements ObjectReachableCallback<Object> {
         }
 
         @Override
-        public void doCallback(DuringAnalysisAccess access, Object option, ObjectScanner.ScanReason reason) {
+        public void accept(Object option) {
             if (sealed) {
                 VMError.guarantee(options.contains(option), "All options must have been discovered during static analysis: %s", option);
             } else {
@@ -371,6 +366,10 @@ private void registerPhaseStatistics(DuringAnalysisAccess a, Class<?> newlyReach
 
     @Override
     public void beforeAnalysis(BeforeAnalysisAccess baa) {
+        optionCollector = new OptionCollector(LibGraalEntryPoints.vmOptionDescriptors);
+        baa.registerObjectReachabilityHandler(optionCollector::accept, OptionKey.class);
+        baa.registerObjectReachabilityHandler(optionCollector::accept, loadClassOrFail(OptionKey.class.getName()));
+
         BeforeAnalysisAccessImpl impl = (BeforeAnalysisAccessImpl) baa;
         var bb = impl.getBigBang();
 

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

@@ -499,6 +499,12 @@ public void registerOpaqueMethodReturn(Method method) {
             VMError.guarantee(aMethod.getAllMultiMethods().size() == 1, "Opaque method return called for method with >1 multimethods: %s ", method);
             aMethod.setOpaqueReturn();
         }
+
+        @Override
+        public <T> void registerObjectReachabilityHandler(Consumer<T> callback, Class<T> clazz) {
+            ObjectReachableCallback<T> wrapper = (access, obj, reason) -> callback.accept(obj);
+            getMetaAccess().lookupJavaType(clazz).registerObjectReachableCallback(wrapper);
+        }
     }
 
     public static class DuringAnalysisAccessImpl extends BeforeAnalysisAccessImpl implements Feature.DuringAnalysisAccess {