1 /*
  2  * Copyright (c) 1997, 2021, 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 "compiler/compileBroker.hpp"
 27 #include "gc/serial/markSweep.inline.hpp"
 28 #include "gc/shared/collectedHeap.inline.hpp"
 29 #include "gc/shared/gcTimer.hpp"
 30 #include "gc/shared/gcTrace.hpp"
 31 #include "gc/shared/gc_globals.hpp"
 32 #include "memory/iterator.inline.hpp"
 33 #include "memory/universe.hpp"
 34 #include "oops/access.inline.hpp"
 35 #include "oops/compressedOops.inline.hpp"
 36 #include "oops/instanceClassLoaderKlass.inline.hpp"
 37 #include "oops/instanceKlass.inline.hpp"
 38 #include "oops/instanceMirrorKlass.inline.hpp"
 39 #include "oops/instanceRefKlass.inline.hpp"
 40 #include "oops/methodData.hpp"
 41 #include "oops/objArrayKlass.inline.hpp"
 42 #include "oops/oop.inline.hpp"
 43 #include "oops/typeArrayOop.inline.hpp"
 44 #include "utilities/macros.hpp"
 45 #include "utilities/stack.inline.hpp"
 46 
 47 uint                    MarkSweep::_total_invocations = 0;
 48 
 49 Stack<oop, mtGC>              MarkSweep::_marking_stack;
 50 Stack<ObjArrayTask, mtGC>     MarkSweep::_objarray_stack;
 51 
 52 Stack<oop, mtGC>              MarkSweep::_preserved_oop_stack;
 53 Stack<markWord, mtGC>         MarkSweep::_preserved_mark_stack;
 54 size_t                  MarkSweep::_preserved_count = 0;
 55 size_t                  MarkSweep::_preserved_count_max = 0;
 56 PreservedMark*          MarkSweep::_preserved_marks = NULL;
 57 ReferenceProcessor*     MarkSweep::_ref_processor   = NULL;
 58 STWGCTimer*             MarkSweep::_gc_timer        = NULL;
 59 SerialOldTracer*        MarkSweep::_gc_tracer       = NULL;
 60 
 61 MarkSweep::FollowRootClosure  MarkSweep::follow_root_closure;
 62 
 63 MarkAndPushClosure MarkSweep::mark_and_push_closure;
 64 CLDToOopClosure    MarkSweep::follow_cld_closure(&mark_and_push_closure, ClassLoaderData::_claim_strong);
 65 
 66 template <class T> inline void MarkSweep::KeepAliveClosure::do_oop_work(T* p) {
 67   mark_and_push(p);
 68 }
 69 
 70 void MarkSweep::push_objarray(oop obj, size_t index) {
 71   ObjArrayTask task(obj, index);
 72   assert(task.is_valid(), "bad ObjArrayTask");
 73   _objarray_stack.push(task);
 74 }
 75 
 76 inline void MarkSweep::follow_array(objArrayOop array) {
 77   MarkSweep::follow_klass(array->klass());
 78   // Don't push empty arrays to avoid unnecessary work.
 79   if (array->length() > 0) {
 80     MarkSweep::push_objarray(array, 0);
 81   }
 82 }
 83 
 84 inline void MarkSweep::follow_object(oop obj) {
 85   assert(obj->is_gc_marked(), "should be marked");
 86   if (obj->is_objArray()) {
 87     // Handle object arrays explicitly to allow them to
 88     // be split into chunks if needed.
 89     MarkSweep::follow_array((objArrayOop)obj);
 90   } else {
 91     obj->oop_iterate(&mark_and_push_closure);
 92   }
 93 }
 94 
 95 void MarkSweep::follow_array_chunk(objArrayOop array, int index) {
 96   const int len = array->length();
 97   const int beg_index = index;
 98   assert(beg_index < len || len == 0, "index too large");
 99 
100   const int stride = MIN2(len - beg_index, (int) ObjArrayMarkingStride);
101   const int end_index = beg_index + stride;
102 
103   array->oop_iterate_range(&mark_and_push_closure, beg_index, end_index);
104 
105   if (end_index < len) {
106     MarkSweep::push_objarray(array, end_index); // Push the continuation.
107   }
108 }
109 
110 void MarkSweep::follow_stack() {
111   do {
112     while (!_marking_stack.is_empty()) {
113       oop obj = _marking_stack.pop();
114       assert (obj->is_gc_marked(), "p must be marked");
115       follow_object(obj);
116     }
117     // Process ObjArrays one at a time to avoid marking stack bloat.
118     if (!_objarray_stack.is_empty()) {
119       ObjArrayTask task = _objarray_stack.pop();
120       follow_array_chunk(objArrayOop(task.obj()), task.index());
121     }
122   } while (!_marking_stack.is_empty() || !_objarray_stack.is_empty());
123 }
124 
125 MarkSweep::FollowStackClosure MarkSweep::follow_stack_closure;
126 
127 void MarkSweep::FollowStackClosure::do_void() { follow_stack(); }
128 
129 template <class T> inline void MarkSweep::follow_root(T* p) {
130   assert(!Universe::heap()->is_in(p),
131          "roots shouldn't be things within the heap");
132   T heap_oop = RawAccess<>::oop_load(p);
133   if (!CompressedOops::is_null(heap_oop)) {
134     oop obj = CompressedOops::decode_not_null(heap_oop);
135     if (!obj->mark().is_marked()) {
136       mark_object(obj);
137       follow_object(obj);
138     }
139   }
140   follow_stack();
141 }
142 
143 void MarkSweep::FollowRootClosure::do_oop(oop* p)       { follow_root(p); }
144 void MarkSweep::FollowRootClosure::do_oop(narrowOop* p) { follow_root(p); }
145 
146 template <bool ALT_FWD>
147 void PreservedMark::adjust_pointer() {
148   MarkSweep::adjust_pointer<ALT_FWD>(&_obj);
149 }
150 
151 void PreservedMark::restore() {
152   _obj->set_mark(_mark);
153 }
154 
155 // We preserve the mark which should be replaced at the end and the location
156 // that it will go.  Note that the object that this markWord belongs to isn't
157 // currently at that address but it will be after phase4
158 void MarkSweep::preserve_mark(oop obj, markWord mark) {
159   // We try to store preserved marks in the to space of the new generation since
160   // this is storage which should be available.  Most of the time this should be
161   // sufficient space for the marks we need to preserve but if it isn't we fall
162   // back to using Stacks to keep track of the overflow.
163   if (_preserved_count < _preserved_count_max) {
164     _preserved_marks[_preserved_count++].init(obj, mark);
165   } else {
166     _preserved_mark_stack.push(mark);
167     _preserved_oop_stack.push(obj);
168   }
169 }
170 
171 void MarkSweep::set_ref_processor(ReferenceProcessor* rp) {
172   _ref_processor = rp;
173   mark_and_push_closure.set_ref_discoverer(_ref_processor);
174 }
175 
176 template <bool ALT_FWD>
177 void MarkSweep::adjust_marks_impl() {
178   assert( _preserved_oop_stack.size() == _preserved_mark_stack.size(),
179          "inconsistent preserved oop stacks");
180 
181   // adjust the oops we saved earlier
182   for (size_t i = 0; i < _preserved_count; i++) {
183     _preserved_marks[i].adjust_pointer<ALT_FWD>();
184   }
185 
186   // deal with the overflow stack
187   StackIterator<oop, mtGC> iter(_preserved_oop_stack);
188   while (!iter.is_empty()) {
189     oop* p = iter.next_addr();
190     adjust_pointer<ALT_FWD>(p);
191   }
192 }
193 
194 void MarkSweep::adjust_marks() {
195   if (UseAltGCForwarding) {
196     adjust_marks_impl<true>();
197   } else {
198     adjust_marks_impl<false>();
199   }
200 }
201 
202 void MarkSweep::restore_marks() {
203   assert(_preserved_oop_stack.size() == _preserved_mark_stack.size(),
204          "inconsistent preserved oop stacks");
205   log_trace(gc)("Restoring " SIZE_FORMAT " marks", _preserved_count + _preserved_oop_stack.size());
206 
207   // restore the marks we saved earlier
208   for (size_t i = 0; i < _preserved_count; i++) {
209     _preserved_marks[i].restore();
210   }
211 
212   // deal with the overflow
213   while (!_preserved_oop_stack.is_empty()) {
214     oop obj       = _preserved_oop_stack.pop();
215     markWord mark = _preserved_mark_stack.pop();
216     obj->set_mark(mark);
217   }
218 }
219 
220 MarkSweep::IsAliveClosure   MarkSweep::is_alive;
221 
222 bool MarkSweep::IsAliveClosure::do_object_b(oop p) { return p->is_gc_marked(); }
223 
224 MarkSweep::KeepAliveClosure MarkSweep::keep_alive;
225 
226 void MarkSweep::KeepAliveClosure::do_oop(oop* p)       { MarkSweep::KeepAliveClosure::do_oop_work(p); }
227 void MarkSweep::KeepAliveClosure::do_oop(narrowOop* p) { MarkSweep::KeepAliveClosure::do_oop_work(p); }
228 
229 void MarkSweep::initialize() {
230   MarkSweep::_gc_timer = new (ResourceObj::C_HEAP, mtGC) STWGCTimer();
231   MarkSweep::_gc_tracer = new (ResourceObj::C_HEAP, mtGC) SerialOldTracer();
232 }