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