/*

 * Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#ifndef SHARE_VM_GC_IMPLEMENTATION_G1_G1COLLECTEDHEAP_HPP

#define SHARE_VM_GC_IMPLEMENTATION_G1_G1COLLECTEDHEAP_HPP

#include "gc_implementation/g1/concurrentMark.hpp"

#include "gc_implementation/g1/g1AllocRegion.hpp"

#include "gc_implementation/g1/g1HRPrinter.hpp"

#include "gc_implementation/g1/g1RemSet.hpp"

#include "gc_implementation/g1/g1MonitoringSupport.hpp"

#include "gc_implementation/g1/heapRegionSeq.hpp"

#include "gc_implementation/g1/heapRegionSets.hpp"

#include "gc_implementation/shared/hSpaceCounters.hpp"

#include "gc_implementation/parNew/parGCAllocBuffer.hpp"

#include "memory/barrierSet.hpp"

#include "memory/memRegion.hpp"

#include "memory/sharedHeap.hpp"

// A "G1CollectedHeap" is an implementation of a java heap for HotSpot.

// It uses the "Garbage First" heap organization and algorithm, which

// may combine concurrent marking with parallel, incremental compaction of

// heap subsets that will yield large amounts of garbage.

class HeapRegion;

class HRRSCleanupTask;

class PermanentGenerationSpec;

class GenerationSpec;

class OopsInHeapRegionClosure;

class G1ScanHeapEvacClosure;

class ObjectClosure;

class SpaceClosure;

class CompactibleSpaceClosure;

class Space;

class G1CollectorPolicy;

class GenRemSet;

class G1RemSet;

class HeapRegionRemSetIterator;

class ConcurrentMark;

class ConcurrentMarkThread;

class ConcurrentG1Refine;

class GenerationCounters;

typedef OverflowTaskQueue<StarTask>         RefToScanQueue;

typedef GenericTaskQueueSet<RefToScanQueue> RefToScanQueueSet;

typedef int RegionIdx_t;   // needs to hold [ 0..max_regions() )

typedef int CardIdx_t;     // needs to hold [ 0..CardsPerRegion )

enum GCAllocPurpose {

  GCAllocForTenured,

  GCAllocForSurvived,

  GCAllocPurposeCount

};

class YoungList : public CHeapObj {

private:

  G1CollectedHeap* _g1h;

  HeapRegion* _head;

  HeapRegion* _survivor_head;

  HeapRegion* _survivor_tail;

  HeapRegion* _curr;

  size_t      _length;

  size_t      _survivor_length;

  size_t      _last_sampled_rs_lengths;

  size_t      _sampled_rs_lengths;

  void         empty_list(HeapRegion* list);

public:

  YoungList(G1CollectedHeap* g1h);

  void         push_region(HeapRegion* hr);

  void         add_survivor_region(HeapRegion* hr);

  void         empty_list();

  bool         is_empty() { return _length == 0; }

  size_t       length() { return _length; }

  size_t       survivor_length() { return _survivor_length; }

  // Currently we do not keep track of the used byte sum for the

  // young list and the survivors and it'd be quite a lot of work to

  // do so. When we'll eventually replace the young list with

  // instances of HeapRegionLinkedList we'll get that for free. So,

  // we'll report the more accurate information then.

  size_t       eden_used_bytes() {

    assert(length() >= survivor_length(), "invariant");

    return (length() - survivor_length()) * HeapRegion::GrainBytes;

  }

  size_t       survivor_used_bytes() {

    return survivor_length() * HeapRegion::GrainBytes;

  }

  void rs_length_sampling_init();

  bool rs_length_sampling_more();

  void rs_length_sampling_next();

  void reset_sampled_info() {

    _last_sampled_rs_lengths =   0;

  }

  size_t sampled_rs_lengths() { return _last_sampled_rs_lengths; }

  // for development purposes

  void reset_auxilary_lists();

  void clear() { _head = NULL; _length = 0; }

  void clear_survivors() {

    _survivor_head    = NULL;

    _survivor_tail    = NULL;

    _survivor_length  = 0;

  }

  HeapRegion* first_region() { return _head; }

  HeapRegion* first_survivor_region() { return _survivor_head; }

  HeapRegion* last_survivor_region() { return _survivor_tail; }

  // debugging

  bool          check_list_well_formed();

  bool          check_list_empty(bool check_sample = true);

  void          print();

};

class MutatorAllocRegion : public G1AllocRegion {

protected:

  virtual HeapRegion* allocate_new_region(size_t word_size, bool force);

  virtual void retire_region(HeapRegion* alloc_region, size_t allocated_bytes);

public:

  MutatorAllocRegion()

    : G1AllocRegion("Mutator Alloc Region", false /* bot_updates */) { }

};

