[GR-63242] Added feature to dump runtime compiled methods on SVM.

PullRequest: graal/20336

Author: matteoldani

substratevm/src/com.oracle.svm.core.posix/src/com/oracle/svm/core/posix/PosixRawFileOperationSupport.java

@@ -27,6 +27,7 @@
 import java.io.File;
 import java.nio.ByteOrder;
 
+import com.oracle.svm.core.jdk.SystemPropertiesSupport;
 import jdk.graal.compiler.word.Word;
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.Platform;
@@ -82,6 +83,11 @@ public RawFileDescriptor create(CCharPointer cPath, FileCreationMode creationMod
         return open0(cPath, flags);
     }
 
+    @Override
+    public String getTempDirectory() {
+        return SystemPropertiesSupport.singleton().getInitialProperty("java.io.tmpdir");
+    }
+
     @Override
     public RawFileDescriptor open(File file, FileAccessMode mode) {
         String path = file.getPath();

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

@@ -1160,6 +1160,14 @@ protected void onValueUpdate(EconomicMap<OptionKey<?>, Object> values, Integer o
         @OptionMigrationMessage("Use the '-o' option instead.")//
         @Option(help = "Directory of the image file to be generated", type = OptionType.User)//
         public static final HostedOptionKey<String> Path = new HostedOptionKey<>(null);
+
+        /** Use {@link SubstrateOptions#hasDumpRuntimeCompiledMethodsSupport()} instead. */
+        @Option(help = "Dump the instructions of runtime compiled methods in temporary files.") //
+        public static final RuntimeOptionKey<Boolean> DumpRuntimeCompiledMethods = new RuntimeOptionKey<>(false, key -> {
+            if (key.hasBeenSet() && Platform.includedIn(Platform.WINDOWS.class)) {
+                throw UserError.invalidOptionValue(key, key.getValue(), "Dumping runtime compiled code is not supported on Windows.");
+            }
+        });
     }
 
     @Fold
@@ -1471,4 +1479,9 @@ private static void validateRelativeCodePointers(HostedOptionKey<Boolean> option
             UserError.guarantee(!PLTGOTConfiguration.isEnabled(), "%s cannot be used together with PLT/GOT.", enabledOption);
         }
     }
+
+    public static boolean hasDumpRuntimeCompiledMethodsSupport() {
+        return !Platform.includedIn(Platform.WINDOWS.class) && ConcealedOptions.DumpRuntimeCompiledMethods.getValue();
+    }
+
 }

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/code/RuntimeCodeCache.java

@@ -26,14 +26,20 @@
 
 import static com.oracle.svm.core.deopt.Deoptimizer.Options.LazyDeoptimization;
 import static com.oracle.svm.core.option.RuntimeOptionKey.RuntimeOptionKeyFlag.RelevantForCompilationIsolates;
+import static com.oracle.svm.core.os.RawFileOperationSupport.FileAccessMode.WRITE;
+import static com.oracle.svm.core.os.RawFileOperationSupport.FileCreationMode.CREATE_OR_REPLACE;
 import static com.oracle.svm.core.snippets.KnownIntrinsics.readCallerStackPointer;
 
+import com.oracle.svm.core.SubstrateOptions;
+import com.oracle.svm.core.log.Log;
+import com.oracle.svm.core.os.RawFileOperationSupport;
 import org.graalvm.collections.EconomicMap;
 import org.graalvm.nativeimage.CurrentIsolate;
 import org.graalvm.nativeimage.IsolateThread;
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
 import org.graalvm.nativeimage.c.function.CodePointer;
+import org.graalvm.nativeimage.c.type.CCharPointer;
 import org.graalvm.word.Pointer;
 import org.graalvm.word.UnsignedWord;
 
@@ -59,6 +65,8 @@
 import jdk.graal.compiler.options.OptionType;
 import jdk.graal.compiler.word.Word;
 
+import java.text.SimpleDateFormat;
+
 public class RuntimeCodeCache {
 
     public static class Options {
@@ -161,11 +169,45 @@ private static int binarySearch(NonmovableArray<UntetheredCodeInfo> a, int fromI
         return -(low + 1);  // key not found.
     }
 
+    private static RawFileOperationSupport getFileSupport() {
+        return RawFileOperationSupport.bigEndian();
+    }
+
+    private static void dumpMethod(CodeInfo info) {
+        String methodName = CodeInfoAccess.getName(info);
+        int tier = CodeInfoAccess.getTier(info);
+        String date = new SimpleDateFormat("yyyy.MM.dd.HH.mm.ss").format(new java.util.Date());
+        String tmpDirPath = getFileSupport().getTempDirectory();
+        String filePath = tmpDirPath + "/" + date + "_" + methodName + "_" + tier + ".bin";
+
+        RawFileOperationSupport.RawFileDescriptor fd = getFileSupport().create(filePath, CREATE_OR_REPLACE, WRITE);
+        if (!getFileSupport().isValid(fd)) {
+            Log.log().string("Failed to dump runtime compiled code: '").string(filePath).string("' could not be created.").newline();
+            return;
+        }
+
+        try {
+            CCharPointer codeStart = (CCharPointer) CodeInfoAccess.getCodeStart(info);
+
+            UnsignedWord codeSize = CodeInfoAccess.getCodeSize(info);
+            if (!RawFileOperationSupport.bigEndian().write(fd, (Pointer) codeStart, codeSize)) {
+                Log.log().string("Dumping method to ").string(filePath).string(" failed").newline();
+            }
+        } finally {
+            getFileSupport().close(fd);
+        }
+    }
+
     public void addMethod(CodeInfo info) {
         assert VMOperation.isInProgressAtSafepoint() : "invalid state";
         InstalledCodeObserverSupport.activateObservers(RuntimeCodeInfoAccess.getCodeObserverHandles(info));
+
         addMethod0(info);
         RuntimeCodeInfoHistory.singleton().logAdd(info);
+
+        if (SubstrateOptions.hasDumpRuntimeCompiledMethodsSupport()) {
+            dumpMethod(info);
+        }
     }
 
     @Uninterruptible(reason = "Modifying code tables that are used by the GC")

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/os/RawFileOperationSupport.java

@@ -110,6 +110,9 @@ static RawFileOperationSupport nativeByteOrder() {
     @Uninterruptible(reason = "Called from uninterruptible code.", mayBeInlined = true)
     RawFileDescriptor create(CCharPointer path, FileCreationMode creationMode, FileAccessMode accessMode);
 
+    /** Returns the path to the platform-specific temporary directory. */
+    String getTempDirectory();
+
     /**
      * Opens a file with the specified {@link FileAccessMode access mode}.
      *