1 /*
   2  * Copyright (c) 2003, 2018, 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 "jvm.h"
  27 #include "classfile/classLoader.inline.hpp"
  28 #include "classfile/classLoaderExt.hpp"
  29 #include "classfile/compactHashtable.inline.hpp"
  30 #include "classfile/stringTable.hpp"
  31 #include "classfile/symbolTable.hpp"
  32 #include "classfile/systemDictionaryShared.hpp"
  33 #include "classfile/altHashing.hpp"
  34 #include "logging/log.hpp"
  35 #include "logging/logStream.hpp"
  36 #include "logging/logMessage.hpp"
  37 #include "memory/filemap.hpp"
  38 #include "memory/metadataFactory.hpp"
  39 #include "memory/metaspaceClosure.hpp"
  40 #include "memory/metaspaceShared.hpp"
  41 #include "memory/oopFactory.hpp"
  42 #include "oops/compressedOops.inline.hpp"
  43 #include "oops/objArrayOop.hpp"
  44 #include "prims/jvmtiExport.hpp"
  45 #include "runtime/arguments.hpp"
  46 #include "runtime/java.hpp"
  47 #include "runtime/os.hpp"
  48 #include "runtime/vm_version.hpp"
  49 #include "services/memTracker.hpp"
  50 #include "utilities/align.hpp"
  51 #include "utilities/defaultStream.hpp"
  52 #if INCLUDE_G1GC
  53 #include "gc/g1/g1CollectedHeap.hpp"
  54 #endif
  55 
  56 # include <sys/stat.h>
  57 # include <errno.h>
  58 
  59 #ifndef O_BINARY       // if defined (Win32) use binary files.
  60 #define O_BINARY 0     // otherwise do nothing.
  61 #endif
  62 
  63 extern address JVM_FunctionAtStart();
  64 extern address JVM_FunctionAtEnd();
  65 
  66 // Complain and stop. All error conditions occurring during the writing of
  67 // an archive file should stop the process.  Unrecoverable errors during
  68 // the reading of the archive file should stop the process.
  69 
  70 static void fail(const char *msg, va_list ap) {
  71   // This occurs very early during initialization: tty is not initialized.
  72   jio_fprintf(defaultStream::error_stream(),
  73               "An error has occurred while processing the"
  74               " shared archive file.\n");
  75   jio_vfprintf(defaultStream::error_stream(), msg, ap);
  76   jio_fprintf(defaultStream::error_stream(), "\n");
  77   // Do not change the text of the below message because some tests check for it.
  78   vm_exit_during_initialization("Unable to use shared archive.", NULL);
  79 }
  80 
  81 
  82 void FileMapInfo::fail_stop(const char *msg, ...) {
  83         va_list ap;
  84   va_start(ap, msg);
  85   fail(msg, ap);        // Never returns.
  86   va_end(ap);           // for completeness.
  87 }
  88 
  89 
  90 // Complain and continue.  Recoverable errors during the reading of the
  91 // archive file may continue (with sharing disabled).
  92 //
  93 // If we continue, then disable shared spaces and close the file.
  94 
  95 void FileMapInfo::fail_continue(const char *msg, ...) {
  96   va_list ap;
  97   va_start(ap, msg);
  98   MetaspaceShared::set_archive_loading_failed();
  99   if (PrintSharedArchiveAndExit && _validating_shared_path_table) {
 100     // If we are doing PrintSharedArchiveAndExit and some of the classpath entries
 101     // do not validate, we can still continue "limping" to validate the remaining
 102     // entries. No need to quit.
 103     tty->print("[");
 104     tty->vprint(msg, ap);
 105     tty->print_cr("]");
 106   } else {
 107     if (RequireSharedSpaces) {
 108       fail(msg, ap);
 109     } else {
 110       if (log_is_enabled(Info, cds)) {
 111         ResourceMark rm;
 112         LogStream ls(Log(cds)::info());
 113         ls.print("UseSharedSpaces: ");
 114         ls.vprint_cr(msg, ap);
 115       }
 116     }
 117     UseSharedSpaces = false;
 118     assert(current_info() != NULL, "singleton must be registered");
 119     current_info()->close();
 120   }
 121   va_end(ap);
 122 }
 123 
 124 // Fill in the fileMapInfo structure with data about this VM instance.
 125 
 126 // This method copies the vm version info into header_version.  If the version is too
 127 // long then a truncated version, which has a hash code appended to it, is copied.
 128 //
 129 // Using a template enables this method to verify that header_version is an array of
 130 // length JVM_IDENT_MAX.  This ensures that the code that writes to the CDS file and
 131 // the code that reads the CDS file will both use the same size buffer.  Hence, will
 132 // use identical truncation.  This is necessary for matching of truncated versions.
 133 template <int N> static void get_header_version(char (&header_version) [N]) {
 134   assert(N == JVM_IDENT_MAX, "Bad header_version size");
 135 
 136   const char *vm_version = VM_Version::internal_vm_info_string();
 137   const int version_len = (int)strlen(vm_version);
 138 
 139   if (version_len < (JVM_IDENT_MAX-1)) {
 140     strcpy(header_version, vm_version);
 141 
 142   } else {
 143     // Get the hash value.  Use a static seed because the hash needs to return the same
 144     // value over multiple jvm invocations.
 145     unsigned int hash = AltHashing::murmur3_32(8191, (const jbyte*)vm_version, version_len);
 146 
 147     // Truncate the ident, saving room for the 8 hex character hash value.
 148     strncpy(header_version, vm_version, JVM_IDENT_MAX-9);
 149 
 150     // Append the hash code as eight hex digits.
 151     sprintf(&header_version[JVM_IDENT_MAX-9], "%08x", hash);
 152     header_version[JVM_IDENT_MAX-1] = 0;  // Null terminate.
 153   }
 154 }
 155 
 156 FileMapInfo::FileMapInfo() {
 157   assert(_current_info == NULL, "must be singleton"); // not thread safe
 158   _current_info = this;
 159   memset((void*)this, 0, sizeof(FileMapInfo));
 160   _file_offset = 0;
 161   _file_open = false;
 162   _header = new FileMapHeader();
 163   _header->_version = _invalid_version;
 164   _header->_has_platform_or_app_classes = true;
 165 }
 166 
 167 FileMapInfo::~FileMapInfo() {
 168   assert(_current_info == this, "must be singleton"); // not thread safe
 169   _current_info = NULL;
 170 }
 171 
 172 void FileMapInfo::populate_header(size_t alignment) {
 173   _header->populate(this, alignment);
 174 }
 175 
 176 void FileMapInfo::FileMapHeader::populate(FileMapInfo* mapinfo, size_t alignment) {
 177   _magic = 0xf00baba2;
 178   _version = _current_version;
 179   _alignment = alignment;
 180   _obj_alignment = ObjectAlignmentInBytes;
 181   _compact_strings = CompactStrings;
 182   _narrow_oop_mode = Universe::narrow_oop_mode();
 183   _narrow_oop_base = Universe::narrow_oop_base();
 184   _narrow_oop_shift = Universe::narrow_oop_shift();
 185   _max_heap_size = MaxHeapSize;
 186   _narrow_klass_base = Universe::narrow_klass_base();
 187   _narrow_klass_shift = Universe::narrow_klass_shift();
 188   _shared_path_table_size = mapinfo->_shared_path_table_size;
 189   _shared_path_table = mapinfo->_shared_path_table;
 190   _shared_path_entry_size = mapinfo->_shared_path_entry_size;
 191 
 192   // The following fields are for sanity checks for whether this archive
 193   // will function correctly with this JVM and the bootclasspath it's
 194   // invoked with.
 195 
 196   // JVM version string ... changes on each build.
 197   get_header_version(_jvm_ident);
 198 
 199   ClassLoaderExt::finalize_shared_paths_misc_info();
 200   _app_class_paths_start_index = ClassLoaderExt::app_class_paths_start_index();
 201   _app_module_paths_start_index = ClassLoaderExt::app_module_paths_start_index();
 202 
 203   _verify_local = BytecodeVerificationLocal;
 204   _verify_remote = BytecodeVerificationRemote;
 205   _has_platform_or_app_classes = ClassLoaderExt::has_platform_or_app_classes();
 206 }
 207 
 208 void SharedClassPathEntry::init(const char* name, bool is_modules_image, TRAPS) {
 209   assert(DumpSharedSpaces, "dump time only");
 210   _timestamp = 0;
 211   _filesize  = 0;
 212 
 213   struct stat st;
 214   if (os::stat(name, &st) == 0) {
 215     if ((st.st_mode & S_IFMT) == S_IFDIR) {
 216       _type = dir_entry;
 217     } else {
 218       // The timestamp of the modules_image is not checked at runtime.
 219       if (is_modules_image) {
 220         _type = modules_image_entry;
 221       } else {
 222         _type = jar_entry;
 223         _timestamp = st.st_mtime;
 224       }
 225       _filesize = st.st_size;
 226     }
 227   } else {
 228     // The file/dir must exist, or it would not have been added
 229     // into ClassLoader::classpath_entry().
 230     //
 231     // If we can't access a jar file in the boot path, then we can't
 232     // make assumptions about where classes get loaded from.
 233     FileMapInfo::fail_stop("Unable to open file %s.", name);
 234   }
 235 
 236   size_t len = strlen(name) + 1;
 237   _name = MetadataFactory::new_array<char>(ClassLoaderData::the_null_class_loader_data(), (int)len, THREAD);
 238   strcpy(_name->data(), name);
 239 }
 240 
 241 bool SharedClassPathEntry::validate(bool is_class_path) {
 242   assert(UseSharedSpaces, "runtime only");
 243 
 244   struct stat st;
 245   const char* name;
 246 
 247   // In order to validate the runtime modules image file size against the archived
 248   // size information, we need to obtain the runtime modules image path. The recorded
 249   // dump time modules image path in the archive may be different from the runtime path
 250   // if the JDK image has beed moved after generating the archive.
 251   if (is_modules_image()) {
 252     name = ClassLoader::get_jrt_entry()->name();
 253   } else {
 254     name = this->name();
 255   }
 256 
 257   bool ok = true;
 258   log_info(class, path)("checking shared classpath entry: %s", name);
 259   if (os::stat(name, &st) != 0 && is_class_path) {
 260     // If the archived module path entry does not exist at runtime, it is not fatal
 261     // (no need to invalid the shared archive) because the shared runtime visibility check
 262     // filters out any archived module classes that do not have a matching runtime
 263     // module path location.
 264     FileMapInfo::fail_continue("Required classpath entry does not exist: %s", name);
 265     ok = false;
 266   } else if (is_dir()) {
 267     if (!os::dir_is_empty(name)) {
 268       FileMapInfo::fail_continue("directory is not empty: %s", name);
 269       ok = false;
 270     }
 271   } else if ((has_timestamp() && _timestamp != st.st_mtime) ||
 272              _filesize != st.st_size) {
 273     ok = false;
 274     if (PrintSharedArchiveAndExit) {
 275       FileMapInfo::fail_continue(_timestamp != st.st_mtime ?
 276                                  "Timestamp mismatch" :
 277                                  "File size mismatch");
 278     } else {
 279       FileMapInfo::fail_continue("A jar file is not the one used while building"
 280                                  " the shared archive file: %s", name);
 281     }
 282   }
 283   return ok;
 284 }
 285 
 286 void SharedClassPathEntry::metaspace_pointers_do(MetaspaceClosure* it) {
 287   it->push(&_name);
 288   it->push(&_manifest);
 289 }
 290 
 291 void FileMapInfo::allocate_shared_path_table() {
 292   assert(DumpSharedSpaces, "Sanity");
 293 
 294   Thread* THREAD = Thread::current();
 295   ClassLoaderData* loader_data = ClassLoaderData::the_null_class_loader_data();
 296   ClassPathEntry* jrt = ClassLoader::get_jrt_entry();
 297 
 298   assert(jrt != NULL,
 299          "No modular java runtime image present when allocating the CDS classpath entry table");
 300 
 301   size_t entry_size = sizeof(SharedClassPathEntry); // assert ( should be 8 byte aligned??)
 302   int num_boot_classpath_entries = ClassLoader::num_boot_classpath_entries();
 303   int num_app_classpath_entries = ClassLoader::num_app_classpath_entries();
 304   int num_module_path_entries = ClassLoader::num_module_path_entries();
 305   int num_entries = num_boot_classpath_entries + num_app_classpath_entries + num_module_path_entries;
 306   size_t bytes = entry_size * num_entries;
 307 
 308   _shared_path_table = MetadataFactory::new_array<u8>(loader_data, (int)(bytes + 7 / 8), THREAD);
 309   _shared_path_table_size = num_entries;
 310   _shared_path_entry_size = entry_size;
 311 
 312   // 1. boot class path
 313   int i = 0;
 314   ClassPathEntry* cpe = jrt;
 315   while (cpe != NULL) {
 316     bool is_jrt = (cpe == jrt);
 317     const char* type = (is_jrt ? "jrt" : (cpe->is_jar_file() ? "jar" : "dir"));
 318     log_info(class, path)("add main shared path (%s) %s", type, cpe->name());
 319     SharedClassPathEntry* ent = shared_path(i);
 320     ent->init(cpe->name(), is_jrt, THREAD);
 321     if (!is_jrt) {    // No need to do the modules image.
 322       EXCEPTION_MARK; // The following call should never throw, but would exit VM on error.
 323       update_shared_classpath(cpe, ent, THREAD);
 324     }
 325     cpe = ClassLoader::get_next_boot_classpath_entry(cpe);
 326     i++;
 327   }
 328   assert(i == num_boot_classpath_entries,
 329          "number of boot class path entry mismatch");
 330 
 331   // 2. app class path
 332   ClassPathEntry *acpe = ClassLoader::app_classpath_entries();
 333   while (acpe != NULL) {
 334     log_info(class, path)("add app shared path %s", acpe->name());
 335     SharedClassPathEntry* ent = shared_path(i);
 336     ent->init(acpe->name(), false, THREAD);
 337     EXCEPTION_MARK;
 338     update_shared_classpath(acpe, ent, THREAD);
 339     acpe = acpe->next();
 340     i++;
 341   }
 342 
 343   // 3. module path
 344   ClassPathEntry *mpe = ClassLoader::module_path_entries();
 345   while (mpe != NULL) {
 346     log_info(class, path)("add module path %s",mpe->name());
 347     SharedClassPathEntry* ent = shared_path(i);
 348     ent->init(mpe->name(), false, THREAD);
 349     EXCEPTION_MARK;
 350     update_shared_classpath(mpe, ent, THREAD);
 351     mpe = mpe->next();
 352     i++;
 353   }
 354   assert(i == num_entries, "number of shared path entry mismatch");
 355 }
 356 
 357 void FileMapInfo::check_nonempty_dir_in_shared_path_table() {
 358   assert(DumpSharedSpaces, "dump time only");
 359 
 360   bool has_nonempty_dir = false;
 361 
 362   int end = _shared_path_table_size;
 363   if (!ClassLoaderExt::has_platform_or_app_classes()) {
 364     // only check the boot path if no app class is loaded
 365     end = ClassLoaderExt::app_class_paths_start_index();
 366   }
 367 
 368   for (int i = 0; i < end; i++) {
 369     SharedClassPathEntry *e = shared_path(i);
 370     if (e->is_dir()) {
 371       const char* path = e->name();
 372       if (!os::dir_is_empty(path)) {
 373         tty->print_cr("Error: non-empty directory '%s'", path);
 374         has_nonempty_dir = true;
 375       }
 376     }
 377   }
 378 
 379   if (has_nonempty_dir) {
 380     ClassLoader::exit_with_path_failure("Cannot have non-empty directory in paths", NULL);
 381   }
 382 }
 383 
 384 class ManifestStream: public ResourceObj {
 385   private:
 386   u1*   _buffer_start; // Buffer bottom
 387   u1*   _buffer_end;   // Buffer top (one past last element)
 388   u1*   _current;      // Current buffer position
 389 
 390  public:
 391   // Constructor
 392   ManifestStream(u1* buffer, int length) : _buffer_start(buffer),
 393                                            _current(buffer) {
 394     _buffer_end = buffer + length;
 395   }
 396 
 397   static bool is_attr(u1* attr, const char* name) {
 398     return strncmp((const char*)attr, name, strlen(name)) == 0;
 399   }
 400 
 401   static char* copy_attr(u1* value, size_t len) {
 402     char* buf = NEW_RESOURCE_ARRAY(char, len + 1);
 403     strncpy(buf, (char*)value, len);
 404     buf[len] = 0;
 405     return buf;
 406   }
 407 
 408   // The return value indicates if the JAR is signed or not
 409   bool check_is_signed() {
 410     u1* attr = _current;
 411     bool isSigned = false;
 412     while (_current < _buffer_end) {
 413       if (*_current == '\n') {
 414         *_current = '\0';
 415         u1* value = (u1*)strchr((char*)attr, ':');
 416         if (value != NULL) {
 417           assert(*(value+1) == ' ', "Unrecognized format" );
 418           if (strstr((char*)attr, "-Digest") != NULL) {
 419             isSigned = true;
 420             break;
 421           }
 422         }
 423         *_current = '\n'; // restore
 424         attr = _current + 1;
 425       }
 426       _current ++;
 427     }
 428     return isSigned;
 429   }
 430 };
 431 
 432 void FileMapInfo::update_shared_classpath(ClassPathEntry *cpe, SharedClassPathEntry* ent, TRAPS) {
 433   ClassLoaderData* loader_data = ClassLoaderData::the_null_class_loader_data();
 434   ResourceMark rm(THREAD);
 435   jint manifest_size;
 436 
 437   if (cpe->is_jar_file()) {
 438     assert(ent->is_jar(), "the shared class path entry is not a JAR file");
 439     char* manifest = ClassLoaderExt::read_manifest(cpe, &manifest_size, CHECK);
 440     if (manifest != NULL) {
 441       ManifestStream* stream = new ManifestStream((u1*)manifest,
 442                                                   manifest_size);
 443       if (stream->check_is_signed()) {
 444         ent->set_is_signed();
 445       } else {
 446         // Copy the manifest into the shared archive
 447         manifest = ClassLoaderExt::read_raw_manifest(cpe, &manifest_size, CHECK);
 448         Array<u1>* buf = MetadataFactory::new_array<u1>(loader_data,
 449                                                         manifest_size,
 450                                                         THREAD);
 451         char* p = (char*)(buf->data());
 452         memcpy(p, manifest, manifest_size);
 453         ent->set_manifest(buf);
 454       }
 455     }
 456   }
 457 }
 458 
 459 
 460 bool FileMapInfo::validate_shared_path_table() {
 461   assert(UseSharedSpaces, "runtime only");
 462 
 463   _validating_shared_path_table = true;
 464   _shared_path_table = _header->_shared_path_table;
 465   _shared_path_entry_size = _header->_shared_path_entry_size;
 466   _shared_path_table_size = _header->_shared_path_table_size;
 467 
 468   int module_paths_start_index = _header->_app_module_paths_start_index;
 469 
 470   // If the shared archive contain app or platform classes, validate all entries
 471   // in the shared path table. Otherwise, only validate the boot path entries (with
 472   // entry index < _app_class_paths_start_index).
 473   int count = _header->has_platform_or_app_classes() ?
 474               _shared_path_table_size : _header->_app_class_paths_start_index;
 475 
 476   for (int i=0; i<count; i++) {
 477     if (i < module_paths_start_index) {
 478       if (shared_path(i)->validate()) {
 479         log_info(class, path)("ok");
 480       }
 481     } else if (i >= module_paths_start_index) {
 482       if (shared_path(i)->validate(false /* not a class path entry */)) {
 483         log_info(class, path)("ok");
 484       }
 485     } else if (!PrintSharedArchiveAndExit) {
 486       _validating_shared_path_table = false;
 487       _shared_path_table = NULL;
 488       _shared_path_table_size = 0;
 489       return false;
 490     }
 491   }
 492 
 493   _validating_shared_path_table = false;
 494   return true;
 495 }
 496 
 497 // Read the FileMapInfo information from the file.
 498 
 499 bool FileMapInfo::init_from_file(int fd) {
 500   size_t sz = _header->data_size();
 501   char* addr = _header->data();
 502   size_t n = os::read(fd, addr, (unsigned int)sz);
 503   if (n != sz) {
 504     fail_continue("Unable to read the file header.");
 505     return false;
 506   }
 507   if (_header->_version != current_version()) {
 508     fail_continue("The shared archive file has the wrong version.");
 509     return false;
 510   }
 511   _file_offset = (long)n;
 512 
 513   size_t info_size = _header->_paths_misc_info_size;
 514   _paths_misc_info = NEW_C_HEAP_ARRAY_RETURN_NULL(char, info_size, mtClass);
 515   if (_paths_misc_info == NULL) {
 516     fail_continue("Unable to read the file header.");
 517     return false;
 518   }
 519   n = os::read(fd, _paths_misc_info, (unsigned int)info_size);
 520   if (n != info_size) {
 521     fail_continue("Unable to read the shared path info header.");
 522     FREE_C_HEAP_ARRAY(char, _paths_misc_info);
 523     _paths_misc_info = NULL;
 524     return false;
 525   }
 526 
 527   size_t len = lseek(fd, 0, SEEK_END);
 528   struct FileMapInfo::FileMapHeader::space_info* si =
 529     &_header->_space[MetaspaceShared::last_valid_region];
 530   // The last space might be empty
 531   if (si->_file_offset > len || len - si->_file_offset < si->_used) {
 532     fail_continue("The shared archive file has been truncated.");
 533     return false;
 534   }
 535 
 536   _file_offset += (long)n;
 537   return true;
 538 }
 539 
 540 
 541 // Read the FileMapInfo information from the file.
 542 bool FileMapInfo::open_for_read() {
 543   _full_path = Arguments::GetSharedArchivePath();
 544   int fd = open(_full_path, O_RDONLY | O_BINARY, 0);
 545   if (fd < 0) {
 546     if (errno == ENOENT) {
 547       // Not locating the shared archive is ok.
 548       fail_continue("Specified shared archive not found.");
 549     } else {
 550       fail_continue("Failed to open shared archive file (%s).",
 551                     os::strerror(errno));
 552     }
 553     return false;
 554   }
 555 
 556   _fd = fd;
 557   _file_open = true;
 558   return true;
 559 }
 560 
 561 
 562 // Write the FileMapInfo information to the file.
 563 
 564 void FileMapInfo::open_for_write() {
 565   _full_path = Arguments::GetSharedArchivePath();
 566   LogMessage(cds) msg;
 567   if (msg.is_info()) {
 568     msg.info("Dumping shared data to file: ");
 569     msg.info("   %s", _full_path);
 570   }
 571 
 572 #ifdef _WINDOWS  // On Windows, need WRITE permission to remove the file.
 573   chmod(_full_path, _S_IREAD | _S_IWRITE);
 574 #endif
 575 
 576   // Use remove() to delete the existing file because, on Unix, this will
 577   // allow processes that have it open continued access to the file.
 578   remove(_full_path);
 579   int fd = open(_full_path, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0444);
 580   if (fd < 0) {
 581     fail_stop("Unable to create shared archive file %s: (%s).", _full_path,
 582               os::strerror(errno));
 583   }
 584   _fd = fd;
 585   _file_offset = 0;
 586   _file_open = true;
 587 }
 588 
 589 
 590 // Write the header to the file, seek to the next allocation boundary.
 591 
 592 void FileMapInfo::write_header() {
 593   int info_size = ClassLoader::get_shared_paths_misc_info_size();
 594 
 595   _header->_paths_misc_info_size = info_size;
 596 
 597   align_file_position();
 598   size_t sz = _header->data_size();
 599   char* addr = _header->data();
 600   write_bytes(addr, (int)sz); // skip the C++ vtable
 601   write_bytes(ClassLoader::get_shared_paths_misc_info(), info_size);
 602   align_file_position();
 603 }
 604 
 605 
 606 // Dump region to file.
 607 
 608 void FileMapInfo::write_region(int region, char* base, size_t size,
 609                                bool read_only, bool allow_exec) {
 610   struct FileMapInfo::FileMapHeader::space_info* si = &_header->_space[region];
 611 
 612   if (_file_open) {
 613     guarantee(si->_file_offset == _file_offset, "file offset mismatch.");
 614     log_info(cds)("Shared file region %d: " SIZE_FORMAT_HEX_W(08)
 615                   " bytes, addr " INTPTR_FORMAT " file offset " SIZE_FORMAT_HEX_W(08),
 616                   region, size, p2i(base), _file_offset);
 617   } else {
 618     si->_file_offset = _file_offset;
 619   }
 620   if (MetaspaceShared::is_heap_region(region)) {
 621     assert((base - (char*)Universe::narrow_oop_base()) % HeapWordSize == 0, "Sanity");
 622     if (base != NULL) {
 623       si->_addr._offset = (intx)CompressedOops::encode_not_null((oop)base);
 624     } else {
 625       si->_addr._offset = 0;
 626     }
 627   } else {
 628     si->_addr._base = base;
 629   }
 630   si->_used = size;
 631   si->_read_only = read_only;
 632   si->_allow_exec = allow_exec;
 633   si->_crc = ClassLoader::crc32(0, base, (jint)size);
 634   if (base != NULL) {
 635     write_bytes_aligned(base, (int)size);
 636   }
 637 }
 638 
 639 // Write out the given archive heap memory regions.  GC code combines multiple
 640 // consecutive archive GC regions into one MemRegion whenever possible and
 641 // produces the 'heap_mem' array.
 642 //
 643 // If the archive heap memory size is smaller than a single dump time GC region
 644 // size, there is only one MemRegion in the array.
 645 //
 646 // If the archive heap memory size is bigger than one dump time GC region size,
 647 // the 'heap_mem' array may contain more than one consolidated MemRegions. When
 648 // the first/bottom archive GC region is a partial GC region (with the empty
 649 // portion at the higher address within the region), one MemRegion is used for
 650 // the bottom partial archive GC region. The rest of the consecutive archive
 651 // GC regions are combined into another MemRegion.
 652 //
 653 // Here's the mapping from (archive heap GC regions) -> (GrowableArray<MemRegion> *regions).
 654 //   + We have 1 or more archive heap regions: ah0, ah1, ah2 ..... ahn
 655 //   + We have 1 or 2 consolidated heap memory regions: r0 and r1
 656 //
 657 // If there's a single archive GC region (ah0), then r0 == ah0, and r1 is empty.
 658 // Otherwise:
 659 //
 660 // "X" represented space that's occupied by heap objects.
 661 // "_" represented unused spaced in the heap region.
 662 //
 663 //
 664 //    |ah0       | ah1 | ah2| ...... | ahn |
 665 //    |XXXXXX|__ |XXXXX|XXXX|XXXXXXXX|XXXX|
 666 //    |<-r0->|   |<- r1 ----------------->|
 667 //            ^^^
 668 //             |
 669 //             +-- gap
 670 size_t FileMapInfo::write_archive_heap_regions(GrowableArray<MemRegion> *heap_mem,
 671                                                int first_region_id, int max_num_regions) {
 672   assert(max_num_regions <= 2, "Only support maximum 2 memory regions");
 673 
 674   int arr_len = heap_mem == NULL ? 0 : heap_mem->length();
 675   if(arr_len > max_num_regions) {
 676     fail_stop("Unable to write archive heap memory regions: "
 677               "number of memory regions exceeds maximum due to fragmentation");
 678   }
 679 
 680   size_t total_size = 0;
 681   for (int i = first_region_id, arr_idx = 0;
 682            i < first_region_id + max_num_regions;
 683            i++, arr_idx++) {
 684     char* start = NULL;
 685     size_t size = 0;
 686     if (arr_idx < arr_len) {
 687       start = (char*)heap_mem->at(arr_idx).start();
 688       size = heap_mem->at(arr_idx).byte_size();
 689       total_size += size;
 690     }
 691 
 692     log_info(cds)("Archive heap region %d " INTPTR_FORMAT " - " INTPTR_FORMAT " = " SIZE_FORMAT_W(8) " bytes",
 693                   i, p2i(start), p2i(start + size), size);
 694     write_region(i, start, size, false, false);
 695   }
 696   return total_size;
 697 }
 698 
 699 // Dump bytes to file -- at the current file position.
 700 
 701 void FileMapInfo::write_bytes(const void* buffer, int nbytes) {
 702   if (_file_open) {
 703     int n = ::write(_fd, buffer, nbytes);
 704     if (n != nbytes) {
 705       // It is dangerous to leave the corrupted shared archive file around,
 706       // close and remove the file. See bug 6372906.
 707       close();
 708       remove(_full_path);
 709       fail_stop("Unable to write to shared archive file.");
 710     }
 711   }
 712   _file_offset += nbytes;
 713 }
 714 
 715 
 716 // Align file position to an allocation unit boundary.
 717 
 718 void FileMapInfo::align_file_position() {
 719   size_t new_file_offset = align_up(_file_offset,
 720                                          os::vm_allocation_granularity());
 721   if (new_file_offset != _file_offset) {
 722     _file_offset = new_file_offset;
 723     if (_file_open) {
 724       // Seek one byte back from the target and write a byte to insure
 725       // that the written file is the correct length.
 726       _file_offset -= 1;
 727       if (lseek(_fd, (long)_file_offset, SEEK_SET) < 0) {
 728         fail_stop("Unable to seek.");
 729       }
 730       char zero = 0;
 731       write_bytes(&zero, 1);
 732     }
 733   }
 734 }
 735 
 736 
 737 // Dump bytes to file -- at the current file position.
 738 
 739 void FileMapInfo::write_bytes_aligned(const void* buffer, int nbytes) {
 740   align_file_position();
 741   write_bytes(buffer, nbytes);
 742   align_file_position();
 743 }
 744 
 745 
 746 // Close the shared archive file.  This does NOT unmap mapped regions.
 747 
 748 void FileMapInfo::close() {
 749   if (_file_open) {
 750     if (::close(_fd) < 0) {
 751       fail_stop("Unable to close the shared archive file.");
 752     }
 753     _file_open = false;
 754     _fd = -1;
 755   }
 756 }
 757 
 758 
 759 // JVM/TI RedefineClasses() support:
 760 // Remap the shared readonly space to shared readwrite, private.
 761 bool FileMapInfo::remap_shared_readonly_as_readwrite() {
 762   int idx = MetaspaceShared::ro;
 763   struct FileMapInfo::FileMapHeader::space_info* si = &_header->_space[idx];
 764   if (!si->_read_only) {
 765     // the space is already readwrite so we are done
 766     return true;
 767   }
 768   size_t used = si->_used;
 769   size_t size = align_up(used, os::vm_allocation_granularity());
 770   if (!open_for_read()) {
 771     return false;
 772   }
 773   char *addr = _header->region_addr(idx);
 774   char *base = os::remap_memory(_fd, _full_path, si->_file_offset,
 775                                 addr, size, false /* !read_only */,
 776                                 si->_allow_exec);
 777   close();
 778   if (base == NULL) {
 779     fail_continue("Unable to remap shared readonly space (errno=%d).", errno);
 780     return false;
 781   }
 782   if (base != addr) {
 783     fail_continue("Unable to remap shared readonly space at required address.");
 784     return false;
 785   }
 786   si->_read_only = false;
 787   return true;
 788 }
 789 
 790 // Map the whole region at once, assumed to be allocated contiguously.
 791 ReservedSpace FileMapInfo::reserve_shared_memory() {
 792   char* requested_addr = _header->region_addr(0);
 793   size_t size = FileMapInfo::core_spaces_size();
 794 
 795   // Reserve the space first, then map otherwise map will go right over some
 796   // other reserved memory (like the code cache).
 797   ReservedSpace rs(size, os::vm_allocation_granularity(), false, requested_addr);
 798   if (!rs.is_reserved()) {
 799     fail_continue("Unable to reserve shared space at required address "
 800                   INTPTR_FORMAT, p2i(requested_addr));
 801     return rs;
 802   }
 803   // the reserved virtual memory is for mapping class data sharing archive
 804   MemTracker::record_virtual_memory_type((address)rs.base(), mtClassShared);
 805 
 806   return rs;
 807 }
 808 
 809 // Memory map a region in the address space.
 810 static const char* shared_region_name[] = { "MiscData", "ReadWrite", "ReadOnly", "MiscCode", "OptionalData",
 811                                             "String1", "String2", "OpenArchive1", "OpenArchive2" };
 812 
 813 char* FileMapInfo::map_region(int i, char** top_ret) {
 814   assert(!MetaspaceShared::is_heap_region(i), "sanity");
 815   struct FileMapInfo::FileMapHeader::space_info* si = &_header->_space[i];
 816   size_t used = si->_used;
 817   size_t alignment = os::vm_allocation_granularity();
 818   size_t size = align_up(used, alignment);
 819   char *requested_addr = _header->region_addr(i);
 820 
 821   // If a tool agent is in use (debugging enabled), we must map the address space RW
 822   if (JvmtiExport::can_modify_any_class() || JvmtiExport::can_walk_any_space()) {
 823     si->_read_only = false;
 824   }
 825 
 826   // map the contents of the CDS archive in this memory
 827   char *base = os::map_memory(_fd, _full_path, si->_file_offset,
 828                               requested_addr, size, si->_read_only,
 829                               si->_allow_exec);
 830   if (base == NULL || base != requested_addr) {
 831     fail_continue("Unable to map %s shared space at required address.", shared_region_name[i]);
 832     return NULL;
 833   }
 834 #ifdef _WINDOWS
 835   // This call is Windows-only because the memory_type gets recorded for the other platforms
 836   // in method FileMapInfo::reserve_shared_memory(), which is not called on Windows.
 837   MemTracker::record_virtual_memory_type((address)base, mtClassShared);
 838 #endif
 839 
 840 
 841   if (!verify_region_checksum(i)) {
 842     return NULL;
 843   }
 844 
 845   *top_ret = base + size;
 846   return base;
 847 }
 848 
 849 static MemRegion *string_ranges = NULL;
 850 static MemRegion *open_archive_heap_ranges = NULL;
 851 static int num_string_ranges = 0;
 852 static int num_open_archive_heap_ranges = 0;
 853 
 854 #if INCLUDE_CDS_JAVA_HEAP
 855 //
 856 // Map the shared string objects and open archive heap objects to the runtime
 857 // java heap.
 858 //
 859 // The shared strings are mapped near the runtime java heap top. The
 860 // mapped strings contain no out-going references to any other java heap
 861 // regions. GC does not write into the mapped shared strings.
 862 //
 863 // The open archive heap objects are mapped below the shared strings in
 864 // the runtime java heap. The mapped open archive heap data only contain
 865 // references to the shared strings and open archive objects initially.
 866 // During runtime execution, out-going references to any other java heap
 867 // regions may be added. GC may mark and update references in the mapped
 868 // open archive objects.
 869 void FileMapInfo::map_heap_regions() {
 870   if (MetaspaceShared::is_heap_object_archiving_allowed()) {
 871       log_info(cds)("Archived narrow_oop_mode = %d, narrow_oop_base = " PTR_FORMAT ", narrow_oop_shift = %d",
 872                     narrow_oop_mode(), p2i(narrow_oop_base()), narrow_oop_shift());
 873       log_info(cds)("Archived narrow_klass_base = " PTR_FORMAT ", narrow_klass_shift = %d",
 874                     p2i(narrow_klass_base()), narrow_klass_shift());
 875 
 876     // Check that all the narrow oop and klass encodings match the archive
 877     if (narrow_oop_mode() != Universe::narrow_oop_mode() ||
 878         narrow_oop_base() != Universe::narrow_oop_base() ||
 879         narrow_oop_shift() != Universe::narrow_oop_shift() ||
 880         narrow_klass_base() != Universe::narrow_klass_base() ||
 881         narrow_klass_shift() != Universe::narrow_klass_shift()) {
 882       if (log_is_enabled(Info, cds) && _header->_space[MetaspaceShared::first_string]._used > 0) {
 883         log_info(cds)("Cached heap data from the CDS archive is being ignored. "
 884                       "The current CompressedOops/CompressedClassPointers encoding differs from "
 885                       "that archived due to heap size change. The archive was dumped using max heap "
 886                       "size " UINTX_FORMAT "M.", max_heap_size()/M);
 887         log_info(cds)("Current narrow_oop_mode = %d, narrow_oop_base = " PTR_FORMAT ", narrow_oop_shift = %d",
 888                       Universe::narrow_oop_mode(), p2i(Universe::narrow_oop_base()),
 889                       Universe::narrow_oop_shift());
 890         log_info(cds)("Current narrow_klass_base = " PTR_FORMAT ", narrow_klass_shift = %d",
 891                       p2i(Universe::narrow_klass_base()), Universe::narrow_klass_shift());
 892       }
 893     } else {
 894       // First, map string regions as closed archive heap regions.
 895       // GC does not write into the regions.
 896       if (map_heap_data(&string_ranges,
 897                          MetaspaceShared::first_string,
 898                          MetaspaceShared::max_strings,
 899                          &num_string_ranges)) {
 900         StringTable::set_shared_string_mapped();
 901 
 902         // Now, map open_archive heap regions, GC can write into the regions.
 903         if (map_heap_data(&open_archive_heap_ranges,
 904                           MetaspaceShared::first_open_archive_heap_region,
 905                           MetaspaceShared::max_open_archive_heap_region,
 906                           &num_open_archive_heap_ranges,
 907                           true /* open */)) {
 908           MetaspaceShared::set_open_archive_heap_region_mapped();
 909         }
 910       }
 911     }
 912   } else {
 913     if (log_is_enabled(Info, cds) && _header->_space[MetaspaceShared::first_string]._used > 0) {
 914       log_info(cds)("Cached heap data from the CDS archive is being ignored. UseG1GC, "
 915                     "UseCompressedOops and UseCompressedClassPointers are required.");
 916     }
 917   }
 918 
 919   if (!StringTable::shared_string_mapped()) {
 920     assert(string_ranges == NULL && num_string_ranges == 0, "sanity");
 921   }
 922 
 923   if (!MetaspaceShared::open_archive_heap_region_mapped()) {
 924     assert(open_archive_heap_ranges == NULL && num_open_archive_heap_ranges == 0, "sanity");
 925   }
 926 }
 927 
 928 bool FileMapInfo::map_heap_data(MemRegion **heap_mem, int first,
 929                                 int max, int* num, bool is_open_archive) {
 930   MemRegion * regions = new MemRegion[max];
 931   struct FileMapInfo::FileMapHeader::space_info* si;
 932   int region_num = 0;
 933 
 934   for (int i = first;
 935            i < first + max; i++) {
 936     si = &_header->_space[i];
 937     size_t used = si->_used;
 938     if (used > 0) {
 939       size_t size = used;
 940       char* requested_addr = (char*)((void*)CompressedOops::decode_not_null(
 941                                             (narrowOop)si->_addr._offset));
 942       regions[region_num] = MemRegion((HeapWord*)requested_addr, size / HeapWordSize);
 943       region_num ++;
 944     }
 945   }
 946 
 947   if (region_num == 0) {
 948     return false; // no archived java heap data
 949   }
 950 
 951   // Check that ranges are within the java heap
 952   if (!G1CollectedHeap::heap()->check_archive_addresses(regions, region_num)) {
 953     log_info(cds)("UseSharedSpaces: Unable to allocate region, "
 954                   "range is not within java heap.");
 955     return false;
 956   }
 957 
 958   // allocate from java heap
 959   if (!G1CollectedHeap::heap()->alloc_archive_regions(
 960              regions, region_num, is_open_archive)) {
 961     log_info(cds)("UseSharedSpaces: Unable to allocate region, "
 962                   "java heap range is already in use.");
 963     return false;
 964   }
 965 
 966   // Map the archived heap data. No need to call MemTracker::record_virtual_memory_type()
 967   // for mapped regions as they are part of the reserved java heap, which is
 968   // already recorded.
 969   for (int i = 0; i < region_num; i++) {
 970     si = &_header->_space[first + i];
 971     char* addr = (char*)regions[i].start();
 972     char* base = os::map_memory(_fd, _full_path, si->_file_offset,
 973                                 addr, regions[i].byte_size(), si->_read_only,
 974                                 si->_allow_exec);
 975     if (base == NULL || base != addr) {
 976       // dealloc the regions from java heap
 977       dealloc_archive_heap_regions(regions, region_num);
 978       log_info(cds)("UseSharedSpaces: Unable to map at required address in java heap.");
 979       return false;
 980     }
 981   }
 982 
 983   if (!verify_mapped_heap_regions(first, region_num)) {
 984     // dealloc the regions from java heap
 985     dealloc_archive_heap_regions(regions, region_num);
 986     log_info(cds)("UseSharedSpaces: mapped heap regions are corrupt");
 987     return false;
 988   }
 989 
 990   // the shared heap data is mapped successfully
 991   *heap_mem = regions;
 992   *num = region_num;
 993   return true;
 994 }
 995 
 996 bool FileMapInfo::verify_mapped_heap_regions(int first, int num) {
 997   for (int i = first;
 998            i <= first + num; i++) {
 999     if (!verify_region_checksum(i)) {
1000       return false;
1001     }
1002   }
1003   return true;
1004 }
1005 
1006 void FileMapInfo::fixup_mapped_heap_regions() {
1007   // If any string regions were found, call the fill routine to make them parseable.
1008   // Note that string_ranges may be non-NULL even if no ranges were found.
1009   if (num_string_ranges != 0) {
1010     assert(string_ranges != NULL, "Null string_ranges array with non-zero count");
1011     G1CollectedHeap::heap()->fill_archive_regions(string_ranges, num_string_ranges);
1012   }
1013 
1014   // do the same for mapped open archive heap regions
1015   if (num_open_archive_heap_ranges != 0) {
1016     assert(open_archive_heap_ranges != NULL, "NULL open_archive_heap_ranges array with non-zero count");
1017     G1CollectedHeap::heap()->fill_archive_regions(open_archive_heap_ranges,
1018                                                   num_open_archive_heap_ranges);
1019   }
1020 }
1021 
1022 // dealloc the archive regions from java heap
1023 void FileMapInfo::dealloc_archive_heap_regions(MemRegion* regions, int num) {
1024   if (num > 0) {
1025     assert(regions != NULL, "Null archive ranges array with non-zero count");
1026     G1CollectedHeap::heap()->dealloc_archive_regions(regions, num);
1027   }
1028 }
1029 #endif // INCLUDE_CDS_JAVA_HEAP
1030 
1031 bool FileMapInfo::verify_region_checksum(int i) {
1032   if (!VerifySharedSpaces) {
1033     return true;
1034   }
1035 
1036   size_t sz = _header->_space[i]._used;
1037 
1038   if (sz == 0) {
1039     return true; // no data
1040   }
1041   if ((MetaspaceShared::is_string_region(i) &&
1042        !StringTable::shared_string_mapped()) ||
1043       (MetaspaceShared::is_open_archive_heap_region(i) &&
1044        !MetaspaceShared::open_archive_heap_region_mapped())) {
1045     return true; // archived heap data is not mapped
1046   }
1047   const char* buf = _header->region_addr(i);
1048   int crc = ClassLoader::crc32(0, buf, (jint)sz);
1049   if (crc != _header->_space[i]._crc) {
1050     fail_continue("Checksum verification failed.");
1051     return false;
1052   }
1053   return true;
1054 }
1055 
1056 // Unmap a memory region in the address space.
1057 
1058 void FileMapInfo::unmap_region(int i) {
1059   assert(!MetaspaceShared::is_heap_region(i), "sanity");
1060   struct FileMapInfo::FileMapHeader::space_info* si = &_header->_space[i];
1061   size_t used = si->_used;
1062   size_t size = align_up(used, os::vm_allocation_granularity());
1063 
1064   if (used == 0) {
1065     return;
1066   }
1067 
1068   char* addr = _header->region_addr(i);
1069   if (!os::unmap_memory(addr, size)) {
1070     fail_stop("Unable to unmap shared space.");
1071   }
1072 }
1073 
1074 void FileMapInfo::assert_mark(bool check) {
1075   if (!check) {
1076     fail_stop("Mark mismatch while restoring from shared file.");
1077   }
1078 }
1079 
1080 void FileMapInfo::metaspace_pointers_do(MetaspaceClosure* it) {
1081   it->push(&_shared_path_table);
1082   for (int i=0; i<_shared_path_table_size; i++) {
1083     shared_path(i)->metaspace_pointers_do(it);
1084   }
1085 }
1086 
1087 
1088 FileMapInfo* FileMapInfo::_current_info = NULL;
1089 Array<u8>* FileMapInfo::_shared_path_table = NULL;
1090 int FileMapInfo::_shared_path_table_size = 0;
1091 size_t FileMapInfo::_shared_path_entry_size = 0x1234baad;
1092 bool FileMapInfo::_validating_shared_path_table = false;
1093 
1094 // Open the shared archive file, read and validate the header
1095 // information (version, boot classpath, etc.).  If initialization
1096 // fails, shared spaces are disabled and the file is closed. [See
1097 // fail_continue.]
1098 //
1099 // Validation of the archive is done in two steps:
1100 //
1101 // [1] validate_header() - done here. This checks the header, including _paths_misc_info.
1102 // [2] validate_shared_path_table - this is done later, because the table is in the RW
1103 //     region of the archive, which is not mapped yet.
1104 bool FileMapInfo::initialize() {
1105   assert(UseSharedSpaces, "UseSharedSpaces expected.");
1106 
1107   if (!open_for_read()) {
1108     return false;
1109   }
1110 
1111   init_from_file(_fd);
1112   if (!validate_header()) {
1113     return false;
1114   }
1115   return true;
1116 }
1117 
1118 char* FileMapInfo::FileMapHeader::region_addr(int idx) {
1119   if (MetaspaceShared::is_heap_region(idx)) {
1120     return _space[idx]._used > 0 ?
1121              (char*)((void*)CompressedOops::decode_not_null((narrowOop)_space[idx]._addr._offset)) : NULL;
1122   } else {
1123     return _space[idx]._addr._base;
1124   }
1125 }
1126 
1127 int FileMapInfo::FileMapHeader::compute_crc() {
1128   char* header = data();
1129   // start computing from the field after _crc
1130   char* buf = (char*)&_crc + sizeof(int);
1131   size_t sz = data_size() - (buf - header);
1132   int crc = ClassLoader::crc32(0, buf, (jint)sz);
1133   return crc;
1134 }
1135 
1136 // This function should only be called during run time with UseSharedSpaces enabled.
1137 bool FileMapInfo::FileMapHeader::validate() {
1138   if (VerifySharedSpaces && compute_crc() != _crc) {
1139     fail_continue("Header checksum verification failed.");
1140     return false;
1141   }
1142 
1143   if (!Arguments::has_jimage()) {
1144     FileMapInfo::fail_continue("The shared archive file cannot be used with an exploded module build.");
1145     return false;
1146   }
1147 
1148   if (_version != current_version()) {
1149     FileMapInfo::fail_continue("The shared archive file is the wrong version.");
1150     return false;
1151   }
1152   if (_magic != (int)0xf00baba2) {
1153     FileMapInfo::fail_continue("The shared archive file has a bad magic number.");
1154     return false;
1155   }
1156   char header_version[JVM_IDENT_MAX];
1157   get_header_version(header_version);
1158   if (strncmp(_jvm_ident, header_version, JVM_IDENT_MAX-1) != 0) {
1159     log_info(class, path)("expected: %s", header_version);
1160     log_info(class, path)("actual:   %s", _jvm_ident);
1161     FileMapInfo::fail_continue("The shared archive file was created by a different"
1162                   " version or build of HotSpot");
1163     return false;
1164   }
1165   if (_obj_alignment != ObjectAlignmentInBytes) {
1166     FileMapInfo::fail_continue("The shared archive file's ObjectAlignmentInBytes of %d"
1167                   " does not equal the current ObjectAlignmentInBytes of " INTX_FORMAT ".",
1168                   _obj_alignment, ObjectAlignmentInBytes);
1169     return false;
1170   }
1171   if (_compact_strings != CompactStrings) {
1172     FileMapInfo::fail_continue("The shared archive file's CompactStrings setting (%s)"
1173                   " does not equal the current CompactStrings setting (%s).",
1174                   _compact_strings ? "enabled" : "disabled",
1175                   CompactStrings   ? "enabled" : "disabled");
1176     return false;
1177   }
1178 
1179   // This must be done after header validation because it might change the
1180   // header data
1181   const char* prop = Arguments::get_property("java.system.class.loader");
1182   if (prop != NULL) {
1183     warning("Archived non-system classes are disabled because the "
1184             "java.system.class.loader property is specified (value = \"%s\"). "
1185             "To use archived non-system classes, this property must be not be set", prop);
1186     _has_platform_or_app_classes = false;
1187   }
1188 
1189   // For backwards compatibility, we don't check the verification setting
1190   // if the archive only contains system classes.
1191   if (_has_platform_or_app_classes &&
1192       ((!_verify_local && BytecodeVerificationLocal) ||
1193        (!_verify_remote && BytecodeVerificationRemote))) {
1194     FileMapInfo::fail_continue("The shared archive file was created with less restrictive "
1195                   "verification setting than the current setting.");
1196     return false;
1197   }
1198 
1199   return true;
1200 }
1201 
1202 bool FileMapInfo::validate_header() {
1203   bool status = _header->validate();
1204 
1205   if (status) {
1206     if (!ClassLoader::check_shared_paths_misc_info(_paths_misc_info, _header->_paths_misc_info_size)) {
1207       if (!PrintSharedArchiveAndExit) {
1208         fail_continue("shared class paths mismatch (hint: enable -Xlog:class+path=info to diagnose the failure)");
1209         status = false;
1210       }
1211     }
1212   }
1213 
1214   if (_paths_misc_info != NULL) {
1215     FREE_C_HEAP_ARRAY(char, _paths_misc_info);
1216     _paths_misc_info = NULL;
1217   }
1218   return status;
1219 }
1220 
1221 // Check if a given address is within one of the shared regions
1222 bool FileMapInfo::is_in_shared_region(const void* p, int idx) {
1223   assert(idx == MetaspaceShared::ro ||
1224          idx == MetaspaceShared::rw ||
1225          idx == MetaspaceShared::mc ||
1226          idx == MetaspaceShared::md, "invalid region index");
1227   char* base = _header->region_addr(idx);
1228   if (p >= base && p < base + _header->_space[idx]._used) {
1229     return true;
1230   }
1231   return false;
1232 }
1233 
1234 void FileMapInfo::print_shared_spaces() {
1235   tty->print_cr("Shared Spaces:");
1236   for (int i = 0; i < MetaspaceShared::n_regions; i++) {
1237     struct FileMapInfo::FileMapHeader::space_info* si = &_header->_space[i];
1238     char *base = _header->region_addr(i);
1239     tty->print("  %s " INTPTR_FORMAT "-" INTPTR_FORMAT,
1240                         shared_region_name[i],
1241                         p2i(base), p2i(base + si->_used));
1242   }
1243 }
1244 
1245 // Unmap mapped regions of shared space.
1246 void FileMapInfo::stop_sharing_and_unmap(const char* msg) {
1247   FileMapInfo *map_info = FileMapInfo::current_info();
1248   if (map_info) {
1249     map_info->fail_continue("%s", msg);
1250     for (int i = 0; i < MetaspaceShared::num_non_heap_spaces; i++) {
1251       char *addr = map_info->_header->region_addr(i);
1252       if (addr != NULL && !MetaspaceShared::is_heap_region(i)) {
1253         map_info->unmap_region(i);
1254         map_info->_header->_space[i]._addr._base = NULL;
1255       }
1256     }
1257     // Dealloc the archive heap regions only without unmapping. The regions are part
1258     // of the java heap. Unmapping of the heap regions are managed by GC.
1259     map_info->dealloc_archive_heap_regions(open_archive_heap_ranges,
1260                                            num_open_archive_heap_ranges);
1261     map_info->dealloc_archive_heap_regions(string_ranges, num_string_ranges);
1262   } else if (DumpSharedSpaces) {
1263     fail_stop("%s", msg);
1264   }
1265 }