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