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