1 /*
   2  * Copyright (c) 2003, 2012, 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 #include "precompiled.hpp"
  26 #include "classfile/systemDictionary.hpp"
  27 #include "classfile/vmSymbols.hpp"
  28 #include "oops/oop.inline.hpp"
  29 #include "runtime/handles.inline.hpp"
  30 #include "runtime/javaCalls.hpp"
  31 #include "services/lowMemoryDetector.hpp"
  32 #include "services/management.hpp"
  33 #include "services/memoryManager.hpp"
  34 #include "services/memoryPool.hpp"
  35 #include "services/memoryService.hpp"
  36 #include "services/gcNotifier.hpp"
  37 #include "utilities/dtrace.hpp"
  38 
  39 #ifndef USDT2
  40 HS_DTRACE_PROBE_DECL8(hotspot, mem__pool__gc__begin, char*, int, char*, int,
  41   size_t, size_t, size_t, size_t);
  42 HS_DTRACE_PROBE_DECL8(hotspot, mem__pool__gc__end, char*, int, char*, int,
  43   size_t, size_t, size_t, size_t);
  44 #endif /* !USDT2 */
  45 
  46 MemoryManager::MemoryManager() {
  47   _num_pools = 0;
  48   _memory_mgr_obj = NULL;
  49 }
  50 
  51 void MemoryManager::add_pool(MemoryPool* pool) {
  52   assert(_num_pools < MemoryManager::max_num_pools, "_num_pools exceeds the max");
  53   if (_num_pools < MemoryManager::max_num_pools) {
  54     _pools[_num_pools] = pool;
  55     _num_pools++;
  56   }
  57   pool->add_manager(this);
  58 }
  59 
  60 MemoryManager* MemoryManager::get_code_cache_memory_manager() {
  61   return (MemoryManager*) new CodeCacheMemoryManager();
  62 }
  63 
  64 MemoryManager* MemoryManager::get_metaspace_memory_manager() {
  65   return (MemoryManager*) new MetaspaceMemoryManager();
  66 }
  67 
  68 GCMemoryManager* MemoryManager::get_copy_memory_manager() {
  69   return (GCMemoryManager*) new CopyMemoryManager();
  70 }
  71 
  72 GCMemoryManager* MemoryManager::get_msc_memory_manager() {
  73   return (GCMemoryManager*) new MSCMemoryManager();
  74 }
  75 
  76 GCMemoryManager* MemoryManager::get_parnew_memory_manager() {
  77   return (GCMemoryManager*) new ParNewMemoryManager();
  78 }
  79 
  80 GCMemoryManager* MemoryManager::get_cms_memory_manager() {
  81   return (GCMemoryManager*) new CMSMemoryManager();
  82 }
  83 
  84 GCMemoryManager* MemoryManager::get_psScavenge_memory_manager() {
  85   return (GCMemoryManager*) new PSScavengeMemoryManager();
  86 }
  87 
  88 GCMemoryManager* MemoryManager::get_psMarkSweep_memory_manager() {
  89   return (GCMemoryManager*) new PSMarkSweepMemoryManager();
  90 }
  91 
  92 GCMemoryManager* MemoryManager::get_g1YoungGen_memory_manager() {
  93   return (GCMemoryManager*) new G1YoungGenMemoryManager();
  94 }
  95 
  96 GCMemoryManager* MemoryManager::get_g1OldGen_memory_manager() {
  97   return (GCMemoryManager*) new G1OldGenMemoryManager();
  98 }
  99 
 100 instanceOop MemoryManager::get_memory_manager_instance(TRAPS) {
 101   // Must do an acquire so as to force ordering of subsequent
 102   // loads from anything _memory_mgr_obj points to or implies.
 103   instanceOop mgr_obj = (instanceOop)OrderAccess::load_ptr_acquire(&_memory_mgr_obj);
 104   if (mgr_obj == NULL) {
 105     // It's ok for more than one thread to execute the code up to the locked region.
 106     // Extra manager instances will just be gc'ed.
 107     Klass* k = Management::sun_management_ManagementFactory_klass(CHECK_0);
 108     instanceKlassHandle ik(THREAD, k);
 109 
 110     Handle mgr_name = java_lang_String::create_from_str(name(), CHECK_0);
 111 
 112     JavaValue result(T_OBJECT);
 113     JavaCallArguments args;
 114     args.push_oop(mgr_name);    // Argument 1
 115 
 116     Symbol* method_name = NULL;
 117     Symbol* signature = NULL;
 118     if (is_gc_memory_manager()) {
 119       method_name = vmSymbols::createGarbageCollector_name();
 120       signature = vmSymbols::createGarbageCollector_signature();
 121       args.push_oop(Handle());      // Argument 2 (for future extension)
 122     } else {
 123       method_name = vmSymbols::createMemoryManager_name();
 124       signature = vmSymbols::createMemoryManager_signature();
 125     }
 126 
 127     JavaCalls::call_static(&result,
 128                            ik,
 129                            method_name,
 130                            signature,
 131                            &args,
 132                            CHECK_0);
 133 
 134     instanceOop m = (instanceOop) result.get_jobject();
 135     instanceHandle mgr(THREAD, m);
 136 
 137     {
 138       // Get lock before setting _memory_mgr_obj
 139       // since another thread may have created the instance
 140       MutexLocker ml(Management_lock);
 141 
 142       // Check if another thread has created the management object.  We reload
 143       // _memory_mgr_obj here because some other thread may have initialized
 144       // it while we were executing the code before the lock.
 145       //
 146       // The lock has done an acquire, so the load can't float above it, but
 147       // we need to do a load_acquire as above.
 148       mgr_obj = (instanceOop)OrderAccess::load_ptr_acquire(&_memory_mgr_obj);
 149       if (mgr_obj != NULL) {
 150          return mgr_obj;
 151       }
 152 
 153       // Get the address of the object we created via call_special.
 154       mgr_obj = mgr();
 155 
 156       // Use store barrier to make sure the memory accesses associated
 157       // with creating the management object are visible before publishing
 158       // its address.  The unlock will publish the store to _memory_mgr_obj
 159       // because it does a release first.
 160       OrderAccess::release_store_ptr(&_memory_mgr_obj, mgr_obj);
 161     }
 162   }
 163 
 164   return mgr_obj;
 165 }
 166 
 167 void MemoryManager::oops_do(OopClosure* f) {
 168   f->do_oop((oop*) &_memory_mgr_obj);
 169 }
 170 
 171 GCStatInfo::GCStatInfo(int num_pools) {
 172   // initialize the arrays for memory usage
 173   _before_gc_usage_array = (MemoryUsage*) NEW_C_HEAP_ARRAY(MemoryUsage, num_pools, mtInternal);
 174   _after_gc_usage_array  = (MemoryUsage*) NEW_C_HEAP_ARRAY(MemoryUsage, num_pools, mtInternal);
 175   _usage_array_size = num_pools;
 176   clear();
 177 }
 178 
 179 GCStatInfo::~GCStatInfo() {
 180   FREE_C_HEAP_ARRAY(MemoryUsage*, _before_gc_usage_array, mtInternal);
 181   FREE_C_HEAP_ARRAY(MemoryUsage*, _after_gc_usage_array, mtInternal);
 182 }
 183 
 184 void GCStatInfo::set_gc_usage(int pool_index, MemoryUsage usage, bool before_gc) {
 185   MemoryUsage* gc_usage_array;
 186   if (before_gc) {
 187     gc_usage_array = _before_gc_usage_array;
 188   } else {
 189     gc_usage_array = _after_gc_usage_array;
 190   }
 191   gc_usage_array[pool_index] = usage;
 192 }
 193 
 194 void GCStatInfo::clear() {
 195   _index = 0;
 196   _start_time = 0L;
 197   _end_time = 0L;
 198   size_t len = _usage_array_size * sizeof(MemoryUsage);
 199   memset(_before_gc_usage_array, 0, len);
 200   memset(_after_gc_usage_array, 0, len);
 201 }
 202 
 203 
 204 GCMemoryManager::GCMemoryManager() : MemoryManager() {
 205   _num_collections = 0;
 206   _last_gc_stat = NULL;
 207   _last_gc_lock = new Mutex(Mutex::leaf, "_last_gc_lock", true);
 208   _current_gc_stat = NULL;
 209   _num_gc_threads = 1;
 210   _notification_enabled = false;
 211 }
 212 
 213 GCMemoryManager::~GCMemoryManager() {
 214   delete _last_gc_stat;
 215   delete _last_gc_lock;
 216   delete _current_gc_stat;
 217 }
 218 
 219 void GCMemoryManager::initialize_gc_stat_info() {
 220   assert(MemoryService::num_memory_pools() > 0, "should have one or more memory pools");
 221   _last_gc_stat = new(ResourceObj::C_HEAP, mtGC) GCStatInfo(MemoryService::num_memory_pools());
 222   _current_gc_stat = new(ResourceObj::C_HEAP, mtGC) GCStatInfo(MemoryService::num_memory_pools());
 223   // tracking concurrent collections we need two objects: one to update, and one to
 224   // hold the publicly available "last (completed) gc" information.
 225 }
 226 
 227 void GCMemoryManager::gc_begin(bool recordGCBeginTime, bool recordPreGCUsage,
 228                                bool recordAccumulatedGCTime) {
 229   assert(_last_gc_stat != NULL && _current_gc_stat != NULL, "Just checking");
 230   if (recordAccumulatedGCTime) {
 231     _accumulated_timer.start();
 232   }
 233   // _num_collections now increases in gc_end, to count completed collections
 234   if (recordGCBeginTime) {
 235     _current_gc_stat->set_index(_num_collections+1);
 236     _current_gc_stat->set_start_time(Management::timestamp());
 237   }
 238 
 239   if (recordPreGCUsage) {
 240     // Keep memory usage of all memory pools
 241     for (int i = 0; i < MemoryService::num_memory_pools(); i++) {
 242       MemoryPool* pool = MemoryService::get_memory_pool(i);
 243       MemoryUsage usage = pool->get_memory_usage();
 244       _current_gc_stat->set_before_gc_usage(i, usage);
 245 #ifndef USDT2
 246       HS_DTRACE_PROBE8(hotspot, mem__pool__gc__begin,
 247         name(), strlen(name()),
 248         pool->name(), strlen(pool->name()),
 249         usage.init_size(), usage.used(),
 250         usage.committed(), usage.max_size());
 251 #else /* USDT2 */
 252       HOTSPOT_MEM_POOL_GC_BEGIN(
 253         (char *) name(), strlen(name()),
 254         (char *) pool->name(), strlen(pool->name()),
 255         usage.init_size(), usage.used(),
 256         usage.committed(), usage.max_size());
 257 #endif /* USDT2 */
 258     }
 259   }
 260 }
 261 
 262 // A collector MUST, even if it does not complete for some reason,
 263 // make a TraceMemoryManagerStats object where countCollection is true,
 264 // to ensure the current gc stat is placed in _last_gc_stat.
 265 void GCMemoryManager::gc_end(bool recordPostGCUsage,
 266                              bool recordAccumulatedGCTime,
 267                              bool recordGCEndTime, bool countCollection,
 268                              GCCause::Cause cause) {
 269   if (recordAccumulatedGCTime) {
 270     _accumulated_timer.stop();
 271   }
 272   if (recordGCEndTime) {
 273     _current_gc_stat->set_end_time(Management::timestamp());
 274   }
 275 
 276   if (recordPostGCUsage) {
 277     int i;
 278     // keep the last gc statistics for all memory pools
 279     for (i = 0; i < MemoryService::num_memory_pools(); i++) {
 280       MemoryPool* pool = MemoryService::get_memory_pool(i);
 281       MemoryUsage usage = pool->get_memory_usage();
 282 
 283 #ifndef USDT2
 284       HS_DTRACE_PROBE8(hotspot, mem__pool__gc__end,
 285         name(), strlen(name()),
 286         pool->name(), strlen(pool->name()),
 287         usage.init_size(), usage.used(),
 288         usage.committed(), usage.max_size());
 289 #else /* USDT2 */
 290       HOTSPOT_MEM_POOL_GC_END(
 291         (char *) name(), strlen(name()),
 292         (char *) pool->name(), strlen(pool->name()),
 293         usage.init_size(), usage.used(),
 294         usage.committed(), usage.max_size());
 295 #endif /* USDT2 */
 296 
 297       _current_gc_stat->set_after_gc_usage(i, usage);
 298     }
 299 
 300     // Set last collection usage of the memory pools managed by this collector
 301     for (i = 0; i < num_memory_pools(); i++) {
 302       MemoryPool* pool = get_memory_pool(i);
 303       MemoryUsage usage = pool->get_memory_usage();
 304 
 305       // Compare with GC usage threshold
 306       pool->set_last_collection_usage(usage);
 307       LowMemoryDetector::detect_after_gc_memory(pool);
 308     }
 309   }
 310 
 311   if (countCollection) {
 312     _num_collections++;
 313     // alternately update two objects making one public when complete
 314     {
 315       MutexLockerEx ml(_last_gc_lock, Mutex::_no_safepoint_check_flag);
 316       GCStatInfo *tmp = _last_gc_stat;
 317       _last_gc_stat = _current_gc_stat;
 318       _current_gc_stat = tmp;
 319       // reset the current stat for diagnosability purposes
 320       _current_gc_stat->clear();
 321     }
 322 
 323     if (is_notification_enabled()) {
 324       bool isMajorGC = this == MemoryService::get_major_gc_manager();
 325       GCNotifier::pushNotification(this, isMajorGC ? "end of major GC" : "end of minor GC",
 326                                    GCCause::to_string(cause));
 327     }
 328   }
 329 }
 330 
 331 size_t GCMemoryManager::get_last_gc_stat(GCStatInfo* dest) {
 332   MutexLockerEx ml(_last_gc_lock, Mutex::_no_safepoint_check_flag);
 333   if (_last_gc_stat->gc_index() != 0) {
 334     dest->set_index(_last_gc_stat->gc_index());
 335     dest->set_start_time(_last_gc_stat->start_time());
 336     dest->set_end_time(_last_gc_stat->end_time());
 337     assert(dest->usage_array_size() == _last_gc_stat->usage_array_size(),
 338            "Must have same array size");
 339     size_t len = dest->usage_array_size() * sizeof(MemoryUsage);
 340     memcpy(dest->before_gc_usage_array(), _last_gc_stat->before_gc_usage_array(), len);
 341     memcpy(dest->after_gc_usage_array(), _last_gc_stat->after_gc_usage_array(), len);
 342   }
 343   return _last_gc_stat->gc_index();
 344 }