1 /* 2 * Copyright (c) 2011, 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 #ifndef SHARE_VM_MEMORY_METASPACE_HPP 25 #define SHARE_VM_MEMORY_METASPACE_HPP 26 27 #include "memory/allocation.hpp" 28 #include "memory/memRegion.hpp" 29 #include "memory/metaspaceChunkFreeListSummary.hpp" 30 #include "memory/virtualspace.hpp" 31 #include "utilities/exceptions.hpp" 32 33 // Metaspace 34 // 35 // Metaspaces are Arenas for the VM's metadata. 36 // They are allocated one per class loader object, and one for the null 37 // bootstrap class loader 38 // 39 // block X ---+ +-------------------+ 40 // | | Virtualspace | 41 // | | | 42 // | | | 43 // | |-------------------| 44 // | || Chunk | 45 // | || | 46 // | ||---------- | 47 // +------>||| block 0 | | 48 // ||---------- | 49 // ||| block 1 | | 50 // ||---------- | 51 // || | 52 // |-------------------| 53 // | | 54 // | | 55 // +-------------------+ 56 // 57 58 class ClassLoaderData; 59 class MetaspaceTracer; 60 class MetaWord; 61 class Mutex; 62 class outputStream; 63 64 class CollectedHeap; 65 66 namespace metaspace { 67 class ChunkManager; 68 class ClassLoaderMetaspaceStatistics; 69 class Metablock; 70 class Metachunk; 71 class PrintCLDMetaspaceInfoClosure; 72 class SpaceManager; 73 class VirtualSpaceList; 74 class VirtualSpaceNode; 75 } 76 77 // Metaspaces each have a SpaceManager and allocations 78 // are done by the SpaceManager. Allocations are done 79 // out of the current Metachunk. When the current Metachunk 80 // is exhausted, the SpaceManager gets a new one from 81 // the current VirtualSpace. When the VirtualSpace is exhausted 82 // the SpaceManager gets a new one. The SpaceManager 83 // also manages freelists of available Chunks. 84 // 85 // Currently the space manager maintains the list of 86 // virtual spaces and the list of chunks in use. Its 87 // allocate() method returns a block for use as a 88 // quantum of metadata. 89 90 // Namespace for important central static functions 91 // (auxiliary stuff goes into MetaspaceUtils) 92 class Metaspace : public AllStatic { 93 94 friend class MetaspaceShared; 95 96 public: 97 enum MetadataType { 98 ClassType, 99 NonClassType, 100 MetadataTypeCount 101 }; 102 enum MetaspaceType { 103 ZeroMetaspaceType = 0, 104 StandardMetaspaceType = ZeroMetaspaceType, 105 BootMetaspaceType = StandardMetaspaceType + 1, 106 AnonymousMetaspaceType = BootMetaspaceType + 1, 107 ReflectionMetaspaceType = AnonymousMetaspaceType + 1, 108 MetaspaceTypeCount 109 }; 110 111 private: 112 113 // Align up the word size to the allocation word size 114 static size_t align_word_size_up(size_t); 115 116 // Aligned size of the metaspace. 117 static size_t _compressed_class_space_size; 118 119 static size_t compressed_class_space_size() { 120 return _compressed_class_space_size; 121 } 122 123 static void set_compressed_class_space_size(size_t size) { 124 _compressed_class_space_size = size; 125 } 126 127 static size_t _first_chunk_word_size; 128 static size_t _first_class_chunk_word_size; 129 130 static size_t _commit_alignment; 131 static size_t _reserve_alignment; 132 DEBUG_ONLY(static bool _frozen;) 133 134 // Virtual Space lists for both classes and other metadata 135 static metaspace::VirtualSpaceList* _space_list; 136 static metaspace::VirtualSpaceList* _class_space_list; 137 138 static metaspace::ChunkManager* _chunk_manager_metadata; 139 static metaspace::ChunkManager* _chunk_manager_class; 140 141 static const MetaspaceTracer* _tracer; 142 143 static bool _initialized; 144 145 public: 146 static metaspace::VirtualSpaceList* space_list() { return _space_list; } 147 static metaspace::VirtualSpaceList* class_space_list() { return _class_space_list; } 148 static metaspace::VirtualSpaceList* get_space_list(MetadataType mdtype) { 149 assert(mdtype != MetadataTypeCount, "MetadaTypeCount can't be used as mdtype"); 150 return mdtype == ClassType ? class_space_list() : space_list(); 151 } 152 153 static metaspace::ChunkManager* chunk_manager_metadata() { return _chunk_manager_metadata; } 154 static metaspace::ChunkManager* chunk_manager_class() { return _chunk_manager_class; } 155 static metaspace::ChunkManager* get_chunk_manager(MetadataType mdtype) { 156 assert(mdtype != MetadataTypeCount, "MetadaTypeCount can't be used as mdtype"); 157 return mdtype == ClassType ? chunk_manager_class() : chunk_manager_metadata(); 158 } 159 160 // convenience function 161 static metaspace::ChunkManager* get_chunk_manager(bool is_class) { 162 return is_class ? chunk_manager_class() : chunk_manager_metadata(); 163 } 164 165 static const MetaspaceTracer* tracer() { return _tracer; } 166 static void freeze() { 167 assert(DumpSharedSpaces, "sanity"); 168 DEBUG_ONLY(_frozen = true;) 169 } 170 static void assert_not_frozen() { 171 assert(!_frozen, "sanity"); 172 } 173 #ifdef _LP64 174 static void allocate_metaspace_compressed_klass_ptrs(char* requested_addr, address cds_base); 175 #endif 176 177 private: 178 179 #ifdef _LP64 180 static void set_narrow_klass_base_and_shift(address metaspace_base, address cds_base); 181 182 // Returns true if can use CDS with metaspace allocated as specified address. 183 static bool can_use_cds_with_metaspace_addr(char* metaspace_base, address cds_base); 184 185 static void initialize_class_space(ReservedSpace rs); 186 #endif 187 188 public: 189 190 static void ergo_initialize(); 191 static void global_initialize(); 192 static void post_initialize(); 193 194 static void verify_global_initialization(); 195 196 static size_t first_chunk_word_size() { return _first_chunk_word_size; } 197 static size_t first_class_chunk_word_size() { return _first_class_chunk_word_size; } 198 199 static size_t reserve_alignment() { return _reserve_alignment; } 200 static size_t reserve_alignment_words() { return _reserve_alignment / BytesPerWord; } 201 static size_t commit_alignment() { return _commit_alignment; } 202 static size_t commit_alignment_words() { return _commit_alignment / BytesPerWord; } 203 204 static MetaWord* allocate(ClassLoaderData* loader_data, size_t word_size, 205 MetaspaceObj::Type type, TRAPS); 206 207 static bool contains(const void* ptr); 208 static bool contains_non_shared(const void* ptr); 209 210 // Free empty virtualspaces 211 static void purge(MetadataType mdtype); 212 static void purge(); 213 214 static void report_metadata_oome(ClassLoaderData* loader_data, size_t word_size, 215 MetaspaceObj::Type type, MetadataType mdtype, TRAPS); 216 217 static const char* metadata_type_name(Metaspace::MetadataType mdtype); 218 219 static void print_compressed_class_space(outputStream* st, const char* requested_addr = 0) NOT_LP64({}); 220 221 // Return TRUE only if UseCompressedClassPointers is True. 222 static bool using_class_space() { 223 return NOT_LP64(false) LP64_ONLY(UseCompressedClassPointers); 224 } 225 226 static bool is_class_space_allocation(MetadataType mdType) { 227 return mdType == ClassType && using_class_space(); 228 } 229 230 static bool initialized() { return _initialized; } 231 232 }; 233 234 // Manages the metaspace portion belonging to a class loader 235 class ClassLoaderMetaspace : public CHeapObj<mtClass> { 236 friend class CollectedHeap; // For expand_and_allocate() 237 friend class ZCollectedHeap; // For expand_and_allocate() 238 friend class ShenandoahHeap; // For expand_and_allocate() 239 friend class Metaspace; 240 friend class MetaspaceUtils; 241 friend class metaspace::PrintCLDMetaspaceInfoClosure; 242 friend class VM_CollectForMetadataAllocation; // For expand_and_allocate() 243 244 private: 245 246 void initialize(Mutex* lock, Metaspace::MetaspaceType type); 247 248 // Initialize the first chunk for a Metaspace. Used for 249 // special cases such as the boot class loader, reflection 250 // class loader and anonymous class loader. 251 void initialize_first_chunk(Metaspace::MetaspaceType type, Metaspace::MetadataType mdtype); 252 metaspace::Metachunk* get_initialization_chunk(Metaspace::MetaspaceType type, Metaspace::MetadataType mdtype); 253 254 const Metaspace::MetaspaceType _space_type; 255 Mutex* const _lock; 256 metaspace::SpaceManager* _vsm; 257 metaspace::SpaceManager* _class_vsm; 258 259 metaspace::SpaceManager* vsm() const { return _vsm; } 260 metaspace::SpaceManager* class_vsm() const { return _class_vsm; } 261 metaspace::SpaceManager* get_space_manager(Metaspace::MetadataType mdtype) { 262 assert(mdtype != Metaspace::MetadataTypeCount, "MetadaTypeCount can't be used as mdtype"); 263 return mdtype == Metaspace::ClassType ? class_vsm() : vsm(); 264 } 265 266 Mutex* lock() const { return _lock; } 267 268 MetaWord* expand_and_allocate(size_t size, Metaspace::MetadataType mdtype); 269 270 size_t class_chunk_size(size_t word_size); 271 272 // Adds to the given statistic object. Must be locked with CLD metaspace lock. 273 void add_to_statistics_locked(metaspace::ClassLoaderMetaspaceStatistics* out) const; 274 275 Metaspace::MetaspaceType space_type() const { return _space_type; } 276 277 public: 278 279 ClassLoaderMetaspace(Mutex* lock, Metaspace::MetaspaceType type); 280 ~ClassLoaderMetaspace(); 281 282 // Allocate space for metadata of type mdtype. This is space 283 // within a Metachunk and is used by 284 // allocate(ClassLoaderData*, size_t, bool, MetadataType, TRAPS) 285 MetaWord* allocate(size_t word_size, Metaspace::MetadataType mdtype); 286 287 size_t allocated_blocks_bytes() const; 288 size_t allocated_chunks_bytes() const; 289 290 void deallocate(MetaWord* ptr, size_t byte_size, bool is_class); 291 292 void print_on(outputStream* st) const; 293 // Debugging support 294 void verify(); 295 296 // Adds to the given statistic object. Will lock with CLD metaspace lock. 297 void add_to_statistics(metaspace::ClassLoaderMetaspaceStatistics* out) const; 298 299 }; // ClassLoaderMetaspace 300 301 class MetaspaceUtils : AllStatic { 302 303 // Spacemanager updates running counters. 304 friend class metaspace::SpaceManager; 305 306 // Special access for error reporting (checks without locks). 307 friend class oopDesc; 308 friend class Klass; 309 310 // Running counters for statistics concerning in-use chunks. 311 // Note: capacity = used + free + waste + overhead. Note that we do not 312 // count free and waste. Their sum can be deduces from the three other values. 313 // For more details, one should call print_report() from within a safe point. 314 static size_t _capacity_words [Metaspace:: MetadataTypeCount]; 315 static size_t _overhead_words [Metaspace:: MetadataTypeCount]; 316 static volatile size_t _used_words [Metaspace:: MetadataTypeCount]; 317 318 // Atomically decrement or increment in-use statistic counters 319 static void dec_capacity(Metaspace::MetadataType mdtype, size_t words); 320 static void inc_capacity(Metaspace::MetadataType mdtype, size_t words); 321 static void dec_used(Metaspace::MetadataType mdtype, size_t words); 322 static void inc_used(Metaspace::MetadataType mdtype, size_t words); 323 static void dec_overhead(Metaspace::MetadataType mdtype, size_t words); 324 static void inc_overhead(Metaspace::MetadataType mdtype, size_t words); 325 326 327 // Getters for the in-use counters. 328 static size_t capacity_words(Metaspace::MetadataType mdtype) { return _capacity_words[mdtype]; } 329 static size_t used_words(Metaspace::MetadataType mdtype) { return _used_words[mdtype]; } 330 static size_t overhead_words(Metaspace::MetadataType mdtype) { return _overhead_words[mdtype]; } 331 332 static size_t free_chunks_total_words(Metaspace::MetadataType mdtype); 333 334 // Helper for print_xx_report. 335 static void print_vs(outputStream* out, size_t scale); 336 337 // Utils to check if a pointer or range is part of a committed metaspace region 338 // without acquiring any locks. 339 static metaspace::VirtualSpaceNode* find_enclosing_virtual_space(const void* p); 340 static bool is_in_committed(const void* p); 341 static bool is_range_in_committed(const void* from, const void* to); 342 343 public: 344 345 // Collect used metaspace statistics. This involves walking the CLDG. The resulting 346 // output will be the accumulated values for all live metaspaces. 347 // Note: method does not do any locking. 348 static void collect_statistics(metaspace::ClassLoaderMetaspaceStatistics* out); 349 350 // Used by MetaspaceCounters 351 static size_t free_chunks_total_words(); 352 static size_t free_chunks_total_bytes(); 353 static size_t free_chunks_total_bytes(Metaspace::MetadataType mdtype); 354 355 static size_t capacity_words() { 356 return capacity_words(Metaspace::NonClassType) + 357 capacity_words(Metaspace::ClassType); 358 } 359 static size_t capacity_bytes(Metaspace::MetadataType mdtype) { 360 return capacity_words(mdtype) * BytesPerWord; 361 } 362 static size_t capacity_bytes() { 363 return capacity_words() * BytesPerWord; 364 } 365 366 static size_t used_words() { 367 return used_words(Metaspace::NonClassType) + 368 used_words(Metaspace::ClassType); 369 } 370 static size_t used_bytes(Metaspace::MetadataType mdtype) { 371 return used_words(mdtype) * BytesPerWord; 372 } 373 static size_t used_bytes() { 374 return used_words() * BytesPerWord; 375 } 376 377 // Space committed but yet unclaimed by any class loader. 378 static size_t free_in_vs_bytes(); 379 static size_t free_in_vs_bytes(Metaspace::MetadataType mdtype); 380 381 static size_t reserved_bytes(Metaspace::MetadataType mdtype); 382 static size_t reserved_bytes() { 383 return reserved_bytes(Metaspace::ClassType) + 384 reserved_bytes(Metaspace::NonClassType); 385 } 386 387 static size_t committed_bytes(Metaspace::MetadataType mdtype); 388 static size_t committed_bytes() { 389 return committed_bytes(Metaspace::ClassType) + 390 committed_bytes(Metaspace::NonClassType); 391 } 392 393 static size_t min_chunk_size_words(); 394 static size_t min_chunk_size_bytes() { 395 return min_chunk_size_words() * BytesPerWord; 396 } 397 398 // Flags for print_report(). 399 enum ReportFlag { 400 // Show usage by class loader. 401 rf_show_loaders = (1 << 0), 402 // Breaks report down by chunk type (small, medium, ...). 403 rf_break_down_by_chunktype = (1 << 1), 404 // Breaks report down by space type (anonymous, reflection, ...). 405 rf_break_down_by_spacetype = (1 << 2), 406 // Print details about the underlying virtual spaces. 407 rf_show_vslist = (1 << 3), 408 // Print metaspace map. 409 rf_show_vsmap = (1 << 4), 410 // If show_loaders: show loaded classes for each loader. 411 rf_show_classes = (1 << 5) 412 }; 413 414 // This will print out a basic metaspace usage report but 415 // unlike print_report() is guaranteed not to lock or to walk the CLDG. 416 static void print_basic_report(outputStream* st, size_t scale); 417 418 // Prints a report about the current metaspace state. 419 // Optional parts can be enabled via flags. 420 // Function will walk the CLDG and will lock the expand lock; if that is not 421 // convenient, use print_basic_report() instead. 422 static void print_report(outputStream* out, size_t scale = 0, int flags = 0); 423 424 static bool has_chunk_free_list(Metaspace::MetadataType mdtype); 425 static MetaspaceChunkFreeListSummary chunk_free_list_summary(Metaspace::MetadataType mdtype); 426 427 // Print change in used metadata. 428 static void print_metaspace_change(size_t prev_metadata_used); 429 static void print_on(outputStream * out); 430 431 // Prints an ASCII representation of the given space. 432 static void print_metaspace_map(outputStream* out, Metaspace::MetadataType mdtype); 433 434 static void dump(outputStream* out); 435 static void verify_free_chunks(); 436 // Check internal counters (capacity, used). 437 static void verify_metrics(); 438 }; 439 440 // Metaspace are deallocated when their class loader are GC'ed. 441 // This class implements a policy for inducing GC's to recover 442 // Metaspaces. 443 444 class MetaspaceGC : AllStatic { 445 446 // The current high-water-mark for inducing a GC. 447 // When committed memory of all metaspaces reaches this value, 448 // a GC is induced and the value is increased. Size is in bytes. 449 static volatile size_t _capacity_until_GC; 450 451 // For a CMS collection, signal that a concurrent collection should 452 // be started. 453 static bool _should_concurrent_collect; 454 455 static uint _shrink_factor; 456 457 static size_t shrink_factor() { return _shrink_factor; } 458 void set_shrink_factor(uint v) { _shrink_factor = v; } 459 460 public: 461 462 static void initialize(); 463 static void post_initialize(); 464 465 static size_t capacity_until_GC(); 466 static bool inc_capacity_until_GC(size_t v, 467 size_t* new_cap_until_GC = NULL, 468 size_t* old_cap_until_GC = NULL, 469 bool* can_retry = NULL); 470 static size_t dec_capacity_until_GC(size_t v); 471 472 static bool should_concurrent_collect() { return _should_concurrent_collect; } 473 static void set_should_concurrent_collect(bool v) { 474 _should_concurrent_collect = v; 475 } 476 477 // The amount to increase the high-water-mark (_capacity_until_GC) 478 static size_t delta_capacity_until_GC(size_t bytes); 479 480 // Tells if we have can expand metaspace without hitting set limits. 481 static bool can_expand(size_t words, bool is_class); 482 483 // Returns amount that we can expand without hitting a GC, 484 // measured in words. 485 static size_t allowed_expansion(); 486 487 // Calculate the new high-water mark at which to induce 488 // a GC. 489 static void compute_new_size(); 490 }; 491 492 #endif // SHARE_VM_MEMORY_METASPACE_HPP