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) {
  62   _total_bytes = 0;
  63   _objs = new (ResourceObj::C_HEAP, 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   _rw_src_objs(),
 159   _ro_src_objs(),
 160   _src_obj_table(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE),
 161   _buffered_to_src_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     address src_obj = ref->obj();
 426     size_t field_offset = pointer_delta(p, src_obj,  sizeof(u1));
 427     _builder->add_special_ref(type, src_obj, field_offset, ref->size() * BytesPerWord);
 428   };
 429 
 430   virtual void do_pending_ref(Ref* ref) {
 431     if (ref->obj() != NULL) {
 432       _builder->remember_embedded_pointer_in_copied_obj(enclosing_ref(), ref);
 433     }
 434   }
 435 };
 436 
 437 bool ArchiveBuilder::gather_one_source_obj(MetaspaceClosure::Ref* enclosing_ref,
 438                                            MetaspaceClosure::Ref* ref, bool read_only) {
 439   address src_obj = ref->obj();
 440   if (src_obj == NULL) {
 441     return false;
 442   }
 443   ref->set_keep_after_pushing();
 444   remember_embedded_pointer_in_copied_obj(enclosing_ref, ref);
 445 
 446   FollowMode follow_mode = get_follow_mode(ref);
 447   SourceObjInfo src_info(ref, read_only, follow_mode);
 448   bool created;
 449   SourceObjInfo* p = _src_obj_table.put_if_absent(src_obj, src_info, &created);
 450   if (created) {
 451     if (_src_obj_table.maybe_grow()) {
 452       log_info(cds, hashtables)("Expanded _src_obj_table table to %d", _src_obj_table.table_size());
 453     }
 454   }
 455 
 456   assert(p->read_only() == src_info.read_only(), "must be");
 457 
 458   if (created && src_info.should_copy()) {
 459     ref->set_user_data((void*)p);
 460     if (read_only) {
 461       _ro_src_objs.append(enclosing_ref, p);
 462     } else {
 463       _rw_src_objs.append(enclosing_ref, p);
 464     }
 465     return true; // Need to recurse into this ref only if we are copying it
 466   } else {
 467     return false;
 468   }
 469 }
 470 
 471 void ArchiveBuilder::remember_embedded_pointer_in_copied_obj(MetaspaceClosure::Ref* enclosing_ref,
 472                                                              MetaspaceClosure::Ref* ref) {
 473   assert(ref->obj() != NULL, "should have checked");
 474 
 475   if (enclosing_ref != NULL) {
 476     SourceObjInfo* src_info = (SourceObjInfo*)enclosing_ref->user_data();
 477     if (src_info == NULL) {
 478       // source objects of point_to_it/set_to_null types are not copied
 479       // so we don't need to remember their pointers.
 480     } else {
 481       if (src_info->read_only()) {
 482         _ro_src_objs.remember_embedded_pointer(src_info, ref);
 483       } else {
 484         _rw_src_objs.remember_embedded_pointer(src_info, ref);
 485       }
 486     }
 487   }
 488 }
 489 
 490 void ArchiveBuilder::gather_source_objs() {
 491   ResourceMark rm;
 492   log_info(cds)("Gathering all archivable objects ... ");
 493   gather_klasses_and_symbols();
 494   GatherSortedSourceObjs doit(this);
 495   iterate_sorted_roots(&doit, /*is_relocating_pointers=*/false);
 496   doit.finish();
 497 }
 498 
 499 bool ArchiveBuilder::is_excluded(Klass* klass) {
 500   if (klass->is_instance_klass()) {
 501     InstanceKlass* ik = InstanceKlass::cast(klass);
 502     return SystemDictionaryShared::is_excluded_class(ik);
 503   } else if (klass->is_objArray_klass()) {
 504     if (DynamicDumpSharedSpaces) {
 505       // Don't support archiving of array klasses for now (WHY???)
 506       return true;
 507     }
 508     Klass* bottom = ObjArrayKlass::cast(klass)->bottom_klass();
 509     if (bottom->is_instance_klass()) {
 510       return SystemDictionaryShared::is_excluded_class(InstanceKlass::cast(bottom));
 511     }
 512   }
 513 
 514   return false;
 515 }
 516 
 517 ArchiveBuilder::FollowMode ArchiveBuilder::get_follow_mode(MetaspaceClosure::Ref *ref) {
 518   address obj = ref->obj();
 519   if (MetaspaceShared::is_in_shared_metaspace(obj)) {
 520     // Don't dump existing shared metadata again.
 521     return point_to_it;
 522   } else if (ref->msotype() == MetaspaceObj::MethodDataType ||
 523              ref->msotype() == MetaspaceObj::MethodCountersType) {
 524     return set_to_null;
 525   } else {
 526     if (ref->msotype() == MetaspaceObj::ClassType) {
 527       Klass* klass = (Klass*)ref->obj();
 528       assert(klass->is_klass(), "must be");
 529       if (is_excluded(klass)) {
 530         ResourceMark rm;
 531         log_debug(cds, dynamic)("Skipping class (excluded): %s", klass->external_name());
 532         return set_to_null;
 533       }
 534     }
 535 
 536     return make_a_copy;
 537   }
 538 }
 539 
 540 void ArchiveBuilder::start_dump_space(DumpRegion* next) {
 541   address bottom = _last_verified_top;
 542   address top = (address)(current_dump_space()->top());
 543   _other_region_used_bytes += size_t(top - bottom);
 544 
 545   current_dump_space()->pack(next);
 546   _current_dump_space = next;
 547   _num_dump_regions_used ++;
 548 
 549   _last_verified_top = (address)(current_dump_space()->top());
 550 }
 551 
 552 void ArchiveBuilder::verify_estimate_size(size_t estimate, const char* which) {
 553   address bottom = _last_verified_top;
 554   address top = (address)(current_dump_space()->top());
 555   size_t used = size_t(top - bottom) + _other_region_used_bytes;
 556   int diff = int(estimate) - int(used);
 557 
 558   log_info(cds)("%s estimate = " SIZE_FORMAT " used = " SIZE_FORMAT "; diff = %d bytes", which, estimate, used, diff);
 559   assert(diff >= 0, "Estimate is too small");
 560 
 561   _last_verified_top = top;
 562   _other_region_used_bytes = 0;
 563 }
 564 
 565 void ArchiveBuilder::dump_rw_metadata() {
 566   ResourceMark rm;
 567   log_info(cds)("Allocating RW objects ... ");
 568   make_shallow_copies(&_rw_region, &_rw_src_objs);
 569 
 570 #if INCLUDE_CDS_JAVA_HEAP
 571   if (is_dumping_full_module_graph()) {
 572     // Archive the ModuleEntry's and PackageEntry's of the 3 built-in loaders
 573     char* start = rw_region()->top();
 574     ClassLoaderDataShared::allocate_archived_tables();
 575     alloc_stats()->record_modules(rw_region()->top() - start, /*read_only*/false);
 576   }
 577 #endif
 578 }
 579 
 580 void ArchiveBuilder::dump_ro_metadata() {
 581   ResourceMark rm;
 582   log_info(cds)("Allocating RO objects ... ");
 583 
 584   start_dump_space(&_ro_region);
 585   make_shallow_copies(&_ro_region, &_ro_src_objs);
 586 
 587 #if INCLUDE_CDS_JAVA_HEAP
 588   if (is_dumping_full_module_graph()) {
 589     char* start = ro_region()->top();
 590     ClassLoaderDataShared::init_archived_tables();
 591     alloc_stats()->record_modules(ro_region()->top() - start, /*read_only*/true);
 592   }
 593 #endif
 594 }
 595 
 596 void ArchiveBuilder::make_shallow_copies(DumpRegion *dump_region,
 597                                          const ArchiveBuilder::SourceObjList* src_objs) {
 598   for (int i = 0; i < src_objs->objs()->length(); i++) {
 599     make_shallow_copy(dump_region, src_objs->objs()->at(i));
 600   }
 601   log_info(cds)("done (%d objects)", src_objs->objs()->length());
 602 }
 603 
 604 void ArchiveBuilder::make_shallow_copy(DumpRegion *dump_region, SourceObjInfo* src_info) {
 605   MetaspaceClosure::Ref* ref = src_info->ref();
 606   address src = ref->obj();
 607   int bytes = src_info->size_in_bytes();
 608   char* dest;
 609   char* oldtop;
 610   char* newtop;
 611 
 612   oldtop = dump_region->top();
 613   if (ref->msotype() == MetaspaceObj::ClassType) {
 614     // Save a pointer immediate in front of an InstanceKlass, so
 615     // we can do a quick lookup from InstanceKlass* -> RunTimeClassInfo*
 616     // without building another hashtable. See RunTimeClassInfo::get_for()
 617     // in systemDictionaryShared.cpp.
 618     Klass* klass = (Klass*)src;
 619     if (klass->is_instance_klass()) {
 620       SystemDictionaryShared::validate_before_archiving(InstanceKlass::cast(klass));
 621       dump_region->allocate(sizeof(address));
 622     }
 623   }
 624   dest = dump_region->allocate(bytes);
 625   newtop = dump_region->top();
 626 
 627   memcpy(dest, src, bytes);
 628   {
 629     bool created;
 630     _buffered_to_src_table.put_if_absent((address)dest, src, &created);
 631     assert(created, "must be");
 632     if (_buffered_to_src_table.maybe_grow()) {
 633       log_info(cds, hashtables)("Expanded _buffered_to_src_table table to %d", _buffered_to_src_table.table_size());
 634     }
 635   }
 636 
 637   intptr_t* archived_vtable = CppVtables::get_archived_vtable(ref->msotype(), (address)dest);
 638   if (archived_vtable != NULL) {
 639     *(address*)dest = (address)archived_vtable;
 640     ArchivePtrMarker::mark_pointer((address*)dest);
 641   }
 642 
 643   log_trace(cds)("Copy: " PTR_FORMAT " ==> " PTR_FORMAT " %d", p2i(src), p2i(dest), bytes);
 644   src_info->set_buffered_addr((address)dest);
 645 
 646   _alloc_stats.record(ref->msotype(), int(newtop - oldtop), src_info->read_only());
 647 }
 648 
 649 address ArchiveBuilder::get_buffered_addr(address src_addr) const {
 650   SourceObjInfo* p = _src_obj_table.get(src_addr);
 651   assert(p != NULL, "must be");
 652 
 653   return p->buffered_addr();
 654 }
 655 
 656 address ArchiveBuilder::get_source_addr(address buffered_addr) const {
 657   assert(is_in_buffer_space(buffered_addr), "must be");
 658   address* src_p = _buffered_to_src_table.get(buffered_addr);
 659   assert(src_p != NULL && *src_p != NULL, "must be");
 660   return *src_p;
 661 }
 662 
 663 void ArchiveBuilder::relocate_embedded_pointers(ArchiveBuilder::SourceObjList* src_objs) {
 664   for (int i = 0; i < src_objs->objs()->length(); i++) {
 665     src_objs->relocate(i, this);
 666   }
 667 }
 668 
 669 void ArchiveBuilder::update_special_refs() {
 670   for (int i = 0; i < _special_refs->length(); i++) {
 671     SpecialRefInfo s = _special_refs->at(i);
 672     size_t field_offset = s.field_offset();
 673     address src_obj = s.src_obj();
 674     address dst_obj = get_buffered_addr(src_obj);
 675     intptr_t* src_p = (intptr_t*)(src_obj + field_offset);
 676     intptr_t* dst_p = (intptr_t*)(dst_obj + field_offset);
 677 
 678 
 679     MetaspaceClosure::assert_valid(s.type());
 680     switch (s.type()) {
 681     case MetaspaceClosure::_method_entry_ref:
 682       assert(*src_p == *dst_p, "must be a copy");
 683       break;
 684     case MetaspaceClosure::_internal_pointer_ref:
 685       {
 686         // *src_p points to a location inside src_obj. Let's make *dst_p point to
 687         // the same location inside dst_obj.
 688         size_t off = pointer_delta(*((address*)src_p), src_obj, sizeof(u1));
 689         assert(off < s.src_obj_size_in_bytes(), "must point to internal address");
 690         *((address*)dst_p) = dst_obj + off;
 691       }
 692       break;
 693     default:
 694       ShouldNotReachHere();
 695     }
 696     ArchivePtrMarker::mark_pointer((address*)dst_p);
 697   }
 698 }
 699 
 700 class RefRelocator: public MetaspaceClosure {
 701   ArchiveBuilder* _builder;
 702 
 703 public:
 704   RefRelocator(ArchiveBuilder* builder) : _builder(builder) {}
 705 
 706   virtual bool do_ref(Ref* ref, bool read_only) {
 707     if (ref->not_null()) {
 708       ref->update(_builder->get_buffered_addr(ref->obj()));
 709       ArchivePtrMarker::mark_pointer(ref->addr());
 710     }
 711     return false; // Do not recurse.
 712   }
 713 };
 714 
 715 void ArchiveBuilder::relocate_roots() {
 716   log_info(cds)("Relocating external roots ... ");
 717   ResourceMark rm;
 718   RefRelocator doit(this);
 719   iterate_sorted_roots(&doit, /*is_relocating_pointers=*/true);
 720   doit.finish();
 721   log_info(cds)("done");
 722 }
 723 
 724 void ArchiveBuilder::relocate_metaspaceobj_embedded_pointers() {
 725   log_info(cds)("Relocating embedded pointers in core regions ... ");
 726   relocate_embedded_pointers(&_rw_src_objs);
 727   relocate_embedded_pointers(&_ro_src_objs);
 728   update_special_refs();
 729 }
 730 
 731 // We must relocate vmClasses::_klasses[] only after we have copied the
 732 // java objects in during dump_java_heap_objects(): during the object copy, we operate on
 733 // old objects which assert that their klass is the original klass.
 734 void ArchiveBuilder::relocate_vm_classes() {
 735   log_info(cds)("Relocating vmClasses::_klasses[] ... ");
 736   ResourceMark rm;
 737   RefRelocator doit(this);
 738   vmClasses::metaspace_pointers_do(&doit);
 739 }
 740 
 741 void ArchiveBuilder::make_klasses_shareable() {
 742   int num_instance_klasses = 0;
 743   int num_boot_klasses = 0;
 744   int num_platform_klasses = 0;
 745   int num_app_klasses = 0;
 746   int num_hidden_klasses = 0;
 747   int num_unlinked_klasses = 0;
 748   int num_unregistered_klasses = 0;
 749   int num_obj_array_klasses = 0;
 750   int num_type_array_klasses = 0;
 751 
 752   for (int i = 0; i < klasses()->length(); i++) {
 753     const char* type;
 754     const char* unlinked = "";
 755     const char* hidden = "";
 756     const char* generated = "";
 757     Klass* k = klasses()->at(i);
 758     k->remove_java_mirror();
 759     if (k->is_objArray_klass()) {
 760       // InstanceKlass and TypeArrayKlass will in turn call remove_unshareable_info
 761       // on their array classes.
 762       num_obj_array_klasses ++;
 763       type = "array";
 764     } else if (k->is_typeArray_klass()) {
 765       num_type_array_klasses ++;
 766       type = "array";
 767       k->remove_unshareable_info();
 768     } else {
 769       assert(k->is_instance_klass(), " must be");
 770       num_instance_klasses ++;
 771       InstanceKlass* ik = InstanceKlass::cast(k);
 772       if (DynamicDumpSharedSpaces) {
 773         // For static dump, class loader type are already set.
 774         ik->assign_class_loader_type();
 775       }
 776       if (ik->is_shared_boot_class()) {
 777         type = "boot";
 778         num_boot_klasses ++;
 779       } else if (ik->is_shared_platform_class()) {
 780         type = "plat";
 781         num_platform_klasses ++;
 782       } else if (ik->is_shared_app_class()) {
 783         type = "app";
 784         num_app_klasses ++;
 785       } else {
 786         assert(ik->is_shared_unregistered_class(), "must be");
 787         type = "unreg";
 788         num_unregistered_klasses ++;
 789       }
 790 
 791       if (!ik->is_linked()) {
 792         num_unlinked_klasses ++;
 793         unlinked = " ** unlinked";
 794       }
 795 
 796       if (ik->is_hidden()) {
 797         num_hidden_klasses ++;
 798         hidden = " ** hidden";
 799       }
 800 
 801       if (ik->is_generated_shared_class()) {
 802         generated = " ** generated";
 803       }
 804       MetaspaceShared::rewrite_nofast_bytecodes_and_calculate_fingerprints(Thread::current(), ik);
 805       ik->remove_unshareable_info();
 806     }
 807 
 808     if (log_is_enabled(Debug, cds, class)) {
 809       ResourceMark rm;
 810       log_debug(cds, class)("klasses[%5d] = " PTR_FORMAT " %-5s %s%s%s%s", i,
 811                             p2i(to_requested(k)), type, k->external_name(),
 812                             hidden, unlinked, generated);
 813     }
 814   }
 815 
 816   log_info(cds)("Number of classes %d", num_instance_klasses + num_obj_array_klasses + num_type_array_klasses);
 817   log_info(cds)("    instance classes   = %5d", num_instance_klasses);
 818   log_info(cds)("      boot             = %5d", num_boot_klasses);
 819   log_info(cds)("      app              = %5d", num_app_klasses);
 820   log_info(cds)("      platform         = %5d", num_platform_klasses);
 821   log_info(cds)("      unregistered     = %5d", num_unregistered_klasses);
 822   log_info(cds)("      (hidden)         = %5d", num_hidden_klasses);
 823   log_info(cds)("      (unlinked)       = %5d", num_unlinked_klasses);
 824   log_info(cds)("    obj array classes  = %5d", num_obj_array_klasses);
 825   log_info(cds)("    type array classes = %5d", num_type_array_klasses);
 826   log_info(cds)("               symbols = %5d", _symbols->length());
 827 }
 828 
 829 uintx ArchiveBuilder::buffer_to_offset(address p) const {
 830   address requested_p = to_requested(p);
 831   assert(requested_p >= _requested_static_archive_bottom, "must be");
 832   return requested_p - _requested_static_archive_bottom;
 833 }
 834 
 835 uintx ArchiveBuilder::any_to_offset(address p) const {
 836   if (is_in_mapped_static_archive(p)) {
 837     assert(DynamicDumpSharedSpaces, "must be");
 838     return p - _mapped_static_archive_bottom;
 839   }
 840   return buffer_to_offset(p);
 841 }
 842 
 843 // Update a Java object to point its Klass* to the address whene
 844 // the class would be mapped at runtime.
 845 void ArchiveBuilder::relocate_klass_ptr_of_oop(oop o) {
 846   assert(DumpSharedSpaces, "sanity");
 847   Klass* k = get_buffered_klass(o->klass());
 848   Klass* requested_k = to_requested(k);
 849   narrowKlass nk = CompressedKlassPointers::encode_not_null(requested_k, _requested_static_archive_bottom);
 850   o->set_narrow_klass(nk);
 851 }
 852 
 853 // RelocateBufferToRequested --- Relocate all the pointers in rw/ro,
 854 // so that the archive can be mapped to the "requested" location without runtime relocation.
 855 //
 856 // - See ArchiveBuilder header for the definition of "buffer", "mapped" and "requested"
 857 // - ArchivePtrMarker::ptrmap() marks all the pointers in the rw/ro regions
 858 // - Every pointer must have one of the following values:
 859 //   [a] NULL:
 860 //       No relocation is needed. Remove this pointer from ptrmap so we don't need to
 861 //       consider it at runtime.
 862 //   [b] Points into an object X which is inside the buffer:
 863 //       Adjust this pointer by _buffer_to_requested_delta, so it points to X
 864 //       when the archive is mapped at the requested location.
 865 //   [c] Points into an object Y which is inside mapped static archive:
 866 //       - This happens only during dynamic dump
 867 //       - Adjust this pointer by _mapped_to_requested_static_archive_delta,
 868 //         so it points to Y when the static archive is mapped at the requested location.
 869 template <bool STATIC_DUMP>
 870 class RelocateBufferToRequested : public BitMapClosure {
 871   ArchiveBuilder* _builder;
 872   address _buffer_bottom;
 873   intx _buffer_to_requested_delta;
 874   intx _mapped_to_requested_static_archive_delta;
 875   size_t _max_non_null_offset;
 876 
 877  public:
 878   RelocateBufferToRequested(ArchiveBuilder* builder) {
 879     _builder = builder;
 880     _buffer_bottom = _builder->buffer_bottom();
 881     _buffer_to_requested_delta = builder->buffer_to_requested_delta();
 882     _mapped_to_requested_static_archive_delta = builder->requested_static_archive_bottom() - builder->mapped_static_archive_bottom();
 883     _max_non_null_offset = 0;
 884 
 885     address bottom = _builder->buffer_bottom();
 886     address top = _builder->buffer_top();
 887     address new_bottom = bottom + _buffer_to_requested_delta;
 888     address new_top = top + _buffer_to_requested_delta;
 889     log_debug(cds)("Relocating archive from [" INTPTR_FORMAT " - " INTPTR_FORMAT "] to "
 890                    "[" INTPTR_FORMAT " - " INTPTR_FORMAT "]",
 891                    p2i(bottom), p2i(top),
 892                    p2i(new_bottom), p2i(new_top));
 893   }
 894 
 895   bool do_bit(size_t offset) {
 896     address* p = (address*)_buffer_bottom + offset;
 897     assert(_builder->is_in_buffer_space(p), "pointer must live in buffer space");
 898 
 899     if (*p == NULL) {
 900       // todo -- clear bit, etc
 901       ArchivePtrMarker::ptrmap()->clear_bit(offset);
 902     } else {
 903       if (STATIC_DUMP) {
 904         assert(_builder->is_in_buffer_space(*p), "old pointer must point inside buffer space");
 905         *p += _buffer_to_requested_delta;
 906         assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
 907       } else {
 908         if (_builder->is_in_buffer_space(*p)) {
 909           *p += _buffer_to_requested_delta;
 910           // assert is in requested dynamic archive
 911         } else {
 912           assert(_builder->is_in_mapped_static_archive(*p), "old pointer must point inside buffer space or mapped static archive");
 913           *p += _mapped_to_requested_static_archive_delta;
 914           assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
 915         }
 916       }
 917       _max_non_null_offset = offset;
 918     }
 919 
 920     return true; // keep iterating
 921   }
 922 
 923   void doit() {
 924     ArchivePtrMarker::ptrmap()->iterate(this);
 925     ArchivePtrMarker::compact(_max_non_null_offset);
 926   }
 927 };
 928 
 929 
 930 void ArchiveBuilder::relocate_to_requested() {
 931   ro_region()->pack();
 932 
 933   size_t my_archive_size = buffer_top() - buffer_bottom();
 934 
 935   if (DumpSharedSpaces) {
 936     _requested_static_archive_top = _requested_static_archive_bottom + my_archive_size;
 937     RelocateBufferToRequested<true> patcher(this);
 938     patcher.doit();
 939   } else {
 940     assert(DynamicDumpSharedSpaces, "must be");
 941     _requested_dynamic_archive_top = _requested_dynamic_archive_bottom + my_archive_size;
 942     RelocateBufferToRequested<false> patcher(this);
 943     patcher.doit();
 944   }
 945 }
 946 
 947 // Write detailed info to a mapfile to analyze contents of the archive.
 948 // static dump:
 949 //   java -Xshare:dump -Xlog:cds+map=trace:file=cds.map:none:filesize=0
 950 // dynamic dump:
 951 //   java -cp MyApp.jar -XX:ArchiveClassesAtExit=MyApp.jsa \
 952 //        -Xlog:cds+map=trace:file=cds.map:none:filesize=0 MyApp
 953 //
 954 // We need to do some address translation because the buffers used at dump time may be mapped to
 955 // a different location at runtime. At dump time, the buffers may be at arbitrary locations
 956 // picked by the OS. At runtime, we try to map at a fixed location (SharedBaseAddress). For
 957 // consistency, we log everything using runtime addresses.
 958 class ArchiveBuilder::CDSMapLogger : AllStatic {
 959   static intx buffer_to_runtime_delta() {
 960     // Translate the buffers used by the RW/RO regions to their eventual (requested) locations
 961     // at runtime.
 962     return ArchiveBuilder::current()->buffer_to_requested_delta();
 963   }
 964 
 965   // rw/ro regions only
 966   static void log_metaspace_region(const char* name, DumpRegion* region,
 967                                    const ArchiveBuilder::SourceObjList* src_objs) {
 968     address region_base = address(region->base());
 969     address region_top  = address(region->top());
 970     log_region(name, region_base, region_top, region_base + buffer_to_runtime_delta());
 971     log_metaspace_objects(region, src_objs);
 972   }
 973 
 974 #define _LOG_PREFIX PTR_FORMAT ": @@ %-17s %d"
 975 
 976   static void log_klass(Klass* k, address runtime_dest, const char* type_name, int bytes, Thread* current) {
 977     ResourceMark rm(current);
 978     log_debug(cds, map)(_LOG_PREFIX " %s",
 979                         p2i(runtime_dest), type_name, bytes, k->external_name());
 980   }
 981   static void log_method(Method* m, address runtime_dest, const char* type_name, int bytes, Thread* current) {
 982     ResourceMark rm(current);
 983     log_debug(cds, map)(_LOG_PREFIX " %s",
 984                         p2i(runtime_dest), type_name, bytes,  m->external_name());
 985   }
 986 
 987   // rw/ro regions only
 988   static void log_metaspace_objects(DumpRegion* region, const ArchiveBuilder::SourceObjList* src_objs) {
 989     address last_obj_base = address(region->base());
 990     address last_obj_end  = address(region->base());
 991     address region_end    = address(region->end());
 992     Thread* current = Thread::current();
 993     for (int i = 0; i < src_objs->objs()->length(); i++) {
 994       SourceObjInfo* src_info = src_objs->at(i);
 995       address src = src_info->source_addr();
 996       address dest = src_info->buffered_addr();
 997       log_data(last_obj_base, dest, last_obj_base + buffer_to_runtime_delta());
 998       address runtime_dest = dest + buffer_to_runtime_delta();
 999       int bytes = src_info->size_in_bytes();
1000 
1001       MetaspaceObj::Type type = src_info->msotype();
1002       const char* type_name = MetaspaceObj::type_name(type);
1003 
1004       switch (type) {
1005       case MetaspaceObj::ClassType:
1006         log_klass((Klass*)src, runtime_dest, type_name, bytes, current);
1007         break;
1008       case MetaspaceObj::ConstantPoolType:
1009         log_klass(((ConstantPool*)src)->pool_holder(),
1010                     runtime_dest, type_name, bytes, current);
1011         break;
1012       case MetaspaceObj::ConstantPoolCacheType:
1013         log_klass(((ConstantPoolCache*)src)->constant_pool()->pool_holder(),
1014                     runtime_dest, type_name, bytes, current);
1015         break;
1016       case MetaspaceObj::MethodType:
1017         log_method((Method*)src, runtime_dest, type_name, bytes, current);
1018         break;
1019       case MetaspaceObj::ConstMethodType:
1020         log_method(((ConstMethod*)src)->method(), runtime_dest, type_name, bytes, current);
1021         break;
1022       case MetaspaceObj::SymbolType:
1023         {
1024           ResourceMark rm(current);
1025           Symbol* s = (Symbol*)src;
1026           log_debug(cds, map)(_LOG_PREFIX " %s", p2i(runtime_dest), type_name, bytes,
1027                               s->as_quoted_ascii());
1028         }
1029         break;
1030       default:
1031         log_debug(cds, map)(_LOG_PREFIX, p2i(runtime_dest), type_name, bytes);
1032         break;
1033       }
1034 
1035       last_obj_base = dest;
1036       last_obj_end  = dest + bytes;
1037     }
1038 
1039     log_data(last_obj_base, last_obj_end, last_obj_base + buffer_to_runtime_delta());
1040     if (last_obj_end < region_end) {
1041       log_debug(cds, map)(PTR_FORMAT ": @@ Misc data " SIZE_FORMAT " bytes",
1042                           p2i(last_obj_end + buffer_to_runtime_delta()),
1043                           size_t(region_end - last_obj_end));
1044       log_data(last_obj_end, region_end, last_obj_end + buffer_to_runtime_delta());
1045     }
1046   }
1047 
1048 #undef _LOG_PREFIX
1049 
1050   // Log information about a region, whose address at dump time is [base .. top). At
1051   // runtime, this region will be mapped to requested_base. requested_base is 0 if this
1052   // region will be mapped at os-selected addresses (such as the bitmap region), or will
1053   // be accessed with os::read (the header).
1054   //
1055   // Note: across -Xshare:dump runs, base may be different, but requested_base should
1056   // be the same as the archive contents should be deterministic.
1057   static void log_region(const char* name, address base, address top, address requested_base) {
1058     size_t size = top - base;
1059     base = requested_base;
1060     top = requested_base + size;
1061     log_info(cds, map)("[%-18s " PTR_FORMAT " - " PTR_FORMAT " " SIZE_FORMAT_W(9) " bytes]",
1062                        name, p2i(base), p2i(top), size);
1063   }
1064 
1065 #if INCLUDE_CDS_JAVA_HEAP
1066   // open and closed archive regions
1067   static void log_heap_regions(const char* which, GrowableArray<MemRegion> *regions) {
1068     for (int i = 0; i < regions->length(); i++) {
1069       address start = address(regions->at(i).start());
1070       address end = address(regions->at(i).end());
1071       log_region(which, start, end, to_requested(start));
1072 
1073       while (start < end) {
1074         size_t byte_size;
1075         oop archived_oop = cast_to_oop(start);
1076         oop original_oop = HeapShared::get_original_object(archived_oop);
1077         if (original_oop != NULL) {
1078           ResourceMark rm;
1079           log_info(cds, map)(PTR_FORMAT ": @@ Object %s",
1080                              p2i(to_requested(start)), original_oop->klass()->external_name());
1081           byte_size = original_oop->size() * BytesPerWord;
1082         } else if (archived_oop == HeapShared::roots()) {
1083           // HeapShared::roots() is copied specially so it doesn't exist in
1084           // HeapShared::OriginalObjectTable. See HeapShared::copy_roots().
1085           log_info(cds, map)(PTR_FORMAT ": @@ Object HeapShared::roots (ObjArray)",
1086                              p2i(to_requested(start)));
1087           byte_size = objArrayOopDesc::object_size(HeapShared::roots()->length()) * BytesPerWord;
1088         } else {
1089           // We have reached the end of the region
1090           break;
1091         }
1092         address oop_end = start + byte_size;
1093         log_data(start, oop_end, to_requested(start), /*is_heap=*/true);
1094         start = oop_end;
1095       }
1096       if (start < end) {
1097         log_info(cds, map)(PTR_FORMAT ": @@ Unused heap space " SIZE_FORMAT " bytes",
1098                            p2i(to_requested(start)), size_t(end - start));
1099         log_data(start, end, to_requested(start), /*is_heap=*/true);
1100       }
1101     }
1102   }
1103   static address to_requested(address p) {
1104     return HeapShared::to_requested_address(p);
1105   }
1106 #endif
1107 
1108   // Log all the data [base...top). Pretend that the base address
1109   // will be mapped to requested_base at run-time.
1110   static void log_data(address base, address top, address requested_base, bool is_heap = false) {
1111     assert(top >= base, "must be");
1112 
1113     LogStreamHandle(Trace, cds, map) lsh;
1114     if (lsh.is_enabled()) {
1115       int unitsize = sizeof(address);
1116       if (is_heap && UseCompressedOops) {
1117         // This makes the compressed oop pointers easier to read, but
1118         // longs and doubles will be split into two words.
1119         unitsize = sizeof(narrowOop);
1120       }
1121       os::print_hex_dump(&lsh, base, top, unitsize, 32, requested_base);
1122     }
1123   }
1124 
1125   static void log_header(FileMapInfo* mapinfo) {
1126     LogStreamHandle(Info, cds, map) lsh;
1127     if (lsh.is_enabled()) {
1128       mapinfo->print(&lsh);
1129     }
1130   }
1131 
1132 public:
1133   static void log(ArchiveBuilder* builder, FileMapInfo* mapinfo,
1134                   GrowableArray<MemRegion> *closed_heap_regions,
1135                   GrowableArray<MemRegion> *open_heap_regions,
1136                   char* bitmap, size_t bitmap_size_in_bytes) {
1137     log_info(cds, map)("%s CDS archive map for %s", DumpSharedSpaces ? "Static" : "Dynamic", mapinfo->full_path());
1138 
1139     address header = address(mapinfo->header());
1140     address header_end = header + mapinfo->header()->header_size();
1141     log_region("header", header, header_end, 0);
1142     log_header(mapinfo);
1143     log_data(header, header_end, 0);
1144 
1145     DumpRegion* rw_region = &builder->_rw_region;
1146     DumpRegion* ro_region = &builder->_ro_region;
1147 
1148     log_metaspace_region("rw region", rw_region, &builder->_rw_src_objs);
1149     log_metaspace_region("ro region", ro_region, &builder->_ro_src_objs);
1150 
1151     address bitmap_end = address(bitmap + bitmap_size_in_bytes);
1152     log_region("bitmap", address(bitmap), bitmap_end, 0);
1153     log_data((address)bitmap, bitmap_end, 0);
1154 
1155 #if INCLUDE_CDS_JAVA_HEAP
1156     if (closed_heap_regions != NULL) {
1157       log_heap_regions("closed heap region", closed_heap_regions);
1158     }
1159     if (open_heap_regions != NULL) {
1160       log_heap_regions("open heap region", open_heap_regions);
1161     }
1162 #endif
1163 
1164     log_info(cds, map)("[End of CDS archive map]");
1165   }
1166 }; // end ArchiveBuilder::CDSMapLogger
1167 
1168 void ArchiveBuilder::print_stats() {
1169   _alloc_stats.print_stats(int(_ro_region.used()), int(_rw_region.used()));
1170 }
1171 
1172 void ArchiveBuilder::clean_up_src_obj_table() {
1173   SrcObjTableCleaner cleaner;
1174   _src_obj_table.iterate(&cleaner);
1175 }
1176 
1177 void ArchiveBuilder::write_archive(FileMapInfo* mapinfo,
1178                                    GrowableArray<MemRegion>* closed_heap_regions,
1179                                    GrowableArray<MemRegion>* open_heap_regions,
1180                                    GrowableArray<ArchiveHeapOopmapInfo>* closed_heap_oopmaps,
1181                                    GrowableArray<ArchiveHeapOopmapInfo>* open_heap_oopmaps) {
1182   // Make sure NUM_CDS_REGIONS (exported in cds.h) agrees with
1183   // MetaspaceShared::n_regions (internal to hotspot).
1184   assert(NUM_CDS_REGIONS == MetaspaceShared::n_regions, "sanity");
1185 
1186   write_region(mapinfo, MetaspaceShared::rw, &_rw_region, /*read_only=*/false,/*allow_exec=*/false);
1187   write_region(mapinfo, MetaspaceShared::ro, &_ro_region, /*read_only=*/true, /*allow_exec=*/false);
1188 
1189   size_t bitmap_size_in_bytes;
1190   char* bitmap = mapinfo->write_bitmap_region(ArchivePtrMarker::ptrmap(), closed_heap_oopmaps, open_heap_oopmaps,
1191                                               bitmap_size_in_bytes);
1192 
1193   if (closed_heap_regions != NULL) {
1194     _total_closed_heap_region_size = mapinfo->write_heap_regions(
1195                                         closed_heap_regions,
1196                                         closed_heap_oopmaps,
1197                                         MetaspaceShared::first_closed_heap_region,
1198                                         MetaspaceShared::max_num_closed_heap_regions);
1199     _total_open_heap_region_size = mapinfo->write_heap_regions(
1200                                         open_heap_regions,
1201                                         open_heap_oopmaps,
1202                                         MetaspaceShared::first_open_heap_region,
1203                                         MetaspaceShared::max_num_open_heap_regions);
1204   }
1205 
1206   print_region_stats(mapinfo, closed_heap_regions, open_heap_regions);
1207 
1208   mapinfo->set_requested_base((char*)MetaspaceShared::requested_base_address());
1209   mapinfo->set_header_crc(mapinfo->compute_header_crc());
1210   // After this point, we should not write any data into mapinfo->header() since this
1211   // would corrupt its checksum we have calculated before.
1212   mapinfo->write_header();
1213   mapinfo->close();
1214 
1215   if (log_is_enabled(Info, cds)) {
1216     print_stats();
1217   }
1218 
1219   if (log_is_enabled(Info, cds, map)) {
1220     CDSMapLogger::log(this, mapinfo, closed_heap_regions, open_heap_regions,
1221                       bitmap, bitmap_size_in_bytes);
1222   }
1223   CDS_JAVA_HEAP_ONLY(HeapShared::destroy_archived_object_cache());
1224   FREE_C_HEAP_ARRAY(char, bitmap);
1225 }
1226 
1227 void ArchiveBuilder::write_region(FileMapInfo* mapinfo, int region_idx, DumpRegion* dump_region, bool read_only,  bool allow_exec) {
1228   mapinfo->write_region(region_idx, dump_region->base(), dump_region->used(), read_only, allow_exec);
1229 }
1230 
1231 void ArchiveBuilder::print_region_stats(FileMapInfo *mapinfo,
1232                                         GrowableArray<MemRegion>* closed_heap_regions,
1233                                         GrowableArray<MemRegion>* open_heap_regions) {
1234   // Print statistics of all the regions
1235   const size_t bitmap_used = mapinfo->space_at(MetaspaceShared::bm)->used();
1236   const size_t bitmap_reserved = mapinfo->space_at(MetaspaceShared::bm)->used_aligned();
1237   const size_t total_reserved = _ro_region.reserved()  + _rw_region.reserved() +
1238                                 bitmap_reserved +
1239                                 _total_closed_heap_region_size +
1240                                 _total_open_heap_region_size;
1241   const size_t total_bytes = _ro_region.used()  + _rw_region.used() +
1242                              bitmap_used +
1243                              _total_closed_heap_region_size +
1244                              _total_open_heap_region_size;
1245   const double total_u_perc = percent_of(total_bytes, total_reserved);
1246 
1247   _rw_region.print(total_reserved);
1248   _ro_region.print(total_reserved);
1249 
1250   print_bitmap_region_stats(bitmap_used, total_reserved);
1251 
1252   if (closed_heap_regions != NULL) {
1253     print_heap_region_stats(closed_heap_regions, "ca", total_reserved);
1254     print_heap_region_stats(open_heap_regions, "oa", total_reserved);
1255   }
1256 
1257   log_debug(cds)("total    : " SIZE_FORMAT_W(9) " [100.0%% of total] out of " SIZE_FORMAT_W(9) " bytes [%5.1f%% used]",
1258                  total_bytes, total_reserved, total_u_perc);
1259 }
1260 
1261 void ArchiveBuilder::print_bitmap_region_stats(size_t size, size_t total_size) {
1262   log_debug(cds)("bm  space: " SIZE_FORMAT_W(9) " [ %4.1f%% of total] out of " SIZE_FORMAT_W(9) " bytes [100.0%% used]",
1263                  size, size/double(total_size)*100.0, size);
1264 }
1265 
1266 void ArchiveBuilder::print_heap_region_stats(GrowableArray<MemRegion>* regions,
1267                                              const char *name, size_t total_size) {
1268   int arr_len = regions == NULL ? 0 : regions->length();
1269   for (int i = 0; i < arr_len; i++) {
1270       char* start = (char*)regions->at(i).start();
1271       size_t size = regions->at(i).byte_size();
1272       char* top = start + size;
1273       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,
1274                      name, i, size, size/double(total_size)*100.0, size, p2i(start));
1275   }
1276 }
1277 
1278 void ArchiveBuilder::report_out_of_space(const char* name, size_t needed_bytes) {
1279   // This is highly unlikely to happen on 64-bits because we have reserved a 4GB space.
1280   // On 32-bit we reserve only 256MB so you could run out of space with 100,000 classes
1281   // or so.
1282   _rw_region.print_out_of_space_msg(name, needed_bytes);
1283   _ro_region.print_out_of_space_msg(name, needed_bytes);
1284 
1285   vm_exit_during_initialization(err_msg("Unable to allocate from '%s' region", name),
1286                                 "Please reduce the number of shared classes.");
1287 }
1288 
1289 
1290 #ifndef PRODUCT
1291 void ArchiveBuilder::assert_is_vm_thread() {
1292   assert(Thread::current()->is_VM_thread(), "ArchiveBuilder should be used only inside the VMThread");
1293 }
1294 #endif