/*

 * Copyright (c) 1997, 2015, 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 "classfile/classFileParser.hpp"

#include "classfile/classFileStream.hpp"

#include "classfile/classLoader.hpp"

#include "classfile/classLoaderData.inline.hpp"

#include "classfile/classLoaderExt.hpp"

#include "classfile/javaClasses.hpp"

#include "classfile/jimage.hpp"

#include "classfile/systemDictionary.hpp"

#include "classfile/vmSymbols.hpp"

#include "compiler/compileBroker.hpp"

#include "gc/shared/collectedHeap.inline.hpp"

#include "gc/shared/generation.hpp"

#include "interpreter/bytecodeStream.hpp"

#include "interpreter/oopMapCache.hpp"

#include "memory/allocation.inline.hpp"

#include "memory/filemap.hpp"

#include "memory/oopFactory.hpp"

#include "memory/universe.inline.hpp"

#include "oops/instanceKlass.hpp"

#include "oops/instanceRefKlass.hpp"

#include "oops/oop.inline.hpp"

#include "oops/symbol.hpp"

#include "prims/jvm_misc.hpp"

#include "runtime/arguments.hpp"

#include "runtime/compilationPolicy.hpp"

#include "runtime/fprofiler.hpp"

#include "runtime/handles.hpp"

#include "runtime/handles.inline.hpp"

#include "runtime/init.hpp"

#include "runtime/interfaceSupport.hpp"

#include "runtime/java.hpp"

#include "runtime/javaCalls.hpp"

#include "runtime/os.hpp"

#include "runtime/threadCritical.hpp"

#include "runtime/timer.hpp"

#include "runtime/vm_version.hpp"

#include "services/management.hpp"

#include "services/threadService.hpp"

#include "utilities/events.hpp"

#include "utilities/hashtable.inline.hpp"

#include "utilities/macros.hpp"

#if INCLUDE_CDS

#include "classfile/sharedClassUtil.hpp"

#include "classfile/sharedPathsMiscInfo.hpp"

#endif

// Entry points in zip.dll for loading zip/jar file entries

typedef void * * (JNICALL *ZipOpen_t)(const char *name, char **pmsg);

typedef void (JNICALL *ZipClose_t)(jzfile *zip);

typedef jzentry* (JNICALL *FindEntry_t)(jzfile *zip, const char *name, jint *sizeP, jint *nameLen);

typedef jboolean (JNICALL *ReadEntry_t)(jzfile *zip, jzentry *entry, unsigned char *buf, char *namebuf);

typedef jboolean (JNICALL *ReadMappedEntry_t)(jzfile *zip, jzentry *entry, unsigned char **buf, char *namebuf);

typedef jzentry* (JNICALL *GetNextEntry_t)(jzfile *zip, jint n);

typedef jboolean (JNICALL *ZipInflateFully_t)(void *inBuf, jlong inLen, void *outBuf, jlong outLen, char **pmsg);

typedef jint     (JNICALL *Crc32_t)(jint crc, const jbyte *buf, jint len);

static ZipOpen_t         ZipOpen            = NULL;

static ZipClose_t        ZipClose           = NULL;

static FindEntry_t       FindEntry          = NULL;

static ReadEntry_t       ReadEntry          = NULL;

static ReadMappedEntry_t ReadMappedEntry    = NULL;

static GetNextEntry_t    GetNextEntry       = NULL;

static canonicalize_fn_t CanonicalizeEntry  = NULL;

static ZipInflateFully_t ZipInflateFully    = NULL;

static Crc32_t           Crc32              = NULL;

// Entry points for jimage.dll for loading jimage file entries

static JImageOpen_t                    JImageOpen                    = NULL;

static JImageClose_t                   JImageClose                   = NULL;

static JImagePackageToModule_t         JImagePackageToModule         = NULL;

static JImageFindResource_t            JImageFindResource            = NULL;

static JImageGetResource_t             JImageGetResource             = NULL;

static JImageResourceIterator_t        JImageResourceIterator        = NULL;

// Globals

PerfCounter*    ClassLoader::_perf_accumulated_time = NULL;

PerfCounter*    ClassLoader::_perf_classes_inited = NULL;

PerfCounter*    ClassLoader::_perf_class_init_time = NULL;

PerfCounter*    ClassLoader::_perf_class_init_selftime = NULL;

PerfCounter*    ClassLoader::_perf_classes_verified = NULL;

PerfCounter*    ClassLoader::_perf_class_verify_time = NULL;

PerfCounter*    ClassLoader::_perf_class_verify_selftime = NULL;

PerfCounter*    ClassLoader::_perf_classes_linked = NULL;

PerfCounter*    ClassLoader::_perf_class_link_time = NULL;

PerfCounter*    ClassLoader::_perf_class_link_selftime = NULL;

PerfCounter*    ClassLoader::_perf_class_parse_time = NULL;

PerfCounter*    ClassLoader::_perf_class_parse_selftime = NULL;

PerfCounter*    ClassLoader::_perf_sys_class_lookup_time = NULL;

PerfCounter*    ClassLoader::_perf_shared_classload_time = NULL;

PerfCounter*    ClassLoader::_perf_sys_classload_time = NULL;

PerfCounter*    ClassLoader::_perf_app_classload_time = NULL;

PerfCounter*    ClassLoader::_perf_app_classload_selftime = NULL;

PerfCounter*    ClassLoader::_perf_app_classload_count = NULL;

PerfCounter*    ClassLoader::_perf_define_appclasses = NULL;

PerfCounter*    ClassLoader::_perf_define_appclass_time = NULL;

PerfCounter*    ClassLoader::_perf_define_appclass_selftime = NULL;

PerfCounter*    ClassLoader::_perf_app_classfile_bytes_read = NULL;

PerfCounter*    ClassLoader::_perf_sys_classfile_bytes_read = NULL;

PerfCounter*    ClassLoader::_sync_systemLoaderLockContentionRate = NULL;

PerfCounter*    ClassLoader::_sync_nonSystemLoaderLockContentionRate = NULL;

PerfCounter*    ClassLoader::_sync_JVMFindLoadedClassLockFreeCounter = NULL;

PerfCounter*    ClassLoader::_sync_JVMDefineClassLockFreeCounter = NULL;

PerfCounter*    ClassLoader::_sync_JNIDefineClassLockFreeCounter = NULL;

PerfCounter*    ClassLoader::_unsafe_defineClassCallCounter = NULL;

PerfCounter*    ClassLoader::_isUnsyncloadClass = NULL;

PerfCounter*    ClassLoader::_load_instance_class_failCounter = NULL;

ClassPathEntry* ClassLoader::_first_entry         = NULL;

ClassPathEntry* ClassLoader::_last_entry          = NULL;

int             ClassLoader::_num_entries         = 0;

PackageHashtable* ClassLoader::_package_hash_table = NULL;

#if INCLUDE_CDS

SharedPathsMiscInfo* ClassLoader::_shared_paths_misc_info = NULL;

#endif

// helper routines

bool string_starts_with(const char* str, const char* str_to_find) {

  size_t str_len = strlen(str);

  size_t str_to_find_len = strlen(str_to_find);

  if (str_to_find_len > str_len) {

    return false;

  }

  return (strncmp(str, str_to_find, str_to_find_len) == 0);

}

static const char* get_jimage_version_string() {

  static char version_string[10] = "";

  if (version_string[0] == '\0') {

    jio_snprintf(version_string, sizeof(version_string), "%d.%d",

                 Abstract_VM_Version::vm_minor_version(), Abstract_VM_Version::vm_micro_version());

  }

  return (const char*)version_string;

}

bool string_ends_with(const char* str, const char* str_to_find) {

  size_t str_len = strlen(str);

  size_t str_to_find_len = strlen(str_to_find);

  if (str_to_find_len > str_len) {

    return false;

  }

  return (strncmp(str + (str_len - str_to_find_len), str_to_find, str_to_find_len) == 0);

}

ClassPathEntry::ClassPathEntry() {

  set_next(NULL);

}

ClassPathDirEntry::ClassPathDirEntry(const char* dir) : ClassPathEntry() {

  char* copy = NEW_C_HEAP_ARRAY(char, strlen(dir)+1, mtClass);

  strcpy(copy, dir);

  _dir = copy;

}

ClassFileStream* ClassPathDirEntry::open_stream(const char* name, TRAPS) {

  // construct full path name

  char path[JVM_MAXPATHLEN];

  if (jio_snprintf(path, sizeof(path), "%s%s%s", _dir, os::file_separator(), name) == -1) {

    return NULL;

  }

  // check if file exists

  struct stat st;

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

#if INCLUDE_CDS

    if (DumpSharedSpaces) {

      // We have already check in ClassLoader::check_shared_classpath() that the directory is empty, so

      // we should never find a file underneath it -- unless user has added a new file while we are running

      // the dump, in which case let's quit!

      ShouldNotReachHere();

    }

#endif

    // found file, open it

    int file_handle = os::open(path, 0, 0);

    if (file_handle != -1) {

      // read contents into resource array

      u1* buffer = NEW_RESOURCE_ARRAY(u1, st.st_size);

      size_t num_read = os::read(file_handle, (char*) buffer, st.st_size);

      // close file

      os::close(file_handle);

      // construct ClassFileStream

      if (num_read == (size_t)st.st_size) {

        if (UsePerfData) {

          ClassLoader::perf_sys_classfile_bytes_read()->inc(num_read);

        }

        return new ClassFileStream(buffer, st.st_size, _dir);    // Resource allocated

      }

    }

  }

  return NULL;

}

ClassPathZipEntry::ClassPathZipEntry(jzfile* zip, const char* zip_name) : ClassPathEntry() {

  _zip = zip;

  char *copy = NEW_C_HEAP_ARRAY(char, strlen(zip_name)+1, mtClass);

  strcpy(copy, zip_name);

  _zip_name = copy;

}

ClassPathZipEntry::~ClassPathZipEntry() {

  if (ZipClose != NULL) {

    (*ZipClose)(_zip);

  }

  FREE_C_HEAP_ARRAY(char, _zip_name);

}

u1* ClassPathZipEntry::open_entry(const char* name, jint* filesize, bool nul_terminate, TRAPS) {

    // enable call to C land

  JavaThread* thread = JavaThread::current();

  ThreadToNativeFromVM ttn(thread);

  // check whether zip archive contains name

  jint name_len;

  jzentry* entry = (*FindEntry)(_zip, name, filesize, &name_len);

  if (entry == NULL) return NULL;

  u1* buffer;

  char name_buf[128];

  char* filename;

  if (name_len < 128) {

    filename = name_buf;

  } else {

    filename = NEW_RESOURCE_ARRAY(char, name_len + 1);

  }

  // file found, get pointer to the entry in mmapped jar file.

  if (ReadMappedEntry == NULL ||

      !(*ReadMappedEntry)(_zip, entry, &buffer, filename)) {

      // mmapped access not available, perhaps due to compression,

      // read contents into resource array

      int size = (*filesize) + ((nul_terminate) ? 1 : 0);

      buffer = NEW_RESOURCE_ARRAY(u1, size);

      if (!(*ReadEntry)(_zip, entry, buffer, filename)) return NULL;

  }

  // return result

  if (nul_terminate) {

    buffer[*filesize] = 0;

  }

  return buffer;

}

ClassFileStream* ClassPathZipEntry::open_stream(const char* name, TRAPS) {

  jint filesize;

  u1* buffer = open_entry(name, &filesize, false, CHECK_NULL);

  if (buffer == NULL) {

    return NULL;

  }

  if (UsePerfData) {

    ClassLoader::perf_sys_classfile_bytes_read()->inc(filesize);

  }

  return new ClassFileStream(buffer, filesize, _zip_name); // Resource allocated

}

// invoke function for each entry in the zip file

void ClassPathZipEntry::contents_do(void f(const char* name, void* context), void* context) {

  JavaThread* thread = JavaThread::current();

  HandleMark  handle_mark(thread);

  ThreadToNativeFromVM ttn(thread);

  for (int n = 0; ; n++) {

    jzentry * ze = ((*GetNextEntry)(_zip, n));

    if (ze == NULL) break;

    (*f)(ze->name, context);

  }

}

ClassPathImageEntry::ClassPathImageEntry(JImageFile* jimage, const char* name) :

  ClassPathEntry(),

  _jimage(jimage) {

  guarantee(jimage != NULL, "jimage file is null");

  guarantee(name != NULL, "jimage file name is null");

  size_t len = strlen(name) + 1;

  _name = NEW_C_HEAP_ARRAY(const char, len, mtClass);

  strncpy((char *)_name, name, len);

}

ClassPathImageEntry::~ClassPathImageEntry() {

  if (_name != NULL) {

    FREE_C_HEAP_ARRAY(const char, _name);

    _name = NULL;

  }

  if (_jimage != NULL) {

    (*JImageClose)(_jimage);

    _jimage = NULL;

  }

}

void ClassPathImageEntry::name_to_package(const char* name, char* buffer, int length) {

  const char *pslash = strrchr(name, '/');

  if (pslash == NULL) {

    buffer[0] = '\0';

    return;

  }

  int len = pslash - name;

#if INCLUDE_CDS

  if (len <= 0 && DumpSharedSpaces) {

    buffer[0] = '\0';

    return;

  }

#endif

  assert(len > 0, "Bad length for package name");

  if (len >= length) {

    buffer[0] = '\0';

    return;

  }

  // drop name after last slash (including slash)

  // Ex., "java/lang/String.class" => "java/lang"

  strncpy(buffer, name, len);

  // ensure string termination (strncpy does not guarantee)

  buffer[len] = '\0';

}

// For a class in a named module, look it up in the jimage file using this syntax:

//    /<module-name>/<package-name>/<base-class>

//

// Assumptions:

//     1. There are no unnamed modules in the jimage file.

//     2. A package is in at most one module in the jimage file.

//

ClassFileStream* ClassPathImageEntry::open_stream(const char* name, TRAPS) {

  jlong size;

  JImageLocationRef location = (*JImageFindResource)(_jimage, "", get_jimage_version_string(), name, &size);

  if (location == 0) {

    char package[JIMAGE_MAX_PATH];

    name_to_package(name, package, JIMAGE_MAX_PATH);

    if (package[0] != '\0') {

        const char* module = (*JImagePackageToModule)(_jimage, package);

        if (module == NULL) {

            module = "java.base";

        }

        location = (*JImageFindResource)(_jimage, module, get_jimage_version_string(), name, &size);

    }

  }

  if (location != 0) {

    if (UsePerfData) {

      ClassLoader::perf_sys_classfile_bytes_read()->inc(size);

    }

    char* data = NEW_RESOURCE_ARRAY(char, size);

    (*JImageGetResource)(_jimage, location, data, size);

    return new ClassFileStream((u1*)data, (int)size, _name);  // Resource allocated

  }

  return NULL;

}

#ifndef PRODUCT

bool ctw_visitor(JImageFile* jimage,

        const char* module_name, const char* version, const char* package,

        const char* name, const char* extension, void* arg) {

  if (strcmp(extension, "class") == 0) {

    Thread* THREAD = Thread::current();

    char path[JIMAGE_MAX_PATH];

    jio_snprintf(path, JIMAGE_MAX_PATH - 1, "%s/%s.class", package, name);

    ClassLoader::compile_the_world_in(path, *(Handle*)arg, THREAD);

    return !HAS_PENDING_EXCEPTION;

  }

  return true;

}

void ClassPathImageEntry::compile_the_world(Handle loader, TRAPS) {

  tty->print_cr("CompileTheWorld : Compiling all classes in %s", name());

  tty->cr();

  (*JImageResourceIterator)(_jimage, (JImageResourceVisitor_t)ctw_visitor, (void *)&loader);

  if (HAS_PENDING_EXCEPTION) {

    if (PENDING_EXCEPTION->is_a(SystemDictionary::OutOfMemoryError_klass())) {

      CLEAR_PENDING_EXCEPTION;

      tty->print_cr("\nCompileTheWorld : Ran out of memory\n");

      tty->print_cr("Increase class metadata storage if a limit was set");

    } else {

      tty->print_cr("\nCompileTheWorld : Unexpected exception occurred\n");

    }

  }

}

bool ClassPathImageEntry::is_jrt() {

  return string_ends_with(name(), BOOT_IMAGE_NAME);

}

#endif

#if INCLUDE_CDS

void ClassLoader::exit_with_path_failure(const char* error, const char* message) {

  assert(DumpSharedSpaces, "only called at dump time");

  tty->print_cr("Hint: enable -XX:+TraceClassPaths to diagnose the failure");

  vm_exit_during_initialization(error, message);

}

#endif

void ClassLoader::trace_class_path(const char* msg, const char* name) {

  if (!TraceClassPaths) {

    return;

  }

  if (msg) {

    tty->print("%s", msg);

  }

  if (name) {

    if (strlen(name) < 256) {

      tty->print("%s", name);

    } else {

      // For very long paths, we need to print each character separately,

      // as print_cr() has a length limit

      while (name[0] != '\0') {

        tty->print("%c", name[0]);

        name++;

      }

    }

  }

  if (msg && msg[0] == '[') {

    tty->print_cr("]");

  } else {

    tty->cr();

  }

}

#if INCLUDE_CDS

void ClassLoader::check_shared_classpath(const char *path) {

  if (strcmp(path, "") == 0) {

    exit_with_path_failure("Cannot have empty path in archived classpaths", NULL);

  }

  struct stat st;

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

    if ((st.st_mode & S_IFREG) != S_IFREG) { // is directory

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

        tty->print_cr("Error: non-empty directory '%s'", path);

        exit_with_path_failure("CDS allows only empty directories in archived classpaths", NULL);

      }

    }

  }

}

#endif

void ClassLoader::setup_bootstrap_search_path() {

  assert(_first_entry == NULL, "should not setup bootstrap class search path twice");

  const char* sys_class_path = Arguments::get_sysclasspath();

  if (PrintSharedArchiveAndExit) {

    // Don't print sys_class_path - this is the bootcp of this current VM process, not necessarily

    // the same as the bootcp of the shared archive.

  } else {

    trace_class_path("[Bootstrap loader class path=", sys_class_path);

  }

#if INCLUDE_CDS

  if (DumpSharedSpaces) {

    _shared_paths_misc_info->add_boot_classpath(sys_class_path);

  }

#endif

  setup_search_path(sys_class_path);

}

#if INCLUDE_CDS

int ClassLoader::get_shared_paths_misc_info_size() {

  return _shared_paths_misc_info->get_used_bytes();

}

void* ClassLoader::get_shared_paths_misc_info() {

  return _shared_paths_misc_info->buffer();

}

bool ClassLoader::check_shared_paths_misc_info(void *buf, int size) {

  SharedPathsMiscInfo* checker = SharedClassUtil::allocate_shared_paths_misc_info((char*)buf, size);

  bool result = checker->check();

  delete checker;

  return result;

}

#endif

void ClassLoader::setup_search_path(const char *class_path) {

  int offset = 0;

  int len = (int)strlen(class_path);