class SurvivorGCAllocRegion : public G1AllocRegion {

protected:

  virtual HeapRegion* allocate_new_region(size_t word_size, bool force);

  virtual void retire_region(HeapRegion* alloc_region, size_t allocated_bytes);

public:

  SurvivorGCAllocRegion()

  : G1AllocRegion("Survivor GC Alloc Region", false /* bot_updates */) { }

};

class OldGCAllocRegion : public G1AllocRegion {

protected:

  virtual HeapRegion* allocate_new_region(size_t word_size, bool force);

  virtual void retire_region(HeapRegion* alloc_region, size_t allocated_bytes);

public:

  OldGCAllocRegion()

  : G1AllocRegion("Old GC Alloc Region", true /* bot_updates */) { }

};

class RefineCardTableEntryClosure;

class G1CollectedHeap : public SharedHeap {

  friend class VM_G1CollectForAllocation;

  friend class VM_GenCollectForPermanentAllocation;

  friend class VM_G1CollectFull;

  friend class VM_G1IncCollectionPause;

  friend class VMStructs;

  friend class MutatorAllocRegion;

  friend class SurvivorGCAllocRegion;

  friend class OldGCAllocRegion;

  // Closures used in implementation.

  friend class G1ParCopyHelper;

  friend class G1IsAliveClosure;

  friend class G1EvacuateFollowersClosure;

  friend class G1ParScanThreadState;

  friend class G1ParScanClosureSuper;

  friend class G1ParEvacuateFollowersClosure;

  friend class G1ParTask;

  friend class G1FreeGarbageRegionClosure;

  friend class RefineCardTableEntryClosure;

  friend class G1PrepareCompactClosure;

  friend class RegionSorter;

  friend class RegionResetter;

  friend class CountRCClosure;

  friend class EvacPopObjClosure;

  friend class G1ParCleanupCTTask;

  // Other related classes.

  friend class G1MarkSweep;

private:

  // The one and only G1CollectedHeap, so static functions can find it.

  static G1CollectedHeap* _g1h;

  static size_t _humongous_object_threshold_in_words;

  // Storage for the G1 heap (excludes the permanent generation).

  VirtualSpace _g1_storage;

  MemRegion    _g1_reserved;

  // The part of _g1_storage that is currently committed.

  MemRegion _g1_committed;

  // The master free list. It will satisfy all new region allocations.

  MasterFreeRegionList      _free_list;

  // The secondary free list which contains regions that have been

  // freed up during the cleanup process. This will be appended to the

  // master free list when appropriate.

  SecondaryFreeRegionList   _secondary_free_list;

  // It keeps track of the humongous regions.

  MasterHumongousRegionSet  _humongous_set;

  // The number of regions we could create by expansion.

  size_t _expansion_regions;

  // The block offset table for the G1 heap.

  G1BlockOffsetSharedArray* _bot_shared;

  // Move all of the regions off the free lists, then rebuild those free

  // lists, before and after full GC.

  void tear_down_region_lists();

  void rebuild_region_lists();

  // The sequence of all heap regions in the heap.

  HeapRegionSeq _hrs;

  // Alloc region used to satisfy mutator allocation requests.

  MutatorAllocRegion _mutator_alloc_region;

  // Alloc region used to satisfy allocation requests by the GC for

  // survivor objects.

  SurvivorGCAllocRegion _survivor_gc_alloc_region;

  // Alloc region used to satisfy allocation requests by the GC for

  // old objects.

  OldGCAllocRegion _old_gc_alloc_region;

  // The last old region we allocated to during the last GC.

  // Typically, it is not full so we should re-use it during the next GC.

  HeapRegion* _retained_old_gc_alloc_region;

  // It resets the mutator alloc region before new allocations can take place.

  void init_mutator_alloc_region();

  // It releases the mutator alloc region.

  void release_mutator_alloc_region();

  // It initializes the GC alloc regions at the start of a GC.

  void init_gc_alloc_regions();

  // It releases the GC alloc regions at the end of a GC.

  void release_gc_alloc_regions();

  // It does any cleanup that needs to be done on the GC alloc regions

