[GR-62109] Add directives to defer initialization to App Layer.

PullRequest: graal/20297

Author: teshull

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/ObjectScanner.java

@@ -109,7 +109,7 @@ public void scanBootImageHeapRoots(Comparator<AnalysisField> fieldComparator, Co
         }
         for (AnalysisField field : fields) {
             if (Modifier.isStatic(field.getModifiers()) && field.isRead()) {
-                execute(() -> scanRootField(field));
+                execute(() -> scanStaticFieldRoot(field));
             }
         }
 
@@ -155,9 +155,9 @@ protected void scanEmbeddedRoot(JavaConstant root, Object position) {
      *
      * @param field the scanned root field
      */
-    protected final void scanRootField(AnalysisField field) {
-        if (field.isInBaseLayer()) {
-            // skip base layer roots
+    protected final void scanStaticFieldRoot(AnalysisField field) {
+        if (!field.installableInLayer()) {
+            // skip fields not installable in this layer
             return;
         }
         scanField(field, null, null);

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/api/HostVM.java

@@ -391,6 +391,20 @@ public boolean enableReachableInCurrentLayer() {
         return false;
     }
 
+    public boolean buildingImageLayer() {
+        return false;
+    }
+
+    @SuppressWarnings("unused")
+    public boolean installableInLayer(AnalysisField aField) {
+        return true;
+    }
+
+    @SuppressWarnings("unused")
+    public boolean preventConstantFolding(AnalysisField aField) {
+        return false;
+    }
+
     /**
      * Helpers to determine what analysis actions should be taken for a given Multi-Method version.
      */

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/heap/ImageHeapRelocatableConstant.java

@@ -77,4 +77,9 @@ public JavaConstant uncompress() {
     public ImageHeapConstant forObjectClone() {
         throw AnalysisError.shouldNotReachHere("Unsupported in ImageHeapRelocatableConstant");
     }
+
+    @Override
+    public String toString() {
+        return "(ImageHeapRelocatableConstant) " + super.toString();
+    }
 }

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/heap/ImageHeapScanner.java

@@ -133,10 +133,10 @@ public void onFieldRead(AnalysisField field) {
         AnalysisType declaringClass = field.getDeclaringClass();
         if (field.isStatic()) {
             FieldScan reason = new FieldScan(field);
-            if (field.isInBaseLayer()) {
+            if (!field.installableInLayer()) {
                 /*
-                 * For base layer static fields we don't want to scan the constant value, but
-                 * instead inject its type state in the field flow. This will be propagated to any
+                 * For non-installable static fields we do not scan the constant value, but instead
+                 * inject its type state in the field flow. This will be propagated to any
                  * corresponding field loads.
                  * 
                  * GR-52421: the field state needs to be serialized from the base layer analysis
@@ -146,9 +146,7 @@ public void onFieldRead(AnalysisField field) {
                 } else if (bb.trackPrimitiveValues() && field.getStorageKind().isPrimitive()) {
                     ((PointsToAnalysisField) field).saturatePrimitiveField();
                 }
-                return;
-            }
-            if (isValueAvailable(field)) {
+            } else if (isValueAvailable(field)) {
                 JavaConstant fieldValue = readStaticFieldValue(field);
                 if (fieldValue instanceof ImageHeapConstant imageHeapConstant && field.isFinal()) {
                     AnalysisError.guarantee(imageHeapConstant.getOrigin() != null, "The origin of the constant %s should have been registered before", imageHeapConstant);

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/meta/AnalysisField.java

@@ -107,6 +107,13 @@ public abstract class AnalysisField extends AnalysisElement implements WrappedJa
      */
     protected Object fieldValueInterceptor;
 
+    /**
+     * When building layered images, for static fields we must keep track of what layer's static
+     * fields array the field is assigned in. This also impacts when the underlying value can be
+     * read and/or constant folded.
+     */
+    private final boolean isLayeredStaticField;
+
     @SuppressWarnings("this-escape")
     public AnalysisField(AnalysisUniverse universe, ResolvedJavaField wrappedField) {
         super(universe.hostVM.enableTrackAcrossLayers());
@@ -152,6 +159,7 @@ public AnalysisField(AnalysisUniverse universe, ResolvedJavaField wrappedField)
             id = universe.computeNextFieldId();
             isInBaseLayer = false;
         }
+        isLayeredStaticField = isStatic() && universe.hostVM.buildingImageLayer();
     }
 
     @Override
@@ -188,6 +196,22 @@ public boolean isInBaseLayer() {
         return isInBaseLayer;
     }
 
+    public boolean installableInLayer() {
+        if (isLayeredStaticField) {
+            return getUniverse().hostVM.installableInLayer(this);
+        } else {
+            return true;
+        }
+    }
+
+    public boolean preventConstantFolding() {
+        if (isLayeredStaticField) {
+            return getUniverse().hostVM.preventConstantFolding(this);
+        } else {
+            return false;
+        }
+    }
+
     @Override
     public int hashCode() {
         return id;

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/StaticFieldsSupport.java

@@ -54,6 +54,7 @@
 import jdk.graal.compiler.graph.NodeClass;
 import jdk.graal.compiler.nodeinfo.NodeInfo;
 import jdk.graal.compiler.nodes.ConstantNode;
+import jdk.graal.compiler.nodes.StructuredGraph;
 import jdk.graal.compiler.nodes.ValueNode;
 import jdk.graal.compiler.nodes.calc.FloatingNode;
 import jdk.graal.compiler.nodes.graphbuilderconf.GraphBuilderConfiguration.Plugins;
@@ -99,9 +100,9 @@ static HostedStaticFieldSupport singleton() {
             return ImageSingletons.lookup(HostedStaticFieldSupport.class);
         }
 
-        JavaConstant getStaticPrimitiveFieldsConstant(int layerNum, Function<Object, JavaConstant> toConstant);
+        JavaConstant getStaticFieldsBaseConstant(int layerNum, boolean primitive, Function<Object, JavaConstant> toConstant);
 
-        JavaConstant getStaticObjectFieldsConstant(int layerNum, Function<Object, JavaConstant> toConstant);
+        FloatingNode getStaticFieldsBaseReplacement(int layerNum, boolean primitive, LoweringTool tool, StructuredGraph graph);
 
         boolean isPrimitive(ResolvedJavaField field);
 
@@ -137,7 +138,7 @@ public static JavaConstant getStaticFieldsConstant(ResolvedJavaField field, Func
         var hostedSupport = HostedStaticFieldSupport.singleton();
         boolean primitive = hostedSupport.isPrimitive(field);
         int layerNum = getInstalledLayerNum(field);
-        return primitive ? hostedSupport.getStaticPrimitiveFieldsConstant(layerNum, toConstant) : hostedSupport.getStaticObjectFieldsConstant(layerNum, toConstant);
+        return hostedSupport.getStaticFieldsBaseConstant(layerNum, primitive, toConstant);
     }
 
     public static int getInstalledLayerNum(ResolvedJavaField field) {
@@ -249,25 +250,22 @@ public void lower(LoweringTool tool) {
                  */
                 return;
             }
-            JavaConstant constant;
+            FloatingNode replacement;
             if (SubstrateUtil.HOSTED) {
                 /*
                  * Build-time version of lowering.
                  */
-                Function<Object, JavaConstant> toConstantFunction = (obj) -> tool.getSnippetReflection().forObject(obj);
-
                 HostedStaticFieldSupport hostedSupport = HostedStaticFieldSupport.singleton();
-                constant = primitive ? hostedSupport.getStaticPrimitiveFieldsConstant(layerNum, toConstantFunction)
-                                : hostedSupport.getStaticObjectFieldsConstant(layerNum, toConstantFunction);
+                replacement = hostedSupport.getStaticFieldsBaseReplacement(layerNum, primitive, tool, graph());
             } else {
                 /*
                  * JIT version of lowering.
                  */
-                constant = tool.getSnippetReflection()
+                JavaConstant constant = tool.getSnippetReflection()
                                 .forObject(primitive ? StaticFieldsSupport.getStaticPrimitiveFieldsAtRuntime(layerNum) : StaticFieldsSupport.getStaticObjectFieldsAtRuntime(layerNum));
+                replacement = ConstantNode.forConstant(constant, tool.getMetaAccess(), graph());
             }
-            assert constant.isNonNull() : constant;
-            replaceAndDelete(ConstantNode.forConstant(constant, tool.getMetaAccess(), graph()));
+            replaceAndDelete(graph().addOrUniqueWithInputs(replacement));
         }
     }
 

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/SubstrateOptions.java

@@ -167,6 +167,10 @@ protected void onValueUpdate(EconomicMap<OptionKey<?>, Object> values, Boolean o
     @Option(help = "Mark singleton as application layer only")//
     public static final HostedOptionKey<AccumulatingLocatableMultiOptionValue.Strings> ApplicationLayerOnlySingletons = new HostedOptionKey<>(AccumulatingLocatableMultiOptionValue.Strings.build());
 
+    @Option(help = "Register class as being initialized in the app layer.")//
+    public static final HostedOptionKey<AccumulatingLocatableMultiOptionValue.Strings> ApplicationLayerInitializedClasses = new HostedOptionKey<>(
+                    AccumulatingLocatableMultiOptionValue.Strings.build());
+
     @APIOption(name = "libc")//
     @Option(help = "Selects the libc implementation to use. Available implementations: glibc, musl, bionic")//
     public static final HostedOptionKey<String> UseLibC = new HostedOptionKey<>(null) {

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/hub/ConstantPoolProvider.java

@@ -44,7 +44,7 @@
  * {@link Target_jdk_internal_reflect_ConstantPool}.
  */
 public class ConstantPoolProvider implements MultiLayeredImageSingleton, UnsavedSingleton {
-    private final Target_jdk_internal_reflect_ConstantPool constantPool = new Target_jdk_internal_reflect_ConstantPool(DynamicImageLayerInfo.singleton().layerNumber);
+    private final Target_jdk_internal_reflect_ConstantPool constantPool = new Target_jdk_internal_reflect_ConstantPool(DynamicImageLayerInfo.getCurrentLayerNumber());
 
     public static ConstantPoolProvider[] singletons() {
         return MultiLayeredImageSingleton.getAllLayers(ConstantPoolProvider.class);

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/imagelayer/DynamicImageLayerInfo.java

@@ -29,13 +29,14 @@
 import org.graalvm.nativeimage.Platforms;
 
 import com.oracle.svm.core.graal.code.CGlobalDataInfo;
+import com.oracle.svm.core.layeredimagesingleton.MultiLayeredImageSingleton;
 import com.oracle.svm.core.meta.SharedMethod;
 
 @Platforms(Platform.HOSTED_ONLY.class)
 public abstract class DynamicImageLayerInfo {
     public static final int CREMA_LAYER_ID = Byte.MAX_VALUE;
 
-    public final int layerNumber;
+    private final int layerNumber;
     public final int nextLayerNumber;
     public final int numLayers;
 
@@ -56,4 +57,12 @@ public record PriorLayerMethodLocation(CGlobalDataInfo base, int offset) {
      * Returns a (Base, Offset) pair which can be used to call a method defined in a prior layer.
      */
     public abstract PriorLayerMethodLocation getPriorLayerMethodLocation(SharedMethod method);
+
+    public static int getCurrentLayerNumber() {
+        if (!ImageLayerBuildingSupport.buildingImageLayer()) {
+            return MultiLayeredImageSingleton.UNUSED_LAYER_NUMBER;
+        } else {
+            return singleton().layerNumber;
+        }
+    }
 }

substratevm/src/com.oracle.svm.hosted/resources/SharedLayerSnapshotCapnProtoSchema.capnp

@@ -128,7 +128,7 @@ struct PersistedAnalysisField {
   declaringTypeId @2 :TypeId;
   typeId @3 :TypeId;
   position @4 :Int32;
-  location @5 :Int32;
+  location @5 :Int32; # note currently we only read information about static fields' location
   modifiers @6 :Int32;
   isInternal @7 :Bool;
   isAccessed @8 :Bool;
@@ -139,6 +139,8 @@ struct PersistedAnalysisField {
   isSynthetic @13 :Bool;
   annotationList @14 :List(Annotation);
   name @15 :Text;
+  priorInstalledLayerNum @16 :Int32;
+  assignmentStatus @17 :Int32;
 }
 
 struct CEntryPointLiteralReference {