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