  // before a Full GC.

  void abandon_gc_alloc_regions();

  // Helper for monitoring and management support.

  G1MonitoringSupport* _g1mm;

  // Determines PLAB size for a particular allocation purpose.

  static size_t desired_plab_sz(GCAllocPurpose purpose);

  // Outside of GC pauses, the number of bytes used in all regions other

  // than the current allocation region.

  size_t _summary_bytes_used;

  // This is used for a quick test on whether a reference points into

  // the collection set or not. Basically, we have an array, with one

  // byte per region, and that byte denotes whether the corresponding

  // region is in the collection set or not. The entry corresponding

  // the bottom of the heap, i.e., region 0, is pointed to by

  // _in_cset_fast_test_base.  The _in_cset_fast_test field has been

  // biased so that it actually points to address 0 of the address

  // space, to make the test as fast as possible (we can simply shift

  // the address to address into it, instead of having to subtract the

  // bottom of the heap from the address before shifting it; basically

  // it works in the same way the card table works).

  bool* _in_cset_fast_test;

  // The allocated array used for the fast test on whether a reference

  // points into the collection set or not. This field is also used to

  // free the array.

  bool* _in_cset_fast_test_base;

  // The length of the _in_cset_fast_test_base array.

  size_t _in_cset_fast_test_length;

  volatile unsigned _gc_time_stamp;

  size_t* _surviving_young_words;

  G1HRPrinter _hr_printer;

  void setup_surviving_young_words();

  void update_surviving_young_words(size_t* surv_young_words);

  void cleanup_surviving_young_words();

  // It decides whether an explicit GC should start a concurrent cycle

  // instead of doing a STW GC. Currently, a concurrent cycle is

  // explicitly started if:

  // (a) cause == _gc_locker and +GCLockerInvokesConcurrent, or

  // (b) cause == _java_lang_system_gc and +ExplicitGCInvokesConcurrent.

  bool should_do_concurrent_full_gc(GCCause::Cause cause);

  // Keeps track of how many "full collections" (i.e., Full GCs or

  // concurrent cycles) we have completed. The number of them we have

  // started is maintained in _total_full_collections in CollectedHeap.

  volatile unsigned int _full_collections_completed;

  // This is a non-product method that is helpful for testing. It is

  // called at the end of a GC and artificially expands the heap by

  // allocating a number of dead regions. This way we can induce very

  // frequent marking cycles and stress the cleanup / concurrent

  // cleanup code more (as all the regions that will be allocated by

  // this method will be found dead by the marking cycle).

  void allocate_dummy_regions() PRODUCT_RETURN;

  // These are macros so that, if the assert fires, we get the correct

  // line number, file, etc.

#define heap_locking_asserts_err_msg(_extra_message_)                         \

  err_msg("%s : Heap_lock locked: %s, at safepoint: %s, is VM thread: %s",    \

          (_extra_message_),                                                  \

          BOOL_TO_STR(Heap_lock->owned_by_self()),                            \

          BOOL_TO_STR(SafepointSynchronize::is_at_safepoint()),               \

          BOOL_TO_STR(Thread::current()->is_VM_thread()))

#define assert_heap_locked()                                                  \

  do {                                                                        \

    assert(Heap_lock->owned_by_self(),                                        \

           heap_locking_asserts_err_msg("should be holding the Heap_lock"));  \

  } while (0)

#define assert_heap_locked_or_at_safepoint(_should_be_vm_thread_)             \

  do {                                                                        \

    assert(Heap_lock->owned_by_self() ||                                      \

           (SafepointSynchronize::is_at_safepoint() &&                        \

             ((_should_be_vm_thread_) == Thread::current()->is_VM_thread())), \

           heap_locking_asserts_err_msg("should be holding the Heap_lock or " \

                                        "should be at a safepoint"));         \

  } while (0)

#define assert_heap_locked_and_not_at_safepoint()                             \

  do {                                                                        \

    assert(Heap_lock->owned_by_self() &&                                      \

                                    !SafepointSynchronize::is_at_safepoint(), \

          heap_locking_asserts_err_msg("should be holding the Heap_lock and " \

                                       "should not be at a safepoint"));      \

  } while (0)

#define assert_heap_not_locked()                                              \

  do {                                                                        \

    assert(!Heap_lock->owned_by_self(),                                       \

        heap_locking_asserts_err_msg("should not be holding the Heap_lock")); \

  } while (0)

#define assert_heap_not_locked_and_not_at_safepoint()                         \

