1 /*
   2  * Copyright (c) 2020, 2024, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #include "precompiled.hpp"
  26 #include "cds/archiveBuilder.hpp"
  27 #include "cds/archiveHeapWriter.hpp"
  28 #include "cds/archiveUtils.hpp"
  29 #include "cds/cdsConfig.hpp"
  30 #include "cds/classPrelinker.hpp"
  31 #include "cds/classPreloader.hpp"
  32 #include "cds/cppVtables.hpp"
  33 #include "cds/dumpAllocStats.hpp"
  34 #include "cds/dynamicArchive.hpp"
  35 #include "cds/finalImageRecipes.hpp"
  36 #include "cds/heapShared.hpp"
  37 #include "cds/metaspaceShared.hpp"
  38 #include "cds/regeneratedClasses.hpp"
  39 #include "classfile/classLoader.hpp"
  40 #include "classfile/classLoaderExt.hpp"
  41 #include "classfile/classLoaderDataShared.hpp"
  42 #include "classfile/javaClasses.hpp"
  43 #include "classfile/symbolTable.hpp"
  44 #include "classfile/systemDictionaryShared.hpp"
  45 #include "classfile/vmClasses.hpp"
  46 #include "interpreter/abstractInterpreter.hpp"
  47 #include "jvm.h"
  48 #include "logging/log.hpp"
  49 #include "logging/logStream.hpp"
  50 #include "memory/allStatic.hpp"
  51 #include "memory/memRegion.hpp"
  52 #include "memory/resourceArea.hpp"
  53 #include "oops/compressedKlass.inline.hpp"
  54 #include "oops/instanceKlass.hpp"
  55 #include "oops/objArrayKlass.hpp"
  56 #include "oops/objArrayOop.inline.hpp"
  57 #include "oops/oopHandle.inline.hpp"
  58 #include "oops/trainingData.hpp"
  59 #include "runtime/arguments.hpp"
  60 #include "runtime/fieldDescriptor.inline.hpp"
  61 #include "runtime/globals_extension.hpp"
  62 #include "runtime/javaThread.hpp"
  63 #include "runtime/sharedRuntime.hpp"
  64 #include "utilities/align.hpp"
  65 #include "utilities/bitMap.inline.hpp"
  66 #include "utilities/formatBuffer.hpp"
  67 
  68 ArchiveBuilder* ArchiveBuilder::_current = nullptr;
  69 
  70 ArchiveBuilder::OtherROAllocMark::~OtherROAllocMark() {
  71   char* newtop = ArchiveBuilder::current()->_ro_region.top();
  72   ArchiveBuilder::alloc_stats()->record_other_type(int(newtop - _oldtop), true);
  73 }
  74 
  75 ArchiveBuilder::SourceObjList::SourceObjList() : _ptrmap(16 * K, mtClassShared) {
  76   _total_bytes = 0;
  77   _objs = new (mtClassShared) GrowableArray<SourceObjInfo*>(128 * K, mtClassShared);
  78 }
  79 
  80 ArchiveBuilder::SourceObjList::~SourceObjList() {
  81   delete _objs;
  82 }
  83 
  84 void ArchiveBuilder::SourceObjList::append(SourceObjInfo* src_info) {
  85   // Save this source object for copying
  86   src_info->set_id(_objs->length());
  87   _objs->append(src_info);
  88 
  89   // Prepare for marking the pointers in this source object
  90   assert(is_aligned(_total_bytes, sizeof(address)), "must be");
  91   src_info->set_ptrmap_start(_total_bytes / sizeof(address));
  92   _total_bytes = align_up(_total_bytes + (uintx)src_info->size_in_bytes(), sizeof(address));
  93   src_info->set_ptrmap_end(_total_bytes / sizeof(address));
  94 
  95   BitMap::idx_t bitmap_size_needed = BitMap::idx_t(src_info->ptrmap_end());
  96   if (_ptrmap.size() <= bitmap_size_needed) {
  97     _ptrmap.resize((bitmap_size_needed + 1) * 2);
  98   }
  99 }
 100 
 101 void ArchiveBuilder::SourceObjList::remember_embedded_pointer(SourceObjInfo* src_info, MetaspaceClosure::Ref* ref) {
 102   // src_obj contains a pointer. Remember the location of this pointer in _ptrmap,
 103   // so that we can copy/relocate it later.
 104   src_info->set_has_embedded_pointer();
 105   address src_obj = src_info->source_addr();
 106   address* field_addr = ref->addr();
 107   assert(src_info->ptrmap_start() < _total_bytes, "sanity");
 108   assert(src_info->ptrmap_end() <= _total_bytes, "sanity");
 109   assert(*field_addr != nullptr, "should have checked");
 110 
 111   intx field_offset_in_bytes = ((address)field_addr) - src_obj;
 112   DEBUG_ONLY(int src_obj_size = src_info->size_in_bytes();)
 113   assert(field_offset_in_bytes >= 0, "must be");
 114   assert(field_offset_in_bytes + intx(sizeof(intptr_t)) <= intx(src_obj_size), "must be");
 115   assert(is_aligned(field_offset_in_bytes, sizeof(address)), "must be");
 116 
 117   BitMap::idx_t idx = BitMap::idx_t(src_info->ptrmap_start() + (uintx)(field_offset_in_bytes / sizeof(address)));
 118   _ptrmap.set_bit(BitMap::idx_t(idx));
 119 }
 120 
 121 class RelocateEmbeddedPointers : public BitMapClosure {
 122   ArchiveBuilder* _builder;
 123   address _buffered_obj;
 124   BitMap::idx_t _start_idx;
 125 public:
 126   RelocateEmbeddedPointers(ArchiveBuilder* builder, address buffered_obj, BitMap::idx_t start_idx) :
 127     _builder(builder), _buffered_obj(buffered_obj), _start_idx(start_idx) {}
 128 
 129   bool do_bit(BitMap::idx_t bit_offset) {
 130     size_t field_offset = size_t(bit_offset - _start_idx) * sizeof(address);
 131     address* ptr_loc = (address*)(_buffered_obj + field_offset);
 132 
 133     address old_p = *ptr_loc;
 134     address new_p = _builder->get_buffered_addr(old_p);
 135 
 136     log_trace(cds)("Ref: [" PTR_FORMAT "] -> " PTR_FORMAT " => " PTR_FORMAT,
 137                    p2i(ptr_loc), p2i(old_p), p2i(new_p));
 138 
 139     ArchivePtrMarker::set_and_mark_pointer(ptr_loc, new_p);
 140     return true; // keep iterating the bitmap
 141   }
 142 };
 143 
 144 void ArchiveBuilder::SourceObjList::relocate(int i, ArchiveBuilder* builder) {
 145   SourceObjInfo* src_info = objs()->at(i);
 146   assert(src_info->should_copy(), "must be");
 147   BitMap::idx_t start = BitMap::idx_t(src_info->ptrmap_start()); // inclusive
 148   BitMap::idx_t end = BitMap::idx_t(src_info->ptrmap_end());     // exclusive
 149 
 150   RelocateEmbeddedPointers relocator(builder, src_info->buffered_addr(), start);
 151   _ptrmap.iterate(&relocator, start, end);
 152 }
 153 
 154 ArchiveBuilder::ArchiveBuilder() :
 155   _current_dump_region(nullptr),
 156   _buffer_bottom(nullptr),
 157   _last_verified_top(nullptr),
 158   _num_dump_regions_used(0),
 159   _other_region_used_bytes(0),
 160   _requested_static_archive_bottom(nullptr),
 161   _requested_static_archive_top(nullptr),
 162   _requested_dynamic_archive_bottom(nullptr),
 163   _requested_dynamic_archive_top(nullptr),
 164   _mapped_static_archive_bottom(nullptr),
 165   _mapped_static_archive_top(nullptr),
 166   _buffer_to_requested_delta(0),
 167   _rw_region("rw", MAX_SHARED_DELTA),
 168   _ro_region("ro", MAX_SHARED_DELTA),
 169   _cc_region("cc", MAX_SHARED_DELTA),
 170   _ptrmap(mtClassShared),
 171   _rw_ptrmap(mtClassShared),
 172   _ro_ptrmap(mtClassShared),
 173   _cc_ptrmap(mtClassShared),
 174   _rw_src_objs(),
 175   _ro_src_objs(),
 176   _src_obj_table(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE),
 177   _buffered_to_src_table(INITIAL_TABLE_SIZE, MAX_TABLE_SIZE),
 178   _total_heap_region_size(0),
 179   _estimated_metaspaceobj_bytes(0),
 180   _estimated_hashtable_bytes(0)
 181 {
 182   _klasses = new (mtClassShared) GrowableArray<Klass*>(4 * K, mtClassShared);
 183   _symbols = new (mtClassShared) GrowableArray<Symbol*>(256 * K, mtClassShared);
 184   _entropy_seed = 0x12345678;
 185   assert(_current == nullptr, "must be");
 186   _current = this;
 187 }
 188 
 189 ArchiveBuilder::~ArchiveBuilder() {
 190   assert(_current == this, "must be");
 191   _current = nullptr;
 192 
 193   for (int i = 0; i < _symbols->length(); i++) {
 194     _symbols->at(i)->decrement_refcount();
 195   }
 196 
 197   delete _klasses;
 198   delete _symbols;
 199   if (_shared_rs.is_reserved()) {
 200     _shared_rs.release();
 201   }
 202 }
 203 
 204 // Returns a deterministic sequence of pseudo random numbers. The main purpose is NOT
 205 // for randomness but to get good entropy for the identity_hash() of archived Symbols,
 206 // while keeping the contents of static CDS archives deterministic to ensure
 207 // reproducibility of JDK builds.
 208 int ArchiveBuilder::entropy() {
 209   assert(SafepointSynchronize::is_at_safepoint(), "needed to ensure deterministic sequence");
 210   _entropy_seed = os::next_random(_entropy_seed);
 211   return static_cast<int>(_entropy_seed);
 212 }
 213 
 214 class GatherKlassesAndSymbols : public UniqueMetaspaceClosure {
 215   ArchiveBuilder* _builder;
 216 
 217 public:
 218   GatherKlassesAndSymbols(ArchiveBuilder* builder) : _builder(builder) {}
 219 
 220   virtual bool do_unique_ref(Ref* ref, bool read_only) {
 221     return _builder->gather_klass_and_symbol(ref, read_only);
 222   }
 223 };
 224 
 225 bool ArchiveBuilder::gather_klass_and_symbol(MetaspaceClosure::Ref* ref, bool read_only) {
 226   if (ref->obj() == nullptr) {
 227     return false;
 228   }
 229   if (get_follow_mode(ref) != make_a_copy) {
 230     return false;
 231   }
 232   if (ref->msotype() == MetaspaceObj::ClassType) {
 233     Klass* klass = (Klass*)ref->obj();
 234     assert(klass->is_klass(), "must be");
 235     if (!is_excluded(klass)) {
 236       _klasses->append(klass);
 237       if (klass->is_hidden() && klass->is_instance_klass()) {
 238         update_hidden_class_loader_type(InstanceKlass::cast(klass));
 239       }
 240     }
 241     // See RunTimeClassInfo::get_for()
 242     _estimated_metaspaceobj_bytes += align_up(BytesPerWord, SharedSpaceObjectAlignment);
 243   } else if (ref->msotype() == MetaspaceObj::SymbolType) {
 244     // Make sure the symbol won't be GC'ed while we are dumping the archive.
 245     Symbol* sym = (Symbol*)ref->obj();
 246     sym->increment_refcount();
 247     _symbols->append(sym);
 248   }
 249 
 250   int bytes = ref->size() * BytesPerWord;
 251   _estimated_metaspaceobj_bytes += align_up(bytes, SharedSpaceObjectAlignment);
 252 
 253   return true; // recurse
 254 }
 255 
 256 void ArchiveBuilder::gather_klasses_and_symbols() {
 257   ResourceMark rm;
 258   log_info(cds)("Gathering classes and symbols ... ");
 259   GatherKlassesAndSymbols doit(this);
 260   iterate_roots(&doit);
 261 #if INCLUDE_CDS_JAVA_HEAP
 262   if (CDSConfig::is_dumping_full_module_graph()) {
 263     ClassLoaderDataShared::iterate_symbols(&doit);
 264   }
 265 #endif
 266   doit.finish();
 267 
 268   if (CDSConfig::is_dumping_static_archive()) {
 269     // To ensure deterministic contents in the static archive, we need to ensure that
 270     // we iterate the MetaspaceObjs in a deterministic order. It doesn't matter where
 271     // the MetaspaceObjs are located originally, as they are copied sequentially into
 272     // the archive during the iteration.
 273     //
 274     // The only issue here is that the symbol table and the system directories may be
 275     // randomly ordered, so we copy the symbols and klasses into two arrays and sort
 276     // them deterministically.
 277     //
 278     // During -Xshare:dump, the order of Symbol creation is strictly determined by
 279     // the SharedClassListFile (class loading is done in a single thread and the JIT
 280     // is disabled). Also, Symbols are allocated in monotonically increasing addresses
 281     // (see Symbol::operator new(size_t, int)). So if we iterate the Symbols by
 282     // ascending address order, we ensure that all Symbols are copied into deterministic
 283     // locations in the archive.
 284     //
 285     // TODO: in the future, if we want to produce deterministic contents in the
 286     // dynamic archive, we might need to sort the symbols alphabetically (also see
 287     // DynamicArchiveBuilder::sort_methods()).
 288     log_info(cds)("Sorting symbols ... ");
 289     _symbols->sort(compare_symbols_by_address);
 290     sort_klasses();
 291 
 292     // TODO -- we need a proper estimate for the archived modules, etc,
 293     // but this should be enough for now
 294     _estimated_metaspaceobj_bytes += 200 * 1024 * 1024;
 295   }
 296 }
 297 
 298 #if INCLUDE_CDS_JAVA_HEAP
 299 
 300 void ArchiveBuilder::update_hidden_class_loader_type(InstanceKlass* ik) {
 301   s2 classloader_type;
 302   if (HeapShared::is_lambda_form_klass(ik)) {
 303     assert(CDSConfig::is_dumping_invokedynamic(), "lambda form classes are archived only if CDSConfig::is_dumping_invokedynamic() is true");
 304     classloader_type = ClassLoader::BOOT_LOADER;
 305   } else if (SystemDictionaryShared::should_hidden_class_be_archived(ik)) {
 306     oop loader = ik->class_loader();
 307 
 308     if (loader == nullptr) {
 309       classloader_type = ClassLoader::BOOT_LOADER;
 310     } else if (SystemDictionary::is_platform_class_loader(loader)) {
 311       classloader_type = ClassLoader::PLATFORM_LOADER;
 312     } else if (SystemDictionary::is_system_class_loader(loader)) {
 313       classloader_type = ClassLoader::APP_LOADER;
 314     } else {
 315       ShouldNotReachHere();
 316     }
 317   } else {
 318     ShouldNotReachHere();
 319   }
 320 
 321   ik->set_shared_class_loader_type(classloader_type);
 322   if (HeapShared::is_lambda_proxy_klass(ik)) {
 323     InstanceKlass* nest_host = ik->nest_host_not_null();
 324     ik->set_shared_classpath_index(nest_host->shared_classpath_index());
 325   } else if (!HeapShared::is_lambda_form_klass(ik)) {
 326     // Injected invoker classes: fake this for now. Probably not needed!
 327     if (classloader_type == ClassLoader::APP_LOADER) {
 328       ik->set_shared_classpath_index(ClassLoaderExt::app_class_paths_start_index()); // HACK
 329     } else {
 330       ik->set_shared_classpath_index(0);
 331     }
 332   }
 333 }
 334 
 335 #endif //INCLUDE_CDS_JAVA_HEAP
 336 
 337 int ArchiveBuilder::compare_symbols_by_address(Symbol** a, Symbol** b) {
 338   if (a[0] < b[0]) {
 339     return -1;
 340   } else {
 341     assert(a[0] > b[0], "Duplicated symbol %s unexpected", (*a)->as_C_string());
 342     return 1;
 343   }
 344 }
 345 
 346 int ArchiveBuilder::compare_klass_by_name(Klass** a, Klass** b) {
 347   return a[0]->name()->fast_compare(b[0]->name());
 348 }
 349 
 350 void ArchiveBuilder::sort_klasses() {
 351   log_info(cds)("Sorting classes ... ");
 352   _klasses->sort(compare_klass_by_name);
 353 }
 354 
 355 size_t ArchiveBuilder::estimate_archive_size() {
 356   // size of the symbol table and two dictionaries, plus the RunTimeClassInfo's
 357   size_t symbol_table_est = SymbolTable::estimate_size_for_archive();
 358   size_t dictionary_est = SystemDictionaryShared::estimate_size_for_archive();
 359   size_t training_data_est = TrainingData::estimate_size_for_archive();
 360   _estimated_hashtable_bytes = symbol_table_est + dictionary_est + training_data_est;
 361 
 362   if (CDSConfig::is_dumping_final_static_archive()) {
 363     _estimated_hashtable_bytes += 200 * 1024 * 1024; // FIXME -- need to iterate archived symbols??
 364   }
 365 
 366   if (CDSConfig::is_dumping_dynamic_archive()) {
 367     // Some extra space for traning data. Be generous. Unused areas will be trimmed from the archive file.
 368     _estimated_hashtable_bytes += 200 * 1024 * 1024;
 369   }
 370   size_t total = 0;
 371 
 372   total += _estimated_metaspaceobj_bytes;
 373   total += _estimated_hashtable_bytes;
 374 
 375   // allow fragmentation at the end of each dump region
 376   total += _total_dump_regions * MetaspaceShared::core_region_alignment();
 377 
 378   log_info(cds)("_estimated_hashtable_bytes = " SIZE_FORMAT " + " SIZE_FORMAT " = " SIZE_FORMAT,
 379                 symbol_table_est, dictionary_est, _estimated_hashtable_bytes);
 380   log_info(cds)("_estimated_metaspaceobj_bytes = " SIZE_FORMAT, _estimated_metaspaceobj_bytes);
 381   log_info(cds)("total estimate bytes = " SIZE_FORMAT, total);
 382 
 383   return align_up(total, MetaspaceShared::core_region_alignment());
 384 }
 385 
 386 address ArchiveBuilder::reserve_buffer() {
 387   size_t buffer_size = estimate_archive_size();
 388   ReservedSpace rs(buffer_size, MetaspaceShared::core_region_alignment(), os::vm_page_size());
 389   if (!rs.is_reserved()) {
 390     log_error(cds)("Failed to reserve " SIZE_FORMAT " bytes of output buffer.", buffer_size);
 391     MetaspaceShared::unrecoverable_writing_error();
 392   }
 393 
 394   // buffer_bottom is the lowest address of the 2 core regions (rw, ro) when
 395   // we are copying the class metadata into the buffer.
 396   address buffer_bottom = (address)rs.base();
 397   log_info(cds)("Reserved output buffer space at " PTR_FORMAT " [" SIZE_FORMAT " bytes]",
 398                 p2i(buffer_bottom), buffer_size);
 399   _shared_rs = rs;
 400 
 401   _buffer_bottom = buffer_bottom;
 402   _last_verified_top = buffer_bottom;
 403   _current_dump_region = &_rw_region;
 404   _num_dump_regions_used = 1;
 405   _other_region_used_bytes = 0;
 406   _current_dump_region->init(&_shared_rs, &_shared_vs);
 407 
 408   ArchivePtrMarker::initialize(&_ptrmap, &_shared_vs);
 409 
 410   // The bottom of the static archive should be mapped at this address by default.
 411   _requested_static_archive_bottom = (address)MetaspaceShared::requested_base_address();
 412 
 413   // The bottom of the archive (that I am writing now) should be mapped at this address by default.
 414   address my_archive_requested_bottom;
 415 
 416   if (CDSConfig::is_dumping_static_archive()) {
 417     my_archive_requested_bottom = _requested_static_archive_bottom;
 418   } else {
 419     _mapped_static_archive_bottom = (address)MetaspaceObj::shared_metaspace_base();
 420     _mapped_static_archive_top  = (address)MetaspaceObj::shared_metaspace_top();
 421     assert(_mapped_static_archive_top >= _mapped_static_archive_bottom, "must be");
 422     size_t static_archive_size = _mapped_static_archive_top - _mapped_static_archive_bottom;
 423 
 424     // At run time, we will mmap the dynamic archive at my_archive_requested_bottom
 425     _requested_static_archive_top = _requested_static_archive_bottom + static_archive_size;
 426     my_archive_requested_bottom = align_up(_requested_static_archive_top, MetaspaceShared::core_region_alignment());
 427 
 428     _requested_dynamic_archive_bottom = my_archive_requested_bottom;
 429   }
 430 
 431   _buffer_to_requested_delta = my_archive_requested_bottom - _buffer_bottom;
 432 
 433   address my_archive_requested_top = my_archive_requested_bottom + buffer_size;
 434   if (my_archive_requested_bottom <  _requested_static_archive_bottom ||
 435       my_archive_requested_top    <= _requested_static_archive_bottom) {
 436     // Size overflow.
 437     log_error(cds)("my_archive_requested_bottom = " INTPTR_FORMAT, p2i(my_archive_requested_bottom));
 438     log_error(cds)("my_archive_requested_top    = " INTPTR_FORMAT, p2i(my_archive_requested_top));
 439     log_error(cds)("SharedBaseAddress (" INTPTR_FORMAT ") is too high. "
 440                    "Please rerun java -Xshare:dump with a lower value", p2i(_requested_static_archive_bottom));
 441     MetaspaceShared::unrecoverable_writing_error();
 442   }
 443 
 444   if (CDSConfig::is_dumping_static_archive()) {
 445     // We don't want any valid object to be at the very bottom of the archive.
 446     // See ArchivePtrMarker::mark_pointer().
 447     rw_region()->allocate(16);
 448   }
 449 
 450   return buffer_bottom;
 451 }
 452 
 453 void ArchiveBuilder::iterate_sorted_roots(MetaspaceClosure* it) {
 454   int num_symbols = _symbols->length();
 455   for (int i = 0; i < num_symbols; i++) {
 456     it->push(_symbols->adr_at(i));
 457   }
 458 
 459   int num_klasses = _klasses->length();
 460   for (int i = 0; i < num_klasses; i++) {
 461     it->push(_klasses->adr_at(i));
 462   }
 463 
 464   iterate_roots(it);
 465 }
 466 
 467 class GatherSortedSourceObjs : public MetaspaceClosure {
 468   ArchiveBuilder* _builder;
 469 
 470 public:
 471   GatherSortedSourceObjs(ArchiveBuilder* builder) : _builder(builder) {}
 472 
 473   virtual bool do_ref(Ref* ref, bool read_only) {
 474     return _builder->gather_one_source_obj(ref, read_only);
 475   }
 476 };
 477 
 478 bool ArchiveBuilder::gather_one_source_obj(MetaspaceClosure::Ref* ref, bool read_only) {
 479   address src_obj = ref->obj();
 480   if (src_obj == nullptr) {
 481     return false;
 482   }
 483 
 484   remember_embedded_pointer_in_enclosing_obj(ref);
 485   if (RegeneratedClasses::has_been_regenerated(src_obj)) {
 486     // No need to copy it. We will later relocate it to point to the regenerated klass/method.
 487     return false;
 488   }

 489 
 490   FollowMode follow_mode = get_follow_mode(ref);
 491   SourceObjInfo src_info(ref, read_only, follow_mode);
 492   bool created;
 493   SourceObjInfo* p = _src_obj_table.put_if_absent(src_obj, src_info, &created);
 494   if (created) {
 495     if (_src_obj_table.maybe_grow()) {
 496       log_info(cds, hashtables)("Expanded _src_obj_table table to %d", _src_obj_table.table_size());
 497     }
 498   }
 499 
 500 #ifdef ASSERT
 501   if (ref->msotype() == MetaspaceObj::MethodType) {
 502     Method* m = (Method*)ref->obj();
 503     assert(!RegeneratedClasses::has_been_regenerated((address)m->method_holder()),
 504            "Should not archive methods in a class that has been regenerated");
 505   }
 506 #endif
 507 
 508   assert(p->read_only() == src_info.read_only(), "must be");
 509 
 510   if (created && src_info.should_copy()) {
 511     if (read_only) {
 512       _ro_src_objs.append(p);
 513     } else {
 514       _rw_src_objs.append(p);
 515     }
 516     return true; // Need to recurse into this ref only if we are copying it
 517   } else {
 518     return false;
 519   }
 520 }
 521 
 522 void ArchiveBuilder::record_regenerated_object(address orig_src_obj, address regen_src_obj) {
 523   // Record the fact that orig_src_obj has been replaced by regen_src_obj. All calls to get_buffered_addr(orig_src_obj)
 524   // should return the same value as get_buffered_addr(regen_src_obj).
 525   SourceObjInfo* p = _src_obj_table.get(regen_src_obj);
 526   assert(p != nullptr, "regenerated object should always be dumped");
 527   SourceObjInfo orig_src_info(orig_src_obj, p);
 528   bool created;
 529   _src_obj_table.put_if_absent(orig_src_obj, orig_src_info, &created);
 530   assert(created, "We shouldn't have archived the original copy of a regenerated object");
 531 }
 532 
 533 // Remember that we have a pointer inside ref->enclosing_obj() that points to ref->obj()
 534 void ArchiveBuilder::remember_embedded_pointer_in_enclosing_obj(MetaspaceClosure::Ref* ref) {
 535   assert(ref->obj() != nullptr, "should have checked");
 536 
 537   address enclosing_obj = ref->enclosing_obj();
 538   if (enclosing_obj == nullptr) {
 539     return;
 540   }
 541 
 542   // We are dealing with 3 addresses:
 543   // address o    = ref->obj(): We have found an object whose address is o.
 544   // address* mpp = ref->mpp(): The object o is pointed to by a pointer whose address is mpp.
 545   //                            I.e., (*mpp == o)
 546   // enclosing_obj            : If non-null, it is the object which has a field that points to o.
 547   //                            mpp is the address if that field.
 548   //
 549   // Example: We have an array whose first element points to a Method:
 550   //     Method* o                     = 0x0000abcd;
 551   //     Array<Method*>* enclosing_obj = 0x00001000;
 552   //     enclosing_obj->at_put(0, o);
 553   //
 554   // We the MetaspaceClosure iterates on the very first element of this array, we have
 555   //     ref->obj()           == 0x0000abcd   (the Method)
 556   //     ref->mpp()           == 0x00001008   (the location of the first element in the array)
 557   //     ref->enclosing_obj() == 0x00001000   (the Array that contains the Method)
 558   //
 559   // We use the above information to mark the bitmap to indicate that there's a pointer on address 0x00001008.
 560   SourceObjInfo* src_info = _src_obj_table.get(enclosing_obj);
 561   if (src_info == nullptr || !src_info->should_copy()) {
 562     // source objects of point_to_it/set_to_null types are not copied
 563     // so we don't need to remember their pointers.
 564   } else {
 565     if (src_info->read_only()) {
 566       _ro_src_objs.remember_embedded_pointer(src_info, ref);
 567     } else {
 568       _rw_src_objs.remember_embedded_pointer(src_info, ref);
 569     }
 570   }
 571 }
 572 
 573 void ArchiveBuilder::gather_source_objs() {
 574   ResourceMark rm;
 575   log_info(cds)("Gathering all archivable objects ... ");
 576   gather_klasses_and_symbols();
 577   GatherSortedSourceObjs doit(this);
 578   iterate_sorted_roots(&doit);
 579   doit.finish();
 580 }
 581 
 582 bool ArchiveBuilder::is_excluded(Klass* klass) {
 583   if (klass->is_instance_klass()) {
 584     InstanceKlass* ik = InstanceKlass::cast(klass);
 585     return SystemDictionaryShared::is_excluded_class(ik);
 586   } else if (klass->is_objArray_klass()) {
 587     Klass* bottom = ObjArrayKlass::cast(klass)->bottom_klass();
 588     if (CDSConfig::is_dumping_dynamic_archive() && MetaspaceShared::is_shared_static(bottom)) {
 589       // The bottom class is in the static archive so it's clearly not excluded.
 590       assert(CDSConfig::is_dumping_dynamic_archive(), "sanity");
 591       return false;
 592     } else if (bottom->is_instance_klass()) {
 593       return SystemDictionaryShared::is_excluded_class(InstanceKlass::cast(bottom));
 594     }
 595   }
 596 
 597   return false;
 598 }
 599 
 600 ArchiveBuilder::FollowMode ArchiveBuilder::get_follow_mode(MetaspaceClosure::Ref *ref) {
 601   address obj = ref->obj();
 602   if (CDSConfig::is_dumping_dynamic_archive() && MetaspaceShared::is_in_shared_metaspace(obj)) {
 603     // Don't dump existing shared metadata again.
 604     return point_to_it;
 605   } else if (ref->msotype() == MetaspaceObj::MethodDataType ||
 606              ref->msotype() == MetaspaceObj::MethodCountersType ||
 607              ref->msotype() == MetaspaceObj::KlassTrainingDataType ||
 608              ref->msotype() == MetaspaceObj::MethodTrainingDataType ||
 609              ref->msotype() == MetaspaceObj::CompileTrainingDataType) {
 610       return TrainingData::need_data() ? make_a_copy : set_to_null;
 611   } else {
 612     if (ref->msotype() == MetaspaceObj::ClassType) {
 613       Klass* klass = (Klass*)ref->obj();
 614       assert(klass->is_klass(), "must be");
 615       if (is_excluded(klass)) {
 616         ResourceMark rm;
 617         log_debug(cds, dynamic)("Skipping class (excluded): %s", klass->external_name());
 618         return set_to_null;
 619       }
 620     }
 621 
 622     return make_a_copy;
 623   }
 624 }
 625 
 626 void ArchiveBuilder::start_dump_region(DumpRegion* next) {
 627   address bottom = _last_verified_top;
 628   address top = (address)(current_dump_region()->top());
 629   _other_region_used_bytes += size_t(top - bottom);
 630 
 631   current_dump_region()->pack(next);
 632   _current_dump_region = next;
 633   _num_dump_regions_used ++;
 634 
 635   _last_verified_top = (address)(current_dump_region()->top());
 636 }
 637 
 638 void ArchiveBuilder::verify_estimate_size(size_t estimate, const char* which) {
 639   address bottom = _last_verified_top;
 640   address top = (address)(current_dump_region()->top());
 641   size_t used = size_t(top - bottom) + _other_region_used_bytes;
 642   int diff = int(estimate) - int(used);
 643 
 644   log_info(cds)("%s estimate = " SIZE_FORMAT " used = " SIZE_FORMAT "; diff = %d bytes", which, estimate, used, diff);
 645   assert(diff >= 0, "Estimate is too small");
 646 
 647   _last_verified_top = top;
 648   _other_region_used_bytes = 0;
 649 }
 650 
 651 char* ArchiveBuilder::ro_strdup(const char* s) {
 652   char* archived_str = ro_region_alloc((int)strlen(s) + 1);
 653   strcpy(archived_str, s);
 654   return archived_str;
 655 }
 656 
 657 // The objects that have embedded pointers will sink
 658 // towards the end of the list. This ensures we have a maximum
 659 // number of leading zero bits in the relocation bitmap.
 660 int ArchiveBuilder::compare_src_objs(SourceObjInfo** a, SourceObjInfo** b) {
 661   if ((*a)->has_embedded_pointer() && !(*b)->has_embedded_pointer()) {
 662     return 1;
 663   } else if (!(*a)->has_embedded_pointer() && (*b)->has_embedded_pointer()) {
 664     return -1;
 665   } else {
 666     // This is necessary to keep the sorting order stable. Otherwise the
 667     // archive's contents may not be deterministic.
 668     return (*a)->id() - (*b)->id();
 669   }
 670 }
 671 
 672 void ArchiveBuilder::sort_metadata_objs() {
 673   _rw_src_objs.objs()->sort(compare_src_objs);
 674   _ro_src_objs.objs()->sort(compare_src_objs);
 675 }
 676 
 677 void ArchiveBuilder::dump_rw_metadata() {
 678   ResourceMark rm;
 679   log_info(cds)("Allocating RW objects ... ");
 680   make_shallow_copies(&_rw_region, &_rw_src_objs);
 681 
 682 #if INCLUDE_CDS_JAVA_HEAP
 683   if (CDSConfig::is_dumping_full_module_graph()) {
 684     // Archive the ModuleEntry's and PackageEntry's of the 3 built-in loaders
 685     char* start = rw_region()->top();
 686     ClassLoaderDataShared::allocate_archived_tables();
 687     alloc_stats()->record_modules(rw_region()->top() - start, /*read_only*/false);
 688   }
 689 #endif
 690 }
 691 
 692 void ArchiveBuilder::dump_ro_metadata() {
 693   ResourceMark rm;
 694   log_info(cds)("Allocating RO objects ... ");
 695 
 696   start_dump_region(&_ro_region);
 697   make_shallow_copies(&_ro_region, &_ro_src_objs);
 698 
 699 #if INCLUDE_CDS_JAVA_HEAP
 700   if (CDSConfig::is_dumping_full_module_graph()) {
 701     char* start = ro_region()->top();
 702     ClassLoaderDataShared::init_archived_tables();
 703     alloc_stats()->record_modules(ro_region()->top() - start, /*read_only*/true);
 704   }
 705 #endif
 706 
 707   RegeneratedClasses::record_regenerated_objects();
 708 }
 709 
 710 void ArchiveBuilder::make_shallow_copies(DumpRegion *dump_region,
 711                                          const ArchiveBuilder::SourceObjList* src_objs) {
 712   for (int i = 0; i < src_objs->objs()->length(); i++) {
 713     make_shallow_copy(dump_region, src_objs->objs()->at(i));
 714   }
 715   log_info(cds)("done (%d objects)", src_objs->objs()->length());
 716 }
 717 
 718 void ArchiveBuilder::make_shallow_copy(DumpRegion *dump_region, SourceObjInfo* src_info) {
 719   address src = src_info->source_addr();
 720   int bytes = src_info->size_in_bytes();
 721   char* dest;
 722   char* oldtop;
 723   char* newtop;
 724 
 725   oldtop = dump_region->top();
 726   if (src_info->msotype() == MetaspaceObj::ClassType) {
 727     // Save a pointer immediate in front of an InstanceKlass, so
 728     // we can do a quick lookup from InstanceKlass* -> RunTimeClassInfo*
 729     // without building another hashtable. See RunTimeClassInfo::get_for()
 730     // in systemDictionaryShared.cpp.
 731     Klass* klass = (Klass*)src;
 732     if (klass->is_instance_klass()) {
 733       SystemDictionaryShared::validate_before_archiving(InstanceKlass::cast(klass));
 734       dump_region->allocate(sizeof(address));
 735     }
 736   }
 737   dest = dump_region->allocate(bytes);
 738   newtop = dump_region->top();
 739 
 740   memcpy(dest, src, bytes);
 741 
 742   // Update the hash of buffered sorted symbols for static dump so that the symbols have deterministic contents
 743   if (CDSConfig::is_dumping_static_archive() && (src_info->msotype() == MetaspaceObj::SymbolType)) {
 744     Symbol* buffered_symbol = (Symbol*)dest;
 745     assert(((Symbol*)src)->is_permanent(), "archived symbols must be permanent");
 746     buffered_symbol->update_identity_hash();
 747   }
 748 
 749   {
 750     bool created;
 751     _buffered_to_src_table.put_if_absent((address)dest, src, &created);
 752     assert(created, "must be");
 753     if (_buffered_to_src_table.maybe_grow()) {
 754       log_info(cds, hashtables)("Expanded _buffered_to_src_table table to %d", _buffered_to_src_table.table_size());
 755     }
 756   }
 757 
 758   intptr_t* archived_vtable = CppVtables::get_archived_vtable(src_info->msotype(), (address)dest);
 759   if (archived_vtable != nullptr) {
 760     *(address*)dest = (address)archived_vtable;
 761     ArchivePtrMarker::mark_pointer((address*)dest);
 762   }
 763 
 764   log_trace(cds)("Copy: " PTR_FORMAT " ==> " PTR_FORMAT " %d", p2i(src), p2i(dest), bytes);
 765   src_info->set_buffered_addr((address)dest);
 766 
 767   _alloc_stats.record(src_info->msotype(), int(newtop - oldtop), src_info->read_only());
 768 }
 769 
 770 // This is used by code that hand-assembles data structures, such as the LambdaProxyClassKey, that are
 771 // not handled by MetaspaceClosure.
 772 void ArchiveBuilder::write_pointer_in_buffer(address* ptr_location, address src_addr) {
 773   assert(is_in_buffer_space(ptr_location), "must be");
 774   if (src_addr == nullptr) {
 775     *ptr_location = nullptr;
 776     ArchivePtrMarker::clear_pointer(ptr_location);
 777   } else {
 778     *ptr_location = get_buffered_addr(src_addr);
 779     ArchivePtrMarker::mark_pointer(ptr_location);
 780   }
 781 }
 782 
 783 void ArchiveBuilder::mark_and_relocate_to_buffered_addr(address* ptr_location) {
 784   assert(*ptr_location != nullptr, "sanity");
 785   if (!is_in_mapped_static_archive(*ptr_location)) {
 786     *ptr_location = get_buffered_addr(*ptr_location);
 787   }
 788   ArchivePtrMarker::mark_pointer(ptr_location);
 789 }
 790 
 791 address ArchiveBuilder::get_buffered_addr(address src_addr) const {
 792   SourceObjInfo* p = _src_obj_table.get(src_addr);
 793   assert(p != nullptr, "src_addr " INTPTR_FORMAT " is used but has not been archived",
 794          p2i(src_addr));
 795 
 796   return p->buffered_addr();
 797 }
 798 
 799 bool ArchiveBuilder::has_been_archived(address src_addr) const {
 800   SourceObjInfo* p = _src_obj_table.get(src_addr);
 801   return (p != nullptr);
 802 }
 803 
 804 address ArchiveBuilder::get_source_addr(address buffered_addr) const {
 805   assert(is_in_buffer_space(buffered_addr), "must be");
 806   address* src_p = _buffered_to_src_table.get(buffered_addr);
 807   assert(src_p != nullptr && *src_p != nullptr, "must be");
 808   return *src_p;
 809 }
 810 
 811 void ArchiveBuilder::relocate_embedded_pointers(ArchiveBuilder::SourceObjList* src_objs) {
 812   for (int i = 0; i < src_objs->objs()->length(); i++) {
 813     src_objs->relocate(i, this);
 814   }
 815 }
 816 
 817 void ArchiveBuilder::relocate_metaspaceobj_embedded_pointers() {
 818   log_info(cds)("Relocating embedded pointers in core regions ... ");
 819   relocate_embedded_pointers(&_rw_src_objs);
 820   relocate_embedded_pointers(&_ro_src_objs);
 821 }
 822 
 823 #define ADD_COUNT(x) \
 824   x += 1; \
 825   x ## _p += preloaded; \
 826   x ## _i += inited;
 827 
 828 #define DECLARE_INSTANCE_KLASS_COUNTER(x) \
 829   int x = 0; \
 830   int x ## _p = 0; \
 831   int x ## _i = 0; \
 832 
 833 void ArchiveBuilder::make_klasses_shareable() {
 834   DECLARE_INSTANCE_KLASS_COUNTER(num_instance_klasses);
 835   DECLARE_INSTANCE_KLASS_COUNTER(num_boot_klasses);
 836   DECLARE_INSTANCE_KLASS_COUNTER(num_vm_klasses);
 837   DECLARE_INSTANCE_KLASS_COUNTER(num_platform_klasses);
 838   DECLARE_INSTANCE_KLASS_COUNTER(num_app_klasses);
 839   DECLARE_INSTANCE_KLASS_COUNTER(num_hidden_klasses);
 840   DECLARE_INSTANCE_KLASS_COUNTER(num_unlinked_klasses);
 841   DECLARE_INSTANCE_KLASS_COUNTER(num_unregistered_klasses);
 842   int num_obj_array_klasses = 0;
 843   int num_type_array_klasses = 0;
 844 
 845   int boot_unlinked = 0;
 846   int platform_unlinked = 0;
 847   int app_unlinked = 0;
 848   int unreg_unlinked = 0;
 849 
 850   for (int i = 0; i < klasses()->length(); i++) {
 851     // Some of the code in ConstantPool::remove_unshareable_info() requires the classes
 852     // to be in linked state, so it must be call here before the next loop, which returns
 853     // all classes to unlinked state.
 854     Klass* k = get_buffered_addr(klasses()->at(i));
 855     if (k->is_instance_klass()) {
 856       InstanceKlass::cast(k)->constants()->remove_unshareable_info();
 857     }
 858   }
 859 
 860   for (int i = 0; i < klasses()->length(); i++) {
 861     const char* type;
 862     const char* unlinked = "";
 863     const char* hidden = "";
 864     const char* generated = "";
 865     const char* preloaded_msg = "";
 866     const char* inited_msg = "";
 867     Klass* k = get_buffered_addr(klasses()->at(i));
 868     k->remove_java_mirror();
 869     if (k->is_objArray_klass()) {
 870       // InstanceKlass and TypeArrayKlass will in turn call remove_unshareable_info
 871       // on their array classes.
 872       num_obj_array_klasses ++;
 873       type = "array";
 874     } else if (k->is_typeArray_klass()) {
 875       num_type_array_klasses ++;
 876       type = "array";
 877       k->remove_unshareable_info();
 878     } else {
 879       assert(k->is_instance_klass(), " must be");

 880       InstanceKlass* ik = InstanceKlass::cast(k);
 881       InstanceKlass* src_ik = get_source_addr(ik);
 882       int preloaded = ClassPreloader::is_preloaded_class(src_ik);
 883       int inited = ik->has_preinitialized_mirror();
 884       ADD_COUNT(num_instance_klasses);
 885       if (CDSConfig::is_dumping_dynamic_archive()) {
 886         // For static dump, class loader type are already set.
 887         ik->assign_class_loader_type();
 888       }
 889       if (ik->is_hidden()) {
 890         oop loader = k->class_loader();
 891         if (loader == nullptr) {
 892           type = "boot";
 893           ADD_COUNT(num_boot_klasses);
 894         } else if (loader == SystemDictionary::java_platform_loader()) {
 895           type = "plat";
 896           ADD_COUNT(num_platform_klasses);
 897         } else if (loader == SystemDictionary::java_system_loader()) {
 898           type = "app";
 899           ADD_COUNT(num_app_klasses);
 900         } else {
 901           type = "bad";
 902           assert(0, "shouldn't happen");
 903         }
 904       } else if (ik->is_shared_boot_class()) {
 905         type = "boot";
 906         ADD_COUNT(num_boot_klasses);
 907       } else if (ik->is_shared_platform_class()) {
 908         type = "plat";
 909         ADD_COUNT(num_platform_klasses);
 910       } else if (ik->is_shared_app_class()) {
 911         type = "app";
 912         ADD_COUNT(num_app_klasses);
 913       } else {
 914         assert(ik->is_shared_unregistered_class(), "must be");
 915         type = "unreg";
 916         ADD_COUNT(num_unregistered_klasses);
 917       }
 918 
 919       if (ClassPreloader::is_vm_class(src_ik)) {
 920         ADD_COUNT(num_vm_klasses);
 921       }
 922 
 923       if (!ik->is_linked()) {
 924         ADD_COUNT(num_unlinked_klasses);
 925         unlinked = " unlinked";
 926         if (ik->is_shared_boot_class()) {
 927           boot_unlinked ++;
 928         } else if (ik->is_shared_platform_class()) {
 929           platform_unlinked ++;
 930         } else if (ik->is_shared_app_class()) {
 931           app_unlinked ++;
 932         } else {
 933           unreg_unlinked ++;
 934         }
 935       }
 936 
 937       if (ik->is_hidden()) {
 938         ADD_COUNT(num_hidden_klasses);
 939         hidden = " hidden";
 940       }
 941 
 942       if (ik->is_generated_shared_class()) {
 943         generated = " generated";
 944       }
 945       if (preloaded) {
 946         preloaded_msg = " preloaded";
 947       }
 948       if (inited) {
 949         inited_msg = " inited";
 950       }
 951 
 952       MetaspaceShared::rewrite_nofast_bytecodes_and_calculate_fingerprints(Thread::current(), ik);
 953       ik->remove_unshareable_info();
 954     }
 955 
 956     if (log_is_enabled(Debug, cds, class)) {
 957       ResourceMark rm;
 958       log_debug(cds, class)("klasses[%5d] = " PTR_FORMAT " %-5s %s%s%s%s%s%s", i,
 959                             p2i(to_requested(k)), type, k->external_name(),
 960                             hidden, unlinked, generated, preloaded_msg, inited_msg);
 961     }
 962   }
 963 
 964 #define STATS_FORMAT    "= %5d, preloaded = %5d, inited = %5d"
 965 #define STATS_PARAMS(x) num_ ## x, num_ ## x ## _p, num_ ## x ## _i
 966 
 967   log_info(cds)("Number of classes %d", num_instance_klasses + num_obj_array_klasses + num_type_array_klasses);
 968   log_info(cds)("    instance classes   " STATS_FORMAT, STATS_PARAMS(instance_klasses));
 969   log_info(cds)("      boot             " STATS_FORMAT, STATS_PARAMS(boot_klasses));
 970   log_info(cds)("       vm              " STATS_FORMAT, STATS_PARAMS(vm_klasses));
 971   log_info(cds)("      platform         " STATS_FORMAT, STATS_PARAMS(platform_klasses));
 972   log_info(cds)("      app              " STATS_FORMAT, STATS_PARAMS(app_klasses));
 973   log_info(cds)("      unregistered     " STATS_FORMAT, STATS_PARAMS(unregistered_klasses));
 974   log_info(cds)("      (hidden)         " STATS_FORMAT, STATS_PARAMS(hidden_klasses));
 975   log_info(cds)("      (unlinked)       " STATS_FORMAT ", boot = %d, plat = %d, app = %d, unreg = %d",
 976                                                               STATS_PARAMS(unlinked_klasses),
 977                                                               boot_unlinked, platform_unlinked,
 978                                                               app_unlinked, unreg_unlinked);
 979   log_info(cds)("    obj array classes  = %5d", num_obj_array_klasses);
 980   log_info(cds)("    type array classes = %5d", num_type_array_klasses);
 981   log_info(cds)("               symbols = %5d", _symbols->length());
 982 
 983 #undef STATS_FORMAT
 984 #undef STATS_PARAMS
 985 
 986   DynamicArchive::make_array_klasses_shareable();
 987 }
 988 
 989 void ArchiveBuilder::make_training_data_shareable() {
 990   auto clean_td = [&] (address& src_obj,  SourceObjInfo& info) {
 991     if (!is_in_buffer_space(info.buffered_addr())) {
 992       return;
 993     }
 994 
 995     if (info.msotype() == MetaspaceObj::KlassTrainingDataType ||
 996         info.msotype() == MetaspaceObj::MethodTrainingDataType ||
 997         info.msotype() == MetaspaceObj::CompileTrainingDataType) {
 998       TrainingData* buffered_td = (TrainingData*)info.buffered_addr();
 999       buffered_td->remove_unshareable_info();
1000     } else if (info.msotype() == MetaspaceObj::MethodDataType) {
1001       MethodData* buffered_mdo = (MethodData*)info.buffered_addr();
1002       buffered_mdo->remove_unshareable_info();
1003     } else if (info.msotype() == MetaspaceObj::MethodCountersType) {
1004       MethodCounters* buffered_mc = (MethodCounters*)info.buffered_addr();
1005       buffered_mc->remove_unshareable_info();
1006     }
1007   };
1008   _src_obj_table.iterate_all(clean_td);
1009 }
1010 
1011 void ArchiveBuilder::serialize_dynamic_archivable_items(SerializeClosure* soc) {
1012   SymbolTable::serialize_shared_table_header(soc, false);
1013   SystemDictionaryShared::serialize_dictionary_headers(soc, false);
1014   DynamicArchive::serialize_array_klasses(soc);
1015   ClassPreloader::serialize(soc, false);
1016   FinalImageRecipes::serialize(soc, false);
1017   TrainingData::serialize_training_data(soc);
1018 }
1019 
1020 uintx ArchiveBuilder::buffer_to_offset(address p) const {
1021   address requested_p = to_requested(p);
1022   assert(requested_p >= _requested_static_archive_bottom, "must be");
1023   return requested_p - _requested_static_archive_bottom;
1024 }
1025 
1026 uintx ArchiveBuilder::any_to_offset(address p) const {
1027   if (is_in_mapped_static_archive(p)) {
1028     assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
1029     return p - _mapped_static_archive_bottom;
1030   }
1031   if (!is_in_buffer_space(p)) {
1032     // p must be a "source" address
1033     p = get_buffered_addr(p);
1034   }
1035   return buffer_to_offset(p);
1036 }
1037 
1038 void ArchiveBuilder::start_cc_region() {
1039   ro_region()->pack();
1040   start_dump_region(&_cc_region);
1041 }
1042 
1043 void ArchiveBuilder::end_cc_region() {
1044   _cc_region.pack();
1045 }
1046 
1047 #if INCLUDE_CDS_JAVA_HEAP
1048 narrowKlass ArchiveBuilder::get_requested_narrow_klass(Klass* k) {
1049   assert(CDSConfig::is_dumping_heap(), "sanity");
1050   k = get_buffered_klass(k);
1051   Klass* requested_k = to_requested(k);
1052   address narrow_klass_base = _requested_static_archive_bottom; // runtime encoding base == runtime mapping start
1053   const int narrow_klass_shift = ArchiveHeapWriter::precomputed_narrow_klass_shift;
1054   return CompressedKlassPointers::encode_not_null(requested_k, narrow_klass_base, narrow_klass_shift);
1055 }
1056 #endif // INCLUDE_CDS_JAVA_HEAP
1057 
1058 // RelocateBufferToRequested --- Relocate all the pointers in rw/ro,
1059 // so that the archive can be mapped to the "requested" location without runtime relocation.
1060 //
1061 // - See ArchiveBuilder header for the definition of "buffer", "mapped" and "requested"
1062 // - ArchivePtrMarker::ptrmap() marks all the pointers in the rw/ro regions
1063 // - Every pointer must have one of the following values:
1064 //   [a] nullptr:
1065 //       No relocation is needed. Remove this pointer from ptrmap so we don't need to
1066 //       consider it at runtime.
1067 //   [b] Points into an object X which is inside the buffer:
1068 //       Adjust this pointer by _buffer_to_requested_delta, so it points to X
1069 //       when the archive is mapped at the requested location.
1070 //   [c] Points into an object Y which is inside mapped static archive:
1071 //       - This happens only during dynamic dump
1072 //       - Adjust this pointer by _mapped_to_requested_static_archive_delta,
1073 //         so it points to Y when the static archive is mapped at the requested location.
1074 template <bool STATIC_DUMP>
1075 class RelocateBufferToRequested : public BitMapClosure {
1076   ArchiveBuilder* _builder;
1077   address _buffer_bottom;
1078   intx _buffer_to_requested_delta;
1079   intx _mapped_to_requested_static_archive_delta;
1080   size_t _max_non_null_offset;
1081 
1082  public:
1083   RelocateBufferToRequested(ArchiveBuilder* builder) {
1084     _builder = builder;
1085     _buffer_bottom = _builder->buffer_bottom();
1086     _buffer_to_requested_delta = builder->buffer_to_requested_delta();
1087     _mapped_to_requested_static_archive_delta = builder->requested_static_archive_bottom() - builder->mapped_static_archive_bottom();
1088     _max_non_null_offset = 0;
1089 
1090     address bottom = _builder->buffer_bottom();
1091     address top = _builder->buffer_top();
1092     address new_bottom = bottom + _buffer_to_requested_delta;
1093     address new_top = top + _buffer_to_requested_delta;
1094     log_debug(cds)("Relocating archive from [" INTPTR_FORMAT " - " INTPTR_FORMAT "] to "
1095                    "[" INTPTR_FORMAT " - " INTPTR_FORMAT "]",
1096                    p2i(bottom), p2i(top),
1097                    p2i(new_bottom), p2i(new_top));
1098   }
1099 
1100   bool do_bit(size_t offset) {
1101     address* p = (address*)_buffer_bottom + offset;
1102     assert(_builder->is_in_buffer_space(p), "pointer must live in buffer space");
1103 
1104     if (*p == nullptr) {
1105       // todo -- clear bit, etc
1106       ArchivePtrMarker::ptrmap()->clear_bit(offset);
1107     } else {
1108       if (STATIC_DUMP) {
1109         assert(_builder->is_in_buffer_space(*p), "old pointer must point inside buffer space");
1110         *p += _buffer_to_requested_delta;
1111         assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
1112       } else {
1113         if (_builder->is_in_buffer_space(*p)) {
1114           *p += _buffer_to_requested_delta;
1115           // assert is in requested dynamic archive
1116         } else {
1117           assert(_builder->is_in_mapped_static_archive(*p), "old pointer must point inside buffer space or mapped static archive");
1118           *p += _mapped_to_requested_static_archive_delta;
1119           assert(_builder->is_in_requested_static_archive(*p), "new pointer must point inside requested archive");
1120         }
1121       }
1122       _max_non_null_offset = offset;
1123     }
1124 
1125     return true; // keep iterating
1126   }
1127 
1128   void doit() {
1129     ArchivePtrMarker::ptrmap()->iterate(this);
1130     ArchivePtrMarker::compact(_max_non_null_offset);
1131   }
1132 };
1133 
1134 
1135 void ArchiveBuilder::relocate_to_requested() {
1136   if (!ro_region()->is_packed()) {
1137     ro_region()->pack();
1138   }
1139 
1140   size_t my_archive_size = buffer_top() - buffer_bottom();
1141 
1142   if (CDSConfig::is_dumping_static_archive()) {
1143     _requested_static_archive_top = _requested_static_archive_bottom + my_archive_size;
1144     RelocateBufferToRequested<true> patcher(this);
1145     patcher.doit();
1146   } else {
1147     assert(CDSConfig::is_dumping_dynamic_archive(), "must be");
1148     _requested_dynamic_archive_top = _requested_dynamic_archive_bottom + my_archive_size;
1149     RelocateBufferToRequested<false> patcher(this);
1150     patcher.doit();
1151   }
1152 }
1153 
1154 // Write detailed info to a mapfile to analyze contents of the archive.
1155 // static dump:
1156 //   java -Xshare:dump -Xlog:cds+map=trace:file=cds.map:none:filesize=0
1157 // dynamic dump:
1158 //   java -cp MyApp.jar -XX:ArchiveClassesAtExit=MyApp.jsa \
1159 //        -Xlog:cds+map=trace:file=cds.map:none:filesize=0 MyApp
1160 //
1161 // We need to do some address translation because the buffers used at dump time may be mapped to
1162 // a different location at runtime. At dump time, the buffers may be at arbitrary locations
1163 // picked by the OS. At runtime, we try to map at a fixed location (SharedBaseAddress). For
1164 // consistency, we log everything using runtime addresses.
1165 class ArchiveBuilder::CDSMapLogger : AllStatic {
1166   static intx buffer_to_runtime_delta() {
1167     // Translate the buffers used by the RW/RO regions to their eventual (requested) locations
1168     // at runtime.
1169     return ArchiveBuilder::current()->buffer_to_requested_delta();
1170   }
1171 
1172   // rw/ro regions only
1173   static void log_metaspace_region(const char* name, DumpRegion* region,
1174                                    const ArchiveBuilder::SourceObjList* src_objs) {
1175     address region_base = address(region->base());
1176     address region_top  = address(region->top());
1177     log_region(name, region_base, region_top, region_base + buffer_to_runtime_delta());
1178     log_metaspace_objects(region, src_objs);
1179   }
1180 
1181 #define _LOG_PREFIX PTR_FORMAT ": @@ %-17s %d"
1182 
1183   static void log_klass(Klass* k, address runtime_dest, const char* type_name, int bytes, Thread* current) {
1184     ResourceMark rm(current);
1185     log_debug(cds, map)(_LOG_PREFIX " %s",
1186                         p2i(runtime_dest), type_name, bytes, k->external_name());
1187   }
1188   static void log_method(Method* m, address runtime_dest, const char* type_name, int bytes, Thread* current) {
1189     ResourceMark rm(current);
1190     log_debug(cds, map)(_LOG_PREFIX " %s",
1191                         p2i(runtime_dest), type_name, bytes,  m->external_name());
1192   }
1193 
1194   // rw/ro regions only
1195   static void log_metaspace_objects(DumpRegion* region, const ArchiveBuilder::SourceObjList* src_objs) {
1196     address last_obj_base = address(region->base());
1197     address last_obj_end  = address(region->base());
1198     address region_end    = address(region->end());
1199     Thread* current = Thread::current();
1200     for (int i = 0; i < src_objs->objs()->length(); i++) {
1201       SourceObjInfo* src_info = src_objs->at(i);
1202       address src = src_info->source_addr();
1203       address dest = src_info->buffered_addr();
1204       log_as_hex(last_obj_base, dest, last_obj_base + buffer_to_runtime_delta());
1205       address runtime_dest = dest + buffer_to_runtime_delta();
1206       int bytes = src_info->size_in_bytes();
1207 
1208       MetaspaceObj::Type type = src_info->msotype();
1209       const char* type_name = MetaspaceObj::type_name(type);
1210 
1211       switch (type) {
1212       case MetaspaceObj::ClassType:
1213         log_klass((Klass*)src, runtime_dest, type_name, bytes, current);
1214         break;
1215       case MetaspaceObj::ConstantPoolType:
1216         log_klass(((ConstantPool*)src)->pool_holder(),
1217                     runtime_dest, type_name, bytes, current);
1218         break;
1219       case MetaspaceObj::ConstantPoolCacheType:
1220         log_klass(((ConstantPoolCache*)src)->constant_pool()->pool_holder(),
1221                     runtime_dest, type_name, bytes, current);
1222         break;
1223       case MetaspaceObj::MethodType:
1224         log_method((Method*)src, runtime_dest, type_name, bytes, current);
1225         break;
1226       case MetaspaceObj::ConstMethodType:
1227         log_method(((ConstMethod*)src)->method(), runtime_dest, type_name, bytes, current);
1228         break;
1229       case MetaspaceObj::SymbolType:
1230         {
1231           ResourceMark rm(current);
1232           Symbol* s = (Symbol*)src;
1233           log_debug(cds, map)(_LOG_PREFIX " %s", p2i(runtime_dest), type_name, bytes,
1234                               s->as_quoted_ascii());
1235         }
1236         break;
1237       default:
1238         log_debug(cds, map)(_LOG_PREFIX, p2i(runtime_dest), type_name, bytes);
1239         break;
1240       }
1241 
1242       last_obj_base = dest;
1243       last_obj_end  = dest + bytes;
1244     }
1245 
1246     log_as_hex(last_obj_base, last_obj_end, last_obj_base + buffer_to_runtime_delta());
1247     if (last_obj_end < region_end) {
1248       log_debug(cds, map)(PTR_FORMAT ": @@ Misc data " SIZE_FORMAT " bytes",
1249                           p2i(last_obj_end + buffer_to_runtime_delta()),
1250                           size_t(region_end - last_obj_end));
1251       log_as_hex(last_obj_end, region_end, last_obj_end + buffer_to_runtime_delta());
1252     }
1253   }
1254 
1255 #undef _LOG_PREFIX
1256 
1257   // Log information about a region, whose address at dump time is [base .. top). At
1258   // runtime, this region will be mapped to requested_base. requested_base is 0 if this
1259   // region will be mapped at os-selected addresses (such as the bitmap region), or will
1260   // be accessed with os::read (the header).
1261   //
1262   // Note: across -Xshare:dump runs, base may be different, but requested_base should
1263   // be the same as the archive contents should be deterministic.
1264   static void log_region(const char* name, address base, address top, address requested_base) {
1265     size_t size = top - base;
1266     base = requested_base;
1267     top = requested_base + size;
1268     log_info(cds, map)("[%-18s " PTR_FORMAT " - " PTR_FORMAT " " SIZE_FORMAT_W(9) " bytes]",
1269                        name, p2i(base), p2i(top), size);
1270   }
1271 
1272 #if INCLUDE_CDS_JAVA_HEAP
1273   static void log_heap_region(ArchiveHeapInfo* heap_info) {
1274     MemRegion r = heap_info->buffer_region();
1275     address start = address(r.start()); // start of the current oop inside the buffer
1276     address end = address(r.end());
1277     log_region("heap", start, end, ArchiveHeapWriter::buffered_addr_to_requested_addr(start));
1278 
1279     LogStreamHandle(Info, cds, map) st;
1280 
1281     while (start < end) {
1282       size_t byte_size;
1283       oop source_oop = ArchiveHeapWriter::buffered_addr_to_source_obj(start);
1284       address requested_start = ArchiveHeapWriter::buffered_addr_to_requested_addr(start);
1285       st.print(PTR_FORMAT ": @@ Object ", p2i(requested_start));
1286       int permobj_segment = -1;
1287       int permobj_segment_length = -1;
1288 
1289       if (source_oop != nullptr) {
1290         // This is a regular oop that got archived.
1291         print_oop_with_requested_addr_cr(&st, source_oop, false);
1292         byte_size = source_oop->size() * BytesPerWord;
1293       } else if (start == ArchiveHeapWriter::buffered_heap_roots_addr()) {
1294         // HeapShared::roots() is copied specially, so it doesn't exist in
1295         // ArchiveHeapWriter::BufferOffsetToSourceObjectTable.
1296         // See ArchiveHeapWriter::copy_roots_to_buffer().
1297         st.print_cr("HeapShared::roots[%d]", HeapShared::pending_roots()->length());
1298         byte_size = ArchiveHeapWriter::heap_roots_word_size() * BytesPerWord;
1299       } else if ((byte_size = ArchiveHeapWriter::get_filler_size_at(start)) > 0) {
1300         // We have a filler oop, which also does not exist in BufferOffsetToSourceObjectTable.
1301         st.print_cr("filler " SIZE_FORMAT " bytes", byte_size);
1302       } else if ((permobj_segment = ArchiveHeapWriter::get_permobj_segment_at(start, &byte_size, &permobj_segment_length)) >= 0) {
1303         st.print_cr("permobj_%d[%d] %zu bytes", permobj_segment, permobj_segment_length, byte_size);
1304       } else {
1305         ShouldNotReachHere();
1306       }
1307 
1308       address oop_end = start + byte_size;
1309       log_as_hex(start, oop_end, requested_start, /*is_heap=*/true);
1310 
1311       if (source_oop != nullptr) {
1312         log_oop_details(heap_info, source_oop, /*buffered_addr=*/start);
1313       } else if (start == ArchiveHeapWriter::buffered_heap_roots_addr()) {
1314         log_heap_roots();
1315       } else if (permobj_segment >= 0) {
1316         log_permobj_segment(permobj_segment, permobj_segment_length);
1317       }
1318       start = oop_end;
1319     }
1320   }
1321 
1322   // ArchivedFieldPrinter is used to print the fields of archived objects. We can't
1323   // use _source_obj->print_on(), because we want to print the oop fields
1324   // in _source_obj with their requested addresses using print_oop_with_requested_addr_cr().
1325   class ArchivedFieldPrinter : public FieldClosure {
1326     ArchiveHeapInfo* _heap_info;
1327     outputStream* _st;
1328     oop _source_obj;
1329     address _buffered_addr;
1330   public:
1331     ArchivedFieldPrinter(ArchiveHeapInfo* heap_info, outputStream* st, oop src_obj, address buffered_addr) :
1332       _heap_info(heap_info), _st(st), _source_obj(src_obj), _buffered_addr(buffered_addr) {}
1333 
1334     void do_field(fieldDescriptor* fd) {
1335       _st->print(" - ");
1336       BasicType ft = fd->field_type();
1337       switch (ft) {
1338       case T_ARRAY:
1339       case T_OBJECT:
1340         fd->print_on(_st); // print just the name and offset
1341         print_oop_with_requested_addr_cr(_st, _source_obj->obj_field(fd->offset()));
1342         break;
1343       default:
1344         if (ArchiveHeapWriter::is_marked_as_native_pointer(_heap_info, _source_obj, fd->offset())) {
1345           print_as_native_pointer(fd);
1346         } else {
1347           fd->print_on_for(_st, cast_to_oop(_buffered_addr)); // name, offset, value
1348           _st->cr();
1349         }
1350       }
1351     }
1352 
1353     void print_as_native_pointer(fieldDescriptor* fd) {
1354       LP64_ONLY(assert(fd->field_type() == T_LONG, "must be"));
1355       NOT_LP64 (assert(fd->field_type() == T_INT,  "must be"));
1356 
1357       // We have a field that looks like an integer, but it's actually a pointer to a MetaspaceObj.
1358       address source_native_ptr = (address)
1359           LP64_ONLY(_source_obj->long_field(fd->offset()))
1360           NOT_LP64( _source_obj->int_field (fd->offset()));
1361       ArchiveBuilder* builder = ArchiveBuilder::current();
1362 
1363       // The value of the native pointer at runtime.
1364       address requested_native_ptr = builder->to_requested(builder->get_buffered_addr(source_native_ptr));
1365 
1366       // The address of _source_obj at runtime
1367       oop requested_obj = ArchiveHeapWriter::source_obj_to_requested_obj(_source_obj);
1368       // The address of this field in the requested space
1369       assert(requested_obj != nullptr, "Attempting to load field from null oop");
1370       address requested_field_addr = cast_from_oop<address>(requested_obj) + fd->offset();
1371 
1372       fd->print_on(_st);
1373       _st->print_cr(PTR_FORMAT " (marked metadata pointer @" PTR_FORMAT " )",
1374                     p2i(requested_native_ptr), p2i(requested_field_addr));
1375     }
1376   };
1377 
1378   // Print the fields of instanceOops, or the elements of arrayOops
1379   static void log_oop_details(ArchiveHeapInfo* heap_info, oop source_oop, address buffered_addr) {
1380     LogStreamHandle(Trace, cds, map, oops) st;
1381     if (st.is_enabled()) {
1382       Klass* source_klass = source_oop->klass();
1383       ArchiveBuilder* builder = ArchiveBuilder::current();
1384       Klass* requested_klass = builder->to_requested(builder->get_buffered_addr(source_klass));
1385 
1386       st.print(" - klass: ");
1387       source_klass->print_value_on(&st);
1388       st.print(" " PTR_FORMAT, p2i(requested_klass));
1389       st.cr();
1390 
1391       if (source_oop->is_typeArray()) {
1392         TypeArrayKlass::cast(source_klass)->oop_print_elements_on(typeArrayOop(source_oop), &st);
1393       } else if (source_oop->is_objArray()) {
1394         objArrayOop source_obj_array = objArrayOop(source_oop);
1395         for (int i = 0; i < source_obj_array->length(); i++) {
1396           st.print(" -%4d: ", i);
1397           print_oop_with_requested_addr_cr(&st, source_obj_array->obj_at(i));
1398         }
1399       } else {
1400         st.print_cr(" - fields (" SIZE_FORMAT " words):", source_oop->size());
1401         ArchivedFieldPrinter print_field(heap_info, &st, source_oop, buffered_addr);
1402         InstanceKlass::cast(source_klass)->print_nonstatic_fields(&print_field);
1403 
1404         if (java_lang_Class::is_instance(source_oop)) {
1405           st.print(" - signature: ");
1406           if (java_lang_Class::is_primitive(source_oop)) {
1407             st.print("primitive ??");
1408           } else {
1409             java_lang_Class::print_signature(source_oop, &st);            
1410           }
1411           st.cr();
1412         }
1413       }
1414     }
1415   }
1416 
1417   static void log_heap_roots() {
1418     LogStreamHandle(Trace, cds, map, oops) st;
1419     if (st.is_enabled()) {
1420       for (int i = 0; i < HeapShared::pending_roots()->length(); i++) {
1421         st.print("roots[%4d]: ", i);
1422         print_oop_with_requested_addr_cr(&st, HeapShared::pending_roots()->at(i));
1423       }
1424     }
1425   }
1426 
1427   static void log_permobj_segment(int permobj_segment, int permobj_segment_length) {
1428     LogStreamHandle(Trace, cds, map, oops) st;
1429     if (st.is_enabled()) {
1430       for (int i = 0; i < permobj_segment_length; i++) {
1431         st.print("permobj_%d[%4d]: ", permobj_segment, i);
1432         print_oop_with_requested_addr_cr(&st, ArchiveHeapWriter::get_permobj_source_addr(permobj_segment, i));
1433       }
1434     }
1435   }
1436 
1437 
1438   // The output looks like this. The first number is the requested address. The second number is
1439   // the narrowOop version of the requested address.
1440   //     0x00000007ffc7e840 (0xfff8fd08) java.lang.Class
1441   //     0x00000007ffc000f8 (0xfff8001f) [B length: 11
1442   static void print_oop_with_requested_addr_cr(outputStream* st, oop source_oop, bool print_addr = true) {
1443     if (source_oop == nullptr) {
1444       st->print_cr("null");
1445     } else {
1446       ResourceMark rm;
1447       oop requested_obj = ArchiveHeapWriter::source_obj_to_requested_obj(source_oop);
1448       if (print_addr) {
1449         st->print(PTR_FORMAT " ", p2i(requested_obj));
1450       }
1451       if (UseCompressedOops) {
1452         st->print("(0x%08x) ", CompressedOops::narrow_oop_value(requested_obj));
1453       }
1454       if (source_oop->is_array()) {
1455         int array_len = arrayOop(source_oop)->length();
1456         st->print_cr("%s length: %d", source_oop->klass()->external_name(), array_len);
1457       } else {
1458         st->print("%s", source_oop->klass()->external_name());
1459         if (java_lang_invoke_MethodType::is_instance(source_oop)) {
1460           st->print(" ");
1461           java_lang_invoke_MethodType::print_signature(source_oop, st);
1462         }
1463         st->cr();
1464       }
1465     }
1466   }
1467 #endif // INCLUDE_CDS_JAVA_HEAP
1468 
1469   // Log all the data [base...top). Pretend that the base address
1470   // will be mapped to requested_base at run-time.
1471   static void log_as_hex(address base, address top, address requested_base, bool is_heap = false) {
1472     assert(top >= base, "must be");
1473 
1474     LogStreamHandle(Trace, cds, map) lsh;
1475     if (lsh.is_enabled()) {
1476       int unitsize = sizeof(address);
1477       if (is_heap && UseCompressedOops) {
1478         // This makes the compressed oop pointers easier to read, but
1479         // longs and doubles will be split into two words.
1480         unitsize = sizeof(narrowOop);
1481       }
1482       os::print_hex_dump(&lsh, base, top, unitsize, /* print_ascii=*/true, /* bytes_per_line=*/32, requested_base);
1483     }
1484   }
1485 
1486   static void log_header(FileMapInfo* mapinfo) {
1487     LogStreamHandle(Info, cds, map) lsh;
1488     if (lsh.is_enabled()) {
1489       mapinfo->print(&lsh);
1490     }
1491   }
1492 
1493 public:
1494   static void log(ArchiveBuilder* builder, FileMapInfo* mapinfo,
1495                   ArchiveHeapInfo* heap_info,
1496                   char* bitmap, size_t bitmap_size_in_bytes) {
1497     log_info(cds, map)("%s CDS archive map for %s", CDSConfig::is_dumping_static_archive() ? "Static" : "Dynamic", mapinfo->full_path());
1498 
1499     address header = address(mapinfo->header());
1500     address header_end = header + mapinfo->header()->header_size();
1501     log_region("header", header, header_end, nullptr);
1502     log_header(mapinfo);
1503     log_as_hex(header, header_end, nullptr);
1504 
1505     DumpRegion* rw_region = &builder->_rw_region;
1506     DumpRegion* ro_region = &builder->_ro_region;
1507 
1508     log_metaspace_region("rw region", rw_region, &builder->_rw_src_objs);
1509     log_metaspace_region("ro region", ro_region, &builder->_ro_src_objs);
1510 
1511     address bitmap_end = address(bitmap + bitmap_size_in_bytes);
1512     log_region("bitmap", address(bitmap), bitmap_end, nullptr);
1513     log_as_hex((address)bitmap, bitmap_end, nullptr);
1514 
1515 #if INCLUDE_CDS_JAVA_HEAP
1516     if (heap_info->is_used()) {
1517       log_heap_region(heap_info);
1518     }
1519 #endif
1520 
1521     log_info(cds, map)("[End of CDS archive map]");
1522   }
1523 }; // end ArchiveBuilder::CDSMapLogger
1524 
1525 void ArchiveBuilder::print_stats() {
1526   _alloc_stats.print_stats(int(_ro_region.used()), int(_rw_region.used()));
1527 }
1528 
1529 void ArchiveBuilder::write_archive(FileMapInfo* mapinfo, ArchiveHeapInfo* heap_info) {
1530   // Make sure NUM_CDS_REGIONS (exported in cds.h) agrees with
1531   // MetaspaceShared::n_regions (internal to hotspot).
1532   assert(NUM_CDS_REGIONS == MetaspaceShared::n_regions, "sanity");
1533 
1534   write_region(mapinfo, MetaspaceShared::rw, &_rw_region, /*read_only=*/false,/*allow_exec=*/false);
1535   write_region(mapinfo, MetaspaceShared::ro, &_ro_region, /*read_only=*/true, /*allow_exec=*/false);
1536   write_region(mapinfo, MetaspaceShared::cc, &_cc_region, /*read_only=*/false,/*allow_exec=*/true);
1537 
1538   // Split pointer map into read-write and read-only bitmaps
1539   ArchivePtrMarker::initialize_rw_ro_cc_maps(&_rw_ptrmap, &_ro_ptrmap, &_cc_ptrmap);
1540 
1541   size_t bitmap_size_in_bytes;
1542   char* bitmap = mapinfo->write_bitmap_region(ArchivePtrMarker::rw_ptrmap(),
1543                                               ArchivePtrMarker::ro_ptrmap(),
1544                                               ArchivePtrMarker::cc_ptrmap(),
1545                                               heap_info,
1546                                               bitmap_size_in_bytes);
1547 
1548   if (heap_info->is_used()) {
1549     _total_heap_region_size = mapinfo->write_heap_region(heap_info);
1550   }
1551 
1552   print_region_stats(mapinfo, heap_info);
1553 
1554   mapinfo->set_requested_base((char*)MetaspaceShared::requested_base_address());
1555   mapinfo->set_header_crc(mapinfo->compute_header_crc());
1556   // After this point, we should not write any data into mapinfo->header() since this
1557   // would corrupt its checksum we have calculated before.
1558   mapinfo->write_header();
1559   mapinfo->close();
1560 
1561   if (log_is_enabled(Info, cds)) {
1562     print_stats();
1563   }
1564 
1565   if (log_is_enabled(Info, cds, map)) {
1566     CDSMapLogger::log(this, mapinfo, heap_info,
1567                       bitmap, bitmap_size_in_bytes);
1568   }
1569   CDS_JAVA_HEAP_ONLY(HeapShared::destroy_archived_object_cache());
1570   FREE_C_HEAP_ARRAY(char, bitmap);
1571 }
1572 
1573 void ArchiveBuilder::write_region(FileMapInfo* mapinfo, int region_idx, DumpRegion* dump_region, bool read_only,  bool allow_exec) {
1574   mapinfo->write_region(region_idx, dump_region->base(), dump_region->used(), read_only, allow_exec);
1575 }
1576 
1577 void ArchiveBuilder::print_region_stats(FileMapInfo *mapinfo, ArchiveHeapInfo* heap_info) {
1578   // Print statistics of all the regions
1579   const size_t bitmap_used = mapinfo->region_at(MetaspaceShared::bm)->used();
1580   const size_t bitmap_reserved = mapinfo->region_at(MetaspaceShared::bm)->used_aligned();
1581   const size_t total_reserved = _ro_region.reserved()  + _rw_region.reserved() +
1582                                 bitmap_reserved +
1583                                 _total_heap_region_size;
1584   const size_t total_bytes = _ro_region.used()  + _rw_region.used() +
1585                              bitmap_used +
1586                              _total_heap_region_size;
1587   const double total_u_perc = percent_of(total_bytes, total_reserved);
1588 
1589   _rw_region.print(total_reserved);
1590   _ro_region.print(total_reserved);
1591   _cc_region.print(total_reserved);
1592 
1593   print_bitmap_region_stats(bitmap_used, total_reserved);
1594 
1595   if (heap_info->is_used()) {
1596     print_heap_region_stats(heap_info, total_reserved);
1597   }
1598 
1599   log_debug(cds)("total   : " SIZE_FORMAT_W(9) " [100.0%% of total] out of " SIZE_FORMAT_W(9) " bytes [%5.1f%% used]",
1600                  total_bytes, total_reserved, total_u_perc);
1601 }
1602 
1603 void ArchiveBuilder::print_bitmap_region_stats(size_t size, size_t total_size) {
1604   log_debug(cds)("bm space: " SIZE_FORMAT_W(9) " [ %4.1f%% of total] out of " SIZE_FORMAT_W(9) " bytes [100.0%% used]",
1605                  size, size/double(total_size)*100.0, size);
1606 }
1607 
1608 void ArchiveBuilder::print_heap_region_stats(ArchiveHeapInfo *info, size_t total_size) {
1609   char* start = info->buffer_start();
1610   size_t size = info->buffer_byte_size();
1611   char* top = start + size;
1612   log_debug(cds)("hp space: " SIZE_FORMAT_W(9) " [ %4.1f%% of total] out of " SIZE_FORMAT_W(9) " bytes [100.0%% used] at " INTPTR_FORMAT,
1613                      size, size/double(total_size)*100.0, size, p2i(start));
1614 }
1615 
1616 void ArchiveBuilder::report_out_of_space(const char* name, size_t needed_bytes) {
1617   // This is highly unlikely to happen on 64-bits because we have reserved a 4GB space.
1618   // On 32-bit we reserve only 256MB so you could run out of space with 100,000 classes
1619   // or so.
1620   _rw_region.print_out_of_space_msg(name, needed_bytes);
1621   _ro_region.print_out_of_space_msg(name, needed_bytes);
1622 
1623   log_error(cds)("Unable to allocate from '%s' region: Please reduce the number of shared classes.", name);
1624   MetaspaceShared::unrecoverable_writing_error();
1625 }
--- EOF ---