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