1 /* 2 * Copyright (c) 2012, 2018, 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 #include "precompiled.hpp" 25 #include "jvm.h" 26 27 #include "runtime/mutex.hpp" 28 #include "runtime/orderAccess.inline.hpp" 29 #include "runtime/vmThread.hpp" 30 #include "runtime/vm_operations.hpp" 31 #include "services/memBaseline.hpp" 32 #include "services/memReporter.hpp" 33 #include "services/mallocTracker.inline.hpp" 34 #include "services/memTracker.hpp" 35 #include "utilities/defaultStream.hpp" 36 #include "utilities/vmError.hpp" 37 38 #ifdef SOLARIS 39 volatile bool NMT_stack_walkable = false; 40 #else 41 volatile bool NMT_stack_walkable = true; 42 #endif 43 44 volatile NMT_TrackingLevel MemTracker::_tracking_level = NMT_unknown; 45 NMT_TrackingLevel MemTracker::_cmdline_tracking_level = NMT_unknown; 46 47 MemBaseline MemTracker::_baseline; 48 Mutex* MemTracker::_query_lock = NULL; 49 bool MemTracker::_is_nmt_env_valid = true; 50 51 52 NMT_TrackingLevel MemTracker::init_tracking_level() { 53 NMT_TrackingLevel level = NMT_off; 54 char buf[64]; 55 jio_snprintf(buf, sizeof(buf), "NMT_LEVEL_%d", os::current_process_id()); 56 const char *nmt_option = ::getenv(buf); 57 if (nmt_option != NULL) { 58 if (strcmp(nmt_option, "summary") == 0) { 59 level = NMT_summary; 60 } else if (strcmp(nmt_option, "detail") == 0) { 61 level = NMT_detail; 62 } else if (strcmp(nmt_option, "off") != 0) { 63 // The option value is invalid 64 _is_nmt_env_valid = false; 65 } 66 67 // Remove the environment variable to avoid leaking to child processes 68 os::unsetenv(buf); 69 } 70 71 // Construct NativeCallStack::EMPTY_STACK. It may get constructed twice, 72 // but it is benign, the results are the same. 73 ::new ((void*)&NativeCallStack::EMPTY_STACK) NativeCallStack(0, false); 74 75 if (!MallocTracker::initialize(level) || 76 !VirtualMemoryTracker::initialize(level)) { 77 level = NMT_off; 78 } 79 return level; 80 } 81 82 void MemTracker::init() { 83 NMT_TrackingLevel level = tracking_level(); 84 if (level >= NMT_summary) { 85 if (!VirtualMemoryTracker::late_initialize(level)) { 86 shutdown(); 87 return; 88 } 89 _query_lock = new (std::nothrow) Mutex(Monitor::max_nonleaf, "NMT_queryLock"); 90 // Already OOM. It is unlikely, but still have to handle it. 91 if (_query_lock == NULL) { 92 shutdown(); 93 } 94 } 95 } 96 97 bool MemTracker::check_launcher_nmt_support(const char* value) { 98 if (strcmp(value, "=detail") == 0) { 99 if (MemTracker::tracking_level() != NMT_detail) { 100 return false; 101 } 102 } else if (strcmp(value, "=summary") == 0) { 103 if (MemTracker::tracking_level() != NMT_summary) { 104 return false; 105 } 106 } else if (strcmp(value, "=off") == 0) { 107 if (MemTracker::tracking_level() != NMT_off) { 108 return false; 109 } 110 } else { 111 _is_nmt_env_valid = false; 112 } 113 114 return true; 115 } 116 117 bool MemTracker::verify_nmt_option() { 118 return _is_nmt_env_valid; 119 } 120 121 void* MemTracker::malloc_base(void* memblock) { 122 return MallocTracker::get_base(memblock); 123 } 124 125 void Tracker::record(address addr, size_t size) { 126 if (MemTracker::tracking_level() < NMT_summary) return; 127 switch(_type) { 128 case uncommit: 129 VirtualMemoryTracker::remove_uncommitted_region(addr, size); 130 break; 131 case release: 132 VirtualMemoryTracker::remove_released_region(addr, size); 133 break; 134 default: 135 ShouldNotReachHere(); 136 } 137 } 138 139 140 // Shutdown can only be issued via JCmd, and NMT JCmd is serialized by lock 141 void MemTracker::shutdown() { 142 // We can only shutdown NMT to minimal tracking level if it is ever on. 143 if (tracking_level () > NMT_minimal) { 144 transition_to(NMT_minimal); 145 } 146 } 147 148 bool MemTracker::transition_to(NMT_TrackingLevel level) { 149 NMT_TrackingLevel current_level = tracking_level(); 150 151 assert(level != NMT_off || current_level == NMT_off, "Cannot transition NMT to off"); 152 153 if (current_level == level) { 154 return true; 155 } else if (current_level > level) { 156 // Downgrade tracking level, we want to lower the tracking level first 157 _tracking_level = level; 158 // Make _tracking_level visible immediately. 159 OrderAccess::fence(); 160 VirtualMemoryTracker::transition(current_level, level); 161 MallocTracker::transition(current_level, level); 162 } else { 163 // Upgrading tracking level is not supported and has never been supported. 164 // Allocating and deallocating malloc tracking structures is not thread safe and 165 // leads to inconsistencies unless a lot coarser locks are added. 166 } 167 return true; 168 } 169 170 void MemTracker::report(bool summary_only, outputStream* output) { 171 assert(output != NULL, "No output stream"); 172 MemBaseline baseline; 173 if (baseline.baseline(summary_only)) { 174 if (summary_only) { 175 MemSummaryReporter rpt(baseline, output); 176 rpt.report(); 177 } else { 178 MemDetailReporter rpt(baseline, output); 179 rpt.report(); 180 output->print("Metaspace:"); 181 // Metadata reporting requires a safepoint, so avoid it if VM is not in good state. 182 assert(!VMError::fatal_error_in_progress(), "Do not report metadata in error report"); 183 VM_PrintMetadata vmop(output, K, 184 MetaspaceUtils::rf_show_loaders); 185 VMThread::execute(&vmop); 186 } 187 } 188 } 189 190 // This is a walker to gather malloc site hashtable statistics, 191 // the result is used for tuning. 192 class StatisticsWalker : public MallocSiteWalker { 193 private: 194 enum Threshold { 195 // aggregates statistics over this threshold into one 196 // line item. 197 report_threshold = 20 198 }; 199 200 private: 201 // Number of allocation sites that have all memory freed 202 int _empty_entries; 203 // Total number of allocation sites, include empty sites 204 int _total_entries; 205 // Number of captured call stack distribution 206 int _stack_depth_distribution[NMT_TrackingStackDepth]; 207 // Hash distribution 208 int _hash_distribution[report_threshold]; 209 // Number of hash buckets that have entries over the threshold 210 int _bucket_over_threshold; 211 212 // The hash bucket that walker is currently walking 213 int _current_hash_bucket; 214 // The length of current hash bucket 215 int _current_bucket_length; 216 // Number of hash buckets that are not empty 217 int _used_buckets; 218 // Longest hash bucket length 219 int _longest_bucket_length; 220 221 public: 222 StatisticsWalker() : _empty_entries(0), _total_entries(0) { 223 int index = 0; 224 for (index = 0; index < NMT_TrackingStackDepth; index ++) { 225 _stack_depth_distribution[index] = 0; 226 } 227 for (index = 0; index < report_threshold; index ++) { 228 _hash_distribution[index] = 0; 229 } 230 _bucket_over_threshold = 0; 231 _longest_bucket_length = 0; 232 _current_hash_bucket = -1; 233 _current_bucket_length = 0; 234 _used_buckets = 0; 235 } 236 237 virtual bool do_malloc_site(const MallocSite* e) { 238 if (e->size() == 0) _empty_entries ++; 239 _total_entries ++; 240 241 // stack depth distrubution 242 int frames = e->call_stack()->frames(); 243 _stack_depth_distribution[frames - 1] ++; 244 245 // hash distribution 246 int hash_bucket = e->hash() % MallocSiteTable::hash_buckets(); 247 if (_current_hash_bucket == -1) { 248 _current_hash_bucket = hash_bucket; 249 _current_bucket_length = 1; 250 } else if (_current_hash_bucket == hash_bucket) { 251 _current_bucket_length ++; 252 } else { 253 record_bucket_length(_current_bucket_length); 254 _current_hash_bucket = hash_bucket; 255 _current_bucket_length = 1; 256 } 257 return true; 258 } 259 260 // walk completed 261 void completed() { 262 record_bucket_length(_current_bucket_length); 263 } 264 265 void report_statistics(outputStream* out) { 266 int index; 267 out->print_cr("Malloc allocation site table:"); 268 out->print_cr("\tTotal entries: %d", _total_entries); 269 out->print_cr("\tEmpty entries: %d (%2.2f%%)", _empty_entries, ((float)_empty_entries * 100) / _total_entries); 270 out->print_cr(" "); 271 out->print_cr("Hash distribution:"); 272 if (_used_buckets < MallocSiteTable::hash_buckets()) { 273 out->print_cr("empty bucket: %d", (MallocSiteTable::hash_buckets() - _used_buckets)); 274 } 275 for (index = 0; index < report_threshold; index ++) { 276 if (_hash_distribution[index] != 0) { 277 if (index == 0) { 278 out->print_cr(" %d entry: %d", 1, _hash_distribution[0]); 279 } else if (index < 9) { // single digit 280 out->print_cr(" %d entries: %d", (index + 1), _hash_distribution[index]); 281 } else { 282 out->print_cr(" %d entries: %d", (index + 1), _hash_distribution[index]); 283 } 284 } 285 } 286 if (_bucket_over_threshold > 0) { 287 out->print_cr(" >%d entries: %d", report_threshold, _bucket_over_threshold); 288 } 289 out->print_cr("most entries: %d", _longest_bucket_length); 290 out->print_cr(" "); 291 out->print_cr("Call stack depth distribution:"); 292 for (index = 0; index < NMT_TrackingStackDepth; index ++) { 293 if (_stack_depth_distribution[index] > 0) { 294 out->print_cr("\t%d: %d", index + 1, _stack_depth_distribution[index]); 295 } 296 } 297 } 298 299 private: 300 void record_bucket_length(int length) { 301 _used_buckets ++; 302 if (length <= report_threshold) { 303 _hash_distribution[length - 1] ++; 304 } else { 305 _bucket_over_threshold ++; 306 } 307 _longest_bucket_length = MAX2(_longest_bucket_length, length); 308 } 309 }; 310 311 312 void MemTracker::tuning_statistics(outputStream* out) { 313 // NMT statistics 314 StatisticsWalker walker; 315 MallocSiteTable::walk_malloc_site(&walker); 316 walker.completed(); 317 318 out->print_cr("Native Memory Tracking Statistics:"); 319 out->print_cr("Malloc allocation site table size: %d", MallocSiteTable::hash_buckets()); 320 out->print_cr(" Tracking stack depth: %d", NMT_TrackingStackDepth); 321 NOT_PRODUCT(out->print_cr("Peak concurrent access: %d", MallocSiteTable::access_peak_count());) 322 out->print_cr(" "); 323 walker.report_statistics(out); 324 }