1 /*
   2  * Copyright (c) 2003, 2005, 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 // A memory manager is responsible for managing one or more memory pools.
  26 // The garbage collector is one type of memory managers responsible
  27 // for reclaiming memory occupied by unreachable objects.  A Java virtual
  28 // machine may have one or more memory managers.   It may
  29 // add or remove memory managers during execution.
  30 // A memory pool can be managed by more than one memory managers.
  31 
  32 class MemoryPool;
  33 class GCMemoryManager;
  34 class OopClosure;
  35 
  36 class MemoryManager : public CHeapObj {
  37 private:
  38   enum {
  39     max_num_pools = 10
  40   };
  41 
  42   MemoryPool* _pools[max_num_pools];
  43   int         _num_pools;
  44 
  45 protected:
  46   volatile instanceOop _memory_mgr_obj;
  47 
  48 public:
  49   enum Name {
  50     Abstract,
  51     CodeCache,
  52     Copy,
  53     MarkSweepCompact,
  54     ParNew,
  55     ConcurrentMarkSweep,
  56     PSScavenge,
  57     PSMarkSweep,
  58     G1YoungGen,
  59     G1OldGen
  60   };
  61 
  62   MemoryManager();
  63 
  64   int num_memory_pools() const           { return _num_pools; }
  65   MemoryPool* get_memory_pool(int index) {
  66     assert(index >= 0 && index < _num_pools, "Invalid index");
  67     return _pools[index];
  68   }
  69 
  70   void add_pool(MemoryPool* pool);
  71 
  72   bool is_manager(instanceHandle mh)     { return mh() == _memory_mgr_obj; }
  73 
  74   virtual instanceOop get_memory_manager_instance(TRAPS);
  75   virtual MemoryManager::Name kind()     { return MemoryManager::Abstract; }
  76   virtual bool is_gc_memory_manager()    { return false; }
  77   virtual const char* name() = 0;
  78 
  79   // GC support
  80   void oops_do(OopClosure* f);
  81 
  82   // Static factory methods to get a memory manager of a specific type
  83   static MemoryManager*   get_code_cache_memory_manager();
  84   static GCMemoryManager* get_copy_memory_manager();
  85   static GCMemoryManager* get_msc_memory_manager();
  86   static GCMemoryManager* get_parnew_memory_manager();
  87   static GCMemoryManager* get_cms_memory_manager();
  88   static GCMemoryManager* get_psScavenge_memory_manager();
  89   static GCMemoryManager* get_psMarkSweep_memory_manager();
  90   static GCMemoryManager* get_g1YoungGen_memory_manager();
  91   static GCMemoryManager* get_g1OldGen_memory_manager();
  92 
  93 };
  94 
  95 class CodeCacheMemoryManager : public MemoryManager {
  96 private:
  97 public:
  98   CodeCacheMemoryManager() : MemoryManager() {}
  99 
 100   MemoryManager::Name kind() { return MemoryManager::CodeCache; }
 101   const char* name()         { return "CodeCacheManager"; }
 102 };
 103 
 104 class GCStatInfo : public CHeapObj {
 105 private:
 106   size_t _index;
 107   jlong  _start_time;
 108   jlong  _end_time;
 109 
 110   // We keep memory usage of all memory pools
 111   MemoryUsage* _before_gc_usage_array;
 112   MemoryUsage* _after_gc_usage_array;
 113   int          _usage_array_size;
 114 
 115   void set_gc_usage(int pool_index, MemoryUsage, bool before_gc);
 116 
 117 public:
 118   GCStatInfo(int num_pools);
 119   ~GCStatInfo();
 120 
 121   size_t gc_index()               { return _index; }
 122   jlong  start_time()             { return _start_time; }
 123   jlong  end_time()               { return _end_time; }
 124   int    usage_array_size()       { return _usage_array_size; }
 125   MemoryUsage before_gc_usage_for_pool(int pool_index) {
 126     assert(pool_index >= 0 && pool_index < _usage_array_size, "Range checking");
 127     return _before_gc_usage_array[pool_index];
 128   }
 129   MemoryUsage after_gc_usage_for_pool(int pool_index) {
 130     assert(pool_index >= 0 && pool_index < _usage_array_size, "Range checking");
 131     return _after_gc_usage_array[pool_index];
 132   }
 133 
 134   void set_index(size_t index)    { _index = index; }
 135   void set_start_time(jlong time) { _start_time = time; }
 136   void set_end_time(jlong time)   { _end_time = time; }
 137   void set_before_gc_usage(int pool_index, MemoryUsage usage) {
 138     assert(pool_index >= 0 && pool_index < _usage_array_size, "Range checking");
 139     set_gc_usage(pool_index, usage, true /* before gc */);
 140   }
 141   void set_after_gc_usage(int pool_index, MemoryUsage usage) {
 142     assert(pool_index >= 0 && pool_index < _usage_array_size, "Range checking");
 143     set_gc_usage(pool_index, usage, false /* after gc */);
 144   }
 145 
 146   void copy_stat(GCStatInfo* stat);
 147 };
 148 
 149 class GCMemoryManager : public MemoryManager {
 150 private:
 151   // TODO: We should unify the GCCounter and GCMemoryManager statistic
 152   size_t       _num_collections;
 153   elapsedTimer _accumulated_timer;
 154   elapsedTimer _gc_timer;         // for measuring every GC duration
 155   GCStatInfo*  volatile _last_gc_stat;
 156   GCStatInfo*  volatile _current_gc_stat;
 157   int          _num_gc_threads;
 158 public:
 159   GCMemoryManager();
 160   ~GCMemoryManager();
 161 
 162   void   initialize_gc_stat_info();
 163 
 164   bool   is_gc_memory_manager()         { return true; }
 165   jlong  gc_time_ms()                   { return _accumulated_timer.milliseconds(); }
 166   size_t gc_count()                     { return _num_collections; }
 167   int    num_gc_threads()               { return _num_gc_threads; }
 168   void   set_num_gc_threads(int count)  { _num_gc_threads = count; }
 169 
 170   void   gc_begin(bool recordGCBeginTime, bool recordPreGCUsage,
 171                   bool recordAccumulatedGCTime);
 172   void   gc_end(bool recordPostGCUsage, bool recordAccumulatedGCTime,
 173                 bool recordGCEndTime, bool countCollection);
 174 
 175 
 176   void        reset_gc_stat()   { _num_collections = 0; _accumulated_timer.reset(); }
 177   GCStatInfo* last_gc_stat() { return _last_gc_stat; }
 178 
 179   virtual MemoryManager::Name kind() = 0;
 180 };
 181 
 182 // These subclasses of GCMemoryManager are defined to include
 183 // GC-specific information.
 184 // TODO: Add GC-specific information
 185 class CopyMemoryManager : public GCMemoryManager {
 186 private:
 187 public:
 188   CopyMemoryManager() : GCMemoryManager() {}
 189 
 190   MemoryManager::Name kind() { return MemoryManager::Copy; }
 191   const char* name()         { return "Copy"; }
 192 };
 193 
 194 class MSCMemoryManager : public GCMemoryManager {
 195 private:
 196 public:
 197   MSCMemoryManager() : GCMemoryManager() {}
 198 
 199   MemoryManager::Name kind() { return MemoryManager::MarkSweepCompact; }
 200   const char* name()         { return "MarkSweepCompact"; }
 201 
 202 };
 203 
 204 class ParNewMemoryManager : public GCMemoryManager {
 205 private:
 206 public:
 207   ParNewMemoryManager() : GCMemoryManager() {}
 208 
 209   MemoryManager::Name kind() { return MemoryManager::ParNew; }
 210   const char* name()         { return "ParNew"; }
 211 
 212 };
 213 
 214 class CMSMemoryManager : public GCMemoryManager {
 215 private:
 216 public:
 217   CMSMemoryManager() : GCMemoryManager() {}
 218 
 219   MemoryManager::Name kind() { return MemoryManager::ConcurrentMarkSweep; }
 220   const char* name()         { return "ConcurrentMarkSweep";}
 221 
 222 };
 223 
 224 class PSScavengeMemoryManager : public GCMemoryManager {
 225 private:
 226 public:
 227   PSScavengeMemoryManager() : GCMemoryManager() {}
 228 
 229   MemoryManager::Name kind() { return MemoryManager::PSScavenge; }
 230   const char* name()         { return "PS Scavenge"; }
 231 
 232 };
 233 
 234 class PSMarkSweepMemoryManager : public GCMemoryManager {
 235 private:
 236 public:
 237   PSMarkSweepMemoryManager() : GCMemoryManager() {}
 238 
 239   MemoryManager::Name kind() { return MemoryManager::PSMarkSweep; }
 240   const char* name()         { return "PS MarkSweep"; }
 241 };
 242 
 243 class G1YoungGenMemoryManager : public GCMemoryManager {
 244 private:
 245 public:
 246   G1YoungGenMemoryManager() : GCMemoryManager() {}
 247 
 248   MemoryManager::Name kind() { return MemoryManager::G1YoungGen; }
 249   const char* name()         { return "G1 Young Generation"; }
 250 };
 251 
 252 class G1OldGenMemoryManager : public GCMemoryManager {
 253 private:
 254 public:
 255   G1OldGenMemoryManager() : GCMemoryManager() {}
 256 
 257   MemoryManager::Name kind() { return MemoryManager::G1OldGen; }
 258   const char* name()         { return "G1 Old Generation"; }
 259 };