1 /*
2 * Copyright (c) 2018, 2025, 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 #include "cds/aotArtifactFinder.hpp"
26 #include "cds/aotClassInitializer.hpp"
27 #include "cds/aotClassLocation.hpp"
28 #include "cds/aotLogging.hpp"
29 #include "cds/aotMappedHeapLoader.hpp"
30 #include "cds/aotMappedHeapWriter.hpp"
31 #include "cds/aotMetaspace.hpp"
32 #include "cds/aotOopChecker.hpp"
33 #include "cds/aotReferenceObjSupport.hpp"
34 #include "cds/aotStreamedHeapLoader.hpp"
35 #include "cds/aotStreamedHeapWriter.hpp"
36 #include "cds/archiveBuilder.hpp"
37 #include "cds/archiveUtils.hpp"
38 #include "cds/cds_globals.hpp"
39 #include "cds/cdsConfig.hpp"
40 #include "cds/cdsEnumKlass.hpp"
41 #include "cds/cdsHeapVerifier.hpp"
42 #include "cds/heapShared.inline.hpp"
43 #include "cds/regeneratedClasses.hpp"
44 #include "classfile/classLoaderData.hpp"
45 #include "classfile/javaClasses.inline.hpp"
46 #include "classfile/modules.hpp"
47 #include "classfile/stringTable.hpp"
48 #include "classfile/symbolTable.hpp"
49 #include "classfile/systemDictionary.hpp"
50 #include "classfile/systemDictionaryShared.hpp"
51 #include "classfile/vmClasses.hpp"
52 #include "classfile/vmSymbols.hpp"
53 #include "gc/shared/collectedHeap.hpp"
54 #include "gc/shared/gcLocker.hpp"
55 #include "gc/shared/gcVMOperations.hpp"
56 #include "logging/log.hpp"
57 #include "logging/logStream.hpp"
58 #include "memory/iterator.inline.hpp"
59 #include "memory/resourceArea.hpp"
60 #include "memory/universe.hpp"
61 #include "oops/compressedOops.inline.hpp"
62 #include "oops/fieldStreams.inline.hpp"
63 #include "oops/objArrayOop.inline.hpp"
64 #include "oops/oop.inline.hpp"
65 #include "oops/oopHandle.inline.hpp"
66 #include "oops/typeArrayOop.inline.hpp"
67 #include "prims/jvmtiExport.hpp"
68 #include "runtime/arguments.hpp"
69 #include "runtime/fieldDescriptor.inline.hpp"
70 #include "runtime/globals_extension.hpp"
71 #include "runtime/init.hpp"
72 #include "runtime/javaCalls.hpp"
73 #include "runtime/mutexLocker.hpp"
74 #include "runtime/safepointVerifiers.hpp"
75 #include "utilities/bitMap.inline.hpp"
76 #include "utilities/copy.hpp"
77 #if INCLUDE_G1GC
78 #include "gc/g1/g1CollectedHeap.hpp"
79 #endif
80
81 #if INCLUDE_CDS_JAVA_HEAP
82
83 struct ArchivableStaticFieldInfo {
84 const char* klass_name;
85 const char* field_name;
86 InstanceKlass* klass;
87 int offset;
88 BasicType type;
89
90 ArchivableStaticFieldInfo(const char* k, const char* f)
91 : klass_name(k), field_name(f), klass(nullptr), offset(0), type(T_ILLEGAL) {}
92
93 bool valid() {
94 return klass_name != nullptr;
95 }
96 };
97
98 // Anything that goes in the header must be thoroughly purged from uninitialized memory
99 // as it will be written to disk. Therefore, the constructors memset the memory to 0.
100 // This is not the prettiest thing, but we need to know every byte is initialized,
101 // including potential padding between fields.
102
103 ArchiveMappedHeapHeader::ArchiveMappedHeapHeader(size_t ptrmap_start_pos,
104 size_t oopmap_start_pos,
105 HeapRootSegments root_segments) {
106 memset((char*)this, 0, sizeof(*this));
107 _ptrmap_start_pos = ptrmap_start_pos;
108 _oopmap_start_pos = oopmap_start_pos;
109 _root_segments = root_segments;
110 }
111
112 ArchiveMappedHeapHeader::ArchiveMappedHeapHeader() {
113 memset((char*)this, 0, sizeof(*this));
114 }
115
116 ArchiveMappedHeapHeader ArchiveMappedHeapInfo::create_header() {
117 return ArchiveMappedHeapHeader{_ptrmap_start_pos,
118 _oopmap_start_pos,
119 _root_segments};
120 }
121
122 ArchiveStreamedHeapHeader::ArchiveStreamedHeapHeader(size_t forwarding_offset,
123 size_t roots_offset,
124 size_t num_roots,
125 size_t root_highest_object_index_table_offset,
126 size_t num_archived_objects) {
127 memset((char*)this, 0, sizeof(*this));
128 _forwarding_offset = forwarding_offset;
129 _roots_offset = roots_offset;
130 _num_roots = num_roots;
131 _root_highest_object_index_table_offset = root_highest_object_index_table_offset;
132 _num_archived_objects = num_archived_objects;
133 }
134
135 ArchiveStreamedHeapHeader::ArchiveStreamedHeapHeader() {
136 memset((char*)this, 0, sizeof(*this));
137 }
138
139 ArchiveStreamedHeapHeader ArchiveStreamedHeapInfo::create_header() {
140 return ArchiveStreamedHeapHeader{_forwarding_offset,
141 _roots_offset,
142 _num_roots,
143 _root_highest_object_index_table_offset,
144 _num_archived_objects};
145 }
146
147 HeapArchiveMode HeapShared::_heap_load_mode = HeapArchiveMode::_uninitialized;
148 HeapArchiveMode HeapShared::_heap_write_mode = HeapArchiveMode::_uninitialized;
149
150 size_t HeapShared::_alloc_count[HeapShared::ALLOC_STAT_SLOTS];
151 size_t HeapShared::_alloc_size[HeapShared::ALLOC_STAT_SLOTS];
152 size_t HeapShared::_total_obj_count;
153 size_t HeapShared::_total_obj_size;
154
155 #ifndef PRODUCT
156 #define ARCHIVE_TEST_FIELD_NAME "archivedObjects"
157 static Array<char>* _archived_ArchiveHeapTestClass = nullptr;
158 static const char* _test_class_name = nullptr;
159 static Klass* _test_class = nullptr;
160 static const ArchivedKlassSubGraphInfoRecord* _test_class_record = nullptr;
161 #endif
162
163
164 //
165 // If you add new entries to the following tables, you should know what you're doing!
166 //
167
168 static ArchivableStaticFieldInfo archive_subgraph_entry_fields[] = {
169 {"java/lang/Integer$IntegerCache", "archivedCache"},
170 {"java/lang/Long$LongCache", "archivedCache"},
171 {"java/lang/Byte$ByteCache", "archivedCache"},
172 {"java/lang/Short$ShortCache", "archivedCache"},
173 {"java/lang/Character$CharacterCache", "archivedCache"},
174 {"java/util/jar/Attributes$Name", "KNOWN_NAMES"},
175 {"sun/util/locale/BaseLocale", "constantBaseLocales"},
176 {"jdk/internal/module/ArchivedModuleGraph", "archivedModuleGraph"},
177 {"java/util/ImmutableCollections", "archivedObjects"},
178 {"java/lang/ModuleLayer", "EMPTY_LAYER"},
179 {"java/lang/module/Configuration", "EMPTY_CONFIGURATION"},
180 {"jdk/internal/math/FDBigInteger", "archivedCaches"},
181
182 #ifndef PRODUCT
183 {nullptr, nullptr}, // Extra slot for -XX:ArchiveHeapTestClass
184 #endif
185 {nullptr, nullptr},
186 };
187
188 // full module graph
189 static ArchivableStaticFieldInfo fmg_archive_subgraph_entry_fields[] = {
190 {"jdk/internal/loader/ArchivedClassLoaders", "archivedClassLoaders"},
191 {ARCHIVED_BOOT_LAYER_CLASS, ARCHIVED_BOOT_LAYER_FIELD},
192 {"java/lang/Module$ArchivedData", "archivedData"},
193 {nullptr, nullptr},
194 };
195
196 KlassSubGraphInfo* HeapShared::_dump_time_special_subgraph;
197 ArchivedKlassSubGraphInfoRecord* HeapShared::_run_time_special_subgraph;
198 GrowableArrayCHeap<oop, mtClassShared>* HeapShared::_pending_roots = nullptr;
199 OopHandle HeapShared::_scratch_basic_type_mirrors[T_VOID+1];
200 MetaspaceObjToOopHandleTable* HeapShared::_scratch_objects_table = nullptr;
201
202 static bool is_subgraph_root_class_of(ArchivableStaticFieldInfo fields[], InstanceKlass* ik) {
203 for (int i = 0; fields[i].valid(); i++) {
204 if (fields[i].klass == ik) {
205 return true;
206 }
207 }
208 return false;
209 }
210
211 bool HeapShared::is_subgraph_root_class(InstanceKlass* ik) {
212 return is_subgraph_root_class_of(archive_subgraph_entry_fields, ik) ||
213 is_subgraph_root_class_of(fmg_archive_subgraph_entry_fields, ik);
214 }
215
216 oop HeapShared::CachedOopInfo::orig_referrer() const {
217 return _orig_referrer.resolve();
218 }
219
220 unsigned HeapShared::oop_hash(oop const& p) {
221 assert(SafepointSynchronize::is_at_safepoint() ||
222 JavaThread::current()->is_in_no_safepoint_scope(), "sanity");
223 // Do not call p->identity_hash() as that will update the
224 // object header.
225 return primitive_hash(cast_from_oop<intptr_t>(p));
226 }
227
228 unsigned int HeapShared::oop_handle_hash_raw(const OopHandle& oh) {
229 return oop_hash(oh.resolve());
230 }
231
232 unsigned int HeapShared::oop_handle_hash(const OopHandle& oh) {
233 oop o = oh.resolve();
234 if (o == nullptr) {
235 return 0;
236 } else {
237 return o->identity_hash();
238 }
239 }
240
241 bool HeapShared::oop_handle_equals(const OopHandle& a, const OopHandle& b) {
242 return a.resolve() == b.resolve();
243 }
244
245 static void reset_states(oop obj, TRAPS) {
246 Handle h_obj(THREAD, obj);
247 InstanceKlass* klass = InstanceKlass::cast(obj->klass());
248 TempNewSymbol method_name = SymbolTable::new_symbol("resetArchivedStates");
249 Symbol* method_sig = vmSymbols::void_method_signature();
250
251 while (klass != nullptr) {
252 Method* method = klass->find_method(method_name, method_sig);
253 if (method != nullptr) {
254 assert(method->is_private(), "must be");
255 if (log_is_enabled(Debug, aot)) {
256 ResourceMark rm(THREAD);
257 log_debug(aot)(" calling %s", method->name_and_sig_as_C_string());
258 }
259 JavaValue result(T_VOID);
260 JavaCalls::call_special(&result, h_obj, klass,
261 method_name, method_sig, CHECK);
262 }
263 klass = klass->super();
264 }
265 }
266
267 void HeapShared::reset_archived_object_states(TRAPS) {
268 assert(CDSConfig::is_dumping_heap(), "dump-time only");
269 log_debug(aot)("Resetting platform loader");
270 reset_states(SystemDictionary::java_platform_loader(), CHECK);
271 log_debug(aot)("Resetting system loader");
272 reset_states(SystemDictionary::java_system_loader(), CHECK);
273
274 // Clean up jdk.internal.loader.ClassLoaders::bootLoader(), which is not
275 // directly used for class loading, but rather is used by the core library
276 // to keep track of resources, etc, loaded by the null class loader.
277 //
278 // Note, this object is non-null, and is not the same as
279 // ClassLoaderData::the_null_class_loader_data()->class_loader(),
280 // which is null.
281 log_debug(aot)("Resetting boot loader");
282 JavaValue result(T_OBJECT);
283 JavaCalls::call_static(&result,
284 vmClasses::jdk_internal_loader_ClassLoaders_klass(),
285 vmSymbols::bootLoader_name(),
286 vmSymbols::void_BuiltinClassLoader_signature(),
287 CHECK);
288 Handle boot_loader(THREAD, result.get_oop());
289 reset_states(boot_loader(), CHECK);
290 }
291
292 HeapShared::ArchivedObjectCache* HeapShared::_archived_object_cache = nullptr;
293
294 bool HeapShared::is_archived_heap_in_use() {
295 if (HeapShared::is_loading()) {
296 if (HeapShared::is_loading_streaming_mode()) {
297 return AOTStreamedHeapLoader::is_in_use();
298 } else {
299 return AOTMappedHeapLoader::is_in_use();
300 }
301 }
302
303 return false;
304 }
305
306 bool HeapShared::can_use_archived_heap() {
307 FileMapInfo* static_mapinfo = FileMapInfo::current_info();
308 if (static_mapinfo == nullptr) {
309 return false;
310 }
311 if (!static_mapinfo->has_heap_region()) {
312 return false;
313 }
314 if (!static_mapinfo->object_streaming_mode() &&
315 !Universe::heap()->can_load_archived_objects() &&
316 !UseG1GC) {
317 // Incompatible object format
318 return false;
319 }
320
321 return true;
322 }
323
324 bool HeapShared::is_too_large_to_archive(size_t size) {
325 if (HeapShared::is_writing_streaming_mode()) {
326 return false;
327 } else {
328 return AOTMappedHeapWriter::is_too_large_to_archive(size);
329 }
330 }
331
332 bool HeapShared::is_too_large_to_archive(oop obj) {
333 if (HeapShared::is_writing_streaming_mode()) {
334 return false;
335 } else {
336 return AOTMappedHeapWriter::is_too_large_to_archive(obj);
337 }
338 }
339
340 bool HeapShared::is_string_too_large_to_archive(oop string) {
341 typeArrayOop value = java_lang_String::value_no_keepalive(string);
342 return is_too_large_to_archive(value);
343 }
344
345 void HeapShared::initialize_loading_mode(HeapArchiveMode mode) {
346 assert(_heap_load_mode == HeapArchiveMode::_uninitialized, "already set?");
347 assert(mode != HeapArchiveMode::_uninitialized, "sanity");
348 _heap_load_mode = mode;
349 };
350
351 void HeapShared::initialize_writing_mode() {
352 assert(!FLAG_IS_ERGO(AOTStreamableObjects), "Should not have been ergonomically set yet");
353
354 if (!CDSConfig::is_dumping_archive()) {
355 // We use FLAG_IS_CMDLINE below because we are specifically looking to warn
356 // a user that explicitly sets the flag on the command line for a JVM that is
357 // not dumping an archive.
358 if (FLAG_IS_CMDLINE(AOTStreamableObjects)) {
359 log_warning(cds)("-XX:%cAOTStreamableObjects was specified, "
360 "AOTStreamableObjects is only used for writing "
361 "the AOT cache.",
362 AOTStreamableObjects ? '+' : '-');
363 }
364 }
365
366 // The below checks use !FLAG_IS_DEFAULT instead of FLAG_IS_CMDLINE
367 // because the one step AOT cache creation transfers the AOTStreamableObjects
368 // flag value from the training JVM to the assembly JVM using an environment
369 // variable that sets the flag as ERGO in the assembly JVM.
370 if (FLAG_IS_DEFAULT(AOTStreamableObjects)) {
371 // By default, the value of AOTStreamableObjects should match !UseCompressedOops.
372 FLAG_SET_DEFAULT(AOTStreamableObjects, !UseCompressedOops);
373 } else if (!AOTStreamableObjects && UseZGC) {
374 // Never write mapped heap with ZGC
375 if (CDSConfig::is_dumping_archive()) {
376 log_warning(cds)("Heap archiving without streaming not supported for -XX:+UseZGC");
377 }
378 FLAG_SET_ERGO(AOTStreamableObjects, true);
379 }
380
381 if (CDSConfig::is_dumping_archive()) {
382 // Select default mode
383 assert(_heap_write_mode == HeapArchiveMode::_uninitialized, "already initialized?");
384 _heap_write_mode = AOTStreamableObjects ? HeapArchiveMode::_streaming : HeapArchiveMode::_mapping;
385 }
386 }
387
388 void HeapShared::initialize_streaming() {
389 assert(is_loading_streaming_mode(), "shouldn't call this");
390 if (can_use_archived_heap()) {
391 AOTStreamedHeapLoader::initialize();
392 }
393 }
394
395 void HeapShared::enable_gc() {
396 if (AOTStreamedHeapLoader::is_in_use()) {
397 AOTStreamedHeapLoader::enable_gc();
398 }
399 }
400
401 void HeapShared::materialize_thread_object() {
402 if (AOTStreamedHeapLoader::is_in_use()) {
403 AOTStreamedHeapLoader::materialize_thread_object();
404 }
405 }
406
407 void HeapShared::add_to_dumped_interned_strings(oop string) {
408 assert(HeapShared::is_writing_mapping_mode(), "Only used by this mode");
409 AOTMappedHeapWriter::add_to_dumped_interned_strings(string);
410 }
411
412 void HeapShared::finalize_initialization(FileMapInfo* static_mapinfo) {
413 if (HeapShared::is_loading()) {
414 if (HeapShared::is_loading_streaming_mode()) {
415 // Heap initialization can be done only after vtables are initialized by ReadClosure.
416 AOTStreamedHeapLoader::finish_initialization(static_mapinfo);
417 } else {
418 // Finish up archived heap initialization. These must be
419 // done after ReadClosure.
420 AOTMappedHeapLoader::finish_initialization(static_mapinfo);
421 }
422 }
423 }
424
425 HeapShared::CachedOopInfo* HeapShared::get_cached_oop_info(oop obj) {
426 OopHandle oh(Universe::vm_global(), obj);
427 CachedOopInfo* result = _archived_object_cache->get(oh);
428 oh.release(Universe::vm_global());
429 return result;
430 }
431
432 bool HeapShared::has_been_archived(oop obj) {
433 assert(CDSConfig::is_dumping_heap(), "dump-time only");
434 return get_cached_oop_info(obj) != nullptr;
435 }
436
437 int HeapShared::append_root(oop obj) {
438 assert(CDSConfig::is_dumping_heap(), "dump-time only");
439 if (obj != nullptr) {
440 assert(has_been_archived(obj), "must be");
441 }
442 // No GC should happen since we aren't scanning _pending_roots.
443 assert(Thread::current() == (Thread*)VMThread::vm_thread(), "should be in vm thread");
444
445 return _pending_roots->append(obj);
446 }
447
448 oop HeapShared::get_root(int index, bool clear) {
449 assert(index >= 0, "sanity");
450 assert(!CDSConfig::is_dumping_heap() && CDSConfig::is_using_archive(), "runtime only");
451 assert(is_archived_heap_in_use(), "getting roots into heap that is not used");
452
453 oop result;
454 if (HeapShared::is_loading_streaming_mode()) {
455 result = AOTStreamedHeapLoader::get_root(index);
456 } else {
457 assert(HeapShared::is_loading_mapping_mode(), "must be");
458 result = AOTMappedHeapLoader::get_root(index);
459 }
460
461 if (clear) {
462 clear_root(index);
463 }
464
465 return result;
466 }
467
468 void HeapShared::finish_materialize_objects() {
469 if (AOTStreamedHeapLoader::is_in_use()) {
470 AOTStreamedHeapLoader::finish_materialize_objects();
471 }
472 }
473
474 void HeapShared::clear_root(int index) {
475 assert(index >= 0, "sanity");
476 assert(CDSConfig::is_using_archive(), "must be");
477 if (is_archived_heap_in_use()) {
478 if (log_is_enabled(Debug, aot, heap)) {
479 log_debug(aot, heap)("Clearing root %d: was %zu", index, p2i(get_root(index, false /* clear */)));
480 }
481 if (HeapShared::is_loading_streaming_mode()) {
482 AOTStreamedHeapLoader::clear_root(index);
483 } else {
484 assert(HeapShared::is_loading_mapping_mode(), "must be");
485 AOTMappedHeapLoader::clear_root(index);
486 }
487 }
488 }
489
490 bool HeapShared::archive_object(oop obj, oop referrer, KlassSubGraphInfo* subgraph_info) {
491 assert(CDSConfig::is_dumping_heap(), "dump-time only");
492
493 assert(!obj->is_stackChunk(), "do not archive stack chunks");
494 if (has_been_archived(obj)) {
495 return true;
496 }
497
498 if (is_too_large_to_archive(obj)) {
499 log_debug(aot, heap)("Cannot archive, object (" PTR_FORMAT ") is too large: %zu",
500 p2i(obj), obj->size());
501 debug_trace();
502 return false;
503 }
504
505 AOTOopChecker::check(obj); // Make sure contents of this oop are safe.
506 count_allocation(obj->size());
507
508 if (HeapShared::is_writing_streaming_mode()) {
509 AOTStreamedHeapWriter::add_source_obj(obj);
510 } else {
511 AOTMappedHeapWriter::add_source_obj(obj);
512 }
513
514 OopHandle oh(Universe::vm_global(), obj);
515 CachedOopInfo info = make_cached_oop_info(obj, referrer);
516 archived_object_cache()->put_when_absent(oh, info);
517 archived_object_cache()->maybe_grow();
518
519 Klass* k = obj->klass();
520 if (k->is_instance_klass()) {
521 // Whenever we see a non-array Java object of type X, we mark X to be aot-initialized.
522 // This ensures that during the production run, whenever Java code sees a cached object
523 // of type X, we know that X is already initialized. (see TODO comment below ...)
524
525 if (InstanceKlass::cast(k)->is_enum_subclass()
526 // We can't rerun <clinit> of enum classes (see cdsEnumKlass.cpp) so
527 // we must store them as AOT-initialized.
528 || (subgraph_info == _dump_time_special_subgraph))
529 // TODO: we do this only for the special subgraph for now. Extending this to
530 // other subgraphs would require more refactoring of the core library (such as
531 // move some initialization logic into runtimeSetup()).
532 //
533 // For the other subgraphs, we have a weaker mechanism to ensure that
534 // all classes in a subgraph are initialized before the subgraph is programmatically
535 // returned from jdk.internal.misc.CDS::initializeFromArchive().
536 // See HeapShared::initialize_from_archived_subgraph().
537 {
538 AOTArtifactFinder::add_aot_inited_class(InstanceKlass::cast(k));
539 }
540
541 if (java_lang_Class::is_instance(obj)) {
542 Klass* mirror_k = java_lang_Class::as_Klass(obj);
543 if (mirror_k != nullptr) {
544 AOTArtifactFinder::add_cached_class(mirror_k);
545 }
546 } else if (java_lang_invoke_ResolvedMethodName::is_instance(obj)) {
547 Method* m = java_lang_invoke_ResolvedMethodName::vmtarget(obj);
548 if (m != nullptr) {
549 if (RegeneratedClasses::has_been_regenerated(m)) {
550 m = RegeneratedClasses::get_regenerated_object(m);
551 }
552 InstanceKlass* method_holder = m->method_holder();
553 AOTArtifactFinder::add_cached_class(method_holder);
554 }
555 }
556 }
557
558 if (log_is_enabled(Debug, aot, heap)) {
559 ResourceMark rm;
560 LogTarget(Debug, aot, heap) log;
561 LogStream out(log);
562 out.print("Archived heap object " PTR_FORMAT " : %s ",
563 p2i(obj), obj->klass()->external_name());
564 if (java_lang_Class::is_instance(obj)) {
565 Klass* k = java_lang_Class::as_Klass(obj);
566 if (k != nullptr) {
567 out.print("%s", k->external_name());
568 } else {
569 out.print("primitive");
570 }
571 }
572 out.cr();
573 }
574
575 return true;
576 }
577
578 class MetaspaceObjToOopHandleTable: public HashTable<MetaspaceObj*, OopHandle,
579 36137, // prime number
580 AnyObj::C_HEAP,
581 mtClassShared> {
582 public:
583 oop get_oop(MetaspaceObj* ptr) {
584 MutexLocker ml(ScratchObjects_lock, Mutex::_no_safepoint_check_flag);
585 OopHandle* handle = get(ptr);
586 if (handle != nullptr) {
587 return handle->resolve();
588 } else {
589 return nullptr;
590 }
591 }
592 void set_oop(MetaspaceObj* ptr, oop o) {
593 MutexLocker ml(ScratchObjects_lock, Mutex::_no_safepoint_check_flag);
594 OopHandle handle(Universe::vm_global(), o);
595 bool is_new = put(ptr, handle);
596 assert(is_new, "cannot set twice");
597 }
598 void remove_oop(MetaspaceObj* ptr) {
599 MutexLocker ml(ScratchObjects_lock, Mutex::_no_safepoint_check_flag);
600 OopHandle* handle = get(ptr);
601 if (handle != nullptr) {
602 handle->release(Universe::vm_global());
603 remove(ptr);
604 }
605 }
606 };
607
608 void HeapShared::add_scratch_resolved_references(ConstantPool* src, objArrayOop dest) {
609 if (SystemDictionaryShared::is_builtin_loader(src->pool_holder()->class_loader_data())) {
610 _scratch_objects_table->set_oop(src, dest);
611 }
612 }
613
614 objArrayOop HeapShared::scratch_resolved_references(ConstantPool* src) {
615 return (objArrayOop)_scratch_objects_table->get_oop(src);
616 }
617
618 void HeapShared::init_dumping() {
619 _scratch_objects_table = new (mtClass)MetaspaceObjToOopHandleTable();
620 _pending_roots = new GrowableArrayCHeap<oop, mtClassShared>(500);
621 }
622
623 void HeapShared::init_scratch_objects_for_basic_type_mirrors(TRAPS) {
624 for (int i = T_BOOLEAN; i < T_VOID+1; i++) {
625 BasicType bt = (BasicType)i;
626 if (!is_reference_type(bt)) {
627 oop m = java_lang_Class::create_basic_type_mirror(type2name(bt), bt, CHECK);
628 _scratch_basic_type_mirrors[i] = OopHandle(Universe::vm_global(), m);
629 }
630 }
631 }
632
633 // Given java_mirror that represents a (primitive or reference) type T,
634 // return the "scratch" version that represents the same type T. Note
635 // that java_mirror will be returned if the mirror is already a scratch mirror.
636 //
637 // See java_lang_Class::create_scratch_mirror() for more info.
638 oop HeapShared::scratch_java_mirror(oop java_mirror) {
639 assert(java_lang_Class::is_instance(java_mirror), "must be");
640
641 for (int i = T_BOOLEAN; i < T_VOID+1; i++) {
642 BasicType bt = (BasicType)i;
643 if (!is_reference_type(bt)) {
644 if (_scratch_basic_type_mirrors[i].resolve() == java_mirror) {
645 return java_mirror;
646 }
647 }
648 }
649
650 if (java_lang_Class::is_primitive(java_mirror)) {
651 return scratch_java_mirror(java_lang_Class::as_BasicType(java_mirror));
652 } else {
653 return scratch_java_mirror(java_lang_Class::as_Klass(java_mirror));
654 }
655 }
656
657 oop HeapShared::scratch_java_mirror(BasicType t) {
658 assert((uint)t < T_VOID+1, "range check");
659 assert(!is_reference_type(t), "sanity");
660 return _scratch_basic_type_mirrors[t].resolve();
661 }
662
663 oop HeapShared::scratch_java_mirror(Klass* k) {
664 return _scratch_objects_table->get_oop(k);
665 }
666
667 void HeapShared::set_scratch_java_mirror(Klass* k, oop mirror) {
668 _scratch_objects_table->set_oop(k, mirror);
669 }
670
671 void HeapShared::remove_scratch_objects(Klass* k) {
672 // Klass is being deallocated. Java mirror can still be alive, and it should not
673 // point to dead klass. We need to break the link from mirror to the Klass.
674 // See how InstanceKlass::deallocate_contents does it for normal mirrors.
675 oop mirror = _scratch_objects_table->get_oop(k);
676 if (mirror != nullptr) {
677 java_lang_Class::set_klass(mirror, nullptr);
678 }
679 _scratch_objects_table->remove_oop(k);
680 if (k->is_instance_klass()) {
681 _scratch_objects_table->remove(InstanceKlass::cast(k)->constants());
682 }
683 }
684
685 //TODO: we eventually want a more direct test for these kinds of things.
686 //For example the JVM could record some bit of context from the creation
687 //of the klass, such as who called the hidden class factory. Using
688 //string compares on names is fragile and will break as soon as somebody
689 //changes the names in the JDK code. See discussion in JDK-8342481 for
690 //related ideas about marking AOT-related classes.
691 bool HeapShared::is_lambda_form_klass(InstanceKlass* ik) {
692 return ik->is_hidden() &&
693 (ik->name()->starts_with("java/lang/invoke/LambdaForm$MH+") ||
694 ik->name()->starts_with("java/lang/invoke/LambdaForm$DMH+") ||
695 ik->name()->starts_with("java/lang/invoke/LambdaForm$BMH+") ||
696 ik->name()->starts_with("java/lang/invoke/LambdaForm$VH+"));
697 }
698
699 bool HeapShared::is_lambda_proxy_klass(InstanceKlass* ik) {
700 return ik->is_hidden() && (ik->name()->index_of_at(0, "$$Lambda+", 9) > 0);
701 }
702
703 bool HeapShared::is_string_concat_klass(InstanceKlass* ik) {
704 return ik->is_hidden() && ik->name()->starts_with("java/lang/String$$StringConcat");
705 }
706
707 bool HeapShared::is_archivable_hidden_klass(InstanceKlass* ik) {
708 return CDSConfig::is_dumping_method_handles() &&
709 (is_lambda_form_klass(ik) || is_lambda_proxy_klass(ik) || is_string_concat_klass(ik));
710 }
711
712
713 void HeapShared::copy_and_rescan_aot_inited_mirror(InstanceKlass* ik) {
714 ik->set_has_aot_initialized_mirror();
715
716 oop orig_mirror;
717 if (RegeneratedClasses::is_regenerated_object(ik)) {
718 InstanceKlass* orig_ik = RegeneratedClasses::get_original_object(ik);
719 precond(orig_ik->is_initialized());
720 orig_mirror = orig_ik->java_mirror();
721 } else {
722 precond(ik->is_initialized());
723 orig_mirror = ik->java_mirror();
724 }
725
726 oop m = scratch_java_mirror(ik);
727 int nfields = 0;
728 for (JavaFieldStream fs(ik); !fs.done(); fs.next()) {
729 if (fs.access_flags().is_static()) {
730 fieldDescriptor& fd = fs.field_descriptor();
731 int offset = fd.offset();
732 switch (fd.field_type()) {
733 case T_OBJECT:
734 case T_ARRAY:
735 {
736 oop field_obj = orig_mirror->obj_field(offset);
737 if (offset == java_lang_Class::reflection_data_offset()) {
738 // Class::reflectData use SoftReference, which cannot be archived. Set it
739 // to null and it will be recreated at runtime.
740 field_obj = nullptr;
741 }
742 m->obj_field_put(offset, field_obj);
743 if (field_obj != nullptr) {
744 bool success = archive_reachable_objects_from(1, _dump_time_special_subgraph, field_obj);
745 assert(success, "sanity");
746 }
747 }
748 break;
749 case T_BOOLEAN:
750 m->bool_field_put(offset, orig_mirror->bool_field(offset));
751 break;
752 case T_BYTE:
753 m->byte_field_put(offset, orig_mirror->byte_field(offset));
754 break;
755 case T_SHORT:
756 m->short_field_put(offset, orig_mirror->short_field(offset));
757 break;
758 case T_CHAR:
759 m->char_field_put(offset, orig_mirror->char_field(offset));
760 break;
761 case T_INT:
762 m->int_field_put(offset, orig_mirror->int_field(offset));
763 break;
764 case T_LONG:
765 m->long_field_put(offset, orig_mirror->long_field(offset));
766 break;
767 case T_FLOAT:
768 m->float_field_put(offset, orig_mirror->float_field(offset));
769 break;
770 case T_DOUBLE:
771 m->double_field_put(offset, orig_mirror->double_field(offset));
772 break;
773 default:
774 ShouldNotReachHere();
775 }
776 nfields ++;
777 }
778 }
779
780 oop class_data = java_lang_Class::class_data(orig_mirror);
781 java_lang_Class::set_class_data(m, class_data);
782 if (class_data != nullptr) {
783 bool success = archive_reachable_objects_from(1, _dump_time_special_subgraph, class_data);
784 assert(success, "sanity");
785 }
786
787 if (log_is_enabled(Debug, aot, init)) {
788 ResourceMark rm;
789 log_debug(aot, init)("copied %3d field(s) in aot-initialized mirror %s%s%s", nfields, ik->external_name(),
790 ik->is_hidden() ? " (hidden)" : "",
791 ik->is_enum_subclass() ? " (enum)" : "");
792 }
793 }
794
795 void HeapShared::copy_java_mirror(oop orig_mirror, oop scratch_m) {
796 // We need to retain the identity_hash, because it may have been used by some hashtables
797 // in the shared heap.
798 if (!orig_mirror->fast_no_hash_check()) {
799 intptr_t src_hash = orig_mirror->identity_hash();
800 if (UseCompactObjectHeaders) {
801 narrowKlass nk = CompressedKlassPointers::encode(orig_mirror->klass());
802 scratch_m->set_mark(markWord::prototype().set_narrow_klass(nk).copy_set_hash(src_hash));
803 } else {
804 scratch_m->set_mark(markWord::prototype().copy_set_hash(src_hash));
805 }
806 assert(scratch_m->mark().is_unlocked(), "sanity");
807
808 DEBUG_ONLY(intptr_t archived_hash = scratch_m->identity_hash());
809 assert(src_hash == archived_hash, "Different hash codes: original " INTPTR_FORMAT ", archived " INTPTR_FORMAT, src_hash, archived_hash);
810 }
811
812 if (CDSConfig::is_dumping_aot_linked_classes()) {
813 java_lang_Class::set_module(scratch_m, java_lang_Class::module(orig_mirror));
814 java_lang_Class::set_protection_domain(scratch_m, java_lang_Class::protection_domain(orig_mirror));
815 }
816 }
817
818 static objArrayOop get_archived_resolved_references(InstanceKlass* src_ik) {
819 if (SystemDictionaryShared::is_builtin_loader(src_ik->class_loader_data())) {
820 objArrayOop rr = src_ik->constants()->resolved_references_or_null();
821 if (rr != nullptr && !HeapShared::is_too_large_to_archive(rr)) {
822 return HeapShared::scratch_resolved_references(src_ik->constants());
823 }
824 }
825 return nullptr;
826 }
827
828 void HeapShared::archive_strings() {
829 assert(HeapShared::is_writing_mapping_mode(), "should not reach here");
830 oop shared_strings_array = StringTable::init_shared_strings_array();
831 bool success = archive_reachable_objects_from(1, _dump_time_special_subgraph, shared_strings_array);
832 assert(success, "shared strings array must not point to arrays or strings that are too large to archive");
833 StringTable::set_shared_strings_array_index(append_root(shared_strings_array));
834 }
835
836 int HeapShared::archive_exception_instance(oop exception) {
837 bool success = archive_reachable_objects_from(1, _dump_time_special_subgraph, exception);
838 assert(success, "sanity");
839 return append_root(exception);
840 }
841
842 void HeapShared::get_pointer_info(oop src_obj, bool& has_oop_pointers, bool& has_native_pointers) {
843 OopHandle oh(&src_obj);
844 CachedOopInfo* info = archived_object_cache()->get(oh);
845 assert(info != nullptr, "must be");
846 has_oop_pointers = info->has_oop_pointers();
847 has_native_pointers = info->has_native_pointers();
848 }
849
850 void HeapShared::set_has_native_pointers(oop src_obj) {
851 OopHandle oh(&src_obj);
852 CachedOopInfo* info = archived_object_cache()->get(oh);
853 assert(info != nullptr, "must be");
854 info->set_has_native_pointers();
855 }
856
857 // Between start_scanning_for_oops() and end_scanning_for_oops(), we discover all Java heap objects that
858 // should be stored in the AOT cache. The scanning is coordinated by AOTArtifactFinder.
859 void HeapShared::start_scanning_for_oops() {
860 {
861 NoSafepointVerifier nsv;
862
863 // The special subgraph doesn't belong to any class. We use Object_klass() here just
864 // for convenience.
865 _dump_time_special_subgraph = init_subgraph_info(vmClasses::Object_klass(), false);
866
867 // Cache for recording where the archived objects are copied to
868 create_archived_object_cache();
869
870 if (HeapShared::is_writing_mapping_mode() && (UseG1GC || UseCompressedOops)) {
871 aot_log_info(aot)("Heap range = [" PTR_FORMAT " - " PTR_FORMAT "]",
872 UseCompressedOops ? p2i(CompressedOops::begin()) :
873 p2i((address)G1CollectedHeap::heap()->reserved().start()),
874 UseCompressedOops ? p2i(CompressedOops::end()) :
875 p2i((address)G1CollectedHeap::heap()->reserved().end()));
876 }
877
878 archive_subgraphs();
879 }
880
881 init_seen_objects_table();
882 Universe::archive_exception_instances();
883 }
884
885 void HeapShared::end_scanning_for_oops() {
886 if (is_writing_mapping_mode()) {
887 archive_strings();
888 }
889 delete_seen_objects_table();
890 }
891
892 void HeapShared::write_heap(ArchiveMappedHeapInfo* mapped_heap_info, ArchiveStreamedHeapInfo* streamed_heap_info) {
893 {
894 NoSafepointVerifier nsv;
895 CDSHeapVerifier::verify();
896 check_special_subgraph_classes();
897 }
898
899 if (HeapShared::is_writing_mapping_mode()) {
900 StringTable::write_shared_table();
901 AOTMappedHeapWriter::write(_pending_roots, mapped_heap_info);
902 } else {
903 assert(HeapShared::is_writing_streaming_mode(), "are there more modes?");
904 AOTStreamedHeapWriter::write(_pending_roots, streamed_heap_info);
905 }
906
907 ArchiveBuilder::OtherROAllocMark mark;
908 write_subgraph_info_table();
909 }
910
911 void HeapShared::scan_java_mirror(oop orig_mirror) {
912 oop m = scratch_java_mirror(orig_mirror);
913 if (m != nullptr) { // nullptr if for custom class loader
914 copy_java_mirror(orig_mirror, m);
915 bool success = archive_reachable_objects_from(1, _dump_time_special_subgraph, m);
916 assert(success, "sanity");
917 }
918 }
919
920 void HeapShared::scan_java_class(Klass* orig_k) {
921 scan_java_mirror(orig_k->java_mirror());
922
923 if (orig_k->is_instance_klass()) {
924 InstanceKlass* orig_ik = InstanceKlass::cast(orig_k);
925 orig_ik->constants()->prepare_resolved_references_for_archiving();
926 objArrayOop rr = get_archived_resolved_references(orig_ik);
927 if (rr != nullptr) {
928 bool success = HeapShared::archive_reachable_objects_from(1, _dump_time_special_subgraph, rr);
929 assert(success, "must be");
930 }
931 }
932 }
933
934 void HeapShared::archive_subgraphs() {
935 assert(CDSConfig::is_dumping_heap(), "must be");
936
937 archive_object_subgraphs(archive_subgraph_entry_fields,
938 false /* is_full_module_graph */);
939
940 if (CDSConfig::is_dumping_full_module_graph()) {
941 archive_object_subgraphs(fmg_archive_subgraph_entry_fields,
942 true /* is_full_module_graph */);
943 Modules::verify_archived_modules();
944 }
945 }
946
947 //
948 // Subgraph archiving support
949 //
950 HeapShared::DumpTimeKlassSubGraphInfoTable* HeapShared::_dump_time_subgraph_info_table = nullptr;
951 HeapShared::RunTimeKlassSubGraphInfoTable HeapShared::_run_time_subgraph_info_table;
952
953 // Get the subgraph_info for Klass k. A new subgraph_info is created if
954 // there is no existing one for k. The subgraph_info records the "buffered"
955 // address of the class.
956 KlassSubGraphInfo* HeapShared::init_subgraph_info(Klass* k, bool is_full_module_graph) {
957 assert(CDSConfig::is_dumping_heap(), "dump time only");
958 bool created;
959 KlassSubGraphInfo* info =
960 _dump_time_subgraph_info_table->put_if_absent(k, KlassSubGraphInfo(k, is_full_module_graph),
961 &created);
962 assert(created, "must not initialize twice");
963 return info;
964 }
965
966 KlassSubGraphInfo* HeapShared::get_subgraph_info(Klass* k) {
967 assert(CDSConfig::is_dumping_heap(), "dump time only");
968 KlassSubGraphInfo* info = _dump_time_subgraph_info_table->get(k);
969 assert(info != nullptr, "must have been initialized");
970 return info;
971 }
972
973 // Add an entry field to the current KlassSubGraphInfo.
974 void KlassSubGraphInfo::add_subgraph_entry_field(int static_field_offset, oop v) {
975 assert(CDSConfig::is_dumping_heap(), "dump time only");
976 if (_subgraph_entry_fields == nullptr) {
977 _subgraph_entry_fields =
978 new (mtClass) GrowableArray<int>(10, mtClass);
979 }
980 _subgraph_entry_fields->append(static_field_offset);
981 _subgraph_entry_fields->append(HeapShared::append_root(v));
982 }
983
984 // Add the Klass* for an object in the current KlassSubGraphInfo's subgraphs.
985 // Only objects of boot classes can be included in sub-graph.
986 void KlassSubGraphInfo::add_subgraph_object_klass(Klass* orig_k) {
987 assert(CDSConfig::is_dumping_heap(), "dump time only");
988
989 if (_subgraph_object_klasses == nullptr) {
990 _subgraph_object_klasses =
991 new (mtClass) GrowableArray<Klass*>(50, mtClass);
992 }
993
994 if (_k == orig_k) {
995 // Don't add the Klass containing the sub-graph to it's own klass
996 // initialization list.
997 return;
998 }
999
1000 if (orig_k->is_instance_klass()) {
1001 #ifdef ASSERT
1002 InstanceKlass* ik = InstanceKlass::cast(orig_k);
1003 if (CDSConfig::is_dumping_method_handles()) {
1004 // -XX:AOTInitTestClass must be used carefully in regression tests to
1005 // include only classes that are safe to aot-initialize.
1006 assert(ik->class_loader() == nullptr ||
1007 HeapShared::is_lambda_proxy_klass(ik) ||
1008 AOTClassInitializer::has_test_class(),
1009 "we can archive only instances of boot classes or lambda proxy classes");
1010 } else {
1011 assert(ik->class_loader() == nullptr, "must be boot class");
1012 }
1013 #endif
1014 // vmClasses::xxx_klass() are not updated, need to check
1015 // the original Klass*
1016 if (orig_k == vmClasses::String_klass() ||
1017 orig_k == vmClasses::Object_klass()) {
1018 // Initialized early during VM initialization. No need to be added
1019 // to the sub-graph object class list.
1020 return;
1021 }
1022 check_allowed_klass(InstanceKlass::cast(orig_k));
1023 } else if (orig_k->is_objArray_klass()) {
1024 Klass* abk = ObjArrayKlass::cast(orig_k)->bottom_klass();
1025 if (abk->is_instance_klass()) {
1026 assert(InstanceKlass::cast(abk)->defined_by_boot_loader(),
1027 "must be boot class");
1028 check_allowed_klass(InstanceKlass::cast(ObjArrayKlass::cast(orig_k)->bottom_klass()));
1029 }
1030 if (orig_k == Universe::objectArrayKlass()) {
1031 // Initialized early during Universe::genesis. No need to be added
1032 // to the list.
1033 return;
1034 }
1035 } else {
1036 assert(orig_k->is_typeArray_klass(), "must be");
1037 // Primitive type arrays are created early during Universe::genesis.
1038 return;
1039 }
1040
1041 if (log_is_enabled(Debug, aot, heap)) {
1042 if (!_subgraph_object_klasses->contains(orig_k)) {
1043 ResourceMark rm;
1044 log_debug(aot, heap)("Adding klass %s", orig_k->external_name());
1045 }
1046 }
1047
1048 _subgraph_object_klasses->append_if_missing(orig_k);
1049 _has_non_early_klasses |= is_non_early_klass(orig_k);
1050 }
1051
1052 void KlassSubGraphInfo::check_allowed_klass(InstanceKlass* ik) {
1053 #ifndef PRODUCT
1054 if (AOTClassInitializer::has_test_class()) {
1055 // The tests can cache arbitrary types of objects.
1056 return;
1057 }
1058 #endif
1059
1060 if (ik->module()->name() == vmSymbols::java_base()) {
1061 assert(ik->package() != nullptr, "classes in java.base cannot be in unnamed package");
1062 return;
1063 }
1064
1065 const char* lambda_msg = "";
1066 if (CDSConfig::is_dumping_method_handles()) {
1067 lambda_msg = ", or a lambda proxy class";
1068 if (HeapShared::is_lambda_proxy_klass(ik) &&
1069 (ik->class_loader() == nullptr ||
1070 ik->class_loader() == SystemDictionary::java_platform_loader() ||
1071 ik->class_loader() == SystemDictionary::java_system_loader())) {
1072 return;
1073 }
1074 }
1075
1076 #ifndef PRODUCT
1077 if (!ik->module()->is_named() && ik->package() == nullptr && ArchiveHeapTestClass != nullptr) {
1078 // This class is loaded by ArchiveHeapTestClass
1079 return;
1080 }
1081 const char* testcls_msg = ", or a test class in an unnamed package of an unnamed module";
1082 #else
1083 const char* testcls_msg = "";
1084 #endif
1085
1086 ResourceMark rm;
1087 log_error(aot, heap)("Class %s not allowed in archive heap. Must be in java.base%s%s",
1088 ik->external_name(), lambda_msg, testcls_msg);
1089 AOTMetaspace::unrecoverable_writing_error();
1090 }
1091
1092 bool KlassSubGraphInfo::is_non_early_klass(Klass* k) {
1093 if (k->is_objArray_klass()) {
1094 k = ObjArrayKlass::cast(k)->bottom_klass();
1095 }
1096 if (k->is_instance_klass()) {
1097 if (!SystemDictionaryShared::is_early_klass(InstanceKlass::cast(k))) {
1098 ResourceMark rm;
1099 log_info(aot, heap)("non-early: %s", k->external_name());
1100 return true;
1101 } else {
1102 return false;
1103 }
1104 } else {
1105 return false;
1106 }
1107 }
1108
1109 // Initialize an archived subgraph_info_record from the given KlassSubGraphInfo.
1110 void ArchivedKlassSubGraphInfoRecord::init(KlassSubGraphInfo* info) {
1111 _k = ArchiveBuilder::get_buffered_klass(info->klass());
1112 _entry_field_records = nullptr;
1113 _subgraph_object_klasses = nullptr;
1114 _is_full_module_graph = info->is_full_module_graph();
1115
1116 if (_is_full_module_graph) {
1117 // Consider all classes referenced by the full module graph as early -- we will be
1118 // allocating objects of these classes during JVMTI early phase, so they cannot
1119 // be processed by (non-early) JVMTI ClassFileLoadHook
1120 _has_non_early_klasses = false;
1121 } else {
1122 _has_non_early_klasses = info->has_non_early_klasses();
1123 }
1124
1125 if (_has_non_early_klasses) {
1126 ResourceMark rm;
1127 log_info(aot, heap)(
1128 "Subgraph of klass %s has non-early klasses and cannot be used when JVMTI ClassFileLoadHook is enabled",
1129 _k->external_name());
1130 }
1131
1132 // populate the entry fields
1133 GrowableArray<int>* entry_fields = info->subgraph_entry_fields();
1134 if (entry_fields != nullptr) {
1135 int num_entry_fields = entry_fields->length();
1136 assert(num_entry_fields % 2 == 0, "sanity");
1137 _entry_field_records =
1138 ArchiveBuilder::new_ro_array<int>(num_entry_fields);
1139 for (int i = 0 ; i < num_entry_fields; i++) {
1140 _entry_field_records->at_put(i, entry_fields->at(i));
1141 }
1142 }
1143
1144 // <recorded_klasses> has the Klasses of all the objects that are referenced by this subgraph.
1145 // Copy those that need to be explicitly initialized into <_subgraph_object_klasses>.
1146 GrowableArray<Klass*>* recorded_klasses = info->subgraph_object_klasses();
1147 if (recorded_klasses != nullptr) {
1148 // AOT-inited classes are automatically marked as "initialized" during bootstrap. When
1149 // programmatically loading a subgraph, we only need to explicitly initialize the classes
1150 // that are not aot-inited.
1151 int num_to_copy = 0;
1152 for (int i = 0; i < recorded_klasses->length(); i++) {
1153 Klass* subgraph_k = ArchiveBuilder::get_buffered_klass(recorded_klasses->at(i));
1154 if (!subgraph_k->has_aot_initialized_mirror()) {
1155 num_to_copy ++;
1156 }
1157 }
1158
1159 _subgraph_object_klasses = ArchiveBuilder::new_ro_array<Klass*>(num_to_copy);
1160 bool is_special = (_k == ArchiveBuilder::get_buffered_klass(vmClasses::Object_klass()));
1161 for (int i = 0, n = 0; i < recorded_klasses->length(); i++) {
1162 Klass* subgraph_k = ArchiveBuilder::get_buffered_klass(recorded_klasses->at(i));
1163 if (subgraph_k->has_aot_initialized_mirror()) {
1164 continue;
1165 }
1166 if (log_is_enabled(Info, aot, heap)) {
1167 ResourceMark rm;
1168 const char* owner_name = is_special ? "<special>" : _k->external_name();
1169 if (subgraph_k->is_instance_klass()) {
1170 InstanceKlass* src_ik = InstanceKlass::cast(ArchiveBuilder::current()->get_source_addr(subgraph_k));
1171 }
1172 log_info(aot, heap)(
1173 "Archived object klass %s (%2d) => %s",
1174 owner_name, n, subgraph_k->external_name());
1175 }
1176 _subgraph_object_klasses->at_put(n, subgraph_k);
1177 ArchivePtrMarker::mark_pointer(_subgraph_object_klasses->adr_at(n));
1178 n++;
1179 }
1180 }
1181
1182 ArchivePtrMarker::mark_pointer(&_k);
1183 ArchivePtrMarker::mark_pointer(&_entry_field_records);
1184 ArchivePtrMarker::mark_pointer(&_subgraph_object_klasses);
1185 }
1186
1187 class HeapShared::CopyKlassSubGraphInfoToArchive : StackObj {
1188 CompactHashtableWriter* _writer;
1189 public:
1190 CopyKlassSubGraphInfoToArchive(CompactHashtableWriter* writer) : _writer(writer) {}
1191
1192 bool do_entry(Klass* klass, KlassSubGraphInfo& info) {
1193 if (info.subgraph_object_klasses() != nullptr || info.subgraph_entry_fields() != nullptr) {
1194 ArchivedKlassSubGraphInfoRecord* record = HeapShared::archive_subgraph_info(&info);
1195 Klass* buffered_k = ArchiveBuilder::get_buffered_klass(klass);
1196 unsigned int hash = SystemDictionaryShared::hash_for_shared_dictionary((address)buffered_k);
1197 u4 delta = ArchiveBuilder::current()->any_to_offset_u4(record);
1198 _writer->add(hash, delta);
1199 }
1200 return true; // keep on iterating
1201 }
1202 };
1203
1204 ArchivedKlassSubGraphInfoRecord* HeapShared::archive_subgraph_info(KlassSubGraphInfo* info) {
1205 ArchivedKlassSubGraphInfoRecord* record =
1206 (ArchivedKlassSubGraphInfoRecord*)ArchiveBuilder::ro_region_alloc(sizeof(ArchivedKlassSubGraphInfoRecord));
1207 record->init(info);
1208 if (info == _dump_time_special_subgraph) {
1209 _run_time_special_subgraph = record;
1210 }
1211 return record;
1212 }
1213
1214 // Build the records of archived subgraph infos, which include:
1215 // - Entry points to all subgraphs from the containing class mirror. The entry
1216 // points are static fields in the mirror. For each entry point, the field
1217 // offset, and value are recorded in the sub-graph
1218 // info. The value is stored back to the corresponding field at runtime.
1219 // - A list of klasses that need to be loaded/initialized before archived
1220 // java object sub-graph can be accessed at runtime.
1221 void HeapShared::write_subgraph_info_table() {
1222 // Allocate the contents of the hashtable(s) inside the RO region of the CDS archive.
1223 DumpTimeKlassSubGraphInfoTable* d_table = _dump_time_subgraph_info_table;
1224 CompactHashtableStats stats;
1225
1226 _run_time_subgraph_info_table.reset();
1227
1228 CompactHashtableWriter writer(d_table->number_of_entries(), &stats);
1229 CopyKlassSubGraphInfoToArchive copy(&writer);
1230 d_table->iterate(©);
1231 writer.dump(&_run_time_subgraph_info_table, "subgraphs");
1232
1233 #ifndef PRODUCT
1234 if (ArchiveHeapTestClass != nullptr) {
1235 size_t len = strlen(ArchiveHeapTestClass) + 1;
1236 Array<char>* array = ArchiveBuilder::new_ro_array<char>((int)len);
1237 strncpy(array->adr_at(0), ArchiveHeapTestClass, len);
1238 _archived_ArchiveHeapTestClass = array;
1239 }
1240 #endif
1241 if (log_is_enabled(Info, aot, heap)) {
1242 print_stats();
1243 }
1244 }
1245
1246 void HeapShared::serialize_tables(SerializeClosure* soc) {
1247
1248 #ifndef PRODUCT
1249 soc->do_ptr(&_archived_ArchiveHeapTestClass);
1250 if (soc->reading() && _archived_ArchiveHeapTestClass != nullptr) {
1251 _test_class_name = _archived_ArchiveHeapTestClass->adr_at(0);
1252 setup_test_class(_test_class_name);
1253 }
1254 #endif
1255
1256 _run_time_subgraph_info_table.serialize_header(soc);
1257 soc->do_ptr(&_run_time_special_subgraph);
1258 }
1259
1260 static void verify_the_heap(Klass* k, const char* which) {
1261 if (VerifyArchivedFields > 0) {
1262 ResourceMark rm;
1263 log_info(aot, heap)("Verify heap %s initializing static field(s) in %s",
1264 which, k->external_name());
1265
1266 if (VerifyArchivedFields == 1) {
1267 VM_Verify verify_op;
1268 VMThread::execute(&verify_op);
1269 } else if (VerifyArchivedFields == 2 && is_init_completed()) {
1270 // At this time, the oop->klass() of some archived objects in the heap may not
1271 // have been loaded into the system dictionary yet. Nevertheless, oop->klass() should
1272 // have enough information (object size, oop maps, etc) so that a GC can be safely
1273 // performed.
1274 //
1275 // -XX:VerifyArchivedFields=2 force a GC to happen in such an early stage
1276 // to check for GC safety.
1277 log_info(aot, heap)("Trigger GC %s initializing static field(s) in %s",
1278 which, k->external_name());
1279 FlagSetting fs1(VerifyBeforeGC, true);
1280 FlagSetting fs2(VerifyDuringGC, true);
1281 FlagSetting fs3(VerifyAfterGC, true);
1282 Universe::heap()->collect(GCCause::_java_lang_system_gc);
1283 }
1284 }
1285 }
1286
1287 // Before GC can execute, we must ensure that all oops reachable from HeapShared::roots()
1288 // have a valid klass. I.e., oopDesc::klass() must have already been resolved.
1289 //
1290 // Note: if a ArchivedKlassSubGraphInfoRecord contains non-early classes, and JVMTI
1291 // ClassFileLoadHook is enabled, it's possible for this class to be dynamically replaced. In
1292 // this case, we will not load the ArchivedKlassSubGraphInfoRecord and will clear its roots.
1293 void HeapShared::resolve_classes(JavaThread* current) {
1294 assert(CDSConfig::is_using_archive(), "runtime only!");
1295 if (!is_archived_heap_in_use()) {
1296 return; // nothing to do
1297 }
1298 resolve_classes_for_subgraphs(current, archive_subgraph_entry_fields);
1299 resolve_classes_for_subgraphs(current, fmg_archive_subgraph_entry_fields);
1300 }
1301
1302 void HeapShared::resolve_classes_for_subgraphs(JavaThread* current, ArchivableStaticFieldInfo fields[]) {
1303 for (int i = 0; fields[i].valid(); i++) {
1304 ArchivableStaticFieldInfo* info = &fields[i];
1305 TempNewSymbol klass_name = SymbolTable::new_symbol(info->klass_name);
1306 InstanceKlass* k = SystemDictionaryShared::find_builtin_class(klass_name);
1307 assert(k != nullptr && k->defined_by_boot_loader(), "sanity");
1308 resolve_classes_for_subgraph_of(current, k);
1309 }
1310 }
1311
1312 void HeapShared::resolve_classes_for_subgraph_of(JavaThread* current, Klass* k) {
1313 JavaThread* THREAD = current;
1314 ExceptionMark em(THREAD);
1315 const ArchivedKlassSubGraphInfoRecord* record =
1316 resolve_or_init_classes_for_subgraph_of(k, /*do_init=*/false, THREAD);
1317 if (HAS_PENDING_EXCEPTION) {
1318 CLEAR_PENDING_EXCEPTION;
1319 }
1320 if (record == nullptr) {
1321 clear_archived_roots_of(k);
1322 }
1323 }
1324
1325 void HeapShared::initialize_java_lang_invoke(TRAPS) {
1326 if (CDSConfig::is_using_aot_linked_classes() || CDSConfig::is_dumping_method_handles()) {
1327 resolve_or_init("java/lang/invoke/Invokers$Holder", true, CHECK);
1328 resolve_or_init("java/lang/invoke/MethodHandle", true, CHECK);
1329 resolve_or_init("java/lang/invoke/MethodHandleNatives", true, CHECK);
1330 resolve_or_init("java/lang/invoke/DirectMethodHandle$Holder", true, CHECK);
1331 resolve_or_init("java/lang/invoke/DelegatingMethodHandle$Holder", true, CHECK);
1332 resolve_or_init("java/lang/invoke/LambdaForm$Holder", true, CHECK);
1333 resolve_or_init("java/lang/invoke/BoundMethodHandle$Species_L", true, CHECK);
1334 }
1335 }
1336
1337 // Initialize the InstanceKlasses of objects that are reachable from the following roots:
1338 // - interned strings
1339 // - Klass::java_mirror() -- including aot-initialized mirrors such as those of Enum klasses.
1340 // - ConstantPool::resolved_references()
1341 // - Universe::<xxx>_exception_instance()
1342 //
1343 // For example, if this enum class is initialized at AOT cache assembly time:
1344 //
1345 // enum Fruit {
1346 // APPLE, ORANGE, BANANA;
1347 // static final Set<Fruit> HAVE_SEEDS = new HashSet<>(Arrays.asList(APPLE, ORANGE));
1348 // }
1349 //
1350 // the aot-initialized mirror of Fruit has a static field that references HashSet, which
1351 // should be initialized before any Java code can access the Fruit class. Note that
1352 // HashSet itself doesn't necessary need to be an aot-initialized class.
1353 void HeapShared::init_classes_for_special_subgraph(Handle class_loader, TRAPS) {
1354 if (!is_archived_heap_in_use()) {
1355 return;
1356 }
1357
1358 assert( _run_time_special_subgraph != nullptr, "must be");
1359 Array<Klass*>* klasses = _run_time_special_subgraph->subgraph_object_klasses();
1360 if (klasses != nullptr) {
1361 for (int pass = 0; pass < 2; pass ++) {
1362 for (int i = 0; i < klasses->length(); i++) {
1363 Klass* k = klasses->at(i);
1364 if (k->class_loader_data() == nullptr) {
1365 // This class is not yet loaded. We will initialize it in a later phase.
1366 // For example, we have loaded only AOTLinkedClassCategory::BOOT1 classes
1367 // but k is part of AOTLinkedClassCategory::BOOT2.
1368 continue;
1369 }
1370 if (k->class_loader() == class_loader()) {
1371 if (pass == 0) {
1372 if (k->is_instance_klass()) {
1373 InstanceKlass::cast(k)->link_class(CHECK);
1374 }
1375 } else {
1376 resolve_or_init(k, /*do_init*/true, CHECK);
1377 }
1378 }
1379 }
1380 }
1381 }
1382 }
1383
1384 void HeapShared::initialize_from_archived_subgraph(JavaThread* current, Klass* k) {
1385 JavaThread* THREAD = current;
1386 if (!is_archived_heap_in_use()) {
1387 return; // nothing to do
1388 }
1389
1390 if (k->name()->equals("jdk/internal/module/ArchivedModuleGraph") &&
1391 !CDSConfig::is_using_optimized_module_handling() &&
1392 // archive was created with --module-path
1393 AOTClassLocationConfig::runtime()->num_module_paths() > 0) {
1394 // ArchivedModuleGraph was created with a --module-path that's different than the runtime --module-path.
1395 // Thus, it might contain references to modules that do not exist at runtime. We cannot use it.
1396 log_info(aot, heap)("Skip initializing ArchivedModuleGraph subgraph: is_using_optimized_module_handling=%s num_module_paths=%d",
1397 BOOL_TO_STR(CDSConfig::is_using_optimized_module_handling()),
1398 AOTClassLocationConfig::runtime()->num_module_paths());
1399 return;
1400 }
1401
1402 ExceptionMark em(THREAD);
1403 const ArchivedKlassSubGraphInfoRecord* record =
1404 resolve_or_init_classes_for_subgraph_of(k, /*do_init=*/true, THREAD);
1405
1406 if (HAS_PENDING_EXCEPTION) {
1407 CLEAR_PENDING_EXCEPTION;
1408 // None of the field value will be set if there was an exception when initializing the classes.
1409 // The java code will not see any of the archived objects in the
1410 // subgraphs referenced from k in this case.
1411 return;
1412 }
1413
1414 if (record != nullptr) {
1415 init_archived_fields_for(k, record);
1416 }
1417 }
1418
1419 const ArchivedKlassSubGraphInfoRecord*
1420 HeapShared::resolve_or_init_classes_for_subgraph_of(Klass* k, bool do_init, TRAPS) {
1421 assert(!CDSConfig::is_dumping_heap(), "Should not be called when dumping heap");
1422
1423 if (!k->in_aot_cache()) {
1424 return nullptr;
1425 }
1426 unsigned int hash = SystemDictionaryShared::hash_for_shared_dictionary_quick(k);
1427 const ArchivedKlassSubGraphInfoRecord* record = _run_time_subgraph_info_table.lookup(k, hash, 0);
1428
1429 #ifndef PRODUCT
1430 if (_test_class_name != nullptr && k->name()->equals(_test_class_name) && record != nullptr) {
1431 _test_class = k;
1432 _test_class_record = record;
1433 }
1434 #endif
1435
1436 // Initialize from archived data. Currently this is done only
1437 // during VM initialization time. No lock is needed.
1438 if (record == nullptr) {
1439 if (log_is_enabled(Info, aot, heap)) {
1440 ResourceMark rm(THREAD);
1441 log_info(aot, heap)("subgraph %s is not recorded",
1442 k->external_name());
1443 }
1444 return nullptr;
1445 } else {
1446 if (record->is_full_module_graph() && !CDSConfig::is_using_full_module_graph()) {
1447 if (log_is_enabled(Info, aot, heap)) {
1448 ResourceMark rm(THREAD);
1449 log_info(aot, heap)("subgraph %s cannot be used because full module graph is disabled",
1450 k->external_name());
1451 }
1452 return nullptr;
1453 }
1454
1455 if (record->has_non_early_klasses() && JvmtiExport::should_post_class_file_load_hook()) {
1456 if (log_is_enabled(Info, aot, heap)) {
1457 ResourceMark rm(THREAD);
1458 log_info(aot, heap)("subgraph %s cannot be used because JVMTI ClassFileLoadHook is enabled",
1459 k->external_name());
1460 }
1461 return nullptr;
1462 }
1463
1464 if (log_is_enabled(Info, aot, heap)) {
1465 ResourceMark rm;
1466 log_info(aot, heap)("%s subgraph %s ", do_init ? "init" : "resolve", k->external_name());
1467 }
1468
1469 resolve_or_init(k, do_init, CHECK_NULL);
1470
1471 // Load/link/initialize the klasses of the objects in the subgraph.
1472 // nullptr class loader is used.
1473 Array<Klass*>* klasses = record->subgraph_object_klasses();
1474 if (klasses != nullptr) {
1475 for (int i = 0; i < klasses->length(); i++) {
1476 Klass* klass = klasses->at(i);
1477 if (!klass->in_aot_cache()) {
1478 return nullptr;
1479 }
1480 resolve_or_init(klass, do_init, CHECK_NULL);
1481 }
1482 }
1483 }
1484
1485 return record;
1486 }
1487
1488 void HeapShared::resolve_or_init(const char* klass_name, bool do_init, TRAPS) {
1489 TempNewSymbol klass_name_sym = SymbolTable::new_symbol(klass_name);
1490 InstanceKlass* k = SystemDictionaryShared::find_builtin_class(klass_name_sym);
1491 if (k == nullptr) {
1492 return;
1493 }
1494 assert(k->defined_by_boot_loader(), "sanity");
1495 resolve_or_init(k, false, CHECK);
1496 if (do_init) {
1497 resolve_or_init(k, true, CHECK);
1498 }
1499 }
1500
1501 void HeapShared::resolve_or_init(Klass* k, bool do_init, TRAPS) {
1502 if (!do_init) {
1503 if (k->class_loader_data() == nullptr) {
1504 Klass* resolved_k = SystemDictionary::resolve_or_null(k->name(), CHECK);
1505 assert(resolved_k == k, "classes used by archived heap must not be replaced by JVMTI ClassFileLoadHook");
1506 }
1507 } else {
1508 assert(k->class_loader_data() != nullptr, "must have been resolved by HeapShared::resolve_classes");
1509 if (k->is_instance_klass()) {
1510 InstanceKlass* ik = InstanceKlass::cast(k);
1511 ik->initialize(CHECK);
1512 } else if (k->is_objArray_klass()) {
1513 ObjArrayKlass* oak = ObjArrayKlass::cast(k);
1514 oak->initialize(CHECK);
1515 }
1516 }
1517 }
1518
1519 void HeapShared::init_archived_fields_for(Klass* k, const ArchivedKlassSubGraphInfoRecord* record) {
1520 verify_the_heap(k, "before");
1521
1522 Array<int>* entry_field_records = record->entry_field_records();
1523 if (entry_field_records != nullptr) {
1524 int efr_len = entry_field_records->length();
1525 assert(efr_len % 2 == 0, "sanity");
1526 for (int i = 0; i < efr_len; i += 2) {
1527 int field_offset = entry_field_records->at(i);
1528 int root_index = entry_field_records->at(i+1);
1529 // Load the subgraph entry fields from the record and store them back to
1530 // the corresponding fields within the mirror.
1531 oop v = get_root(root_index, /*clear=*/true);
1532 oop m = k->java_mirror();
1533 if (k->has_aot_initialized_mirror()) {
1534 assert(v == m->obj_field(field_offset), "must be aot-initialized");
1535 } else {
1536 m->obj_field_put(field_offset, v);
1537 }
1538 log_debug(aot, heap)(" " PTR_FORMAT " init field @ %2d = " PTR_FORMAT, p2i(k), field_offset, p2i(v));
1539 }
1540
1541 // Done. Java code can see the archived sub-graphs referenced from k's
1542 // mirror after this point.
1543 if (log_is_enabled(Info, aot, heap)) {
1544 ResourceMark rm;
1545 log_info(aot, heap)("initialize_from_archived_subgraph %s " PTR_FORMAT "%s%s",
1546 k->external_name(), p2i(k), JvmtiExport::is_early_phase() ? " (early)" : "",
1547 k->has_aot_initialized_mirror() ? " (aot-inited)" : "");
1548 }
1549 }
1550
1551 verify_the_heap(k, "after ");
1552 }
1553
1554 void HeapShared::clear_archived_roots_of(Klass* k) {
1555 unsigned int hash = SystemDictionaryShared::hash_for_shared_dictionary_quick(k);
1556 const ArchivedKlassSubGraphInfoRecord* record = _run_time_subgraph_info_table.lookup(k, hash, 0);
1557 if (record != nullptr) {
1558 Array<int>* entry_field_records = record->entry_field_records();
1559 if (entry_field_records != nullptr) {
1560 int efr_len = entry_field_records->length();
1561 assert(efr_len % 2 == 0, "sanity");
1562 for (int i = 0; i < efr_len; i += 2) {
1563 int root_index = entry_field_records->at(i+1);
1564 clear_root(root_index);
1565 }
1566 }
1567 }
1568 }
1569
1570 // Push all oop fields (or oop array elemenets in case of an objArray) in
1571 // _referencing_obj onto the _stack.
1572 class HeapShared::OopFieldPusher: public BasicOopIterateClosure {
1573 PendingOopStack* _stack;
1574 GrowableArray<oop> _found_oop_fields;
1575 int _level;
1576 bool _record_klasses_only;
1577 KlassSubGraphInfo* _subgraph_info;
1578 oop _referencing_obj;
1579 bool _is_java_lang_ref;
1580 public:
1581 OopFieldPusher(PendingOopStack* stack,
1582 int level,
1583 bool record_klasses_only,
1584 KlassSubGraphInfo* subgraph_info,
1585 oop orig) :
1586 _stack(stack),
1587 _found_oop_fields(),
1588 _level(level),
1589 _record_klasses_only(record_klasses_only),
1590 _subgraph_info(subgraph_info),
1591 _referencing_obj(orig) {
1592 _is_java_lang_ref = AOTReferenceObjSupport::check_if_ref_obj(orig);
1593 }
1594 void do_oop(narrowOop *p) { OopFieldPusher::do_oop_work(p); }
1595 void do_oop( oop *p) { OopFieldPusher::do_oop_work(p); }
1596
1597 ~OopFieldPusher() {
1598 while (_found_oop_fields.length() > 0) {
1599 // This produces the exact same traversal order as the previous version
1600 // of OopFieldPusher that recurses on the C stack -- a depth-first search,
1601 // walking the oop fields in _referencing_obj by ascending field offsets.
1602 oop obj = _found_oop_fields.pop();
1603 _stack->push(PendingOop(obj, _referencing_obj, _level + 1));
1604 }
1605 }
1606
1607 protected:
1608 template <class T> void do_oop_work(T *p) {
1609 int field_offset = pointer_delta_as_int((char*)p, cast_from_oop<char*>(_referencing_obj));
1610 oop obj = HeapAccess<ON_UNKNOWN_OOP_REF>::oop_load_at(_referencing_obj, field_offset);
1611 if (obj != nullptr) {
1612 if (_is_java_lang_ref && AOTReferenceObjSupport::skip_field(field_offset)) {
1613 // Do not follow these fields. They will be cleared to null.
1614 return;
1615 }
1616
1617 if (!_record_klasses_only && log_is_enabled(Debug, aot, heap)) {
1618 ResourceMark rm;
1619 log_debug(aot, heap)("(%d) %s[%d] ==> " PTR_FORMAT " size %zu %s", _level,
1620 _referencing_obj->klass()->external_name(), field_offset,
1621 p2i(obj), obj->size() * HeapWordSize, obj->klass()->external_name());
1622 if (log_is_enabled(Trace, aot, heap)) {
1623 LogTarget(Trace, aot, heap) log;
1624 LogStream out(log);
1625 obj->print_on(&out);
1626 }
1627 }
1628
1629 _found_oop_fields.push(obj);
1630 }
1631 }
1632
1633 public:
1634 oop referencing_obj() { return _referencing_obj; }
1635 KlassSubGraphInfo* subgraph_info() { return _subgraph_info; }
1636 };
1637
1638 // Checks if an oop has any non-null oop fields
1639 class PointsToOopsChecker : public BasicOopIterateClosure {
1640 bool _result;
1641
1642 template <class T> void check(T *p) {
1643 _result |= (HeapAccess<>::oop_load(p) != nullptr);
1644 }
1645
1646 public:
1647 PointsToOopsChecker() : _result(false) {}
1648 void do_oop(narrowOop *p) { check(p); }
1649 void do_oop( oop *p) { check(p); }
1650 bool result() { return _result; }
1651 };
1652
1653 HeapShared::CachedOopInfo HeapShared::make_cached_oop_info(oop obj, oop referrer) {
1654 PointsToOopsChecker points_to_oops_checker;
1655 obj->oop_iterate(&points_to_oops_checker);
1656 return CachedOopInfo(OopHandle(Universe::vm_global(), referrer), points_to_oops_checker.result());
1657 }
1658
1659 void HeapShared::init_box_classes(TRAPS) {
1660 if (is_archived_heap_in_use()) {
1661 vmClasses::Boolean_klass()->initialize(CHECK);
1662 vmClasses::Character_klass()->initialize(CHECK);
1663 vmClasses::Float_klass()->initialize(CHECK);
1664 vmClasses::Double_klass()->initialize(CHECK);
1665 vmClasses::Byte_klass()->initialize(CHECK);
1666 vmClasses::Short_klass()->initialize(CHECK);
1667 vmClasses::Integer_klass()->initialize(CHECK);
1668 vmClasses::Long_klass()->initialize(CHECK);
1669 vmClasses::Void_klass()->initialize(CHECK);
1670 }
1671 }
1672
1673 // (1) If orig_obj has not been archived yet, archive it.
1674 // (2) If orig_obj has not been seen yet (since start_recording_subgraph() was called),
1675 // trace all objects that are reachable from it, and make sure these objects are archived.
1676 // (3) Record the klasses of all objects that are reachable from orig_obj (including those that
1677 // were already archived when this function is called)
1678 bool HeapShared::archive_reachable_objects_from(int level,
1679 KlassSubGraphInfo* subgraph_info,
1680 oop orig_obj) {
1681 assert(orig_obj != nullptr, "must be");
1682 PendingOopStack stack;
1683 stack.push(PendingOop(orig_obj, nullptr, level));
1684
1685 while (stack.length() > 0) {
1686 PendingOop po = stack.pop();
1687 _object_being_archived = po;
1688 bool status = walk_one_object(&stack, po.level(), subgraph_info, po.obj(), po.referrer());
1689 _object_being_archived = PendingOop();
1690
1691 if (!status) {
1692 // Don't archive a subgraph root that's too big. For archives static fields, that's OK
1693 // as the Java code will take care of initializing this field dynamically.
1694 assert(level == 1, "VM should have exited with unarchivable objects for _level > 1");
1695 return false;
1696 }
1697 }
1698
1699 return true;
1700 }
1701
1702 bool HeapShared::walk_one_object(PendingOopStack* stack, int level, KlassSubGraphInfo* subgraph_info,
1703 oop orig_obj, oop referrer) {
1704 assert(orig_obj != nullptr, "must be");
1705 if (!JavaClasses::is_supported_for_archiving(orig_obj)) {
1706 // This object has injected fields that cannot be supported easily, so we disallow them for now.
1707 // If you get an error here, you probably made a change in the JDK library that has added
1708 // these objects that are referenced (directly or indirectly) by static fields.
1709 ResourceMark rm;
1710 log_error(aot, heap)("Cannot archive object " PTR_FORMAT " of class %s", p2i(orig_obj), orig_obj->klass()->external_name());
1711 debug_trace();
1712 AOTMetaspace::unrecoverable_writing_error();
1713 }
1714
1715 if (log_is_enabled(Debug, aot, heap) && java_lang_Class::is_instance(orig_obj)) {
1716 ResourceMark rm;
1717 LogTarget(Debug, aot, heap) log;
1718 LogStream out(log);
1719 out.print("Found java mirror " PTR_FORMAT " ", p2i(orig_obj));
1720 Klass* k = java_lang_Class::as_Klass(orig_obj);
1721 if (k != nullptr) {
1722 out.print("%s", k->external_name());
1723 } else {
1724 out.print("primitive");
1725 }
1726 out.print_cr("; scratch mirror = " PTR_FORMAT,
1727 p2i(scratch_java_mirror(orig_obj)));
1728 }
1729
1730 if (java_lang_Class::is_instance(orig_obj)) {
1731 Klass* k = java_lang_Class::as_Klass(orig_obj);
1732 if (RegeneratedClasses::has_been_regenerated(k)) {
1733 orig_obj = RegeneratedClasses::get_regenerated_object(k)->java_mirror();
1734 }
1735 }
1736
1737 if (CDSConfig::is_initing_classes_at_dump_time()) {
1738 if (java_lang_Class::is_instance(orig_obj)) {
1739 orig_obj = scratch_java_mirror(orig_obj);
1740 assert(orig_obj != nullptr, "must be archived");
1741 }
1742 } else if (java_lang_Class::is_instance(orig_obj) && subgraph_info != _dump_time_special_subgraph) {
1743 // Without CDSConfig::is_initing_classes_at_dump_time(), we only allow archived objects to
1744 // point to the mirrors of (1) j.l.Object, (2) primitive classes, and (3) box classes. These are initialized
1745 // very early by HeapShared::init_box_classes().
1746 if (orig_obj == vmClasses::Object_klass()->java_mirror()
1747 || java_lang_Class::is_primitive(orig_obj)
1748 || orig_obj == vmClasses::Boolean_klass()->java_mirror()
1749 || orig_obj == vmClasses::Character_klass()->java_mirror()
1750 || orig_obj == vmClasses::Float_klass()->java_mirror()
1751 || orig_obj == vmClasses::Double_klass()->java_mirror()
1752 || orig_obj == vmClasses::Byte_klass()->java_mirror()
1753 || orig_obj == vmClasses::Short_klass()->java_mirror()
1754 || orig_obj == vmClasses::Integer_klass()->java_mirror()
1755 || orig_obj == vmClasses::Long_klass()->java_mirror()
1756 || orig_obj == vmClasses::Void_klass()->java_mirror()) {
1757 orig_obj = scratch_java_mirror(orig_obj);
1758 assert(orig_obj != nullptr, "must be archived");
1759 } else {
1760 // If you get an error here, you probably made a change in the JDK library that has added a Class
1761 // object that is referenced (directly or indirectly) by an ArchivableStaticFieldInfo
1762 // defined at the top of this file.
1763 log_error(aot, heap)("(%d) Unknown java.lang.Class object is in the archived sub-graph", level);
1764 debug_trace();
1765 AOTMetaspace::unrecoverable_writing_error();
1766 }
1767 }
1768
1769 if (has_been_seen_during_subgraph_recording(orig_obj)) {
1770 // orig_obj has already been archived and traced. Nothing more to do.
1771 return true;
1772 } else {
1773 set_has_been_seen_during_subgraph_recording(orig_obj);
1774 }
1775
1776 bool already_archived = has_been_archived(orig_obj);
1777 bool record_klasses_only = already_archived;
1778 if (!already_archived) {
1779 ++_num_new_archived_objs;
1780 if (!archive_object(orig_obj, referrer, subgraph_info)) {
1781 // Skip archiving the sub-graph referenced from the current entry field.
1782 ResourceMark rm;
1783 log_error(aot, heap)(
1784 "Cannot archive the sub-graph referenced from %s object ("
1785 PTR_FORMAT ") size %zu, skipped.",
1786 orig_obj->klass()->external_name(), p2i(orig_obj), orig_obj->size() * HeapWordSize);
1787 if (level == 1) {
1788 // Don't archive a subgraph root that's too big. For archives static fields, that's OK
1789 // as the Java code will take care of initializing this field dynamically.
1790 return false;
1791 } else {
1792 // We don't know how to handle an object that has been archived, but some of its reachable
1793 // objects cannot be archived. Bail out for now. We might need to fix this in the future if
1794 // we have a real use case.
1795 AOTMetaspace::unrecoverable_writing_error();
1796 }
1797 }
1798 }
1799
1800 Klass *orig_k = orig_obj->klass();
1801 subgraph_info->add_subgraph_object_klass(orig_k);
1802
1803 {
1804 // Find all the oops that are referenced by orig_obj, push them onto the stack
1805 // so we can work on them next.
1806 ResourceMark rm;
1807 OopFieldPusher pusher(stack, level, record_klasses_only, subgraph_info, orig_obj);
1808 orig_obj->oop_iterate(&pusher);
1809 }
1810
1811 if (CDSConfig::is_initing_classes_at_dump_time()) {
1812 // The classes of all archived enum instances have been marked as aot-init,
1813 // so there's nothing else to be done in the production run.
1814 } else {
1815 // This is legacy support for enum classes before JEP 483 -- we cannot rerun
1816 // the enum's <clinit> in the production run, so special handling is needed.
1817 if (CDSEnumKlass::is_enum_obj(orig_obj)) {
1818 CDSEnumKlass::handle_enum_obj(level + 1, subgraph_info, orig_obj);
1819 }
1820 }
1821
1822 return true;
1823 }
1824
1825 //
1826 // Start from the given static field in a java mirror and archive the
1827 // complete sub-graph of java heap objects that are reached directly
1828 // or indirectly from the starting object by following references.
1829 // Sub-graph archiving restrictions (current):
1830 //
1831 // - All classes of objects in the archived sub-graph (including the
1832 // entry class) must be boot class only.
1833 // - No java.lang.Class instance (java mirror) can be included inside
1834 // an archived sub-graph. Mirror can only be the sub-graph entry object.
1835 //
1836 // The Java heap object sub-graph archiving process (see OopFieldPusher):
1837 //
1838 // 1) Java object sub-graph archiving starts from a given static field
1839 // within a Class instance (java mirror). If the static field is a
1840 // reference field and points to a non-null java object, proceed to
1841 // the next step.
1842 //
1843 // 2) Archives the referenced java object. If an archived copy of the
1844 // current object already exists, updates the pointer in the archived
1845 // copy of the referencing object to point to the current archived object.
1846 // Otherwise, proceed to the next step.
1847 //
1848 // 3) Follows all references within the current java object and recursively
1849 // archive the sub-graph of objects starting from each reference.
1850 //
1851 // 4) Updates the pointer in the archived copy of referencing object to
1852 // point to the current archived object.
1853 //
1854 // 5) The Klass of the current java object is added to the list of Klasses
1855 // for loading and initializing before any object in the archived graph can
1856 // be accessed at runtime.
1857 //
1858 void HeapShared::archive_reachable_objects_from_static_field(InstanceKlass *k,
1859 const char* klass_name,
1860 int field_offset,
1861 const char* field_name) {
1862 assert(CDSConfig::is_dumping_heap(), "dump time only");
1863 assert(k->defined_by_boot_loader(), "must be boot class");
1864
1865 oop m = k->java_mirror();
1866
1867 KlassSubGraphInfo* subgraph_info = get_subgraph_info(k);
1868 oop f = m->obj_field(field_offset);
1869
1870 log_debug(aot, heap)("Start archiving from: %s::%s (" PTR_FORMAT ")", klass_name, field_name, p2i(f));
1871
1872 if (!CompressedOops::is_null(f)) {
1873 if (log_is_enabled(Trace, aot, heap)) {
1874 LogTarget(Trace, aot, heap) log;
1875 LogStream out(log);
1876 f->print_on(&out);
1877 }
1878
1879 bool success = archive_reachable_objects_from(1, subgraph_info, f);
1880 if (!success) {
1881 log_error(aot, heap)("Archiving failed %s::%s (some reachable objects cannot be archived)",
1882 klass_name, field_name);
1883 } else {
1884 // Note: the field value is not preserved in the archived mirror.
1885 // Record the field as a new subGraph entry point. The recorded
1886 // information is restored from the archive at runtime.
1887 subgraph_info->add_subgraph_entry_field(field_offset, f);
1888 log_info(aot, heap)("Archived field %s::%s => " PTR_FORMAT, klass_name, field_name, p2i(f));
1889 }
1890 } else {
1891 // The field contains null, we still need to record the entry point,
1892 // so it can be restored at runtime.
1893 subgraph_info->add_subgraph_entry_field(field_offset, nullptr);
1894 }
1895 }
1896
1897 #ifndef PRODUCT
1898 class VerifySharedOopClosure: public BasicOopIterateClosure {
1899 public:
1900 void do_oop(narrowOop *p) { VerifySharedOopClosure::do_oop_work(p); }
1901 void do_oop( oop *p) { VerifySharedOopClosure::do_oop_work(p); }
1902
1903 protected:
1904 template <class T> void do_oop_work(T *p) {
1905 oop obj = HeapAccess<>::oop_load(p);
1906 if (obj != nullptr) {
1907 HeapShared::verify_reachable_objects_from(obj);
1908 }
1909 }
1910 };
1911
1912 void HeapShared::verify_subgraph_from_static_field(InstanceKlass* k, int field_offset) {
1913 assert(CDSConfig::is_dumping_heap(), "dump time only");
1914 assert(k->defined_by_boot_loader(), "must be boot class");
1915
1916 oop m = k->java_mirror();
1917 oop f = m->obj_field(field_offset);
1918 if (!CompressedOops::is_null(f)) {
1919 verify_subgraph_from(f);
1920 }
1921 }
1922
1923 void HeapShared::verify_subgraph_from(oop orig_obj) {
1924 if (!has_been_archived(orig_obj)) {
1925 // It's OK for the root of a subgraph to be not archived. See comments in
1926 // archive_reachable_objects_from().
1927 return;
1928 }
1929
1930 // Verify that all objects reachable from orig_obj are archived.
1931 init_seen_objects_table();
1932 verify_reachable_objects_from(orig_obj);
1933 delete_seen_objects_table();
1934 }
1935
1936 void HeapShared::verify_reachable_objects_from(oop obj) {
1937 _num_total_verifications ++;
1938 if (java_lang_Class::is_instance(obj)) {
1939 obj = scratch_java_mirror(obj);
1940 assert(obj != nullptr, "must be");
1941 }
1942 if (!has_been_seen_during_subgraph_recording(obj)) {
1943 set_has_been_seen_during_subgraph_recording(obj);
1944 assert(has_been_archived(obj), "must be");
1945 VerifySharedOopClosure walker;
1946 obj->oop_iterate(&walker);
1947 }
1948 }
1949 #endif
1950
1951 void HeapShared::check_special_subgraph_classes() {
1952 if (CDSConfig::is_initing_classes_at_dump_time()) {
1953 // We can have aot-initialized classes (such as Enums) that can reference objects
1954 // of arbitrary types. Currently, we trust the JEP 483 implementation to only
1955 // aot-initialize classes that are "safe".
1956 //
1957 // TODO: we need an automatic tool that checks the safety of aot-initialized
1958 // classes (when we extend the set of aot-initialized classes beyond JEP 483)
1959 return;
1960 } else {
1961 // In this case, the special subgraph should contain a few specific types
1962 GrowableArray<Klass*>* klasses = _dump_time_special_subgraph->subgraph_object_klasses();
1963 int num = klasses->length();
1964 for (int i = 0; i < num; i++) {
1965 Klass* subgraph_k = klasses->at(i);
1966 Symbol* name = subgraph_k->name();
1967 if (subgraph_k->is_instance_klass() &&
1968 name != vmSymbols::java_lang_Class() &&
1969 name != vmSymbols::java_lang_String() &&
1970 name != vmSymbols::java_lang_ArithmeticException() &&
1971 name != vmSymbols::java_lang_ArrayIndexOutOfBoundsException() &&
1972 name != vmSymbols::java_lang_ArrayStoreException() &&
1973 name != vmSymbols::java_lang_ClassCastException() &&
1974 name != vmSymbols::java_lang_InternalError() &&
1975 name != vmSymbols::java_lang_NullPointerException() &&
1976 name != vmSymbols::jdk_internal_vm_PreemptedException()) {
1977 ResourceMark rm;
1978 fatal("special subgraph cannot have objects of type %s", subgraph_k->external_name());
1979 }
1980 }
1981 }
1982 }
1983
1984 HeapShared::SeenObjectsTable* HeapShared::_seen_objects_table = nullptr;
1985 HeapShared::PendingOop HeapShared::_object_being_archived;
1986 size_t HeapShared::_num_new_walked_objs;
1987 size_t HeapShared::_num_new_archived_objs;
1988 size_t HeapShared::_num_old_recorded_klasses;
1989
1990 size_t HeapShared::_num_total_subgraph_recordings = 0;
1991 size_t HeapShared::_num_total_walked_objs = 0;
1992 size_t HeapShared::_num_total_archived_objs = 0;
1993 size_t HeapShared::_num_total_recorded_klasses = 0;
1994 size_t HeapShared::_num_total_verifications = 0;
1995
1996 bool HeapShared::has_been_seen_during_subgraph_recording(oop obj) {
1997 return _seen_objects_table->get(obj) != nullptr;
1998 }
1999
2000 void HeapShared::set_has_been_seen_during_subgraph_recording(oop obj) {
2001 assert(!has_been_seen_during_subgraph_recording(obj), "sanity");
2002 _seen_objects_table->put_when_absent(obj, true);
2003 _seen_objects_table->maybe_grow();
2004 ++ _num_new_walked_objs;
2005 }
2006
2007 void HeapShared::start_recording_subgraph(InstanceKlass *k, const char* class_name, bool is_full_module_graph) {
2008 log_info(aot, heap)("Start recording subgraph(s) for archived fields in %s", class_name);
2009 init_subgraph_info(k, is_full_module_graph);
2010 init_seen_objects_table();
2011 _num_new_walked_objs = 0;
2012 _num_new_archived_objs = 0;
2013 _num_old_recorded_klasses = get_subgraph_info(k)->num_subgraph_object_klasses();
2014 }
2015
2016 void HeapShared::done_recording_subgraph(InstanceKlass *k, const char* class_name) {
2017 size_t num_new_recorded_klasses = get_subgraph_info(k)->num_subgraph_object_klasses() -
2018 _num_old_recorded_klasses;
2019 log_info(aot, heap)("Done recording subgraph(s) for archived fields in %s: "
2020 "walked %zu objs, archived %zu new objs, recorded %zu classes",
2021 class_name, _num_new_walked_objs, _num_new_archived_objs,
2022 num_new_recorded_klasses);
2023
2024 delete_seen_objects_table();
2025
2026 _num_total_subgraph_recordings ++;
2027 _num_total_walked_objs += _num_new_walked_objs;
2028 _num_total_archived_objs += _num_new_archived_objs;
2029 _num_total_recorded_klasses += num_new_recorded_klasses;
2030 }
2031
2032 class ArchivableStaticFieldFinder: public FieldClosure {
2033 InstanceKlass* _ik;
2034 Symbol* _field_name;
2035 bool _found;
2036 int _offset;
2037 public:
2038 ArchivableStaticFieldFinder(InstanceKlass* ik, Symbol* field_name) :
2039 _ik(ik), _field_name(field_name), _found(false), _offset(-1) {}
2040
2041 virtual void do_field(fieldDescriptor* fd) {
2042 if (fd->name() == _field_name) {
2043 assert(!_found, "fields can never be overloaded");
2044 if (is_reference_type(fd->field_type())) {
2045 _found = true;
2046 _offset = fd->offset();
2047 }
2048 }
2049 }
2050 bool found() { return _found; }
2051 int offset() { return _offset; }
2052 };
2053
2054 void HeapShared::init_subgraph_entry_fields(ArchivableStaticFieldInfo fields[],
2055 TRAPS) {
2056 for (int i = 0; fields[i].valid(); i++) {
2057 ArchivableStaticFieldInfo* info = &fields[i];
2058 TempNewSymbol klass_name = SymbolTable::new_symbol(info->klass_name);
2059 TempNewSymbol field_name = SymbolTable::new_symbol(info->field_name);
2060 ResourceMark rm; // for stringStream::as_string() etc.
2061
2062 #ifndef PRODUCT
2063 bool is_test_class = (ArchiveHeapTestClass != nullptr) && (strcmp(info->klass_name, ArchiveHeapTestClass) == 0);
2064 const char* test_class_name = ArchiveHeapTestClass;
2065 #else
2066 bool is_test_class = false;
2067 const char* test_class_name = ""; // avoid C++ printf checks warnings.
2068 #endif
2069
2070 if (is_test_class) {
2071 log_warning(aot)("Loading ArchiveHeapTestClass %s ...", test_class_name);
2072 }
2073
2074 Klass* k = SystemDictionary::resolve_or_fail(klass_name, true, THREAD);
2075 if (HAS_PENDING_EXCEPTION) {
2076 CLEAR_PENDING_EXCEPTION;
2077 stringStream st;
2078 st.print("Fail to initialize archive heap: %s cannot be loaded by the boot loader", info->klass_name);
2079 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), st.as_string());
2080 }
2081
2082 if (!k->is_instance_klass()) {
2083 stringStream st;
2084 st.print("Fail to initialize archive heap: %s is not an instance class", info->klass_name);
2085 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), st.as_string());
2086 }
2087
2088 InstanceKlass* ik = InstanceKlass::cast(k);
2089 assert(InstanceKlass::cast(ik)->defined_by_boot_loader(),
2090 "Only support boot classes");
2091
2092 if (is_test_class) {
2093 if (ik->module()->is_named()) {
2094 // We don't want ArchiveHeapTestClass to be abused to easily load/initialize arbitrary
2095 // core-lib classes. You need to at least append to the bootclasspath.
2096 stringStream st;
2097 st.print("ArchiveHeapTestClass %s is not in unnamed module", test_class_name);
2098 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), st.as_string());
2099 }
2100
2101 if (ik->package() != nullptr) {
2102 // This restriction makes HeapShared::is_a_test_class_in_unnamed_module() easy.
2103 stringStream st;
2104 st.print("ArchiveHeapTestClass %s is not in unnamed package", test_class_name);
2105 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), st.as_string());
2106 }
2107 } else {
2108 if (ik->module()->name() != vmSymbols::java_base()) {
2109 // We don't want to deal with cases when a module is unavailable at runtime.
2110 // FUTURE -- load from archived heap only when module graph has not changed
2111 // between dump and runtime.
2112 stringStream st;
2113 st.print("%s is not in java.base module", info->klass_name);
2114 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), st.as_string());
2115 }
2116 }
2117
2118 if (is_test_class) {
2119 log_warning(aot)("Initializing ArchiveHeapTestClass %s ...", test_class_name);
2120 }
2121 ik->initialize(CHECK);
2122
2123 ArchivableStaticFieldFinder finder(ik, field_name);
2124 ik->do_local_static_fields(&finder);
2125 if (!finder.found()) {
2126 stringStream st;
2127 st.print("Unable to find the static T_OBJECT field %s::%s", info->klass_name, info->field_name);
2128 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), st.as_string());
2129 }
2130
2131 info->klass = ik;
2132 info->offset = finder.offset();
2133 }
2134 }
2135
2136 void HeapShared::init_subgraph_entry_fields(TRAPS) {
2137 assert(CDSConfig::is_dumping_heap(), "must be");
2138 _dump_time_subgraph_info_table = new (mtClass)DumpTimeKlassSubGraphInfoTable();
2139 init_subgraph_entry_fields(archive_subgraph_entry_fields, CHECK);
2140 if (CDSConfig::is_dumping_full_module_graph()) {
2141 init_subgraph_entry_fields(fmg_archive_subgraph_entry_fields, CHECK);
2142 }
2143 }
2144
2145 #ifndef PRODUCT
2146 void HeapShared::setup_test_class(const char* test_class_name) {
2147 ArchivableStaticFieldInfo* p = archive_subgraph_entry_fields;
2148 int num_slots = sizeof(archive_subgraph_entry_fields) / sizeof(ArchivableStaticFieldInfo);
2149 assert(p[num_slots - 2].klass_name == nullptr, "must have empty slot that's patched below");
2150 assert(p[num_slots - 1].klass_name == nullptr, "must have empty slot that marks the end of the list");
2151
2152 if (test_class_name != nullptr) {
2153 p[num_slots - 2].klass_name = test_class_name;
2154 p[num_slots - 2].field_name = ARCHIVE_TEST_FIELD_NAME;
2155 }
2156 }
2157
2158 // See if ik is one of the test classes that are pulled in by -XX:ArchiveHeapTestClass
2159 // during runtime. This may be called before the module system is initialized so
2160 // we cannot rely on InstanceKlass::module(), etc.
2161 bool HeapShared::is_a_test_class_in_unnamed_module(Klass* ik) {
2162 if (_test_class != nullptr) {
2163 if (ik == _test_class) {
2164 return true;
2165 }
2166 Array<Klass*>* klasses = _test_class_record->subgraph_object_klasses();
2167 if (klasses == nullptr) {
2168 return false;
2169 }
2170
2171 for (int i = 0; i < klasses->length(); i++) {
2172 Klass* k = klasses->at(i);
2173 if (k == ik) {
2174 Symbol* name;
2175 if (k->is_instance_klass()) {
2176 name = InstanceKlass::cast(k)->name();
2177 } else if (k->is_objArray_klass()) {
2178 Klass* bk = ObjArrayKlass::cast(k)->bottom_klass();
2179 if (!bk->is_instance_klass()) {
2180 return false;
2181 }
2182 name = bk->name();
2183 } else {
2184 return false;
2185 }
2186
2187 // See KlassSubGraphInfo::check_allowed_klass() - we only allow test classes
2188 // to be:
2189 // (A) java.base classes (which must not be in the unnamed module)
2190 // (B) test classes which must be in the unnamed package of the unnamed module.
2191 // So if we see a '/' character in the class name, it must be in (A);
2192 // otherwise it must be in (B).
2193 if (name->index_of_at(0, "/", 1) >= 0) {
2194 return false; // (A)
2195 }
2196
2197 return true; // (B)
2198 }
2199 }
2200 }
2201
2202 return false;
2203 }
2204
2205 void HeapShared::initialize_test_class_from_archive(JavaThread* current) {
2206 Klass* k = _test_class;
2207 if (k != nullptr && is_archived_heap_in_use()) {
2208 JavaThread* THREAD = current;
2209 ExceptionMark em(THREAD);
2210 const ArchivedKlassSubGraphInfoRecord* record =
2211 resolve_or_init_classes_for_subgraph_of(k, /*do_init=*/false, THREAD);
2212
2213 // The _test_class is in the unnamed module, so it can't call CDS.initializeFromArchive()
2214 // from its <clinit> method. So we set up its "archivedObjects" field first, before
2215 // calling its <clinit>. This is not strictly clean, but it's a convenient way to write unit
2216 // test cases (see test/hotspot/jtreg/runtime/cds/appcds/cacheObject/ArchiveHeapTestClass.java).
2217 if (record != nullptr) {
2218 init_archived_fields_for(k, record);
2219 }
2220 resolve_or_init_classes_for_subgraph_of(k, /*do_init=*/true, THREAD);
2221 }
2222 }
2223 #endif
2224
2225 void HeapShared::init_for_dumping(TRAPS) {
2226 if (CDSConfig::is_dumping_heap()) {
2227 setup_test_class(ArchiveHeapTestClass);
2228 init_subgraph_entry_fields(CHECK);
2229 }
2230 }
2231
2232 void HeapShared::init_heap_writer() {
2233 if (HeapShared::is_writing_streaming_mode()) {
2234 AOTStreamedHeapWriter::init();
2235 } else {
2236 AOTMappedHeapWriter::init();
2237 }
2238 }
2239
2240 void HeapShared::archive_object_subgraphs(ArchivableStaticFieldInfo fields[],
2241 bool is_full_module_graph) {
2242 _num_total_subgraph_recordings = 0;
2243 _num_total_walked_objs = 0;
2244 _num_total_archived_objs = 0;
2245 _num_total_recorded_klasses = 0;
2246 _num_total_verifications = 0;
2247
2248 // For each class X that has one or more archived fields:
2249 // [1] Dump the subgraph of each archived field
2250 // [2] Create a list of all the class of the objects that can be reached
2251 // by any of these static fields.
2252 // At runtime, these classes are initialized before X's archived fields
2253 // are restored by HeapShared::initialize_from_archived_subgraph().
2254 for (int i = 0; fields[i].valid(); ) {
2255 ArchivableStaticFieldInfo* info = &fields[i];
2256 const char* klass_name = info->klass_name;
2257 start_recording_subgraph(info->klass, klass_name, is_full_module_graph);
2258
2259 // If you have specified consecutive fields of the same klass in
2260 // fields[], these will be archived in the same
2261 // {start_recording_subgraph ... done_recording_subgraph} pass to
2262 // save time.
2263 for (; fields[i].valid(); i++) {
2264 ArchivableStaticFieldInfo* f = &fields[i];
2265 if (f->klass_name != klass_name) {
2266 break;
2267 }
2268
2269 archive_reachable_objects_from_static_field(f->klass, f->klass_name,
2270 f->offset, f->field_name);
2271 }
2272 done_recording_subgraph(info->klass, klass_name);
2273 }
2274
2275 log_info(aot, heap)("Archived subgraph records = %zu",
2276 _num_total_subgraph_recordings);
2277 log_info(aot, heap)(" Walked %zu objects", _num_total_walked_objs);
2278 log_info(aot, heap)(" Archived %zu objects", _num_total_archived_objs);
2279 log_info(aot, heap)(" Recorded %zu klasses", _num_total_recorded_klasses);
2280
2281 #ifndef PRODUCT
2282 for (int i = 0; fields[i].valid(); i++) {
2283 ArchivableStaticFieldInfo* f = &fields[i];
2284 verify_subgraph_from_static_field(f->klass, f->offset);
2285 }
2286 log_info(aot, heap)(" Verified %zu references", _num_total_verifications);
2287 #endif
2288 }
2289
2290 bool HeapShared::is_dumped_interned_string(oop o) {
2291 if (is_writing_mapping_mode()) {
2292 return AOTMappedHeapWriter::is_dumped_interned_string(o);
2293 } else {
2294 return AOTStreamedHeapWriter::is_dumped_interned_string(o);
2295 }
2296 }
2297
2298 // These tables should be used only within the CDS safepoint, so
2299 // delete them before we exit the safepoint. Otherwise the table will
2300 // contain bad oops after a GC.
2301 void HeapShared::delete_tables_with_raw_oops() {
2302 assert(_seen_objects_table == nullptr, "should have been deleted");
2303
2304 if (is_writing_mapping_mode()) {
2305 AOTMappedHeapWriter::delete_tables_with_raw_oops();
2306 } else {
2307 assert(is_writing_streaming_mode(), "what other mode?");
2308 AOTStreamedHeapWriter::delete_tables_with_raw_oops();
2309 }
2310 }
2311
2312 void HeapShared::debug_trace() {
2313 ResourceMark rm;
2314 oop referrer = _object_being_archived.referrer();
2315 if (referrer != nullptr) {
2316 LogStream ls(Log(aot, heap)::error());
2317 ls.print_cr("Reference trace");
2318 CDSHeapVerifier::trace_to_root(&ls, referrer);
2319 }
2320 }
2321
2322 #ifndef PRODUCT
2323 // At dump-time, find the location of all the non-null oop pointers in an archived heap
2324 // region. This way we can quickly relocate all the pointers without using
2325 // BasicOopIterateClosure at runtime.
2326 class FindEmbeddedNonNullPointers: public BasicOopIterateClosure {
2327 void* _start;
2328 BitMap *_oopmap;
2329 size_t _num_total_oops;
2330 size_t _num_null_oops;
2331 public:
2332 FindEmbeddedNonNullPointers(void* start, BitMap* oopmap)
2333 : _start(start), _oopmap(oopmap), _num_total_oops(0), _num_null_oops(0) {}
2334
2335 virtual void do_oop(narrowOop* p) {
2336 assert(UseCompressedOops, "sanity");
2337 _num_total_oops ++;
2338 narrowOop v = *p;
2339 if (!CompressedOops::is_null(v)) {
2340 size_t idx = p - (narrowOop*)_start;
2341 _oopmap->set_bit(idx);
2342 } else {
2343 _num_null_oops ++;
2344 }
2345 }
2346 virtual void do_oop(oop* p) {
2347 assert(!UseCompressedOops, "sanity");
2348 _num_total_oops ++;
2349 if ((*p) != nullptr) {
2350 size_t idx = p - (oop*)_start;
2351 _oopmap->set_bit(idx);
2352 } else {
2353 _num_null_oops ++;
2354 }
2355 }
2356 size_t num_total_oops() const { return _num_total_oops; }
2357 size_t num_null_oops() const { return _num_null_oops; }
2358 };
2359 #endif
2360
2361 void HeapShared::count_allocation(size_t size) {
2362 _total_obj_count ++;
2363 _total_obj_size += size;
2364 for (int i = 0; i < ALLOC_STAT_SLOTS; i++) {
2365 if (size <= (size_t(1) << i)) {
2366 _alloc_count[i] ++;
2367 _alloc_size[i] += size;
2368 return;
2369 }
2370 }
2371 }
2372
2373 static double avg_size(size_t size, size_t count) {
2374 double avg = 0;
2375 if (count > 0) {
2376 avg = double(size * HeapWordSize) / double(count);
2377 }
2378 return avg;
2379 }
2380
2381 void HeapShared::print_stats() {
2382 size_t huge_count = _total_obj_count;
2383 size_t huge_size = _total_obj_size;
2384
2385 for (int i = 0; i < ALLOC_STAT_SLOTS; i++) {
2386 size_t byte_size_limit = (size_t(1) << i) * HeapWordSize;
2387 size_t count = _alloc_count[i];
2388 size_t size = _alloc_size[i];
2389 log_info(aot, heap)("%8zu objects are <= %-6zu"
2390 " bytes (total %8zu bytes, avg %8.1f bytes)",
2391 count, byte_size_limit, size * HeapWordSize, avg_size(size, count));
2392 huge_count -= count;
2393 huge_size -= size;
2394 }
2395
2396 log_info(aot, heap)("%8zu huge objects (total %8zu bytes"
2397 ", avg %8.1f bytes)",
2398 huge_count, huge_size * HeapWordSize,
2399 avg_size(huge_size, huge_count));
2400 log_info(aot, heap)("%8zu total objects (total %8zu bytes"
2401 ", avg %8.1f bytes)",
2402 _total_obj_count, _total_obj_size * HeapWordSize,
2403 avg_size(_total_obj_size, _total_obj_count));
2404 }
2405
2406 bool HeapShared::is_metadata_field(oop src_obj, int offset) {
2407 bool result = false;
2408 do_metadata_offsets(src_obj, [&](int metadata_offset) {
2409 if (metadata_offset == offset) {
2410 result = true;
2411 }
2412 });
2413 return result;
2414 }
2415
2416 void HeapShared::remap_dumped_metadata(oop src_obj, address archived_object) {
2417 do_metadata_offsets(src_obj, [&](int offset) {
2418 Metadata** buffered_field_addr = (Metadata**)(archived_object + offset);
2419 Metadata* native_ptr = *buffered_field_addr;
2420
2421 if (native_ptr == nullptr) {
2422 return;
2423 }
2424
2425 if (RegeneratedClasses::has_been_regenerated(native_ptr)) {
2426 native_ptr = RegeneratedClasses::get_regenerated_object(native_ptr);
2427 }
2428
2429 address buffered_native_ptr = ArchiveBuilder::current()->get_buffered_addr((address)native_ptr);
2430 address requested_native_ptr = ArchiveBuilder::current()->to_requested(buffered_native_ptr);
2431 *buffered_field_addr = (Metadata*)requested_native_ptr;
2432 });
2433 }
2434
2435 bool HeapShared::is_archived_boot_layer_available(JavaThread* current) {
2436 TempNewSymbol klass_name = SymbolTable::new_symbol(ARCHIVED_BOOT_LAYER_CLASS);
2437 InstanceKlass* k = SystemDictionary::find_instance_klass(current, klass_name, Handle());
2438 if (k == nullptr) {
2439 return false;
2440 } else {
2441 TempNewSymbol field_name = SymbolTable::new_symbol(ARCHIVED_BOOT_LAYER_FIELD);
2442 TempNewSymbol field_signature = SymbolTable::new_symbol("Ljdk/internal/module/ArchivedBootLayer;");
2443 fieldDescriptor fd;
2444 if (k->find_field(field_name, field_signature, true, &fd) != nullptr) {
2445 oop m = k->java_mirror();
2446 oop f = m->obj_field(fd.offset());
2447 if (CompressedOops::is_null(f)) {
2448 return false;
2449 }
2450 } else {
2451 return false;
2452 }
2453 }
2454 return true;
2455 }
2456
2457 #endif // INCLUDE_CDS_JAVA_HEAP