1 /*
2 * Copyright (c) 2025, 2026, 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/aotMapLogger.hpp"
26 #include "cds/aotMappedHeapLoader.hpp"
27 #include "cds/aotMappedHeapWriter.hpp"
28 #include "cds/aotStreamedHeapLoader.hpp"
29 #include "cds/aotStreamedHeapWriter.hpp"
30 #include "cds/cdsConfig.hpp"
31 #include "cds/filemap.hpp"
32 #include "classfile/moduleEntry.hpp"
33 #include "classfile/packageEntry.hpp"
34 #include "classfile/systemDictionaryShared.hpp"
35 #include "classfile/vmClasses.hpp"
36 #include "logging/log.hpp"
37 #include "logging/logStream.hpp"
38 #include "memory/metaspaceClosure.hpp"
39 #include "memory/resourceArea.hpp"
40 #include "oops/method.hpp"
41 #include "oops/methodCounters.hpp"
42 #include "oops/methodData.hpp"
43 #include "oops/oop.inline.hpp"
44 #include "oops/trainingData.hpp"
45 #include "runtime/fieldDescriptor.inline.hpp"
46 #include "runtime/globals_extension.hpp"
47 #include "utilities/growableArray.hpp"
48
49 bool AOTMapLogger::_is_logging_at_bootstrap;
50 bool AOTMapLogger::_is_runtime_logging;
51 intx AOTMapLogger::_buffer_to_requested_delta;
52 intx AOTMapLogger::_requested_to_mapped_metadata_delta;
53 GrowableArrayCHeap<AOTMapLogger::FakeOop, mtClass>* AOTMapLogger::_roots;
54
55 class AOTMapLogger::RequestedMetadataAddr {
56 address _raw_addr;
57
58 public:
59 RequestedMetadataAddr(address raw_addr) : _raw_addr(raw_addr) {}
60
61 address raw_addr() const { return _raw_addr; }
62
63 Klass* to_real_klass() const {
64 if (_raw_addr == nullptr) {
65 return nullptr;
66 }
67
68 if (_is_runtime_logging) {
69 return (Klass*)(_raw_addr + _requested_to_mapped_metadata_delta);
70 } else {
71 ArchiveBuilder* builder = ArchiveBuilder::current();
72 address buffered_addr = builder->requested_to_buffered(_raw_addr);
73 address klass = builder->get_source_addr(buffered_addr);
74 return (Klass*)klass;
75 }
76 }
77 }; // AOTMapLogger::RequestedMetadataAddr
78
79 void AOTMapLogger::ergo_initialize() {
80 if (!CDSConfig::is_dumping_archive() && CDSConfig::is_using_archive() && log_is_enabled(Info, aot, map)) {
81 _is_logging_at_bootstrap = true;
82 if (FLAG_IS_DEFAULT(ArchiveRelocationMode)) {
83 FLAG_SET_ERGO(ArchiveRelocationMode, 0);
84 } else if (ArchiveRelocationMode != 0) {
85 log_warning(aot, map)("Addresses in the AOT map may be incorrect for -XX:ArchiveRelocationMode=%d.", ArchiveRelocationMode);
86 }
87 }
88 }
89
90 void AOTMapLogger::dumptime_log(ArchiveBuilder* builder, FileMapInfo* mapinfo,
91 AOTMappedHeapInfo* mapped_heap_info, AOTStreamedHeapInfo* streamed_heap_info,
92 char* bitmap, size_t bitmap_size_in_bytes) {
93 _is_runtime_logging = false;
94 _buffer_to_requested_delta = ArchiveBuilder::current()->buffer_to_requested_delta();
95
96 log_file_header(mapinfo);
97
98 DumpRegion* rw_region = &builder->_rw_region;
99 DumpRegion* ro_region = &builder->_ro_region;
100
101 dumptime_log_metaspace_region("rw region", rw_region, &builder->_rw_src_objs, &builder->_ro_src_objs);
102 dumptime_log_metaspace_region("ro region", ro_region, &builder->_rw_src_objs, &builder->_ro_src_objs);
103
104 address bitmap_end = address(bitmap + bitmap_size_in_bytes);
105 log_region_range("bitmap", address(bitmap), bitmap_end, nullptr);
106 log_as_hex((address)bitmap, bitmap_end, nullptr);
107
108 #if INCLUDE_CDS_JAVA_HEAP
109 if (mapped_heap_info != nullptr && mapped_heap_info->is_used()) {
110 dumptime_log_mapped_heap_region(mapped_heap_info);
111 }
112 if (streamed_heap_info != nullptr && streamed_heap_info->is_used()) {
113 dumptime_log_streamed_heap_region(streamed_heap_info);
114 }
115 #endif
116
117 log_info(aot, map)("[End of AOT cache map]");
118 }
119
120 // This class is used to find the location and type of all the
121 // archived metaspace objects.
122 class AOTMapLogger::RuntimeGatherArchivedMetaspaceObjs : public UniqueMetaspaceClosure {
123 GrowableArrayCHeap<ArchivedObjInfo, mtClass> _objs;
124
125 public:
126 GrowableArrayCHeap<ArchivedObjInfo, mtClass>* objs() { return &_objs; }
127
128 virtual bool do_unique_ref(Ref* ref, bool read_only) {
129 ArchivedObjInfo info;
130 if (AOTMetaspace::in_aot_cache(ref->obj())) {
131 info._src_addr = ref->obj();
132 info._buffered_addr = ref->obj();
133 info._requested_addr = ref->obj();
134 info._bytes = ref->size() * BytesPerWord;
135 info._type = ref->type();
136 _objs.append(info);
137 }
138
139 return true; // keep iterating
140 }
141
142 void finish() {
143 UniqueMetaspaceClosure::finish();
144 _objs.sort(compare_by_address);
145 }
146 }; // AOTMapLogger::RuntimeGatherArchivedMetaspaceObjs
147
148 void AOTMapLogger::runtime_log(FileMapInfo* static_mapinfo, FileMapInfo* dynamic_mapinfo) {
149 _is_runtime_logging = true;
150 _requested_to_mapped_metadata_delta = static_mapinfo->relocation_delta();
151
152 ResourceMark rm;
153 RuntimeGatherArchivedMetaspaceObjs gatherer;
154
155 if (log_is_enabled(Debug, aot, map)) {
156 // The metaspace objects in the AOT cache are stored as a stream of bytes. For space
157 // saving, we don't store a complete index that tells us where one object ends and
158 // another object starts. There's also no type information.
159 //
160 // However, we can rebuild our index by iterating over all the objects using
161 // MetaspaceClosure, starting from the dictionary of Klasses in SystemDictionaryShared.
162 GrowableArray<Klass*> klasses;
163 SystemDictionaryShared::get_all_archived_classes(/*is_static*/true, &klasses);
164 if (dynamic_mapinfo != nullptr) {
165 SystemDictionaryShared::get_all_archived_classes(/*is_static*/false, &klasses);
166 }
167
168 for (int i = 0; i < klasses.length(); i++) {
169 gatherer.push(klasses.adr_at(i));
170 }
171 gatherer.finish();
172 }
173
174 runtime_log(static_mapinfo, gatherer.objs());
175 if (dynamic_mapinfo != nullptr) {
176 runtime_log(dynamic_mapinfo, gatherer.objs());
177 }
178 }
179
180 void AOTMapLogger::runtime_log(FileMapInfo* mapinfo, GrowableArrayCHeap<ArchivedObjInfo, mtClass>* objs) {
181 log_file_header(mapinfo);
182
183 runtime_log_metaspace_regions(mapinfo, objs);
184
185 #if INCLUDE_CDS_JAVA_HEAP
186 if (mapinfo->has_heap_region() && CDSConfig::is_loading_heap()) {
187 runtime_log_heap_region(mapinfo);
188 }
189 #endif
190
191 log_info(aot, map)("[End of map]");
192 }
193
194 void AOTMapLogger::dumptime_log_metaspace_region(const char* name, DumpRegion* region,
195 const ArchiveBuilder::SourceObjList* rw_objs,
196 const ArchiveBuilder::SourceObjList* ro_objs) {
197 address region_base = address(region->base());
198 address region_top = address(region->top());
199 log_region_range(name, region_base, region_top, region_base + _buffer_to_requested_delta);
200 if (log_is_enabled(Debug, aot, map)) {
201 GrowableArrayCHeap<ArchivedObjInfo, mtClass> objs;
202 // With -XX:+UseCompactObjectHeaders, it's possible for small objects (including some from
203 // ro_objs) to be allocated in the gaps in the RW region.
204 collect_metaspace_objs(&objs, region_base, region_top, rw_objs);
205 collect_metaspace_objs(&objs, region_base, region_top, ro_objs);
206 objs.sort(compare_by_address);
207 log_metaspace_objects_impl(address(region->base()), address(region->end()), &objs, 0, objs.length());
208 }
209 }
210
211 void AOTMapLogger::collect_metaspace_objs(GrowableArrayCHeap<ArchivedObjInfo, mtClass>* objs,
212 address region_base, address region_top ,
213 const ArchiveBuilder::SourceObjList* src_objs) {
214 for (int i = 0; i < src_objs->objs()->length(); i++) {
215 ArchiveBuilder::SourceObjInfo* src_info = src_objs->at(i);
216 address buf_addr = src_info->buffered_addr();
217 if (region_base <= buf_addr && buf_addr < region_top) {
218 ArchivedObjInfo info;
219 info._src_addr = src_info->source_addr();
220 info._buffered_addr = buf_addr;
221 info._requested_addr = info._buffered_addr + _buffer_to_requested_delta;
222 info._bytes = src_info->size_in_bytes();
223 info._type = src_info->type();
224 objs->append(info);
225 }
226 }
227 }
228
229 int AOTMapLogger::compare_by_address(ArchivedObjInfo* a, ArchivedObjInfo* b) {
230 if (a->_buffered_addr < b->_buffered_addr) {
231 return -1;
232 } else if (a->_buffered_addr > b->_buffered_addr) {
233 return 1;
234 } else {
235 return 0;
236 }
237 }
238
239 void AOTMapLogger::runtime_log_metaspace_regions(FileMapInfo* mapinfo, GrowableArrayCHeap<ArchivedObjInfo, mtClass>* objs) {
240 FileMapRegion* rw = mapinfo->region_at(AOTMetaspace::rw);
241 FileMapRegion* ro = mapinfo->region_at(AOTMetaspace::ro);
242
243 address rw_base = address(rw->mapped_base());
244 address rw_end = address(rw->mapped_end());
245 address ro_base = address(ro->mapped_base());
246 address ro_end = address(ro->mapped_end());
247
248 int first_rw_index = -1;
249 int first_ro_index = -1;
250 int last_ro_index = -1;
251
252 if (log_is_enabled(Debug, aot, map)) {
253 int i = 0;
254 for (; i < objs->length(); i++) {
255 address p = objs->at(i)._src_addr;
256 if (p < rw_base) {
257 // We are printing the dynamic archive but found an object in the static archive
258 precond(!mapinfo->is_static());
259 continue;
260 }
261 if (first_rw_index < 0) {
262 first_rw_index = i;
263 continue;
264 }
265 if (p < ro_base) {
266 continue;
267 }
268 if (first_ro_index < 0) {
269 first_ro_index = i;
270 continue;
271 }
272 if (p < ro_end) {
273 continue;
274 } else {
275 last_ro_index = i;
276 break;
277 }
278 }
279 }
280
281 if (last_ro_index < 0) {
282 last_ro_index = objs->length();
283 }
284
285 log_region_range("rw", rw_base, rw_end, rw_base - _requested_to_mapped_metadata_delta);
286 if (log_is_enabled(Debug, aot, map)) {
287 log_metaspace_objects_impl(rw_base, rw_end, objs, first_rw_index, first_ro_index);
288 }
289
290 log_region_range("ro", ro_base, ro_end, ro_base - _requested_to_mapped_metadata_delta);
291 if (log_is_enabled(Debug, aot, map)) {
292 log_metaspace_objects_impl(ro_base, ro_end, objs, first_ro_index, last_ro_index);
293 }
294 }
295
296 void AOTMapLogger::log_file_header(FileMapInfo* mapinfo) {
297 const char* type;
298 if (mapinfo->is_static()) {
299 if (CDSConfig::new_aot_flags_used()) {
300 type = "AOT cache";
301 } else {
302 type = "Static CDS archive";
303 }
304 } else {
305 type = "Dynamic CDS archive";
306 }
307
308 log_info(aot, map)("%s map for %s", type, mapinfo->full_path());
309
310 address header = address(mapinfo->header());
311 address header_end = header + mapinfo->header()->header_size();
312
313 log_region_range("header", header, header_end, nullptr);
314 LogStreamHandle(Info, aot, map) lsh;
315 mapinfo->print(&lsh);
316 log_as_hex(header, header_end, nullptr);
317 }
318
319 // Log information about a region, whose address at dump time is [base .. top). At
320 // runtime, this region will be mapped to requested_base. requested_base is nullptr if this
321 // region will be mapped at os-selected addresses (such as the bitmap region), or will
322 // be accessed with os::read (the header).
323 void AOTMapLogger::log_region_range(const char* name, address base, address top, address requested_base) {
324 size_t size = top - base;
325 base = requested_base;
326 if (requested_base == nullptr) {
327 top = (address)size;
328 } else {
329 top = requested_base + size;
330 }
331 log_info(aot, map)("[%-18s " PTR_FORMAT " - " PTR_FORMAT " %9zu bytes]",
332 name, p2i(base), p2i(top), size);
333 }
334
335 #define _LOG_PREFIX PTR_FORMAT ": @@ %-17s %d"
336
337 void AOTMapLogger::log_metaspace_objects_impl(address region_base, address region_end, GrowableArrayCHeap<ArchivedObjInfo, mtClass>* objs,
338 int start_idx, int end_idx) {
339 address last_obj_base = region_base;
340 address last_obj_end = region_base;
341 Thread* current = Thread::current();
342
343 for (int i = start_idx; i < end_idx; i++) {
344 ArchivedObjInfo& info = objs->at(i);
345 address src = info._src_addr;
346 address buffered_addr = info._buffered_addr;
347 address requested_addr = info._requested_addr;
348 int bytes = info._bytes;
349 MetaspaceClosureType type = info._type;
350 const char* type_name = MetaspaceClosure::type_name(type);
351
352 log_as_hex(last_obj_base, buffered_addr, last_obj_base + _buffer_to_requested_delta);
353
354 switch (type) {
355 case MetaspaceClosureType::ClassType:
356 log_klass((Klass*)src, requested_addr, type_name, bytes, current);
357 break;
358 case MetaspaceClosureType::ConstantPoolType:
359 log_constant_pool((ConstantPool*)src, requested_addr, type_name, bytes, current);
360 break;
361 case MetaspaceClosureType::ConstantPoolCacheType:
362 log_constant_pool_cache((ConstantPoolCache*)src, requested_addr, type_name, bytes, current);
363 break;
364 case MetaspaceClosureType::ConstMethodType:
365 log_const_method((ConstMethod*)src, requested_addr, type_name, bytes, current);
366 break;
367 case MetaspaceClosureType::MethodType:
368 log_method((Method*)src, requested_addr, type_name, bytes, current);
369 break;
370 case MetaspaceClosureType::MethodCountersType:
371 log_method_counters((MethodCounters*)src, requested_addr, type_name, bytes, current);
372 break;
373 case MetaspaceClosureType::MethodDataType:
374 log_method_data((MethodData*)src, requested_addr, type_name, bytes, current);
375 break;
376 case MetaspaceClosureType::ModuleEntryType:
377 log_module_entry((ModuleEntry*)src, requested_addr, type_name, bytes, current);
378 break;
379 case MetaspaceClosureType::PackageEntryType:
380 log_package_entry((PackageEntry*)src, requested_addr, type_name, bytes, current);
381 break;
382 case MetaspaceClosureType::GrowableArrayType:
383 log_growable_array((GrowableArrayBase*)src, requested_addr, type_name, bytes, current);
384 break;
385 case MetaspaceClosureType::SymbolType:
386 log_symbol((Symbol*)src, requested_addr, type_name, bytes, current);
387 break;
388 case MetaspaceClosureType::KlassTrainingDataType:
389 log_klass_training_data((KlassTrainingData*)src, requested_addr, type_name, bytes, current);
390 break;
391 case MetaspaceClosureType::MethodTrainingDataType:
392 log_method_training_data((MethodTrainingData*)src, requested_addr, type_name, bytes, current);
393 break;
394 case MetaspaceClosureType::CompileTrainingDataType:
395 log_compile_training_data((CompileTrainingData*)src, requested_addr, type_name, bytes, current);
396 break;
397 default:
398 log_debug(aot, map)(_LOG_PREFIX, p2i(requested_addr), type_name, bytes);
399 break;
400 }
401
402 last_obj_base = buffered_addr;
403 last_obj_end = buffered_addr + bytes;
404 }
405
406 log_as_hex(last_obj_base, last_obj_end, last_obj_base + _buffer_to_requested_delta);
407 if (last_obj_end < region_end) {
408 log_debug(aot, map)(PTR_FORMAT ": @@ Misc data %zu bytes",
409 p2i(last_obj_end + _buffer_to_requested_delta),
410 size_t(region_end - last_obj_end));
411 log_as_hex(last_obj_end, region_end, last_obj_end + _buffer_to_requested_delta);
412 }
413 }
414
415 void AOTMapLogger::log_constant_pool(ConstantPool* cp, address requested_addr,
416 const char* type_name, int bytes, Thread* current) {
417 ResourceMark rm(current);
418 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(requested_addr), type_name, bytes,
419 cp->pool_holder()->external_name());
420 }
421
422 void AOTMapLogger::log_constant_pool_cache(ConstantPoolCache* cpc, address requested_addr,
423 const char* type_name, int bytes, Thread* current) {
424 ResourceMark rm(current);
425 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(requested_addr), type_name, bytes,
426 cpc->constant_pool()->pool_holder()->external_name());
427 }
428
429 void AOTMapLogger::log_const_method(ConstMethod* cm, address requested_addr, const char* type_name,
430 int bytes, Thread* current) {
431 ResourceMark rm(current);
432 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(requested_addr), type_name, bytes, cm->method()->external_name());
433 }
434
435 void AOTMapLogger::log_method_counters(MethodCounters* mc, address requested_addr, const char* type_name,
436 int bytes, Thread* current) {
437 ResourceMark rm(current);
438 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(requested_addr), type_name, bytes, mc->method()->external_name());
439 }
440
441 void AOTMapLogger::log_method_data(MethodData* md, address requested_addr, const char* type_name,
442 int bytes, Thread* current) {
443 ResourceMark rm(current);
444 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(requested_addr), type_name, bytes, md->method()->external_name());
445 }
446
447 void AOTMapLogger::log_module_entry(ModuleEntry* mod, address requested_addr, const char* type_name,
448 int bytes, Thread* current) {
449 ResourceMark rm(current);
450 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(requested_addr), type_name, bytes,
451 mod->name_as_C_string());
452 }
453
454 void AOTMapLogger::log_package_entry(PackageEntry* pkg, address requested_addr, const char* type_name,
455 int bytes, Thread* current) {
456 ResourceMark rm(current);
457 log_debug(aot, map)(_LOG_PREFIX " %s - %s", p2i(requested_addr), type_name, bytes,
458 pkg->module()->name_as_C_string(), pkg->name_as_C_string());
459 }
460
461 void AOTMapLogger::log_growable_array(GrowableArrayBase* arr, address requested_addr, const char* type_name,
462 int bytes, Thread* current) {
463 ResourceMark rm(current);
464 log_debug(aot, map)(_LOG_PREFIX " %d (%d)", p2i(requested_addr), type_name, bytes,
465 arr->length(), arr->capacity());
466 }
467
468 void AOTMapLogger::log_klass(Klass* k, address requested_addr, const char* type_name,
469 int bytes, Thread* current) {
470 ResourceMark rm(current);
471 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(requested_addr), type_name, bytes, k->external_name());
472 }
473
474 void AOTMapLogger::log_method(Method* m, address requested_addr, const char* type_name,
475 int bytes, Thread* current) {
476 ResourceMark rm(current);
477 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(requested_addr), type_name, bytes, m->external_name());
478 }
479
480 void AOTMapLogger::log_symbol(Symbol* s, address requested_addr, const char* type_name,
481 int bytes, Thread* current) {
482 ResourceMark rm(current);
483 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(requested_addr), type_name, bytes,
484 s->as_quoted_ascii());
485 }
486
487 void AOTMapLogger::log_klass_training_data(KlassTrainingData* ktd, address requested_addr, const char* type_name,
488 int bytes, Thread* current) {
489 ResourceMark rm(current);
490 if (ktd->has_holder()) {
491 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(requested_addr), type_name, bytes,
492 ktd->name()->as_klass_external_name());
493 } else {
494 log_debug(aot, map)(_LOG_PREFIX, p2i(requested_addr), type_name, bytes);
495 }
496 }
497
498 void AOTMapLogger::log_method_training_data(MethodTrainingData* mtd, address requested_addr, const char* type_name,
499 int bytes, Thread* current) {
500 ResourceMark rm(current);
501 if (mtd->has_holder()) {
502 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(requested_addr), type_name, bytes,
503 mtd->holder()->external_name());
504 } else {
505 log_debug(aot, map)(_LOG_PREFIX, p2i(requested_addr), type_name, bytes);
506 }
507 }
508
509 void AOTMapLogger::log_compile_training_data(CompileTrainingData* ctd, address requested_addr, const char* type_name,
510 int bytes, Thread* current) {
511 ResourceMark rm(current);
512 if (ctd->method() != nullptr && ctd->method()->has_holder()) {
513 log_debug(aot, map)(_LOG_PREFIX " %d %s", p2i(requested_addr), type_name, bytes,
514 ctd->level(), ctd->method()->holder()->external_name());
515 } else {
516 log_debug(aot, map)(_LOG_PREFIX, p2i(requested_addr), type_name, bytes);
517 }
518 }
519 #undef _LOG_PREFIX
520
521 // Log all the data [base...top). Pretend that the base address
522 // will be mapped to requested_base at run-time.
523 void AOTMapLogger::log_as_hex(address base, address top, address requested_base, bool is_heap) {
524 assert(top >= base, "must be");
525
526 LogStreamHandle(Trace, aot, map) lsh;
527 if (lsh.is_enabled()) {
528 int unitsize = sizeof(address);
529 if (is_heap && UseCompressedOops) {
530 // This makes the compressed oop pointers easier to read, but
531 // longs and doubles will be split into two words.
532 unitsize = sizeof(narrowOop);
533 }
534 os::print_hex_dump(&lsh, base, top, unitsize, /* print_ascii=*/true, /* bytes_per_line=*/32, requested_base);
535 }
536 }
537
538 #if INCLUDE_CDS_JAVA_HEAP
539 // FakeOop (and subclasses FakeMirror, FakeString, FakeRefArray, FakeFlatArray, FakeTypeArray) are used to traverse
540 // and print the (image of) heap objects stored in the AOT cache. These objects are different than regular oops:
541 // - They do not reside inside the range of the heap.
542 // - For +UseCompressedOops: pointers may use a different narrowOop encoding: see FakeOop::read_oop_at(narrowOop*)
543 // - For -UseCompressedOops: pointers are not direct: see FakeOop::read_oop_at(oop*)
544 //
545 // Hence, in general, we cannot use regular oop API (such as oopDesc::obj_field()) on these objects. There
546 // are a few rare case where regular oop API work, but these are all guarded with the raw_oop() method and
547 // should be used with care.
548 //
549 // Each AOT heap reader and writer has its own oop_iterator() API that retrieves all the data required to build
550 // fake oops for logging.
551 class AOTMapLogger::FakeOop {
552 OopDataIterator* _iter;
553 OopData _data;
554
555 address* buffered_field_addr(int field_offset) {
556 return (address*)(buffered_addr() + field_offset);
557 }
558
559 public:
560 RequestedMetadataAddr metadata_field(int field_offset) {
561 return RequestedMetadataAddr(*(address*)(buffered_field_addr(field_offset)));
562 }
563
564 address buffered_addr() {
565 return _data._buffered_addr;
566 }
567
568 // Return an "oop" pointer so we can use APIs that accept regular oops. This
569 // must be used with care, as only a limited number of APIs can work with oops that
570 // live outside of the range of the heap.
571 oop raw_oop() { return _data._raw_oop; }
572
573 FakeOop() : _data() {}
574 FakeOop(OopDataIterator* iter, OopData data) : _iter(iter), _data(data) {}
575
576 FakeMirror as_mirror();
577 FakeRefArray as_ref_array();
578 FakeFlatArray as_flat_array();
579 FakeString as_string();
580 FakeTypeArray as_type_array();
581
582 RequestedMetadataAddr klass() {
583 address rk = (address)real_klass();
584 if (_is_runtime_logging) {
585 return RequestedMetadataAddr(rk - _requested_to_mapped_metadata_delta);
586 } else {
587 ArchiveBuilder* builder = ArchiveBuilder::current();
588 return builder->to_requested(builder->get_buffered_addr(rk));
589 }
590 }
591
592 Klass* real_klass() {
593 return _data._klass;
594 }
595
596 // in heap words
597 size_t size() {
598 return _data._size;
599 }
600
601 bool is_root_segment() {
602 return _data._is_root_segment;
603 }
604
605 bool is_array() { return real_klass()->is_array_klass(); }
606 bool is_null() { return buffered_addr() == nullptr; }
607
608 int array_length() {
609 precond(is_array());
610 return arrayOop(raw_oop())->length();
611 }
612
613 intptr_t target_location() {
614 return _data._target_location;
615 }
616
617 address requested_addr() {
618 return _data._requested_addr;
619 }
620
621 uint32_t as_narrow_oop_value() {
622 precond(UseCompressedOops);
623 return _data._narrow_location;
624 }
625
626 FakeOop read_oop_at(narrowOop* addr) { // +UseCompressedOops
627 return FakeOop(_iter, _iter->obj_at(addr));
628 }
629
630 FakeOop read_oop_at(oop* addr) { // -UseCompressedOops
631 return FakeOop(_iter, _iter->obj_at(addr));
632 }
633
634 FakeOop obj_field(int field_offset) {
635 if (UseCompressedOops) {
636 return read_oop_at(raw_oop()->field_addr<narrowOop>(field_offset));
637 } else {
638 return read_oop_at(raw_oop()->field_addr<oop>(field_offset));
639 }
640 }
641
642 void print_non_oop_field(outputStream* st, fieldDescriptor* fd) {
643 // fd->print_on_for() works for non-oop fields in fake oops
644 precond(fd->field_type() != T_ARRAY && fd->field_type() != T_OBJECT);
645 fd->print_on_for(st, raw_oop());
646 }
647 }; // AOTMapLogger::FakeOop
648
649 class AOTMapLogger::FakeMirror : public AOTMapLogger::FakeOop {
650 public:
651 FakeMirror(OopDataIterator* iter, OopData data) : FakeOop(iter, data) {}
652
653 void print_class_signature_on(outputStream* st);
654
655 Klass* real_mirrored_klass() {
656 RequestedMetadataAddr mirrored_klass = metadata_field(java_lang_Class::klass_offset());
657 return mirrored_klass.to_real_klass();
658 }
659
660 int static_oop_field_count() {
661 return java_lang_Class::static_oop_field_count(raw_oop());
662 }
663 }; // AOTMapLogger::FakeMirror
664
665 class AOTMapLogger::FakeRefArray : public AOTMapLogger::FakeOop {
666 refArrayOop raw_refArrayOop() {
667 return (refArrayOop)raw_oop();
668 }
669
670 public:
671 FakeRefArray(OopDataIterator* iter, OopData data) : FakeOop(iter, data) {}
672
673 int length() {
674 return raw_refArrayOop()->length();
675 }
676 FakeOop obj_at(int i) {
677 if (UseCompressedOops) {
678 return read_oop_at(raw_refArrayOop()->obj_at_addr<narrowOop>(i));
679 } else {
680 return read_oop_at(raw_refArrayOop()->obj_at_addr<oop>(i));
681 }
682 }
683 }; // AOTMapLogger::FakeRefArray
684
685 class AOTMapLogger::FakeFlatArray : public AOTMapLogger::FakeOop {
686 flatArrayOop raw_flatArrayOop() {
687 return (flatArrayOop)raw_oop();
688 }
689
690 public:
691 FakeFlatArray(OopDataIterator* iter, OopData data) : FakeOop(iter, data) {}
692
693 int length() {
694 return raw_flatArrayOop()->length();
695 }
696 void print_elements_on(outputStream* st) {
697 FlatArrayKlass::cast(real_klass())->oop_print_elements_on(raw_flatArrayOop(), st);
698 }
699
700 }; // AOTMapLogger::FakeRefArray
701
702 class AOTMapLogger::FakeString : public AOTMapLogger::FakeOop {
703 public:
704 FakeString(OopDataIterator* iter, OopData data) : FakeOop(iter, data) {}
705
706 bool is_latin1() {
707 jbyte coder = raw_oop()->byte_field(java_lang_String::coder_offset());
708 assert(CompactStrings || coder == java_lang_String::CODER_UTF16, "Must be UTF16 without CompactStrings");
709 return coder == java_lang_String::CODER_LATIN1;
710 }
711
712 FakeTypeArray value();
713
714 int length();
715 void print_on(outputStream* st, int max_length = MaxStringPrintSize);
716 }; // AOTMapLogger::FakeString
717
718 class AOTMapLogger::FakeTypeArray : public AOTMapLogger::FakeOop {
719 typeArrayOop raw_typeArrayOop() {
720 return (typeArrayOop)raw_oop();
721 }
722
723 public:
724 FakeTypeArray(OopDataIterator* iter, OopData data) : FakeOop(iter, data) {}
725
726 void print_elements_on(outputStream* st) {
727 TypeArrayKlass::cast(real_klass())->oop_print_elements_on(raw_typeArrayOop(), st);
728 }
729
730 int length() { return raw_typeArrayOop()->length(); }
731 jbyte byte_at(int i) { return raw_typeArrayOop()->byte_at(i); }
732 jchar char_at(int i) { return raw_typeArrayOop()->char_at(i); }
733 }; // AOTMapLogger::FakeTypeArray
734
735 AOTMapLogger::FakeMirror AOTMapLogger::FakeOop::as_mirror() {
736 precond(real_klass() == vmClasses::Class_klass());
737 return FakeMirror(_iter, _data);
738 }
739
740 AOTMapLogger::FakeRefArray AOTMapLogger::FakeOop::as_ref_array() {
741 precond(real_klass()->is_refArray_klass());
742 return FakeRefArray(_iter, _data);
743 }
744
745 AOTMapLogger::FakeFlatArray AOTMapLogger::FakeOop::as_flat_array() {
746 precond(real_klass()->is_flatArray_klass());
747 return FakeFlatArray(_iter, _data);
748 }
749
750 AOTMapLogger::FakeTypeArray AOTMapLogger::FakeOop::as_type_array() {
751 precond(real_klass()->is_typeArray_klass());
752 return FakeTypeArray(_iter, _data);
753 }
754
755 AOTMapLogger::FakeString AOTMapLogger::FakeOop::as_string() {
756 precond(real_klass() == vmClasses::String_klass());
757 return FakeString(_iter, _data);
758 }
759
760 void AOTMapLogger::FakeMirror::print_class_signature_on(outputStream* st) {
761 ResourceMark rm;
762 RequestedMetadataAddr requested_klass = metadata_field(java_lang_Class::klass_offset());
763 Klass* real_klass = requested_klass.to_real_klass();
764
765 if (real_klass == nullptr) {
766 // This is a primitive mirror (Java expressions of int.class, long.class, void.class, etc);
767 RequestedMetadataAddr requested_array_klass = metadata_field(java_lang_Class::array_klass_offset());
768 Klass* real_array_klass = requested_array_klass.to_real_klass();
769 if (real_array_klass == nullptr) {
770 st->print(" V"); // The special mirror for void.class that doesn't have any representation in C++
771 } else {
772 precond(real_array_klass->is_typeArray_klass());
773 st->print(" %c", real_array_klass->name()->char_at(1));
774 }
775 } else {
776 const char* class_name = real_klass->name()->as_C_string();
777 if (real_klass->is_instance_klass()) {
778 st->print(" L%s;", class_name);
779 } else {
780 st->print(" %s", class_name);
781 }
782 if (real_klass->has_aot_initialized_mirror()) {
783 st->print(" (aot-inited)");
784 }
785 }
786 }
787
788 AOTMapLogger::FakeTypeArray AOTMapLogger::FakeString::value() {
789 return obj_field(java_lang_String::value_offset()).as_type_array();
790 }
791
792 int AOTMapLogger::FakeString::length() {
793 FakeTypeArray v = value();
794 if (v.is_null()) {
795 return 0;
796 }
797 int arr_length = v.length();
798 if (!is_latin1()) {
799 assert((arr_length & 1) == 0, "should be even for UTF16 string");
800 arr_length >>= 1; // convert number of bytes to number of elements
801 }
802 return arr_length;
803 }
804
805 void AOTMapLogger::FakeString::print_on(outputStream* st, int max_length) {
806 FakeTypeArray v = value();
807 int length = this->length();
808 bool is_latin1 = this->is_latin1();
809 bool abridge = length > max_length;
810
811 st->print("\"");
812 for (int index = 0; index < length; index++) {
813 // If we need to abridge and we've printed half the allowed characters
814 // then jump to the tail of the string.
815 if (abridge && index >= max_length / 2) {
816 st->print(" ... (%d characters ommitted) ... ", length - 2 * (max_length / 2));
817 index = length - (max_length / 2);
818 abridge = false; // only do this once
819 }
820 jchar c = (!is_latin1) ? v.char_at(index) :
821 ((jchar) v.byte_at(index)) & 0xff;
822 if (c < ' ') {
823 st->print("\\x%02X", c); // print control characters e.g. \x0A
824 } else {
825 st->print("%c", c);
826 }
827 }
828 st->print("\"");
829
830 if (length > max_length) {
831 st->print(" (abridged) ");
832 }
833 }
834
835 class AOTMapLogger::ArchivedFieldPrinter : public FieldClosure {
836 FakeOop _fake_oop;
837 outputStream* _st;
838 public:
839 ArchivedFieldPrinter(FakeOop fake_oop, outputStream* st) : _fake_oop(fake_oop), _st(st) {}
840
841 void do_field(fieldDescriptor* fd) {
842 _st->print(" - ");
843 BasicType ft = fd->field_type();
844 switch (ft) {
845 case T_ARRAY:
846 case T_OBJECT:
847 {
848 fd->print_on(_st); // print just the name and offset
849 FakeOop field_value = _fake_oop.obj_field(fd->offset());
850 print_oop_info_cr(_st, field_value);
851 }
852 break;
853 default:
854 _fake_oop.print_non_oop_field(_st, fd); // name, offset, value
855 _st->cr();
856 }
857 }
858 }; // AOTMapLogger::ArchivedFieldPrinter
859
860 void AOTMapLogger::dumptime_log_mapped_heap_region(AOTMappedHeapInfo* heap_info) {
861 MemRegion r = heap_info->buffer_region();
862 address buffer_start = address(r.start()); // start of the current oop inside the buffer
863 address buffer_end = address(r.end());
864
865 address requested_base = UseCompressedOops ? AOTMappedHeapWriter::narrow_oop_base() : (address)AOTMappedHeapWriter::NOCOOPS_REQUESTED_BASE;
866 address requested_start = UseCompressedOops ? AOTMappedHeapWriter::buffered_addr_to_requested_addr(buffer_start) : requested_base;
867
868 log_region_range("heap", buffer_start, buffer_end, requested_start);
869 log_archived_objects(AOTMappedHeapWriter::oop_iterator(heap_info));
870 }
871
872 void AOTMapLogger::dumptime_log_streamed_heap_region(AOTStreamedHeapInfo* heap_info) {
873 MemRegion r = heap_info->buffer_region();
874 address buffer_start = address(r.start()); // start of the current oop inside the buffer
875 address buffer_end = address(r.end());
876
877 log_region_range("heap", buffer_start, buffer_end, nullptr);
878 log_archived_objects(AOTStreamedHeapWriter::oop_iterator(heap_info));
879 }
880
881 void AOTMapLogger::runtime_log_heap_region(FileMapInfo* mapinfo) {
882 ResourceMark rm;
883
884 int heap_region_index = AOTMetaspace::hp;
885 FileMapRegion* r = mapinfo->region_at(heap_region_index);
886 size_t alignment = (size_t)ObjectAlignmentInBytes;
887
888 if (mapinfo->object_streaming_mode()) {
889 address buffer_start = (address)r->mapped_base();
890 address buffer_end = buffer_start + r->used();
891 log_region_range("heap", buffer_start, buffer_end, nullptr);
892 log_archived_objects(AOTStreamedHeapLoader::oop_iterator(mapinfo, buffer_start, buffer_end));
893 } else {
894 // Allocate a buffer and read the image of the archived heap region. This buffer is outside
895 // of the real Java heap, so we must use FakeOop to access the contents of the archived heap objects.
896 char* buffer = resource_allocate_bytes(r->used() + alignment);
897 address buffer_start = (address)align_up(buffer, alignment);
898 address buffer_end = buffer_start + r->used();
899 if (!mapinfo->read_region(heap_region_index, (char*)buffer_start, r->used(), /* do_commit = */ false)) {
900 log_error(aot)("Cannot read heap region; AOT map logging of heap objects failed");
901 return;
902 }
903
904 address requested_base = UseCompressedOops ? (address)mapinfo->narrow_oop_base() : AOTMappedHeapLoader::heap_region_requested_address(mapinfo);
905 address requested_start = requested_base + r->mapping_offset();
906 log_region_range("heap", buffer_start, buffer_end, requested_start);
907 log_archived_objects(AOTMappedHeapLoader::oop_iterator(mapinfo, buffer_start, buffer_end));
908 }
909 }
910
911 void AOTMapLogger::log_archived_objects(OopDataIterator* iter) {
912 LogStreamHandle(Debug, aot, map) st;
913 if (!st.is_enabled()) {
914 return;
915 }
916
917 _roots = new GrowableArrayCHeap<FakeOop, mtClass>();
918
919 // Roots that are not segmented
920 GrowableArrayCHeap<OopData, mtClass>* normal_roots = iter->roots();
921 for (int i = 0; i < normal_roots->length(); ++i) {
922 OopData data = normal_roots->at(i);
923 FakeOop fop(iter, data);
924 _roots->append(fop);
925 st.print(" root[%4d]: ", i);
926 print_oop_info_cr(&st, fop);
927 }
928
929 while (iter->has_next()) {
930 FakeOop fake_oop(iter, iter->next());
931 st.print(PTR_FORMAT ": @@ Object ", fake_oop.target_location());
932 print_oop_info_cr(&st, fake_oop, /*print_location=*/false);
933
934 LogStreamHandle(Trace, aot, map, oops) trace_st;
935 if (trace_st.is_enabled()) {
936 print_oop_details(fake_oop, &trace_st);
937 }
938
939 address fop = fake_oop.buffered_addr();
940 address end_fop = fop + fake_oop.size() * BytesPerWord;
941 log_as_hex(fop, end_fop, fake_oop.requested_addr(), /*is_heap=*/true);
942 }
943
944 delete _roots;
945 delete iter;
946 delete normal_roots;
947 }
948
949 void AOTMapLogger::print_oop_info_cr(outputStream* st, FakeOop fake_oop, bool print_location) {
950 if (fake_oop.is_null()) {
951 st->print_cr("null");
952 } else {
953 ResourceMark rm;
954 Klass* real_klass = fake_oop.real_klass();
955 intptr_t target_location = fake_oop.target_location();
956 if (print_location) {
957 st->print(PTR_FORMAT " ", target_location);
958 }
959 if (UseCompressedOops) {
960 st->print("(0x%08x) ", fake_oop.as_narrow_oop_value());
961 }
962 if (fake_oop.is_array()) {
963 int array_len = fake_oop.array_length();
964 st->print_cr("%s length: %d", real_klass->external_name(), array_len);
965 } else {
966 st->print("%s", real_klass->external_name());
967
968 if (real_klass == vmClasses::String_klass()) {
969 st->print(" ");
970 FakeString fake_str = fake_oop.as_string();
971 fake_str.print_on(st);
972 } else if (real_klass == vmClasses::Class_klass()) {
973 fake_oop.as_mirror().print_class_signature_on(st);
974 }
975
976 st->cr();
977 }
978 }
979 }
980
981 // Print the fields of instanceOops, or the elements of arrayOops
982 void AOTMapLogger::print_oop_details(FakeOop fake_oop, outputStream* st) {
983 Klass* real_klass = fake_oop.real_klass();
984
985 st->print(" - klass: ");
986 real_klass->print_value_on(st);
987 st->print(" " PTR_FORMAT, p2i(fake_oop.klass().raw_addr()));
988 st->cr();
989
990 if (real_klass->is_typeArray_klass()) {
991 fake_oop.as_type_array().print_elements_on(st);
992 } else if (real_klass->is_flatArray_klass()) {
993 // Archiving FlatArrayOop with embedded oops is not supported.
994 // TODO: add restriction.
995 fake_oop.as_flat_array().print_elements_on(st);
996 } else if (real_klass->is_refArray_klass()) {
997 FakeRefArray fake_obj_array = fake_oop.as_ref_array();
998 bool is_logging_root_segment = fake_oop.is_root_segment();
999
1000 for (int i = 0; i < fake_obj_array.length(); i++) {
1001 FakeOop elm = fake_obj_array.obj_at(i);
1002 if (is_logging_root_segment) {
1003 st->print(" root[%4d]: ", _roots->length());
1004 _roots->append(elm);
1005 } else {
1006 st->print(" -%4d: ", i);
1007 }
1008 print_oop_info_cr(st, elm);
1009 }
1010 } else {
1011 st->print_cr(" - fields (%zu words):", fake_oop.size());
1012
1013 ArchivedFieldPrinter print_field(fake_oop, st);
1014 InstanceKlass::cast(real_klass)->print_nonstatic_fields(&print_field);
1015
1016 if (real_klass == vmClasses::Class_klass()) {
1017 FakeMirror fake_mirror = fake_oop.as_mirror();
1018
1019 st->print(" - signature: ");
1020 fake_mirror.print_class_signature_on(st);
1021 st->cr();
1022
1023 Klass* real_mirrored_klass = fake_mirror.real_mirrored_klass();
1024 if (real_mirrored_klass != nullptr && real_mirrored_klass->is_instance_klass()) {
1025 InstanceKlass* real_mirrored_ik = InstanceKlass::cast(real_mirrored_klass);
1026
1027 ConstantPoolCache* cp_cache = real_mirrored_ik->constants()->cache();
1028 if (!_is_runtime_logging) {
1029 cp_cache = ArchiveBuilder::current()->get_buffered_addr(cp_cache);
1030 }
1031 int rr_root_index = cp_cache->archived_references_index();
1032 st->print(" - resolved_references: ");
1033 if (rr_root_index >= 0) {
1034 FakeOop resolved_references = _roots->at(rr_root_index);
1035 print_oop_info_cr(st, resolved_references);
1036 } else {
1037 st->print("null");
1038 }
1039
1040 st->print_cr("- ---- static fields (%d):", fake_mirror.static_oop_field_count());
1041 real_mirrored_ik->do_local_static_fields(&print_field);
1042 }
1043 }
1044 }
1045 }
1046 #endif // INCLUDE_CDS_JAVA_HEAP