1 /*
   2  * Copyright (c) 2001, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef SHARE_VM_GC_IMPLEMENTATION_G1_G1COLLECTEDHEAP_HPP
  26 #define SHARE_VM_GC_IMPLEMENTATION_G1_G1COLLECTEDHEAP_HPP
  27 
  28 #include "gc_implementation/g1/g1AllocationContext.hpp"
  29 #include "gc_implementation/g1/g1Allocator.hpp"
  30 #include "gc_implementation/g1/concurrentMark.hpp"
  31 #include "gc_implementation/g1/evacuationInfo.hpp"
  32 #include "gc_implementation/g1/g1AllocRegion.hpp"
  33 #include "gc_implementation/g1/g1BiasedArray.hpp"
  34 #include "gc_implementation/g1/g1HRPrinter.hpp"
  35 #include "gc_implementation/g1/g1InCSetState.hpp"
  36 #include "gc_implementation/g1/g1MonitoringSupport.hpp"
  37 #include "gc_implementation/g1/g1SATBCardTableModRefBS.hpp"
  38 #include "gc_implementation/g1/g1YCTypes.hpp"
  39 #include "gc_implementation/g1/heapRegionManager.hpp"
  40 #include "gc_implementation/g1/heapRegionSet.hpp"
  41 #include "gc_implementation/shared/hSpaceCounters.hpp"
  42 #include "gc_implementation/shared/parGCAllocBuffer.hpp"
  43 #include "memory/barrierSet.hpp"
  44 #include "memory/memRegion.hpp"
  45 #include "memory/sharedHeap.hpp"
  46 #include "utilities/stack.hpp"
  47 
  48 // A "G1CollectedHeap" is an implementation of a java heap for HotSpot.
  49 // It uses the "Garbage First" heap organization and algorithm, which
  50 // may combine concurrent marking with parallel, incremental compaction of
  51 // heap subsets that will yield large amounts of garbage.
  52 
  53 // Forward declarations
  54 class HeapRegion;
  55 class HRRSCleanupTask;
  56 class GenerationSpec;
  57 class OopsInHeapRegionClosure;
  58 class G1KlassScanClosure;
  59 class ObjectClosure;
  60 class SpaceClosure;
  61 class CompactibleSpaceClosure;
  62 class Space;
  63 class G1CollectorPolicy;
  64 class GenRemSet;
  65 class G1RemSet;
  66 class HeapRegionRemSetIterator;
  67 class ConcurrentMark;
  68 class ConcurrentMarkThread;
  69 class ConcurrentG1Refine;
  70 class ConcurrentGCTimer;
  71 class GenerationCounters;
  72 class STWGCTimer;
  73 class G1NewTracer;
  74 class G1OldTracer;
  75 class EvacuationFailedInfo;
  76 class nmethod;
  77 class Ticks;
  78 
  79 typedef OverflowTaskQueue<StarTask, mtGC>         RefToScanQueue;
  80 typedef GenericTaskQueueSet<RefToScanQueue, mtGC> RefToScanQueueSet;
  81 
  82 typedef int RegionIdx_t;   // needs to hold [ 0..max_regions() )
  83 typedef int CardIdx_t;     // needs to hold [ 0..CardsPerRegion )
  84 
  85 class YoungList : public CHeapObj<mtGC> {
  86 private:
  87   G1CollectedHeap* _g1h;
  88 
  89   HeapRegion* _head;
  90 
  91   HeapRegion* _survivor_head;
  92   HeapRegion* _survivor_tail;
  93 
  94   HeapRegion* _curr;
  95 
  96   uint        _length;
  97   uint        _survivor_length;
  98 
  99   size_t      _last_sampled_rs_lengths;
 100   size_t      _sampled_rs_lengths;
 101 
 102   void         empty_list(HeapRegion* list);
 103 
 104 public:
 105   YoungList(G1CollectedHeap* g1h);
 106 
 107   void         push_region(HeapRegion* hr);
 108   void         add_survivor_region(HeapRegion* hr);
 109 
 110   void         empty_list();
 111   bool         is_empty() { return _length == 0; }
 112   uint         length() { return _length; }
 113   uint         survivor_length() { return _survivor_length; }
 114 
 115   // Currently we do not keep track of the used byte sum for the
 116   // young list and the survivors and it'd be quite a lot of work to
 117   // do so. When we'll eventually replace the young list with
 118   // instances of HeapRegionLinkedList we'll get that for free. So,
 119   // we'll report the more accurate information then.
 120   size_t       eden_used_bytes() {
 121     assert(length() >= survivor_length(), "invariant");
 122     return (size_t) (length() - survivor_length()) * HeapRegion::GrainBytes;
 123   }
 124   size_t       survivor_used_bytes() {
 125     return (size_t) survivor_length() * HeapRegion::GrainBytes;
 126   }
 127 
 128   void rs_length_sampling_init();
 129   bool rs_length_sampling_more();
 130   void rs_length_sampling_next();
 131 
 132   void reset_sampled_info() {
 133     _last_sampled_rs_lengths =   0;
 134   }
 135   size_t sampled_rs_lengths() { return _last_sampled_rs_lengths; }
 136 
 137   // for development purposes
 138   void reset_auxilary_lists();
 139   void clear() { _head = NULL; _length = 0; }
 140 
 141   void clear_survivors() {
 142     _survivor_head    = NULL;
 143     _survivor_tail    = NULL;
 144     _survivor_length  = 0;
 145   }
 146 
 147   HeapRegion* first_region() { return _head; }
 148   HeapRegion* first_survivor_region() { return _survivor_head; }
 149   HeapRegion* last_survivor_region() { return _survivor_tail; }
 150 
 151   // debugging
 152   bool          check_list_well_formed();
 153   bool          check_list_empty(bool check_sample = true);
 154   void          print();
 155 };
 156 
 157 // The G1 STW is alive closure.
 158 // An instance is embedded into the G1CH and used as the
 159 // (optional) _is_alive_non_header closure in the STW
 160 // reference processor. It is also extensively used during
 161 // reference processing during STW evacuation pauses.
 162 class G1STWIsAliveClosure: public BoolObjectClosure {
 163   G1CollectedHeap* _g1;
 164 public:
 165   G1STWIsAliveClosure() {}
 166   G1STWIsAliveClosure(G1CollectedHeap* g1) : _g1(g1) {}
 167   bool do_object_b(oop p);
 168 };
 169 
 170 class RefineCardTableEntryClosure;
 171 
 172 class G1RegionMappingChangedListener : public G1MappingChangedListener {
 173  private:
 174   void reset_from_card_cache(uint start_idx, size_t num_regions);
 175  public:
 176   virtual void on_commit(uint start_idx, size_t num_regions, bool zero_filled);
 177 };
 178 
 179 class G1CollectedHeap : public SharedHeap {
 180   friend class VM_CollectForMetadataAllocation;
 181   friend class VM_G1CollectForAllocation;
 182   friend class VM_G1CollectFull;
 183   friend class VM_G1IncCollectionPause;
 184   friend class VMStructs;
 185   friend class MutatorAllocRegion;
 186   friend class SurvivorGCAllocRegion;
 187   friend class OldGCAllocRegion;
 188   friend class G1Allocator;
 189 
 190   // Closures used in implementation.
 191   friend class G1ParScanThreadState;
 192   friend class G1ParTask;
 193   friend class G1ParGCAllocator;
 194   friend class G1PrepareCompactClosure;
 195 
 196   // Other related classes.
 197   friend class HeapRegionClaimer;
 198 
 199   // Testing classes.
 200   friend class G1CheckCSetFastTableClosure;
 201 
 202 private:
 203   // The one and only G1CollectedHeap, so static functions can find it.
 204   static G1CollectedHeap* _g1h;
 205 
 206   static size_t _humongous_object_threshold_in_words;
 207 
 208   // The secondary free list which contains regions that have been
 209   // freed up during the cleanup process. This will be appended to
 210   // the master free list when appropriate.
 211   FreeRegionList _secondary_free_list;
 212 
 213   // It keeps track of the old regions.
 214   HeapRegionSet _old_set;
 215 
 216   // It keeps track of the humongous regions.
 217   HeapRegionSet _humongous_set;
 218 
 219   void clear_humongous_is_live_table();
 220   void eagerly_reclaim_humongous_regions();
 221 
 222   // The number of regions we could create by expansion.
 223   uint _expansion_regions;
 224 
 225   // The block offset table for the G1 heap.
 226   G1BlockOffsetSharedArray* _bot_shared;
 227 
 228   // Tears down the region sets / lists so that they are empty and the
 229   // regions on the heap do not belong to a region set / list. The
 230   // only exception is the humongous set which we leave unaltered. If
 231   // free_list_only is true, it will only tear down the master free
 232   // list. It is called before a Full GC (free_list_only == false) or
 233   // before heap shrinking (free_list_only == true).
 234   void tear_down_region_sets(bool free_list_only);
 235 
 236   // Rebuilds the region sets / lists so that they are repopulated to
 237   // reflect the contents of the heap. The only exception is the
 238   // humongous set which was not torn down in the first place. If
 239   // free_list_only is true, it will only rebuild the master free
 240   // list. It is called after a Full GC (free_list_only == false) or
 241   // after heap shrinking (free_list_only == true).
 242   void rebuild_region_sets(bool free_list_only);
 243 
 244   // Callback for region mapping changed events.
 245   G1RegionMappingChangedListener _listener;
 246 
 247   // The sequence of all heap regions in the heap.
 248   HeapRegionManager _hrm;
 249 
 250   // Class that handles the different kinds of allocations.
 251   G1Allocator* _allocator;
 252 
 253   // Statistics for each allocation context
 254   AllocationContextStats _allocation_context_stats;
 255 
 256   // PLAB sizing policy for survivors.
 257   PLABStats _survivor_plab_stats;
 258 
 259   // PLAB sizing policy for tenured objects.
 260   PLABStats _old_plab_stats;
 261 
 262   // It specifies whether we should attempt to expand the heap after a
 263   // region allocation failure. If heap expansion fails we set this to
 264   // false so that we don't re-attempt the heap expansion (it's likely
 265   // that subsequent expansion attempts will also fail if one fails).
 266   // Currently, it is only consulted during GC and it's reset at the
 267   // start of each GC.
 268   bool _expand_heap_after_alloc_failure;
 269 
 270   // It resets the mutator alloc region before new allocations can take place.
 271   void init_mutator_alloc_region();
 272 
 273   // It releases the mutator alloc region.
 274   void release_mutator_alloc_region();
 275 
 276   // It initializes the GC alloc regions at the start of a GC.
 277   void init_gc_alloc_regions(EvacuationInfo& evacuation_info);
 278 
 279   // It releases the GC alloc regions at the end of a GC.
 280   void release_gc_alloc_regions(uint no_of_gc_workers, EvacuationInfo& evacuation_info);
 281 
 282   // It does any cleanup that needs to be done on the GC alloc regions
 283   // before a Full GC.
 284   void abandon_gc_alloc_regions();
 285 
 286   // Helper for monitoring and management support.
 287   G1MonitoringSupport* _g1mm;
 288 
 289   // Records whether the region at the given index is kept live by roots or
 290   // references from the young generation.
 291   class HumongousIsLiveBiasedMappedArray : public G1BiasedMappedArray<bool> {
 292    protected:
 293     bool default_value() const { return false; }
 294    public:
 295     void clear() { G1BiasedMappedArray<bool>::clear(); }
 296     void set_live(uint region) {
 297       set_by_index(region, true);
 298     }
 299     bool is_live(uint region) {
 300       return get_by_index(region);
 301     }
 302   };
 303 
 304   HumongousIsLiveBiasedMappedArray _humongous_is_live;
 305   // Stores whether during humongous object registration we found candidate regions.
 306   // If not, we can skip a few steps.
 307   bool _has_humongous_reclaim_candidates;
 308 
 309   volatile unsigned _gc_time_stamp;
 310 
 311   size_t* _surviving_young_words;
 312 
 313   G1HRPrinter _hr_printer;
 314 
 315   void setup_surviving_young_words();
 316   void update_surviving_young_words(size_t* surv_young_words);
 317   void cleanup_surviving_young_words();
 318 
 319   // It decides whether an explicit GC should start a concurrent cycle
 320   // instead of doing a STW GC. Currently, a concurrent cycle is
 321   // explicitly started if:
 322   // (a) cause == _gc_locker and +GCLockerInvokesConcurrent, or
 323   // (b) cause == _java_lang_system_gc and +ExplicitGCInvokesConcurrent.
 324   // (c) cause == _g1_humongous_allocation
 325   bool should_do_concurrent_full_gc(GCCause::Cause cause);
 326 
 327   // Keeps track of how many "old marking cycles" (i.e., Full GCs or
 328   // concurrent cycles) we have started.
 329   volatile unsigned int _old_marking_cycles_started;
 330 
 331   // Keeps track of how many "old marking cycles" (i.e., Full GCs or
 332   // concurrent cycles) we have completed.
 333   volatile unsigned int _old_marking_cycles_completed;
 334 
 335   bool _concurrent_cycle_started;
 336   bool _heap_summary_sent;
 337 
 338   // This is a non-product method that is helpful for testing. It is
 339   // called at the end of a GC and artificially expands the heap by
 340   // allocating a number of dead regions. This way we can induce very
 341   // frequent marking cycles and stress the cleanup / concurrent
 342   // cleanup code more (as all the regions that will be allocated by
 343   // this method will be found dead by the marking cycle).
 344   void allocate_dummy_regions() PRODUCT_RETURN;
 345 
 346   // Clear RSets after a compaction. It also resets the GC time stamps.
 347   void clear_rsets_post_compaction();
 348 
 349   // If the HR printer is active, dump the state of the regions in the
 350   // heap after a compaction.
 351   void print_hrm_post_compaction();
 352 
 353   double verify(bool guard, const char* msg);
 354   void verify_before_gc();
 355   void verify_after_gc();
 356 
 357   void log_gc_header();
 358   void log_gc_footer(double pause_time_sec);
 359 
 360   // These are macros so that, if the assert fires, we get the correct
 361   // line number, file, etc.
 362 
 363 #define heap_locking_asserts_err_msg(_extra_message_)                         \
 364   err_msg("%s : Heap_lock locked: %s, at safepoint: %s, is VM thread: %s",    \
 365           (_extra_message_),                                                  \
 366           BOOL_TO_STR(Heap_lock->owned_by_self()),                            \
 367           BOOL_TO_STR(SafepointSynchronize::is_at_safepoint()),               \
 368           BOOL_TO_STR(Thread::current()->is_VM_thread()))
 369 
 370 #define assert_heap_locked()                                                  \
 371   do {                                                                        \
 372     assert(Heap_lock->owned_by_self(),                                        \
 373            heap_locking_asserts_err_msg("should be holding the Heap_lock"));  \
 374   } while (0)
 375 
 376 #define assert_heap_locked_or_at_safepoint(_should_be_vm_thread_)             \
 377   do {                                                                        \
 378     assert(Heap_lock->owned_by_self() ||                                      \
 379            (SafepointSynchronize::is_at_safepoint() &&                        \
 380              ((_should_be_vm_thread_) == Thread::current()->is_VM_thread())), \
 381            heap_locking_asserts_err_msg("should be holding the Heap_lock or " \
 382                                         "should be at a safepoint"));         \
 383   } while (0)
 384 
 385 #define assert_heap_locked_and_not_at_safepoint()                             \
 386   do {                                                                        \
 387     assert(Heap_lock->owned_by_self() &&                                      \
 388                                     !SafepointSynchronize::is_at_safepoint(), \
 389           heap_locking_asserts_err_msg("should be holding the Heap_lock and " \
 390                                        "should not be at a safepoint"));      \
 391   } while (0)
 392 
 393 #define assert_heap_not_locked()                                              \
 394   do {                                                                        \
 395     assert(!Heap_lock->owned_by_self(),                                       \
 396         heap_locking_asserts_err_msg("should not be holding the Heap_lock")); \
 397   } while (0)
 398 
 399 #define assert_heap_not_locked_and_not_at_safepoint()                         \
 400   do {                                                                        \
 401     assert(!Heap_lock->owned_by_self() &&                                     \
 402                                     !SafepointSynchronize::is_at_safepoint(), \
 403       heap_locking_asserts_err_msg("should not be holding the Heap_lock and " \
 404                                    "should not be at a safepoint"));          \
 405   } while (0)
 406 
 407 #define assert_at_safepoint(_should_be_vm_thread_)                            \
 408   do {                                                                        \
 409     assert(SafepointSynchronize::is_at_safepoint() &&                         \
 410               ((_should_be_vm_thread_) == Thread::current()->is_VM_thread()), \
 411            heap_locking_asserts_err_msg("should be at a safepoint"));         \
 412   } while (0)
 413 
 414 #define assert_not_at_safepoint()                                             \
 415   do {                                                                        \
 416     assert(!SafepointSynchronize::is_at_safepoint(),                          \
 417            heap_locking_asserts_err_msg("should not be at a safepoint"));     \
 418   } while (0)
 419 
 420 protected:
 421 
 422   // The young region list.
 423   YoungList*  _young_list;
 424 
 425   // The current policy object for the collector.
 426   G1CollectorPolicy* _g1_policy;
 427 
 428   // This is the second level of trying to allocate a new region. If
 429   // new_region() didn't find a region on the free_list, this call will
 430   // check whether there's anything available on the
 431   // secondary_free_list and/or wait for more regions to appear on
 432   // that list, if _free_regions_coming is set.
 433   HeapRegion* new_region_try_secondary_free_list(bool is_old);
 434 
 435   // Try to allocate a single non-humongous HeapRegion sufficient for
 436   // an allocation of the given word_size. If do_expand is true,
 437   // attempt to expand the heap if necessary to satisfy the allocation
 438   // request. If the region is to be used as an old region or for a
 439   // humongous object, set is_old to true. If not, to false.
 440   HeapRegion* new_region(size_t word_size, bool is_old, bool do_expand);
 441 
 442   // Initialize a contiguous set of free regions of length num_regions
 443   // and starting at index first so that they appear as a single
 444   // humongous region.
 445   HeapWord* humongous_obj_allocate_initialize_regions(uint first,
 446                                                       uint num_regions,
 447                                                       size_t word_size,
 448                                                       AllocationContext_t context);
 449 
 450   // Attempt to allocate a humongous object of the given size. Return
 451   // NULL if unsuccessful.
 452   HeapWord* humongous_obj_allocate(size_t word_size, AllocationContext_t context);
 453 
 454   // The following two methods, allocate_new_tlab() and
 455   // mem_allocate(), are the two main entry points from the runtime
 456   // into the G1's allocation routines. They have the following
 457   // assumptions:
 458   //
 459   // * They should both be called outside safepoints.
 460   //
 461   // * They should both be called without holding the Heap_lock.
 462   //
 463   // * All allocation requests for new TLABs should go to
 464   //   allocate_new_tlab().
 465   //
 466   // * All non-TLAB allocation requests should go to mem_allocate().
 467   //
 468   // * If either call cannot satisfy the allocation request using the
 469   //   current allocating region, they will try to get a new one. If
 470   //   this fails, they will attempt to do an evacuation pause and
 471   //   retry the allocation.
 472   //
 473   // * If all allocation attempts fail, even after trying to schedule
 474   //   an evacuation pause, allocate_new_tlab() will return NULL,
 475   //   whereas mem_allocate() will attempt a heap expansion and/or
 476   //   schedule a Full GC.
 477   //
 478   // * We do not allow humongous-sized TLABs. So, allocate_new_tlab
 479   //   should never be called with word_size being humongous. All
 480   //   humongous allocation requests should go to mem_allocate() which
 481   //   will satisfy them with a special path.
 482 
 483   virtual HeapWord* allocate_new_tlab(size_t word_size);
 484 
 485   virtual HeapWord* mem_allocate(size_t word_size,
 486                                  bool*  gc_overhead_limit_was_exceeded);
 487 
 488   // The following three methods take a gc_count_before_ret
 489   // parameter which is used to return the GC count if the method
 490   // returns NULL. Given that we are required to read the GC count
 491   // while holding the Heap_lock, and these paths will take the
 492   // Heap_lock at some point, it's easier to get them to read the GC
 493   // count while holding the Heap_lock before they return NULL instead
 494   // of the caller (namely: mem_allocate()) having to also take the
 495   // Heap_lock just to read the GC count.
 496 
 497   // First-level mutator allocation attempt: try to allocate out of
 498   // the mutator alloc region without taking the Heap_lock. This
 499   // should only be used for non-humongous allocations.
 500   inline HeapWord* attempt_allocation(size_t word_size,
 501                                       unsigned int* gc_count_before_ret,
 502                                       int* gclocker_retry_count_ret);
 503 
 504   // Second-level mutator allocation attempt: take the Heap_lock and
 505   // retry the allocation attempt, potentially scheduling a GC
 506   // pause. This should only be used for non-humongous allocations.
 507   HeapWord* attempt_allocation_slow(size_t word_size,
 508                                     AllocationContext_t context,
 509                                     unsigned int* gc_count_before_ret,
 510                                     int* gclocker_retry_count_ret);
 511 
 512   // Takes the Heap_lock and attempts a humongous allocation. It can
 513   // potentially schedule a GC pause.
 514   HeapWord* attempt_allocation_humongous(size_t word_size,
 515                                          unsigned int* gc_count_before_ret,
 516                                          int* gclocker_retry_count_ret);
 517 
 518   // Allocation attempt that should be called during safepoints (e.g.,
 519   // at the end of a successful GC). expect_null_mutator_alloc_region
 520   // specifies whether the mutator alloc region is expected to be NULL
 521   // or not.
 522   HeapWord* attempt_allocation_at_safepoint(size_t word_size,
 523                                             AllocationContext_t context,
 524                                             bool expect_null_mutator_alloc_region);
 525 
 526   // It dirties the cards that cover the block so that so that the post
 527   // write barrier never queues anything when updating objects on this
 528   // block. It is assumed (and in fact we assert) that the block
 529   // belongs to a young region.
 530   inline void dirty_young_block(HeapWord* start, size_t word_size);
 531 
 532   // Allocate blocks during garbage collection. Will ensure an
 533   // allocation region, either by picking one or expanding the
 534   // heap, and then allocate a block of the given size. The block
 535   // may not be a humongous - it must fit into a single heap region.
 536   inline HeapWord* par_allocate_during_gc(InCSetState dest,
 537                                           size_t word_size,
 538                                           AllocationContext_t context);
 539   // Ensure that no further allocations can happen in "r", bearing in mind
 540   // that parallel threads might be attempting allocations.
 541   void par_allocate_remaining_space(HeapRegion* r);
 542 
 543   // Allocation attempt during GC for a survivor object / PLAB.
 544   inline HeapWord* survivor_attempt_allocation(size_t word_size,
 545                                                AllocationContext_t context);
 546 
 547   // Allocation attempt during GC for an old object / PLAB.
 548   inline HeapWord* old_attempt_allocation(size_t word_size,
 549                                           AllocationContext_t context);
 550 
 551   // These methods are the "callbacks" from the G1AllocRegion class.
 552 
 553   // For mutator alloc regions.
 554   HeapRegion* new_mutator_alloc_region(size_t word_size, bool force);
 555   void retire_mutator_alloc_region(HeapRegion* alloc_region,
 556                                    size_t allocated_bytes);
 557 
 558   // For GC alloc regions.
 559   HeapRegion* new_gc_alloc_region(size_t word_size, uint count,
 560                                   InCSetState dest);
 561   void retire_gc_alloc_region(HeapRegion* alloc_region,
 562                               size_t allocated_bytes, InCSetState dest);
 563 
 564   // - if explicit_gc is true, the GC is for a System.gc() or a heap
 565   //   inspection request and should collect the entire heap
 566   // - if clear_all_soft_refs is true, all soft references should be
 567   //   cleared during the GC
 568   // - if explicit_gc is false, word_size describes the allocation that
 569   //   the GC should attempt (at least) to satisfy
 570   // - it returns false if it is unable to do the collection due to the
 571   //   GC locker being active, true otherwise
 572   bool do_collection(bool explicit_gc,
 573                      bool clear_all_soft_refs,
 574                      size_t word_size);
 575 
 576   // Callback from VM_G1CollectFull operation.
 577   // Perform a full collection.
 578   virtual void do_full_collection(bool clear_all_soft_refs);
 579 
 580   // Resize the heap if necessary after a full collection.  If this is
 581   // after a collect-for allocation, "word_size" is the allocation size,
 582   // and will be considered part of the used portion of the heap.
 583   void resize_if_necessary_after_full_collection(size_t word_size);
 584 
 585   // Callback from VM_G1CollectForAllocation operation.
 586   // This function does everything necessary/possible to satisfy a
 587   // failed allocation request (including collection, expansion, etc.)
 588   HeapWord* satisfy_failed_allocation(size_t word_size,
 589                                       AllocationContext_t context,
 590                                       bool* succeeded);
 591 
 592   // Attempting to expand the heap sufficiently
 593   // to support an allocation of the given "word_size".  If
 594   // successful, perform the allocation and return the address of the
 595   // allocated block, or else "NULL".
 596   HeapWord* expand_and_allocate(size_t word_size, AllocationContext_t context);
 597 
 598   // Process any reference objects discovered during
 599   // an incremental evacuation pause.
 600   void process_discovered_references(uint no_of_gc_workers);
 601 
 602   // Enqueue any remaining discovered references
 603   // after processing.
 604   void enqueue_discovered_references(uint no_of_gc_workers);
 605 
 606 public:
 607 
 608   G1Allocator* allocator() {
 609     return _allocator;
 610   }
 611 
 612   G1MonitoringSupport* g1mm() {
 613     assert(_g1mm != NULL, "should have been initialized");
 614     return _g1mm;
 615   }
 616 
 617   // Expand the garbage-first heap by at least the given size (in bytes!).
 618   // Returns true if the heap was expanded by the requested amount;
 619   // false otherwise.
 620   // (Rounds up to a HeapRegion boundary.)
 621   bool expand(size_t expand_bytes);
 622 
 623   // Returns the PLAB statistics for a given destination.
 624   inline PLABStats* alloc_buffer_stats(InCSetState dest);
 625 
 626   // Determines PLAB size for a given destination.
 627   inline size_t desired_plab_sz(InCSetState dest);
 628 
 629   inline AllocationContextStats& allocation_context_stats();
 630 
 631   // Do anything common to GC's.
 632   virtual void gc_prologue(bool full);
 633   virtual void gc_epilogue(bool full);
 634 
 635   inline void set_humongous_is_live(oop obj);
 636 
 637   bool humongous_is_live(uint region) {
 638     return _humongous_is_live.is_live(region);
 639   }
 640 
 641   // Returns whether the given region (which must be a humongous (start) region)
 642   // is to be considered conservatively live regardless of any other conditions.
 643   bool humongous_region_is_always_live(uint index);
 644   // Returns whether the given region (which must be a humongous (start) region)
 645   // is considered a candidate for eager reclamation.
 646   bool humongous_region_is_candidate(uint index);
 647   // Register the given region to be part of the collection set.
 648   inline void register_humongous_region_with_in_cset_fast_test(uint index);
 649   // Register regions with humongous objects (actually on the start region) in
 650   // the in_cset_fast_test table.
 651   void register_humongous_regions_with_in_cset_fast_test();
 652   // We register a region with the fast "in collection set" test. We
 653   // simply set to true the array slot corresponding to this region.
 654   void register_young_region_with_in_cset_fast_test(HeapRegion* r) {
 655     _in_cset_fast_test.set_in_young(r->hrm_index());
 656   }
 657   void register_old_region_with_in_cset_fast_test(HeapRegion* r) {
 658     _in_cset_fast_test.set_in_old(r->hrm_index());
 659   }
 660 
 661   // This is a fast test on whether a reference points into the
 662   // collection set or not. Assume that the reference
 663   // points into the heap.
 664   inline bool in_cset_fast_test(oop obj);
 665 
 666   void clear_cset_fast_test() {
 667     _in_cset_fast_test.clear();
 668   }
 669 
 670   // This is called at the start of either a concurrent cycle or a Full
 671   // GC to update the number of old marking cycles started.
 672   void increment_old_marking_cycles_started();
 673 
 674   // This is called at the end of either a concurrent cycle or a Full
 675   // GC to update the number of old marking cycles completed. Those two
 676   // can happen in a nested fashion, i.e., we start a concurrent
 677   // cycle, a Full GC happens half-way through it which ends first,
 678   // and then the cycle notices that a Full GC happened and ends
 679   // too. The concurrent parameter is a boolean to help us do a bit
 680   // tighter consistency checking in the method. If concurrent is
 681   // false, the caller is the inner caller in the nesting (i.e., the
 682   // Full GC). If concurrent is true, the caller is the outer caller
 683   // in this nesting (i.e., the concurrent cycle). Further nesting is
 684   // not currently supported. The end of this call also notifies
 685   // the FullGCCount_lock in case a Java thread is waiting for a full
 686   // GC to happen (e.g., it called System.gc() with
 687   // +ExplicitGCInvokesConcurrent).
 688   void increment_old_marking_cycles_completed(bool concurrent);
 689 
 690   unsigned int old_marking_cycles_completed() {
 691     return _old_marking_cycles_completed;
 692   }
 693 
 694   void register_concurrent_cycle_start(const Ticks& start_time);
 695   void register_concurrent_cycle_end();
 696   void trace_heap_after_concurrent_cycle();
 697 
 698   G1YCType yc_type();
 699 
 700   G1HRPrinter* hr_printer() { return &_hr_printer; }
 701 
 702   // Frees a non-humongous region by initializing its contents and
 703   // adding it to the free list that's passed as a parameter (this is
 704   // usually a local list which will be appended to the master free
 705   // list later). The used bytes of freed regions are accumulated in
 706   // pre_used. If par is true, the region's RSet will not be freed
 707   // up. The assumption is that this will be done later.
 708   // The locked parameter indicates if the caller has already taken
 709   // care of proper synchronization. This may allow some optimizations.
 710   void free_region(HeapRegion* hr,
 711                    FreeRegionList* free_list,
 712                    bool par,
 713                    bool locked = false);
 714 
 715   // Frees a humongous region by collapsing it into individual regions
 716   // and calling free_region() for each of them. The freed regions
 717   // will be added to the free list that's passed as a parameter (this
 718   // is usually a local list which will be appended to the master free
 719   // list later). The used bytes of freed regions are accumulated in
 720   // pre_used. If par is true, the region's RSet will not be freed
 721   // up. The assumption is that this will be done later.
 722   void free_humongous_region(HeapRegion* hr,
 723                              FreeRegionList* free_list,
 724                              bool par);
 725 protected:
 726 
 727   // Shrink the garbage-first heap by at most the given size (in bytes!).
 728   // (Rounds down to a HeapRegion boundary.)
 729   virtual void shrink(size_t expand_bytes);
 730   void shrink_helper(size_t expand_bytes);
 731 
 732   #if TASKQUEUE_STATS
 733   static void print_taskqueue_stats_hdr(outputStream* const st = gclog_or_tty);
 734   void print_taskqueue_stats(outputStream* const st = gclog_or_tty) const;
 735   void reset_taskqueue_stats();
 736   #endif // TASKQUEUE_STATS
 737 
 738   // Schedule the VM operation that will do an evacuation pause to
 739   // satisfy an allocation request of word_size. *succeeded will
 740   // return whether the VM operation was successful (it did do an
 741   // evacuation pause) or not (another thread beat us to it or the GC
 742   // locker was active). Given that we should not be holding the
 743   // Heap_lock when we enter this method, we will pass the
 744   // gc_count_before (i.e., total_collections()) as a parameter since
 745   // it has to be read while holding the Heap_lock. Currently, both
 746   // methods that call do_collection_pause() release the Heap_lock
 747   // before the call, so it's easy to read gc_count_before just before.
 748   HeapWord* do_collection_pause(size_t         word_size,
 749                                 unsigned int   gc_count_before,
 750                                 bool*          succeeded,
 751                                 GCCause::Cause gc_cause);
 752 
 753   // The guts of the incremental collection pause, executed by the vm
 754   // thread. It returns false if it is unable to do the collection due
 755   // to the GC locker being active, true otherwise
 756   bool do_collection_pause_at_safepoint(double target_pause_time_ms);
 757 
 758   // Actually do the work of evacuating the collection set.
 759   void evacuate_collection_set(EvacuationInfo& evacuation_info);
 760 
 761   // The g1 remembered set of the heap.
 762   G1RemSet* _g1_rem_set;
 763 
 764   // A set of cards that cover the objects for which the Rsets should be updated
 765   // concurrently after the collection.
 766   DirtyCardQueueSet _dirty_card_queue_set;
 767 
 768   // The closure used to refine a single card.
 769   RefineCardTableEntryClosure* _refine_cte_cl;
 770 
 771   // A DirtyCardQueueSet that is used to hold cards that contain
 772   // references into the current collection set. This is used to
 773   // update the remembered sets of the regions in the collection
 774   // set in the event of an evacuation failure.
 775   DirtyCardQueueSet _into_cset_dirty_card_queue_set;
 776 
 777   // After a collection pause, make the regions in the CS into free
 778   // regions.
 779   void free_collection_set(HeapRegion* cs_head, EvacuationInfo& evacuation_info);
 780 
 781   // Abandon the current collection set without recording policy
 782   // statistics or updating free lists.
 783   void abandon_collection_set(HeapRegion* cs_head);
 784 
 785   // Applies "scan_non_heap_roots" to roots outside the heap,
 786   // "scan_rs" to roots inside the heap (having done "set_region" to
 787   // indicate the region in which the root resides),
 788   // and does "scan_metadata" If "scan_rs" is
 789   // NULL, then this step is skipped.  The "worker_i"
 790   // param is for use with parallel roots processing, and should be
 791   // the "i" of the calling parallel worker thread's work(i) function.
 792   // In the sequential case this param will be ignored.
 793   void g1_process_roots(OopClosure* scan_non_heap_roots,
 794                         OopClosure* scan_non_heap_weak_roots,
 795                         G1ParPushHeapRSClosure* scan_rs,
 796                         CLDClosure* scan_strong_clds,
 797                         CLDClosure* scan_weak_clds,
 798                         CodeBlobClosure* scan_strong_code,
 799                         uint worker_i);
 800 
 801   // The concurrent marker (and the thread it runs in.)
 802   ConcurrentMark* _cm;
 803   ConcurrentMarkThread* _cmThread;
 804   bool _mark_in_progress;
 805 
 806   // The concurrent refiner.
 807   ConcurrentG1Refine* _cg1r;
 808 
 809   // The parallel task queues
 810   RefToScanQueueSet *_task_queues;
 811 
 812   // True iff a evacuation has failed in the current collection.
 813   bool _evacuation_failed;
 814 
 815   EvacuationFailedInfo* _evacuation_failed_info_array;
 816 
 817   // Failed evacuations cause some logical from-space objects to have
 818   // forwarding pointers to themselves.  Reset them.
 819   void remove_self_forwarding_pointers();
 820 
 821   // Together, these store an object with a preserved mark, and its mark value.
 822   Stack<oop, mtGC>     _objs_with_preserved_marks;
 823   Stack<markOop, mtGC> _preserved_marks_of_objs;
 824 
 825   // Preserve the mark of "obj", if necessary, in preparation for its mark
 826   // word being overwritten with a self-forwarding-pointer.
 827   void preserve_mark_if_necessary(oop obj, markOop m);
 828 
 829   // The stack of evac-failure objects left to be scanned.
 830   GrowableArray<oop>*    _evac_failure_scan_stack;
 831   // The closure to apply to evac-failure objects.
 832 
 833   OopsInHeapRegionClosure* _evac_failure_closure;
 834   // Set the field above.
 835   void
 836   set_evac_failure_closure(OopsInHeapRegionClosure* evac_failure_closure) {
 837     _evac_failure_closure = evac_failure_closure;
 838   }
 839 
 840   // Push "obj" on the scan stack.
 841   void push_on_evac_failure_scan_stack(oop obj);
 842   // Process scan stack entries until the stack is empty.
 843   void drain_evac_failure_scan_stack();
 844   // True iff an invocation of "drain_scan_stack" is in progress; to
 845   // prevent unnecessary recursion.
 846   bool _drain_in_progress;
 847 
 848   // Do any necessary initialization for evacuation-failure handling.
 849   // "cl" is the closure that will be used to process evac-failure
 850   // objects.
 851   void init_for_evac_failure(OopsInHeapRegionClosure* cl);
 852   // Do any necessary cleanup for evacuation-failure handling data
 853   // structures.
 854   void finalize_for_evac_failure();
 855 
 856   // An attempt to evacuate "obj" has failed; take necessary steps.
 857   oop handle_evacuation_failure_par(G1ParScanThreadState* _par_scan_state, oop obj);
 858   void handle_evacuation_failure_common(oop obj, markOop m);
 859 
 860 #ifndef PRODUCT
 861   // Support for forcing evacuation failures. Analogous to
 862   // PromotionFailureALot for the other collectors.
 863 
 864   // Records whether G1EvacuationFailureALot should be in effect
 865   // for the current GC
 866   bool _evacuation_failure_alot_for_current_gc;
 867 
 868   // Used to record the GC number for interval checking when
 869   // determining whether G1EvaucationFailureALot is in effect
 870   // for the current GC.
 871   size_t _evacuation_failure_alot_gc_number;
 872 
 873   // Count of the number of evacuations between failures.
 874   volatile size_t _evacuation_failure_alot_count;
 875 
 876   // Set whether G1EvacuationFailureALot should be in effect
 877   // for the current GC (based upon the type of GC and which
 878   // command line flags are set);
 879   inline bool evacuation_failure_alot_for_gc_type(bool gcs_are_young,
 880                                                   bool during_initial_mark,
 881                                                   bool during_marking);
 882 
 883   inline void set_evacuation_failure_alot_for_current_gc();
 884 
 885   // Return true if it's time to cause an evacuation failure.
 886   inline bool evacuation_should_fail();
 887 
 888   // Reset the G1EvacuationFailureALot counters.  Should be called at
 889   // the end of an evacuation pause in which an evacuation failure occurred.
 890   inline void reset_evacuation_should_fail();
 891 #endif // !PRODUCT
 892 
 893   // ("Weak") Reference processing support.
 894   //
 895   // G1 has 2 instances of the reference processor class. One
 896   // (_ref_processor_cm) handles reference object discovery
 897   // and subsequent processing during concurrent marking cycles.
 898   //
 899   // The other (_ref_processor_stw) handles reference object
 900   // discovery and processing during full GCs and incremental
 901   // evacuation pauses.
 902   //
 903   // During an incremental pause, reference discovery will be
 904   // temporarily disabled for _ref_processor_cm and will be
 905   // enabled for _ref_processor_stw. At the end of the evacuation
 906   // pause references discovered by _ref_processor_stw will be
 907   // processed and discovery will be disabled. The previous
 908   // setting for reference object discovery for _ref_processor_cm
 909   // will be re-instated.
 910   //
 911   // At the start of marking:
 912   //  * Discovery by the CM ref processor is verified to be inactive
 913   //    and it's discovered lists are empty.
 914   //  * Discovery by the CM ref processor is then enabled.
 915   //
 916   // At the end of marking:
 917   //  * Any references on the CM ref processor's discovered
 918   //    lists are processed (possibly MT).
 919   //
 920   // At the start of full GC we:
 921   //  * Disable discovery by the CM ref processor and
 922   //    empty CM ref processor's discovered lists
 923   //    (without processing any entries).
 924   //  * Verify that the STW ref processor is inactive and it's
 925   //    discovered lists are empty.
 926   //  * Temporarily set STW ref processor discovery as single threaded.
 927   //  * Temporarily clear the STW ref processor's _is_alive_non_header
 928   //    field.
 929   //  * Finally enable discovery by the STW ref processor.
 930   //
 931   // The STW ref processor is used to record any discovered
 932   // references during the full GC.
 933   //
 934   // At the end of a full GC we:
 935   //  * Enqueue any reference objects discovered by the STW ref processor
 936   //    that have non-live referents. This has the side-effect of
 937   //    making the STW ref processor inactive by disabling discovery.
 938   //  * Verify that the CM ref processor is still inactive
 939   //    and no references have been placed on it's discovered
 940   //    lists (also checked as a precondition during initial marking).
 941 
 942   // The (stw) reference processor...
 943   ReferenceProcessor* _ref_processor_stw;
 944 
 945   STWGCTimer* _gc_timer_stw;
 946   ConcurrentGCTimer* _gc_timer_cm;
 947 
 948   G1OldTracer* _gc_tracer_cm;
 949   G1NewTracer* _gc_tracer_stw;
 950 
 951   // During reference object discovery, the _is_alive_non_header
 952   // closure (if non-null) is applied to the referent object to
 953   // determine whether the referent is live. If so then the
 954   // reference object does not need to be 'discovered' and can
 955   // be treated as a regular oop. This has the benefit of reducing
 956   // the number of 'discovered' reference objects that need to
 957   // be processed.
 958   //
 959   // Instance of the is_alive closure for embedding into the
 960   // STW reference processor as the _is_alive_non_header field.
 961   // Supplying a value for the _is_alive_non_header field is
 962   // optional but doing so prevents unnecessary additions to
 963   // the discovered lists during reference discovery.
 964   G1STWIsAliveClosure _is_alive_closure_stw;
 965 
 966   // The (concurrent marking) reference processor...
 967   ReferenceProcessor* _ref_processor_cm;
 968 
 969   // Instance of the concurrent mark is_alive closure for embedding
 970   // into the Concurrent Marking reference processor as the
 971   // _is_alive_non_header field. Supplying a value for the
 972   // _is_alive_non_header field is optional but doing so prevents
 973   // unnecessary additions to the discovered lists during reference
 974   // discovery.
 975   G1CMIsAliveClosure _is_alive_closure_cm;
 976 
 977   // Cache used by G1CollectedHeap::start_cset_region_for_worker().
 978   HeapRegion** _worker_cset_start_region;
 979 
 980   // Time stamp to validate the regions recorded in the cache
 981   // used by G1CollectedHeap::start_cset_region_for_worker().
 982   // The heap region entry for a given worker is valid iff
 983   // the associated time stamp value matches the current value
 984   // of G1CollectedHeap::_gc_time_stamp.
 985   unsigned int* _worker_cset_start_region_time_stamp;
 986 
 987   enum G1H_process_roots_tasks {
 988     G1H_PS_filter_satb_buffers,
 989     G1H_PS_refProcessor_oops_do,
 990     // Leave this one last.
 991     G1H_PS_NumElements
 992   };
 993 
 994   SubTasksDone* _process_strong_tasks;
 995 
 996   volatile bool _free_regions_coming;
 997 
 998 public:
 999 
1000   SubTasksDone* process_strong_tasks() { return _process_strong_tasks; }
1001 
1002   void set_refine_cte_cl_concurrency(bool concurrent);
1003 
1004   RefToScanQueue *task_queue(int i) const;
1005 
1006   // A set of cards where updates happened during the GC
1007   DirtyCardQueueSet& dirty_card_queue_set() { return _dirty_card_queue_set; }
1008 
1009   // A DirtyCardQueueSet that is used to hold cards that contain
1010   // references into the current collection set. This is used to
1011   // update the remembered sets of the regions in the collection
1012   // set in the event of an evacuation failure.
1013   DirtyCardQueueSet& into_cset_dirty_card_queue_set()
1014         { return _into_cset_dirty_card_queue_set; }
1015 
1016   // Create a G1CollectedHeap with the specified policy.
1017   // Must call the initialize method afterwards.
1018   // May not return if something goes wrong.
1019   G1CollectedHeap(G1CollectorPolicy* policy);
1020 
1021   // Initialize the G1CollectedHeap to have the initial and
1022   // maximum sizes and remembered and barrier sets
1023   // specified by the policy object.
1024   jint initialize();
1025 
1026   virtual void stop();
1027 
1028   // Return the (conservative) maximum heap alignment for any G1 heap
1029   static size_t conservative_max_heap_alignment();
1030 
1031   // Initialize weak reference processing.
1032   virtual void ref_processing_init();
1033 
1034   void set_par_threads(uint t) {
1035     SharedHeap::set_par_threads(t);
1036     // Done in SharedHeap but oddly there are
1037     // two _process_strong_tasks's in a G1CollectedHeap
1038     // so do it here too.
1039     _process_strong_tasks->set_n_threads(t);
1040   }
1041 
1042   // Set _n_par_threads according to a policy TBD.
1043   void set_par_threads();
1044 
1045   void set_n_termination(int t) {
1046     _process_strong_tasks->set_n_threads(t);
1047   }
1048 
1049   virtual CollectedHeap::Name kind() const {
1050     return CollectedHeap::G1CollectedHeap;
1051   }
1052 
1053   // The current policy object for the collector.
1054   G1CollectorPolicy* g1_policy() const { return _g1_policy; }
1055 
1056   virtual CollectorPolicy* collector_policy() const { return (CollectorPolicy*) g1_policy(); }
1057 
1058   // Adaptive size policy.  No such thing for g1.
1059   virtual AdaptiveSizePolicy* size_policy() { return NULL; }
1060 
1061   // The rem set and barrier set.
1062   G1RemSet* g1_rem_set() const { return _g1_rem_set; }
1063 
1064   unsigned get_gc_time_stamp() {
1065     return _gc_time_stamp;
1066   }
1067 
1068   inline void reset_gc_time_stamp();
1069 
1070   void check_gc_time_stamps() PRODUCT_RETURN;
1071 
1072   inline void increment_gc_time_stamp();
1073 
1074   // Reset the given region's GC timestamp. If it's starts humongous,
1075   // also reset the GC timestamp of its corresponding
1076   // continues humongous regions too.
1077   void reset_gc_time_stamps(HeapRegion* hr);
1078 
1079   void iterate_dirty_card_closure(CardTableEntryClosure* cl,
1080                                   DirtyCardQueue* into_cset_dcq,
1081                                   bool concurrent, uint worker_i);
1082 
1083   // The shared block offset table array.
1084   G1BlockOffsetSharedArray* bot_shared() const { return _bot_shared; }
1085 
1086   // Reference Processing accessors
1087 
1088   // The STW reference processor....
1089   ReferenceProcessor* ref_processor_stw() const { return _ref_processor_stw; }
1090 
1091   // The Concurrent Marking reference processor...
1092   ReferenceProcessor* ref_processor_cm() const { return _ref_processor_cm; }
1093 
1094   ConcurrentGCTimer* gc_timer_cm() const { return _gc_timer_cm; }
1095   G1OldTracer* gc_tracer_cm() const { return _gc_tracer_cm; }
1096 
1097   virtual size_t capacity() const;
1098   virtual size_t used() const;
1099   // This should be called when we're not holding the heap lock. The
1100   // result might be a bit inaccurate.
1101   size_t used_unlocked() const;
1102   size_t recalculate_used() const;
1103 
1104   // These virtual functions do the actual allocation.
1105   // Some heaps may offer a contiguous region for shared non-blocking
1106   // allocation, via inlined code (by exporting the address of the top and
1107   // end fields defining the extent of the contiguous allocation region.)
1108   // But G1CollectedHeap doesn't yet support this.
1109 
1110   virtual bool is_maximal_no_gc() const {
1111     return _hrm.available() == 0;
1112   }
1113 
1114   // The current number of regions in the heap.
1115   uint num_regions() const { return _hrm.length(); }
1116 
1117   // The max number of regions in the heap.
1118   uint max_regions() const { return _hrm.max_length(); }
1119 
1120   // The number of regions that are completely free.
1121   uint num_free_regions() const { return _hrm.num_free_regions(); }
1122 
1123   // The number of regions that are not completely free.
1124   uint num_used_regions() const { return num_regions() - num_free_regions(); }
1125 
1126   void verify_not_dirty_region(HeapRegion* hr) PRODUCT_RETURN;
1127   void verify_dirty_region(HeapRegion* hr) PRODUCT_RETURN;
1128   void verify_dirty_young_list(HeapRegion* head) PRODUCT_RETURN;
1129   void verify_dirty_young_regions() PRODUCT_RETURN;
1130 
1131 #ifndef PRODUCT
1132   // Make sure that the given bitmap has no marked objects in the
1133   // range [from,limit). If it does, print an error message and return
1134   // false. Otherwise, just return true. bitmap_name should be "prev"
1135   // or "next".
1136   bool verify_no_bits_over_tams(const char* bitmap_name, CMBitMapRO* bitmap,
1137                                 HeapWord* from, HeapWord* limit);
1138 
1139   // Verify that the prev / next bitmap range [tams,end) for the given
1140   // region has no marks. Return true if all is well, false if errors
1141   // are detected.
1142   bool verify_bitmaps(const char* caller, HeapRegion* hr);
1143 #endif // PRODUCT
1144 
1145   // If G1VerifyBitmaps is set, verify that the marking bitmaps for
1146   // the given region do not have any spurious marks. If errors are
1147   // detected, print appropriate error messages and crash.
1148   void check_bitmaps(const char* caller, HeapRegion* hr) PRODUCT_RETURN;
1149 
1150   // If G1VerifyBitmaps is set, verify that the marking bitmaps do not
1151   // have any spurious marks. If errors are detected, print
1152   // appropriate error messages and crash.
1153   void check_bitmaps(const char* caller) PRODUCT_RETURN;
1154 
1155   // Do sanity check on the contents of the in-cset fast test table.
1156   bool check_cset_fast_test() PRODUCT_RETURN_( return true; );
1157 
1158   // verify_region_sets() performs verification over the region
1159   // lists. It will be compiled in the product code to be used when
1160   // necessary (i.e., during heap verification).
1161   void verify_region_sets();
1162 
1163   // verify_region_sets_optional() is planted in the code for
1164   // list verification in non-product builds (and it can be enabled in
1165   // product builds by defining HEAP_REGION_SET_FORCE_VERIFY to be 1).
1166 #if HEAP_REGION_SET_FORCE_VERIFY
1167   void verify_region_sets_optional() {
1168     verify_region_sets();
1169   }
1170 #else // HEAP_REGION_SET_FORCE_VERIFY
1171   void verify_region_sets_optional() { }
1172 #endif // HEAP_REGION_SET_FORCE_VERIFY
1173 
1174 #ifdef ASSERT
1175   bool is_on_master_free_list(HeapRegion* hr) {
1176     return _hrm.is_free(hr);
1177   }
1178 #endif // ASSERT
1179 
1180   // Wrapper for the region list operations that can be called from
1181   // methods outside this class.
1182 
1183   void secondary_free_list_add(FreeRegionList* list) {
1184     _secondary_free_list.add_ordered(list);
1185   }
1186 
1187   void append_secondary_free_list() {
1188     _hrm.insert_list_into_free_list(&_secondary_free_list);
1189   }
1190 
1191   void append_secondary_free_list_if_not_empty_with_lock() {
1192     // If the secondary free list looks empty there's no reason to
1193     // take the lock and then try to append it.
1194     if (!_secondary_free_list.is_empty()) {
1195       MutexLockerEx x(SecondaryFreeList_lock, Mutex::_no_safepoint_check_flag);
1196       append_secondary_free_list();
1197     }
1198   }
1199 
1200   inline void old_set_remove(HeapRegion* hr);
1201 
1202   size_t non_young_capacity_bytes() {
1203     return _old_set.total_capacity_bytes() + _humongous_set.total_capacity_bytes();
1204   }
1205 
1206   void set_free_regions_coming();
1207   void reset_free_regions_coming();
1208   bool free_regions_coming() { return _free_regions_coming; }
1209   void wait_while_free_regions_coming();
1210 
1211   // Determine whether the given region is one that we are using as an
1212   // old GC alloc region.
1213   bool is_old_gc_alloc_region(HeapRegion* hr) {
1214     return _allocator->is_retained_old_region(hr);
1215   }
1216 
1217   // Perform a collection of the heap; intended for use in implementing
1218   // "System.gc".  This probably implies as full a collection as the
1219   // "CollectedHeap" supports.
1220   virtual void collect(GCCause::Cause cause);
1221 
1222   // The same as above but assume that the caller holds the Heap_lock.
1223   void collect_locked(GCCause::Cause cause);
1224 
1225   virtual bool copy_allocation_context_stats(const jint* contexts,
1226                                              jlong* totals,
1227                                              jbyte* accuracy,
1228                                              jint len);
1229 
1230   // True iff an evacuation has failed in the most-recent collection.
1231   bool evacuation_failed() { return _evacuation_failed; }
1232 
1233   void remove_from_old_sets(const HeapRegionSetCount& old_regions_removed, const HeapRegionSetCount& humongous_regions_removed);
1234   void prepend_to_freelist(FreeRegionList* list);
1235   void decrement_summary_bytes(size_t bytes);
1236 
1237   // Returns "TRUE" iff "p" points into the committed areas of the heap.
1238   virtual bool is_in(const void* p) const;
1239 #ifdef ASSERT
1240   // Returns whether p is in one of the available areas of the heap. Slow but
1241   // extensive version.
1242   bool is_in_exact(const void* p) const;
1243 #endif
1244 
1245   // Return "TRUE" iff the given object address is within the collection
1246   // set. Slow implementation.
1247   inline bool obj_in_cs(oop obj);
1248 
1249   inline bool is_in_cset(oop obj);
1250 
1251   inline bool is_in_cset_or_humongous(const oop obj);
1252 
1253  private:
1254   // This array is used for a quick test on whether a reference points into
1255   // the collection set or not. Each of the array's elements denotes whether the
1256   // corresponding region is in the collection set or not.
1257   G1InCSetStateFastTestBiasedMappedArray _in_cset_fast_test;
1258 
1259  public:
1260 
1261   inline InCSetState in_cset_state(const oop obj);
1262 
1263   // Return "TRUE" iff the given object address is in the reserved
1264   // region of g1.
1265   bool is_in_g1_reserved(const void* p) const {
1266     return _hrm.reserved().contains(p);
1267   }
1268 
1269   // Returns a MemRegion that corresponds to the space that has been
1270   // reserved for the heap
1271   MemRegion g1_reserved() const {
1272     return _hrm.reserved();
1273   }
1274 
1275   virtual bool is_in_closed_subset(const void* p) const;
1276 
1277   G1SATBCardTableLoggingModRefBS* g1_barrier_set() {
1278     return (G1SATBCardTableLoggingModRefBS*) barrier_set();
1279   }
1280 
1281   // This resets the card table to all zeros.  It is used after
1282   // a collection pause which used the card table to claim cards.
1283   void cleanUpCardTable();
1284 
1285   // Iteration functions.
1286 
1287   // Iterate over all the ref-containing fields of all objects, calling
1288   // "cl.do_oop" on each.
1289   virtual void oop_iterate(ExtendedOopClosure* cl);
1290 
1291   // Iterate over all objects, calling "cl.do_object" on each.
1292   virtual void object_iterate(ObjectClosure* cl);
1293 
1294   virtual void safe_object_iterate(ObjectClosure* cl) {
1295     object_iterate(cl);
1296   }
1297 
1298   // Iterate over all spaces in use in the heap, in ascending address order.
1299   virtual void space_iterate(SpaceClosure* cl);
1300 
1301   // Iterate over heap regions, in address order, terminating the
1302   // iteration early if the "doHeapRegion" method returns "true".
1303   void heap_region_iterate(HeapRegionClosure* blk) const;
1304 
1305   // Return the region with the given index. It assumes the index is valid.
1306   inline HeapRegion* region_at(uint index) const;
1307 
1308   // Calculate the region index of the given address. Given address must be
1309   // within the heap.
1310   inline uint addr_to_region(HeapWord* addr) const;
1311 
1312   inline HeapWord* bottom_addr_for_region(uint index) const;
1313 
1314   // Iterate over the heap regions in parallel. Assumes that this will be called
1315   // in parallel by ParallelGCThreads worker threads with distinct worker ids
1316   // in the range [0..max(ParallelGCThreads-1, 1)]. Applies "blk->doHeapRegion"
1317   // to each of the regions, by attempting to claim the region using the
1318   // HeapRegionClaimer and, if successful, applying the closure to the claimed
1319   // region. The concurrent argument should be set to true if iteration is
1320   // performed concurrently, during which no assumptions are made for consistent
1321   // attributes of the heap regions (as they might be modified while iterating).
1322   void heap_region_par_iterate(HeapRegionClosure* cl,
1323                                uint worker_id,
1324                                HeapRegionClaimer* hrclaimer,
1325                                bool concurrent = false) const;
1326 
1327   // Clear the cached cset start regions and (more importantly)
1328   // the time stamps. Called when we reset the GC time stamp.
1329   void clear_cset_start_regions();
1330 
1331   // Given the id of a worker, obtain or calculate a suitable
1332   // starting region for iterating over the current collection set.
1333   HeapRegion* start_cset_region_for_worker(uint worker_i);
1334 
1335   // Iterate over the regions (if any) in the current collection set.
1336   void collection_set_iterate(HeapRegionClosure* blk);
1337 
1338   // As above but starting from region r
1339   void collection_set_iterate_from(HeapRegion* r, HeapRegionClosure *blk);
1340 
1341   HeapRegion* next_compaction_region(const HeapRegion* from) const;
1342 
1343   // A CollectedHeap will contain some number of spaces.  This finds the
1344   // space containing a given address, or else returns NULL.
1345   virtual Space* space_containing(const void* addr) const;
1346 
1347   // Returns the HeapRegion that contains addr. addr must not be NULL.
1348   template <class T>
1349   inline HeapRegion* heap_region_containing_raw(const T addr) const;
1350 
1351   // Returns the HeapRegion that contains addr. addr must not be NULL.
1352   // If addr is within a humongous continues region, it returns its humongous start region.
1353   template <class T>
1354   inline HeapRegion* heap_region_containing(const T addr) const;
1355 
1356   // A CollectedHeap is divided into a dense sequence of "blocks"; that is,
1357   // each address in the (reserved) heap is a member of exactly
1358   // one block.  The defining characteristic of a block is that it is
1359   // possible to find its size, and thus to progress forward to the next
1360   // block.  (Blocks may be of different sizes.)  Thus, blocks may
1361   // represent Java objects, or they might be free blocks in a
1362   // free-list-based heap (or subheap), as long as the two kinds are
1363   // distinguishable and the size of each is determinable.
1364 
1365   // Returns the address of the start of the "block" that contains the
1366   // address "addr".  We say "blocks" instead of "object" since some heaps
1367   // may not pack objects densely; a chunk may either be an object or a
1368   // non-object.
1369   virtual HeapWord* block_start(const void* addr) const;
1370 
1371   // Requires "addr" to be the start of a chunk, and returns its size.
1372   // "addr + size" is required to be the start of a new chunk, or the end
1373   // of the active area of the heap.
1374   virtual size_t block_size(const HeapWord* addr) const;
1375 
1376   // Requires "addr" to be the start of a block, and returns "TRUE" iff
1377   // the block is an object.
1378   virtual bool block_is_obj(const HeapWord* addr) const;
1379 
1380   // Does this heap support heap inspection? (+PrintClassHistogram)
1381   virtual bool supports_heap_inspection() const { return true; }
1382 
1383   // Section on thread-local allocation buffers (TLABs)
1384   // See CollectedHeap for semantics.
1385 
1386   bool supports_tlab_allocation() const;
1387   size_t tlab_capacity(Thread* ignored) const;
1388   size_t tlab_used(Thread* ignored) const;
1389   size_t max_tlab_size() const;
1390   size_t unsafe_max_tlab_alloc(Thread* ignored) const;
1391 
1392   // Can a compiler initialize a new object without store barriers?
1393   // This permission only extends from the creation of a new object
1394   // via a TLAB up to the first subsequent safepoint. If such permission
1395   // is granted for this heap type, the compiler promises to call
1396   // defer_store_barrier() below on any slow path allocation of
1397   // a new object for which such initializing store barriers will
1398   // have been elided. G1, like CMS, allows this, but should be
1399   // ready to provide a compensating write barrier as necessary
1400   // if that storage came out of a non-young region. The efficiency
1401   // of this implementation depends crucially on being able to
1402   // answer very efficiently in constant time whether a piece of
1403   // storage in the heap comes from a young region or not.
1404   // See ReduceInitialCardMarks.
1405   virtual bool can_elide_tlab_store_barriers() const {
1406     return true;
1407   }
1408 
1409   virtual bool card_mark_must_follow_store() const {
1410     return true;
1411   }
1412 
1413   inline bool is_in_young(const oop obj);
1414 
1415 #ifdef ASSERT
1416   virtual bool is_in_partial_collection(const void* p);
1417 #endif
1418 
1419   virtual bool is_scavengable(const void* addr);
1420 
1421   // We don't need barriers for initializing stores to objects
1422   // in the young gen: for the SATB pre-barrier, there is no
1423   // pre-value that needs to be remembered; for the remembered-set
1424   // update logging post-barrier, we don't maintain remembered set
1425   // information for young gen objects.
1426   virtual inline bool can_elide_initializing_store_barrier(oop new_obj);
1427 
1428   // Returns "true" iff the given word_size is "very large".
1429   static bool is_humongous(size_t word_size) {
1430     // Note this has to be strictly greater-than as the TLABs
1431     // are capped at the humongous threshold and we want to
1432     // ensure that we don't try to allocate a TLAB as
1433     // humongous and that we don't allocate a humongous
1434     // object in a TLAB.
1435     return word_size > _humongous_object_threshold_in_words;
1436   }
1437 
1438   // Update mod union table with the set of dirty cards.
1439   void updateModUnion();
1440 
1441   // Set the mod union bits corresponding to the given memRegion.  Note
1442   // that this is always a safe operation, since it doesn't clear any
1443   // bits.
1444   void markModUnionRange(MemRegion mr);
1445 
1446   // Records the fact that a marking phase is no longer in progress.
1447   void set_marking_complete() {
1448     _mark_in_progress = false;
1449   }
1450   void set_marking_started() {
1451     _mark_in_progress = true;
1452   }
1453   bool mark_in_progress() {
1454     return _mark_in_progress;
1455   }
1456 
1457   // Print the maximum heap capacity.
1458   virtual size_t max_capacity() const;
1459 
1460   virtual jlong millis_since_last_gc();
1461 
1462 
1463   // Convenience function to be used in situations where the heap type can be
1464   // asserted to be this type.
1465   static G1CollectedHeap* heap();
1466 
1467   void set_region_short_lived_locked(HeapRegion* hr);
1468   // add appropriate methods for any other surv rate groups
1469 
1470   YoungList* young_list() const { return _young_list; }
1471 
1472   // debugging
1473   bool check_young_list_well_formed() {
1474     return _young_list->check_list_well_formed();
1475   }
1476 
1477   bool check_young_list_empty(bool check_heap,
1478                               bool check_sample = true);
1479 
1480   // *** Stuff related to concurrent marking.  It's not clear to me that so
1481   // many of these need to be public.
1482 
1483   // The functions below are helper functions that a subclass of
1484   // "CollectedHeap" can use in the implementation of its virtual
1485   // functions.
1486   // This performs a concurrent marking of the live objects in a
1487   // bitmap off to the side.
1488   void doConcurrentMark();
1489 
1490   bool isMarkedPrev(oop obj) const;
1491   bool isMarkedNext(oop obj) const;
1492 
1493   // Determine if an object is dead, given the object and also
1494   // the region to which the object belongs. An object is dead
1495   // iff a) it was not allocated since the last mark and b) it
1496   // is not marked.
1497   bool is_obj_dead(const oop obj, const HeapRegion* hr) const {
1498     return
1499       !hr->obj_allocated_since_prev_marking(obj) &&
1500       !isMarkedPrev(obj);
1501   }
1502 
1503   // This function returns true when an object has been
1504   // around since the previous marking and hasn't yet
1505   // been marked during this marking.
1506   bool is_obj_ill(const oop obj, const HeapRegion* hr) const {
1507     return
1508       !hr->obj_allocated_since_next_marking(obj) &&
1509       !isMarkedNext(obj);
1510   }
1511 
1512   // Determine if an object is dead, given only the object itself.
1513   // This will find the region to which the object belongs and
1514   // then call the region version of the same function.
1515 
1516   // Added if it is NULL it isn't dead.
1517 
1518   inline bool is_obj_dead(const oop obj) const;
1519 
1520   inline bool is_obj_ill(const oop obj) const;
1521 
1522   bool allocated_since_marking(oop obj, HeapRegion* hr, VerifyOption vo);
1523   HeapWord* top_at_mark_start(HeapRegion* hr, VerifyOption vo);
1524   bool is_marked(oop obj, VerifyOption vo);
1525   const char* top_at_mark_start_str(VerifyOption vo);
1526 
1527   ConcurrentMark* concurrent_mark() const { return _cm; }
1528 
1529   // Refinement
1530 
1531   ConcurrentG1Refine* concurrent_g1_refine() const { return _cg1r; }
1532 
1533   // The dirty cards region list is used to record a subset of regions
1534   // whose cards need clearing. The list if populated during the
1535   // remembered set scanning and drained during the card table
1536   // cleanup. Although the methods are reentrant, population/draining
1537   // phases must not overlap. For synchronization purposes the last
1538   // element on the list points to itself.
1539   HeapRegion* _dirty_cards_region_list;
1540   void push_dirty_cards_region(HeapRegion* hr);
1541   HeapRegion* pop_dirty_cards_region();
1542 
1543   // Optimized nmethod scanning support routines
1544 
1545   // Register the given nmethod with the G1 heap.
1546   virtual void register_nmethod(nmethod* nm);
1547 
1548   // Unregister the given nmethod from the G1 heap.
1549   virtual void unregister_nmethod(nmethod* nm);
1550 
1551   // Free up superfluous code root memory.
1552   void purge_code_root_memory();
1553 
1554   // Rebuild the strong code root lists for each region
1555   // after a full GC.
1556   void rebuild_strong_code_roots();
1557 
1558   // Delete entries for dead interned string and clean up unreferenced symbols
1559   // in symbol table, possibly in parallel.
1560   void unlink_string_and_symbol_table(BoolObjectClosure* is_alive, bool unlink_strings = true, bool unlink_symbols = true);
1561 
1562   // Parallel phase of unloading/cleaning after G1 concurrent mark.
1563   void parallel_cleaning(BoolObjectClosure* is_alive, bool process_strings, bool process_symbols, bool class_unloading_occurred);
1564 
1565   // Redirty logged cards in the refinement queue.
1566   void redirty_logged_cards();
1567   // Verification
1568 
1569   // The following is just to alert the verification code
1570   // that a full collection has occurred and that the
1571   // remembered sets are no longer up to date.
1572   bool _full_collection;
1573   void set_full_collection() { _full_collection = true;}
1574   void clear_full_collection() {_full_collection = false;}
1575   bool full_collection() {return _full_collection;}
1576 
1577   // Perform any cleanup actions necessary before allowing a verification.
1578   virtual void prepare_for_verify();
1579 
1580   // Perform verification.
1581 
1582   // vo == UsePrevMarking  -> use "prev" marking information,
1583   // vo == UseNextMarking -> use "next" marking information
1584   // vo == UseMarkWord    -> use the mark word in the object header
1585   //
1586   // NOTE: Only the "prev" marking information is guaranteed to be
1587   // consistent most of the time, so most calls to this should use
1588   // vo == UsePrevMarking.
1589   // Currently, there is only one case where this is called with
1590   // vo == UseNextMarking, which is to verify the "next" marking
1591   // information at the end of remark.
1592   // Currently there is only one place where this is called with
1593   // vo == UseMarkWord, which is to verify the marking during a
1594   // full GC.
1595   void verify(bool silent, VerifyOption vo);
1596 
1597   // Override; it uses the "prev" marking information
1598   virtual void verify(bool silent);
1599 
1600   // The methods below are here for convenience and dispatch the
1601   // appropriate method depending on value of the given VerifyOption
1602   // parameter. The values for that parameter, and their meanings,
1603   // are the same as those above.
1604 
1605   bool is_obj_dead_cond(const oop obj,
1606                         const HeapRegion* hr,
1607                         const VerifyOption vo) const;
1608 
1609   bool is_obj_dead_cond(const oop obj,
1610                         const VerifyOption vo) const;
1611 
1612   // Printing
1613 
1614   virtual void print_on(outputStream* st) const;
1615   virtual void print_extended_on(outputStream* st) const;
1616   virtual void print_on_error(outputStream* st) const;
1617 
1618   virtual void print_gc_threads_on(outputStream* st) const;
1619   virtual void gc_threads_do(ThreadClosure* tc) const;
1620 
1621   // Override
1622   void print_tracing_info() const;
1623 
1624   // The following two methods are helpful for debugging RSet issues.
1625   void print_cset_rsets() PRODUCT_RETURN;
1626   void print_all_rsets() PRODUCT_RETURN;
1627 
1628 public:
1629   size_t pending_card_num();
1630   size_t cards_scanned();
1631 
1632 protected:
1633   size_t _max_heap_capacity;
1634 };
1635 
1636 #endif // SHARE_VM_GC_IMPLEMENTATION_G1_G1COLLECTEDHEAP_HPP