1 /*
   2  * Copyright 2001-2008 Sun Microsystems, Inc.  All Rights Reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  20  * CA 95054 USA or visit www.sun.com if you need additional information or
  21  * have any questions.
  22  *
  23  */
  24 
  25 # include "incls/_precompiled.incl"
  26 # include "incls/_concurrentMarkSweepGeneration.cpp.incl"
  27 
  28 // statics
  29 CMSCollector* ConcurrentMarkSweepGeneration::_collector = NULL;
  30 bool          CMSCollector::_full_gc_requested          = false;
  31 
  32 //////////////////////////////////////////////////////////////////
  33 // In support of CMS/VM thread synchronization
  34 //////////////////////////////////////////////////////////////////
  35 // We split use of the CGC_lock into 2 "levels".
  36 // The low-level locking is of the usual CGC_lock monitor. We introduce
  37 // a higher level "token" (hereafter "CMS token") built on top of the
  38 // low level monitor (hereafter "CGC lock").
  39 // The token-passing protocol gives priority to the VM thread. The
  40 // CMS-lock doesn't provide any fairness guarantees, but clients
  41 // should ensure that it is only held for very short, bounded
  42 // durations.
  43 //
  44 // When either of the CMS thread or the VM thread is involved in
  45 // collection operations during which it does not want the other
  46 // thread to interfere, it obtains the CMS token.
  47 //
  48 // If either thread tries to get the token while the other has
  49 // it, that thread waits. However, if the VM thread and CMS thread
  50 // both want the token, then the VM thread gets priority while the
  51 // CMS thread waits. This ensures, for instance, that the "concurrent"
  52 // phases of the CMS thread's work do not block out the VM thread
  53 // for long periods of time as the CMS thread continues to hog
  54 // the token. (See bug 4616232).
  55 //
  56 // The baton-passing functions are, however, controlled by the
  57 // flags _foregroundGCShouldWait and _foregroundGCIsActive,
  58 // and here the low-level CMS lock, not the high level token,
  59 // ensures mutual exclusion.
  60 //
  61 // Two important conditions that we have to satisfy:
  62 // 1. if a thread does a low-level wait on the CMS lock, then it
  63 //    relinquishes the CMS token if it were holding that token
  64 //    when it acquired the low-level CMS lock.
  65 // 2. any low-level notifications on the low-level lock
  66 //    should only be sent when a thread has relinquished the token.
  67 //
  68 // In the absence of either property, we'd have potential deadlock.
  69 //
  70 // We protect each of the CMS (concurrent and sequential) phases
  71 // with the CMS _token_, not the CMS _lock_.
  72 //
  73 // The only code protected by CMS lock is the token acquisition code
  74 // itself, see ConcurrentMarkSweepThread::[de]synchronize(), and the
  75 // baton-passing code.
  76 //
  77 // Unfortunately, i couldn't come up with a good abstraction to factor and
  78 // hide the naked CGC_lock manipulation in the baton-passing code
  79 // further below. That's something we should try to do. Also, the proof
  80 // of correctness of this 2-level locking scheme is far from obvious,
  81 // and potentially quite slippery. We have an uneasy supsicion, for instance,
  82 // that there may be a theoretical possibility of delay/starvation in the
  83 // low-level lock/wait/notify scheme used for the baton-passing because of
  84 // potential intereference with the priority scheme embodied in the
  85 // CMS-token-passing protocol. See related comments at a CGC_lock->wait()
  86 // invocation further below and marked with "XXX 20011219YSR".
  87 // Indeed, as we note elsewhere, this may become yet more slippery
  88 // in the presence of multiple CMS and/or multiple VM threads. XXX
  89 
  90 class CMSTokenSync: public StackObj {
  91  private:
  92   bool _is_cms_thread;
  93  public:
  94   CMSTokenSync(bool is_cms_thread):
  95     _is_cms_thread(is_cms_thread) {
  96     assert(is_cms_thread == Thread::current()->is_ConcurrentGC_thread(),
  97            "Incorrect argument to constructor");
  98     ConcurrentMarkSweepThread::synchronize(_is_cms_thread);
  99   }
 100 
 101   ~CMSTokenSync() {
 102     assert(_is_cms_thread ?
 103              ConcurrentMarkSweepThread::cms_thread_has_cms_token() :
 104              ConcurrentMarkSweepThread::vm_thread_has_cms_token(),
 105           "Incorrect state");
 106     ConcurrentMarkSweepThread::desynchronize(_is_cms_thread);
 107   }
 108 };
 109 
 110 // Convenience class that does a CMSTokenSync, and then acquires
 111 // upto three locks.
 112 class CMSTokenSyncWithLocks: public CMSTokenSync {
 113  private:
 114   // Note: locks are acquired in textual declaration order
 115   // and released in the opposite order
 116   MutexLockerEx _locker1, _locker2, _locker3;
 117  public:
 118   CMSTokenSyncWithLocks(bool is_cms_thread, Mutex* mutex1,
 119                         Mutex* mutex2 = NULL, Mutex* mutex3 = NULL):
 120     CMSTokenSync(is_cms_thread),
 121     _locker1(mutex1, Mutex::_no_safepoint_check_flag),
 122     _locker2(mutex2, Mutex::_no_safepoint_check_flag),
 123     _locker3(mutex3, Mutex::_no_safepoint_check_flag)
 124   { }
 125 };
 126 
 127 
 128 // Wrapper class to temporarily disable icms during a foreground cms collection.
 129 class ICMSDisabler: public StackObj {
 130  public:
 131   // The ctor disables icms and wakes up the thread so it notices the change;
 132   // the dtor re-enables icms.  Note that the CMSCollector methods will check
 133   // CMSIncrementalMode.
 134   ICMSDisabler()  { CMSCollector::disable_icms(); CMSCollector::start_icms(); }
 135   ~ICMSDisabler() { CMSCollector::enable_icms(); }
 136 };
 137 
 138 //////////////////////////////////////////////////////////////////
 139 //  Concurrent Mark-Sweep Generation /////////////////////////////
 140 //////////////////////////////////////////////////////////////////
 141 
 142 NOT_PRODUCT(CompactibleFreeListSpace* debug_cms_space;)
 143 
 144 // This struct contains per-thread things necessary to support parallel
 145 // young-gen collection.
 146 class CMSParGCThreadState: public CHeapObj {
 147  public:
 148   CFLS_LAB lab;
 149   PromotionInfo promo;
 150 
 151   // Constructor.
 152   CMSParGCThreadState(CompactibleFreeListSpace* cfls) : lab(cfls) {
 153     promo.setSpace(cfls);
 154   }
 155 };
 156 
 157 ConcurrentMarkSweepGeneration::ConcurrentMarkSweepGeneration(
 158      ReservedSpace rs, size_t initial_byte_size, int level,
 159      CardTableRS* ct, bool use_adaptive_freelists,
 160      FreeBlockDictionary::DictionaryChoice dictionaryChoice) :
 161   CardGeneration(rs, initial_byte_size, level, ct),
 162   _dilatation_factor(((double)MinChunkSize)/((double)(oopDesc::header_size()))),
 163   _debug_collection_type(Concurrent_collection_type)
 164 {
 165   HeapWord* bottom = (HeapWord*) _virtual_space.low();
 166   HeapWord* end    = (HeapWord*) _virtual_space.high();
 167 
 168   _direct_allocated_words = 0;
 169   NOT_PRODUCT(
 170     _numObjectsPromoted = 0;
 171     _numWordsPromoted = 0;
 172     _numObjectsAllocated = 0;
 173     _numWordsAllocated = 0;
 174   )
 175 
 176   _cmsSpace = new CompactibleFreeListSpace(_bts, MemRegion(bottom, end),
 177                                            use_adaptive_freelists,
 178                                            dictionaryChoice);
 179   NOT_PRODUCT(debug_cms_space = _cmsSpace;)
 180   if (_cmsSpace == NULL) {
 181     vm_exit_during_initialization(
 182       "CompactibleFreeListSpace allocation failure");
 183   }
 184   _cmsSpace->_gen = this;
 185 
 186   _gc_stats = new CMSGCStats();
 187 
 188   // Verify the assumption that FreeChunk::_prev and OopDesc::_klass
 189   // offsets match. The ability to tell free chunks from objects
 190   // depends on this property.
 191   debug_only(
 192     FreeChunk* junk = NULL;
 193     assert(UseCompressedOops ||
 194            junk->prev_addr() == (void*)(oop(junk)->klass_addr()),
 195            "Offset of FreeChunk::_prev within FreeChunk must match"
 196            "  that of OopDesc::_klass within OopDesc");
 197   )
 198   if (ParallelGCThreads > 0) {
 199     typedef CMSParGCThreadState* CMSParGCThreadStatePtr;
 200     _par_gc_thread_states =
 201       NEW_C_HEAP_ARRAY(CMSParGCThreadStatePtr, ParallelGCThreads);
 202     if (_par_gc_thread_states == NULL) {
 203       vm_exit_during_initialization("Could not allocate par gc structs");
 204     }
 205     for (uint i = 0; i < ParallelGCThreads; i++) {
 206       _par_gc_thread_states[i] = new CMSParGCThreadState(cmsSpace());
 207       if (_par_gc_thread_states[i] == NULL) {
 208         vm_exit_during_initialization("Could not allocate par gc structs");
 209       }
 210     }
 211   } else {
 212     _par_gc_thread_states = NULL;
 213   }
 214   _incremental_collection_failed = false;
 215   // The "dilatation_factor" is the expansion that can occur on
 216   // account of the fact that the minimum object size in the CMS
 217   // generation may be larger than that in, say, a contiguous young
 218   //  generation.
 219   // Ideally, in the calculation below, we'd compute the dilatation
 220   // factor as: MinChunkSize/(promoting_gen's min object size)
 221   // Since we do not have such a general query interface for the
 222   // promoting generation, we'll instead just use the mimimum
 223   // object size (which today is a header's worth of space);
 224   // note that all arithmetic is in units of HeapWords.
 225   assert(MinChunkSize >= oopDesc::header_size(), "just checking");
 226   assert(_dilatation_factor >= 1.0, "from previous assert");
 227 }
 228 
 229 
 230 // The field "_initiating_occupancy" represents the occupancy percentage
 231 // at which we trigger a new collection cycle.  Unless explicitly specified
 232 // via CMSInitiating[Perm]OccupancyFraction (argument "io" below), it
 233 // is calculated by:
 234 //
 235 //   Let "f" be MinHeapFreeRatio in
 236 //
 237 //    _intiating_occupancy = 100-f +
 238 //                           f * (CMSTrigger[Perm]Ratio/100)
 239 //   where CMSTrigger[Perm]Ratio is the argument "tr" below.
 240 //
 241 // That is, if we assume the heap is at its desired maximum occupancy at the
 242 // end of a collection, we let CMSTrigger[Perm]Ratio of the (purported) free
 243 // space be allocated before initiating a new collection cycle.
 244 //
 245 void ConcurrentMarkSweepGeneration::init_initiating_occupancy(intx io, intx tr) {
 246   assert(io <= 100 && tr >= 0 && tr <= 100, "Check the arguments");
 247   if (io >= 0) {
 248     _initiating_occupancy = (double)io / 100.0;
 249   } else {
 250     _initiating_occupancy = ((100 - MinHeapFreeRatio) +
 251                              (double)(tr * MinHeapFreeRatio) / 100.0)
 252                             / 100.0;
 253   }
 254 }
 255 
 256 
 257 void ConcurrentMarkSweepGeneration::ref_processor_init() {
 258   assert(collector() != NULL, "no collector");
 259   collector()->ref_processor_init();
 260 }
 261 
 262 void CMSCollector::ref_processor_init() {
 263   if (_ref_processor == NULL) {
 264     // Allocate and initialize a reference processor
 265     _ref_processor = ReferenceProcessor::create_ref_processor(
 266         _span,                               // span
 267         _cmsGen->refs_discovery_is_atomic(), // atomic_discovery
 268         _cmsGen->refs_discovery_is_mt(),     // mt_discovery
 269         &_is_alive_closure,
 270         ParallelGCThreads,
 271         ParallelRefProcEnabled);
 272     // Initialize the _ref_processor field of CMSGen
 273     _cmsGen->set_ref_processor(_ref_processor);
 274 
 275     // Allocate a dummy ref processor for perm gen.
 276     ReferenceProcessor* rp2 = new ReferenceProcessor();
 277     if (rp2 == NULL) {
 278       vm_exit_during_initialization("Could not allocate ReferenceProcessor object");
 279     }
 280     _permGen->set_ref_processor(rp2);
 281   }
 282 }
 283 
 284 CMSAdaptiveSizePolicy* CMSCollector::size_policy() {
 285   GenCollectedHeap* gch = GenCollectedHeap::heap();
 286   assert(gch->kind() == CollectedHeap::GenCollectedHeap,
 287     "Wrong type of heap");
 288   CMSAdaptiveSizePolicy* sp = (CMSAdaptiveSizePolicy*)
 289     gch->gen_policy()->size_policy();
 290   assert(sp->is_gc_cms_adaptive_size_policy(),
 291     "Wrong type of size policy");
 292   return sp;
 293 }
 294 
 295 CMSGCAdaptivePolicyCounters* CMSCollector::gc_adaptive_policy_counters() {
 296   CMSGCAdaptivePolicyCounters* results =
 297     (CMSGCAdaptivePolicyCounters*) collector_policy()->counters();
 298   assert(
 299     results->kind() == GCPolicyCounters::CMSGCAdaptivePolicyCountersKind,
 300     "Wrong gc policy counter kind");
 301   return results;
 302 }
 303 
 304 
 305 void ConcurrentMarkSweepGeneration::initialize_performance_counters() {
 306 
 307   const char* gen_name = "old";
 308 
 309   // Generation Counters - generation 1, 1 subspace
 310   _gen_counters = new GenerationCounters(gen_name, 1, 1, &_virtual_space);
 311 
 312   _space_counters = new GSpaceCounters(gen_name, 0,
 313                                        _virtual_space.reserved_size(),
 314                                        this, _gen_counters);
 315 }
 316 
 317 CMSStats::CMSStats(ConcurrentMarkSweepGeneration* cms_gen, unsigned int alpha):
 318   _cms_gen(cms_gen)
 319 {
 320   assert(alpha <= 100, "bad value");
 321   _saved_alpha = alpha;
 322 
 323   // Initialize the alphas to the bootstrap value of 100.
 324   _gc0_alpha = _cms_alpha = 100;
 325 
 326   _cms_begin_time.update();
 327   _cms_end_time.update();
 328 
 329   _gc0_duration = 0.0;
 330   _gc0_period = 0.0;
 331   _gc0_promoted = 0;
 332 
 333   _cms_duration = 0.0;
 334   _cms_period = 0.0;
 335   _cms_allocated = 0;
 336 
 337   _cms_used_at_gc0_begin = 0;
 338   _cms_used_at_gc0_end = 0;
 339   _allow_duty_cycle_reduction = false;
 340   _valid_bits = 0;
 341   _icms_duty_cycle = CMSIncrementalDutyCycle;
 342 }
 343 
 344 // If promotion failure handling is on use
 345 // the padded average size of the promotion for each
 346 // young generation collection.
 347 double CMSStats::time_until_cms_gen_full() const {
 348   size_t cms_free = _cms_gen->cmsSpace()->free();
 349   GenCollectedHeap* gch = GenCollectedHeap::heap();
 350   size_t expected_promotion = gch->get_gen(0)->capacity();
 351   if (HandlePromotionFailure) {
 352     expected_promotion = MIN2(
 353         (size_t) _cms_gen->gc_stats()->avg_promoted()->padded_average(),
 354         expected_promotion);
 355   }
 356   if (cms_free > expected_promotion) {
 357     // Start a cms collection if there isn't enough space to promote
 358     // for the next minor collection.  Use the padded average as
 359     // a safety factor.
 360     cms_free -= expected_promotion;
 361 
 362     // Adjust by the safety factor.
 363     double cms_free_dbl = (double)cms_free;
 364     cms_free_dbl = cms_free_dbl * (100.0 - CMSIncrementalSafetyFactor) / 100.0;
 365 
 366     if (PrintGCDetails && Verbose) {
 367       gclog_or_tty->print_cr("CMSStats::time_until_cms_gen_full: cms_free "
 368         SIZE_FORMAT " expected_promotion " SIZE_FORMAT,
 369         cms_free, expected_promotion);
 370       gclog_or_tty->print_cr("  cms_free_dbl %f cms_consumption_rate %f",
 371         cms_free_dbl, cms_consumption_rate() + 1.0);
 372     }
 373     // Add 1 in case the consumption rate goes to zero.
 374     return cms_free_dbl / (cms_consumption_rate() + 1.0);
 375   }
 376   return 0.0;
 377 }
 378 
 379 // Compare the duration of the cms collection to the
 380 // time remaining before the cms generation is empty.
 381 // Note that the time from the start of the cms collection
 382 // to the start of the cms sweep (less than the total
 383 // duration of the cms collection) can be used.  This
 384 // has been tried and some applications experienced
 385 // promotion failures early in execution.  This was
 386 // possibly because the averages were not accurate
 387 // enough at the beginning.
 388 double CMSStats::time_until_cms_start() const {
 389   // We add "gc0_period" to the "work" calculation
 390   // below because this query is done (mostly) at the
 391   // end of a scavenge, so we need to conservatively
 392   // account for that much possible delay
 393   // in the query so as to avoid concurrent mode failures
 394   // due to starting the collection just a wee bit too
 395   // late.
 396   double work = cms_duration() + gc0_period();
 397   double deadline = time_until_cms_gen_full();
 398   if (work > deadline) {
 399     if (Verbose && PrintGCDetails) {
 400       gclog_or_tty->print(
 401         " CMSCollector: collect because of anticipated promotion "
 402         "before full %3.7f + %3.7f > %3.7f ", cms_duration(),
 403         gc0_period(), time_until_cms_gen_full());
 404     }
 405     return 0.0;
 406   }
 407   return work - deadline;
 408 }
 409 
 410 // Return a duty cycle based on old_duty_cycle and new_duty_cycle, limiting the
 411 // amount of change to prevent wild oscillation.
 412 unsigned int CMSStats::icms_damped_duty_cycle(unsigned int old_duty_cycle,
 413                                               unsigned int new_duty_cycle) {
 414   assert(old_duty_cycle <= 100, "bad input value");
 415   assert(new_duty_cycle <= 100, "bad input value");
 416 
 417   // Note:  use subtraction with caution since it may underflow (values are
 418   // unsigned).  Addition is safe since we're in the range 0-100.
 419   unsigned int damped_duty_cycle = new_duty_cycle;
 420   if (new_duty_cycle < old_duty_cycle) {
 421     const unsigned int largest_delta = MAX2(old_duty_cycle / 4, 5U);
 422     if (new_duty_cycle + largest_delta < old_duty_cycle) {
 423       damped_duty_cycle = old_duty_cycle - largest_delta;
 424     }
 425   } else if (new_duty_cycle > old_duty_cycle) {
 426     const unsigned int largest_delta = MAX2(old_duty_cycle / 4, 15U);
 427     if (new_duty_cycle > old_duty_cycle + largest_delta) {
 428       damped_duty_cycle = MIN2(old_duty_cycle + largest_delta, 100U);
 429     }
 430   }
 431   assert(damped_duty_cycle <= 100, "invalid duty cycle computed");
 432 
 433   if (CMSTraceIncrementalPacing) {
 434     gclog_or_tty->print(" [icms_damped_duty_cycle(%d,%d) = %d] ",
 435                            old_duty_cycle, new_duty_cycle, damped_duty_cycle);
 436   }
 437   return damped_duty_cycle;
 438 }
 439 
 440 unsigned int CMSStats::icms_update_duty_cycle_impl() {
 441   assert(CMSIncrementalPacing && valid(),
 442          "should be handled in icms_update_duty_cycle()");
 443 
 444   double cms_time_so_far = cms_timer().seconds();
 445   double scaled_duration = cms_duration_per_mb() * _cms_used_at_gc0_end / M;
 446   double scaled_duration_remaining = fabsd(scaled_duration - cms_time_so_far);
 447 
 448   // Avoid division by 0.
 449   double time_until_full = MAX2(time_until_cms_gen_full(), 0.01);
 450   double duty_cycle_dbl = 100.0 * scaled_duration_remaining / time_until_full;
 451 
 452   unsigned int new_duty_cycle = MIN2((unsigned int)duty_cycle_dbl, 100U);
 453   if (new_duty_cycle > _icms_duty_cycle) {
 454     // Avoid very small duty cycles (1 or 2); 0 is allowed.
 455     if (new_duty_cycle > 2) {
 456       _icms_duty_cycle = icms_damped_duty_cycle(_icms_duty_cycle,
 457                                                 new_duty_cycle);
 458     }
 459   } else if (_allow_duty_cycle_reduction) {
 460     // The duty cycle is reduced only once per cms cycle (see record_cms_end()).
 461     new_duty_cycle = icms_damped_duty_cycle(_icms_duty_cycle, new_duty_cycle);
 462     // Respect the minimum duty cycle.
 463     unsigned int min_duty_cycle = (unsigned int)CMSIncrementalDutyCycleMin;
 464     _icms_duty_cycle = MAX2(new_duty_cycle, min_duty_cycle);
 465   }
 466 
 467   if (PrintGCDetails || CMSTraceIncrementalPacing) {
 468     gclog_or_tty->print(" icms_dc=%d ", _icms_duty_cycle);
 469   }
 470 
 471   _allow_duty_cycle_reduction = false;
 472   return _icms_duty_cycle;
 473 }
 474 
 475 #ifndef PRODUCT
 476 void CMSStats::print_on(outputStream *st) const {
 477   st->print(" gc0_alpha=%d,cms_alpha=%d", _gc0_alpha, _cms_alpha);
 478   st->print(",gc0_dur=%g,gc0_per=%g,gc0_promo=" SIZE_FORMAT,
 479                gc0_duration(), gc0_period(), gc0_promoted());
 480   st->print(",cms_dur=%g,cms_dur_per_mb=%g,cms_per=%g,cms_alloc=" SIZE_FORMAT,
 481             cms_duration(), cms_duration_per_mb(),
 482             cms_period(), cms_allocated());
 483   st->print(",cms_since_beg=%g,cms_since_end=%g",
 484             cms_time_since_begin(), cms_time_since_end());
 485   st->print(",cms_used_beg=" SIZE_FORMAT ",cms_used_end=" SIZE_FORMAT,
 486             _cms_used_at_gc0_begin, _cms_used_at_gc0_end);
 487   if (CMSIncrementalMode) {
 488     st->print(",dc=%d", icms_duty_cycle());
 489   }
 490 
 491   if (valid()) {
 492     st->print(",promo_rate=%g,cms_alloc_rate=%g",
 493               promotion_rate(), cms_allocation_rate());
 494     st->print(",cms_consumption_rate=%g,time_until_full=%g",
 495               cms_consumption_rate(), time_until_cms_gen_full());
 496   }
 497   st->print(" ");
 498 }
 499 #endif // #ifndef PRODUCT
 500 
 501 CMSCollector::CollectorState CMSCollector::_collectorState =
 502                              CMSCollector::Idling;
 503 bool CMSCollector::_foregroundGCIsActive = false;
 504 bool CMSCollector::_foregroundGCShouldWait = false;
 505 
 506 CMSCollector::CMSCollector(ConcurrentMarkSweepGeneration* cmsGen,
 507                            ConcurrentMarkSweepGeneration* permGen,
 508                            CardTableRS*                   ct,
 509                            ConcurrentMarkSweepPolicy*     cp):
 510   _cmsGen(cmsGen),
 511   _permGen(permGen),
 512   _ct(ct),
 513   _ref_processor(NULL),    // will be set later
 514   _conc_workers(NULL),     // may be set later
 515   _abort_preclean(false),
 516   _start_sampling(false),
 517   _between_prologue_and_epilogue(false),
 518   _markBitMap(0, Mutex::leaf + 1, "CMS_markBitMap_lock"),
 519   _perm_gen_verify_bit_map(0, -1 /* no mutex */, "No_lock"),
 520   _modUnionTable((CardTableModRefBS::card_shift - LogHeapWordSize),
 521                  -1 /* lock-free */, "No_lock" /* dummy */),
 522   _modUnionClosure(&_modUnionTable),
 523   _modUnionClosurePar(&_modUnionTable),
 524   // Adjust my span to cover old (cms) gen and perm gen
 525   _span(cmsGen->reserved()._union(permGen->reserved())),
 526   // Construct the is_alive_closure with _span & markBitMap
 527   _is_alive_closure(_span, &_markBitMap),
 528   _restart_addr(NULL),
 529   _overflow_list(NULL),
 530   _preserved_oop_stack(NULL),
 531   _preserved_mark_stack(NULL),
 532   _stats(cmsGen),
 533   _eden_chunk_array(NULL),     // may be set in ctor body
 534   _eden_chunk_capacity(0),     // -- ditto --
 535   _eden_chunk_index(0),        // -- ditto --
 536   _survivor_plab_array(NULL),  // -- ditto --
 537   _survivor_chunk_array(NULL), // -- ditto --
 538   _survivor_chunk_capacity(0), // -- ditto --
 539   _survivor_chunk_index(0),    // -- ditto --
 540   _ser_pmc_preclean_ovflw(0),
 541   _ser_pmc_remark_ovflw(0),
 542   _par_pmc_remark_ovflw(0),
 543   _ser_kac_ovflw(0),
 544   _par_kac_ovflw(0),
 545 #ifndef PRODUCT
 546   _num_par_pushes(0),
 547 #endif
 548   _collection_count_start(0),
 549   _verifying(false),
 550   _icms_start_limit(NULL),
 551   _icms_stop_limit(NULL),
 552   _verification_mark_bm(0, Mutex::leaf + 1, "CMS_verification_mark_bm_lock"),
 553   _completed_initialization(false),
 554   _collector_policy(cp),
 555   _should_unload_classes(false),
 556   _concurrent_cycles_since_last_unload(0),
 557   _sweep_estimate(CMS_SweepWeight, CMS_SweepPadding)
 558 {
 559   if (ExplicitGCInvokesConcurrentAndUnloadsClasses) {
 560     ExplicitGCInvokesConcurrent = true;
 561   }
 562   // Now expand the span and allocate the collection support structures
 563   // (MUT, marking bit map etc.) to cover both generations subject to
 564   // collection.
 565 
 566   // First check that _permGen is adjacent to _cmsGen and above it.
 567   assert(   _cmsGen->reserved().word_size()  > 0
 568          && _permGen->reserved().word_size() > 0,
 569          "generations should not be of zero size");
 570   assert(_cmsGen->reserved().intersection(_permGen->reserved()).is_empty(),
 571          "_cmsGen and _permGen should not overlap");
 572   assert(_cmsGen->reserved().end() == _permGen->reserved().start(),
 573          "_cmsGen->end() different from _permGen->start()");
 574 
 575   // For use by dirty card to oop closures.
 576   _cmsGen->cmsSpace()->set_collector(this);
 577   _permGen->cmsSpace()->set_collector(this);
 578 
 579   // Allocate MUT and marking bit map
 580   {
 581     MutexLockerEx x(_markBitMap.lock(), Mutex::_no_safepoint_check_flag);
 582     if (!_markBitMap.allocate(_span)) {
 583       warning("Failed to allocate CMS Bit Map");
 584       return;
 585     }
 586     assert(_markBitMap.covers(_span), "_markBitMap inconsistency?");
 587   }
 588   {
 589     _modUnionTable.allocate(_span);
 590     assert(_modUnionTable.covers(_span), "_modUnionTable inconsistency?");
 591   }
 592 
 593   if (!_markStack.allocate(CMSMarkStackSize)) {
 594     warning("Failed to allocate CMS Marking Stack");
 595     return;
 596   }
 597   if (!_revisitStack.allocate(CMSRevisitStackSize)) {
 598     warning("Failed to allocate CMS Revisit Stack");
 599     return;
 600   }
 601 
 602   // Support for multi-threaded concurrent phases
 603   if (ParallelGCThreads > 0 && CMSConcurrentMTEnabled) {
 604     if (FLAG_IS_DEFAULT(ParallelCMSThreads)) {
 605       // just for now
 606       FLAG_SET_DEFAULT(ParallelCMSThreads, (ParallelGCThreads + 3)/4);
 607     }
 608     if (ParallelCMSThreads > 1) {
 609       _conc_workers = new YieldingFlexibleWorkGang("Parallel CMS Threads",
 610                                  ParallelCMSThreads, true);
 611       if (_conc_workers == NULL) {
 612         warning("GC/CMS: _conc_workers allocation failure: "
 613               "forcing -CMSConcurrentMTEnabled");
 614         CMSConcurrentMTEnabled = false;
 615       }
 616     } else {
 617       CMSConcurrentMTEnabled = false;
 618     }
 619   }
 620   if (!CMSConcurrentMTEnabled) {
 621     ParallelCMSThreads = 0;
 622   } else {
 623     // Turn off CMSCleanOnEnter optimization temporarily for
 624     // the MT case where it's not fixed yet; see 6178663.
 625     CMSCleanOnEnter = false;
 626   }
 627   assert((_conc_workers != NULL) == (ParallelCMSThreads > 1),
 628          "Inconsistency");
 629 
 630   // Parallel task queues; these are shared for the
 631   // concurrent and stop-world phases of CMS, but
 632   // are not shared with parallel scavenge (ParNew).
 633   {
 634     uint i;
 635     uint num_queues = (uint) MAX2(ParallelGCThreads, ParallelCMSThreads);
 636 
 637     if ((CMSParallelRemarkEnabled || CMSConcurrentMTEnabled
 638          || ParallelRefProcEnabled)
 639         && num_queues > 0) {
 640       _task_queues = new OopTaskQueueSet(num_queues);
 641       if (_task_queues == NULL) {
 642         warning("task_queues allocation failure.");
 643         return;
 644       }
 645       _hash_seed = NEW_C_HEAP_ARRAY(int, num_queues);
 646       if (_hash_seed == NULL) {
 647         warning("_hash_seed array allocation failure");
 648         return;
 649       }
 650 
 651       // XXX use a global constant instead of 64!
 652       typedef struct OopTaskQueuePadded {
 653         OopTaskQueue work_queue;
 654         char pad[64 - sizeof(OopTaskQueue)];  // prevent false sharing
 655       } OopTaskQueuePadded;
 656 
 657       for (i = 0; i < num_queues; i++) {
 658         OopTaskQueuePadded *q_padded = new OopTaskQueuePadded();
 659         if (q_padded == NULL) {
 660           warning("work_queue allocation failure.");
 661           return;
 662         }
 663         _task_queues->register_queue(i, &q_padded->work_queue);
 664       }
 665       for (i = 0; i < num_queues; i++) {
 666         _task_queues->queue(i)->initialize();
 667         _hash_seed[i] = 17;  // copied from ParNew
 668       }
 669     }
 670   }
 671 
 672   _cmsGen ->init_initiating_occupancy(CMSInitiatingOccupancyFraction, CMSTriggerRatio);
 673   _permGen->init_initiating_occupancy(CMSInitiatingPermOccupancyFraction, CMSTriggerPermRatio);
 674 
 675   // Clip CMSBootstrapOccupancy between 0 and 100.
 676   _bootstrap_occupancy = ((double)MIN2((uintx)100, MAX2((uintx)0, CMSBootstrapOccupancy)))
 677                          /(double)100;
 678 
 679   _full_gcs_since_conc_gc = 0;
 680 
 681   // Now tell CMS generations the identity of their collector
 682   ConcurrentMarkSweepGeneration::set_collector(this);
 683 
 684   // Create & start a CMS thread for this CMS collector
 685   _cmsThread = ConcurrentMarkSweepThread::start(this);
 686   assert(cmsThread() != NULL, "CMS Thread should have been created");
 687   assert(cmsThread()->collector() == this,
 688          "CMS Thread should refer to this gen");
 689   assert(CGC_lock != NULL, "Where's the CGC_lock?");
 690 
 691   // Support for parallelizing young gen rescan
 692   GenCollectedHeap* gch = GenCollectedHeap::heap();
 693   _young_gen = gch->prev_gen(_cmsGen);
 694   if (gch->supports_inline_contig_alloc()) {
 695     _top_addr = gch->top_addr();
 696     _end_addr = gch->end_addr();
 697     assert(_young_gen != NULL, "no _young_gen");
 698     _eden_chunk_index = 0;
 699     _eden_chunk_capacity = (_young_gen->max_capacity()+CMSSamplingGrain)/CMSSamplingGrain;
 700     _eden_chunk_array = NEW_C_HEAP_ARRAY(HeapWord*, _eden_chunk_capacity);
 701     if (_eden_chunk_array == NULL) {
 702       _eden_chunk_capacity = 0;
 703       warning("GC/CMS: _eden_chunk_array allocation failure");
 704     }
 705   }
 706   assert(_eden_chunk_array != NULL || _eden_chunk_capacity == 0, "Error");
 707 
 708   // Support for parallelizing survivor space rescan
 709   if (CMSParallelRemarkEnabled && CMSParallelSurvivorRemarkEnabled) {
 710     size_t max_plab_samples = MaxNewSize/((SurvivorRatio+2)*MinTLABSize);
 711     _survivor_plab_array  = NEW_C_HEAP_ARRAY(ChunkArray, ParallelGCThreads);
 712     _survivor_chunk_array = NEW_C_HEAP_ARRAY(HeapWord*, 2*max_plab_samples);
 713     _cursor               = NEW_C_HEAP_ARRAY(size_t, ParallelGCThreads);
 714     if (_survivor_plab_array == NULL || _survivor_chunk_array == NULL
 715         || _cursor == NULL) {
 716       warning("Failed to allocate survivor plab/chunk array");
 717       if (_survivor_plab_array  != NULL) {
 718         FREE_C_HEAP_ARRAY(ChunkArray, _survivor_plab_array);
 719         _survivor_plab_array = NULL;
 720       }
 721       if (_survivor_chunk_array != NULL) {
 722         FREE_C_HEAP_ARRAY(HeapWord*, _survivor_chunk_array);
 723         _survivor_chunk_array = NULL;
 724       }
 725       if (_cursor != NULL) {
 726         FREE_C_HEAP_ARRAY(size_t, _cursor);
 727         _cursor = NULL;
 728       }
 729     } else {
 730       _survivor_chunk_capacity = 2*max_plab_samples;
 731       for (uint i = 0; i < ParallelGCThreads; i++) {
 732         HeapWord** vec = NEW_C_HEAP_ARRAY(HeapWord*, max_plab_samples);
 733         if (vec == NULL) {
 734           warning("Failed to allocate survivor plab array");
 735           for (int j = i; j > 0; j--) {
 736             FREE_C_HEAP_ARRAY(HeapWord*, _survivor_plab_array[j-1].array());
 737           }
 738           FREE_C_HEAP_ARRAY(ChunkArray, _survivor_plab_array);
 739           FREE_C_HEAP_ARRAY(HeapWord*, _survivor_chunk_array);
 740           _survivor_plab_array = NULL;
 741           _survivor_chunk_array = NULL;
 742           _survivor_chunk_capacity = 0;
 743           break;
 744         } else {
 745           ChunkArray* cur =
 746             ::new (&_survivor_plab_array[i]) ChunkArray(vec,
 747                                                         max_plab_samples);
 748           assert(cur->end() == 0, "Should be 0");
 749           assert(cur->array() == vec, "Should be vec");
 750           assert(cur->capacity() == max_plab_samples, "Error");
 751         }
 752       }
 753     }
 754   }
 755   assert(   (   _survivor_plab_array  != NULL
 756              && _survivor_chunk_array != NULL)
 757          || (   _survivor_chunk_capacity == 0
 758              && _survivor_chunk_index == 0),
 759          "Error");
 760 
 761   // Choose what strong roots should be scanned depending on verification options
 762   // and perm gen collection mode.
 763   if (!CMSClassUnloadingEnabled) {
 764     // If class unloading is disabled we want to include all classes into the root set.
 765     add_root_scanning_option(SharedHeap::SO_AllClasses);
 766   } else {
 767     add_root_scanning_option(SharedHeap::SO_SystemClasses);
 768   }
 769 
 770   NOT_PRODUCT(_overflow_counter = CMSMarkStackOverflowInterval;)
 771   _gc_counters = new CollectorCounters("CMS", 1);
 772   _completed_initialization = true;
 773   _sweep_timer.start();  // start of time
 774 }
 775 
 776 const char* ConcurrentMarkSweepGeneration::name() const {
 777   return "concurrent mark-sweep generation";
 778 }
 779 void ConcurrentMarkSweepGeneration::update_counters() {
 780   if (UsePerfData) {
 781     _space_counters->update_all();
 782     _gen_counters->update_all();
 783   }
 784 }
 785 
 786 // this is an optimized version of update_counters(). it takes the
 787 // used value as a parameter rather than computing it.
 788 //
 789 void ConcurrentMarkSweepGeneration::update_counters(size_t used) {
 790   if (UsePerfData) {
 791     _space_counters->update_used(used);
 792     _space_counters->update_capacity();
 793     _gen_counters->update_all();
 794   }
 795 }
 796 
 797 void ConcurrentMarkSweepGeneration::print() const {
 798   Generation::print();
 799   cmsSpace()->print();
 800 }
 801 
 802 #ifndef PRODUCT
 803 void ConcurrentMarkSweepGeneration::print_statistics() {
 804   cmsSpace()->printFLCensus(0);
 805 }
 806 #endif
 807 
 808 void ConcurrentMarkSweepGeneration::printOccupancy(const char *s) {
 809   GenCollectedHeap* gch = GenCollectedHeap::heap();
 810   if (PrintGCDetails) {
 811     if (Verbose) {
 812       gclog_or_tty->print(" [%d %s-%s: "SIZE_FORMAT"("SIZE_FORMAT")]",
 813         level(), short_name(), s, used(), capacity());
 814     } else {
 815       gclog_or_tty->print(" [%d %s-%s: "SIZE_FORMAT"K("SIZE_FORMAT"K)]",
 816         level(), short_name(), s, used() / K, capacity() / K);
 817     }
 818   }
 819   if (Verbose) {
 820     gclog_or_tty->print(" "SIZE_FORMAT"("SIZE_FORMAT")",
 821               gch->used(), gch->capacity());
 822   } else {
 823     gclog_or_tty->print(" "SIZE_FORMAT"K("SIZE_FORMAT"K)",
 824               gch->used() / K, gch->capacity() / K);
 825   }
 826 }
 827 
 828 size_t
 829 ConcurrentMarkSweepGeneration::contiguous_available() const {
 830   // dld proposes an improvement in precision here. If the committed
 831   // part of the space ends in a free block we should add that to
 832   // uncommitted size in the calculation below. Will make this
 833   // change later, staying with the approximation below for the
 834   // time being. -- ysr.
 835   return MAX2(_virtual_space.uncommitted_size(), unsafe_max_alloc_nogc());
 836 }
 837 
 838 size_t
 839 ConcurrentMarkSweepGeneration::unsafe_max_alloc_nogc() const {
 840   return _cmsSpace->max_alloc_in_words() * HeapWordSize;
 841 }
 842 
 843 size_t ConcurrentMarkSweepGeneration::max_available() const {
 844   return free() + _virtual_space.uncommitted_size();
 845 }
 846 
 847 bool ConcurrentMarkSweepGeneration::promotion_attempt_is_safe(
 848     size_t max_promotion_in_bytes,
 849     bool younger_handles_promotion_failure) const {
 850 
 851   // This is the most conservative test.  Full promotion is
 852   // guaranteed if this is used. The multiplicative factor is to
 853   // account for the worst case "dilatation".
 854   double adjusted_max_promo_bytes = _dilatation_factor * max_promotion_in_bytes;
 855   if (adjusted_max_promo_bytes > (double)max_uintx) { // larger than size_t
 856     adjusted_max_promo_bytes = (double)max_uintx;
 857   }
 858   bool result = (max_contiguous_available() >= (size_t)adjusted_max_promo_bytes);
 859 
 860   if (younger_handles_promotion_failure && !result) {
 861     // Full promotion is not guaranteed because fragmentation
 862     // of the cms generation can prevent the full promotion.
 863     result = (max_available() >= (size_t)adjusted_max_promo_bytes);
 864 
 865     if (!result) {
 866       // With promotion failure handling the test for the ability
 867       // to support the promotion does not have to be guaranteed.
 868       // Use an average of the amount promoted.
 869       result = max_available() >= (size_t)
 870         gc_stats()->avg_promoted()->padded_average();
 871       if (PrintGC && Verbose && result) {
 872         gclog_or_tty->print_cr(
 873           "\nConcurrentMarkSweepGeneration::promotion_attempt_is_safe"
 874           " max_available: " SIZE_FORMAT
 875           " avg_promoted: " SIZE_FORMAT,
 876           max_available(), (size_t)
 877           gc_stats()->avg_promoted()->padded_average());
 878       }
 879     } else {
 880       if (PrintGC && Verbose) {
 881         gclog_or_tty->print_cr(
 882           "\nConcurrentMarkSweepGeneration::promotion_attempt_is_safe"
 883           " max_available: " SIZE_FORMAT
 884           " adj_max_promo_bytes: " SIZE_FORMAT,
 885           max_available(), (size_t)adjusted_max_promo_bytes);
 886       }
 887     }
 888   } else {
 889     if (PrintGC && Verbose) {
 890       gclog_or_tty->print_cr(
 891         "\nConcurrentMarkSweepGeneration::promotion_attempt_is_safe"
 892         " contiguous_available: " SIZE_FORMAT
 893         " adj_max_promo_bytes: " SIZE_FORMAT,
 894         max_contiguous_available(), (size_t)adjusted_max_promo_bytes);
 895     }
 896   }
 897   return result;
 898 }
 899 
 900 CompactibleSpace*
 901 ConcurrentMarkSweepGeneration::first_compaction_space() const {
 902   return _cmsSpace;
 903 }
 904 
 905 void ConcurrentMarkSweepGeneration::reset_after_compaction() {
 906   // Clear the promotion information.  These pointers can be adjusted
 907   // along with all the other pointers into the heap but
 908   // compaction is expected to be a rare event with
 909   // a heap using cms so don't do it without seeing the need.
 910   if (ParallelGCThreads > 0) {
 911     for (uint i = 0; i < ParallelGCThreads; i++) {
 912       _par_gc_thread_states[i]->promo.reset();
 913     }
 914   }
 915 }
 916 
 917 void ConcurrentMarkSweepGeneration::space_iterate(SpaceClosure* blk, bool usedOnly) {
 918   blk->do_space(_cmsSpace);
 919 }
 920 
 921 void ConcurrentMarkSweepGeneration::compute_new_size() {
 922   assert_locked_or_safepoint(Heap_lock);
 923 
 924   // If incremental collection failed, we just want to expand
 925   // to the limit.
 926   if (incremental_collection_failed()) {
 927     clear_incremental_collection_failed();
 928     grow_to_reserved();
 929     return;
 930   }
 931 
 932   size_t expand_bytes = 0;
 933   double free_percentage = ((double) free()) / capacity();
 934   double desired_free_percentage = (double) MinHeapFreeRatio / 100;
 935   double maximum_free_percentage = (double) MaxHeapFreeRatio / 100;
 936 
 937   // compute expansion delta needed for reaching desired free percentage
 938   if (free_percentage < desired_free_percentage) {
 939     size_t desired_capacity = (size_t)(used() / ((double) 1 - desired_free_percentage));
 940     assert(desired_capacity >= capacity(), "invalid expansion size");
 941     expand_bytes = MAX2(desired_capacity - capacity(), MinHeapDeltaBytes);
 942   }
 943   if (expand_bytes > 0) {
 944     if (PrintGCDetails && Verbose) {
 945       size_t desired_capacity = (size_t)(used() / ((double) 1 - desired_free_percentage));
 946       gclog_or_tty->print_cr("\nFrom compute_new_size: ");
 947       gclog_or_tty->print_cr("  Free fraction %f", free_percentage);
 948       gclog_or_tty->print_cr("  Desired free fraction %f",
 949         desired_free_percentage);
 950       gclog_or_tty->print_cr("  Maximum free fraction %f",
 951         maximum_free_percentage);
 952       gclog_or_tty->print_cr("  Capactiy "SIZE_FORMAT, capacity()/1000);
 953       gclog_or_tty->print_cr("  Desired capacity "SIZE_FORMAT,
 954         desired_capacity/1000);
 955       int prev_level = level() - 1;
 956       if (prev_level >= 0) {
 957         size_t prev_size = 0;
 958         GenCollectedHeap* gch = GenCollectedHeap::heap();
 959         Generation* prev_gen = gch->_gens[prev_level];
 960         prev_size = prev_gen->capacity();
 961           gclog_or_tty->print_cr("  Younger gen size "SIZE_FORMAT,
 962                                  prev_size/1000);
 963       }
 964       gclog_or_tty->print_cr("  unsafe_max_alloc_nogc "SIZE_FORMAT,
 965         unsafe_max_alloc_nogc()/1000);
 966       gclog_or_tty->print_cr("  contiguous available "SIZE_FORMAT,
 967         contiguous_available()/1000);
 968       gclog_or_tty->print_cr("  Expand by "SIZE_FORMAT" (bytes)",
 969         expand_bytes);
 970     }
 971     // safe if expansion fails
 972     expand(expand_bytes, 0, CMSExpansionCause::_satisfy_free_ratio);
 973     if (PrintGCDetails && Verbose) {
 974       gclog_or_tty->print_cr("  Expanded free fraction %f",
 975         ((double) free()) / capacity());
 976     }
 977   }
 978 }
 979 
 980 Mutex* ConcurrentMarkSweepGeneration::freelistLock() const {
 981   return cmsSpace()->freelistLock();
 982 }
 983 
 984 HeapWord* ConcurrentMarkSweepGeneration::allocate(size_t size,
 985                                                   bool   tlab) {
 986   CMSSynchronousYieldRequest yr;
 987   MutexLockerEx x(freelistLock(),
 988                   Mutex::_no_safepoint_check_flag);
 989   return have_lock_and_allocate(size, tlab);
 990 }
 991 
 992 HeapWord* ConcurrentMarkSweepGeneration::have_lock_and_allocate(size_t size,
 993                                                   bool   tlab) {
 994   assert_lock_strong(freelistLock());
 995   size_t adjustedSize = CompactibleFreeListSpace::adjustObjectSize(size);
 996   HeapWord* res = cmsSpace()->allocate(adjustedSize);
 997   // Allocate the object live (grey) if the background collector has
 998   // started marking. This is necessary because the marker may
 999   // have passed this address and consequently this object will
1000   // not otherwise be greyed and would be incorrectly swept up.
1001   // Note that if this object contains references, the writing
1002   // of those references will dirty the card containing this object
1003   // allowing the object to be blackened (and its references scanned)
1004   // either during a preclean phase or at the final checkpoint.
1005   if (res != NULL) {
1006     collector()->direct_allocated(res, adjustedSize);
1007     _direct_allocated_words += adjustedSize;
1008     // allocation counters
1009     NOT_PRODUCT(
1010       _numObjectsAllocated++;
1011       _numWordsAllocated += (int)adjustedSize;
1012     )
1013   }
1014   return res;
1015 }
1016 
1017 // In the case of direct allocation by mutators in a generation that
1018 // is being concurrently collected, the object must be allocated
1019 // live (grey) if the background collector has started marking.
1020 // This is necessary because the marker may
1021 // have passed this address and consequently this object will
1022 // not otherwise be greyed and would be incorrectly swept up.
1023 // Note that if this object contains references, the writing
1024 // of those references will dirty the card containing this object
1025 // allowing the object to be blackened (and its references scanned)
1026 // either during a preclean phase or at the final checkpoint.
1027 void CMSCollector::direct_allocated(HeapWord* start, size_t size) {
1028   assert(_markBitMap.covers(start, size), "Out of bounds");
1029   if (_collectorState >= Marking) {
1030     MutexLockerEx y(_markBitMap.lock(),
1031                     Mutex::_no_safepoint_check_flag);
1032     // [see comments preceding SweepClosure::do_blk() below for details]
1033     // 1. need to mark the object as live so it isn't collected
1034     // 2. need to mark the 2nd bit to indicate the object may be uninitialized
1035     // 3. need to mark the end of the object so sweeper can skip over it
1036     //    if it's uninitialized when the sweeper reaches it.
1037     _markBitMap.mark(start);          // object is live
1038     _markBitMap.mark(start + 1);      // object is potentially uninitialized?
1039     _markBitMap.mark(start + size - 1);
1040                                       // mark end of object
1041   }
1042   // check that oop looks uninitialized
1043   assert(oop(start)->klass_or_null() == NULL, "_klass should be NULL");
1044 }
1045 
1046 void CMSCollector::promoted(bool par, HeapWord* start,
1047                             bool is_obj_array, size_t obj_size) {
1048   assert(_markBitMap.covers(start), "Out of bounds");
1049   // See comment in direct_allocated() about when objects should
1050   // be allocated live.
1051   if (_collectorState >= Marking) {
1052     // we already hold the marking bit map lock, taken in
1053     // the prologue
1054     if (par) {
1055       _markBitMap.par_mark(start);
1056     } else {
1057       _markBitMap.mark(start);
1058     }
1059     // We don't need to mark the object as uninitialized (as
1060     // in direct_allocated above) because this is being done with the
1061     // world stopped and the object will be initialized by the
1062     // time the sweeper gets to look at it.
1063     assert(SafepointSynchronize::is_at_safepoint(),
1064            "expect promotion only at safepoints");
1065 
1066     if (_collectorState < Sweeping) {
1067       // Mark the appropriate cards in the modUnionTable, so that
1068       // this object gets scanned before the sweep. If this is
1069       // not done, CMS generation references in the object might
1070       // not get marked.
1071       // For the case of arrays, which are otherwise precisely
1072       // marked, we need to dirty the entire array, not just its head.
1073       if (is_obj_array) {
1074         // The [par_]mark_range() method expects mr.end() below to
1075         // be aligned to the granularity of a bit's representation
1076         // in the heap. In the case of the MUT below, that's a
1077         // card size.
1078         MemRegion mr(start,
1079                      (HeapWord*)round_to((intptr_t)(start + obj_size),
1080                         CardTableModRefBS::card_size /* bytes */));
1081         if (par) {
1082           _modUnionTable.par_mark_range(mr);
1083         } else {
1084           _modUnionTable.mark_range(mr);
1085         }
1086       } else {  // not an obj array; we can just mark the head
1087         if (par) {
1088           _modUnionTable.par_mark(start);
1089         } else {
1090           _modUnionTable.mark(start);
1091         }
1092       }
1093     }
1094   }
1095 }
1096 
1097 static inline size_t percent_of_space(Space* space, HeapWord* addr)
1098 {
1099   size_t delta = pointer_delta(addr, space->bottom());
1100   return (size_t)(delta * 100.0 / (space->capacity() / HeapWordSize));
1101 }
1102 
1103 void CMSCollector::icms_update_allocation_limits()
1104 {
1105   Generation* gen0 = GenCollectedHeap::heap()->get_gen(0);
1106   EdenSpace* eden = gen0->as_DefNewGeneration()->eden();
1107 
1108   const unsigned int duty_cycle = stats().icms_update_duty_cycle();
1109   if (CMSTraceIncrementalPacing) {
1110     stats().print();
1111   }
1112 
1113   assert(duty_cycle <= 100, "invalid duty cycle");
1114   if (duty_cycle != 0) {
1115     // The duty_cycle is a percentage between 0 and 100; convert to words and
1116     // then compute the offset from the endpoints of the space.
1117     size_t free_words = eden->free() / HeapWordSize;
1118     double free_words_dbl = (double)free_words;
1119     size_t duty_cycle_words = (size_t)(free_words_dbl * duty_cycle / 100.0);
1120     size_t offset_words = (free_words - duty_cycle_words) / 2;
1121 
1122     _icms_start_limit = eden->top() + offset_words;
1123     _icms_stop_limit = eden->end() - offset_words;
1124 
1125     // The limits may be adjusted (shifted to the right) by
1126     // CMSIncrementalOffset, to allow the application more mutator time after a
1127     // young gen gc (when all mutators were stopped) and before CMS starts and
1128     // takes away one or more cpus.
1129     if (CMSIncrementalOffset != 0) {
1130       double adjustment_dbl = free_words_dbl * CMSIncrementalOffset / 100.0;
1131       size_t adjustment = (size_t)adjustment_dbl;
1132       HeapWord* tmp_stop = _icms_stop_limit + adjustment;
1133       if (tmp_stop > _icms_stop_limit && tmp_stop < eden->end()) {
1134         _icms_start_limit += adjustment;
1135         _icms_stop_limit = tmp_stop;
1136       }
1137     }
1138   }
1139   if (duty_cycle == 0 || (_icms_start_limit == _icms_stop_limit)) {
1140     _icms_start_limit = _icms_stop_limit = eden->end();
1141   }
1142 
1143   // Install the new start limit.
1144   eden->set_soft_end(_icms_start_limit);
1145 
1146   if (CMSTraceIncrementalMode) {
1147     gclog_or_tty->print(" icms alloc limits:  "
1148                            PTR_FORMAT "," PTR_FORMAT
1149                            " (" SIZE_FORMAT "%%," SIZE_FORMAT "%%) ",
1150                            _icms_start_limit, _icms_stop_limit,
1151                            percent_of_space(eden, _icms_start_limit),
1152                            percent_of_space(eden, _icms_stop_limit));
1153     if (Verbose) {
1154       gclog_or_tty->print("eden:  ");
1155       eden->print_on(gclog_or_tty);
1156     }
1157   }
1158 }
1159 
1160 // Any changes here should try to maintain the invariant
1161 // that if this method is called with _icms_start_limit
1162 // and _icms_stop_limit both NULL, then it should return NULL
1163 // and not notify the icms thread.
1164 HeapWord*
1165 CMSCollector::allocation_limit_reached(Space* space, HeapWord* top,
1166                                        size_t word_size)
1167 {
1168   // A start_limit equal to end() means the duty cycle is 0, so treat that as a
1169   // nop.
1170   if (CMSIncrementalMode && _icms_start_limit != space->end()) {
1171     if (top <= _icms_start_limit) {
1172       if (CMSTraceIncrementalMode) {
1173         space->print_on(gclog_or_tty);
1174         gclog_or_tty->stamp();
1175         gclog_or_tty->print_cr(" start limit top=" PTR_FORMAT
1176                                ", new limit=" PTR_FORMAT
1177                                " (" SIZE_FORMAT "%%)",
1178                                top, _icms_stop_limit,
1179                                percent_of_space(space, _icms_stop_limit));
1180       }
1181       ConcurrentMarkSweepThread::start_icms();
1182       assert(top < _icms_stop_limit, "Tautology");
1183       if (word_size < pointer_delta(_icms_stop_limit, top)) {
1184         return _icms_stop_limit;
1185       }
1186 
1187       // The allocation will cross both the _start and _stop limits, so do the
1188       // stop notification also and return end().
1189       if (CMSTraceIncrementalMode) {
1190         space->print_on(gclog_or_tty);
1191         gclog_or_tty->stamp();
1192         gclog_or_tty->print_cr(" +stop limit top=" PTR_FORMAT
1193                                ", new limit=" PTR_FORMAT
1194                                " (" SIZE_FORMAT "%%)",
1195                                top, space->end(),
1196                                percent_of_space(space, space->end()));
1197       }
1198       ConcurrentMarkSweepThread::stop_icms();
1199       return space->end();
1200     }
1201 
1202     if (top <= _icms_stop_limit) {
1203       if (CMSTraceIncrementalMode) {
1204         space->print_on(gclog_or_tty);
1205         gclog_or_tty->stamp();
1206         gclog_or_tty->print_cr(" stop limit top=" PTR_FORMAT
1207                                ", new limit=" PTR_FORMAT
1208                                " (" SIZE_FORMAT "%%)",
1209                                top, space->end(),
1210                                percent_of_space(space, space->end()));
1211       }
1212       ConcurrentMarkSweepThread::stop_icms();
1213       return space->end();
1214     }
1215 
1216     if (CMSTraceIncrementalMode) {
1217       space->print_on(gclog_or_tty);
1218       gclog_or_tty->stamp();
1219       gclog_or_tty->print_cr(" end limit top=" PTR_FORMAT
1220                              ", new limit=" PTR_FORMAT,
1221                              top, NULL);
1222     }
1223   }
1224 
1225   return NULL;
1226 }
1227 
1228 oop ConcurrentMarkSweepGeneration::promote(oop obj, size_t obj_size) {
1229   assert(obj_size == (size_t)obj->size(), "bad obj_size passed in");
1230   // allocate, copy and if necessary update promoinfo --
1231   // delegate to underlying space.
1232   assert_lock_strong(freelistLock());
1233 
1234 #ifndef PRODUCT
1235   if (Universe::heap()->promotion_should_fail()) {
1236     return NULL;
1237   }
1238 #endif  // #ifndef PRODUCT
1239 
1240   oop res = _cmsSpace->promote(obj, obj_size);
1241   if (res == NULL) {
1242     // expand and retry
1243     size_t s = _cmsSpace->expansionSpaceRequired(obj_size);  // HeapWords
1244     expand(s*HeapWordSize, MinHeapDeltaBytes,
1245       CMSExpansionCause::_satisfy_promotion);
1246     // Since there's currently no next generation, we don't try to promote
1247     // into a more senior generation.
1248     assert(next_gen() == NULL, "assumption, based upon which no attempt "
1249                                "is made to pass on a possibly failing "
1250                                "promotion to next generation");
1251     res = _cmsSpace->promote(obj, obj_size);
1252   }
1253   if (res != NULL) {
1254     // See comment in allocate() about when objects should
1255     // be allocated live.
1256     assert(obj->is_oop(), "Will dereference klass pointer below");
1257     collector()->promoted(false,           // Not parallel
1258                           (HeapWord*)res, obj->is_objArray(), obj_size);
1259     // promotion counters
1260     NOT_PRODUCT(
1261       _numObjectsPromoted++;
1262       _numWordsPromoted +=
1263         (int)(CompactibleFreeListSpace::adjustObjectSize(obj->size()));
1264     )
1265   }
1266   return res;
1267 }
1268 
1269 
1270 HeapWord*
1271 ConcurrentMarkSweepGeneration::allocation_limit_reached(Space* space,
1272                                              HeapWord* top,
1273                                              size_t word_sz)
1274 {
1275   return collector()->allocation_limit_reached(space, top, word_sz);
1276 }
1277 
1278 // Things to support parallel young-gen collection.
1279 oop
1280 ConcurrentMarkSweepGeneration::par_promote(int thread_num,
1281                                            oop old, markOop m,
1282                                            size_t word_sz) {
1283 #ifndef PRODUCT
1284   if (Universe::heap()->promotion_should_fail()) {
1285     return NULL;
1286   }
1287 #endif  // #ifndef PRODUCT
1288 
1289   CMSParGCThreadState* ps = _par_gc_thread_states[thread_num];
1290   PromotionInfo* promoInfo = &ps->promo;
1291   // if we are tracking promotions, then first ensure space for
1292   // promotion (including spooling space for saving header if necessary).
1293   // then allocate and copy, then track promoted info if needed.
1294   // When tracking (see PromotionInfo::track()), the mark word may
1295   // be displaced and in this case restoration of the mark word
1296   // occurs in the (oop_since_save_marks_)iterate phase.
1297   if (promoInfo->tracking() && !promoInfo->ensure_spooling_space()) {
1298     // Out of space for allocating spooling buffers;
1299     // try expanding and allocating spooling buffers.
1300     if (!expand_and_ensure_spooling_space(promoInfo)) {
1301       return NULL;
1302     }
1303   }
1304   assert(promoInfo->has_spooling_space(), "Control point invariant");
1305   HeapWord* obj_ptr = ps->lab.alloc(word_sz);
1306   if (obj_ptr == NULL) {
1307      obj_ptr = expand_and_par_lab_allocate(ps, word_sz);
1308      if (obj_ptr == NULL) {
1309        return NULL;
1310      }
1311   }
1312   oop obj = oop(obj_ptr);
1313   assert(obj->klass_or_null() == NULL, "Object should be uninitialized here.");
1314   // Otherwise, copy the object.  Here we must be careful to insert the
1315   // klass pointer last, since this marks the block as an allocated object.
1316   // Except with compressed oops it's the mark word.
1317   HeapWord* old_ptr = (HeapWord*)old;
1318   if (word_sz > (size_t)oopDesc::header_size()) {
1319     Copy::aligned_disjoint_words(old_ptr + oopDesc::header_size(),
1320                                  obj_ptr + oopDesc::header_size(),
1321                                  word_sz - oopDesc::header_size());
1322   }
1323 
1324   if (UseCompressedOops) {
1325     // Copy gap missed by (aligned) header size calculation above
1326     obj->set_klass_gap(old->klass_gap());
1327   }
1328 
1329   // Restore the mark word copied above.
1330   obj->set_mark(m);
1331 
1332   // Now we can track the promoted object, if necessary.  We take care
1333   // To delay the transition from uninitialized to full object
1334   // (i.e., insertion of klass pointer) until after, so that it
1335   // atomically becomes a promoted object.
1336   if (promoInfo->tracking()) {
1337     promoInfo->track((PromotedObject*)obj, old->klass());
1338   }
1339 
1340   // Finally, install the klass pointer (this should be volatile).
1341   obj->set_klass(old->klass());
1342 
1343   assert(old->is_oop(), "Will dereference klass ptr below");
1344   collector()->promoted(true,          // parallel
1345                         obj_ptr, old->is_objArray(), word_sz);
1346 
1347   NOT_PRODUCT(
1348     Atomic::inc(&_numObjectsPromoted);
1349     Atomic::add((jint)CompactibleFreeListSpace::adjustObjectSize(obj->size()),
1350                 &_numWordsPromoted);
1351   )
1352 
1353   return obj;
1354 }
1355 
1356 void
1357 ConcurrentMarkSweepGeneration::
1358 par_promote_alloc_undo(int thread_num,
1359                        HeapWord* obj, size_t word_sz) {
1360   // CMS does not support promotion undo.
1361   ShouldNotReachHere();
1362 }
1363 
1364 void
1365 ConcurrentMarkSweepGeneration::
1366 par_promote_alloc_done(int thread_num) {
1367   CMSParGCThreadState* ps = _par_gc_thread_states[thread_num];
1368   ps->lab.retire();
1369 #if CFLS_LAB_REFILL_STATS
1370   if (thread_num == 0) {
1371     _cmsSpace->print_par_alloc_stats();
1372   }
1373 #endif
1374 }
1375 
1376 void
1377 ConcurrentMarkSweepGeneration::
1378 par_oop_since_save_marks_iterate_done(int thread_num) {
1379   CMSParGCThreadState* ps = _par_gc_thread_states[thread_num];
1380   ParScanWithoutBarrierClosure* dummy_cl = NULL;
1381   ps->promo.promoted_oops_iterate_nv(dummy_cl);
1382 }
1383 
1384 // XXXPERM
1385 bool ConcurrentMarkSweepGeneration::should_collect(bool   full,
1386                                                    size_t size,
1387                                                    bool   tlab)
1388 {
1389   // We allow a STW collection only if a full
1390   // collection was requested.
1391   return full || should_allocate(size, tlab); // FIX ME !!!
1392   // This and promotion failure handling are connected at the
1393   // hip and should be fixed by untying them.
1394 }
1395 
1396 bool CMSCollector::shouldConcurrentCollect() {
1397   if (_full_gc_requested) {
1398     assert(ExplicitGCInvokesConcurrent, "Unexpected state");
1399     if (Verbose && PrintGCDetails) {
1400       gclog_or_tty->print_cr("CMSCollector: collect because of explicit "
1401                              " gc request");
1402     }
1403     return true;
1404   }
1405 
1406   // For debugging purposes, change the type of collection.
1407   // If the rotation is not on the concurrent collection
1408   // type, don't start a concurrent collection.
1409   NOT_PRODUCT(
1410     if (RotateCMSCollectionTypes &&
1411         (_cmsGen->debug_collection_type() !=
1412           ConcurrentMarkSweepGeneration::Concurrent_collection_type)) {
1413       assert(_cmsGen->debug_collection_type() !=
1414         ConcurrentMarkSweepGeneration::Unknown_collection_type,
1415         "Bad cms collection type");
1416       return false;
1417     }
1418   )
1419 
1420   FreelistLocker x(this);
1421   // ------------------------------------------------------------------
1422   // Print out lots of information which affects the initiation of
1423   // a collection.
1424   if (PrintCMSInitiationStatistics && stats().valid()) {
1425     gclog_or_tty->print("CMSCollector shouldConcurrentCollect: ");
1426     gclog_or_tty->stamp();
1427     gclog_or_tty->print_cr("");
1428     stats().print_on(gclog_or_tty);
1429     gclog_or_tty->print_cr("time_until_cms_gen_full %3.7f",
1430       stats().time_until_cms_gen_full());
1431     gclog_or_tty->print_cr("free="SIZE_FORMAT, _cmsGen->free());
1432     gclog_or_tty->print_cr("contiguous_available="SIZE_FORMAT,
1433                            _cmsGen->contiguous_available());
1434     gclog_or_tty->print_cr("promotion_rate=%g", stats().promotion_rate());
1435     gclog_or_tty->print_cr("cms_allocation_rate=%g", stats().cms_allocation_rate());
1436     gclog_or_tty->print_cr("occupancy=%3.7f", _cmsGen->occupancy());
1437     gclog_or_tty->print_cr("initiatingOccupancy=%3.7f", _cmsGen->initiating_occupancy());
1438     gclog_or_tty->print_cr("initiatingPermOccupancy=%3.7f", _permGen->initiating_occupancy());
1439   }
1440   // ------------------------------------------------------------------
1441 
1442   // If the estimated time to complete a cms collection (cms_duration())
1443   // is less than the estimated time remaining until the cms generation
1444   // is full, start a collection.
1445   if (!UseCMSInitiatingOccupancyOnly) {
1446     if (stats().valid()) {
1447       if (stats().time_until_cms_start() == 0.0) {
1448         return true;
1449       }
1450     } else {
1451       // We want to conservatively collect somewhat early in order
1452       // to try and "bootstrap" our CMS/promotion statistics;
1453       // this branch will not fire after the first successful CMS
1454       // collection because the stats should then be valid.
1455       if (_cmsGen->occupancy() >= _bootstrap_occupancy) {
1456         if (Verbose && PrintGCDetails) {
1457           gclog_or_tty->print_cr(
1458             " CMSCollector: collect for bootstrapping statistics:"
1459             " occupancy = %f, boot occupancy = %f", _cmsGen->occupancy(),
1460             _bootstrap_occupancy);
1461         }
1462         return true;
1463       }
1464     }
1465   }
1466 
1467   // Otherwise, we start a collection cycle if either the perm gen or
1468   // old gen want a collection cycle started. Each may use
1469   // an appropriate criterion for making this decision.
1470   // XXX We need to make sure that the gen expansion
1471   // criterion dovetails well with this. XXX NEED TO FIX THIS
1472   if (_cmsGen->should_concurrent_collect()) {
1473     if (Verbose && PrintGCDetails) {
1474       gclog_or_tty->print_cr("CMS old gen initiated");
1475     }
1476     return true;
1477   }
1478 
1479   // We start a collection if we believe an incremental collection may fail;
1480   // this is not likely to be productive in practice because it's probably too
1481   // late anyway.
1482   GenCollectedHeap* gch = GenCollectedHeap::heap();
1483   assert(gch->collector_policy()->is_two_generation_policy(),
1484          "You may want to check the correctness of the following");
1485   if (gch->incremental_collection_will_fail()) {
1486     if (PrintGCDetails && Verbose) {
1487       gclog_or_tty->print("CMSCollector: collect because incremental collection will fail ");
1488     }
1489     return true;
1490   }
1491 
1492   if (CMSClassUnloadingEnabled && _permGen->should_concurrent_collect()) {
1493     bool res = update_should_unload_classes();
1494     if (res) {
1495       if (Verbose && PrintGCDetails) {
1496         gclog_or_tty->print_cr("CMS perm gen initiated");
1497       }
1498       return true;
1499     }
1500   }
1501   return false;
1502 }
1503 
1504 // Clear _expansion_cause fields of constituent generations
1505 void CMSCollector::clear_expansion_cause() {
1506   _cmsGen->clear_expansion_cause();
1507   _permGen->clear_expansion_cause();
1508 }
1509 
1510 // We should be conservative in starting a collection cycle.  To
1511 // start too eagerly runs the risk of collecting too often in the
1512 // extreme.  To collect too rarely falls back on full collections,
1513 // which works, even if not optimum in terms of concurrent work.
1514 // As a work around for too eagerly collecting, use the flag
1515 // UseCMSInitiatingOccupancyOnly.  This also has the advantage of
1516 // giving the user an easily understandable way of controlling the
1517 // collections.
1518 // We want to start a new collection cycle if any of the following
1519 // conditions hold:
1520 // . our current occupancy exceeds the configured initiating occupancy
1521 //   for this generation, or
1522 // . we recently needed to expand this space and have not, since that
1523 //   expansion, done a collection of this generation, or
1524 // . the underlying space believes that it may be a good idea to initiate
1525 //   a concurrent collection (this may be based on criteria such as the
1526 //   following: the space uses linear allocation and linear allocation is
1527 //   going to fail, or there is believed to be excessive fragmentation in
1528 //   the generation, etc... or ...
1529 // [.(currently done by CMSCollector::shouldConcurrentCollect() only for
1530 //   the case of the old generation, not the perm generation; see CR 6543076):
1531 //   we may be approaching a point at which allocation requests may fail because
1532 //   we will be out of sufficient free space given allocation rate estimates.]
1533 bool ConcurrentMarkSweepGeneration::should_concurrent_collect() const {
1534 
1535   assert_lock_strong(freelistLock());
1536   if (occupancy() > initiating_occupancy()) {
1537     if (PrintGCDetails && Verbose) {
1538       gclog_or_tty->print(" %s: collect because of occupancy %f / %f  ",
1539         short_name(), occupancy(), initiating_occupancy());
1540     }
1541     return true;
1542   }
1543   if (UseCMSInitiatingOccupancyOnly) {
1544     return false;
1545   }
1546   if (expansion_cause() == CMSExpansionCause::_satisfy_allocation) {
1547     if (PrintGCDetails && Verbose) {
1548       gclog_or_tty->print(" %s: collect because expanded for allocation ",
1549         short_name());
1550     }
1551     return true;
1552   }
1553   if (_cmsSpace->should_concurrent_collect()) {
1554     if (PrintGCDetails && Verbose) {
1555       gclog_or_tty->print(" %s: collect because cmsSpace says so ",
1556         short_name());
1557     }
1558     return true;
1559   }
1560   return false;
1561 }
1562 
1563 void ConcurrentMarkSweepGeneration::collect(bool   full,
1564                                             bool   clear_all_soft_refs,
1565                                             size_t size,
1566                                             bool   tlab)
1567 {
1568   collector()->collect(full, clear_all_soft_refs, size, tlab);
1569 }
1570 
1571 void CMSCollector::collect(bool   full,
1572                            bool   clear_all_soft_refs,
1573                            size_t size,
1574                            bool   tlab)
1575 {
1576   if (!UseCMSCollectionPassing && _collectorState > Idling) {
1577     // For debugging purposes skip the collection if the state
1578     // is not currently idle
1579     if (TraceCMSState) {
1580       gclog_or_tty->print_cr("Thread " INTPTR_FORMAT " skipped full:%d CMS state %d",
1581         Thread::current(), full, _collectorState);
1582     }
1583     return;
1584   }
1585 
1586   // The following "if" branch is present for defensive reasons.
1587   // In the current uses of this interface, it can be replaced with:
1588   // assert(!GC_locker.is_active(), "Can't be called otherwise");
1589   // But I am not placing that assert here to allow future
1590   // generality in invoking this interface.
1591   if (GC_locker::is_active()) {
1592     // A consistency test for GC_locker
1593     assert(GC_locker::needs_gc(), "Should have been set already");
1594     // Skip this foreground collection, instead
1595     // expanding the heap if necessary.
1596     // Need the free list locks for the call to free() in compute_new_size()
1597     compute_new_size();
1598     return;
1599   }
1600   acquire_control_and_collect(full, clear_all_soft_refs);
1601   _full_gcs_since_conc_gc++;
1602 
1603 }
1604 
1605 void CMSCollector::request_full_gc(unsigned int full_gc_count) {
1606   GenCollectedHeap* gch = GenCollectedHeap::heap();
1607   unsigned int gc_count = gch->total_full_collections();
1608   if (gc_count == full_gc_count) {
1609     MutexLockerEx y(CGC_lock, Mutex::_no_safepoint_check_flag);
1610     _full_gc_requested = true;
1611     CGC_lock->notify();   // nudge CMS thread
1612   }
1613 }
1614 
1615 
1616 // The foreground and background collectors need to coordinate in order
1617 // to make sure that they do not mutually interfere with CMS collections.
1618 // When a background collection is active,
1619 // the foreground collector may need to take over (preempt) and
1620 // synchronously complete an ongoing collection. Depending on the
1621 // frequency of the background collections and the heap usage
1622 // of the application, this preemption can be seldom or frequent.
1623 // There are only certain
1624 // points in the background collection that the "collection-baton"
1625 // can be passed to the foreground collector.
1626 //
1627 // The foreground collector will wait for the baton before
1628 // starting any part of the collection.  The foreground collector
1629 // will only wait at one location.
1630 //
1631 // The background collector will yield the baton before starting a new
1632 // phase of the collection (e.g., before initial marking, marking from roots,
1633 // precleaning, final re-mark, sweep etc.)  This is normally done at the head
1634 // of the loop which switches the phases. The background collector does some
1635 // of the phases (initial mark, final re-mark) with the world stopped.
1636 // Because of locking involved in stopping the world,
1637 // the foreground collector should not block waiting for the background
1638 // collector when it is doing a stop-the-world phase.  The background
1639 // collector will yield the baton at an additional point just before
1640 // it enters a stop-the-world phase.  Once the world is stopped, the
1641 // background collector checks the phase of the collection.  If the
1642 // phase has not changed, it proceeds with the collection.  If the
1643 // phase has changed, it skips that phase of the collection.  See
1644 // the comments on the use of the Heap_lock in collect_in_background().
1645 //
1646 // Variable used in baton passing.
1647 //   _foregroundGCIsActive - Set to true by the foreground collector when
1648 //      it wants the baton.  The foreground clears it when it has finished
1649 //      the collection.
1650 //   _foregroundGCShouldWait - Set to true by the background collector
1651 //        when it is running.  The foreground collector waits while
1652 //      _foregroundGCShouldWait is true.
1653 //  CGC_lock - monitor used to protect access to the above variables
1654 //      and to notify the foreground and background collectors.
1655 //  _collectorState - current state of the CMS collection.
1656 //
1657 // The foreground collector
1658 //   acquires the CGC_lock
1659 //   sets _foregroundGCIsActive
1660 //   waits on the CGC_lock for _foregroundGCShouldWait to be false
1661 //     various locks acquired in preparation for the collection
1662 //     are released so as not to block the background collector
1663 //     that is in the midst of a collection
1664 //   proceeds with the collection
1665 //   clears _foregroundGCIsActive
1666 //   returns
1667 //
1668 // The background collector in a loop iterating on the phases of the
1669 //      collection
1670 //   acquires the CGC_lock
1671 //   sets _foregroundGCShouldWait
1672 //   if _foregroundGCIsActive is set
1673 //     clears _foregroundGCShouldWait, notifies _CGC_lock
1674 //     waits on _CGC_lock for _foregroundGCIsActive to become false
1675 //     and exits the loop.
1676 //   otherwise
1677 //     proceed with that phase of the collection
1678 //     if the phase is a stop-the-world phase,
1679 //       yield the baton once more just before enqueueing
1680 //       the stop-world CMS operation (executed by the VM thread).
1681 //   returns after all phases of the collection are done
1682 //
1683 
1684 void CMSCollector::acquire_control_and_collect(bool full,
1685         bool clear_all_soft_refs) {
1686   assert(SafepointSynchronize::is_at_safepoint(), "should be at safepoint");
1687   assert(!Thread::current()->is_ConcurrentGC_thread(),
1688          "shouldn't try to acquire control from self!");
1689 
1690   // Start the protocol for acquiring control of the
1691   // collection from the background collector (aka CMS thread).
1692   assert(ConcurrentMarkSweepThread::vm_thread_has_cms_token(),
1693          "VM thread should have CMS token");
1694   // Remember the possibly interrupted state of an ongoing
1695   // concurrent collection
1696   CollectorState first_state = _collectorState;
1697 
1698   // Signal to a possibly ongoing concurrent collection that
1699   // we want to do a foreground collection.
1700   _foregroundGCIsActive = true;
1701 
1702   // Disable incremental mode during a foreground collection.
1703   ICMSDisabler icms_disabler;
1704 
1705   // release locks and wait for a notify from the background collector
1706   // releasing the locks in only necessary for phases which
1707   // do yields to improve the granularity of the collection.
1708   assert_lock_strong(bitMapLock());
1709   // We need to lock the Free list lock for the space that we are
1710   // currently collecting.
1711   assert(haveFreelistLocks(), "Must be holding free list locks");
1712   bitMapLock()->unlock();
1713   releaseFreelistLocks();
1714   {
1715     MutexLockerEx x(CGC_lock, Mutex::_no_safepoint_check_flag);
1716     if (_foregroundGCShouldWait) {
1717       // We are going to be waiting for action for the CMS thread;
1718       // it had better not be gone (for instance at shutdown)!
1719       assert(ConcurrentMarkSweepThread::cmst() != NULL,
1720              "CMS thread must be running");
1721       // Wait here until the background collector gives us the go-ahead
1722       ConcurrentMarkSweepThread::clear_CMS_flag(
1723         ConcurrentMarkSweepThread::CMS_vm_has_token);  // release token
1724       // Get a possibly blocked CMS thread going:
1725       //   Note that we set _foregroundGCIsActive true above,
1726       //   without protection of the CGC_lock.
1727       CGC_lock->notify();
1728       assert(!ConcurrentMarkSweepThread::vm_thread_wants_cms_token(),
1729              "Possible deadlock");
1730       while (_foregroundGCShouldWait) {
1731         // wait for notification
1732         CGC_lock->wait(Mutex::_no_safepoint_check_flag);
1733         // Possibility of delay/starvation here, since CMS token does
1734         // not know to give priority to VM thread? Actually, i think
1735         // there wouldn't be any delay/starvation, but the proof of
1736         // that "fact" (?) appears non-trivial. XXX 20011219YSR
1737       }
1738       ConcurrentMarkSweepThread::set_CMS_flag(
1739         ConcurrentMarkSweepThread::CMS_vm_has_token);
1740     }
1741   }
1742   // The CMS_token is already held.  Get back the other locks.
1743   assert(ConcurrentMarkSweepThread::vm_thread_has_cms_token(),
1744          "VM thread should have CMS token");
1745   getFreelistLocks();
1746   bitMapLock()->lock_without_safepoint_check();
1747   if (TraceCMSState) {
1748     gclog_or_tty->print_cr("CMS foreground collector has asked for control "
1749       INTPTR_FORMAT " with first state %d", Thread::current(), first_state);
1750     gclog_or_tty->print_cr("    gets control with state %d", _collectorState);
1751   }
1752 
1753   // Check if we need to do a compaction, or if not, whether
1754   // we need to start the mark-sweep from scratch.
1755   bool should_compact    = false;
1756   bool should_start_over = false;
1757   decide_foreground_collection_type(clear_all_soft_refs,
1758     &should_compact, &should_start_over);
1759 
1760 NOT_PRODUCT(
1761   if (RotateCMSCollectionTypes) {
1762     if (_cmsGen->debug_collection_type() ==
1763         ConcurrentMarkSweepGeneration::MSC_foreground_collection_type) {
1764       should_compact = true;
1765     } else if (_cmsGen->debug_collection_type() ==
1766                ConcurrentMarkSweepGeneration::MS_foreground_collection_type) {
1767       should_compact = false;
1768     }
1769   }
1770 )
1771 
1772   if (PrintGCDetails && first_state > Idling) {
1773     GCCause::Cause cause = GenCollectedHeap::heap()->gc_cause();
1774     if (GCCause::is_user_requested_gc(cause) ||
1775         GCCause::is_serviceability_requested_gc(cause)) {
1776       gclog_or_tty->print(" (concurrent mode interrupted)");
1777     } else {
1778       gclog_or_tty->print(" (concurrent mode failure)");
1779     }
1780   }
1781 
1782   if (should_compact) {
1783     // If the collection is being acquired from the background
1784     // collector, there may be references on the discovered
1785     // references lists that have NULL referents (being those
1786     // that were concurrently cleared by a mutator) or
1787     // that are no longer active (having been enqueued concurrently
1788     // by the mutator).
1789     // Scrub the list of those references because Mark-Sweep-Compact
1790     // code assumes referents are not NULL and that all discovered
1791     // Reference objects are active.
1792     ref_processor()->clean_up_discovered_references();
1793 
1794     do_compaction_work(clear_all_soft_refs);
1795 
1796     // Has the GC time limit been exceeded?
1797     check_gc_time_limit();
1798 
1799   } else {
1800     do_mark_sweep_work(clear_all_soft_refs, first_state,
1801       should_start_over);
1802   }
1803   // Reset the expansion cause, now that we just completed
1804   // a collection cycle.
1805   clear_expansion_cause();
1806   _foregroundGCIsActive = false;
1807   return;
1808 }
1809 
1810 void CMSCollector::check_gc_time_limit() {
1811 
1812   // Ignore explicit GC's.  Exiting here does not set the flag and
1813   // does not reset the count.  Updating of the averages for system
1814   // GC's is still controlled by UseAdaptiveSizePolicyWithSystemGC.
1815   GCCause::Cause gc_cause = GenCollectedHeap::heap()->gc_cause();
1816   if (GCCause::is_user_requested_gc(gc_cause) ||
1817       GCCause::is_serviceability_requested_gc(gc_cause)) {
1818     return;
1819   }
1820 
1821   // Calculate the fraction of the CMS generation was freed during
1822   // the last collection.
1823   // Only consider the STW compacting cost for now.
1824   //
1825   // Note that the gc time limit test only works for the collections
1826   // of the young gen + tenured gen and not for collections of the
1827   // permanent gen.  That is because the calculation of the space
1828   // freed by the collection is the free space in the young gen +
1829   // tenured gen.
1830 
1831   double fraction_free =
1832     ((double)_cmsGen->free())/((double)_cmsGen->max_capacity());
1833   if ((100.0 * size_policy()->compacting_gc_cost()) >
1834          ((double) GCTimeLimit) &&
1835         ((fraction_free * 100) < GCHeapFreeLimit)) {
1836     size_policy()->inc_gc_time_limit_count();
1837     if (UseGCOverheadLimit &&
1838         (size_policy()->gc_time_limit_count() >
1839          AdaptiveSizePolicyGCTimeLimitThreshold)) {
1840       size_policy()->set_gc_time_limit_exceeded(true);
1841       // Avoid consecutive OOM due to the gc time limit by resetting
1842       // the counter.
1843       size_policy()->reset_gc_time_limit_count();
1844       if (PrintGCDetails) {
1845         gclog_or_tty->print_cr("      GC is exceeding overhead limit "
1846           "of %d%%", GCTimeLimit);
1847       }
1848     } else {
1849       if (PrintGCDetails) {
1850         gclog_or_tty->print_cr("      GC would exceed overhead limit "
1851           "of %d%%", GCTimeLimit);
1852       }
1853     }
1854   } else {
1855     size_policy()->reset_gc_time_limit_count();
1856   }
1857 }
1858 
1859 // Resize the perm generation and the tenured generation
1860 // after obtaining the free list locks for the
1861 // two generations.
1862 void CMSCollector::compute_new_size() {
1863   assert_locked_or_safepoint(Heap_lock);
1864   FreelistLocker z(this);
1865   _permGen->compute_new_size();
1866   _cmsGen->compute_new_size();
1867 }
1868 
1869 // A work method used by foreground collection to determine
1870 // what type of collection (compacting or not, continuing or fresh)
1871 // it should do.
1872 // NOTE: the intent is to make UseCMSCompactAtFullCollection
1873 // and CMSCompactWhenClearAllSoftRefs the default in the future
1874 // and do away with the flags after a suitable period.
1875 void CMSCollector::decide_foreground_collection_type(
1876   bool clear_all_soft_refs, bool* should_compact,
1877   bool* should_start_over) {
1878   // Normally, we'll compact only if the UseCMSCompactAtFullCollection
1879   // flag is set, and we have either requested a System.gc() or
1880   // the number of full gc's since the last concurrent cycle
1881   // has exceeded the threshold set by CMSFullGCsBeforeCompaction,
1882   // or if an incremental collection has failed
1883   GenCollectedHeap* gch = GenCollectedHeap::heap();
1884   assert(gch->collector_policy()->is_two_generation_policy(),
1885          "You may want to check the correctness of the following");
1886   // Inform cms gen if this was due to partial collection failing.
1887   // The CMS gen may use this fact to determine its expansion policy.
1888   if (gch->incremental_collection_will_fail()) {
1889     assert(!_cmsGen->incremental_collection_failed(),
1890            "Should have been noticed, reacted to and cleared");
1891     _cmsGen->set_incremental_collection_failed();
1892   }
1893   *should_compact =
1894     UseCMSCompactAtFullCollection &&
1895     ((_full_gcs_since_conc_gc >= CMSFullGCsBeforeCompaction) ||
1896      GCCause::is_user_requested_gc(gch->gc_cause()) ||
1897      gch->incremental_collection_will_fail());
1898   *should_start_over = false;
1899   if (clear_all_soft_refs && !*should_compact) {
1900     // We are about to do a last ditch collection attempt
1901     // so it would normally make sense to do a compaction
1902     // to reclaim as much space as possible.
1903     if (CMSCompactWhenClearAllSoftRefs) {
1904       // Default: The rationale is that in this case either
1905       // we are past the final marking phase, in which case
1906       // we'd have to start over, or so little has been done
1907       // that there's little point in saving that work. Compaction
1908       // appears to be the sensible choice in either case.
1909       *should_compact = true;
1910     } else {
1911       // We have been asked to clear all soft refs, but not to
1912       // compact. Make sure that we aren't past the final checkpoint
1913       // phase, for that is where we process soft refs. If we are already
1914       // past that phase, we'll need to redo the refs discovery phase and
1915       // if necessary clear soft refs that weren't previously
1916       // cleared. We do so by remembering the phase in which
1917       // we came in, and if we are past the refs processing
1918       // phase, we'll choose to just redo the mark-sweep
1919       // collection from scratch.
1920       if (_collectorState > FinalMarking) {
1921         // We are past the refs processing phase;
1922         // start over and do a fresh synchronous CMS cycle
1923         _collectorState = Resetting; // skip to reset to start new cycle
1924         reset(false /* == !asynch */);
1925         *should_start_over = true;
1926       } // else we can continue a possibly ongoing current cycle
1927     }
1928   }
1929 }
1930 
1931 // A work method used by the foreground collector to do
1932 // a mark-sweep-compact.
1933 void CMSCollector::do_compaction_work(bool clear_all_soft_refs) {
1934   GenCollectedHeap* gch = GenCollectedHeap::heap();
1935   TraceTime t("CMS:MSC ", PrintGCDetails && Verbose, true, gclog_or_tty);
1936   if (PrintGC && Verbose && !(GCCause::is_user_requested_gc(gch->gc_cause()))) {
1937     gclog_or_tty->print_cr("Compact ConcurrentMarkSweepGeneration after %d "
1938       "collections passed to foreground collector", _full_gcs_since_conc_gc);
1939   }
1940 
1941   // Sample collection interval time and reset for collection pause.
1942   if (UseAdaptiveSizePolicy) {
1943     size_policy()->msc_collection_begin();
1944   }
1945 
1946   // Temporarily widen the span of the weak reference processing to
1947   // the entire heap.
1948   MemRegion new_span(GenCollectedHeap::heap()->reserved_region());
1949   ReferenceProcessorSpanMutator x(ref_processor(), new_span);
1950 
1951   // Temporarily, clear the "is_alive_non_header" field of the
1952   // reference processor.
1953   ReferenceProcessorIsAliveMutator y(ref_processor(), NULL);
1954 
1955   // Temporarily make reference _processing_ single threaded (non-MT).
1956   ReferenceProcessorMTProcMutator z(ref_processor(), false);
1957 
1958   // Temporarily make refs discovery atomic
1959   ReferenceProcessorAtomicMutator w(ref_processor(), true);
1960 
1961   ref_processor()->set_enqueuing_is_done(false);
1962   ref_processor()->enable_discovery();
1963   ref_processor()->snap_policy(clear_all_soft_refs);
1964   // If an asynchronous collection finishes, the _modUnionTable is
1965   // all clear.  If we are assuming the collection from an asynchronous
1966   // collection, clear the _modUnionTable.
1967   assert(_collectorState != Idling || _modUnionTable.isAllClear(),
1968     "_modUnionTable should be clear if the baton was not passed");
1969   _modUnionTable.clear_all();
1970 
1971   // We must adjust the allocation statistics being maintained
1972   // in the free list space. We do so by reading and clearing
1973   // the sweep timer and updating the block flux rate estimates below.
1974   assert(_sweep_timer.is_active(), "We should never see the timer inactive");
1975   _sweep_timer.stop();
1976   // Note that we do not use this sample to update the _sweep_estimate.
1977   _cmsGen->cmsSpace()->beginSweepFLCensus((float)(_sweep_timer.seconds()),
1978                                           _sweep_estimate.padded_average());
1979 
1980   GenMarkSweep::invoke_at_safepoint(_cmsGen->level(),
1981     ref_processor(), clear_all_soft_refs);
1982   #ifdef ASSERT
1983     CompactibleFreeListSpace* cms_space = _cmsGen->cmsSpace();
1984     size_t free_size = cms_space->free();
1985     assert(free_size ==
1986            pointer_delta(cms_space->end(), cms_space->compaction_top())
1987            * HeapWordSize,
1988       "All the free space should be compacted into one chunk at top");
1989     assert(cms_space->dictionary()->totalChunkSize(
1990                                       debug_only(cms_space->freelistLock())) == 0 ||
1991            cms_space->totalSizeInIndexedFreeLists() == 0,
1992       "All the free space should be in a single chunk");
1993     size_t num = cms_space->totalCount();
1994     assert((free_size == 0 && num == 0) ||
1995            (free_size > 0  && (num == 1 || num == 2)),
1996          "There should be at most 2 free chunks after compaction");
1997   #endif // ASSERT
1998   _collectorState = Resetting;
1999   assert(_restart_addr == NULL,
2000          "Should have been NULL'd before baton was passed");
2001   reset(false /* == !asynch */);
2002   _cmsGen->reset_after_compaction();
2003   _concurrent_cycles_since_last_unload = 0;
2004 
2005   if (verifying() && !should_unload_classes()) {
2006     perm_gen_verify_bit_map()->clear_all();
2007   }
2008 
2009   // Clear any data recorded in the PLAB chunk arrays.
2010   if (_survivor_plab_array != NULL) {
2011     reset_survivor_plab_arrays();
2012   }
2013 
2014   // Adjust the per-size allocation stats for the next epoch.
2015   _cmsGen->cmsSpace()->endSweepFLCensus(sweepCount() /* fake */);
2016   // Restart the "sweep timer" for next epoch.
2017   _sweep_timer.reset();
2018   _sweep_timer.start();
2019 
2020   // Sample collection pause time and reset for collection interval.
2021   if (UseAdaptiveSizePolicy) {
2022     size_policy()->msc_collection_end(gch->gc_cause());
2023   }
2024 
2025   // For a mark-sweep-compact, compute_new_size() will be called
2026   // in the heap's do_collection() method.
2027 }
2028 
2029 // A work method used by the foreground collector to do
2030 // a mark-sweep, after taking over from a possibly on-going
2031 // concurrent mark-sweep collection.
2032 void CMSCollector::do_mark_sweep_work(bool clear_all_soft_refs,
2033   CollectorState first_state, bool should_start_over) {
2034   if (PrintGC && Verbose) {
2035     gclog_or_tty->print_cr("Pass concurrent collection to foreground "
2036       "collector with count %d",
2037       _full_gcs_since_conc_gc);
2038   }
2039   switch (_collectorState) {
2040     case Idling:
2041       if (first_state == Idling || should_start_over) {
2042         // The background GC was not active, or should
2043         // restarted from scratch;  start the cycle.
2044         _collectorState = InitialMarking;
2045       }
2046       // If first_state was not Idling, then a background GC
2047       // was in progress and has now finished.  No need to do it
2048       // again.  Leave the state as Idling.
2049       break;
2050     case Precleaning:
2051       // In the foreground case don't do the precleaning since
2052       // it is not done concurrently and there is extra work
2053       // required.
2054       _collectorState = FinalMarking;
2055   }
2056   if (PrintGCDetails &&
2057       (_collectorState > Idling ||
2058        !GCCause::is_user_requested_gc(GenCollectedHeap::heap()->gc_cause()))) {
2059     gclog_or_tty->print(" (concurrent mode failure)");
2060   }
2061   collect_in_foreground(clear_all_soft_refs);
2062 
2063   // For a mark-sweep, compute_new_size() will be called
2064   // in the heap's do_collection() method.
2065 }
2066 
2067 
2068 void CMSCollector::getFreelistLocks() const {
2069   // Get locks for all free lists in all generations that this
2070   // collector is responsible for
2071   _cmsGen->freelistLock()->lock_without_safepoint_check();
2072   _permGen->freelistLock()->lock_without_safepoint_check();
2073 }
2074 
2075 void CMSCollector::releaseFreelistLocks() const {
2076   // Release locks for all free lists in all generations that this
2077   // collector is responsible for
2078   _cmsGen->freelistLock()->unlock();
2079   _permGen->freelistLock()->unlock();
2080 }
2081 
2082 bool CMSCollector::haveFreelistLocks() const {
2083   // Check locks for all free lists in all generations that this
2084   // collector is responsible for
2085   assert_lock_strong(_cmsGen->freelistLock());
2086   assert_lock_strong(_permGen->freelistLock());
2087   PRODUCT_ONLY(ShouldNotReachHere());
2088   return true;
2089 }
2090 
2091 // A utility class that is used by the CMS collector to
2092 // temporarily "release" the foreground collector from its
2093 // usual obligation to wait for the background collector to
2094 // complete an ongoing phase before proceeding.
2095 class ReleaseForegroundGC: public StackObj {
2096  private:
2097   CMSCollector* _c;
2098  public:
2099   ReleaseForegroundGC(CMSCollector* c) : _c(c) {
2100     assert(_c->_foregroundGCShouldWait, "Else should not need to call");
2101     MutexLockerEx x(CGC_lock, Mutex::_no_safepoint_check_flag);
2102     // allow a potentially blocked foreground collector to proceed
2103     _c->_foregroundGCShouldWait = false;
2104     if (_c->_foregroundGCIsActive) {
2105       CGC_lock->notify();
2106     }
2107     assert(!ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
2108            "Possible deadlock");
2109   }
2110 
2111   ~ReleaseForegroundGC() {
2112     assert(!_c->_foregroundGCShouldWait, "Usage protocol violation?");
2113     MutexLockerEx x(CGC_lock, Mutex::_no_safepoint_check_flag);
2114     _c->_foregroundGCShouldWait = true;
2115   }
2116 };
2117 
2118 // There are separate collect_in_background and collect_in_foreground because of
2119 // the different locking requirements of the background collector and the
2120 // foreground collector.  There was originally an attempt to share
2121 // one "collect" method between the background collector and the foreground
2122 // collector but the if-then-else required made it cleaner to have
2123 // separate methods.
2124 void CMSCollector::collect_in_background(bool clear_all_soft_refs) {
2125   assert(Thread::current()->is_ConcurrentGC_thread(),
2126     "A CMS asynchronous collection is only allowed on a CMS thread.");
2127 
2128   GenCollectedHeap* gch = GenCollectedHeap::heap();
2129   {
2130     bool safepoint_check = Mutex::_no_safepoint_check_flag;
2131     MutexLockerEx hl(Heap_lock, safepoint_check);
2132     FreelistLocker fll(this);
2133     MutexLockerEx x(CGC_lock, safepoint_check);
2134     if (_foregroundGCIsActive || !UseAsyncConcMarkSweepGC) {
2135       // The foreground collector is active or we're
2136       // not using asynchronous collections.  Skip this
2137       // background collection.
2138       assert(!_foregroundGCShouldWait, "Should be clear");
2139       return;
2140     } else {
2141       assert(_collectorState == Idling, "Should be idling before start.");
2142       _collectorState = InitialMarking;
2143       // Reset the expansion cause, now that we are about to begin
2144       // a new cycle.
2145       clear_expansion_cause();
2146     }
2147     // Decide if we want to enable class unloading as part of the
2148     // ensuing concurrent GC cycle.
2149     update_should_unload_classes();
2150     _full_gc_requested = false;           // acks all outstanding full gc requests
2151     // Signal that we are about to start a collection
2152     gch->increment_total_full_collections();  // ... starting a collection cycle
2153     _collection_count_start = gch->total_full_collections();
2154   }
2155 
2156   // Used for PrintGC
2157   size_t prev_used;
2158   if (PrintGC && Verbose) {
2159     prev_used = _cmsGen->used(); // XXXPERM
2160   }
2161 
2162   // The change of the collection state is normally done at this level;
2163   // the exceptions are phases that are executed while the world is
2164   // stopped.  For those phases the change of state is done while the
2165   // world is stopped.  For baton passing purposes this allows the
2166   // background collector to finish the phase and change state atomically.
2167   // The foreground collector cannot wait on a phase that is done
2168   // while the world is stopped because the foreground collector already
2169   // has the world stopped and would deadlock.
2170   while (_collectorState != Idling) {
2171     if (TraceCMSState) {
2172       gclog_or_tty->print_cr("Thread " INTPTR_FORMAT " in CMS state %d",
2173         Thread::current(), _collectorState);
2174     }
2175     // The foreground collector
2176     //   holds the Heap_lock throughout its collection.
2177     //   holds the CMS token (but not the lock)
2178     //     except while it is waiting for the background collector to yield.
2179     //
2180     // The foreground collector should be blocked (not for long)
2181     //   if the background collector is about to start a phase
2182     //   executed with world stopped.  If the background
2183     //   collector has already started such a phase, the
2184     //   foreground collector is blocked waiting for the
2185     //   Heap_lock.  The stop-world phases (InitialMarking and FinalMarking)
2186     //   are executed in the VM thread.
2187     //
2188     // The locking order is
2189     //   PendingListLock (PLL)  -- if applicable (FinalMarking)
2190     //   Heap_lock  (both this & PLL locked in VM_CMS_Operation::prologue())
2191     //   CMS token  (claimed in
2192     //                stop_world_and_do() -->
2193     //                  safepoint_synchronize() -->
2194     //                    CMSThread::synchronize())
2195 
2196     {
2197       // Check if the FG collector wants us to yield.
2198       CMSTokenSync x(true); // is cms thread
2199       if (waitForForegroundGC()) {
2200         // We yielded to a foreground GC, nothing more to be
2201         // done this round.
2202         assert(_foregroundGCShouldWait == false, "We set it to false in "
2203                "waitForForegroundGC()");
2204         if (TraceCMSState) {
2205           gclog_or_tty->print_cr("CMS Thread " INTPTR_FORMAT
2206             " exiting collection CMS state %d",
2207             Thread::current(), _collectorState);
2208         }
2209         return;
2210       } else {
2211         // The background collector can run but check to see if the
2212         // foreground collector has done a collection while the
2213         // background collector was waiting to get the CGC_lock
2214         // above.  If yes, break so that _foregroundGCShouldWait
2215         // is cleared before returning.
2216         if (_collectorState == Idling) {
2217           break;
2218         }
2219       }
2220     }
2221 
2222     assert(_foregroundGCShouldWait, "Foreground collector, if active, "
2223       "should be waiting");
2224 
2225     switch (_collectorState) {
2226       case InitialMarking:
2227         {
2228           ReleaseForegroundGC x(this);
2229           stats().record_cms_begin();
2230 
2231           VM_CMS_Initial_Mark initial_mark_op(this);
2232           VMThread::execute(&initial_mark_op);
2233         }
2234         // The collector state may be any legal state at this point
2235         // since the background collector may have yielded to the
2236         // foreground collector.
2237         break;
2238       case Marking:
2239         // initial marking in checkpointRootsInitialWork has been completed
2240         if (markFromRoots(true)) { // we were successful
2241           assert(_collectorState == Precleaning, "Collector state should "
2242             "have changed");
2243         } else {
2244           assert(_foregroundGCIsActive, "Internal state inconsistency");
2245         }
2246         break;
2247       case Precleaning:
2248         if (UseAdaptiveSizePolicy) {
2249           size_policy()->concurrent_precleaning_begin();
2250         }
2251         // marking from roots in markFromRoots has been completed
2252         preclean();
2253         if (UseAdaptiveSizePolicy) {
2254           size_policy()->concurrent_precleaning_end();
2255         }
2256         assert(_collectorState == AbortablePreclean ||
2257                _collectorState == FinalMarking,
2258                "Collector state should have changed");
2259         break;
2260       case AbortablePreclean:
2261         if (UseAdaptiveSizePolicy) {
2262         size_policy()->concurrent_phases_resume();
2263         }
2264         abortable_preclean();
2265         if (UseAdaptiveSizePolicy) {
2266           size_policy()->concurrent_precleaning_end();
2267         }
2268         assert(_collectorState == FinalMarking, "Collector state should "
2269           "have changed");
2270         break;
2271       case FinalMarking:
2272         {
2273           ReleaseForegroundGC x(this);
2274 
2275           VM_CMS_Final_Remark final_remark_op(this);
2276           VMThread::execute(&final_remark_op);
2277           }
2278         assert(_foregroundGCShouldWait, "block post-condition");
2279         break;
2280       case Sweeping:
2281         if (UseAdaptiveSizePolicy) {
2282           size_policy()->concurrent_sweeping_begin();
2283         }
2284         // final marking in checkpointRootsFinal has been completed
2285         sweep(true);
2286         assert(_collectorState == Resizing, "Collector state change "
2287           "to Resizing must be done under the free_list_lock");
2288         _full_gcs_since_conc_gc = 0;
2289 
2290         // Stop the timers for adaptive size policy for the concurrent phases
2291         if (UseAdaptiveSizePolicy) {
2292           size_policy()->concurrent_sweeping_end();
2293           size_policy()->concurrent_phases_end(gch->gc_cause(),
2294                                              gch->prev_gen(_cmsGen)->capacity(),
2295                                              _cmsGen->free());
2296         }
2297 
2298       case Resizing: {
2299         // Sweeping has been completed...
2300         // At this point the background collection has completed.
2301         // Don't move the call to compute_new_size() down
2302         // into code that might be executed if the background
2303         // collection was preempted.
2304         {
2305           ReleaseForegroundGC x(this);   // unblock FG collection
2306           MutexLockerEx       y(Heap_lock, Mutex::_no_safepoint_check_flag);
2307           CMSTokenSync        z(true);   // not strictly needed.
2308           if (_collectorState == Resizing) {
2309             compute_new_size();
2310             _collectorState = Resetting;
2311           } else {
2312             assert(_collectorState == Idling, "The state should only change"
2313                    " because the foreground collector has finished the collection");
2314           }
2315         }
2316         break;
2317       }
2318       case Resetting:
2319         // CMS heap resizing has been completed
2320         reset(true);
2321         assert(_collectorState == Idling, "Collector state should "
2322           "have changed");
2323         stats().record_cms_end();
2324         // Don't move the concurrent_phases_end() and compute_new_size()
2325         // calls to here because a preempted background collection
2326         // has it's state set to "Resetting".
2327         break;
2328       case Idling:
2329       default:
2330         ShouldNotReachHere();
2331         break;
2332     }
2333     if (TraceCMSState) {
2334       gclog_or_tty->print_cr("  Thread " INTPTR_FORMAT " done - next CMS state %d",
2335         Thread::current(), _collectorState);
2336     }
2337     assert(_foregroundGCShouldWait, "block post-condition");
2338   }
2339 
2340   // Should this be in gc_epilogue?
2341   collector_policy()->counters()->update_counters();
2342 
2343   {
2344     // Clear _foregroundGCShouldWait and, in the event that the
2345     // foreground collector is waiting, notify it, before
2346     // returning.
2347     MutexLockerEx x(CGC_lock, Mutex::_no_safepoint_check_flag);
2348     _foregroundGCShouldWait = false;
2349     if (_foregroundGCIsActive) {
2350       CGC_lock->notify();
2351     }
2352     assert(!ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
2353            "Possible deadlock");
2354   }
2355   if (TraceCMSState) {
2356     gclog_or_tty->print_cr("CMS Thread " INTPTR_FORMAT
2357       " exiting collection CMS state %d",
2358       Thread::current(), _collectorState);
2359   }
2360   if (PrintGC && Verbose) {
2361     _cmsGen->print_heap_change(prev_used);
2362   }
2363 }
2364 
2365 void CMSCollector::collect_in_foreground(bool clear_all_soft_refs) {
2366   assert(_foregroundGCIsActive && !_foregroundGCShouldWait,
2367          "Foreground collector should be waiting, not executing");
2368   assert(Thread::current()->is_VM_thread(), "A foreground collection"
2369     "may only be done by the VM Thread with the world stopped");
2370   assert(ConcurrentMarkSweepThread::vm_thread_has_cms_token(),
2371          "VM thread should have CMS token");
2372 
2373   NOT_PRODUCT(TraceTime t("CMS:MS (foreground) ", PrintGCDetails && Verbose,
2374     true, gclog_or_tty);)
2375   if (UseAdaptiveSizePolicy) {
2376     size_policy()->ms_collection_begin();
2377   }
2378   COMPILER2_PRESENT(DerivedPointerTableDeactivate dpt_deact);
2379 
2380   HandleMark hm;  // Discard invalid handles created during verification
2381 
2382   if (VerifyBeforeGC &&
2383       GenCollectedHeap::heap()->total_collections() >= VerifyGCStartAt) {
2384     Universe::verify(true);
2385   }
2386 
2387   // Snapshot the soft reference policy to be used in this collection cycle.
2388   ref_processor()->snap_policy(clear_all_soft_refs);
2389 
2390   bool init_mark_was_synchronous = false; // until proven otherwise
2391   while (_collectorState != Idling) {
2392     if (TraceCMSState) {
2393       gclog_or_tty->print_cr("Thread " INTPTR_FORMAT " in CMS state %d",
2394         Thread::current(), _collectorState);
2395     }
2396     switch (_collectorState) {
2397       case InitialMarking:
2398         init_mark_was_synchronous = true;  // fact to be exploited in re-mark
2399         checkpointRootsInitial(false);
2400         assert(_collectorState == Marking, "Collector state should have changed"
2401           " within checkpointRootsInitial()");
2402         break;
2403       case Marking:
2404         // initial marking in checkpointRootsInitialWork has been completed
2405         if (VerifyDuringGC &&
2406             GenCollectedHeap::heap()->total_collections() >= VerifyGCStartAt) {
2407           gclog_or_tty->print("Verify before initial mark: ");
2408           Universe::verify(true);
2409         }
2410         {
2411           bool res = markFromRoots(false);
2412           assert(res && _collectorState == FinalMarking, "Collector state should "
2413             "have changed");
2414           break;
2415         }
2416       case FinalMarking:
2417         if (VerifyDuringGC &&
2418             GenCollectedHeap::heap()->total_collections() >= VerifyGCStartAt) {
2419           gclog_or_tty->print("Verify before re-mark: ");
2420           Universe::verify(true);
2421         }
2422         checkpointRootsFinal(false, clear_all_soft_refs,
2423                              init_mark_was_synchronous);
2424         assert(_collectorState == Sweeping, "Collector state should not "
2425           "have changed within checkpointRootsFinal()");
2426         break;
2427       case Sweeping:
2428         // final marking in checkpointRootsFinal has been completed
2429         if (VerifyDuringGC &&
2430             GenCollectedHeap::heap()->total_collections() >= VerifyGCStartAt) {
2431           gclog_or_tty->print("Verify before sweep: ");
2432           Universe::verify(true);
2433         }
2434         sweep(false);
2435         assert(_collectorState == Resizing, "Incorrect state");
2436         break;
2437       case Resizing: {
2438         // Sweeping has been completed; the actual resize in this case
2439         // is done separately; nothing to be done in this state.
2440         _collectorState = Resetting;
2441         break;
2442       }
2443       case Resetting:
2444         // The heap has been resized.
2445         if (VerifyDuringGC &&
2446             GenCollectedHeap::heap()->total_collections() >= VerifyGCStartAt) {
2447           gclog_or_tty->print("Verify before reset: ");
2448           Universe::verify(true);
2449         }
2450         reset(false);
2451         assert(_collectorState == Idling, "Collector state should "
2452           "have changed");
2453         break;
2454       case Precleaning:
2455       case AbortablePreclean:
2456         // Elide the preclean phase
2457         _collectorState = FinalMarking;
2458         break;
2459       default:
2460         ShouldNotReachHere();
2461     }
2462     if (TraceCMSState) {
2463       gclog_or_tty->print_cr("  Thread " INTPTR_FORMAT " done - next CMS state %d",
2464         Thread::current(), _collectorState);
2465     }
2466   }
2467 
2468   if (UseAdaptiveSizePolicy) {
2469     GenCollectedHeap* gch = GenCollectedHeap::heap();
2470     size_policy()->ms_collection_end(gch->gc_cause());
2471   }
2472 
2473   if (VerifyAfterGC &&
2474       GenCollectedHeap::heap()->total_collections() >= VerifyGCStartAt) {
2475     Universe::verify(true);
2476   }
2477   if (TraceCMSState) {
2478     gclog_or_tty->print_cr("CMS Thread " INTPTR_FORMAT
2479       " exiting collection CMS state %d",
2480       Thread::current(), _collectorState);
2481   }
2482 }
2483 
2484 bool CMSCollector::waitForForegroundGC() {
2485   bool res = false;
2486   assert(ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
2487          "CMS thread should have CMS token");
2488   // Block the foreground collector until the
2489   // background collectors decides whether to
2490   // yield.
2491   MutexLockerEx x(CGC_lock, Mutex::_no_safepoint_check_flag);
2492   _foregroundGCShouldWait = true;
2493   if (_foregroundGCIsActive) {
2494     // The background collector yields to the
2495     // foreground collector and returns a value
2496     // indicating that it has yielded.  The foreground
2497     // collector can proceed.
2498     res = true;
2499     _foregroundGCShouldWait = false;
2500     ConcurrentMarkSweepThread::clear_CMS_flag(
2501       ConcurrentMarkSweepThread::CMS_cms_has_token);
2502     ConcurrentMarkSweepThread::set_CMS_flag(
2503       ConcurrentMarkSweepThread::CMS_cms_wants_token);
2504     // Get a possibly blocked foreground thread going
2505     CGC_lock->notify();
2506     if (TraceCMSState) {
2507       gclog_or_tty->print_cr("CMS Thread " INTPTR_FORMAT " waiting at CMS state %d",
2508         Thread::current(), _collectorState);
2509     }
2510     while (_foregroundGCIsActive) {
2511       CGC_lock->wait(Mutex::_no_safepoint_check_flag);
2512     }
2513     ConcurrentMarkSweepThread::set_CMS_flag(
2514       ConcurrentMarkSweepThread::CMS_cms_has_token);
2515     ConcurrentMarkSweepThread::clear_CMS_flag(
2516       ConcurrentMarkSweepThread::CMS_cms_wants_token);
2517   }
2518   if (TraceCMSState) {
2519     gclog_or_tty->print_cr("CMS Thread " INTPTR_FORMAT " continuing at CMS state %d",
2520       Thread::current(), _collectorState);
2521   }
2522   return res;
2523 }
2524 
2525 // Because of the need to lock the free lists and other structures in
2526 // the collector, common to all the generations that the collector is
2527 // collecting, we need the gc_prologues of individual CMS generations
2528 // delegate to their collector. It may have been simpler had the
2529 // current infrastructure allowed one to call a prologue on a
2530 // collector. In the absence of that we have the generation's
2531 // prologue delegate to the collector, which delegates back
2532 // some "local" work to a worker method in the individual generations
2533 // that it's responsible for collecting, while itself doing any
2534 // work common to all generations it's responsible for. A similar
2535 // comment applies to the  gc_epilogue()'s.
2536 // The role of the varaible _between_prologue_and_epilogue is to
2537 // enforce the invocation protocol.
2538 void CMSCollector::gc_prologue(bool full) {
2539   // Call gc_prologue_work() for each CMSGen and PermGen that
2540   // we are responsible for.
2541 
2542   // The following locking discipline assumes that we are only called
2543   // when the world is stopped.
2544   assert(SafepointSynchronize::is_at_safepoint(), "world is stopped assumption");
2545 
2546   // The CMSCollector prologue must call the gc_prologues for the
2547   // "generations" (including PermGen if any) that it's responsible
2548   // for.
2549 
2550   assert(   Thread::current()->is_VM_thread()
2551          || (   CMSScavengeBeforeRemark
2552              && Thread::current()->is_ConcurrentGC_thread()),
2553          "Incorrect thread type for prologue execution");
2554 
2555   if (_between_prologue_and_epilogue) {
2556     // We have already been invoked; this is a gc_prologue delegation
2557     // from yet another CMS generation that we are responsible for, just
2558     // ignore it since all relevant work has already been done.
2559     return;
2560   }
2561 
2562   // set a bit saying prologue has been called; cleared in epilogue
2563   _between_prologue_and_epilogue = true;
2564   // Claim locks for common data structures, then call gc_prologue_work()
2565   // for each CMSGen and PermGen that we are responsible for.
2566 
2567   getFreelistLocks();   // gets free list locks on constituent spaces
2568   bitMapLock()->lock_without_safepoint_check();
2569 
2570   // Should call gc_prologue_work() for all cms gens we are responsible for
2571   bool registerClosure =    _collectorState >= Marking
2572                          && _collectorState < Sweeping;
2573   ModUnionClosure* muc = ParallelGCThreads > 0 ? &_modUnionClosurePar
2574                                                : &_modUnionClosure;
2575   _cmsGen->gc_prologue_work(full, registerClosure, muc);
2576   _permGen->gc_prologue_work(full, registerClosure, muc);
2577 
2578   if (!full) {
2579     stats().record_gc0_begin();
2580   }
2581 }
2582 
2583 void ConcurrentMarkSweepGeneration::gc_prologue(bool full) {
2584   // Delegate to CMScollector which knows how to coordinate between
2585   // this and any other CMS generations that it is responsible for
2586   // collecting.
2587   collector()->gc_prologue(full);
2588 }
2589 
2590 // This is a "private" interface for use by this generation's CMSCollector.
2591 // Not to be called directly by any other entity (for instance,
2592 // GenCollectedHeap, which calls the "public" gc_prologue method above).
2593 void ConcurrentMarkSweepGeneration::gc_prologue_work(bool full,
2594   bool registerClosure, ModUnionClosure* modUnionClosure) {
2595   assert(!incremental_collection_failed(), "Shouldn't be set yet");
2596   assert(cmsSpace()->preconsumptionDirtyCardClosure() == NULL,
2597     "Should be NULL");
2598   if (registerClosure) {
2599     cmsSpace()->setPreconsumptionDirtyCardClosure(modUnionClosure);
2600   }
2601   cmsSpace()->gc_prologue();
2602   // Clear stat counters
2603   NOT_PRODUCT(
2604     assert(_numObjectsPromoted == 0, "check");
2605     assert(_numWordsPromoted   == 0, "check");
2606     if (Verbose && PrintGC) {
2607       gclog_or_tty->print("Allocated "SIZE_FORMAT" objects, "
2608                           SIZE_FORMAT" bytes concurrently",
2609       _numObjectsAllocated, _numWordsAllocated*sizeof(HeapWord));
2610     }
2611     _numObjectsAllocated = 0;
2612     _numWordsAllocated   = 0;
2613   )
2614 }
2615 
2616 void CMSCollector::gc_epilogue(bool full) {
2617   // The following locking discipline assumes that we are only called
2618   // when the world is stopped.
2619   assert(SafepointSynchronize::is_at_safepoint(),
2620          "world is stopped assumption");
2621 
2622   // Currently the CMS epilogue (see CompactibleFreeListSpace) merely checks
2623   // if linear allocation blocks need to be appropriately marked to allow the
2624   // the blocks to be parsable. We also check here whether we need to nudge the
2625   // CMS collector thread to start a new cycle (if it's not already active).
2626   assert(   Thread::current()->is_VM_thread()
2627          || (   CMSScavengeBeforeRemark
2628              && Thread::current()->is_ConcurrentGC_thread()),
2629          "Incorrect thread type for epilogue execution");
2630 
2631   if (!_between_prologue_and_epilogue) {
2632     // We have already been invoked; this is a gc_epilogue delegation
2633     // from yet another CMS generation that we are responsible for, just
2634     // ignore it since all relevant work has already been done.
2635     return;
2636   }
2637   assert(haveFreelistLocks(), "must have freelist locks");
2638   assert_lock_strong(bitMapLock());
2639 
2640   _cmsGen->gc_epilogue_work(full);
2641   _permGen->gc_epilogue_work(full);
2642 
2643   if (_collectorState == AbortablePreclean || _collectorState == Precleaning) {
2644     // in case sampling was not already enabled, enable it
2645     _start_sampling = true;
2646   }
2647   // reset _eden_chunk_array so sampling starts afresh
2648   _eden_chunk_index = 0;
2649 
2650   size_t cms_used   = _cmsGen->cmsSpace()->used();
2651   size_t perm_used  = _permGen->cmsSpace()->used();
2652 
2653   // update performance counters - this uses a special version of
2654   // update_counters() that allows the utilization to be passed as a
2655   // parameter, avoiding multiple calls to used().
2656   //
2657   _cmsGen->update_counters(cms_used);
2658   _permGen->update_counters(perm_used);
2659 
2660   if (CMSIncrementalMode) {
2661     icms_update_allocation_limits();
2662   }
2663 
2664   bitMapLock()->unlock();
2665   releaseFreelistLocks();
2666 
2667   _between_prologue_and_epilogue = false;  // ready for next cycle
2668 }
2669 
2670 void ConcurrentMarkSweepGeneration::gc_epilogue(bool full) {
2671   collector()->gc_epilogue(full);
2672 
2673   // Also reset promotion tracking in par gc thread states.
2674   if (ParallelGCThreads > 0) {
2675     for (uint i = 0; i < ParallelGCThreads; i++) {
2676       _par_gc_thread_states[i]->promo.stopTrackingPromotions();
2677     }
2678   }
2679 }
2680 
2681 void ConcurrentMarkSweepGeneration::gc_epilogue_work(bool full) {
2682   assert(!incremental_collection_failed(), "Should have been cleared");
2683   cmsSpace()->setPreconsumptionDirtyCardClosure(NULL);
2684   cmsSpace()->gc_epilogue();
2685     // Print stat counters
2686   NOT_PRODUCT(
2687     assert(_numObjectsAllocated == 0, "check");
2688     assert(_numWordsAllocated == 0, "check");
2689     if (Verbose && PrintGC) {
2690       gclog_or_tty->print("Promoted "SIZE_FORMAT" objects, "
2691                           SIZE_FORMAT" bytes",
2692                  _numObjectsPromoted, _numWordsPromoted*sizeof(HeapWord));
2693     }
2694     _numObjectsPromoted = 0;
2695     _numWordsPromoted   = 0;
2696   )
2697 
2698   if (PrintGC && Verbose) {
2699     // Call down the chain in contiguous_available needs the freelistLock
2700     // so print this out before releasing the freeListLock.
2701     gclog_or_tty->print(" Contiguous available "SIZE_FORMAT" bytes ",
2702                         contiguous_available());
2703   }
2704 }
2705 
2706 #ifndef PRODUCT
2707 bool CMSCollector::have_cms_token() {
2708   Thread* thr = Thread::current();
2709   if (thr->is_VM_thread()) {
2710     return ConcurrentMarkSweepThread::vm_thread_has_cms_token();
2711   } else if (thr->is_ConcurrentGC_thread()) {
2712     return ConcurrentMarkSweepThread::cms_thread_has_cms_token();
2713   } else if (thr->is_GC_task_thread()) {
2714     return ConcurrentMarkSweepThread::vm_thread_has_cms_token() &&
2715            ParGCRareEvent_lock->owned_by_self();
2716   }
2717   return false;
2718 }
2719 #endif
2720 
2721 // Check reachability of the given heap address in CMS generation,
2722 // treating all other generations as roots.
2723 bool CMSCollector::is_cms_reachable(HeapWord* addr) {
2724   // We could "guarantee" below, rather than assert, but i'll
2725   // leave these as "asserts" so that an adventurous debugger
2726   // could try this in the product build provided some subset of
2727   // the conditions were met, provided they were intersted in the
2728   // results and knew that the computation below wouldn't interfere
2729   // with other concurrent computations mutating the structures
2730   // being read or written.
2731   assert(SafepointSynchronize::is_at_safepoint(),
2732          "Else mutations in object graph will make answer suspect");
2733   assert(have_cms_token(), "Should hold cms token");
2734   assert(haveFreelistLocks(), "must hold free list locks");
2735   assert_lock_strong(bitMapLock());
2736 
2737   // Clear the marking bit map array before starting, but, just
2738   // for kicks, first report if the given address is already marked
2739   gclog_or_tty->print_cr("Start: Address 0x%x is%s marked", addr,
2740                 _markBitMap.isMarked(addr) ? "" : " not");
2741 
2742   if (verify_after_remark()) {
2743     MutexLockerEx x(verification_mark_bm()->lock(), Mutex::_no_safepoint_check_flag);
2744     bool result = verification_mark_bm()->isMarked(addr);
2745     gclog_or_tty->print_cr("TransitiveMark: Address 0x%x %s marked", addr,
2746                            result ? "IS" : "is NOT");
2747     return result;
2748   } else {
2749     gclog_or_tty->print_cr("Could not compute result");
2750     return false;
2751   }
2752 }
2753 
2754 ////////////////////////////////////////////////////////
2755 // CMS Verification Support
2756 ////////////////////////////////////////////////////////
2757 // Following the remark phase, the following invariant
2758 // should hold -- each object in the CMS heap which is
2759 // marked in markBitMap() should be marked in the verification_mark_bm().
2760 
2761 class VerifyMarkedClosure: public BitMapClosure {
2762   CMSBitMap* _marks;
2763   bool       _failed;
2764 
2765  public:
2766   VerifyMarkedClosure(CMSBitMap* bm): _marks(bm), _failed(false) {}
2767 
2768   bool do_bit(size_t offset) {
2769     HeapWord* addr = _marks->offsetToHeapWord(offset);
2770     if (!_marks->isMarked(addr)) {
2771       oop(addr)->print();
2772       gclog_or_tty->print_cr(" ("INTPTR_FORMAT" should have been marked)", addr);
2773       _failed = true;
2774     }
2775     return true;
2776   }
2777 
2778   bool failed() { return _failed; }
2779 };
2780 
2781 bool CMSCollector::verify_after_remark() {
2782   gclog_or_tty->print(" [Verifying CMS Marking... ");
2783   MutexLockerEx ml(verification_mark_bm()->lock(), Mutex::_no_safepoint_check_flag);
2784   static bool init = false;
2785 
2786   assert(SafepointSynchronize::is_at_safepoint(),
2787          "Else mutations in object graph will make answer suspect");
2788   assert(have_cms_token(),
2789          "Else there may be mutual interference in use of "
2790          " verification data structures");
2791   assert(_collectorState > Marking && _collectorState <= Sweeping,
2792          "Else marking info checked here may be obsolete");
2793   assert(haveFreelistLocks(), "must hold free list locks");
2794   assert_lock_strong(bitMapLock());
2795 
2796 
2797   // Allocate marking bit map if not already allocated
2798   if (!init) { // first time
2799     if (!verification_mark_bm()->allocate(_span)) {
2800       return false;
2801     }
2802     init = true;
2803   }
2804 
2805   assert(verification_mark_stack()->isEmpty(), "Should be empty");
2806 
2807   // Turn off refs discovery -- so we will be tracing through refs.
2808   // This is as intended, because by this time
2809   // GC must already have cleared any refs that need to be cleared,
2810   // and traced those that need to be marked; moreover,
2811   // the marking done here is not going to intefere in any
2812   // way with the marking information used by GC.
2813   NoRefDiscovery no_discovery(ref_processor());
2814 
2815   COMPILER2_PRESENT(DerivedPointerTableDeactivate dpt_deact;)
2816 
2817   // Clear any marks from a previous round
2818   verification_mark_bm()->clear_all();
2819   assert(verification_mark_stack()->isEmpty(), "markStack should be empty");
2820   assert(overflow_list_is_empty(), "overflow list should be empty");
2821 
2822   GenCollectedHeap* gch = GenCollectedHeap::heap();
2823   gch->ensure_parsability(false);  // fill TLABs, but no need to retire them
2824   // Update the saved marks which may affect the root scans.
2825   gch->save_marks();
2826 
2827   if (CMSRemarkVerifyVariant == 1) {
2828     // In this first variant of verification, we complete
2829     // all marking, then check if the new marks-verctor is
2830     // a subset of the CMS marks-vector.
2831     verify_after_remark_work_1();
2832   } else if (CMSRemarkVerifyVariant == 2) {
2833     // In this second variant of verification, we flag an error
2834     // (i.e. an object reachable in the new marks-vector not reachable
2835     // in the CMS marks-vector) immediately, also indicating the
2836     // identify of an object (A) that references the unmarked object (B) --
2837     // presumably, a mutation to A failed to be picked up by preclean/remark?
2838     verify_after_remark_work_2();
2839   } else {
2840     warning("Unrecognized value %d for CMSRemarkVerifyVariant",
2841             CMSRemarkVerifyVariant);
2842   }
2843   gclog_or_tty->print(" done] ");
2844   return true;
2845 }
2846 
2847 void CMSCollector::verify_after_remark_work_1() {
2848   ResourceMark rm;
2849   HandleMark  hm;
2850   GenCollectedHeap* gch = GenCollectedHeap::heap();
2851 
2852   // Mark from roots one level into CMS
2853   MarkRefsIntoClosure notOlder(_span, verification_mark_bm(), true /* nmethods */);
2854   gch->rem_set()->prepare_for_younger_refs_iterate(false); // Not parallel.
2855 
2856   gch->gen_process_strong_roots(_cmsGen->level(),
2857                                 true,   // younger gens are roots
2858                                 true,   // collecting perm gen
2859                                 SharedHeap::ScanningOption(roots_scanning_options()),
2860                                 NULL, &notOlder);
2861 
2862   // Now mark from the roots
2863   assert(_revisitStack.isEmpty(), "Should be empty");
2864   MarkFromRootsClosure markFromRootsClosure(this, _span,
2865     verification_mark_bm(), verification_mark_stack(), &_revisitStack,
2866     false /* don't yield */, true /* verifying */);
2867   assert(_restart_addr == NULL, "Expected pre-condition");
2868   verification_mark_bm()->iterate(&markFromRootsClosure);
2869   while (_restart_addr != NULL) {
2870     // Deal with stack overflow: by restarting at the indicated
2871     // address.
2872     HeapWord* ra = _restart_addr;
2873     markFromRootsClosure.reset(ra);
2874     _restart_addr = NULL;
2875     verification_mark_bm()->iterate(&markFromRootsClosure, ra, _span.end());
2876   }
2877   assert(verification_mark_stack()->isEmpty(), "Should have been drained");
2878   verify_work_stacks_empty();
2879   // Should reset the revisit stack above, since no class tree
2880   // surgery is forthcoming.
2881   _revisitStack.reset(); // throwing away all contents
2882 
2883   // Marking completed -- now verify that each bit marked in
2884   // verification_mark_bm() is also marked in markBitMap(); flag all
2885   // errors by printing corresponding objects.
2886   VerifyMarkedClosure vcl(markBitMap());
2887   verification_mark_bm()->iterate(&vcl);
2888   if (vcl.failed()) {
2889     gclog_or_tty->print("Verification failed");
2890     Universe::heap()->print();
2891     fatal(" ... aborting");
2892   }
2893 }
2894 
2895 void CMSCollector::verify_after_remark_work_2() {
2896   ResourceMark rm;
2897   HandleMark  hm;
2898   GenCollectedHeap* gch = GenCollectedHeap::heap();
2899 
2900   // Mark from roots one level into CMS
2901   MarkRefsIntoVerifyClosure notOlder(_span, verification_mark_bm(),
2902                                      markBitMap(), true /* nmethods */);
2903   gch->rem_set()->prepare_for_younger_refs_iterate(false); // Not parallel.
2904   gch->gen_process_strong_roots(_cmsGen->level(),
2905                                 true,   // younger gens are roots
2906                                 true,   // collecting perm gen
2907                                 SharedHeap::ScanningOption(roots_scanning_options()),
2908                                 NULL, &notOlder);
2909 
2910   // Now mark from the roots
2911   assert(_revisitStack.isEmpty(), "Should be empty");
2912   MarkFromRootsVerifyClosure markFromRootsClosure(this, _span,
2913     verification_mark_bm(), markBitMap(), verification_mark_stack());
2914   assert(_restart_addr == NULL, "Expected pre-condition");
2915   verification_mark_bm()->iterate(&markFromRootsClosure);
2916   while (_restart_addr != NULL) {
2917     // Deal with stack overflow: by restarting at the indicated
2918     // address.
2919     HeapWord* ra = _restart_addr;
2920     markFromRootsClosure.reset(ra);
2921     _restart_addr = NULL;
2922     verification_mark_bm()->iterate(&markFromRootsClosure, ra, _span.end());
2923   }
2924   assert(verification_mark_stack()->isEmpty(), "Should have been drained");
2925   verify_work_stacks_empty();
2926   // Should reset the revisit stack above, since no class tree
2927   // surgery is forthcoming.
2928   _revisitStack.reset(); // throwing away all contents
2929 
2930   // Marking completed -- now verify that each bit marked in
2931   // verification_mark_bm() is also marked in markBitMap(); flag all
2932   // errors by printing corresponding objects.
2933   VerifyMarkedClosure vcl(markBitMap());
2934   verification_mark_bm()->iterate(&vcl);
2935   assert(!vcl.failed(), "Else verification above should not have succeeded");
2936 }
2937 
2938 void ConcurrentMarkSweepGeneration::save_marks() {
2939   // delegate to CMS space
2940   cmsSpace()->save_marks();
2941   for (uint i = 0; i < ParallelGCThreads; i++) {
2942     _par_gc_thread_states[i]->promo.startTrackingPromotions();
2943   }
2944 }
2945 
2946 bool ConcurrentMarkSweepGeneration::no_allocs_since_save_marks() {
2947   return cmsSpace()->no_allocs_since_save_marks();
2948 }
2949 
2950 #define CMS_SINCE_SAVE_MARKS_DEFN(OopClosureType, nv_suffix)    \
2951                                                                 \
2952 void ConcurrentMarkSweepGeneration::                            \
2953 oop_since_save_marks_iterate##nv_suffix(OopClosureType* cl) {   \
2954   cl->set_generation(this);                                     \
2955   cmsSpace()->oop_since_save_marks_iterate##nv_suffix(cl);      \
2956   cl->reset_generation();                                       \
2957   save_marks();                                                 \
2958 }
2959 
2960 ALL_SINCE_SAVE_MARKS_CLOSURES(CMS_SINCE_SAVE_MARKS_DEFN)
2961 
2962 void
2963 ConcurrentMarkSweepGeneration::object_iterate_since_last_GC(ObjectClosure* blk)
2964 {
2965   // Not currently implemented; need to do the following. -- ysr.
2966   // dld -- I think that is used for some sort of allocation profiler.  So it
2967   // really means the objects allocated by the mutator since the last
2968   // GC.  We could potentially implement this cheaply by recording only
2969   // the direct allocations in a side data structure.
2970   //
2971   // I think we probably ought not to be required to support these
2972   // iterations at any arbitrary point; I think there ought to be some
2973   // call to enable/disable allocation profiling in a generation/space,
2974   // and the iterator ought to return the objects allocated in the
2975   // gen/space since the enable call, or the last iterator call (which
2976   // will probably be at a GC.)  That way, for gens like CM&S that would
2977   // require some extra data structure to support this, we only pay the
2978   // cost when it's in use...
2979   cmsSpace()->object_iterate_since_last_GC(blk);
2980 }
2981 
2982 void
2983 ConcurrentMarkSweepGeneration::younger_refs_iterate(OopsInGenClosure* cl) {
2984   cl->set_generation(this);
2985   younger_refs_in_space_iterate(_cmsSpace, cl);
2986   cl->reset_generation();
2987 }
2988 
2989 void
2990 ConcurrentMarkSweepGeneration::oop_iterate(MemRegion mr, OopClosure* cl) {
2991   if (freelistLock()->owned_by_self()) {
2992     Generation::oop_iterate(mr, cl);
2993   } else {
2994     MutexLockerEx x(freelistLock(), Mutex::_no_safepoint_check_flag);
2995     Generation::oop_iterate(mr, cl);
2996   }
2997 }
2998 
2999 void
3000 ConcurrentMarkSweepGeneration::oop_iterate(OopClosure* cl) {
3001   if (freelistLock()->owned_by_self()) {
3002     Generation::oop_iterate(cl);
3003   } else {
3004     MutexLockerEx x(freelistLock(), Mutex::_no_safepoint_check_flag);
3005     Generation::oop_iterate(cl);
3006   }
3007 }
3008 
3009 void
3010 ConcurrentMarkSweepGeneration::object_iterate(ObjectClosure* cl) {
3011   if (freelistLock()->owned_by_self()) {
3012     Generation::object_iterate(cl);
3013   } else {
3014     MutexLockerEx x(freelistLock(), Mutex::_no_safepoint_check_flag);
3015     Generation::object_iterate(cl);
3016   }
3017 }
3018 
3019 void
3020 ConcurrentMarkSweepGeneration::pre_adjust_pointers() {
3021 }
3022 
3023 void
3024 ConcurrentMarkSweepGeneration::post_compact() {
3025 }
3026 
3027 void
3028 ConcurrentMarkSweepGeneration::prepare_for_verify() {
3029   // Fix the linear allocation blocks to look like free blocks.
3030 
3031   // Locks are normally acquired/released in gc_prologue/gc_epilogue, but those
3032   // are not called when the heap is verified during universe initialization and
3033   // at vm shutdown.
3034   if (freelistLock()->owned_by_self()) {
3035     cmsSpace()->prepare_for_verify();
3036   } else {
3037     MutexLockerEx fll(freelistLock(), Mutex::_no_safepoint_check_flag);
3038     cmsSpace()->prepare_for_verify();
3039   }
3040 }
3041 
3042 void
3043 ConcurrentMarkSweepGeneration::verify(bool allow_dirty /* ignored */) {
3044   // Locks are normally acquired/released in gc_prologue/gc_epilogue, but those
3045   // are not called when the heap is verified during universe initialization and
3046   // at vm shutdown.
3047   if (freelistLock()->owned_by_self()) {
3048     cmsSpace()->verify(false /* ignored */);
3049   } else {
3050     MutexLockerEx fll(freelistLock(), Mutex::_no_safepoint_check_flag);
3051     cmsSpace()->verify(false /* ignored */);
3052   }
3053 }
3054 
3055 void CMSCollector::verify(bool allow_dirty /* ignored */) {
3056   _cmsGen->verify(allow_dirty);
3057   _permGen->verify(allow_dirty);
3058 }
3059 
3060 #ifndef PRODUCT
3061 bool CMSCollector::overflow_list_is_empty() const {
3062   assert(_num_par_pushes >= 0, "Inconsistency");
3063   if (_overflow_list == NULL) {
3064     assert(_num_par_pushes == 0, "Inconsistency");
3065   }
3066   return _overflow_list == NULL;
3067 }
3068 
3069 // The methods verify_work_stacks_empty() and verify_overflow_empty()
3070 // merely consolidate assertion checks that appear to occur together frequently.
3071 void CMSCollector::verify_work_stacks_empty() const {
3072   assert(_markStack.isEmpty(), "Marking stack should be empty");
3073   assert(overflow_list_is_empty(), "Overflow list should be empty");
3074 }
3075 
3076 void CMSCollector::verify_overflow_empty() const {
3077   assert(overflow_list_is_empty(), "Overflow list should be empty");
3078   assert(no_preserved_marks(), "No preserved marks");
3079 }
3080 #endif // PRODUCT
3081 
3082 // Decide if we want to enable class unloading as part of the
3083 // ensuing concurrent GC cycle. We will collect the perm gen and
3084 // unload classes if it's the case that:
3085 // (1) an explicit gc request has been made and the flag
3086 //     ExplicitGCInvokesConcurrentAndUnloadsClasses is set, OR
3087 // (2) (a) class unloading is enabled at the command line, and
3088 //     (b) (i)   perm gen threshold has been crossed, or
3089 //         (ii)  old gen is getting really full, or
3090 //         (iii) the previous N CMS collections did not collect the
3091 //               perm gen
3092 // NOTE: Provided there is no change in the state of the heap between
3093 // calls to this method, it should have idempotent results. Moreover,
3094 // its results should be monotonically increasing (i.e. going from 0 to 1,
3095 // but not 1 to 0) between successive calls between which the heap was
3096 // not collected. For the implementation below, it must thus rely on
3097 // the property that concurrent_cycles_since_last_unload()
3098 // will not decrease unless a collection cycle happened and that
3099 // _permGen->should_concurrent_collect() and _cmsGen->is_too_full() are
3100 // themselves also monotonic in that sense. See check_monotonicity()
3101 // below.
3102 bool CMSCollector::update_should_unload_classes() {
3103   _should_unload_classes = false;
3104   // Condition 1 above
3105   if (_full_gc_requested && ExplicitGCInvokesConcurrentAndUnloadsClasses) {
3106     _should_unload_classes = true;
3107   } else if (CMSClassUnloadingEnabled) { // Condition 2.a above
3108     // Disjuncts 2.b.(i,ii,iii) above
3109     _should_unload_classes = (concurrent_cycles_since_last_unload() >=
3110                               CMSClassUnloadingMaxInterval)
3111                            || _permGen->should_concurrent_collect()
3112                            || _cmsGen->is_too_full();
3113   }
3114   return _should_unload_classes;
3115 }
3116 
3117 bool ConcurrentMarkSweepGeneration::is_too_full() const {
3118   bool res = should_concurrent_collect();
3119   res = res && (occupancy() > (double)CMSIsTooFullPercentage/100.0);
3120   return res;
3121 }
3122 
3123 void CMSCollector::setup_cms_unloading_and_verification_state() {
3124   const  bool should_verify =    VerifyBeforeGC || VerifyAfterGC || VerifyDuringGC
3125                              || VerifyBeforeExit;
3126   const  int  rso           =    SharedHeap::SO_Symbols | SharedHeap::SO_Strings
3127                              |   SharedHeap::SO_CodeCache;
3128 
3129   if (should_unload_classes()) {   // Should unload classes this cycle
3130     remove_root_scanning_option(rso);  // Shrink the root set appropriately
3131     set_verifying(should_verify);    // Set verification state for this cycle
3132     return;                            // Nothing else needs to be done at this time
3133   }
3134 
3135   // Not unloading classes this cycle
3136   assert(!should_unload_classes(), "Inconsitency!");
3137   if ((!verifying() || unloaded_classes_last_cycle()) && should_verify) {
3138     // We were not verifying, or we _were_ unloading classes in the last cycle,
3139     // AND some verification options are enabled this cycle; in this case,
3140     // we must make sure that the deadness map is allocated if not already so,
3141     // and cleared (if already allocated previously --
3142     // CMSBitMap::sizeInBits() is used to determine if it's allocated).
3143     if (perm_gen_verify_bit_map()->sizeInBits() == 0) {
3144       if (!perm_gen_verify_bit_map()->allocate(_permGen->reserved())) {
3145         warning("Failed to allocate permanent generation verification CMS Bit Map;\n"
3146                 "permanent generation verification disabled");
3147         return;  // Note that we leave verification disabled, so we'll retry this
3148                  // allocation next cycle. We _could_ remember this failure
3149                  // and skip further attempts and permanently disable verification
3150                  // attempts if that is considered more desirable.
3151       }
3152       assert(perm_gen_verify_bit_map()->covers(_permGen->reserved()),
3153               "_perm_gen_ver_bit_map inconsistency?");
3154     } else {
3155       perm_gen_verify_bit_map()->clear_all();
3156     }
3157     // Include symbols, strings and code cache elements to prevent their resurrection.
3158     add_root_scanning_option(rso);
3159     set_verifying(true);
3160   } else if (verifying() && !should_verify) {
3161     // We were verifying, but some verification flags got disabled.
3162     set_verifying(false);
3163     // Exclude symbols, strings and code cache elements from root scanning to
3164     // reduce IM and RM pauses.
3165     remove_root_scanning_option(rso);
3166   }
3167 }
3168 
3169 
3170 #ifndef PRODUCT
3171 HeapWord* CMSCollector::block_start(const void* p) const {
3172   const HeapWord* addr = (HeapWord*)p;
3173   if (_span.contains(p)) {
3174     if (_cmsGen->cmsSpace()->is_in_reserved(addr)) {
3175       return _cmsGen->cmsSpace()->block_start(p);
3176     } else {
3177       assert(_permGen->cmsSpace()->is_in_reserved(addr),
3178              "Inconsistent _span?");
3179       return _permGen->cmsSpace()->block_start(p);
3180     }
3181   }
3182   return NULL;
3183 }
3184 #endif
3185 
3186 HeapWord*
3187 ConcurrentMarkSweepGeneration::expand_and_allocate(size_t word_size,
3188                                                    bool   tlab,
3189                                                    bool   parallel) {
3190   assert(!tlab, "Can't deal with TLAB allocation");
3191   MutexLockerEx x(freelistLock(), Mutex::_no_safepoint_check_flag);
3192   expand(word_size*HeapWordSize, MinHeapDeltaBytes,
3193     CMSExpansionCause::_satisfy_allocation);
3194   if (GCExpandToAllocateDelayMillis > 0) {
3195     os::sleep(Thread::current(), GCExpandToAllocateDelayMillis, false);
3196   }
3197   return have_lock_and_allocate(word_size, tlab);
3198 }
3199 
3200 // YSR: All of this generation expansion/shrinking stuff is an exact copy of
3201 // OneContigSpaceCardGeneration, which makes me wonder if we should move this
3202 // to CardGeneration and share it...
3203 bool ConcurrentMarkSweepGeneration::expand(size_t bytes, size_t expand_bytes) {
3204   return CardGeneration::expand(bytes, expand_bytes);
3205 }
3206 
3207 void ConcurrentMarkSweepGeneration::expand(size_t bytes, size_t expand_bytes,
3208   CMSExpansionCause::Cause cause)
3209 {
3210 
3211   bool success = expand(bytes, expand_bytes);
3212 
3213   // remember why we expanded; this information is used
3214   // by shouldConcurrentCollect() when making decisions on whether to start
3215   // a new CMS cycle.
3216   if (success) {
3217     set_expansion_cause(cause);
3218     if (PrintGCDetails && Verbose) {
3219       gclog_or_tty->print_cr("Expanded CMS gen for %s",
3220         CMSExpansionCause::to_string(cause));
3221     }
3222   }
3223 }
3224 
3225 HeapWord* ConcurrentMarkSweepGeneration::expand_and_par_lab_allocate(CMSParGCThreadState* ps, size_t word_sz) {
3226   HeapWord* res = NULL;
3227   MutexLocker x(ParGCRareEvent_lock);
3228   while (true) {
3229     // Expansion by some other thread might make alloc OK now:
3230     res = ps->lab.alloc(word_sz);
3231     if (res != NULL) return res;
3232     // If there's not enough expansion space available, give up.
3233     if (_virtual_space.uncommitted_size() < (word_sz * HeapWordSize)) {
3234       return NULL;
3235     }
3236     // Otherwise, we try expansion.
3237     expand(word_sz*HeapWordSize, MinHeapDeltaBytes,
3238       CMSExpansionCause::_allocate_par_lab);
3239     // Now go around the loop and try alloc again;
3240     // A competing par_promote might beat us to the expansion space,
3241     // so we may go around the loop again if promotion fails agaion.
3242     if (GCExpandToAllocateDelayMillis > 0) {
3243       os::sleep(Thread::current(), GCExpandToAllocateDelayMillis, false);
3244     }
3245   }
3246 }
3247 
3248 
3249 bool ConcurrentMarkSweepGeneration::expand_and_ensure_spooling_space(
3250   PromotionInfo* promo) {
3251   MutexLocker x(ParGCRareEvent_lock);
3252   size_t refill_size_bytes = promo->refillSize() * HeapWordSize;
3253   while (true) {
3254     // Expansion by some other thread might make alloc OK now:
3255     if (promo->ensure_spooling_space()) {
3256       assert(promo->has_spooling_space(),
3257              "Post-condition of successful ensure_spooling_space()");
3258       return true;
3259     }
3260     // If there's not enough expansion space available, give up.
3261     if (_virtual_space.uncommitted_size() < refill_size_bytes) {
3262       return false;
3263     }
3264     // Otherwise, we try expansion.
3265     expand(refill_size_bytes, MinHeapDeltaBytes,
3266       CMSExpansionCause::_allocate_par_spooling_space);
3267     // Now go around the loop and try alloc again;
3268     // A competing allocation might beat us to the expansion space,
3269     // so we may go around the loop again if allocation fails again.
3270     if (GCExpandToAllocateDelayMillis > 0) {
3271       os::sleep(Thread::current(), GCExpandToAllocateDelayMillis, false);
3272     }
3273   }
3274 }
3275 
3276 
3277 
3278 void ConcurrentMarkSweepGeneration::shrink(size_t bytes) {
3279   assert_locked_or_safepoint(Heap_lock);
3280   size_t size = ReservedSpace::page_align_size_down(bytes);
3281   if (size > 0) {
3282     shrink_by(size);
3283   }
3284 }
3285 
3286 bool ConcurrentMarkSweepGeneration::grow_by(size_t bytes) {
3287   assert_locked_or_safepoint(Heap_lock);
3288   bool result = _virtual_space.expand_by(bytes);
3289   if (result) {
3290     HeapWord* old_end = _cmsSpace->end();
3291     size_t new_word_size =
3292       heap_word_size(_virtual_space.committed_size());
3293     MemRegion mr(_cmsSpace->bottom(), new_word_size);
3294     _bts->resize(new_word_size);  // resize the block offset shared array
3295     Universe::heap()->barrier_set()->resize_covered_region(mr);
3296     // Hmmmm... why doesn't CFLS::set_end verify locking?
3297     // This is quite ugly; FIX ME XXX
3298     _cmsSpace->assert_locked();
3299     _cmsSpace->set_end((HeapWord*)_virtual_space.high());
3300 
3301     // update the space and generation capacity counters
3302     if (UsePerfData) {
3303       _space_counters->update_capacity();
3304       _gen_counters->update_all();
3305     }
3306 
3307     if (Verbose && PrintGC) {
3308       size_t new_mem_size = _virtual_space.committed_size();
3309       size_t old_mem_size = new_mem_size - bytes;
3310       gclog_or_tty->print_cr("Expanding %s from %ldK by %ldK to %ldK",
3311                     name(), old_mem_size/K, bytes/K, new_mem_size/K);
3312     }
3313   }
3314   return result;
3315 }
3316 
3317 bool ConcurrentMarkSweepGeneration::grow_to_reserved() {
3318   assert_locked_or_safepoint(Heap_lock);
3319   bool success = true;
3320   const size_t remaining_bytes = _virtual_space.uncommitted_size();
3321   if (remaining_bytes > 0) {
3322     success = grow_by(remaining_bytes);
3323     DEBUG_ONLY(if (!success) warning("grow to reserved failed");)
3324   }
3325   return success;
3326 }
3327 
3328 void ConcurrentMarkSweepGeneration::shrink_by(size_t bytes) {
3329   assert_locked_or_safepoint(Heap_lock);
3330   assert_lock_strong(freelistLock());
3331   // XXX Fix when compaction is implemented.
3332   warning("Shrinking of CMS not yet implemented");
3333   return;
3334 }
3335 
3336 
3337 // Simple ctor/dtor wrapper for accounting & timer chores around concurrent
3338 // phases.
3339 class CMSPhaseAccounting: public StackObj {
3340  public:
3341   CMSPhaseAccounting(CMSCollector *collector,
3342                      const char *phase,
3343                      bool print_cr = true);
3344   ~CMSPhaseAccounting();
3345 
3346  private:
3347   CMSCollector *_collector;
3348   const char *_phase;
3349   elapsedTimer _wallclock;
3350   bool _print_cr;
3351 
3352  public:
3353   // Not MT-safe; so do not pass around these StackObj's
3354   // where they may be accessed by other threads.
3355   jlong wallclock_millis() {
3356     assert(_wallclock.is_active(), "Wall clock should not stop");
3357     _wallclock.stop();  // to record time
3358     jlong ret = _wallclock.milliseconds();
3359     _wallclock.start(); // restart
3360     return ret;
3361   }
3362 };
3363 
3364 CMSPhaseAccounting::CMSPhaseAccounting(CMSCollector *collector,
3365                                        const char *phase,
3366                                        bool print_cr) :
3367   _collector(collector), _phase(phase), _print_cr(print_cr) {
3368 
3369   if (PrintCMSStatistics != 0) {
3370     _collector->resetYields();
3371   }
3372   if (PrintGCDetails && PrintGCTimeStamps) {
3373     gclog_or_tty->date_stamp(PrintGCDateStamps);
3374     gclog_or_tty->stamp();
3375     gclog_or_tty->print_cr(": [%s-concurrent-%s-start]",
3376       _collector->cmsGen()->short_name(), _phase);
3377   }
3378   _collector->resetTimer();
3379   _wallclock.start();
3380   _collector->startTimer();
3381 }
3382 
3383 CMSPhaseAccounting::~CMSPhaseAccounting() {
3384   assert(_wallclock.is_active(), "Wall clock should not have stopped");
3385   _collector->stopTimer();
3386   _wallclock.stop();
3387   if (PrintGCDetails) {
3388     gclog_or_tty->date_stamp(PrintGCDateStamps);
3389     if (PrintGCTimeStamps) {
3390       gclog_or_tty->stamp();
3391       gclog_or_tty->print(": ");
3392     }
3393     gclog_or_tty->print("[%s-concurrent-%s: %3.3f/%3.3f secs]",
3394                  _collector->cmsGen()->short_name(),
3395                  _phase, _collector->timerValue(), _wallclock.seconds());
3396     if (_print_cr) {
3397       gclog_or_tty->print_cr("");
3398     }
3399     if (PrintCMSStatistics != 0) {
3400       gclog_or_tty->print_cr(" (CMS-concurrent-%s yielded %d times)", _phase,
3401                     _collector->yields());
3402     }
3403   }
3404 }
3405 
3406 // CMS work
3407 
3408 // Checkpoint the roots into this generation from outside
3409 // this generation. [Note this initial checkpoint need only
3410 // be approximate -- we'll do a catch up phase subsequently.]
3411 void CMSCollector::checkpointRootsInitial(bool asynch) {
3412   assert(_collectorState == InitialMarking, "Wrong collector state");
3413   check_correct_thread_executing();
3414   ReferenceProcessor* rp = ref_processor();
3415   SpecializationStats::clear();
3416   assert(_restart_addr == NULL, "Control point invariant");
3417   if (asynch) {
3418     // acquire locks for subsequent manipulations
3419     MutexLockerEx x(bitMapLock(),
3420                     Mutex::_no_safepoint_check_flag);
3421     checkpointRootsInitialWork(asynch);
3422     rp->verify_no_references_recorded();
3423     rp->enable_discovery(); // enable ("weak") refs discovery
3424     _collectorState = Marking;
3425   } else {
3426     // (Weak) Refs discovery: this is controlled from genCollectedHeap::do_collection
3427     // which recognizes if we are a CMS generation, and doesn't try to turn on
3428     // discovery; verify that they aren't meddling.
3429     assert(!rp->discovery_is_atomic(),
3430            "incorrect setting of discovery predicate");
3431     assert(!rp->discovery_enabled(), "genCollectedHeap shouldn't control "
3432            "ref discovery for this generation kind");
3433     // already have locks
3434     checkpointRootsInitialWork(asynch);
3435     rp->enable_discovery(); // now enable ("weak") refs discovery
3436     _collectorState = Marking;
3437   }
3438   SpecializationStats::print();
3439 }
3440 
3441 void CMSCollector::checkpointRootsInitialWork(bool asynch) {
3442   assert(SafepointSynchronize::is_at_safepoint(), "world should be stopped");
3443   assert(_collectorState == InitialMarking, "just checking");
3444 
3445   // If there has not been a GC[n-1] since last GC[n] cycle completed,
3446   // precede our marking with a collection of all
3447   // younger generations to keep floating garbage to a minimum.
3448   // XXX: we won't do this for now -- it's an optimization to be done later.
3449 
3450   // already have locks
3451   assert_lock_strong(bitMapLock());
3452   assert(_markBitMap.isAllClear(), "was reset at end of previous cycle");
3453 
3454   // Setup the verification and class unloading state for this
3455   // CMS collection cycle.
3456   setup_cms_unloading_and_verification_state();
3457 
3458   NOT_PRODUCT(TraceTime t("\ncheckpointRootsInitialWork",
3459     PrintGCDetails && Verbose, true, gclog_or_tty);)
3460   if (UseAdaptiveSizePolicy) {
3461     size_policy()->checkpoint_roots_initial_begin();
3462   }
3463 
3464   // Reset all the PLAB chunk arrays if necessary.
3465   if (_survivor_plab_array != NULL && !CMSPLABRecordAlways) {
3466     reset_survivor_plab_arrays();
3467   }
3468 
3469   ResourceMark rm;
3470   HandleMark  hm;
3471 
3472   FalseClosure falseClosure;
3473   // In the case of a synchronous collection, we will elide the
3474   // remark step, so it's important to catch all the nmethod oops
3475   // in this step; hence the last argument to the constrcutor below.
3476   MarkRefsIntoClosure notOlder(_span, &_markBitMap, !asynch /* nmethods */);
3477   GenCollectedHeap* gch = GenCollectedHeap::heap();
3478 
3479   verify_work_stacks_empty();
3480   verify_overflow_empty();
3481 
3482   gch->ensure_parsability(false);  // fill TLABs, but no need to retire them
3483   // Update the saved marks which may affect the root scans.
3484   gch->save_marks();
3485 
3486   // weak reference processing has not started yet.
3487   ref_processor()->set_enqueuing_is_done(false);
3488 
3489   {
3490     COMPILER2_PRESENT(DerivedPointerTableDeactivate dpt_deact;)
3491     gch->rem_set()->prepare_for_younger_refs_iterate(false); // Not parallel.
3492     gch->gen_process_strong_roots(_cmsGen->level(),
3493                                   true,   // younger gens are roots
3494                                   true,   // collecting perm gen
3495                                   SharedHeap::ScanningOption(roots_scanning_options()),
3496                                   NULL, &notOlder);
3497   }
3498 
3499   // Clear mod-union table; it will be dirtied in the prologue of
3500   // CMS generation per each younger generation collection.
3501 
3502   assert(_modUnionTable.isAllClear(),
3503        "Was cleared in most recent final checkpoint phase"
3504        " or no bits are set in the gc_prologue before the start of the next "
3505        "subsequent marking phase.");
3506 
3507   // Temporarily disabled, since pre/post-consumption closures don't
3508   // care about precleaned cards
3509   #if 0
3510   {
3511     MemRegion mr = MemRegion((HeapWord*)_virtual_space.low(),
3512                              (HeapWord*)_virtual_space.high());
3513     _ct->ct_bs()->preclean_dirty_cards(mr);
3514   }
3515   #endif
3516 
3517   // Save the end of the used_region of the constituent generations
3518   // to be used to limit the extent of sweep in each generation.
3519   save_sweep_limits();
3520   if (UseAdaptiveSizePolicy) {
3521     size_policy()->checkpoint_roots_initial_end(gch->gc_cause());
3522   }
3523   verify_overflow_empty();
3524 }
3525 
3526 bool CMSCollector::markFromRoots(bool asynch) {
3527   // we might be tempted to assert that:
3528   // assert(asynch == !SafepointSynchronize::is_at_safepoint(),
3529   //        "inconsistent argument?");
3530   // However that wouldn't be right, because it's possible that
3531   // a safepoint is indeed in progress as a younger generation
3532   // stop-the-world GC happens even as we mark in this generation.
3533   assert(_collectorState == Marking, "inconsistent state?");
3534   check_correct_thread_executing();
3535   verify_overflow_empty();
3536 
3537   bool res;
3538   if (asynch) {
3539 
3540     // Start the timers for adaptive size policy for the concurrent phases
3541     // Do it here so that the foreground MS can use the concurrent
3542     // timer since a foreground MS might has the sweep done concurrently
3543     // or STW.
3544     if (UseAdaptiveSizePolicy) {
3545       size_policy()->concurrent_marking_begin();
3546     }
3547 
3548     // Weak ref discovery note: We may be discovering weak
3549     // refs in this generation concurrent (but interleaved) with
3550     // weak ref discovery by a younger generation collector.
3551 
3552     CMSTokenSyncWithLocks ts(true, bitMapLock());
3553     TraceCPUTime tcpu(PrintGCDetails, true, gclog_or_tty);
3554     CMSPhaseAccounting pa(this, "mark", !PrintGCDetails);
3555     res = markFromRootsWork(asynch);
3556     if (res) {
3557       _collectorState = Precleaning;
3558     } else { // We failed and a foreground collection wants to take over
3559       assert(_foregroundGCIsActive, "internal state inconsistency");
3560       assert(_restart_addr == NULL,  "foreground will restart from scratch");
3561       if (PrintGCDetails) {
3562         gclog_or_tty->print_cr("bailing out to foreground collection");
3563       }
3564     }
3565     if (UseAdaptiveSizePolicy) {
3566       size_policy()->concurrent_marking_end();
3567     }
3568   } else {
3569     assert(SafepointSynchronize::is_at_safepoint(),
3570            "inconsistent with asynch == false");
3571     if (UseAdaptiveSizePolicy) {
3572       size_policy()->ms_collection_marking_begin();
3573     }
3574     // already have locks
3575     res = markFromRootsWork(asynch);
3576     _collectorState = FinalMarking;
3577     if (UseAdaptiveSizePolicy) {
3578       GenCollectedHeap* gch = GenCollectedHeap::heap();
3579       size_policy()->ms_collection_marking_end(gch->gc_cause());
3580     }
3581   }
3582   verify_overflow_empty();
3583   return res;
3584 }
3585 
3586 bool CMSCollector::markFromRootsWork(bool asynch) {
3587   // iterate over marked bits in bit map, doing a full scan and mark
3588   // from these roots using the following algorithm:
3589   // . if oop is to the right of the current scan pointer,
3590   //   mark corresponding bit (we'll process it later)
3591   // . else (oop is to left of current scan pointer)
3592   //   push oop on marking stack
3593   // . drain the marking stack
3594 
3595   // Note that when we do a marking step we need to hold the
3596   // bit map lock -- recall that direct allocation (by mutators)
3597   // and promotion (by younger generation collectors) is also
3598   // marking the bit map. [the so-called allocate live policy.]
3599   // Because the implementation of bit map marking is not
3600   // robust wrt simultaneous marking of bits in the same word,
3601   // we need to make sure that there is no such interference
3602   // between concurrent such updates.
3603 
3604   // already have locks
3605   assert_lock_strong(bitMapLock());
3606 
3607   // Clear the revisit stack, just in case there are any
3608   // obsolete contents from a short-circuited previous CMS cycle.
3609   _revisitStack.reset();
3610   verify_work_stacks_empty();
3611   verify_overflow_empty();
3612   assert(_revisitStack.isEmpty(), "tabula rasa");
3613 
3614   bool result = false;
3615   if (CMSConcurrentMTEnabled && ParallelCMSThreads > 0) {
3616     result = do_marking_mt(asynch);
3617   } else {
3618     result = do_marking_st(asynch);
3619   }
3620   return result;
3621 }
3622 
3623 // Forward decl
3624 class CMSConcMarkingTask;
3625 
3626 class CMSConcMarkingTerminator: public ParallelTaskTerminator {
3627   CMSCollector*       _collector;
3628   CMSConcMarkingTask* _task;
3629   bool _yield;
3630  protected:
3631   virtual void yield();
3632  public:
3633   // "n_threads" is the number of threads to be terminated.
3634   // "queue_set" is a set of work queues of other threads.
3635   // "collector" is the CMS collector associated with this task terminator.
3636   // "yield" indicates whether we need the gang as a whole to yield.
3637   CMSConcMarkingTerminator(int n_threads, TaskQueueSetSuper* queue_set,
3638                            CMSCollector* collector, bool yield) :
3639     ParallelTaskTerminator(n_threads, queue_set),
3640     _collector(collector),
3641     _yield(yield) { }
3642 
3643   void set_task(CMSConcMarkingTask* task) {
3644     _task = task;
3645   }
3646 };
3647 
3648 // MT Concurrent Marking Task
3649 class CMSConcMarkingTask: public YieldingFlexibleGangTask {
3650   CMSCollector* _collector;
3651   YieldingFlexibleWorkGang* _workers;        // the whole gang
3652   int           _n_workers;                  // requested/desired # workers
3653   bool          _asynch;
3654   bool          _result;
3655   CompactibleFreeListSpace*  _cms_space;
3656   CompactibleFreeListSpace* _perm_space;
3657   HeapWord*     _global_finger;
3658   HeapWord*     _restart_addr;
3659 
3660   //  Exposed here for yielding support
3661   Mutex* const _bit_map_lock;
3662 
3663   // The per thread work queues, available here for stealing
3664   OopTaskQueueSet*  _task_queues;
3665   CMSConcMarkingTerminator _term;
3666 
3667  public:
3668   CMSConcMarkingTask(CMSCollector* collector,
3669                  CompactibleFreeListSpace* cms_space,
3670                  CompactibleFreeListSpace* perm_space,
3671                  bool asynch, int n_workers,
3672                  YieldingFlexibleWorkGang* workers,
3673                  OopTaskQueueSet* task_queues):
3674     YieldingFlexibleGangTask("Concurrent marking done multi-threaded"),
3675     _collector(collector),
3676     _cms_space(cms_space),
3677     _perm_space(perm_space),
3678     _asynch(asynch), _n_workers(n_workers), _result(true),
3679     _workers(workers), _task_queues(task_queues),
3680     _term(n_workers, task_queues, _collector, asynch),
3681     _bit_map_lock(collector->bitMapLock())
3682   {
3683     assert(n_workers <= workers->total_workers(),
3684            "Else termination won't work correctly today"); // XXX FIX ME!
3685     _requested_size = n_workers;
3686     _term.set_task(this);
3687     assert(_cms_space->bottom() < _perm_space->bottom(),
3688            "Finger incorrectly initialized below");
3689     _restart_addr = _global_finger = _cms_space->bottom();
3690   }
3691 
3692 
3693   OopTaskQueueSet* task_queues()  { return _task_queues; }
3694 
3695   OopTaskQueue* work_queue(int i) { return task_queues()->queue(i); }
3696 
3697   HeapWord** global_finger_addr() { return &_global_finger; }
3698 
3699   CMSConcMarkingTerminator* terminator() { return &_term; }
3700 
3701   void work(int i);
3702 
3703   virtual void coordinator_yield();  // stuff done by coordinator
3704   bool result() { return _result; }
3705 
3706   void reset(HeapWord* ra) {
3707     assert(_global_finger >= _cms_space->end(),  "Postcondition of ::work(i)");
3708     assert(_global_finger >= _perm_space->end(), "Postcondition of ::work(i)");
3709     assert(ra             <  _perm_space->end(), "ra too large");
3710     _restart_addr = _global_finger = ra;
3711     _term.reset_for_reuse();
3712   }
3713 
3714   static bool get_work_from_overflow_stack(CMSMarkStack* ovflw_stk,
3715                                            OopTaskQueue* work_q);
3716 
3717  private:
3718   void do_scan_and_mark(int i, CompactibleFreeListSpace* sp);
3719   void do_work_steal(int i);
3720   void bump_global_finger(HeapWord* f);
3721 };
3722 
3723 void CMSConcMarkingTerminator::yield() {
3724   if (ConcurrentMarkSweepThread::should_yield() &&
3725       !_collector->foregroundGCIsActive() &&
3726       _yield) {
3727     _task->yield();
3728   } else {
3729     ParallelTaskTerminator::yield();
3730   }
3731 }
3732 
3733 ////////////////////////////////////////////////////////////////
3734 // Concurrent Marking Algorithm Sketch
3735 ////////////////////////////////////////////////////////////////
3736 // Until all tasks exhausted (both spaces):
3737 // -- claim next available chunk
3738 // -- bump global finger via CAS
3739 // -- find first object that starts in this chunk
3740 //    and start scanning bitmap from that position
3741 // -- scan marked objects for oops
3742 // -- CAS-mark target, and if successful:
3743 //    . if target oop is above global finger (volatile read)
3744 //      nothing to do
3745 //    . if target oop is in chunk and above local finger
3746 //        then nothing to do
3747 //    . else push on work-queue
3748 // -- Deal with possible overflow issues:
3749 //    . local work-queue overflow causes stuff to be pushed on
3750 //      global (common) overflow queue
3751 //    . always first empty local work queue
3752 //    . then get a batch of oops from global work queue if any
3753 //    . then do work stealing
3754 // -- When all tasks claimed (both spaces)
3755 //    and local work queue empty,
3756 //    then in a loop do:
3757 //    . check global overflow stack; steal a batch of oops and trace
3758 //    . try to steal from other threads oif GOS is empty
3759 //    . if neither is available, offer termination
3760 // -- Terminate and return result
3761 //
3762 void CMSConcMarkingTask::work(int i) {
3763   elapsedTimer _timer;
3764   ResourceMark rm;
3765   HandleMark hm;
3766 
3767   DEBUG_ONLY(_collector->verify_overflow_empty();)
3768 
3769   // Before we begin work, our work queue should be empty
3770   assert(work_queue(i)->size() == 0, "Expected to be empty");
3771   // Scan the bitmap covering _cms_space, tracing through grey objects.
3772   _timer.start();
3773   do_scan_and_mark(i, _cms_space);
3774   _timer.stop();
3775   if (PrintCMSStatistics != 0) {
3776     gclog_or_tty->print_cr("Finished cms space scanning in %dth thread: %3.3f sec",
3777       i, _timer.seconds()); // XXX: need xxx/xxx type of notation, two timers
3778   }
3779 
3780   // ... do the same for the _perm_space
3781   _timer.reset();
3782   _timer.start();
3783   do_scan_and_mark(i, _perm_space);
3784   _timer.stop();
3785   if (PrintCMSStatistics != 0) {
3786     gclog_or_tty->print_cr("Finished perm space scanning in %dth thread: %3.3f sec",
3787       i, _timer.seconds()); // XXX: need xxx/xxx type of notation, two timers
3788   }
3789 
3790   // ... do work stealing
3791   _timer.reset();
3792   _timer.start();
3793   do_work_steal(i);
3794   _timer.stop();
3795   if (PrintCMSStatistics != 0) {
3796     gclog_or_tty->print_cr("Finished work stealing in %dth thread: %3.3f sec",
3797       i, _timer.seconds()); // XXX: need xxx/xxx type of notation, two timers
3798   }
3799   assert(_collector->_markStack.isEmpty(), "Should have been emptied");
3800   assert(work_queue(i)->size() == 0, "Should have been emptied");
3801   // Note that under the current task protocol, the
3802   // following assertion is true even of the spaces
3803   // expanded since the completion of the concurrent
3804   // marking. XXX This will likely change under a strict
3805   // ABORT semantics.
3806   assert(_global_finger >  _cms_space->end() &&
3807          _global_finger >= _perm_space->end(),
3808          "All tasks have been completed");
3809   DEBUG_ONLY(_collector->verify_overflow_empty();)
3810 }
3811 
3812 void CMSConcMarkingTask::bump_global_finger(HeapWord* f) {
3813   HeapWord* read = _global_finger;
3814   HeapWord* cur  = read;
3815   while (f > read) {
3816     cur = read;
3817     read = (HeapWord*) Atomic::cmpxchg_ptr(f, &_global_finger, cur);
3818     if (cur == read) {
3819       // our cas succeeded
3820       assert(_global_finger >= f, "protocol consistency");
3821       break;
3822     }
3823   }
3824 }
3825 
3826 // This is really inefficient, and should be redone by
3827 // using (not yet available) block-read and -write interfaces to the
3828 // stack and the work_queue. XXX FIX ME !!!
3829 bool CMSConcMarkingTask::get_work_from_overflow_stack(CMSMarkStack* ovflw_stk,
3830                                                       OopTaskQueue* work_q) {
3831   // Fast lock-free check
3832   if (ovflw_stk->length() == 0) {
3833     return false;
3834   }
3835   assert(work_q->size() == 0, "Shouldn't steal");
3836   MutexLockerEx ml(ovflw_stk->par_lock(),
3837                    Mutex::_no_safepoint_check_flag);
3838   // Grab up to 1/4 the size of the work queue
3839   size_t num = MIN2((size_t)work_q->max_elems()/4,
3840                     (size_t)ParGCDesiredObjsFromOverflowList);
3841   num = MIN2(num, ovflw_stk->length());
3842   for (int i = (int) num; i > 0; i--) {
3843     oop cur = ovflw_stk->pop();
3844     assert(cur != NULL, "Counted wrong?");
3845     work_q->push(cur);
3846   }
3847   return num > 0;
3848 }
3849 
3850 void CMSConcMarkingTask::do_scan_and_mark(int i, CompactibleFreeListSpace* sp) {
3851   SequentialSubTasksDone* pst = sp->conc_par_seq_tasks();
3852   int n_tasks = pst->n_tasks();
3853   // We allow that there may be no tasks to do here because
3854   // we are restarting after a stack overflow.
3855   assert(pst->valid() || n_tasks == 0, "Uninitialized use?");
3856   int nth_task = 0;
3857 
3858   HeapWord* aligned_start = sp->bottom();
3859   if (sp->used_region().contains(_restart_addr)) {
3860     // Align down to a card boundary for the start of 0th task
3861     // for this space.
3862     aligned_start =
3863       (HeapWord*)align_size_down((uintptr_t)_restart_addr,
3864                                  CardTableModRefBS::card_size);
3865   }
3866 
3867   size_t chunk_size = sp->marking_task_size();
3868   while (!pst->is_task_claimed(/* reference */ nth_task)) {
3869     // Having claimed the nth task in this space,
3870     // compute the chunk that it corresponds to:
3871     MemRegion span = MemRegion(aligned_start + nth_task*chunk_size,
3872                                aligned_start + (nth_task+1)*chunk_size);
3873     // Try and bump the global finger via a CAS;
3874     // note that we need to do the global finger bump
3875     // _before_ taking the intersection below, because
3876     // the task corresponding to that region will be
3877     // deemed done even if the used_region() expands
3878     // because of allocation -- as it almost certainly will
3879     // during start-up while the threads yield in the
3880     // closure below.
3881     HeapWord* finger = span.end();
3882     bump_global_finger(finger);   // atomically
3883     // There are null tasks here corresponding to chunks
3884     // beyond the "top" address of the space.
3885     span = span.intersection(sp->used_region());
3886     if (!span.is_empty()) {  // Non-null task
3887       HeapWord* prev_obj;
3888       assert(!span.contains(_restart_addr) || nth_task == 0,
3889              "Inconsistency");
3890       if (nth_task == 0) {
3891         // For the 0th task, we'll not need to compute a block_start.
3892         if (span.contains(_restart_addr)) {
3893           // In the case of a restart because of stack overflow,
3894           // we might additionally skip a chunk prefix.
3895           prev_obj = _restart_addr;
3896         } else {
3897           prev_obj = span.start();
3898         }
3899       } else {
3900         // We want to skip the first object because
3901         // the protocol is to scan any object in its entirety
3902         // that _starts_ in this span; a fortiori, any
3903         // object starting in an earlier span is scanned
3904         // as part of an earlier claimed task.
3905         // Below we use the "careful" version of block_start
3906         // so we do not try to navigate uninitialized objects.
3907         prev_obj = sp->block_start_careful(span.start());
3908         // Below we use a variant of block_size that uses the
3909         // Printezis bits to avoid waiting for allocated
3910         // objects to become initialized/parsable.
3911         while (prev_obj < span.start()) {
3912           size_t sz = sp->block_size_no_stall(prev_obj, _collector);
3913           if (sz > 0) {
3914             prev_obj += sz;
3915           } else {
3916             // In this case we may end up doing a bit of redundant
3917             // scanning, but that appears unavoidable, short of
3918             // locking the free list locks; see bug 6324141.
3919             break;
3920           }
3921         }
3922       }
3923       if (prev_obj < span.end()) {
3924         MemRegion my_span = MemRegion(prev_obj, span.end());
3925         // Do the marking work within a non-empty span --
3926         // the last argument to the constructor indicates whether the
3927         // iteration should be incremental with periodic yields.
3928         Par_MarkFromRootsClosure cl(this, _collector, my_span,
3929                                     &_collector->_markBitMap,
3930                                     work_queue(i),
3931                                     &_collector->_markStack,
3932                                     &_collector->_revisitStack,
3933                                     _asynch);
3934         _collector->_markBitMap.iterate(&cl, my_span.start(), my_span.end());
3935       } // else nothing to do for this task
3936     }   // else nothing to do for this task
3937   }
3938   // We'd be tempted to assert here that since there are no
3939   // more tasks left to claim in this space, the global_finger
3940   // must exceed space->top() and a fortiori space->end(). However,
3941   // that would not quite be correct because the bumping of
3942   // global_finger occurs strictly after the claiming of a task,
3943   // so by the time we reach here the global finger may not yet
3944   // have been bumped up by the thread that claimed the last
3945   // task.
3946   pst->all_tasks_completed();
3947 }
3948 
3949 class Par_ConcMarkingClosure: public OopClosure {
3950  private:
3951   CMSCollector* _collector;
3952   MemRegion     _span;
3953   CMSBitMap*    _bit_map;
3954   CMSMarkStack* _overflow_stack;
3955   CMSMarkStack* _revisit_stack;     // XXXXXX Check proper use
3956   OopTaskQueue* _work_queue;
3957  protected:
3958   DO_OOP_WORK_DEFN
3959  public:
3960   Par_ConcMarkingClosure(CMSCollector* collector, OopTaskQueue* work_queue,
3961                          CMSBitMap* bit_map, CMSMarkStack* overflow_stack):
3962     _collector(collector),
3963     _span(_collector->_span),
3964     _work_queue(work_queue),
3965     _bit_map(bit_map),
3966     _overflow_stack(overflow_stack) { }   // need to initialize revisit stack etc.
3967   virtual void do_oop(oop* p);
3968   virtual void do_oop(narrowOop* p);
3969   void trim_queue(size_t max);
3970   void handle_stack_overflow(HeapWord* lost);
3971 };
3972 
3973 // Grey object scanning during work stealing phase --
3974 // the salient assumption here is that any references
3975 // that are in these stolen objects being scanned must
3976 // already have been initialized (else they would not have
3977 // been published), so we do not need to check for
3978 // uninitialized objects before pushing here.
3979 void Par_ConcMarkingClosure::do_oop(oop obj) {
3980   assert(obj->is_oop_or_null(true), "expected an oop or NULL");
3981   HeapWord* addr = (HeapWord*)obj;
3982   // Check if oop points into the CMS generation
3983   // and is not marked
3984   if (_span.contains(addr) && !_bit_map->isMarked(addr)) {
3985     // a white object ...
3986     // If we manage to "claim" the object, by being the
3987     // first thread to mark it, then we push it on our
3988     // marking stack
3989     if (_bit_map->par_mark(addr)) {     // ... now grey
3990       // push on work queue (grey set)
3991       bool simulate_overflow = false;
3992       NOT_PRODUCT(
3993         if (CMSMarkStackOverflowALot &&
3994             _collector->simulate_overflow()) {
3995           // simulate a stack overflow
3996           simulate_overflow = true;
3997         }
3998       )
3999       if (simulate_overflow ||
4000           !(_work_queue->push(obj) || _overflow_stack->par_push(obj))) {
4001         // stack overflow
4002         if (PrintCMSStatistics != 0) {
4003           gclog_or_tty->print_cr("CMS marking stack overflow (benign) at "
4004                                  SIZE_FORMAT, _overflow_stack->capacity());
4005         }
4006         // We cannot assert that the overflow stack is full because
4007         // it may have been emptied since.
4008         assert(simulate_overflow ||
4009                _work_queue->size() == _work_queue->max_elems(),
4010               "Else push should have succeeded");
4011         handle_stack_overflow(addr);
4012       }
4013     } // Else, some other thread got there first
4014   }
4015 }
4016 
4017 void Par_ConcMarkingClosure::do_oop(oop* p)       { Par_ConcMarkingClosure::do_oop_work(p); }
4018 void Par_ConcMarkingClosure::do_oop(narrowOop* p) { Par_ConcMarkingClosure::do_oop_work(p); }
4019 
4020 void Par_ConcMarkingClosure::trim_queue(size_t max) {
4021   while (_work_queue->size() > max) {
4022     oop new_oop;
4023     if (_work_queue->pop_local(new_oop)) {
4024       assert(new_oop->is_oop(), "Should be an oop");
4025       assert(_bit_map->isMarked((HeapWord*)new_oop), "Grey object");
4026       assert(_span.contains((HeapWord*)new_oop), "Not in span");
4027       assert(new_oop->is_parsable(), "Should be parsable");
4028       new_oop->oop_iterate(this);  // do_oop() above
4029     }
4030   }
4031 }
4032 
4033 // Upon stack overflow, we discard (part of) the stack,
4034 // remembering the least address amongst those discarded
4035 // in CMSCollector's _restart_address.
4036 void Par_ConcMarkingClosure::handle_stack_overflow(HeapWord* lost) {
4037   // We need to do this under a mutex to prevent other
4038   // workers from interfering with the work done below.
4039   MutexLockerEx ml(_overflow_stack->par_lock(),
4040                    Mutex::_no_safepoint_check_flag);
4041   // Remember the least grey address discarded
4042   HeapWord* ra = (HeapWord*)_overflow_stack->least_value(lost);
4043   _collector->lower_restart_addr(ra);
4044   _overflow_stack->reset();  // discard stack contents
4045   _overflow_stack->expand(); // expand the stack if possible
4046 }
4047 
4048 
4049 void CMSConcMarkingTask::do_work_steal(int i) {
4050   OopTaskQueue* work_q = work_queue(i);
4051   oop obj_to_scan;
4052   CMSBitMap* bm = &(_collector->_markBitMap);
4053   CMSMarkStack* ovflw = &(_collector->_markStack);
4054   int* seed = _collector->hash_seed(i);
4055   Par_ConcMarkingClosure cl(_collector, work_q, bm, ovflw);
4056   while (true) {
4057     cl.trim_queue(0);
4058     assert(work_q->size() == 0, "Should have been emptied above");
4059     if (get_work_from_overflow_stack(ovflw, work_q)) {
4060       // Can't assert below because the work obtained from the
4061       // overflow stack may already have been stolen from us.
4062       // assert(work_q->size() > 0, "Work from overflow stack");
4063       continue;
4064     } else if (task_queues()->steal(i, seed, /* reference */ obj_to_scan)) {
4065       assert(obj_to_scan->is_oop(), "Should be an oop");
4066       assert(bm->isMarked((HeapWord*)obj_to_scan), "Grey object");
4067       obj_to_scan->oop_iterate(&cl);
4068     } else if (terminator()->offer_termination()) {
4069       assert(work_q->size() == 0, "Impossible!");
4070       break;
4071     }
4072   }
4073 }
4074 
4075 // This is run by the CMS (coordinator) thread.
4076 void CMSConcMarkingTask::coordinator_yield() {
4077   assert(ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
4078          "CMS thread should hold CMS token");
4079 
4080   // First give up the locks, then yield, then re-lock
4081   // We should probably use a constructor/destructor idiom to
4082   // do this unlock/lock or modify the MutexUnlocker class to
4083   // serve our purpose. XXX
4084   assert_lock_strong(_bit_map_lock);
4085   _bit_map_lock->unlock();
4086   ConcurrentMarkSweepThread::desynchronize(true);
4087   ConcurrentMarkSweepThread::acknowledge_yield_request();
4088   _collector->stopTimer();
4089   if (PrintCMSStatistics != 0) {
4090     _collector->incrementYields();
4091   }
4092   _collector->icms_wait();
4093 
4094   // It is possible for whichever thread initiated the yield request
4095   // not to get a chance to wake up and take the bitmap lock between
4096   // this thread releasing it and reacquiring it. So, while the
4097   // should_yield() flag is on, let's sleep for a bit to give the
4098   // other thread a chance to wake up. The limit imposed on the number
4099   // of iterations is defensive, to avoid any unforseen circumstances
4100   // putting us into an infinite loop. Since it's always been this
4101   // (coordinator_yield()) method that was observed to cause the
4102   // problem, we are using a parameter (CMSCoordinatorYieldSleepCount)
4103   // which is by default non-zero. For the other seven methods that
4104   // also perform the yield operation, as are using a different
4105   // parameter (CMSYieldSleepCount) which is by default zero. This way we
4106   // can enable the sleeping for those methods too, if necessary.
4107   // See 6442774.
4108   //
4109   // We really need to reconsider the synchronization between the GC
4110   // thread and the yield-requesting threads in the future and we
4111   // should really use wait/notify, which is the recommended
4112   // way of doing this type of interaction. Additionally, we should
4113   // consolidate the eight methods that do the yield operation and they
4114   // are almost identical into one for better maintenability and
4115   // readability. See 6445193.
4116   //
4117   // Tony 2006.06.29
4118   for (unsigned i = 0; i < CMSCoordinatorYieldSleepCount &&
4119                    ConcurrentMarkSweepThread::should_yield() &&
4120                    !CMSCollector::foregroundGCIsActive(); ++i) {
4121     os::sleep(Thread::current(), 1, false);
4122     ConcurrentMarkSweepThread::acknowledge_yield_request();
4123   }
4124 
4125   ConcurrentMarkSweepThread::synchronize(true);
4126   _bit_map_lock->lock_without_safepoint_check();
4127   _collector->startTimer();
4128 }
4129 
4130 bool CMSCollector::do_marking_mt(bool asynch) {
4131   assert(ParallelCMSThreads > 0 && conc_workers() != NULL, "precondition");
4132   // In the future this would be determined ergonomically, based
4133   // on #cpu's, # active mutator threads (and load), and mutation rate.
4134   int num_workers = ParallelCMSThreads;
4135 
4136   CompactibleFreeListSpace* cms_space  = _cmsGen->cmsSpace();
4137   CompactibleFreeListSpace* perm_space = _permGen->cmsSpace();
4138 
4139   CMSConcMarkingTask tsk(this, cms_space, perm_space,
4140                          asynch, num_workers /* number requested XXX */,
4141                          conc_workers(), task_queues());
4142 
4143   // Since the actual number of workers we get may be different
4144   // from the number we requested above, do we need to do anything different
4145   // below? In particular, may be we need to subclass the SequantialSubTasksDone
4146   // class?? XXX
4147   cms_space ->initialize_sequential_subtasks_for_marking(num_workers);
4148   perm_space->initialize_sequential_subtasks_for_marking(num_workers);
4149 
4150   // Refs discovery is already non-atomic.
4151   assert(!ref_processor()->discovery_is_atomic(), "Should be non-atomic");
4152   // Mutate the Refs discovery so it is MT during the
4153   // multi-threaded marking phase.
4154   ReferenceProcessorMTMutator mt(ref_processor(), num_workers > 1);
4155 
4156   conc_workers()->start_task(&tsk);
4157   while (tsk.yielded()) {
4158     tsk.coordinator_yield();
4159     conc_workers()->continue_task(&tsk);
4160   }
4161   // If the task was aborted, _restart_addr will be non-NULL
4162   assert(tsk.completed() || _restart_addr != NULL, "Inconsistency");
4163   while (_restart_addr != NULL) {
4164     // XXX For now we do not make use of ABORTED state and have not
4165     // yet implemented the right abort semantics (even in the original
4166     // single-threaded CMS case). That needs some more investigation
4167     // and is deferred for now; see CR# TBF. 07252005YSR. XXX
4168     assert(!CMSAbortSemantics || tsk.aborted(), "Inconsistency");
4169     // If _restart_addr is non-NULL, a marking stack overflow
4170     // occured; we need to do a fresh marking iteration from the
4171     // indicated restart address.
4172     if (_foregroundGCIsActive && asynch) {
4173       // We may be running into repeated stack overflows, having
4174       // reached the limit of the stack size, while making very
4175       // slow forward progress. It may be best to bail out and
4176       // let the foreground collector do its job.
4177       // Clear _restart_addr, so that foreground GC
4178       // works from scratch. This avoids the headache of
4179       // a "rescan" which would otherwise be needed because
4180       // of the dirty mod union table & card table.
4181       _restart_addr = NULL;
4182       return false;
4183     }
4184     // Adjust the task to restart from _restart_addr
4185     tsk.reset(_restart_addr);
4186     cms_space ->initialize_sequential_subtasks_for_marking(num_workers,
4187                   _restart_addr);
4188     perm_space->initialize_sequential_subtasks_for_marking(num_workers,
4189                   _restart_addr);
4190     _restart_addr = NULL;
4191     // Get the workers going again
4192     conc_workers()->start_task(&tsk);
4193     while (tsk.yielded()) {
4194       tsk.coordinator_yield();
4195       conc_workers()->continue_task(&tsk);
4196     }
4197   }
4198   assert(tsk.completed(), "Inconsistency");
4199   assert(tsk.result() == true, "Inconsistency");
4200   return true;
4201 }
4202 
4203 bool CMSCollector::do_marking_st(bool asynch) {
4204   ResourceMark rm;
4205   HandleMark   hm;
4206 
4207   MarkFromRootsClosure markFromRootsClosure(this, _span, &_markBitMap,
4208     &_markStack, &_revisitStack, CMSYield && asynch);
4209   // the last argument to iterate indicates whether the iteration
4210   // should be incremental with periodic yields.
4211   _markBitMap.iterate(&markFromRootsClosure);
4212   // If _restart_addr is non-NULL, a marking stack overflow
4213   // occured; we need to do a fresh iteration from the
4214   // indicated restart address.
4215   while (_restart_addr != NULL) {
4216     if (_foregroundGCIsActive && asynch) {
4217       // We may be running into repeated stack overflows, having
4218       // reached the limit of the stack size, while making very
4219       // slow forward progress. It may be best to bail out and
4220       // let the foreground collector do its job.
4221       // Clear _restart_addr, so that foreground GC
4222       // works from scratch. This avoids the headache of
4223       // a "rescan" which would otherwise be needed because
4224       // of the dirty mod union table & card table.
4225       _restart_addr = NULL;
4226       return false;  // indicating failure to complete marking
4227     }
4228     // Deal with stack overflow:
4229     // we restart marking from _restart_addr
4230     HeapWord* ra = _restart_addr;
4231     markFromRootsClosure.reset(ra);
4232     _restart_addr = NULL;
4233     _markBitMap.iterate(&markFromRootsClosure, ra, _span.end());
4234   }
4235   return true;
4236 }
4237 
4238 void CMSCollector::preclean() {
4239   check_correct_thread_executing();
4240   assert(Thread::current()->is_ConcurrentGC_thread(), "Wrong thread");
4241   verify_work_stacks_empty();
4242   verify_overflow_empty();
4243   _abort_preclean = false;
4244   if (CMSPrecleaningEnabled) {
4245     _eden_chunk_index = 0;
4246     size_t used = get_eden_used();
4247     size_t capacity = get_eden_capacity();
4248     // Don't start sampling unless we will get sufficiently
4249     // many samples.
4250     if (used < (capacity/(CMSScheduleRemarkSamplingRatio * 100)
4251                 * CMSScheduleRemarkEdenPenetration)) {
4252       _start_sampling = true;
4253     } else {
4254       _start_sampling = false;
4255     }
4256     TraceCPUTime tcpu(PrintGCDetails, true, gclog_or_tty);
4257     CMSPhaseAccounting pa(this, "preclean", !PrintGCDetails);
4258     preclean_work(CMSPrecleanRefLists1, CMSPrecleanSurvivors1);
4259   }
4260   CMSTokenSync x(true); // is cms thread
4261   if (CMSPrecleaningEnabled) {
4262     sample_eden();
4263     _collectorState = AbortablePreclean;
4264   } else {
4265     _collectorState = FinalMarking;
4266   }
4267   verify_work_stacks_empty();
4268   verify_overflow_empty();
4269 }
4270 
4271 // Try and schedule the remark such that young gen
4272 // occupancy is CMSScheduleRemarkEdenPenetration %.
4273 void CMSCollector::abortable_preclean() {
4274   check_correct_thread_executing();
4275   assert(CMSPrecleaningEnabled,  "Inconsistent control state");
4276   assert(_collectorState == AbortablePreclean, "Inconsistent control state");
4277 
4278   // If Eden's current occupancy is below this threshold,
4279   // immediately schedule the remark; else preclean
4280   // past the next scavenge in an effort to
4281   // schedule the pause as described avove. By choosing
4282   // CMSScheduleRemarkEdenSizeThreshold >= max eden size
4283   // we will never do an actual abortable preclean cycle.
4284   if (get_eden_used() > CMSScheduleRemarkEdenSizeThreshold) {
4285     TraceCPUTime tcpu(PrintGCDetails, true, gclog_or_tty);
4286     CMSPhaseAccounting pa(this, "abortable-preclean", !PrintGCDetails);
4287     // We need more smarts in the abortable preclean
4288     // loop below to deal with cases where allocation
4289     // in young gen is very very slow, and our precleaning
4290     // is running a losing race against a horde of
4291     // mutators intent on flooding us with CMS updates
4292     // (dirty cards).
4293     // One, admittedly dumb, strategy is to give up
4294     // after a certain number of abortable precleaning loops
4295     // or after a certain maximum time. We want to make
4296     // this smarter in the next iteration.
4297     // XXX FIX ME!!! YSR
4298     size_t loops = 0, workdone = 0, cumworkdone = 0, waited = 0;
4299     while (!(should_abort_preclean() ||
4300              ConcurrentMarkSweepThread::should_terminate())) {
4301       workdone = preclean_work(CMSPrecleanRefLists2, CMSPrecleanSurvivors2);
4302       cumworkdone += workdone;
4303       loops++;
4304       // Voluntarily terminate abortable preclean phase if we have
4305       // been at it for too long.
4306       if ((CMSMaxAbortablePrecleanLoops != 0) &&
4307           loops >= CMSMaxAbortablePrecleanLoops) {
4308         if (PrintGCDetails) {
4309           gclog_or_tty->print(" CMS: abort preclean due to loops ");
4310         }
4311         break;
4312       }
4313       if (pa.wallclock_millis() > CMSMaxAbortablePrecleanTime) {
4314         if (PrintGCDetails) {
4315           gclog_or_tty->print(" CMS: abort preclean due to time ");
4316         }
4317         break;
4318       }
4319       // If we are doing little work each iteration, we should
4320       // take a short break.
4321       if (workdone < CMSAbortablePrecleanMinWorkPerIteration) {
4322         // Sleep for some time, waiting for work to accumulate
4323         stopTimer();
4324         cmsThread()->wait_on_cms_lock(CMSAbortablePrecleanWaitMillis);
4325         startTimer();
4326         waited++;
4327       }
4328     }
4329     if (PrintCMSStatistics > 0) {
4330       gclog_or_tty->print(" [%d iterations, %d waits, %d cards)] ",
4331                           loops, waited, cumworkdone);
4332     }
4333   }
4334   CMSTokenSync x(true); // is cms thread
4335   if (_collectorState != Idling) {
4336     assert(_collectorState == AbortablePreclean,
4337            "Spontaneous state transition?");
4338     _collectorState = FinalMarking;
4339   } // Else, a foreground collection completed this CMS cycle.
4340   return;
4341 }
4342 
4343 // Respond to an Eden sampling opportunity
4344 void CMSCollector::sample_eden() {
4345   // Make sure a young gc cannot sneak in between our
4346   // reading and recording of a sample.
4347   assert(Thread::current()->is_ConcurrentGC_thread(),
4348          "Only the cms thread may collect Eden samples");
4349   assert(ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
4350          "Should collect samples while holding CMS token");
4351   if (!_start_sampling) {
4352     return;
4353   }
4354   if (_eden_chunk_array) {
4355     if (_eden_chunk_index < _eden_chunk_capacity) {
4356       _eden_chunk_array[_eden_chunk_index] = *_top_addr;   // take sample
4357       assert(_eden_chunk_array[_eden_chunk_index] <= *_end_addr,
4358              "Unexpected state of Eden");
4359       // We'd like to check that what we just sampled is an oop-start address;
4360       // however, we cannot do that here since the object may not yet have been
4361       // initialized. So we'll instead do the check when we _use_ this sample
4362       // later.
4363       if (_eden_chunk_index == 0 ||
4364           (pointer_delta(_eden_chunk_array[_eden_chunk_index],
4365                          _eden_chunk_array[_eden_chunk_index-1])
4366            >= CMSSamplingGrain)) {
4367         _eden_chunk_index++;  // commit sample
4368       }
4369     }
4370   }
4371   if ((_collectorState == AbortablePreclean) && !_abort_preclean) {
4372     size_t used = get_eden_used();
4373     size_t capacity = get_eden_capacity();
4374     assert(used <= capacity, "Unexpected state of Eden");
4375     if (used >  (capacity/100 * CMSScheduleRemarkEdenPenetration)) {
4376       _abort_preclean = true;
4377     }
4378   }
4379 }
4380 
4381 
4382 size_t CMSCollector::preclean_work(bool clean_refs, bool clean_survivor) {
4383   assert(_collectorState == Precleaning ||
4384          _collectorState == AbortablePreclean, "incorrect state");
4385   ResourceMark rm;
4386   HandleMark   hm;
4387   // Do one pass of scrubbing the discovered reference lists
4388   // to remove any reference objects with strongly-reachable
4389   // referents.
4390   if (clean_refs) {
4391     ReferenceProcessor* rp = ref_processor();
4392     CMSPrecleanRefsYieldClosure yield_cl(this);
4393     assert(rp->span().equals(_span), "Spans should be equal");
4394     CMSKeepAliveClosure keep_alive(this, _span, &_markBitMap,
4395                                    &_markStack);
4396     CMSDrainMarkingStackClosure complete_trace(this,
4397                                   _span, &_markBitMap, &_markStack,
4398                                   &keep_alive);
4399 
4400     // We don't want this step to interfere with a young
4401     // collection because we don't want to take CPU
4402     // or memory bandwidth away from the young GC threads
4403     // (which may be as many as there are CPUs).
4404     // Note that we don't need to protect ourselves from
4405     // interference with mutators because they can't
4406     // manipulate the discovered reference lists nor affect
4407     // the computed reachability of the referents, the
4408     // only properties manipulated by the precleaning
4409     // of these reference lists.
4410     stopTimer();
4411     CMSTokenSyncWithLocks x(true /* is cms thread */,
4412                             bitMapLock());
4413     startTimer();
4414     sample_eden();
4415     // The following will yield to allow foreground
4416     // collection to proceed promptly. XXX YSR:
4417     // The code in this method may need further
4418     // tweaking for better performance and some restructuring
4419     // for cleaner interfaces.
4420     rp->preclean_discovered_references(
4421           rp->is_alive_non_header(), &keep_alive, &complete_trace,
4422           &yield_cl);
4423   }
4424 
4425   if (clean_survivor) {  // preclean the active survivor space(s)
4426     assert(_young_gen->kind() == Generation::DefNew ||
4427            _young_gen->kind() == Generation::ParNew ||
4428            _young_gen->kind() == Generation::ASParNew,
4429          "incorrect type for cast");
4430     DefNewGeneration* dng = (DefNewGeneration*)_young_gen;
4431     PushAndMarkClosure pam_cl(this, _span, ref_processor(),
4432                              &_markBitMap, &_modUnionTable,
4433                              &_markStack, &_revisitStack,
4434                              true /* precleaning phase */);
4435     stopTimer();
4436     CMSTokenSyncWithLocks ts(true /* is cms thread */,
4437                              bitMapLock());
4438     startTimer();
4439     unsigned int before_count =
4440       GenCollectedHeap::heap()->total_collections();
4441     SurvivorSpacePrecleanClosure
4442       sss_cl(this, _span, &_markBitMap, &_markStack,
4443              &pam_cl, before_count, CMSYield);
4444     dng->from()->object_iterate_careful(&sss_cl);
4445     dng->to()->object_iterate_careful(&sss_cl);
4446   }
4447   MarkRefsIntoAndScanClosure
4448     mrias_cl(_span, ref_processor(), &_markBitMap, &_modUnionTable,
4449              &_markStack, &_revisitStack, this, CMSYield,
4450              true /* precleaning phase */);
4451   // CAUTION: The following closure has persistent state that may need to
4452   // be reset upon a decrease in the sequence of addresses it
4453   // processes.
4454   ScanMarkedObjectsAgainCarefullyClosure
4455     smoac_cl(this, _span,
4456       &_markBitMap, &_markStack, &_revisitStack, &mrias_cl, CMSYield);
4457 
4458   // Preclean dirty cards in ModUnionTable and CardTable using
4459   // appropriate convergence criterion;
4460   // repeat CMSPrecleanIter times unless we find that
4461   // we are losing.
4462   assert(CMSPrecleanIter < 10, "CMSPrecleanIter is too large");
4463   assert(CMSPrecleanNumerator < CMSPrecleanDenominator,
4464          "Bad convergence multiplier");
4465   assert(CMSPrecleanThreshold >= 100,
4466          "Unreasonably low CMSPrecleanThreshold");
4467 
4468   size_t numIter, cumNumCards, lastNumCards, curNumCards;
4469   for (numIter = 0, cumNumCards = lastNumCards = curNumCards = 0;
4470        numIter < CMSPrecleanIter;
4471        numIter++, lastNumCards = curNumCards, cumNumCards += curNumCards) {
4472     curNumCards  = preclean_mod_union_table(_cmsGen, &smoac_cl);
4473     if (CMSPermGenPrecleaningEnabled) {
4474       curNumCards  += preclean_mod_union_table(_permGen, &smoac_cl);
4475     }
4476     if (Verbose && PrintGCDetails) {
4477       gclog_or_tty->print(" (modUnionTable: %d cards)", curNumCards);
4478     }
4479     // Either there are very few dirty cards, so re-mark
4480     // pause will be small anyway, or our pre-cleaning isn't
4481     // that much faster than the rate at which cards are being
4482     // dirtied, so we might as well stop and re-mark since
4483     // precleaning won't improve our re-mark time by much.
4484     if (curNumCards <= CMSPrecleanThreshold ||
4485         (numIter > 0 &&
4486          (curNumCards * CMSPrecleanDenominator >
4487          lastNumCards * CMSPrecleanNumerator))) {
4488       numIter++;
4489       cumNumCards += curNumCards;
4490       break;
4491     }
4492   }
4493   curNumCards = preclean_card_table(_cmsGen, &smoac_cl);
4494   if (CMSPermGenPrecleaningEnabled) {
4495     curNumCards += preclean_card_table(_permGen, &smoac_cl);
4496   }
4497   cumNumCards += curNumCards;
4498   if (PrintGCDetails && PrintCMSStatistics != 0) {
4499     gclog_or_tty->print_cr(" (cardTable: %d cards, re-scanned %d cards, %d iterations)",
4500                   curNumCards, cumNumCards, numIter);
4501   }
4502   return cumNumCards;   // as a measure of useful work done
4503 }
4504 
4505 // PRECLEANING NOTES:
4506 // Precleaning involves:
4507 // . reading the bits of the modUnionTable and clearing the set bits.
4508 // . For the cards corresponding to the set bits, we scan the
4509 //   objects on those cards. This means we need the free_list_lock
4510 //   so that we can safely iterate over the CMS space when scanning
4511 //   for oops.
4512 // . When we scan the objects, we'll be both reading and setting
4513 //   marks in the marking bit map, so we'll need the marking bit map.
4514 // . For protecting _collector_state transitions, we take the CGC_lock.
4515 //   Note that any races in the reading of of card table entries by the
4516 //   CMS thread on the one hand and the clearing of those entries by the
4517 //   VM thread or the setting of those entries by the mutator threads on the
4518 //   other are quite benign. However, for efficiency it makes sense to keep
4519 //   the VM thread from racing with the CMS thread while the latter is
4520 //   dirty card info to the modUnionTable. We therefore also use the
4521 //   CGC_lock to protect the reading of the card table and the mod union
4522 //   table by the CM thread.
4523 // . We run concurrently with mutator updates, so scanning
4524 //   needs to be done carefully  -- we should not try to scan
4525 //   potentially uninitialized objects.
4526 //
4527 // Locking strategy: While holding the CGC_lock, we scan over and
4528 // reset a maximal dirty range of the mod union / card tables, then lock
4529 // the free_list_lock and bitmap lock to do a full marking, then
4530 // release these locks; and repeat the cycle. This allows for a
4531 // certain amount of fairness in the sharing of these locks between
4532 // the CMS collector on the one hand, and the VM thread and the
4533 // mutators on the other.
4534 
4535 // NOTE: preclean_mod_union_table() and preclean_card_table()
4536 // further below are largely identical; if you need to modify
4537 // one of these methods, please check the other method too.
4538 
4539 size_t CMSCollector::preclean_mod_union_table(
4540   ConcurrentMarkSweepGeneration* gen,
4541   ScanMarkedObjectsAgainCarefullyClosure* cl) {
4542   verify_work_stacks_empty();
4543   verify_overflow_empty();
4544 
4545   // strategy: starting with the first card, accumulate contiguous
4546   // ranges of dirty cards; clear these cards, then scan the region
4547   // covered by these cards.
4548 
4549   // Since all of the MUT is committed ahead, we can just use
4550   // that, in case the generations expand while we are precleaning.
4551   // It might also be fine to just use the committed part of the
4552   // generation, but we might potentially miss cards when the
4553   // generation is rapidly expanding while we are in the midst
4554   // of precleaning.
4555   HeapWord* startAddr = gen->reserved().start();
4556   HeapWord* endAddr   = gen->reserved().end();
4557 
4558   cl->setFreelistLock(gen->freelistLock());   // needed for yielding
4559 
4560   size_t numDirtyCards, cumNumDirtyCards;
4561   HeapWord *nextAddr, *lastAddr;
4562   for (cumNumDirtyCards = numDirtyCards = 0,
4563        nextAddr = lastAddr = startAddr;
4564        nextAddr < endAddr;
4565        nextAddr = lastAddr, cumNumDirtyCards += numDirtyCards) {
4566 
4567     ResourceMark rm;
4568     HandleMark   hm;
4569 
4570     MemRegion dirtyRegion;
4571     {
4572       stopTimer();
4573       CMSTokenSync ts(true);
4574       startTimer();
4575       sample_eden();
4576       // Get dirty region starting at nextOffset (inclusive),
4577       // simultaneously clearing it.
4578       dirtyRegion =
4579         _modUnionTable.getAndClearMarkedRegion(nextAddr, endAddr);
4580       assert(dirtyRegion.start() >= nextAddr,
4581              "returned region inconsistent?");
4582     }
4583     // Remember where the next search should begin.
4584     // The returned region (if non-empty) is a right open interval,
4585     // so lastOffset is obtained from the right end of that
4586     // interval.
4587     lastAddr = dirtyRegion.end();
4588     // Should do something more transparent and less hacky XXX
4589     numDirtyCards =
4590       _modUnionTable.heapWordDiffToOffsetDiff(dirtyRegion.word_size());
4591 
4592     // We'll scan the cards in the dirty region (with periodic
4593     // yields for foreground GC as needed).
4594     if (!dirtyRegion.is_empty()) {
4595       assert(numDirtyCards > 0, "consistency check");
4596       HeapWord* stop_point = NULL;
4597       stopTimer();
4598       CMSTokenSyncWithLocks ts(true, gen->freelistLock(),
4599                                bitMapLock());
4600       startTimer();
4601       {
4602         verify_work_stacks_empty();
4603         verify_overflow_empty();
4604         sample_eden();
4605         stop_point =
4606           gen->cmsSpace()->object_iterate_careful_m(dirtyRegion, cl);
4607       }
4608       if (stop_point != NULL) {
4609         // The careful iteration stopped early either because it found an
4610         // uninitialized object, or because we were in the midst of an
4611         // "abortable preclean", which should now be aborted. Redirty
4612         // the bits corresponding to the partially-scanned or unscanned
4613         // cards. We'll either restart at the next block boundary or
4614         // abort the preclean.
4615         assert((CMSPermGenPrecleaningEnabled && (gen == _permGen)) ||
4616                (_collectorState == AbortablePreclean && should_abort_preclean()),
4617                "Unparsable objects should only be in perm gen.");
4618         _modUnionTable.mark_range(MemRegion(stop_point, dirtyRegion.end()));
4619         if (should_abort_preclean()) {
4620           break; // out of preclean loop
4621         } else {
4622           // Compute the next address at which preclean should pick up;
4623           // might need bitMapLock in order to read P-bits.
4624           lastAddr = next_card_start_after_block(stop_point);
4625         }
4626       }
4627     } else {
4628       assert(lastAddr == endAddr, "consistency check");
4629       assert(numDirtyCards == 0, "consistency check");
4630       break;
4631     }
4632   }
4633   verify_work_stacks_empty();
4634   verify_overflow_empty();
4635   return cumNumDirtyCards;
4636 }
4637 
4638 // NOTE: preclean_mod_union_table() above and preclean_card_table()
4639 // below are largely identical; if you need to modify
4640 // one of these methods, please check the other method too.
4641 
4642 size_t CMSCollector::preclean_card_table(ConcurrentMarkSweepGeneration* gen,
4643   ScanMarkedObjectsAgainCarefullyClosure* cl) {
4644   // strategy: it's similar to precleamModUnionTable above, in that
4645   // we accumulate contiguous ranges of dirty cards, mark these cards
4646   // precleaned, then scan the region covered by these cards.
4647   HeapWord* endAddr   = (HeapWord*)(gen->_virtual_space.high());
4648   HeapWord* startAddr = (HeapWord*)(gen->_virtual_space.low());
4649 
4650   cl->setFreelistLock(gen->freelistLock());   // needed for yielding
4651 
4652   size_t numDirtyCards, cumNumDirtyCards;
4653   HeapWord *lastAddr, *nextAddr;
4654 
4655   for (cumNumDirtyCards = numDirtyCards = 0,
4656        nextAddr = lastAddr = startAddr;
4657        nextAddr < endAddr;
4658        nextAddr = lastAddr, cumNumDirtyCards += numDirtyCards) {
4659 
4660     ResourceMark rm;
4661     HandleMark   hm;
4662 
4663     MemRegion dirtyRegion;
4664     {
4665       // See comments in "Precleaning notes" above on why we
4666       // do this locking. XXX Could the locking overheads be
4667       // too high when dirty cards are sparse? [I don't think so.]
4668       stopTimer();
4669       CMSTokenSync x(true); // is cms thread
4670       startTimer();
4671       sample_eden();
4672       // Get and clear dirty region from card table
4673       dirtyRegion = _ct->ct_bs()->dirty_card_range_after_reset(
4674                                     MemRegion(nextAddr, endAddr),
4675                                     true,
4676                                     CardTableModRefBS::precleaned_card_val());
4677 
4678       assert(dirtyRegion.start() >= nextAddr,
4679              "returned region inconsistent?");
4680     }
4681     lastAddr = dirtyRegion.end();
4682     numDirtyCards =
4683       dirtyRegion.word_size()/CardTableModRefBS::card_size_in_words;
4684 
4685     if (!dirtyRegion.is_empty()) {
4686       stopTimer();
4687       CMSTokenSyncWithLocks ts(true, gen->freelistLock(), bitMapLock());
4688       startTimer();
4689       sample_eden();
4690       verify_work_stacks_empty();
4691       verify_overflow_empty();
4692       HeapWord* stop_point =
4693         gen->cmsSpace()->object_iterate_careful_m(dirtyRegion, cl);
4694       if (stop_point != NULL) {
4695         // The careful iteration stopped early because it found an
4696         // uninitialized object.  Redirty the bits corresponding to the
4697         // partially-scanned or unscanned cards, and start again at the
4698         // next block boundary.
4699         assert(CMSPermGenPrecleaningEnabled ||
4700                (_collectorState == AbortablePreclean && should_abort_preclean()),
4701                "Unparsable objects should only be in perm gen.");
4702         _ct->ct_bs()->invalidate(MemRegion(stop_point, dirtyRegion.end()));
4703         if (should_abort_preclean()) {
4704           break; // out of preclean loop
4705         } else {
4706           // Compute the next address at which preclean should pick up.
4707           lastAddr = next_card_start_after_block(stop_point);
4708         }
4709       }
4710     } else {
4711       break;
4712     }
4713   }
4714   verify_work_stacks_empty();
4715   verify_overflow_empty();
4716   return cumNumDirtyCards;
4717 }
4718 
4719 void CMSCollector::checkpointRootsFinal(bool asynch,
4720   bool clear_all_soft_refs, bool init_mark_was_synchronous) {
4721   assert(_collectorState == FinalMarking, "incorrect state transition?");
4722   check_correct_thread_executing();
4723   // world is stopped at this checkpoint
4724   assert(SafepointSynchronize::is_at_safepoint(),
4725          "world should be stopped");
4726   verify_work_stacks_empty();
4727   verify_overflow_empty();
4728 
4729   SpecializationStats::clear();
4730   if (PrintGCDetails) {
4731     gclog_or_tty->print("[YG occupancy: "SIZE_FORMAT" K ("SIZE_FORMAT" K)]",
4732                         _young_gen->used() / K,
4733                         _young_gen->capacity() / K);
4734   }
4735   if (asynch) {
4736     if (CMSScavengeBeforeRemark) {
4737       GenCollectedHeap* gch = GenCollectedHeap::heap();
4738       // Temporarily set flag to false, GCH->do_collection will
4739       // expect it to be false and set to true
4740       FlagSetting fl(gch->_is_gc_active, false);
4741       NOT_PRODUCT(TraceTime t("Scavenge-Before-Remark",
4742         PrintGCDetails && Verbose, true, gclog_or_tty);)
4743       int level = _cmsGen->level() - 1;
4744       if (level >= 0) {
4745         gch->do_collection(true,        // full (i.e. force, see below)
4746                            false,       // !clear_all_soft_refs
4747                            0,           // size
4748                            false,       // is_tlab
4749                            level        // max_level
4750                           );
4751       }
4752     }
4753     FreelistLocker x(this);
4754     MutexLockerEx y(bitMapLock(),
4755                     Mutex::_no_safepoint_check_flag);
4756     assert(!init_mark_was_synchronous, "but that's impossible!");
4757     checkpointRootsFinalWork(asynch, clear_all_soft_refs, false);
4758   } else {
4759     // already have all the locks
4760     checkpointRootsFinalWork(asynch, clear_all_soft_refs,
4761                              init_mark_was_synchronous);
4762   }
4763   verify_work_stacks_empty();
4764   verify_overflow_empty();
4765   SpecializationStats::print();
4766 }
4767 
4768 void CMSCollector::checkpointRootsFinalWork(bool asynch,
4769   bool clear_all_soft_refs, bool init_mark_was_synchronous) {
4770 
4771   NOT_PRODUCT(TraceTime tr("checkpointRootsFinalWork", PrintGCDetails, false, gclog_or_tty);)
4772 
4773   assert(haveFreelistLocks(), "must have free list locks");
4774   assert_lock_strong(bitMapLock());
4775 
4776   if (UseAdaptiveSizePolicy) {
4777     size_policy()->checkpoint_roots_final_begin();
4778   }
4779 
4780   ResourceMark rm;
4781   HandleMark   hm;
4782 
4783   GenCollectedHeap* gch = GenCollectedHeap::heap();
4784 
4785   if (should_unload_classes()) {
4786     CodeCache::gc_prologue();
4787   }
4788   assert(haveFreelistLocks(), "must have free list locks");
4789   assert_lock_strong(bitMapLock());
4790 
4791   if (!init_mark_was_synchronous) {
4792     // We might assume that we need not fill TLAB's when
4793     // CMSScavengeBeforeRemark is set, because we may have just done
4794     // a scavenge which would have filled all TLAB's -- and besides
4795     // Eden would be empty. This however may not always be the case --
4796     // for instance although we asked for a scavenge, it may not have
4797     // happened because of a JNI critical section. We probably need
4798     // a policy for deciding whether we can in that case wait until
4799     // the critical section releases and then do the remark following
4800     // the scavenge, and skip it here. In the absence of that policy,
4801     // or of an indication of whether the scavenge did indeed occur,
4802     // we cannot rely on TLAB's having been filled and must do
4803     // so here just in case a scavenge did not happen.
4804     gch->ensure_parsability(false);  // fill TLAB's, but no need to retire them
4805     // Update the saved marks which may affect the root scans.
4806     gch->save_marks();
4807 
4808     {
4809       COMPILER2_PRESENT(DerivedPointerTableDeactivate dpt_deact;)
4810 
4811       // Note on the role of the mod union table:
4812       // Since the marker in "markFromRoots" marks concurrently with
4813       // mutators, it is possible for some reachable objects not to have been
4814       // scanned. For instance, an only reference to an object A was
4815       // placed in object B after the marker scanned B. Unless B is rescanned,
4816       // A would be collected. Such updates to references in marked objects
4817       // are detected via the mod union table which is the set of all cards
4818       // dirtied since the first checkpoint in this GC cycle and prior to
4819       // the most recent young generation GC, minus those cleaned up by the
4820       // concurrent precleaning.
4821       if (CMSParallelRemarkEnabled && ParallelGCThreads > 0) {
4822         TraceTime t("Rescan (parallel) ", PrintGCDetails, false, gclog_or_tty);
4823         do_remark_parallel();
4824       } else {
4825         TraceTime t("Rescan (non-parallel) ", PrintGCDetails, false,
4826                     gclog_or_tty);
4827         do_remark_non_parallel();
4828       }
4829     }
4830   } else {
4831     assert(!asynch, "Can't have init_mark_was_synchronous in asynch mode");
4832     // The initial mark was stop-world, so there's no rescanning to
4833     // do; go straight on to the next step below.
4834   }
4835   verify_work_stacks_empty();
4836   verify_overflow_empty();
4837 
4838   {
4839     NOT_PRODUCT(TraceTime ts("refProcessingWork", PrintGCDetails, false, gclog_or_tty);)
4840     refProcessingWork(asynch, clear_all_soft_refs);
4841   }
4842   verify_work_stacks_empty();
4843   verify_overflow_empty();
4844 
4845   if (should_unload_classes()) {
4846     CodeCache::gc_epilogue();
4847   }
4848 
4849   // If we encountered any (marking stack / work queue) overflow
4850   // events during the current CMS cycle, take appropriate
4851   // remedial measures, where possible, so as to try and avoid
4852   // recurrence of that condition.
4853   assert(_markStack.isEmpty(), "No grey objects");
4854   size_t ser_ovflw = _ser_pmc_remark_ovflw + _ser_pmc_preclean_ovflw +
4855                      _ser_kac_ovflw;
4856   if (ser_ovflw > 0) {
4857     if (PrintCMSStatistics != 0) {
4858       gclog_or_tty->print_cr("Marking stack overflow (benign) "
4859         "(pmc_pc="SIZE_FORMAT", pmc_rm="SIZE_FORMAT", kac="SIZE_FORMAT")",
4860         _ser_pmc_preclean_ovflw, _ser_pmc_remark_ovflw,
4861         _ser_kac_ovflw);
4862     }
4863     _markStack.expand();
4864     _ser_pmc_remark_ovflw = 0;
4865     _ser_pmc_preclean_ovflw = 0;
4866     _ser_kac_ovflw = 0;
4867   }
4868   if (_par_pmc_remark_ovflw > 0 || _par_kac_ovflw > 0) {
4869     if (PrintCMSStatistics != 0) {
4870       gclog_or_tty->print_cr("Work queue overflow (benign) "
4871         "(pmc_rm="SIZE_FORMAT", kac="SIZE_FORMAT")",
4872         _par_pmc_remark_ovflw, _par_kac_ovflw);
4873     }
4874     _par_pmc_remark_ovflw = 0;
4875     _par_kac_ovflw = 0;
4876   }
4877   if (PrintCMSStatistics != 0) {
4878      if (_markStack._hit_limit > 0) {
4879        gclog_or_tty->print_cr(" (benign) Hit max stack size limit ("SIZE_FORMAT")",
4880                               _markStack._hit_limit);
4881      }
4882      if (_markStack._failed_double > 0) {
4883        gclog_or_tty->print_cr(" (benign) Failed stack doubling ("SIZE_FORMAT"),"
4884                               " current capacity "SIZE_FORMAT,
4885                               _markStack._failed_double,
4886                               _markStack.capacity());
4887      }
4888   }
4889   _markStack._hit_limit = 0;
4890   _markStack._failed_double = 0;
4891 
4892   if ((VerifyAfterGC || VerifyDuringGC) &&
4893       GenCollectedHeap::heap()->total_collections() >= VerifyGCStartAt) {
4894     verify_after_remark();
4895   }
4896 
4897   // Change under the freelistLocks.
4898   _collectorState = Sweeping;
4899   // Call isAllClear() under bitMapLock
4900   assert(_modUnionTable.isAllClear(), "Should be clear by end of the"
4901     " final marking");
4902   if (UseAdaptiveSizePolicy) {
4903     size_policy()->checkpoint_roots_final_end(gch->gc_cause());
4904   }
4905 }
4906 
4907 // Parallel remark task
4908 class CMSParRemarkTask: public AbstractGangTask {
4909   CMSCollector* _collector;
4910   WorkGang*     _workers;
4911   int           _n_workers;
4912   CompactibleFreeListSpace* _cms_space;
4913   CompactibleFreeListSpace* _perm_space;
4914 
4915   // The per-thread work queues, available here for stealing.
4916   OopTaskQueueSet*       _task_queues;
4917   ParallelTaskTerminator _term;
4918 
4919  public:
4920   CMSParRemarkTask(CMSCollector* collector,
4921                    CompactibleFreeListSpace* cms_space,
4922                    CompactibleFreeListSpace* perm_space,
4923                    int n_workers, WorkGang* workers,
4924                    OopTaskQueueSet* task_queues):
4925     AbstractGangTask("Rescan roots and grey objects in parallel"),
4926     _collector(collector),
4927     _cms_space(cms_space), _perm_space(perm_space),
4928     _n_workers(n_workers),
4929     _workers(workers),
4930     _task_queues(task_queues),
4931     _term(workers->total_workers(), task_queues) { }
4932 
4933   OopTaskQueueSet* task_queues() { return _task_queues; }
4934 
4935   OopTaskQueue* work_queue(int i) { return task_queues()->queue(i); }
4936 
4937   ParallelTaskTerminator* terminator() { return &_term; }
4938 
4939   void work(int i);
4940 
4941  private:
4942   // Work method in support of parallel rescan ... of young gen spaces
4943   void do_young_space_rescan(int i, Par_MarkRefsIntoAndScanClosure* cl,
4944                              ContiguousSpace* space,
4945                              HeapWord** chunk_array, size_t chunk_top);
4946 
4947   // ... of  dirty cards in old space
4948   void do_dirty_card_rescan_tasks(CompactibleFreeListSpace* sp, int i,
4949                                   Par_MarkRefsIntoAndScanClosure* cl);
4950 
4951   // ... work stealing for the above
4952   void do_work_steal(int i, Par_MarkRefsIntoAndScanClosure* cl, int* seed);
4953 };
4954 
4955 void CMSParRemarkTask::work(int i) {
4956   elapsedTimer _timer;
4957   ResourceMark rm;
4958   HandleMark   hm;
4959 
4960   // ---------- rescan from roots --------------
4961   _timer.start();
4962   GenCollectedHeap* gch = GenCollectedHeap::heap();
4963   Par_MarkRefsIntoAndScanClosure par_mrias_cl(_collector,
4964     _collector->_span, _collector->ref_processor(),
4965     &(_collector->_markBitMap),
4966     work_queue(i), &(_collector->_revisitStack));
4967 
4968   // Rescan young gen roots first since these are likely
4969   // coarsely partitioned and may, on that account, constitute
4970   // the critical path; thus, it's best to start off that
4971   // work first.
4972   // ---------- young gen roots --------------
4973   {
4974     DefNewGeneration* dng = _collector->_young_gen->as_DefNewGeneration();
4975     EdenSpace* eden_space = dng->eden();
4976     ContiguousSpace* from_space = dng->from();
4977     ContiguousSpace* to_space   = dng->to();
4978 
4979     HeapWord** eca = _collector->_eden_chunk_array;
4980     size_t     ect = _collector->_eden_chunk_index;
4981     HeapWord** sca = _collector->_survivor_chunk_array;
4982     size_t     sct = _collector->_survivor_chunk_index;
4983 
4984     assert(ect <= _collector->_eden_chunk_capacity, "out of bounds");
4985     assert(sct <= _collector->_survivor_chunk_capacity, "out of bounds");
4986 
4987     do_young_space_rescan(i, &par_mrias_cl, to_space, NULL, 0);
4988     do_young_space_rescan(i, &par_mrias_cl, from_space, sca, sct);
4989     do_young_space_rescan(i, &par_mrias_cl, eden_space, eca, ect);
4990 
4991     _timer.stop();
4992     if (PrintCMSStatistics != 0) {
4993       gclog_or_tty->print_cr(
4994         "Finished young gen rescan work in %dth thread: %3.3f sec",
4995         i, _timer.seconds());
4996     }
4997   }
4998 
4999   // ---------- remaining roots --------------
5000   _timer.reset();
5001   _timer.start();
5002   gch->gen_process_strong_roots(_collector->_cmsGen->level(),
5003                                 false,     // yg was scanned above
5004                                 true,      // collecting perm gen
5005                                 SharedHeap::ScanningOption(_collector->CMSCollector::roots_scanning_options()),
5006                                 NULL, &par_mrias_cl);
5007   _timer.stop();
5008   if (PrintCMSStatistics != 0) {
5009     gclog_or_tty->print_cr(
5010       "Finished remaining root rescan work in %dth thread: %3.3f sec",
5011       i, _timer.seconds());
5012   }
5013 
5014   // ---------- rescan dirty cards ------------
5015   _timer.reset();
5016   _timer.start();
5017 
5018   // Do the rescan tasks for each of the two spaces
5019   // (cms_space and perm_space) in turn.
5020   do_dirty_card_rescan_tasks(_cms_space, i, &par_mrias_cl);
5021   do_dirty_card_rescan_tasks(_perm_space, i, &par_mrias_cl);
5022   _timer.stop();
5023   if (PrintCMSStatistics != 0) {
5024     gclog_or_tty->print_cr(
5025       "Finished dirty card rescan work in %dth thread: %3.3f sec",
5026       i, _timer.seconds());
5027   }
5028 
5029   // ---------- steal work from other threads ...
5030   // ---------- ... and drain overflow list.
5031   _timer.reset();
5032   _timer.start();
5033   do_work_steal(i, &par_mrias_cl, _collector->hash_seed(i));
5034   _timer.stop();
5035   if (PrintCMSStatistics != 0) {
5036     gclog_or_tty->print_cr(
5037       "Finished work stealing in %dth thread: %3.3f sec",
5038       i, _timer.seconds());
5039   }
5040 }
5041 
5042 void
5043 CMSParRemarkTask::do_young_space_rescan(int i,
5044   Par_MarkRefsIntoAndScanClosure* cl, ContiguousSpace* space,
5045   HeapWord** chunk_array, size_t chunk_top) {
5046   // Until all tasks completed:
5047   // . claim an unclaimed task
5048   // . compute region boundaries corresponding to task claimed
5049   //   using chunk_array
5050   // . par_oop_iterate(cl) over that region
5051 
5052   ResourceMark rm;
5053   HandleMark   hm;
5054 
5055   SequentialSubTasksDone* pst = space->par_seq_tasks();
5056   assert(pst->valid(), "Uninitialized use?");
5057 
5058   int nth_task = 0;
5059   int n_tasks  = pst->n_tasks();
5060 
5061   HeapWord *start, *end;
5062   while (!pst->is_task_claimed(/* reference */ nth_task)) {
5063     // We claimed task # nth_task; compute its boundaries.
5064     if (chunk_top == 0) {  // no samples were taken
5065       assert(nth_task == 0 && n_tasks == 1, "Can have only 1 EdenSpace task");
5066       start = space->bottom();
5067       end   = space->top();
5068     } else if (nth_task == 0) {
5069       start = space->bottom();
5070       end   = chunk_array[nth_task];
5071     } else if (nth_task < (jint)chunk_top) {
5072       assert(nth_task >= 1, "Control point invariant");
5073       start = chunk_array[nth_task - 1];
5074       end   = chunk_array[nth_task];
5075     } else {
5076       assert(nth_task == (jint)chunk_top, "Control point invariant");
5077       start = chunk_array[chunk_top - 1];
5078       end   = space->top();
5079     }
5080     MemRegion mr(start, end);
5081     // Verify that mr is in space
5082     assert(mr.is_empty() || space->used_region().contains(mr),
5083            "Should be in space");
5084     // Verify that "start" is an object boundary
5085     assert(mr.is_empty() || oop(mr.start())->is_oop(),
5086            "Should be an oop");
5087     space->par_oop_iterate(mr, cl);
5088   }
5089   pst->all_tasks_completed();
5090 }
5091 
5092 void
5093 CMSParRemarkTask::do_dirty_card_rescan_tasks(
5094   CompactibleFreeListSpace* sp, int i,
5095   Par_MarkRefsIntoAndScanClosure* cl) {
5096   // Until all tasks completed:
5097   // . claim an unclaimed task
5098   // . compute region boundaries corresponding to task claimed
5099   // . transfer dirty bits ct->mut for that region
5100   // . apply rescanclosure to dirty mut bits for that region
5101 
5102   ResourceMark rm;
5103   HandleMark   hm;
5104 
5105   OopTaskQueue* work_q = work_queue(i);
5106   ModUnionClosure modUnionClosure(&(_collector->_modUnionTable));
5107   // CAUTION! CAUTION! CAUTION! CAUTION! CAUTION! CAUTION! CAUTION!
5108   // CAUTION: This closure has state that persists across calls to
5109   // the work method dirty_range_iterate_clear() in that it has
5110   // imbedded in it a (subtype of) UpwardsObjectClosure. The
5111   // use of that state in the imbedded UpwardsObjectClosure instance
5112   // assumes that the cards are always iterated (even if in parallel
5113   // by several threads) in monotonically increasing order per each
5114   // thread. This is true of the implementation below which picks
5115   // card ranges (chunks) in monotonically increasing order globally
5116   // and, a-fortiori, in monotonically increasing order per thread
5117   // (the latter order being a subsequence of the former).
5118   // If the work code below is ever reorganized into a more chaotic
5119   // work-partitioning form than the current "sequential tasks"
5120   // paradigm, the use of that persistent state will have to be
5121   // revisited and modified appropriately. See also related
5122   // bug 4756801 work on which should examine this code to make
5123   // sure that the changes there do not run counter to the
5124   // assumptions made here and necessary for correctness and
5125   // efficiency. Note also that this code might yield inefficient
5126   // behaviour in the case of very large objects that span one or
5127   // more work chunks. Such objects would potentially be scanned
5128   // several times redundantly. Work on 4756801 should try and
5129   // address that performance anomaly if at all possible. XXX
5130   MemRegion  full_span  = _collector->_span;
5131   CMSBitMap* bm    = &(_collector->_markBitMap);     // shared
5132   CMSMarkStack* rs = &(_collector->_revisitStack);   // shared
5133   MarkFromDirtyCardsClosure
5134     greyRescanClosure(_collector, full_span, // entire span of interest
5135                       sp, bm, work_q, rs, cl);
5136 
5137   SequentialSubTasksDone* pst = sp->conc_par_seq_tasks();
5138   assert(pst->valid(), "Uninitialized use?");
5139   int nth_task = 0;
5140   const int alignment = CardTableModRefBS::card_size * BitsPerWord;
5141   MemRegion span = sp->used_region();
5142   HeapWord* start_addr = span.start();
5143   HeapWord* end_addr = (HeapWord*)round_to((intptr_t)span.end(),
5144                                            alignment);
5145   const size_t chunk_size = sp->rescan_task_size(); // in HeapWord units
5146   assert((HeapWord*)round_to((intptr_t)start_addr, alignment) ==
5147          start_addr, "Check alignment");
5148   assert((size_t)round_to((intptr_t)chunk_size, alignment) ==
5149          chunk_size, "Check alignment");
5150 
5151   while (!pst->is_task_claimed(/* reference */ nth_task)) {
5152     // Having claimed the nth_task, compute corresponding mem-region,
5153     // which is a-fortiori aligned correctly (i.e. at a MUT bopundary).
5154     // The alignment restriction ensures that we do not need any
5155     // synchronization with other gang-workers while setting or
5156     // clearing bits in thus chunk of the MUT.
5157     MemRegion this_span = MemRegion(start_addr + nth_task*chunk_size,
5158                                     start_addr + (nth_task+1)*chunk_size);
5159     // The last chunk's end might be way beyond end of the
5160     // used region. In that case pull back appropriately.
5161     if (this_span.end() > end_addr) {
5162       this_span.set_end(end_addr);
5163       assert(!this_span.is_empty(), "Program logic (calculation of n_tasks)");
5164     }
5165     // Iterate over the dirty cards covering this chunk, marking them
5166     // precleaned, and setting the corresponding bits in the mod union
5167     // table. Since we have been careful to partition at Card and MUT-word
5168     // boundaries no synchronization is needed between parallel threads.
5169     _collector->_ct->ct_bs()->dirty_card_iterate(this_span,
5170                                                  &modUnionClosure);
5171 
5172     // Having transferred these marks into the modUnionTable,
5173     // rescan the marked objects on the dirty cards in the modUnionTable.
5174     // Even if this is at a synchronous collection, the initial marking
5175     // may have been done during an asynchronous collection so there
5176     // may be dirty bits in the mod-union table.
5177     _collector->_modUnionTable.dirty_range_iterate_clear(
5178                   this_span, &greyRescanClosure);
5179     _collector->_modUnionTable.verifyNoOneBitsInRange(
5180                                  this_span.start(),
5181                                  this_span.end());
5182   }
5183   pst->all_tasks_completed();  // declare that i am done
5184 }
5185 
5186 // . see if we can share work_queues with ParNew? XXX
5187 void
5188 CMSParRemarkTask::do_work_steal(int i, Par_MarkRefsIntoAndScanClosure* cl,
5189                                 int* seed) {
5190   OopTaskQueue* work_q = work_queue(i);
5191   NOT_PRODUCT(int num_steals = 0;)
5192   oop obj_to_scan;
5193   CMSBitMap* bm = &(_collector->_markBitMap);
5194   size_t num_from_overflow_list =
5195            MIN2((size_t)work_q->max_elems()/4,
5196                 (size_t)ParGCDesiredObjsFromOverflowList);
5197 
5198   while (true) {
5199     // Completely finish any left over work from (an) earlier round(s)
5200     cl->trim_queue(0);
5201     // Now check if there's any work in the overflow list
5202     if (_collector->par_take_from_overflow_list(num_from_overflow_list,
5203                                                 work_q)) {
5204       // found something in global overflow list;
5205       // not yet ready to go stealing work from others.
5206       // We'd like to assert(work_q->size() != 0, ...)
5207       // because we just took work from the overflow list,
5208       // but of course we can't since all of that could have
5209       // been already stolen from us.
5210       // "He giveth and He taketh away."
5211       continue;
5212     }
5213     // Verify that we have no work before we resort to stealing
5214     assert(work_q->size() == 0, "Have work, shouldn't steal");
5215     // Try to steal from other queues that have work
5216     if (task_queues()->steal(i, seed, /* reference */ obj_to_scan)) {
5217       NOT_PRODUCT(num_steals++;)
5218       assert(obj_to_scan->is_oop(), "Oops, not an oop!");
5219       assert(bm->isMarked((HeapWord*)obj_to_scan), "Stole an unmarked oop?");
5220       // Do scanning work
5221       obj_to_scan->oop_iterate(cl);
5222       // Loop around, finish this work, and try to steal some more
5223     } else if (terminator()->offer_termination()) {
5224         break;  // nirvana from the infinite cycle
5225     }
5226   }
5227   NOT_PRODUCT(
5228     if (PrintCMSStatistics != 0) {
5229       gclog_or_tty->print("\n\t(%d: stole %d oops)", i, num_steals);
5230     }
5231   )
5232   assert(work_q->size() == 0 && _collector->overflow_list_is_empty(),
5233          "Else our work is not yet done");
5234 }
5235 
5236 // Return a thread-local PLAB recording array, as appropriate.
5237 void* CMSCollector::get_data_recorder(int thr_num) {
5238   if (_survivor_plab_array != NULL &&
5239       (CMSPLABRecordAlways ||
5240        (_collectorState > Marking && _collectorState < FinalMarking))) {
5241     assert(thr_num < (int)ParallelGCThreads, "thr_num is out of bounds");
5242     ChunkArray* ca = &_survivor_plab_array[thr_num];
5243     ca->reset();   // clear it so that fresh data is recorded
5244     return (void*) ca;
5245   } else {
5246     return NULL;
5247   }
5248 }
5249 
5250 // Reset all the thread-local PLAB recording arrays
5251 void CMSCollector::reset_survivor_plab_arrays() {
5252   for (uint i = 0; i < ParallelGCThreads; i++) {
5253     _survivor_plab_array[i].reset();
5254   }
5255 }
5256 
5257 // Merge the per-thread plab arrays into the global survivor chunk
5258 // array which will provide the partitioning of the survivor space
5259 // for CMS rescan.
5260 void CMSCollector::merge_survivor_plab_arrays(ContiguousSpace* surv) {
5261   assert(_survivor_plab_array  != NULL, "Error");
5262   assert(_survivor_chunk_array != NULL, "Error");
5263   assert(_collectorState == FinalMarking, "Error");
5264   for (uint j = 0; j < ParallelGCThreads; j++) {
5265     _cursor[j] = 0;
5266   }
5267   HeapWord* top = surv->top();
5268   size_t i;
5269   for (i = 0; i < _survivor_chunk_capacity; i++) {  // all sca entries
5270     HeapWord* min_val = top;          // Higher than any PLAB address
5271     uint      min_tid = 0;            // position of min_val this round
5272     for (uint j = 0; j < ParallelGCThreads; j++) {
5273       ChunkArray* cur_sca = &_survivor_plab_array[j];
5274       if (_cursor[j] == cur_sca->end()) {
5275         continue;
5276       }
5277       assert(_cursor[j] < cur_sca->end(), "ctl pt invariant");
5278       HeapWord* cur_val = cur_sca->nth(_cursor[j]);
5279       assert(surv->used_region().contains(cur_val), "Out of bounds value");
5280       if (cur_val < min_val) {
5281         min_tid = j;
5282         min_val = cur_val;
5283       } else {
5284         assert(cur_val < top, "All recorded addresses should be less");
5285       }
5286     }
5287     // At this point min_val and min_tid are respectively
5288     // the least address in _survivor_plab_array[j]->nth(_cursor[j])
5289     // and the thread (j) that witnesses that address.
5290     // We record this address in the _survivor_chunk_array[i]
5291     // and increment _cursor[min_tid] prior to the next round i.
5292     if (min_val == top) {
5293       break;
5294     }
5295     _survivor_chunk_array[i] = min_val;
5296     _cursor[min_tid]++;
5297   }
5298   // We are all done; record the size of the _survivor_chunk_array
5299   _survivor_chunk_index = i; // exclusive: [0, i)
5300   if (PrintCMSStatistics > 0) {
5301     gclog_or_tty->print(" (Survivor:" SIZE_FORMAT "chunks) ", i);
5302   }
5303   // Verify that we used up all the recorded entries
5304   #ifdef ASSERT
5305     size_t total = 0;
5306     for (uint j = 0; j < ParallelGCThreads; j++) {
5307       assert(_cursor[j] == _survivor_plab_array[j].end(), "Ctl pt invariant");
5308       total += _cursor[j];
5309     }
5310     assert(total == _survivor_chunk_index, "Ctl Pt Invariant");
5311     // Check that the merged array is in sorted order
5312     if (total > 0) {
5313       for (size_t i = 0; i < total - 1; i++) {
5314         if (PrintCMSStatistics > 0) {
5315           gclog_or_tty->print(" (chunk" SIZE_FORMAT ":" INTPTR_FORMAT ") ",
5316                               i, _survivor_chunk_array[i]);
5317         }
5318         assert(_survivor_chunk_array[i] < _survivor_chunk_array[i+1],
5319                "Not sorted");
5320       }
5321     }
5322   #endif // ASSERT
5323 }
5324 
5325 // Set up the space's par_seq_tasks structure for work claiming
5326 // for parallel rescan of young gen.
5327 // See ParRescanTask where this is currently used.
5328 void
5329 CMSCollector::
5330 initialize_sequential_subtasks_for_young_gen_rescan(int n_threads) {
5331   assert(n_threads > 0, "Unexpected n_threads argument");
5332   DefNewGeneration* dng = (DefNewGeneration*)_young_gen;
5333 
5334   // Eden space
5335   {
5336     SequentialSubTasksDone* pst = dng->eden()->par_seq_tasks();
5337     assert(!pst->valid(), "Clobbering existing data?");
5338     // Each valid entry in [0, _eden_chunk_index) represents a task.
5339     size_t n_tasks = _eden_chunk_index + 1;
5340     assert(n_tasks == 1 || _eden_chunk_array != NULL, "Error");
5341     pst->set_par_threads(n_threads);
5342     pst->set_n_tasks((int)n_tasks);
5343   }
5344 
5345   // Merge the survivor plab arrays into _survivor_chunk_array
5346   if (_survivor_plab_array != NULL) {
5347     merge_survivor_plab_arrays(dng->from());
5348   } else {
5349     assert(_survivor_chunk_index == 0, "Error");
5350   }
5351 
5352   // To space
5353   {
5354     SequentialSubTasksDone* pst = dng->to()->par_seq_tasks();
5355     assert(!pst->valid(), "Clobbering existing data?");
5356     pst->set_par_threads(n_threads);
5357     pst->set_n_tasks(1);
5358     assert(pst->valid(), "Error");
5359   }
5360 
5361   // From space
5362   {
5363     SequentialSubTasksDone* pst = dng->from()->par_seq_tasks();
5364     assert(!pst->valid(), "Clobbering existing data?");
5365     size_t n_tasks = _survivor_chunk_index + 1;
5366     assert(n_tasks == 1 || _survivor_chunk_array != NULL, "Error");
5367     pst->set_par_threads(n_threads);
5368     pst->set_n_tasks((int)n_tasks);
5369     assert(pst->valid(), "Error");
5370   }
5371 }
5372 
5373 // Parallel version of remark
5374 void CMSCollector::do_remark_parallel() {
5375   GenCollectedHeap* gch = GenCollectedHeap::heap();
5376   WorkGang* workers = gch->workers();
5377   assert(workers != NULL, "Need parallel worker threads.");
5378   int n_workers = workers->total_workers();
5379   CompactibleFreeListSpace* cms_space  = _cmsGen->cmsSpace();
5380   CompactibleFreeListSpace* perm_space = _permGen->cmsSpace();
5381 
5382   CMSParRemarkTask tsk(this,
5383     cms_space, perm_space,
5384     n_workers, workers, task_queues());
5385 
5386   // Set up for parallel process_strong_roots work.
5387   gch->set_par_threads(n_workers);
5388   gch->change_strong_roots_parity();
5389   // We won't be iterating over the cards in the card table updating
5390   // the younger_gen cards, so we shouldn't call the following else
5391   // the verification code as well as subsequent younger_refs_iterate
5392   // code would get confused. XXX
5393   // gch->rem_set()->prepare_for_younger_refs_iterate(true); // parallel
5394 
5395   // The young gen rescan work will not be done as part of
5396   // process_strong_roots (which currently doesn't knw how to
5397   // parallelize such a scan), but rather will be broken up into
5398   // a set of parallel tasks (via the sampling that the [abortable]
5399   // preclean phase did of EdenSpace, plus the [two] tasks of
5400   // scanning the [two] survivor spaces. Further fine-grain
5401   // parallelization of the scanning of the survivor spaces
5402   // themselves, and of precleaning of the younger gen itself
5403   // is deferred to the future.
5404   initialize_sequential_subtasks_for_young_gen_rescan(n_workers);
5405 
5406   // The dirty card rescan work is broken up into a "sequence"
5407   // of parallel tasks (per constituent space) that are dynamically
5408   // claimed by the parallel threads.
5409   cms_space->initialize_sequential_subtasks_for_rescan(n_workers);
5410   perm_space->initialize_sequential_subtasks_for_rescan(n_workers);
5411 
5412   // It turns out that even when we're using 1 thread, doing the work in a
5413   // separate thread causes wide variance in run times.  We can't help this
5414   // in the multi-threaded case, but we special-case n=1 here to get
5415   // repeatable measurements of the 1-thread overhead of the parallel code.
5416   if (n_workers > 1) {
5417     // Make refs discovery MT-safe
5418     ReferenceProcessorMTMutator mt(ref_processor(), true);
5419     workers->run_task(&tsk);
5420   } else {
5421     tsk.work(0);
5422   }
5423   gch->set_par_threads(0);  // 0 ==> non-parallel.
5424   // restore, single-threaded for now, any preserved marks
5425   // as a result of work_q overflow
5426   restore_preserved_marks_if_any();
5427 }
5428 
5429 // Non-parallel version of remark
5430 void CMSCollector::do_remark_non_parallel() {
5431   ResourceMark rm;
5432   HandleMark   hm;
5433   GenCollectedHeap* gch = GenCollectedHeap::heap();
5434   MarkRefsIntoAndScanClosure
5435     mrias_cl(_span, ref_processor(), &_markBitMap, &_modUnionTable,
5436              &_markStack, &_revisitStack, this,
5437              false /* should_yield */, false /* not precleaning */);
5438   MarkFromDirtyCardsClosure
5439     markFromDirtyCardsClosure(this, _span,
5440                               NULL,  // space is set further below
5441                               &_markBitMap, &_markStack, &_revisitStack,
5442                               &mrias_cl);
5443   {
5444     TraceTime t("grey object rescan", PrintGCDetails, false, gclog_or_tty);
5445     // Iterate over the dirty cards, setting the corresponding bits in the
5446     // mod union table.
5447     {
5448       ModUnionClosure modUnionClosure(&_modUnionTable);
5449       _ct->ct_bs()->dirty_card_iterate(
5450                       _cmsGen->used_region(),
5451                       &modUnionClosure);
5452       _ct->ct_bs()->dirty_card_iterate(
5453                       _permGen->used_region(),
5454                       &modUnionClosure);
5455     }
5456     // Having transferred these marks into the modUnionTable, we just need
5457     // to rescan the marked objects on the dirty cards in the modUnionTable.
5458     // The initial marking may have been done during an asynchronous
5459     // collection so there may be dirty bits in the mod-union table.
5460     const int alignment =
5461       CardTableModRefBS::card_size * BitsPerWord;
5462     {
5463       // ... First handle dirty cards in CMS gen
5464       markFromDirtyCardsClosure.set_space(_cmsGen->cmsSpace());
5465       MemRegion ur = _cmsGen->used_region();
5466       HeapWord* lb = ur.start();
5467       HeapWord* ub = (HeapWord*)round_to((intptr_t)ur.end(), alignment);
5468       MemRegion cms_span(lb, ub);
5469       _modUnionTable.dirty_range_iterate_clear(cms_span,
5470                                                &markFromDirtyCardsClosure);
5471       verify_work_stacks_empty();
5472       if (PrintCMSStatistics != 0) {
5473         gclog_or_tty->print(" (re-scanned "SIZE_FORMAT" dirty cards in cms gen) ",
5474           markFromDirtyCardsClosure.num_dirty_cards());
5475       }
5476     }
5477     {
5478       // .. and then repeat for dirty cards in perm gen
5479       markFromDirtyCardsClosure.set_space(_permGen->cmsSpace());
5480       MemRegion ur = _permGen->used_region();
5481       HeapWord* lb = ur.start();
5482       HeapWord* ub = (HeapWord*)round_to((intptr_t)ur.end(), alignment);
5483       MemRegion perm_span(lb, ub);
5484       _modUnionTable.dirty_range_iterate_clear(perm_span,
5485                                                &markFromDirtyCardsClosure);
5486       verify_work_stacks_empty();
5487       if (PrintCMSStatistics != 0) {
5488         gclog_or_tty->print(" (re-scanned "SIZE_FORMAT" dirty cards in perm gen) ",
5489           markFromDirtyCardsClosure.num_dirty_cards());
5490       }
5491     }
5492   }
5493   if (VerifyDuringGC &&
5494       GenCollectedHeap::heap()->total_collections() >= VerifyGCStartAt) {
5495     HandleMark hm;  // Discard invalid handles created during verification
5496     Universe::verify(true);
5497   }
5498   {
5499     TraceTime t("root rescan", PrintGCDetails, false, gclog_or_tty);
5500 
5501     verify_work_stacks_empty();
5502 
5503     gch->rem_set()->prepare_for_younger_refs_iterate(false); // Not parallel.
5504     gch->gen_process_strong_roots(_cmsGen->level(),
5505                                   true,  // younger gens as roots
5506                                   true,  // collecting perm gen
5507                                   SharedHeap::ScanningOption(roots_scanning_options()),
5508                                   NULL, &mrias_cl);
5509   }
5510   verify_work_stacks_empty();
5511   // Restore evacuated mark words, if any, used for overflow list links
5512   if (!CMSOverflowEarlyRestoration) {
5513     restore_preserved_marks_if_any();
5514   }
5515   verify_overflow_empty();
5516 }
5517 
5518 ////////////////////////////////////////////////////////
5519 // Parallel Reference Processing Task Proxy Class
5520 ////////////////////////////////////////////////////////
5521 class CMSRefProcTaskProxy: public AbstractGangTask {
5522   typedef AbstractRefProcTaskExecutor::ProcessTask ProcessTask;
5523   CMSCollector*          _collector;
5524   CMSBitMap*             _mark_bit_map;
5525   const MemRegion        _span;
5526   OopTaskQueueSet*       _task_queues;
5527   ParallelTaskTerminator _term;
5528   ProcessTask&           _task;
5529 
5530 public:
5531   CMSRefProcTaskProxy(ProcessTask&     task,
5532                       CMSCollector*    collector,
5533                       const MemRegion& span,
5534                       CMSBitMap*       mark_bit_map,
5535                       int              total_workers,
5536                       OopTaskQueueSet* task_queues):
5537     AbstractGangTask("Process referents by policy in parallel"),
5538     _task(task),
5539     _collector(collector), _span(span), _mark_bit_map(mark_bit_map),
5540     _task_queues(task_queues),
5541     _term(total_workers, task_queues)
5542     {
5543       assert(_collector->_span.equals(_span) && !_span.is_empty(),
5544              "Inconsistency in _span");
5545     }
5546 
5547   OopTaskQueueSet* task_queues() { return _task_queues; }
5548 
5549   OopTaskQueue* work_queue(int i) { return task_queues()->queue(i); }
5550 
5551   ParallelTaskTerminator* terminator() { return &_term; }
5552 
5553   void do_work_steal(int i,
5554                      CMSParDrainMarkingStackClosure* drain,
5555                      CMSParKeepAliveClosure* keep_alive,
5556                      int* seed);
5557 
5558   virtual void work(int i);
5559 };
5560 
5561 void CMSRefProcTaskProxy::work(int i) {
5562   assert(_collector->_span.equals(_span), "Inconsistency in _span");
5563   CMSParKeepAliveClosure par_keep_alive(_collector, _span,
5564                                         _mark_bit_map, work_queue(i));
5565   CMSParDrainMarkingStackClosure par_drain_stack(_collector, _span,
5566                                                  _mark_bit_map, work_queue(i));
5567   CMSIsAliveClosure is_alive_closure(_span, _mark_bit_map);
5568   _task.work(i, is_alive_closure, par_keep_alive, par_drain_stack);
5569   if (_task.marks_oops_alive()) {
5570     do_work_steal(i, &par_drain_stack, &par_keep_alive,
5571                   _collector->hash_seed(i));
5572   }
5573   assert(work_queue(i)->size() == 0, "work_queue should be empty");
5574   assert(_collector->_overflow_list == NULL, "non-empty _overflow_list");
5575 }
5576 
5577 class CMSRefEnqueueTaskProxy: public AbstractGangTask {
5578   typedef AbstractRefProcTaskExecutor::EnqueueTask EnqueueTask;
5579   EnqueueTask& _task;
5580 
5581 public:
5582   CMSRefEnqueueTaskProxy(EnqueueTask& task)
5583     : AbstractGangTask("Enqueue reference objects in parallel"),
5584       _task(task)
5585   { }
5586 
5587   virtual void work(int i)
5588   {
5589     _task.work(i);
5590   }
5591 };
5592 
5593 CMSParKeepAliveClosure::CMSParKeepAliveClosure(CMSCollector* collector,
5594   MemRegion span, CMSBitMap* bit_map, OopTaskQueue* work_queue):
5595    _collector(collector),
5596    _span(span),
5597    _bit_map(bit_map),
5598    _work_queue(work_queue),
5599    _mark_and_push(collector, span, bit_map, work_queue),
5600    _low_water_mark(MIN2((uint)(work_queue->max_elems()/4),
5601                         (uint)(CMSWorkQueueDrainThreshold * ParallelGCThreads)))
5602 { }
5603 
5604 // . see if we can share work_queues with ParNew? XXX
5605 void CMSRefProcTaskProxy::do_work_steal(int i,
5606   CMSParDrainMarkingStackClosure* drain,
5607   CMSParKeepAliveClosure* keep_alive,
5608   int* seed) {
5609   OopTaskQueue* work_q = work_queue(i);
5610   NOT_PRODUCT(int num_steals = 0;)
5611   oop obj_to_scan;
5612   size_t num_from_overflow_list =
5613            MIN2((size_t)work_q->max_elems()/4,
5614                 (size_t)ParGCDesiredObjsFromOverflowList);
5615 
5616   while (true) {
5617     // Completely finish any left over work from (an) earlier round(s)
5618     drain->trim_queue(0);
5619     // Now check if there's any work in the overflow list
5620     if (_collector->par_take_from_overflow_list(num_from_overflow_list,
5621                                                 work_q)) {
5622       // Found something in global overflow list;
5623       // not yet ready to go stealing work from others.
5624       // We'd like to assert(work_q->size() != 0, ...)
5625       // because we just took work from the overflow list,
5626       // but of course we can't, since all of that might have
5627       // been already stolen from us.
5628       continue;
5629     }
5630     // Verify that we have no work before we resort to stealing
5631     assert(work_q->size() == 0, "Have work, shouldn't steal");
5632     // Try to steal from other queues that have work
5633     if (task_queues()->steal(i, seed, /* reference */ obj_to_scan)) {
5634       NOT_PRODUCT(num_steals++;)
5635       assert(obj_to_scan->is_oop(), "Oops, not an oop!");
5636       assert(_mark_bit_map->isMarked((HeapWord*)obj_to_scan), "Stole an unmarked oop?");
5637       // Do scanning work
5638       obj_to_scan->oop_iterate(keep_alive);
5639       // Loop around, finish this work, and try to steal some more
5640     } else if (terminator()->offer_termination()) {
5641       break;  // nirvana from the infinite cycle
5642     }
5643   }
5644   NOT_PRODUCT(
5645     if (PrintCMSStatistics != 0) {
5646       gclog_or_tty->print("\n\t(%d: stole %d oops)", i, num_steals);
5647     }
5648   )
5649 }
5650 
5651 void CMSRefProcTaskExecutor::execute(ProcessTask& task)
5652 {
5653   GenCollectedHeap* gch = GenCollectedHeap::heap();
5654   WorkGang* workers = gch->workers();
5655   assert(workers != NULL, "Need parallel worker threads.");
5656   int n_workers = workers->total_workers();
5657   CMSRefProcTaskProxy rp_task(task, &_collector,
5658                               _collector.ref_processor()->span(),
5659                               _collector.markBitMap(),
5660                               n_workers, _collector.task_queues());
5661   workers->run_task(&rp_task);
5662 }
5663 
5664 void CMSRefProcTaskExecutor::execute(EnqueueTask& task)
5665 {
5666 
5667   GenCollectedHeap* gch = GenCollectedHeap::heap();
5668   WorkGang* workers = gch->workers();
5669   assert(workers != NULL, "Need parallel worker threads.");
5670   CMSRefEnqueueTaskProxy enq_task(task);
5671   workers->run_task(&enq_task);
5672 }
5673 
5674 void CMSCollector::refProcessingWork(bool asynch, bool clear_all_soft_refs) {
5675 
5676   ResourceMark rm;
5677   HandleMark   hm;
5678 
5679   ReferenceProcessor* rp = ref_processor();
5680   assert(rp->span().equals(_span), "Spans should be equal");
5681   assert(!rp->enqueuing_is_done(), "Enqueuing should not be complete");
5682   // Process weak references.
5683   rp->snap_policy(clear_all_soft_refs);
5684   verify_work_stacks_empty();
5685 
5686   CMSKeepAliveClosure cmsKeepAliveClosure(this, _span, &_markBitMap,
5687                                           &_markStack);
5688   CMSDrainMarkingStackClosure cmsDrainMarkingStackClosure(this,
5689                                 _span, &_markBitMap, &_markStack,
5690                                 &cmsKeepAliveClosure);
5691   {
5692     TraceTime t("weak refs processing", PrintGCDetails, false, gclog_or_tty);
5693     if (rp->processing_is_mt()) {
5694       CMSRefProcTaskExecutor task_executor(*this);
5695       rp->process_discovered_references(&_is_alive_closure,
5696                                         &cmsKeepAliveClosure,
5697                                         &cmsDrainMarkingStackClosure,
5698                                         &task_executor);
5699     } else {
5700       rp->process_discovered_references(&_is_alive_closure,
5701                                         &cmsKeepAliveClosure,
5702                                         &cmsDrainMarkingStackClosure,
5703                                         NULL);
5704     }
5705     verify_work_stacks_empty();
5706   }
5707 
5708   if (should_unload_classes()) {
5709     {
5710       TraceTime t("class unloading", PrintGCDetails, false, gclog_or_tty);
5711 
5712       // Follow SystemDictionary roots and unload classes
5713       bool purged_class = SystemDictionary::do_unloading(&_is_alive_closure);
5714 
5715       // Follow CodeCache roots and unload any methods marked for unloading
5716       CodeCache::do_unloading(&_is_alive_closure,
5717                               &cmsKeepAliveClosure,
5718                               purged_class);
5719 
5720       cmsDrainMarkingStackClosure.do_void();
5721       verify_work_stacks_empty();
5722 
5723       // Update subklass/sibling/implementor links in KlassKlass descendants
5724       assert(!_revisitStack.isEmpty(), "revisit stack should not be empty");
5725       oop k;
5726       while ((k = _revisitStack.pop()) != NULL) {
5727         ((Klass*)(oopDesc*)k)->follow_weak_klass_links(
5728                        &_is_alive_closure,
5729                        &cmsKeepAliveClosure);
5730       }
5731       assert(!ClassUnloading ||
5732              (_markStack.isEmpty() && overflow_list_is_empty()),
5733              "Should not have found new reachable objects");
5734       assert(_revisitStack.isEmpty(), "revisit stack should have been drained");
5735       cmsDrainMarkingStackClosure.do_void();
5736       verify_work_stacks_empty();
5737     }
5738 
5739     {
5740       TraceTime t("scrub symbol & string tables", PrintGCDetails, false, gclog_or_tty);
5741       // Now clean up stale oops in SymbolTable and StringTable
5742       SymbolTable::unlink(&_is_alive_closure);
5743       StringTable::unlink(&_is_alive_closure);
5744     }
5745   }
5746 
5747   verify_work_stacks_empty();
5748   // Restore any preserved marks as a result of mark stack or
5749   // work queue overflow
5750   restore_preserved_marks_if_any();  // done single-threaded for now
5751 
5752   rp->set_enqueuing_is_done(true);
5753   if (rp->processing_is_mt()) {
5754     CMSRefProcTaskExecutor task_executor(*this);
5755     rp->enqueue_discovered_references(&task_executor);
5756   } else {
5757     rp->enqueue_discovered_references(NULL);
5758   }
5759   rp->verify_no_references_recorded();
5760   assert(!rp->discovery_enabled(), "should have been disabled");
5761 
5762   // JVMTI object tagging is based on JNI weak refs. If any of these
5763   // refs were cleared then JVMTI needs to update its maps and
5764   // maybe post ObjectFrees to agents.
5765   JvmtiExport::cms_ref_processing_epilogue();
5766 }
5767 
5768 #ifndef PRODUCT
5769 void CMSCollector::check_correct_thread_executing() {
5770   Thread* t = Thread::current();
5771   // Only the VM thread or the CMS thread should be here.
5772   assert(t->is_ConcurrentGC_thread() || t->is_VM_thread(),
5773          "Unexpected thread type");
5774   // If this is the vm thread, the foreground process
5775   // should not be waiting.  Note that _foregroundGCIsActive is
5776   // true while the foreground collector is waiting.
5777   if (_foregroundGCShouldWait) {
5778     // We cannot be the VM thread
5779     assert(t->is_ConcurrentGC_thread(),
5780            "Should be CMS thread");
5781   } else {
5782     // We can be the CMS thread only if we are in a stop-world
5783     // phase of CMS collection.
5784     if (t->is_ConcurrentGC_thread()) {
5785       assert(_collectorState == InitialMarking ||
5786              _collectorState == FinalMarking,
5787              "Should be a stop-world phase");
5788       // The CMS thread should be holding the CMS_token.
5789       assert(ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
5790              "Potential interference with concurrently "
5791              "executing VM thread");
5792     }
5793   }
5794 }
5795 #endif
5796 
5797 void CMSCollector::sweep(bool asynch) {
5798   assert(_collectorState == Sweeping, "just checking");
5799   check_correct_thread_executing();
5800   verify_work_stacks_empty();
5801   verify_overflow_empty();
5802   incrementSweepCount();
5803   _sweep_timer.stop();
5804   _sweep_estimate.sample(_sweep_timer.seconds());
5805   size_policy()->avg_cms_free_at_sweep()->sample(_cmsGen->free());
5806 
5807   // PermGen verification support: If perm gen sweeping is disabled in
5808   // this cycle, we preserve the perm gen object "deadness" information
5809   // in the perm_gen_verify_bit_map. In order to do that we traverse
5810   // all blocks in perm gen and mark all dead objects.
5811   if (verifying() && !should_unload_classes()) {
5812     assert(perm_gen_verify_bit_map()->sizeInBits() != 0,
5813            "Should have already been allocated");
5814     MarkDeadObjectsClosure mdo(this, _permGen->cmsSpace(),
5815                                markBitMap(), perm_gen_verify_bit_map());
5816     if (asynch) {
5817       CMSTokenSyncWithLocks ts(true, _permGen->freelistLock(),
5818                                bitMapLock());
5819       _permGen->cmsSpace()->blk_iterate(&mdo);
5820     } else {
5821       // In the case of synchronous sweep, we already have
5822       // the requisite locks/tokens.
5823       _permGen->cmsSpace()->blk_iterate(&mdo);
5824     }
5825   }
5826 
5827   if (asynch) {
5828     TraceCPUTime tcpu(PrintGCDetails, true, gclog_or_tty);
5829     CMSPhaseAccounting pa(this, "sweep", !PrintGCDetails);
5830     // First sweep the old gen then the perm gen
5831     {
5832       CMSTokenSyncWithLocks ts(true, _cmsGen->freelistLock(),
5833                                bitMapLock());
5834       sweepWork(_cmsGen, asynch);
5835     }
5836 
5837     // Now repeat for perm gen
5838     if (should_unload_classes()) {
5839       CMSTokenSyncWithLocks ts(true, _permGen->freelistLock(),
5840                              bitMapLock());
5841       sweepWork(_permGen, asynch);
5842     }
5843 
5844     // Update Universe::_heap_*_at_gc figures.
5845     // We need all the free list locks to make the abstract state
5846     // transition from Sweeping to Resetting. See detailed note
5847     // further below.
5848     {
5849       CMSTokenSyncWithLocks ts(true, _cmsGen->freelistLock(),
5850                                _permGen->freelistLock());
5851       // Update heap occupancy information which is used as
5852       // input to soft ref clearing policy at the next gc.
5853       Universe::update_heap_info_at_gc();
5854       _collectorState = Resizing;
5855     }
5856   } else {
5857     // already have needed locks
5858     sweepWork(_cmsGen,  asynch);
5859 
5860     if (should_unload_classes()) {
5861       sweepWork(_permGen, asynch);
5862     }
5863     // Update heap occupancy information which is used as
5864     // input to soft ref clearing policy at the next gc.
5865     Universe::update_heap_info_at_gc();
5866     _collectorState = Resizing;
5867   }
5868   verify_work_stacks_empty();
5869   verify_overflow_empty();
5870 
5871   _sweep_timer.reset();
5872   _sweep_timer.start();
5873 
5874   update_time_of_last_gc(os::javaTimeMillis());
5875 
5876   // NOTE on abstract state transitions:
5877   // Mutators allocate-live and/or mark the mod-union table dirty
5878   // based on the state of the collection.  The former is done in
5879   // the interval [Marking, Sweeping] and the latter in the interval
5880   // [Marking, Sweeping).  Thus the transitions into the Marking state
5881   // and out of the Sweeping state must be synchronously visible
5882   // globally to the mutators.
5883   // The transition into the Marking state happens with the world
5884   // stopped so the mutators will globally see it.  Sweeping is
5885   // done asynchronously by the background collector so the transition
5886   // from the Sweeping state to the Resizing state must be done
5887   // under the freelistLock (as is the check for whether to
5888   // allocate-live and whether to dirty the mod-union table).
5889   assert(_collectorState == Resizing, "Change of collector state to"
5890     " Resizing must be done under the freelistLocks (plural)");
5891 
5892   // Now that sweeping has been completed, if the GCH's
5893   // incremental_collection_will_fail flag is set, clear it,
5894   // thus inviting a younger gen collection to promote into
5895   // this generation. If such a promotion may still fail,
5896   // the flag will be set again when a young collection is
5897   // attempted.
5898   // I think the incremental_collection_will_fail flag's use
5899   // is specific to a 2 generation collection policy, so i'll
5900   // assert that that's the configuration we are operating within.
5901   // The use of the flag can and should be generalized appropriately
5902   // in the future to deal with a general n-generation system.
5903 
5904   GenCollectedHeap* gch = GenCollectedHeap::heap();
5905   assert(gch->collector_policy()->is_two_generation_policy(),
5906          "Resetting of incremental_collection_will_fail flag"
5907          " may be incorrect otherwise");
5908   gch->clear_incremental_collection_will_fail();
5909   gch->update_full_collections_completed(_collection_count_start);
5910 }
5911 
5912 // FIX ME!!! Looks like this belongs in CFLSpace, with
5913 // CMSGen merely delegating to it.
5914 void ConcurrentMarkSweepGeneration::setNearLargestChunk() {
5915   double nearLargestPercent = 0.999;
5916   HeapWord*  minAddr        = _cmsSpace->bottom();
5917   HeapWord*  largestAddr    =
5918     (HeapWord*) _cmsSpace->dictionary()->findLargestDict();
5919   if (largestAddr == 0) {
5920     // The dictionary appears to be empty.  In this case
5921     // try to coalesce at the end of the heap.
5922     largestAddr = _cmsSpace->end();
5923   }
5924   size_t largestOffset     = pointer_delta(largestAddr, minAddr);
5925   size_t nearLargestOffset =
5926     (size_t)((double)largestOffset * nearLargestPercent) - MinChunkSize;
5927   _cmsSpace->set_nearLargestChunk(minAddr + nearLargestOffset);
5928 }
5929 
5930 bool ConcurrentMarkSweepGeneration::isNearLargestChunk(HeapWord* addr) {
5931   return addr >= _cmsSpace->nearLargestChunk();
5932 }
5933 
5934 FreeChunk* ConcurrentMarkSweepGeneration::find_chunk_at_end() {
5935   return _cmsSpace->find_chunk_at_end();
5936 }
5937 
5938 void ConcurrentMarkSweepGeneration::update_gc_stats(int current_level,
5939                                                     bool full) {
5940   // The next lower level has been collected.  Gather any statistics
5941   // that are of interest at this point.
5942   if (!full && (current_level + 1) == level()) {
5943     // Gather statistics on the young generation collection.
5944     collector()->stats().record_gc0_end(used());
5945   }
5946 }
5947 
5948 CMSAdaptiveSizePolicy* ConcurrentMarkSweepGeneration::size_policy() {
5949   GenCollectedHeap* gch = GenCollectedHeap::heap();
5950   assert(gch->kind() == CollectedHeap::GenCollectedHeap,
5951     "Wrong type of heap");
5952   CMSAdaptiveSizePolicy* sp = (CMSAdaptiveSizePolicy*)
5953     gch->gen_policy()->size_policy();
5954   assert(sp->is_gc_cms_adaptive_size_policy(),
5955     "Wrong type of size policy");
5956   return sp;
5957 }
5958 
5959 void ConcurrentMarkSweepGeneration::rotate_debug_collection_type() {
5960   if (PrintGCDetails && Verbose) {
5961     gclog_or_tty->print("Rotate from %d ", _debug_collection_type);
5962   }
5963   _debug_collection_type = (CollectionTypes) (_debug_collection_type + 1);
5964   _debug_collection_type =
5965     (CollectionTypes) (_debug_collection_type % Unknown_collection_type);
5966   if (PrintGCDetails && Verbose) {
5967     gclog_or_tty->print_cr("to %d ", _debug_collection_type);
5968   }
5969 }
5970 
5971 void CMSCollector::sweepWork(ConcurrentMarkSweepGeneration* gen,
5972   bool asynch) {
5973   // We iterate over the space(s) underlying this generation,
5974   // checking the mark bit map to see if the bits corresponding
5975   // to specific blocks are marked or not. Blocks that are
5976   // marked are live and are not swept up. All remaining blocks
5977   // are swept up, with coalescing on-the-fly as we sweep up
5978   // contiguous free and/or garbage blocks:
5979   // We need to ensure that the sweeper synchronizes with allocators
5980   // and stop-the-world collectors. In particular, the following
5981   // locks are used:
5982   // . CMS token: if this is held, a stop the world collection cannot occur
5983   // . freelistLock: if this is held no allocation can occur from this
5984   //                 generation by another thread
5985   // . bitMapLock: if this is held, no other thread can access or update
5986   //
5987 
5988   // Note that we need to hold the freelistLock if we use
5989   // block iterate below; else the iterator might go awry if
5990   // a mutator (or promotion) causes block contents to change
5991   // (for instance if the allocator divvies up a block).
5992   // If we hold the free list lock, for all practical purposes
5993   // young generation GC's can't occur (they'll usually need to
5994   // promote), so we might as well prevent all young generation
5995   // GC's while we do a sweeping step. For the same reason, we might
5996   // as well take the bit map lock for the entire duration
5997 
5998   // check that we hold the requisite locks
5999   assert(have_cms_token(), "Should hold cms token");
6000   assert(   (asynch && ConcurrentMarkSweepThread::cms_thread_has_cms_token())
6001          || (!asynch && ConcurrentMarkSweepThread::vm_thread_has_cms_token()),
6002         "Should possess CMS token to sweep");
6003   assert_lock_strong(gen->freelistLock());
6004   assert_lock_strong(bitMapLock());
6005 
6006   assert(!_sweep_timer.is_active(), "Was switched off in an outer context");
6007   gen->cmsSpace()->beginSweepFLCensus((float)(_sweep_timer.seconds()),
6008                                       _sweep_estimate.padded_average());
6009   gen->setNearLargestChunk();
6010 
6011   {
6012     SweepClosure sweepClosure(this, gen, &_markBitMap,
6013                             CMSYield && asynch);
6014     gen->cmsSpace()->blk_iterate_careful(&sweepClosure);
6015     // We need to free-up/coalesce garbage/blocks from a
6016     // co-terminal free run. This is done in the SweepClosure
6017     // destructor; so, do not remove this scope, else the
6018     // end-of-sweep-census below will be off by a little bit.
6019   }
6020   gen->cmsSpace()->sweep_completed();
6021   gen->cmsSpace()->endSweepFLCensus(sweepCount());
6022   if (should_unload_classes()) {                // unloaded classes this cycle,
6023     _concurrent_cycles_since_last_unload = 0;   // ... reset count
6024   } else {                                      // did not unload classes,
6025     _concurrent_cycles_since_last_unload++;     // ... increment count
6026   }
6027 }
6028 
6029 // Reset CMS data structures (for now just the marking bit map)
6030 // preparatory for the next cycle.
6031 void CMSCollector::reset(bool asynch) {
6032   GenCollectedHeap* gch = GenCollectedHeap::heap();
6033   CMSAdaptiveSizePolicy* sp = size_policy();
6034   AdaptiveSizePolicyOutput(sp, gch->total_collections());
6035   if (asynch) {
6036     CMSTokenSyncWithLocks ts(true, bitMapLock());
6037 
6038     // If the state is not "Resetting", the foreground  thread
6039     // has done a collection and the resetting.
6040     if (_collectorState != Resetting) {
6041       assert(_collectorState == Idling, "The state should only change"
6042         " because the foreground collector has finished the collection");
6043       return;
6044     }
6045 
6046     // Clear the mark bitmap (no grey objects to start with)
6047     // for the next cycle.
6048     TraceCPUTime tcpu(PrintGCDetails, true, gclog_or_tty);
6049     CMSPhaseAccounting cmspa(this, "reset", !PrintGCDetails);
6050 
6051     HeapWord* curAddr = _markBitMap.startWord();
6052     while (curAddr < _markBitMap.endWord()) {
6053       size_t remaining  = pointer_delta(_markBitMap.endWord(), curAddr);
6054       MemRegion chunk(curAddr, MIN2(CMSBitMapYieldQuantum, remaining));
6055       _markBitMap.clear_large_range(chunk);
6056       if (ConcurrentMarkSweepThread::should_yield() &&
6057           !foregroundGCIsActive() &&
6058           CMSYield) {
6059         assert(ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
6060                "CMS thread should hold CMS token");
6061         assert_lock_strong(bitMapLock());
6062         bitMapLock()->unlock();
6063         ConcurrentMarkSweepThread::desynchronize(true);
6064         ConcurrentMarkSweepThread::acknowledge_yield_request();
6065         stopTimer();
6066         if (PrintCMSStatistics != 0) {
6067           incrementYields();
6068         }
6069         icms_wait();
6070 
6071         // See the comment in coordinator_yield()
6072         for (unsigned i = 0; i < CMSYieldSleepCount &&
6073                          ConcurrentMarkSweepThread::should_yield() &&
6074                          !CMSCollector::foregroundGCIsActive(); ++i) {
6075           os::sleep(Thread::current(), 1, false);
6076           ConcurrentMarkSweepThread::acknowledge_yield_request();
6077         }
6078 
6079         ConcurrentMarkSweepThread::synchronize(true);
6080         bitMapLock()->lock_without_safepoint_check();
6081         startTimer();
6082       }
6083       curAddr = chunk.end();
6084     }
6085     _collectorState = Idling;
6086   } else {
6087     // already have the lock
6088     assert(_collectorState == Resetting, "just checking");
6089     assert_lock_strong(bitMapLock());
6090     _markBitMap.clear_all();
6091     _collectorState = Idling;
6092   }
6093 
6094   // Stop incremental mode after a cycle completes, so that any future cycles
6095   // are triggered by allocation.
6096   stop_icms();
6097 
6098   NOT_PRODUCT(
6099     if (RotateCMSCollectionTypes) {
6100       _cmsGen->rotate_debug_collection_type();
6101     }
6102   )
6103 }
6104 
6105 void CMSCollector::do_CMS_operation(CMS_op_type op) {
6106   gclog_or_tty->date_stamp(PrintGC && PrintGCDateStamps);
6107   TraceCPUTime tcpu(PrintGCDetails, true, gclog_or_tty);
6108   TraceTime t("GC", PrintGC, !PrintGCDetails, gclog_or_tty);
6109   TraceCollectorStats tcs(counters());
6110 
6111   switch (op) {
6112     case CMS_op_checkpointRootsInitial: {
6113       checkpointRootsInitial(true);       // asynch
6114       if (PrintGC) {
6115         _cmsGen->printOccupancy("initial-mark");
6116       }
6117       break;
6118     }
6119     case CMS_op_checkpointRootsFinal: {
6120       checkpointRootsFinal(true,    // asynch
6121                            false,   // !clear_all_soft_refs
6122                            false);  // !init_mark_was_synchronous
6123       if (PrintGC) {
6124         _cmsGen->printOccupancy("remark");
6125       }
6126       break;
6127     }
6128     default:
6129       fatal("No such CMS_op");
6130   }
6131 }
6132 
6133 #ifndef PRODUCT
6134 size_t const CMSCollector::skip_header_HeapWords() {
6135   return FreeChunk::header_size();
6136 }
6137 
6138 // Try and collect here conditions that should hold when
6139 // CMS thread is exiting. The idea is that the foreground GC
6140 // thread should not be blocked if it wants to terminate
6141 // the CMS thread and yet continue to run the VM for a while
6142 // after that.
6143 void CMSCollector::verify_ok_to_terminate() const {
6144   assert(Thread::current()->is_ConcurrentGC_thread(),
6145          "should be called by CMS thread");
6146   assert(!_foregroundGCShouldWait, "should be false");
6147   // We could check here that all the various low-level locks
6148   // are not held by the CMS thread, but that is overkill; see
6149   // also CMSThread::verify_ok_to_terminate() where the CGC_lock
6150   // is checked.
6151 }
6152 #endif
6153 
6154 size_t CMSCollector::block_size_using_printezis_bits(HeapWord* addr) const {
6155    assert(_markBitMap.isMarked(addr) && _markBitMap.isMarked(addr + 1),
6156           "missing Printezis mark?");
6157   HeapWord* nextOneAddr = _markBitMap.getNextMarkedWordAddress(addr + 2);
6158   size_t size = pointer_delta(nextOneAddr + 1, addr);
6159   assert(size == CompactibleFreeListSpace::adjustObjectSize(size),
6160          "alignment problem");
6161   assert(size >= 3, "Necessary for Printezis marks to work");
6162   return size;
6163 }
6164 
6165 // A variant of the above (block_size_using_printezis_bits()) except
6166 // that we return 0 if the P-bits are not yet set.
6167 size_t CMSCollector::block_size_if_printezis_bits(HeapWord* addr) const {
6168   if (_markBitMap.isMarked(addr)) {
6169     assert(_markBitMap.isMarked(addr + 1), "Missing Printezis bit?");
6170     HeapWord* nextOneAddr = _markBitMap.getNextMarkedWordAddress(addr + 2);
6171     size_t size = pointer_delta(nextOneAddr + 1, addr);
6172     assert(size == CompactibleFreeListSpace::adjustObjectSize(size),
6173            "alignment problem");
6174     assert(size >= 3, "Necessary for Printezis marks to work");
6175     return size;
6176   } else {
6177     assert(!_markBitMap.isMarked(addr + 1), "Bit map inconsistency?");
6178     return 0;
6179   }
6180 }
6181 
6182 HeapWord* CMSCollector::next_card_start_after_block(HeapWord* addr) const {
6183   size_t sz = 0;
6184   oop p = (oop)addr;
6185   if (p->klass_or_null() != NULL && p->is_parsable()) {
6186     sz = CompactibleFreeListSpace::adjustObjectSize(p->size());
6187   } else {
6188     sz = block_size_using_printezis_bits(addr);
6189   }
6190   assert(sz > 0, "size must be nonzero");
6191   HeapWord* next_block = addr + sz;
6192   HeapWord* next_card  = (HeapWord*)round_to((uintptr_t)next_block,
6193                                              CardTableModRefBS::card_size);
6194   assert(round_down((uintptr_t)addr,      CardTableModRefBS::card_size) <
6195          round_down((uintptr_t)next_card, CardTableModRefBS::card_size),
6196          "must be different cards");
6197   return next_card;
6198 }
6199 
6200 
6201 // CMS Bit Map Wrapper /////////////////////////////////////////
6202 
6203 // Construct a CMS bit map infrastructure, but don't create the
6204 // bit vector itself. That is done by a separate call CMSBitMap::allocate()
6205 // further below.
6206 CMSBitMap::CMSBitMap(int shifter, int mutex_rank, const char* mutex_name):
6207   _bm(),
6208   _shifter(shifter),
6209   _lock(mutex_rank >= 0 ? new Mutex(mutex_rank, mutex_name, true) : NULL)
6210 {
6211   _bmStartWord = 0;
6212   _bmWordSize  = 0;
6213 }
6214 
6215 bool CMSBitMap::allocate(MemRegion mr) {
6216   _bmStartWord = mr.start();
6217   _bmWordSize  = mr.word_size();
6218   ReservedSpace brs(ReservedSpace::allocation_align_size_up(
6219                      (_bmWordSize >> (_shifter + LogBitsPerByte)) + 1));
6220   if (!brs.is_reserved()) {
6221     warning("CMS bit map allocation failure");
6222     return false;
6223   }
6224   // For now we'll just commit all of the bit map up fromt.
6225   // Later on we'll try to be more parsimonious with swap.
6226   if (!_virtual_space.initialize(brs, brs.size())) {
6227     warning("CMS bit map backing store failure");
6228     return false;
6229   }
6230   assert(_virtual_space.committed_size() == brs.size(),
6231          "didn't reserve backing store for all of CMS bit map?");
6232   _bm.set_map((BitMap::bm_word_t*)_virtual_space.low());
6233   assert(_virtual_space.committed_size() << (_shifter + LogBitsPerByte) >=
6234          _bmWordSize, "inconsistency in bit map sizing");
6235   _bm.set_size(_bmWordSize >> _shifter);
6236 
6237   // bm.clear(); // can we rely on getting zero'd memory? verify below
6238   assert(isAllClear(),
6239          "Expected zero'd memory from ReservedSpace constructor");
6240   assert(_bm.size() == heapWordDiffToOffsetDiff(sizeInWords()),
6241          "consistency check");
6242   return true;
6243 }
6244 
6245 void CMSBitMap::dirty_range_iterate_clear(MemRegion mr, MemRegionClosure* cl) {
6246   HeapWord *next_addr, *end_addr, *last_addr;
6247   assert_locked();
6248   assert(covers(mr), "out-of-range error");
6249   // XXX assert that start and end are appropriately aligned
6250   for (next_addr = mr.start(), end_addr = mr.end();
6251        next_addr < end_addr; next_addr = last_addr) {
6252     MemRegion dirty_region = getAndClearMarkedRegion(next_addr, end_addr);
6253     last_addr = dirty_region.end();
6254     if (!dirty_region.is_empty()) {
6255       cl->do_MemRegion(dirty_region);
6256     } else {
6257       assert(last_addr == end_addr, "program logic");
6258       return;
6259     }
6260   }
6261 }
6262 
6263 #ifndef PRODUCT
6264 void CMSBitMap::assert_locked() const {
6265   CMSLockVerifier::assert_locked(lock());
6266 }
6267 
6268 bool CMSBitMap::covers(MemRegion mr) const {
6269   // assert(_bm.map() == _virtual_space.low(), "map inconsistency");
6270   assert((size_t)_bm.size() == (_bmWordSize >> _shifter),
6271          "size inconsistency");
6272   return (mr.start() >= _bmStartWord) &&
6273          (mr.end()   <= endWord());
6274 }
6275 
6276 bool CMSBitMap::covers(HeapWord* start, size_t size) const {
6277     return (start >= _bmStartWord && (start + size) <= endWord());
6278 }
6279 
6280 void CMSBitMap::verifyNoOneBitsInRange(HeapWord* left, HeapWord* right) {
6281   // verify that there are no 1 bits in the interval [left, right)
6282   FalseBitMapClosure falseBitMapClosure;
6283   iterate(&falseBitMapClosure, left, right);
6284 }
6285 
6286 void CMSBitMap::region_invariant(MemRegion mr)
6287 {
6288   assert_locked();
6289   // mr = mr.intersection(MemRegion(_bmStartWord, _bmWordSize));
6290   assert(!mr.is_empty(), "unexpected empty region");
6291   assert(covers(mr), "mr should be covered by bit map");
6292   // convert address range into offset range
6293   size_t start_ofs = heapWordToOffset(mr.start());
6294   // Make sure that end() is appropriately aligned
6295   assert(mr.end() == (HeapWord*)round_to((intptr_t)mr.end(),
6296                         (1 << (_shifter+LogHeapWordSize))),
6297          "Misaligned mr.end()");
6298   size_t end_ofs   = heapWordToOffset(mr.end());
6299   assert(end_ofs > start_ofs, "Should mark at least one bit");
6300 }
6301 
6302 #endif
6303 
6304 bool CMSMarkStack::allocate(size_t size) {
6305   // allocate a stack of the requisite depth
6306   ReservedSpace rs(ReservedSpace::allocation_align_size_up(
6307                    size * sizeof(oop)));
6308   if (!rs.is_reserved()) {
6309     warning("CMSMarkStack allocation failure");
6310     return false;
6311   }
6312   if (!_virtual_space.initialize(rs, rs.size())) {
6313     warning("CMSMarkStack backing store failure");
6314     return false;
6315   }
6316   assert(_virtual_space.committed_size() == rs.size(),
6317          "didn't reserve backing store for all of CMS stack?");
6318   _base = (oop*)(_virtual_space.low());
6319   _index = 0;
6320   _capacity = size;
6321   NOT_PRODUCT(_max_depth = 0);
6322   return true;
6323 }
6324 
6325 // XXX FIX ME !!! In the MT case we come in here holding a
6326 // leaf lock. For printing we need to take a further lock
6327 // which has lower rank. We need to recallibrate the two
6328 // lock-ranks involved in order to be able to rpint the
6329 // messages below. (Or defer the printing to the caller.
6330 // For now we take the expedient path of just disabling the
6331 // messages for the problematic case.)
6332 void CMSMarkStack::expand() {
6333   assert(_capacity <= CMSMarkStackSizeMax, "stack bigger than permitted");
6334   if (_capacity == CMSMarkStackSizeMax) {
6335     if (_hit_limit++ == 0 && !CMSConcurrentMTEnabled && PrintGCDetails) {
6336       // We print a warning message only once per CMS cycle.
6337       gclog_or_tty->print_cr(" (benign) Hit CMSMarkStack max size limit");
6338     }
6339     return;
6340   }
6341   // Double capacity if possible
6342   size_t new_capacity = MIN2(_capacity*2, CMSMarkStackSizeMax);
6343   // Do not give up existing stack until we have managed to
6344   // get the double capacity that we desired.
6345   ReservedSpace rs(ReservedSpace::allocation_align_size_up(
6346                    new_capacity * sizeof(oop)));
6347   if (rs.is_reserved()) {
6348     // Release the backing store associated with old stack
6349     _virtual_space.release();
6350     // Reinitialize virtual space for new stack
6351     if (!_virtual_space.initialize(rs, rs.size())) {
6352       fatal("Not enough swap for expanded marking stack");
6353     }
6354     _base = (oop*)(_virtual_space.low());
6355     _index = 0;
6356     _capacity = new_capacity;
6357   } else if (_failed_double++ == 0 && !CMSConcurrentMTEnabled && PrintGCDetails) {
6358     // Failed to double capacity, continue;
6359     // we print a detail message only once per CMS cycle.
6360     gclog_or_tty->print(" (benign) Failed to expand marking stack from "SIZE_FORMAT"K to "
6361             SIZE_FORMAT"K",
6362             _capacity / K, new_capacity / K);
6363   }
6364 }
6365 
6366 
6367 // Closures
6368 // XXX: there seems to be a lot of code  duplication here;
6369 // should refactor and consolidate common code.
6370 
6371 // This closure is used to mark refs into the CMS generation in
6372 // the CMS bit map. Called at the first checkpoint. This closure
6373 // assumes that we do not need to re-mark dirty cards; if the CMS
6374 // generation on which this is used is not an oldest (modulo perm gen)
6375 // generation then this will lose younger_gen cards!
6376 
6377 MarkRefsIntoClosure::MarkRefsIntoClosure(
6378   MemRegion span, CMSBitMap* bitMap, bool should_do_nmethods):
6379     _span(span),
6380     _bitMap(bitMap),
6381     _should_do_nmethods(should_do_nmethods)
6382 {
6383     assert(_ref_processor == NULL, "deliberately left NULL");
6384     assert(_bitMap->covers(_span), "_bitMap/_span mismatch");
6385 }
6386 
6387 void MarkRefsIntoClosure::do_oop(oop obj) {
6388   // if p points into _span, then mark corresponding bit in _markBitMap
6389   assert(obj->is_oop(), "expected an oop");
6390   HeapWord* addr = (HeapWord*)obj;
6391   if (_span.contains(addr)) {
6392     // this should be made more efficient
6393     _bitMap->mark(addr);
6394   }
6395 }
6396 
6397 void MarkRefsIntoClosure::do_oop(oop* p)       { MarkRefsIntoClosure::do_oop_work(p); }
6398 void MarkRefsIntoClosure::do_oop(narrowOop* p) { MarkRefsIntoClosure::do_oop_work(p); }
6399 
6400 // A variant of the above, used for CMS marking verification.
6401 MarkRefsIntoVerifyClosure::MarkRefsIntoVerifyClosure(
6402   MemRegion span, CMSBitMap* verification_bm, CMSBitMap* cms_bm,
6403   bool should_do_nmethods):
6404     _span(span),
6405     _verification_bm(verification_bm),
6406     _cms_bm(cms_bm),
6407     _should_do_nmethods(should_do_nmethods) {
6408     assert(_ref_processor == NULL, "deliberately left NULL");
6409     assert(_verification_bm->covers(_span), "_verification_bm/_span mismatch");
6410 }
6411 
6412 void MarkRefsIntoVerifyClosure::do_oop(oop obj) {
6413   // if p points into _span, then mark corresponding bit in _markBitMap
6414   assert(obj->is_oop(), "expected an oop");
6415   HeapWord* addr = (HeapWord*)obj;
6416   if (_span.contains(addr)) {
6417     _verification_bm->mark(addr);
6418     if (!_cms_bm->isMarked(addr)) {
6419       oop(addr)->print();
6420       gclog_or_tty->print_cr(" (" INTPTR_FORMAT " should have been marked)", addr);
6421       fatal("... aborting");
6422     }
6423   }
6424 }
6425 
6426 void MarkRefsIntoVerifyClosure::do_oop(oop* p)       { MarkRefsIntoVerifyClosure::do_oop_work(p); }
6427 void MarkRefsIntoVerifyClosure::do_oop(narrowOop* p) { MarkRefsIntoVerifyClosure::do_oop_work(p); }
6428 
6429 //////////////////////////////////////////////////
6430 // MarkRefsIntoAndScanClosure
6431 //////////////////////////////////////////////////
6432 
6433 MarkRefsIntoAndScanClosure::MarkRefsIntoAndScanClosure(MemRegion span,
6434                                                        ReferenceProcessor* rp,
6435                                                        CMSBitMap* bit_map,
6436                                                        CMSBitMap* mod_union_table,
6437                                                        CMSMarkStack*  mark_stack,
6438                                                        CMSMarkStack*  revisit_stack,
6439                                                        CMSCollector* collector,
6440                                                        bool should_yield,
6441                                                        bool concurrent_precleaning):
6442   _collector(collector),
6443   _span(span),
6444   _bit_map(bit_map),
6445   _mark_stack(mark_stack),
6446   _pushAndMarkClosure(collector, span, rp, bit_map, mod_union_table,
6447                       mark_stack, revisit_stack, concurrent_precleaning),
6448   _yield(should_yield),
6449   _concurrent_precleaning(concurrent_precleaning),
6450   _freelistLock(NULL)
6451 {
6452   _ref_processor = rp;
6453   assert(_ref_processor != NULL, "_ref_processor shouldn't be NULL");
6454 }
6455 
6456 // This closure is used to mark refs into the CMS generation at the
6457 // second (final) checkpoint, and to scan and transitively follow
6458 // the unmarked oops. It is also used during the concurrent precleaning
6459 // phase while scanning objects on dirty cards in the CMS generation.
6460 // The marks are made in the marking bit map and the marking stack is
6461 // used for keeping the (newly) grey objects during the scan.
6462 // The parallel version (Par_...) appears further below.
6463 void MarkRefsIntoAndScanClosure::do_oop(oop obj) {
6464   if (obj != NULL) {
6465     assert(obj->is_oop(), "expected an oop");
6466     HeapWord* addr = (HeapWord*)obj;
6467     assert(_mark_stack->isEmpty(), "pre-condition (eager drainage)");
6468     assert(_collector->overflow_list_is_empty(),
6469            "overflow list should be empty");
6470     if (_span.contains(addr) &&
6471         !_bit_map->isMarked(addr)) {
6472       // mark bit map (object is now grey)
6473       _bit_map->mark(addr);
6474       // push on marking stack (stack should be empty), and drain the
6475       // stack by applying this closure to the oops in the oops popped
6476       // from the stack (i.e. blacken the grey objects)
6477       bool res = _mark_stack->push(obj);
6478       assert(res, "Should have space to push on empty stack");
6479       do {
6480         oop new_oop = _mark_stack->pop();
6481         assert(new_oop != NULL && new_oop->is_oop(), "Expected an oop");
6482         assert(new_oop->is_parsable(), "Found unparsable oop");
6483         assert(_bit_map->isMarked((HeapWord*)new_oop),
6484                "only grey objects on this stack");
6485         // iterate over the oops in this oop, marking and pushing
6486         // the ones in CMS heap (i.e. in _span).
6487         new_oop->oop_iterate(&_pushAndMarkClosure);
6488         // check if it's time to yield
6489         do_yield_check();
6490       } while (!_mark_stack->isEmpty() ||
6491                (!_concurrent_precleaning && take_from_overflow_list()));
6492         // if marking stack is empty, and we are not doing this
6493         // during precleaning, then check the overflow list
6494     }
6495     assert(_mark_stack->isEmpty(), "post-condition (eager drainage)");
6496     assert(_collector->overflow_list_is_empty(),
6497            "overflow list was drained above");
6498     // We could restore evacuated mark words, if any, used for
6499     // overflow list links here because the overflow list is
6500     // provably empty here. That would reduce the maximum
6501     // size requirements for preserved_{oop,mark}_stack.
6502     // But we'll just postpone it until we are all done
6503     // so we can just stream through.
6504     if (!_concurrent_precleaning && CMSOverflowEarlyRestoration) {
6505       _collector->restore_preserved_marks_if_any();
6506       assert(_collector->no_preserved_marks(), "No preserved marks");
6507     }
6508     assert(!CMSOverflowEarlyRestoration || _collector->no_preserved_marks(),
6509            "All preserved marks should have been restored above");
6510   }
6511 }
6512 
6513 void MarkRefsIntoAndScanClosure::do_oop(oop* p)       { MarkRefsIntoAndScanClosure::do_oop_work(p); }
6514 void MarkRefsIntoAndScanClosure::do_oop(narrowOop* p) { MarkRefsIntoAndScanClosure::do_oop_work(p); }
6515 
6516 void MarkRefsIntoAndScanClosure::do_yield_work() {
6517   assert(ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
6518          "CMS thread should hold CMS token");
6519   assert_lock_strong(_freelistLock);
6520   assert_lock_strong(_bit_map->lock());
6521   // relinquish the free_list_lock and bitMaplock()
6522   _bit_map->lock()->unlock();
6523   _freelistLock->unlock();
6524   ConcurrentMarkSweepThread::desynchronize(true);
6525   ConcurrentMarkSweepThread::acknowledge_yield_request();
6526   _collector->stopTimer();
6527   GCPauseTimer p(_collector->size_policy()->concurrent_timer_ptr());
6528   if (PrintCMSStatistics != 0) {
6529     _collector->incrementYields();
6530   }
6531   _collector->icms_wait();
6532 
6533   // See the comment in coordinator_yield()
6534   for (unsigned i = 0;
6535        i < CMSYieldSleepCount &&
6536        ConcurrentMarkSweepThread::should_yield() &&
6537        !CMSCollector::foregroundGCIsActive();
6538        ++i) {
6539     os::sleep(Thread::current(), 1, false);
6540     ConcurrentMarkSweepThread::acknowledge_yield_request();
6541   }
6542 
6543   ConcurrentMarkSweepThread::synchronize(true);
6544   _freelistLock->lock_without_safepoint_check();
6545   _bit_map->lock()->lock_without_safepoint_check();
6546   _collector->startTimer();
6547 }
6548 
6549 ///////////////////////////////////////////////////////////
6550 // Par_MarkRefsIntoAndScanClosure: a parallel version of
6551 //                                 MarkRefsIntoAndScanClosure
6552 ///////////////////////////////////////////////////////////
6553 Par_MarkRefsIntoAndScanClosure::Par_MarkRefsIntoAndScanClosure(
6554   CMSCollector* collector, MemRegion span, ReferenceProcessor* rp,
6555   CMSBitMap* bit_map, OopTaskQueue* work_queue, CMSMarkStack*  revisit_stack):
6556   _span(span),
6557   _bit_map(bit_map),
6558   _work_queue(work_queue),
6559   _low_water_mark(MIN2((uint)(work_queue->max_elems()/4),
6560                        (uint)(CMSWorkQueueDrainThreshold * ParallelGCThreads))),
6561   _par_pushAndMarkClosure(collector, span, rp, bit_map, work_queue,
6562                           revisit_stack)
6563 {
6564   _ref_processor = rp;
6565   assert(_ref_processor != NULL, "_ref_processor shouldn't be NULL");
6566 }
6567 
6568 // This closure is used to mark refs into the CMS generation at the
6569 // second (final) checkpoint, and to scan and transitively follow
6570 // the unmarked oops. The marks are made in the marking bit map and
6571 // the work_queue is used for keeping the (newly) grey objects during
6572 // the scan phase whence they are also available for stealing by parallel
6573 // threads. Since the marking bit map is shared, updates are
6574 // synchronized (via CAS).
6575 void Par_MarkRefsIntoAndScanClosure::do_oop(oop obj) {
6576   if (obj != NULL) {
6577     // Ignore mark word because this could be an already marked oop
6578     // that may be chained at the end of the overflow list.
6579     assert(obj->is_oop(true), "expected an oop");
6580     HeapWord* addr = (HeapWord*)obj;
6581     if (_span.contains(addr) &&
6582         !_bit_map->isMarked(addr)) {
6583       // mark bit map (object will become grey):
6584       // It is possible for several threads to be
6585       // trying to "claim" this object concurrently;
6586       // the unique thread that succeeds in marking the
6587       // object first will do the subsequent push on
6588       // to the work queue (or overflow list).
6589       if (_bit_map->par_mark(addr)) {
6590         // push on work_queue (which may not be empty), and trim the
6591         // queue to an appropriate length by applying this closure to
6592         // the oops in the oops popped from the stack (i.e. blacken the
6593         // grey objects)
6594         bool res = _work_queue->push(obj);
6595         assert(res, "Low water mark should be less than capacity?");
6596         trim_queue(_low_water_mark);
6597       } // Else, another thread claimed the object
6598     }
6599   }
6600 }
6601 
6602 void Par_MarkRefsIntoAndScanClosure::do_oop(oop* p)       { Par_MarkRefsIntoAndScanClosure::do_oop_work(p); }
6603 void Par_MarkRefsIntoAndScanClosure::do_oop(narrowOop* p) { Par_MarkRefsIntoAndScanClosure::do_oop_work(p); }
6604 
6605 // This closure is used to rescan the marked objects on the dirty cards
6606 // in the mod union table and the card table proper.
6607 size_t ScanMarkedObjectsAgainCarefullyClosure::do_object_careful_m(
6608   oop p, MemRegion mr) {
6609 
6610   size_t size = 0;
6611   HeapWord* addr = (HeapWord*)p;
6612   DEBUG_ONLY(_collector->verify_work_stacks_empty();)
6613   assert(_span.contains(addr), "we are scanning the CMS generation");
6614   // check if it's time to yield
6615   if (do_yield_check()) {
6616     // We yielded for some foreground stop-world work,
6617     // and we have been asked to abort this ongoing preclean cycle.
6618     return 0;
6619   }
6620   if (_bitMap->isMarked(addr)) {
6621     // it's marked; is it potentially uninitialized?
6622     if (p->klass_or_null() != NULL) {
6623       if (CMSPermGenPrecleaningEnabled && !p->is_parsable()) {
6624         // Signal precleaning to redirty the card since
6625         // the klass pointer is already installed.
6626         assert(size == 0, "Initial value");
6627       } else {
6628         assert(p->is_parsable(), "must be parsable.");
6629         // an initialized object; ignore mark word in verification below
6630         // since we are running concurrent with mutators
6631         assert(p->is_oop(true), "should be an oop");
6632         if (p->is_objArray()) {
6633           // objArrays are precisely marked; restrict scanning
6634           // to dirty cards only.
6635           size = CompactibleFreeListSpace::adjustObjectSize(
6636                    p->oop_iterate(_scanningClosure, mr));
6637         } else {
6638           // A non-array may have been imprecisely marked; we need
6639           // to scan object in its entirety.
6640           size = CompactibleFreeListSpace::adjustObjectSize(
6641                    p->oop_iterate(_scanningClosure));
6642         }
6643         #ifdef DEBUG
6644           size_t direct_size =
6645             CompactibleFreeListSpace::adjustObjectSize(p->size());
6646           assert(size == direct_size, "Inconsistency in size");
6647           assert(size >= 3, "Necessary for Printezis marks to work");
6648           if (!_bitMap->isMarked(addr+1)) {
6649             _bitMap->verifyNoOneBitsInRange(addr+2, addr+size);
6650           } else {
6651             _bitMap->verifyNoOneBitsInRange(addr+2, addr+size-1);
6652             assert(_bitMap->isMarked(addr+size-1),
6653                    "inconsistent Printezis mark");
6654           }
6655         #endif // DEBUG
6656       }
6657     } else {
6658       // an unitialized object
6659       assert(_bitMap->isMarked(addr+1), "missing Printezis mark?");
6660       HeapWord* nextOneAddr = _bitMap->getNextMarkedWordAddress(addr + 2);
6661       size = pointer_delta(nextOneAddr + 1, addr);
6662       assert(size == CompactibleFreeListSpace::adjustObjectSize(size),
6663              "alignment problem");
6664       // Note that pre-cleaning needn't redirty the card. OopDesc::set_klass()
6665       // will dirty the card when the klass pointer is installed in the
6666       // object (signalling the completion of initialization).
6667     }
6668   } else {
6669     // Either a not yet marked object or an uninitialized object
6670     if (p->klass_or_null() == NULL || !p->is_parsable()) {
6671       // An uninitialized object, skip to the next card, since
6672       // we may not be able to read its P-bits yet.
6673       assert(size == 0, "Initial value");
6674     } else {
6675       // An object not (yet) reached by marking: we merely need to
6676       // compute its size so as to go look at the next block.
6677       assert(p->is_oop(true), "should be an oop");
6678       size = CompactibleFreeListSpace::adjustObjectSize(p->size());
6679     }
6680   }
6681   DEBUG_ONLY(_collector->verify_work_stacks_empty();)
6682   return size;
6683 }
6684 
6685 void ScanMarkedObjectsAgainCarefullyClosure::do_yield_work() {
6686   assert(ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
6687          "CMS thread should hold CMS token");
6688   assert_lock_strong(_freelistLock);
6689   assert_lock_strong(_bitMap->lock());
6690   // relinquish the free_list_lock and bitMaplock()
6691   _bitMap->lock()->unlock();
6692   _freelistLock->unlock();
6693   ConcurrentMarkSweepThread::desynchronize(true);
6694   ConcurrentMarkSweepThread::acknowledge_yield_request();
6695   _collector->stopTimer();
6696   GCPauseTimer p(_collector->size_policy()->concurrent_timer_ptr());
6697   if (PrintCMSStatistics != 0) {
6698     _collector->incrementYields();
6699   }
6700   _collector->icms_wait();
6701 
6702   // See the comment in coordinator_yield()
6703   for (unsigned i = 0; i < CMSYieldSleepCount &&
6704                    ConcurrentMarkSweepThread::should_yield() &&
6705                    !CMSCollector::foregroundGCIsActive(); ++i) {
6706     os::sleep(Thread::current(), 1, false);
6707     ConcurrentMarkSweepThread::acknowledge_yield_request();
6708   }
6709 
6710   ConcurrentMarkSweepThread::synchronize(true);
6711   _freelistLock->lock_without_safepoint_check();
6712   _bitMap->lock()->lock_without_safepoint_check();
6713   _collector->startTimer();
6714 }
6715 
6716 
6717 //////////////////////////////////////////////////////////////////
6718 // SurvivorSpacePrecleanClosure
6719 //////////////////////////////////////////////////////////////////
6720 // This (single-threaded) closure is used to preclean the oops in
6721 // the survivor spaces.
6722 size_t SurvivorSpacePrecleanClosure::do_object_careful(oop p) {
6723 
6724   HeapWord* addr = (HeapWord*)p;
6725   DEBUG_ONLY(_collector->verify_work_stacks_empty();)
6726   assert(!_span.contains(addr), "we are scanning the survivor spaces");
6727   assert(p->klass_or_null() != NULL, "object should be initializd");
6728   assert(p->is_parsable(), "must be parsable.");
6729   // an initialized object; ignore mark word in verification below
6730   // since we are running concurrent with mutators
6731   assert(p->is_oop(true), "should be an oop");
6732   // Note that we do not yield while we iterate over
6733   // the interior oops of p, pushing the relevant ones
6734   // on our marking stack.
6735   size_t size = p->oop_iterate(_scanning_closure);
6736   do_yield_check();
6737   // Observe that below, we do not abandon the preclean
6738   // phase as soon as we should; rather we empty the
6739   // marking stack before returning. This is to satisfy
6740   // some existing assertions. In general, it may be a
6741   // good idea to abort immediately and complete the marking
6742   // from the grey objects at a later time.
6743   while (!_mark_stack->isEmpty()) {
6744     oop new_oop = _mark_stack->pop();
6745     assert(new_oop != NULL && new_oop->is_oop(), "Expected an oop");
6746     assert(new_oop->is_parsable(), "Found unparsable oop");
6747     assert(_bit_map->isMarked((HeapWord*)new_oop),
6748            "only grey objects on this stack");
6749     // iterate over the oops in this oop, marking and pushing
6750     // the ones in CMS heap (i.e. in _span).
6751     new_oop->oop_iterate(_scanning_closure);
6752     // check if it's time to yield
6753     do_yield_check();
6754   }
6755   unsigned int after_count =
6756     GenCollectedHeap::heap()->total_collections();
6757   bool abort = (_before_count != after_count) ||
6758                _collector->should_abort_preclean();
6759   return abort ? 0 : size;
6760 }
6761 
6762 void SurvivorSpacePrecleanClosure::do_yield_work() {
6763   assert(ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
6764          "CMS thread should hold CMS token");
6765   assert_lock_strong(_bit_map->lock());
6766   // Relinquish the bit map lock
6767   _bit_map->lock()->unlock();
6768   ConcurrentMarkSweepThread::desynchronize(true);
6769   ConcurrentMarkSweepThread::acknowledge_yield_request();
6770   _collector->stopTimer();
6771   GCPauseTimer p(_collector->size_policy()->concurrent_timer_ptr());
6772   if (PrintCMSStatistics != 0) {
6773     _collector->incrementYields();
6774   }
6775   _collector->icms_wait();
6776 
6777   // See the comment in coordinator_yield()
6778   for (unsigned i = 0; i < CMSYieldSleepCount &&
6779                        ConcurrentMarkSweepThread::should_yield() &&
6780                        !CMSCollector::foregroundGCIsActive(); ++i) {
6781     os::sleep(Thread::current(), 1, false);
6782     ConcurrentMarkSweepThread::acknowledge_yield_request();
6783   }
6784 
6785   ConcurrentMarkSweepThread::synchronize(true);
6786   _bit_map->lock()->lock_without_safepoint_check();
6787   _collector->startTimer();
6788 }
6789 
6790 // This closure is used to rescan the marked objects on the dirty cards
6791 // in the mod union table and the card table proper. In the parallel
6792 // case, although the bitMap is shared, we do a single read so the
6793 // isMarked() query is "safe".
6794 bool ScanMarkedObjectsAgainClosure::do_object_bm(oop p, MemRegion mr) {
6795   // Ignore mark word because we are running concurrent with mutators
6796   assert(p->is_oop_or_null(true), "expected an oop or null");
6797   HeapWord* addr = (HeapWord*)p;
6798   assert(_span.contains(addr), "we are scanning the CMS generation");
6799   bool is_obj_array = false;
6800   #ifdef DEBUG
6801     if (!_parallel) {
6802       assert(_mark_stack->isEmpty(), "pre-condition (eager drainage)");
6803       assert(_collector->overflow_list_is_empty(),
6804              "overflow list should be empty");
6805 
6806     }
6807   #endif // DEBUG
6808   if (_bit_map->isMarked(addr)) {
6809     // Obj arrays are precisely marked, non-arrays are not;
6810     // so we scan objArrays precisely and non-arrays in their
6811     // entirety.
6812     if (p->is_objArray()) {
6813       is_obj_array = true;
6814       if (_parallel) {
6815         p->oop_iterate(_par_scan_closure, mr);
6816       } else {
6817         p->oop_iterate(_scan_closure, mr);
6818       }
6819     } else {
6820       if (_parallel) {
6821         p->oop_iterate(_par_scan_closure);
6822       } else {
6823         p->oop_iterate(_scan_closure);
6824       }
6825     }
6826   }
6827   #ifdef DEBUG
6828     if (!_parallel) {
6829       assert(_mark_stack->isEmpty(), "post-condition (eager drainage)");
6830       assert(_collector->overflow_list_is_empty(),
6831              "overflow list should be empty");
6832 
6833     }
6834   #endif // DEBUG
6835   return is_obj_array;
6836 }
6837 
6838 MarkFromRootsClosure::MarkFromRootsClosure(CMSCollector* collector,
6839                         MemRegion span,
6840                         CMSBitMap* bitMap, CMSMarkStack*  markStack,
6841                         CMSMarkStack*  revisitStack,
6842                         bool should_yield, bool verifying):
6843   _collector(collector),
6844   _span(span),
6845   _bitMap(bitMap),
6846   _mut(&collector->_modUnionTable),
6847   _markStack(markStack),
6848   _revisitStack(revisitStack),
6849   _yield(should_yield),
6850   _skipBits(0)
6851 {
6852   assert(_markStack->isEmpty(), "stack should be empty");
6853   _finger = _bitMap->startWord();
6854   _threshold = _finger;
6855   assert(_collector->_restart_addr == NULL, "Sanity check");
6856   assert(_span.contains(_finger), "Out of bounds _finger?");
6857   DEBUG_ONLY(_verifying = verifying;)
6858 }
6859 
6860 void MarkFromRootsClosure::reset(HeapWord* addr) {
6861   assert(_markStack->isEmpty(), "would cause duplicates on stack");
6862   assert(_span.contains(addr), "Out of bounds _finger?");
6863   _finger = addr;
6864   _threshold = (HeapWord*)round_to(
6865                  (intptr_t)_finger, CardTableModRefBS::card_size);
6866 }
6867 
6868 // Should revisit to see if this should be restructured for
6869 // greater efficiency.
6870 bool MarkFromRootsClosure::do_bit(size_t offset) {
6871   if (_skipBits > 0) {
6872     _skipBits--;
6873     return true;
6874   }
6875   // convert offset into a HeapWord*
6876   HeapWord* addr = _bitMap->startWord() + offset;
6877   assert(_bitMap->endWord() && addr < _bitMap->endWord(),
6878          "address out of range");
6879   assert(_bitMap->isMarked(addr), "tautology");
6880   if (_bitMap->isMarked(addr+1)) {
6881     // this is an allocated but not yet initialized object
6882     assert(_skipBits == 0, "tautology");
6883     _skipBits = 2;  // skip next two marked bits ("Printezis-marks")
6884     oop p = oop(addr);
6885     if (p->klass_or_null() == NULL || !p->is_parsable()) {
6886       DEBUG_ONLY(if (!_verifying) {)
6887         // We re-dirty the cards on which this object lies and increase
6888         // the _threshold so that we'll come back to scan this object
6889         // during the preclean or remark phase. (CMSCleanOnEnter)
6890         if (CMSCleanOnEnter) {
6891           size_t sz = _collector->block_size_using_printezis_bits(addr);
6892           HeapWord* end_card_addr   = (HeapWord*)round_to(
6893                                          (intptr_t)(addr+sz), CardTableModRefBS::card_size);
6894           MemRegion redirty_range = MemRegion(addr, end_card_addr);
6895           assert(!redirty_range.is_empty(), "Arithmetical tautology");
6896           // Bump _threshold to end_card_addr; note that
6897           // _threshold cannot possibly exceed end_card_addr, anyhow.
6898           // This prevents future clearing of the card as the scan proceeds
6899           // to the right.
6900           assert(_threshold <= end_card_addr,
6901                  "Because we are just scanning into this object");
6902           if (_threshold < end_card_addr) {
6903             _threshold = end_card_addr;
6904           }
6905           if (p->klass_or_null() != NULL) {
6906             // Redirty the range of cards...
6907             _mut->mark_range(redirty_range);
6908           } // ...else the setting of klass will dirty the card anyway.
6909         }
6910       DEBUG_ONLY(})
6911       return true;
6912     }
6913   }
6914   scanOopsInOop(addr);
6915   return true;
6916 }
6917 
6918 // We take a break if we've been at this for a while,
6919 // so as to avoid monopolizing the locks involved.
6920 void MarkFromRootsClosure::do_yield_work() {
6921   // First give up the locks, then yield, then re-lock
6922   // We should probably use a constructor/destructor idiom to
6923   // do this unlock/lock or modify the MutexUnlocker class to
6924   // serve our purpose. XXX
6925   assert(ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
6926          "CMS thread should hold CMS token");
6927   assert_lock_strong(_bitMap->lock());
6928   _bitMap->lock()->unlock();
6929   ConcurrentMarkSweepThread::desynchronize(true);
6930   ConcurrentMarkSweepThread::acknowledge_yield_request();
6931   _collector->stopTimer();
6932   GCPauseTimer p(_collector->size_policy()->concurrent_timer_ptr());
6933   if (PrintCMSStatistics != 0) {
6934     _collector->incrementYields();
6935   }
6936   _collector->icms_wait();
6937 
6938   // See the comment in coordinator_yield()
6939   for (unsigned i = 0; i < CMSYieldSleepCount &&
6940                        ConcurrentMarkSweepThread::should_yield() &&
6941                        !CMSCollector::foregroundGCIsActive(); ++i) {
6942     os::sleep(Thread::current(), 1, false);
6943     ConcurrentMarkSweepThread::acknowledge_yield_request();
6944   }
6945 
6946   ConcurrentMarkSweepThread::synchronize(true);
6947   _bitMap->lock()->lock_without_safepoint_check();
6948   _collector->startTimer();
6949 }
6950 
6951 void MarkFromRootsClosure::scanOopsInOop(HeapWord* ptr) {
6952   assert(_bitMap->isMarked(ptr), "expected bit to be set");
6953   assert(_markStack->isEmpty(),
6954          "should drain stack to limit stack usage");
6955   // convert ptr to an oop preparatory to scanning
6956   oop obj = oop(ptr);
6957   // Ignore mark word in verification below, since we
6958   // may be running concurrent with mutators.
6959   assert(obj->is_oop(true), "should be an oop");
6960   assert(_finger <= ptr, "_finger runneth ahead");
6961   // advance the finger to right end of this object
6962   _finger = ptr + obj->size();
6963   assert(_finger > ptr, "we just incremented it above");
6964   // On large heaps, it may take us some time to get through
6965   // the marking phase (especially if running iCMS). During
6966   // this time it's possible that a lot of mutations have
6967   // accumulated in the card table and the mod union table --
6968   // these mutation records are redundant until we have
6969   // actually traced into the corresponding card.
6970   // Here, we check whether advancing the finger would make
6971   // us cross into a new card, and if so clear corresponding
6972   // cards in the MUT (preclean them in the card-table in the
6973   // future).
6974 
6975   DEBUG_ONLY(if (!_verifying) {)
6976     // The clean-on-enter optimization is disabled by default,
6977     // until we fix 6178663.
6978     if (CMSCleanOnEnter && (_finger > _threshold)) {
6979       // [_threshold, _finger) represents the interval
6980       // of cards to be cleared  in MUT (or precleaned in card table).
6981       // The set of cards to be cleared is all those that overlap
6982       // with the interval [_threshold, _finger); note that
6983       // _threshold is always kept card-aligned but _finger isn't
6984       // always card-aligned.
6985       HeapWord* old_threshold = _threshold;
6986       assert(old_threshold == (HeapWord*)round_to(
6987               (intptr_t)old_threshold, CardTableModRefBS::card_size),
6988              "_threshold should always be card-aligned");
6989       _threshold = (HeapWord*)round_to(
6990                      (intptr_t)_finger, CardTableModRefBS::card_size);
6991       MemRegion mr(old_threshold, _threshold);
6992       assert(!mr.is_empty(), "Control point invariant");
6993       assert(_span.contains(mr), "Should clear within span");
6994       // XXX When _finger crosses from old gen into perm gen
6995       // we may be doing unnecessary cleaning; do better in the
6996       // future by detecting that condition and clearing fewer
6997       // MUT/CT entries.
6998       _mut->clear_range(mr);
6999     }
7000   DEBUG_ONLY(})
7001 
7002   // Note: the finger doesn't advance while we drain
7003   // the stack below.
7004   PushOrMarkClosure pushOrMarkClosure(_collector,
7005                                       _span, _bitMap, _markStack,
7006                                       _revisitStack,
7007                                       _finger, this);
7008   bool res = _markStack->push(obj);
7009   assert(res, "Empty non-zero size stack should have space for single push");
7010   while (!_markStack->isEmpty()) {
7011     oop new_oop = _markStack->pop();
7012     // Skip verifying header mark word below because we are
7013     // running concurrent with mutators.
7014     assert(new_oop->is_oop(true), "Oops! expected to pop an oop");
7015     // now scan this oop's oops
7016     new_oop->oop_iterate(&pushOrMarkClosure);
7017     do_yield_check();
7018   }
7019   assert(_markStack->isEmpty(), "tautology, emphasizing post-condition");
7020 }
7021 
7022 Par_MarkFromRootsClosure::Par_MarkFromRootsClosure(CMSConcMarkingTask* task,
7023                        CMSCollector* collector, MemRegion span,
7024                        CMSBitMap* bit_map,
7025                        OopTaskQueue* work_queue,
7026                        CMSMarkStack*  overflow_stack,
7027                        CMSMarkStack*  revisit_stack,
7028                        bool should_yield):
7029   _collector(collector),
7030   _whole_span(collector->_span),
7031   _span(span),
7032   _bit_map(bit_map),
7033   _mut(&collector->_modUnionTable),
7034   _work_queue(work_queue),
7035   _overflow_stack(overflow_stack),
7036   _revisit_stack(revisit_stack),
7037   _yield(should_yield),
7038   _skip_bits(0),
7039   _task(task)
7040 {
7041   assert(_work_queue->size() == 0, "work_queue should be empty");
7042   _finger = span.start();
7043   _threshold = _finger;     // XXX Defer clear-on-enter optimization for now
7044   assert(_span.contains(_finger), "Out of bounds _finger?");
7045 }
7046 
7047 // Should revisit to see if this should be restructured for
7048 // greater efficiency.
7049 bool Par_MarkFromRootsClosure::do_bit(size_t offset) {
7050   if (_skip_bits > 0) {
7051     _skip_bits--;
7052     return true;
7053   }
7054   // convert offset into a HeapWord*
7055   HeapWord* addr = _bit_map->startWord() + offset;
7056   assert(_bit_map->endWord() && addr < _bit_map->endWord(),
7057          "address out of range");
7058   assert(_bit_map->isMarked(addr), "tautology");
7059   if (_bit_map->isMarked(addr+1)) {
7060     // this is an allocated object that might not yet be initialized
7061     assert(_skip_bits == 0, "tautology");
7062     _skip_bits = 2;  // skip next two marked bits ("Printezis-marks")
7063     oop p = oop(addr);
7064     if (p->klass_or_null() == NULL || !p->is_parsable()) {
7065       // in the case of Clean-on-Enter optimization, redirty card
7066       // and avoid clearing card by increasing  the threshold.
7067       return true;
7068     }
7069   }
7070   scan_oops_in_oop(addr);
7071   return true;
7072 }
7073 
7074 void Par_MarkFromRootsClosure::scan_oops_in_oop(HeapWord* ptr) {
7075   assert(_bit_map->isMarked(ptr), "expected bit to be set");
7076   // Should we assert that our work queue is empty or
7077   // below some drain limit?
7078   assert(_work_queue->size() == 0,
7079          "should drain stack to limit stack usage");
7080   // convert ptr to an oop preparatory to scanning
7081   oop obj = oop(ptr);
7082   // Ignore mark word in verification below, since we
7083   // may be running concurrent with mutators.
7084   assert(obj->is_oop(true), "should be an oop");
7085   assert(_finger <= ptr, "_finger runneth ahead");
7086   // advance the finger to right end of this object
7087   _finger = ptr + obj->size();
7088   assert(_finger > ptr, "we just incremented it above");
7089   // On large heaps, it may take us some time to get through
7090   // the marking phase (especially if running iCMS). During
7091   // this time it's possible that a lot of mutations have
7092   // accumulated in the card table and the mod union table --
7093   // these mutation records are redundant until we have
7094   // actually traced into the corresponding card.
7095   // Here, we check whether advancing the finger would make
7096   // us cross into a new card, and if so clear corresponding
7097   // cards in the MUT (preclean them in the card-table in the
7098   // future).
7099 
7100   // The clean-on-enter optimization is disabled by default,
7101   // until we fix 6178663.
7102   if (CMSCleanOnEnter && (_finger > _threshold)) {
7103     // [_threshold, _finger) represents the interval
7104     // of cards to be cleared  in MUT (or precleaned in card table).
7105     // The set of cards to be cleared is all those that overlap
7106     // with the interval [_threshold, _finger); note that
7107     // _threshold is always kept card-aligned but _finger isn't
7108     // always card-aligned.
7109     HeapWord* old_threshold = _threshold;
7110     assert(old_threshold == (HeapWord*)round_to(
7111             (intptr_t)old_threshold, CardTableModRefBS::card_size),
7112            "_threshold should always be card-aligned");
7113     _threshold = (HeapWord*)round_to(
7114                    (intptr_t)_finger, CardTableModRefBS::card_size);
7115     MemRegion mr(old_threshold, _threshold);
7116     assert(!mr.is_empty(), "Control point invariant");
7117     assert(_span.contains(mr), "Should clear within span"); // _whole_span ??
7118     // XXX When _finger crosses from old gen into perm gen
7119     // we may be doing unnecessary cleaning; do better in the
7120     // future by detecting that condition and clearing fewer
7121     // MUT/CT entries.
7122     _mut->clear_range(mr);
7123   }
7124 
7125   // Note: the local finger doesn't advance while we drain
7126   // the stack below, but the global finger sure can and will.
7127   HeapWord** gfa = _task->global_finger_addr();
7128   Par_PushOrMarkClosure pushOrMarkClosure(_collector,
7129                                       _span, _bit_map,
7130                                       _work_queue,
7131                                       _overflow_stack,
7132                                       _revisit_stack,
7133                                       _finger,
7134                                       gfa, this);
7135   bool res = _work_queue->push(obj);   // overflow could occur here
7136   assert(res, "Will hold once we use workqueues");
7137   while (true) {
7138     oop new_oop;
7139     if (!_work_queue->pop_local(new_oop)) {
7140       // We emptied our work_queue; check if there's stuff that can
7141       // be gotten from the overflow stack.
7142       if (CMSConcMarkingTask::get_work_from_overflow_stack(
7143             _overflow_stack, _work_queue)) {
7144         do_yield_check();
7145         continue;
7146       } else {  // done
7147         break;
7148       }
7149     }
7150     // Skip verifying header mark word below because we are
7151     // running concurrent with mutators.
7152     assert(new_oop->is_oop(true), "Oops! expected to pop an oop");
7153     // now scan this oop's oops
7154     new_oop->oop_iterate(&pushOrMarkClosure);
7155     do_yield_check();
7156   }
7157   assert(_work_queue->size() == 0, "tautology, emphasizing post-condition");
7158 }
7159 
7160 // Yield in response to a request from VM Thread or
7161 // from mutators.
7162 void Par_MarkFromRootsClosure::do_yield_work() {
7163   assert(_task != NULL, "sanity");
7164   _task->yield();
7165 }
7166 
7167 // A variant of the above used for verifying CMS marking work.
7168 MarkFromRootsVerifyClosure::MarkFromRootsVerifyClosure(CMSCollector* collector,
7169                         MemRegion span,
7170                         CMSBitMap* verification_bm, CMSBitMap* cms_bm,
7171                         CMSMarkStack*  mark_stack):
7172   _collector(collector),
7173   _span(span),
7174   _verification_bm(verification_bm),
7175   _cms_bm(cms_bm),
7176   _mark_stack(mark_stack),
7177   _pam_verify_closure(collector, span, verification_bm, cms_bm,
7178                       mark_stack)
7179 {
7180   assert(_mark_stack->isEmpty(), "stack should be empty");
7181   _finger = _verification_bm->startWord();
7182   assert(_collector->_restart_addr == NULL, "Sanity check");
7183   assert(_span.contains(_finger), "Out of bounds _finger?");
7184 }
7185 
7186 void MarkFromRootsVerifyClosure::reset(HeapWord* addr) {
7187   assert(_mark_stack->isEmpty(), "would cause duplicates on stack");
7188   assert(_span.contains(addr), "Out of bounds _finger?");
7189   _finger = addr;
7190 }
7191 
7192 // Should revisit to see if this should be restructured for
7193 // greater efficiency.
7194 bool MarkFromRootsVerifyClosure::do_bit(size_t offset) {
7195   // convert offset into a HeapWord*
7196   HeapWord* addr = _verification_bm->startWord() + offset;
7197   assert(_verification_bm->endWord() && addr < _verification_bm->endWord(),
7198          "address out of range");
7199   assert(_verification_bm->isMarked(addr), "tautology");
7200   assert(_cms_bm->isMarked(addr), "tautology");
7201 
7202   assert(_mark_stack->isEmpty(),
7203          "should drain stack to limit stack usage");
7204   // convert addr to an oop preparatory to scanning
7205   oop obj = oop(addr);
7206   assert(obj->is_oop(), "should be an oop");
7207   assert(_finger <= addr, "_finger runneth ahead");
7208   // advance the finger to right end of this object
7209   _finger = addr + obj->size();
7210   assert(_finger > addr, "we just incremented it above");
7211   // Note: the finger doesn't advance while we drain
7212   // the stack below.
7213   bool res = _mark_stack->push(obj);
7214   assert(res, "Empty non-zero size stack should have space for single push");
7215   while (!_mark_stack->isEmpty()) {
7216     oop new_oop = _mark_stack->pop();
7217     assert(new_oop->is_oop(), "Oops! expected to pop an oop");
7218     // now scan this oop's oops
7219     new_oop->oop_iterate(&_pam_verify_closure);
7220   }
7221   assert(_mark_stack->isEmpty(), "tautology, emphasizing post-condition");
7222   return true;
7223 }
7224 
7225 PushAndMarkVerifyClosure::PushAndMarkVerifyClosure(
7226   CMSCollector* collector, MemRegion span,
7227   CMSBitMap* verification_bm, CMSBitMap* cms_bm,
7228   CMSMarkStack*  mark_stack):
7229   OopClosure(collector->ref_processor()),
7230   _collector(collector),
7231   _span(span),
7232   _verification_bm(verification_bm),
7233   _cms_bm(cms_bm),
7234   _mark_stack(mark_stack)
7235 { }
7236 
7237 void PushAndMarkVerifyClosure::do_oop(oop* p)       { PushAndMarkVerifyClosure::do_oop_work(p); }
7238 void PushAndMarkVerifyClosure::do_oop(narrowOop* p) { PushAndMarkVerifyClosure::do_oop_work(p); }
7239 
7240 // Upon stack overflow, we discard (part of) the stack,
7241 // remembering the least address amongst those discarded
7242 // in CMSCollector's _restart_address.
7243 void PushAndMarkVerifyClosure::handle_stack_overflow(HeapWord* lost) {
7244   // Remember the least grey address discarded
7245   HeapWord* ra = (HeapWord*)_mark_stack->least_value(lost);
7246   _collector->lower_restart_addr(ra);
7247   _mark_stack->reset();  // discard stack contents
7248   _mark_stack->expand(); // expand the stack if possible
7249 }
7250 
7251 void PushAndMarkVerifyClosure::do_oop(oop obj) {
7252   assert(obj->is_oop_or_null(), "expected an oop or NULL");
7253   HeapWord* addr = (HeapWord*)obj;
7254   if (_span.contains(addr) && !_verification_bm->isMarked(addr)) {
7255     // Oop lies in _span and isn't yet grey or black
7256     _verification_bm->mark(addr);            // now grey
7257     if (!_cms_bm->isMarked(addr)) {
7258       oop(addr)->print();
7259       gclog_or_tty->print_cr(" (" INTPTR_FORMAT " should have been marked)",
7260                              addr);
7261       fatal("... aborting");
7262     }
7263 
7264     if (!_mark_stack->push(obj)) { // stack overflow
7265       if (PrintCMSStatistics != 0) {
7266         gclog_or_tty->print_cr("CMS marking stack overflow (benign) at "
7267                                SIZE_FORMAT, _mark_stack->capacity());
7268       }
7269       assert(_mark_stack->isFull(), "Else push should have succeeded");
7270       handle_stack_overflow(addr);
7271     }
7272     // anything including and to the right of _finger
7273     // will be scanned as we iterate over the remainder of the
7274     // bit map
7275   }
7276 }
7277 
7278 PushOrMarkClosure::PushOrMarkClosure(CMSCollector* collector,
7279                      MemRegion span,
7280                      CMSBitMap* bitMap, CMSMarkStack*  markStack,
7281                      CMSMarkStack*  revisitStack,
7282                      HeapWord* finger, MarkFromRootsClosure* parent) :
7283   OopClosure(collector->ref_processor()),
7284   _collector(collector),
7285   _span(span),
7286   _bitMap(bitMap),
7287   _markStack(markStack),
7288   _revisitStack(revisitStack),
7289   _finger(finger),
7290   _parent(parent),
7291   _should_remember_klasses(collector->should_unload_classes())
7292 { }
7293 
7294 Par_PushOrMarkClosure::Par_PushOrMarkClosure(CMSCollector* collector,
7295                      MemRegion span,
7296                      CMSBitMap* bit_map,
7297                      OopTaskQueue* work_queue,
7298                      CMSMarkStack*  overflow_stack,
7299                      CMSMarkStack*  revisit_stack,
7300                      HeapWord* finger,
7301                      HeapWord** global_finger_addr,
7302                      Par_MarkFromRootsClosure* parent) :
7303   OopClosure(collector->ref_processor()),
7304   _collector(collector),
7305   _whole_span(collector->_span),
7306   _span(span),
7307   _bit_map(bit_map),
7308   _work_queue(work_queue),
7309   _overflow_stack(overflow_stack),
7310   _revisit_stack(revisit_stack),
7311   _finger(finger),
7312   _global_finger_addr(global_finger_addr),
7313   _parent(parent),
7314   _should_remember_klasses(collector->should_unload_classes())
7315 { }
7316 
7317 // Assumes thread-safe access by callers, who are
7318 // responsible for mutual exclusion.
7319 void CMSCollector::lower_restart_addr(HeapWord* low) {
7320   assert(_span.contains(low), "Out of bounds addr");
7321   if (_restart_addr == NULL) {
7322     _restart_addr = low;
7323   } else {
7324     _restart_addr = MIN2(_restart_addr, low);
7325   }
7326 }
7327 
7328 // Upon stack overflow, we discard (part of) the stack,
7329 // remembering the least address amongst those discarded
7330 // in CMSCollector's _restart_address.
7331 void PushOrMarkClosure::handle_stack_overflow(HeapWord* lost) {
7332   // Remember the least grey address discarded
7333   HeapWord* ra = (HeapWord*)_markStack->least_value(lost);
7334   _collector->lower_restart_addr(ra);
7335   _markStack->reset();  // discard stack contents
7336   _markStack->expand(); // expand the stack if possible
7337 }
7338 
7339 // Upon stack overflow, we discard (part of) the stack,
7340 // remembering the least address amongst those discarded
7341 // in CMSCollector's _restart_address.
7342 void Par_PushOrMarkClosure::handle_stack_overflow(HeapWord* lost) {
7343   // We need to do this under a mutex to prevent other
7344   // workers from interfering with the work done below.
7345   MutexLockerEx ml(_overflow_stack->par_lock(),
7346                    Mutex::_no_safepoint_check_flag);
7347   // Remember the least grey address discarded
7348   HeapWord* ra = (HeapWord*)_overflow_stack->least_value(lost);
7349   _collector->lower_restart_addr(ra);
7350   _overflow_stack->reset();  // discard stack contents
7351   _overflow_stack->expand(); // expand the stack if possible
7352 }
7353 
7354 void PushOrMarkClosure::do_oop(oop obj) {
7355   // Ignore mark word because we are running concurrent with mutators.
7356   assert(obj->is_oop_or_null(true), "expected an oop or NULL");
7357   HeapWord* addr = (HeapWord*)obj;
7358   if (_span.contains(addr) && !_bitMap->isMarked(addr)) {
7359     // Oop lies in _span and isn't yet grey or black
7360     _bitMap->mark(addr);            // now grey
7361     if (addr < _finger) {
7362       // the bit map iteration has already either passed, or
7363       // sampled, this bit in the bit map; we'll need to
7364       // use the marking stack to scan this oop's oops.
7365       bool simulate_overflow = false;
7366       NOT_PRODUCT(
7367         if (CMSMarkStackOverflowALot &&
7368             _collector->simulate_overflow()) {
7369           // simulate a stack overflow
7370           simulate_overflow = true;
7371         }
7372       )
7373       if (simulate_overflow || !_markStack->push(obj)) { // stack overflow
7374         if (PrintCMSStatistics != 0) {
7375           gclog_or_tty->print_cr("CMS marking stack overflow (benign) at "
7376                                  SIZE_FORMAT, _markStack->capacity());
7377         }
7378         assert(simulate_overflow || _markStack->isFull(), "Else push should have succeeded");
7379         handle_stack_overflow(addr);
7380       }
7381     }
7382     // anything including and to the right of _finger
7383     // will be scanned as we iterate over the remainder of the
7384     // bit map
7385     do_yield_check();
7386   }
7387 }
7388 
7389 void PushOrMarkClosure::do_oop(oop* p)       { PushOrMarkClosure::do_oop_work(p); }
7390 void PushOrMarkClosure::do_oop(narrowOop* p) { PushOrMarkClosure::do_oop_work(p); }
7391 
7392 void Par_PushOrMarkClosure::do_oop(oop obj) {
7393   // Ignore mark word because we are running concurrent with mutators.
7394   assert(obj->is_oop_or_null(true), "expected an oop or NULL");
7395   HeapWord* addr = (HeapWord*)obj;
7396   if (_whole_span.contains(addr) && !_bit_map->isMarked(addr)) {
7397     // Oop lies in _span and isn't yet grey or black
7398     // We read the global_finger (volatile read) strictly after marking oop
7399     bool res = _bit_map->par_mark(addr);    // now grey
7400     volatile HeapWord** gfa = (volatile HeapWord**)_global_finger_addr;
7401     // Should we push this marked oop on our stack?
7402     // -- if someone else marked it, nothing to do
7403     // -- if target oop is above global finger nothing to do
7404     // -- if target oop is in chunk and above local finger
7405     //      then nothing to do
7406     // -- else push on work queue
7407     if (   !res       // someone else marked it, they will deal with it
7408         || (addr >= *gfa)  // will be scanned in a later task
7409         || (_span.contains(addr) && addr >= _finger)) { // later in this chunk
7410       return;
7411     }
7412     // the bit map iteration has already either passed, or
7413     // sampled, this bit in the bit map; we'll need to
7414     // use the marking stack to scan this oop's oops.
7415     bool simulate_overflow = false;
7416     NOT_PRODUCT(
7417       if (CMSMarkStackOverflowALot &&
7418           _collector->simulate_overflow()) {
7419         // simulate a stack overflow
7420         simulate_overflow = true;
7421       }
7422     )
7423     if (simulate_overflow ||
7424         !(_work_queue->push(obj) || _overflow_stack->par_push(obj))) {
7425       // stack overflow
7426       if (PrintCMSStatistics != 0) {
7427         gclog_or_tty->print_cr("CMS marking stack overflow (benign) at "
7428                                SIZE_FORMAT, _overflow_stack->capacity());
7429       }
7430       // We cannot assert that the overflow stack is full because
7431       // it may have been emptied since.
7432       assert(simulate_overflow ||
7433              _work_queue->size() == _work_queue->max_elems(),
7434             "Else push should have succeeded");
7435       handle_stack_overflow(addr);
7436     }
7437     do_yield_check();
7438   }
7439 }
7440 
7441 void Par_PushOrMarkClosure::do_oop(oop* p)       { Par_PushOrMarkClosure::do_oop_work(p); }
7442 void Par_PushOrMarkClosure::do_oop(narrowOop* p) { Par_PushOrMarkClosure::do_oop_work(p); }
7443 
7444 PushAndMarkClosure::PushAndMarkClosure(CMSCollector* collector,
7445                                        MemRegion span,
7446                                        ReferenceProcessor* rp,
7447                                        CMSBitMap* bit_map,
7448                                        CMSBitMap* mod_union_table,
7449                                        CMSMarkStack*  mark_stack,
7450                                        CMSMarkStack*  revisit_stack,
7451                                        bool           concurrent_precleaning):
7452   OopClosure(rp),
7453   _collector(collector),
7454   _span(span),
7455   _bit_map(bit_map),
7456   _mod_union_table(mod_union_table),
7457   _mark_stack(mark_stack),
7458   _revisit_stack(revisit_stack),
7459   _concurrent_precleaning(concurrent_precleaning),
7460   _should_remember_klasses(collector->should_unload_classes())
7461 {
7462   assert(_ref_processor != NULL, "_ref_processor shouldn't be NULL");
7463 }
7464 
7465 // Grey object rescan during pre-cleaning and second checkpoint phases --
7466 // the non-parallel version (the parallel version appears further below.)
7467 void PushAndMarkClosure::do_oop(oop obj) {
7468   // Ignore mark word verification. If during concurrent precleaning,
7469   // the object monitor may be locked. If during the checkpoint
7470   // phases, the object may already have been reached by a  different
7471   // path and may be at the end of the global overflow list (so
7472   // the mark word may be NULL).
7473   assert(obj->is_oop_or_null(true /* ignore mark word */),
7474          "expected an oop or NULL");
7475   HeapWord* addr = (HeapWord*)obj;
7476   // Check if oop points into the CMS generation
7477   // and is not marked
7478   if (_span.contains(addr) && !_bit_map->isMarked(addr)) {
7479     // a white object ...
7480     _bit_map->mark(addr);         // ... now grey
7481     // push on the marking stack (grey set)
7482     bool simulate_overflow = false;
7483     NOT_PRODUCT(
7484       if (CMSMarkStackOverflowALot &&
7485           _collector->simulate_overflow()) {
7486         // simulate a stack overflow
7487         simulate_overflow = true;
7488       }
7489     )
7490     if (simulate_overflow || !_mark_stack->push(obj)) {
7491       if (_concurrent_precleaning) {
7492          // During precleaning we can just dirty the appropriate card(s)
7493          // in the mod union table, thus ensuring that the object remains
7494          // in the grey set  and continue. In the case of object arrays
7495          // we need to dirty all of the cards that the object spans,
7496          // since the rescan of object arrays will be limited to the
7497          // dirty cards.
7498          // Note that no one can be intefering with us in this action
7499          // of dirtying the mod union table, so no locking or atomics
7500          // are required.
7501          if (obj->is_objArray()) {
7502            size_t sz = obj->size();
7503            HeapWord* end_card_addr = (HeapWord*)round_to(
7504                                         (intptr_t)(addr+sz), CardTableModRefBS::card_size);
7505            MemRegion redirty_range = MemRegion(addr, end_card_addr);
7506            assert(!redirty_range.is_empty(), "Arithmetical tautology");
7507            _mod_union_table->mark_range(redirty_range);
7508          } else {
7509            _mod_union_table->mark(addr);
7510          }
7511          _collector->_ser_pmc_preclean_ovflw++;
7512       } else {
7513          // During the remark phase, we need to remember this oop
7514          // in the overflow list.
7515          _collector->push_on_overflow_list(obj);
7516          _collector->_ser_pmc_remark_ovflw++;
7517       }
7518     }
7519   }
7520 }
7521 
7522 Par_PushAndMarkClosure::Par_PushAndMarkClosure(CMSCollector* collector,
7523                                                MemRegion span,
7524                                                ReferenceProcessor* rp,
7525                                                CMSBitMap* bit_map,
7526                                                OopTaskQueue* work_queue,
7527                                                CMSMarkStack* revisit_stack):
7528   OopClosure(rp),
7529   _collector(collector),
7530   _span(span),
7531   _bit_map(bit_map),
7532   _work_queue(work_queue),
7533   _revisit_stack(revisit_stack),
7534   _should_remember_klasses(collector->should_unload_classes())
7535 {
7536   assert(_ref_processor != NULL, "_ref_processor shouldn't be NULL");
7537 }
7538 
7539 void PushAndMarkClosure::do_oop(oop* p)       { PushAndMarkClosure::do_oop_work(p); }
7540 void PushAndMarkClosure::do_oop(narrowOop* p) { PushAndMarkClosure::do_oop_work(p); }
7541 
7542 // Grey object rescan during second checkpoint phase --
7543 // the parallel version.
7544 void Par_PushAndMarkClosure::do_oop(oop obj) {
7545   // In the assert below, we ignore the mark word because
7546   // this oop may point to an already visited object that is
7547   // on the overflow stack (in which case the mark word has
7548   // been hijacked for chaining into the overflow stack --
7549   // if this is the last object in the overflow stack then
7550   // its mark word will be NULL). Because this object may
7551   // have been subsequently popped off the global overflow
7552   // stack, and the mark word possibly restored to the prototypical
7553   // value, by the time we get to examined this failing assert in
7554   // the debugger, is_oop_or_null(false) may subsequently start
7555   // to hold.
7556   assert(obj->is_oop_or_null(true),
7557          "expected an oop or NULL");
7558   HeapWord* addr = (HeapWord*)obj;
7559   // Check if oop points into the CMS generation
7560   // and is not marked
7561   if (_span.contains(addr) && !_bit_map->isMarked(addr)) {
7562     // a white object ...
7563     // If we manage to "claim" the object, by being the
7564     // first thread to mark it, then we push it on our
7565     // marking stack
7566     if (_bit_map->par_mark(addr)) {     // ... now grey
7567       // push on work queue (grey set)
7568       bool simulate_overflow = false;
7569       NOT_PRODUCT(
7570         if (CMSMarkStackOverflowALot &&
7571             _collector->par_simulate_overflow()) {
7572           // simulate a stack overflow
7573           simulate_overflow = true;
7574         }
7575       )
7576       if (simulate_overflow || !_work_queue->push(obj)) {
7577         _collector->par_push_on_overflow_list(obj);
7578         _collector->_par_pmc_remark_ovflw++; //  imprecise OK: no need to CAS
7579       }
7580     } // Else, some other thread got there first
7581   }
7582 }
7583 
7584 void Par_PushAndMarkClosure::do_oop(oop* p)       { Par_PushAndMarkClosure::do_oop_work(p); }
7585 void Par_PushAndMarkClosure::do_oop(narrowOop* p) { Par_PushAndMarkClosure::do_oop_work(p); }
7586 
7587 void PushAndMarkClosure::remember_klass(Klass* k) {
7588   if (!_revisit_stack->push(oop(k))) {
7589     fatal("Revisit stack overflowed in PushAndMarkClosure");
7590   }
7591 }
7592 
7593 void Par_PushAndMarkClosure::remember_klass(Klass* k) {
7594   if (!_revisit_stack->par_push(oop(k))) {
7595     fatal("Revist stack overflowed in Par_PushAndMarkClosure");
7596   }
7597 }
7598 
7599 void CMSPrecleanRefsYieldClosure::do_yield_work() {
7600   Mutex* bml = _collector->bitMapLock();
7601   assert_lock_strong(bml);
7602   assert(ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
7603          "CMS thread should hold CMS token");
7604 
7605   bml->unlock();
7606   ConcurrentMarkSweepThread::desynchronize(true);
7607 
7608   ConcurrentMarkSweepThread::acknowledge_yield_request();
7609 
7610   _collector->stopTimer();
7611   GCPauseTimer p(_collector->size_policy()->concurrent_timer_ptr());
7612   if (PrintCMSStatistics != 0) {
7613     _collector->incrementYields();
7614   }
7615   _collector->icms_wait();
7616 
7617   // See the comment in coordinator_yield()
7618   for (unsigned i = 0; i < CMSYieldSleepCount &&
7619                        ConcurrentMarkSweepThread::should_yield() &&
7620                        !CMSCollector::foregroundGCIsActive(); ++i) {
7621     os::sleep(Thread::current(), 1, false);
7622     ConcurrentMarkSweepThread::acknowledge_yield_request();
7623   }
7624 
7625   ConcurrentMarkSweepThread::synchronize(true);
7626   bml->lock();
7627 
7628   _collector->startTimer();
7629 }
7630 
7631 bool CMSPrecleanRefsYieldClosure::should_return() {
7632   if (ConcurrentMarkSweepThread::should_yield()) {
7633     do_yield_work();
7634   }
7635   return _collector->foregroundGCIsActive();
7636 }
7637 
7638 void MarkFromDirtyCardsClosure::do_MemRegion(MemRegion mr) {
7639   assert(((size_t)mr.start())%CardTableModRefBS::card_size_in_words == 0,
7640          "mr should be aligned to start at a card boundary");
7641   // We'd like to assert:
7642   // assert(mr.word_size()%CardTableModRefBS::card_size_in_words == 0,
7643   //        "mr should be a range of cards");
7644   // However, that would be too strong in one case -- the last
7645   // partition ends at _unallocated_block which, in general, can be
7646   // an arbitrary boundary, not necessarily card aligned.
7647   if (PrintCMSStatistics != 0) {
7648     _num_dirty_cards +=
7649          mr.word_size()/CardTableModRefBS::card_size_in_words;
7650   }
7651   _space->object_iterate_mem(mr, &_scan_cl);
7652 }
7653 
7654 SweepClosure::SweepClosure(CMSCollector* collector,
7655                            ConcurrentMarkSweepGeneration* g,
7656                            CMSBitMap* bitMap, bool should_yield) :
7657   _collector(collector),
7658   _g(g),
7659   _sp(g->cmsSpace()),
7660   _limit(_sp->sweep_limit()),
7661   _freelistLock(_sp->freelistLock()),
7662   _bitMap(bitMap),
7663   _yield(should_yield),
7664   _inFreeRange(false),           // No free range at beginning of sweep
7665   _freeRangeInFreeLists(false),  // No free range at beginning of sweep
7666   _lastFreeRangeCoalesced(false),
7667   _freeFinger(g->used_region().start())
7668 {
7669   NOT_PRODUCT(
7670     _numObjectsFreed = 0;
7671     _numWordsFreed   = 0;
7672     _numObjectsLive = 0;
7673     _numWordsLive = 0;
7674     _numObjectsAlreadyFree = 0;
7675     _numWordsAlreadyFree = 0;
7676     _last_fc = NULL;
7677 
7678     _sp->initializeIndexedFreeListArrayReturnedBytes();
7679     _sp->dictionary()->initializeDictReturnedBytes();
7680   )
7681   assert(_limit >= _sp->bottom() && _limit <= _sp->end(),
7682          "sweep _limit out of bounds");
7683   if (CMSTraceSweeper) {
7684     gclog_or_tty->print("\n====================\nStarting new sweep\n");
7685   }
7686 }
7687 
7688 // We need this destructor to reclaim any space at the end
7689 // of the space, which do_blk below may not have added back to
7690 // the free lists. [basically dealing with the "fringe effect"]
7691 SweepClosure::~SweepClosure() {
7692   assert_lock_strong(_freelistLock);
7693   // this should be treated as the end of a free run if any
7694   // The current free range should be returned to the free lists
7695   // as one coalesced chunk.
7696   if (inFreeRange()) {
7697     flushCurFreeChunk(freeFinger(),
7698       pointer_delta(_limit, freeFinger()));
7699     assert(freeFinger() < _limit, "the finger pointeth off base");
7700     if (CMSTraceSweeper) {
7701       gclog_or_tty->print("destructor:");
7702       gclog_or_tty->print("Sweep:put_free_blk 0x%x ("SIZE_FORMAT") "
7703                  "[coalesced:"SIZE_FORMAT"]\n",
7704                  freeFinger(), pointer_delta(_limit, freeFinger()),
7705                  lastFreeRangeCoalesced());
7706     }
7707   }
7708   NOT_PRODUCT(
7709     if (Verbose && PrintGC) {
7710       gclog_or_tty->print("Collected "SIZE_FORMAT" objects, "
7711                           SIZE_FORMAT " bytes",
7712                  _numObjectsFreed, _numWordsFreed*sizeof(HeapWord));
7713       gclog_or_tty->print_cr("\nLive "SIZE_FORMAT" objects,  "
7714                              SIZE_FORMAT" bytes  "
7715         "Already free "SIZE_FORMAT" objects, "SIZE_FORMAT" bytes",
7716         _numObjectsLive, _numWordsLive*sizeof(HeapWord),
7717         _numObjectsAlreadyFree, _numWordsAlreadyFree*sizeof(HeapWord));
7718       size_t totalBytes = (_numWordsFreed + _numWordsLive + _numWordsAlreadyFree) *
7719         sizeof(HeapWord);
7720       gclog_or_tty->print_cr("Total sweep: "SIZE_FORMAT" bytes", totalBytes);
7721 
7722       if (PrintCMSStatistics && CMSVerifyReturnedBytes) {
7723         size_t indexListReturnedBytes = _sp->sumIndexedFreeListArrayReturnedBytes();
7724         size_t dictReturnedBytes = _sp->dictionary()->sumDictReturnedBytes();
7725         size_t returnedBytes = indexListReturnedBytes + dictReturnedBytes;
7726         gclog_or_tty->print("Returned "SIZE_FORMAT" bytes", returnedBytes);
7727         gclog_or_tty->print("   Indexed List Returned "SIZE_FORMAT" bytes",
7728           indexListReturnedBytes);
7729         gclog_or_tty->print_cr("        Dictionary Returned "SIZE_FORMAT" bytes",
7730           dictReturnedBytes);
7731       }
7732     }
7733   )
7734   // Now, in debug mode, just null out the sweep_limit
7735   NOT_PRODUCT(_sp->clear_sweep_limit();)
7736   if (CMSTraceSweeper) {
7737     gclog_or_tty->print("end of sweep\n================\n");
7738   }
7739 }
7740 
7741 void SweepClosure::initialize_free_range(HeapWord* freeFinger,
7742     bool freeRangeInFreeLists) {
7743   if (CMSTraceSweeper) {
7744     gclog_or_tty->print("---- Start free range 0x%x with free block [%d] (%d)\n",
7745                freeFinger, _sp->block_size(freeFinger),
7746                freeRangeInFreeLists);
7747   }
7748   assert(!inFreeRange(), "Trampling existing free range");
7749   set_inFreeRange(true);
7750   set_lastFreeRangeCoalesced(false);
7751 
7752   set_freeFinger(freeFinger);
7753   set_freeRangeInFreeLists(freeRangeInFreeLists);
7754   if (CMSTestInFreeList) {
7755     if (freeRangeInFreeLists) {
7756       FreeChunk* fc = (FreeChunk*) freeFinger;
7757       assert(fc->isFree(), "A chunk on the free list should be free.");
7758       assert(fc->size() > 0, "Free range should have a size");
7759       assert(_sp->verifyChunkInFreeLists(fc), "Chunk is not in free lists");
7760     }
7761   }
7762 }
7763 
7764 // Note that the sweeper runs concurrently with mutators. Thus,
7765 // it is possible for direct allocation in this generation to happen
7766 // in the middle of the sweep. Note that the sweeper also coalesces
7767 // contiguous free blocks. Thus, unless the sweeper and the allocator
7768 // synchronize appropriately freshly allocated blocks may get swept up.
7769 // This is accomplished by the sweeper locking the free lists while
7770 // it is sweeping. Thus blocks that are determined to be free are
7771 // indeed free. There is however one additional complication:
7772 // blocks that have been allocated since the final checkpoint and
7773 // mark, will not have been marked and so would be treated as
7774 // unreachable and swept up. To prevent this, the allocator marks
7775 // the bit map when allocating during the sweep phase. This leads,
7776 // however, to a further complication -- objects may have been allocated
7777 // but not yet initialized -- in the sense that the header isn't yet
7778 // installed. The sweeper can not then determine the size of the block
7779 // in order to skip over it. To deal with this case, we use a technique
7780 // (due to Printezis) to encode such uninitialized block sizes in the
7781 // bit map. Since the bit map uses a bit per every HeapWord, but the
7782 // CMS generation has a minimum object size of 3 HeapWords, it follows
7783 // that "normal marks" won't be adjacent in the bit map (there will
7784 // always be at least two 0 bits between successive 1 bits). We make use
7785 // of these "unused" bits to represent uninitialized blocks -- the bit
7786 // corresponding to the start of the uninitialized object and the next
7787 // bit are both set. Finally, a 1 bit marks the end of the object that
7788 // started with the two consecutive 1 bits to indicate its potentially
7789 // uninitialized state.
7790 
7791 size_t SweepClosure::do_blk_careful(HeapWord* addr) {
7792   FreeChunk* fc = (FreeChunk*)addr;
7793   size_t res;
7794 
7795   // check if we are done sweepinrg
7796   if (addr == _limit) { // we have swept up to the limit, do nothing more
7797     assert(_limit >= _sp->bottom() && _limit <= _sp->end(),
7798            "sweep _limit out of bounds");
7799     // help the closure application finish
7800     return pointer_delta(_sp->end(), _limit);
7801   }
7802   assert(addr <= _limit, "sweep invariant");
7803 
7804   // check if we should yield
7805   do_yield_check(addr);
7806   if (fc->isFree()) {
7807     // Chunk that is already free
7808     res = fc->size();
7809     doAlreadyFreeChunk(fc);
7810     debug_only(_sp->verifyFreeLists());
7811     assert(res == fc->size(), "Don't expect the size to change");
7812     NOT_PRODUCT(
7813       _numObjectsAlreadyFree++;
7814       _numWordsAlreadyFree += res;
7815     )
7816     NOT_PRODUCT(_last_fc = fc;)
7817   } else if (!_bitMap->isMarked(addr)) {
7818     // Chunk is fresh garbage
7819     res = doGarbageChunk(fc);
7820     debug_only(_sp->verifyFreeLists());
7821     NOT_PRODUCT(
7822       _numObjectsFreed++;
7823       _numWordsFreed += res;
7824     )
7825   } else {
7826     // Chunk that is alive.
7827     res = doLiveChunk(fc);
7828     debug_only(_sp->verifyFreeLists());
7829     NOT_PRODUCT(
7830         _numObjectsLive++;
7831         _numWordsLive += res;
7832     )
7833   }
7834   return res;
7835 }
7836 
7837 // For the smart allocation, record following
7838 //  split deaths - a free chunk is removed from its free list because
7839 //      it is being split into two or more chunks.
7840 //  split birth - a free chunk is being added to its free list because
7841 //      a larger free chunk has been split and resulted in this free chunk.
7842 //  coal death - a free chunk is being removed from its free list because
7843 //      it is being coalesced into a large free chunk.
7844 //  coal birth - a free chunk is being added to its free list because
7845 //      it was created when two or more free chunks where coalesced into
7846 //      this free chunk.
7847 //
7848 // These statistics are used to determine the desired number of free
7849 // chunks of a given size.  The desired number is chosen to be relative
7850 // to the end of a CMS sweep.  The desired number at the end of a sweep
7851 // is the
7852 //      count-at-end-of-previous-sweep (an amount that was enough)
7853 //              - count-at-beginning-of-current-sweep  (the excess)
7854 //              + split-births  (gains in this size during interval)
7855 //              - split-deaths  (demands on this size during interval)
7856 // where the interval is from the end of one sweep to the end of the
7857 // next.
7858 //
7859 // When sweeping the sweeper maintains an accumulated chunk which is
7860 // the chunk that is made up of chunks that have been coalesced.  That
7861 // will be termed the left-hand chunk.  A new chunk of garbage that
7862 // is being considered for coalescing will be referred to as the
7863 // right-hand chunk.
7864 //
7865 // When making a decision on whether to coalesce a right-hand chunk with
7866 // the current left-hand chunk, the current count vs. the desired count
7867 // of the left-hand chunk is considered.  Also if the right-hand chunk
7868 // is near the large chunk at the end of the heap (see
7869 // ConcurrentMarkSweepGeneration::isNearLargestChunk()), then the
7870 // left-hand chunk is coalesced.
7871 //
7872 // When making a decision about whether to split a chunk, the desired count
7873 // vs. the current count of the candidate to be split is also considered.
7874 // If the candidate is underpopulated (currently fewer chunks than desired)
7875 // a chunk of an overpopulated (currently more chunks than desired) size may
7876 // be chosen.  The "hint" associated with a free list, if non-null, points
7877 // to a free list which may be overpopulated.
7878 //
7879 
7880 void SweepClosure::doAlreadyFreeChunk(FreeChunk* fc) {
7881   size_t size = fc->size();
7882   // Chunks that cannot be coalesced are not in the
7883   // free lists.
7884   if (CMSTestInFreeList && !fc->cantCoalesce()) {
7885     assert(_sp->verifyChunkInFreeLists(fc),
7886       "free chunk should be in free lists");
7887   }
7888   // a chunk that is already free, should not have been
7889   // marked in the bit map
7890   HeapWord* addr = (HeapWord*) fc;
7891   assert(!_bitMap->isMarked(addr), "free chunk should be unmarked");
7892   // Verify that the bit map has no bits marked between
7893   // addr and purported end of this block.
7894   _bitMap->verifyNoOneBitsInRange(addr + 1, addr + size);
7895 
7896   // Some chunks cannot be coalesced in under any circumstances.
7897   // See the definition of cantCoalesce().
7898   if (!fc->cantCoalesce()) {
7899     // This chunk can potentially be coalesced.
7900     if (_sp->adaptive_freelists()) {
7901       // All the work is done in
7902       doPostIsFreeOrGarbageChunk(fc, size);
7903     } else {  // Not adaptive free lists
7904       // this is a free chunk that can potentially be coalesced by the sweeper;
7905       if (!inFreeRange()) {
7906         // if the next chunk is a free block that can't be coalesced
7907         // it doesn't make sense to remove this chunk from the free lists
7908         FreeChunk* nextChunk = (FreeChunk*)(addr + size);
7909         assert((HeapWord*)nextChunk <= _limit, "sweep invariant");
7910         if ((HeapWord*)nextChunk < _limit  &&    // there's a next chunk...
7911             nextChunk->isFree()    &&            // which is free...
7912             nextChunk->cantCoalesce()) {         // ... but cant be coalesced
7913           // nothing to do
7914         } else {
7915           // Potentially the start of a new free range:
7916           // Don't eagerly remove it from the free lists.
7917           // No need to remove it if it will just be put
7918           // back again.  (Also from a pragmatic point of view
7919           // if it is a free block in a region that is beyond
7920           // any allocated blocks, an assertion will fail)
7921           // Remember the start of a free run.
7922           initialize_free_range(addr, true);
7923           // end - can coalesce with next chunk
7924         }
7925       } else {
7926         // the midst of a free range, we are coalescing
7927         debug_only(record_free_block_coalesced(fc);)
7928         if (CMSTraceSweeper) {
7929           gclog_or_tty->print("  -- pick up free block 0x%x (%d)\n", fc, size);
7930         }
7931         // remove it from the free lists
7932         _sp->removeFreeChunkFromFreeLists(fc);
7933         set_lastFreeRangeCoalesced(true);
7934         // If the chunk is being coalesced and the current free range is
7935         // in the free lists, remove the current free range so that it
7936         // will be returned to the free lists in its entirety - all
7937         // the coalesced pieces included.
7938         if (freeRangeInFreeLists()) {
7939           FreeChunk* ffc = (FreeChunk*) freeFinger();
7940           assert(ffc->size() == pointer_delta(addr, freeFinger()),
7941             "Size of free range is inconsistent with chunk size.");
7942           if (CMSTestInFreeList) {
7943             assert(_sp->verifyChunkInFreeLists(ffc),
7944               "free range is not in free lists");
7945           }
7946           _sp->removeFreeChunkFromFreeLists(ffc);
7947           set_freeRangeInFreeLists(false);
7948         }
7949       }
7950     }
7951   } else {
7952     // Code path common to both original and adaptive free lists.
7953 
7954     // cant coalesce with previous block; this should be treated
7955     // as the end of a free run if any
7956     if (inFreeRange()) {
7957       // we kicked some butt; time to pick up the garbage
7958       assert(freeFinger() < addr, "the finger pointeth off base");
7959       flushCurFreeChunk(freeFinger(), pointer_delta(addr, freeFinger()));
7960     }
7961     // else, nothing to do, just continue
7962   }
7963 }
7964 
7965 size_t SweepClosure::doGarbageChunk(FreeChunk* fc) {
7966   // This is a chunk of garbage.  It is not in any free list.
7967   // Add it to a free list or let it possibly be coalesced into
7968   // a larger chunk.
7969   HeapWord* addr = (HeapWord*) fc;
7970   size_t size = CompactibleFreeListSpace::adjustObjectSize(oop(addr)->size());
7971 
7972   if (_sp->adaptive_freelists()) {
7973     // Verify that the bit map has no bits marked between
7974     // addr and purported end of just dead object.
7975     _bitMap->verifyNoOneBitsInRange(addr + 1, addr + size);
7976 
7977     doPostIsFreeOrGarbageChunk(fc, size);
7978   } else {
7979     if (!inFreeRange()) {
7980       // start of a new free range
7981       assert(size > 0, "A free range should have a size");
7982       initialize_free_range(addr, false);
7983 
7984     } else {
7985       // this will be swept up when we hit the end of the
7986       // free range
7987       if (CMSTraceSweeper) {
7988         gclog_or_tty->print("  -- pick up garbage 0x%x (%d) \n", fc, size);
7989       }
7990       // If the chunk is being coalesced and the current free range is
7991       // in the free lists, remove the current free range so that it
7992       // will be returned to the free lists in its entirety - all
7993       // the coalesced pieces included.
7994       if (freeRangeInFreeLists()) {
7995         FreeChunk* ffc = (FreeChunk*)freeFinger();
7996         assert(ffc->size() == pointer_delta(addr, freeFinger()),
7997           "Size of free range is inconsistent with chunk size.");
7998         if (CMSTestInFreeList) {
7999           assert(_sp->verifyChunkInFreeLists(ffc),
8000             "free range is not in free lists");
8001         }
8002         _sp->removeFreeChunkFromFreeLists(ffc);
8003         set_freeRangeInFreeLists(false);
8004       }
8005       set_lastFreeRangeCoalesced(true);
8006     }
8007     // this will be swept up when we hit the end of the free range
8008 
8009     // Verify that the bit map has no bits marked between
8010     // addr and purported end of just dead object.
8011     _bitMap->verifyNoOneBitsInRange(addr + 1, addr + size);
8012   }
8013   return size;
8014 }
8015 
8016 size_t SweepClosure::doLiveChunk(FreeChunk* fc) {
8017   HeapWord* addr = (HeapWord*) fc;
8018   // The sweeper has just found a live object. Return any accumulated
8019   // left hand chunk to the free lists.
8020   if (inFreeRange()) {
8021     if (_sp->adaptive_freelists()) {
8022       flushCurFreeChunk(freeFinger(),
8023                         pointer_delta(addr, freeFinger()));
8024     } else { // not adaptive freelists
8025       set_inFreeRange(false);
8026       // Add the free range back to the free list if it is not already
8027       // there.
8028       if (!freeRangeInFreeLists()) {
8029         assert(freeFinger() < addr, "the finger pointeth off base");
8030         if (CMSTraceSweeper) {
8031           gclog_or_tty->print("Sweep:put_free_blk 0x%x (%d) "
8032             "[coalesced:%d]\n",
8033             freeFinger(), pointer_delta(addr, freeFinger()),
8034             lastFreeRangeCoalesced());
8035         }
8036         _sp->addChunkAndRepairOffsetTable(freeFinger(),
8037           pointer_delta(addr, freeFinger()), lastFreeRangeCoalesced());
8038       }
8039     }
8040   }
8041 
8042   // Common code path for original and adaptive free lists.
8043 
8044   // this object is live: we'd normally expect this to be
8045   // an oop, and like to assert the following:
8046   // assert(oop(addr)->is_oop(), "live block should be an oop");
8047   // However, as we commented above, this may be an object whose
8048   // header hasn't yet been initialized.
8049   size_t size;
8050   assert(_bitMap->isMarked(addr), "Tautology for this control point");
8051   if (_bitMap->isMarked(addr + 1)) {
8052     // Determine the size from the bit map, rather than trying to
8053     // compute it from the object header.
8054     HeapWord* nextOneAddr = _bitMap->getNextMarkedWordAddress(addr + 2);
8055     size = pointer_delta(nextOneAddr + 1, addr);
8056     assert(size == CompactibleFreeListSpace::adjustObjectSize(size),
8057            "alignment problem");
8058 
8059     #ifdef DEBUG
8060       if (oop(addr)->klass_or_null() != NULL &&
8061           (   !_collector->should_unload_classes()
8062            || oop(addr)->is_parsable())) {
8063         // Ignore mark word because we are running concurrent with mutators
8064         assert(oop(addr)->is_oop(true), "live block should be an oop");
8065         assert(size ==
8066                CompactibleFreeListSpace::adjustObjectSize(oop(addr)->size()),
8067                "P-mark and computed size do not agree");
8068       }
8069     #endif
8070 
8071   } else {
8072     // This should be an initialized object that's alive.
8073     assert(oop(addr)->klass_or_null() != NULL &&
8074            (!_collector->should_unload_classes()
8075             || oop(addr)->is_parsable()),
8076            "Should be an initialized object");
8077     // Ignore mark word because we are running concurrent with mutators
8078     assert(oop(addr)->is_oop(true), "live block should be an oop");
8079     // Verify that the bit map has no bits marked between
8080     // addr and purported end of this block.
8081     size = CompactibleFreeListSpace::adjustObjectSize(oop(addr)->size());
8082     assert(size >= 3, "Necessary for Printezis marks to work");
8083     assert(!_bitMap->isMarked(addr+1), "Tautology for this control point");
8084     DEBUG_ONLY(_bitMap->verifyNoOneBitsInRange(addr+2, addr+size);)
8085   }
8086   return size;
8087 }
8088 
8089 void SweepClosure::doPostIsFreeOrGarbageChunk(FreeChunk* fc,
8090                                             size_t chunkSize) {
8091   // doPostIsFreeOrGarbageChunk() should only be called in the smart allocation
8092   // scheme.
8093   bool fcInFreeLists = fc->isFree();
8094   assert(_sp->adaptive_freelists(), "Should only be used in this case.");
8095   assert((HeapWord*)fc <= _limit, "sweep invariant");
8096   if (CMSTestInFreeList && fcInFreeLists) {
8097     assert(_sp->verifyChunkInFreeLists(fc),
8098       "free chunk is not in free lists");
8099   }
8100 
8101 
8102   if (CMSTraceSweeper) {
8103     gclog_or_tty->print_cr("  -- pick up another chunk at 0x%x (%d)", fc, chunkSize);
8104   }
8105 
8106   HeapWord* addr = (HeapWord*) fc;
8107 
8108   bool coalesce;
8109   size_t left  = pointer_delta(addr, freeFinger());
8110   size_t right = chunkSize;
8111   switch (FLSCoalescePolicy) {
8112     // numeric value forms a coalition aggressiveness metric
8113     case 0:  { // never coalesce
8114       coalesce = false;
8115       break;
8116     }
8117     case 1: { // coalesce if left & right chunks on overpopulated lists
8118       coalesce = _sp->coalOverPopulated(left) &&
8119                  _sp->coalOverPopulated(right);
8120       break;
8121     }
8122     case 2: { // coalesce if left chunk on overpopulated list (default)
8123       coalesce = _sp->coalOverPopulated(left);
8124       break;
8125     }
8126     case 3: { // coalesce if left OR right chunk on overpopulated list
8127       coalesce = _sp->coalOverPopulated(left) ||
8128                  _sp->coalOverPopulated(right);
8129       break;
8130     }
8131     case 4: { // always coalesce
8132       coalesce = true;
8133       break;
8134     }
8135     default:
8136      ShouldNotReachHere();
8137   }
8138 
8139   // Should the current free range be coalesced?
8140   // If the chunk is in a free range and either we decided to coalesce above
8141   // or the chunk is near the large block at the end of the heap
8142   // (isNearLargestChunk() returns true), then coalesce this chunk.
8143   bool doCoalesce = inFreeRange() &&
8144     (coalesce || _g->isNearLargestChunk((HeapWord*)fc));
8145   if (doCoalesce) {
8146     // Coalesce the current free range on the left with the new
8147     // chunk on the right.  If either is on a free list,
8148     // it must be removed from the list and stashed in the closure.
8149     if (freeRangeInFreeLists()) {
8150       FreeChunk* ffc = (FreeChunk*)freeFinger();
8151       assert(ffc->size() == pointer_delta(addr, freeFinger()),
8152         "Size of free range is inconsistent with chunk size.");
8153       if (CMSTestInFreeList) {
8154         assert(_sp->verifyChunkInFreeLists(ffc),
8155           "Chunk is not in free lists");
8156       }
8157       _sp->coalDeath(ffc->size());
8158       _sp->removeFreeChunkFromFreeLists(ffc);
8159       set_freeRangeInFreeLists(false);
8160     }
8161     if (fcInFreeLists) {
8162       _sp->coalDeath(chunkSize);
8163       assert(fc->size() == chunkSize,
8164         "The chunk has the wrong size or is not in the free lists");
8165       _sp->removeFreeChunkFromFreeLists(fc);
8166     }
8167     set_lastFreeRangeCoalesced(true);
8168   } else {  // not in a free range and/or should not coalesce
8169     // Return the current free range and start a new one.
8170     if (inFreeRange()) {
8171       // In a free range but cannot coalesce with the right hand chunk.
8172       // Put the current free range into the free lists.
8173       flushCurFreeChunk(freeFinger(),
8174         pointer_delta(addr, freeFinger()));
8175     }
8176     // Set up for new free range.  Pass along whether the right hand
8177     // chunk is in the free lists.
8178     initialize_free_range((HeapWord*)fc, fcInFreeLists);
8179   }
8180 }
8181 void SweepClosure::flushCurFreeChunk(HeapWord* chunk, size_t size) {
8182   assert(inFreeRange(), "Should only be called if currently in a free range.");
8183   assert(size > 0,
8184     "A zero sized chunk cannot be added to the free lists.");
8185   if (!freeRangeInFreeLists()) {
8186     if(CMSTestInFreeList) {
8187       FreeChunk* fc = (FreeChunk*) chunk;
8188       fc->setSize(size);
8189       assert(!_sp->verifyChunkInFreeLists(fc),
8190         "chunk should not be in free lists yet");
8191     }
8192     if (CMSTraceSweeper) {
8193       gclog_or_tty->print_cr(" -- add free block 0x%x (%d) to free lists",
8194                     chunk, size);
8195     }
8196     // A new free range is going to be starting.  The current
8197     // free range has not been added to the free lists yet or
8198     // was removed so add it back.
8199     // If the current free range was coalesced, then the death
8200     // of the free range was recorded.  Record a birth now.
8201     if (lastFreeRangeCoalesced()) {
8202       _sp->coalBirth(size);
8203     }
8204     _sp->addChunkAndRepairOffsetTable(chunk, size,
8205             lastFreeRangeCoalesced());
8206   }
8207   set_inFreeRange(false);
8208   set_freeRangeInFreeLists(false);
8209 }
8210 
8211 // We take a break if we've been at this for a while,
8212 // so as to avoid monopolizing the locks involved.
8213 void SweepClosure::do_yield_work(HeapWord* addr) {
8214   // Return current free chunk being used for coalescing (if any)
8215   // to the appropriate freelist.  After yielding, the next
8216   // free block encountered will start a coalescing range of
8217   // free blocks.  If the next free block is adjacent to the
8218   // chunk just flushed, they will need to wait for the next
8219   // sweep to be coalesced.
8220   if (inFreeRange()) {
8221     flushCurFreeChunk(freeFinger(), pointer_delta(addr, freeFinger()));
8222   }
8223 
8224   // First give up the locks, then yield, then re-lock.
8225   // We should probably use a constructor/destructor idiom to
8226   // do this unlock/lock or modify the MutexUnlocker class to
8227   // serve our purpose. XXX
8228   assert_lock_strong(_bitMap->lock());
8229   assert_lock_strong(_freelistLock);
8230   assert(ConcurrentMarkSweepThread::cms_thread_has_cms_token(),
8231          "CMS thread should hold CMS token");
8232   _bitMap->lock()->unlock();
8233   _freelistLock->unlock();
8234   ConcurrentMarkSweepThread::desynchronize(true);
8235   ConcurrentMarkSweepThread::acknowledge_yield_request();
8236   _collector->stopTimer();
8237   GCPauseTimer p(_collector->size_policy()->concurrent_timer_ptr());
8238   if (PrintCMSStatistics != 0) {
8239     _collector->incrementYields();
8240   }
8241   _collector->icms_wait();
8242 
8243   // See the comment in coordinator_yield()
8244   for (unsigned i = 0; i < CMSYieldSleepCount &&
8245                        ConcurrentMarkSweepThread::should_yield() &&
8246                        !CMSCollector::foregroundGCIsActive(); ++i) {
8247     os::sleep(Thread::current(), 1, false);
8248     ConcurrentMarkSweepThread::acknowledge_yield_request();
8249   }
8250 
8251   ConcurrentMarkSweepThread::synchronize(true);
8252   _freelistLock->lock();
8253   _bitMap->lock()->lock_without_safepoint_check();
8254   _collector->startTimer();
8255 }
8256 
8257 #ifndef PRODUCT
8258 // This is actually very useful in a product build if it can
8259 // be called from the debugger.  Compile it into the product
8260 // as needed.
8261 bool debug_verifyChunkInFreeLists(FreeChunk* fc) {
8262   return debug_cms_space->verifyChunkInFreeLists(fc);
8263 }
8264 
8265 void SweepClosure::record_free_block_coalesced(FreeChunk* fc) const {
8266   if (CMSTraceSweeper) {
8267     gclog_or_tty->print("Sweep:coal_free_blk 0x%x (%d)\n", fc, fc->size());
8268   }
8269 }
8270 #endif
8271 
8272 // CMSIsAliveClosure
8273 bool CMSIsAliveClosure::do_object_b(oop obj) {
8274   HeapWord* addr = (HeapWord*)obj;
8275   return addr != NULL &&
8276          (!_span.contains(addr) || _bit_map->isMarked(addr));
8277 }
8278 
8279 // CMSKeepAliveClosure: the serial version
8280 void CMSKeepAliveClosure::do_oop(oop obj) {
8281   HeapWord* addr = (HeapWord*)obj;
8282   if (_span.contains(addr) &&
8283       !_bit_map->isMarked(addr)) {
8284     _bit_map->mark(addr);
8285     bool simulate_overflow = false;
8286     NOT_PRODUCT(
8287       if (CMSMarkStackOverflowALot &&
8288           _collector->simulate_overflow()) {
8289         // simulate a stack overflow
8290         simulate_overflow = true;
8291       }
8292     )
8293     if (simulate_overflow || !_mark_stack->push(obj)) {
8294       _collector->push_on_overflow_list(obj);
8295       _collector->_ser_kac_ovflw++;
8296     }
8297   }
8298 }
8299 
8300 void CMSKeepAliveClosure::do_oop(oop* p)       { CMSKeepAliveClosure::do_oop_work(p); }
8301 void CMSKeepAliveClosure::do_oop(narrowOop* p) { CMSKeepAliveClosure::do_oop_work(p); }
8302 
8303 // CMSParKeepAliveClosure: a parallel version of the above.
8304 // The work queues are private to each closure (thread),
8305 // but (may be) available for stealing by other threads.
8306 void CMSParKeepAliveClosure::do_oop(oop obj) {
8307   HeapWord* addr = (HeapWord*)obj;
8308   if (_span.contains(addr) &&
8309       !_bit_map->isMarked(addr)) {
8310     // In general, during recursive tracing, several threads
8311     // may be concurrently getting here; the first one to
8312     // "tag" it, claims it.
8313     if (_bit_map->par_mark(addr)) {
8314       bool res = _work_queue->push(obj);
8315       assert(res, "Low water mark should be much less than capacity");
8316       // Do a recursive trim in the hope that this will keep
8317       // stack usage lower, but leave some oops for potential stealers
8318       trim_queue(_low_water_mark);
8319     } // Else, another thread got there first
8320   }
8321 }
8322 
8323 void CMSParKeepAliveClosure::do_oop(oop* p)       { CMSParKeepAliveClosure::do_oop_work(p); }
8324 void CMSParKeepAliveClosure::do_oop(narrowOop* p) { CMSParKeepAliveClosure::do_oop_work(p); }
8325 
8326 void CMSParKeepAliveClosure::trim_queue(uint max) {
8327   while (_work_queue->size() > max) {
8328     oop new_oop;
8329     if (_work_queue->pop_local(new_oop)) {
8330       assert(new_oop != NULL && new_oop->is_oop(), "Expected an oop");
8331       assert(_bit_map->isMarked((HeapWord*)new_oop),
8332              "no white objects on this stack!");
8333       assert(_span.contains((HeapWord*)new_oop), "Out of bounds oop");
8334       // iterate over the oops in this oop, marking and pushing
8335       // the ones in CMS heap (i.e. in _span).
8336       new_oop->oop_iterate(&_mark_and_push);
8337     }
8338   }
8339 }
8340 
8341 void CMSInnerParMarkAndPushClosure::do_oop(oop obj) {
8342   HeapWord* addr = (HeapWord*)obj;
8343   if (_span.contains(addr) &&
8344       !_bit_map->isMarked(addr)) {
8345     if (_bit_map->par_mark(addr)) {
8346       bool simulate_overflow = false;
8347       NOT_PRODUCT(
8348         if (CMSMarkStackOverflowALot &&
8349             _collector->par_simulate_overflow()) {
8350           // simulate a stack overflow
8351           simulate_overflow = true;
8352         }
8353       )
8354       if (simulate_overflow || !_work_queue->push(obj)) {
8355         _collector->par_push_on_overflow_list(obj);
8356         _collector->_par_kac_ovflw++;
8357       }
8358     } // Else another thread got there already
8359   }
8360 }
8361 
8362 void CMSInnerParMarkAndPushClosure::do_oop(oop* p)       { CMSInnerParMarkAndPushClosure::do_oop_work(p); }
8363 void CMSInnerParMarkAndPushClosure::do_oop(narrowOop* p) { CMSInnerParMarkAndPushClosure::do_oop_work(p); }
8364 
8365 //////////////////////////////////////////////////////////////////
8366 //  CMSExpansionCause                /////////////////////////////
8367 //////////////////////////////////////////////////////////////////
8368 const char* CMSExpansionCause::to_string(CMSExpansionCause::Cause cause) {
8369   switch (cause) {
8370     case _no_expansion:
8371       return "No expansion";
8372     case _satisfy_free_ratio:
8373       return "Free ratio";
8374     case _satisfy_promotion:
8375       return "Satisfy promotion";
8376     case _satisfy_allocation:
8377       return "allocation";
8378     case _allocate_par_lab:
8379       return "Par LAB";
8380     case _allocate_par_spooling_space:
8381       return "Par Spooling Space";
8382     case _adaptive_size_policy:
8383       return "Ergonomics";
8384     default:
8385       return "unknown";
8386   }
8387 }
8388 
8389 void CMSDrainMarkingStackClosure::do_void() {
8390   // the max number to take from overflow list at a time
8391   const size_t num = _mark_stack->capacity()/4;
8392   while (!_mark_stack->isEmpty() ||
8393          // if stack is empty, check the overflow list
8394          _collector->take_from_overflow_list(num, _mark_stack)) {
8395     oop obj = _mark_stack->pop();
8396     HeapWord* addr = (HeapWord*)obj;
8397     assert(_span.contains(addr), "Should be within span");
8398     assert(_bit_map->isMarked(addr), "Should be marked");
8399     assert(obj->is_oop(), "Should be an oop");
8400     obj->oop_iterate(_keep_alive);
8401   }
8402 }
8403 
8404 void CMSParDrainMarkingStackClosure::do_void() {
8405   // drain queue
8406   trim_queue(0);
8407 }
8408 
8409 // Trim our work_queue so its length is below max at return
8410 void CMSParDrainMarkingStackClosure::trim_queue(uint max) {
8411   while (_work_queue->size() > max) {
8412     oop new_oop;
8413     if (_work_queue->pop_local(new_oop)) {
8414       assert(new_oop->is_oop(), "Expected an oop");
8415       assert(_bit_map->isMarked((HeapWord*)new_oop),
8416              "no white objects on this stack!");
8417       assert(_span.contains((HeapWord*)new_oop), "Out of bounds oop");
8418       // iterate over the oops in this oop, marking and pushing
8419       // the ones in CMS heap (i.e. in _span).
8420       new_oop->oop_iterate(&_mark_and_push);
8421     }
8422   }
8423 }
8424 
8425 ////////////////////////////////////////////////////////////////////
8426 // Support for Marking Stack Overflow list handling and related code
8427 ////////////////////////////////////////////////////////////////////
8428 // Much of the following code is similar in shape and spirit to the
8429 // code used in ParNewGC. We should try and share that code
8430 // as much as possible in the future.
8431 
8432 #ifndef PRODUCT
8433 // Debugging support for CMSStackOverflowALot
8434 
8435 // It's OK to call this multi-threaded;  the worst thing
8436 // that can happen is that we'll get a bunch of closely
8437 // spaced simulated oveflows, but that's OK, in fact
8438 // probably good as it would exercise the overflow code
8439 // under contention.
8440 bool CMSCollector::simulate_overflow() {
8441   if (_overflow_counter-- <= 0) { // just being defensive
8442     _overflow_counter = CMSMarkStackOverflowInterval;
8443     return true;
8444   } else {
8445     return false;
8446   }
8447 }
8448 
8449 bool CMSCollector::par_simulate_overflow() {
8450   return simulate_overflow();
8451 }
8452 #endif
8453 
8454 // Single-threaded
8455 bool CMSCollector::take_from_overflow_list(size_t num, CMSMarkStack* stack) {
8456   assert(stack->isEmpty(), "Expected precondition");
8457   assert(stack->capacity() > num, "Shouldn't bite more than can chew");
8458   size_t i = num;
8459   oop  cur = _overflow_list;
8460   const markOop proto = markOopDesc::prototype();
8461   NOT_PRODUCT(size_t n = 0;)
8462   for (oop next; i > 0 && cur != NULL; cur = next, i--) {
8463     next = oop(cur->mark());
8464     cur->set_mark(proto);   // until proven otherwise
8465     assert(cur->is_oop(), "Should be an oop");
8466     bool res = stack->push(cur);
8467     assert(res, "Bit off more than can chew?");
8468     NOT_PRODUCT(n++;)
8469   }
8470   _overflow_list = cur;
8471 #ifndef PRODUCT
8472   assert(_num_par_pushes >= n, "Too many pops?");
8473   _num_par_pushes -=n;
8474 #endif
8475   return !stack->isEmpty();
8476 }
8477 
8478 // Multi-threaded; use CAS to break off a prefix
8479 bool CMSCollector::par_take_from_overflow_list(size_t num,
8480                                                OopTaskQueue* work_q) {
8481   assert(work_q->size() == 0, "That's the current policy");
8482   assert(num < work_q->max_elems(), "Can't bite more than we can chew");
8483   if (_overflow_list == NULL) {
8484     return false;
8485   }
8486   // Grab the entire list; we'll put back a suffix
8487   oop prefix = (oop)Atomic::xchg_ptr(NULL, &_overflow_list);
8488   if (prefix == NULL) {  // someone grabbed it before we did ...
8489     // ... we could spin for a short while, but for now we don't
8490     return false;
8491   }
8492   size_t i = num;
8493   oop cur = prefix;
8494   for (; i > 1 && cur->mark() != NULL; cur = oop(cur->mark()), i--);
8495   if (cur->mark() != NULL) {
8496     oop suffix_head = cur->mark(); // suffix will be put back on global list
8497     cur->set_mark(NULL);           // break off suffix
8498     // Find tail of suffix so we can prepend suffix to global list
8499     for (cur = suffix_head; cur->mark() != NULL; cur = (oop)(cur->mark()));
8500     oop suffix_tail = cur;
8501     assert(suffix_tail != NULL && suffix_tail->mark() == NULL,
8502            "Tautology");
8503     oop observed_overflow_list = _overflow_list;
8504     do {
8505       cur = observed_overflow_list;
8506       suffix_tail->set_mark(markOop(cur));
8507       observed_overflow_list =
8508         (oop) Atomic::cmpxchg_ptr(suffix_head, &_overflow_list, cur);
8509     } while (cur != observed_overflow_list);
8510   }
8511 
8512   // Push the prefix elements on work_q
8513   assert(prefix != NULL, "control point invariant");
8514   const markOop proto = markOopDesc::prototype();
8515   oop next;
8516   NOT_PRODUCT(size_t n = 0;)
8517   for (cur = prefix; cur != NULL; cur = next) {
8518     next = oop(cur->mark());
8519     cur->set_mark(proto);   // until proven otherwise
8520     assert(cur->is_oop(), "Should be an oop");
8521     bool res = work_q->push(cur);
8522     assert(res, "Bit off more than we can chew?");
8523     NOT_PRODUCT(n++;)
8524   }
8525 #ifndef PRODUCT
8526   assert(_num_par_pushes >= n, "Too many pops?");
8527   Atomic::add_ptr(-(intptr_t)n, &_num_par_pushes);
8528 #endif
8529   return true;
8530 }
8531 
8532 // Single-threaded
8533 void CMSCollector::push_on_overflow_list(oop p) {
8534   NOT_PRODUCT(_num_par_pushes++;)
8535   assert(p->is_oop(), "Not an oop");
8536   preserve_mark_if_necessary(p);
8537   p->set_mark((markOop)_overflow_list);
8538   _overflow_list = p;
8539 }
8540 
8541 // Multi-threaded; use CAS to prepend to overflow list
8542 void CMSCollector::par_push_on_overflow_list(oop p) {
8543   NOT_PRODUCT(Atomic::inc_ptr(&_num_par_pushes);)
8544   assert(p->is_oop(), "Not an oop");
8545   par_preserve_mark_if_necessary(p);
8546   oop observed_overflow_list = _overflow_list;
8547   oop cur_overflow_list;
8548   do {
8549     cur_overflow_list = observed_overflow_list;
8550     p->set_mark(markOop(cur_overflow_list));
8551     observed_overflow_list =
8552       (oop) Atomic::cmpxchg_ptr(p, &_overflow_list, cur_overflow_list);
8553   } while (cur_overflow_list != observed_overflow_list);
8554 }
8555 
8556 // Single threaded
8557 // General Note on GrowableArray: pushes may silently fail
8558 // because we are (temporarily) out of C-heap for expanding
8559 // the stack. The problem is quite ubiquitous and affects
8560 // a lot of code in the JVM. The prudent thing for GrowableArray
8561 // to do (for now) is to exit with an error. However, that may
8562 // be too draconian in some cases because the caller may be
8563 // able to recover without much harm. For suych cases, we
8564 // should probably introduce a "soft_push" method which returns
8565 // an indication of success or failure with the assumption that
8566 // the caller may be able to recover from a failure; code in
8567 // the VM can then be changed, incrementally, to deal with such
8568 // failures where possible, thus, incrementally hardening the VM
8569 // in such low resource situations.
8570 void CMSCollector::preserve_mark_work(oop p, markOop m) {
8571   int PreserveMarkStackSize = 128;
8572 
8573   if (_preserved_oop_stack == NULL) {
8574     assert(_preserved_mark_stack == NULL,
8575            "bijection with preserved_oop_stack");
8576     // Allocate the stacks
8577     _preserved_oop_stack  = new (ResourceObj::C_HEAP)
8578       GrowableArray<oop>(PreserveMarkStackSize, true);
8579     _preserved_mark_stack = new (ResourceObj::C_HEAP)
8580       GrowableArray<markOop>(PreserveMarkStackSize, true);
8581     if (_preserved_oop_stack == NULL || _preserved_mark_stack == NULL) {
8582       vm_exit_out_of_memory(2* PreserveMarkStackSize * sizeof(oop) /* punt */,
8583                             "Preserved Mark/Oop Stack for CMS (C-heap)");
8584     }
8585   }
8586   _preserved_oop_stack->push(p);
8587   _preserved_mark_stack->push(m);
8588   assert(m == p->mark(), "Mark word changed");
8589   assert(_preserved_oop_stack->length() == _preserved_mark_stack->length(),
8590          "bijection");
8591 }
8592 
8593 // Single threaded
8594 void CMSCollector::preserve_mark_if_necessary(oop p) {
8595   markOop m = p->mark();
8596   if (m->must_be_preserved(p)) {
8597     preserve_mark_work(p, m);
8598   }
8599 }
8600 
8601 void CMSCollector::par_preserve_mark_if_necessary(oop p) {
8602   markOop m = p->mark();
8603   if (m->must_be_preserved(p)) {
8604     MutexLockerEx x(ParGCRareEvent_lock, Mutex::_no_safepoint_check_flag);
8605     // Even though we read the mark word without holding
8606     // the lock, we are assured that it will not change
8607     // because we "own" this oop, so no other thread can
8608     // be trying to push it on the overflow list; see
8609     // the assertion in preserve_mark_work() that checks
8610     // that m == p->mark().
8611     preserve_mark_work(p, m);
8612   }
8613 }
8614 
8615 // We should be able to do this multi-threaded,
8616 // a chunk of stack being a task (this is
8617 // correct because each oop only ever appears
8618 // once in the overflow list. However, it's
8619 // not very easy to completely overlap this with
8620 // other operations, so will generally not be done
8621 // until all work's been completed. Because we
8622 // expect the preserved oop stack (set) to be small,
8623 // it's probably fine to do this single-threaded.
8624 // We can explore cleverer concurrent/overlapped/parallel
8625 // processing of preserved marks if we feel the
8626 // need for this in the future. Stack overflow should
8627 // be so rare in practice and, when it happens, its
8628 // effect on performance so great that this will
8629 // likely just be in the noise anyway.
8630 void CMSCollector::restore_preserved_marks_if_any() {
8631   if (_preserved_oop_stack == NULL) {
8632     assert(_preserved_mark_stack == NULL,
8633            "bijection with preserved_oop_stack");
8634     return;
8635   }
8636 
8637   assert(SafepointSynchronize::is_at_safepoint(),
8638          "world should be stopped");
8639   assert(Thread::current()->is_ConcurrentGC_thread() ||
8640          Thread::current()->is_VM_thread(),
8641          "should be single-threaded");
8642 
8643   int length = _preserved_oop_stack->length();
8644   assert(_preserved_mark_stack->length() == length, "bijection");
8645   for (int i = 0; i < length; i++) {
8646     oop p = _preserved_oop_stack->at(i);
8647     assert(p->is_oop(), "Should be an oop");
8648     assert(_span.contains(p), "oop should be in _span");
8649     assert(p->mark() == markOopDesc::prototype(),
8650            "Set when taken from overflow list");
8651     markOop m = _preserved_mark_stack->at(i);
8652     p->set_mark(m);
8653   }
8654   _preserved_mark_stack->clear();
8655   _preserved_oop_stack->clear();
8656   assert(_preserved_mark_stack->is_empty() &&
8657          _preserved_oop_stack->is_empty(),
8658          "stacks were cleared above");
8659 }
8660 
8661 #ifndef PRODUCT
8662 bool CMSCollector::no_preserved_marks() const {
8663   return (   (   _preserved_mark_stack == NULL
8664               && _preserved_oop_stack == NULL)
8665           || (   _preserved_mark_stack->is_empty()
8666               && _preserved_oop_stack->is_empty()));
8667 }
8668 #endif
8669 
8670 CMSAdaptiveSizePolicy* ASConcurrentMarkSweepGeneration::cms_size_policy() const
8671 {
8672   GenCollectedHeap* gch = (GenCollectedHeap*) GenCollectedHeap::heap();
8673   CMSAdaptiveSizePolicy* size_policy =
8674     (CMSAdaptiveSizePolicy*) gch->gen_policy()->size_policy();
8675   assert(size_policy->is_gc_cms_adaptive_size_policy(),
8676     "Wrong type for size policy");
8677   return size_policy;
8678 }
8679 
8680 void ASConcurrentMarkSweepGeneration::resize(size_t cur_promo_size,
8681                                            size_t desired_promo_size) {
8682   if (cur_promo_size < desired_promo_size) {
8683     size_t expand_bytes = desired_promo_size - cur_promo_size;
8684     if (PrintAdaptiveSizePolicy && Verbose) {
8685       gclog_or_tty->print_cr(" ASConcurrentMarkSweepGeneration::resize "
8686         "Expanding tenured generation by " SIZE_FORMAT " (bytes)",
8687         expand_bytes);
8688     }
8689     expand(expand_bytes,
8690            MinHeapDeltaBytes,
8691            CMSExpansionCause::_adaptive_size_policy);
8692   } else if (desired_promo_size < cur_promo_size) {
8693     size_t shrink_bytes = cur_promo_size - desired_promo_size;
8694     if (PrintAdaptiveSizePolicy && Verbose) {
8695       gclog_or_tty->print_cr(" ASConcurrentMarkSweepGeneration::resize "
8696         "Shrinking tenured generation by " SIZE_FORMAT " (bytes)",
8697         shrink_bytes);
8698     }
8699     shrink(shrink_bytes);
8700   }
8701 }
8702 
8703 CMSGCAdaptivePolicyCounters* ASConcurrentMarkSweepGeneration::gc_adaptive_policy_counters() {
8704   GenCollectedHeap* gch = GenCollectedHeap::heap();
8705   CMSGCAdaptivePolicyCounters* counters =
8706     (CMSGCAdaptivePolicyCounters*) gch->collector_policy()->counters();
8707   assert(counters->kind() == GCPolicyCounters::CMSGCAdaptivePolicyCountersKind,
8708     "Wrong kind of counters");
8709   return counters;
8710 }
8711 
8712 
8713 void ASConcurrentMarkSweepGeneration::update_counters() {
8714   if (UsePerfData) {
8715     _space_counters->update_all();
8716     _gen_counters->update_all();
8717     CMSGCAdaptivePolicyCounters* counters = gc_adaptive_policy_counters();
8718     GenCollectedHeap* gch = GenCollectedHeap::heap();
8719     CMSGCStats* gc_stats_l = (CMSGCStats*) gc_stats();
8720     assert(gc_stats_l->kind() == GCStats::CMSGCStatsKind,
8721       "Wrong gc statistics type");
8722     counters->update_counters(gc_stats_l);
8723   }
8724 }
8725 
8726 void ASConcurrentMarkSweepGeneration::update_counters(size_t used) {
8727   if (UsePerfData) {
8728     _space_counters->update_used(used);
8729     _space_counters->update_capacity();
8730     _gen_counters->update_all();
8731 
8732     CMSGCAdaptivePolicyCounters* counters = gc_adaptive_policy_counters();
8733     GenCollectedHeap* gch = GenCollectedHeap::heap();
8734     CMSGCStats* gc_stats_l = (CMSGCStats*) gc_stats();
8735     assert(gc_stats_l->kind() == GCStats::CMSGCStatsKind,
8736       "Wrong gc statistics type");
8737     counters->update_counters(gc_stats_l);
8738   }
8739 }
8740 
8741 // The desired expansion delta is computed so that:
8742 // . desired free percentage or greater is used
8743 void ASConcurrentMarkSweepGeneration::compute_new_size() {
8744   assert_locked_or_safepoint(Heap_lock);
8745 
8746   GenCollectedHeap* gch = (GenCollectedHeap*) GenCollectedHeap::heap();
8747 
8748   // If incremental collection failed, we just want to expand
8749   // to the limit.
8750   if (incremental_collection_failed()) {
8751     clear_incremental_collection_failed();
8752     grow_to_reserved();
8753     return;
8754   }
8755 
8756   assert(UseAdaptiveSizePolicy, "Should be using adaptive sizing");
8757 
8758   assert(gch->kind() == CollectedHeap::GenCollectedHeap,
8759     "Wrong type of heap");
8760   int prev_level = level() - 1;
8761   assert(prev_level >= 0, "The cms generation is the lowest generation");
8762   Generation* prev_gen = gch->get_gen(prev_level);
8763   assert(prev_gen->kind() == Generation::ASParNew,
8764     "Wrong type of young generation");
8765   ParNewGeneration* younger_gen = (ParNewGeneration*) prev_gen;
8766   size_t cur_eden = younger_gen->eden()->capacity();
8767   CMSAdaptiveSizePolicy* size_policy = cms_size_policy();
8768   size_t cur_promo = free();
8769   size_policy->compute_tenured_generation_free_space(cur_promo,
8770                                                        max_available(),
8771                                                        cur_eden);
8772   resize(cur_promo, size_policy->promo_size());
8773 
8774   // Record the new size of the space in the cms generation
8775   // that is available for promotions.  This is temporary.
8776   // It should be the desired promo size.
8777   size_policy->avg_cms_promo()->sample(free());
8778   size_policy->avg_old_live()->sample(used());
8779 
8780   if (UsePerfData) {
8781     CMSGCAdaptivePolicyCounters* counters = gc_adaptive_policy_counters();
8782     counters->update_cms_capacity_counter(capacity());
8783   }
8784 }
8785 
8786 void ASConcurrentMarkSweepGeneration::shrink_by(size_t desired_bytes) {
8787   assert_locked_or_safepoint(Heap_lock);
8788   assert_lock_strong(freelistLock());
8789   HeapWord* old_end = _cmsSpace->end();
8790   HeapWord* unallocated_start = _cmsSpace->unallocated_block();
8791   assert(old_end >= unallocated_start, "Miscalculation of unallocated_start");
8792   FreeChunk* chunk_at_end = find_chunk_at_end();
8793   if (chunk_at_end == NULL) {
8794     // No room to shrink
8795     if (PrintGCDetails && Verbose) {
8796       gclog_or_tty->print_cr("No room to shrink: old_end  "
8797         PTR_FORMAT "  unallocated_start  " PTR_FORMAT
8798         " chunk_at_end  " PTR_FORMAT,
8799         old_end, unallocated_start, chunk_at_end);
8800     }
8801     return;
8802   } else {
8803 
8804     // Find the chunk at the end of the space and determine
8805     // how much it can be shrunk.
8806     size_t shrinkable_size_in_bytes = chunk_at_end->size();
8807     size_t aligned_shrinkable_size_in_bytes =
8808       align_size_down(shrinkable_size_in_bytes, os::vm_page_size());
8809     assert(unallocated_start <= chunk_at_end->end(),
8810       "Inconsistent chunk at end of space");
8811     size_t bytes = MIN2(desired_bytes, aligned_shrinkable_size_in_bytes);
8812     size_t word_size_before = heap_word_size(_virtual_space.committed_size());
8813 
8814     // Shrink the underlying space
8815     _virtual_space.shrink_by(bytes);
8816     if (PrintGCDetails && Verbose) {
8817       gclog_or_tty->print_cr("ConcurrentMarkSweepGeneration::shrink_by:"
8818         " desired_bytes " SIZE_FORMAT
8819         " shrinkable_size_in_bytes " SIZE_FORMAT
8820         " aligned_shrinkable_size_in_bytes " SIZE_FORMAT
8821         "  bytes  " SIZE_FORMAT,
8822         desired_bytes, shrinkable_size_in_bytes,
8823         aligned_shrinkable_size_in_bytes, bytes);
8824       gclog_or_tty->print_cr("          old_end  " SIZE_FORMAT
8825         "  unallocated_start  " SIZE_FORMAT,
8826         old_end, unallocated_start);
8827     }
8828 
8829     // If the space did shrink (shrinking is not guaranteed),
8830     // shrink the chunk at the end by the appropriate amount.
8831     if (((HeapWord*)_virtual_space.high()) < old_end) {
8832       size_t new_word_size =
8833         heap_word_size(_virtual_space.committed_size());
8834 
8835       // Have to remove the chunk from the dictionary because it is changing
8836       // size and might be someplace elsewhere in the dictionary.
8837 
8838       // Get the chunk at end, shrink it, and put it
8839       // back.
8840       _cmsSpace->removeChunkFromDictionary(chunk_at_end);
8841       size_t word_size_change = word_size_before - new_word_size;
8842       size_t chunk_at_end_old_size = chunk_at_end->size();
8843       assert(chunk_at_end_old_size >= word_size_change,
8844         "Shrink is too large");
8845       chunk_at_end->setSize(chunk_at_end_old_size -
8846                           word_size_change);
8847       _cmsSpace->freed((HeapWord*) chunk_at_end->end(),
8848         word_size_change);
8849 
8850       _cmsSpace->returnChunkToDictionary(chunk_at_end);
8851 
8852       MemRegion mr(_cmsSpace->bottom(), new_word_size);
8853       _bts->resize(new_word_size);  // resize the block offset shared array
8854       Universe::heap()->barrier_set()->resize_covered_region(mr);
8855       _cmsSpace->assert_locked();
8856       _cmsSpace->set_end((HeapWord*)_virtual_space.high());
8857 
8858       NOT_PRODUCT(_cmsSpace->dictionary()->verify());
8859 
8860       // update the space and generation capacity counters
8861       if (UsePerfData) {
8862         _space_counters->update_capacity();
8863         _gen_counters->update_all();
8864       }
8865 
8866       if (Verbose && PrintGCDetails) {
8867         size_t new_mem_size = _virtual_space.committed_size();
8868         size_t old_mem_size = new_mem_size + bytes;
8869         gclog_or_tty->print_cr("Shrinking %s from %ldK by %ldK to %ldK",
8870                       name(), old_mem_size/K, bytes/K, new_mem_size/K);
8871       }
8872     }
8873 
8874     assert(_cmsSpace->unallocated_block() <= _cmsSpace->end(),
8875       "Inconsistency at end of space");
8876     assert(chunk_at_end->end() == _cmsSpace->end(),
8877       "Shrinking is inconsistent");
8878     return;
8879   }
8880 }
8881 
8882 // Transfer some number of overflown objects to usual marking
8883 // stack. Return true if some objects were transferred.
8884 bool MarkRefsIntoAndScanClosure::take_from_overflow_list() {
8885   size_t num = MIN2((size_t)_mark_stack->capacity()/4,
8886                     (size_t)ParGCDesiredObjsFromOverflowList);
8887 
8888   bool res = _collector->take_from_overflow_list(num, _mark_stack);
8889   assert(_collector->overflow_list_is_empty() || res,
8890          "If list is not empty, we should have taken something");
8891   assert(!res || !_mark_stack->isEmpty(),
8892          "If we took something, it should now be on our stack");
8893   return res;
8894 }
8895 
8896 size_t MarkDeadObjectsClosure::do_blk(HeapWord* addr) {
8897   size_t res = _sp->block_size_no_stall(addr, _collector);
8898   assert(res != 0, "Should always be able to compute a size");
8899   if (_sp->block_is_obj(addr)) {
8900     if (_live_bit_map->isMarked(addr)) {
8901       // It can't have been dead in a previous cycle
8902       guarantee(!_dead_bit_map->isMarked(addr), "No resurrection!");
8903     } else {
8904       _dead_bit_map->mark(addr);      // mark the dead object
8905     }
8906   }
8907   return res;
8908 }