1 /*
2 * Copyright (c) 2020, 2024, 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 "precompiled.hpp"
26 #include "cds/archiveBuilder.hpp"
27 #include "cds/archiveHeapWriter.hpp"
28 #include "cds/archiveUtils.hpp"
29 #include "cds/cdsConfig.hpp"
30 #include "cds/cppVtables.hpp"
31 #include "cds/dumpAllocStats.hpp"
32 #include "cds/dynamicArchive.hpp"
33 #include "cds/heapShared.hpp"
34 #include "cds/metaspaceShared.hpp"
35 #include "cds/regeneratedClasses.hpp"
36 #include "classfile/classLoaderDataShared.hpp"
37 #include "classfile/javaClasses.hpp"
38 #include "classfile/symbolTable.hpp"
39 #include "classfile/systemDictionaryShared.hpp"
40 #include "classfile/vmClasses.hpp"
41 #include "interpreter/abstractInterpreter.hpp"
42 #include "jvm.h"
43 #include "logging/log.hpp"
44 #include "logging/logStream.hpp"
45 #include "memory/allStatic.hpp"
46 #include "memory/memRegion.hpp"
47 #include "memory/resourceArea.hpp"
48 #include "oops/compressedKlass.inline.hpp"
49 #include "oops/instanceKlass.hpp"
50 #include "oops/objArrayKlass.hpp"
51 #include "oops/objArrayOop.inline.hpp"
52 #include "oops/oopHandle.inline.hpp"
53 #include "runtime/arguments.hpp"
54 #include "runtime/fieldDescriptor.inline.hpp"
55 #include "runtime/globals_extension.hpp"
56 #include "runtime/javaThread.hpp"
57 #include "runtime/sharedRuntime.hpp"
58 #include "utilities/align.hpp"
59 #include "utilities/bitMap.inline.hpp"
60 #include "utilities/formatBuffer.hpp"
61
62 ArchiveBuilder* ArchiveBuilder::_current = nullptr;
63
64 ArchiveBuilder::OtherROAllocMark::~OtherROAllocMark() {
65 char* newtop = ArchiveBuilder::current()->_ro_region.top();
66 ArchiveBuilder::alloc_stats()->record_other_type(int(newtop - _oldtop), true);
67 }
68
69 ArchiveBuilder::SourceObjList::SourceObjList() : _ptrmap(16 * K, mtClassShared) {
70 _total_bytes = 0;
71 _objs = new (mtClassShared) GrowableArray<SourceObjInfo*>(128 * K, mtClassShared);
72 }
73
74 ArchiveBuilder::SourceObjList::~SourceObjList() {
75 delete _objs;
76 }
77
78 void ArchiveBuilder::SourceObjList::append(SourceObjInfo* src_info) {
79 // Save this source object for copying
80 src_info->set_id(_objs->length());
81 _objs->append(src_info);
82
83 // Prepare for marking the pointers in this source object
84 assert(is_aligned(_total_bytes, sizeof(address)), "must be");
85 src_info->set_ptrmap_start(_total_bytes / sizeof(address));
86 _total_bytes = align_up(_total_bytes + (uintx)src_info->size_in_bytes(), sizeof(address));
87 src_info->set_ptrmap_end(_total_bytes / sizeof(address));
88
89 BitMap::idx_t bitmap_size_needed = BitMap::idx_t(src_info->ptrmap_end());
90 if (_ptrmap.size() <= bitmap_size_needed) {
91 _ptrmap.resize((bitmap_size_needed + 1) * 2);
92 }
93 }
94
95 void ArchiveBuilder::SourceObjList::remember_embedded_pointer(SourceObjInfo* src_info, MetaspaceClosure::Ref* ref) {
96 // src_obj contains a pointer. Remember the location of this pointer in _ptrmap,
97 // so that we can copy/relocate it later.
98 src_info->set_has_embedded_pointer();
99 address src_obj = src_info->source_addr();
100 address* field_addr = ref->addr();
101 assert(src_info->ptrmap_start() < _total_bytes, "sanity");
102 assert(src_info->ptrmap_end() <= _total_bytes, "sanity");
103 assert(*field_addr != nullptr, "should have checked");
104
105 intx field_offset_in_bytes = ((address)field_addr) - src_obj;
106 DEBUG_ONLY(int src_obj_size = src_info->size_in_bytes();)
107 assert(field_offset_in_bytes >= 0, "must be");
108 assert(field_offset_in_bytes + intx(sizeof(intptr_t)) <= intx(src_obj_size), "must be");
109 assert(is_aligned(field_offset_in_bytes, sizeof(address)), "must be");
110
111 BitMap::idx_t idx = BitMap::idx_t(src_info->ptrmap_start() + (uintx)(field_offset_in_bytes / sizeof(address)));
112 _ptrmap.set_bit(BitMap::idx_t(idx));
113 }
114
115 class RelocateEmbeddedPointers : public BitMapClosure {
116 ArchiveBuilder* _builder;
117 address _buffered_obj;
118 BitMap::idx_t _start_idx;
119 public:
120 RelocateEmbeddedPointers(ArchiveBuilder* builder, address buffered_obj, BitMap::idx_t start_idx) :
121 _builder(builder), _buffered_obj(buffered_obj), _start_idx(start_idx) {}
122
123 bool do_bit(BitMap::idx_t bit_offset) {
124 size_t field_offset = size_t(bit_offset - _start_idx) * sizeof(address);
125 address* ptr_loc = (address*)(_buffered_obj + field_offset);
126
127 address old_p = *ptr_loc;
128 address new_p = _builder->get_buffered_addr(old_p);
129
130 log_trace(cds)("Ref: [" PTR_FORMAT "] -> " PTR_FORMAT " => " PTR_FORMAT,
131 p2i(ptr_loc), p2i(old_p), p2i(new_p));
132
133 ArchivePtrMarker::set_and_mark_pointer(ptr_loc, new_p);
134 return true; // keep iterating the bitmap
135 }
136 };
137
138 void ArchiveBuilder::SourceObjList::relocate(int i, ArchiveBuilder* builder) {
139 SourceObjInfo* src_info = objs()->at(i);
140 assert(src_info->should_copy(), "must be");
141 BitMap::idx_t start = BitMap::idx_t(src_info->ptrmap_start()); // inclusive
142 BitMap::idx_t end = BitMap::idx_t(src_info->ptrmap_end()); // exclusive
143
144 RelocateEmbeddedPointers relocator(builder, src_info->buffered_addr(), start);
145 _ptrmap.iterate(&relocator, start, end);
146 }
147
148 ArchiveBuilder::ArchiveBuilder() :
149 _current_dump_region(nullptr),
150 _buffer_bottom(nullptr),
151 _last_verified_top(nullptr),
152 _num_dump_regions_used(0),
153 _other_region_used_bytes(0),
154 _requested_static_archive_bottom(nullptr),
155 _requested_static_archive_top(nullptr),
156 _requested_dynamic_archive_bottom(nullptr),
157 _requested_dynamic_archive_top(nullptr),
158 _mapped_static_archive_bottom(nullptr),
159 _mapped_static_archive_top(nullptr),
160 _buffer_to_requested_delta(0),
161 _rw_region("rw", MAX_SHARED_DELTA),
162 _ro_region("ro", MAX_SHARED_DELTA),
163 _ptrmap(mtClassShared),
164 _rw_ptrmap(mtClassShared),
165 _ro_ptrmap(mtClassShared),
166 _rw_src_objs(),
167 _ro_src_objs(),
168 _src_obj_table(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE),
169 _buffered_to_src_table(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE),
170 _total_heap_region_size(0),
171 _estimated_metaspaceobj_bytes(0),
172 _estimated_hashtable_bytes(0)
173 {
174 _klasses = new (mtClassShared) GrowableArray<Klass*>(4 * K, mtClassShared);
175 _symbols = new (mtClassShared) GrowableArray<Symbol*>(256 * K, mtClassShared);
176 _entropy_seed = 0x12345678;
177 assert(_current == nullptr, "must be");
178 _current = this;
179 }
180
181 ArchiveBuilder::~ArchiveBuilder() {
182 assert(_current == this, "must be");
183 _current = nullptr;
184
185 for (int i = 0; i < _symbols->length(); i++) {
186 _symbols->at(i)->decrement_refcount();
187 }
188
189 delete _klasses;
190 delete _symbols;
191 if (_shared_rs.is_reserved()) {
192 _shared_rs.release();
193 }
194 }
195
196 // Returns a deterministic sequence of pseudo random numbers. The main purpose is NOT
197 // for randomness but to get good entropy for the identity_hash() of archived Symbols,
198 // while keeping the contents of static CDS archives deterministic to ensure
199 // reproducibility of JDK builds.
200 int ArchiveBuilder::entropy() {
201 assert(SafepointSynchronize::is_at_safepoint(), "needed to ensure deterministic sequence");
202 _entropy_seed = os::next_random(_entropy_seed);
203 return static_cast<int>(_entropy_seed);
204 }
205
206 class GatherKlassesAndSymbols : public UniqueMetaspaceClosure {
207 ArchiveBuilder* _builder;
208
209 public:
210 GatherKlassesAndSymbols(ArchiveBuilder* builder) : _builder(builder) {}
211
212 virtual bool do_unique_ref(Ref* ref, bool read_only) {
213 return _builder->gather_klass_and_symbol(ref, read_only);
214 }
215 };
216
217 bool ArchiveBuilder::gather_klass_and_symbol(MetaspaceClosure::Ref* ref, bool read_only) {
218 if (ref->obj() == nullptr) {
219 return false;
220 }
221 if (get_follow_mode(ref) != make_a_copy) {
222 return false;
223 }
224 if (ref->msotype() == MetaspaceObj::ClassType) {
225 Klass* klass = (Klass*)ref->obj();
226 assert(klass->is_klass(), "must be");
227 if (!is_excluded(klass)) {
228 _klasses->append(klass);
229 }
230 // See RunTimeClassInfo::get_for()
231 _estimated_metaspaceobj_bytes += align_up(BytesPerWord, SharedSpaceObjectAlignment);
232 } else if (ref->msotype() == MetaspaceObj::SymbolType) {
233 // Make sure the symbol won't be GC'ed while we are dumping the archive.
234 Symbol* sym = (Symbol*)ref->obj();
235 sym->increment_refcount();
236 _symbols->append(sym);
237 }
238
239 int bytes = ref->size() * BytesPerWord;
240 _estimated_metaspaceobj_bytes += align_up(bytes, SharedSpaceObjectAlignment);
241
242 return true; // recurse
243 }
244
245 void ArchiveBuilder::gather_klasses_and_symbols() {
246 ResourceMark rm;
247 log_info(cds)("Gathering classes and symbols ... ");
248 GatherKlassesAndSymbols doit(this);
249 iterate_roots(&doit);
250 #if INCLUDE_CDS_JAVA_HEAP
251 if (CDSConfig::is_dumping_full_module_graph()) {
252 ClassLoaderDataShared::iterate_symbols(&doit);
253 }
254 #endif
255 doit.finish();
256
257 if (CDSConfig::is_dumping_static_archive()) {
258 // To ensure deterministic contents in the static archive, we need to ensure that
259 // we iterate the MetaspaceObjs in a deterministic order. It doesn't matter where
260 // the MetaspaceObjs are located originally, as they are copied sequentially into
261 // the archive during the iteration.
262 //
263 // The only issue here is that the symbol table and the system directories may be
264 // randomly ordered, so we copy the symbols and klasses into two arrays and sort
265 // them deterministically.
266 //
267 // During -Xshare:dump, the order of Symbol creation is strictly determined by
268 // the SharedClassListFile (class loading is done in a single thread and the JIT
269 // is disabled). Also, Symbols are allocated in monotonically increasing addresses
270 // (see Symbol::operator new(size_t, int)). So if we iterate the Symbols by
271 // ascending address order, we ensure that all Symbols are copied into deterministic
272 // locations in the archive.
273 //
274 // TODO: in the future, if we want to produce deterministic contents in the
275 // dynamic archive, we might need to sort the symbols alphabetically (also see
276 // DynamicArchiveBuilder::sort_methods()).
277 log_info(cds)("Sorting symbols ... ");
278 _symbols->sort(compare_symbols_by_address);
279 sort_klasses();
280
281 // TODO -- we need a proper estimate for the archived modules, etc,
282 // but this should be enough for now
283 _estimated_metaspaceobj_bytes += 200 * 1024 * 1024;
284 }
285 }
286
287 int ArchiveBuilder::compare_symbols_by_address(Symbol** a, Symbol** b) {
288 if (a[0] < b[0]) {
289 return -1;
290 } else {
291 assert(a[0] > b[0], "Duplicated symbol %s unexpected", (*a)->as_C_string());
292 return 1;
293 }
294 }
295
296 int ArchiveBuilder::compare_klass_by_name(Klass** a, Klass** b) {
297 return a[0]->name()->fast_compare(b[0]->name());
298 }
299
300 void ArchiveBuilder::sort_klasses() {
301 log_info(cds)("Sorting classes ... ");
302 _klasses->sort(compare_klass_by_name);
303 }
304
305 size_t ArchiveBuilder::estimate_archive_size() {
306 // size of the symbol table and two dictionaries, plus the RunTimeClassInfo's
307 size_t symbol_table_est = SymbolTable::estimate_size_for_archive();
308 size_t dictionary_est = SystemDictionaryShared::estimate_size_for_archive();
309 _estimated_hashtable_bytes = symbol_table_est + dictionary_est;
310
311 size_t total = 0;
312
313 total += _estimated_metaspaceobj_bytes;
314 total += _estimated_hashtable_bytes;
315
316 // allow fragmentation at the end of each dump region
317 total += _total_dump_regions * MetaspaceShared::core_region_alignment();
318
319 log_info(cds)("_estimated_hashtable_bytes = " SIZE_FORMAT " + " SIZE_FORMAT " = " SIZE_FORMAT,
320 symbol_table_est, dictionary_est, _estimated_hashtable_bytes);
321 log_info(cds)("_estimated_metaspaceobj_bytes = " SIZE_FORMAT, _estimated_metaspaceobj_bytes);
322 log_info(cds)("total estimate bytes = " SIZE_FORMAT, total);
323
324 return align_up(total, MetaspaceShared::core_region_alignment());
325 }
326
327 address ArchiveBuilder::reserve_buffer() {
328 size_t buffer_size = estimate_archive_size();
329 ReservedSpace rs(buffer_size, MetaspaceShared::core_region_alignment(), os::vm_page_size());
330 if (!rs.is_reserved()) {
331 log_error(cds)("Failed to reserve " SIZE_FORMAT " bytes of output buffer.", buffer_size);
332 MetaspaceShared::unrecoverable_writing_error();
333 }
334
335 // buffer_bottom is the lowest address of the 2 core regions (rw, ro) when
336 // we are copying the class metadata into the buffer.
337 address buffer_bottom = (address)rs.base();
338 log_info(cds)("Reserved output buffer space at " PTR_FORMAT " [" SIZE_FORMAT " bytes]",
339 p2i(buffer_bottom), buffer_size);
340 _shared_rs = rs;
341
342 _buffer_bottom = buffer_bottom;
343 _last_verified_top = buffer_bottom;
344 _current_dump_region = &_rw_region;
345 _num_dump_regions_used = 1;
346 _other_region_used_bytes = 0;
347 _current_dump_region->init(&_shared_rs, &_shared_vs);
348
349 ArchivePtrMarker::initialize(&_ptrmap, &_shared_vs);
350
351 // The bottom of the static archive should be mapped at this address by default.
352 _requested_static_archive_bottom = (address)MetaspaceShared::requested_base_address();
353
354 // The bottom of the archive (that I am writing now) should be mapped at this address by default.
355 address my_archive_requested_bottom;
356
357 if (CDSConfig::is_dumping_static_archive()) {
358 my_archive_requested_bottom = _requested_static_archive_bottom;
359 } else {
360 _mapped_static_archive_bottom = (address)MetaspaceObj::shared_metaspace_base();
361 _mapped_static_archive_top = (address)MetaspaceObj::shared_metaspace_top();
362 assert(_mapped_static_archive_top >= _mapped_static_archive_bottom, "must be");
363 size_t static_archive_size = _mapped_static_archive_top - _mapped_static_archive_bottom;
364
365 // At run time, we will mmap the dynamic archive at my_archive_requested_bottom
366 _requested_static_archive_top = _requested_static_archive_bottom + static_archive_size;
367 my_archive_requested_bottom = align_up(_requested_static_archive_top, MetaspaceShared::core_region_alignment());
368
369 _requested_dynamic_archive_bottom = my_archive_requested_bottom;
370 }
371
372 _buffer_to_requested_delta = my_archive_requested_bottom - _buffer_bottom;
373
374 address my_archive_requested_top = my_archive_requested_bottom + buffer_size;
375 if (my_archive_requested_bottom < _requested_static_archive_bottom ||
376 my_archive_requested_top <= _requested_static_archive_bottom) {
377 // Size overflow.
378 log_error(cds)("my_archive_requested_bottom = " INTPTR_FORMAT, p2i(my_archive_requested_bottom));
379 log_error(cds)("my_archive_requested_top = " INTPTR_FORMAT, p2i(my_archive_requested_top));
380 log_error(cds)("SharedBaseAddress (" INTPTR_FORMAT ") is too high. "
381 "Please rerun java -Xshare:dump with a lower value", p2i(_requested_static_archive_bottom));
382 MetaspaceShared::unrecoverable_writing_error();
383 }
384
385 if (CDSConfig::is_dumping_static_archive()) {
386 // We don't want any valid object to be at the very bottom of the archive.
387 // See ArchivePtrMarker::mark_pointer().
388 rw_region()->allocate(16);
389 }
390
391 return buffer_bottom;
392 }
393
394 void ArchiveBuilder::iterate_sorted_roots(MetaspaceClosure* it) {
395 int num_symbols = _symbols->length();
396 for (int i = 0; i < num_symbols; i++) {
397 it->push(_symbols->adr_at(i));
398 }
399
400 int num_klasses = _klasses->length();
401 for (int i = 0; i < num_klasses; i++) {
402 it->push(_klasses->adr_at(i));
403 }
404
405 iterate_roots(it);
406 }
407
408 class GatherSortedSourceObjs : public MetaspaceClosure {
409 ArchiveBuilder* _builder;
410
411 public:
412 GatherSortedSourceObjs(ArchiveBuilder* builder) : _builder(builder) {}
413
414 virtual bool do_ref(Ref* ref, bool read_only) {
415 return _builder->gather_one_source_obj(ref, read_only);
416 }
417 };
418
419 bool ArchiveBuilder::gather_one_source_obj(MetaspaceClosure::Ref* ref, bool read_only) {
420 address src_obj = ref->obj();
421 if (src_obj == nullptr) {
422 return false;
423 }
424 if (RegeneratedClasses::has_been_regenerated(src_obj)) {
425 // No need to copy it. We will later relocate it to point to the regenerated klass/method.
426 return false;
427 }
428 remember_embedded_pointer_in_enclosing_obj(ref);
429
430 FollowMode follow_mode = get_follow_mode(ref);
431 SourceObjInfo src_info(ref, read_only, follow_mode);
432 bool created;
433 SourceObjInfo* p = _src_obj_table.put_if_absent(src_obj, src_info, &created);
434 if (created) {
435 if (_src_obj_table.maybe_grow()) {
436 log_info(cds, hashtables)("Expanded _src_obj_table table to %d", _src_obj_table.table_size());
437 }
438 }
439
440 #ifdef ASSERT
441 if (ref->msotype() == MetaspaceObj::MethodType) {
442 Method* m = (Method*)ref->obj();
443 assert(!RegeneratedClasses::has_been_regenerated((address)m->method_holder()),
444 "Should not archive methods in a class that has been regenerated");
445 }
446 #endif
447
448 assert(p->read_only() == src_info.read_only(), "must be");
449
450 if (created && src_info.should_copy()) {
451 if (read_only) {
452 _ro_src_objs.append(p);
453 } else {
454 _rw_src_objs.append(p);
455 }
456 return true; // Need to recurse into this ref only if we are copying it
457 } else {
458 return false;
459 }
460 }
461
462 void ArchiveBuilder::record_regenerated_object(address orig_src_obj, address regen_src_obj) {
463 // Record the fact that orig_src_obj has been replaced by regen_src_obj. All calls to get_buffered_addr(orig_src_obj)
464 // should return the same value as get_buffered_addr(regen_src_obj).
465 SourceObjInfo* p = _src_obj_table.get(regen_src_obj);
466 assert(p != nullptr, "regenerated object should always be dumped");
467 SourceObjInfo orig_src_info(orig_src_obj, p);
468 bool created;
469 _src_obj_table.put_if_absent(orig_src_obj, orig_src_info, &created);
470 assert(created, "We shouldn't have archived the original copy of a regenerated object");
471 }
472
473 // Remember that we have a pointer inside ref->enclosing_obj() that points to ref->obj()
474 void ArchiveBuilder::remember_embedded_pointer_in_enclosing_obj(MetaspaceClosure::Ref* ref) {
475 assert(ref->obj() != nullptr, "should have checked");
476
477 address enclosing_obj = ref->enclosing_obj();
478 if (enclosing_obj == nullptr) {
479 return;
480 }
481
482 // We are dealing with 3 addresses:
483 // address o = ref->obj(): We have found an object whose address is o.
484 // address* mpp = ref->mpp(): The object o is pointed to by a pointer whose address is mpp.
485 // I.e., (*mpp == o)
486 // enclosing_obj : If non-null, it is the object which has a field that points to o.
487 // mpp is the address if that field.
488 //
489 // Example: We have an array whose first element points to a Method:
490 // Method* o = 0x0000abcd;
491 // Array<Method*>* enclosing_obj = 0x00001000;
492 // enclosing_obj->at_put(0, o);
493 //
494 // We the MetaspaceClosure iterates on the very first element of this array, we have
495 // ref->obj() == 0x0000abcd (the Method)
496 // ref->mpp() == 0x00001008 (the location of the first element in the array)
497 // ref->enclosing_obj() == 0x00001000 (the Array that contains the Method)
498 //
499 // We use the above information to mark the bitmap to indicate that there's a pointer on address 0x00001008.
500 SourceObjInfo* src_info = _src_obj_table.get(enclosing_obj);
501 if (src_info == nullptr || !src_info->should_copy()) {
502 // source objects of point_to_it/set_to_null types are not copied
503 // so we don't need to remember their pointers.
504 } else {
505 if (src_info->read_only()) {
506 _ro_src_objs.remember_embedded_pointer(src_info, ref);
507 } else {
508 _rw_src_objs.remember_embedded_pointer(src_info, ref);
509 }
510 }
511 }
512
513 void ArchiveBuilder::gather_source_objs() {
514 ResourceMark rm;
515 log_info(cds)("Gathering all archivable objects ... ");
516 gather_klasses_and_symbols();
517 GatherSortedSourceObjs doit(this);
518 iterate_sorted_roots(&doit);
519 doit.finish();
520 }
521
522 bool ArchiveBuilder::is_excluded(Klass* klass) {
523 if (klass->is_instance_klass()) {
524 InstanceKlass* ik = InstanceKlass::cast(klass);
525 return SystemDictionaryShared::is_excluded_class(ik);
526 } else if (klass->is_objArray_klass()) {
527 Klass* bottom = ObjArrayKlass::cast(klass)->bottom_klass();
528 if (MetaspaceShared::is_shared_static(bottom)) {
529 // The bottom class is in the static archive so it's clearly not excluded.
530 assert(CDSConfig::is_dumping_dynamic_archive(), "sanity");
531 return false;
532 } else if (bottom->is_instance_klass()) {
533 return SystemDictionaryShared::is_excluded_class(InstanceKlass::cast(bottom));
534 }
535 }
536
537 return false;
538 }
539
540 ArchiveBuilder::FollowMode ArchiveBuilder::get_follow_mode(MetaspaceClosure::Ref *ref) {
541 address obj = ref->obj();
542 if (MetaspaceShared::is_in_shared_metaspace(obj)) {
543 // Don't dump existing shared metadata again.
544 return point_to_it;
545 } else if (ref->msotype() == MetaspaceObj::MethodDataType ||
546 ref->msotype() == MetaspaceObj::MethodCountersType) {
547 return set_to_null;
548 } else {
549 if (ref->msotype() == MetaspaceObj::ClassType) {
550 Klass* klass = (Klass*)ref->obj();
551 assert(klass->is_klass(), "must be");
552 if (is_excluded(klass)) {
553 ResourceMark rm;
554 log_debug(cds, dynamic)("Skipping class (excluded): %s", klass->external_name());
555 return set_to_null;
556 }
557 }
558
559 return make_a_copy;
560 }
561 }
562
563 void ArchiveBuilder::start_dump_region(DumpRegion* next) {
564 address bottom = _last_verified_top;
565 address top = (address)(current_dump_region()->top());
566 _other_region_used_bytes += size_t(top - bottom);
567
568 current_dump_region()->pack(next);
569 _current_dump_region = next;
570 _num_dump_regions_used ++;
571
572 _last_verified_top = (address)(current_dump_region()->top());
573 }
574
575 void ArchiveBuilder::verify_estimate_size(size_t estimate, const char* which) {
576 address bottom = _last_verified_top;
577 address top = (address)(current_dump_region()->top());
578 size_t used = size_t(top - bottom) + _other_region_used_bytes;
579 int diff = int(estimate) - int(used);
580
581 log_info(cds)("%s estimate = " SIZE_FORMAT " used = " SIZE_FORMAT "; diff = %d bytes", which, estimate, used, diff);
582 assert(diff >= 0, "Estimate is too small");
583
584 _last_verified_top = top;
585 _other_region_used_bytes = 0;
586 }
587
588 char* ArchiveBuilder::ro_strdup(const char* s) {
589 char* archived_str = ro_region_alloc((int)strlen(s) + 1);
590 strcpy(archived_str, s);
591 return archived_str;
592 }
593
594 // The objects that have embedded pointers will sink
595 // towards the end of the list. This ensures we have a maximum
596 // number of leading zero bits in the relocation bitmap.
597 int ArchiveBuilder::compare_src_objs(SourceObjInfo** a, SourceObjInfo** b) {
598 if ((*a)->has_embedded_pointer() && !(*b)->has_embedded_pointer()) {
599 return 1;
600 } else if (!(*a)->has_embedded_pointer() && (*b)->has_embedded_pointer()) {
601 return -1;
602 } else {
603 // This is necessary to keep the sorting order stable. Otherwise the
604 // archive's contents may not be deterministic.
605 return (*a)->id() - (*b)->id();
606 }
607 }
608
609 void ArchiveBuilder::sort_metadata_objs() {
610 _rw_src_objs.objs()->sort(compare_src_objs);
611 _ro_src_objs.objs()->sort(compare_src_objs);
612 }
613
614 void ArchiveBuilder::dump_rw_metadata() {
615 ResourceMark rm;
616 log_info(cds)("Allocating RW objects ... ");
617 make_shallow_copies(&_rw_region, &_rw_src_objs);
618
619 #if INCLUDE_CDS_JAVA_HEAP
620 if (CDSConfig::is_dumping_full_module_graph()) {
621 // Archive the ModuleEntry's and PackageEntry's of the 3 built-in loaders
622 char* start = rw_region()->top();
623 ClassLoaderDataShared::allocate_archived_tables();
624 alloc_stats()->record_modules(rw_region()->top() - start, /*read_only*/false);
625 }
626 #endif
627 }
628
629 void ArchiveBuilder::dump_ro_metadata() {
630 ResourceMark rm;
631 log_info(cds)("Allocating RO objects ... ");
632
633 start_dump_region(&_ro_region);
634 make_shallow_copies(&_ro_region, &_ro_src_objs);
635
636 #if INCLUDE_CDS_JAVA_HEAP
637 if (CDSConfig::is_dumping_full_module_graph()) {
638 char* start = ro_region()->top();
639 ClassLoaderDataShared::init_archived_tables();
640 alloc_stats()->record_modules(ro_region()->top() - start, /*read_only*/true);
641 }
642 #endif
643
644 RegeneratedClasses::record_regenerated_objects();
645 }
646
647 void ArchiveBuilder::make_shallow_copies(DumpRegion *dump_region,
648 const ArchiveBuilder::SourceObjList* src_objs) {
649 for (int i = 0; i < src_objs->objs()->length(); i++) {
650 make_shallow_copy(dump_region, src_objs->objs()->at(i));
651 }
652 log_info(cds)("done (%d objects)", src_objs->objs()->length());
653 }
654
655 void ArchiveBuilder::make_shallow_copy(DumpRegion *dump_region, SourceObjInfo* src_info) {
656 address src = src_info->source_addr();
657 int bytes = src_info->size_in_bytes();
658 char* dest;
659 char* oldtop;
660 char* newtop;
661
662 oldtop = dump_region->top();
663 if (src_info->msotype() == MetaspaceObj::ClassType) {
664 // Save a pointer immediate in front of an InstanceKlass, so
665 // we can do a quick lookup from InstanceKlass* -> RunTimeClassInfo*
666 // without building another hashtable. See RunTimeClassInfo::get_for()
667 // in systemDictionaryShared.cpp.
668 Klass* klass = (Klass*)src;
669 if (klass->is_instance_klass()) {
670 SystemDictionaryShared::validate_before_archiving(InstanceKlass::cast(klass));
671 dump_region->allocate(sizeof(address));
672 }
673 }
674 dest = dump_region->allocate(bytes);
675 newtop = dump_region->top();
676
677 memcpy(dest, src, bytes);
678
679 // Update the hash of buffered sorted symbols for static dump so that the symbols have deterministic contents
680 if (CDSConfig::is_dumping_static_archive() && (src_info->msotype() == MetaspaceObj::SymbolType)) {
681 Symbol* buffered_symbol = (Symbol*)dest;
682 assert(((Symbol*)src)->is_permanent(), "archived symbols must be permanent");
683 buffered_symbol->update_identity_hash();
684 }
685
686 {
687 bool created;
688 _buffered_to_src_table.put_if_absent((address)dest, src, &created);
689 assert(created, "must be");
690 if (_buffered_to_src_table.maybe_grow()) {
691 log_info(cds, hashtables)("Expanded _buffered_to_src_table table to %d", _buffered_to_src_table.table_size());
692 }
693 }
694
695 intptr_t* archived_vtable = CppVtables::get_archived_vtable(src_info->msotype(), (address)dest);
696 if (archived_vtable != nullptr) {
697 *(address*)dest = (address)archived_vtable;
698 ArchivePtrMarker::mark_pointer((address*)dest);
699 }
700
701 log_trace(cds)("Copy: " PTR_FORMAT " ==> " PTR_FORMAT " %d", p2i(src), p2i(dest), bytes);
702 src_info->set_buffered_addr((address)dest);
703
704 _alloc_stats.record(src_info->msotype(), int(newtop - oldtop), src_info->read_only());
705 }
706
707 // This is used by code that hand-assembles data structures, such as the LambdaProxyClassKey, that are
708 // not handled by MetaspaceClosure.
709 void ArchiveBuilder::write_pointer_in_buffer(address* ptr_location, address src_addr) {
710 assert(is_in_buffer_space(ptr_location), "must be");
711 if (src_addr == nullptr) {
712 *ptr_location = nullptr;
713 ArchivePtrMarker::clear_pointer(ptr_location);
714 } else {
715 *ptr_location = get_buffered_addr(src_addr);
716 ArchivePtrMarker::mark_pointer(ptr_location);
717 }
718 }
719
720 void ArchiveBuilder::mark_and_relocate_to_buffered_addr(address* ptr_location) {
721 assert(*ptr_location != nullptr, "sanity");
722 if (!is_in_mapped_static_archive(*ptr_location)) {
723 *ptr_location = get_buffered_addr(*ptr_location);
724 }
725 ArchivePtrMarker::mark_pointer(ptr_location);
726 }
727
728 address ArchiveBuilder::get_buffered_addr(address src_addr) const {
729 SourceObjInfo* p = _src_obj_table.get(src_addr);
730 assert(p != nullptr, "src_addr " INTPTR_FORMAT " is used but has not been archived",
731 p2i(src_addr));
732
733 return p->buffered_addr();
734 }
735
736 address ArchiveBuilder::get_source_addr(address buffered_addr) const {
737 assert(is_in_buffer_space(buffered_addr), "must be");
738 address* src_p = _buffered_to_src_table.get(buffered_addr);
739 assert(src_p != nullptr && *src_p != nullptr, "must be");
740 return *src_p;
741 }
742
743 void ArchiveBuilder::relocate_embedded_pointers(ArchiveBuilder::SourceObjList* src_objs) {
744 for (int i = 0; i < src_objs->objs()->length(); i++) {
745 src_objs->relocate(i, this);
746 }
747 }
748
749 void ArchiveBuilder::relocate_metaspaceobj_embedded_pointers() {
750 log_info(cds)("Relocating embedded pointers in core regions ... ");
751 relocate_embedded_pointers(&_rw_src_objs);
752 relocate_embedded_pointers(&_ro_src_objs);
753 }
754
755 void ArchiveBuilder::make_klasses_shareable() {
756 int num_instance_klasses = 0;
757 int num_boot_klasses = 0;
758 int num_platform_klasses = 0;
759 int num_app_klasses = 0;
760 int num_hidden_klasses = 0;
761 int num_unlinked_klasses = 0;
762 int num_unregistered_klasses = 0;
763 int num_obj_array_klasses = 0;
764 int num_type_array_klasses = 0;
765
766 for (int i = 0; i < klasses()->length(); i++) {
767 // Some of the code in ConstantPool::remove_unshareable_info() requires the classes
768 // to be in linked state, so it must be call here before the next loop, which returns
769 // all classes to unlinked state.
770 Klass* k = get_buffered_addr(klasses()->at(i));
771 if (k->is_instance_klass()) {
772 InstanceKlass::cast(k)->constants()->remove_unshareable_info();
773 }
774 }
775
776 for (int i = 0; i < klasses()->length(); i++) {
777 const char* type;
778 const char* unlinked = "";
779 const char* hidden = "";
780 const char* generated = "";
781 Klass* k = get_buffered_addr(klasses()->at(i));
782 k->remove_java_mirror();
783 if (k->is_objArray_klass()) {
784 // InstanceKlass and TypeArrayKlass will in turn call remove_unshareable_info
785 // on their array classes.
786 num_obj_array_klasses ++;
787 type = "array";
788 } else if (k->is_typeArray_klass()) {
789 num_type_array_klasses ++;
790 type = "array";
791 k->remove_unshareable_info();
792 } else {
793 assert(k->is_instance_klass(), " must be");
794 num_instance_klasses ++;
795 InstanceKlass* ik = InstanceKlass::cast(k);
796 if (ik->is_shared_boot_class()) {
797 type = "boot";
798 num_boot_klasses ++;
799 } else if (ik->is_shared_platform_class()) {
800 type = "plat";
801 num_platform_klasses ++;
802 } else if (ik->is_shared_app_class()) {
803 type = "app";
804 num_app_klasses ++;
805 } else {
806 assert(ik->is_shared_unregistered_class(), "must be");
807 type = "unreg";
808 num_unregistered_klasses ++;
809 }
810
811 if (!ik->is_linked()) {
812 num_unlinked_klasses ++;
813 unlinked = " ** unlinked";
814 }
815
816 if (ik->is_hidden()) {
817 num_hidden_klasses ++;
818 hidden = " ** hidden";
819 }
820
821 if (ik->is_generated_shared_class()) {
822 generated = " ** generated";
823 }
824 MetaspaceShared::rewrite_nofast_bytecodes_and_calculate_fingerprints(Thread::current(), ik);
825 ik->remove_unshareable_info();
826 }
827
828 if (log_is_enabled(Debug, cds, class)) {
829 ResourceMark rm;
830 log_debug(cds, class)("klasses[%5d] = " PTR_FORMAT " %-5s %s%s%s%s", i,
831 p2i(to_requested(k)), type, k->external_name(),
832 hidden, unlinked, generated);
833 }
834 }
835
836 log_info(cds)("Number of classes %d", num_instance_klasses + num_obj_array_klasses + num_type_array_klasses);
837 log_info(cds)(" instance classes = %5d", num_instance_klasses);
838 log_info(cds)(" boot = %5d", num_boot_klasses);
839 log_info(cds)(" app = %5d", num_app_klasses);
840 log_info(cds)(" platform = %5d", num_platform_klasses);
841 log_info(cds)(" unregistered = %5d", num_unregistered_klasses);
842 log_info(cds)(" (hidden) = %5d", num_hidden_klasses);
843 log_info(cds)(" (unlinked) = %5d", num_unlinked_klasses);
844 log_info(cds)(" obj array classes = %5d", num_obj_array_klasses);
845 log_info(cds)(" type array classes = %5d", num_type_array_klasses);
846 log_info(cds)(" symbols = %5d", _symbols->length());
847
848 DynamicArchive::make_array_klasses_shareable();
849 }
850
851 void ArchiveBuilder::serialize_dynamic_archivable_items(SerializeClosure* soc) {
852 SymbolTable::serialize_shared_table_header(soc, false);
853 SystemDictionaryShared::serialize_dictionary_headers(soc, false);
854 DynamicArchive::serialize_array_klasses(soc);
855 }
856
857 uintx ArchiveBuilder::buffer_to_offset(address p) const {
858 address requested_p = to_requested(p);
859 assert(requested_p >= _requested_static_archive_bottom, "must be");
860 return requested_p - _requested_static_archive_bottom;
861 }
862
863 uintx ArchiveBuilder::any_to_offset(address p) const {
864 if (is_in_mapped_static_archive(p)) {
865 assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
866 return p - _mapped_static_archive_bottom;
867 }
868 if (!is_in_buffer_space(p)) {
869 // p must be a "source" address
870 p = get_buffered_addr(p);
871 }
872 return buffer_to_offset(p);
873 }
874
875 #if INCLUDE_CDS_JAVA_HEAP
876 narrowKlass ArchiveBuilder::get_requested_narrow_klass(Klass* k) {
877 assert(CDSConfig::is_dumping_heap(), "sanity");
878 k = get_buffered_klass(k);
879 Klass* requested_k = to_requested(k);
880 address narrow_klass_base = _requested_static_archive_bottom; // runtime encoding base == runtime mapping start
881 const int narrow_klass_shift = ArchiveHeapWriter::precomputed_narrow_klass_shift;
882 return CompressedKlassPointers::encode_not_null(requested_k, narrow_klass_base, narrow_klass_shift);
883 }
884 #endif // INCLUDE_CDS_JAVA_HEAP
885
886 // RelocateBufferToRequested --- Relocate all the pointers in rw/ro,
887 // so that the archive can be mapped to the "requested" location without runtime relocation.
888 //
889 // - See ArchiveBuilder header for the definition of "buffer", "mapped" and "requested"
890 // - ArchivePtrMarker::ptrmap() marks all the pointers in the rw/ro regions
891 // - Every pointer must have one of the following values:
892 // [a] nullptr:
893 // No relocation is needed. Remove this pointer from ptrmap so we don't need to
894 // consider it at runtime.
895 // [b] Points into an object X which is inside the buffer:
896 // Adjust this pointer by _buffer_to_requested_delta, so it points to X
897 // when the archive is mapped at the requested location.
898 // [c] Points into an object Y which is inside mapped static archive:
899 // - This happens only during dynamic dump
900 // - Adjust this pointer by _mapped_to_requested_static_archive_delta,
901 // so it points to Y when the static archive is mapped at the requested location.
902 template <bool STATIC_DUMP>
903 class RelocateBufferToRequested : public BitMapClosure {
904 ArchiveBuilder* _builder;
905 address _buffer_bottom;
906 intx _buffer_to_requested_delta;
907 intx _mapped_to_requested_static_archive_delta;
908 size_t _max_non_null_offset;
909
910 public:
911 RelocateBufferToRequested(ArchiveBuilder* builder) {
912 _builder = builder;
913 _buffer_bottom = _builder->buffer_bottom();
914 _buffer_to_requested_delta = builder->buffer_to_requested_delta();
915 _mapped_to_requested_static_archive_delta = builder->requested_static_archive_bottom() - builder->mapped_static_archive_bottom();
916 _max_non_null_offset = 0;
917
918 address bottom = _builder->buffer_bottom();
919 address top = _builder->buffer_top();
920 address new_bottom = bottom + _buffer_to_requested_delta;
921 address new_top = top + _buffer_to_requested_delta;
922 log_debug(cds)("Relocating archive from [" INTPTR_FORMAT " - " INTPTR_FORMAT "] to "
923 "[" INTPTR_FORMAT " - " INTPTR_FORMAT "]",
924 p2i(bottom), p2i(top),
925 p2i(new_bottom), p2i(new_top));
926 }
927
928 bool do_bit(size_t offset) {
929 address* p = (address*)_buffer_bottom + offset;
930 assert(_builder->is_in_buffer_space(p), "pointer must live in buffer space");
931
932 if (*p == nullptr) {
933 // todo -- clear bit, etc
934 ArchivePtrMarker::ptrmap()->clear_bit(offset);
935 } else {
936 if (STATIC_DUMP) {
937 assert(_builder->is_in_buffer_space(*p), "old pointer must point inside buffer space");
938 *p += _buffer_to_requested_delta;
939 assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
940 } else {
941 if (_builder->is_in_buffer_space(*p)) {
942 *p += _buffer_to_requested_delta;
943 // assert is in requested dynamic archive
944 } else {
945 assert(_builder->is_in_mapped_static_archive(*p), "old pointer must point inside buffer space or mapped static archive");
946 *p += _mapped_to_requested_static_archive_delta;
947 assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
948 }
949 }
950 _max_non_null_offset = offset;
951 }
952
953 return true; // keep iterating
954 }
955
956 void doit() {
957 ArchivePtrMarker::ptrmap()->iterate(this);
958 ArchivePtrMarker::compact(_max_non_null_offset);
959 }
960 };
961
962
963 void ArchiveBuilder::relocate_to_requested() {
964 ro_region()->pack();
965
966 size_t my_archive_size = buffer_top() - buffer_bottom();
967
968 if (CDSConfig::is_dumping_static_archive()) {
969 _requested_static_archive_top = _requested_static_archive_bottom + my_archive_size;
970 RelocateBufferToRequested<true> patcher(this);
971 patcher.doit();
972 } else {
973 assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
974 _requested_dynamic_archive_top = _requested_dynamic_archive_bottom + my_archive_size;
975 RelocateBufferToRequested<false> patcher(this);
976 patcher.doit();
977 }
978 }
979
980 // Write detailed info to a mapfile to analyze contents of the archive.
981 // static dump:
982 // java -Xshare:dump -Xlog:cds+map=trace:file=cds.map:none:filesize=0
983 // dynamic dump:
984 // java -cp MyApp.jar -XX:ArchiveClassesAtExit=MyApp.jsa \
985 // -Xlog:cds+map=trace:file=cds.map:none:filesize=0 MyApp
986 //
987 // We need to do some address translation because the buffers used at dump time may be mapped to
988 // a different location at runtime. At dump time, the buffers may be at arbitrary locations
989 // picked by the OS. At runtime, we try to map at a fixed location (SharedBaseAddress). For
990 // consistency, we log everything using runtime addresses.
991 class ArchiveBuilder::CDSMapLogger : AllStatic {
992 static intx buffer_to_runtime_delta() {
993 // Translate the buffers used by the RW/RO regions to their eventual (requested) locations
994 // at runtime.
995 return ArchiveBuilder::current()->buffer_to_requested_delta();
996 }
997
998 // rw/ro regions only
999 static void log_metaspace_region(const char* name, DumpRegion* region,
1000 const ArchiveBuilder::SourceObjList* src_objs) {
1001 address region_base = address(region->base());
1002 address region_top = address(region->top());
1003 log_region(name, region_base, region_top, region_base + buffer_to_runtime_delta());
1004 log_metaspace_objects(region, src_objs);
1005 }
1006
1007 #define _LOG_PREFIX PTR_FORMAT ": @@ %-17s %d"
1008
1009 static void log_klass(Klass* k, address runtime_dest, const char* type_name, int bytes, Thread* current) {
1010 ResourceMark rm(current);
1011 log_debug(cds, map)(_LOG_PREFIX " %s",
1012 p2i(runtime_dest), type_name, bytes, k->external_name());
1013 }
1014 static void log_method(Method* m, address runtime_dest, const char* type_name, int bytes, Thread* current) {
1015 ResourceMark rm(current);
1016 log_debug(cds, map)(_LOG_PREFIX " %s",
1017 p2i(runtime_dest), type_name, bytes, m->external_name());
1018 }
1019
1020 // rw/ro regions only
1021 static void log_metaspace_objects(DumpRegion* region, const ArchiveBuilder::SourceObjList* src_objs) {
1022 address last_obj_base = address(region->base());
1023 address last_obj_end = address(region->base());
1024 address region_end = address(region->end());
1025 Thread* current = Thread::current();
1026 for (int i = 0; i < src_objs->objs()->length(); i++) {
1027 SourceObjInfo* src_info = src_objs->at(i);
1028 address src = src_info->source_addr();
1029 address dest = src_info->buffered_addr();
1030 log_as_hex(last_obj_base, dest, last_obj_base + buffer_to_runtime_delta());
1031 address runtime_dest = dest + buffer_to_runtime_delta();
1032 int bytes = src_info->size_in_bytes();
1033
1034 MetaspaceObj::Type type = src_info->msotype();
1035 const char* type_name = MetaspaceObj::type_name(type);
1036
1037 switch (type) {
1038 case MetaspaceObj::ClassType:
1039 log_klass((Klass*)src, runtime_dest, type_name, bytes, current);
1040 break;
1041 case MetaspaceObj::ConstantPoolType:
1042 log_klass(((ConstantPool*)src)->pool_holder(),
1043 runtime_dest, type_name, bytes, current);
1044 break;
1045 case MetaspaceObj::ConstantPoolCacheType:
1046 log_klass(((ConstantPoolCache*)src)->constant_pool()->pool_holder(),
1047 runtime_dest, type_name, bytes, current);
1048 break;
1049 case MetaspaceObj::MethodType:
1050 log_method((Method*)src, runtime_dest, type_name, bytes, current);
1051 break;
1052 case MetaspaceObj::ConstMethodType:
1053 log_method(((ConstMethod*)src)->method(), runtime_dest, type_name, bytes, current);
1054 break;
1055 case MetaspaceObj::SymbolType:
1056 {
1057 ResourceMark rm(current);
1058 Symbol* s = (Symbol*)src;
1059 log_debug(cds, map)(_LOG_PREFIX " %s", p2i(runtime_dest), type_name, bytes,
1060 s->as_quoted_ascii());
1061 }
1062 break;
1063 default:
1064 log_debug(cds, map)(_LOG_PREFIX, p2i(runtime_dest), type_name, bytes);
1065 break;
1066 }
1067
1068 last_obj_base = dest;
1069 last_obj_end = dest + bytes;
1070 }
1071
1072 log_as_hex(last_obj_base, last_obj_end, last_obj_base + buffer_to_runtime_delta());
1073 if (last_obj_end < region_end) {
1074 log_debug(cds, map)(PTR_FORMAT ": @@ Misc data " SIZE_FORMAT " bytes",
1075 p2i(last_obj_end + buffer_to_runtime_delta()),
1076 size_t(region_end - last_obj_end));
1077 log_as_hex(last_obj_end, region_end, last_obj_end + buffer_to_runtime_delta());
1078 }
1079 }
1080
1081 #undef _LOG_PREFIX
1082
1083 // Log information about a region, whose address at dump time is [base .. top). At
1084 // runtime, this region will be mapped to requested_base. requested_base is 0 if this
1085 // region will be mapped at os-selected addresses (such as the bitmap region), or will
1086 // be accessed with os::read (the header).
1087 //
1088 // Note: across -Xshare:dump runs, base may be different, but requested_base should
1089 // be the same as the archive contents should be deterministic.
1090 static void log_region(const char* name, address base, address top, address requested_base) {
1091 size_t size = top - base;
1092 base = requested_base;
1093 top = requested_base + size;
1094 log_info(cds, map)("[%-18s " PTR_FORMAT " - " PTR_FORMAT " " SIZE_FORMAT_W(9) " bytes]",
1095 name, p2i(base), p2i(top), size);
1096 }
1097
1098 #if INCLUDE_CDS_JAVA_HEAP
1099 static void log_heap_region(ArchiveHeapInfo* heap_info) {
1100 MemRegion r = heap_info->buffer_region();
1101 address start = address(r.start()); // start of the current oop inside the buffer
1102 address end = address(r.end());
1103 log_region("heap", start, end, ArchiveHeapWriter::buffered_addr_to_requested_addr(start));
1104
1105 LogStreamHandle(Info, cds, map) st;
1106
1107 while (start < end) {
1108 size_t byte_size;
1109 oop source_oop = ArchiveHeapWriter::buffered_addr_to_source_obj(start);
1110 address requested_start = ArchiveHeapWriter::buffered_addr_to_requested_addr(start);
1111 st.print(PTR_FORMAT ": @@ Object ", p2i(requested_start));
1112
1113 if (source_oop != nullptr) {
1114 // This is a regular oop that got archived.
1115 print_oop_with_requested_addr_cr(&st, source_oop, false);
1116 byte_size = source_oop->size() * BytesPerWord;
1117 } else if (start == ArchiveHeapWriter::buffered_heap_roots_addr()) {
1118 // HeapShared::roots() is copied specially, so it doesn't exist in
1119 // ArchiveHeapWriter::BufferOffsetToSourceObjectTable.
1120 // See ArchiveHeapWriter::copy_roots_to_buffer().
1121 st.print_cr("HeapShared::roots[%d]", HeapShared::pending_roots()->length());
1122 byte_size = ArchiveHeapWriter::heap_roots_word_size() * BytesPerWord;
1123 } else if ((byte_size = ArchiveHeapWriter::get_filler_size_at(start)) > 0) {
1124 // We have a filler oop, which also does not exist in BufferOffsetToSourceObjectTable.
1125 st.print_cr("filler " SIZE_FORMAT " bytes", byte_size);
1126 } else {
1127 ShouldNotReachHere();
1128 }
1129
1130 address oop_end = start + byte_size;
1131 log_as_hex(start, oop_end, requested_start, /*is_heap=*/true);
1132
1133 if (source_oop != nullptr) {
1134 log_oop_details(heap_info, source_oop, /*buffered_addr=*/start);
1135 } else if (start == ArchiveHeapWriter::buffered_heap_roots_addr()) {
1136 log_heap_roots();
1137 }
1138 start = oop_end;
1139 }
1140 }
1141
1142 // ArchivedFieldPrinter is used to print the fields of archived objects. We can't
1143 // use _source_obj->print_on(), because we want to print the oop fields
1144 // in _source_obj with their requested addresses using print_oop_with_requested_addr_cr().
1145 class ArchivedFieldPrinter : public FieldClosure {
1146 ArchiveHeapInfo* _heap_info;
1147 outputStream* _st;
1148 oop _source_obj;
1149 address _buffered_addr;
1150 public:
1151 ArchivedFieldPrinter(ArchiveHeapInfo* heap_info, outputStream* st, oop src_obj, address buffered_addr) :
1152 _heap_info(heap_info), _st(st), _source_obj(src_obj), _buffered_addr(buffered_addr) {}
1153
1154 void do_field(fieldDescriptor* fd) {
1155 _st->print(" - ");
1156 BasicType ft = fd->field_type();
1157 switch (ft) {
1158 case T_ARRAY:
1159 case T_OBJECT:
1160 fd->print_on(_st); // print just the name and offset
1161 print_oop_with_requested_addr_cr(_st, _source_obj->obj_field(fd->offset()));
1162 break;
1163 default:
1164 if (ArchiveHeapWriter::is_marked_as_native_pointer(_heap_info, _source_obj, fd->offset())) {
1165 print_as_native_pointer(fd);
1166 } else {
1167 fd->print_on_for(_st, cast_to_oop(_buffered_addr)); // name, offset, value
1168 _st->cr();
1169 }
1170 }
1171 }
1172
1173 void print_as_native_pointer(fieldDescriptor* fd) {
1174 LP64_ONLY(assert(fd->field_type() == T_LONG, "must be"));
1175 NOT_LP64 (assert(fd->field_type() == T_INT, "must be"));
1176
1177 // We have a field that looks like an integer, but it's actually a pointer to a MetaspaceObj.
1178 address source_native_ptr = (address)
1179 LP64_ONLY(_source_obj->long_field(fd->offset()))
1180 NOT_LP64( _source_obj->int_field (fd->offset()));
1181 ArchiveBuilder* builder = ArchiveBuilder::current();
1182
1183 // The value of the native pointer at runtime.
1184 address requested_native_ptr = builder->to_requested(builder->get_buffered_addr(source_native_ptr));
1185
1186 // The address of _source_obj at runtime
1187 oop requested_obj = ArchiveHeapWriter::source_obj_to_requested_obj(_source_obj);
1188 // The address of this field in the requested space
1189 assert(requested_obj != nullptr, "Attempting to load field from null oop");
1190 address requested_field_addr = cast_from_oop<address>(requested_obj) + fd->offset();
1191
1192 fd->print_on(_st);
1193 _st->print_cr(PTR_FORMAT " (marked metadata pointer @" PTR_FORMAT " )",
1194 p2i(requested_native_ptr), p2i(requested_field_addr));
1195 }
1196 };
1197
1198 // Print the fields of instanceOops, or the elements of arrayOops
1199 static void log_oop_details(ArchiveHeapInfo* heap_info, oop source_oop, address buffered_addr) {
1200 LogStreamHandle(Trace, cds, map, oops) st;
1201 if (st.is_enabled()) {
1202 Klass* source_klass = source_oop->klass();
1203 ArchiveBuilder* builder = ArchiveBuilder::current();
1204 Klass* requested_klass = builder->to_requested(builder->get_buffered_addr(source_klass));
1205
1206 st.print(" - klass: ");
1207 source_klass->print_value_on(&st);
1208 st.print(" " PTR_FORMAT, p2i(requested_klass));
1209 st.cr();
1210
1211 if (source_oop->is_typeArray()) {
1212 TypeArrayKlass::cast(source_klass)->oop_print_elements_on(typeArrayOop(source_oop), &st);
1213 } else if (source_oop->is_objArray()) {
1214 objArrayOop source_obj_array = objArrayOop(source_oop);
1215 for (int i = 0; i < source_obj_array->length(); i++) {
1216 st.print(" -%4d: ", i);
1217 print_oop_with_requested_addr_cr(&st, source_obj_array->obj_at(i));
1218 }
1219 } else {
1220 st.print_cr(" - fields (" SIZE_FORMAT " words):", source_oop->size());
1221 ArchivedFieldPrinter print_field(heap_info, &st, source_oop, buffered_addr);
1222 InstanceKlass::cast(source_klass)->print_nonstatic_fields(&print_field);
1223 }
1224 }
1225 }
1226
1227 static void log_heap_roots() {
1228 LogStreamHandle(Trace, cds, map, oops) st;
1229 if (st.is_enabled()) {
1230 for (int i = 0; i < HeapShared::pending_roots()->length(); i++) {
1231 st.print("roots[%4d]: ", i);
1232 print_oop_with_requested_addr_cr(&st, HeapShared::pending_roots()->at(i));
1233 }
1234 }
1235 }
1236
1237 // The output looks like this. The first number is the requested address. The second number is
1238 // the narrowOop version of the requested address.
1239 // 0x00000007ffc7e840 (0xfff8fd08) java.lang.Class
1240 // 0x00000007ffc000f8 (0xfff8001f) [B length: 11
1241 static void print_oop_with_requested_addr_cr(outputStream* st, oop source_oop, bool print_addr = true) {
1242 if (source_oop == nullptr) {
1243 st->print_cr("null");
1244 } else {
1245 ResourceMark rm;
1246 oop requested_obj = ArchiveHeapWriter::source_obj_to_requested_obj(source_oop);
1247 if (print_addr) {
1248 st->print(PTR_FORMAT " ", p2i(requested_obj));
1249 }
1250 if (UseCompressedOops) {
1251 st->print("(0x%08x) ", CompressedOops::narrow_oop_value(requested_obj));
1252 }
1253 if (source_oop->is_array()) {
1254 int array_len = arrayOop(source_oop)->length();
1255 st->print_cr("%s length: %d", source_oop->klass()->external_name(), array_len);
1256 } else {
1257 st->print_cr("%s", source_oop->klass()->external_name());
1258 }
1259 }
1260 }
1261 #endif // INCLUDE_CDS_JAVA_HEAP
1262
1263 // Log all the data [base...top). Pretend that the base address
1264 // will be mapped to requested_base at run-time.
1265 static void log_as_hex(address base, address top, address requested_base, bool is_heap = false) {
1266 assert(top >= base, "must be");
1267
1268 LogStreamHandle(Trace, cds, map) lsh;
1269 if (lsh.is_enabled()) {
1270 int unitsize = sizeof(address);
1271 if (is_heap && UseCompressedOops) {
1272 // This makes the compressed oop pointers easier to read, but
1273 // longs and doubles will be split into two words.
1274 unitsize = sizeof(narrowOop);
1275 }
1276 os::print_hex_dump(&lsh, base, top, unitsize, 32, requested_base);
1277 }
1278 }
1279
1280 static void log_header(FileMapInfo* mapinfo) {
1281 LogStreamHandle(Info, cds, map) lsh;
1282 if (lsh.is_enabled()) {
1283 mapinfo->print(&lsh);
1284 }
1285 }
1286
1287 public:
1288 static void log(ArchiveBuilder* builder, FileMapInfo* mapinfo,
1289 ArchiveHeapInfo* heap_info,
1290 char* bitmap, size_t bitmap_size_in_bytes) {
1291 log_info(cds, map)("%s CDS archive map for %s", CDSConfig::is_dumping_static_archive() ? "Static" : "Dynamic", mapinfo->full_path());
1292
1293 address header = address(mapinfo->header());
1294 address header_end = header + mapinfo->header()->header_size();
1295 log_region("header", header, header_end, 0);
1296 log_header(mapinfo);
1297 log_as_hex(header, header_end, 0);
1298
1299 DumpRegion* rw_region = &builder->_rw_region;
1300 DumpRegion* ro_region = &builder->_ro_region;
1301
1302 log_metaspace_region("rw region", rw_region, &builder->_rw_src_objs);
1303 log_metaspace_region("ro region", ro_region, &builder->_ro_src_objs);
1304
1305 address bitmap_end = address(bitmap + bitmap_size_in_bytes);
1306 log_region("bitmap", address(bitmap), bitmap_end, 0);
1307 log_as_hex((address)bitmap, bitmap_end, 0);
1308
1309 #if INCLUDE_CDS_JAVA_HEAP
1310 if (heap_info->is_used()) {
1311 log_heap_region(heap_info);
1312 }
1313 #endif
1314
1315 log_info(cds, map)("[End of CDS archive map]");
1316 }
1317 }; // end ArchiveBuilder::CDSMapLogger
1318
1319 void ArchiveBuilder::print_stats() {
1320 _alloc_stats.print_stats(int(_ro_region.used()), int(_rw_region.used()));
1321 }
1322
1323 void ArchiveBuilder::write_archive(FileMapInfo* mapinfo, ArchiveHeapInfo* heap_info) {
1324 // Make sure NUM_CDS_REGIONS (exported in cds.h) agrees with
1325 // MetaspaceShared::n_regions (internal to hotspot).
1326 assert(NUM_CDS_REGIONS == MetaspaceShared::n_regions, "sanity");
1327
1328 write_region(mapinfo, MetaspaceShared::rw, &_rw_region, /*read_only=*/false,/*allow_exec=*/false);
1329 write_region(mapinfo, MetaspaceShared::ro, &_ro_region, /*read_only=*/true, /*allow_exec=*/false);
1330
1331 // Split pointer map into read-write and read-only bitmaps
1332 ArchivePtrMarker::initialize_rw_ro_maps(&_rw_ptrmap, &_ro_ptrmap);
1333
1334 size_t bitmap_size_in_bytes;
1335 char* bitmap = mapinfo->write_bitmap_region(ArchivePtrMarker::rw_ptrmap(), ArchivePtrMarker::ro_ptrmap(), heap_info,
1336 bitmap_size_in_bytes);
1337
1338 if (heap_info->is_used()) {
1339 _total_heap_region_size = mapinfo->write_heap_region(heap_info);
1340 }
1341
1342 print_region_stats(mapinfo, heap_info);
1343
1344 mapinfo->set_requested_base((char*)MetaspaceShared::requested_base_address());
1345 mapinfo->set_header_crc(mapinfo->compute_header_crc());
1346 // After this point, we should not write any data into mapinfo->header() since this
1347 // would corrupt its checksum we have calculated before.
1348 mapinfo->write_header();
1349 mapinfo->close();
1350
1351 if (log_is_enabled(Info, cds)) {
1352 print_stats();
1353 }
1354
1355 if (log_is_enabled(Info, cds, map)) {
1356 CDSMapLogger::log(this, mapinfo, heap_info,
1357 bitmap, bitmap_size_in_bytes);
1358 }
1359 CDS_JAVA_HEAP_ONLY(HeapShared::destroy_archived_object_cache());
1360 FREE_C_HEAP_ARRAY(char, bitmap);
1361 }
1362
1363 void ArchiveBuilder::write_region(FileMapInfo* mapinfo, int region_idx, DumpRegion* dump_region, bool read_only, bool allow_exec) {
1364 mapinfo->write_region(region_idx, dump_region->base(), dump_region->used(), read_only, allow_exec);
1365 }
1366
1367 void ArchiveBuilder::print_region_stats(FileMapInfo *mapinfo, ArchiveHeapInfo* heap_info) {
1368 // Print statistics of all the regions
1369 const size_t bitmap_used = mapinfo->region_at(MetaspaceShared::bm)->used();
1370 const size_t bitmap_reserved = mapinfo->region_at(MetaspaceShared::bm)->used_aligned();
1371 const size_t total_reserved = _ro_region.reserved() + _rw_region.reserved() +
1372 bitmap_reserved +
1373 _total_heap_region_size;
1374 const size_t total_bytes = _ro_region.used() + _rw_region.used() +
1375 bitmap_used +
1376 _total_heap_region_size;
1377 const double total_u_perc = percent_of(total_bytes, total_reserved);
1378
1379 _rw_region.print(total_reserved);
1380 _ro_region.print(total_reserved);
1381
1382 print_bitmap_region_stats(bitmap_used, total_reserved);
1383
1384 if (heap_info->is_used()) {
1385 print_heap_region_stats(heap_info, total_reserved);
1386 }
1387
1388 log_debug(cds)("total : " SIZE_FORMAT_W(9) " [100.0%% of total] out of " SIZE_FORMAT_W(9) " bytes [%5.1f%% used]",
1389 total_bytes, total_reserved, total_u_perc);
1390 }
1391
1392 void ArchiveBuilder::print_bitmap_region_stats(size_t size, size_t total_size) {
1393 log_debug(cds)("bm space: " SIZE_FORMAT_W(9) " [ %4.1f%% of total] out of " SIZE_FORMAT_W(9) " bytes [100.0%% used]",
1394 size, size/double(total_size)*100.0, size);
1395 }
1396
1397 void ArchiveBuilder::print_heap_region_stats(ArchiveHeapInfo *info, size_t total_size) {
1398 char* start = info->buffer_start();
1399 size_t size = info->buffer_byte_size();
1400 char* top = start + size;
1401 log_debug(cds)("hp space: " SIZE_FORMAT_W(9) " [ %4.1f%% of total] out of " SIZE_FORMAT_W(9) " bytes [100.0%% used] at " INTPTR_FORMAT,
1402 size, size/double(total_size)*100.0, size, p2i(start));
1403 }
1404
1405 void ArchiveBuilder::report_out_of_space(const char* name, size_t needed_bytes) {
1406 // This is highly unlikely to happen on 64-bits because we have reserved a 4GB space.
1407 // On 32-bit we reserve only 256MB so you could run out of space with 100,000 classes
1408 // or so.
1409 _rw_region.print_out_of_space_msg(name, needed_bytes);
1410 _ro_region.print_out_of_space_msg(name, needed_bytes);
1411
1412 log_error(cds)("Unable to allocate from '%s' region: Please reduce the number of shared classes.", name);
1413 MetaspaceShared::unrecoverable_writing_error();
1414 }
1415
1416
1417 #ifndef PRODUCT
1418 void ArchiveBuilder::assert_is_vm_thread() {
1419 assert(Thread::current()->is_VM_thread(), "ArchiveBuilder should be used only inside the VMThread");
1420 }
1421 #endif