Enable --install-exit-handlers by default

Enable `--install-exit-handlers` by default and deprecate the option: Image size increase is negligable (10 types with 53 mehtods), and there is only 2.5% extra starup instructions (68498) for "Hello, World!" on Linux.

Author: vjovanov

docs/reference-manual/native-image/BuildOptions.md

@@ -59,7 +59,6 @@ Run `native-image --help` for help on build options.
 * `--gc=<value>`: select a Native Image garbage collector implementation. Allowed options for `<value>` are: `G1` for G1 garbage collector (not available in GraalVM Community Edition); `epsilon` for Epsilon garbage collector; `serial` for Serial garbage collector (default).
 * `--initialize-at-build-time`: a comma-separated list of packages and classes (and implicitly all of their superclasses) that are initialized during generation of a native executable. An empty string designates all packages.
 * `--initialize-at-run-time`: a comma-separated list of packages and classes (and implicitly all of their subclasses) that must be initialized at run time and not during generation. An empty string is currently not supported.
-* `--install-exit-handlers`: provide `java.lang.Terminator` exit handlers
 * `--libc`: select the `libc` implementation to use. Available implementations are `glibc`, `musl`, `bionic`.
 * `--link-at-build-time`: require types to be fully defined at native executable build time. If used without arguments, all classes in scope of the option are required to be fully defined.
 * `--link-at-build-time-paths`: require all types in given class or module path entries to be fully defined at native executable build time

docs/reference-manual/native-image/Compatibility.md

@@ -51,15 +51,6 @@ Native Image implements some Java features differently to the Java VM.
 
 `java.lang.System#setSecurityManager(SecurityManager)` invoked with a non-null argument throws a `java.lang.SecurityException` if `-Djava.security.manager` is set to anything but `disallow` at program startup.
 
-### Signal Handlers
-
-Registering a signal handler requires a new thread to start that handles the signal and invokes shutdown hooks.
-By default, no signal handlers are registered when building a native image, unless they are registered explicitly by the user.
-For example, it is not recommended to register the default signal handlers when building a shared library, but it is desirable to include signal handlers when building a native executable for containerized environments, such as Docker containers.
-
-To register the default signal handlers, pass the `--install-exit-handlers` option to the `native-image` builder.
-This option gives you the same signal handlers as a Java VM.
-
 ### Class Initializers
 
 By default, classes are initialized at run time.

docs/reference-manual/native-image/guides/troubleshoot-run-time-errors.md

@@ -47,23 +47,19 @@ Otherwise, the `System.getProperty("java.home")` call will return a `null` value
 Try enabling all URL protocols on-demand at build time: `--enable-url-protocols=<protocols>`.
 To enable the HTTPS support only, pass `--enable-https`. 
 
-### 4. Enable Signal Handling
-
-If your application is using signal handling or the `java.lang.Terminator` exit handlers, provide the option `--install-exit-handlers` option at build time.
-
-### 5. Include All Charsets and Locales
+### 4. Include All Charsets and Locales
 
 Other handy options are `-H:+AddAllCharsets` to add charsets support, and `-H:+IncludeAllLocales` to pre-initialize support for locale-sensitive behavior in the `java.util` and `java.text` packages. 
 Pass those options at build time.
 This might increase the size of the resulting binary.
 
-### 6. Add Missing Security Providers
+### 5. Add Missing Security Providers
 
 If your application is using Security Providers, try to pre-initialize security providers by passing the option `-H:AdditionalSecurityProviders=<list-of-providers>` at build time. 
 Here is a list of all JDK security providers to choose from:
 `sun.security.provider.Sun,sun.security.rsa.SunRsaSign,sun.security.ec.SunEC,sun.security.ssl.SunJSSE,com.sun.crypto.provider.SunJCE,sun.security.jgss.SunProvider,com.sun.security.sasl.Provider,org.jcp.xml.dsig.internal.dom.XMLDSigRI,sun.security.smartcardio.SunPCSC,sun.security.provider.certpath.ldap.JdkLDAP,com.sun.security.sasl.gsskerb.JdkSASL`.
 
