[GR-66214] Switch Application Layer Only Image Singletons to use new trait.

PullRequest: graal/21898

Author: teshull

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

@@ -32,7 +32,6 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
-import java.util.EnumSet;
 import java.util.List;
 import java.util.function.BooleanSupplier;
 
@@ -70,15 +69,16 @@
 import com.oracle.svm.core.jdk.RuntimeSupport;
 import com.oracle.svm.core.jni.JNIJavaVMList;
 import com.oracle.svm.core.jni.functions.JNIFunctionTables;
-import com.oracle.svm.core.layeredimagesingleton.ApplicationLayerOnlyImageSingleton;
-import com.oracle.svm.core.layeredimagesingleton.LayeredImageSingletonBuilderFlags;
-import com.oracle.svm.core.layeredimagesingleton.UnsavedSingleton;
 import com.oracle.svm.core.log.Log;
 import com.oracle.svm.core.thread.JavaThreads;
 import com.oracle.svm.core.thread.PlatformThreads;
 import com.oracle.svm.core.thread.RecurringCallbackSupport;
 import com.oracle.svm.core.thread.VMThreads;
 import com.oracle.svm.core.thread.VMThreads.OSThreadHandle;
+import com.oracle.svm.core.traits.BuiltinTraits.AllAccess;
+import com.oracle.svm.core.traits.BuiltinTraits.NoLayeredCallbacks;
+import com.oracle.svm.core.traits.SingletonLayeredInstallationKind.ApplicationLayerOnly;
+import com.oracle.svm.core.traits.SingletonTraits;
 import com.oracle.svm.core.util.UserError;
 import com.oracle.svm.core.util.VMError;
 import com.oracle.svm.util.ClassUtil;
