[GR-41614] Move resource registration to beforeAnalysis phase

PullRequest: graal/14560

Author: dnestoro

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/hosted/RuntimeResourceAccess.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2022, 2023, 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
@@ -40,17 +40,16 @@
  */
 package org.graalvm.nativeimage.hosted;
 
-import java.util.Arrays;
-import java.util.Locale;
-import java.util.Objects;
-import java.util.regex.Pattern;
-
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
 import org.graalvm.nativeimage.impl.ConfigurationCondition;
 import org.graalvm.nativeimage.impl.RuntimeResourceSupport;
 
+import java.util.Arrays;
+import java.util.Locale;
+import java.util.Objects;
+
 /**
  * This class can be used to register Java resources and ResourceBundles that should be accessible
  * at run time.
@@ -69,8 +68,7 @@ public final class RuntimeResourceAccess {
     public static void addResource(Module module, String resourcePath) {
         Objects.requireNonNull(module);
         Objects.requireNonNull(resourcePath);
-        ImageSingletons.lookup(RuntimeResourceSupport.class).addResources(ConfigurationCondition.alwaysTrue(),
-                        withModuleName(module, Pattern.quote(resourcePath)));
+        ImageSingletons.lookup(RuntimeResourceSupport.class).addResource(module, resourcePath);
     }
 
     /**

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/impl/ConfigurationCondition.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2021, 2023, 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
@@ -50,6 +50,10 @@ public static ConfigurationCondition alwaysTrue() {
         return OBJECT_REACHABLE;
     }
 
+    public static boolean isAlwaysTrue(ConfigurationCondition condition) {
+        return ConfigurationCondition.alwaysTrue().equals(condition);
+    }
+
     public static ConfigurationCondition create(String typeReachability) {
         Objects.requireNonNull(typeReachability);
         if (OBJECT_REACHABLE.typeName.equals(typeReachability)) {

sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/impl/RuntimeResourceSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2022, 2023, 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
@@ -46,6 +46,8 @@
 public interface RuntimeResourceSupport {
     void addResources(ConfigurationCondition condition, String pattern);
 
+    void addResource(Module module, String resourcePath);
+
     void injectResource(Module module, String resourcePath, byte[] resourceContent);
 
     void ignoreResources(ConfigurationCondition condition, String pattern);

substratevm/mx.substratevm/mx_substratevm.py

@@ -28,6 +28,7 @@
 import tempfile
 from glob import glob
 from contextlib import contextmanager
+from distutils.dir_util import mkpath  # pylint: disable=no-name-in-module
 from os.path import join, exists, dirname
 import pipes
 from argparse import ArgumentParser
@@ -475,9 +476,26 @@ def native_unittests_task(extra_build_args=None):
         # GR-24075
         mx_unittest.add_global_ignore_glob('com.oracle.svm.test.ProcessPropertiesTest')
 
+    # add resources that are not in jar but in the separate directory
+    cp_entry_name = join(svmbuild_dir(), 'cpEntryDir')
+    resources_from_dir = join(cp_entry_name, 'resourcesFromDir')
+    simple_dir = join(cp_entry_name, 'simpleDir')
+
+    mkpath(cp_entry_name)
+    mkpath(resources_from_dir)
+    mkpath(simple_dir)
+
+    for i in range(4):
+        with open(join(cp_entry_name, "resourcesFromDir", f'cond-resource{i}.txt'), 'w') as out:
+            out.write(f"Conditional file{i}" + '\n')
+
+        with open(join(cp_entry_name, "simpleDir", f'simple-resource{i}.txt'), 'w') as out:
+            out.write(f"Simple file{i}" + '\n')
+
     additional_build_args = svm_experimental_options([
         '-H:AdditionalSecurityProviders=com.oracle.svm.test.SecurityServiceTest$NoOpProvider',
         '-H:AdditionalSecurityServiceTypes=com.oracle.svm.test.SecurityServiceTest$JCACompliantNoOpService',
+        '-cp', cp_entry_name
     ])
     if extra_build_args is not None:
         additional_build_args += extra_build_args

substratevm/src/com.oracle.svm.configure.test/src/com/oracle/svm/configure/test/config/ResourceConfigurationTest.java

@@ -38,9 +38,10 @@
 import org.junit.Test;
 
 import com.oracle.svm.configure.config.ResourceConfiguration;
-import com.oracle.svm.core.util.json.JsonWriter;
 import com.oracle.svm.core.configure.ResourceConfigurationParser;
 import com.oracle.svm.core.configure.ResourcesRegistry;
+import com.oracle.svm.core.util.VMError;
+import com.oracle.svm.core.util.json.JsonWriter;
 
 public class ResourceConfigurationTest {
 
@@ -93,6 +94,11 @@ public void addResources(ConfigurationCondition condition, String pattern) {
                     addedResources.add(pattern);
                 }
 
+                @Override
+                public void addResource(Module module, String resourcePath) {
+                    throw VMError.shouldNotReachHere("Unused function.");
+                }
+
                 @Override
                 public void injectResource(Module module, String resourcePath, byte[] resourceContent) {
                 }

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

@@ -38,13 +38,13 @@
 import org.graalvm.nativeimage.impl.ConfigurationCondition;
 
 import com.oracle.svm.configure.ConfigurationBase;
-import com.oracle.svm.core.util.json.JsonPrinter;
-import com.oracle.svm.core.util.json.JsonWriter;
 import com.oracle.svm.core.configure.ConditionalElement;
 import com.oracle.svm.core.configure.ConfigurationParser;
 import com.oracle.svm.core.configure.ResourceConfigurationParser;
 import com.oracle.svm.core.configure.ResourcesRegistry;
 import com.oracle.svm.core.util.VMError;
+import com.oracle.svm.core.util.json.JsonPrinter;
+import com.oracle.svm.core.util.json.JsonWriter;
 
 public final class ResourceConfiguration extends ConfigurationBase<ResourceConfiguration, ResourceConfiguration.Predicate> {
 
@@ -63,6 +63,11 @@ public void addResources(ConfigurationCondition condition, String pattern) {
             configuration.addResourcePattern(condition, pattern);
         }
 
+        @Override
+        public void addResource(Module module, String resourcePath) {
+            throw VMError.shouldNotReachHere("Unused function.");
+        }
+
         @Override
         public void injectResource(Module module, String resourcePath, byte[] resourceContent) {
             VMError.shouldNotReachHere("Resource injection is only supported via Feature implementation");

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

@@ -25,14 +25,16 @@
 package com.oracle.svm.core;
 
 import java.io.IOException;
-import java.io.InputStream;
 import java.net.URI;
 import java.util.List;
 import java.util.Locale;
+import java.util.Map;
 import java.util.ResourceBundle;
+import java.util.Set;
 
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
+import org.graalvm.nativeimage.impl.ConfigurationCondition;
 
 @Platforms(Platform.HOSTED_ONLY.class)
 public abstract class ClassLoaderSupport {
@@ -51,12 +53,11 @@ public boolean isNativeImageClassLoader(ClassLoader classLoader) {
     protected abstract boolean isNativeImageClassLoaderImpl(ClassLoader classLoader);
 
     public interface ResourceCollector {
+        List<ConfigurationCondition> isIncluded(Module module, String resourceName, URI resourceURI);
 
-        boolean isIncluded(Module module, String resourceName, URI resourceURI);
+        void addResource(Module module, String resourceName);
 
-        void addResource(Module module, String resourceName, InputStream resourceStream, boolean fromJar);
-
-        void addDirectoryResource(Module module, String dir, String content, boolean fromJar);
+        void addResourceConditionally(Module module, String resourceName, ConfigurationCondition condition);
 
         void registerNegativeQuery(Module module, String resourceName);
 
@@ -66,4 +67,6 @@ public interface ResourceCollector {
     public abstract void collectResources(ResourceCollector resourceCollector);
 
     public abstract List<ResourceBundle> getResourceBundle(String bundleName, Locale locale);
+
+    public abstract Map<String, Set<Module>> getPackageToModules();
 }

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

@@ -166,7 +166,7 @@ private void updateTimeStamp() {
     }
 
     @Platforms(Platform.HOSTED_ONLY.class)
-    private ResourceStorageEntryBase addEntry(Module module, String resourceName, ResourceStorageEntryBase newEntry, boolean isDirectory, boolean fromJar) {
+    private void addEntry(Module module, String resourceName, boolean isDirectory, byte[] data, boolean fromJar, boolean isNegativeQuery) {
         VMError.guarantee(!BuildPhaseProvider.isAnalysisFinished(), "Trying to add a resource entry after analysis.");
         Module m = module != null && module.isNamed() ? module : null;
         if (m != null) {
@@ -175,58 +175,42 @@ private ResourceStorageEntryBase addEntry(Module module, String resourceName, Re
         synchronized (resources) {
             Pair<Module, String> key = createStorageKey(m, resourceName);
             ResourceStorageEntryBase entry = resources.get(key);
+            if (isNegativeQuery) {
+                if (entry == null) {
+                    resources.put(key, NEGATIVE_QUERY_MARKER);
+                }
+                return;
+            }
+
             if (entry == null || entry == NEGATIVE_QUERY_MARKER) {
-                entry = newEntry == null ? new ResourceStorageEntry(isDirectory, fromJar) : newEntry;
                 updateTimeStamp();
+                entry = new ResourceStorageEntry(isDirectory, fromJar);
                 resources.put(key, entry);
+            } else {
+                if (key.getLeft() != null) {
+                    // if the entry already exists, and it comes from a module, it is the same entry
+                    // that we registered at some point before
+                    return;
+                }
             }
-            return entry;
-        }
-    }
 
-    private void addEntry(Module module, String resourceName, boolean isDirectory, byte[] data, boolean fromJar) {
-        ResourceStorageEntryBase entry = addEntry(module, resourceName, null, isDirectory, fromJar);
-        entry.getData().add(data);
+            entry.getData().add(data);
+        }
     }
 
     @Platforms(Platform.HOSTED_ONLY.class)
     public static void registerResource(String resourceName, InputStream is) {
         singleton().registerResource(null, resourceName, is, true);
     }
 
-    @Platforms(Platform.HOSTED_ONLY.class)
-    public void registerResource(String resourceName, InputStream is, boolean fromJar) {
-        registerResource(null, resourceName, is, fromJar);
-    }
-
-    @Platforms(Platform.HOSTED_ONLY.class)
-    public void registerResource(Module module, String resourceName, InputStream is) {
-        registerResource(module, resourceName, is, true);
-    }
-
     @Platforms(Platform.HOSTED_ONLY.class)
     public void registerResource(Module module, String resourceName, byte[] resourceContent) {
-        addEntry(module, resourceName, false, resourceContent, true);
+        addEntry(module, resourceName, false, resourceContent, true, false);
     }
 
     @Platforms(Platform.HOSTED_ONLY.class)
     public void registerResource(Module module, String resourceName, InputStream is, boolean fromJar) {
-        addEntry(module, resourceName, false, inputStreamToByteArray(is), fromJar);
-    }
-
-    @Platforms(Platform.HOSTED_ONLY.class)
-    public void registerDirectoryResource(String resourceDirName, String content) {
-        registerDirectoryResource(null, resourceDirName, content, true);
-    }
-
-    @Platforms(Platform.HOSTED_ONLY.class)
-    public void registerDirectoryResource(String resourceDirName, String content, boolean fromJar) {
-        registerDirectoryResource(null, resourceDirName, content, fromJar);
-    }
-
-    @Platforms(Platform.HOSTED_ONLY.class)
-    public void registerDirectoryResource(Module module, String resourceDirName, String content) {
-        registerDirectoryResource(module, resourceDirName, content, true);
+        addEntry(module, resourceName, false, inputStreamToByteArray(is), fromJar, false);
     }
 
     @Platforms(Platform.HOSTED_ONLY.class)
@@ -236,21 +220,16 @@ public void registerDirectoryResource(Module module, String resourceDirName, Str
          * specified directory, separated with new line delimiter and joined into one string which
          * is later converted into a byte array and placed into the resources map.
          */
