Future default class-for-name-respects-class-loader

Author: vjovanov

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

@@ -24,17 +24,7 @@
  */
 package com.oracle.svm.core;
 
-import java.util.Collections;
-import java.util.LinkedHashSet;
-import java.util.List;
-import java.util.Objects;
-import java.util.Set;
-import java.util.stream.Collectors;
-
-import org.graalvm.nativeimage.ImageInfo;
-import org.graalvm.nativeimage.Platform;
-import org.graalvm.nativeimage.Platforms;
-
+import com.oracle.svm.core.hub.ClassForNameSupport;
 import com.oracle.svm.core.option.APIOption;
 import com.oracle.svm.core.option.AccumulatingLocatableMultiOptionValue;
 import com.oracle.svm.core.option.HostedOptionKey;
@@ -43,9 +33,20 @@
 import com.oracle.svm.core.util.VMError;
 import com.oracle.svm.util.LogUtils;
 import com.oracle.svm.util.StringUtil;
-
 import jdk.graal.compiler.options.Option;
+import jdk.graal.compiler.options.OptionKey;
 import jdk.graal.compiler.options.OptionType;
+import org.graalvm.collections.EconomicMap;
+import org.graalvm.nativeimage.ImageInfo;
+import org.graalvm.nativeimage.Platform;
+import org.graalvm.nativeimage.Platforms;
+
+import java.util.Collections;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Objects;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 /**
  * Enables the --future-defaults=value flag that is used for evolution of Native Image semantics.
@@ -81,13 +82,14 @@ public class FutureDefaultsOptions {
     private static final String RUN_TIME_INITIALIZE_SECURITY_PROVIDERS = "run-time-initialize-security-providers";
     private static final String RUN_TIME_INITIALIZE_FILE_SYSTEM_PROVIDERS = "run-time-initialize-file-system-providers";
     private static final String RUN_TIME_INITIALIZE_RESOURCE_BUNDLES = "run-time-initialize-resource-bundles";
-    private static final List<String> ALL_FUTURE_DEFAULTS = List.of(RUN_TIME_INITIALIZE_FILE_SYSTEM_PROVIDERS, RUN_TIME_INITIALIZE_SECURITY_PROVIDERS, RUN_TIME_INITIALIZE_RESOURCE_BUNDLES);
+    private static final String CLASS_FOR_NAME_RESPECTS_CLASS_LOADER = "class-for-name-respects-class-loader";
+    private static final List<String> ALL_FUTURE_DEFAULTS = List.of(CLASS_FOR_NAME_RESPECTS_CLASS_LOADER, RUN_TIME_INITIALIZE_FILE_SYSTEM_PROVIDERS, RUN_TIME_INITIALIZE_SECURITY_PROVIDERS, RUN_TIME_INITIALIZE_RESOURCE_BUNDLES);
 
     private static final String COMPLETE_REFLECTION_TYPES = "complete-reflection-types";
     private static final List<String> RETIRED_FUTURE_DEFAULTS = List.of(COMPLETE_REFLECTION_TYPES);
 
-    public static final String RUN_TIME_INITIALIZE_FILE_SYSTEM_PROVIDERS_REASON = "Initialize JDK classes at run time (--" + OPTION_NAME + " includes " + RUN_TIME_INITIALIZE_FILE_SYSTEM_PROVIDERS +
-                    ")";
+    public static final String RUN_TIME_INITIALIZE_FILE_SYSTEM_PROVIDERS_REASON = "Initialize JDK classes at run time (--" + OPTION_NAME + " includes " + CLASS_FOR_NAME_RESPECTS_CLASS_LOADER +
+            ")";
     public static final String RUN_TIME_INITIALIZE_SECURITY_PROVIDERS_REASON = "Initialize JDK classes at run time (--" + OPTION_NAME + " includes " + RUN_TIME_INITIALIZE_SECURITY_PROVIDERS + ")";
     public static final String RUN_TIME_INITIALIZE_RESOURCE_BUNDLES_REASON = "Initialize JDK classes at run time (--" + OPTION_NAME + " includes " + RUN_TIME_INITIALIZE_RESOURCE_BUNDLES + ")";
     private static final String DEFAULT_NAME = "<default-value>";
@@ -107,12 +109,21 @@ private static LinkedHashSet<String> getAllValues() {
     @APIOption(name = OPTION_NAME, defaultValue = DEFAULT_NAME) //
     @Option(help = "file:doc-files/FutureDefaultsHelp.txt", type = OptionType.User) //
     static final HostedOptionKey<AccumulatingLocatableMultiOptionValue.Strings> FutureDefaults = new HostedOptionKey<>(
-                    AccumulatingLocatableMultiOptionValue.Strings.buildWithCommaDelimiter());
+            AccumulatingLocatableMultiOptionValue.Strings.buildWithCommaDelimiter()) {
+        @Override
+        protected void onValueUpdate(EconomicMap<OptionKey<?>, Object> values, AccumulatingLocatableMultiOptionValue.Strings oldValue, AccumulatingLocatableMultiOptionValue.Strings newValue) {
+            super.onValueUpdate(values, oldValue, newValue);
+            /* temporary simple pwdctest, will do full parsing */
+            if (newValue.values().contains("all") || newValue.values().contains(CLASS_FOR_NAME_RESPECTS_CLASS_LOADER)) {
+                ClassForNameSupport.Options.ClassForNameRespectsClassLoader.update(values, true);
+            }
+        }
+    };
 
     private static String getOptionHelpText() {
         Objects.requireNonNull(FutureDefaultsOptions.FutureDefaults.getDescriptor(), "This must be called after the options are processed.");
         return FutureDefaultsOptions.FutureDefaults.getDescriptor().getHelp().stream()
-                        .collect(Collectors.joining(System.lineSeparator()));
+                .collect(Collectors.joining(System.lineSeparator()));
     }
 
     private static void verifyOptionDescription() {
@@ -124,7 +135,14 @@ private static void verifyOptionDescription() {
             }
         }
         if (!optionHelpText.contains(futureDefaultsAllValues())) {
-            throw VMError.shouldNotReachHere("Must mention all options in a comma-separated sequence: " + futureDefaultsAllValues());
+            throw VMError.shouldNotReachHere("Must mention all options in a comma-separated in the exact order: " + futureDefaultsAllValues());
+        }
+
+        /* Ensure retired future-defaults are not mentioned in user-facing help text */
+        for (String retired : RETIRED_FUTURE_DEFAULTS) {
+            if (optionHelpText.contains("'" + retired + "'")) {
+                throw VMError.shouldNotReachHere("Must not mention retired options in the help text. Retired option: " + retired);
+            }
         }
     }
 
