Introduce helper to check if metadata tracing is enabled

DSouzaM · DSouzaM · commit 586afd51e81c · 2025-07-08T15:11:16.000-04:00
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/hub/ClassForNameSupport.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/hub/ClassForNameSupport.java
@@ -411,7 +411,7 @@ private Object forName0(String className, ClassLoader classLoader) {
             /* Invalid class names always throw, no need for reflection data */
             return new ClassNotFoundException(className);
         }
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             // NB: the early returns above ensure we do not trace calls with bad type args.
             MetadataTracer.singleton().traceReflectionType(className);
         }
@@ -500,7 +500,7 @@ public static Throwable getSavedException(String className) {
      */
     public static boolean canUnsafeInstantiateAsInstance(DynamicHub hub) {
         Class<?> clazz = DynamicHub.toClass(hub);
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             ConfigurationType type = MetadataTracer.singleton().traceReflectionType(clazz.getName());
             if (type != null) {
                 type.setUnsafeAllocated();
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/hub/DynamicHub.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/hub/DynamicHub.java
@@ -709,7 +709,7 @@ private ReflectionMetadata reflectionMetadata() {
     }
 
     private void checkClassFlag(int mask, String methodName) {
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             traceClassFlagQuery(mask);
         }
         if (throwMissingRegistrationErrors() && !(isClassFlagSet(mask) && getConditions().satisfied())) {
@@ -1315,7 +1315,7 @@ private void checkField(String fieldName, Field field, boolean publicOnly) throw
         boolean throwMissingErrors = throwMissingRegistrationErrors();
         Class<?> clazz = DynamicHub.toClass(this);
 
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             traceFieldLookup(fieldName, field, publicOnly);
         }
 
@@ -1397,7 +1397,7 @@ private boolean checkExecutableExists(String methodName, Class<?>[] parameterTyp
         boolean throwMissingErrors = throwMissingRegistrationErrors();
         Class<?> clazz = DynamicHub.toClass(this);
 
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             traceMethodLookup(methodName, parameterTypes, method, publicOnly);
         }
 
@@ -1973,7 +1973,7 @@ public DynamicHub arrayType() {
         if (toClass(this) == void.class) {
             throw new UnsupportedOperationException(new IllegalArgumentException());
         }
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             MetadataTracer.singleton().traceReflectionType(arrayTypeName());
         }
         if (companion.arrayHub == null) {
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/JavaIOSubstitutions.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/JavaIOSubstitutions.java
@@ -65,7 +65,7 @@ static ObjectStreamClass lookup(Class<?> cl, boolean all) {
         }
 
         if (Serializable.class.isAssignableFrom(cl) && !cl.isArray()) {
-            if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+            if (MetadataTracer.enabled()) {
                 MetadataTracer.singleton().traceSerializationType(cl.getName());
             }
             if (!DynamicHub.fromClass(cl).isRegisteredForSerialization()) {
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/JavaLangReflectSubstitutions.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/JavaLangReflectSubstitutions.java
@@ -387,7 +387,7 @@ private static void set(Object a, int index, Object value) {
     @Substitute
     private static Object newArray(Class<?> componentType, int length)
                     throws NegativeArraySizeException {
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             MetadataTracer.singleton().traceReflectionType(componentType.arrayType().getName());
         }
         return KnownIntrinsics.unvalidatedNewArray(componentType, length);
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/Resources.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/Resources.java
@@ -498,7 +498,7 @@ public static ResourceStorageEntryBase getAtRuntime(Module module, String resour
 
     @AlwaysInline("tracing should fold away when disabled")
     private static void traceResource(String resourceName, String moduleName) {
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             MetadataTracer.singleton().traceResource(resourceName, moduleName);
         }
     }
@@ -510,7 +510,7 @@ private static void traceResourceMissingMetadata(String resourceName, String mod
 
     @AlwaysInline("tracing should fold away when disabled")
     private static void traceResourceMissingMetadata(String resourceName, String moduleName, boolean probe) {
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled() && !probe) {
+        if (MetadataTracer.enabled() && !probe) {
             // Do not trace missing metadata for probing queries, otherwise we'll trace an entry for
             // every module. The caller is responsible for tracing missing entries if it uses
             // probing.
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/localization/LocalizationSupport.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/localization/LocalizationSupport.java
@@ -294,7 +294,7 @@ public boolean isRegisteredBundleLookup(String baseName, Locale locale, Object c
             /* Those cases will throw a NullPointerException before any lookup */
             return true;
         }
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             MetadataTracer.singleton().traceResourceBundle(baseName);
         }
         if (registeredBundles.containsKey(baseName)) {
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jni/access/JNIReflectionDictionary.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jni/access/JNIReflectionDictionary.java
@@ -184,7 +184,7 @@ public static Class<?> getClassObjectByName(CharSequence name) {
             JNIAccessibleClass clazz = dictionary.classesByName.get(name);
             if (clazz == null && !ClassNameSupport.isValidJNIName(name.toString())) {
                 clazz = NEGATIVE_CLASS_LOOKUP;
-            } else if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+            } else if (MetadataTracer.enabled()) {
                 // trace if class exists (positive query) or name is valid (negative query)
                 MetadataTracer.singleton().traceJNIType(ClassNameSupport.jniNameToTypeName(name.toString()));
             }
@@ -273,7 +273,7 @@ public static JNIMethodId getDeclaredMethodID(Class<?> classObject, JNIAccessibl
     }
 
     private static JNIAccessibleMethod getDeclaredMethod(Class<?> classObject, JNIAccessibleMethodDescriptor descriptor, String dumpLabel) {
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             ConfigurationType clazzType = MetadataTracer.singleton().traceJNIType(classObject.getName());
             if (clazzType != null) {
                 clazzType.addMethod(descriptor.getNameConvertToString(), descriptor.getSignatureConvertToString(), ConfigurationMemberInfo.ConfigurationMemberDeclaration.DECLARED);
@@ -334,7 +334,7 @@ private static JNIAccessibleMethod checkMethod(JNIAccessibleMethod method, Class
     }
 
     private static JNIAccessibleField getDeclaredField(Class<?> classObject, CharSequence name, boolean isStatic, String dumpLabel) {
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             ConfigurationType clazzType = MetadataTracer.singleton().traceJNIType(classObject.getName());
             if (clazzType != null) {
                 clazzType.addField(name.toString(), ConfigurationMemberInfo.ConfigurationMemberDeclaration.DECLARED, false);
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/metadata/MetadataTracer.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/metadata/MetadataTracer.java
@@ -44,6 +44,7 @@
 import com.oracle.svm.configure.config.ConfigurationFileCollection;
 import com.oracle.svm.configure.config.ConfigurationSet;
 import com.oracle.svm.configure.config.ConfigurationType;
+import com.oracle.svm.core.AlwaysInline;
 import com.oracle.svm.core.SubstrateUtil;
 import com.oracle.svm.core.feature.AutomaticallyRegisteredFeature;
 import com.oracle.svm.core.feature.InternalFeature;
@@ -56,7 +57,6 @@
 import com.oracle.svm.core.thread.VMOperation;
 import com.oracle.svm.core.util.VMError;
 
-import jdk.graal.compiler.api.replacements.Fold;
 import jdk.graal.compiler.options.Option;
 import jdk.graal.compiler.options.OptionStability;
 
@@ -97,15 +97,32 @@ public static class Options {
      */
     private volatile ConfigurationSet config;
 
-    @Fold
+    /**
+     * Returns the singleton object, which is only available if tracing is enabled at build time.
+     * <p>
+     * We use {@code @AlwaysInline} and not {@code @Fold} because the latter eagerly evaluates the
+     * method, which fails when the singleton is unavailable.
+     */
+    @AlwaysInline("avoid null check on singleton")
     public static MetadataTracer singleton() {
         return ImageSingletons.lookup(MetadataTracer.class);
     }
 
+    /**
+     * Returns whether tracing is enabled. Tracing code should be guarded by this condition.
+     * <p>
+     * This condition is force-inlined so that when tracing support is not included at build time
+     * the condition folds to false and the tracing code itself will fold away.
+     */
+    @AlwaysInline("tracing should fold away when disabled")
+    public static boolean enabled() {
+        return Options.MetadataTracingSupport.getValue() && singleton().enabledAtRunTime();
+    }
+
     /**
      * Returns whether tracing is enabled at run time (using {@code -XX:RecordMetadata}).
      */
-    public boolean enabled() {
+    private boolean enabledAtRunTime() {
         VMError.guarantee(Options.MetadataTracingSupport.getValue());
         return options != null;
     }
@@ -140,7 +157,7 @@ public void traceProxyType(List<String> interfaceNames) {
     }
 
     private ConfigurationType traceReflectionTypeImpl(ConfigurationTypeDescriptor typeDescriptor) {
-        assert enabled();
+        assert enabledAtRunTime();
         ConfigurationSet configurationSet = getConfigurationSetForTracing();
         if (configurationSet != null) {
             return configurationSet.getReflectionConfiguration().getOrCreateType(UnresolvedConfigurationCondition.alwaysTrue(), typeDescriptor);
@@ -155,7 +172,7 @@ private ConfigurationType traceReflectionTypeImpl(ConfigurationTypeDescriptor ty
      *         (e.g., during shutdown).
      */
     public ConfigurationType traceJNIType(String className) {
-        assert enabled();
+        assert enabledAtRunTime();
         ConfigurationType result = traceReflectionType(className);
         if (result != null) {
             result.setJniAccessible();
@@ -168,7 +185,7 @@ public ConfigurationType traceJNIType(String className) {
      * trace resource lookups covered by image metadata (including negative queries).
      */
     public void traceResource(String resourceName, String moduleName) {
-        assert enabled();
+        assert enabledAtRunTime();
         ConfigurationSet configurationSet = getConfigurationSetForTracing();
         if (configurationSet != null) {
             configurationSet.getResourceConfiguration().addGlobPattern(UnresolvedConfigurationCondition.alwaysTrue(), resourceName, moduleName);
@@ -179,7 +196,7 @@ public void traceResource(String resourceName, String moduleName) {
      * Marks the given resource bundle within the given locale as reachable.
      */
     public void traceResourceBundle(String baseName) {
-        assert enabled();
+        assert enabledAtRunTime();
         ConfigurationSet configurationSet = getConfigurationSetForTracing();
         if (configurationSet != null) {
             configurationSet.getResourceConfiguration().addBundle(UnresolvedConfigurationCondition.alwaysTrue(), baseName, List.of());
@@ -190,7 +207,7 @@ public void traceResourceBundle(String baseName) {
      * Marks the given type as serializable.
      */
     public void traceSerializationType(String className) {
-        assert enabled();
+        assert enabledAtRunTime();
         ConfigurationType result = traceReflectionType(className);
         if (result != null) {
             result.setSerializable();
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/reflect/proxy/DynamicProxySupport.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/reflect/proxy/DynamicProxySupport.java
@@ -191,7 +191,7 @@ private static ClassLoader getCommonClassLoaderOrFail(ClassLoader loader, Class<
 
     @Override
     public Class<?> getProxyClass(ClassLoader loader, Class<?>... interfaces) {
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+        if (MetadataTracer.enabled()) {
             List<String> interfaceNames = new ArrayList<>(interfaces.length);
             for (Class<?> iface : interfaces) {
                 interfaceNames.add(iface.getName());
diff --git a/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/reflect/serialize/SerializationSupport.java b/substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/reflect/serialize/SerializationSupport.java
@@ -267,7 +267,7 @@ public static Object getSerializationConstructorAccessor(Class<?> serializationT
                 return constructorAccessor;
             }
         } else {
-            if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+            if (MetadataTracer.enabled()) {
                 MetadataTracer.singleton().traceSerializationType(declaringClass.getName());
             }
             for (var singleton : layeredSingletons()) {

Original file line number	Diff line number	Diff line change
`@@ -709,7 +709,7 @@ private ReflectionMetadata reflectionMetadata() {`
`709`	`709`	`}`
`710`	`710`
`711`	`711`	`private void checkClassFlag(int mask, String methodName) {`
`712`		`- if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {`
	`712`	`+ if (MetadataTracer.enabled()) {`
`713`	`713`	`traceClassFlagQuery(mask);`
`714`	`714`	`}`
`715`	`715`	`if (throwMissingRegistrationErrors() && !(isClassFlagSet(mask) && getConditions().satisfied())) {`
`@@ -1315,7 +1315,7 @@ private void checkField(String fieldName, Field field, boolean publicOnly) throw`
`1315`	`1315`	`boolean throwMissingErrors = throwMissingRegistrationErrors();`
`1316`	`1316`	`Class<?> clazz = DynamicHub.toClass(this);`
`1317`	`1317`
`1318`		`- if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {`
	`1318`	`+ if (MetadataTracer.enabled()) {`
`1319`	`1319`	`traceFieldLookup(fieldName, field, publicOnly);`
`1320`	`1320`	`}`
`1321`	`1321`
`@@ -1397,7 +1397,7 @@ private boolean checkExecutableExists(String methodName, Class<?>[] parameterTyp`
`1397`	`1397`	`boolean throwMissingErrors = throwMissingRegistrationErrors();`
`1398`	`1398`	`Class<?> clazz = DynamicHub.toClass(this);`
`1399`	`1399`
`1400`		`- if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {`
	`1400`	`+ if (MetadataTracer.enabled()) {`
`1401`	`1401`	`traceMethodLookup(methodName, parameterTypes, method, publicOnly);`
`1402`	`1402`	`}`
`1403`	`1403`
`@@ -1973,7 +1973,7 @@ public DynamicHub arrayType() {`
`1973`	`1973`	`if (toClass(this) == void.class) {`
`1974`	`1974`	`throw new UnsupportedOperationException(new IllegalArgumentException());`
`1975`	`1975`	`}`
`1976`		`- if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {`
	`1976`	`+ if (MetadataTracer.enabled()) {`
`1977`	`1977`	`MetadataTracer.singleton().traceReflectionType(arrayTypeName());`
`1978`	`1978`	`}`
`1979`	`1979`	`if (companion.arrayHub == null) {`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ static ObjectStreamClass lookup(Class<?> cl, boolean all) {`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`if (Serializable.class.isAssignableFrom(cl) && !cl.isArray()) {`
`68`		`- if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {`
	`68`	`+ if (MetadataTracer.enabled()) {`
`69`	`69`	`MetadataTracer.singleton().traceSerializationType(cl.getName());`
`70`	`70`	`}`
`71`	`71`	`if (!DynamicHub.fromClass(cl).isRegisteredForSerialization()) {`
Original file line number	Diff line number	Diff line change
`@@ -387,7 +387,7 @@ private static void set(Object a, int index, Object value) {`
`387`	`387`	`@Substitute`
`388`	`388`	`private static Object newArray(Class<?> componentType, int length)`
`389`	`389`	`throws NegativeArraySizeException {`
`390`		`- if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {`
	`390`	`+ if (MetadataTracer.enabled()) {`
`391`	`391`	`MetadataTracer.singleton().traceReflectionType(componentType.arrayType().getName());`
`392`	`392`	`}`
`393`	`393`	`return KnownIntrinsics.unvalidatedNewArray(componentType, length);`
Original file line number	Diff line number	Diff line change
`@@ -294,7 +294,7 @@ public boolean isRegisteredBundleLookup(String baseName, Locale locale, Object c`
`294`	`294`	`/* Those cases will throw a NullPointerException before any lookup */`
`295`	`295`	`return true;`
`296`	`296`	`}`
`297`		`- if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {`
	`297`	`+ if (MetadataTracer.enabled()) {`
`298`	`298`	`MetadataTracer.singleton().traceResourceBundle(baseName);`
`299`	`299`	`}`
`300`	`300`	`if (registeredBundles.containsKey(baseName)) {`
Original file line number	Diff line number	Diff line change
`@@ -267,7 +267,7 @@ public static Object getSerializationConstructorAccessor(Class<?> serializationT`
`267`	`267`	`return constructorAccessor;`
`268`	`268`	`}`
`269`	`269`	`} else {`
`270`		`- if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {`
	`270`	`+ if (MetadataTracer.enabled()) {`
`271`	`271`	`MetadataTracer.singleton().traceSerializationType(declaringClass.getName());`
`272`	`272`	`}`
`273`	`273`	`for (var singleton : layeredSingletons()) {`