1 /*
   2  * Copyright (c) 2017, 2021, 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 
  26 #include "precompiled.hpp"
  27 #include "gc/shared/tlab_globals.hpp"
  28 #include "gc/shenandoah/shenandoahAsserts.hpp"
  29 #include "gc/shenandoah/shenandoahForwarding.inline.hpp"
  30 #include "gc/shenandoah/shenandoahPhaseTimings.hpp"
  31 #include "gc/shenandoah/shenandoahGeneration.hpp"
  32 #include "gc/shenandoah/shenandoahHeap.inline.hpp"
  33 #include "gc/shenandoah/shenandoahHeapRegion.inline.hpp"
  34 #include "gc/shenandoah/shenandoahOldGeneration.hpp"
  35 #include "gc/shenandoah/shenandoahRootProcessor.hpp"
  36 #include "gc/shenandoah/shenandoahScanRemembered.inline.hpp"
  37 #include "gc/shenandoah/shenandoahTaskqueue.inline.hpp"
  38 #include "gc/shenandoah/shenandoahUtils.hpp"
  39 #include "gc/shenandoah/shenandoahVerifier.hpp"
  40 #include "gc/shenandoah/shenandoahYoungGeneration.hpp"
  41 #include "memory/allocation.hpp"
  42 #include "memory/iterator.inline.hpp"
  43 #include "memory/resourceArea.hpp"
  44 #include "oops/compressedOops.inline.hpp"
  45 #include "runtime/atomic.hpp"
  46 #include "runtime/orderAccess.hpp"
  47 #include "runtime/threads.hpp"
  48 #include "utilities/align.hpp"
  49 
  50 // Avoid name collision on verify_oop (defined in macroAssembler_arm.hpp)
  51 #ifdef verify_oop
  52 #undef verify_oop
  53 #endif
  54 
  55 static bool is_instance_ref_klass(Klass* k) {
  56   return k->is_instance_klass() && InstanceKlass::cast(k)->reference_type() != REF_NONE;
  57 }
  58 
  59 class ShenandoahIgnoreReferenceDiscoverer : public ReferenceDiscoverer {
  60 public:
  61   virtual bool discover_reference(oop obj, ReferenceType type) {
  62     return true;
  63   }
  64 };
  65 
  66 class ShenandoahVerifyOopClosure : public BasicOopIterateClosure {
  67 private:
  68   const char* _phase;
  69   ShenandoahVerifier::VerifyOptions _options;
  70   ShenandoahVerifierStack* _stack;
  71   ShenandoahHeap* _heap;
  72   MarkBitMap* _map;
  73   ShenandoahLivenessData* _ld;
  74   void* _interior_loc;
  75   oop _loc;
  76   ShenandoahGeneration* _generation;
  77 
  78 public:
  79   ShenandoahVerifyOopClosure(ShenandoahVerifierStack* stack, MarkBitMap* map, ShenandoahLivenessData* ld,
  80                              const char* phase, ShenandoahVerifier::VerifyOptions options) :
  81     _phase(phase),
  82     _options(options),
  83     _stack(stack),
  84     _heap(ShenandoahHeap::heap()),
  85     _map(map),
  86     _ld(ld),
  87     _interior_loc(nullptr),
  88     _loc(nullptr),
  89     _generation(nullptr) {
  90     if (options._verify_marked == ShenandoahVerifier::_verify_marked_complete_except_references ||
  91         options._verify_marked == ShenandoahVerifier::_verify_marked_complete_satb_empty ||
  92         options._verify_marked == ShenandoahVerifier::_verify_marked_disable) {
  93       set_ref_discoverer_internal(new ShenandoahIgnoreReferenceDiscoverer());
  94     }
  95 
  96     if (_heap->mode()->is_generational()) {
  97       _generation = _heap->gc_generation();
  98       assert(_generation != nullptr, "Expected active generation in this mode");
  99       shenandoah_assert_generations_reconciled();
 100     }
 101   }
 102 
 103 private:
 104   void check(ShenandoahAsserts::SafeLevel level, oop obj, bool test, const char* label) {
 105     if (!test) {
 106       ShenandoahAsserts::print_failure(level, obj, _interior_loc, _loc, _phase, label, __FILE__, __LINE__);
 107     }
 108   }
 109 
 110   template <class T>
 111   void do_oop_work(T* p) {
 112     T o = RawAccess<>::oop_load(p);
 113     if (!CompressedOops::is_null(o)) {
 114       oop obj = CompressedOops::decode_not_null(o);
 115       if (is_instance_ref_klass(obj->klass())) {
 116         obj = ShenandoahForwarding::get_forwardee(obj);
 117       }
 118       // Single threaded verification can use faster non-atomic stack and bitmap
 119       // methods.
 120       //
 121       // For performance reasons, only fully verify non-marked field values.
 122       // We are here when the host object for *p is already marked.
 123       if (in_generation(obj) && _map->par_mark(obj)) {
 124         verify_oop_at(p, obj);
 125         _stack->push(ShenandoahVerifierTask(obj));
 126       }
 127     }
 128   }
 129 
 130   bool in_generation(oop obj) {
 131     if (_generation == nullptr) {
 132       return true;
 133     }
 134 
 135     ShenandoahHeapRegion* region = _heap->heap_region_containing(obj);
 136     return _generation->contains(region);
 137   }
 138 
 139   void verify_oop(oop obj) {
 140     // Perform consistency checks with gradually decreasing safety level. This guarantees
 141     // that failure report would not try to touch something that was not yet verified to be
 142     // safe to process.
 143 
 144     check(ShenandoahAsserts::_safe_unknown, obj, _heap->is_in(obj),
 145               "oop must be in heap");
 146     check(ShenandoahAsserts::_safe_unknown, obj, is_object_aligned(obj),
 147               "oop must be aligned");
 148 
 149     ShenandoahHeapRegion *obj_reg = _heap->heap_region_containing(obj);
 150     Klass* obj_klass = obj->klass_or_null();
 151 
 152     // Verify that obj is not in dead space:
 153     {
 154       // Do this before touching obj->size()
 155       check(ShenandoahAsserts::_safe_unknown, obj, obj_klass != nullptr,
 156              "Object klass pointer should not be null");
 157       check(ShenandoahAsserts::_safe_unknown, obj, Metaspace::contains(obj_klass),
 158              "Object klass pointer must go to metaspace");
 159 
 160       HeapWord *obj_addr = cast_from_oop<HeapWord*>(obj);
 161       check(ShenandoahAsserts::_safe_unknown, obj, obj_addr < obj_reg->top(),
 162              "Object start should be within the region");
 163 
 164       if (!obj_reg->is_humongous()) {
 165         check(ShenandoahAsserts::_safe_unknown, obj, (obj_addr + obj->size()) <= obj_reg->top(),
 166                "Object end should be within the region");
 167       } else {
 168         size_t humongous_start = obj_reg->index();
 169         size_t humongous_end = humongous_start + (obj->size() >> ShenandoahHeapRegion::region_size_words_shift());
 170         for (size_t idx = humongous_start + 1; idx < humongous_end; idx++) {
 171           check(ShenandoahAsserts::_safe_unknown, obj, _heap->get_region(idx)->is_humongous_continuation(),
 172                  "Humongous object is in continuation that fits it");
 173         }
 174       }
 175 
 176       // ------------ obj is safe at this point --------------
 177 
 178       check(ShenandoahAsserts::_safe_oop, obj, obj_reg->is_active(),
 179             "Object should be in active region");
 180 
 181       switch (_options._verify_liveness) {
 182         case ShenandoahVerifier::_verify_liveness_disable:
 183           // skip
 184           break;
 185         case ShenandoahVerifier::_verify_liveness_complete:
 186           Atomic::add(&_ld[obj_reg->index()], (uint) obj->size(), memory_order_relaxed);
 187           // fallthrough for fast failure for un-live regions:
 188         case ShenandoahVerifier::_verify_liveness_conservative:
 189           check(ShenandoahAsserts::_safe_oop, obj, obj_reg->has_live() ||
 190                 (obj_reg->is_old() && _heap->gc_generation()->is_young()),
 191                    "Object must belong to region with live data");
 192           shenandoah_assert_generations_reconciled();
 193           break;
 194         default:
 195           assert(false, "Unhandled liveness verification");
 196       }
 197     }
 198 
 199     oop fwd = ShenandoahForwarding::get_forwardee_raw_unchecked(obj);
 200 
 201     ShenandoahHeapRegion* fwd_reg = nullptr;
 202 
 203     if (obj != fwd) {
 204       check(ShenandoahAsserts::_safe_oop, obj, _heap->is_in(fwd),
 205              "Forwardee must be in heap");
 206       check(ShenandoahAsserts::_safe_oop, obj, !CompressedOops::is_null(fwd),
 207              "Forwardee is set");
 208       check(ShenandoahAsserts::_safe_oop, obj, is_object_aligned(fwd),
 209              "Forwardee must be aligned");
 210 
 211       // Do this before touching fwd->size()
 212       Klass* fwd_klass = fwd->klass_or_null();
 213       check(ShenandoahAsserts::_safe_oop, obj, fwd_klass != nullptr,
 214              "Forwardee klass pointer should not be null");
 215       check(ShenandoahAsserts::_safe_oop, obj, Metaspace::contains(fwd_klass),
 216              "Forwardee klass pointer must go to metaspace");
 217       check(ShenandoahAsserts::_safe_oop, obj, obj_klass == fwd_klass,
 218              "Forwardee klass pointer must go to metaspace");
 219 
 220       fwd_reg = _heap->heap_region_containing(fwd);
 221 
 222       // Verify that forwardee is not in the dead space:
 223       check(ShenandoahAsserts::_safe_oop, obj, !fwd_reg->is_humongous(),
 224              "Should have no humongous forwardees");
 225 
 226       HeapWord *fwd_addr = cast_from_oop<HeapWord *>(fwd);
 227       check(ShenandoahAsserts::_safe_oop, obj, fwd_addr < fwd_reg->top(),
 228              "Forwardee start should be within the region");
 229       check(ShenandoahAsserts::_safe_oop, obj, (fwd_addr + fwd->size()) <= fwd_reg->top(),
 230              "Forwardee end should be within the region");
 231 
 232       oop fwd2 = ShenandoahForwarding::get_forwardee_raw_unchecked(fwd);
 233       check(ShenandoahAsserts::_safe_oop, obj, (fwd == fwd2),
 234              "Double forwarding");
 235     } else {
 236       fwd_reg = obj_reg;
 237     }
 238 
 239     // Do additional checks for special objects: their fields can hold metadata as well.
 240     // We want to check class loading/unloading did not corrupt them.
 241 
 242     if (obj_klass == vmClasses::Class_klass()) {
 243       Metadata* klass = obj->metadata_field(java_lang_Class::klass_offset());
 244       check(ShenandoahAsserts::_safe_oop, obj,
 245             klass == nullptr || Metaspace::contains(klass),
 246             "Instance class mirror should point to Metaspace");
 247 
 248       Metadata* array_klass = obj->metadata_field(java_lang_Class::array_klass_offset());
 249       check(ShenandoahAsserts::_safe_oop, obj,
 250             array_klass == nullptr || Metaspace::contains(array_klass),
 251             "Array class mirror should point to Metaspace");
 252     }
 253 
 254     // ------------ obj and fwd are safe at this point --------------
 255     switch (_options._verify_marked) {
 256       case ShenandoahVerifier::_verify_marked_disable:
 257         // skip
 258         break;
 259       case ShenandoahVerifier::_verify_marked_incomplete:
 260         check(ShenandoahAsserts::_safe_all, obj, _heap->marking_context()->is_marked(obj),
 261                "Must be marked in incomplete bitmap");
 262         break;
 263       case ShenandoahVerifier::_verify_marked_complete:
 264         check(ShenandoahAsserts::_safe_all, obj, _heap->complete_marking_context()->is_marked(obj),
 265                "Must be marked in complete bitmap");
 266         break;
 267       case ShenandoahVerifier::_verify_marked_complete_except_references:
 268       case ShenandoahVerifier::_verify_marked_complete_satb_empty:
 269         check(ShenandoahAsserts::_safe_all, obj, _heap->complete_marking_context()->is_marked(obj),
 270               "Must be marked in complete bitmap, except j.l.r.Reference referents");
 271         break;
 272       default:
 273         assert(false, "Unhandled mark verification");
 274     }
 275 
 276     switch (_options._verify_forwarded) {
 277       case ShenandoahVerifier::_verify_forwarded_disable:
 278         // skip
 279         break;
 280       case ShenandoahVerifier::_verify_forwarded_none: {
 281         check(ShenandoahAsserts::_safe_all, obj, (obj == fwd),
 282                "Should not be forwarded");
 283         break;
 284       }
 285       case ShenandoahVerifier::_verify_forwarded_allow: {
 286         if (obj != fwd) {
 287           check(ShenandoahAsserts::_safe_all, obj, obj_reg != fwd_reg,
 288                  "Forwardee should be in another region");
 289         }
 290         break;
 291       }
 292       default:
 293         assert(false, "Unhandled forwarding verification");
 294     }
 295 
 296     switch (_options._verify_cset) {
 297       case ShenandoahVerifier::_verify_cset_disable:
 298         // skip
 299         break;
 300       case ShenandoahVerifier::_verify_cset_none:
 301         check(ShenandoahAsserts::_safe_all, obj, !_heap->in_collection_set(obj),
 302                "Should not have references to collection set");
 303         break;
 304       case ShenandoahVerifier::_verify_cset_forwarded:
 305         if (_heap->in_collection_set(obj)) {
 306           check(ShenandoahAsserts::_safe_all, obj, (obj != fwd),
 307                  "Object in collection set, should have forwardee");
 308         }
 309         break;
 310       default:
 311         assert(false, "Unhandled cset verification");
 312     }
 313 
 314   }
 315 
 316 public:
 317   /**
 318    * Verify object with known interior reference.
 319    * @param p interior reference where the object is referenced from; can be off-heap
 320    * @param obj verified object
 321    */
 322   template <class T>
 323   void verify_oop_at(T* p, oop obj) {
 324     _interior_loc = p;
 325     verify_oop(obj);
 326     _interior_loc = nullptr;
 327   }
 328 
 329   /**
 330    * Verify object without known interior reference.
 331    * Useful when picking up the object at known offset in heap,
 332    * but without knowing what objects reference it.
 333    * @param obj verified object
 334    */
 335   void verify_oop_standalone(oop obj) {
 336     _interior_loc = nullptr;
 337     verify_oop(obj);
 338     _interior_loc = nullptr;
 339   }
 340 
 341   /**
 342    * Verify oop fields from this object.
 343    * @param obj host object for verified fields
 344    */
 345   void verify_oops_from(oop obj) {
 346     _loc = obj;
 347     obj->oop_iterate(this);
 348     _loc = nullptr;
 349   }
 350 
 351   void do_oop(oop* p) override { do_oop_work(p); }
 352   void do_oop(narrowOop* p) override { do_oop_work(p); }
 353 };
 354 
 355 // This closure computes the amounts of used, committed, and garbage memory and the number of regions contained within
 356 // a subset (e.g. the young generation or old generation) of the total heap.
 357 class ShenandoahCalculateRegionStatsClosure : public ShenandoahHeapRegionClosure {
 358 private:
 359   size_t _used, _committed, _garbage, _regions, _humongous_waste, _trashed_regions;
 360 public:
 361   ShenandoahCalculateRegionStatsClosure() :
 362       _used(0), _committed(0), _garbage(0), _regions(0), _humongous_waste(0), _trashed_regions(0) {};
 363 
 364   void heap_region_do(ShenandoahHeapRegion* r) override {
 365     _used += r->used();
 366     _garbage += r->garbage();
 367     _committed += r->is_committed() ? ShenandoahHeapRegion::region_size_bytes() : 0;
 368     if (r->is_humongous()) {
 369       _humongous_waste += r->free();
 370     }
 371     if (r->is_trash()) {
 372       _trashed_regions++;
 373     }
 374     _regions++;
 375     log_debug(gc)("ShenandoahCalculateRegionStatsClosure: adding " SIZE_FORMAT " for %s Region " SIZE_FORMAT ", yielding: " SIZE_FORMAT,
 376             r->used(), (r->is_humongous() ? "humongous" : "regular"), r->index(), _used);
 377   }
 378 
 379   size_t used() const { return _used; }
 380   size_t committed() const { return _committed; }
 381   size_t garbage() const { return _garbage; }
 382   size_t regions() const { return _regions; }
 383   size_t waste() const { return _humongous_waste; }
 384 
 385   // span is the total memory affiliated with these stats (some of which is in use and other is available)
 386   size_t span() const { return _regions * ShenandoahHeapRegion::region_size_bytes(); }
 387   size_t non_trashed_span() const { return (_regions - _trashed_regions) * ShenandoahHeapRegion::region_size_bytes(); }
 388 };
 389 
 390 class ShenandoahGenerationStatsClosure : public ShenandoahHeapRegionClosure {
 391  public:
 392   ShenandoahCalculateRegionStatsClosure old;
 393   ShenandoahCalculateRegionStatsClosure young;
 394   ShenandoahCalculateRegionStatsClosure global;
 395 
 396   void heap_region_do(ShenandoahHeapRegion* r) override {
 397     switch (r->affiliation()) {
 398       case FREE:
 399         return;
 400       case YOUNG_GENERATION:
 401         young.heap_region_do(r);
 402         global.heap_region_do(r);
 403         break;
 404       case OLD_GENERATION:
 405         old.heap_region_do(r);
 406         global.heap_region_do(r);
 407         break;
 408       default:
 409         ShouldNotReachHere();
 410     }
 411   }
 412 
 413   static void log_usage(ShenandoahGeneration* generation, ShenandoahCalculateRegionStatsClosure& stats) {
 414     log_debug(gc)("Safepoint verification: %s verified usage: " SIZE_FORMAT "%s, recorded usage: " SIZE_FORMAT "%s",
 415                   generation->name(),
 416                   byte_size_in_proper_unit(generation->used()), proper_unit_for_byte_size(generation->used()),
 417                   byte_size_in_proper_unit(stats.used()),       proper_unit_for_byte_size(stats.used()));
 418   }
 419 
 420   static void validate_usage(const bool adjust_for_padding,
 421                              const char* label, ShenandoahGeneration* generation, ShenandoahCalculateRegionStatsClosure& stats) {
 422     ShenandoahHeap* heap = ShenandoahHeap::heap();
 423     size_t generation_used = generation->used();
 424     size_t generation_used_regions = generation->used_regions();
 425     if (adjust_for_padding && (generation->is_young() || generation->is_global())) {
 426       size_t pad = heap->old_generation()->get_pad_for_promote_in_place();
 427       generation_used += pad;
 428     }
 429 
 430     guarantee(stats.used() == generation_used,
 431               "%s: generation (%s) used size must be consistent: generation-used: " PROPERFMT ", regions-used: " PROPERFMT,
 432               label, generation->name(), PROPERFMTARGS(generation_used), PROPERFMTARGS(stats.used()));
 433 
 434     guarantee(stats.regions() == generation_used_regions,
 435               "%s: generation (%s) used regions (" SIZE_FORMAT ") must equal regions that are in use (" SIZE_FORMAT ")",
 436               label, generation->name(), generation->used_regions(), stats.regions());
 437 
 438     size_t generation_capacity = generation->max_capacity();
 439     guarantee(stats.non_trashed_span() <= generation_capacity,
 440               "%s: generation (%s) size spanned by regions (" SIZE_FORMAT ") * region size (" PROPERFMT
 441               ") must not exceed current capacity (" PROPERFMT ")",
 442               label, generation->name(), stats.regions(), PROPERFMTARGS(ShenandoahHeapRegion::region_size_bytes()),
 443               PROPERFMTARGS(generation_capacity));
 444 
 445     size_t humongous_waste = generation->get_humongous_waste();
 446     guarantee(stats.waste() == humongous_waste,
 447               "%s: generation (%s) humongous waste must be consistent: generation: " PROPERFMT ", regions: " PROPERFMT,
 448               label, generation->name(), PROPERFMTARGS(humongous_waste), PROPERFMTARGS(stats.waste()));
 449   }
 450 };
 451 
 452 class ShenandoahVerifyHeapRegionClosure : public ShenandoahHeapRegionClosure {
 453 private:
 454   ShenandoahHeap* _heap;
 455   const char* _phase;
 456   ShenandoahVerifier::VerifyRegions _regions;
 457 public:
 458   ShenandoahVerifyHeapRegionClosure(const char* phase, ShenandoahVerifier::VerifyRegions regions) :
 459     _heap(ShenandoahHeap::heap()),
 460     _phase(phase),
 461     _regions(regions) {};
 462 
 463   void print_failure(ShenandoahHeapRegion* r, const char* label) {
 464     ResourceMark rm;
 465 
 466     ShenandoahMessageBuffer msg("Shenandoah verification failed; %s: %s\n\n", _phase, label);
 467 
 468     stringStream ss;
 469     r->print_on(&ss);
 470     msg.append("%s", ss.as_string());
 471 
 472     report_vm_error(__FILE__, __LINE__, msg.buffer());
 473   }
 474 
 475   void verify(ShenandoahHeapRegion* r, bool test, const char* msg) {
 476     if (!test) {
 477       print_failure(r, msg);
 478     }
 479   }
 480 
 481   void heap_region_do(ShenandoahHeapRegion* r) override {
 482     switch (_regions) {
 483       case ShenandoahVerifier::_verify_regions_disable:
 484         break;
 485       case ShenandoahVerifier::_verify_regions_notrash:
 486         verify(r, !r->is_trash(),
 487                "Should not have trash regions");
 488         break;
 489       case ShenandoahVerifier::_verify_regions_nocset:
 490         verify(r, !r->is_cset(),
 491                "Should not have cset regions");
 492         break;
 493       case ShenandoahVerifier::_verify_regions_notrash_nocset:
 494         verify(r, !r->is_trash(),
 495                "Should not have trash regions");
 496         verify(r, !r->is_cset(),
 497                "Should not have cset regions");
 498         break;
 499       default:
 500         ShouldNotReachHere();
 501     }
 502 
 503     verify(r, r->capacity() == ShenandoahHeapRegion::region_size_bytes(),
 504            "Capacity should match region size");
 505 
 506     verify(r, r->bottom() <= r->top(),
 507            "Region top should not be less than bottom");
 508 
 509     verify(r, r->bottom() <= _heap->marking_context()->top_at_mark_start(r),
 510            "Region TAMS should not be less than bottom");
 511 
 512     verify(r, _heap->marking_context()->top_at_mark_start(r) <= r->top(),
 513            "Complete TAMS should not be larger than top");
 514 
 515     verify(r, r->get_live_data_bytes() <= r->capacity(),
 516            "Live data cannot be larger than capacity");
 517 
 518     verify(r, r->garbage() <= r->capacity(),
 519            "Garbage cannot be larger than capacity");
 520 
 521     verify(r, r->used() <= r->capacity(),
 522            "Used cannot be larger than capacity");
 523 
 524     verify(r, r->get_shared_allocs() <= r->capacity(),
 525            "Shared alloc count should not be larger than capacity");
 526 
 527     verify(r, r->get_tlab_allocs() <= r->capacity(),
 528            "TLAB alloc count should not be larger than capacity");
 529 
 530     verify(r, r->get_gclab_allocs() <= r->capacity(),
 531            "GCLAB alloc count should not be larger than capacity");
 532 
 533     verify(r, r->get_plab_allocs() <= r->capacity(),
 534            "PLAB alloc count should not be larger than capacity");
 535 
 536     verify(r, r->get_shared_allocs() + r->get_tlab_allocs() + r->get_gclab_allocs() + r->get_plab_allocs() == r->used(),
 537            "Accurate accounting: shared + TLAB + GCLAB + PLAB = used");
 538 
 539     verify(r, !r->is_empty() || !r->has_live(),
 540            "Empty regions should not have live data");
 541 
 542     verify(r, r->is_cset() == _heap->collection_set()->is_in(r),
 543            "Transitional: region flags and collection set agree");
 544   }
 545 };
 546 
 547 class ShenandoahVerifierReachableTask : public WorkerTask {
 548 private:
 549   const char* _label;
 550   ShenandoahVerifier::VerifyOptions _options;
 551   ShenandoahHeap* _heap;
 552   ShenandoahLivenessData* _ld;
 553   MarkBitMap* _bitmap;
 554   volatile size_t _processed;
 555 
 556 public:
 557   ShenandoahVerifierReachableTask(MarkBitMap* bitmap,
 558                                   ShenandoahLivenessData* ld,
 559                                   const char* label,
 560                                   ShenandoahVerifier::VerifyOptions options) :
 561     WorkerTask("Shenandoah Verifier Reachable Objects"),
 562     _label(label),
 563     _options(options),
 564     _heap(ShenandoahHeap::heap()),
 565     _ld(ld),
 566     _bitmap(bitmap),
 567     _processed(0) {};
 568 
 569   size_t processed() const {
 570     return _processed;
 571   }
 572 
 573   void work(uint worker_id) override {
 574     ResourceMark rm;
 575     ShenandoahVerifierStack stack;
 576 
 577     // On level 2, we need to only check the roots once.
 578     // On level 3, we want to check the roots, and seed the local stack.
 579     // It is a lesser evil to accept multiple root scans at level 3, because
 580     // extended parallelism would buy us out.
 581     if (((ShenandoahVerifyLevel == 2) && (worker_id == 0))
 582         || (ShenandoahVerifyLevel >= 3)) {
 583         ShenandoahVerifyOopClosure cl(&stack, _bitmap, _ld,
 584                                       ShenandoahMessageBuffer("%s, Roots", _label),
 585                                       _options);
 586         if (_heap->unload_classes()) {
 587           ShenandoahRootVerifier::strong_roots_do(&cl);
 588         } else {
 589           ShenandoahRootVerifier::roots_do(&cl);
 590         }
 591     }
 592 
 593     size_t processed = 0;
 594 
 595     if (ShenandoahVerifyLevel >= 3) {
 596       ShenandoahVerifyOopClosure cl(&stack, _bitmap, _ld,
 597                                     ShenandoahMessageBuffer("%s, Reachable", _label),
 598                                     _options);
 599       while (!stack.is_empty()) {
 600         processed++;
 601         ShenandoahVerifierTask task = stack.pop();
 602         cl.verify_oops_from(task.obj());
 603       }
 604     }
 605 
 606     Atomic::add(&_processed, processed, memory_order_relaxed);
 607   }
 608 };
 609 
 610 class ShenandoahVerifyNoIncompleteSatbBuffers : public ThreadClosure {
 611 public:
 612   void do_thread(Thread* thread) override {
 613     SATBMarkQueue& queue = ShenandoahThreadLocalData::satb_mark_queue(thread);
 614     if (!is_empty(queue)) {
 615       fatal("All SATB buffers should have been flushed during mark");
 616     }
 617   }
 618 private:
 619   bool is_empty(SATBMarkQueue& queue) {
 620     return queue.buffer() == nullptr || queue.index() == queue.capacity();
 621   }
 622 };
 623 
 624 class ShenandoahVerifierMarkedRegionTask : public WorkerTask {
 625 private:
 626   const char* _label;
 627   ShenandoahVerifier::VerifyOptions _options;
 628   ShenandoahHeap *_heap;
 629   MarkBitMap* _bitmap;
 630   ShenandoahLivenessData* _ld;
 631   volatile size_t _claimed;
 632   volatile size_t _processed;
 633   ShenandoahGeneration* _generation;
 634 
 635 public:
 636   ShenandoahVerifierMarkedRegionTask(MarkBitMap* bitmap,
 637                                      ShenandoahLivenessData* ld,
 638                                      const char* label,
 639                                      ShenandoahVerifier::VerifyOptions options) :
 640           WorkerTask("Shenandoah Verifier Marked Objects"),
 641           _label(label),
 642           _options(options),
 643           _heap(ShenandoahHeap::heap()),
 644           _bitmap(bitmap),
 645           _ld(ld),
 646           _claimed(0),
 647           _processed(0),
 648           _generation(nullptr) {
 649     if (_heap->mode()->is_generational()) {
 650       _generation = _heap->gc_generation();
 651       assert(_generation != nullptr, "Expected active generation in this mode.");
 652       shenandoah_assert_generations_reconciled();
 653     }
 654   };
 655 
 656   size_t processed() {
 657     return Atomic::load(&_processed);
 658   }
 659 
 660   void work(uint worker_id) override {
 661     if (_options._verify_marked == ShenandoahVerifier::_verify_marked_complete_satb_empty) {
 662       ShenandoahVerifyNoIncompleteSatbBuffers verify_satb;
 663       Threads::threads_do(&verify_satb);
 664     }
 665 
 666     ShenandoahVerifierStack stack;
 667     ShenandoahVerifyOopClosure cl(&stack, _bitmap, _ld,
 668                                   ShenandoahMessageBuffer("%s, Marked", _label),
 669                                   _options);
 670 
 671     while (true) {
 672       size_t v = Atomic::fetch_then_add(&_claimed, 1u, memory_order_relaxed);
 673       if (v < _heap->num_regions()) {
 674         ShenandoahHeapRegion* r = _heap->get_region(v);
 675         if (!in_generation(r)) {
 676           continue;
 677         }
 678 
 679         if (!r->is_humongous() && !r->is_trash()) {
 680           work_regular(r, stack, cl);
 681         } else if (r->is_humongous_start()) {
 682           work_humongous(r, stack, cl);
 683         }
 684       } else {
 685         break;
 686       }
 687     }
 688   }
 689 
 690   bool in_generation(ShenandoahHeapRegion* r) {
 691     return _generation == nullptr || _generation->contains(r);
 692   }
 693 
 694   virtual void work_humongous(ShenandoahHeapRegion *r, ShenandoahVerifierStack& stack, ShenandoahVerifyOopClosure& cl) {
 695     size_t processed = 0;
 696     HeapWord* obj = r->bottom();
 697     if (_heap->complete_marking_context()->is_marked(cast_to_oop(obj))) {
 698       verify_and_follow(obj, stack, cl, &processed);
 699     }
 700     Atomic::add(&_processed, processed, memory_order_relaxed);
 701   }
 702 
 703   virtual void work_regular(ShenandoahHeapRegion *r, ShenandoahVerifierStack &stack, ShenandoahVerifyOopClosure &cl) {
 704     size_t processed = 0;
 705     ShenandoahMarkingContext* ctx = _heap->complete_marking_context();
 706     HeapWord* tams = ctx->top_at_mark_start(r);
 707 
 708     // Bitmaps, before TAMS
 709     if (tams > r->bottom()) {
 710       HeapWord* start = r->bottom();
 711       HeapWord* addr = ctx->get_next_marked_addr(start, tams);
 712 
 713       while (addr < tams) {
 714         verify_and_follow(addr, stack, cl, &processed);
 715         addr += 1;
 716         if (addr < tams) {
 717           addr = ctx->get_next_marked_addr(addr, tams);
 718         }
 719       }
 720     }
 721 
 722     // Size-based, after TAMS
 723     {
 724       HeapWord* limit = r->top();
 725       HeapWord* addr = tams;
 726 
 727       while (addr < limit) {
 728         verify_and_follow(addr, stack, cl, &processed);
 729         addr += cast_to_oop(addr)->size();
 730       }
 731     }
 732 
 733     Atomic::add(&_processed, processed, memory_order_relaxed);
 734   }
 735 
 736   void verify_and_follow(HeapWord *addr, ShenandoahVerifierStack &stack, ShenandoahVerifyOopClosure &cl, size_t *processed) {
 737     if (!_bitmap->par_mark(addr)) return;
 738 
 739     // Verify the object itself:
 740     oop obj = cast_to_oop(addr);
 741     cl.verify_oop_standalone(obj);
 742 
 743     // Verify everything reachable from that object too, hopefully realizing
 744     // everything was already marked, and never touching further:
 745     if (!is_instance_ref_klass(obj->klass())) {
 746       cl.verify_oops_from(obj);
 747       (*processed)++;
 748     }
 749     while (!stack.is_empty()) {
 750       ShenandoahVerifierTask task = stack.pop();
 751       cl.verify_oops_from(task.obj());
 752       (*processed)++;
 753     }
 754   }
 755 };
 756 
 757 class VerifyThreadGCState : public ThreadClosure {
 758 private:
 759   const char* const _label;
 760          char const _expected;
 761 
 762 public:
 763   VerifyThreadGCState(const char* label, char expected) : _label(label), _expected(expected) {}
 764   void do_thread(Thread* t) override {
 765     char actual = ShenandoahThreadLocalData::gc_state(t);
 766     if (!verify_gc_state(actual, _expected)) {
 767       fatal("%s: Thread %s: expected gc-state %d, actual %d", _label, t->name(), _expected, actual);
 768     }
 769   }
 770 
 771   static bool verify_gc_state(char actual, char expected) {
 772     // Old generation marking is allowed in all states.
 773     if (ShenandoahHeap::heap()->mode()->is_generational()) {
 774       return ((actual & ~(ShenandoahHeap::OLD_MARKING | ShenandoahHeap::MARKING)) == expected);
 775     } else {
 776       assert((actual & ShenandoahHeap::OLD_MARKING) == 0, "Should not mark old in non-generational mode");
 777       return (actual == expected);
 778     }
 779   }
 780 };
 781 
 782 void ShenandoahVerifier::verify_at_safepoint(const char* label,
 783                                              VerifyRememberedSet remembered,
 784                                              VerifyForwarded forwarded, VerifyMarked marked,
 785                                              VerifyCollectionSet cset,
 786                                              VerifyLiveness liveness, VerifyRegions regions,
 787                                              VerifySize sizeness,
 788                                              VerifyGCState gcstate) {
 789   guarantee(ShenandoahSafepoint::is_at_shenandoah_safepoint(), "only when nothing else happens");
 790   guarantee(ShenandoahVerify, "only when enabled, and bitmap is initialized in ShenandoahHeap::initialize");
 791 
 792   ShenandoahHeap::heap()->propagate_gc_state_to_java_threads();
 793 
 794   // Avoid side-effect of changing workers' active thread count, but bypass concurrent/parallel protocol check
 795   ShenandoahPushWorkerScope verify_worker_scope(_heap->workers(), _heap->max_workers(), false /*bypass check*/);
 796 
 797   log_info(gc,start)("Verify %s, Level " INTX_FORMAT, label, ShenandoahVerifyLevel);
 798 
 799   // GC state checks
 800   {
 801     char expected = -1;
 802     bool enabled;
 803     switch (gcstate) {
 804       case _verify_gcstate_disable:
 805         enabled = false;
 806         break;
 807       case _verify_gcstate_forwarded:
 808         enabled = true;
 809         expected = ShenandoahHeap::HAS_FORWARDED;
 810         break;
 811       case _verify_gcstate_stable:
 812         enabled = true;
 813         expected = ShenandoahHeap::STABLE;
 814         break;
 815       case _verify_gcstate_stable_weakroots:
 816         enabled = true;
 817         expected = ShenandoahHeap::STABLE;
 818         if (!_heap->is_stw_gc_in_progress()) {
 819           // Only concurrent GC sets this.
 820           expected |= ShenandoahHeap::WEAK_ROOTS;
 821         }
 822         break;
 823       default:
 824         enabled = false;
 825         assert(false, "Unhandled gc-state verification");
 826     }
 827 
 828     if (enabled) {
 829       char actual = _heap->gc_state();
 830 
 831       bool is_marking = (actual & ShenandoahHeap::MARKING);
 832       bool is_marking_young_or_old = (actual & (ShenandoahHeap::YOUNG_MARKING | ShenandoahHeap::OLD_MARKING));
 833       assert(is_marking == is_marking_young_or_old, "MARKING iff (YOUNG_MARKING or OLD_MARKING), gc_state is: %x", actual);
 834 
 835       // Old generation marking is allowed in all states.
 836       if (!VerifyThreadGCState::verify_gc_state(actual, expected)) {
 837         fatal("%s: Global gc-state: expected %d, actual %d", label, expected, actual);
 838       }
 839 
 840       VerifyThreadGCState vtgcs(label, expected);
 841       Threads::java_threads_do(&vtgcs);
 842     }
 843   }
 844 
 845   // Deactivate barriers temporarily: Verifier wants plain heap accesses
 846   ShenandoahGCStateResetter resetter;
 847 
 848   // Heap size checks
 849   {
 850     ShenandoahHeapLocker lock(_heap->lock());
 851 
 852     ShenandoahCalculateRegionStatsClosure cl;
 853     _heap->heap_region_iterate(&cl);
 854     size_t heap_used;
 855     if (_heap->mode()->is_generational() && (sizeness == _verify_size_adjusted_for_padding)) {
 856       // Prior to evacuation, regular regions that are to be evacuated in place are padded to prevent further allocations
 857       heap_used = _heap->used() + _heap->old_generation()->get_pad_for_promote_in_place();
 858     } else if (sizeness != _verify_size_disable) {
 859       heap_used = _heap->used();
 860     }
 861     if (sizeness != _verify_size_disable) {
 862       guarantee(cl.used() == heap_used,
 863                 "%s: heap used size must be consistent: heap-used = " SIZE_FORMAT "%s, regions-used = " SIZE_FORMAT "%s",
 864                 label,
 865                 byte_size_in_proper_unit(heap_used), proper_unit_for_byte_size(heap_used),
 866                 byte_size_in_proper_unit(cl.used()), proper_unit_for_byte_size(cl.used()));
 867     }
 868     size_t heap_committed = _heap->committed();
 869     guarantee(cl.committed() == heap_committed,
 870               "%s: heap committed size must be consistent: heap-committed = " SIZE_FORMAT "%s, regions-committed = " SIZE_FORMAT "%s",
 871               label,
 872               byte_size_in_proper_unit(heap_committed), proper_unit_for_byte_size(heap_committed),
 873               byte_size_in_proper_unit(cl.committed()), proper_unit_for_byte_size(cl.committed()));
 874   }
 875 
 876   log_debug(gc)("Safepoint verification finished heap usage verification");
 877 
 878   ShenandoahGeneration* generation;
 879   if (_heap->mode()->is_generational()) {
 880     generation = _heap->gc_generation();
 881     guarantee(generation != nullptr, "Need to know which generation to verify.");
 882     shenandoah_assert_generations_reconciled();
 883   } else {
 884     generation = nullptr;
 885   }
 886 
 887   if (generation != nullptr) {
 888     ShenandoahHeapLocker lock(_heap->lock());
 889 
 890     switch (remembered) {
 891       case _verify_remembered_disable:
 892         break;
 893       case _verify_remembered_before_marking:
 894         log_debug(gc)("Safepoint verification of remembered set at mark");
 895         verify_rem_set_before_mark();
 896         break;
 897       case _verify_remembered_before_updating_references:
 898         log_debug(gc)("Safepoint verification of remembered set at update ref");
 899         verify_rem_set_before_update_ref();
 900         break;
 901       case _verify_remembered_after_full_gc:
 902         log_debug(gc)("Safepoint verification of remembered set after full gc");
 903         verify_rem_set_after_full_gc();
 904         break;
 905       default:
 906         fatal("Unhandled remembered set verification mode");
 907     }
 908 
 909     ShenandoahGenerationStatsClosure cl;
 910     _heap->heap_region_iterate(&cl);
 911 
 912     if (LogTarget(Debug, gc)::is_enabled()) {
 913       ShenandoahGenerationStatsClosure::log_usage(_heap->old_generation(),    cl.old);
 914       ShenandoahGenerationStatsClosure::log_usage(_heap->young_generation(),  cl.young);
 915       ShenandoahGenerationStatsClosure::log_usage(_heap->global_generation(), cl.global);
 916     }
 917     if (sizeness == _verify_size_adjusted_for_padding) {
 918       ShenandoahGenerationStatsClosure::validate_usage(false, label, _heap->old_generation(), cl.old);
 919       ShenandoahGenerationStatsClosure::validate_usage(true, label, _heap->young_generation(), cl.young);
 920       ShenandoahGenerationStatsClosure::validate_usage(true, label, _heap->global_generation(), cl.global);
 921     } else if (sizeness == _verify_size_exact) {
 922       ShenandoahGenerationStatsClosure::validate_usage(false, label, _heap->old_generation(), cl.old);
 923       ShenandoahGenerationStatsClosure::validate_usage(false, label, _heap->young_generation(), cl.young);
 924       ShenandoahGenerationStatsClosure::validate_usage(false, label, _heap->global_generation(), cl.global);
 925     }
 926     // else: sizeness must equal _verify_size_disable
 927   }
 928 
 929   log_debug(gc)("Safepoint verification finished remembered set verification");
 930 
 931   // Internal heap region checks
 932   if (ShenandoahVerifyLevel >= 1) {
 933     ShenandoahVerifyHeapRegionClosure cl(label, regions);
 934     if (generation != nullptr) {
 935       generation->heap_region_iterate(&cl);
 936     } else {
 937       _heap->heap_region_iterate(&cl);
 938     }
 939   }
 940 
 941   log_debug(gc)("Safepoint verification finished heap region closure verification");
 942 
 943   OrderAccess::fence();
 944 
 945   if (UseTLAB) {
 946     _heap->labs_make_parsable();
 947   }
 948 
 949   // Allocate temporary bitmap for storing marking wavefront:
 950   _verification_bit_map->clear();
 951 
 952   // Allocate temporary array for storing liveness data
 953   ShenandoahLivenessData* ld = NEW_C_HEAP_ARRAY(ShenandoahLivenessData, _heap->num_regions(), mtGC);
 954   Copy::fill_to_bytes((void*)ld, _heap->num_regions()*sizeof(ShenandoahLivenessData), 0);
 955 
 956   const VerifyOptions& options = ShenandoahVerifier::VerifyOptions(forwarded, marked, cset, liveness, regions, gcstate);
 957 
 958   // Steps 1-2. Scan root set to get initial reachable set. Finish walking the reachable heap.
 959   // This verifies what application can see, since it only cares about reachable objects.
 960   size_t count_reachable = 0;
 961   if (ShenandoahVerifyLevel >= 2) {
 962     ShenandoahVerifierReachableTask task(_verification_bit_map, ld, label, options);
 963     _heap->workers()->run_task(&task);
 964     count_reachable = task.processed();
 965   }
 966 
 967   log_debug(gc)("Safepoint verification finished getting initial reachable set");
 968 
 969   // Step 3. Walk marked objects. Marked objects might be unreachable. This verifies what collector,
 970   // not the application, can see during the region scans. There is no reason to process the objects
 971   // that were already verified, e.g. those marked in verification bitmap. There is interaction with TAMS:
 972   // before TAMS, we verify the bitmaps, if available; after TAMS, we walk until the top(). It mimics
 973   // what marked_object_iterate is doing, without calling into that optimized (and possibly incorrect)
 974   // version
 975 
 976   size_t count_marked = 0;
 977   if (ShenandoahVerifyLevel >= 4 &&
 978         (marked == _verify_marked_complete ||
 979          marked == _verify_marked_complete_except_references ||
 980          marked == _verify_marked_complete_satb_empty)) {
 981     guarantee(_heap->marking_context()->is_complete(), "Marking context should be complete");
 982     ShenandoahVerifierMarkedRegionTask task(_verification_bit_map, ld, label, options);
 983     _heap->workers()->run_task(&task);
 984     count_marked = task.processed();
 985   } else {
 986     guarantee(ShenandoahVerifyLevel < 4 || marked == _verify_marked_incomplete || marked == _verify_marked_disable, "Should be");
 987   }
 988 
 989   log_debug(gc)("Safepoint verification finished walking marked objects");
 990 
 991   // Step 4. Verify accumulated liveness data, if needed. Only reliable if verification level includes
 992   // marked objects.
 993 
 994   if (ShenandoahVerifyLevel >= 4 && marked == _verify_marked_complete && liveness == _verify_liveness_complete) {
 995     for (size_t i = 0; i < _heap->num_regions(); i++) {
 996       ShenandoahHeapRegion* r = _heap->get_region(i);
 997       if (generation != nullptr && !generation->contains(r)) {
 998         continue;
 999       }
1000 
1001       juint verf_live = 0;
1002       if (r->is_humongous()) {
1003         // For humongous objects, test if start region is marked live, and if so,
1004         // all humongous regions in that chain have live data equal to their "used".
1005         juint start_live = Atomic::load(&ld[r->humongous_start_region()->index()]);
1006         if (start_live > 0) {
1007           verf_live = (juint)(r->used() / HeapWordSize);
1008         }
1009       } else {
1010         verf_live = Atomic::load(&ld[r->index()]);
1011       }
1012 
1013       size_t reg_live = r->get_live_data_words();
1014       if (reg_live != verf_live) {
1015         stringStream ss;
1016         r->print_on(&ss);
1017         fatal("%s: Live data should match: region-live = " SIZE_FORMAT ", verifier-live = " UINT32_FORMAT "\n%s",
1018               label, reg_live, verf_live, ss.freeze());
1019       }
1020     }
1021   }
1022 
1023   log_debug(gc)("Safepoint verification finished accumulation of liveness data");
1024 
1025 
1026   log_info(gc)("Verify %s, Level " INTX_FORMAT " (" SIZE_FORMAT " reachable, " SIZE_FORMAT " marked)",
1027                label, ShenandoahVerifyLevel, count_reachable, count_marked);
1028 
1029   FREE_C_HEAP_ARRAY(ShenandoahLivenessData, ld);
1030 }
1031 
1032 void ShenandoahVerifier::verify_generic(VerifyOption vo) {
1033   verify_at_safepoint(
1034           "Generic Verification",
1035           _verify_remembered_disable,  // do not verify remembered set
1036           _verify_forwarded_allow,     // conservatively allow forwarded
1037           _verify_marked_disable,      // do not verify marked: lots ot time wasted checking dead allocations
1038           _verify_cset_disable,        // cset may be inconsistent
1039           _verify_liveness_disable,    // no reliable liveness data
1040           _verify_regions_disable,     // no reliable region data
1041           _verify_size_exact,          // expect generation and heap sizes to match exactly
1042           _verify_gcstate_disable      // no data about gcstate
1043   );
1044 }
1045 
1046 void ShenandoahVerifier::verify_before_concmark() {
1047     verify_at_safepoint(
1048           "Before Mark",
1049           _verify_remembered_before_marking,
1050                                        // verify read-only remembered set from bottom() to top()
1051           _verify_forwarded_none,      // UR should have fixed up
1052           _verify_marked_disable,      // do not verify marked: lots ot time wasted checking dead allocations
1053           _verify_cset_none,           // UR should have fixed this
1054           _verify_liveness_disable,    // no reliable liveness data
1055           _verify_regions_notrash,     // no trash regions
1056           _verify_size_exact,          // expect generation and heap sizes to match exactly
1057           _verify_gcstate_stable       // there are no forwarded objects
1058   );
1059 }
1060 
1061 void ShenandoahVerifier::verify_after_concmark() {
1062   verify_at_safepoint(
1063           "After Mark",
1064           _verify_remembered_disable,         // do not verify remembered set
1065           _verify_forwarded_none,             // no forwarded references
1066           _verify_marked_complete_satb_empty, // bitmaps as precise as we can get, except dangling j.l.r.Refs
1067           _verify_cset_none,                  // no references to cset anymore
1068           _verify_liveness_complete,          // liveness data must be complete here
1069           _verify_regions_disable,            // trash regions not yet recycled
1070           _verify_size_exact,                 // expect generation and heap sizes to match exactly
1071           _verify_gcstate_stable_weakroots    // heap is still stable, weakroots are in progress
1072   );
1073 }
1074 
1075 void ShenandoahVerifier::verify_after_concmark_with_promotions() {
1076   verify_at_safepoint(
1077           "After Mark",
1078           _verify_remembered_disable,         // do not verify remembered set
1079           _verify_forwarded_none,             // no forwarded references
1080           _verify_marked_complete_satb_empty, // bitmaps as precise as we can get, except dangling j.l.r.Refs
1081           _verify_cset_none,                  // no references to cset anymore
1082           _verify_liveness_complete,          // liveness data must be complete here
1083           _verify_regions_disable,            // trash regions not yet recycled
1084           _verify_size_adjusted_for_padding,  // expect generation and heap sizes to match after adjustments
1085                                               // for promote in place padding
1086           _verify_gcstate_stable_weakroots    // heap is still stable, weakroots are in progress
1087   );
1088 }
1089 
1090 void ShenandoahVerifier::verify_before_evacuation() {
1091   verify_at_safepoint(
1092           "Before Evacuation",
1093           _verify_remembered_disable,                // do not verify remembered set
1094           _verify_forwarded_none,                    // no forwarded references
1095           _verify_marked_complete_except_references, // walk over marked objects too
1096           _verify_cset_disable,                      // non-forwarded references to cset expected
1097           _verify_liveness_complete,                 // liveness data must be complete here
1098           _verify_regions_disable,                   // trash regions not yet recycled
1099           _verify_size_adjusted_for_padding,         // expect generation and heap sizes to match after adjustments
1100                                                      //  for promote in place padding
1101           _verify_gcstate_stable_weakroots           // heap is still stable, weakroots are in progress
1102   );
1103 }
1104 
1105 void ShenandoahVerifier::verify_before_updaterefs() {
1106   verify_at_safepoint(
1107           "Before Updating References",
1108           _verify_remembered_before_updating_references,  // verify read-write remembered set
1109           _verify_forwarded_allow,     // forwarded references allowed
1110           _verify_marked_complete,     // bitmaps might be stale, but alloc-after-mark should be well
1111           _verify_cset_forwarded,      // all cset refs are fully forwarded
1112           _verify_liveness_disable,    // no reliable liveness data anymore
1113           _verify_regions_notrash,     // trash regions have been recycled already
1114           _verify_size_exact,          // expect generation and heap sizes to match exactly
1115           _verify_gcstate_forwarded    // evacuation should have produced some forwarded objects
1116   );
1117 }
1118 
1119 // We have not yet cleanup (reclaimed) the collection set
1120 void ShenandoahVerifier::verify_after_updaterefs() {
1121   verify_at_safepoint(
1122           "After Updating References",
1123           _verify_remembered_disable,  // do not verify remembered set
1124           _verify_forwarded_none,      // no forwarded references
1125           _verify_marked_complete,     // bitmaps might be stale, but alloc-after-mark should be well
1126           _verify_cset_none,           // no cset references, all updated
1127           _verify_liveness_disable,    // no reliable liveness data anymore
1128           _verify_regions_nocset,      // no cset regions, trash regions have appeared
1129           _verify_size_exact,          // expect generation and heap sizes to match exactly
1130           _verify_gcstate_stable       // update refs had cleaned up forwarded objects
1131   );
1132 }
1133 
1134 void ShenandoahVerifier::verify_after_degenerated() {
1135   verify_at_safepoint(
1136           "After Degenerated GC",
1137           _verify_remembered_disable,  // do not verify remembered set
1138           _verify_forwarded_none,      // all objects are non-forwarded
1139           _verify_marked_complete,     // all objects are marked in complete bitmap
1140           _verify_cset_none,           // no cset references
1141           _verify_liveness_disable,    // no reliable liveness data anymore
1142           _verify_regions_notrash_nocset, // no trash, no cset
1143           _verify_size_exact,          // expect generation and heap sizes to match exactly
1144           _verify_gcstate_stable       // degenerated refs had cleaned up forwarded objects
1145   );
1146 }
1147 
1148 void ShenandoahVerifier::verify_before_fullgc() {
1149   verify_at_safepoint(
1150           "Before Full GC",
1151           _verify_remembered_disable,  // do not verify remembered set
1152           _verify_forwarded_allow,     // can have forwarded objects
1153           _verify_marked_disable,      // do not verify marked: lots ot time wasted checking dead allocations
1154           _verify_cset_disable,        // cset might be foobared
1155           _verify_liveness_disable,    // no reliable liveness data anymore
1156           _verify_regions_disable,     // no reliable region data here
1157           _verify_size_disable,        // if we degenerate during evacuation, usage not valid: padding and deferred accounting
1158           _verify_gcstate_disable      // no reliable gcstate data
1159   );
1160 }
1161 
1162 void ShenandoahVerifier::verify_after_fullgc() {
1163   verify_at_safepoint(
1164           "After Full GC",
1165           _verify_remembered_after_full_gc,  // verify read-write remembered set
1166           _verify_forwarded_none,      // all objects are non-forwarded
1167           _verify_marked_complete,     // all objects are marked in complete bitmap
1168           _verify_cset_none,           // no cset references
1169           _verify_liveness_disable,    // no reliable liveness data anymore
1170           _verify_regions_notrash_nocset, // no trash, no cset
1171           _verify_size_exact,           // expect generation and heap sizes to match exactly
1172           _verify_gcstate_stable        // full gc cleaned up everything
1173   );
1174 }
1175 
1176 class ShenandoahVerifyNoForwarded : public BasicOopIterateClosure {
1177 private:
1178   template <class T>
1179   void do_oop_work(T* p) {
1180     T o = RawAccess<>::oop_load(p);
1181     if (!CompressedOops::is_null(o)) {
1182       oop obj = CompressedOops::decode_not_null(o);
1183       oop fwd = ShenandoahForwarding::get_forwardee_raw_unchecked(obj);
1184       if (obj != fwd) {
1185         ShenandoahAsserts::print_failure(ShenandoahAsserts::_safe_all, obj, p, nullptr,
1186                                          "Verify Roots", "Should not be forwarded", __FILE__, __LINE__);
1187       }
1188     }
1189   }
1190 
1191 public:
1192   void do_oop(narrowOop* p) { do_oop_work(p); }
1193   void do_oop(oop* p)       { do_oop_work(p); }
1194 };
1195 
1196 class ShenandoahVerifyInToSpaceClosure : public BasicOopIterateClosure {
1197 private:
1198   template <class T>
1199   void do_oop_work(T* p) {
1200     T o = RawAccess<>::oop_load(p);
1201     if (!CompressedOops::is_null(o)) {
1202       oop obj = CompressedOops::decode_not_null(o);
1203       ShenandoahHeap* heap = ShenandoahHeap::heap();
1204 
1205       if (!heap->marking_context()->is_marked_or_old(obj)) {
1206         ShenandoahAsserts::print_failure(ShenandoahAsserts::_safe_all, obj, p, nullptr,
1207                 "Verify Roots In To-Space", "Should be marked", __FILE__, __LINE__);
1208       }
1209 
1210       if (heap->in_collection_set(obj)) {
1211         ShenandoahAsserts::print_failure(ShenandoahAsserts::_safe_all, obj, p, nullptr,
1212                 "Verify Roots In To-Space", "Should not be in collection set", __FILE__, __LINE__);
1213       }
1214 
1215       oop fwd = ShenandoahForwarding::get_forwardee_raw_unchecked(obj);
1216       if (obj != fwd) {
1217         ShenandoahAsserts::print_failure(ShenandoahAsserts::_safe_all, obj, p, nullptr,
1218                 "Verify Roots In To-Space", "Should not be forwarded", __FILE__, __LINE__);
1219       }
1220     }
1221   }
1222 
1223 public:
1224   void do_oop(narrowOop* p) override { do_oop_work(p); }
1225   void do_oop(oop* p)       override { do_oop_work(p); }
1226 };
1227 
1228 void ShenandoahVerifier::verify_roots_in_to_space() {
1229   ShenandoahVerifyInToSpaceClosure cl;
1230   ShenandoahRootVerifier::roots_do(&cl);
1231 }
1232 
1233 void ShenandoahVerifier::verify_roots_no_forwarded() {
1234   ShenandoahVerifyNoForwarded cl;
1235   ShenandoahRootVerifier::roots_do(&cl);
1236 }
1237 
1238 template<typename Scanner>
1239 class ShenandoahVerifyRemSetClosure : public BasicOopIterateClosure {
1240 protected:
1241   ShenandoahGenerationalHeap* const _heap;
1242   Scanner*   const _scanner;
1243   const char* _message;
1244 
1245 public:
1246   // Argument distinguishes between initial mark or start of update refs verification.
1247   explicit ShenandoahVerifyRemSetClosure(Scanner* scanner, const char* message) :
1248             _heap(ShenandoahGenerationalHeap::heap()),
1249             _scanner(scanner),
1250             _message(message) {}
1251 
1252   template<class T>
1253   inline void work(T* p) {
1254     T o = RawAccess<>::oop_load(p);
1255     if (!CompressedOops::is_null(o)) {
1256       oop obj = CompressedOops::decode_not_null(o);
1257       if (_heap->is_in_young(obj) && !_scanner->is_card_dirty((HeapWord*) p)) {
1258         ShenandoahAsserts::print_failure(ShenandoahAsserts::_safe_all, obj, p, nullptr,
1259                                          _message, "clean card should be dirty", __FILE__, __LINE__);
1260       }
1261     }
1262   }
1263 
1264   void do_oop(narrowOop* p) override { work(p); }
1265   void do_oop(oop* p)       override { work(p); }
1266 };
1267 
1268 ShenandoahMarkingContext* ShenandoahVerifier::get_marking_context_for_old() {
1269   shenandoah_assert_generations_reconciled();
1270   if (_heap->old_generation()->is_mark_complete() || _heap->gc_generation()->is_global()) {
1271     return _heap->complete_marking_context();
1272   }
1273   return nullptr;
1274 }
1275 
1276 template<typename Scanner>
1277 void ShenandoahVerifier::help_verify_region_rem_set(Scanner* scanner, ShenandoahHeapRegion* r, ShenandoahMarkingContext* ctx,
1278                                                     HeapWord* registration_watermark, const char* message) {
1279   ShenandoahVerifyRemSetClosure<Scanner> check_interesting_pointers(scanner, message);
1280   HeapWord* from = r->bottom();
1281   HeapWord* obj_addr = from;
1282   if (r->is_humongous_start()) {
1283     oop obj = cast_to_oop(obj_addr);
1284     if ((ctx == nullptr) || ctx->is_marked(obj)) {
1285       // For humongous objects, the typical object is an array, so the following checks may be overkill
1286       // For regular objects (not object arrays), if the card holding the start of the object is dirty,
1287       // we do not need to verify that cards spanning interesting pointers within this object are dirty.
1288       if (!scanner->is_card_dirty(obj_addr) || obj->is_objArray()) {
1289         obj->oop_iterate(&check_interesting_pointers);
1290       }
1291       // else, object's start is marked dirty and obj is not an objArray, so any interesting pointers are covered
1292     }
1293     // else, this humongous object is not live so no need to verify its internal pointers
1294 
1295     if ((obj_addr < registration_watermark) && !scanner->verify_registration(obj_addr, ctx)) {
1296       ShenandoahAsserts::print_failure(ShenandoahAsserts::_safe_all, obj, obj_addr, nullptr, message,
1297                                        "object not properly registered", __FILE__, __LINE__);
1298     }
1299   } else if (!r->is_humongous()) {
1300     HeapWord* top = r->top();
1301     while (obj_addr < top) {
1302       oop obj = cast_to_oop(obj_addr);
1303       // ctx->is_marked() returns true if mark bit set or if obj above TAMS.
1304       if ((ctx == nullptr) || ctx->is_marked(obj)) {
1305         // For regular objects (not object arrays), if the card holding the start of the object is dirty,
1306         // we do not need to verify that cards spanning interesting pointers within this object are dirty.
1307         if (!scanner->is_card_dirty(obj_addr) || obj->is_objArray()) {
1308           obj->oop_iterate(&check_interesting_pointers);
1309         }
1310         // else, object's start is marked dirty and obj is not an objArray, so any interesting pointers are covered
1311 
1312         if ((obj_addr < registration_watermark) && !scanner->verify_registration(obj_addr, ctx)) {
1313           ShenandoahAsserts::print_failure(ShenandoahAsserts::_safe_all, obj, obj_addr, nullptr, message,
1314                                            "object not properly registered", __FILE__, __LINE__);
1315         }
1316         obj_addr += obj->size();
1317       } else {
1318         // This object is not live so we don't verify dirty cards contained therein
1319         HeapWord* tams = ctx->top_at_mark_start(r);
1320         obj_addr = ctx->get_next_marked_addr(obj_addr, tams);
1321       }
1322     }
1323   }
1324 }
1325 
1326 class ShenandoahWriteTableScanner {
1327 private:
1328   ShenandoahScanRemembered* _scanner;
1329 public:
1330   explicit ShenandoahWriteTableScanner(ShenandoahScanRemembered* scanner) : _scanner(scanner) {}
1331 
1332   bool is_card_dirty(HeapWord* obj_addr) {
1333     return _scanner->is_write_card_dirty(obj_addr);
1334   }
1335 
1336   bool verify_registration(HeapWord* obj_addr, ShenandoahMarkingContext* ctx) {
1337     return _scanner->verify_registration(obj_addr, ctx);
1338   }
1339 };
1340 
1341 // Assure that the remember set has a dirty card everywhere there is an interesting pointer.
1342 // This examines the read_card_table between bottom() and top() since all PLABS are retired
1343 // before the safepoint for init_mark.  Actually, we retire them before update-references and don't
1344 // restore them until the start of evacuation.
1345 void ShenandoahVerifier::verify_rem_set_before_mark() {
1346   shenandoah_assert_safepoint();
1347   shenandoah_assert_generational();
1348 
1349   ShenandoahMarkingContext* ctx = get_marking_context_for_old();
1350   ShenandoahOldGeneration* old_generation = _heap->old_generation();
1351 
1352   log_debug(gc)("Verifying remembered set at %s mark", old_generation->is_doing_mixed_evacuations() ? "mixed" : "young");
1353 
1354   ShenandoahScanRemembered* scanner = old_generation->card_scan();
1355   for (size_t i = 0, n = _heap->num_regions(); i < n; ++i) {
1356     ShenandoahHeapRegion* r = _heap->get_region(i);
1357     if (r->is_old() && r->is_active()) {
1358       help_verify_region_rem_set(scanner, r, ctx, r->end(), "Verify init-mark remembered set violation");
1359     }
1360   }
1361 }
1362 
1363 void ShenandoahVerifier::verify_rem_set_after_full_gc() {
1364   shenandoah_assert_safepoint();
1365   shenandoah_assert_generational();
1366 
1367   ShenandoahWriteTableScanner scanner(ShenandoahGenerationalHeap::heap()->old_generation()->card_scan());
1368   for (size_t i = 0, n = _heap->num_regions(); i < n; ++i) {
1369     ShenandoahHeapRegion* r = _heap->get_region(i);
1370     if (r->is_old() && !r->is_cset()) {
1371       help_verify_region_rem_set(&scanner, r, nullptr, r->top(), "Remembered set violation at end of Full GC");
1372     }
1373   }
1374 }
1375 
1376 // Assure that the remember set has a dirty card everywhere there is an interesting pointer.  Even though
1377 // the update-references scan of remembered set only examines cards up to update_watermark, the remembered
1378 // set should be valid through top.  This examines the write_card_table between bottom() and top() because
1379 // all PLABS are retired immediately before the start of update refs.
1380 void ShenandoahVerifier::verify_rem_set_before_update_ref() {
1381   shenandoah_assert_safepoint();
1382   shenandoah_assert_generational();
1383 
1384   ShenandoahMarkingContext* ctx = get_marking_context_for_old();
1385   ShenandoahWriteTableScanner scanner(_heap->old_generation()->card_scan());
1386   for (size_t i = 0, n = _heap->num_regions(); i < n; ++i) {
1387     ShenandoahHeapRegion* r = _heap->get_region(i);
1388     if (r->is_old() && !r->is_cset()) {
1389       help_verify_region_rem_set(&scanner, r, ctx, r->get_update_watermark(), "Remembered set violation at init-update-references");
1390     }
1391   }
1392 }
1393 
1394 void ShenandoahVerifier::verify_before_rebuilding_free_set() {
1395   ShenandoahGenerationStatsClosure cl;
1396   _heap->heap_region_iterate(&cl);
1397 
1398   ShenandoahGenerationStatsClosure::validate_usage(false, "Before free set rebuild", _heap->old_generation(), cl.old);
1399   ShenandoahGenerationStatsClosure::validate_usage(false, "Before free set rebuild", _heap->young_generation(), cl.young);
1400   ShenandoahGenerationStatsClosure::validate_usage(false, "Before free set rebuild", _heap->global_generation(), cl.global);
1401 }