1 /*
  2  * Copyright (c) 2019, 2020, Red Hat, Inc. All rights reserved.
  3  * Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
  4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  5  *
  6  * This code is free software; you can redistribute it and/or modify it
  7  * under the terms of the GNU General Public License version 2 only, as
  8  * published by the Free Software Foundation.
  9  *
 10  * This code is distributed in the hope that it will be useful, but WITHOUT
 11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 13  * version 2 for more details (a copy is included in the LICENSE file that
 14  * accompanied this code).
 15  *
 16  * You should have received a copy of the GNU General Public License version
 17  * 2 along with this work; if not, write to the Free Software Foundation,
 18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 19  *
 20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 21  * or visit www.oracle.com if you need additional information or have any
 22  * questions.
 23  *
 24  */
 25 #ifndef SHARE_GC_SHENANDOAH_SHENANDOAHCLOSURES_INLINE_HPP
 26 #define SHARE_GC_SHENANDOAH_SHENANDOAHCLOSURES_INLINE_HPP
 27 
 28 #include "gc/shenandoah/shenandoahClosures.hpp"
 29 
 30 #include "gc/shared/barrierSetNMethod.hpp"
 31 #include "gc/shenandoah/shenandoahAsserts.hpp"
 32 #include "gc/shenandoah/shenandoahBarrierSet.hpp"
 33 #include "gc/shenandoah/shenandoahEvacOOMHandler.inline.hpp"
 34 #include "gc/shenandoah/shenandoahMarkingContext.inline.hpp"
 35 #include "gc/shenandoah/shenandoahHeap.inline.hpp"
 36 #include "gc/shenandoah/shenandoahNMethod.inline.hpp"
 37 #include "gc/shenandoah/shenandoahMark.inline.hpp"
 38 #include "gc/shenandoah/shenandoahReferenceProcessor.hpp"
 39 #include "gc/shenandoah/shenandoahTaskqueue.inline.hpp"
 40 #include "memory/iterator.inline.hpp"
 41 #include "oops/compressedOops.inline.hpp"
 42 #include "runtime/atomic.hpp"
 43 #include "runtime/javaThread.hpp"
 44 
 45 //
 46 // ========= Super
 47 //
 48 
 49 ShenandoahSuperClosure::ShenandoahSuperClosure() :
 50   MetadataVisitingOopIterateClosure(), _heap(ShenandoahHeap::heap()) {}
 51 
 52 ShenandoahSuperClosure::ShenandoahSuperClosure(ShenandoahReferenceProcessor* rp) :
 53   MetadataVisitingOopIterateClosure(rp), _heap(ShenandoahHeap::heap()) {}
 54 
 55 void ShenandoahSuperClosure::do_nmethod(nmethod* nm) {
 56   nm->run_nmethod_entry_barrier();
 57 }
 58 
 59 //
 60 // ========= Marking
 61 //
 62 
 63 ShenandoahMarkRefsSuperClosure::ShenandoahMarkRefsSuperClosure(ShenandoahObjToScanQueue* q,
 64                                                                ShenandoahReferenceProcessor* rp,
 65                                                                ShenandoahObjToScanQueue* old_q) :
 66         ShenandoahSuperClosure(rp),
 67         _queue(q),
 68         _old_queue(old_q),
 69         _mark_context(ShenandoahHeap::heap()->marking_context()),
 70         _weak(false) {}
 71 
 72 template<class T, ShenandoahGenerationType GENERATION>
 73 inline void ShenandoahMarkRefsSuperClosure::work(T* p) {
 74   ShenandoahMark::mark_through_ref<T, GENERATION>(p, _queue, _old_queue, _mark_context, _weak);
 75 }
 76 
 77 ShenandoahForwardedIsAliveClosure::ShenandoahForwardedIsAliveClosure() :
 78   _mark_context(ShenandoahHeap::heap()->marking_context()) {}
 79 
 80 bool ShenandoahForwardedIsAliveClosure::do_object_b(oop obj) {
 81   if (CompressedOops::is_null(obj)) {
 82     return false;
 83   }
 84   obj = ShenandoahBarrierSet::resolve_forwarded_not_null(obj);
 85   shenandoah_assert_not_forwarded_if(nullptr, obj, ShenandoahHeap::heap()->is_concurrent_mark_in_progress());
 86   return _mark_context->is_marked_or_old(obj);
 87 }
 88 
 89 ShenandoahIsAliveClosure::ShenandoahIsAliveClosure() :
 90   _mark_context(ShenandoahHeap::heap()->marking_context()) {}
 91 
 92 bool ShenandoahIsAliveClosure::do_object_b(oop obj) {
 93   if (CompressedOops::is_null(obj)) {
 94     return false;
 95   }
 96   shenandoah_assert_not_forwarded(nullptr, obj);
 97   return _mark_context->is_marked_or_old(obj);
 98 }
 99 
