1 /*
   2  * Copyright (c) 1997, 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 "jimage.hpp"
  28 #include "classfile/classFileStream.hpp"
  29 #include "classfile/classLoader.inline.hpp"
  30 #include "classfile/classLoaderData.inline.hpp"
  31 #include "classfile/classLoaderExt.hpp"
  32 #include "classfile/javaClasses.hpp"
  33 #include "classfile/moduleEntry.hpp"
  34 #include "classfile/modules.hpp"
  35 #include "classfile/packageEntry.hpp"
  36 #include "classfile/klassFactory.hpp"
  37 #include "classfile/systemDictionary.hpp"
  38 #include "classfile/vmSymbols.hpp"
  39 #include "compiler/compileBroker.hpp"
  40 #include "gc/shared/collectedHeap.inline.hpp"
  41 #include "gc/shared/generation.hpp"
  42 #include "interpreter/bytecodeStream.hpp"
  43 #include "interpreter/oopMapCache.hpp"
  44 #include "logging/log.hpp"
  45 #include "logging/logStream.hpp"
  46 #include "logging/logTag.hpp"
  47 #include "memory/allocation.inline.hpp"
  48 #include "memory/filemap.hpp"
  49 #include "memory/oopFactory.hpp"
  50 #include "memory/resourceArea.hpp"
  51 #include "memory/universe.hpp"
  52 #include "oops/instanceKlass.hpp"
  53 #include "oops/instanceRefKlass.hpp"
  54 #include "oops/method.inline.hpp"
  55 #include "oops/objArrayOop.inline.hpp"
  56 #include "oops/oop.inline.hpp"
  57 #include "oops/symbol.hpp"
  58 #include "prims/jvm_misc.hpp"
  59 #include "runtime/arguments.hpp"
  60 #include "runtime/compilationPolicy.hpp"
  61 #include "runtime/handles.hpp"
  62 #include "runtime/handles.inline.hpp"
  63 #include "runtime/init.hpp"
  64 #include "runtime/interfaceSupport.inline.hpp"
  65 #include "runtime/java.hpp"
  66 #include "runtime/javaCalls.hpp"
  67 #include "runtime/os.inline.hpp"
  68 #include "runtime/threadCritical.hpp"
  69 #include "runtime/timer.hpp"
  70 #include "runtime/vm_version.hpp"
  71 #include "services/management.hpp"
  72 #include "services/threadService.hpp"
  73 #include "utilities/events.hpp"
  74 #include "utilities/hashtable.inline.hpp"
  75 #include "utilities/macros.hpp"
  76 #if INCLUDE_CDS
  77 #include "classfile/sharedClassUtil.hpp"
  78 #include "classfile/sharedPathsMiscInfo.hpp"
  79 #endif
  80 
  81 // Entry points in zip.dll for loading zip/jar file entries
  82 
  83 typedef void * * (JNICALL *ZipOpen_t)(const char *name, char **pmsg);
  84 typedef void (JNICALL *ZipClose_t)(jzfile *zip);
  85 typedef jzentry* (JNICALL *FindEntry_t)(jzfile *zip, const char *name, jint *sizeP, jint *nameLen);
  86 typedef jboolean (JNICALL *ReadEntry_t)(jzfile *zip, jzentry *entry, unsigned char *buf, char *namebuf);
  87 typedef jzentry* (JNICALL *GetNextEntry_t)(jzfile *zip, jint n);
  88 typedef jboolean (JNICALL *ZipInflateFully_t)(void *inBuf, jlong inLen, void *outBuf, jlong outLen, char **pmsg);
  89 typedef jint     (JNICALL *Crc32_t)(jint crc, const jbyte *buf, jint len);
  90 
  91 static ZipOpen_t         ZipOpen            = NULL;
  92 static ZipClose_t        ZipClose           = NULL;
  93 static FindEntry_t       FindEntry          = NULL;
  94 static ReadEntry_t       ReadEntry          = NULL;
  95 static GetNextEntry_t    GetNextEntry       = NULL;
  96 static canonicalize_fn_t CanonicalizeEntry  = NULL;
  97 static ZipInflateFully_t ZipInflateFully    = NULL;
  98 static Crc32_t           Crc32              = NULL;
  99 
 100 // Entry points for jimage.dll for loading jimage file entries
 101 
 102 static JImageOpen_t                    JImageOpen             = NULL;
 103 static JImageClose_t                   JImageClose            = NULL;
 104 static JImagePackageToModule_t         JImagePackageToModule  = NULL;
 105 static JImageFindResource_t            JImageFindResource     = NULL;
 106 static JImageGetResource_t             JImageGetResource      = NULL;
 107 static JImageResourceIterator_t        JImageResourceIterator = NULL;
 108 static JImage_ResourcePath_t           JImageResourcePath     = NULL;
 109 
 110 // Globals
 111 
 112 PerfCounter*    ClassLoader::_perf_accumulated_time = NULL;
 113 PerfCounter*    ClassLoader::_perf_classes_inited = NULL;
 114 PerfCounter*    ClassLoader::_perf_class_init_time = NULL;
 115 PerfCounter*    ClassLoader::_perf_class_init_selftime = NULL;
 116 PerfCounter*    ClassLoader::_perf_classes_verified = NULL;
 117 PerfCounter*    ClassLoader::_perf_class_verify_time = NULL;
 118 PerfCounter*    ClassLoader::_perf_class_verify_selftime = NULL;
 119 PerfCounter*    ClassLoader::_perf_classes_linked = NULL;
 120 PerfCounter*    ClassLoader::_perf_class_link_time = NULL;
 121 PerfCounter*    ClassLoader::_perf_class_link_selftime = NULL;
 122 PerfCounter*    ClassLoader::_perf_class_parse_time = NULL;
 123 PerfCounter*    ClassLoader::_perf_class_parse_selftime = NULL;
 124 PerfCounter*    ClassLoader::_perf_sys_class_lookup_time = NULL;
 125 PerfCounter*    ClassLoader::_perf_shared_classload_time = NULL;
 126 PerfCounter*    ClassLoader::_perf_sys_classload_time = NULL;
 127 PerfCounter*    ClassLoader::_perf_app_classload_time = NULL;
 128 PerfCounter*    ClassLoader::_perf_app_classload_selftime = NULL;
 129 PerfCounter*    ClassLoader::_perf_app_classload_count = NULL;
 130 PerfCounter*    ClassLoader::_perf_define_appclasses = NULL;
 131 PerfCounter*    ClassLoader::_perf_define_appclass_time = NULL;
 132 PerfCounter*    ClassLoader::_perf_define_appclass_selftime = NULL;
 133 PerfCounter*    ClassLoader::_perf_app_classfile_bytes_read = NULL;
 134 PerfCounter*    ClassLoader::_perf_sys_classfile_bytes_read = NULL;
 135 PerfCounter*    ClassLoader::_sync_systemLoaderLockContentionRate = NULL;
 136 PerfCounter*    ClassLoader::_sync_nonSystemLoaderLockContentionRate = NULL;
 137 PerfCounter*    ClassLoader::_sync_JVMFindLoadedClassLockFreeCounter = NULL;
 138 PerfCounter*    ClassLoader::_sync_JVMDefineClassLockFreeCounter = NULL;
 139 PerfCounter*    ClassLoader::_sync_JNIDefineClassLockFreeCounter = NULL;
 140 PerfCounter*    ClassLoader::_unsafe_defineClassCallCounter = NULL;
 141 PerfCounter*    ClassLoader::_load_instance_class_failCounter = NULL;
 142 
 143 GrowableArray<ModuleClassPathList*>* ClassLoader::_patch_mod_entries = NULL;
 144 GrowableArray<ModuleClassPathList*>* ClassLoader::_exploded_entries = NULL;
 145 ClassPathEntry* ClassLoader::_jrt_entry = NULL;
 146 ClassPathEntry* ClassLoader::_first_append_entry = NULL;
 147 ClassPathEntry* ClassLoader::_last_append_entry  = NULL;
 148 #if INCLUDE_CDS
 149 ClassPathEntry* ClassLoader::_app_classpath_entries = NULL;
 150 ClassPathEntry* ClassLoader::_last_app_classpath_entry = NULL;
 151 ClassPathEntry* ClassLoader::_module_path_entries = NULL;
 152 ClassPathEntry* ClassLoader::_last_module_path_entry = NULL;
 153 SharedPathsMiscInfo* ClassLoader::_shared_paths_misc_info = NULL;
 154 #endif
 155 
 156 // helper routines
 157 bool string_starts_with(const char* str, const char* str_to_find) {
 158   size_t str_len = strlen(str);
 159   size_t str_to_find_len = strlen(str_to_find);
 160   if (str_to_find_len > str_len) {
 161     return false;
 162   }
 163   return (strncmp(str, str_to_find, str_to_find_len) == 0);
 164 }
 165 
 166 static const char* get_jimage_version_string() {
 167   static char version_string[10] = "";
 168   if (version_string[0] == '\0') {
 169     jio_snprintf(version_string, sizeof(version_string), "%d.%d",
 170                  Abstract_VM_Version::vm_major_version(), Abstract_VM_Version::vm_minor_version());
 171   }
 172   return (const char*)version_string;
 173 }
 174 
 175 bool ClassLoader::string_ends_with(const char* str, const char* str_to_find) {
 176   size_t str_len = strlen(str);
 177   size_t str_to_find_len = strlen(str_to_find);
 178   if (str_to_find_len > str_len) {
 179     return false;
 180   }
 181   return (strncmp(str + (str_len - str_to_find_len), str_to_find, str_to_find_len) == 0);
 182 }
 183 
 184 // Used to obtain the package name from a fully qualified class name.
 185 // It is the responsibility of the caller to establish a ResourceMark.
 186 const char* ClassLoader::package_from_name(const char* const class_name, bool* bad_class_name) {
 187   if (class_name == NULL) {
 188     if (bad_class_name != NULL) {
 189       *bad_class_name = true;
 190     }
 191     return NULL;
 192   }
 193 
 194   if (bad_class_name != NULL) {
 195     *bad_class_name = false;
 196   }
 197 
 198   const char* const last_slash = strrchr(class_name, '/');
 199   if (last_slash == NULL) {
 200     // No package name
 201     return NULL;
 202   }
 203 
 204   char* class_name_ptr = (char*) class_name;
 205   // Skip over '['s
 206   if (*class_name_ptr == '[') {
 207     do {
 208       class_name_ptr++;
 209     } while (*class_name_ptr == '[');
 210 
 211     // Fully qualified class names should not contain a 'L'.
 212     // Set bad_class_name to true to indicate that the package name
 213     // could not be obtained due to an error condition.
 214     // In this situation, is_same_class_package returns false.
 215     if (*class_name_ptr == 'L') {
 216       if (bad_class_name != NULL) {
 217         *bad_class_name = true;
 218       }
 219       return NULL;
 220     }
 221   }
 222 
 223   int length = last_slash - class_name_ptr;
 224 
 225   // A class name could have just the slash character in the name.
 226   if (length <= 0) {
 227     // No package name
 228     if (bad_class_name != NULL) {
 229       *bad_class_name = true;
 230     }
 231     return NULL;
 232   }
 233 
 234   // drop name after last slash (including slash)
 235   // Ex., "java/lang/String.class" => "java/lang"
 236   char* pkg_name = NEW_RESOURCE_ARRAY(char, length + 1);
 237   strncpy(pkg_name, class_name_ptr, length);
 238   *(pkg_name+length) = '\0';
 239 
 240   return (const char *)pkg_name;
 241 }
 242 
 243 // Given a fully qualified class name, find its defining package in the class loader's
 244 // package entry table.
 245 PackageEntry* ClassLoader::get_package_entry(const char* class_name, ClassLoaderData* loader_data, TRAPS) {
 246   ResourceMark rm(THREAD);
 247   const char *pkg_name = ClassLoader::package_from_name(class_name);
 248   if (pkg_name == NULL) {
 249     return NULL;
 250   }
 251   PackageEntryTable* pkgEntryTable = loader_data->packages();
 252   TempNewSymbol pkg_symbol = SymbolTable::new_symbol(pkg_name, CHECK_NULL);
 253   return pkgEntryTable->lookup_only(pkg_symbol);
 254 }
 255 
 256 ClassPathDirEntry::ClassPathDirEntry(const char* dir) : ClassPathEntry() {
 257   char* copy = NEW_C_HEAP_ARRAY(char, strlen(dir)+1, mtClass);
 258   strcpy(copy, dir);
 259   _dir = copy;
 260 }
 261 
 262 
 263 ClassFileStream* ClassPathDirEntry::open_stream(const char* name, TRAPS) {
 264   // construct full path name
 265   assert((_dir != NULL) && (name != NULL), "sanity");
 266   size_t path_len = strlen(_dir) + strlen(name) + strlen(os::file_separator()) + 1;
 267   char* path = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, path_len);
 268   int len = jio_snprintf(path, path_len, "%s%s%s", _dir, os::file_separator(), name);
 269   assert(len == (int)(path_len - 1), "sanity");
 270   // check if file exists
 271   struct stat st;
 272   if (os::stat(path, &st) == 0) {
 273 #if INCLUDE_CDS
 274     if (DumpSharedSpaces) {
 275       // We have already check in ClassLoader::check_shared_classpath() that the directory is empty, so
 276       // we should never find a file underneath it -- unless user has added a new file while we are running
 277       // the dump, in which case let's quit!
 278       ShouldNotReachHere();
 279     }
 280 #endif
 281     // found file, open it
 282     int file_handle = os::open(path, 0, 0);
 283     if (file_handle != -1) {
 284       // read contents into resource array
 285       u1* buffer = NEW_RESOURCE_ARRAY(u1, st.st_size);
 286       size_t num_read = os::read(file_handle, (char*) buffer, st.st_size);
 287       // close file
 288       os::close(file_handle);
 289       // construct ClassFileStream
 290       if (num_read == (size_t)st.st_size) {
 291         if (UsePerfData) {
 292           ClassLoader::perf_sys_classfile_bytes_read()->inc(num_read);
 293         }
 294         FREE_RESOURCE_ARRAY(char, path, path_len);
 295         // Resource allocated
 296         return new ClassFileStream(buffer,
 297                                    st.st_size,
 298                                    _dir,
 299                                    ClassFileStream::verify);
 300       }
 301     }
 302   }
 303   FREE_RESOURCE_ARRAY(char, path, path_len);
 304   return NULL;
 305 }
 306 
 307 ClassPathZipEntry::ClassPathZipEntry(jzfile* zip, const char* zip_name, bool is_boot_append) : ClassPathEntry() {
 308   _zip = zip;
 309   char *copy = NEW_C_HEAP_ARRAY(char, strlen(zip_name)+1, mtClass);
 310   strcpy(copy, zip_name);
 311   _zip_name = copy;
 312   _is_boot_append = is_boot_append;
 313   _multi_versioned = _unknown;
 314 }
 315 
 316 ClassPathZipEntry::~ClassPathZipEntry() {
 317   if (ZipClose != NULL) {
 318     (*ZipClose)(_zip);
 319   }
 320   FREE_C_HEAP_ARRAY(char, _zip_name);
 321 }
 322 
 323 u1* ClassPathZipEntry::open_entry(const char* name, jint* filesize, bool nul_terminate, TRAPS) {
 324     // enable call to C land
 325   JavaThread* thread = JavaThread::current();
 326   ThreadToNativeFromVM ttn(thread);
 327   // check whether zip archive contains name
 328   jint name_len;
 329   jzentry* entry = (*FindEntry)(_zip, name, filesize, &name_len);
 330   if (entry == NULL) return NULL;
 331   u1* buffer;
 332   char name_buf[128];
 333   char* filename;
 334   if (name_len < 128) {
 335     filename = name_buf;
 336   } else {
 337     filename = NEW_RESOURCE_ARRAY(char, name_len + 1);
 338   }
 339 
 340   // read contents into resource array
 341   int size = (*filesize) + ((nul_terminate) ? 1 : 0);
 342   buffer = NEW_RESOURCE_ARRAY(u1, size);
 343   if (!(*ReadEntry)(_zip, entry, buffer, filename)) return NULL;
 344 
 345   // return result
 346   if (nul_terminate) {
 347     buffer[*filesize] = 0;
 348   }
 349   return buffer;
 350 }
 351 
 352 #if INCLUDE_CDS
 353 u1* ClassPathZipEntry::open_versioned_entry(const char* name, jint* filesize, TRAPS) {
 354   u1* buffer = NULL;
 355   if (DumpSharedSpaces && !_is_boot_append) {
 356     // We presume default is multi-release enabled
 357     const char* multi_ver = Arguments::get_property("jdk.util.jar.enableMultiRelease");
 358     const char* verstr = Arguments::get_property("jdk.util.jar.version");
 359     bool is_multi_ver = (multi_ver == NULL ||
 360                          strcmp(multi_ver, "true") == 0 ||
 361                          strcmp(multi_ver, "force")  == 0) &&
 362                          is_multiple_versioned(THREAD);
 363     // command line version setting
 364     int version = 0;
 365     const int base_version = 8; // JDK8
 366     int cur_ver = JDK_Version::current().major_version();
 367     if (verstr != NULL) {
 368       version = atoi(verstr);
 369       if (version < base_version || version > cur_ver) {
 370         // If the specified version is lower than the base version, the base
 371         // entry will be used; if the version is higher than the current
 372         // jdk version, the highest versioned entry will be used.
 373         if (version < base_version) {
 374           is_multi_ver = false;
 375         }
 376         // print out warning, do not use assertion here since it will continue to look
 377         // for proper version.
 378         warning("JDK%d is not supported in multiple version jars", version);
 379       }
 380     }
 381 
 382     if (is_multi_ver) {
 383       int n;
 384       const char* version_entry = "META-INF/versions/";
 385       // 10 is the max length of a decimal 32-bit non-negative number
 386       // 2 includes the '/' and trailing zero
 387       size_t entry_name_len = strlen(version_entry) + 10 + strlen(name) + 2;
 388       char* entry_name = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, entry_name_len);
 389       if (version > 0) {
 390         n = jio_snprintf(entry_name, entry_name_len, "%s%d/%s", version_entry, version, name);
 391         entry_name[n] = '\0';
 392         buffer = open_entry((const char*)entry_name, filesize, false, CHECK_NULL);
 393         if (buffer == NULL) {
 394           warning("Could not find %s in %s, try to find highest version instead", entry_name, _zip_name);
 395         }
 396       }
 397       if (buffer == NULL) {
 398         for (int i = cur_ver; i >= base_version; i--) {
 399           n = jio_snprintf(entry_name, entry_name_len, "%s%d/%s", version_entry, i, name);
 400           entry_name[n] = '\0';
 401           buffer = open_entry((const char*)entry_name, filesize, false, CHECK_NULL);
 402           if (buffer != NULL) {
 403             break;
 404           }
 405         }
 406       }
 407       FREE_RESOURCE_ARRAY(char, entry_name, entry_name_len);
 408     }
 409   }
 410   return buffer;
 411 }
 412 
 413 bool ClassPathZipEntry::is_multiple_versioned(TRAPS) {
 414   assert(DumpSharedSpaces, "called only at dump time");
 415   if (_multi_versioned != _unknown) {
 416     return (_multi_versioned == _yes) ? true : false;
 417   }
 418   jint size;
 419   char* buffer = (char*)open_entry("META-INF/MANIFEST.MF", &size, true, CHECK_false);
 420   if (buffer != NULL) {
 421     char* p = buffer;
 422     for ( ; *p; ++p) *p = tolower(*p);
 423     if (strstr(buffer, "multi-release: true") != NULL) {
 424       _multi_versioned = _yes;
 425       return true;
 426     }
 427   }
 428   _multi_versioned = _no;
 429   return false;
 430 }
 431 #endif // INCLUDE_CDS
 432 
 433 ClassFileStream* ClassPathZipEntry::open_stream(const char* name, TRAPS) {
 434   jint filesize;
 435   u1* buffer = open_versioned_entry(name, &filesize, CHECK_NULL);
 436   if (buffer == NULL) {
 437     buffer = open_entry(name, &filesize, false, CHECK_NULL);
 438     if (buffer == NULL) {
 439       return NULL;
 440     }
 441   }
 442   if (UsePerfData) {
 443     ClassLoader::perf_sys_classfile_bytes_read()->inc(filesize);
 444   }
 445   // Resource allocated
 446   return new ClassFileStream(buffer,
 447                              filesize,
 448                              _zip_name,
 449                              ClassFileStream::verify);
 450 }
 451 
 452 // invoke function for each entry in the zip file
 453 void ClassPathZipEntry::contents_do(void f(const char* name, void* context), void* context) {
 454   JavaThread* thread = JavaThread::current();
 455   HandleMark  handle_mark(thread);
 456   ThreadToNativeFromVM ttn(thread);
 457   for (int n = 0; ; n++) {
 458     jzentry * ze = ((*GetNextEntry)(_zip, n));
 459     if (ze == NULL) break;
 460     (*f)(ze->name, context);
 461   }
 462 }
 463 
 464 ClassPathImageEntry::ClassPathImageEntry(JImageFile* jimage, const char* name) :
 465   ClassPathEntry(),
 466   _jimage(jimage) {
 467   guarantee(jimage != NULL, "jimage file is null");
 468   guarantee(name != NULL, "jimage file name is null");
 469   size_t len = strlen(name) + 1;
 470   _name = NEW_C_HEAP_ARRAY(const char, len, mtClass);
 471   strncpy((char *)_name, name, len);
 472 }
 473 
 474 ClassPathImageEntry::~ClassPathImageEntry() {
 475   if (_name != NULL) {
 476     FREE_C_HEAP_ARRAY(const char, _name);
 477     _name = NULL;
 478   }
 479   if (_jimage != NULL) {
 480     (*JImageClose)(_jimage);
 481     _jimage = NULL;
 482   }
 483 }
 484 
 485 // For a class in a named module, look it up in the jimage file using this syntax:
 486 //    /<module-name>/<package-name>/<base-class>
 487 //
 488 // Assumptions:
 489 //     1. There are no unnamed modules in the jimage file.
 490 //     2. A package is in at most one module in the jimage file.
 491 //
 492 ClassFileStream* ClassPathImageEntry::open_stream(const char* name, TRAPS) {
 493   jlong size;
 494   JImageLocationRef location = (*JImageFindResource)(_jimage, "", get_jimage_version_string(), name, &size);
 495 
 496   if (location == 0) {
 497     ResourceMark rm;
 498     const char* pkg_name = ClassLoader::package_from_name(name);
 499 
 500     if (pkg_name != NULL) {
 501       if (!Universe::is_module_initialized()) {
 502         location = (*JImageFindResource)(_jimage, JAVA_BASE_NAME, get_jimage_version_string(), name, &size);
 503 #if INCLUDE_CDS
 504         // CDS uses the boot class loader to load classes whose packages are in
 505         // modules defined for other class loaders.  So, for now, get their module
 506         // names from the "modules" jimage file.
 507         if (DumpSharedSpaces && location == 0) {
 508           const char* module_name = (*JImagePackageToModule)(_jimage, pkg_name);
 509           if (module_name != NULL) {
 510             location = (*JImageFindResource)(_jimage, module_name, get_jimage_version_string(), name, &size);
 511           }
 512         }
 513 #endif
 514 
 515       } else {
 516         PackageEntry* package_entry = ClassLoader::get_package_entry(name, ClassLoaderData::the_null_class_loader_data(), CHECK_NULL);
 517         if (package_entry != NULL) {
 518           ResourceMark rm;
 519           // Get the module name
 520           ModuleEntry* module = package_entry->module();
 521           assert(module != NULL, "Boot classLoader package missing module");
 522           assert(module->is_named(), "Boot classLoader package is in unnamed module");
 523           const char* module_name = module->name()->as_C_string();
 524           if (module_name != NULL) {
 525             location = (*JImageFindResource)(_jimage, module_name, get_jimage_version_string(), name, &size);
 526           }
 527         }
 528       }
 529     }
 530   }
 531   if (location != 0) {
 532     if (UsePerfData) {
 533       ClassLoader::perf_sys_classfile_bytes_read()->inc(size);
 534     }
 535     char* data = NEW_RESOURCE_ARRAY(char, size);
 536     (*JImageGetResource)(_jimage, location, data, size);
 537     // Resource allocated
 538     return new ClassFileStream((u1*)data,
 539                                (int)size,
 540                                _name,
 541                                ClassFileStream::verify);
 542   }
 543 
 544   return NULL;
 545 }
 546 
 547 JImageLocationRef ClassLoader::jimage_find_resource(JImageFile* jf,
 548                                                     const char* module_name,
 549                                                     const char* file_name,
 550                                                     jlong &size) {
 551   return ((*JImageFindResource)(jf, module_name, get_jimage_version_string(), file_name, &size));
 552 }
 553 
 554 #ifndef PRODUCT
 555 bool ctw_visitor(JImageFile* jimage,
 556         const char* module_name, const char* version, const char* package,
 557         const char* name, const char* extension, void* arg) {
 558   if (strcmp(extension, "class") == 0) {
 559     Thread* THREAD = Thread::current();
 560     ResourceMark rm(THREAD);
 561     char* path = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, JIMAGE_MAX_PATH);
 562     jio_snprintf(path, JIMAGE_MAX_PATH - 1, "%s/%s.class", package, name);
 563     ClassLoader::compile_the_world_in(path, *(Handle*)arg, THREAD);
 564     return !HAS_PENDING_EXCEPTION;
 565   }
 566   return true;
 567 }
 568 
 569 void ClassPathImageEntry::compile_the_world(Handle loader, TRAPS) {
 570   tty->print_cr("CompileTheWorld : Compiling all classes in %s", name());
 571   tty->cr();
 572   (*JImageResourceIterator)(_jimage, (JImageResourceVisitor_t)ctw_visitor, (void *)&loader);
 573   if (HAS_PENDING_EXCEPTION) {
 574     if (PENDING_EXCEPTION->is_a(SystemDictionary::OutOfMemoryError_klass())) {
 575       CLEAR_PENDING_EXCEPTION;
 576       tty->print_cr("\nCompileTheWorld : Ran out of memory\n");
 577       tty->print_cr("Increase class metadata storage if a limit was set");
 578     } else {
 579       tty->print_cr("\nCompileTheWorld : Unexpected exception occurred\n");
 580     }
 581   }
 582 }
 583 #endif
 584 
 585 bool ClassPathImageEntry::is_modules_image() const {
 586   return ClassLoader::is_modules_image(name());
 587 }
 588 
 589 #if INCLUDE_CDS
 590 void ClassLoader::exit_with_path_failure(const char* error, const char* message) {
 591   assert(DumpSharedSpaces, "only called at dump time");
 592   tty->print_cr("Hint: enable -Xlog:class+path=info to diagnose the failure");
 593   vm_exit_during_initialization(error, message);
 594 }
 595 #endif
 596 
 597 ModuleClassPathList::ModuleClassPathList(Symbol* module_name) {
 598   _module_name = module_name;
 599   _module_first_entry = NULL;
 600   _module_last_entry = NULL;
 601 }
 602 
 603 ModuleClassPathList::~ModuleClassPathList() {
 604   // Clean out each ClassPathEntry on list
 605   ClassPathEntry* e = _module_first_entry;
 606   while (e != NULL) {
 607     ClassPathEntry* next_entry = e->next();
 608     delete e;
 609     e = next_entry;
 610   }
 611 }
 612 
 613 void ModuleClassPathList::add_to_list(ClassPathEntry* new_entry) {
 614   if (new_entry != NULL) {
 615     if (_module_last_entry == NULL) {
 616       _module_first_entry = _module_last_entry = new_entry;
 617     } else {
 618       _module_last_entry->set_next(new_entry);
 619       _module_last_entry = new_entry;
 620     }
 621   }
 622 }
 623 
 624 void ClassLoader::trace_class_path(const char* msg, const char* name) {
 625   LogTarget(Info, class, path) lt;
 626   if (lt.is_enabled()) {
 627     LogStream ls(lt);
 628     if (msg) {
 629       ls.print("%s", msg);
 630     }
 631     if (name) {
 632       if (strlen(name) < 256) {
 633         ls.print("%s", name);
 634       } else {
 635         // For very long paths, we need to print each character separately,
 636         // as print_cr() has a length limit
 637         while (name[0] != '\0') {
 638           ls.print("%c", name[0]);
 639           name++;
 640         }
 641       }
 642     }
 643     ls.cr();
 644   }
 645 }
 646 
 647 #if INCLUDE_CDS
 648 void ClassLoader::check_shared_classpath(const char *path) {
 649   if (strcmp(path, "") == 0) {
 650     exit_with_path_failure("Cannot have empty path in archived classpaths", NULL);
 651   }
 652 
 653   struct stat st;
 654   if (os::stat(path, &st) == 0) {
 655     if ((st.st_mode & S_IFMT) != S_IFREG) { // is not a regular file
 656       if (!os::dir_is_empty(path)) {
 657         tty->print_cr("Error: non-empty directory '%s'", path);
 658         exit_with_path_failure("CDS allows only empty directories in archived classpaths", NULL);
 659       }
 660     }
 661   }
 662 }
 663 #endif
 664 
 665 void ClassLoader::setup_bootstrap_search_path() {
 666   const char* sys_class_path = Arguments::get_sysclasspath();
 667   if (PrintSharedArchiveAndExit) {
 668     // Don't print sys_class_path - this is the bootcp of this current VM process, not necessarily
 669     // the same as the bootcp of the shared archive.
 670   } else {
 671     trace_class_path("bootstrap loader class path=", sys_class_path);
 672   }
 673 #if INCLUDE_CDS
 674   if (DumpSharedSpaces) {
 675     _shared_paths_misc_info->add_boot_classpath(sys_class_path);
 676   }
 677 #endif
 678   setup_boot_search_path(sys_class_path);
 679 }
 680 
 681 #if INCLUDE_CDS
 682 int ClassLoader::get_shared_paths_misc_info_size() {
 683   return _shared_paths_misc_info->get_used_bytes();
 684 }
 685 
 686 void* ClassLoader::get_shared_paths_misc_info() {
 687   return _shared_paths_misc_info->buffer();
 688 }
 689 
 690 bool ClassLoader::check_shared_paths_misc_info(void *buf, int size) {
 691   SharedPathsMiscInfo* checker = SharedClassUtil::allocate_shared_paths_misc_info((char*)buf, size);
 692   bool result = checker->check();
 693   delete checker;
 694   return result;
 695 }
 696 
 697 void ClassLoader::setup_app_search_path(const char *class_path) {
 698 
 699   assert(DumpSharedSpaces, "Sanity");
 700 
 701   Thread* THREAD = Thread::current();
 702   int len = (int)strlen(class_path);
 703   int end = 0;
 704 
 705   // Iterate over class path entries
 706   for (int start = 0; start < len; start = end) {
 707     while (class_path[end] && class_path[end] != os::path_separator()[0]) {
 708       end++;
 709     }
 710     EXCEPTION_MARK;
 711     ResourceMark rm(THREAD);
 712     char* path = NEW_RESOURCE_ARRAY(char, end - start + 1);
 713     strncpy(path, &class_path[start], end - start);
 714     path[end - start] = '\0';
 715 
 716     check_shared_classpath(path);
 717 
 718     update_class_path_entry_list(path, false, false);
 719 
 720     while (class_path[end] == os::path_separator()[0]) {
 721       end++;
 722     }
 723   }
 724 }
 725 
 726 void ClassLoader::add_to_module_path_entries(const char* path,
 727                                              ClassPathEntry* entry) {
 728   assert(entry != NULL, "ClassPathEntry should not be NULL");
 729   assert(DumpSharedSpaces, "dump time only");
 730 
 731   // The entry does not exist, add to the list
 732   if (_module_path_entries == NULL) {
 733     assert(_last_module_path_entry == NULL, "Sanity");
 734     _module_path_entries = _last_module_path_entry = entry;
 735   } else {
 736     _last_module_path_entry->set_next(entry);
 737     _last_module_path_entry = entry;
 738   }
 739 }
 740 
 741 // Add a module path to the _module_path_entries list.
 742 void ClassLoader::update_module_path_entry_list(const char *path, TRAPS) {
 743   assert(DumpSharedSpaces, "dump time only");
 744   struct stat st;
 745   int ret = os::stat(path, &st);
 746   assert(ret == 0, "module path must exist");
 747   // File or directory found
 748   ClassPathEntry* new_entry = NULL;
 749   new_entry = create_class_path_entry(path, &st, true /* throw_exception */,
 750                                       false /*is_boot_append */, CHECK);
 751   if (new_entry == NULL) {
 752     return;
 753   }
 754 
 755   add_to_module_path_entries(path, new_entry);
 756   return;
 757 }
 758 
 759 void ClassLoader::setup_module_search_path(const char* path, TRAPS) {
 760   check_shared_classpath(path);
 761   update_module_path_entry_list(path, THREAD);
 762 }
 763 #endif // INCLUDE_CDS
 764 
 765 // Construct the array of module/path pairs as specified to --patch-module
 766 // for the boot loader to search ahead of the jimage, if the class being
 767 // loaded is defined to a module that has been specified to --patch-module.
 768 void ClassLoader::setup_patch_mod_entries() {
 769   Thread* THREAD = Thread::current();
 770   GrowableArray<ModulePatchPath*>* patch_mod_args = Arguments::get_patch_mod_prefix();
 771   int num_of_entries = patch_mod_args->length();
 772 
 773 
 774   // Set up the boot loader's _patch_mod_entries list
 775   _patch_mod_entries = new (ResourceObj::C_HEAP, mtModule) GrowableArray<ModuleClassPathList*>(num_of_entries, true);
 776 
 777   for (int i = 0; i < num_of_entries; i++) {
 778     const char* module_name = (patch_mod_args->at(i))->module_name();
 779     Symbol* const module_sym = SymbolTable::lookup(module_name, (int)strlen(module_name), CHECK);
 780     assert(module_sym != NULL, "Failed to obtain Symbol for module name");
 781     ModuleClassPathList* module_cpl = new ModuleClassPathList(module_sym);
 782 
 783     char* class_path = (patch_mod_args->at(i))->path_string();
 784     int len = (int)strlen(class_path);
 785     int end = 0;
 786     // Iterate over the module's class path entries
 787     for (int start = 0; start < len; start = end) {
 788       while (class_path[end] && class_path[end] != os::path_separator()[0]) {
 789         end++;
 790       }
 791       EXCEPTION_MARK;
 792       ResourceMark rm(THREAD);
 793       char* path = NEW_RESOURCE_ARRAY(char, end - start + 1);
 794       strncpy(path, &class_path[start], end - start);
 795       path[end - start] = '\0';
 796 
 797       struct stat st;
 798       if (os::stat(path, &st) == 0) {
 799         // File or directory found
 800         Thread* THREAD = Thread::current();
 801         ClassPathEntry* new_entry = create_class_path_entry(path, &st, false, false, CHECK);
 802         // If the path specification is valid, enter it into this module's list
 803         if (new_entry != NULL) {
 804           module_cpl->add_to_list(new_entry);
 805         }
 806       }
 807 
 808       while (class_path[end] == os::path_separator()[0]) {
 809         end++;
 810       }
 811     }
 812 
 813     // Record the module into the list of --patch-module entries only if
 814     // valid ClassPathEntrys have been created
 815     if (module_cpl->module_first_entry() != NULL) {
 816       _patch_mod_entries->push(module_cpl);
 817     }
 818   }
 819 }
 820 
 821 // Determine whether the module has been patched via the command-line
 822 // option --patch-module
 823 bool ClassLoader::is_in_patch_mod_entries(Symbol* module_name) {
 824   if (_patch_mod_entries != NULL && _patch_mod_entries->is_nonempty()) {
 825     int table_len = _patch_mod_entries->length();
 826     for (int i = 0; i < table_len; i++) {
 827       ModuleClassPathList* patch_mod = _patch_mod_entries->at(i);
 828       if (module_name->fast_compare(patch_mod->module_name()) == 0) {
 829         return true;
 830       }
 831     }
 832   }
 833   return false;
 834 }
 835 
 836 // Set up the _jrt_entry if present and boot append path
 837 void ClassLoader::setup_boot_search_path(const char *class_path) {
 838   int len = (int)strlen(class_path);
 839   int end = 0;
 840   bool set_base_piece = true;
 841 
 842 #if INCLUDE_CDS
 843   if (DumpSharedSpaces) {
 844     if (!Arguments::has_jimage()) {
 845       vm_exit_during_initialization("CDS is not supported in exploded JDK build", NULL);
 846     }
 847   }
 848 #endif
 849 
 850   // Iterate over class path entries
 851   for (int start = 0; start < len; start = end) {
 852     while (class_path[end] && class_path[end] != os::path_separator()[0]) {
 853       end++;
 854     }
 855     EXCEPTION_MARK;
 856     ResourceMark rm(THREAD);
 857     char* path = NEW_RESOURCE_ARRAY(char, end - start + 1);
 858     strncpy(path, &class_path[start], end - start);
 859     path[end - start] = '\0';
 860 
 861     if (set_base_piece) {
 862       // The first time through the bootstrap_search setup, it must be determined
 863       // what the base or core piece of the boot loader search is.  Either a java runtime
 864       // image is present or this is an exploded module build situation.
 865       assert(string_ends_with(path, MODULES_IMAGE_NAME) || string_ends_with(path, JAVA_BASE_NAME),
 866              "Incorrect boot loader search path, no java runtime image or " JAVA_BASE_NAME " exploded build");
 867       struct stat st;
 868       if (os::stat(path, &st) == 0) {
 869         // Directory found
 870         Thread* THREAD = Thread::current();
 871         ClassPathEntry* new_entry = create_class_path_entry(path, &st, false, false, CHECK);
 872 
 873         // Check for a jimage
 874         if (Arguments::has_jimage()) {
 875           assert(_jrt_entry == NULL, "should not setup bootstrap class search path twice");
 876           assert(new_entry != NULL && new_entry->is_modules_image(), "No java runtime image present");
 877           _jrt_entry = new_entry;
 878           assert(_jrt_entry->jimage() != NULL, "No java runtime image");
 879         }
 880       } else {
 881         // If path does not exist, exit
 882         vm_exit_during_initialization("Unable to establish the boot loader search path", path);
 883       }
 884       set_base_piece = false;
 885     } else {
 886       // Every entry on the system boot class path after the initial base piece,
 887       // which is set by os::set_boot_path(), is considered an appended entry.
 888       update_class_path_entry_list(path, false, true);
 889     }
 890 
 891 #if INCLUDE_CDS
 892     if (DumpSharedSpaces) {
 893       check_shared_classpath(path);
 894     }
 895 #endif
 896     while (class_path[end] == os::path_separator()[0]) {
 897       end++;
 898     }
 899   }
 900 }
 901 
 902 // During an exploded modules build, each module defined to the boot loader
 903 // will be added to the ClassLoader::_exploded_entries array.
 904 void ClassLoader::add_to_exploded_build_list(Symbol* module_sym, TRAPS) {
 905   assert(!ClassLoader::has_jrt_entry(), "Exploded build not applicable");
 906   assert(_exploded_entries != NULL, "_exploded_entries was not initialized");
 907 
 908   // Find the module's symbol
 909   ResourceMark rm(THREAD);
 910   const char *module_name = module_sym->as_C_string();
 911   const char *home = Arguments::get_java_home();
 912   const char file_sep = os::file_separator()[0];
 913   // 10 represents the length of "modules" + 2 file separators + \0
 914   size_t len = strlen(home) + strlen(module_name) + 10;
 915   char *path = NEW_C_HEAP_ARRAY(char, len, mtModule);
 916   jio_snprintf(path, len, "%s%cmodules%c%s", home, file_sep, file_sep, module_name);
 917 
 918   struct stat st;
 919   if (os::stat(path, &st) == 0) {
 920     // Directory found
 921     ClassPathEntry* new_entry = create_class_path_entry(path, &st, false, false, CHECK);
 922 
 923     // If the path specification is valid, enter it into this module's list.
 924     // There is no need to check for duplicate modules in the exploded entry list,
 925     // since no two modules with the same name can be defined to the boot loader.
 926     // This is checked at module definition time in Modules::define_module.
 927     if (new_entry != NULL) {
 928       ModuleClassPathList* module_cpl = new ModuleClassPathList(module_sym);
 929       module_cpl->add_to_list(new_entry);
 930       {
 931         MutexLocker ml(Module_lock, THREAD);
 932         _exploded_entries->push(module_cpl);
 933       }
 934       log_info(class, load)("path: %s", path);
 935     }
 936   }
 937   FREE_C_HEAP_ARRAY(char, path);
 938 }
 939 
 940 ClassPathEntry* ClassLoader::create_class_path_entry(const char *path, const struct stat* st,
 941                                                      bool throw_exception,
 942                                                      bool is_boot_append, TRAPS) {
 943   JavaThread* thread = JavaThread::current();
 944   ClassPathEntry* new_entry = NULL;
 945   if ((st->st_mode & S_IFMT) == S_IFREG) {
 946     ResourceMark rm(thread);
 947     // Regular file, should be a zip or jimage file
 948     // Canonicalized filename
 949     char* canonical_path = NEW_RESOURCE_ARRAY_IN_THREAD(thread, char, JVM_MAXPATHLEN);
 950     if (!get_canonical_path(path, canonical_path, JVM_MAXPATHLEN)) {
 951       // This matches the classic VM
 952       if (throw_exception) {
 953         THROW_MSG_(vmSymbols::java_io_IOException(), "Bad pathname", NULL);
 954       } else {
 955         return NULL;
 956       }
 957     }
 958     jint error;
 959     JImageFile* jimage =(*JImageOpen)(canonical_path, &error);
 960     if (jimage != NULL) {
 961       new_entry = new ClassPathImageEntry(jimage, canonical_path);
 962     } else {
 963       char* error_msg = NULL;
 964       jzfile* zip;
 965       {
 966         // enable call to C land
 967         ThreadToNativeFromVM ttn(thread);
 968         HandleMark hm(thread);
 969         zip = (*ZipOpen)(canonical_path, &error_msg);
 970       }
 971       if (zip != NULL && error_msg == NULL) {
 972         new_entry = new ClassPathZipEntry(zip, path, is_boot_append);
 973       } else {
 974         char *msg;
 975         if (error_msg == NULL) {
 976           msg = NEW_RESOURCE_ARRAY_IN_THREAD(thread, char, strlen(path) + 128); ;
 977           jio_snprintf(msg, strlen(path) + 127, "error in opening JAR file %s", path);
 978         } else {
 979           int len = (int)(strlen(path) + strlen(error_msg) + 128);
 980           msg = NEW_RESOURCE_ARRAY_IN_THREAD(thread, char, len); ;
 981           jio_snprintf(msg, len - 1, "error in opening JAR file <%s> %s", error_msg, path);
 982         }
 983         // Don't complain about bad jar files added via -Xbootclasspath/a:.
 984         if (throw_exception && is_init_completed()) {
 985           THROW_MSG_(vmSymbols::java_lang_ClassNotFoundException(), msg, NULL);
 986         } else {
 987           return NULL;
 988         }
 989       }
 990     }
 991     log_info(class, path)("opened: %s", path);
 992     log_info(class, load)("opened: %s", path);
 993   } else {
 994     // Directory
 995     new_entry = new ClassPathDirEntry(path);
 996     log_info(class, load)("path: %s", path);
 997   }
 998   return new_entry;
 999 }
