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