Bugfixes

Author: loicottet

docs/reference-manual/native-image/BuildOutput.md

@@ -99,7 +99,7 @@ To reduce overhead, please ensure that the classpath only contains entries that
 
 #### <a name="glossary-reflection-registrations"></a>Reflection Registrations
 The number of classes, fields, and methods that are registered for reflection.
-Large numbers can cause significant reflection overheads, slow down the build process, and increase the size of the native image (see [method metadata](#glossary-method-metadata)).
+Large numbers can cause significant reflection overheads, slow down the build process, and increase the size of the native image (see [reflection metadata](#glossary-reflection-metadata)).
 
 #### <a name="glossary-jni-access-registrations"></a>JNI Access Registrations
 The number of classes, fields, and methods that are registered for [JNI][doc_jni] access.
@@ -136,16 +136,16 @@ Therefore, reducing the number of [reachable methods](#glossary-reachability) al
 The image heap contains reachable objects such as static application data, metadata, and `byte[]` for different purposes.
 
 ##### <a name="glossary-general-heap-data"></a>General Heap Data Stored in `byte[]`
-The total size of all `byte[]` objects that are neither used for `java.lang.String`, nor [code metadata](#glossary-code-metadata), nor [method metadata](#glossary-method-metadata), nor [graph encodings](#glossary-graph-encodings).
+The total size of all `byte[]` objects that are neither used for `java.lang.String`, nor [code metadata](#glossary-code-metadata), nor [reflection metadata](#glossary-reflection-metadata), nor [graph encodings](#glossary-graph-encodings).
 Therefore, this can also include `byte[]` objects from application code.
 
 ##### <a name="glossary-code-metadata"></a>Code Metadata Stored in `byte[]`
 The total size of all `byte[]` objects used for metadata for the [code area](#glossary-code-area).
 Therefore, reducing the number of [reachable methods](#glossary-reachability) also reduces the size of this metadata.
 
-##### <a name="glossary-method-metadata"></a>Method Metadata Stored in `byte[]`
-The total size of all `byte[]` objects used for method metadata, a type of reflection metadata.
-To reduce the amount of method metadata, reduce the number of [classes registered for reflection](#glossary-reflection-classes).
+##### <a name="glossary-reflection-metadata"></a>Reflection Metadata Stored in `byte[]`
+The total size of all `byte[]` objects used for reflection metadata, including class, field, method and constructor data.
+To reduce the amount of reflection metadata, reduce the number of [elements registered for reflection](#glossary-reflection-registrations).
 
 ##### <a name="glossary-graph-encodings"></a>Graph Encodings Stored in `byte[]`
 The total size of all `byte[]` objects used for graph encodings.

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/c/CContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * The Universal Permissive License (UPL), Version 1.0
@@ -47,6 +47,8 @@
 import java.util.Collections;
 import java.util.List;
 
+import org.graalvm.nativeimage.Platform;
+import org.graalvm.nativeimage.Platforms;
 import org.graalvm.nativeimage.c.function.CLibrary;
 
 /**
@@ -58,6 +60,7 @@
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE})
+@Platforms(Platform.HOSTED_ONLY.class)
 public @interface CContext {
 
     /**

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

@@ -720,6 +720,11 @@ protected void onValueUpdate(EconomicMap<OptionKey<?>, Object> values, String ol
         }
     };
 
+    @SuppressWarnings("unused")//
+    @APIOption(name = "configure-reflection-metadata")//
+    @Option(help = "Enable runtime instantiation of reflection objects for non-invoked methods.", type = OptionType.Expert, deprecated = true)//
+    public static final HostedOptionKey<Boolean> ConfigureReflectionMetadata = new HostedOptionKey<>(true);
+
     @Option(help = "Include a list of methods included in the image for runtime inspection.", type = OptionType.Expert)//
     public static final HostedOptionKey<Boolean> IncludeMethodData = new HostedOptionKey<>(true);
 

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

@@ -33,6 +33,7 @@
 import java.lang.reflect.AnnotatedElement;
 import java.lang.reflect.AnnotatedType;
 import java.lang.reflect.Constructor;
+import java.lang.reflect.Executable;
 import java.lang.reflect.Field;
 import java.lang.reflect.GenericDeclaration;
 import java.lang.reflect.InvocationTargetException;
@@ -341,6 +342,7 @@ public void setModule(Module module) {
     @TargetElement(onlyWith = JDK17OrLater.class)//
     @UnknownPrimitiveField int recordComponentsEncodingIndex;
 
+    @TargetElement(onlyWith = JDK17OrLater.class)//
     @UnknownPrimitiveField int permittedSubclassesEncodingIndex;
 
     @Platforms(Platform.HOSTED_ONLY.class)
@@ -1034,6 +1036,9 @@ private static ReflectionFactory getReflectionFactory() {
     @KeepOriginal
     private static native Field searchFields(Field[] fields, String name);
 
+    /**
+     * @see #filterHidingMethods(Method...)
+     */
     @Substitute
     private static Method searchMethods(Method[] allMethods, String name, Class<?>[] parameterTypes) {
         Method[] methods = filterHidingMethods(allMethods);
@@ -1057,6 +1062,9 @@ private static Method searchMethods(Method[] allMethods, String name, Class<?>[]
     @KeepOriginal
     private static native Field[] copyFields(Field[] arg);
 
+    /**
+     * @see #filterHidingMethods(Method...)
+     */
     @Substitute
     private static Method[] copyMethods(Method[] original) {
         Method[] arg = filterHidingMethods(original);
@@ -1235,6 +1243,9 @@ private String getSimpleBinaryName0() {
         /* See open/src/hotspot/share/prims/jvm.cpp#1522. */
     }
 
+    /**
+     * @see #filterHidingMethods(Method...)
+     */
     @Substitute //
     @SuppressWarnings({"unused"})
     List<Method> getDeclaredPublicMethods(String methodName, Class<?>... parameterTypes) {
@@ -1476,6 +1487,14 @@ private Class<?>[] getPermittedSubclasses0() {
     @KeepOriginal
     native AnnotationType getAnnotationType();
 
+    @KeepOriginal
+    static native byte[] getExecutableTypeAnnotationBytes(Executable ex);
+
+    /*
+     * We need to filter out hiding methods at the last moment. This ensures that the JDK internals
+     * see them as regular methods and ensure the visibility of methods is correct, but they should
+     * not be returned to application code.
+     */
     private static Method[] filterHidingMethods(Method... methods) {
         List<Method> filtered = new ArrayList<>();
         for (Method method : methods) {
@@ -1510,6 +1529,13 @@ private static AnnotationType getAnnotationType(DynamicHub that) {
     private static class CachedConstructorAccessors {
         @SuppressWarnings("unused")
         private static Constructor<?> getCachedConstructor(DynamicHub that) {
+            /*
+             * The JavaDoc for the Class.newInstance method states that "The class is initialized if
+             * it has not already been initialized". However, it doesn't specify if the absence of a
+             * nullary constructor will result in an InstantiationException before the class is
+             * initialized. We eagerly initialize the class to conform with JCK tests.
+             */
+            that.ensureInitialized();
             return that.companion.getCachedConstructor();
         }
 

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

@@ -24,16 +24,11 @@
  */
 package com.oracle.svm.core.hub;
 
-import java.lang.annotation.Annotation;
 import java.lang.reflect.AnnotatedType;
 import java.lang.reflect.GenericDeclaration;
 import java.lang.reflect.MalformedParameterizedTypeException;
 import java.lang.reflect.Type;
 
-import org.graalvm.compiler.core.common.SuppressFBWarnings;
-import org.graalvm.util.GuardedAnnotationAccess;
-
-import com.oracle.svm.core.SubstrateUtil;
 import com.oracle.svm.core.annotate.Alias;
 import com.oracle.svm.core.annotate.Inject;
 import com.oracle.svm.core.annotate.RecomputeFieldValue;
@@ -46,7 +41,6 @@
 import jdk.vm.ci.meta.ResolvedJavaField;
 import sun.reflect.generics.reflectiveObjects.TypeVariableImpl;
 import sun.reflect.generics.reflectiveObjects.WildcardTypeImpl;
-import sun.reflect.generics.tree.FieldTypeSignature;
 
 /**
  * The bounds in TypeVariableImpl and WildcardTypeImpl are lazily computed. We capture the value and
@@ -56,18 +50,13 @@
 @TargetClass(sun.reflect.generics.reflectiveObjects.TypeVariableImpl.class)
 final class Target_sun_reflect_generics_reflectiveObjects_TypeVariableImpl {
 
-    @Alias private String name;
-
     /* Cache the bounds value. */
 
     @Alias @RecomputeFieldValue(kind = Kind.Custom, declClass = TypeVariableBoundsComputer.class) //
     private Object[] bounds;
 
     @Alias GenericDeclaration genericDeclaration;
 
-    @Inject @RecomputeFieldValue(kind = Kind.Custom, declClass = TypeVariableAnnotationsComputer.class) //
-    Annotation[] annotations;
-
     @Inject @RecomputeFieldValue(kind = Kind.Custom, declClass = TypeVariableAnnotatedBoundsComputer.class) //
     AnnotatedType[] annotatedBounds;
 
@@ -82,31 +71,6 @@ public GenericDeclaration getGenericDeclaration() {
         return genericDeclaration;
     }
 
-    @Substitute
-    public Annotation[] getAnnotations() {
-        return annotations;
-    }
-}
-
-final class Util_sun_reflect_generics_reflectiveObjects_TypeVariableImpl {
-
-    /** Emulate the Java class hierarchy. */
-    static Target_sun_reflect_generics_reflectiveObjects_LazyReflectiveObjectGenerator asLazyReflectiveObjectGenerator(
-                    Target_sun_reflect_generics_reflectiveObjects_TypeVariableImpl typeVariableImpl) {
-        return SubstrateUtil.cast(typeVariableImpl, Target_sun_reflect_generics_reflectiveObjects_LazyReflectiveObjectGenerator.class);
-    }
-
-    /** Emulate virtual dispatch. */
-    static Type[] reifyBounds(Target_sun_reflect_generics_reflectiveObjects_TypeVariableImpl typeVariableImpl, FieldTypeSignature[] boundASTs) {
-        return asLazyReflectiveObjectGenerator(typeVariableImpl).reifyBounds(boundASTs);
-    }
-}
-
-@TargetClass(className = "sun.reflect.generics.reflectiveObjects.LazyReflectiveObjectGenerator")
-final class Target_sun_reflect_generics_reflectiveObjects_LazyReflectiveObjectGenerator {
-
-    @Alias
-    native Type[] reifyBounds(FieldTypeSignature[] boundASTs);
 }
 
 class TypeVariableBoundsComputer implements RecomputeFieldValue.CustomFieldValueComputer {
@@ -133,18 +97,6 @@ public Object compute(MetaAccessProvider metaAccess, ResolvedJavaField original,
     }
 }
 
-class TypeVariableAnnotationsComputer implements CustomFieldValueComputer {
-    @Override
-    public RecomputeFieldValue.ValueAvailability valueAvailability() {
-        return RecomputeFieldValue.ValueAvailability.BeforeAnalysis;
-    }
-
-    @Override
-    public Object compute(MetaAccessProvider metaAccess, ResolvedJavaField original, ResolvedJavaField annotated, Object receiver) {
-        return GuardedAnnotationAccess.getAnnotations((TypeVariableImpl<?>) receiver);
-    }
-}
-
 @TargetClass(sun.reflect.generics.reflectiveObjects.WildcardTypeImpl.class)
 final class Target_sun_reflect_generics_reflectiveObjects_WildcardTypeImpl {
 
@@ -157,26 +109,6 @@ final class Target_sun_reflect_generics_reflectiveObjects_WildcardTypeImpl {
     @Alias //
     @RecomputeFieldValue(kind = Kind.Custom, declClass = WildcardTypeImplLowerBoundsComputer.class) //
     private Object[] lowerBounds;
-
-    @Substitute
-    public Type[] getUpperBounds() {
-        Object[] value = upperBounds;
-        if (value instanceof FieldTypeSignature[]) {
-            value = Util_sun_reflect_generics_reflectiveObjects_WildcardTypeImpl.reifyBounds(this, (FieldTypeSignature[]) value);
-            upperBounds = value;
-        }
-        return (Type[]) value.clone();
-    }
-
-    @Substitute
-    public Type[] getLowerBounds() {
-        Object[] value = lowerBounds;
-        if (value instanceof FieldTypeSignature[]) {
-            value = Util_sun_reflect_generics_reflectiveObjects_WildcardTypeImpl.reifyBounds(this, (FieldTypeSignature[]) value);
-            lowerBounds = value;
-        }
-        return (Type[]) value.clone();
-    }
 }
 
 class WildcardTypeImplUpperBoundsComputer implements RecomputeFieldValue.CustomFieldValueComputer {
@@ -203,21 +135,6 @@ public Object compute(MetaAccessProvider metaAccess, ResolvedJavaField original,
     }
 }
 
-final class Util_sun_reflect_generics_reflectiveObjects_WildcardTypeImpl {
-
-    /** Emulate the Java class hierarchy. */
-    @SuppressFBWarnings(value = "BC", justification = "Widening cast between @TargetClasses")
-    static Target_sun_reflect_generics_reflectiveObjects_LazyReflectiveObjectGenerator asLazyReflectiveObjectGenerator(
-                    Target_sun_reflect_generics_reflectiveObjects_WildcardTypeImpl wildCardTypeImpl) {
-        return Target_sun_reflect_generics_reflectiveObjects_LazyReflectiveObjectGenerator.class.cast(wildCardTypeImpl);
-    }
-
-    /** Emulate virtual dispatch. */
-    static Type[] reifyBounds(Target_sun_reflect_generics_reflectiveObjects_WildcardTypeImpl wildCardTypeImpl, FieldTypeSignature[] boundASTs) {
-        return asLazyReflectiveObjectGenerator(wildCardTypeImpl).reifyBounds(boundASTs);
-    }
-}
-
 class GuardedBoundsAccess {
 
     static Type[] getLowerBounds(WildcardTypeImpl receiver) {

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/meta/ReadableJavaField.java

@@ -35,6 +35,7 @@ static JavaConstant readFieldValue(MetaAccessProvider metaAccess, ConstantReflec
         if (javaField instanceof ReadableJavaField) {
             ReadableJavaField readableField = (ReadableJavaField) javaField;
             if (!readableField.isValueAvailable()) {
+                assert !readableField.allowConstantFolding() && readableField.isUnknown();
                 return SubstrateObjectConstant.forObject(null);
             }
             return readableField.readValue(metaAccess, javaConstant);
@@ -64,4 +65,8 @@ static boolean injectFinalForRuntimeCompilation(ResolvedJavaField original) {
             return false;
         }
     }
+
+    default boolean isUnknown() {
+        return false;
+    }
 }

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

@@ -505,7 +505,7 @@ private Map<String, Long> calculateHeapBreakdown(Collection<ObjectInfo> heapObje
             }
             long metadataByteLength = ImageSingletons.lookup(ReflectionMetadataDecoder.class).getMetadataByteLength();
             if (metadataByteLength > 0) {
-                classNameToSize.put(BREAKDOWN_BYTE_ARRAY_PREFIX + linkStrategy.asDocLink("reflection metadata", "#glossary-method-metadata"), metadataByteLength);
+                classNameToSize.put(BREAKDOWN_BYTE_ARRAY_PREFIX + linkStrategy.asDocLink("reflection metadata", "#glossary-reflection-metadata"), metadataByteLength);
                 remainingBytes -= metadataByteLength;
             }
             if (graphEncodingByteLength > 0) {

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/heap/SVMImageHeapScanner.java

@@ -25,6 +25,7 @@
 package com.oracle.svm.hosted.heap;
 
 import java.lang.reflect.AccessibleObject;
+import java.lang.reflect.Executable;
 import java.lang.reflect.Field;
 import java.util.function.Consumer;
 
@@ -60,6 +61,7 @@ public class SVMImageHeapScanner extends ImageHeapScanner {
     private final Class<?> economicMapImpl;
     private final Field economicMapImplEntriesField;
     private final Field economicMapImplHashArrayField;
+    private final RuntimeReflectionSupport reflectionSupport;
 
     public SVMImageHeapScanner(ImageHeap imageHeap, ImageClassLoader loader, AnalysisMetaAccess metaAccess,
                     SnippetReflectionProvider snippetReflection, ConstantReflectionProvider aConstantReflection, ObjectScanningObserver aScanningObserver) {
@@ -69,6 +71,7 @@ public SVMImageHeapScanner(ImageHeap imageHeap, ImageClassLoader loader, Analysi
         economicMapImplEntriesField = ReflectionUtil.lookupField(economicMapImpl, "entries");
         economicMapImplHashArrayField = ReflectionUtil.lookupField(economicMapImpl, "hashArray");
         ImageSingletons.add(ImageHeapScanner.class, this);
+        reflectionSupport = ImageSingletons.lookup(RuntimeReflectionSupport.class);
     }
 
     public static ImageHeapScanner instance() {
@@ -143,8 +146,8 @@ protected void onObjectReachable(ImageHeapObject imageHeapObject) {
         super.onObjectReachable(imageHeapObject);
 
         Object object = SubstrateObjectConstant.asObject(imageHeapObject.getObject());
-        if (object instanceof AccessibleObject) {
-            ImageSingletons.lookup(RuntimeReflectionSupport.class).registerHeapReflectionObject((AccessibleObject) object);
+        if (object instanceof Field || object instanceof Executable) {
+            reflectionSupport.registerHeapReflectionObject((AccessibleObject) object);
         }
     }
 }

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/substitute/ComputedValueField.java

@@ -53,6 +53,8 @@
 import com.oracle.svm.core.annotate.RecomputeFieldValue.CustomFieldValueComputer;
 import com.oracle.svm.core.annotate.RecomputeFieldValue.CustomFieldValueProvider;
 import com.oracle.svm.core.annotate.RecomputeFieldValue.CustomFieldValueTransformer;
+import com.oracle.svm.core.annotate.UnknownObjectField;
+import com.oracle.svm.core.annotate.UnknownPrimitiveField;
 import com.oracle.svm.core.config.ConfigurationValues;
 import com.oracle.svm.core.meta.ReadableJavaField;
 import com.oracle.svm.core.util.UserError;
@@ -499,4 +501,9 @@ public String toString() {
     public Field getJavaField() {
         return OriginalFieldProvider.getJavaField(GraalAccess.getOriginalSnippetReflection(), original);
     }
+
+    @Override
+    public boolean isUnknown() {
+        return annotated.isAnnotationPresent(UnknownObjectField.class) || annotated.isAnnotationPresent(UnknownPrimitiveField.class);
+    }
 }