@@ -139,35 +157,35 @@ public static void parseAndVerifyOptions() {
             String value = valueWithOrigin.value();
             if (DEFAULT_NAME.equals(value)) {
                 throw UserError.abort("The '%s' from %s is forbidden. It can only contain: %s.%n%nUsage:%n%n%s",
-                                SubstrateOptionsParser.commandArgument(FutureDefaults, DEFAULT_NAME),
-                                valueWithOrigin.origin(),
-                                futureDefaultsAllValues(),
-                                getOptionHelpText());
+                        SubstrateOptionsParser.commandArgument(FutureDefaults, DEFAULT_NAME),
+                        valueWithOrigin.origin(),
+                        futureDefaultsAllValues(),
+                        getOptionHelpText());
             }
 
             if (RETIRED_FUTURE_DEFAULTS.contains(value)) {
                 LogUtils.warning("The '%s' option from %s contains the value '%s' which is enabled by default in this GraalVM release (%s) and can be removed.",
-                                SubstrateOptionsParser.commandArgument(FutureDefaults, value),
-                                valueWithOrigin.origin(),
-                                value,
-                                VM.getVersion());
+                        SubstrateOptionsParser.commandArgument(FutureDefaults, value),
+                        valueWithOrigin.origin(),
+                        value,
+                        VM.getVersion());
                 return;
             }
 
             if (!getAllValues().contains(value)) {
                 throw UserError.abort("The '%s' option from %s contains invalid value '%s'. It can only contain: %s.%n%nUsage:%n%n%s",
-                                SubstrateOptionsParser.commandArgument(FutureDefaults, value),
-                                valueWithOrigin.origin(),
-                                value,
-                                futureDefaultsAllValues(),
-                                getOptionHelpText());
+                        SubstrateOptionsParser.commandArgument(FutureDefaults, value),
+                        valueWithOrigin.origin(),
+                        value,
+                        futureDefaultsAllValues(),
+                        getOptionHelpText());
             }
 
             if (value.equals(NONE_NAME)) {
                 if (!valueWithOrigin.origin().commandLineLike()) {
                     throw UserError.abort("The '%s' option can only be used from the command line. Detected usage from %s.",
-                                    SubstrateOptionsParser.commandArgument(FutureDefaults, NONE_NAME),
-                                    valueWithOrigin.origin());
+                            SubstrateOptionsParser.commandArgument(FutureDefaults, NONE_NAME),
+                            valueWithOrigin.origin());
                 }
                 futureDefaults.clear();
             }
