1 /*
   2  * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef SHARE_VM_GC_IMPLEMENTATION_PARALLELSCAVENGE_PARALLELSCAVENGEHEAP_HPP
  26 #define SHARE_VM_GC_IMPLEMENTATION_PARALLELSCAVENGE_PARALLELSCAVENGEHEAP_HPP
  27 
  28 #include "gc_implementation/parallelScavenge/objectStartArray.hpp"
  29 #include "gc_implementation/parallelScavenge/psGCAdaptivePolicyCounters.hpp"
  30 #include "gc_implementation/parallelScavenge/psOldGen.hpp"
  31 #include "gc_implementation/parallelScavenge/psYoungGen.hpp"
  32 #include "gc_implementation/shared/gcPolicyCounters.hpp"
  33 #include "gc_interface/collectedHeap.inline.hpp"
  34 #include "utilities/ostream.hpp"
  35 
  36 class AdjoiningGenerations;
  37 class GCTaskManager;
  38 class PSAdaptiveSizePolicy;
  39 class GenerationSizer;
  40 class CollectorPolicy;
  41 
  42 class ParallelScavengeHeap : public CollectedHeap {
  43   friend class VMStructs;
  44  private:
  45   static PSYoungGen* _young_gen;
  46   static PSOldGen*   _old_gen;
  47 
  48   // Sizing policy for entire heap
  49   static PSAdaptiveSizePolicy* _size_policy;
  50   static PSGCAdaptivePolicyCounters*   _gc_policy_counters;
  51 
  52   static ParallelScavengeHeap* _psh;
  53 
  54   size_t _young_gen_alignment;
  55   size_t _old_gen_alignment;
  56 
  57   GenerationSizer* _collector_policy;
  58 
  59   inline size_t set_alignment(size_t& var, size_t val);
  60 
  61   // Collection of generations that are adjacent in the
  62   // space reserved for the heap.
  63   AdjoiningGenerations* _gens;
  64   unsigned int _death_march_count;
  65 
  66   static GCTaskManager*          _gc_task_manager;      // The task manager.
  67 
  68  protected:
  69   static inline size_t total_invocations();
  70   HeapWord* allocate_new_tlab(size_t size);
  71 
  72   inline bool should_alloc_in_eden(size_t size) const;
  73   inline void death_march_check(HeapWord* const result, size_t size);
  74   HeapWord* mem_allocate_old_gen(size_t size);
  75 
  76  public:
  77   ParallelScavengeHeap() : CollectedHeap() {
  78     _death_march_count = 0;
  79     set_alignment(_young_gen_alignment, intra_heap_alignment());
  80     set_alignment(_old_gen_alignment, intra_heap_alignment());
  81   }
  82 
  83   // return the (conservative) maximum heap alignment
  84   static size_t max_heap_alignment() {
  85     return MAX2(os::max_page_size(), intra_heap_alignment());
  86   }
  87 
  88   // For use by VM operations
  89   enum CollectionType {
  90     Scavenge,
  91     MarkSweep
  92   };
  93 
  94   ParallelScavengeHeap::Name kind() const {
  95     return CollectedHeap::ParallelScavengeHeap;
  96   }
  97 
  98   virtual CollectorPolicy* collector_policy() const { return (CollectorPolicy*) _collector_policy; }
  99 
 100   static PSYoungGen* young_gen()     { return _young_gen; }
 101   static PSOldGen* old_gen()         { return _old_gen; }
 102 
 103   virtual PSAdaptiveSizePolicy* size_policy() { return _size_policy; }
 104 
 105   static PSGCAdaptivePolicyCounters* gc_policy_counters() { return _gc_policy_counters; }
 106 
 107   static ParallelScavengeHeap* heap();
 108 
 109   static GCTaskManager* const gc_task_manager() { return _gc_task_manager; }
 110 
 111   AdjoiningGenerations* gens() { return _gens; }
 112 
 113   // Returns JNI_OK on success
 114   virtual jint initialize();
 115 
 116   void post_initialize();
 117   void update_counters();
 118   // The alignment used for the various generations.
 119   size_t young_gen_alignment() const { return _young_gen_alignment; }
 120   size_t old_gen_alignment()  const { return _old_gen_alignment; }
 121 
 122   // The alignment used for eden and survivors within the young gen
 123   // and for boundary between young gen and old gen.
 124   static size_t intra_heap_alignment() { return 64 * K * HeapWordSize; }
 125 
 126   size_t capacity() const;
 127   size_t used() const;
 128 
 129   // Return "true" if all generations have reached the
 130   // maximal committed limit that they can reach, without a garbage
 131   // collection.
 132   virtual bool is_maximal_no_gc() const;
 133 
 134   // Return true if the reference points to an object that
 135   // can be moved in a partial collection.  For currently implemented
 136   // generational collectors that means during a collection of
 137   // the young gen.
 138   virtual bool is_scavengable(const void* addr);
 139 
 140   // Does this heap support heap inspection? (+PrintClassHistogram)
 141   bool supports_heap_inspection() const { return true; }
 142 
 143   size_t max_capacity() const;
 144 
 145   // Whether p is in the allocated part of the heap
 146   bool is_in(const void* p) const;
 147 
 148   bool is_in_reserved(const void* p) const;
 149 
 150 #ifdef ASSERT
 151   virtual bool is_in_partial_collection(const void *p);
 152 #endif
 153 
 154   bool is_in_young(oop p);        // reserved part
 155   bool is_in_old(oop p);          // reserved part
 156 
 157   // Memory allocation.   "gc_time_limit_was_exceeded" will
 158   // be set to true if the adaptive size policy determine that
 159   // an excessive amount of time is being spent doing collections
 160   // and caused a NULL to be returned.  If a NULL is not returned,
 161   // "gc_time_limit_was_exceeded" has an undefined meaning.
 162   HeapWord* mem_allocate(size_t size,
 163                          bool* gc_overhead_limit_was_exceeded);
 164 
 165   // Allocation attempt(s) during a safepoint. It should never be called
 166   // to allocate a new TLAB as this allocation might be satisfied out
 167   // of the old generation.
 168   HeapWord* failed_mem_allocate(size_t size);
 169 
 170   // Support for System.gc()
 171   void collect(GCCause::Cause cause);
 172 
 173   // These also should be called by the vm thread at a safepoint (e.g., from a
 174   // VM operation).
 175   //
 176   // The first collects the young generation only, unless the scavenge fails; it
 177   // will then attempt a full gc.  The second collects the entire heap; if
 178   // maximum_compaction is true, it will compact everything and clear all soft
 179   // references.
 180   inline void invoke_scavenge();
 181 
 182   // Perform a full collection
 183   virtual void do_full_collection(bool clear_all_soft_refs);
 184 
 185   bool supports_inline_contig_alloc() const { return !UseNUMA; }
 186 
 187   HeapWord** top_addr() const { return !UseNUMA ? young_gen()->top_addr() : (HeapWord**)-1; }
 188   HeapWord** end_addr() const { return !UseNUMA ? young_gen()->end_addr() : (HeapWord**)-1; }
 189 
 190   void ensure_parsability(bool retire_tlabs);
 191   void accumulate_statistics_all_tlabs();
 192   void resize_all_tlabs();
 193 
 194   size_t unsafe_max_alloc();
 195 
 196   bool supports_tlab_allocation() const { return true; }
 197 
 198   size_t tlab_capacity(Thread* thr) const;
 199   size_t unsafe_max_tlab_alloc(Thread* thr) const;
 200 
 201   // Can a compiler initialize a new object without store barriers?
 202   // This permission only extends from the creation of a new object
 203   // via a TLAB up to the first subsequent safepoint.
 204   virtual bool can_elide_tlab_store_barriers() const {
 205     return true;
 206   }
 207 
 208   virtual bool card_mark_must_follow_store() const {
 209     return false;
 210   }
 211 
 212   // Return true if we don't we need a store barrier for
 213   // initializing stores to an object at this address.
 214   virtual bool can_elide_initializing_store_barrier(oop new_obj);
 215 
 216   void oop_iterate(ExtendedOopClosure* cl);
 217   void object_iterate(ObjectClosure* cl);
 218   void safe_object_iterate(ObjectClosure* cl) { object_iterate(cl); }
 219 
 220   HeapWord* block_start(const void* addr) const;
 221   size_t block_size(const HeapWord* addr) const;
 222   bool block_is_obj(const HeapWord* addr) const;
 223 
 224   jlong millis_since_last_gc();
 225 
 226   void prepare_for_verify();
 227   virtual void print_on(outputStream* st) const;
 228   virtual void print_on_error(outputStream* st) const;
 229   virtual void print_gc_threads_on(outputStream* st) const;
 230   virtual void gc_threads_do(ThreadClosure* tc) const;
 231   virtual void print_tracing_info() const;
 232 
 233   void verify(bool silent, VerifyOption option /* ignored */);
 234 
 235   void print_heap_change(size_t prev_used);
 236 
 237   // Resize the young generation.  The reserved space for the
 238   // generation may be expanded in preparation for the resize.
 239   void resize_young_gen(size_t eden_size, size_t survivor_size);
 240 
 241   // Resize the old generation.  The reserved space for the
 242   // generation may be expanded in preparation for the resize.
 243   void resize_old_gen(size_t desired_free_space);
 244 
 245   // Save the tops of the spaces in all generations
 246   void record_gen_tops_before_GC() PRODUCT_RETURN;
 247 
 248   // Mangle the unused parts of all spaces in the heap
 249   void gen_mangle_unused_area() PRODUCT_RETURN;
 250 
 251   // Call these in sequential code around the processing of strong roots.
 252   class ParStrongRootsScope : public MarkingCodeBlobClosure::MarkScope {
 253   public:
 254     ParStrongRootsScope();
 255     ~ParStrongRootsScope();
 256   };
 257 };
 258 
 259 inline size_t ParallelScavengeHeap::set_alignment(size_t& var, size_t val)
 260 {
 261   assert(is_power_of_2((intptr_t)val), "must be a power of 2");
 262   var = round_to(val, intra_heap_alignment());
 263   return var;
 264 }
 265 
 266 #endif // SHARE_VM_GC_IMPLEMENTATION_PARALLELSCAVENGE_PARALLELSCAVENGEHEAP_HPP