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