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