-### 7. File a Native Image Run-Time Issue
+### 6. File a Native Image Run-Time Issue
 
 Only if you tried all the above suggestions, file a [Native Image Run-Time Issue Report](https://github.com/oracle/graal/issues/new?assignees=&labels=native-image%2Cbug%2Crun-time&projects=&template=1_1_native_image_run_time_bug_report.yml&title=%5BNative+Image%5D+) at GitHub, filling out the necessary information. 
 

sdk/mx.sdk/mx_sdk_benchmark.py

@@ -1468,7 +1468,6 @@ def run_stage_instrument_run(self):
                     mx.abort(
                         f"Profile file {self.config.profile_path} does not exist "
                         f"even though the instrument run terminated successfully with exit code 0. "
-                        f"Try adding the '--install-exit-handlers' build option if it is not present."
                     )
                 print(f"Profile file {self.config.profile_path} sha1 is {mx.sha1OfFile(self.config.profile_path)}")
                 self._ensureSamplesAreInProfile(self.config.profile_path)

sdk/mx.sdk/mx_sdk_vm_impl.py

@@ -1423,7 +1423,6 @@ def contents(self):
 
             if isinstance(image_config, mx_sdk.LauncherConfig) or (isinstance(image_config, mx_sdk.LanguageLibraryConfig) and image_config.launchers):
                 build_args += [
-                    '--install-exit-handlers',
                     '--enable-monitoring=jvmstat,heapdump,jfr,threaddump',
                 ] + svm_experimental_options([
                     '-H:+DumpRuntimeCompilationOnSignal',

sdk/mx.sdk/mx_sdk_vm_ng.py

@@ -353,7 +353,7 @@ def get_build_args(self):
         build_args += [
             '-R:+EnableSignalHandling',
             '-R:+InstallSegfaultHandler',
-            '--install-exit-handlers',
+            '-H:+InstallJavaExitHandlersForSharedLibrary',
         ]
 
         # Monitoring flags

sdk/src/org.graalvm.maven.downloader/src/META-INF/native-image/org.graalvm.sdk/maven-downloader/native-image.properties

@@ -1,4 +1,3 @@
 Args = --enable-url-protocols=http,https \
-       --install-exit-handlers \
        --initialize-at-build-time=org.graalvm.maven.downloader.OptionProperties \
        --initialize-at-run-time=org.graalvm.maven.downloader.Main,org.graalvm.maven.downloader.MVNDownloader,org.graalvm.maven.downloader.Main$Arguments,org.graalvm.maven.downloader.MVNDownloader$DeleteDownloadDir

substratevm/CHANGELOG.md

@@ -16,6 +16,7 @@ This changelog summarizes major changes to GraalVM Native Image.
     1. `run-time-initialized-jdk` shifts away from build-time initialization of the JDK, instead initializing most of it at run time. This transition is gradual, with individual components of the JDK becoming run-time initialized in each release. This process should complete with JDK 29 when this option should not be needed anymore. Unless you store classes from the JDK in the image heap, this option should not affect you. In case this option breaks your build, follow the suggestions in the error messages.
 * (GR-63494) Recurring callback support is no longer enabled by default. If this feature is needed, please specify `-H:+SupportRecurringCallback` at image build-time.
 * (GR-60209) New syntax for configuration of the [Foreign Function & Memory API](https://github.com/oracle/graal/blob/master/docs/reference-manual/native-image/ForeignInterface.md)
+* (GR-64787) Enable `--install-exit-handlers` by default and deprecate the option: Image size increase is negligible (10 new types and 53 new methods), and there is only 2.5% extra startup instructions (68498) for "Hello, World!" on Linux.
 
 ## GraalVM for JDK 24 (Internal Version 24.2.0)
 * (GR-59717) Added `DuringSetupAccess.registerObjectReachabilityHandler` to allow registering a callback that is executed when an object of a specified type is marked as reachable during heap scanning.

substratevm/mx.substratevm/mx_substratevm_benchmark.py

@@ -352,11 +352,6 @@ def extra_run_arg(self, benchmark, args, image_run_args):
         # Added by BaristaNativeImageCommand
         return []
 
-    def extra_image_build_argument(self, benchmark, args):
-        return [
-            "--install-exit-handlers"
-        ] + super().extra_image_build_argument(benchmark, args)
-
     def run(self, benchmarks, bmSuiteArgs) -> mx_benchmark.DataPoints:
         self.context = mx_sdk_benchmark.BaristaBenchmarkSuite.RuntimeContext(self, None, benchmarks[0], bmSuiteArgs)
         return self.intercept_run(super(), benchmarks, bmSuiteArgs)

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

@@ -24,6 +24,8 @@
  */
 package com.oracle.svm.core;
 
+import org.graalvm.nativeimage.ImageInfo;
+
 import com.oracle.svm.core.annotate.Alias;
 import com.oracle.svm.core.annotate.TargetClass;
 import com.oracle.svm.core.feature.AutomaticallyRegisteredFeature;
@@ -34,7 +36,7 @@
 public class SubstrateExitHandlerFeature implements InternalFeature {
     @Override
     public void beforeAnalysis(BeforeAnalysisAccess access) {
-        if (SubstrateOptions.needsExitHandlers()) {
+        if (!ImageInfo.isSharedLibrary() || SubstrateOptions.DeprecatedOptions.InstallExitHandlers.getValue() || SubstrateOptions.InstallJavaExitHandlersForSharedLibrary.getValue()) {
             RuntimeSupport.getRuntimeSupport().addStartupHook(new SubstrateExitHandlerStartupHook());
         }
     }
@@ -43,6 +45,9 @@ public void beforeAnalysis(BeforeAnalysisAccess access) {
 final class SubstrateExitHandlerStartupHook implements RuntimeSupport.Hook {
     @Override
     public void execute(boolean isFirstIsolate) {
+        if (!SubstrateOptions.EnableSignalHandling.getValue()) {
+            throw new UnsupportedOperationException("java.lang.Terminator can only be set when -XX:+EnableSignalHandling is set");
+        }
         if (isFirstIsolate) {
             Target_java_lang_Terminator.setup();
         }