[GR-41912] More user-friendly reporting of internal errors.

PullRequest: graal/13151

Author: fniephaus

.github/ISSUE_TEMPLATE/1_issues_native_image_error_report.md

@@ -0,0 +1,10 @@
+---
+# This template is linked from https://graalvm.org/native-image/error-report
+name: "\U0001F6A8 Share Native Image error report"
+about: Share an error report from Native Image. To report a security vulnerability, please see below or the SECURITY.md file at the root of the repository. Do not open a GitHub issue.
+labels: bug, native-image
+
+---
+
+Replace this text with the error report (`svm_err_b_*.md`) generated by the Native Image build process.
+Please make sure the report does not contain any sensitive information.

.github/ISSUE_TEMPLATE/1_issues_native_image.md renamed to .github/ISSUE_TEMPLATE/2_issues_native_image_other.md

@@ -1,6 +1,6 @@
 ---
-name: "\U0001F6A8 Native Image Issue Report"
-about: Create a report for a failure with Native Image. To report a security vulnerability, please see below or the SECURITY.md file at the root of the repository. Do not open a GitHub issue.
+name: "\U0001F6A8 Other Native Image Issues"
+about: File an issue for a problem with Native Image. To report a security vulnerability, please see below or the SECURITY.md file at the root of the repository. Do not open a GitHub issue.
 title: ''
 labels: bug, native-image
 assignees: ''

.github/ISSUE_TEMPLATE/2_issues_truffle.md renamed to .github/ISSUE_TEMPLATE/3_issues_truffle.md

@@ -2,4 +2,4 @@ blank_issues_enabled: false
 contact_links:
   - name: Need help or have a question?
     url: https://www.graalvm.org/slack-invitation/
-    about: Visit our slack channel.
+    about: Join the GraalVM Slack channel.

.github/ISSUE_TEMPLATE/3_issues_tools.md renamed to .github/ISSUE_TEMPLATE/4_issues_tools.md

@@ -1273,6 +1273,7 @@ def contents(self):
                     '--install-exit-handlers',
                     '--enable-monitoring',
                     '-H:+DumpRuntimeCompilationOnSignal',
+                    '-H:+ReportExceptionStackTraces',
                 ]
 
             if isinstance(image_config, (mx_sdk.LauncherConfig, mx_sdk.LanguageLibraryConfig)):

.github/ISSUE_TEMPLATE/4_issues_llvm.md renamed to .github/ISSUE_TEMPLATE/5_issues_llvm.md

@@ -12,6 +12,7 @@ This changelog summarizes major changes to GraalVM Native Image.
 * (GR-42375) Add `-H:±GenerateBuildArtifactsFile` option, which generates a `build-artifacts.json` file with a list of all artifacts produced by Native Image. `.build_artifacts.txt` files are now deprecated, disabled (can be re-enabled with env setting `NATIVE_IMAGE_DEPRECATED_BUILD_ARTIFACTS_TXT=true`), and will be removed in a future release.
 * (GR-34179) Improved debugging support on Windows: Debug information now includes information about Java types (contributed by Red Hat).
 * (GR-41096) Support services loaded through the `java.util.ServiceLoader.ModuleServicesLookupIterator`. An example of such service is the `com.sun.jndi.rmi.registry.RegistryContextFactory`.
+* (GR-41912) The builder now generated reports for internal errors, which users can share when creating issues. By default, error reports follow the `svm_err_b_<timestamp>_pid<pid>.md` pattern and are created in the working directory. Use `-H:ErrorFile` to adjust the path or filename.
 
 ## Version 22.3.0
 * (GR-35721) Remove old build output style and the `-H:±BuildOutputUseNewStyle` option.

.github/ISSUE_TEMPLATE/5_issues_other.md renamed to .github/ISSUE_TEMPLATE/6_issues_other.md

@@ -236,7 +236,7 @@ def vm_executable_path(executable, config=None):
 @contextmanager
 def native_image_context(common_args=None, hosted_assertions=True, native_image_cmd='', config=None, build_if_missing=False):
     common_args = [] if common_args is None else common_args
-    base_args = ['--no-fallback', '-H:+EnforceMaxRuntimeCompileMethods']
+    base_args = ['--no-fallback', '-H:+EnforceMaxRuntimeCompileMethods', '-H:+ReportExceptionStackTraces']
     base_args += ['-H:Path=' + svmbuild_dir()]
     if mx.get_opts().verbose:
         base_args += ['--verbose']

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2022, 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
@@ -27,25 +27,22 @@
 import org.graalvm.nativeimage.Platform;
 import org.graalvm.nativeimage.Platforms;
 
