1 /*
   2  * Copyright (c) 2003, 2015, 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_SERVICES_MEMORYSERVICE_HPP
  26 #define SHARE_VM_SERVICES_MEMORYSERVICE_HPP
  27 
  28 #include "gc/shared/gcCause.hpp"
  29 #include "gc/shared/generation.hpp"
  30 #include "logging/log.hpp"
  31 #include "memory/allocation.hpp"
  32 #include "runtime/handles.hpp"
  33 #include "services/memoryUsage.hpp"
  34 
  35 // Forward declaration
  36 class MemoryPool;
  37 class MemoryManager;
  38 class GCMemoryManager;
  39 class CollectedHeap;
  40 class Generation;
  41 class DefNewGeneration;
  42 class PSYoungGen;
  43 class PSOldGen;
  44 class CodeHeap;
  45 class ContiguousSpace;
  46 class CompactibleFreeListSpace;
  47 class GenCollectedHeap;
  48 class ParallelScavengeHeap;
  49 class G1CollectedHeap;
  50 class ShenandoahHeap;
  51 
  52 // VM Monitoring and Management Support
  53 
  54 class MemoryService : public AllStatic {
  55 private:
  56   enum {
  57     init_pools_list_size = 10,
  58     init_managers_list_size = 5,
  59     init_code_heap_pools_size = 9
  60   };
  61 
  62   static GrowableArray<MemoryPool*>*    _pools_list;
  63   static GrowableArray<MemoryManager*>* _managers_list;
  64 
  65   // memory managers for minor and major GC statistics
  66   static GCMemoryManager*               _major_gc_manager;
  67   static GCMemoryManager*               _minor_gc_manager;
  68 
  69   // memory manager and code heap pools for the CodeCache
  70   static MemoryManager*                 _code_cache_manager;
  71   static GrowableArray<MemoryPool*>*    _code_heap_pools;
  72 
  73   static MemoryPool*                    _metaspace_pool;
  74   static MemoryPool*                    _compressed_class_pool;
  75 
  76   static void add_generation_memory_pool(Generation* gen,
  77                                          MemoryManager* major_mgr,
  78                                          MemoryManager* minor_mgr);
  79   static void add_generation_memory_pool(Generation* gen,
  80                                          MemoryManager* major_mgr) {
  81     add_generation_memory_pool(gen, major_mgr, NULL);
  82   }
  83 
  84 
  85   static void add_psYoung_memory_pool(PSYoungGen* young_gen,
  86                                       MemoryManager* major_mgr,
  87                                       MemoryManager* minor_mgr);
  88   static void add_psOld_memory_pool(PSOldGen* old_gen,
  89                                     MemoryManager* mgr);
  90 
  91   static void add_g1YoungGen_memory_pool(G1CollectedHeap* g1h,
  92                                          MemoryManager* major_mgr,
  93                                          MemoryManager* minor_mgr);
  94   static void add_g1OldGen_memory_pool(G1CollectedHeap* g1h,
  95                                        MemoryManager* mgr);
  96 
  97   static void add_shenandoah_memory_pool(ShenandoahHeap* pgc,
  98                                          MemoryManager* mgr,
  99                                          bool global);
 100 
 101   static MemoryPool* add_space(ContiguousSpace* space,
 102                                const char* name,
 103                                bool is_heap,
 104                                size_t max_size,
 105                                bool support_usage_threshold);
 106   static MemoryPool* add_survivor_spaces(DefNewGeneration* young_gen,
 107                                          const char* name,
 108                                          bool is_heap,
 109                                          size_t max_size,
 110                                          bool support_usage_threshold);
 111   static MemoryPool* add_gen(Generation* gen,
 112                              const char* name,
 113                              bool is_heap,
 114                              bool support_usage_threshold);
 115   static MemoryPool* add_cms_space(CompactibleFreeListSpace* space,
 116                                    const char* name,
 117                                    bool is_heap,
 118                                    size_t max_size,
 119                                    bool support_usage_threshold);
 120 
 121   static void add_gen_collected_heap_info(GenCollectedHeap* heap);
 122   static void add_parallel_scavenge_heap_info(ParallelScavengeHeap* heap);
 123   static void add_g1_heap_info(G1CollectedHeap* g1h);
 124   static void add_shenandoah_heap_info(ShenandoahHeap* heap);
 125 
 126 public:
 127   static void set_universe_heap(CollectedHeap* heap);
 128   static void add_code_heap_memory_pool(CodeHeap* heap, const char* name);
 129   static void add_metaspace_memory_pools();
 130 
 131   static MemoryPool*    get_memory_pool(instanceHandle pool);
 132   static MemoryManager* get_memory_manager(instanceHandle mgr);
 133 
 134   static const int num_memory_pools() {
 135     return _pools_list->length();
 136   }
 137   static const int num_memory_managers() {
 138     return _managers_list->length();
 139   }
 140 
 141   static MemoryPool* get_memory_pool(int index) {
 142     return _pools_list->at(index);
 143   }
 144 
 145   static MemoryManager* get_memory_manager(int index) {
 146     return _managers_list->at(index);
 147   }
 148 
 149   static void track_memory_usage();
 150   static void track_code_cache_memory_usage() {
 151     // Track memory pool usage of all CodeCache memory pools
 152     for (int i = 0; i < _code_heap_pools->length(); ++i) {
 153       track_memory_pool_usage(_code_heap_pools->at(i));
 154     }
 155   }
 156   static void track_metaspace_memory_usage() {
 157     track_memory_pool_usage(_metaspace_pool);
 158   }
 159   static void track_compressed_class_memory_usage() {
 160     track_memory_pool_usage(_compressed_class_pool);
 161   }
 162   static void track_memory_pool_usage(MemoryPool* pool);
 163 
 164   static void gc_begin(bool fullGC, bool recordGCBeginTime,
 165                        bool recordAccumulatedGCTime,
 166                        bool recordPreGCUsage, bool recordPeakUsage);
 167   static void gc_end(bool fullGC, bool recordPostGCUsage,
 168                      bool recordAccumulatedGCTime,
 169                      bool recordGCEndTime, bool countCollection,
 170                      GCCause::Cause cause);
 171 
 172   static void oops_do(OopClosure* f);
 173 
 174   static bool get_verbose() { return log_is_enabled(Info, gc); }
 175   static bool set_verbose(bool verbose);
 176 
 177   // Create an instance of java/lang/management/MemoryUsage
 178   static Handle create_MemoryUsage_obj(MemoryUsage usage, TRAPS);
 179 
 180   static const GCMemoryManager* get_minor_gc_manager() {
 181       return _minor_gc_manager;
 182   }
 183 
 184   static const GCMemoryManager* get_major_gc_manager() {
 185       return _major_gc_manager;
 186   }
 187 };
 188 
 189 class TraceMemoryManagerStats : public StackObj {
 190 private:
 191   bool         _fullGC;
 192   bool         _recordGCBeginTime;
 193   bool         _recordPreGCUsage;
 194   bool         _recordPeakUsage;
 195   bool         _recordPostGCUsage;
 196   bool         _recordAccumulatedGCTime;
 197   bool         _recordGCEndTime;
 198   bool         _countCollection;
 199   GCCause::Cause _cause;
 200 public:
 201   TraceMemoryManagerStats() {}
 202   TraceMemoryManagerStats(bool fullGC,
 203                           GCCause::Cause cause,
 204                           bool recordGCBeginTime = true,
 205                           bool recordPreGCUsage = true,
 206                           bool recordPeakUsage = true,
 207                           bool recordPostGCUsage = true,
 208                           bool recordAccumulatedGCTime = true,
 209                           bool recordGCEndTime = true,
 210                           bool countCollection = true);
 211 
 212   void initialize(bool fullGC,
 213                   GCCause::Cause cause,
 214                   bool recordGCBeginTime,
 215                   bool recordPreGCUsage,
 216                   bool recordPeakUsage,
 217                   bool recordPostGCUsage,
 218                   bool recordAccumulatedGCTime,
 219                   bool recordGCEndTime,
 220                   bool countCollection);
 221 
 222   TraceMemoryManagerStats(Generation::Name kind, GCCause::Cause cause);
 223   ~TraceMemoryManagerStats();
 224 };
 225 
 226 #endif // SHARE_VM_SERVICES_MEMORYSERVICE_HPP