Validate the RuntimeDebugInfo option and use a better default for RuntimeSourceDestDir

Author: dominikmascherbauer

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

@@ -52,6 +52,7 @@
 import com.oracle.svm.core.c.libc.LibCBase;
 import com.oracle.svm.core.c.libc.MuslLibC;
 import com.oracle.svm.core.config.ConfigurationValues;
+import com.oracle.svm.core.graal.RuntimeCompilation;
 import com.oracle.svm.core.heap.ReferenceHandler;
 import com.oracle.svm.core.jdk.VectorAPIEnabled;
 import com.oracle.svm.core.option.APIOption;
@@ -512,7 +513,19 @@ public static void setImageLayerCreateEnabledHandler(OptionEnabledHandler<Boolea
     public static final HostedOptionKey<Boolean> IncludeNodeSourcePositions = new HostedOptionKey<>(false);
 
     @Option(help = "Provide debuginfo for runtime-compiled code.")//
-    public static final HostedOptionKey<Boolean> RuntimeDebugInfo = new HostedOptionKey<>(false);
+    public static final HostedOptionKey<Boolean> RuntimeDebugInfo = new HostedOptionKey<>(false, SubstrateOptions::validateRuntimeDebugInfo);
+
+    private static void validateRuntimeDebugInfo(HostedOptionKey<Boolean> optionKey) {
+        if (optionKey.getValue()) {
+            if (!useDebugInfoGeneration()) {
+                throw UserError.invalidOptionValue(optionKey, optionKey.getValue(), "The option can only be enabled if debug info generation is enabled ('-g')");
+            } else if (!OS.LINUX.isCurrent()) {
+                throw UserError.invalidOptionValue(optionKey, optionKey.getValue(), "The option is only supported on Linux.");
+            } else if (!RuntimeCompilation.isEnabled()) {
+                throw UserError.invalidOptionValue(optionKey, optionKey.getValue(), "The option only works if run-time compilation support is enabled.");
+            }
+        }
+    }
 
     @Option(help = "Search path for C libraries passed to the linker (list of comma-separated directories)", stability = OptionStability.STABLE)//
     @BundleMember(role = BundleMember.Role.Input)//

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/debug/SubstrateDebugInfoProvider.java

@@ -30,7 +30,6 @@
 import java.util.stream.Stream;
 
 import org.graalvm.collections.Pair;
-import org.graalvm.nativeimage.ProcessProperties;
 
 import com.oracle.objectfile.debugentry.ArrayTypeEntry;
 import com.oracle.objectfile.debugentry.ClassEntry;
@@ -39,12 +38,14 @@
 import com.oracle.objectfile.debugentry.PointerToTypeEntry;
 import com.oracle.objectfile.debugentry.PrimitiveTypeEntry;
 import com.oracle.objectfile.debugentry.TypeEntry;
+import com.oracle.svm.core.SubstrateOptions;
 import com.oracle.svm.core.SubstrateUtil;
 import com.oracle.svm.core.graal.meta.RuntimeConfiguration;
 import com.oracle.svm.core.meta.SharedMethod;
 import com.oracle.svm.core.meta.SharedType;
 import com.oracle.svm.core.option.RuntimeOptionKey;
 
+import jdk.graal.compiler.api.replacements.Fold;
 import jdk.graal.compiler.code.CompilationResult;
 import jdk.graal.compiler.debug.DebugContext;
 import jdk.graal.compiler.options.Option;
@@ -73,18 +74,19 @@ public static class Options {
 
         public static Path getRuntimeSourceDestDir() {
             String sourceDestDir = RuntimeSourceDestDir.getValue();
-            if (sourceDestDir != null) {
-                return Path.of(sourceDestDir);
-            }
-            Path result = Path.of("sources");
-            Path exeDir = Path.of(ProcessProperties.getExecutableName()).getParent();
-            if (exeDir != null) {
-                result = exeDir.resolve(result);
-            }
-            return result;
+            /*
+             * If not set, use source cache root from the native image debug info. This makes sure
+             * the cachePath is the same as in the native image debug info.
+             */
+            return sourceDestDir != null ? Path.of(sourceDestDir) : getHostedSourceCacheRoot();
         }
     }
 
+    @Fold
+    static Path getHostedSourceCacheRoot() {
+        return SubstrateOptions.getDebugInfoSourceCacheRoot();
+    }
+
     private final SharedMethod sharedMethod;
     private final CompilationResult compilation;
     private final long codeAddress;