[GR-45822] Add AOT fallback compilation.

PullRequest: graal/21384

Author: Michael Haas

substratevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/util/ParallelExecutionException.java

@@ -38,6 +38,7 @@ public class ParallelExecutionException extends RuntimeException {
     private final List<Throwable> exceptions;
 
     ParallelExecutionException(List<Throwable> exceptions) {
+        super(exceptions.getFirst().getMessage());
         this.exceptions = exceptions;
     }
 

substratevm/src/com.oracle.svm.core.graal.aarch64/src/com/oracle/svm/core/graal/aarch64/SubstrateAArch64SuitesCreatorProvider.java

@@ -32,6 +32,6 @@
 public class SubstrateAArch64SuitesCreatorProvider extends SubstrateSuitesCreatorProvider {
     public SubstrateAArch64SuitesCreatorProvider() {
         super(new AArch64SubstrateSuitesCreator(getHostedCompilerConfiguration()),
-                        new AArch64SubstrateSuitesCreator(new EconomyCompilerConfiguration()));
+                        new AArch64SubstrateSuitesCreator(new EconomyCompilerConfiguration()), new AArch64SubstrateSuitesCreator(getFallbackCompilerConfiguration()));
     }
 }

substratevm/src/com.oracle.svm.core.graal.amd64/src/com/oracle/svm/core/graal/amd64/SubstrateAMD64SuitesCreatorProvider.java

@@ -31,6 +31,6 @@
 public class SubstrateAMD64SuitesCreatorProvider extends SubstrateSuitesCreatorProvider {
     public SubstrateAMD64SuitesCreatorProvider() {
         super(new AMD64SubstrateSuitesCreator(getHostedCompilerConfiguration()),
-                        new AMD64SubstrateSuitesCreator(new EconomyCompilerConfiguration()));
+                        new AMD64SubstrateSuitesCreator(new EconomyCompilerConfiguration()), new AMD64SubstrateSuitesCreator(getFallbackCompilerConfiguration()));
     }
 }

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

@@ -1696,4 +1696,19 @@ protected void onValueUpdate(EconomicMap<OptionKey<?>, Object> values, Boolean o
             }
         }
     };
+
+    @Option(help = "Fallback to economy mode in case a compilation during native image generation fails.")//
+    public static final HostedOptionKey<Boolean> EnableFallbackCompilation = new HostedOptionKey<>(false, SubstrateOptions::validateEnableFallbackCompilation);
+
+    private static void validateEnableFallbackCompilation(HostedOptionKey<Boolean> optionKey) {
+        if (optionKey.getValue() && SubstrateOptions.useEconomyCompilerConfig()) {
+            throw UserError.invalidOptionValue(optionKey, true,
+                            String.format("Combining the option %s with %s is not supported", SubstrateOptionsParser.commandArgument(SubstrateOptions.EnableFallbackCompilation, "+"),
+                                            SubstrateOptionsParser.commandArgument(SubstrateOptions.Optimize, "b")));
+        }
+    }
+
+    public static boolean canEnableFallbackCompilation() {
+        return !EnableFallbackCompilation.getValue() && !useEconomyCompilerConfig();
+    }
 }

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/feature/InternalFeature.java