-import com.oracle.svm.core.util.VMError;
-
 public final class VM {
 
     public final String version;
     public final String vendor;
     public final String vendorUrl;
     public final String runtimeName;
+    public final String supportURL;
 
     @Platforms(Platform.HOSTED_ONLY.class)
-    public VM(String config) {
-        String versionStr = System.getProperty("org.graalvm.version");
-        VMError.guarantee(versionStr != null);
-        versionStr = "GraalVM " + versionStr;
-        versionStr += " Java " + Runtime.version().toString();
-        versionStr += " " + config;
-        version = versionStr;
+    public VM() {
+        String versionStr = System.getProperty("org.graalvm.version", "Unknown Version");
+        String edition = System.getProperty("org.graalvm.config", "CE");
+        version = String.format("GraalVM %s Java %s %s", versionStr, Runtime.version(), edition);
         vendor = System.getProperty("org.graalvm.vendor", "Oracle Corporation");
         vendorUrl = System.getProperty("org.graalvm.vendorurl", "https://www.graalvm.org/");
         runtimeName = System.getProperty("java.runtime.name", "Unknown Runtime Environment");
+        supportURL = System.getProperty("org.graalvm.supporturl", "https://graalvm.org/native-image/error-report/");
     }
 }

sdk/mx.sdk/mx_sdk_vm_impl.py

@@ -24,7 +24,9 @@
  */
 package com.oracle.svm.hosted;
 
+import java.io.PrintWriter;
 import java.util.ArrayList;
+import java.util.Comparator;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedHashSet;
@@ -178,14 +180,7 @@ public void registerFeatures(ImageClassLoader loader, DebugContext debug) {
         if (NativeImageOptions.PrintFeatures.getValue()) {
             ReportUtils.report("feature information", SubstrateOptions.reportsPath(), "feature_info", "csv", out -> {
                 out.println("Feature, Required Features");
-                for (Feature featureInstance : featureInstances) {
-                    out.print(featureInstance.getClass().getTypeName());
-                    String requiredFeaturesString = featureInstance.getRequiredFeatures().stream()
-                                    .map(Class::getTypeName)
-                                    .collect(Collectors.joining(" ", "[", "]"));
-                    out.print(", ");
-                    out.println(requiredFeaturesString);
-                }
+                dumpAllFeatures(out);
             });
         }
     }
@@ -248,4 +243,15 @@ public List<Feature> getUserSpecificFeatures() {
                                         (classLoaderSupport.isNativeImageClassLoader(f.getClass().getClassLoader()) || userEnabledFeatures.contains(f.getClass().getName())))
                         .collect(Collectors.toList());
     }
+
+    public void dumpAllFeatures(PrintWriter out) {
+        featureInstances.stream().sorted(Comparator.comparing(f -> f.getClass().getTypeName())).forEachOrdered(f -> {
+            out.print(f.getClass().getTypeName());
+            String requiredFeaturesString = f.getRequiredFeatures().stream()
+                            .map(Class::getTypeName)
+                            .collect(Collectors.joining(" ", "[", "]"));
+            out.print(", ");
+            out.println(requiredFeaturesString);
+        });
+    }
 }

substratevm/CHANGELOG.md

@@ -287,6 +287,7 @@ private int buildImage(ImageClassLoader classLoader) {
         ForkJoinPool compilationExecutor = null;
 
         ProgressReporter reporter = new ProgressReporter(parsedHostedOptions);
+        Throwable vmError = null;
         boolean wasSuccessfulBuild = false;
         try (StopTimer ignored = totalTimer.start()) {
             Timer classlistTimer = timerCollection.get(TimerCollection.Registry.CLASSLIST);
@@ -452,20 +453,18 @@ private int buildImage(ImageClassLoader classLoader) {
             }
             return ExitStatus.BUILDER_ERROR.getValue();
         } catch (Throwable e) {
-            NativeImageGeneratorRunner.reportFatalError(e);
+            vmError = e;
             return ExitStatus.BUILDER_ERROR.getValue();
         } finally {
-            if (imageName != null && generator != null) {
-                reportEpilog(imageName, reporter, wasSuccessfulBuild, parsedHostedOptions);
-            }
+            reportEpilog(imageName, reporter, classLoader, vmError, parsedHostedOptions);
             NativeImageGenerator.clearSystemPropertiesForImage();
             ImageSingletonsSupportImpl.HostedManagement.clear();
         }
         return ExitStatus.OK.getValue();
     }
 
