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