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