1 /*
  2  * Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
  3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  4  *
  5  * This code is free software; you can redistribute it and/or modify it
  6  * under the terms of the GNU General Public License version 2 only, as
  7  * published by the Free Software Foundation.
  8  *
  9  * This code is distributed in the hope that it will be useful, but WITHOUT
 10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 12  * version 2 for more details (a copy is included in the LICENSE file that
 13  * accompanied this code).
 14  *
 15  * You should have received a copy of the GNU General Public License version
 16  * 2 along with this work; if not, write to the Free Software Foundation,
 17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 18  *
 19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 20  * or visit www.oracle.com if you need additional information or have any
 21  * questions.
 22  *
 23  */
 24 
 25 #include "gc/shenandoah/heuristics/shenandoahYoungHeuristics.hpp"
 26 #include "gc/shenandoah/shenandoahClosures.inline.hpp"
 27 #include "gc/shenandoah/shenandoahFreeSet.hpp"
 28 #include "gc/shenandoah/shenandoahGeneration.hpp"
 29 #include "gc/shenandoah/shenandoahGenerationalHeap.hpp"
 30 #include "gc/shenandoah/shenandoahHeap.inline.hpp"
 31 #include "gc/shenandoah/shenandoahMonitoringSupport.hpp"
 32 #include "gc/shenandoah/shenandoahOldGC.hpp"
 33 #include "gc/shenandoah/shenandoahOldGeneration.hpp"
 34 #include "gc/shenandoah/shenandoahYoungGeneration.hpp"
 35 #include "prims/jvmtiTagMap.hpp"
 36 #include "utilities/events.hpp"
 37 
 38 
 39 ShenandoahOldGC::ShenandoahOldGC(ShenandoahOldGeneration* generation, ShenandoahSharedFlag& allow_preemption) :
 40     ShenandoahConcurrentGC(generation, false), _old_generation(generation), _allow_preemption(allow_preemption) {
 41 }
 42 
 43 // Final mark for old-gen is different for young than old, so we
 44 // override the implementation.
 45 void ShenandoahOldGC::op_final_mark() {
 46 
 47   ShenandoahGenerationalHeap* const heap = ShenandoahGenerationalHeap::heap();
 48   assert(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "Should be at safepoint");
 49   assert(!heap->has_forwarded_objects(), "No forwarded objects on this path");
 50 
 51   if (ShenandoahVerify) {
 52     heap->verifier()->verify_roots_no_forwarded(_old_generation);
 53   }
 54 
 55   if (!heap->cancelled_gc()) {
 56     assert(_mark.generation()->is_old(), "Generation of Old-Gen GC should be OLD");
 57     _mark.finish_mark();
 58     assert(!heap->cancelled_gc(), "STW mark cannot OOM");
 59 
 60     // Old collection is complete, the young generation no longer needs this
 61     // reference to the old concurrent mark so clean it up.
 62     heap->young_generation()->set_old_gen_task_queues(nullptr);
 63 
 64     // We need to do this because weak root cleaning reports the number of dead handles
 65     JvmtiTagMap::set_needs_cleaning();
 66 
 67     _generation->prepare_regions_and_collection_set(true);
 68 
 69     heap->set_unload_classes(false);
 70     heap->prepare_concurrent_roots();
 71 
 72     if (VerifyAfterGC) {
 73       Universe::verify();
 74     }
 75 
 76     {
 77       ShenandoahTimingsTracker timing(ShenandoahPhaseTimings::final_mark_propagate_gc_state);
 78       heap->propagate_gc_state_to_all_threads();
 79     }
 80   }
 81 }
 82 
 83 bool ShenandoahOldGC::collect(GCCause::Cause cause) {
 84   auto heap = ShenandoahGenerationalHeap::heap();
 85   assert(!_old_generation->is_doing_mixed_evacuations(), "Should not start an old gc with pending mixed evacuations");
 86   assert(!_old_generation->is_preparing_for_mark(), "Old regions need to be parsable during concurrent mark.");
 87 
 88   // Enable preemption of old generation mark.
 89   _allow_preemption.set();
 90 
 91   // Continue concurrent mark, do not reset regions, do not mark roots, do not collect $200.
 92   entry_mark();
 93 
 94   // If we failed to unset the preemption flag, it means another thread has already unset it.
 95   if (!_allow_preemption.try_unset()) {
 96     // The regulator thread has unset the preemption guard. That thread will shortly cancel
 97     // the gc, but the control thread is now racing it. Wait until this thread sees the
 98     // cancellation.
 99     while (!heap->cancelled_gc()) {
100       SpinPause();
101     }
102   }
103 
104   if (heap->cancelled_gc()) {
105     return false;
106   }
107 
108   // Complete marking under STW
109   vmop_entry_final_mark();
110 
111   if (_generation->is_concurrent_mark_in_progress()) {
112     assert(heap->cancelled_gc(), "Safepoint operation observed gc cancellation");
113     // GC may have been cancelled before final mark, but after the preceding cancellation check.
114     return false;
115   }
116 
117   // We aren't dealing with old generation evacuation yet. Our heuristic
118   // should not have built a cset in final mark.
119   assert(!heap->is_evacuation_in_progress(), "Old gen evacuations are not supported");
120 
121   // Process weak roots that might still point to regions that would be broken by cleanup
122   if (heap->is_concurrent_weak_root_in_progress()) {
123     entry_weak_refs();
124     entry_weak_roots();
125   }
126 
127   // Final mark might have reclaimed some immediate garbage, kick cleanup to reclaim
128   // the space. This would be the last action if there is nothing to evacuate.
129   entry_cleanup_early();
130 
131   assert(!heap->is_concurrent_strong_root_in_progress(), "No evacuations during old gc.");
132 
133   // We must execute this vm operation if we completed final mark. We cannot
134   // return from here with weak roots in progress. This is not a valid gc state
135   // for any young collections (or allocation failures) that interrupt the old
136   // collection.
137   heap->concurrent_final_roots();
138 
139   // Arm the nmethods to possibly flip the barriers to idle.
140   vmop_entry_final_verify();
141 
142   // Now we are back at concurrent phase, process nmethods to fix their barriers.
143   // TODO: Is this really safe to do when we overlap with young GC?
144   ShenandoahCodeRoots::disarm_nmethods();
145 
146   // After concurrent old marking finishes, we reclaim immediate garbage. Further, we may also want to expand OLD in order
147   // to make room for anticipated promotions and/or for mixed evacuations.  Mixed evacuations are especially likely to
148   // follow the end of OLD marking.
149   heap->rebuild_free_set_within_phase();
150   heap->free_set()->log_status_under_lock();
151   return true;
152 }