  do {                                                                        \

    assert(!Heap_lock->owned_by_self() &&                                     \

                                    !SafepointSynchronize::is_at_safepoint(), \

      heap_locking_asserts_err_msg("should not be holding the Heap_lock and " \

                                   "should not be at a safepoint"));          \

  } while (0)

#define assert_at_safepoint(_should_be_vm_thread_)                            \

  do {                                                                        \

    assert(SafepointSynchronize::is_at_safepoint() &&                         \

              ((_should_be_vm_thread_) == Thread::current()->is_VM_thread()), \

           heap_locking_asserts_err_msg("should be at a safepoint"));         \

  } while (0)

#define assert_not_at_safepoint()                                             \

  do {                                                                        \

    assert(!SafepointSynchronize::is_at_safepoint(),                          \

           heap_locking_asserts_err_msg("should not be at a safepoint"));     \

  } while (0)

protected:

  // The young region list.

  YoungList*  _young_list;

  // The current policy object for the collector.

  G1CollectorPolicy* _g1_policy;

  // This is the second level of trying to allocate a new region. If

  // new_region() didn't find a region on the free_list, this call will

  // check whether there's anything available on the

  // secondary_free_list and/or wait for more regions to appear on

  // that list, if _free_regions_coming is set.

  HeapRegion* new_region_try_secondary_free_list();

  // Try to allocate a single non-humongous HeapRegion sufficient for

  // an allocation of the given word_size. If do_expand is true,

  // attempt to expand the heap if necessary to satisfy the allocation

  // request.

  HeapRegion* new_region(size_t word_size, bool do_expand);

  // Attempt to satisfy a humongous allocation request of the given

  // size by finding a contiguous set of free regions of num_regions

  // length and remove them from the master free list. Return the

  // index of the first region or G1_NULL_HRS_INDEX if the search

  // was unsuccessful.

  size_t humongous_obj_allocate_find_first(size_t num_regions,

                                           size_t word_size);

  // Initialize a contiguous set of free regions of length num_regions

  // and starting at index first so that they appear as a single

  // humongous region.

  HeapWord* humongous_obj_allocate_initialize_regions(size_t first,

                                                      size_t num_regions,

                                                      size_t word_size);

  // Attempt to allocate a humongous object of the given size. Return

  // NULL if unsuccessful.

  HeapWord* humongous_obj_allocate(size_t word_size);

  // The following two methods, allocate_new_tlab() and

  // mem_allocate(), are the two main entry points from the runtime

  // into the G1's allocation routines. They have the following

  // assumptions:

  //

  // * They should both be called outside safepoints.

  //

  // * They should both be called without holding the Heap_lock.

  //

  // * All allocation requests for new TLABs should go to

  //   allocate_new_tlab().

  //

  // * All non-TLAB allocation requests should go to mem_allocate().

  //

  // * If either call cannot satisfy the allocation request using the

  //   current allocating region, they will try to get a new one. If

  //   this fails, they will attempt to do an evacuation pause and

  //   retry the allocation.

  //

  // * If all allocation attempts fail, even after trying to schedule

  //   an evacuation pause, allocate_new_tlab() will return NULL,

  //   whereas mem_allocate() will attempt a heap expansion and/or

  //   schedule a Full GC.

  //

  // * We do not allow humongous-sized TLABs. So, allocate_new_tlab

  //   should never be called with word_size being humongous. All

  //   humongous allocation requests should go to mem_allocate() which

  //   will satisfy them with a special path.

  virtual HeapWord* allocate_new_tlab(size_t word_size);

  virtual HeapWord* mem_allocate(size_t word_size,

                                 bool*  gc_overhead_limit_was_exceeded);

  // The following three methods take a gc_count_before_ret

  // parameter which is used to return the GC count if the method

  // returns NULL. Given that we are required to read the GC count

  // while holding the Heap_lock, and these paths will take the

  // Heap_lock at some point, it's easier to get them to read the GC

  // count while holding the Heap_lock before they return NULL instead

  // of the caller (namely: mem_allocate()) having to also take the

  // Heap_lock just to read the GC count.

  // First-level mutator allocation attempt: try to allocate out of

  // the mutator alloc region without taking the Heap_lock. This

  // should only be used for non-humongous allocations.

  inline HeapWord* attempt_allocation(size_t word_size,

                                      unsigned int* gc_count_before_ret);