-        addEntry(module, resourceDirName, true, content.getBytes(), fromJar);
-    }
-
-    @Platforms(Platform.HOSTED_ONLY.class)
-    public void registerIOException(String resourceName, IOException e, boolean linkAtBuildTime) {
-        registerIOException(null, resourceName, e, linkAtBuildTime);
+        addEntry(module, resourceDirName, true, content.getBytes(), fromJar, false);
     }
 
     @Platforms(Platform.HOSTED_ONLY.class)
     public void registerIOException(Module module, String resourceName, IOException e, boolean linkAtBuildTime) {
         if (linkAtBuildTime) {
             if (SubstrateOptions.ThrowLinkAtBuildTimeIOExceptions.getValue()) {
-                throw new RuntimeException("Resource " + resourceName + " from module " + module.getName() + " produced an IOException.", e);
+                throw new RuntimeException("Resource " + resourceName + " from module " + moduleName(module) + " produced an IOException.", e);
             } else {
-                LogUtils.warning("Resource " + resourceName + " from module " + module.getName() + " produced the following IOException: " + e.getClass().getTypeName() + ": " + e.getMessage());
+                LogUtils.warning("Resource " + resourceName + " from module " + moduleName(module) + " produced the following IOException: " + e.getClass().getTypeName() + ": " + e.getMessage());
             }
         }
         Pair<Module, String> key = createStorageKey(module, resourceName);
@@ -267,7 +246,7 @@ public void registerNegativeQuery(String resourceName) {
 
     @Platforms(Platform.HOSTED_ONLY.class)
     public void registerNegativeQuery(Module module, String resourceName) {
-        addEntry(module, resourceName, NEGATIVE_QUERY_MARKER, false, false);
+        addEntry(module, resourceName, false, null, false, true);
     }
 
     @Platforms(Platform.HOSTED_ONLY.class)

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/localization/BundleContentSubstitutedLocalizationSupport.java

@@ -30,14 +30,15 @@
 import java.util.ListResourceBundle;
 import java.util.Locale;
 import java.util.Map;
+import java.util.Optional;
 import java.util.ResourceBundle;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ForkJoinPool;
+import java.util.function.Function;
 import java.util.regex.Pattern;
 import java.util.regex.PatternSyntaxException;
 
-import jdk.graal.compiler.debug.GraalError;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
 
@@ -49,6 +50,7 @@
 import com.oracle.svm.core.util.UserError;
 import com.oracle.svm.core.util.VMError;
 
+import jdk.graal.compiler.debug.GraalError;
 import sun.util.resources.OpenListResourceBundle;
 import sun.util.resources.ParallelListResourceBundle;
 
@@ -172,8 +174,8 @@ public boolean isNotIncluded(String bundleName) {
     }
 
     @Override
-    public void prepareBundle(String bundleName, ResourceBundle bundle, Locale locale) {
-        super.prepareBundle(bundleName, bundle, locale);
+    public void prepareBundle(String bundleName, ResourceBundle bundle, Function<String, Optional<Module>> findModule, Locale locale) {
+        super.prepareBundle(bundleName, bundle, findModule, locale);
         /* Initialize ResourceBundle.keySet eagerly */
         bundle.keySet();
         this.existingBundles.add(control.toBundleName(bundleName, locale));