100 BoolObjectClosure* ShenandoahIsAliveSelector::is_alive_closure() {
101   return ShenandoahHeap::heap()->has_forwarded_objects() ?
102          reinterpret_cast<BoolObjectClosure*>(&_fwd_alive_cl) :
103          reinterpret_cast<BoolObjectClosure*>(&_alive_cl);
104 }
105 
106 ShenandoahKeepAliveClosure::ShenandoahKeepAliveClosure() :
107   _bs(ShenandoahBarrierSet::barrier_set()) {}
108 
109 template <typename T>
110 void ShenandoahKeepAliveClosure::do_oop_work(T* p) {
111   assert(ShenandoahHeap::heap()->is_concurrent_mark_in_progress(), "Only for concurrent marking phase");
112   assert(ShenandoahHeap::heap()->is_concurrent_old_mark_in_progress() || !ShenandoahHeap::heap()->has_forwarded_objects(), "Not expected");
113 
114   T o = RawAccess<>::oop_load(p);
115   if (!CompressedOops::is_null(o)) {
116     oop obj = CompressedOops::decode_not_null(o);
117     _bs->enqueue(obj);
118   }
119 }
120 
121 
122 //
123 // ========= Evacuating + Roots
124 //
125 
126 template <bool CONCURRENT, bool STABLE_THREAD>
127 void ShenandoahEvacuateUpdateRootClosureBase<CONCURRENT, STABLE_THREAD>::do_oop(oop* p) {
128   if (CONCURRENT) {
129     ShenandoahEvacOOMScope scope;
130     do_oop_work(p);
131   } else {
132     do_oop_work(p);
133   }
134 }
135 
136 template <bool CONCURRENT, bool STABLE_THREAD>
137 void ShenandoahEvacuateUpdateRootClosureBase<CONCURRENT, STABLE_THREAD>::do_oop(narrowOop* p) {
138   if (CONCURRENT) {
139     ShenandoahEvacOOMScope scope;
140     do_oop_work(p);
141   } else {
142     do_oop_work(p);
143   }
144 }
145 
146 template <bool CONCURRENT, bool STABLE_THREAD>
147 template <class T>
148 void ShenandoahEvacuateUpdateRootClosureBase<CONCURRENT, STABLE_THREAD>::do_oop_work(T* p) {
149   assert(_heap->is_concurrent_weak_root_in_progress() ||
150          _heap->is_concurrent_strong_root_in_progress(),
151          "Only do this in root processing phase");
152 
153   T o = RawAccess<>::oop_load(p);
154   if (!CompressedOops::is_null(o)) {
155     oop obj = CompressedOops::decode_not_null(o);
156     if (_heap->in_collection_set(obj)) {
157       assert(_heap->is_evacuation_in_progress(), "Only do this when evacuation is in progress");
158       shenandoah_assert_marked(p, obj);
159       oop resolved = ShenandoahBarrierSet::resolve_forwarded_not_null(obj);
160       if (resolved == obj) {
161         Thread* thr = STABLE_THREAD ? _thread : Thread::current();
162         assert(thr == Thread::current(), "Wrong thread");
163 
164         resolved = _heap->evacuate_object(obj, thr);
165       }
166       if (CONCURRENT) {
167         ShenandoahHeap::atomic_update_oop(resolved, p, o);
168       } else {
169         RawAccess<IS_NOT_NULL | MO_UNORDERED>::oop_store(p, resolved);
170       }
171     }
172   }
173 }
174 
175 template <bool CONCURRENT, typename IsAlive, typename KeepAlive>
176 ShenandoahCleanUpdateWeakOopsClosure<CONCURRENT, IsAlive, KeepAlive>::ShenandoahCleanUpdateWeakOopsClosure(IsAlive* is_alive, KeepAlive* keep_alive) :
177   _is_alive(is_alive), _keep_alive(keep_alive) {
178   if (!CONCURRENT) {
179     assert(SafepointSynchronize::is_at_safepoint(), "Must be at a safepoint");
180   }
181 }
182 
183 template <bool CONCURRENT, typename IsAlive, typename KeepAlive>
184 void ShenandoahCleanUpdateWeakOopsClosure<CONCURRENT, IsAlive, KeepAlive>::do_oop(oop* p) {
185   oop obj = RawAccess<>::oop_load(p);
186   if (!CompressedOops::is_null(obj)) {
187     if (_is_alive->do_object_b(obj)) {
188       _keep_alive->do_oop(p);
189     } else {
190       if (CONCURRENT) {
191         ShenandoahHeap::atomic_clear_oop(p, obj);
192       } else {
193         RawAccess<IS_NOT_NULL>::oop_store(p, oop());
194       }
195     }
196   }
197 }
198 
199 template <bool CONCURRENT, typename IsAlive, typename KeepAlive>
200 void ShenandoahCleanUpdateWeakOopsClosure<CONCURRENT, IsAlive, KeepAlive>::do_oop(narrowOop* p) {
201   ShouldNotReachHere();
202 }
203 
204 ShenandoahNMethodAndDisarmClosure::ShenandoahNMethodAndDisarmClosure(OopClosure* cl) :
205   NMethodToOopClosure(cl, true /* fix_relocations */),
206    _bs(BarrierSet::barrier_set()->barrier_set_nmethod()) {
207 }
208 
209 void ShenandoahNMethodAndDisarmClosure::do_nmethod(nmethod* nm) {
210   assert(nm != nullptr, "Sanity");
211   assert(!ShenandoahNMethod::gc_data(nm)->is_unregistered(), "Should not be here");
212   NMethodToOopClosure::do_nmethod(nm);
213   _bs->disarm(nm);
214 }
215 
216 
217 //
218 // ========= Update References
219 //
220 
221 template <ShenandoahGenerationType GENERATION>
222 ShenandoahMarkUpdateRefsClosure<GENERATION>::ShenandoahMarkUpdateRefsClosure(ShenandoahObjToScanQueue* q,
223                                                                              ShenandoahReferenceProcessor* rp,
224                                                                              ShenandoahObjToScanQueue* old_q) :
225   ShenandoahMarkRefsSuperClosure(q, rp, old_q) {
226   assert(_heap->is_stw_gc_in_progress(), "Can only be used for STW GC");
227 }
228 
229 template<ShenandoahGenerationType GENERATION>
230 template<class T>
231 inline void ShenandoahMarkUpdateRefsClosure<GENERATION>::work(T* p) {
232   // Update the location
233   _heap->non_conc_update_with_forwarded(p);
234 
235   // ...then do the usual thing
236   ShenandoahMarkRefsSuperClosure::work<T, GENERATION>(p);
237 }
238 
239 template<class T>
240 inline void ShenandoahNonConcUpdateRefsClosure::work(T* p) {
241   _heap->non_conc_update_with_forwarded(p);
242 }
243 
244 template<class T>
245 inline void ShenandoahConcUpdateRefsClosure::work(T* p) {
246   _heap->conc_update_with_forwarded(p);
247 }
248 
249 
250 //
251 // ========= Utilities
252 //
253 
254 #ifdef ASSERT
255 template <class T>
256 void ShenandoahAssertNotForwardedClosure::do_oop_work(T* p) {
257   T o = RawAccess<>::oop_load(p);
258   if (!CompressedOops::is_null(o)) {
259     oop obj = CompressedOops::decode_not_null(o);
260     shenandoah_assert_not_forwarded(p, obj);
261   }
262 }
263 
264 void ShenandoahAssertNotForwardedClosure::do_oop(narrowOop* p) { do_oop_work(p); }
265 void ShenandoahAssertNotForwardedClosure::do_oop(oop* p)       { do_oop_work(p); }
266 #endif
267 
268 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHCLOSURES_INLINE_HPP