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