1 /*
2 * Copyright (c) 2001, 2015, 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_implementation/g1/g1CollectedHeap.inline.hpp"
27 #include "gc_implementation/g1/satbQueue.hpp"
28 #include "gc_interface/collectedHeap.hpp"
29 #include "memory/allocation.inline.hpp"
30 #include "oops/oop.inline.hpp"
31 #include "runtime/mutexLocker.hpp"
32 #include "runtime/thread.hpp"
33 #include "runtime/vmThread.hpp"
34
35 void ObjPtrQueue::flush() {
36 // Filter now to possibly save work later. If filtering empties the
37 // buffer then flush_impl can deallocate the buffer.
38 filter();
39 flush_impl();
40 }
41
42 // Return true if a SATB buffer entry refers to an object that
43 // requires marking.
44 //
45 // The entry must point into the G1 heap. In particular, it must not
46 // be a NULL pointer. NULL pointers are pre-filtered and never
47 // inserted into a SATB buffer.
48 //
49 // An entry that is below the NTAMS pointer for the containing heap
50 // region requires marking. Such an entry must point to a valid object.
51 //
52 // An entry that is at least the NTAMS pointer for the containing heap
53 // region might be any of the following, none of which should be marked.
54 //
55 // * A reference to an object allocated since marking started.
56 // According to SATB, such objects are implicitly kept live and do
57 // not need to be dealt with via SATB buffer processing.
58 //
59 // * A reference to a young generation object. Young objects are
60 // handled separately and are not marked by concurrent marking.
61 //
62 // * A stale reference to a young generation object. If a young
63 // generation object reference is recorded and not filtered out
64 // before being moved by a young collection, the reference becomes
65 // stale.
66 //
67 // * A stale reference to an eagerly reclaimed humongous object. If a
68 // humongous object is recorded and then reclaimed, the reference
69 // becomes stale.
70 //
71 // The stale reference cases are implicitly handled by the NTAMS
72 // comparison. Because of the possibility of stale references, buffer
73 // processing must be somewhat circumspect and not assume entries
74 // in an unfiltered buffer refer to valid objects.
75
76 inline bool requires_marking(const void* entry, G1CollectedHeap* heap) {
77 // Includes rejection of NULL pointers.
78 assert(heap->is_in_reserved(entry),
79 err_msg("Non-heap pointer in SATB buffer: " PTR_FORMAT, p2i(entry)));
80
81 HeapRegion* region = heap->heap_region_containing_raw(entry);
82 assert(region != NULL, err_msg("No region for " PTR_FORMAT, p2i(entry)));
83 if (entry >= region->next_top_at_mark_start()) {
84 return false;
85 }
86
87 assert(((oop)entry)->is_oop(true /* ignore mark word */),
88 err_msg("Invalid oop in SATB buffer: " PTR_FORMAT, p2i(entry)));
89
90 return true;
91 }
92
93 // This method removes entries from a SATB buffer that will not be
94 // useful to the concurrent marking threads. Entries are retained if
95 // they require marking and are not already marked. Retained entries
96 // are compacted toward the top of the buffer.
97
98 void ObjPtrQueue::filter() {
99 G1CollectedHeap* g1h = G1CollectedHeap::heap();
100 void** buf = _buf;
101 size_t sz = _sz;
102
103 if (buf == NULL) {
104 // nothing to do
105 return;
106 }
107
108 // Used for sanity checking at the end of the loop.
109 debug_only(size_t entries = 0; size_t retained = 0;)
110
111 size_t i = sz;
112 size_t new_index = sz;
113
114 while (i > _index) {
115 assert(i > 0, "we should have at least one more entry to process");
116 i -= oopSize;
117 debug_only(entries += 1;)
118 void** p = &buf[byte_index_to_index((int) i)];
119 void* entry = *p;
120 // NULL the entry so that unused parts of the buffer contain NULLs
121 // at the end. If we are going to retain it we will copy it to its
122 // final place. If we have retained all entries we have visited so
123 // far, we'll just end up copying it to the same place.
124 *p = NULL;
125
126 if (requires_marking(entry, g1h) && !g1h->isMarkedNext((oop)entry)) {
127 assert(new_index > 0, "we should not have already filled up the buffer");
128 new_index -= oopSize;
129 assert(new_index >= i,
130 "new_index should never be below i, as we always compact 'up'");
131 void** new_p = &buf[byte_index_to_index((int) new_index)];
132 assert(new_p >= p, "the destination location should never be below "
133 "the source as we always compact 'up'");
134 assert(*new_p == NULL,
135 "we should have already cleared the destination location");
136 *new_p = entry;
137 debug_only(retained += 1;)
138 }
139 }
140
141 #ifdef ASSERT
142 size_t entries_calc = (sz - _index) / oopSize;
143 assert(entries == entries_calc, "the number of entries we counted "
144 "should match the number of entries we calculated");
145 size_t retained_calc = (sz - new_index) / oopSize;
146 assert(retained == retained_calc, "the number of retained entries we counted "
147 "should match the number of retained entries we calculated");
148 #endif // ASSERT
149
150 _index = new_index;
151 }
152
153 // This method will first apply the above filtering to the buffer. If
154 // post-filtering a large enough chunk of the buffer has been cleared
155 // we can re-use the buffer (instead of enqueueing it) and we can just
156 // allow the mutator to carry on executing using the same buffer
157 // instead of replacing it.
158
159 bool ObjPtrQueue::should_enqueue_buffer() {
160 assert(_lock == NULL || _lock->owned_by_self(),
161 "we should have taken the lock before calling this");
162
163 // Even if G1SATBBufferEnqueueingThresholdPercent == 0 we have to
164 // filter the buffer given that this will remove any references into
165 // the CSet as we currently assume that no such refs will appear in
166 // enqueued buffers.
167
168 // This method should only be called if there is a non-NULL buffer
169 // that is full.
170 assert(_index == 0, "pre-condition");
171 assert(_buf != NULL, "pre-condition");
172
173 filter();
174
175 size_t sz = _sz;
176 size_t all_entries = sz / oopSize;
177 size_t retained_entries = (sz - _index) / oopSize;
178 size_t perc = retained_entries * 100 / all_entries;
179 bool should_enqueue = perc > (size_t) G1SATBBufferEnqueueingThresholdPercent;
180 return should_enqueue;
181 }
182
183 void ObjPtrQueue::apply_closure(ObjectClosure* cl) {
184 if (_buf != NULL) {
185 apply_closure_to_buffer(cl, _buf, _index, _sz);
186 }
187 }
188
189 void ObjPtrQueue::apply_closure_and_empty(ObjectClosure* cl) {
190 if (_buf != NULL) {
191 apply_closure_to_buffer(cl, _buf, _index, _sz);
192 _index = _sz;
193 }
194 }
195
196 void ObjPtrQueue::apply_closure_to_buffer(ObjectClosure* cl,
197 void** buf, size_t index, size_t sz) {
198 if (cl == NULL) return;
199 for (size_t i = index; i < sz; i += oopSize) {
200 oop obj = (oop)buf[byte_index_to_index((int)i)];
201 // There can be NULL entries because of destructors.
202 if (obj != NULL) {
203 cl->do_object(obj);
204 }
205 }
206 }
207
208 #ifndef PRODUCT
209 // Helpful for debugging
210
211 void ObjPtrQueue::print(const char* name) {
212 print(name, _buf, _index, _sz);
213 }
214
215 void ObjPtrQueue::print(const char* name,
216 void** buf, size_t index, size_t sz) {
217 gclog_or_tty->print_cr(" SATB BUFFER [%s] buf: "PTR_FORMAT" "
218 "index: "SIZE_FORMAT" sz: "SIZE_FORMAT,
219 name, p2i(buf), index, sz);
220 }
221 #endif // PRODUCT
222
223 #ifdef _MSC_VER // the use of 'this' below gets a warning, make it go away
224 #pragma warning( disable:4355 ) // 'this' : used in base member initializer list
225 #endif // _MSC_VER
226
227 SATBMarkQueueSet::SATBMarkQueueSet() :
228 PtrQueueSet(), _closures(NULL),
229 _shared_satb_queue(this, true /*perm*/) { }
230
231 void SATBMarkQueueSet::initialize(Monitor* cbl_mon, Mutex* fl_lock,
232 int process_completed_threshold,
233 Mutex* lock) {
234 PtrQueueSet::initialize(cbl_mon, fl_lock, process_completed_threshold, -1);
235 _shared_satb_queue.set_lock(lock);
236 _closures = NEW_C_HEAP_ARRAY(ObjectClosure*, ParallelGCThreads, mtGC);
237 }
238
239 void SATBMarkQueueSet::handle_zero_index_for_thread(JavaThread* t) {
240 t->satb_mark_queue().handle_zero_index();
241 }
242
243 #ifdef ASSERT
244 void SATBMarkQueueSet::dump_active_states(bool expected_active) {
245 gclog_or_tty->print_cr("Expected SATB active state: %s",
246 expected_active ? "ACTIVE" : "INACTIVE");
247 gclog_or_tty->print_cr("Actual SATB active states:");
248 gclog_or_tty->print_cr(" Queue set: %s", is_active() ? "ACTIVE" : "INACTIVE");
249 for (JavaThread* t = Threads::first(); t; t = t->next()) {
250 gclog_or_tty->print_cr(" Thread \"%s\" queue: %s", t->name(),
251 t->satb_mark_queue().is_active() ? "ACTIVE" : "INACTIVE");
252 }
253 gclog_or_tty->print_cr(" Shared queue: %s",
254 shared_satb_queue()->is_active() ? "ACTIVE" : "INACTIVE");
255 }
256
257 void SATBMarkQueueSet::verify_active_states(bool expected_active) {
258 // Verify queue set state
259 if (is_active() != expected_active) {
260 dump_active_states(expected_active);
261 guarantee(false, "SATB queue set has an unexpected active state");
262 }
263
264 // Verify thread queue states
265 for (JavaThread* t = Threads::first(); t; t = t->next()) {
266 if (t->satb_mark_queue().is_active() != expected_active) {
267 dump_active_states(expected_active);
268 guarantee(false, "Thread SATB queue has an unexpected active state");
269 }
270 }
271
272 // Verify shared queue state
273 if (shared_satb_queue()->is_active() != expected_active) {
274 dump_active_states(expected_active);
275 guarantee(false, "Shared SATB queue has an unexpected active state");
276 }
277 }
278 #endif // ASSERT
279
280 void SATBMarkQueueSet::set_active_all_threads(bool active, bool expected_active) {
281 assert(SafepointSynchronize::is_at_safepoint(), "Must be at safepoint.");
282 #ifdef ASSERT
283 verify_active_states(expected_active);
284 #endif // ASSERT
285 _all_active = active;
286 for (JavaThread* t = Threads::first(); t; t = t->next()) {
287 t->satb_mark_queue().set_active(active);
288 }
289 shared_satb_queue()->set_active(active);
290 }
291
292 void SATBMarkQueueSet::filter_thread_buffers() {
293 for(JavaThread* t = Threads::first(); t; t = t->next()) {
294 t->satb_mark_queue().filter();
295 }
296 shared_satb_queue()->filter();
297 }
298
299 void SATBMarkQueueSet::set_closure(uint worker, ObjectClosure* closure) {
300 assert(_closures != NULL, "Precondition");
301 assert(worker < ParallelGCThreads, "Worker index must be in range [0...ParallelGCThreads)");
302 _closures[worker] = closure;
303 }
304
305 bool SATBMarkQueueSet::apply_closure_to_completed_buffer(uint worker) {
306 BufferNode* nd = NULL;
307 {
308 MutexLockerEx x(_cbl_mon, Mutex::_no_safepoint_check_flag);
309 if (_completed_buffers_head != NULL) {
310 nd = _completed_buffers_head;
311 _completed_buffers_head = nd->next();
312 if (_completed_buffers_head == NULL) _completed_buffers_tail = NULL;
313 _n_completed_buffers--;
314 if (_n_completed_buffers == 0) _process_completed = false;
315 }
316 }
317 ObjectClosure* cl = _closures[worker];
318 if (nd != NULL) {
319 void **buf = BufferNode::make_buffer_from_node(nd);
320 ObjPtrQueue::apply_closure_to_buffer(cl, buf, 0, _sz);
321 deallocate_buffer(buf);
322 return true;
323 } else {
324 return false;
325 }
326 }
327
328 void SATBMarkQueueSet::iterate_completed_buffers_read_only(ObjectClosure* cl) {
329 assert(SafepointSynchronize::is_at_safepoint(), "Must be at safepoint.");
330 assert(cl != NULL, "pre-condition");
331
332 BufferNode* nd = _completed_buffers_head;
333 while (nd != NULL) {
334 void** buf = BufferNode::make_buffer_from_node(nd);
335 ObjPtrQueue::apply_closure_to_buffer(cl, buf, 0, _sz);
336 nd = nd->next();
337 }
338 }
339
340 void SATBMarkQueueSet::iterate_thread_buffers_read_only(ObjectClosure* cl) {
341 assert(SafepointSynchronize::is_at_safepoint(), "Must be at safepoint.");
342 assert(cl != NULL, "pre-condition");
343
344 for (JavaThread* t = Threads::first(); t; t = t->next()) {
345 t->satb_mark_queue().apply_closure(cl);
346 }
347 shared_satb_queue()->apply_closure(cl);
348 }
349
350 #ifndef PRODUCT
351 // Helpful for debugging
352
353 #define SATB_PRINTER_BUFFER_SIZE 256
354
355 void SATBMarkQueueSet::print_all(const char* msg) {
356 char buffer[SATB_PRINTER_BUFFER_SIZE];
357 assert(SafepointSynchronize::is_at_safepoint(), "Must be at safepoint.");
358
359 gclog_or_tty->cr();
360 gclog_or_tty->print_cr("SATB BUFFERS [%s]", msg);
361
362 BufferNode* nd = _completed_buffers_head;
363 int i = 0;
364 while (nd != NULL) {
365 void** buf = BufferNode::make_buffer_from_node(nd);
366 jio_snprintf(buffer, SATB_PRINTER_BUFFER_SIZE, "Enqueued: %d", i);
367 ObjPtrQueue::print(buffer, buf, 0, _sz);
368 nd = nd->next();
369 i += 1;
370 }
371
372 for (JavaThread* t = Threads::first(); t; t = t->next()) {
373 jio_snprintf(buffer, SATB_PRINTER_BUFFER_SIZE, "Thread: %s", t->name());
374 t->satb_mark_queue().print(buffer);
375 }
376
377 shared_satb_queue()->print("Shared");
378
379 gclog_or_tty->cr();
380 }
381 #endif // PRODUCT
382
383 void SATBMarkQueueSet::abandon_partial_marking() {
384 BufferNode* buffers_to_delete = NULL;
385 {
386 MutexLockerEx x(_cbl_mon, Mutex::_no_safepoint_check_flag);
387 while (_completed_buffers_head != NULL) {
388 BufferNode* nd = _completed_buffers_head;
389 _completed_buffers_head = nd->next();
390 nd->set_next(buffers_to_delete);
391 buffers_to_delete = nd;
392 }
393 _completed_buffers_tail = NULL;
394 _n_completed_buffers = 0;
395 DEBUG_ONLY(assert_completed_buffer_list_len_correct_locked());
396 }
397 while (buffers_to_delete != NULL) {
398 BufferNode* nd = buffers_to_delete;
399 buffers_to_delete = nd->next();
400 deallocate_buffer(BufferNode::make_buffer_from_node(nd));
401 }
402 assert(SafepointSynchronize::is_at_safepoint(), "Must be at safepoint.");
403 // So we can safely manipulate these queues.
404 for (JavaThread* t = Threads::first(); t; t = t->next()) {
405 t->satb_mark_queue().reset();
406 }
407 shared_satb_queue()->reset();
408 }