1 /*
2 * Copyright (c) 2017, 2021, Red Hat, Inc. 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/shared/tlab_globals.hpp"
27 #include "gc/shenandoah/shenandoahAsserts.hpp"
28 #include "gc/shenandoah/shenandoahForwarding.inline.hpp"
29 #include "gc/shenandoah/shenandoahPhaseTimings.hpp"
30 #include "gc/shenandoah/shenandoahHeap.inline.hpp"
31 #include "gc/shenandoah/shenandoahHeapRegion.inline.hpp"
32 #include "gc/shenandoah/shenandoahRootProcessor.hpp"
33 #include "gc/shenandoah/shenandoahTaskqueue.inline.hpp"
34 #include "gc/shenandoah/shenandoahUtils.hpp"
35 #include "gc/shenandoah/shenandoahVerifier.hpp"
36 #include "memory/allocation.hpp"
37 #include "memory/iterator.inline.hpp"
38 #include "memory/resourceArea.hpp"
39 #include "oops/compressedOops.inline.hpp"
40 #include "runtime/atomic.hpp"
41 #include "runtime/orderAccess.hpp"
42 #include "runtime/threads.hpp"
43 #include "utilities/align.hpp"
44
45 // Avoid name collision on verify_oop (defined in macroAssembler_arm.hpp)
46 #ifdef verify_oop
47 #undef verify_oop
48 #endif
49
50 static bool is_instance_ref_klass(Klass* k) {
51 return k->is_instance_klass() && InstanceKlass::cast(k)->reference_type() != REF_NONE;
52 }
53
54 class ShenandoahIgnoreReferenceDiscoverer : public ReferenceDiscoverer {
55 public:
56 virtual bool discover_reference(oop obj, ReferenceType type) {
57 return true;
58 }
59 };
60
61 class ShenandoahVerifyOopClosure : public BasicOopIterateClosure {
62 private:
63 const char* _phase;
64 ShenandoahVerifier::VerifyOptions _options;
65 ShenandoahVerifierStack* _stack;
66 ShenandoahHeap* _heap;
67 MarkBitMap* _map;
68 ShenandoahLivenessData* _ld;
69 void* _interior_loc;
70 oop _loc;
71
72 public:
73 ShenandoahVerifyOopClosure(ShenandoahVerifierStack* stack, MarkBitMap* map, ShenandoahLivenessData* ld,
74 const char* phase, ShenandoahVerifier::VerifyOptions options) :
75 _phase(phase),
76 _options(options),
77 _stack(stack),
78 _heap(ShenandoahHeap::heap()),
79 _map(map),
80 _ld(ld),
81 _interior_loc(nullptr),
82 _loc(nullptr) {
83 if (options._verify_marked == ShenandoahVerifier::_verify_marked_complete_except_references ||
84 options._verify_marked == ShenandoahVerifier::_verify_marked_disable) {
85 set_ref_discoverer_internal(new ShenandoahIgnoreReferenceDiscoverer());
86 }
87 }
88
89 private:
90 void check(ShenandoahAsserts::SafeLevel level, oop obj, bool test, const char* label) {
91 if (!test) {
92 ShenandoahAsserts::print_failure(level, obj, _interior_loc, _loc, _phase, label, __FILE__, __LINE__);
93 }
94 }
95
96 template <class T>
97 void do_oop_work(T* p) {
98 T o = RawAccess<>::oop_load(p);
99 if (!CompressedOops::is_null(o)) {
100 oop obj = CompressedOops::decode_not_null(o);
101 if (is_instance_ref_klass(obj->klass())) {
102 obj = ShenandoahForwarding::get_forwardee(obj);
103 }
104 // Single threaded verification can use faster non-atomic stack and bitmap
105 // methods.
106 //
107 // For performance reasons, only fully verify non-marked field values.
108 // We are here when the host object for *p is already marked.
109
110 if (_map->par_mark(obj)) {
111 verify_oop_at(p, obj);
112 _stack->push(ShenandoahVerifierTask(obj));
113 }
114 }
115 }
116
117 void verify_oop(oop obj) {
118 // Perform consistency checks with gradually decreasing safety level. This guarantees
119 // that failure report would not try to touch something that was not yet verified to be
120 // safe to process.
121
122 check(ShenandoahAsserts::_safe_unknown, obj, _heap->is_in(obj),
123 "oop must be in heap");
124 check(ShenandoahAsserts::_safe_unknown, obj, is_object_aligned(obj),
125 "oop must be aligned");
126
127 ShenandoahHeapRegion *obj_reg = _heap->heap_region_containing(obj);
128 Klass* obj_klass = obj->klass_or_null();
129
130 // Verify that obj is not in dead space:
131 {
132 // Do this before touching obj->size()
133 check(ShenandoahAsserts::_safe_unknown, obj, obj_klass != nullptr,
134 "Object klass pointer should not be null");
135 check(ShenandoahAsserts::_safe_unknown, obj, Metaspace::contains(obj_klass),
136 "Object klass pointer must go to metaspace");
137
138 HeapWord *obj_addr = cast_from_oop<HeapWord*>(obj);
139 check(ShenandoahAsserts::_safe_unknown, obj, obj_addr < obj_reg->top(),
140 "Object start should be within the region");
141
142 if (!obj_reg->is_humongous()) {
143 check(ShenandoahAsserts::_safe_unknown, obj, (obj_addr + obj->size()) <= obj_reg->top(),
144 "Object end should be within the region");
145 } else {
146 size_t humongous_start = obj_reg->index();
147 size_t humongous_end = humongous_start + (obj->size() >> ShenandoahHeapRegion::region_size_words_shift());
148 for (size_t idx = humongous_start + 1; idx < humongous_end; idx++) {
149 check(ShenandoahAsserts::_safe_unknown, obj, _heap->get_region(idx)->is_humongous_continuation(),
150 "Humongous object is in continuation that fits it");
151 }
152 }
153
154 // ------------ obj is safe at this point --------------
155
156 check(ShenandoahAsserts::_safe_oop, obj, obj_reg->is_active(),
157 "Object should be in active region");
158
159 switch (_options._verify_liveness) {
160 case ShenandoahVerifier::_verify_liveness_disable:
161 // skip
162 break;
163 case ShenandoahVerifier::_verify_liveness_complete:
164 Atomic::add(&_ld[obj_reg->index()], (uint) obj->size(), memory_order_relaxed);
165 // fallthrough for fast failure for un-live regions:
166 case ShenandoahVerifier::_verify_liveness_conservative:
167 check(ShenandoahAsserts::_safe_oop, obj, obj_reg->has_live(),
168 "Object must belong to region with live data");
169 break;
170 default:
171 assert(false, "Unhandled liveness verification");
172 }
173 }
174
175 oop fwd = ShenandoahForwarding::get_forwardee_raw_unchecked(obj);
176
177 ShenandoahHeapRegion* fwd_reg = nullptr;
178
179 if (obj != fwd) {
180 check(ShenandoahAsserts::_safe_oop, obj, _heap->is_in(fwd),
181 "Forwardee must be in heap");
182 check(ShenandoahAsserts::_safe_oop, obj, !CompressedOops::is_null(fwd),
183 "Forwardee is set");
184 check(ShenandoahAsserts::_safe_oop, obj, is_object_aligned(fwd),
185 "Forwardee must be aligned");
186
187 // Do this before touching fwd->size()
188 Klass* fwd_klass = fwd->klass_or_null();
189 check(ShenandoahAsserts::_safe_oop, obj, fwd_klass != nullptr,
190 "Forwardee klass pointer should not be null");
191 check(ShenandoahAsserts::_safe_oop, obj, Metaspace::contains(fwd_klass),
192 "Forwardee klass pointer must go to metaspace");
193 check(ShenandoahAsserts::_safe_oop, obj, obj_klass == fwd_klass,
194 "Forwardee klass pointer must go to metaspace");
195
196 fwd_reg = _heap->heap_region_containing(fwd);
197
198 // Verify that forwardee is not in the dead space:
199 check(ShenandoahAsserts::_safe_oop, obj, !fwd_reg->is_humongous(),
200 "Should have no humongous forwardees");
201
202 HeapWord *fwd_addr = cast_from_oop<HeapWord *>(fwd);
203 check(ShenandoahAsserts::_safe_oop, obj, fwd_addr < fwd_reg->top(),
204 "Forwardee start should be within the region");
205 check(ShenandoahAsserts::_safe_oop, obj, (fwd_addr + fwd->size()) <= fwd_reg->top(),
206 "Forwardee end should be within the region");
207
208 oop fwd2 = ShenandoahForwarding::get_forwardee_raw_unchecked(fwd);
209 check(ShenandoahAsserts::_safe_oop, obj, (fwd == fwd2),
210 "Double forwarding");
211 } else {
212 fwd_reg = obj_reg;
213 }
214
215 // ------------ obj and fwd are safe at this point --------------
216
217 switch (_options._verify_marked) {
218 case ShenandoahVerifier::_verify_marked_disable:
219 // skip
220 break;
221 case ShenandoahVerifier::_verify_marked_incomplete:
222 check(ShenandoahAsserts::_safe_all, obj, _heap->marking_context()->is_marked(obj),
223 "Must be marked in incomplete bitmap");
224 break;
225 case ShenandoahVerifier::_verify_marked_complete:
226 check(ShenandoahAsserts::_safe_all, obj, _heap->complete_marking_context()->is_marked(obj),
227 "Must be marked in complete bitmap");
228 break;
229 case ShenandoahVerifier::_verify_marked_complete_except_references:
230 check(ShenandoahAsserts::_safe_all, obj, _heap->complete_marking_context()->is_marked(obj),
231 "Must be marked in complete bitmap, except j.l.r.Reference referents");
232 break;
233 default:
234 assert(false, "Unhandled mark verification");
235 }
236
237 switch (_options._verify_forwarded) {
238 case ShenandoahVerifier::_verify_forwarded_disable:
239 // skip
240 break;
241 case ShenandoahVerifier::_verify_forwarded_none: {
242 check(ShenandoahAsserts::_safe_all, obj, (obj == fwd),
243 "Should not be forwarded");
244 break;
245 }
246 case ShenandoahVerifier::_verify_forwarded_allow: {
247 if (obj != fwd) {
248 check(ShenandoahAsserts::_safe_all, obj, obj_reg != fwd_reg,
249 "Forwardee should be in another region");
250 }
251 break;
252 }
253 default:
254 assert(false, "Unhandled forwarding verification");
255 }
256
257 switch (_options._verify_cset) {
258 case ShenandoahVerifier::_verify_cset_disable:
259 // skip
260 break;
261 case ShenandoahVerifier::_verify_cset_none:
262 check(ShenandoahAsserts::_safe_all, obj, !_heap->in_collection_set(obj),
263 "Should not have references to collection set");
264 break;
265 case ShenandoahVerifier::_verify_cset_forwarded:
266 if (_heap->in_collection_set(obj)) {
267 check(ShenandoahAsserts::_safe_all, obj, (obj != fwd),
268 "Object in collection set, should have forwardee");
269 }
270 break;
271 default:
272 assert(false, "Unhandled cset verification");
273 }
274
275 }
276
277 public:
278 /**
279 * Verify object with known interior reference.
280 * @param p interior reference where the object is referenced from; can be off-heap
281 * @param obj verified object
282 */
283 template <class T>
284 void verify_oop_at(T* p, oop obj) {
285 _interior_loc = p;
286 verify_oop(obj);
287 _interior_loc = nullptr;
288 }
289
290 /**
291 * Verify object without known interior reference.
292 * Useful when picking up the object at known offset in heap,
293 * but without knowing what objects reference it.
294 * @param obj verified object
295 */
296 void verify_oop_standalone(oop obj) {
297 _interior_loc = nullptr;
298 verify_oop(obj);
299 _interior_loc = nullptr;
300 }
301
302 /**
303 * Verify oop fields from this object.
304 * @param obj host object for verified fields
305 */
306 void verify_oops_from(oop obj) {
307 _loc = obj;
308 obj->oop_iterate(this);
309 _loc = nullptr;
310 }
311
312 virtual void do_oop(oop* p) { do_oop_work(p); }
313 virtual void do_oop(narrowOop* p) { do_oop_work(p); }
314 };
315
316 class ShenandoahCalculateRegionStatsClosure : public ShenandoahHeapRegionClosure {
317 private:
318 size_t _used, _committed, _garbage;
319 public:
320 ShenandoahCalculateRegionStatsClosure() : _used(0), _committed(0), _garbage(0) {};
321
322 void heap_region_do(ShenandoahHeapRegion* r) {
323 _used += r->used();
324 _garbage += r->garbage();
325 _committed += r->is_committed() ? ShenandoahHeapRegion::region_size_bytes() : 0;
326 }
327
328 size_t used() { return _used; }
329 size_t committed() { return _committed; }
330 size_t garbage() { return _garbage; }
331 };
332
333 class ShenandoahVerifyHeapRegionClosure : public ShenandoahHeapRegionClosure {
334 private:
335 ShenandoahHeap* _heap;
336 const char* _phase;
337 ShenandoahVerifier::VerifyRegions _regions;
338 public:
339 ShenandoahVerifyHeapRegionClosure(const char* phase, ShenandoahVerifier::VerifyRegions regions) :
340 _heap(ShenandoahHeap::heap()),
341 _phase(phase),
342 _regions(regions) {};
343
344 void print_failure(ShenandoahHeapRegion* r, const char* label) {
345 ResourceMark rm;
346
347 ShenandoahMessageBuffer msg("Shenandoah verification failed; %s: %s\n\n", _phase, label);
348
349 stringStream ss;
350 r->print_on(&ss);
351 msg.append("%s", ss.as_string());
352
353 report_vm_error(__FILE__, __LINE__, msg.buffer());
354 }
355
356 void verify(ShenandoahHeapRegion* r, bool test, const char* msg) {
357 if (!test) {
358 print_failure(r, msg);
359 }
360 }
361
362 void heap_region_do(ShenandoahHeapRegion* r) {
363 switch (_regions) {
364 case ShenandoahVerifier::_verify_regions_disable:
365 break;
366 case ShenandoahVerifier::_verify_regions_notrash:
367 verify(r, !r->is_trash(),
368 "Should not have trash regions");
369 break;
370 case ShenandoahVerifier::_verify_regions_nocset:
371 verify(r, !r->is_cset(),
372 "Should not have cset regions");
373 break;
374 case ShenandoahVerifier::_verify_regions_notrash_nocset:
375 verify(r, !r->is_trash(),
376 "Should not have trash regions");
377 verify(r, !r->is_cset(),
378 "Should not have cset regions");
379 break;
380 default:
381 ShouldNotReachHere();
382 }
383
384 verify(r, r->capacity() == ShenandoahHeapRegion::region_size_bytes(),
385 "Capacity should match region size");
386
387 verify(r, r->bottom() <= r->top(),
388 "Region top should not be less than bottom");
389
390 verify(r, r->bottom() <= _heap->marking_context()->top_at_mark_start(r),
391 "Region TAMS should not be less than bottom");
392
393 verify(r, _heap->marking_context()->top_at_mark_start(r) <= r->top(),
394 "Complete TAMS should not be larger than top");
395
396 verify(r, r->get_live_data_bytes() <= r->capacity(),
397 "Live data cannot be larger than capacity");
398
399 verify(r, r->garbage() <= r->capacity(),
400 "Garbage cannot be larger than capacity");
401
402 verify(r, r->used() <= r->capacity(),
403 "Used cannot be larger than capacity");
404
405 verify(r, r->get_shared_allocs() <= r->capacity(),
406 "Shared alloc count should not be larger than capacity");
407
408 verify(r, r->get_tlab_allocs() <= r->capacity(),
409 "TLAB alloc count should not be larger than capacity");
410
411 verify(r, r->get_gclab_allocs() <= r->capacity(),
412 "GCLAB alloc count should not be larger than capacity");
413
414 verify(r, r->get_shared_allocs() + r->get_tlab_allocs() + r->get_gclab_allocs() == r->used(),
415 "Accurate accounting: shared + TLAB + GCLAB = used");
416
417 verify(r, !r->is_empty() || !r->has_live(),
418 "Empty regions should not have live data");
419
420 verify(r, r->is_cset() == _heap->collection_set()->is_in(r),
421 "Transitional: region flags and collection set agree");
422 }
423 };
424
425 class ShenandoahVerifierReachableTask : public WorkerTask {
426 private:
427 const char* _label;
428 ShenandoahVerifier::VerifyOptions _options;
429 ShenandoahHeap* _heap;
430 ShenandoahLivenessData* _ld;
431 MarkBitMap* _bitmap;
432 volatile size_t _processed;
433
434 public:
435 ShenandoahVerifierReachableTask(MarkBitMap* bitmap,
436 ShenandoahLivenessData* ld,
437 const char* label,
438 ShenandoahVerifier::VerifyOptions options) :
439 WorkerTask("Shenandoah Verifier Reachable Objects"),
440 _label(label),
441 _options(options),
442 _heap(ShenandoahHeap::heap()),
443 _ld(ld),
444 _bitmap(bitmap),
445 _processed(0) {};
446
447 size_t processed() {
448 return _processed;
449 }
450
451 virtual void work(uint worker_id) {
452 ResourceMark rm;
453 ShenandoahVerifierStack stack;
454
455 // On level 2, we need to only check the roots once.
456 // On level 3, we want to check the roots, and seed the local stack.
457 // It is a lesser evil to accept multiple root scans at level 3, because
458 // extended parallelism would buy us out.
459 if (((ShenandoahVerifyLevel == 2) && (worker_id == 0))
460 || (ShenandoahVerifyLevel >= 3)) {
461 ShenandoahVerifyOopClosure cl(&stack, _bitmap, _ld,
462 ShenandoahMessageBuffer("%s, Roots", _label),
463 _options);
464 if (_heap->unload_classes()) {
465 ShenandoahRootVerifier::strong_roots_do(&cl);
466 } else {
467 ShenandoahRootVerifier::roots_do(&cl);
468 }
469 }
470
471 size_t processed = 0;
472
473 if (ShenandoahVerifyLevel >= 3) {
474 ShenandoahVerifyOopClosure cl(&stack, _bitmap, _ld,
475 ShenandoahMessageBuffer("%s, Reachable", _label),
476 _options);
477 while (!stack.is_empty()) {
478 processed++;
479 ShenandoahVerifierTask task = stack.pop();
480 cl.verify_oops_from(task.obj());
481 }
482 }
483
484 Atomic::add(&_processed, processed, memory_order_relaxed);
485 }
486 };
487
488 class ShenandoahVerifierMarkedRegionTask : public WorkerTask {
489 private:
490 const char* _label;
491 ShenandoahVerifier::VerifyOptions _options;
492 ShenandoahHeap *_heap;
493 MarkBitMap* _bitmap;
494 ShenandoahLivenessData* _ld;
495 volatile size_t _claimed;
496 volatile size_t _processed;
497
498 public:
499 ShenandoahVerifierMarkedRegionTask(MarkBitMap* bitmap,
500 ShenandoahLivenessData* ld,
501 const char* label,
502 ShenandoahVerifier::VerifyOptions options) :
503 WorkerTask("Shenandoah Verifier Marked Objects"),
504 _label(label),
505 _options(options),
506 _heap(ShenandoahHeap::heap()),
507 _bitmap(bitmap),
508 _ld(ld),
509 _claimed(0),
510 _processed(0) {};
511
512 size_t processed() {
513 return Atomic::load(&_processed);
514 }
515
516 virtual void work(uint worker_id) {
517 ShenandoahVerifierStack stack;
518 ShenandoahVerifyOopClosure cl(&stack, _bitmap, _ld,
519 ShenandoahMessageBuffer("%s, Marked", _label),
520 _options);
521
522 while (true) {
523 size_t v = Atomic::fetch_then_add(&_claimed, 1u, memory_order_relaxed);
524 if (v < _heap->num_regions()) {
525 ShenandoahHeapRegion* r = _heap->get_region(v);
526 if (!r->is_humongous() && !r->is_trash()) {
527 work_regular(r, stack, cl);
528 } else if (r->is_humongous_start()) {
529 work_humongous(r, stack, cl);
530 }
531 } else {
532 break;
533 }
534 }
535 }
536
537 virtual void work_humongous(ShenandoahHeapRegion *r, ShenandoahVerifierStack& stack, ShenandoahVerifyOopClosure& cl) {
538 size_t processed = 0;
539 HeapWord* obj = r->bottom();
540 if (_heap->complete_marking_context()->is_marked(cast_to_oop(obj))) {
541 verify_and_follow(obj, stack, cl, &processed);
542 }
543 Atomic::add(&_processed, processed, memory_order_relaxed);
544 }
545
546 virtual void work_regular(ShenandoahHeapRegion *r, ShenandoahVerifierStack &stack, ShenandoahVerifyOopClosure &cl) {
547 size_t processed = 0;
548 ShenandoahMarkingContext* ctx = _heap->complete_marking_context();
549 HeapWord* tams = ctx->top_at_mark_start(r);
550
551 // Bitmaps, before TAMS
552 if (tams > r->bottom()) {
553 HeapWord* start = r->bottom();
554 HeapWord* addr = ctx->get_next_marked_addr(start, tams);
555
556 while (addr < tams) {
557 verify_and_follow(addr, stack, cl, &processed);
558 addr += 1;
559 if (addr < tams) {
560 addr = ctx->get_next_marked_addr(addr, tams);
561 }
562 }
563 }
564
565 // Size-based, after TAMS
566 {
567 HeapWord* limit = r->top();
568 HeapWord* addr = tams;
569
570 while (addr < limit) {
571 verify_and_follow(addr, stack, cl, &processed);
572 addr += cast_to_oop(addr)->size();
573 }
574 }
575
576 Atomic::add(&_processed, processed, memory_order_relaxed);
577 }
578
579 void verify_and_follow(HeapWord *addr, ShenandoahVerifierStack &stack, ShenandoahVerifyOopClosure &cl, size_t *processed) {
580 if (!_bitmap->par_mark(addr)) return;
581
582 // Verify the object itself:
583 oop obj = cast_to_oop(addr);
584 cl.verify_oop_standalone(obj);
585
586 // Verify everything reachable from that object too, hopefully realizing
587 // everything was already marked, and never touching further:
588 if (!is_instance_ref_klass(obj->klass())) {
589 cl.verify_oops_from(obj);
590 (*processed)++;
591 }
592 while (!stack.is_empty()) {
593 ShenandoahVerifierTask task = stack.pop();
594 cl.verify_oops_from(task.obj());
595 (*processed)++;
596 }
597 }
598 };
599
600 class VerifyThreadGCState : public ThreadClosure {
601 private:
602 const char* const _label;
603 char const _expected;
604
605 public:
606 VerifyThreadGCState(const char* label, char expected) : _label(label), _expected(expected) {}
607 void do_thread(Thread* t) {
608 char actual = ShenandoahThreadLocalData::gc_state(t);
609 if (actual != _expected) {
610 fatal("%s: Thread %s: expected gc-state %d, actual %d", _label, t->name(), _expected, actual);
611 }
612 }
613 };
614
615 void ShenandoahVerifier::verify_at_safepoint(const char *label,
616 VerifyForwarded forwarded, VerifyMarked marked,
617 VerifyCollectionSet cset,
618 VerifyLiveness liveness, VerifyRegions regions,
619 VerifyGCState gcstate) {
620 guarantee(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "only when nothing else happens");
621 guarantee(ShenandoahVerify, "only when enabled, and bitmap is initialized in ShenandoahHeap::initialize");
622
623 ShenandoahHeap::heap()->propagate_gc_state_to_java_threads();
624
625 // Avoid side-effect of changing workers' active thread count, but bypass concurrent/parallel protocol check
626 ShenandoahPushWorkerScope verify_worker_scope(_heap->workers(), _heap->max_workers(), false /*bypass check*/);
627
628 log_info(gc,start)("Verify %s, Level " INTX_FORMAT, label, ShenandoahVerifyLevel);
629
630 // GC state checks
631 {
632 char expected = -1;
633 bool enabled;
634 switch (gcstate) {
635 case _verify_gcstate_disable:
636 enabled = false;
637 break;
638 case _verify_gcstate_forwarded:
639 enabled = true;
640 expected = ShenandoahHeap::HAS_FORWARDED;
641 break;
642 case _verify_gcstate_evacuation:
643 enabled = true;
644 expected = ShenandoahHeap::HAS_FORWARDED | ShenandoahHeap::EVACUATION;
645 if (!_heap->is_stw_gc_in_progress()) {
646 // Only concurrent GC sets this.
647 expected |= ShenandoahHeap::WEAK_ROOTS;
648 }
649 break;
650 case _verify_gcstate_stable:
651 enabled = true;
652 expected = ShenandoahHeap::STABLE;
653 break;
654 case _verify_gcstate_stable_weakroots:
655 enabled = true;
656 expected = ShenandoahHeap::STABLE;
657 if (!_heap->is_stw_gc_in_progress()) {
658 // Only concurrent GC sets this.
659 expected |= ShenandoahHeap::WEAK_ROOTS;
660 }
661 break;
662 default:
663 enabled = false;
664 assert(false, "Unhandled gc-state verification");
665 }
666
667 if (enabled) {
668 char actual = _heap->gc_state();
669 if (actual != expected) {
670 fatal("%s: Global gc-state: expected %d, actual %d", label, expected, actual);
671 }
672
673 VerifyThreadGCState vtgcs(label, expected);
674 Threads::java_threads_do(&vtgcs);
675 }
676 }
677
678 // Deactivate barriers temporarily: Verifier wants plain heap accesses
679 ShenandoahGCStateResetter resetter;
680
681 // Heap size checks
682 {
683 ShenandoahHeapLocker lock(_heap->lock());
684
685 ShenandoahCalculateRegionStatsClosure cl;
686 _heap->heap_region_iterate(&cl);
687 size_t heap_used = _heap->used();
688 guarantee(cl.used() == heap_used,
689 "%s: heap used size must be consistent: heap-used = " SIZE_FORMAT "%s, regions-used = " SIZE_FORMAT "%s",
690 label,
691 byte_size_in_proper_unit(heap_used), proper_unit_for_byte_size(heap_used),
692 byte_size_in_proper_unit(cl.used()), proper_unit_for_byte_size(cl.used()));
693
694 size_t heap_committed = _heap->committed();
695 guarantee(cl.committed() == heap_committed,
696 "%s: heap committed size must be consistent: heap-committed = " SIZE_FORMAT "%s, regions-committed = " SIZE_FORMAT "%s",
697 label,
698 byte_size_in_proper_unit(heap_committed), proper_unit_for_byte_size(heap_committed),
699 byte_size_in_proper_unit(cl.committed()), proper_unit_for_byte_size(cl.committed()));
700 }
701
702 // Internal heap region checks
703 if (ShenandoahVerifyLevel >= 1) {
704 ShenandoahVerifyHeapRegionClosure cl(label, regions);
705 _heap->heap_region_iterate(&cl);
706 }
707
708 OrderAccess::fence();
709
710 if (UseTLAB) {
711 _heap->labs_make_parsable();
712 }
713
714 // Allocate temporary bitmap for storing marking wavefront:
715 _verification_bit_map->clear();
716
717 // Allocate temporary array for storing liveness data
718 ShenandoahLivenessData* ld = NEW_C_HEAP_ARRAY(ShenandoahLivenessData, _heap->num_regions(), mtGC);
719 Copy::fill_to_bytes((void*)ld, _heap->num_regions()*sizeof(ShenandoahLivenessData), 0);
720
721 const VerifyOptions& options = ShenandoahVerifier::VerifyOptions(forwarded, marked, cset, liveness, regions, gcstate);
722
723 // Steps 1-2. Scan root set to get initial reachable set. Finish walking the reachable heap.
724 // This verifies what application can see, since it only cares about reachable objects.
725 size_t count_reachable = 0;
726 if (ShenandoahVerifyLevel >= 2) {
727 ShenandoahVerifierReachableTask task(_verification_bit_map, ld, label, options);
728 _heap->workers()->run_task(&task);
729 count_reachable = task.processed();
730 }
731
732 // Step 3. Walk marked objects. Marked objects might be unreachable. This verifies what collector,
733 // not the application, can see during the region scans. There is no reason to process the objects
734 // that were already verified, e.g. those marked in verification bitmap. There is interaction with TAMS:
735 // before TAMS, we verify the bitmaps, if available; after TAMS, we walk until the top(). It mimics
736 // what marked_object_iterate is doing, without calling into that optimized (and possibly incorrect)
737 // version
738
739 size_t count_marked = 0;
740 if (ShenandoahVerifyLevel >= 4 && (marked == _verify_marked_complete || marked == _verify_marked_complete_except_references)) {
741 guarantee(_heap->marking_context()->is_complete(), "Marking context should be complete");
742 ShenandoahVerifierMarkedRegionTask task(_verification_bit_map, ld, label, options);
743 _heap->workers()->run_task(&task);
744 count_marked = task.processed();
745 } else {
746 guarantee(ShenandoahVerifyLevel < 4 || marked == _verify_marked_incomplete || marked == _verify_marked_disable, "Should be");
747 }
748
749 // Step 4. Verify accumulated liveness data, if needed. Only reliable if verification level includes
750 // marked objects.
751
752 if (ShenandoahVerifyLevel >= 4 && marked == _verify_marked_complete && liveness == _verify_liveness_complete) {
753 for (size_t i = 0; i < _heap->num_regions(); i++) {
754 ShenandoahHeapRegion* r = _heap->get_region(i);
755
756 juint verf_live = 0;
757 if (r->is_humongous()) {
758 // For humongous objects, test if start region is marked live, and if so,
759 // all humongous regions in that chain have live data equal to their "used".
760 juint start_live = Atomic::load(&ld[r->humongous_start_region()->index()]);
761 if (start_live > 0) {
762 verf_live = (juint)(r->used() / HeapWordSize);
763 }
764 } else {
765 verf_live = Atomic::load(&ld[r->index()]);
766 }
767
768 size_t reg_live = r->get_live_data_words();
769 if (reg_live != verf_live) {
770 stringStream ss;
771 r->print_on(&ss);
772 fatal("%s: Live data should match: region-live = " SIZE_FORMAT ", verifier-live = " UINT32_FORMAT "\n%s",
773 label, reg_live, verf_live, ss.freeze());
774 }
775 }
776 }
777
778 log_info(gc)("Verify %s, Level " INTX_FORMAT " (" SIZE_FORMAT " reachable, " SIZE_FORMAT " marked)",
779 label, ShenandoahVerifyLevel, count_reachable, count_marked);
780
781 FREE_C_HEAP_ARRAY(ShenandoahLivenessData, ld);
782 }
783
784 void ShenandoahVerifier::verify_generic(VerifyOption vo) {
785 verify_at_safepoint(
786 "Generic Verification",
787 _verify_forwarded_allow, // conservatively allow forwarded
788 _verify_marked_disable, // do not verify marked: lots ot time wasted checking dead allocations
789 _verify_cset_disable, // cset may be inconsistent
790 _verify_liveness_disable, // no reliable liveness data
791 _verify_regions_disable, // no reliable region data
792 _verify_gcstate_disable // no data about gcstate
793 );
794 }
795
796 void ShenandoahVerifier::verify_before_concmark() {
797 verify_at_safepoint(
798 "Before Mark",
799 _verify_forwarded_none, // UR should have fixed up
800 _verify_marked_disable, // do not verify marked: lots ot time wasted checking dead allocations
801 _verify_cset_none, // UR should have fixed this
802 _verify_liveness_disable, // no reliable liveness data
803 _verify_regions_notrash, // no trash regions
804 _verify_gcstate_stable // there are no forwarded objects
805 );
806 }
807
808 void ShenandoahVerifier::verify_after_concmark() {
809 verify_at_safepoint(
810 "After Mark",
811 _verify_forwarded_none, // no forwarded references
812 _verify_marked_complete_except_references, // bitmaps as precise as we can get, except dangling j.l.r.Refs
813 _verify_cset_none, // no references to cset anymore
814 _verify_liveness_complete, // liveness data must be complete here
815 _verify_regions_disable, // trash regions not yet recycled
816 _verify_gcstate_stable_weakroots // heap is still stable, weakroots are in progress
817 );
818 }
819
820 void ShenandoahVerifier::verify_before_evacuation() {
821 verify_at_safepoint(
822 "Before Evacuation",
823 _verify_forwarded_none, // no forwarded references
824 _verify_marked_complete_except_references, // walk over marked objects too
825 _verify_cset_disable, // non-forwarded references to cset expected
826 _verify_liveness_complete, // liveness data must be complete here
827 _verify_regions_disable, // trash regions not yet recycled
828 _verify_gcstate_stable_weakroots // heap is still stable, weakroots are in progress
829 );
830 }
831
832 void ShenandoahVerifier::verify_during_evacuation() {
833 verify_at_safepoint(
834 "During Evacuation",
835 _verify_forwarded_allow, // some forwarded references are allowed
836 _verify_marked_disable, // walk only roots
837 _verify_cset_disable, // some cset references are not forwarded yet
838 _verify_liveness_disable, // liveness data might be already stale after pre-evacs
839 _verify_regions_disable, // trash regions not yet recycled
840 _verify_gcstate_evacuation // evacuation is in progress
841 );
842 }
843
844 void ShenandoahVerifier::verify_after_evacuation() {
845 verify_at_safepoint(
846 "After Evacuation",
847 _verify_forwarded_allow, // objects are still forwarded
848 _verify_marked_complete, // bitmaps might be stale, but alloc-after-mark should be well
849 _verify_cset_forwarded, // all cset refs are fully forwarded
850 _verify_liveness_disable, // no reliable liveness data anymore
851 _verify_regions_notrash, // trash regions have been recycled already
852 _verify_gcstate_forwarded // evacuation produced some forwarded objects
853 );
854 }
855
856 void ShenandoahVerifier::verify_before_updaterefs() {
857 verify_at_safepoint(
858 "Before Updating References",
859 _verify_forwarded_allow, // forwarded references allowed
860 _verify_marked_complete, // bitmaps might be stale, but alloc-after-mark should be well
861 _verify_cset_forwarded, // all cset refs are fully forwarded
862 _verify_liveness_disable, // no reliable liveness data anymore
863 _verify_regions_notrash, // trash regions have been recycled already
864 _verify_gcstate_forwarded // evacuation should have produced some forwarded objects
865 );
866 }
867
868 void ShenandoahVerifier::verify_after_updaterefs() {
869 verify_at_safepoint(
870 "After Updating References",
871 _verify_forwarded_none, // no forwarded references
872 _verify_marked_complete, // bitmaps might be stale, but alloc-after-mark should be well
873 _verify_cset_none, // no cset references, all updated
874 _verify_liveness_disable, // no reliable liveness data anymore
875 _verify_regions_nocset, // no cset regions, trash regions have appeared
876 _verify_gcstate_stable // update refs had cleaned up forwarded objects
877 );
878 }
879
880 void ShenandoahVerifier::verify_after_degenerated() {
881 verify_at_safepoint(
882 "After Degenerated GC",
883 _verify_forwarded_none, // all objects are non-forwarded
884 _verify_marked_complete, // all objects are marked in complete bitmap
885 _verify_cset_none, // no cset references
886 _verify_liveness_disable, // no reliable liveness data anymore
887 _verify_regions_notrash_nocset, // no trash, no cset
888 _verify_gcstate_stable // degenerated refs had cleaned up forwarded objects
889 );
890 }
891
892 void ShenandoahVerifier::verify_before_fullgc() {
893 verify_at_safepoint(
894 "Before Full GC",
895 _verify_forwarded_allow, // can have forwarded objects
896 _verify_marked_disable, // do not verify marked: lots ot time wasted checking dead allocations
897 _verify_cset_disable, // cset might be foobared
898 _verify_liveness_disable, // no reliable liveness data anymore
899 _verify_regions_disable, // no reliable region data here
900 _verify_gcstate_disable // no reliable gcstate data
901 );
902 }
903
904 void ShenandoahVerifier::verify_after_fullgc() {
905 verify_at_safepoint(
906 "After Full GC",
907 _verify_forwarded_none, // all objects are non-forwarded
908 _verify_marked_complete, // all objects are marked in complete bitmap
909 _verify_cset_none, // no cset references
910 _verify_liveness_disable, // no reliable liveness data anymore
911 _verify_regions_notrash_nocset, // no trash, no cset
912 _verify_gcstate_stable // full gc cleaned up everything
913 );
914 }
915
916 class ShenandoahVerifyNoForwared : public OopClosure {
917 private:
918 template <class T>
919 void do_oop_work(T* p) {
920 T o = RawAccess<>::oop_load(p);
921 if (!CompressedOops::is_null(o)) {
922 oop obj = CompressedOops::decode_not_null(o);
923 oop fwd = ShenandoahForwarding::get_forwardee_raw_unchecked(obj);
924 if (obj != fwd) {
925 ShenandoahAsserts::print_failure(ShenandoahAsserts::_safe_all, obj, p, nullptr,
926 "Verify Roots", "Should not be forwarded", __FILE__, __LINE__);
927 }
928 }
929 }
930
931 public:
932 void do_oop(narrowOop* p) { do_oop_work(p); }
933 void do_oop(oop* p) { do_oop_work(p); }
934 };
935
936 class ShenandoahVerifyInToSpaceClosure : public OopClosure {
937 private:
938 template <class T>
939 void do_oop_work(T* p) {
940 T o = RawAccess<>::oop_load(p);
941 if (!CompressedOops::is_null(o)) {
942 oop obj = CompressedOops::decode_not_null(o);
943 ShenandoahHeap* heap = ShenandoahHeap::heap();
944
945 if (!heap->marking_context()->is_marked(obj)) {
946 ShenandoahAsserts::print_failure(ShenandoahAsserts::_safe_all, obj, p, nullptr,
947 "Verify Roots In To-Space", "Should be marked", __FILE__, __LINE__);
948 }
949
950 if (heap->in_collection_set(obj)) {
951 ShenandoahAsserts::print_failure(ShenandoahAsserts::_safe_all, obj, p, nullptr,
952 "Verify Roots In To-Space", "Should not be in collection set", __FILE__, __LINE__);
953 }
954
955 oop fwd = ShenandoahForwarding::get_forwardee_raw_unchecked(obj);
956 if (obj != fwd) {
957 ShenandoahAsserts::print_failure(ShenandoahAsserts::_safe_all, obj, p, nullptr,
958 "Verify Roots In To-Space", "Should not be forwarded", __FILE__, __LINE__);
959 }
960 }
961 }
962
963 public:
964 void do_oop(narrowOop* p) { do_oop_work(p); }
965 void do_oop(oop* p) { do_oop_work(p); }
966 };
967
968 void ShenandoahVerifier::verify_roots_in_to_space() {
969 ShenandoahVerifyInToSpaceClosure cl;
970 ShenandoahRootVerifier::roots_do(&cl);
971 }
972
973 void ShenandoahVerifier::verify_roots_no_forwarded() {
974 ShenandoahVerifyNoForwared cl;
975 ShenandoahRootVerifier::roots_do(&cl);
976 }