1 /*
2 * Copyright (c) 2020, 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/aotClassLinker.hpp"
27 #include "cds/aotLinkedClassBulkLoader.hpp"
28 #include "cds/aotLogging.hpp"
29 #include "cds/archiveBuilder.hpp"
30 #include "cds/archiveHeapWriter.hpp"
31 #include "cds/archiveUtils.hpp"
32 #include "cds/cdsConfig.hpp"
33 #include "cds/cppVtables.hpp"
34 #include "cds/dumpAllocStats.hpp"
35 #include "cds/dynamicArchive.hpp"
36 #include "cds/finalImageRecipes.hpp"
37 #include "cds/heapShared.hpp"
38 #include "cds/metaspaceShared.hpp"
39 #include "cds/regeneratedClasses.hpp"
40 #include "classfile/classLoader.hpp"
41 #include "classfile/classLoaderDataShared.hpp"
42 #include "classfile/classLoaderExt.hpp"
43 #include "classfile/javaClasses.hpp"
44 #include "classfile/symbolTable.hpp"
45 #include "classfile/systemDictionaryShared.hpp"
46 #include "classfile/vmClasses.hpp"
47 #include "code/aotCodeCache.hpp"
48 #include "interpreter/abstractInterpreter.hpp"
49 #include "jvm.h"
50 #include "logging/log.hpp"
51 #include "logging/logStream.hpp"
52 #include "memory/allStatic.hpp"
53 #include "memory/memoryReserver.hpp"
54 #include "memory/memRegion.hpp"
55 #include "memory/resourceArea.hpp"
56 #include "oops/compressedKlass.inline.hpp"
57 #include "oops/instanceKlass.hpp"
58 #include "oops/methodCounters.hpp"
59 #include "oops/methodData.hpp"
60 #include "oops/objArrayKlass.hpp"
61 #include "oops/objArrayOop.inline.hpp"
62 #include "oops/oopHandle.inline.hpp"
63 #include "oops/trainingData.hpp"
64 #include "runtime/arguments.hpp"
65 #include "runtime/fieldDescriptor.inline.hpp"
66 #include "runtime/globals_extension.hpp"
67 #include "runtime/javaThread.hpp"
68 #include "runtime/safepointVerifiers.hpp"
69 #include "runtime/sharedRuntime.hpp"
70 #include "utilities/align.hpp"
71 #include "utilities/bitMap.inline.hpp"
72 #include "utilities/formatBuffer.hpp"
73
74 ArchiveBuilder* ArchiveBuilder::_current = nullptr;
75
76 ArchiveBuilder::OtherROAllocMark::~OtherROAllocMark() {
77 char* newtop = ArchiveBuilder::current()->_ro_region.top();
78 ArchiveBuilder::alloc_stats()->record_other_type(int(newtop - _oldtop), true);
79 }
80
81 ArchiveBuilder::SourceObjList::SourceObjList() : _ptrmap(16 * K, mtClassShared) {
82 _total_bytes = 0;
83 _objs = new (mtClassShared) GrowableArray<SourceObjInfo*>(128 * K, mtClassShared);
84 }
85
86 ArchiveBuilder::SourceObjList::~SourceObjList() {
87 delete _objs;
88 }
89
90 void ArchiveBuilder::SourceObjList::append(SourceObjInfo* src_info) {
91 // Save this source object for copying
92 src_info->set_id(_objs->length());
93 _objs->append(src_info);
94
95 // Prepare for marking the pointers in this source object
96 assert(is_aligned(_total_bytes, sizeof(address)), "must be");
97 src_info->set_ptrmap_start(_total_bytes / sizeof(address));
98 _total_bytes = align_up(_total_bytes + (uintx)src_info->size_in_bytes(), sizeof(address));
99 src_info->set_ptrmap_end(_total_bytes / sizeof(address));
100
101 BitMap::idx_t bitmap_size_needed = BitMap::idx_t(src_info->ptrmap_end());
102 if (_ptrmap.size() <= bitmap_size_needed) {
103 _ptrmap.resize((bitmap_size_needed + 1) * 2);
104 }
105 }
106
107 void ArchiveBuilder::SourceObjList::remember_embedded_pointer(SourceObjInfo* src_info, MetaspaceClosure::Ref* ref) {
108 // src_obj contains a pointer. Remember the location of this pointer in _ptrmap,
109 // so that we can copy/relocate it later.
110 src_info->set_has_embedded_pointer();
111 address src_obj = src_info->source_addr();
112 address* field_addr = ref->addr();
113 assert(src_info->ptrmap_start() < _total_bytes, "sanity");
114 assert(src_info->ptrmap_end() <= _total_bytes, "sanity");
115 assert(*field_addr != nullptr, "should have checked");
116
117 intx field_offset_in_bytes = ((address)field_addr) - src_obj;
118 DEBUG_ONLY(int src_obj_size = src_info->size_in_bytes();)
119 assert(field_offset_in_bytes >= 0, "must be");
120 assert(field_offset_in_bytes + intx(sizeof(intptr_t)) <= intx(src_obj_size), "must be");
121 assert(is_aligned(field_offset_in_bytes, sizeof(address)), "must be");
122
123 BitMap::idx_t idx = BitMap::idx_t(src_info->ptrmap_start() + (uintx)(field_offset_in_bytes / sizeof(address)));
124 _ptrmap.set_bit(BitMap::idx_t(idx));
125 }
126
127 class RelocateEmbeddedPointers : public BitMapClosure {
128 ArchiveBuilder* _builder;
129 address _buffered_obj;
130 BitMap::idx_t _start_idx;
131 public:
132 RelocateEmbeddedPointers(ArchiveBuilder* builder, address buffered_obj, BitMap::idx_t start_idx) :
133 _builder(builder), _buffered_obj(buffered_obj), _start_idx(start_idx) {}
134
135 bool do_bit(BitMap::idx_t bit_offset) {
136 size_t field_offset = size_t(bit_offset - _start_idx) * sizeof(address);
137 address* ptr_loc = (address*)(_buffered_obj + field_offset);
138
139 address old_p_with_tags = *ptr_loc;
140 assert(old_p_with_tags != nullptr, "null ptrs shouldn't have been marked");
141
142 address old_p = MetaspaceClosure::strip_tags(old_p_with_tags);
143 uintx tags = MetaspaceClosure::decode_tags(old_p_with_tags);
144 address new_p = _builder->get_buffered_addr(old_p);
145
146 bool nulled;
147 if (new_p == nullptr) {
148 // old_p had a FollowMode of set_to_null
149 nulled = true;
150 } else {
151 new_p = MetaspaceClosure::add_tags(new_p, tags);
152 nulled = false;
153 }
154
155 log_trace(aot)("Ref: [" PTR_FORMAT "] -> " PTR_FORMAT " => " PTR_FORMAT " %zu",
156 p2i(ptr_loc), p2i(old_p) + tags, p2i(new_p), tags);
157
158 ArchivePtrMarker::set_and_mark_pointer(ptr_loc, new_p);
159 ArchiveBuilder::current()->count_relocated_pointer(tags != 0, nulled);
160 return true; // keep iterating the bitmap
161 }
162 };
163
164 void ArchiveBuilder::SourceObjList::relocate(int i, ArchiveBuilder* builder) {
165 SourceObjInfo* src_info = objs()->at(i);
166 assert(src_info->should_copy(), "must be");
167 BitMap::idx_t start = BitMap::idx_t(src_info->ptrmap_start()); // inclusive
168 BitMap::idx_t end = BitMap::idx_t(src_info->ptrmap_end()); // exclusive
169
170 RelocateEmbeddedPointers relocator(builder, src_info->buffered_addr(), start);
171 _ptrmap.iterate(&relocator, start, end);
172 }
173
174 ArchiveBuilder::ArchiveBuilder() :
175 _current_dump_region(nullptr),
176 _buffer_bottom(nullptr),
177 _requested_static_archive_bottom(nullptr),
178 _requested_static_archive_top(nullptr),
179 _requested_dynamic_archive_bottom(nullptr),
180 _requested_dynamic_archive_top(nullptr),
181 _mapped_static_archive_bottom(nullptr),
182 _mapped_static_archive_top(nullptr),
183 _buffer_to_requested_delta(0),
184 _pz_region("pz", MAX_SHARED_DELTA), // protection zone -- used only during dumping; does NOT exist in cds archive.
185 _rw_region("rw", MAX_SHARED_DELTA),
186 _ro_region("ro", MAX_SHARED_DELTA),
187 _ac_region("ac", MAX_SHARED_DELTA),
188 _ptrmap(mtClassShared),
189 _rw_ptrmap(mtClassShared),
190 _ro_ptrmap(mtClassShared),
191 _ac_ptrmap(mtClassShared),
192 _rw_src_objs(),
193 _ro_src_objs(),
194 _src_obj_table(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE),
195 _buffered_to_src_table(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE),
196 _total_heap_region_size(0)
197 {
198 _klasses = new (mtClassShared) GrowableArray<Klass*>(4 * K, mtClassShared);
199 _symbols = new (mtClassShared) GrowableArray<Symbol*>(256 * K, mtClassShared);
200 _entropy_seed = 0x12345678;
201 _relocated_ptr_info._num_ptrs = 0;
202 _relocated_ptr_info._num_tagged_ptrs = 0;
203 _relocated_ptr_info._num_nulled_ptrs = 0;
204 assert(_current == nullptr, "must be");
205 _current = this;
206 }
207
208 ArchiveBuilder::~ArchiveBuilder() {
209 assert(_current == this, "must be");
210 _current = nullptr;
211
212 for (int i = 0; i < _symbols->length(); i++) {
213 _symbols->at(i)->decrement_refcount();
214 }
215
216 delete _klasses;
217 delete _symbols;
218 if (_shared_rs.is_reserved()) {
219 MemoryReserver::release(_shared_rs);
220 }
221
222 AOTArtifactFinder::dispose();
223 }
224
225 // Returns a deterministic sequence of pseudo random numbers. The main purpose is NOT
226 // for randomness but to get good entropy for the identity_hash() of archived Symbols,
227 // while keeping the contents of static CDS archives deterministic to ensure
228 // reproducibility of JDK builds.
229 int ArchiveBuilder::entropy() {
230 assert(SafepointSynchronize::is_at_safepoint(), "needed to ensure deterministic sequence");
231 _entropy_seed = os::next_random(_entropy_seed);
232 return static_cast<int>(_entropy_seed);
233 }
234
235 class GatherKlassesAndSymbols : public UniqueMetaspaceClosure {
236 ArchiveBuilder* _builder;
237
238 public:
239 GatherKlassesAndSymbols(ArchiveBuilder* builder) : _builder(builder) {}
240
241 virtual bool do_unique_ref(Ref* ref, bool read_only) {
242 return _builder->gather_klass_and_symbol(ref, read_only);
243 }
244 };
245
246 bool ArchiveBuilder::gather_klass_and_symbol(MetaspaceClosure::Ref* ref, bool read_only) {
247 if (ref->obj() == nullptr) {
248 return false;
249 }
250 if (get_follow_mode(ref) != make_a_copy) {
251 return false;
252 }
253 if (ref->msotype() == MetaspaceObj::ClassType) {
254 Klass* klass = (Klass*)ref->obj();
255 assert(klass->is_klass(), "must be");
256 if (!is_excluded(klass)) {
257 _klasses->append(klass);
258 if (klass->is_hidden()) {
259 assert(klass->is_instance_klass(), "must be");
260 }
261 }
262 } else if (ref->msotype() == MetaspaceObj::SymbolType) {
263 // Make sure the symbol won't be GC'ed while we are dumping the archive.
264 Symbol* sym = (Symbol*)ref->obj();
265 sym->increment_refcount();
266 _symbols->append(sym);
267 }
268
269 return true; // recurse
270 }
271
272 void ArchiveBuilder::gather_klasses_and_symbols() {
273 ResourceMark rm;
274
275 AOTArtifactFinder::initialize();
276 AOTArtifactFinder::find_artifacts();
277
278 aot_log_info(aot)("Gathering classes and symbols ... ");
279 GatherKlassesAndSymbols doit(this);
280 iterate_roots(&doit);
281 #if INCLUDE_CDS_JAVA_HEAP
282 if (CDSConfig::is_dumping_full_module_graph()) {
283 ClassLoaderDataShared::iterate_symbols(&doit);
284 }
285 #endif
286 doit.finish();
287
288 if (CDSConfig::is_dumping_static_archive()) {
289 // To ensure deterministic contents in the static archive, we need to ensure that
290 // we iterate the MetaspaceObjs in a deterministic order. It doesn't matter where
291 // the MetaspaceObjs are located originally, as they are copied sequentially into
292 // the archive during the iteration.
293 //
294 // The only issue here is that the symbol table and the system directories may be
295 // randomly ordered, so we copy the symbols and klasses into two arrays and sort
296 // them deterministically.
297 //
298 // During -Xshare:dump, the order of Symbol creation is strictly determined by
299 // the SharedClassListFile (class loading is done in a single thread and the JIT
300 // is disabled). Also, Symbols are allocated in monotonically increasing addresses
301 // (see Symbol::operator new(size_t, int)). So if we iterate the Symbols by
302 // ascending address order, we ensure that all Symbols are copied into deterministic
303 // locations in the archive.
304 //
305 // TODO: in the future, if we want to produce deterministic contents in the
306 // dynamic archive, we might need to sort the symbols alphabetically (also see
307 // DynamicArchiveBuilder::sort_methods()).
308 aot_log_info(aot)("Sorting symbols ... ");
309 _symbols->sort(compare_symbols_by_address);
310 sort_klasses();
311 }
312
313 AOTClassLinker::add_candidates();
314 }
315
316 int ArchiveBuilder::compare_symbols_by_address(Symbol** a, Symbol** b) {
317 if (a[0] < b[0]) {
318 return -1;
319 } else {
320 assert(a[0] > b[0], "Duplicated symbol %s unexpected", (*a)->as_C_string());
321 return 1;
322 }
323 }
324
325 int ArchiveBuilder::compare_klass_by_name(Klass** a, Klass** b) {
326 return a[0]->name()->fast_compare(b[0]->name());
327 }
328
329 void ArchiveBuilder::sort_klasses() {
330 aot_log_info(aot)("Sorting classes ... ");
331 _klasses->sort(compare_klass_by_name);
332 }
333
334 address ArchiveBuilder::reserve_buffer() {
335 // AOTCodeCache::max_aot_code_size() accounts for aot code region.
336 size_t buffer_size = LP64_ONLY(CompressedClassSpaceSize) NOT_LP64(256 * M) + AOTCodeCache::max_aot_code_size();
337 ReservedSpace rs = MemoryReserver::reserve(buffer_size,
338 MetaspaceShared::core_region_alignment(),
339 os::vm_page_size(),
340 mtNone);
341 if (!rs.is_reserved()) {
342 aot_log_error(aot)("Failed to reserve %zu bytes of output buffer.", buffer_size);
343 MetaspaceShared::unrecoverable_writing_error();
344 }
345
346 // buffer_bottom is the lowest address of the 2 core regions (rw, ro) when
347 // we are copying the class metadata into the buffer.
348 address buffer_bottom = (address)rs.base();
349 aot_log_info(aot)("Reserved output buffer space at " PTR_FORMAT " [%zu bytes]",
350 p2i(buffer_bottom), buffer_size);
351 _shared_rs = rs;
352
353 _buffer_bottom = buffer_bottom;
354
355 if (CDSConfig::is_dumping_static_archive()) {
356 _current_dump_region = &_pz_region;
357 } else {
358 _current_dump_region = &_rw_region;
359 }
360 _current_dump_region->init(&_shared_rs, &_shared_vs);
361
362 ArchivePtrMarker::initialize(&_ptrmap, &_shared_vs);
363
364 // The bottom of the static archive should be mapped at this address by default.
365 _requested_static_archive_bottom = (address)MetaspaceShared::requested_base_address();
366
367 // The bottom of the archive (that I am writing now) should be mapped at this address by default.
368 address my_archive_requested_bottom;
369
370 if (CDSConfig::is_dumping_static_archive()) {
371 my_archive_requested_bottom = _requested_static_archive_bottom;
372 } else {
373 _mapped_static_archive_bottom = (address)MetaspaceObj::shared_metaspace_base();
374 _mapped_static_archive_top = (address)MetaspaceObj::shared_metaspace_top();
375 assert(_mapped_static_archive_top >= _mapped_static_archive_bottom, "must be");
376 size_t static_archive_size = _mapped_static_archive_top - _mapped_static_archive_bottom;
377
378 // At run time, we will mmap the dynamic archive at my_archive_requested_bottom
379 _requested_static_archive_top = _requested_static_archive_bottom + static_archive_size;
380 my_archive_requested_bottom = align_up(_requested_static_archive_top, MetaspaceShared::core_region_alignment());
381
382 _requested_dynamic_archive_bottom = my_archive_requested_bottom;
383 }
384
385 _buffer_to_requested_delta = my_archive_requested_bottom - _buffer_bottom;
386
387 address my_archive_requested_top = my_archive_requested_bottom + buffer_size;
388 if (my_archive_requested_bottom < _requested_static_archive_bottom ||
389 my_archive_requested_top <= _requested_static_archive_bottom) {
390 // Size overflow.
391 aot_log_error(aot)("my_archive_requested_bottom = " INTPTR_FORMAT, p2i(my_archive_requested_bottom));
392 aot_log_error(aot)("my_archive_requested_top = " INTPTR_FORMAT, p2i(my_archive_requested_top));
393 aot_log_error(aot)("SharedBaseAddress (" INTPTR_FORMAT ") is too high. "
394 "Please rerun java -Xshare:dump with a lower value", p2i(_requested_static_archive_bottom));
395 MetaspaceShared::unrecoverable_writing_error();
396 }
397
398 if (CDSConfig::is_dumping_static_archive()) {
399 // We don't want any valid object to be at the very bottom of the archive.
400 // See ArchivePtrMarker::mark_pointer().
401 _pz_region.allocate(MetaspaceShared::protection_zone_size());
402 start_dump_region(&_rw_region);
403 }
404
405 return buffer_bottom;
406 }
407
408 void ArchiveBuilder::iterate_sorted_roots(MetaspaceClosure* it) {
409 int num_symbols = _symbols->length();
410 for (int i = 0; i < num_symbols; i++) {
411 it->push(_symbols->adr_at(i));
412 }
413
414 int num_klasses = _klasses->length();
415 for (int i = 0; i < num_klasses; i++) {
416 it->push(_klasses->adr_at(i));
417 }
418
419 iterate_roots(it);
420 }
421
422 class GatherSortedSourceObjs : public MetaspaceClosure {
423 ArchiveBuilder* _builder;
424
425 public:
426 GatherSortedSourceObjs(ArchiveBuilder* builder) : _builder(builder) {}
427
428 virtual bool do_ref(Ref* ref, bool read_only) {
429 return _builder->gather_one_source_obj(ref, read_only);
430 }
431 };
432
433 bool ArchiveBuilder::gather_one_source_obj(MetaspaceClosure::Ref* ref, bool read_only) {
434 address src_obj = ref->obj();
435 if (src_obj == nullptr) {
436 return false;
437 }
438
439 remember_embedded_pointer_in_enclosing_obj(ref);
440 if (RegeneratedClasses::has_been_regenerated(src_obj)) {
441 // No need to copy it. We will later relocate it to point to the regenerated klass/method.
442 return false;
443 }
444
445 FollowMode follow_mode = get_follow_mode(ref);
446 SourceObjInfo src_info(ref, read_only, follow_mode);
447 bool created;
448 SourceObjInfo* p = _src_obj_table.put_if_absent(src_obj, src_info, &created);
449 if (created) {
450 if (_src_obj_table.maybe_grow()) {
451 log_info(aot, hashtables)("Expanded _src_obj_table table to %d", _src_obj_table.table_size());
452 }
453 }
454
455 #ifdef ASSERT
456 if (ref->msotype() == MetaspaceObj::MethodType) {
457 Method* m = (Method*)ref->obj();
458 assert(!RegeneratedClasses::has_been_regenerated((address)m->method_holder()),
459 "Should not archive methods in a class that has been regenerated");
460 }
461 #endif
462
463 if (ref->msotype() == MetaspaceObj::MethodDataType) {
464 MethodData* md = (MethodData*)ref->obj();
465 md->clean_method_data(false /* always_clean */);
466 }
467
468 assert(p->read_only() == src_info.read_only(), "must be");
469
470 if (created && src_info.should_copy()) {
471 if (read_only) {
472 _ro_src_objs.append(p);
473 } else {
474 _rw_src_objs.append(p);
475 }
476 return true; // Need to recurse into this ref only if we are copying it
477 } else {
478 return false;
479 }
480 }
481
482 void ArchiveBuilder::record_regenerated_object(address orig_src_obj, address regen_src_obj) {
483 // Record the fact that orig_src_obj has been replaced by regen_src_obj. All calls to get_buffered_addr(orig_src_obj)
484 // should return the same value as get_buffered_addr(regen_src_obj).
485 SourceObjInfo* p = _src_obj_table.get(regen_src_obj);
486 assert(p != nullptr, "regenerated object should always be dumped");
487 SourceObjInfo orig_src_info(orig_src_obj, p);
488 bool created;
489 _src_obj_table.put_if_absent(orig_src_obj, orig_src_info, &created);
490 assert(created, "We shouldn't have archived the original copy of a regenerated object");
491 }
492
493 // Remember that we have a pointer inside ref->enclosing_obj() that points to ref->obj()
494 void ArchiveBuilder::remember_embedded_pointer_in_enclosing_obj(MetaspaceClosure::Ref* ref) {
495 assert(ref->obj() != nullptr, "should have checked");
496
497 address enclosing_obj = ref->enclosing_obj();
498 if (enclosing_obj == nullptr) {
499 return;
500 }
501
502 // We are dealing with 3 addresses:
503 // address o = ref->obj(): We have found an object whose address is o.
504 // address* mpp = ref->mpp(): The object o is pointed to by a pointer whose address is mpp.
505 // I.e., (*mpp == o)
506 // enclosing_obj : If non-null, it is the object which has a field that points to o.
507 // mpp is the address if that field.
508 //
509 // Example: We have an array whose first element points to a Method:
510 // Method* o = 0x0000abcd;
511 // Array<Method*>* enclosing_obj = 0x00001000;
512 // enclosing_obj->at_put(0, o);
513 //
514 // We the MetaspaceClosure iterates on the very first element of this array, we have
515 // ref->obj() == 0x0000abcd (the Method)
516 // ref->mpp() == 0x00001008 (the location of the first element in the array)
517 // ref->enclosing_obj() == 0x00001000 (the Array that contains the Method)
518 //
519 // We use the above information to mark the bitmap to indicate that there's a pointer on address 0x00001008.
520 SourceObjInfo* src_info = _src_obj_table.get(enclosing_obj);
521 if (src_info == nullptr || !src_info->should_copy()) {
522 // source objects of point_to_it/set_to_null types are not copied
523 // so we don't need to remember their pointers.
524 } else {
525 if (src_info->read_only()) {
526 _ro_src_objs.remember_embedded_pointer(src_info, ref);
527 } else {
528 _rw_src_objs.remember_embedded_pointer(src_info, ref);
529 }
530 }
531 }
532
533 void ArchiveBuilder::gather_source_objs() {
534 ResourceMark rm;
535 aot_log_info(aot)("Gathering all archivable objects ... ");
536 gather_klasses_and_symbols();
537 GatherSortedSourceObjs doit(this);
538 iterate_sorted_roots(&doit);
539 doit.finish();
540 }
541
542 bool ArchiveBuilder::is_excluded(Klass* klass) {
543 if (klass->is_instance_klass()) {
544 InstanceKlass* ik = InstanceKlass::cast(klass);
545 return SystemDictionaryShared::is_excluded_class(ik);
546 } else if (klass->is_objArray_klass()) {
547 Klass* bottom = ObjArrayKlass::cast(klass)->bottom_klass();
548 if (CDSConfig::is_dumping_dynamic_archive() && MetaspaceShared::is_shared_static(bottom)) {
549 // The bottom class is in the static archive so it's clearly not excluded.
550 return false;
551 } else if (bottom->is_instance_klass()) {
552 return SystemDictionaryShared::is_excluded_class(InstanceKlass::cast(bottom));
553 }
554 }
555
556 return false;
557 }
558
559 ArchiveBuilder::FollowMode ArchiveBuilder::get_follow_mode(MetaspaceClosure::Ref *ref) {
560 address obj = ref->obj();
561 if (CDSConfig::is_dumping_dynamic_archive() && MetaspaceShared::is_in_shared_metaspace(obj)) {
562 // Don't dump existing shared metadata again.
563 return point_to_it;
564 } else if (ref->msotype() == MetaspaceObj::MethodDataType ||
565 ref->msotype() == MetaspaceObj::MethodCountersType ||
566 ref->msotype() == MetaspaceObj::KlassTrainingDataType ||
567 ref->msotype() == MetaspaceObj::MethodTrainingDataType ||
568 ref->msotype() == MetaspaceObj::CompileTrainingDataType) {
569 return (TrainingData::need_data() || TrainingData::assembling_data()) ? make_a_copy : set_to_null;
570 } else if (ref->msotype() == MetaspaceObj::AdapterHandlerEntryType) {
571 if (CDSConfig::is_dumping_adapters()) {
572 AdapterHandlerEntry* entry = (AdapterHandlerEntry*)ref->obj();
573 return AdapterHandlerLibrary::is_abstract_method_adapter(entry) ? set_to_null : make_a_copy;
574 } else {
575 return set_to_null;
576 }
577 } else {
578 if (ref->msotype() == MetaspaceObj::ClassType) {
579 Klass* klass = (Klass*)ref->obj();
580 assert(klass->is_klass(), "must be");
581 if (is_excluded(klass)) {
582 ResourceMark rm;
583 log_debug(cds, dynamic)("Skipping class (excluded): %s", klass->external_name());
584 return set_to_null;
585 }
586 }
587
588 return make_a_copy;
589 }
590 }
591
592 void ArchiveBuilder::start_dump_region(DumpRegion* next) {
593 current_dump_region()->pack(next);
594 _current_dump_region = next;
595 }
596
597 char* ArchiveBuilder::ro_strdup(const char* s) {
598 char* archived_str = ro_region_alloc((int)strlen(s) + 1);
599 strcpy(archived_str, s);
600 return archived_str;
601 }
602
603 // The objects that have embedded pointers will sink
604 // towards the end of the list. This ensures we have a maximum
605 // number of leading zero bits in the relocation bitmap.
606 int ArchiveBuilder::compare_src_objs(SourceObjInfo** a, SourceObjInfo** b) {
607 if ((*a)->has_embedded_pointer() && !(*b)->has_embedded_pointer()) {
608 return 1;
609 } else if (!(*a)->has_embedded_pointer() && (*b)->has_embedded_pointer()) {
610 return -1;
611 } else {
612 // This is necessary to keep the sorting order stable. Otherwise the
613 // archive's contents may not be deterministic.
614 return (*a)->id() - (*b)->id();
615 }
616 }
617
618 void ArchiveBuilder::sort_metadata_objs() {
619 _rw_src_objs.objs()->sort(compare_src_objs);
620 _ro_src_objs.objs()->sort(compare_src_objs);
621 }
622
623 void ArchiveBuilder::dump_rw_metadata() {
624 ResourceMark rm;
625 aot_log_info(aot)("Allocating RW objects ... ");
626 make_shallow_copies(&_rw_region, &_rw_src_objs);
627
628 #if INCLUDE_CDS_JAVA_HEAP
629 if (CDSConfig::is_dumping_full_module_graph()) {
630 // Archive the ModuleEntry's and PackageEntry's of the 3 built-in loaders
631 char* start = rw_region()->top();
632 ClassLoaderDataShared::allocate_archived_tables();
633 alloc_stats()->record_modules(rw_region()->top() - start, /*read_only*/false);
634 }
635 #endif
636 }
637
638 void ArchiveBuilder::dump_ro_metadata() {
639 ResourceMark rm;
640 aot_log_info(aot)("Allocating RO objects ... ");
641
642 start_dump_region(&_ro_region);
643 make_shallow_copies(&_ro_region, &_ro_src_objs);
644
645 #if INCLUDE_CDS_JAVA_HEAP
646 if (CDSConfig::is_dumping_full_module_graph()) {
647 char* start = ro_region()->top();
648 ClassLoaderDataShared::init_archived_tables();
649 alloc_stats()->record_modules(ro_region()->top() - start, /*read_only*/true);
650 }
651 #endif
652
653 RegeneratedClasses::record_regenerated_objects();
654 }
655
656 void ArchiveBuilder::make_shallow_copies(DumpRegion *dump_region,
657 const ArchiveBuilder::SourceObjList* src_objs) {
658 for (int i = 0; i < src_objs->objs()->length(); i++) {
659 make_shallow_copy(dump_region, src_objs->objs()->at(i));
660 }
661 aot_log_info(aot)("done (%d objects)", src_objs->objs()->length());
662 }
663
664 void ArchiveBuilder::make_shallow_copy(DumpRegion *dump_region, SourceObjInfo* src_info) {
665 address src = src_info->source_addr();
666 int bytes = src_info->size_in_bytes();
667 char* dest;
668 char* oldtop;
669 char* newtop;
670
671 oldtop = dump_region->top();
672 if (src_info->msotype() == MetaspaceObj::ClassType) {
673 // Allocate space for a pointer directly in front of the future InstanceKlass, so
674 // we can do a quick lookup from InstanceKlass* -> RunTimeClassInfo*
675 // without building another hashtable. See RunTimeClassInfo::get_for()
676 // in systemDictionaryShared.cpp.
677 Klass* klass = (Klass*)src;
678 if (klass->is_instance_klass()) {
679 SystemDictionaryShared::validate_before_archiving(InstanceKlass::cast(klass));
680 dump_region->allocate(sizeof(address));
681 }
682 // Allocate space for the future InstanceKlass with proper alignment
683 const size_t alignment =
684 #ifdef _LP64
685 UseCompressedClassPointers ?
686 nth_bit(ArchiveBuilder::precomputed_narrow_klass_shift()) :
687 SharedSpaceObjectAlignment;
688 #else
689 SharedSpaceObjectAlignment;
690 #endif
691 dest = dump_region->allocate(bytes, alignment);
692 } else {
693 dest = dump_region->allocate(bytes);
694 }
695 newtop = dump_region->top();
696
697 memcpy(dest, src, bytes);
698
699 // Update the hash of buffered sorted symbols for static dump so that the symbols have deterministic contents
700 if (CDSConfig::is_dumping_static_archive() && (src_info->msotype() == MetaspaceObj::SymbolType)) {
701 Symbol* buffered_symbol = (Symbol*)dest;
702 assert(((Symbol*)src)->is_permanent(), "archived symbols must be permanent");
703 buffered_symbol->update_identity_hash();
704 }
705
706 {
707 bool created;
708 _buffered_to_src_table.put_if_absent((address)dest, src, &created);
709 assert(created, "must be");
710 if (_buffered_to_src_table.maybe_grow()) {
711 log_info(aot, hashtables)("Expanded _buffered_to_src_table table to %d", _buffered_to_src_table.table_size());
712 }
713 }
714
715 intptr_t* archived_vtable = CppVtables::get_archived_vtable(src_info->msotype(), (address)dest);
716 if (archived_vtable != nullptr) {
717 *(address*)dest = (address)archived_vtable;
718 ArchivePtrMarker::mark_pointer((address*)dest);
719 }
720
721 log_trace(aot)("Copy: " PTR_FORMAT " ==> " PTR_FORMAT " %d", p2i(src), p2i(dest), bytes);
722 src_info->set_buffered_addr((address)dest);
723
724 _alloc_stats.record(src_info->msotype(), int(newtop - oldtop), src_info->read_only());
725
726 DEBUG_ONLY(_alloc_stats.verify((int)dump_region->used(), src_info->read_only()));
727 }
728
729 // This is used by code that hand-assembles data structures, such as the LambdaProxyClassKey, that are
730 // not handled by MetaspaceClosure.
731 void ArchiveBuilder::write_pointer_in_buffer(address* ptr_location, address src_addr) {
732 assert(is_in_buffer_space(ptr_location), "must be");
733 if (src_addr == nullptr) {
734 *ptr_location = nullptr;
735 ArchivePtrMarker::clear_pointer(ptr_location);
736 } else {
737 *ptr_location = get_buffered_addr(src_addr);
738 ArchivePtrMarker::mark_pointer(ptr_location);
739 }
740 }
741
742 void ArchiveBuilder::mark_and_relocate_to_buffered_addr(address* ptr_location) {
743 assert(*ptr_location != nullptr, "sanity");
744 if (!is_in_mapped_static_archive(*ptr_location)) {
745 *ptr_location = get_buffered_addr(*ptr_location);
746 }
747 ArchivePtrMarker::mark_pointer(ptr_location);
748 }
749
750 bool ArchiveBuilder::has_been_archived(address src_addr) const {
751 SourceObjInfo* p = _src_obj_table.get(src_addr);
752 return (p != nullptr);
753 }
754
755 bool ArchiveBuilder::has_been_buffered(address src_addr) const {
756 if (RegeneratedClasses::has_been_regenerated(src_addr) ||
757 _src_obj_table.get(src_addr) == nullptr ||
758 get_buffered_addr(src_addr) == nullptr) {
759 return false;
760 } else {
761 return true;
762 }
763 }
764
765 address ArchiveBuilder::get_buffered_addr(address src_addr) const {
766 SourceObjInfo* p = _src_obj_table.get(src_addr);
767 assert(p != nullptr, "src_addr " INTPTR_FORMAT " is used but has not been archived",
768 p2i(src_addr));
769
770 return p->buffered_addr();
771 }
772
773 address ArchiveBuilder::get_source_addr(address buffered_addr) const {
774 assert(is_in_buffer_space(buffered_addr), "must be");
775 address* src_p = _buffered_to_src_table.get(buffered_addr);
776 assert(src_p != nullptr && *src_p != nullptr, "must be");
777 return *src_p;
778 }
779
780 void ArchiveBuilder::relocate_embedded_pointers(ArchiveBuilder::SourceObjList* src_objs) {
781 for (int i = 0; i < src_objs->objs()->length(); i++) {
782 src_objs->relocate(i, this);
783 }
784 }
785
786 void ArchiveBuilder::relocate_metaspaceobj_embedded_pointers() {
787 aot_log_info(aot)("Relocating embedded pointers in core regions ... ");
788 relocate_embedded_pointers(&_rw_src_objs);
789 relocate_embedded_pointers(&_ro_src_objs);
790 log_info(cds)("Relocating %zu pointers, %zu tagged, %zu nulled",
791 _relocated_ptr_info._num_ptrs,
792 _relocated_ptr_info._num_tagged_ptrs,
793 _relocated_ptr_info._num_nulled_ptrs);
794 }
795
796 #define ADD_COUNT(x) \
797 x += 1; \
798 x ## _a += aotlinked ? 1 : 0; \
799 x ## _i += inited ? 1 : 0;
800
801 #define DECLARE_INSTANCE_KLASS_COUNTER(x) \
802 int x = 0; \
803 int x ## _a = 0; \
804 int x ## _i = 0;
805
806 void ArchiveBuilder::make_klasses_shareable() {
807 DECLARE_INSTANCE_KLASS_COUNTER(num_instance_klasses);
808 DECLARE_INSTANCE_KLASS_COUNTER(num_boot_klasses);
809 DECLARE_INSTANCE_KLASS_COUNTER(num_vm_klasses);
810 DECLARE_INSTANCE_KLASS_COUNTER(num_platform_klasses);
811 DECLARE_INSTANCE_KLASS_COUNTER(num_app_klasses);
812 DECLARE_INSTANCE_KLASS_COUNTER(num_old_klasses);
813 DECLARE_INSTANCE_KLASS_COUNTER(num_hidden_klasses);
814 DECLARE_INSTANCE_KLASS_COUNTER(num_enum_klasses);
815 DECLARE_INSTANCE_KLASS_COUNTER(num_unregistered_klasses);
816 int num_unlinked_klasses = 0;
817 int num_obj_array_klasses = 0;
818 int num_type_array_klasses = 0;
819
820 int boot_unlinked = 0;
821 int platform_unlinked = 0;
822 int app_unlinked = 0;
823 int unreg_unlinked = 0;
824
825 for (int i = 0; i < klasses()->length(); i++) {
826 // Some of the code in ConstantPool::remove_unshareable_info() requires the classes
827 // to be in linked state, so it must be call here before the next loop, which returns
828 // all classes to unlinked state.
829 Klass* k = get_buffered_addr(klasses()->at(i));
830 if (k->is_instance_klass()) {
831 InstanceKlass::cast(k)->constants()->remove_unshareable_info();
832 }
833 }
834
835 for (int i = 0; i < klasses()->length(); i++) {
836 const char* type;
837 const char* unlinked = "";
838 const char* kind = "";
839 const char* hidden = "";
840 const char* old = "";
841 const char* generated = "";
842 const char* aotlinked_msg = "";
843 const char* inited_msg = "";
844 Klass* k = get_buffered_addr(klasses()->at(i));
845 bool inited = false;
846 k->remove_java_mirror();
847 #ifdef _LP64
848 if (UseCompactObjectHeaders) {
849 Klass* requested_k = to_requested(k);
850 address narrow_klass_base = _requested_static_archive_bottom; // runtime encoding base == runtime mapping start
851 const int narrow_klass_shift = precomputed_narrow_klass_shift();
852 narrowKlass nk = CompressedKlassPointers::encode_not_null_without_asserts(requested_k, narrow_klass_base, narrow_klass_shift);
853 k->set_prototype_header(markWord::prototype().set_narrow_klass(nk));
854 }
855 #endif //_LP64
856 if (k->is_objArray_klass()) {
857 // InstanceKlass and TypeArrayKlass will in turn call remove_unshareable_info
858 // on their array classes.
859 num_obj_array_klasses ++;
860 type = "array";
861 } else if (k->is_typeArray_klass()) {
862 num_type_array_klasses ++;
863 type = "array";
864 k->remove_unshareable_info();
865 } else {
866 assert(k->is_instance_klass(), " must be");
867 InstanceKlass* ik = InstanceKlass::cast(k);
868 InstanceKlass* src_ik = get_source_addr(ik);
869 bool aotlinked = AOTClassLinker::is_candidate(src_ik);
870 inited = ik->has_aot_initialized_mirror();
871 ADD_COUNT(num_instance_klasses);
872 if (ik->is_hidden()) {
873 ADD_COUNT(num_hidden_klasses);
874 hidden = " hidden";
875 oop loader = k->class_loader();
876 if (loader == nullptr) {
877 type = "boot";
878 ADD_COUNT(num_boot_klasses);
879 } else if (loader == SystemDictionary::java_platform_loader()) {
880 type = "plat";
881 ADD_COUNT(num_platform_klasses);
882 } else if (loader == SystemDictionary::java_system_loader()) {
883 type = "app";
884 ADD_COUNT(num_app_klasses);
885 } else {
886 type = "bad";
887 assert(0, "shouldn't happen");
888 }
889 if (CDSConfig::is_dumping_method_handles()) {
890 assert(HeapShared::is_archivable_hidden_klass(ik), "sanity");
891 } else {
892 // Legacy CDS support for lambda proxies
893 CDS_JAVA_HEAP_ONLY(assert(HeapShared::is_lambda_proxy_klass(ik), "sanity");)
894 }
895 } else if (ik->defined_by_boot_loader()) {
896 type = "boot";
897 ADD_COUNT(num_boot_klasses);
898 } else if (ik->defined_by_platform_loader()) {
899 type = "plat";
900 ADD_COUNT(num_platform_klasses);
901 } else if (ik->defined_by_app_loader()) {
902 type = "app";
903 ADD_COUNT(num_app_klasses);
904 } else {
905 assert(ik->defined_by_other_loaders(), "must be");
906 type = "unreg";
907 ADD_COUNT(num_unregistered_klasses);
908 }
909
910 if (AOTClassLinker::is_vm_class(src_ik)) {
911 ADD_COUNT(num_vm_klasses);
912 }
913
914 if (!ik->is_linked()) {
915 num_unlinked_klasses ++;
916 unlinked = " unlinked";
917 if (ik->defined_by_boot_loader()) {
918 boot_unlinked ++;
919 } else if (ik->defined_by_platform_loader()) {
920 platform_unlinked ++;
921 } else if (ik->defined_by_app_loader()) {
922 app_unlinked ++;
923 } else {
924 unreg_unlinked ++;
925 }
926 }
927
928 if (ik->is_interface()) {
929 kind = " interface";
930 } else if (src_ik->is_enum_subclass()) {
931 kind = " enum";
932 ADD_COUNT(num_enum_klasses);
933 }
934
935 if (!ik->can_be_verified_at_dumptime()) {
936 ADD_COUNT(num_old_klasses);
937 old = " old";
938 }
939
940 if (ik->is_generated_shared_class()) {
941 generated = " generated";
942 }
943 if (aotlinked) {
944 aotlinked_msg = " aot-linked";
945 }
946 if (inited) {
947 if (InstanceKlass::cast(k)->static_field_size() == 0) {
948 inited_msg = " inited (no static fields)";
949 } else {
950 inited_msg = " inited";
951 }
952 }
953
954 MetaspaceShared::rewrite_nofast_bytecodes_and_calculate_fingerprints(Thread::current(), ik);
955 ik->remove_unshareable_info();
956 }
957
958 if (aot_log_is_enabled(Debug, aot, class)) {
959 ResourceMark rm;
960 aot_log_debug(aot, class)("klasses[%5d] = " PTR_FORMAT " %-5s %s%s%s%s%s%s%s%s", i,
961 p2i(to_requested(k)), type, k->external_name(),
962 kind, hidden, old, unlinked, generated, aotlinked_msg, inited_msg);
963 }
964 }
965
966 #define STATS_FORMAT "= %5d, aot-linked = %5d, inited = %5d"
967 #define STATS_PARAMS(x) num_ ## x, num_ ## x ## _a, num_ ## x ## _i
968
969 aot_log_info(aot)("Number of classes %d", num_instance_klasses + num_obj_array_klasses + num_type_array_klasses);
970 aot_log_info(aot)(" instance classes " STATS_FORMAT, STATS_PARAMS(instance_klasses));
971 aot_log_info(aot)(" boot " STATS_FORMAT, STATS_PARAMS(boot_klasses));
972 aot_log_info(aot)(" vm " STATS_FORMAT, STATS_PARAMS(vm_klasses));
973 aot_log_info(aot)(" platform " STATS_FORMAT, STATS_PARAMS(platform_klasses));
974 aot_log_info(aot)(" app " STATS_FORMAT, STATS_PARAMS(app_klasses));
975 aot_log_info(aot)(" unregistered " STATS_FORMAT, STATS_PARAMS(unregistered_klasses));
976 aot_log_info(aot)(" (enum) " STATS_FORMAT, STATS_PARAMS(enum_klasses));
977 aot_log_info(aot)(" (hidden) " STATS_FORMAT, STATS_PARAMS(hidden_klasses));
978 aot_log_info(aot)(" (old) " STATS_FORMAT, STATS_PARAMS(old_klasses));
979 aot_log_info(aot)(" (unlinked) = %5d, boot = %d, plat = %d, app = %d, unreg = %d",
980 num_unlinked_klasses, boot_unlinked, platform_unlinked, app_unlinked, unreg_unlinked);
981 aot_log_info(aot)(" obj array classes = %5d", num_obj_array_klasses);
982 aot_log_info(aot)(" type array classes = %5d", num_type_array_klasses);
983 aot_log_info(aot)(" symbols = %5d", _symbols->length());
984
985 #undef STATS_FORMAT
986 #undef STATS_PARAMS
987
988 DynamicArchive::make_array_klasses_shareable();
989 }
990
991 void ArchiveBuilder::make_training_data_shareable() {
992 auto clean_td = [&] (address& src_obj, SourceObjInfo& info) {
993 if (!is_in_buffer_space(info.buffered_addr())) {
994 return;
995 }
996
997 if (info.msotype() == MetaspaceObj::KlassTrainingDataType ||
998 info.msotype() == MetaspaceObj::MethodTrainingDataType ||
999 info.msotype() == MetaspaceObj::CompileTrainingDataType) {
1000 TrainingData* buffered_td = (TrainingData*)info.buffered_addr();
1001 buffered_td->remove_unshareable_info();
1002 } else if (info.msotype() == MetaspaceObj::MethodDataType) {
1003 MethodData* buffered_mdo = (MethodData*)info.buffered_addr();
1004 buffered_mdo->remove_unshareable_info();
1005 } else if (info.msotype() == MetaspaceObj::MethodCountersType) {
1006 MethodCounters* buffered_mc = (MethodCounters*)info.buffered_addr();
1007 buffered_mc->remove_unshareable_info();
1008 }
1009 };
1010 _src_obj_table.iterate_all(clean_td);
1011 }
1012
1013 void ArchiveBuilder::serialize_dynamic_archivable_items(SerializeClosure* soc) {
1014 SymbolTable::serialize_shared_table_header(soc, false);
1015 SystemDictionaryShared::serialize_dictionary_headers(soc, false);
1016 DynamicArchive::serialize_array_klasses(soc);
1017 AOTLinkedClassBulkLoader::serialize(soc, false);
1018 }
1019
1020 uintx ArchiveBuilder::buffer_to_offset(address p) const {
1021 address requested_p = to_requested(p);
1022 assert(requested_p >= _requested_static_archive_bottom, "must be");
1023 return requested_p - _requested_static_archive_bottom;
1024 }
1025
1026 uintx ArchiveBuilder::any_to_offset(address p) const {
1027 if (is_in_mapped_static_archive(p)) {
1028 assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
1029 return p - _mapped_static_archive_bottom;
1030 }
1031 if (!is_in_buffer_space(p)) {
1032 // p must be a "source" address
1033 p = get_buffered_addr(p);
1034 }
1035 return buffer_to_offset(p);
1036 }
1037
1038 address ArchiveBuilder::offset_to_buffered_address(u4 offset) const {
1039 address requested_addr = _requested_static_archive_bottom + offset;
1040 address buffered_addr = requested_addr - _buffer_to_requested_delta;
1041 assert(is_in_buffer_space(buffered_addr), "bad offset");
1042 return buffered_addr;
1043 }
1044
1045 void ArchiveBuilder::start_ac_region() {
1046 ro_region()->pack();
1047 start_dump_region(&_ac_region);
1048 }
1049
1050 void ArchiveBuilder::end_ac_region() {
1051 _ac_region.pack();
1052 }
1053
1054 #if INCLUDE_CDS_JAVA_HEAP
1055 narrowKlass ArchiveBuilder::get_requested_narrow_klass(Klass* k) {
1056 assert(CDSConfig::is_dumping_heap(), "sanity");
1057 k = get_buffered_klass(k);
1058 Klass* requested_k = to_requested(k);
1059 const int narrow_klass_shift = ArchiveBuilder::precomputed_narrow_klass_shift();
1060 #ifdef ASSERT
1061 const size_t klass_alignment = MAX2(SharedSpaceObjectAlignment, (size_t)nth_bit(narrow_klass_shift));
1062 assert(is_aligned(k, klass_alignment), "Klass " PTR_FORMAT " misaligned.", p2i(k));
1063 #endif
1064 address narrow_klass_base = _requested_static_archive_bottom; // runtime encoding base == runtime mapping start
1065 // Note: use the "raw" version of encode that takes explicit narrow klass base and shift. Don't use any
1066 // of the variants that do sanity checks, nor any of those that use the current - dump - JVM's encoding setting.
1067 return CompressedKlassPointers::encode_not_null_without_asserts(requested_k, narrow_klass_base, narrow_klass_shift);
1068 }
1069 #endif // INCLUDE_CDS_JAVA_HEAP
1070
1071 // RelocateBufferToRequested --- Relocate all the pointers in rw/ro,
1072 // so that the archive can be mapped to the "requested" location without runtime relocation.
1073 //
1074 // - See ArchiveBuilder header for the definition of "buffer", "mapped" and "requested"
1075 // - ArchivePtrMarker::ptrmap() marks all the pointers in the rw/ro regions
1076 // - Every pointer must have one of the following values:
1077 // [a] nullptr:
1078 // No relocation is needed. Remove this pointer from ptrmap so we don't need to
1079 // consider it at runtime.
1080 // [b] Points into an object X which is inside the buffer:
1081 // Adjust this pointer by _buffer_to_requested_delta, so it points to X
1082 // when the archive is mapped at the requested location.
1083 // [c] Points into an object Y which is inside mapped static archive:
1084 // - This happens only during dynamic dump
1085 // - Adjust this pointer by _mapped_to_requested_static_archive_delta,
1086 // so it points to Y when the static archive is mapped at the requested location.
1087 template <bool STATIC_DUMP>
1088 class RelocateBufferToRequested : public BitMapClosure {
1089 ArchiveBuilder* _builder;
1090 address _buffer_bottom;
1091 intx _buffer_to_requested_delta;
1092 intx _mapped_to_requested_static_archive_delta;
1093 size_t _max_non_null_offset;
1094
1095 public:
1096 RelocateBufferToRequested(ArchiveBuilder* builder) {
1097 _builder = builder;
1098 _buffer_bottom = _builder->buffer_bottom();
1099 _buffer_to_requested_delta = builder->buffer_to_requested_delta();
1100 _mapped_to_requested_static_archive_delta = builder->requested_static_archive_bottom() - builder->mapped_static_archive_bottom();
1101 _max_non_null_offset = 0;
1102
1103 address bottom = _builder->buffer_bottom();
1104 address top = _builder->buffer_top();
1105 address new_bottom = bottom + _buffer_to_requested_delta;
1106 address new_top = top + _buffer_to_requested_delta;
1107 aot_log_debug(aot)("Relocating archive from [" INTPTR_FORMAT " - " INTPTR_FORMAT "] to "
1108 "[" INTPTR_FORMAT " - " INTPTR_FORMAT "]",
1109 p2i(bottom), p2i(top),
1110 p2i(new_bottom), p2i(new_top));
1111 }
1112
1113 bool do_bit(size_t offset) {
1114 address* p = (address*)_buffer_bottom + offset;
1115 assert(_builder->is_in_buffer_space(p), "pointer must live in buffer space");
1116
1117 if (*p == nullptr) {
1118 // todo -- clear bit, etc
1119 ArchivePtrMarker::ptrmap()->clear_bit(offset);
1120 } else {
1121 if (STATIC_DUMP) {
1122 assert(_builder->is_in_buffer_space(*p), "old pointer must point inside buffer space");
1123 *p += _buffer_to_requested_delta;
1124 assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
1125 } else {
1126 if (_builder->is_in_buffer_space(*p)) {
1127 *p += _buffer_to_requested_delta;
1128 // assert is in requested dynamic archive
1129 } else {
1130 assert(_builder->is_in_mapped_static_archive(*p), "old pointer must point inside buffer space or mapped static archive");
1131 *p += _mapped_to_requested_static_archive_delta;
1132 assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
1133 }
1134 }
1135 _max_non_null_offset = offset;
1136 }
1137
1138 return true; // keep iterating
1139 }
1140
1141 void doit() {
1142 ArchivePtrMarker::ptrmap()->iterate(this);
1143 ArchivePtrMarker::compact(_max_non_null_offset);
1144 }
1145 };
1146
1147 #ifdef _LP64
1148 int ArchiveBuilder::precomputed_narrow_klass_shift() {
1149 // Legacy Mode:
1150 // We use 32 bits for narrowKlass, which should cover the full 4G Klass range. Shift can be 0.
1151 // CompactObjectHeader Mode:
1152 // narrowKlass is much smaller, and we use the highest possible shift value to later get the maximum
1153 // Klass encoding range.
1154 //
1155 // Note that all of this may change in the future, if we decide to correct the pre-calculated
1156 // narrow Klass IDs at archive load time.
1157 assert(UseCompressedClassPointers, "Only needed for compressed class pointers");
1158 return UseCompactObjectHeaders ? CompressedKlassPointers::max_shift() : 0;
1159 }
1160 #endif // _LP64
1161
1162 void ArchiveBuilder::relocate_to_requested() {
1163 if (!ro_region()->is_packed()) {
1164 ro_region()->pack();
1165 }
1166 size_t my_archive_size = buffer_top() - buffer_bottom();
1167
1168 if (CDSConfig::is_dumping_static_archive()) {
1169 _requested_static_archive_top = _requested_static_archive_bottom + my_archive_size;
1170 RelocateBufferToRequested<true> patcher(this);
1171 patcher.doit();
1172 } else {
1173 assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
1174 _requested_dynamic_archive_top = _requested_dynamic_archive_bottom + my_archive_size;
1175 RelocateBufferToRequested<false> patcher(this);
1176 patcher.doit();
1177 }
1178 }
1179
1180 // Write detailed info to a mapfile to analyze contents of the archive.
1181 // static dump:
1182 // java -Xshare:dump -Xlog:cds+map=trace:file=cds.map:none:filesize=0
1183 // dynamic dump:
1184 // java -cp MyApp.jar -XX:ArchiveClassesAtExit=MyApp.jsa \
1185 // -Xlog:cds+map=trace:file=cds.map:none:filesize=0 MyApp
1186 //
1187 // We need to do some address translation because the buffers used at dump time may be mapped to
1188 // a different location at runtime. At dump time, the buffers may be at arbitrary locations
1189 // picked by the OS. At runtime, we try to map at a fixed location (SharedBaseAddress). For
1190 // consistency, we log everything using runtime addresses.
1191 class ArchiveBuilder::CDSMapLogger : AllStatic {
1192 static intx buffer_to_runtime_delta() {
1193 // Translate the buffers used by the RW/RO regions to their eventual (requested) locations
1194 // at runtime.
1195 return ArchiveBuilder::current()->buffer_to_requested_delta();
1196 }
1197
1198 // rw/ro regions only
1199 static void log_metaspace_region(const char* name, DumpRegion* region,
1200 const ArchiveBuilder::SourceObjList* src_objs) {
1201 address region_base = address(region->base());
1202 address region_top = address(region->top());
1203 log_region(name, region_base, region_top, region_base + buffer_to_runtime_delta());
1204 log_metaspace_objects(region, src_objs);
1205 }
1206
1207 #define _LOG_PREFIX PTR_FORMAT ": @@ %-17s %d"
1208
1209 static void log_klass(Klass* k, address runtime_dest, const char* type_name, int bytes, Thread* current) {
1210 ResourceMark rm(current);
1211 log_debug(aot, map)(_LOG_PREFIX " %s",
1212 p2i(runtime_dest), type_name, bytes, k->external_name());
1213 }
1214 static void log_method(Method* m, address runtime_dest, const char* type_name, int bytes, Thread* current) {
1215 ResourceMark rm(current);
1216 log_debug(aot, map)(_LOG_PREFIX " %s",
1217 p2i(runtime_dest), type_name, bytes, m->external_name());
1218 }
1219
1220 // rw/ro regions only
1221 static void log_metaspace_objects(DumpRegion* region, const ArchiveBuilder::SourceObjList* src_objs) {
1222 address last_obj_base = address(region->base());
1223 address last_obj_end = address(region->base());
1224 address region_end = address(region->end());
1225 Thread* current = Thread::current();
1226 for (int i = 0; i < src_objs->objs()->length(); i++) {
1227 SourceObjInfo* src_info = src_objs->at(i);
1228 address src = src_info->source_addr();
1229 address dest = src_info->buffered_addr();
1230 log_as_hex(last_obj_base, dest, last_obj_base + buffer_to_runtime_delta());
1231 address runtime_dest = dest + buffer_to_runtime_delta();
1232 int bytes = src_info->size_in_bytes();
1233
1234 MetaspaceObj::Type type = src_info->msotype();
1235 const char* type_name = MetaspaceObj::type_name(type);
1236
1237 switch (type) {
1238 case MetaspaceObj::ClassType:
1239 log_klass((Klass*)src, runtime_dest, type_name, bytes, current);
1240 break;
1241 case MetaspaceObj::ConstantPoolType:
1242 log_klass(((ConstantPool*)src)->pool_holder(),
1243 runtime_dest, type_name, bytes, current);
1244 break;
1245 case MetaspaceObj::ConstantPoolCacheType:
1246 log_klass(((ConstantPoolCache*)src)->constant_pool()->pool_holder(),
1247 runtime_dest, type_name, bytes, current);
1248 break;
1249 case MetaspaceObj::MethodType:
1250 log_method((Method*)src, runtime_dest, type_name, bytes, current);
1251 break;
1252 case MetaspaceObj::ConstMethodType:
1253 log_method(((ConstMethod*)src)->method(), runtime_dest, type_name, bytes, current);
1254 break;
1255 case MetaspaceObj::SymbolType:
1256 {
1257 ResourceMark rm(current);
1258 Symbol* s = (Symbol*)src;
1259 log_debug(aot, map)(_LOG_PREFIX " %s", p2i(runtime_dest), type_name, bytes,
1260 s->as_quoted_ascii());
1261 }
1262 break;
1263 default:
1264 log_debug(aot, map)(_LOG_PREFIX, p2i(runtime_dest), type_name, bytes);
1265 break;
1266 }
1267
1268 last_obj_base = dest;
1269 last_obj_end = dest + bytes;
1270 }
1271
1272 log_as_hex(last_obj_base, last_obj_end, last_obj_base + buffer_to_runtime_delta());
1273 if (last_obj_end < region_end) {
1274 log_debug(aot, map)(PTR_FORMAT ": @@ Misc data %zu bytes",
1275 p2i(last_obj_end + buffer_to_runtime_delta()),
1276 size_t(region_end - last_obj_end));
1277 log_as_hex(last_obj_end, region_end, last_obj_end + buffer_to_runtime_delta());
1278 }
1279 }
1280
1281 #undef _LOG_PREFIX
1282
1283 // Log information about a region, whose address at dump time is [base .. top). At
1284 // runtime, this region will be mapped to requested_base. requested_base is nullptr if this
1285 // region will be mapped at os-selected addresses (such as the bitmap region), or will
1286 // be accessed with os::read (the header).
1287 //
1288 // Note: across -Xshare:dump runs, base may be different, but requested_base should
1289 // be the same as the archive contents should be deterministic.
1290 static void log_region(const char* name, address base, address top, address requested_base) {
1291 size_t size = top - base;
1292 base = requested_base;
1293 if (requested_base == nullptr) {
1294 top = (address)size;
1295 } else {
1296 top = requested_base + size;
1297 }
1298 log_info(aot, map)("[%-18s " PTR_FORMAT " - " PTR_FORMAT " %9zu bytes]",
1299 name, p2i(base), p2i(top), size);
1300 }
1301
1302 #if INCLUDE_CDS_JAVA_HEAP
1303 static void log_heap_region(ArchiveHeapInfo* heap_info) {
1304 MemRegion r = heap_info->buffer_region();
1305 address start = address(r.start()); // start of the current oop inside the buffer
1306 address end = address(r.end());
1307 log_region("heap", start, end, ArchiveHeapWriter::buffered_addr_to_requested_addr(start));
1308
1309 LogStreamHandle(Info, aot, map) st;
1310
1311 HeapRootSegments segments = heap_info->heap_root_segments();
1312 assert(segments.base_offset() == 0, "Sanity");
1313
1314 for (size_t seg_idx = 0; seg_idx < segments.count(); seg_idx++) {
1315 address requested_start = ArchiveHeapWriter::buffered_addr_to_requested_addr(start);
1316 st.print_cr(PTR_FORMAT ": Heap roots segment [%d]",
1317 p2i(requested_start), segments.size_in_elems(seg_idx));
1318 start += segments.size_in_bytes(seg_idx);
1319 }
1320 log_heap_roots();
1321
1322 while (start < end) {
1323 size_t byte_size;
1324 oop source_oop = ArchiveHeapWriter::buffered_addr_to_source_obj(start);
1325 address requested_start = ArchiveHeapWriter::buffered_addr_to_requested_addr(start);
1326 st.print(PTR_FORMAT ": @@ Object ", p2i(requested_start));
1327
1328 if (source_oop != nullptr) {
1329 // This is a regular oop that got archived.
1330 // Don't print the requested addr again as we have just printed it at the beginning of the line.
1331 // Example:
1332 // 0x00000007ffd27938: @@ Object (0xfffa4f27) java.util.HashMap
1333 assert(HeapShared::has_been_archived(source_oop), "did you call HeapShared::rehash_archived_object_cache()?");
1334 print_oop_info_cr(&st, source_oop, /*print_requested_addr=*/false);
1335 byte_size = source_oop->size() * BytesPerWord;
1336 } else if ((byte_size = ArchiveHeapWriter::get_filler_size_at(start)) > 0) {
1337 // We have a filler oop, which also does not exist in BufferOffsetToSourceObjectTable.
1338 // Example:
1339 // 0x00000007ffc3ffd8: @@ Object filler 40 bytes
1340 st.print_cr("filler %zu bytes", byte_size);
1341 } else {
1342 ShouldNotReachHere();
1343 }
1344
1345 address oop_end = start + byte_size;
1346 log_as_hex(start, oop_end, requested_start, /*is_heap=*/true);
1347
1348 if (source_oop != nullptr) {
1349 log_oop_details(heap_info, source_oop, /*buffered_addr=*/start);
1350 }
1351 start = oop_end;
1352 }
1353 }
1354
1355 // ArchivedFieldPrinter is used to print the fields of archived objects. We can't
1356 // use _source_obj->print_on(), because we want to print the oop fields
1357 // in _source_obj with their requested addresses using print_oop_info_cr().
1358 class ArchivedFieldPrinter : public FieldClosure {
1359 ArchiveHeapInfo* _heap_info;
1360 outputStream* _st;
1361 oop _source_obj;
1362 address _buffered_addr;
1363 public:
1364 ArchivedFieldPrinter(ArchiveHeapInfo* heap_info, outputStream* st, oop src_obj, address buffered_addr) :
1365 _heap_info(heap_info), _st(st), _source_obj(src_obj), _buffered_addr(buffered_addr) {}
1366
1367 void do_field(fieldDescriptor* fd) {
1368 _st->print(" - ");
1369 BasicType ft = fd->field_type();
1370 switch (ft) {
1371 case T_ARRAY:
1372 case T_OBJECT:
1373 {
1374 fd->print_on(_st); // print just the name and offset
1375 oop obj = _source_obj->obj_field(fd->offset());
1376 if (java_lang_Class::is_instance(obj)) {
1377 obj = HeapShared::scratch_java_mirror(obj);
1378 }
1379 print_oop_info_cr(_st, obj);
1380 }
1381 break;
1382 default:
1383 if (ArchiveHeapWriter::is_marked_as_native_pointer(_heap_info, _buffered_addr, fd->offset())) {
1384 print_as_native_pointer(fd);
1385 } else {
1386 fd->print_on_for(_st, cast_to_oop(_buffered_addr)); // name, offset, value
1387 _st->cr();
1388 }
1389 }
1390 }
1391
1392 void print_as_native_pointer(fieldDescriptor* fd) {
1393 LP64_ONLY(assert(fd->field_type() == T_LONG, "must be"));
1394 NOT_LP64 (assert(fd->field_type() == T_INT, "must be"));
1395
1396 // We have a field that looks like an integer, but it's actually a pointer to a MetaspaceObj.
1397 address source_native_ptr = (address)
1398 LP64_ONLY(_source_obj->long_field(fd->offset()))
1399 NOT_LP64( _source_obj->int_field (fd->offset()));
1400 ArchiveBuilder* builder = ArchiveBuilder::current();
1401
1402 // The value of the native pointer at runtime.
1403 address requested_native_ptr = builder->to_requested(builder->get_buffered_addr(source_native_ptr));
1404
1405 // The address of _source_obj at runtime
1406 oop requested_obj = cast_to_oop(ArchiveHeapWriter::buffered_addr_to_requested_addr(_buffered_addr));
1407 // The address of this field in the requested space
1408 assert(requested_obj != nullptr, "Attempting to load field from null oop");
1409 address requested_field_addr = cast_from_oop<address>(requested_obj) + fd->offset();
1410
1411 fd->print_on(_st);
1412 _st->print_cr(PTR_FORMAT " (marked metadata pointer @" PTR_FORMAT " )",
1413 p2i(requested_native_ptr), p2i(requested_field_addr));
1414 }
1415 };
1416
1417 // Print the fields of instanceOops, or the elements of arrayOops
1418 static void log_oop_details(ArchiveHeapInfo* heap_info, oop source_oop, address buffered_addr) {
1419 LogStreamHandle(Trace, aot, map, oops) st;
1420 if (st.is_enabled()) {
1421 Klass* source_klass = source_oop->klass();
1422 ArchiveBuilder* builder = ArchiveBuilder::current();
1423 Klass* requested_klass = builder->to_requested(builder->get_buffered_addr(source_klass));
1424
1425 st.print(" - klass: ");
1426 source_klass->print_value_on(&st);
1427 st.print(" " PTR_FORMAT, p2i(requested_klass));
1428 st.cr();
1429
1430 if (source_oop->is_typeArray()) {
1431 TypeArrayKlass::cast(source_klass)->oop_print_elements_on(typeArrayOop(source_oop), &st);
1432 } else if (source_oop->is_objArray()) {
1433 objArrayOop source_obj_array = objArrayOop(source_oop);
1434 for (int i = 0; i < source_obj_array->length(); i++) {
1435 st.print(" -%4d: ", i);
1436 oop obj = source_obj_array->obj_at(i);
1437 if (java_lang_Class::is_instance(obj)) {
1438 obj = HeapShared::scratch_java_mirror(obj);
1439 }
1440 print_oop_info_cr(&st, obj);
1441 }
1442 } else {
1443 st.print_cr(" - fields (%zu words):", source_oop->size());
1444 ArchivedFieldPrinter print_field(heap_info, &st, source_oop, buffered_addr);
1445 InstanceKlass::cast(source_klass)->print_nonstatic_fields(&print_field);
1446
1447 if (java_lang_Class::is_instance(source_oop)) {
1448 oop scratch_mirror = source_oop;
1449 st.print(" - signature: ");
1450 print_class_signature_for_mirror(&st, scratch_mirror);
1451 st.cr();
1452
1453 Klass* src_klass = java_lang_Class::as_Klass(scratch_mirror);
1454 if (src_klass != nullptr && src_klass->is_instance_klass()) {
1455 oop rr = HeapShared::scratch_resolved_references(InstanceKlass::cast(src_klass)->constants());
1456 st.print(" - archived_resolved_references: ");
1457 print_oop_info_cr(&st, rr);
1458
1459 // We need to print the fields in the scratch_mirror, not the original mirror.
1460 // (if a class is not aot-initialized, static fields in its scratch mirror will be cleared).
1461 assert(scratch_mirror == HeapShared::scratch_java_mirror(src_klass->java_mirror()), "sanity");
1462 st.print_cr("- ---- static fields (%d):", java_lang_Class::static_oop_field_count(scratch_mirror));
1463 InstanceKlass::cast(src_klass)->do_local_static_fields(&print_field);
1464 }
1465 }
1466 }
1467 }
1468 }
1469
1470 static void print_class_signature_for_mirror(outputStream* st, oop scratch_mirror) {
1471 assert(java_lang_Class::is_instance(scratch_mirror), "sanity");
1472 if (java_lang_Class::is_primitive(scratch_mirror)) {
1473 for (int i = T_BOOLEAN; i < T_VOID+1; i++) {
1474 BasicType bt = (BasicType)i;
1475 if (!is_reference_type(bt) && scratch_mirror == HeapShared::scratch_java_mirror(bt)) {
1476 oop orig_mirror = Universe::java_mirror(bt);
1477 java_lang_Class::print_signature(orig_mirror, st);
1478 return;
1479 }
1480 }
1481 ShouldNotReachHere();
1482 }
1483 java_lang_Class::print_signature(scratch_mirror, st);
1484 }
1485
1486 static void log_heap_roots() {
1487 LogStreamHandle(Trace, aot, map, oops) st;
1488 if (st.is_enabled()) {
1489 for (int i = 0; i < HeapShared::pending_roots()->length(); i++) {
1490 st.print("roots[%4d]: ", i);
1491 print_oop_info_cr(&st, HeapShared::pending_roots()->at(i).resolve());
1492 }
1493 }
1494 }
1495
1496 // Example output:
1497 // - The first number is the requested address (if print_requested_addr == true)
1498 // - The second number is the narrowOop version of the requested address (if UseCompressedOops == true)
1499 // 0x00000007ffc7e840 (0xfff8fd08) java.lang.Class Ljava/util/Array;
1500 // 0x00000007ffc000f8 (0xfff8001f) [B length: 11
1501 static void print_oop_info_cr(outputStream* st, oop source_oop, bool print_requested_addr = true) {
1502 if (source_oop == nullptr) {
1503 st->print_cr("null");
1504 } else {
1505 ResourceMark rm;
1506 assert(HeapShared::has_been_archived(source_oop), "did you call HeapShared::rehash_archived_object_cache()?");
1507 oop requested_obj = ArchiveHeapWriter::source_obj_to_requested_obj(source_oop);
1508 if (print_requested_addr) {
1509 st->print(PTR_FORMAT " ", p2i(requested_obj));
1510 }
1511 if (UseCompressedOops) {
1512 st->print("(0x%08x) ", CompressedOops::narrow_oop_value(requested_obj));
1513 }
1514 if (source_oop->is_array()) {
1515 int array_len = arrayOop(source_oop)->length();
1516 st->print_cr("%s length: %d", source_oop->klass()->external_name(), array_len);
1517 } else {
1518 st->print("%s", source_oop->klass()->external_name());
1519
1520 if (java_lang_String::is_instance(source_oop)) {
1521 st->print(" ");
1522 java_lang_String::print(source_oop, st);
1523 } else if (java_lang_invoke_MethodType::is_instance(source_oop)) {
1524 st->print(" ");
1525 java_lang_invoke_MethodType::print_signature(source_oop, st);
1526 } else if (java_lang_Class::is_instance(source_oop)) {
1527 oop scratch_mirror = source_oop;
1528
1529 st->print(" ");
1530 print_class_signature_for_mirror(st, scratch_mirror);
1531
1532 Klass* src_klass = java_lang_Class::as_Klass(scratch_mirror);
1533 if (src_klass != nullptr && src_klass->is_instance_klass()) {
1534 InstanceKlass* buffered_klass =
1535 ArchiveBuilder::current()->get_buffered_addr(InstanceKlass::cast(src_klass));
1536 if (buffered_klass->has_aot_initialized_mirror()) {
1537 st->print(" (aot-inited)");
1538 }
1539 }
1540 }
1541 st->cr();
1542 }
1543 }
1544 }
1545 #endif // INCLUDE_CDS_JAVA_HEAP
1546
1547 // Log all the data [base...top). Pretend that the base address
1548 // will be mapped to requested_base at run-time.
1549 static void log_as_hex(address base, address top, address requested_base, bool is_heap = false) {
1550 assert(top >= base, "must be");
1551
1552 LogStreamHandle(Trace, aot, map) lsh;
1553 if (lsh.is_enabled()) {
1554 int unitsize = sizeof(address);
1555 if (is_heap && UseCompressedOops) {
1556 // This makes the compressed oop pointers easier to read, but
1557 // longs and doubles will be split into two words.
1558 unitsize = sizeof(narrowOop);
1559 }
1560 os::print_hex_dump(&lsh, base, top, unitsize, /* print_ascii=*/true, /* bytes_per_line=*/32, requested_base);
1561 }
1562 }
1563
1564 static void log_header(FileMapInfo* mapinfo) {
1565 LogStreamHandle(Info, aot, map) lsh;
1566 if (lsh.is_enabled()) {
1567 mapinfo->print(&lsh);
1568 }
1569 }
1570
1571 public:
1572 static void log(ArchiveBuilder* builder, FileMapInfo* mapinfo,
1573 ArchiveHeapInfo* heap_info,
1574 char* bitmap, size_t bitmap_size_in_bytes) {
1575 // HeapShared::archived_object_cache() uses raw address of oop to compute the hash. At this point,
1576 // a GC might have happened and moved some of the oops, so the table needs to be rehashed.
1577 NoSafepointVerifier nsv;
1578 HeapShared::rehash_archived_object_cache();
1579
1580 log_info(aot, map)("%s CDS archive map for %s", CDSConfig::is_dumping_static_archive() ? "Static" : "Dynamic", mapinfo->full_path());
1581
1582 address header = address(mapinfo->header());
1583 address header_end = header + mapinfo->header()->header_size();
1584 log_region("header", header, header_end, nullptr);
1585 log_header(mapinfo);
1586 log_as_hex(header, header_end, nullptr);
1587
1588 DumpRegion* rw_region = &builder->_rw_region;
1589 DumpRegion* ro_region = &builder->_ro_region;
1590
1591 log_metaspace_region("rw region", rw_region, &builder->_rw_src_objs);
1592 log_metaspace_region("ro region", ro_region, &builder->_ro_src_objs);
1593
1594 address bitmap_end = address(bitmap + bitmap_size_in_bytes);
1595 log_region("bitmap", address(bitmap), bitmap_end, nullptr);
1596 log_as_hex((address)bitmap, bitmap_end, nullptr);
1597
1598 #if INCLUDE_CDS_JAVA_HEAP
1599 if (heap_info->is_used()) {
1600 log_heap_region(heap_info);
1601 }
1602 #endif
1603
1604 log_info(aot, map)("[End of CDS archive map]");
1605 }
1606 }; // end ArchiveBuilder::CDSMapLogger
1607
1608 void ArchiveBuilder::print_stats() {
1609 _alloc_stats.print_stats(int(_ro_region.used()), int(_rw_region.used()));
1610 }
1611
1612 void ArchiveBuilder::write_archive(FileMapInfo* mapinfo, ArchiveHeapInfo* heap_info) {
1613 // Make sure NUM_CDS_REGIONS (exported in cds.h) agrees with
1614 // MetaspaceShared::n_regions (internal to hotspot).
1615 assert(NUM_CDS_REGIONS == MetaspaceShared::n_regions, "sanity");
1616
1617 write_region(mapinfo, MetaspaceShared::rw, &_rw_region, /*read_only=*/false,/*allow_exec=*/false);
1618 write_region(mapinfo, MetaspaceShared::ro, &_ro_region, /*read_only=*/true, /*allow_exec=*/false);
1619 write_region(mapinfo, MetaspaceShared::ac, &_ac_region, /*read_only=*/false,/*allow_exec=*/false);
1620
1621 // Split pointer map into read-write and read-only bitmaps
1622 ArchivePtrMarker::initialize_rw_ro_ac_maps(&_rw_ptrmap, &_ro_ptrmap, &_ac_ptrmap);
1623
1624 size_t bitmap_size_in_bytes;
1625 char* bitmap = mapinfo->write_bitmap_region(ArchivePtrMarker::rw_ptrmap(),
1626 ArchivePtrMarker::ro_ptrmap(),
1627 ArchivePtrMarker::ac_ptrmap(),
1628 heap_info,
1629 bitmap_size_in_bytes);
1630
1631 if (heap_info->is_used()) {
1632 _total_heap_region_size = mapinfo->write_heap_region(heap_info);
1633 }
1634
1635 print_region_stats(mapinfo, heap_info);
1636
1637 mapinfo->set_requested_base((char*)MetaspaceShared::requested_base_address());
1638 mapinfo->set_header_crc(mapinfo->compute_header_crc());
1639 // After this point, we should not write any data into mapinfo->header() since this
1640 // would corrupt its checksum we have calculated before.
1641 mapinfo->write_header();
1642 mapinfo->close();
1643
1644 aot_log_info(aot)("Full module graph = %s", CDSConfig::is_dumping_full_module_graph() ? "enabled" : "disabled");
1645 if (log_is_enabled(Info, aot)) {
1646 print_stats();
1647 }
1648
1649 if (log_is_enabled(Info, aot, map)) {
1650 CDSMapLogger::log(this, mapinfo, heap_info,
1651 bitmap, bitmap_size_in_bytes);
1652 }
1653 CDS_JAVA_HEAP_ONLY(HeapShared::destroy_archived_object_cache());
1654 FREE_C_HEAP_ARRAY(char, bitmap);
1655 }
1656
1657 void ArchiveBuilder::write_region(FileMapInfo* mapinfo, int region_idx, DumpRegion* dump_region, bool read_only, bool allow_exec) {
1658 mapinfo->write_region(region_idx, dump_region->base(), dump_region->used(), read_only, allow_exec);
1659 }
1660
1661 void ArchiveBuilder::count_relocated_pointer(bool tagged, bool nulled) {
1662 _relocated_ptr_info._num_ptrs ++;
1663 _relocated_ptr_info._num_tagged_ptrs += tagged ? 1 : 0;
1664 _relocated_ptr_info._num_nulled_ptrs += nulled ? 1 : 0;
1665 }
1666
1667 void ArchiveBuilder::print_region_stats(FileMapInfo *mapinfo, ArchiveHeapInfo* heap_info) {
1668 // Print statistics of all the regions
1669 const size_t bitmap_used = mapinfo->region_at(MetaspaceShared::bm)->used();
1670 const size_t bitmap_reserved = mapinfo->region_at(MetaspaceShared::bm)->used_aligned();
1671 const size_t total_reserved = _ro_region.reserved() + _rw_region.reserved() +
1672 bitmap_reserved +
1673 _total_heap_region_size;
1674 const size_t total_bytes = _ro_region.used() + _rw_region.used() +
1675 bitmap_used +
1676 _total_heap_region_size;
1677 const double total_u_perc = percent_of(total_bytes, total_reserved);
1678
1679 _rw_region.print(total_reserved);
1680 _ro_region.print(total_reserved);
1681 _ac_region.print(total_reserved);
1682
1683 print_bitmap_region_stats(bitmap_used, total_reserved);
1684
1685 if (heap_info->is_used()) {
1686 print_heap_region_stats(heap_info, total_reserved);
1687 }
1688
1689 aot_log_debug(aot)("total : %9zu [100.0%% of total] out of %9zu bytes [%5.1f%% used]",
1690 total_bytes, total_reserved, total_u_perc);
1691 }
1692
1693 void ArchiveBuilder::print_bitmap_region_stats(size_t size, size_t total_size) {
1694 aot_log_debug(aot)("bm space: %9zu [ %4.1f%% of total] out of %9zu bytes [100.0%% used]",
1695 size, size/double(total_size)*100.0, size);
1696 }
1697
1698 void ArchiveBuilder::print_heap_region_stats(ArchiveHeapInfo *info, size_t total_size) {
1699 char* start = info->buffer_start();
1700 size_t size = info->buffer_byte_size();
1701 char* top = start + size;
1702 aot_log_debug(aot)("hp space: %9zu [ %4.1f%% of total] out of %9zu bytes [100.0%% used] at " INTPTR_FORMAT,
1703 size, size/double(total_size)*100.0, size, p2i(start));
1704 }
1705
1706 void ArchiveBuilder::report_out_of_space(const char* name, size_t needed_bytes) {
1707 // This is highly unlikely to happen on 64-bits because we have reserved a 4GB space.
1708 // On 32-bit we reserve only 256MB so you could run out of space with 100,000 classes
1709 // or so.
1710 _rw_region.print_out_of_space_msg(name, needed_bytes);
1711 _ro_region.print_out_of_space_msg(name, needed_bytes);
1712
1713 log_error(aot)("Unable to allocate from '%s' region: Please reduce the number of shared classes.", name);
1714 MetaspaceShared::unrecoverable_writing_error();
1715 }