-    protected void reportEpilog(String imageName, ProgressReporter reporter, boolean wasSuccessfulBuild, OptionValues parsedHostedOptions) {
-        reporter.printEpilog(imageName, generator, wasSuccessfulBuild, parsedHostedOptions);
+    protected void reportEpilog(String imageName, ProgressReporter reporter, ImageClassLoader classLoader, Throwable vmError, OptionValues parsedHostedOptions) {
+        reporter.printEpilog(imageName, generator, generator.featureHandler, classLoader, vmError, parsedHostedOptions);
     }
 
     protected NativeImageGenerator createImageGenerator(ImageClassLoader classLoader, HostedOptionParser optionParser, Pair<Method, CEntryPointData> mainEntryPointData, ProgressReporter reporter) {

substratevm/mx.substratevm/mx_substratevm.py

@@ -27,19 +27,24 @@
 import static org.graalvm.compiler.options.OptionType.Debug;
 import static org.graalvm.compiler.options.OptionType.User;
 
+import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.text.SimpleDateFormat;
 import java.util.Arrays;
+import java.util.Date;
 
 import org.graalvm.collections.EconomicMap;
 import org.graalvm.compiler.options.Option;
 import org.graalvm.compiler.options.OptionKey;
 import org.graalvm.compiler.options.OptionValues;
+import org.graalvm.compiler.serviceprovider.GraalServices;
 
 import com.oracle.graal.pointsto.reports.ReportUtils;
 import com.oracle.graal.pointsto.util.CompletionExecutor;
 import com.oracle.svm.core.SubstrateOptions;
 import com.oracle.svm.core.option.APIOption;
 import com.oracle.svm.core.option.HostedOptionKey;
+import com.oracle.svm.core.option.HostedOptionValues;
 import com.oracle.svm.core.option.LocatableMultiOptionValue;
 import com.oracle.svm.core.util.UserError;
 import com.oracle.svm.hosted.classinitialization.ClassInitializationOptions;
@@ -180,6 +185,26 @@ public static CStandards getCStandard() {
     @Option(help = "Print unsafe operation offset warnings.)")//
     public static final HostedOptionKey<Boolean> UnsafeOffsetWarningsAreFatal = new HostedOptionKey<>(false);
 
+    // Inspired by HotSpot's hs_err_<pid>.log files and for build-time errors (err_b).
+    private static final String DEFAULT_ERROR_FILE_NAME = "svm_err_b_%t_pid%p.md";
+
+    public static final Path getErrorFilePath() {
+        String errorFile = NativeImageOptions.ErrorFile.getValue();
+        if (errorFile.isEmpty()) {
+            return NativeImageGenerator.generatedFiles(HostedOptionValues.singleton()).resolve(expandErrorFile(DEFAULT_ERROR_FILE_NAME));
+        } else {
+            return Paths.get(expandErrorFile(errorFile));
+        }
+    }
+
+    private static String expandErrorFile(String errorFile) {
+        String timestamp = new SimpleDateFormat("yyyyMMdd'T'HHmmss.SSS").format(new Date(GraalServices.getGlobalTimeStamp()));
+        return errorFile.replaceAll("%p", GraalServices.getExecutionID()).replaceAll("%t", timestamp);
+    }
+
+    @Option(help = "If an error occurs, save a build error report to this file [default: " + DEFAULT_ERROR_FILE_NAME + "] (%p replaced with pid, %t with timestamp).)")//
+    public static final HostedOptionKey<String> ErrorFile = new HostedOptionKey<>("");
+
     @Option(help = "Show exception stack traces for exceptions during image building.)")//
     public static final HostedOptionKey<Boolean> ReportExceptionStackTraces = new HostedOptionKey<>(areAssertionsEnabled());
 
@@ -199,6 +224,7 @@ protected void onValueUpdate(EconomicMap<OptionKey<?>, Object> values, Boolean o
                 SubstitutionReportFeature.Options.ReportPerformedSubstitutions.update(values, true);
                 SubstrateOptions.DumpTargetInfo.update(values, true);
                 PrintFeatures.update(values, true);
+                ReportExceptionStackTraces.update(values, true);
             }
         }
     };

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

@@ -74,14 +74,14 @@
 import com.oracle.svm.core.SubstrateOptions;
 import com.oracle.svm.core.VM;
 import com.oracle.svm.core.code.CodeInfoTable;
+import com.oracle.svm.core.feature.AutomaticallyRegisteredFeature;
 import com.oracle.svm.core.feature.InternalFeature;
 import com.oracle.svm.core.heap.Heap;
 import com.oracle.svm.core.jdk.Resources;
 import com.oracle.svm.core.jdk.resources.ResourceStorageEntry;
 import com.oracle.svm.core.meta.SubstrateObjectConstant;
 import com.oracle.svm.core.option.HostedOptionValues;
 import com.oracle.svm.core.reflect.ReflectionMetadataDecoder;
-import com.oracle.svm.core.feature.AutomaticallyRegisteredFeature;
 import com.oracle.svm.core.util.VMError;
 import com.oracle.svm.hosted.ProgressReporterJsonHelper.AnalysisResults;
 import com.oracle.svm.hosted.ProgressReporterJsonHelper.GeneralInfo;
@@ -94,6 +94,7 @@
 import com.oracle.svm.hosted.image.NativeImageHeap.ObjectInfo;
 import com.oracle.svm.hosted.meta.HostedMetaAccess;
 import com.oracle.svm.hosted.reflect.ReflectionHostedSupport;
+import com.oracle.svm.hosted.util.VMErrorReporter;
 import com.oracle.svm.util.ImageBuildStatistics;
 import com.oracle.svm.util.ReflectionUtil;
 
@@ -117,6 +118,7 @@ public class ProgressReporter {
 
     private final ProgressReporterJsonHelper jsonHelper;
     private final DirectPrinter linePrinter = new DirectPrinter();
+    private final StringBuilder buildOutputLog = new StringBuilder();
     private final StagePrinter<?> stagePrinter;
     private final ColorStrategy colorStrategy;
     private final LinkStrategy linkStrategy;
@@ -595,19 +597,28 @@ private void printBreakdowns() {
                         .a(String.format("%9s for %s more object types", Utils.bytesToHuman(totalHeapBytes - printedHeapBytes), numHeapItems - printedHeapItems)).flushln();
     }
 
-    public void printEpilog(String imageName, NativeImageGenerator generator, boolean wasSuccessfulBuild, OptionValues parsedHostedOptions) {
+    public void printEpilog(String imageName, NativeImageGenerator generator, FeatureHandler featureHandler, ImageClassLoader classLoader, Throwable error, OptionValues parsedHostedOptions) {
+        executor.shutdown();
+
+        if (error != null) {
+            Path errorReportPath = NativeImageOptions.getErrorFilePath();
+            ReportUtils.report("GraalVM Native Image Error Report", errorReportPath, p -> VMErrorReporter.generateErrorReport(p, buildOutputLog, classLoader, featureHandler, error), false);
+            BuildArtifacts.singleton().add(ArtifactType.BUILD_INFO, errorReportPath);
+        }
+
+        if (imageName == null || generator == null) {
+            printErrorMessage(error);
+            return;
+        }
+
         l().printLineSeparator();
         printResourceStatistics();
 
         double totalSeconds = Utils.millisToSeconds(getTimer(TimerCollection.Registry.TOTAL).getTotalTime());
         recordJsonMetric(ResourceUsageKey.TOTAL_SECS, totalSeconds);
 
-        createArtifacts(imageName, generator, parsedHostedOptions, wasSuccessfulBuild);
-        Map<ArtifactType, List<Path>> artifacts = generator.getBuildArtifacts();
-        if (!artifacts.isEmpty()) {
-            l().printLineSeparator();
-            printArtifacts(artifacts);
-        }
+        createAdditionalArtifacts(imageName, generator, error, parsedHostedOptions);
+        printArtifacts(generator.getBuildArtifacts());
 
         l().printHeadlineSeparator();
 
@@ -617,14 +628,38 @@ public void printEpilog(String imageName, NativeImageGenerator generator, boolea
         } else {
             timeStats = String.format("%dm %ds", (int) totalSeconds / 60, (int) totalSeconds % 60);
         }
-        l().a(wasSuccessfulBuild ? "Finished" : "Failed").a(" generating '").bold().a(imageName).reset().a("' ")
-                        .a(wasSuccessfulBuild ? "in" : "after").a(" ").a(timeStats).a(".").println();
-        executor.shutdown();
+        l().a(error == null ? "Finished" : "Failed").a(" generating '").bold().a(imageName).reset().a("' ")
+                        .a(error == null ? "in" : "after").a(" ").a(timeStats).a(".").println();
+
+        printErrorMessage(error);
     }
 
-    private void createArtifacts(String imageName, NativeImageGenerator generator, OptionValues parsedHostedOptions, boolean wasSuccessfulBuild) {
+    private void printErrorMessage(Throwable error) {
+        if (error == null) {
+            return;
+        }
+        l().println();
+        l().redBold().a("The build process encountered an unexpected error:").reset().println();
+        if (NativeImageOptions.ReportExceptionStackTraces.getValue()) {
+            l().dim().println();
+            error.printStackTrace(builderIO.getOut());
+            l().reset().println();
+        } else {
+            l().println();
+            l().dim().a("> %s", error).reset().println();
+            l().println();
+            l().a("Please inspect the generated error report at:").println();
+            l().link(NativeImageOptions.getErrorFilePath()).println();
+            l().println();
+            l().a("If you are unable to resolve this problem, please file an issue with the error report at:").println();
+            var supportURL = ImageSingletons.lookup(VM.class).supportURL;
+            l().link(supportURL, supportURL).println();
+        }
+    }
+
+    private void createAdditionalArtifacts(String imageName, NativeImageGenerator generator, Throwable error, OptionValues parsedHostedOptions) {
         BuildArtifacts artifacts = BuildArtifacts.singleton();
-        if (jsonHelper != null && wasSuccessfulBuild) {
+        if (error == null && jsonHelper != null) {
             artifacts.add(ArtifactType.BUILD_INFO, jsonHelper.printToFile());
         }
         if (generator.getBigbang() != null && ImageBuildStatistics.Options.CollectImageBuildStatistics.getValue(parsedHostedOptions)) {
@@ -634,6 +669,10 @@ private void createArtifacts(String imageName, NativeImageGenerator generator, O
     }
 
     private void printArtifacts(Map<ArtifactType, List<Path>> artifacts) {
+        if (artifacts.isEmpty()) {
+            return;
+        }
+        l().printLineSeparator();
         l().yellowBold().a("Produced artifacts:").reset().println();
         // Use TreeMap to sort paths alphabetically.
         Map<Path, List<String>> pathToTypes = new TreeMap<>();
@@ -857,14 +896,17 @@ public void close() {
 
     private void print(char text) {
         builderIO.getOut().print(text);
+        buildOutputLog.append(text);
     }
 
     private void print(String text) {
         builderIO.getOut().print(text);
+        buildOutputLog.append(text);
     }
 
     private void println() {
         builderIO.getOut().println();
+        buildOutputLog.append(System.lineSeparator());
     }
 
     /*
@@ -1361,23 +1403,30 @@ public String asDocLink(String text, String htmlAnchor) {
         }
     }
 
-    private static class ANSI {
+    public static class ANSI {
         static final String ESCAPE = "\033";
         static final String RESET = ESCAPE + "[0m";
         static final String BOLD = ESCAPE + "[1m";
         static final String DIM = ESCAPE + "[2m";
+        static final String STRIP_COLORS = "\033\\[[;\\d]*m";
 
         static final String LINK_START = ESCAPE + "]8;;";
         static final String LINK_TEXT = ESCAPE + "\\";
         static final String LINK_END = LINK_START + LINK_TEXT;
         static final String LINK_FORMAT = LINK_START + "%s" + LINK_TEXT + "%s" + LINK_END;
+        static final String STRIP_LINKS = "\033]8;;https://\\S+\033\\\\([^\033]*)\033]8;;\033\\\\";
 
         static final String BLUE = ESCAPE + "[0;34m";
 
         static final String RED_BOLD = ESCAPE + "[1;31m";
         static final String YELLOW_BOLD = ESCAPE + "[1;33m";
         static final String BLUE_BOLD = ESCAPE + "[1;34m";
         static final String MAGENTA_BOLD = ESCAPE + "[1;35m";
+
+        /* Strip all ANSI codes emitted by this class. */
+        public static String strip(String string) {
+            return string.replaceAll(STRIP_COLORS, "").replaceAll(STRIP_LINKS, "$1");
+        }
     }
 }