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/aotMapLogger.hpp"
30 #include "cds/aotMetaspace.hpp"
31 #include "cds/archiveBuilder.hpp"
32 #include "cds/archiveHeapWriter.hpp"
33 #include "cds/archiveUtils.hpp"
34 #include "cds/cdsConfig.hpp"
35 #include "cds/cppVtables.hpp"
36 #include "cds/dumpAllocStats.hpp"
37 #include "cds/dynamicArchive.hpp"
38 #include "cds/finalImageRecipes.hpp"
39 #include "cds/heapShared.hpp"
40 #include "cds/regeneratedClasses.hpp"
41 #include "classfile/classLoader.hpp"
42 #include "classfile/classLoaderDataShared.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 "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/globals_extension.hpp"
65 #include "runtime/javaThread.hpp"
66 #include "runtime/safepointVerifiers.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 _ac_ptrmap(mtClassShared),
190 _rw_src_objs(),
191 _ro_src_objs(),
192 _src_obj_table(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE),
193 _buffered_to_src_table(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE),
194 _total_heap_region_size(0)
195 {
196 _klasses = new (mtClassShared) GrowableArray<Klass*>(4 * K, mtClassShared);
197 _symbols = new (mtClassShared) GrowableArray<Symbol*>(256 * K, mtClassShared);
198 _entropy_seed = 0x12345678;
199 _relocated_ptr_info._num_ptrs = 0;
200 _relocated_ptr_info._num_tagged_ptrs = 0;
201 _relocated_ptr_info._num_nulled_ptrs = 0;
202 assert(_current == nullptr, "must be");
203 _current = this;
204 }
205
206 ArchiveBuilder::~ArchiveBuilder() {
207 assert(_current == this, "must be");
208 _current = nullptr;
209
210 for (int i = 0; i < _symbols->length(); i++) {
211 _symbols->at(i)->decrement_refcount();
212 }
213
214 delete _klasses;
215 delete _symbols;
216 if (_shared_rs.is_reserved()) {
217 MemoryReserver::release(_shared_rs);
218 }
219
220 AOTArtifactFinder::dispose();
221 }
222
223 // Returns a deterministic sequence of pseudo random numbers. The main purpose is NOT
224 // for randomness but to get good entropy for the identity_hash() of archived Symbols,
225 // while keeping the contents of static CDS archives deterministic to ensure
226 // reproducibility of JDK builds.
227 int ArchiveBuilder::entropy() {
228 assert(SafepointSynchronize::is_at_safepoint(), "needed to ensure deterministic sequence");
229 _entropy_seed = os::next_random(_entropy_seed);
230 return static_cast<int>(_entropy_seed);
231 }
232
233 class GatherKlassesAndSymbols : public UniqueMetaspaceClosure {
234 ArchiveBuilder* _builder;
235
236 public:
237 GatherKlassesAndSymbols(ArchiveBuilder* builder) : _builder(builder) {}
238
239 virtual bool do_unique_ref(Ref* ref, bool read_only) {
240 return _builder->gather_klass_and_symbol(ref, read_only);
241 }
242 };
243
244 bool ArchiveBuilder::gather_klass_and_symbol(MetaspaceClosure::Ref* ref, bool read_only) {
245 if (ref->obj() == nullptr) {
246 return false;
247 }
248 if (get_follow_mode(ref) != make_a_copy) {
249 return false;
250 }
251 if (ref->msotype() == MetaspaceObj::ClassType) {
252 Klass* klass = (Klass*)ref->obj();
253 assert(klass->is_klass(), "must be");
254 if (!is_excluded(klass)) {
255 _klasses->append(klass);
256 if (klass->is_hidden()) {
257 assert(klass->is_instance_klass(), "must be");
258 }
259 }
260 } else if (ref->msotype() == MetaspaceObj::SymbolType) {
261 // Make sure the symbol won't be GC'ed while we are dumping the archive.
262 Symbol* sym = (Symbol*)ref->obj();
263 sym->increment_refcount();
264 _symbols->append(sym);
265 }
266
267 return true; // recurse
268 }
269
270 void ArchiveBuilder::gather_klasses_and_symbols() {
271 ResourceMark rm;
272
273 AOTArtifactFinder::initialize();
274 AOTArtifactFinder::find_artifacts();
275
276 aot_log_info(aot)("Gathering classes and symbols ... ");
277 GatherKlassesAndSymbols doit(this);
278 iterate_roots(&doit);
279 #if INCLUDE_CDS_JAVA_HEAP
280 if (CDSConfig::is_dumping_full_module_graph()) {
281 ClassLoaderDataShared::iterate_symbols(&doit);
282 }
283 #endif
284 doit.finish();
285
286 if (CDSConfig::is_dumping_static_archive()) {
287 // To ensure deterministic contents in the static archive, we need to ensure that
288 // we iterate the MetaspaceObjs in a deterministic order. It doesn't matter where
289 // the MetaspaceObjs are located originally, as they are copied sequentially into
290 // the archive during the iteration.
291 //
292 // The only issue here is that the symbol table and the system directories may be
293 // randomly ordered, so we copy the symbols and klasses into two arrays and sort
294 // them deterministically.
295 //
296 // During -Xshare:dump, the order of Symbol creation is strictly determined by
297 // the SharedClassListFile (class loading is done in a single thread and the JIT
298 // is disabled). Also, Symbols are allocated in monotonically increasing addresses
299 // (see Symbol::operator new(size_t, int)). So if we iterate the Symbols by
300 // ascending address order, we ensure that all Symbols are copied into deterministic
301 // locations in the archive.
302 //
303 // TODO: in the future, if we want to produce deterministic contents in the
304 // dynamic archive, we might need to sort the symbols alphabetically (also see
305 // DynamicArchiveBuilder::sort_methods()).
306 aot_log_info(aot)("Sorting symbols ... ");
307 _symbols->sort(compare_symbols_by_address);
308 sort_klasses();
309 }
310
311 AOTClassLinker::add_candidates();
312 }
313
314 int ArchiveBuilder::compare_symbols_by_address(Symbol** a, Symbol** b) {
315 if (a[0] < b[0]) {
316 return -1;
317 } else {
318 assert(a[0] > b[0], "Duplicated symbol %s unexpected", (*a)->as_C_string());
319 return 1;
320 }
321 }
322
323 int ArchiveBuilder::compare_klass_by_name(Klass** a, Klass** b) {
324 return a[0]->name()->fast_compare(b[0]->name());
325 }
326
327 void ArchiveBuilder::sort_klasses() {
328 aot_log_info(aot)("Sorting classes ... ");
329 _klasses->sort(compare_klass_by_name);
330 }
331
332 address ArchiveBuilder::reserve_buffer() {
333 // AOTCodeCache::max_aot_code_size() accounts for aot code region.
334 size_t buffer_size = LP64_ONLY(CompressedClassSpaceSize) NOT_LP64(256 * M) + AOTCodeCache::max_aot_code_size();
335 ReservedSpace rs = MemoryReserver::reserve(buffer_size,
336 AOTMetaspace::core_region_alignment(),
337 os::vm_page_size(),
338 mtNone);
339 if (!rs.is_reserved()) {
340 aot_log_error(aot)("Failed to reserve %zu bytes of output buffer.", buffer_size);
341 AOTMetaspace::unrecoverable_writing_error();
342 }
343
344 // buffer_bottom is the lowest address of the 2 core regions (rw, ro) when
345 // we are copying the class metadata into the buffer.
346 address buffer_bottom = (address)rs.base();
347 aot_log_info(aot)("Reserved output buffer space at " PTR_FORMAT " [%zu bytes]",
348 p2i(buffer_bottom), buffer_size);
349 _shared_rs = rs;
350
351 _buffer_bottom = buffer_bottom;
352
353 if (CDSConfig::is_dumping_static_archive()) {
354 _current_dump_region = &_pz_region;
355 } else {
356 _current_dump_region = &_rw_region;
357 }
358 _current_dump_region->init(&_shared_rs, &_shared_vs);
359
360 ArchivePtrMarker::initialize(&_ptrmap, &_shared_vs);
361
362 // The bottom of the static archive should be mapped at this address by default.
363 _requested_static_archive_bottom = (address)AOTMetaspace::requested_base_address();
364
365 // The bottom of the archive (that I am writing now) should be mapped at this address by default.
366 address my_archive_requested_bottom;
367
368 if (CDSConfig::is_dumping_static_archive()) {
369 my_archive_requested_bottom = _requested_static_archive_bottom;
370 } else {
371 _mapped_static_archive_bottom = (address)MetaspaceObj::aot_metaspace_base();
372 _mapped_static_archive_top = (address)MetaspaceObj::aot_metaspace_top();
373 assert(_mapped_static_archive_top >= _mapped_static_archive_bottom, "must be");
374 size_t static_archive_size = _mapped_static_archive_top - _mapped_static_archive_bottom;
375
376 // At run time, we will mmap the dynamic archive at my_archive_requested_bottom
377 _requested_static_archive_top = _requested_static_archive_bottom + static_archive_size;
378 my_archive_requested_bottom = align_up(_requested_static_archive_top, AOTMetaspace::core_region_alignment());
379
380 _requested_dynamic_archive_bottom = my_archive_requested_bottom;
381 }
382
383 _buffer_to_requested_delta = my_archive_requested_bottom - _buffer_bottom;
384
385 address my_archive_requested_top = my_archive_requested_bottom + buffer_size;
386 if (my_archive_requested_bottom < _requested_static_archive_bottom ||
387 my_archive_requested_top <= _requested_static_archive_bottom) {
388 // Size overflow.
389 aot_log_error(aot)("my_archive_requested_bottom = " INTPTR_FORMAT, p2i(my_archive_requested_bottom));
390 aot_log_error(aot)("my_archive_requested_top = " INTPTR_FORMAT, p2i(my_archive_requested_top));
391 aot_log_error(aot)("SharedBaseAddress (" INTPTR_FORMAT ") is too high. "
392 "Please rerun java -Xshare:dump with a lower value", p2i(_requested_static_archive_bottom));
393 AOTMetaspace::unrecoverable_writing_error();
394 }
395
396 if (CDSConfig::is_dumping_static_archive()) {
397 // We don't want any valid object to be at the very bottom of the archive.
398 // See ArchivePtrMarker::mark_pointer().
399 _pz_region.allocate(AOTMetaspace::protection_zone_size());
400 start_dump_region(&_rw_region);
401 }
402
403 return buffer_bottom;
404 }
405
406 void ArchiveBuilder::iterate_sorted_roots(MetaspaceClosure* it) {
407 int num_symbols = _symbols->length();
408 for (int i = 0; i < num_symbols; i++) {
409 it->push(_symbols->adr_at(i));
410 }
411
412 int num_klasses = _klasses->length();
413 for (int i = 0; i < num_klasses; i++) {
414 it->push(_klasses->adr_at(i));
415 }
416
417 iterate_roots(it);
418 }
419
420 class GatherSortedSourceObjs : public MetaspaceClosure {
421 ArchiveBuilder* _builder;
422
423 public:
424 GatherSortedSourceObjs(ArchiveBuilder* builder) : _builder(builder) {}
425
426 virtual bool do_ref(Ref* ref, bool read_only) {
427 return _builder->gather_one_source_obj(ref, read_only);
428 }
429 };
430
431 bool ArchiveBuilder::gather_one_source_obj(MetaspaceClosure::Ref* ref, bool read_only) {
432 address src_obj = ref->obj();
433 if (src_obj == nullptr) {
434 return false;
435 }
436
437 remember_embedded_pointer_in_enclosing_obj(ref);
438 if (RegeneratedClasses::has_been_regenerated(src_obj)) {
439 // No need to copy it. We will later relocate it to point to the regenerated klass/method.
440 return false;
441 }
442
443 FollowMode follow_mode = get_follow_mode(ref);
444 SourceObjInfo src_info(ref, read_only, follow_mode);
445 bool created;
446 SourceObjInfo* p = _src_obj_table.put_if_absent(src_obj, src_info, &created);
447 if (created) {
448 if (_src_obj_table.maybe_grow()) {
449 log_info(aot, hashtables)("Expanded _src_obj_table table to %d", _src_obj_table.table_size());
450 }
451 }
452
453 #ifdef ASSERT
454 if (ref->msotype() == MetaspaceObj::MethodType) {
455 Method* m = (Method*)ref->obj();
456 assert(!RegeneratedClasses::has_been_regenerated((address)m->method_holder()),
457 "Should not archive methods in a class that has been regenerated");
458 }
459 #endif
460
461 if (ref->msotype() == MetaspaceObj::MethodDataType) {
462 MethodData* md = (MethodData*)ref->obj();
463 md->clean_method_data(false /* always_clean */);
464 }
465
466 assert(p->read_only() == src_info.read_only(), "must be");
467
468 if (created && src_info.should_copy()) {
469 if (read_only) {
470 _ro_src_objs.append(p);
471 } else {
472 _rw_src_objs.append(p);
473 }
474 return true; // Need to recurse into this ref only if we are copying it
475 } else {
476 return false;
477 }
478 }
479
480 void ArchiveBuilder::record_regenerated_object(address orig_src_obj, address regen_src_obj) {
481 // Record the fact that orig_src_obj has been replaced by regen_src_obj. All calls to get_buffered_addr(orig_src_obj)
482 // should return the same value as get_buffered_addr(regen_src_obj).
483 SourceObjInfo* p = _src_obj_table.get(regen_src_obj);
484 assert(p != nullptr, "regenerated object should always be dumped");
485 SourceObjInfo orig_src_info(orig_src_obj, p);
486 bool created;
487 _src_obj_table.put_if_absent(orig_src_obj, orig_src_info, &created);
488 assert(created, "We shouldn't have archived the original copy of a regenerated object");
489 }
490
491 // Remember that we have a pointer inside ref->enclosing_obj() that points to ref->obj()
492 void ArchiveBuilder::remember_embedded_pointer_in_enclosing_obj(MetaspaceClosure::Ref* ref) {
493 assert(ref->obj() != nullptr, "should have checked");
494
495 address enclosing_obj = ref->enclosing_obj();
496 if (enclosing_obj == nullptr) {
497 return;
498 }
499
500 // We are dealing with 3 addresses:
501 // address o = ref->obj(): We have found an object whose address is o.
502 // address* mpp = ref->mpp(): The object o is pointed to by a pointer whose address is mpp.
503 // I.e., (*mpp == o)
504 // enclosing_obj : If non-null, it is the object which has a field that points to o.
505 // mpp is the address if that field.
506 //
507 // Example: We have an array whose first element points to a Method:
508 // Method* o = 0x0000abcd;
509 // Array<Method*>* enclosing_obj = 0x00001000;
510 // enclosing_obj->at_put(0, o);
511 //
512 // We the MetaspaceClosure iterates on the very first element of this array, we have
513 // ref->obj() == 0x0000abcd (the Method)
514 // ref->mpp() == 0x00001008 (the location of the first element in the array)
515 // ref->enclosing_obj() == 0x00001000 (the Array that contains the Method)
516 //
517 // We use the above information to mark the bitmap to indicate that there's a pointer on address 0x00001008.
518 SourceObjInfo* src_info = _src_obj_table.get(enclosing_obj);
519 if (src_info == nullptr || !src_info->should_copy()) {
520 // source objects of point_to_it/set_to_null types are not copied
521 // so we don't need to remember their pointers.
522 } else {
523 if (src_info->read_only()) {
524 _ro_src_objs.remember_embedded_pointer(src_info, ref);
525 } else {
526 _rw_src_objs.remember_embedded_pointer(src_info, ref);
527 }
528 }
529 }
530
531 void ArchiveBuilder::gather_source_objs() {
532 ResourceMark rm;
533 aot_log_info(aot)("Gathering all archivable objects ... ");
534 gather_klasses_and_symbols();
535 GatherSortedSourceObjs doit(this);
536 iterate_sorted_roots(&doit);
537 doit.finish();
538 }
539
540 bool ArchiveBuilder::is_excluded(Klass* klass) {
541 if (klass->is_instance_klass()) {
542 InstanceKlass* ik = InstanceKlass::cast(klass);
543 return SystemDictionaryShared::is_excluded_class(ik);
544 } else if (klass->is_objArray_klass()) {
545 Klass* bottom = ObjArrayKlass::cast(klass)->bottom_klass();
546 if (CDSConfig::is_dumping_dynamic_archive() && AOTMetaspace::in_aot_cache_static_region(bottom)) {
547 // The bottom class is in the static archive so it's clearly not excluded.
548 return false;
549 } else if (bottom->is_instance_klass()) {
550 return SystemDictionaryShared::is_excluded_class(InstanceKlass::cast(bottom));
551 }
552 }
553
554 return false;
555 }
556
557 ArchiveBuilder::FollowMode ArchiveBuilder::get_follow_mode(MetaspaceClosure::Ref *ref) {
558 address obj = ref->obj();
559 if (CDSConfig::is_dumping_dynamic_archive() && AOTMetaspace::in_aot_cache(obj)) {
560 // Don't dump existing shared metadata again.
561 return point_to_it;
562 } else if (ref->msotype() == MetaspaceObj::MethodDataType ||
563 ref->msotype() == MetaspaceObj::MethodCountersType ||
564 ref->msotype() == MetaspaceObj::KlassTrainingDataType ||
565 ref->msotype() == MetaspaceObj::MethodTrainingDataType ||
566 ref->msotype() == MetaspaceObj::CompileTrainingDataType) {
567 return (TrainingData::need_data() || TrainingData::assembling_data()) ? make_a_copy : set_to_null;
568 } else if (ref->msotype() == MetaspaceObj::AdapterHandlerEntryType) {
569 return CDSConfig::is_dumping_adapters() ? make_a_copy : set_to_null;
570 } else {
571 if (ref->msotype() == MetaspaceObj::ClassType) {
572 Klass* klass = (Klass*)ref->obj();
573 assert(klass->is_klass(), "must be");
574 if (RegeneratedClasses::has_been_regenerated(klass)) {
575 klass = RegeneratedClasses::get_regenerated_object(klass);
576 }
577 if (is_excluded(klass)) {
578 ResourceMark rm;
579 log_debug(cds, dynamic)("Skipping class (excluded): %s", klass->external_name());
580 return set_to_null;
581 }
582 }
583
584 return make_a_copy;
585 }
586 }
587
588 void ArchiveBuilder::start_dump_region(DumpRegion* next) {
589 current_dump_region()->pack(next);
590 _current_dump_region = next;
591 }
592
593 char* ArchiveBuilder::ro_strdup(const char* s) {
594 char* archived_str = ro_region_alloc((int)strlen(s) + 1);
595 strcpy(archived_str, s);
596 return archived_str;
597 }
598
599 // The objects that have embedded pointers will sink
600 // towards the end of the list. This ensures we have a maximum
601 // number of leading zero bits in the relocation bitmap.
602 int ArchiveBuilder::compare_src_objs(SourceObjInfo** a, SourceObjInfo** b) {
603 if ((*a)->has_embedded_pointer() && !(*b)->has_embedded_pointer()) {
604 return 1;
605 } else if (!(*a)->has_embedded_pointer() && (*b)->has_embedded_pointer()) {
606 return -1;
607 } else {
608 // This is necessary to keep the sorting order stable. Otherwise the
609 // archive's contents may not be deterministic.
610 return (*a)->id() - (*b)->id();
611 }
612 }
613
614 void ArchiveBuilder::sort_metadata_objs() {
615 _rw_src_objs.objs()->sort(compare_src_objs);
616 _ro_src_objs.objs()->sort(compare_src_objs);
617 }
618
619 void ArchiveBuilder::dump_rw_metadata() {
620 ResourceMark rm;
621 aot_log_info(aot)("Allocating RW objects ... ");
622 make_shallow_copies(&_rw_region, &_rw_src_objs);
623
624 #if INCLUDE_CDS_JAVA_HEAP
625 if (CDSConfig::is_dumping_full_module_graph()) {
626 // Archive the ModuleEntry's and PackageEntry's of the 3 built-in loaders
627 char* start = rw_region()->top();
628 ClassLoaderDataShared::allocate_archived_tables();
629 alloc_stats()->record_modules(rw_region()->top() - start, /*read_only*/false);
630 }
631 #endif
632 }
633
634 void ArchiveBuilder::dump_ro_metadata() {
635 ResourceMark rm;
636 aot_log_info(aot)("Allocating RO objects ... ");
637
638 start_dump_region(&_ro_region);
639 make_shallow_copies(&_ro_region, &_ro_src_objs);
640
641 #if INCLUDE_CDS_JAVA_HEAP
642 if (CDSConfig::is_dumping_full_module_graph()) {
643 char* start = ro_region()->top();
644 ClassLoaderDataShared::init_archived_tables();
645 alloc_stats()->record_modules(ro_region()->top() - start, /*read_only*/true);
646 }
647 #endif
648
649 RegeneratedClasses::record_regenerated_objects();
650 }
651
652 void ArchiveBuilder::make_shallow_copies(DumpRegion *dump_region,
653 const ArchiveBuilder::SourceObjList* src_objs) {
654 for (int i = 0; i < src_objs->objs()->length(); i++) {
655 make_shallow_copy(dump_region, src_objs->objs()->at(i));
656 }
657 aot_log_info(aot)("done (%d objects)", src_objs->objs()->length());
658 }
659
660 void ArchiveBuilder::make_shallow_copy(DumpRegion *dump_region, SourceObjInfo* src_info) {
661 address src = src_info->source_addr();
662 int bytes = src_info->size_in_bytes();
663 char* dest;
664 char* oldtop;
665 char* newtop;
666
667 oldtop = dump_region->top();
668 if (src_info->msotype() == MetaspaceObj::ClassType) {
669 // Allocate space for a pointer directly in front of the future InstanceKlass, so
670 // we can do a quick lookup from InstanceKlass* -> RunTimeClassInfo*
671 // without building another hashtable. See RunTimeClassInfo::get_for()
672 // in systemDictionaryShared.cpp.
673 Klass* klass = (Klass*)src;
674 if (klass->is_instance_klass()) {
675 SystemDictionaryShared::validate_before_archiving(InstanceKlass::cast(klass));
676 dump_region->allocate(sizeof(address));
677 }
678 // Allocate space for the future InstanceKlass with proper alignment
679 const size_t alignment =
680 #ifdef _LP64
681 UseCompressedClassPointers ?
682 nth_bit(ArchiveBuilder::precomputed_narrow_klass_shift()) :
683 SharedSpaceObjectAlignment;
684 #else
685 SharedSpaceObjectAlignment;
686 #endif
687 dest = dump_region->allocate(bytes, alignment);
688 } else {
689 dest = dump_region->allocate(bytes);
690 }
691 newtop = dump_region->top();
692
693 memcpy(dest, src, bytes);
694
695 // Update the hash of buffered sorted symbols for static dump so that the symbols have deterministic contents
696 if (CDSConfig::is_dumping_static_archive() && (src_info->msotype() == MetaspaceObj::SymbolType)) {
697 Symbol* buffered_symbol = (Symbol*)dest;
698 assert(((Symbol*)src)->is_permanent(), "archived symbols must be permanent");
699 buffered_symbol->update_identity_hash();
700 }
701
702 {
703 bool created;
704 _buffered_to_src_table.put_if_absent((address)dest, src, &created);
705 assert(created, "must be");
706 if (_buffered_to_src_table.maybe_grow()) {
707 log_info(aot, hashtables)("Expanded _buffered_to_src_table table to %d", _buffered_to_src_table.table_size());
708 }
709 }
710
711 intptr_t* archived_vtable = CppVtables::get_archived_vtable(src_info->msotype(), (address)dest);
712 if (archived_vtable != nullptr) {
713 *(address*)dest = (address)archived_vtable;
714 ArchivePtrMarker::mark_pointer((address*)dest);
715 }
716
717 log_trace(aot)("Copy: " PTR_FORMAT " ==> " PTR_FORMAT " %d", p2i(src), p2i(dest), bytes);
718 src_info->set_buffered_addr((address)dest);
719
720 _alloc_stats.record(src_info->msotype(), int(newtop - oldtop), src_info->read_only());
721
722 DEBUG_ONLY(_alloc_stats.verify((int)dump_region->used(), src_info->read_only()));
723 }
724
725 // This is used by code that hand-assembles data structures, such as the LambdaProxyClassKey, that are
726 // not handled by MetaspaceClosure.
727 void ArchiveBuilder::write_pointer_in_buffer(address* ptr_location, address src_addr) {
728 assert(is_in_buffer_space(ptr_location), "must be");
729 if (src_addr == nullptr) {
730 *ptr_location = nullptr;
731 ArchivePtrMarker::clear_pointer(ptr_location);
732 } else {
733 *ptr_location = get_buffered_addr(src_addr);
734 ArchivePtrMarker::mark_pointer(ptr_location);
735 }
736 }
737
738 void ArchiveBuilder::mark_and_relocate_to_buffered_addr(address* ptr_location) {
739 assert(*ptr_location != nullptr, "sanity");
740 if (!is_in_mapped_static_archive(*ptr_location)) {
741 *ptr_location = get_buffered_addr(*ptr_location);
742 }
743 ArchivePtrMarker::mark_pointer(ptr_location);
744 }
745
746 bool ArchiveBuilder::has_been_archived(address src_addr) const {
747 SourceObjInfo* p = _src_obj_table.get(src_addr);
748 if (p == nullptr) {
749 // This object has never been seen by ArchiveBuilder
750 return false;
751 }
752 if (p->buffered_addr() == nullptr) {
753 // ArchiveBuilder has seen this object, but decided not to archive it. So
754 // Any reference to this object will be modified to nullptr inside the buffer.
755 assert(p->follow_mode() == set_to_null, "must be");
756 return false;
757 }
758
759 DEBUG_ONLY({
760 // This is a class/method that belongs to one of the "original" classes that
761 // have been regenerated by lambdaFormInvokers.cpp. We must have archived
762 // the "regenerated" version of it.
763 if (RegeneratedClasses::has_been_regenerated(src_addr)) {
764 address regen_obj = RegeneratedClasses::get_regenerated_object(src_addr);
765 precond(regen_obj != nullptr && regen_obj != src_addr);
766 assert(has_been_archived(regen_obj), "must be");
767 assert(get_buffered_addr(src_addr) == get_buffered_addr(regen_obj), "must be");
768 }});
769
770 return true;
771 }
772
773 address ArchiveBuilder::get_buffered_addr(address src_addr) const {
774 SourceObjInfo* p = _src_obj_table.get(src_addr);
775 assert(p != nullptr, "src_addr " INTPTR_FORMAT " is used but has not been archived",
776 p2i(src_addr));
777
778 return p->buffered_addr();
779 }
780
781 address ArchiveBuilder::get_source_addr(address buffered_addr) const {
782 assert(is_in_buffer_space(buffered_addr), "must be");
783 address* src_p = _buffered_to_src_table.get(buffered_addr);
784 assert(src_p != nullptr && *src_p != nullptr, "must be");
785 return *src_p;
786 }
787
788 void ArchiveBuilder::relocate_embedded_pointers(ArchiveBuilder::SourceObjList* src_objs) {
789 for (int i = 0; i < src_objs->objs()->length(); i++) {
790 src_objs->relocate(i, this);
791 }
792 }
793
794 void ArchiveBuilder::relocate_metaspaceobj_embedded_pointers() {
795 aot_log_info(aot)("Relocating embedded pointers in core regions ... ");
796 relocate_embedded_pointers(&_rw_src_objs);
797 relocate_embedded_pointers(&_ro_src_objs);
798 log_info(cds)("Relocating %zu pointers, %zu tagged, %zu nulled",
799 _relocated_ptr_info._num_ptrs,
800 _relocated_ptr_info._num_tagged_ptrs,
801 _relocated_ptr_info._num_nulled_ptrs);
802 }
803
804 #define ADD_COUNT(x) \
805 x += 1; \
806 x ## _a += aotlinked ? 1 : 0; \
807 x ## _i += inited ? 1 : 0;
808
809 #define DECLARE_INSTANCE_KLASS_COUNTER(x) \
810 int x = 0; \
811 int x ## _a = 0; \
812 int x ## _i = 0;
813
814 void ArchiveBuilder::make_klasses_shareable() {
815 DECLARE_INSTANCE_KLASS_COUNTER(num_instance_klasses);
816 DECLARE_INSTANCE_KLASS_COUNTER(num_boot_klasses);
817 DECLARE_INSTANCE_KLASS_COUNTER(num_vm_klasses);
818 DECLARE_INSTANCE_KLASS_COUNTER(num_platform_klasses);
819 DECLARE_INSTANCE_KLASS_COUNTER(num_app_klasses);
820 DECLARE_INSTANCE_KLASS_COUNTER(num_old_klasses);
821 DECLARE_INSTANCE_KLASS_COUNTER(num_hidden_klasses);
822 DECLARE_INSTANCE_KLASS_COUNTER(num_enum_klasses);
823 DECLARE_INSTANCE_KLASS_COUNTER(num_unregistered_klasses);
824 int num_unlinked_klasses = 0;
825 int num_obj_array_klasses = 0;
826 int num_type_array_klasses = 0;
827
828 int boot_unlinked = 0;
829 int platform_unlinked = 0;
830 int app_unlinked = 0;
831 int unreg_unlinked = 0;
832
833 for (int i = 0; i < klasses()->length(); i++) {
834 // Some of the code in ConstantPool::remove_unshareable_info() requires the classes
835 // to be in linked state, so it must be call here before the next loop, which returns
836 // all classes to unlinked state.
837 Klass* k = get_buffered_addr(klasses()->at(i));
838 if (k->is_instance_klass()) {
839 InstanceKlass::cast(k)->constants()->remove_unshareable_info();
840 }
841 }
842
843 for (int i = 0; i < klasses()->length(); i++) {
844 const char* type;
845 const char* unlinked = "";
846 const char* kind = "";
847 const char* hidden = "";
848 const char* old = "";
849 const char* generated = "";
850 const char* aotlinked_msg = "";
851 const char* inited_msg = "";
852 Klass* k = get_buffered_addr(klasses()->at(i));
853 bool inited = false;
854 k->remove_java_mirror();
855 #ifdef _LP64
856 if (UseCompactObjectHeaders) {
857 Klass* requested_k = to_requested(k);
858 address narrow_klass_base = _requested_static_archive_bottom; // runtime encoding base == runtime mapping start
859 const int narrow_klass_shift = precomputed_narrow_klass_shift();
860 narrowKlass nk = CompressedKlassPointers::encode_not_null_without_asserts(requested_k, narrow_klass_base, narrow_klass_shift);
861 k->set_prototype_header(markWord::prototype().set_narrow_klass(nk));
862 }
863 #endif //_LP64
864 if (k->is_objArray_klass()) {
865 // InstanceKlass and TypeArrayKlass will in turn call remove_unshareable_info
866 // on their array classes.
867 num_obj_array_klasses ++;
868 type = "array";
869 } else if (k->is_typeArray_klass()) {
870 num_type_array_klasses ++;
871 type = "array";
872 k->remove_unshareable_info();
873 } else {
874 assert(k->is_instance_klass(), " must be");
875 InstanceKlass* ik = InstanceKlass::cast(k);
876 InstanceKlass* src_ik = get_source_addr(ik);
877 bool aotlinked = AOTClassLinker::is_candidate(src_ik);
878 inited = ik->has_aot_initialized_mirror();
879 ADD_COUNT(num_instance_klasses);
880 if (ik->is_hidden()) {
881 ADD_COUNT(num_hidden_klasses);
882 hidden = " hidden";
883 oop loader = k->class_loader();
884 if (loader == nullptr) {
885 type = "boot";
886 ADD_COUNT(num_boot_klasses);
887 } else if (loader == SystemDictionary::java_platform_loader()) {
888 type = "plat";
889 ADD_COUNT(num_platform_klasses);
890 } else if (loader == SystemDictionary::java_system_loader()) {
891 type = "app";
892 ADD_COUNT(num_app_klasses);
893 } else {
894 type = "bad";
895 assert(0, "shouldn't happen");
896 }
897 if (CDSConfig::is_dumping_method_handles()) {
898 assert(HeapShared::is_archivable_hidden_klass(ik), "sanity");
899 } else {
900 // Legacy CDS support for lambda proxies
901 CDS_JAVA_HEAP_ONLY(assert(HeapShared::is_lambda_proxy_klass(ik), "sanity");)
902 }
903 } else if (ik->defined_by_boot_loader()) {
904 type = "boot";
905 ADD_COUNT(num_boot_klasses);
906 } else if (ik->defined_by_platform_loader()) {
907 type = "plat";
908 ADD_COUNT(num_platform_klasses);
909 } else if (ik->defined_by_app_loader()) {
910 type = "app";
911 ADD_COUNT(num_app_klasses);
912 } else {
913 assert(ik->defined_by_other_loaders(), "must be");
914 type = "unreg";
915 ADD_COUNT(num_unregistered_klasses);
916 }
917
918 if (AOTClassLinker::is_vm_class(src_ik)) {
919 ADD_COUNT(num_vm_klasses);
920 }
921
922 if (!ik->is_linked()) {
923 num_unlinked_klasses ++;
924 unlinked = " unlinked";
925 if (ik->defined_by_boot_loader()) {
926 boot_unlinked ++;
927 } else if (ik->defined_by_platform_loader()) {
928 platform_unlinked ++;
929 } else if (ik->defined_by_app_loader()) {
930 app_unlinked ++;
931 } else {
932 unreg_unlinked ++;
933 }
934 }
935
936 if (ik->is_interface()) {
937 kind = " interface";
938 } else if (src_ik->is_enum_subclass()) {
939 kind = " enum";
940 ADD_COUNT(num_enum_klasses);
941 }
942
943 if (!ik->can_be_verified_at_dumptime()) {
944 ADD_COUNT(num_old_klasses);
945 old = " old";
946 }
947
948 if (ik->is_generated_shared_class()) {
949 generated = " generated";
950 }
951 if (aotlinked) {
952 aotlinked_msg = " aot-linked";
953 }
954 if (inited) {
955 if (InstanceKlass::cast(k)->static_field_size() == 0) {
956 inited_msg = " inited (no static fields)";
957 } else {
958 inited_msg = " inited";
959 }
960 }
961
962 AOTMetaspace::rewrite_nofast_bytecodes_and_calculate_fingerprints(Thread::current(), ik);
963 ik->remove_unshareable_info();
964 }
965
966 if (aot_log_is_enabled(Debug, aot, class)) {
967 ResourceMark rm;
968 aot_log_debug(aot, class)("klasses[%5d] = " PTR_FORMAT " %-5s %s%s%s%s%s%s%s%s", i,
969 p2i(to_requested(k)), type, k->external_name(),
970 kind, hidden, old, unlinked, generated, aotlinked_msg, inited_msg);
971 }
972 }
973
974 #define STATS_FORMAT "= %5d, aot-linked = %5d, inited = %5d"
975 #define STATS_PARAMS(x) num_ ## x, num_ ## x ## _a, num_ ## x ## _i
976
977 aot_log_info(aot)("Number of classes %d", num_instance_klasses + num_obj_array_klasses + num_type_array_klasses);
978 aot_log_info(aot)(" instance classes " STATS_FORMAT, STATS_PARAMS(instance_klasses));
979 aot_log_info(aot)(" boot " STATS_FORMAT, STATS_PARAMS(boot_klasses));
980 aot_log_info(aot)(" vm " STATS_FORMAT, STATS_PARAMS(vm_klasses));
981 aot_log_info(aot)(" platform " STATS_FORMAT, STATS_PARAMS(platform_klasses));
982 aot_log_info(aot)(" app " STATS_FORMAT, STATS_PARAMS(app_klasses));
983 aot_log_info(aot)(" unregistered " STATS_FORMAT, STATS_PARAMS(unregistered_klasses));
984 aot_log_info(aot)(" (enum) " STATS_FORMAT, STATS_PARAMS(enum_klasses));
985 aot_log_info(aot)(" (hidden) " STATS_FORMAT, STATS_PARAMS(hidden_klasses));
986 aot_log_info(aot)(" (old) " STATS_FORMAT, STATS_PARAMS(old_klasses));
987 aot_log_info(aot)(" (unlinked) = %5d, boot = %d, plat = %d, app = %d, unreg = %d",
988 num_unlinked_klasses, boot_unlinked, platform_unlinked, app_unlinked, unreg_unlinked);
989 aot_log_info(aot)(" obj array classes = %5d", num_obj_array_klasses);
990 aot_log_info(aot)(" type array classes = %5d", num_type_array_klasses);
991 aot_log_info(aot)(" symbols = %5d", _symbols->length());
992
993 #undef STATS_FORMAT
994 #undef STATS_PARAMS
995
996 DynamicArchive::make_array_klasses_shareable();
997 }
998
999 void ArchiveBuilder::make_training_data_shareable() {
1000 auto clean_td = [&] (address& src_obj, SourceObjInfo& info) {
1001 if (!is_in_buffer_space(info.buffered_addr())) {
1002 return;
1003 }
1004
1005 if (info.msotype() == MetaspaceObj::KlassTrainingDataType ||
1006 info.msotype() == MetaspaceObj::MethodTrainingDataType ||
1007 info.msotype() == MetaspaceObj::CompileTrainingDataType) {
1008 TrainingData* buffered_td = (TrainingData*)info.buffered_addr();
1009 buffered_td->remove_unshareable_info();
1010 } else if (info.msotype() == MetaspaceObj::MethodDataType) {
1011 MethodData* buffered_mdo = (MethodData*)info.buffered_addr();
1012 buffered_mdo->remove_unshareable_info();
1013 } else if (info.msotype() == MetaspaceObj::MethodCountersType) {
1014 MethodCounters* buffered_mc = (MethodCounters*)info.buffered_addr();
1015 buffered_mc->remove_unshareable_info();
1016 }
1017 };
1018 _src_obj_table.iterate_all(clean_td);
1019 }
1020
1021 void ArchiveBuilder::serialize_dynamic_archivable_items(SerializeClosure* soc) {
1022 SymbolTable::serialize_shared_table_header(soc, false);
1023 SystemDictionaryShared::serialize_dictionary_headers(soc, false);
1024 DynamicArchive::serialize_array_klasses(soc);
1025 AOTLinkedClassBulkLoader::serialize(soc, false);
1026 }
1027
1028 uintx ArchiveBuilder::buffer_to_offset(address p) const {
1029 address requested_p = to_requested(p);
1030 assert(requested_p >= _requested_static_archive_bottom, "must be");
1031 return requested_p - _requested_static_archive_bottom;
1032 }
1033
1034 uintx ArchiveBuilder::any_to_offset(address p) const {
1035 if (is_in_mapped_static_archive(p)) {
1036 assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
1037 return p - _mapped_static_archive_bottom;
1038 }
1039 if (!is_in_buffer_space(p)) {
1040 // p must be a "source" address
1041 p = get_buffered_addr(p);
1042 }
1043 return buffer_to_offset(p);
1044 }
1045
1046 address ArchiveBuilder::offset_to_buffered_address(u4 offset) const {
1047 address requested_addr = _requested_static_archive_bottom + offset;
1048 address buffered_addr = requested_addr - _buffer_to_requested_delta;
1049 assert(is_in_buffer_space(buffered_addr), "bad offset");
1050 return buffered_addr;
1051 }
1052
1053 void ArchiveBuilder::start_ac_region() {
1054 ro_region()->pack();
1055 start_dump_region(&_ac_region);
1056 }
1057
1058 void ArchiveBuilder::end_ac_region() {
1059 _ac_region.pack();
1060 }
1061
1062 #if INCLUDE_CDS_JAVA_HEAP
1063 narrowKlass ArchiveBuilder::get_requested_narrow_klass(Klass* k) {
1064 assert(CDSConfig::is_dumping_heap(), "sanity");
1065 k = get_buffered_klass(k);
1066 Klass* requested_k = to_requested(k);
1067 const int narrow_klass_shift = ArchiveBuilder::precomputed_narrow_klass_shift();
1068 #ifdef ASSERT
1069 const size_t klass_alignment = MAX2(SharedSpaceObjectAlignment, (size_t)nth_bit(narrow_klass_shift));
1070 assert(is_aligned(k, klass_alignment), "Klass " PTR_FORMAT " misaligned.", p2i(k));
1071 #endif
1072 address narrow_klass_base = _requested_static_archive_bottom; // runtime encoding base == runtime mapping start
1073 // Note: use the "raw" version of encode that takes explicit narrow klass base and shift. Don't use any
1074 // of the variants that do sanity checks, nor any of those that use the current - dump - JVM's encoding setting.
1075 return CompressedKlassPointers::encode_not_null_without_asserts(requested_k, narrow_klass_base, narrow_klass_shift);
1076 }
1077 #endif // INCLUDE_CDS_JAVA_HEAP
1078
1079 // RelocateBufferToRequested --- Relocate all the pointers in rw/ro,
1080 // so that the archive can be mapped to the "requested" location without runtime relocation.
1081 //
1082 // - See ArchiveBuilder header for the definition of "buffer", "mapped" and "requested"
1083 // - ArchivePtrMarker::ptrmap() marks all the pointers in the rw/ro regions
1084 // - Every pointer must have one of the following values:
1085 // [a] nullptr:
1086 // No relocation is needed. Remove this pointer from ptrmap so we don't need to
1087 // consider it at runtime.
1088 // [b] Points into an object X which is inside the buffer:
1089 // Adjust this pointer by _buffer_to_requested_delta, so it points to X
1090 // when the archive is mapped at the requested location.
1091 // [c] Points into an object Y which is inside mapped static archive:
1092 // - This happens only during dynamic dump
1093 // - Adjust this pointer by _mapped_to_requested_static_archive_delta,
1094 // so it points to Y when the static archive is mapped at the requested location.
1095 template <bool STATIC_DUMP>
1096 class RelocateBufferToRequested : public BitMapClosure {
1097 ArchiveBuilder* _builder;
1098 address _buffer_bottom;
1099 intx _buffer_to_requested_delta;
1100 intx _mapped_to_requested_static_archive_delta;
1101 size_t _max_non_null_offset;
1102
1103 public:
1104 RelocateBufferToRequested(ArchiveBuilder* builder) {
1105 _builder = builder;
1106 _buffer_bottom = _builder->buffer_bottom();
1107 _buffer_to_requested_delta = builder->buffer_to_requested_delta();
1108 _mapped_to_requested_static_archive_delta = builder->requested_static_archive_bottom() - builder->mapped_static_archive_bottom();
1109 _max_non_null_offset = 0;
1110
1111 address bottom = _builder->buffer_bottom();
1112 address top = _builder->buffer_top();
1113 address new_bottom = bottom + _buffer_to_requested_delta;
1114 address new_top = top + _buffer_to_requested_delta;
1115 aot_log_debug(aot)("Relocating archive from [" INTPTR_FORMAT " - " INTPTR_FORMAT "] to "
1116 "[" INTPTR_FORMAT " - " INTPTR_FORMAT "]",
1117 p2i(bottom), p2i(top),
1118 p2i(new_bottom), p2i(new_top));
1119 }
1120
1121 bool do_bit(size_t offset) {
1122 address* p = (address*)_buffer_bottom + offset;
1123 assert(_builder->is_in_buffer_space(p), "pointer must live in buffer space");
1124
1125 if (*p == nullptr) {
1126 // todo -- clear bit, etc
1127 ArchivePtrMarker::ptrmap()->clear_bit(offset);
1128 } else {
1129 if (STATIC_DUMP) {
1130 assert(_builder->is_in_buffer_space(*p), "old pointer must point inside buffer space");
1131 *p += _buffer_to_requested_delta;
1132 assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
1133 } else {
1134 if (_builder->is_in_buffer_space(*p)) {
1135 *p += _buffer_to_requested_delta;
1136 // assert is in requested dynamic archive
1137 } else {
1138 assert(_builder->is_in_mapped_static_archive(*p), "old pointer must point inside buffer space or mapped static archive");
1139 *p += _mapped_to_requested_static_archive_delta;
1140 assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
1141 }
1142 }
1143 _max_non_null_offset = offset;
1144 }
1145
1146 return true; // keep iterating
1147 }
1148
1149 void doit() {
1150 ArchivePtrMarker::ptrmap()->iterate(this);
1151 ArchivePtrMarker::compact(_max_non_null_offset);
1152 }
1153 };
1154
1155 #ifdef _LP64
1156 int ArchiveBuilder::precomputed_narrow_klass_shift() {
1157 // Legacy Mode:
1158 // We use 32 bits for narrowKlass, which should cover the full 4G Klass range. Shift can be 0.
1159 // CompactObjectHeader Mode:
1160 // narrowKlass is much smaller, and we use the highest possible shift value to later get the maximum
1161 // Klass encoding range.
1162 //
1163 // Note that all of this may change in the future, if we decide to correct the pre-calculated
1164 // narrow Klass IDs at archive load time.
1165 assert(UseCompressedClassPointers, "Only needed for compressed class pointers");
1166 return UseCompactObjectHeaders ? CompressedKlassPointers::max_shift() : 0;
1167 }
1168 #endif // _LP64
1169
1170 void ArchiveBuilder::relocate_to_requested() {
1171 if (!ro_region()->is_packed()) {
1172 ro_region()->pack();
1173 }
1174 size_t my_archive_size = buffer_top() - buffer_bottom();
1175
1176 if (CDSConfig::is_dumping_static_archive()) {
1177 _requested_static_archive_top = _requested_static_archive_bottom + my_archive_size;
1178 RelocateBufferToRequested<true> patcher(this);
1179 patcher.doit();
1180 } else {
1181 assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
1182 _requested_dynamic_archive_top = _requested_dynamic_archive_bottom + my_archive_size;
1183 RelocateBufferToRequested<false> patcher(this);
1184 patcher.doit();
1185 }
1186 }
1187
1188 void ArchiveBuilder::print_stats() {
1189 _alloc_stats.print_stats(int(_ro_region.used()), int(_rw_region.used()));
1190 }
1191
1192 void ArchiveBuilder::write_archive(FileMapInfo* mapinfo, ArchiveHeapInfo* heap_info) {
1193 // Make sure NUM_CDS_REGIONS (exported in cds.h) agrees with
1194 // AOTMetaspace::n_regions (internal to hotspot).
1195 assert(NUM_CDS_REGIONS == AOTMetaspace::n_regions, "sanity");
1196
1197 write_region(mapinfo, AOTMetaspace::rw, &_rw_region, /*read_only=*/false,/*allow_exec=*/false);
1198 write_region(mapinfo, AOTMetaspace::ro, &_ro_region, /*read_only=*/true, /*allow_exec=*/false);
1199 write_region(mapinfo, AOTMetaspace::ac, &_ac_region, /*read_only=*/false,/*allow_exec=*/false);
1200
1201 // Split pointer map into read-write and read-only bitmaps
1202 ArchivePtrMarker::initialize_rw_ro_ac_maps(&_rw_ptrmap, &_ro_ptrmap, &_ac_ptrmap);
1203
1204 size_t bitmap_size_in_bytes;
1205 char* bitmap = mapinfo->write_bitmap_region(ArchivePtrMarker::rw_ptrmap(),
1206 ArchivePtrMarker::ro_ptrmap(),
1207 ArchivePtrMarker::ac_ptrmap(),
1208 heap_info,
1209 bitmap_size_in_bytes);
1210
1211 if (heap_info->is_used()) {
1212 _total_heap_region_size = mapinfo->write_heap_region(heap_info);
1213 }
1214
1215 print_region_stats(mapinfo, heap_info);
1216
1217 mapinfo->set_requested_base((char*)AOTMetaspace::requested_base_address());
1218 mapinfo->set_header_crc(mapinfo->compute_header_crc());
1219 // After this point, we should not write any data into mapinfo->header() since this
1220 // would corrupt its checksum we have calculated before.
1221 mapinfo->write_header();
1222 mapinfo->close();
1223
1224 aot_log_info(aot)("Full module graph = %s", CDSConfig::is_dumping_full_module_graph() ? "enabled" : "disabled");
1225 if (log_is_enabled(Info, aot)) {
1226 print_stats();
1227 }
1228
1229 if (log_is_enabled(Info, aot, map)) {
1230 AOTMapLogger::dumptime_log(this, mapinfo, heap_info, bitmap, bitmap_size_in_bytes);
1231 }
1232 CDS_JAVA_HEAP_ONLY(HeapShared::destroy_archived_object_cache());
1233 FREE_C_HEAP_ARRAY(char, bitmap);
1234 }
1235
1236 void ArchiveBuilder::write_region(FileMapInfo* mapinfo, int region_idx, DumpRegion* dump_region, bool read_only, bool allow_exec) {
1237 mapinfo->write_region(region_idx, dump_region->base(), dump_region->used(), read_only, allow_exec);
1238 }
1239
1240 void ArchiveBuilder::count_relocated_pointer(bool tagged, bool nulled) {
1241 _relocated_ptr_info._num_ptrs ++;
1242 _relocated_ptr_info._num_tagged_ptrs += tagged ? 1 : 0;
1243 _relocated_ptr_info._num_nulled_ptrs += nulled ? 1 : 0;
1244 }
1245
1246 void ArchiveBuilder::print_region_stats(FileMapInfo *mapinfo, ArchiveHeapInfo* heap_info) {
1247 // Print statistics of all the regions
1248 const size_t bitmap_used = mapinfo->region_at(AOTMetaspace::bm)->used();
1249 const size_t bitmap_reserved = mapinfo->region_at(AOTMetaspace::bm)->used_aligned();
1250 const size_t total_reserved = _ro_region.reserved() + _rw_region.reserved() +
1251 bitmap_reserved +
1252 _total_heap_region_size;
1253 const size_t total_bytes = _ro_region.used() + _rw_region.used() +
1254 bitmap_used +
1255 _total_heap_region_size;
1256 const double total_u_perc = percent_of(total_bytes, total_reserved);
1257
1258 _rw_region.print(total_reserved);
1259 _ro_region.print(total_reserved);
1260 _ac_region.print(total_reserved);
1261
1262 print_bitmap_region_stats(bitmap_used, total_reserved);
1263
1264 if (heap_info->is_used()) {
1265 print_heap_region_stats(heap_info, total_reserved);
1266 }
1267
1268 aot_log_debug(aot)("total : %9zu [100.0%% of total] out of %9zu bytes [%5.1f%% used]",
1269 total_bytes, total_reserved, total_u_perc);
1270 }
1271
1272 void ArchiveBuilder::print_bitmap_region_stats(size_t size, size_t total_size) {
1273 aot_log_debug(aot)("bm space: %9zu [ %4.1f%% of total] out of %9zu bytes [100.0%% used]",
1274 size, size/double(total_size)*100.0, size);
1275 }
1276
1277 void ArchiveBuilder::print_heap_region_stats(ArchiveHeapInfo *info, size_t total_size) {
1278 char* start = info->buffer_start();
1279 size_t size = info->buffer_byte_size();
1280 char* top = start + size;
1281 aot_log_debug(aot)("hp space: %9zu [ %4.1f%% of total] out of %9zu bytes [100.0%% used] at " INTPTR_FORMAT,
1282 size, size/double(total_size)*100.0, size, p2i(start));
1283 }
1284
1285 void ArchiveBuilder::report_out_of_space(const char* name, size_t needed_bytes) {
1286 // This is highly unlikely to happen on 64-bits because we have reserved a 4GB space.
1287 // On 32-bit we reserve only 256MB so you could run out of space with 100,000 classes
1288 // or so.
1289 _rw_region.print_out_of_space_msg(name, needed_bytes);
1290 _ro_region.print_out_of_space_msg(name, needed_bytes);
1291
1292 log_error(aot)("Unable to allocate from '%s' region: Please reduce the number of shared classes.", name);
1293 AOTMetaspace::unrecoverable_writing_error();
1294 }