Fix: Properly trace "accessed" members; report missing registration errors for constructors & fields

Author: DSouzaM

substratevm/src/com.oracle.svm.configure/src/com/oracle/svm/configure/config/SignatureUtil.java

@@ -80,6 +80,19 @@ public static String toInternalSignature(List<?> parameterTypes) {
         return sb.append(')').toString();
     }
 
+    public static String toInternalSignature(Class<?>[] parameters) {
+        List<String> names;
+        if (parameters == null) {
+            names = List.of();
+        } else {
+            names = new ArrayList<>(parameters.length);
+            for (Class<?> parameter : parameters) {
+                names.add(parameter.getName());
+            }
+        }
+        return toInternalSignature(names);
+    }
+
     public static String toInternalClassName(String qualifiedForNameString) {
         assert qualifiedForNameString.indexOf('/') == -1 : "Requires qualified Java name, not internal representation";
         assert !qualifiedForNameString.endsWith("[]") : "Requires Class.forName syntax, for example '[Ljava.lang.String;'";

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

@@ -24,7 +24,6 @@
  */
 package com.oracle.svm.core.hub;
 
-import static com.oracle.svm.configure.config.ConfigurationMemberInfo.ConfigurationMemberAccessibility;
 import static com.oracle.svm.configure.config.ConfigurationMemberInfo.ConfigurationMemberDeclaration;
 import static com.oracle.svm.core.MissingRegistrationUtils.throwMissingRegistrationErrors;
 import static com.oracle.svm.core.Uninterruptible.CALLED_FROM_UNINTERRUPTIBLE_CODE;
@@ -91,8 +90,6 @@
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
 
-import com.oracle.svm.configure.ConfigurationTypeDescriptor;
-import com.oracle.svm.configure.config.ConfigurationType;
 import com.oracle.svm.configure.config.SignatureUtil;
 import com.oracle.svm.core.BuildPhaseProvider.AfterHostedUniverse;
 import com.oracle.svm.core.BuildPhaseProvider.CompileQueueFinished;
@@ -762,7 +759,7 @@ private ReflectionMetadata reflectionMetadata() {
 
     private void checkClassFlag(int mask, String methodName) {
         if (MetadataTracer.enabled()) {
-            traceClassFlagQuery(mask);
+            MetadataTracer.singleton().traceReflectionType(toClass(this));
         }
         if (throwMissingRegistrationErrors() && !(isClassFlagSet(mask) && getConditions().satisfied())) {
             MissingReflectionRegistrationUtils.reportClassQuery(DynamicHub.toClass(this), methodName);
@@ -786,30 +783,6 @@ private static boolean isClassFlagSet(int mask, ReflectionMetadata reflectionMet
         return reflectionMetadata != null && (reflectionMetadata.classFlags & mask) != 0;
     }
 
-    private void traceClassFlagQuery(int mask) {
-        ConfigurationType type = MetadataTracer.singleton().traceReflectionTypeImpl(ConfigurationTypeDescriptor.fromClass(toClass(this)));
-        if (type == null) {
-            return;
-        }
-        // TODO (GR-64765): We over-approximate member accessibility here because we don't trace
-        // accesses. Once we trace accesses, it will suffice to register the class for reflection.
-        switch (mask) {
-            case ALL_FIELDS_FLAG -> type.setAllPublicFields(ConfigurationMemberAccessibility.ACCESSED);
-            case ALL_DECLARED_FIELDS_FLAG -> type.setAllDeclaredFields(ConfigurationMemberAccessibility.ACCESSED);
-            case ALL_METHODS_FLAG -> type.setAllPublicMethods(ConfigurationMemberAccessibility.ACCESSED);
-            case ALL_DECLARED_METHODS_FLAG -> type.setAllDeclaredMethods(ConfigurationMemberAccessibility.ACCESSED);
-            case ALL_CONSTRUCTORS_FLAG -> type.setAllPublicConstructors(ConfigurationMemberAccessibility.ACCESSED);
-            case ALL_DECLARED_CONSTRUCTORS_FLAG -> type.setAllDeclaredConstructors(ConfigurationMemberAccessibility.ACCESSED);
-            case ALL_CLASSES_FLAG -> type.setAllPublicClasses();
-            case ALL_DECLARED_CLASSES_FLAG -> type.setAllDeclaredClasses();
-            case ALL_RECORD_COMPONENTS_FLAG -> type.setAllRecordComponents();
-            case ALL_PERMITTED_SUBCLASSES_FLAG -> type.setAllPermittedSubclasses();
-            case ALL_NEST_MEMBERS_FLAG -> type.setAllNestMembers();
-            case ALL_SIGNERS_FLAG -> type.setAllSigners();
-            default -> throw VMError.shouldNotReachHere("unknown class flag " + mask);
-        }
-    }
-
     /** Executed at runtime. */
     private static Object initEnumConstantsAtRuntime(Method values) {
         try {
@@ -1397,13 +1370,13 @@ private void checkField(String fieldName, Field field, boolean publicOnly) throw
     private void traceFieldLookup(String fieldName, Field field, boolean publicOnly) {
         ConfigurationMemberDeclaration declaration = publicOnly ? ConfigurationMemberDeclaration.PRESENT : ConfigurationMemberDeclaration.DECLARED;
         if (field != null) {
-            // register declaring type and field
-            MetadataTracer.singleton().traceField(field.getDeclaringClass(), fieldName, declaration);
+            // register declaring type (registers all fields for lookup)
+            MetadataTracer.singleton().traceReflectionType(field.getDeclaringClass());
             // register receiver type
             MetadataTracer.singleton().traceReflectionType(toClass(this));
         } else {
             // register receiver type and negative field query
-            MetadataTracer.singleton().traceField(toClass(this), fieldName, declaration);
+            MetadataTracer.singleton().traceFieldAccess(toClass(this), fieldName, declaration);
         }
     }
 
@@ -1476,28 +1449,14 @@ private boolean checkExecutableExists(String methodName, Class<?>[] parameterTyp
     private void traceMethodLookup(String methodName, Class<?>[] parameterTypes, Executable method, boolean publicOnly) {
         ConfigurationMemberDeclaration declaration = publicOnly ? ConfigurationMemberDeclaration.PRESENT : ConfigurationMemberDeclaration.DECLARED;
         if (method != null) {
-            // register declaring type and method
-            // TODO (GR-64765) loosen to queried accessibility once method invocations are traced
-            MetadataTracer.singleton().traceMethod(method.getDeclaringClass(), methodName, toInternalSignature(parameterTypes), declaration, ConfigurationMemberAccessibility.ACCESSED);
+            // register declaring type (registers all methods for lookup)
+            MetadataTracer.singleton().traceReflectionType(method.getDeclaringClass());
             // register receiver type
             MetadataTracer.singleton().traceReflectionType(toClass(this));
         } else {
             // register receiver type and negative method query
-            MetadataTracer.singleton().traceMethod(toClass(this), methodName, toInternalSignature(parameterTypes), declaration, ConfigurationMemberAccessibility.QUERIED);
-        }
-    }
-
-    private static String toInternalSignature(Class<?>[] classes) {
-        List<String> names;
-        if (classes == null) {
-            names = List.of();
-        } else {
-            names = new ArrayList<>(classes.length);
-            for (Class<?> aClass : classes) {
-                names.add(aClass.getName());
-            }
+            MetadataTracer.singleton().traceMethodAccess(toClass(this), methodName, SignatureUtil.toInternalSignature(parameterTypes), declaration);
         }
-        return SignatureUtil.toInternalSignature(names);
     }
 
     private boolean allElementsRegistered(boolean publicOnly, int allDeclaredElementsFlag, int allPublicElementsFlag) {

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jni/access/JNIReflectionDictionary.java

@@ -274,9 +274,8 @@ public static JNIMethodId getDeclaredMethodID(Class<?> classObject, JNIAccessibl
     private static JNIAccessibleMethod getDeclaredMethod(Class<?> classObject, JNIAccessibleMethodDescriptor descriptor, String dumpLabel) {
         if (MetadataTracer.enabled()) {
             MetadataTracer.singleton().traceJNIType(classObject);
-            // TODO (GR-64765) loosen to queried accessibility once method invocations are traced
-            MetadataTracer.singleton().traceMethod(classObject, descriptor.getNameConvertToString(), descriptor.getSignatureConvertToString(),
-                            ConfigurationMemberInfo.ConfigurationMemberDeclaration.DECLARED, ConfigurationMemberInfo.ConfigurationMemberAccessibility.ACCESSED);
+            MetadataTracer.singleton().traceMethodAccess(classObject, descriptor.getNameConvertToString(), descriptor.getSignatureConvertToString(),
+                            ConfigurationMemberInfo.ConfigurationMemberDeclaration.DECLARED);
         }
         boolean foundClass = false;
         for (var dictionary : layeredSingletons()) {
@@ -335,7 +334,7 @@ private static JNIAccessibleMethod checkMethod(JNIAccessibleMethod method, Class
     private static JNIAccessibleField getDeclaredField(Class<?> classObject, CharSequence name, boolean isStatic, String dumpLabel) {
         if (MetadataTracer.enabled()) {
             MetadataTracer.singleton().traceJNIType(classObject);
-            MetadataTracer.singleton().traceField(classObject, name.toString(), ConfigurationMemberInfo.ConfigurationMemberDeclaration.DECLARED);
+            MetadataTracer.singleton().traceFieldAccess(classObject, name.toString(), ConfigurationMemberInfo.ConfigurationMemberDeclaration.DECLARED);
         }
         boolean foundClass = false;
         for (var dictionary : layeredSingletons()) {

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/metadata/MetadataTracer.java

@@ -197,9 +197,9 @@ public void traceReflectionArrayType(Class<?> componentClazz) {
     }
 
     /**
-     * Marks the given field as reachable from reflection.
+     * Marks the given field as accessible from reflection.
      */
-    public void traceField(Class<?> declaringClass, String fieldName, ConfigurationMemberInfo.ConfigurationMemberDeclaration declaration) {
+    public void traceFieldAccess(Class<?> declaringClass, String fieldName, ConfigurationMemberInfo.ConfigurationMemberDeclaration declaration) {
         ConfigurationTypeDescriptor typeDescriptor = ConfigurationTypeDescriptor.fromClass(declaringClass);
         ConfigurationType type = traceReflectionTypeImpl(typeDescriptor);
         if (type != null) {
@@ -209,15 +209,14 @@ public void traceField(Class<?> declaringClass, String fieldName, ConfigurationM
     }
 
     /**
-     * Marks the given method as reachable from reflection.
+     * Marks the given method as accessible from reflection.
      */
-    public void traceMethod(Class<?> declaringClass, String methodName, String internalSignature, ConfigurationMemberInfo.ConfigurationMemberDeclaration declaration,
-                    ConfigurationMemberInfo.ConfigurationMemberAccessibility accessibility) {
+    public void traceMethodAccess(Class<?> declaringClass, String methodName, String internalSignature, ConfigurationMemberInfo.ConfigurationMemberDeclaration declaration) {
         ConfigurationTypeDescriptor typeDescriptor = ConfigurationTypeDescriptor.fromClass(declaringClass);
         ConfigurationType type = traceReflectionTypeImpl(typeDescriptor);
         if (type != null) {
-            debugMethod(typeDescriptor, methodName, internalSignature, accessibility);
-            type.addMethod(methodName, internalSignature, declaration, accessibility);
+            debugMethod(typeDescriptor, methodName, internalSignature);
+            type.addMethod(methodName, internalSignature, declaration, ConfigurationMemberInfo.ConfigurationMemberAccessibility.ACCESSED);
         }
     }
 
@@ -242,13 +241,7 @@ public void traceProxyType(Class<?>[] interfaces) {
         traceReflectionTypeImpl(descriptor);
     }
 
-    /*
-     * TODO (GR-64765): This method should not be used outside of this class, but we need it for
-     * tracing class flag queries. Once class flag tracing is unnecessary, mark it private. We do
-     * not want to expose ConfigurationTypes to the caller, because they could perform further
-     * registration (e.g., of methods) which would not be traced by debug logging.
-     */
-    public ConfigurationType traceReflectionTypeImpl(ConfigurationTypeDescriptor typeDescriptor) {
+    private ConfigurationType traceReflectionTypeImpl(ConfigurationTypeDescriptor typeDescriptor) {
         assert enabledAtRunTime();
         if (isInternal(typeDescriptor)) {
             debug("type not registered for reflection (uses an internal interface)", typeDescriptor);
@@ -406,11 +399,11 @@ private void debugField(ConfigurationTypeDescriptor typeDescriptor, String field
     /**
      * Debug helper for methods. Avoids method name computations if debug logging is disabled.
      */
-    private void debugMethod(ConfigurationTypeDescriptor typeDescriptor, String methodName, String internalSignature, ConfigurationMemberInfo.ConfigurationMemberAccessibility accessibility) {
+    private void debugMethod(ConfigurationTypeDescriptor typeDescriptor, String methodName, String internalSignature) {
         if (debugWriter == null) {
             return;
         }
-        debug("method registered for reflection (" + accessibility.name().toLowerCase() + ")", typeDescriptor + "." + methodName + internalSignature);
+        debug("method registered for reflection", typeDescriptor + "." + methodName + internalSignature);
     }
 
     /**

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/methodhandles/Target_java_lang_invoke_MethodHandleNatives.java

@@ -52,6 +52,7 @@
 import com.oracle.svm.core.imagelayer.ImageLayerBuildingSupport;
 import com.oracle.svm.core.invoke.Target_java_lang_invoke_MemberName;
 import com.oracle.svm.core.layeredimagesingleton.MultiLayeredImageSingleton;
+import com.oracle.svm.core.reflect.UnsafeFieldUtil;
 import com.oracle.svm.core.reflect.target.Target_java_lang_reflect_Field;
 import com.oracle.svm.core.util.VMError;
 import com.oracle.svm.util.ReflectionUtil;
@@ -134,11 +135,7 @@ private static long objectFieldOffset(Target_java_lang_invoke_MemberName self) {
         if (self.intrinsic != null) {
             return -1L;
         }
-        int offset = SubstrateUtil.cast(self.reflectAccess, Target_java_lang_reflect_Field.class).offset;
-        if (offset == -1) {
-            throw unsupportedFeature("Trying to access field " + self.reflectAccess + " without registering it as unsafe accessed.");
-        }
-        return offset;
+        return UnsafeFieldUtil.getFieldOffset(SubstrateUtil.cast(self.reflectAccess, Target_java_lang_reflect_Field.class));
     }
 
     @Substitute
@@ -153,11 +150,7 @@ private static long staticFieldOffset(Target_java_lang_invoke_MemberName self) {
         if (self.intrinsic != null) {
             return -1L;
         }
-        int offset = SubstrateUtil.cast(self.reflectAccess, Target_java_lang_reflect_Field.class).offset;
-        if (offset == -1) {
-            throw unsupportedFeature("Trying to access field " + self.reflectAccess + " without registering it as unsafe accessed.");
-        }
-        return offset;
+        return UnsafeFieldUtil.getFieldOffset(SubstrateUtil.cast(self.reflectAccess, Target_java_lang_reflect_Field.class));
     }
 
     @Substitute

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/reflect/UnsafeFieldUtil.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2025, 2025, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package com.oracle.svm.core.reflect;
+
+import java.lang.reflect.Field;
+
+import com.oracle.svm.configure.config.ConfigurationMemberInfo;
+import com.oracle.svm.core.SubstrateUtil;
+import com.oracle.svm.core.metadata.MetadataTracer;
+import com.oracle.svm.core.reflect.target.Target_java_lang_reflect_AccessibleObject;
+import com.oracle.svm.core.reflect.target.Target_java_lang_reflect_Field;
+
+public class UnsafeFieldUtil {
+    public static long getFieldOffset(Target_java_lang_reflect_Field field) {
+        if (field == null) {
+            throw new NullPointerException();
+        }
+        if (MetadataTracer.enabled()) {
+            traceFieldAccess(SubstrateUtil.cast(field, Field.class));
+        }
+        int offset = field.root == null ? field.offset : field.root.offset;
+        boolean conditionsSatisfied = SubstrateUtil.cast(field, Target_java_lang_reflect_AccessibleObject.class).conditions.satisfied();
+        if (offset <= 0 || !conditionsSatisfied) {
+            throw MissingReflectionRegistrationUtils.reportAccessedField(SubstrateUtil.cast(field, Field.class));
+        }
+        return offset;
+    }
+
+    private static void traceFieldAccess(Field f) {
+        MetadataTracer.singleton().traceFieldAccess(f.getDeclaringClass(), f.getName(), ConfigurationMemberInfo.ConfigurationMemberDeclaration.DECLARED);
+    }
+}

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/reflect/target/ReflectionObjectFactory.java

@@ -68,7 +68,7 @@ public static Constructor<?> newConstructor(RuntimeConditionSet conditions, Clas
                     byte[] annotations, byte[] parameterAnnotations, Object accessor, byte[] rawParameters, byte[] typeAnnotations) {
         Target_java_lang_reflect_Constructor ctor = new Target_java_lang_reflect_Constructor();
         ctor.constructor(declaringClass, parameterTypes, exceptionTypes, modifiers, -1, signature, annotations, parameterAnnotations);
-        ctor.constructorAccessor = (Target_jdk_internal_reflect_ConstructorAccessor) accessor;
+        ctor.constructorAccessorFromMetadata = (Target_jdk_internal_reflect_ConstructorAccessor) accessor;
         SubstrateUtil.cast(ctor, Target_java_lang_reflect_Executable.class).rawParameters = rawParameters;
         Target_java_lang_reflect_AccessibleObject accessibleObject = SubstrateUtil.cast(ctor, Target_java_lang_reflect_AccessibleObject.class);
         accessibleObject.typeAnnotations = typeAnnotations;