[GR-38413] Add support for -XX:+ExitOnOutOfMemoryError

[vsevel]

Feature request

Is your feature request related to a problem? Please describe.
When we get an OOM, we want the pod to restart automatically. We need the ExitOnOutOfMemoryError for this.

Describe the solution you'd like.
Support for the ExitOnOutOfMemoryError flag in GraalVM Native Image.

Describe who do you think will benefit the most.
GraalVM users.

Describe alternatives you've considered.
A hack is to allocate a heap that will make the memory of the container grow bigger than its limit. But that is hard to tune.

Additional context.
N/A

Express whether you'd like to help contributing this feature
If you'd like to contribute, please read the contribution guide.

[dougxc]

This should already work since it is a HotSpot feature and GraalVM is built on top of HotSpot. Are you able to provide a reproducer showing that it does not work?

[vsevel]

hi @dougxc
here is what I get if I try to pass the option to a native version of my application:

$ ./target/transfosettlement-1.0.0-SNAPSHOT-runner -XX:+ExitOnOutOfMemoryError 
error: Could not find option 'ExitOnOutOfMemoryError'. Use -XX:PrintFlags= to list all available options.

When I print the options I get:

$ ./target/transfosettlement-1.0.0-SNAPSHOT-runner -XX:PrintFlags=

  -XX:ActiveProcessorCount=-1                  Overwrites the available number of processors provided by the OS. Any value <= 0 means using the processor count from
                                               the OS.
  -XX:±CollectYoungGenerationSeparately        Determines if a full GC collects the young generation separately or together with the old generation.
  -XX:DiagnosticDetails=""                     Specifies how many details are printed for certain diagnostic thunks, e.g.: 'DumpThreads:1,DumpRegisters:2'. A value of
                                               1 will result in the maximum amount of information, higher values will print less information. By default, the most
                                               detailed output is enabled for all diagnostic thunks. Wildcards (*) are supported in the name of the diagnostic thunk.
  -XX:±DisableExplicitGC                       Ignore calls to System.gc(). Default: - (disabled).
  -XX:±EagerSnippets                           Eagerly construct extra snippet info. Default: - (disabled).
  -XX:±InstallSegfaultHandler                  Install segfault handler that prints register contents and full Java stacktrace. Default: enabled for an executable,
                                               disabled for a shared library.
  -XX:MaxDirectMemorySize=0                    Maximum total size of NIO direct-buffer allocations.
  -XX:MaxHeapFree=0                            The maximum free bytes reserved for allocations, in bytes (0 for automatic according to GC policy).
  -XX:MaxHeapSize=0                            The maximum heap size at run-time, in bytes.
  -XX:MaxJavaStackTraceDepth=1024              The maximum number of lines in the stack trace for Java exceptions (0 means all).
  -XX:MaxNewSize=0                             The maximum size of the young generation at run-time, in bytes.
  -XX:MaximumHeapSizePercent=80                The maximum heap size as percent of physical memory.
  -XX:MaximumYoungGenerationSizePercent=10     The maximum size of the young generation as a percentage of the maximum heap size.
  -XX:MinHeapSize=0                            The minimum heap size at run-time, in bytes.
  -XX:PercentTimeInIncrementalCollection=50    Percentage of total collection time that should be spent on young generation collections.
  -XX:±PreferContainerQuotaForCPUCount         Calculate the container CPU availability based on the value of quotas (if set), when true. Otherwise, use the CPU shares
                                               value, provided it is less than quota. Default: + (enabled).
  -XX:PrintFlags=...                           Show available options based on comma-separated option-types (allowed categories: User, Expert, Debug). Default: None
  -XX:PrintFlagsWithExtraHelp=...              Print extra help, if available, based on comma-separated option names. Pass * to show all options that contain extra
                                               help. Default: None
  -XX:±PrintGC                                 Print summary GC information after each collection. Default: - (disabled).
  -XX:±PrintGCSummary                          Print summary GC information after application main method returns. Default: - (disabled).
  -XX:±PrintGCTimeStamps                       Print a time stamp at each collection, if +PrintGC or +VerboseGC. Default: - (disabled).
  -XX:±PrintGCTimes                            Print the time for each of the phases of each collection, if +VerboseGC. Default: - (disabled).
  -XX:±PrintHeapShape                          Print the shape of the heap before and after each collection, if +VerboseGC. Default: - (disabled).
  -XX:SafepointPromptnessFailureNanos=0        Exit the VM if I can not come to a safepoint in this many nanoseconds. 0 implies forever.
  -XX:SafepointPromptnessWarningNanos=0        Print a warning if I can not come to a safepoint in this many nanoseconds. 0 implies forever.
  -XX:StackSize=0                              The size of each thread stack at run-time, in bytes.
  -XX:TearDownFailureNanos=0                   The number of nanoseconds before tearing down an isolate gives a failure message.  0 implies no message.
  -XX:TearDownWarningNanos=0                   The number of nanoseconds before and between which tearing down an isolate gives a warning message.  0 implies no
                                               warning.
  -XX:±TraceHeapChunks                         Trace heap chunks during collections, if +VerboseGC and +PrintHeapShape. Default: - (disabled).
  -XX:±VerboseGC                               Print more information about the heap before and after each collection. Default: - (disabled).

I do not see the option listed here. how can we pass it?

of course if I run in jvm mode, there is no issue:

$  java -XX:+ExitOnOutOfMemoryError -XX:+UseSerialGC -Xlog:gc=info -jar target/quarkus-app/quarkus-run.jar

Anything I am missing? Thanks.

[dougxc]

Ah, you want this feature for GraalVM Native Image, not GraalVM JVM (I know this can be confusing!)

@peter-hofer is there already something like this for Native Image?

[fniephaus]

I don't think this is supported yet, it certainly isn't for G1GC that comes with GraalVM EE Native Image. I'm sure @christianhaeubl knows more about this though.

I've updated the initial issue description to make clear this is about Native Image and am tracking this internally via GR-38413.

[vsevel]

thanks @fniephaus

[christianhaeubl]

This feature is currently not supported by Native Image, regardless of the used garbage collector. It should be fairly simple to implement though because the HotSpot JVM only exits if an OutOfMemoryError is thrown by object allocation routines in the VM (see https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8257790).

[zakkak]

WIP PR #4520

[fniephaus]

This has been fixed in de89b2f.

@vsevel you can test this in a few hours using the next GraalVM dev build. The new feature will ship with GraalVM 22.2. Please feel free to re-open if something is not working for you.