@@ -95,8 +95,9 @@ default void registerLowerings(RuntimeConfiguration runtimeConfig, OptionValues
      * @param suites The Graal compilation suites to add to.
      * @param hosted True if registering for ahead-of-time compilation, false if registering for
      *            runtime compilation.
+     * @param fallback True if registering for fallback compilation, false otherwise.
      */
-    default void registerGraalPhases(Providers providers, Suites suites, boolean hosted) {
+    default void registerGraalPhases(Providers providers, Suites suites, boolean hosted, boolean fallback) {
     }
 
     /**

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/graal/GraalConfiguration.java

@@ -124,6 +124,10 @@ public Suites createFirstTierSuites(OptionValues options, @SuppressWarnings("unu
         return ImageSingletons.lookup(SubstrateSuitesCreatorProvider.class).getFirstTierSuitesCreator().createSuites(options, arch);
     }
 
+    public Suites createFallbackSuites(OptionValues options, @SuppressWarnings("unused") boolean hosted, Architecture arch) {
+        return ImageSingletons.lookup(SubstrateSuitesCreatorProvider.class).getFallbackSuitesCreator().createSuites(options, arch);
+    }
+
     public LIRSuites createLIRSuites(OptionValues options) {
         return ImageSingletons.lookup(SubstrateSuitesCreatorProvider.class).getSuitesCreator().createLIRSuites(options);
     }
@@ -132,6 +136,10 @@ public LIRSuites createFirstTierLIRSuites(OptionValues options) {
         return ImageSingletons.lookup(SubstrateSuitesCreatorProvider.class).getFirstTierSuitesCreator().createLIRSuites(options);
     }
 
+    public LIRSuites createFallbackLIRSuites(OptionValues options) {
+        return ImageSingletons.lookup(SubstrateSuitesCreatorProvider.class).getFallbackSuitesCreator().createLIRSuites(options);
+    }
+
     public String getCompilerConfigurationName() {
         return COMPILER_CONFIGURATION_NAME;
     }

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/graal/code/SubstrateSuitesCreatorProvider.java

@@ -25,18 +25,20 @@
  */
 package com.oracle.svm.core.graal.code;
 
+import com.oracle.svm.core.SubstrateOptions;
+
 import jdk.graal.compiler.core.phases.CommunityCompilerConfiguration;
 import jdk.graal.compiler.core.phases.EconomyCompilerConfiguration;
 import jdk.graal.compiler.phases.tiers.CompilerConfiguration;
 import jdk.graal.compiler.phases.tiers.SuitesCreator;
 
-import com.oracle.svm.core.SubstrateOptions;
-
 public class SubstrateSuitesCreatorProvider {
     private final SuitesCreator suitesCreator;
 
     private final SuitesCreator firstTierSuitesCreator;
 
+    private final SuitesCreator fallbackSuitesCreator;
+
     protected static CompilerConfiguration getHostedCompilerConfiguration() {
         if (SubstrateOptions.useEconomyCompilerConfig()) {
             return new EconomyCompilerConfiguration();
@@ -45,13 +47,23 @@ protected static CompilerConfiguration getHostedCompilerConfiguration() {
         }
     }
 
-    protected SubstrateSuitesCreatorProvider(SuitesCreator suitesCreator, SuitesCreator firstTierSuitesCreator) {
+    protected static CompilerConfiguration getFallbackCompilerConfiguration() {
+        return new EconomyCompilerConfiguration();
+    }
+
+    protected SubstrateSuitesCreatorProvider(SuitesCreator suitesCreator, SuitesCreator firstTierSuitesCreator, SuitesCreator fallbackSuitesCreator) {
         this.suitesCreator = suitesCreator;
         this.firstTierSuitesCreator = firstTierSuitesCreator;
+        this.fallbackSuitesCreator = fallbackSuitesCreator;
+    }
+
+    protected SubstrateSuitesCreatorProvider(SuitesCreator suitesCreator, SuitesCreator firstTierSuitesCreator) {
+        this(suitesCreator, firstTierSuitesCreator, new SubstrateSuitesCreator(getFallbackCompilerConfiguration()));
     }
 
     public SubstrateSuitesCreatorProvider() {
-        this(new SubstrateSuitesCreator(getHostedCompilerConfiguration()), new SubstrateSuitesCreator(new EconomyCompilerConfiguration()));
+        this(new SubstrateSuitesCreator(getHostedCompilerConfiguration()), new SubstrateSuitesCreator(new EconomyCompilerConfiguration()),
+                        new SubstrateSuitesCreator(getFallbackCompilerConfiguration()));
     }
 
     public final SuitesCreator getSuitesCreator() {
@@ -61,4 +73,8 @@ public final SuitesCreator getSuitesCreator() {
     public final SuitesCreator getFirstTierSuitesCreator() {
         return firstTierSuitesCreator;
     }
+
+    public final SuitesCreator getFallbackSuitesCreator() {
+        return fallbackSuitesCreator;
+    }
 }

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/graal/snippets/StackOverflowCheckFeature.java

@@ -66,7 +66,7 @@ public void afterRegistration(AfterRegistrationAccess access) {
     }
 
     @Override
-    public void registerGraalPhases(Providers providers, Suites suites, boolean hosted) {
+    public void registerGraalPhases(Providers providers, Suites suites, boolean hosted, boolean fallback) {
         /*
          * There is no need to have the stack overflow check in the graph throughout most of the
          * compilation pipeline. Inserting it before the mid-tier lowering is done for pragmatic

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/graal/stackvalue/StackValueFeature.java

@@ -49,7 +49,7 @@
 @AutomaticallyRegisteredFeature
 public class StackValueFeature implements InternalFeature {
     @Override
-    public void registerGraalPhases(Providers providers, Suites suites, boolean hosted) {
+    public void registerGraalPhases(Providers providers, Suites suites, boolean hosted, boolean fallback) {
         ListIterator<BasePhase<? super MidTierContext>> midTierPos = suites.getMidTier().findPhase(FrameStateAssignmentPhase.class);
         midTierPos.previous();
         midTierPos.add(new StackValueRecursionDepthPhase());

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

@@ -1579,7 +1579,7 @@ public static Suites createSuites(FeatureHandler featureHandler, RuntimeConfigur
         } else {
             suites = GraalConfiguration.runtimeInstance().createSuites(optionsToUse == null ? RuntimeOptionValues.singleton() : optionsToUse, hosted, ConfigurationValues.getTarget().arch);
         }
-        return modifySuites(backend, suites, featureHandler, hosted, false);
+        return modifySuites(backend, suites, featureHandler, hosted, false, false);
     }
 
     public static Suites createSuites(FeatureHandler featureHandler, RuntimeConfiguration runtimeConfig, boolean hosted) {
@@ -1594,18 +1594,34 @@ public static Suites createFirstTierSuites(FeatureHandler featureHandler, Runtim
         } else {
             suites = GraalConfiguration.runtimeInstance().createFirstTierSuites(RuntimeOptionValues.singleton(), hosted, ConfigurationValues.getTarget().arch);
         }
-        return modifySuites(backend, suites, featureHandler, hosted, true);
+        return modifySuites(backend, suites, featureHandler, hosted, true, false);
+    }
+
+    /**
+     * Creates a fallback set of {@link Suites} for the given environment and configuration. These
+     * suites contain fewer optimizations and can be used as a fallback for problematic
+     * compilations.
+     */
+    public static Suites createFallbackSuites(FeatureHandler featureHandler, RuntimeConfiguration runtimeConfig, boolean hosted) {
+        SubstrateBackend backend = runtimeConfig.getBackendForNormalMethod();
+        Suites suites;
+        if (hosted) {
+            suites = GraalConfiguration.hostedInstance().createFallbackSuites(HostedOptionValues.singleton(), hosted, ConfigurationValues.getTarget().arch);
+        } else {
+            suites = GraalConfiguration.runtimeInstance().createFallbackSuites(RuntimeOptionValues.singleton(), hosted, ConfigurationValues.getTarget().arch);
+        }
+        return modifySuites(backend, suites, featureHandler, hosted, false, true);
     }
 
     private static Suites modifySuites(SubstrateBackend backend, Suites suites, FeatureHandler featureHandler,
-                    boolean hosted, boolean firstTier) {
+                    boolean hosted, boolean firstTier, boolean fallback) {
         Providers runtimeCallProviders = backend.getProviders();
 
         PhaseSuite<HighTierContext> highTier = suites.getHighTier();
         PhaseSuite<MidTierContext> midTier = suites.getMidTier();
         PhaseSuite<LowTierContext> lowTier = suites.getLowTier();
 
-        final boolean economy = firstTier || SubstrateOptions.useEconomyCompilerConfig();
+        final boolean economy = firstTier || fallback || SubstrateOptions.useEconomyCompilerConfig();
 
         ListIterator<BasePhase<? super HighTierContext>> position;
         if (hosted) {
@@ -1666,7 +1682,7 @@ private static Suites modifySuites(SubstrateBackend backend, Suites suites, Feat
             }
         }
 
-        featureHandler.forEachGraalFeature(feature -> feature.registerGraalPhases(runtimeCallProviders, suites, hosted));
+        featureHandler.forEachGraalFeature(feature -> feature.registerGraalPhases(runtimeCallProviders, suites, hosted, fallback));
 
         if (hosted && ImageBuildStatistics.Options.CollectImageBuildStatistics.getValue(HostedOptionValues.singleton())) {
             highTier.prependPhase(new ImageBuildStatisticsCounterPhase(ImageBuildStatistics.CheckCountLocation.BEFORE_HIGH_TIER));
@@ -1736,6 +1752,21 @@ public static LIRSuites createFirstTierLIRSuites(FeatureHandler featureHandler,
         return lirSuites;
     }
 
+    @SuppressWarnings("unused")
+    public static LIRSuites createFallbackLIRSuites(FeatureHandler featureHandler, Providers providers, boolean hosted) {
+        LIRSuites lirSuites;
+        if (hosted) {
+            lirSuites = GraalConfiguration.hostedInstance().createFallbackLIRSuites(HostedOptionValues.singleton());
+            lirSuites.getFinalCodeAnalysisStage().appendPhase(new VerifyCFunctionReferenceMapsLIRPhase());
+        } else {
+            lirSuites = GraalConfiguration.runtimeInstance().createFallbackLIRSuites(RuntimeOptionValues.singleton());
+        }
+
+        /* Add phases that just perform assertion checking. */
+        assert addAssertionLIRPhases(lirSuites, hosted);
+        return lirSuites;
+    }
+
     private static boolean addAssertionLIRPhases(LIRSuites lirSuites, boolean hosted) {
         if (hosted) {
             lirSuites.getFinalCodeAnalysisStage().appendPhase(new VerifyDeoptLIRFrameStatesPhase());