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/SCCache.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 _cc_region("cc", MAX_SHARED_DELTA),
186 _ptrmap(mtClassShared),
187 _rw_ptrmap(mtClassShared),
188 _ro_ptrmap(mtClassShared),
189 _cc_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 // SCCache::max_aot_code_size() accounts for cached code region.
334 size_t buffer_size = LP64_ONLY(CompressedClassSpaceSize) NOT_LP64(256 * M) + SCCache::max_aot_code_size();
335 ReservedSpace rs = MemoryReserver::reserve(buffer_size,
336 MetaspaceShared::core_region_alignment(),
337 os::vm_page_size());
338 if (!rs.is_reserved()) {
339 log_error(cds)("Failed to reserve %zu bytes of output buffer.", buffer_size);
340 MetaspaceShared::unrecoverable_writing_error();
341 }
342
343 // buffer_bottom is the lowest address of the 2 core regions (rw, ro) when
344 // we are copying the class metadata into the buffer.
345 address buffer_bottom = (address)rs.base();
346 log_info(cds)("Reserved output buffer space at " PTR_FORMAT " [%zu bytes]",
347 p2i(buffer_bottom), buffer_size);
348 _shared_rs = rs;
349
350 _buffer_bottom = buffer_bottom;
351
352 if (CDSConfig::is_dumping_static_archive()) {
353 _current_dump_region = &_pz_region;
354 } else {
355 _current_dump_region = &_rw_region;
356 }
357 _current_dump_region->init(&_shared_rs, &_shared_vs);
358
359 ArchivePtrMarker::initialize(&_ptrmap, &_shared_vs);
360
361 // The bottom of the static archive should be mapped at this address by default.
362 _requested_static_archive_bottom = (address)MetaspaceShared::requested_base_address();
363
364 // The bottom of the archive (that I am writing now) should be mapped at this address by default.
365 address my_archive_requested_bottom;
366
367 if (CDSConfig::is_dumping_static_archive()) {
368 my_archive_requested_bottom = _requested_static_archive_bottom;
369 } else {
370 _mapped_static_archive_bottom = (address)MetaspaceObj::shared_metaspace_base();
371 _mapped_static_archive_top = (address)MetaspaceObj::shared_metaspace_top();
372 assert(_mapped_static_archive_top >= _mapped_static_archive_bottom, "must be");
373 size_t static_archive_size = _mapped_static_archive_top - _mapped_static_archive_bottom;
374
375 // At run time, we will mmap the dynamic archive at my_archive_requested_bottom
376 _requested_static_archive_top = _requested_static_archive_bottom + static_archive_size;
377 my_archive_requested_bottom = align_up(_requested_static_archive_top, MetaspaceShared::core_region_alignment());
378
379 _requested_dynamic_archive_bottom = my_archive_requested_bottom;
380 }
381
382 _buffer_to_requested_delta = my_archive_requested_bottom - _buffer_bottom;
383
384 address my_archive_requested_top = my_archive_requested_bottom + buffer_size;
385 if (my_archive_requested_bottom < _requested_static_archive_bottom ||
386 my_archive_requested_top <= _requested_static_archive_bottom) {
387 // Size overflow.
388 log_error(cds)("my_archive_requested_bottom = " INTPTR_FORMAT, p2i(my_archive_requested_bottom));
389 log_error(cds)("my_archive_requested_top = " INTPTR_FORMAT, p2i(my_archive_requested_top));
390 log_error(cds)("SharedBaseAddress (" INTPTR_FORMAT ") is too high. "
391 "Please rerun java -Xshare:dump with a lower value", p2i(_requested_static_archive_bottom));
392 MetaspaceShared::unrecoverable_writing_error();
393 }
394
395 if (CDSConfig::is_dumping_static_archive()) {
396 // We don't want any valid object to be at the very bottom of the archive.
397 // See ArchivePtrMarker::mark_pointer().
398 _pz_region.allocate(MetaspaceShared::protection_zone_size());
399 start_dump_region(&_rw_region);
400 }
401
402 return buffer_bottom;
403 }
404
405 void ArchiveBuilder::iterate_sorted_roots(MetaspaceClosure* it) {
406 int num_symbols = _symbols->length();
407 for (int i = 0; i < num_symbols; i++) {
408 it->push(_symbols->adr_at(i));
409 }
410
411 int num_klasses = _klasses->length();
412 for (int i = 0; i < num_klasses; i++) {
413 it->push(_klasses->adr_at(i));
414 }
415
416 iterate_roots(it);
417 }
418
419 class GatherSortedSourceObjs : public MetaspaceClosure {
420 ArchiveBuilder* _builder;
421
422 public:
423 GatherSortedSourceObjs(ArchiveBuilder* builder) : _builder(builder) {}
424
425 virtual bool do_ref(Ref* ref, bool read_only) {
426 return _builder->gather_one_source_obj(ref, read_only);
427 }
428 };
429
430 bool ArchiveBuilder::gather_one_source_obj(MetaspaceClosure::Ref* ref, bool read_only) {
431 address src_obj = ref->obj();
432 if (src_obj == nullptr) {
433 return false;
434 }
435
436 remember_embedded_pointer_in_enclosing_obj(ref);
437 if (RegeneratedClasses::has_been_regenerated(src_obj)) {
438 // No need to copy it. We will later relocate it to point to the regenerated klass/method.
439 return false;
440 }
441
442 FollowMode follow_mode = get_follow_mode(ref);
443 SourceObjInfo src_info(ref, read_only, follow_mode);
444 bool created;
445 SourceObjInfo* p = _src_obj_table.put_if_absent(src_obj, src_info, &created);
446 if (created) {
447 if (_src_obj_table.maybe_grow()) {
448 log_info(cds, hashtables)("Expanded _src_obj_table table to %d", _src_obj_table.table_size());
449 }
450 }
451
452 #ifdef ASSERT
453 if (ref->msotype() == MetaspaceObj::MethodType) {
454 Method* m = (Method*)ref->obj();
455 assert(!RegeneratedClasses::has_been_regenerated((address)m->method_holder()),
456 "Should not archive methods in a class that has been regenerated");
457 }
458 #endif
459
460 if (ref->msotype() == MetaspaceObj::MethodDataType) {
461 MethodData* md = (MethodData*)ref->obj();
462 md->clean_method_data(false /* always_clean */);
463 }
464
465 assert(p->read_only() == src_info.read_only(), "must be");
466
467 if (created && src_info.should_copy()) {
468 if (read_only) {
469 _ro_src_objs.append(p);
470 } else {
471 _rw_src_objs.append(p);
472 }
473 return true; // Need to recurse into this ref only if we are copying it
474 } else {
475 return false;
476 }
477 }
478
479 void ArchiveBuilder::record_regenerated_object(address orig_src_obj, address regen_src_obj) {
480 // Record the fact that orig_src_obj has been replaced by regen_src_obj. All calls to get_buffered_addr(orig_src_obj)
481 // should return the same value as get_buffered_addr(regen_src_obj).
482 SourceObjInfo* p = _src_obj_table.get(regen_src_obj);
483 assert(p != nullptr, "regenerated object should always be dumped");
484 SourceObjInfo orig_src_info(orig_src_obj, p);
485 bool created;
486 _src_obj_table.put_if_absent(orig_src_obj, orig_src_info, &created);
487 assert(created, "We shouldn't have archived the original copy of a regenerated object");
488 }
489
490 // Remember that we have a pointer inside ref->enclosing_obj() that points to ref->obj()
491 void ArchiveBuilder::remember_embedded_pointer_in_enclosing_obj(MetaspaceClosure::Ref* ref) {
492 assert(ref->obj() != nullptr, "should have checked");
493
494 address enclosing_obj = ref->enclosing_obj();
495 if (enclosing_obj == nullptr) {
496 return;
497 }
498
499 // We are dealing with 3 addresses:
500 // address o = ref->obj(): We have found an object whose address is o.
501 // address* mpp = ref->mpp(): The object o is pointed to by a pointer whose address is mpp.
502 // I.e., (*mpp == o)
503 // enclosing_obj : If non-null, it is the object which has a field that points to o.
504 // mpp is the address if that field.
505 //
506 // Example: We have an array whose first element points to a Method:
507 // Method* o = 0x0000abcd;
508 // Array<Method*>* enclosing_obj = 0x00001000;
509 // enclosing_obj->at_put(0, o);
510 //
511 // We the MetaspaceClosure iterates on the very first element of this array, we have
512 // ref->obj() == 0x0000abcd (the Method)
513 // ref->mpp() == 0x00001008 (the location of the first element in the array)
514 // ref->enclosing_obj() == 0x00001000 (the Array that contains the Method)
515 //
516 // We use the above information to mark the bitmap to indicate that there's a pointer on address 0x00001008.
517 SourceObjInfo* src_info = _src_obj_table.get(enclosing_obj);
518 if (src_info == nullptr || !src_info->should_copy()) {
519 // source objects of point_to_it/set_to_null types are not copied
520 // so we don't need to remember their pointers.
521 } else {
522 if (src_info->read_only()) {
523 _ro_src_objs.remember_embedded_pointer(src_info, ref);
524 } else {
525 _rw_src_objs.remember_embedded_pointer(src_info, ref);
526 }
527 }
528 }
529
530 void ArchiveBuilder::gather_source_objs() {
531 ResourceMark rm;
532 log_info(cds)("Gathering all archivable objects ... ");
533 gather_klasses_and_symbols();
534 GatherSortedSourceObjs doit(this);
535 iterate_sorted_roots(&doit);
536 doit.finish();
537 }
538
539 bool ArchiveBuilder::is_excluded(Klass* klass) {
540 if (klass->is_instance_klass()) {
541 InstanceKlass* ik = InstanceKlass::cast(klass);
542 return SystemDictionaryShared::is_excluded_class(ik);
543 } else if (klass->is_objArray_klass()) {
544 Klass* bottom = ObjArrayKlass::cast(klass)->bottom_klass();
545 if (CDSConfig::is_dumping_dynamic_archive() && MetaspaceShared::is_shared_static(bottom)) {
546 // The bottom class is in the static archive so it's clearly not excluded.
547 return false;
548 } else if (bottom->is_instance_klass()) {
549 return SystemDictionaryShared::is_excluded_class(InstanceKlass::cast(bottom));
550 }
551 }
552
553 return false;
554 }
555
556 ArchiveBuilder::FollowMode ArchiveBuilder::get_follow_mode(MetaspaceClosure::Ref *ref) {
557 address obj = ref->obj();
558 if (CDSConfig::is_dumping_dynamic_archive() && MetaspaceShared::is_in_shared_metaspace(obj)) {
559 // Don't dump existing shared metadata again.
560 return point_to_it;
561 } else if (ref->msotype() == MetaspaceObj::MethodDataType ||
562 ref->msotype() == MetaspaceObj::MethodCountersType ||
563 ref->msotype() == MetaspaceObj::KlassTrainingDataType ||
564 ref->msotype() == MetaspaceObj::MethodTrainingDataType ||
565 ref->msotype() == MetaspaceObj::CompileTrainingDataType) {
566 return TrainingData::need_data() ? make_a_copy : set_to_null;
567 } else if (ref->msotype() == MetaspaceObj::AdapterHandlerEntryType) {
568 if (CDSConfig::is_dumping_adapters()) {
569 AdapterHandlerEntry* entry = (AdapterHandlerEntry*)ref->obj();
570 return AdapterHandlerLibrary::is_abstract_method_adapter(entry) ? set_to_null : make_a_copy;
571 } else {
572 return set_to_null;
573 }
574 } else {
575 if (ref->msotype() == MetaspaceObj::ClassType) {
576 Klass* klass = (Klass*)ref->obj();
577 assert(klass->is_klass(), "must be");
578 if (is_excluded(klass)) {
579 ResourceMark rm;
580 log_debug(cds, dynamic)("Skipping class (excluded): %s", klass->external_name());
581 return set_to_null;
582 }
583 }
584
585 return make_a_copy;
586 }
587 }
588
589 void ArchiveBuilder::start_dump_region(DumpRegion* next) {
590 current_dump_region()->pack(next);
591 _current_dump_region = next;
592 }
593
594 char* ArchiveBuilder::ro_strdup(const char* s) {
595 char* archived_str = ro_region_alloc((int)strlen(s) + 1);
596 strcpy(archived_str, s);
597 return archived_str;
598 }
599
600 // The objects that have embedded pointers will sink
601 // towards the end of the list. This ensures we have a maximum
602 // number of leading zero bits in the relocation bitmap.
603 int ArchiveBuilder::compare_src_objs(SourceObjInfo** a, SourceObjInfo** b) {
604 if ((*a)->has_embedded_pointer() && !(*b)->has_embedded_pointer()) {
605 return 1;
606 } else if (!(*a)->has_embedded_pointer() && (*b)->has_embedded_pointer()) {
607 return -1;
608 } else {
609 // This is necessary to keep the sorting order stable. Otherwise the
610 // archive's contents may not be deterministic.
611 return (*a)->id() - (*b)->id();
612 }
613 }
614
615 void ArchiveBuilder::sort_metadata_objs() {
616 _rw_src_objs.objs()->sort(compare_src_objs);
617 _ro_src_objs.objs()->sort(compare_src_objs);
618 }
619
620 void ArchiveBuilder::dump_rw_metadata() {
621 ResourceMark rm;
622 log_info(cds)("Allocating RW objects ... ");
623 make_shallow_copies(&_rw_region, &_rw_src_objs);
624
625 #if INCLUDE_CDS_JAVA_HEAP
626 if (CDSConfig::is_dumping_full_module_graph()) {
627 // Archive the ModuleEntry's and PackageEntry's of the 3 built-in loaders
628 char* start = rw_region()->top();
629 ClassLoaderDataShared::allocate_archived_tables();
630 alloc_stats()->record_modules(rw_region()->top() - start, /*read_only*/false);
631 }
632 #endif
633 }
634
635 void ArchiveBuilder::dump_ro_metadata() {
636 ResourceMark rm;
637 log_info(cds)("Allocating RO objects ... ");
638
639 start_dump_region(&_ro_region);
640 make_shallow_copies(&_ro_region, &_ro_src_objs);
641
642 #if INCLUDE_CDS_JAVA_HEAP
643 if (CDSConfig::is_dumping_full_module_graph()) {
644 char* start = ro_region()->top();
645 ClassLoaderDataShared::init_archived_tables();
646 alloc_stats()->record_modules(ro_region()->top() - start, /*read_only*/true);
647 }
648 #endif
649
650 RegeneratedClasses::record_regenerated_objects();
651 }
652
653 void ArchiveBuilder::make_shallow_copies(DumpRegion *dump_region,
654 const ArchiveBuilder::SourceObjList* src_objs) {
655 for (int i = 0; i < src_objs->objs()->length(); i++) {
656 make_shallow_copy(dump_region, src_objs->objs()->at(i));
657 }
658 log_info(cds)("done (%d objects)", src_objs->objs()->length());
659 }
660
661 void ArchiveBuilder::make_shallow_copy(DumpRegion *dump_region, SourceObjInfo* src_info) {
662 address src = src_info->source_addr();
663 int bytes = src_info->size_in_bytes();
664 char* dest;
665 char* oldtop;
666 char* newtop;
667
668 oldtop = dump_region->top();
669 if (src_info->msotype() == MetaspaceObj::ClassType) {
670 // Allocate space for a pointer directly in front of the future InstanceKlass, so
671 // we can do a quick lookup from InstanceKlass* -> RunTimeClassInfo*
672 // without building another hashtable. See RunTimeClassInfo::get_for()
673 // in systemDictionaryShared.cpp.
674 Klass* klass = (Klass*)src;
675 if (klass->is_instance_klass()) {
676 SystemDictionaryShared::validate_before_archiving(InstanceKlass::cast(klass));
677 dump_region->allocate(sizeof(address));
678 }
679 // Allocate space for the future InstanceKlass with proper alignment
680 const size_t alignment =
681 #ifdef _LP64
682 UseCompressedClassPointers ?
683 nth_bit(ArchiveBuilder::precomputed_narrow_klass_shift()) :
684 SharedSpaceObjectAlignment;
685 #else
686 SharedSpaceObjectAlignment;
687 #endif
688 dest = dump_region->allocate(bytes, alignment);
689 } else {
690 dest = dump_region->allocate(bytes);
691 }
692 newtop = dump_region->top();
693
694 memcpy(dest, src, bytes);
695
696 // Update the hash of buffered sorted symbols for static dump so that the symbols have deterministic contents
697 if (CDSConfig::is_dumping_static_archive() && (src_info->msotype() == MetaspaceObj::SymbolType)) {
698 Symbol* buffered_symbol = (Symbol*)dest;
699 assert(((Symbol*)src)->is_permanent(), "archived symbols must be permanent");
700 buffered_symbol->update_identity_hash();
701 }
702
703 {
704 bool created;
705 _buffered_to_src_table.put_if_absent((address)dest, src, &created);
706 assert(created, "must be");
707 if (_buffered_to_src_table.maybe_grow()) {
708 log_info(cds, hashtables)("Expanded _buffered_to_src_table table to %d", _buffered_to_src_table.table_size());
709 }
710 }
711
712 intptr_t* archived_vtable = CppVtables::get_archived_vtable(src_info->msotype(), (address)dest);
713 if (archived_vtable != nullptr) {
714 *(address*)dest = (address)archived_vtable;
715 ArchivePtrMarker::mark_pointer((address*)dest);
716 }
717
718 log_trace(cds)("Copy: " PTR_FORMAT " ==> " PTR_FORMAT " %d", p2i(src), p2i(dest), bytes);
719 src_info->set_buffered_addr((address)dest);
720
721 _alloc_stats.record(src_info->msotype(), int(newtop - oldtop), src_info->read_only());
722
723 DEBUG_ONLY(_alloc_stats.verify((int)dump_region->used(), src_info->read_only()));
724 }
725
726 // This is used by code that hand-assembles data structures, such as the LambdaProxyClassKey, that are
727 // not handled by MetaspaceClosure.
728 void ArchiveBuilder::write_pointer_in_buffer(address* ptr_location, address src_addr) {
729 assert(is_in_buffer_space(ptr_location), "must be");
730 if (src_addr == nullptr) {
731 *ptr_location = nullptr;
732 ArchivePtrMarker::clear_pointer(ptr_location);
733 } else {
734 *ptr_location = get_buffered_addr(src_addr);
735 ArchivePtrMarker::mark_pointer(ptr_location);
736 }
737 }
738
739 void ArchiveBuilder::mark_and_relocate_to_buffered_addr(address* ptr_location) {
740 assert(*ptr_location != nullptr, "sanity");
741 if (!is_in_mapped_static_archive(*ptr_location)) {
742 *ptr_location = get_buffered_addr(*ptr_location);
743 }
744 ArchivePtrMarker::mark_pointer(ptr_location);
745 }
746
747 bool ArchiveBuilder::has_been_buffered(address src_addr) const {
748 if (RegeneratedClasses::has_been_regenerated(src_addr) ||
749 _src_obj_table.get(src_addr) == nullptr ||
750 get_buffered_addr(src_addr) == nullptr) {
751 return false;
752 } else {
753 return true;
754 }
755 }
756
757 address ArchiveBuilder::get_buffered_addr(address src_addr) const {
758 SourceObjInfo* p = _src_obj_table.get(src_addr);
759 assert(p != nullptr, "src_addr " INTPTR_FORMAT " is used but has not been archived",
760 p2i(src_addr));
761
762 return p->buffered_addr();
763 }
764
765 bool ArchiveBuilder::has_been_archived(address src_addr) const {
766 SourceObjInfo* p = _src_obj_table.get(src_addr);
767 return (p != nullptr);
768 }
769
770 address ArchiveBuilder::get_source_addr(address buffered_addr) const {
771 assert(is_in_buffer_space(buffered_addr), "must be");
772 address* src_p = _buffered_to_src_table.get(buffered_addr);
773 assert(src_p != nullptr && *src_p != nullptr, "must be");
774 return *src_p;
775 }
776
777 void ArchiveBuilder::relocate_embedded_pointers(ArchiveBuilder::SourceObjList* src_objs) {
778 for (int i = 0; i < src_objs->objs()->length(); i++) {
779 src_objs->relocate(i, this);
780 }
781 }
782
783 void ArchiveBuilder::relocate_metaspaceobj_embedded_pointers() {
784 log_info(cds)("Relocating embedded pointers in core regions ... ");
785 relocate_embedded_pointers(&_rw_src_objs);
786 relocate_embedded_pointers(&_ro_src_objs);
787 log_info(cds)("Relocating %zu pointers, %zu tagged, %zu nulled",
788 _relocated_ptr_info._num_ptrs,
789 _relocated_ptr_info._num_tagged_ptrs,
790 _relocated_ptr_info._num_nulled_ptrs);
791 }
792
793 #define ADD_COUNT(x) \
794 x += 1; \
795 x ## _a += aotlinked ? 1 : 0; \
796 x ## _i += inited ? 1 : 0;
797
798 #define DECLARE_INSTANCE_KLASS_COUNTER(x) \
799 int x = 0; \
800 int x ## _a = 0; \
801 int x ## _i = 0;
802
803 void ArchiveBuilder::make_klasses_shareable() {
804 DECLARE_INSTANCE_KLASS_COUNTER(num_instance_klasses);
805 DECLARE_INSTANCE_KLASS_COUNTER(num_boot_klasses);
806 DECLARE_INSTANCE_KLASS_COUNTER(num_vm_klasses);
807 DECLARE_INSTANCE_KLASS_COUNTER(num_platform_klasses);
808 DECLARE_INSTANCE_KLASS_COUNTER(num_app_klasses);
809 DECLARE_INSTANCE_KLASS_COUNTER(num_old_klasses);
810 DECLARE_INSTANCE_KLASS_COUNTER(num_hidden_klasses);
811 DECLARE_INSTANCE_KLASS_COUNTER(num_enum_klasses);
812 DECLARE_INSTANCE_KLASS_COUNTER(num_unregistered_klasses);
813 int num_unlinked_klasses = 0;
814 int num_obj_array_klasses = 0;
815 int num_type_array_klasses = 0;
816
817 int boot_unlinked = 0;
818 int platform_unlinked = 0;
819 int app_unlinked = 0;
820 int unreg_unlinked = 0;
821
822 for (int i = 0; i < klasses()->length(); i++) {
823 // Some of the code in ConstantPool::remove_unshareable_info() requires the classes
824 // to be in linked state, so it must be call here before the next loop, which returns
825 // all classes to unlinked state.
826 Klass* k = get_buffered_addr(klasses()->at(i));
827 if (k->is_instance_klass()) {
828 InstanceKlass::cast(k)->constants()->remove_unshareable_info();
829 }
830 }
831
832 for (int i = 0; i < klasses()->length(); i++) {
833 const char* type;
834 const char* unlinked = "";
835 const char* kind = "";
836 const char* hidden = "";
837 const char* old = "";
838 const char* generated = "";
839 const char* aotlinked_msg = "";
840 const char* inited_msg = "";
841 Klass* k = get_buffered_addr(klasses()->at(i));
842 bool inited = false;
843 k->remove_java_mirror();
844 #ifdef _LP64
845 if (UseCompactObjectHeaders) {
846 Klass* requested_k = to_requested(k);
847 address narrow_klass_base = _requested_static_archive_bottom; // runtime encoding base == runtime mapping start
848 const int narrow_klass_shift = precomputed_narrow_klass_shift();
849 narrowKlass nk = CompressedKlassPointers::encode_not_null_without_asserts(requested_k, narrow_klass_base, narrow_klass_shift);
850 k->set_prototype_header(markWord::prototype().set_narrow_klass(nk));
851 }
852 #endif //_LP64
853 if (k->is_objArray_klass()) {
854 // InstanceKlass and TypeArrayKlass will in turn call remove_unshareable_info
855 // on their array classes.
856 num_obj_array_klasses ++;
857 type = "array";
858 } else if (k->is_typeArray_klass()) {
859 num_type_array_klasses ++;
860 type = "array";
861 k->remove_unshareable_info();
862 } else {
863 assert(k->is_instance_klass(), " must be");
864 InstanceKlass* ik = InstanceKlass::cast(k);
865 InstanceKlass* src_ik = get_source_addr(ik);
866 bool aotlinked = AOTClassLinker::is_candidate(src_ik);
867 inited = ik->has_aot_initialized_mirror();
868 ADD_COUNT(num_instance_klasses);
869 if (CDSConfig::is_dumping_dynamic_archive()) {
870 // For static dump, class loader type are already set.
871 ik->assign_class_loader_type();
872 }
873 if (ik->is_hidden()) {
874 ADD_COUNT(num_hidden_klasses);
875 hidden = " hidden";
876 oop loader = k->class_loader();
877 if (loader == nullptr) {
878 type = "boot";
879 ADD_COUNT(num_boot_klasses);
880 } else if (loader == SystemDictionary::java_platform_loader()) {
881 type = "plat";
882 ADD_COUNT(num_platform_klasses);
883 } else if (loader == SystemDictionary::java_system_loader()) {
884 type = "app";
885 ADD_COUNT(num_app_klasses);
886 } else {
887 type = "bad";
888 assert(0, "shouldn't happen");
889 }
890 if (CDSConfig::is_dumping_method_handles()) {
891 assert(HeapShared::is_archivable_hidden_klass(ik), "sanity");
892 } else {
893 // Legacy CDS support for lambda proxies
894 CDS_JAVA_HEAP_ONLY(assert(HeapShared::is_lambda_proxy_klass(ik), "sanity");)
895 }
896 } else if (ik->is_shared_boot_class()) {
897 type = "boot";
898 ADD_COUNT(num_boot_klasses);
899 } else if (ik->is_shared_platform_class()) {
900 type = "plat";
901 ADD_COUNT(num_platform_klasses);
902 } else if (ik->is_shared_app_class()) {
903 type = "app";
904 ADD_COUNT(num_app_klasses);
905 } else {
906 assert(ik->is_shared_unregistered_class(), "must be");
907 type = "unreg";
908 ADD_COUNT(num_unregistered_klasses);
909 }
910
911 if (AOTClassLinker::is_vm_class(src_ik)) {
912 ADD_COUNT(num_vm_klasses);
913 }
914
915 if (!ik->is_linked()) {
916 num_unlinked_klasses ++;
917 unlinked = " unlinked";
918 if (ik->is_shared_boot_class()) {
919 boot_unlinked ++;
920 } else if (ik->is_shared_platform_class()) {
921 platform_unlinked ++;
922 } else if (ik->is_shared_app_class()) {
923 app_unlinked ++;
924 } else {
925 unreg_unlinked ++;
926 }
927 }
928
929 if (ik->is_interface()) {
930 kind = " interface";
931 } else if (src_ik->is_enum_subclass()) {
932 kind = " enum";
933 ADD_COUNT(num_enum_klasses);
934 }
935
936 if (!ik->can_be_verified_at_dumptime()) {
937 ADD_COUNT(num_old_klasses);
938 old = " old";
939 }
940
941 if (ik->is_generated_shared_class()) {
942 generated = " generated";
943 }
944 if (aotlinked) {
945 aotlinked_msg = " aot-linked";
946 }
947 if (inited) {
948 if (InstanceKlass::cast(k)->static_field_size() == 0) {
949 inited_msg = " inited (no static fields)";
950 } else {
951 inited_msg = " inited";
952 }
953 }
954
955 MetaspaceShared::rewrite_nofast_bytecodes_and_calculate_fingerprints(Thread::current(), ik);
956 ik->remove_unshareable_info();
957 }
958
959 if (log_is_enabled(Debug, cds, class)) {
960 ResourceMark rm;
961 log_debug(cds, class)("klasses[%5d] = " PTR_FORMAT " %-5s %s%s%s%s%s%s%s%s", i,
962 p2i(to_requested(k)), type, k->external_name(),
963 kind, hidden, old, unlinked, generated, aotlinked_msg, inited_msg);
964 }
965 }
966
967 #define STATS_FORMAT "= %5d, aot-linked = %5d, inited = %5d"
968 #define STATS_PARAMS(x) num_ ## x, num_ ## x ## _a, num_ ## x ## _i
969
970 log_info(cds)("Number of classes %d", num_instance_klasses + num_obj_array_klasses + num_type_array_klasses);
971 log_info(cds)(" instance classes " STATS_FORMAT, STATS_PARAMS(instance_klasses));
972 log_info(cds)(" boot " STATS_FORMAT, STATS_PARAMS(boot_klasses));
973 log_info(cds)(" vm " STATS_FORMAT, STATS_PARAMS(vm_klasses));
974 log_info(cds)(" platform " STATS_FORMAT, STATS_PARAMS(platform_klasses));
975 log_info(cds)(" app " STATS_FORMAT, STATS_PARAMS(app_klasses));
976 log_info(cds)(" unregistered " STATS_FORMAT, STATS_PARAMS(unregistered_klasses));
977 log_info(cds)(" (enum) " STATS_FORMAT, STATS_PARAMS(enum_klasses));
978 log_info(cds)(" (hidden) " STATS_FORMAT, STATS_PARAMS(hidden_klasses));
979 log_info(cds)(" (old) " STATS_FORMAT, STATS_PARAMS(old_klasses));
980 log_info(cds)(" (unlinked) = %5d, boot = %d, plat = %d, app = %d, unreg = %d",
981 num_unlinked_klasses, boot_unlinked, platform_unlinked, app_unlinked, unreg_unlinked);
982 log_info(cds)(" obj array classes = %5d", num_obj_array_klasses);
983 log_info(cds)(" type array classes = %5d", num_type_array_klasses);
984 log_info(cds)(" symbols = %5d", _symbols->length());
985
986 #undef STATS_FORMAT
987 #undef STATS_PARAMS
988
989 DynamicArchive::make_array_klasses_shareable();
990 }
991
992 void ArchiveBuilder::make_training_data_shareable() {
993 auto clean_td = [&] (address& src_obj, SourceObjInfo& info) {
994 if (!is_in_buffer_space(info.buffered_addr())) {
995 return;
996 }
997
998 if (info.msotype() == MetaspaceObj::KlassTrainingDataType ||
999 info.msotype() == MetaspaceObj::MethodTrainingDataType ||
1000 info.msotype() == MetaspaceObj::CompileTrainingDataType) {
1001 TrainingData* buffered_td = (TrainingData*)info.buffered_addr();
1002 buffered_td->remove_unshareable_info();
1003 } else if (info.msotype() == MetaspaceObj::MethodDataType) {
1004 MethodData* buffered_mdo = (MethodData*)info.buffered_addr();
1005 buffered_mdo->remove_unshareable_info();
1006 } else if (info.msotype() == MetaspaceObj::MethodCountersType) {
1007 MethodCounters* buffered_mc = (MethodCounters*)info.buffered_addr();
1008 buffered_mc->remove_unshareable_info();
1009 }
1010 };
1011 _src_obj_table.iterate_all(clean_td);
1012 }
1013
1014 void ArchiveBuilder::serialize_dynamic_archivable_items(SerializeClosure* soc) {
1015 SymbolTable::serialize_shared_table_header(soc, false);
1016 SystemDictionaryShared::serialize_dictionary_headers(soc, false);
1017 DynamicArchive::serialize_array_klasses(soc);
1018 AOTLinkedClassBulkLoader::serialize(soc, false);
1019 }
1020
1021 uintx ArchiveBuilder::buffer_to_offset(address p) const {
1022 address requested_p = to_requested(p);
1023 assert(requested_p >= _requested_static_archive_bottom, "must be");
1024 return requested_p - _requested_static_archive_bottom;
1025 }
1026
1027 uintx ArchiveBuilder::any_to_offset(address p) const {
1028 if (is_in_mapped_static_archive(p)) {
1029 assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
1030 return p - _mapped_static_archive_bottom;
1031 }
1032 if (!is_in_buffer_space(p)) {
1033 // p must be a "source" address
1034 p = get_buffered_addr(p);
1035 }
1036 return buffer_to_offset(p);
1037 }
1038
1039 void ArchiveBuilder::start_cc_region() {
1040 ro_region()->pack();
1041 start_dump_region(&_cc_region);
1042 }
1043
1044 void ArchiveBuilder::end_cc_region() {
1045 _cc_region.pack();
1046 }
1047
1048 address ArchiveBuilder::offset_to_buffered_address(u4 offset) const {
1049 address requested_addr = _requested_static_archive_bottom + offset;
1050 address buffered_addr = requested_addr - _buffer_to_requested_delta;
1051 assert(is_in_buffer_space(buffered_addr), "bad offset");
1052 return buffered_addr;
1053 }
1054
1055 #if INCLUDE_CDS_JAVA_HEAP
1056 narrowKlass ArchiveBuilder::get_requested_narrow_klass(Klass* k) {
1057 assert(CDSConfig::is_dumping_heap(), "sanity");
1058 k = get_buffered_klass(k);
1059 Klass* requested_k = to_requested(k);
1060 const int narrow_klass_shift = ArchiveBuilder::precomputed_narrow_klass_shift();
1061 #ifdef ASSERT
1062 const size_t klass_alignment = MAX2(SharedSpaceObjectAlignment, (size_t)nth_bit(narrow_klass_shift));
1063 assert(is_aligned(k, klass_alignment), "Klass " PTR_FORMAT " misaligned.", p2i(k));
1064 #endif
1065 address narrow_klass_base = _requested_static_archive_bottom; // runtime encoding base == runtime mapping start
1066 // Note: use the "raw" version of encode that takes explicit narrow klass base and shift. Don't use any
1067 // of the variants that do sanity checks, nor any of those that use the current - dump - JVM's encoding setting.
1068 return CompressedKlassPointers::encode_not_null_without_asserts(requested_k, narrow_klass_base, narrow_klass_shift);
1069 }
1070 #endif // INCLUDE_CDS_JAVA_HEAP
1071
1072 // RelocateBufferToRequested --- Relocate all the pointers in rw/ro,
1073 // so that the archive can be mapped to the "requested" location without runtime relocation.
1074 //
1075 // - See ArchiveBuilder header for the definition of "buffer", "mapped" and "requested"
1076 // - ArchivePtrMarker::ptrmap() marks all the pointers in the rw/ro regions
1077 // - Every pointer must have one of the following values:
1078 // [a] nullptr:
1079 // No relocation is needed. Remove this pointer from ptrmap so we don't need to
1080 // consider it at runtime.
1081 // [b] Points into an object X which is inside the buffer:
1082 // Adjust this pointer by _buffer_to_requested_delta, so it points to X
1083 // when the archive is mapped at the requested location.
1084 // [c] Points into an object Y which is inside mapped static archive:
1085 // - This happens only during dynamic dump
1086 // - Adjust this pointer by _mapped_to_requested_static_archive_delta,
1087 // so it points to Y when the static archive is mapped at the requested location.
1088 template <bool STATIC_DUMP>
1089 class RelocateBufferToRequested : public BitMapClosure {
1090 ArchiveBuilder* _builder;
1091 address _buffer_bottom;
1092 intx _buffer_to_requested_delta;
1093 intx _mapped_to_requested_static_archive_delta;
1094 size_t _max_non_null_offset;
1095
1096 public:
1097 RelocateBufferToRequested(ArchiveBuilder* builder) {
1098 _builder = builder;
1099 _buffer_bottom = _builder->buffer_bottom();
1100 _buffer_to_requested_delta = builder->buffer_to_requested_delta();
1101 _mapped_to_requested_static_archive_delta = builder->requested_static_archive_bottom() - builder->mapped_static_archive_bottom();
1102 _max_non_null_offset = 0;
1103
1104 address bottom = _builder->buffer_bottom();
1105 address top = _builder->buffer_top();
1106 address new_bottom = bottom + _buffer_to_requested_delta;
1107 address new_top = top + _buffer_to_requested_delta;
1108 log_debug(cds)("Relocating archive from [" INTPTR_FORMAT " - " INTPTR_FORMAT "] to "
1109 "[" INTPTR_FORMAT " - " INTPTR_FORMAT "]",
1110 p2i(bottom), p2i(top),
1111 p2i(new_bottom), p2i(new_top));
1112 }
1113
1114 bool do_bit(size_t offset) {
1115 address* p = (address*)_buffer_bottom + offset;
1116 assert(_builder->is_in_buffer_space(p), "pointer must live in buffer space");
1117
1118 if (*p == nullptr) {
1119 // todo -- clear bit, etc
1120 ArchivePtrMarker::ptrmap()->clear_bit(offset);
1121 } else {
1122 if (STATIC_DUMP) {
1123 assert(_builder->is_in_buffer_space(*p), "old pointer must point inside buffer space");
1124 *p += _buffer_to_requested_delta;
1125 assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
1126 } else {
1127 if (_builder->is_in_buffer_space(*p)) {
1128 *p += _buffer_to_requested_delta;
1129 // assert is in requested dynamic archive
1130 } else {
1131 assert(_builder->is_in_mapped_static_archive(*p), "old pointer must point inside buffer space or mapped static archive");
1132 *p += _mapped_to_requested_static_archive_delta;
1133 assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
1134 }
1135 }
1136 _max_non_null_offset = offset;
1137 }
1138
1139 return true; // keep iterating
1140 }
1141
1142 void doit() {
1143 ArchivePtrMarker::ptrmap()->iterate(this);
1144 ArchivePtrMarker::compact(_max_non_null_offset);
1145 }
1146 };
1147
1148 #ifdef _LP64
1149 int ArchiveBuilder::precomputed_narrow_klass_shift() {
1150 // Legacy Mode:
1151 // We use 32 bits for narrowKlass, which should cover the full 4G Klass range. Shift can be 0.
1152 // CompactObjectHeader Mode:
1153 // narrowKlass is much smaller, and we use the highest possible shift value to later get the maximum
1154 // Klass encoding range.
1155 //
1156 // Note that all of this may change in the future, if we decide to correct the pre-calculated
1157 // narrow Klass IDs at archive load time.
1158 assert(UseCompressedClassPointers, "Only needed for compressed class pointers");
1159 return UseCompactObjectHeaders ? CompressedKlassPointers::max_shift() : 0;
1160 }
1161 #endif // _LP64
1162
1163 void ArchiveBuilder::relocate_to_requested() {
1164 if (!ro_region()->is_packed()) {
1165 ro_region()->pack();
1166 }
1167
1168 size_t my_archive_size = buffer_top() - buffer_bottom();
1169
1170 if (CDSConfig::is_dumping_static_archive()) {
1171 _requested_static_archive_top = _requested_static_archive_bottom + my_archive_size;
1172 RelocateBufferToRequested<true> patcher(this);
1173 patcher.doit();
1174 } else {
1175 assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
1176 _requested_dynamic_archive_top = _requested_dynamic_archive_bottom + my_archive_size;
1177 RelocateBufferToRequested<false> patcher(this);
1178 patcher.doit();
1179 }
1180 }
1181
1182 // Write detailed info to a mapfile to analyze contents of the archive.
1183 // static dump:
1184 // java -Xshare:dump -Xlog:cds+map=trace:file=cds.map:none:filesize=0
1185 // dynamic dump:
1186 // java -cp MyApp.jar -XX:ArchiveClassesAtExit=MyApp.jsa \
1187 // -Xlog:cds+map=trace:file=cds.map:none:filesize=0 MyApp
1188 //
1189 // We need to do some address translation because the buffers used at dump time may be mapped to
1190 // a different location at runtime. At dump time, the buffers may be at arbitrary locations
1191 // picked by the OS. At runtime, we try to map at a fixed location (SharedBaseAddress). For
1192 // consistency, we log everything using runtime addresses.
1193 class ArchiveBuilder::CDSMapLogger : AllStatic {
1194 static intx buffer_to_runtime_delta() {
1195 // Translate the buffers used by the RW/RO regions to their eventual (requested) locations
1196 // at runtime.
1197 return ArchiveBuilder::current()->buffer_to_requested_delta();
1198 }
1199
1200 // rw/ro regions only
1201 static void log_metaspace_region(const char* name, DumpRegion* region,
1202 const ArchiveBuilder::SourceObjList* src_objs) {
1203 address region_base = address(region->base());
1204 address region_top = address(region->top());
1205 log_region(name, region_base, region_top, region_base + buffer_to_runtime_delta());
1206 log_metaspace_objects(region, src_objs);
1207 }
1208
1209 #define _LOG_PREFIX PTR_FORMAT ": @@ %-17s %d"
1210
1211 static void log_klass(Klass* k, address runtime_dest, const char* type_name, int bytes, Thread* current) {
1212 ResourceMark rm(current);
1213 log_debug(cds, map)(_LOG_PREFIX " %s",
1214 p2i(runtime_dest), type_name, bytes, k->external_name());
1215 }
1216 static void log_method(Method* m, address runtime_dest, const char* type_name, int bytes, Thread* current) {
1217 ResourceMark rm(current);
1218 log_debug(cds, map)(_LOG_PREFIX " %s",
1219 p2i(runtime_dest), type_name, bytes, m->external_name());
1220 }
1221
1222 // rw/ro regions only
1223 static void log_metaspace_objects(DumpRegion* region, const ArchiveBuilder::SourceObjList* src_objs) {
1224 address last_obj_base = address(region->base());
1225 address last_obj_end = address(region->base());
1226 address region_end = address(region->end());
1227 Thread* current = Thread::current();
1228 for (int i = 0; i < src_objs->objs()->length(); i++) {
1229 SourceObjInfo* src_info = src_objs->at(i);
1230 address src = src_info->source_addr();
1231 address dest = src_info->buffered_addr();
1232 log_as_hex(last_obj_base, dest, last_obj_base + buffer_to_runtime_delta());
1233 address runtime_dest = dest + buffer_to_runtime_delta();
1234 int bytes = src_info->size_in_bytes();
1235
1236 MetaspaceObj::Type type = src_info->msotype();
1237 const char* type_name = MetaspaceObj::type_name(type);
1238
1239 switch (type) {
1240 case MetaspaceObj::ClassType:
1241 log_klass((Klass*)src, runtime_dest, type_name, bytes, current);
1242 break;
1243 case MetaspaceObj::ConstantPoolType:
1244 log_klass(((ConstantPool*)src)->pool_holder(),
1245 runtime_dest, type_name, bytes, current);
1246 break;
1247 case MetaspaceObj::ConstantPoolCacheType:
1248 log_klass(((ConstantPoolCache*)src)->constant_pool()->pool_holder(),
1249 runtime_dest, type_name, bytes, current);
1250 break;
1251 case MetaspaceObj::MethodType:
1252 log_method((Method*)src, runtime_dest, type_name, bytes, current);
1253 break;
1254 case MetaspaceObj::ConstMethodType:
1255 log_method(((ConstMethod*)src)->method(), runtime_dest, type_name, bytes, current);
1256 break;
1257 case MetaspaceObj::SymbolType:
1258 {
1259 ResourceMark rm(current);
1260 Symbol* s = (Symbol*)src;
1261 log_debug(cds, map)(_LOG_PREFIX " %s", p2i(runtime_dest), type_name, bytes,
1262 s->as_quoted_ascii());
1263 }
1264 break;
1265 default:
1266 log_debug(cds, map)(_LOG_PREFIX, p2i(runtime_dest), type_name, bytes);
1267 break;
1268 }
1269
1270 last_obj_base = dest;
1271 last_obj_end = dest + bytes;
1272 }
1273
1274 log_as_hex(last_obj_base, last_obj_end, last_obj_base + buffer_to_runtime_delta());
1275 if (last_obj_end < region_end) {
1276 log_debug(cds, map)(PTR_FORMAT ": @@ Misc data %zu bytes",
1277 p2i(last_obj_end + buffer_to_runtime_delta()),
1278 size_t(region_end - last_obj_end));
1279 log_as_hex(last_obj_end, region_end, last_obj_end + buffer_to_runtime_delta());
1280 }
1281 }
1282
1283 #undef _LOG_PREFIX
1284
1285 // Log information about a region, whose address at dump time is [base .. top). At
1286 // runtime, this region will be mapped to requested_base. requested_base is 0 if this
1287 // region will be mapped at os-selected addresses (such as the bitmap region), or will
1288 // be accessed with os::read (the header).
1289 //
1290 // Note: across -Xshare:dump runs, base may be different, but requested_base should
1291 // be the same as the archive contents should be deterministic.
1292 static void log_region(const char* name, address base, address top, address requested_base) {
1293 size_t size = top - base;
1294 base = requested_base;
1295 top = requested_base + size;
1296 log_info(cds, map)("[%-18s " PTR_FORMAT " - " PTR_FORMAT " %9zu bytes]",
1297 name, p2i(base), p2i(top), size);
1298 }
1299
1300 #if INCLUDE_CDS_JAVA_HEAP
1301 static void log_heap_region(ArchiveHeapInfo* heap_info) {
1302 MemRegion r = heap_info->buffer_region();
1303 address start = address(r.start()); // start of the current oop inside the buffer
1304 address end = address(r.end());
1305 log_region("heap", start, end, ArchiveHeapWriter::buffered_addr_to_requested_addr(start));
1306
1307 LogStreamHandle(Info, cds, map) st;
1308
1309 HeapRootSegments segments = heap_info->heap_root_segments();
1310 assert(segments.base_offset() == 0, "Sanity");
1311
1312 for (size_t seg_idx = 0; seg_idx < segments.count(); seg_idx++) {
1313 address requested_start = ArchiveHeapWriter::buffered_addr_to_requested_addr(start);
1314 st.print_cr(PTR_FORMAT ": Heap roots segment [%d]",
1315 p2i(requested_start), segments.size_in_elems(seg_idx));
1316 start += segments.size_in_bytes(seg_idx);
1317 }
1318 log_heap_roots();
1319
1320 while (start < end) {
1321 size_t byte_size;
1322 oop source_oop = ArchiveHeapWriter::buffered_addr_to_source_obj(start);
1323 address requested_start = ArchiveHeapWriter::buffered_addr_to_requested_addr(start);
1324 st.print(PTR_FORMAT ": @@ Object ", p2i(requested_start));
1325
1326 if (source_oop != nullptr) {
1327 // This is a regular oop that got archived.
1328 // Don't print the requested addr again as we have just printed it at the beginning of the line.
1329 // Example:
1330 // 0x00000007ffd27938: @@ Object (0xfffa4f27) java.util.HashMap
1331 print_oop_info_cr(&st, source_oop, /*print_requested_addr=*/false);
1332 byte_size = source_oop->size() * BytesPerWord;
1333 } else if ((byte_size = ArchiveHeapWriter::get_filler_size_at(start)) > 0) {
1334 // We have a filler oop, which also does not exist in BufferOffsetToSourceObjectTable.
1335 // Example:
1336 // 0x00000007ffc3ffd8: @@ Object filler 40 bytes
1337 st.print_cr("filler %zu bytes", byte_size);
1338 } else {
1339 ShouldNotReachHere();
1340 }
1341
1342 address oop_end = start + byte_size;
1343 log_as_hex(start, oop_end, requested_start, /*is_heap=*/true);
1344
1345 if (source_oop != nullptr) {
1346 log_oop_details(heap_info, source_oop, /*buffered_addr=*/start);
1347 }
1348 start = oop_end;
1349 }
1350 }
1351
1352 // ArchivedFieldPrinter is used to print the fields of archived objects. We can't
1353 // use _source_obj->print_on(), because we want to print the oop fields
1354 // in _source_obj with their requested addresses using print_oop_info_cr().
1355 class ArchivedFieldPrinter : public FieldClosure {
1356 ArchiveHeapInfo* _heap_info;
1357 outputStream* _st;
1358 oop _source_obj;
1359 address _buffered_addr;
1360 public:
1361 ArchivedFieldPrinter(ArchiveHeapInfo* heap_info, outputStream* st, oop src_obj, address buffered_addr) :
1362 _heap_info(heap_info), _st(st), _source_obj(src_obj), _buffered_addr(buffered_addr) {}
1363
1364 void do_field(fieldDescriptor* fd) {
1365 _st->print(" - ");
1366 BasicType ft = fd->field_type();
1367 switch (ft) {
1368 case T_ARRAY:
1369 case T_OBJECT:
1370 {
1371 fd->print_on(_st); // print just the name and offset
1372 oop obj = _source_obj->obj_field(fd->offset());
1373 if (java_lang_Class::is_instance(obj)) {
1374 obj = HeapShared::scratch_java_mirror(obj);
1375 }
1376 print_oop_info_cr(_st, obj);
1377 }
1378 break;
1379 default:
1380 if (ArchiveHeapWriter::is_marked_as_native_pointer(_heap_info, _source_obj, fd->offset())) {
1381 print_as_native_pointer(fd);
1382 } else {
1383 fd->print_on_for(_st, cast_to_oop(_buffered_addr)); // name, offset, value
1384 _st->cr();
1385 }
1386 }
1387 }
1388
1389 void print_as_native_pointer(fieldDescriptor* fd) {
1390 LP64_ONLY(assert(fd->field_type() == T_LONG, "must be"));
1391 NOT_LP64 (assert(fd->field_type() == T_INT, "must be"));
1392
1393 // We have a field that looks like an integer, but it's actually a pointer to a MetaspaceObj.
1394 address source_native_ptr = (address)
1395 LP64_ONLY(_source_obj->long_field(fd->offset()))
1396 NOT_LP64( _source_obj->int_field (fd->offset()));
1397 ArchiveBuilder* builder = ArchiveBuilder::current();
1398
1399 // The value of the native pointer at runtime.
1400 address requested_native_ptr = builder->to_requested(builder->get_buffered_addr(source_native_ptr));
1401
1402 // The address of _source_obj at runtime
1403 oop requested_obj = ArchiveHeapWriter::source_obj_to_requested_obj(_source_obj);
1404 // The address of this field in the requested space
1405 assert(requested_obj != nullptr, "Attempting to load field from null oop");
1406 address requested_field_addr = cast_from_oop<address>(requested_obj) + fd->offset();
1407
1408 fd->print_on(_st);
1409 _st->print_cr(PTR_FORMAT " (marked metadata pointer @" PTR_FORMAT " )",
1410 p2i(requested_native_ptr), p2i(requested_field_addr));
1411 }
1412 };
1413
1414 // Print the fields of instanceOops, or the elements of arrayOops
1415 static void log_oop_details(ArchiveHeapInfo* heap_info, oop source_oop, address buffered_addr) {
1416 LogStreamHandle(Trace, cds, map, oops) st;
1417 if (st.is_enabled()) {
1418 Klass* source_klass = source_oop->klass();
1419 ArchiveBuilder* builder = ArchiveBuilder::current();
1420 Klass* requested_klass = builder->to_requested(builder->get_buffered_addr(source_klass));
1421
1422 st.print(" - klass: ");
1423 source_klass->print_value_on(&st);
1424 st.print(" " PTR_FORMAT, p2i(requested_klass));
1425 st.cr();
1426
1427 if (source_oop->is_typeArray()) {
1428 TypeArrayKlass::cast(source_klass)->oop_print_elements_on(typeArrayOop(source_oop), &st);
1429 } else if (source_oop->is_objArray()) {
1430 objArrayOop source_obj_array = objArrayOop(source_oop);
1431 for (int i = 0; i < source_obj_array->length(); i++) {
1432 st.print(" -%4d: ", i);
1433 oop obj = source_obj_array->obj_at(i);
1434 if (java_lang_Class::is_instance(obj)) {
1435 obj = HeapShared::scratch_java_mirror(obj);
1436 }
1437 print_oop_info_cr(&st, obj);
1438 }
1439 } else {
1440 st.print_cr(" - fields (%zu words):", source_oop->size());
1441 ArchivedFieldPrinter print_field(heap_info, &st, source_oop, buffered_addr);
1442 InstanceKlass::cast(source_klass)->print_nonstatic_fields(&print_field);
1443
1444 if (java_lang_Class::is_instance(source_oop)) {
1445 oop scratch_mirror = source_oop;
1446 st.print(" - signature: ");
1447 print_class_signature_for_mirror(&st, scratch_mirror);
1448 st.cr();
1449
1450 Klass* src_klass = java_lang_Class::as_Klass(scratch_mirror);
1451 if (src_klass != nullptr && src_klass->is_instance_klass()) {
1452 oop rr = HeapShared::scratch_resolved_references(InstanceKlass::cast(src_klass)->constants());
1453 st.print(" - archived_resolved_references: ");
1454 print_oop_info_cr(&st, rr);
1455
1456 // We need to print the fields in the scratch_mirror, not the original mirror.
1457 // (if a class is not aot-initialized, static fields in its scratch mirror will be cleared).
1458 assert(scratch_mirror == HeapShared::scratch_java_mirror(src_klass->java_mirror()), "sanity");
1459 st.print_cr("- ---- static fields (%d):", java_lang_Class::static_oop_field_count(scratch_mirror));
1460 InstanceKlass::cast(src_klass)->do_local_static_fields(&print_field);
1461 }
1462 }
1463 }
1464 }
1465 }
1466
1467 static void print_class_signature_for_mirror(outputStream* st, oop scratch_mirror) {
1468 assert(java_lang_Class::is_instance(scratch_mirror), "sanity");
1469 if (java_lang_Class::is_primitive(scratch_mirror)) {
1470 for (int i = T_BOOLEAN; i < T_VOID+1; i++) {
1471 BasicType bt = (BasicType)i;
1472 if (!is_reference_type(bt) && scratch_mirror == HeapShared::scratch_java_mirror(bt)) {
1473 oop orig_mirror = Universe::java_mirror(bt);
1474 java_lang_Class::print_signature(orig_mirror, st);
1475 return;
1476 }
1477 }
1478 ShouldNotReachHere();
1479 }
1480 java_lang_Class::print_signature(scratch_mirror, st);
1481 }
1482
1483 static void log_heap_roots() {
1484 LogStreamHandle(Trace, cds, map, oops) st;
1485 if (st.is_enabled()) {
1486 for (int i = 0; i < HeapShared::pending_roots()->length(); i++) {
1487 st.print("roots[%4d]: ", i);
1488 print_oop_info_cr(&st, HeapShared::pending_roots()->at(i).resolve());
1489 }
1490 }
1491 }
1492
1493 // Example output:
1494 // - The first number is the requested address (if print_requested_addr == true)
1495 // - The second number is the narrowOop version of the requested address (if UseCompressedOops == true)
1496 // 0x00000007ffc7e840 (0xfff8fd08) java.lang.Class Ljava/util/Array;
1497 // 0x00000007ffc000f8 (0xfff8001f) [B length: 11
1498 static void print_oop_info_cr(outputStream* st, oop source_oop, bool print_requested_addr = true) {
1499 if (source_oop == nullptr) {
1500 st->print_cr("null");
1501 } else {
1502 ResourceMark rm;
1503 oop requested_obj = ArchiveHeapWriter::source_obj_to_requested_obj(source_oop);
1504 if (print_requested_addr) {
1505 st->print(PTR_FORMAT " ", p2i(requested_obj));
1506 }
1507 if (UseCompressedOops) {
1508 st->print("(0x%08x) ", CompressedOops::narrow_oop_value(requested_obj));
1509 }
1510 if (source_oop->is_array()) {
1511 int array_len = arrayOop(source_oop)->length();
1512 st->print_cr("%s length: %d", source_oop->klass()->external_name(), array_len);
1513 } else {
1514 st->print("%s", source_oop->klass()->external_name());
1515
1516 if (java_lang_String::is_instance(source_oop)) {
1517 st->print(" ");
1518 java_lang_String::print(source_oop, st);
1519 } else if (java_lang_invoke_MethodType::is_instance(source_oop)) {
1520 st->print(" ");
1521 java_lang_invoke_MethodType::print_signature(source_oop, st);
1522 } else if (java_lang_Class::is_instance(source_oop)) {
1523 oop scratch_mirror = source_oop;
1524
1525 st->print(" ");
1526 print_class_signature_for_mirror(st, scratch_mirror);
1527
1528 Klass* src_klass = java_lang_Class::as_Klass(scratch_mirror);
1529 if (src_klass != nullptr && src_klass->is_instance_klass()) {
1530 InstanceKlass* buffered_klass =
1531 ArchiveBuilder::current()->get_buffered_addr(InstanceKlass::cast(src_klass));
1532 if (buffered_klass->has_aot_initialized_mirror()) {
1533 st->print(" (aot-inited)");
1534 }
1535 }
1536 }
1537 st->cr();
1538 }
1539 }
1540 }
1541 #endif // INCLUDE_CDS_JAVA_HEAP
1542
1543 // Log all the data [base...top). Pretend that the base address
1544 // will be mapped to requested_base at run-time.
1545 static void log_as_hex(address base, address top, address requested_base, bool is_heap = false) {
1546 assert(top >= base, "must be");
1547
1548 LogStreamHandle(Trace, cds, map) lsh;
1549 if (lsh.is_enabled()) {
1550 int unitsize = sizeof(address);
1551 if (is_heap && UseCompressedOops) {
1552 // This makes the compressed oop pointers easier to read, but
1553 // longs and doubles will be split into two words.
1554 unitsize = sizeof(narrowOop);
1555 }
1556 os::print_hex_dump(&lsh, base, top, unitsize, /* print_ascii=*/true, /* bytes_per_line=*/32, requested_base);
1557 }
1558 }
1559
1560 static void log_header(FileMapInfo* mapinfo) {
1561 LogStreamHandle(Info, cds, map) lsh;
1562 if (lsh.is_enabled()) {
1563 mapinfo->print(&lsh);
1564 }
1565 }
1566
1567 public:
1568 static void log(ArchiveBuilder* builder, FileMapInfo* mapinfo,
1569 ArchiveHeapInfo* heap_info,
1570 char* bitmap, size_t bitmap_size_in_bytes) {
1571 log_info(cds, map)("%s CDS archive map for %s", CDSConfig::is_dumping_static_archive() ? "Static" : "Dynamic", mapinfo->full_path());
1572
1573 address header = address(mapinfo->header());
1574 address header_end = header + mapinfo->header()->header_size();
1575 log_region("header", header, header_end, nullptr);
1576 log_header(mapinfo);
1577 log_as_hex(header, header_end, nullptr);
1578
1579 DumpRegion* rw_region = &builder->_rw_region;
1580 DumpRegion* ro_region = &builder->_ro_region;
1581
1582 log_metaspace_region("rw region", rw_region, &builder->_rw_src_objs);
1583 log_metaspace_region("ro region", ro_region, &builder->_ro_src_objs);
1584
1585 address bitmap_end = address(bitmap + bitmap_size_in_bytes);
1586 log_region("bitmap", address(bitmap), bitmap_end, nullptr);
1587 log_as_hex((address)bitmap, bitmap_end, nullptr);
1588
1589 #if INCLUDE_CDS_JAVA_HEAP
1590 if (heap_info->is_used()) {
1591 log_heap_region(heap_info);
1592 }
1593 #endif
1594
1595 log_info(cds, map)("[End of CDS archive map]");
1596 }
1597 }; // end ArchiveBuilder::CDSMapLogger
1598
1599 void ArchiveBuilder::print_stats() {
1600 _alloc_stats.print_stats(int(_ro_region.used()), int(_rw_region.used()));
1601 }
1602
1603 void ArchiveBuilder::write_archive(FileMapInfo* mapinfo, ArchiveHeapInfo* heap_info) {
1604 // Make sure NUM_CDS_REGIONS (exported in cds.h) agrees with
1605 // MetaspaceShared::n_regions (internal to hotspot).
1606 assert(NUM_CDS_REGIONS == MetaspaceShared::n_regions, "sanity");
1607
1608 write_region(mapinfo, MetaspaceShared::rw, &_rw_region, /*read_only=*/false,/*allow_exec=*/false);
1609 write_region(mapinfo, MetaspaceShared::ro, &_ro_region, /*read_only=*/true, /*allow_exec=*/false);
1610 write_region(mapinfo, MetaspaceShared::cc, &_cc_region, /*read_only=*/false,/*allow_exec=*/false);
1611
1612 // Split pointer map into read-write and read-only bitmaps
1613 ArchivePtrMarker::initialize_rw_ro_cc_maps(&_rw_ptrmap, &_ro_ptrmap, &_cc_ptrmap);
1614
1615 size_t bitmap_size_in_bytes;
1616 char* bitmap = mapinfo->write_bitmap_region(ArchivePtrMarker::rw_ptrmap(),
1617 ArchivePtrMarker::ro_ptrmap(),
1618 ArchivePtrMarker::cc_ptrmap(),
1619 heap_info,
1620 bitmap_size_in_bytes);
1621
1622 if (heap_info->is_used()) {
1623 _total_heap_region_size = mapinfo->write_heap_region(heap_info);
1624 }
1625
1626 print_region_stats(mapinfo, heap_info);
1627
1628 mapinfo->set_requested_base((char*)MetaspaceShared::requested_base_address());
1629 mapinfo->set_header_crc(mapinfo->compute_header_crc());
1630 // After this point, we should not write any data into mapinfo->header() since this
1631 // would corrupt its checksum we have calculated before.
1632 mapinfo->write_header();
1633 mapinfo->close();
1634
1635 if (log_is_enabled(Info, cds)) {
1636 log_info(cds)("Full module graph = %s", CDSConfig::is_dumping_full_module_graph() ? "enabled" : "disabled");
1637 print_stats();
1638 }
1639
1640 if (log_is_enabled(Info, cds, map)) {
1641 CDSMapLogger::log(this, mapinfo, heap_info,
1642 bitmap, bitmap_size_in_bytes);
1643 }
1644 CDS_JAVA_HEAP_ONLY(HeapShared::destroy_archived_object_cache());
1645 FREE_C_HEAP_ARRAY(char, bitmap);
1646 }
1647
1648 void ArchiveBuilder::write_region(FileMapInfo* mapinfo, int region_idx, DumpRegion* dump_region, bool read_only, bool allow_exec) {
1649 mapinfo->write_region(region_idx, dump_region->base(), dump_region->used(), read_only, allow_exec);
1650 }
1651
1652 void ArchiveBuilder::count_relocated_pointer(bool tagged, bool nulled) {
1653 _relocated_ptr_info._num_ptrs ++;
1654 _relocated_ptr_info._num_tagged_ptrs += tagged ? 1 : 0;
1655 _relocated_ptr_info._num_nulled_ptrs += nulled ? 1 : 0;
1656 }
1657
1658 void ArchiveBuilder::print_region_stats(FileMapInfo *mapinfo, ArchiveHeapInfo* heap_info) {
1659 // Print statistics of all the regions
1660 const size_t bitmap_used = mapinfo->region_at(MetaspaceShared::bm)->used();
1661 const size_t bitmap_reserved = mapinfo->region_at(MetaspaceShared::bm)->used_aligned();
1662 const size_t total_reserved = _ro_region.reserved() + _rw_region.reserved() +
1663 bitmap_reserved +
1664 _total_heap_region_size;
1665 const size_t total_bytes = _ro_region.used() + _rw_region.used() +
1666 bitmap_used +
1667 _total_heap_region_size;
1668 const double total_u_perc = percent_of(total_bytes, total_reserved);
1669
1670 _rw_region.print(total_reserved);
1671 _ro_region.print(total_reserved);
1672 _cc_region.print(total_reserved);
1673
1674 print_bitmap_region_stats(bitmap_used, total_reserved);
1675
1676 if (heap_info->is_used()) {
1677 print_heap_region_stats(heap_info, total_reserved);
1678 }
1679
1680 log_debug(cds)("total : %9zu [100.0%% of total] out of %9zu bytes [%5.1f%% used]",
1681 total_bytes, total_reserved, total_u_perc);
1682 }
1683
1684 void ArchiveBuilder::print_bitmap_region_stats(size_t size, size_t total_size) {
1685 log_debug(cds)("bm space: %9zu [ %4.1f%% of total] out of %9zu bytes [100.0%% used]",
1686 size, size/double(total_size)*100.0, size);
1687 }
1688
1689 void ArchiveBuilder::print_heap_region_stats(ArchiveHeapInfo *info, size_t total_size) {
1690 char* start = info->buffer_start();
1691 size_t size = info->buffer_byte_size();
1692 char* top = start + size;
1693 log_debug(cds)("hp space: %9zu [ %4.1f%% of total] out of %9zu bytes [100.0%% used] at " INTPTR_FORMAT,
1694 size, size/double(total_size)*100.0, size, p2i(start));
1695 }
1696
1697 void ArchiveBuilder::report_out_of_space(const char* name, size_t needed_bytes) {
1698 // This is highly unlikely to happen on 64-bits because we have reserved a 4GB space.
1699 // On 32-bit we reserve only 256MB so you could run out of space with 100,000 classes
1700 // or so.
1701 _rw_region.print_out_of_space_msg(name, needed_bytes);
1702 _ro_region.print_out_of_space_msg(name, needed_bytes);
1703
1704 log_error(cds)("Unable to allocate from '%s' region: Please reduce the number of shared classes.", name);
1705 MetaspaceShared::unrecoverable_writing_error();
1706 }