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