1 /*
2 * Copyright (c) 2016, 2024, 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 "cds/archiveBuilder.hpp"
27 #include "cds/cdsConfig.hpp"
28 #include "cds/metaspaceShared.hpp"
29 #include "classfile/classFileParser.hpp"
30 #include "classfile/classLoader.hpp"
31 #include "classfile/classLoaderData.inline.hpp"
32 #include "classfile/classLoaderDataShared.hpp"
33 #include "classfile/javaAssertions.hpp"
34 #include "classfile/javaClasses.hpp"
35 #include "classfile/javaClasses.inline.hpp"
36 #include "classfile/moduleEntry.hpp"
37 #include "classfile/modules.hpp"
38 #include "classfile/packageEntry.hpp"
39 #include "classfile/stringTable.hpp"
40 #include "classfile/symbolTable.hpp"
41 #include "classfile/systemDictionary.hpp"
42 #include "classfile/vmClasses.hpp"
43 #include "classfile/vmSymbols.hpp"
44 #include "jvm.h"
45 #include "logging/log.hpp"
46 #include "logging/logStream.hpp"
47 #include "memory/resourceArea.hpp"
48 #include "prims/jvmtiExport.hpp"
49 #include "runtime/arguments.hpp"
50 #include "runtime/globals_extension.hpp"
51 #include "runtime/handles.inline.hpp"
52 #include "runtime/javaCalls.hpp"
53 #include "runtime/jniHandles.inline.hpp"
54 #include "utilities/formatBuffer.hpp"
55 #include "utilities/stringUtils.hpp"
56 #include "utilities/utf8.hpp"
57
58 static bool verify_module_name(const char *module_name, int len) {
59 assert(module_name != nullptr, "invariant");
60 return (len > 0 && len <= Symbol::max_length());
61 }
62
63 static bool verify_package_name(const char* package_name, int len) {
64 assert(package_name != nullptr, "Package name derived from non-null jstring can't be null");
65 return (len > 0 && len <= Symbol::max_length() &&
66 ClassFileParser::verify_unqualified_name(package_name, len,
67 ClassFileParser::LegalClass));
68 }
69
70 static char* get_module_name(oop module, int& len, TRAPS) {
71 oop name_oop = java_lang_Module::name(module);
72 if (name_oop == nullptr) {
73 THROW_MSG_NULL(vmSymbols::java_lang_NullPointerException(), "Null module name");
74 }
75 char* module_name = java_lang_String::as_utf8_string(name_oop, len);
76 if (!verify_module_name(module_name, len)) {
77 THROW_MSG_NULL(vmSymbols::java_lang_IllegalArgumentException(),
78 err_msg("Invalid module name: %s", module_name));
79 }
80 return module_name;
81 }
82
83 static Symbol* as_symbol(jstring str_object) {
84 if (str_object == nullptr) {
85 return nullptr;
86 }
87 int len;
88 char* str = java_lang_String::as_utf8_string(JNIHandles::resolve_non_null(str_object), len);
89 return SymbolTable::new_symbol(str, len);
90 }
91
92 ModuleEntryTable* Modules::get_module_entry_table(Handle h_loader) {
93 // This code can be called during start-up, before the classLoader's classLoader data got
94 // created. So, call register_loader() to make sure the classLoader data gets created.
95 ClassLoaderData *loader_cld = SystemDictionary::register_loader(h_loader);
96 return loader_cld->modules();
97 }
98
99 static PackageEntryTable* get_package_entry_table(Handle h_loader) {
100 // This code can be called during start-up, before the classLoader's classLoader data got
101 // created. So, call register_loader() to make sure the classLoader data gets created.
102 ClassLoaderData *loader_cld = SystemDictionary::register_loader(h_loader);
103 return loader_cld->packages();
104 }
105
106 static ModuleEntry* get_module_entry(Handle module, TRAPS) {
107 if (!java_lang_Module::is_instance(module())) {
108 THROW_MSG_NULL(vmSymbols::java_lang_IllegalArgumentException(),
109 "module is not an instance of type java.lang.Module");
110 }
111 return java_lang_Module::module_entry(module());
112 }
113
114
115 static PackageEntry* get_locked_package_entry(ModuleEntry* module_entry, const char* package_name, int len) {
116 assert(Module_lock->owned_by_self(), "should have the Module_lock");
117 assert(package_name != nullptr, "Precondition");
118 TempNewSymbol pkg_symbol = SymbolTable::new_symbol(package_name, len);
119 PackageEntryTable* package_entry_table = module_entry->loader_data()->packages();
120 assert(package_entry_table != nullptr, "Unexpected null package entry table");
121 PackageEntry* package_entry = package_entry_table->locked_lookup_only(pkg_symbol);
122 assert(package_entry == nullptr || package_entry->module() == module_entry, "Unexpectedly found a package linked to another module");
123 return package_entry;
124 }
125
126 static PackageEntry* get_package_entry_by_name(Symbol* package, Handle h_loader) {
127 if (package != nullptr) {
128 PackageEntryTable* const package_entry_table =
129 get_package_entry_table(h_loader);
130 assert(package_entry_table != nullptr, "Unexpected null package entry table");
131 return package_entry_table->lookup_only(package);
132 }
133 return nullptr;
134 }
135
136 bool Modules::is_package_defined(Symbol* package, Handle h_loader) {
137 PackageEntry* res = get_package_entry_by_name(package, h_loader);
138 return res != nullptr;
139 }
140
141 // Converts the String oop to an internal package
142 // Will use the provided buffer if it's sufficiently large, otherwise allocates
143 // a resource array
144 // The length of the resulting string will be assigned to utf8_len
145 static const char* as_internal_package(oop package_string, char* buf, int buflen, int& utf8_len) {
146 char* package_name = java_lang_String::as_utf8_string_full(package_string, buf, buflen, utf8_len);
147
148 // Turn all '/'s into '.'s
149 for (int index = 0; index < utf8_len; index++) {
150 if (package_name[index] == JVM_SIGNATURE_DOT) {
151 package_name[index] = JVM_SIGNATURE_SLASH;
152 }
153 }
154 return package_name;
155 }
156
157 static void define_javabase_module(Handle module_handle, jstring version, jstring location,
158 objArrayHandle pkgs, int num_packages, TRAPS) {
159 ResourceMark rm(THREAD);
160
161 // Obtain java.base's module version
162 TempNewSymbol version_symbol = as_symbol(version);
163
164 // Obtain java.base's location
165 TempNewSymbol location_symbol = as_symbol(location);
166
167 // Check that the packages are syntactically ok.
168 char buf[128];
169 GrowableArray<Symbol*>* pkg_list = new GrowableArray<Symbol*>(num_packages);
170 for (int x = 0; x < num_packages; x++) {
171 oop pkg_str = pkgs->obj_at(x);
172
173 if (pkg_str == nullptr || pkg_str->klass() != vmClasses::String_klass()) {
174 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
175 err_msg("Bad package name"));
176 }
177
178 int package_len;
179 const char* package_name = as_internal_package(pkg_str, buf, sizeof(buf), package_len);
180 if (!verify_package_name(package_name, package_len)) {
181 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
182 err_msg("Invalid package name: %s for module: " JAVA_BASE_NAME, package_name));
183 }
184 Symbol* pkg_symbol = SymbolTable::new_symbol(package_name, package_len);
185 pkg_list->append(pkg_symbol);
186 }
187
188 // Validate java_base's loader is the boot loader.
189 oop loader = java_lang_Module::loader(module_handle());
190 if (loader != nullptr) {
191 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
192 "Class loader must be the boot class loader");
193 }
194 Handle h_loader(THREAD, loader);
195
196 // Ensure the boot loader's PackageEntryTable has been created
197 PackageEntryTable* package_table = get_package_entry_table(h_loader);
198 assert(pkg_list->length() == 0 || package_table != nullptr, "Bad package_table");
199
200 // Ensure java.base's ModuleEntry has been created
201 assert(ModuleEntryTable::javabase_moduleEntry() != nullptr, "No ModuleEntry for " JAVA_BASE_NAME);
202
203 bool duplicate_javabase = false;
204 {
205 MutexLocker m1(THREAD, Module_lock);
206
207 if (ModuleEntryTable::javabase_defined()) {
208 duplicate_javabase = true;
209 } else {
210
211 // Verify that all java.base packages created during bootstrapping are in
212 // pkg_list. If any are not in pkg_list, than a non-java.base class was
213 // loaded erroneously pre java.base module definition.
214 package_table->verify_javabase_packages(pkg_list);
215
216 // loop through and add any new packages for java.base
217 for (int x = 0; x < pkg_list->length(); x++) {
218 // Some of java.base's packages were added early in bootstrapping, ignore duplicates.
219 package_table->locked_create_entry_if_absent(pkg_list->at(x),
220 ModuleEntryTable::javabase_moduleEntry());
221 assert(package_table->locked_lookup_only(pkg_list->at(x)) != nullptr,
222 "Unable to create a " JAVA_BASE_NAME " package entry");
223 // Unable to have a GrowableArray of TempNewSymbol. Must decrement the refcount of
224 // the Symbol* that was created above for each package. The refcount was incremented
225 // by SymbolTable::new_symbol and as well by the PackageEntry creation.
226 pkg_list->at(x)->decrement_refcount();
227 }
228
229 // Finish defining java.base's ModuleEntry
230 ModuleEntryTable::finalize_javabase(module_handle, version_symbol, location_symbol);
231 }
232 }
233 if (duplicate_javabase) {
234 THROW_MSG(vmSymbols::java_lang_InternalError(),
235 "Module " JAVA_BASE_NAME " is already defined");
236 }
237
238 // Only the thread that actually defined the base module will get here,
239 // so no locking is needed.
240
241 // Patch any previously loaded class's module field with java.base's java.lang.Module.
242 ModuleEntryTable::patch_javabase_entries(THREAD, module_handle);
243
244 log_info(module, load)(JAVA_BASE_NAME " location: %s",
245 location_symbol != nullptr ? location_symbol->as_C_string() : "nullptr");
246 log_debug(module)("define_javabase_module(): Definition of module: "
247 JAVA_BASE_NAME ", version: %s, location: %s, package #: %d",
248 version_symbol != nullptr ? version_symbol->as_C_string() : "nullptr",
249 location_symbol != nullptr ? location_symbol->as_C_string() : "nullptr",
250 pkg_list->length());
251
252 // packages defined to java.base
253 if (log_is_enabled(Trace, module)) {
254 for (int x = 0; x < pkg_list->length(); x++) {
255 log_trace(module)("define_javabase_module(): creation of package %s for module " JAVA_BASE_NAME,
256 (pkg_list->at(x))->as_C_string());
257 }
258 }
259 }
260
261 // Caller needs ResourceMark.
262 static void throw_dup_pkg_exception(const char* module_name, PackageEntry* package, TRAPS) {
263 const char* package_name = package->name()->as_C_string();
264 if (package->module()->is_named()) {
265 THROW_MSG(vmSymbols::java_lang_IllegalStateException(),
266 err_msg("Package %s for module %s is already in another module, %s, defined to the class loader",
267 package_name, module_name, package->module()->name()->as_C_string()));
268 } else {
269 THROW_MSG(vmSymbols::java_lang_IllegalStateException(),
270 err_msg("Package %s for module %s is already in the unnamed module defined to the class loader",
271 package_name, module_name));
272 }
273 }
274
275 void Modules::define_module(Handle module, jboolean is_open, jstring version,
276 jstring location, jobjectArray packages, TRAPS) {
277 check_cds_restrictions(CHECK);
278 ResourceMark rm(THREAD);
279
280 if (module.is_null()) {
281 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null module object");
282 }
283
284 if (!java_lang_Module::is_instance(module())) {
285 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
286 "module is not an instance of type java.lang.Module");
287 }
288
289 int module_name_len;
290 char* module_name = get_module_name(module(), module_name_len, CHECK);
291 if (module_name == nullptr) {
292 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
293 "Module name cannot be null");
294 }
295
296 // Resolve packages
297 objArrayHandle packages_h(THREAD, objArrayOop(JNIHandles::resolve(packages)));
298 int num_packages = (packages_h.is_null() ? 0 : packages_h->length());
299
300 // Special handling of java.base definition
301 if (strcmp(module_name, JAVA_BASE_NAME) == 0) {
302 assert(is_open == JNI_FALSE, "java.base module cannot be open");
303 define_javabase_module(module, version, location, packages_h, num_packages, CHECK);
304 return;
305 }
306
307 oop loader = java_lang_Module::loader(module());
308 // Make sure loader is not the jdk.internal.reflect.DelegatingClassLoader.
309 if (loader != java_lang_ClassLoader::non_reflection_class_loader(loader)) {
310 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
311 "Class loader is an invalid delegating class loader");
312 }
313 Handle h_loader = Handle(THREAD, loader);
314 // define_module can be called during start-up, before the class loader's ClassLoaderData
315 // has been created. SystemDictionary::register_loader ensures creation, if needed.
316 ClassLoaderData* loader_data = SystemDictionary::register_loader(h_loader);
317 assert(loader_data != nullptr, "class loader data shouldn't be null");
318
319 // Only modules defined to either the boot or platform class loader, can define a "java/" package.
320 bool java_pkg_disallowed = !h_loader.is_null() &&
321 !SystemDictionary::is_platform_class_loader(h_loader());
322
323 // Check that the list of packages has no duplicates and that the
324 // packages are syntactically ok.
325 char buf[128];
326 GrowableArray<Symbol*>* pkg_list = new GrowableArray<Symbol*>(num_packages);
327 for (int x = 0; x < num_packages; x++) {
328 oop pkg_str = packages_h->obj_at(x);
329 if (pkg_str == nullptr || pkg_str->klass() != vmClasses::String_klass()) {
330 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
331 err_msg("Bad package name"));
332 }
333
334 int package_len;
335 const char* package_name = as_internal_package(pkg_str, buf, sizeof(buf), package_len);
336 if (!verify_package_name(package_name, package_len)) {
337 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
338 err_msg("Invalid package name: %s for module: %s",
339 package_name, module_name));
340 }
341
342 // Only modules defined to either the boot or platform class loader, can define a "java/" package.
343 if (java_pkg_disallowed &&
344 (strncmp(package_name, JAVAPKG, JAVAPKG_LEN) == 0 &&
345 (package_name[JAVAPKG_LEN] == JVM_SIGNATURE_SLASH || package_name[JAVAPKG_LEN] == '\0'))) {
346 const char* class_loader_name = loader_data->loader_name_and_id();
347 size_t pkg_len = strlen(package_name);
348 char* pkg_name = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, pkg_len + 1);
349 strncpy(pkg_name, package_name, pkg_len + 1);
350 StringUtils::replace_no_expand(pkg_name, "/", ".");
351 const char* msg_text1 = "Class loader (instance of): ";
352 const char* msg_text2 = " tried to define prohibited package name: ";
353 size_t len = strlen(msg_text1) + strlen(class_loader_name) + strlen(msg_text2) + pkg_len + 1;
354 char* message = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, len);
355 jio_snprintf(message, len, "%s%s%s%s", msg_text1, class_loader_name, msg_text2, pkg_name);
356 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(), message);
357 }
358
359 Symbol* pkg_symbol = SymbolTable::new_symbol(package_name, package_len);
360 pkg_list->append(pkg_symbol);
361 }
362
363 ModuleEntryTable* module_table = get_module_entry_table(h_loader);
364 assert(module_table != nullptr, "module entry table shouldn't be null");
365
366 // Create symbol* entry for module name.
367 TempNewSymbol module_symbol = SymbolTable::new_symbol(module_name, module_name_len);
368
369 bool dupl_modules = false;
370
371 // Create symbol for module version.
372 TempNewSymbol version_symbol = as_symbol(version);
373
374 // Create symbol* entry for module location.
375 TempNewSymbol location_symbol = as_symbol(location);
376
377 PackageEntryTable* package_table = nullptr;
378 PackageEntry* existing_pkg = nullptr;
379 {
380 MutexLocker ml(THREAD, Module_lock);
381
382 if (num_packages > 0) {
383 package_table = get_package_entry_table(h_loader);
384 assert(package_table != nullptr, "Missing package_table");
385
386 // Check that none of the packages exist in the class loader's package table.
387 for (int x = 0; x < pkg_list->length(); x++) {
388 existing_pkg = package_table->locked_lookup_only(pkg_list->at(x));
389 if (existing_pkg != nullptr) {
390 // This could be because the module was already defined. If so,
391 // report that error instead of the package error.
392 if (module_table->lookup_only(module_symbol) != nullptr) {
393 dupl_modules = true;
394 }
395 break;
396 }
397 }
398 } // if (num_packages > 0)...
399
400 // Add the module and its packages.
401 if (!dupl_modules && existing_pkg == nullptr) {
402 if (module_table->lookup_only(module_symbol) == nullptr) {
403 // Create the entry for this module in the class loader's module entry table.
404 ModuleEntry* module_entry = module_table->locked_create_entry(module,
405 (is_open == JNI_TRUE), module_symbol,
406 version_symbol, location_symbol, loader_data);
407 assert(module_entry != nullptr, "module_entry creation failed");
408
409 // Add the packages.
410 assert(pkg_list->length() == 0 || package_table != nullptr, "Bad package table");
411 for (int y = 0; y < pkg_list->length(); y++) {
412 package_table->locked_create_entry(pkg_list->at(y), module_entry);
413
414 // Unable to have a GrowableArray of TempNewSymbol. Must decrement the refcount of
415 // the Symbol* that was created above for each package. The refcount was incremented
416 // by SymbolTable::new_symbol and as well by the PackageEntry creation.
417 pkg_list->at(y)->decrement_refcount();
418 }
419
420 // Store pointer to ModuleEntry record in java.lang.Module object.
421 java_lang_Module::set_module_entry(module(), module_entry);
422 } else {
423 dupl_modules = true;
424 }
425 }
426 } // Release the lock
427
428 // any errors ?
429 if (dupl_modules) {
430 THROW_MSG(vmSymbols::java_lang_IllegalStateException(),
431 err_msg("Module %s is already defined", module_name));
432 } else if (existing_pkg != nullptr) {
433 throw_dup_pkg_exception(module_name, existing_pkg, CHECK);
434 }
435
436 log_info(module, load)("%s location: %s", module_name,
437 location_symbol != nullptr ? location_symbol->as_C_string() : "null");
438 LogTarget(Debug, module) lt;
439 if (lt.is_enabled()) {
440 LogStream ls(lt);
441 ls.print("define_module(): creation of module: %s, version: %s, location: %s, ",
442 module_name, version_symbol != nullptr ? version_symbol->as_C_string() : "null",
443 location_symbol != nullptr ? location_symbol->as_C_string() : "null");
444 loader_data->print_value_on(&ls);
445 ls.print_cr(", package #: %d", pkg_list->length());
446 for (int y = 0; y < pkg_list->length(); y++) {
447 log_trace(module)("define_module(): creation of package %s for module %s",
448 (pkg_list->at(y))->as_C_string(), module_name);
449 }
450 }
451
452 // If the module is defined to the boot loader and an exploded build is being
453 // used, prepend <java.home>/modules/modules_name to the boot class path.
454 if (h_loader.is_null() && !ClassLoader::has_jrt_entry()) {
455 ClassLoader::add_to_exploded_build_list(THREAD, module_symbol);
456 }
457
458 #if COMPILER2_OR_JVMCI
459 // Special handling of jdk.incubator.vector
460 if (strcmp(module_name, "jdk.incubator.vector") == 0) {
461 if (FLAG_IS_DEFAULT(EnableVectorSupport)) {
462 FLAG_SET_DEFAULT(EnableVectorSupport, true);
463 }
464 if (EnableVectorSupport && FLAG_IS_DEFAULT(EnableVectorReboxing)) {
465 FLAG_SET_DEFAULT(EnableVectorReboxing, true);
466 }
467 if (EnableVectorSupport && EnableVectorReboxing && FLAG_IS_DEFAULT(EnableVectorAggressiveReboxing)) {
468 FLAG_SET_DEFAULT(EnableVectorAggressiveReboxing, true);
469 }
470 if (EnableVectorSupport && FLAG_IS_DEFAULT(UseVectorStubs)) {
471 FLAG_SET_DEFAULT(UseVectorStubs, true);
472 }
473 log_info(compilation)("EnableVectorSupport=%s", (EnableVectorSupport ? "true" : "false"));
474 log_info(compilation)("EnableVectorReboxing=%s", (EnableVectorReboxing ? "true" : "false"));
475 log_info(compilation)("EnableVectorAggressiveReboxing=%s", (EnableVectorAggressiveReboxing ? "true" : "false"));
476 log_info(compilation)("UseVectorStubs=%s", (UseVectorStubs ? "true" : "false"));
477 }
478 #endif // COMPILER2_OR_JVMCI
479 }
480
481 #if INCLUDE_CDS_JAVA_HEAP
482 static bool _seen_platform_unnamed_module = false;
483 static bool _seen_system_unnamed_module = false;
484
485 // Validate the states of an java.lang.Module oop to be archived.
486 //
487 // Returns true iff the oop has an archived ModuleEntry.
488 bool Modules::check_archived_module_oop(oop orig_module_obj) {
489 assert(CDSConfig::is_dumping_full_module_graph(), "must be");
490 assert(java_lang_Module::is_instance(orig_module_obj), "must be");
491
492 ModuleEntry* orig_module_ent = java_lang_Module::module_entry_raw(orig_module_obj);
493 if (orig_module_ent == nullptr) {
494 // These special java.lang.Module oops are created in Java code. They are not
495 // defined via Modules::define_module(), so they don't have a ModuleEntry:
496 // java.lang.Module::ALL_UNNAMED_MODULE
497 // java.lang.Module::EVERYONE_MODULE
498 // jdk.internal.loader.ClassLoaders$BootClassLoader::unnamedModule
499 log_info(cds, module)("Archived java.lang.Module oop " PTR_FORMAT " with no ModuleEntry*", p2i(orig_module_obj));
500 assert(java_lang_Module::name(orig_module_obj) == nullptr, "must be unnamed");
501 return false;
502 } else {
503 // This java.lang.Module oop has an ModuleEntry*. Check if the latter is archived.
504 if (log_is_enabled(Info, cds, module)) {
505 ResourceMark rm;
506 LogStream ls(Log(cds, module)::info());
507 ls.print("Archived java.lang.Module oop " PTR_FORMAT " for ", p2i(orig_module_obj));
508 orig_module_ent->print(&ls);
509 }
510
511 // We only archive the default module graph, which should contain only java.lang.Module oops
512 // for the 3 built-in loaders (boot/platform/system)
513 ClassLoaderData* loader_data = orig_module_ent->loader_data();
514 assert(loader_data->is_builtin_class_loader_data(), "must be");
515
516 if (orig_module_ent->name() != nullptr) {
517 // For each named module, we archive both the java.lang.Module oop and the ModuleEntry.
518 assert(orig_module_ent->has_been_archived(), "sanity");
519 return true;
520 } else {
521 // We only archive two unnamed module oops (for platform and system loaders). These do NOT have an archived
522 // ModuleEntry.
523 //
524 // At runtime, these oops are fetched from java_lang_ClassLoader::unnamedModule(loader) and
525 // are initialized in ClassLoaderData::ClassLoaderData() => ModuleEntry::create_unnamed_module(), where
526 // a new ModuleEntry is allocated.
527 assert(!loader_data->is_boot_class_loader_data(), "unnamed module for boot loader should be not archived");
528 assert(!orig_module_ent->has_been_archived(), "sanity");
529
530 if (SystemDictionary::is_platform_class_loader(loader_data->class_loader())) {
531 assert(!_seen_platform_unnamed_module, "only once");
532 _seen_platform_unnamed_module = true;
533 } else if (SystemDictionary::is_system_class_loader(loader_data->class_loader())) {
534 assert(!_seen_system_unnamed_module, "only once");
535 _seen_system_unnamed_module = true;
536 } else {
537 // The java.lang.Module oop and ModuleEntry of the unnamed module of the boot loader are
538 // not in the archived module graph. These are always allocated at runtime.
539 ShouldNotReachHere();
540 }
541 return false;
542 }
543 }
544 }
545
546 void Modules::update_oops_in_archived_module(oop orig_module_obj, int archived_module_root_index) {
547 // This java.lang.Module oop must have an archived ModuleEntry
548 assert(check_archived_module_oop(orig_module_obj) == true, "sanity");
549
550 // We remember the oop inside the ModuleEntry::_archived_module_index. At runtime, we use
551 // this index to reinitialize the ModuleEntry inside ModuleEntry::restore_archived_oops().
552 //
553 // ModuleEntry::verify_archived_module_entries(), called below, ensures that every archived
554 // ModuleEntry has been assigned an _archived_module_index.
555 ModuleEntry* orig_module_ent = java_lang_Module::module_entry_raw(orig_module_obj);
556 ModuleEntry::get_archived_entry(orig_module_ent)->update_oops_in_archived_module(archived_module_root_index);
557 }
558
559 void Modules::verify_archived_modules() {
560 ModuleEntry::verify_archived_module_entries();
561 }
562
563 #if INCLUDE_CDS_JAVA_HEAP
564 char* Modules::_archived_main_module_name = nullptr;
565 #endif
566
567 void Modules::dump_main_module_name() {
568 const char* module_name = Arguments::get_property("jdk.module.main");
569 if (module_name != nullptr) {
570 _archived_main_module_name = ArchiveBuilder::current()->ro_strdup(module_name);
571 }
572 ArchivePtrMarker::mark_pointer(&_archived_main_module_name);
573 }
574
575 void Modules::serialize(SerializeClosure* soc) {
576 soc->do_ptr(&_archived_main_module_name);
577 if (soc->reading()) {
578 const char* runtime_main_module = Arguments::get_property("jdk.module.main");
579 log_info(cds)("_archived_main_module_name %s",
580 _archived_main_module_name != nullptr ? _archived_main_module_name : "(null)");
581 bool disable = false;
582 if (runtime_main_module == nullptr) {
583 if (_archived_main_module_name != nullptr) {
584 log_info(cds)("Module %s specified during dump time but not during runtime", _archived_main_module_name);
585 disable = true;
586 }
587 } else {
588 if (_archived_main_module_name == nullptr) {
589 log_info(cds)("Module %s specified during runtime but not during dump time", runtime_main_module);
590 disable = true;
591 } else if (strcmp(runtime_main_module, _archived_main_module_name) != 0) {
592 log_info(cds)("Mismatched modules: runtime %s dump time %s", runtime_main_module, _archived_main_module_name);
593 disable = true;
594 }
595 }
596
597 if (disable) {
598 log_info(cds)("Disabling optimized module handling");
599 CDSConfig::stop_using_optimized_module_handling();
600 }
601 log_info(cds)("optimized module handling: %s", CDSConfig::is_using_optimized_module_handling() ? "enabled" : "disabled");
602 log_info(cds)("full module graph: %s", CDSConfig::is_using_full_module_graph() ? "enabled" : "disabled");
603 }
604 }
605
606 void Modules::define_archived_modules(Handle h_platform_loader, Handle h_system_loader, TRAPS) {
607 assert(CDSConfig::is_using_full_module_graph(), "must be");
608
609 // We don't want the classes used by the archived full module graph to be redefined by JVMTI.
610 // Luckily, such classes are loaded in the JVMTI "early" phase, and CDS is disabled if a JVMTI
611 // agent wants to redefine classes in this phase.
612 JVMTI_ONLY(assert(JvmtiExport::is_early_phase(), "must be"));
613 assert(!(JvmtiExport::should_post_class_file_load_hook() && JvmtiExport::has_early_class_hook_env()),
614 "CDS should be disabled if early class hooks are enabled");
615
616 Handle java_base_module(THREAD, ClassLoaderDataShared::restore_archived_oops_for_null_class_loader_data());
617 // Patch any previously loaded class's module field with java.base's java.lang.Module.
618 ModuleEntryTable::patch_javabase_entries(THREAD, java_base_module);
619
620 if (h_platform_loader.is_null()) {
621 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null platform loader object");
622 }
623
624 if (h_system_loader.is_null()) {
625 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null system loader object");
626 }
627
628 ClassLoaderData* platform_loader_data = SystemDictionary::register_loader(h_platform_loader);
629 SystemDictionary::set_platform_loader(platform_loader_data);
630 ClassLoaderDataShared::restore_java_platform_loader_from_archive(platform_loader_data);
631
632 ClassLoaderData* system_loader_data = SystemDictionary::register_loader(h_system_loader);
633 SystemDictionary::set_system_loader(system_loader_data);
634 // system_loader_data here is always an instance of jdk.internal.loader.ClassLoader$AppClassLoader.
635 // However, if -Djava.system.class.loader=xxx is specified, java_platform_loader() would
636 // be an instance of a user-defined class, so make sure this never happens.
637 assert(Arguments::get_property("java.system.class.loader") == nullptr,
638 "archived full module should have been disabled if -Djava.system.class.loader is specified");
639 ClassLoaderDataShared::restore_java_system_loader_from_archive(system_loader_data);
640 }
641
642 void Modules::check_cds_restrictions(TRAPS) {
643 if (CDSConfig::is_dumping_full_module_graph() && Universe::is_module_initialized()) {
644 THROW_MSG(vmSymbols::java_lang_UnsupportedOperationException(),
645 "During -Xshare:dump, module system cannot be modified after it's initialized");
646 }
647 }
648 #endif // INCLUDE_CDS_JAVA_HEAP
649
650 void Modules::set_bootloader_unnamed_module(Handle module, TRAPS) {
651 ResourceMark rm(THREAD);
652
653 if (module.is_null()) {
654 THROW_MSG(vmSymbols::java_lang_NullPointerException(), "Null module object");
655 }
656 if (!java_lang_Module::is_instance(module())) {
657 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
658 "module is not an instance of type java.lang.Module");
659 }
660
661 // Ensure that this is an unnamed module
662 oop name = java_lang_Module::name(module());
663 if (name != nullptr) {
664 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
665 "boot loader's unnamed module's java.lang.Module has a name");
666 }
667
668 // Validate java_base's loader is the boot loader.
669 oop loader = java_lang_Module::loader(module());
670 if (loader != nullptr) {
671 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
672 "Class loader must be the boot class loader");
673 }
674
675 log_debug(module)("set_bootloader_unnamed_module(): recording unnamed module for boot loader");
676
677 // Set java.lang.Module for the boot loader's unnamed module
678 ClassLoaderData* boot_loader_data = ClassLoaderData::the_null_class_loader_data();
679 ModuleEntry* unnamed_module = boot_loader_data->unnamed_module();
680 assert(unnamed_module != nullptr, "boot loader's unnamed ModuleEntry not defined");
681 unnamed_module->set_module(boot_loader_data->add_handle(module));
682 // Store pointer to the ModuleEntry in the unnamed module's java.lang.Module object.
683 java_lang_Module::set_module_entry(module(), unnamed_module);
684 }
685
686 void Modules::add_module_exports(Handle from_module, jstring package_name, Handle to_module, TRAPS) {
687 check_cds_restrictions(CHECK);
688
689 if (package_name == nullptr) {
690 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
691 "package is null");
692 }
693 if (from_module.is_null()) {
694 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
695 "from_module is null");
696 }
697 ModuleEntry* from_module_entry = get_module_entry(from_module, CHECK);
698 if (from_module_entry == nullptr) {
699 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
700 "from_module cannot be found");
701 }
702
703 // All packages in unnamed and open modules are exported by default.
704 if (!from_module_entry->is_named() || from_module_entry->is_open()) return;
705
706 ModuleEntry* to_module_entry;
707 if (to_module.is_null()) {
708 to_module_entry = nullptr; // It's an unqualified export.
709 } else {
710 to_module_entry = get_module_entry(to_module, CHECK);
711 if (to_module_entry == nullptr) {
712 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
713 "to_module is invalid");
714 }
715 }
716
717 PackageEntry* package_entry = nullptr;
718 char buf[128];
719 int package_len;
720
721 ResourceMark rm(THREAD);
722 const char* pkg = as_internal_package(JNIHandles::resolve_non_null(package_name), buf, sizeof(buf), package_len);
723 {
724 MutexLocker ml(THREAD, Module_lock);
725 package_entry = get_locked_package_entry(from_module_entry, pkg, package_len);
726 // Do nothing if modules are the same
727 // If the package is not found we'll throw an exception later
728 if (from_module_entry != to_module_entry &&
729 package_entry != nullptr) {
730 package_entry->set_exported(to_module_entry);
731 }
732 }
733
734 // Handle errors and logging outside locked section
735 if (package_entry == nullptr) {
736 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
737 err_msg("Package %s not found in from_module %s",
738 pkg != nullptr ? pkg : "",
739 from_module_entry->name()->as_C_string()));
740 }
741
742 if (log_is_enabled(Debug, module)) {
743 log_debug(module)("add_module_exports(): package %s in module %s is exported to module %s",
744 package_entry->name()->as_C_string(),
745 from_module_entry->name()->as_C_string(),
746 to_module_entry == nullptr ? "null" :
747 to_module_entry->is_named() ?
748 to_module_entry->name()->as_C_string() : UNNAMED_MODULE);
749 }
750 }
751
752
753 void Modules::add_module_exports_qualified(Handle from_module, jstring package,
754 Handle to_module, TRAPS) {
755 check_cds_restrictions(CHECK);
756 if (to_module.is_null()) {
757 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
758 "to_module is null");
759 }
760 add_module_exports(from_module, package, to_module, CHECK);
761 }
762
763 void Modules::add_reads_module(Handle from_module, Handle to_module, TRAPS) {
764 check_cds_restrictions(CHECK);
765 if (from_module.is_null()) {
766 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
767 "from_module is null");
768 }
769
770 ModuleEntry* from_module_entry = get_module_entry(from_module, CHECK);
771 if (from_module_entry == nullptr) {
772 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
773 "from_module is not valid");
774 }
775
776 ModuleEntry* to_module_entry;
777 if (!to_module.is_null()) {
778 to_module_entry = get_module_entry(to_module, CHECK);
779 if (to_module_entry == nullptr) {
780 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
781 "to_module is invalid");
782 }
783 } else {
784 to_module_entry = nullptr;
785 }
786
787 ResourceMark rm(THREAD);
788 log_debug(module)("add_reads_module(): Adding read from module %s to module %s",
789 from_module_entry->is_named() ?
790 from_module_entry->name()->as_C_string() : UNNAMED_MODULE,
791 to_module_entry == nullptr ? "all unnamed" :
792 (to_module_entry->is_named() ?
793 to_module_entry->name()->as_C_string() : UNNAMED_MODULE));
794
795 // if modules are the same or if from_module is unnamed then no need to add the read.
796 if (from_module_entry != to_module_entry && from_module_entry->is_named()) {
797 from_module_entry->add_read(to_module_entry);
798 }
799 }
800
801 // This method is called by JFR and JNI.
802 jobject Modules::get_module(jclass clazz, TRAPS) {
803 assert(ModuleEntryTable::javabase_defined(),
804 "Attempt to call get_module before " JAVA_BASE_NAME " is defined");
805
806 if (clazz == nullptr) {
807 THROW_MSG_(vmSymbols::java_lang_NullPointerException(),
808 "class is null", nullptr);
809 }
810 oop mirror = JNIHandles::resolve_non_null(clazz);
811 if (mirror == nullptr) {
812 log_debug(module)("get_module(): no mirror, returning nullptr");
813 return nullptr;
814 }
815 if (!java_lang_Class::is_instance(mirror)) {
816 THROW_MSG_(vmSymbols::java_lang_IllegalArgumentException(),
817 "Invalid class", nullptr);
818 }
819
820 oop module = java_lang_Class::module(mirror);
821
822 assert(module != nullptr, "java.lang.Class module field not set");
823 assert(java_lang_Module::is_instance(module), "module is not an instance of type java.lang.Module");
824
825 LogTarget(Debug,module) lt;
826 if (lt.is_enabled()) {
827 ResourceMark rm(THREAD);
828 LogStream ls(lt);
829 Klass* klass = java_lang_Class::as_Klass(mirror);
830 oop module_name = java_lang_Module::name(module);
831 if (module_name != nullptr) {
832 ls.print("get_module(): module ");
833 java_lang_String::print(module_name, tty);
834 } else {
835 ls.print("get_module(): Unnamed Module");
836 }
837 if (klass != nullptr) {
838 ls.print_cr(" for class %s", klass->external_name());
839 } else {
840 ls.print_cr(" for primitive class");
841 }
842 }
843
844 return JNIHandles::make_local(THREAD, module);
845 }
846
847 oop Modules::get_named_module(Handle h_loader, const char* package_name) {
848 assert(ModuleEntryTable::javabase_defined(),
849 "Attempt to call get_named_module before " JAVA_BASE_NAME " is defined");
850 assert(h_loader.is_null() || java_lang_ClassLoader::is_subclass(h_loader->klass()),
851 "Class loader is not a subclass of java.lang.ClassLoader");
852 assert(package_name != nullptr, "the package_name should not be null");
853
854 if (strlen(package_name) == 0) {
855 return nullptr;
856 }
857 TempNewSymbol package_sym = SymbolTable::new_symbol(package_name);
858 const PackageEntry* const pkg_entry =
859 get_package_entry_by_name(package_sym, h_loader);
860 const ModuleEntry* const module_entry = (pkg_entry != nullptr ? pkg_entry->module() : nullptr);
861
862 if (module_entry != nullptr && module_entry->module() != nullptr && module_entry->is_named()) {
863 return module_entry->module();
864 }
865 return nullptr;
866 }
867
868 // Export package in module to all unnamed modules.
869 void Modules::add_module_exports_to_all_unnamed(Handle module, jstring package_name, TRAPS) {
870 check_cds_restrictions(CHECK);
871 if (module.is_null()) {
872 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
873 "module is null");
874 }
875 if (package_name == nullptr) {
876 THROW_MSG(vmSymbols::java_lang_NullPointerException(),
877 "package is null");
878 }
879 ModuleEntry* module_entry = get_module_entry(module, CHECK);
880 if (module_entry == nullptr) {
881 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
882 "module is invalid");
883 }
884
885 // No-op for unnamed module and open modules
886 if (!module_entry->is_named() || module_entry->is_open())
887 return;
888
889 ResourceMark rm(THREAD);
890 char buf[128];
891 int pkg_len;
892 const char* pkg = as_internal_package(JNIHandles::resolve_non_null(package_name), buf, sizeof(buf), pkg_len);
893 PackageEntry* package_entry = nullptr;
894 {
895 MutexLocker m1(THREAD, Module_lock);
896 package_entry = get_locked_package_entry(module_entry, pkg, pkg_len);
897
898 // Mark package as exported to all unnamed modules.
899 if (package_entry != nullptr) {
900 package_entry->set_is_exported_allUnnamed();
901 }
902 }
903
904 // Handle errors and logging outside locked section
905 if (package_entry == nullptr) {
906 THROW_MSG(vmSymbols::java_lang_IllegalArgumentException(),
907 err_msg("Package %s not found in module %s",
908 pkg != nullptr ? pkg : "",
909 module_entry->name()->as_C_string()));
910 }
911
912 if (log_is_enabled(Debug, module)) {
913 log_debug(module)("add_module_exports_to_all_unnamed(): package %s in module"
914 " %s is exported to all unnamed modules",
915 package_entry->name()->as_C_string(),
916 module_entry->name()->as_C_string());
917 }
918 }