@@ -183,16 +201,16 @@ public static void parseAndVerifyOptions() {
 
         /* Set build-time properties for user features */
         for (String futureDefault : getFutureDefaults()) {
-            setSystemProperty(futureDefault, true);
+            setSystemProperty(futureDefault);
         }
 
         for (String retiredFutureDefault : RETIRED_FUTURE_DEFAULTS) {
-            setSystemProperty(retiredFutureDefault, true);
+            setSystemProperty(retiredFutureDefault);
         }
     }
 
-    private static void setSystemProperty(String futureDefault, boolean value) {
-        System.setProperty(FutureDefaultsOptions.SYSTEM_PROPERTY_PREFIX + futureDefault, Boolean.toString(value));
+    private static void setSystemProperty(String futureDefault) {
+        System.setProperty(FutureDefaultsOptions.SYSTEM_PROPERTY_PREFIX + futureDefault, Boolean.toString(true));
     }
 
     public static Set<String> getFutureDefaults() {

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/doc-files/FutureDefaultsHelp.txt

@@ -1,4 +1,4 @@
-Enable options that are planned to become defaults in future releases. Comma-separated list can contain 'all', 'none', 'run-time-initialize-jdk', 'run-time-initialize-file-system-providers', 'run-time-initialize-security-providers', 'run-time-initialize-resource-bundles', 'complete-reflection-types'. The preferred usage is '--future-defaults=all'.
+Enable options that are planned to become defaults in future releases. Comma-separated list can contain 'all', 'none', 'run-time-initialize-jdk', 'class-for-name-respects-class-loader', 'run-time-initialize-file-system-providers', 'run-time-initialize-security-providers', 'run-time-initialize-resource-bundles'. The preferred usage is '--future-defaults=all'.
 
 The meaning of each possible option is as follows:
   'all' - is the preferred option, and it enables all other behaviors.
@@ -7,10 +7,10 @@ The meaning of each possible option is as follows:
 
   'run-time-initialize-jdk' - enables all behaviors related to run-time initialization of the JDK: ['run-time-initialize-security-providers', 'run-time-initialize-file-system-providers', 'run-time-initialize-resource-bundles'].
 
-  'complete-reflection-types' - reflective registration of a type, via metadata files or the Feature API, always includes all type metadata. Now, all registered types behave the same as types defined in 'reachability-metadata.json'.
+  'class-for-name-respects-class-loader' - `Class.forName` and similar respect their class loader argument.
 
   'run-time-initialize-security-providers' - shifts away from build-time initialization for 'java.security.Provider'. Unless you store 'java.security.Provider'-related classes in the image heap, this option should not affect you. In case this option breaks your build, follow the suggestions in the error messages.
 
   'run-time-initialize-file-system-providers' - shifts away from build-time initialization for 'java.nio.file.spi.FileSystemProvider'. Unless you store 'FileSystemProvider'-related classes in the image heap, this option should not affect you. In case this option breaks your build, follow the suggestions in the error messages.
 
-  'run-time-initialize-resource-bundles' - shifts away from build-time initialization for 'java.util.ResourceBundle'. Unless you store 'ResourceBundle'-related classes in the image heap, this option should not affect you. In case this option breaks your build, follow the suggestions in the error messages.
+  'run-time-initialize-resource-bundles' - shifts away from build-time initialization for 'java.util.ResourceBundle'. Unless you store 'ResourceBundle'-related classes in the image heap, this option should not affect you. In case this option breaks your build, follow the suggestions in the error messages.

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

@@ -39,6 +39,7 @@
 import java.util.function.BooleanSupplier;
 import java.util.function.Consumer;
 
+import com.oracle.svm.core.FutureDefaultsOptions;
 import org.graalvm.collections.EconomicMap;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platform.HOSTED_ONLY;