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