1 /* 2 * Copyright (c) 1997, 2015, 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 #ifndef SHARE_VM_MEMORY_UNIVERSE_HPP 26 #define SHARE_VM_MEMORY_UNIVERSE_HPP 27 28 #include "runtime/handles.hpp" 29 #include "utilities/array.hpp" 30 #include "utilities/growableArray.hpp" 31 32 // Universe is a name space holding known system classes and objects in the VM. 33 // 34 // Loaded classes are accessible through the SystemDictionary. 35 // 36 // The object heap is allocated and accessed through Universe, and various allocation 37 // support is provided. Allocation by the interpreter and compiled code is done inline 38 // and bails out to Scavenge::invoke_and_allocate. 39 40 class CollectedHeap; 41 class DeferredObjAllocEvent; 42 43 44 // A helper class for caching a Method* when the user of the cache 45 // only cares about the latest version of the Method*. This cache safely 46 // interacts with the RedefineClasses API. 47 48 class LatestMethodCache : public CHeapObj<mtClass> { 49 // We save the Klass* and the idnum of Method* in order to get 50 // the current cached Method*. 51 private: 52 Klass* _klass; 53 int _method_idnum; 54 55 public: 56 LatestMethodCache() { _klass = NULL; _method_idnum = -1; } 57 ~LatestMethodCache() { _klass = NULL; _method_idnum = -1; } 58 59 void init(Klass* k, Method* m); 60 Klass* klass() const { return _klass; } 61 int method_idnum() const { return _method_idnum; } 62 63 Method* get_method(); 64 65 // Enhanced Class Redefinition support 66 void classes_do(void f(Klass*)) { 67 f(_klass); 68 } 69 70 // CDS support. Replace the klass in this with the archive version 71 // could use this for Enhanced Class Redefinition also. 72 void serialize(SerializeClosure* f) { 73 f->do_ptr((void**)&_klass); 74 } 75 }; 76 77 78 // For UseCompressedOops. 79 struct NarrowPtrStruct { 80 // Base address for oop-within-java-object materialization. 81 // NULL if using wide oops or zero based narrow oops. 82 address _base; 83 // Number of shift bits for encoding/decoding narrow ptrs. 84 // 0 if using wide ptrs or zero based unscaled narrow ptrs, 85 // LogMinObjAlignmentInBytes/LogKlassAlignmentInBytes otherwise. 86 int _shift; 87 // Generate code with implicit null checks for narrow ptrs. 88 bool _use_implicit_null_checks; 89 }; 90 91 enum VerifyOption { 92 VerifyOption_Default = 0, 93 94 // G1 95 VerifyOption_G1UsePrevMarking = VerifyOption_Default, 96 VerifyOption_G1UseNextMarking = VerifyOption_G1UsePrevMarking + 1, 97 VerifyOption_G1UseMarkWord = VerifyOption_G1UseNextMarking + 1 98 }; 99 100 class Universe: AllStatic { 101 // Ugh. Universe is much too friendly. 102 friend class MarkSweep; 103 friend class oopDesc; 104 friend class ClassLoader; 105 friend class SystemDictionary; 106 friend class ReservedHeapSpace; 107 friend class VMStructs; 108 friend class VM_PopulateDumpSharedSpace; 109 friend class Metaspace; 110 111 friend jint universe_init(); 112 friend void universe2_init(); 113 friend bool universe_post_init(); 114 115 private: 116 // Known classes in the VM 117 static Klass* _boolArrayKlassObj; 118 static Klass* _byteArrayKlassObj; 119 static Klass* _charArrayKlassObj; 120 static Klass* _intArrayKlassObj; 121 static Klass* _shortArrayKlassObj; 122 static Klass* _longArrayKlassObj; 123 static Klass* _singleArrayKlassObj; 124 static Klass* _doubleArrayKlassObj; 125 static Klass* _typeArrayKlassObjs[T_VOID+1]; 126 127 static Klass* _objectArrayKlassObj; 128 129 // Known objects in the VM 130 131 // Primitive objects 132 static oop _int_mirror; 133 static oop _float_mirror; 134 static oop _double_mirror; 135 static oop _byte_mirror; 136 static oop _bool_mirror; 137 static oop _char_mirror; 138 static oop _long_mirror; 139 static oop _short_mirror; 140 static oop _void_mirror; 141 142 static oop _main_thread_group; // Reference to the main thread group object 143 static oop _system_thread_group; // Reference to the system thread group object 144 145 static objArrayOop _the_empty_class_klass_array; // Canonicalized obj array of type java.lang.Class 146 static oop _the_null_string; // A cache of "null" as a Java string 147 static oop _the_min_jint_string; // A cache of "-2147483648" as a Java string 148 static LatestMethodCache* _finalizer_register_cache; // static method for registering finalizable objects 149 static LatestMethodCache* _loader_addClass_cache; // method for registering loaded classes in class loader vector 150 static LatestMethodCache* _pd_implies_cache; // method for checking protection domain attributes 151 static LatestMethodCache* _throw_illegal_access_error_cache; // Unsafe.throwIllegalAccessError() method 152 153 // preallocated error objects (no backtrace) 154 static oop _out_of_memory_error_java_heap; 155 static oop _out_of_memory_error_metaspace; 156 static oop _out_of_memory_error_class_metaspace; 157 static oop _out_of_memory_error_array_size; 158 static oop _out_of_memory_error_gc_overhead_limit; 159 static oop _out_of_memory_error_realloc_objects; 160 161 // preallocated cause message for delayed StackOverflowError 162 static oop _delayed_stack_overflow_error_message; 163 164 static Array<int>* _the_empty_int_array; // Canonicalized int array 165 static Array<u2>* _the_empty_short_array; // Canonicalized short array 166 static Array<Klass*>* _the_empty_klass_array; // Canonicalized klass obj array 167 static Array<Method*>* _the_empty_method_array; // Canonicalized method obj array 168 169 static Array<Klass*>* _the_array_interfaces_array; 170 171 // array of preallocated error objects with backtrace 172 static objArrayOop _preallocated_out_of_memory_error_array; 173 174 // number of preallocated error objects available for use 175 static volatile jint _preallocated_out_of_memory_error_avail_count; 176 177 static oop _null_ptr_exception_instance; // preallocated exception object 178 static oop _arithmetic_exception_instance; // preallocated exception object 179 static oop _virtual_machine_error_instance; // preallocated exception object 180 // The object used as an exception dummy when exceptions are thrown for 181 // the vm thread. 182 static oop _vm_exception; 183 184 static oop _allocation_context_notification_obj; 185 186 // The particular choice of collected heap. 187 static CollectedHeap* _collectedHeap; 188 189 static intptr_t _non_oop_bits; 190 191 // For UseCompressedOops. 192 static struct NarrowPtrStruct _narrow_oop; 193 // For UseCompressedClassPointers. 194 static struct NarrowPtrStruct _narrow_klass; 195 static address _narrow_ptrs_base; 196 197 // array of dummy objects used with +FullGCAlot 198 debug_only(static objArrayOop _fullgc_alot_dummy_array;) 199 // index of next entry to clear 200 debug_only(static int _fullgc_alot_dummy_next;) 201 202 // Compiler/dispatch support 203 static int _base_vtable_size; // Java vtbl size of klass Object (in words) 204 205 // Initialization 206 static bool _bootstrapping; // true during genesis 207 static bool _fully_initialized; // true after universe_init and initialize_vtables called 208 209 // the array of preallocated errors with backtraces 210 static objArrayOop preallocated_out_of_memory_errors() { return _preallocated_out_of_memory_error_array; } 211 212 // generate an out of memory error; if possible using an error with preallocated backtrace; 213 // otherwise return the given default error. 214 static oop gen_out_of_memory_error(oop default_err); 215 216 // Historic gc information 217 static size_t _heap_capacity_at_last_gc; 218 static size_t _heap_used_at_last_gc; 219 220 template <class Heap, class Policy> static CollectedHeap* create_heap_with_policy(); 221 static CollectedHeap* create_heap(); 222 static CollectedHeap* create_heap_ext(); 223 static jint initialize_heap(); 224 static void initialize_basic_type_mirrors(TRAPS); 225 static void fixup_mirrors(TRAPS); 226 227 static void reinitialize_vtable_of(KlassHandle h_k, TRAPS); 228 static void reinitialize_itables(TRAPS); 229 static void compute_base_vtable_size(); // compute vtable size of class Object 230 231 static void genesis(TRAPS); // Create the initial world 232 233 // Mirrors for primitive classes (created eagerly) 234 static oop check_mirror(oop m) { 235 assert(m != NULL, "mirror not initialized"); 236 return m; 237 } 238 239 static void set_narrow_oop_base(address base) { 240 assert(UseCompressedOops, "no compressed oops?"); 241 _narrow_oop._base = base; 242 } 243 static void set_narrow_klass_base(address base) { 244 assert(UseCompressedClassPointers, "no compressed klass ptrs?"); 245 _narrow_klass._base = base; 246 } 247 static void set_narrow_oop_use_implicit_null_checks(bool use) { 248 assert(UseCompressedOops, "no compressed ptrs?"); 249 _narrow_oop._use_implicit_null_checks = use; 250 } 251 252 // Debugging 253 static int _verify_count; // number of verifies done 254 255 // True during call to verify(). Should only be set/cleared in verify(). 256 static bool _verify_in_progress; 257 258 static uintptr_t _verify_oop_mask; 259 static uintptr_t _verify_oop_bits; 260 261 static void calculate_verify_data(HeapWord* low_boundary, HeapWord* high_boundary) PRODUCT_RETURN; 262 static void compute_verify_oop_data(); 263 264 public: 265 // Known classes in the VM 266 static Klass* boolArrayKlassObj() { return _boolArrayKlassObj; } 267 static Klass* byteArrayKlassObj() { return _byteArrayKlassObj; } 268 static Klass* charArrayKlassObj() { return _charArrayKlassObj; } 269 static Klass* intArrayKlassObj() { return _intArrayKlassObj; } 270 static Klass* shortArrayKlassObj() { return _shortArrayKlassObj; } 271 static Klass* longArrayKlassObj() { return _longArrayKlassObj; } 272 static Klass* singleArrayKlassObj() { return _singleArrayKlassObj; } 273 static Klass* doubleArrayKlassObj() { return _doubleArrayKlassObj; } 274 275 static Klass* objectArrayKlassObj() { 276 return _objectArrayKlassObj; 277 } 278 279 static Klass* typeArrayKlassObj(BasicType t) { 280 assert((uint)t < T_VOID+1, "range check for type: %s", type2name(t)); 281 assert(_typeArrayKlassObjs[t] != NULL, "domain check"); 282 return _typeArrayKlassObjs[t]; 283 } 284 285 // Known objects in the VM 286 static oop int_mirror() { return check_mirror(_int_mirror); } 287 static oop float_mirror() { return check_mirror(_float_mirror); } 288 static oop double_mirror() { return check_mirror(_double_mirror); } 289 static oop byte_mirror() { return check_mirror(_byte_mirror); } 290 static oop bool_mirror() { return check_mirror(_bool_mirror); } 291 static oop char_mirror() { return check_mirror(_char_mirror); } 292 static oop long_mirror() { return check_mirror(_long_mirror); } 293 static oop short_mirror() { return check_mirror(_short_mirror); } 294 static oop void_mirror() { return check_mirror(_void_mirror); } 295 296 // table of same 297 static oop _mirrors[T_VOID+1]; 298 299 static oop java_mirror(BasicType t) { 300 assert((uint)t < T_VOID+1, "range check"); 301 return check_mirror(_mirrors[t]); 302 } 303 static oop main_thread_group() { return _main_thread_group; } 304 static void set_main_thread_group(oop group) { _main_thread_group = group;} 305 306 static oop system_thread_group() { return _system_thread_group; } 307 static void set_system_thread_group(oop group) { _system_thread_group = group;} 308 309 static objArrayOop the_empty_class_klass_array () { return _the_empty_class_klass_array; } 310 static Array<Klass*>* the_array_interfaces_array() { return _the_array_interfaces_array; } 311 static oop the_null_string() { return _the_null_string; } 312 static oop the_min_jint_string() { return _the_min_jint_string; } 313 314 static Method* finalizer_register_method() { return _finalizer_register_cache->get_method(); } 315 static Method* loader_addClass_method() { return _loader_addClass_cache->get_method(); } 316 317 static Method* protection_domain_implies_method() { return _pd_implies_cache->get_method(); } 318 static Method* throw_illegal_access_error() { return _throw_illegal_access_error_cache->get_method(); } 319 320 static oop null_ptr_exception_instance() { return _null_ptr_exception_instance; } 321 static oop arithmetic_exception_instance() { return _arithmetic_exception_instance; } 322 static oop virtual_machine_error_instance() { return _virtual_machine_error_instance; } 323 static oop vm_exception() { return _vm_exception; } 324 325 static inline oop allocation_context_notification_obj(); 326 static inline void set_allocation_context_notification_obj(oop obj); 327 328 static Array<int>* the_empty_int_array() { return _the_empty_int_array; } 329 static Array<u2>* the_empty_short_array() { return _the_empty_short_array; } 330 static Array<Method*>* the_empty_method_array() { return _the_empty_method_array; } 331 static Array<Klass*>* the_empty_klass_array() { return _the_empty_klass_array; } 332 333 // OutOfMemoryError support. Returns an error with the required message. The returned error 334 // may or may not have a backtrace. If error has a backtrace then the stack trace is already 335 // filled in. 336 static oop out_of_memory_error_java_heap() { return gen_out_of_memory_error(_out_of_memory_error_java_heap); } 337 static oop out_of_memory_error_metaspace() { return gen_out_of_memory_error(_out_of_memory_error_metaspace); } 338 static oop out_of_memory_error_class_metaspace() { return gen_out_of_memory_error(_out_of_memory_error_class_metaspace); } 339 static oop out_of_memory_error_array_size() { return gen_out_of_memory_error(_out_of_memory_error_array_size); } 340 static oop out_of_memory_error_gc_overhead_limit() { return gen_out_of_memory_error(_out_of_memory_error_gc_overhead_limit); } 341 static oop out_of_memory_error_realloc_objects() { return gen_out_of_memory_error(_out_of_memory_error_realloc_objects); } 342 static oop delayed_stack_overflow_error_message() { return _delayed_stack_overflow_error_message; } 343 344 // Accessors needed for fast allocation 345 static Klass** boolArrayKlassObj_addr() { return &_boolArrayKlassObj; } 346 static Klass** byteArrayKlassObj_addr() { return &_byteArrayKlassObj; } 347 static Klass** charArrayKlassObj_addr() { return &_charArrayKlassObj; } 348 static Klass** intArrayKlassObj_addr() { return &_intArrayKlassObj; } 349 static Klass** shortArrayKlassObj_addr() { return &_shortArrayKlassObj; } 350 static Klass** longArrayKlassObj_addr() { return &_longArrayKlassObj; } 351 static Klass** singleArrayKlassObj_addr() { return &_singleArrayKlassObj; } 352 static Klass** doubleArrayKlassObj_addr() { return &_doubleArrayKlassObj; } 353 static Klass** objectArrayKlassObj_addr() { return &_objectArrayKlassObj; } 354 355 // The particular choice of collected heap. 356 static CollectedHeap* heap() { return _collectedHeap; } 357 358 // For UseCompressedOops 359 // Narrow Oop encoding mode: 360 // 0 - Use 32-bits oops without encoding when 361 // NarrowOopHeapBaseMin + heap_size < 4Gb 362 // 1 - Use zero based compressed oops with encoding when 363 // NarrowOopHeapBaseMin + heap_size < 32Gb 364 // 2 - Use compressed oops with disjoint heap base if 365 // base is 32G-aligned and base > 0. This allows certain 366 // optimizations in encoding/decoding. 367 // Disjoint: Bits used in base are disjoint from bits used 368 // for oops ==> oop = (cOop << 3) | base. One can disjoint 369 // the bits of an oop into base and compressed oop. 370 // 3 - Use compressed oops with heap base + encoding. 371 enum NARROW_OOP_MODE { 372 UnscaledNarrowOop = 0, 373 ZeroBasedNarrowOop = 1, 374 DisjointBaseNarrowOop = 2, 375 HeapBasedNarrowOop = 3, 376 AnyNarrowOopMode = 4 377 }; 378 static NARROW_OOP_MODE narrow_oop_mode(); 379 static const char* narrow_oop_mode_to_string(NARROW_OOP_MODE mode); 380 static char* preferred_heap_base(size_t heap_size, size_t alignment, NARROW_OOP_MODE mode); 381 static char* preferred_metaspace_base(size_t heap_size, NARROW_OOP_MODE mode); 382 static address narrow_oop_base() { return _narrow_oop._base; } 383 // Test whether bits of addr and possible offsets into the heap overlap. 384 static bool is_disjoint_heap_base_address(address addr) { 385 return (((uint64_t)(intptr_t)addr) & 386 (((uint64_t)UCONST64(0xFFFFffffFFFFffff)) >> (32-LogMinObjAlignmentInBytes))) == 0; 387 } 388 // Check for disjoint base compressed oops. 389 static bool narrow_oop_base_disjoint() { 390 return _narrow_oop._base != NULL && is_disjoint_heap_base_address(_narrow_oop._base); 391 } 392 // Check for real heapbased compressed oops. 393 // We must subtract the base as the bits overlap. 394 // If we negate above function, we also get unscaled and zerobased. 395 static bool narrow_oop_base_overlaps() { 396 return _narrow_oop._base != NULL && !is_disjoint_heap_base_address(_narrow_oop._base); 397 } 398 static bool is_narrow_oop_base(void* addr) { return (narrow_oop_base() == (address)addr); } 399 static int narrow_oop_shift() { return _narrow_oop._shift; } 400 static bool narrow_oop_use_implicit_null_checks() { return _narrow_oop._use_implicit_null_checks; } 401 402 // For UseCompressedClassPointers 403 static address narrow_klass_base() { return _narrow_klass._base; } 404 static bool is_narrow_klass_base(void* addr) { return (narrow_klass_base() == (address)addr); } 405 static int narrow_klass_shift() { return _narrow_klass._shift; } 406 static bool narrow_klass_use_implicit_null_checks() { return _narrow_klass._use_implicit_null_checks; } 407 408 static address* narrow_ptrs_base_addr() { return &_narrow_ptrs_base; } 409 static void set_narrow_ptrs_base(address a) { _narrow_ptrs_base = a; } 410 static address narrow_ptrs_base() { return _narrow_ptrs_base; } 411 412 static void print_compressed_oops_mode(outputStream* st); 413 414 // this is set in vm_version on sparc (and then reset in universe afaict) 415 static void set_narrow_oop_shift(int shift) { 416 _narrow_oop._shift = shift; 417 } 418 419 static void set_narrow_klass_shift(int shift) { 420 assert(shift == 0 || shift == LogKlassAlignmentInBytes, "invalid shift for klass ptrs"); 421 _narrow_klass._shift = shift; 422 } 423 424 // Reserve Java heap and determine CompressedOops mode 425 static ReservedSpace reserve_heap(size_t heap_size, size_t alignment); 426 427 // Historic gc information 428 static size_t get_heap_capacity_at_last_gc() { return _heap_capacity_at_last_gc; } 429 static size_t get_heap_free_at_last_gc() { return _heap_capacity_at_last_gc - _heap_used_at_last_gc; } 430 static size_t get_heap_used_at_last_gc() { return _heap_used_at_last_gc; } 431 static void update_heap_info_at_gc(); 432 433 // Testers 434 static bool is_bootstrapping() { return _bootstrapping; } 435 static bool is_fully_initialized() { return _fully_initialized; } 436 437 static inline bool element_type_should_be_aligned(BasicType type); 438 static inline bool field_type_should_be_aligned(BasicType type); 439 static bool on_page_boundary(void* addr); 440 static bool should_fill_in_stack_trace(Handle throwable); 441 static void check_alignment(uintx size, uintx alignment, const char* name); 442 443 // Finalizer support. 444 static void run_finalizers_on_exit(); 445 446 // Iteration 447 448 // Apply "f" to the addresses of all the direct heap pointers maintained 449 // as static fields of "Universe". 450 static void oops_do(OopClosure* f, bool do_all = false); 451 452 // CDS support 453 static void serialize(SerializeClosure* f, bool do_all = false); 454 455 // Apply "f" to all klasses for basic types (classes not present in 456 // SystemDictionary). 457 static void basic_type_classes_do(void f(Klass*)); 458 459 // For sharing -- fill in a list of known vtable pointers. 460 static void init_self_patching_vtbl_list(void** list, int count); 461 462 // Debugging 463 static bool verify_in_progress() { return _verify_in_progress; } 464 static void verify(VerifyOption option, const char* prefix, bool silent = VerifySilently); 465 static void verify(const char* prefix, bool silent = VerifySilently) { 466 verify(VerifyOption_Default, prefix, silent); 467 } 468 static void verify(bool silent = VerifySilently) { 469 verify("", silent); 470 } 471 472 static int verify_count() { return _verify_count; } 473 // The default behavior is to call print_on() on gclog_or_tty. 474 static void print(); 475 // The extended parameter determines which method on the heap will 476 // be called: print_on() (extended == false) or print_extended_on() 477 // (extended == true). 478 static void print_on(outputStream* st, bool extended = false); 479 static void print_heap_at_SIGBREAK(); 480 static void print_heap_before_gc() { print_heap_before_gc(gclog_or_tty); } 481 static void print_heap_after_gc() { print_heap_after_gc(gclog_or_tty); } 482 static void print_heap_before_gc(outputStream* st, bool ignore_extended = false); 483 static void print_heap_after_gc(outputStream* st, bool ignore_extended = false); 484 485 // Change the number of dummy objects kept reachable by the full gc dummy 486 // array; this should trigger relocation in a sliding compaction collector. 487 debug_only(static bool release_fullgc_alot_dummy();) 488 // The non-oop pattern (see compiledIC.hpp, etc) 489 static void* non_oop_word(); 490 491 // Oop verification (see MacroAssembler::verify_oop) 492 static uintptr_t verify_oop_mask() PRODUCT_RETURN0; 493 static uintptr_t verify_oop_bits() PRODUCT_RETURN0; 494 static uintptr_t verify_mark_bits() PRODUCT_RETURN0; 495 static uintptr_t verify_mark_mask() PRODUCT_RETURN0; 496 497 // Compiler support 498 static int base_vtable_size() { return _base_vtable_size; } 499 }; 500 501 class DeferredObjAllocEvent : public CHeapObj<mtInternal> { 502 private: 503 oop _oop; 504 size_t _bytesize; 505 jint _arena_id; 506 507 public: 508 DeferredObjAllocEvent(const oop o, const size_t s, const jint id) { 509 _oop = o; 510 _bytesize = s; 511 _arena_id = id; 512 } 513 514 ~DeferredObjAllocEvent() { 515 } 516 517 jint arena_id() { return _arena_id; } 518 size_t bytesize() { return _bytesize; } 519 oop get_oop() { return _oop; } 520 }; 521 522 #endif // SHARE_VM_MEMORY_UNIVERSE_HPP