/*

 * Copyright (c) 2001, 2019, 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_GC_G1_HEAPREGION_HPP

#define SHARE_GC_G1_HEAPREGION_HPP

#include "gc/g1/g1BlockOffsetTable.hpp"

#include "gc/g1/g1HeapRegionTraceType.hpp"

#include "gc/g1/heapRegionTracer.hpp"

#include "gc/g1/heapRegionType.hpp"

#include "gc/g1/survRateGroup.hpp"

#include "gc/shared/ageTable.hpp"

#include "gc/shared/spaceDecorator.hpp"

#include "gc/shared/verifyOption.hpp"

#include "runtime/mutex.hpp"

#include "utilities/macros.hpp"

class G1CollectedHeap;

class G1CMBitMap;

class HeapRegionRemSet;

class HeapRegion;

class HeapRegionSetBase;

class nmethod;

#define HR_FORMAT "%u:(%s)[" PTR_FORMAT "," PTR_FORMAT "," PTR_FORMAT "]"

#define HR_FORMAT_PARAMS(_hr_) \

                (_hr_)->hrm_index(), \

                (_hr_)->get_short_type_str(), \

                p2i((_hr_)->bottom()), p2i((_hr_)->top()), p2i((_hr_)->end())

// sentinel value for hrm_index

#define G1_NO_HRM_INDEX ((uint) -1)

// A HeapRegion is the smallest piece of a G1CollectedHeap that

// can be collected independently.

// Each heap region is self contained. top() and end() can never

// be set beyond the end of the region. For humongous objects,

// the first region is a StartsHumongous region. If the humongous

// object is larger than a heap region, the following regions will

// be of type ContinuesHumongous. In this case the top() of the

// StartHumongous region and all ContinuesHumongous regions except

// the last will point to their own end. The last ContinuesHumongous

// region may have top() equal the end of object if there isn't

// room for filler objects to pad out to the end of the region.

class HeapRegion : public CHeapObj<mtGC> {

  friend class VMStructs;

  HeapWord* _bottom;

  HeapWord* _end;

  HeapWord* volatile _top;

  HeapWord* _compaction_top;

  G1BlockOffsetTablePart _bot_part;

  Mutex _par_alloc_lock;

  // When we need to retire an allocation region, while other threads

  // are also concurrently trying to allocate into it, we typically

  // allocate a dummy object at the end of the region to ensure that

  // no more allocations can take place in it. However, sometimes we

  // want to know where the end of the last "real" object we allocated

  // into the region was and this is what this keeps track.

  HeapWord* _pre_dummy_top;

public:

  void set_bottom(HeapWord* value) { _bottom = value; }

  HeapWord* bottom() const         { return _bottom; }

  void set_end(HeapWord* value)    { _end = value; }

  HeapWord* end() const            { return _end;    }

  void set_compaction_top(HeapWord* compaction_top) { _compaction_top = compaction_top; }

  HeapWord* compaction_top() const { return _compaction_top; }

  void set_top(HeapWord* value) { _top = value; }

  HeapWord* top() const { return _top; }

  // Returns true iff the given the heap  region contains the

  // given address as part of an allocated object. This may

  // be a potentially, so we restrict its use to assertion checks only.

  bool is_in(const void* p) const {

    return is_in_reserved(p);

  }

  bool is_in(oop obj) const {

    return is_in((void*)obj);

  }

  // Returns true iff the given reserved memory of the space contains the

  // given address.

  bool is_in_reserved(const void* p) const { return _bottom <= p && p < _end; }

  size_t capacity()     const { return byte_size(bottom(), end()); }

  size_t used() const { return byte_size(bottom(), top()); }

  size_t free() const { return byte_size(top(), end()); }

  bool is_empty() const { return used() == 0; }

private:

  void reset_after_compaction() { set_top(compaction_top()); }

  // Try to allocate at least min_word_size and up to desired_size from this region.

  // Returns NULL if not possible, otherwise sets actual_word_size to the amount of

  // space allocated.

  // This version assumes that all allocation requests to this HeapRegion are properly

  // synchronized.

  inline HeapWord* allocate_impl(size_t min_word_size, size_t desired_word_size, size_t* actual_word_size);

  // Try to allocate at least min_word_size and up to desired_size from this HeapRegion.

  // Returns NULL if not possible, otherwise sets actual_word_size to the amount of

  // space allocated.

  // This version synchronizes with other calls to par_allocate_impl().

  inline HeapWord* par_allocate_impl(size_t min_word_size, size_t desired_word_size, size_t* actual_word_size);

public:

  // Allocation (return NULL if full).  Assumes the caller has established

  // mutually exclusive access to the HeapRegion.

  HeapWord* allocate(size_t min_word_size, size_t desired_word_size, size_t* actual_word_size);

  // Allocation (return NULL if full).  Enforces mutual exclusion internally.

  HeapWord* par_allocate(size_t min_word_size, size_t desired_word_size, size_t* actual_word_size);

  HeapWord* allocate(size_t word_size);

  HeapWord* par_allocate(size_t word_size);

  HeapWord* initialize_threshold();

  HeapWord* cross_threshold(HeapWord* start, HeapWord* end);

  void reset_bot() {

    _bot_part.reset_bot();

  }

private:

  // The remembered set for this region.

  HeapRegionRemSet* _rem_set;

  uint  _hrm_index;

  HeapRegionType _type;

  // For a humongous region, region in which it starts.

  HeapRegion* _humongous_start_region;

  // True iff an attempt to evacuate an object in the region failed.

  bool _evacuation_failed;

  // Fields used by the HeapRegionSetBase class and subclasses.

  HeapRegion* _next;

  HeapRegion* _prev;

#ifdef ASSERT

  HeapRegionSetBase* _containing_set;

#endif // ASSERT

  // The start of the unmarked area. The unmarked area extends from this

  // word until the top and/or end of the region, and is the part

  // of the region for which no marking was done, i.e. objects may

  // have been allocated in this part since the last mark phase.

  // "prev" is the top at the start of the last completed marking.

  // "next" is the top at the start of the in-progress marking (if any.)

  HeapWord* _prev_top_at_mark_start;

  HeapWord* _next_top_at_mark_start;

  void init_top_at_mark_start() {

    assert(_prev_marked_bytes == 0 &&

           _next_marked_bytes == 0,

           "Must be called after zero_marked_bytes.");

  }

  // Cached attributes used in the collection set policy information

  // for the collection set.

  size_t _recorded_rs_length;

  // The predicted elapsed time that was added to total value

  // for the collection set.

  double _predicted_elapsed_time_ms;

  uint _node_index;

  // Iterate over the references covered by the given MemRegion in a humongous

  // object and apply the given closure to them.

  // Humongous objects are allocated directly in the old-gen. So we need special

  // handling for concurrent processing encountering an in-progress allocation.

  // Returns the address after the last actually scanned or NULL if the area could

  // not be scanned (That should only happen when invoked concurrently with the

  // mutator).

  template <class Closure, bool is_gc_active>

  inline HeapWord* do_oops_on_memregion_in_humongous(MemRegion mr,

                                                     Closure* cl,

                                                     G1CollectedHeap* g1h);

  // Returns the block size of the given (dead, potentially having its class unloaded) object

  // starting at p extending to at most the prev TAMS using the given mark bitmap.

  inline size_t block_size_using_bitmap(const HeapWord* p, const G1CMBitMap* const prev_bitmap) const;

public:

  HeapRegion(uint hrm_index, G1BlockOffsetTable* bot, MemRegion mr);

  // Initializing the HeapRegion not only resets the data structure, but also

  // resets the BOT for that heap region.

  // The default values for clear_space means that we will do the clearing if

  // there's clearing to be done ourselves. We also always mangle the space.

  void initialize(MemRegion mr, bool clear_space = false, bool mangle_space = SpaceDecorator::Mangle);

  static int    LogOfHRGrainBytes;

  static int    LogOfHRGrainWords;

  static int    LogCardsPerRegion;

  static size_t GrainBytes;

  static size_t GrainWords;

  static size_t CardsPerRegion;

  static size_t align_up_to_region_byte_size(size_t sz) {

    return (sz + (size_t) GrainBytes - 1) &

                                      ~((1 << (size_t) LogOfHRGrainBytes) - 1);

  }

  // Returns whether a field is in the same region as the obj it points to.

  template <typename T>

  static bool is_in_same_region(T* p, oop obj) {

    assert(p != NULL, "p can't be NULL");

    assert(obj != NULL, "obj can't be NULL");

    return (((uintptr_t) p ^ cast_from_oop<uintptr_t>(obj)) >> LogOfHRGrainBytes) == 0;

  }

  static size_t max_region_size();

  static size_t min_region_size_in_words();

  // It sets up the heap region size (GrainBytes / GrainWords), as

  // well as other related fields that are based on the heap region

  // size (LogOfHRGrainBytes / LogOfHRGrainWords /

  // CardsPerRegion). All those fields are considered constant

  // throughout the JVM's execution, therefore they should only be set

  // up once during initialization time.

  static void setup_heap_region_size(size_t initial_heap_size, size_t max_heap_size);

  // The number of bytes marked live in the region in the last marking phase.

  size_t marked_bytes()    { return _prev_marked_bytes; }

  size_t live_bytes() {

    return (top() - prev_top_at_mark_start()) * HeapWordSize + marked_bytes();

  }

  // The number of bytes counted in the next marking.

  size_t next_marked_bytes() { return _next_marked_bytes; }

  // The number of bytes live wrt the next marking.

  size_t next_live_bytes() {

    return

      (top() - next_top_at_mark_start()) * HeapWordSize + next_marked_bytes();

  }

  // A lower bound on the amount of garbage bytes in the region.

  size_t garbage_bytes() {

    size_t used_at_mark_start_bytes =

      (prev_top_at_mark_start() - bottom()) * HeapWordSize;

    return used_at_mark_start_bytes - marked_bytes();

  }

  // Return the amount of bytes we'll reclaim if we collect this

  // region. This includes not only the known garbage bytes in the

  // region but also any unallocated space in it, i.e., [top, end),

  // since it will also be reclaimed if we collect the region.

  size_t reclaimable_bytes() {

    size_t known_live_bytes = live_bytes();

    assert(known_live_bytes <= capacity(), "sanity");

    return capacity() - known_live_bytes;

  }

  // An upper bound on the number of live bytes in the region.

  size_t max_live_bytes() { return used() - garbage_bytes(); }

  void add_to_marked_bytes(size_t incr_bytes) {

    _next_marked_bytes = _next_marked_bytes + incr_bytes;

  }

  void zero_marked_bytes()      {

    _prev_marked_bytes = _next_marked_bytes = 0;

  }

  const char* get_type_str() const { return _type.get_str(); }

  const char* get_short_type_str() const { return _type.get_short_str(); }

  G1HeapRegionTraceType::Type get_trace_type() { return _type.get_trace_type(); }

  bool is_free() const { return _type.is_free(); }

  bool is_young()    const { return _type.is_young();    }

  bool is_eden()     const { return _type.is_eden();     }

  bool is_survivor() const { return _type.is_survivor(); }

  bool is_humongous() const { return _type.is_humongous(); }

  bool is_starts_humongous() const { return _type.is_starts_humongous(); }

  bool is_continues_humongous() const { return _type.is_continues_humongous();   }

  bool is_old() const { return _type.is_old(); }

  bool is_old_or_humongous() const { return _type.is_old_or_humongous(); }

  bool is_old_or_humongous_or_archive() const { return _type.is_old_or_humongous_or_archive(); }

  // A pinned region contains objects which are not moved by garbage collections.

  // Humongous regions and archive regions are pinned.

  bool is_pinned() const { return _type.is_pinned(); }

  // An archive region is a pinned region, also tagged as old, which

  // should not be marked during mark/sweep. This allows the address

  // space to be shared by JVM instances.

  bool is_archive()        const { return _type.is_archive(); }

  bool is_open_archive()   const { return _type.is_open_archive(); }

  bool is_closed_archive() const { return _type.is_closed_archive(); }

  // For a humongous region, region in which it starts.

  HeapRegion* humongous_start_region() const {

    return _humongous_start_region;

  }

  // Makes the current region be a "starts humongous" region, i.e.,

  // the first region in a series of one or more contiguous regions

  // that will contain a single "humongous" object.

  //

  // obj_top : points to the top of the humongous object.

  // fill_size : size of the filler object at the end of the region series.

  void set_starts_humongous(HeapWord* obj_top, size_t fill_size);

  // Makes the current region be a "continues humongous'

  // region. first_hr is the "start humongous" region of the series

  // which this region will be part of.

  void set_continues_humongous(HeapRegion* first_hr);

  // Unsets the humongous-related fields on the region.

  void clear_humongous();

  // If the region has a remembered set, return a pointer to it.

  HeapRegionRemSet* rem_set() const {

    return _rem_set;

  }

  inline bool in_collection_set() const;

  // Methods used by the HeapRegionSetBase class and subclasses.

  // Getter and setter for the next and prev fields used to link regions into

  // linked lists.

  HeapRegion* next()              { return _next; }

  void set_prev(HeapRegion* prev) { _prev = prev; }

  // Every region added to a set is tagged with a reference to that

  // set. This is used for doing consistency checking to make sure that

  // the contents of a set are as they should be and it's only

  // available in non-product builds.

#ifdef ASSERT

  void set_containing_set(HeapRegionSetBase* containing_set) {

    assert((containing_set == NULL && _containing_set != NULL) ||

           (containing_set != NULL && _containing_set == NULL),

           "containing_set: " PTR_FORMAT " "

           "_containing_set: " PTR_FORMAT,

           p2i(containing_set), p2i(_containing_set));

    _containing_set = containing_set;

  }