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