8308009: Generational ZGC: OOM before clearing all SoftReferences

Reviewed-by: stefank, aboldtch

Author: fisk

src/hotspot/share/gc/z/zDriver.cpp

@@ -302,6 +302,14 @@ static bool should_preclean_young(GCCause::Cause cause) {
     return true;
   }
 
+  // It is important that when soft references are cleared, we also pre-clean the young
+  // generation, as we might otherwise throw premature OOM. Therefore, all causes that
+  // trigger soft ref cleaning must also trigger pre-cleaning of young gen. If allocations
+  // stalled when checking for soft ref cleaning, then since we hold the driver locker all
+  // the way until we check for young gen pre-cleaning, we can be certain that we should
+  // catch that above and perform young gen pre-cleaning.
+  assert(!should_clear_soft_references(cause), "Clearing soft references without pre-cleaning young gen");
+
   // Preclean young if implied by configuration
   return ScavengeBeforeFullGC;
 }
@@ -385,10 +393,6 @@ class ZDriverScopeMajor : public StackObj {
       _gc_cause_setter(ZDriver::major(), _gc_cause),
       _stat_timer(ZPhaseCollectionMajor, gc_timer),
       _tracer(false /* minor */) {
-    // Set up soft reference policy
-    const bool clear = should_clear_soft_references(request.cause());
-    ZGeneration::old()->set_soft_reference_policy(clear);
-
     // Select number of worker threads to use
     ZGeneration::young()->set_active_workers(request.young_nworkers());
     ZGeneration::old()->set_active_workers(request.old_nworkers());
@@ -441,12 +445,12 @@ void ZDriverMajor::gc(const ZDriverRequest& request) {
   collect_old();
 }
 
-static void handle_alloc_stalling_for_old() {
-  ZHeap::heap()->handle_alloc_stalling_for_old();
+static void handle_alloc_stalling_for_old(bool cleared_soft_refs) {
+  ZHeap::heap()->handle_alloc_stalling_for_old(cleared_soft_refs);
 }
 
-void ZDriverMajor::handle_alloc_stalls() const {
-  handle_alloc_stalling_for_old();
+void ZDriverMajor::handle_alloc_stalls(bool cleared_soft_refs) const {
+  handle_alloc_stalling_for_old(cleared_soft_refs);
 }
 
 void ZDriverMajor::run_thread() {
@@ -461,6 +465,10 @@ void ZDriverMajor::run_thread() {
 
     abortpoint();
 
+    // Set up soft reference policy
+    const bool clear_soft_refs = should_clear_soft_references(request.cause());
+    ZGeneration::old()->set_soft_reference_policy(clear_soft_refs);
+
     // Run GC
     gc(request);
 
@@ -470,7 +478,7 @@ void ZDriverMajor::run_thread() {
     _port.ack();
 
     // Handle allocation stalls
-    handle_alloc_stalls();
+    handle_alloc_stalls(clear_soft_refs);
 
     ZBreakpoint::at_after_gc();
   }

src/hotspot/share/gc/z/zDriver.hpp

@@ -112,7 +112,7 @@ class ZDriverMajor : public ZDriver {
 
   void collect_old();
   void gc(const ZDriverRequest& request);
-  void handle_alloc_stalls() const;
+  void handle_alloc_stalls(bool cleared_soft_refs) const;
 
 protected:
   virtual void run_thread();

src/hotspot/share/gc/z/zHeap.hpp

@@ -111,7 +111,7 @@ class ZHeap {
   bool is_alloc_stalling() const;
   bool is_alloc_stalling_for_old() const;
   void handle_alloc_stalling_for_young();
-  void handle_alloc_stalling_for_old();
+  void handle_alloc_stalling_for_old(bool cleared_soft_refs);
 
   // Continuations
   bool is_allocating(zaddress addr) const;

src/hotspot/share/gc/z/zHeap.inline.hpp

@@ -86,8 +86,8 @@ inline void ZHeap::handle_alloc_stalling_for_young() {
   _page_allocator.handle_alloc_stalling_for_young();
 }
 
-inline void ZHeap::handle_alloc_stalling_for_old() {
-  _page_allocator.handle_alloc_stalling_for_old();
+inline void ZHeap::handle_alloc_stalling_for_old(bool cleared_soft_refs) {
+  _page_allocator.handle_alloc_stalling_for_old(cleared_soft_refs);
 }
 
 inline bool ZHeap::is_oop(uintptr_t addr) const {

src/hotspot/share/gc/z/zPageAllocator.cpp

@@ -985,9 +985,11 @@ void ZPageAllocator::handle_alloc_stalling_for_young() {
   restart_gc();
 }
 
-void ZPageAllocator::handle_alloc_stalling_for_old() {
+void ZPageAllocator::handle_alloc_stalling_for_old(bool cleared_soft_refs) {
   ZLocker<ZLock> locker(&_lock);
-  notify_out_of_memory();
+  if (cleared_soft_refs) {
+    notify_out_of_memory();
+  }
   restart_gc();
 }
 

src/hotspot/share/gc/z/zPageAllocator.hpp

@@ -163,7 +163,7 @@ class ZPageAllocator {
   bool is_alloc_stalling() const;
   bool is_alloc_stalling_for_old() const;
   void handle_alloc_stalling_for_young();
-  void handle_alloc_stalling_for_old();
+  void handle_alloc_stalling_for_old(bool cleared_soft_refs);
 
   void threads_do(ThreadClosure* tc) const;
 };