1 /*
  2  * Copyright (c) 2005, 2023, Oracle and/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 "precompiled.hpp"
 26 #include "gc/parallel/objectStartArray.hpp"
 27 #include "gc/parallel/parMarkBitMap.inline.hpp"
 28 #include "gc/parallel/parallelScavengeHeap.hpp"
 29 #include "gc/parallel/psCompactionManager.inline.hpp"
 30 #include "gc/parallel/psOldGen.hpp"
 31 #include "gc/parallel/psParallelCompact.inline.hpp"
 32 #include "gc/shared/taskqueue.inline.hpp"
 33 #include "logging/log.hpp"
 34 #include "memory/iterator.inline.hpp"
 35 #include "oops/access.inline.hpp"
 36 #include "oops/compressedOops.inline.hpp"
 37 #include "oops/instanceKlass.inline.hpp"
 38 #include "oops/instanceMirrorKlass.inline.hpp"
 39 #include "oops/objArrayKlass.inline.hpp"
 40 #include "oops/oop.inline.hpp"
 41 
 42 PSOldGen*               ParCompactionManager::_old_gen = nullptr;
 43 ParCompactionManager**  ParCompactionManager::_manager_array = nullptr;
 44 
 45 ParCompactionManager::OopTaskQueueSet*      ParCompactionManager::_oop_task_queues = nullptr;
 46 ParCompactionManager::ObjArrayTaskQueueSet* ParCompactionManager::_objarray_task_queues = nullptr;
 47 ParCompactionManager::RegionTaskQueueSet*   ParCompactionManager::_region_task_queues = nullptr;
 48 
 49 ObjectStartArray*    ParCompactionManager::_start_array = nullptr;
 50 ParMarkBitMap*       ParCompactionManager::_mark_bitmap = nullptr;
 51 GrowableArray<size_t >* ParCompactionManager::_shadow_region_array = nullptr;
 52 Monitor*                ParCompactionManager::_shadow_region_monitor = nullptr;
 53 
 54 ParCompactionManager::ParCompactionManager() {
 55 
 56   ParallelScavengeHeap* heap = ParallelScavengeHeap::heap();
 57 
 58   _old_gen = heap->old_gen();
 59   _start_array = old_gen()->start_array();
 60 
 61   reset_bitmap_query_cache();
 62 
 63   _deferred_obj_array = new (mtGC) GrowableArray<HeapWord*>(10, mtGC);
 64 }
 65 
 66 void ParCompactionManager::initialize(ParMarkBitMap* mbm) {
 67   assert(ParallelScavengeHeap::heap() != nullptr,
 68     "Needed for initialization");
 69 
 70   _mark_bitmap = mbm;
 71 
 72   uint parallel_gc_threads = ParallelScavengeHeap::heap()->workers().max_workers();
 73 
 74   assert(_manager_array == nullptr, "Attempt to initialize twice");
 75   _manager_array = NEW_C_HEAP_ARRAY(ParCompactionManager*, parallel_gc_threads, mtGC);
 76 
 77   _oop_task_queues = new OopTaskQueueSet(parallel_gc_threads);
 78   _objarray_task_queues = new ObjArrayTaskQueueSet(parallel_gc_threads);
 79   _region_task_queues = new RegionTaskQueueSet(parallel_gc_threads);
 80 
 81   // Create and register the ParCompactionManager(s) for the worker threads.
 82   for(uint i=0; i<parallel_gc_threads; i++) {
 83     _manager_array[i] = new ParCompactionManager();
 84     oop_task_queues()->register_queue(i, _manager_array[i]->oop_stack());
 85     _objarray_task_queues->register_queue(i, &_manager_array[i]->_objarray_stack);
 86     region_task_queues()->register_queue(i, _manager_array[i]->region_stack());
 87   }
 88 
 89   assert(ParallelScavengeHeap::heap()->workers().max_workers() != 0,
 90     "Not initialized?");
 91 
 92   _shadow_region_array = new (mtGC) GrowableArray<size_t >(10, mtGC);
 93 
 94   _shadow_region_monitor = new Monitor(Mutex::nosafepoint, "CompactionManager_lock");
 95 }
 96 
 97 void ParCompactionManager::reset_all_bitmap_query_caches() {
 98   uint parallel_gc_threads = ParallelScavengeHeap::heap()->workers().max_workers();
 99   for (uint i=0; i<parallel_gc_threads; i++) {
100     _manager_array[i]->reset_bitmap_query_cache();
101   }
102 }
103 
104 void ParCompactionManager::flush_all_string_dedup_requests() {
105   uint parallel_gc_threads = ParallelScavengeHeap::heap()->workers().max_workers();
106   for (uint i=0; i<parallel_gc_threads; i++) {
107     _manager_array[i]->flush_string_dedup_requests();
108   }
109 }
110 
111 ParCompactionManager*
112 ParCompactionManager::gc_thread_compaction_manager(uint index) {
113   assert(index < ParallelGCThreads, "index out of range");
114   assert(_manager_array != nullptr, "Sanity");
115   return _manager_array[index];
116 }
117 
118 inline void ParCompactionManager::publish_and_drain_oop_tasks() {
119   oop obj;
120   while (oop_stack()->pop_overflow(obj)) {
121     if (!oop_stack()->try_push_to_taskqueue(obj)) {
122       follow_contents(obj);
123     }
124   }
125   while (oop_stack()->pop_local(obj)) {
126     follow_contents(obj);
127   }
128 }
129 
130 bool ParCompactionManager::publish_or_pop_objarray_tasks(ObjArrayTask& task) {
131   while (_objarray_stack.pop_overflow(task)) {
132     if (!_objarray_stack.try_push_to_taskqueue(task)) {
133       return true;
134     }
135   }
136   return false;
137 }
138 
139 void ParCompactionManager::follow_marking_stacks() {
140   do {
141     // First, try to move tasks from the overflow stack into the shared buffer, so
142     // that other threads can steal. Otherwise process the overflow stack first.
143     publish_and_drain_oop_tasks();
144 
145     // Process ObjArrays one at a time to avoid marking stack bloat.
146     ObjArrayTask task;
147     if (publish_or_pop_objarray_tasks(task) ||
148         _objarray_stack.pop_local(task)) {
149       follow_array((objArrayOop)task.obj(), task.index());
150     }
151   } while (!marking_stacks_empty());
152 
153   assert(marking_stacks_empty(), "Sanity");
154 }
155 
156 void ParCompactionManager::drain_region_stacks() {
157   do {
158     // Drain overflow stack first so other threads can steal.
159     size_t region_index;
160     while (region_stack()->pop_overflow(region_index)) {
161       PSParallelCompact::fill_and_update_region(this, region_index);
162     }
163 
164     while (region_stack()->pop_local(region_index)) {
165       PSParallelCompact::fill_and_update_region(this, region_index);
166     }
167   } while (!region_stack()->is_empty());
168 }
169 
170 void ParCompactionManager::drain_deferred_objects() {
171   while (!_deferred_obj_array->is_empty()) {
172     HeapWord* addr = _deferred_obj_array->pop();
173     assert(addr != nullptr, "expected a deferred object");
174     PSParallelCompact::update_deferred_object(this, addr);
175   }
176   _deferred_obj_array->clear_and_deallocate();
177 }
178 
179 size_t ParCompactionManager::pop_shadow_region_mt_safe(PSParallelCompact::RegionData* region_ptr) {
180   MonitorLocker ml(_shadow_region_monitor, Mutex::_no_safepoint_check_flag);
181   while (true) {
182     if (!_shadow_region_array->is_empty()) {
183       return _shadow_region_array->pop();
184     }
185     // Check if the corresponding heap region is available now.
186     // If so, we don't need to get a shadow region anymore, and
187     // we return InvalidShadow to indicate such a case.
188     if (region_ptr->claimed()) {
189       return InvalidShadow;
190     }
191     ml.wait(1);
192   }
193 }
194 
195 void ParCompactionManager::push_shadow_region_mt_safe(size_t shadow_region) {
196   MonitorLocker ml(_shadow_region_monitor, Mutex::_no_safepoint_check_flag);
197   _shadow_region_array->push(shadow_region);
198   ml.notify();
199 }
200 
201 void ParCompactionManager::push_shadow_region(size_t shadow_region) {
202   _shadow_region_array->push(shadow_region);
203 }
204 
205 void ParCompactionManager::remove_all_shadow_regions() {
206   _shadow_region_array->clear();
207 }
208 
209 void ParCompactionManager::push_deferred_object(HeapWord* addr) {
210   _deferred_obj_array->push(addr);
211 }
212 
213 #ifdef ASSERT
214 void ParCompactionManager::verify_all_marking_stack_empty() {
215   uint parallel_gc_threads = ParallelGCThreads;
216   for (uint i = 0; i < parallel_gc_threads; i++) {
217     assert(_manager_array[i]->marking_stacks_empty(), "Marking stack should be empty");
218   }
219 }
220 
221 void ParCompactionManager::verify_all_region_stack_empty() {
222   uint parallel_gc_threads = ParallelGCThreads;
223   for (uint i = 0; i < parallel_gc_threads; i++) {
224     assert(_manager_array[i]->region_stack()->is_empty(), "Region stack should be empty");
225   }
226 }
227 #endif