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