1000 
1001 
1002 // Create a class path zip entry for a given path (return NULL if not found
1003 // or zip/JAR file cannot be opened)
1004 ClassPathZipEntry* ClassLoader::create_class_path_zip_entry(const char *path, bool is_boot_append) {
1005   // check for a regular file
1006   struct stat st;
1007   if (os::stat(path, &st) == 0) {
1008     if ((st.st_mode & S_IFMT) == S_IFREG) {
1009       char canonical_path[JVM_MAXPATHLEN];
1010       if (get_canonical_path(path, canonical_path, JVM_MAXPATHLEN)) {
1011         char* error_msg = NULL;
1012         jzfile* zip;
1013         {
1014           // enable call to C land
1015           JavaThread* thread = JavaThread::current();
1016           ThreadToNativeFromVM ttn(thread);
1017           HandleMark hm(thread);
1018           zip = (*ZipOpen)(canonical_path, &error_msg);
1019         }
1020         if (zip != NULL && error_msg == NULL) {
1021           // create using canonical path
1022           return new ClassPathZipEntry(zip, canonical_path, is_boot_append);
1023         }
1024       }
1025     }
1026   }
1027   return NULL;
1028 }
1029 
1030 // returns true if entry already on class path
1031 bool ClassLoader::contains_append_entry(const char* name) {
1032   ClassPathEntry* e = _first_append_entry;
1033   while (e != NULL) {
1034     // assume zip entries have been canonicalized
1035     if (strcmp(name, e->name()) == 0) {
1036       return true;
1037     }
1038     e = e->next();
1039   }
1040   return false;
1041 }
1042 
1043 void ClassLoader::add_to_boot_append_entries(ClassPathEntry *new_entry) {
1044   if (new_entry != NULL) {
1045     if (_last_append_entry == NULL) {
1046       assert(_first_append_entry == NULL, "boot loader's append class path entry list not empty");
1047       _first_append_entry = _last_append_entry = new_entry;
1048     } else {
1049       _last_append_entry->set_next(new_entry);
1050       _last_append_entry = new_entry;
1051     }
1052   }
1053 }
1054 
1055 // Record the path entries specified in -cp during dump time. The recorded
1056 // information will be used at runtime for loading the archived app classes.
1057 //
1058 // Note that at dump time, ClassLoader::_app_classpath_entries are NOT used for
1059 // loading app classes. Instead, the app class are loaded by the
1060 // jdk/internal/loader/ClassLoaders$AppClassLoader instance.
1061 void ClassLoader::add_to_app_classpath_entries(const char* path,
1062                                                ClassPathEntry* entry,
1063                                                bool check_for_duplicates) {
1064 #if INCLUDE_CDS
1065   assert(entry != NULL, "ClassPathEntry should not be NULL");
1066   ClassPathEntry* e = _app_classpath_entries;
1067   if (check_for_duplicates) {
1068     while (e != NULL) {
1069       if (strcmp(e->name(), entry->name()) == 0) {
1070         // entry already exists
1071         return;
1072       }
1073       e = e->next();
1074     }
1075   }
1076 
1077   // The entry does not exist, add to the list
1078   if (_app_classpath_entries == NULL) {
1079     assert(_last_app_classpath_entry == NULL, "Sanity");
1080     _app_classpath_entries = _last_app_classpath_entry = entry;
1081   } else {
1082     _last_app_classpath_entry->set_next(entry);
1083     _last_app_classpath_entry = entry;
1084   }
1085 
1086   if (entry->is_jar_file()) {
1087     ClassLoaderExt::process_jar_manifest(entry, check_for_duplicates);
1088   } else {
1089     if (!os::dir_is_empty(path)) {
1090       tty->print_cr("Error: non-empty directory '%s'", path);
1091       exit_with_path_failure("Cannot have non-empty directory in app classpaths", NULL);
1092     }
1093   }
1094 #endif
1095 }
1096 
1097 // Returns true IFF the file/dir exists and the entry was successfully created.
1098 bool ClassLoader::update_class_path_entry_list(const char *path,
1099                                                bool check_for_duplicates,
1100                                                bool is_boot_append,
1101                                                bool throw_exception) {
1102   struct stat st;
1103   if (os::stat(path, &st) == 0) {
1104     // File or directory found
1105     ClassPathEntry* new_entry = NULL;
1106     Thread* THREAD = Thread::current();
1107     new_entry = create_class_path_entry(path, &st, throw_exception, is_boot_append, CHECK_(false));
1108     if (new_entry == NULL) {
1109       return false;
1110     }
1111 
1112     // Do not reorder the bootclasspath which would break get_system_package().
1113     // Add new entry to linked list
1114     if (is_boot_append) {
1115       add_to_boot_append_entries(new_entry);
1116     } else {
1117       add_to_app_classpath_entries(path, new_entry, check_for_duplicates);
1118     }
1119     return true;
1120   } else {
1121 #if INCLUDE_CDS
1122     if (DumpSharedSpaces) {
1123       _shared_paths_misc_info->add_nonexist_path(path);
1124     }
1125 #endif
1126     return false;
1127   }
1128 }
1129 
1130 static void print_module_entry_table(const GrowableArray<ModuleClassPathList*>* const module_list) {
1131   ResourceMark rm;
1132   int num_of_entries = module_list->length();
1133   for (int i = 0; i < num_of_entries; i++) {
1134     ClassPathEntry* e;
1135     ModuleClassPathList* mpl = module_list->at(i);
1136     tty->print("%s=", mpl->module_name()->as_C_string());
1137     e = mpl->module_first_entry();
1138     while (e != NULL) {
1139       tty->print("%s", e->name());
1140       e = e->next();
1141       if (e != NULL) {
1142         tty->print("%s", os::path_separator());
1143       }
1144     }
1145     tty->print(" ;");
1146   }
1147 }
1148 
1149 void ClassLoader::print_bootclasspath() {
1150   ClassPathEntry* e;
1151   tty->print("[bootclasspath= ");
1152 
1153   // Print --patch-module module/path specifications first
1154   if (_patch_mod_entries != NULL) {
1155     print_module_entry_table(_patch_mod_entries);
1156   }
1157 
1158   // [jimage | exploded modules build]
1159   if (has_jrt_entry()) {
1160     // Print the location of the java runtime image
1161     tty->print("%s ;", _jrt_entry->name());
1162   } else {
1163     // Print exploded module build path specifications
1164     if (_exploded_entries != NULL) {
1165       print_module_entry_table(_exploded_entries);
1166     }
1167   }
1168 
1169   // appended entries
1170   e = _first_append_entry;
1171   while (e != NULL) {
1172     tty->print("%s ;", e->name());
1173     e = e->next();
1174   }
1175   tty->print_cr("]");
1176 }
1177 
1178 void ClassLoader::load_zip_library() {
1179   assert(ZipOpen == NULL, "should not load zip library twice");
1180   // First make sure native library is loaded
1181   os::native_java_library();
1182   // Load zip library
1183   char path[JVM_MAXPATHLEN];
1184   char ebuf[1024];
1185   void* handle = NULL;
1186   if (os::dll_locate_lib(path, sizeof(path), Arguments::get_dll_dir(), "zip")) {
1187     handle = os::dll_load(path, ebuf, sizeof ebuf);
1188   }
1189   if (handle == NULL) {
1190     vm_exit_during_initialization("Unable to load ZIP library", path);
1191   }
1192   // Lookup zip entry points
1193   ZipOpen      = CAST_TO_FN_PTR(ZipOpen_t, os::dll_lookup(handle, "ZIP_Open"));
1194   ZipClose     = CAST_TO_FN_PTR(ZipClose_t, os::dll_lookup(handle, "ZIP_Close"));
1195   FindEntry    = CAST_TO_FN_PTR(FindEntry_t, os::dll_lookup(handle, "ZIP_FindEntry"));
1196   ReadEntry    = CAST_TO_FN_PTR(ReadEntry_t, os::dll_lookup(handle, "ZIP_ReadEntry"));
1197   GetNextEntry = CAST_TO_FN_PTR(GetNextEntry_t, os::dll_lookup(handle, "ZIP_GetNextEntry"));
1198   ZipInflateFully = CAST_TO_FN_PTR(ZipInflateFully_t, os::dll_lookup(handle, "ZIP_InflateFully"));
1199   Crc32        = CAST_TO_FN_PTR(Crc32_t, os::dll_lookup(handle, "ZIP_CRC32"));
1200 
1201   // ZIP_Close is not exported on Windows in JDK5.0 so don't abort if ZIP_Close is NULL
1202   if (ZipOpen == NULL || FindEntry == NULL || ReadEntry == NULL ||
1203       GetNextEntry == NULL || Crc32 == NULL) {
1204     vm_exit_during_initialization("Corrupted ZIP library", path);
1205   }
1206 
1207   if (ZipInflateFully == NULL) {
1208     vm_exit_during_initialization("Corrupted ZIP library ZIP_InflateFully missing", path);
1209   }
1210 
1211   // Lookup canonicalize entry in libjava.dll
1212   void *javalib_handle = os::native_java_library();
1213   CanonicalizeEntry = CAST_TO_FN_PTR(canonicalize_fn_t, os::dll_lookup(javalib_handle, "Canonicalize"));
1214   // This lookup only works on 1.3. Do not check for non-null here
1215 }
1216 
1217 void ClassLoader::load_jimage_library() {
1218   // First make sure native library is loaded
1219   os::native_java_library();
1220   // Load jimage library
1221   char path[JVM_MAXPATHLEN];
1222   char ebuf[1024];
1223   void* handle = NULL;
1224   if (os::dll_locate_lib(path, sizeof(path), Arguments::get_dll_dir(), "jimage")) {
1225     handle = os::dll_load(path, ebuf, sizeof ebuf);
1226   }
1227   if (handle == NULL) {
1228     vm_exit_during_initialization("Unable to load jimage library", path);
1229   }
1230 
1231   // Lookup jimage entry points
1232   JImageOpen = CAST_TO_FN_PTR(JImageOpen_t, os::dll_lookup(handle, "JIMAGE_Open"));
1233   guarantee(JImageOpen != NULL, "function JIMAGE_Open not found");
1234   JImageClose = CAST_TO_FN_PTR(JImageClose_t, os::dll_lookup(handle, "JIMAGE_Close"));
1235   guarantee(JImageClose != NULL, "function JIMAGE_Close not found");
1236   JImagePackageToModule = CAST_TO_FN_PTR(JImagePackageToModule_t, os::dll_lookup(handle, "JIMAGE_PackageToModule"));
1237   guarantee(JImagePackageToModule != NULL, "function JIMAGE_PackageToModule not found");
1238   JImageFindResource = CAST_TO_FN_PTR(JImageFindResource_t, os::dll_lookup(handle, "JIMAGE_FindResource"));
1239   guarantee(JImageFindResource != NULL, "function JIMAGE_FindResource not found");
1240   JImageGetResource = CAST_TO_FN_PTR(JImageGetResource_t, os::dll_lookup(handle, "JIMAGE_GetResource"));
1241   guarantee(JImageGetResource != NULL, "function JIMAGE_GetResource not found");
1242   JImageResourceIterator = CAST_TO_FN_PTR(JImageResourceIterator_t, os::dll_lookup(handle, "JIMAGE_ResourceIterator"));
1243   guarantee(JImageResourceIterator != NULL, "function JIMAGE_ResourceIterator not found");
1244   JImageResourcePath = CAST_TO_FN_PTR(JImage_ResourcePath_t, os::dll_lookup(handle, "JIMAGE_ResourcePath"));
1245   guarantee(JImageResourcePath != NULL, "function JIMAGE_ResourcePath not found");
1246 }
1247 
1248 jboolean ClassLoader::decompress(void *in, u8 inSize, void *out, u8 outSize, char **pmsg) {
1249   return (*ZipInflateFully)(in, inSize, out, outSize, pmsg);
1250 }
1251 
1252 int ClassLoader::crc32(int crc, const char* buf, int len) {
1253   assert(Crc32 != NULL, "ZIP_CRC32 is not found");
1254   return (*Crc32)(crc, (const jbyte*)buf, len);
1255 }
1256 
1257 // Function add_package extracts the package from the fully qualified class name
1258 // and checks if the package is in the boot loader's package entry table.  If so,
1259 // then it sets the classpath_index in the package entry record.
1260 //
1261 // The classpath_index field is used to find the entry on the boot loader class
1262 // path for packages with classes loaded by the boot loader from -Xbootclasspath/a
1263 // in an unnamed module.  It is also used to indicate (for all packages whose
1264 // classes are loaded by the boot loader) that at least one of the package's
1265 // classes has been loaded.
1266 bool ClassLoader::add_package(const char *fullq_class_name, s2 classpath_index, TRAPS) {
1267   assert(fullq_class_name != NULL, "just checking");
1268 
1269   // Get package name from fully qualified class name.
1270   ResourceMark rm;
1271   const char *cp = package_from_name(fullq_class_name);
1272   if (cp != NULL) {
1273     PackageEntryTable* pkg_entry_tbl = ClassLoaderData::the_null_class_loader_data()->packages();
1274     TempNewSymbol pkg_symbol = SymbolTable::new_symbol(cp, CHECK_false);
1275     PackageEntry* pkg_entry = pkg_entry_tbl->lookup_only(pkg_symbol);
1276     if (pkg_entry != NULL) {
1277       assert(classpath_index != -1, "Unexpected classpath_index");
1278       pkg_entry->set_classpath_index(classpath_index);
1279     } else {
1280       return false;
1281     }
1282   }
1283   return true;
1284 }
1285 
1286 oop ClassLoader::get_system_package(const char* name, TRAPS) {
1287   // Look up the name in the boot loader's package entry table.
1288   if (name != NULL) {
1289     TempNewSymbol package_sym = SymbolTable::new_symbol(name, (int)strlen(name), CHECK_NULL);
1290     // Look for the package entry in the boot loader's package entry table.
1291     PackageEntry* package =
1292       ClassLoaderData::the_null_class_loader_data()->packages()->lookup_only(package_sym);
1293 
1294     // Return NULL if package does not exist or if no classes in that package
1295     // have been loaded.
1296     if (package != NULL && package->has_loaded_class()) {
1297       ModuleEntry* module = package->module();
1298       if (module->location() != NULL) {
1299         ResourceMark rm(THREAD);
1300         Handle ml = java_lang_String::create_from_str(
1301           module->location()->as_C_string(), THREAD);
1302         return ml();
1303       }
1304       // Return entry on boot loader class path.
1305       Handle cph = java_lang_String::create_from_str(
1306         ClassLoader::classpath_entry(package->classpath_index())->name(), THREAD);
1307       return cph();
1308     }
1309   }
1310   return NULL;
1311 }
1312 
1313 objArrayOop ClassLoader::get_system_packages(TRAPS) {
1314   ResourceMark rm(THREAD);
1315   // List of pointers to PackageEntrys that have loaded classes.
1316   GrowableArray<PackageEntry*>* loaded_class_pkgs = new GrowableArray<PackageEntry*>(50);
1317   {
1318     MutexLocker ml(Module_lock, THREAD);
1319 
1320     PackageEntryTable* pe_table =
1321       ClassLoaderData::the_null_class_loader_data()->packages();
1322 
1323     // Collect the packages that have at least one loaded class.
1324     for (int x = 0; x < pe_table->table_size(); x++) {
1325       for (PackageEntry* package_entry = pe_table->bucket(x);
1326            package_entry != NULL;
1327            package_entry = package_entry->next()) {
1328         if (package_entry->has_loaded_class()) {
1329           loaded_class_pkgs->append(package_entry);
1330         }
1331       }
1332     }
1333   }
1334 
1335 
1336   // Allocate objArray and fill with java.lang.String
1337   objArrayOop r = oopFactory::new_objArray(SystemDictionary::String_klass(),
1338                                            loaded_class_pkgs->length(), CHECK_NULL);
1339   objArrayHandle result(THREAD, r);
1340   for (int x = 0; x < loaded_class_pkgs->length(); x++) {
1341     PackageEntry* package_entry = loaded_class_pkgs->at(x);
1342     Handle str = java_lang_String::create_from_symbol(package_entry->name(), CHECK_NULL);
1343     result->obj_at_put(x, str());
1344   }
1345   return result();
1346 }
1347 
1348 // caller needs ResourceMark
1349 const char* ClassLoader::file_name_for_class_name(const char* class_name,
1350                                                   int class_name_len) {
1351   assert(class_name != NULL, "invariant");
1352   assert((int)strlen(class_name) == class_name_len, "invariant");
1353 
1354   static const char class_suffix[] = ".class";
1355 
1356   char* const file_name = NEW_RESOURCE_ARRAY(char,
1357                                              class_name_len +
1358                                              sizeof(class_suffix)); // includes term NULL
1359 
1360   strncpy(file_name, class_name, class_name_len);
1361   strncpy(&file_name[class_name_len], class_suffix, sizeof(class_suffix));
1362 
1363   return file_name;
1364 }
1365 
1366 ClassPathEntry* find_first_module_cpe(ModuleEntry* mod_entry,
1367                                       const GrowableArray<ModuleClassPathList*>* const module_list) {
1368   int num_of_entries = module_list->length();
1369   const Symbol* class_module_name = mod_entry->name();
1370 
1371   // Loop through all the modules in either the patch-module or exploded entries looking for module
1372   for (int i = 0; i < num_of_entries; i++) {
1373     ModuleClassPathList* module_cpl = module_list->at(i);
1374     Symbol* module_cpl_name = module_cpl->module_name();
1375 
1376     if (module_cpl_name->fast_compare(class_module_name) == 0) {
1377       // Class' module has been located.
1378       return module_cpl->module_first_entry();
1379     }
1380   }
1381   return NULL;
1382 }
1383 
1384 
1385 // Search either the patch-module or exploded build entries for class.
1386 ClassFileStream* ClassLoader::search_module_entries(const GrowableArray<ModuleClassPathList*>* const module_list,
1387                                                     const char* const class_name,
1388                                                     const char* const file_name,
1389                                                     TRAPS) {
1390   ClassFileStream* stream = NULL;
1391 
1392   // Find the class' defining module in the boot loader's module entry table
1393   PackageEntry* pkg_entry = get_package_entry(class_name, ClassLoaderData::the_null_class_loader_data(), CHECK_NULL);
1394   ModuleEntry* mod_entry = (pkg_entry != NULL) ? pkg_entry->module() : NULL;
1395 
1396   // If the module system has not defined java.base yet, then
1397   // classes loaded are assumed to be defined to java.base.
1398   // When java.base is eventually defined by the module system,
1399   // all packages of classes that have been previously loaded
1400   // are verified in ModuleEntryTable::verify_javabase_packages().
1401   if (!Universe::is_module_initialized() &&
1402       !ModuleEntryTable::javabase_defined() &&
1403       mod_entry == NULL) {
1404     mod_entry = ModuleEntryTable::javabase_moduleEntry();
1405   }
1406 
1407   // The module must be a named module
1408   ClassPathEntry* e = NULL;
1409   if (mod_entry != NULL && mod_entry->is_named()) {
1410     if (module_list == _exploded_entries) {
1411       // The exploded build entries can be added to at any time so a lock is
1412       // needed when searching them.
1413       assert(!ClassLoader::has_jrt_entry(), "Must be exploded build");
1414       MutexLocker ml(Module_lock, THREAD);
1415       e = find_first_module_cpe(mod_entry, module_list);
1416     } else {
1417       e = find_first_module_cpe(mod_entry, module_list);
1418     }
1419   }
1420 
1421   // Try to load the class from the module's ClassPathEntry list.
1422   while (e != NULL) {
1423     stream = e->open_stream(file_name, CHECK_NULL);
1424     // No context.check is required since CDS is not supported
1425     // for an exploded modules build or if --patch-module is specified.
1426     if (NULL != stream) {
1427       return stream;
1428     }
1429     e = e->next();
1430   }
1431   // If the module was located, break out even if the class was not
1432   // located successfully from that module's ClassPathEntry list.
1433   // There will not be another valid entry for that module.
1434   return NULL;
1435 }
1436 
1437 // Called by the boot classloader to load classes
1438 InstanceKlass* ClassLoader::load_class(Symbol* name, bool search_append_only, TRAPS) {
1439   assert(name != NULL, "invariant");
1440   assert(THREAD->is_Java_thread(), "must be a JavaThread");
1441 
1442   ResourceMark rm(THREAD);
1443   HandleMark hm(THREAD);
1444 
1445   const char* const class_name = name->as_C_string();
1446 
1447   EventMark m("loading class %s", class_name);
1448 
1449   const char* const file_name = file_name_for_class_name(class_name,
1450                                                          name->utf8_length());
1451   assert(file_name != NULL, "invariant");
1452 
1453   ClassLoaderExt::Context context(class_name, file_name, THREAD);
1454 
1455   // Lookup stream for parsing .class file
1456   ClassFileStream* stream = NULL;
1457   s2 classpath_index = 0;
1458   ClassPathEntry* e = NULL;
1459 
1460   // If DumpSharedSpaces is true boot loader visibility boundaries are set to:
1461   //   - [jimage] + [_first_append_entry to _last_append_entry] (all path entries).
1462   //
1463   // If search_append_only is true, boot loader visibility boundaries are
1464   // set to be _first_append_entry to the end. This includes:
1465   //   [-Xbootclasspath/a]; [jvmti appended entries]
1466   //
1467   // If both DumpSharedSpaces and search_append_only are false, boot loader
1468   // visibility boundaries are set to be the --patch-module entries plus the base piece.
1469   // This would include:
1470   //   [--patch-module=<module>=<file>(<pathsep><file>)*]; [jimage | exploded module build]
1471   //
1472 
1473   // Load Attempt #1: --patch-module
1474   // Determine the class' defining module.  If it appears in the _patch_mod_entries,
1475   // attempt to load the class from those locations specific to the module.
1476   // Specifications to --patch-module can contain a partial number of classes
1477   // that are part of the overall module definition.  So if a particular class is not
1478   // found within its module specification, the search should continue to Load Attempt #2.
1479   // Note: The --patch-module entries are never searched if the boot loader's
1480   //       visibility boundary is limited to only searching the append entries.
1481   if (_patch_mod_entries != NULL && !search_append_only) {
1482     // At CDS dump time, the --patch-module entries are ignored. That means a
1483     // class is still loaded from the runtime image even if it might
1484     // appear in the _patch_mod_entries. The runtime shared class visibility
1485     // check will determine if a shared class is visible based on the runtime
1486     // environemnt, including the runtime --patch-module setting.
1487     if (!DumpSharedSpaces) {
1488       stream = search_module_entries(_patch_mod_entries, class_name, file_name, CHECK_NULL);
1489     }
1490   }
1491 
1492   // Load Attempt #2: [jimage | exploded build]
1493   if (!search_append_only && (NULL == stream)) {
1494     if (has_jrt_entry()) {
1495       e = _jrt_entry;
1496       stream = _jrt_entry->open_stream(file_name, CHECK_NULL);
1497     } else {
1498       // Exploded build - attempt to locate class in its defining module's location.
1499       assert(_exploded_entries != NULL, "No exploded build entries present");
1500       stream = search_module_entries(_exploded_entries, class_name, file_name, CHECK_NULL);
1501     }
1502   }
1503 
1504   // Load Attempt #3: [-Xbootclasspath/a]; [jvmti appended entries]
1505   if ((search_append_only || DumpSharedSpaces) && (NULL == stream)) {
1506     // For the boot loader append path search, the starting classpath_index
1507     // for the appended piece is always 1 to account for either the
1508     // _jrt_entry or the _exploded_entries.
1509     assert(classpath_index == 0, "The classpath_index has been incremented incorrectly");
1510     classpath_index = 1;
1511 
1512     e = _first_append_entry;
1513     while (e != NULL) {
1514       stream = e->open_stream(file_name, CHECK_NULL);
1515       if (NULL != stream) {
1516         break;
1517       }
1518       e = e->next();
1519       ++classpath_index;
1520     }
1521   }
1522 
1523   if (NULL == stream) {
1524     return NULL;
1525   }
1526 
1527   stream->set_verify(context.should_verify(classpath_index));
1528 
1529   ClassLoaderData* loader_data = ClassLoaderData::the_null_class_loader_data();
1530   Handle protection_domain;
1531 
1532   InstanceKlass* result = KlassFactory::create_from_stream(stream,
1533                                                            name,
1534                                                            loader_data,
1535                                                            protection_domain,
1536                                                            NULL, // host_klass
1537                                                            NULL, // cp_patches
1538                                                            THREAD);
1539   if (HAS_PENDING_EXCEPTION) {
1540     if (DumpSharedSpaces) {
1541       tty->print_cr("Preload Error: Failed to load %s", class_name);
1542     }
1543     return NULL;
1544   }
1545 
1546   if (!add_package(file_name, classpath_index, THREAD)) {
1547     return NULL;
1548   }
1549 
1550   return result;
1551 }
1552 
1553 #if INCLUDE_CDS
1554 char* ClassLoader::skip_uri_protocol(char* source) {
1555   if (strncmp(source, "file:", 5) == 0) {
1556     // file: protocol path could start with file:/ or file:///
1557     // locate the char after all the forward slashes
1558     int offset = 5;
1559     while (*(source + offset) == '/') {
1560         offset++;
1561     }
1562     source += offset;
1563   // for non-windows platforms, move back one char as the path begins with a '/'
1564 #ifndef _WINDOWS
1565     source -= 1;
1566 #endif
1567   } else if (strncmp(source, "jrt:/", 5) == 0) {
1568     source += 5;
1569   }
1570   return source;
1571 }
1572 
1573 // Record the shared classpath index and loader type for classes loaded
1574 // by the builtin loaders at dump time.
1575 void ClassLoader::record_result(InstanceKlass* ik, const ClassFileStream* stream, TRAPS) {
1576   assert(DumpSharedSpaces, "sanity");
1577   assert(stream != NULL, "sanity");
1578 
1579   if (ik->is_anonymous()) {
1580     // We do not archive anonymous classes.
1581     return;
1582   }
1583 
1584   oop loader = ik->class_loader();
1585   char* src = (char*)stream->source();
1586   if (src == NULL) {
1587     if (loader == NULL) {
1588       // JFR classes
1589       ik->set_shared_classpath_index(0);
1590       ik->set_class_loader_type(ClassLoader::BOOT_LOADER);
1591     }
1592     return;
1593   }
1594 
1595   assert(has_jrt_entry(), "CDS dumping does not support exploded JDK build");
1596 
1597   ResourceMark rm(THREAD);
1598   int classpath_index = -1;
1599   PackageEntry* pkg_entry = ik->package();
1600 
1601   if (FileMapInfo::get_number_of_shared_paths() > 0) {
1602     char* canonical_path = NEW_RESOURCE_ARRAY(char, JVM_MAXPATHLEN);
1603 
1604     // save the path from the file: protocol or the module name from the jrt: protocol
1605     // if no protocol prefix is found, path is the same as stream->source()
1606     char* path = skip_uri_protocol(src);
1607     for (int i = 0; i < FileMapInfo::get_number_of_shared_paths(); i++) {
1608       SharedClassPathEntry* ent = FileMapInfo::shared_path(i);
1609       if (get_canonical_path(ent->name(), canonical_path, JVM_MAXPATHLEN)) {
1610         // If the path (from the class stream source) is the same as the shared
1611         // class or module path, then we have a match.
1612         if (strcmp(canonical_path, os::native_path((char*)path)) == 0) {
1613           // NULL pkg_entry and pkg_entry in an unnamed module implies the class
1614           // is from the -cp or boot loader append path which consists of -Xbootclasspath/a
1615           // and jvmti appended entries.
1616           if ((pkg_entry == NULL) || (pkg_entry->in_unnamed_module())) {
1617             // Ensure the index is within the -cp range before assigning
1618             // to the classpath_index.
1619             if (SystemDictionary::is_system_class_loader(loader) &&
1620                 (i >= ClassLoaderExt::app_class_paths_start_index()) &&
1621                 (i < ClassLoaderExt::app_module_paths_start_index())) {
1622               classpath_index = i;
1623               break;
1624             } else {
1625               if ((i >= 1) &&
1626                   (i < ClassLoaderExt::app_class_paths_start_index())) {
1627                 // The class must be from boot loader append path which consists of
1628                 // -Xbootclasspath/a and jvmti appended entries.
1629                 assert(loader == NULL, "sanity");
1630                 classpath_index = i;
1631                 break;
1632               }
1633             }
1634           } else {
1635             // A class from a named module from the --module-path. Ensure the index is
1636             // within the --module-path range before assigning to the classpath_index.
1637             if ((pkg_entry != NULL) && !(pkg_entry->in_unnamed_module()) && (i > 0)) {
1638               if (i >= ClassLoaderExt::app_module_paths_start_index() &&
1639                   i < FileMapInfo::get_number_of_shared_paths()) {
1640                 classpath_index = i;
1641                 break;
1642               }
1643             }
1644           }
1645         }
1646         // for index 0 and the stream->source() is the modules image or has the jrt: protocol.
1647         // The class must be from the runtime modules image.
1648         if (i == 0 && (is_modules_image(src) || string_starts_with(src, "jrt:"))) {
1649           classpath_index = i;
1650           break;
1651         }
1652       }
1653     }
1654 
1655     // No path entry found for this class. Must be a shared class loaded by the
1656     // user defined classloader.
1657     if (classpath_index < 0) {
1658       assert(ik->shared_classpath_index() < 0, "Sanity");
1659       return;
1660     }
1661   } else {
1662     // The shared path table is set up after module system initialization.
1663     // The path table contains no entry before that. Any classes loaded prior
1664     // to the setup of the shared path table must be from the modules image.
1665     assert(is_modules_image(src), "stream must be from modules image");
1666     assert(FileMapInfo::get_number_of_shared_paths() == 0, "shared path table must not have been setup");
1667     classpath_index = 0;
1668   }
1669 
1670   const char* const class_name = ik->name()->as_C_string();
1671   const char* const file_name = file_name_for_class_name(class_name,
1672                                                          ik->name()->utf8_length());
1673   assert(file_name != NULL, "invariant");
1674 
1675   ClassLoaderExt::Context context(class_name, file_name, CATCH);
1676   context.record_result(ik->name(), classpath_index, ik, THREAD);
1677 }
1678 #endif // INCLUDE_CDS
1679 
1680 // Initialize the class loader's access to methods in libzip.  Parse and
1681 // process the boot classpath into a list ClassPathEntry objects.  Once
1682 // this list has been created, it must not change order (see class PackageInfo)
1683 // it can be appended to and is by jvmti and the kernel vm.
1684 
1685 void ClassLoader::initialize() {
1686   EXCEPTION_MARK;
1687 
1688   if (UsePerfData) {
1689     // jvmstat performance counters
1690     NEWPERFTICKCOUNTER(_perf_accumulated_time, SUN_CLS, "time");
1691     NEWPERFTICKCOUNTER(_perf_class_init_time, SUN_CLS, "classInitTime");
1692     NEWPERFTICKCOUNTER(_perf_class_init_selftime, SUN_CLS, "classInitTime.self");
1693     NEWPERFTICKCOUNTER(_perf_class_verify_time, SUN_CLS, "classVerifyTime");
1694     NEWPERFTICKCOUNTER(_perf_class_verify_selftime, SUN_CLS, "classVerifyTime.self");
1695     NEWPERFTICKCOUNTER(_perf_class_link_time, SUN_CLS, "classLinkedTime");
1696     NEWPERFTICKCOUNTER(_perf_class_link_selftime, SUN_CLS, "classLinkedTime.self");
1697     NEWPERFEVENTCOUNTER(_perf_classes_inited, SUN_CLS, "initializedClasses");
1698     NEWPERFEVENTCOUNTER(_perf_classes_linked, SUN_CLS, "linkedClasses");
1699     NEWPERFEVENTCOUNTER(_perf_classes_verified, SUN_CLS, "verifiedClasses");
1700 
1701     NEWPERFTICKCOUNTER(_perf_class_parse_time, SUN_CLS, "parseClassTime");
1702     NEWPERFTICKCOUNTER(_perf_class_parse_selftime, SUN_CLS, "parseClassTime.self");
1703     NEWPERFTICKCOUNTER(_perf_sys_class_lookup_time, SUN_CLS, "lookupSysClassTime");
1704     NEWPERFTICKCOUNTER(_perf_shared_classload_time, SUN_CLS, "sharedClassLoadTime");
1705     NEWPERFTICKCOUNTER(_perf_sys_classload_time, SUN_CLS, "sysClassLoadTime");
1706     NEWPERFTICKCOUNTER(_perf_app_classload_time, SUN_CLS, "appClassLoadTime");
1707     NEWPERFTICKCOUNTER(_perf_app_classload_selftime, SUN_CLS, "appClassLoadTime.self");
1708     NEWPERFEVENTCOUNTER(_perf_app_classload_count, SUN_CLS, "appClassLoadCount");
1709     NEWPERFTICKCOUNTER(_perf_define_appclasses, SUN_CLS, "defineAppClasses");
1710     NEWPERFTICKCOUNTER(_perf_define_appclass_time, SUN_CLS, "defineAppClassTime");
1711     NEWPERFTICKCOUNTER(_perf_define_appclass_selftime, SUN_CLS, "defineAppClassTime.self");
1712     NEWPERFBYTECOUNTER(_perf_app_classfile_bytes_read, SUN_CLS, "appClassBytes");
1713     NEWPERFBYTECOUNTER(_perf_sys_classfile_bytes_read, SUN_CLS, "sysClassBytes");
1714 
1715 
1716     // The following performance counters are added for measuring the impact
1717     // of the bug fix of 6365597. They are mainly focused on finding out
1718     // the behavior of system & user-defined classloader lock, whether
1719     // ClassLoader.loadClass/findClass is being called synchronized or not.
1720     NEWPERFEVENTCOUNTER(_sync_systemLoaderLockContentionRate, SUN_CLS,
1721                         "systemLoaderLockContentionRate");
1722     NEWPERFEVENTCOUNTER(_sync_nonSystemLoaderLockContentionRate, SUN_CLS,
1723                         "nonSystemLoaderLockContentionRate");
1724     NEWPERFEVENTCOUNTER(_sync_JVMFindLoadedClassLockFreeCounter, SUN_CLS,
1725                         "jvmFindLoadedClassNoLockCalls");
1726     NEWPERFEVENTCOUNTER(_sync_JVMDefineClassLockFreeCounter, SUN_CLS,
1727                         "jvmDefineClassNoLockCalls");
1728 
1729     NEWPERFEVENTCOUNTER(_sync_JNIDefineClassLockFreeCounter, SUN_CLS,
1730                         "jniDefineClassNoLockCalls");
1731 
1732     NEWPERFEVENTCOUNTER(_unsafe_defineClassCallCounter, SUN_CLS,
1733                         "unsafeDefineClassCalls");
1734 
1735     NEWPERFEVENTCOUNTER(_load_instance_class_failCounter, SUN_CLS,
1736                         "loadInstanceClassFailRate");
1737   }
1738 
1739   // lookup zip library entry points
1740   load_zip_library();
1741   // lookup jimage library entry points
1742   load_jimage_library();
1743 #if INCLUDE_CDS
1744   // initialize search path
1745   if (DumpSharedSpaces) {
1746     _shared_paths_misc_info = SharedClassUtil::allocate_shared_paths_misc_info();
1747   }
1748 #endif
1749   setup_bootstrap_search_path();
1750 }
1751 
1752 #if INCLUDE_CDS
1753 void ClassLoader::initialize_shared_path() {
1754   if (DumpSharedSpaces) {
1755     ClassLoaderExt::setup_search_paths();
1756     _shared_paths_misc_info->write_jint(0); // see comments in SharedPathsMiscInfo::check()
1757   }
1758 }
1759 
1760 void ClassLoader::initialize_module_path(TRAPS) {
1761   if (DumpSharedSpaces) {
1762     ClassLoaderExt::setup_module_paths(THREAD);
1763     FileMapInfo::allocate_shared_path_table();
1764   }
1765 }
1766 #endif
1767 
1768 jlong ClassLoader::classloader_time_ms() {
1769   return UsePerfData ?
1770     Management::ticks_to_ms(_perf_accumulated_time->get_value()) : -1;
1771 }
1772 
1773 jlong ClassLoader::class_init_count() {
1774   return UsePerfData ? _perf_classes_inited->get_value() : -1;
1775 }
1776 
1777 jlong ClassLoader::class_init_time_ms() {
1778   return UsePerfData ?
1779     Management::ticks_to_ms(_perf_class_init_time->get_value()) : -1;
1780 }
1781 
1782 jlong ClassLoader::class_verify_time_ms() {
1783   return UsePerfData ?
1784     Management::ticks_to_ms(_perf_class_verify_time->get_value()) : -1;
1785 }
1786 
1787 jlong ClassLoader::class_link_count() {
1788   return UsePerfData ? _perf_classes_linked->get_value() : -1;
1789 }
1790 
1791 jlong ClassLoader::class_link_time_ms() {
1792   return UsePerfData ?
1793     Management::ticks_to_ms(_perf_class_link_time->get_value()) : -1;
1794 }
1795 
1796 int ClassLoader::compute_Object_vtable() {
1797   // hardwired for JDK1.2 -- would need to duplicate class file parsing
1798   // code to determine actual value from file
1799   // Would be value '11' if finals were in vtable
1800   int JDK_1_2_Object_vtable_size = 5;
1801   return JDK_1_2_Object_vtable_size * vtableEntry::size();
1802 }
1803 
1804 
1805 void classLoader_init1() {
1806   ClassLoader::initialize();
1807 }
1808 
1809 // Complete the ClassPathEntry setup for the boot loader
1810 void ClassLoader::classLoader_init2(TRAPS) {
1811   // Setup the list of module/path pairs for --patch-module processing
1812   // This must be done after the SymbolTable is created in order
1813   // to use fast_compare on module names instead of a string compare.
1814   if (Arguments::get_patch_mod_prefix() != NULL) {
1815     setup_patch_mod_entries();
1816   }
1817 
1818   // Create the ModuleEntry for java.base (must occur after setup_patch_mod_entries
1819   // to successfully determine if java.base has been patched)
1820   create_javabase();
1821 
1822   // Setup the initial java.base/path pair for the exploded build entries.
1823   // As more modules are defined during module system initialization, more
1824   // entries will be added to the exploded build array.
1825   if (!has_jrt_entry()) {
1826     assert(!DumpSharedSpaces, "DumpSharedSpaces not supported with exploded module builds");
1827     assert(!UseSharedSpaces, "UsedSharedSpaces not supported with exploded module builds");
1828     // Set up the boot loader's _exploded_entries list.  Note that this gets
1829     // done before loading any classes, by the same thread that will
1830     // subsequently do the first class load. So, no lock is needed for this.
1831     assert(_exploded_entries == NULL, "Should only get initialized once");
1832     _exploded_entries = new (ResourceObj::C_HEAP, mtModule)
1833       GrowableArray<ModuleClassPathList*>(EXPLODED_ENTRY_SIZE, true);
1834     add_to_exploded_build_list(vmSymbols::java_base(), CHECK);
1835   }
1836 }
1837 
1838 
1839 bool ClassLoader::get_canonical_path(const char* orig, char* out, int len) {
1840   assert(orig != NULL && out != NULL && len > 0, "bad arguments");
1841   if (CanonicalizeEntry != NULL) {
1842     JavaThread* THREAD = JavaThread::current();
1843     JNIEnv* env = THREAD->jni_environment();
1844     ResourceMark rm(THREAD);
1845 
1846     // os::native_path writes into orig_copy
1847     char* orig_copy = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, strlen(orig)+1);
1848     strcpy(orig_copy, orig);
1849     if ((CanonicalizeEntry)(env, os::native_path(orig_copy), out, len) < 0) {
1850       return false;
1851     }
1852   } else {
1853     // On JDK 1.2.2 the Canonicalize does not exist, so just do nothing
1854     strncpy(out, orig, len);
1855     out[len - 1] = '\0';
1856   }
1857   return true;
1858 }
1859 
1860 void ClassLoader::create_javabase() {
1861   Thread* THREAD = Thread::current();
1862 
1863   // Create java.base's module entry for the boot
1864   // class loader prior to loading j.l.Ojbect.
1865   ClassLoaderData* null_cld = ClassLoaderData::the_null_class_loader_data();
1866 
1867   // Get module entry table
1868   ModuleEntryTable* null_cld_modules = null_cld->modules();
1869   if (null_cld_modules == NULL) {
1870     vm_exit_during_initialization("No ModuleEntryTable for the boot class loader");
1871   }
1872 
1873   {
1874     MutexLocker ml(Module_lock, THREAD);
1875     ModuleEntry* jb_module = null_cld_modules->locked_create_entry_or_null(Handle(),
1876                                false, vmSymbols::java_base(), NULL, NULL, null_cld);
1877     if (jb_module == NULL) {
1878       vm_exit_during_initialization("Unable to create ModuleEntry for " JAVA_BASE_NAME);
1879     }
1880     ModuleEntryTable::set_javabase_moduleEntry(jb_module);
1881   }
1882 }
1883 
1884 #ifndef PRODUCT
1885 
1886 // CompileTheWorld
1887 //
1888 // Iterates over all class path entries and forces compilation of all methods
1889 // in all classes found. Currently, only zip/jar archives are searched.
1890 //
1891 // The classes are loaded by the Java level bootstrap class loader, and the
1892 // initializer is called. If DelayCompilationDuringStartup is true (default),
1893 // the interpreter will run the initialization code. Note that forcing
1894 // initialization in this way could potentially lead to initialization order
1895 // problems, in which case we could just force the initialization bit to be set.
1896 
1897 
1898 // We need to iterate over the contents of a zip/jar file, so we replicate the
1899 // jzcell and jzfile definitions from zip_util.h but rename jzfile to real_jzfile,
1900 // since jzfile already has a void* definition.
1901 //
1902 // Note that this is only used in debug mode.
1903 //
1904 // HotSpot integration note:
1905 // Matches zip_util.h 1.14 99/06/01 from jdk1.3 beta H build
1906 
1907 
1908 // JDK 1.3 version
1909 typedef struct real_jzentry {         /* Zip file entry */
1910     char *name;                 /* entry name */
1911     jint time;                  /* modification time */
1912     jint size;                  /* size of uncompressed data */
1913     jint csize;                 /* size of compressed data (zero if uncompressed) */
1914     jint crc;                   /* crc of uncompressed data */
1915     char *comment;              /* optional zip file comment */
1916     jbyte *extra;               /* optional extra data */
1917     jint pos;                   /* position of LOC header (if negative) or data */
1918 } real_jzentry;
1919 
1920 typedef struct real_jzfile {  /* Zip file */
1921     char *name;                 /* zip file name */
1922     jint refs;                  /* number of active references */
1923     jint fd;                    /* open file descriptor */
1924     void *lock;                 /* read lock */
1925     char *comment;              /* zip file comment */
1926     char *msg;                  /* zip error message */
1927     void *entries;              /* array of hash cells */
1928     jint total;                 /* total number of entries */
1929     unsigned short *table;      /* Hash chain heads: indexes into entries */
1930     jint tablelen;              /* number of hash eads */
1931     real_jzfile *next;        /* next zip file in search list */
1932     jzentry *cache;             /* we cache the most recently freed jzentry */
1933     /* Information on metadata names in META-INF directory */
1934     char **metanames;           /* array of meta names (may have null names) */
1935     jint metacount;             /* number of slots in metanames array */
1936     /* If there are any per-entry comments, they are in the comments array */
1937     char **comments;
1938 } real_jzfile;
1939 
1940 void ClassPathDirEntry::compile_the_world(Handle loader, TRAPS) {
1941   // For now we only compile all methods in all classes in zip/jar files
1942   tty->print_cr("CompileTheWorld : Skipped classes in %s", _dir);
1943   tty->cr();
1944 }
1945 
1946 void ClassPathZipEntry::compile_the_world(Handle loader, TRAPS) {
1947   real_jzfile* zip = (real_jzfile*) _zip;
1948   tty->print_cr("CompileTheWorld : Compiling all classes in %s", zip->name);
1949   tty->cr();
1950   // Iterate over all entries in zip file
1951   for (int n = 0; ; n++) {
1952     real_jzentry * ze = (real_jzentry *)((*GetNextEntry)(_zip, n));
1953     if (ze == NULL) break;
1954     ClassLoader::compile_the_world_in(ze->name, loader, CHECK);
1955   }
1956   if (HAS_PENDING_EXCEPTION) {
1957     if (PENDING_EXCEPTION->is_a(SystemDictionary::OutOfMemoryError_klass())) {
1958       CLEAR_PENDING_EXCEPTION;
1959       tty->print_cr("\nCompileTheWorld : Ran out of memory\n");
1960       tty->print_cr("Increase class metadata storage if a limit was set");
1961     } else {
1962       tty->print_cr("\nCompileTheWorld : Unexpected exception occurred\n");
1963     }
1964   }
1965 }
1966 
1967 void ClassLoader::compile_the_world() {
1968   EXCEPTION_MARK;
1969   HandleMark hm(THREAD);
1970   ResourceMark rm(THREAD);
1971 
1972   assert(has_jrt_entry(), "Compile The World not supported with exploded module build");
1973 
1974   // Find bootstrap loader
1975   Handle system_class_loader (THREAD, SystemDictionary::java_system_loader());
1976   jlong start = os::javaTimeMillis();
1977 
1978   // Compile the world for the modular java runtime image
1979   _jrt_entry->compile_the_world(system_class_loader, CATCH);
1980 
1981   // Iterate over all bootstrap class path appended entries
1982   ClassPathEntry* e = _first_append_entry;
1983   while (e != NULL) {
1984     assert(!e->is_modules_image(), "A modular java runtime image is present on the list of appended entries");
1985     e->compile_the_world(system_class_loader, CATCH);
1986     e = e->next();
1987   }
1988   jlong end = os::javaTimeMillis();
1989   tty->print_cr("CompileTheWorld : Done (%d classes, %d methods, " JLONG_FORMAT " ms)",
1990                 _compile_the_world_class_counter, _compile_the_world_method_counter, (end - start));
1991   {
1992     // Print statistics as if before normal exit:
1993     extern void print_statistics();
1994     print_statistics();
1995   }
1996   vm_exit(0);
1997 }
1998 
1999 int ClassLoader::_compile_the_world_class_counter = 0;
2000 int ClassLoader::_compile_the_world_method_counter = 0;
2001 static int _codecache_sweep_counter = 0;
2002 
2003 // Filter out all exceptions except OOMs
2004 static void clear_pending_exception_if_not_oom(TRAPS) {
2005   if (HAS_PENDING_EXCEPTION &&
2006       !PENDING_EXCEPTION->is_a(SystemDictionary::OutOfMemoryError_klass())) {
2007     CLEAR_PENDING_EXCEPTION;
2008   }
2009   // The CHECK at the caller will propagate the exception out
2010 }
2011 
2012 /**
2013  * Returns if the given method should be compiled when doing compile-the-world.
2014  *
2015  * TODO:  This should be a private method in a CompileTheWorld class.
2016  */
2017 static bool can_be_compiled(const methodHandle& m, int comp_level) {
2018   assert(CompileTheWorld, "must be");
2019 
2020   // It's not valid to compile a native wrapper for MethodHandle methods
2021   // that take a MemberName appendix since the bytecode signature is not
2022   // correct.
2023   vmIntrinsics::ID iid = m->intrinsic_id();
2024   if (MethodHandles::is_signature_polymorphic(iid) && MethodHandles::has_member_arg(iid)) {
2025     return false;
2026   }
2027 
2028   return CompilationPolicy::can_be_compiled(m, comp_level);
2029 }
2030 
2031 void ClassLoader::compile_the_world_in(char* name, Handle loader, TRAPS) {
2032   if (string_ends_with(name, ".class")) {
2033     // We have a .class file
2034     int len = (int)strlen(name);
2035     char buffer[2048];
2036     strncpy(buffer, name, len - 6);
2037     buffer[len-6] = 0;
2038     // If the file has a period after removing .class, it's not really a
2039     // valid class file.  The class loader will check everything else.
2040     if (strchr(buffer, '.') == NULL) {
2041       _compile_the_world_class_counter++;
2042       if (_compile_the_world_class_counter > CompileTheWorldStopAt) return;
2043 
2044       // Construct name without extension
2045       TempNewSymbol sym = SymbolTable::new_symbol(buffer, CHECK);
2046       // Use loader to load and initialize class
2047       Klass* k = SystemDictionary::resolve_or_null(sym, loader, Handle(), THREAD);
2048       if (k != NULL && !HAS_PENDING_EXCEPTION) {
2049         k->initialize(THREAD);
2050       }
2051       bool exception_occurred = HAS_PENDING_EXCEPTION;
2052       clear_pending_exception_if_not_oom(CHECK);
2053       if (CompileTheWorldPreloadClasses && k != NULL) {
2054         InstanceKlass* ik = InstanceKlass::cast(k);
2055         ConstantPool::preload_and_initialize_all_classes(ik->constants(), THREAD);
2056         if (HAS_PENDING_EXCEPTION) {
2057           // If something went wrong in preloading we just ignore it
2058           clear_pending_exception_if_not_oom(CHECK);
2059           tty->print_cr("Preloading failed for (%d) %s", _compile_the_world_class_counter, buffer);
2060         }
2061       }
2062 
2063       if (_compile_the_world_class_counter >= CompileTheWorldStartAt) {
2064         if (k == NULL || exception_occurred) {
2065           // If something went wrong (e.g. ExceptionInInitializerError) we skip this class
2066           tty->print_cr("CompileTheWorld (%d) : Skipping %s", _compile_the_world_class_counter, buffer);
2067         } else {
2068           tty->print_cr("CompileTheWorld (%d) : %s", _compile_the_world_class_counter, buffer);
2069           // Preload all classes to get around uncommon traps
2070           // Iterate over all methods in class
2071           int comp_level = CompilationPolicy::policy()->initial_compile_level();
2072           InstanceKlass* ik = InstanceKlass::cast(k);
2073           for (int n = 0; n < ik->methods()->length(); n++) {
2074             methodHandle m (THREAD, ik->methods()->at(n));
2075             if (can_be_compiled(m, comp_level)) {
2076               if (++_codecache_sweep_counter == CompileTheWorldSafepointInterval) {
2077                 // Give sweeper a chance to keep up with CTW
2078                 VM_CTWThreshold op;
2079                 VMThread::execute(&op);
2080                 _codecache_sweep_counter = 0;
2081               }
2082               // Force compilation
2083               CompileBroker::compile_method(m, InvocationEntryBci, comp_level,
2084                                             methodHandle(), 0, CompileTask::Reason_CTW, THREAD);
2085               if (HAS_PENDING_EXCEPTION) {
2086                 clear_pending_exception_if_not_oom(CHECK);
2087                 tty->print_cr("CompileTheWorld (%d) : Skipping method: %s", _compile_the_world_class_counter, m->name_and_sig_as_C_string());
2088               } else {
2089                 _compile_the_world_method_counter++;
2090               }
2091               if (TieredCompilation && TieredStopAtLevel >= CompLevel_full_optimization) {
2092                 // Clobber the first compile and force second tier compilation
2093                 CompiledMethod* nm = m->code();
2094                 if (nm != NULL && !m->is_method_handle_intrinsic()) {
2095                   // Throw out the code so that the code cache doesn't fill up
2096                   nm->make_not_entrant();
2097                 }
2098                 CompileBroker::compile_method(m, InvocationEntryBci, CompLevel_full_optimization,
2099                                               methodHandle(), 0, CompileTask::Reason_CTW, THREAD);
2100                 if (HAS_PENDING_EXCEPTION) {
2101                   clear_pending_exception_if_not_oom(CHECK);
2102                   tty->print_cr("CompileTheWorld (%d) : Skipping method: %s", _compile_the_world_class_counter, m->name_and_sig_as_C_string());
2103                 } else {
2104                   _compile_the_world_method_counter++;
2105                 }
2106               }
2107             } else {
2108               tty->print_cr("CompileTheWorld (%d) : Skipping method: %s", _compile_the_world_class_counter, m->name_and_sig_as_C_string());
2109             }
2110 
2111             CompiledMethod* nm = m->code();
2112             if (nm != NULL && !m->is_method_handle_intrinsic()) {
2113               // Throw out the code so that the code cache doesn't fill up
2114               nm->make_not_entrant();
2115             }
2116           }
2117         }
2118       }
2119     }
2120   }
2121 }
2122 
2123 #endif //PRODUCT
2124 
2125 // Please keep following two functions at end of this file. With them placed at top or in middle of the file,
2126 // they could get inlined by agressive compiler, an unknown trick, see bug 6966589.
2127 void PerfClassTraceTime::initialize() {
2128   if (!UsePerfData) return;
2129 
2130   if (_eventp != NULL) {
2131     // increment the event counter
2132     _eventp->inc();
2133   }
2134 
2135   // stop the current active thread-local timer to measure inclusive time
2136   _prev_active_event = -1;
2137   for (int i=0; i < EVENT_TYPE_COUNT; i++) {
2138      if (_timers[i].is_active()) {
2139        assert(_prev_active_event == -1, "should have only one active timer");
2140        _prev_active_event = i;
2141        _timers[i].stop();
2142      }
2143   }
2144 
2145   if (_recursion_counters == NULL || (_recursion_counters[_event_type])++ == 0) {
2146     // start the inclusive timer if not recursively called
2147     _t.start();
2148   }
2149 
2150   // start thread-local timer of the given event type
2151    if (!_timers[_event_type].is_active()) {
2152     _timers[_event_type].start();
2153   }
2154 }
2155 
2156 PerfClassTraceTime::~PerfClassTraceTime() {
2157   if (!UsePerfData) return;
2158 
2159   // stop the thread-local timer as the event completes
2160   // and resume the thread-local timer of the event next on the stack
2161   _timers[_event_type].stop();
2162   jlong selftime = _timers[_event_type].ticks();
2163 
2164   if (_prev_active_event >= 0) {
2165     _timers[_prev_active_event].start();
2166   }
2167 
2168   if (_recursion_counters != NULL && --(_recursion_counters[_event_type]) > 0) return;
2169 
2170   // increment the counters only on the leaf call
2171   _t.stop();
2172   _timep->inc(_t.ticks());
2173   if (_selftimep != NULL) {
2174     _selftimep->inc(selftime);
2175   }
2176   // add all class loading related event selftime to the accumulated time counter
2177   ClassLoader::perf_accumulated_time()->inc(selftime);
2178 
2179   // reset the timer
2180   _timers[_event_type].reset();
2181 }