/*

 * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#include "precompiled.hpp"

#include "jvm.h"

#include "classfile/classFileStream.hpp"

#include "classfile/classLoader.inline.hpp"

#include "classfile/classLoaderData.inline.hpp"

#include "classfile/classLoaderExt.hpp"

#include "classfile/symbolTable.hpp"

#include "classfile/systemDictionaryShared.hpp"

#include "classfile/altHashing.hpp"

#include "logging/log.hpp"

#include "logging/logStream.hpp"

#include "logging/logMessage.hpp"

#include "memory/archiveUtils.inline.hpp"

#include "memory/dynamicArchive.hpp"

#include "memory/filemap.hpp"

#include "memory/heapShared.inline.hpp"

#include "memory/iterator.inline.hpp"

#include "memory/metadataFactory.hpp"

#include "memory/metaspaceClosure.hpp"

#include "memory/metaspaceShared.hpp"

#include "memory/oopFactory.hpp"

#include "memory/universe.hpp"

#include "oops/compressedOops.hpp"

#include "oops/compressedOops.inline.hpp"

#include "oops/objArrayOop.hpp"

#include "oops/oop.inline.hpp"

#include "prims/jvmtiExport.hpp"

#include "runtime/arguments.hpp"

#include "runtime/java.hpp"

#include "runtime/mutexLocker.hpp"

#include "runtime/os.inline.hpp"

#include "runtime/vm_version.hpp"

#include "services/memTracker.hpp"

#include "utilities/align.hpp"

#include "utilities/bitMap.inline.hpp"

#include "utilities/classpathStream.hpp"

#include "utilities/defaultStream.hpp"

#if INCLUDE_G1GC

#include "gc/g1/g1CollectedHeap.hpp"

#include "gc/g1/heapRegion.hpp"

#endif

# include <sys/stat.h>

# include <errno.h>

#ifndef O_BINARY       // if defined (Win32) use binary files.

#define O_BINARY 0     // otherwise do nothing.

#endif

// Complain and stop. All error conditions occurring during the writing of

// an archive file should stop the process.  Unrecoverable errors during

// the reading of the archive file should stop the process.

static void fail_exit(const char *msg, va_list ap) {

  // This occurs very early during initialization: tty is not initialized.

  jio_fprintf(defaultStream::error_stream(),

              "An error has occurred while processing the"

              " shared archive file.\n");

  jio_vfprintf(defaultStream::error_stream(), msg, ap);

  jio_fprintf(defaultStream::error_stream(), "\n");

  // Do not change the text of the below message because some tests check for it.

  vm_exit_during_initialization("Unable to use shared archive.", NULL);

}

void FileMapInfo::fail_stop(const char *msg, ...) {

        va_list ap;

  va_start(ap, msg);

  fail_exit(msg, ap);   // Never returns.

  va_end(ap);           // for completeness.

}

// Complain and continue.  Recoverable errors during the reading of the

// archive file may continue (with sharing disabled).

//

// If we continue, then disable shared spaces and close the file.

void FileMapInfo::fail_continue(const char *msg, ...) {

  va_list ap;

  va_start(ap, msg);

  if (PrintSharedArchiveAndExit && _validating_shared_path_table) {

    // If we are doing PrintSharedArchiveAndExit and some of the classpath entries

    // do not validate, we can still continue "limping" to validate the remaining

    // entries. No need to quit.

    tty->print("[");

    tty->vprint(msg, ap);

    tty->print_cr("]");

  } else {

    if (RequireSharedSpaces) {

      fail_exit(msg, ap);

    } else {

      if (log_is_enabled(Info, cds)) {

        ResourceMark rm;

        LogStream ls(Log(cds)::info());

        ls.print("UseSharedSpaces: ");

        ls.vprint_cr(msg, ap);

      }

    }

  }

  va_end(ap);

}

// Fill in the fileMapInfo structure with data about this VM instance.

// This method copies the vm version info into header_version.  If the version is too

// long then a truncated version, which has a hash code appended to it, is copied.

//

// Using a template enables this method to verify that header_version is an array of

// length JVM_IDENT_MAX.  This ensures that the code that writes to the CDS file and

// the code that reads the CDS file will both use the same size buffer.  Hence, will

// use identical truncation.  This is necessary for matching of truncated versions.

template <int N> static void get_header_version(char (&header_version) [N]) {

  assert(N == JVM_IDENT_MAX, "Bad header_version size");

  const char *vm_version = VM_Version::internal_vm_info_string();

  const int version_len = (int)strlen(vm_version);

  memset(header_version, 0, JVM_IDENT_MAX);

  if (version_len < (JVM_IDENT_MAX-1)) {

    strcpy(header_version, vm_version);

  } else {

    // Get the hash value.  Use a static seed because the hash needs to return the same

    // value over multiple jvm invocations.

    unsigned int hash = AltHashing::murmur3_32(8191, (const jbyte*)vm_version, version_len);

    // Truncate the ident, saving room for the 8 hex character hash value.

    strncpy(header_version, vm_version, JVM_IDENT_MAX-9);

    // Append the hash code as eight hex digits.

    sprintf(&header_version[JVM_IDENT_MAX-9], "%08x", hash);

    header_version[JVM_IDENT_MAX-1] = 0;  // Null terminate.

  }

  assert(header_version[JVM_IDENT_MAX-1] == 0, "must be");

}

FileMapInfo::FileMapInfo(bool is_static) {

  memset((void*)this, 0, sizeof(FileMapInfo));

  _is_static = is_static;

  size_t header_size;

  if (is_static) {

    assert(_current_info == NULL, "must be singleton"); // not thread safe

    _current_info = this;

    header_size = sizeof(FileMapHeader);

  } else {

    assert(_dynamic_archive_info == NULL, "must be singleton"); // not thread safe

    _dynamic_archive_info = this;

    header_size = sizeof(DynamicArchiveHeader);

  }

  _header = (FileMapHeader*)os::malloc(header_size, mtInternal);

  memset((void*)_header, 0, header_size);

  _header->set_header_size(header_size);

  _header->set_version(INVALID_CDS_ARCHIVE_VERSION);

  _header->set_has_platform_or_app_classes(true);

  _file_offset = 0;

  _file_open = false;

}

FileMapInfo::~FileMapInfo() {

  if (_is_static) {

    assert(_current_info == this, "must be singleton"); // not thread safe

    _current_info = NULL;

  } else {

    assert(_dynamic_archive_info == this, "must be singleton"); // not thread safe

    _dynamic_archive_info = NULL;

  }

}

void FileMapInfo::populate_header(size_t alignment) {

  header()->populate(this, alignment);

}

void FileMapHeader::populate(FileMapInfo* mapinfo, size_t alignment) {

  if (DynamicDumpSharedSpaces) {

    _magic = CDS_DYNAMIC_ARCHIVE_MAGIC;

  } else {

    _magic = CDS_ARCHIVE_MAGIC;

  }

  _version = CURRENT_CDS_ARCHIVE_VERSION;

  _alignment = alignment;

  _obj_alignment = ObjectAlignmentInBytes;

  _compact_strings = CompactStrings;

  _narrow_oop_mode = CompressedOops::mode();

  _narrow_oop_base = CompressedOops::base();

  _narrow_oop_shift = CompressedOops::shift();

  _max_heap_size = MaxHeapSize;

  _narrow_klass_shift = CompressedKlassPointers::shift();

  if (HeapShared::is_heap_object_archiving_allowed()) {

    _heap_end = CompressedOops::end();

  }

  // The following fields are for sanity checks for whether this archive

  // will function correctly with this JVM and the bootclasspath it's

  // invoked with.

  // JVM version string ... changes on each build.

  get_header_version(_jvm_ident);

  _app_class_paths_start_index = ClassLoaderExt::app_class_paths_start_index();

  _app_module_paths_start_index = ClassLoaderExt::app_module_paths_start_index();

  _num_module_paths = ClassLoader::num_module_path_entries();

  _max_used_path_index = ClassLoaderExt::max_used_path_index();

  _verify_local = BytecodeVerificationLocal;

  _verify_remote = BytecodeVerificationRemote;

  _has_platform_or_app_classes = ClassLoaderExt::has_platform_or_app_classes();

  _requested_base_address = (char*)SharedBaseAddress;

  _mapped_base_address = (char*)SharedBaseAddress;

  _allow_archiving_with_java_agent = AllowArchivingWithJavaAgent;

  // the following 2 fields will be set in write_header for dynamic archive header

  _base_archive_name_size = 0;

  _base_archive_is_default = false;

  if (!DynamicDumpSharedSpaces) {

    set_shared_path_table(mapinfo->_shared_path_table);

  }

}

void SharedClassPathEntry::init_as_non_existent(const char* path, TRAPS) {

  _type = non_existent_entry;

  set_name(path, THREAD);

}

void SharedClassPathEntry::init(bool is_modules_image,

                                ClassPathEntry* cpe, TRAPS) {

  Arguments::assert_is_dumping_archive();

  _timestamp = 0;

  _filesize  = 0;

  _from_class_path_attr = false;

  struct stat st;

  if (os::stat(cpe->name(), &st) == 0) {

    if ((st.st_mode & S_IFMT) == S_IFDIR) {

      _type = dir_entry;

    } else {

      // The timestamp of the modules_image is not checked at runtime.

      if (is_modules_image) {

        _type = modules_image_entry;

      } else {

        _type = jar_entry;

        _timestamp = st.st_mtime;

        _from_class_path_attr = cpe->from_class_path_attr();

      }

      _filesize = st.st_size;

    }

  } else {

    // The file/dir must exist, or it would not have been added

    // into ClassLoader::classpath_entry().

    //

    // If we can't access a jar file in the boot path, then we can't

    // make assumptions about where classes get loaded from.

    FileMapInfo::fail_stop("Unable to open file %s.", cpe->name());

  }

  // No need to save the name of the module file, as it will be computed at run time

  // to allow relocation of the JDK directory.

  const char* name = is_modules_image  ? "" : cpe->name();

  set_name(name, THREAD);

}

void SharedClassPathEntry::set_name(const char* name, TRAPS) {

  size_t len = strlen(name) + 1;

  _name = MetadataFactory::new_array<char>(ClassLoaderData::the_null_class_loader_data(), (int)len, THREAD);

  strcpy(_name->data(), name);

}

const char* SharedClassPathEntry::name() const {

  if (UseSharedSpaces && is_modules_image()) {

    // In order to validate the runtime modules image file size against the archived

    // size information, we need to obtain the runtime modules image path. The recorded

    // dump time modules image path in the archive may be different from the runtime path

    // if the JDK image has beed moved after generating the archive.

    return ClassLoader::get_jrt_entry()->name();

  } else {

    return _name->data();

  }

}

bool SharedClassPathEntry::validate(bool is_class_path) const {

  assert(UseSharedSpaces, "runtime only");

  struct stat st;

  const char* name = this->name();

  bool ok = true;

  log_info(class, path)("checking shared classpath entry: %s", name);

  if (os::stat(name, &st) != 0 && is_class_path) {

    // If the archived module path entry does not exist at runtime, it is not fatal

    // (no need to invalid the shared archive) because the shared runtime visibility check

    // filters out any archived module classes that do not have a matching runtime

    // module path location.

    FileMapInfo::fail_continue("Required classpath entry does not exist: %s", name);

    ok = false;

  } else if (is_dir()) {

    if (!os::dir_is_empty(name)) {

      FileMapInfo::fail_continue("directory is not empty: %s", name);

      ok = false;

    }

  } else if ((has_timestamp() && _timestamp != st.st_mtime) ||

             _filesize != st.st_size) {

    ok = false;

    if (PrintSharedArchiveAndExit) {

      FileMapInfo::fail_continue(_timestamp != st.st_mtime ?

                                 "Timestamp mismatch" :

                                 "File size mismatch");

    } else {

      FileMapInfo::fail_continue("A jar file is not the one used while building"

                                 " the shared archive file: %s", name);

    }

  }

  if (PrintSharedArchiveAndExit && !ok) {

    // If PrintSharedArchiveAndExit is enabled, don't report failure to the

    // caller. Please see above comments for more details.

    ok = true;

    MetaspaceShared::set_archive_loading_failed();

  }

  return ok;

}

bool SharedClassPathEntry::check_non_existent() const {

  assert(_type == non_existent_entry, "must be");

  log_info(class, path)("should be non-existent: %s", name());

  struct stat st;

  if (os::stat(name(), &st) != 0) {

    log_info(class, path)("ok");

    return true; // file doesn't exist

  } else {

    return false;

  }

}

void SharedClassPathEntry::metaspace_pointers_do(MetaspaceClosure* it) {

  it->push(&_name);

  it->push(&_manifest);

}

void SharedPathTable::metaspace_pointers_do(MetaspaceClosure* it) {

  it->push(&_table);

  for (int i=0; i<_size; i++) {

    path_at(i)->metaspace_pointers_do(it);

  }

}

void SharedPathTable::dumptime_init(ClassLoaderData* loader_data, Thread* THREAD) {

  size_t entry_size = sizeof(SharedClassPathEntry);

  int num_entries = 0;

  num_entries += ClassLoader::num_boot_classpath_entries();

  num_entries += ClassLoader::num_app_classpath_entries();

  num_entries += ClassLoader::num_module_path_entries();

  num_entries += FileMapInfo::num_non_existent_class_paths();

  size_t bytes = entry_size * num_entries;

  _table = MetadataFactory::new_array<u8>(loader_data, (int)(bytes + 7 / 8), THREAD);

  _size = num_entries;

}

void FileMapInfo::allocate_shared_path_table() {

  Arguments::assert_is_dumping_archive();

  EXCEPTION_MARK; // The following calls should never throw, but would exit VM on error.

  ClassLoaderData* loader_data = ClassLoaderData::the_null_class_loader_data();

  ClassPathEntry* jrt = ClassLoader::get_jrt_entry();

  assert(jrt != NULL,

         "No modular java runtime image present when allocating the CDS classpath entry table");

  _shared_path_table.dumptime_init(loader_data, THREAD);

  // 1. boot class path

  int i = 0;

  i = add_shared_classpaths(i, "boot",   jrt, THREAD);

  i = add_shared_classpaths(i, "app",    ClassLoader::app_classpath_entries(), THREAD);

  i = add_shared_classpaths(i, "module", ClassLoader::module_path_entries(), THREAD);

  for (int x = 0; x < num_non_existent_class_paths(); x++, i++) {

    const char* path = _non_existent_class_paths->at(x);

    shared_path(i)->init_as_non_existent(path, THREAD);

  }

  assert(i == _shared_path_table.size(), "number of shared path entry mismatch");

}

int FileMapInfo::add_shared_classpaths(int i, const char* which, ClassPathEntry *cpe, TRAPS) {

  while (cpe != NULL) {

    bool is_jrt = (cpe == ClassLoader::get_jrt_entry());

    const char* type = (is_jrt ? "jrt" : (cpe->is_jar_file() ? "jar" : "dir"));

    log_info(class, path)("add %s shared path (%s) %s", which, type, cpe->name());

    SharedClassPathEntry* ent = shared_path(i);

    ent->init(is_jrt, cpe, THREAD);

    if (cpe->is_jar_file()) {

      update_jar_manifest(cpe, ent, THREAD);

    }

    if (is_jrt) {

      cpe = ClassLoader::get_next_boot_classpath_entry(cpe);

    } else {

      cpe = cpe->next();

    }

    i++;

  }

  return i;

}

void FileMapInfo::check_nonempty_dir_in_shared_path_table() {

  Arguments::assert_is_dumping_archive();

  bool has_nonempty_dir = false;

  int last = _shared_path_table.size() - 1;

  if (last > ClassLoaderExt::max_used_path_index()) {

     // no need to check any path beyond max_used_path_index

     last = ClassLoaderExt::max_used_path_index();

  }

  for (int i = 0; i <= last; i++) {

    SharedClassPathEntry *e = shared_path(i);

    if (e->is_dir()) {

      const char* path = e->name();

      if (!os::dir_is_empty(path)) {

        log_error(cds)("Error: non-empty directory '%s'", path);

        has_nonempty_dir = true;

      }

    }

  }

  if (has_nonempty_dir) {

    ClassLoader::exit_with_path_failure("Cannot have non-empty directory in paths", NULL);

  }

}

void FileMapInfo::record_non_existent_class_path_entry(const char* path) {

  Arguments::assert_is_dumping_archive();

  log_info(class, path)("non-existent Class-Path entry %s", path);

  if (_non_existent_class_paths == NULL) {

    _non_existent_class_paths = new (ResourceObj::C_HEAP, mtInternal)GrowableArray<const char*>(10, true);

  }

  _non_existent_class_paths->append(os::strdup(path));

}

int FileMapInfo::num_non_existent_class_paths() {

  Arguments::assert_is_dumping_archive();

  if (_non_existent_class_paths != NULL) {

    return _non_existent_class_paths->length();

  } else {

    return 0;

  }

}

class ManifestStream: public ResourceObj {

  private:

  u1*   _buffer_start; // Buffer bottom

  u1*   _buffer_end;   // Buffer top (one past last element)

  u1*   _current;      // Current buffer position

 public:

  // Constructor

  ManifestStream(u1* buffer, int length) : _buffer_start(buffer),

                                           _current(buffer) {

    _buffer_end = buffer + length;