1 /*
2 * Copyright (c) 1997, 2025, 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 "cds/aotClassLocation.hpp"
26 #include "cds/cds_globals.hpp"
27 #include "cds/cdsConfig.hpp"
28 #include "cds/heapShared.hpp"
29 #include "classfile/classFileStream.hpp"
30 #include "classfile/classLoader.inline.hpp"
31 #include "classfile/classLoaderData.inline.hpp"
32 #include "classfile/classLoaderExt.hpp"
33 #include "classfile/classLoadInfo.hpp"
34 #include "classfile/javaClasses.hpp"
35 #include "classfile/klassFactory.hpp"
36 #include "classfile/moduleEntry.hpp"
37 #include "classfile/modules.hpp"
38 #include "classfile/packageEntry.hpp"
39 #include "classfile/symbolTable.hpp"
40 #include "classfile/systemDictionary.hpp"
41 #include "classfile/systemDictionaryShared.hpp"
42 #include "classfile/vmClasses.hpp"
43 #include "classfile/vmSymbols.hpp"
44 #include "compiler/compileBroker.hpp"
45 #include "interpreter/bytecodeStream.hpp"
46 #include "interpreter/oopMapCache.hpp"
47 #include "jimage.hpp"
48 #include "jvm.h"
49 #include "logging/log.hpp"
50 #include "logging/logStream.hpp"
51 #include "logging/logTag.hpp"
52 #include "memory/allocation.inline.hpp"
53 #include "memory/oopFactory.hpp"
54 #include "memory/resourceArea.hpp"
55 #include "memory/universe.hpp"
56 #include "oops/instanceKlass.hpp"
57 #include "oops/instanceRefKlass.hpp"
58 #include "oops/klass.inline.hpp"
59 #include "oops/method.inline.hpp"
60 #include "oops/objArrayOop.inline.hpp"
61 #include "oops/oop.inline.hpp"
62 #include "oops/symbol.hpp"
63 #include "prims/jvm_misc.hpp"
64 #include "runtime/arguments.hpp"
65 #include "runtime/handles.inline.hpp"
66 #include "runtime/init.hpp"
67 #include "runtime/interfaceSupport.inline.hpp"
68 #include "runtime/java.hpp"
69 #include "runtime/javaCalls.hpp"
70 #include "runtime/os.hpp"
71 #include "runtime/perfData.hpp"
72 #include "runtime/threadCritical.hpp"
73 #include "runtime/timer.hpp"
74 #include "runtime/vm_version.hpp"
75 #include "services/management.hpp"
76 #include "services/threadService.hpp"
77 #include "utilities/checkedCast.hpp"
78 #include "utilities/classpathStream.hpp"
79 #include "utilities/events.hpp"
80 #include "utilities/macros.hpp"
81 #include "utilities/ostream.hpp"
82 #include "utilities/utf8.hpp"
83
84 #include <stdlib.h>
85 #include <ctype.h>
86
87 // Entry point in java.dll for path canonicalization
88
89 typedef int (*canonicalize_fn_t)(const char *orig, char *out, int len);
90
91 static canonicalize_fn_t CanonicalizeEntry = nullptr;
92
93 // Entry points for jimage.dll for loading jimage file entries
94
95 static JImageOpen_t JImageOpen = nullptr;
96 static JImageClose_t JImageClose = nullptr;
97 static JImageFindResource_t JImageFindResource = nullptr;
98 static JImageGetResource_t JImageGetResource = nullptr;
99
100 // JimageFile pointer, or null if exploded JDK build.
101 static JImageFile* JImage_file = nullptr;
102
103 // Globals
104
105 PerfCounter* ClassLoader::_perf_accumulated_time = nullptr;
106 PerfCounter* ClassLoader::_perf_classes_inited = nullptr;
107 PerfCounter* ClassLoader::_perf_class_init_time = nullptr;
108 PerfCounter* ClassLoader::_perf_class_init_selftime = nullptr;
109 PerfCounter* ClassLoader::_perf_classes_verified = nullptr;
110 PerfCounter* ClassLoader::_perf_class_verify_time = nullptr;
111 PerfCounter* ClassLoader::_perf_class_verify_selftime = nullptr;
112 PerfCounter* ClassLoader::_perf_classes_linked = nullptr;
113 PerfCounter* ClassLoader::_perf_class_link_time = nullptr;
114 PerfCounter* ClassLoader::_perf_class_link_selftime = nullptr;
115 PerfCounter* ClassLoader::_perf_shared_classload_time = nullptr;
116 PerfCounter* ClassLoader::_perf_sys_classload_time = nullptr;
117 PerfCounter* ClassLoader::_perf_app_classload_time = nullptr;
118 PerfCounter* ClassLoader::_perf_app_classload_selftime = nullptr;
119 PerfCounter* ClassLoader::_perf_app_classload_count = nullptr;
120 PerfCounter* ClassLoader::_perf_define_appclasses = nullptr;
121 PerfCounter* ClassLoader::_perf_define_appclass_time = nullptr;
122 PerfCounter* ClassLoader::_perf_define_appclass_selftime = nullptr;
123 PerfCounter* ClassLoader::_perf_app_classfile_bytes_read = nullptr;
124 PerfCounter* ClassLoader::_perf_sys_classfile_bytes_read = nullptr;
125 PerfCounter* ClassLoader::_perf_ik_link_methods_time = nullptr;
126 PerfCounter* ClassLoader::_perf_method_adapters_time = nullptr;
127 PerfCounter* ClassLoader::_perf_ik_link_methods_count = nullptr;
128 PerfCounter* ClassLoader::_perf_method_adapters_count = nullptr;
129 PerfCounter* ClassLoader::_unsafe_defineClassCallCounter = nullptr;
130 PerfCounter* ClassLoader::_perf_secondary_hash_time = nullptr;
131
132 PerfCounter* ClassLoader::_perf_resolve_indy_time = nullptr;
133 PerfCounter* ClassLoader::_perf_resolve_invokehandle_time = nullptr;
134 PerfCounter* ClassLoader::_perf_resolve_mh_time = nullptr;
135 PerfCounter* ClassLoader::_perf_resolve_mt_time = nullptr;
136
137 PerfCounter* ClassLoader::_perf_resolve_indy_count = nullptr;
138 PerfCounter* ClassLoader::_perf_resolve_invokehandle_count = nullptr;
139 PerfCounter* ClassLoader::_perf_resolve_mh_count = nullptr;
140 PerfCounter* ClassLoader::_perf_resolve_mt_count = nullptr;
141
142 void ClassLoader::print_counters(outputStream *st) {
143 st->print_cr("ClassLoader:");
144 st->print_cr(" clinit: " JLONG_FORMAT "ms / " JLONG_FORMAT " events", ClassLoader::class_init_time_ms(), ClassLoader::class_init_count());
145 st->print_cr(" link methods: " JLONG_FORMAT "ms / " JLONG_FORMAT " events", Management::ticks_to_ms(_perf_ik_link_methods_time->get_value()) , _perf_ik_link_methods_count->get_value());
146 st->print_cr(" method adapters: " JLONG_FORMAT "ms / " JLONG_FORMAT " events", Management::ticks_to_ms(_perf_method_adapters_time->get_value()) , _perf_method_adapters_count->get_value());
147 st->print_cr(" resolve...");
148 st->print_cr(" invokedynamic: " JLONG_FORMAT "ms / " JLONG_FORMAT " events", Management::ticks_to_ms(_perf_resolve_indy_time->get_value()) , _perf_resolve_indy_count->get_value());
149 st->print_cr(" invokehandle: " JLONG_FORMAT "ms / " JLONG_FORMAT " events", Management::ticks_to_ms(_perf_resolve_invokehandle_time->get_value()) , _perf_resolve_invokehandle_count->get_value());
150 st->print_cr(" CP_MethodHandle: " JLONG_FORMAT "ms / " JLONG_FORMAT " events", Management::ticks_to_ms(_perf_resolve_mh_time->get_value()) , _perf_resolve_mh_count->get_value());
151 st->print_cr(" CP_MethodType: " JLONG_FORMAT "ms / " JLONG_FORMAT " events", Management::ticks_to_ms(_perf_resolve_mt_time->get_value()) , _perf_resolve_mt_count->get_value());
152 st->cr();
153 }
154
155 GrowableArray<ModuleClassPathList*>* ClassLoader::_patch_mod_entries = nullptr;
156 GrowableArray<ModuleClassPathList*>* ClassLoader::_exploded_entries = nullptr;
157 ClassPathEntry* ClassLoader::_jrt_entry = nullptr;
158
159 ClassPathEntry* volatile ClassLoader::_first_append_entry_list = nullptr;
160 ClassPathEntry* volatile ClassLoader::_last_append_entry = nullptr;
161
162 // helper routines
163 #if INCLUDE_CDS
164 static bool string_starts_with(const char* str, const char* str_to_find) {
165 size_t str_len = strlen(str);
166 size_t str_to_find_len = strlen(str_to_find);
167 if (str_to_find_len > str_len) {
168 return false;
169 }
170 return (strncmp(str, str_to_find, str_to_find_len) == 0);
171 }
172 #endif
173
174 static const char* get_jimage_version_string() {
175 static char version_string[10] = "";
176 if (version_string[0] == '\0') {
177 jio_snprintf(version_string, sizeof(version_string), "%d.%d",
178 VM_Version::vm_major_version(), VM_Version::vm_minor_version());
179 }
180 return (const char*)version_string;
181 }
182
183 bool ClassLoader::string_ends_with(const char* str, const char* str_to_find) {
184 size_t str_len = strlen(str);
185 size_t str_to_find_len = strlen(str_to_find);
186 if (str_to_find_len > str_len) {
187 return false;
188 }
189 return (strncmp(str + (str_len - str_to_find_len), str_to_find, str_to_find_len) == 0);
190 }
191
192 // Used to obtain the package name from a fully qualified class name.
193 Symbol* ClassLoader::package_from_class_name(const Symbol* name, bool* bad_class_name) {
194 if (name == nullptr) {
195 if (bad_class_name != nullptr) {
196 *bad_class_name = true;
197 }
198 return nullptr;
199 }
200
201 int utf_len = name->utf8_length();
202 const jbyte* base = (const jbyte*)name->base();
203 const jbyte* start = base;
204 const jbyte* end = UTF8::strrchr(start, utf_len, JVM_SIGNATURE_SLASH);
205 if (end == nullptr) {
206 return nullptr;
207 }
208 // Skip over '['s
209 if (*start == JVM_SIGNATURE_ARRAY) {
210 do {
211 start++;
212 } while (start < end && *start == JVM_SIGNATURE_ARRAY);
213
214 // Fully qualified class names should not contain a 'L'.
215 // Set bad_class_name to true to indicate that the package name
216 // could not be obtained due to an error condition.
217 // In this situation, is_same_class_package returns false.
218 if (*start == JVM_SIGNATURE_CLASS) {
219 if (bad_class_name != nullptr) {
220 *bad_class_name = true;
221 }
222 return nullptr;
223 }
224 }
225 // A class name could have just the slash character in the name,
226 // in which case start > end
227 if (start >= end) {
228 // No package name
229 if (bad_class_name != nullptr) {
230 *bad_class_name = true;
231 }
232 return nullptr;
233 }
234 return SymbolTable::new_symbol(name, pointer_delta_as_int(start, base), pointer_delta_as_int(end, base));
235 }
236
237 // Given a fully qualified package name, find its defining package in the class loader's
238 // package entry table.
239 PackageEntry* ClassLoader::get_package_entry(Symbol* pkg_name, ClassLoaderData* loader_data) {
240 if (pkg_name == nullptr) {
241 return nullptr;
242 }
243 PackageEntryTable* pkgEntryTable = loader_data->packages();
244 return pkgEntryTable->lookup_only(pkg_name);
245 }
246
247 const char* ClassPathEntry::copy_path(const char* path) {
248 char* copy = NEW_C_HEAP_ARRAY(char, strlen(path)+1, mtClass);
249 strcpy(copy, path);
250 return copy;
251 }
252
253 ClassPathDirEntry::~ClassPathDirEntry() {
254 FREE_C_HEAP_ARRAY(char, _dir);
255 }
256
257 ClassFileStream* ClassPathDirEntry::open_stream(JavaThread* current, const char* name) {
258 // construct full path name
259 assert((_dir != nullptr) && (name != nullptr), "sanity");
260 size_t path_len = strlen(_dir) + strlen(name) + strlen(os::file_separator()) + 1;
261 char* path = NEW_RESOURCE_ARRAY_IN_THREAD(current, char, path_len);
262 int len = jio_snprintf(path, path_len, "%s%s%s", _dir, os::file_separator(), name);
263 assert(len == (int)(path_len - 1), "sanity");
264 // check if file exists
265 struct stat st;
266 if (os::stat(path, &st) == 0) {
267 // found file, open it
268 int file_handle = os::open(path, 0, 0);
269 if (file_handle != -1) {
270 // read contents into resource array
271 u1* buffer = NEW_RESOURCE_ARRAY_IN_THREAD(current, u1, st.st_size);
272 size_t num_read = ::read(file_handle, (char*) buffer, st.st_size);
273 // close file
274 ::close(file_handle);
275 // construct ClassFileStream
276 if (num_read == (size_t)st.st_size) {
277 if (UsePerfData) {
278 ClassLoader::perf_sys_classfile_bytes_read()->inc(num_read);
279 }
280 #ifdef ASSERT
281 // Freeing path is a no-op here as buffer prevents it from being reclaimed. But we keep it for
282 // debug builds so that we guard against use-after-free bugs.
283 FREE_RESOURCE_ARRAY_IN_THREAD(current, char, path, path_len);
284 #endif
285 // We don't verify the length of the classfile stream fits in an int, but this is the
286 // bootloader so we have control of this.
287 // Resource allocated
288 return new ClassFileStream(buffer,
289 checked_cast<int>(st.st_size),
290 _dir);
291 }
292 }
293 }
294 FREE_RESOURCE_ARRAY_IN_THREAD(current, char, path, path_len);
295 return nullptr;
296 }
297
298 ClassPathZipEntry::ClassPathZipEntry(jzfile* zip, const char* zip_name) : ClassPathEntry() {
299 _zip = zip;
300 _zip_name = copy_path(zip_name);
301 }
302
303 ClassPathZipEntry::~ClassPathZipEntry() {
304 ZipLibrary::close(_zip);
305 FREE_C_HEAP_ARRAY(char, _zip_name);
306 }
307
308 bool ClassPathZipEntry::has_entry(JavaThread* current, const char* name) {
309 ThreadToNativeFromVM ttn(current);
310 // check whether zip archive contains name
311 jint name_len;
312 jint filesize;
313 jzentry* entry = ZipLibrary::find_entry(_zip, name, &filesize, &name_len);
314 if (entry == nullptr) {
315 return false;
316 } else {
317 ZipLibrary::free_entry(_zip, entry);
318 return true;
319 }
320 }
321
322 u1* ClassPathZipEntry::open_entry(JavaThread* current, const char* name, jint* filesize, bool nul_terminate) {
323 // enable call to C land
324 ThreadToNativeFromVM ttn(current);
325 // check whether zip archive contains name
326 jint name_len;
327 jzentry* entry = ZipLibrary::find_entry(_zip, name, filesize, &name_len);
328 if (entry == nullptr) return nullptr;
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 size_t size = (uint32_t)(*filesize);
340 if (nul_terminate) {
341 if (sizeof(size) == sizeof(uint32_t) && size == UINT_MAX) {
342 return nullptr; // 32-bit integer overflow will occur.
343 }
344 size++;
345 }
346 buffer = NEW_RESOURCE_ARRAY(u1, size);
347 if (!ZipLibrary::read_entry(_zip, entry, buffer, filename)) {
348 return nullptr;
349 }
350
351 // return result
352 if (nul_terminate) {
353 buffer[size - 1] = 0;
354 }
355 return buffer;
356 }
357
358 ClassFileStream* ClassPathZipEntry::open_stream(JavaThread* current, const char* name) {
359 jint filesize;
360 u1* buffer = open_entry(current, name, &filesize, false);
361 if (buffer == nullptr) {
362 return nullptr;
363 }
364 if (UsePerfData) {
365 ClassLoader::perf_sys_classfile_bytes_read()->inc(filesize);
366 }
367 // Resource allocated
368 return new ClassFileStream(buffer,
369 filesize,
370 _zip_name);
371 }
372
373 DEBUG_ONLY(ClassPathImageEntry* ClassPathImageEntry::_singleton = nullptr;)
374
375 JImageFile* ClassPathImageEntry::jimage() const {
376 return JImage_file;
377 }
378
379 JImageFile* ClassPathImageEntry::jimage_non_null() const {
380 assert(ClassLoader::has_jrt_entry(), "must be");
381 assert(jimage() != nullptr, "should have been opened by ClassLoader::lookup_vm_options "
382 "and remained throughout normal JVM lifetime");
383 return jimage();
384 }
385
386 void ClassPathImageEntry::close_jimage() {
387 if (jimage() != nullptr) {
388 (*JImageClose)(jimage());
389 JImage_file = nullptr;
390 }
391 }
392
393 ClassPathImageEntry::ClassPathImageEntry(JImageFile* jimage, const char* name) :
394 ClassPathEntry() {
395 guarantee(jimage != nullptr, "jimage file is null");
396 guarantee(name != nullptr, "jimage file name is null");
397 assert(_singleton == nullptr, "VM supports only one jimage");
398 DEBUG_ONLY(_singleton = this);
399 size_t len = strlen(name) + 1;
400 _name = copy_path(name);
401 }
402
403 ClassFileStream* ClassPathImageEntry::open_stream(JavaThread* current, const char* name) {
404 return open_stream_for_loader(current, name, ClassLoaderData::the_null_class_loader_data());
405 }
406
407 // For a class in a named module, look it up in the jimage file using this syntax:
408 // /<module-name>/<package-name>/<base-class>
409 //
410 // Assumptions:
411 // 1. There are no unnamed modules in the jimage file.
412 // 2. A package is in at most one module in the jimage file.
413 //
414 ClassFileStream* ClassPathImageEntry::open_stream_for_loader(JavaThread* current, const char* name, ClassLoaderData* loader_data) {
415 jlong size;
416 JImageLocationRef location = (*JImageFindResource)(jimage_non_null(), "", get_jimage_version_string(), name, &size);
417
418 if (location == 0) {
419 TempNewSymbol class_name = SymbolTable::new_symbol(name);
420 TempNewSymbol pkg_name = ClassLoader::package_from_class_name(class_name);
421
422 if (pkg_name != nullptr) {
423 if (!Universe::is_module_initialized()) {
424 location = (*JImageFindResource)(jimage_non_null(), JAVA_BASE_NAME, get_jimage_version_string(), name, &size);
425 } else {
426 PackageEntry* package_entry = ClassLoader::get_package_entry(pkg_name, loader_data);
427 if (package_entry != nullptr) {
428 ResourceMark rm(current);
429 // Get the module name
430 ModuleEntry* module = package_entry->module();
431 assert(module != nullptr, "Boot classLoader package missing module");
432 assert(module->is_named(), "Boot classLoader package is in unnamed module");
433 const char* module_name = module->name()->as_C_string();
434 if (module_name != nullptr) {
435 location = (*JImageFindResource)(jimage_non_null(), module_name, get_jimage_version_string(), name, &size);
436 }
437 }
438 }
439 }
440 }
441 if (location != 0) {
442 if (UsePerfData) {
443 ClassLoader::perf_sys_classfile_bytes_read()->inc(size);
444 }
445 char* data = NEW_RESOURCE_ARRAY(char, size);
446 (*JImageGetResource)(jimage_non_null(), location, data, size);
447 // Resource allocated
448 assert(this == (ClassPathImageEntry*)ClassLoader::get_jrt_entry(), "must be");
449 return new ClassFileStream((u1*)data,
450 checked_cast<int>(size),
451 _name,
452 true); // from_boot_loader_modules_image
453 }
454
455 return nullptr;
456 }
457
458 JImageLocationRef ClassLoader::jimage_find_resource(JImageFile* jf,
459 const char* module_name,
460 const char* file_name,
461 jlong &size) {
462 return ((*JImageFindResource)(jf, module_name, get_jimage_version_string(), file_name, &size));
463 }
464
465 bool ClassPathImageEntry::is_modules_image() const {
466 assert(this == _singleton, "VM supports a single jimage");
467 assert(this == (ClassPathImageEntry*)ClassLoader::get_jrt_entry(), "must be used for jrt entry");
468 return true;
469 }
470
471 ModuleClassPathList::ModuleClassPathList(Symbol* module_name) {
472 _module_name = module_name;
473 _module_first_entry = nullptr;
474 _module_last_entry = nullptr;
475 }
476
477 ModuleClassPathList::~ModuleClassPathList() {
478 // Clean out each ClassPathEntry on list
479 ClassPathEntry* e = _module_first_entry;
480 while (e != nullptr) {
481 ClassPathEntry* next_entry = e->next();
482 delete e;
483 e = next_entry;
484 }
485 }
486
487 void ModuleClassPathList::add_to_list(ClassPathEntry* new_entry) {
488 if (new_entry != nullptr) {
489 if (_module_last_entry == nullptr) {
490 _module_first_entry = _module_last_entry = new_entry;
491 } else {
492 _module_last_entry->set_next(new_entry);
493 _module_last_entry = new_entry;
494 }
495 }
496 }
497
498 void ClassLoader::trace_class_path(const char* msg, const char* name) {
499 LogTarget(Info, class, path) lt;
500 if (lt.is_enabled()) {
501 LogStream ls(lt);
502 if (msg) {
503 ls.print("%s", msg);
504 }
505 if (name) {
506 if (strlen(name) < 256) {
507 ls.print("%s", name);
508 } else {
509 // For very long paths, we need to print each character separately,
510 // as print_cr() has a length limit
511 while (name[0] != '\0') {
512 ls.print("%c", name[0]);
513 name++;
514 }
515 }
516 }
517 ls.cr();
518 }
519 }
520
521 void ClassLoader::setup_bootstrap_search_path(JavaThread* current) {
522 const char* bootcp = Arguments::get_boot_class_path();
523 assert(bootcp != nullptr, "Boot class path must not be nullptr");
524 if (PrintSharedArchiveAndExit) {
525 // Don't print bootcp - this is the bootcp of this current VM process, not necessarily
526 // the same as the boot classpath of the shared archive.
527 } else {
528 trace_class_path("bootstrap loader class path=", bootcp);
529 }
530 setup_bootstrap_search_path_impl(current, bootcp);
531 }
532
533 void ClassLoader::close_jrt_image() {
534 // Not applicable for exploded builds
535 if (!ClassLoader::has_jrt_entry()) return;
536 _jrt_entry->close_jimage();
537 }
538
539 // Construct the array of module/path pairs as specified to --patch-module
540 // for the boot loader to search ahead of the jimage, if the class being
541 // loaded is defined to a module that has been specified to --patch-module.
542 void ClassLoader::setup_patch_mod_entries() {
543 JavaThread* current = JavaThread::current();
544 GrowableArray<ModulePatchPath*>* patch_mod_args = Arguments::get_patch_mod_prefix();
545 int num_of_entries = patch_mod_args->length();
546
547 // Set up the boot loader's _patch_mod_entries list
548 _patch_mod_entries = new (mtModule) GrowableArray<ModuleClassPathList*>(num_of_entries, mtModule);
549
550 for (int i = 0; i < num_of_entries; i++) {
551 const char* module_name = (patch_mod_args->at(i))->module_name();
552 Symbol* const module_sym = SymbolTable::new_symbol(module_name);
553 assert(module_sym != nullptr, "Failed to obtain Symbol for module name");
554 ModuleClassPathList* module_cpl = new ModuleClassPathList(module_sym);
555
556 char* class_path = (patch_mod_args->at(i))->path_string();
557 ResourceMark rm(current);
558 ClasspathStream cp_stream(class_path);
559
560 while (cp_stream.has_next()) {
561 const char* path = cp_stream.get_next();
562 struct stat st;
563 if (os::stat(path, &st) == 0) {
564 // File or directory found
565 ClassPathEntry* new_entry = create_class_path_entry(current, path, &st);
566 // If the path specification is valid, enter it into this module's list
567 if (new_entry != nullptr) {
568 module_cpl->add_to_list(new_entry);
569 }
570 }
571 }
572
573 // Record the module into the list of --patch-module entries only if
574 // valid ClassPathEntrys have been created
575 if (module_cpl->module_first_entry() != nullptr) {
576 _patch_mod_entries->push(module_cpl);
577 }
578 }
579 }
580
581 // Determine whether the module has been patched via the command-line
582 // option --patch-module
583 bool ClassLoader::is_in_patch_mod_entries(Symbol* module_name) {
584 if (_patch_mod_entries != nullptr && _patch_mod_entries->is_nonempty()) {
585 int table_len = _patch_mod_entries->length();
586 for (int i = 0; i < table_len; i++) {
587 ModuleClassPathList* patch_mod = _patch_mod_entries->at(i);
588 if (module_name->fast_compare(patch_mod->module_name()) == 0) {
589 return true;
590 }
591 }
592 }
593 return false;
594 }
595
596 // Set up the _jrt_entry if present and boot append path
597 void ClassLoader::setup_bootstrap_search_path_impl(JavaThread* current, const char *class_path) {
598 ResourceMark rm(current);
599 ClasspathStream cp_stream(class_path);
600 bool set_base_piece = true;
601
602 #if INCLUDE_CDS
603 if (CDSConfig::is_dumping_archive()) {
604 if (!Arguments::has_jimage()) {
605 vm_exit_during_initialization("CDS is not supported in exploded JDK build", nullptr);
606 }
607 }
608 #endif
609
610 while (cp_stream.has_next()) {
611 const char* path = cp_stream.get_next();
612
613 if (set_base_piece) {
614 // The first time through the bootstrap_search setup, it must be determined
615 // what the base or core piece of the boot loader search is. Either a java runtime
616 // image is present or this is an exploded module build situation.
617 assert(string_ends_with(path, MODULES_IMAGE_NAME) || string_ends_with(path, JAVA_BASE_NAME),
618 "Incorrect boot loader search path, no java runtime image or " JAVA_BASE_NAME " exploded build");
619 struct stat st;
620 if (os::stat(path, &st) == 0) {
621 // Directory found
622 if (JImage_file != nullptr) {
623 assert(Arguments::has_jimage(), "sanity check");
624 const char* canonical_path = get_canonical_path(path, current);
625 assert(canonical_path != nullptr, "canonical_path issue");
626
627 _jrt_entry = new ClassPathImageEntry(JImage_file, canonical_path);
628 assert(_jrt_entry != nullptr && _jrt_entry->is_modules_image(), "No java runtime image present");
629 assert(_jrt_entry->jimage() != nullptr, "No java runtime image");
630 } // else it's an exploded build.
631 } else {
632 // If path does not exist, exit
633 vm_exit_during_initialization("Unable to establish the boot loader search path", path);
634 }
635 set_base_piece = false;
636 } else {
637 // Every entry on the boot class path after the initial base piece,
638 // which is set by os::set_boot_path(), is considered an appended entry.
639 update_class_path_entry_list(current, path);
640 }
641 }
642 }
643
644 // Gets the exploded path for the named module. The memory for the path
645 // is allocated on the C heap if `c_heap` is true otherwise in the resource area.
646 static const char* get_exploded_module_path(const char* module_name, bool c_heap) {
647 const char *home = Arguments::get_java_home();
648 const char file_sep = os::file_separator()[0];
649 // 10 represents the length of "modules" + 2 file separators + \0
650 size_t len = strlen(home) + strlen(module_name) + 10;
651 char *path = c_heap ? NEW_C_HEAP_ARRAY(char, len, mtModule) : NEW_RESOURCE_ARRAY(char, len);
652 jio_snprintf(path, len, "%s%cmodules%c%s", home, file_sep, file_sep, module_name);
653 return path;
654 }
655
656 // During an exploded modules build, each module defined to the boot loader
657 // will be added to the ClassLoader::_exploded_entries array.
658 void ClassLoader::add_to_exploded_build_list(JavaThread* current, Symbol* module_sym) {
659 assert(!ClassLoader::has_jrt_entry(), "Exploded build not applicable");
660 assert(_exploded_entries != nullptr, "_exploded_entries was not initialized");
661
662 // Find the module's symbol
663 ResourceMark rm(current);
664 const char *module_name = module_sym->as_C_string();
665 const char *path = get_exploded_module_path(module_name, false);
666
667 struct stat st;
668 if (os::stat(path, &st) == 0) {
669 // Directory found
670 ClassPathEntry* new_entry = create_class_path_entry(current, path, &st);
671
672 // If the path specification is valid, enter it into this module's list.
673 // There is no need to check for duplicate modules in the exploded entry list,
674 // since no two modules with the same name can be defined to the boot loader.
675 // This is checked at module definition time in Modules::define_module.
676 if (new_entry != nullptr) {
677 ModuleClassPathList* module_cpl = new ModuleClassPathList(module_sym);
678 module_cpl->add_to_list(new_entry);
679 {
680 MutexLocker ml(current, Module_lock);
681 _exploded_entries->push(module_cpl);
682 }
683 log_info(class, load)("path: %s", path);
684 }
685 }
686 }
687
688 jzfile* ClassLoader::open_zip_file(const char* canonical_path, char** error_msg, JavaThread* thread) {
689 // enable call to C land
690 ThreadToNativeFromVM ttn(thread);
691 HandleMark hm(thread);
692 return ZipLibrary::open(canonical_path, error_msg);
693 }
694
695 ClassPathEntry* ClassLoader::create_class_path_entry(JavaThread* current,
696 const char *path, const struct stat* st) {
697 ClassPathEntry* new_entry = nullptr;
698 if ((st->st_mode & S_IFMT) == S_IFREG) {
699 ResourceMark rm(current);
700 // Regular file, should be a zip file
701 // Canonicalized filename
702 const char* canonical_path = get_canonical_path(path, current);
703 if (canonical_path == nullptr) {
704 return nullptr;
705 }
706 char* error_msg = nullptr;
707 jzfile* zip = open_zip_file(canonical_path, &error_msg, current);
708 if (zip != nullptr && error_msg == nullptr) {
709 new_entry = new ClassPathZipEntry(zip, path);
710 } else {
711 return nullptr;
712 }
713 log_info(class, path)("opened: %s", path);
714 log_info(class, load)("opened: %s", path);
715 } else {
716 // Directory
717 new_entry = new ClassPathDirEntry(path);
718 log_info(class, load)("path: %s", path);
719 }
720 return new_entry;
721 }
722
723
724 // Create a class path zip entry for a given path (return null if not found
725 // or zip/JAR file cannot be opened)
726 ClassPathZipEntry* ClassLoader::create_class_path_zip_entry(const char *path) {
727 // check for a regular file
728 struct stat st;
729 if (os::stat(path, &st) == 0) {
730 if ((st.st_mode & S_IFMT) == S_IFREG) {
731 JavaThread* thread = JavaThread::current();
732 ResourceMark rm(thread);
733 const char* canonical_path = get_canonical_path(path, thread);
734 if (canonical_path != nullptr) {
735 char* error_msg = nullptr;
736 jzfile* zip = open_zip_file(canonical_path, &error_msg, thread);
737 if (zip != nullptr && error_msg == nullptr) {
738 // create using canonical path
739 return new ClassPathZipEntry(zip, canonical_path);
740 }
741 }
742 }
743 }
744 return nullptr;
745 }
746
747 // The boot append entries are added with a lock, and read lock free.
748 void ClassLoader::add_to_boot_append_entries(ClassPathEntry *new_entry) {
749 if (new_entry != nullptr) {
750 MutexLocker ml(Bootclasspath_lock, Mutex::_no_safepoint_check_flag);
751 if (_last_append_entry == nullptr) {
752 _last_append_entry = new_entry;
753 assert(first_append_entry() == nullptr, "boot loader's append class path entry list not empty");
754 Atomic::release_store(&_first_append_entry_list, new_entry);
755 } else {
756 _last_append_entry->set_next(new_entry);
757 _last_append_entry = new_entry;
758 }
759 }
760 }
761
762 // Returns true IFF the file/dir exists and the entry was successfully created.
763 bool ClassLoader::update_class_path_entry_list(JavaThread* current, const char *path) {
764 struct stat st;
765 if (os::stat(path, &st) == 0) {
766 // File or directory found
767 ClassPathEntry* new_entry = nullptr;
768 new_entry = create_class_path_entry(current, path, &st);
769 if (new_entry == nullptr) {
770 return false;
771 }
772
773 // Do not reorder the bootclasspath which would break get_system_package().
774 // Add new entry to linked list
775 add_to_boot_append_entries(new_entry);
776 return true;
777 } else {
778 return false;
779 }
780 }
781
782 static void print_module_entry_table(const GrowableArray<ModuleClassPathList*>* const module_list) {
783 ResourceMark rm;
784 int num_of_entries = module_list->length();
785 for (int i = 0; i < num_of_entries; i++) {
786 ClassPathEntry* e;
787 ModuleClassPathList* mpl = module_list->at(i);
788 tty->print("%s=", mpl->module_name()->as_C_string());
789 e = mpl->module_first_entry();
790 while (e != nullptr) {
791 tty->print("%s", e->name());
792 e = e->next();
793 if (e != nullptr) {
794 tty->print("%s", os::path_separator());
795 }
796 }
797 tty->print(" ;");
798 }
799 }
800
801 void ClassLoader::print_bootclasspath() {
802 ClassPathEntry* e;
803 tty->print("[bootclasspath= ");
804
805 // Print --patch-module module/path specifications first
806 if (_patch_mod_entries != nullptr) {
807 print_module_entry_table(_patch_mod_entries);
808 }
809
810 // [jimage | exploded modules build]
811 if (has_jrt_entry()) {
812 // Print the location of the java runtime image
813 tty->print("%s ;", _jrt_entry->name());
814 } else {
815 // Print exploded module build path specifications
816 if (_exploded_entries != nullptr) {
817 print_module_entry_table(_exploded_entries);
818 }
819 }
820
821 // appended entries
822 e = first_append_entry();
823 while (e != nullptr) {
824 tty->print("%s ;", e->name());
825 e = e->next();
826 }
827 tty->print_cr("]");
828 }
829
830 void* ClassLoader::dll_lookup(void* lib, const char* name, const char* path) {
831 void* func = os::dll_lookup(lib, name);
832 if (func == nullptr) {
833 char msg[256] = "";
834 jio_snprintf(msg, sizeof(msg), "Could not resolve \"%s\"", name);
835 vm_exit_during_initialization(msg, path);
836 }
837 return func;
838 }
839
840 void ClassLoader::load_java_library() {
841 assert(CanonicalizeEntry == nullptr, "should not load java library twice");
842 if (is_vm_statically_linked()) {
843 CanonicalizeEntry = CAST_TO_FN_PTR(canonicalize_fn_t, os::lookup_function("JDK_Canonicalize"));
844 assert(CanonicalizeEntry != nullptr, "could not lookup JDK_Canonicalize");
845 return;
846 }
847
848 void *javalib_handle = os::native_java_library();
849 if (javalib_handle == nullptr) {
850 vm_exit_during_initialization("Unable to load java library", nullptr);
851 }
852
853 CanonicalizeEntry = CAST_TO_FN_PTR(canonicalize_fn_t, dll_lookup(javalib_handle, "JDK_Canonicalize", nullptr));
854 assert(CanonicalizeEntry != nullptr, "could not lookup JDK_Canonicalize in java library");
855 }
856
857 void ClassLoader::load_jimage_library() {
858 assert(JImageOpen == nullptr, "should not load jimage library twice");
859
860 if (is_vm_statically_linked()) {
861 JImageOpen = CAST_TO_FN_PTR(JImageOpen_t, os::lookup_function("JIMAGE_Open"));
862 JImageClose = CAST_TO_FN_PTR(JImageClose_t, os::lookup_function("JIMAGE_Close"));
863 JImageFindResource = CAST_TO_FN_PTR(JImageFindResource_t, os::lookup_function("JIMAGE_FindResource"));
864 JImageGetResource = CAST_TO_FN_PTR(JImageGetResource_t, os::lookup_function("JIMAGE_GetResource"));
865 assert(JImageOpen != nullptr && JImageClose != nullptr &&
866 JImageFindResource != nullptr && JImageGetResource != nullptr,
867 "could not lookup all jimage library functions");
868 return;
869 }
870
871 char path[JVM_MAXPATHLEN];
872 char ebuf[1024];
873 void* handle = nullptr;
874 if (os::dll_locate_lib(path, sizeof(path), Arguments::get_dll_dir(), "jimage")) {
875 handle = os::dll_load(path, ebuf, sizeof ebuf);
876 }
877 if (handle == nullptr) {
878 vm_exit_during_initialization("Unable to load jimage library", path);
879 }
880
881 JImageOpen = CAST_TO_FN_PTR(JImageOpen_t, dll_lookup(handle, "JIMAGE_Open", path));
882 JImageClose = CAST_TO_FN_PTR(JImageClose_t, dll_lookup(handle, "JIMAGE_Close", path));
883 JImageFindResource = CAST_TO_FN_PTR(JImageFindResource_t, dll_lookup(handle, "JIMAGE_FindResource", path));
884 JImageGetResource = CAST_TO_FN_PTR(JImageGetResource_t, dll_lookup(handle, "JIMAGE_GetResource", path));
885 assert(JImageOpen != nullptr && JImageClose != nullptr &&
886 JImageFindResource != nullptr && JImageGetResource != nullptr,
887 "could not lookup all jimage library functions in jimage library");
888 }
889
890 int ClassLoader::crc32(int crc, const char* buf, int len) {
891 return ZipLibrary::crc32(crc, (const jbyte*)buf, len);
892 }
893
894 oop ClassLoader::get_system_package(const char* name, TRAPS) {
895 // Look up the name in the boot loader's package entry table.
896 if (name != nullptr) {
897 TempNewSymbol package_sym = SymbolTable::new_symbol(name);
898 // Look for the package entry in the boot loader's package entry table.
899 PackageEntry* package =
900 ClassLoaderData::the_null_class_loader_data()->packages()->lookup_only(package_sym);
901
902 // Return null if package does not exist or if no classes in that package
903 // have been loaded.
904 if (package != nullptr && package->has_loaded_class()) {
905 ModuleEntry* module = package->module();
906 if (module->location() != nullptr) {
907 ResourceMark rm(THREAD);
908 Handle ml = java_lang_String::create_from_str(
909 module->location()->as_C_string(), THREAD);
910 return ml();
911 }
912 // Return entry on boot loader class path.
913 Handle cph = java_lang_String::create_from_str(
914 ClassLoader::classpath_entry(package->classpath_index())->name(), THREAD);
915 return cph();
916 }
917 }
918 return nullptr;
919 }
920
921 objArrayOop ClassLoader::get_system_packages(TRAPS) {
922 ResourceMark rm(THREAD);
923 // List of pointers to PackageEntrys that have loaded classes.
924 PackageEntryTable* pe_table =
925 ClassLoaderData::the_null_class_loader_data()->packages();
926 GrowableArray<PackageEntry*>* loaded_class_pkgs = pe_table->get_system_packages();
927
928 // Allocate objArray and fill with java.lang.String
929 objArrayOop r = oopFactory::new_objArray(vmClasses::String_klass(),
930 loaded_class_pkgs->length(), CHECK_NULL);
931 objArrayHandle result(THREAD, r);
932 for (int x = 0; x < loaded_class_pkgs->length(); x++) {
933 PackageEntry* package_entry = loaded_class_pkgs->at(x);
934 Handle str = java_lang_String::create_from_symbol(package_entry->name(), CHECK_NULL);
935 result->obj_at_put(x, str());
936 }
937 return result();
938 }
939
940 // caller needs ResourceMark
941 const char* ClassLoader::file_name_for_class_name(const char* class_name,
942 int class_name_len) {
943 assert(class_name != nullptr, "invariant");
944 assert((int)strlen(class_name) == class_name_len, "invariant");
945
946 static const char class_suffix[] = ".class";
947 size_t class_suffix_len = sizeof(class_suffix);
948
949 char* const file_name = NEW_RESOURCE_ARRAY(char,
950 class_name_len +
951 class_suffix_len); // includes term null
952
953 strncpy(file_name, class_name, class_name_len);
954 strncpy(&file_name[class_name_len], class_suffix, class_suffix_len);
955
956 return file_name;
957 }
958
959 static ClassPathEntry* find_first_module_cpe(ModuleEntry* mod_entry,
960 const GrowableArray<ModuleClassPathList*>* const module_list) {
961 int num_of_entries = module_list->length();
962 const Symbol* class_module_name = mod_entry->name();
963
964 // Loop through all the modules in either the patch-module or exploded entries looking for module
965 for (int i = 0; i < num_of_entries; i++) {
966 ModuleClassPathList* module_cpl = module_list->at(i);
967 Symbol* module_cpl_name = module_cpl->module_name();
968
969 if (module_cpl_name->fast_compare(class_module_name) == 0) {
970 // Class' module has been located.
971 return module_cpl->module_first_entry();
972 }
973 }
974 return nullptr;
975 }
976
977
978 // Search the module list for the class file stream based on the file name and java package
979 ClassFileStream* ClassLoader::search_module_entries(JavaThread* current,
980 const GrowableArray<ModuleClassPathList*>* const module_list,
981 PackageEntry* pkg_entry, // Java package entry derived from the class name
982 const char* const file_name) {
983 ClassFileStream* stream = nullptr;
984
985 // Find the defining module in the boot loader's module entry table
986 ModuleEntry* mod_entry = (pkg_entry != nullptr) ? pkg_entry->module() : nullptr;
987
988 // If the module system has not defined java.base yet, then
989 // classes loaded are assumed to be defined to java.base.
990 // When java.base is eventually defined by the module system,
991 // all packages of classes that have been previously loaded
992 // are verified in ModuleEntryTable::verify_javabase_packages().
993 if (!Universe::is_module_initialized() &&
994 !ModuleEntryTable::javabase_defined() &&
995 mod_entry == nullptr) {
996 mod_entry = ModuleEntryTable::javabase_moduleEntry();
997 }
998
999 // The module must be a named module
1000 ClassPathEntry* e = nullptr;
1001 if (mod_entry != nullptr && mod_entry->is_named()) {
1002 if (module_list == _exploded_entries) {
1003 // The exploded build entries can be added to at any time so a lock is
1004 // needed when searching them.
1005 assert(!ClassLoader::has_jrt_entry(), "Must be exploded build");
1006 MutexLocker ml(current, Module_lock);
1007 e = find_first_module_cpe(mod_entry, module_list);
1008 } else {
1009 e = find_first_module_cpe(mod_entry, module_list);
1010 }
1011 }
1012
1013 // Try to load the class from the module's ClassPathEntry list.
1014 while (e != nullptr) {
1015 stream = e->open_stream(current, file_name);
1016 // No context.check is required since CDS is not supported
1017 // for an exploded modules build or if --patch-module is specified.
1018 if (nullptr != stream) {
1019 return stream;
1020 }
1021 e = e->next();
1022 }
1023 // If the module was located, break out even if the class was not
1024 // located successfully from that module's ClassPathEntry list.
1025 // There will not be another valid entry for that module.
1026 return nullptr;
1027 }
1028
1029 // Called by the boot classloader to load classes
1030 InstanceKlass* ClassLoader::load_class(Symbol* name, PackageEntry* pkg_entry, bool search_append_only, TRAPS) {
1031 assert(name != nullptr, "invariant");
1032
1033 ResourceMark rm(THREAD);
1034 HandleMark hm(THREAD);
1035
1036 const char* const class_name = name->as_C_string();
1037
1038 EventMarkClassLoading m("Loading class %s", class_name);
1039
1040 const char* const file_name = file_name_for_class_name(class_name,
1041 name->utf8_length());
1042 assert(file_name != nullptr, "invariant");
1043
1044 // Lookup stream for parsing .class file
1045 ClassFileStream* stream = nullptr;
1046 s2 classpath_index = 0;
1047 ClassPathEntry* e = nullptr;
1048 bool is_patched = false;
1049
1050 // If search_append_only is true, boot loader visibility boundaries are
1051 // set to be _first_append_entry to the end. This includes:
1052 // [-Xbootclasspath/a]; [jvmti appended entries]
1053 //
1054 // If search_append_only is false, boot loader visibility boundaries are
1055 // set to be the --patch-module entries plus the base piece. This includes:
1056 // [--patch-module=<module>=<file>(<pathsep><file>)*]; [jimage | exploded module build]
1057 //
1058
1059 // Load Attempt #1: --patch-module
1060 // Determine the class' defining module. If it appears in the _patch_mod_entries,
1061 // attempt to load the class from those locations specific to the module.
1062 // Specifications to --patch-module can contain a partial number of classes
1063 // that are part of the overall module definition. So if a particular class is not
1064 // found within its module specification, the search should continue to Load Attempt #2.
1065 // Note: The --patch-module entries are never searched if the boot loader's
1066 // visibility boundary is limited to only searching the append entries.
1067 if (_patch_mod_entries != nullptr && !search_append_only) {
1068 // At CDS dump time, the --patch-module entries are ignored. That means a
1069 // class is still loaded from the runtime image even if it might
1070 // appear in the _patch_mod_entries. The runtime shared class visibility
1071 // check will determine if a shared class is visible based on the runtime
1072 // environment, including the runtime --patch-module setting.
1073 if (!CDSConfig::is_valhalla_preview()) {
1074 // Dynamic dumping requires UseSharedSpaces to be enabled. Since --patch-module
1075 // is not supported with UseSharedSpaces, we can never come here during dynamic dumping.
1076 assert(!CDSConfig::is_dumping_archive(), "CDS doesn't support --patch-module during dumping");
1077 }
1078 if (CDSConfig::is_valhalla_preview() || !CDSConfig::is_dumping_static_archive()) {
1079 stream = search_module_entries(THREAD, _patch_mod_entries, pkg_entry, file_name);
1080 if (stream != nullptr) {
1081 is_patched = true;
1082 }
1083 }
1084 }
1085
1086 // Load Attempt #2: [jimage | exploded build]
1087 if (!search_append_only && (nullptr == stream)) {
1088 if (has_jrt_entry()) {
1089 e = _jrt_entry;
1090 stream = _jrt_entry->open_stream(THREAD, file_name);
1091 } else {
1092 // Exploded build - attempt to locate class in its defining module's location.
1093 assert(_exploded_entries != nullptr, "No exploded build entries present");
1094 assert(!CDSConfig::is_dumping_archive(), "CDS dumping doesn't support exploded build");
1095 stream = search_module_entries(THREAD, _exploded_entries, pkg_entry, file_name);
1096 }
1097 }
1098
1099 // Load Attempt #3: [-Xbootclasspath/a]; [jvmti appended entries]
1100 if (search_append_only && (nullptr == stream)) {
1101 // For the boot loader append path search, the starting classpath_index
1102 // for the appended piece is always 1 to account for either the
1103 // _jrt_entry or the _exploded_entries.
1104 assert(classpath_index == 0, "The classpath_index has been incremented incorrectly");
1105 classpath_index = 1;
1106
1107 e = first_append_entry();
1108 while (e != nullptr) {
1109 stream = e->open_stream(THREAD, file_name);
1110 if (nullptr != stream) {
1111 break;
1112 }
1113 e = e->next();
1114 ++classpath_index;
1115 }
1116 }
1117
1118 if (nullptr == stream) {
1119 return nullptr;
1120 }
1121
1122 ClassLoaderData* loader_data = ClassLoaderData::the_null_class_loader_data();
1123 Handle protection_domain;
1124 ClassLoadInfo cl_info(protection_domain);
1125
1126 InstanceKlass* result = KlassFactory::create_from_stream(stream,
1127 name,
1128 loader_data,
1129 cl_info,
1130 CHECK_NULL);
1131 result->set_classpath_index(classpath_index);
1132 if (is_patched) {
1133 result->set_shared_classpath_index(0);
1134 #if INCLUDE_CDS
1135 result->set_shared_class_loader_type(ClassLoader::BOOT_LOADER);
1136 #endif
1137 }
1138 return result;
1139 }
1140
1141 #if INCLUDE_CDS
1142 static const char* skip_uri_protocol(const char* source) {
1143 if (strncmp(source, "file:", 5) == 0) {
1144 // file: protocol path could start with file:/ or file:///
1145 // locate the char after all the forward slashes
1146 int offset = 5;
1147 while (*(source + offset) == '/') {
1148 offset++;
1149 }
1150 source += offset;
1151 // for non-windows platforms, move back one char as the path begins with a '/'
1152 #ifndef _WINDOWS
1153 source -= 1;
1154 #endif
1155 } else if (strncmp(source, "jrt:/", 5) == 0) {
1156 source += 5;
1157 }
1158 return source;
1159 }
1160
1161 static char decode_percent_encoded(const char *str, size_t& index) {
1162 if (str[index] == '%'
1163 && isxdigit(str[index + 1])
1164 && isxdigit(str[index + 2])) {
1165 char hex[3];
1166 hex[0] = str[index + 1];
1167 hex[1] = str[index + 2];
1168 hex[2] = '\0';
1169 index += 2;
1170 return (char) strtol(hex, nullptr, 16);
1171 }
1172 return str[index];
1173 }
1174
1175 char* ClassLoader::uri_to_path(const char* uri) {
1176 const size_t len = strlen(uri) + 1;
1177 char* path = NEW_RESOURCE_ARRAY(char, len);
1178
1179 uri = skip_uri_protocol(uri);
1180
1181 if (strncmp(uri, "//", 2) == 0) {
1182 // Skip the empty "authority" part
1183 uri += 2;
1184 }
1185
1186 #ifdef _WINDOWS
1187 if (uri[0] == '/') {
1188 // Absolute path name on Windows does not begin with a slash
1189 uri += 1;
1190 }
1191 #endif
1192
1193 size_t path_index = 0;
1194 for (size_t i = 0; i < strlen(uri); ++i) {
1195 char decoded = decode_percent_encoded(uri, i);
1196 path[path_index++] = decoded;
1197 }
1198 path[path_index] = '\0';
1199 return path;
1200 }
1201
1202 // Record the shared classpath index and loader type for classes loaded
1203 // by the builtin loaders at dump time.
1204 void ClassLoader::record_result(JavaThread* current, InstanceKlass* ik,
1205 const ClassFileStream* stream, bool redefined) {
1206 assert(CDSConfig::is_dumping_archive(), "sanity");
1207 assert(stream != nullptr, "sanity");
1208
1209 if (ik->is_hidden()) {
1210 record_hidden_class(ik);
1211 return;
1212 }
1213
1214 if (ik->shared_classpath_index() == 0 && ik->is_shared_boot_class()) {
1215 return;
1216 }
1217
1218 oop loader = ik->class_loader();
1219 char* src = (char*)stream->source();
1220 if (src == nullptr) {
1221 if (loader == nullptr) {
1222 // JFR classes
1223 ik->set_shared_classpath_index(0);
1224 ik->set_shared_class_loader_type(ClassLoader::BOOT_LOADER);
1225 }
1226 return;
1227 }
1228
1229 assert(has_jrt_entry(), "CDS dumping does not support exploded JDK build");
1230
1231 ResourceMark rm(current);
1232 int classpath_index = -1;
1233 PackageEntry* pkg_entry = ik->package();
1234
1235 if (!AOTClassLocationConfig::dumptime_is_ready()) {
1236 // The shared path table is set up after module system initialization.
1237 // The path table contains no entry before that. Any classes loaded prior
1238 // to the setup of the shared path table must be from the modules image.
1239 assert(stream->from_boot_loader_modules_image(), "stream must be loaded by boot loader from modules image");
1240 classpath_index = 0;
1241 } else {
1242 // Save the path from the file: protocol or the module name from the jrt: protocol
1243 // if no protocol prefix is found, path is the same as stream->source(). This path
1244 // must be valid since the class has been successfully parsed.
1245 const char* path = ClassLoader::uri_to_path(src);
1246 assert(path != nullptr, "sanity");
1247 bool found_invalid = false;
1248 AOTClassLocationConfig::dumptime_iterate([&] (AOTClassLocation* cl) {
1249 int i = cl->index();
1250 // for index 0 and the stream->source() is the modules image or has the jrt: protocol.
1251 // The class must be from the runtime modules image.
1252 if (cl->is_modules_image() && (stream->from_boot_loader_modules_image() || string_starts_with(src, "jrt:"))) {
1253 classpath_index = i;
1254 } else if (os::same_files(cl->path(), path)) {
1255 // If the path (from the class stream source) is the same as the shared
1256 // class or module path, then we have a match.
1257 // src may come from the App/Platform class loaders, which would canonicalize
1258 // the file name. We cannot use strcmp to check for equality against cs->path().
1259 // We must use os::same_files (which is faster than canonicalizing cs->path()).
1260
1261 // null pkg_entry and pkg_entry in an unnamed module implies the class
1262 // is from the -cp or boot loader append path which consists of -Xbootclasspath/a
1263 // and jvmti appended entries.
1264 if ((pkg_entry == nullptr) || (pkg_entry->in_unnamed_module())) {
1265 // Ensure the index is within the -cp range before assigning
1266 // to the classpath_index.
1267 if (SystemDictionary::is_system_class_loader(loader) && cl->from_app_classpath()) {
1268 classpath_index = i;
1269 } else {
1270 if (cl->from_boot_classpath()) {
1271 if (loader != nullptr) {
1272 // Probably loaded by jdk/internal/loader/ClassLoaders$BootClassLoader. Don't archive
1273 // such classes.
1274 ik->set_shared_classpath_index(-1);
1275 ik->set_shared_class_loader_type(ClassLoader::BOOT_LOADER);
1276 found_invalid = true;
1277 } else {
1278 classpath_index = i;
1279 }
1280 }
1281 }
1282 } else {
1283 // A class from a named module from the --module-path. Ensure the index is
1284 // within the --module-path range before assigning to the classpath_index.
1285 if ((pkg_entry != nullptr) && !(pkg_entry->in_unnamed_module()) && cl->from_module_path()) {
1286 classpath_index = i;
1287 }
1288 }
1289 }
1290 if (classpath_index >= 0 || found_invalid) {
1291 return false; // quit iterating
1292 } else {
1293 return true; // Keep iterating
1294 }
1295 });
1296
1297 if (found_invalid) {
1298 return;
1299 }
1300
1301 // No path entry found for this class: most likely a shared class loaded by the
1302 // user defined classloader.
1303 if (classpath_index < 0 && !SystemDictionaryShared::is_builtin_loader(ik->class_loader_data())) {
1304 assert(ik->shared_classpath_index() < 0, "not assigned yet");
1305 ik->set_shared_classpath_index(UNREGISTERED_INDEX);
1306 SystemDictionaryShared::set_shared_class_misc_info(ik, (ClassFileStream*)stream);
1307 return;
1308 }
1309 }
1310
1311 const char* const class_name = ik->name()->as_C_string();
1312 const char* const file_name = file_name_for_class_name(class_name,
1313 ik->name()->utf8_length());
1314 assert(file_name != nullptr, "invariant");
1315 ClassLoaderExt::record_result(checked_cast<s2>(classpath_index), ik, redefined);
1316 }
1317
1318 void ClassLoader::record_hidden_class(InstanceKlass* ik) {
1319 assert(ik->is_hidden(), "must be");
1320
1321 s2 classloader_type;
1322 if (HeapShared::is_lambda_form_klass(ik)) {
1323 classloader_type = ClassLoader::BOOT_LOADER;
1324 } else {
1325 oop loader = ik->class_loader();
1326
1327 if (loader == nullptr) {
1328 classloader_type = ClassLoader::BOOT_LOADER;
1329 } else if (SystemDictionary::is_platform_class_loader(loader)) {
1330 classloader_type = ClassLoader::PLATFORM_LOADER;
1331 } else if (SystemDictionary::is_system_class_loader(loader)) {
1332 classloader_type = ClassLoader::APP_LOADER;
1333 } else {
1334 // This class won't be archived, so no need to update its
1335 // classloader_type/classpath_index.
1336 return;
1337 }
1338 }
1339 ik->set_shared_class_loader_type(classloader_type);
1340
1341 if (HeapShared::is_lambda_proxy_klass(ik)) {
1342 InstanceKlass* nest_host = ik->nest_host_not_null();
1343 ik->set_shared_classpath_index(nest_host->shared_classpath_index());
1344 } else if (HeapShared::is_lambda_form_klass(ik)) {
1345 ik->set_shared_classpath_index(0);
1346 } else {
1347 // Generated invoker classes.
1348 if (classloader_type == ClassLoader::APP_LOADER) {
1349 ik->set_shared_classpath_index(AOTClassLocationConfig::dumptime()->app_cp_start_index());
1350 } else {
1351 ik->set_shared_classpath_index(0);
1352 }
1353 }
1354 }
1355 #endif // INCLUDE_CDS
1356
1357 // Initialize the class loader's access to methods in libzip. Parse and
1358 // process the boot classpath into a list ClassPathEntry objects. Once
1359 // this list has been created, it must not change order (see class PackageInfo)
1360 // it can be appended to and is by jvmti.
1361
1362 void ClassLoader::initialize(TRAPS) {
1363 if (UsePerfData) {
1364 // jvmstat performance counters
1365 NEWPERFTICKCOUNTER(_perf_accumulated_time, SUN_CLS, "time");
1366 NEWPERFTICKCOUNTER(_perf_class_init_time, SUN_CLS, "classInitTime");
1367 NEWPERFTICKCOUNTER(_perf_class_init_selftime, SUN_CLS, "classInitTime.self");
1368 NEWPERFTICKCOUNTER(_perf_class_verify_time, SUN_CLS, "classVerifyTime");
1369 NEWPERFTICKCOUNTER(_perf_class_verify_selftime, SUN_CLS, "classVerifyTime.self");
1370 NEWPERFTICKCOUNTER(_perf_class_link_time, SUN_CLS, "classLinkedTime");
1371 NEWPERFTICKCOUNTER(_perf_class_link_selftime, SUN_CLS, "classLinkedTime.self");
1372 NEWPERFEVENTCOUNTER(_perf_classes_inited, SUN_CLS, "initializedClasses");
1373 NEWPERFEVENTCOUNTER(_perf_classes_linked, SUN_CLS, "linkedClasses");
1374 NEWPERFEVENTCOUNTER(_perf_classes_verified, SUN_CLS, "verifiedClasses");
1375
1376 NEWPERFTICKCOUNTER(_perf_shared_classload_time, SUN_CLS, "sharedClassLoadTime");
1377 NEWPERFTICKCOUNTER(_perf_sys_classload_time, SUN_CLS, "sysClassLoadTime");
1378 NEWPERFTICKCOUNTER(_perf_app_classload_time, SUN_CLS, "appClassLoadTime");
1379 NEWPERFTICKCOUNTER(_perf_app_classload_selftime, SUN_CLS, "appClassLoadTime.self");
1380 NEWPERFEVENTCOUNTER(_perf_app_classload_count, SUN_CLS, "appClassLoadCount");
1381 NEWPERFTICKCOUNTER(_perf_define_appclasses, SUN_CLS, "defineAppClasses");
1382 NEWPERFTICKCOUNTER(_perf_define_appclass_time, SUN_CLS, "defineAppClassTime");
1383 NEWPERFTICKCOUNTER(_perf_define_appclass_selftime, SUN_CLS, "defineAppClassTime.self");
1384 NEWPERFBYTECOUNTER(_perf_app_classfile_bytes_read, SUN_CLS, "appClassBytes");
1385 NEWPERFBYTECOUNTER(_perf_sys_classfile_bytes_read, SUN_CLS, "sysClassBytes");
1386 NEWPERFEVENTCOUNTER(_unsafe_defineClassCallCounter, SUN_CLS, "unsafeDefineClassCalls");
1387 NEWPERFTICKCOUNTER(_perf_secondary_hash_time, SUN_CLS, "secondarySuperHashTime");
1388
1389 if (log_is_enabled(Info, perf, class, link)) {
1390 NEWPERFTICKCOUNTER(_perf_ik_link_methods_time, SUN_CLS, "linkMethodsTime");
1391 NEWPERFTICKCOUNTER(_perf_method_adapters_time, SUN_CLS, "makeAdaptersTime");
1392 NEWPERFEVENTCOUNTER(_perf_ik_link_methods_count, SUN_CLS, "linkMethodsCount");
1393 NEWPERFEVENTCOUNTER(_perf_method_adapters_count, SUN_CLS, "makeAdaptersCount");
1394
1395 NEWPERFTICKCOUNTER(_perf_resolve_indy_time, SUN_CLS, "resolve_invokedynamic_time");
1396 NEWPERFTICKCOUNTER(_perf_resolve_invokehandle_time, SUN_CLS, "resolve_invokehandle_time");
1397 NEWPERFTICKCOUNTER(_perf_resolve_mh_time, SUN_CLS, "resolve_MethodHandle_time");
1398 NEWPERFTICKCOUNTER(_perf_resolve_mt_time, SUN_CLS, "resolve_MethodType_time");
1399
1400 NEWPERFEVENTCOUNTER(_perf_resolve_indy_count, SUN_CLS, "resolve_invokedynamic_count");
1401 NEWPERFEVENTCOUNTER(_perf_resolve_invokehandle_count, SUN_CLS, "resolve_invokehandle_count");
1402 NEWPERFEVENTCOUNTER(_perf_resolve_mh_count, SUN_CLS, "resolve_MethodHandle_count");
1403 NEWPERFEVENTCOUNTER(_perf_resolve_mt_count, SUN_CLS, "resolve_MethodType_count");
1404 }
1405 }
1406
1407 // lookup java library entry points
1408 load_java_library();
1409 // jimage library entry points are loaded below, in lookup_vm_options
1410 setup_bootstrap_search_path(THREAD);
1411 }
1412
1413 static char* lookup_vm_resource(JImageFile *jimage, const char *jimage_version, const char *path) {
1414 jlong size;
1415 JImageLocationRef location = (*JImageFindResource)(jimage, "java.base", jimage_version, path, &size);
1416 if (location == 0)
1417 return nullptr;
1418 char *val = NEW_C_HEAP_ARRAY(char, size+1, mtClass);
1419 (*JImageGetResource)(jimage, location, val, size);
1420 val[size] = '\0';
1421 return val;
1422 }
1423
1424 // Lookup VM options embedded in the modules jimage file
1425 char* ClassLoader::lookup_vm_options() {
1426 jint error;
1427 char modules_path[JVM_MAXPATHLEN];
1428 const char* fileSep = os::file_separator();
1429
1430 // Initialize jimage library entry points
1431 load_jimage_library();
1432
1433 jio_snprintf(modules_path, JVM_MAXPATHLEN, "%s%slib%smodules", Arguments::get_java_home(), fileSep, fileSep);
1434 JImage_file =(*JImageOpen)(modules_path, &error);
1435 if (JImage_file == nullptr) {
1436 return nullptr;
1437 }
1438
1439 const char *jimage_version = get_jimage_version_string();
1440 char *options = lookup_vm_resource(JImage_file, jimage_version, "jdk/internal/vm/options");
1441 return options;
1442 }
1443
1444 bool ClassLoader::is_module_observable(const char* module_name) {
1445 assert(JImageOpen != nullptr, "jimage library should have been opened");
1446 if (JImage_file == nullptr) {
1447 struct stat st;
1448 const char *path = get_exploded_module_path(module_name, true);
1449 bool res = os::stat(path, &st) == 0;
1450 FREE_C_HEAP_ARRAY(char, path);
1451 return res;
1452 }
1453 jlong size;
1454 const char *jimage_version = get_jimage_version_string();
1455 return (*JImageFindResource)(JImage_file, module_name, jimage_version, "module-info.class", &size) != 0;
1456 }
1457
1458 jlong ClassLoader::classloader_time_ms() {
1459 return UsePerfData ?
1460 Management::ticks_to_ms(_perf_accumulated_time->get_value()) : -1;
1461 }
1462
1463 jlong ClassLoader::class_init_count() {
1464 return UsePerfData ? _perf_classes_inited->get_value() : -1;
1465 }
1466
1467 jlong ClassLoader::class_init_time_ms() {
1468 return UsePerfData ?
1469 Management::ticks_to_ms(_perf_class_init_time->get_value()) : -1;
1470 }
1471
1472 jlong ClassLoader::class_verify_time_ms() {
1473 return UsePerfData ?
1474 Management::ticks_to_ms(_perf_class_verify_time->get_value()) : -1;
1475 }
1476
1477 jlong ClassLoader::class_link_count() {
1478 return UsePerfData ? _perf_classes_linked->get_value() : -1;
1479 }
1480
1481 jlong ClassLoader::class_link_time_ms() {
1482 return UsePerfData ?
1483 Management::ticks_to_ms(_perf_class_link_time->get_value()) : -1;
1484 }
1485
1486 int ClassLoader::compute_Object_vtable() {
1487 // hardwired for JDK1.2 -- would need to duplicate class file parsing
1488 // code to determine actual value from file
1489 // Would be value '11' if finals were in vtable
1490 int JDK_1_2_Object_vtable_size = 5;
1491 return JDK_1_2_Object_vtable_size * vtableEntry::size();
1492 }
1493
1494
1495 void classLoader_init1() {
1496 EXCEPTION_MARK;
1497 ClassLoader::initialize(THREAD);
1498 if (HAS_PENDING_EXCEPTION) {
1499 vm_exit_during_initialization("ClassLoader::initialize() failed unexpectedly");
1500 }
1501 }
1502
1503 // Complete the ClassPathEntry setup for the boot loader
1504 void ClassLoader::classLoader_init2(JavaThread* current) {
1505 // Setup the list of module/path pairs for --patch-module processing
1506 // This must be done after the SymbolTable is created in order
1507 // to use fast_compare on module names instead of a string compare.
1508 if (Arguments::get_patch_mod_prefix() != nullptr) {
1509 setup_patch_mod_entries();
1510 }
1511
1512 // Create the ModuleEntry for java.base (must occur after setup_patch_mod_entries
1513 // to successfully determine if java.base has been patched)
1514 create_javabase();
1515
1516 // Setup the initial java.base/path pair for the exploded build entries.
1517 // As more modules are defined during module system initialization, more
1518 // entries will be added to the exploded build array.
1519 if (!has_jrt_entry()) {
1520 assert(!CDSConfig::is_dumping_archive(), "not supported with exploded module builds");
1521 assert(!CDSConfig::is_using_archive(), "UsedSharedSpaces not supported with exploded module builds");
1522 // Set up the boot loader's _exploded_entries list. Note that this gets
1523 // done before loading any classes, by the same thread that will
1524 // subsequently do the first class load. So, no lock is needed for this.
1525 assert(_exploded_entries == nullptr, "Should only get initialized once");
1526 _exploded_entries = new (mtModule)
1527 GrowableArray<ModuleClassPathList*>(EXPLODED_ENTRY_SIZE, mtModule);
1528 add_to_exploded_build_list(current, vmSymbols::java_base());
1529 }
1530 }
1531
1532 char* ClassLoader::get_canonical_path(const char* orig, Thread* thread) {
1533 assert(orig != nullptr, "bad arguments");
1534 // caller needs to allocate ResourceMark for the following output buffer
1535 char* canonical_path = NEW_RESOURCE_ARRAY_IN_THREAD(thread, char, JVM_MAXPATHLEN);
1536 ResourceMark rm(thread);
1537 // os::native_path writes into orig_copy
1538 char* orig_copy = NEW_RESOURCE_ARRAY_IN_THREAD(thread, char, strlen(orig)+1);
1539 strcpy(orig_copy, orig);
1540 if ((CanonicalizeEntry)(os::native_path(orig_copy), canonical_path, JVM_MAXPATHLEN) < 0) {
1541 return nullptr;
1542 }
1543 return canonical_path;
1544 }
1545
1546 void ClassLoader::create_javabase() {
1547 JavaThread* current = JavaThread::current();
1548
1549 // Create java.base's module entry for the boot
1550 // class loader prior to loading j.l.Object.
1551 ClassLoaderData* null_cld = ClassLoaderData::the_null_class_loader_data();
1552
1553 // Get module entry table
1554 ModuleEntryTable* null_cld_modules = null_cld->modules();
1555 if (null_cld_modules == nullptr) {
1556 vm_exit_during_initialization("No ModuleEntryTable for the boot class loader");
1557 }
1558
1559 {
1560 MutexLocker ml(current, Module_lock);
1561 if (ModuleEntryTable::javabase_moduleEntry() == nullptr) { // may have been inited by CDS.
1562 ModuleEntry* jb_module = null_cld_modules->locked_create_entry(Handle(),
1563 false, vmSymbols::java_base(), nullptr, nullptr, null_cld);
1564 if (jb_module == nullptr) {
1565 vm_exit_during_initialization("Unable to create ModuleEntry for " JAVA_BASE_NAME);
1566 }
1567 ModuleEntryTable::set_javabase_moduleEntry(jb_module);
1568 }
1569 }
1570 }
1571
1572 // Please keep following two functions at end of this file. With them placed at top or in middle of the file,
1573 // they could get inlined by aggressive compiler, an unknown trick, see bug 6966589.
1574 void PerfClassTraceTime::initialize() {
1575 if (!UsePerfData) return;
1576
1577 if (_eventp != nullptr) {
1578 // increment the event counter
1579 _eventp->inc();
1580 }
1581
1582 // stop the current active thread-local timer to measure inclusive time
1583 _prev_active_event = -1;
1584 for (int i=0; i < EVENT_TYPE_COUNT; i++) {
1585 if (_timers[i].is_active()) {
1586 assert(_prev_active_event == -1, "should have only one active timer");
1587 _prev_active_event = i;
1588 _timers[i].stop();
1589 }
1590 }
1591
1592 if (_recursion_counters == nullptr || (_recursion_counters[_event_type])++ == 0) {
1593 // start the inclusive timer if not recursively called
1594 _t.start();
1595 }
1596
1597 // start thread-local timer of the given event type
1598 if (!_timers[_event_type].is_active()) {
1599 _timers[_event_type].start();
1600 }
1601 }
1602
1603 PerfClassTraceTime::~PerfClassTraceTime() {
1604 if (!UsePerfData) return;
1605
1606 // stop the thread-local timer as the event completes
1607 // and resume the thread-local timer of the event next on the stack
1608 _timers[_event_type].stop();
1609 jlong selftime = _timers[_event_type].ticks();
1610
1611 if (_prev_active_event >= 0) {
1612 _timers[_prev_active_event].start();
1613 }
1614
1615 if (_recursion_counters != nullptr && --(_recursion_counters[_event_type]) > 0) return;
1616
1617 // increment the counters only on the leaf call
1618 _t.stop();
1619 _timep->inc(_t.ticks());
1620 if (_selftimep != nullptr) {
1621 _selftimep->inc(selftime);
1622 }
1623 // add all class loading related event selftime to the accumulated time counter
1624 ClassLoader::perf_accumulated_time()->inc(selftime);
1625
1626 // reset the timer
1627 _timers[_event_type].reset();
1628 }