Throw exception for missing resource metadata

Author: Zeavee

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

@@ -24,6 +24,7 @@
  */
 package com.oracle.svm.core;
 
+import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
 import java.util.List;
@@ -56,6 +57,10 @@ public interface ResourceCollector {
         void addResource(Module module, String resourceName, InputStream resourceStream, boolean fromJar);
 
         void addDirectoryResource(Module module, String dir, String content, boolean fromJar);
+
+        void registerNegativeQuery(Module module, String resourceName);
+
+        void registerIOException(Module module, String resourceName, IOException e);
     }
 
     public abstract void collectResources(ResourceCollector resourceCollector);

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

@@ -805,7 +805,7 @@ public Enum<?>[] getEnumConstantsShared() {
     @Substitute
     public InputStream getResourceAsStream(String resourceName) {
         String resolvedName = resolveName(resourceName);
-        return Resources.createInputStream(module, resolvedName);
+        return Resources.singleton().createInputStream(module, resolvedName);
     }
 
     @KeepOriginal

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

@@ -90,7 +90,7 @@ public static Resource nameToResource(String resourceName) {
     }
 
     public static Enumeration<Resource> nameToResources(String resourceName) {
-        Enumeration<URL> urls = Resources.createURLs(resourceName);
+        Enumeration<URL> urls = Resources.singleton().createURLs(resourceName);
         List<Resource> resourceURLs = new ArrayList<>();
         while (urls.hasMoreElements()) {
             resourceURLs.add(urlToResource(resourceName, urls.nextElement()));
@@ -99,11 +99,11 @@ public static Enumeration<Resource> nameToResources(String resourceName) {
     }
 
     public static URL nameToResourceURL(String resourceName) {
-        return Resources.createURL(resourceName);
+        return Resources.singleton().createURL(resourceName);
     }
 
     public static URL nameToResourceURL(Module module, String resourceName) {
-        return Resources.createURL(module, resourceName);
+        return Resources.singleton().createURL(module, resourceName);
     }
 
     public static InputStream nameToResourceInputStream(String resourceName) throws IOException {
@@ -112,7 +112,7 @@ public static InputStream nameToResourceInputStream(String resourceName) throws
     }
 
     public static List<URL> nameToResourceListURLs(String resourcesName) {
-        Enumeration<URL> urls = Resources.createURLs(resourcesName);
+        Enumeration<URL> urls = Resources.singleton().createURLs(resourcesName);
         List<URL> resourceURLs = new ArrayList<>();
         while (urls.hasMoreElements()) {
             resourceURLs.add(urls.nextElement());

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

@@ -47,8 +47,8 @@ private InputStream getResourceAsStream(String resourceName) {
         if (resName.startsWith("/")) {
             resName = resName.substring(1);
         }
-        ResourceStorageEntry res = Resources.get(SubstrateUtil.cast(this, Module.class), resName);
-        return res == null ? null : new ByteArrayInputStream(res.getData().get(0));
+        Object res = Resources.singleton().get(SubstrateUtil.cast(this, Module.class), resName, true);
+        return res == null ? null : new ByteArrayInputStream(((ResourceStorageEntry) res).getData().get(0));
     }
 
     @Substitute

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

@@ -0,0 +1,76 @@
+/*
+ * Copyright (c) 2023, 2023, 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.jdk.resources;
+
+import org.graalvm.compiler.options.Option;
+import org.graalvm.compiler.options.OptionType;
+
+import com.oracle.svm.core.option.HostedOptionKey;
+import com.oracle.svm.core.util.ExitStatus;
+
+public final class MissingResourceMetadataException extends RuntimeException {
+    private static final long serialVersionUID = 1L;
+
+    public static class Options {
+        @Option(help = "Enable termination caused by missing metadata.")//
+        public static final HostedOptionKey<Boolean> ExitOnMissingMetadata = new HostedOptionKey<>(false);
+
+        @Option(help = "Simulate exiting the program with an exception instead of calling System.exit() (for testing)")//
+        public static final HostedOptionKey<Boolean> ExitWithException = new HostedOptionKey<>(false);
+
+        @Option(help = "Throw Native Image-specific exceptions when encountering an unregistered reflection call.", type = OptionType.User)//
+        public static final HostedOptionKey<Boolean> ThrowMissingMetadataExceptions = new HostedOptionKey<>(false);
+    }
+
+    private MissingResourceMetadataException(String message) {
+        super(message);
+    }
+
+    public static MissingResourceMetadataException missingResource(String resourcePath) {
+        MissingResourceMetadataException exception = new MissingResourceMetadataException(
+                        "Resource at path " + resourcePath + " has not been registered as reachable. To ensure this resource is available at run time, you need to add it to the resource metadata.");
+        if (MissingResourceMetadataException.Options.ExitOnMissingMetadata.getValue()) {
+            exitOnMissingMetadata(exception);
+        }
+        return exception;
+    }
+
+    private static void exitOnMissingMetadata(MissingResourceMetadataException exception) {
+        if (Options.ExitWithException.getValue()) {
+            throw new ExitException(exception);
+        } else {
+            exception.printStackTrace(System.out);
+            System.exit(ExitStatus.MISSING_METADATA.getValue());
+        }
+    }
+
+    public static final class ExitException extends Error {
+        private static final long serialVersionUID = 1L;
+
+        private ExitException(Throwable cause) {
+            super(cause);
+        }
+    }
+}

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/resources/MissingResourceMetadataException.java

@@ -36,11 +36,11 @@ private NativeImageResourceFileSystemUtil() {
     }
 
     public static byte[] getBytes(String resourceName, boolean readOnly) {
-        ResourceStorageEntry entry = Resources.get(resourceName);
+        Object entry = Resources.singleton().get(resourceName, true);
         if (entry == null) {
             return new byte[0];
         }
-        byte[] bytes = entry.getData().get(0);
+        byte[] bytes = ((ResourceStorageEntry) entry).getData().get(0);
         if (readOnly) {
             return bytes;
         } else {
@@ -49,11 +49,11 @@ public static byte[] getBytes(String resourceName, boolean readOnly) {
     }
 
     public static int getSize(String resourceName) {
-        ResourceStorageEntry entry = Resources.get(resourceName);
+        Object entry = Resources.singleton().get(resourceName, true);
         if (entry == null) {
             return 0;
         } else {
-            return entry.getData().get(0).length;
+            return ((ResourceStorageEntry) entry).getData().get(0).length;
         }
     }
 

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/resources/NativeImageResourceFileSystemUtil.java

@@ -74,10 +74,11 @@ public void connect() {
         String resourceName = urlPath.substring(1);
 
         Module module = hostNameOrNull != null ? ModuleLayer.boot().findModule(hostNameOrNull).orElse(null) : null;
-        ResourceStorageEntry entry = Resources.get(module, resourceName);
+        Object entry = Resources.singleton().get(module, resourceName, true);
         if (entry != null) {
-            List<byte[]> bytes = entry.getData();
-            isDirectory = entry.isDirectory();
+            ResourceStorageEntry resourceStorageEntry = (ResourceStorageEntry) entry;
+            List<byte[]> bytes = resourceStorageEntry.getData();
+            isDirectory = resourceStorageEntry.isDirectory();
             String urlRef = url.getRef();
             int index = 0;
             if (urlRef != null) {

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/resources/ResourceURLConnection.java

@@ -144,18 +144,21 @@ private static void collectResourceFromModule(ResourceCollector resourceCollecto
             for (String resName : foundResources) {
                 Optional<InputStream> content = moduleReader.open(resName);
                 if (content.isEmpty()) {
+                    resourceCollector.registerNegativeQuery(info.module, resName);
                     continue;
                 }
                 try (InputStream is = content.get()) {
                     resourceCollector.addResource(info.module, resName, is, false);
+                } catch (IOException resourceException) {
+                    resourceCollector.registerIOException(info.module, resName, resourceException);
                 }
             }
         } catch (IOException e) {
             throw VMError.shouldNotReachHere(e);
         }
     }
 
-    private static void scanDirectory(Path root, ResourceCollector collector) throws IOException {
+    private static void scanDirectory(Path root, ResourceCollector collector) {
         Map<String, List<String>> matchedDirectoryResources = new HashMap<>();
         Set<String> allEntries = new HashSet<>();
 
@@ -183,11 +186,15 @@ private static void scanDirectory(Path root, ResourceCollector collector) throws
                         filtered = filtered.filter(Predicate.not(ClassUtil.CLASS_MODULE_PATH_EXCLUDE_DIRECTORIES::contains));
                     }
                     filtered.forEach(queue::push);
+                } catch (IOException resourceException) {
+                    collector.registerIOException(null, relativeFilePath, resourceException);
                 }
             } else {
                 if (collector.isIncluded(null, relativeFilePath, Path.of(relativeFilePath).toUri())) {
                     try (InputStream is = Files.newInputStream(entry)) {
                         collector.addResource(null, relativeFilePath, is, false);
+                    } catch (IOException resourceException) {
+                        collector.registerIOException(null, relativeFilePath, resourceException);
                     }
                 }
             }
@@ -199,6 +206,8 @@ private static void scanDirectory(Path root, ResourceCollector collector) throws
             List<String> dirContent = matchedDirectoryResources.get(key);
             if (dirContent != null && !dirContent.contains(entry)) {
                 dirContent.add(entry.substring(last + 1));
+            } else if (dirContent == null) {
+                collector.registerNegativeQuery(null, key);
             }
         }
 
@@ -223,6 +232,8 @@ private static void scanJar(Path jarPath, ResourceCollector collector) throws IO
                     if (collector.isIncluded(null, entry.getName(), jarPath.toUri())) {
                         try (InputStream is = jf.getInputStream(entry)) {
                             collector.addResource(null, entry.getName(), is, true);
+                        } catch (IOException resourceException) {
+                            collector.registerIOException(null, entry.getName(), resourceException);
                         }
                     }
                 }

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

@@ -146,10 +146,12 @@ protected void calculate(BeforeImageWriteAccessImpl access) {
         /* Extract byte[] for resources. */
         long resourcesByteArraySize = 0;
         int resourcesByteArrayCount = 0;
-        for (ResourceStorageEntry resourceList : Resources.singleton().resources()) {
-            for (byte[] resource : resourceList.getData()) {
-                resourcesByteArraySize += objectLayout.getArraySize(JavaKind.Byte, resource.length, true);
-                resourcesByteArrayCount++;
+        for (Object resourceList : Resources.singleton().resources()) {
+            if (resourceList instanceof ResourceStorageEntry resourceStorageEntry) {
+                for (byte[] resource : resourceStorageEntry.getData()) {
+                    resourcesByteArraySize += objectLayout.getArraySize(JavaKind.Byte, resource.length, true);
+                    resourcesByteArrayCount++;
+                }
             }
         }
         ProgressReporter reporter = ProgressReporter.singleton();

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

@@ -27,6 +27,7 @@
 
 import static com.oracle.svm.core.jdk.Resources.RESOURCES_INTERNAL_PATH_SEPARATOR;
 
+import java.io.IOException;
 import java.io.InputStream;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
@@ -156,7 +157,7 @@ public void addResources(ConfigurationCondition condition, String pattern) {
 
         @Override
         public void injectResource(Module module, String resourcePath, byte[] resourceContent) {
-            Resources.registerResource(module, resourcePath, resourceContent);
+            Resources.singleton().registerResource(module, resourcePath, resourceContent);
         }
 
         @Override
@@ -308,6 +309,16 @@ public void addResource(Module module, String resourceName, InputStream resource
         public void addDirectoryResource(Module module, String dir, String content, boolean fromJar) {
             registerDirectoryResource(debugContext, module, dir, content, fromJar);
         }
+
+        @Override
+        public void registerIOException(Module module, String resourceName, IOException e) {
+            Resources.singleton().registerIOException(module, resourceName, e);
+        }
+
+        @Override
+        public void registerNegativeQuery(Module module, String resourceName) {
+            Resources.singleton().registerNegativeQuery(module, resourceName);
+        }
     }
 
     @Override
@@ -321,7 +332,13 @@ public void duringAnalysis(DuringAnalysisAccess access) {
 
         DuringAnalysisAccessImpl duringAnalysisAccess = ((DuringAnalysisAccessImpl) access);
         ResourcePattern[] includePatterns = compilePatterns(resourcePatternWorkSet);
+        for (ResourcePattern resourcePattern : includePatterns) {
+            Resources.singleton().registerIncludePattern(resourcePattern.moduleName, resourcePattern.pattern);
+        }
         ResourcePattern[] excludePatterns = compilePatterns(excludedResourcePatterns);
+        for (ResourcePattern resourcePattern : excludePatterns) {
+            Resources.singleton().registerExcludePattern(resourcePattern.moduleName, resourcePattern.pattern);
+        }
         DebugContext debugContext = duringAnalysisAccess.getDebugContext();
         ResourceCollectorImpl collector = new ResourceCollectorImpl(debugContext, includePatterns, excludePatterns, duringAnalysisAccess.bb.getHeartbeatCallback());
         try {
@@ -399,7 +416,7 @@ private static void registerResource(DebugContext debugContext, Module module, S
         try (DebugContext.Scope s = debugContext.scope("registerResource")) {
             String moduleNamePrefix = module == null ? "" : module.getName() + ":";
             debugContext.log(DebugContext.VERBOSE_LEVEL, "ResourcesFeature: registerResource: %s%s", moduleNamePrefix, resourceName);
-            Resources.registerResource(module, resourceName, resourceStream, fromJar);
+            Resources.singleton().registerResource(module, resourceName, resourceStream, fromJar);
         }
     }
 
@@ -408,7 +425,7 @@ private static void registerDirectoryResource(DebugContext debugContext, Module
         try (DebugContext.Scope s = debugContext.scope("registerResource")) {
             String moduleNamePrefix = module == null ? "" : module.getName() + ":";
             debugContext.log(DebugContext.VERBOSE_LEVEL, "ResourcesFeature: registerResource: %s%s", moduleNamePrefix, dir);
-            Resources.registerDirectoryResource(module, dir, content, fromJar);
+            Resources.singleton().registerDirectoryResource(module, dir, content, fromJar);
         }
     }
 

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

@@ -145,11 +145,13 @@ private static EnumMap<ObjectReachabilityGroup, GroupEntry> groupObjectsByReacha
     }
 
     private static void markResources(NativeImageHeap heap) {
-        for (ResourceStorageEntry value : Resources.singleton().resources()) {
-            for (byte[] arr : value.getData()) {
-                ObjectInfo info = heap.getObjectInfo(arr);
-                if (info != null) {
-                    heap.objectReachabilityInfo.get(info).addReason(HeapInclusionReason.Resource);
+        for (Object value : Resources.singleton().resources()) {
+            if (value instanceof ResourceStorageEntry resourceStorageEntry) {
+                for (byte[] arr : resourceStorageEntry.getData()) {
+                    ObjectInfo info = heap.getObjectInfo(arr);
+                    if (info != null) {
+                        heap.objectReachabilityInfo.get(info).addReason(HeapInclusionReason.Resource);
+                    }
                 }
             }
         }