@@ -101,7 +101,8 @@ public class JavaMainWrapper {
      * that uses it may be compiled as part of the base layer, e.g., such as
      * {@link CEntryPointSnippets}.
      */
-    public static class JavaMainSupport implements ApplicationLayerOnlyImageSingleton, UnsavedSingleton {
+    @SingletonTraits(access = AllAccess.class, layeredCallbacks = NoLayeredCallbacks.class, layeredInstallationKind = ApplicationLayerOnly.class)
+    public static class JavaMainSupport {
         private final MethodHandle javaMainHandle;
         private final MethodHandle javaMainClassCtorHandle;
         final String javaMainClassName;
@@ -158,11 +159,6 @@ public List<String> getInputArguments() {
             }
             return Collections.emptyList();
         }
-
-        @Override
-        public EnumSet<LayeredImageSingletonBuilderFlags> getImageBuilderFlags() {
-            return LayeredImageSingletonBuilderFlags.ALL_ACCESS;
-        }
     }
 
     public static void invokeMain(String[] args) throws Throwable {

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/hub/registry/TypeIDs.java

@@ -24,7 +24,6 @@
  */
 package com.oracle.svm.core.hub.registry;
 
-import java.util.EnumSet;
 import java.util.concurrent.atomic.AtomicInteger;
 
 import org.graalvm.nativeimage.ImageSingletons;
@@ -38,13 +37,15 @@
 import com.oracle.svm.core.hub.DynamicHub;
 import com.oracle.svm.core.hub.DynamicHubSupport;
 import com.oracle.svm.core.imagelayer.ImageLayerBuildingSupport;
-import com.oracle.svm.core.layeredimagesingleton.ApplicationLayerOnlyImageSingleton;
-import com.oracle.svm.core.layeredimagesingleton.LayeredImageSingletonBuilderFlags;
-import com.oracle.svm.core.layeredimagesingleton.UnsavedSingleton;
+import com.oracle.svm.core.traits.BuiltinTraits.AllAccess;
+import com.oracle.svm.core.traits.BuiltinTraits.NoLayeredCallbacks;
+import com.oracle.svm.core.traits.SingletonLayeredInstallationKind.ApplicationLayerOnly;
+import com.oracle.svm.core.traits.SingletonTraits;
 import com.oracle.svm.core.util.VMError;
 
 /** Keeps track of type ID information at run-time (see {@link DynamicHub#getTypeID()}). */
-public class TypeIDs implements ApplicationLayerOnlyImageSingleton, UnsavedSingleton {
+@SingletonTraits(access = AllAccess.class, layeredCallbacks = NoLayeredCallbacks.class, layeredInstallationKind = ApplicationLayerOnly.class)
+public class TypeIDs {
     private final AtomicInteger nextTypeId = new AtomicInteger();
     @UnknownPrimitiveField(availability = AfterCompilation.class) //
     private int firstRuntimeTypeId;
@@ -79,11 +80,6 @@ public int nextTypeId() {
     public int getNumTypeIds() {
         return nextTypeId.get();
     }
-
-    @Override
-    public EnumSet<LayeredImageSingletonBuilderFlags> getImageBuilderFlags() {
-        return LayeredImageSingletonBuilderFlags.ALL_ACCESS;
-    }
 }
 
 @AutomaticallyRegisteredFeature

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

@@ -63,8 +63,8 @@
  */
 public abstract class ImageLayerBuildingSupport {
     public final boolean buildingImageLayer;
-    private final boolean buildingInitialLayer;
-    private final boolean buildingApplicationLayer;
+    public final boolean buildingInitialLayer;
+    public final boolean buildingApplicationLayer;
 
     protected ImageLayerBuildingSupport(boolean buildingImageLayer, boolean buildingInitialLayer, boolean buildingApplicationLayer) {
         this.buildingImageLayer = buildingImageLayer;

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/RuntimeModuleSupport.java

@@ -24,8 +24,6 @@
  */
 package com.oracle.svm.core.jdk;
 
-import java.util.EnumSet;
-
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
@@ -34,9 +32,10 @@
 import com.oracle.svm.core.feature.AutomaticallyRegisteredImageSingleton;
 import com.oracle.svm.core.heap.UnknownObjectField;
 import com.oracle.svm.core.imagelayer.LastImageBuildPredicate;
-import com.oracle.svm.core.layeredimagesingleton.ApplicationLayerOnlyImageSingleton;
-import com.oracle.svm.core.layeredimagesingleton.LayeredImageSingletonBuilderFlags;
-import com.oracle.svm.core.layeredimagesingleton.UnsavedSingleton;
+import com.oracle.svm.core.traits.BuiltinTraits.AllAccess;
+import com.oracle.svm.core.traits.BuiltinTraits.NoLayeredCallbacks;
+import com.oracle.svm.core.traits.SingletonLayeredInstallationKind.ApplicationLayerOnly;
+import com.oracle.svm.core.traits.SingletonTraits;
 
 /**
  * Runtime module support singleton, containing the runtime boot module layer. The boot module layer
@@ -48,7 +47,8 @@
  * {@code ModuleLayerFeature} for more information.
  */
 @AutomaticallyRegisteredImageSingleton(onlyWith = LastImageBuildPredicate.class)
-public final class RuntimeModuleSupport implements ApplicationLayerOnlyImageSingleton, UnsavedSingleton {
+@SingletonTraits(access = AllAccess.class, layeredCallbacks = NoLayeredCallbacks.class, layeredInstallationKind = ApplicationLayerOnly.class)
+public final class RuntimeModuleSupport {
     public static RuntimeModuleSupport singleton() {
         return ImageSingletons.lookup(RuntimeModuleSupport.class);
     }
@@ -64,9 +64,4 @@ public void setBootLayer(ModuleLayer bootLayer) {
     public ModuleLayer getBootLayer() {
         return bootLayer;
     }
-
-    @Override
-    public EnumSet<LayeredImageSingletonBuilderFlags> getImageBuilderFlags() {
-        return LayeredImageSingletonBuilderFlags.ALL_ACCESS;
-    }
 }

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/layeredimagesingleton/ApplicationLayerOnlyImageSingleton.java

@@ -34,13 +34,9 @@
 
 /**
  * In additional to the traditional singleton model, i.e. a key-value map whose lookups are constant
- * folded within generated code, we provide two additional options:
+ * folded within generated code, we provide one additional option:
  *
  * <ul>
- * <li>{@link ApplicationLayerOnlyImageSingleton}: Instead of having a per-layer singleton, all
- * {@link ImageSingletons#lookup} calls refer to a single singleton which will be created in the
- * application layer.</li>
- *
  * <li>{@link MultiLayeredImageSingleton}: {@link ImageSingletons#lookup} should no longer be used.
  * Instead, there is the method {@link MultiLayeredImageSingleton#getAllLayers} which returns an
  * array with the image singletons corresponding to this key for all layers. The length of this
@@ -52,10 +48,9 @@
  * {@link ImageLayerBuildingSupport} for a description of the different layer names.</li>
  * </ul>
  *
- * Note the unique behavior of {@link ApplicationLayerOnlyImageSingleton} applies only when building
- * a layered image. Calling {@link MultiLayeredImageSingleton#getAllLayers} during a traditional
- * build requires the singleton to be installed in the build and will return an array of length 1
- * containing that singleton.
+ * Calling {@link MultiLayeredImageSingleton#getAllLayers} during a traditional build requires the
+ * singleton to be installed in the build and will return an array of length 1 containing that
+ * singleton.
  *
  * Currently, when using these special singleton types there are additional restrictions:
  *
@@ -65,8 +60,6 @@
  * between Class<->singleton object</li>
  * <li>{@link ImageSingletons#add} must be called before the analysis phase (i.e. these image
  * singletons cannot be added at a later point)</li>
- * <li>{@link ApplicationLayerOnlyImageSingleton}s can only be installed in the application
- * layer</li>
  * </ol>
  */
 public interface LayeredImageSingleton {

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/layeredimagesingleton/LayeredImageSingleton.java

@@ -26,9 +26,6 @@
 
 import java.util.EnumSet;
 
-import com.oracle.svm.core.graal.RuntimeCompilation;
-import com.oracle.svm.core.util.VMError;
-
 /**
  * Flags used during build time to determine how the native image generator handles the layered
  * image singleton.
@@ -52,39 +49,4 @@ public enum LayeredImageSingletonBuilderFlags {
     public static final EnumSet<LayeredImageSingletonBuilderFlags> RUNTIME_ACCESS_ONLY = EnumSet.of(RUNTIME_ACCESS);
 
     public static final EnumSet<LayeredImageSingletonBuilderFlags> ALL_ACCESS = EnumSet.of(RUNTIME_ACCESS, BUILDTIME_ACCESS);
-
-    public static boolean verifyImageBuilderFlags(Object singleton, EnumSet<LayeredImageSingletonBuilderFlags> flags) {
-        if (!(flags.contains(BUILDTIME_ACCESS) || flags.contains(RUNTIME_ACCESS))) {
-            assert false : String.format("At least one of the following flags must be set: %s, %s", BUILDTIME_ACCESS, RUNTIME_ACCESS);
-        }
-
-        if (singleton instanceof MultiLayeredImageSingleton || ApplicationLayerOnlyImageSingleton.isSingletonInstanceOf(singleton)) {
-            assert flags.contains(RUNTIME_ACCESS) : String.format("%s must be set when implementing either %s or %s: %s", RUNTIME_ACCESS, MultiLayeredImageSingleton.class,
-                            ApplicationLayerOnlyImageSingleton.class, singleton);
-        }
-
-        assert !(singleton instanceof MultiLayeredImageSingleton && ApplicationLayerOnlyImageSingleton.isSingletonInstanceOf(singleton)) : String.format("%s can only implement one of %s or %s",
-                        singleton,
-                        MultiLayeredImageSingleton.class, ApplicationLayerOnlyImageSingleton.class);
-
-        return true;
-    }
-
-    public static void validateRuntimeLookup(Object singleton) {
-        if (singleton instanceof LayeredImageSingleton layeredSingleton) {
-            if (!layeredSingleton.getImageBuilderFlags().contains(LayeredImageSingletonBuilderFlags.RUNTIME_ACCESS)) {
-                /*
-                 * Runtime compilation installs many singletons into the image which are otherwise
-                 * hosted only. Note the platform checks still apply and can be used to ensure
-                 * certain singleton are not installed into the image.
-                 */
-                if (!RuntimeCompilation.isEnabled()) {
-                    throw VMError.shouldNotReachHere("Layered image singleton without runtime access is in runtime graph: " + layeredSingleton);
-                }
-            }
-            if (layeredSingleton instanceof MultiLayeredImageSingleton) {
-                throw VMError.shouldNotReachHere("Forbidden lookup of MultiLayeredImageSingleton in runtime graph: " + layeredSingleton);
-            }
-        }
-    }
 }

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/layeredimagesingleton/LayeredImageSingletonBuilderFlags.java

@@ -32,6 +32,8 @@
 import org.graalvm.nativeimage.Platforms;
 
 import com.oracle.svm.core.traits.SingletonLayeredInstallationKind;
+import com.oracle.svm.core.traits.SingletonTrait;
+import com.oracle.svm.core.traits.SingletonTraitKind;
 
 import jdk.vm.ci.meta.JavaConstant;
 
@@ -58,7 +60,10 @@ static LayeredImageSingletonSupport singleton() {
 
     void freezeLayeredImageSingletonMetadata();
 
-    boolean isInitialLayerOnlyImageSingleton(Class<?> key);
-
     JavaConstant getInitialLayerOnlyImageSingleton(Class<?> key);
+
+    /**
+     * @return trait associated with this key if it exists, or else {@code null}.
+     */
+    SingletonTrait getTraitForUninstalledSingleton(Class<?> key, SingletonTraitKind kind);
 }

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/layeredimagesingleton/LayeredImageSingletonSupport.java

@@ -27,7 +27,6 @@
 import static com.oracle.svm.core.Uninterruptible.CALLED_FROM_UNINTERRUPTIBLE_CODE;
 
 import java.lang.Thread.UncaughtExceptionHandler;
-import java.util.EnumSet;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.atomic.AtomicLong;
 
@@ -46,15 +45,16 @@
 import com.oracle.svm.core.feature.AutomaticallyRegisteredImageSingleton;
 import com.oracle.svm.core.imagelayer.LastImageBuildPredicate;
 import com.oracle.svm.core.jdk.StackTraceUtils;
-import com.oracle.svm.core.layeredimagesingleton.ApplicationLayerOnlyImageSingleton;
-import com.oracle.svm.core.layeredimagesingleton.LayeredImageSingletonBuilderFlags;
-import com.oracle.svm.core.layeredimagesingleton.UnsavedSingleton;
 import com.oracle.svm.core.log.Log;
 import com.oracle.svm.core.snippets.KnownIntrinsics;
 import com.oracle.svm.core.stack.StackFrameVisitor;
 import com.oracle.svm.core.threadlocal.FastThreadLocal;
 import com.oracle.svm.core.threadlocal.FastThreadLocalFactory;
 import com.oracle.svm.core.threadlocal.FastThreadLocalLong;
+import com.oracle.svm.core.traits.BuiltinTraits.AllAccess;
+import com.oracle.svm.core.traits.BuiltinTraits.NoLayeredCallbacks;
+import com.oracle.svm.core.traits.SingletonLayeredInstallationKind.ApplicationLayerOnly;
+import com.oracle.svm.core.traits.SingletonTraits;
 import com.oracle.svm.util.ReflectionUtil;
 
 import jdk.graal.compiler.api.directives.GraalDirectives;
@@ -93,7 +93,8 @@ public final class JavaThreads {
     static final FastThreadLocalLong currentVThreadId = FastThreadLocalFactory.createLong("JavaThreads.currentVThreadId").setMaxOffset(FastThreadLocal.BYTE_OFFSET);
 
     @AutomaticallyRegisteredImageSingleton(onlyWith = LastImageBuildPredicate.class)
-    public static class JavaThreadNumberSingleton implements ApplicationLayerOnlyImageSingleton, UnsavedSingleton {
+    @SingletonTraits(access = AllAccess.class, layeredCallbacks = NoLayeredCallbacks.class, layeredInstallationKind = ApplicationLayerOnly.class)
+    public static class JavaThreadNumberSingleton {
 
         public static JavaThreadNumberSingleton singleton() {
             return ImageSingletons.lookup(JavaThreadNumberSingleton.class);
@@ -114,11 +115,6 @@ public void setThreadNumberInfo(long seqNumber, int initNumber) {
             this.threadSeqNumber.set(seqNumber);
             this.threadInitNumber.set(initNumber);
         }
-
-        @Override
-        public EnumSet<LayeredImageSingletonBuilderFlags> getImageBuilderFlags() {
-            return LayeredImageSingletonBuilderFlags.ALL_ACCESS;
-        }
     }
 
     private JavaThreads() {