1 /*
   2  * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #include "precompiled.hpp"
  26 #include "gc_implementation/g1/bufferingOopClosure.hpp"
  27 #include "gc_implementation/g1/concurrentG1Refine.hpp"
  28 #include "gc_implementation/g1/concurrentG1RefineThread.hpp"
  29 #include "gc_implementation/g1/g1BlockOffsetTable.inline.hpp"
  30 #include "gc_implementation/g1/g1CollectedHeap.inline.hpp"
  31 #include "gc_implementation/g1/g1CollectorPolicy.hpp"
  32 #include "gc_implementation/g1/g1HotCardCache.hpp"
  33 #include "gc_implementation/g1/g1GCPhaseTimes.hpp"
  34 #include "gc_implementation/g1/g1OopClosures.inline.hpp"
  35 #include "gc_implementation/g1/g1RemSet.inline.hpp"
  36 #include "gc_implementation/g1/heapRegionSeq.inline.hpp"
  37 #include "gc_implementation/g1/heapRegionRemSet.hpp"
  38 #include "memory/iterator.hpp"
  39 #include "oops/oop.inline.hpp"
  40 #include "utilities/intHisto.hpp"
  41 
  42 #define CARD_REPEAT_HISTO 0
  43 
  44 #if CARD_REPEAT_HISTO
  45 static size_t ct_freq_sz;
  46 static jbyte* ct_freq = NULL;
  47 
  48 void init_ct_freq_table(size_t heap_sz_bytes) {
  49   if (ct_freq == NULL) {
  50     ct_freq_sz = heap_sz_bytes/CardTableModRefBS::card_size;
  51     ct_freq = new jbyte[ct_freq_sz];
  52     for (size_t j = 0; j < ct_freq_sz; j++) ct_freq[j] = 0;
  53   }
  54 }
  55 
  56 void ct_freq_note_card(size_t index) {
  57   assert(0 <= index && index < ct_freq_sz, "Bounds error.");
  58   if (ct_freq[index] < 100) { ct_freq[index]++; }
  59 }
  60 
  61 static IntHistogram card_repeat_count(10, 10);
  62 
  63 void ct_freq_update_histo_and_reset() {
  64   for (size_t j = 0; j < ct_freq_sz; j++) {
  65     card_repeat_count.add_entry(ct_freq[j]);
  66     ct_freq[j] = 0;
  67   }
  68 
  69 }
  70 #endif
  71 
  72 G1RemSet::G1RemSet(G1CollectedHeap* g1, CardTableModRefBS* ct_bs)
  73   : _g1(g1), _conc_refine_cards(0),
  74     _ct_bs(ct_bs), _g1p(_g1->g1_policy()),
  75     _cg1r(g1->concurrent_g1_refine()),
  76     _cset_rs_update_cl(NULL),
  77     _cards_scanned(NULL), _total_cards_scanned(0),
  78     _prev_period_summary()
  79 {
  80   _seq_task = new SubTasksDone(NumSeqTasks);
  81   guarantee(n_workers() > 0, "There should be some workers");
  82   _cset_rs_update_cl = NEW_C_HEAP_ARRAY(OopsInHeapRegionClosure*, n_workers(), mtGC);
  83   for (uint i = 0; i < n_workers(); i++) {
  84     _cset_rs_update_cl[i] = NULL;
  85   }
  86   _prev_period_summary.initialize(this, n_workers());
  87 }
  88 
  89 G1RemSet::~G1RemSet() {
  90   delete _seq_task;
  91   for (uint i = 0; i < n_workers(); i++) {
  92     assert(_cset_rs_update_cl[i] == NULL, "it should be");
  93   }
  94   FREE_C_HEAP_ARRAY(OopsInHeapRegionClosure*, _cset_rs_update_cl, mtGC);
  95 }
  96 
  97 void CountNonCleanMemRegionClosure::do_MemRegion(MemRegion mr) {
  98   if (_g1->is_in_g1_reserved(mr.start())) {
  99     _n += (int) ((mr.byte_size() / CardTableModRefBS::card_size));
 100     if (_start_first == NULL) _start_first = mr.start();
 101   }
 102 }
 103 
 104 class ScanRSClosure : public HeapRegionClosure {
 105   size_t _cards_done, _cards;
 106   G1CollectedHeap* _g1h;
 107 
 108   OopsInHeapRegionClosure* _oc;
 109   CodeBlobToOopClosure* _code_root_cl;
 110 
 111   G1BlockOffsetSharedArray* _bot_shared;
 112   CardTableModRefBS *_ct_bs;
 113 
 114   double _strong_code_root_scan_time_sec;
 115   int    _worker_i;
 116   int    _block_size;
 117   bool   _try_claimed;
 118 
 119 public:
 120   ScanRSClosure(OopsInHeapRegionClosure* oc,
 121                 CodeBlobToOopClosure* code_root_cl,
 122                 int worker_i) :
 123     _oc(oc),
 124     _code_root_cl(code_root_cl),
 125     _strong_code_root_scan_time_sec(0.0),
 126     _cards(0),
 127     _cards_done(0),
 128     _worker_i(worker_i),
 129     _try_claimed(false)
 130   {
 131     _g1h = G1CollectedHeap::heap();
 132     _bot_shared = _g1h->bot_shared();
 133     _ct_bs = (CardTableModRefBS*) (_g1h->barrier_set());
 134     _block_size = MAX2<int>(G1RSetScanBlockSize, 1);
 135   }
 136 
 137   void set_try_claimed() { _try_claimed = true; }
 138 
 139   void scanCard(size_t index, HeapRegion *r) {
 140     // Stack allocate the DirtyCardToOopClosure instance
 141     HeapRegionDCTOC cl(_g1h, r, _oc,
 142                        CardTableModRefBS::Precise,
 143                        HeapRegionDCTOC::IntoCSFilterKind);
 144 
 145     // Set the "from" region in the closure.
 146     _oc->set_region(r);
 147     HeapWord* card_start = _bot_shared->address_for_index(index);
 148     HeapWord* card_end = card_start + G1BlockOffsetSharedArray::N_words;
 149     Space *sp = SharedHeap::heap()->space_containing(card_start);
 150     MemRegion sm_region = sp->used_region_at_save_marks();
 151     MemRegion mr = sm_region.intersection(MemRegion(card_start,card_end));
 152     if (!mr.is_empty() && !_ct_bs->is_card_claimed(index)) {
 153       // We make the card as "claimed" lazily (so races are possible
 154       // but they're benign), which reduces the number of duplicate
 155       // scans (the rsets of the regions in the cset can intersect).
 156       _ct_bs->set_card_claimed(index);
 157       _cards_done++;
 158       cl.do_MemRegion(mr);
 159     }
 160   }
 161 
 162   void printCard(HeapRegion* card_region, size_t card_index,
 163                  HeapWord* card_start) {
 164     gclog_or_tty->print_cr("T %d Region [" PTR_FORMAT ", " PTR_FORMAT ") "
 165                            "RS names card %p: "
 166                            "[" PTR_FORMAT ", " PTR_FORMAT ")",
 167                            _worker_i,
 168                            card_region->bottom(), card_region->end(),
 169                            card_index,
 170                            card_start, card_start + G1BlockOffsetSharedArray::N_words);
 171   }
 172 
 173   void scan_strong_code_roots(HeapRegion* r) {
 174     double scan_start = os::elapsedTime();
 175     r->strong_code_roots_do(_code_root_cl);
 176     _strong_code_root_scan_time_sec += (os::elapsedTime() - scan_start);
 177   }
 178 
 179   bool doHeapRegion(HeapRegion* r) {
 180     assert(r->in_collection_set(), "should only be called on elements of CS.");
 181     HeapRegionRemSet* hrrs = r->rem_set();
 182     if (hrrs->iter_is_complete()) return false; // All done.
 183     if (!_try_claimed && !hrrs->claim_iter()) return false;
 184     // If we ever free the collection set concurrently, we should also
 185     // clear the card table concurrently therefore we won't need to
 186     // add regions of the collection set to the dirty cards region.
 187     _g1h->push_dirty_cards_region(r);
 188     // If we didn't return above, then
 189     //   _try_claimed || r->claim_iter()
 190     // is true: either we're supposed to work on claimed-but-not-complete
 191     // regions, or we successfully claimed the region.
 192 
 193     HeapRegionRemSetIterator* iter = _g1h->rem_set_iterator(_worker_i);
 194     hrrs->init_iterator(iter);
 195     size_t card_index;
 196 
 197     // We claim cards in block so as to recude the contention. The block size is determined by
 198     // the G1RSetScanBlockSize parameter.
 199     size_t jump_to_card = hrrs->iter_claimed_next(_block_size);
 200     for (size_t current_card = 0; iter->has_next(card_index); current_card++) {
 201       if (current_card >= jump_to_card + _block_size) {
 202         jump_to_card = hrrs->iter_claimed_next(_block_size);
 203       }
 204       if (current_card < jump_to_card) continue;
 205       HeapWord* card_start = _g1h->bot_shared()->address_for_index(card_index);
 206 #if 0
 207       gclog_or_tty->print("Rem set iteration yielded card [" PTR_FORMAT ", " PTR_FORMAT ").\n",
 208                           card_start, card_start + CardTableModRefBS::card_size_in_words);
 209 #endif
 210 
 211       HeapRegion* card_region = _g1h->heap_region_containing(card_start);
 212       assert(card_region != NULL, "Yielding cards not in the heap?");
 213       _cards++;
 214 
 215       if (!card_region->is_on_dirty_cards_region_list()) {
 216         _g1h->push_dirty_cards_region(card_region);
 217       }
 218 
 219       // If the card is dirty, then we will scan it during updateRS.
 220       if (!card_region->in_collection_set() &&
 221           !_ct_bs->is_card_dirty(card_index)) {
 222         scanCard(card_index, card_region);
 223       }
 224     }
 225     if (!_try_claimed) {
 226       // Scan the strong code root list attached to the current region
 227       scan_strong_code_roots(r);
 228 
 229       hrrs->set_iter_complete();
 230     }
 231     return false;
 232   }
 233 
 234   double strong_code_root_scan_time_sec() {
 235     return _strong_code_root_scan_time_sec;
 236   }
 237 
 238   size_t cards_done() { return _cards_done;}
 239   size_t cards_looked_up() { return _cards;}
 240 };
 241 
 242 void G1RemSet::scanRS(OopsInHeapRegionClosure* oc,
 243                       CodeBlobToOopClosure* code_root_cl,
 244                       int worker_i) {
 245   double rs_time_start = os::elapsedTime();
 246   HeapRegion *startRegion = _g1->start_cset_region_for_worker(worker_i);
 247 
 248   ScanRSClosure scanRScl(oc, code_root_cl, worker_i);
 249 
 250   _g1->collection_set_iterate_from(startRegion, &scanRScl);
 251   scanRScl.set_try_claimed();
 252   _g1->collection_set_iterate_from(startRegion, &scanRScl);
 253 
 254   double scan_rs_time_sec = (os::elapsedTime() - rs_time_start)
 255                             - scanRScl.strong_code_root_scan_time_sec();
 256 
 257   assert(_cards_scanned != NULL, "invariant");
 258   _cards_scanned[worker_i] = scanRScl.cards_done();
 259 
 260   _g1p->phase_times()->record_scan_rs_time(worker_i, scan_rs_time_sec * 1000.0);
 261   _g1p->phase_times()->record_strong_code_root_scan_time(worker_i,
 262                                                          scanRScl.strong_code_root_scan_time_sec() * 1000.0);
 263 }
 264 
 265 // Closure used for updating RSets and recording references that
 266 // point into the collection set. Only called during an
 267 // evacuation pause.
 268 
 269 class RefineRecordRefsIntoCSCardTableEntryClosure: public CardTableEntryClosure {
 270   G1RemSet* _g1rs;
 271   DirtyCardQueue* _into_cset_dcq;
 272 public:
 273   RefineRecordRefsIntoCSCardTableEntryClosure(G1CollectedHeap* g1h,
 274                                               DirtyCardQueue* into_cset_dcq) :
 275     _g1rs(g1h->g1_rem_set()), _into_cset_dcq(into_cset_dcq)
 276   {}
 277   bool do_card_ptr(jbyte* card_ptr, int worker_i) {
 278     // The only time we care about recording cards that
 279     // contain references that point into the collection set
 280     // is during RSet updating within an evacuation pause.
 281     // In this case worker_i should be the id of a GC worker thread.
 282     assert(SafepointSynchronize::is_at_safepoint(), "not during an evacuation pause");
 283     assert(worker_i < (int) (ParallelGCThreads == 0 ? 1 : ParallelGCThreads), "should be a GC worker");
 284 
 285     if (_g1rs->refine_card(card_ptr, worker_i, true)) {
 286       // 'card_ptr' contains references that point into the collection
 287       // set. We need to record the card in the DCQS
 288       // (G1CollectedHeap::into_cset_dirty_card_queue_set())
 289       // that's used for that purpose.
 290       //
 291       // Enqueue the card
 292       _into_cset_dcq->enqueue(card_ptr);
 293     }
 294     return true;
 295   }
 296 };
 297 
 298 void G1RemSet::updateRS(DirtyCardQueue* into_cset_dcq, int worker_i) {
 299   double start = os::elapsedTime();
 300   // Apply the given closure to all remaining log entries.
 301   RefineRecordRefsIntoCSCardTableEntryClosure into_cset_update_rs_cl(_g1, into_cset_dcq);
 302 
 303   _g1->iterate_dirty_card_closure(&into_cset_update_rs_cl, into_cset_dcq, false, worker_i);
 304 
 305   // Now there should be no dirty cards.
 306   if (G1RSLogCheckCardTable) {
 307     CountNonCleanMemRegionClosure cl(_g1);
 308     _ct_bs->mod_card_iterate(&cl);
 309     // XXX This isn't true any more: keeping cards of young regions
 310     // marked dirty broke it.  Need some reasonable fix.
 311     guarantee(cl.n() == 0, "Card table should be clean.");
 312   }
 313 
 314   _g1p->phase_times()->record_update_rs_time(worker_i, (os::elapsedTime() - start) * 1000.0);
 315 }
 316 
 317 void G1RemSet::cleanupHRRS() {
 318   HeapRegionRemSet::cleanup();
 319 }
 320 
 321 void G1RemSet::oops_into_collection_set_do(OopsInHeapRegionClosure* oc,
 322                                            CodeBlobToOopClosure* code_root_cl,
 323                                            int worker_i) {
 324 #if CARD_REPEAT_HISTO
 325   ct_freq_update_histo_and_reset();
 326 #endif
 327 
 328   // We cache the value of 'oc' closure into the appropriate slot in the
 329   // _cset_rs_update_cl for this worker
 330   assert(worker_i < (int)n_workers(), "sanity");
 331   _cset_rs_update_cl[worker_i] = oc;
 332 
 333   // A DirtyCardQueue that is used to hold cards containing references
 334   // that point into the collection set. This DCQ is associated with a
 335   // special DirtyCardQueueSet (see g1CollectedHeap.hpp).  Under normal
 336   // circumstances (i.e. the pause successfully completes), these cards
 337   // are just discarded (there's no need to update the RSets of regions
 338   // that were in the collection set - after the pause these regions
 339   // are wholly 'free' of live objects. In the event of an evacuation
 340   // failure the cards/buffers in this queue set are:
 341   // * passed to the DirtyCardQueueSet that is used to manage deferred
 342   //   RSet updates, or
 343   // * scanned for references that point into the collection set
 344   //   and the RSet of the corresponding region in the collection set
 345   //   is updated immediately.
 346   DirtyCardQueue into_cset_dcq(&_g1->into_cset_dirty_card_queue_set());
 347 
 348   assert((ParallelGCThreads > 0) || worker_i == 0, "invariant");
 349 
 350   // The two flags below were introduced temporarily to serialize
 351   // the updating and scanning of remembered sets. There are some
 352   // race conditions when these two operations are done in parallel
 353   // and they are causing failures. When we resolve said race
 354   // conditions, we'll revert back to parallel remembered set
 355   // updating and scanning. See CRs 6677707 and 6677708.
 356   if (G1UseParallelRSetUpdating || (worker_i == 0)) {
 357     updateRS(&into_cset_dcq, worker_i);
 358   } else {
 359     _g1p->phase_times()->record_update_rs_processed_buffers(worker_i, 0);
 360     _g1p->phase_times()->record_update_rs_time(worker_i, 0.0);
 361   }
 362   if (G1UseParallelRSetScanning || (worker_i == 0)) {
 363     scanRS(oc, code_root_cl, worker_i);
 364   } else {
 365     _g1p->phase_times()->record_scan_rs_time(worker_i, 0.0);
 366   }
 367 
 368   // We now clear the cached values of _cset_rs_update_cl for this worker
 369   _cset_rs_update_cl[worker_i] = NULL;
 370 }
 371 
 372 void G1RemSet::prepare_for_oops_into_collection_set_do() {
 373   cleanupHRRS();
 374   ConcurrentG1Refine* cg1r = _g1->concurrent_g1_refine();
 375   _g1->set_refine_cte_cl_concurrency(false);
 376   DirtyCardQueueSet& dcqs = JavaThread::dirty_card_queue_set();
 377   dcqs.concatenate_logs();
 378 
 379   if (G1CollectedHeap::use_parallel_gc_threads()) {
 380     // Don't set the number of workers here.  It will be set
 381     // when the task is run
 382     // _seq_task->set_n_termination((int)n_workers());
 383   }
 384   guarantee( _cards_scanned == NULL, "invariant" );
 385   _cards_scanned = NEW_C_HEAP_ARRAY(size_t, n_workers(), mtGC);
 386   for (uint i = 0; i < n_workers(); ++i) {
 387     _cards_scanned[i] = 0;
 388   }
 389   _total_cards_scanned = 0;
 390 }
 391 
 392 
 393 // This closure, applied to a DirtyCardQueueSet, is used to immediately
 394 // update the RSets for the regions in the CSet. For each card it iterates
 395 // through the oops which coincide with that card. It scans the reference
 396 // fields in each oop; when it finds an oop that points into the collection
 397 // set, the RSet for the region containing the referenced object is updated.
 398 class UpdateRSetCardTableEntryIntoCSetClosure: public CardTableEntryClosure {
 399   G1CollectedHeap* _g1;
 400   CardTableModRefBS* _ct_bs;
 401 public:
 402   UpdateRSetCardTableEntryIntoCSetClosure(G1CollectedHeap* g1,
 403                                           CardTableModRefBS* bs):
 404     _g1(g1), _ct_bs(bs)
 405   { }
 406 
 407   bool do_card_ptr(jbyte* card_ptr, int worker_i) {
 408     // Construct the region representing the card.
 409     HeapWord* start = _ct_bs->addr_for(card_ptr);
 410     // And find the region containing it.
 411     HeapRegion* r = _g1->heap_region_containing(start);
 412     assert(r != NULL, "unexpected null");
 413 
 414     // Scan oops in the card looking for references into the collection set
 415     // Don't use addr_for(card_ptr + 1) which can ask for
 416     // a card beyond the heap.  This is not safe without a perm
 417     // gen.
 418     HeapWord* end   = start + CardTableModRefBS::card_size_in_words;
 419     MemRegion scanRegion(start, end);
 420 
 421     UpdateRSetImmediate update_rs_cl(_g1->g1_rem_set());
 422     FilterIntoCSClosure update_rs_cset_oop_cl(NULL, _g1, &update_rs_cl);
 423     FilterOutOfRegionClosure filter_then_update_rs_cset_oop_cl(r, &update_rs_cset_oop_cl);
 424 
 425     // We can pass false as the "filter_young" parameter here as:
 426     // * we should be in a STW pause,
 427     // * the DCQS to which this closure is applied is used to hold
 428     //   references that point into the collection set from the prior
 429     //   RSet updating,
 430     // * the post-write barrier shouldn't be logging updates to young
 431     //   regions (but there is a situation where this can happen - see
 432     //   the comment in G1RemSet::refine_card() below -
 433     //   that should not be applicable here), and
 434     // * during actual RSet updating, the filtering of cards in young
 435     //   regions in HeapRegion::oops_on_card_seq_iterate_careful is
 436     //   employed.
 437     // As a result, when this closure is applied to "refs into cset"
 438     // DCQS, we shouldn't see any cards in young regions.
 439     update_rs_cl.set_region(r);
 440     HeapWord* stop_point =
 441       r->oops_on_card_seq_iterate_careful(scanRegion,
 442                                           &filter_then_update_rs_cset_oop_cl,
 443                                           false /* filter_young */,
 444                                           NULL  /* card_ptr */);
 445 
 446     // Since this is performed in the event of an evacuation failure, we
 447     // we shouldn't see a non-null stop point
 448     assert(stop_point == NULL, "saw an unallocated region");
 449     return true;
 450   }
 451 };
 452 
 453 void G1RemSet::cleanup_after_oops_into_collection_set_do() {
 454   guarantee( _cards_scanned != NULL, "invariant" );
 455   _total_cards_scanned = 0;
 456   for (uint i = 0; i < n_workers(); ++i) {
 457     _total_cards_scanned += _cards_scanned[i];
 458   }
 459   FREE_C_HEAP_ARRAY(size_t, _cards_scanned, mtGC);
 460   _cards_scanned = NULL;
 461   // Cleanup after copy
 462   _g1->set_refine_cte_cl_concurrency(true);
 463   // Set all cards back to clean.
 464   _g1->cleanUpCardTable();
 465 
 466   DirtyCardQueueSet& into_cset_dcqs = _g1->into_cset_dirty_card_queue_set();
 467   int into_cset_n_buffers = into_cset_dcqs.completed_buffers_num();
 468 
 469   if (_g1->evacuation_failed()) {
 470     // Restore remembered sets for the regions pointing into the collection set.
 471 
 472     if (G1DeferredRSUpdate) {
 473       // If deferred RS updates are enabled then we just need to transfer
 474       // the completed buffers from (a) the DirtyCardQueueSet used to hold
 475       // cards that contain references that point into the collection set
 476       // to (b) the DCQS used to hold the deferred RS updates
 477       _g1->dirty_card_queue_set().merge_bufferlists(&into_cset_dcqs);
 478     } else {
 479 
 480       CardTableModRefBS* bs = (CardTableModRefBS*)_g1->barrier_set();
 481       UpdateRSetCardTableEntryIntoCSetClosure update_rs_cset_immediate(_g1, bs);
 482 
 483       int n_completed_buffers = 0;
 484       while (into_cset_dcqs.apply_closure_to_completed_buffer(&update_rs_cset_immediate,
 485                                                     0, 0, true)) {
 486         n_completed_buffers++;
 487       }
 488       assert(n_completed_buffers == into_cset_n_buffers, "missed some buffers");
 489     }
 490   }
 491 
 492   // Free any completed buffers in the DirtyCardQueueSet used to hold cards
 493   // which contain references that point into the collection.
 494   _g1->into_cset_dirty_card_queue_set().clear();
 495   assert(_g1->into_cset_dirty_card_queue_set().completed_buffers_num() == 0,
 496          "all buffers should be freed");
 497   _g1->into_cset_dirty_card_queue_set().clear_n_completed_buffers();
 498 }
 499 
 500 class ScrubRSClosure: public HeapRegionClosure {
 501   G1CollectedHeap* _g1h;
 502   BitMap* _region_bm;
 503   BitMap* _card_bm;
 504   CardTableModRefBS* _ctbs;
 505 public:
 506   ScrubRSClosure(BitMap* region_bm, BitMap* card_bm) :
 507     _g1h(G1CollectedHeap::heap()),
 508     _region_bm(region_bm), _card_bm(card_bm),
 509     _ctbs(NULL)
 510   {
 511     ModRefBarrierSet* bs = _g1h->mr_bs();
 512     guarantee(bs->is_a(BarrierSet::CardTableModRef), "Precondition");
 513     _ctbs = (CardTableModRefBS*)bs;
 514   }
 515 
 516   bool doHeapRegion(HeapRegion* r) {
 517     if (!r->continuesHumongous()) {
 518       r->rem_set()->scrub(_ctbs, _region_bm, _card_bm);
 519     }
 520     return false;
 521   }
 522 };
 523 
 524 void G1RemSet::scrub(BitMap* region_bm, BitMap* card_bm) {
 525   ScrubRSClosure scrub_cl(region_bm, card_bm);
 526   _g1->heap_region_iterate(&scrub_cl);
 527 }
 528 
 529 void G1RemSet::scrub_par(BitMap* region_bm, BitMap* card_bm,
 530                                 uint worker_num, int claim_val) {
 531   ScrubRSClosure scrub_cl(region_bm, card_bm);
 532   _g1->heap_region_par_iterate_chunked(&scrub_cl,
 533                                        worker_num,
 534                                        n_workers(),
 535                                        claim_val);
 536 }
 537 
 538 G1TriggerClosure::G1TriggerClosure() :
 539   _triggered(false) { }
 540 
 541 G1InvokeIfNotTriggeredClosure::G1InvokeIfNotTriggeredClosure(G1TriggerClosure* t_cl,
 542                                                              OopClosure* oop_cl)  :
 543   _trigger_cl(t_cl), _oop_cl(oop_cl) { }
 544 
 545 G1Mux2Closure::G1Mux2Closure(OopClosure *c1, OopClosure *c2) :
 546   _c1(c1), _c2(c2) { }
 547 
 548 G1UpdateRSOrPushRefOopClosure::
 549 G1UpdateRSOrPushRefOopClosure(G1CollectedHeap* g1h,
 550                               G1RemSet* rs,
 551                               OopsInHeapRegionClosure* push_ref_cl,
 552                               bool record_refs_into_cset,
 553                               int worker_i) :
 554   _g1(g1h), _g1_rem_set(rs), _from(NULL),
 555   _record_refs_into_cset(record_refs_into_cset),
 556   _push_ref_cl(push_ref_cl), _worker_i(worker_i) { }
 557 
 558 // Returns true if the given card contains references that point
 559 // into the collection set, if we're checking for such references;
 560 // false otherwise.
 561 
 562 bool G1RemSet::refine_card(jbyte* card_ptr, int worker_i,
 563                            bool check_for_refs_into_cset) {
 564 
 565   // If the card is no longer dirty, nothing to do.
 566   if (*card_ptr != CardTableModRefBS::dirty_card_val()) {
 567     // No need to return that this card contains refs that point
 568     // into the collection set.
 569     return false;
 570   }
 571 
 572   // Construct the region representing the card.
 573   HeapWord* start = _ct_bs->addr_for(card_ptr);
 574   // And find the region containing it.
 575   HeapRegion* r = _g1->heap_region_containing(start);
 576   if (r == NULL) {
 577     guarantee(_g1->is_in_permanent(start), "Or else where?");
 578     // Again no need to return that this card contains refs that
 579     // point into the collection set.
 580     return false;  // Not in the G1 heap (might be in perm, for example.)
 581   }
 582 
 583   // Why do we have to check here whether a card is on a young region,
 584   // given that we dirty young regions and, as a result, the
 585   // post-barrier is supposed to filter them out and never to enqueue
 586   // them? When we allocate a new region as the "allocation region" we
 587   // actually dirty its cards after we release the lock, since card
 588   // dirtying while holding the lock was a performance bottleneck. So,
 589   // as a result, it is possible for other threads to actually
 590   // allocate objects in the region (after the acquire the lock)
 591   // before all the cards on the region are dirtied. This is unlikely,
 592   // and it doesn't happen often, but it can happen. So, the extra
 593   // check below filters out those cards.
 594   if (r->is_young()) {
 595     return false;
 596   }
 597 
 598   // While we are processing RSet buffers during the collection, we
 599   // actually don't want to scan any cards on the collection set,
 600   // since we don't want to update remebered sets with entries that
 601   // point into the collection set, given that live objects from the
 602   // collection set are about to move and such entries will be stale
 603   // very soon. This change also deals with a reliability issue which
 604   // involves scanning a card in the collection set and coming across
 605   // an array that was being chunked and looking malformed. Note,
 606   // however, that if evacuation fails, we have to scan any objects
 607   // that were not moved and create any missing entries.
 608   if (r->in_collection_set()) {
 609     return false;
 610   }
 611 
 612   // The result from the hot card cache insert call is either:
 613   //   * pointer to the current card
 614   //     (implying that the current card is not 'hot'),
 615   //   * null
 616   //     (meaning we had inserted the card ptr into the "hot" card cache,
 617   //     which had some headroom),
 618   //   * a pointer to a "hot" card that was evicted from the "hot" cache.
 619   //
 620 
 621   G1HotCardCache* hot_card_cache = _cg1r->hot_card_cache();
 622   if (hot_card_cache->use_cache()) {
 623     assert(!check_for_refs_into_cset, "sanity");
 624     assert(!SafepointSynchronize::is_at_safepoint(), "sanity");
 625 
 626     card_ptr = hot_card_cache->insert(card_ptr);
 627     if (card_ptr == NULL) {
 628       // There was no eviction. Nothing to do.
 629       return false;
 630     }
 631 
 632     start = _ct_bs->addr_for(card_ptr);
 633     r = _g1->heap_region_containing(start);
 634     if (r == NULL) {
 635       guarantee(_g1->is_in_permanent(start), "Or else where?");
 636       // Not in the G1 heap
 637       return false;
 638     }
 639 
 640     // Checking whether the region we got back from the cache
 641     // is young here is inappropriate. The region could have been
 642     // freed, reallocated and tagged as young while in the cache.
 643     // Hence we could see its young type change at any time.
 644   }
 645 
 646   // Don't use addr_for(card_ptr + 1) which can ask for
 647   // a card beyond the heap.  This is not safe without a perm
 648   // gen at the upper end of the heap.
 649   HeapWord* end   = start + CardTableModRefBS::card_size_in_words;
 650   MemRegion dirtyRegion(start, end);
 651 
 652 #if CARD_REPEAT_HISTO
 653   init_ct_freq_table(_g1->max_capacity());
 654   ct_freq_note_card(_ct_bs->index_for(start));
 655 #endif
 656 
 657   OopsInHeapRegionClosure* oops_in_heap_closure = NULL;
 658   if (check_for_refs_into_cset) {
 659     // ConcurrentG1RefineThreads have worker numbers larger than what
 660     // _cset_rs_update_cl[] is set up to handle. But those threads should
 661     // only be active outside of a collection which means that when they
 662     // reach here they should have check_for_refs_into_cset == false.
 663     assert((size_t)worker_i < n_workers(), "index of worker larger than _cset_rs_update_cl[].length");
 664     oops_in_heap_closure = _cset_rs_update_cl[worker_i];
 665   }
 666   G1UpdateRSOrPushRefOopClosure update_rs_oop_cl(_g1,
 667                                                  _g1->g1_rem_set(),
 668                                                  oops_in_heap_closure,
 669                                                  check_for_refs_into_cset,
 670                                                  worker_i);
 671   update_rs_oop_cl.set_from(r);
 672 
 673   G1TriggerClosure trigger_cl;
 674   FilterIntoCSClosure into_cs_cl(NULL, _g1, &trigger_cl);
 675   G1InvokeIfNotTriggeredClosure invoke_cl(&trigger_cl, &into_cs_cl);
 676   G1Mux2Closure mux(&invoke_cl, &update_rs_oop_cl);
 677 
 678   FilterOutOfRegionClosure filter_then_update_rs_oop_cl(r,
 679                         (check_for_refs_into_cset ?
 680                                 (OopClosure*)&mux :
 681                                 (OopClosure*)&update_rs_oop_cl));
 682 
 683   // The region for the current card may be a young region. The
 684   // current card may have been a card that was evicted from the
 685   // card cache. When the card was inserted into the cache, we had
 686   // determined that its region was non-young. While in the cache,
 687   // the region may have been freed during a cleanup pause, reallocated
 688   // and tagged as young.
 689   //
 690   // We wish to filter out cards for such a region but the current
 691   // thread, if we're running concurrently, may "see" the young type
 692   // change at any time (so an earlier "is_young" check may pass or
 693   // fail arbitrarily). We tell the iteration code to perform this
 694   // filtering when it has been determined that there has been an actual
 695   // allocation in this region and making it safe to check the young type.
 696   bool filter_young = true;
 697 
 698   HeapWord* stop_point =
 699     r->oops_on_card_seq_iterate_careful(dirtyRegion,
 700                                         &filter_then_update_rs_oop_cl,
 701                                         filter_young,
 702                                         card_ptr);
 703 
 704   // If stop_point is non-null, then we encountered an unallocated region
 705   // (perhaps the unfilled portion of a TLAB.)  For now, we'll dirty the
 706   // card and re-enqueue: if we put off the card until a GC pause, then the
 707   // unallocated portion will be filled in.  Alternatively, we might try
 708   // the full complexity of the technique used in "regular" precleaning.
 709   if (stop_point != NULL) {
 710     // The card might have gotten re-dirtied and re-enqueued while we
 711     // worked.  (In fact, it's pretty likely.)
 712     if (*card_ptr != CardTableModRefBS::dirty_card_val()) {
 713       *card_ptr = CardTableModRefBS::dirty_card_val();
 714       MutexLockerEx x(Shared_DirtyCardQ_lock,
 715                       Mutex::_no_safepoint_check_flag);
 716       DirtyCardQueue* sdcq =
 717         JavaThread::dirty_card_queue_set().shared_dirty_card_queue();
 718       sdcq->enqueue(card_ptr);
 719     }
 720   } else {
 721     _conc_refine_cards++;
 722   }
 723 
 724   // This gets set to true if the card being refined has
 725   // references that point into the collection set.
 726   bool has_refs_into_cset = trigger_cl.triggered();
 727 
 728   // We should only be detecting that the card contains references
 729   // that point into the collection set if the current thread is
 730   // a GC worker thread.
 731   assert(!has_refs_into_cset || SafepointSynchronize::is_at_safepoint(),
 732            "invalid result at non safepoint");
 733 
 734   return has_refs_into_cset;
 735 }
 736 
 737 void G1RemSet::print_periodic_summary_info(const char* header) {
 738   G1RemSetSummary current;
 739   current.initialize(this, n_workers());
 740 
 741   _prev_period_summary.subtract_from(&current);
 742   print_summary_info(&_prev_period_summary, header);
 743 
 744   _prev_period_summary.set(&current);
 745 }
 746 
 747 void G1RemSet::print_summary_info() {
 748   G1RemSetSummary current;
 749   current.initialize(this, n_workers());
 750 
 751   print_summary_info(&current, " Cumulative RS summary");
 752 }
 753 
 754 void G1RemSet::print_summary_info(G1RemSetSummary * summary, const char * header) {
 755   assert(summary != NULL, "just checking");
 756 
 757   if (header != NULL) {
 758     gclog_or_tty->print_cr("%s", header);
 759   }
 760 
 761 #if CARD_REPEAT_HISTO
 762   gclog_or_tty->print_cr("\nG1 card_repeat count histogram: ");
 763   gclog_or_tty->print_cr("  # of repeats --> # of cards with that number.");
 764   card_repeat_count.print_on(gclog_or_tty);
 765 #endif
 766 
 767   summary->print_on(gclog_or_tty);
 768 }
 769 
 770 void G1RemSet::prepare_for_verify() {
 771   if (G1HRRSFlushLogBuffersOnVerify &&
 772       (VerifyBeforeGC || VerifyAfterGC)
 773       &&  (!_g1->full_collection() || G1VerifyRSetsDuringFullGC)) {
 774     cleanupHRRS();
 775     _g1->set_refine_cte_cl_concurrency(false);
 776     if (SafepointSynchronize::is_at_safepoint()) {
 777       DirtyCardQueueSet& dcqs = JavaThread::dirty_card_queue_set();
 778       dcqs.concatenate_logs();
 779     }
 780 
 781     G1HotCardCache* hot_card_cache = _cg1r->hot_card_cache();
 782     bool use_hot_card_cache = hot_card_cache->use_cache();
 783     hot_card_cache->set_use_cache(false);
 784 
 785     DirtyCardQueue into_cset_dcq(&_g1->into_cset_dirty_card_queue_set());
 786     updateRS(&into_cset_dcq, 0);
 787     _g1->into_cset_dirty_card_queue_set().clear();
 788 
 789     hot_card_cache->set_use_cache(use_hot_card_cache);
 790     assert(JavaThread::dirty_card_queue_set().completed_buffers_num() == 0, "All should be consumed");
 791   }
 792 }