Properly trace negative resource queries

Author: DSouzaM

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

@@ -54,6 +54,7 @@
 import org.graalvm.nativeimage.Platforms;
 import org.graalvm.nativeimage.impl.ConfigurationCondition;
 
+import com.oracle.svm.core.AlwaysInline;
 import com.oracle.svm.core.BuildPhaseProvider;
 import com.oracle.svm.core.ClassLoaderSupport.ConditionWithOrigin;
 import com.oracle.svm.core.MissingRegistrationUtils;
@@ -437,6 +438,10 @@ public static ResourceStorageEntryBase getAtRuntime(String name) {
      * The {@code probe} parameter indicates whether the caller is probing for the existence of a
      * resource. If {@code probe} is true, failed resource lookups return will not throw missing
      * registration errors and may instead return {@link #MISSING_METADATA_MARKER}.
+     * <p>
+     * Tracing note: When this method is used for probing, only successful metadata matches will be
+     * traced. If a probing result is {@link #MISSING_METADATA_MARKER}, the caller must explicitly
+     * trace the missing metadata.
      */
     public static ResourceStorageEntryBase getAtRuntime(Module module, String resourceName, boolean probe) {
         VMError.guarantee(ImageInfo.inImageRuntimeCode(), "This function should be used only at runtime.");
@@ -448,16 +453,20 @@ public static ResourceStorageEntryBase getAtRuntime(Module module, String resour
                 if (missingResourceMatchesIncludePattern(resourceName, moduleName) || missingResourceMatchesIncludePattern(canonicalResourceName, moduleName)) {
                     // This resource name matches a pattern/glob from the provided metadata, but no
                     // resource with the name actually exists. Do not report missing metadata.
+                    traceResource(resourceName, moduleName);
                     return null;
                 }
+                traceResourceMissingMetadata(resourceName, moduleName, probe);
                 return missingMetadata(module, resourceName, probe);
             } else {
+                // NB: Without exact reachability metadata, resource include patterns are not
+                // stored in the image heap, so we cannot reliably identify if the resource was
+                // included at build time. Assume it is missing.
+                traceResourceMissingMetadata(resourceName, moduleName, probe);
                 return null;
             }
         }
-        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
-            MetadataTracer.singleton().traceResource(resourceName, moduleName);
-        }
+        traceResource(resourceName, moduleName);
         if (!entry.getConditions().satisfied()) {
             return missingMetadata(module, resourceName, probe);
         }
@@ -487,6 +496,28 @@ public static ResourceStorageEntryBase getAtRuntime(Module module, String resour
         return unconditionalEntry;
     }
 
+    @AlwaysInline("tracing should fold away when disabled")
+    private static void traceResource(String resourceName, String moduleName) {
+        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled()) {
+            MetadataTracer.singleton().traceResource(resourceName, moduleName);
+        }
+    }
+
+    @AlwaysInline("tracing should fold away when disabled")
+    private static void traceResourceMissingMetadata(String resourceName, String moduleName) {
+        traceResourceMissingMetadata(resourceName, moduleName, false);
+    }
+
+    @AlwaysInline("tracing should fold away when disabled")
+    private static void traceResourceMissingMetadata(String resourceName, String moduleName, boolean probe) {
+        if (MetadataTracer.Options.MetadataTracingSupport.getValue() && MetadataTracer.singleton().enabled() && !probe) {
+            // Do not trace missing metadata for probing queries, otherwise we'll trace an entry for
+            // every module. The caller is responsible for tracing missing entries if it uses
+            // probing.
+            MetadataTracer.singleton().traceResource(resourceName, moduleName);
+        }
+    }
+
     /**
      * Checks whether the given missing resource is matched by a pattern/glob registered at build
      * time. In such a case, we should not report missing metadata.
@@ -558,6 +589,7 @@ public static InputStream createInputStream(Module module, String resourceName)
         }
         ResourceStorageEntryBase entry = findResourceForInputStream(module, resourceName);
         if (entry == MISSING_METADATA_MARKER) {
+            traceResourceMissingMetadata(resourceName, moduleName(module));
             MissingResourceRegistrationUtils.reportResourceAccess(module, resourceName);
             return null;
         } else if (entry == null) {

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

@@ -164,7 +164,8 @@ public ConfigurationType traceJNIType(String className) {
     }
 
     /**
-     * Marks the given resource within the given (optional) module as reachable.
+     * Marks the given resource within the given (optional) module as reachable. Use this method to
+     * trace resource lookups covered by image metadata (including negative queries).
      */
     public void traceResource(String resourceName, String moduleName) {
         assert enabled();