1 /*
   2  * Copyright (c) 2001, 2018, 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_PARALLEL_PSOLDGEN_HPP
  26 #define SHARE_VM_GC_PARALLEL_PSOLDGEN_HPP
  27 
  28 #include "gc/parallel/mutableSpace.hpp"
  29 #include "gc/parallel/objectStartArray.hpp"
  30 #include "gc/parallel/psGenerationCounters.hpp"
  31 #include "gc/parallel/psVirtualspace.hpp"
  32 #include "gc/parallel/spaceCounters.hpp"
  33 #include "runtime/safepoint.hpp"
  34 
  35 class PSMarkSweepDecorator;
  36 
  37 class PSOldGen : public CHeapObj<mtGC> {
  38   friend class VMStructs;
  39   friend class PSPromotionManager; // Uses the cas_allocate methods
  40   friend class ParallelScavengeHeap;
  41   friend class AdjoiningGenerations;
  42 
  43  protected:
  44   MemRegion                _reserved;          // Used for simple containment tests
  45   PSVirtualSpace*          _virtual_space;     // Controls mapping and unmapping of virtual mem
  46   ObjectStartArray         _start_array;       // Keeps track of where objects start in a 512b block
  47   MutableSpace*            _object_space;      // Where all the objects live
  48 #if INCLUDE_SERIALGC
  49   PSMarkSweepDecorator*    _object_mark_sweep; // The mark sweep view of _object_space
  50 #endif
  51   const char* const        _name;              // Name of this generation.
  52 
  53   // Performance Counters
  54   PSGenerationCounters*    _gen_counters;
  55   SpaceCounters*           _space_counters;
  56 
  57   // Sizing information, in bytes, set in constructor
  58   const size_t _init_gen_size;
  59   const size_t _min_gen_size;
  60   const size_t _max_gen_size;
  61 
  62   // NVDIMM handle to expand/shrink old gen on NVDIMM.
  63   int _nvdimm_fd;
  64 
  65   // Used when initializing the _name field.
  66   static inline const char* select_name();
  67 
  68 #ifdef ASSERT
  69   void assert_block_in_covered_region(MemRegion new_memregion) {
  70     // Explictly capture current covered_region in a local
  71     MemRegion covered_region = this->start_array()->covered_region();
  72     assert(covered_region.contains(new_memregion),
  73            "new region is not in covered_region [ " PTR_FORMAT ", " PTR_FORMAT " ], "
  74            "new region [ " PTR_FORMAT ", " PTR_FORMAT " ], "
  75            "object space [ " PTR_FORMAT ", " PTR_FORMAT " ]",
  76            p2i(covered_region.start()),
  77            p2i(covered_region.end()),
  78            p2i(new_memregion.start()),
  79            p2i(new_memregion.end()),
  80            p2i(this->object_space()->used_region().start()),
  81            p2i(this->object_space()->used_region().end()));
  82   }
  83 #endif
  84 
  85   HeapWord* allocate_noexpand(size_t word_size) {
  86     // We assume the heap lock is held here.
  87     assert_locked_or_safepoint(Heap_lock);
  88     HeapWord* res = object_space()->allocate(word_size);
  89     if (res != NULL) {
  90       DEBUG_ONLY(assert_block_in_covered_region(MemRegion(res, word_size)));
  91       _start_array.allocate_block(res);
  92     }
  93     return res;
  94   }
  95 
  96   // Support for MT garbage collection. CAS allocation is lower overhead than grabbing
  97   // and releasing the heap lock, which is held during gc's anyway. This method is not
  98   // safe for use at the same time as allocate_noexpand()!
  99   HeapWord* cas_allocate_noexpand(size_t word_size) {
 100     assert(SafepointSynchronize::is_at_safepoint(), "Must only be called at safepoint");
 101     HeapWord* res = object_space()->cas_allocate(word_size);
 102     if (res != NULL) {
 103       DEBUG_ONLY(assert_block_in_covered_region(MemRegion(res, word_size)));
 104       _start_array.allocate_block(res);
 105     }
 106     return res;
 107   }
 108 
 109   // Support for MT garbage collection. See above comment.
 110   HeapWord* cas_allocate(size_t word_size) {
 111     HeapWord* res = cas_allocate_noexpand(word_size);
 112     return (res == NULL) ? expand_and_cas_allocate(word_size) : res;
 113   }
 114 
 115   HeapWord* expand_and_allocate(size_t word_size);
 116   HeapWord* expand_and_cas_allocate(size_t word_size);
 117   void expand(size_t bytes);
 118   bool expand_by(size_t bytes);
 119   bool expand_to_reserved();
 120 
 121   void shrink(size_t bytes);
 122 
 123   void post_resize();
 124 
 125  public:
 126   // Initialize the generation.
 127   PSOldGen(ReservedSpace rs, size_t alignment,
 128            size_t initial_size, size_t min_size, size_t max_size,
 129            const char* perf_data_name, int level);
 130 
 131   PSOldGen(size_t initial_size, size_t min_size, size_t max_size,
 132            const char* perf_data_name, int level);
 133 
 134   virtual void initialize(ReservedSpace rs, size_t alignment,
 135                   const char* perf_data_name, int level);
 136   void initialize_virtual_space(ReservedSpace rs, size_t alignment);
 137   virtual void initialize_work(const char* perf_data_name, int level);
 138   virtual void initialize_performance_counters(const char* perf_data_name, int level);
 139 
 140   MemRegion reserved() const                { return _reserved; }
 141   virtual size_t max_gen_size()             { return _max_gen_size; }
 142   size_t min_gen_size()                     { return _min_gen_size; }
 143   int nvdimm_fd()                           { return _nvdimm_fd; }
 144   // Returns limit on the maximum size of the generation.  This
 145   // is the same as _max_gen_size for PSOldGen but need not be
 146   // for a derived class.
 147   virtual size_t gen_size_limit();
 148 
 149   bool is_in(const void* p) const           {
 150     return _virtual_space->contains((void *)p);
 151   }
 152 
 153   bool is_in_reserved(const void* p) const {
 154     return reserved().contains(p);
 155   }
 156 
 157   MutableSpace*         object_space() const      { return _object_space; }
 158 #if INCLUDE_SERIALGC
 159   PSMarkSweepDecorator* object_mark_sweep() const { return _object_mark_sweep; }
 160 #endif
 161   ObjectStartArray*     start_array()             { return &_start_array; }
 162   PSVirtualSpace*       virtual_space() const     { return _virtual_space;}
 163 
 164   // Has the generation been successfully allocated?
 165   bool is_allocated();
 166 
 167 #if INCLUDE_SERIALGC
 168   // MarkSweep methods
 169   virtual void precompact();
 170   void adjust_pointers();
 171   void compact();
 172 #endif
 173 
 174   // Size info
 175   size_t capacity_in_bytes() const        { return object_space()->capacity_in_bytes(); }
 176   size_t used_in_bytes() const            { return object_space()->used_in_bytes(); }
 177   size_t free_in_bytes() const            { return object_space()->free_in_bytes(); }
 178 
 179   size_t capacity_in_words() const        { return object_space()->capacity_in_words(); }
 180   size_t used_in_words() const            { return object_space()->used_in_words(); }
 181   size_t free_in_words() const            { return object_space()->free_in_words(); }
 182 
 183   // Includes uncommitted memory
 184   size_t contiguous_available() const;
 185 
 186   bool is_maximal_no_gc() const {
 187     return virtual_space()->uncommitted_size() == 0;
 188   }
 189 
 190   // Calculating new sizes
 191   void resize(size_t desired_free_space);
 192 
 193   // Allocation. We report all successful allocations to the size policy
 194   // Note that the perm gen does not use this method, and should not!
 195   HeapWord* allocate(size_t word_size);
 196 
 197   // Iteration.
 198   void oop_iterate_no_header(OopClosure* cl) { object_space()->oop_iterate_no_header(cl); }
 199   void object_iterate(ObjectClosure* cl) { object_space()->object_iterate(cl); }
 200 
 201   // Debugging - do not use for time critical operations
 202   virtual void print() const;
 203   virtual void print_on(outputStream* st) const;
 204   void print_used_change(size_t prev_used) const;
 205 
 206   void verify();
 207   void verify_object_start_array();
 208 
 209   // These should not used
 210   virtual void reset_after_change();
 211 
 212   // These should not used
 213   virtual size_t available_for_expansion();
 214   virtual size_t available_for_contraction();
 215 
 216   void space_invariants() PRODUCT_RETURN;
 217 
 218   // Performance Counter support
 219   void update_counters();
 220 
 221   // Printing support
 222   virtual const char* name() const { return _name; }
 223 
 224   // set up fd for NVDIMM
 225   void setup_fd(int fd) {_nvdimm_fd = fd; }
 226   // Debugging support
 227   // Save the tops of all spaces for later use during mangling.
 228   void record_spaces_top() PRODUCT_RETURN;
 229 };
 230 
 231 #endif // SHARE_VM_GC_PARALLEL_PSOLDGEN_HPP